2 * Copyright (c) 2009, 2010, 2011 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 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 *);
40 static struct cls_rule *find_match(const struct cls_table *,
42 static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
44 static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
46 static bool flow_equal_except(const struct flow *, const struct flow *,
47 const struct flow_wildcards *);
49 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
50 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD) \
51 for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
52 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD) \
53 for ((RULE) = (HEAD); \
54 (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true); \
57 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
58 static struct cls_rule *next_rule_in_list(struct cls_rule *);
60 static struct cls_table *
61 cls_table_from_hmap_node(const struct hmap_node *node)
63 return node ? CONTAINER_OF(node, struct cls_table, hmap_node) : NULL;
66 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
67 * 'wildcards' and 'priority'. */
69 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
70 unsigned int priority, struct cls_rule *rule)
73 rule->wc = *wildcards;
74 rule->priority = priority;
75 cls_rule_zero_wildcarded_fields(rule);
78 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
79 * given 'priority'. (For OpenFlow 1.0, exact-match rule are always highest
80 * priority, so 'priority' should be at least 65535.) */
82 cls_rule_init_exact(const struct flow *flow,
83 unsigned int priority, struct cls_rule *rule)
86 rule->flow.priority = 0;
87 flow_wildcards_init_exact(&rule->wc);
88 rule->priority = priority;
91 /* Initializes 'rule' as a "catch-all" rule that matches every packet, with
92 * priority 'priority'. */
94 cls_rule_init_catchall(struct cls_rule *rule, unsigned int priority)
96 memset(&rule->flow, 0, sizeof rule->flow);
97 flow_wildcards_init_catchall(&rule->wc);
98 rule->priority = priority;
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.
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.
110 cls_rule_zero_wildcarded_fields(struct cls_rule *rule)
112 flow_zero_wildcards(&rule->flow, &rule->wc);
116 cls_rule_set_reg(struct cls_rule *rule, unsigned int reg_idx, uint32_t value)
118 cls_rule_set_reg_masked(rule, reg_idx, value, UINT32_MAX);
122 cls_rule_set_reg_masked(struct cls_rule *rule, unsigned int reg_idx,
123 uint32_t value, uint32_t mask)
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;
131 cls_rule_set_tun_id(struct cls_rule *rule, ovs_be64 tun_id)
133 cls_rule_set_tun_id_masked(rule, tun_id, htonll(UINT64_MAX));
137 cls_rule_set_tun_id_masked(struct cls_rule *rule,
138 ovs_be64 tun_id, ovs_be64 mask)
140 rule->wc.tun_id_mask = mask;
141 rule->flow.tun_id = tun_id & mask;
145 cls_rule_set_in_port(struct cls_rule *rule, uint16_t ofp_port)
147 rule->wc.wildcards &= ~FWW_IN_PORT;
148 rule->flow.in_port = ofp_port;
152 cls_rule_set_dl_type(struct cls_rule *rule, ovs_be16 dl_type)
154 rule->wc.wildcards &= ~FWW_DL_TYPE;
155 rule->flow.dl_type = dl_type;
159 cls_rule_set_dl_src(struct cls_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
161 rule->wc.wildcards &= ~FWW_DL_SRC;
162 memcpy(rule->flow.dl_src, dl_src, ETH_ADDR_LEN);
165 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' exactly. */
167 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
169 rule->wc.wildcards &= ~(FWW_DL_DST | FWW_ETH_MCAST);
170 memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
173 /* Modifies 'rule' so that the Ethernet address must match 'dl_dst' after each
174 * byte is ANDed with the appropriate byte in 'mask'.
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. */
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])
183 flow_wildcards_t *wc = &rule->wc.wildcards;
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];
193 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
195 cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
199 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
201 rule->flow.vlan_tci = tci & mask;
202 rule->wc.vlan_tci_mask = mask;
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. */
209 cls_rule_set_any_vid(struct cls_rule *rule)
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);
215 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
219 /* Modifies 'rule' depending on 'dl_vlan':
221 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
222 * without an 802.1Q header.
224 * - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
225 * VID equals the low 12 bits of 'dl_vlan'.
228 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
230 if (dl_vlan == htons(OFP_VLAN_NONE)) {
231 cls_rule_set_dl_tci(rule, htons(0));
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);
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. */
244 cls_rule_set_any_pcp(struct cls_rule *rule)
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);
250 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
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'. */
257 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
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);
266 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
268 rule->wc.wildcards &= ~FWW_TP_SRC;
269 rule->flow.tp_src = tp_src;
273 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
275 rule->wc.wildcards &= ~FWW_TP_DST;
276 rule->flow.tp_dst = tp_dst;
280 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
282 rule->wc.wildcards &= ~FWW_NW_PROTO;
283 rule->flow.nw_proto = nw_proto;
287 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
289 cls_rule_set_nw_src_masked(rule, nw_src, htonl(UINT32_MAX));
293 cls_rule_set_nw_src_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
295 if (flow_wildcards_set_nw_src_mask(&rule->wc, mask)) {
296 rule->flow.nw_src = ip & mask;
304 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
306 cls_rule_set_nw_dst_masked(rule, nw_dst, htonl(UINT32_MAX));
310 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
312 if (flow_wildcards_set_nw_dst_mask(&rule->wc, mask)) {
313 rule->flow.nw_dst = ip & mask;
321 cls_rule_set_nw_tos(struct cls_rule *rule, uint8_t nw_tos)
323 rule->wc.tos_frag_mask |= IP_DSCP_MASK;
324 rule->flow.tos_frag &= ~IP_DSCP_MASK;
325 rule->flow.tos_frag |= nw_tos & IP_DSCP_MASK;
329 cls_rule_set_frag(struct cls_rule *rule, uint8_t frag)
331 rule->wc.tos_frag_mask |= FLOW_FRAG_MASK;
332 rule->flow.tos_frag &= ~FLOW_FRAG_MASK;
333 rule->flow.tos_frag |= frag & FLOW_FRAG_MASK;
337 cls_rule_set_frag_masked(struct cls_rule *rule, uint8_t frag, uint8_t mask)
339 mask &= FLOW_FRAG_MASK;
341 rule->wc.tos_frag_mask = (rule->wc.tos_frag_mask & ~FLOW_FRAG_MASK) | mask;
342 rule->flow.tos_frag = (rule->flow.tos_frag & ~FLOW_FRAG_MASK) | frag;
346 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
348 rule->wc.wildcards &= ~FWW_TP_SRC;
349 rule->flow.tp_src = htons(icmp_type);
354 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
356 rule->wc.wildcards &= ~FWW_TP_DST;
357 rule->flow.tp_dst = htons(icmp_code);
361 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
363 rule->wc.wildcards &= ~FWW_ARP_SHA;
364 memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
368 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
370 rule->wc.wildcards &= ~FWW_ARP_THA;
371 memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
375 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
377 cls_rule_set_ipv6_src_masked(rule, src, &in6addr_exact);
381 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
382 const struct in6_addr *mask)
384 if (flow_wildcards_set_ipv6_src_mask(&rule->wc, mask)) {
385 rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
393 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
395 cls_rule_set_ipv6_dst_masked(rule, dst, &in6addr_exact);
399 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
400 const struct in6_addr *mask)
402 if (flow_wildcards_set_ipv6_dst_mask(&rule->wc, mask)) {
403 rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
411 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
413 rule->wc.wildcards &= ~FWW_ND_TARGET;
414 rule->flow.nd_target = *target;
417 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
418 * fields, and have the same values for fixed fields, otherwise false. */
420 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
422 return (a->priority == b->priority
423 && flow_wildcards_equal(&a->wc, &b->wc)
424 && flow_equal(&a->flow, &b->flow));
427 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
428 * starting from 'basis'. */
430 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
432 uint32_t h0 = flow_hash(&rule->flow, basis);
433 uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
434 return hash_int(rule->priority, h1);
438 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
442 ds_put_format(s, "%s=", name);
443 ip_format_masked(ip, netmask, s);
449 format_ipv6_netmask(struct ds *s, const char *name,
450 const struct in6_addr *addr,
451 const struct in6_addr *netmask)
453 if (!ipv6_mask_is_any(netmask)) {
454 ds_put_format(s, "%s=", name);
455 print_ipv6_masked(s, addr, netmask);
461 cls_rule_format(const struct cls_rule *rule, struct ds *s)
463 const struct flow_wildcards *wc = &rule->wc;
464 size_t start_len = s->length;
465 flow_wildcards_t w = wc->wildcards;
466 const struct flow *f = &rule->flow;
467 bool skip_type = false;
468 bool skip_proto = false;
472 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 3);
474 if (rule->priority != OFP_DEFAULT_PRIORITY) {
475 ds_put_format(s, "priority=%d,", rule->priority);
478 if (!(w & FWW_DL_TYPE)) {
480 if (f->dl_type == htons(ETH_TYPE_IP)) {
481 if (!(w & FWW_NW_PROTO)) {
483 if (f->nw_proto == IPPROTO_ICMP) {
484 ds_put_cstr(s, "icmp,");
485 } else if (f->nw_proto == IPPROTO_TCP) {
486 ds_put_cstr(s, "tcp,");
487 } else if (f->nw_proto == IPPROTO_UDP) {
488 ds_put_cstr(s, "udp,");
490 ds_put_cstr(s, "ip,");
494 ds_put_cstr(s, "ip,");
496 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
497 if (!(w & FWW_NW_PROTO)) {
499 if (f->nw_proto == IPPROTO_ICMPV6) {
500 ds_put_cstr(s, "icmp6,");
501 } else if (f->nw_proto == IPPROTO_TCP) {
502 ds_put_cstr(s, "tcp6,");
503 } else if (f->nw_proto == IPPROTO_UDP) {
504 ds_put_cstr(s, "udp6,");
506 ds_put_cstr(s, "ipv6,");
510 ds_put_cstr(s, "ipv6,");
512 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
513 ds_put_cstr(s, "arp,");
518 for (i = 0; i < FLOW_N_REGS; i++) {
519 switch (wc->reg_masks[i]) {
523 ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
526 ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
527 i, f->regs[i], wc->reg_masks[i]);
531 switch (wc->tun_id_mask) {
534 case CONSTANT_HTONLL(UINT64_MAX):
535 ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
538 ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
539 ntohll(f->tun_id), ntohll(wc->tun_id_mask));
542 if (!(w & FWW_IN_PORT)) {
543 ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
545 if (wc->vlan_tci_mask) {
546 ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
547 ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
548 ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
550 if (cfi && f->vlan_tci & htons(VLAN_CFI)
551 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
552 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
553 && (vid_mask || pcp_mask)) {
555 ds_put_format(s, "dl_vlan=%"PRIu16",",
556 vlan_tci_to_vid(f->vlan_tci));
559 ds_put_format(s, "dl_vlan_pcp=%d,",
560 vlan_tci_to_pcp(f->vlan_tci));
562 } else if (wc->vlan_tci_mask == htons(0xffff)) {
563 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
565 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
566 ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
569 if (!(w & FWW_DL_SRC)) {
570 ds_put_format(s, "dl_src="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_src));
572 switch (w & (FWW_DL_DST | FWW_ETH_MCAST)) {
574 ds_put_format(s, "dl_dst="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_dst));
577 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/01:00:00:00:00:00,",
578 ETH_ADDR_ARGS(f->dl_dst));
581 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/fe:ff:ff:ff:ff:ff,",
582 ETH_ADDR_ARGS(f->dl_dst));
584 case FWW_DL_DST | FWW_ETH_MCAST:
587 if (!skip_type && !(w & FWW_DL_TYPE)) {
588 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
590 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
591 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
592 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
594 format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
595 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
597 if (!skip_proto && !(w & FWW_NW_PROTO)) {
598 if (f->dl_type == htons(ETH_TYPE_ARP)) {
599 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
601 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
604 if (f->dl_type == htons(ETH_TYPE_ARP)) {
605 if (!(w & FWW_ARP_SHA)) {
606 ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
607 ETH_ADDR_ARGS(f->arp_sha));
609 if (!(w & FWW_ARP_THA)) {
610 ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
611 ETH_ADDR_ARGS(f->arp_tha));
614 if (wc->tos_frag_mask & IP_DSCP_MASK) {
615 ds_put_format(s, "nw_tos=%"PRIu8",", f->tos_frag & IP_DSCP_MASK);
617 switch (wc->tos_frag_mask & FLOW_FRAG_MASK) {
618 case FLOW_FRAG_ANY | FLOW_FRAG_LATER:
619 ds_put_format(s, "frag=%s,",
620 f->tos_frag & FLOW_FRAG_ANY
621 ? (f->tos_frag & FLOW_FRAG_LATER ? "later" : "first")
622 : (f->tos_frag & FLOW_FRAG_LATER ? "<error>" : "no"));
626 ds_put_format(s, "frag=%s,",
627 f->tos_frag & FLOW_FRAG_ANY ? "yes" : "no");
630 case FLOW_FRAG_LATER:
631 ds_put_format(s, "frag=%s,",
632 f->tos_frag & FLOW_FRAG_LATER ? "later" : "not_later");
635 if (f->nw_proto == IPPROTO_ICMP) {
636 if (!(w & FWW_TP_SRC)) {
637 ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
639 if (!(w & FWW_TP_DST)) {
640 ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
642 } else if (f->nw_proto == IPPROTO_ICMPV6) {
643 if (!(w & FWW_TP_SRC)) {
644 ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
646 if (!(w & FWW_TP_DST)) {
647 ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
649 if (!(w & FWW_ND_TARGET)) {
650 ds_put_cstr(s, "nd_target=");
651 print_ipv6_addr(s, &f->nd_target);
654 if (!(w & FWW_ARP_SHA)) {
655 ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
656 ETH_ADDR_ARGS(f->arp_sha));
658 if (!(w & FWW_ARP_THA)) {
659 ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
660 ETH_ADDR_ARGS(f->arp_tha));
663 if (!(w & FWW_TP_SRC)) {
664 ds_put_format(s, "tp_src=%"PRIu16",", ntohs(f->tp_src));
666 if (!(w & FWW_TP_DST)) {
667 ds_put_format(s, "tp_dst=%"PRIu16",", ntohs(f->tp_dst));
671 if (s->length > start_len && ds_last(s) == ',') {
676 /* Converts 'rule' to a string and returns the string. The caller must free
677 * the string (with free()). */
679 cls_rule_to_string(const struct cls_rule *rule)
681 struct ds s = DS_EMPTY_INITIALIZER;
682 cls_rule_format(rule, &s);
683 return ds_steal_cstr(&s);
687 cls_rule_print(const struct cls_rule *rule)
689 char *s = cls_rule_to_string(rule);
694 /* Initializes 'cls' as a classifier that initially contains no classification
697 classifier_init(struct classifier *cls)
700 hmap_init(&cls->tables);
703 /* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
704 * caller's responsibility. */
706 classifier_destroy(struct classifier *cls)
709 struct cls_table *table, *next_table;
711 HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
712 hmap_destroy(&table->rules);
713 hmap_remove(&cls->tables, &table->hmap_node);
716 hmap_destroy(&cls->tables);
720 /* Returns true if 'cls' contains no classification rules, false otherwise. */
722 classifier_is_empty(const struct classifier *cls)
724 return cls->n_rules == 0;
727 /* Returns the number of rules in 'classifier'. */
729 classifier_count(const struct classifier *cls)
734 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
735 * must not modify or free it.
737 * If 'cls' already contains an identical rule (including wildcards, values of
738 * fixed fields, and priority), replaces the old rule by 'rule' and returns the
739 * rule that was replaced. The caller takes ownership of the returned rule and
740 * is thus responsible for freeing it, etc., as necessary.
742 * Returns NULL if 'cls' does not contain a rule with an identical key, after
743 * inserting the new rule. In this case, no rules are displaced by the new
744 * rule, even rules that cannot have any effect because the new rule matches a
745 * superset of their flows and has higher priority. */
747 classifier_replace(struct classifier *cls, struct cls_rule *rule)
749 struct cls_rule *old_rule;
750 struct cls_table *table;
752 table = find_table(cls, &rule->wc);
754 table = insert_table(cls, &rule->wc);
757 old_rule = insert_rule(table, rule);
759 table->n_table_rules++;
765 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
766 * must not modify or free it.
768 * 'cls' must not contain an identical rule (including wildcards, values of
769 * fixed fields, and priority). Use classifier_find_rule_exactly() to find
772 classifier_insert(struct classifier *cls, struct cls_rule *rule)
774 struct cls_rule *displaced_rule = classifier_replace(cls, rule);
775 assert(!displaced_rule);
778 /* Removes 'rule' from 'cls'. It is the caller's responsibility to free
779 * 'rule', if this is desirable. */
781 classifier_remove(struct classifier *cls, struct cls_rule *rule)
783 struct cls_rule *head;
784 struct cls_table *table;
786 table = find_table(cls, &rule->wc);
787 head = find_equal(table, &rule->flow, rule->hmap_node.hash);
789 list_remove(&rule->list);
790 } else if (list_is_empty(&rule->list)) {
791 hmap_remove(&table->rules, &rule->hmap_node);
793 struct cls_rule *next = CONTAINER_OF(rule->list.next,
794 struct cls_rule, list);
796 list_remove(&rule->list);
797 hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
800 if (--table->n_table_rules == 0) {
801 destroy_table(cls, table);
807 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
808 * Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
809 * of equal priority match 'flow', returns one arbitrarily. */
811 classifier_lookup(const struct classifier *cls, const struct flow *flow)
813 struct cls_table *table;
814 struct cls_rule *best;
817 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
818 struct cls_rule *rule = find_match(table, flow);
819 if (rule && (!best || rule->priority > best->priority)) {
826 /* Finds and returns a rule in 'cls' with exactly the same priority and
827 * matching criteria as 'target'. Returns a null pointer if 'cls' doesn't
828 * contain an exact match. */
830 classifier_find_rule_exactly(const struct classifier *cls,
831 const struct cls_rule *target)
833 struct cls_rule *head, *rule;
834 struct cls_table *table;
836 table = find_table(cls, &target->wc);
841 head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
842 FOR_EACH_RULE_IN_LIST (rule, head) {
843 if (target->priority >= rule->priority) {
844 return target->priority == rule->priority ? rule : NULL;
850 /* Checks if 'target' would overlap any other rule in 'cls'. Two rules are
851 * considered to overlap if both rules have the same priority and a packet
852 * could match both. */
854 classifier_rule_overlaps(const struct classifier *cls,
855 const struct cls_rule *target)
857 struct cls_table *table;
859 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
860 struct flow_wildcards wc;
861 struct cls_rule *head;
863 flow_wildcards_combine(&wc, &target->wc, &table->wc);
864 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
865 struct cls_rule *rule;
867 FOR_EACH_RULE_IN_LIST (rule, head) {
868 if (rule->priority == target->priority
869 && flow_equal_except(&target->flow, &rule->flow, &wc)) {
882 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
885 || flow_equal_except(&rule->flow, &target->flow, &target->wc));
888 static struct cls_rule *
889 search_table(const struct cls_table *table, const struct cls_rule *target)
891 if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
892 struct cls_rule *rule;
894 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
895 if (rule_matches(rule, target)) {
903 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
904 * 'target' or are more specific than 'target'. That is, a given 'rule'
905 * matches 'target' if, for every field:
907 * - 'target' and 'rule' specify the same (non-wildcarded) value for the
910 * - 'target' wildcards the field,
914 * - 'target' and 'rule' specify different values for the field, or
916 * - 'target' specifies a value for the field but 'rule' wildcards it.
918 * Equivalently, the truth table for whether a field matches is:
923 * +---------+---------+
924 * t wild | yes | yes |
926 * r +---------+---------+
927 * g exact | no |if values|
929 * t +---------+---------+
931 * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
932 * commands and by OpenFlow 1.0 aggregate and flow stats.
934 * Ignores target->priority.
936 * 'target' may be NULL to iterate over every rule in 'cls'. */
938 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
939 const struct cls_rule *target)
942 cursor->target = target;
945 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
946 * pointer if there are no matches. */
948 cls_cursor_first(struct cls_cursor *cursor)
950 struct cls_table *table;
952 for (table = classifier_first_table(cursor->cls); table;
953 table = classifier_next_table(cursor->cls, table)) {
954 struct cls_rule *rule = search_table(table, cursor->target);
956 cursor->table = table;
964 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
965 * pointer if there are no more matches. */
967 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
969 const struct cls_table *table;
970 struct cls_rule *next;
972 next = next_rule_in_list__(rule);
973 if (next->priority < rule->priority) {
977 /* 'next' is the head of the list, that is, the rule that is included in
978 * the table's hmap. (This is important when the classifier contains rules
979 * that differ only in priority.) */
981 HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
982 if (rule_matches(rule, cursor->target)) {
987 for (table = classifier_next_table(cursor->cls, cursor->table); table;
988 table = classifier_next_table(cursor->cls, table)) {
989 rule = search_table(table, cursor->target);
991 cursor->table = table;
999 static struct cls_table *
1000 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1002 struct cls_table *table;
1004 HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1006 if (flow_wildcards_equal(wc, &table->wc)) {
1013 static struct cls_table *
1014 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1016 struct cls_table *table;
1018 table = xzalloc(sizeof *table);
1019 hmap_init(&table->rules);
1021 hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1026 static struct cls_table *
1027 classifier_first_table(const struct classifier *cls)
1029 return cls_table_from_hmap_node(hmap_first(&cls->tables));
1032 static struct cls_table *
1033 classifier_next_table(const struct classifier *cls,
1034 const struct cls_table *table)
1036 return cls_table_from_hmap_node(hmap_next(&cls->tables,
1037 &table->hmap_node));
1041 destroy_table(struct classifier *cls, struct cls_table *table)
1043 hmap_remove(&cls->tables, &table->hmap_node);
1044 hmap_destroy(&table->rules);
1048 static struct cls_rule *
1049 find_match(const struct cls_table *table, const struct flow *flow)
1051 struct cls_rule *rule;
1055 flow_zero_wildcards(&f, &table->wc);
1056 HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1058 if (flow_equal(&f, &rule->flow)) {
1065 static struct cls_rule *
1066 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1068 struct cls_rule *head;
1070 HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1071 if (flow_equal(&head->flow, flow)) {
1078 static struct cls_rule *
1079 insert_rule(struct cls_table *table, struct cls_rule *new)
1081 struct cls_rule *head;
1083 new->hmap_node.hash = flow_hash(&new->flow, 0);
1085 head = find_equal(table, &new->flow, new->hmap_node.hash);
1087 hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1088 list_init(&new->list);
1091 /* Scan the list for the insertion point that will keep the list in
1092 * order of decreasing priority. */
1093 struct cls_rule *rule;
1094 FOR_EACH_RULE_IN_LIST (rule, head) {
1095 if (new->priority >= rule->priority) {
1097 /* 'new' is the new highest-priority flow in the list. */
1098 hmap_replace(&table->rules,
1099 &rule->hmap_node, &new->hmap_node);
1102 if (new->priority == rule->priority) {
1103 list_replace(&new->list, &rule->list);
1106 list_insert(&rule->list, &new->list);
1112 /* Insert 'new' at the end of the list. */
1113 list_push_back(&head->list, &new->list);
1118 static struct cls_rule *
1119 next_rule_in_list__(struct cls_rule *rule)
1121 struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1125 static struct cls_rule *
1126 next_rule_in_list(struct cls_rule *rule)
1128 struct cls_rule *next = next_rule_in_list__(rule);
1129 return next->priority < rule->priority ? next : NULL;
1133 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1134 const struct in6_addr *mask)
1139 for (i=0; i<4; i++) {
1140 if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1145 for (i=0; i<16; i++) {
1146 if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1157 flow_equal_except(const struct flow *a, const struct flow *b,
1158 const struct flow_wildcards *wildcards)
1160 const flow_wildcards_t wc = wildcards->wildcards;
1163 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 3);
1165 for (i = 0; i < FLOW_N_REGS; i++) {
1166 if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1171 return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1172 && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1173 && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1174 && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1175 && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1176 && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1177 && (wc & FWW_TP_SRC || a->tp_src == b->tp_src)
1178 && (wc & FWW_TP_DST || a->tp_dst == b->tp_dst)
1179 && (wc & FWW_DL_SRC || eth_addr_equals(a->dl_src, b->dl_src))
1181 || (!((a->dl_dst[0] ^ b->dl_dst[0]) & 0xfe)
1182 && a->dl_dst[1] == b->dl_dst[1]
1183 && a->dl_dst[2] == b->dl_dst[2]
1184 && a->dl_dst[3] == b->dl_dst[3]
1185 && a->dl_dst[4] == b->dl_dst[4]
1186 && a->dl_dst[5] == b->dl_dst[5]))
1187 && (wc & FWW_ETH_MCAST
1188 || !((a->dl_dst[0] ^ b->dl_dst[0]) & 0x01))
1189 && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1190 && !((a->tos_frag ^ b->tos_frag) & wildcards->tos_frag_mask)
1191 && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1192 && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1193 && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1194 &wildcards->ipv6_src_mask)
1195 && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1196 &wildcards->ipv6_dst_mask)
1197 && (wc & FWW_ND_TARGET
1198 || ipv6_addr_equals(&a->nd_target, &b->nd_target)));