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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
|
# Copyright (C) 2018-2020 Canonical, Ltd.
# Author: Mathieu Trudel-Lapierre <mathieu.trudel-lapierre@canonical.com>
# Author: Łukasz 'sil2100' Zemczak <lukasz.zemczak@canonical.com>
# Author: Lukas 'slyon' Märdian <lukas.maerdian@canonical.com>
# Author: Simon Chopin <simon.chopin@canonical.com>
#
# 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; version 3.
#
# 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, see <http://www.gnu.org/licenses/>.
import tempfile
import logging
import ctypes
import ctypes.util
from ctypes import c_char_p, c_void_p, c_int, c_uint, c_size_t, c_ssize_t
from typing import List, Union, IO
class LibNetplanException(Exception):
pass
class _GError(ctypes.Structure):
_fields_ = [("domain", ctypes.c_uint32), ("code", c_int), ("message", c_char_p)]
class _netplan_state(ctypes.Structure):
pass
class _netplan_parser(ctypes.Structure):
pass
class _netplan_net_definition(ctypes.Structure):
pass
lib = ctypes.CDLL(ctypes.util.find_library('netplan'))
_GErrorPP = ctypes.POINTER(ctypes.POINTER(_GError))
_NetplanParserP = ctypes.POINTER(_netplan_parser)
_NetplanStateP = ctypes.POINTER(_netplan_state)
_NetplanNetDefinitionP = ctypes.POINTER(_netplan_net_definition)
lib.netplan_get_id_from_nm_filename.restype = ctypes.c_char_p
def _string_realloc_call_no_error(function):
size = 16
while size < 1073741824: # 1MB
buffer = ctypes.create_string_buffer(size)
code = function(buffer)
if code == -2:
size = size * 2
continue
if code < 0: # pragma: nocover
raise LibNetplanException("Unknown error: %d" % code)
elif code == 0:
return None # pragma: nocover as it's hard to trigger for now
else:
return buffer.value.decode('utf-8')
raise LibNetplanException('Aborting due to string buffer size > 1M') # pragma: nocover
def _checked_lib_call(fn, *args):
err = ctypes.POINTER(_GError)()
ret = bool(fn(*args, ctypes.byref(err)))
if not ret:
raise LibNetplanException(err.contents.message.decode('utf-8'))
class Parser:
_abi_loaded = False
@classmethod
def _load_abi(cls):
if cls._abi_loaded:
return
lib.netplan_parser_new.restype = _NetplanParserP
lib.netplan_parser_clear.argtypes = [ctypes.POINTER(_NetplanParserP)]
lib.netplan_parser_load_yaml.argtypes = [_NetplanParserP, c_char_p, _GErrorPP]
lib.netplan_parser_load_yaml.restype = c_int
lib.netplan_parser_load_yaml_from_fd.argtypes = [_NetplanParserP, c_int, _GErrorPP]
lib.netplan_parser_load_yaml_from_fd.restype = c_int
lib.netplan_parser_load_nullable_fields.argtypes = [_NetplanParserP, c_int, _GErrorPP]
lib.netplan_parser_load_nullable_fields.restype = c_int
cls._abi_loaded = True
def __init__(self):
self._load_abi()
self._ptr = lib.netplan_parser_new()
def __del__(self):
lib.netplan_parser_clear(ctypes.byref(self._ptr))
def load_yaml(self, input_file: Union[str, IO]):
if isinstance(input_file, str):
_checked_lib_call(lib.netplan_parser_load_yaml, self._ptr, input_file.encode('utf-8'))
else:
_checked_lib_call(lib.netplan_parser_load_yaml_from_fd, self._ptr, input_file.fileno())
def load_yaml_hierarchy(self, rootdir):
_checked_lib_call(lib.netplan_parser_load_yaml_hierarchy, self._ptr, rootdir.encode('utf-8'))
def load_nullable_fields(self, input_file: IO):
_checked_lib_call(lib.netplan_parser_load_nullable_fields, self._ptr, input_file.fileno())
class State:
_abi_loaded = False
@classmethod
def _load_abi(cls):
if cls._abi_loaded:
return
lib.netplan_state_new.restype = _NetplanStateP
lib.netplan_state_clear.argtypes = [ctypes.POINTER(_NetplanStateP)]
lib.netplan_state_import_parser_results.argtypes = [_NetplanStateP, _NetplanParserP, _GErrorPP]
lib.netplan_state_import_parser_results.restype = c_int
lib.netplan_state_get_netdefs_size.argtypes = [_NetplanStateP]
lib.netplan_state_get_netdefs_size.restype = c_int
lib.netplan_state_get_netdef.argtypes = [_NetplanStateP, c_char_p]
lib.netplan_state_get_netdef.restype = _NetplanNetDefinitionP
lib.netplan_state_write_yaml_file.argtypes = [_NetplanStateP, c_char_p, c_char_p, _GErrorPP]
lib.netplan_state_write_yaml_file.restype = c_int
lib.netplan_state_update_yaml_hierarchy.argtypes = [_NetplanStateP, c_char_p, c_char_p, _GErrorPP]
lib.netplan_state_update_yaml_hierarchy.restype = c_int
lib.netplan_state_dump_yaml.argtypes = [_NetplanStateP, c_int, _GErrorPP]
lib.netplan_state_dump_yaml.restype = c_int
lib.netplan_netdef_get_embedded_switch_mode.argtypes = [_NetplanNetDefinitionP]
lib.netplan_netdef_get_embedded_switch_mode.restype = c_char_p
lib.netplan_netdef_get_delay_virtual_functions_rebind.argtypes = [_NetplanNetDefinitionP]
lib.netplan_netdef_get_delay_virtual_functions_rebind.restype = c_int
lib.netplan_state_get_backend.argtypes = [_NetplanStateP]
lib.netplan_state_get_backend.restype = c_int
cls._abi_loaded = True
def __init__(self):
self._load_abi()
self._ptr = lib.netplan_state_new()
def __del__(self):
lib.netplan_state_clear(ctypes.byref(self._ptr))
def import_parser_results(self, parser):
_checked_lib_call(lib.netplan_state_import_parser_results, self._ptr, parser._ptr)
def write_yaml_file(self, filename, rootdir):
name = filename.encode('utf-8') if filename else None
root = rootdir.encode('utf-8') if rootdir else None
_checked_lib_call(lib.netplan_state_write_yaml_file, self._ptr, name, root)
def update_yaml_hierarchy(self, default_filename, rootdir):
name = default_filename.encode('utf-8')
root = rootdir.encode('utf-8') if rootdir else None
_checked_lib_call(lib.netplan_state_update_yaml_hierarchy, self._ptr, name, root)
def dump_yaml(self, output_file):
fd = output_file.fileno()
_checked_lib_call(lib.netplan_state_dump_yaml, self._ptr, fd)
def __len__(self):
return lib.netplan_state_get_netdefs_size(self._ptr)
def __getitem__(self, def_id):
ptr = lib.netplan_state_get_netdef(self._ptr, def_id.encode('utf-8'))
if not ptr:
raise IndexError()
return NetDefinition(self, ptr)
@property
def all_defs(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, None))
@property
def ethernets(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "ethernets"))
@property
def modems(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "modems"))
@property
def wifis(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "wifis"))
@property
def vlans(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "vlans"))
@property
def bridges(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "bridges"))
@property
def bonds(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "bonds"))
@property
def tunnels(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "tunnels"))
@property
def vrfs(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "vrfs"))
@property
def ovs_ports(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "_ovs-ports"))
@property
def nm_devices(self):
return dict((nd.id, nd) for nd in _NetdefIterator(self, "nm-devices"))
@property
def backend(self):
return lib.netplan_backend_name(lib.netplan_state_get_backend(self._ptr)).decode('utf-8')
def dump_to_logs(self):
# Convoluted way to dump the parsed config to the logs...
with tempfile.TemporaryFile() as tmp:
self.dump_yaml(output_file=tmp)
logging.debug("Merged config:\n{}".format(tmp.read()))
class NetDefinition:
_abi_loaded = False
@classmethod
def _load_abi(cls):
if cls._abi_loaded:
return
lib.netplan_netdef_has_match.argtypes = [_NetplanNetDefinitionP]
lib.netplan_netdef_has_match.restype = c_int
lib.netplan_netdef_get_id.argtypes = [_NetplanNetDefinitionP, c_char_p, c_size_t]
lib.netplan_netdef_get_id.restype = c_ssize_t
lib.netplan_netdef_get_filepath.argtypes = [_NetplanNetDefinitionP, c_char_p, c_size_t]
lib.netplan_netdef_get_filepath.restype = c_ssize_t
lib.netplan_netdef_get_backend.argtypes = [_NetplanNetDefinitionP]
lib.netplan_netdef_get_backend.restype = c_int
lib.netplan_netdef_get_type.argtypes = [_NetplanNetDefinitionP]
lib.netplan_netdef_get_type.restype = c_int
lib.netplan_netdef_get_set_name.argtypes = [_NetplanNetDefinitionP, c_char_p, c_size_t]
lib.netplan_netdef_get_set_name.restype = c_ssize_t
lib._netplan_netdef_get_critical.argtypes = [_NetplanNetDefinitionP]
lib._netplan_netdef_get_critical.restype = c_int
lib._netplan_netdef_get_sriov_link.argtypes = [_NetplanNetDefinitionP]
lib._netplan_netdef_get_sriov_link.restype = _NetplanNetDefinitionP
lib._netplan_netdef_get_vlan_link.argtypes = [_NetplanNetDefinitionP]
lib._netplan_netdef_get_vlan_link.restype = _NetplanNetDefinitionP
lib._netplan_netdef_get_vlan_id.argtypes = [_NetplanNetDefinitionP]
lib._netplan_netdef_get_vlan_id.restype = c_uint
lib._netplan_netdef_get_sriov_vlan_filter.argtypes = [_NetplanNetDefinitionP]
lib._netplan_netdef_get_sriov_vlan_filter.restype = c_int
lib.netplan_netdef_match_interface.argtypes = [_NetplanNetDefinitionP]
lib.netplan_netdef_match_interface.restype = c_int
lib.netplan_backend_name.argtypes = [c_int]
lib.netplan_backend_name.restype = c_char_p
lib.netplan_def_type_name.argtypes = [c_int]
lib.netplan_def_type_name.restype = c_char_p
lib._netplan_state_get_vf_count_for_def.argtypes = [_NetplanStateP, _NetplanNetDefinitionP, _GErrorPP]
lib._netplan_state_get_vf_count_for_def.restype = c_int
lib._netplan_netdef_is_trivial_compound_itf.argtypes = [_NetplanNetDefinitionP]
lib._netplan_netdef_is_trivial_compound_itf.restype = c_int
cls._abi_loaded = True
def __eq__(self, other):
if not hasattr(other, '_ptr'):
return False
return ctypes.addressof(self._ptr.contents) == ctypes.addressof(other._ptr.contents)
def __init__(self, np_state, ptr):
self._load_abi()
self._ptr = ptr
# We hold on to this to avoid the underlying pointer being invalidated by
# the GC invoking netplan_state_free
self._parent = np_state
@property
def has_match(self):
return bool(lib.netplan_netdef_has_match(self._ptr))
@property
def set_name(self):
return _string_realloc_call_no_error(lambda b: lib.netplan_netdef_get_set_name(self._ptr, b, len(b)))
@property
def critical(self):
return bool(lib._netplan_netdef_get_critical(self._ptr))
@property
def sriov_link(self):
link_ptr = lib._netplan_netdef_get_sriov_link(self._ptr)
if link_ptr:
return NetDefinition(self._parent, link_ptr)
return None
@property
def vlan_link(self):
link_ptr = lib._netplan_netdef_get_vlan_link(self._ptr)
if link_ptr:
return NetDefinition(self._parent, link_ptr)
return None
@property
def vlan_id(self):
vlan_id = lib._netplan_netdef_get_vlan_id(self._ptr)
# No easy way to get UINT_MAX besides this...
if vlan_id == c_uint(-1).value:
return None
return vlan_id
@property
def has_sriov_vlan_filter(self):
return bool(lib._netplan_netdef_get_sriov_vlan_filter(self._ptr))
@property
def backend(self):
return lib.netplan_backend_name(lib.netplan_netdef_get_backend(self._ptr)).decode('utf-8')
@property
def type(self):
return lib.netplan_def_type_name(lib.netplan_netdef_get_type(self._ptr)).decode('utf-8')
@property
def id(self):
return _string_realloc_call_no_error(lambda b: lib.netplan_netdef_get_id(self._ptr, b, len(b)))
@property
def filepath(self):
return _string_realloc_call_no_error(lambda b: lib.netplan_netdef_get_filepath(self._ptr, b, len(b)))
@property
def embedded_switch_mode(self):
mode = lib.netplan_netdef_get_embedded_switch_mode(self._ptr)
return mode and mode.decode('utf-8')
@property
def delay_virtual_functions_rebind(self):
return bool(lib.netplan_netdef_get_delay_virtual_functions_rebind(self._ptr))
def match_interface(self, itf_name=None, itf_driver=None, itf_mac=None):
return bool(lib.netplan_netdef_match_interface(
self._ptr,
itf_name and itf_name.encode('utf-8'),
itf_mac and itf_mac.encode('utf-8'),
itf_driver and itf_driver.encode('utf-8')))
@property
def vf_count(self):
err = ctypes.POINTER(_GError)()
count = lib._netplan_state_get_vf_count_for_def(self._parent._ptr, self._ptr, ctypes.byref(err))
if count < 0:
raise LibNetplanException(err.contents.message.decode('utf-8'))
return count
@property
def is_trivial_compound_itf(self):
'''
Returns True if the interface is a compound interface (bond or bridge),
and its configuration is trivial, without any variation from the defaults.
'''
return bool(lib._netplan_netdef_is_trivial_compound_itf(self._ptr))
class _NetdefIterator:
_abi_loaded = False
@classmethod
def _load_abi(cls):
if cls._abi_loaded:
return
if not hasattr(lib, '_netplan_iter_defs_per_devtype_init'): # pragma: nocover (hard to unit-test against the WRONG lib)
raise LibNetplanException('''
The current version of libnetplan does not allow iterating by devtype.
Please ensure that both the netplan CLI package and its library are up to date.
''')
lib._netplan_state_new_netdef_pertype_iter.argtypes = [_NetplanStateP, c_char_p]
lib._netplan_state_new_netdef_pertype_iter.restype = c_void_p
lib._netplan_iter_defs_per_devtype_next.argtypes = [c_void_p]
lib._netplan_iter_defs_per_devtype_next.restype = _NetplanNetDefinitionP
lib._netplan_iter_defs_per_devtype_free.argtypes = [c_void_p]
lib._netplan_iter_defs_per_devtype_free.restype = None
lib._netplan_netdef_id.argtypes = [c_void_p]
lib._netplan_netdef_id.restype = c_char_p
cls._abi_loaded = True
def __init__(self, np_state, devtype):
self._load_abi()
# To keep things valid, keep a reference to the parent state
self.np_state = np_state
self.iterator = lib._netplan_state_new_netdef_pertype_iter(np_state._ptr, devtype and devtype.encode('utf-8'))
def __del__(self):
lib._netplan_iter_defs_per_devtype_free(self.iterator)
def __iter__(self):
return self
def __next__(self):
next_value = lib._netplan_iter_defs_per_devtype_next(self.iterator)
if not next_value:
raise StopIteration
return NetDefinition(self.np_state, next_value)
lib.netplan_util_create_yaml_patch.argtypes = [c_char_p, c_char_p, c_int, _GErrorPP]
lib.netplan_util_create_yaml_patch.restype = c_int
lib.netplan_util_dump_yaml_subtree.argtypes = [c_char_p, c_int, c_int, _GErrorPP]
lib.netplan_util_dump_yaml_subtree.restype = c_int
def create_yaml_patch(patch_object_path: List[str], patch_payload: str, patch_output):
_checked_lib_call(lib.netplan_util_create_yaml_patch,
'\t'.join(patch_object_path).encode('utf-8'),
patch_payload.encode('utf-8'),
patch_output.fileno())
def dump_yaml_subtree(prefix, input_file, output_file):
_checked_lib_call(lib.netplan_util_dump_yaml_subtree,
prefix.encode('utf-8'),
input_file.fileno(),
output_file.fileno())
|