2 * Copyright (c) 2011, 2012, 2013 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"
23 #include <netinet/icmp6.h>
24 #include <netinet/ip6.h>
26 #include "classifier.h"
27 #include "dynamic-string.h"
28 #include "ofp-errors.h"
33 #include "socket-util.h"
34 #include "unaligned.h"
37 VLOG_DEFINE_THIS_MODULE(meta_flow
);
39 #define MF_FIELD_SIZES(MEMBER) \
40 sizeof ((union mf_value *)0)->MEMBER, \
41 8 * sizeof ((union mf_value *)0)->MEMBER
43 static const struct mf_field mf_fields
[MFF_N_IDS
] = {
49 MFF_TUN_ID
, "tun_id", NULL
,
55 NXM_NX_TUN_ID
, "NXM_NX_TUN_ID",
56 OXM_OF_TUNNEL_ID
, "OXM_OF_TUNNEL_ID",
58 MFF_TUN_SRC
, "tun_src", NULL
,
64 NXM_NX_TUN_IPV4_SRC
, "NXM_NX_TUN_IPV4_SRC",
65 NXM_NX_TUN_IPV4_SRC
, "NXM_NX_TUN_IPV4_SRC",
67 MFF_TUN_DST
, "tun_dst", NULL
,
73 NXM_NX_TUN_IPV4_DST
, "NXM_NX_TUN_IPV4_DST",
74 NXM_NX_TUN_IPV4_DST
, "NXM_NX_TUN_IPV4_DST",
76 MFF_TUN_FLAGS
, "tun_flags", NULL
,
85 MFF_TUN_TOS
, "tun_tos", NULL
,
94 MFF_TUN_TTL
, "tun_ttl", NULL
,
103 MFF_METADATA
, "metadata", NULL
,
104 MF_FIELD_SIZES(be64
),
109 OXM_OF_METADATA
, "OXM_OF_METADATA",
110 OXM_OF_METADATA
, "OXM_OF_METADATA",
112 MFF_IN_PORT
, "in_port", NULL
,
113 MF_FIELD_SIZES(be16
),
118 NXM_OF_IN_PORT
, "NXM_OF_IN_PORT",
119 NXM_OF_IN_PORT
, "NXM_OF_IN_PORT",
121 MFF_IN_PORT_OXM
, "in_port_oxm", NULL
,
122 MF_FIELD_SIZES(be32
),
127 OXM_OF_IN_PORT
, "OXM_OF_IN_PORT",
128 OXM_OF_IN_PORT
, "OXM_OF_IN_PORT",
130 MFF_SKB_PRIORITY
, "skb_priority", NULL
,
131 MF_FIELD_SIZES(be32
),
139 MFF_SKB_MARK
, "skb_mark", NULL
,
140 MF_FIELD_SIZES(be32
),
149 #define REGISTER(IDX) \
151 MFF_REG##IDX, "reg" #IDX, NULL, \
152 MF_FIELD_SIZES(be32), \
157 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
158 NXM_NX_REG(IDX), "NXM_NX_REG" #IDX, \
193 MFF_ETH_SRC
, "eth_src", "dl_src",
199 NXM_OF_ETH_SRC
, "NXM_OF_ETH_SRC",
200 OXM_OF_ETH_SRC
, "OXM_OF_ETH_SRC",
202 MFF_ETH_DST
, "eth_dst", "dl_dst",
208 NXM_OF_ETH_DST
, "NXM_OF_ETH_DST",
209 OXM_OF_ETH_DST
, "OXM_OF_ETH_DST",
211 MFF_ETH_TYPE
, "eth_type", "dl_type",
212 MF_FIELD_SIZES(be16
),
217 NXM_OF_ETH_TYPE
, "NXM_OF_ETH_TYPE",
218 OXM_OF_ETH_TYPE
, "OXM_OF_ETH_TYPE",
222 MFF_VLAN_TCI
, "vlan_tci", NULL
,
223 MF_FIELD_SIZES(be16
),
228 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
229 NXM_OF_VLAN_TCI
, "NXM_OF_VLAN_TCI",
231 MFF_DL_VLAN
, "dl_vlan", NULL
,
232 sizeof(ovs_be16
), 12,
240 MFF_VLAN_VID
, "vlan_vid", NULL
,
241 sizeof(ovs_be16
), 12,
246 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
247 OXM_OF_VLAN_VID
, "OXM_OF_VLAN_VID",
249 MFF_DL_VLAN_PCP
, "dl_vlan_pcp", NULL
,
258 MFF_VLAN_PCP
, "vlan_pcp", NULL
,
264 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
265 OXM_OF_VLAN_PCP
, "OXM_OF_VLAN_PCP",
272 MFF_MPLS_LABEL
, "mpls_label", NULL
,
278 OXM_OF_MPLS_LABEL
, "OXM_OF_MPLS_LABEL",
279 OXM_OF_MPLS_LABEL
, "OXM_OF_MPLS_LABEL",
281 MFF_MPLS_TC
, "mpls_tc", NULL
,
287 OXM_OF_MPLS_TC
, "OXM_OF_MPLS_TC",
288 OXM_OF_MPLS_TC
, "OXM_OF_MPLS_TC",
290 MFF_MPLS_BOS
, "mpls_bos", NULL
,
296 OXM_OF_MPLS_BOS
, "OXM_OF_MPLS_BOS",
297 OXM_OF_MPLS_BOS
, "OXM_OF_MPLS_BOS",
305 MFF_IPV4_SRC
, "ip_src", "nw_src",
306 MF_FIELD_SIZES(be32
),
311 NXM_OF_IP_SRC
, "NXM_OF_IP_SRC",
312 OXM_OF_IPV4_SRC
, "OXM_OF_IPV4_SRC",
314 MFF_IPV4_DST
, "ip_dst", "nw_dst",
315 MF_FIELD_SIZES(be32
),
320 NXM_OF_IP_DST
, "NXM_OF_IP_DST",
321 OXM_OF_IPV4_DST
, "OXM_OF_IPV4_DST",
325 MFF_IPV6_SRC
, "ipv6_src", NULL
,
326 MF_FIELD_SIZES(ipv6
),
331 NXM_NX_IPV6_SRC
, "NXM_NX_IPV6_SRC",
332 OXM_OF_IPV6_SRC
, "OXM_OF_IPV6_SRC",
334 MFF_IPV6_DST
, "ipv6_dst", NULL
,
335 MF_FIELD_SIZES(ipv6
),
340 NXM_NX_IPV6_DST
, "NXM_NX_IPV6_DST",
341 OXM_OF_IPV6_DST
, "OXM_OF_IPV6_DST",
344 MFF_IPV6_LABEL
, "ipv6_label", NULL
,
350 NXM_NX_IPV6_LABEL
, "NXM_NX_IPV6_LABEL",
351 OXM_OF_IPV6_FLABEL
, "OXM_OF_IPV6_FLABEL",
355 MFF_IP_PROTO
, "nw_proto", NULL
,
361 NXM_OF_IP_PROTO
, "NXM_OF_IP_PROTO",
362 OXM_OF_IP_PROTO
, "OXM_OF_IP_PROTO",
364 MFF_IP_DSCP
, "nw_tos", NULL
,
370 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS",
371 NXM_OF_IP_TOS
, "NXM_OF_IP_TOS",
373 MFF_IP_DSCP_SHIFTED
, "nw_tos_shifted", NULL
,
379 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP",
380 OXM_OF_IP_DSCP
, "OXM_OF_IP_DSCP",
382 MFF_IP_ECN
, "nw_ecn", NULL
,
388 NXM_NX_IP_ECN
, "NXM_NX_IP_ECN",
389 OXM_OF_IP_ECN
, "OXM_OF_IP_ECN",
391 MFF_IP_TTL
, "nw_ttl", NULL
,
397 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
398 NXM_NX_IP_TTL
, "NXM_NX_IP_TTL",
400 MFF_IP_FRAG
, "ip_frag", NULL
,
406 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
407 NXM_NX_IP_FRAG
, "NXM_NX_IP_FRAG",
411 MFF_ARP_OP
, "arp_op", NULL
,
412 MF_FIELD_SIZES(be16
),
417 NXM_OF_ARP_OP
, "NXM_OF_ARP_OP",
418 OXM_OF_ARP_OP
, "OXM_OF_ARP_OP",
420 MFF_ARP_SPA
, "arp_spa", NULL
,
421 MF_FIELD_SIZES(be32
),
426 NXM_OF_ARP_SPA
, "NXM_OF_ARP_SPA",
427 OXM_OF_ARP_SPA
, "OXM_OF_ARP_SPA",
429 MFF_ARP_TPA
, "arp_tpa", NULL
,
430 MF_FIELD_SIZES(be32
),
435 NXM_OF_ARP_TPA
, "NXM_OF_ARP_TPA",
436 OXM_OF_ARP_TPA
, "OXM_OF_ARP_TPA",
438 MFF_ARP_SHA
, "arp_sha", NULL
,
444 NXM_NX_ARP_SHA
, "NXM_NX_ARP_SHA",
445 OXM_OF_ARP_SHA
, "OXM_OF_ARP_SHA",
447 MFF_ARP_THA
, "arp_tha", NULL
,
453 NXM_NX_ARP_THA
, "NXM_NX_ARP_THA",
454 OXM_OF_ARP_THA
, "OXM_OF_ARP_THA",
462 MFF_TCP_SRC
, "tcp_src", "tp_src",
463 MF_FIELD_SIZES(be16
),
468 NXM_OF_TCP_SRC
, "NXM_OF_TCP_SRC",
469 OXM_OF_TCP_SRC
, "OXM_OF_TCP_SRC",
471 MFF_TCP_DST
, "tcp_dst", "tp_dst",
472 MF_FIELD_SIZES(be16
),
477 NXM_OF_TCP_DST
, "NXM_OF_TCP_DST",
478 OXM_OF_TCP_DST
, "OXM_OF_TCP_DST",
482 MFF_UDP_SRC
, "udp_src", NULL
,
483 MF_FIELD_SIZES(be16
),
488 NXM_OF_UDP_SRC
, "NXM_OF_UDP_SRC",
489 OXM_OF_UDP_SRC
, "OXM_OF_UDP_SRC",
491 MFF_UDP_DST
, "udp_dst", NULL
,
492 MF_FIELD_SIZES(be16
),
497 NXM_OF_UDP_DST
, "NXM_OF_UDP_DST",
498 OXM_OF_UDP_DST
, "OXM_OF_UDP_DST",
502 MFF_ICMPV4_TYPE
, "icmp_type", NULL
,
508 NXM_OF_ICMP_TYPE
, "NXM_OF_ICMP_TYPE",
509 OXM_OF_ICMPV4_TYPE
, "OXM_OF_ICMPV4_TYPE",
511 MFF_ICMPV4_CODE
, "icmp_code", NULL
,
517 NXM_OF_ICMP_CODE
, "NXM_OF_ICMP_CODE",
518 OXM_OF_ICMPV4_CODE
, "OXM_OF_ICMPV4_CODE",
522 MFF_ICMPV6_TYPE
, "icmpv6_type", NULL
,
528 NXM_NX_ICMPV6_TYPE
, "NXM_NX_ICMPV6_TYPE",
529 OXM_OF_ICMPV6_TYPE
, "OXM_OF_ICMPV6_TYPE",
531 MFF_ICMPV6_CODE
, "icmpv6_code", NULL
,
537 NXM_NX_ICMPV6_CODE
, "NXM_NX_ICMPV6_CODE",
538 OXM_OF_ICMPV6_CODE
, "OXM_OF_ICMPV6_CODE",
546 MFF_ND_TARGET
, "nd_target", NULL
,
547 MF_FIELD_SIZES(ipv6
),
552 NXM_NX_ND_TARGET
, "NXM_NX_ND_TARGET",
553 OXM_OF_IPV6_ND_TARGET
, "OXM_OF_IPV6_ND_TARGET",
555 MFF_ND_SLL
, "nd_sll", NULL
,
561 NXM_NX_ND_SLL
, "NXM_NX_ND_SLL",
562 OXM_OF_IPV6_ND_SLL
, "OXM_OF_IPV6_ND_SLL",
564 MFF_ND_TLL
, "nd_tll", NULL
,
570 NXM_NX_ND_TLL
, "NXM_NX_ND_TLL",
571 OXM_OF_IPV6_ND_TLL
, "OXM_OF_IPV6_ND_TLL",
575 /* Maps an NXM or OXM header value to an mf_field. */
577 struct hmap_node hmap_node
; /* In 'all_fields' hmap. */
578 uint32_t header
; /* NXM or OXM header value. */
579 const struct mf_field
*mf
;
582 /* Contains 'struct nxm_field's. */
583 static struct hmap all_fields
= HMAP_INITIALIZER(&all_fields
);
585 /* Rate limit for parse errors. These always indicate a bug in an OpenFlow
586 * controller and so there's not much point in showing a lot of them. */
587 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
589 const struct mf_field
*mf_from_nxm_header__(uint32_t header
);
591 /* Returns the field with the given 'id'. */
592 const struct mf_field
*
593 mf_from_id(enum mf_field_id id
)
595 ovs_assert((unsigned int) id
< MFF_N_IDS
);
596 return &mf_fields
[id
];
599 /* Returns the field with the given 'name', or a null pointer if no field has
601 const struct mf_field
*
602 mf_from_name(const char *name
)
604 static struct shash mf_by_name
= SHASH_INITIALIZER(&mf_by_name
);
606 if (shash_is_empty(&mf_by_name
)) {
607 const struct mf_field
*mf
;
609 for (mf
= mf_fields
; mf
< &mf_fields
[MFF_N_IDS
]; mf
++) {
610 shash_add_once(&mf_by_name
, mf
->name
, mf
);
611 if (mf
->extra_name
) {
612 shash_add_once(&mf_by_name
, mf
->extra_name
, mf
);
617 return shash_find_data(&mf_by_name
, name
);
621 add_nxm_field(uint32_t header
, const struct mf_field
*mf
)
625 f
= xmalloc(sizeof *f
);
626 hmap_insert(&all_fields
, &f
->hmap_node
, hash_int(header
, 0));
632 nxm_init_add_field(const struct mf_field
*mf
, uint32_t header
)
635 ovs_assert(!mf_from_nxm_header__(header
));
636 add_nxm_field(header
, mf
);
637 if (mf
->maskable
!= MFM_NONE
) {
638 add_nxm_field(NXM_MAKE_WILD_HEADER(header
), mf
);
646 const struct mf_field
*mf
;
648 for (mf
= mf_fields
; mf
< &mf_fields
[MFF_N_IDS
]; mf
++) {
649 nxm_init_add_field(mf
, mf
->nxm_header
);
650 if (mf
->oxm_header
!= mf
->nxm_header
) {
651 nxm_init_add_field(mf
, mf
->oxm_header
);
656 const struct mf_field
*
657 mf_from_nxm_header(uint32_t header
)
659 if (hmap_is_empty(&all_fields
)) {
662 return mf_from_nxm_header__(header
);
665 const struct mf_field
*
666 mf_from_nxm_header__(uint32_t header
)
668 const struct nxm_field
*f
;
670 HMAP_FOR_EACH_IN_BUCKET (f
, hmap_node
, hash_int(header
, 0), &all_fields
) {
671 if (f
->header
== header
) {
679 /* Returns true if 'wc' wildcards all the bits in field 'mf', false if 'wc'
680 * specifies at least one bit in the field.
682 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
683 * meets 'mf''s prerequisites. */
685 mf_is_all_wild(const struct mf_field
*mf
, const struct flow_wildcards
*wc
)
689 return !wc
->masks
.tunnel
.ip_src
;
691 return !wc
->masks
.tunnel
.ip_dst
;
696 return !wc
->masks
.tunnel
.tun_id
;
698 return !wc
->masks
.metadata
;
700 case MFF_IN_PORT_OXM
:
701 return !wc
->masks
.in_port
.ofp_port
;
702 case MFF_SKB_PRIORITY
:
703 return !wc
->masks
.skb_priority
;
705 return !wc
->masks
.skb_mark
;
707 return !wc
->masks
.regs
[mf
->id
- MFF_REG0
];
710 return eth_addr_is_zero(wc
->masks
.dl_src
);
712 return eth_addr_is_zero(wc
->masks
.dl_dst
);
714 return !wc
->masks
.dl_type
;
718 return eth_addr_is_zero(wc
->masks
.arp_sha
);
722 return eth_addr_is_zero(wc
->masks
.arp_tha
);
725 return !wc
->masks
.vlan_tci
;
727 return !(wc
->masks
.vlan_tci
& htons(VLAN_VID_MASK
));
729 return !(wc
->masks
.vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
));
730 case MFF_DL_VLAN_PCP
:
732 return !(wc
->masks
.vlan_tci
& htons(VLAN_PCP_MASK
));
735 return !(wc
->masks
.mpls_lse
& htonl(MPLS_LABEL_MASK
));
737 return !(wc
->masks
.mpls_lse
& htonl(MPLS_TC_MASK
));
739 return !(wc
->masks
.mpls_lse
& htonl(MPLS_BOS_MASK
));
742 return !wc
->masks
.nw_src
;
744 return !wc
->masks
.nw_dst
;
747 return ipv6_mask_is_any(&wc
->masks
.ipv6_src
);
749 return ipv6_mask_is_any(&wc
->masks
.ipv6_dst
);
752 return !wc
->masks
.ipv6_label
;
755 return !wc
->masks
.nw_proto
;
757 case MFF_IP_DSCP_SHIFTED
:
758 return !(wc
->masks
.nw_tos
& IP_DSCP_MASK
);
760 return !(wc
->masks
.nw_tos
& IP_ECN_MASK
);
762 return !wc
->masks
.nw_ttl
;
765 return ipv6_mask_is_any(&wc
->masks
.nd_target
);
768 return !(wc
->masks
.nw_frag
& FLOW_NW_FRAG_MASK
);
771 return !wc
->masks
.nw_proto
;
773 return !wc
->masks
.nw_src
;
775 return !wc
->masks
.nw_dst
;
779 case MFF_ICMPV4_TYPE
:
780 case MFF_ICMPV6_TYPE
:
781 return !wc
->masks
.tp_src
;
784 case MFF_ICMPV4_CODE
:
785 case MFF_ICMPV6_CODE
:
786 return !wc
->masks
.tp_dst
;
794 /* Initializes 'mask' with the wildcard bit pattern for field 'mf' within 'wc'.
795 * Each bit in 'mask' will be set to 1 if the bit is significant for matching
796 * purposes, or to 0 if it is wildcarded.
798 * The caller is responsible for ensuring that 'wc' corresponds to a flow that
799 * meets 'mf''s prerequisites. */
801 mf_get_mask(const struct mf_field
*mf
, const struct flow_wildcards
*wc
,
802 union mf_value
*mask
)
804 mf_get_value(mf
, &wc
->masks
, mask
);
807 /* Tests whether 'mask' is a valid wildcard bit pattern for 'mf'. Returns true
808 * if the mask is valid, false otherwise. */
810 mf_is_mask_valid(const struct mf_field
*mf
, const union mf_value
*mask
)
812 switch (mf
->maskable
) {
814 return (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
) ||
815 is_all_ones((const uint8_t *) mask
, mf
->n_bytes
));
825 is_icmpv4(const struct flow
*flow
)
827 return (flow
->dl_type
== htons(ETH_TYPE_IP
)
828 && flow
->nw_proto
== IPPROTO_ICMP
);
832 is_icmpv6(const struct flow
*flow
)
834 return (flow
->dl_type
== htons(ETH_TYPE_IPV6
)
835 && flow
->nw_proto
== IPPROTO_ICMPV6
);
838 /* Returns true if 'flow' meets the prerequisites for 'mf', false otherwise. */
840 mf_are_prereqs_ok(const struct mf_field
*mf
, const struct flow
*flow
)
842 switch (mf
->prereqs
) {
847 return (flow
->dl_type
== htons(ETH_TYPE_ARP
) ||
848 flow
->dl_type
== htons(ETH_TYPE_RARP
));
850 return flow
->dl_type
== htons(ETH_TYPE_IP
);
852 return flow
->dl_type
== htons(ETH_TYPE_IPV6
);
854 return (flow
->vlan_tci
& htons(VLAN_CFI
)) != 0;
856 return eth_type_mpls(flow
->dl_type
);
858 return is_ip_any(flow
);
861 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_TCP
;
863 return is_ip_any(flow
) && flow
->nw_proto
== IPPROTO_UDP
;
865 return is_icmpv4(flow
);
867 return is_icmpv6(flow
);
870 return (is_icmpv6(flow
)
871 && flow
->tp_dst
== htons(0)
872 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
) ||
873 flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
875 return (is_icmpv6(flow
)
876 && flow
->tp_dst
== htons(0)
877 && (flow
->tp_src
== htons(ND_NEIGHBOR_SOLICIT
)));
879 return (is_icmpv6(flow
)
880 && flow
->tp_dst
== htons(0)
881 && (flow
->tp_src
== htons(ND_NEIGHBOR_ADVERT
)));
887 /* Returns true if 'value' may be a valid value *as part of a masked match*,
890 * A value is not rejected just because it is not valid for the field in
891 * question, but only if it doesn't make sense to test the bits in question at
892 * all. For example, the MFF_VLAN_TCI field will never have a nonzero value
893 * without the VLAN_CFI bit being set, but we can't reject those values because
894 * it is still legitimate to test just for those bits (see the documentation
895 * for NXM_OF_VLAN_TCI in nicira-ext.h). On the other hand, there is never a
896 * reason to set the low bit of MFF_IP_DSCP to 1, so we reject that. */
898 mf_is_value_valid(const struct mf_field
*mf
, const union mf_value
*value
)
909 case MFF_SKB_PRIORITY
:
930 case MFF_ICMPV4_TYPE
:
931 case MFF_ICMPV4_CODE
:
932 case MFF_ICMPV6_TYPE
:
933 case MFF_ICMPV6_CODE
:
939 case MFF_IN_PORT_OXM
: {
941 return !ofputil_port_from_ofp11(value
->be32
, &port
);
945 return !(value
->u8
& ~IP_DSCP_MASK
);
946 case MFF_IP_DSCP_SHIFTED
:
947 return !(value
->u8
& (~IP_DSCP_MASK
>> 2));
949 return !(value
->u8
& ~IP_ECN_MASK
);
951 return !(value
->u8
& ~FLOW_NW_FRAG_MASK
);
954 return !(value
->be16
& htons(0xff00));
957 return !(value
->be16
& htons(VLAN_CFI
| VLAN_PCP_MASK
));
959 return !(value
->be16
& htons(VLAN_PCP_MASK
));
961 case MFF_DL_VLAN_PCP
:
963 return !(value
->u8
& ~(VLAN_PCP_MASK
>> VLAN_PCP_SHIFT
));
966 return !(value
->be32
& ~htonl(IPV6_LABEL_MASK
));
969 return !(value
->be32
& ~htonl(MPLS_LABEL_MASK
>> MPLS_LABEL_SHIFT
));
972 return !(value
->u8
& ~(MPLS_TC_MASK
>> MPLS_TC_SHIFT
));
975 return !(value
->u8
& ~(MPLS_BOS_MASK
>> MPLS_BOS_SHIFT
));
983 /* Copies the value of field 'mf' from 'flow' into 'value'. The caller is
984 * responsible for ensuring that 'flow' meets 'mf''s prerequisites. */
986 mf_get_value(const struct mf_field
*mf
, const struct flow
*flow
,
987 union mf_value
*value
)
991 value
->be64
= flow
->tunnel
.tun_id
;
994 value
->be32
= flow
->tunnel
.ip_src
;
997 value
->be32
= flow
->tunnel
.ip_dst
;
1000 value
->be16
= htons(flow
->tunnel
.flags
);
1003 value
->u8
= flow
->tunnel
.ip_ttl
;
1006 value
->u8
= flow
->tunnel
.ip_tos
;
1010 value
->be64
= flow
->metadata
;
1014 value
->be16
= htons(ofp_to_u16(flow
->in_port
.ofp_port
));
1016 case MFF_IN_PORT_OXM
:
1017 value
->be32
= ofputil_port_to_ofp11(flow
->in_port
.ofp_port
);
1020 case MFF_SKB_PRIORITY
:
1021 value
->be32
= htonl(flow
->skb_priority
);
1025 value
->be32
= htonl(flow
->skb_mark
);
1029 value
->be32
= htonl(flow
->regs
[mf
->id
- MFF_REG0
]);
1033 memcpy(value
->mac
, flow
->dl_src
, ETH_ADDR_LEN
);
1037 memcpy(value
->mac
, flow
->dl_dst
, ETH_ADDR_LEN
);
1041 value
->be16
= flow
->dl_type
;
1045 value
->be16
= flow
->vlan_tci
;
1049 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
);
1052 value
->be16
= flow
->vlan_tci
& htons(VLAN_VID_MASK
| VLAN_CFI
);
1055 case MFF_DL_VLAN_PCP
:
1057 value
->u8
= vlan_tci_to_pcp(flow
->vlan_tci
);
1060 case MFF_MPLS_LABEL
:
1061 value
->be32
= htonl(mpls_lse_to_label(flow
->mpls_lse
));
1065 value
->u8
= mpls_lse_to_tc(flow
->mpls_lse
);
1069 value
->u8
= mpls_lse_to_bos(flow
->mpls_lse
);
1073 value
->be32
= flow
->nw_src
;
1077 value
->be32
= flow
->nw_dst
;
1081 value
->ipv6
= flow
->ipv6_src
;
1085 value
->ipv6
= flow
->ipv6_dst
;
1088 case MFF_IPV6_LABEL
:
1089 value
->be32
= flow
->ipv6_label
;
1093 value
->u8
= flow
->nw_proto
;
1097 value
->u8
= flow
->nw_tos
& IP_DSCP_MASK
;
1100 case MFF_IP_DSCP_SHIFTED
:
1101 value
->u8
= flow
->nw_tos
>> 2;
1105 value
->u8
= flow
->nw_tos
& IP_ECN_MASK
;
1109 value
->u8
= flow
->nw_ttl
;
1113 value
->u8
= flow
->nw_frag
;
1117 value
->be16
= htons(flow
->nw_proto
);
1121 value
->be32
= flow
->nw_src
;
1125 value
->be32
= flow
->nw_dst
;
1130 memcpy(value
->mac
, flow
->arp_sha
, ETH_ADDR_LEN
);
1135 memcpy(value
->mac
, flow
->arp_tha
, ETH_ADDR_LEN
);
1140 value
->be16
= flow
->tp_src
;
1145 value
->be16
= flow
->tp_dst
;
1148 case MFF_ICMPV4_TYPE
:
1149 case MFF_ICMPV6_TYPE
:
1150 value
->u8
= ntohs(flow
->tp_src
);
1153 case MFF_ICMPV4_CODE
:
1154 case MFF_ICMPV6_CODE
:
1155 value
->u8
= ntohs(flow
->tp_dst
);
1159 value
->ipv6
= flow
->nd_target
;
1168 /* Makes 'match' match field 'mf' exactly, with the value matched taken from
1169 * 'value'. The caller is responsible for ensuring that 'match' meets 'mf''s
1172 mf_set_value(const struct mf_field
*mf
,
1173 const union mf_value
*value
, struct match
*match
)
1177 match_set_tun_id(match
, value
->be64
);
1180 match_set_tun_src(match
, value
->be32
);
1183 match_set_tun_dst(match
, value
->be32
);
1186 match_set_tun_flags(match
, ntohs(value
->be16
));
1189 match_set_tun_tos(match
, value
->u8
);
1192 match_set_tun_ttl(match
, value
->u8
);
1196 match_set_metadata(match
, value
->be64
);
1200 match_set_in_port(match
, u16_to_ofp(ntohs(value
->be16
)));
1203 case MFF_IN_PORT_OXM
: {
1205 ofputil_port_from_ofp11(value
->be32
, &port
);
1206 match_set_in_port(match
, port
);
1210 case MFF_SKB_PRIORITY
:
1211 match_set_skb_priority(match
, ntohl(value
->be32
));
1215 match_set_skb_mark(match
, ntohl(value
->be32
));
1219 match_set_reg(match
, mf
->id
- MFF_REG0
, ntohl(value
->be32
));
1223 match_set_dl_src(match
, value
->mac
);
1227 match_set_dl_dst(match
, value
->mac
);
1231 match_set_dl_type(match
, value
->be16
);
1235 match_set_dl_tci(match
, value
->be16
);
1239 match_set_dl_vlan(match
, value
->be16
);
1242 match_set_vlan_vid(match
, value
->be16
);
1245 case MFF_DL_VLAN_PCP
:
1247 match_set_dl_vlan_pcp(match
, value
->u8
);
1250 case MFF_MPLS_LABEL
:
1251 match_set_mpls_label(match
, value
->be32
);
1255 match_set_mpls_tc(match
, value
->u8
);
1259 match_set_mpls_bos(match
, value
->u8
);
1263 match_set_nw_src(match
, value
->be32
);
1267 match_set_nw_dst(match
, value
->be32
);
1271 match_set_ipv6_src(match
, &value
->ipv6
);
1275 match_set_ipv6_dst(match
, &value
->ipv6
);
1278 case MFF_IPV6_LABEL
:
1279 match_set_ipv6_label(match
, value
->be32
);
1283 match_set_nw_proto(match
, value
->u8
);
1287 match_set_nw_dscp(match
, value
->u8
);
1290 case MFF_IP_DSCP_SHIFTED
:
1291 match_set_nw_dscp(match
, value
->u8
<< 2);
1295 match_set_nw_ecn(match
, value
->u8
);
1299 match_set_nw_ttl(match
, value
->u8
);
1303 match_set_nw_frag(match
, value
->u8
);
1307 match_set_nw_proto(match
, ntohs(value
->be16
));
1311 match_set_nw_src(match
, value
->be32
);
1315 match_set_nw_dst(match
, value
->be32
);
1320 match_set_arp_sha(match
, value
->mac
);
1325 match_set_arp_tha(match
, value
->mac
);
1330 match_set_tp_src(match
, value
->be16
);
1335 match_set_tp_dst(match
, value
->be16
);
1338 case MFF_ICMPV4_TYPE
:
1339 case MFF_ICMPV6_TYPE
:
1340 match_set_icmp_type(match
, value
->u8
);
1343 case MFF_ICMPV4_CODE
:
1344 case MFF_ICMPV6_CODE
:
1345 match_set_icmp_code(match
, value
->u8
);
1349 match_set_nd_target(match
, &value
->ipv6
);
1358 /* Sets 'flow' member field described by 'mf' to 'value'. The caller is
1359 * responsible for ensuring that 'flow' meets 'mf''s prerequisites.*/
1361 mf_set_flow_value(const struct mf_field
*mf
,
1362 const union mf_value
*value
, struct flow
*flow
)
1366 flow
->tunnel
.tun_id
= value
->be64
;
1369 flow
->tunnel
.ip_src
= value
->be32
;
1372 flow
->tunnel
.ip_dst
= value
->be32
;
1375 flow
->tunnel
.flags
= ntohs(value
->be16
);
1378 flow
->tunnel
.ip_tos
= value
->u8
;
1381 flow
->tunnel
.ip_ttl
= value
->u8
;
1385 flow
->metadata
= value
->be64
;
1389 flow
->in_port
.ofp_port
= u16_to_ofp(ntohs(value
->be16
));
1392 case MFF_IN_PORT_OXM
: {
1394 ofputil_port_from_ofp11(value
->be32
, &port
);
1395 flow
->in_port
.ofp_port
= port
;
1399 case MFF_SKB_PRIORITY
:
1400 flow
->skb_priority
= ntohl(value
->be32
);
1404 flow
->skb_mark
= ntohl(value
->be32
);
1408 flow
->regs
[mf
->id
- MFF_REG0
] = ntohl(value
->be32
);
1412 memcpy(flow
->dl_src
, value
->mac
, ETH_ADDR_LEN
);
1416 memcpy(flow
->dl_dst
, value
->mac
, ETH_ADDR_LEN
);
1420 flow
->dl_type
= value
->be16
;
1424 flow
->vlan_tci
= value
->be16
;
1428 flow_set_dl_vlan(flow
, value
->be16
);
1431 flow_set_vlan_vid(flow
, value
->be16
);
1434 case MFF_DL_VLAN_PCP
:
1436 flow_set_vlan_pcp(flow
, value
->u8
);
1439 case MFF_MPLS_LABEL
:
1440 flow_set_mpls_label(flow
, value
->be32
);
1444 flow_set_mpls_tc(flow
, value
->u8
);
1448 flow_set_mpls_bos(flow
, value
->u8
);
1452 flow
->nw_src
= value
->be32
;
1456 flow
->nw_dst
= value
->be32
;
1460 flow
->ipv6_src
= value
->ipv6
;
1464 flow
->ipv6_dst
= value
->ipv6
;
1467 case MFF_IPV6_LABEL
:
1468 flow
->ipv6_label
= value
->be32
& ~htonl(IPV6_LABEL_MASK
);
1472 flow
->nw_proto
= value
->u8
;
1476 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1477 flow
->nw_tos
|= value
->u8
& IP_DSCP_MASK
;
1480 case MFF_IP_DSCP_SHIFTED
:
1481 flow
->nw_tos
&= ~IP_DSCP_MASK
;
1482 flow
->nw_tos
|= value
->u8
<< 2;
1486 flow
->nw_tos
&= ~IP_ECN_MASK
;
1487 flow
->nw_tos
|= value
->u8
& IP_ECN_MASK
;
1491 flow
->nw_ttl
= value
->u8
;
1495 flow
->nw_frag
&= value
->u8
;
1499 flow
->nw_proto
= ntohs(value
->be16
);
1503 flow
->nw_src
= value
->be32
;
1507 flow
->nw_dst
= value
->be32
;
1512 memcpy(flow
->arp_sha
, value
->mac
, ETH_ADDR_LEN
);
1517 memcpy(flow
->arp_tha
, value
->mac
, ETH_ADDR_LEN
);
1522 flow
->tp_src
= value
->be16
;
1527 flow
->tp_dst
= value
->be16
;
1530 case MFF_ICMPV4_TYPE
:
1531 case MFF_ICMPV6_TYPE
:
1532 flow
->tp_src
= htons(value
->u8
);
1535 case MFF_ICMPV4_CODE
:
1536 case MFF_ICMPV6_CODE
:
1537 flow
->tp_dst
= htons(value
->u8
);
1541 flow
->nd_target
= value
->ipv6
;
1550 /* Returns true if 'mf' has a zero value in 'flow', false if it is nonzero.
1552 * The caller is responsible for ensuring that 'flow' meets 'mf''s
1555 mf_is_zero(const struct mf_field
*mf
, const struct flow
*flow
)
1557 union mf_value value
;
1559 mf_get_value(mf
, flow
, &value
);
1560 return is_all_zeros((const uint8_t *) &value
, mf
->n_bytes
);
1563 /* Makes 'match' wildcard field 'mf'.
1565 * The caller is responsible for ensuring that 'match' meets 'mf''s
1568 mf_set_wild(const struct mf_field
*mf
, struct match
*match
)
1572 match_set_tun_id_masked(match
, htonll(0), htonll(0));
1575 match_set_tun_src_masked(match
, htonl(0), htonl(0));
1578 match_set_tun_dst_masked(match
, htonl(0), htonl(0));
1581 match_set_tun_flags_masked(match
, 0, 0);
1584 match_set_tun_tos_masked(match
, 0, 0);
1587 match_set_tun_ttl_masked(match
, 0, 0);
1591 match_set_metadata_masked(match
, htonll(0), htonll(0));
1595 case MFF_IN_PORT_OXM
:
1596 match
->flow
.in_port
.ofp_port
= 0;
1597 match
->wc
.masks
.in_port
.ofp_port
= 0;
1600 case MFF_SKB_PRIORITY
:
1601 match
->flow
.skb_priority
= 0;
1602 match
->wc
.masks
.skb_priority
= 0;
1606 match
->flow
.skb_mark
= 0;
1607 match
->wc
.masks
.skb_mark
= 0;
1611 match_set_reg_masked(match
, mf
->id
- MFF_REG0
, 0, 0);
1615 memset(match
->flow
.dl_src
, 0, ETH_ADDR_LEN
);
1616 memset(match
->wc
.masks
.dl_src
, 0, ETH_ADDR_LEN
);
1620 memset(match
->flow
.dl_dst
, 0, ETH_ADDR_LEN
);
1621 memset(match
->wc
.masks
.dl_dst
, 0, ETH_ADDR_LEN
);
1625 match
->flow
.dl_type
= htons(0);
1626 match
->wc
.masks
.dl_type
= htons(0);
1630 match_set_dl_tci_masked(match
, htons(0), htons(0));
1635 match_set_any_vid(match
);
1638 case MFF_DL_VLAN_PCP
:
1640 match_set_any_pcp(match
);
1643 case MFF_MPLS_LABEL
:
1644 match_set_any_mpls_label(match
);
1648 match_set_any_mpls_tc(match
);
1652 match_set_any_mpls_bos(match
);
1657 match_set_nw_src_masked(match
, htonl(0), htonl(0));
1662 match_set_nw_dst_masked(match
, htonl(0), htonl(0));
1666 memset(&match
->wc
.masks
.ipv6_src
, 0, sizeof match
->wc
.masks
.ipv6_src
);
1667 memset(&match
->flow
.ipv6_src
, 0, sizeof match
->flow
.ipv6_src
);
1671 memset(&match
->wc
.masks
.ipv6_dst
, 0, sizeof match
->wc
.masks
.ipv6_dst
);
1672 memset(&match
->flow
.ipv6_dst
, 0, sizeof match
->flow
.ipv6_dst
);
1675 case MFF_IPV6_LABEL
:
1676 match
->wc
.masks
.ipv6_label
= htonl(0);
1677 match
->flow
.ipv6_label
= htonl(0);
1681 match
->wc
.masks
.nw_proto
= 0;
1682 match
->flow
.nw_proto
= 0;
1686 case MFF_IP_DSCP_SHIFTED
:
1687 match
->wc
.masks
.nw_tos
&= ~IP_DSCP_MASK
;
1688 match
->flow
.nw_tos
&= ~IP_DSCP_MASK
;
1692 match
->wc
.masks
.nw_tos
&= ~IP_ECN_MASK
;
1693 match
->flow
.nw_tos
&= ~IP_ECN_MASK
;
1697 match
->wc
.masks
.nw_ttl
= 0;
1698 match
->flow
.nw_ttl
= 0;
1702 match
->wc
.masks
.nw_frag
|= FLOW_NW_FRAG_MASK
;
1703 match
->flow
.nw_frag
&= ~FLOW_NW_FRAG_MASK
;
1707 match
->wc
.masks
.nw_proto
= 0;
1708 match
->flow
.nw_proto
= 0;
1713 memset(match
->flow
.arp_sha
, 0, ETH_ADDR_LEN
);
1714 memset(match
->wc
.masks
.arp_sha
, 0, ETH_ADDR_LEN
);
1719 memset(match
->flow
.arp_tha
, 0, ETH_ADDR_LEN
);
1720 memset(match
->wc
.masks
.arp_tha
, 0, ETH_ADDR_LEN
);
1725 case MFF_ICMPV4_TYPE
:
1726 case MFF_ICMPV6_TYPE
:
1727 match
->wc
.masks
.tp_src
= htons(0);
1728 match
->flow
.tp_src
= htons(0);
1733 case MFF_ICMPV4_CODE
:
1734 case MFF_ICMPV6_CODE
:
1735 match
->wc
.masks
.tp_dst
= htons(0);
1736 match
->flow
.tp_dst
= htons(0);
1740 memset(&match
->wc
.masks
.nd_target
, 0,
1741 sizeof match
->wc
.masks
.nd_target
);
1742 memset(&match
->flow
.nd_target
, 0, sizeof match
->flow
.nd_target
);
1751 /* Makes 'match' match field 'mf' with the specified 'value' and 'mask'.
1752 * 'value' specifies a value to match and 'mask' specifies a wildcard pattern,
1753 * with a 1-bit indicating that the corresponding value bit must match and a
1754 * 0-bit indicating a don't-care.
1756 * If 'mask' is NULL or points to all-1-bits, then this call is equivalent to
1757 * mf_set_value(mf, value, match). If 'mask' points to all-0-bits, then this
1758 * call is equivalent to mf_set_wild(mf, match).
1760 * 'mask' must be a valid mask for 'mf' (see mf_is_mask_valid()). The caller
1761 * is responsible for ensuring that 'match' meets 'mf''s prerequisites. */
1763 mf_set(const struct mf_field
*mf
,
1764 const union mf_value
*value
, const union mf_value
*mask
,
1765 struct match
*match
)
1767 if (!mask
|| is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
1768 mf_set_value(mf
, value
, match
);
1770 } else if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
1771 mf_set_wild(mf
, match
);
1777 case MFF_IN_PORT_OXM
:
1779 case MFF_SKB_PRIORITY
:
1782 case MFF_DL_VLAN_PCP
:
1784 case MFF_MPLS_LABEL
:
1790 case MFF_IP_DSCP_SHIFTED
:
1793 case MFF_ICMPV4_TYPE
:
1794 case MFF_ICMPV4_CODE
:
1795 case MFF_ICMPV6_TYPE
:
1796 case MFF_ICMPV6_CODE
:
1800 match_set_tun_id_masked(match
, value
->be64
, mask
->be64
);
1803 match_set_tun_src_masked(match
, value
->be32
, mask
->be32
);
1806 match_set_tun_dst_masked(match
, value
->be32
, mask
->be32
);
1809 match_set_tun_flags_masked(match
, ntohs(value
->be16
), ntohs(mask
->be16
));
1812 match_set_tun_ttl_masked(match
, value
->u8
, mask
->u8
);
1815 match_set_tun_tos_masked(match
, value
->u8
, mask
->u8
);
1819 match_set_metadata_masked(match
, value
->be64
, mask
->be64
);
1823 match_set_reg_masked(match
, mf
->id
- MFF_REG0
,
1824 ntohl(value
->be32
), ntohl(mask
->be32
));
1828 match_set_dl_dst_masked(match
, value
->mac
, mask
->mac
);
1832 match_set_dl_src_masked(match
, value
->mac
, mask
->mac
);
1837 match_set_arp_sha_masked(match
, value
->mac
, mask
->mac
);
1842 match_set_arp_tha_masked(match
, value
->mac
, mask
->mac
);
1846 match_set_dl_tci_masked(match
, value
->be16
, mask
->be16
);
1850 match_set_vlan_vid_masked(match
, value
->be16
, mask
->be16
);
1854 match_set_nw_src_masked(match
, value
->be32
, mask
->be32
);
1858 match_set_nw_dst_masked(match
, value
->be32
, mask
->be32
);
1862 match_set_ipv6_src_masked(match
, &value
->ipv6
, &mask
->ipv6
);
1866 match_set_ipv6_dst_masked(match
, &value
->ipv6
, &mask
->ipv6
);
1869 case MFF_IPV6_LABEL
:
1870 if ((mask
->be32
& htonl(IPV6_LABEL_MASK
)) == htonl(IPV6_LABEL_MASK
)) {
1871 mf_set_value(mf
, value
, match
);
1873 match_set_ipv6_label_masked(match
, value
->be32
, mask
->be32
);
1878 match_set_nd_target_masked(match
, &value
->ipv6
, &mask
->ipv6
);
1882 match_set_nw_frag_masked(match
, value
->u8
, mask
->u8
);
1886 match_set_nw_src_masked(match
, value
->be32
, mask
->be32
);
1890 match_set_nw_dst_masked(match
, value
->be32
, mask
->be32
);
1895 match_set_tp_src_masked(match
, value
->be16
, mask
->be16
);
1900 match_set_tp_dst_masked(match
, value
->be16
, mask
->be16
);
1910 mf_check__(const struct mf_subfield
*sf
, const struct flow
*flow
,
1914 VLOG_WARN_RL(&rl
, "unknown %s field", type
);
1915 } else if (!sf
->n_bits
) {
1916 VLOG_WARN_RL(&rl
, "zero bit %s field %s", type
, sf
->field
->name
);
1917 } else if (sf
->ofs
>= sf
->field
->n_bits
) {
1918 VLOG_WARN_RL(&rl
, "bit offset %d exceeds %d-bit width of %s field %s",
1919 sf
->ofs
, sf
->field
->n_bits
, type
, sf
->field
->name
);
1920 } else if (sf
->ofs
+ sf
->n_bits
> sf
->field
->n_bits
) {
1921 VLOG_WARN_RL(&rl
, "bit offset %d and width %d exceeds %d-bit width "
1922 "of %s field %s", sf
->ofs
, sf
->n_bits
,
1923 sf
->field
->n_bits
, type
, sf
->field
->name
);
1924 } else if (flow
&& !mf_are_prereqs_ok(sf
->field
, flow
)) {
1925 VLOG_WARN_RL(&rl
, "%s field %s lacks correct prerequisites",
1926 type
, sf
->field
->name
);
1931 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1934 /* Checks whether 'sf' is valid for reading a subfield out of 'flow'. Returns
1935 * 0 if so, otherwise an OpenFlow error code (e.g. as returned by
1938 mf_check_src(const struct mf_subfield
*sf
, const struct flow
*flow
)
1940 return mf_check__(sf
, flow
, "source");
1943 /* Checks whether 'sf' is valid for writing a subfield into 'flow'. Returns 0
1944 * if so, otherwise an OpenFlow error code (e.g. as returned by
1947 mf_check_dst(const struct mf_subfield
*sf
, const struct flow
*flow
)
1949 int error
= mf_check__(sf
, flow
, "destination");
1950 if (!error
&& !sf
->field
->writable
) {
1951 VLOG_WARN_RL(&rl
, "destination field %s is not writable",
1953 return OFPERR_OFPBAC_BAD_ARGUMENT
;
1958 /* Copies the value and wildcard bit pattern for 'mf' from 'match' into the
1959 * 'value' and 'mask', respectively. */
1961 mf_get(const struct mf_field
*mf
, const struct match
*match
,
1962 union mf_value
*value
, union mf_value
*mask
)
1964 mf_get_value(mf
, &match
->flow
, value
);
1965 mf_get_mask(mf
, &match
->wc
, mask
);
1968 /* Assigns a random value for field 'mf' to 'value'. */
1970 mf_random_value(const struct mf_field
*mf
, union mf_value
*value
)
1972 random_bytes(value
, mf
->n_bytes
);
1984 case MFF_SKB_PRIORITY
:
2004 case MFF_ICMPV4_TYPE
:
2005 case MFF_ICMPV4_CODE
:
2006 case MFF_ICMPV6_TYPE
:
2007 case MFF_ICMPV6_CODE
:
2013 case MFF_IN_PORT_OXM
:
2014 value
->be32
= ofputil_port_to_ofp11(u16_to_ofp(ntohs(value
->be16
)));
2017 case MFF_IPV6_LABEL
:
2018 value
->be32
&= ~htonl(IPV6_LABEL_MASK
);
2022 value
->u8
&= IP_DSCP_MASK
;
2025 case MFF_IP_DSCP_SHIFTED
:
2026 value
->u8
&= IP_DSCP_MASK
>> 2;
2030 value
->u8
&= IP_ECN_MASK
;
2034 value
->u8
&= FLOW_NW_FRAG_MASK
;
2038 value
->be16
&= htons(0xff);
2042 value
->be16
&= htons(VLAN_VID_MASK
);
2045 value
->be16
&= htons(VLAN_VID_MASK
| VLAN_CFI
);
2048 case MFF_DL_VLAN_PCP
:
2053 case MFF_MPLS_LABEL
:
2054 value
->be32
&= htonl(MPLS_LABEL_MASK
>> MPLS_LABEL_SHIFT
);
2058 value
->u8
&= MPLS_TC_MASK
>> MPLS_TC_SHIFT
;
2062 value
->u8
&= MPLS_BOS_MASK
>> MPLS_BOS_SHIFT
;
2072 mf_from_integer_string(const struct mf_field
*mf
, const char *s
,
2073 uint8_t *valuep
, uint8_t *maskp
)
2075 unsigned long long int integer
, mask
;
2080 integer
= strtoull(s
, &tail
, 0);
2081 if (errno
|| (*tail
!= '\0' && *tail
!= '/')) {
2086 mask
= strtoull(tail
+ 1, &tail
, 0);
2087 if (errno
|| *tail
!= '\0') {
2094 for (i
= mf
->n_bytes
- 1; i
>= 0; i
--) {
2095 valuep
[i
] = integer
;
2101 return xasprintf("%s: value too large for %u-byte field %s",
2102 s
, mf
->n_bytes
, mf
->name
);
2107 return xasprintf("%s: bad syntax for %s", s
, mf
->name
);
2111 mf_from_ethernet_string(const struct mf_field
*mf
, const char *s
,
2112 uint8_t mac
[ETH_ADDR_LEN
],
2113 uint8_t mask
[ETH_ADDR_LEN
])
2115 ovs_assert(mf
->n_bytes
== ETH_ADDR_LEN
);
2117 switch (sscanf(s
, ETH_ADDR_SCAN_FMT
"/"ETH_ADDR_SCAN_FMT
,
2118 ETH_ADDR_SCAN_ARGS(mac
), ETH_ADDR_SCAN_ARGS(mask
))){
2119 case ETH_ADDR_SCAN_COUNT
* 2:
2122 case ETH_ADDR_SCAN_COUNT
:
2123 memset(mask
, 0xff, ETH_ADDR_LEN
);
2127 return xasprintf("%s: invalid Ethernet address", s
);
2132 mf_from_ipv4_string(const struct mf_field
*mf
, const char *s
,
2133 ovs_be32
*ip
, ovs_be32
*mask
)
2137 ovs_assert(mf
->n_bytes
== sizeof *ip
);
2139 if (sscanf(s
, IP_SCAN_FMT
"/"IP_SCAN_FMT
,
2140 IP_SCAN_ARGS(ip
), IP_SCAN_ARGS(mask
)) == IP_SCAN_COUNT
* 2) {
2142 } else if (sscanf(s
, IP_SCAN_FMT
"/%d",
2143 IP_SCAN_ARGS(ip
), &prefix
) == IP_SCAN_COUNT
+ 1) {
2144 if (prefix
<= 0 || prefix
> 32) {
2145 return xasprintf("%s: network prefix bits not between 1 and "
2147 } else if (prefix
== 32) {
2148 *mask
= htonl(UINT32_MAX
);
2150 *mask
= htonl(((1u << prefix
) - 1) << (32 - prefix
));
2152 } else if (sscanf(s
, IP_SCAN_FMT
, IP_SCAN_ARGS(ip
)) == IP_SCAN_COUNT
) {
2153 *mask
= htonl(UINT32_MAX
);
2155 return xasprintf("%s: invalid IP address", s
);
2161 mf_from_ipv6_string(const struct mf_field
*mf
, const char *s
,
2162 struct in6_addr
*value
, struct in6_addr
*mask
)
2164 char *str
= xstrdup(s
);
2165 char *save_ptr
= NULL
;
2166 const char *name
, *netmask
;
2169 ovs_assert(mf
->n_bytes
== sizeof *value
);
2171 name
= strtok_r(str
, "/", &save_ptr
);
2172 retval
= name
? lookup_ipv6(name
, value
) : EINVAL
;
2176 err
= xasprintf("%s: could not convert to IPv6 address", str
);
2182 netmask
= strtok_r(NULL
, "/", &save_ptr
);
2184 if (inet_pton(AF_INET6
, netmask
, mask
) != 1) {
2185 int prefix
= atoi(netmask
);
2186 if (prefix
<= 0 || prefix
> 128) {
2188 return xasprintf("%s: prefix bits not between 1 and 128", s
);
2190 *mask
= ipv6_create_mask(prefix
);
2194 *mask
= in6addr_exact
;
2202 mf_from_ofp_port_string(const struct mf_field
*mf
, const char *s
,
2203 ovs_be16
*valuep
, ovs_be16
*maskp
)
2207 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2209 if (ofputil_port_from_string(s
, &port
)) {
2210 *valuep
= htons(ofp_to_u16(port
));
2211 *maskp
= htons(UINT16_MAX
);
2214 return xasprintf("%s: port value out of range for %s", s
, mf
->name
);
2218 mf_from_ofp_port_string32(const struct mf_field
*mf
, const char *s
,
2219 ovs_be32
*valuep
, ovs_be32
*maskp
)
2223 ovs_assert(mf
->n_bytes
== sizeof(ovs_be32
));
2224 if (ofputil_port_from_string(s
, &port
)) {
2225 *valuep
= ofputil_port_to_ofp11(port
);
2226 *maskp
= htonl(UINT32_MAX
);
2229 return xasprintf("%s: port value out of range for %s", s
, mf
->name
);
2232 struct frag_handling
{
2238 static const struct frag_handling all_frags
[] = {
2239 #define A FLOW_NW_FRAG_ANY
2240 #define L FLOW_NW_FRAG_LATER
2241 /* name mask value */
2244 { "first", A
|L
, A
},
2245 { "later", A
|L
, A
|L
},
2250 { "not_later", L
, 0 },
2257 mf_from_frag_string(const char *s
, uint8_t *valuep
, uint8_t *maskp
)
2259 const struct frag_handling
*h
;
2261 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2262 if (!strcasecmp(s
, h
->name
)) {
2263 /* We force the upper bits of the mask on to make mf_parse_value()
2264 * happy (otherwise it will never think it's an exact match.) */
2265 *maskp
= h
->mask
| ~FLOW_NW_FRAG_MASK
;
2271 return xasprintf("%s: unknown fragment type (valid types are \"no\", "
2272 "\"yes\", \"first\", \"later\", \"not_first\"", s
);
2276 parse_flow_tun_flags(const char *s_
, const char *(*bit_to_string
)(uint32_t),
2279 uint32_t result
= 0;
2280 char *save_ptr
= NULL
;
2283 char *s
= xstrdup(s_
);
2285 for (name
= strtok_r((char *)s
, " |", &save_ptr
); name
;
2286 name
= strtok_r(NULL
, " |", &save_ptr
)) {
2288 unsigned long long int flags
;
2292 if (sscanf(name
, "%lli%n", &flags
, &n0
) > 0 && n0
> 0) {
2296 name_len
= strlen(name
);
2297 for (bit
= 1; bit
; bit
<<= 1) {
2298 const char *fname
= bit_to_string(bit
);
2305 len
= strlen(fname
);
2306 if (len
!= name_len
) {
2309 if (!strncmp(name
, fname
, len
)) {
2321 *res
= htons(result
);
2328 mf_from_tun_flags_string(const char *s
, ovs_be16
*valuep
, ovs_be16
*maskp
)
2330 if (!parse_flow_tun_flags(s
, flow_tun_flag_to_string
, valuep
)) {
2331 *maskp
= htons(UINT16_MAX
);
2335 return xasprintf("%s: unknown tunnel flags (valid flags are \"df\", "
2336 "\"csum\", \"key\"", s
);
2339 /* Parses 's', a string value for field 'mf', into 'value' and 'mask'. Returns
2340 * NULL if successful, otherwise a malloc()'d string describing the error. */
2342 mf_parse(const struct mf_field
*mf
, const char *s
,
2343 union mf_value
*value
, union mf_value
*mask
)
2345 if (!strcmp(s
, "*")) {
2346 memset(value
, 0, mf
->n_bytes
);
2347 memset(mask
, 0, mf
->n_bytes
);
2351 switch (mf
->string
) {
2353 case MFS_HEXADECIMAL
:
2354 return mf_from_integer_string(mf
, s
,
2355 (uint8_t *) value
, (uint8_t *) mask
);
2358 return mf_from_ethernet_string(mf
, s
, value
->mac
, mask
->mac
);
2361 return mf_from_ipv4_string(mf
, s
, &value
->be32
, &mask
->be32
);
2364 return mf_from_ipv6_string(mf
, s
, &value
->ipv6
, &mask
->ipv6
);
2367 return mf_from_ofp_port_string(mf
, s
, &value
->be16
, &mask
->be16
);
2369 case MFS_OFP_PORT_OXM
:
2370 return mf_from_ofp_port_string32(mf
, s
, &value
->be32
, &mask
->be32
);
2373 return mf_from_frag_string(s
, &value
->u8
, &mask
->u8
);
2376 ovs_assert(mf
->n_bytes
== sizeof(ovs_be16
));
2377 return mf_from_tun_flags_string(s
, &value
->be16
, &mask
->be16
);
2382 /* Parses 's', a string value for field 'mf', into 'value'. Returns NULL if
2383 * successful, otherwise a malloc()'d string describing the error. */
2385 mf_parse_value(const struct mf_field
*mf
, const char *s
, union mf_value
*value
)
2387 union mf_value mask
;
2390 error
= mf_parse(mf
, s
, value
, &mask
);
2395 if (!is_all_ones((const uint8_t *) &mask
, mf
->n_bytes
)) {
2396 return xasprintf("%s: wildcards not allowed here", s
);
2402 mf_format_integer_string(const struct mf_field
*mf
, const uint8_t *valuep
,
2403 const uint8_t *maskp
, struct ds
*s
)
2405 unsigned long long int integer
;
2408 ovs_assert(mf
->n_bytes
<= 8);
2411 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2412 integer
= (integer
<< 8) | valuep
[i
];
2414 if (mf
->string
== MFS_HEXADECIMAL
) {
2415 ds_put_format(s
, "%#llx", integer
);
2417 ds_put_format(s
, "%lld", integer
);
2421 unsigned long long int mask
;
2424 for (i
= 0; i
< mf
->n_bytes
; i
++) {
2425 mask
= (mask
<< 8) | maskp
[i
];
2428 /* I guess we could write the mask in decimal for MFS_DECIMAL but I'm
2429 * not sure that that a bit-mask written in decimal is ever easier to
2430 * understand than the same bit-mask written in hexadecimal. */
2431 ds_put_format(s
, "/%#llx", mask
);
2436 mf_format_frag_string(uint8_t value
, uint8_t mask
, struct ds
*s
)
2438 const struct frag_handling
*h
;
2440 mask
&= FLOW_NW_FRAG_MASK
;
2443 for (h
= all_frags
; h
< &all_frags
[ARRAY_SIZE(all_frags
)]; h
++) {
2444 if (value
== h
->value
&& mask
== h
->mask
) {
2445 ds_put_cstr(s
, h
->name
);
2449 ds_put_cstr(s
, "<error>");
2453 mf_format_tnl_flags_string(const ovs_be16
*valuep
, struct ds
*s
)
2455 format_flags(s
, flow_tun_flag_to_string
, ntohs(*valuep
), '|');
2458 /* Appends to 's' a string representation of field 'mf' whose value is in
2459 * 'value' and 'mask'. 'mask' may be NULL to indicate an exact match. */
2461 mf_format(const struct mf_field
*mf
,
2462 const union mf_value
*value
, const union mf_value
*mask
,
2466 if (is_all_zeros((const uint8_t *) mask
, mf
->n_bytes
)) {
2467 ds_put_cstr(s
, "ANY");
2469 } else if (is_all_ones((const uint8_t *) mask
, mf
->n_bytes
)) {
2474 switch (mf
->string
) {
2475 case MFS_OFP_PORT_OXM
:
2478 ofputil_port_from_ofp11(value
->be32
, &port
);
2479 ofputil_format_port(port
, s
);
2485 ofputil_format_port(u16_to_ofp(ntohs(value
->be16
)), s
);
2490 case MFS_HEXADECIMAL
:
2491 mf_format_integer_string(mf
, (uint8_t *) value
, (uint8_t *) mask
, s
);
2495 eth_format_masked(value
->mac
, mask
->mac
, s
);
2499 ip_format_masked(value
->be32
, mask
? mask
->be32
: htonl(UINT32_MAX
),
2504 print_ipv6_masked(s
, &value
->ipv6
, mask
? &mask
->ipv6
: NULL
);
2508 mf_format_frag_string(value
->u8
, mask
? mask
->u8
: UINT8_MAX
, s
);
2512 mf_format_tnl_flags_string(&value
->be16
, s
);
2520 /* Makes subfield 'sf' within 'flow' exactly match the 'sf->n_bits'
2521 * least-significant bits in 'x'.
2524 mf_write_subfield_flow(const struct mf_subfield
*sf
,
2525 const union mf_subvalue
*x
, struct flow
*flow
)
2527 const struct mf_field
*field
= sf
->field
;
2528 union mf_value value
;
2530 mf_get_value(field
, flow
, &value
);
2531 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
,
2532 sf
->ofs
, sf
->n_bits
);
2533 mf_set_flow_value(field
, &value
, flow
);
2536 /* Makes subfield 'sf' within 'match' exactly match the 'sf->n_bits'
2537 * least-significant bits in 'x'.
2540 mf_write_subfield(const struct mf_subfield
*sf
, const union mf_subvalue
*x
,
2541 struct match
*match
)
2543 const struct mf_field
*field
= sf
->field
;
2544 union mf_value value
, mask
;
2546 mf_get(field
, match
, &value
, &mask
);
2547 bitwise_copy(x
, sizeof *x
, 0, &value
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2548 bitwise_one ( &mask
, field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2549 mf_set(field
, &value
, &mask
, match
);
2552 /* Initializes 'x' to the value of 'sf' within 'flow'. 'sf' must be valid for
2553 * reading 'flow', e.g. as checked by mf_check_src(). */
2555 mf_read_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
,
2556 union mf_subvalue
*x
)
2558 union mf_value value
;
2560 mf_get_value(sf
->field
, flow
, &value
);
2562 memset(x
, 0, sizeof *x
);
2563 bitwise_copy(&value
, sf
->field
->n_bytes
, sf
->ofs
,
2568 /* Returns the value of 'sf' within 'flow'. 'sf' must be valid for reading
2569 * 'flow', e.g. as checked by mf_check_src() and sf->n_bits must be 64 or
2572 mf_get_subfield(const struct mf_subfield
*sf
, const struct flow
*flow
)
2574 union mf_value value
;
2576 mf_get_value(sf
->field
, flow
, &value
);
2577 return bitwise_get(&value
, sf
->field
->n_bytes
, sf
->ofs
, sf
->n_bits
);
2580 /* Formats 'sf' into 's' in a format normally acceptable to
2581 * mf_parse_subfield(). (It won't be acceptable if sf->field is NULL or if
2582 * sf->field has no NXM name.) */
2584 mf_format_subfield(const struct mf_subfield
*sf
, struct ds
*s
)
2587 ds_put_cstr(s
, "<unknown>");
2588 } else if (sf
->field
->nxm_name
) {
2589 ds_put_cstr(s
, sf
->field
->nxm_name
);
2590 } else if (sf
->field
->nxm_header
) {
2591 uint32_t header
= sf
->field
->nxm_header
;
2592 ds_put_format(s
, "%d:%d", NXM_VENDOR(header
), NXM_FIELD(header
));
2594 ds_put_cstr(s
, sf
->field
->name
);
2597 if (sf
->field
&& sf
->ofs
== 0 && sf
->n_bits
== sf
->field
->n_bits
) {
2598 ds_put_cstr(s
, "[]");
2599 } else if (sf
->n_bits
== 1) {
2600 ds_put_format(s
, "[%d]", sf
->ofs
);
2602 ds_put_format(s
, "[%d..%d]", sf
->ofs
, sf
->ofs
+ sf
->n_bits
- 1);
2606 static const struct mf_field
*
2607 mf_parse_subfield_name(const char *name
, int name_len
, bool *wild
)
2611 *wild
= name_len
> 2 && !memcmp(&name
[name_len
- 2], "_W", 2);
2616 for (i
= 0; i
< MFF_N_IDS
; i
++) {
2617 const struct mf_field
*mf
= mf_from_id(i
);
2620 && !strncmp(mf
->nxm_name
, name
, name_len
)
2621 && mf
->nxm_name
[name_len
] == '\0') {
2625 && !strncmp(mf
->oxm_name
, name
, name_len
)
2626 && mf
->oxm_name
[name_len
] == '\0') {
2634 /* Parses a subfield from the beginning of '*sp' into 'sf'. If successful,
2635 * returns NULL and advances '*sp' to the first byte following the parsed
2636 * string. On failure, returns a malloc()'d error message, does not modify
2637 * '*sp', and does not properly initialize 'sf'.
2639 * The syntax parsed from '*sp' takes the form "header[start..end]" where
2640 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2641 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2642 * may both be omitted (the [] are still required) to indicate an entire
2645 mf_parse_subfield__(struct mf_subfield
*sf
, const char **sp
)
2647 const struct mf_field
*field
;
2656 name_len
= strcspn(s
, "[");
2657 if (s
[name_len
] != '[') {
2658 return xasprintf("%s: missing [ looking for field name", *sp
);
2661 field
= mf_parse_subfield_name(name
, name_len
, &wild
);
2663 return xasprintf("%s: unknown field `%.*s'", *sp
, name_len
, s
);
2667 if (sscanf(s
, "[%d..%d]", &start
, &end
) == 2) {
2668 /* Nothing to do. */
2669 } else if (sscanf(s
, "[%d]", &start
) == 1) {
2671 } else if (!strncmp(s
, "[]", 2)) {
2673 end
= field
->n_bits
- 1;
2675 return xasprintf("%s: syntax error expecting [] or [<bit>] or "
2676 "[<start>..<end>]", *sp
);
2678 s
= strchr(s
, ']') + 1;
2681 return xasprintf("%s: starting bit %d is after ending bit %d",
2683 } else if (start
>= field
->n_bits
) {
2684 return xasprintf("%s: starting bit %d is not valid because field is "
2685 "only %d bits wide", *sp
, start
, field
->n_bits
);
2686 } else if (end
>= field
->n_bits
){
2687 return xasprintf("%s: ending bit %d is not valid because field is "
2688 "only %d bits wide", *sp
, end
, field
->n_bits
);
2693 sf
->n_bits
= end
- start
+ 1;
2699 /* Parses a subfield from the beginning of 's' into 'sf'. Returns the first
2700 * byte in 's' following the parsed string.
2702 * Exits with an error message if 's' has incorrect syntax.
2704 * The syntax parsed from 's' takes the form "header[start..end]" where
2705 * 'header' is the name of an NXM field and 'start' and 'end' are (inclusive)
2706 * bit indexes. "..end" may be omitted to indicate a single bit. "start..end"
2707 * may both be omitted (the [] are still required) to indicate an entire
2710 mf_parse_subfield(struct mf_subfield
*sf
, const char *s
)
2712 char *msg
= mf_parse_subfield__(sf
, &s
);
2714 ovs_fatal(0, "%s", msg
);
2720 mf_format_subvalue(const union mf_subvalue
*subvalue
, struct ds
*s
)
2724 for (i
= 0; i
< ARRAY_SIZE(subvalue
->u8
); i
++) {
2725 if (subvalue
->u8
[i
]) {
2726 ds_put_format(s
, "0x%"PRIx8
, subvalue
->u8
[i
]);
2727 for (i
++; i
< ARRAY_SIZE(subvalue
->u8
); i
++) {
2728 ds_put_format(s
, "%02"PRIx8
, subvalue
->u8
[i
]);
2733 ds_put_char(s
, '0');