blob: c65cfedaaa86ffaba488847a27b9f8dacd5b8376 [file] [log] [blame]
Andreas Wundsamd30c1072013-11-15 13:36:57 -08001## List of mixed data types
2#
3# This is a list of data types which require special treatment
4# because the underlying datatype has changed between versions.
5# The main example is port which went from 16 to 32 bits. We
6# define per-version accessors for these types and those are
7# used in place of the normal ones.
8#
9# The wire protocol number is used to identify versions. For now,
10# the value is the name of the type to use for that version
11#
12# This is the map between the external type (like of_port_no_t)
13# which is used by customers of this code and the internal
14# datatypes (like uint16_t) that appear on the wire for a
15# particular version.
16#
17from collections import namedtuple
18import logging
19
20import loxi_front_end.frontend_ir as fe
21import loxi_ir.ir
22
23ofp_constants = dict(
24 OF_MAX_TABLE_NAME_LEN = 32,
25 OF_MAX_PORT_NAME_LEN = 16,
26 OF_ETH_ALEN = 6,
27 OF_DESC_STR_LEN = 256,
28 OF_SERIAL_NUM_LEN = 32
29)
30
31
32of_mixed_types = dict(
33 of_port_no_t = {
34 1: "uint16_t",
35 2: "uint32_t",
36 3: "uint32_t",
37 4: "uint32_t",
alshabib9f50e482014-08-23 17:10:57 -050038 5: "uint32_t",
Andreas Wundsamd30c1072013-11-15 13:36:57 -080039 "short_name":"port_no"
40 },
41 of_port_desc_t = {
42 1: "of_port_desc_t",
43 2: "of_port_desc_t",
44 3: "of_port_desc_t",
45 4: "of_port_desc_t",
alshabib9f50e482014-08-23 17:10:57 -050046 5: "of_port_desc_t",
Andreas Wundsamd30c1072013-11-15 13:36:57 -080047 "short_name":"port_desc"
48 },
49 of_bsn_vport_t = {
50 1: "of_bsn_vport_t",
51 2: "of_bsn_vport_t",
52 3: "of_bsn_vport_t",
53 4: "of_bsn_vport_t",
alshabib9f50e482014-08-23 17:10:57 -050054 5: "of_bsn_vport_t",
Andreas Wundsamd30c1072013-11-15 13:36:57 -080055 "short_name":"bsn_vport"
56 },
57 of_fm_cmd_t = { # Flow mod command went from u16 to u8
58 1: "uint16_t",
59 2: "uint8_t",
60 3: "uint8_t",
61 4: "uint8_t",
alshabib9f50e482014-08-23 17:10:57 -050062 5: "uint8_t",
Andreas Wundsamd30c1072013-11-15 13:36:57 -080063 "short_name":"fm_cmd"
64 },
65 of_wc_bmap_t = { # Wildcard bitmap
66 1: "uint32_t",
67 2: "uint32_t",
68 3: "uint64_t",
69 4: "uint64_t",
alshabib9f50e482014-08-23 17:10:57 -050070 5: "uint64_t",
Andreas Wundsamd30c1072013-11-15 13:36:57 -080071 "short_name":"wc_bmap"
72 },
73 of_match_bmap_t = { # Match bitmap
74 1: "uint32_t",
75 2: "uint32_t",
76 3: "uint64_t",
77 4: "uint64_t",
alshabib9f50e482014-08-23 17:10:57 -050078 5: "uint64_t",
Andreas Wundsamd30c1072013-11-15 13:36:57 -080079 "short_name":"match_bmap"
80 },
81 of_match_t = { # Match object
82 1: "of_match_v1_t",
83 2: "of_match_v2_t",
84 3: "of_match_v3_t",
85 4: "of_match_v3_t", # Currently uses same match as 1.2 (v3).
alshabib9f50e482014-08-23 17:10:57 -050086 5: "of_match_v3_t", # Currently uses same match as 1.2 (v3).
Andreas Wundsamd30c1072013-11-15 13:36:57 -080087 "short_name":"match"
88 },
89)
90
91## basic lengths
92of_base_lengths = dict(
93 char = (1, True),
94 uint8_t = (1, True),
95 uint16_t = (2, True),
96 uint32_t = (4, True),
97 uint64_t = (8, True),
98 of_mac_addr_t = (6, True),
99 of_ipv4_t = (4, True),
100 of_ipv6_t = (16, True),
101 of_port_name_t = (ofp_constants["OF_MAX_PORT_NAME_LEN"], True),
102 of_table_name_t = (ofp_constants["OF_MAX_TABLE_NAME_LEN"], True),
103 of_desc_str_t = (ofp_constants["OF_DESC_STR_LEN"], True),
104 of_serial_num_t = (ofp_constants["OF_SERIAL_NUM_LEN"], True),
Rich Lanef8a3d002014-03-19 13:33:52 -0700105 of_str64_t = (64, True),
Andreas Wundsamd30c1072013-11-15 13:36:57 -0800106 of_match_v1_t = (40, True),
107 of_match_v2_t = (88, True),
108 of_match_v3_t = (8, False),
109 of_octets_t = (0, False),
110 of_bitmap_128_t = (16, True),
Rich Lane51833982013-12-03 13:02:45 -0800111 of_checksum_128_t = (16, True),
Andreas Wundsamd30c1072013-11-15 13:36:57 -0800112)
113
114def type_dec_to_count_base(m_type):
115 """
116 Resolve a type declaration like uint8_t[4] to a count (4) and base_type
117 (uint8_t)
118
119 @param m_type The string type declaration to process
120 """
121 count = 1
122 chk_ar = m_type.split('[')
123 if len(chk_ar) > 1:
124 count_str = chk_ar[1].split(']')[0]
125 if count_str in ofp_constants:
126 count = ofp_constants[count_str]
127 else:
128 count = int(count_str)
129 base_type = chk_ar[0]
130 else:
131 base_type = m_type
132 return count, base_type
133
134
135LengthInfo = namedtuple("LengthInfo", ("offset", "base_length", "is_fixed_length"))
136
137def calc_lengths(version, fe_class, existing_classes, existing_enums):
138 offset_fixed = True
139 offset = 0
140
141 member_infos = {}
142 for member in fe_class.members:
143 member_offset = offset if offset_fixed else None
144
145 if isinstance(member, fe.OFPadMember):
146 member_base_length = member.length
147 member_fixed_length = True
148 else:
149 m_type = member.oftype
150 name = member.name
151
152 member_base_length = 0
153 if m_type.find("list(") == 0:
154 member_fixed_length = False
155 elif m_type.find("struct") == 0:
156 raise Exception("Error: recursive struct found: {}, {}"
157 .format(fe_class.name, name))
158 elif m_type == "octets":
159 member_fixed_length = False
160 else:
161 member_base_length, member_fixed_length = member_length(version, fe_class, member, existing_classes, existing_enums)
162
163 if not member_fixed_length:
164 offset_fixed = False
165
166 member_infos[member] = LengthInfo(member_offset, member_base_length,
167 member_fixed_length)
168 offset += member_base_length
169
170 base_length = offset
171 fixed_length = offset_fixed if not fe_class.virtual else False
172 return (base_length, fixed_length, member_infos)
173
174def member_length(version, fe_class, fe_member, existing_classes, existing_enums):
175 """
176 return the length of an ir member.
177
178 @return tuple (base_length, length_fixed)
179 """
180 count, base_type = type_dec_to_count_base(fe_member.oftype)
181
Andreas Wundsamd30c1072013-11-15 13:36:57 -0800182 if base_type in of_mixed_types:
183 base_type = of_mixed_types[base_type][version.wire_version]
184
185 base_class = base_type[:-2]
186 if base_class in existing_classes:
187 member_ir_class = existing_classes[base_class]
188 bytes = member_ir_class.base_length
189 length_fixed = member_ir_class.is_fixed_length
190 else:
191 if base_type in existing_enums:
192 enum = existing_enums[base_type]
193 base_type = enum.wire_type
194
195 if base_type in of_base_lengths:
196 bytes, length_fixed = of_base_lengths[base_type]
197 else:
198 raise Exception("Unknown type for {}.{}: {}".format(fe_class.name, fe_member.name, base_type))
199
200 return (count * bytes), length_fixed