2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include "classifier.h"
21 #include <netinet/in.h>
22 #include "byte-order.h"
23 #include "dynamic-string.h"
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 *);
35 static void destroy_table(struct classifier *, struct cls_table *);
37 static struct cls_rule *find_match(const struct cls_table *,
39 static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
41 static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
43 static bool flow_equal_except(const struct flow *, const struct flow *,
44 const struct flow_wildcards *);
46 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
47 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD) \
48 for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
49 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD) \
50 for ((RULE) = (HEAD); \
51 (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true); \
54 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
55 static struct cls_rule *next_rule_in_list(struct cls_rule *);
57 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
58 * 'wildcards' and 'priority'. */
60 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
61 unsigned int priority, struct cls_rule *rule)
64 rule->wc = *wildcards;
65 rule->priority = priority;
66 cls_rule_zero_wildcarded_fields(rule);
69 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
70 * given 'priority'. (For OpenFlow 1.0, exact-match rule are always highest
71 * priority, so 'priority' should be at least 65535.) */
73 cls_rule_init_exact(const struct flow *flow,
74 unsigned int priority, struct cls_rule *rule)
77 rule->flow.skb_priority = 0;
78 flow_wildcards_init_exact(&rule->wc);
79 rule->priority = priority;
82 /* Initializes 'rule' as a "catch-all" rule that matches every packet, with
83 * priority 'priority'. */
85 cls_rule_init_catchall(struct cls_rule *rule, unsigned int priority)
87 memset(&rule->flow, 0, sizeof rule->flow);
88 flow_wildcards_init_catchall(&rule->wc);
89 rule->priority = priority;
92 /* For each bit or field wildcarded in 'rule', sets the corresponding bit or
93 * field in 'flow' to all-0-bits. It is important to maintain this invariant
94 * in a clr_rule that might be inserted into a classifier.
96 * It is never necessary to call this function directly for a cls_rule that is
97 * initialized or modified only by cls_rule_*() functions. It is useful to
98 * restore the invariant in a cls_rule whose 'wc' member is modified by hand.
101 cls_rule_zero_wildcarded_fields(struct cls_rule *rule)
103 flow_zero_wildcards(&rule->flow, &rule->wc);
107 cls_rule_set_reg(struct cls_rule *rule, unsigned int reg_idx, uint32_t value)
109 cls_rule_set_reg_masked(rule, reg_idx, value, UINT32_MAX);
113 cls_rule_set_reg_masked(struct cls_rule *rule, unsigned int reg_idx,
114 uint32_t value, uint32_t mask)
116 assert(reg_idx < FLOW_N_REGS);
117 flow_wildcards_set_reg_mask(&rule->wc, reg_idx, mask);
118 rule->flow.regs[reg_idx] = value & mask;
122 cls_rule_set_tun_id(struct cls_rule *rule, ovs_be64 tun_id)
124 cls_rule_set_tun_id_masked(rule, tun_id, htonll(UINT64_MAX));
128 cls_rule_set_tun_id_masked(struct cls_rule *rule,
129 ovs_be64 tun_id, ovs_be64 mask)
131 rule->wc.tun_id_mask = mask;
132 rule->flow.tun_id = tun_id & mask;
136 cls_rule_set_in_port(struct cls_rule *rule, uint16_t ofp_port)
138 rule->wc.wildcards &= ~FWW_IN_PORT;
139 rule->flow.in_port = ofp_port;
143 cls_rule_set_dl_type(struct cls_rule *rule, ovs_be16 dl_type)
145 rule->wc.wildcards &= ~FWW_DL_TYPE;
146 rule->flow.dl_type = dl_type;
150 cls_rule_set_dl_src(struct cls_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
152 memcpy(rule->flow.dl_src, dl_src, ETH_ADDR_LEN);
153 memset(rule->wc.dl_src_mask, 0xff, ETH_ADDR_LEN);
156 /* Modifies 'rule' so that the Ethernet address must match 'dl_src' after each
157 * byte is ANDed with the appropriate byte in 'mask'. */
159 cls_rule_set_dl_src_masked(struct cls_rule *rule,
160 const uint8_t dl_src[ETH_ADDR_LEN],
161 const uint8_t mask[ETH_ADDR_LEN])
165 for (i = 0; i < ETH_ADDR_LEN; i++) {
166 rule->flow.dl_src[i] = dl_src[i] & mask[i];
167 rule->wc.dl_src_mask[i] = mask[i];
171 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' exactly. */
173 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
175 memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
176 memset(rule->wc.dl_dst_mask, 0xff, ETH_ADDR_LEN);
179 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' after each
180 * byte is ANDed with the appropriate byte in 'mask'.
182 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
183 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
185 cls_rule_set_dl_dst_masked(struct cls_rule *rule,
186 const uint8_t dl_dst[ETH_ADDR_LEN],
187 const uint8_t mask[ETH_ADDR_LEN])
191 for (i = 0; i < ETH_ADDR_LEN; i++) {
192 rule->flow.dl_dst[i] = dl_dst[i] & mask[i];
193 rule->wc.dl_dst_mask[i] = mask[i];
198 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
200 cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
204 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
206 rule->flow.vlan_tci = tci & mask;
207 rule->wc.vlan_tci_mask = mask;
210 /* Modifies 'rule' so that the VLAN VID is wildcarded. If the PCP is already
211 * wildcarded, then 'rule' will match a packet regardless of whether it has an
212 * 802.1Q header or not. */
214 cls_rule_set_any_vid(struct cls_rule *rule)
216 if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
217 rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
218 rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
220 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
224 /* Modifies 'rule' depending on 'dl_vlan':
226 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
227 * without an 802.1Q header.
229 * - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
230 * VID equals the low 12 bits of 'dl_vlan'.
233 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
235 flow_set_vlan_vid(&rule->flow, dl_vlan);
236 if (dl_vlan == htons(OFP_VLAN_NONE)) {
237 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
239 rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
243 /* Modifies 'rule' so that the VLAN PCP is wildcarded. If the VID is already
244 * wildcarded, then 'rule' will match a packet regardless of whether it has an
245 * 802.1Q header or not. */
247 cls_rule_set_any_pcp(struct cls_rule *rule)
249 if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
250 rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
251 rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
253 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
257 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
258 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
260 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
262 flow_set_vlan_pcp(&rule->flow, dl_vlan_pcp);
263 rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
267 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
269 cls_rule_set_tp_src_masked(rule, tp_src, htons(UINT16_MAX));
273 cls_rule_set_tp_src_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
275 rule->flow.tp_src = port & mask;
276 rule->wc.tp_src_mask = mask;
280 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
282 cls_rule_set_tp_dst_masked(rule, tp_dst, htons(UINT16_MAX));
286 cls_rule_set_tp_dst_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
288 rule->flow.tp_dst = port & mask;
289 rule->wc.tp_dst_mask = mask;
293 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
295 rule->wc.wildcards &= ~FWW_NW_PROTO;
296 rule->flow.nw_proto = nw_proto;
300 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
302 rule->flow.nw_src = nw_src;
303 rule->wc.nw_src_mask = htonl(UINT32_MAX);
307 cls_rule_set_nw_src_masked(struct cls_rule *rule,
308 ovs_be32 nw_src, ovs_be32 mask)
310 rule->flow.nw_src = nw_src & mask;
311 rule->wc.nw_src_mask = mask;
315 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
317 rule->flow.nw_dst = nw_dst;
318 rule->wc.nw_dst_mask = htonl(UINT32_MAX);
322 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
324 rule->flow.nw_dst = ip & mask;
325 rule->wc.nw_dst_mask = mask;
329 cls_rule_set_nw_dscp(struct cls_rule *rule, uint8_t nw_dscp)
331 rule->wc.wildcards &= ~FWW_NW_DSCP;
332 rule->flow.nw_tos &= ~IP_DSCP_MASK;
333 rule->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
337 cls_rule_set_nw_ecn(struct cls_rule *rule, uint8_t nw_ecn)
339 rule->wc.wildcards &= ~FWW_NW_ECN;
340 rule->flow.nw_tos &= ~IP_ECN_MASK;
341 rule->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
345 cls_rule_set_nw_ttl(struct cls_rule *rule, uint8_t nw_ttl)
347 rule->wc.wildcards &= ~FWW_NW_TTL;
348 rule->flow.nw_ttl = nw_ttl;
352 cls_rule_set_nw_frag(struct cls_rule *rule, uint8_t nw_frag)
354 rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
355 rule->flow.nw_frag = nw_frag;
359 cls_rule_set_nw_frag_masked(struct cls_rule *rule,
360 uint8_t nw_frag, uint8_t mask)
362 rule->flow.nw_frag = nw_frag & mask;
363 rule->wc.nw_frag_mask = mask;
367 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
369 cls_rule_set_tp_src(rule, htons(icmp_type));
373 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
375 cls_rule_set_tp_dst(rule, htons(icmp_code));
379 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
381 rule->wc.wildcards &= ~FWW_ARP_SHA;
382 memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
386 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
388 rule->wc.wildcards &= ~FWW_ARP_THA;
389 memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
393 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
395 rule->flow.ipv6_src = *src;
396 rule->wc.ipv6_src_mask = in6addr_exact;
400 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
401 const struct in6_addr *mask)
403 rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
404 rule->wc.ipv6_src_mask = *mask;
408 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
410 rule->flow.ipv6_dst = *dst;
411 rule->wc.ipv6_dst_mask = in6addr_exact;
415 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
416 const struct in6_addr *mask)
418 rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
419 rule->wc.ipv6_dst_mask = *mask;
423 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
425 rule->wc.wildcards &= ~FWW_IPV6_LABEL;
426 rule->flow.ipv6_label = ipv6_label;
430 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
432 rule->flow.nd_target = *target;
433 rule->wc.nd_target_mask = in6addr_exact;
437 cls_rule_set_nd_target_masked(struct cls_rule *rule,
438 const struct in6_addr *target,
439 const struct in6_addr *mask)
441 rule->flow.nd_target = ipv6_addr_bitand(target, mask);
442 rule->wc.nd_target_mask = *mask;
445 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
446 * fields, and have the same values for fixed fields, otherwise false. */
448 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
450 return (a->priority == b->priority
451 && flow_wildcards_equal(&a->wc, &b->wc)
452 && flow_equal(&a->flow, &b->flow));
455 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
456 * starting from 'basis'. */
458 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
460 uint32_t h0 = flow_hash(&rule->flow, basis);
461 uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
462 return hash_int(rule->priority, h1);
466 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
467 const uint8_t mask[6])
469 if (!eth_addr_is_zero(mask)) {
470 ds_put_format(s, "%s=", name);
471 eth_format_masked(eth, mask, s);
477 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
481 ds_put_format(s, "%s=", name);
482 ip_format_masked(ip, netmask, s);
488 format_ipv6_netmask(struct ds *s, const char *name,
489 const struct in6_addr *addr,
490 const struct in6_addr *netmask)
492 if (!ipv6_mask_is_any(netmask)) {
493 ds_put_format(s, "%s=", name);
494 print_ipv6_masked(s, addr, netmask);
501 format_be16_masked(struct ds *s, const char *name,
502 ovs_be16 value, ovs_be16 mask)
504 if (mask != htons(0)) {
505 ds_put_format(s, "%s=", name);
506 if (mask == htons(UINT16_MAX)) {
507 ds_put_format(s, "%"PRIu16, ntohs(value));
509 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
510 ntohs(value), ntohs(mask));
517 cls_rule_format(const struct cls_rule *rule, struct ds *s)
519 const struct flow_wildcards *wc = &rule->wc;
520 size_t start_len = s->length;
521 flow_wildcards_t w = wc->wildcards;
522 const struct flow *f = &rule->flow;
523 bool skip_type = false;
524 bool skip_proto = false;
528 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
530 if (rule->priority != OFP_DEFAULT_PRIORITY) {
531 ds_put_format(s, "priority=%d,", rule->priority);
534 if (!(w & FWW_DL_TYPE)) {
536 if (f->dl_type == htons(ETH_TYPE_IP)) {
537 if (!(w & FWW_NW_PROTO)) {
539 if (f->nw_proto == IPPROTO_ICMP) {
540 ds_put_cstr(s, "icmp,");
541 } else if (f->nw_proto == IPPROTO_TCP) {
542 ds_put_cstr(s, "tcp,");
543 } else if (f->nw_proto == IPPROTO_UDP) {
544 ds_put_cstr(s, "udp,");
546 ds_put_cstr(s, "ip,");
550 ds_put_cstr(s, "ip,");
552 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
553 if (!(w & FWW_NW_PROTO)) {
555 if (f->nw_proto == IPPROTO_ICMPV6) {
556 ds_put_cstr(s, "icmp6,");
557 } else if (f->nw_proto == IPPROTO_TCP) {
558 ds_put_cstr(s, "tcp6,");
559 } else if (f->nw_proto == IPPROTO_UDP) {
560 ds_put_cstr(s, "udp6,");
562 ds_put_cstr(s, "ipv6,");
566 ds_put_cstr(s, "ipv6,");
568 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
569 ds_put_cstr(s, "arp,");
574 for (i = 0; i < FLOW_N_REGS; i++) {
575 switch (wc->reg_masks[i]) {
579 ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
582 ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
583 i, f->regs[i], wc->reg_masks[i]);
587 switch (wc->tun_id_mask) {
590 case CONSTANT_HTONLL(UINT64_MAX):
591 ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
594 ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
595 ntohll(f->tun_id), ntohll(wc->tun_id_mask));
598 if (!(w & FWW_IN_PORT)) {
599 ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
601 if (wc->vlan_tci_mask) {
602 ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
603 ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
604 ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
606 if (cfi && f->vlan_tci & htons(VLAN_CFI)
607 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
608 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
609 && (vid_mask || pcp_mask)) {
611 ds_put_format(s, "dl_vlan=%"PRIu16",",
612 vlan_tci_to_vid(f->vlan_tci));
615 ds_put_format(s, "dl_vlan_pcp=%d,",
616 vlan_tci_to_pcp(f->vlan_tci));
618 } else if (wc->vlan_tci_mask == htons(0xffff)) {
619 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
621 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
622 ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
625 format_eth_masked(s, "dl_src", f->dl_src, wc->dl_src_mask);
626 format_eth_masked(s, "dl_dst", f->dl_dst, wc->dl_dst_mask);
627 if (!skip_type && !(w & FWW_DL_TYPE)) {
628 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
630 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
631 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
632 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
633 if (!(w & FWW_IPV6_LABEL)) {
634 ds_put_format(s, "ipv6_label=0x%05"PRIx32",", ntohl(f->ipv6_label));
637 format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
638 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
640 if (!skip_proto && !(w & FWW_NW_PROTO)) {
641 if (f->dl_type == htons(ETH_TYPE_ARP)) {
642 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
644 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
647 if (f->dl_type == htons(ETH_TYPE_ARP)) {
648 if (!(w & FWW_ARP_SHA)) {
649 ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
650 ETH_ADDR_ARGS(f->arp_sha));
652 if (!(w & FWW_ARP_THA)) {
653 ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
654 ETH_ADDR_ARGS(f->arp_tha));
657 if (!(w & FWW_NW_DSCP)) {
658 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
660 if (!(w & FWW_NW_ECN)) {
661 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
663 if (!(w & FWW_NW_TTL)) {
664 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
666 switch (wc->nw_frag_mask) {
667 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
668 ds_put_format(s, "nw_frag=%s,",
669 f->nw_frag & FLOW_NW_FRAG_ANY
670 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
671 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
674 case FLOW_NW_FRAG_ANY:
675 ds_put_format(s, "nw_frag=%s,",
676 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
679 case FLOW_NW_FRAG_LATER:
680 ds_put_format(s, "nw_frag=%s,",
681 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
684 if (f->nw_proto == IPPROTO_ICMP) {
685 format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
686 format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
687 } else if (f->nw_proto == IPPROTO_ICMPV6) {
688 format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
689 format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
690 format_ipv6_netmask(s, "nd_target", &f->nd_target,
691 &wc->nd_target_mask);
692 if (!(w & FWW_ARP_SHA)) {
693 ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
694 ETH_ADDR_ARGS(f->arp_sha));
696 if (!(w & FWW_ARP_THA)) {
697 ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
698 ETH_ADDR_ARGS(f->arp_tha));
701 format_be16_masked(s, "tp_src", f->tp_src, wc->tp_src_mask);
702 format_be16_masked(s, "tp_dst", f->tp_dst, wc->tp_dst_mask);
705 if (s->length > start_len && ds_last(s) == ',') {
710 /* Converts 'rule' to a string and returns the string. The caller must free
711 * the string (with free()). */
713 cls_rule_to_string(const struct cls_rule *rule)
715 struct ds s = DS_EMPTY_INITIALIZER;
716 cls_rule_format(rule, &s);
717 return ds_steal_cstr(&s);
721 cls_rule_print(const struct cls_rule *rule)
723 char *s = cls_rule_to_string(rule);
728 /* Initializes 'cls' as a classifier that initially contains no classification
731 classifier_init(struct classifier *cls)
734 hmap_init(&cls->tables);
737 /* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
738 * caller's responsibility. */
740 classifier_destroy(struct classifier *cls)
743 struct cls_table *table, *next_table;
745 HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
746 hmap_destroy(&table->rules);
747 hmap_remove(&cls->tables, &table->hmap_node);
750 hmap_destroy(&cls->tables);
754 /* Returns true if 'cls' contains no classification rules, false otherwise. */
756 classifier_is_empty(const struct classifier *cls)
758 return cls->n_rules == 0;
761 /* Returns the number of rules in 'classifier'. */
763 classifier_count(const struct classifier *cls)
768 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
769 * must not modify or free it.
771 * If 'cls' already contains an identical rule (including wildcards, values of
772 * fixed fields, and priority), replaces the old rule by 'rule' and returns the
773 * rule that was replaced. The caller takes ownership of the returned rule and
774 * is thus responsible for freeing it, etc., as necessary.
776 * Returns NULL if 'cls' does not contain a rule with an identical key, after
777 * inserting the new rule. In this case, no rules are displaced by the new
778 * rule, even rules that cannot have any effect because the new rule matches a
779 * superset of their flows and has higher priority. */
781 classifier_replace(struct classifier *cls, struct cls_rule *rule)
783 struct cls_rule *old_rule;
784 struct cls_table *table;
786 table = find_table(cls, &rule->wc);
788 table = insert_table(cls, &rule->wc);
791 old_rule = insert_rule(table, rule);
793 table->n_table_rules++;
799 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
800 * must not modify or free it.
802 * 'cls' must not contain an identical rule (including wildcards, values of
803 * fixed fields, and priority). Use classifier_find_rule_exactly() to find
806 classifier_insert(struct classifier *cls, struct cls_rule *rule)
808 struct cls_rule *displaced_rule = classifier_replace(cls, rule);
809 assert(!displaced_rule);
812 /* Removes 'rule' from 'cls'. It is the caller's responsibility to free
813 * 'rule', if this is desirable. */
815 classifier_remove(struct classifier *cls, struct cls_rule *rule)
817 struct cls_rule *head;
818 struct cls_table *table;
820 table = find_table(cls, &rule->wc);
821 head = find_equal(table, &rule->flow, rule->hmap_node.hash);
823 list_remove(&rule->list);
824 } else if (list_is_empty(&rule->list)) {
825 hmap_remove(&table->rules, &rule->hmap_node);
827 struct cls_rule *next = CONTAINER_OF(rule->list.next,
828 struct cls_rule, list);
830 list_remove(&rule->list);
831 hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
834 if (--table->n_table_rules == 0) {
835 destroy_table(cls, table);
841 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
842 * Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
843 * of equal priority match 'flow', returns one arbitrarily. */
845 classifier_lookup(const struct classifier *cls, const struct flow *flow)
847 struct cls_table *table;
848 struct cls_rule *best;
851 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
852 struct cls_rule *rule = find_match(table, flow);
853 if (rule && (!best || rule->priority > best->priority)) {
860 /* Finds and returns a rule in 'cls' with exactly the same priority and
861 * matching criteria as 'target'. Returns a null pointer if 'cls' doesn't
862 * contain an exact match. */
864 classifier_find_rule_exactly(const struct classifier *cls,
865 const struct cls_rule *target)
867 struct cls_rule *head, *rule;
868 struct cls_table *table;
870 table = find_table(cls, &target->wc);
875 head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
876 FOR_EACH_RULE_IN_LIST (rule, head) {
877 if (target->priority >= rule->priority) {
878 return target->priority == rule->priority ? rule : NULL;
884 /* Checks if 'target' would overlap any other rule in 'cls'. Two rules are
885 * considered to overlap if both rules have the same priority and a packet
886 * could match both. */
888 classifier_rule_overlaps(const struct classifier *cls,
889 const struct cls_rule *target)
891 struct cls_table *table;
893 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
894 struct flow_wildcards wc;
895 struct cls_rule *head;
897 flow_wildcards_combine(&wc, &target->wc, &table->wc);
898 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
899 struct cls_rule *rule;
901 FOR_EACH_RULE_IN_LIST (rule, head) {
902 if (rule->priority == target->priority
903 && flow_equal_except(&target->flow, &rule->flow, &wc)) {
916 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
919 || flow_equal_except(&rule->flow, &target->flow, &target->wc));
922 static struct cls_rule *
923 search_table(const struct cls_table *table, const struct cls_rule *target)
925 if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
926 struct cls_rule *rule;
928 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
929 if (rule_matches(rule, target)) {
937 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
938 * 'target' or are more specific than 'target'. That is, a given 'rule'
939 * matches 'target' if, for every field:
941 * - 'target' and 'rule' specify the same (non-wildcarded) value for the
944 * - 'target' wildcards the field,
948 * - 'target' and 'rule' specify different values for the field, or
950 * - 'target' specifies a value for the field but 'rule' wildcards it.
952 * Equivalently, the truth table for whether a field matches is:
957 * +---------+---------+
958 * t wild | yes | yes |
960 * r +---------+---------+
961 * g exact | no |if values|
963 * t +---------+---------+
965 * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
966 * commands and by OpenFlow 1.0 aggregate and flow stats.
968 * Ignores target->priority.
970 * 'target' may be NULL to iterate over every rule in 'cls'. */
972 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
973 const struct cls_rule *target)
976 cursor->target = target;
979 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
980 * pointer if there are no matches. */
982 cls_cursor_first(struct cls_cursor *cursor)
984 struct cls_table *table;
986 HMAP_FOR_EACH (table, hmap_node, &cursor->cls->tables) {
987 struct cls_rule *rule = search_table(table, cursor->target);
989 cursor->table = table;
997 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
998 * pointer if there are no more matches. */
1000 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
1002 const struct cls_table *table;
1003 struct cls_rule *next;
1005 next = next_rule_in_list__(rule);
1006 if (next->priority < rule->priority) {
1010 /* 'next' is the head of the list, that is, the rule that is included in
1011 * the table's hmap. (This is important when the classifier contains rules
1012 * that differ only in priority.) */
1014 HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
1015 if (rule_matches(rule, cursor->target)) {
1020 table = cursor->table;
1021 HMAP_FOR_EACH_CONTINUE (table, hmap_node, &cursor->cls->tables) {
1022 rule = search_table(table, cursor->target);
1024 cursor->table = table;
1032 static struct cls_table *
1033 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1035 struct cls_table *table;
1037 HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1039 if (flow_wildcards_equal(wc, &table->wc)) {
1046 static struct cls_table *
1047 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1049 struct cls_table *table;
1051 table = xzalloc(sizeof *table);
1052 hmap_init(&table->rules);
1054 table->is_catchall = flow_wildcards_is_catchall(&table->wc);
1055 hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1061 destroy_table(struct classifier *cls, struct cls_table *table)
1063 hmap_remove(&cls->tables, &table->hmap_node);
1064 hmap_destroy(&table->rules);
1068 static struct cls_rule *
1069 find_match(const struct cls_table *table, const struct flow *flow)
1071 struct cls_rule *rule;
1073 if (table->is_catchall) {
1074 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1081 flow_zero_wildcards(&f, &table->wc);
1082 HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1084 if (flow_equal(&f, &rule->flow)) {
1093 static struct cls_rule *
1094 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1096 struct cls_rule *head;
1098 HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1099 if (flow_equal(&head->flow, flow)) {
1106 static struct cls_rule *
1107 insert_rule(struct cls_table *table, struct cls_rule *new)
1109 struct cls_rule *head;
1111 new->hmap_node.hash = flow_hash(&new->flow, 0);
1113 head = find_equal(table, &new->flow, new->hmap_node.hash);
1115 hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1116 list_init(&new->list);
1119 /* Scan the list for the insertion point that will keep the list in
1120 * order of decreasing priority. */
1121 struct cls_rule *rule;
1122 FOR_EACH_RULE_IN_LIST (rule, head) {
1123 if (new->priority >= rule->priority) {
1125 /* 'new' is the new highest-priority flow in the list. */
1126 hmap_replace(&table->rules,
1127 &rule->hmap_node, &new->hmap_node);
1130 if (new->priority == rule->priority) {
1131 list_replace(&new->list, &rule->list);
1134 list_insert(&rule->list, &new->list);
1140 /* Insert 'new' at the end of the list. */
1141 list_push_back(&head->list, &new->list);
1146 static struct cls_rule *
1147 next_rule_in_list__(struct cls_rule *rule)
1149 struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1153 static struct cls_rule *
1154 next_rule_in_list(struct cls_rule *rule)
1156 struct cls_rule *next = next_rule_in_list__(rule);
1157 return next->priority < rule->priority ? next : NULL;
1161 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1162 const struct in6_addr *mask)
1167 for (i=0; i<4; i++) {
1168 if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1173 for (i=0; i<16; i++) {
1174 if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1185 flow_equal_except(const struct flow *a, const struct flow *b,
1186 const struct flow_wildcards *wildcards)
1188 const flow_wildcards_t wc = wildcards->wildcards;
1191 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
1193 for (i = 0; i < FLOW_N_REGS; i++) {
1194 if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1199 return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1200 && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1201 && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1202 && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1203 && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1204 && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1205 && !((a->tp_src ^ b->tp_src) & wildcards->tp_src_mask)
1206 && !((a->tp_dst ^ b->tp_dst) & wildcards->tp_dst_mask)
1207 && eth_addr_equal_except(a->dl_src, b->dl_src,
1208 wildcards->dl_src_mask)
1209 && eth_addr_equal_except(a->dl_dst, b->dl_dst,
1210 wildcards->dl_dst_mask)
1211 && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1212 && (wc & FWW_NW_TTL || a->nw_ttl == b->nw_ttl)
1213 && (wc & FWW_NW_DSCP || !((a->nw_tos ^ b->nw_tos) & IP_DSCP_MASK))
1214 && (wc & FWW_NW_ECN || !((a->nw_tos ^ b->nw_tos) & IP_ECN_MASK))
1215 && !((a->nw_frag ^ b->nw_frag) & wildcards->nw_frag_mask)
1216 && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1217 && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1218 && (wc & FWW_IPV6_LABEL || a->ipv6_label == b->ipv6_label)
1219 && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1220 &wildcards->ipv6_src_mask)
1221 && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1222 &wildcards->ipv6_dst_mask)
1223 && ipv6_equal_except(&a->nd_target, &b->nd_target,
1224 &wildcards->nd_target_mask));