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