OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/logging/Kconfig.misc

107 lines
3.0 KiB
Plaintext
Raw Normal View History

logging: Revamp menuconfig Clean up logging menuconfig by grouping configuration into sections like: mode, processing configuration, backends. Additionlly, removed LOG_ENABLE_FANCY_OUTPUT_FORMATTING which is no longer in use. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-01-18 21:31:11 +08:00
# Copyright (c) 2021 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0
menu "Misc"
config LOG_DOMAIN_ID
logging: Initial multidomain support Adding multidomain support by introducing log_link module which acts as a receiver of log messages created by another domain. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-07-14 12:49:11 +08:00
int "Domain ID [DEPRECATED]"
logging: Minimal mode configuration cleanup Remove LOG_MINIMAL kconfig option which was confusing since LOG_MODE_MINIMAL existed. LOG_MINIMAL was used to force minimal mode but because of invalid dependencies it was leading to issues. Refactored code to use LOG_MODE_MINIMAL everywhere and renamed LOG_MINIMAL to LOG_DEFAULT_MINIMAL which has impact on defualt logging mode (which still can be later changed in conf file or in menuconfig). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-11-19 14:59:23 +08:00
depends on !LOG_MODE_MINIMAL
logging: Revamp menuconfig Clean up logging menuconfig by grouping configuration into sections like: mode, processing configuration, backends. Additionlly, removed LOG_ENABLE_FANCY_OUTPUT_FORMATTING which is no longer in use. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-01-18 21:31:11 +08:00
default 0
range 0 7
help
logging: Initial multidomain support Adding multidomain support by introducing log_link module which acts as a receiver of log messages created by another domain. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-07-14 12:49:11 +08:00
Deprecated. It is not used in the code.
logging: Revamp menuconfig Clean up logging menuconfig by grouping configuration into sections like: mode, processing configuration, backends. Additionlly, removed LOG_ENABLE_FANCY_OUTPUT_FORMATTING which is no longer in use. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-01-18 21:31:11 +08:00
config LOG_CMDS
kconfig: remove Enable from boolean prompts According to Kconfig guidelines, boolean prompts must not start with "Enable...". The following command has been used to automate the changes in this patch: sed -i "s/bool \"[Ee]nables\? \(\w\)/bool \"\U\1/g" **/Kconfig* Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 19:05:12 +08:00
bool "Shell commands"
logging: Revamp menuconfig Clean up logging menuconfig by grouping configuration into sections like: mode, processing configuration, backends. Additionlly, removed LOG_ENABLE_FANCY_OUTPUT_FORMATTING which is no longer in use. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-01-18 21:31:11 +08:00
depends on SHELL
logging: Add frontend support to v2 Extended logging v2 to support frontend api. Contrary to v1, it is possible to have frontend and backends in the system. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-01-25 16:10:15 +08:00
depends on !LOG_FRONTEND_ONLY && !LOG_MODE_MINIMAL
logging: Revamp menuconfig Clean up logging menuconfig by grouping configuration into sections like: mode, processing configuration, backends. Additionlly, removed LOG_ENABLE_FANCY_OUTPUT_FORMATTING which is no longer in use. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-01-18 21:31:11 +08:00
default y if SHELL
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
config LOG_TEST_CLEAR_MESSAGE_SPACE
bool "Clear message after allocation"
default y
depends on ZTEST
help
Used in testing to simplify message comparision if message contains
paddings.
logging: Removing v2 suffix from logging names Renaming objects which had 2 in the name to indicate that it is v2 specific. Once logging v1 has been removed such suffixes are redundant. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-21 17:51:38 +08:00
config LOG_USE_VLA
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
bool "Using variable length arrays"
default y if !MISRA_SANE
help
Using VLA slightly decreases stack usage in some cases it may not be
supported. Note that VLA are used for arrays which size is resolved at
compile time so at runtime arrays have fixed size.
logging: Removing v2 suffix from logging names Renaming objects which had 2 in the name to indicate that it is v2 specific. Once logging v1 has been removed such suffixes are redundant. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-21 17:51:38 +08:00
config LOG_ALWAYS_RUNTIME
logging: Add prompt to LOG2_ALWAYS_RUNTIME option Prompt was removed by 154ca8526 to ensure that it is not disable when it is required. That removed possibility of manually enabling that option my the user. Bringing prompt back and adding check to code to fail compilation if LOG2_ALWAYS_RUNTIME is not set but is required. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-03-07 18:31:25 +08:00
bool "Always use runtime message creation (v2)"
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
default y if NO_OPTIMIZATIONS
logging: Use runtime packaging in immediate mode Always use runtime packaging in immediate mode. Removing attempt to package on stack if possible. It would be done only to speed up logging but that is not a requirement in immediate mode where packaging time is fractional compared to backend processing. Using runtime packaging also reduces stack usage in the context which calls log message. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-02-09 18:59:26 +08:00
default y if LOG_MODE_IMMEDIATE
logging: v2: force LOG2_ALWAYS_RUNTIME if XCC XCC is based on GCC 4.2.0 which doesn't support auto type. So force CONFIG_LOG2_ALWAYS_RUNTIME to be enabled if XCC is being used. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-02-25 07:23:30 +08:00
default y if "$(ZEPHYR_TOOLCHAIN_VARIANT)" = "xcc"
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
help
If enabled, runtime method is always used for message creation. Static
creation relies on compiler being able to optimize and remove code
logging: Add prompt to LOG2_ALWAYS_RUNTIME option Prompt was removed by 154ca8526 to ensure that it is not disable when it is required. That removed possibility of manually enabling that option my the user. Bringing prompt back and adding check to code to fail compilation if LOG2_ALWAYS_RUNTIME is not set but is required. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-03-07 18:31:25 +08:00
based on information known at compile time. Runtime only approach must
be used when optimization is disabled because some compilers
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
(seen on arm_cortex_m and x86) were using unrealistic amount of stack
logging: Add prompt to LOG2_ALWAYS_RUNTIME option Prompt was removed by 154ca8526 to ensure that it is not disable when it is required. That removed possibility of manually enabling that option my the user. Bringing prompt back and adding check to code to fail compilation if LOG2_ALWAYS_RUNTIME is not set but is required. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-03-07 18:31:25 +08:00
for dead code. It is also required in immediate mode since it requires
logging: Use runtime packaging in immediate mode Always use runtime packaging in immediate mode. Removing attempt to package on stack if possible. It would be done only to speed up logging but that is not a requirement in immediate mode where packaging time is fractional compared to backend processing. Using runtime packaging also reduces stack usage in the context which calls log message. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-02-09 18:59:26 +08:00
less stack than static message creation and speed has lower priority
in that mode.
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
logging: Removing v2 suffix from logging names Renaming objects which had 2 in the name to indicate that it is v2 specific. Once logging v1 has been removed such suffixes are redundant. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-21 17:51:38 +08:00
config LOG_FMT_SECTION
logging: Add logging v2 implementation for log_msg Added implementation of log_msg2 which is creating log messages using cbprintf packaging and storing them in circular ring buffer (mpsg_pbuf). Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2020-11-20 00:25:03 +08:00
bool "Keep log strings in dedicated section"
help
When enabled, logs are kept in dedicated memory section. It allows
removing strings from final binary and should be used for dictionary
logging.
logging: Removing v2 suffix from logging names Renaming objects which had 2 in the name to indicate that it is v2 specific. Once logging v1 has been removed such suffixes are redundant. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-21 17:51:38 +08:00
config LOG_USE_TAGGED_ARGUMENTS
logging: support tagged argument in log message packaging This adds support for packaging with tagged arguments for log messages so that backends can make use of this information when they process messages. Note that currently tagged arguments must be used with CONFIG_LOG2_ALWAYS_RUNTIME where log messages are created via z_log_msg2_runtime_{v,}create(). For some reason, using C++ on Cortex-M (mps2_an385) results in an additional empty string argument being added to the list. This does not happen if only doing C on mps2_an385, or on other architectures. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-02-17 05:03:54 +08:00
bool "Using tagged arguments for packaging"
lib/cbprintf: Disable tagged arguments with picolibc Picolibc doesn't have the non-standard printf support required for tagged arguments in cbprintf. Disable this and use the format string parsing code instead. Signed-off-by: Keith Packard <keithp@keithp.com>
2022-06-28 13:56:13 +08:00
depends on !PICOLIBC
logging: support tagged argument in log message packaging This adds support for packaging with tagged arguments for log messages so that backends can make use of this information when they process messages. Note that currently tagged arguments must be used with CONFIG_LOG2_ALWAYS_RUNTIME where log messages are created via z_log_msg2_runtime_{v,}create(). For some reason, using C++ on Cortex-M (mps2_an385) results in an additional empty string argument being added to the list. This does not happen if only doing C on mps2_an385, or on other architectures. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-02-17 05:03:54 +08:00
select CBPRINTF_PACKAGE_SUPPORT_TAGGED_ARGUMENTS
logging: Removing v2 suffix from logging names Renaming objects which had 2 in the name to indicate that it is v2 specific. Once logging v1 has been removed such suffixes are redundant. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-21 17:51:38 +08:00
select LOG_ALWAYS_RUNTIME
logging: support tagged argument in log message packaging This adds support for packaging with tagged arguments for log messages so that backends can make use of this information when they process messages. Note that currently tagged arguments must be used with CONFIG_LOG2_ALWAYS_RUNTIME where log messages are created via z_log_msg2_runtime_{v,}create(). For some reason, using C++ on Cortex-M (mps2_an385) results in an additional empty string argument being added to the list. This does not happen if only doing C on mps2_an385, or on other architectures. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-02-17 05:03:54 +08:00
help
If enabled, packaging uses tagged arguments.
logging: Add common api for getting memory usage Logging v2 did not support getting memory usage data. Adding this support by creating common api for getting current and maximum usage. Tracking of maximum usage is optional and can be enabled using CONFIG_LOG_MEM_UTILIZATION. Updated shell command to use common API. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-02-07 21:36:36 +08:00
config LOG_MEM_UTILIZATION
kconfig: remove Enable from boolean prompts According to Kconfig guidelines, boolean prompts must not start with "Enable...". The following command has been used to automate the changes in this patch: sed -i "s/bool \"[Ee]nables\? \(\w\)/bool \"\U\1/g" **/Kconfig* Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 19:05:12 +08:00
bool "Tracking maximum memory utilization"
logging: Add common api for getting memory usage Logging v2 did not support getting memory usage data. Adding this support by creating common api for getting current and maximum usage. Tracking of maximum usage is optional and can be enabled using CONFIG_LOG_MEM_UTILIZATION. Updated shell command to use common API. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-02-07 21:36:36 +08:00
depends on LOG_MODE_DEFERRED
default y if LOG_CMDS
help
When enabled, maximum usage of memory used for log messages in deferred
mode is tracked. It can be used to trim LOG_BUFFER_SIZE.
logging: Kconfig cleanup of frontened related options Cleanup in kconfig options in preparation for adding a frontend that will use dictionary mode. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-03-29 21:47:01 +08:00
config LOG_DICTIONARY_DB
bool
logging: Add option LOG_MSG_APPEND_RO_STRING_LOC Bring back Kconfig option which was previously removed by 9cd5086407 (previously named LOG_MSG_PKG_ALWAYS_ADD_RO_STRING_IDXS). Renamed to shorten and be more descriptive. It can be useful for external backends or frontends. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-09-30 23:31:14 +08:00
config LOG_MSG_APPEND_RO_STRING_LOC
bool
help
Enable this option to force log messages to always append location of
read-only string arguments in the package. This should be selected by
backends if required.
logging: Initial multidomain support Adding multidomain support by introducing log_link module which acts as a receiver of log messages created by another domain. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-07-14 12:49:11 +08:00
config LOG_FAILURE_REPORT_PERIOD
int "Failure report period (in milliseconds)"
default 1000
depends on LOG_MODE_DEFERRED
help
Determines how often failures are reported. Report contains number
of dropped messages. It may contain additional information depending
on the mode.
config LOG_DOMAIN_NAME
string "Domain name"
default ""
if LOG_MULTIDOMAIN
config LOG_REMOTE_DOMAIN_MAX_COUNT
int "Maximum number of link domains"
default 4
help
Number of domains that can be handled by a link
endif
logging: Revamp menuconfig Clean up logging menuconfig by grouping configuration into sections like: mode, processing configuration, backends. Additionlly, removed LOG_ENABLE_FANCY_OUTPUT_FORMATTING which is no longer in use. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-01-18 21:31:11 +08:00
endmenu