Skip to content

Commit f5a4d53

Browse files
authored
Merge pull request #531 from erhankur/add_esp_gcov
Add esp-gcov for code coverage support (IEC-342)
2 parents 478223e + 3b48dfa commit f5a4d53

File tree

13 files changed

+657
-0
lines changed

13 files changed

+657
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ body:
3131
- eigen
3232
- esp_delta_ota
3333
- esp_encrypted_img
34+
- esp_gcov
3435
- esp_jpeg
3536
- esp_lcd_qemu_rgb
3637
- esp_serial_slave_link

.github/workflows/upload_component.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ jobs:
4343
eigen;
4444
esp_delta_ota;
4545
esp_encrypted_img;
46+
esp_gcov;
4647
esp_lcd_qemu_rgb;
4748
esp_jpeg;
4849
esp_serial_slave_link;

.idf_build_apps.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ manifest_file = [
88
"ccomp_timer/.build-test-rules.yml",
99
"coremark/.build-test-rules.yml",
1010
"esp_encrypted_img/.build-test-rules.yml",
11+
"esp_gcov/.build-test-rules.yml",
1112
"esp_jpeg/.build-test-rules.yml",
1213
"esp_serial_slave_link/.build-test-rules.yml",
1314
"expat/.build-test-rules.yml",

esp_gcov/.build-test-rules.yml

Whitespace-only changes.

esp_gcov/CMakeLists.txt

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
if(CONFIG_ESP_GCOV_ENABLE)
2+
if(NOT CMAKE_C_COMPILER_ID MATCHES "GNU")
3+
# TODO: LLVM-214
4+
message(FATAL_ERROR "Coverage info is supported only when building with GNU!")
5+
endif()
6+
7+
# Set a name for Gcov library
8+
set(GCOV_LIB libgcov_rtio)
9+
10+
# Set include directory of Gcov internal headers
11+
execute_process(COMMAND ${CMAKE_C_COMPILER} -print-file-name=plugin
12+
OUTPUT_VARIABLE gcc_plugin_dir
13+
OUTPUT_STRIP_TRAILING_WHITESPACE
14+
ERROR_QUIET
15+
RESULT_VARIABLE gcc_plugin_result)
16+
17+
set_source_files_properties(gcov_rtio.c
18+
PROPERTIES COMPILE_FLAGS "-I${gcc_plugin_dir}/include")
19+
20+
# Copy libgcov.a with symbols redefinition
21+
find_library(GCOV_LIBRARY_PATH gcov ${CMAKE_C_IMPLICIT_LINK_DIRECTORIES})
22+
23+
# Check if libgcov.a was found
24+
if(NOT GCOV_LIBRARY_PATH)
25+
message(FATAL_ERROR "GCOV: libgcov.a not found in system directories: ${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}")
26+
endif()
27+
28+
# Verify libgcov.a file exists and is readable
29+
if(NOT EXISTS "${GCOV_LIBRARY_PATH}")
30+
message(FATAL_ERROR "GCOV: libgcov.a file does not exist")
31+
endif()
32+
33+
# Check if symbol map file exists
34+
set(SYMBOL_MAP_FILE "${CMAKE_CURRENT_LIST_DIR}/io_sym.map")
35+
36+
# Check if objcopy tool exists
37+
find_program(OBJCOPY_TOOL "${_CMAKE_TOOLCHAIN_PREFIX}objcopy")
38+
if(NOT OBJCOPY_TOOL)
39+
message(FATAL_ERROR "GCOV: objcopy tool not found: ${_CMAKE_TOOLCHAIN_PREFIX}objcopy. "
40+
"Make sure your toolchain is properly installed.")
41+
endif()
42+
43+
add_custom_command(OUTPUT ${GCOV_LIB}.a
44+
COMMAND ${OBJCOPY_TOOL}
45+
--redefine-syms ${SYMBOL_MAP_FILE}
46+
${GCOV_LIBRARY_PATH} ${GCOV_LIB}.a
47+
COMMAND ${CMAKE_COMMAND} -E echo "GCOV: Successfully created modified library: ${GCOV_LIB}.a"
48+
MAIN_DEPENDENCY ${GCOV_LIBRARY_PATH}
49+
DEPENDS ${SYMBOL_MAP_FILE}
50+
VERBATIM
51+
COMMENT "Creating GCOV library with symbol redefinition")
52+
53+
add_custom_target(${GCOV_LIB}_target DEPENDS ${GCOV_LIB}.a)
54+
add_library(${GCOV_LIB} STATIC IMPORTED)
55+
set_target_properties(${GCOV_LIB}
56+
PROPERTIES
57+
IMPORTED_LOCATION ${CMAKE_CURRENT_BINARY_DIR}/${GCOV_LIB}.a)
58+
add_dependencies(${GCOV_LIB} ${GCOV_LIB}_target)
59+
60+
# Register component with app_trace dependency
61+
idf_component_register(SRCS "gcov_rtio.c"
62+
REQUIRES "app_trace"
63+
INCLUDE_DIRS ".")
64+
65+
# Configure gcov-specific flags
66+
target_compile_options(${COMPONENT_LIB} PRIVATE "-fno-profile-arcs" "-fno-test-coverage")
67+
target_link_options(${COMPONENT_LIB} INTERFACE "-Wl,--wrap=__gcov_init")
68+
target_link_libraries(${COMPONENT_LIB} INTERFACE ${GCOV_LIB} c)
69+
70+
message(STATUS "GCOV: Component configured successfully")
71+
message(STATUS "GCOV: GCC Plugin Dir: ${gcc_plugin_dir}")
72+
message(STATUS "GCOV: Original Library: ${GCOV_LIBRARY_PATH}")
73+
message(STATUS "GCOV: Modified Library: ${CMAKE_CURRENT_BINARY_DIR}/${GCOV_LIB}.a")
74+
75+
else()
76+
# Register empty component when GCOV is disabled
77+
idf_component_register(REQUIRES "app_trace")
78+
message(STATUS "GCOV: Component registered but GCOV support is disabled")
79+
endif()

esp_gcov/Kconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
menu "GNU Code Coverage"
2+
3+
config ESP_GCOV_ENABLE
4+
bool "GCOV to Host Enable"
5+
depends on APPTRACE_ENABLE && !APPTRACE_SV_ENABLE
6+
select ESP_DEBUG_STUBS_ENABLE
7+
default y
8+
help
9+
Enables support for GCOV data transfer to host.
10+
11+
config ESP_GCOV_DUMP_TASK_STACK_SIZE
12+
int "Gcov dump task stack size"
13+
depends on ESP_GCOV_ENABLE
14+
default 2048
15+
help
16+
Configures stack size of Gcov dump task
17+
18+
endmenu

esp_gcov/LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
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+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)