Rich Lane | 45dcae1 | 2013-06-04 13:07:41 -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 | import os |
Rich Lane | b014bcf | 2013-06-19 11:14:11 -0700 | [diff] [blame] | 29 | from collections import namedtuple |
Rich Lane | 45dcae1 | 2013-06-04 13:07:41 -0700 | [diff] [blame] | 30 | import loxi_utils.loxi_utils as utils |
Rich Lane | 96641df | 2013-06-10 13:36:35 -0700 | [diff] [blame] | 31 | import loxi_front_end |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 32 | import loxi_globals |
Rich Lane | 364e029 | 2013-10-01 21:05:57 -0700 | [diff] [blame] | 33 | from loxi_ir import * |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 34 | import field_info |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 35 | import template_utils |
Rich Lane | 45dcae1 | 2013-06-04 13:07:41 -0700 | [diff] [blame] | 36 | |
| 37 | templates_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'templates') |
| 38 | |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 39 | DissectorField = namedtuple("DissectorField", ["fullname", "name", "type", "base", "enum_table"]) |
Rich Lane | b014bcf | 2013-06-19 11:14:11 -0700 | [diff] [blame] | 40 | |
Rich Lane | 7708c18 | 2013-10-01 23:27:27 -0700 | [diff] [blame] | 41 | proto_names = { 1: 'of10', 2: 'of11', 3: 'of12', 4: 'of13' } |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 42 | def make_field_name(version, ofclass_name, member_name): |
| 43 | return "%s.%s.%s" % (proto_names[version.wire_version], |
Rich Lane | 7708c18 | 2013-10-01 23:27:27 -0700 | [diff] [blame] | 44 | ofclass_name[3:], |
| 45 | member_name) |
| 46 | |
Rich Lane | 7ff373a | 2013-10-25 14:18:04 -0700 | [diff] [blame] | 47 | def get_reader(version, cls, m): |
| 48 | """ |
| 49 | Decide on a reader function to use for the given field |
| 50 | """ |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 51 | ofproto = loxi_globals.ir[version] |
Rich Lane | 7ff373a | 2013-10-25 14:18:04 -0700 | [diff] [blame] | 52 | enum = ofproto.enum_by_name(m.oftype) |
| 53 | if enum and 'wire_type' in enum.params: |
| 54 | return "read_" + enum.params['wire_type'] |
| 55 | else: |
| 56 | return "read_" + m.oftype.replace(')', '').replace('(', '_') |
| 57 | |
Tomasz | cdfb36c | 2013-12-08 11:16:03 -0800 | [diff] [blame] | 58 | def get_peeker(version, cls, m): |
| 59 | """ |
| 60 | Decide on a peeker function to use for the given field |
| 61 | """ |
| 62 | ofproto = loxi_globals.ir[version] |
| 63 | enum = ofproto.enum_by_name(m.oftype) |
| 64 | if enum and 'wire_type' in enum.params: |
| 65 | return "peek_" + enum.params['wire_type'] |
| 66 | else: |
| 67 | return "peek_" + m.oftype.replace(')', '').replace('(', '_') |
| 68 | |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 69 | def get_field_info(version, cls, name, oftype): |
| 70 | """ |
| 71 | Decide on a Wireshark type and base for a given field. |
| 72 | |
| 73 | Returns (type, base) |
| 74 | """ |
| 75 | if oftype.startswith("list"): |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 76 | return "bytes", "NONE", "nil" |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 77 | |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 78 | ofproto = loxi_globals.ir[version] |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 79 | |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 80 | enum = ofproto.enum_by_name(oftype) |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 81 | if not enum and (cls, name) in field_info.class_field_to_enum: |
| 82 | enum_name = field_info.class_field_to_enum[(cls, name)] |
| 83 | enum = ofproto.enum_by_name(enum_name) |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 84 | |
| 85 | if enum: |
Rich Lane | 4df40f3 | 2013-10-08 15:40:39 -0700 | [diff] [blame] | 86 | field_type = "uint32" |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 87 | elif oftype in field_info.oftype_to_wireshark_type: |
| 88 | field_type = field_info.oftype_to_wireshark_type[oftype] |
| 89 | else: |
| 90 | print "WARN missing oftype_to_wireshark_type for", oftype |
Rich Lane | 4df40f3 | 2013-10-08 15:40:39 -0700 | [diff] [blame] | 91 | field_type = "bytes" |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 92 | |
| 93 | if enum: |
| 94 | if enum.is_bitmask: |
| 95 | field_base = "HEX" |
| 96 | else: |
| 97 | field_base = "DEC" |
| 98 | elif oftype in field_info.field_to_base: |
| 99 | field_base = field_info.field_to_base[name] |
| 100 | elif oftype in field_info.oftype_to_base: |
| 101 | field_base = field_info.oftype_to_base[oftype] |
| 102 | else: |
| 103 | print "WARN missing oftype_to_base for", oftype |
| 104 | field_base = "NONE" |
| 105 | |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 106 | if enum: |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 107 | enum_table = 'enum_v%d_%s' % (version.wire_version, enum.name) |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 108 | else: |
| 109 | enum_table = 'nil' |
| 110 | |
| 111 | return field_type, field_base, enum_table |
Rich Lane | 64585d9 | 2013-10-02 16:01:37 -0700 | [diff] [blame] | 112 | |
Rich Lane | b014bcf | 2013-06-19 11:14:11 -0700 | [diff] [blame] | 113 | def create_fields(): |
Rich Lane | 364e029 | 2013-10-01 21:05:57 -0700 | [diff] [blame] | 114 | r = [] |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 115 | for version, ofproto in loxi_globals.ir.items(): |
Rich Lane | 364e029 | 2013-10-01 21:05:57 -0700 | [diff] [blame] | 116 | for ofclass in ofproto.classes: |
| 117 | for m in ofclass.members: |
| 118 | if isinstance(m, OFPadMember): |
| 119 | continue |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 120 | fullname = make_field_name(version, ofclass.name, m.name) |
| 121 | field_type, field_base, enum_table = get_field_info(version, ofclass.name, m.name, m.oftype) |
Rich Lane | 5245266 | 2013-10-25 13:34:42 -0700 | [diff] [blame] | 122 | r.append(DissectorField(fullname, m.name, field_type, field_base, enum_table)) |
Rich Lane | 364e029 | 2013-10-01 21:05:57 -0700 | [diff] [blame] | 123 | |
| 124 | return r |
Rich Lane | b014bcf | 2013-06-19 11:14:11 -0700 | [diff] [blame] | 125 | |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 126 | def generate(install_dir): |
Rich Lane | b014bcf | 2013-06-19 11:14:11 -0700 | [diff] [blame] | 127 | context = { |
Rich Lane | b014bcf | 2013-06-19 11:14:11 -0700 | [diff] [blame] | 128 | 'fields': create_fields(), |
| 129 | } |
Rich Lane | 05fde26 | 2013-11-10 17:35:15 -0800 | [diff] [blame] | 130 | |
Rich Lane | 2353b52 | 2013-11-18 12:08:56 -0800 | [diff] [blame] | 131 | with template_utils.open_output(install_dir, 'wireshark/openflow.lua') as out: |
Andreas Wundsam | c2ce5fa | 2013-11-15 15:20:11 -0800 | [diff] [blame] | 132 | template_utils.render_template(out, "openflow.lua", [templates_dir], context) |