137d9df22SJakub Kicinski# SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause 23aacf828SJakub Kicinski 33aacf828SJakub Kicinskiimport collections 45c6674f6SJakub Kicinskiimport importlib 53aacf828SJakub Kicinskiimport os 63aacf828SJakub Kicinskiimport yaml 73aacf828SJakub Kicinski 83aacf828SJakub Kicinski 95c6674f6SJakub Kicinski# To be loaded dynamically as needed 105c6674f6SJakub Kicinskijsonschema = None 115c6674f6SJakub Kicinski 125c6674f6SJakub Kicinski 133aacf828SJakub Kicinskiclass SpecElement: 143aacf828SJakub Kicinski """Netlink spec element. 153aacf828SJakub Kicinski 163aacf828SJakub Kicinski Abstract element of the Netlink spec. Implements the dictionary interface 173aacf828SJakub Kicinski for access to the raw spec. Supports iterative resolution of dependencies 183aacf828SJakub Kicinski across elements and class inheritance levels. The elements of the spec 193aacf828SJakub Kicinski may refer to each other, and although loops should be very rare, having 203aacf828SJakub Kicinski to maintain correct ordering of instantiation is painful, so the resolve() 213aacf828SJakub Kicinski method should be used to perform parts of init which require access to 223aacf828SJakub Kicinski other parts of the spec. 233aacf828SJakub Kicinski 243aacf828SJakub Kicinski Attributes: 253aacf828SJakub Kicinski yaml raw spec as loaded from the spec file 263aacf828SJakub Kicinski family back reference to the full family 273aacf828SJakub Kicinski 283aacf828SJakub Kicinski name name of the entity as listed in the spec (optional) 293aacf828SJakub Kicinski ident_name name which can be safely used as identifier in code (optional) 303aacf828SJakub Kicinski """ 313aacf828SJakub Kicinski def __init__(self, family, yaml): 323aacf828SJakub Kicinski self.yaml = yaml 333aacf828SJakub Kicinski self.family = family 343aacf828SJakub Kicinski 353aacf828SJakub Kicinski if 'name' in self.yaml: 363aacf828SJakub Kicinski self.name = self.yaml['name'] 373aacf828SJakub Kicinski self.ident_name = self.name.replace('-', '_') 383aacf828SJakub Kicinski 393aacf828SJakub Kicinski self._super_resolved = False 403aacf828SJakub Kicinski family.add_unresolved(self) 413aacf828SJakub Kicinski 423aacf828SJakub Kicinski def __getitem__(self, key): 433aacf828SJakub Kicinski return self.yaml[key] 443aacf828SJakub Kicinski 453aacf828SJakub Kicinski def __contains__(self, key): 463aacf828SJakub Kicinski return key in self.yaml 473aacf828SJakub Kicinski 483aacf828SJakub Kicinski def get(self, key, default=None): 493aacf828SJakub Kicinski return self.yaml.get(key, default) 503aacf828SJakub Kicinski 513aacf828SJakub Kicinski def resolve_up(self, up): 523aacf828SJakub Kicinski if not self._super_resolved: 533aacf828SJakub Kicinski up.resolve() 543aacf828SJakub Kicinski self._super_resolved = True 553aacf828SJakub Kicinski 563aacf828SJakub Kicinski def resolve(self): 573aacf828SJakub Kicinski pass 583aacf828SJakub Kicinski 593aacf828SJakub Kicinski 606517a60bSJakub Kicinskiclass SpecEnumEntry(SpecElement): 616517a60bSJakub Kicinski """ Entry within an enum declared in the Netlink spec. 626517a60bSJakub Kicinski 636517a60bSJakub Kicinski Attributes: 646517a60bSJakub Kicinski doc documentation string 656517a60bSJakub Kicinski enum_set back reference to the enum 666517a60bSJakub Kicinski value numerical value of this enum (use accessors in most situations!) 676517a60bSJakub Kicinski 686517a60bSJakub Kicinski Methods: 696517a60bSJakub Kicinski raw_value raw value, i.e. the id in the enum, unlike user value which is a mask for flags 706517a60bSJakub Kicinski user_value user value, same as raw value for enums, for flags it's the mask 716517a60bSJakub Kicinski """ 726517a60bSJakub Kicinski def __init__(self, enum_set, yaml, prev, value_start): 736517a60bSJakub Kicinski if isinstance(yaml, str): 746517a60bSJakub Kicinski yaml = {'name': yaml} 756517a60bSJakub Kicinski super().__init__(enum_set.family, yaml) 766517a60bSJakub Kicinski 776517a60bSJakub Kicinski self.doc = yaml.get('doc', '') 786517a60bSJakub Kicinski self.enum_set = enum_set 796517a60bSJakub Kicinski 806517a60bSJakub Kicinski if 'value' in yaml: 816517a60bSJakub Kicinski self.value = yaml['value'] 826517a60bSJakub Kicinski elif prev: 836517a60bSJakub Kicinski self.value = prev.value + 1 846517a60bSJakub Kicinski else: 856517a60bSJakub Kicinski self.value = value_start 866517a60bSJakub Kicinski 876517a60bSJakub Kicinski def has_doc(self): 886517a60bSJakub Kicinski return bool(self.doc) 896517a60bSJakub Kicinski 906517a60bSJakub Kicinski def raw_value(self): 916517a60bSJakub Kicinski return self.value 926517a60bSJakub Kicinski 934c6170d1SJakub Kicinski def user_value(self, as_flags=None): 944c6170d1SJakub Kicinski if self.enum_set['type'] == 'flags' or as_flags: 956517a60bSJakub Kicinski return 1 << self.value 966517a60bSJakub Kicinski else: 976517a60bSJakub Kicinski return self.value 986517a60bSJakub Kicinski 996517a60bSJakub Kicinski 1006517a60bSJakub Kicinskiclass SpecEnumSet(SpecElement): 1016517a60bSJakub Kicinski """ Enum type 1026517a60bSJakub Kicinski 1036517a60bSJakub Kicinski Represents an enumeration (list of numerical constants) 1046517a60bSJakub Kicinski as declared in the "definitions" section of the spec. 1056517a60bSJakub Kicinski 1066517a60bSJakub Kicinski Attributes: 1076517a60bSJakub Kicinski type enum or flags 1086517a60bSJakub Kicinski entries entries by name 109c311aaa7SJakub Kicinski entries_by_val entries by value 1106517a60bSJakub Kicinski Methods: 1116517a60bSJakub Kicinski get_mask for flags compute the mask of all defined values 1126517a60bSJakub Kicinski """ 1136517a60bSJakub Kicinski def __init__(self, family, yaml): 1146517a60bSJakub Kicinski super().__init__(family, yaml) 1156517a60bSJakub Kicinski 1166517a60bSJakub Kicinski self.type = yaml['type'] 1176517a60bSJakub Kicinski 1186517a60bSJakub Kicinski prev_entry = None 1196517a60bSJakub Kicinski value_start = self.yaml.get('value-start', 0) 1206517a60bSJakub Kicinski self.entries = dict() 121c311aaa7SJakub Kicinski self.entries_by_val = dict() 1226517a60bSJakub Kicinski for entry in self.yaml['entries']: 1236517a60bSJakub Kicinski e = self.new_entry(entry, prev_entry, value_start) 1246517a60bSJakub Kicinski self.entries[e.name] = e 125c311aaa7SJakub Kicinski self.entries_by_val[e.raw_value()] = e 1266517a60bSJakub Kicinski prev_entry = e 1276517a60bSJakub Kicinski 1286517a60bSJakub Kicinski def new_entry(self, entry, prev_entry, value_start): 1296517a60bSJakub Kicinski return SpecEnumEntry(self, entry, prev_entry, value_start) 1306517a60bSJakub Kicinski 1316517a60bSJakub Kicinski def has_doc(self): 1326517a60bSJakub Kicinski if 'doc' in self.yaml: 1336517a60bSJakub Kicinski return True 1346517a60bSJakub Kicinski for entry in self.entries.values(): 1356517a60bSJakub Kicinski if entry.has_doc(): 1366517a60bSJakub Kicinski return True 1376517a60bSJakub Kicinski return False 1386517a60bSJakub Kicinski 1394c6170d1SJakub Kicinski def get_mask(self, as_flags=None): 1406517a60bSJakub Kicinski mask = 0 141bf51d277SLorenzo Bianconi for e in self.entries.values(): 1424c6170d1SJakub Kicinski mask += e.user_value(as_flags) 1436517a60bSJakub Kicinski return mask 1446517a60bSJakub Kicinski 1456517a60bSJakub Kicinski 1463aacf828SJakub Kicinskiclass SpecAttr(SpecElement): 1473aacf828SJakub Kicinski """ Single Netlink atttribute type 1483aacf828SJakub Kicinski 1493aacf828SJakub Kicinski Represents a single attribute type within an attr space. 1503aacf828SJakub Kicinski 1513aacf828SJakub Kicinski Attributes: 1523aacf828SJakub Kicinski value numerical ID when serialized 1533aacf828SJakub Kicinski attr_set Attribute Set containing this attr 154b423c3c8SDonald Hunter is_multi bool, attr may repeat multiple times 15526071913SDonald Hunter struct_name string, name of struct definition 156b423c3c8SDonald Hunter sub_type string, name of sub type 157d8eea68dSDonald Hunter len integer, optional byte length of binary types 158d8eea68dSDonald Hunter display_hint string, hint to help choose format specifier 159d8eea68dSDonald Hunter when displaying the value 1603aacf828SJakub Kicinski """ 1613aacf828SJakub Kicinski def __init__(self, family, attr_set, yaml, value): 1623aacf828SJakub Kicinski super().__init__(family, yaml) 1633aacf828SJakub Kicinski 1643aacf828SJakub Kicinski self.value = value 1653aacf828SJakub Kicinski self.attr_set = attr_set 1663aacf828SJakub Kicinski self.is_multi = yaml.get('multi-attr', False) 16726071913SDonald Hunter self.struct_name = yaml.get('struct') 168b423c3c8SDonald Hunter self.sub_type = yaml.get('sub-type') 1699f7cc57fSStanislav Fomichev self.byte_order = yaml.get('byte-order') 170d8eea68dSDonald Hunter self.len = yaml.get('len') 171d8eea68dSDonald Hunter self.display_hint = yaml.get('display-hint') 1723aacf828SJakub Kicinski 1733aacf828SJakub Kicinski 1743aacf828SJakub Kicinskiclass SpecAttrSet(SpecElement): 1753aacf828SJakub Kicinski """ Netlink Attribute Set class. 1763aacf828SJakub Kicinski 1773aacf828SJakub Kicinski Represents a ID space of attributes within Netlink. 1783aacf828SJakub Kicinski 1793aacf828SJakub Kicinski Note that unlike other elements, which expose contents of the raw spec 1803aacf828SJakub Kicinski via the dictionary interface Attribute Set exposes attributes by name. 1813aacf828SJakub Kicinski 1823aacf828SJakub Kicinski Attributes: 1833aacf828SJakub Kicinski attrs ordered dict of all attributes (indexed by name) 1843aacf828SJakub Kicinski attrs_by_val ordered dict of all attributes (indexed by value) 1853aacf828SJakub Kicinski subset_of parent set if this is a subset, otherwise None 1863aacf828SJakub Kicinski """ 1873aacf828SJakub Kicinski def __init__(self, family, yaml): 1883aacf828SJakub Kicinski super().__init__(family, yaml) 1893aacf828SJakub Kicinski 1903aacf828SJakub Kicinski self.subset_of = self.yaml.get('subset-of', None) 1913aacf828SJakub Kicinski 1923aacf828SJakub Kicinski self.attrs = collections.OrderedDict() 1933aacf828SJakub Kicinski self.attrs_by_val = collections.OrderedDict() 1943aacf828SJakub Kicinski 1957cf93538SJakub Kicinski if self.subset_of is None: 196ad4fafcdSJakub Kicinski val = 1 1973aacf828SJakub Kicinski for elem in self.yaml['attributes']: 1983aacf828SJakub Kicinski if 'value' in elem: 1993aacf828SJakub Kicinski val = elem['value'] 2003aacf828SJakub Kicinski 2013aacf828SJakub Kicinski attr = self.new_attr(elem, val) 2023aacf828SJakub Kicinski self.attrs[attr.name] = attr 2033aacf828SJakub Kicinski self.attrs_by_val[attr.value] = attr 2043aacf828SJakub Kicinski val += 1 2057cf93538SJakub Kicinski else: 2067cf93538SJakub Kicinski real_set = family.attr_sets[self.subset_of] 2077cf93538SJakub Kicinski for elem in self.yaml['attributes']: 2087cf93538SJakub Kicinski attr = real_set[elem['name']] 2097cf93538SJakub Kicinski self.attrs[attr.name] = attr 2107cf93538SJakub Kicinski self.attrs_by_val[attr.value] = attr 2113aacf828SJakub Kicinski 2123aacf828SJakub Kicinski def new_attr(self, elem, value): 2133aacf828SJakub Kicinski return SpecAttr(self.family, self, elem, value) 2143aacf828SJakub Kicinski 2153aacf828SJakub Kicinski def __getitem__(self, key): 2163aacf828SJakub Kicinski return self.attrs[key] 2173aacf828SJakub Kicinski 2183aacf828SJakub Kicinski def __contains__(self, key): 2193aacf828SJakub Kicinski return key in self.attrs 2203aacf828SJakub Kicinski 2213aacf828SJakub Kicinski def __iter__(self): 2223aacf828SJakub Kicinski yield from self.attrs 2233aacf828SJakub Kicinski 2243aacf828SJakub Kicinski def items(self): 2253aacf828SJakub Kicinski return self.attrs.items() 2263aacf828SJakub Kicinski 2273aacf828SJakub Kicinski 228bec0b7a2SDonald Hunterclass SpecStructMember(SpecElement): 229bec0b7a2SDonald Hunter """Struct member attribute 230bec0b7a2SDonald Hunter 231bec0b7a2SDonald Hunter Represents a single struct member attribute. 232bec0b7a2SDonald Hunter 233bec0b7a2SDonald Hunter Attributes: 234bec0b7a2SDonald Hunter type string, type of the member attribute 235bddd2e56SDonald Hunter byte_order string or None for native byte order 236313a7a80SDonald Hunter enum string, name of the enum definition 237d8eea68dSDonald Hunter len integer, optional byte length of binary types 238d8eea68dSDonald Hunter display_hint string, hint to help choose format specifier 239d8eea68dSDonald Hunter when displaying the value 240bec0b7a2SDonald Hunter """ 241bec0b7a2SDonald Hunter def __init__(self, family, yaml): 242bec0b7a2SDonald Hunter super().__init__(family, yaml) 243bec0b7a2SDonald Hunter self.type = yaml['type'] 244bddd2e56SDonald Hunter self.byte_order = yaml.get('byte-order') 245313a7a80SDonald Hunter self.enum = yaml.get('enum') 246d8eea68dSDonald Hunter self.len = yaml.get('len') 247d8eea68dSDonald Hunter self.display_hint = yaml.get('display-hint') 248bec0b7a2SDonald Hunter 249bec0b7a2SDonald Hunter 250bec0b7a2SDonald Hunterclass SpecStruct(SpecElement): 251bec0b7a2SDonald Hunter """Netlink struct type 252bec0b7a2SDonald Hunter 253bec0b7a2SDonald Hunter Represents a C struct definition. 254bec0b7a2SDonald Hunter 255bec0b7a2SDonald Hunter Attributes: 256bec0b7a2SDonald Hunter members ordered list of struct members 257bec0b7a2SDonald Hunter """ 258bec0b7a2SDonald Hunter def __init__(self, family, yaml): 259bec0b7a2SDonald Hunter super().__init__(family, yaml) 260bec0b7a2SDonald Hunter 261bec0b7a2SDonald Hunter self.members = [] 262bec0b7a2SDonald Hunter for member in yaml.get('members', []): 263bec0b7a2SDonald Hunter self.members.append(self.new_member(family, member)) 264bec0b7a2SDonald Hunter 265bec0b7a2SDonald Hunter def new_member(self, family, elem): 266bec0b7a2SDonald Hunter return SpecStructMember(family, elem) 267bec0b7a2SDonald Hunter 268bec0b7a2SDonald Hunter def __iter__(self): 269bec0b7a2SDonald Hunter yield from self.members 270bec0b7a2SDonald Hunter 271bec0b7a2SDonald Hunter def items(self): 272bec0b7a2SDonald Hunter return self.members.items() 273bec0b7a2SDonald Hunter 274bec0b7a2SDonald Hunter 2753aacf828SJakub Kicinskiclass SpecOperation(SpecElement): 2763aacf828SJakub Kicinski """Netlink Operation 2773aacf828SJakub Kicinski 2783aacf828SJakub Kicinski Information about a single Netlink operation. 2793aacf828SJakub Kicinski 2803aacf828SJakub Kicinski Attributes: 2813aacf828SJakub Kicinski value numerical ID when serialized, None if req/rsp values differ 2823aacf828SJakub Kicinski 2833aacf828SJakub Kicinski req_value numerical ID when serialized, user -> kernel 2843aacf828SJakub Kicinski rsp_value numerical ID when serialized, user <- kernel 2853aacf828SJakub Kicinski is_call bool, whether the operation is a call 2863aacf828SJakub Kicinski is_async bool, whether the operation is a notification 2873aacf828SJakub Kicinski is_resv bool, whether the operation does not exist (it's just a reserved ID) 2883aacf828SJakub Kicinski attr_set attribute set name 289f036d936SDonald Hunter fixed_header string, optional name of fixed header struct 2903aacf828SJakub Kicinski 2913aacf828SJakub Kicinski yaml raw spec as loaded from the spec file 2923aacf828SJakub Kicinski """ 2933aacf828SJakub Kicinski def __init__(self, family, yaml, req_value, rsp_value): 2943aacf828SJakub Kicinski super().__init__(family, yaml) 2953aacf828SJakub Kicinski 2963aacf828SJakub Kicinski self.value = req_value if req_value == rsp_value else None 2973aacf828SJakub Kicinski self.req_value = req_value 2983aacf828SJakub Kicinski self.rsp_value = rsp_value 2993aacf828SJakub Kicinski 3003aacf828SJakub Kicinski self.is_call = 'do' in yaml or 'dump' in yaml 3013aacf828SJakub Kicinski self.is_async = 'notify' in yaml or 'event' in yaml 3023aacf828SJakub Kicinski self.is_resv = not self.is_async and not self.is_call 303f036d936SDonald Hunter self.fixed_header = self.yaml.get('fixed-header', family.fixed_header) 3043aacf828SJakub Kicinski 3053aacf828SJakub Kicinski # Added by resolve: 3063aacf828SJakub Kicinski self.attr_set = None 3073aacf828SJakub Kicinski delattr(self, "attr_set") 3083aacf828SJakub Kicinski 3093aacf828SJakub Kicinski def resolve(self): 3103aacf828SJakub Kicinski self.resolve_up(super()) 3113aacf828SJakub Kicinski 3123aacf828SJakub Kicinski if 'attribute-set' in self.yaml: 3133aacf828SJakub Kicinski attr_set_name = self.yaml['attribute-set'] 3143aacf828SJakub Kicinski elif 'notify' in self.yaml: 3153aacf828SJakub Kicinski msg = self.family.msgs[self.yaml['notify']] 3163aacf828SJakub Kicinski attr_set_name = msg['attribute-set'] 3173aacf828SJakub Kicinski elif self.is_resv: 3183aacf828SJakub Kicinski attr_set_name = '' 3193aacf828SJakub Kicinski else: 3203aacf828SJakub Kicinski raise Exception(f"Can't resolve attribute set for op '{self.name}'") 3213aacf828SJakub Kicinski if attr_set_name: 3223aacf828SJakub Kicinski self.attr_set = self.family.attr_sets[attr_set_name] 3233aacf828SJakub Kicinski 3243aacf828SJakub Kicinski 325*88901b96SDonald Hunterclass SpecMcastGroup(SpecElement): 326*88901b96SDonald Hunter """Netlink Multicast Group 327*88901b96SDonald Hunter 328*88901b96SDonald Hunter Information about a multicast group. 329*88901b96SDonald Hunter 330*88901b96SDonald Hunter Value is only used for classic netlink families that use the 331*88901b96SDonald Hunter netlink-raw schema. Genetlink families use dynamic ID allocation 332*88901b96SDonald Hunter where the ids of multicast groups get resolved at runtime. Value 333*88901b96SDonald Hunter will be None for genetlink families. 334*88901b96SDonald Hunter 335*88901b96SDonald Hunter Attributes: 336*88901b96SDonald Hunter name name of the mulitcast group 337*88901b96SDonald Hunter value integer id of this multicast group for netlink-raw or None 338*88901b96SDonald Hunter yaml raw spec as loaded from the spec file 339*88901b96SDonald Hunter """ 340*88901b96SDonald Hunter def __init__(self, family, yaml): 341*88901b96SDonald Hunter super().__init__(family, yaml) 342*88901b96SDonald Hunter self.value = self.yaml.get('value') 343*88901b96SDonald Hunter 344*88901b96SDonald Hunter 3453aacf828SJakub Kicinskiclass SpecFamily(SpecElement): 3463aacf828SJakub Kicinski """ Netlink Family Spec class. 3473aacf828SJakub Kicinski 3483aacf828SJakub Kicinski Netlink family information loaded from a spec (e.g. in YAML). 3493aacf828SJakub Kicinski Takes care of unfolding implicit information which can be skipped 3503aacf828SJakub Kicinski in the spec itself for brevity. 3513aacf828SJakub Kicinski 3523aacf828SJakub Kicinski The class can be used like a dictionary to access the raw spec 3533aacf828SJakub Kicinski elements but that's usually a bad idea. 3543aacf828SJakub Kicinski 3553aacf828SJakub Kicinski Attributes: 3563aacf828SJakub Kicinski proto protocol type (e.g. genetlink) 357ff6db4b5SJakub Kicinski msg_id_model enum-model for operations (unified, directional etc.) 358cfab77c0SJakub Kicinski license spec license (loaded from an SPDX tag on the spec) 3593aacf828SJakub Kicinski 3603aacf828SJakub Kicinski attr_sets dict of attribute sets 3613aacf828SJakub Kicinski msgs dict of all messages (index by name) 3623aacf828SJakub Kicinski ops dict of all valid requests / responses 363ced15688SJakub Kicinski ntfs dict of all async events 3646517a60bSJakub Kicinski consts dict of all constants/enums 365f036d936SDonald Hunter fixed_header string, optional name of family default fixed header struct 366*88901b96SDonald Hunter mcast_groups dict of all multicast groups (index by name) 3673aacf828SJakub Kicinski """ 368008bcd68SJakub Kicinski def __init__(self, spec_path, schema_path=None, exclude_ops=None): 3693aacf828SJakub Kicinski with open(spec_path, "r") as stream: 370cfab77c0SJakub Kicinski prefix = '# SPDX-License-Identifier: ' 371cfab77c0SJakub Kicinski first = stream.readline().strip() 372cfab77c0SJakub Kicinski if not first.startswith(prefix): 373cfab77c0SJakub Kicinski raise Exception('SPDX license tag required in the spec') 374cfab77c0SJakub Kicinski self.license = first[len(prefix):] 375cfab77c0SJakub Kicinski 376cfab77c0SJakub Kicinski stream.seek(0) 3773aacf828SJakub Kicinski spec = yaml.safe_load(stream) 3783aacf828SJakub Kicinski 3793aacf828SJakub Kicinski self._resolution_list = [] 3803aacf828SJakub Kicinski 3813aacf828SJakub Kicinski super().__init__(self, spec) 3823aacf828SJakub Kicinski 383008bcd68SJakub Kicinski self._exclude_ops = exclude_ops if exclude_ops else [] 384008bcd68SJakub Kicinski 3853aacf828SJakub Kicinski self.proto = self.yaml.get('protocol', 'genetlink') 386ff6db4b5SJakub Kicinski self.msg_id_model = self.yaml['operations'].get('enum-model', 'unified') 3873aacf828SJakub Kicinski 3883aacf828SJakub Kicinski if schema_path is None: 3893aacf828SJakub Kicinski schema_path = os.path.dirname(os.path.dirname(spec_path)) + f'/{self.proto}.yaml' 3903aacf828SJakub Kicinski if schema_path: 3915c6674f6SJakub Kicinski global jsonschema 3925c6674f6SJakub Kicinski 3933aacf828SJakub Kicinski with open(schema_path, "r") as stream: 3943aacf828SJakub Kicinski schema = yaml.safe_load(stream) 3953aacf828SJakub Kicinski 3965c6674f6SJakub Kicinski if jsonschema is None: 3975c6674f6SJakub Kicinski jsonschema = importlib.import_module("jsonschema") 3985c6674f6SJakub Kicinski 3993aacf828SJakub Kicinski jsonschema.validate(self.yaml, schema) 4003aacf828SJakub Kicinski 4013aacf828SJakub Kicinski self.attr_sets = collections.OrderedDict() 4023aacf828SJakub Kicinski self.msgs = collections.OrderedDict() 4033aacf828SJakub Kicinski self.req_by_value = collections.OrderedDict() 4043aacf828SJakub Kicinski self.rsp_by_value = collections.OrderedDict() 4053aacf828SJakub Kicinski self.ops = collections.OrderedDict() 406ced15688SJakub Kicinski self.ntfs = collections.OrderedDict() 4076517a60bSJakub Kicinski self.consts = collections.OrderedDict() 408*88901b96SDonald Hunter self.mcast_groups = collections.OrderedDict() 4093aacf828SJakub Kicinski 4103aacf828SJakub Kicinski last_exception = None 4113aacf828SJakub Kicinski while len(self._resolution_list) > 0: 4123aacf828SJakub Kicinski resolved = [] 4133aacf828SJakub Kicinski unresolved = self._resolution_list 4143aacf828SJakub Kicinski self._resolution_list = [] 4153aacf828SJakub Kicinski 4163aacf828SJakub Kicinski for elem in unresolved: 4173aacf828SJakub Kicinski try: 4183aacf828SJakub Kicinski elem.resolve() 4193aacf828SJakub Kicinski except (KeyError, AttributeError) as e: 4203aacf828SJakub Kicinski self._resolution_list.append(elem) 4213aacf828SJakub Kicinski last_exception = e 4223aacf828SJakub Kicinski continue 4233aacf828SJakub Kicinski 4243aacf828SJakub Kicinski resolved.append(elem) 4253aacf828SJakub Kicinski 4263aacf828SJakub Kicinski if len(resolved) == 0: 427b9d3a3e4SJakub Kicinski raise last_exception 4283aacf828SJakub Kicinski 4296517a60bSJakub Kicinski def new_enum(self, elem): 4306517a60bSJakub Kicinski return SpecEnumSet(self, elem) 4316517a60bSJakub Kicinski 4323aacf828SJakub Kicinski def new_attr_set(self, elem): 4333aacf828SJakub Kicinski return SpecAttrSet(self, elem) 4343aacf828SJakub Kicinski 435bec0b7a2SDonald Hunter def new_struct(self, elem): 436bec0b7a2SDonald Hunter return SpecStruct(self, elem) 437bec0b7a2SDonald Hunter 4383aacf828SJakub Kicinski def new_operation(self, elem, req_val, rsp_val): 4393aacf828SJakub Kicinski return SpecOperation(self, elem, req_val, rsp_val) 4403aacf828SJakub Kicinski 441*88901b96SDonald Hunter def new_mcast_group(self, elem): 442*88901b96SDonald Hunter return SpecMcastGroup(self, elem) 443*88901b96SDonald Hunter 4443aacf828SJakub Kicinski def add_unresolved(self, elem): 4453aacf828SJakub Kicinski self._resolution_list.append(elem) 4463aacf828SJakub Kicinski 4473aacf828SJakub Kicinski def _dictify_ops_unified(self): 448f036d936SDonald Hunter self.fixed_header = self.yaml['operations'].get('fixed-header') 449ad4fafcdSJakub Kicinski val = 1 4503aacf828SJakub Kicinski for elem in self.yaml['operations']['list']: 4513aacf828SJakub Kicinski if 'value' in elem: 4523aacf828SJakub Kicinski val = elem['value'] 4533aacf828SJakub Kicinski 4543aacf828SJakub Kicinski op = self.new_operation(elem, val, val) 4553aacf828SJakub Kicinski val += 1 4563aacf828SJakub Kicinski 4573aacf828SJakub Kicinski self.msgs[op.name] = op 4583aacf828SJakub Kicinski 4593aacf828SJakub Kicinski def _dictify_ops_directional(self): 460f036d936SDonald Hunter self.fixed_header = self.yaml['operations'].get('fixed-header') 461ad4fafcdSJakub Kicinski req_val = rsp_val = 1 4623aacf828SJakub Kicinski for elem in self.yaml['operations']['list']: 4636da3424fSJakub Kicinski if 'notify' in elem or 'event' in elem: 4643aacf828SJakub Kicinski if 'value' in elem: 4653aacf828SJakub Kicinski rsp_val = elem['value'] 4663aacf828SJakub Kicinski req_val_next = req_val 4673aacf828SJakub Kicinski rsp_val_next = rsp_val + 1 4683aacf828SJakub Kicinski req_val = None 4693aacf828SJakub Kicinski elif 'do' in elem or 'dump' in elem: 4703aacf828SJakub Kicinski mode = elem['do'] if 'do' in elem else elem['dump'] 4713aacf828SJakub Kicinski 4723aacf828SJakub Kicinski v = mode.get('request', {}).get('value', None) 4733aacf828SJakub Kicinski if v: 4743aacf828SJakub Kicinski req_val = v 4753aacf828SJakub Kicinski v = mode.get('reply', {}).get('value', None) 4763aacf828SJakub Kicinski if v: 4773aacf828SJakub Kicinski rsp_val = v 4783aacf828SJakub Kicinski 4793aacf828SJakub Kicinski rsp_inc = 1 if 'reply' in mode else 0 4803aacf828SJakub Kicinski req_val_next = req_val + 1 4813aacf828SJakub Kicinski rsp_val_next = rsp_val + rsp_inc 4823aacf828SJakub Kicinski else: 4833aacf828SJakub Kicinski raise Exception("Can't parse directional ops") 4843aacf828SJakub Kicinski 4859858bfc2SJakub Kicinski if req_val == req_val_next: 4869858bfc2SJakub Kicinski req_val = None 4879858bfc2SJakub Kicinski if rsp_val == rsp_val_next: 4889858bfc2SJakub Kicinski rsp_val = None 489008bcd68SJakub Kicinski 490008bcd68SJakub Kicinski skip = False 491008bcd68SJakub Kicinski for exclude in self._exclude_ops: 492008bcd68SJakub Kicinski skip |= bool(exclude.match(elem['name'])) 493008bcd68SJakub Kicinski if not skip: 4943aacf828SJakub Kicinski op = self.new_operation(elem, req_val, rsp_val) 495008bcd68SJakub Kicinski 4963aacf828SJakub Kicinski req_val = req_val_next 4973aacf828SJakub Kicinski rsp_val = rsp_val_next 4983aacf828SJakub Kicinski 4993aacf828SJakub Kicinski self.msgs[op.name] = op 5003aacf828SJakub Kicinski 501f3d07b02SStanislav Fomichev def find_operation(self, name): 502f3d07b02SStanislav Fomichev """ 503f3d07b02SStanislav Fomichev For a given operation name, find and return operation spec. 504f3d07b02SStanislav Fomichev """ 505f3d07b02SStanislav Fomichev for op in self.yaml['operations']['list']: 506f3d07b02SStanislav Fomichev if name == op['name']: 507f3d07b02SStanislav Fomichev return op 508f3d07b02SStanislav Fomichev return None 509f3d07b02SStanislav Fomichev 5103aacf828SJakub Kicinski def resolve(self): 5113aacf828SJakub Kicinski self.resolve_up(super()) 5123aacf828SJakub Kicinski 513054abb51SJakub Kicinski definitions = self.yaml.get('definitions', []) 514054abb51SJakub Kicinski for elem in definitions: 5156517a60bSJakub Kicinski if elem['type'] == 'enum' or elem['type'] == 'flags': 5166517a60bSJakub Kicinski self.consts[elem['name']] = self.new_enum(elem) 517bec0b7a2SDonald Hunter elif elem['type'] == 'struct': 518bec0b7a2SDonald Hunter self.consts[elem['name']] = self.new_struct(elem) 5196517a60bSJakub Kicinski else: 5206517a60bSJakub Kicinski self.consts[elem['name']] = elem 5216517a60bSJakub Kicinski 5223aacf828SJakub Kicinski for elem in self.yaml['attribute-sets']: 5233aacf828SJakub Kicinski attr_set = self.new_attr_set(elem) 5243aacf828SJakub Kicinski self.attr_sets[elem['name']] = attr_set 5253aacf828SJakub Kicinski 526ff6db4b5SJakub Kicinski if self.msg_id_model == 'unified': 5273aacf828SJakub Kicinski self._dictify_ops_unified() 528ff6db4b5SJakub Kicinski elif self.msg_id_model == 'directional': 5293aacf828SJakub Kicinski self._dictify_ops_directional() 5303aacf828SJakub Kicinski 5313aacf828SJakub Kicinski for op in self.msgs.values(): 5323aacf828SJakub Kicinski if op.req_value is not None: 5333aacf828SJakub Kicinski self.req_by_value[op.req_value] = op 5343aacf828SJakub Kicinski if op.rsp_value is not None: 5353aacf828SJakub Kicinski self.rsp_by_value[op.rsp_value] = op 5363aacf828SJakub Kicinski if not op.is_async and 'attribute-set' in op: 5373aacf828SJakub Kicinski self.ops[op.name] = op 538ced15688SJakub Kicinski elif op.is_async: 539ced15688SJakub Kicinski self.ntfs[op.name] = op 540*88901b96SDonald Hunter 541*88901b96SDonald Hunter mcgs = self.yaml.get('mcast-groups') 542*88901b96SDonald Hunter if mcgs: 543*88901b96SDonald Hunter for elem in mcgs['list']: 544*88901b96SDonald Hunter mcg = self.new_mcast_group(elem) 545*88901b96SDonald Hunter self.mcast_groups[elem['name']] = mcg 546