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