2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira Networks.
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 rule->wc.wildcards &= ~FWW_DL_SRC;
153 memcpy(rule->flow.dl_src, dl_src, ETH_ADDR_LEN);
156 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' exactly. */
158 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
160 rule->wc.wildcards &= ~(FWW_DL_DST | FWW_ETH_MCAST);
161 memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
164 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' after each
165 * byte is ANDed with the appropriate byte in 'mask'.
167 * This function will assert-fail if 'mask' is invalid. Only 'mask' values
168 * accepted by flow_wildcards_is_dl_dst_mask_valid() are allowed. */
170 cls_rule_set_dl_dst_masked(struct cls_rule *rule,
171 const uint8_t dl_dst[ETH_ADDR_LEN],
172 const uint8_t mask[ETH_ADDR_LEN])
174 flow_wildcards_t *wc = &rule->wc.wildcards;
177 *wc = flow_wildcards_set_dl_dst_mask(*wc, mask);
178 for (i = 0; i < ETH_ADDR_LEN; i++) {
179 rule->flow.dl_dst[i] = dl_dst[i] & mask[i];
184 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
186 cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
190 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
192 rule->flow.vlan_tci = tci & mask;
193 rule->wc.vlan_tci_mask = mask;
196 /* Modifies 'rule' so that the VLAN VID is wildcarded. If the PCP is already
197 * wildcarded, then 'rule' will match a packet regardless of whether it has an
198 * 802.1Q header or not. */
200 cls_rule_set_any_vid(struct cls_rule *rule)
202 if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
203 rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
204 rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
206 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
210 /* Modifies 'rule' depending on 'dl_vlan':
212 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
213 * without an 802.1Q header.
215 * - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
216 * VID equals the low 12 bits of 'dl_vlan'.
219 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
221 flow_set_vlan_vid(&rule->flow, dl_vlan);
222 if (dl_vlan == htons(OFP_VLAN_NONE)) {
223 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
225 rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
229 /* Modifies 'rule' so that the VLAN PCP is wildcarded. If the VID is already
230 * wildcarded, then 'rule' will match a packet regardless of whether it has an
231 * 802.1Q header or not. */
233 cls_rule_set_any_pcp(struct cls_rule *rule)
235 if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
236 rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
237 rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
239 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
243 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
244 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
246 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
248 flow_set_vlan_pcp(&rule->flow, dl_vlan_pcp);
249 rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
253 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
255 cls_rule_set_tp_src_masked(rule, tp_src, htons(UINT16_MAX));
259 cls_rule_set_tp_src_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
261 rule->flow.tp_src = port & mask;
262 rule->wc.tp_src_mask = mask;
266 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
268 cls_rule_set_tp_dst_masked(rule, tp_dst, htons(UINT16_MAX));
272 cls_rule_set_tp_dst_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
274 rule->flow.tp_dst = port & mask;
275 rule->wc.tp_dst_mask = mask;
279 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
281 rule->wc.wildcards &= ~FWW_NW_PROTO;
282 rule->flow.nw_proto = nw_proto;
286 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
288 rule->flow.nw_src = nw_src;
289 rule->wc.nw_src_mask = htonl(UINT32_MAX);
293 cls_rule_set_nw_src_masked(struct cls_rule *rule,
294 ovs_be32 nw_src, ovs_be32 mask)
296 rule->flow.nw_src = nw_src & mask;
297 rule->wc.nw_src_mask = mask;
301 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
303 rule->flow.nw_dst = nw_dst;
304 rule->wc.nw_dst_mask = htonl(UINT32_MAX);
308 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
310 rule->flow.nw_dst = ip & mask;
311 rule->wc.nw_dst_mask = mask;
315 cls_rule_set_nw_dscp(struct cls_rule *rule, uint8_t nw_dscp)
317 rule->wc.wildcards &= ~FWW_NW_DSCP;
318 rule->flow.nw_tos &= ~IP_DSCP_MASK;
319 rule->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
323 cls_rule_set_nw_ecn(struct cls_rule *rule, uint8_t nw_ecn)
325 rule->wc.wildcards &= ~FWW_NW_ECN;
326 rule->flow.nw_tos &= ~IP_ECN_MASK;
327 rule->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
331 cls_rule_set_nw_ttl(struct cls_rule *rule, uint8_t nw_ttl)
333 rule->wc.wildcards &= ~FWW_NW_TTL;
334 rule->flow.nw_ttl = nw_ttl;
338 cls_rule_set_nw_frag(struct cls_rule *rule, uint8_t nw_frag)
340 rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
341 rule->flow.nw_frag = nw_frag;
345 cls_rule_set_nw_frag_masked(struct cls_rule *rule,
346 uint8_t nw_frag, uint8_t mask)
348 rule->flow.nw_frag = nw_frag & mask;
349 rule->wc.nw_frag_mask = mask;
353 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
355 cls_rule_set_tp_src(rule, htons(icmp_type));
359 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
361 cls_rule_set_tp_dst(rule, htons(icmp_code));
365 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
367 rule->wc.wildcards &= ~FWW_ARP_SHA;
368 memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
372 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
374 rule->wc.wildcards &= ~FWW_ARP_THA;
375 memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
379 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
381 rule->flow.ipv6_src = *src;
382 rule->wc.ipv6_src_mask = in6addr_exact;
386 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
387 const struct in6_addr *mask)
389 rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
390 rule->wc.ipv6_src_mask = *mask;
394 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
396 rule->flow.ipv6_dst = *dst;
397 rule->wc.ipv6_dst_mask = in6addr_exact;
401 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
402 const struct in6_addr *mask)
404 rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
405 rule->wc.ipv6_dst_mask = *mask;
409 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
411 rule->wc.wildcards &= ~FWW_IPV6_LABEL;
412 rule->flow.ipv6_label = ipv6_label;
416 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
418 rule->wc.wildcards &= ~FWW_ND_TARGET;
419 rule->flow.nd_target = *target;
422 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
423 * fields, and have the same values for fixed fields, otherwise false. */
425 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
427 return (a->priority == b->priority
428 && flow_wildcards_equal(&a->wc, &b->wc)
429 && flow_equal(&a->flow, &b->flow));
432 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
433 * starting from 'basis'. */
435 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
437 uint32_t h0 = flow_hash(&rule->flow, basis);
438 uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
439 return hash_int(rule->priority, h1);
443 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
447 ds_put_format(s, "%s=", name);
448 ip_format_masked(ip, netmask, s);
454 format_ipv6_netmask(struct ds *s, const char *name,
455 const struct in6_addr *addr,
456 const struct in6_addr *netmask)
458 if (!ipv6_mask_is_any(netmask)) {
459 ds_put_format(s, "%s=", name);
460 print_ipv6_masked(s, addr, netmask);
467 format_be16_masked(struct ds *s, const char *name,
468 ovs_be16 value, ovs_be16 mask)
470 if (mask != htons(0)) {
471 ds_put_format(s, "%s=", name);
472 if (mask == htons(UINT16_MAX)) {
473 ds_put_format(s, "%"PRIu16, ntohs(value));
475 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
476 ntohs(value), ntohs(mask));
483 cls_rule_format(const struct cls_rule *rule, struct ds *s)
485 const struct flow_wildcards *wc = &rule->wc;
486 size_t start_len = s->length;
487 flow_wildcards_t w = wc->wildcards;
488 const struct flow *f = &rule->flow;
489 bool skip_type = false;
490 bool skip_proto = false;
494 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 8);
496 if (rule->priority != OFP_DEFAULT_PRIORITY) {
497 ds_put_format(s, "priority=%d,", rule->priority);
500 if (!(w & FWW_DL_TYPE)) {
502 if (f->dl_type == htons(ETH_TYPE_IP)) {
503 if (!(w & FWW_NW_PROTO)) {
505 if (f->nw_proto == IPPROTO_ICMP) {
506 ds_put_cstr(s, "icmp,");
507 } else if (f->nw_proto == IPPROTO_TCP) {
508 ds_put_cstr(s, "tcp,");
509 } else if (f->nw_proto == IPPROTO_UDP) {
510 ds_put_cstr(s, "udp,");
512 ds_put_cstr(s, "ip,");
516 ds_put_cstr(s, "ip,");
518 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
519 if (!(w & FWW_NW_PROTO)) {
521 if (f->nw_proto == IPPROTO_ICMPV6) {
522 ds_put_cstr(s, "icmp6,");
523 } else if (f->nw_proto == IPPROTO_TCP) {
524 ds_put_cstr(s, "tcp6,");
525 } else if (f->nw_proto == IPPROTO_UDP) {
526 ds_put_cstr(s, "udp6,");
528 ds_put_cstr(s, "ipv6,");
532 ds_put_cstr(s, "ipv6,");
534 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
535 ds_put_cstr(s, "arp,");
540 for (i = 0; i < FLOW_N_REGS; i++) {
541 switch (wc->reg_masks[i]) {
545 ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
548 ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
549 i, f->regs[i], wc->reg_masks[i]);
553 switch (wc->tun_id_mask) {
556 case CONSTANT_HTONLL(UINT64_MAX):
557 ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
560 ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
561 ntohll(f->tun_id), ntohll(wc->tun_id_mask));
564 if (!(w & FWW_IN_PORT)) {
565 ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
567 if (wc->vlan_tci_mask) {
568 ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
569 ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
570 ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
572 if (cfi && f->vlan_tci & htons(VLAN_CFI)
573 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
574 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
575 && (vid_mask || pcp_mask)) {
577 ds_put_format(s, "dl_vlan=%"PRIu16",",
578 vlan_tci_to_vid(f->vlan_tci));
581 ds_put_format(s, "dl_vlan_pcp=%d,",
582 vlan_tci_to_pcp(f->vlan_tci));
584 } else if (wc->vlan_tci_mask == htons(0xffff)) {
585 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
587 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
588 ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
591 if (!(w & FWW_DL_SRC)) {
592 ds_put_format(s, "dl_src="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_src));
594 switch (w & (FWW_DL_DST | FWW_ETH_MCAST)) {
596 ds_put_format(s, "dl_dst="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_dst));
599 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/01:00:00:00:00:00,",
600 ETH_ADDR_ARGS(f->dl_dst));
603 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/fe:ff:ff:ff:ff:ff,",
604 ETH_ADDR_ARGS(f->dl_dst));
606 case FWW_DL_DST | FWW_ETH_MCAST:
609 if (!skip_type && !(w & FWW_DL_TYPE)) {
610 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
612 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
613 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
614 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
615 if (!(w & FWW_IPV6_LABEL)) {
616 ds_put_format(s, "ipv6_label=0x%05"PRIx32",", ntohl(f->ipv6_label));
619 format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
620 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
622 if (!skip_proto && !(w & FWW_NW_PROTO)) {
623 if (f->dl_type == htons(ETH_TYPE_ARP)) {
624 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
626 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
629 if (f->dl_type == htons(ETH_TYPE_ARP)) {
630 if (!(w & FWW_ARP_SHA)) {
631 ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
632 ETH_ADDR_ARGS(f->arp_sha));
634 if (!(w & FWW_ARP_THA)) {
635 ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
636 ETH_ADDR_ARGS(f->arp_tha));
639 if (!(w & FWW_NW_DSCP)) {
640 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
642 if (!(w & FWW_NW_ECN)) {
643 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
645 if (!(w & FWW_NW_TTL)) {
646 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
648 switch (wc->nw_frag_mask) {
649 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
650 ds_put_format(s, "nw_frag=%s,",
651 f->nw_frag & FLOW_NW_FRAG_ANY
652 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
653 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
656 case FLOW_NW_FRAG_ANY:
657 ds_put_format(s, "nw_frag=%s,",
658 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
661 case FLOW_NW_FRAG_LATER:
662 ds_put_format(s, "nw_frag=%s,",
663 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
666 if (f->nw_proto == IPPROTO_ICMP) {
667 format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
668 format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
669 } else if (f->nw_proto == IPPROTO_ICMPV6) {
670 format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
671 format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
672 if (!(w & FWW_ND_TARGET)) {
673 ds_put_cstr(s, "nd_target=");
674 print_ipv6_addr(s, &f->nd_target);
677 if (!(w & FWW_ARP_SHA)) {
678 ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
679 ETH_ADDR_ARGS(f->arp_sha));
681 if (!(w & FWW_ARP_THA)) {
682 ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
683 ETH_ADDR_ARGS(f->arp_tha));
686 format_be16_masked(s, "tp_src", f->tp_src, wc->tp_src_mask);
687 format_be16_masked(s, "tp_dst", f->tp_dst, wc->tp_dst_mask);
690 if (s->length > start_len && ds_last(s) == ',') {
695 /* Converts 'rule' to a string and returns the string. The caller must free
696 * the string (with free()). */
698 cls_rule_to_string(const struct cls_rule *rule)
700 struct ds s = DS_EMPTY_INITIALIZER;
701 cls_rule_format(rule, &s);
702 return ds_steal_cstr(&s);
706 cls_rule_print(const struct cls_rule *rule)
708 char *s = cls_rule_to_string(rule);
713 /* Initializes 'cls' as a classifier that initially contains no classification
716 classifier_init(struct classifier *cls)
719 hmap_init(&cls->tables);
722 /* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
723 * caller's responsibility. */
725 classifier_destroy(struct classifier *cls)
728 struct cls_table *table, *next_table;
730 HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
731 hmap_destroy(&table->rules);
732 hmap_remove(&cls->tables, &table->hmap_node);
735 hmap_destroy(&cls->tables);
739 /* Returns true if 'cls' contains no classification rules, false otherwise. */
741 classifier_is_empty(const struct classifier *cls)
743 return cls->n_rules == 0;
746 /* Returns the number of rules in 'classifier'. */
748 classifier_count(const struct classifier *cls)
753 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
754 * must not modify or free it.
756 * If 'cls' already contains an identical rule (including wildcards, values of
757 * fixed fields, and priority), replaces the old rule by 'rule' and returns the
758 * rule that was replaced. The caller takes ownership of the returned rule and
759 * is thus responsible for freeing it, etc., as necessary.
761 * Returns NULL if 'cls' does not contain a rule with an identical key, after
762 * inserting the new rule. In this case, no rules are displaced by the new
763 * rule, even rules that cannot have any effect because the new rule matches a
764 * superset of their flows and has higher priority. */
766 classifier_replace(struct classifier *cls, struct cls_rule *rule)
768 struct cls_rule *old_rule;
769 struct cls_table *table;
771 table = find_table(cls, &rule->wc);
773 table = insert_table(cls, &rule->wc);
776 old_rule = insert_rule(table, rule);
778 table->n_table_rules++;
784 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
785 * must not modify or free it.
787 * 'cls' must not contain an identical rule (including wildcards, values of
788 * fixed fields, and priority). Use classifier_find_rule_exactly() to find
791 classifier_insert(struct classifier *cls, struct cls_rule *rule)
793 struct cls_rule *displaced_rule = classifier_replace(cls, rule);
794 assert(!displaced_rule);
797 /* Removes 'rule' from 'cls'. It is the caller's responsibility to free
798 * 'rule', if this is desirable. */
800 classifier_remove(struct classifier *cls, struct cls_rule *rule)
802 struct cls_rule *head;
803 struct cls_table *table;
805 table = find_table(cls, &rule->wc);
806 head = find_equal(table, &rule->flow, rule->hmap_node.hash);
808 list_remove(&rule->list);
809 } else if (list_is_empty(&rule->list)) {
810 hmap_remove(&table->rules, &rule->hmap_node);
812 struct cls_rule *next = CONTAINER_OF(rule->list.next,
813 struct cls_rule, list);
815 list_remove(&rule->list);
816 hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
819 if (--table->n_table_rules == 0) {
820 destroy_table(cls, table);
826 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
827 * Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
828 * of equal priority match 'flow', returns one arbitrarily. */
830 classifier_lookup(const struct classifier *cls, const struct flow *flow)
832 struct cls_table *table;
833 struct cls_rule *best;
836 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
837 struct cls_rule *rule = find_match(table, flow);
838 if (rule && (!best || rule->priority > best->priority)) {
845 /* Finds and returns a rule in 'cls' with exactly the same priority and
846 * matching criteria as 'target'. Returns a null pointer if 'cls' doesn't
847 * contain an exact match. */
849 classifier_find_rule_exactly(const struct classifier *cls,
850 const struct cls_rule *target)
852 struct cls_rule *head, *rule;
853 struct cls_table *table;
855 table = find_table(cls, &target->wc);
860 head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
861 FOR_EACH_RULE_IN_LIST (rule, head) {
862 if (target->priority >= rule->priority) {
863 return target->priority == rule->priority ? rule : NULL;
869 /* Checks if 'target' would overlap any other rule in 'cls'. Two rules are
870 * considered to overlap if both rules have the same priority and a packet
871 * could match both. */
873 classifier_rule_overlaps(const struct classifier *cls,
874 const struct cls_rule *target)
876 struct cls_table *table;
878 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
879 struct flow_wildcards wc;
880 struct cls_rule *head;
882 flow_wildcards_combine(&wc, &target->wc, &table->wc);
883 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
884 struct cls_rule *rule;
886 FOR_EACH_RULE_IN_LIST (rule, head) {
887 if (rule->priority == target->priority
888 && flow_equal_except(&target->flow, &rule->flow, &wc)) {
901 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
904 || flow_equal_except(&rule->flow, &target->flow, &target->wc));
907 static struct cls_rule *
908 search_table(const struct cls_table *table, const struct cls_rule *target)
910 if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
911 struct cls_rule *rule;
913 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
914 if (rule_matches(rule, target)) {
922 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
923 * 'target' or are more specific than 'target'. That is, a given 'rule'
924 * matches 'target' if, for every field:
926 * - 'target' and 'rule' specify the same (non-wildcarded) value for the
929 * - 'target' wildcards the field,
933 * - 'target' and 'rule' specify different values for the field, or
935 * - 'target' specifies a value for the field but 'rule' wildcards it.
937 * Equivalently, the truth table for whether a field matches is:
942 * +---------+---------+
943 * t wild | yes | yes |
945 * r +---------+---------+
946 * g exact | no |if values|
948 * t +---------+---------+
950 * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
951 * commands and by OpenFlow 1.0 aggregate and flow stats.
953 * Ignores target->priority.
955 * 'target' may be NULL to iterate over every rule in 'cls'. */
957 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
958 const struct cls_rule *target)
961 cursor->target = target;
964 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
965 * pointer if there are no matches. */
967 cls_cursor_first(struct cls_cursor *cursor)
969 struct cls_table *table;
971 HMAP_FOR_EACH (table, hmap_node, &cursor->cls->tables) {
972 struct cls_rule *rule = search_table(table, cursor->target);
974 cursor->table = table;
982 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
983 * pointer if there are no more matches. */
985 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
987 const struct cls_table *table;
988 struct cls_rule *next;
990 next = next_rule_in_list__(rule);
991 if (next->priority < rule->priority) {
995 /* 'next' is the head of the list, that is, the rule that is included in
996 * the table's hmap. (This is important when the classifier contains rules
997 * that differ only in priority.) */
999 HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
1000 if (rule_matches(rule, cursor->target)) {
1005 table = cursor->table;
1006 HMAP_FOR_EACH_CONTINUE (table, hmap_node, &cursor->cls->tables) {
1007 rule = search_table(table, cursor->target);
1009 cursor->table = table;
1017 static struct cls_table *
1018 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1020 struct cls_table *table;
1022 HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1024 if (flow_wildcards_equal(wc, &table->wc)) {
1031 static struct cls_table *
1032 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1034 struct cls_table *table;
1036 table = xzalloc(sizeof *table);
1037 hmap_init(&table->rules);
1039 hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1045 destroy_table(struct classifier *cls, struct cls_table *table)
1047 hmap_remove(&cls->tables, &table->hmap_node);
1048 hmap_destroy(&table->rules);
1052 static struct cls_rule *
1053 find_match(const struct cls_table *table, const struct flow *flow)
1055 struct cls_rule *rule;
1059 flow_zero_wildcards(&f, &table->wc);
1060 HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1062 if (flow_equal(&f, &rule->flow)) {
1069 static struct cls_rule *
1070 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1072 struct cls_rule *head;
1074 HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1075 if (flow_equal(&head->flow, flow)) {
1082 static struct cls_rule *
1083 insert_rule(struct cls_table *table, struct cls_rule *new)
1085 struct cls_rule *head;
1087 new->hmap_node.hash = flow_hash(&new->flow, 0);
1089 head = find_equal(table, &new->flow, new->hmap_node.hash);
1091 hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1092 list_init(&new->list);
1095 /* Scan the list for the insertion point that will keep the list in
1096 * order of decreasing priority. */
1097 struct cls_rule *rule;
1098 FOR_EACH_RULE_IN_LIST (rule, head) {
1099 if (new->priority >= rule->priority) {
1101 /* 'new' is the new highest-priority flow in the list. */
1102 hmap_replace(&table->rules,
1103 &rule->hmap_node, &new->hmap_node);
1106 if (new->priority == rule->priority) {
1107 list_replace(&new->list, &rule->list);
1110 list_insert(&rule->list, &new->list);
1116 /* Insert 'new' at the end of the list. */
1117 list_push_back(&head->list, &new->list);
1122 static struct cls_rule *
1123 next_rule_in_list__(struct cls_rule *rule)
1125 struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1129 static struct cls_rule *
1130 next_rule_in_list(struct cls_rule *rule)
1132 struct cls_rule *next = next_rule_in_list__(rule);
1133 return next->priority < rule->priority ? next : NULL;
1137 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1138 const struct in6_addr *mask)
1143 for (i=0; i<4; i++) {
1144 if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1149 for (i=0; i<16; i++) {
1150 if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1161 flow_equal_except(const struct flow *a, const struct flow *b,
1162 const struct flow_wildcards *wildcards)
1164 const flow_wildcards_t wc = wildcards->wildcards;
1167 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 8);
1169 for (i = 0; i < FLOW_N_REGS; i++) {
1170 if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1175 return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1176 && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1177 && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1178 && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1179 && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1180 && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1181 && !((a->tp_src ^ b->tp_src) & wildcards->tp_src_mask)
1182 && !((a->tp_dst ^ b->tp_dst) & wildcards->tp_dst_mask)
1183 && (wc & FWW_DL_SRC || eth_addr_equals(a->dl_src, b->dl_src))
1185 || (!((a->dl_dst[0] ^ b->dl_dst[0]) & 0xfe)
1186 && a->dl_dst[1] == b->dl_dst[1]
1187 && a->dl_dst[2] == b->dl_dst[2]
1188 && a->dl_dst[3] == b->dl_dst[3]
1189 && a->dl_dst[4] == b->dl_dst[4]
1190 && a->dl_dst[5] == b->dl_dst[5]))
1191 && (wc & FWW_ETH_MCAST
1192 || !((a->dl_dst[0] ^ b->dl_dst[0]) & 0x01))
1193 && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1194 && (wc & FWW_NW_TTL || a->nw_ttl == b->nw_ttl)
1195 && (wc & FWW_NW_DSCP || !((a->nw_tos ^ b->nw_tos) & IP_DSCP_MASK))
1196 && (wc & FWW_NW_ECN || !((a->nw_tos ^ b->nw_tos) & IP_ECN_MASK))
1197 && !((a->nw_frag ^ b->nw_frag) & wildcards->nw_frag_mask)
1198 && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1199 && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1200 && (wc & FWW_IPV6_LABEL || a->ipv6_label == b->ipv6_label)
1201 && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1202 &wildcards->ipv6_src_mask)
1203 && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1204 &wildcards->ipv6_dst_mask)
1205 && (wc & FWW_ND_TARGET
1206 || ipv6_addr_equals(&a->nd_target, &b->nd_target)));