// SPDX-License-Identifier: LGPL-2.1+ /* NetworkManager -- Network link manager * * (C) Copyright 2016 Red Hat, Inc. */ #ifndef __NM_SHARED_UTILS_H__ #define __NM_SHARED_UTILS_H__ #include /*****************************************************************************/ pid_t nm_utils_gettid (void); gboolean _nm_assert_on_main_thread (void); #if NM_MORE_ASSERTS > 5 #define NM_ASSERT_ON_MAIN_THREAD() G_STMT_START { nm_assert (_nm_assert_on_main_thread ()); } G_STMT_END #else #define NM_ASSERT_ON_MAIN_THREAD() G_STMT_START { ; } G_STMT_END #endif /*****************************************************************************/ static inline gboolean _NM_INT_NOT_NEGATIVE (gssize val) { /* whether an enum (without negative values) is a signed int, depends on compiler options * and compiler implementation. * * When using such an enum for accessing an array, one naturally wants to check * that the enum is not negative. However, the compiler doesn't like a plain * comparison "enum_val >= 0", because (if the enum is unsigned), it will warn * that the expression is always true *duh*. Not even a cast to a signed * type helps to avoid the compiler warning in any case. * * The sole purpose of this function is to avoid a compiler warning, when checking * that an enum is not negative. */ return val >= 0; } /* check whether the integer value is smaller than G_MAXINT32. This macro exists * for the sole purpose, that a plain "((int) value <= G_MAXINT32)" comparison * may cause the compiler or coverity that this check is always TRUE. But the * check depends on compile time and the size of C type "int". Of course, most * of the time in is gint32 and an int value is always <= G_MAXINT32. The check * exists to catch cases where that is not true. * * Together with the G_STATIC_ASSERT(), we make sure that this is always satisfied. */ G_STATIC_ASSERT (sizeof (int) == sizeof (gint32)); #if _NM_CC_SUPPORT_GENERIC #define _NM_INT_LE_MAXINT32(value) \ ({ \ _nm_unused typeof (value) _value = (value); \ \ _Generic((value), \ int: TRUE \ ); \ }) #else #define _NM_INT_LE_MAXINT32(value) ({ \ _nm_unused typeof (value) _value = (value); \ _nm_unused const int *_p_value = &_value; \ \ TRUE; \ }) #endif /*****************************************************************************/ static inline char nm_utils_addr_family_to_char (int addr_family) { switch (addr_family) { case AF_UNSPEC: return 'X'; case AF_INET: return '4'; case AF_INET6: return '6'; } g_return_val_if_reached ('?'); } static inline gsize nm_utils_addr_family_to_size (int addr_family) { switch (addr_family) { case AF_INET: return sizeof (in_addr_t); case AF_INET6: return sizeof (struct in6_addr); } g_return_val_if_reached (0); } #define nm_assert_addr_family(addr_family) \ nm_assert (NM_IN_SET ((addr_family), AF_INET, AF_INET6)) /*****************************************************************************/ typedef struct { union { guint8 addr_ptr[1]; in_addr_t addr4; struct in_addr addr4_struct; struct in6_addr addr6; /* NMIPAddr is really a union for IP addresses. * However, as ethernet addresses fit in here nicely, use * it also for an ethernet MAC address. */ guint8 addr_eth[6 /*ETH_ALEN*/]; }; } NMIPAddr; extern const NMIPAddr nm_ip_addr_zero; static inline gboolean nm_ip_addr_is_null (int addr_family, gconstpointer addr) { nm_assert (addr); if (addr_family == AF_INET6) return IN6_IS_ADDR_UNSPECIFIED ((const struct in6_addr *) addr); nm_assert (addr_family == AF_INET); return ((const struct in_addr *) addr)->s_addr == 0; } static inline void nm_ip_addr_set (int addr_family, gpointer dst, gconstpointer src) { nm_assert_addr_family (addr_family); nm_assert (dst); nm_assert (src); memcpy (dst, src, (addr_family != AF_INET6) ? sizeof (in_addr_t) : sizeof (struct in6_addr)); } gboolean nm_ip_addr_set_from_untrusted (int addr_family, gpointer dst, gconstpointer src, gsize src_len, int *out_addr_family); static inline gboolean nm_ip4_addr_is_localhost (in_addr_t addr4) { return (addr4 & htonl (0xFF000000u)) == htonl (0x7F000000u); } /*****************************************************************************/ #define NM_CMP_RETURN(c) \ G_STMT_START { \ const int _cc = (c); \ if (_cc) \ return _cc < 0 ? -1 : 1; \ } G_STMT_END #define NM_CMP_RETURN_DIRECT(c) \ G_STMT_START { \ const int _cc = (c); \ if (_cc) \ return _cc; \ } G_STMT_END #define NM_CMP_SELF(a, b) \ G_STMT_START { \ typeof (a) _a = (a); \ typeof (b) _b = (b); \ \ if (_a == _b) \ return 0; \ if (!_a) \ return -1; \ if (!_b) \ return 1; \ } G_STMT_END #define NM_CMP_DIRECT(a, b) \ G_STMT_START { \ typeof (a) _a = (a); \ typeof (b) _b = (b); \ \ if (_a != _b) \ return (_a < _b) ? -1 : 1; \ } G_STMT_END #define NM_CMP_DIRECT_MEMCMP(a, b, size) \ NM_CMP_RETURN (memcmp ((a), (b), (size))) #define NM_CMP_DIRECT_STRCMP(a, b) \ NM_CMP_RETURN_DIRECT (strcmp ((a), (b))) #define NM_CMP_DIRECT_STRCMP0(a, b) \ NM_CMP_RETURN_DIRECT (nm_strcmp0 ((a), (b))) #define NM_CMP_DIRECT_IN6ADDR(a, b) \ G_STMT_START { \ const struct in6_addr *const _a = (a); \ const struct in6_addr *const _b = (b); \ NM_CMP_RETURN (memcmp (_a, _b, sizeof (struct in6_addr))); \ } G_STMT_END #define NM_CMP_FIELD(a, b, field) \ NM_CMP_DIRECT (((a)->field), ((b)->field)) #define NM_CMP_FIELD_UNSAFE(a, b, field) \ G_STMT_START { \ /* it's unsafe, because it evaluates the arguments more then once. * This is necessary for bitfields, for which typeof() doesn't work. */ \ if (((a)->field) != ((b)->field)) \ return ((a)->field < ((b)->field)) ? -1 : 1; \ } G_STMT_END #define NM_CMP_FIELD_BOOL(a, b, field) \ NM_CMP_DIRECT (!!((a)->field), !!((b)->field)) #define NM_CMP_FIELD_STR(a, b, field) \ NM_CMP_RETURN (strcmp (((a)->field), ((b)->field))) #define NM_CMP_FIELD_STR_INTERNED(a, b, field) \ G_STMT_START { \ const char *_a = ((a)->field); \ const char *_b = ((b)->field); \ \ if (_a != _b) { \ NM_CMP_RETURN_DIRECT (nm_strcmp0 (_a, _b)); \ } \ } G_STMT_END #define NM_CMP_FIELD_STR0(a, b, field) \ NM_CMP_RETURN_DIRECT (nm_strcmp0 (((a)->field), ((b)->field))) #define NM_CMP_FIELD_MEMCMP_LEN(a, b, field, len) \ NM_CMP_RETURN (memcmp (&((a)->field), &((b)->field), \ NM_MIN (len, sizeof ((a)->field)))) #define NM_CMP_FIELD_MEMCMP(a, b, field) \ NM_CMP_RETURN (memcmp (&((a)->field), \ &((b)->field), \ sizeof ((a)->field))) #define NM_CMP_FIELD_IN6ADDR(a, b, field) \ G_STMT_START { \ const struct in6_addr *const _a = &((a)->field); \ const struct in6_addr *const _b = &((b)->field); \ NM_CMP_RETURN (memcmp (_a, _b, sizeof (struct in6_addr))); \ } G_STMT_END /*****************************************************************************/ gboolean nm_utils_memeqzero (gconstpointer data, gsize length); /*****************************************************************************/ extern const void *const _NM_PTRARRAY_EMPTY[1]; #define NM_PTRARRAY_EMPTY(type) ((type const*) _NM_PTRARRAY_EMPTY) static inline void _nm_utils_strbuf_init (char *buf, gsize len, char **p_buf_ptr, gsize *p_buf_len) { NM_SET_OUT (p_buf_len, len); NM_SET_OUT (p_buf_ptr, buf); buf[0] = '\0'; } #define nm_utils_strbuf_init(buf, p_buf_ptr, p_buf_len) \ G_STMT_START { \ G_STATIC_ASSERT (G_N_ELEMENTS (buf) == sizeof (buf) && sizeof (buf) > sizeof (char *)); \ _nm_utils_strbuf_init ((buf), sizeof (buf), (p_buf_ptr), (p_buf_len)); \ } G_STMT_END void nm_utils_strbuf_append (char **buf, gsize *len, const char *format, ...) _nm_printf (3, 4); void nm_utils_strbuf_append_c (char **buf, gsize *len, char c); void nm_utils_strbuf_append_str (char **buf, gsize *len, const char *str); void nm_utils_strbuf_append_bin (char **buf, gsize *len, gconstpointer str, gsize str_len); void nm_utils_strbuf_seek_end (char **buf, gsize *len); const char *nm_strquote (char *buf, gsize buf_len, const char *str); static inline gboolean nm_utils_is_separator (const char c) { return NM_IN_SET (c, ' ', '\t'); } /*****************************************************************************/ static inline gboolean nm_gbytes_equal0 (GBytes *a, GBytes *b) { return a == b || (a && b && g_bytes_equal (a, b)); } gboolean nm_utils_gbytes_equal_mem (GBytes *bytes, gconstpointer mem_data, gsize mem_len); GVariant *nm_utils_gbytes_to_variant_ay (GBytes *bytes); /*****************************************************************************/ GVariant *nm_utils_gvariant_vardict_filter (GVariant *src, gboolean (*filter_fcn) (const char *key, GVariant *val, char **out_key, GVariant **out_val, gpointer user_data), gpointer user_data); GVariant * nm_utils_gvariant_vardict_filter_drop_one (GVariant *src, const char *key); /*****************************************************************************/ static inline int nm_utils_hexchar_to_int (char ch) { G_STATIC_ASSERT_EXPR ('0' < 'A'); G_STATIC_ASSERT_EXPR ('A' < 'a'); if (ch >= '0') { if (ch <= '9') return ch - '0'; if (ch >= 'A') { if (ch <= 'F') return ((int) ch) + (10 - (int) 'A'); if (ch >= 'a' && ch <= 'f') return ((int) ch) + (10 - (int) 'a'); } } return -1; } /*****************************************************************************/ const char *nm_utils_dbus_path_get_last_component (const char *dbus_path); int nm_utils_dbus_path_cmp (const char *dbus_path_a, const char *dbus_path_b); /*****************************************************************************/ typedef enum { NM_UTILS_STRSPLIT_SET_FLAGS_NONE = 0, NM_UTILS_STRSPLIT_SET_FLAGS_PRESERVE_EMPTY = (1u << 0), NM_UTILS_STRSPLIT_SET_FLAGS_ALLOW_ESCAPING = (1u << 1), /* If flag is set, does the same as g_strstrip() on the returned tokens. * This will remove leading and trailing ascii whitespaces (g_ascii_isspace() * and NM_ASCII_SPACES). * * - when combined with !%NM_UTILS_STRSPLIT_SET_FLAGS_PRESERVE_EMPTY, * empty tokens will be removed (and %NULL will be returned if that * results in an empty string array). * - when combined with %NM_UTILS_STRSPLIT_SET_FLAGS_ALLOW_ESCAPING, * trailing whitespace escaped by backslash are not stripped. */ NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP = (1u << 2), /* This implies %NM_UTILS_STRSPLIT_SET_FLAGS_ALLOW_ESCAPING. * * This will do a final run over all tokens and remove all backslash * escape characters that * - precede a delimiter. * - precede a backslash. * - preceed a whitespace (with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP). * * Note that with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP, it is only * necessary to escape the very last whitespace (if the delimiters * are not whitespace themself). So, technically, it would be sufficient * to only unescape a backslash before the last whitespace and the user * still could express everything. However, such a rule would be complicated * to understand, so when using backslash escaping with nm_utils_strsplit_set_full(), * then all characters (including backslash) are treated verbatim, except: * * - "\\$DELIMITER" (escaped delimiter) * - "\\\\" (escaped backslash) * - "\\$SPACE" (escaped space) (with %NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP). * * Note that all other escapes like "\\n" or "\\001" are left alone. * That makes the escaping/unescaping rules simple. Also, for the most part * a text is just taken as-is, with little additional rules. Only backslashes * need extra care, and then only if they proceed one of the relevant characters. */ NM_UTILS_STRSPLIT_SET_FLAGS_ESCAPED = (1u << 3), } NMUtilsStrsplitSetFlags; const char **nm_utils_strsplit_set_full (const char *str, const char *delimiter, NMUtilsStrsplitSetFlags flags); static inline const char ** nm_utils_strsplit_set_with_empty (const char *str, const char *delimiters) { /* this returns the same result as g_strsplit_set(str, delimiters, -1), except * it does not deep-clone the strv array. * Also, for @str == "", this returns %NULL while g_strsplit_set() would return * an empty strv array. */ return nm_utils_strsplit_set_full (str, delimiters, NM_UTILS_STRSPLIT_SET_FLAGS_PRESERVE_EMPTY); } static inline const char ** nm_utils_strsplit_set (const char *str, const char *delimiters) { return nm_utils_strsplit_set_full (str, delimiters, NM_UTILS_STRSPLIT_SET_FLAGS_NONE); } gssize nm_utils_strv_find_first (char **list, gssize len, const char *needle); char **_nm_utils_strv_cleanup (char **strv, gboolean strip_whitespace, gboolean skip_empty, gboolean skip_repeated); /*****************************************************************************/ static inline const char ** nm_utils_escaped_tokens_split (const char *str, const char *delimiters) { return nm_utils_strsplit_set_full (str, delimiters, NM_UTILS_STRSPLIT_SET_FLAGS_ESCAPED | NM_UTILS_STRSPLIT_SET_FLAGS_STRSTRIP); } const char *nm_utils_escaped_tokens_escape (const char *str, const char *delimiters, char **out_to_free); static inline GString * nm_utils_escaped_tokens_escape_gstr_assert (const char *str, const char *delimiters, GString *gstring) { #if NM_MORE_ASSERTS > 0 /* Just appends @str to @gstring, but also assert that * no escaping is necessary. * * Use nm_utils_escaped_tokens_escape_gstr_assert() instead * of nm_utils_escaped_tokens_escape_gstr(), if you *know* that * @str contains no delimiters, no backslashes, and no trailing * whitespace that requires escaping. */ nm_assert (str); nm_assert (gstring); nm_assert (delimiters); { gs_free char *str_to_free = NULL; const char *str0; str0 = nm_utils_escaped_tokens_escape (str, delimiters, &str_to_free); nm_assert (str0 == str); nm_assert (!str_to_free); } #endif g_string_append (gstring, str); return gstring; } static inline GString * nm_utils_escaped_tokens_escape_gstr (const char *str, const char *delimiters, GString *gstring) { gs_free char *str_to_free = NULL; nm_assert (str); nm_assert (gstring); g_string_append (gstring, nm_utils_escaped_tokens_escape (str, delimiters, &str_to_free)); return gstring; } /*****************************************************************************/ #define NM_UTILS_CHECKSUM_LENGTH_MD5 16 #define NM_UTILS_CHECKSUM_LENGTH_SHA1 20 #define NM_UTILS_CHECKSUM_LENGTH_SHA256 32 #define nm_utils_checksum_get_digest(sum, arr) \ G_STMT_START { \ GChecksum *const _sum = (sum); \ gsize _len; \ \ G_STATIC_ASSERT_EXPR ( sizeof (arr) == NM_UTILS_CHECKSUM_LENGTH_MD5 \ || sizeof (arr) == NM_UTILS_CHECKSUM_LENGTH_SHA1 \ || sizeof (arr) == NM_UTILS_CHECKSUM_LENGTH_SHA256); \ G_STATIC_ASSERT_EXPR (sizeof (arr) == G_N_ELEMENTS (arr)); \ \ nm_assert (_sum); \ \ _len = G_N_ELEMENTS (arr); \ \ g_checksum_get_digest (_sum, (arr), &_len); \ nm_assert (_len == G_N_ELEMENTS (arr)); \ } G_STMT_END #define nm_utils_checksum_get_digest_len(sum, buf, len) \ G_STMT_START { \ GChecksum *const _sum = (sum); \ const gsize _len0 = (len); \ gsize _len; \ \ nm_assert (NM_IN_SET (_len0, NM_UTILS_CHECKSUM_LENGTH_MD5, \ NM_UTILS_CHECKSUM_LENGTH_SHA1, \ NM_UTILS_CHECKSUM_LENGTH_SHA256)); \ nm_assert (_sum); \ \ _len = _len0; \ g_checksum_get_digest (_sum, (buf), &_len); \ nm_assert (_len == _len0); \ } G_STMT_END /*****************************************************************************/ guint32 _nm_utils_ip4_prefix_to_netmask (guint32 prefix); guint32 _nm_utils_ip4_get_default_prefix (guint32 ip); gboolean nm_utils_ip_is_site_local (int addr_family, const void *address); /*****************************************************************************/ gboolean nm_utils_parse_inaddr_bin (int addr_family, const char *text, int *out_addr_family, gpointer out_addr); gboolean nm_utils_parse_inaddr (int addr_family, const char *text, char **out_addr); gboolean nm_utils_parse_inaddr_prefix_bin (int addr_family, const char *text, int *out_addr_family, gpointer out_addr, int *out_prefix); gboolean nm_utils_parse_inaddr_prefix (int addr_family, const char *text, char **out_addr, int *out_prefix); gint64 _nm_utils_ascii_str_to_int64 (const char *str, guint base, gint64 min, gint64 max, gint64 fallback); guint64 _nm_utils_ascii_str_to_uint64 (const char *str, guint base, guint64 min, guint64 max, guint64 fallback); int _nm_utils_ascii_str_to_bool (const char *str, int default_value); /*****************************************************************************/ extern char _nm_utils_to_string_buffer[2096]; void nm_utils_to_string_buffer_init (char **buf, gsize *len); gboolean nm_utils_to_string_buffer_init_null (gconstpointer obj, char **buf, gsize *len); /*****************************************************************************/ typedef struct { unsigned flag; const char *name; } NMUtilsFlags2StrDesc; #define NM_UTILS_FLAGS2STR(f, n) { .flag = f, .name = ""n, } #define _NM_UTILS_FLAGS2STR_DEFINE(scope, fcn_name, flags_type, ...) \ scope const char * \ fcn_name (flags_type flags, char *buf, gsize len) \ { \ static const NMUtilsFlags2StrDesc descs[] = { \ __VA_ARGS__ \ }; \ G_STATIC_ASSERT (sizeof (flags_type) <= sizeof (unsigned)); \ return nm_utils_flags2str (descs, G_N_ELEMENTS (descs), flags, buf, len); \ }; #define NM_UTILS_FLAGS2STR_DEFINE(fcn_name, flags_type, ...) \ _NM_UTILS_FLAGS2STR_DEFINE (, fcn_name, flags_type, __VA_ARGS__) #define NM_UTILS_FLAGS2STR_DEFINE_STATIC(fcn_name, flags_type, ...) \ _NM_UTILS_FLAGS2STR_DEFINE (static, fcn_name, flags_type, __VA_ARGS__) const char *nm_utils_flags2str (const NMUtilsFlags2StrDesc *descs, gsize n_descs, unsigned flags, char *buf, gsize len); /*****************************************************************************/ #define NM_UTILS_ENUM2STR(v, n) (void) 0; case v: s = ""n""; break; (void) 0 #define NM_UTILS_ENUM2STR_IGNORE(v) (void) 0; case v: break; (void) 0 #define _NM_UTILS_ENUM2STR_DEFINE(scope, fcn_name, lookup_type, int_fmt, ...) \ scope const char * \ fcn_name (lookup_type val, char *buf, gsize len) \ { \ nm_utils_to_string_buffer_init (&buf, &len); \ if (len) { \ const char *s = NULL; \ switch (val) { \ (void) 0, \ __VA_ARGS__ \ (void) 0; \ }; \ if (s) \ g_strlcpy (buf, s, len); \ else \ g_snprintf (buf, len, "(%"int_fmt")", val); \ } \ return buf; \ } #define NM_UTILS_ENUM2STR_DEFINE(fcn_name, lookup_type, ...) \ _NM_UTILS_ENUM2STR_DEFINE (, fcn_name, lookup_type, "d", __VA_ARGS__) #define NM_UTILS_ENUM2STR_DEFINE_STATIC(fcn_name, lookup_type, ...) \ _NM_UTILS_ENUM2STR_DEFINE (static, fcn_name, lookup_type, "d", __VA_ARGS__) /*****************************************************************************/ #define _nm_g_slice_free_fcn_define(mem_size) \ static inline void \ _nm_g_slice_free_fcn_##mem_size (gpointer mem_block) \ { \ g_slice_free1 (mem_size, mem_block); \ } _nm_g_slice_free_fcn_define (1) _nm_g_slice_free_fcn_define (2) _nm_g_slice_free_fcn_define (4) _nm_g_slice_free_fcn_define (8) _nm_g_slice_free_fcn_define (10) _nm_g_slice_free_fcn_define (12) _nm_g_slice_free_fcn_define (16) _nm_g_slice_free_fcn_define (32) #define _nm_g_slice_free_fcn1(mem_size) \ ({ \ void (*_fcn) (gpointer); \ \ /* If mem_size is a compile time constant, the compiler * will be able to optimize this. Hence, you don't want * to call this with a non-constant size argument. */ \ G_STATIC_ASSERT_EXPR ( ((mem_size) == 1) \ || ((mem_size) == 2) \ || ((mem_size) == 4) \ || ((mem_size) == 8) \ || ((mem_size) == 10) \ || ((mem_size) == 12) \ || ((mem_size) == 16) \ || ((mem_size) == 32)); \ switch ((mem_size)) { \ case 1: _fcn = _nm_g_slice_free_fcn_1; break; \ case 2: _fcn = _nm_g_slice_free_fcn_2; break; \ case 4: _fcn = _nm_g_slice_free_fcn_4; break; \ case 8: _fcn = _nm_g_slice_free_fcn_8; break; \ case 10: _fcn = _nm_g_slice_free_fcn_10; break; \ case 12: _fcn = _nm_g_slice_free_fcn_12; break; \ case 16: _fcn = _nm_g_slice_free_fcn_16; break; \ case 32: _fcn = _nm_g_slice_free_fcn_32; break; \ default: g_assert_not_reached (); _fcn = NULL; break; \ } \ _fcn; \ }) /** * nm_g_slice_free_fcn: * @type: type argument for sizeof() operator that you would * pass to g_slice_new(). * * Returns: a function pointer with GDestroyNotify signature * for g_slice_free(type,*). * * Only certain types are implemented. You'll get an assertion * using the wrong type. */ #define nm_g_slice_free_fcn(type) (_nm_g_slice_free_fcn1 (sizeof (type))) #define nm_g_slice_free_fcn_gint64 (nm_g_slice_free_fcn (gint64)) /*****************************************************************************/ /** * NMUtilsError: * @NM_UTILS_ERROR_UNKNOWN: unknown or unclassified error * @NM_UTILS_ERROR_CANCELLED_DISPOSING: when disposing an object that has * pending aynchronous operations, the operation is cancelled with this * error reason. Depending on the usage, this might indicate a bug because * usually the target object should stay alive as long as there are pending * operations. * * @NM_UTILS_ERROR_CONNECTION_AVAILABLE_INCOMPATIBLE: used for a very particular * purpose during nm_device_check_connection_compatible() to indicate that * the profile does not match the device already because their type differs. * That is, there is a fundamental reason of trying to check a profile that * cannot possibly match on this device. * @NM_UTILS_ERROR_CONNECTION_AVAILABLE_UNMANAGED_DEVICE: used for a very particular * purpose during nm_device_check_connection_available(), to indicate that the * device is not available because it is unmanaged. * @NM_UTILS_ERROR_CONNECTION_AVAILABLE_TEMPORARY: the profile is currently not * available/compatible with the device, but this may be only temporary. * * @NM_UTILS_ERROR_SETTING_MISSING: the setting is missing * * @NM_UTILS_ERROR_INVALID_ARGUMENT: invalid argument. */ typedef enum { NM_UTILS_ERROR_UNKNOWN = 0, /*< nick=Unknown >*/ NM_UTILS_ERROR_CANCELLED_DISPOSING, /*< nick=CancelledDisposing >*/ NM_UTILS_ERROR_INVALID_ARGUMENT, /*< nick=InvalidArgument >*/ /* the following codes have a special meaning and are exactly used for * nm_device_check_connection_compatible() and nm_device_check_connection_available(). * * Actually, their meaning is not very important (so, don't think too * hard about the name of these error codes). What is important, is their * relative order (i.e. the integer value of the codes). When manager * searches for a suitable device, it will check all devices whether * a profile can be activated. If they all fail, it will pick the error * message from the device that returned the *highest* error code, * in the hope that this message makes the most sense for the caller. * */ NM_UTILS_ERROR_CONNECTION_AVAILABLE_INCOMPATIBLE, NM_UTILS_ERROR_CONNECTION_AVAILABLE_UNMANAGED_DEVICE, NM_UTILS_ERROR_CONNECTION_AVAILABLE_TEMPORARY, NM_UTILS_ERROR_SETTING_MISSING, } NMUtilsError; #define NM_UTILS_ERROR (nm_utils_error_quark ()) GQuark nm_utils_error_quark (void); void nm_utils_error_set_cancelled (GError **error, gboolean is_disposing, const char *instance_name); gboolean nm_utils_error_is_cancelled (GError *error, gboolean consider_is_disposing); gboolean nm_utils_error_is_notfound (GError *error); static inline void nm_utils_error_set_literal (GError **error, int error_code, const char *literal) { g_set_error_literal (error, NM_UTILS_ERROR, error_code, literal); } #define nm_utils_error_set(error, error_code, ...) \ G_STMT_START { \ if (NM_NARG (__VA_ARGS__) == 1) { \ g_set_error_literal ((error), NM_UTILS_ERROR, (error_code), _NM_UTILS_MACRO_FIRST (__VA_ARGS__)); \ } else { \ g_set_error ((error), NM_UTILS_ERROR, (error_code), __VA_ARGS__); \ } \ } G_STMT_END #define nm_utils_error_set_errno(error, errsv, fmt, ...) \ G_STMT_START { \ char _bstrerr[NM_STRERROR_BUFSIZE]; \ \ g_set_error ((error), \ NM_UTILS_ERROR, \ NM_UTILS_ERROR_UNKNOWN, \ fmt, \ ##__VA_ARGS__, \ nm_strerror_native_r (({ \ const int _errsv = (errsv); \ \ ( _errsv >= 0 \ ? _errsv \ : ( G_UNLIKELY (_errsv == G_MININT) \ ? G_MAXINT \ : -errsv)); \ }), \ _bstrerr, \ sizeof (_bstrerr))); \ } G_STMT_END /*****************************************************************************/ gboolean nm_g_object_set_property (GObject *object, const char *property_name, const GValue *value, GError **error); gboolean nm_g_object_set_property_string (GObject *object, const char *property_name, const char *value, GError **error); gboolean nm_g_object_set_property_string_static (GObject *object, const char *property_name, const char *value, GError **error); gboolean nm_g_object_set_property_string_take (GObject *object, const char *property_name, char *value, GError **error); gboolean nm_g_object_set_property_boolean (GObject *object, const char *property_name, gboolean value, GError **error); gboolean nm_g_object_set_property_char (GObject *object, const char *property_name, gint8 value, GError **error); gboolean nm_g_object_set_property_uchar (GObject *object, const char *property_name, guint8 value, GError **error); gboolean nm_g_object_set_property_int (GObject *object, const char *property_name, int value, GError **error); gboolean nm_g_object_set_property_int64 (GObject *object, const char *property_name, gint64 value, GError **error); gboolean nm_g_object_set_property_uint (GObject *object, const char *property_name, guint value, GError **error); gboolean nm_g_object_set_property_uint64 (GObject *object, const char *property_name, guint64 value, GError **error); gboolean nm_g_object_set_property_flags (GObject *object, const char *property_name, GType gtype, guint value, GError **error); gboolean nm_g_object_set_property_enum (GObject *object, const char *property_name, GType gtype, int value, GError **error); GParamSpec *nm_g_object_class_find_property_from_gtype (GType gtype, const char *property_name); /*****************************************************************************/ GType nm_g_type_find_implementing_class_for_property (GType gtype, const char *pname); /*****************************************************************************/ typedef enum { NM_UTILS_STR_UTF8_SAFE_FLAG_NONE = 0, NM_UTILS_STR_UTF8_SAFE_FLAG_ESCAPE_CTRL = 0x0001, NM_UTILS_STR_UTF8_SAFE_FLAG_ESCAPE_NON_ASCII = 0x0002, } NMUtilsStrUtf8SafeFlags; const char *nm_utils_buf_utf8safe_escape (gconstpointer buf, gssize buflen, NMUtilsStrUtf8SafeFlags flags, char **to_free); const char *nm_utils_buf_utf8safe_escape_bytes (GBytes *bytes, NMUtilsStrUtf8SafeFlags flags, char **to_free); gconstpointer nm_utils_buf_utf8safe_unescape (const char *str, gsize *out_len, gpointer *to_free); const char *nm_utils_str_utf8safe_escape (const char *str, NMUtilsStrUtf8SafeFlags flags, char **to_free); const char *nm_utils_str_utf8safe_unescape (const char *str, char **to_free); char *nm_utils_str_utf8safe_escape_cp (const char *str, NMUtilsStrUtf8SafeFlags flags); char *nm_utils_str_utf8safe_unescape_cp (const char *str); char *nm_utils_str_utf8safe_escape_take (char *str, NMUtilsStrUtf8SafeFlags flags); static inline void nm_g_variant_unref_floating (GVariant *var) { /* often a function wants to keep a reference to an input variant. * It uses g_variant_ref_sink() to either increase the ref-count, * or take ownership of a possibly floating reference. * * If the function doesn't actually want to do anything with the * input variant, it still must make sure that a passed in floating * reference is consumed. Hence, this helper which: * * - does nothing if @var is not floating * - unrefs (consumes) @var if it is floating. */ if (g_variant_is_floating (var)) g_variant_unref (var); } /*****************************************************************************/ static inline int nm_utf8_collate0 (const char *a, const char *b) { if (!a) return !b ? 0 : -1; if (!b) return 1; return g_utf8_collate (a, b); } int nm_strcmp_with_data (gconstpointer a, gconstpointer b, gpointer user_data); int nm_strcmp_p_with_data (gconstpointer a, gconstpointer b, gpointer user_data); int nm_strcmp0_p_with_data (gconstpointer a, gconstpointer b, gpointer user_data); int nm_cmp_uint32_p_with_data (gconstpointer p_a, gconstpointer p_b, gpointer user_data); int nm_cmp_int2ptr_p_with_data (gconstpointer p_a, gconstpointer p_b, gpointer user_data); /*****************************************************************************/ typedef struct { const char *name; } NMUtilsNamedEntry; typedef struct { union { NMUtilsNamedEntry named_entry; const char *name; }; union { const char *value_str; gconstpointer value_ptr; }; } NMUtilsNamedValue; NMUtilsNamedValue *nm_utils_named_values_from_str_dict (GHashTable *hash, guint *out_len); gssize nm_utils_named_value_list_find (const NMUtilsNamedValue *arr, gsize len, const char *name, gboolean sorted); gboolean nm_utils_named_value_list_is_sorted (const NMUtilsNamedValue *arr, gsize len, gboolean accept_duplicates, GCompareDataFunc compare_func, gpointer user_data); void nm_utils_named_value_list_sort (NMUtilsNamedValue *arr, gsize len, GCompareDataFunc compare_func, gpointer user_data); /*****************************************************************************/ gpointer *nm_utils_hash_keys_to_array (GHashTable *hash, GCompareDataFunc compare_func, gpointer user_data, guint *out_len); gpointer *nm_utils_hash_values_to_array (GHashTable *hash, GCompareDataFunc compare_func, gpointer user_data, guint *out_len); static inline const char ** nm_utils_strdict_get_keys (const GHashTable *hash, gboolean sorted, guint *out_length) { return (const char **) nm_utils_hash_keys_to_array ((GHashTable *) hash, sorted ? nm_strcmp_p_with_data : NULL, NULL, out_length); } gboolean nm_utils_hashtable_same_keys (const GHashTable *a, const GHashTable *b); char **nm_utils_strv_make_deep_copied (const char **strv); char **nm_utils_strv_make_deep_copied_n (const char **strv, gsize len); static inline char ** nm_utils_strv_make_deep_copied_nonnull (const char **strv) { return nm_utils_strv_make_deep_copied (strv) ?: g_new0 (char *, 1); } char **nm_utils_strv_dup (gpointer strv, gssize len); /*****************************************************************************/ GSList *nm_utils_g_slist_find_str (const GSList *list, const char *needle); int nm_utils_g_slist_strlist_cmp (const GSList *a, const GSList *b); /*****************************************************************************/ gssize nm_utils_ptrarray_find_binary_search (gconstpointer *list, gsize len, gconstpointer needle, GCompareDataFunc cmpfcn, gpointer user_data, gssize *out_idx_first, gssize *out_idx_last); gssize nm_utils_array_find_binary_search (gconstpointer list, gsize elem_size, gsize len, gconstpointer needle, GCompareDataFunc cmpfcn, gpointer user_data); /*****************************************************************************/ typedef gboolean (*NMUtilsHashTableEqualFunc) (gconstpointer a, gconstpointer b); gboolean nm_utils_hash_table_equal (const GHashTable *a, const GHashTable *b, gboolean treat_null_as_empty, NMUtilsHashTableEqualFunc equal_func); /*****************************************************************************/ void _nm_utils_strv_sort (const char **strv, gssize len); #define nm_utils_strv_sort(strv, len) _nm_utils_strv_sort (NM_CAST_STRV_MC (strv), len) int _nm_utils_strv_cmp_n (const char *const*strv1, gssize len1, const char *const*strv2, gssize len2); static inline gboolean _nm_utils_strv_equal (char **strv1, char **strv2) { return _nm_utils_strv_cmp_n ((const char *const*) strv1, -1, (const char *const*) strv2, -1) == 0; } /*****************************************************************************/ #define NM_UTILS_NS_PER_SECOND ((gint64) 1000000000) #define NM_UTILS_NS_PER_MSEC ((gint64) 1000000) #define NM_UTILS_MSEC_PER_SECOND ((gint64) 1000) #define NM_UTILS_NS_TO_MSEC_CEIL(nsec) (((nsec) + (NM_UTILS_NS_PER_MSEC - 1)) / NM_UTILS_NS_PER_MSEC) /*****************************************************************************/ int nm_utils_fd_wait_for_event (int fd, int event, gint64 timeout_ns); ssize_t nm_utils_fd_read_loop (int fd, void *buf, size_t nbytes, bool do_poll); int nm_utils_fd_read_loop_exact (int fd, void *buf, size_t nbytes, bool do_poll); /*****************************************************************************/ static inline const char * nm_utils_dbus_normalize_object_path (const char *path) { /* D-Bus does not allow an empty object path. Hence, whenever we mean NULL / no-object * on D-Bus, it's path is actually "/". * * Normalize that away, and return %NULL in that case. */ if (path && path[0] == '/' && path[1] == '\0') return NULL; return path; } #define NM_DEFINE_GDBUS_ARG_INFO_FULL(name_, ...) \ ((GDBusArgInfo *) (&((const GDBusArgInfo) { \ .ref_count = -1, \ .name = name_, \ __VA_ARGS__ \ }))) #define NM_DEFINE_GDBUS_ARG_INFO(name_, a_signature) \ NM_DEFINE_GDBUS_ARG_INFO_FULL ( \ name_, \ .signature = a_signature, \ ) #define NM_DEFINE_GDBUS_ARG_INFOS(...) \ ((GDBusArgInfo **) ((const GDBusArgInfo *[]) { \ __VA_ARGS__ \ NULL, \ })) #define NM_DEFINE_GDBUS_PROPERTY_INFO(name_, ...) \ ((GDBusPropertyInfo *) (&((const GDBusPropertyInfo) { \ .ref_count = -1, \ .name = name_, \ __VA_ARGS__ \ }))) #define NM_DEFINE_GDBUS_PROPERTY_INFO_READABLE(name_, m_signature) \ NM_DEFINE_GDBUS_PROPERTY_INFO ( \ name_, \ .signature = m_signature, \ .flags = G_DBUS_PROPERTY_INFO_FLAGS_READABLE, \ ) #define NM_DEFINE_GDBUS_PROPERTY_INFOS(...) \ ((GDBusPropertyInfo **) ((const GDBusPropertyInfo *[]) { \ __VA_ARGS__ \ NULL, \ })) #define NM_DEFINE_GDBUS_SIGNAL_INFO_INIT(name_, ...) \ { \ .ref_count = -1, \ .name = name_, \ __VA_ARGS__ \ } #define NM_DEFINE_GDBUS_SIGNAL_INFO(name_, ...) \ ((GDBusSignalInfo *) (&((const GDBusSignalInfo) NM_DEFINE_GDBUS_SIGNAL_INFO_INIT (name_, __VA_ARGS__)))) #define NM_DEFINE_GDBUS_SIGNAL_INFOS(...) \ ((GDBusSignalInfo **) ((const GDBusSignalInfo *[]) { \ __VA_ARGS__ \ NULL, \ })) #define NM_DEFINE_GDBUS_METHOD_INFO_INIT(name_, ...) \ { \ .ref_count = -1, \ .name = name_, \ __VA_ARGS__ \ } #define NM_DEFINE_GDBUS_METHOD_INFO(name_, ...) \ ((GDBusMethodInfo *) (&((const GDBusMethodInfo) NM_DEFINE_GDBUS_METHOD_INFO_INIT (name_, __VA_ARGS__)))) #define NM_DEFINE_GDBUS_METHOD_INFOS(...) \ ((GDBusMethodInfo **) ((const GDBusMethodInfo *[]) { \ __VA_ARGS__ \ NULL, \ })) #define NM_DEFINE_GDBUS_INTERFACE_INFO_INIT(name_, ...) \ { \ .ref_count = -1, \ .name = name_, \ __VA_ARGS__ \ } #define NM_DEFINE_GDBUS_INTERFACE_INFO(name_, ...) \ ((GDBusInterfaceInfo *) (&((const GDBusInterfaceInfo) NM_DEFINE_GDBUS_INTERFACE_INFO_INIT (name_, __VA_ARGS__)))) #define NM_DEFINE_GDBUS_INTERFACE_VTABLE(...) \ ((GDBusInterfaceVTable *) (&((const GDBusInterfaceVTable) { \ __VA_ARGS__ \ }))) /*****************************************************************************/ guint64 nm_utils_get_start_time_for_pid (pid_t pid, char *out_state, pid_t *out_ppid); /*****************************************************************************/ gpointer _nm_utils_user_data_pack (int nargs, gconstpointer *args); #define nm_utils_user_data_pack(...) \ _nm_utils_user_data_pack(NM_NARG (__VA_ARGS__), (gconstpointer[]) { __VA_ARGS__ }) void _nm_utils_user_data_unpack (gpointer user_data, int nargs, ...); #define nm_utils_user_data_unpack(user_data, ...) \ _nm_utils_user_data_unpack(user_data, NM_NARG (__VA_ARGS__), __VA_ARGS__) /*****************************************************************************/ typedef void (*NMUtilsInvokeOnIdleCallback) (gpointer callback_user_data, GCancellable *cancellable); void nm_utils_invoke_on_idle (NMUtilsInvokeOnIdleCallback callback, gpointer callback_user_data, GCancellable *cancellable); /*****************************************************************************/ static inline void nm_strv_ptrarray_add_string_take (GPtrArray *cmd, char *str) { nm_assert (cmd); nm_assert (str); g_ptr_array_add (cmd, str); } static inline void nm_strv_ptrarray_add_string_dup (GPtrArray *cmd, const char *str) { nm_strv_ptrarray_add_string_take (cmd, g_strdup (str)); } #define nm_strv_ptrarray_add_string_concat(cmd, ...) \ nm_strv_ptrarray_add_string_take ((cmd), g_strconcat (__VA_ARGS__, NULL)) #define nm_strv_ptrarray_add_string_printf(cmd, ...) \ nm_strv_ptrarray_add_string_take ((cmd), g_strdup_printf (__VA_ARGS__)) #define nm_strv_ptrarray_add_int(cmd, val) \ nm_strv_ptrarray_add_string_take ((cmd), nm_strdup_int (val)) static inline void nm_strv_ptrarray_take_gstring (GPtrArray *cmd, GString **gstr) { nm_assert (gstr && *gstr); nm_strv_ptrarray_add_string_take (cmd, g_string_free (g_steal_pointer (gstr), FALSE)); } /*****************************************************************************/ int nm_utils_getpagesize (void); /*****************************************************************************/ char *nm_utils_bin2hexstr_full (gconstpointer addr, gsize length, char delimiter, gboolean upper_case, char *out); guint8 *nm_utils_hexstr2bin_full (const char *hexstr, gboolean allow_0x_prefix, gboolean delimiter_required, const char *delimiter_candidates, gsize required_len, guint8 *buffer, gsize buffer_len, gsize *out_len); #define nm_utils_hexstr2bin_buf(hexstr, allow_0x_prefix, delimiter_required, delimiter_candidates, buffer) \ nm_utils_hexstr2bin_full ((hexstr), (allow_0x_prefix), (delimiter_required), (delimiter_candidates), G_N_ELEMENTS (buffer), (buffer), G_N_ELEMENTS (buffer), NULL) guint8 *nm_utils_hexstr2bin_alloc (const char *hexstr, gboolean allow_0x_prefix, gboolean delimiter_required, const char *delimiter_candidates, gsize required_len, gsize *out_len); #endif /* __NM_SHARED_UTILS_H__ */