1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
// SPDX-License-Identifier: LGPL-2.1+
/*
* Copyright 2011 Red Hat, Inc.
*/
#ifndef __NM_SETTING_PRIVATE_H__
#define __NM_SETTING_PRIVATE_H__
#if !((NETWORKMANAGER_COMPILATION) & NM_NETWORKMANAGER_COMPILATION_WITH_LIBNM_CORE_PRIVATE)
#error Cannot use this header.
#endif
#include "nm-setting.h"
#include "nm-setting-bridge.h"
#include "nm-connection.h"
#include "nm-core-enum-types.h"
#include "nm-core-internal.h"
/*****************************************************************************/
NMSettingPriority _nm_setting_get_base_type_priority (NMSetting *setting);
NMSettingPriority _nm_setting_type_get_base_type_priority (GType type);
int _nm_setting_compare_priority (gconstpointer a, gconstpointer b);
/*****************************************************************************/
void _nm_setting_emit_property_changed (NMSetting *setting);
typedef enum NMSettingUpdateSecretResult {
NM_SETTING_UPDATE_SECRET_ERROR = FALSE,
NM_SETTING_UPDATE_SECRET_SUCCESS_MODIFIED = TRUE,
NM_SETTING_UPDATE_SECRET_SUCCESS_UNCHANGED = 2,
} NMSettingUpdateSecretResult;
NMSettingUpdateSecretResult _nm_setting_update_secrets (NMSetting *setting,
GVariant *secrets,
GError **error);
gboolean _nm_setting_clear_secrets (NMSetting *setting,
NMSettingClearSecretsWithFlagsFn func,
gpointer user_data);
/* The property of the #NMSetting should be considered during comparisons that
* use the %NM_SETTING_COMPARE_FLAG_INFERRABLE flag. Properties that don't have
* this flag, are ignored when doing an infrerrable comparison. This flag should
* be set on all properties that are read from the kernel or the system when a
* connection is generated. eg, IP addresses/routes can be read from the
* kernel, but the 'autoconnect' property cannot, so
* %NM_SETTING_IP4_CONFIG_ADDRESSES gets the INFERRABLE flag, but
* %NM_SETTING_CONNECTION_AUTOCONNECT would not.
*
* This flag should not be used with properties where the default cannot be
* read separately from the current value, like MTU or wired duplex mode.
*/
#define NM_SETTING_PARAM_INFERRABLE (1 << (4 + G_PARAM_USER_SHIFT))
/* This is a legacy property, which clients should not send to the daemon. */
#define NM_SETTING_PARAM_LEGACY (1 << (5 + G_PARAM_USER_SHIFT))
/* When a connection is active and gets modified, usually the change
* to the settings-connection does not propagate automatically to the
* applied-connection of the device. For certain properties like the
* firewall zone and the metered property, this is different.
*
* Such fields can be ignored during nm_connection_compare() with the
* NMSettingCompareFlag NM_SETTING_COMPARE_FLAG_IGNORE_REAPPLY_IMMEDIATELY.
*/
#define NM_SETTING_PARAM_REAPPLY_IMMEDIATELY (1 << (6 + G_PARAM_USER_SHIFT))
#define NM_SETTING_PARAM_GENDATA_BACKED (1 << (7 + G_PARAM_USER_SHIFT))
extern const NMSettInfoPropertType nm_sett_info_propert_type_deprecated_interface_name;
extern const NMSettInfoPropertType nm_sett_info_propert_type_deprecated_ignore_i;
extern const NMSettInfoPropertType nm_sett_info_propert_type_deprecated_ignore_u;
extern const NMSettInfoPropertType nm_sett_info_propert_type_plain_i;
extern const NMSettInfoPropertType nm_sett_info_propert_type_plain_u;
NMSettingVerifyResult _nm_setting_verify (NMSetting *setting,
NMConnection *connection,
GError **error);
gboolean _nm_setting_verify_secret_string (const char *str,
const char *setting_name,
const char *property,
GError **error);
gboolean _nm_setting_aggregate (NMSetting *setting,
NMConnectionAggregateType type,
gpointer arg);
gboolean _nm_setting_slave_type_is_valid (const char *slave_type, const char **out_port_type);
GVariant *_nm_setting_to_dbus (NMSetting *setting,
NMConnection *connection,
NMConnectionSerializationFlags flags,
const NMConnectionSerializationOptions *options);
NMSetting *_nm_setting_new_from_dbus (GType setting_type,
GVariant *setting_dict,
GVariant *connection_dict,
NMSettingParseFlags parse_flags,
GError **error);
gboolean _nm_setting_property_is_regular_secret (NMSetting *setting,
const char *secret_name);
gboolean _nm_setting_property_is_regular_secret_flags (NMSetting *setting,
const char *secret_flags_name);
/*****************************************************************************/
static inline GArray *
_nm_sett_info_property_override_create_array (void)
{
return g_array_new (FALSE, FALSE, sizeof (NMSettInfoProperty));
}
GArray *_nm_sett_info_property_override_create_array_ip_config (void);
void _nm_setting_class_commit_full (NMSettingClass *setting_class,
NMMetaSettingType meta_type,
const NMSettInfoSettDetail *detail,
GArray *properties_override);
static inline void
_nm_setting_class_commit (NMSettingClass *setting_class,
NMMetaSettingType meta_type)
{
_nm_setting_class_commit_full (setting_class, meta_type, NULL, NULL);
}
#define NM_SETT_INFO_SETT_GENDATA(...) \
({ \
static const NMSettInfoSettGendata _g = { \
__VA_ARGS__ \
}; \
\
&_g; \
})
#define NM_SETT_INFO_SETT_DETAIL(...) \
(&((const NMSettInfoSettDetail) { \
__VA_ARGS__ \
}))
#define NM_SETT_INFO_PROPERT_TYPE(...) \
({ \
static const NMSettInfoPropertType _g = { \
__VA_ARGS__ \
}; \
\
&_g; \
})
#define NM_SETT_INFO_PROPERTY(...) \
(&((const NMSettInfoProperty) { \
__VA_ARGS__ \
}))
void _properties_override_add_struct (GArray *properties_override,
const NMSettInfoProperty *prop_info);
#define _properties_override_add(properties_override, \
...) \
(_properties_override_add_struct (properties_override, \
NM_SETT_INFO_PROPERTY (__VA_ARGS__)))
#define _properties_override_add_gobj(properties_override, p_param_spec, p_property_type) \
_properties_override_add ((properties_override), .param_spec = (p_param_spec), .property_type = (p_property_type))
#define _properties_override_add_virt(properties_override, p_name, p_property_type) \
_properties_override_add ((properties_override), .name = (p_name), .property_type = (p_property_type))
/**
* _properties_override_add_override:
* @properties_override: an array collecting the overrides
* @p_param_spec: the name of the property to override
* @p_dbus_type: the type of the property (in its D-Bus representation)
* @p_to_dbus_fcn: (allow-none): function to call to get the value of the property
* @p_from_dbus_fcn: (allow-none): function to call to set the value of the property
* @p_missing_from_dbus_fcn: (allow-none): function to call to indicate the property was not set
*
* Overrides the D-Bus representation of the #GObject property that shares the
* same name as @p_param_spec.
*
* When serializing a setting to D-Bus, if @p_to_dbus_fcn is non-%NULL, then it will
* be called to get the property's value. If it returns a #GVariant, the
* property will be added to the hash, and if it returns %NULL, the property
* will be omitted. (If @p_to_dbus_fcn is %NULL, the property will be read normally
* with g_object_get_property(), and added to the hash if it is not the default
* value.)
*
* When deserializing a D-Bus representation into a setting, if a value with
* the name of @p_param_spec is present, then @p_from_dbus_fcn will be called to set it.
* (If @p_from_dbus_fcn is %NULL then the property will be set normally with
* g_object_set_property().)
*
* If @p_missing_from_dbus_fcn is non-%NULL, then it will be called when deserializing a
* representation that does NOT contain a value for the property. This can be used,
* eg, if a new property needs to be initialized from some older deprecated property
* when it is not present.
*/
#define _properties_override_add_override(properties_override, \
p_param_spec, \
p_dbus_type, \
p_to_dbus_fcn, \
p_from_dbus_fcn, \
p_missing_from_dbus_fcn) \
({ \
GParamSpec *const _param_spec = (p_param_spec); \
\
nm_assert (_param_spec); \
\
_properties_override_add ((properties_override), \
.param_spec = (_param_spec), \
.property_type = NM_SETT_INFO_PROPERT_TYPE ( \
.dbus_type = (p_dbus_type), \
.to_dbus_fcn = (p_to_dbus_fcn), \
.from_dbus_fcn = (p_from_dbus_fcn), \
.missing_from_dbus_fcn = (p_missing_from_dbus_fcn), \
)); \
})
/**
* _properties_override_add_transform:
* @properties_override: an array collecting the overrides
* @p_param_spec: the param spec of the property to transform.
* @p_dbus_type: the type of the property (in its D-Bus representation)
* @p_gprop_to_dbus_fcn: function to convert from object to D-Bus format
* @p_gprop_from_dbus_fcn: function to convert from D-Bus to object format
*
* Indicates that @property on @setting_class does not have the same format as
* its corresponding D-Bus representation, and so must be transformed when
* serializing/deserializing.
*
* The transformation will also be used by nm_setting_compare(), meaning that
* the underlying object property does not need to be of a type that
* nm_property_compare() recognizes, as long as it recognizes @p_dbus_type.
*/
#define _properties_override_add_transform(properties_override, \
p_param_spec, \
p_dbus_type, \
p_gprop_to_dbus_fcn, \
p_gprop_from_dbus_fcn) \
({ \
GParamSpec *const _param_spec = (p_param_spec); \
\
nm_assert (_param_spec); \
\
_properties_override_add ((properties_override), \
.param_spec = (_param_spec), \
.property_type = NM_SETT_INFO_PROPERT_TYPE ( \
.dbus_type = (p_dbus_type), \
.gprop_to_dbus_fcn = (p_gprop_to_dbus_fcn), \
.gprop_from_dbus_fcn = (p_gprop_from_dbus_fcn), \
)); \
})
/*****************************************************************************/
gboolean _nm_setting_use_legacy_property (NMSetting *setting,
GVariant *connection_dict,
const char *legacy_property,
const char *new_property);
GPtrArray *_nm_setting_need_secrets (NMSetting *setting);
gboolean _nm_setting_should_compare_secret_property (NMSetting *setting,
NMSetting *other,
const char *secret_name,
NMSettingCompareFlags flags);
NMBridgeVlan *_nm_bridge_vlan_dup (const NMBridgeVlan *vlan);
NMBridgeVlan *_nm_bridge_vlan_dup_and_seal (const NMBridgeVlan *vlan);
/*****************************************************************************/
#endif /* NM_SETTING_PRIVATE_H */
|
