2 * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "classifier.h"
21 #include <netinet/in.h>
22 #include "byte-order.h"
23 #include "dynamic-string.h"
30 static struct cls_table *find_table(const struct classifier *,
31 const struct flow_wildcards *);
32 static struct cls_table *insert_table(struct classifier *,
33 const struct flow_wildcards *);
35 static void destroy_table(struct classifier *, struct cls_table *);
37 static struct cls_rule *find_match(const struct cls_table *,
39 static struct cls_rule *find_equal(struct cls_table *, const struct flow *,
41 static struct cls_rule *insert_rule(struct cls_table *, struct cls_rule *);
43 static bool flow_equal_except(const struct flow *, const struct flow *,
44 const struct flow_wildcards *);
46 /* Iterates RULE over HEAD and all of the cls_rules on HEAD->list. */
47 #define FOR_EACH_RULE_IN_LIST(RULE, HEAD) \
48 for ((RULE) = (HEAD); (RULE) != NULL; (RULE) = next_rule_in_list(RULE))
49 #define FOR_EACH_RULE_IN_LIST_SAFE(RULE, NEXT, HEAD) \
50 for ((RULE) = (HEAD); \
51 (RULE) != NULL && ((NEXT) = next_rule_in_list(RULE), true); \
54 static struct cls_rule *next_rule_in_list__(struct cls_rule *);
55 static struct cls_rule *next_rule_in_list(struct cls_rule *);
57 /* Converts the flow in 'flow' into a cls_rule in 'rule', with the given
58 * 'wildcards' and 'priority'. */
60 cls_rule_init(const struct flow *flow, const struct flow_wildcards *wildcards,
61 unsigned int priority, struct cls_rule *rule)
64 rule->wc = *wildcards;
65 rule->priority = priority;
66 cls_rule_zero_wildcarded_fields(rule);
69 /* Converts the flow in 'flow' into an exact-match cls_rule in 'rule', with the
70 * given 'priority'. (For OpenFlow 1.0, exact-match rule are always highest
71 * priority, so 'priority' should be at least 65535.) */
73 cls_rule_init_exact(const struct flow *flow,
74 unsigned int priority, struct cls_rule *rule)
77 rule->flow.skb_priority = 0;
78 flow_wildcards_init_exact(&rule->wc);
79 rule->priority = priority;
82 /* Initializes 'rule' as a "catch-all" rule that matches every packet, with
83 * priority 'priority'. */
85 cls_rule_init_catchall(struct cls_rule *rule, unsigned int priority)
87 memset(&rule->flow, 0, sizeof rule->flow);
88 flow_wildcards_init_catchall(&rule->wc);
89 rule->priority = priority;
92 /* For each bit or field wildcarded in 'rule', sets the corresponding bit or
93 * field in 'flow' to all-0-bits. It is important to maintain this invariant
94 * in a clr_rule that might be inserted into a classifier.
96 * It is never necessary to call this function directly for a cls_rule that is
97 * initialized or modified only by cls_rule_*() functions. It is useful to
98 * restore the invariant in a cls_rule whose 'wc' member is modified by hand.
101 cls_rule_zero_wildcarded_fields(struct cls_rule *rule)
103 flow_zero_wildcards(&rule->flow, &rule->wc);
107 cls_rule_set_reg(struct cls_rule *rule, unsigned int reg_idx, uint32_t value)
109 cls_rule_set_reg_masked(rule, reg_idx, value, UINT32_MAX);
113 cls_rule_set_reg_masked(struct cls_rule *rule, unsigned int reg_idx,
114 uint32_t value, uint32_t mask)
116 assert(reg_idx < FLOW_N_REGS);
117 flow_wildcards_set_reg_mask(&rule->wc, reg_idx, mask);
118 rule->flow.regs[reg_idx] = value & mask;
122 cls_rule_set_metadata(struct cls_rule *rule, ovs_be64 metadata)
124 cls_rule_set_metadata_masked(rule, metadata, htonll(UINT64_MAX));
128 cls_rule_set_metadata_masked(struct cls_rule *rule, ovs_be64 metadata,
131 rule->wc.metadata_mask = mask;
132 rule->flow.metadata = metadata & mask;
136 cls_rule_set_tun_id(struct cls_rule *rule, ovs_be64 tun_id)
138 cls_rule_set_tun_id_masked(rule, tun_id, htonll(UINT64_MAX));
142 cls_rule_set_tun_id_masked(struct cls_rule *rule,
143 ovs_be64 tun_id, ovs_be64 mask)
145 rule->wc.tun_id_mask = mask;
146 rule->flow.tun_id = tun_id & mask;
150 cls_rule_set_in_port(struct cls_rule *rule, uint16_t ofp_port)
152 rule->wc.in_port_mask = UINT16_MAX;
153 rule->flow.in_port = ofp_port;
157 cls_rule_set_dl_type(struct cls_rule *rule, ovs_be16 dl_type)
159 rule->wc.dl_type_mask = htons(UINT16_MAX);
160 rule->flow.dl_type = dl_type;
163 /* Modifies 'value_src' so that the Ethernet address must match
164 * 'value_dst' exactly. 'mask_dst' is set to all 1s */
166 cls_rule_set_eth(const uint8_t value_src[ETH_ADDR_LEN],
167 uint8_t value_dst[ETH_ADDR_LEN],
168 uint8_t mask_dst[ETH_ADDR_LEN])
170 memcpy(value_dst, value_src, ETH_ADDR_LEN);
171 memset(mask_dst, 0xff, ETH_ADDR_LEN);
174 /* Modifies 'value_src' so that the Ethernet address must match
175 * 'value_src' after each byte is ANDed with the appropriate byte in
176 * 'mask_src'. 'mask_dst' is set to 'mask_src' */
178 cls_rule_set_eth_masked(const uint8_t value_src[ETH_ADDR_LEN],
179 const uint8_t mask_src[ETH_ADDR_LEN],
180 uint8_t value_dst[ETH_ADDR_LEN],
181 uint8_t mask_dst[ETH_ADDR_LEN])
185 for (i = 0; i < ETH_ADDR_LEN; i++) {
186 value_dst[i] = value_src[i] & mask_src[i];
187 mask_dst[i] = mask_src[i];
191 /* Modifies 'rule' so that the source Ethernet address
192 * must match 'dl_src' exactly. */
194 cls_rule_set_dl_src(struct cls_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
196 cls_rule_set_eth(dl_src, rule->flow.dl_src, rule->wc.dl_src_mask);
199 /* Modifies 'rule' so that the source Ethernet address
200 * must match 'dl_src' after each byte is ANDed with
201 * the appropriate byte in 'mask'. */
203 cls_rule_set_dl_src_masked(struct cls_rule *rule,
204 const uint8_t dl_src[ETH_ADDR_LEN],
205 const uint8_t mask[ETH_ADDR_LEN])
207 cls_rule_set_eth_masked(dl_src, mask,
208 rule->flow.dl_src, rule->wc.dl_src_mask);
211 /* Modifies 'rule' so that the destination Ethernet address
212 * must match 'dl_dst' exactly. */
214 cls_rule_set_dl_dst(struct cls_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
216 cls_rule_set_eth(dl_dst, rule->flow.dl_dst, rule->wc.dl_dst_mask);
219 /* Modifies 'rule' so that the destination Ethernet address
220 * must match 'dl_src' after each byte is ANDed with
221 * the appropriate byte in 'mask'. */
223 cls_rule_set_dl_dst_masked(struct cls_rule *rule,
224 const uint8_t dl_dst[ETH_ADDR_LEN],
225 const uint8_t mask[ETH_ADDR_LEN])
227 cls_rule_set_eth_masked(dl_dst, mask,
228 rule->flow.dl_dst, rule->wc.dl_dst_mask);
232 cls_rule_set_dl_tci(struct cls_rule *rule, ovs_be16 tci)
234 cls_rule_set_dl_tci_masked(rule, tci, htons(0xffff));
238 cls_rule_set_dl_tci_masked(struct cls_rule *rule, ovs_be16 tci, ovs_be16 mask)
240 rule->flow.vlan_tci = tci & mask;
241 rule->wc.vlan_tci_mask = mask;
244 /* Modifies 'rule' so that the VLAN VID is wildcarded. If the PCP is already
245 * wildcarded, then 'rule' will match a packet regardless of whether it has an
246 * 802.1Q header or not. */
248 cls_rule_set_any_vid(struct cls_rule *rule)
250 if (rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK)) {
251 rule->wc.vlan_tci_mask &= ~htons(VLAN_VID_MASK);
252 rule->flow.vlan_tci &= ~htons(VLAN_VID_MASK);
254 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
258 /* Modifies 'rule' depending on 'dl_vlan':
260 * - If 'dl_vlan' is htons(OFP_VLAN_NONE), makes 'rule' match only packets
261 * without an 802.1Q header.
263 * - Otherwise, makes 'rule' match only packets with an 802.1Q header whose
264 * VID equals the low 12 bits of 'dl_vlan'.
267 cls_rule_set_dl_vlan(struct cls_rule *rule, ovs_be16 dl_vlan)
269 flow_set_dl_vlan(&rule->flow, dl_vlan);
270 if (dl_vlan == htons(OFP10_VLAN_NONE)) {
271 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
273 rule->wc.vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
277 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
278 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
281 cls_rule_set_vlan_vid(struct cls_rule *rule, ovs_be16 vid)
283 cls_rule_set_vlan_vid_masked(rule, vid, htons(VLAN_VID_MASK | VLAN_CFI));
287 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
288 * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
289 * plus CFI), with the corresponding 'mask'. */
291 cls_rule_set_vlan_vid_masked(struct cls_rule *rule,
292 ovs_be16 vid, ovs_be16 mask)
294 ovs_be16 pcp_mask = htons(VLAN_PCP_MASK);
295 ovs_be16 vid_mask = htons(VLAN_VID_MASK | VLAN_CFI);
298 flow_set_vlan_vid(&rule->flow, vid & mask);
299 rule->wc.vlan_tci_mask = mask | (rule->wc.vlan_tci_mask & pcp_mask);
302 /* Modifies 'rule' so that the VLAN PCP is wildcarded. If the VID is already
303 * wildcarded, then 'rule' will match a packet regardless of whether it has an
304 * 802.1Q header or not. */
306 cls_rule_set_any_pcp(struct cls_rule *rule)
308 if (rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK)) {
309 rule->wc.vlan_tci_mask &= ~htons(VLAN_PCP_MASK);
310 rule->flow.vlan_tci &= ~htons(VLAN_PCP_MASK);
312 cls_rule_set_dl_tci_masked(rule, htons(0), htons(0));
316 /* Modifies 'rule' so that it matches only packets with an 802.1Q header whose
317 * PCP equals the low 3 bits of 'dl_vlan_pcp'. */
319 cls_rule_set_dl_vlan_pcp(struct cls_rule *rule, uint8_t dl_vlan_pcp)
321 flow_set_vlan_pcp(&rule->flow, dl_vlan_pcp);
322 rule->wc.vlan_tci_mask |= htons(VLAN_CFI | VLAN_PCP_MASK);
326 cls_rule_set_tp_src(struct cls_rule *rule, ovs_be16 tp_src)
328 cls_rule_set_tp_src_masked(rule, tp_src, htons(UINT16_MAX));
332 cls_rule_set_tp_src_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
334 rule->flow.tp_src = port & mask;
335 rule->wc.tp_src_mask = mask;
339 cls_rule_set_tp_dst(struct cls_rule *rule, ovs_be16 tp_dst)
341 cls_rule_set_tp_dst_masked(rule, tp_dst, htons(UINT16_MAX));
345 cls_rule_set_tp_dst_masked(struct cls_rule *rule, ovs_be16 port, ovs_be16 mask)
347 rule->flow.tp_dst = port & mask;
348 rule->wc.tp_dst_mask = mask;
352 cls_rule_set_nw_proto(struct cls_rule *rule, uint8_t nw_proto)
354 rule->flow.nw_proto = nw_proto;
355 rule->wc.nw_proto_mask = UINT8_MAX;
359 cls_rule_set_nw_src(struct cls_rule *rule, ovs_be32 nw_src)
361 rule->flow.nw_src = nw_src;
362 rule->wc.nw_src_mask = htonl(UINT32_MAX);
366 cls_rule_set_nw_src_masked(struct cls_rule *rule,
367 ovs_be32 nw_src, ovs_be32 mask)
369 rule->flow.nw_src = nw_src & mask;
370 rule->wc.nw_src_mask = mask;
374 cls_rule_set_nw_dst(struct cls_rule *rule, ovs_be32 nw_dst)
376 rule->flow.nw_dst = nw_dst;
377 rule->wc.nw_dst_mask = htonl(UINT32_MAX);
381 cls_rule_set_nw_dst_masked(struct cls_rule *rule, ovs_be32 ip, ovs_be32 mask)
383 rule->flow.nw_dst = ip & mask;
384 rule->wc.nw_dst_mask = mask;
388 cls_rule_set_nw_dscp(struct cls_rule *rule, uint8_t nw_dscp)
390 rule->wc.nw_tos_mask |= IP_DSCP_MASK;
391 rule->flow.nw_tos &= ~IP_DSCP_MASK;
392 rule->flow.nw_tos |= nw_dscp & IP_DSCP_MASK;
396 cls_rule_set_nw_ecn(struct cls_rule *rule, uint8_t nw_ecn)
398 rule->wc.nw_tos_mask |= IP_ECN_MASK;
399 rule->flow.nw_tos &= ~IP_ECN_MASK;
400 rule->flow.nw_tos |= nw_ecn & IP_ECN_MASK;
404 cls_rule_set_nw_ttl(struct cls_rule *rule, uint8_t nw_ttl)
406 rule->wc.nw_ttl_mask = UINT8_MAX;
407 rule->flow.nw_ttl = nw_ttl;
411 cls_rule_set_nw_frag(struct cls_rule *rule, uint8_t nw_frag)
413 rule->wc.nw_frag_mask |= FLOW_NW_FRAG_MASK;
414 rule->flow.nw_frag = nw_frag;
418 cls_rule_set_nw_frag_masked(struct cls_rule *rule,
419 uint8_t nw_frag, uint8_t mask)
421 rule->flow.nw_frag = nw_frag & mask;
422 rule->wc.nw_frag_mask = mask;
426 cls_rule_set_icmp_type(struct cls_rule *rule, uint8_t icmp_type)
428 cls_rule_set_tp_src(rule, htons(icmp_type));
432 cls_rule_set_icmp_code(struct cls_rule *rule, uint8_t icmp_code)
434 cls_rule_set_tp_dst(rule, htons(icmp_code));
438 cls_rule_set_arp_sha(struct cls_rule *rule, const uint8_t sha[ETH_ADDR_LEN])
440 cls_rule_set_eth(sha, rule->flow.arp_sha, rule->wc.arp_sha_mask);
444 cls_rule_set_arp_sha_masked(struct cls_rule *rule,
445 const uint8_t arp_sha[ETH_ADDR_LEN],
446 const uint8_t mask[ETH_ADDR_LEN])
448 cls_rule_set_eth_masked(arp_sha, mask,
449 rule->flow.arp_sha, rule->wc.arp_sha_mask);
453 cls_rule_set_arp_tha(struct cls_rule *rule, const uint8_t tha[ETH_ADDR_LEN])
455 cls_rule_set_eth(tha, rule->flow.arp_tha, rule->wc.arp_tha_mask);
459 cls_rule_set_arp_tha_masked(struct cls_rule *rule,
460 const uint8_t arp_tha[ETH_ADDR_LEN],
461 const uint8_t mask[ETH_ADDR_LEN])
463 cls_rule_set_eth_masked(arp_tha, mask,
464 rule->flow.arp_tha, rule->wc.arp_tha_mask);
468 cls_rule_set_ipv6_src(struct cls_rule *rule, const struct in6_addr *src)
470 rule->flow.ipv6_src = *src;
471 rule->wc.ipv6_src_mask = in6addr_exact;
475 cls_rule_set_ipv6_src_masked(struct cls_rule *rule, const struct in6_addr *src,
476 const struct in6_addr *mask)
478 rule->flow.ipv6_src = ipv6_addr_bitand(src, mask);
479 rule->wc.ipv6_src_mask = *mask;
483 cls_rule_set_ipv6_dst(struct cls_rule *rule, const struct in6_addr *dst)
485 rule->flow.ipv6_dst = *dst;
486 rule->wc.ipv6_dst_mask = in6addr_exact;
490 cls_rule_set_ipv6_dst_masked(struct cls_rule *rule, const struct in6_addr *dst,
491 const struct in6_addr *mask)
493 rule->flow.ipv6_dst = ipv6_addr_bitand(dst, mask);
494 rule->wc.ipv6_dst_mask = *mask;
498 cls_rule_set_ipv6_label(struct cls_rule *rule, ovs_be32 ipv6_label)
500 cls_rule_set_ipv6_label_masked(rule, ipv6_label, htonl(UINT32_MAX));
504 cls_rule_set_ipv6_label_masked(struct cls_rule *rule, ovs_be32 ipv6_label,
507 rule->flow.ipv6_label = ipv6_label & mask;
508 rule->wc.ipv6_label_mask = mask;
512 cls_rule_set_nd_target(struct cls_rule *rule, const struct in6_addr *target)
514 rule->flow.nd_target = *target;
515 rule->wc.nd_target_mask = in6addr_exact;
519 cls_rule_set_nd_target_masked(struct cls_rule *rule,
520 const struct in6_addr *target,
521 const struct in6_addr *mask)
523 rule->flow.nd_target = ipv6_addr_bitand(target, mask);
524 rule->wc.nd_target_mask = *mask;
527 /* Returns true if 'a' and 'b' have the same priority, wildcard the same
528 * fields, and have the same values for fixed fields, otherwise false. */
530 cls_rule_equal(const struct cls_rule *a, const struct cls_rule *b)
532 return (a->priority == b->priority
533 && flow_wildcards_equal(&a->wc, &b->wc)
534 && flow_equal(&a->flow, &b->flow));
537 /* Returns a hash value for the flow, wildcards, and priority in 'rule',
538 * starting from 'basis'. */
540 cls_rule_hash(const struct cls_rule *rule, uint32_t basis)
542 uint32_t h0 = flow_hash(&rule->flow, basis);
543 uint32_t h1 = flow_wildcards_hash(&rule->wc, h0);
544 return hash_int(rule->priority, h1);
548 format_eth_masked(struct ds *s, const char *name, const uint8_t eth[6],
549 const uint8_t mask[6])
551 if (!eth_addr_is_zero(mask)) {
552 ds_put_format(s, "%s=", name);
553 eth_format_masked(eth, mask, s);
559 format_ip_netmask(struct ds *s, const char *name, ovs_be32 ip,
563 ds_put_format(s, "%s=", name);
564 ip_format_masked(ip, netmask, s);
570 format_ipv6_netmask(struct ds *s, const char *name,
571 const struct in6_addr *addr,
572 const struct in6_addr *netmask)
574 if (!ipv6_mask_is_any(netmask)) {
575 ds_put_format(s, "%s=", name);
576 print_ipv6_masked(s, addr, netmask);
583 format_be16_masked(struct ds *s, const char *name,
584 ovs_be16 value, ovs_be16 mask)
586 if (mask != htons(0)) {
587 ds_put_format(s, "%s=", name);
588 if (mask == htons(UINT16_MAX)) {
589 ds_put_format(s, "%"PRIu16, ntohs(value));
591 ds_put_format(s, "0x%"PRIx16"/0x%"PRIx16,
592 ntohs(value), ntohs(mask));
599 cls_rule_format(const struct cls_rule *rule, struct ds *s)
601 const struct flow_wildcards *wc = &rule->wc;
602 size_t start_len = s->length;
603 const struct flow *f = &rule->flow;
604 bool skip_type = false;
605 bool skip_proto = false;
609 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
611 if (rule->priority != OFP_DEFAULT_PRIORITY) {
612 ds_put_format(s, "priority=%d,", rule->priority);
615 if (wc->dl_type_mask) {
617 if (f->dl_type == htons(ETH_TYPE_IP)) {
618 if (wc->nw_proto_mask) {
620 if (f->nw_proto == IPPROTO_ICMP) {
621 ds_put_cstr(s, "icmp,");
622 } else if (f->nw_proto == IPPROTO_TCP) {
623 ds_put_cstr(s, "tcp,");
624 } else if (f->nw_proto == IPPROTO_UDP) {
625 ds_put_cstr(s, "udp,");
627 ds_put_cstr(s, "ip,");
631 ds_put_cstr(s, "ip,");
633 } else if (f->dl_type == htons(ETH_TYPE_IPV6)) {
634 if (wc->nw_proto_mask) {
636 if (f->nw_proto == IPPROTO_ICMPV6) {
637 ds_put_cstr(s, "icmp6,");
638 } else if (f->nw_proto == IPPROTO_TCP) {
639 ds_put_cstr(s, "tcp6,");
640 } else if (f->nw_proto == IPPROTO_UDP) {
641 ds_put_cstr(s, "udp6,");
643 ds_put_cstr(s, "ipv6,");
647 ds_put_cstr(s, "ipv6,");
649 } else if (f->dl_type == htons(ETH_TYPE_ARP)) {
650 ds_put_cstr(s, "arp,");
655 for (i = 0; i < FLOW_N_REGS; i++) {
656 switch (wc->reg_masks[i]) {
660 ds_put_format(s, "reg%d=0x%"PRIx32",", i, f->regs[i]);
663 ds_put_format(s, "reg%d=0x%"PRIx32"/0x%"PRIx32",",
664 i, f->regs[i], wc->reg_masks[i]);
668 switch (wc->tun_id_mask) {
671 case CONSTANT_HTONLL(UINT64_MAX):
672 ds_put_format(s, "tun_id=%#"PRIx64",", ntohll(f->tun_id));
675 ds_put_format(s, "tun_id=%#"PRIx64"/%#"PRIx64",",
676 ntohll(f->tun_id), ntohll(wc->tun_id_mask));
679 switch (wc->metadata_mask) {
682 case CONSTANT_HTONLL(UINT64_MAX):
683 ds_put_format(s, "metadata=%#"PRIx64",", ntohll(f->metadata));
686 ds_put_format(s, "metadata=%#"PRIx64"/%#"PRIx64",",
687 ntohll(f->metadata), ntohll(wc->metadata_mask));
690 if (wc->in_port_mask) {
691 ds_put_format(s, "in_port=%"PRIu16",", f->in_port);
693 if (wc->vlan_tci_mask) {
694 ovs_be16 vid_mask = wc->vlan_tci_mask & htons(VLAN_VID_MASK);
695 ovs_be16 pcp_mask = wc->vlan_tci_mask & htons(VLAN_PCP_MASK);
696 ovs_be16 cfi = wc->vlan_tci_mask & htons(VLAN_CFI);
698 if (cfi && f->vlan_tci & htons(VLAN_CFI)
699 && (!vid_mask || vid_mask == htons(VLAN_VID_MASK))
700 && (!pcp_mask || pcp_mask == htons(VLAN_PCP_MASK))
701 && (vid_mask || pcp_mask)) {
703 ds_put_format(s, "dl_vlan=%"PRIu16",",
704 vlan_tci_to_vid(f->vlan_tci));
707 ds_put_format(s, "dl_vlan_pcp=%d,",
708 vlan_tci_to_pcp(f->vlan_tci));
710 } else if (wc->vlan_tci_mask == htons(0xffff)) {
711 ds_put_format(s, "vlan_tci=0x%04"PRIx16",", ntohs(f->vlan_tci));
713 ds_put_format(s, "vlan_tci=0x%04"PRIx16"/0x%04"PRIx16",",
714 ntohs(f->vlan_tci), ntohs(wc->vlan_tci_mask));
717 format_eth_masked(s, "dl_src", f->dl_src, wc->dl_src_mask);
718 format_eth_masked(s, "dl_dst", f->dl_dst, wc->dl_dst_mask);
719 if (!skip_type && wc->dl_type_mask) {
720 ds_put_format(s, "dl_type=0x%04"PRIx16",", ntohs(f->dl_type));
722 if (f->dl_type == htons(ETH_TYPE_IPV6)) {
723 format_ipv6_netmask(s, "ipv6_src", &f->ipv6_src, &wc->ipv6_src_mask);
724 format_ipv6_netmask(s, "ipv6_dst", &f->ipv6_dst, &wc->ipv6_dst_mask);
725 if (wc->ipv6_label_mask) {
726 if (wc->ipv6_label_mask == htonl(UINT32_MAX)) {
727 ds_put_format(s, "ipv6_label=0x%05"PRIx32",",
728 ntohl(f->ipv6_label));
730 ds_put_format(s, "ipv6_label=0x%05"PRIx32"/0x%05"PRIx32",",
731 ntohl(f->ipv6_label),
732 ntohl(wc->ipv6_label_mask));
736 format_ip_netmask(s, "nw_src", f->nw_src, wc->nw_src_mask);
737 format_ip_netmask(s, "nw_dst", f->nw_dst, wc->nw_dst_mask);
739 if (!skip_proto && wc->nw_proto_mask) {
740 if (f->dl_type == htons(ETH_TYPE_ARP)) {
741 ds_put_format(s, "arp_op=%"PRIu8",", f->nw_proto);
743 ds_put_format(s, "nw_proto=%"PRIu8",", f->nw_proto);
746 if (f->dl_type == htons(ETH_TYPE_ARP)) {
747 format_eth_masked(s, "arp_sha", f->arp_sha, wc->arp_sha_mask);
748 format_eth_masked(s, "arp_tha", f->arp_tha, wc->arp_tha_mask);
750 if (wc->nw_tos_mask & IP_DSCP_MASK) {
751 ds_put_format(s, "nw_tos=%"PRIu8",", f->nw_tos & IP_DSCP_MASK);
753 if (wc->nw_tos_mask & IP_ECN_MASK) {
754 ds_put_format(s, "nw_ecn=%"PRIu8",", f->nw_tos & IP_ECN_MASK);
756 if (wc->nw_ttl_mask) {
757 ds_put_format(s, "nw_ttl=%"PRIu8",", f->nw_ttl);
759 switch (wc->nw_frag_mask) {
760 case FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER:
761 ds_put_format(s, "nw_frag=%s,",
762 f->nw_frag & FLOW_NW_FRAG_ANY
763 ? (f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "first")
764 : (f->nw_frag & FLOW_NW_FRAG_LATER ? "<error>" : "no"));
767 case FLOW_NW_FRAG_ANY:
768 ds_put_format(s, "nw_frag=%s,",
769 f->nw_frag & FLOW_NW_FRAG_ANY ? "yes" : "no");
772 case FLOW_NW_FRAG_LATER:
773 ds_put_format(s, "nw_frag=%s,",
774 f->nw_frag & FLOW_NW_FRAG_LATER ? "later" : "not_later");
777 if (f->nw_proto == IPPROTO_ICMP) {
778 format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
779 format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
780 } else if (f->nw_proto == IPPROTO_ICMPV6) {
781 format_be16_masked(s, "icmp_type", f->tp_src, wc->tp_src_mask);
782 format_be16_masked(s, "icmp_code", f->tp_dst, wc->tp_dst_mask);
783 format_ipv6_netmask(s, "nd_target", &f->nd_target,
784 &wc->nd_target_mask);
785 format_eth_masked(s, "nd_sll", f->arp_sha, wc->arp_sha_mask);
786 format_eth_masked(s, "nd_tll", f->arp_tha, wc->arp_tha_mask);
788 format_be16_masked(s, "tp_src", f->tp_src, wc->tp_src_mask);
789 format_be16_masked(s, "tp_dst", f->tp_dst, wc->tp_dst_mask);
792 if (s->length > start_len && ds_last(s) == ',') {
797 /* Converts 'rule' to a string and returns the string. The caller must free
798 * the string (with free()). */
800 cls_rule_to_string(const struct cls_rule *rule)
802 struct ds s = DS_EMPTY_INITIALIZER;
803 cls_rule_format(rule, &s);
804 return ds_steal_cstr(&s);
808 cls_rule_print(const struct cls_rule *rule)
810 char *s = cls_rule_to_string(rule);
815 /* Initializes 'cls' as a classifier that initially contains no classification
818 classifier_init(struct classifier *cls)
821 hmap_init(&cls->tables);
824 /* Destroys 'cls'. Rules within 'cls', if any, are not freed; this is the
825 * caller's responsibility. */
827 classifier_destroy(struct classifier *cls)
830 struct cls_table *table, *next_table;
832 HMAP_FOR_EACH_SAFE (table, next_table, hmap_node, &cls->tables) {
833 hmap_destroy(&table->rules);
834 hmap_remove(&cls->tables, &table->hmap_node);
837 hmap_destroy(&cls->tables);
841 /* Returns true if 'cls' contains no classification rules, false otherwise. */
843 classifier_is_empty(const struct classifier *cls)
845 return cls->n_rules == 0;
848 /* Returns the number of rules in 'classifier'. */
850 classifier_count(const struct classifier *cls)
855 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
856 * must not modify or free it.
858 * If 'cls' already contains an identical rule (including wildcards, values of
859 * fixed fields, and priority), replaces the old rule by 'rule' and returns the
860 * rule that was replaced. The caller takes ownership of the returned rule and
861 * is thus responsible for freeing it, etc., as necessary.
863 * Returns NULL if 'cls' does not contain a rule with an identical key, after
864 * inserting the new rule. In this case, no rules are displaced by the new
865 * rule, even rules that cannot have any effect because the new rule matches a
866 * superset of their flows and has higher priority. */
868 classifier_replace(struct classifier *cls, struct cls_rule *rule)
870 struct cls_rule *old_rule;
871 struct cls_table *table;
873 table = find_table(cls, &rule->wc);
875 table = insert_table(cls, &rule->wc);
878 old_rule = insert_rule(table, rule);
880 table->n_table_rules++;
886 /* Inserts 'rule' into 'cls'. Until 'rule' is removed from 'cls', the caller
887 * must not modify or free it.
889 * 'cls' must not contain an identical rule (including wildcards, values of
890 * fixed fields, and priority). Use classifier_find_rule_exactly() to find
893 classifier_insert(struct classifier *cls, struct cls_rule *rule)
895 struct cls_rule *displaced_rule = classifier_replace(cls, rule);
896 assert(!displaced_rule);
899 /* Removes 'rule' from 'cls'. It is the caller's responsibility to free
900 * 'rule', if this is desirable. */
902 classifier_remove(struct classifier *cls, struct cls_rule *rule)
904 struct cls_rule *head;
905 struct cls_table *table;
907 table = find_table(cls, &rule->wc);
908 head = find_equal(table, &rule->flow, rule->hmap_node.hash);
910 list_remove(&rule->list);
911 } else if (list_is_empty(&rule->list)) {
912 hmap_remove(&table->rules, &rule->hmap_node);
914 struct cls_rule *next = CONTAINER_OF(rule->list.next,
915 struct cls_rule, list);
917 list_remove(&rule->list);
918 hmap_replace(&table->rules, &rule->hmap_node, &next->hmap_node);
921 if (--table->n_table_rules == 0) {
922 destroy_table(cls, table);
928 /* Finds and returns the highest-priority rule in 'cls' that matches 'flow'.
929 * Returns a null pointer if no rules in 'cls' match 'flow'. If multiple rules
930 * of equal priority match 'flow', returns one arbitrarily. */
932 classifier_lookup(const struct classifier *cls, const struct flow *flow)
934 struct cls_table *table;
935 struct cls_rule *best;
938 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
939 struct cls_rule *rule = find_match(table, flow);
940 if (rule && (!best || rule->priority > best->priority)) {
947 /* Finds and returns a rule in 'cls' with exactly the same priority and
948 * matching criteria as 'target'. Returns a null pointer if 'cls' doesn't
949 * contain an exact match. */
951 classifier_find_rule_exactly(const struct classifier *cls,
952 const struct cls_rule *target)
954 struct cls_rule *head, *rule;
955 struct cls_table *table;
957 table = find_table(cls, &target->wc);
962 head = find_equal(table, &target->flow, flow_hash(&target->flow, 0));
963 FOR_EACH_RULE_IN_LIST (rule, head) {
964 if (target->priority >= rule->priority) {
965 return target->priority == rule->priority ? rule : NULL;
971 /* Checks if 'target' would overlap any other rule in 'cls'. Two rules are
972 * considered to overlap if both rules have the same priority and a packet
973 * could match both. */
975 classifier_rule_overlaps(const struct classifier *cls,
976 const struct cls_rule *target)
978 struct cls_table *table;
980 HMAP_FOR_EACH (table, hmap_node, &cls->tables) {
981 struct flow_wildcards wc;
982 struct cls_rule *head;
984 flow_wildcards_combine(&wc, &target->wc, &table->wc);
985 HMAP_FOR_EACH (head, hmap_node, &table->rules) {
986 struct cls_rule *rule;
988 FOR_EACH_RULE_IN_LIST (rule, head) {
989 if (rule->priority == target->priority
990 && flow_equal_except(&target->flow, &rule->flow, &wc)) {
1000 /* Returns true if 'rule' exactly matches 'criteria' or if 'rule' is more
1001 * specific than 'criteria'. That is, 'rule' matches 'criteria' and this
1002 * function returns true if, for every field:
1004 * - 'criteria' and 'rule' specify the same (non-wildcarded) value for the
1007 * - 'criteria' wildcards the field,
1009 * Conversely, 'rule' does not match 'criteria' and this function returns false
1010 * if, for at least one field:
1012 * - 'criteria' and 'rule' specify different values for the field, or
1014 * - 'criteria' specifies a value for the field but 'rule' wildcards it.
1016 * Equivalently, the truth table for whether a field matches is:
1021 * r +---------+---------+
1022 * i wild | yes | yes |
1024 * e +---------+---------+
1025 * r exact | no |if values|
1027 * a +---------+---------+
1029 * This is the matching rule used by OpenFlow 1.0 non-strict OFPT_FLOW_MOD
1030 * commands and by OpenFlow 1.0 aggregate and flow stats.
1032 * Ignores rule->priority and criteria->priority. */
1034 cls_rule_is_loose_match(const struct cls_rule *rule,
1035 const struct cls_rule *criteria)
1037 return (!flow_wildcards_has_extra(&rule->wc, &criteria->wc)
1038 && flow_equal_except(&rule->flow, &criteria->flow, &criteria->wc));
1044 rule_matches(const struct cls_rule *rule, const struct cls_rule *target)
1047 || flow_equal_except(&rule->flow, &target->flow, &target->wc));
1050 static struct cls_rule *
1051 search_table(const struct cls_table *table, const struct cls_rule *target)
1053 if (!target || !flow_wildcards_has_extra(&table->wc, &target->wc)) {
1054 struct cls_rule *rule;
1056 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1057 if (rule_matches(rule, target)) {
1065 /* Initializes 'cursor' for iterating through rules in 'cls':
1067 * - If 'target' is null, the cursor will visit every rule in 'cls'.
1069 * - If 'target' is nonnull, the cursor will visit each 'rule' in 'cls'
1070 * such that cls_rule_is_loose_match(rule, target) returns true.
1072 * Ignores target->priority. */
1074 cls_cursor_init(struct cls_cursor *cursor, const struct classifier *cls,
1075 const struct cls_rule *target)
1078 cursor->target = target;
1081 /* Returns the first matching cls_rule in 'cursor''s iteration, or a null
1082 * pointer if there are no matches. */
1084 cls_cursor_first(struct cls_cursor *cursor)
1086 struct cls_table *table;
1088 HMAP_FOR_EACH (table, hmap_node, &cursor->cls->tables) {
1089 struct cls_rule *rule = search_table(table, cursor->target);
1091 cursor->table = table;
1099 /* Returns the next matching cls_rule in 'cursor''s iteration, or a null
1100 * pointer if there are no more matches. */
1102 cls_cursor_next(struct cls_cursor *cursor, struct cls_rule *rule)
1104 const struct cls_table *table;
1105 struct cls_rule *next;
1107 next = next_rule_in_list__(rule);
1108 if (next->priority < rule->priority) {
1112 /* 'next' is the head of the list, that is, the rule that is included in
1113 * the table's hmap. (This is important when the classifier contains rules
1114 * that differ only in priority.) */
1116 HMAP_FOR_EACH_CONTINUE (rule, hmap_node, &cursor->table->rules) {
1117 if (rule_matches(rule, cursor->target)) {
1122 table = cursor->table;
1123 HMAP_FOR_EACH_CONTINUE (table, hmap_node, &cursor->cls->tables) {
1124 rule = search_table(table, cursor->target);
1126 cursor->table = table;
1134 static struct cls_table *
1135 find_table(const struct classifier *cls, const struct flow_wildcards *wc)
1137 struct cls_table *table;
1139 HMAP_FOR_EACH_IN_BUCKET (table, hmap_node, flow_wildcards_hash(wc, 0),
1141 if (flow_wildcards_equal(wc, &table->wc)) {
1148 static struct cls_table *
1149 insert_table(struct classifier *cls, const struct flow_wildcards *wc)
1151 struct cls_table *table;
1153 table = xzalloc(sizeof *table);
1154 hmap_init(&table->rules);
1156 table->is_catchall = flow_wildcards_is_catchall(&table->wc);
1157 hmap_insert(&cls->tables, &table->hmap_node, flow_wildcards_hash(wc, 0));
1163 destroy_table(struct classifier *cls, struct cls_table *table)
1165 hmap_remove(&cls->tables, &table->hmap_node);
1166 hmap_destroy(&table->rules);
1170 static struct cls_rule *
1171 find_match(const struct cls_table *table, const struct flow *flow)
1173 struct cls_rule *rule;
1175 if (table->is_catchall) {
1176 HMAP_FOR_EACH (rule, hmap_node, &table->rules) {
1183 flow_zero_wildcards(&f, &table->wc);
1184 HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, flow_hash(&f, 0),
1186 if (flow_equal(&f, &rule->flow)) {
1195 static struct cls_rule *
1196 find_equal(struct cls_table *table, const struct flow *flow, uint32_t hash)
1198 struct cls_rule *head;
1200 HMAP_FOR_EACH_WITH_HASH (head, hmap_node, hash, &table->rules) {
1201 if (flow_equal(&head->flow, flow)) {
1208 static struct cls_rule *
1209 insert_rule(struct cls_table *table, struct cls_rule *new)
1211 struct cls_rule *head;
1213 new->hmap_node.hash = flow_hash(&new->flow, 0);
1215 head = find_equal(table, &new->flow, new->hmap_node.hash);
1217 hmap_insert(&table->rules, &new->hmap_node, new->hmap_node.hash);
1218 list_init(&new->list);
1221 /* Scan the list for the insertion point that will keep the list in
1222 * order of decreasing priority. */
1223 struct cls_rule *rule;
1224 FOR_EACH_RULE_IN_LIST (rule, head) {
1225 if (new->priority >= rule->priority) {
1227 /* 'new' is the new highest-priority flow in the list. */
1228 hmap_replace(&table->rules,
1229 &rule->hmap_node, &new->hmap_node);
1232 if (new->priority == rule->priority) {
1233 list_replace(&new->list, &rule->list);
1236 list_insert(&rule->list, &new->list);
1242 /* Insert 'new' at the end of the list. */
1243 list_push_back(&head->list, &new->list);
1248 static struct cls_rule *
1249 next_rule_in_list__(struct cls_rule *rule)
1251 struct cls_rule *next = OBJECT_CONTAINING(rule->list.next, next, list);
1255 static struct cls_rule *
1256 next_rule_in_list(struct cls_rule *rule)
1258 struct cls_rule *next = next_rule_in_list__(rule);
1259 return next->priority < rule->priority ? next : NULL;
1263 ipv6_equal_except(const struct in6_addr *a, const struct in6_addr *b,
1264 const struct in6_addr *mask)
1269 for (i=0; i<4; i++) {
1270 if ((a->s6_addr32[i] ^ b->s6_addr32[i]) & mask->s6_addr32[i]) {
1275 for (i=0; i<16; i++) {
1276 if ((a->s6_addr[i] ^ b->s6_addr[i]) & mask->s6_addr[i]) {
1287 flow_equal_except(const struct flow *a, const struct flow *b,
1288 const struct flow_wildcards *wildcards)
1292 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
1294 for (i = 0; i < FLOW_N_REGS; i++) {
1295 if ((a->regs[i] ^ b->regs[i]) & wildcards->reg_masks[i]) {
1300 return (!((a->tun_id ^ b->tun_id) & wildcards->tun_id_mask)
1301 && !((a->metadata ^ b->metadata) & wildcards->metadata_mask)
1302 && !((a->nw_src ^ b->nw_src) & wildcards->nw_src_mask)
1303 && !((a->nw_dst ^ b->nw_dst) & wildcards->nw_dst_mask)
1304 && !((a->in_port ^ b->in_port) & wildcards->in_port_mask)
1305 && !((a->vlan_tci ^ b->vlan_tci) & wildcards->vlan_tci_mask)
1306 && !((a->dl_type ^ b->dl_type) & wildcards->dl_type_mask)
1307 && !((a->tp_src ^ b->tp_src) & wildcards->tp_src_mask)
1308 && !((a->tp_dst ^ b->tp_dst) & wildcards->tp_dst_mask)
1309 && eth_addr_equal_except(a->dl_src, b->dl_src,
1310 wildcards->dl_src_mask)
1311 && eth_addr_equal_except(a->dl_dst, b->dl_dst,
1312 wildcards->dl_dst_mask)
1313 && !((a->nw_proto ^ b->nw_proto) & wildcards->nw_proto_mask)
1314 && !((a->nw_ttl ^ b->nw_ttl) & wildcards->nw_ttl_mask)
1315 && !((a->nw_tos ^ b->nw_tos) & wildcards->nw_tos_mask)
1316 && !((a->nw_frag ^ b->nw_frag) & wildcards->nw_frag_mask)
1317 && eth_addr_equal_except(a->arp_sha, b->arp_sha,
1318 wildcards->arp_sha_mask)
1319 && eth_addr_equal_except(a->arp_tha, b->arp_tha,
1320 wildcards->arp_tha_mask)
1321 && !((a->ipv6_label ^ b->ipv6_label) & wildcards->ipv6_label_mask)
1322 && ipv6_equal_except(&a->ipv6_src, &b->ipv6_src,
1323 &wildcards->ipv6_src_mask)
1324 && ipv6_equal_except(&a->ipv6_dst, &b->ipv6_dst,
1325 &wildcards->ipv6_dst_mask)
1326 && ipv6_equal_except(&a->nd_target, &b->nd_target,
1327 &wildcards->nd_target_mask));