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