compiler cleanliness patches and incorporation of HLS APT (#1470)

* dont use a float as a for-loop counter

replace this with a while loop instead to be more clear about the possibility of rounding errors affecting performance

* remove unnecessary member variables holding digis, rename and align numbering of digi collections

* more compiler warning patches

- update digis{1,2,3} collection variable names
- remove useless (int) casts
- remove unused int index = count variables

* remove unnecessary zero-ing of count after its use

* Apply clang-format

* dont specify HLS includes as a specific directory

we include them as a SYSTEM include in central CMakeLists.txt
and specifying them as SYSTEM informs CMake and its downstream compilers
to avoid analyzing them since they aren't our problem

* require value initialization in Firmware-mimic structs

* Add checks in TrigScintFirmwareTracker, and fix array sizes, add defaults

* copy HLS APT submodule into ldmx-sw proper under Tools

* update readme notes

* rename etc and hide private headers in the ap_impl directory

* fix up paths in includes so examples compile

* attach HLS APT headers as 'system' headers to Tools module

* remove inclusion of directory that doesn't exist anymore

* patch inclusion of directories to correctly specify them as system headers

* cleanup TS CMakeLists and specify Tools as dependency of Firmware

* add patch from PR #1

Xilinx/HLS_arbitrary_Precision_Types#1

* wrap unknown pragmas in ifdef so they can be ignored here

* remove unused centroid variable

* Apply clang-format

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Tamas Vami <Tamas.Almos.Vami@cern.ch>

.gitmodules

@@ -4,9 +4,6 @@
 [submodule "Tracking/acts"]
 	path = Tracking/acts
 	url = https://github.com/acts-project/acts
-[submodule "Trigger/HLS_arbitrary_Precision_Types"]
-	path = Trigger/HLS_arbitrary_Precision_Types
-	url = https://github.com/Xilinx/HLS_arbitrary_Precision_Types.git
 [submodule "Trigger/ruckus"]
 	path = Trigger/ruckus
 	url = https://github.com/slaclab/ruckus

CMakeLists.txt

@@ -34,7 +34,6 @@ include(BuildMacros RESULT_VARIABLE build_macros_found)
 # which will silence compiler warnings from these 3rd party softwares
 include_directories(SYSTEM /usr/local/include/root)
 include_directories(SYSTEM Tracking/acts/Core/include)
-include_directories(SYSTEM Trigger/HLS_arbitrary_Precision_Types/include)
 
 # FunctionalCoreTest.cxx doesnt comply with clang-tidy but that's ok
 set_source_files_properties(Framework/test/FunctionalCoreTest.cxx PROPERTIES COMPILE_OPTIONS "-Wno-null-dereference")

Tools/CMakeLists.txt

@@ -20,6 +20,7 @@ setup_library(module Tools
               dependencies Framework::Framework Recon::Event Conditions::Conditions
                            ONNXRuntime::Interface ROOT::Core ROOT::Physics Packing::Utility
 )
+target_include_directories(Tools SYSTEM PUBLIC HLS_Arbitrary_Precision_Types/include)
 
 setup_python(package_name LDMX/Tools)
 

Tools/HLS_Arbitrary_Precision_Types/.gitignore

@@ -0,0 +1,39 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Vim temp
+*.swp
+*.swo
+
+# test folder
+test

Tools/HLS_Arbitrary_Precision_Types/LICENSE.TXT

@@ -0,0 +1,178 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+

Tools/HLS_Arbitrary_Precision_Types/OLD_README.MD

@@ -0,0 +1,42 @@
+# HLS Arbitrary Precision Types Library
+
+This repo provides simulation code of HLS Arbitrary Precision Types.
+
+The code is based from headers shipped with Vivado,
+but due to absence of synthesis support **it should not be used in an HLS project targeting FPGA**.
+
+## Compatibility
+
+Tested with g++ (GCC) 6.2.0 on x86_64 GNU/Linux.
+
+## Usage
+
+Include the `ap_int.h` or `ap_fixed.h` in C++ code,
+and set compiler option to add the path of `include` directory in this repo
+into header search directory list.
+
+```
+$ cd examples/ap_int
+$ g++ -I ../../include/ test.cpp
+$ ./a.out
+a = 11.3137 (0x0b.504ea4p0)
+b = 11.3137 (0x0b.504f33p0)
+c = a + b = 22.6274 (0x16.a09dd7p0)
+$
+```
+
+## License Info
+
+Copyright 2011-2019 Xilinx, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

Tools/HLS_Arbitrary_Precision_Types/README.md

@@ -0,0 +1,16 @@
+# HLS Arbitrary Precision Types
+
+Originating from [`Xilinx/HLS_arbitrary_Precision_Types`](https://github.com/Xilinx/HLS_arbitrary_Precision_Types)
+commit 200a9ae.
+
+Keeping these headers separate from our other Tools headers for two reasons.
+1. They originated from somewhere else and have a different (although very permissive) license.
+2. They do not pass our strigent compilation requirements so we have CMake pretend
+   they are system headers.
+
+The Apache 2 license requires us to publish the changes we've made to the source code we have
+copied. This requirement is satisifed by keeping our commits to ldmx-sw public. The other
+requirement is keeping the Apache 2 license on the copied source code which we can maintain
+by keeping this code separate.
+
+The [original README](OLD_README.MD) is available as well.

Tools/HLS_Arbitrary_Precision_Types/examples/ap_fixed/Makefile

@@ -0,0 +1,22 @@
+#
+# Copyright 2019 Xilinx, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+a.out: test.cpp
+	g++ -I../../include test.cpp
+	./a.out
+
+.PHONY: clean
+clean:
+	rm -rf a.out

Tools/HLS_Arbitrary_Precision_Types/examples/ap_fixed/test.cpp

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 Xilinx, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include "ap_fixed.h"
+#include <iostream>
+
+int main(int argc, const char* argv[]) {
+
+  ap_ufixed<28, 4> a = 11.3137;
+  std::cout << "a = " << a << " (" << a.to_string(AP_HEX) << ")\n";
+
+#if __cplusplus >= 201103L
+  ap_ufixed<28, 4> b = 0xB.504F33p0; // hex-float
+#else
+  ap_ufixed<28, 4> b = "0xB.504F33p0";
+#endif
+  std::cout << "b = " << b << " (" << b.to_string(AP_HEX) << ")\n";
+
+  ap_ufixed<29, 5> c = a + b;
+  std::cout << "c = a + b = " << c.to_double() << " (" << c.to_string(AP_HEX) << ")" << std::endl;
+
+  return 0;
+}

Tools/HLS_Arbitrary_Precision_Types/examples/ap_int/Makefile

@@ -0,0 +1,22 @@
+#
+# Copyright 2019 Xilinx, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+a.out: test.cpp
+	g++ -I../../include test.cpp -std=c++11
+	./a.out
+
+.PHONY: clean
+clean:
+	rm -rf a.out