/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */ /* NetworkManager -- Network link manager * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * * Copyright (C) 2006 - 2012 Red Hat, Inc. * Copyright (C) 2006 - 2008 Novell, Inc. */ #ifndef __NETWORKMANAGER_LOGGING_H__ #define __NETWORKMANAGER_LOGGING_H__ #include "nm-core-types.h" #ifdef __NM_TEST_UTILS_H__ #error nm-test-utils.h must be included as last header #endif #define NM_LOG_CONFIG_BACKEND_DEBUG "debug" #define NM_LOG_CONFIG_BACKEND_SYSLOG "syslog" #define NM_LOG_CONFIG_BACKEND_JOURNAL "journal" /* Log domains */ typedef enum { /*< skip >*/ LOGD_NONE = 0LL, LOGD_PLATFORM = (1LL << 0), /* Platform services */ LOGD_RFKILL = (1LL << 1), LOGD_ETHER = (1LL << 2), LOGD_WIFI = (1LL << 3), LOGD_BT = (1LL << 4), LOGD_MB = (1LL << 5), /* mobile broadband */ LOGD_DHCP4 = (1LL << 6), LOGD_DHCP6 = (1LL << 7), LOGD_PPP = (1LL << 8), LOGD_WIFI_SCAN = (1LL << 9), LOGD_IP4 = (1LL << 10), LOGD_IP6 = (1LL << 11), LOGD_AUTOIP4 = (1LL << 12), LOGD_DNS = (1LL << 13), LOGD_VPN = (1LL << 14), LOGD_SHARING = (1LL << 15), /* Connection sharing/dnsmasq */ LOGD_SUPPLICANT = (1LL << 16), /* WiFi and 802.1x */ LOGD_AGENTS = (1LL << 17), /* Secret agents */ LOGD_SETTINGS = (1LL << 18), /* Settings */ LOGD_SUSPEND = (1LL << 19), /* Suspend/Resume */ LOGD_CORE = (1LL << 20), /* Core daemon and policy stuff */ LOGD_DEVICE = (1LL << 21), /* Device state and activation */ LOGD_OLPC = (1LL << 22), LOGD_INFINIBAND = (1LL << 23), LOGD_FIREWALL = (1LL << 24), LOGD_ADSL = (1LL << 25), LOGD_BOND = (1LL << 26), LOGD_VLAN = (1LL << 27), LOGD_BRIDGE = (1LL << 28), LOGD_DBUS_PROPS = (1LL << 29), LOGD_TEAM = (1LL << 30), LOGD_CONCHECK = (1LL << 31), LOGD_DCB = (1LL << 32), /* Data Center Bridging */ LOGD_DISPATCH = (1LL << 33), LOGD_AUDIT = (1LL << 34), LOGD_SYSTEMD = (1LL << 35), LOGD_VPN_PLUGIN = (1LL << 36), LOGD_PROXY = (1LL << 37), __LOGD_MAX, LOGD_ALL = (((__LOGD_MAX - 1LL) << 1) - 1LL), LOGD_DEFAULT = LOGD_ALL & ~( LOGD_DBUS_PROPS | LOGD_WIFI_SCAN | LOGD_VPN_PLUGIN | 0), /* aliases: */ LOGD_DHCP = LOGD_DHCP4 | LOGD_DHCP6, LOGD_IP = LOGD_IP4 | LOGD_IP6, } NMLogDomain; static inline NMLogDomain LOGD_IP_from_af (int addr_family) { switch (addr_family) { case AF_INET: return LOGD_IP4; case AF_INET6: return LOGD_IP6; } g_return_val_if_reached (LOGD_NONE); } /* Log levels */ typedef enum { /*< skip >*/ LOGL_TRACE, LOGL_DEBUG, LOGL_INFO, LOGL_WARN, LOGL_ERR, _LOGL_N_REAL, /* the number of actual logging levels */ _LOGL_OFF = _LOGL_N_REAL, /* special logging level that is always disabled. */ _LOGL_KEEP, /* special logging level to indicate that the logging level should not be changed. */ _LOGL_N, /* the number of logging levels including "OFF" */ } NMLogLevel; #define nm_log_err(domain, ...) nm_log (LOGL_ERR, (domain), NULL, NULL, __VA_ARGS__) #define nm_log_warn(domain, ...) nm_log (LOGL_WARN, (domain), NULL, NULL, __VA_ARGS__) #define nm_log_info(domain, ...) nm_log (LOGL_INFO, (domain), NULL, NULL, __VA_ARGS__) #define nm_log_dbg(domain, ...) nm_log (LOGL_DEBUG, (domain), NULL, NULL, __VA_ARGS__) #define nm_log_trace(domain, ...) nm_log (LOGL_TRACE, (domain), NULL, NULL, __VA_ARGS__) //#define _NM_LOG_FUNC G_STRFUNC #define _NM_LOG_FUNC NULL /* A wrapper for the _nm_log_impl() function that adds call site information. * Contrary to nm_log(), it unconditionally calls the function without * checking whether logging for the given level and domain is enabled. */ #define _nm_log(level, domain, error, ifname, con_uuid, ...) \ G_STMT_START { \ _nm_log_impl (__FILE__, __LINE__, \ _NM_LOG_FUNC, \ (level), \ (domain), \ (error), \ (ifname), \ (con_uuid), \ ""__VA_ARGS__); \ } G_STMT_END /* nm_log() only evaluates its argument list after checking * whether logging for the given level/domain is enabled. */ #define nm_log(level, domain, ifname, con_uuid, ...) \ G_STMT_START { \ if (nm_logging_enabled ((level), (domain))) { \ _nm_log (level, domain, 0, ifname, con_uuid, __VA_ARGS__); \ } \ } G_STMT_END #define _nm_log_ptr(level, domain, ifname, con_uuid, self, prefix, ...) \ nm_log ((level), \ (domain), \ (ifname), \ (con_uuid), \ "%s[%p] " _NM_UTILS_MACRO_FIRST(__VA_ARGS__), \ (prefix) ?: "", \ self _NM_UTILS_MACRO_REST(__VA_ARGS__)) static inline gboolean _nm_log_ptr_is_debug (NMLogLevel level) { return level <= LOGL_DEBUG; } /* log a message for an object (with providing a generic @self pointer) */ #define nm_log_ptr(level, domain, ifname, con_uuid, self, prefix, ...) \ G_STMT_START { \ if (_nm_log_ptr_is_debug (level)) { \ _nm_log_ptr ((level), \ (domain), \ (ifname), \ (con_uuid), \ (self), \ (prefix), \ __VA_ARGS__); \ } else { \ const char *__prefix = (prefix); \ \ nm_log ((level), \ (domain), \ (ifname), \ (con_uuid), \ "%s%s" _NM_UTILS_MACRO_FIRST(__VA_ARGS__), \ __prefix ?: "", \ __prefix ? " " : "" _NM_UTILS_MACRO_REST(__VA_ARGS__)); \ } \ } G_STMT_END #define _nm_log_obj(level, domain, ifname, con_uuid, self, prefix, ...) \ _nm_log_ptr ((level), \ (domain), \ (ifname), \ (con_uuid), \ (self), \ prefix, \ __VA_ARGS__) /* log a message for an object (with providing a @self pointer to a GObject). * Contrary to nm_log_ptr(), @self must be a GObject type (or %NULL). * As of now, nm_log_obj() is identical to nm_log_ptr(), but we might change that */ #define nm_log_obj(level, domain, ifname, con_uuid, self, prefix, ...) \ nm_log_ptr ((level), \ (domain), \ (ifname), \ (con_uuid), \ (self), \ prefix, \ __VA_ARGS__) void _nm_log_impl (const char *file, guint line, const char *func, NMLogLevel level, NMLogDomain domain, int error, const char *ifname, const char *con_uuid, const char *fmt, ...) _nm_printf (9, 10); const char *nm_logging_level_to_string (void); const char *nm_logging_domains_to_string (void); extern NMLogDomain _nm_logging_enabled_state[_LOGL_N_REAL]; static inline gboolean nm_logging_enabled (NMLogLevel level, NMLogDomain domain) { nm_assert (((guint) level) < G_N_ELEMENTS (_nm_logging_enabled_state)); return (((guint) level) < G_N_ELEMENTS (_nm_logging_enabled_state)) && !!(_nm_logging_enabled_state[level] & domain); } NMLogLevel nm_logging_get_level (NMLogDomain domain); const char *nm_logging_all_levels_to_string (void); const char *nm_logging_all_domains_to_string (void); gboolean nm_logging_setup (const char *level, const char *domains, char **bad_domains, GError **error); void nm_logging_set_syslog_identifier (const char *domain); void nm_logging_set_prefix (const char *format, ...) _nm_printf (1, 2); void nm_logging_syslog_openlog (const char *logging_backend, gboolean debug); gboolean nm_logging_syslog_enabled (void); /*****************************************************************************/ /* This is the default definition of _NMLOG_ENABLED(). Special implementations * might want to undef this and redefine it. */ #define _NMLOG_ENABLED(level) ( nm_logging_enabled ((level), (_NMLOG_DOMAIN)) ) #define _LOGT(...) _NMLOG (LOGL_TRACE, __VA_ARGS__) #define _LOGD(...) _NMLOG (LOGL_DEBUG, __VA_ARGS__) #define _LOGI(...) _NMLOG (LOGL_INFO , __VA_ARGS__) #define _LOGW(...) _NMLOG (LOGL_WARN , __VA_ARGS__) #define _LOGE(...) _NMLOG (LOGL_ERR , __VA_ARGS__) #define _LOGT_ENABLED(...) _NMLOG_ENABLED (LOGL_TRACE, ##__VA_ARGS__) #define _LOGD_ENABLED(...) _NMLOG_ENABLED (LOGL_DEBUG, ##__VA_ARGS__) #define _LOGI_ENABLED(...) _NMLOG_ENABLED (LOGL_INFO , ##__VA_ARGS__) #define _LOGW_ENABLED(...) _NMLOG_ENABLED (LOGL_WARN , ##__VA_ARGS__) #define _LOGE_ENABLED(...) _NMLOG_ENABLED (LOGL_ERR , ##__VA_ARGS__) #define _LOGT_err(errsv, ...) _NMLOG_err (errsv, LOGL_TRACE, __VA_ARGS__) #define _LOGD_err(errsv, ...) _NMLOG_err (errsv, LOGL_DEBUG, __VA_ARGS__) #define _LOGI_err(errsv, ...) _NMLOG_err (errsv, LOGL_INFO , __VA_ARGS__) #define _LOGW_err(errsv, ...) _NMLOG_err (errsv, LOGL_WARN , __VA_ARGS__) #define _LOGE_err(errsv, ...) _NMLOG_err (errsv, LOGL_ERR , __VA_ARGS__) /* _LOGT() and _LOGt() both log with level TRACE, but the latter is disabled by default, * unless building with --with-more-logging. */ #if NM_MORE_LOGGING #define _LOGt_ENABLED(...) _NMLOG_ENABLED (LOGL_TRACE, ##__VA_ARGS__) #define _LOGt(...) _NMLOG (LOGL_TRACE, __VA_ARGS__) #define _LOGt_err(errsv, ...) _NMLOG_err (errsv, LOGL_TRACE, __VA_ARGS__) #else /* still call the logging macros to get compile time checks, but they will be optimized out. */ #define _LOGt_ENABLED(...) ( FALSE && (_NMLOG_ENABLED (LOGL_TRACE, ##__VA_ARGS__)) ) #define _LOGt(...) G_STMT_START { if (FALSE) { _NMLOG (LOGL_TRACE, __VA_ARGS__); } } G_STMT_END #define _LOGt_err(errsv, ...) G_STMT_START { if (FALSE) { _NMLOG_err (errsv, LOGL_TRACE, __VA_ARGS__); } } G_STMT_END #endif /*****************************************************************************/ /* Some implementation define a second set of logging macros, for a separate * use. As with the _LOGD() macro family above, the exact implementation * depends on the file that uses them. * Still, it encourages a common pattern to have the common set of macros * like _LOG2D(), _LOG2I(), etc. and have _LOG2t() which by default * is disabled at compile time. */ #define _NMLOG2_ENABLED(level) ( nm_logging_enabled ((level), (_NMLOG2_DOMAIN)) ) #define _LOG2T(...) _NMLOG2 (LOGL_TRACE, __VA_ARGS__) #define _LOG2D(...) _NMLOG2 (LOGL_DEBUG, __VA_ARGS__) #define _LOG2I(...) _NMLOG2 (LOGL_INFO , __VA_ARGS__) #define _LOG2W(...) _NMLOG2 (LOGL_WARN , __VA_ARGS__) #define _LOG2E(...) _NMLOG2 (LOGL_ERR , __VA_ARGS__) #define _LOG2T_ENABLED(...) _NMLOG2_ENABLED (LOGL_TRACE, ##__VA_ARGS__) #define _LOG2D_ENABLED(...) _NMLOG2_ENABLED (LOGL_DEBUG, ##__VA_ARGS__) #define _LOG2I_ENABLED(...) _NMLOG2_ENABLED (LOGL_INFO , ##__VA_ARGS__) #define _LOG2W_ENABLED(...) _NMLOG2_ENABLED (LOGL_WARN , ##__VA_ARGS__) #define _LOG2E_ENABLED(...) _NMLOG2_ENABLED (LOGL_ERR , ##__VA_ARGS__) #define _LOG2T_err(errsv, ...) _NMLOG2_err (errsv, LOGL_TRACE, __VA_ARGS__) #define _LOG2D_err(errsv, ...) _NMLOG2_err (errsv, LOGL_DEBUG, __VA_ARGS__) #define _LOG2I_err(errsv, ...) _NMLOG2_err (errsv, LOGL_INFO , __VA_ARGS__) #define _LOG2W_err(errsv, ...) _NMLOG2_err (errsv, LOGL_WARN , __VA_ARGS__) #define _LOG2E_err(errsv, ...) _NMLOG2_err (errsv, LOGL_ERR , __VA_ARGS__) #if NM_MORE_LOGGING #define _LOG2t_ENABLED(...) _NMLOG2_ENABLED (LOGL_TRACE, ##__VA_ARGS__) #define _LOG2t(...) _NMLOG2 (LOGL_TRACE, __VA_ARGS__) #define _LOG2t_err(errsv, ...) _NMLOG2_err (errsv, LOGL_TRACE, __VA_ARGS__) #else /* still call the logging macros to get compile time checks, but they will be optimized out. */ #define _LOG2t_ENABLED(...) ( FALSE && (_NMLOG2_ENABLED (LOGL_TRACE, ##__VA_ARGS__)) ) #define _LOG2t(...) G_STMT_START { if (FALSE) { _NMLOG2 (LOGL_TRACE, __VA_ARGS__); } } G_STMT_END #define _LOG2t_err(errsv, ...) G_STMT_START { if (FALSE) { _NMLOG2_err (errsv, LOGL_TRACE, __VA_ARGS__); } } G_STMT_END #endif #define _NMLOG3_ENABLED(level) ( nm_logging_enabled ((level), (_NMLOG3_DOMAIN)) ) #define _LOG3T(...) _NMLOG3 (LOGL_TRACE, __VA_ARGS__) #define _LOG3D(...) _NMLOG3 (LOGL_DEBUG, __VA_ARGS__) #define _LOG3I(...) _NMLOG3 (LOGL_INFO , __VA_ARGS__) #define _LOG3W(...) _NMLOG3 (LOGL_WARN , __VA_ARGS__) #define _LOG3E(...) _NMLOG3 (LOGL_ERR , __VA_ARGS__) #define _LOG3T_ENABLED(...) _NMLOG3_ENABLED (LOGL_TRACE, ##__VA_ARGS__) #define _LOG3D_ENABLED(...) _NMLOG3_ENABLED (LOGL_DEBUG, ##__VA_ARGS__) #define _LOG3I_ENABLED(...) _NMLOG3_ENABLED (LOGL_INFO , ##__VA_ARGS__) #define _LOG3W_ENABLED(...) _NMLOG3_ENABLED (LOGL_WARN , ##__VA_ARGS__) #define _LOG3E_ENABLED(...) _NMLOG3_ENABLED (LOGL_ERR , ##__VA_ARGS__) #define _LOG3T_err(errsv, ...) _NMLOG3_err (errsv, LOGL_TRACE, __VA_ARGS__) #define _LOG3D_err(errsv, ...) _NMLOG3_err (errsv, LOGL_DEBUG, __VA_ARGS__) #define _LOG3I_err(errsv, ...) _NMLOG3_err (errsv, LOGL_INFO , __VA_ARGS__) #define _LOG3W_err(errsv, ...) _NMLOG3_err (errsv, LOGL_WARN , __VA_ARGS__) #define _LOG3E_err(errsv, ...) _NMLOG3_err (errsv, LOGL_ERR , __VA_ARGS__) #if NM_MORE_LOGGING #define _LOG3t_ENABLED(...) _NMLOG3_ENABLED (LOGL_TRACE, ##__VA_ARGS__) #define _LOG3t(...) _NMLOG3 (LOGL_TRACE, __VA_ARGS__) #define _LOG3t_err(errsv, ...) _NMLOG3_err (errsv, LOGL_TRACE, __VA_ARGS__) #else /* still call the logging macros to get compile time checks, but they will be optimized out. */ #define _LOG3t_ENABLED(...) ( FALSE && (_NMLOG3_ENABLED (LOGL_TRACE, ##__VA_ARGS__)) ) #define _LOG3t(...) G_STMT_START { if (FALSE) { _NMLOG3 (LOGL_TRACE, __VA_ARGS__); } } G_STMT_END #define _LOG3t_err(errsv, ...) G_STMT_START { if (FALSE) { _NMLOG3_err (errsv, LOGL_TRACE, __VA_ARGS__); } } G_STMT_END #endif extern void (*_nm_logging_clear_platform_logging_cache) (void); /*****************************************************************************/ #define __NMLOG_DEFAULT(level, domain, prefix, ...) \ G_STMT_START { \ nm_log ((level), (domain), NULL, NULL, \ "%s: " _NM_UTILS_MACRO_FIRST(__VA_ARGS__), \ (prefix) \ _NM_UTILS_MACRO_REST(__VA_ARGS__)); \ } G_STMT_END #define __NMLOG_DEFAULT_WITH_ADDR(level, domain, prefix, ...) \ G_STMT_START { \ nm_log ((level), (domain), NULL, NULL, \ "%s[%p]: " _NM_UTILS_MACRO_FIRST(__VA_ARGS__), \ (prefix), \ (self) \ _NM_UTILS_MACRO_REST(__VA_ARGS__)); \ } G_STMT_END #endif /* __NETWORKMANAGER_LOGGING_H__ */