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 *);
48 static void zero_wildcards(struct flow *, const struct flow_wildcards *);
50 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
51 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD) \
52 for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
53 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD) \
54 for ((RULE) = (HEAD); \
55 (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true); \
58 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
59 static struct cls_rule *next_rule_in_list(struct cls_rule *);
61 static struct cls_table *
62 cls_table_from_hmap_node(const struct hmap_node *node)
64 return node ? CONTAINER_OF(node, struct cls_table, hmap_node) : NULL;
67 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
68 * 'wildcards' and 'priority'. */
70 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
71 unsigned int priority, struct cls_rule *rule)
74 rule->wc = *wildcards;
75 rule->priority = priority;
76 cls_rule_zero_wildcarded_fields(rule);
79 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
80 * given 'priority'. (For OpenFlow 1.0, exact-match rule are always highest
81 * priority, so 'priority' should be at least 65535.) */
83 cls_rule_init_exact(const struct flow *flow,
84 unsigned int priority, struct cls_rule *rule)
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 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.wildcards &= ~FWW_NW_TOS;
324 rule->flow.nw_tos = nw_tos & IP_DSCP_MASK;
328 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
330 rule->wc.wildcards &= ~FWW_TP_SRC;
331 rule->flow.icmp_type = htons(icmp_type);
336 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
338 rule->wc.wildcards &= ~FWW_TP_DST;
339 rule->flow.icmp_code = htons(icmp_code);
343 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
345 rule->wc.wildcards &= ~FWW_ARP_SHA;
346 memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
350 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
352 rule->wc.wildcards &= ~FWW_ARP_THA;
353 memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
357 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
359 cls_rule_set_ipv6_src_masked(rule, src, &in6addr_exact);
363 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
364 const struct in6_addr *mask)
366 if (flow_wildcards_set_ipv6_src_mask(&rule->wc, mask)) {
367 rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
375 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
377 cls_rule_set_ipv6_dst_masked(rule, dst, &in6addr_exact);
381 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
382 const struct in6_addr *mask)
384 if (flow_wildcards_set_ipv6_dst_mask(&rule->wc, mask)) {
385 rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
393 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr target)
395 rule->wc.wildcards &= ~FWW_ND_TARGET;
396 rule->flow.nd_target = target;
399 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
400 * fields, and have the same values for fixed fields, otherwise false. */
402 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
404 return (a->priority == b->priority
405 && flow_wildcards_equal(&a->wc, &b->wc)
406 && flow_equal(&a->flow, &b->flow));
409 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
410 * starting from 'basis'. */
412 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
414 uint32_t h0 = flow_hash(&rule->flow, basis);
415 uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
416 return hash_int(rule->priority, h1);
420 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
424 ds_put_format(s, "%s="IP_FMT, name, IP_ARGS(&ip));
425 if (netmask != htonl(UINT32_MAX)) {
426 if (ip_is_cidr(netmask)) {
427 int wcbits = ofputil_netmask_to_wcbits(netmask);
428 ds_put_format(s, "/%d", 32 - wcbits);
430 ds_put_format(s, "/"IP_FMT, IP_ARGS(&netmask));
438 format_ipv6_netmask(struct ds *s, const char *name,
439 const struct in6_addr *addr,
440 const struct in6_addr *netmask)
442 if (!ipv6_mask_is_any(netmask)) {
443 ds_put_format(s, "%s=", name);
444 print_ipv6_addr(s, addr);
445 if (!ipv6_mask_is_exact(netmask)) {
446 if (ipv6_is_cidr(netmask)) {
447 int cidr_bits = ipv6_count_cidr_bits(netmask);
448 ds_put_format(s, "/%d", cidr_bits);
451 print_ipv6_addr(s, netmask);
459 cls_rule_format(const struct cls_rule *rule, struct ds *s)
461 const struct flow_wildcards *wc = &rule->wc;
462 size_t start_len = s->length;
463 flow_wildcards_t w = wc->wildcards;
464 const struct flow *f = &rule->flow;
465 bool skip_type = false;
466 bool skip_proto = false;
470 if (rule->priority != OFP_DEFAULT_PRIORITY) {
471 ds_put_format(s, "priority=%d,", rule->priority);
474 if (!(w & FWW_DL_TYPE)) {
476 if (f->dl_type == htons(ETH_TYPE_IP)) {
477 if (!(w & FWW_NW_PROTO)) {
479 if (f->nw_proto == IPPROTO_ICMP) {
480 ds_put_cstr(s, "icmp,");
481 } else if (f->nw_proto == IPPROTO_TCP) {
482 ds_put_cstr(s, "tcp,");
483 } else if (f->nw_proto == IPPROTO_UDP) {
484 ds_put_cstr(s, "udp,");
486 ds_put_cstr(s, "ip,");
490 ds_put_cstr(s, "ip,");
492 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
493 if (!(w & FWW_NW_PROTO)) {
495 if (f->nw_proto == IPPROTO_ICMPV6) {
496 ds_put_cstr(s, "icmp6,");
497 } else if (f->nw_proto == IPPROTO_TCP) {
498 ds_put_cstr(s, "tcp6,");
499 } else if (f->nw_proto == IPPROTO_UDP) {
500 ds_put_cstr(s, "udp6,");
502 ds_put_cstr(s, "ipv6,");
506 ds_put_cstr(s, "ipv6,");
508 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
509 ds_put_cstr(s, "arp,");
514 for (i = 0; i < FLOW_N_REGS; i++) {
515 switch (wc->reg_masks[i]) {
519 ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
522 ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
523 i, f->regs[i], wc->reg_masks[i]);
527 switch (wc->tun_id_mask) {
530 case CONSTANT_HTONLL(UINT64_MAX):
531 ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
534 ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
535 ntohll(f->tun_id), ntohll(wc->tun_id_mask));
538 if (!(w & FWW_IN_PORT)) {
539 ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
541 if (wc->vlan_tci_mask) {
542 ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
543 ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
544 ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
546 if (cfi && f->vlan_tci & htons(VLAN_CFI)
547 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
548 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
549 && (vid_mask || pcp_mask)) {
551 ds_put_format(s, "dl_vlan=%"PRIu16",",
552 vlan_tci_to_vid(f->vlan_tci));
555 ds_put_format(s, "dl_vlan_pcp=%d,",
556 vlan_tci_to_pcp(f->vlan_tci));
558 } else if (wc->vlan_tci_mask == htons(0xffff)) {
559 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
561 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
562 ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
565 if (!(w & FWW_DL_SRC)) {
566 ds_put_format(s, "dl_src="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_src));
568 switch (w & (FWW_DL_DST | FWW_ETH_MCAST)) {
570 ds_put_format(s, "dl_dst="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_dst));
573 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/01:00:00:00:00:00,",
574 ETH_ADDR_ARGS(f->dl_dst));
577 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/fe:ff:ff:ff:ff:ff,",
578 ETH_ADDR_ARGS(f->dl_dst));
580 case FWW_DL_DST | FWW_ETH_MCAST:
583 if (!skip_type && !(w & FWW_DL_TYPE)) {
584 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
586 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
587 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
588 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
590 format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
591 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
593 if (!skip_proto && !(w & FWW_NW_PROTO)) {
594 if (f->dl_type == htons(ETH_TYPE_ARP)) {
595 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
597 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
600 if (f->dl_type == htons(ETH_TYPE_ARP)) {
601 if (!(w & FWW_ARP_SHA)) {
602 ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
603 ETH_ADDR_ARGS(f->arp_sha));
605 if (!(w & FWW_ARP_THA)) {
606 ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
607 ETH_ADDR_ARGS(f->arp_tha));
610 if (!(w & FWW_NW_TOS)) {
611 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos);
613 if (f->nw_proto == IPPROTO_ICMP) {
614 if (!(w & FWW_TP_SRC)) {
615 ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
617 if (!(w & FWW_TP_DST)) {
618 ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
620 } else if (f->nw_proto == IPPROTO_ICMPV6) {
621 if (!(w & FWW_TP_SRC)) {
622 ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
624 if (!(w & FWW_TP_DST)) {
625 ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
627 if (!(w & FWW_ND_TARGET)) {
628 ds_put_cstr(s, "nd_target=");
629 print_ipv6_addr(s, &f->nd_target);
632 if (!(w & FWW_ARP_SHA)) {
633 ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
634 ETH_ADDR_ARGS(f->arp_sha));
636 if (!(w & FWW_ARP_THA)) {
637 ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
638 ETH_ADDR_ARGS(f->arp_tha));
641 if (!(w & FWW_TP_SRC)) {
642 ds_put_format(s, "tp_src=%"PRIu16",", ntohs(f->tp_src));
644 if (!(w & FWW_TP_DST)) {
645 ds_put_format(s, "tp_dst=%"PRIu16",", ntohs(f->tp_dst));
649 if (s->length > start_len && ds_last(s) == ',') {
654 /* Converts 'rule' to a string and returns the string. The caller must free
655 * the string (with free()). */
657 cls_rule_to_string(const struct cls_rule *rule)
659 struct ds s = DS_EMPTY_INITIALIZER;
660 cls_rule_format(rule, &s);
661 return ds_steal_cstr(&s);
665 cls_rule_print(const struct cls_rule *rule)
667 char *s = cls_rule_to_string(rule);
672 /* Initializes 'cls' as a classifier that initially contains no classification
675 classifier_init(struct classifier *cls)
678 hmap_init(&cls->tables);
681 /* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
682 * caller's responsibility. */
684 classifier_destroy(struct classifier *cls)
687 struct cls_table *table, *next_table;
689 HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
690 hmap_destroy(&table->rules);
691 hmap_remove(&cls->tables, &table->hmap_node);
694 hmap_destroy(&cls->tables);
698 /* Returns true if 'cls' contains no classification rules, false otherwise. */
700 classifier_is_empty(const struct classifier *cls)
702 return cls->n_rules == 0;
705 /* Returns the number of rules in 'classifier'. */
707 classifier_count(const struct classifier *cls)
712 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
713 * must not modify or free it.
715 * If 'cls' already contains an identical rule (including wildcards, values of
716 * fixed fields, and priority), replaces the old rule by 'rule' and returns the
717 * rule that was replaced. The caller takes ownership of the returned rule and
718 * is thus responsible for freeing it, etc., as necessary.
720 * Returns NULL if 'cls' does not contain a rule with an identical key, after
721 * inserting the new rule. In this case, no rules are displaced by the new
722 * rule, even rules that cannot have any effect because the new rule matches a
723 * superset of their flows and has higher priority. */
725 classifier_replace(struct classifier *cls, struct cls_rule *rule)
727 struct cls_rule *old_rule;
728 struct cls_table *table;
730 table = find_table(cls, &rule->wc);
732 table = insert_table(cls, &rule->wc);
735 old_rule = insert_rule(table, rule);
737 table->n_table_rules++;
743 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
744 * must not modify or free it.
746 * 'cls' must not contain an identical rule (including wildcards, values of
747 * fixed fields, and priority). Use classifier_find_rule_exactly() to find
750 classifier_insert(struct classifier *cls, struct cls_rule *rule)
752 struct cls_rule *displaced_rule = classifier_replace(cls, rule);
753 assert(!displaced_rule);
756 /* Removes 'rule' from 'cls'. It is the caller's responsibility to free
757 * 'rule', if this is desirable. */
759 classifier_remove(struct classifier *cls, struct cls_rule *rule)
761 struct cls_rule *head;
762 struct cls_table *table;
764 table = find_table(cls, &rule->wc);
765 head = find_equal(table, &rule->flow, rule->hmap_node.hash);
767 list_remove(&rule->list);
768 } else if (list_is_empty(&rule->list)) {
769 hmap_remove(&table->rules, &rule->hmap_node);
771 struct cls_rule *next = CONTAINER_OF(rule->list.next,
772 struct cls_rule, list);
774 list_remove(&rule->list);
775 hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
778 if (--table->n_table_rules == 0) {
779 destroy_table(cls, table);
785 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
786 * Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
787 * of equal priority match 'flow', returns one arbitrarily. */
789 classifier_lookup(const struct classifier *cls, const struct flow *flow)
791 struct cls_table *table;
792 struct cls_rule *best;
795 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
796 struct cls_rule *rule = find_match(table, flow);
797 if (rule && (!best || rule->priority > best->priority)) {
804 /* Finds and returns a rule in 'cls' with exactly the same priority and
805 * matching criteria as 'target'. Returns a null pointer if 'cls' doesn't
806 * contain an exact match. */
808 classifier_find_rule_exactly(const struct classifier *cls,
809 const struct cls_rule *target)
811 struct cls_rule *head, *rule;
812 struct cls_table *table;
814 table = find_table(cls, &target->wc);
819 head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
820 FOR_EACH_RULE_IN_LIST (rule, head) {
821 if (target->priority >= rule->priority) {
822 return target->priority == rule->priority ? rule : NULL;
828 /* Checks if 'target' would overlap any other rule in 'cls'. Two rules are
829 * considered to overlap if both rules have the same priority and a packet
830 * could match both. */
832 classifier_rule_overlaps(const struct classifier *cls,
833 const struct cls_rule *target)
835 struct cls_table *table;
837 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
838 struct flow_wildcards wc;
839 struct cls_rule *head;
841 flow_wildcards_combine(&wc, &target->wc, &table->wc);
842 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
843 struct cls_rule *rule;
845 FOR_EACH_RULE_IN_LIST (rule, head) {
846 if (rule->priority == target->priority
847 && flow_equal_except(&target->flow, &rule->flow, &wc)) {
860 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
863 || flow_equal_except(&rule->flow, &target->flow, &target->wc));
866 static struct cls_rule *
867 search_table(const struct cls_table *table, const struct cls_rule *target)
869 if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
870 struct cls_rule *rule;
872 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
873 if (rule_matches(rule, target)) {
881 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
882 * 'target' or are more specific than 'target'. That is, a given 'rule'
883 * matches 'target' if, for every field:
885 * - 'target' and 'rule' specify the same (non-wildcarded) value for the
888 * - 'target' wildcards the field,
892 * - 'target' and 'rule' specify different values for the field, or
894 * - 'target' specifies a value for the field but 'rule' wildcards it.
896 * Equivalently, the truth table for whether a field matches is:
901 * +---------+---------+
902 * t wild | yes | yes |
904 * r +---------+---------+
905 * g exact | no |if values|
907 * t +---------+---------+
909 * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
910 * commands and by OpenFlow 1.0 aggregate and flow stats.
912 * Ignores target->priority.
914 * 'target' may be NULL to iterate over every rule in 'cls'. */
916 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
917 const struct cls_rule *target)
920 cursor->target = target;
923 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
924 * pointer if there are no matches. */
926 cls_cursor_first(struct cls_cursor *cursor)
928 struct cls_table *table;
930 for (table = classifier_first_table(cursor->cls); table;
931 table = classifier_next_table(cursor->cls, table)) {
932 struct cls_rule *rule = search_table(table, cursor->target);
934 cursor->table = table;
942 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
943 * pointer if there are no more matches. */
945 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
947 const struct cls_table *table;
948 struct cls_rule *next;
950 next = next_rule_in_list__(rule);
951 if (next->priority < rule->priority) {
955 /* 'next' is the head of the list, that is, the rule that is included in
956 * the table's hmap. (This is important when the classifier contains rules
957 * that differ only in priority.) */
959 HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
960 if (rule_matches(rule, cursor->target)) {
965 for (table = classifier_next_table(cursor->cls, cursor->table); table;
966 table = classifier_next_table(cursor->cls, table)) {
967 rule = search_table(table, cursor->target);
969 cursor->table = table;
977 static struct cls_table *
978 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
980 struct cls_table *table;
982 HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
984 if (flow_wildcards_equal(wc, &table->wc)) {
991 static struct cls_table *
992 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
994 struct cls_table *table;
996 table = xzalloc(sizeof *table);
997 hmap_init(&table->rules);
999 hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1004 static struct cls_table *
1005 classifier_first_table(const struct classifier *cls)
1007 return cls_table_from_hmap_node(hmap_first(&cls->tables));
1010 static struct cls_table *
1011 classifier_next_table(const struct classifier *cls,
1012 const struct cls_table *table)
1014 return cls_table_from_hmap_node(hmap_next(&cls->tables,
1015 &table->hmap_node));
1019 destroy_table(struct classifier *cls, struct cls_table *table)
1021 hmap_remove(&cls->tables, &table->hmap_node);
1022 hmap_destroy(&table->rules);
1026 static struct cls_rule *
1027 find_match(const struct cls_table *table, const struct flow *flow)
1029 struct cls_rule *rule;
1033 zero_wildcards(&f, &table->wc);
1034 HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1036 if (flow_equal(&f, &rule->flow)) {
1043 static struct cls_rule *
1044 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1046 struct cls_rule *head;
1048 HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1049 if (flow_equal(&head->flow, flow)) {
1056 static struct cls_rule *
1057 insert_rule(struct cls_table *table, struct cls_rule *new)
1059 struct cls_rule *head;
1061 new->hmap_node.hash = flow_hash(&new->flow, 0);
1063 head = find_equal(table, &new->flow, new->hmap_node.hash);
1065 hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1066 list_init(&new->list);
1069 /* Scan the list for the insertion point that will keep the list in
1070 * order of decreasing priority. */
1071 struct cls_rule *rule;
1072 FOR_EACH_RULE_IN_LIST (rule, head) {
1073 if (new->priority >= rule->priority) {
1075 /* 'new' is the new highest-priority flow in the list. */
1076 hmap_replace(&table->rules,
1077 &rule->hmap_node, &new->hmap_node);
1080 if (new->priority == rule->priority) {
1081 list_replace(&new->list, &rule->list);
1084 list_insert(&rule->list, &new->list);
1090 /* Insert 'new' at the end of the list. */
1091 list_push_back(&head->list, &new->list);
1096 static struct cls_rule *
1097 next_rule_in_list__(struct cls_rule *rule)
1099 struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1103 static struct cls_rule *
1104 next_rule_in_list(struct cls_rule *rule)
1106 struct cls_rule *next = next_rule_in_list__(rule);
1107 return next->priority < rule->priority ? next : NULL;
1111 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1112 const struct in6_addr *mask)
1117 for (i=0; i<4; i++) {
1118 if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1123 for (i=0; i<16; i++) {
1124 if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1135 flow_equal_except(const struct flow *a, const struct flow *b,
1136 const struct flow_wildcards *wildcards)
1138 const flow_wildcards_t wc = wildcards->wildcards;
1141 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 100 + FLOW_N_REGS * 4);
1143 for (i = 0; i < FLOW_N_REGS; i++) {
1144 if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1149 return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1150 && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1151 && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1152 && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1153 && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1154 && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1155 && (wc & FWW_TP_SRC || a->tp_src == b->tp_src)
1156 && (wc & FWW_TP_DST || a->tp_dst == b->tp_dst)
1157 && (wc & FWW_DL_SRC || eth_addr_equals(a->dl_src, b->dl_src))
1159 || (!((a->dl_dst[0] ^ b->dl_dst[0]) & 0xfe)
1160 && a->dl_dst[1] == b->dl_dst[1]
1161 && a->dl_dst[2] == b->dl_dst[2]
1162 && a->dl_dst[3] == b->dl_dst[3]
1163 && a->dl_dst[4] == b->dl_dst[4]
1164 && a->dl_dst[5] == b->dl_dst[5]))
1165 && (wc & FWW_ETH_MCAST
1166 || !((a->dl_dst[0] ^ b->dl_dst[0]) & 0x01))
1167 && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1168 && (wc & FWW_NW_TOS || a->nw_tos == b->nw_tos)
1169 && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1170 && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1171 && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1172 &wildcards->ipv6_src_mask)
1173 && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1174 &wildcards->ipv6_dst_mask)
1175 && (wc & FWW_ND_TARGET
1176 || ipv6_addr_equals(&a->nd_target, &b->nd_target)));
1180 zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
1182 const flow_wildcards_t wc = wildcards->wildcards;
1185 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 100 + 4 * FLOW_N_REGS);
1187 for (i = 0; i < FLOW_N_REGS; i++) {
1188 flow->regs[i] &= wildcards->reg_masks[i];
1190 flow->tun_id &= wildcards->tun_id_mask;
1191 flow->nw_src &= wildcards->nw_src_mask;
1192 flow->nw_dst &= wildcards->nw_dst_mask;
1193 if (wc & FWW_IN_PORT) {
1196 flow->vlan_tci &= wildcards->vlan_tci_mask;
1197 if (wc & FWW_DL_TYPE) {
1200 if (wc & FWW_TP_SRC) {
1203 if (wc & FWW_TP_DST) {
1206 if (wc & FWW_DL_SRC) {
1207 memset(flow->dl_src, 0, sizeof flow->dl_src);
1209 if (wc & FWW_DL_DST) {
1210 flow->dl_dst[0] &= 0x01;
1211 memset(&flow->dl_dst[1], 0, 5);
1213 if (wc & FWW_ETH_MCAST) {
1214 flow->dl_dst[0] &= 0xfe;
1216 if (wc & FWW_NW_PROTO) {
1219 if (wc & FWW_NW_TOS) {
1222 if (wc & FWW_ARP_SHA) {
1223 memset(flow->arp_sha, 0, sizeof flow->arp_sha);
1225 if (wc & FWW_ARP_THA) {
1226 memset(flow->arp_tha, 0, sizeof flow->arp_tha);
1228 flow->ipv6_src = ipv6_addr_bitand(&flow->ipv6_src,
1229 &wildcards->ipv6_src_mask);
1230 flow->ipv6_dst = ipv6_addr_bitand(&flow->ipv6_dst,
1231 &wildcards->ipv6_dst_mask);
1232 if (wc & FWW_ND_TARGET) {
1233 memset(&flow->nd_target, 0, sizeof flow->nd_target);