logging: Deprecate v1, default to v2

Reduced logging mode selection to deferred, immediate, minimal and
frontend. Decoupled logging version from mode and created CONFIG_LOG1
which can be used to explicitly select deprecated version.

From now on, chosing CONFIG_LOG_MODE_{IMMEDIATE,DEFERRED} will result
in version2.

Deprecated CONFIG_LOG2_MODE_{IMMEDIATE,DEFERRED} with cmake warning.

Codebase adapted to those changes.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>

Author: nordic-krch

boards/posix/native_posix/doc/index.rst

@@ -644,7 +644,7 @@ development by integrating more seamlessly with the host operating system:
   ``--force-color``.
 
   In native_posix, by default, the logger is configured with
-  :kconfig:`CONFIG_LOG_IMMEDIATE`.
+  :kconfig:`CONFIG_LOG_MODE_IMMEDIATE`.
 
   This backend can be selected with :kconfig:`CONFIG_LOG_BACKEND_NATIVE_POSIX`
   and is enabled by default unless the native_posix UART is compiled in.

doc/reference/logging/index.rst

@@ -117,14 +117,12 @@ Mode of operations:
 
 :kconfig:`CONFIG_LOG_MODE_DEFERRED`: Deferred mode.
 
-:kconfig:`CONFIG_LOG2_MODE_DEFERRED`: Deferred mode v2.
-
 :kconfig:`CONFIG_LOG_MODE_IMMEDIATE`: Immediate (synchronous) mode.
 
-:kconfig:`CONFIG_LOG2_MODE_IMMEDIATE`: Immediate (synchronous) mode v2.
-
 :kconfig:`CONFIG_LOG_MODE_MINIMAL`: Minimal footprint mode.
 
+:kconfig:`CONFIG_LOG1`: Use deprecated version of logging.
+
 Filtering options:
 
 :kconfig:`CONFIG_LOG_RUNTIME_FILTERING`: Enables runtime reconfiguration of the

include/logging/log_backend_std.h

@@ -101,8 +101,7 @@ log_backend_std_sync_string(const struct log_output *const output,
 		flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
 	}
 
-	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE) &&
-		IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
+	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
 		/* In order to ensure that one log processing is not interrupted
 		 * by another one, lock context for whole log processing.
 		 */
@@ -111,8 +110,7 @@ log_backend_std_sync_string(const struct log_output *const output,
 
 	log_output_string(output, src_level, timestamp, fmt, ap, flags);
 
-	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE) &&
-		IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
+	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
 		irq_unlock(key);
 	}
 }
@@ -144,8 +142,7 @@ log_backend_std_sync_hexdump(const struct log_output *const output,
 		flags |= LOG_OUTPUT_FLAG_FORMAT_TIMESTAMP;
 	}
 
-	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE) &&
-		IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
+	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
 		/* In order to ensure that one log processing is not interrupted
 		 * by another one, lock context for whole log processing.
 		 */
@@ -155,8 +152,7 @@ log_backend_std_sync_hexdump(const struct log_output *const output,
 	log_output_hexdump(output, src_level, timestamp,
 			metadata, data, length, flags);
 
-	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE) &&
-		IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
+	if (IS_ENABLED(CONFIG_LOG_IMMEDIATE_CLEAN_OUTPUT)) {
 		irq_unlock(key);
 	}
 }

include/logging/log_core.h

