2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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 <arpa/inet.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
28 #include "byte-order.h"
31 #include "dynamic-string.h"
38 #include "tun-metadata.h"
39 #include "unaligned.h"
42 #include "openvswitch/vlog.h"
44 VLOG_DEFINE_THIS_MODULE(odp_util);
46 /* The interface between userspace and kernel uses an "OVS_*" prefix.
47 * Since this is fairly non-specific for the OVS userspace components,
48 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
49 * interactions with the datapath.
52 /* The set of characters that may separate one action or one key attribute
54 static const char *delimiters = ", \t\r\n";
55 static const char *delimiters_end = ", \t\r\n)";
59 const struct attr_len_tbl *next;
62 #define ATTR_LEN_INVALID -1
63 #define ATTR_LEN_VARIABLE -2
64 #define ATTR_LEN_NESTED -3
66 static int parse_odp_key_mask_attr(const char *, const struct simap *port_names,
67 struct ofpbuf *, struct ofpbuf *);
68 static void format_odp_key_attr(const struct nlattr *a,
69 const struct nlattr *ma,
70 const struct hmap *portno_names, struct ds *ds,
74 struct geneve_opt d[63];
78 static int scan_geneve(const char *s, struct geneve_scan *key,
79 struct geneve_scan *mask);
80 static void format_geneve_opts(const struct geneve_opt *opt,
81 const struct geneve_opt *mask, int opts_len,
82 struct ds *, bool verbose);
84 static struct nlattr *generate_all_wildcard_mask(const struct attr_len_tbl tbl[],
85 int max, struct ofpbuf *,
86 const struct nlattr *key);
87 static void format_u128(struct ds *ds, const ovs_u128 *value,
88 const ovs_u128 *mask, bool verbose);
89 static int scan_u128(const char *s, ovs_u128 *value, ovs_u128 *mask);
91 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
94 * - For an action whose argument has a fixed length, returned that
95 * nonnegative length in bytes.
97 * - For an action with a variable-length argument, returns ATTR_LEN_VARIABLE.
99 * - For an invalid 'type', returns ATTR_LEN_INVALID. */
101 odp_action_len(uint16_t type)
103 if (type > OVS_ACTION_ATTR_MAX) {
107 switch ((enum ovs_action_attr) type) {
108 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
109 case OVS_ACTION_ATTR_TUNNEL_PUSH: return ATTR_LEN_VARIABLE;
110 case OVS_ACTION_ATTR_TUNNEL_POP: return sizeof(uint32_t);
111 case OVS_ACTION_ATTR_USERSPACE: return ATTR_LEN_VARIABLE;
112 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
113 case OVS_ACTION_ATTR_POP_VLAN: return 0;
114 case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
115 case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
116 case OVS_ACTION_ATTR_RECIRC: return sizeof(uint32_t);
117 case OVS_ACTION_ATTR_HASH: return sizeof(struct ovs_action_hash);
118 case OVS_ACTION_ATTR_SET: return ATTR_LEN_VARIABLE;
119 case OVS_ACTION_ATTR_SET_MASKED: return ATTR_LEN_VARIABLE;
120 case OVS_ACTION_ATTR_SAMPLE: return ATTR_LEN_VARIABLE;
121 case OVS_ACTION_ATTR_CT: return ATTR_LEN_VARIABLE;
123 case OVS_ACTION_ATTR_UNSPEC:
124 case __OVS_ACTION_ATTR_MAX:
125 return ATTR_LEN_INVALID;
128 return ATTR_LEN_INVALID;
131 /* Returns a string form of 'attr'. The return value is either a statically
132 * allocated constant string or the 'bufsize'-byte buffer 'namebuf'. 'bufsize'
133 * should be at least OVS_KEY_ATTR_BUFSIZE. */
134 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
136 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
139 case OVS_KEY_ATTR_UNSPEC: return "unspec";
140 case OVS_KEY_ATTR_ENCAP: return "encap";
141 case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
142 case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
143 case OVS_KEY_ATTR_CT_STATE: return "ct_state";
144 case OVS_KEY_ATTR_CT_ZONE: return "ct_zone";
145 case OVS_KEY_ATTR_CT_MARK: return "ct_mark";
146 case OVS_KEY_ATTR_CT_LABELS: return "ct_label";
147 case OVS_KEY_ATTR_TUNNEL: return "tunnel";
148 case OVS_KEY_ATTR_IN_PORT: return "in_port";
149 case OVS_KEY_ATTR_ETHERNET: return "eth";
150 case OVS_KEY_ATTR_VLAN: return "vlan";
151 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
152 case OVS_KEY_ATTR_IPV4: return "ipv4";
153 case OVS_KEY_ATTR_IPV6: return "ipv6";
154 case OVS_KEY_ATTR_TCP: return "tcp";
155 case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
156 case OVS_KEY_ATTR_UDP: return "udp";
157 case OVS_KEY_ATTR_SCTP: return "sctp";
158 case OVS_KEY_ATTR_ICMP: return "icmp";
159 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
160 case OVS_KEY_ATTR_ARP: return "arp";
161 case OVS_KEY_ATTR_ND: return "nd";
162 case OVS_KEY_ATTR_MPLS: return "mpls";
163 case OVS_KEY_ATTR_DP_HASH: return "dp_hash";
164 case OVS_KEY_ATTR_RECIRC_ID: return "recirc_id";
166 case __OVS_KEY_ATTR_MAX:
168 snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
174 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
176 size_t len = nl_attr_get_size(a);
178 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
180 const uint8_t *unspec;
183 unspec = nl_attr_get(a);
184 for (i = 0; i < len; i++) {
185 ds_put_char(ds, i ? ' ': '(');
186 ds_put_format(ds, "%02x", unspec[i]);
188 ds_put_char(ds, ')');
193 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
195 static const struct nl_policy ovs_sample_policy[] = {
196 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
197 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
199 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
201 const struct nlattr *nla_acts;
204 ds_put_cstr(ds, "sample");
206 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
207 ds_put_cstr(ds, "(error)");
211 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
214 ds_put_format(ds, "(sample=%.1f%%,", percentage);
216 ds_put_cstr(ds, "actions(");
217 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
218 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
219 format_odp_actions(ds, nla_acts, len);
220 ds_put_format(ds, "))");
224 slow_path_reason_to_string(uint32_t reason)
226 switch ((enum slow_path_reason) reason) {
227 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
236 slow_path_reason_to_explanation(enum slow_path_reason reason)
239 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
248 parse_odp_flags(const char *s, const char *(*bit_to_string)(uint32_t),
249 uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask)
251 return parse_flags(s, bit_to_string, ')', NULL, NULL,
252 res_flags, allowed, res_mask);
256 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
258 static const struct nl_policy ovs_userspace_policy[] = {
259 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
260 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_UNSPEC,
262 [OVS_USERSPACE_ATTR_EGRESS_TUN_PORT] = { .type = NL_A_U32,
264 [OVS_USERSPACE_ATTR_ACTIONS] = { .type = NL_A_UNSPEC,
267 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
268 const struct nlattr *userdata_attr;
269 const struct nlattr *tunnel_out_port_attr;
271 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
272 ds_put_cstr(ds, "userspace(error)");
276 ds_put_format(ds, "userspace(pid=%"PRIu32,
277 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
279 userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
282 const uint8_t *userdata = nl_attr_get(userdata_attr);
283 size_t userdata_len = nl_attr_get_size(userdata_attr);
284 bool userdata_unspec = true;
285 union user_action_cookie cookie;
287 if (userdata_len >= sizeof cookie.type
288 && userdata_len <= sizeof cookie) {
290 memset(&cookie, 0, sizeof cookie);
291 memcpy(&cookie, userdata, userdata_len);
293 userdata_unspec = false;
295 if (userdata_len == sizeof cookie.sflow
296 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
297 ds_put_format(ds, ",sFlow("
298 "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
299 vlan_tci_to_vid(cookie.sflow.vlan_tci),
300 vlan_tci_to_pcp(cookie.sflow.vlan_tci),
301 cookie.sflow.output);
302 } else if (userdata_len == sizeof cookie.slow_path
303 && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
304 ds_put_cstr(ds, ",slow_path(");
305 format_flags(ds, slow_path_reason_to_string,
306 cookie.slow_path.reason, ',');
307 ds_put_format(ds, ")");
308 } else if (userdata_len == sizeof cookie.flow_sample
309 && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
310 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
311 ",collector_set_id=%"PRIu32
312 ",obs_domain_id=%"PRIu32
313 ",obs_point_id=%"PRIu32")",
314 cookie.flow_sample.probability,
315 cookie.flow_sample.collector_set_id,
316 cookie.flow_sample.obs_domain_id,
317 cookie.flow_sample.obs_point_id);
318 } else if (userdata_len >= sizeof cookie.ipfix
319 && cookie.type == USER_ACTION_COOKIE_IPFIX) {
320 ds_put_format(ds, ",ipfix(output_port=%"PRIu32")",
321 cookie.ipfix.output_odp_port);
323 userdata_unspec = true;
327 if (userdata_unspec) {
329 ds_put_format(ds, ",userdata(");
330 for (i = 0; i < userdata_len; i++) {
331 ds_put_format(ds, "%02x", userdata[i]);
333 ds_put_char(ds, ')');
337 if (a[OVS_USERSPACE_ATTR_ACTIONS]) {
338 ds_put_cstr(ds, ",actions");
341 tunnel_out_port_attr = a[OVS_USERSPACE_ATTR_EGRESS_TUN_PORT];
342 if (tunnel_out_port_attr) {
343 ds_put_format(ds, ",tunnel_out_port=%"PRIu32,
344 nl_attr_get_u32(tunnel_out_port_attr));
347 ds_put_char(ds, ')');
351 format_vlan_tci(struct ds *ds, ovs_be16 tci, ovs_be16 mask, bool verbose)
353 if (verbose || vlan_tci_to_vid(tci) || vlan_tci_to_vid(mask)) {
354 ds_put_format(ds, "vid=%"PRIu16, vlan_tci_to_vid(tci));
355 if (vlan_tci_to_vid(mask) != VLAN_VID_MASK) { /* Partially masked. */
356 ds_put_format(ds, "/0x%"PRIx16, vlan_tci_to_vid(mask));
358 ds_put_char(ds, ',');
360 if (verbose || vlan_tci_to_pcp(tci) || vlan_tci_to_pcp(mask)) {
361 ds_put_format(ds, "pcp=%d", vlan_tci_to_pcp(tci));
362 if (vlan_tci_to_pcp(mask) != (VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
363 ds_put_format(ds, "/0x%x", vlan_tci_to_pcp(mask));
365 ds_put_char(ds, ',');
367 if (!(tci & htons(VLAN_CFI))) {
368 ds_put_cstr(ds, "cfi=0");
369 ds_put_char(ds, ',');
375 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
377 ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
378 mpls_lse_to_label(mpls_lse),
379 mpls_lse_to_tc(mpls_lse),
380 mpls_lse_to_ttl(mpls_lse),
381 mpls_lse_to_bos(mpls_lse));
385 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
386 const struct ovs_key_mpls *mpls_mask, int n)
389 ovs_be32 key = mpls_key->mpls_lse;
391 if (mpls_mask == NULL) {
392 format_mpls_lse(ds, key);
394 ovs_be32 mask = mpls_mask->mpls_lse;
396 ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
397 mpls_lse_to_label(key), mpls_lse_to_label(mask),
398 mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
399 mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
400 mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
405 for (i = 0; i < n; i++) {
406 ds_put_format(ds, "lse%d=%#"PRIx32,
407 i, ntohl(mpls_key[i].mpls_lse));
409 ds_put_format(ds, "/%#"PRIx32, ntohl(mpls_mask[i].mpls_lse));
411 ds_put_char(ds, ',');
418 format_odp_recirc_action(struct ds *ds, uint32_t recirc_id)
420 ds_put_format(ds, "recirc(%#"PRIx32")", recirc_id);
424 format_odp_hash_action(struct ds *ds, const struct ovs_action_hash *hash_act)
426 ds_put_format(ds, "hash(");
428 if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
429 ds_put_format(ds, "hash_l4(%"PRIu32")", hash_act->hash_basis);
431 ds_put_format(ds, "Unknown hash algorithm(%"PRIu32")",
434 ds_put_format(ds, ")");
438 format_udp_tnl_push_header(struct ds *ds, const struct ip_header *ip)
440 const struct udp_header *udp;
442 udp = (const struct udp_header *) (ip + 1);
443 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16",csum=0x%"PRIx16"),",
444 ntohs(udp->udp_src), ntohs(udp->udp_dst),
445 ntohs(udp->udp_csum));
451 format_odp_tnl_push_header(struct ds *ds, struct ovs_action_push_tnl *data)
453 const struct eth_header *eth;
454 const struct ip_header *ip;
457 eth = (const struct eth_header *)data->header;
460 ip = (const struct ip_header *)l3;
463 ds_put_format(ds, "header(size=%"PRIu8",type=%"PRIu8",eth(dst=",
464 data->header_len, data->tnl_type);
465 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_dst));
466 ds_put_format(ds, ",src=");
467 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_src));
468 ds_put_format(ds, ",dl_type=0x%04"PRIx16"),", ntohs(eth->eth_type));
471 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
472 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=0x%"PRIx16"),",
473 IP_ARGS(get_16aligned_be32(&ip->ip_src)),
474 IP_ARGS(get_16aligned_be32(&ip->ip_dst)),
475 ip->ip_proto, ip->ip_tos,
479 if (data->tnl_type == OVS_VPORT_TYPE_VXLAN) {
480 const struct vxlanhdr *vxh;
482 vxh = format_udp_tnl_push_header(ds, ip);
484 ds_put_format(ds, "vxlan(flags=0x%"PRIx32",vni=0x%"PRIx32")",
485 ntohl(get_16aligned_be32(&vxh->vx_flags)),
486 ntohl(get_16aligned_be32(&vxh->vx_vni)) >> 8);
487 } else if (data->tnl_type == OVS_VPORT_TYPE_GENEVE) {
488 const struct genevehdr *gnh;
490 gnh = format_udp_tnl_push_header(ds, ip);
492 ds_put_format(ds, "geneve(%s%svni=0x%"PRIx32,
493 gnh->oam ? "oam," : "",
494 gnh->critical ? "crit," : "",
495 ntohl(get_16aligned_be32(&gnh->vni)) >> 8);
498 ds_put_cstr(ds, ",options(");
499 format_geneve_opts(gnh->options, NULL, gnh->opt_len * 4,
501 ds_put_char(ds, ')');
504 ds_put_char(ds, ')');
505 } else if (data->tnl_type == OVS_VPORT_TYPE_GRE) {
506 const struct gre_base_hdr *greh;
507 ovs_16aligned_be32 *options;
510 l4 = ((uint8_t *)l3 + sizeof(struct ip_header));
511 greh = (const struct gre_base_hdr *) l4;
513 ds_put_format(ds, "gre((flags=0x%"PRIx16",proto=0x%"PRIx16")",
514 ntohs(greh->flags), ntohs(greh->protocol));
515 options = (ovs_16aligned_be32 *)(greh + 1);
516 if (greh->flags & htons(GRE_CSUM)) {
517 ds_put_format(ds, ",csum=0x%"PRIx16, ntohs(*((ovs_be16 *)options)));
520 if (greh->flags & htons(GRE_KEY)) {
521 ds_put_format(ds, ",key=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
524 if (greh->flags & htons(GRE_SEQ)) {
525 ds_put_format(ds, ",seq=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
528 ds_put_format(ds, ")");
530 ds_put_format(ds, ")");
534 format_odp_tnl_push_action(struct ds *ds, const struct nlattr *attr)
536 struct ovs_action_push_tnl *data;
538 data = (struct ovs_action_push_tnl *) nl_attr_get(attr);
540 ds_put_format(ds, "tnl_push(tnl_port(%"PRIu32"),", data->tnl_port);
541 format_odp_tnl_push_header(ds, data);
542 ds_put_format(ds, ",out_port(%"PRIu32"))", data->out_port);
545 static const struct nl_policy ovs_nat_policy[] = {
546 [OVS_NAT_ATTR_SRC] = { .type = NL_A_FLAG, .optional = true, },
547 [OVS_NAT_ATTR_DST] = { .type = NL_A_FLAG, .optional = true, },
548 [OVS_NAT_ATTR_IP_MIN] = { .type = NL_A_UNSPEC, .optional = true,
549 .min_len = sizeof(struct in_addr),
550 .max_len = sizeof(struct in6_addr)},
551 [OVS_NAT_ATTR_IP_MAX] = { .type = NL_A_UNSPEC, .optional = true,
552 .min_len = sizeof(struct in_addr),
553 .max_len = sizeof(struct in6_addr)},
554 [OVS_NAT_ATTR_PROTO_MIN] = { .type = NL_A_U16, .optional = true, },
555 [OVS_NAT_ATTR_PROTO_MAX] = { .type = NL_A_U16, .optional = true, },
556 [OVS_NAT_ATTR_PERSISTENT] = { .type = NL_A_FLAG, .optional = true, },
557 [OVS_NAT_ATTR_PROTO_HASH] = { .type = NL_A_FLAG, .optional = true, },
558 [OVS_NAT_ATTR_PROTO_RANDOM] = { .type = NL_A_FLAG, .optional = true, },
562 format_odp_ct_nat(struct ds *ds, const struct nlattr *attr)
564 struct nlattr *a[ARRAY_SIZE(ovs_nat_policy)];
566 ovs_be32 ip_min, ip_max;
567 struct in6_addr ip6_min, ip6_max;
568 uint16_t proto_min, proto_max;
570 if (!nl_parse_nested(attr, ovs_nat_policy, a, ARRAY_SIZE(a))) {
571 ds_put_cstr(ds, "nat(error: nl_parse_nested() failed.)");
574 /* If no type, then nothing else either. */
575 if (!(a[OVS_NAT_ATTR_SRC] || a[OVS_NAT_ATTR_DST])
576 && (a[OVS_NAT_ATTR_IP_MIN] || a[OVS_NAT_ATTR_IP_MAX]
577 || a[OVS_NAT_ATTR_PROTO_MIN] || a[OVS_NAT_ATTR_PROTO_MAX]
578 || a[OVS_NAT_ATTR_PERSISTENT] || a[OVS_NAT_ATTR_PROTO_HASH]
579 || a[OVS_NAT_ATTR_PROTO_RANDOM])) {
580 ds_put_cstr(ds, "nat(error: options allowed only with \"src\" or \"dst\")");
583 /* Both SNAT & DNAT may not be specified. */
584 if (a[OVS_NAT_ATTR_SRC] && a[OVS_NAT_ATTR_DST]) {
585 ds_put_cstr(ds, "nat(error: Only one of \"src\" or \"dst\" may be present.)");
588 /* proto may not appear without ip. */
589 if (!a[OVS_NAT_ATTR_IP_MIN] && a[OVS_NAT_ATTR_PROTO_MIN]) {
590 ds_put_cstr(ds, "nat(error: proto but no IP.)");
593 /* MAX may not appear without MIN. */
594 if ((!a[OVS_NAT_ATTR_IP_MIN] && a[OVS_NAT_ATTR_IP_MAX])
595 || (!a[OVS_NAT_ATTR_PROTO_MIN] && a[OVS_NAT_ATTR_PROTO_MAX])) {
596 ds_put_cstr(ds, "nat(error: range max without min.)");
599 /* Address sizes must match. */
600 if ((a[OVS_NAT_ATTR_IP_MIN]
601 && (nl_attr_get_size(a[OVS_NAT_ATTR_IP_MIN]) != sizeof(ovs_be32) &&
602 nl_attr_get_size(a[OVS_NAT_ATTR_IP_MIN]) != sizeof(struct in6_addr)))
603 || (a[OVS_NAT_ATTR_IP_MIN] && a[OVS_NAT_ATTR_IP_MAX]
604 && (nl_attr_get_size(a[OVS_NAT_ATTR_IP_MIN])
605 != nl_attr_get_size(a[OVS_NAT_ATTR_IP_MAX])))) {
606 ds_put_cstr(ds, "nat(error: IP address sizes do not match)");
610 addr_len = a[OVS_NAT_ATTR_IP_MIN]
611 ? nl_attr_get_size(a[OVS_NAT_ATTR_IP_MIN]) : 0;
612 ip_min = addr_len == sizeof(ovs_be32) && a[OVS_NAT_ATTR_IP_MIN]
613 ? nl_attr_get_be32(a[OVS_NAT_ATTR_IP_MIN]) : 0;
614 ip_max = addr_len == sizeof(ovs_be32) && a[OVS_NAT_ATTR_IP_MAX]
615 ? nl_attr_get_be32(a[OVS_NAT_ATTR_IP_MAX]) : 0;
616 if (addr_len == sizeof ip6_min) {
617 ip6_min = a[OVS_NAT_ATTR_IP_MIN]
618 ? *(struct in6_addr *)nl_attr_get(a[OVS_NAT_ATTR_IP_MIN])
620 ip6_max = a[OVS_NAT_ATTR_IP_MAX]
621 ? *(struct in6_addr *)nl_attr_get(a[OVS_NAT_ATTR_IP_MAX])
624 proto_min = a[OVS_NAT_ATTR_PROTO_MIN]
625 ? nl_attr_get_u16(a[OVS_NAT_ATTR_PROTO_MIN]) : 0;
626 proto_max = a[OVS_NAT_ATTR_PROTO_MAX]
627 ? nl_attr_get_u16(a[OVS_NAT_ATTR_PROTO_MAX]) : 0;
629 if ((addr_len == sizeof(ovs_be32)
630 && ip_max && ntohl(ip_min) > ntohl(ip_max))
631 || (addr_len == sizeof(struct in6_addr)
632 && !ipv6_mask_is_any(&ip6_max)
633 && memcmp(&ip6_min, &ip6_max, sizeof ip6_min) > 0)
634 || (proto_max && proto_min > proto_max)) {
635 ds_put_cstr(ds, "nat(range error)");
639 ds_put_cstr(ds, "nat");
640 if (a[OVS_NAT_ATTR_SRC] || a[OVS_NAT_ATTR_DST]) {
641 ds_put_char(ds, '(');
642 if (a[OVS_NAT_ATTR_SRC]) {
643 ds_put_cstr(ds, "src");
644 } else if (a[OVS_NAT_ATTR_DST]) {
645 ds_put_cstr(ds, "dst");
649 ds_put_cstr(ds, "=");
651 if (addr_len == sizeof ip_min) {
652 ds_put_format(ds, IP_FMT, IP_ARGS(ip_min));
654 if (ip_max && ip_max != ip_min) {
655 ds_put_format(ds, "-"IP_FMT, IP_ARGS(ip_max));
657 } else if (addr_len == sizeof ip6_min) {
658 ipv6_format_addr_bracket(&ip6_min, ds, proto_min);
660 if (!ipv6_mask_is_any(&ip6_max) &&
661 memcmp(&ip6_max, &ip6_min, sizeof ip6_max) != 0) {
662 ds_put_char(ds, '-');
663 ipv6_format_addr_bracket(&ip6_max, ds, proto_min);
667 ds_put_format(ds, ":%"PRIu16, proto_min);
669 if (proto_max && proto_max != proto_min) {
670 ds_put_format(ds, "-%"PRIu16, proto_max);
674 ds_put_char(ds, ',');
675 if (a[OVS_NAT_ATTR_PERSISTENT]) {
676 ds_put_cstr(ds, "persistent,");
678 if (a[OVS_NAT_ATTR_PROTO_HASH]) {
679 ds_put_cstr(ds, "hash,");
681 if (a[OVS_NAT_ATTR_PROTO_RANDOM]) {
682 ds_put_cstr(ds, "random,");
685 ds_put_char(ds, ')');
689 static const struct nl_policy ovs_conntrack_policy[] = {
690 [OVS_CT_ATTR_COMMIT] = { .type = NL_A_FLAG, .optional = true, },
691 [OVS_CT_ATTR_ZONE] = { .type = NL_A_U16, .optional = true, },
692 [OVS_CT_ATTR_MARK] = { .type = NL_A_UNSPEC, .optional = true,
693 .min_len = sizeof(uint32_t) * 2 },
694 [OVS_CT_ATTR_LABELS] = { .type = NL_A_UNSPEC, .optional = true,
695 .min_len = sizeof(struct ovs_key_ct_labels) * 2 },
696 [OVS_CT_ATTR_HELPER] = { .type = NL_A_STRING, .optional = true,
697 .min_len = 1, .max_len = 16 },
698 [OVS_CT_ATTR_NAT] = { .type = NL_A_UNSPEC, .optional = true },
702 format_odp_conntrack_action(struct ds *ds, const struct nlattr *attr)
704 struct nlattr *a[ARRAY_SIZE(ovs_conntrack_policy)];
705 const ovs_u128 *label;
706 const uint32_t *mark;
710 const struct nlattr *nat;
712 if (!nl_parse_nested(attr, ovs_conntrack_policy, a, ARRAY_SIZE(a))) {
713 ds_put_cstr(ds, "ct(error)");
717 commit = a[OVS_CT_ATTR_COMMIT] ? true : false;
718 zone = a[OVS_CT_ATTR_ZONE] ? nl_attr_get_u16(a[OVS_CT_ATTR_ZONE]) : 0;
719 mark = a[OVS_CT_ATTR_MARK] ? nl_attr_get(a[OVS_CT_ATTR_MARK]) : NULL;
720 label = a[OVS_CT_ATTR_LABELS] ? nl_attr_get(a[OVS_CT_ATTR_LABELS]): NULL;
721 helper = a[OVS_CT_ATTR_HELPER] ? nl_attr_get(a[OVS_CT_ATTR_HELPER]) : NULL;
722 nat = a[OVS_CT_ATTR_NAT];
724 ds_put_format(ds, "ct");
725 if (commit || zone || mark || label || helper || nat) {
726 ds_put_cstr(ds, "(");
728 ds_put_format(ds, "commit,");
731 ds_put_format(ds, "zone=%"PRIu16",", zone);
734 ds_put_format(ds, "mark=%#"PRIx32"/%#"PRIx32",", *mark,
738 ds_put_format(ds, "label=");
739 format_u128(ds, label, label + 1, true);
740 ds_put_char(ds, ',');
743 ds_put_format(ds, "helper=%s,", helper);
746 format_odp_ct_nat(ds, nat);
749 ds_put_cstr(ds, ")");
754 format_odp_action(struct ds *ds, const struct nlattr *a)
757 enum ovs_action_attr type = nl_attr_type(a);
758 const struct ovs_action_push_vlan *vlan;
761 expected_len = odp_action_len(nl_attr_type(a));
762 if (expected_len != ATTR_LEN_VARIABLE &&
763 nl_attr_get_size(a) != expected_len) {
764 ds_put_format(ds, "bad length %"PRIuSIZE", expected %d for: ",
765 nl_attr_get_size(a), expected_len);
766 format_generic_odp_action(ds, a);
771 case OVS_ACTION_ATTR_OUTPUT:
772 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
774 case OVS_ACTION_ATTR_TUNNEL_POP:
775 ds_put_format(ds, "tnl_pop(%"PRIu32")", nl_attr_get_u32(a));
777 case OVS_ACTION_ATTR_TUNNEL_PUSH:
778 format_odp_tnl_push_action(ds, a);
780 case OVS_ACTION_ATTR_USERSPACE:
781 format_odp_userspace_action(ds, a);
783 case OVS_ACTION_ATTR_RECIRC:
784 format_odp_recirc_action(ds, nl_attr_get_u32(a));
786 case OVS_ACTION_ATTR_HASH:
787 format_odp_hash_action(ds, nl_attr_get(a));
789 case OVS_ACTION_ATTR_SET_MASKED:
791 size = nl_attr_get_size(a) / 2;
792 ds_put_cstr(ds, "set(");
794 /* Masked set action not supported for tunnel key, which is bigger. */
795 if (size <= sizeof(struct ovs_key_ipv6)) {
796 struct nlattr attr[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
797 sizeof(struct nlattr))];
798 struct nlattr mask[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
799 sizeof(struct nlattr))];
801 mask->nla_type = attr->nla_type = nl_attr_type(a);
802 mask->nla_len = attr->nla_len = NLA_HDRLEN + size;
803 memcpy(attr + 1, (char *)(a + 1), size);
804 memcpy(mask + 1, (char *)(a + 1) + size, size);
805 format_odp_key_attr(attr, mask, NULL, ds, false);
807 format_odp_key_attr(a, NULL, NULL, ds, false);
809 ds_put_cstr(ds, ")");
811 case OVS_ACTION_ATTR_SET:
812 ds_put_cstr(ds, "set(");
813 format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
814 ds_put_cstr(ds, ")");
816 case OVS_ACTION_ATTR_PUSH_VLAN:
817 vlan = nl_attr_get(a);
818 ds_put_cstr(ds, "push_vlan(");
819 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
820 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
822 format_vlan_tci(ds, vlan->vlan_tci, OVS_BE16_MAX, false);
823 ds_put_char(ds, ')');
825 case OVS_ACTION_ATTR_POP_VLAN:
826 ds_put_cstr(ds, "pop_vlan");
828 case OVS_ACTION_ATTR_PUSH_MPLS: {
829 const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
830 ds_put_cstr(ds, "push_mpls(");
831 format_mpls_lse(ds, mpls->mpls_lse);
832 ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
835 case OVS_ACTION_ATTR_POP_MPLS: {
836 ovs_be16 ethertype = nl_attr_get_be16(a);
837 ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
840 case OVS_ACTION_ATTR_SAMPLE:
841 format_odp_sample_action(ds, a);
843 case OVS_ACTION_ATTR_CT:
844 format_odp_conntrack_action(ds, a);
846 case OVS_ACTION_ATTR_UNSPEC:
847 case __OVS_ACTION_ATTR_MAX:
849 format_generic_odp_action(ds, a);
855 format_odp_actions(struct ds *ds, const struct nlattr *actions,
859 const struct nlattr *a;
862 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
864 ds_put_char(ds, ',');
866 format_odp_action(ds, a);
871 if (left == actions_len) {
872 ds_put_cstr(ds, "<empty>");
874 ds_put_format(ds, ",***%u leftover bytes*** (", left);
875 for (i = 0; i < left; i++) {
876 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
878 ds_put_char(ds, ')');
881 ds_put_cstr(ds, "drop");
885 /* Separate out parse_odp_userspace_action() function. */
887 parse_odp_userspace_action(const char *s, struct ofpbuf *actions)
890 union user_action_cookie cookie;
892 odp_port_t tunnel_out_port;
894 void *user_data = NULL;
895 size_t user_data_size = 0;
896 bool include_actions = false;
898 if (!ovs_scan(s, "userspace(pid=%"SCNi32"%n", &pid, &n)) {
904 uint32_t probability;
905 uint32_t collector_set_id;
906 uint32_t obs_domain_id;
907 uint32_t obs_point_id;
910 if (ovs_scan(&s[n], ",sFlow(vid=%i,"
911 "pcp=%i,output=%"SCNi32")%n",
912 &vid, &pcp, &output, &n1)) {
916 tci = vid | (pcp << VLAN_PCP_SHIFT);
921 cookie.type = USER_ACTION_COOKIE_SFLOW;
922 cookie.sflow.vlan_tci = htons(tci);
923 cookie.sflow.output = output;
925 user_data_size = sizeof cookie.sflow;
926 } else if (ovs_scan(&s[n], ",slow_path(%n",
931 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
932 cookie.slow_path.unused = 0;
933 cookie.slow_path.reason = 0;
935 res = parse_odp_flags(&s[n], slow_path_reason_to_string,
936 &cookie.slow_path.reason,
937 SLOW_PATH_REASON_MASK, NULL);
938 if (res < 0 || s[n + res] != ')') {
944 user_data_size = sizeof cookie.slow_path;
945 } else if (ovs_scan(&s[n], ",flow_sample(probability=%"SCNi32","
946 "collector_set_id=%"SCNi32","
947 "obs_domain_id=%"SCNi32","
948 "obs_point_id=%"SCNi32")%n",
949 &probability, &collector_set_id,
950 &obs_domain_id, &obs_point_id, &n1)) {
953 cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
954 cookie.flow_sample.probability = probability;
955 cookie.flow_sample.collector_set_id = collector_set_id;
956 cookie.flow_sample.obs_domain_id = obs_domain_id;
957 cookie.flow_sample.obs_point_id = obs_point_id;
959 user_data_size = sizeof cookie.flow_sample;
960 } else if (ovs_scan(&s[n], ",ipfix(output_port=%"SCNi32")%n",
963 cookie.type = USER_ACTION_COOKIE_IPFIX;
964 cookie.ipfix.output_odp_port = u32_to_odp(output);
966 user_data_size = sizeof cookie.ipfix;
967 } else if (ovs_scan(&s[n], ",userdata(%n",
972 ofpbuf_init(&buf, 16);
973 end = ofpbuf_put_hex(&buf, &s[n], NULL);
977 user_data = buf.data;
978 user_data_size = buf.size;
985 if (ovs_scan(&s[n], ",actions%n", &n1)) {
987 include_actions = true;
993 if (ovs_scan(&s[n], ",tunnel_out_port=%"SCNi32")%n",
994 &tunnel_out_port, &n1)) {
995 odp_put_userspace_action(pid, user_data, user_data_size,
996 tunnel_out_port, include_actions, actions);
998 } else if (s[n] == ')') {
999 odp_put_userspace_action(pid, user_data, user_data_size,
1000 ODPP_NONE, include_actions, actions);
1009 ovs_parse_tnl_push(const char *s, struct ovs_action_push_tnl *data)
1011 struct eth_header *eth;
1012 struct ip_header *ip;
1013 struct udp_header *udp;
1014 struct gre_base_hdr *greh;
1015 uint16_t gre_proto, gre_flags, dl_type, udp_src, udp_dst, csum;
1017 uint32_t tnl_type = 0, header_len = 0;
1021 if (!ovs_scan_len(s, &n, "tnl_push(tnl_port(%"SCNi32"),", &data->tnl_port)) {
1024 eth = (struct eth_header *) data->header;
1025 l3 = (data->header + sizeof *eth);
1026 l4 = ((uint8_t *) l3 + sizeof (struct ip_header));
1027 ip = (struct ip_header *) l3;
1028 if (!ovs_scan_len(s, &n, "header(size=%"SCNi32",type=%"SCNi32","
1029 "eth(dst="ETH_ADDR_SCAN_FMT",",
1032 ETH_ADDR_SCAN_ARGS(eth->eth_dst))) {
1036 if (!ovs_scan_len(s, &n, "src="ETH_ADDR_SCAN_FMT",",
1037 ETH_ADDR_SCAN_ARGS(eth->eth_src))) {
1040 if (!ovs_scan_len(s, &n, "dl_type=0x%"SCNx16"),", &dl_type)) {
1043 eth->eth_type = htons(dl_type);
1046 if (!ovs_scan_len(s, &n, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT",proto=%"SCNi8
1047 ",tos=%"SCNi8",ttl=%"SCNi8",frag=0x%"SCNx16"),",
1050 &ip->ip_proto, &ip->ip_tos,
1051 &ip->ip_ttl, &ip->ip_frag_off)) {
1054 put_16aligned_be32(&ip->ip_src, sip);
1055 put_16aligned_be32(&ip->ip_dst, dip);
1058 udp = (struct udp_header *) l4;
1059 greh = (struct gre_base_hdr *) l4;
1060 if (ovs_scan_len(s, &n, "udp(src=%"SCNi16",dst=%"SCNi16",csum=0x%"SCNx16"),",
1061 &udp_src, &udp_dst, &csum)) {
1062 uint32_t vx_flags, vni;
1064 udp->udp_src = htons(udp_src);
1065 udp->udp_dst = htons(udp_dst);
1067 udp->udp_csum = htons(csum);
1069 if (ovs_scan_len(s, &n, "vxlan(flags=0x%"SCNx32",vni=0x%"SCNx32"))",
1071 struct vxlanhdr *vxh = (struct vxlanhdr *) (udp + 1);
1073 put_16aligned_be32(&vxh->vx_flags, htonl(vx_flags));
1074 put_16aligned_be32(&vxh->vx_vni, htonl(vni << 8));
1075 tnl_type = OVS_VPORT_TYPE_VXLAN;
1076 header_len = sizeof *eth + sizeof *ip +
1077 sizeof *udp + sizeof *vxh;
1078 } else if (ovs_scan_len(s, &n, "geneve(")) {
1079 struct genevehdr *gnh = (struct genevehdr *) (udp + 1);
1081 memset(gnh, 0, sizeof *gnh);
1082 header_len = sizeof *eth + sizeof *ip +
1083 sizeof *udp + sizeof *gnh;
1085 if (ovs_scan_len(s, &n, "oam,")) {
1088 if (ovs_scan_len(s, &n, "crit,")) {
1091 if (!ovs_scan_len(s, &n, "vni=%"SCNi32, &vni)) {
1094 if (ovs_scan_len(s, &n, ",options(")) {
1095 struct geneve_scan options;
1098 memset(&options, 0, sizeof options);
1099 len = scan_geneve(s + n, &options, NULL);
1104 memcpy(gnh->options, options.d, options.len);
1105 gnh->opt_len = options.len / 4;
1106 header_len += options.len;
1110 if (!ovs_scan_len(s, &n, "))")) {
1114 gnh->proto_type = htons(ETH_TYPE_TEB);
1115 put_16aligned_be32(&gnh->vni, htonl(vni << 8));
1116 tnl_type = OVS_VPORT_TYPE_GENEVE;
1120 } else if (ovs_scan_len(s, &n, "gre((flags=0x%"SCNx16",proto=0x%"SCNx16")",
1121 &gre_flags, &gre_proto)){
1123 tnl_type = OVS_VPORT_TYPE_GRE;
1124 greh->flags = htons(gre_flags);
1125 greh->protocol = htons(gre_proto);
1126 ovs_16aligned_be32 *options = (ovs_16aligned_be32 *) (greh + 1);
1128 if (greh->flags & htons(GRE_CSUM)) {
1129 if (!ovs_scan_len(s, &n, ",csum=0x%"SCNx16, &csum)) {
1133 memset(options, 0, sizeof *options);
1134 *((ovs_be16 *)options) = htons(csum);
1137 if (greh->flags & htons(GRE_KEY)) {
1140 if (!ovs_scan_len(s, &n, ",key=0x%"SCNx32, &key)) {
1144 put_16aligned_be32(options, htonl(key));
1147 if (greh->flags & htons(GRE_SEQ)) {
1150 if (!ovs_scan_len(s, &n, ",seq=0x%"SCNx32, &seq)) {
1153 put_16aligned_be32(options, htonl(seq));
1157 if (!ovs_scan_len(s, &n, "))")) {
1161 header_len = sizeof *eth + sizeof *ip +
1162 ((uint8_t *) options - (uint8_t *) greh);
1167 /* check tunnel meta data. */
1168 if (data->tnl_type != tnl_type) {
1171 if (data->header_len != header_len) {
1176 if (!ovs_scan_len(s, &n, ",out_port(%"SCNi32"))", &data->out_port)) {
1183 struct ct_nat_params {
1189 struct in6_addr ip6;
1193 struct in6_addr ip6;
1203 scan_ct_nat_range(const char *s, int *n, struct ct_nat_params *p)
1205 if (ovs_scan_len(s, n, "=")) {
1206 char ipv6_s[IPV6_SCAN_LEN + 1];
1207 struct in6_addr ipv6;
1209 if (ovs_scan_len(s, n, IP_SCAN_FMT, IP_SCAN_ARGS(&p->addr_min.ip))) {
1210 p->addr_len = sizeof p->addr_min.ip;
1211 if (ovs_scan_len(s, n, "-")) {
1212 if (!ovs_scan_len(s, n, IP_SCAN_FMT,
1213 IP_SCAN_ARGS(&p->addr_max.ip))) {
1217 } else if ((ovs_scan_len(s, n, IPV6_SCAN_FMT, ipv6_s)
1218 || ovs_scan_len(s, n, "["IPV6_SCAN_FMT"]", ipv6_s))
1219 && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
1220 p->addr_len = sizeof p->addr_min.ip6;
1221 p->addr_min.ip6 = ipv6;
1222 if (ovs_scan_len(s, n, "-")) {
1223 if ((ovs_scan_len(s, n, IPV6_SCAN_FMT, ipv6_s)
1224 || ovs_scan_len(s, n, "["IPV6_SCAN_FMT"]", ipv6_s))
1225 && inet_pton(AF_INET6, ipv6_s, &ipv6) == 1) {
1226 p->addr_max.ip6 = ipv6;
1234 if (ovs_scan_len(s, n, ":%"SCNu16, &p->proto_min)) {
1235 if (ovs_scan_len(s, n, "-")) {
1236 if (!ovs_scan_len(s, n, "%"SCNu16, &p->proto_max)) {
1246 scan_ct_nat(const char *s, struct ct_nat_params *p)
1250 if (ovs_scan_len(s, &n, "nat")) {
1251 memset(p, 0, sizeof *p);
1253 if (ovs_scan_len(s, &n, "(")) {
1257 end = strchr(s + n, ')');
1264 n += strspn(s + n, delimiters);
1265 if (ovs_scan_len(s, &n, "src")) {
1266 int err = scan_ct_nat_range(s, &n, p);
1273 if (ovs_scan_len(s, &n, "dst")) {
1274 int err = scan_ct_nat_range(s, &n, p);
1281 if (ovs_scan_len(s, &n, "persistent")) {
1282 p->persistent = true;
1285 if (ovs_scan_len(s, &n, "hash")) {
1286 p->proto_hash = true;
1289 if (ovs_scan_len(s, &n, "random")) {
1290 p->proto_random = true;
1296 if (p->snat && p->dnat) {
1299 if ((p->addr_len != 0 &&
1300 memcmp(&p->addr_max, &in6addr_any, p->addr_len) &&
1301 memcmp(&p->addr_max, &p->addr_min, p->addr_len) < 0) ||
1302 (p->proto_max && p->proto_max < p->proto_min)) {
1305 if (p->proto_hash && p->proto_random) {
1315 nl_msg_put_ct_nat(struct ct_nat_params *p, struct ofpbuf *actions)
1317 size_t start = nl_msg_start_nested(actions, OVS_CT_ATTR_NAT);
1320 nl_msg_put_flag(actions, OVS_NAT_ATTR_SRC);
1321 } else if (p->dnat) {
1322 nl_msg_put_flag(actions, OVS_NAT_ATTR_DST);
1326 if (p->addr_len != 0) {
1327 nl_msg_put_unspec(actions, OVS_NAT_ATTR_IP_MIN, &p->addr_min,
1329 if (memcmp(&p->addr_max, &p->addr_min, p->addr_len) > 0) {
1330 nl_msg_put_unspec(actions, OVS_NAT_ATTR_IP_MAX, &p->addr_max,
1334 nl_msg_put_u16(actions, OVS_NAT_ATTR_PROTO_MIN, p->proto_min);
1335 if (p->proto_max && p->proto_max > p->proto_min) {
1336 nl_msg_put_u16(actions, OVS_NAT_ATTR_PROTO_MAX, p->proto_max);
1339 if (p->persistent) {
1340 nl_msg_put_flag(actions, OVS_NAT_ATTR_PERSISTENT);
1342 if (p->proto_hash) {
1343 nl_msg_put_flag(actions, OVS_NAT_ATTR_PROTO_HASH);
1345 if (p->proto_random) {
1346 nl_msg_put_flag(actions, OVS_NAT_ATTR_PROTO_RANDOM);
1350 nl_msg_end_nested(actions, start);
1354 parse_conntrack_action(const char *s_, struct ofpbuf *actions)
1358 if (ovs_scan(s, "ct")) {
1359 const char *helper = NULL;
1360 size_t helper_len = 0;
1361 bool commit = false;
1366 } ct_mark = { 0, 0 };
1371 struct ct_nat_params nat_params;
1372 bool have_nat = false;
1376 memset(&ct_label, 0, sizeof(ct_label));
1379 if (ovs_scan(s, "(")) {
1382 end = strchr(s, ')');
1390 s += strspn(s, delimiters);
1391 if (ovs_scan(s, "commit%n", &n)) {
1396 if (ovs_scan(s, "zone=%"SCNu16"%n", &zone, &n)) {
1400 if (ovs_scan(s, "mark=%"SCNx32"%n", &ct_mark.value, &n)) {
1403 if (ovs_scan(s, "/%"SCNx32"%n", &ct_mark.mask, &n)) {
1406 ct_mark.mask = UINT32_MAX;
1410 if (ovs_scan(s, "label=%n", &n)) {
1414 retval = scan_u128(s, &ct_label.value, &ct_label.mask);
1421 if (ovs_scan(s, "helper=%n", &n)) {
1423 helper_len = strcspn(s, delimiters_end);
1424 if (!helper_len || helper_len > 15) {
1432 n = scan_ct_nat(s, &nat_params);
1437 /* end points to the end of the nested, nat action.
1438 * find the real end. */
1441 /* Nothing matched. */
1447 start = nl_msg_start_nested(actions, OVS_ACTION_ATTR_CT);
1449 nl_msg_put_flag(actions, OVS_CT_ATTR_COMMIT);
1452 nl_msg_put_u16(actions, OVS_CT_ATTR_ZONE, zone);
1455 nl_msg_put_unspec(actions, OVS_CT_ATTR_MARK, &ct_mark,
1458 if (!ovs_u128_is_zero(&ct_label.mask)) {
1459 nl_msg_put_unspec(actions, OVS_CT_ATTR_LABELS, &ct_label,
1463 nl_msg_put_string__(actions, OVS_CT_ATTR_HELPER, helper,
1467 nl_msg_put_ct_nat(&nat_params, actions);
1469 nl_msg_end_nested(actions, start);
1476 parse_odp_action(const char *s, const struct simap *port_names,
1477 struct ofpbuf *actions)
1483 if (ovs_scan(s, "%"SCNi32"%n", &port, &n)) {
1484 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
1490 int len = strcspn(s, delimiters);
1491 struct simap_node *node;
1493 node = simap_find_len(port_names, s, len);
1495 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
1504 if (ovs_scan(s, "recirc(%"PRIu32")%n", &recirc_id, &n)) {
1505 nl_msg_put_u32(actions, OVS_ACTION_ATTR_RECIRC, recirc_id);
1510 if (!strncmp(s, "userspace(", 10)) {
1511 return parse_odp_userspace_action(s, actions);
1514 if (!strncmp(s, "set(", 4)) {
1517 struct nlattr mask[128 / sizeof(struct nlattr)];
1518 struct ofpbuf maskbuf;
1519 struct nlattr *nested, *key;
1522 /* 'mask' is big enough to hold any key. */
1523 ofpbuf_use_stack(&maskbuf, mask, sizeof mask);
1525 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
1526 retval = parse_odp_key_mask_attr(s + 4, port_names, actions, &maskbuf);
1530 if (s[retval + 4] != ')') {
1534 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1537 size = nl_attr_get_size(mask);
1538 if (size == nl_attr_get_size(key)) {
1539 /* Change to masked set action if not fully masked. */
1540 if (!is_all_ones(mask + 1, size)) {
1541 key->nla_len += size;
1542 ofpbuf_put(actions, mask + 1, size);
1543 /* 'actions' may have been reallocated by ofpbuf_put(). */
1544 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1545 nested->nla_type = OVS_ACTION_ATTR_SET_MASKED;
1549 nl_msg_end_nested(actions, start_ofs);
1554 struct ovs_action_push_vlan push;
1555 int tpid = ETH_TYPE_VLAN;
1560 if (ovs_scan(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)
1561 || ovs_scan(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
1562 &vid, &pcp, &cfi, &n)
1563 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
1564 &tpid, &vid, &pcp, &n)
1565 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
1566 &tpid, &vid, &pcp, &cfi, &n)) {
1567 push.vlan_tpid = htons(tpid);
1568 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
1569 | (pcp << VLAN_PCP_SHIFT)
1570 | (cfi ? VLAN_CFI : 0));
1571 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
1572 &push, sizeof push);
1578 if (!strncmp(s, "pop_vlan", 8)) {
1579 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
1587 if (ovs_scan(s, "sample(sample=%lf%%,actions(%n", &percentage, &n)
1588 && percentage >= 0. && percentage <= 100.0) {
1589 size_t sample_ofs, actions_ofs;
1592 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
1593 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
1594 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
1595 (probability <= 0 ? 0
1596 : probability >= UINT32_MAX ? UINT32_MAX
1599 actions_ofs = nl_msg_start_nested(actions,
1600 OVS_SAMPLE_ATTR_ACTIONS);
1604 n += strspn(s + n, delimiters);
1609 retval = parse_odp_action(s + n, port_names, actions);
1615 nl_msg_end_nested(actions, actions_ofs);
1616 nl_msg_end_nested(actions, sample_ofs);
1618 return s[n + 1] == ')' ? n + 2 : -EINVAL;
1626 if (ovs_scan(s, "tnl_pop(%"SCNi32")%n", &port, &n)) {
1627 nl_msg_put_u32(actions, OVS_ACTION_ATTR_TUNNEL_POP, port);
1635 retval = parse_conntrack_action(s, actions);
1642 struct ovs_action_push_tnl data;
1645 n = ovs_parse_tnl_push(s, &data);
1647 odp_put_tnl_push_action(actions, &data);
1656 /* Parses the string representation of datapath actions, in the format output
1657 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
1658 * value. On success, the ODP actions are appended to 'actions' as a series of
1659 * Netlink attributes. On failure, no data is appended to 'actions'. Either
1660 * way, 'actions''s data might be reallocated. */
1662 odp_actions_from_string(const char *s, const struct simap *port_names,
1663 struct ofpbuf *actions)
1667 if (!strcasecmp(s, "drop")) {
1671 old_size = actions->size;
1675 s += strspn(s, delimiters);
1680 retval = parse_odp_action(s, port_names, actions);
1681 if (retval < 0 || !strchr(delimiters, s[retval])) {
1682 actions->size = old_size;
1691 static const struct attr_len_tbl ovs_vxlan_ext_attr_lens[OVS_VXLAN_EXT_MAX + 1] = {
1692 [OVS_VXLAN_EXT_GBP] = { .len = 4 },
1695 static const struct attr_len_tbl ovs_tun_key_attr_lens[OVS_TUNNEL_KEY_ATTR_MAX + 1] = {
1696 [OVS_TUNNEL_KEY_ATTR_ID] = { .len = 8 },
1697 [OVS_TUNNEL_KEY_ATTR_IPV4_SRC] = { .len = 4 },
1698 [OVS_TUNNEL_KEY_ATTR_IPV4_DST] = { .len = 4 },
1699 [OVS_TUNNEL_KEY_ATTR_TOS] = { .len = 1 },
1700 [OVS_TUNNEL_KEY_ATTR_TTL] = { .len = 1 },
1701 [OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT] = { .len = 0 },
1702 [OVS_TUNNEL_KEY_ATTR_CSUM] = { .len = 0 },
1703 [OVS_TUNNEL_KEY_ATTR_TP_SRC] = { .len = 2 },
1704 [OVS_TUNNEL_KEY_ATTR_TP_DST] = { .len = 2 },
1705 [OVS_TUNNEL_KEY_ATTR_OAM] = { .len = 0 },
1706 [OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS] = { .len = ATTR_LEN_VARIABLE },
1707 [OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS] = { .len = ATTR_LEN_NESTED,
1708 .next = ovs_vxlan_ext_attr_lens ,
1709 .next_max = OVS_VXLAN_EXT_MAX},
1712 static const struct attr_len_tbl ovs_flow_key_attr_lens[OVS_KEY_ATTR_MAX + 1] = {
1713 [OVS_KEY_ATTR_ENCAP] = { .len = ATTR_LEN_NESTED },
1714 [OVS_KEY_ATTR_PRIORITY] = { .len = 4 },
1715 [OVS_KEY_ATTR_SKB_MARK] = { .len = 4 },
1716 [OVS_KEY_ATTR_DP_HASH] = { .len = 4 },
1717 [OVS_KEY_ATTR_RECIRC_ID] = { .len = 4 },
1718 [OVS_KEY_ATTR_TUNNEL] = { .len = ATTR_LEN_NESTED,
1719 .next = ovs_tun_key_attr_lens,
1720 .next_max = OVS_TUNNEL_KEY_ATTR_MAX },
1721 [OVS_KEY_ATTR_IN_PORT] = { .len = 4 },
1722 [OVS_KEY_ATTR_ETHERNET] = { .len = sizeof(struct ovs_key_ethernet) },
1723 [OVS_KEY_ATTR_VLAN] = { .len = 2 },
1724 [OVS_KEY_ATTR_ETHERTYPE] = { .len = 2 },
1725 [OVS_KEY_ATTR_MPLS] = { .len = ATTR_LEN_VARIABLE },
1726 [OVS_KEY_ATTR_IPV4] = { .len = sizeof(struct ovs_key_ipv4) },
1727 [OVS_KEY_ATTR_IPV6] = { .len = sizeof(struct ovs_key_ipv6) },
1728 [OVS_KEY_ATTR_TCP] = { .len = sizeof(struct ovs_key_tcp) },
1729 [OVS_KEY_ATTR_TCP_FLAGS] = { .len = 2 },
1730 [OVS_KEY_ATTR_UDP] = { .len = sizeof(struct ovs_key_udp) },
1731 [OVS_KEY_ATTR_SCTP] = { .len = sizeof(struct ovs_key_sctp) },
1732 [OVS_KEY_ATTR_ICMP] = { .len = sizeof(struct ovs_key_icmp) },
1733 [OVS_KEY_ATTR_ICMPV6] = { .len = sizeof(struct ovs_key_icmpv6) },
1734 [OVS_KEY_ATTR_ARP] = { .len = sizeof(struct ovs_key_arp) },
1735 [OVS_KEY_ATTR_ND] = { .len = sizeof(struct ovs_key_nd) },
1736 [OVS_KEY_ATTR_CT_STATE] = { .len = 4 },
1737 [OVS_KEY_ATTR_CT_ZONE] = { .len = 2 },
1738 [OVS_KEY_ATTR_CT_MARK] = { .len = 4 },
1739 [OVS_KEY_ATTR_CT_LABELS] = { .len = sizeof(struct ovs_key_ct_labels) },
1742 /* Returns the correct length of the payload for a flow key attribute of the
1743 * specified 'type', ATTR_LEN_INVALID if 'type' is unknown, ATTR_LEN_VARIABLE
1744 * if the attribute's payload is variable length, or ATTR_LEN_NESTED if the
1745 * payload is a nested type. */
1747 odp_key_attr_len(const struct attr_len_tbl tbl[], int max_len, uint16_t type)
1749 if (type > max_len) {
1750 return ATTR_LEN_INVALID;
1753 return tbl[type].len;
1757 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
1759 size_t len = nl_attr_get_size(a);
1761 const uint8_t *unspec;
1764 unspec = nl_attr_get(a);
1765 for (i = 0; i < len; i++) {
1767 ds_put_char(ds, ' ');
1769 ds_put_format(ds, "%02x", unspec[i]);
1775 ovs_frag_type_to_string(enum ovs_frag_type type)
1778 case OVS_FRAG_TYPE_NONE:
1780 case OVS_FRAG_TYPE_FIRST:
1782 case OVS_FRAG_TYPE_LATER:
1784 case __OVS_FRAG_TYPE_MAX:
1790 static enum odp_key_fitness
1791 odp_tun_key_from_attr__(const struct nlattr *attr,
1792 const struct nlattr *flow_attrs, size_t flow_attr_len,
1793 const struct flow_tnl *src_tun, struct flow_tnl *tun,
1797 const struct nlattr *a;
1799 bool unknown = false;
1801 NL_NESTED_FOR_EACH(a, left, attr) {
1802 uint16_t type = nl_attr_type(a);
1803 size_t len = nl_attr_get_size(a);
1804 int expected_len = odp_key_attr_len(ovs_tun_key_attr_lens,
1805 OVS_TUNNEL_ATTR_MAX, type);
1807 if (len != expected_len && expected_len >= 0) {
1808 return ODP_FIT_ERROR;
1812 case OVS_TUNNEL_KEY_ATTR_ID:
1813 tun->tun_id = nl_attr_get_be64(a);
1814 tun->flags |= FLOW_TNL_F_KEY;
1816 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1817 tun->ip_src = nl_attr_get_be32(a);
1819 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
1820 tun->ip_dst = nl_attr_get_be32(a);
1822 case OVS_TUNNEL_KEY_ATTR_TOS:
1823 tun->ip_tos = nl_attr_get_u8(a);
1825 case OVS_TUNNEL_KEY_ATTR_TTL:
1826 tun->ip_ttl = nl_attr_get_u8(a);
1829 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
1830 tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
1832 case OVS_TUNNEL_KEY_ATTR_CSUM:
1833 tun->flags |= FLOW_TNL_F_CSUM;
1835 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
1836 tun->tp_src = nl_attr_get_be16(a);
1838 case OVS_TUNNEL_KEY_ATTR_TP_DST:
1839 tun->tp_dst = nl_attr_get_be16(a);
1841 case OVS_TUNNEL_KEY_ATTR_OAM:
1842 tun->flags |= FLOW_TNL_F_OAM;
1844 case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS: {
1845 static const struct nl_policy vxlan_opts_policy[] = {
1846 [OVS_VXLAN_EXT_GBP] = { .type = NL_A_U32 },
1848 struct nlattr *ext[ARRAY_SIZE(vxlan_opts_policy)];
1850 if (!nl_parse_nested(a, vxlan_opts_policy, ext, ARRAY_SIZE(ext))) {
1851 return ODP_FIT_ERROR;
1854 if (ext[OVS_VXLAN_EXT_GBP]) {
1855 uint32_t gbp = nl_attr_get_u32(ext[OVS_VXLAN_EXT_GBP]);
1857 tun->gbp_id = htons(gbp & 0xFFFF);
1858 tun->gbp_flags = (gbp >> 16) & 0xFF;
1863 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
1864 if (tun_metadata_from_geneve_nlattr(a, flow_attrs, flow_attr_len,
1865 src_tun, udpif, tun)) {
1866 return ODP_FIT_ERROR;
1871 /* Allow this to show up as unexpected, if there are unknown
1872 * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
1879 return ODP_FIT_ERROR;
1882 return ODP_FIT_TOO_MUCH;
1884 return ODP_FIT_PERFECT;
1887 enum odp_key_fitness
1888 odp_tun_key_from_attr(const struct nlattr *attr, bool udpif,
1889 struct flow_tnl *tun)
1891 memset(tun, 0, sizeof *tun);
1892 return odp_tun_key_from_attr__(attr, NULL, 0, NULL, tun, udpif);
1896 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key,
1897 const struct flow_tnl *tun_flow_key,
1898 const struct ofpbuf *key_buf)
1902 tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
1904 /* tun_id != 0 without FLOW_TNL_F_KEY is valid if tun_key is a mask. */
1905 if (tun_key->tun_id || tun_key->flags & FLOW_TNL_F_KEY) {
1906 nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
1908 if (tun_key->ip_src) {
1909 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
1911 if (tun_key->ip_dst) {
1912 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
1914 if (tun_key->ip_tos) {
1915 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
1917 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
1918 if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
1919 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
1921 if (tun_key->flags & FLOW_TNL_F_CSUM) {
1922 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
1924 if (tun_key->tp_src) {
1925 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src);
1927 if (tun_key->tp_dst) {
1928 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst);
1930 if (tun_key->flags & FLOW_TNL_F_OAM) {
1931 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
1933 if (tun_key->gbp_flags || tun_key->gbp_id) {
1934 size_t vxlan_opts_ofs;
1936 vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
1937 nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP,
1938 (tun_key->gbp_flags << 16) | ntohs(tun_key->gbp_id));
1939 nl_msg_end_nested(a, vxlan_opts_ofs);
1941 tun_metadata_to_geneve_nlattr(tun_key, tun_flow_key, key_buf, a);
1943 nl_msg_end_nested(a, tun_key_ofs);
1947 odp_mask_attr_is_wildcard(const struct nlattr *ma)
1949 return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
1953 odp_mask_is_exact(enum ovs_key_attr attr, const void *mask, size_t size)
1955 if (attr == OVS_KEY_ATTR_TCP_FLAGS) {
1956 return TCP_FLAGS(*(ovs_be16 *)mask) == TCP_FLAGS(OVS_BE16_MAX);
1958 if (attr == OVS_KEY_ATTR_IPV6) {
1959 const struct ovs_key_ipv6 *ipv6_mask = mask;
1962 ((ipv6_mask->ipv6_label & htonl(IPV6_LABEL_MASK))
1963 == htonl(IPV6_LABEL_MASK))
1964 && ipv6_mask->ipv6_proto == UINT8_MAX
1965 && ipv6_mask->ipv6_tclass == UINT8_MAX
1966 && ipv6_mask->ipv6_hlimit == UINT8_MAX
1967 && ipv6_mask->ipv6_frag == UINT8_MAX
1968 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_src)
1969 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_dst);
1971 if (attr == OVS_KEY_ATTR_TUNNEL) {
1975 if (attr == OVS_KEY_ATTR_ARP) {
1976 /* ARP key has padding, ignore it. */
1977 BUILD_ASSERT_DECL(sizeof(struct ovs_key_arp) == 24);
1978 BUILD_ASSERT_DECL(offsetof(struct ovs_key_arp, arp_tha) == 10 + 6);
1979 size = offsetof(struct ovs_key_arp, arp_tha) + ETH_ADDR_LEN;
1980 ovs_assert(((uint16_t *)mask)[size/2] == 0);
1983 return is_all_ones(mask, size);
1987 odp_mask_attr_is_exact(const struct nlattr *ma)
1989 enum ovs_key_attr attr = nl_attr_type(ma);
1993 if (attr == OVS_KEY_ATTR_TUNNEL) {
1996 mask = nl_attr_get(ma);
1997 size = nl_attr_get_size(ma);
2000 return odp_mask_is_exact(attr, mask, size);
2004 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
2007 struct odp_portno_names *odp_portno_names;
2009 odp_portno_names = xmalloc(sizeof *odp_portno_names);
2010 odp_portno_names->port_no = port_no;
2011 odp_portno_names->name = xstrdup(port_name);
2012 hmap_insert(portno_names, &odp_portno_names->hmap_node,
2013 hash_odp_port(port_no));
2017 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
2019 struct odp_portno_names *odp_portno_names;
2021 HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
2022 hash_odp_port(port_no), portno_names) {
2023 if (odp_portno_names->port_no == port_no) {
2024 return odp_portno_names->name;
2031 odp_portno_names_destroy(struct hmap *portno_names)
2033 struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
2034 HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
2035 hmap_node, portno_names) {
2036 hmap_remove(portno_names, &odp_portno_names->hmap_node);
2037 free(odp_portno_names->name);
2038 free(odp_portno_names);
2042 /* Format helpers. */
2045 format_eth(struct ds *ds, const char *name, const struct eth_addr key,
2046 const struct eth_addr *mask, bool verbose)
2048 bool mask_empty = mask && eth_addr_is_zero(*mask);
2050 if (verbose || !mask_empty) {
2051 bool mask_full = !mask || eth_mask_is_exact(*mask);
2054 ds_put_format(ds, "%s="ETH_ADDR_FMT",", name, ETH_ADDR_ARGS(key));
2056 ds_put_format(ds, "%s=", name);
2057 eth_format_masked(key, mask, ds);
2058 ds_put_char(ds, ',');
2064 format_be64(struct ds *ds, const char *name, ovs_be64 key,
2065 const ovs_be64 *mask, bool verbose)
2067 bool mask_empty = mask && !*mask;
2069 if (verbose || !mask_empty) {
2070 bool mask_full = !mask || *mask == OVS_BE64_MAX;
2072 ds_put_format(ds, "%s=0x%"PRIx64, name, ntohll(key));
2073 if (!mask_full) { /* Partially masked. */
2074 ds_put_format(ds, "/%#"PRIx64, ntohll(*mask));
2076 ds_put_char(ds, ',');
2081 format_ipv4(struct ds *ds, const char *name, ovs_be32 key,
2082 const ovs_be32 *mask, bool verbose)
2084 bool mask_empty = mask && !*mask;
2086 if (verbose || !mask_empty) {
2087 bool mask_full = !mask || *mask == OVS_BE32_MAX;
2089 ds_put_format(ds, "%s="IP_FMT, name, IP_ARGS(key));
2090 if (!mask_full) { /* Partially masked. */
2091 ds_put_format(ds, "/"IP_FMT, IP_ARGS(*mask));
2093 ds_put_char(ds, ',');
2098 format_in6_addr(struct ds *ds, const char *name,
2099 const struct in6_addr *key,
2100 const struct in6_addr *mask,
2103 char buf[INET6_ADDRSTRLEN];
2104 bool mask_empty = mask && ipv6_mask_is_any(mask);
2106 if (verbose || !mask_empty) {
2107 bool mask_full = !mask || ipv6_mask_is_exact(mask);
2109 inet_ntop(AF_INET6, key, buf, sizeof buf);
2110 ds_put_format(ds, "%s=%s", name, buf);
2111 if (!mask_full) { /* Partially masked. */
2112 inet_ntop(AF_INET6, mask, buf, sizeof buf);
2113 ds_put_format(ds, "/%s", buf);
2115 ds_put_char(ds, ',');
2120 format_ipv6(struct ds *ds, const char *name, const ovs_be32 key_[4],
2121 const ovs_be32 (*mask_)[4], bool verbose)
2123 format_in6_addr(ds, name,
2124 (const struct in6_addr *)key_,
2125 mask_ ? (const struct in6_addr *)*mask_ : NULL,
2130 format_ipv6_label(struct ds *ds, const char *name, ovs_be32 key,
2131 const ovs_be32 *mask, bool verbose)
2133 bool mask_empty = mask && !*mask;
2135 if (verbose || !mask_empty) {
2136 bool mask_full = !mask
2137 || (*mask & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK);
2139 ds_put_format(ds, "%s=%#"PRIx32, name, ntohl(key));
2140 if (!mask_full) { /* Partially masked. */
2141 ds_put_format(ds, "/%#"PRIx32, ntohl(*mask));
2143 ds_put_char(ds, ',');
2148 format_u8x(struct ds *ds, const char *name, uint8_t key,
2149 const uint8_t *mask, bool verbose)
2151 bool mask_empty = mask && !*mask;
2153 if (verbose || !mask_empty) {
2154 bool mask_full = !mask || *mask == UINT8_MAX;
2156 ds_put_format(ds, "%s=%#"PRIx8, name, key);
2157 if (!mask_full) { /* Partially masked. */
2158 ds_put_format(ds, "/%#"PRIx8, *mask);
2160 ds_put_char(ds, ',');
2165 format_u8u(struct ds *ds, const char *name, uint8_t key,
2166 const uint8_t *mask, bool verbose)
2168 bool mask_empty = mask && !*mask;
2170 if (verbose || !mask_empty) {
2171 bool mask_full = !mask || *mask == UINT8_MAX;
2173 ds_put_format(ds, "%s=%"PRIu8, name, key);
2174 if (!mask_full) { /* Partially masked. */
2175 ds_put_format(ds, "/%#"PRIx8, *mask);
2177 ds_put_char(ds, ',');
2182 format_be16(struct ds *ds, const char *name, ovs_be16 key,
2183 const ovs_be16 *mask, bool verbose)
2185 bool mask_empty = mask && !*mask;
2187 if (verbose || !mask_empty) {
2188 bool mask_full = !mask || *mask == OVS_BE16_MAX;
2190 ds_put_format(ds, "%s=%"PRIu16, name, ntohs(key));
2191 if (!mask_full) { /* Partially masked. */
2192 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
2194 ds_put_char(ds, ',');
2199 format_be16x(struct ds *ds, const char *name, ovs_be16 key,
2200 const ovs_be16 *mask, bool verbose)
2202 bool mask_empty = mask && !*mask;
2204 if (verbose || !mask_empty) {
2205 bool mask_full = !mask || *mask == OVS_BE16_MAX;
2207 ds_put_format(ds, "%s=%#"PRIx16, name, ntohs(key));
2208 if (!mask_full) { /* Partially masked. */
2209 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
2211 ds_put_char(ds, ',');
2216 format_tun_flags(struct ds *ds, const char *name, uint16_t key,
2217 const uint16_t *mask, bool verbose)
2219 bool mask_empty = mask && !*mask;
2221 if (verbose || !mask_empty) {
2222 ds_put_cstr(ds, name);
2223 ds_put_char(ds, '(');
2225 format_flags_masked(ds, NULL, flow_tun_flag_to_string, key,
2226 *mask & FLOW_TNL_F_MASK, FLOW_TNL_F_MASK);
2227 } else { /* Fully masked. */
2228 format_flags(ds, flow_tun_flag_to_string, key, '|');
2230 ds_put_cstr(ds, "),");
2235 check_attr_len(struct ds *ds, const struct nlattr *a, const struct nlattr *ma,
2236 const struct attr_len_tbl tbl[], int max_len, bool need_key)
2240 expected_len = odp_key_attr_len(tbl, max_len, nl_attr_type(a));
2241 if (expected_len != ATTR_LEN_VARIABLE &&
2242 expected_len != ATTR_LEN_NESTED) {
2244 bool bad_key_len = nl_attr_get_size(a) != expected_len;
2245 bool bad_mask_len = ma && nl_attr_get_size(ma) != expected_len;
2247 if (bad_key_len || bad_mask_len) {
2249 ds_put_format(ds, "key%u", nl_attr_type(a));
2252 ds_put_format(ds, "(bad key length %"PRIuSIZE", expected %d)(",
2253 nl_attr_get_size(a), expected_len);
2255 format_generic_odp_key(a, ds);
2257 ds_put_char(ds, '/');
2259 ds_put_format(ds, "(bad mask length %"PRIuSIZE", expected %d)(",
2260 nl_attr_get_size(ma), expected_len);
2262 format_generic_odp_key(ma, ds);
2264 ds_put_char(ds, ')');
2273 format_unknown_key(struct ds *ds, const struct nlattr *a,
2274 const struct nlattr *ma)
2276 ds_put_format(ds, "key%u(", nl_attr_type(a));
2277 format_generic_odp_key(a, ds);
2278 if (ma && !odp_mask_attr_is_exact(ma)) {
2279 ds_put_char(ds, '/');
2280 format_generic_odp_key(ma, ds);
2282 ds_put_cstr(ds, "),");
2286 format_odp_tun_vxlan_opt(const struct nlattr *attr,
2287 const struct nlattr *mask_attr, struct ds *ds,
2291 const struct nlattr *a;
2294 ofpbuf_init(&ofp, 100);
2295 NL_NESTED_FOR_EACH(a, left, attr) {
2296 uint16_t type = nl_attr_type(a);
2297 const struct nlattr *ma = NULL;
2300 ma = nl_attr_find__(nl_attr_get(mask_attr),
2301 nl_attr_get_size(mask_attr), type);
2303 ma = generate_all_wildcard_mask(ovs_vxlan_ext_attr_lens,
2309 if (!check_attr_len(ds, a, ma, ovs_vxlan_ext_attr_lens,
2310 OVS_VXLAN_EXT_MAX, true)) {
2315 case OVS_VXLAN_EXT_GBP: {
2316 uint32_t key = nl_attr_get_u32(a);
2317 ovs_be16 id, id_mask;
2318 uint8_t flags, flags_mask;
2320 id = htons(key & 0xFFFF);
2321 flags = (key >> 16) & 0xFF;
2323 uint32_t mask = nl_attr_get_u32(ma);
2324 id_mask = htons(mask & 0xFFFF);
2325 flags_mask = (mask >> 16) & 0xFF;
2328 ds_put_cstr(ds, "gbp(");
2329 format_be16(ds, "id", id, ma ? &id_mask : NULL, verbose);
2330 format_u8x(ds, "flags", flags, ma ? &flags_mask : NULL, verbose);
2332 ds_put_cstr(ds, "),");
2337 format_unknown_key(ds, a, ma);
2343 ofpbuf_uninit(&ofp);
2346 #define MASK(PTR, FIELD) PTR ? &PTR->FIELD : NULL
2349 format_geneve_opts(const struct geneve_opt *opt,
2350 const struct geneve_opt *mask, int opts_len,
2351 struct ds *ds, bool verbose)
2353 while (opts_len > 0) {
2355 uint8_t data_len, data_len_mask;
2357 if (opts_len < sizeof *opt) {
2358 ds_put_format(ds, "opt len %u less than minimum %"PRIuSIZE,
2359 opts_len, sizeof *opt);
2363 data_len = opt->length * 4;
2365 if (mask->length == 0x1f) {
2366 data_len_mask = UINT8_MAX;
2368 data_len_mask = mask->length;
2371 len = sizeof *opt + data_len;
2372 if (len > opts_len) {
2373 ds_put_format(ds, "opt len %u greater than remaining %u",
2378 ds_put_char(ds, '{');
2379 format_be16x(ds, "class", opt->opt_class, MASK(mask, opt_class),
2381 format_u8x(ds, "type", opt->type, MASK(mask, type), verbose);
2382 format_u8u(ds, "len", data_len, mask ? &data_len_mask : NULL, verbose);
2384 (verbose || !mask || !is_all_zeros(mask + 1, data_len))) {
2385 ds_put_hex(ds, opt + 1, data_len);
2386 if (mask && !is_all_ones(mask + 1, data_len)) {
2387 ds_put_char(ds, '/');
2388 ds_put_hex(ds, mask + 1, data_len);
2393 ds_put_char(ds, '}');
2395 opt += len / sizeof(*opt);
2397 mask += len / sizeof(*opt);
2404 format_odp_tun_geneve(const struct nlattr *attr,
2405 const struct nlattr *mask_attr, struct ds *ds,
2408 int opts_len = nl_attr_get_size(attr);
2409 const struct geneve_opt *opt = nl_attr_get(attr);
2410 const struct geneve_opt *mask = mask_attr ?
2411 nl_attr_get(mask_attr) : NULL;
2413 if (mask && nl_attr_get_size(attr) != nl_attr_get_size(mask_attr)) {
2414 ds_put_format(ds, "value len %"PRIuSIZE" different from mask len %"PRIuSIZE,
2415 nl_attr_get_size(attr), nl_attr_get_size(mask_attr));
2419 format_geneve_opts(opt, mask, opts_len, ds, verbose);
2423 format_odp_tun_attr(const struct nlattr *attr, const struct nlattr *mask_attr,
2424 struct ds *ds, bool verbose)
2427 const struct nlattr *a;
2429 uint16_t mask_flags = 0;
2432 ofpbuf_init(&ofp, 100);
2433 NL_NESTED_FOR_EACH(a, left, attr) {
2434 enum ovs_tunnel_key_attr type = nl_attr_type(a);
2435 const struct nlattr *ma = NULL;
2438 ma = nl_attr_find__(nl_attr_get(mask_attr),
2439 nl_attr_get_size(mask_attr), type);
2441 ma = generate_all_wildcard_mask(ovs_tun_key_attr_lens,
2442 OVS_TUNNEL_KEY_ATTR_MAX,
2447 if (!check_attr_len(ds, a, ma, ovs_tun_key_attr_lens,
2448 OVS_TUNNEL_KEY_ATTR_MAX, true)) {
2453 case OVS_TUNNEL_KEY_ATTR_ID:
2454 format_be64(ds, "tun_id", nl_attr_get_be64(a),
2455 ma ? nl_attr_get(ma) : NULL, verbose);
2456 flags |= FLOW_TNL_F_KEY;
2458 mask_flags |= FLOW_TNL_F_KEY;
2461 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
2462 format_ipv4(ds, "src", nl_attr_get_be32(a),
2463 ma ? nl_attr_get(ma) : NULL, verbose);
2465 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
2466 format_ipv4(ds, "dst", nl_attr_get_be32(a),
2467 ma ? nl_attr_get(ma) : NULL, verbose);
2469 case OVS_TUNNEL_KEY_ATTR_TOS:
2470 format_u8x(ds, "tos", nl_attr_get_u8(a),
2471 ma ? nl_attr_get(ma) : NULL, verbose);
2473 case OVS_TUNNEL_KEY_ATTR_TTL:
2474 format_u8u(ds, "ttl", nl_attr_get_u8(a),
2475 ma ? nl_attr_get(ma) : NULL, verbose);
2477 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2478 flags |= FLOW_TNL_F_DONT_FRAGMENT;
2480 case OVS_TUNNEL_KEY_ATTR_CSUM:
2481 flags |= FLOW_TNL_F_CSUM;
2483 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
2484 format_be16(ds, "tp_src", nl_attr_get_be16(a),
2485 ma ? nl_attr_get(ma) : NULL, verbose);
2487 case OVS_TUNNEL_KEY_ATTR_TP_DST:
2488 format_be16(ds, "tp_dst", nl_attr_get_be16(a),
2489 ma ? nl_attr_get(ma) : NULL, verbose);
2491 case OVS_TUNNEL_KEY_ATTR_OAM:
2492 flags |= FLOW_TNL_F_OAM;
2494 case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS:
2495 ds_put_cstr(ds, "vxlan(");
2496 format_odp_tun_vxlan_opt(a, ma, ds, verbose);
2497 ds_put_cstr(ds, "),");
2499 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
2500 ds_put_cstr(ds, "geneve(");
2501 format_odp_tun_geneve(a, ma, ds, verbose);
2502 ds_put_cstr(ds, "),");
2504 case __OVS_TUNNEL_KEY_ATTR_MAX:
2506 format_unknown_key(ds, a, ma);
2511 /* Flags can have a valid mask even if the attribute is not set, so
2512 * we need to collect these separately. */
2514 NL_NESTED_FOR_EACH(a, left, mask_attr) {
2515 switch (nl_attr_type(a)) {
2516 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2517 mask_flags |= FLOW_TNL_F_DONT_FRAGMENT;
2519 case OVS_TUNNEL_KEY_ATTR_CSUM:
2520 mask_flags |= FLOW_TNL_F_CSUM;
2522 case OVS_TUNNEL_KEY_ATTR_OAM:
2523 mask_flags |= FLOW_TNL_F_OAM;
2529 format_tun_flags(ds, "flags", flags, mask_attr ? &mask_flags : NULL,
2532 ofpbuf_uninit(&ofp);
2536 odp_ct_state_to_string(uint32_t flag)
2539 case OVS_CS_F_REPLY_DIR:
2541 case OVS_CS_F_TRACKED:
2545 case OVS_CS_F_ESTABLISHED:
2547 case OVS_CS_F_RELATED:
2549 case OVS_CS_F_INVALID:
2557 format_frag(struct ds *ds, const char *name, uint8_t key,
2558 const uint8_t *mask, bool verbose)
2560 bool mask_empty = mask && !*mask;
2562 /* ODP frag is an enumeration field; partial masks are not meaningful. */
2563 if (verbose || !mask_empty) {
2564 bool mask_full = !mask || *mask == UINT8_MAX;
2566 if (!mask_full) { /* Partially masked. */
2567 ds_put_format(ds, "error: partial mask not supported for frag (%#"
2570 ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
2576 mask_empty(const struct nlattr *ma)
2584 mask = nl_attr_get(ma);
2585 n = nl_attr_get_size(ma);
2587 return is_all_zeros(mask, n);
2591 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
2592 const struct hmap *portno_names, struct ds *ds,
2595 enum ovs_key_attr attr = nl_attr_type(a);
2596 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2599 is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
2601 ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
2603 if (!check_attr_len(ds, a, ma, ovs_flow_key_attr_lens,
2604 OVS_KEY_ATTR_MAX, false)) {
2608 ds_put_char(ds, '(');
2610 case OVS_KEY_ATTR_ENCAP:
2611 if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
2612 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
2613 nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
2615 } else if (nl_attr_get_size(a)) {
2616 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
2621 case OVS_KEY_ATTR_PRIORITY:
2622 case OVS_KEY_ATTR_SKB_MARK:
2623 case OVS_KEY_ATTR_DP_HASH:
2624 case OVS_KEY_ATTR_RECIRC_ID:
2625 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2627 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2631 case OVS_KEY_ATTR_CT_MARK:
2632 if (verbose || !mask_empty(ma)) {
2633 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2635 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2640 case OVS_KEY_ATTR_CT_STATE:
2642 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2644 ds_put_format(ds, "/%#"PRIx32,
2645 mask_empty(ma) ? 0 : nl_attr_get_u32(ma));
2647 } else if (!is_exact) {
2648 format_flags_masked(ds, NULL, odp_ct_state_to_string,
2650 mask_empty(ma) ? 0 : nl_attr_get_u32(ma),
2653 format_flags(ds, odp_ct_state_to_string, nl_attr_get_u32(a), '|');
2657 case OVS_KEY_ATTR_CT_ZONE:
2658 if (verbose || !mask_empty(ma)) {
2659 ds_put_format(ds, "%#"PRIx16, nl_attr_get_u16(a));
2661 ds_put_format(ds, "/%#"PRIx16, nl_attr_get_u16(ma));
2666 case OVS_KEY_ATTR_CT_LABELS: {
2667 const ovs_u128 *value = nl_attr_get(a);
2668 const ovs_u128 *mask = ma ? nl_attr_get(ma) : NULL;
2670 format_u128(ds, value, mask, verbose);
2674 case OVS_KEY_ATTR_TUNNEL:
2675 format_odp_tun_attr(a, ma, ds, verbose);
2678 case OVS_KEY_ATTR_IN_PORT:
2679 if (portno_names && verbose && is_exact) {
2680 char *name = odp_portno_names_get(portno_names,
2681 u32_to_odp(nl_attr_get_u32(a)));
2683 ds_put_format(ds, "%s", name);
2685 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2688 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2690 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2695 case OVS_KEY_ATTR_ETHERNET: {
2696 const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
2697 const struct ovs_key_ethernet *key = nl_attr_get(a);
2699 format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
2700 format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
2704 case OVS_KEY_ATTR_VLAN:
2705 format_vlan_tci(ds, nl_attr_get_be16(a),
2706 ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
2709 case OVS_KEY_ATTR_MPLS: {
2710 const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
2711 const struct ovs_key_mpls *mpls_mask = NULL;
2712 size_t size = nl_attr_get_size(a);
2714 if (!size || size % sizeof *mpls_key) {
2715 ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
2719 mpls_mask = nl_attr_get(ma);
2720 if (size != nl_attr_get_size(ma)) {
2721 ds_put_format(ds, "(key length %"PRIuSIZE" != "
2722 "mask length %"PRIuSIZE")",
2723 size, nl_attr_get_size(ma));
2727 format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
2730 case OVS_KEY_ATTR_ETHERTYPE:
2731 ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
2733 ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
2737 case OVS_KEY_ATTR_IPV4: {
2738 const struct ovs_key_ipv4 *key = nl_attr_get(a);
2739 const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
2741 format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
2742 format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
2743 format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
2745 format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
2746 format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
2747 format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
2752 case OVS_KEY_ATTR_IPV6: {
2753 const struct ovs_key_ipv6 *key = nl_attr_get(a);
2754 const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
2756 format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
2757 format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
2758 format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
2760 format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
2762 format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
2764 format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
2766 format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
2771 /* These have the same structure and format. */
2772 case OVS_KEY_ATTR_TCP:
2773 case OVS_KEY_ATTR_UDP:
2774 case OVS_KEY_ATTR_SCTP: {
2775 const struct ovs_key_tcp *key = nl_attr_get(a);
2776 const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
2778 format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
2779 format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
2783 case OVS_KEY_ATTR_TCP_FLAGS:
2785 format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
2786 ntohs(nl_attr_get_be16(a)),
2787 TCP_FLAGS(nl_attr_get_be16(ma)),
2788 TCP_FLAGS(OVS_BE16_MAX));
2790 format_flags(ds, packet_tcp_flag_to_string,
2791 ntohs(nl_attr_get_be16(a)), '|');
2795 case OVS_KEY_ATTR_ICMP: {
2796 const struct ovs_key_icmp *key = nl_attr_get(a);
2797 const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
2799 format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
2800 format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
2804 case OVS_KEY_ATTR_ICMPV6: {
2805 const struct ovs_key_icmpv6 *key = nl_attr_get(a);
2806 const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
2808 format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
2810 format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
2815 case OVS_KEY_ATTR_ARP: {
2816 const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
2817 const struct ovs_key_arp *key = nl_attr_get(a);
2819 format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
2820 format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
2821 format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
2822 format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
2823 format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
2827 case OVS_KEY_ATTR_ND: {
2828 const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
2829 const struct ovs_key_nd *key = nl_attr_get(a);
2831 format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
2833 format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
2834 format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
2839 case OVS_KEY_ATTR_UNSPEC:
2840 case __OVS_KEY_ATTR_MAX:
2842 format_generic_odp_key(a, ds);
2844 ds_put_char(ds, '/');
2845 format_generic_odp_key(ma, ds);
2849 ds_put_char(ds, ')');
2852 static struct nlattr *
2853 generate_all_wildcard_mask(const struct attr_len_tbl tbl[], int max,
2854 struct ofpbuf *ofp, const struct nlattr *key)
2856 const struct nlattr *a;
2858 int type = nl_attr_type(key);
2859 int size = nl_attr_get_size(key);
2861 if (odp_key_attr_len(tbl, max, type) != ATTR_LEN_NESTED) {
2862 nl_msg_put_unspec_zero(ofp, type, size);
2866 if (tbl[type].next) {
2867 tbl = tbl[type].next;
2868 max = tbl[type].next_max;
2871 nested_mask = nl_msg_start_nested(ofp, type);
2872 NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
2873 generate_all_wildcard_mask(tbl, max, ofp, nl_attr_get(a));
2875 nl_msg_end_nested(ofp, nested_mask);
2882 format_u128(struct ds *ds, const ovs_u128 *key, const ovs_u128 *mask,
2885 if (verbose || (mask && !ovs_u128_is_zero(mask))) {
2888 value = hton128(*key);
2889 ds_put_hex(ds, &value, sizeof value);
2890 if (mask && !(ovs_u128_is_ones(mask))) {
2891 value = hton128(*mask);
2892 ds_put_char(ds, '/');
2893 ds_put_hex(ds, &value, sizeof value);
2899 scan_u128(const char *s_, ovs_u128 *value, ovs_u128 *mask)
2901 char *s = CONST_CAST(char *, s_);
2905 if (!parse_int_string(s, (uint8_t *)&be_value, sizeof be_value, &s)) {
2906 *value = ntoh128(be_value);
2911 if (ovs_scan(s, "/%n", &n)) {
2915 error = parse_int_string(s, (uint8_t *)&be_mask,
2916 sizeof be_mask, &s);
2920 *mask = ntoh128(be_mask);
2922 *mask = OVS_U128_MAX;
2932 odp_ufid_from_string(const char *s_, ovs_u128 *ufid)
2936 if (ovs_scan(s, "ufid:")) {
2939 if (!uuid_from_string_prefix((struct uuid *)ufid, s)) {
2951 odp_format_ufid(const ovs_u128 *ufid, struct ds *ds)
2953 ds_put_format(ds, "ufid:"UUID_FMT, UUID_ARGS((struct uuid *)ufid));
2956 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2957 * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
2958 * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
2959 * non-null and 'verbose' is true, translates odp port number to its name. */
2961 odp_flow_format(const struct nlattr *key, size_t key_len,
2962 const struct nlattr *mask, size_t mask_len,
2963 const struct hmap *portno_names, struct ds *ds, bool verbose)
2966 const struct nlattr *a;
2968 bool has_ethtype_key = false;
2969 const struct nlattr *ma = NULL;
2971 bool first_field = true;
2973 ofpbuf_init(&ofp, 100);
2974 NL_ATTR_FOR_EACH (a, left, key, key_len) {
2975 bool is_nested_attr;
2976 bool is_wildcard = false;
2977 int attr_type = nl_attr_type(a);
2979 if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
2980 has_ethtype_key = true;
2983 is_nested_attr = odp_key_attr_len(ovs_flow_key_attr_lens,
2984 OVS_KEY_ATTR_MAX, attr_type) ==
2987 if (mask && mask_len) {
2988 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
2989 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
2992 if (verbose || !is_wildcard || is_nested_attr) {
2993 if (is_wildcard && !ma) {
2994 ma = generate_all_wildcard_mask(ovs_flow_key_attr_lens,
2999 ds_put_char(ds, ',');
3001 format_odp_key_attr(a, ma, portno_names, ds, verbose);
3002 first_field = false;
3006 ofpbuf_uninit(&ofp);
3011 if (left == key_len) {
3012 ds_put_cstr(ds, "<empty>");
3014 ds_put_format(ds, ",***%u leftover bytes*** (", left);
3015 for (i = 0; i < left; i++) {
3016 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
3018 ds_put_char(ds, ')');
3020 if (!has_ethtype_key) {
3021 ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
3023 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
3024 ntohs(nl_attr_get_be16(ma)));
3028 ds_put_cstr(ds, "<empty>");
3032 /* Appends to 'ds' a string representation of the 'key_len' bytes of
3033 * OVS_KEY_ATTR_* attributes in 'key'. */
3035 odp_flow_key_format(const struct nlattr *key,
3036 size_t key_len, struct ds *ds)
3038 odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
3042 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
3044 if (!strcasecmp(s, "no")) {
3045 *type = OVS_FRAG_TYPE_NONE;
3046 } else if (!strcasecmp(s, "first")) {
3047 *type = OVS_FRAG_TYPE_FIRST;
3048 } else if (!strcasecmp(s, "later")) {
3049 *type = OVS_FRAG_TYPE_LATER;
3059 scan_eth(const char *s, struct eth_addr *key, struct eth_addr *mask)
3063 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n",
3064 ETH_ADDR_SCAN_ARGS(*key), &n)) {
3068 if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
3069 ETH_ADDR_SCAN_ARGS(*mask), &n)) {
3072 memset(mask, 0xff, sizeof *mask);
3081 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
3085 if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
3089 if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
3090 IP_SCAN_ARGS(mask), &n)) {
3093 *mask = OVS_BE32_MAX;
3102 scan_in6_addr(const char *s, struct in6_addr *key, struct in6_addr *mask)
3105 char ipv6_s[IPV6_SCAN_LEN + 1];
3107 if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
3108 && inet_pton(AF_INET6, ipv6_s, key) == 1) {
3112 if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
3113 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
3116 memset(mask, 0xff, sizeof *mask);
3125 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
3127 return scan_in6_addr(s, key ? (struct in6_addr *) *key : NULL,
3128 mask ? (struct in6_addr *) *mask : NULL);
3132 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
3137 if (ovs_scan(s, "%i%n", &key_, &n)
3138 && (key_ & ~IPV6_LABEL_MASK) == 0) {
3143 if (ovs_scan(s + len, "/%i%n", &mask_, &n)
3144 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
3146 *mask = htonl(mask_);
3148 *mask = htonl(IPV6_LABEL_MASK);
3157 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
3161 if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
3165 if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
3177 scan_u16(const char *s, uint16_t *key, uint16_t *mask)
3181 if (ovs_scan(s, "%"SCNi16"%n", key, &n)) {
3185 if (ovs_scan(s + len, "/%"SCNi16"%n", mask, &n)) {
3197 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
3201 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
3205 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
3217 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
3219 uint16_t key_, mask_;
3222 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
3227 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
3229 *mask = htons(mask_);
3231 *mask = OVS_BE16_MAX;
3240 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
3242 uint64_t key_, mask_;
3245 if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
3248 *key = htonll(key_);
3250 if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
3252 *mask = htonll(mask_);
3254 *mask = OVS_BE64_MAX;
3263 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
3265 uint32_t flags, fmask;
3268 n = parse_odp_flags(s, flow_tun_flag_to_string, &flags,
3269 FLOW_TNL_F_MASK, mask ? &fmask : NULL);
3270 if (n >= 0 && s[n] == ')') {
3281 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
3283 uint32_t flags, fmask;
3286 n = parse_odp_flags(s, packet_tcp_flag_to_string, &flags,
3287 TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
3289 *key = htons(flags);
3291 *mask = htons(fmask);
3299 ovs_to_odp_ct_state(uint8_t state)
3303 if (state & CS_NEW) {
3304 odp |= OVS_CS_F_NEW;
3306 if (state & CS_ESTABLISHED) {
3307 odp |= OVS_CS_F_ESTABLISHED;
3309 if (state & CS_RELATED) {
3310 odp |= OVS_CS_F_RELATED;
3312 if (state & CS_INVALID) {
3313 odp |= OVS_CS_F_INVALID;
3315 if (state & CS_REPLY_DIR) {
3316 odp |= OVS_CS_F_REPLY_DIR;
3318 if (state & CS_TRACKED) {
3319 odp |= OVS_CS_F_TRACKED;
3326 odp_to_ovs_ct_state(uint32_t flags)
3330 if (flags & OVS_CS_F_NEW) {
3333 if (flags & OVS_CS_F_ESTABLISHED) {
3334 state |= CS_ESTABLISHED;
3336 if (flags & OVS_CS_F_RELATED) {
3337 state |= CS_RELATED;
3339 if (flags & OVS_CS_F_INVALID) {
3340 state |= CS_INVALID;
3342 if (flags & OVS_CS_F_REPLY_DIR) {
3343 state |= CS_REPLY_DIR;
3345 if (flags & OVS_CS_F_TRACKED) {
3346 state |= CS_TRACKED;
3353 scan_ct_state(const char *s, uint32_t *key, uint32_t *mask)
3355 uint32_t flags, fmask;
3358 n = parse_flags(s, odp_ct_state_to_string, ')', NULL, NULL, &flags,
3359 ovs_to_odp_ct_state(CS_SUPPORTED_MASK),
3360 mask ? &fmask : NULL);
3373 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
3377 enum ovs_frag_type frag_type;
3379 if (ovs_scan(s, "%7[a-z]%n", frag, &n)
3380 && ovs_frag_type_from_string(frag, &frag_type)) {
3393 scan_port(const char *s, uint32_t *key, uint32_t *mask,
3394 const struct simap *port_names)
3398 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
3402 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
3409 } else if (port_names) {
3410 const struct simap_node *node;
3413 len = strcspn(s, ")");
3414 node = simap_find_len(port_names, s, len);
3427 /* Helper for vlan parsing. */
3428 struct ovs_key_vlan__ {
3433 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
3435 const uint16_t mask = ((1U << bits) - 1) << offset;
3437 if (value >> bits) {
3441 *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
3446 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
3449 uint16_t key_, mask_;
3452 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
3455 if (set_be16_bf(key, bits, offset, key_)) {
3457 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
3460 if (!set_be16_bf(mask, bits, offset, mask_)) {
3464 *mask |= htons(((1U << bits) - 1) << offset);
3474 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
3476 return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
3480 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
3482 return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
3486 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
3488 return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
3493 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
3495 const uint32_t mask = ((1U << bits) - 1) << offset;
3497 if (value >> bits) {
3501 *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
3506 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
3509 uint32_t key_, mask_;
3512 if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
3515 if (set_be32_bf(key, bits, offset, key_)) {
3517 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
3520 if (!set_be32_bf(mask, bits, offset, mask_)) {
3524 *mask |= htonl(((1U << bits) - 1) << offset);
3534 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
3536 return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
3540 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
3542 return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
3546 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
3548 return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
3552 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
3554 return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
3558 scan_vxlan_gbp(const char *s, uint32_t *key, uint32_t *mask)
3560 const char *s_base = s;
3561 ovs_be16 id = 0, id_mask = 0;
3562 uint8_t flags = 0, flags_mask = 0;
3564 if (!strncmp(s, "id=", 3)) {
3566 s += scan_be16(s, &id, mask ? &id_mask : NULL);
3572 if (!strncmp(s, "flags=", 6)) {
3574 s += scan_u8(s, &flags, mask ? &flags_mask : NULL);
3577 if (!strncmp(s, "))", 2)) {
3580 *key = (flags << 16) | ntohs(id);
3582 *mask = (flags_mask << 16) | ntohs(id_mask);
3592 scan_geneve(const char *s, struct geneve_scan *key, struct geneve_scan *mask)
3594 const char *s_base = s;
3595 struct geneve_opt *opt = key->d;
3596 struct geneve_opt *opt_mask = mask ? mask->d : NULL;
3597 int len_remain = sizeof key->d;
3599 while (s[0] == '{' && len_remain >= sizeof *opt) {
3603 len_remain -= sizeof *opt;
3605 if (!strncmp(s, "class=", 6)) {
3607 s += scan_be16(s, &opt->opt_class,
3608 mask ? &opt_mask->opt_class : NULL);
3610 memset(&opt_mask->opt_class, 0, sizeof opt_mask->opt_class);
3616 if (!strncmp(s, "type=", 5)) {
3618 s += scan_u8(s, &opt->type, mask ? &opt_mask->type : NULL);
3620 memset(&opt_mask->type, 0, sizeof opt_mask->type);
3626 if (!strncmp(s, "len=", 4)) {
3627 uint8_t opt_len, opt_len_mask;
3629 s += scan_u8(s, &opt_len, mask ? &opt_len_mask : NULL);
3631 if (opt_len > 124 || opt_len % 4 || opt_len > len_remain) {
3634 opt->length = opt_len / 4;
3636 opt_mask->length = opt_len_mask;
3640 memset(&opt_mask->type, 0, sizeof opt_mask->type);
3646 if (parse_int_string(s, (uint8_t *)(opt + 1), data_len, (char **)&s)) {
3653 if (parse_int_string(s, (uint8_t *)(opt_mask + 1),
3654 data_len, (char **)&s)) {
3665 opt += 1 + data_len / 4;
3667 opt_mask += 1 + data_len / 4;
3669 len_remain -= data_len;
3674 int len = sizeof key->d - len_remain;
3688 tun_flags_to_attr(struct ofpbuf *a, const void *data_)
3690 const uint16_t *flags = data_;
3692 if (*flags & FLOW_TNL_F_DONT_FRAGMENT) {
3693 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
3695 if (*flags & FLOW_TNL_F_CSUM) {
3696 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
3698 if (*flags & FLOW_TNL_F_OAM) {
3699 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
3704 vxlan_gbp_to_attr(struct ofpbuf *a, const void *data_)
3706 const uint32_t *gbp = data_;
3709 size_t vxlan_opts_ofs;
3711 vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
3712 nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP, *gbp);
3713 nl_msg_end_nested(a, vxlan_opts_ofs);
3718 geneve_to_attr(struct ofpbuf *a, const void *data_)
3720 const struct geneve_scan *geneve = data_;
3722 nl_msg_put_unspec(a, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, geneve->d,
3726 #define SCAN_PUT_ATTR(BUF, ATTR, DATA, FUNC) \
3728 unsigned long call_fn = (unsigned long)FUNC; \
3730 typedef void (*fn)(struct ofpbuf *, const void *); \
3732 func(BUF, &(DATA)); \
3734 nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
3738 #define SCAN_IF(NAME) \
3739 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3740 const char *start = s; \
3745 /* Usually no special initialization is needed. */
3746 #define SCAN_BEGIN(NAME, TYPE) \
3749 memset(&skey, 0, sizeof skey); \
3750 memset(&smask, 0, sizeof smask); \
3754 /* Init as fully-masked as mask will not be scanned. */
3755 #define SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) \
3758 memset(&skey, 0, sizeof skey); \
3759 memset(&smask, 0xff, sizeof smask); \
3763 /* VLAN needs special initialization. */
3764 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT) \
3766 TYPE skey = KEY_INIT; \
3767 TYPE smask = MASK_INIT; \
3771 /* Scan unnamed entry as 'TYPE' */
3772 #define SCAN_TYPE(TYPE, KEY, MASK) \
3773 len = scan_##TYPE(s, KEY, MASK); \
3779 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3780 #define SCAN_FIELD(NAME, TYPE, FIELD) \
3781 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3782 s += strlen(NAME); \
3783 SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL); \
3787 #define SCAN_FINISH() \
3788 } while (*s++ == ',' && len != 0); \
3789 if (s[-1] != ')') { \
3793 #define SCAN_FINISH_SINGLE() \
3795 if (*s++ != ')') { \
3799 /* Beginning of nested attribute. */
3800 #define SCAN_BEGIN_NESTED(NAME, ATTR) \
3802 size_t key_offset, mask_offset; \
3803 key_offset = nl_msg_start_nested(key, ATTR); \
3805 mask_offset = nl_msg_start_nested(mask, ATTR); \
3810 #define SCAN_END_NESTED() \
3812 nl_msg_end_nested(key, key_offset); \
3814 nl_msg_end_nested(mask, mask_offset); \
3819 #define SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, FUNC) \
3820 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3822 memset(&skey, 0, sizeof skey); \
3823 memset(&smask, 0xff, sizeof smask); \
3824 s += strlen(NAME); \
3825 SCAN_TYPE(SCAN_AS, &skey, &smask); \
3826 SCAN_PUT(ATTR, FUNC); \
3830 #define SCAN_FIELD_NESTED(NAME, TYPE, SCAN_AS, ATTR) \
3831 SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, NULL)
3833 #define SCAN_FIELD_NESTED_FUNC(NAME, TYPE, SCAN_AS, FUNC) \
3834 SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, 0, FUNC)
3836 #define SCAN_PUT(ATTR, FUNC) \
3837 if (!mask || !is_all_zeros(&smask, sizeof smask)) { \
3838 SCAN_PUT_ATTR(key, ATTR, skey, FUNC); \
3840 SCAN_PUT_ATTR(mask, ATTR, smask, FUNC); \
3844 #define SCAN_END(ATTR) \
3846 SCAN_PUT(ATTR, NULL); \
3850 #define SCAN_END_SINGLE(ATTR) \
3851 SCAN_FINISH_SINGLE(); \
3852 SCAN_PUT(ATTR, NULL); \
3856 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR) \
3857 SCAN_BEGIN(NAME, TYPE) { \
3858 SCAN_TYPE(SCAN_AS, &skey, &smask); \
3859 } SCAN_END_SINGLE(ATTR)
3861 #define SCAN_SINGLE_FULLY_MASKED(NAME, TYPE, SCAN_AS, ATTR) \
3862 SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) { \
3863 SCAN_TYPE(SCAN_AS, &skey, NULL); \
3864 } SCAN_END_SINGLE(ATTR)
3866 /* scan_port needs one extra argument. */
3867 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR) \
3868 SCAN_BEGIN(NAME, TYPE) { \
3869 len = scan_port(s, &skey, &smask, port_names); \
3874 } SCAN_END_SINGLE(ATTR)
3877 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
3878 struct ofpbuf *key, struct ofpbuf *mask)
3884 len = odp_ufid_from_string(s, &ufid);
3889 SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
3890 SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
3891 SCAN_SINGLE_FULLY_MASKED("recirc_id(", uint32_t, u32,
3892 OVS_KEY_ATTR_RECIRC_ID);
3893 SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
3895 SCAN_SINGLE("ct_state(", uint32_t, ct_state, OVS_KEY_ATTR_CT_STATE);
3896 SCAN_SINGLE("ct_zone(", uint16_t, u16, OVS_KEY_ATTR_CT_ZONE);
3897 SCAN_SINGLE("ct_mark(", uint32_t, u32, OVS_KEY_ATTR_CT_MARK);
3898 SCAN_SINGLE("ct_label(", ovs_u128, u128, OVS_KEY_ATTR_CT_LABELS);
3900 SCAN_BEGIN_NESTED("tunnel(", OVS_KEY_ATTR_TUNNEL) {
3901 SCAN_FIELD_NESTED("tun_id=", ovs_be64, be64, OVS_TUNNEL_KEY_ATTR_ID);
3902 SCAN_FIELD_NESTED("src=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_SRC);
3903 SCAN_FIELD_NESTED("dst=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_DST);
3904 SCAN_FIELD_NESTED("tos=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TOS);
3905 SCAN_FIELD_NESTED("ttl=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TTL);
3906 SCAN_FIELD_NESTED("tp_src=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_SRC);
3907 SCAN_FIELD_NESTED("tp_dst=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_DST);
3908 SCAN_FIELD_NESTED_FUNC("vxlan(gbp(", uint32_t, vxlan_gbp, vxlan_gbp_to_attr);
3909 SCAN_FIELD_NESTED_FUNC("geneve(", struct geneve_scan, geneve,
3911 SCAN_FIELD_NESTED_FUNC("flags(", uint16_t, tun_flags, tun_flags_to_attr);
3912 } SCAN_END_NESTED();
3914 SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
3916 SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
3917 SCAN_FIELD("src=", eth, eth_src);
3918 SCAN_FIELD("dst=", eth, eth_dst);
3919 } SCAN_END(OVS_KEY_ATTR_ETHERNET);
3921 SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
3922 { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
3923 SCAN_FIELD("vid=", vid, tci);
3924 SCAN_FIELD("pcp=", pcp, tci);
3925 SCAN_FIELD("cfi=", cfi, tci);
3926 } SCAN_END(OVS_KEY_ATTR_VLAN);
3928 SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
3930 SCAN_BEGIN("mpls(", struct ovs_key_mpls) {
3931 SCAN_FIELD("label=", mpls_label, mpls_lse);
3932 SCAN_FIELD("tc=", mpls_tc, mpls_lse);
3933 SCAN_FIELD("ttl=", mpls_ttl, mpls_lse);
3934 SCAN_FIELD("bos=", mpls_bos, mpls_lse);
3935 } SCAN_END(OVS_KEY_ATTR_MPLS);
3937 SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
3938 SCAN_FIELD("src=", ipv4, ipv4_src);
3939 SCAN_FIELD("dst=", ipv4, ipv4_dst);
3940 SCAN_FIELD("proto=", u8, ipv4_proto);
3941 SCAN_FIELD("tos=", u8, ipv4_tos);
3942 SCAN_FIELD("ttl=", u8, ipv4_ttl);
3943 SCAN_FIELD("frag=", frag, ipv4_frag);
3944 } SCAN_END(OVS_KEY_ATTR_IPV4);
3946 SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
3947 SCAN_FIELD("src=", ipv6, ipv6_src);
3948 SCAN_FIELD("dst=", ipv6, ipv6_dst);
3949 SCAN_FIELD("label=", ipv6_label, ipv6_label);
3950 SCAN_FIELD("proto=", u8, ipv6_proto);
3951 SCAN_FIELD("tclass=", u8, ipv6_tclass);
3952 SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
3953 SCAN_FIELD("frag=", frag, ipv6_frag);
3954 } SCAN_END(OVS_KEY_ATTR_IPV6);
3956 SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
3957 SCAN_FIELD("src=", be16, tcp_src);
3958 SCAN_FIELD("dst=", be16, tcp_dst);
3959 } SCAN_END(OVS_KEY_ATTR_TCP);
3961 SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
3963 SCAN_BEGIN("udp(", struct ovs_key_udp) {
3964 SCAN_FIELD("src=", be16, udp_src);
3965 SCAN_FIELD("dst=", be16, udp_dst);
3966 } SCAN_END(OVS_KEY_ATTR_UDP);
3968 SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
3969 SCAN_FIELD("src=", be16, sctp_src);
3970 SCAN_FIELD("dst=", be16, sctp_dst);
3971 } SCAN_END(OVS_KEY_ATTR_SCTP);
3973 SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
3974 SCAN_FIELD("type=", u8, icmp_type);
3975 SCAN_FIELD("code=", u8, icmp_code);
3976 } SCAN_END(OVS_KEY_ATTR_ICMP);
3978 SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
3979 SCAN_FIELD("type=", u8, icmpv6_type);
3980 SCAN_FIELD("code=", u8, icmpv6_code);
3981 } SCAN_END(OVS_KEY_ATTR_ICMPV6);
3983 SCAN_BEGIN("arp(", struct ovs_key_arp) {
3984 SCAN_FIELD("sip=", ipv4, arp_sip);
3985 SCAN_FIELD("tip=", ipv4, arp_tip);
3986 SCAN_FIELD("op=", be16, arp_op);
3987 SCAN_FIELD("sha=", eth, arp_sha);
3988 SCAN_FIELD("tha=", eth, arp_tha);
3989 } SCAN_END(OVS_KEY_ATTR_ARP);
3991 SCAN_BEGIN("nd(", struct ovs_key_nd) {
3992 SCAN_FIELD("target=", ipv6, nd_target);
3993 SCAN_FIELD("sll=", eth, nd_sll);
3994 SCAN_FIELD("tll=", eth, nd_tll);
3995 } SCAN_END(OVS_KEY_ATTR_ND);
3997 /* Encap open-coded. */
3998 if (!strncmp(s, "encap(", 6)) {
3999 const char *start = s;
4000 size_t encap, encap_mask = 0;
4002 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
4004 encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
4011 s += strspn(s, delimiters);
4014 } else if (*s == ')') {
4018 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
4026 nl_msg_end_nested(key, encap);
4028 nl_msg_end_nested(mask, encap_mask);
4037 /* Parses the string representation of a datapath flow key, in the
4038 * format output by odp_flow_key_format(). Returns 0 if successful,
4039 * otherwise a positive errno value. On success, the flow key is
4040 * appended to 'key' as a series of Netlink attributes. On failure, no
4041 * data is appended to 'key'. Either way, 'key''s data might be
4044 * If 'port_names' is nonnull, it points to an simap that maps from a port name
4045 * to a port number. (Port names may be used instead of port numbers in
4048 * On success, the attributes appended to 'key' are individually syntactically
4049 * valid, but they may not be valid as a sequence. 'key' might, for example,
4050 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
4052 odp_flow_from_string(const char *s, const struct simap *port_names,
4053 struct ofpbuf *key, struct ofpbuf *mask)
4055 const size_t old_size = key->size;
4059 s += strspn(s, delimiters);
4064 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
4066 key->size = old_size;
4076 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
4079 /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
4080 * not a set of flags or bitfields. Hence, if the struct flow nw_frag
4081 * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
4082 * must use a zero mask for the netlink frag field, and all ones mask
4084 return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
4086 return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
4087 : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
4088 : OVS_FRAG_TYPE_FIRST;
4091 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
4092 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
4093 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
4095 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
4097 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
4099 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
4101 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
4102 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
4103 static void get_nd_key(const struct flow *, struct ovs_key_nd *);
4104 static void put_nd_key(const struct ovs_key_nd *, struct flow *);
4106 /* These share the same layout. */
4108 struct ovs_key_tcp tcp;
4109 struct ovs_key_udp udp;
4110 struct ovs_key_sctp sctp;
4113 static void get_tp_key(const struct flow *, union ovs_key_tp *);
4114 static void put_tp_key(const union ovs_key_tp *, struct flow *);
4117 odp_flow_key_from_flow__(const struct odp_flow_key_parms *parms,
4118 bool export_mask, struct ofpbuf *buf)
4120 struct ovs_key_ethernet *eth_key;
4122 const struct flow *flow = parms->flow;
4123 const struct flow *data = export_mask ? parms->mask : parms->flow;
4125 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
4127 if (flow->tunnel.ip_dst || export_mask) {
4128 tun_key_to_attr(buf, &data->tunnel, &parms->flow->tunnel,
4132 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
4134 if (parms->support.ct_state) {
4135 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
4136 ovs_to_odp_ct_state(data->ct_state));
4138 if (parms->support.ct_zone) {
4139 nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, data->ct_zone);
4141 if (parms->support.ct_mark) {
4142 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, data->ct_mark);
4144 if (parms->support.ct_label) {
4145 nl_msg_put_unspec(buf, OVS_KEY_ATTR_CT_LABELS, &data->ct_label,
4146 sizeof(data->ct_label));
4148 if (parms->support.recirc) {
4149 nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
4150 nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
4153 /* Add an ingress port attribute if this is a mask or 'odp_in_port'
4154 * is not the magical value "ODPP_NONE". */
4155 if (export_mask || parms->odp_in_port != ODPP_NONE) {
4156 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, parms->odp_in_port);
4159 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
4161 get_ethernet_key(data, eth_key);
4163 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
4165 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
4167 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
4169 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
4170 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
4171 if (flow->vlan_tci == htons(0)) {
4178 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
4179 /* For backwards compatibility with kernels that don't support
4180 * wildcarding, the following convention is used to encode the
4181 * OVS_KEY_ATTR_ETHERTYPE for key and mask:
4184 * -------- -------- -------
4185 * >0x5ff 0xffff Specified Ethernet II Ethertype.
4186 * >0x5ff 0 Any Ethernet II or non-Ethernet II frame.
4187 * <none> 0xffff Any non-Ethernet II frame (except valid
4188 * 802.3 SNAP packet with valid eth_type).
4191 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
4196 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
4198 if (flow->dl_type == htons(ETH_TYPE_IP)) {
4199 struct ovs_key_ipv4 *ipv4_key;
4201 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
4203 get_ipv4_key(data, ipv4_key, export_mask);
4204 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
4205 struct ovs_key_ipv6 *ipv6_key;
4207 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
4209 get_ipv6_key(data, ipv6_key, export_mask);
4210 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
4211 flow->dl_type == htons(ETH_TYPE_RARP)) {
4212 struct ovs_key_arp *arp_key;
4214 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
4216 get_arp_key(data, arp_key);
4217 } else if (eth_type_mpls(flow->dl_type)) {
4218 struct ovs_key_mpls *mpls_key;
4221 n = flow_count_mpls_labels(flow, NULL);
4223 n = MIN(n, parms->support.max_mpls_depth);
4225 mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
4226 n * sizeof *mpls_key);
4227 for (i = 0; i < n; i++) {
4228 mpls_key[i].mpls_lse = data->mpls_lse[i];
4232 if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4233 if (flow->nw_proto == IPPROTO_TCP) {
4234 union ovs_key_tp *tcp_key;
4236 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
4238 get_tp_key(data, tcp_key);
4239 if (data->tcp_flags) {
4240 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
4242 } else if (flow->nw_proto == IPPROTO_UDP) {
4243 union ovs_key_tp *udp_key;
4245 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
4247 get_tp_key(data, udp_key);
4248 } else if (flow->nw_proto == IPPROTO_SCTP) {
4249 union ovs_key_tp *sctp_key;
4251 sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
4253 get_tp_key(data, sctp_key);
4254 } else if (flow->dl_type == htons(ETH_TYPE_IP)
4255 && flow->nw_proto == IPPROTO_ICMP) {
4256 struct ovs_key_icmp *icmp_key;
4258 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
4260 icmp_key->icmp_type = ntohs(data->tp_src);
4261 icmp_key->icmp_code = ntohs(data->tp_dst);
4262 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
4263 && flow->nw_proto == IPPROTO_ICMPV6) {
4264 struct ovs_key_icmpv6 *icmpv6_key;
4266 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
4267 sizeof *icmpv6_key);
4268 icmpv6_key->icmpv6_type = ntohs(data->tp_src);
4269 icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
4271 if (flow->tp_dst == htons(0)
4272 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
4273 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT))
4274 && (!export_mask || (data->tp_src == htons(0xffff)
4275 && data->tp_dst == htons(0xffff)))) {
4277 struct ovs_key_nd *nd_key;
4279 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
4281 memcpy(nd_key->nd_target, &data->nd_target,
4282 sizeof nd_key->nd_target);
4283 nd_key->nd_sll = data->arp_sha;
4284 nd_key->nd_tll = data->arp_tha;
4291 nl_msg_end_nested(buf, encap);
4295 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
4297 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
4298 * capable of being expanded to allow for that much space. */
4300 odp_flow_key_from_flow(const struct odp_flow_key_parms *parms,
4303 odp_flow_key_from_flow__(parms, false, buf);
4306 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
4309 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
4310 * capable of being expanded to allow for that much space. */
4312 odp_flow_key_from_mask(const struct odp_flow_key_parms *parms,
4315 odp_flow_key_from_flow__(parms, true, buf);
4318 /* Generate ODP flow key from the given packet metadata */
4320 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
4322 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
4324 if (md->tunnel.ip_dst) {
4325 tun_key_to_attr(buf, &md->tunnel, &md->tunnel, NULL);
4328 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
4331 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
4332 ovs_to_odp_ct_state(md->ct_state));
4334 nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, md->ct_zone);
4337 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, md->ct_mark);
4339 if (!ovs_u128_is_zero(&md->ct_label)) {
4340 nl_msg_put_unspec(buf, OVS_KEY_ATTR_CT_LABELS, &md->ct_label,
4341 sizeof(md->ct_label));
4345 /* Add an ingress port attribute if 'odp_in_port' is not the magical
4346 * value "ODPP_NONE". */
4347 if (md->in_port.odp_port != ODPP_NONE) {
4348 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
4352 /* Generate packet metadata from the given ODP flow key. */
4354 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
4355 struct pkt_metadata *md)
4357 const struct nlattr *nla;
4359 uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
4360 1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
4361 1u << OVS_KEY_ATTR_IN_PORT;
4363 pkt_metadata_init(md, ODPP_NONE);
4365 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
4366 uint16_t type = nl_attr_type(nla);
4367 size_t len = nl_attr_get_size(nla);
4368 int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
4369 OVS_KEY_ATTR_MAX, type);
4371 if (len != expected_len && expected_len >= 0) {
4376 case OVS_KEY_ATTR_RECIRC_ID:
4377 md->recirc_id = nl_attr_get_u32(nla);
4378 wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
4380 case OVS_KEY_ATTR_DP_HASH:
4381 md->dp_hash = nl_attr_get_u32(nla);
4382 wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
4384 case OVS_KEY_ATTR_PRIORITY:
4385 md->skb_priority = nl_attr_get_u32(nla);
4386 wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
4388 case OVS_KEY_ATTR_SKB_MARK:
4389 md->pkt_mark = nl_attr_get_u32(nla);
4390 wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
4392 case OVS_KEY_ATTR_CT_STATE:
4393 md->ct_state = odp_to_ovs_ct_state(nl_attr_get_u32(nla));
4394 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_STATE);
4396 case OVS_KEY_ATTR_CT_ZONE:
4397 md->ct_zone = nl_attr_get_u16(nla);
4398 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_ZONE);
4400 case OVS_KEY_ATTR_CT_MARK:
4401 md->ct_mark = nl_attr_get_u32(nla);
4402 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_MARK);
4404 case OVS_KEY_ATTR_CT_LABELS: {
4405 const ovs_u128 *cl = nl_attr_get(nla);
4408 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_LABELS);
4411 case OVS_KEY_ATTR_TUNNEL: {
4412 enum odp_key_fitness res;
4414 res = odp_tun_key_from_attr(nla, true, &md->tunnel);
4415 if (res == ODP_FIT_ERROR) {
4416 memset(&md->tunnel, 0, sizeof md->tunnel);
4417 } else if (res == ODP_FIT_PERFECT) {
4418 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
4422 case OVS_KEY_ATTR_IN_PORT:
4423 md->in_port.odp_port = nl_attr_get_odp_port(nla);
4424 wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
4430 if (!wanted_attrs) {
4431 return; /* Have everything. */
4437 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
4439 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
4440 return hash_words(ALIGNED_CAST(const uint32_t *, key),
4441 key_len / sizeof(uint32_t), 0);
4445 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
4446 uint64_t attrs, int out_of_range_attr,
4447 const struct nlattr *key, size_t key_len)
4452 if (VLOG_DROP_DBG(rl)) {
4457 for (i = 0; i < 64; i++) {
4458 if (attrs & (UINT64_C(1) << i)) {
4459 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4461 ds_put_format(&s, " %s",
4462 ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
4465 if (out_of_range_attr) {
4466 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
4469 ds_put_cstr(&s, ": ");
4470 odp_flow_key_format(key, key_len, &s);
4472 VLOG_DBG("%s:%s", title, ds_cstr(&s));
4477 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
4479 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4482 return odp_frag ? FLOW_NW_FRAG_MASK : 0;
4485 if (odp_frag > OVS_FRAG_TYPE_LATER) {
4486 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
4487 return 0xff; /* Error. */
4490 return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
4491 : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
4492 : FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
4496 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
4497 const struct nlattr *attrs[], uint64_t *present_attrsp,
4498 int *out_of_range_attrp)
4500 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4501 const struct nlattr *nla;
4502 uint64_t present_attrs;
4505 BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
4507 *out_of_range_attrp = 0;
4508 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
4509 uint16_t type = nl_attr_type(nla);
4510 size_t len = nl_attr_get_size(nla);
4511 int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
4512 OVS_KEY_ATTR_MAX, type);
4514 if (len != expected_len && expected_len >= 0) {
4515 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4517 VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
4518 "length %d", ovs_key_attr_to_string(type, namebuf,
4524 if (type > OVS_KEY_ATTR_MAX) {
4525 *out_of_range_attrp = type;
4527 if (present_attrs & (UINT64_C(1) << type)) {
4528 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4530 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
4531 ovs_key_attr_to_string(type,
4532 namebuf, sizeof namebuf));
4536 present_attrs |= UINT64_C(1) << type;
4541 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
4545 *present_attrsp = present_attrs;
4549 static enum odp_key_fitness
4550 check_expectations(uint64_t present_attrs, int out_of_range_attr,
4551 uint64_t expected_attrs,
4552 const struct nlattr *key, size_t key_len)
4554 uint64_t missing_attrs;
4555 uint64_t extra_attrs;
4557 missing_attrs = expected_attrs & ~present_attrs;
4558 if (missing_attrs) {
4559 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4560 log_odp_key_attributes(&rl, "expected but not present",
4561 missing_attrs, 0, key, key_len);
4562 return ODP_FIT_TOO_LITTLE;
4565 extra_attrs = present_attrs & ~expected_attrs;
4566 if (extra_attrs || out_of_range_attr) {
4567 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4568 log_odp_key_attributes(&rl, "present but not expected",
4569 extra_attrs, out_of_range_attr, key, key_len);
4570 return ODP_FIT_TOO_MUCH;
4573 return ODP_FIT_PERFECT;
4577 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4578 uint64_t present_attrs, uint64_t *expected_attrs,
4579 struct flow *flow, const struct flow *src_flow)
4581 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4582 bool is_mask = flow != src_flow;
4584 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
4585 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
4586 if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
4587 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
4588 ntohs(flow->dl_type));
4591 if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
4592 flow->dl_type != htons(0xffff)) {
4595 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
4598 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
4599 } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
4600 /* See comments in odp_flow_key_from_flow__(). */
4601 VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
4608 static enum odp_key_fitness
4609 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4610 uint64_t present_attrs, int out_of_range_attr,
4611 uint64_t expected_attrs, struct flow *flow,
4612 const struct nlattr *key, size_t key_len,
4613 const struct flow *src_flow)
4615 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4616 bool is_mask = src_flow != flow;
4617 const void *check_start = NULL;
4618 size_t check_len = 0;
4619 enum ovs_key_attr expected_bit = 0xff;
4621 if (eth_type_mpls(src_flow->dl_type)) {
4622 if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4623 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
4625 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4626 size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
4627 const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
4628 int n = size / sizeof(ovs_be32);
4631 if (!size || size % sizeof(ovs_be32)) {
4632 return ODP_FIT_ERROR;
4634 if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
4635 return ODP_FIT_ERROR;
4638 for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
4639 flow->mpls_lse[i] = mpls_lse[i];
4641 if (n > FLOW_MAX_MPLS_LABELS) {
4642 return ODP_FIT_TOO_MUCH;
4646 /* BOS may be set only in the innermost label. */
4647 for (i = 0; i < n - 1; i++) {
4648 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
4649 return ODP_FIT_ERROR;
4653 /* BOS must be set in the innermost label. */
4654 if (n < FLOW_MAX_MPLS_LABELS
4655 && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
4656 return ODP_FIT_TOO_LITTLE;
4662 } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
4664 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
4666 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
4667 const struct ovs_key_ipv4 *ipv4_key;
4669 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
4670 put_ipv4_key(ipv4_key, flow, is_mask);
4671 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4672 return ODP_FIT_ERROR;
4675 check_start = ipv4_key;
4676 check_len = sizeof *ipv4_key;
4677 expected_bit = OVS_KEY_ATTR_IPV4;
4680 } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
4682 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
4684 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
4685 const struct ovs_key_ipv6 *ipv6_key;
4687 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
4688 put_ipv6_key(ipv6_key, flow, is_mask);
4689 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4690 return ODP_FIT_ERROR;
4693 check_start = ipv6_key;
4694 check_len = sizeof *ipv6_key;
4695 expected_bit = OVS_KEY_ATTR_IPV6;
4698 } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
4699 src_flow->dl_type == htons(ETH_TYPE_RARP)) {
4701 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
4703 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
4704 const struct ovs_key_arp *arp_key;
4706 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
4707 if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
4708 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
4709 "key", ntohs(arp_key->arp_op));
4710 return ODP_FIT_ERROR;
4712 put_arp_key(arp_key, flow);
4714 check_start = arp_key;
4715 check_len = sizeof *arp_key;
4716 expected_bit = OVS_KEY_ATTR_ARP;
4722 if (check_len > 0) { /* Happens only when 'is_mask'. */
4723 if (!is_all_zeros(check_start, check_len) &&
4724 flow->dl_type != htons(0xffff)) {
4725 return ODP_FIT_ERROR;
4727 expected_attrs |= UINT64_C(1) << expected_bit;
4731 expected_bit = OVS_KEY_ATTR_UNSPEC;
4732 if (src_flow->nw_proto == IPPROTO_TCP
4733 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4734 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4735 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4737 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
4739 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
4740 const union ovs_key_tp *tcp_key;
4742 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
4743 put_tp_key(tcp_key, flow);
4744 expected_bit = OVS_KEY_ATTR_TCP;
4746 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
4747 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
4748 flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
4750 } else if (src_flow->nw_proto == IPPROTO_UDP
4751 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4752 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4753 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4755 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
4757 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
4758 const union ovs_key_tp *udp_key;
4760 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
4761 put_tp_key(udp_key, flow);
4762 expected_bit = OVS_KEY_ATTR_UDP;
4764 } else if (src_flow->nw_proto == IPPROTO_SCTP
4765 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4766 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4767 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4769 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
4771 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
4772 const union ovs_key_tp *sctp_key;
4774 sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
4775 put_tp_key(sctp_key, flow);
4776 expected_bit = OVS_KEY_ATTR_SCTP;
4778 } else if (src_flow->nw_proto == IPPROTO_ICMP
4779 && src_flow->dl_type == htons(ETH_TYPE_IP)
4780 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4782 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
4784 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
4785 const struct ovs_key_icmp *icmp_key;
4787 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
4788 flow->tp_src = htons(icmp_key->icmp_type);
4789 flow->tp_dst = htons(icmp_key->icmp_code);
4790 expected_bit = OVS_KEY_ATTR_ICMP;
4792 } else if (src_flow->nw_proto == IPPROTO_ICMPV6
4793 && src_flow->dl_type == htons(ETH_TYPE_IPV6)
4794 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4796 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
4798 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
4799 const struct ovs_key_icmpv6 *icmpv6_key;
4801 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
4802 flow->tp_src = htons(icmpv6_key->icmpv6_type);
4803 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
4804 expected_bit = OVS_KEY_ATTR_ICMPV6;
4805 if (src_flow->tp_dst == htons(0) &&
4806 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
4807 src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
4809 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4811 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
4812 const struct ovs_key_nd *nd_key;
4814 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
4815 memcpy(&flow->nd_target, nd_key->nd_target,
4816 sizeof flow->nd_target);
4817 flow->arp_sha = nd_key->nd_sll;
4818 flow->arp_tha = nd_key->nd_tll;
4820 if (!is_all_zeros(nd_key, sizeof *nd_key) &&
4821 (flow->tp_src != htons(0xffff) ||
4822 flow->tp_dst != htons(0xffff))) {
4823 return ODP_FIT_ERROR;
4825 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4832 if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
4833 if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
4834 return ODP_FIT_ERROR;
4836 expected_attrs |= UINT64_C(1) << expected_bit;
4841 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
4845 /* Parse 802.1Q header then encapsulated L3 attributes. */
4846 static enum odp_key_fitness
4847 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4848 uint64_t present_attrs, int out_of_range_attr,
4849 uint64_t expected_attrs, struct flow *flow,
4850 const struct nlattr *key, size_t key_len,
4851 const struct flow *src_flow)
4853 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4854 bool is_mask = src_flow != flow;
4856 const struct nlattr *encap
4857 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
4858 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
4859 enum odp_key_fitness encap_fitness;
4860 enum odp_key_fitness fitness;
4862 /* Calculate fitness of outer attributes. */
4864 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
4865 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
4867 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4868 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4870 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
4871 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
4874 fitness = check_expectations(present_attrs, out_of_range_attr,
4875 expected_attrs, key, key_len);
4878 * Remove the TPID from dl_type since it's not the real Ethertype. */
4879 flow->dl_type = htons(0);
4880 flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
4881 ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
4884 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
4885 return ODP_FIT_TOO_LITTLE;
4886 } else if (flow->vlan_tci == htons(0)) {
4887 /* Corner case for a truncated 802.1Q header. */
4888 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
4889 return ODP_FIT_TOO_MUCH;
4892 } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
4893 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
4894 "but CFI bit is not set", ntohs(flow->vlan_tci));
4895 return ODP_FIT_ERROR;
4898 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
4903 /* Now parse the encapsulated attributes. */
4904 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
4905 attrs, &present_attrs, &out_of_range_attr)) {
4906 return ODP_FIT_ERROR;
4910 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
4911 return ODP_FIT_ERROR;
4913 encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4914 expected_attrs, flow, key, key_len,
4917 /* The overall fitness is the worse of the outer and inner attributes. */
4918 return MAX(fitness, encap_fitness);
4921 static enum odp_key_fitness
4922 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
4923 const struct nlattr *src_key, size_t src_key_len,
4924 struct flow *flow, const struct flow *src_flow,
4927 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
4928 uint64_t expected_attrs;
4929 uint64_t present_attrs;
4930 int out_of_range_attr;
4931 bool is_mask = src_flow != flow;
4933 memset(flow, 0, sizeof *flow);
4935 /* Parse attributes. */
4936 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
4937 &out_of_range_attr)) {
4938 return ODP_FIT_ERROR;
4943 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
4944 flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
4945 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
4946 } else if (is_mask) {
4947 /* Always exact match recirc_id if it is not specified. */
4948 flow->recirc_id = UINT32_MAX;
4951 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
4952 flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
4953 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
4955 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
4956 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
4957 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
4960 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
4961 flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
4962 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
4965 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_STATE)) {
4966 uint32_t odp_state = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_STATE]);
4968 flow->ct_state = odp_to_ovs_ct_state(odp_state);
4969 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_STATE;
4971 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE)) {
4972 flow->ct_zone = nl_attr_get_u16(attrs[OVS_KEY_ATTR_CT_ZONE]);
4973 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE;
4975 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_MARK)) {
4976 flow->ct_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_MARK]);
4977 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_MARK;
4979 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_LABELS)) {
4980 const ovs_u128 *cl = nl_attr_get(attrs[OVS_KEY_ATTR_CT_LABELS]);
4982 flow->ct_label = *cl;
4983 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_LABELS;
4986 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
4987 enum odp_key_fitness res;
4989 res = odp_tun_key_from_attr__(attrs[OVS_KEY_ATTR_TUNNEL],
4990 is_mask ? src_key : NULL,
4991 src_key_len, &src_flow->tunnel,
4992 &flow->tunnel, udpif);
4993 if (res == ODP_FIT_ERROR) {
4994 return ODP_FIT_ERROR;
4995 } else if (res == ODP_FIT_PERFECT) {
4996 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
5000 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
5001 flow->in_port.odp_port
5002 = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
5003 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
5004 } else if (!is_mask) {
5005 flow->in_port.odp_port = ODPP_NONE;
5008 /* Ethernet header. */
5009 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
5010 const struct ovs_key_ethernet *eth_key;
5012 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
5013 put_ethernet_key(eth_key, flow);
5015 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
5019 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
5022 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
5023 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
5025 return ODP_FIT_ERROR;
5029 ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
5030 : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
5031 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
5032 expected_attrs, flow, key, key_len, src_flow);
5035 /* A missing VLAN mask means exact match on vlan_tci 0 (== no VLAN). */
5036 flow->vlan_tci = htons(0xffff);
5037 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
5038 flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
5039 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
5042 return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
5043 expected_attrs, flow, key, key_len, src_flow);
5046 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
5047 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
5048 * 'key' fits our expectations for what a flow key should contain.
5050 * The 'in_port' will be the datapath's understanding of the port. The
5051 * caller will need to translate with odp_port_to_ofp_port() if the
5052 * OpenFlow port is needed.
5054 * This function doesn't take the packet itself as an argument because none of
5055 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
5056 * it is always possible to infer which additional attribute(s) should appear
5057 * by looking at the attributes for lower-level protocols, e.g. if the network
5058 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
5059 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
5060 * must be absent. */
5061 enum odp_key_fitness
5062 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
5065 return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, false);
5068 /* Converts the 'mask_key_len' bytes of OVS_KEY_ATTR_* attributes in 'mask_key'
5069 * to a mask structure in 'mask'. 'flow' must be a previously translated flow
5070 * corresponding to 'mask' and similarly flow_key/flow_key_len must be the
5071 * attributes from that flow. Returns an ODP_FIT_* value that indicates how
5072 * well 'key' fits our expectations for what a flow key should contain. */
5073 enum odp_key_fitness
5074 odp_flow_key_to_mask(const struct nlattr *mask_key, size_t mask_key_len,
5075 const struct nlattr *flow_key, size_t flow_key_len,
5076 struct flow *mask, const struct flow *flow)
5078 return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
5082 /* These functions are similar to their non-"_udpif" variants but output a
5083 * 'flow' that is suitable for fast-path packet processing.
5085 * Some fields have different representation for flow setup and per-
5086 * packet processing (i.e. different between ofproto-dpif and userspace
5087 * datapath). In particular, with the non-"_udpif" functions, struct
5088 * tun_metadata is in the per-flow format (using 'present.map' and 'opts.u8');
5089 * with these functions, struct tun_metadata is in the per-packet format
5090 * (using 'present.len' and 'opts.gnv'). */
5091 enum odp_key_fitness
5092 odp_flow_key_to_flow_udpif(const struct nlattr *key, size_t key_len,
5095 return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, true);
5098 enum odp_key_fitness
5099 odp_flow_key_to_mask_udpif(const struct nlattr *mask_key, size_t mask_key_len,
5100 const struct nlattr *flow_key, size_t flow_key_len,
5101 struct flow *mask, const struct flow *flow)
5103 return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
5107 /* Returns 'fitness' as a string, for use in debug messages. */
5109 odp_key_fitness_to_string(enum odp_key_fitness fitness)
5112 case ODP_FIT_PERFECT:
5114 case ODP_FIT_TOO_MUCH:
5116 case ODP_FIT_TOO_LITTLE:
5117 return "too_little";
5125 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
5126 * Netlink PID 'pid'. If 'userdata' is nonnull, adds a userdata attribute
5127 * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
5128 * offset within 'odp_actions' of the start of the cookie. (If 'userdata' is
5129 * null, then the return value is not meaningful.) */
5131 odp_put_userspace_action(uint32_t pid,
5132 const void *userdata, size_t userdata_size,
5133 odp_port_t tunnel_out_port,
5134 bool include_actions,
5135 struct ofpbuf *odp_actions)
5137 size_t userdata_ofs;
5140 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
5141 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
5143 userdata_ofs = odp_actions->size + NLA_HDRLEN;
5145 /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
5146 * module before Linux 3.10 required the userdata to be exactly 8 bytes
5149 * - The kernel rejected shorter userdata with -ERANGE.
5151 * - The kernel silently dropped userdata beyond the first 8 bytes.
5153 * Thus, for maximum compatibility, always put at least 8 bytes. (We
5154 * separately disable features that required more than 8 bytes.) */
5155 memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
5156 MAX(8, userdata_size)),
5157 userdata, userdata_size);
5161 if (tunnel_out_port != ODPP_NONE) {
5162 nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
5165 if (include_actions) {
5166 nl_msg_put_flag(odp_actions, OVS_USERSPACE_ATTR_ACTIONS);
5168 nl_msg_end_nested(odp_actions, offset);
5170 return userdata_ofs;
5174 odp_put_tunnel_action(const struct flow_tnl *tunnel,
5175 struct ofpbuf *odp_actions)
5177 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
5178 tun_key_to_attr(odp_actions, tunnel, tunnel, NULL);
5179 nl_msg_end_nested(odp_actions, offset);
5183 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
5184 struct ovs_action_push_tnl *data)
5186 int size = offsetof(struct ovs_action_push_tnl, header);
5188 size += data->header_len;
5189 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
5193 /* The commit_odp_actions() function and its helpers. */
5196 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
5197 const void *key, size_t key_size)
5199 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
5200 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
5201 nl_msg_end_nested(odp_actions, offset);
5204 /* Masked set actions have a mask following the data within the netlink
5205 * attribute. The unmasked bits in the data will be cleared as the data
5206 * is copied to the action. */
5208 commit_masked_set_action(struct ofpbuf *odp_actions,
5209 enum ovs_key_attr key_type,
5210 const void *key_, const void *mask_, size_t key_size)
5212 size_t offset = nl_msg_start_nested(odp_actions,
5213 OVS_ACTION_ATTR_SET_MASKED);
5214 char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
5215 const char *key = key_, *mask = mask_;
5217 memcpy(data + key_size, mask, key_size);
5218 /* Clear unmasked bits while copying. */
5219 while (key_size--) {
5220 *data++ = *key++ & *mask++;
5222 nl_msg_end_nested(odp_actions, offset);
5225 /* If any of the flow key data that ODP actions can modify are different in
5226 * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
5227 * 'odp_actions' that change the flow tunneling information in key from
5228 * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
5229 * same way. In other words, operates the same as commit_odp_actions(), but
5230 * only on tunneling information. */
5232 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
5233 struct ofpbuf *odp_actions)
5235 /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
5236 if (flow->tunnel.ip_dst) {
5237 if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
5240 memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
5241 odp_put_tunnel_action(&base->tunnel, odp_actions);
5246 commit(enum ovs_key_attr attr, bool use_masked_set,
5247 const void *key, void *base, void *mask, size_t size,
5248 struct ofpbuf *odp_actions)
5250 if (memcmp(key, base, size)) {
5251 bool fully_masked = odp_mask_is_exact(attr, mask, size);
5253 if (use_masked_set && !fully_masked) {
5254 commit_masked_set_action(odp_actions, attr, key, mask, size);
5256 if (!fully_masked) {
5257 memset(mask, 0xff, size);
5259 commit_set_action(odp_actions, attr, key, size);
5261 memcpy(base, key, size);
5264 /* Mask bits are set when we have either read or set the corresponding
5265 * values. Masked bits will be exact-matched, no need to set them
5266 * if the value did not actually change. */
5272 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
5274 eth->eth_src = flow->dl_src;
5275 eth->eth_dst = flow->dl_dst;
5279 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
5281 flow->dl_src = eth->eth_src;
5282 flow->dl_dst = eth->eth_dst;
5286 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
5287 struct ofpbuf *odp_actions,
5288 struct flow_wildcards *wc,
5291 struct ovs_key_ethernet key, base, mask;
5293 get_ethernet_key(flow, &key);
5294 get_ethernet_key(base_flow, &base);
5295 get_ethernet_key(&wc->masks, &mask);
5297 if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
5298 &key, &base, &mask, sizeof key, odp_actions)) {
5299 put_ethernet_key(&base, base_flow);
5300 put_ethernet_key(&mask, &wc->masks);
5305 pop_vlan(struct flow *base,
5306 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5308 memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
5310 if (base->vlan_tci & htons(VLAN_CFI)) {
5311 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
5317 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
5318 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5320 if (base->vlan_tci == vlan_tci) {
5324 pop_vlan(base, odp_actions, wc);
5325 if (vlan_tci & htons(VLAN_CFI)) {
5326 struct ovs_action_push_vlan vlan;
5328 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
5329 vlan.vlan_tci = vlan_tci;
5330 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
5331 &vlan, sizeof vlan);
5333 base->vlan_tci = vlan_tci;
5336 /* Wildcarding already done at action translation time. */
5338 commit_mpls_action(const struct flow *flow, struct flow *base,
5339 struct ofpbuf *odp_actions)
5341 int base_n = flow_count_mpls_labels(base, NULL);
5342 int flow_n = flow_count_mpls_labels(flow, NULL);
5343 int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
5346 while (base_n > common_n) {
5347 if (base_n - 1 == common_n && flow_n > common_n) {
5348 /* If there is only one more LSE in base than there are common
5349 * between base and flow; and flow has at least one more LSE than
5350 * is common then the topmost LSE of base may be updated using
5352 struct ovs_key_mpls mpls_key;
5354 mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
5355 commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
5356 &mpls_key, sizeof mpls_key);
5357 flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
5360 /* Otherwise, if there more LSEs in base than are common between
5361 * base and flow then pop the topmost one. */
5365 /* If all the LSEs are to be popped and this is not the outermost
5366 * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
5367 * POP_MPLS action instead of flow->dl_type.
5369 * This is because the POP_MPLS action requires its ethertype
5370 * argument to be an MPLS ethernet type but in this case
5371 * flow->dl_type will be a non-MPLS ethernet type.
5373 * When the final POP_MPLS action occurs it use flow->dl_type and
5374 * the and the resulting packet will have the desired dl_type. */
5375 if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
5376 dl_type = htons(ETH_TYPE_MPLS);
5378 dl_type = flow->dl_type;
5380 nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
5381 popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
5387 /* If, after the above popping and setting, there are more LSEs in flow
5388 * than base then some LSEs need to be pushed. */
5389 while (base_n < flow_n) {
5390 struct ovs_action_push_mpls *mpls;
5392 mpls = nl_msg_put_unspec_zero(odp_actions,
5393 OVS_ACTION_ATTR_PUSH_MPLS,
5395 mpls->mpls_ethertype = flow->dl_type;
5396 mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
5397 flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
5398 flow_set_mpls_lse(base, 0, mpls->mpls_lse);
5404 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
5406 ipv4->ipv4_src = flow->nw_src;
5407 ipv4->ipv4_dst = flow->nw_dst;
5408 ipv4->ipv4_proto = flow->nw_proto;
5409 ipv4->ipv4_tos = flow->nw_tos;
5410 ipv4->ipv4_ttl = flow->nw_ttl;
5411 ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
5415 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
5417 flow->nw_src = ipv4->ipv4_src;
5418 flow->nw_dst = ipv4->ipv4_dst;
5419 flow->nw_proto = ipv4->ipv4_proto;
5420 flow->nw_tos = ipv4->ipv4_tos;
5421 flow->nw_ttl = ipv4->ipv4_ttl;
5422 flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
5426 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
5427 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5430 struct ovs_key_ipv4 key, mask, base;
5432 /* Check that nw_proto and nw_frag remain unchanged. */
5433 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
5434 flow->nw_frag == base_flow->nw_frag);
5436 get_ipv4_key(flow, &key, false);
5437 get_ipv4_key(base_flow, &base, false);
5438 get_ipv4_key(&wc->masks, &mask, true);
5439 mask.ipv4_proto = 0; /* Not writeable. */
5440 mask.ipv4_frag = 0; /* Not writable. */
5442 if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
5444 put_ipv4_key(&base, base_flow, false);
5445 if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
5446 put_ipv4_key(&mask, &wc->masks, true);
5452 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
5454 memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
5455 memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
5456 ipv6->ipv6_label = flow->ipv6_label;
5457 ipv6->ipv6_proto = flow->nw_proto;
5458 ipv6->ipv6_tclass = flow->nw_tos;
5459 ipv6->ipv6_hlimit = flow->nw_ttl;
5460 ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
5464 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
5466 memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
5467 memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
5468 flow->ipv6_label = ipv6->ipv6_label;
5469 flow->nw_proto = ipv6->ipv6_proto;
5470 flow->nw_tos = ipv6->ipv6_tclass;
5471 flow->nw_ttl = ipv6->ipv6_hlimit;
5472 flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
5476 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
5477 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5480 struct ovs_key_ipv6 key, mask, base;
5482 /* Check that nw_proto and nw_frag remain unchanged. */
5483 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
5484 flow->nw_frag == base_flow->nw_frag);
5486 get_ipv6_key(flow, &key, false);
5487 get_ipv6_key(base_flow, &base, false);
5488 get_ipv6_key(&wc->masks, &mask, true);
5489 mask.ipv6_proto = 0; /* Not writeable. */
5490 mask.ipv6_frag = 0; /* Not writable. */
5492 if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
5494 put_ipv6_key(&base, base_flow, false);
5495 if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
5496 put_ipv6_key(&mask, &wc->masks, true);
5502 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
5504 /* ARP key has padding, clear it. */
5505 memset(arp, 0, sizeof *arp);
5507 arp->arp_sip = flow->nw_src;
5508 arp->arp_tip = flow->nw_dst;
5509 arp->arp_op = htons(flow->nw_proto);
5510 arp->arp_sha = flow->arp_sha;
5511 arp->arp_tha = flow->arp_tha;
5515 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
5517 flow->nw_src = arp->arp_sip;
5518 flow->nw_dst = arp->arp_tip;
5519 flow->nw_proto = ntohs(arp->arp_op);
5520 flow->arp_sha = arp->arp_sha;
5521 flow->arp_tha = arp->arp_tha;
5524 static enum slow_path_reason
5525 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
5526 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5528 struct ovs_key_arp key, mask, base;
5530 get_arp_key(flow, &key);
5531 get_arp_key(base_flow, &base);
5532 get_arp_key(&wc->masks, &mask);
5534 if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
5536 put_arp_key(&base, base_flow);
5537 put_arp_key(&mask, &wc->masks);
5544 get_icmp_key(const struct flow *flow, struct ovs_key_icmp *icmp)
5546 /* icmp_type and icmp_code are stored in tp_src and tp_dst, respectively */
5547 icmp->icmp_type = ntohs(flow->tp_src);
5548 icmp->icmp_code = ntohs(flow->tp_dst);
5552 put_icmp_key(const struct ovs_key_icmp *icmp, struct flow *flow)
5554 /* icmp_type and icmp_code are stored in tp_src and tp_dst, respectively */
5555 flow->tp_src = htons(icmp->icmp_type);
5556 flow->tp_dst = htons(icmp->icmp_code);
5559 static enum slow_path_reason
5560 commit_set_icmp_action(const struct flow *flow, struct flow *base_flow,
5561 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5563 struct ovs_key_icmp key, mask, base;
5564 enum ovs_key_attr attr;
5566 get_icmp_key(flow, &key);
5567 get_icmp_key(base_flow, &base);
5568 get_icmp_key(&wc->masks, &mask);
5570 attr = flow->dl_type == htons(ETH_TYPE_IP) ? OVS_KEY_ATTR_ICMP
5571 : OVS_KEY_ATTR_ICMPV6;
5572 if (commit(attr, false, &key, &base, &mask, sizeof key, odp_actions)) {
5573 put_icmp_key(&base, base_flow);
5574 put_icmp_key(&mask, &wc->masks);
5581 get_nd_key(const struct flow *flow, struct ovs_key_nd *nd)
5583 memcpy(nd->nd_target, &flow->nd_target, sizeof flow->nd_target);
5584 /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5585 nd->nd_sll = flow->arp_sha;
5586 nd->nd_tll = flow->arp_tha;
5590 put_nd_key(const struct ovs_key_nd *nd, struct flow *flow)
5592 memcpy(&flow->nd_target, nd->nd_target, sizeof flow->nd_target);
5593 /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5594 flow->arp_sha = nd->nd_sll;
5595 flow->arp_tha = nd->nd_tll;
5598 static enum slow_path_reason
5599 commit_set_nd_action(const struct flow *flow, struct flow *base_flow,
5600 struct ofpbuf *odp_actions,
5601 struct flow_wildcards *wc, bool use_masked)
5603 struct ovs_key_nd key, mask, base;
5605 get_nd_key(flow, &key);
5606 get_nd_key(base_flow, &base);
5607 get_nd_key(&wc->masks, &mask);
5609 if (commit(OVS_KEY_ATTR_ND, use_masked, &key, &base, &mask, sizeof key,
5611 put_nd_key(&base, base_flow);
5612 put_nd_key(&mask, &wc->masks);
5619 static enum slow_path_reason
5620 commit_set_nw_action(const struct flow *flow, struct flow *base,
5621 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5624 /* Check if 'flow' really has an L3 header. */
5625 if (!flow->nw_proto) {
5629 switch (ntohs(base->dl_type)) {
5631 commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
5635 commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
5636 return commit_set_nd_action(flow, base, odp_actions, wc, use_masked);
5639 return commit_set_arp_action(flow, base, odp_actions, wc);
5645 /* TCP, UDP, and SCTP keys have the same layout. */
5646 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
5647 sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
5650 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
5652 tp->tcp.tcp_src = flow->tp_src;
5653 tp->tcp.tcp_dst = flow->tp_dst;
5657 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
5659 flow->tp_src = tp->tcp.tcp_src;
5660 flow->tp_dst = tp->tcp.tcp_dst;
5664 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
5665 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5668 enum ovs_key_attr key_type;
5669 union ovs_key_tp key, mask, base;
5671 /* Check if 'flow' really has an L3 header. */
5672 if (!flow->nw_proto) {
5676 if (!is_ip_any(base_flow)) {
5680 if (flow->nw_proto == IPPROTO_TCP) {
5681 key_type = OVS_KEY_ATTR_TCP;
5682 } else if (flow->nw_proto == IPPROTO_UDP) {
5683 key_type = OVS_KEY_ATTR_UDP;
5684 } else if (flow->nw_proto == IPPROTO_SCTP) {
5685 key_type = OVS_KEY_ATTR_SCTP;
5690 get_tp_key(flow, &key);
5691 get_tp_key(base_flow, &base);
5692 get_tp_key(&wc->masks, &mask);
5694 if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
5696 put_tp_key(&base, base_flow);
5697 put_tp_key(&mask, &wc->masks);
5702 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
5703 struct ofpbuf *odp_actions,
5704 struct flow_wildcards *wc,
5707 uint32_t key, mask, base;
5709 key = flow->skb_priority;
5710 base = base_flow->skb_priority;
5711 mask = wc->masks.skb_priority;
5713 if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
5714 sizeof key, odp_actions)) {
5715 base_flow->skb_priority = base;
5716 wc->masks.skb_priority = mask;
5721 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base_flow,
5722 struct ofpbuf *odp_actions,
5723 struct flow_wildcards *wc,
5726 uint32_t key, mask, base;
5728 key = flow->pkt_mark;
5729 base = base_flow->pkt_mark;
5730 mask = wc->masks.pkt_mark;
5732 if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
5733 sizeof key, odp_actions)) {
5734 base_flow->pkt_mark = base;
5735 wc->masks.pkt_mark = mask;
5739 /* If any of the flow key data that ODP actions can modify are different in
5740 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
5741 * key from 'base' into 'flow', and then changes 'base' the same way. Does not
5742 * commit set_tunnel actions. Users should call commit_odp_tunnel_action()
5743 * in addition to this function if needed. Sets fields in 'wc' that are
5744 * used as part of the action.
5746 * Returns a reason to force processing the flow's packets into the userspace
5747 * slow path, if there is one, otherwise 0. */
5748 enum slow_path_reason
5749 commit_odp_actions(const struct flow *flow, struct flow *base,
5750 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5753 enum slow_path_reason slow1, slow2;
5755 commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
5756 slow1 = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
5757 commit_set_port_action(flow, base, odp_actions, wc, use_masked);
5758 slow2 = commit_set_icmp_action(flow, base, odp_actions, wc);
5759 commit_mpls_action(flow, base, odp_actions);
5760 commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
5761 commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
5762 commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);
5764 return slow1 ? slow1 : slow2;