logging: Use TYPE_SECTION macros for log const

galak · carlescufi · commit bae0a5b8b66a · 2023-05-03T10:43:31.000+02:00
Clean up log_const to utilize macros for handling sections.

Update database_gen.py to match naming convention change.

Signed-off-by: Kumar Gala &lt;kumar.gala@intel.com&gt;
diff --git a/cmake/linker_script/common/common-rom.cmake b/cmake/linker_script/common/common-rom.cmake
@@ -166,8 +166,7 @@ endif()
 
 zephyr_iterable_section(NAME log_strings KVMA RAM_REGION GROUP RODATA_REGION SUBALIGN 4)
 
-zephyr_linker_section(NAME log_const KVMA RAM_REGION GROUP RODATA_REGION NOINPUT ${XIP_ALIGN_WITH_INPUT})
-zephyr_linker_section_configure(SECTION log_const INPUT ".log_const_*" KEEP SORT NAME)
+zephyr_iterable_section(NAME log_const KVMA RAM_REGION GROUP RODATA_REGION SUBALIGN 4)
 
 zephyr_iterable_section(NAME shell KVMA RAM_REGION GROUP RODATA_REGION SUBALIGN 4)
 
diff --git a/include/zephyr/linker/common-rom/common-rom-logging.ld b/include/zephyr/linker/common-rom/common-rom-logging.ld
@@ -2,12 +2,7 @@
 
 	ITERABLE_SECTION_ROM(log_strings, 4)
 
-	SECTION_DATA_PROLOGUE(log_const_sections,,)
-	{
-		__log_const_start = .;
-		KEEP(*(SORT(.log_const_*)));
-		__log_const_end = .;
-	} GROUP_ROM_LINK_IN(RAMABLE_REGION, ROMABLE_REGION)
+	ITERABLE_SECTION_ROM(log_const, 4)
 
 	ITERABLE_SECTION_ROM(log_backend, 4)
 
diff --git a/include/zephyr/logging/log.h b/include/zephyr/logging/log.h
@@ -298,9 +298,10 @@ void z_log_vprintk(const char *fmt, va_list ap);
 
 #define _LOG_MODULE_CONST_DATA_CREATE(_name, _level)			       \
 	IF_ENABLED(LOG_IN_CPLUSPLUS, (extern))				       \
