blob: db040f1b07b7fb872c5c81db7aa5eb5af71836e8 [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
28##
29# @brief Global data structs for LOXI code generation
30#
31# @fixme This needs to be refactored and brought into the 21st century.
32#
33
34import sys
35from optparse import OptionParser
36# @fixme Replace with argparse
37
38################################################################
39#
40# Configuration global parameters
41#
42################################################################
43
44##
45# The map from wire protocol to enum identifier generated from input
46# This is built from the version-specific structs file info.
47# @fixme This should go away when the process structs file is updated
48wire_ver_map = {}
49
50##
51# Command line options
52options = {}
53
54##
55# Command line arguments
56args = []
57
58##@var config_default
59# The default configuration dictionary for LOXI code generation
60options_default = {
61 "lang" : "c",
62 "version-list" : "1.0 1.1 1.2 1.3",
63 "install-dir" : "loxi_output",
64}
65
66##
67# The list of wire versions which are to be supported
68target_version_list = []
69
70def lang_normalize(lang):
71 """
Andreas Wundsam53256162013-05-02 14:05:53 -070072 Normalize the representation of the language
Rich Lanea06d0c32013-03-25 08:52:03 -070073 """
74 return lang.lower()
75
76def version_list_normalize(vlist):
77 """
78 Normalize the version list and return as an array
79 """
80 out_list = []
81 # @fixme Map to OF version references
82 if vlist.find(',') > 0:
83 vlist = vlist.split(',')
84 else:
85 vlist = vlist.split()
86 vlist.sort()
87 for ver in vlist:
88 try:
89 out_list.append(of_param_version_map[ver])
90 except KeyError:
91 sys.stderr.write("Bad version input, %s" % str(ver))
92 sys.exit(1)
93
94 return out_list
95
96def process_commandline(default_vals=options_default):
97 """
98 Set up the options dictionary
99
100 @param cfg_dflt The default configuration dictionary
101 @return A pair (options, args) as per parser return
102 """
103 global options
104 global args
105 global target_version_list
106
107 parser = OptionParser(version="%prog 0.1")
108
109 #@todo Add options via dictionary
110 parser.add_option("--list-files", action="store_true", default=False,
111 help="List output files generated")
112 parser.add_option("-l", "--lang", "--language",
113 default=default_vals["lang"],
114 help="Select the target language: c, python")
115 parser.add_option("-i", "--install-dir",
116 default=default_vals["install-dir"],
117 help="Directory to install generated files to (default %s)" % default_vals["install-dir"])
Andreas Wundsam53256162013-05-02 14:05:53 -0700118 parser.add_option("-v", "--version-list",
Rich Lanea06d0c32013-03-25 08:52:03 -0700119 default=default_vals["version-list"],
120 help="Specify the versions to target as 1.0 1.1 etc")
121
122 (options, args) = parser.parse_args()
123
124 options.lang = lang_normalize(options.lang)
125 target_version_list = version_list_normalize(options.version_list)
126 target_version_list.sort()
127 return (options, args)
128
129##
130# The dictionary of config variables related to code
131#
132# @param gen_unified_fns Boolean; Generate top level function definitions for
Andreas Wundsam53256162013-05-02 14:05:53 -0700133# accessors which are independent of the version; the alternative is to only
Rich Lanea06d0c32013-03-25 08:52:03 -0700134# use the function pointers in the class definitions. These functions support
135# better inlining optimizations.
136#
137# @param gen_fn_ptrs Boolean; Generate the functions pointed to by pointer
138# in the class (struct) definitions; the alternative is to only use the
139# unified (use_) functions
140#
141# @param use_obj_id Use object IDs in struct defns CURRENTLY NOT SUPPORTED
Andreas Wundsam53256162013-05-02 14:05:53 -0700142#
Rich Lanea06d0c32013-03-25 08:52:03 -0700143# @param return_base_types For 'get' accessors, return values when possible.
144# Otherwise all values are returned thru a call by variable parameter
145#
146# @param use_static_inlines Generate low level accessors as static inline
147# and put them in header files rather than .c files.
148#
149# @param copy_semantics One of "read", "write" or "grow". This defines the
150# way that buffer references are managed. Currently on "read" is supported.
151#
152# @param encode_typedefs Use object and member IDs (rather than names)
153# when generating the names used for accessor function typedefs
154#
Andreas Wundsam53256162013-05-02 14:05:53 -0700155# @param get_returns One of "error", "value", or "void";
Rich Lanea06d0c32013-03-25 08:52:03 -0700156# CURRENTLY ONLY "error" IS SUPPORTED. "error" means
157# all get operations return an error code. "value" means return a base_type
158# value when possible or void if not. "void" means always return void
159# and use a call-by-variable parameter
160#
161
162# @fixme These are still very C specific and should probably either
163# go into lang_c.py or be swallowed by command line option parsing
164code_gen_config = dict(
165 gen_unified_fns=True,
166# gen_fn_ptrs=True, # WARNING: Haven't tested with this in a while
167 gen_fn_ptrs=False,
168 use_obj_id=False,
169 use_static_inlines=False,
170 copy_semantics="read", # Only read implemented: read, write, grow
171 encoded_typedefs=False,
172 get_returns="error", # Only error implemented; error, value, void
173)
174
175## These members do not get normal accessors
176
177skip_members = ["version", "type", "length", "stats_type", "len",
178 "type_len", "actions_len", "_command"]
179
180## Some OpenFlow string length constants
181#
182# These are a few length constants needed for array processing
183ofp_constants = dict(
184 OF_MAX_TABLE_NAME_LEN = 32,
185 OF_MAX_PORT_NAME_LEN = 16,
186 OF_ETH_ALEN = 6,
187 OF_DESC_STR_LEN = 256,
188 OF_SERIAL_NUM_LEN = 32
189)
190
191## List of mixed data types
192#
193# This is a list of data types which require special treatment
194# because the underlying datatype has changed between versions.
195# The main example is port which went from 16 to 32 bits. We
196# define per-version accessors for these types and those are
197# used in place of the normal ones.
198#
199# The wire protocol number is used to identify versions. For now,
200# the value is the name of the type to use for that version
201#
202# This is the map between the external type (like of_port_no_t)
Andreas Wundsam53256162013-05-02 14:05:53 -0700203# which is used by customers of this code and the internal
204# datatypes (like uint16_t) that appear on the wire for a
Rich Lanea06d0c32013-03-25 08:52:03 -0700205# particular version.
206#
207of_mixed_types = dict(
208 of_port_no_t = {
209 1: "uint16_t",
210 2: "uint32_t",
211 3: "uint32_t",
212 4: "uint32_t",
213 "short_name":"port_no"
214 },
215 of_port_desc_t = {
216 1: "of_port_desc_t",
217 2: "of_port_desc_t",
218 3: "of_port_desc_t",
219 4: "of_port_desc_t",
220 "short_name":"port_desc"
221 },
Dan Talaycoc0e802e2013-05-18 23:52:39 -0700222 of_bsn_vport_t = {
223 1: "of_bsn_vport_t",
224 2: "of_bsn_vport_t",
225 3: "of_bsn_vport_t",
226 4: "of_bsn_vport_t",
227 "short_name":"bsn_vport"
228 },
Rich Lanea06d0c32013-03-25 08:52:03 -0700229 of_fm_cmd_t = { # Flow mod command went from u16 to u8
230 1: "uint16_t",
231 2: "uint8_t",
232 3: "uint8_t",
233 4: "uint8_t",
234 "short_name":"fm_cmd"
235 },
236 of_wc_bmap_t = { # Wildcard bitmap
237 1: "uint32_t",
238 2: "uint32_t",
239 3: "uint64_t",
240 4: "uint64_t",
241 "short_name":"wc_bmap"
242 },
243 of_match_bmap_t = { # Match bitmap
244 1: "uint32_t",
245 2: "uint32_t",
246 3: "uint64_t",
247 4: "uint64_t",
248 "short_name":"match_bmap"
249 },
250 of_match_t = { # Match object
251 1: "of_match_v1_t",
252 2: "of_match_v2_t",
253 3: "of_match_v3_t",
254 4: "of_match_v3_t", # Currently uses same match as 1.2 (v3).
255 "short_name":"match"
256 },
257)
258
259## Base data types
260#
261# The basic types; Value is a list: bytes, to_wire, from_wire
262# The accessors deal with endian, alignment and any other host/network
263# considerations. These are common across all versions
264#
265# For get accessors, assume we memcpy from wire buf and then apply ntoh
266# For set accessors, assume we apply hton and then memcpy to wire buf
267#
268# to/from wire functions take a pointer to class and change in place
269of_base_types = dict(
270 char = dict(bytes=1, use_as_rv=1, short_name="char"),
271 uint8_t = dict(bytes=1, use_as_rv=1, short_name="u8"),
272 uint16_t = dict(bytes=2, to_w="u16_hton", from_w="u16_ntoh", use_as_rv=1,
273 short_name="u16"),
274 uint32_t = dict(bytes=4, to_w="u32_hton", from_w="u32_ntoh", use_as_rv=1,
275 short_name="u32"),
276 uint64_t = dict(bytes=8, to_w="u64_hton", from_w="u64_ntoh", use_as_rv=1,
277 short_name="u64"),
278# of_cookie_t = dict(bytes=8, to_w="u64_hton", from_w="u64_ntoh", use_as_rv=1#,
279# short_name="cookie"),
280# of_counter_t = dict(bytes=8, to_w="u64_hton", from_w="u64_ntoh", use_as_rv=1,
281# short_name="counter"),
282 of_mac_addr_t = dict(bytes=6, short_name="mac"),
283 of_ipv6_t = dict(bytes=16, short_name="ipv6"),
284 of_port_name_t = dict(bytes=ofp_constants["OF_MAX_PORT_NAME_LEN"],
285 short_name="port_name"),
286 of_table_name_t = dict(bytes=ofp_constants["OF_MAX_TABLE_NAME_LEN"],
287 short_name="tab_name"),
288 of_desc_str_t = dict(bytes=ofp_constants["OF_DESC_STR_LEN"],
289 short_name="desc_str"),
290 of_serial_num_t = dict(bytes=ofp_constants["OF_SERIAL_NUM_LEN"],
291 short_name="ser_num"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700292 of_match_v1_t = dict(bytes=40, to_w="match_v1_hton",
293 from_w="match_v1_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700294 short_name="match_v1"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700295 of_match_v2_t = dict(bytes=88, to_w="match_v2_hton",
296 from_w="match_v2_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700297 short_name="match_v2"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700298 of_match_v3_t = dict(bytes=-1, to_w="match_v3_hton",
299 from_w="match_v3_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700300 short_name="match_v3"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700301# of_match_v4_t = dict(bytes=-1, to_w="match_v4_hton",
302# from_w="match_v4_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700303# short_name="match_v4"),
304 of_octets_t = dict(bytes=-1, short_name="octets")
305)
306
307of_scalar_types = ["char", "uint8_t", "uint16_t", "uint32_t", "uint64_t",
308 "of_port_no_t", "of_fm_cmd_t", "of_wc_bmap_t",
309 "of_match_bmap_t", "of_port_name_t", "of_table_name_t",
Andreas Wundsam53256162013-05-02 14:05:53 -0700310 "of_desc_str_t", "of_serial_num_t", "of_mac_addr_t",
Rich Lanea06d0c32013-03-25 08:52:03 -0700311 "of_ipv6_t"]
312
313base_object_members = """\
314 /* The control block for the underlying data buffer */
315 of_wire_object_t wire_object;
316 /* The LOCI type enum value of the object */
317 of_object_id_t object_id;
318
319 /*
320 * Objects need to track their "parent" so that updates to the
321 * object that affect its length can be pushed to the parent.
322 * Treat as private.
323 */
324 of_object_t *parent;
325
326 /*
327 * Not all objects have length and version on the wire so we keep
328 * them here. NOTE: Infrastructure manages length and version.
329 * Treat length as private and version as read only.
330 */
331 int length;
332 of_version_t version;
333
334 /*
335 * Many objects have a length and/or type represented in the wire buffer
336 * These accessors get and set those value when present. Treat as private.
337 */
338 of_wire_length_get_f wire_length_get;
339 of_wire_length_set_f wire_length_set;
340 of_wire_type_get_f wire_type_get;
341 of_wire_type_set_f wire_type_set;
342
343 of_object_track_info_t track_info;
344
345 /*
346 * Metadata available for applications. Ensure 8-byte alignment, but
347 * that buffer is at least as large as requested. This data is not used
348 * or inspected by LOCI.
349 */
350 uint64_t metadata[(OF_OBJECT_METADATA_BYTES + 7) / 8];
351"""
352
353
354##
355# LOXI identifiers
356#
357# Dict indexed by identifier name. Each entry contains the information
358# as a DotDict with the following keys:
359# values: A dict indexed by wire version giving each verion's value or None
360# common: The common value to use for this identifier at the LOXI top level (TBD)
361# all_same: If True, all the values across all versions are the same
362# ofp_name: The original name for the identifier
363# ofp_group: The ofp enumerated type if defined
364
365identifiers = {}
366
367##
368# Identifiers by original group
369# Keys are the original group names. Value is a list of LOXI identifiers
370
371identifiers_by_group = {}
372
373## Ordered list of class names
374# This is per-wire-version and is a list of the classes in the order
375# they appear in the file. That is important because of the assumption
376# that data members are defined before they are included in a superclass.
377ordered_classes = {} # Indexed by wire version
378
379## Per class ordered list of member names
380ordered_members = {}
381
382## Ordered list of message classes
383ordered_messages = []
384
385## Ordered list of non message classes
386ordered_non_messages = []
387
388## The objects that need list support
389ordered_list_objects = []
390
391## Stats request/reply are pseudo objects
392ordered_pseudo_objects = []
393
394## Standard order is normally messages followed by non-messages
395standard_class_order = []
396
397## All classes in order, including psuedo classes for which most code
398# is not generated.
399all_class_order = []
400
401## Map from class, wire_version to size of fixed part of class
402base_length = {}
403
Andreas Wundsam53256162013-05-02 14:05:53 -0700404## Boolean indication of variable length, per class, wire_version,
Rich Lanea06d0c32013-03-25 08:52:03 -0700405is_fixed_length = set()
406
407## The global object ID counter
408object_id = 1 # Reserve 0 for root object
409
410## The unified view of all classes. See internal readme.
411unified = {}
412
413## Indicates data members with non-fixed start offsets
414# Indexed by (cls, version, member-name) and value is prev-member-name
415special_offsets = {}
416
417## Define Python variables with integer wire version values
418VERSION_1_0 = 1
419VERSION_1_1 = 2
420VERSION_1_2 = 3
421VERSION_1_3 = 4
422
423# Ignore version for some functions
424VERSION_ANY = -1
425
426## @var supported_wire_protos
427# The wire protocols this version of LoxiGen supports
428supported_wire_protos = set([1, 2, 3, 4])
429version_names = {1:"VERSION_1_0", 2:"VERSION_1_1", 3:"VERSION_1_2",
430 4:"VERSION_1_3"}
431short_version_names = {1:"OF_1_0", 2:"OF_1_1", 3:"OF_1_2", 4:"OF_1_3"}
432param_version_names = {1:"1.0", 2:"1.1", 3:"1.2", 4:"1.3"}
433
434##
435# Maps and ranges related to versioning
436
437# For parameter version indications
438of_param_version_map = {
439 "1.0":VERSION_1_0,
440 "1.1":VERSION_1_1,
441 "1.2":VERSION_1_2,
442 "1.3":VERSION_1_3
443 }
444
445# For parameter version indications
446of_version_map = {
447 "1.0":VERSION_1_0,
448 "1.1":VERSION_1_1,
449 "1.2":VERSION_1_2,
450 "1.3":VERSION_1_3
451 }
452
453# The iteration object that gives the wire versions supported
454of_version_range = [VERSION_1_0, VERSION_1_1, VERSION_1_2, VERSION_1_3]
455of_version_max = VERSION_1_3
456
457
458of_version_name2wire = dict(
459 OF_VERSION_1_0=VERSION_1_0,
460 OF_VERSION_1_1=VERSION_1_1,
461 OF_VERSION_1_2=VERSION_1_2,
462 OF_VERSION_1_3=VERSION_1_3
463 )
464
465of_version_wire2name = {
466 VERSION_1_0:"OF_VERSION_1_0",
467 VERSION_1_1:"OF_VERSION_1_1",
468 VERSION_1_2:"OF_VERSION_1_2",
469 VERSION_1_3:"OF_VERSION_1_3"
470 }
471
472
473################################################################
474#
475# Experimenters, vendors, extensions
476#
Andreas Wundsam53256162013-05-02 14:05:53 -0700477# Although the term "experimenter" is used for identifying
Rich Lanea06d0c32013-03-25 08:52:03 -0700478# external extension definitions, we generally use the term
479# extension when refering to the messages or objects themselves.
480#
481# Conventions:
482#
483# Extension messages should start with of_<experimenter>_
484# Extension actions should start with of_<experimenter>_action_
485# Extension instructions should start with of_<experimenter>_instructions_
486#
487# Currently, the above conventions are not enforced; the mapping
488# is done brute force in type_maps.py
489#
490################################################################
491
492# The map of known experimenters to their experimenter IDs
493experimenter_name_to_id = dict(
494 bsn = 0x005c16c7,
495 nicira = 0x00002320,
496 openflow = 0x000026e1
497 )
498
499def experimenter_name_lookup(experimenter_id):
500 """
501 Map an experimenter ID to its LOXI recognized name string
502 """
503 for name, id in of_g.experimenter_name_to_id.items():
504 if id == experimenter_id:
505 return name
506 return None
507
508################################################################
509#
510# Debug
511#
512################################################################
513
514loxigen_dbg_file = sys.stdout
515loxigen_log_file = sys.stdout
516
517################################################################
518#
519# Internal representation
520#
521################################################################
522
523class OFInput(object):
524 """
525 A single LOXI input file.
526 """
527
528 def __init__(self):
529 self.wire_versions = set()
530 self.classes = {}
531 self.ordered_classes = []
Rich Lane38388e62013-04-08 14:09:46 -0700532 self.enums = {}