blob: b4135ea6470d3c05b48d35e81e9790462f49ef85 [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 Lane364e0292013-10-01 21:05:57 -070038DissectorField = namedtuple("DissectorField", ["fullname", "name", "type", "base"])
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 Lane64585d92013-10-02 16:01:37 -070046def get_field_info(version, cls, name, oftype):
47 """
48 Decide on a Wireshark type and base for a given field.
49
50 Returns (type, base)
51 """
52 if oftype.startswith("list"):
Rich Lane4df40f32013-10-08 15:40:39 -070053 return "bytes", "NONE"
Rich Lane64585d92013-10-02 16:01:37 -070054
55 ofproto = of_g.ir[version]
56 enum = ofproto.enum_by_name(oftype)
57
58 if enum:
Rich Lane4df40f32013-10-08 15:40:39 -070059 field_type = "uint32"
Rich Lane64585d92013-10-02 16:01:37 -070060 elif oftype in field_info.oftype_to_wireshark_type:
61 field_type = field_info.oftype_to_wireshark_type[oftype]
62 else:
63 print "WARN missing oftype_to_wireshark_type for", oftype
Rich Lane4df40f32013-10-08 15:40:39 -070064 field_type = "bytes"
Rich Lane64585d92013-10-02 16:01:37 -070065
66 if enum:
67 if enum.is_bitmask:
68 field_base = "HEX"
69 else:
70 field_base = "DEC"
71 elif oftype in field_info.field_to_base:
72 field_base = field_info.field_to_base[name]
73 elif oftype in field_info.oftype_to_base:
74 field_base = field_info.oftype_to_base[oftype]
75 else:
76 print "WARN missing oftype_to_base for", oftype
77 field_base = "NONE"
78
79 return field_type, field_base
80
Rich Laneb014bcf2013-06-19 11:14:11 -070081def create_fields():
Rich Lane364e0292013-10-01 21:05:57 -070082 r = []
Rich Lane364e0292013-10-01 21:05:57 -070083 for wire_version, ofproto in of_g.ir.items():
84 for ofclass in ofproto.classes:
85 for m in ofclass.members:
86 if isinstance(m, OFPadMember):
87 continue
Rich Lane7708c182013-10-01 23:27:27 -070088 fullname = make_field_name(wire_version, ofclass.name, m.name)
Rich Lane64585d92013-10-02 16:01:37 -070089 field_type, field_base = get_field_info(wire_version, ofclass.name, m.name, m.oftype)
90 r.append(DissectorField(fullname, m.name, field_type, field_base))
Rich Lane364e0292013-10-01 21:05:57 -070091
92 return r
Rich Laneb014bcf2013-06-19 11:14:11 -070093
Rich Lane45dcae12013-06-04 13:07:41 -070094def generate(out, name):
Rich Laneb014bcf2013-06-19 11:14:11 -070095 context = {
Rich Laneb014bcf2013-06-19 11:14:11 -070096 'fields': create_fields(),
97 }
Rich Lane45dcae12013-06-04 13:07:41 -070098 utils.render_template(out, "openflow.lua", [templates_dir], context)