Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1 | # Copyright 2013, Big Switch Networks, Inc. |
| 2 | # |
| 3 | # LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with |
| 4 | # the following special exception: |
| 5 | # |
| 6 | # LOXI Exception |
| 7 | # |
| 8 | # As a special exception to the terms of the EPL, you may distribute libraries |
| 9 | # generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided |
| 10 | # that copyright and licensing notices generated by LoxiGen are not altered or removed |
| 11 | # from the LoxiGen Libraries and the notice provided below is (i) included in |
| 12 | # the LoxiGen Libraries, if distributed in source code form and (ii) included in any |
| 13 | # documentation for the LoxiGen Libraries, if distributed in binary form. |
| 14 | # |
| 15 | # Notice: "Copyright 2013, Big Switch Networks, Inc. This library was generated by the LoxiGen Compiler." |
| 16 | # |
| 17 | # You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain |
| 18 | # a copy of the EPL at: |
| 19 | # |
| 20 | # http://www.eclipse.org/legal/epl-v10.html |
| 21 | # |
| 22 | # Unless required by applicable law or agreed to in writing, software |
| 23 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 24 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 25 | # EPL for the specific language governing permissions and limitations |
| 26 | # under the EPL. |
| 27 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 28 | from generic_utils import * |
Andreas Wundsam | 542a13c | 2013-11-15 13:28:55 -0800 | [diff] [blame] | 29 | import c_gen.loxi_utils_legacy as loxi_utils |
Rich Lane | 043a3d8 | 2013-12-10 10:57:30 -0800 | [diff] [blame] | 30 | import loxi_globals |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 31 | |
Rich Lane | 9145978 | 2014-10-12 10:59:53 -0700 | [diff] [blame] | 32 | inheritance_roots = [ |
| 33 | 'of_instruction', |
| 34 | 'of_instruction_id', |
| 35 | 'of_action', |
| 36 | 'of_action_id', |
| 37 | 'of_oxm', |
| 38 | 'of_queue_prop', |
| 39 | 'of_hello_elem', |
| 40 | 'of_table_feature_prop', |
| 41 | 'of_meter_band', |
| 42 | 'of_bsn_vport', |
| 43 | 'of_bsn_tlv', |
| 44 | ] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 45 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 46 | def class_is_virtual(cls): |
| 47 | """ |
| 48 | Returns True if cls is a virtual class |
| 49 | """ |
Harshmeet Singh | 19d566b | 2014-10-06 14:08:06 -0700 | [diff] [blame] | 50 | if cls.endswith("header"): |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 51 | return True |
| 52 | if loxi_utils.class_is_list(cls): |
| 53 | return True |
Rich Lane | 043a3d8 | 2013-12-10 10:57:30 -0800 | [diff] [blame] | 54 | return loxi_globals.unified.class_by_name(cls).virtual |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 55 | |
Rich Lane | 9145978 | 2014-10-12 10:59:53 -0700 | [diff] [blame] | 56 | # map from parent class name to set of subclass names |
Rich Lane | 6bb28dd | 2013-05-13 15:19:14 -0700 | [diff] [blame] | 57 | inheritance_map = dict() |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 58 | |
Rich Lane | 6bb28dd | 2013-05-13 15:19:14 -0700 | [diff] [blame] | 59 | def generate_maps(): |
Rich Lane | 9145978 | 2014-10-12 10:59:53 -0700 | [diff] [blame] | 60 | def inheritance_root(ofclass): |
| 61 | if not ofclass.superclass: |
| 62 | if ofclass.name in inheritance_roots: |
| 63 | return ofclass |
| 64 | else: |
| 65 | return None |
| 66 | else: |
| 67 | return inheritance_root(ofclass.superclass) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 68 | |
Rich Lane | 9145978 | 2014-10-12 10:59:53 -0700 | [diff] [blame] | 69 | for version, protocol in loxi_globals.ir.items(): |
| 70 | wire_version = version.wire_version |
| 71 | for ofclass in protocol.classes: |
| 72 | root = inheritance_root(ofclass) |
| 73 | if not root or root == ofclass: |
| 74 | continue |
Rich Lane | 6bb28dd | 2013-05-13 15:19:14 -0700 | [diff] [blame] | 75 | |
Rich Lane | 9145978 | 2014-10-12 10:59:53 -0700 | [diff] [blame] | 76 | assert ofclass.name.startswith(root.name + '_') |
| 77 | subcls = ofclass.name[len(root.name)+1:] |
| 78 | |
Rich Lane | 9145978 | 2014-10-12 10:59:53 -0700 | [diff] [blame] | 79 | if root.name not in inheritance_map: |
| 80 | inheritance_map[root.name] = set() |
| 81 | inheritance_map[root.name].add(subcls) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 82 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 83 | def sub_class_map(base_type, version): |
| 84 | """ |
| 85 | Returns an iterable object giving the instance nameys and subclass types |
| 86 | for the base_type, version values |
| 87 | """ |
| 88 | rv = [] |
| 89 | if base_type not in inheritance_map: |
| 90 | return rv |
| 91 | |
| 92 | for instance in inheritance_map[base_type]: |
| 93 | subcls = loxi_utils.instance_to_class(instance, base_type) |
| 94 | if not loxi_utils.class_in_version(subcls, version): |
| 95 | continue |
| 96 | rv.append((instance, subcls)) |
| 97 | |
| 98 | return rv |