blob: 2ae112d4de0008006d88c63f7457c5b0d7cfd884 [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
Rich Lanef1a89842014-10-12 10:04:13 -070034import loxi_globals
Rich Lanea06d0c32013-03-25 08:52:03 -070035
36################################################################
37#
38# Configuration global parameters
39#
40################################################################
41
42##
43# The map from wire protocol to enum identifier generated from input
44# This is built from the version-specific structs file info.
45# @fixme This should go away when the process structs file is updated
46wire_ver_map = {}
47
48##
Rich Lanea06d0c32013-03-25 08:52:03 -070049# The list of wire versions which are to be supported
50target_version_list = []
51
Rich Lanea06d0c32013-03-25 08:52:03 -070052##
53# The dictionary of config variables related to code
54#
Rich Lanea06d0c32013-03-25 08:52:03 -070055# @param use_obj_id Use object IDs in struct defns CURRENTLY NOT SUPPORTED
Andreas Wundsam53256162013-05-02 14:05:53 -070056#
Rich Lanea06d0c32013-03-25 08:52:03 -070057# @param return_base_types For 'get' accessors, return values when possible.
58# Otherwise all values are returned thru a call by variable parameter
59#
60# @param use_static_inlines Generate low level accessors as static inline
61# and put them in header files rather than .c files.
62#
63# @param copy_semantics One of "read", "write" or "grow". This defines the
64# way that buffer references are managed. Currently on "read" is supported.
65#
66# @param encode_typedefs Use object and member IDs (rather than names)
67# when generating the names used for accessor function typedefs
68#
Andreas Wundsam53256162013-05-02 14:05:53 -070069# @param get_returns One of "error", "value", or "void";
Rich Lanea06d0c32013-03-25 08:52:03 -070070# CURRENTLY ONLY "error" IS SUPPORTED. "error" means
71# all get operations return an error code. "value" means return a base_type
72# value when possible or void if not. "void" means always return void
73# and use a call-by-variable parameter
74#
75
Rich Lanea06d0c32013-03-25 08:52:03 -070076## These members do not get normal accessors
77
Rob Vaterlausb3f49d92013-10-01 17:57:31 -070078skip_members = ["version", "type", "length", "err_type", "stats_type", "len",
Rich Lane713d9282013-12-30 15:21:35 -080079 "type_len", "actions_len", "_command", "command", "key_length"]
Rich Lanea06d0c32013-03-25 08:52:03 -070080
81## Some OpenFlow string length constants
82#
83# These are a few length constants needed for array processing
84ofp_constants = dict(
85 OF_MAX_TABLE_NAME_LEN = 32,
86 OF_MAX_PORT_NAME_LEN = 16,
87 OF_ETH_ALEN = 6,
88 OF_DESC_STR_LEN = 256,
Praseed Balakrishnan7f718782014-09-18 17:02:48 -070089 OF_SERIAL_NUM_LEN = 32,
90 OF_APP_CODE_LEN = 15,
Praseed Balakrishnan2ed6da02014-09-18 17:02:48 -070091 OF_SIGID_LEN=6,
Rich Lanea06d0c32013-03-25 08:52:03 -070092)
93
94## List of mixed data types
95#
96# This is a list of data types which require special treatment
97# because the underlying datatype has changed between versions.
98# The main example is port which went from 16 to 32 bits. We
99# define per-version accessors for these types and those are
100# used in place of the normal ones.
101#
102# The wire protocol number is used to identify versions. For now,
103# the value is the name of the type to use for that version
104#
105# This is the map between the external type (like of_port_no_t)
Andreas Wundsam53256162013-05-02 14:05:53 -0700106# which is used by customers of this code and the internal
107# datatypes (like uint16_t) that appear on the wire for a
Rich Lanea06d0c32013-03-25 08:52:03 -0700108# particular version.
109#
110of_mixed_types = dict(
111 of_port_no_t = {
112 1: "uint16_t",
113 2: "uint32_t",
114 3: "uint32_t",
115 4: "uint32_t",
Rich Lane2dd17012014-10-16 09:55:10 -0700116 5: "uint32_t",
Rich Lanea06d0c32013-03-25 08:52:03 -0700117 "short_name":"port_no"
118 },
119 of_port_desc_t = {
120 1: "of_port_desc_t",
121 2: "of_port_desc_t",
122 3: "of_port_desc_t",
123 4: "of_port_desc_t",
Rich Lane2dd17012014-10-16 09:55:10 -0700124 5: "of_port_desc_t",
Rich Lanea06d0c32013-03-25 08:52:03 -0700125 "short_name":"port_desc"
126 },
Dan Talaycoc0e802e2013-05-18 23:52:39 -0700127 of_bsn_vport_t = {
128 1: "of_bsn_vport_t",
129 2: "of_bsn_vport_t",
130 3: "of_bsn_vport_t",
131 4: "of_bsn_vport_t",
Rich Lane2dd17012014-10-16 09:55:10 -0700132 5: "of_bsn_vport_t",
Dan Talaycoc0e802e2013-05-18 23:52:39 -0700133 "short_name":"bsn_vport"
134 },
Rich Lanea06d0c32013-03-25 08:52:03 -0700135 of_fm_cmd_t = { # Flow mod command went from u16 to u8
136 1: "uint16_t",
137 2: "uint8_t",
138 3: "uint8_t",
139 4: "uint8_t",
Rich Lane2dd17012014-10-16 09:55:10 -0700140 5: "uint8_t",
Rich Lanea06d0c32013-03-25 08:52:03 -0700141 "short_name":"fm_cmd"
142 },
143 of_wc_bmap_t = { # Wildcard bitmap
144 1: "uint32_t",
145 2: "uint32_t",
146 3: "uint64_t",
147 4: "uint64_t",
Rich Lane2dd17012014-10-16 09:55:10 -0700148 5: "uint64_t",
Rich Lanea06d0c32013-03-25 08:52:03 -0700149 "short_name":"wc_bmap"
150 },
151 of_match_bmap_t = { # Match bitmap
152 1: "uint32_t",
153 2: "uint32_t",
154 3: "uint64_t",
155 4: "uint64_t",
Rich Lane2dd17012014-10-16 09:55:10 -0700156 5: "uint64_t",
Rich Lanea06d0c32013-03-25 08:52:03 -0700157 "short_name":"match_bmap"
158 },
159 of_match_t = { # Match object
160 1: "of_match_v1_t",
161 2: "of_match_v2_t",
162 3: "of_match_v3_t",
163 4: "of_match_v3_t", # Currently uses same match as 1.2 (v3).
Rich Lane2dd17012014-10-16 09:55:10 -0700164 5: "of_match_v3_t", # Currently uses same match as 1.2 (v3).
Rich Lanea06d0c32013-03-25 08:52:03 -0700165 "short_name":"match"
166 },
Marc De Leenheer88c0bcb2015-07-24 15:49:19 -0700167 of_calient_port_desc_stats_entry_t = {
168 1: "of_calient_port_desc_stats_entry_t",
169 2: "of_calient_port_desc_stats_entry_t",
170 3: "of_calient_port_desc_stats_entry_t",
171 4: "of_calient_port_desc_stats_entry_t",
172 5: "of_calient_port_desc_stats_entry_t",
173 "short_name":"calient_port_desc_stats_entry"
174 },
175
Rich Lanea06d0c32013-03-25 08:52:03 -0700176)
177
178## Base data types
179#
180# The basic types; Value is a list: bytes, to_wire, from_wire
181# The accessors deal with endian, alignment and any other host/network
182# considerations. These are common across all versions
183#
184# For get accessors, assume we memcpy from wire buf and then apply ntoh
185# For set accessors, assume we apply hton and then memcpy to wire buf
186#
187# to/from wire functions take a pointer to class and change in place
188of_base_types = dict(
189 char = dict(bytes=1, use_as_rv=1, short_name="char"),
190 uint8_t = dict(bytes=1, use_as_rv=1, short_name="u8"),
191 uint16_t = dict(bytes=2, to_w="u16_hton", from_w="u16_ntoh", use_as_rv=1,
192 short_name="u16"),
193 uint32_t = dict(bytes=4, to_w="u32_hton", from_w="u32_ntoh", use_as_rv=1,
194 short_name="u32"),
195 uint64_t = dict(bytes=8, to_w="u64_hton", from_w="u64_ntoh", use_as_rv=1,
196 short_name="u64"),
197# of_cookie_t = dict(bytes=8, to_w="u64_hton", from_w="u64_ntoh", use_as_rv=1#,
198# short_name="cookie"),
199# of_counter_t = dict(bytes=8, to_w="u64_hton", from_w="u64_ntoh", use_as_rv=1,
200# short_name="counter"),
201 of_mac_addr_t = dict(bytes=6, short_name="mac"),
Andreas Wundsamb566a162013-07-18 19:30:23 -0700202 of_ipv4_t = dict(bytes=4, short_name="ipv4"),
Rich Lanea06d0c32013-03-25 08:52:03 -0700203 of_ipv6_t = dict(bytes=16, short_name="ipv6"),
204 of_port_name_t = dict(bytes=ofp_constants["OF_MAX_PORT_NAME_LEN"],
205 short_name="port_name"),
206 of_table_name_t = dict(bytes=ofp_constants["OF_MAX_TABLE_NAME_LEN"],
207 short_name="tab_name"),
208 of_desc_str_t = dict(bytes=ofp_constants["OF_DESC_STR_LEN"],
209 short_name="desc_str"),
210 of_serial_num_t = dict(bytes=ofp_constants["OF_SERIAL_NUM_LEN"],
211 short_name="ser_num"),
Rich Lanef8a3d002014-03-19 13:33:52 -0700212 of_str64_t = dict(bytes=64, short_name="str64"),
Brian O'Connor58a73e32015-05-28 11:51:27 -0700213 of_str32_t = dict(bytes=32, short_name="str32"),
214 of_str6_t = dict(bytes=6, short_name="str6"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700215 of_match_v1_t = dict(bytes=40, to_w="match_v1_hton",
216 from_w="match_v1_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700217 short_name="match_v1"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700218 of_match_v2_t = dict(bytes=88, to_w="match_v2_hton",
219 from_w="match_v2_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700220 short_name="match_v2"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700221 of_match_v3_t = dict(bytes=-1, to_w="match_v3_hton",
222 from_w="match_v3_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700223 short_name="match_v3"),
Andreas Wundsam53256162013-05-02 14:05:53 -0700224# of_match_v4_t = dict(bytes=-1, to_w="match_v4_hton",
225# from_w="match_v4_ntoh",
Rich Lanea06d0c32013-03-25 08:52:03 -0700226# short_name="match_v4"),
Rich Lane3b2fd832013-09-24 13:44:08 -0700227 of_octets_t = dict(bytes=-1, short_name="octets"),
228 of_bitmap_128_t = dict(bytes=16, short_name="bitmap_128"),
Rich Lane119289c2014-12-01 13:44:08 -0800229 of_bitmap_512_t = dict(bytes=64, short_name="bitmap_512"),
Rich Lanefab0c822013-12-30 11:46:48 -0800230 of_checksum_128_t = dict(bytes=16, short_name="checksum_128"),
Praseed Balakrishnan7f718782014-09-18 17:02:48 -0700231 of_app_code_t = dict(bytes=ofp_constants["OF_APP_CODE_LEN"],
232 short_name="app_code"),
Praseed Balakrishnan2ed6da02014-09-18 17:02:48 -0700233 of_sig_id_t = dict(bytes=ofp_constants["OF_SIGID_LEN"],
234 short_name="sig_id"),
Rich Lanea06d0c32013-03-25 08:52:03 -0700235)
236
237of_scalar_types = ["char", "uint8_t", "uint16_t", "uint32_t", "uint64_t",
238 "of_port_no_t", "of_fm_cmd_t", "of_wc_bmap_t",
239 "of_match_bmap_t", "of_port_name_t", "of_table_name_t",
Andreas Wundsam53256162013-05-02 14:05:53 -0700240 "of_desc_str_t", "of_serial_num_t", "of_mac_addr_t",
Rich Lanef8a3d002014-03-19 13:33:52 -0700241 "of_ipv6_t", "of_ipv4_t", "of_bitmap_128_t", "of_checksum_128_t",
Brian O'Connor58a73e32015-05-28 11:51:27 -0700242 "of_str64_t", "of_str32_t", "of_str6_t", "of_bitmap_512_t"]
Rich Lanea06d0c32013-03-25 08:52:03 -0700243
Rich Lanea06d0c32013-03-25 08:52:03 -0700244##
245# LOXI identifiers
246#
247# Dict indexed by identifier name. Each entry contains the information
248# as a DotDict with the following keys:
249# values: A dict indexed by wire version giving each verion's value or None
250# common: The common value to use for this identifier at the LOXI top level (TBD)
251# all_same: If True, all the values across all versions are the same
252# ofp_name: The original name for the identifier
253# ofp_group: The ofp enumerated type if defined
254
255identifiers = {}
256
257##
258# Identifiers by original group
259# Keys are the original group names. Value is a list of LOXI identifiers
260
261identifiers_by_group = {}
262
263## Ordered list of class names
264# This is per-wire-version and is a list of the classes in the order
265# they appear in the file. That is important because of the assumption
266# that data members are defined before they are included in a superclass.
267ordered_classes = {} # Indexed by wire version
268
269## Per class ordered list of member names
270ordered_members = {}
271
272## Ordered list of message classes
273ordered_messages = []
274
275## Ordered list of non message classes
276ordered_non_messages = []
277
278## The objects that need list support
279ordered_list_objects = []
280
281## Stats request/reply are pseudo objects
282ordered_pseudo_objects = []
283
284## Standard order is normally messages followed by non-messages
285standard_class_order = []
286
287## All classes in order, including psuedo classes for which most code
288# is not generated.
289all_class_order = []
290
291## Map from class, wire_version to size of fixed part of class
292base_length = {}
293
Andreas Wundsam53256162013-05-02 14:05:53 -0700294## Boolean indication of variable length, per class, wire_version,
Rich Lanea06d0c32013-03-25 08:52:03 -0700295is_fixed_length = set()
296
297## The global object ID counter
298object_id = 1 # Reserve 0 for root object
299
300## The unified view of all classes. See internal readme.
301unified = {}
302
303## Indicates data members with non-fixed start offsets
304# Indexed by (cls, version, member-name) and value is prev-member-name
305special_offsets = {}
306
Rich Lanef1a89842014-10-12 10:04:13 -0700307# Map from wire version to OF_1_x
308short_version_names = {}
Rich Lanea06d0c32013-03-25 08:52:03 -0700309
310# The iteration object that gives the wire versions supported
Rich Lanef1a89842014-10-12 10:04:13 -0700311of_version_range = []
Rich Lanea06d0c32013-03-25 08:52:03 -0700312
Rich Lanef1a89842014-10-12 10:04:13 -0700313# Map from wire version to OF_VERSION_1_x
314of_version_wire2name = {}
315
316for version in loxi_globals.OFVersions.all_supported:
317 v = version.version.replace('.', '_')
318 short_version_names[version.wire_version] = 'OF_' + v
319 of_version_range.append(version.wire_version)
320 of_version_wire2name[version.wire_version] = 'OF_VERSION_' + v
321 globals()['VERSION_' + v] = version.wire_version
Rich Lanea06d0c32013-03-25 08:52:03 -0700322
323
324################################################################
325#
326# Experimenters, vendors, extensions
327#
Andreas Wundsam53256162013-05-02 14:05:53 -0700328# Although the term "experimenter" is used for identifying
Rich Lanea06d0c32013-03-25 08:52:03 -0700329# external extension definitions, we generally use the term
330# extension when refering to the messages or objects themselves.
331#
332# Conventions:
333#
334# Extension messages should start with of_<experimenter>_
335# Extension actions should start with of_<experimenter>_action_
336# Extension instructions should start with of_<experimenter>_instructions_
337#
338# Currently, the above conventions are not enforced; the mapping
339# is done brute force in type_maps.py
340#
341################################################################
342
343# The map of known experimenters to their experimenter IDs
344experimenter_name_to_id = dict(
345 bsn = 0x005c16c7,
346 nicira = 0x00002320,
347 openflow = 0x000026e1
348 )