|
Packit Service |
5ffa24 |
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
Packit Service |
5ffa24 |
/*
|
|
Packit Service |
5ffa24 |
* Copyright (C) 2008 - 2017 Red Hat, Inc.
|
|
Packit Service |
5ffa24 |
*/
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#ifndef _UTILS_H_
|
|
Packit Service |
5ffa24 |
#define _UTILS_H_
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#include "nm-connection.h"
|
|
Packit Service |
5ffa24 |
#include "nm-base/nm-ethtool-base.h"
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#include "shvar.h"
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
/*****************************************************************************/
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
typedef enum {
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_UNKNOWN = 0,
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_WELL_KNOWN = (1u << 0),
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_IS_PLAIN = (1u << 1),
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_IS_NUMBERED = (1u << 2),
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_IS_PREFIX = (1u << 3),
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
/* by default, well knowns keys that are not explicitly set
|
|
Packit Service |
5ffa24 |
* by the writer (the unvisited, dirty ones) are removed.
|
|
Packit Service |
5ffa24 |
* With this flag, such keys are kept if they are present. */
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_KEEP_WHEN_DIRTY = (1u << 4),
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
} NMSIfcfgKeyTypeFlags;
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
typedef struct {
|
|
Packit Service |
5ffa24 |
const char * key_name;
|
|
Packit Service |
5ffa24 |
NMSIfcfgKeyTypeFlags key_flags;
|
|
Packit Service |
5ffa24 |
} NMSIfcfgKeyTypeInfo;
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
extern const NMSIfcfgKeyTypeInfo nms_ifcfg_well_known_keys[247];
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
const NMSIfcfgKeyTypeInfo *nms_ifcfg_well_known_key_find_info(const char *key, gssize *out_idx);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
static inline NMSIfcfgKeyTypeFlags
|
|
Packit Service |
5ffa24 |
nms_ifcfg_well_known_key_find_info_flags(const char *key)
|
|
Packit Service |
5ffa24 |
{
|
|
Packit Service |
5ffa24 |
const NMSIfcfgKeyTypeInfo *ti;
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
ti = nms_ifcfg_well_known_key_find_info(key, NULL);
|
|
Packit Service |
5ffa24 |
if (!ti)
|
|
Packit Service |
5ffa24 |
return NMS_IFCFG_KEY_TYPE_UNKNOWN;
|
|
Packit Service |
5ffa24 |
return ti->key_flags;
|
|
Packit Service |
5ffa24 |
}
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
/*****************************************************************************/
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
gboolean nms_ifcfg_rh_utils_parse_unhandled_spec(const char * unhandled_spec,
|
|
Packit Service |
5ffa24 |
const char **out_unmanaged_spec,
|
|
Packit Service |
5ffa24 |
const char **out_unrecognized_spec);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#define NM_IFCFG_CONNECTION_LOG_PATH(path) ((path) ?: "in-memory")
|
|
Packit Service |
5ffa24 |
#define NM_IFCFG_CONNECTION_LOG_FMT "%s (%s,\"%s\")"
|
|
Packit Service |
5ffa24 |
#define NM_IFCFG_CONNECTION_LOG_ARG(con) \
|
|
Packit Service |
5ffa24 |
NM_IFCFG_CONNECTION_LOG_PATH( \
|
|
Packit Service |
5ffa24 |
nm_settings_connection_get_filename((NMSettingsConnection *) (con))), \
|
|
Packit Service |
5ffa24 |
nm_settings_connection_get_uuid((NMSettingsConnection *) (con)), \
|
|
Packit Service |
5ffa24 |
nm_settings_connection_get_id((NMSettingsConnection *) (con))
|
|
Packit Service |
5ffa24 |
#define NM_IFCFG_CONNECTION_LOG_FMTD "%s (%s,\"%s\",%p)"
|
|
Packit Service |
5ffa24 |
#define NM_IFCFG_CONNECTION_LOG_ARGD(con) \
|
|
Packit Service |
5ffa24 |
NM_IFCFG_CONNECTION_LOG_PATH( \
|
|
Packit Service |
5ffa24 |
nm_settings_connection_get_filename((NMSettingsConnection *) (con))), \
|
|
Packit Service |
5ffa24 |
nm_settings_connection_get_uuid((NMSettingsConnection *) (con)), \
|
|
Packit Service |
5ffa24 |
nm_settings_connection_get_id((NMSettingsConnection *) (con)), (con)
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
char *utils_cert_path(const char *parent, const char *suffix, const char *extension);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
const char *utils_get_ifcfg_name(const char *file, gboolean only_ifcfg);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
gboolean utils_should_ignore_file(const char *filename, gboolean only_ifcfg);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
char *utils_get_ifcfg_path(const char *parent);
|
|
Packit Service |
5ffa24 |
char *utils_get_keys_path(const char *parent);
|
|
Packit Service |
5ffa24 |
char *utils_get_route_path(const char *parent);
|
|
Packit Service |
5ffa24 |
char *utils_get_route6_path(const char *parent);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
shvarFile *utils_get_extra_ifcfg(const char *parent, const char *tag, gboolean should_create);
|
|
Packit Service |
5ffa24 |
shvarFile *utils_get_keys_ifcfg(const char *parent, gboolean should_create);
|
|
Packit Service |
5ffa24 |
shvarFile *utils_get_route_ifcfg(const char *parent, gboolean should_create);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
gboolean utils_has_route_file_new_syntax(const char *filename);
|
|
Packit Service |
5ffa24 |
gboolean utils_has_route_file_new_syntax_content(const char *contents, gsize len);
|
|
Packit Service |
5ffa24 |
gboolean utils_has_complex_routes(const char *filename, int addr_family);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
gboolean utils_is_ifcfg_alias_file(const char *alias, const char *ifcfg);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
char *utils_detect_ifcfg_path(const char *path, gboolean only_ifcfg);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
void nms_ifcfg_rh_utils_user_key_encode(const char *key, GString *str_buffer);
|
|
Packit Service |
5ffa24 |
gboolean nms_ifcfg_rh_utils_user_key_decode(const char *name, GString *str_buffer);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
static inline const char *
|
|
Packit Service |
5ffa24 |
_nms_ifcfg_rh_utils_numbered_tag(char *buf, gsize buf_len, const char *tag_name, int which)
|
|
Packit Service |
5ffa24 |
{
|
|
Packit Service |
5ffa24 |
gsize l;
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#if NM_MORE_ASSERTS > 5
|
|
Packit Service |
5ffa24 |
nm_assert(NM_FLAGS_ALL(nms_ifcfg_well_known_key_find_info_flags(tag_name),
|
|
Packit Service |
5ffa24 |
NMS_IFCFG_KEY_TYPE_WELL_KNOWN | NMS_IFCFG_KEY_TYPE_IS_NUMBERED));
|
|
Packit Service |
5ffa24 |
#endif
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
l = g_strlcpy(buf, tag_name, buf_len);
|
|
Packit Service |
5ffa24 |
nm_assert(l < buf_len);
|
|
Packit Service |
5ffa24 |
if (which != -1) {
|
|
Packit Service |
5ffa24 |
buf_len -= l;
|
|
Packit Service |
5ffa24 |
l = g_snprintf(&buf[l], buf_len, "%d", which);
|
|
Packit Service |
5ffa24 |
nm_assert(l < buf_len);
|
|
Packit Service |
5ffa24 |
}
|
|
Packit Service |
5ffa24 |
return buf;
|
|
Packit Service |
5ffa24 |
}
|
|
Packit Service |
5ffa24 |
#define numbered_tag(buf, tag_name, which) \
|
|
Packit Service |
5ffa24 |
({ \
|
|
Packit Service |
5ffa24 |
_nm_unused char *const _buf = (buf); \
|
|
Packit Service |
5ffa24 |
\
|
|
Packit Service |
5ffa24 |
/* some static assert trying to ensure that the buffer is statically allocated.
|
|
Packit Service |
5ffa24 |
* It disallows a buffer size of sizeof(gpointer) to catch that. */ \
|
|
Packit Service |
5ffa24 |
G_STATIC_ASSERT(G_N_ELEMENTS(buf) == sizeof(buf) && sizeof(buf) != sizeof(char *) \
|
|
Packit Service |
5ffa24 |
&& sizeof(buf) < G_MAXINT); \
|
|
Packit Service |
5ffa24 |
_nms_ifcfg_rh_utils_numbered_tag(buf, sizeof(buf), "" tag_name "", (which)); \
|
|
Packit Service |
5ffa24 |
})
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
gboolean nms_ifcfg_rh_utils_is_numbered_tag_impl(const char *key,
|
|
Packit Service |
5ffa24 |
const char *tag,
|
|
Packit Service |
5ffa24 |
gsize tag_len,
|
|
Packit Service |
5ffa24 |
gint64 * out_idx);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
static inline gboolean
|
|
Packit Service |
5ffa24 |
nms_ifcfg_rh_utils_is_numbered_tag(const char *key, const char *tag, gint64 *out_idx)
|
|
Packit Service |
5ffa24 |
{
|
|
Packit Service |
5ffa24 |
nm_assert(tag);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
return nms_ifcfg_rh_utils_is_numbered_tag_impl(key, tag, strlen(tag), out_idx);
|
|
Packit Service |
5ffa24 |
}
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#define NMS_IFCFG_RH_UTIL_IS_NUMBERED_TAG(key, tag, out_idx) \
|
|
Packit Service |
5ffa24 |
nms_ifcfg_rh_utils_is_numbered_tag_impl(key, tag, NM_STRLEN(tag), out_idx)
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
/*****************************************************************************/
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
const NMSIfcfgKeyTypeInfo *nms_ifcfg_rh_utils_is_well_known_key(const char *key);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
/*****************************************************************************/
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
extern const char *const _nm_ethtool_ifcfg_names[_NM_ETHTOOL_ID_NUM];
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
static inline const char *
|
|
Packit Service |
5ffa24 |
nms_ifcfg_rh_utils_get_ethtool_name(NMEthtoolID ethtool_id)
|
|
Packit Service |
5ffa24 |
{
|
|
Packit Service |
5ffa24 |
nm_assert(ethtool_id >= _NM_ETHTOOL_ID_FIRST && ethtool_id <= _NM_ETHTOOL_ID_LAST);
|
|
Packit Service |
5ffa24 |
nm_assert(ethtool_id < G_N_ELEMENTS(_nm_ethtool_ifcfg_names));
|
|
Packit Service |
5ffa24 |
nm_assert(_nm_ethtool_ifcfg_names[ethtool_id]);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
return _nm_ethtool_ifcfg_names[ethtool_id];
|
|
Packit Service |
5ffa24 |
}
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
const NMEthtoolData *nms_ifcfg_rh_utils_get_ethtool_by_name(const char * name,
|
|
Packit Service |
5ffa24 |
NMEthtoolType ethtool_type);
|
|
Packit Service |
5ffa24 |
|
|
Packit Service |
5ffa24 |
#endif /* _UTILS_H_ */
|