blob: cf87dedb855fcc75989ccb94582ade2e5104a832 [file] [log] [blame]
Rich Lanea06d0c32013-03-25 08:52:03 -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
Rich Lane8a22cda2013-06-19 13:20:07 -070028from collections import namedtuple
29
30OFTypeData = namedtuple("OFTypeData", ["init", "pack", "unpack"])
31
Rich Lanec854bae2013-06-19 14:39:51 -070032# Map from LOXI type name to an object with templates for init, pack, and unpack
33# Most types are defined using the convenience code below. This dict should
34# only be used directly for special cases such as primitive types.
Rich Laneda11f8b2013-06-19 15:53:25 -070035type_data_map = {
Rich Lane8a22cda2013-06-19 13:20:07 -070036 'char': OFTypeData(
37 init='0',
38 pack='struct.pack("!B", %s)',
39 unpack='%s.read("!B")[0]'),
40
41 'uint8_t': OFTypeData(
42 init='0',
43 pack='struct.pack("!B", %s)',
44 unpack='%s.read("!B")[0]'),
45
46 'uint16_t': OFTypeData(
47 init='0',
48 pack='struct.pack("!H", %s)',
49 unpack='%s.read("!H")[0]'),
50
51 'uint32_t': OFTypeData(
52 init='0',
53 pack='struct.pack("!L", %s)',
54 unpack='%s.read("!L")[0]'),
55
56 'uint64_t': OFTypeData(
57 init='0',
58 pack='struct.pack("!Q", %s)',
59 unpack='%s.read("!Q")[0]'),
60
61 'of_port_no_t': OFTypeData(
62 init='0',
63 pack='util.pack_port_no(%s)',
64 unpack='util.unpack_port_no(%s)'),
65
66 'of_fm_cmd_t': OFTypeData(
67 init='0',
68 pack='util.pack_fm_cmd(%s)',
69 unpack='util.unpack_fm_cmd(%s)'),
70
71 'of_wc_bmap_t': OFTypeData(
72 init='util.init_wc_bmap()',
73 pack='util.pack_wc_bmap(%s)',
74 unpack='util.unpack_wc_bmap(%s)'),
75
76 'of_match_bmap_t': OFTypeData(
77 init='util.init_match_bmap()',
78 pack='util.pack_match_bmap(%s)',
79 unpack='util.unpack_match_bmap(%s)'),
80
81 'of_ipv6_t': OFTypeData(
82 init="'\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00'",
83 pack='struct.pack("!16s", %s)',
84 unpack="%s.read('!16s')[0]"),
85
86 'of_mac_addr_t': OFTypeData(
87 init='[0,0,0,0,0,0]',
88 pack='struct.pack("!6B", *%s)',
89 unpack="list(%s.read('!6B'))"),
90
91 'of_octets_t': OFTypeData(
92 init="''",
93 pack='%s',
94 unpack='str(%s.read_all())'),
95
Rich Lane8a22cda2013-06-19 13:20:07 -070096 # HACK need the match_v3 length field
97 'list(of_oxm_t)': OFTypeData(
98 init='[]',
99 pack='util.pack_list(%s)',
100 unpack='oxm.unpack_list(%s.slice(_length-4))'),
101
Rich Lanec854bae2013-06-19 14:39:51 -0700102 # TODO implement unpack
103 'list(of_table_features_t)': OFTypeData(
Rich Lane8a22cda2013-06-19 13:20:07 -0700104 init='[]',
105 pack='util.pack_list(%s)',
Rich Lanec854bae2013-06-19 14:39:51 -0700106 unpack=None),
Rich Lane8a22cda2013-06-19 13:20:07 -0700107
Rich Lanec854bae2013-06-19 14:39:51 -0700108 # TODO implement unpack
Rich Lane8a22cda2013-06-19 13:20:07 -0700109 'list(of_action_id_t)': OFTypeData(
110 init='[]',
111 pack='util.pack_list(%s)',
112 unpack=None),
113
Rich Lanec854bae2013-06-19 14:39:51 -0700114 # TODO implement unpack
Rich Lane8a22cda2013-06-19 13:20:07 -0700115 'list(of_table_feature_prop_t)': OFTypeData(
116 init='[]',
117 pack='util.pack_list(%s)',
118 unpack=None),
Rich Lane8a22cda2013-06-19 13:20:07 -0700119}
Rich Lanea06d0c32013-03-25 08:52:03 -0700120
Rich Lanec854bae2013-06-19 14:39:51 -0700121## Fixed length strings
122
123# Map from class name to length
124fixed_length_strings = {
125 'of_port_name_t': 16,
126 'of_table_name_t': 32,
127 'of_serial_num_t': 32,
128 'of_desc_str_t': 256,
129}
130
131for (cls, length) in fixed_length_strings.items():
Rich Laneda11f8b2013-06-19 15:53:25 -0700132 type_data_map[cls] = OFTypeData(
Rich Lanec854bae2013-06-19 14:39:51 -0700133 init='""',
134 pack='struct.pack("!%ds", %%s)' % length,
135 unpack='%%s.read("!%ds")[0].rstrip("\\x00")' % length)
136
137## Embedded structs
138
139# Map from class name to Python class name
140embedded_structs = {
141 'of_match_t': 'common.match',
142 'of_port_desc_t': 'common.port_desc',
143 'of_meter_features_t': 'common.meter_features',
144 'of_bsn_vport_q_in_q_t': 'common.bsn_vport_q_in_q',
145}
146
147for (cls, pyclass) in embedded_structs.items():
Rich Laneda11f8b2013-06-19 15:53:25 -0700148 type_data_map[cls] = OFTypeData(
Rich Lanec854bae2013-06-19 14:39:51 -0700149 init='%s()' % pyclass,
150 pack='%s.pack()',
151 unpack='%s.unpack(%%s)' % pyclass)
152
153## Variable element length lists
154
155# Map from list class name to list deserializer
156variable_elem_len_lists = {
157 'list(of_action_t)': 'action.unpack_list',
158 'list(of_bucket_t)': 'common.unpack_list_bucket',
159 'list(of_flow_stats_entry_t)': 'common.unpack_list_flow_stats_entry',
160 'list(of_group_desc_stats_entry_t)': 'common.unpack_list_group_desc_stats_entry',
161 'list(of_group_stats_entry_t)': 'common.unpack_list_group_stats_entry',
162 'list(of_hello_elem_t)': 'common.unpack_list_hello_elem',
163 'list(of_instruction_t)': 'instruction.unpack_list',
164 'list(of_meter_band_t)': 'meter_band.unpack_list',
165 'list(of_meter_stats_t)': 'common.unpack_list_meter_stats',
166 'list(of_packet_queue_t)': 'common.unpack_list_packet_queue',
167 'list(of_queue_prop_t)': 'common.unpack_list_queue_prop',
168}
169
170for (cls, deserializer) in variable_elem_len_lists.items():
Rich Laneda11f8b2013-06-19 15:53:25 -0700171 type_data_map[cls] = OFTypeData(
Rich Lanec854bae2013-06-19 14:39:51 -0700172 init='[]',
173 pack='util.pack_list(%s)',
174 unpack='%s(%%s)' % deserializer)
175
176## Fixed element length lists
177
178# Map from list class name to list element deserializer
179fixed_elem_len_lists = {
180 'list(of_bsn_interface_t)': 'common.bsn_interface.unpack',
181 'list(of_bucket_counter_t)': 'common.bucket_counter.unpack',
182 'list(of_meter_band_stats_t)': 'common.meter_band_stats.unpack',
183 'list(of_port_desc_t)': 'common.port_desc.unpack',
184 'list(of_port_stats_entry_t)': 'common.port_stats_entry.unpack',
185 'list(of_queue_stats_entry_t)': 'common.queue_stats_entry.unpack',
186 'list(of_table_stats_entry_t)': 'common.table_stats_entry.unpack',
187 'list(of_uint32_t)': 'common.uint32.unpack',
188 'list(of_uint8_t)': 'common.uint8.unpack',
189}
190
191for (cls, element_deserializer) in fixed_elem_len_lists.items():
Rich Laneda11f8b2013-06-19 15:53:25 -0700192 type_data_map[cls] = OFTypeData(
Rich Lanec854bae2013-06-19 14:39:51 -0700193 init='[]',
194 pack='util.pack_list(%s)',
195 unpack='loxi.generic_util.unpack_list(%%s, %s)' % element_deserializer)
196
Rich Laneda11f8b2013-06-19 15:53:25 -0700197## Public interface
Rich Lanec854bae2013-06-19 14:39:51 -0700198
Rich Laneda11f8b2013-06-19 15:53:25 -0700199# Return an initializer expression for the given oftype
200def gen_init_expr(oftype):
201 type_data = type_data_map.get(oftype)
202 if type_data and type_data.init:
203 return type_data.init
204 else:
205 return "loxi.unimplemented('init %s')" % oftype
Rich Lanea06d0c32013-03-25 08:52:03 -0700206
Rich Laneda11f8b2013-06-19 15:53:25 -0700207# Return a pack expression for the given oftype
208#
209# 'value_expr' is a string of Python code which will evaluate to
210# the value to be packed.
211def gen_pack_expr(oftype, value_expr):
212 type_data = type_data_map.get(oftype)
213 if type_data and type_data.pack:
214 return type_data.pack % value_expr
215 else:
216 return "loxi.unimplemented('pack %s')" % oftype
Rich Lanea06d0c32013-03-25 08:52:03 -0700217
Rich Laneda11f8b2013-06-19 15:53:25 -0700218# Return an unpack expression for the given oftype
219#
220# 'reader_expr' is a string of Python code which will evaluate to
221# the OFReader instance used for deserialization.
222def gen_unpack_expr(oftype, reader_expr):
223 type_data = type_data_map.get(oftype)
224 if type_data and type_data.unpack:
225 return type_data.unpack % reader_expr
226 else:
227 return "loxi.unimplemented('unpack %s')" % oftype