2 # SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
9 from lib import SpecFamily, SpecAttrSet, SpecAttr, SpecOperation, SpecEnumSet, SpecEnumEntry
13 return name.upper().replace('-', '_')
17 return name.lower().replace('-', '_')
21 def get_family_id(self):
22 return 'ys->family_id'
24 def parse_cb_run(self, cb, data, is_dump=False, indent=1):
25 ind = '\n\t\t' + '\t' * indent + ' '
27 return f"mnl_cb_run2(ys->rx_buf, len, 0, 0, {cb}, {data},{ind}ynl_cb_array, NLMSG_MIN_TYPE)"
29 return f"mnl_cb_run2(ys->rx_buf, len, ys->seq, ys->portid,{ind}{cb}, {data},{ind}" + \
30 "ynl_cb_array, NLMSG_MIN_TYPE)"
34 def __init__(self, family, attr_set, attr, value):
35 super().__init__(family, attr_set, attr, value)
38 self.attr_set = attr_set
39 self.type = attr['type']
40 self.checks = attr.get('checks', {})
43 self.len = attr['len']
44 if 'nested-attributes' in attr:
45 self.nested_attrs = attr['nested-attributes']
46 if self.nested_attrs == family.name:
47 self.nested_render_name = f"{family.name}"
49 self.nested_render_name = f"{family.name}_{c_lower(self.nested_attrs)}"
51 self.c_name = c_lower(self.name)
52 if self.c_name in _C_KW:
57 delattr(self, "enum_name")
60 self.enum_name = f"{self.attr_set.name_prefix}{self.name}"
61 self.enum_name = c_upper(self.enum_name)
63 def is_multi_val(self):
67 return self.type in {'u8', 'u16', 'u32', 'u64', 's32', 's64'}
69 def presence_type(self):
72 def presence_member(self, space, type_filter):
73 if self.presence_type() != type_filter:
76 if self.presence_type() == 'bit':
77 pfx = '__' if space == 'user' else ''
78 return f"{pfx}u32 {self.c_name}:1;"
80 if self.presence_type() == 'len':
81 pfx = '__' if space == 'user' else ''
82 return f"{pfx}u32 {self.c_name}_len;"
84 def _complex_member_type(self, ri):
87 def free_needs_iter(self):
90 def free(self, ri, var, ref):
91 if self.is_multi_val() or self.presence_type() == 'len':
92 ri.cw.p(f'free({var}->{ref}{self.c_name});')
94 def arg_member(self, ri):
95 member = self._complex_member_type(ri)
97 return [member + ' *' + self.c_name]
98 raise Exception(f"Struct member not implemented for class type {self.type}")
100 def struct_member(self, ri):
101 if self.is_multi_val():
102 ri.cw.p(f"unsigned int n_{self.c_name};")
103 member = self._complex_member_type(ri)
105 ptr = '*' if self.is_multi_val() else ''
106 ri.cw.p(f"{member} {ptr}{self.c_name};")
108 members = self.arg_member(ri)
112 def _attr_policy(self, policy):
113 return '{ .type = ' + policy + ', }'
115 def attr_policy(self, cw):
116 policy = c_upper('nla-' + self.attr['type'])
118 spec = self._attr_policy(policy)
119 cw.p(f"\t[{self.enum_name}] = {spec},")
121 def _attr_typol(self):
122 raise Exception(f"Type policy not implemented for class type {self.type}")
124 def attr_typol(self, cw):
125 typol = self._attr_typol()
126 cw.p(f'[{self.enum_name}] = {"{"} .name = "{self.name}", {typol}{"}"},')
128 def _attr_put_line(self, ri, var, line):
129 if self.presence_type() == 'bit':
130 ri.cw.p(f"if ({var}->_present.{self.c_name})")
131 elif self.presence_type() == 'len':
132 ri.cw.p(f"if ({var}->_present.{self.c_name}_len)")
135 def _attr_put_simple(self, ri, var, put_type):
136 line = f"mnl_attr_put_{put_type}(nlh, {self.enum_name}, {var}->{self.c_name})"
137 self._attr_put_line(ri, var, line)
139 def attr_put(self, ri, var):
140 raise Exception(f"Put not implemented for class type {self.type}")
142 def _attr_get(self, ri, var):
143 raise Exception(f"Attr get not implemented for class type {self.type}")
145 def attr_get(self, ri, var, first):
146 lines, init_lines, local_vars = self._attr_get(ri, var)
147 if type(lines) is str:
149 if type(init_lines) is str:
150 init_lines = [init_lines]
152 kw = 'if' if first else 'else if'
153 ri.cw.block_start(line=f"{kw} (mnl_attr_get_type(attr) == {self.enum_name})")
155 for local in local_vars:
159 if not self.is_multi_val():
160 ri.cw.p("if (ynl_attr_validate(yarg, attr))")
161 ri.cw.p("return MNL_CB_ERROR;")
162 if self.presence_type() == 'bit':
163 ri.cw.p(f"{var}->_present.{self.c_name} = 1;")
167 for line in init_lines:
174 def _setter_lines(self, ri, member, presence):
175 raise Exception(f"Setter not implemented for class type {self.type}")
177 def setter(self, ri, space, direction, deref=False, ref=None):
178 ref = (ref if ref else []) + [self.c_name]
180 member = f"{var}->{'.'.join(ref)}"
184 for i in range(0, len(ref)):
185 presence = f"{var}->{'.'.join(ref[:i] + [''])}_present.{ref[i]}"
186 if self.presence_type() == 'bit':
187 code.append(presence + ' = 1;')
188 code += self._setter_lines(ri, member, presence)
190 ri.cw.write_func('static inline void',
191 f"{op_prefix(ri, direction, deref=deref)}_set_{'_'.join(ref)}",
193 args=[f'{type_name(ri, direction, deref=deref)} *{var}'] + self.arg_member(ri))
196 class TypeUnused(Type):
197 def presence_type(self):
200 def _attr_typol(self):
201 return '.type = YNL_PT_REJECT, '
203 def attr_policy(self, cw):
208 def presence_type(self):
211 def _attr_typol(self):
212 return '.type = YNL_PT_REJECT, '
214 def attr_policy(self, cw):
218 class TypeScalar(Type):
219 def __init__(self, family, attr_set, attr, value):
220 super().__init__(family, attr_set, attr, value)
222 self.byte_order_comment = ''
223 if 'byte-order' in attr:
224 self.byte_order_comment = f" /* {attr['byte-order']} */"
226 # Added by resolve():
227 self.is_bitfield = None
228 delattr(self, "is_bitfield")
229 self.type_name = None
230 delattr(self, "type_name")
233 self.resolve_up(super())
235 if 'enum-as-flags' in self.attr and self.attr['enum-as-flags']:
236 self.is_bitfield = True
237 elif 'enum' in self.attr:
238 self.is_bitfield = self.family.consts[self.attr['enum']]['type'] == 'flags'
240 self.is_bitfield = False
242 if 'enum' in self.attr and not self.is_bitfield:
243 self.type_name = f"enum {self.family.name}_{c_lower(self.attr['enum'])}"
245 self.type_name = '__' + self.type
249 # mnl does not have a helper for signed types
254 def _attr_policy(self, policy):
255 if 'flags-mask' in self.checks or self.is_bitfield:
257 mask = self.family.consts[self.attr['enum']].get_mask()
259 flags = self.family.consts[self.checks['flags-mask']]
260 flag_cnt = len(flags['entries'])
261 mask = (1 << flag_cnt) - 1
262 return f"NLA_POLICY_MASK({policy}, 0x{mask:x})"
263 elif 'min' in self.checks:
264 return f"NLA_POLICY_MIN({policy}, {self.checks['min']})"
265 elif 'enum' in self.attr:
266 enum = self.family.consts[self.attr['enum']]
267 cnt = len(enum['entries'])
268 return f"NLA_POLICY_MAX({policy}, {cnt - 1})"
269 return super()._attr_policy(policy)
271 def _attr_typol(self):
272 return f'.type = YNL_PT_U{self.type[1:]}, '
274 def arg_member(self, ri):
275 return [f'{self.type_name} {self.c_name}{self.byte_order_comment}']
277 def attr_put(self, ri, var):
278 self._attr_put_simple(ri, var, self._mnl_type())
280 def _attr_get(self, ri, var):
281 return f"{var}->{self.c_name} = mnl_attr_get_{self._mnl_type()}(attr);", None, None
283 def _setter_lines(self, ri, member, presence):
284 return [f"{member} = {self.c_name};"]
287 class TypeFlag(Type):
288 def arg_member(self, ri):
291 def _attr_typol(self):
292 return '.type = YNL_PT_FLAG, '
294 def attr_put(self, ri, var):
295 self._attr_put_line(ri, var, f"mnl_attr_put(nlh, {self.enum_name}, 0, NULL)")
297 def _attr_get(self, ri, var):
298 return [], None, None
300 def _setter_lines(self, ri, member, presence):
304 class TypeString(Type):
305 def arg_member(self, ri):
306 return [f"const char *{self.c_name}"]
308 def presence_type(self):
311 def struct_member(self, ri):
312 ri.cw.p(f"char *{self.c_name};")
314 def _attr_typol(self):
315 return f'.type = YNL_PT_NUL_STR, '
317 def _attr_policy(self, policy):
318 mem = '{ .type = ' + policy
319 if 'max-len' in self.checks:
320 mem += ', .len = ' + str(self.checks['max-len'])
324 def attr_policy(self, cw):
325 if self.checks.get('unterminated-ok', False):
326 policy = 'NLA_STRING'
328 policy = 'NLA_NUL_STRING'
330 spec = self._attr_policy(policy)
331 cw.p(f"\t[{self.enum_name}] = {spec},")
333 def attr_put(self, ri, var):
334 self._attr_put_simple(ri, var, 'strz')
336 def _attr_get(self, ri, var):
337 len_mem = var + '->_present.' + self.c_name + '_len'
338 return [f"{len_mem} = len;",
339 f"{var}->{self.c_name} = malloc(len + 1);",
340 f"memcpy({var}->{self.c_name}, mnl_attr_get_str(attr), len);",
341 f"{var}->{self.c_name}[len] = 0;"], \
342 ['len = strnlen(mnl_attr_get_str(attr), mnl_attr_get_payload_len(attr));'], \
343 ['unsigned int len;']
345 def _setter_lines(self, ri, member, presence):
346 return [f"free({member});",
347 f"{presence}_len = strlen({self.c_name});",
348 f"{member} = malloc({presence}_len + 1);",
349 f'memcpy({member}, {self.c_name}, {presence}_len);',
350 f'{member}[{presence}_len] = 0;']
353 class TypeBinary(Type):
354 def arg_member(self, ri):
355 return [f"const void *{self.c_name}", 'size_t len']
357 def presence_type(self):
360 def struct_member(self, ri):
361 ri.cw.p(f"void *{self.c_name};")
363 def _attr_typol(self):
364 return f'.type = YNL_PT_BINARY,'
366 def _attr_policy(self, policy):
368 if len(self.checks) == 1 and 'min-len' in self.checks:
369 mem += '.len = ' + str(self.checks['min-len'])
370 elif len(self.checks) == 0:
371 mem += '.type = NLA_BINARY'
373 raise Exception('One or more of binary type checks not implemented, yet')
377 def attr_put(self, ri, var):
378 self._attr_put_line(ri, var, f"mnl_attr_put(nlh, {self.enum_name}, " +
379 f"{var}->_present.{self.c_name}_len, {var}->{self.c_name})")
381 def _attr_get(self, ri, var):
382 len_mem = var + '->_present.' + self.c_name + '_len'
383 return [f"{len_mem} = len;",
384 f"{var}->{self.c_name} = malloc(len);",
385 f"memcpy({var}->{self.c_name}, mnl_attr_get_payload(attr), len);"], \
386 ['len = mnl_attr_get_payload_len(attr);'], \
387 ['unsigned int len;']
389 def _setter_lines(self, ri, member, presence):
390 return [f"free({member});",
391 f"{member} = malloc({presence}_len);",
392 f'memcpy({member}, {self.c_name}, {presence}_len);']
395 class TypeNest(Type):
396 def _complex_member_type(self, ri):
397 return f"struct {self.nested_render_name}"
399 def free(self, ri, var, ref):
400 ri.cw.p(f'{self.nested_render_name}_free(&{var}->{ref}{self.c_name});')
402 def _attr_typol(self):
403 return f'.type = YNL_PT_NEST, .nest = &{self.nested_render_name}_nest, '
405 def _attr_policy(self, policy):
406 return 'NLA_POLICY_NESTED(' + self.nested_render_name + '_nl_policy)'
408 def attr_put(self, ri, var):
409 self._attr_put_line(ri, var, f"{self.nested_render_name}_put(nlh, " +
410 f"{self.enum_name}, &{var}->{self.c_name})")
412 def _attr_get(self, ri, var):
413 get_lines = [f"{self.nested_render_name}_parse(&parg, attr);"]
414 init_lines = [f"parg.rsp_policy = &{self.nested_render_name}_nest;",
415 f"parg.data = &{var}->{self.c_name};"]
416 return get_lines, init_lines, None
418 def setter(self, ri, space, direction, deref=False, ref=None):
419 ref = (ref if ref else []) + [self.c_name]
421 for _, attr in ri.family.pure_nested_structs[self.nested_attrs].member_list():
422 attr.setter(ri, self.nested_attrs, direction, deref=deref, ref=ref)
425 class TypeMultiAttr(Type):
426 def is_multi_val(self):
429 def presence_type(self):
432 def _complex_member_type(self, ri):
433 if 'type' not in self.attr or self.attr['type'] == 'nest':
434 return f"struct {self.nested_render_name}"
435 elif self.attr['type'] in scalars:
436 scalar_pfx = '__' if ri.ku_space == 'user' else ''
437 return scalar_pfx + self.attr['type']
439 raise Exception(f"Sub-type {self.attr['type']} not supported yet")
441 def free_needs_iter(self):
442 return 'type' not in self.attr or self.attr['type'] == 'nest'
444 def free(self, ri, var, ref):
445 if 'type' not in self.attr or self.attr['type'] == 'nest':
446 ri.cw.p(f"for (i = 0; i < {var}->{ref}n_{self.c_name}; i++)")
447 ri.cw.p(f'{self.nested_render_name}_free(&{var}->{ref}{self.c_name}[i]);')
449 def _attr_typol(self):
450 if 'type' not in self.attr or self.attr['type'] == 'nest':
451 return f'.type = YNL_PT_NEST, .nest = &{self.nested_render_name}_nest, '
452 elif self.attr['type'] in scalars:
453 return f".type = YNL_PT_U{self.attr['type'][1:]}, "
455 raise Exception(f"Sub-type {self.attr['type']} not supported yet")
457 def _attr_get(self, ri, var):
458 return f'{var}->n_{self.c_name}++;', None, None
461 class TypeArrayNest(Type):
462 def is_multi_val(self):
465 def presence_type(self):
468 def _complex_member_type(self, ri):
469 if 'sub-type' not in self.attr or self.attr['sub-type'] == 'nest':
470 return f"struct {self.nested_render_name}"
471 elif self.attr['sub-type'] in scalars:
472 scalar_pfx = '__' if ri.ku_space == 'user' else ''
473 return scalar_pfx + self.attr['sub-type']
475 raise Exception(f"Sub-type {self.attr['sub-type']} not supported yet")
477 def _attr_typol(self):
478 return f'.type = YNL_PT_NEST, .nest = &{self.nested_render_name}_nest, '
480 def _attr_get(self, ri, var):
481 local_vars = ['const struct nlattr *attr2;']
482 get_lines = [f'attr_{self.c_name} = attr;',
483 'mnl_attr_for_each_nested(attr2, attr)',
484 f'\t{var}->n_{self.c_name}++;']
485 return get_lines, None, local_vars
488 class TypeNestTypeValue(Type):
489 def _complex_member_type(self, ri):
490 return f"struct {self.nested_render_name}"
492 def _attr_typol(self):
493 return f'.type = YNL_PT_NEST, .nest = &{self.nested_render_name}_nest, '
495 def _attr_get(self, ri, var):
500 init_lines = [f"parg.rsp_policy = &{self.nested_render_name}_nest;",
501 f"parg.data = &{var}->{self.c_name};"]
502 if 'type-value' in self.attr:
503 tv_names = [c_lower(x) for x in self.attr["type-value"]]
504 local_vars += [f'const struct nlattr *attr_{", *attr_".join(tv_names)};']
505 local_vars += [f'__u32 {", ".join(tv_names)};']
506 for level in self.attr["type-value"]:
507 level = c_lower(level)
508 get_lines += [f'attr_{level} = mnl_attr_get_payload({prev});']
509 get_lines += [f'{level} = mnl_attr_get_type(attr_{level});']
510 prev = 'attr_' + level
512 tv_args = f", {', '.join(tv_names)}"
514 get_lines += [f"{self.nested_render_name}_parse(&parg, {prev}{tv_args});"]
515 return get_lines, init_lines, local_vars
519 def __init__(self, family, space_name, type_list=None, inherited=None):
521 self.space_name = space_name
522 self.attr_set = family.attr_sets[space_name]
523 # Use list to catch comparisons with empty sets
524 self._inherited = inherited if inherited is not None else []
527 self.nested = type_list is None
528 if family.name == c_lower(space_name):
529 self.render_name = f"{family.name}"
531 self.render_name = f"{family.name}_{c_lower(space_name)}"
532 self.struct_name = 'struct ' + self.render_name
533 self.ptr_name = self.struct_name + ' *'
542 self.attr_list.append((t, self.attr_set[t]),)
544 for t in self.attr_set:
545 self.attr_list.append((t, self.attr_set[t]),)
548 self.attr_max_val = None
549 for name, attr in self.attr_list:
550 if attr.value >= max_val:
552 self.attr_max_val = attr
553 self.attrs[name] = attr
556 yield from self.attrs
558 def __getitem__(self, key):
559 return self.attrs[key]
561 def member_list(self):
562 return self.attr_list
564 def set_inherited(self, new_inherited):
565 if self._inherited != new_inherited:
566 raise Exception("Inheriting different members not supported")
567 self.inherited = [c_lower(x) for x in sorted(self._inherited)]
570 class EnumEntry(SpecEnumEntry):
571 def __init__(self, enum_set, yaml, prev, value_start):
572 super().__init__(enum_set, yaml, prev, value_start)
575 self.value_change = (self.value != prev.value + 1)
577 self.value_change = (self.value != 0)
578 self.value_change = self.value_change or self.enum_set['type'] == 'flags'
582 delattr(self, "c_name")
585 self.resolve_up(super())
587 self.c_name = c_upper(self.enum_set.value_pfx + self.name)
590 class EnumSet(SpecEnumSet):
591 def __init__(self, family, yaml):
592 self.render_name = c_lower(family.name + '-' + yaml['name'])
593 self.enum_name = 'enum ' + self.render_name
595 self.value_pfx = yaml.get('name-prefix', f"{family.name}-{yaml['name']}-")
597 super().__init__(family, yaml)
599 def new_entry(self, entry, prev_entry, value_start):
600 return EnumEntry(self, entry, prev_entry, value_start)
603 class AttrSet(SpecAttrSet):
604 def __init__(self, family, yaml):
605 super().__init__(family, yaml)
607 if self.subset_of is None:
608 if 'name-prefix' in yaml:
609 pfx = yaml['name-prefix']
610 elif self.name == family.name:
611 pfx = family.name + '-a-'
613 pfx = f"{family.name}-a-{self.name}-"
614 self.name_prefix = c_upper(pfx)
615 self.max_name = c_upper(self.yaml.get('attr-max-name', f"{self.name_prefix}max"))
617 self.name_prefix = family.attr_sets[self.subset_of].name_prefix
618 self.max_name = family.attr_sets[self.subset_of].max_name
622 delattr(self, "c_name")
625 self.c_name = c_lower(self.name)
626 if self.c_name in _C_KW:
628 if self.c_name == self.family.c_name:
631 def new_attr(self, elem, value):
632 if 'multi-attr' in elem and elem['multi-attr']:
633 return TypeMultiAttr(self.family, self, elem, value)
634 elif elem['type'] in scalars:
635 return TypeScalar(self.family, self, elem, value)
636 elif elem['type'] == 'unused':
637 return TypeUnused(self.family, self, elem, value)
638 elif elem['type'] == 'pad':
639 return TypePad(self.family, self, elem, value)
640 elif elem['type'] == 'flag':
641 return TypeFlag(self.family, self, elem, value)
642 elif elem['type'] == 'string':
643 return TypeString(self.family, self, elem, value)
644 elif elem['type'] == 'binary':
645 return TypeBinary(self.family, self, elem, value)
646 elif elem['type'] == 'nest':
647 return TypeNest(self.family, self, elem, value)
648 elif elem['type'] == 'array-nest':
649 return TypeArrayNest(self.family, self, elem, value)
650 elif elem['type'] == 'nest-type-value':
651 return TypeNestTypeValue(self.family, self, elem, value)
653 raise Exception(f"No typed class for type {elem['type']}")
656 class Operation(SpecOperation):
657 def __init__(self, family, yaml, req_value, rsp_value):
658 super().__init__(family, yaml, req_value, rsp_value)
660 if req_value != rsp_value:
661 raise Exception("Directional messages not supported by codegen")
663 self.render_name = family.name + '_' + c_lower(self.name)
665 self.dual_policy = ('do' in yaml and 'request' in yaml['do']) and \
666 ('dump' in yaml and 'request' in yaml['dump'])
669 self.enum_name = None
670 delattr(self, "enum_name")
673 self.resolve_up(super())
675 if not self.is_async:
676 self.enum_name = self.family.op_prefix + c_upper(self.name)
678 self.enum_name = self.family.async_op_prefix + c_upper(self.name)
680 def add_notification(self, op):
681 if 'notify' not in self.yaml:
682 self.yaml['notify'] = dict()
683 self.yaml['notify']['reply'] = self.yaml['do']['reply']
684 self.yaml['notify']['cmds'] = []
685 self.yaml['notify']['cmds'].append(op)
688 class Family(SpecFamily):
689 def __init__(self, file_name):
692 delattr(self, "c_name")
693 self.op_prefix = None
694 delattr(self, "op_prefix")
695 self.async_op_prefix = None
696 delattr(self, "async_op_prefix")
698 delattr(self, "mcgrps")
700 delattr(self, "consts")
702 delattr(self, "hooks")
704 super().__init__(file_name)
706 self.fam_key = c_upper(self.yaml.get('c-family-name', self.yaml["name"] + '_FAMILY_NAME'))
707 self.ver_key = c_upper(self.yaml.get('c-version-name', self.yaml["name"] + '_FAMILY_VERSION'))
709 if 'definitions' not in self.yaml:
710 self.yaml['definitions'] = []
712 if 'uapi-header' in self.yaml:
713 self.uapi_header = self.yaml['uapi-header']
715 self.uapi_header = f"linux/{self.name}.h"
718 self.resolve_up(super())
720 if self.yaml.get('protocol', 'genetlink') not in {'genetlink', 'genetlink-c', 'genetlink-legacy'}:
721 raise Exception("Codegen only supported for genetlink")
723 self.c_name = c_lower(self.name)
724 if 'name-prefix' in self.yaml['operations']:
725 self.op_prefix = c_upper(self.yaml['operations']['name-prefix'])
727 self.op_prefix = c_upper(self.yaml['name'] + '-cmd-')
728 if 'async-prefix' in self.yaml['operations']:
729 self.async_op_prefix = c_upper(self.yaml['operations']['async-prefix'])
731 self.async_op_prefix = self.op_prefix
733 self.mcgrps = self.yaml.get('mcast-groups', {'list': []})
736 for when in ['pre', 'post']:
737 self.hooks[when] = dict()
738 for op_mode in ['do', 'dump']:
739 self.hooks[when][op_mode] = dict()
740 self.hooks[when][op_mode]['set'] = set()
741 self.hooks[when][op_mode]['list'] = []
743 # dict space-name -> 'request': set(attrs), 'reply': set(attrs)
744 self.root_sets = dict()
745 # dict space-name -> set('request', 'reply')
746 self.pure_nested_structs = dict()
747 self.all_notify = dict()
749 self._mock_up_events()
752 self._load_root_sets()
753 self._load_nested_sets()
754 self._load_all_notify()
757 self.kernel_policy = self.yaml.get('kernel-policy', 'split')
758 if self.kernel_policy == 'global':
759 self._load_global_policy()
761 def new_enum(self, elem):
762 return EnumSet(self, elem)
764 def new_attr_set(self, elem):
765 return AttrSet(self, elem)
767 def new_operation(self, elem, req_value, rsp_value):
768 return Operation(self, elem, req_value, rsp_value)
770 # Fake a 'do' equivalent of all events, so that we can render their response parsing
771 def _mock_up_events(self):
772 for op in self.yaml['operations']['list']:
776 'attributes': op['event']['attributes']
782 for msg in self.msgs.values():
786 self.ops[n['notify']].add_notification(n)
788 def _load_root_sets(self):
789 for op_name, op in self.ops.items():
790 if 'attribute-set' not in op:
795 for op_mode in ['do', 'dump']:
796 if op_mode in op and 'request' in op[op_mode]:
797 req_attrs.update(set(op[op_mode]['request']['attributes']))
798 if op_mode in op and 'reply' in op[op_mode]:
799 rsp_attrs.update(set(op[op_mode]['reply']['attributes']))
801 if op['attribute-set'] not in self.root_sets:
802 self.root_sets[op['attribute-set']] = {'request': req_attrs, 'reply': rsp_attrs}
804 self.root_sets[op['attribute-set']]['request'].update(req_attrs)
805 self.root_sets[op['attribute-set']]['reply'].update(rsp_attrs)
807 def _load_nested_sets(self):
808 for root_set, rs_members in self.root_sets.items():
809 for attr, spec in self.attr_sets[root_set].items():
810 if 'nested-attributes' in spec:
812 nested = spec['nested-attributes']
813 if nested not in self.root_sets:
814 self.pure_nested_structs[nested] = Struct(self, nested, inherited=inherit)
815 if attr in rs_members['request']:
816 self.pure_nested_structs[nested].request = True
817 if attr in rs_members['reply']:
818 self.pure_nested_structs[nested].reply = True
820 if 'type-value' in spec:
821 if nested in self.root_sets:
822 raise Exception("Inheriting members to a space used as root not supported")
823 inherit.update(set(spec['type-value']))
824 elif spec['type'] == 'array-nest':
826 self.pure_nested_structs[nested].set_inherited(inherit)
828 def _load_all_notify(self):
829 for op_name, op in self.ops.items():
834 self.all_notify[op_name] = op['notify']['cmds']
836 def _load_global_policy(self):
839 for op_name, op in self.ops.items():
842 if 'attribute-set' not in op:
845 if attr_set_name is None:
846 attr_set_name = op['attribute-set']
847 if attr_set_name != op['attribute-set']:
848 raise Exception('For a global policy all ops must use the same set')
850 for op_mode in ['do', 'dump']:
852 global_set.update(op[op_mode].get('request', []))
854 self.global_policy = []
855 self.global_policy_set = attr_set_name
856 for attr in self.attr_sets[attr_set_name]:
857 if attr in global_set:
858 self.global_policy.append(attr)
860 def _load_hooks(self):
861 for op in self.ops.values():
862 for op_mode in ['do', 'dump']:
863 if op_mode not in op:
865 for when in ['pre', 'post']:
866 if when not in op[op_mode]:
868 name = op[op_mode][when]
869 if name in self.hooks[when][op_mode]['set']:
871 self.hooks[when][op_mode]['set'].add(name)
872 self.hooks[when][op_mode]['list'].append(name)
876 def __init__(self, cw, family, ku_space, op, op_name, op_mode, attr_set=None):
879 self.ku_space = ku_space
881 self.op_name = op_name
882 self.op_mode = op_mode
884 # 'do' and 'dump' response parsing is identical
885 if op_mode != 'do' and 'dump' in op and 'do' in op and 'reply' in op['do'] and \
886 op["do"]["reply"] == op["dump"]["reply"]:
887 self.type_consistent = True
889 self.type_consistent = op_mode == 'event'
891 self.attr_set = attr_set
892 if not self.attr_set:
893 self.attr_set = op['attribute-set']
896 self.type_name = c_lower(op_name)
898 self.type_name = c_lower(attr_set)
903 for op_dir in ['request', 'reply']:
904 if op and op_dir in op[op_mode]:
905 self.struct[op_dir] = Struct(family, self.attr_set,
906 type_list=op[op_mode][op_dir]['attributes'])
907 if op_mode == 'event':
908 self.struct['reply'] = Struct(family, self.attr_set, type_list=op['event']['attributes'])
912 def __init__(self, nlib, out_file):
916 self._silent_block = False
921 def _is_cond(cls, line):
922 return line.startswith('if') or line.startswith('while') or line.startswith('for')
924 def p(self, line, add_ind=0):
926 self._out.write('\n')
931 if self._silent_block:
933 self._silent_block = line.endswith(')') and CodeWriter._is_cond(line)
936 self._out.write('\t' * ind + line + '\n')
941 def block_start(self, line=''):
947 def block_end(self, line=''):
948 if line and line[0] not in {';', ','}:
953 def write_doc_line(self, doc, indent=True):
957 if len(line) + len(word) >= 79:
965 def write_func_prot(self, qual_ret, name, args=None, doc=None, suffix=''):
975 if qual_ret[-1] != '*':
977 oneline += f"{name}({', '.join(args)}){suffix}"
979 if len(oneline) < 80:
987 elif qual_ret[-1] != '*':
990 ind = '\t' * (len(v) // 8) + ' ' * (len(v) % 8)
991 delta_ind = len(v) - len(ind)
995 next_len = len(v) + len(args[i])
997 next_len += delta_ind
1005 self.p(v + ')' + suffix)
1007 def write_func_lvar(self, local_vars):
1011 if type(local_vars) is str:
1012 local_vars = [local_vars]
1014 local_vars.sort(key=len, reverse=True)
1015 for var in local_vars:
1019 def write_func(self, qual_ret, name, body, args=None, local_vars=None):
1020 self.write_func_prot(qual_ret=qual_ret, name=name, args=args)
1021 self.write_func_lvar(local_vars=local_vars)
1028 def writes_defines(self, defines):
1030 for define in defines:
1031 if len(define[0]) > longest:
1032 longest = len(define[0])
1033 longest = ((longest + 8) // 8) * 8
1034 for define in defines:
1035 line = '#define ' + define[0]
1036 line += '\t' * ((longest - len(define[0]) + 7) // 8)
1037 if type(define[1]) is int:
1038 line += str(define[1])
1039 elif type(define[1]) is str:
1040 line += '"' + define[1] + '"'
1043 def write_struct_init(self, members):
1044 longest = max([len(x[0]) for x in members])
1045 longest += 1 # because we prepend a .
1046 longest = ((longest + 8) // 8) * 8
1049 line += '\t' * ((longest - len(one[0]) - 1 + 7) // 8)
1050 line += '= ' + one[1] + ','
1054 scalars = {'u8', 'u16', 'u32', 'u64', 's32', 's64'}
1056 direction_to_suffix = {
1062 op_mode_to_wrapper = {
1074 def rdir(direction):
1075 if direction == 'reply':
1077 if direction == 'request':
1082 def op_prefix(ri, direction, deref=False):
1083 suffix = f"_{ri.type_name}"
1085 if not ri.op_mode or ri.op_mode == 'do':
1086 suffix += f"{direction_to_suffix[direction]}"
1088 if direction == 'request':
1089 suffix += '_req_dump'
1091 if ri.type_consistent:
1093 suffix += f"{direction_to_suffix[direction]}"
1095 suffix += op_mode_to_wrapper[ri.op_mode]
1098 suffix += '_dump' if deref else '_list'
1100 return f"{ri.family['name']}{suffix}"
1103 def type_name(ri, direction, deref=False):
1104 return f"struct {op_prefix(ri, direction, deref=deref)}"
1107 def print_prototype(ri, direction, terminate=True, doc=None):
1108 suffix = ';' if terminate else ''
1110 fname = ri.op.render_name
1111 if ri.op_mode == 'dump':
1114 args = ['struct ynl_sock *ys']
1115 if 'request' in ri.op[ri.op_mode]:
1116 args.append(f"{type_name(ri, direction)} *" + f"{direction_to_suffix[direction][1:]}")
1119 if 'reply' in ri.op[ri.op_mode]:
1120 ret = f"{type_name(ri, rdir(direction))} *"
1122 ri.cw.write_func_prot(ret, fname, args, doc=doc, suffix=suffix)
1125 def print_req_prototype(ri):
1126 print_prototype(ri, "request", doc=ri.op['doc'])
1129 def print_dump_prototype(ri):
1130 print_prototype(ri, "request")
1133 def put_typol_fwd(cw, struct):
1134 cw.p(f'extern struct ynl_policy_nest {struct.render_name}_nest;')
1137 def put_typol(cw, struct):
1138 type_max = struct.attr_set.max_name
1139 cw.block_start(line=f'struct ynl_policy_attr {struct.render_name}_policy[{type_max} + 1] =')
1141 for _, arg in struct.member_list():
1144 cw.block_end(line=';')
1147 cw.block_start(line=f'struct ynl_policy_nest {struct.render_name}_nest =')
1148 cw.p(f'.max_attr = {type_max},')
1149 cw.p(f'.table = {struct.render_name}_policy,')
1150 cw.block_end(line=';')
1154 def put_req_nested(ri, struct):
1155 func_args = ['struct nlmsghdr *nlh',
1156 'unsigned int attr_type',
1157 f'{struct.ptr_name}obj']
1159 ri.cw.write_func_prot('int', f'{struct.render_name}_put', func_args)
1161 ri.cw.write_func_lvar('struct nlattr *nest;')
1163 ri.cw.p("nest = mnl_attr_nest_start(nlh, attr_type);")
1165 for _, arg in struct.member_list():
1166 arg.attr_put(ri, "obj")
1168 ri.cw.p("mnl_attr_nest_end(nlh, nest);")
1171 ri.cw.p('return 0;')
1176 def _multi_parse(ri, struct, init_lines, local_vars):
1178 iter_line = "mnl_attr_for_each_nested(attr, nested)"
1180 iter_line = "mnl_attr_for_each(attr, nlh, sizeof(struct genlmsghdr))"
1185 for arg, aspec in struct.member_list():
1186 if aspec['type'] == 'array-nest':
1187 local_vars.append(f'const struct nlattr *attr_{aspec.c_name};')
1188 array_nests.add(arg)
1189 if 'multi-attr' in aspec:
1190 multi_attrs.add(arg)
1191 needs_parg |= 'nested-attributes' in aspec
1192 if array_nests or multi_attrs:
1193 local_vars.append('int i;')
1195 local_vars.append('struct ynl_parse_arg parg;')
1196 init_lines.append('parg.ys = yarg->ys;')
1199 ri.cw.write_func_lvar(local_vars)
1201 for line in init_lines:
1205 for arg in struct.inherited:
1206 ri.cw.p(f'dst->{arg} = {arg};')
1209 ri.cw.block_start(line=iter_line)
1212 for _, arg in struct.member_list():
1213 arg.attr_get(ri, 'dst', first=first)
1219 for anest in sorted(array_nests):
1220 aspec = struct[anest]
1222 ri.cw.block_start(line=f"if (dst->n_{aspec.c_name})")
1223 ri.cw.p(f"dst->{aspec.c_name} = calloc(dst->n_{aspec.c_name}, sizeof(*dst->{aspec.c_name}));")
1225 ri.cw.p(f"parg.rsp_policy = &{aspec.nested_render_name}_nest;")
1226 ri.cw.block_start(line=f"mnl_attr_for_each_nested(attr, attr_{aspec.c_name})")
1227 ri.cw.p(f"parg.data = &dst->{aspec.c_name}[i];")
1228 ri.cw.p(f"if ({aspec.nested_render_name}_parse(&parg, attr, mnl_attr_get_type(attr)))")
1229 ri.cw.p('return MNL_CB_ERROR;')
1235 for anest in sorted(multi_attrs):
1236 aspec = struct[anest]
1237 ri.cw.block_start(line=f"if (dst->n_{aspec.c_name})")
1238 ri.cw.p(f"dst->{aspec.c_name} = calloc(dst->n_{aspec.c_name}, sizeof(*dst->{aspec.c_name}));")
1240 if 'nested-attributes' in aspec:
1241 ri.cw.p(f"parg.rsp_policy = &{aspec.nested_render_name}_nest;")
1242 ri.cw.block_start(line=iter_line)
1243 ri.cw.block_start(line=f"if (mnl_attr_get_type(attr) == {aspec.enum_name})")
1244 if 'nested-attributes' in aspec:
1245 ri.cw.p(f"parg.data = &dst->{aspec.c_name}[i];")
1246 ri.cw.p(f"if ({aspec.nested_render_name}_parse(&parg, attr))")
1247 ri.cw.p('return MNL_CB_ERROR;')
1248 elif aspec['type'] in scalars:
1252 ri.cw.p(f"dst->{aspec.c_name}[i] = mnl_attr_get_{t}(attr);")
1254 raise Exception('Nest parsing type not supported yet')
1262 ri.cw.p('return 0;')
1264 ri.cw.p('return MNL_CB_OK;')
1269 def parse_rsp_nested(ri, struct):
1270 func_args = ['struct ynl_parse_arg *yarg',
1271 'const struct nlattr *nested']
1272 for arg in struct.inherited:
1273 func_args.append('__u32 ' + arg)
1275 local_vars = ['const struct nlattr *attr;',
1276 f'{struct.ptr_name}dst = yarg->data;']
1279 ri.cw.write_func_prot('int', f'{struct.render_name}_parse', func_args)
1281 _multi_parse(ri, struct, init_lines, local_vars)
1284 def parse_rsp_msg(ri, deref=False):
1285 if 'reply' not in ri.op[ri.op_mode] and ri.op_mode != 'event':
1288 func_args = ['const struct nlmsghdr *nlh',
1291 local_vars = [f'{type_name(ri, "reply", deref=deref)} *dst;',
1292 'struct ynl_parse_arg *yarg = data;',
1293 'const struct nlattr *attr;']
1294 init_lines = ['dst = yarg->data;']
1296 ri.cw.write_func_prot('int', f'{op_prefix(ri, "reply", deref=deref)}_parse', func_args)
1298 _multi_parse(ri, ri.struct["reply"], init_lines, local_vars)
1304 direction = "request"
1305 local_vars = ['struct nlmsghdr *nlh;',
1308 if 'reply' in ri.op[ri.op_mode]:
1311 local_vars += [f'{type_name(ri, rdir(direction))} *rsp;',
1312 'struct ynl_parse_arg yarg = { .ys = ys, };']
1314 print_prototype(ri, direction, terminate=False)
1316 ri.cw.write_func_lvar(local_vars)
1318 ri.cw.p(f"nlh = ynl_gemsg_start_req(ys, {ri.nl.get_family_id()}, {ri.op.enum_name}, 1);")
1320 ri.cw.p(f"ys->req_policy = &{ri.struct['request'].render_name}_nest;")
1321 if 'reply' in ri.op[ri.op_mode]:
1322 ri.cw.p(f"yarg.rsp_policy = &{ri.struct['reply'].render_name}_nest;")
1324 for _, attr in ri.struct["request"].member_list():
1325 attr.attr_put(ri, "req")
1328 ri.cw.p('err = mnl_socket_sendto(ys->sock, nlh, nlh->nlmsg_len);')
1329 ri.cw.p('if (err < 0)')
1330 ri.cw.p(f"return {ret_err};")
1332 ri.cw.p('len = mnl_socket_recvfrom(ys->sock, ys->rx_buf, MNL_SOCKET_BUFFER_SIZE);')
1333 ri.cw.p('if (len < 0)')
1334 ri.cw.p(f"return {ret_err};")
1337 if 'reply' in ri.op[ri.op_mode]:
1338 ri.cw.p('rsp = calloc(1, sizeof(*rsp));')
1339 ri.cw.p('yarg.data = rsp;')
1341 ri.cw.p(f"err = {ri.nl.parse_cb_run(op_prefix(ri, 'reply') + '_parse', '&yarg', False)};")
1342 ri.cw.p('if (err < 0)')
1343 ri.cw.p('goto err_free;')
1346 ri.cw.p('err = ynl_recv_ack(ys, err);')
1348 ri.cw.p('goto err_free;')
1350 ri.cw.p(f"return {ret_ok};")
1352 ri.cw.p('err_free:')
1354 if 'reply' in ri.op[ri.op_mode]:
1355 ri.cw.p(f"{call_free(ri, rdir(direction), 'rsp')}")
1356 ri.cw.p(f"return {ret_err};")
1361 direction = "request"
1362 print_prototype(ri, direction, terminate=False)
1364 local_vars = ['struct ynl_dump_state yds = {};',
1365 'struct nlmsghdr *nlh;',
1368 for var in local_vars:
1372 ri.cw.p('yds.ys = ys;')
1373 ri.cw.p(f"yds.alloc_sz = sizeof({type_name(ri, rdir(direction))});")
1374 ri.cw.p(f"yds.cb = {op_prefix(ri, 'reply', deref=True)}_parse;")
1375 ri.cw.p(f"yds.rsp_policy = &{ri.struct['reply'].render_name}_nest;")
1377 ri.cw.p(f"nlh = ynl_gemsg_start_dump(ys, {ri.nl.get_family_id()}, {ri.op.enum_name}, 1);")
1379 if "request" in ri.op[ri.op_mode]:
1380 ri.cw.p(f"ys->req_policy = &{ri.struct['request'].render_name}_nest;")
1382 for _, attr in ri.struct["request"].member_list():
1383 attr.attr_put(ri, "req")
1386 ri.cw.p('err = mnl_socket_sendto(ys->sock, nlh, nlh->nlmsg_len);')
1387 ri.cw.p('if (err < 0)')
1388 ri.cw.p('return NULL;')
1391 ri.cw.block_start(line='do')
1392 ri.cw.p('len = mnl_socket_recvfrom(ys->sock, ys->rx_buf, MNL_SOCKET_BUFFER_SIZE);')
1393 ri.cw.p('if (len < 0)')
1394 ri.cw.p('goto free_list;')
1396 ri.cw.p(f"err = {ri.nl.parse_cb_run('ynl_dump_trampoline', '&yds', False, indent=2)};")
1397 ri.cw.p('if (err < 0)')
1398 ri.cw.p('goto free_list;')
1399 ri.cw.block_end(line='while (err > 0);')
1402 ri.cw.p('return yds.first;')
1404 ri.cw.p('free_list:')
1405 ri.cw.p(call_free(ri, rdir(direction), 'yds.first'))
1406 ri.cw.p('return NULL;')
1410 def call_free(ri, direction, var):
1411 return f"{op_prefix(ri, direction)}_free({var});"
1414 def free_arg_name(direction):
1416 return direction_to_suffix[direction][1:]
1420 def print_free_prototype(ri, direction, suffix=';'):
1421 name = op_prefix(ri, direction)
1422 arg = free_arg_name(direction)
1423 ri.cw.write_func_prot('void', f"{name}_free", [f"struct {name} *{arg}"], suffix=suffix)
1426 def _print_type(ri, direction, struct):
1427 suffix = f'_{ri.type_name}{direction_to_suffix[direction]}'
1429 if ri.op_mode == 'dump':
1432 ri.cw.block_start(line=f"struct {ri.family['name']}{suffix}")
1434 meta_started = False
1435 for _, attr in struct.member_list():
1436 for type_filter in ['len', 'bit']:
1437 line = attr.presence_member(ri.ku_space, type_filter)
1439 if not meta_started:
1440 ri.cw.block_start(line=f"struct")
1444 ri.cw.block_end(line='_present;')
1447 for arg in struct.inherited:
1448 ri.cw.p(f"__u32 {arg};")
1450 for _, attr in struct.member_list():
1451 attr.struct_member(ri)
1453 ri.cw.block_end(line=';')
1457 def print_type(ri, direction):
1458 _print_type(ri, direction, ri.struct[direction])
1461 def print_type_full(ri, struct):
1462 _print_type(ri, "", struct)
1465 def print_type_helpers(ri, direction, deref=False):
1466 print_free_prototype(ri, direction)
1468 if ri.ku_space == 'user' and direction == 'request':
1469 for _, attr in ri.struct[direction].member_list():
1470 attr.setter(ri, ri.attr_set, direction, deref=deref)
1474 def print_req_type_helpers(ri):
1475 print_type_helpers(ri, "request")
1478 def print_rsp_type_helpers(ri):
1479 if 'reply' not in ri.op[ri.op_mode]:
1481 print_type_helpers(ri, "reply")
1484 def print_parse_prototype(ri, direction, terminate=True):
1485 suffix = "_rsp" if direction == "reply" else "_req"
1486 term = ';' if terminate else ''
1488 ri.cw.write_func_prot('void', f"{ri.op.render_name}{suffix}_parse",
1489 ['const struct nlattr **tb',
1490 f"struct {ri.op.render_name}{suffix} *req"],
1494 def print_req_type(ri):
1495 print_type(ri, "request")
1498 def print_rsp_type(ri):
1499 if (ri.op_mode == 'do' or ri.op_mode == 'dump') and 'reply' in ri.op[ri.op_mode]:
1501 elif ri.op_mode == 'event':
1505 print_type(ri, direction)
1508 def print_wrapped_type(ri):
1509 ri.cw.block_start(line=f"{type_name(ri, 'reply')}")
1510 if ri.op_mode == 'dump':
1511 ri.cw.p(f"{type_name(ri, 'reply')} *next;")
1512 elif ri.op_mode == 'notify' or ri.op_mode == 'event':
1513 ri.cw.p('__u16 family;')
1514 ri.cw.p('__u8 cmd;')
1515 ri.cw.p(f"void (*free)({type_name(ri, 'reply')} *ntf);")
1516 ri.cw.p(f"{type_name(ri, 'reply', deref=True)} obj __attribute__ ((aligned (8)));")
1517 ri.cw.block_end(line=';')
1519 print_free_prototype(ri, 'reply')
1523 def _free_type_members_iter(ri, struct):
1524 for _, attr in struct.member_list():
1525 if attr.free_needs_iter():
1526 ri.cw.p('unsigned int i;')
1531 def _free_type_members(ri, var, struct, ref=''):
1532 for _, attr in struct.member_list():
1533 attr.free(ri, var, ref)
1536 def _free_type(ri, direction, struct):
1537 var = free_arg_name(direction)
1539 print_free_prototype(ri, direction, suffix='')
1541 _free_type_members_iter(ri, struct)
1542 _free_type_members(ri, var, struct)
1544 ri.cw.p(f'free({var});')
1549 def free_rsp_nested(ri, struct):
1550 _free_type(ri, "", struct)
1553 def print_rsp_free(ri):
1554 if 'reply' not in ri.op[ri.op_mode]:
1556 _free_type(ri, 'reply', ri.struct['reply'])
1559 def print_dump_type_free(ri):
1560 sub_type = type_name(ri, 'reply')
1562 print_free_prototype(ri, 'reply', suffix='')
1564 ri.cw.p(f"{sub_type} *next = rsp;")
1566 ri.cw.block_start(line='while (next)')
1567 _free_type_members_iter(ri, ri.struct['reply'])
1568 ri.cw.p('rsp = next;')
1569 ri.cw.p('next = rsp->next;')
1572 _free_type_members(ri, 'rsp', ri.struct['reply'], ref='obj.')
1573 ri.cw.p(f'free(rsp);')
1579 def print_ntf_type_free(ri):
1580 print_free_prototype(ri, 'reply', suffix='')
1582 _free_type_members_iter(ri, ri.struct['reply'])
1583 _free_type_members(ri, 'rsp', ri.struct['reply'], ref='obj.')
1584 ri.cw.p(f'free(rsp);')
1589 def print_ntf_parse_prototype(family, cw, suffix=';'):
1590 cw.write_func_prot('struct ynl_ntf_base_type *', f"{family['name']}_ntf_parse",
1591 ['struct ynl_sock *ys'], suffix=suffix)
1594 def print_ntf_type_parse(family, cw, ku_mode):
1595 print_ntf_parse_prototype(family, cw, suffix='')
1597 cw.write_func_lvar(['struct genlmsghdr *genlh;',
1598 'struct nlmsghdr *nlh;',
1599 'struct ynl_parse_arg yarg = { .ys = ys, };',
1600 'struct ynl_ntf_base_type *rsp;',
1603 cw.p('len = mnl_socket_recvfrom(ys->sock, ys->rx_buf, MNL_SOCKET_BUFFER_SIZE);')
1604 cw.p('if (len < (ssize_t)(sizeof(*nlh) + sizeof(*genlh)))')
1605 cw.p('return NULL;')
1607 cw.p('nlh = (struct nlmsghdr *)ys->rx_buf;')
1608 cw.p('genlh = mnl_nlmsg_get_payload(nlh);')
1610 cw.block_start(line='switch (genlh->cmd)')
1611 for ntf_op in sorted(family.all_notify.keys()):
1612 op = family.ops[ntf_op]
1613 ri = RenderInfo(cw, family, ku_mode, op, ntf_op, "notify")
1614 for ntf in op['notify']['cmds']:
1615 cw.p(f"case {ntf.enum_name}:")
1616 cw.p(f"rsp = calloc(1, sizeof({type_name(ri, 'notify')}));")
1617 cw.p(f"parse = {op_prefix(ri, 'reply', deref=True)}_parse;")
1618 cw.p(f"yarg.rsp_policy = &{ri.struct['reply'].render_name}_nest;")
1619 cw.p(f"rsp->free = (void *){op_prefix(ri, 'notify')}_free;")
1621 for op_name, op in family.ops.items():
1622 if 'event' not in op:
1624 ri = RenderInfo(cw, family, ku_mode, op, op_name, "event")
1625 cw.p(f"case {op.enum_name}:")
1626 cw.p(f"rsp = calloc(1, sizeof({type_name(ri, 'event')}));")
1627 cw.p(f"parse = {op_prefix(ri, 'reply', deref=True)}_parse;")
1628 cw.p(f"yarg.rsp_policy = &{ri.struct['reply'].render_name}_nest;")
1629 cw.p(f"rsp->free = (void *){op_prefix(ri, 'notify')}_free;")
1632 cw.p('ynl_error_unknown_notification(ys, genlh->cmd);')
1633 cw.p('return NULL;')
1636 cw.p('yarg.data = rsp->data;')
1638 cw.p(f"err = {cw.nlib.parse_cb_run('parse', '&yarg', True)};")
1639 cw.p('if (err < 0)')
1640 cw.p('goto err_free;')
1642 cw.p('rsp->family = nlh->nlmsg_type;')
1643 cw.p('rsp->cmd = genlh->cmd;')
1648 cw.p('return NULL;')
1653 def print_req_policy_fwd(cw, struct, ri=None, terminate=True):
1654 if terminate and ri and kernel_can_gen_family_struct(struct.family):
1660 if kernel_can_gen_family_struct(struct.family) and ri:
1665 suffix = ';' if terminate else ' = {'
1667 max_attr = struct.attr_max_val
1669 name = ri.op.render_name
1670 if ri.op.dual_policy:
1671 name += '_' + ri.op_mode
1673 name = struct.render_name
1674 cw.p(f"{prefix}const struct nla_policy {name}_nl_policy[{max_attr.enum_name} + 1]{suffix}")
1677 def print_req_policy(cw, struct, ri=None):
1678 print_req_policy_fwd(cw, struct, ri=ri, terminate=False)
1679 for _, arg in struct.member_list():
1684 def kernel_can_gen_family_struct(family):
1685 return family.proto == 'genetlink'
1688 def print_kernel_op_table_fwd(family, cw, terminate):
1689 exported = not kernel_can_gen_family_struct(family)
1691 if not terminate or exported:
1692 cw.p(f"/* Ops table for {family.name} */")
1694 pol_to_struct = {'global': 'genl_small_ops',
1695 'per-op': 'genl_ops',
1696 'split': 'genl_split_ops'}
1697 struct_type = pol_to_struct[family.kernel_policy]
1699 if family.kernel_policy == 'split':
1701 for op in family.ops.values():
1707 cnt = len(family.ops)
1709 qual = 'static const' if not exported else 'const'
1710 line = f"{qual} struct {struct_type} {family.name}_nl_ops[{cnt}]"
1712 cw.p(f"extern {line};")
1714 cw.block_start(line=line + ' =')
1720 for name in family.hooks['pre']['do']['list']:
1721 cw.write_func_prot('int', c_lower(name),
1722 ['const struct genl_split_ops *ops',
1723 'struct sk_buff *skb', 'struct genl_info *info'], suffix=';')
1724 for name in family.hooks['post']['do']['list']:
1725 cw.write_func_prot('void', c_lower(name),
1726 ['const struct genl_split_ops *ops',
1727 'struct sk_buff *skb', 'struct genl_info *info'], suffix=';')
1728 for name in family.hooks['pre']['dump']['list']:
1729 cw.write_func_prot('int', c_lower(name),
1730 ['struct netlink_callback *cb'], suffix=';')
1731 for name in family.hooks['post']['dump']['list']:
1732 cw.write_func_prot('int', c_lower(name),
1733 ['struct netlink_callback *cb'], suffix=';')
1737 for op_name, op in family.ops.items():
1742 name = c_lower(f"{family.name}-nl-{op_name}-doit")
1743 cw.write_func_prot('int', name,
1744 ['struct sk_buff *skb', 'struct genl_info *info'], suffix=';')
1747 name = c_lower(f"{family.name}-nl-{op_name}-dumpit")
1748 cw.write_func_prot('int', name,
1749 ['struct sk_buff *skb', 'struct netlink_callback *cb'], suffix=';')
1753 def print_kernel_op_table_hdr(family, cw):
1754 print_kernel_op_table_fwd(family, cw, terminate=True)
1757 def print_kernel_op_table(family, cw):
1758 print_kernel_op_table_fwd(family, cw, terminate=False)
1759 if family.kernel_policy == 'global' or family.kernel_policy == 'per-op':
1760 for op_name, op in family.ops.items():
1765 members = [('cmd', op.enum_name)]
1766 if 'dont-validate' in op:
1767 members.append(('validate',
1768 ' | '.join([c_upper('genl-dont-validate-' + x)
1769 for x in op['dont-validate']])), )
1770 for op_mode in ['do', 'dump']:
1772 name = c_lower(f"{family.name}-nl-{op_name}-{op_mode}it")
1773 members.append((op_mode + 'it', name))
1774 if family.kernel_policy == 'per-op':
1775 struct = Struct(family, op['attribute-set'],
1776 type_list=op['do']['request']['attributes'])
1778 name = c_lower(f"{family.name}-{op_name}-nl-policy")
1779 members.append(('policy', name))
1780 members.append(('maxattr', struct.attr_max_val.enum_name))
1782 members.append(('flags', ' | '.join([c_upper('genl-' + x) for x in op['flags']])))
1783 cw.write_struct_init(members)
1784 cw.block_end(line=',')
1785 elif family.kernel_policy == 'split':
1786 cb_names = {'do': {'pre': 'pre_doit', 'post': 'post_doit'},
1787 'dump': {'pre': 'start', 'post': 'done'}}
1789 for op_name, op in family.ops.items():
1790 for op_mode in ['do', 'dump']:
1791 if op.is_async or op_mode not in op:
1795 members = [('cmd', op.enum_name)]
1796 if 'dont-validate' in op:
1797 members.append(('validate',
1798 ' | '.join([c_upper('genl-dont-validate-' + x)
1799 for x in op['dont-validate']])), )
1800 name = c_lower(f"{family.name}-nl-{op_name}-{op_mode}it")
1801 if 'pre' in op[op_mode]:
1802 members.append((cb_names[op_mode]['pre'], c_lower(op[op_mode]['pre'])))
1803 members.append((op_mode + 'it', name))
1804 if 'post' in op[op_mode]:
1805 members.append((cb_names[op_mode]['post'], c_lower(op[op_mode]['post'])))
1806 if 'request' in op[op_mode]:
1807 struct = Struct(family, op['attribute-set'],
1808 type_list=op[op_mode]['request']['attributes'])
1811 name = c_lower(f"{family.name}-{op_name}-{op_mode}-nl-policy")
1813 name = c_lower(f"{family.name}-{op_name}-nl-policy")
1814 members.append(('policy', name))
1815 members.append(('maxattr', struct.attr_max_val.enum_name))
1816 flags = (op['flags'] if 'flags' in op else []) + ['cmd-cap-' + op_mode]
1817 members.append(('flags', ' | '.join([c_upper('genl-' + x) for x in flags])))
1818 cw.write_struct_init(members)
1819 cw.block_end(line=',')
1821 cw.block_end(line=';')
1825 def print_kernel_mcgrp_hdr(family, cw):
1826 if not family.mcgrps['list']:
1829 cw.block_start('enum')
1830 for grp in family.mcgrps['list']:
1831 grp_id = c_upper(f"{family.name}-nlgrp-{grp['name']},")
1837 def print_kernel_mcgrp_src(family, cw):
1838 if not family.mcgrps['list']:
1841 cw.block_start('static const struct genl_multicast_group ' + family.name + '_nl_mcgrps[] =')
1842 for grp in family.mcgrps['list']:
1844 grp_id = c_upper(f"{family.name}-nlgrp-{name}")
1845 cw.p('[' + grp_id + '] = { "' + name + '", },')
1850 def print_kernel_family_struct_hdr(family, cw):
1851 if not kernel_can_gen_family_struct(family):
1854 cw.p(f"extern struct genl_family {family.name}_nl_family;")
1858 def print_kernel_family_struct_src(family, cw):
1859 if not kernel_can_gen_family_struct(family):
1862 cw.block_start(f"struct genl_family {family.name}_nl_family __ro_after_init =")
1863 cw.p('.name\t\t= ' + family.fam_key + ',')
1864 cw.p('.version\t= ' + family.ver_key + ',')
1865 cw.p('.netnsok\t= true,')
1866 cw.p('.parallel_ops\t= true,')
1867 cw.p('.module\t\t= THIS_MODULE,')
1868 if family.kernel_policy == 'per-op':
1869 cw.p(f'.ops\t\t= {family.name}_nl_ops,')
1870 cw.p(f'.n_ops\t\t= ARRAY_SIZE({family.name}_nl_ops),')
1871 elif family.kernel_policy == 'split':
1872 cw.p(f'.split_ops\t= {family.name}_nl_ops,')
1873 cw.p(f'.n_split_ops\t= ARRAY_SIZE({family.name}_nl_ops),')
1874 if family.mcgrps['list']:
1875 cw.p(f'.mcgrps\t\t= {family.name}_nl_mcgrps,')
1876 cw.p(f'.n_mcgrps\t= ARRAY_SIZE({family.name}_nl_mcgrps),')
1880 def uapi_enum_start(family, cw, obj, ckey='', enum_name='enum-name'):
1882 if enum_name in obj:
1884 start_line = 'enum ' + c_lower(obj[enum_name])
1885 elif ckey and ckey in obj:
1886 start_line = 'enum ' + family.name + '_' + c_lower(obj[ckey])
1887 cw.block_start(line=start_line)
1890 def render_uapi(family, cw):
1891 hdr_prot = f"_UAPI_LINUX_{family.name.upper()}_H"
1892 cw.p('#ifndef ' + hdr_prot)
1893 cw.p('#define ' + hdr_prot)
1896 defines = [(family.fam_key, family["name"]),
1897 (family.ver_key, family.get('version', 1))]
1898 cw.writes_defines(defines)
1902 for const in family['definitions']:
1903 if const['type'] != 'const':
1904 cw.writes_defines(defines)
1908 # Write kdoc for enum and flags (one day maybe also structs)
1909 if const['type'] == 'enum' or const['type'] == 'flags':
1910 enum = family.consts[const['name']]
1916 doc = ' - ' + enum['doc']
1917 cw.write_doc_line(enum.enum_name + doc)
1918 for entry in enum.entries.values():
1920 doc = '@' + entry.c_name + ': ' + entry['doc']
1921 cw.write_doc_line(doc)
1924 uapi_enum_start(family, cw, const, 'name')
1925 name_pfx = const.get('name-prefix', f"{family.name}-{const['name']}-")
1926 for entry in enum.entries.values():
1928 if entry.value_change:
1929 suffix = f" = {entry.user_value()}" + suffix
1930 cw.p(entry.c_name + suffix)
1932 if const.get('render-max', False):
1934 max_name = c_upper(name_pfx + 'max')
1935 cw.p('__' + max_name + ',')
1936 cw.p(max_name + ' = (__' + max_name + ' - 1)')
1937 cw.block_end(line=';')
1939 elif const['type'] == 'const':
1940 defines.append([c_upper(family.get('c-define-name',
1941 f"{family.name}-{const['name']}")),
1945 cw.writes_defines(defines)
1948 max_by_define = family.get('max-by-define', False)
1950 for _, attr_set in family.attr_sets.items():
1951 if attr_set.subset_of:
1954 cnt_name = c_upper(family.get('attr-cnt-name', f"__{attr_set.name_prefix}MAX"))
1955 max_value = f"({cnt_name} - 1)"
1958 uapi_enum_start(family, cw, attr_set.yaml, 'enum-name')
1959 for _, attr in attr_set.items():
1961 if attr.value != val:
1962 suffix = f" = {attr.value},"
1965 cw.p(attr.enum_name + suffix)
1967 cw.p(cnt_name + ('' if max_by_define else ','))
1968 if not max_by_define:
1969 cw.p(f"{attr_set.max_name} = {max_value}")
1970 cw.block_end(line=';')
1972 cw.p(f"#define {attr_set.max_name} {max_value}")
1976 separate_ntf = 'async-prefix' in family['operations']
1978 max_name = c_upper(family.get('cmd-max-name', f"{family.op_prefix}MAX"))
1979 cnt_name = c_upper(family.get('cmd-cnt-name', f"__{family.op_prefix}MAX"))
1980 max_value = f"({cnt_name} - 1)"
1982 uapi_enum_start(family, cw, family['operations'], 'enum-name')
1984 for op in family.msgs.values():
1985 if separate_ntf and ('notify' in op or 'event' in op):
1990 suffix = f" = {op.value},"
1992 cw.p(op.enum_name + suffix)
1995 cw.p(cnt_name + ('' if max_by_define else ','))
1996 if not max_by_define:
1997 cw.p(f"{max_name} = {max_value}")
1998 cw.block_end(line=';')
2000 cw.p(f"#define {max_name} {max_value}")
2004 uapi_enum_start(family, cw, family['operations'], enum_name='async-enum')
2005 for op in family.msgs.values():
2006 if separate_ntf and not ('notify' in op or 'event' in op):
2011 suffix = f" = {op['value']},"
2012 cw.p(op.enum_name + suffix)
2013 cw.block_end(line=';')
2018 for grp in family.mcgrps['list']:
2020 defines.append([c_upper(grp.get('c-define-name', f"{family.name}-mcgrp-{name}")),
2024 cw.writes_defines(defines)
2027 cw.p(f'#endif /* {hdr_prot} */')
2030 def find_kernel_root(full_path):
2033 sub_path = os.path.join(os.path.basename(full_path), sub_path)
2034 full_path = os.path.dirname(full_path)
2035 maintainers = os.path.join(full_path, "MAINTAINERS")
2036 if os.path.exists(maintainers):
2037 return full_path, sub_path[:-1]
2041 parser = argparse.ArgumentParser(description='Netlink simple parsing generator')
2042 parser.add_argument('--mode', dest='mode', type=str, required=True)
2043 parser.add_argument('--spec', dest='spec', type=str, required=True)
2044 parser.add_argument('--header', dest='header', action='store_true', default=None)
2045 parser.add_argument('--source', dest='header', action='store_false')
2046 parser.add_argument('--user-header', nargs='+', default=[])
2047 parser.add_argument('-o', dest='out_file', type=str)
2048 args = parser.parse_args()
2050 out_file = open(args.out_file, 'w+') if args.out_file else os.sys.stdout
2052 if args.header is None:
2053 parser.error("--header or --source is required")
2056 parsed = Family(args.spec)
2057 except yaml.YAMLError as exc:
2062 cw = CodeWriter(BaseNlLib(), out_file)
2064 _, spec_kernel = find_kernel_root(args.spec)
2065 if args.mode == 'uapi':
2066 cw.p('/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause */')
2069 cw.p('/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */')
2071 cw.p('// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause')
2072 cw.p("/* Do not edit directly, auto-generated from: */")
2073 cw.p(f"/*\t{spec_kernel} */")
2074 cw.p(f"/* YNL-GEN {args.mode} {'header' if args.header else 'source'} */")
2077 if args.mode == 'uapi':
2078 render_uapi(parsed, cw)
2081 hdr_prot = f"_LINUX_{parsed.name.upper()}_GEN_H"
2083 cw.p('#ifndef ' + hdr_prot)
2084 cw.p('#define ' + hdr_prot)
2087 if args.mode == 'kernel':
2088 cw.p('#include <net/netlink.h>')
2089 cw.p('#include <net/genetlink.h>')
2093 cw.p(f'#include "{os.path.basename(args.out_file[:-2])}.h"')
2095 headers = [parsed.uapi_header]
2096 for definition in parsed['definitions']:
2097 if 'header' in definition:
2098 headers.append(definition['header'])
2100 cw.p(f"#include <{one}>")
2103 if args.mode == "user":
2105 cw.p("#include <stdlib.h>")
2106 cw.p("#include <stdio.h>")
2107 cw.p("#include <string.h>")
2108 cw.p("#include <libmnl/libmnl.h>")
2109 cw.p("#include <linux/genetlink.h>")
2111 for one in args.user_header:
2112 cw.p(f'#include "{one}"')
2114 cw.p('struct ynl_sock;')
2117 if args.mode == "kernel":
2119 for _, struct in sorted(parsed.pure_nested_structs.items()):
2121 cw.p('/* Common nested types */')
2123 for attr_set, struct in sorted(parsed.pure_nested_structs.items()):
2125 print_req_policy_fwd(cw, struct)
2128 if parsed.kernel_policy == 'global':
2129 cw.p(f"/* Global operation policy for {parsed.name} */")
2131 struct = Struct(parsed, parsed.global_policy_set, type_list=parsed.global_policy)
2132 print_req_policy_fwd(cw, struct)
2135 if parsed.kernel_policy in {'per-op', 'split'}:
2136 for op_name, op in parsed.ops.items():
2137 if 'do' in op and 'event' not in op:
2138 ri = RenderInfo(cw, parsed, args.mode, op, op_name, "do")
2139 print_req_policy_fwd(cw, ri.struct['request'], ri=ri)
2142 print_kernel_op_table_hdr(parsed, cw)
2143 print_kernel_mcgrp_hdr(parsed, cw)
2144 print_kernel_family_struct_hdr(parsed, cw)
2146 for _, struct in sorted(parsed.pure_nested_structs.items()):
2148 cw.p('/* Common nested types */')
2150 for attr_set, struct in sorted(parsed.pure_nested_structs.items()):
2152 print_req_policy(cw, struct)
2155 if parsed.kernel_policy == 'global':
2156 cw.p(f"/* Global operation policy for {parsed.name} */")
2158 struct = Struct(parsed, parsed.global_policy_set, type_list=parsed.global_policy)
2159 print_req_policy(cw, struct)
2162 for op_name, op in parsed.ops.items():
2163 if parsed.kernel_policy in {'per-op', 'split'}:
2164 for op_mode in ['do', 'dump']:
2165 if op_mode in op and 'request' in op[op_mode]:
2166 cw.p(f"/* {op.enum_name} - {op_mode} */")
2167 ri = RenderInfo(cw, parsed, args.mode, op, op_name, op_mode)
2168 print_req_policy(cw, ri.struct['request'], ri=ri)
2171 print_kernel_op_table(parsed, cw)
2172 print_kernel_mcgrp_src(parsed, cw)
2173 print_kernel_family_struct_src(parsed, cw)
2175 if args.mode == "user":
2178 cw.p('/* Common nested types */')
2179 for attr_set, struct in sorted(parsed.pure_nested_structs.items()):
2180 ri = RenderInfo(cw, parsed, args.mode, "", "", "", attr_set)
2181 print_type_full(ri, struct)
2183 for op_name, op in parsed.ops.items():
2184 cw.p(f"/* ============== {op.enum_name} ============== */")
2186 if 'do' in op and 'event' not in op:
2187 cw.p(f"/* {op.enum_name} - do */")
2188 ri = RenderInfo(cw, parsed, args.mode, op, op_name, "do")
2190 print_req_type_helpers(ri)
2193 print_rsp_type_helpers(ri)
2195 print_req_prototype(ri)
2199 cw.p(f"/* {op.enum_name} - dump */")
2200 ri = RenderInfo(cw, parsed, args.mode, op, op_name, 'dump')
2201 if 'request' in op['dump']:
2203 print_req_type_helpers(ri)
2204 if not ri.type_consistent:
2206 print_wrapped_type(ri)
2207 print_dump_prototype(ri)
2211 cw.p(f"/* {op.enum_name} - notify */")
2212 ri = RenderInfo(cw, parsed, args.mode, op, op_name, 'notify')
2214 if not ri.type_consistent:
2215 raise Exception('Only notifications with consistent types supported')
2216 print_wrapped_type(ri)
2219 ri = RenderInfo(cw, parsed, args.mode, op, op_name, 'event')
2220 cw.p(f"/* {op.enum_name} - event */")
2223 print_wrapped_type(ri)
2226 cw.p('/* --------------- Common notification parsing --------------- */')
2227 print_ntf_parse_prototype(parsed, cw)
2230 cw.p('/* Policies */')
2231 for name, _ in parsed.attr_sets.items():
2232 struct = Struct(parsed, name)
2233 put_typol_fwd(cw, struct)
2236 for name, _ in parsed.attr_sets.items():
2237 struct = Struct(parsed, name)
2238 put_typol(cw, struct)
2240 cw.p('/* Common nested types */')
2241 for attr_set, struct in sorted(parsed.pure_nested_structs.items()):
2242 ri = RenderInfo(cw, parsed, args.mode, "", "", "", attr_set)
2244 free_rsp_nested(ri, struct)
2246 put_req_nested(ri, struct)
2248 parse_rsp_nested(ri, struct)
2250 for op_name, op in parsed.ops.items():
2251 cw.p(f"/* ============== {op.enum_name} ============== */")
2252 if 'do' in op and 'event' not in op:
2253 cw.p(f"/* {op.enum_name} - do */")
2254 ri = RenderInfo(cw, parsed, args.mode, op, op_name, "do")
2261 cw.p(f"/* {op.enum_name} - dump */")
2262 ri = RenderInfo(cw, parsed, args.mode, op, op_name, "dump")
2263 if not ri.type_consistent:
2264 parse_rsp_msg(ri, deref=True)
2265 print_dump_type_free(ri)
2270 cw.p(f"/* {op.enum_name} - notify */")
2271 ri = RenderInfo(cw, parsed, args.mode, op, op_name, 'notify')
2273 if not ri.type_consistent:
2274 raise Exception('Only notifications with consistent types supported')
2275 print_ntf_type_free(ri)
2278 cw.p(f"/* {op.enum_name} - event */")
2281 ri = RenderInfo(cw, parsed, args.mode, op, op_name, "do")
2284 ri = RenderInfo(cw, parsed, args.mode, op, op_name, "event")
2285 print_ntf_type_free(ri)
2288 cw.p('/* --------------- Common notification parsing --------------- */')
2289 print_ntf_type_parse(parsed, cw, args.mode)
2292 cw.p(f'#endif /* {hdr_prot} */')
2295 if __name__ == "__main__":