openflow: Rename OFP_VLAN_NONE as OFP10_VLAN_NONE
[sliver-openvswitch.git] / lib / classifier.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "classifier.h"
19 #include <assert.h>
20 #include <errno.h>
21 #include <netinet/in.h>
22 #include "byte-order.h"
23 #include "dynamic-string.h"
24 #include "flow.h"
25 #include "hash.h"
26 #include "odp-util.h"
27 #include "ofp-util.h"
28 #include "packets.h"
29
30 static struct cls_table *find_table(const struct classifier *,
31                                     const struct flow_wildcards *);
32 static struct cls_table *insert_table(struct classifier *,
33                                       const struct flow_wildcards *);
34
35 static void destroy_table(struct classifier *, struct cls_table *);
36
37 static struct cls_rule *find_match(const struct cls_table *,
38                                    const struct flow *);
39 static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
40                                    uint32_t hash);
41 static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
42
43 static bool flow_equal_except(const struct flow *, const struct flow *,
44                                 const struct flow_wildcards *);
45
46 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
47 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD)                               \
48     for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
49 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD)                    \
50     for ((RULE) = (HEAD);                                               \
51          (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true);    \
52          (RULE) = (NEXT))
53
54 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
55 static struct cls_rule *next_rule_in_list(struct cls_rule *);
56
57 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
58  * 'wildcards' and 'priority'. */
59 void
60 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
61               unsigned int priority, struct cls_rule *rule)
62 {
63     rule->flow = *flow;
64     rule->wc = *wildcards;
65     rule->priority = priority;
66     cls_rule_zero_wildcarded_fields(rule);
67 }
68
69 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
70  * given 'priority'.  (For OpenFlow 1.0, exact-match rule are always highest
71  * priority, so 'priority' should be at least 65535.) */
72 void
73 cls_rule_init_exact(const struct flow *flow,
74                     unsigned int priority, struct cls_rule *rule)
75 {
76     rule->flow = *flow;
77     rule->flow.skb_priority = 0;
78     flow_wildcards_init_exact(&rule->wc);
79     rule->priority = priority;
80 }
81
82 /* Initializes 'rule' as a "catch-all" rule that matches every packet, with
83  * priority 'priority'. */
84 void
85 cls_rule_init_catchall(struct cls_rule *rule, unsigned int priority)
86 {
87     memset(&rule->flow, 0, sizeof rule->flow);
88     flow_wildcards_init_catchall(&rule->wc);
89     rule->priority = priority;
90 }
91
92 /* For each bit or field wildcarded in 'rule', sets the corresponding bit or
93  * field in 'flow' to all-0-bits.  It is important to maintain this invariant
94  * in a clr_rule that might be inserted into a classifier.
95  *
96  * It is never necessary to call this function directly for a cls_rule that is
97  * initialized or modified only by cls_rule_*() functions.  It is useful to
98  * restore the invariant in a cls_rule whose 'wc' member is modified by hand.
99  */
100 void
101 cls_rule_zero_wildcarded_fields(struct cls_rule *rule)
102 {
103     flow_zero_wildcards(&rule->flow, &rule->wc);
104 }
105
106 void
107 cls_rule_set_reg(struct cls_rule *rule, unsigned int reg_idx, uint32_t value)
108 {
109     cls_rule_set_reg_masked(rule, reg_idx, value, UINT32_MAX);
110 }
111
112 void
113 cls_rule_set_reg_masked(struct cls_rule *rule, unsigned int reg_idx,
114                         uint32_t value, uint32_t mask)
115 {
116     assert(reg_idx < FLOW_N_REGS);
117     flow_wildcards_set_reg_mask(&rule->wc, reg_idx, mask);
118     rule->flow.regs[reg_idx] = value & mask;
119 }
120
121 void
122 cls_rule_set_metadata(struct cls_rule *rule, ovs_be64 metadata)
123 {
124     cls_rule_set_metadata_masked(rule, metadata, htonll(UINT64_MAX));
125 }
126
127 void
128 cls_rule_set_metadata_masked(struct cls_rule *rule, ovs_be64 metadata,
129                              ovs_be64 mask)
130 {
131     rule->wc.metadata_mask = mask;
132     rule->flow.metadata = metadata & mask;
133 }
134
135 void
136 cls_rule_set_tun_id(struct cls_rule *rule, ovs_be64 tun_id)
137 {
138     cls_rule_set_tun_id_masked(rule, tun_id, htonll(UINT64_MAX));
139 }
140
141 void
142 cls_rule_set_tun_id_masked(struct cls_rule *rule,
143                            ovs_be64 tun_id, ovs_be64 mask)
144 {
145     rule->wc.tun_id_mask = mask;
146     rule->flow.tun_id = tun_id & mask;
147 }
148
149 void
150 cls_rule_set_in_port(struct cls_rule *rule, uint16_t ofp_port)
151 {
152     rule->wc.wildcards &= ~FWW_IN_PORT;
153     rule->flow.in_port = ofp_port;
154 }
155
156 void
157 cls_rule_set_dl_type(struct cls_rule *rule, ovs_be16 dl_type)
158 {
159     rule->wc.wildcards &= ~FWW_DL_TYPE;
160     rule->flow.dl_type = dl_type;
161 }
162
163 void
164 cls_rule_set_dl_src(struct cls_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
165 {
166     memcpy(rule->flow.dl_src, dl_src, ETH_ADDR_LEN);
167     memset(rule->wc.dl_src_mask, 0xff, ETH_ADDR_LEN);
168 }
169
170 /* Modifies 'rule' so that the Ethernet address must match 'dl_src' after each
171  * byte is ANDed with the appropriate byte in 'mask'. */
172 void
173 cls_rule_set_dl_src_masked(struct cls_rule *rule,
174                            const uint8_t dl_src[ETH_ADDR_LEN],
175                            const uint8_t mask[ETH_ADDR_LEN])
176 {
177     size_t i;
178
179     for (i = 0; i < ETH_ADDR_LEN; i++) {
180         rule->flow.dl_src[i] = dl_src[i] & mask[i];
181         rule->wc.dl_src_mask[i] = mask[i];
182     }
183 }
184
185 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' exactly. */
186 void
187 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
188 {
189     memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
190     memset(rule->wc.dl_dst_mask, 0xff, ETH_ADDR_LEN);
191 }
192
193 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' after each
194  * byte is ANDed with the appropriate byte in 'mask'.
195  *
196  * This function will assert-fail if 'mask' is invalid.  Only 'mask' values
197  * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
198 void
199 cls_rule_set_dl_dst_masked(struct cls_rule *rule,
200                            const uint8_t dl_dst[ETH_ADDR_LEN],
201                            const uint8_t mask[ETH_ADDR_LEN])
202 {
203     size_t i;
204
205     for (i = 0; i < ETH_ADDR_LEN; i++) {
206         rule->flow.dl_dst[i] = dl_dst[i] & mask[i];
207         rule->wc.dl_dst_mask[i] = mask[i];
208     }
209 }
210
211 void
212 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
213 {
214     cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
215 }
216
217 void
218 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
219 {
220     rule->flow.vlan_tci = tci & mask;
221     rule->wc.vlan_tci_mask = mask;
222 }
223
224 /* Modifies 'rule' so that the VLAN VID is wildcarded.  If the PCP is already
225  * wildcarded, then 'rule' will match a packet regardless of whether it has an
226  * 802.1Q header or not. */
227 void
228 cls_rule_set_any_vid(struct cls_rule *rule)
229 {
230     if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
231         rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
232         rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
233     } else {
234         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
235     }
236 }
237
238 /* Modifies 'rule' depending on 'dl_vlan':
239  *
240  *   - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
241  *     without an 802.1Q header.
242  *
243  *   - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
244  *     VID equals the low 12 bits of 'dl_vlan'.
245  */
246 void
247 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
248 {
249     flow_set_vlan_vid(&rule->flow, dl_vlan);
250     if (dl_vlan == htons(OFP10_VLAN_NONE)) {
251         rule->wc.vlan_tci_mask = htons(UINT16_MAX);
252     } else {
253         rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
254     }
255 }
256
257 /* Modifies 'rule' so that the VLAN PCP is wildcarded.  If the VID is already
258  * wildcarded, then 'rule' will match a packet regardless of whether it has an
259  * 802.1Q header or not. */
260 void
261 cls_rule_set_any_pcp(struct cls_rule *rule)
262 {
263     if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
264         rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
265         rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
266     } else {
267         cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
268     }
269 }
270
271 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
272  * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
273 void
274 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
275 {
276     flow_set_vlan_pcp(&rule->flow, dl_vlan_pcp);
277     rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
278 }
279
280 void
281 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
282 {
283     cls_rule_set_tp_src_masked(rule, tp_src, htons(UINT16_MAX));
284 }
285
286 void
287 cls_rule_set_tp_src_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
288 {
289     rule->flow.tp_src = port & mask;
290     rule->wc.tp_src_mask = mask;
291 }
292
293 void
294 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
295 {
296     cls_rule_set_tp_dst_masked(rule, tp_dst, htons(UINT16_MAX));
297 }
298
299 void
300 cls_rule_set_tp_dst_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
301 {
302     rule->flow.tp_dst = port & mask;
303     rule->wc.tp_dst_mask = mask;
304 }
305
306 void
307 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
308 {
309     rule->wc.wildcards &= ~FWW_NW_PROTO;
310     rule->flow.nw_proto = nw_proto;
311 }
312
313 void
314 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
315 {
316     rule->flow.nw_src = nw_src;
317     rule->wc.nw_src_mask = htonl(UINT32_MAX);
318 }
319
320 void
321 cls_rule_set_nw_src_masked(struct cls_rule *rule,
322                            ovs_be32 nw_src, ovs_be32 mask)
323 {
324     rule->flow.nw_src = nw_src & mask;
325     rule->wc.nw_src_mask = mask;
326 }
327
328 void
329 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
330 {
331     rule->flow.nw_dst = nw_dst;
332     rule->wc.nw_dst_mask = htonl(UINT32_MAX);
333 }
334
335 void
336 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
337 {
338     rule->flow.nw_dst = ip & mask;
339     rule->wc.nw_dst_mask = mask;
340 }
341
342 void
343 cls_rule_set_nw_dscp(struct cls_rule *rule, uint8_t nw_dscp)
344 {
345     rule->wc.wildcards &= ~FWW_NW_DSCP;
346     rule->flow.nw_tos &= ~IP_DSCP_MASK;
347     rule->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
348 }
349
350 void
351 cls_rule_set_nw_ecn(struct cls_rule *rule, uint8_t nw_ecn)
352 {
353     rule->wc.wildcards &= ~FWW_NW_ECN;
354     rule->flow.nw_tos &= ~IP_ECN_MASK;
355     rule->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
356 }
357
358 void
359 cls_rule_set_nw_ttl(struct cls_rule *rule, uint8_t nw_ttl)
360 {
361     rule->wc.wildcards &= ~FWW_NW_TTL;
362     rule->flow.nw_ttl = nw_ttl;
363 }
364
365 void
366 cls_rule_set_nw_frag(struct cls_rule *rule, uint8_t nw_frag)
367 {
368     rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
369     rule->flow.nw_frag = nw_frag;
370 }
371
372 void
373 cls_rule_set_nw_frag_masked(struct cls_rule *rule,
374                             uint8_t nw_frag, uint8_t mask)
375 {
376     rule->flow.nw_frag = nw_frag & mask;
377     rule->wc.nw_frag_mask = mask;
378 }
379
380 void
381 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
382 {
383     cls_rule_set_tp_src(rule, htons(icmp_type));
384 }
385
386 void
387 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
388 {
389     cls_rule_set_tp_dst(rule, htons(icmp_code));
390 }
391
392 void
393 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
394 {
395     rule->wc.wildcards &= ~FWW_ARP_SHA;
396     memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
397 }
398
399 void
400 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
401 {
402     rule->wc.wildcards &= ~FWW_ARP_THA;
403     memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
404 }
405
406 void
407 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
408 {
409     rule->flow.ipv6_src = *src;
410     rule->wc.ipv6_src_mask = in6addr_exact;
411 }
412
413 void
414 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
415                              const struct in6_addr *mask)
416 {
417     rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
418     rule->wc.ipv6_src_mask = *mask;
419 }
420
421 void
422 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
423 {
424     rule->flow.ipv6_dst = *dst;
425     rule->wc.ipv6_dst_mask = in6addr_exact;
426 }
427
428 void
429 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
430                              const struct in6_addr *mask)
431 {
432     rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
433     rule->wc.ipv6_dst_mask = *mask;
434 }
435
436 void
437 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
438 {
439     rule->wc.wildcards &= ~FWW_IPV6_LABEL;
440     rule->flow.ipv6_label = ipv6_label;
441 }
442
443 void
444 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
445 {
446     rule->flow.nd_target = *target;
447     rule->wc.nd_target_mask = in6addr_exact;
448 }
449
450 void
451 cls_rule_set_nd_target_masked(struct cls_rule *rule,
452                               const struct in6_addr *target,
453                               const struct in6_addr *mask)
454 {
455     rule->flow.nd_target = ipv6_addr_bitand(target, mask);
456     rule->wc.nd_target_mask = *mask;
457 }
458
459 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
460  * fields, and have the same values for fixed fields, otherwise false. */
461 bool
462 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
463 {
464     return (a->priority == b->priority
465             && flow_wildcards_equal(&a->wc, &b->wc)
466             && flow_equal(&a->flow, &b->flow));
467 }
468
469 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
470  * starting from 'basis'. */
471 uint32_t
472 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
473 {
474     uint32_t h0 = flow_hash(&rule->flow, basis);
475     uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
476     return hash_int(rule->priority, h1);
477 }
478
479 static void
480 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
481                   const uint8_t mask[6])
482 {
483     if (!eth_addr_is_zero(mask)) {
484         ds_put_format(s, "%s=", name);
485         eth_format_masked(eth, mask, s);
486         ds_put_char(s, ',');
487     }
488 }
489
490 static void
491 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
492                   ovs_be32 netmask)
493 {
494     if (netmask) {
495         ds_put_format(s, "%s=", name);
496         ip_format_masked(ip, netmask, s);
497         ds_put_char(s, ',');
498     }
499 }
500
501 static void
502 format_ipv6_netmask(struct ds *s, const char *name,
503                     const struct in6_addr *addr,
504                     const struct in6_addr *netmask)
505 {
506     if (!ipv6_mask_is_any(netmask)) {
507         ds_put_format(s, "%s=", name);
508         print_ipv6_masked(s, addr, netmask);
509         ds_put_char(s, ',');
510     }
511 }
512
513
514 static void
515 format_be16_masked(struct ds *s, const char *name,
516                    ovs_be16 value, ovs_be16 mask)
517 {
518     if (mask != htons(0)) {
519         ds_put_format(s, "%s=", name);
520         if (mask == htons(UINT16_MAX)) {
521             ds_put_format(s, "%"PRIu16, ntohs(value));
522         } else {
523             ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
524                           ntohs(value), ntohs(mask));
525         }
526         ds_put_char(s, ',');
527     }
528 }
529
530 void
531 cls_rule_format(const struct cls_rule *rule, struct ds *s)
532 {
533     const struct flow_wildcards *wc = &rule->wc;
534     size_t start_len = s->length;
535     flow_wildcards_t w = wc->wildcards;
536     const struct flow *f = &rule->flow;
537     bool skip_type = false;
538     bool skip_proto = false;
539
540     int i;
541
542     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 12);
543
544     if (rule->priority != OFP_DEFAULT_PRIORITY) {
545         ds_put_format(s, "priority=%d,", rule->priority);
546     }
547
548     if (!(w & FWW_DL_TYPE)) {
549         skip_type = true;
550         if (f->dl_type == htons(ETH_TYPE_IP)) {
551             if (!(w & FWW_NW_PROTO)) {
552                 skip_proto = true;
553                 if (f->nw_proto == IPPROTO_ICMP) {
554                     ds_put_cstr(s, "icmp,");
555                 } else if (f->nw_proto == IPPROTO_TCP) {
556                     ds_put_cstr(s, "tcp,");
557                 } else if (f->nw_proto == IPPROTO_UDP) {
558                     ds_put_cstr(s, "udp,");
559                 } else {
560                     ds_put_cstr(s, "ip,");
561                     skip_proto = false;
562                 }
563             } else {
564                 ds_put_cstr(s, "ip,");
565             }
566         } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
567             if (!(w & FWW_NW_PROTO)) {
568                 skip_proto = true;
569                 if (f->nw_proto == IPPROTO_ICMPV6) {
570                     ds_put_cstr(s, "icmp6,");
571                 } else if (f->nw_proto == IPPROTO_TCP) {
572                     ds_put_cstr(s, "tcp6,");
573                 } else if (f->nw_proto == IPPROTO_UDP) {
574                     ds_put_cstr(s, "udp6,");
575                 } else {
576                     ds_put_cstr(s, "ipv6,");
577                     skip_proto = false;
578                 }
579             } else {
580                 ds_put_cstr(s, "ipv6,");
581             }
582         } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
583             ds_put_cstr(s, "arp,");
584         } else {
585             skip_type = false;
586         }
587     }
588     for (i = 0; i < FLOW_N_REGS; i++) {
589         switch (wc->reg_masks[i]) {
590         case 0:
591             break;
592         case UINT32_MAX:
593             ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
594             break;
595         default:
596             ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
597                           i, f->regs[i], wc->reg_masks[i]);
598             break;
599         }
600     }
601     switch (wc->tun_id_mask) {
602     case 0:
603         break;
604     case CONSTANT_HTONLL(UINT64_MAX):
605         ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
606         break;
607     default:
608         ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
609                       ntohll(f->tun_id), ntohll(wc->tun_id_mask));
610         break;
611     }
612     switch (wc->metadata_mask) {
613     case 0:
614         break;
615     case CONSTANT_HTONLL(UINT64_MAX):
616         ds_put_format(s, "metadata=%#"PRIx64",", ntohll(f->metadata));
617         break;
618     default:
619         ds_put_format(s, "metadata=%#"PRIx64"/%#"PRIx64",",
620                       ntohll(f->metadata), ntohll(wc->metadata_mask));
621         break;
622     }
623     if (!(w & FWW_IN_PORT)) {
624         ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
625     }
626     if (wc->vlan_tci_mask) {
627         ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
628         ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
629         ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
630
631         if (cfi && f->vlan_tci & htons(VLAN_CFI)
632             && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
633             && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
634             && (vid_mask || pcp_mask)) {
635             if (vid_mask) {
636                 ds_put_format(s, "dl_vlan=%"PRIu16",",
637                               vlan_tci_to_vid(f->vlan_tci));
638             }
639             if (pcp_mask) {
640                 ds_put_format(s, "dl_vlan_pcp=%d,",
641                               vlan_tci_to_pcp(f->vlan_tci));
642             }
643         } else if (wc->vlan_tci_mask == htons(0xffff)) {
644             ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
645         } else {
646             ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
647                           ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
648         }
649     }
650     format_eth_masked(s, "dl_src", f->dl_src, wc->dl_src_mask);
651     format_eth_masked(s, "dl_dst", f->dl_dst, wc->dl_dst_mask);
652     if (!skip_type && !(w & FWW_DL_TYPE)) {
653         ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
654     }
655     if (f->dl_type == htons(ETH_TYPE_IPV6)) {
656         format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
657         format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
658         if (!(w & FWW_IPV6_LABEL)) {
659             ds_put_format(s, "ipv6_label=0x%05"PRIx32",", ntohl(f->ipv6_label));
660         }
661     } else {
662         format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
663         format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
664     }
665     if (!skip_proto && !(w & FWW_NW_PROTO)) {
666         if (f->dl_type == htons(ETH_TYPE_ARP)) {
667             ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
668         } else {
669             ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
670         }
671     }
672     if (f->dl_type == htons(ETH_TYPE_ARP)) {
673         if (!(w & FWW_ARP_SHA)) {
674             ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
675                     ETH_ADDR_ARGS(f->arp_sha));
676         }
677         if (!(w & FWW_ARP_THA)) {
678             ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
679                     ETH_ADDR_ARGS(f->arp_tha));
680         }
681     }
682     if (!(w & FWW_NW_DSCP)) {
683         ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
684     }
685     if (!(w & FWW_NW_ECN)) {
686         ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
687     }
688     if (!(w & FWW_NW_TTL)) {
689         ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
690     }
691     switch (wc->nw_frag_mask) {
692     case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
693         ds_put_format(s, "nw_frag=%s,",
694                       f->nw_frag & FLOW_NW_FRAG_ANY
695                       ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
696                       : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
697         break;
698
699     case FLOW_NW_FRAG_ANY:
700         ds_put_format(s, "nw_frag=%s,",
701                       f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
702         break;
703
704     case FLOW_NW_FRAG_LATER:
705         ds_put_format(s, "nw_frag=%s,",
706                       f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
707         break;
708     }
709     if (f->nw_proto == IPPROTO_ICMP) {
710         format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
711         format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
712     } else if (f->nw_proto == IPPROTO_ICMPV6) {
713         format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
714         format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
715         format_ipv6_netmask(s, "nd_target", &f->nd_target,
716                             &wc->nd_target_mask);
717         if (!(w & FWW_ARP_SHA)) {
718             ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
719                     ETH_ADDR_ARGS(f->arp_sha));
720         }
721         if (!(w & FWW_ARP_THA)) {
722             ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
723                     ETH_ADDR_ARGS(f->arp_tha));
724         }
725    } else {
726         format_be16_masked(s, "tp_src", f->tp_src, wc->tp_src_mask);
727         format_be16_masked(s, "tp_dst", f->tp_dst, wc->tp_dst_mask);
728     }
729
730     if (s->length > start_len && ds_last(s) == ',') {
731         s->length--;
732     }
733 }
734
735 /* Converts 'rule' to a string and returns the string.  The caller must free
736  * the string (with free()). */
737 char *
738 cls_rule_to_string(const struct cls_rule *rule)
739 {
740     struct ds s = DS_EMPTY_INITIALIZER;
741     cls_rule_format(rule, &s);
742     return ds_steal_cstr(&s);
743 }
744
745 void
746 cls_rule_print(const struct cls_rule *rule)
747 {
748     char *s = cls_rule_to_string(rule);
749     puts(s);
750     free(s);
751 }
752 \f
753 /* Initializes 'cls' as a classifier that initially contains no classification
754  * rules. */
755 void
756 classifier_init(struct classifier *cls)
757 {
758     cls->n_rules = 0;
759     hmap_init(&cls->tables);
760 }
761
762 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
763  * caller's responsibility. */
764 void
765 classifier_destroy(struct classifier *cls)
766 {
767     if (cls) {
768         struct cls_table *table, *next_table;
769
770         HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
771             hmap_destroy(&table->rules);
772             hmap_remove(&cls->tables, &table->hmap_node);
773             free(table);
774         }
775         hmap_destroy(&cls->tables);
776     }
777 }
778
779 /* Returns true if 'cls' contains no classification rules, false otherwise. */
780 bool
781 classifier_is_empty(const struct classifier *cls)
782 {
783     return cls->n_rules == 0;
784 }
785
786 /* Returns the number of rules in 'classifier'. */
787 int
788 classifier_count(const struct classifier *cls)
789 {
790     return cls->n_rules;
791 }
792
793 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
794  * must not modify or free it.
795  *
796  * If 'cls' already contains an identical rule (including wildcards, values of
797  * fixed fields, and priority), replaces the old rule by 'rule' and returns the
798  * rule that was replaced.  The caller takes ownership of the returned rule and
799  * is thus responsible for freeing it, etc., as necessary.
800  *
801  * Returns NULL if 'cls' does not contain a rule with an identical key, after
802  * inserting the new rule.  In this case, no rules are displaced by the new
803  * rule, even rules that cannot have any effect because the new rule matches a
804  * superset of their flows and has higher priority. */
805 struct cls_rule *
806 classifier_replace(struct classifier *cls, struct cls_rule *rule)
807 {
808     struct cls_rule *old_rule;
809     struct cls_table *table;
810
811     table = find_table(cls, &rule->wc);
812     if (!table) {
813         table = insert_table(cls, &rule->wc);
814     }
815
816     old_rule = insert_rule(table, rule);
817     if (!old_rule) {
818         table->n_table_rules++;
819         cls->n_rules++;
820     }
821     return old_rule;
822 }
823
824 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
825  * must not modify or free it.
826  *
827  * 'cls' must not contain an identical rule (including wildcards, values of
828  * fixed fields, and priority).  Use classifier_find_rule_exactly() to find
829  * such a rule. */
830 void
831 classifier_insert(struct classifier *cls, struct cls_rule *rule)
832 {
833     struct cls_rule *displaced_rule = classifier_replace(cls, rule);
834     assert(!displaced_rule);
835 }
836
837 /* Removes 'rule' from 'cls'.  It is the caller's responsibility to free
838  * 'rule', if this is desirable. */
839 void
840 classifier_remove(struct classifier *cls, struct cls_rule *rule)
841 {
842     struct cls_rule *head;
843     struct cls_table *table;
844
845     table = find_table(cls, &rule->wc);
846     head = find_equal(table, &rule->flow, rule->hmap_node.hash);
847     if (head != rule) {
848         list_remove(&rule->list);
849     } else if (list_is_empty(&rule->list)) {
850         hmap_remove(&table->rules, &rule->hmap_node);
851     } else {
852         struct cls_rule *next = CONTAINER_OF(rule->list.next,
853                                              struct cls_rule, list);
854
855         list_remove(&rule->list);
856         hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
857     }
858
859     if (--table->n_table_rules == 0) {
860         destroy_table(cls, table);
861     }
862
863     cls->n_rules--;
864 }
865
866 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
867  * Returns a null pointer if no rules in 'cls' match 'flow'.  If multiple rules
868  * of equal priority match 'flow', returns one arbitrarily. */
869 struct cls_rule *
870 classifier_lookup(const struct classifier *cls, const struct flow *flow)
871 {
872     struct cls_table *table;
873     struct cls_rule *best;
874
875     best = NULL;
876     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
877         struct cls_rule *rule = find_match(table, flow);
878         if (rule && (!best || rule->priority > best->priority)) {
879             best = rule;
880         }
881     }
882     return best;
883 }
884
885 /* Finds and returns a rule in 'cls' with exactly the same priority and
886  * matching criteria as 'target'.  Returns a null pointer if 'cls' doesn't
887  * contain an exact match. */
888 struct cls_rule *
889 classifier_find_rule_exactly(const struct classifier *cls,
890                              const struct cls_rule *target)
891 {
892     struct cls_rule *head, *rule;
893     struct cls_table *table;
894
895     table = find_table(cls, &target->wc);
896     if (!table) {
897         return NULL;
898     }
899
900     head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
901     FOR_EACH_RULE_IN_LIST (rule, head) {
902         if (target->priority >= rule->priority) {
903             return target->priority == rule->priority ? rule : NULL;
904         }
905     }
906     return NULL;
907 }
908
909 /* Checks if 'target' would overlap any other rule in 'cls'.  Two rules are
910  * considered to overlap if both rules have the same priority and a packet
911  * could match both. */
912 bool
913 classifier_rule_overlaps(const struct classifier *cls,
914                          const struct cls_rule *target)
915 {
916     struct cls_table *table;
917
918     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
919         struct flow_wildcards wc;
920         struct cls_rule *head;
921
922         flow_wildcards_combine(&wc, &target->wc, &table->wc);
923         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
924             struct cls_rule *rule;
925
926             FOR_EACH_RULE_IN_LIST (rule, head) {
927                 if (rule->priority == target->priority
928                     && flow_equal_except(&target->flow, &rule->flow, &wc)) {
929                     return true;
930                 }
931             }
932         }
933     }
934
935     return false;
936 }
937 \f
938 /* Iteration. */
939
940 static bool
941 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
942 {
943     return (!target
944             || flow_equal_except(&rule->flow, &target->flow, &target->wc));
945 }
946
947 static struct cls_rule *
948 search_table(const struct cls_table *table, const struct cls_rule *target)
949 {
950     if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
951         struct cls_rule *rule;
952
953         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
954             if (rule_matches(rule, target)) {
955                 return rule;
956             }
957         }
958     }
959     return NULL;
960 }
961
962 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
963  * 'target' or are more specific than 'target'.  That is, a given 'rule'
964  * matches 'target' if, for every field:
965  *
966  *   - 'target' and 'rule' specify the same (non-wildcarded) value for the
967  *     field, or
968  *
969  *   - 'target' wildcards the field,
970  *
971  * but not if:
972  *
973  *   - 'target' and 'rule' specify different values for the field, or
974  *
975  *   - 'target' specifies a value for the field but 'rule' wildcards it.
976  *
977  * Equivalently, the truth table for whether a field matches is:
978  *
979  *                                     rule
980  *
981  *                             wildcard    exact
982  *                            +---------+---------+
983  *                   t   wild |   yes   |   yes   |
984  *                   a   card |         |         |
985  *                   r        +---------+---------+
986  *                   g  exact |    no   |if values|
987  *                   e        |         |are equal|
988  *                   t        +---------+---------+
989  *
990  * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
991  * commands and by OpenFlow 1.0 aggregate and flow stats.
992  *
993  * Ignores target->priority.
994  *
995  * 'target' may be NULL to iterate over every rule in 'cls'. */
996 void
997 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
998                 const struct cls_rule *target)
999 {
1000     cursor->cls = cls;
1001     cursor->target = target;
1002 }
1003
1004 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
1005  * pointer if there are no matches. */
1006 struct cls_rule *
1007 cls_cursor_first(struct cls_cursor *cursor)
1008 {
1009     struct cls_table *table;
1010
1011     HMAP_FOR_EACH (table, hmap_node, &cursor->cls->tables) {
1012         struct cls_rule *rule = search_table(table, cursor->target);
1013         if (rule) {
1014             cursor->table = table;
1015             return rule;
1016         }
1017     }
1018
1019     return NULL;
1020 }
1021
1022 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
1023  * pointer if there are no more matches. */
1024 struct cls_rule *
1025 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
1026 {
1027     const struct cls_table *table;
1028     struct cls_rule *next;
1029
1030     next = next_rule_in_list__(rule);
1031     if (next->priority < rule->priority) {
1032         return next;
1033     }
1034
1035     /* 'next' is the head of the list, that is, the rule that is included in
1036      * the table's hmap.  (This is important when the classifier contains rules
1037      * that differ only in priority.) */
1038     rule = next;
1039     HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
1040         if (rule_matches(rule, cursor->target)) {
1041             return rule;
1042         }
1043     }
1044
1045     table = cursor->table;
1046     HMAP_FOR_EACH_CONTINUE (table, hmap_node, &cursor->cls->tables) {
1047         rule = search_table(table, cursor->target);
1048         if (rule) {
1049             cursor->table = table;
1050             return rule;
1051         }
1052     }
1053
1054     return NULL;
1055 }
1056 \f
1057 static struct cls_table *
1058 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1059 {
1060     struct cls_table *table;
1061
1062     HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1063                              &cls->tables) {
1064         if (flow_wildcards_equal(wc, &table->wc)) {
1065             return table;
1066         }
1067     }
1068     return NULL;
1069 }
1070
1071 static struct cls_table *
1072 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1073 {
1074     struct cls_table *table;
1075
1076     table = xzalloc(sizeof *table);
1077     hmap_init(&table->rules);
1078     table->wc = *wc;
1079     table->is_catchall = flow_wildcards_is_catchall(&table->wc);
1080     hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1081
1082     return table;
1083 }
1084
1085 static void
1086 destroy_table(struct classifier *cls, struct cls_table *table)
1087 {
1088     hmap_remove(&cls->tables, &table->hmap_node);
1089     hmap_destroy(&table->rules);
1090     free(table);
1091 }
1092
1093 static struct cls_rule *
1094 find_match(const struct cls_table *table, const struct flow *flow)
1095 {
1096     struct cls_rule *rule;
1097
1098     if (table->is_catchall) {
1099         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1100             return rule;
1101         }
1102     } else {
1103         struct flow f;
1104
1105         f = *flow;
1106         flow_zero_wildcards(&f, &table->wc);
1107         HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1108                                  &table->rules) {
1109             if (flow_equal(&f, &rule->flow)) {
1110                 return rule;
1111             }
1112         }
1113     }
1114
1115     return NULL;
1116 }
1117
1118 static struct cls_rule *
1119 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1120 {
1121     struct cls_rule *head;
1122
1123     HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1124         if (flow_equal(&head->flow, flow)) {
1125             return head;
1126         }
1127     }
1128     return NULL;
1129 }
1130
1131 static struct cls_rule *
1132 insert_rule(struct cls_table *table, struct cls_rule *new)
1133 {
1134     struct cls_rule *head;
1135
1136     new->hmap_node.hash = flow_hash(&new->flow, 0);
1137
1138     head = find_equal(table, &new->flow, new->hmap_node.hash);
1139     if (!head) {
1140         hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1141         list_init(&new->list);
1142         return NULL;
1143     } else {
1144         /* Scan the list for the insertion point that will keep the list in
1145          * order of decreasing priority. */
1146         struct cls_rule *rule;
1147         FOR_EACH_RULE_IN_LIST (rule, head) {
1148             if (new->priority >= rule->priority) {
1149                 if (rule == head) {
1150                     /* 'new' is the new highest-priority flow in the list. */
1151                     hmap_replace(&table->rules,
1152                                  &rule->hmap_node, &new->hmap_node);
1153                 }
1154
1155                 if (new->priority == rule->priority) {
1156                     list_replace(&new->list, &rule->list);
1157                     return rule;
1158                 } else {
1159                     list_insert(&rule->list, &new->list);
1160                     return NULL;
1161                 }
1162             }
1163         }
1164
1165         /* Insert 'new' at the end of the list. */
1166         list_push_back(&head->list, &new->list);
1167         return NULL;
1168     }
1169 }
1170
1171 static struct cls_rule *
1172 next_rule_in_list__(struct cls_rule *rule)
1173 {
1174     struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1175     return next;
1176 }
1177
1178 static struct cls_rule *
1179 next_rule_in_list(struct cls_rule *rule)
1180 {
1181     struct cls_rule *next = next_rule_in_list__(rule);
1182     return next->priority < rule->priority ? next : NULL;
1183 }
1184
1185 static bool
1186 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1187                   const struct in6_addr *mask)
1188 {
1189     int i;
1190
1191 #ifdef s6_addr32
1192     for (i=0; i<4; i++) {
1193         if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1194             return false;
1195         }
1196     }
1197 #else
1198     for (i=0; i<16; i++) {
1199         if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1200             return false;
1201         }
1202     }
1203 #endif
1204
1205     return true;
1206 }
1207
1208
1209 static bool
1210 flow_equal_except(const struct flow *a, const struct flow *b,
1211                   const struct flow_wildcards *wildcards)
1212 {
1213     const flow_wildcards_t wc = wildcards->wildcards;
1214     int i;
1215
1216     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 12);
1217
1218     for (i = 0; i < FLOW_N_REGS; i++) {
1219         if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1220             return false;
1221         }
1222     }
1223
1224     return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1225             && !((a->metadata ^ b->metadata) & wildcards->metadata_mask)
1226             && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1227             && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1228             && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1229             && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1230             && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1231             && !((a->tp_src ^ b->tp_src) & wildcards->tp_src_mask)
1232             && !((a->tp_dst ^ b->tp_dst) & wildcards->tp_dst_mask)
1233             && eth_addr_equal_except(a->dl_src, b->dl_src,
1234                                      wildcards->dl_src_mask)
1235             && eth_addr_equal_except(a->dl_dst, b->dl_dst,
1236                                      wildcards->dl_dst_mask)
1237             && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1238             && (wc & FWW_NW_TTL || a->nw_ttl == b->nw_ttl)
1239             && (wc & FWW_NW_DSCP || !((a->nw_tos ^ b->nw_tos) & IP_DSCP_MASK))
1240             && (wc & FWW_NW_ECN || !((a->nw_tos ^ b->nw_tos) & IP_ECN_MASK))
1241             && !((a->nw_frag ^ b->nw_frag) & wildcards->nw_frag_mask)
1242             && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1243             && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1244             && (wc & FWW_IPV6_LABEL || a->ipv6_label == b->ipv6_label)
1245             && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1246                     &wildcards->ipv6_src_mask)
1247             && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1248                     &wildcards->ipv6_dst_mask)
1249             && ipv6_equal_except(&a->nd_target, &b->nd_target,
1250                                  &wildcards->nd_target_mask));
1251 }