blob: c4ff7f4dd54b4d07d717ddf2fafd3bc61fa99ba9 [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
32import of_g
Rich Lane364e0292013-10-01 21:05:57 -070033from loxi_ir import *
Rich Lane64585d92013-10-02 16:01:37 -070034import field_info
Rich Lane45dcae12013-06-04 13:07:41 -070035
36templates_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'templates')
37
Rich Lane52452662013-10-25 13:34:42 -070038DissectorField = namedtuple("DissectorField", ["fullname", "name", "type", "base", "enum_table"])
Rich Laneb014bcf2013-06-19 11:14:11 -070039
Rich Lane7708c182013-10-01 23:27:27 -070040proto_names = { 1: 'of10', 2: 'of11', 3: 'of12', 4: 'of13' }
41def make_field_name(wire_version, ofclass_name, member_name):
42 return "%s.%s.%s" % (proto_names[wire_version],
43 ofclass_name[3:],
44 member_name)
45
Rich Lane7ff373a2013-10-25 14:18:04 -070046def get_reader(version, cls, m):
47 """
48 Decide on a reader function to use for the given field
49 """
50 ofproto = of_g.ir[version]
51 enum = ofproto.enum_by_name(m.oftype)
52 if enum and 'wire_type' in enum.params:
53 return "read_" + enum.params['wire_type']
54 else:
55 return "read_" + m.oftype.replace(')', '').replace('(', '_')
56
Rich Lane64585d92013-10-02 16:01:37 -070057def get_field_info(version, cls, name, oftype):
58 """
59 Decide on a Wireshark type and base for a given field.
60
61 Returns (type, base)
62 """
63 if oftype.startswith("list"):
Rich Lane52452662013-10-25 13:34:42 -070064 return "bytes", "NONE", "nil"
Rich Lane64585d92013-10-02 16:01:37 -070065
66 ofproto = of_g.ir[version]
Rich Lane52452662013-10-25 13:34:42 -070067
Rich Lane64585d92013-10-02 16:01:37 -070068 enum = ofproto.enum_by_name(oftype)
Rich Lane52452662013-10-25 13:34:42 -070069 if not enum and (cls, name) in field_info.class_field_to_enum:
70 enum_name = field_info.class_field_to_enum[(cls, name)]
71 enum = ofproto.enum_by_name(enum_name)
Rich Lane64585d92013-10-02 16:01:37 -070072
73 if enum:
Rich Lane4df40f32013-10-08 15:40:39 -070074 field_type = "uint32"
Rich Lane64585d92013-10-02 16:01:37 -070075 elif oftype in field_info.oftype_to_wireshark_type:
76 field_type = field_info.oftype_to_wireshark_type[oftype]
77 else:
78 print "WARN missing oftype_to_wireshark_type for", oftype
Rich Lane4df40f32013-10-08 15:40:39 -070079 field_type = "bytes"
Rich Lane64585d92013-10-02 16:01:37 -070080
81 if enum:
82 if enum.is_bitmask:
83 field_base = "HEX"
84 else:
85 field_base = "DEC"
86 elif oftype in field_info.field_to_base:
87 field_base = field_info.field_to_base[name]
88 elif oftype in field_info.oftype_to_base:
89 field_base = field_info.oftype_to_base[oftype]
90 else:
91 print "WARN missing oftype_to_base for", oftype
92 field_base = "NONE"
93
Rich Lane52452662013-10-25 13:34:42 -070094 if enum:
95 enum_table = 'enum_v%d_%s' % (version, enum.name)
96 else:
97 enum_table = 'nil'
98
99 return field_type, field_base, enum_table
Rich Lane64585d92013-10-02 16:01:37 -0700100
Rich Laneb014bcf2013-06-19 11:14:11 -0700101def create_fields():
Rich Lane364e0292013-10-01 21:05:57 -0700102 r = []
Rich Lane364e0292013-10-01 21:05:57 -0700103 for wire_version, ofproto in of_g.ir.items():
104 for ofclass in ofproto.classes:
105 for m in ofclass.members:
106 if isinstance(m, OFPadMember):
107 continue
Rich Lane7708c182013-10-01 23:27:27 -0700108 fullname = make_field_name(wire_version, ofclass.name, m.name)
Rich Lane52452662013-10-25 13:34:42 -0700109 field_type, field_base, enum_table = get_field_info(wire_version, ofclass.name, m.name, m.oftype)
110 r.append(DissectorField(fullname, m.name, field_type, field_base, enum_table))
Rich Lane364e0292013-10-01 21:05:57 -0700111
112 return r
Rich Laneb014bcf2013-06-19 11:14:11 -0700113
Rich Lane45dcae12013-06-04 13:07:41 -0700114def generate(out, name):
Rich Laneb014bcf2013-06-19 11:14:11 -0700115 context = {
Rich Laneb014bcf2013-06-19 11:14:11 -0700116 'fields': create_fields(),
117 }
Rich Lane45dcae12013-06-04 13:07:41 -0700118 utils.render_template(out, "openflow.lua", [templates_dir], context)