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