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