Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1 | # 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 | # @brief Generate wire to generic match conversion functions |
| 29 | # |
| 30 | # @fixme This has lots of C specific code that should be moved into c_gen |
| 31 | |
| 32 | # of_match_to_wire_match(match, wire_match) |
| 33 | # of_wire_match_to_match(wire_match, match) |
| 34 | # Version is taken from the source in each case |
| 35 | # |
| 36 | # name |
| 37 | # type |
| 38 | # conditions |
| 39 | # v3 ident |
| 40 | # takes mask |
| 41 | |
| 42 | import sys |
Andreas Wundsam | 542a13c | 2013-11-15 13:28:55 -0800 | [diff] [blame] | 43 | import c_gen.of_g_legacy as of_g |
| 44 | import c_gen.match as match |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 45 | import c_code_gen |
| 46 | |
| 47 | def match_c_top_matter(out, name): |
| 48 | """ |
| 49 | Generate top matter for match C file |
| 50 | |
| 51 | @param name The name of the output file |
| 52 | @param out The output file object |
| 53 | """ |
| 54 | c_code_gen.common_top_matter(out, name) |
| 55 | out.write("#include \"loci_log.h\"\n") |
| 56 | out.write("#include <loci/loci.h>\n") |
| 57 | |
| 58 | def match_h_top_matter(out, name): |
| 59 | """ |
| 60 | Generate top matter for the C file |
| 61 | |
| 62 | @param name The name of the output file |
| 63 | @param ih_name The name of the internal header file |
| 64 | @param out The output file object |
| 65 | """ |
| 66 | c_code_gen.common_top_matter(out, name) |
| 67 | out.write(""" |
| 68 | #include <loci/loci_base.h> |
| 69 | """) |
| 70 | |
| 71 | def gen_declarations(out): |
| 72 | out.write(""" |
| 73 | /* |
| 74 | * Match serialize/deserialize declarations |
| 75 | * Wire match conversion function declarations |
| 76 | */ |
| 77 | extern int of_match_serialize(of_version_t version, of_match_t *match, |
| 78 | of_octets_t *octets); |
| 79 | extern int of_match_deserialize(of_version_t version, of_match_t *match, |
| 80 | of_octets_t *octets); |
| 81 | extern int of_match_v1_to_match(of_match_v1_t *src, of_match_t *dst); |
| 82 | extern int of_match_v2_to_match(of_match_v2_t *src, of_match_t *dst); |
| 83 | extern int of_match_v3_to_match(of_match_v3_t *src, of_match_t *dst); |
| 84 | extern int of_match_to_wire_match_v1(of_match_t *src, of_match_v1_t *dst); |
| 85 | extern int of_match_to_wire_match_v2(of_match_t *src, of_match_v2_t *dst); |
| 86 | extern int of_match_to_wire_match_v3(of_match_t *src, of_match_v3_t *dst); |
| 87 | """) |
| 88 | |
| 89 | def gen_v4_match_compat(out): |
| 90 | """ |
| 91 | Code for coercing version 1.3 matches to 1.2 matches |
| 92 | |
| 93 | @FIXME This is a stopgap and needs to get cleaned up. |
| 94 | """ |
| 95 | out.write(""" |
| 96 | /** |
| 97 | * Definitions to coerce v4 match (version 1.3) to v3 matches |
| 98 | * (version 1.2). |
| 99 | * @FIXME This is a stopgap and needs to get cleaned up. |
| 100 | */ |
| 101 | #define of_match_v4_t of_match_v3_t |
| 102 | #define of_match_v4_init of_match_v3_init |
| 103 | #define of_match_v4_new of_match_v3_new |
| 104 | #define of_match_v4_to_match of_match_v3_to_match |
| 105 | #define of_match_to_wire_match_v4 of_match_to_wire_match_v3 |
| 106 | #define of_match_v4_delete of_match_v3_delete |
| 107 | """) |
| 108 | |
| 109 | def gen_match_macros(out): |
| 110 | out.write(""" |
| 111 | |
| 112 | /** |
| 113 | * Definitions for wildcard macros for OF_VERSION_1_0 |
| 114 | */ |
| 115 | |
| 116 | """) |
| 117 | for key in match.of_v1_keys: |
| 118 | entry = match.of_match_members[key] |
| 119 | if "v1_wc_shift" in entry: |
| 120 | if key in ["ipv4_src", "ipv4_dst"]: |
| 121 | out.write(""" |
| 122 | #define OF_MATCH_V1_WC_%(ku)s_SHIFT %(val)d |
| 123 | #define OF_MATCH_V1_WC_%(ku)s_MASK (0x3f << %(val)d) |
| 124 | #define OF_MATCH_V1_WC_%(ku)s_CLEAR(wc) ((wc) &= ~(0x3f << %(val)d)) |
| 125 | #define OF_MATCH_V1_WC_%(ku)s_SET(wc, value) do { \\ |
| 126 | OF_MATCH_V1_WC_%(ku)s_CLEAR(wc); \\ |
| 127 | ((wc) |= (((value) & 0x3f) << %(val)d)); \\ |
| 128 | } while (0) |
| 129 | #define OF_MATCH_V1_WC_%(ku)s_TEST(wc) ((wc) & (0x3f << %(val)d)) |
| 130 | #define OF_MATCH_V1_WC_%(ku)s_GET(wc) (((wc) >> %(val)d) & 0x3f) |
| 131 | """ % dict(ku=key.upper(), val=entry["v1_wc_shift"])) |
| 132 | else: |
| 133 | out.write(""" |
| 134 | #define OF_MATCH_V1_WC_%(ku)s_SHIFT %(val)d |
| 135 | #define OF_MATCH_V1_WC_%(ku)s_MASK (1 << %(val)d) |
| 136 | #define OF_MATCH_V1_WC_%(ku)s_SET(wc) ((wc) |= (1 << %(val)d)) |
| 137 | #define OF_MATCH_V1_WC_%(ku)s_CLEAR(wc) ((wc) &= ~(1 << %(val)d)) |
| 138 | #define OF_MATCH_V1_WC_%(ku)s_TEST(wc) ((wc) & (1 << %(val)d)) |
| 139 | """ % dict(ku=key.upper(), val=entry["v1_wc_shift"])) |
| 140 | |
| 141 | out.write(""" |
| 142 | |
| 143 | /** |
| 144 | * Definitions for wildcard macros for OF_VERSION_1_1 |
| 145 | */ |
| 146 | """) |
| 147 | |
| 148 | for key in sorted(match.of_v2_keys): |
| 149 | entry = match.of_match_members[key] |
| 150 | if "v2_wc_shift" in entry: |
| 151 | out.write(""" |
| 152 | #define OF_MATCH_V2_WC_%(ku)s_SHIFT %(val)d |
| 153 | #define OF_MATCH_V2_WC_%(ku)s_MASK (1 << %(val)d) |
| 154 | #define OF_MATCH_V2_WC_%(ku)s_SET(wc) ((wc) |= (1 << %(val)d)) |
| 155 | #define OF_MATCH_V2_WC_%(ku)s_CLEAR(wc) ((wc) &= ~(1 << %(val)d)) |
| 156 | #define OF_MATCH_V2_WC_%(ku)s_TEST(wc) ((wc) & (1 << %(val)d)) |
| 157 | """ % dict(ku=key.upper(), val=entry["v2_wc_shift"])) |
| 158 | |
| 159 | |
| 160 | def gen_match_struct(out=sys.stdout): |
| 161 | out.write("/* Unified, flat OpenFlow match structure based on OF 1.2 */\n") |
| 162 | out.write("typedef struct of_match_fields_s {\n") |
| 163 | out.write(" /* Version 1.2 is used for field names */\n") |
| 164 | for name in match.match_keys_sorted: |
| 165 | entry = match.of_match_members[name] |
| 166 | out.write(" %-20s %s;\n" % (entry["m_type"], entry["name"])) |
| 167 | out.write(""" |
| 168 | } of_match_fields_t; |
| 169 | |
| 170 | /** |
| 171 | * @brief The LOCI match structure. |
| 172 | */ |
| 173 | |
| 174 | typedef struct of_match_s { |
| 175 | of_version_t version; |
| 176 | of_match_fields_t fields; |
| 177 | of_match_fields_t masks; |
| 178 | } of_match_t; |
| 179 | |
Rich Lane | 68798a5 | 2014-04-16 14:57:52 -0700 | [diff] [blame] | 180 | /* |
| 181 | * AND 'len' bytes starting from 'value' with the corresponding byte in |
| 182 | * 'mask'. |
Dan Talayco | fb50d38 | 2013-08-05 16:00:17 -0700 | [diff] [blame] | 183 | */ |
Rich Lane | d5f2345 | 2014-04-03 01:16:37 -0700 | [diff] [blame] | 184 | static inline void |
Rich Lane | 68798a5 | 2014-04-16 14:57:52 -0700 | [diff] [blame] | 185 | of_memmask(void *value, const void *mask, size_t len) |
Dan Talayco | fb50d38 | 2013-08-05 16:00:17 -0700 | [diff] [blame] | 186 | { |
Rich Lane | 68798a5 | 2014-04-16 14:57:52 -0700 | [diff] [blame] | 187 | int i; |
| 188 | uint8_t *v = value; |
| 189 | const uint8_t *m = mask; |
Dan Talayco | fb50d38 | 2013-08-05 16:00:17 -0700 | [diff] [blame] | 190 | |
Rich Lane | 68798a5 | 2014-04-16 14:57:52 -0700 | [diff] [blame] | 191 | for (i = 0; i < len; i++) { |
| 192 | v[i] &= m[i]; |
Dan Talayco | fb50d38 | 2013-08-05 16:00:17 -0700 | [diff] [blame] | 193 | } |
| 194 | } |
| 195 | |
| 196 | /** |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 197 | * IP Mask map. IP maks wildcards from OF 1.0 are interpretted as |
| 198 | * indices into the map below. |
| 199 | * |
| 200 | * of_ip_mask_map: Array mapping index to mask |
| 201 | * of_ip_mask_use_map: Boolean indication set when map is initialized |
| 202 | * of_ip_mask_map_init: Initialize to default values; set "use map". |
| 203 | */ |
| 204 | #define OF_IP_MASK_MAP_COUNT 64 |
| 205 | extern uint32_t of_ip_mask_map[OF_IP_MASK_MAP_COUNT]; |
| 206 | extern int of_ip_mask_map_init_done; |
| 207 | |
| 208 | #define OF_IP_MASK_INIT_CHECK \ |
| 209 | if (!of_ip_mask_map_init_done) of_ip_mask_map_init() |
| 210 | |
| 211 | /** |
| 212 | * Initialize map |
| 213 | */ |
| 214 | extern void of_ip_mask_map_init(void); |
| 215 | |
| 216 | extern int of_ip_mask_map_set(int index, uint32_t mask); |
| 217 | extern int of_ip_mask_map_get(int index, uint32_t *mask); |
| 218 | |
| 219 | /** |
| 220 | * @brief Map from mask to index |
| 221 | */ |
| 222 | |
| 223 | extern int of_ip_mask_to_index(uint32_t mask); |
| 224 | |
| 225 | /** |
| 226 | * @brief Map from index to mask |
| 227 | */ |
| 228 | |
| 229 | extern uint32_t of_ip_index_to_mask(int index); |
| 230 | |
| 231 | /** |
| 232 | * The signalling of an untagged packet varies by OF version. |
| 233 | * Use this macro to set the field value. |
| 234 | */ |
| 235 | #define OF_MATCH_UNTAGGED_VLAN_ID(version) \\ |
| 236 | ((version) == OF_VERSION_1_0 ? 0xffff : \\ |
| 237 | ((version) == OF_VERSION_1_1 ? 0xffff : 0)) |
| 238 | |
| 239 | /** |
| 240 | * Version 1.1 had the notion of "any" vlan but must be set |
| 241 | */ |
| 242 | #define OF_MATCH_VLAN_TAG_PRESENT_ANY_ID(version) \\ |
| 243 | ((version) == OF_VERSION_1_0 ? 0 /* @fixme */ : \\ |
| 244 | ((version) == OF_VERSION_1_1 ? 0xfffe : 0x1000)) |
| 245 | """) |
| 246 | |
| 247 | def gen_oxm_defines(out): |
| 248 | """ |
| 249 | Generate verbatim definitions for OXM |
| 250 | """ |
| 251 | out.write(""" |
| 252 | |
| 253 | /* These are from the OpenFlow 1.2 header file */ |
| 254 | |
| 255 | /* OXM index values for bitmaps and parsing */ |
| 256 | enum of_oxm_index_e { |
| 257 | OF_OXM_INDEX_IN_PORT = 0, /* Switch input port. */ |
| 258 | OF_OXM_INDEX_IN_PHY_PORT = 1, /* Switch physical input port. */ |
| 259 | OF_OXM_INDEX_METADATA = 2, /* Metadata passed between tables. */ |
| 260 | OF_OXM_INDEX_ETH_DST = 3, /* Ethernet destination address. */ |
| 261 | OF_OXM_INDEX_ETH_SRC = 4, /* Ethernet source address. */ |
| 262 | OF_OXM_INDEX_ETH_TYPE = 5, /* Ethernet frame type. */ |
| 263 | OF_OXM_INDEX_VLAN_VID = 6, /* VLAN id. */ |
| 264 | OF_OXM_INDEX_VLAN_PCP = 7, /* VLAN priority. */ |
| 265 | OF_OXM_INDEX_IP_DSCP = 8, /* IP DSCP (6 bits in ToS field). */ |
| 266 | OF_OXM_INDEX_IP_ECN = 9, /* IP ECN (2 bits in ToS field). */ |
| 267 | OF_OXM_INDEX_IP_PROTO = 10, /* IP protocol. */ |
| 268 | OF_OXM_INDEX_IPV4_SRC = 11, /* IPv4 source address. */ |
| 269 | OF_OXM_INDEX_IPV4_DST = 12, /* IPv4 destination address. */ |
| 270 | OF_OXM_INDEX_TCP_SRC = 13, /* TCP source port. */ |
| 271 | OF_OXM_INDEX_TCP_DST = 14, /* TCP destination port. */ |
| 272 | OF_OXM_INDEX_UDP_SRC = 15, /* UDP source port. */ |
| 273 | OF_OXM_INDEX_UDP_DST = 16, /* UDP destination port. */ |
| 274 | OF_OXM_INDEX_SCTP_SRC = 17, /* SCTP source port. */ |
| 275 | OF_OXM_INDEX_SCTP_DST = 18, /* SCTP destination port. */ |
| 276 | OF_OXM_INDEX_ICMPV4_TYPE = 19, /* ICMP type. */ |
| 277 | OF_OXM_INDEX_ICMPV4_CODE = 20, /* ICMP code. */ |
| 278 | OF_OXM_INDEX_ARP_OP = 21, /* ARP opcode. */ |
| 279 | OF_OXM_INDEX_ARP_SPA = 22, /* ARP source IPv4 address. */ |
| 280 | OF_OXM_INDEX_ARP_TPA = 23, /* ARP target IPv4 address. */ |
| 281 | OF_OXM_INDEX_ARP_SHA = 24, /* ARP source hardware address. */ |
| 282 | OF_OXM_INDEX_ARP_THA = 25, /* ARP target hardware address. */ |
| 283 | OF_OXM_INDEX_IPV6_SRC = 26, /* IPv6 source address. */ |
| 284 | OF_OXM_INDEX_IPV6_DST = 27, /* IPv6 destination address. */ |
| 285 | OF_OXM_INDEX_IPV6_FLABEL = 28, /* IPv6 Flow Label */ |
| 286 | OF_OXM_INDEX_ICMPV6_TYPE = 29, /* ICMPv6 type. */ |
| 287 | OF_OXM_INDEX_ICMPV6_CODE = 30, /* ICMPv6 code. */ |
| 288 | OF_OXM_INDEX_IPV6_ND_TARGET = 31, /* Target address for ND. */ |
| 289 | OF_OXM_INDEX_IPV6_ND_SLL = 32, /* Source link-layer for ND. */ |
| 290 | OF_OXM_INDEX_IPV6_ND_TLL = 33, /* Target link-layer for ND. */ |
| 291 | OF_OXM_INDEX_MPLS_LABEL = 34, /* MPLS label. */ |
| 292 | OF_OXM_INDEX_MPLS_TC = 35, /* MPLS TC. */ |
Byungjoon Lee | 09b5377 | 2014-05-12 16:36:32 +0900 | [diff] [blame^] | 293 | OF_OXM_INDEX_TUNNEL_ID = 38, /* Logical Port Metadata. */ |
Rich Lane | d8d29c9 | 2013-09-24 13:46:42 -0700 | [diff] [blame] | 294 | |
| 295 | OF_OXM_INDEX_BSN_IN_PORTS_128 = 36, |
Rich Lane | 6171836 | 2013-10-24 16:59:42 -0700 | [diff] [blame] | 296 | OF_OXM_INDEX_BSN_LAG_ID = 37, |
Rich Lane | eb21c4f | 2013-10-28 17:34:41 -0700 | [diff] [blame] | 297 | OF_OXM_INDEX_BSN_VRF = 38, |
| 298 | OF_OXM_INDEX_BSN_GLOBAL_VRF_ALLOWED = 39, |
| 299 | OF_OXM_INDEX_BSN_L3_INTERFACE_CLASS_ID = 40, |
| 300 | OF_OXM_INDEX_BSN_L3_SRC_CLASS_ID = 41, |
| 301 | OF_OXM_INDEX_BSN_L3_DST_CLASS_ID = 42, |
Rich Lane | adb9481 | 2014-03-11 17:13:07 -0700 | [diff] [blame] | 302 | OF_OXM_INDEX_BSN_EGR_PORT_GROUP_ID = 43, |
Rich Lane | 53ddf5c | 2014-03-20 15:24:08 -0700 | [diff] [blame] | 303 | OF_OXM_INDEX_BSN_UDF0 = 44, |
| 304 | OF_OXM_INDEX_BSN_UDF1 = 45, |
| 305 | OF_OXM_INDEX_BSN_UDF2 = 46, |
| 306 | OF_OXM_INDEX_BSN_UDF3 = 47, |
| 307 | OF_OXM_INDEX_BSN_UDF4 = 48, |
| 308 | OF_OXM_INDEX_BSN_UDF5 = 49, |
| 309 | OF_OXM_INDEX_BSN_UDF6 = 50, |
| 310 | OF_OXM_INDEX_BSN_UDF7 = 51, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 311 | }; |
| 312 | |
| 313 | #define OF_OXM_BIT(index) (((uint64_t) 1) << (index)) |
| 314 | |
| 315 | /* |
| 316 | * The generic match structure uses the OXM bit indices for it's |
| 317 | * bitmasks for active and masked values |
| 318 | */ |
| 319 | """) |
| 320 | for key, entry in match.of_match_members.items(): |
| 321 | out.write(""" |
| 322 | /* Mask/value check/set macros for %(key)s */ |
| 323 | |
| 324 | /** |
| 325 | * Set the mask for an exact match of %(key)s |
| 326 | */ |
| 327 | #define OF_MATCH_MASK_%(ku)s_EXACT_SET(_match) \\ |
| 328 | MEMSET(&(_match)->masks.%(key)s, 0xff, \\ |
| 329 | sizeof(((_match)->masks).%(key)s)) |
| 330 | |
| 331 | /** |
| 332 | * Clear the mask for %(key)s making that field inactive for the match |
| 333 | */ |
| 334 | #define OF_MATCH_MASK_%(ku)s_CLEAR(_match) \\ |
| 335 | MEMSET(&(_match)->masks.%(key)s, 0, \\ |
| 336 | sizeof(((_match)->masks).%(key)s)) |
| 337 | |
| 338 | /** |
| 339 | * Test whether the match is exact for %(key)s |
| 340 | */ |
| 341 | #define OF_MATCH_MASK_%(ku)s_EXACT_TEST(_match) \\ |
| 342 | OF_VARIABLE_IS_ALL_ONES(&(((_match)->masks).%(key)s)) |
| 343 | |
| 344 | /** |
| 345 | * Test whether key %(key)s is being checked in the match |
| 346 | */ |
| 347 | #define OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(_match) \\ |
| 348 | OF_VARIABLE_IS_NON_ZERO(&(((_match)->masks).%(key)s)) |
| 349 | |
| 350 | """ % dict(key=key, bit=match.oxm_index(key), ku=key.upper())) |
| 351 | |
| 352 | def gen_incompat_members(out=sys.stdout): |
| 353 | """ |
| 354 | Generate a macro that lists all the unified fields which are |
| 355 | incompatible with v1 matches |
| 356 | """ |
| 357 | out.write(""" |
| 358 | /* Identify bits in unified match that are incompatible with V1, V2 matches */ |
| 359 | #define OF_MATCH_V1_INCOMPAT ( (uint64_t)0 """) |
| 360 | for key in match.of_match_members: |
| 361 | if key in match.of_v1_keys: |
| 362 | continue |
| 363 | out.write("\\\n | ((uint64_t)1 << %s)" % match.oxm_index(key)) |
| 364 | out.write(")\n\n") |
| 365 | |
| 366 | out.write("#define OF_MATCH_V2_INCOMPAT ( (uint64_t)0 ") |
| 367 | for key in match.of_match_members: |
| 368 | if key in match.of_v2_keys: |
| 369 | continue |
| 370 | out.write("\\\n | ((uint64_t)1 << %s)" % match.oxm_index(key)) |
| 371 | out.write(""") |
| 372 | |
| 373 | /* Indexed by version number */ |
Rich Lane | b157b0f | 2013-03-27 13:55:28 -0700 | [diff] [blame] | 374 | extern const uint64_t of_match_incompat[4]; |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 375 | """) |
| 376 | |
| 377 | |
| 378 | # # FIXME: Make these version specific |
| 379 | # def name_to_index(a, name, key="name"): |
| 380 | # """ |
| 381 | # Given an array, a, with each entry a dict, and a name, |
| 382 | # find the entry with key matching name and return the index |
| 383 | # """ |
| 384 | # count = 0 |
| 385 | # for e in a: |
| 386 | # if e[key] == name: |
| 387 | # return count |
| 388 | # count += 1 |
| 389 | # return -1 |
| 390 | |
| 391 | def gen_wc_convert_literal(out): |
| 392 | """ |
| 393 | A bunch of literal C code that's associated with match conversions |
| 394 | @param out The output file handle |
| 395 | """ |
| 396 | out.write(""" |
| 397 | |
| 398 | /* Some internal macros and utility functions */ |
| 399 | |
| 400 | /* For counting bits in a uint32 */ |
| 401 | #define _VAL_AND_5s(v) ((v) & 0x55555555) |
| 402 | #define _VAL_EVERY_OTHER(v) (_VAL_AND_5s(v) + _VAL_AND_5s(v >> 1)) |
| 403 | #define _VAL_AND_3s(v) ((v) & 0x33333333) |
| 404 | #define _VAL_PAIRS(v) (_VAL_AND_3s(v) + _VAL_AND_3s(v >> 2)) |
| 405 | #define _VAL_QUADS(v) (((val) + ((val) >> 4)) & 0x0F0F0F0F) |
| 406 | #define _VAL_BYTES(v) ((val) + ((val) >> 8)) |
| 407 | |
| 408 | /** |
| 409 | * Counts the number of bits set in an integer |
| 410 | */ |
| 411 | static inline int |
| 412 | _COUNT_BITS(unsigned int val) |
| 413 | { |
| 414 | val = _VAL_EVERY_OTHER(val); |
| 415 | val = _VAL_PAIRS(val); |
| 416 | val = _VAL_QUADS(val); |
| 417 | val = _VAL_BYTES(val); |
| 418 | |
| 419 | return (val & 0XFF) + ((val >> 16) & 0xFF); |
| 420 | } |
| 421 | |
| 422 | /* Indexed by version number */ |
Rich Lane | b157b0f | 2013-03-27 13:55:28 -0700 | [diff] [blame] | 423 | const uint64_t of_match_incompat[4] = { |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 424 | -1, |
| 425 | OF_MATCH_V1_INCOMPAT, |
| 426 | OF_MATCH_V2_INCOMPAT, |
| 427 | 0 |
| 428 | }; |
| 429 | |
| 430 | """) |
| 431 | |
| 432 | |
| 433 | def gen_unified_match_to_v1(out): |
| 434 | """ |
| 435 | Generate C code to convert a unified match structure to a V1 match struct |
| 436 | @param out The output file handle |
| 437 | """ |
| 438 | |
| 439 | out.write(""" |
| 440 | /** |
| 441 | * Check if match is compatible with OF 1.0 |
| 442 | * @param match The match being checked |
| 443 | */ |
| 444 | static inline int |
| 445 | of_match_v1_compat_check(of_match_t *match) |
| 446 | { |
| 447 | """) |
| 448 | for key in match.of_match_members: |
| 449 | if key in match.of_v1_keys: |
| 450 | continue |
| 451 | out.write(""" |
| 452 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(match)) { |
| 453 | return 0; |
| 454 | } |
| 455 | """ % dict(ku=key.upper())) |
| 456 | |
| 457 | out.write(""" |
| 458 | return 1; |
| 459 | } |
| 460 | """) |
| 461 | |
| 462 | out.write(""" |
| 463 | /** |
| 464 | * Convert a generic match object to an OF_VERSION_1_0 object |
| 465 | * @param src Pointer to the generic match object source |
| 466 | * @param dst Pointer to the OF 1.0 wire structure |
| 467 | * |
| 468 | * The wire structure is initialized by this function if it doesn't |
| 469 | * not have the proper object ID. |
| 470 | */ |
| 471 | |
| 472 | int |
| 473 | of_match_to_wire_match_v1(of_match_t *src, of_match_v1_t *dst) |
| 474 | { |
| 475 | of_wc_bmap_t wildcards = 0; |
| 476 | int ip_mask_index; |
| 477 | |
| 478 | if ((src == NULL) || (dst == NULL)) { |
| 479 | return OF_ERROR_PARAM; |
| 480 | } |
| 481 | if (!of_match_v1_compat_check(src)) { |
| 482 | return OF_ERROR_COMPAT; |
| 483 | } |
| 484 | if (dst->object_id != OF_MATCH_V1) { |
| 485 | of_match_v1_init(dst, OF_VERSION_1_0, 0, 0); |
| 486 | } |
| 487 | """) |
| 488 | for key in sorted(match.of_v1_keys): |
| 489 | if key in ["ipv4_src", "ipv4_dst"]: # Special cases for masks here |
| 490 | out.write(""" |
| 491 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(src)) { |
| 492 | ip_mask_index = of_ip_mask_to_index(src->masks.%(key)s); |
| 493 | of_match_v1_%(key)s_set(dst, src->fields.%(key)s); |
| 494 | } else { /* Wildcarded, look for 0 mask */ |
| 495 | ip_mask_index = of_ip_mask_to_index(0); |
| 496 | } |
| 497 | OF_MATCH_V1_WC_%(ku)s_SET(wildcards, ip_mask_index); |
| 498 | """ % dict(key=key, ku=key.upper())) |
| 499 | else: |
| 500 | out.write(""" |
| 501 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(src)) { |
| 502 | of_match_v1_%(key)s_set(dst, src->fields.%(key)s); |
| 503 | } else { |
| 504 | OF_MATCH_V1_WC_%(ku)s_SET(wildcards); |
| 505 | } |
| 506 | """ % dict(key=key, ku=key.upper())) |
| 507 | |
| 508 | out.write(""" |
| 509 | of_match_v1_wildcards_set(dst, wildcards); |
| 510 | |
| 511 | return OF_ERROR_NONE; |
| 512 | } |
| 513 | """) |
| 514 | |
| 515 | def all_ones_mask(d_type): |
| 516 | if d_type == "of_mac_addr_t": |
| 517 | return "of_mac_addr_all_ones" |
| 518 | else: |
| 519 | return "((%s) -1)" % d_type |
| 520 | |
| 521 | def gen_unified_match_to_v2(out): |
| 522 | """ |
| 523 | Generate C code to convert a unified match structure to a V2 match struct |
| 524 | @param out The output file handle |
| 525 | """ |
| 526 | |
| 527 | out.write(""" |
| 528 | /** |
| 529 | * Check if match is compatible with OF 1.0 |
| 530 | * @param match The match being checked |
| 531 | */ |
| 532 | static inline int |
| 533 | of_match_v2_compat_check(of_match_t *match) |
| 534 | { |
| 535 | """) |
| 536 | for key in match.of_match_members: |
| 537 | if key in match.of_v2_keys: |
| 538 | continue |
| 539 | out.write(""" |
| 540 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(match)) { |
| 541 | return 0; |
| 542 | } |
| 543 | """ % dict(ku=key.upper())) |
| 544 | |
| 545 | out.write(""" |
| 546 | return 1; |
| 547 | } |
| 548 | """) |
| 549 | |
| 550 | out.write(""" |
| 551 | /** |
| 552 | * Convert a generic match object to an OF_VERSION_1_1 object |
| 553 | * @param src Pointer to the generic match object source |
| 554 | * @param dst Pointer to the OF 1.1 wire structure |
| 555 | * |
| 556 | * The wire structure is initialized by this function. |
| 557 | */ |
| 558 | |
| 559 | int |
| 560 | of_match_to_wire_match_v2(of_match_t *src, of_match_v2_t *dst) |
| 561 | { |
| 562 | of_wc_bmap_t wildcards = 0; |
| 563 | |
| 564 | if ((src == NULL) || (dst == NULL)) { |
| 565 | return OF_ERROR_PARAM; |
| 566 | } |
| 567 | if (!of_match_v2_compat_check(src)) { |
| 568 | return OF_ERROR_COMPAT; |
| 569 | } |
| 570 | if (dst->object_id != OF_MATCH_V2) { |
| 571 | of_match_v2_init(dst, OF_VERSION_1_1, 0, 0); |
| 572 | } |
| 573 | """) |
| 574 | for key in match.of_v2_keys: |
| 575 | if key in match.of_v2_full_mask: |
| 576 | ones_mask = all_ones_mask(match.of_match_members[key]["m_type"]) |
| 577 | out.write(""" |
| 578 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(src)) { |
| 579 | if (!OF_MATCH_MASK_%(ku)s_EXACT_TEST(src)) { |
| 580 | of_match_v2_%(key)s_mask_set(dst, |
| 581 | src->masks.%(key)s); |
| 582 | } else { /* Exact match; use all ones mask */ |
| 583 | of_match_v2_%(key)s_mask_set(dst, |
| 584 | %(ones_mask)s); |
| 585 | } |
| 586 | of_match_v2_%(key)s_set(dst, src->fields.%(key)s); |
| 587 | } |
| 588 | |
| 589 | """ % dict(key=key, ku=key.upper(), ones_mask=ones_mask)) |
| 590 | else: |
| 591 | out.write(""" |
| 592 | if (!OF_MATCH_MASK_%(ku)s_EXACT_TEST(src)) { |
| 593 | return OF_ERROR_COMPAT; |
| 594 | } |
| 595 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(src)) { |
| 596 | of_match_v2_%(key)s_set(dst, src->fields.%(key)s); |
| 597 | } else { |
| 598 | OF_MATCH_V2_WC_%(ku)s_SET(wildcards); |
| 599 | } |
| 600 | """ % dict(key=key, ku=key.upper(), |
| 601 | wc_bit="OF_MATCH_WC_V2_%s" % key.upper())) |
| 602 | |
| 603 | out.write(""" |
| 604 | of_match_v2_wildcards_set(dst, wildcards); |
| 605 | |
| 606 | return OF_ERROR_NONE; |
| 607 | } |
| 608 | """) |
| 609 | |
| 610 | def gen_unified_match_to_v3(out): |
| 611 | """ |
| 612 | Generate C code to convert a unified match structure to a V3 match |
| 613 | |
| 614 | This is much easier as the unified struct is based on V3 |
| 615 | @param out The output file handle |
| 616 | """ |
| 617 | out.write(""" |
| 618 | static int |
| 619 | populate_oxm_list(of_match_t *src, of_list_oxm_t *oxm_list) |
| 620 | { |
| 621 | of_oxm_t oxm_entry; |
| 622 | |
| 623 | /* For each active member, add an OXM entry to the list */ |
| 624 | """) |
Rich Lane | 4964d54 | 2013-10-14 18:13:47 -0700 | [diff] [blame] | 625 | for key in match.match_keys_sorted: |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 626 | out.write("""\ |
| 627 | if (OF_MATCH_MASK_%(ku)s_ACTIVE_TEST(src)) { |
| 628 | if (!OF_MATCH_MASK_%(ku)s_EXACT_TEST(src)) { |
| 629 | of_oxm_%(key)s_masked_t *elt; |
| 630 | elt = &oxm_entry.%(key)s_masked; |
| 631 | |
| 632 | of_oxm_%(key)s_masked_init(elt, |
Rich Lane | cfd4ce0 | 2013-07-12 16:37:14 -0700 | [diff] [blame] | 633 | oxm_list->version, -1, 1); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 634 | of_list_oxm_append_bind(oxm_list, &oxm_entry); |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 635 | of_oxm_%(key)s_masked_value_set(elt, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 636 | src->fields.%(key)s); |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 637 | of_oxm_%(key)s_masked_value_mask_set(elt, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 638 | src->masks.%(key)s); |
| 639 | } else { /* Active, but not masked */ |
| 640 | of_oxm_%(key)s_t *elt; |
| 641 | elt = &oxm_entry.%(key)s; |
| 642 | of_oxm_%(key)s_init(elt, |
Rich Lane | cfd4ce0 | 2013-07-12 16:37:14 -0700 | [diff] [blame] | 643 | oxm_list->version, -1, 1); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 644 | of_list_oxm_append_bind(oxm_list, &oxm_entry); |
| 645 | of_oxm_%(key)s_value_set(elt, src->fields.%(key)s); |
| 646 | } |
| 647 | } |
| 648 | """ % dict(key=key, ku=key.upper())) |
| 649 | out.write(""" |
| 650 | return OF_ERROR_NONE; |
| 651 | } |
| 652 | |
| 653 | /** |
| 654 | * Convert a generic match object to an OF_VERSION_1_2 object |
| 655 | * @param src Pointer to the generic match object source |
| 656 | * @param dst Pointer to the OF 1.2 wire structure |
| 657 | * |
| 658 | * The wire structure is initialized by this function if the object |
| 659 | * id is not correct in the object |
| 660 | */ |
| 661 | |
| 662 | int |
| 663 | of_match_to_wire_match_v3(of_match_t *src, of_match_v3_t *dst) |
| 664 | { |
| 665 | int rv = OF_ERROR_NONE; |
| 666 | of_list_oxm_t *oxm_list; |
| 667 | |
| 668 | if ((src == NULL) || (dst == NULL)) { |
| 669 | return OF_ERROR_PARAM; |
| 670 | } |
| 671 | if (dst->object_id != OF_MATCH_V3) { |
Rich Lane | cfd4ce0 | 2013-07-12 16:37:14 -0700 | [diff] [blame] | 672 | of_match_v3_init(dst, OF_VERSION_1_2, 0, 0); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 673 | } |
Rich Lane | cfd4ce0 | 2013-07-12 16:37:14 -0700 | [diff] [blame] | 674 | if ((oxm_list = of_list_oxm_new(dst->version)) == NULL) { |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 675 | return OF_ERROR_RESOURCE; |
| 676 | } |
| 677 | |
| 678 | rv = populate_oxm_list(src, oxm_list); |
| 679 | |
| 680 | if (rv == OF_ERROR_NONE) { |
| 681 | rv = of_match_v3_oxm_list_set(dst, oxm_list); |
| 682 | } |
| 683 | |
| 684 | of_list_oxm_delete(oxm_list); |
| 685 | |
| 686 | return rv; |
| 687 | } |
| 688 | """) |
| 689 | |
| 690 | def gen_v1_to_unified_match(out): |
| 691 | """ |
| 692 | Generate the code that maps a v1 wire format match object |
| 693 | to a unified match object |
| 694 | """ |
| 695 | # for each v1 member, if not in wildcards |
| 696 | # translate to unified. Treat nw_src/dst specially |
| 697 | out.write(""" |
| 698 | |
| 699 | /** |
| 700 | * Convert an OF_VERSION_1_0 object to a generic match object |
| 701 | * @param src Pointer to the OF 1.0 wire structure source |
| 702 | * @param dst Pointer to the generic match object destination |
| 703 | * |
| 704 | * The wire structure is initialized by this function. |
| 705 | */ |
| 706 | |
| 707 | int |
| 708 | of_match_v1_to_match(of_match_v1_t *src, of_match_t *dst) |
| 709 | { |
| 710 | of_wc_bmap_t wc; |
| 711 | int count; |
| 712 | |
| 713 | MEMSET(dst, 0, sizeof(*dst)); |
| 714 | dst->version = src->version; |
| 715 | |
| 716 | of_match_v1_wildcards_get(src, &wc); |
| 717 | """) |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 718 | for key in sorted(match.of_v1_keys): |
| 719 | if key in ["ipv4_src", "ipv4_dst"]: # Special cases for masks here |
| 720 | out.write(""" |
| 721 | count = OF_MATCH_V1_WC_%(ku)s_GET(wc); |
| 722 | dst->masks.%(key)s = of_ip_index_to_mask(count); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 723 | of_match_v1_%(key)s_get(src, &dst->fields.%(key)s); |
Dan Talayco | fb50d38 | 2013-08-05 16:00:17 -0700 | [diff] [blame] | 724 | /* Clear the bits not indicated by mask; IP addrs are special for 1.0 */ |
| 725 | dst->fields.%(key)s &= dst->masks.%(key)s; |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 726 | """ % dict(ku=key.upper(), key=key)) |
| 727 | else: |
| 728 | out.write(""" |
| 729 | if (!(OF_MATCH_V1_WC_%(ku)s_TEST(wc))) { |
| 730 | of_match_v1_%(key)s_get(src, &dst->fields.%(key)s); |
| 731 | OF_MATCH_MASK_%(ku)s_EXACT_SET(dst); |
| 732 | } |
| 733 | """ % dict(ku=key.upper(), key=key)) |
| 734 | |
| 735 | out.write(""" |
| 736 | return OF_ERROR_NONE; |
| 737 | } |
| 738 | """) |
| 739 | |
| 740 | def gen_v2_to_unified_match(out): |
| 741 | """ |
| 742 | Generate the code that maps a v2 wire format match object |
| 743 | to a unified match object |
| 744 | """ |
| 745 | out.write(""" |
| 746 | int |
| 747 | of_match_v2_to_match(of_match_v2_t *src, of_match_t *dst) |
| 748 | { |
| 749 | of_wc_bmap_t wc; |
| 750 | |
| 751 | MEMSET(dst, 0, sizeof(*dst)); |
| 752 | dst->version = src->version; |
| 753 | |
| 754 | of_match_v2_wildcards_get(src, &wc); |
| 755 | """) |
| 756 | for key in match.of_v2_keys: |
| 757 | if key in match.of_v2_full_mask: |
| 758 | out.write(""" |
| 759 | of_match_v2_%(key)s_mask_get(src, &dst->masks.%(key)s); |
| 760 | if (OF_VARIABLE_IS_NON_ZERO(&dst->masks.%(key)s)) { /* Matching something */ |
| 761 | of_match_v2_%(key)s_get(src, &dst->fields.%(key)s); |
| 762 | } |
Rich Lane | 054a818 | 2014-04-16 14:42:41 -0700 | [diff] [blame] | 763 | of_memmask(&dst->fields.%(key)s, &dst->masks.%(key)s, sizeof(&dst->fields.%(key)s)); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 764 | """ % dict(ku=key.upper(), key=key)) |
| 765 | else: |
| 766 | out.write(""" |
| 767 | if (!(OF_MATCH_V2_WC_%(ku)s_TEST(wc))) { |
| 768 | of_match_v2_%(key)s_get(src, &dst->fields.%(key)s); |
| 769 | OF_MATCH_MASK_%(ku)s_EXACT_SET(dst); |
| 770 | } |
| 771 | """ % dict(ku=key.upper(), key=key)) |
| 772 | |
| 773 | out.write(""" |
Dan Talayco | fb50d38 | 2013-08-05 16:00:17 -0700 | [diff] [blame] | 774 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 775 | return OF_ERROR_NONE; |
| 776 | } |
| 777 | """) |
| 778 | |
| 779 | |
| 780 | def gen_v3_to_unified_match(out): |
| 781 | """ |
| 782 | Generate the code that maps a v3 wire format match object |
| 783 | to a unified match object |
| 784 | """ |
| 785 | # Iterate thru the OXM list members |
| 786 | out.write(""" |
| 787 | int |
| 788 | of_match_v3_to_match(of_match_v3_t *src, of_match_t *dst) |
| 789 | { |
| 790 | int rv; |
| 791 | of_list_oxm_t oxm_list; |
| 792 | of_oxm_t oxm_entry; |
| 793 | """) |
| 794 | # for key in match.of_match_members: |
| 795 | # out.write(" of_oxm_%s_t *%s;\n" % (key, key)) |
| 796 | # out.write(" of_oxm_%s_masked_t *%s_masked;\n" % (key, key)) |
| 797 | |
| 798 | out.write(""" |
| 799 | MEMSET(dst, 0, sizeof(*dst)); |
| 800 | dst->version = src->version; |
| 801 | |
| 802 | of_match_v3_oxm_list_bind(src, &oxm_list); |
| 803 | rv = of_list_oxm_first(&oxm_list, &oxm_entry); |
| 804 | |
| 805 | while (rv == OF_ERROR_NONE) { |
| 806 | switch (oxm_entry.header.object_id) { /* What kind of entry is this */ |
| 807 | """) |
| 808 | for key in match.of_match_members: |
| 809 | out.write(""" |
| 810 | case OF_OXM_%(ku)s_MASKED: |
| 811 | of_oxm_%(key)s_masked_value_mask_get( |
| 812 | &oxm_entry.%(key)s_masked, |
| 813 | &dst->masks.%(key)s); |
| 814 | of_oxm_%(key)s_masked_value_get( |
| 815 | &oxm_entry.%(key)s, |
| 816 | &dst->fields.%(key)s); |
Rich Lane | d5f2345 | 2014-04-03 01:16:37 -0700 | [diff] [blame] | 817 | of_memmask(&dst->fields.%(key)s, &dst->masks.%(key)s, sizeof(&dst->fields.%(key)s)); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 818 | break; |
| 819 | case OF_OXM_%(ku)s: |
| 820 | OF_MATCH_MASK_%(ku)s_EXACT_SET(dst); |
| 821 | of_oxm_%(key)s_value_get( |
| 822 | &oxm_entry.%(key)s, |
| 823 | &dst->fields.%(key)s); |
| 824 | break; |
| 825 | """ % (dict(ku=key.upper(), key=key))) |
| 826 | |
| 827 | out.write(""" |
| 828 | default: |
| 829 | /* @fixme Add debug statement */ |
| 830 | return OF_ERROR_PARSE; |
| 831 | } /* end switch */ |
| 832 | rv = of_list_oxm_next(&oxm_list, &oxm_entry); |
| 833 | } /* end OXM iteration */ |
| 834 | |
| 835 | return OF_ERROR_NONE; |
| 836 | } |
| 837 | """) |
| 838 | |
| 839 | def gen_serialize(out): |
| 840 | out.write(""" |
| 841 | /** |
| 842 | * Serialize a match structure according to the version passed |
| 843 | * @param version The version to use for serialization protocol |
| 844 | * @param match Pointer to the structure to serialize |
| 845 | * @param octets Pointer to an octets object to fill out |
| 846 | * |
| 847 | * A buffer is allocated using normal internal ALLOC/FREE semantics |
| 848 | * and pointed to by the octets object. The length of the resulting |
| 849 | * serialization is in octets->bytes. |
| 850 | * |
| 851 | * For 1.2 matches, returns the padded serialized structure |
| 852 | * |
| 853 | * Note that FREE must be called on octets->data when processing of |
| 854 | * the object is complete. |
| 855 | */ |
| 856 | |
| 857 | int |
| 858 | of_match_serialize(of_version_t version, of_match_t *match, of_octets_t *octets) |
| 859 | { |
| 860 | int rv; |
| 861 | |
| 862 | switch (version) { |
| 863 | """) |
| 864 | for version in of_g.of_version_range: |
| 865 | out.write(""" |
| 866 | case %(ver_name)s: |
| 867 | { |
| 868 | of_match_v%(version)s_t *wire_match; |
| 869 | wire_match = of_match_v%(version)s_new(version); |
| 870 | if (wire_match == NULL) { |
| 871 | return OF_ERROR_RESOURCE; |
| 872 | } |
| 873 | if ((rv = of_match_to_wire_match_v%(version)s(match, wire_match)) < 0) { |
| 874 | of_match_v%(version)s_delete(wire_match); |
| 875 | return rv; |
| 876 | } |
Rich Lane | dc9bc7f | 2014-04-05 11:19:20 -0700 | [diff] [blame] | 877 | of_wire_buffer_grow(wire_match->wbuf, OF_MATCH_BYTES(wire_match->length)); |
| 878 | octets->bytes = wire_match->wbuf->current_bytes; |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 879 | of_object_wire_buffer_steal((of_object_t *)wire_match, |
| 880 | &octets->data); |
| 881 | of_match_v%(version)s_delete(wire_match); |
| 882 | } |
| 883 | break; |
| 884 | """ % dict(version=version, ver_name=of_g.of_version_wire2name[version])) |
| 885 | out.write(""" |
| 886 | default: |
| 887 | return OF_ERROR_COMPAT; |
| 888 | } |
| 889 | |
| 890 | return OF_ERROR_NONE; |
| 891 | } |
| 892 | """) |
| 893 | |
| 894 | |
| 895 | def gen_deserialize(out): |
| 896 | out.write(""" |
| 897 | /** |
| 898 | * Deserialize a match structure according to the version passed |
| 899 | * @param version The version to use for deserialization protocol |
| 900 | * @param match Pointer to the structure to fill out |
| 901 | * @param octets Pointer to an octets object holding serial buffer |
| 902 | * |
| 903 | * Normally the octets object will point to a part of a wire buffer. |
| 904 | */ |
| 905 | |
| 906 | int |
| 907 | of_match_deserialize(of_version_t version, of_match_t *match, |
| 908 | of_octets_t *octets) |
| 909 | { |
| 910 | if (octets->bytes == 0) { /* No match specified means all wildcards */ |
| 911 | MEMSET(match, 0, sizeof(*match)); |
| 912 | match->version = version; |
| 913 | |
| 914 | return OF_ERROR_NONE; |
| 915 | } |
| 916 | |
| 917 | switch (version) { |
| 918 | """) |
| 919 | for version in of_g.of_version_range: |
| 920 | out.write(""" |
| 921 | case %(ver_name)s: |
| 922 | { /* FIXME: check init bytes */ |
| 923 | uint8_t *tmp; |
| 924 | of_match_v%(version)d_t wire_match; |
| 925 | of_match_v%(version)d_init(&wire_match, |
| 926 | %(ver_name)s, -1, 1); |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 927 | of_object_buffer_bind((of_object_t *)&wire_match, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 928 | octets->data, octets->bytes, NULL); |
| 929 | OF_TRY(of_match_v%(version)d_to_match(&wire_match, match)); |
| 930 | |
| 931 | /* Free the wire buffer control block without freeing |
| 932 | * octets->bytes. */ |
Rich Lane | cdd542d | 2014-04-03 16:13:12 -0700 | [diff] [blame] | 933 | of_wire_buffer_steal(wire_match.wbuf, &tmp); |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 934 | } |
| 935 | break; |
| 936 | """ % dict(version=version, ver_name=of_g.of_version_wire2name[version])) |
| 937 | |
| 938 | out.write(""" |
| 939 | default: |
| 940 | return OF_ERROR_COMPAT; |
| 941 | } |
| 942 | |
| 943 | return OF_ERROR_NONE; |
| 944 | } |
| 945 | """) |
| 946 | |
| 947 | def gen_match_comp(out=sys.stdout): |
| 948 | """ |
| 949 | Generate match comparison functions |
| 950 | """ |
| 951 | out.write(""" |
| 952 | /** |
| 953 | * Determine "more specific" relationship between mac addrs |
| 954 | * @return true if v1 is equal to or more specific than v2 |
| 955 | * |
| 956 | * @todo Could be optimized |
| 957 | * |
| 958 | * Check: Every bit in v2 is set in v1; v1 may have add'l bits set. |
| 959 | * That is, return false if there is a bit set in v2 and not in v1. |
| 960 | */ |
| 961 | |
| 962 | static inline int |
| 963 | of_more_specific_ipv6(of_ipv6_t *v1, of_ipv6_t *v2) { |
| 964 | int idx; |
| 965 | |
| 966 | for (idx = 0; idx < OF_IPV6_BYTES; idx++) { |
| 967 | /* If there's a bit set in v2 that is clear in v1, return false */ |
| 968 | if (~v1->addr[idx] & v2->addr[idx]) { |
| 969 | return 0; |
| 970 | } |
| 971 | } |
| 972 | |
| 973 | return 1; |
| 974 | } |
| 975 | |
| 976 | /** |
| 977 | * Boolean test if two values agree when restricted to a mask |
| 978 | */ |
| 979 | |
| 980 | static inline int |
| 981 | of_restricted_match_ipv6(of_ipv6_t *v1, of_ipv6_t *v2, of_ipv6_t *mask) { |
| 982 | int idx; |
| 983 | |
| 984 | for (idx = 0; idx < OF_IPV6_BYTES; idx++) { |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 985 | if ((v1->addr[idx] & mask->addr[idx]) != |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 986 | (v2->addr[idx] & mask->addr[idx])) { |
| 987 | return 0; |
| 988 | } |
| 989 | } |
| 990 | |
| 991 | return 1; |
| 992 | } |
| 993 | |
| 994 | /** |
| 995 | * Boolean test if two values "overlap" (agree on common masks) |
| 996 | */ |
| 997 | |
| 998 | static inline int |
| 999 | of_overlap_ipv6(of_ipv6_t *v1, of_ipv6_t *v2, |
| 1000 | of_ipv6_t *m1, of_ipv6_t *m2) { |
| 1001 | int idx; |
| 1002 | |
| 1003 | for (idx = 0; idx < OF_IPV6_BYTES; idx++) { |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 1004 | if (((v1->addr[idx] & m1->addr[idx]) & m2->addr[idx]) != |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1005 | ((v2->addr[idx] & m1->addr[idx]) & m2->addr[idx])) { |
| 1006 | return 0; |
| 1007 | } |
| 1008 | } |
| 1009 | |
| 1010 | return 1; |
| 1011 | } |
| 1012 | |
| 1013 | #define OF_MORE_SPECIFIC_IPV6(v1, v2) of_more_specific_ipv6((v1), (v2)) |
| 1014 | |
| 1015 | #define OF_RESTRICTED_MATCH_IPV6(v1, v2, mask) \\ |
| 1016 | of_restricted_match_ipv6((v1), (v2), (mask)) |
| 1017 | |
| 1018 | #define OF_OVERLAP_IPV6(v1, v2, m1, m2) of_overlap_ipv6((v1), (v2), (m1), (m2)) |
| 1019 | |
| 1020 | /** |
| 1021 | * Determine "more specific" relationship between mac addrs |
| 1022 | * @return true if v1 is equal to or more specific than v2 |
| 1023 | * |
| 1024 | * @todo Could be optimized |
| 1025 | * |
| 1026 | * Check: Every bit in v2 is set in v1; v1 may have add'l bits set. |
| 1027 | * That is, return false if there is a bit set in v2 and not in v1. |
| 1028 | */ |
| 1029 | static inline int |
| 1030 | of_more_specific_mac_addr(of_mac_addr_t *v1, of_mac_addr_t *v2) { |
| 1031 | int idx; |
| 1032 | |
| 1033 | for (idx = 0; idx < OF_MAC_ADDR_BYTES; idx++) { |
| 1034 | /* If there's a bit set in v2 that is clear in v1, return false */ |
| 1035 | if (~v1->addr[idx] & v2->addr[idx]) { |
| 1036 | return 0; |
| 1037 | } |
| 1038 | } |
| 1039 | |
| 1040 | return 1; |
| 1041 | } |
| 1042 | |
| 1043 | /** |
| 1044 | * Boolean test if two values agree when restricted to a mask |
| 1045 | */ |
| 1046 | static inline int |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 1047 | of_restricted_match_mac_addr(of_mac_addr_t *v1, of_mac_addr_t *v2, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1048 | of_mac_addr_t *mask) { |
| 1049 | int idx; |
| 1050 | |
| 1051 | for (idx = 0; idx < OF_MAC_ADDR_BYTES; idx++) { |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 1052 | if ((v1->addr[idx] & mask->addr[idx]) != |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1053 | (v2->addr[idx] & mask->addr[idx])) { |
| 1054 | return 0; |
| 1055 | } |
| 1056 | } |
| 1057 | |
| 1058 | return 1; |
| 1059 | } |
| 1060 | |
| 1061 | /** |
| 1062 | * Boolean test if two values "overlap" (agree on common masks) |
| 1063 | */ |
| 1064 | |
| 1065 | static inline int |
| 1066 | of_overlap_mac_addr(of_mac_addr_t *v1, of_mac_addr_t *v2, |
| 1067 | of_mac_addr_t *m1, of_mac_addr_t *m2) { |
| 1068 | int idx; |
| 1069 | |
| 1070 | for (idx = 0; idx < OF_MAC_ADDR_BYTES; idx++) { |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 1071 | if (((v1->addr[idx] & m1->addr[idx]) & m2->addr[idx]) != |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1072 | ((v2->addr[idx] & m1->addr[idx]) & m2->addr[idx])) { |
| 1073 | return 0; |
| 1074 | } |
| 1075 | } |
| 1076 | |
| 1077 | return 1; |
| 1078 | } |
| 1079 | |
| 1080 | #define OF_MORE_SPECIFIC_MAC_ADDR(v1, v2) of_more_specific_mac_addr((v1), (v2)) |
| 1081 | |
| 1082 | #define OF_RESTRICTED_MATCH_MAC_ADDR(v1, v2, mask) \\ |
| 1083 | of_restricted_match_mac_addr((v1), (v2), (mask)) |
| 1084 | |
| 1085 | #define OF_OVERLAP_MAC_ADDR(v1, v2, m1, m2) \\ |
| 1086 | of_overlap_mac_addr((v1), (v2), (m1), (m2)) |
| 1087 | |
Rich Lane | 3b2fd83 | 2013-09-24 13:44:08 -0700 | [diff] [blame] | 1088 | #define OF_MORE_SPECIFIC_BITMAP_128(v1, v2) \\ |
| 1089 | (OF_MORE_SPECIFIC_INT((v1)->lo, (v2)->lo) && OF_MORE_SPECIFIC_INT((v1)->hi, (v2)->hi)) |
| 1090 | |
| 1091 | #define OF_RESTRICTED_MATCH_BITMAP_128(v1, v2, mask) \\ |
| 1092 | (OF_RESTRICTED_MATCH_INT((v1)->lo, (v2)->lo, (mask)->lo) && OF_RESTRICTED_MATCH_INT((v1)->hi, (v2)->hi, (mask)->hi)) |
| 1093 | |
| 1094 | #define OF_OVERLAP_BITMAP_128(v1, v2, m1, m2) \\ |
| 1095 | (OF_OVERLAP_INT((v1)->lo, (v2)->lo, (m1)->lo, (m2)->lo) && OF_OVERLAP_INT((v1)->hi, (v2)->hi, (m1)->hi, (m2)->hi)) |
| 1096 | |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1097 | /** |
| 1098 | * More-specific-than macro for integer types; see above |
| 1099 | * @return true if v1 is equal to or more specific than v2 |
| 1100 | * |
| 1101 | * If there is a bit that is set in v2 and not in v1, return false. |
| 1102 | */ |
| 1103 | #define OF_MORE_SPECIFIC_INT(v1, v2) (!(~(v1) & (v2))) |
| 1104 | |
| 1105 | /** |
| 1106 | * Boolean test if two values agree when restricted to a mask |
| 1107 | */ |
| 1108 | #define OF_RESTRICTED_MATCH_INT(v1, v2, mask) \\ |
| 1109 | (((v1) & (mask)) == ((v2) & (mask))) |
| 1110 | |
| 1111 | |
| 1112 | #define OF_OVERLAP_INT(v1, v2, m1, m2) \\ |
| 1113 | ((((v1) & (m1)) & (m2)) == (((v2) & (m1)) & (m2))) |
| 1114 | """) |
| 1115 | |
| 1116 | out.write(""" |
| 1117 | /** |
| 1118 | * Compare two match structures for exact equality |
| 1119 | * |
| 1120 | * We just do memcmp assuming structs were memset to 0 on init |
| 1121 | */ |
| 1122 | static inline int |
| 1123 | of_match_eq(of_match_t *match1, of_match_t *match2) |
| 1124 | { |
| 1125 | return (MEMCMP(match1, match2, sizeof(of_match_t)) == 0); |
| 1126 | } |
| 1127 | |
| 1128 | /** |
| 1129 | * Is the entry match more specific than (or equal to) the query match? |
| 1130 | * @param entry Match expected to be more specific (subset of query) |
| 1131 | * @param query Match expected to be less specific (superset of entry) |
| 1132 | * @returns Boolean, see below |
| 1133 | * |
| 1134 | * The assumption is that a query is being done for a non-strict |
| 1135 | * match against an entry in a table. The result is true if the |
| 1136 | * entry match indicates a more specific (but compatible) flow space |
| 1137 | * specification than that in the query match. This means that the |
| 1138 | * values agree between the two where they overlap, and that each mask |
| 1139 | * for the entry is more specific than that of the query. |
| 1140 | * |
| 1141 | * The query has the less specific mask (fewer mask bits) so it is |
| 1142 | * used for the mask when checking values. |
| 1143 | */ |
| 1144 | |
| 1145 | static inline int |
| 1146 | of_match_more_specific(of_match_t *entry, of_match_t *query) |
| 1147 | { |
| 1148 | of_match_fields_t *q_m, *e_m; /* Short hand for masks, fields */ |
| 1149 | of_match_fields_t *q_f, *e_f; |
| 1150 | |
| 1151 | q_m = &query->masks; |
| 1152 | e_m = &entry->masks; |
| 1153 | q_f = &query->fields; |
| 1154 | e_f = &entry->fields; |
| 1155 | """) |
| 1156 | for key, entry in match.of_match_members.items(): |
| 1157 | q_m = "&q_m->%s" % key |
| 1158 | e_m = "&e_m->%s" % key |
| 1159 | q_f = "&q_f->%s" % key |
| 1160 | e_f = "&e_f->%s" % key |
| 1161 | if entry["m_type"] == "of_ipv6_t": |
| 1162 | comp = "OF_MORE_SPECIFIC_IPV6" |
| 1163 | match_type = "OF_RESTRICTED_MATCH_IPV6" |
| 1164 | elif entry["m_type"] == "of_mac_addr_t": |
| 1165 | comp = "OF_MORE_SPECIFIC_MAC_ADDR" |
| 1166 | match_type = "OF_RESTRICTED_MATCH_MAC_ADDR" |
Rich Lane | 3b2fd83 | 2013-09-24 13:44:08 -0700 | [diff] [blame] | 1167 | elif entry["m_type"] == "of_bitmap_128_t": |
| 1168 | comp = "OF_MORE_SPECIFIC_BITMAP_128" |
| 1169 | match_type = "OF_RESTRICTED_MATCH_BITMAP_128" |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1170 | else: # Integer |
| 1171 | comp = "OF_MORE_SPECIFIC_INT" |
| 1172 | match_type = "OF_RESTRICTED_MATCH_INT" |
| 1173 | q_m = "q_m->%s" % key |
| 1174 | e_m = "e_m->%s" % key |
| 1175 | q_f = "q_f->%s" % key |
| 1176 | e_f = "e_f->%s" % key |
| 1177 | out.write(""" |
| 1178 | /* Mask and values for %(key)s */ |
| 1179 | if (!%(comp)s(%(e_m)s, %(q_m)s)) { |
| 1180 | return 0; |
| 1181 | } |
| 1182 | if (!%(match_type)s(%(e_f)s, %(q_f)s, |
| 1183 | %(q_m)s)) { |
| 1184 | return 0; |
| 1185 | } |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 1186 | """ % dict(match_type=match_type, comp=comp, q_f=q_f, e_f=e_f, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1187 | q_m=q_m, e_m=e_m, key=key)) |
| 1188 | |
| 1189 | out.write(""" |
| 1190 | return 1; |
| 1191 | } |
| 1192 | """) |
| 1193 | |
| 1194 | out.write(""" |
| 1195 | |
| 1196 | /** |
| 1197 | * Do two entries overlap? |
| 1198 | * @param match1 One match struct |
| 1199 | * @param match2 Another match struct |
| 1200 | * @returns Boolean: true if there is a packet that would match both |
| 1201 | * |
| 1202 | */ |
| 1203 | |
| 1204 | static inline int |
| 1205 | of_match_overlap(of_match_t *match1, of_match_t *match2) |
| 1206 | { |
| 1207 | of_match_fields_t *m1, *m2; /* Short hand for masks, fields */ |
| 1208 | of_match_fields_t *f1, *f2; |
| 1209 | |
| 1210 | m1 = &match1->masks; |
| 1211 | m2 = &match2->masks; |
| 1212 | f1 = &match1->fields; |
| 1213 | f2 = &match2->fields; |
| 1214 | """) |
| 1215 | for key, entry in match.of_match_members.items(): |
| 1216 | m1 = "&m1->%s" % key |
| 1217 | m2 = "&m2->%s" % key |
| 1218 | f1 = "&f1->%s" % key |
| 1219 | f2 = "&f2->%s" % key |
| 1220 | if entry["m_type"] == "of_ipv6_t": |
| 1221 | check = "OF_OVERLAP_IPV6" |
| 1222 | elif entry["m_type"] == "of_mac_addr_t": |
| 1223 | check = "OF_OVERLAP_MAC_ADDR" |
Rich Lane | 3b2fd83 | 2013-09-24 13:44:08 -0700 | [diff] [blame] | 1224 | elif entry["m_type"] == "of_bitmap_128_t": |
| 1225 | check = "OF_OVERLAP_BITMAP_128" |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1226 | else: # Integer |
| 1227 | check = "OF_OVERLAP_INT" |
| 1228 | m1 = "m1->%s" % key |
| 1229 | m2 = "m2->%s" % key |
| 1230 | f1 = "f1->%s" % key |
| 1231 | f2 = "f2->%s" % key |
| 1232 | out.write(""" |
| 1233 | /* Check overlap for %(key)s */ |
Andreas Wundsam | 5325616 | 2013-05-02 14:05:53 -0700 | [diff] [blame] | 1234 | if (!%(check)s(%(f1)s, %(f2)s, |
Rich Lane | a06d0c3 | 2013-03-25 08:52:03 -0700 | [diff] [blame] | 1235 | %(m2)s, %(m1)s)) { |
| 1236 | return 0; /* This field differentiates; all done */ |
| 1237 | } |
| 1238 | """ % dict(check=check, f1=f1, f2=f2, m1=m1, m2=m2, key=key)) |
| 1239 | |
| 1240 | out.write(""" |
| 1241 | return 1; /* No field differentiates matches */ |
| 1242 | } |
| 1243 | """) |
| 1244 | |
| 1245 | def gen_match_conversions(out=sys.stdout): |
| 1246 | match.match_sanity_check() |
| 1247 | gen_wc_convert_literal(out) |
| 1248 | out.write(""" |
| 1249 | /** |
| 1250 | * IP Mask map. IP maks wildcards from OF 1.0 are interpretted as |
| 1251 | * indices into the map below. |
| 1252 | */ |
| 1253 | |
| 1254 | int of_ip_mask_map_init_done = 0; |
| 1255 | uint32_t of_ip_mask_map[OF_IP_MASK_MAP_COUNT]; |
| 1256 | void |
| 1257 | of_ip_mask_map_init(void) |
| 1258 | { |
| 1259 | int idx; |
| 1260 | |
| 1261 | MEMSET(of_ip_mask_map, 0, sizeof(of_ip_mask_map)); |
| 1262 | for (idx = 0; idx < 32; idx++) { |
| 1263 | of_ip_mask_map[idx] = ~((1U << idx) - 1); |
| 1264 | } |
| 1265 | |
| 1266 | of_ip_mask_map_init_done = 1; |
| 1267 | } |
| 1268 | |
| 1269 | /** |
| 1270 | * @brief Set non-default IP mask for given index |
| 1271 | */ |
| 1272 | int |
| 1273 | of_ip_mask_map_set(int index, uint32_t mask) |
| 1274 | { |
| 1275 | OF_IP_MASK_INIT_CHECK; |
| 1276 | |
| 1277 | if ((index < 0) || (index >= OF_IP_MASK_MAP_COUNT)) { |
| 1278 | return OF_ERROR_RANGE; |
| 1279 | } |
| 1280 | of_ip_mask_map[index] = mask; |
| 1281 | |
| 1282 | return OF_ERROR_NONE; |
| 1283 | } |
| 1284 | |
| 1285 | /** |
| 1286 | * @brief Get a non-default IP mask for given index |
| 1287 | */ |
| 1288 | int |
| 1289 | of_ip_mask_map_get(int index, uint32_t *mask) |
| 1290 | { |
| 1291 | OF_IP_MASK_INIT_CHECK; |
| 1292 | |
| 1293 | if ((mask == NULL) || (index < 0) || (index >= OF_IP_MASK_MAP_COUNT)) { |
| 1294 | return OF_ERROR_RANGE; |
| 1295 | } |
| 1296 | *mask = of_ip_mask_map[index]; |
| 1297 | |
| 1298 | return OF_ERROR_NONE; |
| 1299 | } |
| 1300 | |
| 1301 | /** |
| 1302 | * @brief Return the index (used as the WC field in 1.0 match) given the mask |
| 1303 | */ |
| 1304 | |
| 1305 | int |
| 1306 | of_ip_mask_to_index(uint32_t mask) |
| 1307 | { |
| 1308 | int idx; |
| 1309 | |
| 1310 | OF_IP_MASK_INIT_CHECK; |
| 1311 | |
| 1312 | /* Handle most common cases directly */ |
| 1313 | if ((mask == 0) && (of_ip_mask_map[63] == 0)) { |
| 1314 | return 63; |
| 1315 | } |
| 1316 | if ((mask == 0xffffffff) && (of_ip_mask_map[0] == 0xffffffff)) { |
| 1317 | return 0; |
| 1318 | } |
| 1319 | |
| 1320 | for (idx = 0; idx < OF_IP_MASK_MAP_COUNT; idx++) { |
| 1321 | if (mask == of_ip_mask_map[idx]) { |
| 1322 | return idx; |
| 1323 | } |
| 1324 | } |
| 1325 | |
| 1326 | LOCI_LOG_INFO("OF 1.0: Could not map IP addr mask 0x%x", mask); |
| 1327 | return 0x3f; |
| 1328 | } |
| 1329 | |
| 1330 | /** |
| 1331 | * @brief Return the mask for the given index |
| 1332 | */ |
| 1333 | |
| 1334 | uint32_t |
| 1335 | of_ip_index_to_mask(int index) |
| 1336 | { |
| 1337 | OF_IP_MASK_INIT_CHECK; |
| 1338 | |
| 1339 | if (index >= OF_IP_MASK_MAP_COUNT) { |
| 1340 | LOCI_LOG_INFO("IP index to map: bad index %d", index); |
| 1341 | return 0; |
| 1342 | } |
| 1343 | |
| 1344 | return of_ip_mask_map[index]; |
| 1345 | } |
| 1346 | |
| 1347 | """) |
| 1348 | |
| 1349 | gen_unified_match_to_v1(out) |
| 1350 | gen_unified_match_to_v2(out) |
| 1351 | gen_unified_match_to_v3(out) |
| 1352 | gen_v1_to_unified_match(out) |
| 1353 | gen_v2_to_unified_match(out) |
| 1354 | gen_v3_to_unified_match(out) |
| 1355 | return |