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 odp_port)
147 rule->wc.wildcards &= ~FWW_IN_PORT;
148 rule->flow.in_port = odp_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);
166 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
168 rule->wc.wildcards &= ~(FWW_DL_DST | FWW_ETH_MCAST);
169 memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
173 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
175 cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
179 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
181 rule->flow.vlan_tci = tci & mask;
182 rule->wc.vlan_tci_mask = mask;
185 /* Modifies 'rule' so that the VLAN VID is wildcarded. If the PCP is already
186 * wildcarded, then 'rule' will match a packet regardless of whether it has an
187 * 802.1Q header or not. */
189 cls_rule_set_any_vid(struct cls_rule *rule)
191 if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
192 rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
193 rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
195 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
199 /* Modifies 'rule' depending on 'dl_vlan':
201 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
202 * without an 802.1Q header.
204 * - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
205 * VID equals the low 12 bits of 'dl_vlan'.
208 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
210 if (dl_vlan == htons(OFP_VLAN_NONE)) {
211 cls_rule_set_dl_tci(rule, htons(0));
213 dl_vlan &= htons(VLAN_VID_MASK);
214 rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
215 rule->flow.vlan_tci |= htons(VLAN_CFI) | dl_vlan;
216 rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
220 /* Modifies 'rule' so that the VLAN PCP is wildcarded. If the VID is already
221 * wildcarded, then 'rule' will match a packet regardless of whether it has an
222 * 802.1Q header or not. */
224 cls_rule_set_any_pcp(struct cls_rule *rule)
226 if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
227 rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
228 rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
230 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
234 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
235 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
237 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
240 rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
241 rule->flow.vlan_tci |= htons((dl_vlan_pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
242 rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
246 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
248 rule->wc.wildcards &= ~FWW_TP_SRC;
249 rule->flow.tp_src = tp_src;
253 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
255 rule->wc.wildcards &= ~FWW_TP_DST;
256 rule->flow.tp_dst = tp_dst;
260 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
262 rule->wc.wildcards &= ~FWW_NW_PROTO;
263 rule->flow.nw_proto = nw_proto;
267 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
269 cls_rule_set_nw_src_masked(rule, nw_src, htonl(UINT32_MAX));
273 cls_rule_set_nw_src_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
275 if (flow_wildcards_set_nw_src_mask(&rule->wc, mask)) {
276 rule->flow.nw_src = ip & mask;
284 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
286 cls_rule_set_nw_dst_masked(rule, nw_dst, htonl(UINT32_MAX));
290 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
292 if (flow_wildcards_set_nw_dst_mask(&rule->wc, mask)) {
293 rule->flow.nw_dst = ip & mask;
301 cls_rule_set_nw_tos(struct cls_rule *rule, uint8_t nw_tos)
303 rule->wc.wildcards &= ~FWW_NW_TOS;
304 rule->flow.nw_tos = nw_tos & IP_DSCP_MASK;
308 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
310 rule->wc.wildcards &= ~FWW_TP_SRC;
311 rule->flow.icmp_type = htons(icmp_type);
316 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
318 rule->wc.wildcards &= ~FWW_TP_DST;
319 rule->flow.icmp_code = htons(icmp_code);
323 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
325 rule->wc.wildcards &= ~FWW_ARP_SHA;
326 memcpy(rule->flow.arp_sha, sha, ETH_ADDR_LEN);
330 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
332 rule->wc.wildcards &= ~FWW_ARP_THA;
333 memcpy(rule->flow.arp_tha, tha, ETH_ADDR_LEN);
337 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
339 cls_rule_set_ipv6_src_masked(rule, src, &in6addr_exact);
343 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
344 const struct in6_addr *mask)
346 if (flow_wildcards_set_ipv6_src_mask(&rule->wc, mask)) {
347 rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
355 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
357 cls_rule_set_ipv6_dst_masked(rule, dst, &in6addr_exact);
361 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
362 const struct in6_addr *mask)
364 if (flow_wildcards_set_ipv6_dst_mask(&rule->wc, mask)) {
365 rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
373 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr target)
375 rule->wc.wildcards &= ~FWW_ND_TARGET;
376 rule->flow.nd_target = target;
379 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
380 * fields, and have the same values for fixed fields, otherwise false. */
382 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
384 return (a->priority == b->priority
385 && flow_wildcards_equal(&a->wc, &b->wc)
386 && flow_equal(&a->flow, &b->flow));
390 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
394 ds_put_format(s, "%s="IP_FMT, name, IP_ARGS(&ip));
395 if (netmask != htonl(UINT32_MAX)) {
396 if (ip_is_cidr(netmask)) {
397 int wcbits = ofputil_netmask_to_wcbits(netmask);
398 ds_put_format(s, "/%d", 32 - wcbits);
400 ds_put_format(s, "/"IP_FMT, IP_ARGS(&netmask));
408 format_ipv6_netmask(struct ds *s, const char *name,
409 const struct in6_addr *addr,
410 const struct in6_addr *netmask)
412 if (!ipv6_mask_is_any(netmask)) {
413 ds_put_format(s, "%s=", name);
414 print_ipv6_addr(s, addr);
415 if (!ipv6_mask_is_exact(netmask)) {
416 if (ipv6_is_cidr(netmask)) {
417 int cidr_bits = ipv6_count_cidr_bits(netmask);
418 ds_put_format(s, "/%d", cidr_bits);
421 print_ipv6_addr(s, netmask);
429 cls_rule_format(const struct cls_rule *rule, struct ds *s)
431 const struct flow_wildcards *wc = &rule->wc;
432 size_t start_len = s->length;
433 flow_wildcards_t w = wc->wildcards;
434 const struct flow *f = &rule->flow;
435 bool skip_type = false;
436 bool skip_proto = false;
440 if (rule->priority != OFP_DEFAULT_PRIORITY) {
441 ds_put_format(s, "priority=%d,", rule->priority);
444 if (!(w & FWW_DL_TYPE)) {
446 if (f->dl_type == htons(ETH_TYPE_IP)) {
447 if (!(w & FWW_NW_PROTO)) {
449 if (f->nw_proto == IPPROTO_ICMP) {
450 ds_put_cstr(s, "icmp,");
451 } else if (f->nw_proto == IPPROTO_TCP) {
452 ds_put_cstr(s, "tcp,");
453 } else if (f->nw_proto == IPPROTO_UDP) {
454 ds_put_cstr(s, "udp,");
456 ds_put_cstr(s, "ip,");
460 ds_put_cstr(s, "ip,");
462 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
463 if (!(w & FWW_NW_PROTO)) {
465 if (f->nw_proto == IPPROTO_ICMPV6) {
466 ds_put_cstr(s, "icmp6,");
467 } else if (f->nw_proto == IPPROTO_TCP) {
468 ds_put_cstr(s, "tcp6,");
469 } else if (f->nw_proto == IPPROTO_UDP) {
470 ds_put_cstr(s, "udp6,");
472 ds_put_cstr(s, "ipv6,");
476 ds_put_cstr(s, "ipv6,");
478 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
479 ds_put_cstr(s, "arp,");
484 for (i = 0; i < FLOW_N_REGS; i++) {
485 switch (wc->reg_masks[i]) {
489 ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
492 ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
493 i, f->regs[i], wc->reg_masks[i]);
497 switch (wc->tun_id_mask) {
500 case CONSTANT_HTONLL(UINT64_MAX):
501 ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
504 ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
505 ntohll(f->tun_id), ntohll(wc->tun_id_mask));
508 if (!(w & FWW_IN_PORT)) {
509 ds_put_format(s, "in_port=%"PRIu16",",
510 odp_port_to_ofp_port(f->in_port));
512 if (wc->vlan_tci_mask) {
513 ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
514 ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
515 ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
517 if (cfi && f->vlan_tci & htons(VLAN_CFI)
518 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
519 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
520 && (vid_mask || pcp_mask)) {
522 ds_put_format(s, "dl_vlan=%"PRIu16",",
523 vlan_tci_to_vid(f->vlan_tci));
526 ds_put_format(s, "dl_vlan_pcp=%d,",
527 vlan_tci_to_pcp(f->vlan_tci));
529 } else if (wc->vlan_tci_mask == htons(0xffff)) {
530 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
532 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
533 ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
536 if (!(w & FWW_DL_SRC)) {
537 ds_put_format(s, "dl_src="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_src));
539 switch (w & (FWW_DL_DST | FWW_ETH_MCAST)) {
541 ds_put_format(s, "dl_dst="ETH_ADDR_FMT",", ETH_ADDR_ARGS(f->dl_dst));
544 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/01:00:00:00:00:00,",
545 ETH_ADDR_ARGS(f->dl_dst));
548 ds_put_format(s, "dl_dst="ETH_ADDR_FMT"/fe:ff:ff:ff:ff:ff,",
549 ETH_ADDR_ARGS(f->dl_dst));
551 case FWW_DL_DST | FWW_ETH_MCAST:
554 if (!skip_type && !(w & FWW_DL_TYPE)) {
555 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
557 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
558 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
559 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
561 format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
562 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
564 if (!skip_proto && !(w & FWW_NW_PROTO)) {
565 if (f->dl_type == htons(ETH_TYPE_ARP)) {
566 ds_put_format(s, "opcode=%"PRIu8",", f->nw_proto);
568 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
571 if (f->dl_type == htons(ETH_TYPE_ARP)) {
572 if (!(w & FWW_ARP_SHA)) {
573 ds_put_format(s, "arp_sha="ETH_ADDR_FMT",",
574 ETH_ADDR_ARGS(f->arp_sha));
576 if (!(w & FWW_ARP_THA)) {
577 ds_put_format(s, "arp_tha="ETH_ADDR_FMT",",
578 ETH_ADDR_ARGS(f->arp_tha));
581 if (!(w & FWW_NW_TOS)) {
582 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos);
584 if (f->nw_proto == IPPROTO_ICMP) {
585 if (!(w & FWW_TP_SRC)) {
586 ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
588 if (!(w & FWW_TP_DST)) {
589 ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
591 } else if (f->nw_proto == IPPROTO_ICMPV6) {
592 if (!(w & FWW_TP_SRC)) {
593 ds_put_format(s, "icmp_type=%"PRIu16",", ntohs(f->tp_src));
595 if (!(w & FWW_TP_DST)) {
596 ds_put_format(s, "icmp_code=%"PRIu16",", ntohs(f->tp_dst));
598 if (!(w & FWW_ND_TARGET)) {
599 ds_put_cstr(s, "nd_target=");
600 print_ipv6_addr(s, &f->nd_target);
603 if (!(w & FWW_ARP_SHA)) {
604 ds_put_format(s, "nd_sll="ETH_ADDR_FMT",",
605 ETH_ADDR_ARGS(f->arp_sha));
607 if (!(w & FWW_ARP_THA)) {
608 ds_put_format(s, "nd_tll="ETH_ADDR_FMT",",
609 ETH_ADDR_ARGS(f->arp_tha));
612 if (!(w & FWW_TP_SRC)) {
613 ds_put_format(s, "tp_src=%"PRIu16",", ntohs(f->tp_src));
615 if (!(w & FWW_TP_DST)) {
616 ds_put_format(s, "tp_dst=%"PRIu16",", ntohs(f->tp_dst));
620 if (s->length > start_len && ds_last(s) == ',') {
625 /* Converts 'rule' to a string and returns the string. The caller must free
626 * the string (with free()). */
628 cls_rule_to_string(const struct cls_rule *rule)
630 struct ds s = DS_EMPTY_INITIALIZER;
631 cls_rule_format(rule, &s);
632 return ds_steal_cstr(&s);
636 cls_rule_print(const struct cls_rule *rule)
638 char *s = cls_rule_to_string(rule);
643 /* Initializes 'cls' as a classifier that initially contains no classification
646 classifier_init(struct classifier *cls)
649 hmap_init(&cls->tables);
652 /* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
653 * caller's responsibility. */
655 classifier_destroy(struct classifier *cls)
658 struct cls_table *table, *next_table;
660 HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
661 hmap_destroy(&table->rules);
662 hmap_remove(&cls->tables, &table->hmap_node);
665 hmap_destroy(&cls->tables);
669 /* Returns true if 'cls' contains no classification rules, false otherwise. */
671 classifier_is_empty(const struct classifier *cls)
673 return cls->n_rules == 0;
676 /* Returns the number of rules in 'classifier'. */
678 classifier_count(const struct classifier *cls)
683 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
684 * must not modify or free it.
686 * If 'cls' already contains an identical rule (including wildcards, values of
687 * fixed fields, and priority), replaces the old rule by 'rule' and returns the
688 * rule that was replaced. The caller takes ownership of the returned rule and
689 * is thus responsible for freeing it, etc., as necessary.
691 * Returns NULL if 'cls' does not contain a rule with an identical key, after
692 * inserting the new rule. In this case, no rules are displaced by the new
693 * rule, even rules that cannot have any effect because the new rule matches a
694 * superset of their flows and has higher priority. */
696 classifier_insert(struct classifier *cls, struct cls_rule *rule)
698 struct cls_rule *old_rule;
699 struct cls_table *table;
701 table = find_table(cls, &rule->wc);
703 table = insert_table(cls, &rule->wc);
706 old_rule = insert_rule(table, rule);
708 table->n_table_rules++;
714 /* Removes 'rule' from 'cls'. It is the caller's responsibility to free
715 * 'rule', if this is desirable. */
717 classifier_remove(struct classifier *cls, struct cls_rule *rule)
719 struct cls_rule *head;
720 struct cls_table *table;
722 table = find_table(cls, &rule->wc);
723 head = find_equal(table, &rule->flow, rule->hmap_node.hash);
725 list_remove(&rule->list);
726 } else if (list_is_empty(&rule->list)) {
727 hmap_remove(&table->rules, &rule->hmap_node);
729 struct cls_rule *next = CONTAINER_OF(rule->list.next,
730 struct cls_rule, list);
732 list_remove(&rule->list);
733 hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
736 if (--table->n_table_rules == 0) {
737 destroy_table(cls, table);
743 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
744 * Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
745 * of equal priority match 'flow', returns one arbitrarily. */
747 classifier_lookup(const struct classifier *cls, const struct flow *flow)
749 struct cls_table *table;
750 struct cls_rule *best;
753 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
754 struct cls_rule *rule = find_match(table, flow);
755 if (rule && (!best || rule->priority > best->priority)) {
762 /* Finds and returns a rule in 'cls' with exactly the same priority and
763 * matching criteria as 'target'. Returns a null pointer if 'cls' doesn't
764 * contain an exact match.
766 * Priority is ignored for exact-match rules (because OpenFlow 1.0 always
767 * treats exact-match rules as highest priority). */
769 classifier_find_rule_exactly(const struct classifier *cls,
770 const struct cls_rule *target)
772 struct cls_rule *head, *rule;
773 struct cls_table *table;
775 table = find_table(cls, &target->wc);
780 head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
781 if (flow_wildcards_is_exact(&target->wc)) {
784 FOR_EACH_RULE_IN_LIST (rule, head) {
785 if (target->priority >= rule->priority) {
786 return target->priority == rule->priority ? rule : NULL;
792 /* Checks if 'target' would overlap any other rule in 'cls'. Two rules are
793 * considered to overlap if both rules have the same priority and a packet
794 * could match both. */
796 classifier_rule_overlaps(const struct classifier *cls,
797 const struct cls_rule *target)
799 struct cls_table *table;
801 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
802 struct flow_wildcards wc;
803 struct cls_rule *head;
805 flow_wildcards_combine(&wc, &target->wc, &table->wc);
806 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
807 struct cls_rule *rule;
809 FOR_EACH_RULE_IN_LIST (rule, head) {
810 if (rule->priority == target->priority
811 && flow_equal_except(&target->flow, &rule->flow, &wc)) {
824 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
827 || flow_equal_except(&rule->flow, &target->flow, &target->wc));
830 static struct cls_rule *
831 search_table(const struct cls_table *table, const struct cls_rule *target)
833 if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
834 struct cls_rule *rule;
836 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
837 if (rule_matches(rule, target)) {
845 /* Initializes 'cursor' for iterating through 'cls' rules that exactly match
846 * 'target' or are more specific than 'target'. That is, a given 'rule'
847 * matches 'target' if, for every field:
849 * - 'target' and 'rule' specify the same (non-wildcarded) value for the
852 * - 'target' wildcards the field,
856 * - 'target' and 'rule' specify different values for the field, or
858 * - 'target' specifies a value for the field but 'rule' wildcards it.
860 * Equivalently, the truth table for whether a field matches is:
865 * +---------+---------+
866 * t wild | yes | yes |
868 * r +---------+---------+
869 * g exact | no |if values|
871 * t +---------+---------+
873 * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
874 * commands and by OpenFlow 1.0 aggregate and flow stats.
876 * Ignores target->priority.
878 * 'target' may be NULL to iterate over every rule in 'cls'. */
880 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
881 const struct cls_rule *target)
884 cursor->target = target;
887 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
888 * pointer if there are no matches. */
890 cls_cursor_first(struct cls_cursor *cursor)
892 struct cls_table *table;
894 for (table = classifier_first_table(cursor->cls); table;
895 table = classifier_next_table(cursor->cls, table)) {
896 struct cls_rule *rule = search_table(table, cursor->target);
898 cursor->table = table;
906 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
907 * pointer if there are no more matches. */
909 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
911 const struct cls_table *table;
912 struct cls_rule *next;
914 next = next_rule_in_list__(rule);
915 if (next->priority < rule->priority) {
919 /* 'next' is the head of the list, that is, the rule that is included in
920 * the table's hmap. (This is important when the classifier contains rules
921 * that differ only in priority.) */
923 HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
924 if (rule_matches(rule, cursor->target)) {
929 for (table = classifier_next_table(cursor->cls, cursor->table); table;
930 table = classifier_next_table(cursor->cls, table)) {
931 rule = search_table(table, cursor->target);
933 cursor->table = table;
941 static struct cls_table *
942 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
944 struct cls_table *table;
946 HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc),
948 if (flow_wildcards_equal(wc, &table->wc)) {
955 static struct cls_table *
956 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
958 struct cls_table *table;
960 table = xzalloc(sizeof *table);
961 hmap_init(&table->rules);
963 hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc));
968 static struct cls_table *
969 classifier_first_table(const struct classifier *cls)
971 return cls_table_from_hmap_node(hmap_first(&cls->tables));
974 static struct cls_table *
975 classifier_next_table(const struct classifier *cls,
976 const struct cls_table *table)
978 return cls_table_from_hmap_node(hmap_next(&cls->tables,
983 destroy_table(struct classifier *cls, struct cls_table *table)
985 hmap_remove(&cls->tables, &table->hmap_node);
986 hmap_destroy(&table->rules);
990 static struct cls_rule *
991 find_match(const struct cls_table *table, const struct flow *flow)
993 struct cls_rule *rule;
997 zero_wildcards(&f, &table->wc);
998 HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1000 if (flow_equal(&f, &rule->flow)) {
1007 static struct cls_rule *
1008 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1010 struct cls_rule *head;
1012 HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1013 if (flow_equal(&head->flow, flow)) {
1020 static struct cls_rule *
1021 insert_rule(struct cls_table *table, struct cls_rule *new)
1023 struct cls_rule *head;
1025 new->hmap_node.hash = flow_hash(&new->flow, 0);
1027 head = find_equal(table, &new->flow, new->hmap_node.hash);
1029 hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1030 list_init(&new->list);
1033 /* Scan the list for the insertion point that will keep the list in
1034 * order of decreasing priority. */
1035 struct cls_rule *rule;
1036 FOR_EACH_RULE_IN_LIST (rule, head) {
1037 if (new->priority >= rule->priority) {
1039 /* 'new' is the new highest-priority flow in the list. */
1040 hmap_replace(&table->rules,
1041 &rule->hmap_node, &new->hmap_node);
1044 if (new->priority == rule->priority) {
1045 list_replace(&new->list, &rule->list);
1048 list_insert(&rule->list, &new->list);
1054 /* Insert 'new' at the end of the list. */
1055 list_push_back(&head->list, &new->list);
1060 static struct cls_rule *
1061 next_rule_in_list__(struct cls_rule *rule)
1063 struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1067 static struct cls_rule *
1068 next_rule_in_list(struct cls_rule *rule)
1070 struct cls_rule *next = next_rule_in_list__(rule);
1071 return next->priority < rule->priority ? next : NULL;
1075 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1076 const struct in6_addr *mask)
1081 for (i=0; i<4; i++) {
1082 if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1087 for (i=0; i<16; i++) {
1088 if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1099 flow_equal_except(const struct flow *a, const struct flow *b,
1100 const struct flow_wildcards *wildcards)
1102 const flow_wildcards_t wc = wildcards->wildcards;
1105 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 100 + FLOW_N_REGS * 4);
1107 for (i = 0; i < FLOW_N_REGS; i++) {
1108 if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1113 return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1114 && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1115 && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1116 && (wc & FWW_IN_PORT || a->in_port == b->in_port)
1117 && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1118 && (wc & FWW_DL_TYPE || a->dl_type == b->dl_type)
1119 && (wc & FWW_TP_SRC || a->tp_src == b->tp_src)
1120 && (wc & FWW_TP_DST || a->tp_dst == b->tp_dst)
1121 && (wc & FWW_DL_SRC || eth_addr_equals(a->dl_src, b->dl_src))
1123 || (!((a->dl_dst[0] ^ b->dl_dst[0]) & 0xfe)
1124 && a->dl_dst[1] == b->dl_dst[1]
1125 && a->dl_dst[2] == b->dl_dst[2]
1126 && a->dl_dst[3] == b->dl_dst[3]
1127 && a->dl_dst[4] == b->dl_dst[4]
1128 && a->dl_dst[5] == b->dl_dst[5]))
1129 && (wc & FWW_ETH_MCAST
1130 || !((a->dl_dst[0] ^ b->dl_dst[0]) & 0x01))
1131 && (wc & FWW_NW_PROTO || a->nw_proto == b->nw_proto)
1132 && (wc & FWW_NW_TOS || a->nw_tos == b->nw_tos)
1133 && (wc & FWW_ARP_SHA || eth_addr_equals(a->arp_sha, b->arp_sha))
1134 && (wc & FWW_ARP_THA || eth_addr_equals(a->arp_tha, b->arp_tha))
1135 && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1136 &wildcards->ipv6_src_mask)
1137 && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1138 &wildcards->ipv6_dst_mask)
1139 && (wc & FWW_ND_TARGET
1140 || ipv6_addr_equals(&a->nd_target, &b->nd_target)));
1144 zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
1146 const flow_wildcards_t wc = wildcards->wildcards;
1149 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 100 + 4 * FLOW_N_REGS);
1151 for (i = 0; i < FLOW_N_REGS; i++) {
1152 flow->regs[i] &= wildcards->reg_masks[i];
1154 flow->tun_id &= wildcards->tun_id_mask;
1155 flow->nw_src &= wildcards->nw_src_mask;
1156 flow->nw_dst &= wildcards->nw_dst_mask;
1157 if (wc & FWW_IN_PORT) {
1160 flow->vlan_tci &= wildcards->vlan_tci_mask;
1161 if (wc & FWW_DL_TYPE) {
1164 if (wc & FWW_TP_SRC) {
1167 if (wc & FWW_TP_DST) {
1170 if (wc & FWW_DL_SRC) {
1171 memset(flow->dl_src, 0, sizeof flow->dl_src);
1173 if (wc & FWW_DL_DST) {
1174 flow->dl_dst[0] &= 0x01;
1175 memset(&flow->dl_dst[1], 0, 5);
1177 if (wc & FWW_ETH_MCAST) {
1178 flow->dl_dst[0] &= 0xfe;
1180 if (wc & FWW_NW_PROTO) {
1183 if (wc & FWW_NW_TOS) {
1186 if (wc & FWW_ARP_SHA) {
1187 memset(flow->arp_sha, 0, sizeof flow->arp_sha);
1189 if (wc & FWW_ARP_THA) {
1190 memset(flow->arp_tha, 0, sizeof flow->arp_tha);
1192 flow->ipv6_src = ipv6_addr_bitand(&flow->ipv6_src,
1193 &wildcards->ipv6_src_mask);
1194 flow->ipv6_dst = ipv6_addr_bitand(&flow->ipv6_dst,
1195 &wildcards->ipv6_dst_mask);
1196 if (wc & FWW_ND_TARGET) {
1197 memset(&flow->nd_target, 0, sizeof flow->nd_target);