Skip to content

Commit ebbf27a

Browse files
tomeichlersmithgithub-actions[bot]tvami
authored
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>
1 parent 6c08a49 commit ebbf27a

30 files changed

Lines changed: 15798 additions & 84 deletions

‎.gitmodules‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
[submodule "Tracking/acts"]
55
path = Tracking/acts
66
url = https://github.com/acts-project/acts
7-
[submodule "Trigger/HLS_arbitrary_Precision_Types"]
8-
path = Trigger/HLS_arbitrary_Precision_Types
9-
url = https://github.com/Xilinx/HLS_arbitrary_Precision_Types.git
107
[submodule "Trigger/ruckus"]
118
path = Trigger/ruckus
129
url = https://github.com/slaclab/ruckus

‎CMakeLists.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ include(BuildMacros RESULT_VARIABLE build_macros_found)
3434
# which will silence compiler warnings from these 3rd party softwares
3535
include_directories(SYSTEM /usr/local/include/root)
3636
include_directories(SYSTEM Tracking/acts/Core/include)
37-
include_directories(SYSTEM Trigger/HLS_arbitrary_Precision_Types/include)
3837

3938
# FunctionalCoreTest.cxx doesnt comply with clang-tidy but that's ok
4039
set_source_files_properties(Framework/test/FunctionalCoreTest.cxx PROPERTIES COMPILE_OPTIONS "-Wno-null-dereference")

‎Tools/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ setup_library(module Tools
2020
dependencies Framework::Framework Recon::Event Conditions::Conditions
2121
ONNXRuntime::Interface ROOT::Core ROOT::Physics Packing::Utility
2222
)
23+
target_include_directories(Tools SYSTEM PUBLIC HLS_Arbitrary_Precision_Types/include)
2324

2425
setup_python(package_name LDMX/Tools)
2526

‎Tools/HLS_Arbitrary_Precision_Types/.gitignore‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Prerequisites
2+
*.d
3+
4+
# Compiled Object files
5+
*.slo
6+
*.lo
7+
*.o
8+
*.obj
9+
10+
# Precompiled Headers
11+
*.gch
12+
*.pch
13+
14+
# Compiled Dynamic libraries
15+
*.so
16+
*.dylib
17+
*.dll
18+
19+
# Fortran module files
20+
*.mod
21+
*.smod
22+
23+
# Compiled Static libraries
24+
*.lai
25+
*.la
26+
*.a
27+
*.lib
28+
29+
# Executables
30+
*.exe
31+
*.out
32+
*.app
33+
34+
# Vim temp
35+
*.swp
36+
*.swo
37+
38+
# test folder
39+
test

‎Tools/HLS_Arbitrary_Precision_Types/LICENSE.TXT‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+

‎Tools/HLS_Arbitrary_Precision_Types/OLD_README.MD‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# HLS Arbitrary Precision Types Library
2+
3+
This repo provides simulation code of HLS Arbitrary Precision Types.
4+
5+
The code is based from headers shipped with Vivado,
6+
but due to absence of synthesis support **it should not be used in an HLS project targeting FPGA**.
7+
8+
## Compatibility
9+
10+
Tested with g++ (GCC) 6.2.0 on x86_64 GNU/Linux.
11+
12+
## Usage
13+
14+
Include the `ap_int.h` or `ap_fixed.h` in C++ code,
15+
and set compiler option to add the path of `include` directory in this repo
16+
into header search directory list.
17+
18+
```
19+
$ cd examples/ap_int
20+
$ g++ -I ../../include/ test.cpp
21+
$ ./a.out
22+
a = 11.3137 (0x0b.504ea4p0)
23+
b = 11.3137 (0x0b.504f33p0)
24+
c = a + b = 22.6274 (0x16.a09dd7p0)
25+
$
26+
```
27+
28+
## License Info
29+
30+
Copyright 2011-2019 Xilinx, Inc.
31+
32+
Licensed under the Apache License, Version 2.0 (the "License");
33+
you may not use this file except in compliance with the License.
34+
You may obtain a copy of the License at
35+
36+
http://www.apache.org/licenses/LICENSE-2.0
37+
38+
Unless required by applicable law or agreed to in writing, software
39+
distributed under the License is distributed on an "AS IS" BASIS,
40+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
41+
See the License for the specific language governing permissions and
42+
limitations under the License.

‎Tools/HLS_Arbitrary_Precision_Types/README.md‎

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

‎Tools/HLS_Arbitrary_Precision_Types/examples/ap_fixed/Makefile‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#
2+
# Copyright 2019 Xilinx, Inc.
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
a.out: test.cpp
17+
g++ -I../../include test.cpp
18+
./a.out
19+
20+
.PHONY: clean
21+
clean:
22+
rm -rf a.out

‎Tools/HLS_Arbitrary_Precision_Types/examples/ap_fixed/test.cpp‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/*
2+
* Copyright 2019 Xilinx, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
#include "ap_fixed.h"
17+
#include <iostream>
18+
19+
int main(int argc, const char* argv[]) {
20+
21+
ap_ufixed<28, 4> a = 11.3137;
22+
std::cout << "a = " << a << " (" << a.to_string(AP_HEX) << ")\n";
23+
24+
#if __cplusplus >= 201103L
25+
ap_ufixed<28, 4> b = 0xB.504F33p0; // hex-float
26+
#else
27+
ap_ufixed<28, 4> b = "0xB.504F33p0";
28+
#endif
29+
std::cout << "b = " << b << " (" << b.to_string(AP_HEX) << ")\n";
30+
31+
ap_ufixed<29, 5> c = a + b;
32+
std::cout << "c = a + b = " << c.to_double() << " (" << c.to_string(AP_HEX) << ")" << std::endl;
33+
34+
return 0;
35+
}

‎Tools/HLS_Arbitrary_Precision_Types/examples/ap_int/Makefile‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#
2+
# Copyright 2019 Xilinx, Inc.
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
a.out: test.cpp
17+
g++ -I../../include test.cpp -std=c++11
18+
./a.out
19+
20+
.PHONY: clean
21+
clean:
22+
rm -rf a.out

0 commit comments

Comments
 (0)