fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-30 16:40:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

libnm: merge branch 'th/libnm-client-debug'

Browse source 
https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1796
This commit is contained in:
Thomas Haller 2023-12-12 20:17:44 +01:00
commit 28bf977500
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
2 changed files with 59 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
src/libnm-client-impl/nm-libnm-utils.c
View file

@ -30,8 +30,12 @@ _nml_dbus_log_level_init(void)
const GDebugKey keys[] = {
{"trace", _NML_DBUS_LOG_LEVEL_TRACE},
{"debug", _NML_DBUS_LOG_LEVEL_DEBUG},
{"warn", _NML_DBUS_LOG_LEVEL_WARN},
{"warning", _NML_DBUS_LOG_LEVEL_WARN},
{"error", _NML_DBUS_LOG_LEVEL_ERROR},
{"WARN", _NML_DBUS_LOG_LEVEL_WARN | NML_DBUS_LOG_ASSERT},
{"WARNING", _NML_DBUS_LOG_LEVEL_WARN | NML_DBUS_LOG_ASSERT},
{"ERROR", _NML_DBUS_LOG_LEVEL_ERROR | NML_DBUS_LOG_ASSERT},
{"stdout", NML_DBUS_LOG_STDOUT},
};
int l;
@ -147,6 +151,12 @@ _nml_dbus_log(NMLDBusLogLevel level, gboolean use_stdout, const char *fmt, ...)
gint64 ts;
pid_t pid;
nm_assert(NM_IN_SET(level,
NML_DBUS_LOG_LEVEL_TRACE,
NML_DBUS_LOG_LEVEL_DEBUG,
NML_DBUS_LOG_LEVEL_WARN,
NML_DBUS_LOG_LEVEL_ERROR));
/* we only call _nml_dbus_log() after nml_dbus_log_enabled(), which already does
* an atomic access to the variable. Since the value is only initialized once and
* never changes, we can just access it without additional locking. */
@ -167,21 +177,13 @@ _nml_dbus_log(NMLDBusLogLevel level, gboolean use_stdout, const char *fmt, ...)
break;
case NML_DBUS_LOG_LEVEL_WARN:
prefix = "<warn > ";
if (NM_FLAGS_HAS(configured_log_level, _NML_DBUS_LOG_LEVEL_WARN)) {
if (NM_FLAGS_HAS(configured_log_level, NML_DBUS_LOG_ASSERT))
g_warning("libnm-dbus: %s%s", prefix, msg);
return;
}
break;
case NML_DBUS_LOG_LEVEL_ERROR:
prefix = "<error> ";
if (NM_FLAGS_HAS(configured_log_level, _NML_DBUS_LOG_LEVEL_ERROR)) {
if (NM_FLAGS_HAS(configured_log_level, NML_DBUS_LOG_ASSERT))
g_critical("libnm-dbus: %s%s", prefix, msg);
return;
}
if (NM_FLAGS_HAS(configured_log_level, _NML_DBUS_LOG_LEVEL_WARN)) {
g_warning("libnm-dbus: %s%s", prefix, msg);
return;
}
break;
default:
break;
@ -987,10 +989,26 @@ nm_utils_g_param_spec_is_default(const GParamSpec *pspec)
* with these functions (it implements additional buffering). By
* using nm_utils_print(), the same logging mechanisms can be used.
*
* Also, libnm honors LIBNM_CLIENT_DEBUG_FILE environment. If this
* is set to a filename pattern (accepting "%p" for the process ID),
* then the debug log is written to that file instead. With @output_mode
* zero, the same location will be written. Since: 1.44.
* LIBNM_CLIENT_DEBUG is a list of keywords separated by commas. The keyword
* "trace" enables printing messages of the lowest up to the highest severity.
* Likewise, the severities "debug", "warn" ("warning") and "error" are honored
* in similar way. Setting the flags "ERROR" or "WARN" ("WARNING") implies that
* respective levels are enabled, but also are ERROR messages printed with
* g_critical() and WARN messages with g_warning(). Together with G_DEBUG="fatal-warnings"
* or G_DEBUG="fatal-critical" this can be used to abort the program on errors.
* Note that all &lt;error&gt; messages imply an unexpected data on the D-Bus API
* (due to a bug). &lt;warn&gt; also implies unexepected data, but that can happen
* when using different versions of libnm and daemon. For testing, it is
* good to turn these into assertions.
*
* By default, messages are printed to stderr, unless LIBNM_CLIENT_DEBUG
* contains "stdout" flag. Also, libnm honors LIBNM_CLIENT_DEBUG_FILE
* environment. If this is set to a filename pattern (accepting "%%p" for the
* process ID), then the debug log is written to that file instead of
* stderr/stdout. With @output_mode zero, the same location will be written.
*
* LIBNM_CLIENT_DEBUG_FILE is supported since 1.44. "ERROR", "WARN" and "WARNING"
* are supported since 1.46.
*
* Since: 1.30
*/

