Don't overload IP TOS with the frag matching bits.
[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_tos(struct cls_rule *rule, uint8_t nw_tos)
322 {
323     rule->wc.tos_mask |= IP_DSCP_MASK;
324     rule->flow.tos &= ~IP_DSCP_MASK;
325     rule->flow.tos |= nw_tos & IP_DSCP_MASK;
326 }
327
328 void
329 cls_rule_set_frag(struct cls_rule *rule, uint8_t frag)
330 {
331     rule->wc.frag_mask |= FLOW_FRAG_MASK;
332     rule->flow.frag = frag;
333 }
334
335 void
336 cls_rule_set_frag_masked(struct cls_rule *rule, uint8_t frag, uint8_t mask)
337 {
338     rule->flow.frag = frag & mask;
339     rule->wc.frag_mask = mask;
340 }
341
342 void
343 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
344 {
345     rule->wc.wildcards &= ~FWW_TP_SRC;
346     rule->flow.tp_src = htons(icmp_type);
347 }
348
349 void
350 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
351 {
352     rule->wc.wildcards &= ~FWW_TP_DST;
353     rule->flow.tp_dst = htons(icmp_code);
354 }
355
356 void
357 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
358 {
359     rule->wc.wildcards &= ~FWW_ARP_SHA;
360     memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
361 }
362
363 void
364 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
365 {
366     rule->wc.wildcards &= ~FWW_ARP_THA;
367     memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
368 }
369
370 void
371 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
372 {
373     cls_rule_set_ipv6_src_masked(rule, src, &in6addr_exact);
374 }
375
376 bool
377 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
378                              const struct in6_addr *mask)
379 {
380     if (flow_wildcards_set_ipv6_src_mask(&rule->wc, mask)) {
381         rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
382         return true;
383     } else {
384         return false;
385     }
386 }
387
388 void
389 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
390 {
391     cls_rule_set_ipv6_dst_masked(rule, dst, &in6addr_exact);
392 }
393
394 bool
395 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
396                              const struct in6_addr *mask)
397 {
398     if (flow_wildcards_set_ipv6_dst_mask(&rule->wc, mask)) {
399         rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
400         return true;
401     } else {
402         return false;
403     }
404 }
405
406 void
407 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
408 {
409     rule->wc.wildcards &= ~FWW_IPV6_LABEL;
410     rule->flow.ipv6_label = ipv6_label;
411 }
412
413 void
414 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
415 {
416     rule->wc.wildcards &= ~FWW_ND_TARGET;
417     rule->flow.nd_target = *target;
418 }
419
420 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
421  * fields, and have the same values for fixed fields, otherwise false. */
422 bool
423 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
424 {
425     return (a->priority == b->priority
426             && flow_wildcards_equal(&a->wc, &b->wc)
427             && flow_equal(&a->flow, &b->flow));
428 }
429
430 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
431  * starting from 'basis'. */
432 uint32_t
433 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
434 {
435     uint32_t h0 = flow_hash(&rule->flow, basis);
436     uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
437     return hash_int(rule->priority, h1);
438 }
439
440 static void
441 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
442                   ovs_be32 netmask)
443 {
444     if (netmask) {
445         ds_put_format(s, "%s=", name);
446         ip_format_masked(ip, netmask, s);
447         ds_put_char(s, ',');
448     }
449 }
450
451 static void
452 format_ipv6_netmask(struct ds *s, const char *name,
453                     const struct in6_addr *addr,
454                     const struct in6_addr *netmask)
455 {
456     if (!ipv6_mask_is_any(netmask)) {
457         ds_put_format(s, "%s=", name);
458         print_ipv6_masked(s, addr, netmask);
459         ds_put_char(s, ',');
460     }
461 }
462
463 void
464 cls_rule_format(const struct cls_rule *rule, struct ds *s)
465 {
466     const struct flow_wildcards *wc = &rule->wc;
467     size_t start_len = s->length;
468     flow_wildcards_t w = wc->wildcards;
469     const struct flow *f = &rule->flow;
470     bool skip_type = false;
471     bool skip_proto = false;
472
473     int i;
474
475     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 5);
476
477     if (rule->priority != OFP_DEFAULT_PRIORITY) {
478         ds_put_format(s, "priority=%d,", rule->priority);
479     }
480
481     if (!(w & FWW_DL_TYPE)) {
482         skip_type = true;
483         if (f->dl_type == htons(ETH_TYPE_IP)) {
484             if (!(w & FWW_NW_PROTO)) {
485                 skip_proto = true;
486                 if (f->nw_proto == IPPROTO_ICMP) {
487                     ds_put_cstr(s, "icmp,");
488                 } else if (f->nw_proto == IPPROTO_TCP) {
489                     ds_put_cstr(s, "tcp,");
490                 } else if (f->nw_proto == IPPROTO_UDP) {
491                     ds_put_cstr(s, "udp,");
492                 } else {
493                     ds_put_cstr(s, "ip,");
494                     skip_proto = false;
495                 }
496             } else {
497                 ds_put_cstr(s, "ip,");
498             }
499         } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
500             if (!(w & FWW_NW_PROTO)) {
501                 skip_proto = true;
502                 if (f->nw_proto == IPPROTO_ICMPV6) {
503                     ds_put_cstr(s, "icmp6,");
504                 } else if (f->nw_proto == IPPROTO_TCP) {
505                     ds_put_cstr(s, "tcp6,");
506                 } else if (f->nw_proto == IPPROTO_UDP) {
507                     ds_put_cstr(s, "udp6,");
508                 } else {
509                     ds_put_cstr(s, "ipv6,");
510                     skip_proto = false;
511                 }
512             } else {
513                 ds_put_cstr(s, "ipv6,");
514             }
515         } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
516             ds_put_cstr(s, "arp,");
517         } else {
518             skip_type = false;
519         }
520     }
521     for (i = 0; i < FLOW_N_REGS; i++) {
522         switch (wc->reg_masks[i]) {
523         case 0:
524             break;
525         case UINT32_MAX:
526             ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
527             break;
528         default:
529             ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
530                           i, f->regs[i], wc->reg_masks[i]);
531             break;
532         }
533     }
534     switch (wc->tun_id_mask) {
535     case 0:
536         break;
537     case CONSTANT_HTONLL(UINT64_MAX):
538         ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
539         break;
540     default:
541         ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
542                       ntohll(f->tun_id), ntohll(wc->tun_id_mask));
543         break;
544     }
545     if (!(w & FWW_IN_PORT)) {
546         ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
547     }
548     if (wc->vlan_tci_mask) {
549         ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
550         ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
551         ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
552
553         if (cfi && f->vlan_tci & htons(VLAN_CFI)
554             && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
555             && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
556             && (vid_mask || pcp_mask)) {
557             if (vid_mask) {
558                 ds_put_format(s, "dl_vlan=%"PRIu16",",
559                               vlan_tci_to_vid(f->vlan_tci));
560             }
561             if (pcp_mask) {
562                 ds_put_format(s, "dl_vlan_pcp=%d,",
563                               vlan_tci_to_pcp(f->vlan_tci));
564             }
565         } else if (wc->vlan_tci_mask == htons(0xffff)) {
566             ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
567         } else {
568             ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
569                           ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
570         }
571     }
572     if (!(w & FWW_DL_SRC)) {
573         ds_put_format(s, "dl_src="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_src));
574     }
575     switch (w & (FWW_DL_DST | FWW_ETH_MCAST)) {
576     case 0:
577         ds_put_format(s, "dl_dst="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_dst));
578         break;
579     case FWW_DL_DST:
580         ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/01:00:00:00:00:00,",
581                       ETH_ADDR_ARGS(f->dl_dst));
582         break;
583     case FWW_ETH_MCAST:
584         ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/fe:ff:ff:ff:ff:ff,",
585                       ETH_ADDR_ARGS(f->dl_dst));
586         break;
587     case FWW_DL_DST | FWW_ETH_MCAST:
588         break;
589     }
590     if (!skip_type && !(w & FWW_DL_TYPE)) {
591         ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
592     }
593     if (f->dl_type == htons(ETH_TYPE_IPV6)) {
594         format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
595         format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
596         if (!(w & FWW_IPV6_LABEL)) {
597             ds_put_format(s, "ipv6_label=0x%05"PRIx32",", ntohl(f->ipv6_label));
598         }
599     } else {
600         format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
601         format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
602     }
603     if (!skip_proto && !(w & FWW_NW_PROTO)) {
604         if (f->dl_type == htons(ETH_TYPE_ARP)) {
605             ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
606         } else {
607             ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
608         }
609     }
610     if (f->dl_type == htons(ETH_TYPE_ARP)) {
611         if (!(w & FWW_ARP_SHA)) {
612             ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
613                     ETH_ADDR_ARGS(f->arp_sha));
614         }
615         if (!(w & FWW_ARP_THA)) {
616             ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
617                     ETH_ADDR_ARGS(f->arp_tha));
618         }
619     }
620     if (wc->tos_mask & IP_DSCP_MASK) {
621         ds_put_format(s, "nw_tos=%"PRIu8",", f->tos & IP_DSCP_MASK);
622     }
623     switch (wc->frag_mask) {
624     case FLOW_FRAG_ANY | FLOW_FRAG_LATER:
625         ds_put_format(s, "frag=%s,",
626                       f->frag & FLOW_FRAG_ANY
627                       ? (f->frag & FLOW_FRAG_LATER ? "later" : "first")
628                       : (f->frag & FLOW_FRAG_LATER ? "<error>" : "no"));
629         break;
630
631     case FLOW_FRAG_ANY:
632         ds_put_format(s, "frag=%s,",
633                       f->frag & FLOW_FRAG_ANY ? "yes" : "no");
634         break;
635
636     case FLOW_FRAG_LATER:
637         ds_put_format(s, "frag=%s,",
638                       f->frag & FLOW_FRAG_LATER ? "later" : "not_later");
639         break;
640     }
641     if (f->nw_proto == IPPROTO_ICMP) {
642         if (!(w & FWW_TP_SRC)) {
643             ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
644         }
645         if (!(w & FWW_TP_DST)) {
646             ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
647         }
648     } else if (f->nw_proto == IPPROTO_ICMPV6) {
649         if (!(w & FWW_TP_SRC)) {
650             ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
651         }
652         if (!(w & FWW_TP_DST)) {
653             ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
654         }
655         if (!(w & FWW_ND_TARGET)) {
656             ds_put_cstr(s, "nd_target=");
657             print_ipv6_addr(s, &f->nd_target);
658             ds_put_char(s, ',');
659         }
660         if (!(w & FWW_ARP_SHA)) {
661             ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
662                     ETH_ADDR_ARGS(f->arp_sha));
663         }
664         if (!(w & FWW_ARP_THA)) {
665             ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
666                     ETH_ADDR_ARGS(f->arp_tha));
667         }
668    } else {
669         if (!(w & FWW_TP_SRC)) {
670             ds_put_format(s, "tp_src=%"PRIu16",", ntohs(f->tp_src));
671         }
672         if (!(w & FWW_TP_DST)) {
673             ds_put_format(s, "tp_dst=%"PRIu16",", ntohs(f->tp_dst));
674         }
675     }
676
677     if (s->length > start_len && ds_last(s) == ',') {
678         s->length--;
679     }
680 }
681
682 /* Converts 'rule' to a string and returns the string.  The caller must free
683  * the string (with free()). */
684 char *
685 cls_rule_to_string(const struct cls_rule *rule)
686 {
687     struct ds s = DS_EMPTY_INITIALIZER;
688     cls_rule_format(rule, &s);
689     return ds_steal_cstr(&s);
690 }
691
692 void
693 cls_rule_print(const struct cls_rule *rule)
694 {
695     char *s = cls_rule_to_string(rule);
696     puts(s);
697     free(s);
698 }
699 \f
700 /* Initializes 'cls' as a classifier that initially contains no classification
701  * rules. */
702 void
703 classifier_init(struct classifier *cls)
704 {
705     cls->n_rules = 0;
706     hmap_init(&cls->tables);
707 }
708
709 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
710  * caller's responsibility. */
711 void
712 classifier_destroy(struct classifier *cls)
713 {
714     if (cls) {
715         struct cls_table *table, *next_table;
716
717         HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
718             hmap_destroy(&table->rules);
719             hmap_remove(&cls->tables, &table->hmap_node);
720             free(table);
721         }
722         hmap_destroy(&cls->tables);
723     }
724 }
725
726 /* Returns true if 'cls' contains no classification rules, false otherwise. */
727 bool
728 classifier_is_empty(const struct classifier *cls)
729 {
730     return cls->n_rules == 0;
731 }
732
733 /* Returns the number of rules in 'classifier'. */
734 int
735 classifier_count(const struct classifier *cls)
736 {
737     return cls->n_rules;
738 }
739
740 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
741  * must not modify or free it.
742  *
743  * If 'cls' already contains an identical rule (including wildcards, values of
744  * fixed fields, and priority), replaces the old rule by 'rule' and returns the
745  * rule that was replaced.  The caller takes ownership of the returned rule and
746  * is thus responsible for freeing it, etc., as necessary.
747  *
748  * Returns NULL if 'cls' does not contain a rule with an identical key, after
749  * inserting the new rule.  In this case, no rules are displaced by the new
750  * rule, even rules that cannot have any effect because the new rule matches a
751  * superset of their flows and has higher priority. */
752 struct cls_rule *
753 classifier_replace(struct classifier *cls, struct cls_rule *rule)
754 {
755     struct cls_rule *old_rule;
756     struct cls_table *table;
757
758     table = find_table(cls, &rule->wc);
759     if (!table) {
760         table = insert_table(cls, &rule->wc);
761     }
762
763     old_rule = insert_rule(table, rule);
764     if (!old_rule) {
765         table->n_table_rules++;
766         cls->n_rules++;
767     }
768     return old_rule;
769 }
770
771 /* Inserts 'rule' into 'cls'.  Until 'rule' is removed from 'cls', the caller
772  * must not modify or free it.
773  *
774  * 'cls' must not contain an identical rule (including wildcards, values of
775  * fixed fields, and priority).  Use classifier_find_rule_exactly() to find
776  * such a rule. */
777 void
778 classifier_insert(struct classifier *cls, struct cls_rule *rule)
779 {
780     struct cls_rule *displaced_rule = classifier_replace(cls, rule);
781     assert(!displaced_rule);
782 }
783
784 /* Removes 'rule' from 'cls'.  It is the caller's responsibility to free
785  * 'rule', if this is desirable. */
786 void
787 classifier_remove(struct classifier *cls, struct cls_rule *rule)
788 {
789     struct cls_rule *head;
790     struct cls_table *table;
791
792     table = find_table(cls, &rule->wc);
793     head = find_equal(table, &rule->flow, rule->hmap_node.hash);
794     if (head != rule) {
795         list_remove(&rule->list);
796     } else if (list_is_empty(&rule->list)) {
797         hmap_remove(&table->rules, &rule->hmap_node);
798     } else {
799         struct cls_rule *next = CONTAINER_OF(rule->list.next,
800                                              struct cls_rule, list);
801
802         list_remove(&rule->list);
803         hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
804     }
805
806     if (--table->n_table_rules == 0) {
807         destroy_table(cls, table);
808     }
809
810     cls->n_rules--;
811 }
812
813 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
814  * Returns a null pointer if no rules in 'cls' match 'flow'.  If multiple rules
815  * of equal priority match 'flow', returns one arbitrarily. */
816 struct cls_rule *
817 classifier_lookup(const struct classifier *cls, const struct flow *flow)
818 {
819     struct cls_table *table;
820     struct cls_rule *best;
821
822     best = NULL;
823     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
824         struct cls_rule *rule = find_match(table, flow);
825         if (rule && (!best || rule->priority > best->priority)) {
826             best = rule;
827         }
828     }
829     return best;
830 }
831
832 /* Finds and returns a rule in 'cls' with exactly the same priority and
833  * matching criteria as 'target'.  Returns a null pointer if 'cls' doesn't
834  * contain an exact match. */
835 struct cls_rule *
836 classifier_find_rule_exactly(const struct classifier *cls,
837                              const struct cls_rule *target)
838 {
839     struct cls_rule *head, *rule;
840     struct cls_table *table;
841
842     table = find_table(cls, &target->wc);
843     if (!table) {
844         return NULL;
845     }
846
847     head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
848     FOR_EACH_RULE_IN_LIST (rule, head) {
849         if (target->priority >= rule->priority) {
850             return target->priority == rule->priority ? rule : NULL;
851         }
852     }
853     return NULL;
854 }
855
856 /* Checks if 'target' would overlap any other rule in 'cls'.  Two rules are
857  * considered to overlap if both rules have the same priority and a packet
858  * could match both. */
859 bool
860 classifier_rule_overlaps(const struct classifier *cls,
861                          const struct cls_rule *target)
862 {
863     struct cls_table *table;
864
865     HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
866         struct flow_wildcards wc;
867         struct cls_rule *head;
868
869         flow_wildcards_combine(&wc, &target->wc, &table->wc);
870         HMAP_FOR_EACH (head, hmap_node, &table->rules) {
871             struct cls_rule *rule;
872
873             FOR_EACH_RULE_IN_LIST (rule, head) {
874                 if (rule->priority == target->priority
875                     && flow_equal_except(&target->flow, &rule->flow, &wc)) {
876                     return true;
877                 }
878             }
879         }
880     }
881
882     return false;
883 }
884 \f
885 /* Iteration. */
886
887 static bool
888 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
889 {
890     return (!target
891             || flow_equal_except(&rule->flow, &target->flow, &target->wc));
892 }
893
894 static struct cls_rule *
895 search_table(const struct cls_table *table, const struct cls_rule *target)
896 {
897     if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
898         struct cls_rule *rule;
899
900         HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
901             if (rule_matches(rule, target)) {
902                 return rule;
903             }
904         }
905     }
906     return NULL;
907 }
908
909 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
910  * 'target' or are more specific than 'target'.  That is, a given 'rule'
911  * matches 'target' if, for every field:
912  *
913  *   - 'target' and 'rule' specify the same (non-wildcarded) value for the
914  *     field, or
915  *
916  *   - 'target' wildcards the field,
917  *
918  * but not if:
919  *
920  *   - 'target' and 'rule' specify different values for the field, or
921  *
922  *   - 'target' specifies a value for the field but 'rule' wildcards it.
923  *
924  * Equivalently, the truth table for whether a field matches is:
925  *
926  *                                     rule
927  *
928  *                             wildcard    exact
929  *                            +---------+---------+
930  *                   t   wild |   yes   |   yes   |
931  *                   a   card |         |         |
932  *                   r        +---------+---------+
933  *                   g  exact |    no   |if values|
934  *                   e        |         |are equal|
935  *                   t        +---------+---------+
936  *
937  * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
938  * commands and by OpenFlow 1.0 aggregate and flow stats.
939  *
940  * Ignores target->priority.
941  *
942  * 'target' may be NULL to iterate over every rule in 'cls'. */
943 void
944 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
945                 const struct cls_rule *target)
946 {
947     cursor->cls = cls;
948     cursor->target = target;
949 }
950
951 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
952  * pointer if there are no matches. */
953 struct cls_rule *
954 cls_cursor_first(struct cls_cursor *cursor)
955 {
956     struct cls_table *table;
957
958     for (table = classifier_first_table(cursor->cls); table;
959          table = classifier_next_table(cursor->cls, table)) {
960         struct cls_rule *rule = search_table(table, cursor->target);
961         if (rule) {
962             cursor->table = table;
963             return rule;
964         }
965     }
966
967     return NULL;
968 }
969
970 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
971  * pointer if there are no more matches. */
972 struct cls_rule *
973 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
974 {
975     const struct cls_table *table;
976     struct cls_rule *next;
977
978     next = next_rule_in_list__(rule);
979     if (next->priority < rule->priority) {
980         return next;
981     }
982
983     /* 'next' is the head of the list, that is, the rule that is included in
984      * the table's hmap.  (This is important when the classifier contains rules
985      * that differ only in priority.) */
986     rule = next;
987     HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
988         if (rule_matches(rule, cursor->target)) {
989             return rule;
990         }
991     }
992
993     for (table = classifier_next_table(cursor->cls, cursor->table); table;
994          table = classifier_next_table(cursor->cls, table)) {
995         rule = search_table(table, cursor->target);
996         if (rule) {
997             cursor->table = table;
998             return rule;
999         }
1000     }
1001
1002     return NULL;
1003 }
1004 \f
1005 static struct cls_table *
1006 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1007 {
1008     struct cls_table *table;
1009
1010     HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1011                              &cls->tables) {
1012         if (flow_wildcards_equal(wc, &table->wc)) {
1013             return table;
1014         }
1015     }
1016     return NULL;
1017 }
1018
1019 static struct cls_table *
1020 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1021 {
1022     struct cls_table *table;
1023
1024     table = xzalloc(sizeof *table);
1025     hmap_init(&table->rules);
1026     table->wc = *wc;
1027     hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1028
1029     return table;
1030 }
1031
1032 static struct cls_table *
1033 classifier_first_table(const struct classifier *cls)
1034 {
1035     return cls_table_from_hmap_node(hmap_first(&cls->tables));
1036 }
1037
1038 static struct cls_table *
1039 classifier_next_table(const struct classifier *cls,
1040                       const struct cls_table *table)
1041 {
1042     return cls_table_from_hmap_node(hmap_next(&cls->tables,
1043                                               &table->hmap_node));
1044 }
1045
1046 static void
1047 destroy_table(struct classifier *cls, struct cls_table *table)
1048 {
1049     hmap_remove(&cls->tables, &table->hmap_node);
1050     hmap_destroy(&table->rules);
1051     free(table);
1052 }
1053
1054 static struct cls_rule *
1055 find_match(const struct cls_table *table, const struct flow *flow)
1056 {
1057     struct cls_rule *rule;
1058     struct flow f;
1059
1060     f = *flow;
1061     flow_zero_wildcards(&f, &table->wc);
1062     HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1063                              &table->rules) {
1064         if (flow_equal(&f, &rule->flow)) {
1065             return rule;
1066         }
1067     }
1068     return NULL;
1069 }
1070
1071 static struct cls_rule *
1072 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1073 {
1074     struct cls_rule *head;
1075
1076     HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1077         if (flow_equal(&head->flow, flow)) {
1078             return head;
1079         }
1080     }
1081     return NULL;
1082 }
1083
1084 static struct cls_rule *
1085 insert_rule(struct cls_table *table, struct cls_rule *new)
1086 {
1087     struct cls_rule *head;
1088
1089     new->hmap_node.hash = flow_hash(&new->flow, 0);
1090
1091     head = find_equal(table, &new->flow, new->hmap_node.hash);
1092     if (!head) {
1093         hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1094         list_init(&new->list);
1095         return NULL;
1096     } else {
1097         /* Scan the list for the insertion point that will keep the list in
1098          * order of decreasing priority. */
1099         struct cls_rule *rule;
1100         FOR_EACH_RULE_IN_LIST (rule, head) {
1101             if (new->priority >= rule->priority) {
1102                 if (rule == head) {
1103                     /* 'new' is the new highest-priority flow in the list. */
1104                     hmap_replace(&table->rules,
1105                                  &rule->hmap_node, &new->hmap_node);
1106                 }
1107
1108                 if (new->priority == rule->priority) {
1109                     list_replace(&new->list, &rule->list);
1110                     return rule;
1111                 } else {
1112                     list_insert(&rule->list, &new->list);
1113                     return NULL;
1114                 }
1115             }
1116         }
1117
1118         /* Insert 'new' at the end of the list. */
1119         list_push_back(&head->list, &new->list);
1120         return NULL;
1121     }
1122 }
1123
1124 static struct cls_rule *
1125 next_rule_in_list__(struct cls_rule *rule)
1126 {
1127     struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1128     return next;
1129 }
1130
1131 static struct cls_rule *
1132 next_rule_in_list(struct cls_rule *rule)
1133 {
1134     struct cls_rule *next = next_rule_in_list__(rule);
1135     return next->priority < rule->priority ? next : NULL;
1136 }
1137
1138 static bool
1139 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1140                   const struct in6_addr *mask)
1141 {
1142     int i;
1143
1144 #ifdef s6_addr32
1145     for (i=0; i<4; i++) {
1146         if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1147             return false;
1148         }
1149     }
1150 #else
1151     for (i=0; i<16; i++) {
1152         if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1153             return false;
1154         }
1155     }
1156 #endif
1157
1158     return true;
1159 }
1160
1161
1162 static bool
1163 flow_equal_except(const struct flow *a, const struct flow *b,
1164                   const struct flow_wildcards *wildcards)
1165 {
1166     const flow_wildcards_t wc = wildcards->wildcards;
1167     int i;
1168
1169     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 5);
1170
1171     for (i = 0; i < FLOW_N_REGS; i++) {
1172         if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1173             return false;
1174         }
1175     }
1176
1177     return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1178             && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1179             && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1180             && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1181             && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1182             && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1183             && (wc & FWW_TP_SRC || a->tp_src == b->tp_src)
1184             && (wc & FWW_TP_DST || a->tp_dst == b->tp_dst)
1185             && (wc & FWW_DL_SRC || eth_addr_equals(a->dl_src, b->dl_src))
1186             && (wc & FWW_DL_DST
1187                 || (!((a->dl_dst[0] ^ b->dl_dst[0]) & 0xfe)
1188                     && a->dl_dst[1] == b->dl_dst[1]
1189                     && a->dl_dst[2] == b->dl_dst[2]
1190                     && a->dl_dst[3] == b->dl_dst[3]
1191                     && a->dl_dst[4] == b->dl_dst[4]
1192                     && a->dl_dst[5] == b->dl_dst[5]))
1193             && (wc & FWW_ETH_MCAST
1194                 || !((a->dl_dst[0] ^ b->dl_dst[0]) & 0x01))
1195             && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1196             && !((a->tos ^ b->tos) & wildcards->tos_mask)
1197             && !((a->frag ^ b->frag) & wildcards->frag_mask)
1198             && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1199             && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1200             && (wc & FWW_IPV6_LABEL || a->ipv6_label == b->ipv6_label)
1201             && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1202                     &wildcards->ipv6_src_mask)
1203             && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1204                     &wildcards->ipv6_dst_mask)
1205             && (wc & FWW_ND_TARGET
1206                 || ipv6_addr_equals(&a->nd_target, &b->nd_target)));
1207 }