Gcov: Enhance gcov

.github/linters/setup.cfg

@@ -0,0 +1,10 @@
+[flake8]
+ignore = W503,W605,E203,E704
+max-complexity=27
+max-line-length =125
+multi line_output=3
+show-source = True
+statistics = True
+
+[isort]
+profile = black

boards/boardctl.c

@@ -24,11 +24,12 @@
 
 #include <nuttx/config.h>
 
-#include <sys/types.h>
 #include <sys/boardctl.h>
+#include <sys/types.h>
+#include <assert.h>
 #include <stdint.h>
 #include <errno.h>
-#include <assert.h>
+#include <gcov.h>
 
 #include <nuttx/arch.h>
 #include <nuttx/board.h>

include/gcov.h

@@ -0,0 +1,183 @@
+/****************************************************************************
+ * include/gcov.h
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.  The
+ * ASF licenses this file to you 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.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_GCOV_H
+#define __INCLUDE_GCOV_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <sys/types.h>
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/* The GCOV 12 gcno/gcda format has slight change,
+ * Please refer to gcov-io.h in the GCC 12 for
+ * more details.
+ */
+
+#if __GNUC__ >= 12
+#  define GCOV_12_FORMAT
+#endif
+
+#if __GNUC__ >= 14
+#  define GCOV_COUNTERS 9u
+#elif __GNUC__ >= 10
+#  define GCOV_COUNTERS 8u
+#elif __GNUC__ >= 8
+#  define GCOV_COUNTERS 9u
+#else
+#  define GCOV_COUNTERS 10u
+#endif
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
+struct gcov_fn_info;
+typedef uint64_t gcov_type;
+
+/** Profiling data per object file
+ *
+ * This data is generated by gcc during compilation and doesn't change
+ * at run-time with the exception of the next pointer.
+ */
+
+struct gcov_info
+{
+  unsigned int version;                /* Gcov version (same as GCC version) */
+  FAR struct gcov_info *next;          /* List head for a singly-linked list */
+  unsigned int stamp;                  /* Uniquifying time stamp */
+#ifdef GCOV_12_FORMAT
+  unsigned int checksum;               /* unique object checksum */
+#endif
+  FAR const char *filename;            /* Name of the associated gcda data file */
+  void (*merge[GCOV_COUNTERS])(FAR gcov_type *, unsigned int);
+  unsigned int n_functions;            /* number of instrumented functions */
+  FAR struct gcov_fn_info **functions; /* function information */
+};
+
+/****************************************************************************
+ * Public Data
+ ****************************************************************************/
+
+extern FAR struct gcov_info *__gcov_info_start;
+extern FAR struct gcov_info *__gcov_info_end;
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C"
+{
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Name: __gcov_reset
+ *
+ * Description:
+ *   Set all counters to zero.
+ *
+ ****************************************************************************/
+
+extern void __gcov_reset(void);
+
+/****************************************************************************
+ * Name: __gcov_dump
+ *
+ * Description:
+ *   Write profile information to a file.
+ *
+ ****************************************************************************/
+
+extern void __gcov_dump(void);
+
+/****************************************************************************
+ * Name: __gcov_info_to_gcda
+ *
+ * Description:
+ *   Convert the gcov information referenced by INFO to a gcda data stream.
+ *
+ * Parameters:
+ *   info - Pointer to the gcov information.
+ *   filename - Callback function to get the filename.
+ *   dump - Callback function to write the gcda data.
+ *   allocate - Callback function to allocate memory.
+ *   arg - User-provided argument.
+ *
+ ****************************************************************************/
+
+extern void __gcov_info_to_gcda(FAR const struct gcov_info *info,
+                                FAR void (*filename)(FAR const char *,
+                                                     FAR void *),
+                                FAR void (*dump)(FAR const void *,
+                                                 size_t, FAR void *),
+                                FAR void *(*allocate)(unsigned int,
+                                                      FAR void *),
+                                FAR void *arg);
+
+/****************************************************************************
+ * Name: __gcov_filename_to_gcfn
+ *
+ * Description:
+ *   Convert the filename to a gcfn data stream.
+ *
+ * Parameters:
+ *   filename - Pointer to the filename.
+ *   dump - Callback function to write the gcfn data.
+ *   arg - User-provided argument.
+ *
+ ****************************************************************************/
+
+extern void __gcov_filename_to_gcfn(FAR const char *filename,
+                                    FAR void (*dump)(FAR const void *,
+                                                     unsigned int,
+                                                     FAR void *),
+                                     FAR void *arg);
+
+/****************************************************************************
+ * Name: __gcov_dump_to_memory
+ *
+ * Description:
+ *   Dump gcov data directly to memory
+ *
+ * Parameters:
+ *   ptr - Memory Address
+ *   size - Memory block size
+ *
+ ****************************************************************************/
+
+size_t __gcov_dump_to_memory(FAR void *ptr, size_t size);
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __INCLUDE_GCOV_H */

libs/libbuiltin/Kconfig

@@ -65,6 +65,25 @@ config COVERAGE_NONE
 
 endchoice
 
+config COVERAGE_GCOV_DUMP_REBOOT
+	bool "Dump gcov data on reboot"
+	default n
+	---help---
+		Dump gcov data on reboot, this will cause the gcov data to be
+		dumped to the default path when the system is rebooted.
+
+config COVERAGE_DEFAULT_PREFIX_STRIP
+	string "Default gcov dump path prefix strip"
+	default "99"
+	---help---
+		The default prefix strip of the gcov data
+
+config COVERAGE_DEFAULT_PREFIX
+	string "Default gcov dump path prefix"
+	default "/data"
+	---help---
+		The default prefix to store the gcov data
+
 choice
 	prompt "Builtin profile support"
 	default PROFILE_NONE

libs/libbuiltin/compiler-rt/CMakeLists.txt

@@ -52,77 +52,57 @@ if(CONFIG_LIB_COMPILER_RT)
 
   endif()
 
-  if(CONFIG_ARCH_ARM)
-    set(ARCH arm)
-  elseif(CONFIG_ARCH_RISCV)
-    set(ARCH riscv)
-  elseif(CONFIG_ARCH_X86_64)
-    set(ARCH x86_64)
-  elseif(CONFIG_ARCH_ARM64)
-    set(ARCH aarch64)
-  endif()
-
-  list(APPEND INCDIR ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/include)
-
-  if(CONFIG_BUILTIN_COMPILER_RT)
-
-    nuttx_add_system_library(rt.buitlins)
-
-    target_include_directories(
-      rt.buitlins PRIVATE ${INCDIR}
-                          ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins)
+endif()
 
-    target_compile_options(rt.buitlins PRIVATE -Wno-undef -Wno-macro-redefined)
+if(CONFIG_ARCH_ARM)
+  set(ARCH arm)
+elseif(CONFIG_ARCH_RISCV)
+  set(ARCH riscv)
+elseif(CONFIG_ARCH_X86_64)
+  set(ARCH x86_64)
+elseif(CONFIG_ARCH_ARM64)
+  set(ARCH aarch64)
+endif()
 
-    set(SRCSTMP)
-    set(RT_BUILTINS_SRCS)
-    file(GLOB RT_BUILTINS_SRCS
-         ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/*.c)
+list(APPEND INCDIR ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/include)
 
-    file(GLOB SRCSTMP
-         ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/${ARCH}/*.S)
-    list(APPEND RT_BUILTINS_SRCS ${SRCSTMP})
+if(CONFIG_BUILTIN_COMPILER_RT)
 
-    file(GLOB SRCSTMP
-         ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/${ARCH}/*.c)
-    list(APPEND RT_BUILTINS_SRCS ${SRCSTMP})
+  nuttx_add_system_library(rt.buitlins)
 
-    if(NOT CONFIG_LIB_COMPILER_RT_HAS_BFLOAT16)
-      set(RT_BUILTINS_BFLOAT16_SRCS
-          ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/truncdfbf2.c
-          ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/truncsfbf2.c)
-      list(REMOVE_ITEM RT_BUILTINS_SRCS ${RT_BUILTINS_BFLOAT16_SRCS})
-    endif()
+  target_include_directories(
+    rt.buitlins PRIVATE ${INCDIR}
+                        ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins)
 
-    target_sources(rt.buitlins PRIVATE ${RT_BUILTINS_SRCS})
+  target_compile_options(rt.buitlins PRIVATE -Wno-undef -Wno-macro-redefined)
 
+  set(SRCSTMP)
+  set(RT_BUILTINS_SRCS)
+  file(GLOB RT_BUILTINS_SRCS
+       ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/*.c)
+
+  file(GLOB SRCSTMP
+       ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/${ARCH}/*.S)
+  list(APPEND RT_BUILTINS_SRCS ${SRCSTMP})
+
+  file(GLOB SRCSTMP
+       ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/${ARCH}/*.c)
+  list(APPEND RT_BUILTINS_SRCS ${SRCSTMP})
+
+  if(NOT CONFIG_LIB_COMPILER_RT_HAS_BFLOAT16)
+    set(RT_BUILTINS_BFLOAT16_SRCS
+        ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/truncdfbf2.c
+        ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/builtins/truncsfbf2.c)
+    list(REMOVE_ITEM RT_BUILTINS_SRCS ${RT_BUILTINS_BFLOAT16_SRCS})
   endif()
 
-  if(CONFIG_COVERAGE_COMPILER_RT)
-
-    nuttx_add_system_library(rt.profile)
-
-    target_include_directories(
-      rt.profile PRIVATE ${INCDIR}
-                         ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/profile)
-
-    target_compile_options(
-      rt.profile PRIVATE -DCOMPILER_RT_HAS_UNAME -Wno-undef
-                         -Wno-strict-prototypes -Wno-shadow)
-
-    set(SRCSTMP)
-    set(RT_PROFILE_SRCS InstrProfilingPlatform.c)
-
-    file(GLOB SRCSTMP ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/profile/*.c)
-    list(APPEND RT_PROFILE_SRCS ${SRCSTMP})
-
-    file(GLOB SRCSTMP ${CMAKE_CURRENT_LIST_DIR}/compiler-rt/lib/profile/*.cpp)
-    list(APPEND RT_PROFILE_SRCS ${SRCSTMP})
-
-    target_sources(rt.profile PRIVATE ${RT_PROFILE_SRCS})
-
+  if(NOT CONFIG_COVERAGE_NONE)
+    target_compile_options(rt.buitlins -fno-profile-instr-generate
+                           -fno-coverage-mapping)
   endif()
 
+  target_sources(rt.buitlins PRIVATE ${RT_BUILTINS_SRCS})
+
 endif()
 
 if(CONFIG_COVERAGE_COMPILER_RT)
@@ -150,7 +130,7 @@ if(CONFIG_COVERAGE_COMPILER_RT)
 
   target_sources(rt.profile PRIVATE ${RT_PROFILE_SRCS})
 
-elseif(CONFIG_COVERAGE_MINI)
+elseif(CONFIG_COVERAGE_MINI AND CONFIG_ARCH_TOOLCHAIN_CLANG)
   nuttx_add_system_library(rt.miniprofile)
 
   target_compile_options(rt.miniprofile -fno-profile-instr-generate

libs/libbuiltin/compiler-rt/Make.defs

@@ -106,7 +106,7 @@ CSRCS += $(wildcard compiler-rt/compiler-rt/lib/profile/*.c)
 CPPSRCS += $(wildcard compiler-rt/compiler-rt/lib/profile/*.cpp)
 CSRCS += InstrProfilingPlatform.c
 
-else ifeq ($(CONFIG_COVERAGE_MINI),y)
+else ifeq ($(CONFIG_COVERAGE_MINI)$(CONFIG_ARCH_TOOLCHAIN_CLANG),yy)
 
 FLAGS += -fno-profile-instr-generate -fno-coverage-mapping