46
src/libnm-client-impl/nm-libnm-utils.h
View file

@ -26,31 +26,35 @@ typedef enum {
_NML_DBUS_LOG_LEVEL_INITIALIZED = 0x01,
_NML_DBUS_LOG_LEVEL_TRACE = 0x02,
NML_DBUS_LOG_LEVEL_TRACE = 0x02,
_NML_DBUS_LOG_LEVEL_DEBUG = 0x04,
NML_DBUS_LOG_LEVEL_DEBUG = 0x04,
/* the difference between a warning and a critical is that it results in
* g_warning() vs. g_critical() messages. Note that we want to use "warnings"
* for unknown D-Bus API that could just result because we run against a
* newer NetworkManager version (such warnings are more graceful, because
* we want that libnm can be forward compatible against newer servers).
* Critical warnings should be emitted when NetworkManager exposes something
* on D-Bus that breaks the current expectations. Usually NetworkManager
* should not break API, hence such issues are more severe. */
_NML_DBUS_LOG_LEVEL_WARN = 0x08,
_NML_DBUS_LOG_LEVEL_ERROR = 0x10,
* g_warning() vs. g_critical() messages (with NML_DBUS_LOG_ASSERT). Note
* that we want to use "warnings" for unknown D-Bus API that could just
* result because we run against a newer NetworkManager version (such
* warnings are more graceful, because we want that libnm can be forward
* compatible against newer servers). Critical warnings should be emitted
* when NetworkManager exposes something on D-Bus that breaks the current
* expectations. Usually NetworkManager should not break API, hence such
* issues are more severe. */
NML_DBUS_LOG_LEVEL_WARN = 0x08,
NML_DBUS_LOG_LEVEL_ERROR = 0x10,
/* ANY is only relevant for nml_dbus_log_enabled() to check whether any of the
* options is on. */
NML_DBUS_LOG_LEVEL_ANY = _NML_DBUS_LOG_LEVEL_INITIALIZED,
NML_DBUS_LOG_LEVEL_TRACE = _NML_DBUS_LOG_LEVEL_TRACE,
NML_DBUS_LOG_LEVEL_DEBUG = _NML_DBUS_LOG_LEVEL_DEBUG | NML_DBUS_LOG_LEVEL_TRACE,
NML_DBUS_LOG_LEVEL_WARN = _NML_DBUS_LOG_LEVEL_WARN | NML_DBUS_LOG_LEVEL_DEBUG,
NML_DBUS_LOG_LEVEL_ERROR = _NML_DBUS_LOG_LEVEL_ERROR | NML_DBUS_LOG_LEVEL_WARN,
NML_DBUS_LOG_STDOUT = 0x20,
NML_DBUS_LOG_ASSERT = 0x40,
_NML_DBUS_LOG_LEVEL_ERROR = NML_DBUS_LOG_LEVEL_ERROR,
_NML_DBUS_LOG_LEVEL_WARN = NML_DBUS_LOG_LEVEL_WARN | _NML_DBUS_LOG_LEVEL_ERROR,
_NML_DBUS_LOG_LEVEL_DEBUG = NML_DBUS_LOG_LEVEL_DEBUG | _NML_DBUS_LOG_LEVEL_WARN,
_NML_DBUS_LOG_LEVEL_TRACE = NML_DBUS_LOG_LEVEL_TRACE | _NML_DBUS_LOG_LEVEL_DEBUG,
} NMLDBusLogLevel;
#undef _LOGL_TRACE
@ -61,7 +65,6 @@ typedef enum {
#define _LOGL_TRACE NML_DBUS_LOG_LEVEL_TRACE
#define _LOGL_DEBUG NML_DBUS_LOG_LEVEL_DEBUG
#define _LOGL_INFO NML_DBUS_LOG_LEVEL_INFO
#define _LOGL_WARN NML_DBUS_LOG_LEVEL_WARN
#define _LOGL_ERR NML_DBUS_LOG_LEVEL_ERR
@ -87,9 +90,14 @@ nml_dbus_log_enabled_full(NMLDBusLogLevel level, gboolean *out_use_stdout)
l = _nml_dbus_log_level_init();
nm_assert(l & _NML_DBUS_LOG_LEVEL_INITIALIZED);
NM_SET_OUT(out_use_stdout, NM_FLAGS_HAS(l, NML_DBUS_LOG_STDOUT));
if (level == NML_DBUS_LOG_LEVEL_ANY)
return l != _NML_DBUS_LOG_LEVEL_INITIALIZED;
if (level == NML_DBUS_LOG_LEVEL_ANY) {
return NM_FLAGS_ANY(l,
NML_DBUS_LOG_LEVEL_TRACE | NML_DBUS_LOG_LEVEL_DEBUG
| NML_DBUS_LOG_LEVEL_WARN | NML_DBUS_LOG_LEVEL_ERROR);
}
return !!(((NMLDBusLogLevel) l) & level);
}