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 | |
| 28 | ## |
| 29 | # @brief Process identifiers for updating of_g.identifiers |
| 30 | # |
| 31 | |
| 32 | import sys |
| 33 | import of_h_utils |
| 34 | from generic_utils import * |
| 35 | import of_g |
| 36 | |
| 37 | ## |
| 38 | # The value to use when an identifier is not defined for a version |
| 39 | UNDEFINED_IDENT_VALUE = 0 |
| 40 | |
| 41 | def add_identifiers(all_idents, idents_by_group, version, contents): |
| 42 | """ |
| 43 | Update all_idents with identifiers from an openflow.h header file |
| 44 | @param all_idents A dict, usually of_g.identifiers |
| 45 | @param idents_by_group A dict for mapping LOXI idents to groups, |
| 46 | usually of_g.identifiers_by_group |
| 47 | @param version The OF wire version |
| 48 | @param contents The contents of an openflow.h file |
| 49 | """ |
| 50 | |
| 51 | # Get the dictionary of enums from the file text |
| 52 | enum_dict = of_h_utils.get_enum_dict(version, |
| 53 | contents) |
| 54 | for name, info in enum_dict.items(): |
Rich Lane | ba7feb1 | 2013-04-08 14:07:00 -0700 | [diff] [blame] | 55 | add_identifier(name, info.ofp_name, info.ofp_group, info.value, |
| 56 | version, all_idents, idents_by_group) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 57 | |
Rich Lane | ba7feb1 | 2013-04-08 14:07:00 -0700 | [diff] [blame] | 58 | def add_identifier(name, ofp_name, ofp_group, value, version, all_idents, idents_by_group): |
| 59 | if name in all_idents: |
| 60 | all_idents[name]["values_by_version"][version] = value |
| 61 | if ((all_idents[name]["ofp_name"] != ofp_name or |
| 62 | all_idents[name]["ofp_group"] != ofp_group) and |
| 63 | ofp_name.find("OFPP_") != 0): |
| 64 | log(""" |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 65 | NOTE: Identifier %s has different ofp name or group in version %s |
| 66 | From ofp name %s, group %s to name %s, group %s. |
| 67 | This could indicate a name collision in LOXI identifier translation. |
| 68 | """ % (name, str(version), all_idents[name]["ofp_name"], |
Rich Lane | ba7feb1 | 2013-04-08 14:07:00 -0700 | [diff] [blame] | 69 | all_idents[name]["ofp_group"], ofp_name, ofp_group)) |
| 70 | # Update stuff assuming newer versions processed later |
| 71 | all_idents[name]["ofp_name"] = ofp_name |
| 72 | all_idents[name]["ofp_group"] = ofp_group |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 73 | |
Rich Lane | ba7feb1 | 2013-04-08 14:07:00 -0700 | [diff] [blame] | 74 | else: # New name |
| 75 | all_idents[name] = dict( |
| 76 | values_by_version = {version:value}, |
| 77 | common_value = value, |
| 78 | ofp_name = ofp_name, |
| 79 | ofp_group = ofp_group |
| 80 | ) |
| 81 | if ofp_group not in idents_by_group: |
| 82 | idents_by_group[ofp_group] = [] |
| 83 | if name not in idents_by_group[ofp_group]: |
| 84 | idents_by_group[ofp_group].append(name) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 85 | |
| 86 | def all_versions_agree(all_idents, version_list, name): |
| 87 | val_list = all_idents[name]["values_by_version"] |
| 88 | for version in version_list: |
| 89 | if not version in val_list: |
| 90 | return False |
| 91 | if str(val_list[version]) != str(all_idents[name]["common_value"]): |
| 92 | return False |
| 93 | return True |
| 94 | |
| 95 | def defined_versions_agree(all_idents, version_list, name): |
| 96 | val_list = all_idents[name]["values_by_version"] |
| 97 | for version in version_list: |
| 98 | if version in val_list: |
| 99 | if str(val_list[version]) != str(all_idents[name]["common_value"]): |
| 100 | return False |
| 101 | return True |