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 | from collections import namedtuple |
Rich Lane | c268579 | 2013-04-30 14:08:33 -0700 | [diff] [blame] | 29 | import struct |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 30 | import of_g |
| 31 | import loxi_front_end.type_maps as type_maps |
| 32 | import loxi_utils.loxi_utils as utils |
| 33 | import util |
| 34 | import oftype |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 35 | from loxi_ir import * |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 36 | |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 37 | PyOFClass = namedtuple('PyOFClass', ['name', 'pyname', 'members', 'type_members', |
| 38 | 'min_length', 'is_fixed_length']) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 39 | |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 40 | # Return the name for the generated Python class |
| 41 | def generate_pyname(cls): |
| 42 | if utils.class_is_action(cls): |
| 43 | return cls[10:] |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 44 | elif utils.class_is_oxm(cls): |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 45 | return cls[7:] |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 46 | elif utils.class_is_meter_band(cls): |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 47 | return cls[14:] |
Rich Lane | e02314c | 2013-05-02 16:42:04 -0700 | [diff] [blame] | 48 | elif utils.class_is_instruction(cls): |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 49 | return cls[15:] |
| 50 | else: |
| 51 | return cls[3:] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 52 | |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 53 | # Create intermediate representation, extended from the LOXI IR |
| 54 | # HACK the oftype member attribute is replaced with an OFType instance |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 55 | def build_ofclasses(version): |
Rich Lane | b915bec | 2013-05-09 16:14:45 -0700 | [diff] [blame] | 56 | blacklist = ["of_experimenter", "of_action_experimenter"] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 57 | ofclasses = [] |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 58 | for ofclass in of_g.ir[version].classes: |
| 59 | cls = ofclass.name |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 60 | if type_maps.class_is_virtual(cls): |
| 61 | continue |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 62 | if cls in blacklist: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 63 | continue |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 64 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 65 | members = [] |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 66 | type_members = [] |
Rich Lane | 8ca3b77 | 2013-04-30 13:36:55 -0700 | [diff] [blame] | 67 | |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 68 | for m in ofclass.members: |
| 69 | if type(m) == OFTypeMember: |
| 70 | members.append(OFTypeMember( |
| 71 | name=m.name, |
| 72 | oftype=oftype.OFType(m.oftype, version), |
| 73 | value=m.value)) |
Rich Lane | 8ca3b77 | 2013-04-30 13:36:55 -0700 | [diff] [blame] | 74 | type_members.append(members[-1]) |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 75 | elif type(m) == OFLengthMember: |
| 76 | members.append(OFLengthMember( |
| 77 | name=m.name, |
| 78 | oftype=oftype.OFType(m.oftype, version))) |
| 79 | elif type(m) == OFFieldLengthMember: |
| 80 | members.append(OFFieldLengthMember( |
| 81 | name=m.name, |
| 82 | oftype=oftype.OFType(m.oftype, version), |
| 83 | field_name=m.field_name)) |
| 84 | elif type(m) == OFPadMember: |
| 85 | members.append(m) |
| 86 | elif type(m) == OFDataMember: |
| 87 | if utils.class_is_message(ofclass.name) and m.name == 'version': |
| 88 | # HACK move to frontend |
| 89 | members.append(OFTypeMember( |
| 90 | name=m.name, |
| 91 | oftype=oftype.OFType(m.oftype, version), |
| 92 | value=version)) |
| 93 | type_members.append(members[-1]) |
| 94 | else: |
| 95 | members.append(OFDataMember( |
| 96 | name=m.name, |
| 97 | oftype=oftype.OFType(m.oftype, version))) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 98 | |
| 99 | ofclasses.append( |
Rich Lane | 002e70c | 2013-05-09 17:08:16 -0700 | [diff] [blame] | 100 | PyOFClass(name=cls, |
| 101 | pyname=generate_pyname(cls), |
| 102 | members=members, |
| 103 | type_members=type_members, |
| 104 | min_length=of_g.base_length[(cls, version)], |
| 105 | is_fixed_length=(cls, version) in of_g.is_fixed_length)) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 106 | return ofclasses |
| 107 | |
| 108 | def generate_init(out, name, version): |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 109 | util.render_template(out, 'init.py', version=version) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 110 | |
| 111 | def generate_action(out, name, version): |
| 112 | ofclasses = [x for x in build_ofclasses(version) |
| 113 | if utils.class_is_action(x.name)] |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 114 | util.render_template(out, 'action.py', ofclasses=ofclasses, version=version) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 115 | |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 116 | def generate_oxm(out, name, version): |
| 117 | ofclasses = [x for x in build_ofclasses(version) |
| 118 | if utils.class_is_oxm(x.name)] |
| 119 | util.render_template(out, 'oxm.py', ofclasses=ofclasses, version=version) |
| 120 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 121 | def generate_common(out, name, version): |
| 122 | ofclasses = [x for x in build_ofclasses(version) |
| 123 | if not utils.class_is_message(x.name) |
| 124 | and not utils.class_is_action(x.name) |
Rich Lane | e02314c | 2013-05-02 16:42:04 -0700 | [diff] [blame] | 125 | and not utils.class_is_instruction(x.name) |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 126 | and not utils.class_is_meter_band(x.name) |
Rich Lane | ea69375 | 2013-03-18 11:05:45 -0700 | [diff] [blame] | 127 | and not utils.class_is_oxm(x.name) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 128 | and not utils.class_is_list(x.name)] |
Rich Lane | 3f07597 | 2013-03-15 22:56:29 -0700 | [diff] [blame] | 129 | util.render_template(out, 'common.py', ofclasses=ofclasses, version=version) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 130 | |
| 131 | def generate_const(out, name, version): |
Rich Lane | dffcf85 | 2013-05-10 10:40:46 -0700 | [diff] [blame] | 132 | util.render_template(out, 'const.py', version=version, |
| 133 | enums=of_g.ir[version].enums) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 134 | |
Rich Lane | e02314c | 2013-05-02 16:42:04 -0700 | [diff] [blame] | 135 | def generate_instruction(out, name, version): |
| 136 | ofclasses = [x for x in build_ofclasses(version) |
| 137 | if utils.class_is_instruction(x.name)] |
| 138 | util.render_template(out, 'instruction.py', ofclasses=ofclasses, version=version) |
| 139 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 140 | def generate_message(out, name, version): |
| 141 | ofclasses = [x for x in build_ofclasses(version) |
| 142 | if utils.class_is_message(x.name)] |
| 143 | util.render_template(out, 'message.py', ofclasses=ofclasses, version=version) |
| 144 | |
Rich Lane | d82c0a6 | 2013-05-02 15:40:35 -0700 | [diff] [blame] | 145 | def generate_meter_band(out, name, version): |
| 146 | ofclasses = [x for x in build_ofclasses(version) |
| 147 | if utils.class_is_meter_band(x.name)] |
| 148 | util.render_template(out, 'meter_band.py', ofclasses=ofclasses, version=version) |
| 149 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 150 | def generate_pp(out, name, version): |
| 151 | util.render_template(out, 'pp.py') |
| 152 | |
| 153 | def generate_util(out, name, version): |
Rich Lane | adb7983 | 2013-05-02 17:14:33 -0700 | [diff] [blame] | 154 | util.render_template(out, 'util.py', version=version) |