blob: a610f3f164afacefdb58b9e11b2af18ead88ee6a [file] [log] [blame]
Rich Lane45dcae12013-06-04 13:07:41 -07001# 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
28import os
Rich Laneb014bcf2013-06-19 11:14:11 -070029from collections import namedtuple
Rich Lane45dcae12013-06-04 13:07:41 -070030import loxi_utils.loxi_utils as utils
Rich Lane96641df2013-06-10 13:36:35 -070031import loxi_front_end
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -080032import loxi_globals
Rich Lane364e0292013-10-01 21:05:57 -070033from loxi_ir import *
Rich Lane64585d92013-10-02 16:01:37 -070034import field_info
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -080035import template_utils
Rich Lane45dcae12013-06-04 13:07:41 -070036
37templates_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'templates')
38
Rich Lane52452662013-10-25 13:34:42 -070039DissectorField = namedtuple("DissectorField", ["fullname", "name", "type", "base", "enum_table"])
Rich Laneb014bcf2013-06-19 11:14:11 -070040
Rich Lane7708c182013-10-01 23:27:27 -070041proto_names = { 1: 'of10', 2: 'of11', 3: 'of12', 4: 'of13' }
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -080042def make_field_name(version, ofclass_name, member_name):
43 return "%s.%s.%s" % (proto_names[version.wire_version],
Rich Lane7708c182013-10-01 23:27:27 -070044 ofclass_name[3:],
45 member_name)
46
Rich Lane7ff373a2013-10-25 14:18:04 -070047def get_reader(version, cls, m):
48 """
49 Decide on a reader function to use for the given field
50 """
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -080051 ofproto = loxi_globals.ir[version]
Rich Lane7ff373a2013-10-25 14:18:04 -070052 enum = ofproto.enum_by_name(m.oftype)
53 if enum and 'wire_type' in enum.params:
54 return "read_" + enum.params['wire_type']
tomaszklimczyk8d18d722014-01-19 23:17:05 -080055 elif (cls.name, m.name) in field_info.reader_overrides:
56 return field_info.reader_overrides[(cls.name, m.name)]
Rich Lane7ff373a2013-10-25 14:18:04 -070057 else:
58 return "read_" + m.oftype.replace(')', '').replace('(', '_')
59
Rich Lane64585d92013-10-02 16:01:37 -070060def get_field_info(version, cls, name, oftype):
61 """
62 Decide on a Wireshark type and base for a given field.
63
64 Returns (type, base)
65 """
66 if oftype.startswith("list"):
Rich Lane52452662013-10-25 13:34:42 -070067 return "bytes", "NONE", "nil"
Rich Lane64585d92013-10-02 16:01:37 -070068
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -080069 ofproto = loxi_globals.ir[version]
Rich Lane52452662013-10-25 13:34:42 -070070
Rich Lane64585d92013-10-02 16:01:37 -070071 enum = ofproto.enum_by_name(oftype)
Rich Lane52452662013-10-25 13:34:42 -070072 if not enum and (cls, name) in field_info.class_field_to_enum:
73 enum_name = field_info.class_field_to_enum[(cls, name)]
74 enum = ofproto.enum_by_name(enum_name)
Rich Lane64585d92013-10-02 16:01:37 -070075
76 if enum:
Rich Lane4df40f32013-10-08 15:40:39 -070077 field_type = "uint32"
Rich Lane64585d92013-10-02 16:01:37 -070078 elif oftype in field_info.oftype_to_wireshark_type:
79 field_type = field_info.oftype_to_wireshark_type[oftype]
80 else:
81 print "WARN missing oftype_to_wireshark_type for", oftype
Rich Lane4df40f32013-10-08 15:40:39 -070082 field_type = "bytes"
Rich Lane64585d92013-10-02 16:01:37 -070083
84 if enum:
85 if enum.is_bitmask:
86 field_base = "HEX"
87 else:
88 field_base = "DEC"
89 elif oftype in field_info.field_to_base:
90 field_base = field_info.field_to_base[name]
91 elif oftype in field_info.oftype_to_base:
92 field_base = field_info.oftype_to_base[oftype]
93 else:
94 print "WARN missing oftype_to_base for", oftype
95 field_base = "NONE"
96
Rich Lane52452662013-10-25 13:34:42 -070097 if enum:
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -080098 enum_table = 'enum_v%d_%s' % (version.wire_version, enum.name)
Rich Lane52452662013-10-25 13:34:42 -070099 else:
100 enum_table = 'nil'
101
102 return field_type, field_base, enum_table
Rich Lane64585d92013-10-02 16:01:37 -0700103
Rich Laneb014bcf2013-06-19 11:14:11 -0700104def create_fields():
Rich Lane364e0292013-10-01 21:05:57 -0700105 r = []
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -0800106 for version, ofproto in loxi_globals.ir.items():
Rich Lane364e0292013-10-01 21:05:57 -0700107 for ofclass in ofproto.classes:
108 for m in ofclass.members:
109 if isinstance(m, OFPadMember):
110 continue
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -0800111 fullname = make_field_name(version, ofclass.name, m.name)
112 field_type, field_base, enum_table = get_field_info(version, ofclass.name, m.name, m.oftype)
Rich Lane52452662013-10-25 13:34:42 -0700113 r.append(DissectorField(fullname, m.name, field_type, field_base, enum_table))
Rich Lane364e0292013-10-01 21:05:57 -0700114
115 return r
Rich Laneb014bcf2013-06-19 11:14:11 -0700116
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -0800117def generate(install_dir):
Rich Laneb014bcf2013-06-19 11:14:11 -0700118 context = {
Rich Laneb014bcf2013-06-19 11:14:11 -0700119 'fields': create_fields(),
120 }
Rich Lane05fde262013-11-10 17:35:15 -0800121
Rich Lane2353b522013-11-18 12:08:56 -0800122 with template_utils.open_output(install_dir, 'wireshark/openflow.lua') as out:
Andreas Wundsamc2ce5fa2013-11-15 15:20:11 -0800123 template_utils.render_template(out, "openflow.lua", [templates_dir], context)