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";
58 const struct attr_len_tbl *next;
61 #define ATTR_LEN_INVALID -1
62 #define ATTR_LEN_VARIABLE -2
63 #define ATTR_LEN_NESTED -3
65 static int parse_odp_key_mask_attr(const char *, const struct simap *port_names,
66 struct ofpbuf *, struct ofpbuf *);
67 static void format_odp_key_attr(const struct nlattr *a,
68 const struct nlattr *ma,
69 const struct hmap *portno_names, struct ds *ds,
73 struct geneve_opt d[63];
77 static int scan_geneve(const char *s, struct geneve_scan *key,
78 struct geneve_scan *mask);
79 static void format_geneve_opts(const struct geneve_opt *opt,
80 const struct geneve_opt *mask, int opts_len,
81 struct ds *, bool verbose);
83 static struct nlattr *generate_all_wildcard_mask(const struct attr_len_tbl tbl[],
84 int max, struct ofpbuf *,
85 const struct nlattr *key);
86 static void format_u128(struct ds *ds, const ovs_u128 *value,
87 const ovs_u128 *mask, bool verbose);
88 static int scan_u128(const char *s, ovs_u128 *value, ovs_u128 *mask);
90 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
93 * - For an action whose argument has a fixed length, returned that
94 * nonnegative length in bytes.
96 * - For an action with a variable-length argument, returns ATTR_LEN_VARIABLE.
98 * - For an invalid 'type', returns ATTR_LEN_INVALID. */
100 odp_action_len(uint16_t type)
102 if (type > OVS_ACTION_ATTR_MAX) {
106 switch ((enum ovs_action_attr) type) {
107 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
108 case OVS_ACTION_ATTR_TUNNEL_PUSH: return ATTR_LEN_VARIABLE;
109 case OVS_ACTION_ATTR_TUNNEL_POP: return sizeof(uint32_t);
110 case OVS_ACTION_ATTR_USERSPACE: return ATTR_LEN_VARIABLE;
111 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
112 case OVS_ACTION_ATTR_POP_VLAN: return 0;
113 case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
114 case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
115 case OVS_ACTION_ATTR_RECIRC: return sizeof(uint32_t);
116 case OVS_ACTION_ATTR_HASH: return sizeof(struct ovs_action_hash);
117 case OVS_ACTION_ATTR_SET: return ATTR_LEN_VARIABLE;
118 case OVS_ACTION_ATTR_SET_MASKED: return ATTR_LEN_VARIABLE;
119 case OVS_ACTION_ATTR_SAMPLE: return ATTR_LEN_VARIABLE;
120 case OVS_ACTION_ATTR_CT: return ATTR_LEN_VARIABLE;
122 case OVS_ACTION_ATTR_UNSPEC:
123 case __OVS_ACTION_ATTR_MAX:
124 return ATTR_LEN_INVALID;
127 return ATTR_LEN_INVALID;
130 /* Returns a string form of 'attr'. The return value is either a statically
131 * allocated constant string or the 'bufsize'-byte buffer 'namebuf'. 'bufsize'
132 * should be at least OVS_KEY_ATTR_BUFSIZE. */
133 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
135 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
138 case OVS_KEY_ATTR_UNSPEC: return "unspec";
139 case OVS_KEY_ATTR_ENCAP: return "encap";
140 case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
141 case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
142 case OVS_KEY_ATTR_CT_STATE: return "ct_state";
143 case OVS_KEY_ATTR_CT_ZONE: return "ct_zone";
144 case OVS_KEY_ATTR_CT_MARK: return "ct_mark";
145 case OVS_KEY_ATTR_CT_LABELS: return "ct_label";
146 case OVS_KEY_ATTR_TUNNEL: return "tunnel";
147 case OVS_KEY_ATTR_IN_PORT: return "in_port";
148 case OVS_KEY_ATTR_ETHERNET: return "eth";
149 case OVS_KEY_ATTR_VLAN: return "vlan";
150 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
151 case OVS_KEY_ATTR_IPV4: return "ipv4";
152 case OVS_KEY_ATTR_IPV6: return "ipv6";
153 case OVS_KEY_ATTR_TCP: return "tcp";
154 case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
155 case OVS_KEY_ATTR_UDP: return "udp";
156 case OVS_KEY_ATTR_SCTP: return "sctp";
157 case OVS_KEY_ATTR_ICMP: return "icmp";
158 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
159 case OVS_KEY_ATTR_ARP: return "arp";
160 case OVS_KEY_ATTR_ND: return "nd";
161 case OVS_KEY_ATTR_MPLS: return "mpls";
162 case OVS_KEY_ATTR_DP_HASH: return "dp_hash";
163 case OVS_KEY_ATTR_RECIRC_ID: return "recirc_id";
165 case __OVS_KEY_ATTR_MAX:
167 snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
173 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
175 size_t len = nl_attr_get_size(a);
177 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
179 const uint8_t *unspec;
182 unspec = nl_attr_get(a);
183 for (i = 0; i < len; i++) {
184 ds_put_char(ds, i ? ' ': '(');
185 ds_put_format(ds, "%02x", unspec[i]);
187 ds_put_char(ds, ')');
192 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
194 static const struct nl_policy ovs_sample_policy[] = {
195 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
196 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
198 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
200 const struct nlattr *nla_acts;
203 ds_put_cstr(ds, "sample");
205 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
206 ds_put_cstr(ds, "(error)");
210 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
213 ds_put_format(ds, "(sample=%.1f%%,", percentage);
215 ds_put_cstr(ds, "actions(");
216 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
217 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
218 format_odp_actions(ds, nla_acts, len);
219 ds_put_format(ds, "))");
223 slow_path_reason_to_string(uint32_t reason)
225 switch ((enum slow_path_reason) reason) {
226 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
235 slow_path_reason_to_explanation(enum slow_path_reason reason)
238 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
247 parse_odp_flags(const char *s, const char *(*bit_to_string)(uint32_t),
248 uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask)
250 return parse_flags(s, bit_to_string, ')', NULL, NULL,
251 res_flags, allowed, res_mask);
255 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
257 static const struct nl_policy ovs_userspace_policy[] = {
258 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
259 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_UNSPEC,
261 [OVS_USERSPACE_ATTR_EGRESS_TUN_PORT] = { .type = NL_A_U32,
263 [OVS_USERSPACE_ATTR_ACTIONS] = { .type = NL_A_UNSPEC,
266 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
267 const struct nlattr *userdata_attr;
268 const struct nlattr *tunnel_out_port_attr;
270 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
271 ds_put_cstr(ds, "userspace(error)");
275 ds_put_format(ds, "userspace(pid=%"PRIu32,
276 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
278 userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
281 const uint8_t *userdata = nl_attr_get(userdata_attr);
282 size_t userdata_len = nl_attr_get_size(userdata_attr);
283 bool userdata_unspec = true;
284 union user_action_cookie cookie;
286 if (userdata_len >= sizeof cookie.type
287 && userdata_len <= sizeof cookie) {
289 memset(&cookie, 0, sizeof cookie);
290 memcpy(&cookie, userdata, userdata_len);
292 userdata_unspec = false;
294 if (userdata_len == sizeof cookie.sflow
295 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
296 ds_put_format(ds, ",sFlow("
297 "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
298 vlan_tci_to_vid(cookie.sflow.vlan_tci),
299 vlan_tci_to_pcp(cookie.sflow.vlan_tci),
300 cookie.sflow.output);
301 } else if (userdata_len == sizeof cookie.slow_path
302 && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
303 ds_put_cstr(ds, ",slow_path(");
304 format_flags(ds, slow_path_reason_to_string,
305 cookie.slow_path.reason, ',');
306 ds_put_format(ds, ")");
307 } else if (userdata_len == sizeof cookie.flow_sample
308 && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
309 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
310 ",collector_set_id=%"PRIu32
311 ",obs_domain_id=%"PRIu32
312 ",obs_point_id=%"PRIu32")",
313 cookie.flow_sample.probability,
314 cookie.flow_sample.collector_set_id,
315 cookie.flow_sample.obs_domain_id,
316 cookie.flow_sample.obs_point_id);
317 } else if (userdata_len >= sizeof cookie.ipfix
318 && cookie.type == USER_ACTION_COOKIE_IPFIX) {
319 ds_put_format(ds, ",ipfix(output_port=%"PRIu32")",
320 cookie.ipfix.output_odp_port);
322 userdata_unspec = true;
326 if (userdata_unspec) {
328 ds_put_format(ds, ",userdata(");
329 for (i = 0; i < userdata_len; i++) {
330 ds_put_format(ds, "%02x", userdata[i]);
332 ds_put_char(ds, ')');
336 if (a[OVS_USERSPACE_ATTR_ACTIONS]) {
337 ds_put_cstr(ds, ",actions");
340 tunnel_out_port_attr = a[OVS_USERSPACE_ATTR_EGRESS_TUN_PORT];
341 if (tunnel_out_port_attr) {
342 ds_put_format(ds, ",tunnel_out_port=%"PRIu32,
343 nl_attr_get_u32(tunnel_out_port_attr));
346 ds_put_char(ds, ')');
350 format_vlan_tci(struct ds *ds, ovs_be16 tci, ovs_be16 mask, bool verbose)
352 if (verbose || vlan_tci_to_vid(tci) || vlan_tci_to_vid(mask)) {
353 ds_put_format(ds, "vid=%"PRIu16, vlan_tci_to_vid(tci));
354 if (vlan_tci_to_vid(mask) != VLAN_VID_MASK) { /* Partially masked. */
355 ds_put_format(ds, "/0x%"PRIx16, vlan_tci_to_vid(mask));
357 ds_put_char(ds, ',');
359 if (verbose || vlan_tci_to_pcp(tci) || vlan_tci_to_pcp(mask)) {
360 ds_put_format(ds, "pcp=%d", vlan_tci_to_pcp(tci));
361 if (vlan_tci_to_pcp(mask) != (VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
362 ds_put_format(ds, "/0x%x", vlan_tci_to_pcp(mask));
364 ds_put_char(ds, ',');
366 if (!(tci & htons(VLAN_CFI))) {
367 ds_put_cstr(ds, "cfi=0");
368 ds_put_char(ds, ',');
374 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
376 ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
377 mpls_lse_to_label(mpls_lse),
378 mpls_lse_to_tc(mpls_lse),
379 mpls_lse_to_ttl(mpls_lse),
380 mpls_lse_to_bos(mpls_lse));
384 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
385 const struct ovs_key_mpls *mpls_mask, int n)
388 ovs_be32 key = mpls_key->mpls_lse;
390 if (mpls_mask == NULL) {
391 format_mpls_lse(ds, key);
393 ovs_be32 mask = mpls_mask->mpls_lse;
395 ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
396 mpls_lse_to_label(key), mpls_lse_to_label(mask),
397 mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
398 mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
399 mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
404 for (i = 0; i < n; i++) {
405 ds_put_format(ds, "lse%d=%#"PRIx32,
406 i, ntohl(mpls_key[i].mpls_lse));
408 ds_put_format(ds, "/%#"PRIx32, ntohl(mpls_mask[i].mpls_lse));
410 ds_put_char(ds, ',');
417 format_odp_recirc_action(struct ds *ds, uint32_t recirc_id)
419 ds_put_format(ds, "recirc(%#"PRIx32")", recirc_id);
423 format_odp_hash_action(struct ds *ds, const struct ovs_action_hash *hash_act)
425 ds_put_format(ds, "hash(");
427 if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
428 ds_put_format(ds, "hash_l4(%"PRIu32")", hash_act->hash_basis);
430 ds_put_format(ds, "Unknown hash algorithm(%"PRIu32")",
433 ds_put_format(ds, ")");
437 format_udp_tnl_push_header(struct ds *ds, const struct ip_header *ip)
439 const struct udp_header *udp;
441 udp = (const struct udp_header *) (ip + 1);
442 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16",csum=0x%"PRIx16"),",
443 ntohs(udp->udp_src), ntohs(udp->udp_dst),
444 ntohs(udp->udp_csum));
450 format_odp_tnl_push_header(struct ds *ds, struct ovs_action_push_tnl *data)
452 const struct eth_header *eth;
453 const struct ip_header *ip;
456 eth = (const struct eth_header *)data->header;
459 ip = (const struct ip_header *)l3;
462 ds_put_format(ds, "header(size=%"PRIu8",type=%"PRIu8",eth(dst=",
463 data->header_len, data->tnl_type);
464 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_dst));
465 ds_put_format(ds, ",src=");
466 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_src));
467 ds_put_format(ds, ",dl_type=0x%04"PRIx16"),", ntohs(eth->eth_type));
470 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
471 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=0x%"PRIx16"),",
472 IP_ARGS(get_16aligned_be32(&ip->ip_src)),
473 IP_ARGS(get_16aligned_be32(&ip->ip_dst)),
474 ip->ip_proto, ip->ip_tos,
478 if (data->tnl_type == OVS_VPORT_TYPE_VXLAN) {
479 const struct vxlanhdr *vxh;
481 vxh = format_udp_tnl_push_header(ds, ip);
483 ds_put_format(ds, "vxlan(flags=0x%"PRIx32",vni=0x%"PRIx32")",
484 ntohl(get_16aligned_be32(&vxh->vx_flags)),
485 ntohl(get_16aligned_be32(&vxh->vx_vni)) >> 8);
486 } else if (data->tnl_type == OVS_VPORT_TYPE_GENEVE) {
487 const struct genevehdr *gnh;
489 gnh = format_udp_tnl_push_header(ds, ip);
491 ds_put_format(ds, "geneve(%s%svni=0x%"PRIx32,
492 gnh->oam ? "oam," : "",
493 gnh->critical ? "crit," : "",
494 ntohl(get_16aligned_be32(&gnh->vni)) >> 8);
497 ds_put_cstr(ds, ",options(");
498 format_geneve_opts(gnh->options, NULL, gnh->opt_len * 4,
500 ds_put_char(ds, ')');
503 ds_put_char(ds, ')');
504 } else if (data->tnl_type == OVS_VPORT_TYPE_GRE) {
505 const struct gre_base_hdr *greh;
506 ovs_16aligned_be32 *options;
509 l4 = ((uint8_t *)l3 + sizeof(struct ip_header));
510 greh = (const struct gre_base_hdr *) l4;
512 ds_put_format(ds, "gre((flags=0x%"PRIx16",proto=0x%"PRIx16")",
513 ntohs(greh->flags), ntohs(greh->protocol));
514 options = (ovs_16aligned_be32 *)(greh + 1);
515 if (greh->flags & htons(GRE_CSUM)) {
516 ds_put_format(ds, ",csum=0x%"PRIx16, ntohs(*((ovs_be16 *)options)));
519 if (greh->flags & htons(GRE_KEY)) {
520 ds_put_format(ds, ",key=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
523 if (greh->flags & htons(GRE_SEQ)) {
524 ds_put_format(ds, ",seq=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
527 ds_put_format(ds, ")");
529 ds_put_format(ds, ")");
533 format_odp_tnl_push_action(struct ds *ds, const struct nlattr *attr)
535 struct ovs_action_push_tnl *data;
537 data = (struct ovs_action_push_tnl *) nl_attr_get(attr);
539 ds_put_format(ds, "tnl_push(tnl_port(%"PRIu32"),", data->tnl_port);
540 format_odp_tnl_push_header(ds, data);
541 ds_put_format(ds, ",out_port(%"PRIu32"))", data->out_port);
544 static const struct nl_policy ovs_conntrack_policy[] = {
545 [OVS_CT_ATTR_COMMIT] = { .type = NL_A_FLAG, .optional = true, },
546 [OVS_CT_ATTR_ZONE] = { .type = NL_A_U16, .optional = true, },
547 [OVS_CT_ATTR_MARK] = { .type = NL_A_UNSPEC, .optional = true,
548 .min_len = sizeof(uint32_t) * 2 },
549 [OVS_CT_ATTR_LABELS] = { .type = NL_A_UNSPEC, .optional = true,
550 .min_len = sizeof(struct ovs_key_ct_labels) * 2 },
554 format_odp_conntrack_action(struct ds *ds, const struct nlattr *attr)
556 struct nlattr *a[ARRAY_SIZE(ovs_conntrack_policy)];
557 const ovs_u128 *label;
558 const uint32_t *mark;
562 if (!nl_parse_nested(attr, ovs_conntrack_policy, a, ARRAY_SIZE(a))) {
563 ds_put_cstr(ds, "ct(error)");
567 commit = a[OVS_CT_ATTR_COMMIT] ? true : false;
568 zone = a[OVS_CT_ATTR_ZONE] ? nl_attr_get_u16(a[OVS_CT_ATTR_ZONE]) : 0;
569 mark = a[OVS_CT_ATTR_MARK] ? nl_attr_get(a[OVS_CT_ATTR_MARK]) : NULL;
570 label = a[OVS_CT_ATTR_LABELS] ? nl_attr_get(a[OVS_CT_ATTR_LABELS]): NULL;
572 ds_put_format(ds, "ct");
573 if (commit || zone || mark || label) {
574 ds_put_cstr(ds, "(");
576 ds_put_format(ds, "commit,");
579 ds_put_format(ds, "zone=%"PRIu16",", zone);
582 ds_put_format(ds, "mark=%#"PRIx32"/%#"PRIx32",", *mark,
586 ds_put_format(ds, "label=");
587 format_u128(ds, label, label + 1, true);
590 ds_put_cstr(ds, ")");
595 format_odp_action(struct ds *ds, const struct nlattr *a)
598 enum ovs_action_attr type = nl_attr_type(a);
599 const struct ovs_action_push_vlan *vlan;
602 expected_len = odp_action_len(nl_attr_type(a));
603 if (expected_len != ATTR_LEN_VARIABLE &&
604 nl_attr_get_size(a) != expected_len) {
605 ds_put_format(ds, "bad length %"PRIuSIZE", expected %d for: ",
606 nl_attr_get_size(a), expected_len);
607 format_generic_odp_action(ds, a);
612 case OVS_ACTION_ATTR_OUTPUT:
613 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
615 case OVS_ACTION_ATTR_TUNNEL_POP:
616 ds_put_format(ds, "tnl_pop(%"PRIu32")", nl_attr_get_u32(a));
618 case OVS_ACTION_ATTR_TUNNEL_PUSH:
619 format_odp_tnl_push_action(ds, a);
621 case OVS_ACTION_ATTR_USERSPACE:
622 format_odp_userspace_action(ds, a);
624 case OVS_ACTION_ATTR_RECIRC:
625 format_odp_recirc_action(ds, nl_attr_get_u32(a));
627 case OVS_ACTION_ATTR_HASH:
628 format_odp_hash_action(ds, nl_attr_get(a));
630 case OVS_ACTION_ATTR_SET_MASKED:
632 size = nl_attr_get_size(a) / 2;
633 ds_put_cstr(ds, "set(");
635 /* Masked set action not supported for tunnel key, which is bigger. */
636 if (size <= sizeof(struct ovs_key_ipv6)) {
637 struct nlattr attr[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
638 sizeof(struct nlattr))];
639 struct nlattr mask[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
640 sizeof(struct nlattr))];
642 mask->nla_type = attr->nla_type = nl_attr_type(a);
643 mask->nla_len = attr->nla_len = NLA_HDRLEN + size;
644 memcpy(attr + 1, (char *)(a + 1), size);
645 memcpy(mask + 1, (char *)(a + 1) + size, size);
646 format_odp_key_attr(attr, mask, NULL, ds, false);
648 format_odp_key_attr(a, NULL, NULL, ds, false);
650 ds_put_cstr(ds, ")");
652 case OVS_ACTION_ATTR_SET:
653 ds_put_cstr(ds, "set(");
654 format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
655 ds_put_cstr(ds, ")");
657 case OVS_ACTION_ATTR_PUSH_VLAN:
658 vlan = nl_attr_get(a);
659 ds_put_cstr(ds, "push_vlan(");
660 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
661 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
663 format_vlan_tci(ds, vlan->vlan_tci, OVS_BE16_MAX, false);
664 ds_put_char(ds, ')');
666 case OVS_ACTION_ATTR_POP_VLAN:
667 ds_put_cstr(ds, "pop_vlan");
669 case OVS_ACTION_ATTR_PUSH_MPLS: {
670 const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
671 ds_put_cstr(ds, "push_mpls(");
672 format_mpls_lse(ds, mpls->mpls_lse);
673 ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
676 case OVS_ACTION_ATTR_POP_MPLS: {
677 ovs_be16 ethertype = nl_attr_get_be16(a);
678 ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
681 case OVS_ACTION_ATTR_SAMPLE:
682 format_odp_sample_action(ds, a);
684 case OVS_ACTION_ATTR_CT:
685 format_odp_conntrack_action(ds, a);
687 case OVS_ACTION_ATTR_UNSPEC:
688 case __OVS_ACTION_ATTR_MAX:
690 format_generic_odp_action(ds, a);
696 format_odp_actions(struct ds *ds, const struct nlattr *actions,
700 const struct nlattr *a;
703 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
705 ds_put_char(ds, ',');
707 format_odp_action(ds, a);
712 if (left == actions_len) {
713 ds_put_cstr(ds, "<empty>");
715 ds_put_format(ds, ",***%u leftover bytes*** (", left);
716 for (i = 0; i < left; i++) {
717 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
719 ds_put_char(ds, ')');
722 ds_put_cstr(ds, "drop");
726 /* Separate out parse_odp_userspace_action() function. */
728 parse_odp_userspace_action(const char *s, struct ofpbuf *actions)
731 union user_action_cookie cookie;
733 odp_port_t tunnel_out_port;
735 void *user_data = NULL;
736 size_t user_data_size = 0;
737 bool include_actions = false;
739 if (!ovs_scan(s, "userspace(pid=%"SCNi32"%n", &pid, &n)) {
745 uint32_t probability;
746 uint32_t collector_set_id;
747 uint32_t obs_domain_id;
748 uint32_t obs_point_id;
751 if (ovs_scan(&s[n], ",sFlow(vid=%i,"
752 "pcp=%i,output=%"SCNi32")%n",
753 &vid, &pcp, &output, &n1)) {
757 tci = vid | (pcp << VLAN_PCP_SHIFT);
762 cookie.type = USER_ACTION_COOKIE_SFLOW;
763 cookie.sflow.vlan_tci = htons(tci);
764 cookie.sflow.output = output;
766 user_data_size = sizeof cookie.sflow;
767 } else if (ovs_scan(&s[n], ",slow_path(%n",
772 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
773 cookie.slow_path.unused = 0;
774 cookie.slow_path.reason = 0;
776 res = parse_odp_flags(&s[n], slow_path_reason_to_string,
777 &cookie.slow_path.reason,
778 SLOW_PATH_REASON_MASK, NULL);
779 if (res < 0 || s[n + res] != ')') {
785 user_data_size = sizeof cookie.slow_path;
786 } else if (ovs_scan(&s[n], ",flow_sample(probability=%"SCNi32","
787 "collector_set_id=%"SCNi32","
788 "obs_domain_id=%"SCNi32","
789 "obs_point_id=%"SCNi32")%n",
790 &probability, &collector_set_id,
791 &obs_domain_id, &obs_point_id, &n1)) {
794 cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
795 cookie.flow_sample.probability = probability;
796 cookie.flow_sample.collector_set_id = collector_set_id;
797 cookie.flow_sample.obs_domain_id = obs_domain_id;
798 cookie.flow_sample.obs_point_id = obs_point_id;
800 user_data_size = sizeof cookie.flow_sample;
801 } else if (ovs_scan(&s[n], ",ipfix(output_port=%"SCNi32")%n",
804 cookie.type = USER_ACTION_COOKIE_IPFIX;
805 cookie.ipfix.output_odp_port = u32_to_odp(output);
807 user_data_size = sizeof cookie.ipfix;
808 } else if (ovs_scan(&s[n], ",userdata(%n",
813 ofpbuf_init(&buf, 16);
814 end = ofpbuf_put_hex(&buf, &s[n], NULL);
818 user_data = buf.data;
819 user_data_size = buf.size;
826 if (ovs_scan(&s[n], ",actions%n", &n1)) {
828 include_actions = true;
834 if (ovs_scan(&s[n], ",tunnel_out_port=%"SCNi32")%n",
835 &tunnel_out_port, &n1)) {
836 odp_put_userspace_action(pid, user_data, user_data_size,
837 tunnel_out_port, include_actions, actions);
839 } else if (s[n] == ')') {
840 odp_put_userspace_action(pid, user_data, user_data_size,
841 ODPP_NONE, include_actions, actions);
850 ovs_parse_tnl_push(const char *s, struct ovs_action_push_tnl *data)
852 struct eth_header *eth;
853 struct ip_header *ip;
854 struct udp_header *udp;
855 struct gre_base_hdr *greh;
856 uint16_t gre_proto, gre_flags, dl_type, udp_src, udp_dst, csum;
858 uint32_t tnl_type = 0, header_len = 0;
862 if (!ovs_scan_len(s, &n, "tnl_push(tnl_port(%"SCNi32"),", &data->tnl_port)) {
865 eth = (struct eth_header *) data->header;
866 l3 = (data->header + sizeof *eth);
867 l4 = ((uint8_t *) l3 + sizeof (struct ip_header));
868 ip = (struct ip_header *) l3;
869 if (!ovs_scan_len(s, &n, "header(size=%"SCNi32",type=%"SCNi32","
870 "eth(dst="ETH_ADDR_SCAN_FMT",",
873 ETH_ADDR_SCAN_ARGS(eth->eth_dst))) {
877 if (!ovs_scan_len(s, &n, "src="ETH_ADDR_SCAN_FMT",",
878 ETH_ADDR_SCAN_ARGS(eth->eth_src))) {
881 if (!ovs_scan_len(s, &n, "dl_type=0x%"SCNx16"),", &dl_type)) {
884 eth->eth_type = htons(dl_type);
887 if (!ovs_scan_len(s, &n, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT",proto=%"SCNi8
888 ",tos=%"SCNi8",ttl=%"SCNi8",frag=0x%"SCNx16"),",
891 &ip->ip_proto, &ip->ip_tos,
892 &ip->ip_ttl, &ip->ip_frag_off)) {
895 put_16aligned_be32(&ip->ip_src, sip);
896 put_16aligned_be32(&ip->ip_dst, dip);
899 udp = (struct udp_header *) l4;
900 greh = (struct gre_base_hdr *) l4;
901 if (ovs_scan_len(s, &n, "udp(src=%"SCNi16",dst=%"SCNi16",csum=0x%"SCNx16"),",
902 &udp_src, &udp_dst, &csum)) {
903 uint32_t vx_flags, vni;
905 udp->udp_src = htons(udp_src);
906 udp->udp_dst = htons(udp_dst);
908 udp->udp_csum = htons(csum);
910 if (ovs_scan_len(s, &n, "vxlan(flags=0x%"SCNx32",vni=0x%"SCNx32"))",
912 struct vxlanhdr *vxh = (struct vxlanhdr *) (udp + 1);
914 put_16aligned_be32(&vxh->vx_flags, htonl(vx_flags));
915 put_16aligned_be32(&vxh->vx_vni, htonl(vni << 8));
916 tnl_type = OVS_VPORT_TYPE_VXLAN;
917 header_len = sizeof *eth + sizeof *ip +
918 sizeof *udp + sizeof *vxh;
919 } else if (ovs_scan_len(s, &n, "geneve(")) {
920 struct genevehdr *gnh = (struct genevehdr *) (udp + 1);
922 memset(gnh, 0, sizeof *gnh);
923 header_len = sizeof *eth + sizeof *ip +
924 sizeof *udp + sizeof *gnh;
926 if (ovs_scan_len(s, &n, "oam,")) {
929 if (ovs_scan_len(s, &n, "crit,")) {
932 if (!ovs_scan_len(s, &n, "vni=%"SCNi32, &vni)) {
935 if (ovs_scan_len(s, &n, ",options(")) {
936 struct geneve_scan options;
939 memset(&options, 0, sizeof options);
940 len = scan_geneve(s + n, &options, NULL);
945 memcpy(gnh->options, options.d, options.len);
946 gnh->opt_len = options.len / 4;
947 header_len += options.len;
951 if (!ovs_scan_len(s, &n, "))")) {
955 gnh->proto_type = htons(ETH_TYPE_TEB);
956 put_16aligned_be32(&gnh->vni, htonl(vni << 8));
957 tnl_type = OVS_VPORT_TYPE_GENEVE;
961 } else if (ovs_scan_len(s, &n, "gre((flags=0x%"SCNx16",proto=0x%"SCNx16")",
962 &gre_flags, &gre_proto)){
964 tnl_type = OVS_VPORT_TYPE_GRE;
965 greh->flags = htons(gre_flags);
966 greh->protocol = htons(gre_proto);
967 ovs_16aligned_be32 *options = (ovs_16aligned_be32 *) (greh + 1);
969 if (greh->flags & htons(GRE_CSUM)) {
970 if (!ovs_scan_len(s, &n, ",csum=0x%"SCNx16, &csum)) {
974 memset(options, 0, sizeof *options);
975 *((ovs_be16 *)options) = htons(csum);
978 if (greh->flags & htons(GRE_KEY)) {
981 if (!ovs_scan_len(s, &n, ",key=0x%"SCNx32, &key)) {
985 put_16aligned_be32(options, htonl(key));
988 if (greh->flags & htons(GRE_SEQ)) {
991 if (!ovs_scan_len(s, &n, ",seq=0x%"SCNx32, &seq)) {
994 put_16aligned_be32(options, htonl(seq));
998 if (!ovs_scan_len(s, &n, "))")) {
1002 header_len = sizeof *eth + sizeof *ip +
1003 ((uint8_t *) options - (uint8_t *) greh);
1008 /* check tunnel meta data. */
1009 if (data->tnl_type != tnl_type) {
1012 if (data->header_len != header_len) {
1017 if (!ovs_scan_len(s, &n, ",out_port(%"SCNi32"))", &data->out_port)) {
1025 parse_conntrack_action(const char *s_, struct ofpbuf *actions)
1029 if (ovs_scan(s, "ct")) {
1030 bool commit = false;
1035 } ct_mark = { 0, 0 };
1043 memset(&ct_label, 0, sizeof(ct_label));
1046 if (ovs_scan(s, "(")) {
1048 end = strchr(s, ')');
1056 s += strspn(s, delimiters);
1057 if (ovs_scan(s, "commit%n", &n)) {
1062 if (ovs_scan(s, "zone=%"SCNu16"%n", &zone, &n)) {
1066 if (ovs_scan(s, "mark=%"SCNx32"%n", &ct_mark.value, &n)) {
1069 if (ovs_scan(s, "/%"SCNx32"%n", &ct_mark.mask, &n)) {
1072 ct_mark.mask = UINT32_MAX;
1076 if (ovs_scan(s, "label=%n", &n)) {
1080 retval = scan_u128(s, &ct_label.value, &ct_label.mask);
1093 start = nl_msg_start_nested(actions, OVS_ACTION_ATTR_CT);
1095 nl_msg_put_flag(actions, OVS_CT_ATTR_COMMIT);
1098 nl_msg_put_u16(actions, OVS_CT_ATTR_ZONE, zone);
1101 nl_msg_put_unspec(actions, OVS_CT_ATTR_MARK, &ct_mark,
1104 if (!ovs_u128_is_zero(&ct_label.mask)) {
1105 nl_msg_put_unspec(actions, OVS_CT_ATTR_LABELS, &ct_label,
1108 nl_msg_end_nested(actions, start);
1115 parse_odp_action(const char *s, const struct simap *port_names,
1116 struct ofpbuf *actions)
1122 if (ovs_scan(s, "%"SCNi32"%n", &port, &n)) {
1123 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
1129 int len = strcspn(s, delimiters);
1130 struct simap_node *node;
1132 node = simap_find_len(port_names, s, len);
1134 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
1143 if (ovs_scan(s, "recirc(%"PRIu32")%n", &recirc_id, &n)) {
1144 nl_msg_put_u32(actions, OVS_ACTION_ATTR_RECIRC, recirc_id);
1149 if (!strncmp(s, "userspace(", 10)) {
1150 return parse_odp_userspace_action(s, actions);
1153 if (!strncmp(s, "set(", 4)) {
1156 struct nlattr mask[128 / sizeof(struct nlattr)];
1157 struct ofpbuf maskbuf;
1158 struct nlattr *nested, *key;
1161 /* 'mask' is big enough to hold any key. */
1162 ofpbuf_use_stack(&maskbuf, mask, sizeof mask);
1164 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
1165 retval = parse_odp_key_mask_attr(s + 4, port_names, actions, &maskbuf);
1169 if (s[retval + 4] != ')') {
1173 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1176 size = nl_attr_get_size(mask);
1177 if (size == nl_attr_get_size(key)) {
1178 /* Change to masked set action if not fully masked. */
1179 if (!is_all_ones(mask + 1, size)) {
1180 key->nla_len += size;
1181 ofpbuf_put(actions, mask + 1, size);
1182 /* 'actions' may have been reallocated by ofpbuf_put(). */
1183 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1184 nested->nla_type = OVS_ACTION_ATTR_SET_MASKED;
1188 nl_msg_end_nested(actions, start_ofs);
1193 struct ovs_action_push_vlan push;
1194 int tpid = ETH_TYPE_VLAN;
1199 if (ovs_scan(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)
1200 || ovs_scan(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
1201 &vid, &pcp, &cfi, &n)
1202 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
1203 &tpid, &vid, &pcp, &n)
1204 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
1205 &tpid, &vid, &pcp, &cfi, &n)) {
1206 push.vlan_tpid = htons(tpid);
1207 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
1208 | (pcp << VLAN_PCP_SHIFT)
1209 | (cfi ? VLAN_CFI : 0));
1210 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
1211 &push, sizeof push);
1217 if (!strncmp(s, "pop_vlan", 8)) {
1218 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
1226 if (ovs_scan(s, "sample(sample=%lf%%,actions(%n", &percentage, &n)
1227 && percentage >= 0. && percentage <= 100.0) {
1228 size_t sample_ofs, actions_ofs;
1231 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
1232 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
1233 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
1234 (probability <= 0 ? 0
1235 : probability >= UINT32_MAX ? UINT32_MAX
1238 actions_ofs = nl_msg_start_nested(actions,
1239 OVS_SAMPLE_ATTR_ACTIONS);
1243 n += strspn(s + n, delimiters);
1248 retval = parse_odp_action(s + n, port_names, actions);
1254 nl_msg_end_nested(actions, actions_ofs);
1255 nl_msg_end_nested(actions, sample_ofs);
1257 return s[n + 1] == ')' ? n + 2 : -EINVAL;
1265 if (ovs_scan(s, "tnl_pop(%"SCNi32")%n", &port, &n)) {
1266 nl_msg_put_u32(actions, OVS_ACTION_ATTR_TUNNEL_POP, port);
1274 retval = parse_conntrack_action(s, actions);
1281 struct ovs_action_push_tnl data;
1284 n = ovs_parse_tnl_push(s, &data);
1286 odp_put_tnl_push_action(actions, &data);
1295 /* Parses the string representation of datapath actions, in the format output
1296 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
1297 * value. On success, the ODP actions are appended to 'actions' as a series of
1298 * Netlink attributes. On failure, no data is appended to 'actions'. Either
1299 * way, 'actions''s data might be reallocated. */
1301 odp_actions_from_string(const char *s, const struct simap *port_names,
1302 struct ofpbuf *actions)
1306 if (!strcasecmp(s, "drop")) {
1310 old_size = actions->size;
1314 s += strspn(s, delimiters);
1319 retval = parse_odp_action(s, port_names, actions);
1320 if (retval < 0 || !strchr(delimiters, s[retval])) {
1321 actions->size = old_size;
1330 static const struct attr_len_tbl ovs_vxlan_ext_attr_lens[OVS_VXLAN_EXT_MAX + 1] = {
1331 [OVS_VXLAN_EXT_GBP] = { .len = 4 },
1334 static const struct attr_len_tbl ovs_tun_key_attr_lens[OVS_TUNNEL_KEY_ATTR_MAX + 1] = {
1335 [OVS_TUNNEL_KEY_ATTR_ID] = { .len = 8 },
1336 [OVS_TUNNEL_KEY_ATTR_IPV4_SRC] = { .len = 4 },
1337 [OVS_TUNNEL_KEY_ATTR_IPV4_DST] = { .len = 4 },
1338 [OVS_TUNNEL_KEY_ATTR_TOS] = { .len = 1 },
1339 [OVS_TUNNEL_KEY_ATTR_TTL] = { .len = 1 },
1340 [OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT] = { .len = 0 },
1341 [OVS_TUNNEL_KEY_ATTR_CSUM] = { .len = 0 },
1342 [OVS_TUNNEL_KEY_ATTR_TP_SRC] = { .len = 2 },
1343 [OVS_TUNNEL_KEY_ATTR_TP_DST] = { .len = 2 },
1344 [OVS_TUNNEL_KEY_ATTR_OAM] = { .len = 0 },
1345 [OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS] = { .len = ATTR_LEN_VARIABLE },
1346 [OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS] = { .len = ATTR_LEN_NESTED,
1347 .next = ovs_vxlan_ext_attr_lens ,
1348 .next_max = OVS_VXLAN_EXT_MAX},
1351 static const struct attr_len_tbl ovs_flow_key_attr_lens[OVS_KEY_ATTR_MAX + 1] = {
1352 [OVS_KEY_ATTR_ENCAP] = { .len = ATTR_LEN_NESTED },
1353 [OVS_KEY_ATTR_PRIORITY] = { .len = 4 },
1354 [OVS_KEY_ATTR_SKB_MARK] = { .len = 4 },
1355 [OVS_KEY_ATTR_DP_HASH] = { .len = 4 },
1356 [OVS_KEY_ATTR_RECIRC_ID] = { .len = 4 },
1357 [OVS_KEY_ATTR_TUNNEL] = { .len = ATTR_LEN_NESTED,
1358 .next = ovs_tun_key_attr_lens,
1359 .next_max = OVS_TUNNEL_KEY_ATTR_MAX },
1360 [OVS_KEY_ATTR_IN_PORT] = { .len = 4 },
1361 [OVS_KEY_ATTR_ETHERNET] = { .len = sizeof(struct ovs_key_ethernet) },
1362 [OVS_KEY_ATTR_VLAN] = { .len = 2 },
1363 [OVS_KEY_ATTR_ETHERTYPE] = { .len = 2 },
1364 [OVS_KEY_ATTR_MPLS] = { .len = ATTR_LEN_VARIABLE },
1365 [OVS_KEY_ATTR_IPV4] = { .len = sizeof(struct ovs_key_ipv4) },
1366 [OVS_KEY_ATTR_IPV6] = { .len = sizeof(struct ovs_key_ipv6) },
1367 [OVS_KEY_ATTR_TCP] = { .len = sizeof(struct ovs_key_tcp) },
1368 [OVS_KEY_ATTR_TCP_FLAGS] = { .len = 2 },
1369 [OVS_KEY_ATTR_UDP] = { .len = sizeof(struct ovs_key_udp) },
1370 [OVS_KEY_ATTR_SCTP] = { .len = sizeof(struct ovs_key_sctp) },
1371 [OVS_KEY_ATTR_ICMP] = { .len = sizeof(struct ovs_key_icmp) },
1372 [OVS_KEY_ATTR_ICMPV6] = { .len = sizeof(struct ovs_key_icmpv6) },
1373 [OVS_KEY_ATTR_ARP] = { .len = sizeof(struct ovs_key_arp) },
1374 [OVS_KEY_ATTR_ND] = { .len = sizeof(struct ovs_key_nd) },
1375 [OVS_KEY_ATTR_CT_STATE] = { .len = 4 },
1376 [OVS_KEY_ATTR_CT_ZONE] = { .len = 2 },
1377 [OVS_KEY_ATTR_CT_MARK] = { .len = 4 },
1378 [OVS_KEY_ATTR_CT_LABELS] = { .len = sizeof(struct ovs_key_ct_labels) },
1381 /* Returns the correct length of the payload for a flow key attribute of the
1382 * specified 'type', ATTR_LEN_INVALID if 'type' is unknown, ATTR_LEN_VARIABLE
1383 * if the attribute's payload is variable length, or ATTR_LEN_NESTED if the
1384 * payload is a nested type. */
1386 odp_key_attr_len(const struct attr_len_tbl tbl[], int max_len, uint16_t type)
1388 if (type > max_len) {
1389 return ATTR_LEN_INVALID;
1392 return tbl[type].len;
1396 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
1398 size_t len = nl_attr_get_size(a);
1400 const uint8_t *unspec;
1403 unspec = nl_attr_get(a);
1404 for (i = 0; i < len; i++) {
1406 ds_put_char(ds, ' ');
1408 ds_put_format(ds, "%02x", unspec[i]);
1414 ovs_frag_type_to_string(enum ovs_frag_type type)
1417 case OVS_FRAG_TYPE_NONE:
1419 case OVS_FRAG_TYPE_FIRST:
1421 case OVS_FRAG_TYPE_LATER:
1423 case __OVS_FRAG_TYPE_MAX:
1429 static enum odp_key_fitness
1430 odp_tun_key_from_attr__(const struct nlattr *attr,
1431 const struct nlattr *flow_attrs, size_t flow_attr_len,
1432 const struct flow_tnl *src_tun, struct flow_tnl *tun,
1436 const struct nlattr *a;
1438 bool unknown = false;
1440 NL_NESTED_FOR_EACH(a, left, attr) {
1441 uint16_t type = nl_attr_type(a);
1442 size_t len = nl_attr_get_size(a);
1443 int expected_len = odp_key_attr_len(ovs_tun_key_attr_lens,
1444 OVS_TUNNEL_ATTR_MAX, type);
1446 if (len != expected_len && expected_len >= 0) {
1447 return ODP_FIT_ERROR;
1451 case OVS_TUNNEL_KEY_ATTR_ID:
1452 tun->tun_id = nl_attr_get_be64(a);
1453 tun->flags |= FLOW_TNL_F_KEY;
1455 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1456 tun->ip_src = nl_attr_get_be32(a);
1458 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
1459 tun->ip_dst = nl_attr_get_be32(a);
1461 case OVS_TUNNEL_KEY_ATTR_TOS:
1462 tun->ip_tos = nl_attr_get_u8(a);
1464 case OVS_TUNNEL_KEY_ATTR_TTL:
1465 tun->ip_ttl = nl_attr_get_u8(a);
1468 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
1469 tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
1471 case OVS_TUNNEL_KEY_ATTR_CSUM:
1472 tun->flags |= FLOW_TNL_F_CSUM;
1474 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
1475 tun->tp_src = nl_attr_get_be16(a);
1477 case OVS_TUNNEL_KEY_ATTR_TP_DST:
1478 tun->tp_dst = nl_attr_get_be16(a);
1480 case OVS_TUNNEL_KEY_ATTR_OAM:
1481 tun->flags |= FLOW_TNL_F_OAM;
1483 case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS: {
1484 static const struct nl_policy vxlan_opts_policy[] = {
1485 [OVS_VXLAN_EXT_GBP] = { .type = NL_A_U32 },
1487 struct nlattr *ext[ARRAY_SIZE(vxlan_opts_policy)];
1489 if (!nl_parse_nested(a, vxlan_opts_policy, ext, ARRAY_SIZE(ext))) {
1490 return ODP_FIT_ERROR;
1493 if (ext[OVS_VXLAN_EXT_GBP]) {
1494 uint32_t gbp = nl_attr_get_u32(ext[OVS_VXLAN_EXT_GBP]);
1496 tun->gbp_id = htons(gbp & 0xFFFF);
1497 tun->gbp_flags = (gbp >> 16) & 0xFF;
1502 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
1503 if (tun_metadata_from_geneve_nlattr(a, flow_attrs, flow_attr_len,
1504 src_tun, udpif, tun)) {
1505 return ODP_FIT_ERROR;
1510 /* Allow this to show up as unexpected, if there are unknown
1511 * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
1518 return ODP_FIT_ERROR;
1521 return ODP_FIT_TOO_MUCH;
1523 return ODP_FIT_PERFECT;
1526 enum odp_key_fitness
1527 odp_tun_key_from_attr(const struct nlattr *attr, bool udpif,
1528 struct flow_tnl *tun)
1530 memset(tun, 0, sizeof *tun);
1531 return odp_tun_key_from_attr__(attr, NULL, 0, NULL, tun, udpif);
1535 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key,
1536 const struct flow_tnl *tun_flow_key,
1537 const struct ofpbuf *key_buf)
1541 tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
1543 /* tun_id != 0 without FLOW_TNL_F_KEY is valid if tun_key is a mask. */
1544 if (tun_key->tun_id || tun_key->flags & FLOW_TNL_F_KEY) {
1545 nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
1547 if (tun_key->ip_src) {
1548 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
1550 if (tun_key->ip_dst) {
1551 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
1553 if (tun_key->ip_tos) {
1554 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
1556 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
1557 if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
1558 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
1560 if (tun_key->flags & FLOW_TNL_F_CSUM) {
1561 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
1563 if (tun_key->tp_src) {
1564 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src);
1566 if (tun_key->tp_dst) {
1567 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst);
1569 if (tun_key->flags & FLOW_TNL_F_OAM) {
1570 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
1572 if (tun_key->gbp_flags || tun_key->gbp_id) {
1573 size_t vxlan_opts_ofs;
1575 vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
1576 nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP,
1577 (tun_key->gbp_flags << 16) | ntohs(tun_key->gbp_id));
1578 nl_msg_end_nested(a, vxlan_opts_ofs);
1580 tun_metadata_to_geneve_nlattr(tun_key, tun_flow_key, key_buf, a);
1582 nl_msg_end_nested(a, tun_key_ofs);
1586 odp_mask_attr_is_wildcard(const struct nlattr *ma)
1588 return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
1592 odp_mask_is_exact(enum ovs_key_attr attr, const void *mask, size_t size)
1594 if (attr == OVS_KEY_ATTR_TCP_FLAGS) {
1595 return TCP_FLAGS(*(ovs_be16 *)mask) == TCP_FLAGS(OVS_BE16_MAX);
1597 if (attr == OVS_KEY_ATTR_IPV6) {
1598 const struct ovs_key_ipv6 *ipv6_mask = mask;
1601 ((ipv6_mask->ipv6_label & htonl(IPV6_LABEL_MASK))
1602 == htonl(IPV6_LABEL_MASK))
1603 && ipv6_mask->ipv6_proto == UINT8_MAX
1604 && ipv6_mask->ipv6_tclass == UINT8_MAX
1605 && ipv6_mask->ipv6_hlimit == UINT8_MAX
1606 && ipv6_mask->ipv6_frag == UINT8_MAX
1607 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_src)
1608 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_dst);
1610 if (attr == OVS_KEY_ATTR_TUNNEL) {
1614 if (attr == OVS_KEY_ATTR_ARP) {
1615 /* ARP key has padding, ignore it. */
1616 BUILD_ASSERT_DECL(sizeof(struct ovs_key_arp) == 24);
1617 BUILD_ASSERT_DECL(offsetof(struct ovs_key_arp, arp_tha) == 10 + 6);
1618 size = offsetof(struct ovs_key_arp, arp_tha) + ETH_ADDR_LEN;
1619 ovs_assert(((uint16_t *)mask)[size/2] == 0);
1622 return is_all_ones(mask, size);
1626 odp_mask_attr_is_exact(const struct nlattr *ma)
1628 enum ovs_key_attr attr = nl_attr_type(ma);
1632 if (attr == OVS_KEY_ATTR_TUNNEL) {
1635 mask = nl_attr_get(ma);
1636 size = nl_attr_get_size(ma);
1639 return odp_mask_is_exact(attr, mask, size);
1643 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
1646 struct odp_portno_names *odp_portno_names;
1648 odp_portno_names = xmalloc(sizeof *odp_portno_names);
1649 odp_portno_names->port_no = port_no;
1650 odp_portno_names->name = xstrdup(port_name);
1651 hmap_insert(portno_names, &odp_portno_names->hmap_node,
1652 hash_odp_port(port_no));
1656 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
1658 struct odp_portno_names *odp_portno_names;
1660 HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
1661 hash_odp_port(port_no), portno_names) {
1662 if (odp_portno_names->port_no == port_no) {
1663 return odp_portno_names->name;
1670 odp_portno_names_destroy(struct hmap *portno_names)
1672 struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
1673 HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
1674 hmap_node, portno_names) {
1675 hmap_remove(portno_names, &odp_portno_names->hmap_node);
1676 free(odp_portno_names->name);
1677 free(odp_portno_names);
1681 /* Format helpers. */
1684 format_eth(struct ds *ds, const char *name, const struct eth_addr key,
1685 const struct eth_addr *mask, bool verbose)
1687 bool mask_empty = mask && eth_addr_is_zero(*mask);
1689 if (verbose || !mask_empty) {
1690 bool mask_full = !mask || eth_mask_is_exact(*mask);
1693 ds_put_format(ds, "%s="ETH_ADDR_FMT",", name, ETH_ADDR_ARGS(key));
1695 ds_put_format(ds, "%s=", name);
1696 eth_format_masked(key, mask, ds);
1697 ds_put_char(ds, ',');
1703 format_be64(struct ds *ds, const char *name, ovs_be64 key,
1704 const ovs_be64 *mask, bool verbose)
1706 bool mask_empty = mask && !*mask;
1708 if (verbose || !mask_empty) {
1709 bool mask_full = !mask || *mask == OVS_BE64_MAX;
1711 ds_put_format(ds, "%s=0x%"PRIx64, name, ntohll(key));
1712 if (!mask_full) { /* Partially masked. */
1713 ds_put_format(ds, "/%#"PRIx64, ntohll(*mask));
1715 ds_put_char(ds, ',');
1720 format_ipv4(struct ds *ds, const char *name, ovs_be32 key,
1721 const ovs_be32 *mask, bool verbose)
1723 bool mask_empty = mask && !*mask;
1725 if (verbose || !mask_empty) {
1726 bool mask_full = !mask || *mask == OVS_BE32_MAX;
1728 ds_put_format(ds, "%s="IP_FMT, name, IP_ARGS(key));
1729 if (!mask_full) { /* Partially masked. */
1730 ds_put_format(ds, "/"IP_FMT, IP_ARGS(*mask));
1732 ds_put_char(ds, ',');
1737 format_ipv6(struct ds *ds, const char *name, const ovs_be32 key_[4],
1738 const ovs_be32 (*mask_)[4], bool verbose)
1740 char buf[INET6_ADDRSTRLEN];
1741 const struct in6_addr *key = (const struct in6_addr *)key_;
1742 const struct in6_addr *mask = mask_ ? (const struct in6_addr *)*mask_
1744 bool mask_empty = mask && ipv6_mask_is_any(mask);
1746 if (verbose || !mask_empty) {
1747 bool mask_full = !mask || ipv6_mask_is_exact(mask);
1749 inet_ntop(AF_INET6, key, buf, sizeof buf);
1750 ds_put_format(ds, "%s=%s", name, buf);
1751 if (!mask_full) { /* Partially masked. */
1752 inet_ntop(AF_INET6, mask, buf, sizeof buf);
1753 ds_put_format(ds, "/%s", buf);
1755 ds_put_char(ds, ',');
1760 format_ipv6_label(struct ds *ds, const char *name, ovs_be32 key,
1761 const ovs_be32 *mask, bool verbose)
1763 bool mask_empty = mask && !*mask;
1765 if (verbose || !mask_empty) {
1766 bool mask_full = !mask
1767 || (*mask & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK);
1769 ds_put_format(ds, "%s=%#"PRIx32, name, ntohl(key));
1770 if (!mask_full) { /* Partially masked. */
1771 ds_put_format(ds, "/%#"PRIx32, ntohl(*mask));
1773 ds_put_char(ds, ',');
1778 format_u8x(struct ds *ds, const char *name, uint8_t key,
1779 const uint8_t *mask, bool verbose)
1781 bool mask_empty = mask && !*mask;
1783 if (verbose || !mask_empty) {
1784 bool mask_full = !mask || *mask == UINT8_MAX;
1786 ds_put_format(ds, "%s=%#"PRIx8, name, key);
1787 if (!mask_full) { /* Partially masked. */
1788 ds_put_format(ds, "/%#"PRIx8, *mask);
1790 ds_put_char(ds, ',');
1795 format_u8u(struct ds *ds, const char *name, uint8_t key,
1796 const uint8_t *mask, bool verbose)
1798 bool mask_empty = mask && !*mask;
1800 if (verbose || !mask_empty) {
1801 bool mask_full = !mask || *mask == UINT8_MAX;
1803 ds_put_format(ds, "%s=%"PRIu8, name, key);
1804 if (!mask_full) { /* Partially masked. */
1805 ds_put_format(ds, "/%#"PRIx8, *mask);
1807 ds_put_char(ds, ',');
1812 format_be16(struct ds *ds, const char *name, ovs_be16 key,
1813 const ovs_be16 *mask, bool verbose)
1815 bool mask_empty = mask && !*mask;
1817 if (verbose || !mask_empty) {
1818 bool mask_full = !mask || *mask == OVS_BE16_MAX;
1820 ds_put_format(ds, "%s=%"PRIu16, name, ntohs(key));
1821 if (!mask_full) { /* Partially masked. */
1822 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1824 ds_put_char(ds, ',');
1829 format_be16x(struct ds *ds, const char *name, ovs_be16 key,
1830 const ovs_be16 *mask, bool verbose)
1832 bool mask_empty = mask && !*mask;
1834 if (verbose || !mask_empty) {
1835 bool mask_full = !mask || *mask == OVS_BE16_MAX;
1837 ds_put_format(ds, "%s=%#"PRIx16, name, ntohs(key));
1838 if (!mask_full) { /* Partially masked. */
1839 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1841 ds_put_char(ds, ',');
1846 format_tun_flags(struct ds *ds, const char *name, uint16_t key,
1847 const uint16_t *mask, bool verbose)
1849 bool mask_empty = mask && !*mask;
1851 if (verbose || !mask_empty) {
1852 ds_put_cstr(ds, name);
1853 ds_put_char(ds, '(');
1855 format_flags_masked(ds, NULL, flow_tun_flag_to_string, key,
1856 *mask & FLOW_TNL_F_MASK, FLOW_TNL_F_MASK);
1857 } else { /* Fully masked. */
1858 format_flags(ds, flow_tun_flag_to_string, key, '|');
1860 ds_put_cstr(ds, "),");
1865 check_attr_len(struct ds *ds, const struct nlattr *a, const struct nlattr *ma,
1866 const struct attr_len_tbl tbl[], int max_len, bool need_key)
1870 expected_len = odp_key_attr_len(tbl, max_len, nl_attr_type(a));
1871 if (expected_len != ATTR_LEN_VARIABLE &&
1872 expected_len != ATTR_LEN_NESTED) {
1874 bool bad_key_len = nl_attr_get_size(a) != expected_len;
1875 bool bad_mask_len = ma && nl_attr_get_size(ma) != expected_len;
1877 if (bad_key_len || bad_mask_len) {
1879 ds_put_format(ds, "key%u", nl_attr_type(a));
1882 ds_put_format(ds, "(bad key length %"PRIuSIZE", expected %d)(",
1883 nl_attr_get_size(a), expected_len);
1885 format_generic_odp_key(a, ds);
1887 ds_put_char(ds, '/');
1889 ds_put_format(ds, "(bad mask length %"PRIuSIZE", expected %d)(",
1890 nl_attr_get_size(ma), expected_len);
1892 format_generic_odp_key(ma, ds);
1894 ds_put_char(ds, ')');
1903 format_unknown_key(struct ds *ds, const struct nlattr *a,
1904 const struct nlattr *ma)
1906 ds_put_format(ds, "key%u(", nl_attr_type(a));
1907 format_generic_odp_key(a, ds);
1908 if (ma && !odp_mask_attr_is_exact(ma)) {
1909 ds_put_char(ds, '/');
1910 format_generic_odp_key(ma, ds);
1912 ds_put_cstr(ds, "),");
1916 format_odp_tun_vxlan_opt(const struct nlattr *attr,
1917 const struct nlattr *mask_attr, struct ds *ds,
1921 const struct nlattr *a;
1924 ofpbuf_init(&ofp, 100);
1925 NL_NESTED_FOR_EACH(a, left, attr) {
1926 uint16_t type = nl_attr_type(a);
1927 const struct nlattr *ma = NULL;
1930 ma = nl_attr_find__(nl_attr_get(mask_attr),
1931 nl_attr_get_size(mask_attr), type);
1933 ma = generate_all_wildcard_mask(ovs_vxlan_ext_attr_lens,
1939 if (!check_attr_len(ds, a, ma, ovs_vxlan_ext_attr_lens,
1940 OVS_VXLAN_EXT_MAX, true)) {
1945 case OVS_VXLAN_EXT_GBP: {
1946 uint32_t key = nl_attr_get_u32(a);
1947 ovs_be16 id, id_mask;
1948 uint8_t flags, flags_mask;
1950 id = htons(key & 0xFFFF);
1951 flags = (key >> 16) & 0xFF;
1953 uint32_t mask = nl_attr_get_u32(ma);
1954 id_mask = htons(mask & 0xFFFF);
1955 flags_mask = (mask >> 16) & 0xFF;
1958 ds_put_cstr(ds, "gbp(");
1959 format_be16(ds, "id", id, ma ? &id_mask : NULL, verbose);
1960 format_u8x(ds, "flags", flags, ma ? &flags_mask : NULL, verbose);
1962 ds_put_cstr(ds, "),");
1967 format_unknown_key(ds, a, ma);
1973 ofpbuf_uninit(&ofp);
1976 #define MASK(PTR, FIELD) PTR ? &PTR->FIELD : NULL
1979 format_geneve_opts(const struct geneve_opt *opt,
1980 const struct geneve_opt *mask, int opts_len,
1981 struct ds *ds, bool verbose)
1983 while (opts_len > 0) {
1985 uint8_t data_len, data_len_mask;
1987 if (opts_len < sizeof *opt) {
1988 ds_put_format(ds, "opt len %u less than minimum %"PRIuSIZE,
1989 opts_len, sizeof *opt);
1993 data_len = opt->length * 4;
1995 if (mask->length == 0x1f) {
1996 data_len_mask = UINT8_MAX;
1998 data_len_mask = mask->length;
2001 len = sizeof *opt + data_len;
2002 if (len > opts_len) {
2003 ds_put_format(ds, "opt len %u greater than remaining %u",
2008 ds_put_char(ds, '{');
2009 format_be16x(ds, "class", opt->opt_class, MASK(mask, opt_class),
2011 format_u8x(ds, "type", opt->type, MASK(mask, type), verbose);
2012 format_u8u(ds, "len", data_len, mask ? &data_len_mask : NULL, verbose);
2014 (verbose || !mask || !is_all_zeros(mask + 1, data_len))) {
2015 ds_put_hex(ds, opt + 1, data_len);
2016 if (mask && !is_all_ones(mask + 1, data_len)) {
2017 ds_put_char(ds, '/');
2018 ds_put_hex(ds, mask + 1, data_len);
2023 ds_put_char(ds, '}');
2025 opt += len / sizeof(*opt);
2027 mask += len / sizeof(*opt);
2034 format_odp_tun_geneve(const struct nlattr *attr,
2035 const struct nlattr *mask_attr, struct ds *ds,
2038 int opts_len = nl_attr_get_size(attr);
2039 const struct geneve_opt *opt = nl_attr_get(attr);
2040 const struct geneve_opt *mask = mask_attr ?
2041 nl_attr_get(mask_attr) : NULL;
2043 if (mask && nl_attr_get_size(attr) != nl_attr_get_size(mask_attr)) {
2044 ds_put_format(ds, "value len %"PRIuSIZE" different from mask len %"PRIuSIZE,
2045 nl_attr_get_size(attr), nl_attr_get_size(mask_attr));
2049 format_geneve_opts(opt, mask, opts_len, ds, verbose);
2053 format_odp_tun_attr(const struct nlattr *attr, const struct nlattr *mask_attr,
2054 struct ds *ds, bool verbose)
2057 const struct nlattr *a;
2059 uint16_t mask_flags = 0;
2062 ofpbuf_init(&ofp, 100);
2063 NL_NESTED_FOR_EACH(a, left, attr) {
2064 enum ovs_tunnel_key_attr type = nl_attr_type(a);
2065 const struct nlattr *ma = NULL;
2068 ma = nl_attr_find__(nl_attr_get(mask_attr),
2069 nl_attr_get_size(mask_attr), type);
2071 ma = generate_all_wildcard_mask(ovs_tun_key_attr_lens,
2072 OVS_TUNNEL_KEY_ATTR_MAX,
2077 if (!check_attr_len(ds, a, ma, ovs_tun_key_attr_lens,
2078 OVS_TUNNEL_KEY_ATTR_MAX, true)) {
2083 case OVS_TUNNEL_KEY_ATTR_ID:
2084 format_be64(ds, "tun_id", nl_attr_get_be64(a),
2085 ma ? nl_attr_get(ma) : NULL, verbose);
2086 flags |= FLOW_TNL_F_KEY;
2088 mask_flags |= FLOW_TNL_F_KEY;
2091 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
2092 format_ipv4(ds, "src", nl_attr_get_be32(a),
2093 ma ? nl_attr_get(ma) : NULL, verbose);
2095 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
2096 format_ipv4(ds, "dst", nl_attr_get_be32(a),
2097 ma ? nl_attr_get(ma) : NULL, verbose);
2099 case OVS_TUNNEL_KEY_ATTR_TOS:
2100 format_u8x(ds, "tos", nl_attr_get_u8(a),
2101 ma ? nl_attr_get(ma) : NULL, verbose);
2103 case OVS_TUNNEL_KEY_ATTR_TTL:
2104 format_u8u(ds, "ttl", nl_attr_get_u8(a),
2105 ma ? nl_attr_get(ma) : NULL, verbose);
2107 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2108 flags |= FLOW_TNL_F_DONT_FRAGMENT;
2110 case OVS_TUNNEL_KEY_ATTR_CSUM:
2111 flags |= FLOW_TNL_F_CSUM;
2113 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
2114 format_be16(ds, "tp_src", nl_attr_get_be16(a),
2115 ma ? nl_attr_get(ma) : NULL, verbose);
2117 case OVS_TUNNEL_KEY_ATTR_TP_DST:
2118 format_be16(ds, "tp_dst", nl_attr_get_be16(a),
2119 ma ? nl_attr_get(ma) : NULL, verbose);
2121 case OVS_TUNNEL_KEY_ATTR_OAM:
2122 flags |= FLOW_TNL_F_OAM;
2124 case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS:
2125 ds_put_cstr(ds, "vxlan(");
2126 format_odp_tun_vxlan_opt(a, ma, ds, verbose);
2127 ds_put_cstr(ds, "),");
2129 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
2130 ds_put_cstr(ds, "geneve(");
2131 format_odp_tun_geneve(a, ma, ds, verbose);
2132 ds_put_cstr(ds, "),");
2134 case __OVS_TUNNEL_KEY_ATTR_MAX:
2136 format_unknown_key(ds, a, ma);
2141 /* Flags can have a valid mask even if the attribute is not set, so
2142 * we need to collect these separately. */
2144 NL_NESTED_FOR_EACH(a, left, mask_attr) {
2145 switch (nl_attr_type(a)) {
2146 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2147 mask_flags |= FLOW_TNL_F_DONT_FRAGMENT;
2149 case OVS_TUNNEL_KEY_ATTR_CSUM:
2150 mask_flags |= FLOW_TNL_F_CSUM;
2152 case OVS_TUNNEL_KEY_ATTR_OAM:
2153 mask_flags |= FLOW_TNL_F_OAM;
2159 format_tun_flags(ds, "flags", flags, mask_attr ? &mask_flags : NULL,
2162 ofpbuf_uninit(&ofp);
2166 odp_ct_state_to_string(uint32_t flag)
2169 case OVS_CS_F_REPLY_DIR:
2171 case OVS_CS_F_TRACKED:
2175 case OVS_CS_F_ESTABLISHED:
2177 case OVS_CS_F_RELATED:
2179 case OVS_CS_F_INVALID:
2187 format_frag(struct ds *ds, const char *name, uint8_t key,
2188 const uint8_t *mask, bool verbose)
2190 bool mask_empty = mask && !*mask;
2192 /* ODP frag is an enumeration field; partial masks are not meaningful. */
2193 if (verbose || !mask_empty) {
2194 bool mask_full = !mask || *mask == UINT8_MAX;
2196 if (!mask_full) { /* Partially masked. */
2197 ds_put_format(ds, "error: partial mask not supported for frag (%#"
2200 ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
2206 mask_empty(const struct nlattr *ma)
2214 mask = nl_attr_get(ma);
2215 n = nl_attr_get_size(ma);
2217 return is_all_zeros(mask, n);
2221 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
2222 const struct hmap *portno_names, struct ds *ds,
2225 enum ovs_key_attr attr = nl_attr_type(a);
2226 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2229 is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
2231 ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
2233 if (!check_attr_len(ds, a, ma, ovs_flow_key_attr_lens,
2234 OVS_KEY_ATTR_MAX, false)) {
2238 ds_put_char(ds, '(');
2240 case OVS_KEY_ATTR_ENCAP:
2241 if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
2242 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
2243 nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
2245 } else if (nl_attr_get_size(a)) {
2246 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
2251 case OVS_KEY_ATTR_PRIORITY:
2252 case OVS_KEY_ATTR_SKB_MARK:
2253 case OVS_KEY_ATTR_DP_HASH:
2254 case OVS_KEY_ATTR_RECIRC_ID:
2255 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2257 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2261 case OVS_KEY_ATTR_CT_MARK:
2262 if (verbose || !mask_empty(ma)) {
2263 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2265 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2270 case OVS_KEY_ATTR_CT_STATE:
2272 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2274 ds_put_format(ds, "/%#"PRIx32,
2275 mask_empty(ma) ? 0 : nl_attr_get_u32(ma));
2277 } else if (!is_exact) {
2278 format_flags_masked(ds, NULL, odp_ct_state_to_string,
2280 mask_empty(ma) ? 0 : nl_attr_get_u32(ma),
2283 format_flags(ds, odp_ct_state_to_string, nl_attr_get_u32(a), '|');
2287 case OVS_KEY_ATTR_CT_ZONE:
2288 if (verbose || !mask_empty(ma)) {
2289 ds_put_format(ds, "%#"PRIx16, nl_attr_get_u16(a));
2291 ds_put_format(ds, "/%#"PRIx16, nl_attr_get_u16(ma));
2296 case OVS_KEY_ATTR_CT_LABELS: {
2297 const ovs_u128 *value = nl_attr_get(a);
2298 const ovs_u128 *mask = ma ? nl_attr_get(ma) : NULL;
2300 format_u128(ds, value, mask, verbose);
2304 case OVS_KEY_ATTR_TUNNEL:
2305 format_odp_tun_attr(a, ma, ds, verbose);
2308 case OVS_KEY_ATTR_IN_PORT:
2309 if (portno_names && verbose && is_exact) {
2310 char *name = odp_portno_names_get(portno_names,
2311 u32_to_odp(nl_attr_get_u32(a)));
2313 ds_put_format(ds, "%s", name);
2315 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2318 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2320 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2325 case OVS_KEY_ATTR_ETHERNET: {
2326 const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
2327 const struct ovs_key_ethernet *key = nl_attr_get(a);
2329 format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
2330 format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
2334 case OVS_KEY_ATTR_VLAN:
2335 format_vlan_tci(ds, nl_attr_get_be16(a),
2336 ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
2339 case OVS_KEY_ATTR_MPLS: {
2340 const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
2341 const struct ovs_key_mpls *mpls_mask = NULL;
2342 size_t size = nl_attr_get_size(a);
2344 if (!size || size % sizeof *mpls_key) {
2345 ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
2349 mpls_mask = nl_attr_get(ma);
2350 if (size != nl_attr_get_size(ma)) {
2351 ds_put_format(ds, "(key length %"PRIuSIZE" != "
2352 "mask length %"PRIuSIZE")",
2353 size, nl_attr_get_size(ma));
2357 format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
2360 case OVS_KEY_ATTR_ETHERTYPE:
2361 ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
2363 ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
2367 case OVS_KEY_ATTR_IPV4: {
2368 const struct ovs_key_ipv4 *key = nl_attr_get(a);
2369 const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
2371 format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
2372 format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
2373 format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
2375 format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
2376 format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
2377 format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
2382 case OVS_KEY_ATTR_IPV6: {
2383 const struct ovs_key_ipv6 *key = nl_attr_get(a);
2384 const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
2386 format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
2387 format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
2388 format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
2390 format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
2392 format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
2394 format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
2396 format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
2401 /* These have the same structure and format. */
2402 case OVS_KEY_ATTR_TCP:
2403 case OVS_KEY_ATTR_UDP:
2404 case OVS_KEY_ATTR_SCTP: {
2405 const struct ovs_key_tcp *key = nl_attr_get(a);
2406 const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
2408 format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
2409 format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
2413 case OVS_KEY_ATTR_TCP_FLAGS:
2415 format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
2416 ntohs(nl_attr_get_be16(a)),
2417 TCP_FLAGS(nl_attr_get_be16(ma)),
2418 TCP_FLAGS(OVS_BE16_MAX));
2420 format_flags(ds, packet_tcp_flag_to_string,
2421 ntohs(nl_attr_get_be16(a)), '|');
2425 case OVS_KEY_ATTR_ICMP: {
2426 const struct ovs_key_icmp *key = nl_attr_get(a);
2427 const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
2429 format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
2430 format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
2434 case OVS_KEY_ATTR_ICMPV6: {
2435 const struct ovs_key_icmpv6 *key = nl_attr_get(a);
2436 const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
2438 format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
2440 format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
2445 case OVS_KEY_ATTR_ARP: {
2446 const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
2447 const struct ovs_key_arp *key = nl_attr_get(a);
2449 format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
2450 format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
2451 format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
2452 format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
2453 format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
2457 case OVS_KEY_ATTR_ND: {
2458 const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
2459 const struct ovs_key_nd *key = nl_attr_get(a);
2461 format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
2463 format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
2464 format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
2469 case OVS_KEY_ATTR_UNSPEC:
2470 case __OVS_KEY_ATTR_MAX:
2472 format_generic_odp_key(a, ds);
2474 ds_put_char(ds, '/');
2475 format_generic_odp_key(ma, ds);
2479 ds_put_char(ds, ')');
2482 static struct nlattr *
2483 generate_all_wildcard_mask(const struct attr_len_tbl tbl[], int max,
2484 struct ofpbuf *ofp, const struct nlattr *key)
2486 const struct nlattr *a;
2488 int type = nl_attr_type(key);
2489 int size = nl_attr_get_size(key);
2491 if (odp_key_attr_len(tbl, max, type) != ATTR_LEN_NESTED) {
2492 nl_msg_put_unspec_zero(ofp, type, size);
2496 if (tbl[type].next) {
2497 tbl = tbl[type].next;
2498 max = tbl[type].next_max;
2501 nested_mask = nl_msg_start_nested(ofp, type);
2502 NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
2503 generate_all_wildcard_mask(tbl, max, ofp, nl_attr_get(a));
2505 nl_msg_end_nested(ofp, nested_mask);
2512 format_u128(struct ds *ds, const ovs_u128 *key, const ovs_u128 *mask,
2515 if (verbose || (mask && !ovs_u128_is_zero(mask))) {
2518 hton128(key, &value);
2519 ds_put_hex(ds, &value, sizeof value);
2520 if (mask && !(ovs_u128_is_ones(mask))) {
2521 hton128(mask, &value);
2522 ds_put_char(ds, '/');
2523 ds_put_hex(ds, &value, sizeof value);
2529 scan_u128(const char *s_, ovs_u128 *value, ovs_u128 *mask)
2531 char *s = CONST_CAST(char *, s_);
2535 if (!parse_int_string(s, (uint8_t *)&be_value, sizeof be_value, &s)) {
2536 ntoh128(&be_value, value);
2541 if (ovs_scan(s, "/%n", &n)) {
2545 error = parse_int_string(s, (uint8_t *)&be_mask,
2546 sizeof be_mask, &s);
2550 ntoh128(&be_mask, mask);
2552 *mask = OVS_U128_MAX;
2562 odp_ufid_from_string(const char *s_, ovs_u128 *ufid)
2566 if (ovs_scan(s, "ufid:")) {
2569 if (!uuid_from_string_prefix((struct uuid *)ufid, s)) {
2581 odp_format_ufid(const ovs_u128 *ufid, struct ds *ds)
2583 ds_put_format(ds, "ufid:"UUID_FMT, UUID_ARGS((struct uuid *)ufid));
2586 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2587 * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
2588 * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
2589 * non-null and 'verbose' is true, translates odp port number to its name. */
2591 odp_flow_format(const struct nlattr *key, size_t key_len,
2592 const struct nlattr *mask, size_t mask_len,
2593 const struct hmap *portno_names, struct ds *ds, bool verbose)
2596 const struct nlattr *a;
2598 bool has_ethtype_key = false;
2599 const struct nlattr *ma = NULL;
2601 bool first_field = true;
2603 ofpbuf_init(&ofp, 100);
2604 NL_ATTR_FOR_EACH (a, left, key, key_len) {
2605 bool is_nested_attr;
2606 bool is_wildcard = false;
2607 int attr_type = nl_attr_type(a);
2609 if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
2610 has_ethtype_key = true;
2613 is_nested_attr = odp_key_attr_len(ovs_flow_key_attr_lens,
2614 OVS_KEY_ATTR_MAX, attr_type) ==
2617 if (mask && mask_len) {
2618 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
2619 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
2622 if (verbose || !is_wildcard || is_nested_attr) {
2623 if (is_wildcard && !ma) {
2624 ma = generate_all_wildcard_mask(ovs_flow_key_attr_lens,
2629 ds_put_char(ds, ',');
2631 format_odp_key_attr(a, ma, portno_names, ds, verbose);
2632 first_field = false;
2636 ofpbuf_uninit(&ofp);
2641 if (left == key_len) {
2642 ds_put_cstr(ds, "<empty>");
2644 ds_put_format(ds, ",***%u leftover bytes*** (", left);
2645 for (i = 0; i < left; i++) {
2646 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
2648 ds_put_char(ds, ')');
2650 if (!has_ethtype_key) {
2651 ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
2653 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
2654 ntohs(nl_attr_get_be16(ma)));
2658 ds_put_cstr(ds, "<empty>");
2662 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2663 * OVS_KEY_ATTR_* attributes in 'key'. */
2665 odp_flow_key_format(const struct nlattr *key,
2666 size_t key_len, struct ds *ds)
2668 odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
2672 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
2674 if (!strcasecmp(s, "no")) {
2675 *type = OVS_FRAG_TYPE_NONE;
2676 } else if (!strcasecmp(s, "first")) {
2677 *type = OVS_FRAG_TYPE_FIRST;
2678 } else if (!strcasecmp(s, "later")) {
2679 *type = OVS_FRAG_TYPE_LATER;
2689 scan_eth(const char *s, struct eth_addr *key, struct eth_addr *mask)
2693 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n",
2694 ETH_ADDR_SCAN_ARGS(*key), &n)) {
2698 if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
2699 ETH_ADDR_SCAN_ARGS(*mask), &n)) {
2702 memset(mask, 0xff, sizeof *mask);
2711 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
2715 if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
2719 if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
2720 IP_SCAN_ARGS(mask), &n)) {
2723 *mask = OVS_BE32_MAX;
2732 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
2735 char ipv6_s[IPV6_SCAN_LEN + 1];
2737 if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
2738 && inet_pton(AF_INET6, ipv6_s, key) == 1) {
2742 if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
2743 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
2746 memset(mask, 0xff, sizeof *mask);
2755 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2760 if (ovs_scan(s, "%i%n", &key_, &n)
2761 && (key_ & ~IPV6_LABEL_MASK) == 0) {
2766 if (ovs_scan(s + len, "/%i%n", &mask_, &n)
2767 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
2769 *mask = htonl(mask_);
2771 *mask = htonl(IPV6_LABEL_MASK);
2780 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
2784 if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
2788 if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
2800 scan_u16(const char *s, uint16_t *key, uint16_t *mask)
2804 if (ovs_scan(s, "%"SCNi16"%n", key, &n)) {
2808 if (ovs_scan(s + len, "/%"SCNi16"%n", mask, &n)) {
2820 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
2824 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2828 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2840 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
2842 uint16_t key_, mask_;
2845 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2850 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2852 *mask = htons(mask_);
2854 *mask = OVS_BE16_MAX;
2863 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
2865 uint64_t key_, mask_;
2868 if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
2871 *key = htonll(key_);
2873 if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
2875 *mask = htonll(mask_);
2877 *mask = OVS_BE64_MAX;
2886 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
2888 uint32_t flags, fmask;
2891 n = parse_odp_flags(s, flow_tun_flag_to_string, &flags,
2892 FLOW_TNL_F_MASK, mask ? &fmask : NULL);
2893 if (n >= 0 && s[n] == ')') {
2904 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
2906 uint32_t flags, fmask;
2909 n = parse_odp_flags(s, packet_tcp_flag_to_string, &flags,
2910 TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
2912 *key = htons(flags);
2914 *mask = htons(fmask);
2922 ovs_to_odp_ct_state(uint8_t state)
2926 if (state & CS_NEW) {
2927 odp |= OVS_CS_F_NEW;
2929 if (state & CS_ESTABLISHED) {
2930 odp |= OVS_CS_F_ESTABLISHED;
2932 if (state & CS_RELATED) {
2933 odp |= OVS_CS_F_RELATED;
2935 if (state & CS_INVALID) {
2936 odp |= OVS_CS_F_INVALID;
2938 if (state & CS_REPLY_DIR) {
2939 odp |= OVS_CS_F_REPLY_DIR;
2941 if (state & CS_TRACKED) {
2942 odp |= OVS_CS_F_TRACKED;
2949 odp_to_ovs_ct_state(uint32_t flags)
2953 if (flags & OVS_CS_F_NEW) {
2956 if (flags & OVS_CS_F_ESTABLISHED) {
2957 state |= CS_ESTABLISHED;
2959 if (flags & OVS_CS_F_RELATED) {
2960 state |= CS_RELATED;
2962 if (flags & OVS_CS_F_INVALID) {
2963 state |= CS_INVALID;
2965 if (flags & OVS_CS_F_REPLY_DIR) {
2966 state |= CS_REPLY_DIR;
2968 if (flags & OVS_CS_F_TRACKED) {
2969 state |= CS_TRACKED;
2976 scan_ct_state(const char *s, uint32_t *key, uint32_t *mask)
2978 uint32_t flags, fmask;
2981 n = parse_flags(s, odp_ct_state_to_string, ')', NULL, NULL, &flags,
2982 ovs_to_odp_ct_state(CS_SUPPORTED_MASK),
2983 mask ? &fmask : NULL);
2996 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
3000 enum ovs_frag_type frag_type;
3002 if (ovs_scan(s, "%7[a-z]%n", frag, &n)
3003 && ovs_frag_type_from_string(frag, &frag_type)) {
3016 scan_port(const char *s, uint32_t *key, uint32_t *mask,
3017 const struct simap *port_names)
3021 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
3025 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
3032 } else if (port_names) {
3033 const struct simap_node *node;
3036 len = strcspn(s, ")");
3037 node = simap_find_len(port_names, s, len);
3050 /* Helper for vlan parsing. */
3051 struct ovs_key_vlan__ {
3056 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
3058 const uint16_t mask = ((1U << bits) - 1) << offset;
3060 if (value >> bits) {
3064 *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
3069 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
3072 uint16_t key_, mask_;
3075 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
3078 if (set_be16_bf(key, bits, offset, key_)) {
3080 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
3083 if (!set_be16_bf(mask, bits, offset, mask_)) {
3087 *mask |= htons(((1U << bits) - 1) << offset);
3097 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
3099 return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
3103 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
3105 return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
3109 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
3111 return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
3116 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
3118 const uint32_t mask = ((1U << bits) - 1) << offset;
3120 if (value >> bits) {
3124 *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
3129 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
3132 uint32_t key_, mask_;
3135 if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
3138 if (set_be32_bf(key, bits, offset, key_)) {
3140 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
3143 if (!set_be32_bf(mask, bits, offset, mask_)) {
3147 *mask |= htonl(((1U << bits) - 1) << offset);
3157 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
3159 return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
3163 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
3165 return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
3169 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
3171 return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
3175 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
3177 return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
3181 scan_vxlan_gbp(const char *s, uint32_t *key, uint32_t *mask)
3183 const char *s_base = s;
3184 ovs_be16 id = 0, id_mask = 0;
3185 uint8_t flags = 0, flags_mask = 0;
3187 if (!strncmp(s, "id=", 3)) {
3189 s += scan_be16(s, &id, mask ? &id_mask : NULL);
3195 if (!strncmp(s, "flags=", 6)) {
3197 s += scan_u8(s, &flags, mask ? &flags_mask : NULL);
3200 if (!strncmp(s, "))", 2)) {
3203 *key = (flags << 16) | ntohs(id);
3205 *mask = (flags_mask << 16) | ntohs(id_mask);
3215 scan_geneve(const char *s, struct geneve_scan *key, struct geneve_scan *mask)
3217 const char *s_base = s;
3218 struct geneve_opt *opt = key->d;
3219 struct geneve_opt *opt_mask = mask ? mask->d : NULL;
3220 int len_remain = sizeof key->d;
3222 while (s[0] == '{' && len_remain >= sizeof *opt) {
3226 len_remain -= sizeof *opt;
3228 if (!strncmp(s, "class=", 6)) {
3230 s += scan_be16(s, &opt->opt_class,
3231 mask ? &opt_mask->opt_class : NULL);
3233 memset(&opt_mask->opt_class, 0, sizeof opt_mask->opt_class);
3239 if (!strncmp(s, "type=", 5)) {
3241 s += scan_u8(s, &opt->type, mask ? &opt_mask->type : NULL);
3243 memset(&opt_mask->type, 0, sizeof opt_mask->type);
3249 if (!strncmp(s, "len=", 4)) {
3250 uint8_t opt_len, opt_len_mask;
3252 s += scan_u8(s, &opt_len, mask ? &opt_len_mask : NULL);
3254 if (opt_len > 124 || opt_len % 4 || opt_len > len_remain) {
3257 opt->length = opt_len / 4;
3259 opt_mask->length = opt_len_mask;
3263 memset(&opt_mask->type, 0, sizeof opt_mask->type);
3269 if (parse_int_string(s, (uint8_t *)(opt + 1), data_len, (char **)&s)) {
3276 if (parse_int_string(s, (uint8_t *)(opt_mask + 1),
3277 data_len, (char **)&s)) {
3288 opt += 1 + data_len / 4;
3290 opt_mask += 1 + data_len / 4;
3292 len_remain -= data_len;
3297 int len = sizeof key->d - len_remain;
3311 tun_flags_to_attr(struct ofpbuf *a, const void *data_)
3313 const uint16_t *flags = data_;
3315 if (*flags & FLOW_TNL_F_DONT_FRAGMENT) {
3316 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
3318 if (*flags & FLOW_TNL_F_CSUM) {
3319 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
3321 if (*flags & FLOW_TNL_F_OAM) {
3322 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
3327 vxlan_gbp_to_attr(struct ofpbuf *a, const void *data_)
3329 const uint32_t *gbp = data_;
3332 size_t vxlan_opts_ofs;
3334 vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
3335 nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP, *gbp);
3336 nl_msg_end_nested(a, vxlan_opts_ofs);
3341 geneve_to_attr(struct ofpbuf *a, const void *data_)
3343 const struct geneve_scan *geneve = data_;
3345 nl_msg_put_unspec(a, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, geneve->d,
3349 #define SCAN_PUT_ATTR(BUF, ATTR, DATA, FUNC) \
3351 unsigned long call_fn = (unsigned long)FUNC; \
3353 typedef void (*fn)(struct ofpbuf *, const void *); \
3355 func(BUF, &(DATA)); \
3357 nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
3361 #define SCAN_IF(NAME) \
3362 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3363 const char *start = s; \
3368 /* Usually no special initialization is needed. */
3369 #define SCAN_BEGIN(NAME, TYPE) \
3372 memset(&skey, 0, sizeof skey); \
3373 memset(&smask, 0, sizeof smask); \
3377 /* Init as fully-masked as mask will not be scanned. */
3378 #define SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) \
3381 memset(&skey, 0, sizeof skey); \
3382 memset(&smask, 0xff, sizeof smask); \
3386 /* VLAN needs special initialization. */
3387 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT) \
3389 TYPE skey = KEY_INIT; \
3390 TYPE smask = MASK_INIT; \
3394 /* Scan unnamed entry as 'TYPE' */
3395 #define SCAN_TYPE(TYPE, KEY, MASK) \
3396 len = scan_##TYPE(s, KEY, MASK); \
3402 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3403 #define SCAN_FIELD(NAME, TYPE, FIELD) \
3404 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3405 s += strlen(NAME); \
3406 SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL); \
3410 #define SCAN_FINISH() \
3411 } while (*s++ == ',' && len != 0); \
3412 if (s[-1] != ')') { \
3416 #define SCAN_FINISH_SINGLE() \
3418 if (*s++ != ')') { \
3422 /* Beginning of nested attribute. */
3423 #define SCAN_BEGIN_NESTED(NAME, ATTR) \
3425 size_t key_offset, mask_offset; \
3426 key_offset = nl_msg_start_nested(key, ATTR); \
3428 mask_offset = nl_msg_start_nested(mask, ATTR); \
3433 #define SCAN_END_NESTED() \
3435 nl_msg_end_nested(key, key_offset); \
3437 nl_msg_end_nested(mask, mask_offset); \
3442 #define SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, FUNC) \
3443 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3445 memset(&skey, 0, sizeof skey); \
3446 memset(&smask, 0xff, sizeof smask); \
3447 s += strlen(NAME); \
3448 SCAN_TYPE(SCAN_AS, &skey, &smask); \
3449 SCAN_PUT(ATTR, FUNC); \
3453 #define SCAN_FIELD_NESTED(NAME, TYPE, SCAN_AS, ATTR) \
3454 SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, NULL)
3456 #define SCAN_FIELD_NESTED_FUNC(NAME, TYPE, SCAN_AS, FUNC) \
3457 SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, 0, FUNC)
3459 #define SCAN_PUT(ATTR, FUNC) \
3460 if (!mask || !is_all_zeros(&smask, sizeof smask)) { \
3461 SCAN_PUT_ATTR(key, ATTR, skey, FUNC); \
3463 SCAN_PUT_ATTR(mask, ATTR, smask, FUNC); \
3467 #define SCAN_END(ATTR) \
3469 SCAN_PUT(ATTR, NULL); \
3473 #define SCAN_END_SINGLE(ATTR) \
3474 SCAN_FINISH_SINGLE(); \
3475 SCAN_PUT(ATTR, NULL); \
3479 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR) \
3480 SCAN_BEGIN(NAME, TYPE) { \
3481 SCAN_TYPE(SCAN_AS, &skey, &smask); \
3482 } SCAN_END_SINGLE(ATTR)
3484 #define SCAN_SINGLE_FULLY_MASKED(NAME, TYPE, SCAN_AS, ATTR) \
3485 SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) { \
3486 SCAN_TYPE(SCAN_AS, &skey, NULL); \
3487 } SCAN_END_SINGLE(ATTR)
3489 /* scan_port needs one extra argument. */
3490 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR) \
3491 SCAN_BEGIN(NAME, TYPE) { \
3492 len = scan_port(s, &skey, &smask, port_names); \
3497 } SCAN_END_SINGLE(ATTR)
3500 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
3501 struct ofpbuf *key, struct ofpbuf *mask)
3507 len = odp_ufid_from_string(s, &ufid);
3512 SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
3513 SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
3514 SCAN_SINGLE_FULLY_MASKED("recirc_id(", uint32_t, u32,
3515 OVS_KEY_ATTR_RECIRC_ID);
3516 SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
3518 SCAN_SINGLE("ct_state(", uint32_t, ct_state, OVS_KEY_ATTR_CT_STATE);
3519 SCAN_SINGLE("ct_zone(", uint16_t, u16, OVS_KEY_ATTR_CT_ZONE);
3520 SCAN_SINGLE("ct_mark(", uint32_t, u32, OVS_KEY_ATTR_CT_MARK);
3521 SCAN_SINGLE("ct_label(", ovs_u128, u128, OVS_KEY_ATTR_CT_LABELS);
3523 SCAN_BEGIN_NESTED("tunnel(", OVS_KEY_ATTR_TUNNEL) {
3524 SCAN_FIELD_NESTED("tun_id=", ovs_be64, be64, OVS_TUNNEL_KEY_ATTR_ID);
3525 SCAN_FIELD_NESTED("src=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_SRC);
3526 SCAN_FIELD_NESTED("dst=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_DST);
3527 SCAN_FIELD_NESTED("tos=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TOS);
3528 SCAN_FIELD_NESTED("ttl=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TTL);
3529 SCAN_FIELD_NESTED("tp_src=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_SRC);
3530 SCAN_FIELD_NESTED("tp_dst=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_DST);
3531 SCAN_FIELD_NESTED_FUNC("vxlan(gbp(", uint32_t, vxlan_gbp, vxlan_gbp_to_attr);
3532 SCAN_FIELD_NESTED_FUNC("geneve(", struct geneve_scan, geneve,
3534 SCAN_FIELD_NESTED_FUNC("flags(", uint16_t, tun_flags, tun_flags_to_attr);
3535 } SCAN_END_NESTED();
3537 SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
3539 SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
3540 SCAN_FIELD("src=", eth, eth_src);
3541 SCAN_FIELD("dst=", eth, eth_dst);
3542 } SCAN_END(OVS_KEY_ATTR_ETHERNET);
3544 SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
3545 { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
3546 SCAN_FIELD("vid=", vid, tci);
3547 SCAN_FIELD("pcp=", pcp, tci);
3548 SCAN_FIELD("cfi=", cfi, tci);
3549 } SCAN_END(OVS_KEY_ATTR_VLAN);
3551 SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
3553 SCAN_BEGIN("mpls(", struct ovs_key_mpls) {
3554 SCAN_FIELD("label=", mpls_label, mpls_lse);
3555 SCAN_FIELD("tc=", mpls_tc, mpls_lse);
3556 SCAN_FIELD("ttl=", mpls_ttl, mpls_lse);
3557 SCAN_FIELD("bos=", mpls_bos, mpls_lse);
3558 } SCAN_END(OVS_KEY_ATTR_MPLS);
3560 SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
3561 SCAN_FIELD("src=", ipv4, ipv4_src);
3562 SCAN_FIELD("dst=", ipv4, ipv4_dst);
3563 SCAN_FIELD("proto=", u8, ipv4_proto);
3564 SCAN_FIELD("tos=", u8, ipv4_tos);
3565 SCAN_FIELD("ttl=", u8, ipv4_ttl);
3566 SCAN_FIELD("frag=", frag, ipv4_frag);
3567 } SCAN_END(OVS_KEY_ATTR_IPV4);
3569 SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
3570 SCAN_FIELD("src=", ipv6, ipv6_src);
3571 SCAN_FIELD("dst=", ipv6, ipv6_dst);
3572 SCAN_FIELD("label=", ipv6_label, ipv6_label);
3573 SCAN_FIELD("proto=", u8, ipv6_proto);
3574 SCAN_FIELD("tclass=", u8, ipv6_tclass);
3575 SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
3576 SCAN_FIELD("frag=", frag, ipv6_frag);
3577 } SCAN_END(OVS_KEY_ATTR_IPV6);
3579 SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
3580 SCAN_FIELD("src=", be16, tcp_src);
3581 SCAN_FIELD("dst=", be16, tcp_dst);
3582 } SCAN_END(OVS_KEY_ATTR_TCP);
3584 SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
3586 SCAN_BEGIN("udp(", struct ovs_key_udp) {
3587 SCAN_FIELD("src=", be16, udp_src);
3588 SCAN_FIELD("dst=", be16, udp_dst);
3589 } SCAN_END(OVS_KEY_ATTR_UDP);
3591 SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
3592 SCAN_FIELD("src=", be16, sctp_src);
3593 SCAN_FIELD("dst=", be16, sctp_dst);
3594 } SCAN_END(OVS_KEY_ATTR_SCTP);
3596 SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
3597 SCAN_FIELD("type=", u8, icmp_type);
3598 SCAN_FIELD("code=", u8, icmp_code);
3599 } SCAN_END(OVS_KEY_ATTR_ICMP);
3601 SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
3602 SCAN_FIELD("type=", u8, icmpv6_type);
3603 SCAN_FIELD("code=", u8, icmpv6_code);
3604 } SCAN_END(OVS_KEY_ATTR_ICMPV6);
3606 SCAN_BEGIN("arp(", struct ovs_key_arp) {
3607 SCAN_FIELD("sip=", ipv4, arp_sip);
3608 SCAN_FIELD("tip=", ipv4, arp_tip);
3609 SCAN_FIELD("op=", be16, arp_op);
3610 SCAN_FIELD("sha=", eth, arp_sha);
3611 SCAN_FIELD("tha=", eth, arp_tha);
3612 } SCAN_END(OVS_KEY_ATTR_ARP);
3614 SCAN_BEGIN("nd(", struct ovs_key_nd) {
3615 SCAN_FIELD("target=", ipv6, nd_target);
3616 SCAN_FIELD("sll=", eth, nd_sll);
3617 SCAN_FIELD("tll=", eth, nd_tll);
3618 } SCAN_END(OVS_KEY_ATTR_ND);
3620 /* Encap open-coded. */
3621 if (!strncmp(s, "encap(", 6)) {
3622 const char *start = s;
3623 size_t encap, encap_mask = 0;
3625 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
3627 encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
3634 s += strspn(s, delimiters);
3637 } else if (*s == ')') {
3641 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3649 nl_msg_end_nested(key, encap);
3651 nl_msg_end_nested(mask, encap_mask);
3660 /* Parses the string representation of a datapath flow key, in the
3661 * format output by odp_flow_key_format(). Returns 0 if successful,
3662 * otherwise a positive errno value. On success, the flow key is
3663 * appended to 'key' as a series of Netlink attributes. On failure, no
3664 * data is appended to 'key'. Either way, 'key''s data might be
3667 * If 'port_names' is nonnull, it points to an simap that maps from a port name
3668 * to a port number. (Port names may be used instead of port numbers in
3671 * On success, the attributes appended to 'key' are individually syntactically
3672 * valid, but they may not be valid as a sequence. 'key' might, for example,
3673 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
3675 odp_flow_from_string(const char *s, const struct simap *port_names,
3676 struct ofpbuf *key, struct ofpbuf *mask)
3678 const size_t old_size = key->size;
3682 s += strspn(s, delimiters);
3687 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3689 key->size = old_size;
3699 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
3702 /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
3703 * not a set of flags or bitfields. Hence, if the struct flow nw_frag
3704 * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
3705 * must use a zero mask for the netlink frag field, and all ones mask
3707 return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
3709 return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
3710 : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
3711 : OVS_FRAG_TYPE_FIRST;
3714 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
3715 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
3716 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
3718 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
3720 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
3722 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
3724 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
3725 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
3726 static void get_nd_key(const struct flow *, struct ovs_key_nd *);
3727 static void put_nd_key(const struct ovs_key_nd *, struct flow *);
3729 /* These share the same layout. */
3731 struct ovs_key_tcp tcp;
3732 struct ovs_key_udp udp;
3733 struct ovs_key_sctp sctp;
3736 static void get_tp_key(const struct flow *, union ovs_key_tp *);
3737 static void put_tp_key(const union ovs_key_tp *, struct flow *);
3740 odp_flow_key_from_flow__(const struct odp_flow_key_parms *parms,
3741 bool export_mask, struct ofpbuf *buf)
3743 struct ovs_key_ethernet *eth_key;
3745 const struct flow *flow = parms->flow;
3746 const struct flow *data = export_mask ? parms->mask : parms->flow;
3748 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
3750 if (flow->tunnel.ip_dst || export_mask) {
3751 tun_key_to_attr(buf, &data->tunnel, &parms->flow->tunnel,
3755 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
3757 if (parms->support.ct_state) {
3758 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
3759 ovs_to_odp_ct_state(data->ct_state));
3761 if (parms->support.ct_zone) {
3762 nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, data->ct_zone);
3764 if (parms->support.ct_mark) {
3765 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, data->ct_mark);
3767 if (parms->support.ct_label) {
3768 nl_msg_put_unspec(buf, OVS_KEY_ATTR_CT_LABELS, &data->ct_label,
3769 sizeof(data->ct_label));
3771 if (parms->support.recirc) {
3772 nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
3773 nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
3776 /* Add an ingress port attribute if this is a mask or 'odp_in_port'
3777 * is not the magical value "ODPP_NONE". */
3778 if (export_mask || parms->odp_in_port != ODPP_NONE) {
3779 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, parms->odp_in_port);
3782 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
3784 get_ethernet_key(data, eth_key);
3786 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
3788 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3790 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
3792 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
3793 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
3794 if (flow->vlan_tci == htons(0)) {
3801 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3802 /* For backwards compatibility with kernels that don't support
3803 * wildcarding, the following convention is used to encode the
3804 * OVS_KEY_ATTR_ETHERTYPE for key and mask:
3807 * -------- -------- -------
3808 * >0x5ff 0xffff Specified Ethernet II Ethertype.
3809 * >0x5ff 0 Any Ethernet II or non-Ethernet II frame.
3810 * <none> 0xffff Any non-Ethernet II frame (except valid
3811 * 802.3 SNAP packet with valid eth_type).
3814 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3819 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
3821 if (flow->dl_type == htons(ETH_TYPE_IP)) {
3822 struct ovs_key_ipv4 *ipv4_key;
3824 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
3826 get_ipv4_key(data, ipv4_key, export_mask);
3827 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
3828 struct ovs_key_ipv6 *ipv6_key;
3830 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
3832 get_ipv6_key(data, ipv6_key, export_mask);
3833 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
3834 flow->dl_type == htons(ETH_TYPE_RARP)) {
3835 struct ovs_key_arp *arp_key;
3837 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
3839 get_arp_key(data, arp_key);
3840 } else if (eth_type_mpls(flow->dl_type)) {
3841 struct ovs_key_mpls *mpls_key;
3844 n = flow_count_mpls_labels(flow, NULL);
3846 n = MIN(n, parms->support.max_mpls_depth);
3848 mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
3849 n * sizeof *mpls_key);
3850 for (i = 0; i < n; i++) {
3851 mpls_key[i].mpls_lse = data->mpls_lse[i];
3855 if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3856 if (flow->nw_proto == IPPROTO_TCP) {
3857 union ovs_key_tp *tcp_key;
3859 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
3861 get_tp_key(data, tcp_key);
3862 if (data->tcp_flags) {
3863 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
3865 } else if (flow->nw_proto == IPPROTO_UDP) {
3866 union ovs_key_tp *udp_key;
3868 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
3870 get_tp_key(data, udp_key);
3871 } else if (flow->nw_proto == IPPROTO_SCTP) {
3872 union ovs_key_tp *sctp_key;
3874 sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
3876 get_tp_key(data, sctp_key);
3877 } else if (flow->dl_type == htons(ETH_TYPE_IP)
3878 && flow->nw_proto == IPPROTO_ICMP) {
3879 struct ovs_key_icmp *icmp_key;
3881 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
3883 icmp_key->icmp_type = ntohs(data->tp_src);
3884 icmp_key->icmp_code = ntohs(data->tp_dst);
3885 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
3886 && flow->nw_proto == IPPROTO_ICMPV6) {
3887 struct ovs_key_icmpv6 *icmpv6_key;
3889 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
3890 sizeof *icmpv6_key);
3891 icmpv6_key->icmpv6_type = ntohs(data->tp_src);
3892 icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
3894 if (flow->tp_dst == htons(0)
3895 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
3896 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT))
3897 && (!export_mask || (data->tp_src == htons(0xffff)
3898 && data->tp_dst == htons(0xffff)))) {
3900 struct ovs_key_nd *nd_key;
3902 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
3904 memcpy(nd_key->nd_target, &data->nd_target,
3905 sizeof nd_key->nd_target);
3906 nd_key->nd_sll = data->arp_sha;
3907 nd_key->nd_tll = data->arp_tha;
3914 nl_msg_end_nested(buf, encap);
3918 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
3920 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3921 * capable of being expanded to allow for that much space. */
3923 odp_flow_key_from_flow(const struct odp_flow_key_parms *parms,
3926 odp_flow_key_from_flow__(parms, false, buf);
3929 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
3932 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3933 * capable of being expanded to allow for that much space. */
3935 odp_flow_key_from_mask(const struct odp_flow_key_parms *parms,
3938 odp_flow_key_from_flow__(parms, true, buf);
3941 /* Generate ODP flow key from the given packet metadata */
3943 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
3945 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
3947 if (md->tunnel.ip_dst) {
3948 tun_key_to_attr(buf, &md->tunnel, &md->tunnel, NULL);
3951 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
3954 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
3955 ovs_to_odp_ct_state(md->ct_state));
3957 nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, md->ct_zone);
3960 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, md->ct_mark);
3962 if (!ovs_u128_is_zero(&md->ct_label)) {
3963 nl_msg_put_unspec(buf, OVS_KEY_ATTR_CT_LABELS, &md->ct_label,
3964 sizeof(md->ct_label));
3968 /* Add an ingress port attribute if 'odp_in_port' is not the magical
3969 * value "ODPP_NONE". */
3970 if (md->in_port.odp_port != ODPP_NONE) {
3971 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
3975 /* Generate packet metadata from the given ODP flow key. */
3977 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
3978 struct pkt_metadata *md)
3980 const struct nlattr *nla;
3982 uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
3983 1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
3984 1u << OVS_KEY_ATTR_IN_PORT;
3986 pkt_metadata_init(md, ODPP_NONE);
3988 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3989 uint16_t type = nl_attr_type(nla);
3990 size_t len = nl_attr_get_size(nla);
3991 int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
3992 OVS_KEY_ATTR_MAX, type);
3994 if (len != expected_len && expected_len >= 0) {
3999 case OVS_KEY_ATTR_RECIRC_ID:
4000 md->recirc_id = nl_attr_get_u32(nla);
4001 wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
4003 case OVS_KEY_ATTR_DP_HASH:
4004 md->dp_hash = nl_attr_get_u32(nla);
4005 wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
4007 case OVS_KEY_ATTR_PRIORITY:
4008 md->skb_priority = nl_attr_get_u32(nla);
4009 wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
4011 case OVS_KEY_ATTR_SKB_MARK:
4012 md->pkt_mark = nl_attr_get_u32(nla);
4013 wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
4015 case OVS_KEY_ATTR_CT_STATE:
4016 md->ct_state = odp_to_ovs_ct_state(nl_attr_get_u32(nla));
4017 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_STATE);
4019 case OVS_KEY_ATTR_CT_ZONE:
4020 md->ct_zone = nl_attr_get_u16(nla);
4021 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_ZONE);
4023 case OVS_KEY_ATTR_CT_MARK:
4024 md->ct_mark = nl_attr_get_u32(nla);
4025 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_MARK);
4027 case OVS_KEY_ATTR_CT_LABELS: {
4028 const ovs_u128 *cl = nl_attr_get(nla);
4031 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_LABELS);
4034 case OVS_KEY_ATTR_TUNNEL: {
4035 enum odp_key_fitness res;
4037 res = odp_tun_key_from_attr(nla, true, &md->tunnel);
4038 if (res == ODP_FIT_ERROR) {
4039 memset(&md->tunnel, 0, sizeof md->tunnel);
4040 } else if (res == ODP_FIT_PERFECT) {
4041 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
4045 case OVS_KEY_ATTR_IN_PORT:
4046 md->in_port.odp_port = nl_attr_get_odp_port(nla);
4047 wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
4053 if (!wanted_attrs) {
4054 return; /* Have everything. */
4060 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
4062 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
4063 return hash_words(ALIGNED_CAST(const uint32_t *, key),
4064 key_len / sizeof(uint32_t), 0);
4068 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
4069 uint64_t attrs, int out_of_range_attr,
4070 const struct nlattr *key, size_t key_len)
4075 if (VLOG_DROP_DBG(rl)) {
4080 for (i = 0; i < 64; i++) {
4081 if (attrs & (UINT64_C(1) << i)) {
4082 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4084 ds_put_format(&s, " %s",
4085 ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
4088 if (out_of_range_attr) {
4089 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
4092 ds_put_cstr(&s, ": ");
4093 odp_flow_key_format(key, key_len, &s);
4095 VLOG_DBG("%s:%s", title, ds_cstr(&s));
4100 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
4102 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4105 return odp_frag ? FLOW_NW_FRAG_MASK : 0;
4108 if (odp_frag > OVS_FRAG_TYPE_LATER) {
4109 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
4110 return 0xff; /* Error. */
4113 return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
4114 : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
4115 : FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
4119 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
4120 const struct nlattr *attrs[], uint64_t *present_attrsp,
4121 int *out_of_range_attrp)
4123 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4124 const struct nlattr *nla;
4125 uint64_t present_attrs;
4128 BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
4130 *out_of_range_attrp = 0;
4131 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
4132 uint16_t type = nl_attr_type(nla);
4133 size_t len = nl_attr_get_size(nla);
4134 int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
4135 OVS_KEY_ATTR_MAX, type);
4137 if (len != expected_len && expected_len >= 0) {
4138 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4140 VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
4141 "length %d", ovs_key_attr_to_string(type, namebuf,
4147 if (type > OVS_KEY_ATTR_MAX) {
4148 *out_of_range_attrp = type;
4150 if (present_attrs & (UINT64_C(1) << type)) {
4151 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4153 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
4154 ovs_key_attr_to_string(type,
4155 namebuf, sizeof namebuf));
4159 present_attrs |= UINT64_C(1) << type;
4164 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
4168 *present_attrsp = present_attrs;
4172 static enum odp_key_fitness
4173 check_expectations(uint64_t present_attrs, int out_of_range_attr,
4174 uint64_t expected_attrs,
4175 const struct nlattr *key, size_t key_len)
4177 uint64_t missing_attrs;
4178 uint64_t extra_attrs;
4180 missing_attrs = expected_attrs & ~present_attrs;
4181 if (missing_attrs) {
4182 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4183 log_odp_key_attributes(&rl, "expected but not present",
4184 missing_attrs, 0, key, key_len);
4185 return ODP_FIT_TOO_LITTLE;
4188 extra_attrs = present_attrs & ~expected_attrs;
4189 if (extra_attrs || out_of_range_attr) {
4190 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4191 log_odp_key_attributes(&rl, "present but not expected",
4192 extra_attrs, out_of_range_attr, key, key_len);
4193 return ODP_FIT_TOO_MUCH;
4196 return ODP_FIT_PERFECT;
4200 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4201 uint64_t present_attrs, uint64_t *expected_attrs,
4202 struct flow *flow, const struct flow *src_flow)
4204 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4205 bool is_mask = flow != src_flow;
4207 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
4208 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
4209 if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
4210 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
4211 ntohs(flow->dl_type));
4214 if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
4215 flow->dl_type != htons(0xffff)) {
4218 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
4221 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
4222 } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
4223 /* See comments in odp_flow_key_from_flow__(). */
4224 VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
4231 static enum odp_key_fitness
4232 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4233 uint64_t present_attrs, int out_of_range_attr,
4234 uint64_t expected_attrs, struct flow *flow,
4235 const struct nlattr *key, size_t key_len,
4236 const struct flow *src_flow)
4238 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4239 bool is_mask = src_flow != flow;
4240 const void *check_start = NULL;
4241 size_t check_len = 0;
4242 enum ovs_key_attr expected_bit = 0xff;
4244 if (eth_type_mpls(src_flow->dl_type)) {
4245 if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4246 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
4248 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4249 size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
4250 const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
4251 int n = size / sizeof(ovs_be32);
4254 if (!size || size % sizeof(ovs_be32)) {
4255 return ODP_FIT_ERROR;
4257 if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
4258 return ODP_FIT_ERROR;
4261 for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
4262 flow->mpls_lse[i] = mpls_lse[i];
4264 if (n > FLOW_MAX_MPLS_LABELS) {
4265 return ODP_FIT_TOO_MUCH;
4269 /* BOS may be set only in the innermost label. */
4270 for (i = 0; i < n - 1; i++) {
4271 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
4272 return ODP_FIT_ERROR;
4276 /* BOS must be set in the innermost label. */
4277 if (n < FLOW_MAX_MPLS_LABELS
4278 && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
4279 return ODP_FIT_TOO_LITTLE;
4285 } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
4287 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
4289 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
4290 const struct ovs_key_ipv4 *ipv4_key;
4292 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
4293 put_ipv4_key(ipv4_key, flow, is_mask);
4294 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4295 return ODP_FIT_ERROR;
4298 check_start = ipv4_key;
4299 check_len = sizeof *ipv4_key;
4300 expected_bit = OVS_KEY_ATTR_IPV4;
4303 } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
4305 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
4307 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
4308 const struct ovs_key_ipv6 *ipv6_key;
4310 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
4311 put_ipv6_key(ipv6_key, flow, is_mask);
4312 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4313 return ODP_FIT_ERROR;
4316 check_start = ipv6_key;
4317 check_len = sizeof *ipv6_key;
4318 expected_bit = OVS_KEY_ATTR_IPV6;
4321 } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
4322 src_flow->dl_type == htons(ETH_TYPE_RARP)) {
4324 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
4326 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
4327 const struct ovs_key_arp *arp_key;
4329 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
4330 if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
4331 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
4332 "key", ntohs(arp_key->arp_op));
4333 return ODP_FIT_ERROR;
4335 put_arp_key(arp_key, flow);
4337 check_start = arp_key;
4338 check_len = sizeof *arp_key;
4339 expected_bit = OVS_KEY_ATTR_ARP;
4345 if (check_len > 0) { /* Happens only when 'is_mask'. */
4346 if (!is_all_zeros(check_start, check_len) &&
4347 flow->dl_type != htons(0xffff)) {
4348 return ODP_FIT_ERROR;
4350 expected_attrs |= UINT64_C(1) << expected_bit;
4354 expected_bit = OVS_KEY_ATTR_UNSPEC;
4355 if (src_flow->nw_proto == IPPROTO_TCP
4356 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4357 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4358 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4360 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
4362 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
4363 const union ovs_key_tp *tcp_key;
4365 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
4366 put_tp_key(tcp_key, flow);
4367 expected_bit = OVS_KEY_ATTR_TCP;
4369 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
4370 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
4371 flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
4373 } else if (src_flow->nw_proto == IPPROTO_UDP
4374 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4375 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4376 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4378 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
4380 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
4381 const union ovs_key_tp *udp_key;
4383 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
4384 put_tp_key(udp_key, flow);
4385 expected_bit = OVS_KEY_ATTR_UDP;
4387 } else if (src_flow->nw_proto == IPPROTO_SCTP
4388 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4389 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4390 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4392 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
4394 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
4395 const union ovs_key_tp *sctp_key;
4397 sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
4398 put_tp_key(sctp_key, flow);
4399 expected_bit = OVS_KEY_ATTR_SCTP;
4401 } else if (src_flow->nw_proto == IPPROTO_ICMP
4402 && src_flow->dl_type == htons(ETH_TYPE_IP)
4403 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4405 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
4407 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
4408 const struct ovs_key_icmp *icmp_key;
4410 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
4411 flow->tp_src = htons(icmp_key->icmp_type);
4412 flow->tp_dst = htons(icmp_key->icmp_code);
4413 expected_bit = OVS_KEY_ATTR_ICMP;
4415 } else if (src_flow->nw_proto == IPPROTO_ICMPV6
4416 && src_flow->dl_type == htons(ETH_TYPE_IPV6)
4417 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4419 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
4421 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
4422 const struct ovs_key_icmpv6 *icmpv6_key;
4424 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
4425 flow->tp_src = htons(icmpv6_key->icmpv6_type);
4426 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
4427 expected_bit = OVS_KEY_ATTR_ICMPV6;
4428 if (src_flow->tp_dst == htons(0) &&
4429 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
4430 src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
4432 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4434 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
4435 const struct ovs_key_nd *nd_key;
4437 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
4438 memcpy(&flow->nd_target, nd_key->nd_target,
4439 sizeof flow->nd_target);
4440 flow->arp_sha = nd_key->nd_sll;
4441 flow->arp_tha = nd_key->nd_tll;
4443 if (!is_all_zeros(nd_key, sizeof *nd_key) &&
4444 (flow->tp_src != htons(0xffff) ||
4445 flow->tp_dst != htons(0xffff))) {
4446 return ODP_FIT_ERROR;
4448 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4455 if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
4456 if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
4457 return ODP_FIT_ERROR;
4459 expected_attrs |= UINT64_C(1) << expected_bit;
4464 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
4468 /* Parse 802.1Q header then encapsulated L3 attributes. */
4469 static enum odp_key_fitness
4470 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4471 uint64_t present_attrs, int out_of_range_attr,
4472 uint64_t expected_attrs, struct flow *flow,
4473 const struct nlattr *key, size_t key_len,
4474 const struct flow *src_flow)
4476 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4477 bool is_mask = src_flow != flow;
4479 const struct nlattr *encap
4480 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
4481 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
4482 enum odp_key_fitness encap_fitness;
4483 enum odp_key_fitness fitness;
4485 /* Calculate fitness of outer attributes. */
4487 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
4488 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
4490 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4491 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4493 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
4494 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
4497 fitness = check_expectations(present_attrs, out_of_range_attr,
4498 expected_attrs, key, key_len);
4501 * Remove the TPID from dl_type since it's not the real Ethertype. */
4502 flow->dl_type = htons(0);
4503 flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
4504 ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
4507 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
4508 return ODP_FIT_TOO_LITTLE;
4509 } else if (flow->vlan_tci == htons(0)) {
4510 /* Corner case for a truncated 802.1Q header. */
4511 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
4512 return ODP_FIT_TOO_MUCH;
4515 } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
4516 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
4517 "but CFI bit is not set", ntohs(flow->vlan_tci));
4518 return ODP_FIT_ERROR;
4521 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
4526 /* Now parse the encapsulated attributes. */
4527 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
4528 attrs, &present_attrs, &out_of_range_attr)) {
4529 return ODP_FIT_ERROR;
4533 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
4534 return ODP_FIT_ERROR;
4536 encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4537 expected_attrs, flow, key, key_len,
4540 /* The overall fitness is the worse of the outer and inner attributes. */
4541 return MAX(fitness, encap_fitness);
4544 static enum odp_key_fitness
4545 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
4546 const struct nlattr *src_key, size_t src_key_len,
4547 struct flow *flow, const struct flow *src_flow,
4550 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
4551 uint64_t expected_attrs;
4552 uint64_t present_attrs;
4553 int out_of_range_attr;
4554 bool is_mask = src_flow != flow;
4556 memset(flow, 0, sizeof *flow);
4558 /* Parse attributes. */
4559 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
4560 &out_of_range_attr)) {
4561 return ODP_FIT_ERROR;
4566 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
4567 flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
4568 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
4569 } else if (is_mask) {
4570 /* Always exact match recirc_id if it is not specified. */
4571 flow->recirc_id = UINT32_MAX;
4574 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
4575 flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
4576 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
4578 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
4579 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
4580 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
4583 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
4584 flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
4585 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
4588 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_STATE)) {
4589 uint32_t odp_state = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_STATE]);
4591 flow->ct_state = odp_to_ovs_ct_state(odp_state);
4592 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_STATE;
4594 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE)) {
4595 flow->ct_zone = nl_attr_get_u16(attrs[OVS_KEY_ATTR_CT_ZONE]);
4596 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE;
4598 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_MARK)) {
4599 flow->ct_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_MARK]);
4600 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_MARK;
4602 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_LABELS)) {
4603 const ovs_u128 *cl = nl_attr_get(attrs[OVS_KEY_ATTR_CT_LABELS]);
4605 flow->ct_label = *cl;
4606 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_LABELS;
4609 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
4610 enum odp_key_fitness res;
4612 res = odp_tun_key_from_attr__(attrs[OVS_KEY_ATTR_TUNNEL],
4613 is_mask ? src_key : NULL,
4614 src_key_len, &src_flow->tunnel,
4615 &flow->tunnel, udpif);
4616 if (res == ODP_FIT_ERROR) {
4617 return ODP_FIT_ERROR;
4618 } else if (res == ODP_FIT_PERFECT) {
4619 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
4623 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
4624 flow->in_port.odp_port
4625 = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
4626 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
4627 } else if (!is_mask) {
4628 flow->in_port.odp_port = ODPP_NONE;
4631 /* Ethernet header. */
4632 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
4633 const struct ovs_key_ethernet *eth_key;
4635 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
4636 put_ethernet_key(eth_key, flow);
4638 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4642 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4645 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
4646 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
4648 return ODP_FIT_ERROR;
4652 ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
4653 : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
4654 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
4655 expected_attrs, flow, key, key_len, src_flow);
4658 /* A missing VLAN mask means exact match on vlan_tci 0 (== no VLAN). */
4659 flow->vlan_tci = htons(0xffff);
4660 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4661 flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
4662 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4665 return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4666 expected_attrs, flow, key, key_len, src_flow);
4669 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
4670 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
4671 * 'key' fits our expectations for what a flow key should contain.
4673 * The 'in_port' will be the datapath's understanding of the port. The
4674 * caller will need to translate with odp_port_to_ofp_port() if the
4675 * OpenFlow port is needed.
4677 * This function doesn't take the packet itself as an argument because none of
4678 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
4679 * it is always possible to infer which additional attribute(s) should appear
4680 * by looking at the attributes for lower-level protocols, e.g. if the network
4681 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
4682 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
4683 * must be absent. */
4684 enum odp_key_fitness
4685 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
4688 return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, false);
4691 /* Converts the 'mask_key_len' bytes of OVS_KEY_ATTR_* attributes in 'mask_key'
4692 * to a mask structure in 'mask'. 'flow' must be a previously translated flow
4693 * corresponding to 'mask' and similarly flow_key/flow_key_len must be the
4694 * attributes from that flow. Returns an ODP_FIT_* value that indicates how
4695 * well 'key' fits our expectations for what a flow key should contain. */
4696 enum odp_key_fitness
4697 odp_flow_key_to_mask(const struct nlattr *mask_key, size_t mask_key_len,
4698 const struct nlattr *flow_key, size_t flow_key_len,
4699 struct flow *mask, const struct flow *flow)
4701 return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
4705 /* These functions are similar to their non-"_udpif" variants but output a
4706 * 'flow' that is suitable for fast-path packet processing.
4708 * Some fields have different representation for flow setup and per-
4709 * packet processing (i.e. different between ofproto-dpif and userspace
4710 * datapath). In particular, with the non-"_udpif" functions, struct
4711 * tun_metadata is in the per-flow format (using 'present.map' and 'opts.u8');
4712 * with these functions, struct tun_metadata is in the per-packet format
4713 * (using 'present.len' and 'opts.gnv'). */
4714 enum odp_key_fitness
4715 odp_flow_key_to_flow_udpif(const struct nlattr *key, size_t key_len,
4718 return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, true);
4721 enum odp_key_fitness
4722 odp_flow_key_to_mask_udpif(const struct nlattr *mask_key, size_t mask_key_len,
4723 const struct nlattr *flow_key, size_t flow_key_len,
4724 struct flow *mask, const struct flow *flow)
4726 return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
4730 /* Returns 'fitness' as a string, for use in debug messages. */
4732 odp_key_fitness_to_string(enum odp_key_fitness fitness)
4735 case ODP_FIT_PERFECT:
4737 case ODP_FIT_TOO_MUCH:
4739 case ODP_FIT_TOO_LITTLE:
4740 return "too_little";
4748 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
4749 * Netlink PID 'pid'. If 'userdata' is nonnull, adds a userdata attribute
4750 * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
4751 * offset within 'odp_actions' of the start of the cookie. (If 'userdata' is
4752 * null, then the return value is not meaningful.) */
4754 odp_put_userspace_action(uint32_t pid,
4755 const void *userdata, size_t userdata_size,
4756 odp_port_t tunnel_out_port,
4757 bool include_actions,
4758 struct ofpbuf *odp_actions)
4760 size_t userdata_ofs;
4763 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
4764 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
4766 userdata_ofs = odp_actions->size + NLA_HDRLEN;
4768 /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
4769 * module before Linux 3.10 required the userdata to be exactly 8 bytes
4772 * - The kernel rejected shorter userdata with -ERANGE.
4774 * - The kernel silently dropped userdata beyond the first 8 bytes.
4776 * Thus, for maximum compatibility, always put at least 8 bytes. (We
4777 * separately disable features that required more than 8 bytes.) */
4778 memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
4779 MAX(8, userdata_size)),
4780 userdata, userdata_size);
4784 if (tunnel_out_port != ODPP_NONE) {
4785 nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
4788 if (include_actions) {
4789 nl_msg_put_flag(odp_actions, OVS_USERSPACE_ATTR_ACTIONS);
4791 nl_msg_end_nested(odp_actions, offset);
4793 return userdata_ofs;
4797 odp_put_tunnel_action(const struct flow_tnl *tunnel,
4798 struct ofpbuf *odp_actions)
4800 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4801 tun_key_to_attr(odp_actions, tunnel, tunnel, NULL);
4802 nl_msg_end_nested(odp_actions, offset);
4806 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
4807 struct ovs_action_push_tnl *data)
4809 int size = offsetof(struct ovs_action_push_tnl, header);
4811 size += data->header_len;
4812 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
4816 /* The commit_odp_actions() function and its helpers. */
4819 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
4820 const void *key, size_t key_size)
4822 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4823 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
4824 nl_msg_end_nested(odp_actions, offset);
4827 /* Masked set actions have a mask following the data within the netlink
4828 * attribute. The unmasked bits in the data will be cleared as the data
4829 * is copied to the action. */
4831 commit_masked_set_action(struct ofpbuf *odp_actions,
4832 enum ovs_key_attr key_type,
4833 const void *key_, const void *mask_, size_t key_size)
4835 size_t offset = nl_msg_start_nested(odp_actions,
4836 OVS_ACTION_ATTR_SET_MASKED);
4837 char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
4838 const char *key = key_, *mask = mask_;
4840 memcpy(data + key_size, mask, key_size);
4841 /* Clear unmasked bits while copying. */
4842 while (key_size--) {
4843 *data++ = *key++ & *mask++;
4845 nl_msg_end_nested(odp_actions, offset);
4848 /* If any of the flow key data that ODP actions can modify are different in
4849 * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
4850 * 'odp_actions' that change the flow tunneling information in key from
4851 * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
4852 * same way. In other words, operates the same as commit_odp_actions(), but
4853 * only on tunneling information. */
4855 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
4856 struct ofpbuf *odp_actions)
4858 /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
4859 if (flow->tunnel.ip_dst) {
4860 if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
4863 memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
4864 odp_put_tunnel_action(&base->tunnel, odp_actions);
4869 commit(enum ovs_key_attr attr, bool use_masked_set,
4870 const void *key, void *base, void *mask, size_t size,
4871 struct ofpbuf *odp_actions)
4873 if (memcmp(key, base, size)) {
4874 bool fully_masked = odp_mask_is_exact(attr, mask, size);
4876 if (use_masked_set && !fully_masked) {
4877 commit_masked_set_action(odp_actions, attr, key, mask, size);
4879 if (!fully_masked) {
4880 memset(mask, 0xff, size);
4882 commit_set_action(odp_actions, attr, key, size);
4884 memcpy(base, key, size);
4887 /* Mask bits are set when we have either read or set the corresponding
4888 * values. Masked bits will be exact-matched, no need to set them
4889 * if the value did not actually change. */
4895 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
4897 eth->eth_src = flow->dl_src;
4898 eth->eth_dst = flow->dl_dst;
4902 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
4904 flow->dl_src = eth->eth_src;
4905 flow->dl_dst = eth->eth_dst;
4909 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
4910 struct ofpbuf *odp_actions,
4911 struct flow_wildcards *wc,
4914 struct ovs_key_ethernet key, base, mask;
4916 get_ethernet_key(flow, &key);
4917 get_ethernet_key(base_flow, &base);
4918 get_ethernet_key(&wc->masks, &mask);
4920 if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
4921 &key, &base, &mask, sizeof key, odp_actions)) {
4922 put_ethernet_key(&base, base_flow);
4923 put_ethernet_key(&mask, &wc->masks);
4928 pop_vlan(struct flow *base,
4929 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4931 memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
4933 if (base->vlan_tci & htons(VLAN_CFI)) {
4934 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
4940 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
4941 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4943 if (base->vlan_tci == vlan_tci) {
4947 pop_vlan(base, odp_actions, wc);
4948 if (vlan_tci & htons(VLAN_CFI)) {
4949 struct ovs_action_push_vlan vlan;
4951 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
4952 vlan.vlan_tci = vlan_tci;
4953 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
4954 &vlan, sizeof vlan);
4956 base->vlan_tci = vlan_tci;
4959 /* Wildcarding already done at action translation time. */
4961 commit_mpls_action(const struct flow *flow, struct flow *base,
4962 struct ofpbuf *odp_actions)
4964 int base_n = flow_count_mpls_labels(base, NULL);
4965 int flow_n = flow_count_mpls_labels(flow, NULL);
4966 int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
4969 while (base_n > common_n) {
4970 if (base_n - 1 == common_n && flow_n > common_n) {
4971 /* If there is only one more LSE in base than there are common
4972 * between base and flow; and flow has at least one more LSE than
4973 * is common then the topmost LSE of base may be updated using
4975 struct ovs_key_mpls mpls_key;
4977 mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
4978 commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
4979 &mpls_key, sizeof mpls_key);
4980 flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
4983 /* Otherwise, if there more LSEs in base than are common between
4984 * base and flow then pop the topmost one. */
4988 /* If all the LSEs are to be popped and this is not the outermost
4989 * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
4990 * POP_MPLS action instead of flow->dl_type.
4992 * This is because the POP_MPLS action requires its ethertype
4993 * argument to be an MPLS ethernet type but in this case
4994 * flow->dl_type will be a non-MPLS ethernet type.
4996 * When the final POP_MPLS action occurs it use flow->dl_type and
4997 * the and the resulting packet will have the desired dl_type. */
4998 if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
4999 dl_type = htons(ETH_TYPE_MPLS);
5001 dl_type = flow->dl_type;
5003 nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
5004 popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
5010 /* If, after the above popping and setting, there are more LSEs in flow
5011 * than base then some LSEs need to be pushed. */
5012 while (base_n < flow_n) {
5013 struct ovs_action_push_mpls *mpls;
5015 mpls = nl_msg_put_unspec_zero(odp_actions,
5016 OVS_ACTION_ATTR_PUSH_MPLS,
5018 mpls->mpls_ethertype = flow->dl_type;
5019 mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
5020 flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
5021 flow_set_mpls_lse(base, 0, mpls->mpls_lse);
5027 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
5029 ipv4->ipv4_src = flow->nw_src;
5030 ipv4->ipv4_dst = flow->nw_dst;
5031 ipv4->ipv4_proto = flow->nw_proto;
5032 ipv4->ipv4_tos = flow->nw_tos;
5033 ipv4->ipv4_ttl = flow->nw_ttl;
5034 ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
5038 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
5040 flow->nw_src = ipv4->ipv4_src;
5041 flow->nw_dst = ipv4->ipv4_dst;
5042 flow->nw_proto = ipv4->ipv4_proto;
5043 flow->nw_tos = ipv4->ipv4_tos;
5044 flow->nw_ttl = ipv4->ipv4_ttl;
5045 flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
5049 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
5050 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5053 struct ovs_key_ipv4 key, mask, base;
5055 /* Check that nw_proto and nw_frag remain unchanged. */
5056 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
5057 flow->nw_frag == base_flow->nw_frag);
5059 get_ipv4_key(flow, &key, false);
5060 get_ipv4_key(base_flow, &base, false);
5061 get_ipv4_key(&wc->masks, &mask, true);
5062 mask.ipv4_proto = 0; /* Not writeable. */
5063 mask.ipv4_frag = 0; /* Not writable. */
5065 if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
5067 put_ipv4_key(&base, base_flow, false);
5068 if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
5069 put_ipv4_key(&mask, &wc->masks, true);
5075 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
5077 memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
5078 memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
5079 ipv6->ipv6_label = flow->ipv6_label;
5080 ipv6->ipv6_proto = flow->nw_proto;
5081 ipv6->ipv6_tclass = flow->nw_tos;
5082 ipv6->ipv6_hlimit = flow->nw_ttl;
5083 ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
5087 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
5089 memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
5090 memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
5091 flow->ipv6_label = ipv6->ipv6_label;
5092 flow->nw_proto = ipv6->ipv6_proto;
5093 flow->nw_tos = ipv6->ipv6_tclass;
5094 flow->nw_ttl = ipv6->ipv6_hlimit;
5095 flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
5099 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
5100 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5103 struct ovs_key_ipv6 key, mask, base;
5105 /* Check that nw_proto and nw_frag remain unchanged. */
5106 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
5107 flow->nw_frag == base_flow->nw_frag);
5109 get_ipv6_key(flow, &key, false);
5110 get_ipv6_key(base_flow, &base, false);
5111 get_ipv6_key(&wc->masks, &mask, true);
5112 mask.ipv6_proto = 0; /* Not writeable. */
5113 mask.ipv6_frag = 0; /* Not writable. */
5115 if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
5117 put_ipv6_key(&base, base_flow, false);
5118 if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
5119 put_ipv6_key(&mask, &wc->masks, true);
5125 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
5127 /* ARP key has padding, clear it. */
5128 memset(arp, 0, sizeof *arp);
5130 arp->arp_sip = flow->nw_src;
5131 arp->arp_tip = flow->nw_dst;
5132 arp->arp_op = htons(flow->nw_proto);
5133 arp->arp_sha = flow->arp_sha;
5134 arp->arp_tha = flow->arp_tha;
5138 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
5140 flow->nw_src = arp->arp_sip;
5141 flow->nw_dst = arp->arp_tip;
5142 flow->nw_proto = ntohs(arp->arp_op);
5143 flow->arp_sha = arp->arp_sha;
5144 flow->arp_tha = arp->arp_tha;
5147 static enum slow_path_reason
5148 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
5149 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5151 struct ovs_key_arp key, mask, base;
5153 get_arp_key(flow, &key);
5154 get_arp_key(base_flow, &base);
5155 get_arp_key(&wc->masks, &mask);
5157 if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
5159 put_arp_key(&base, base_flow);
5160 put_arp_key(&mask, &wc->masks);
5167 get_nd_key(const struct flow *flow, struct ovs_key_nd *nd)
5169 memcpy(nd->nd_target, &flow->nd_target, sizeof flow->nd_target);
5170 /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5171 nd->nd_sll = flow->arp_sha;
5172 nd->nd_tll = flow->arp_tha;
5176 put_nd_key(const struct ovs_key_nd *nd, struct flow *flow)
5178 memcpy(&flow->nd_target, nd->nd_target, sizeof flow->nd_target);
5179 /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5180 flow->arp_sha = nd->nd_sll;
5181 flow->arp_tha = nd->nd_tll;
5184 static enum slow_path_reason
5185 commit_set_nd_action(const struct flow *flow, struct flow *base_flow,
5186 struct ofpbuf *odp_actions,
5187 struct flow_wildcards *wc, bool use_masked)
5189 struct ovs_key_nd key, mask, base;
5191 get_nd_key(flow, &key);
5192 get_nd_key(base_flow, &base);
5193 get_nd_key(&wc->masks, &mask);
5195 if (commit(OVS_KEY_ATTR_ND, use_masked, &key, &base, &mask, sizeof key,
5197 put_nd_key(&base, base_flow);
5198 put_nd_key(&mask, &wc->masks);
5205 static enum slow_path_reason
5206 commit_set_nw_action(const struct flow *flow, struct flow *base,
5207 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5210 /* Check if 'flow' really has an L3 header. */
5211 if (!flow->nw_proto) {
5215 switch (ntohs(base->dl_type)) {
5217 commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
5221 commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
5222 return commit_set_nd_action(flow, base, odp_actions, wc, use_masked);
5225 return commit_set_arp_action(flow, base, odp_actions, wc);
5231 /* TCP, UDP, and SCTP keys have the same layout. */
5232 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
5233 sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
5236 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
5238 tp->tcp.tcp_src = flow->tp_src;
5239 tp->tcp.tcp_dst = flow->tp_dst;
5243 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
5245 flow->tp_src = tp->tcp.tcp_src;
5246 flow->tp_dst = tp->tcp.tcp_dst;
5250 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
5251 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5254 enum ovs_key_attr key_type;
5255 union ovs_key_tp key, mask, base;
5257 /* Check if 'flow' really has an L3 header. */
5258 if (!flow->nw_proto) {
5262 if (!is_ip_any(base_flow)) {
5266 if (flow->nw_proto == IPPROTO_TCP) {
5267 key_type = OVS_KEY_ATTR_TCP;
5268 } else if (flow->nw_proto == IPPROTO_UDP) {
5269 key_type = OVS_KEY_ATTR_UDP;
5270 } else if (flow->nw_proto == IPPROTO_SCTP) {
5271 key_type = OVS_KEY_ATTR_SCTP;
5276 get_tp_key(flow, &key);
5277 get_tp_key(base_flow, &base);
5278 get_tp_key(&wc->masks, &mask);
5280 if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
5282 put_tp_key(&base, base_flow);
5283 put_tp_key(&mask, &wc->masks);
5288 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
5289 struct ofpbuf *odp_actions,
5290 struct flow_wildcards *wc,
5293 uint32_t key, mask, base;
5295 key = flow->skb_priority;
5296 base = base_flow->skb_priority;
5297 mask = wc->masks.skb_priority;
5299 if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
5300 sizeof key, odp_actions)) {
5301 base_flow->skb_priority = base;
5302 wc->masks.skb_priority = mask;
5307 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base_flow,
5308 struct ofpbuf *odp_actions,
5309 struct flow_wildcards *wc,
5312 uint32_t key, mask, base;
5314 key = flow->pkt_mark;
5315 base = base_flow->pkt_mark;
5316 mask = wc->masks.pkt_mark;
5318 if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
5319 sizeof key, odp_actions)) {
5320 base_flow->pkt_mark = base;
5321 wc->masks.pkt_mark = mask;
5325 /* If any of the flow key data that ODP actions can modify are different in
5326 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
5327 * key from 'base' into 'flow', and then changes 'base' the same way. Does not
5328 * commit set_tunnel actions. Users should call commit_odp_tunnel_action()
5329 * in addition to this function if needed. Sets fields in 'wc' that are
5330 * used as part of the action.
5332 * Returns a reason to force processing the flow's packets into the userspace
5333 * slow path, if there is one, otherwise 0. */
5334 enum slow_path_reason
5335 commit_odp_actions(const struct flow *flow, struct flow *base,
5336 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5339 enum slow_path_reason slow;
5341 commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
5342 slow = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
5343 commit_set_port_action(flow, base, odp_actions, wc, use_masked);
5344 commit_mpls_action(flow, base, odp_actions);
5345 commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
5346 commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
5347 commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);