@@ -202,7 +202,7 @@ extern "C" {
 #define Z_LOG_INTERNAL2(is_user_context, _src_level, ...) do { \
 	if (is_user_context) { \
 		log_from_user(_src_level, __VA_ARGS__); \
-	} else if (IS_ENABLED(CONFIG_LOG_IMMEDIATE)) { \
+	} else if (IS_ENABLED(CONFIG_LOG_MODE_IMMEDIATE)) { \
 		log_string_sync(_src_level, __VA_ARGS__); \
 	} else { \
 		Z_LOG_INTERNAL_X(Z_LOG_NARGS_POSTFIX(__VA_ARGS__), \
@@ -442,7 +442,7 @@ static inline char z_log_minimal_level_to_char(int level)
 	if (is_user_context) { \
 		log_hexdump_from_user(src_level, _str, \
 				      (const char *)_data, _len); \
-	} else if (IS_ENABLED(CONFIG_LOG_IMMEDIATE)) { \
+	} else if (IS_ENABLED(CONFIG_LOG_MODE_IMMEDIATE)) { \
 		log_hexdump_sync(src_level, _str, (const char *)_data, _len); \
 	} else { \
 		log_hexdump(_str, (const char *)_data, _len, src_level); \
@@ -860,7 +860,7 @@ static inline log_arg_t z_log_do_strdup(uint32_t msk, uint32_t idx,
 do {									       \
 	if (is_user_context) {						       \
 		log_generic_from_user(_src_level, _str, _valist);	       \
-	} else if (IS_ENABLED(CONFIG_LOG_IMMEDIATE)) {			       \
+	} else if (IS_ENABLED(CONFIG_LOG_MODE_IMMEDIATE)) {		       \
 		log_generic(_src_level, _str, _valist, _strdup_action);        \
 	} else if (_argnum == 0) {					       \
 		_LOG_INTERNAL_0(_src_level, _str);			       \

include/logging/log_ctrl.h

@@ -201,10 +201,9 @@ uint32_t log_get_strdup_longest_string(void);
  */
 static inline bool log_data_pending(void)
 {
-	if (IS_ENABLED(CONFIG_LOG2_MODE_DEFERRED)) {
-		return z_log_msg2_pending();
-	} else if (IS_ENABLED(CONFIG_LOG_MODE_DEFERRED)) {
-		return log_msg_mem_get_used() > 0;
+	if (IS_ENABLED(CONFIG_LOG_MODE_DEFERRED)) {
+		return IS_ENABLED(CONFIG_LOG2) ?
+			z_log_msg2_pending() : (log_msg_mem_get_used() > 0);
 	}
 
 	return false;

include/logging/log_msg2.h

@@ -353,7 +353,7 @@ do {\
 				  Z_LOG_FMT_ARGS(_fmt, ##__VA_ARGS__));\
 	_mode = Z_LOG_MSG2_MODE_RUNTIME; \
 } while (0)
-#elif defined(CONFIG_LOG2_MODE_IMMEDIATE) /* CONFIG_LOG2_ALWAYS_RUNTIME */
+#elif defined(CONFIG_LOG_MODE_IMMEDIATE) /* CONFIG_LOG2_ALWAYS_RUNTIME */
 #define Z_LOG_MSG2_CREATE2(_try_0cpy, _mode,  _cstr_cnt, _domain_id, _source,\
 			  _level, _data, _dlen, ...) \
 do { \

include/shell/shell_log_backend.h

@@ -91,9 +91,9 @@ int z_shell_log_backend_output_func(uint8_t *data, size_t length, void *ctx);
 		.log_output = &_name##_log_output, \
 		.control_block = &_name##_control_block, \
 		.timeout = _timeout, \
-		.mpsc_buffer_config = IS_ENABLED(CONFIG_LOG2_MODE_DEFERRED) ? \
+		.mpsc_buffer_config = IS_ENABLED(CONFIG_LOG2_DEFERRED) ? \
 			&_name##_mpsc_buffer_config : NULL, \
-		.mpsc_buffer = IS_ENABLED(CONFIG_LOG2_MODE_DEFERRED) ? \
+		.mpsc_buffer = IS_ENABLED(CONFIG_LOG2_DEFERRED) ? \
 			&_name##_mpsc_buffer : NULL, \
 	}
 

samples/bluetooth/iso_broadcast_benchmark/prj.conf

@@ -14,5 +14,4 @@ CONFIG_MAIN_STACK_SIZE=2048
 
 CONFIG_LOG=y
 CONFIG_CBPRINTF_FP_SUPPORT=y
-CONFIG_LOG2_MODE_DEFERRED=y
 CONFIG_LOG_BUFFER_SIZE=2048

samples/bluetooth/iso_connected_benchmark/prj.conf

@@ -13,5 +13,4 @@ CONFIG_MAIN_STACK_SIZE=2048
 
 CONFIG_LOG=y
 CONFIG_CBPRINTF_FP_SUPPORT=y
-CONFIG_LOG2_MODE_DEFERRED=y
 CONFIG_LOG_BUFFER_SIZE=2048

samples/subsys/logging/dictionary/prj.conf

@@ -2,4 +2,3 @@ CONFIG_LOG=y
 CONFIG_LOG_PRINTK=y
 CONFIG_LOG_BACKEND_UART_OUTPUT_DICTIONARY_HEX=y
 CONFIG_LOG_BACKEND_UART=y
-CONFIG_LOG2_MODE_DEFERRED=y