-	const struct log_source_const_data Z_LOG_ITEM_CONST_DATA(_name)	       \
-	__attribute__ ((section("." STRINGIFY(Z_LOG_ITEM_CONST_DATA(_name))))) \
-	__attribute__((used)) = {					       \
+	const STRUCT_SECTION_ITERABLE_ALTERNATE(log_const,		       \
+		log_source_const_data,					       \
+		Z_LOG_ITEM_CONST_DATA(_name)) =				       \
+	{								       \
 		.name = STRINGIFY(_name),				       \
 		.level = _level						       \
 	}
diff --git a/include/zephyr/logging/log_core.h b/include/zephyr/logging/log_core.h
@@ -389,8 +389,8 @@ static inline char z_log_minimal_level_to_char(int level)
  */
 #define LOG_LEVEL_INTERNAL_RAW_STRING LOG_LEVEL_NONE
 
-extern struct log_source_const_data __log_const_start[];
-extern struct log_source_const_data __log_const_end[];
+TYPE_SECTION_START_EXTERN(struct log_source_const_data, log_const);
+TYPE_SECTION_END_EXTERN(struct log_source_const_data, log_const);
 
 /** @brief Create message for logging printk-like string or a raw string.
  *
@@ -429,7 +429,7 @@ extern struct log_source_const_data __log_const_end[];
 static inline uint32_t log_const_source_id(
 				const struct log_source_const_data *data)
 {
-	return ((const uint8_t *)data - (uint8_t *)__log_const_start)/
+	return ((const uint8_t *)data - (uint8_t *)TYPE_SECTION_START(log_const))/
 			sizeof(struct log_source_const_data);
 }
 
diff --git a/include/zephyr/logging/log_instance.h b/include/zephyr/logging/log_instance.h
@@ -61,9 +61,10 @@ struct log_source_dynamic_data {
  * @param _level Messages up to this level are compiled in.
  */
 #define Z_LOG_CONST_ITEM_REGISTER(_name, _str_name, _level)		       \
-	const struct log_source_const_data Z_LOG_ITEM_CONST_DATA(_name)	       \
-	__attribute__ ((section("." STRINGIFY(Z_LOG_ITEM_CONST_DATA(_name))))) \
-	__attribute__((used)) = {					       \
+	const STRUCT_SECTION_ITERABLE_ALTERNATE(log_const,		       \
+		log_source_const_data,					       \
+		Z_LOG_ITEM_CONST_DATA(_name)) =				       \
+	{								       \
 		.name = _str_name,					       \
 		.level  = (_level),					       \
 	}
diff --git a/include/zephyr/logging/log_internal.h b/include/zephyr/logging/log_internal.h
@@ -92,7 +92,7 @@ static inline uint32_t *z_log_dynamic_filters_get(uint32_t source_id)
 /** @brief Get number of registered sources. */
 static inline uint32_t z_log_sources_count(void)
 {
-	return log_const_source_id(__log_const_end);
+	return log_const_source_id(TYPE_SECTION_END(log_const));
 }
 
 /** @brief Return number of external domains.
diff --git a/scripts/logging/dictionary/database_gen.py b/scripts/logging/dictionary/database_gen.py
@@ -167,7 +167,7 @@ def find_log_const_symbols(elf):
     return ret_list
 
 
-def parse_log_const_symbols(database, log_const_section, log_const_symbols, string_mappings):
+def parse_log_const_symbols(database, log_const_area, log_const_symbols, string_mappings):
     """Find the log instances and map source IDs to names"""
     if database.is_tgt_little_endian():
         formatter = "<"
@@ -192,17 +192,17 @@ def parse_log_const_symbols(database, log_const_section, log_const_symbols, stri
         if sym.entry['st_value'] < first_offset:
             first_offset = sym.entry['st_value']
 
-    first_offset -= log_const_section['start']
+    first_offset -= log_const_area['start']
 
     # find all log_const_*
     for sym in log_const_symbols:
-        # Find data offset in log_const_section for this symbol
-        offset = sym.entry['st_value'] - log_const_section['start']
+        # Find data offset in log_const_area for this symbol
+        offset = sym.entry['st_value'] - log_const_area['start']
 
         idx_s = offset
         idx_e = offset + datum_size
 
-        datum = log_const_section['data'][idx_s:idx_e]
+        datum = log_const_area['data'][idx_s:idx_e]
 
         if len(datum) != datum_size:
             # Not enough data to unpack
@@ -266,13 +266,13 @@ def extract_logging_subsys_information(elf, database, string_mappings):
     mapping from source ID to name.
     """
     # Extract log constant section for module names
-    section_log_const = find_elf_sections(elf, "log_const_sections")
+    section_log_const = find_elf_sections(elf, "log_const_area")
     if section_log_const is None:
-        # ESP32 puts "log_const_*" info log_static_section instead of log_const_sections
+        # ESP32 puts "log_const_*" info log_static_section instead of log_const_areas
         section_log_const = find_elf_sections(elf, "log_static_section")
 
     if section_log_const is None:
-        logger.error("Cannot find section 'log_const_sections' in ELF file, exiting...")
+        logger.error("Cannot find section 'log_const_areas' in ELF file, exiting...")
         sys.exit(1)
 
     # Find all "log_const_*" symbols and parse them
diff --git a/subsys/logging/log_mgmt.c b/subsys/logging/log_mgmt.c
@@ -196,7 +196,7 @@ static uint16_t link_source_count(uint8_t domain_id)
 uint32_t log_src_cnt_get(uint32_t domain_id)
 {
 	if (z_log_is_local_domain(domain_id)) {
-		return log_const_source_id(__log_const_end);
+		return z_log_sources_count();
 	}
 
 	return link_source_count(domain_id);
@@ -242,7 +242,7 @@ const char *log_source_name_get(uint32_t domain_id, uint32_t source_id)
 {
 	if (z_log_is_local_domain(domain_id)) {
 		if (source_id < log_src_cnt_get(domain_id)) {
-			return __log_const_start[source_id].name;
+			return TYPE_SECTION_START(log_const)[source_id].name;
 		} else {
 			return NULL;
 		}
@@ -308,7 +308,7 @@ uint8_t log_compiled_level_get(uint8_t domain_id, uint32_t source_id)
 {
 	if (z_log_is_local_domain(domain_id)) {
 		if (source_id < log_src_cnt_get(domain_id)) {
-			return __log_const_start[source_id].level;
+			return TYPE_SECTION_START(log_const)[source_id].level;
 		} else {
 			return LOG_LEVEL_NONE;
 		}
diff --git a/tests/subsys/logging/log_links/src/main.c b/tests/subsys/logging/log_links/src/main.c
@@ -131,7 +131,7 @@ ZTEST(log_links, test_log_domain_count)
 ZTEST(log_links, test_log_source_count)
 {
 	uint8_t exp_source_cnt[] = {
-		log_const_source_id(__log_const_end),
+		log_const_source_id(TYPE_SECTION_END(log_const)),
 		/*link1*/
 		domains_a[0]->source_cnt,
 		domains_a[1]->source_cnt,

Original file line number	Diff line number	Diff line change
`@@ -389,8 +389,8 @@ static inline char z_log_minimal_level_to_char(int level)`
`389`	`389`	`*/`
`390`	`390`	`#define LOG_LEVEL_INTERNAL_RAW_STRING LOG_LEVEL_NONE`
`391`	`391`
`392`		`-extern struct log_source_const_data __log_const_start[];`
`393`		`-extern struct log_source_const_data __log_const_end[];`
	`392`	`+TYPE_SECTION_START_EXTERN(struct log_source_const_data, log_const);`
	`393`	`+TYPE_SECTION_END_EXTERN(struct log_source_const_data, log_const);`
`394`	`394`
`395`	`395`	`/** @brief Create message for logging printk-like string or a raw string.`
`396`	`396`	`*`
`@@ -429,7 +429,7 @@ extern struct log_source_const_data __log_const_end[];`
`429`	`429`	`static inline uint32_t log_const_source_id(`
`430`	`430`	`const struct log_source_const_data *data)`
`431`	`431`	`{`
`432`		`- return ((const uint8_t )data - (uint8_t )__log_const_start)/`
	`432`	`+ return ((const uint8_t )data - (uint8_t )TYPE_SECTION_START(log_const))/`
`433`	`433`	`sizeof(struct log_source_const_data);`
`434`	`434`	`}`
`435`	`435`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ static inline uint32_t *z_log_dynamic_filters_get(uint32_t source_id)`
`92`	`92`	`/** @brief Get number of registered sources. */`
`93`	`93`	`static inline uint32_t z_log_sources_count(void)`
`94`	`94`	`{`
`95`		`- return log_const_source_id(__log_const_end);`
	`95`	`+ return log_const_source_id(TYPE_SECTION_END(log_const));`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`/** @brief Return number of external domains.`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ static uint16_t link_source_count(uint8_t domain_id)`
`196`	`196`	`uint32_t log_src_cnt_get(uint32_t domain_id)`
`197`	`197`	`{`
`198`	`198`	`if (z_log_is_local_domain(domain_id)) {`
`199`		`- return log_const_source_id(__log_const_end);`
	`199`	`+ return z_log_sources_count();`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`return link_source_count(domain_id);`
`@@ -242,7 +242,7 @@ const char *log_source_name_get(uint32_t domain_id, uint32_t source_id)`
`242`	`242`	`{`
`243`	`243`	`if (z_log_is_local_domain(domain_id)) {`
`244`	`244`	`if (source_id < log_src_cnt_get(domain_id)) {`
`245`		`- return __log_const_start[source_id].name;`
	`245`	`+ return TYPE_SECTION_START(log_const)[source_id].name;`
`246`	`246`	`} else {`
`247`	`247`	`return NULL;`
`248`	`248`	`}`
`@@ -308,7 +308,7 @@ uint8_t log_compiled_level_get(uint8_t domain_id, uint32_t source_id)`
`308`	`308`	`{`
`309`	`309`	`if (z_log_is_local_domain(domain_id)) {`
`310`	`310`	`if (source_id < log_src_cnt_get(domain_id)) {`
`311`		`- return __log_const_start[source_id].level;`
	`311`	`+ return TYPE_SECTION_START(log_const)[source_id].level;`
`312`	`312`	`} else {`
`313`	`313`	`return LOG_LEVEL_NONE;`
`314`	`314`	`}`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ ZTEST(log_links, test_log_domain_count)`
`131`	`131`	`ZTEST(log_links, test_log_source_count)`
`132`	`132`	`{`
`133`	`133`	`uint8_t exp_source_cnt[] = {`
`134`		`- log_const_source_id(__log_const_end),`
	`134`	`+ log_const_source_id(TYPE_SECTION_END(log_const)),`
`135`	`135`	`/link1/`
`136`	`136`	`domains_a[0]->source_cnt,`
`137`	`137`	`domains_a[1]->source_cnt,`