blob: 48aaca0a8e8391134e03d891b254adbbb1e0f229 [file] [log] [blame]
Andreas Wundsam542a13c2013-11-15 13:28:55 -08001# 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"""
29@brief Utilities involving LOXI naming conventions
30
31Utility functions for OpenFlow class generation
32
33These may need to be sorted out into language specific functions
34"""
35
36import sys
37import c_gen.of_g_legacy as of_g
38import tenjin
39from generic_utils import find, memoize
40
41def class_signature(members):
42 """
43 Generate a signature string for a class in canonical form
44
45 @param cls The class whose signature is to be generated
46 """
47 return ";".join([",".join([x["m_type"], x["name"], str(x["offset"])])
48 for x in members])
49
50def type_dec_to_count_base(m_type):
51 """
52 Resolve a type declaration like uint8_t[4] to a count (4) and base_type
53 (uint8_t)
54
55 @param m_type The string type declaration to process
56 """
57 count = 1
58 chk_ar = m_type.split('[')
59 if len(chk_ar) > 1:
60 count_str = chk_ar[1].split(']')[0]
61 if count_str in of_g.ofp_constants:
62 count = of_g.ofp_constants[count_str]
63 else:
64 count = int(count_str)
65 base_type = chk_ar[0]
66 else:
67 base_type = m_type
68 return count, base_type
69
70##
71# Class types:
72#
73# Virtual
74# A virtual class is one which does not have an explicit wire
75# representation. For example, an inheritance super class
76# or a list type.
77#
78# List
79# A list of objects of some other type
80#
81# TLV16
82# The wire represenation starts with 16-bit type and length fields
83#
84# OXM
85# An extensible match object
86#
87# Message
88# A top level OpenFlow message
89#
90#
91
92def class_is_message(cls):
93 """
94 Return True if cls is a message object based on info in unified
95 """
Rich Lanec9c54fe2014-04-23 15:15:09 -070096 return "xid" in of_g.unified[cls]["union"]
Andreas Wundsam542a13c2013-11-15 13:28:55 -080097
98def class_is_tlv16(cls):
99 """
100 Return True if cls_name is an object which uses uint16 for type and length
101 """
102 if cls.find("of_action") == 0: # Includes of_action_id classes
103 return True
104 if cls.find("of_instruction") == 0:
105 return True
106 if cls.find("of_queue_prop") == 0:
107 return True
108 if cls.find("of_table_feature_prop") == 0:
109 return True
110 # *sigh*
111 if cls.find("of_meter_band_stats") == 0: # NOT A TLV
112 return False
113 if cls.find("of_meter_band") == 0:
114 return True
115 if cls.find("of_hello_elem") == 0:
116 return True
117 if cls == "of_match_v3":
118 return True
119 if cls == "of_match_v4":
120 return True
Rich Lane713d9282013-12-30 15:21:35 -0800121 if cls.find("of_bsn_tlv") == 0:
122 return True
Wilson Ngd6181882014-04-14 16:28:35 -0700123 if cls.find("of_bsn_vport") == 0:
124 return True
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800125 return False
126
127def class_is_u16_len(cls):
128 """
129 Return True if cls_name is an object which uses initial uint16 length
130 """
131 return cls in ["of_group_desc_stats_entry", "of_group_stats_entry",
xinwuf08ef682013-12-05 18:29:20 -0800132 "of_flow_stats_entry", "of_bucket", "of_table_features",
Rich Lane713d9282013-12-30 15:21:35 -0800133 "of_bsn_port_counter_stats_entry", "of_bsn_vlan_counter_stats_entry",
134 "of_bsn_gentable_entry_desc_stats_entry", "of_bsn_gentable_entry_stats_entry",
135 "of_bsn_gentable_desc_stats_entry"]
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800136
137def class_is_oxm(cls):
138 """
139 Return True if cls_name is an OXM object
140 """
141 if cls.find("of_oxm") == 0:
142 return True
143 return False
144
145def class_is_action(cls):
146 """
147 Return True if cls_name is an action object
148
149 Note that action_id is not an action object, though it has
150 the same header. It looks like an action header, but the type
151 is used to identify a kind of action, it does not indicate the
152 type of the object following.
153 """
154 if cls.find("of_action_id") == 0:
155 return False
156 if cls.find("of_action") == 0:
157 return True
158
159 # For each vendor, check for vendor specific action
160 for exp in of_g.experimenter_name_to_id:
161 if cls.find("of_action" + exp) == 0:
162 return True
163
164 return False
165
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800166def class_is_list(cls):
167 """
168 Return True if cls_name is a list object
169 """
170 return (cls.find("of_list_") == 0)
171
172def type_is_of_object(m_type):
173 """
174 Return True if m_type is an OF object type
175 """
176 # Remove _t from the type id and see if key for unified class
177 if m_type[-2:] == "_t":
178 m_type = m_type[:-2]
179 return m_type in of_g.unified
180
181def list_to_entry_type(cls):
182 """
183 Return the entry type for a list
184 """
185 slen = len("of_list_")
186 return "of_" + cls[slen:]
187
188def type_to_short_name(m_type):
189 if m_type in of_g.of_base_types:
190 tname = of_g.of_base_types[m_type]["short_name"]
191 elif m_type in of_g.of_mixed_types:
192 tname = of_g.of_mixed_types[m_type]["short_name"]
193 else:
194 tname = "unknown"
195 return tname
196
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800197def member_to_index(m_name, members):
198 """
199 Given a member name, return the index in the members dict
200 @param m_name The name of the data member to search for
201 @param members The dict of members
202 @return Index if found, -1 not found
203
204 Note we could generate an index when processing the original input
205 """
206 count = 0
207 for d in members:
208 if d["name"] == m_name:
209 return count
210 count += 1
211 return -1
212
213def member_base_type(cls, m_name):
214 """
215 Map a member to its of_ type
216 @param cls The class name
217 @param m_name The name of the member being gotten
218 @return The of_ type of the member
219 """
220 rv = of_g.unified[cls]["union"][m_name]["m_type"]
221 if rv[-2:] == "_t":
222 return rv
223 return rv + "_t"
224
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800225def type_is_scalar(m_type):
226 return m_type in of_g.of_scalar_types
227
228def skip_member_name(name):
229 return name.find("pad") == 0 or name in of_g.skip_members
230
231def enum_name(cls):
232 """
233 Return the name used for an enum identifier for the given class
234 @param cls The class name
235 """
236 return cls.upper()
237
238def class_in_version(cls, ver):
239 """
240 Return boolean indicating if cls is defined for wire version ver
241 """
242
243 return (cls, ver) in of_g.base_length
244
245def instance_to_class(instance, parent):
246 """
247 Return the name of the class for an instance of inheritance type parent
248 """
249 return parent + "_" + instance
250
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800251def class_is_var_len(cls, version):
252 # Match is special case. Only version 1.2 (wire version 3) is var
253 if cls == "of_match":
254 return version == 3
255
256 return not (cls, version) in of_g.is_fixed_length
257
Andreas Wundsam542a13c2013-11-15 13:28:55 -0800258##
259# Is class a flow modify of some sort?
260
261def cls_is_flow_mod(cls):
262 return cls in ["of_flow_mod", "of_flow_modify", "of_flow_add", "of_flow_delete",
263 "of_flow_modify_strict", "of_flow_delete_strict"]
264
265
266def all_member_types_get(cls, version):
267 """
268 Get the members and list of types for members of a given class
269 @param cls The class name to process
270 @param version The version for the class
271 """
272 member_types = []
273
274 if not version in of_g.unified[cls]:
275 return ([], [])
276
277 if "use_version" in of_g.unified[cls][version]:
278 v = of_g.unified[cls][version]["use_version"]
279 members = of_g.unified[cls][v]["members"]
280 else:
281 members = of_g.unified[cls][version]["members"]
282 # Accumulate variables that are supported
283 for member in members:
284 m_type = member["m_type"]
285 m_name = member["name"]
286 if skip_member_name(m_name):
287 continue
288 if not m_type in member_types:
289 member_types.append(m_type)
290
291 return (members, member_types)
292
293def list_name_extract(list_type):
294 """
295 Return the base name for a list object of the given type
296 @param list_type The type of the list as appears in the input,
297 for example list(of_port_desc_t).
298 @return A pair, (list-name, base-type) where list-name is the
299 base name for the list, for example of_list_port_desc, and base-type
300 is the type of list elements like of_port_desc_t
301 """
302 base_type = list_type[5:-1]
303 list_name = base_type
304 if list_name.find("of_") == 0:
305 list_name = list_name[3:]
306 if list_name[-2:] == "_t":
307 list_name = list_name[:-2]
308 list_name = "of_list_" + list_name
309 return (list_name, base_type)
310
311def version_to_name(version):
312 """
313 Convert an integer version to the C macro name
314 """
315 return "OF_" + of_g.version_names[version]
316
317def gen_c_copy_license(out):
318 """
319 Generate the top comments for copyright and license
320 """
321 import c_gen.util
322 c_gen.util.render_template(out, '_copyright.c')
323
324def accessor_returns_error(a_type, m_type):
325 is_var_len = (not type_is_scalar(m_type)) and \
326 [x for x in of_g.of_version_range if class_is_var_len(m_type[:-2], x)] != []
327 if a_type == "set" and is_var_len:
328 return True
329 elif m_type == "of_match_t":
330 return True
331 else:
332 return False