2 * Copyright (c) 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.
19 #include "meta-flow.h"
24 #include <netinet/icmp6.h>
25 #include <netinet/ip6.h>
27 #include "classifier.h"
28 #include "dynamic-string.h"
29 #include "ofp-errors.h"
34 #include "socket-util.h"
35 #include "unaligned.h"
38 VLOG_DEFINE_THIS_MODULE(meta_flow
);
40 #define MF_FIELD_SIZES(MEMBER) \
41 sizeof ((union mf_value *)0)->MEMBER, \
42 8 * sizeof ((union mf_value *)0)->MEMBER
44 static const struct mf_field mf_fields
[MFF_N_IDS
] = {
50 MFF_TUN_ID
, "tun_id", NULL
,
56 NXM_NX_TUN_ID
, "NXM_NX_TUN_ID",
57 NXM_NX_TUN_ID
, "NXM_NX_TUN_ID",
59 MFF_METADATA
, "metadata", NULL
,
65 OXM_OF_METADATA
, "OXM_OF_METADATA",
66 OXM_OF_METADATA
, "OXM_OF_METADATA",
68 MFF_IN_PORT
, "in_port", NULL
,
74 NXM_OF_IN_PORT
, "NXM_OF_IN_PORT",
75 OXM_OF_IN_PORT
, "OXM_OF_IN_PORT",
78 #define REGISTER(IDX) \
80 MFF_REG##IDX, "reg" #IDX, NULL, \
81 MF_FIELD_SIZES(be32), \
86 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
87 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
122 MFF_ETH_SRC
, "eth_src", "dl_src",
128 NXM_OF_ETH_SRC
, "NXM_OF_ETH_SRC",
129 OXM_OF_ETH_SRC
, "OXM_OF_ETH_SRC",
131 MFF_ETH_DST
, "eth_dst", "dl_dst",
137 NXM_OF_ETH_DST
, "NXM_OF_ETH_DST",
138 OXM_OF_ETH_DST
, "OXM_OF_ETH_DST",
140 MFF_ETH_TYPE
, "eth_type", "dl_type",
141 MF_FIELD_SIZES(be16
),
146 NXM_OF_ETH_TYPE
, "NXM_OF_ETH_TYPE",
147 OXM_OF_ETH_TYPE
, "OXM_OF_ETH_TYPE",
151 MFF_VLAN_TCI
, "vlan_tci", NULL
,
152 MF_FIELD_SIZES(be16
),
157 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
158 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
160 MFF_DL_VLAN
, "dl_vlan", NULL
,
161 sizeof(ovs_be16
), 12,
169 MFF_VLAN_VID
, "vlan_vid", NULL
,
170 sizeof(ovs_be16
), 12,
175 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
176 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
178 MFF_DL_VLAN_PCP
, "dl_vlan_pcp", NULL
,
187 MFF_VLAN_PCP
, "vlan_pcp", NULL
,
193 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
194 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
202 MFF_IPV4_SRC
, "ip_src", "nw_src",
203 MF_FIELD_SIZES(be32
),
208 NXM_OF_IP_SRC
, "NXM_OF_IP_SRC",
209 OXM_OF_IPV4_SRC
, "OXM_OF_IPV4_SRC",
211 MFF_IPV4_DST
, "ip_dst", "nw_dst",
212 MF_FIELD_SIZES(be32
),
217 NXM_OF_IP_DST
, "NXM_OF_IP_DST",
218 OXM_OF_IPV4_DST
, "OXM_OF_IPV4_DST",
222 MFF_IPV6_SRC
, "ipv6_src", NULL
,
223 MF_FIELD_SIZES(ipv6
),
228 NXM_NX_IPV6_SRC
, "NXM_NX_IPV6_SRC",
229 OXM_OF_IPV6_SRC
, "OXM_OF_IPV6_SRC",
231 MFF_IPV6_DST
, "ipv6_dst", NULL
,
232 MF_FIELD_SIZES(ipv6
),
237 NXM_NX_IPV6_DST
, "NXM_NX_IPV6_DST",
238 OXM_OF_IPV6_DST
, "OXM_OF_IPV6_DST",
241 MFF_IPV6_LABEL
, "ipv6_label", NULL
,
247 NXM_NX_IPV6_LABEL
, "NXM_NX_IPV6_LABEL",
248 OXM_OF_IPV6_FLABEL
, "OXM_OF_IPV6_FLABEL",
252 MFF_IP_PROTO
, "nw_proto", NULL
,
258 NXM_OF_IP_PROTO
, "NXM_OF_IP_PROTO",
259 OXM_OF_IP_PROTO
, "OXM_OF_IP_PROTO",
261 MFF_IP_DSCP
, "nw_tos", NULL
,
267 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS",
268 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP",
270 MFF_IP_ECN
, "nw_ecn", NULL
,
276 NXM_NX_IP_ECN
, "NXM_NX_IP_ECN",
277 OXM_OF_IP_ECN
, "OXM_OF_IP_ECN",
279 MFF_IP_TTL
, "nw_ttl", NULL
,
285 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
286 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
288 MFF_IP_FRAG
, "ip_frag", NULL
,
294 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
295 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
299 MFF_ARP_OP
, "arp_op", NULL
,
300 MF_FIELD_SIZES(be16
),
305 NXM_OF_ARP_OP
, "NXM_OF_ARP_OP",
306 OXM_OF_ARP_OP
, "OXM_OF_ARP_OP",
308 MFF_ARP_SPA
, "arp_spa", NULL
,
309 MF_FIELD_SIZES(be32
),
314 NXM_OF_ARP_SPA
, "NXM_OF_ARP_SPA",
315 OXM_OF_ARP_SPA
, "OXM_OF_ARP_SPA",
317 MFF_ARP_TPA
, "arp_tpa", NULL
,
318 MF_FIELD_SIZES(be32
),
323 NXM_OF_ARP_TPA
, "NXM_OF_ARP_TPA",
324 OXM_OF_ARP_TPA
, "OXM_OF_ARP_TPA",
326 MFF_ARP_SHA
, "arp_sha", NULL
,
332 NXM_NX_ARP_SHA
, "NXM_NX_ARP_SHA",
333 OXM_OF_ARP_SHA
, "OXM_OF_ARP_SHA",
335 MFF_ARP_THA
, "arp_tha", NULL
,
341 NXM_NX_ARP_THA
, "NXM_NX_ARP_THA",
342 OXM_OF_ARP_THA
, "OXM_OF_ARP_THA",
350 MFF_TCP_SRC
, "tcp_src", "tp_src",
351 MF_FIELD_SIZES(be16
),
356 NXM_OF_TCP_SRC
, "NXM_OF_TCP_SRC",
357 OXM_OF_TCP_SRC
, "OXM_OF_TCP_SRC",
359 MFF_TCP_DST
, "tcp_dst", "tp_dst",
360 MF_FIELD_SIZES(be16
),
365 NXM_OF_TCP_DST
, "NXM_OF_TCP_DST",
366 OXM_OF_TCP_DST
, "OXM_OF_TCP_DST",
370 MFF_UDP_SRC
, "udp_src", NULL
,
371 MF_FIELD_SIZES(be16
),
376 NXM_OF_UDP_SRC
, "NXM_OF_UDP_SRC",
377 OXM_OF_UDP_SRC
, "OXM_OF_UDP_SRC",
379 MFF_UDP_DST
, "udp_dst", NULL
,
380 MF_FIELD_SIZES(be16
),
385 NXM_OF_UDP_DST
, "NXM_OF_UDP_DST",
386 OXM_OF_UDP_DST
, "OXM_OF_UDP_DST",
390 MFF_ICMPV4_TYPE
, "icmp_type", NULL
,
396 NXM_OF_ICMP_TYPE
, "NXM_OF_ICMP_TYPE",
397 OXM_OF_ICMPV4_TYPE
, "OXM_OF_ICMPV4_TYPE",
399 MFF_ICMPV4_CODE
, "icmp_code", NULL
,
405 NXM_OF_ICMP_CODE
, "NXM_OF_ICMP_CODE",
406 OXM_OF_ICMPV4_CODE
, "OXM_OF_ICMPV4_CODE",
410 MFF_ICMPV6_TYPE
, "icmpv6_type", NULL
,
416 NXM_NX_ICMPV6_TYPE
, "NXM_NX_ICMPV6_TYPE",
417 OXM_OF_ICMPV6_TYPE
, "OXM_OF_ICMPV6_TYPE",
419 MFF_ICMPV6_CODE
, "icmpv6_code", NULL
,
425 NXM_NX_ICMPV6_CODE
, "NXM_NX_ICMPV6_CODE",
426 OXM_OF_ICMPV6_CODE
, "OXM_OF_ICMPV6_CODE",
434 MFF_ND_TARGET
, "nd_target", NULL
,
435 MF_FIELD_SIZES(ipv6
),
440 NXM_NX_ND_TARGET
, "NXM_NX_ND_TARGET",
441 OXM_OF_IPV6_ND_TARGET
, "OXM_OF_IPV6_ND_TARGET",
443 MFF_ND_SLL
, "nd_sll", NULL
,
449 NXM_NX_ND_SLL
, "NXM_NX_ND_SLL",
450 OXM_OF_IPV6_ND_SLL
, "OXM_OF_IPV6_ND_SLL",
452 MFF_ND_TLL
, "nd_tll", NULL
,
458 NXM_NX_ND_TLL
, "NXM_NX_ND_TLL",
459 OXM_OF_IPV6_ND_TLL
, "OXM_OF_IPV6_ND_TLL",
463 /* Maps an NXM or OXM header value to an mf_field. */
465 struct hmap_node hmap_node
; /* In 'all_fields' hmap. */
466 uint32_t header
; /* NXM or OXM header value. */
467 const struct mf_field
*mf
;
470 /* Contains 'struct nxm_field's. */
471 static struct hmap all_fields
= HMAP_INITIALIZER(&all_fields
);
473 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
474 * controller and so there's not much point in showing a lot of them. */
475 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
477 const struct mf_field
*mf_from_nxm_header__(uint32_t header
);
479 /* Returns the field with the given 'id'. */
480 const struct mf_field
*
481 mf_from_id(enum mf_field_id id
)
483 assert((unsigned int) id
< MFF_N_IDS
);
484 return &mf_fields
[id
];
487 /* Returns the field with the given 'name', or a null pointer if no field has
489 const struct mf_field
*
490 mf_from_name(const char *name
)
492 static struct shash mf_by_name
= SHASH_INITIALIZER(&mf_by_name
);
494 if (shash_is_empty(&mf_by_name
)) {
495 const struct mf_field
*mf
;
497 for (mf
= mf_fields
; mf
< &mf_fields
[MFF_N_IDS
]; mf
++) {
498 shash_add_once(&mf_by_name
, mf
->name
, mf
);
499 if (mf
->extra_name
) {
500 shash_add_once(&mf_by_name
, mf
->extra_name
, mf
);
505 return shash_find_data(&mf_by_name
, name
);
509 add_nxm_field(uint32_t header
, const struct mf_field
*mf
)
513 f
= xmalloc(sizeof *f
);
514 hmap_insert(&all_fields
, &f
->hmap_node
, hash_int(header
, 0));
520 nxm_init_add_field(const struct mf_field
*mf
, uint32_t header
)
523 assert(!mf_from_nxm_header__(header
));
524 add_nxm_field(header
, mf
);
525 if (mf
->maskable
!= MFM_NONE
) {
526 add_nxm_field(NXM_MAKE_WILD_HEADER(header
), mf
);
534 const struct mf_field
*mf
;
536 for (mf
= mf_fields
; mf
< &mf_fields
[MFF_N_IDS
]; mf
++) {
537 nxm_init_add_field(mf
, mf
->nxm_header
);
538 if (mf
->oxm_header
!= mf
->nxm_header
) {
539 nxm_init_add_field(mf
, mf
->oxm_header
);
544 const struct mf_field
*
545 mf_from_nxm_header(uint32_t header
)
547 if (hmap_is_empty(&all_fields
)) {
550 return mf_from_nxm_header__(header
);
553 const struct mf_field
*
554 mf_from_nxm_header__(uint32_t header
)
556 const struct nxm_field
*f
;
558 HMAP_FOR_EACH_IN_BUCKET (f
, hmap_node
, hash_int(header
, 0), &all_fields
) {
559 if (f
->header
== header
) {
567 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
568 * specifies at least one bit in the field.
570 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
571 * meets 'mf''s prerequisites. */
573 mf_is_all_wild(const struct mf_field
*mf
, const struct flow_wildcards
*wc
)
577 return !wc
->tun_id_mask
;
579 return !wc
->metadata_mask
;
581 return !wc
->in_port_mask
;
583 return !wc
->reg_masks
[mf
->id
- MFF_REG0
];
586 return eth_addr_is_zero(wc
->dl_src_mask
);
588 return eth_addr_is_zero(wc
->dl_dst_mask
);
590 return !wc
->dl_type_mask
;
594 return eth_addr_is_zero(wc
->arp_sha_mask
);
598 return eth_addr_is_zero(wc
->arp_tha_mask
);
601 return !wc
->vlan_tci_mask
;
603 return !(wc
->vlan_tci_mask
& htons(VLAN_VID_MASK
));
605 return !(wc
->vlan_tci_mask
& htons(VLAN_VID_MASK
| VLAN_CFI
));
606 case MFF_DL_VLAN_PCP
:
608 return !(wc
->vlan_tci_mask
& htons(VLAN_PCP_MASK
));
611 return !wc
->nw_src_mask
;
613 return !wc
->nw_dst_mask
;
616 return ipv6_mask_is_any(&wc
->ipv6_src_mask
);
618 return ipv6_mask_is_any(&wc
->ipv6_dst_mask
);
621 return !wc
->ipv6_label_mask
;
624 return !wc
->nw_proto_mask
;
626 return !(wc
->nw_tos_mask
& IP_DSCP_MASK
);
628 return !(wc
->nw_tos_mask
& IP_ECN_MASK
);
630 return !wc
->nw_ttl_mask
;
633 return ipv6_mask_is_any(&wc
->nd_target_mask
);
636 return !(wc
->nw_frag_mask
& FLOW_NW_FRAG_MASK
);
639 return !wc
->nw_proto_mask
;
641 return !wc
->nw_src_mask
;
643 return !wc
->nw_dst_mask
;
647 case MFF_ICMPV4_TYPE
:
648 case MFF_ICMPV6_TYPE
:
649 return !wc
->tp_src_mask
;
652 case MFF_ICMPV4_CODE
:
653 case MFF_ICMPV6_CODE
:
654 return !wc
->tp_dst_mask
;
662 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
663 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
664 * purposes, or to 0 if it is wildcarded.
666 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
667 * meets 'mf''s prerequisites. */
669 mf_get_mask(const struct mf_field
*mf
, const struct flow_wildcards
*wc
,
670 union mf_value
*mask
)
674 mask
->be64
= wc
->tun_id_mask
;
677 mask
->be64
= wc
->metadata_mask
;
680 mask
->be16
= htons(wc
->in_port_mask
);
683 mask
->be32
= htonl(wc
->reg_masks
[mf
->id
- MFF_REG0
]);
687 memcpy(mask
->mac
, wc
->dl_dst_mask
, ETH_ADDR_LEN
);
690 memcpy(mask
->mac
, wc
->dl_src_mask
, ETH_ADDR_LEN
);
693 mask
->be16
= wc
->dl_type_mask
;
697 mask
->be16
= wc
->vlan_tci_mask
;
700 mask
->be16
= wc
->vlan_tci_mask
& htons(VLAN_VID_MASK
);
703 mask
->be16
= wc
->vlan_tci_mask
& htons(VLAN_VID_MASK
| VLAN_CFI
);
705 case MFF_DL_VLAN_PCP
:
707 mask
->u8
= vlan_tci_to_pcp(wc
->vlan_tci_mask
);
711 mask
->be32
= wc
->nw_src_mask
;
714 mask
->be32
= wc
->nw_dst_mask
;
718 mask
->ipv6
= wc
->ipv6_src_mask
;
721 mask
->ipv6
= wc
->ipv6_dst_mask
;
724 mask
->be32
= wc
->ipv6_label_mask
;
728 mask
->u8
= wc
->nw_proto_mask
;
731 mask
->u8
= wc
->nw_tos_mask
& IP_DSCP_MASK
;
734 mask
->u8
= wc
->nw_tos_mask
& IP_ECN_MASK
;
738 mask
->ipv6
= wc
->nd_target_mask
;
742 mask
->u8
= wc
->nw_ttl_mask
;
745 mask
->u8
= wc
->nw_frag_mask
& FLOW_NW_FRAG_MASK
;
749 mask
->u8
= wc
->nw_proto_mask
;
752 mask
->be32
= wc
->nw_src_mask
;
755 mask
->be32
= wc
->nw_dst_mask
;
759 memcpy(mask
->mac
, wc
->arp_sha_mask
, ETH_ADDR_LEN
);
763 memcpy(mask
->mac
, wc
->arp_tha_mask
, ETH_ADDR_LEN
);
768 mask
->be16
= wc
->tp_src_mask
;
772 mask
->be16
= wc
->tp_dst_mask
;
775 case MFF_ICMPV4_TYPE
:
776 case MFF_ICMPV6_TYPE
:
777 mask
->u8
= ntohs(wc
->tp_src_mask
);
779 case MFF_ICMPV4_CODE
:
780 case MFF_ICMPV6_CODE
:
781 mask
->u8
= ntohs(wc
->tp_dst_mask
);
790 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
791 * if the mask is valid, false otherwise. */
793 mf_is_mask_valid(const struct mf_field
*mf
, const union mf_value
*mask
)
795 switch (mf
->maskable
) {
797 return (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
) ||
798 is_all_ones((const uint8_t *) mask
, mf
->n_bytes
));
808 is_ip_any(const struct flow
*flow
)
810 return (flow
->dl_type
== htons(ETH_TYPE_IP
) ||
811 flow
->dl_type
== htons(ETH_TYPE_IPV6
));
815 is_icmpv4(const struct flow
*flow
)
817 return (flow
->dl_type
== htons(ETH_TYPE_IP
)
818 && flow
->nw_proto
== IPPROTO_ICMP
);
822 is_icmpv6(const struct flow
*flow
)
824 return (flow
->dl_type
== htons(ETH_TYPE_IPV6
)
825 && flow
->nw_proto
== IPPROTO_ICMPV6
);
828 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
830 mf_are_prereqs_ok(const struct mf_field
*mf
, const struct flow
*flow
)
832 switch (mf
->prereqs
) {
837 return flow
->dl_type
== htons(ETH_TYPE_ARP
);
839 return flow
->dl_type
== htons(ETH_TYPE_IP
);
841 return flow
->dl_type
== htons(ETH_TYPE_IPV6
);
843 return (flow
->vlan_tci
& htons(VLAN_CFI
)) != 0;
845 return is_ip_any(flow
);
848 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_TCP
;
850 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_UDP
;
852 return is_icmpv4(flow
);
854 return is_icmpv6(flow
);
857 return (is_icmpv6(flow
)
858 && flow
->tp_dst
== htons(0)
859 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
) ||
860 flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
862 return (is_icmpv6(flow
)
863 && flow
->tp_dst
== htons(0)
864 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
)));
866 return (is_icmpv6(flow
)
867 && flow
->tp_dst
== htons(0)
868 && (flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
874 /* Returns true if 'value' may be a valid value *as part of a masked match*,
877 * A value is not rejected just because it is not valid for the field in
878 * question, but only if it doesn't make sense to test the bits in question at
879 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
880 * without the VLAN_CFI bit being set, but we can't reject those values because
881 * it is still legitimate to test just for those bits (see the documentation
882 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
883 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
885 mf_is_value_valid(const struct mf_field
*mf
, const union mf_value
*value
)
910 case MFF_ICMPV4_TYPE
:
911 case MFF_ICMPV4_CODE
:
912 case MFF_ICMPV6_TYPE
:
913 case MFF_ICMPV6_CODE
:
920 return !(value
->u8
& ~IP_DSCP_MASK
);
922 return !(value
->u8
& ~IP_ECN_MASK
);
924 return !(value
->u8
& ~FLOW_NW_FRAG_MASK
);
927 return !(value
->be16
& htons(0xff00));
930 return !(value
->be16
& htons(VLAN_CFI
| VLAN_PCP_MASK
));
932 return !(value
->be16
& htons(VLAN_PCP_MASK
));
934 case MFF_DL_VLAN_PCP
:
936 return !(value
->u8
& ~(VLAN_PCP_MASK
>> VLAN_PCP_SHIFT
));
939 return !(value
->be32
& ~htonl(IPV6_LABEL_MASK
));
947 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
948 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
950 mf_get_value(const struct mf_field
*mf
, const struct flow
*flow
,
951 union mf_value
*value
)
955 value
->be64
= flow
->tun_id
;
958 value
->be64
= flow
->metadata
;
962 value
->be16
= htons(flow
->in_port
);
966 value
->be32
= htonl(flow
->regs
[mf
->id
- MFF_REG0
]);
970 memcpy(value
->mac
, flow
->dl_src
, ETH_ADDR_LEN
);
974 memcpy(value
->mac
, flow
->dl_dst
, ETH_ADDR_LEN
);
978 value
->be16
= flow
->dl_type
;
982 value
->be16
= flow
->vlan_tci
;
986 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
);
989 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
);
992 case MFF_DL_VLAN_PCP
:
994 value
->u8
= vlan_tci_to_pcp(flow
->vlan_tci
);
998 value
->be32
= flow
->nw_src
;
1002 value
->be32
= flow
->nw_dst
;
1006 value
->ipv6
= flow
->ipv6_src
;
1010 value
->ipv6
= flow
->ipv6_dst
;
1013 case MFF_IPV6_LABEL
:
1014 value
->be32
= flow
->ipv6_label
;
1018 value
->u8
= flow
->nw_proto
;
1022 value
->u8
= flow
->nw_tos
& IP_DSCP_MASK
;
1026 value
->u8
= flow
->nw_tos
& IP_ECN_MASK
;
1030 value
->u8
= flow
->nw_ttl
;
1034 value
->u8
= flow
->nw_frag
;
1038 value
->be16
= htons(flow
->nw_proto
);
1042 value
->be32
= flow
->nw_src
;
1046 value
->be32
= flow
->nw_dst
;
1051 memcpy(value
->mac
, flow
->arp_sha
, ETH_ADDR_LEN
);
1056 memcpy(value
->mac
, flow
->arp_tha
, ETH_ADDR_LEN
);
1061 value
->be16
= flow
->tp_src
;
1066 value
->be16
= flow
->tp_dst
;
1069 case MFF_ICMPV4_TYPE
:
1070 case MFF_ICMPV6_TYPE
:
1071 value
->u8
= ntohs(flow
->tp_src
);
1074 case MFF_ICMPV4_CODE
:
1075 case MFF_ICMPV6_CODE
:
1076 value
->u8
= ntohs(flow
->tp_dst
);
1080 value
->ipv6
= flow
->nd_target
;
1089 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1090 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1093 mf_set_value(const struct mf_field
*mf
,
1094 const union mf_value
*value
, struct cls_rule
*rule
)
1098 cls_rule_set_tun_id(rule
, value
->be64
);
1101 cls_rule_set_metadata(rule
, value
->be64
);
1105 cls_rule_set_in_port(rule
, ntohs(value
->be16
));
1109 cls_rule_set_reg(rule
, mf
->id
- MFF_REG0
, ntohl(value
->be32
));
1113 cls_rule_set_dl_src(rule
, value
->mac
);
1117 cls_rule_set_dl_dst(rule
, value
->mac
);
1121 cls_rule_set_dl_type(rule
, value
->be16
);
1125 cls_rule_set_dl_tci(rule
, value
->be16
);
1129 cls_rule_set_dl_vlan(rule
, value
->be16
);
1132 cls_rule_set_vlan_vid(rule
, value
->be16
);
1135 case MFF_DL_VLAN_PCP
:
1137 cls_rule_set_dl_vlan_pcp(rule
, value
->u8
);
1141 cls_rule_set_nw_src(rule
, value
->be32
);
1145 cls_rule_set_nw_dst(rule
, value
->be32
);
1149 cls_rule_set_ipv6_src(rule
, &value
->ipv6
);
1153 cls_rule_set_ipv6_dst(rule
, &value
->ipv6
);
1156 case MFF_IPV6_LABEL
:
1157 cls_rule_set_ipv6_label(rule
, value
->be32
);
1161 cls_rule_set_nw_proto(rule
, value
->u8
);
1165 cls_rule_set_nw_dscp(rule
, value
->u8
);
1169 cls_rule_set_nw_ecn(rule
, value
->u8
);
1173 cls_rule_set_nw_ttl(rule
, value
->u8
);
1177 cls_rule_set_nw_frag(rule
, value
->u8
);
1181 cls_rule_set_nw_proto(rule
, ntohs(value
->be16
));
1185 cls_rule_set_nw_src(rule
, value
->be32
);
1189 cls_rule_set_nw_dst(rule
, value
->be32
);
1194 cls_rule_set_arp_sha(rule
, value
->mac
);
1199 cls_rule_set_arp_tha(rule
, value
->mac
);
1204 cls_rule_set_tp_src(rule
, value
->be16
);
1209 cls_rule_set_tp_dst(rule
, value
->be16
);
1212 case MFF_ICMPV4_TYPE
:
1213 case MFF_ICMPV6_TYPE
:
1214 cls_rule_set_icmp_type(rule
, value
->u8
);
1217 case MFF_ICMPV4_CODE
:
1218 case MFF_ICMPV6_CODE
:
1219 cls_rule_set_icmp_code(rule
, value
->u8
);
1223 cls_rule_set_nd_target(rule
, &value
->ipv6
);
1232 /* Makes 'rule' match field 'mf' exactly, with the value matched taken from
1233 * 'value'. The caller is responsible for ensuring that 'rule' meets 'mf''s
1236 mf_set_flow_value(const struct mf_field
*mf
,
1237 const union mf_value
*value
, struct flow
*flow
)
1241 flow
->tun_id
= value
->be64
;
1244 flow
->metadata
= value
->be64
;
1248 flow
->in_port
= ntohs(value
->be16
);
1252 flow
->regs
[mf
->id
- MFF_REG0
] = ntohl(value
->be32
);
1256 memcpy(flow
->dl_src
, value
->mac
, ETH_ADDR_LEN
);
1260 memcpy(flow
->dl_dst
, value
->mac
, ETH_ADDR_LEN
);
1264 flow
->dl_type
= value
->be16
;
1268 flow
->vlan_tci
= value
->be16
;
1272 flow_set_dl_vlan(flow
, value
->be16
);
1275 flow_set_vlan_vid(flow
, value
->be16
);
1278 case MFF_DL_VLAN_PCP
:
1280 flow_set_vlan_pcp(flow
, value
->u8
);
1284 flow
->nw_src
= value
->be32
;
1288 flow
->nw_dst
= value
->be32
;
1292 flow
->ipv6_src
= value
->ipv6
;
1296 flow
->ipv6_dst
= value
->ipv6
;
1299 case MFF_IPV6_LABEL
:
1300 flow
->ipv6_label
= value
->be32
& ~htonl(IPV6_LABEL_MASK
);
1304 flow
->nw_proto
= value
->u8
;
1308 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1309 flow
->nw_tos
|= value
->u8
& IP_DSCP_MASK
;
1313 flow
->nw_tos
&= ~IP_ECN_MASK
;
1314 flow
->nw_tos
|= value
->u8
& IP_ECN_MASK
;
1318 flow
->nw_ttl
= value
->u8
;
1322 flow
->nw_frag
&= value
->u8
;
1326 flow
->nw_proto
= ntohs(value
->be16
);
1330 flow
->nw_src
= value
->be32
;
1334 flow
->nw_dst
= value
->be32
;
1339 memcpy(flow
->arp_sha
, value
->mac
, ETH_ADDR_LEN
);
1344 memcpy(flow
->arp_tha
, value
->mac
, ETH_ADDR_LEN
);
1349 flow
->tp_src
= value
->be16
;
1354 flow
->tp_dst
= value
->be16
;
1357 case MFF_ICMPV4_TYPE
:
1358 case MFF_ICMPV6_TYPE
:
1359 flow
->tp_src
= htons(value
->u8
);
1362 case MFF_ICMPV4_CODE
:
1363 case MFF_ICMPV6_CODE
:
1364 flow
->tp_dst
= htons(value
->u8
);
1368 flow
->nd_target
= value
->ipv6
;
1377 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1379 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1382 mf_is_zero(const struct mf_field
*mf
, const struct flow
*flow
)
1384 union mf_value value
;
1386 mf_get_value(mf
, flow
, &value
);
1387 return is_all_zeros((const uint8_t *) &value
, mf
->n_bytes
);
1390 /* Makes 'rule' wildcard field 'mf'.
1392 * The caller is responsible for ensuring that 'rule' meets 'mf''s
1395 mf_set_wild(const struct mf_field
*mf
, struct cls_rule
*rule
)
1399 cls_rule_set_tun_id_masked(rule
, htonll(0), htonll(0));
1402 cls_rule_set_metadata_masked(rule
, htonll(0), htonll(0));
1405 rule
->flow
.in_port
= 0;
1406 rule
->wc
.in_port_mask
= 0;
1410 cls_rule_set_reg_masked(rule
, mf
->id
- MFF_REG0
, 0, 0);
1414 memset(rule
->flow
.dl_src
, 0, ETH_ADDR_LEN
);
1415 memset(rule
->wc
.dl_src_mask
, 0, ETH_ADDR_LEN
);
1419 memset(rule
->flow
.dl_dst
, 0, ETH_ADDR_LEN
);
1420 memset(rule
->wc
.dl_dst_mask
, 0, ETH_ADDR_LEN
);
1424 rule
->flow
.dl_type
= htons(0);
1425 rule
->wc
.dl_type_mask
= htons(0);
1429 cls_rule_set_dl_tci_masked(rule
, htons(0), htons(0));
1434 cls_rule_set_any_vid(rule
);
1437 case MFF_DL_VLAN_PCP
:
1439 cls_rule_set_any_pcp(rule
);
1444 cls_rule_set_nw_src_masked(rule
, htonl(0), htonl(0));
1449 cls_rule_set_nw_dst_masked(rule
, htonl(0), htonl(0));
1453 memset(&rule
->wc
.ipv6_src_mask
, 0, sizeof rule
->wc
.ipv6_src_mask
);
1454 memset(&rule
->flow
.ipv6_src
, 0, sizeof rule
->flow
.ipv6_src
);
1458 memset(&rule
->wc
.ipv6_dst_mask
, 0, sizeof rule
->wc
.ipv6_dst_mask
);
1459 memset(&rule
->flow
.ipv6_dst
, 0, sizeof rule
->flow
.ipv6_dst
);
1462 case MFF_IPV6_LABEL
:
1463 rule
->wc
.ipv6_label_mask
= 0;
1464 rule
->flow
.ipv6_label
= 0;
1468 rule
->wc
.nw_proto_mask
= 0;
1469 rule
->flow
.nw_proto
= 0;
1473 rule
->wc
.nw_tos_mask
&= ~IP_DSCP_MASK
;
1474 rule
->flow
.nw_tos
&= ~IP_DSCP_MASK
;
1478 rule
->wc
.nw_tos_mask
&= ~IP_ECN_MASK
;
1479 rule
->flow
.nw_tos
&= ~IP_ECN_MASK
;
1483 rule
->wc
.nw_ttl_mask
= 0;
1484 rule
->flow
.nw_ttl
= 0;
1488 rule
->wc
.nw_frag_mask
|= FLOW_NW_FRAG_MASK
;
1489 rule
->flow
.nw_frag
&= ~FLOW_NW_FRAG_MASK
;
1493 rule
->wc
.nw_proto_mask
= 0;
1494 rule
->flow
.nw_proto
= 0;
1499 memset(rule
->flow
.arp_sha
, 0, ETH_ADDR_LEN
);
1500 memset(rule
->wc
.arp_sha_mask
, 0, ETH_ADDR_LEN
);
1505 memset(rule
->flow
.arp_tha
, 0, ETH_ADDR_LEN
);
1506 memset(rule
->wc
.arp_tha_mask
, 0, ETH_ADDR_LEN
);
1511 case MFF_ICMPV4_TYPE
:
1512 case MFF_ICMPV6_TYPE
:
1513 rule
->wc
.tp_src_mask
= htons(0);
1514 rule
->flow
.tp_src
= htons(0);
1519 case MFF_ICMPV4_CODE
:
1520 case MFF_ICMPV6_CODE
:
1521 rule
->wc
.tp_dst_mask
= htons(0);
1522 rule
->flow
.tp_dst
= htons(0);
1526 memset(&rule
->wc
.nd_target_mask
, 0, sizeof rule
->wc
.nd_target_mask
);
1527 memset(&rule
->flow
.nd_target
, 0, sizeof rule
->flow
.nd_target
);
1536 /* Makes 'rule' match field 'mf' with the specified 'value' and 'mask'.
1537 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1538 * with a 1-bit indicating that the corresponding value bit must match and a
1539 * 0-bit indicating a don't-care.
1541 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1542 * mf_set_value(mf, value, rule). If 'mask' points to all-0-bits, then this
1543 * call is equivalent to mf_set_wild(mf, rule).
1545 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1546 * is responsible for ensuring that 'rule' meets 'mf''s prerequisites. */
1548 mf_set(const struct mf_field
*mf
,
1549 const union mf_value
*value
, const union mf_value
*mask
,
1550 struct cls_rule
*rule
)
1552 if (!mask
|| is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
1553 mf_set_value(mf
, value
, rule
);
1555 } else if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
1556 mf_set_wild(mf
, rule
);
1564 case MFF_DL_VLAN_PCP
:
1571 case MFF_ICMPV4_TYPE
:
1572 case MFF_ICMPV4_CODE
:
1573 case MFF_ICMPV6_TYPE
:
1574 case MFF_ICMPV6_CODE
:
1578 cls_rule_set_tun_id_masked(rule
, value
->be64
, mask
->be64
);
1581 cls_rule_set_metadata_masked(rule
, value
->be64
, mask
->be64
);
1585 cls_rule_set_reg_masked(rule
, mf
->id
- MFF_REG0
,
1586 ntohl(value
->be32
), ntohl(mask
->be32
));
1590 cls_rule_set_dl_dst_masked(rule
, value
->mac
, mask
->mac
);
1594 cls_rule_set_dl_src_masked(rule
, value
->mac
, mask
->mac
);
1599 cls_rule_set_arp_sha_masked(rule
, value
->mac
, mask
->mac
);
1604 cls_rule_set_arp_tha_masked(rule
, value
->mac
, mask
->mac
);
1608 cls_rule_set_dl_tci_masked(rule
, value
->be16
, mask
->be16
);
1612 cls_rule_set_vlan_vid_masked(rule
, value
->be16
, mask
->be16
);
1616 cls_rule_set_nw_src_masked(rule
, value
->be32
, mask
->be32
);
1620 cls_rule_set_nw_dst_masked(rule
, value
->be32
, mask
->be32
);
1624 cls_rule_set_ipv6_src_masked(rule
, &value
->ipv6
, &mask
->ipv6
);
1628 cls_rule_set_ipv6_dst_masked(rule
, &value
->ipv6
, &mask
->ipv6
);
1631 case MFF_IPV6_LABEL
:
1632 if ((mask
->be32
& htonl(IPV6_LABEL_MASK
)) == htonl(IPV6_LABEL_MASK
)) {
1633 mf_set_value(mf
, value
, rule
);
1635 cls_rule_set_ipv6_label_masked(rule
, value
->be32
, mask
->be32
);
1640 cls_rule_set_nd_target_masked(rule
, &value
->ipv6
, &mask
->ipv6
);
1644 cls_rule_set_nw_frag_masked(rule
, value
->u8
, mask
->u8
);
1648 cls_rule_set_nw_src_masked(rule
, value
->be32
, mask
->be32
);
1652 cls_rule_set_nw_dst_masked(rule
, value
->be32
, mask
->be32
);
1657 cls_rule_set_tp_src_masked(rule
, value
->be16
, mask
->be16
);
1662 cls_rule_set_tp_dst_masked(rule
, value
->be16
, mask
->be16
);
1672 mf_check__(const struct mf_subfield
*sf
, const struct flow
*flow
,
1676 VLOG_WARN_RL(&rl
, "unknown %s field", type
);
1677 } else if (!sf
->n_bits
) {
1678 VLOG_WARN_RL(&rl
, "zero bit %s field %s", type
, sf
->field
->name
);
1679 } else if (sf
->ofs
>= sf
->field
->n_bits
) {
1680 VLOG_WARN_RL(&rl
, "bit offset %d exceeds %d-bit width of %s field %s",
1681 sf
->ofs
, sf
->field
->n_bits
, type
, sf
->field
->name
);
1682 } else if (sf
->ofs
+ sf
->n_bits
> sf
->field
->n_bits
) {
1683 VLOG_WARN_RL(&rl
, "bit offset %d and width %d exceeds %d-bit width "
1684 "of %s field %s", sf
->ofs
, sf
->n_bits
,
1685 sf
->field
->n_bits
, type
, sf
->field
->name
);
1686 } else if (flow
&& !mf_are_prereqs_ok(sf
->field
, flow
)) {
1687 VLOG_WARN_RL(&rl
, "%s field %s lacks correct prerequisites",
1688 type
, sf
->field
->name
);
1693 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1696 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1697 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1700 mf_check_src(const struct mf_subfield
*sf
, const struct flow
*flow
)
1702 return mf_check__(sf
, flow
, "source");
1705 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1706 * if so, otherwise an OpenFlow error code (e.g. as returned by
1709 mf_check_dst(const struct mf_subfield
*sf
, const struct flow
*flow
)
1711 int error
= mf_check__(sf
, flow
, "destination");
1712 if (!error
&& !sf
->field
->writable
) {
1713 VLOG_WARN_RL(&rl
, "destination field %s is not writable",
1715 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1720 /* Copies the value and wildcard bit pattern for 'mf' from 'rule' into the
1721 * 'value' and 'mask', respectively. */
1723 mf_get(const struct mf_field
*mf
, const struct cls_rule
*rule
,
1724 union mf_value
*value
, union mf_value
*mask
)
1726 mf_get_value(mf
, &rule
->flow
, value
);
1727 mf_get_mask(mf
, &rule
->wc
, mask
);
1730 /* Assigns a random value for field 'mf' to 'value'. */
1732 mf_random_value(const struct mf_field
*mf
, union mf_value
*value
)
1734 random_bytes(value
, mf
->n_bytes
);
1759 case MFF_ICMPV4_TYPE
:
1760 case MFF_ICMPV4_CODE
:
1761 case MFF_ICMPV6_TYPE
:
1762 case MFF_ICMPV6_CODE
:
1768 case MFF_IPV6_LABEL
:
1769 value
->be32
&= ~htonl(IPV6_LABEL_MASK
);
1773 value
->u8
&= IP_DSCP_MASK
;
1777 value
->u8
&= IP_ECN_MASK
;
1781 value
->u8
&= FLOW_NW_FRAG_MASK
;
1785 value
->be16
&= htons(0xff);
1789 value
->be16
&= htons(VLAN_VID_MASK
);
1792 value
->be16
&= htons(VLAN_VID_MASK
| VLAN_CFI
);
1795 case MFF_DL_VLAN_PCP
:
1807 mf_from_integer_string(const struct mf_field
*mf
, const char *s
,
1808 uint8_t *valuep
, uint8_t *maskp
)
1810 unsigned long long int integer
, mask
;
1815 integer
= strtoull(s
, &tail
, 0);
1816 if (errno
|| (*tail
!= '\0' && *tail
!= '/')) {
1821 mask
= strtoull(tail
+ 1, &tail
, 0);
1822 if (errno
|| *tail
!= '\0') {
1829 for (i
= mf
->n_bytes
- 1; i
>= 0; i
--) {
1830 valuep
[i
] = integer
;
1836 return xasprintf("%s: value too large for %u-byte field %s",
1837 s
, mf
->n_bytes
, mf
->name
);
1842 return xasprintf("%s: bad syntax for %s", s
, mf
->name
);
1846 mf_from_ethernet_string(const struct mf_field
*mf
, const char *s
,
1847 uint8_t mac
[ETH_ADDR_LEN
],
1848 uint8_t mask
[ETH_ADDR_LEN
])
1850 assert(mf
->n_bytes
== ETH_ADDR_LEN
);
1852 switch (sscanf(s
, ETH_ADDR_SCAN_FMT
"/"ETH_ADDR_SCAN_FMT
,
1853 ETH_ADDR_SCAN_ARGS(mac
), ETH_ADDR_SCAN_ARGS(mask
))){
1854 case ETH_ADDR_SCAN_COUNT
* 2:
1857 case ETH_ADDR_SCAN_COUNT
:
1858 memset(mask
, 0xff, ETH_ADDR_LEN
);
1862 return xasprintf("%s: invalid Ethernet address", s
);
1867 mf_from_ipv4_string(const struct mf_field
*mf
, const char *s
,
1868 ovs_be32
*ip
, ovs_be32
*mask
)
1872 assert(mf
->n_bytes
== sizeof *ip
);
1874 if (sscanf(s
, IP_SCAN_FMT
"/"IP_SCAN_FMT
,
1875 IP_SCAN_ARGS(ip
), IP_SCAN_ARGS(mask
)) == IP_SCAN_COUNT
* 2) {
1877 } else if (sscanf(s
, IP_SCAN_FMT
"/%d",
1878 IP_SCAN_ARGS(ip
), &prefix
) == IP_SCAN_COUNT
+ 1) {
1879 if (prefix
<= 0 || prefix
> 32) {
1880 return xasprintf("%s: network prefix bits not between 1 and "
1882 } else if (prefix
== 32) {
1883 *mask
= htonl(UINT32_MAX
);
1885 *mask
= htonl(((1u << prefix
) - 1) << (32 - prefix
));
1887 } else if (sscanf(s
, IP_SCAN_FMT
, IP_SCAN_ARGS(ip
)) == IP_SCAN_COUNT
) {
1888 *mask
= htonl(UINT32_MAX
);
1890 return xasprintf("%s: invalid IP address", s
);
1896 mf_from_ipv6_string(const struct mf_field
*mf
, const char *s
,
1897 struct in6_addr
*value
, struct in6_addr
*mask
)
1899 char *str
= xstrdup(s
);
1900 char *save_ptr
= NULL
;
1901 const char *name
, *netmask
;
1904 assert(mf
->n_bytes
== sizeof *value
);
1906 name
= strtok_r(str
, "/", &save_ptr
);
1907 retval
= name
? lookup_ipv6(name
, value
) : EINVAL
;
1911 err
= xasprintf("%s: could not convert to IPv6 address", str
);
1917 netmask
= strtok_r(NULL
, "/", &save_ptr
);
1919 if (inet_pton(AF_INET6
, netmask
, mask
) != 1) {
1920 int prefix
= atoi(netmask
);
1921 if (prefix
<= 0 || prefix
> 128) {
1923 return xasprintf("%s: prefix bits not between 1 and 128", s
);
1925 *mask
= ipv6_create_mask(prefix
);
1929 *mask
= in6addr_exact
;
1937 mf_from_ofp_port_string(const struct mf_field
*mf
, const char *s
,
1938 ovs_be16
*valuep
, ovs_be16
*maskp
)
1942 assert(mf
->n_bytes
== sizeof(ovs_be16
));
1943 if (ofputil_port_from_string(s
, &port
)) {
1944 *valuep
= htons(port
);
1945 *maskp
= htons(UINT16_MAX
);
1948 return mf_from_integer_string(mf
, s
,
1949 (uint8_t *) valuep
, (uint8_t *) maskp
);
1953 struct frag_handling
{
1959 static const struct frag_handling all_frags
[] = {
1960 #define A FLOW_NW_FRAG_ANY
1961 #define L FLOW_NW_FRAG_LATER
1962 /* name mask value */
1965 { "first", A
|L
, A
},
1966 { "later", A
|L
, A
|L
},
1971 { "not_later", L
, 0 },
1978 mf_from_frag_string(const char *s
, uint8_t *valuep
, uint8_t *maskp
)
1980 const struct frag_handling
*h
;
1982 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
1983 if (!strcasecmp(s
, h
->name
)) {
1984 /* We force the upper bits of the mask on to make mf_parse_value()
1985 * happy (otherwise it will never think it's an exact match.) */
1986 *maskp
= h
->mask
| ~FLOW_NW_FRAG_MASK
;
1992 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
1993 "\"yes\", \"first\", \"later\", \"not_first\"", s
);
1996 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
1997 * NULL if successful, otherwise a malloc()'d string describing the error. */
1999 mf_parse(const struct mf_field
*mf
, const char *s
,
2000 union mf_value
*value
, union mf_value
*mask
)
2002 if (!strcasecmp(s
, "any") || !strcmp(s
, "*")) {
2003 memset(value
, 0, mf
->n_bytes
);
2004 memset(mask
, 0, mf
->n_bytes
);
2008 switch (mf
->string
) {
2010 case MFS_HEXADECIMAL
:
2011 return mf_from_integer_string(mf
, s
,
2012 (uint8_t *) value
, (uint8_t *) mask
);
2015 return mf_from_ethernet_string(mf
, s
, value
->mac
, mask
->mac
);
2018 return mf_from_ipv4_string(mf
, s
, &value
->be32
, &mask
->be32
);
2021 return mf_from_ipv6_string(mf
, s
, &value
->ipv6
, &mask
->ipv6
);
2024 return mf_from_ofp_port_string(mf
, s
, &value
->be16
, &mask
->be16
);
2027 return mf_from_frag_string(s
, &value
->u8
, &mask
->u8
);
2032 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2033 * successful, otherwise a malloc()'d string describing the error. */
2035 mf_parse_value(const struct mf_field
*mf
, const char *s
, union mf_value
*value
)
2037 union mf_value mask
;
2040 error
= mf_parse(mf
, s
, value
, &mask
);
2045 if (!is_all_ones((const uint8_t *) &mask
, mf
->n_bytes
)) {
2046 return xasprintf("%s: wildcards not allowed here", s
);
2052 mf_format_integer_string(const struct mf_field
*mf
, const uint8_t *valuep
,
2053 const uint8_t *maskp
, struct ds
*s
)
2055 unsigned long long int integer
;
2058 assert(mf
->n_bytes
<= 8);
2061 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2062 integer
= (integer
<< 8) | valuep
[i
];
2064 if (mf
->string
== MFS_HEXADECIMAL
) {
2065 ds_put_format(s
, "%#llx", integer
);
2067 ds_put_format(s
, "%lld", integer
);
2071 unsigned long long int mask
;
2074 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2075 mask
= (mask
<< 8) | maskp
[i
];
2078 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2079 * not sure that that a bit-mask written in decimal is ever easier to
2080 * understand than the same bit-mask written in hexadecimal. */
2081 ds_put_format(s
, "/%#llx", mask
);
2086 mf_format_frag_string(const uint8_t *valuep
, const uint8_t *maskp
,
2089 const struct frag_handling
*h
;
2090 uint8_t value
= *valuep
;
2091 uint8_t mask
= *maskp
;
2094 mask
&= FLOW_NW_FRAG_MASK
;
2096 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2097 if (value
== h
->value
&& mask
== h
->mask
) {
2098 ds_put_cstr(s
, h
->name
);
2102 ds_put_cstr(s
, "<error>");
2105 /* Appends to 's' a string representation of field 'mf' whose value is in
2106 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2108 mf_format(const struct mf_field
*mf
,
2109 const union mf_value
*value
, const union mf_value
*mask
,
2113 if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
2114 ds_put_cstr(s
, "ANY");
2116 } else if (is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
2121 switch (mf
->string
) {
2124 ofputil_format_port(ntohs(value
->be16
), s
);
2129 case MFS_HEXADECIMAL
:
2130 mf_format_integer_string(mf
, (uint8_t *) value
, (uint8_t *) mask
, s
);
2134 eth_format_masked(value
->mac
, mask
->mac
, s
);
2138 ip_format_masked(value
->be32
, mask
? mask
->be32
: htonl(UINT32_MAX
),
2143 print_ipv6_masked(s
, &value
->ipv6
, mask
? &mask
->ipv6
: NULL
);
2147 mf_format_frag_string(&value
->u8
, &mask
->u8
, s
);
2155 /* Makes subfield 'sf' within 'rule' exactly match the 'sf->n_bits'
2156 * least-significant bits in 'x'.
2159 mf_write_subfield(const struct mf_subfield
*sf
, const union mf_subvalue
*x
,
2160 struct cls_rule
*rule
)
2162 const struct mf_field
*field
= sf
->field
;
2163 union mf_value value
, mask
;
2165 mf_get(field
, rule
, &value
, &mask
);
2166 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2167 bitwise_one ( &mask
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2168 mf_set(field
, &value
, &mask
, rule
);
2171 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2172 * reading 'flow', e.g. as checked by mf_check_src(). */
2174 mf_read_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
,
2175 union mf_subvalue
*x
)
2177 union mf_value value
;
2179 mf_get_value(sf
->field
, flow
, &value
);
2181 memset(x
, 0, sizeof *x
);
2182 bitwise_copy(&value
, sf
->field
->n_bytes
, sf
->ofs
,
2187 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2188 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2191 mf_get_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
)
2193 union mf_value value
;
2195 mf_get_value(sf
->field
, flow
, &value
);
2196 return bitwise_get(&value
, sf
->field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2199 /* Formats 'sf' into 's' in a format normally acceptable to
2200 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2201 * sf->field has no NXM name.) */
2203 mf_format_subfield(const struct mf_subfield
*sf
, struct ds
*s
)
2206 ds_put_cstr(s
, "<unknown>");
2207 } else if (sf
->field
->nxm_name
) {
2208 ds_put_cstr(s
, sf
->field
->nxm_name
);
2209 } else if (sf
->field
->nxm_header
) {
2210 uint32_t header
= sf
->field
->nxm_header
;
2211 ds_put_format(s
, "%d:%d", NXM_VENDOR(header
), NXM_FIELD(header
));
2213 ds_put_cstr(s
, sf
->field
->name
);
2216 if (sf
->field
&& sf
->ofs
== 0 && sf
->n_bits
== sf
->field
->n_bits
) {
2217 ds_put_cstr(s
, "[]");
2218 } else if (sf
->n_bits
== 1) {
2219 ds_put_format(s
, "[%d]", sf
->ofs
);
2221 ds_put_format(s
, "[%d..%d]", sf
->ofs
, sf
->ofs
+ sf
->n_bits
- 1);
2225 static const struct mf_field
*
2226 mf_parse_subfield_name(const char *name
, int name_len
, bool *wild
)
2230 *wild
= name_len
> 2 && !memcmp(&name
[name_len
- 2], "_W", 2);
2235 for (i
= 0; i
< MFF_N_IDS
; i
++) {
2236 const struct mf_field
*mf
= mf_from_id(i
);
2239 && !strncmp(mf
->nxm_name
, name
, name_len
)
2240 && mf
->nxm_name
[name_len
] == '\0') {
2244 && !strncmp(mf
->oxm_name
, name
, name_len
)
2245 && mf
->oxm_name
[name_len
] == '\0') {
2253 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2254 * returns NULL and advances '*sp' to the first byte following the parsed
2255 * string. On failure, returns a malloc()'d error message, does not modify
2256 * '*sp', and does not properly initialize 'sf'.
2258 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2259 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2260 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2261 * may both be omitted (the [] are still required) to indicate an entire
2264 mf_parse_subfield__(struct mf_subfield
*sf
, const char **sp
)
2266 const struct mf_field
*field
;
2275 name_len
= strcspn(s
, "[");
2276 if (s
[name_len
] != '[') {
2277 return xasprintf("%s: missing [ looking for field name", *sp
);
2280 field
= mf_parse_subfield_name(name
, name_len
, &wild
);
2282 return xasprintf("%s: unknown field `%.*s'", *sp
, name_len
, s
);
2286 if (sscanf(s
, "[%d..%d]", &start
, &end
) == 2) {
2287 /* Nothing to do. */
2288 } else if (sscanf(s
, "[%d]", &start
) == 1) {
2290 } else if (!strncmp(s
, "[]", 2)) {
2292 end
= field
->n_bits
- 1;
2294 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2295 "[<start>..<end>]", *sp
);
2297 s
= strchr(s
, ']') + 1;
2300 return xasprintf("%s: starting bit %d is after ending bit %d",
2302 } else if (start
>= field
->n_bits
) {
2303 return xasprintf("%s: starting bit %d is not valid because field is "
2304 "only %d bits wide", *sp
, start
, field
->n_bits
);
2305 } else if (end
>= field
->n_bits
){
2306 return xasprintf("%s: ending bit %d is not valid because field is "
2307 "only %d bits wide", *sp
, end
, field
->n_bits
);
2312 sf
->n_bits
= end
- start
+ 1;
2318 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2319 * byte in 's' following the parsed string.
2321 * Exits with an error message if 's' has incorrect syntax.
2323 * The syntax parsed from 's' takes the form "header[start..end]" where
2324 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2325 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2326 * may both be omitted (the [] are still required) to indicate an entire
2329 mf_parse_subfield(struct mf_subfield
*sf
, const char *s
)
2331 char *msg
= mf_parse_subfield__(sf
, &s
);
2333 ovs_fatal(0, "%s", msg
);