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 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
89 * - For an action whose argument has a fixed length, returned that
90 * nonnegative length in bytes.
92 * - For an action with a variable-length argument, returns ATTR_LEN_VARIABLE.
94 * - For an invalid 'type', returns ATTR_LEN_INVALID. */
96 odp_action_len(uint16_t type)
98 if (type > OVS_ACTION_ATTR_MAX) {
102 switch ((enum ovs_action_attr) type) {
103 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
104 case OVS_ACTION_ATTR_TUNNEL_PUSH: return ATTR_LEN_VARIABLE;
105 case OVS_ACTION_ATTR_TUNNEL_POP: return sizeof(uint32_t);
106 case OVS_ACTION_ATTR_USERSPACE: return ATTR_LEN_VARIABLE;
107 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
108 case OVS_ACTION_ATTR_POP_VLAN: return 0;
109 case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
110 case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
111 case OVS_ACTION_ATTR_RECIRC: return sizeof(uint32_t);
112 case OVS_ACTION_ATTR_HASH: return sizeof(struct ovs_action_hash);
113 case OVS_ACTION_ATTR_SET: return ATTR_LEN_VARIABLE;
114 case OVS_ACTION_ATTR_SET_MASKED: return ATTR_LEN_VARIABLE;
115 case OVS_ACTION_ATTR_SAMPLE: return ATTR_LEN_VARIABLE;
116 case OVS_ACTION_ATTR_CT: return ATTR_LEN_VARIABLE;
118 case OVS_ACTION_ATTR_UNSPEC:
119 case __OVS_ACTION_ATTR_MAX:
120 return ATTR_LEN_INVALID;
123 return ATTR_LEN_INVALID;
126 /* Returns a string form of 'attr'. The return value is either a statically
127 * allocated constant string or the 'bufsize'-byte buffer 'namebuf'. 'bufsize'
128 * should be at least OVS_KEY_ATTR_BUFSIZE. */
129 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
131 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
134 case OVS_KEY_ATTR_UNSPEC: return "unspec";
135 case OVS_KEY_ATTR_ENCAP: return "encap";
136 case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
137 case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
138 case OVS_KEY_ATTR_CT_STATE: return "ct_state";
139 case OVS_KEY_ATTR_CT_ZONE: return "ct_zone";
140 case OVS_KEY_ATTR_CT_MARK: return "ct_mark";
141 case OVS_KEY_ATTR_TUNNEL: return "tunnel";
142 case OVS_KEY_ATTR_IN_PORT: return "in_port";
143 case OVS_KEY_ATTR_ETHERNET: return "eth";
144 case OVS_KEY_ATTR_VLAN: return "vlan";
145 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
146 case OVS_KEY_ATTR_IPV4: return "ipv4";
147 case OVS_KEY_ATTR_IPV6: return "ipv6";
148 case OVS_KEY_ATTR_TCP: return "tcp";
149 case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
150 case OVS_KEY_ATTR_UDP: return "udp";
151 case OVS_KEY_ATTR_SCTP: return "sctp";
152 case OVS_KEY_ATTR_ICMP: return "icmp";
153 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
154 case OVS_KEY_ATTR_ARP: return "arp";
155 case OVS_KEY_ATTR_ND: return "nd";
156 case OVS_KEY_ATTR_MPLS: return "mpls";
157 case OVS_KEY_ATTR_DP_HASH: return "dp_hash";
158 case OVS_KEY_ATTR_RECIRC_ID: return "recirc_id";
160 case __OVS_KEY_ATTR_MAX:
162 snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
168 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
170 size_t len = nl_attr_get_size(a);
172 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
174 const uint8_t *unspec;
177 unspec = nl_attr_get(a);
178 for (i = 0; i < len; i++) {
179 ds_put_char(ds, i ? ' ': '(');
180 ds_put_format(ds, "%02x", unspec[i]);
182 ds_put_char(ds, ')');
187 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
189 static const struct nl_policy ovs_sample_policy[] = {
190 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
191 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
193 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
195 const struct nlattr *nla_acts;
198 ds_put_cstr(ds, "sample");
200 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
201 ds_put_cstr(ds, "(error)");
205 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
208 ds_put_format(ds, "(sample=%.1f%%,", percentage);
210 ds_put_cstr(ds, "actions(");
211 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
212 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
213 format_odp_actions(ds, nla_acts, len);
214 ds_put_format(ds, "))");
218 slow_path_reason_to_string(uint32_t reason)
220 switch ((enum slow_path_reason) reason) {
221 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
230 slow_path_reason_to_explanation(enum slow_path_reason reason)
233 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
242 parse_odp_flags(const char *s, const char *(*bit_to_string)(uint32_t),
243 uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask)
245 return parse_flags(s, bit_to_string, ')', NULL, NULL,
246 res_flags, allowed, res_mask);
250 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
252 static const struct nl_policy ovs_userspace_policy[] = {
253 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
254 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_UNSPEC,
256 [OVS_USERSPACE_ATTR_EGRESS_TUN_PORT] = { .type = NL_A_U32,
258 [OVS_USERSPACE_ATTR_ACTIONS] = { .type = NL_A_UNSPEC,
261 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
262 const struct nlattr *userdata_attr;
263 const struct nlattr *tunnel_out_port_attr;
265 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
266 ds_put_cstr(ds, "userspace(error)");
270 ds_put_format(ds, "userspace(pid=%"PRIu32,
271 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
273 userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
276 const uint8_t *userdata = nl_attr_get(userdata_attr);
277 size_t userdata_len = nl_attr_get_size(userdata_attr);
278 bool userdata_unspec = true;
279 union user_action_cookie cookie;
281 if (userdata_len >= sizeof cookie.type
282 && userdata_len <= sizeof cookie) {
284 memset(&cookie, 0, sizeof cookie);
285 memcpy(&cookie, userdata, userdata_len);
287 userdata_unspec = false;
289 if (userdata_len == sizeof cookie.sflow
290 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
291 ds_put_format(ds, ",sFlow("
292 "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
293 vlan_tci_to_vid(cookie.sflow.vlan_tci),
294 vlan_tci_to_pcp(cookie.sflow.vlan_tci),
295 cookie.sflow.output);
296 } else if (userdata_len == sizeof cookie.slow_path
297 && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
298 ds_put_cstr(ds, ",slow_path(");
299 format_flags(ds, slow_path_reason_to_string,
300 cookie.slow_path.reason, ',');
301 ds_put_format(ds, ")");
302 } else if (userdata_len == sizeof cookie.flow_sample
303 && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
304 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
305 ",collector_set_id=%"PRIu32
306 ",obs_domain_id=%"PRIu32
307 ",obs_point_id=%"PRIu32")",
308 cookie.flow_sample.probability,
309 cookie.flow_sample.collector_set_id,
310 cookie.flow_sample.obs_domain_id,
311 cookie.flow_sample.obs_point_id);
312 } else if (userdata_len >= sizeof cookie.ipfix
313 && cookie.type == USER_ACTION_COOKIE_IPFIX) {
314 ds_put_format(ds, ",ipfix(output_port=%"PRIu32")",
315 cookie.ipfix.output_odp_port);
317 userdata_unspec = true;
321 if (userdata_unspec) {
323 ds_put_format(ds, ",userdata(");
324 for (i = 0; i < userdata_len; i++) {
325 ds_put_format(ds, "%02x", userdata[i]);
327 ds_put_char(ds, ')');
331 if (a[OVS_USERSPACE_ATTR_ACTIONS]) {
332 ds_put_cstr(ds, ",actions");
335 tunnel_out_port_attr = a[OVS_USERSPACE_ATTR_EGRESS_TUN_PORT];
336 if (tunnel_out_port_attr) {
337 ds_put_format(ds, ",tunnel_out_port=%"PRIu32,
338 nl_attr_get_u32(tunnel_out_port_attr));
341 ds_put_char(ds, ')');
345 format_vlan_tci(struct ds *ds, ovs_be16 tci, ovs_be16 mask, bool verbose)
347 if (verbose || vlan_tci_to_vid(tci) || vlan_tci_to_vid(mask)) {
348 ds_put_format(ds, "vid=%"PRIu16, vlan_tci_to_vid(tci));
349 if (vlan_tci_to_vid(mask) != VLAN_VID_MASK) { /* Partially masked. */
350 ds_put_format(ds, "/0x%"PRIx16, vlan_tci_to_vid(mask));
352 ds_put_char(ds, ',');
354 if (verbose || vlan_tci_to_pcp(tci) || vlan_tci_to_pcp(mask)) {
355 ds_put_format(ds, "pcp=%d", vlan_tci_to_pcp(tci));
356 if (vlan_tci_to_pcp(mask) != (VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
357 ds_put_format(ds, "/0x%x", vlan_tci_to_pcp(mask));
359 ds_put_char(ds, ',');
361 if (!(tci & htons(VLAN_CFI))) {
362 ds_put_cstr(ds, "cfi=0");
363 ds_put_char(ds, ',');
369 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
371 ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
372 mpls_lse_to_label(mpls_lse),
373 mpls_lse_to_tc(mpls_lse),
374 mpls_lse_to_ttl(mpls_lse),
375 mpls_lse_to_bos(mpls_lse));
379 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
380 const struct ovs_key_mpls *mpls_mask, int n)
383 ovs_be32 key = mpls_key->mpls_lse;
385 if (mpls_mask == NULL) {
386 format_mpls_lse(ds, key);
388 ovs_be32 mask = mpls_mask->mpls_lse;
390 ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
391 mpls_lse_to_label(key), mpls_lse_to_label(mask),
392 mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
393 mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
394 mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
399 for (i = 0; i < n; i++) {
400 ds_put_format(ds, "lse%d=%#"PRIx32,
401 i, ntohl(mpls_key[i].mpls_lse));
403 ds_put_format(ds, "/%#"PRIx32, ntohl(mpls_mask[i].mpls_lse));
405 ds_put_char(ds, ',');
412 format_odp_recirc_action(struct ds *ds, uint32_t recirc_id)
414 ds_put_format(ds, "recirc(%#"PRIx32")", recirc_id);
418 format_odp_hash_action(struct ds *ds, const struct ovs_action_hash *hash_act)
420 ds_put_format(ds, "hash(");
422 if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
423 ds_put_format(ds, "hash_l4(%"PRIu32")", hash_act->hash_basis);
425 ds_put_format(ds, "Unknown hash algorithm(%"PRIu32")",
428 ds_put_format(ds, ")");
432 format_udp_tnl_push_header(struct ds *ds, const struct ip_header *ip)
434 const struct udp_header *udp;
436 udp = (const struct udp_header *) (ip + 1);
437 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16",csum=0x%"PRIx16"),",
438 ntohs(udp->udp_src), ntohs(udp->udp_dst),
439 ntohs(udp->udp_csum));
445 format_odp_tnl_push_header(struct ds *ds, struct ovs_action_push_tnl *data)
447 const struct eth_header *eth;
448 const struct ip_header *ip;
451 eth = (const struct eth_header *)data->header;
454 ip = (const struct ip_header *)l3;
457 ds_put_format(ds, "header(size=%"PRIu8",type=%"PRIu8",eth(dst=",
458 data->header_len, data->tnl_type);
459 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_dst));
460 ds_put_format(ds, ",src=");
461 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_src));
462 ds_put_format(ds, ",dl_type=0x%04"PRIx16"),", ntohs(eth->eth_type));
465 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
466 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=0x%"PRIx16"),",
467 IP_ARGS(get_16aligned_be32(&ip->ip_src)),
468 IP_ARGS(get_16aligned_be32(&ip->ip_dst)),
469 ip->ip_proto, ip->ip_tos,
473 if (data->tnl_type == OVS_VPORT_TYPE_VXLAN) {
474 const struct vxlanhdr *vxh;
476 vxh = format_udp_tnl_push_header(ds, ip);
478 ds_put_format(ds, "vxlan(flags=0x%"PRIx32",vni=0x%"PRIx32")",
479 ntohl(get_16aligned_be32(&vxh->vx_flags)),
480 ntohl(get_16aligned_be32(&vxh->vx_vni)) >> 8);
481 } else if (data->tnl_type == OVS_VPORT_TYPE_GENEVE) {
482 const struct genevehdr *gnh;
484 gnh = format_udp_tnl_push_header(ds, ip);
486 ds_put_format(ds, "geneve(%s%svni=0x%"PRIx32,
487 gnh->oam ? "oam," : "",
488 gnh->critical ? "crit," : "",
489 ntohl(get_16aligned_be32(&gnh->vni)) >> 8);
492 ds_put_cstr(ds, ",options(");
493 format_geneve_opts(gnh->options, NULL, gnh->opt_len * 4,
495 ds_put_char(ds, ')');
498 ds_put_char(ds, ')');
499 } else if (data->tnl_type == OVS_VPORT_TYPE_GRE) {
500 const struct gre_base_hdr *greh;
501 ovs_16aligned_be32 *options;
504 l4 = ((uint8_t *)l3 + sizeof(struct ip_header));
505 greh = (const struct gre_base_hdr *) l4;
507 ds_put_format(ds, "gre((flags=0x%"PRIx16",proto=0x%"PRIx16")",
508 ntohs(greh->flags), ntohs(greh->protocol));
509 options = (ovs_16aligned_be32 *)(greh + 1);
510 if (greh->flags & htons(GRE_CSUM)) {
511 ds_put_format(ds, ",csum=0x%"PRIx16, ntohs(*((ovs_be16 *)options)));
514 if (greh->flags & htons(GRE_KEY)) {
515 ds_put_format(ds, ",key=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
518 if (greh->flags & htons(GRE_SEQ)) {
519 ds_put_format(ds, ",seq=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
522 ds_put_format(ds, ")");
524 ds_put_format(ds, ")");
528 format_odp_tnl_push_action(struct ds *ds, const struct nlattr *attr)
530 struct ovs_action_push_tnl *data;
532 data = (struct ovs_action_push_tnl *) nl_attr_get(attr);
534 ds_put_format(ds, "tnl_push(tnl_port(%"PRIu32"),", data->tnl_port);
535 format_odp_tnl_push_header(ds, data);
536 ds_put_format(ds, ",out_port(%"PRIu32"))", data->out_port);
539 static const struct nl_policy ovs_conntrack_policy[] = {
540 [OVS_CT_ATTR_COMMIT] = { .type = NL_A_FLAG, .optional = true, },
541 [OVS_CT_ATTR_ZONE] = { .type = NL_A_U16, .optional = true, },
542 [OVS_CT_ATTR_MARK] = { .type = NL_A_UNSPEC, .optional = true,
543 .min_len = sizeof(uint32_t) * 2 },
547 format_odp_conntrack_action(struct ds *ds, const struct nlattr *attr)
549 struct nlattr *a[ARRAY_SIZE(ovs_conntrack_policy)];
550 const uint32_t *mark;
554 if (!nl_parse_nested(attr, ovs_conntrack_policy, a, ARRAY_SIZE(a))) {
555 ds_put_cstr(ds, "ct(error)");
559 commit = a[OVS_CT_ATTR_COMMIT] ? true : false;
560 zone = a[OVS_CT_ATTR_ZONE] ? nl_attr_get_u16(a[OVS_CT_ATTR_ZONE]) : 0;
561 mark = a[OVS_CT_ATTR_MARK] ? nl_attr_get(a[OVS_CT_ATTR_MARK]) : NULL;
563 ds_put_format(ds, "ct");
564 if (commit || zone || mark) {
565 ds_put_cstr(ds, "(");
567 ds_put_format(ds, "commit,");
570 ds_put_format(ds, "zone=%"PRIu16",", zone);
573 ds_put_format(ds, "mark=%#"PRIx32"/%#"PRIx32",", *mark,
577 ds_put_cstr(ds, ")");
582 format_odp_action(struct ds *ds, const struct nlattr *a)
585 enum ovs_action_attr type = nl_attr_type(a);
586 const struct ovs_action_push_vlan *vlan;
589 expected_len = odp_action_len(nl_attr_type(a));
590 if (expected_len != ATTR_LEN_VARIABLE &&
591 nl_attr_get_size(a) != expected_len) {
592 ds_put_format(ds, "bad length %"PRIuSIZE", expected %d for: ",
593 nl_attr_get_size(a), expected_len);
594 format_generic_odp_action(ds, a);
599 case OVS_ACTION_ATTR_OUTPUT:
600 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
602 case OVS_ACTION_ATTR_TUNNEL_POP:
603 ds_put_format(ds, "tnl_pop(%"PRIu32")", nl_attr_get_u32(a));
605 case OVS_ACTION_ATTR_TUNNEL_PUSH:
606 format_odp_tnl_push_action(ds, a);
608 case OVS_ACTION_ATTR_USERSPACE:
609 format_odp_userspace_action(ds, a);
611 case OVS_ACTION_ATTR_RECIRC:
612 format_odp_recirc_action(ds, nl_attr_get_u32(a));
614 case OVS_ACTION_ATTR_HASH:
615 format_odp_hash_action(ds, nl_attr_get(a));
617 case OVS_ACTION_ATTR_SET_MASKED:
619 size = nl_attr_get_size(a) / 2;
620 ds_put_cstr(ds, "set(");
622 /* Masked set action not supported for tunnel key, which is bigger. */
623 if (size <= sizeof(struct ovs_key_ipv6)) {
624 struct nlattr attr[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
625 sizeof(struct nlattr))];
626 struct nlattr mask[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
627 sizeof(struct nlattr))];
629 mask->nla_type = attr->nla_type = nl_attr_type(a);
630 mask->nla_len = attr->nla_len = NLA_HDRLEN + size;
631 memcpy(attr + 1, (char *)(a + 1), size);
632 memcpy(mask + 1, (char *)(a + 1) + size, size);
633 format_odp_key_attr(attr, mask, NULL, ds, false);
635 format_odp_key_attr(a, NULL, NULL, ds, false);
637 ds_put_cstr(ds, ")");
639 case OVS_ACTION_ATTR_SET:
640 ds_put_cstr(ds, "set(");
641 format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
642 ds_put_cstr(ds, ")");
644 case OVS_ACTION_ATTR_PUSH_VLAN:
645 vlan = nl_attr_get(a);
646 ds_put_cstr(ds, "push_vlan(");
647 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
648 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
650 format_vlan_tci(ds, vlan->vlan_tci, OVS_BE16_MAX, false);
651 ds_put_char(ds, ')');
653 case OVS_ACTION_ATTR_POP_VLAN:
654 ds_put_cstr(ds, "pop_vlan");
656 case OVS_ACTION_ATTR_PUSH_MPLS: {
657 const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
658 ds_put_cstr(ds, "push_mpls(");
659 format_mpls_lse(ds, mpls->mpls_lse);
660 ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
663 case OVS_ACTION_ATTR_POP_MPLS: {
664 ovs_be16 ethertype = nl_attr_get_be16(a);
665 ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
668 case OVS_ACTION_ATTR_SAMPLE:
669 format_odp_sample_action(ds, a);
671 case OVS_ACTION_ATTR_CT:
672 format_odp_conntrack_action(ds, a);
674 case OVS_ACTION_ATTR_UNSPEC:
675 case __OVS_ACTION_ATTR_MAX:
677 format_generic_odp_action(ds, a);
683 format_odp_actions(struct ds *ds, const struct nlattr *actions,
687 const struct nlattr *a;
690 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
692 ds_put_char(ds, ',');
694 format_odp_action(ds, a);
699 if (left == actions_len) {
700 ds_put_cstr(ds, "<empty>");
702 ds_put_format(ds, ",***%u leftover bytes*** (", left);
703 for (i = 0; i < left; i++) {
704 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
706 ds_put_char(ds, ')');
709 ds_put_cstr(ds, "drop");
713 /* Separate out parse_odp_userspace_action() function. */
715 parse_odp_userspace_action(const char *s, struct ofpbuf *actions)
718 union user_action_cookie cookie;
720 odp_port_t tunnel_out_port;
722 void *user_data = NULL;
723 size_t user_data_size = 0;
724 bool include_actions = false;
726 if (!ovs_scan(s, "userspace(pid=%"SCNi32"%n", &pid, &n)) {
732 uint32_t probability;
733 uint32_t collector_set_id;
734 uint32_t obs_domain_id;
735 uint32_t obs_point_id;
738 if (ovs_scan(&s[n], ",sFlow(vid=%i,"
739 "pcp=%i,output=%"SCNi32")%n",
740 &vid, &pcp, &output, &n1)) {
744 tci = vid | (pcp << VLAN_PCP_SHIFT);
749 cookie.type = USER_ACTION_COOKIE_SFLOW;
750 cookie.sflow.vlan_tci = htons(tci);
751 cookie.sflow.output = output;
753 user_data_size = sizeof cookie.sflow;
754 } else if (ovs_scan(&s[n], ",slow_path(%n",
759 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
760 cookie.slow_path.unused = 0;
761 cookie.slow_path.reason = 0;
763 res = parse_odp_flags(&s[n], slow_path_reason_to_string,
764 &cookie.slow_path.reason,
765 SLOW_PATH_REASON_MASK, NULL);
766 if (res < 0 || s[n + res] != ')') {
772 user_data_size = sizeof cookie.slow_path;
773 } else if (ovs_scan(&s[n], ",flow_sample(probability=%"SCNi32","
774 "collector_set_id=%"SCNi32","
775 "obs_domain_id=%"SCNi32","
776 "obs_point_id=%"SCNi32")%n",
777 &probability, &collector_set_id,
778 &obs_domain_id, &obs_point_id, &n1)) {
781 cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
782 cookie.flow_sample.probability = probability;
783 cookie.flow_sample.collector_set_id = collector_set_id;
784 cookie.flow_sample.obs_domain_id = obs_domain_id;
785 cookie.flow_sample.obs_point_id = obs_point_id;
787 user_data_size = sizeof cookie.flow_sample;
788 } else if (ovs_scan(&s[n], ",ipfix(output_port=%"SCNi32")%n",
791 cookie.type = USER_ACTION_COOKIE_IPFIX;
792 cookie.ipfix.output_odp_port = u32_to_odp(output);
794 user_data_size = sizeof cookie.ipfix;
795 } else if (ovs_scan(&s[n], ",userdata(%n",
800 ofpbuf_init(&buf, 16);
801 end = ofpbuf_put_hex(&buf, &s[n], NULL);
805 user_data = buf.data;
806 user_data_size = buf.size;
813 if (ovs_scan(&s[n], ",actions%n", &n1)) {
815 include_actions = true;
821 if (ovs_scan(&s[n], ",tunnel_out_port=%"SCNi32")%n",
822 &tunnel_out_port, &n1)) {
823 odp_put_userspace_action(pid, user_data, user_data_size,
824 tunnel_out_port, include_actions, actions);
826 } else if (s[n] == ')') {
827 odp_put_userspace_action(pid, user_data, user_data_size,
828 ODPP_NONE, include_actions, actions);
837 ovs_parse_tnl_push(const char *s, struct ovs_action_push_tnl *data)
839 struct eth_header *eth;
840 struct ip_header *ip;
841 struct udp_header *udp;
842 struct gre_base_hdr *greh;
843 uint16_t gre_proto, gre_flags, dl_type, udp_src, udp_dst, csum;
845 uint32_t tnl_type = 0, header_len = 0;
849 if (!ovs_scan_len(s, &n, "tnl_push(tnl_port(%"SCNi32"),", &data->tnl_port)) {
852 eth = (struct eth_header *) data->header;
853 l3 = (data->header + sizeof *eth);
854 l4 = ((uint8_t *) l3 + sizeof (struct ip_header));
855 ip = (struct ip_header *) l3;
856 if (!ovs_scan_len(s, &n, "header(size=%"SCNi32",type=%"SCNi32","
857 "eth(dst="ETH_ADDR_SCAN_FMT",",
860 ETH_ADDR_SCAN_ARGS(eth->eth_dst))) {
864 if (!ovs_scan_len(s, &n, "src="ETH_ADDR_SCAN_FMT",",
865 ETH_ADDR_SCAN_ARGS(eth->eth_src))) {
868 if (!ovs_scan_len(s, &n, "dl_type=0x%"SCNx16"),", &dl_type)) {
871 eth->eth_type = htons(dl_type);
874 if (!ovs_scan_len(s, &n, "ipv4(src="IP_SCAN_FMT",dst="IP_SCAN_FMT",proto=%"SCNi8
875 ",tos=%"SCNi8",ttl=%"SCNi8",frag=0x%"SCNx16"),",
878 &ip->ip_proto, &ip->ip_tos,
879 &ip->ip_ttl, &ip->ip_frag_off)) {
882 put_16aligned_be32(&ip->ip_src, sip);
883 put_16aligned_be32(&ip->ip_dst, dip);
886 udp = (struct udp_header *) l4;
887 greh = (struct gre_base_hdr *) l4;
888 if (ovs_scan_len(s, &n, "udp(src=%"SCNi16",dst=%"SCNi16",csum=0x%"SCNx16"),",
889 &udp_src, &udp_dst, &csum)) {
890 uint32_t vx_flags, vni;
892 udp->udp_src = htons(udp_src);
893 udp->udp_dst = htons(udp_dst);
895 udp->udp_csum = htons(csum);
897 if (ovs_scan_len(s, &n, "vxlan(flags=0x%"SCNx32",vni=0x%"SCNx32"))",
899 struct vxlanhdr *vxh = (struct vxlanhdr *) (udp + 1);
901 put_16aligned_be32(&vxh->vx_flags, htonl(vx_flags));
902 put_16aligned_be32(&vxh->vx_vni, htonl(vni << 8));
903 tnl_type = OVS_VPORT_TYPE_VXLAN;
904 header_len = sizeof *eth + sizeof *ip +
905 sizeof *udp + sizeof *vxh;
906 } else if (ovs_scan_len(s, &n, "geneve(")) {
907 struct genevehdr *gnh = (struct genevehdr *) (udp + 1);
909 memset(gnh, 0, sizeof *gnh);
910 header_len = sizeof *eth + sizeof *ip +
911 sizeof *udp + sizeof *gnh;
913 if (ovs_scan_len(s, &n, "oam,")) {
916 if (ovs_scan_len(s, &n, "crit,")) {
919 if (!ovs_scan_len(s, &n, "vni=%"SCNi32, &vni)) {
922 if (ovs_scan_len(s, &n, ",options(")) {
923 struct geneve_scan options;
926 memset(&options, 0, sizeof options);
927 len = scan_geneve(s + n, &options, NULL);
932 memcpy(gnh->options, options.d, options.len);
933 gnh->opt_len = options.len / 4;
934 header_len += options.len;
938 if (!ovs_scan_len(s, &n, "))")) {
942 gnh->proto_type = htons(ETH_TYPE_TEB);
943 put_16aligned_be32(&gnh->vni, htonl(vni << 8));
944 tnl_type = OVS_VPORT_TYPE_GENEVE;
948 } else if (ovs_scan_len(s, &n, "gre((flags=0x%"SCNx16",proto=0x%"SCNx16")",
949 &gre_flags, &gre_proto)){
951 tnl_type = OVS_VPORT_TYPE_GRE;
952 greh->flags = htons(gre_flags);
953 greh->protocol = htons(gre_proto);
954 ovs_16aligned_be32 *options = (ovs_16aligned_be32 *) (greh + 1);
956 if (greh->flags & htons(GRE_CSUM)) {
957 if (!ovs_scan_len(s, &n, ",csum=0x%"SCNx16, &csum)) {
961 memset(options, 0, sizeof *options);
962 *((ovs_be16 *)options) = htons(csum);
965 if (greh->flags & htons(GRE_KEY)) {
968 if (!ovs_scan_len(s, &n, ",key=0x%"SCNx32, &key)) {
972 put_16aligned_be32(options, htonl(key));
975 if (greh->flags & htons(GRE_SEQ)) {
978 if (!ovs_scan_len(s, &n, ",seq=0x%"SCNx32, &seq)) {
981 put_16aligned_be32(options, htonl(seq));
985 if (!ovs_scan_len(s, &n, "))")) {
989 header_len = sizeof *eth + sizeof *ip +
990 ((uint8_t *) options - (uint8_t *) greh);
995 /* check tunnel meta data. */
996 if (data->tnl_type != tnl_type) {
999 if (data->header_len != header_len) {
1004 if (!ovs_scan_len(s, &n, ",out_port(%"SCNi32"))", &data->out_port)) {
1012 parse_conntrack_action(const char *s_, struct ofpbuf *actions)
1016 if (ovs_scan(s, "ct")) {
1017 bool commit = false;
1022 } ct_mark = { 0, 0 };
1027 if (ovs_scan(s, "(")) {
1029 end = strchr(s, ')');
1037 s += strspn(s, delimiters);
1038 if (ovs_scan(s, "commit%n", &n)) {
1043 if (ovs_scan(s, "zone=%"SCNu16"%n", &zone, &n)) {
1047 if (ovs_scan(s, "mark=%"SCNx32"%n", &ct_mark.value, &n)) {
1050 if (ovs_scan(s, "/%"SCNx32"%n", &ct_mark.mask, &n)) {
1053 ct_mark.mask = UINT32_MAX;
1063 start = nl_msg_start_nested(actions, OVS_ACTION_ATTR_CT);
1065 nl_msg_put_flag(actions, OVS_CT_ATTR_COMMIT);
1068 nl_msg_put_u16(actions, OVS_CT_ATTR_ZONE, zone);
1071 nl_msg_put_unspec(actions, OVS_CT_ATTR_MARK, &ct_mark,
1074 nl_msg_end_nested(actions, start);
1081 parse_odp_action(const char *s, const struct simap *port_names,
1082 struct ofpbuf *actions)
1088 if (ovs_scan(s, "%"SCNi32"%n", &port, &n)) {
1089 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
1095 int len = strcspn(s, delimiters);
1096 struct simap_node *node;
1098 node = simap_find_len(port_names, s, len);
1100 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
1109 if (ovs_scan(s, "recirc(%"PRIu32")%n", &recirc_id, &n)) {
1110 nl_msg_put_u32(actions, OVS_ACTION_ATTR_RECIRC, recirc_id);
1115 if (!strncmp(s, "userspace(", 10)) {
1116 return parse_odp_userspace_action(s, actions);
1119 if (!strncmp(s, "set(", 4)) {
1122 struct nlattr mask[128 / sizeof(struct nlattr)];
1123 struct ofpbuf maskbuf;
1124 struct nlattr *nested, *key;
1127 /* 'mask' is big enough to hold any key. */
1128 ofpbuf_use_stack(&maskbuf, mask, sizeof mask);
1130 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
1131 retval = parse_odp_key_mask_attr(s + 4, port_names, actions, &maskbuf);
1135 if (s[retval + 4] != ')') {
1139 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1142 size = nl_attr_get_size(mask);
1143 if (size == nl_attr_get_size(key)) {
1144 /* Change to masked set action if not fully masked. */
1145 if (!is_all_ones(mask + 1, size)) {
1146 key->nla_len += size;
1147 ofpbuf_put(actions, mask + 1, size);
1148 /* 'actions' may have been reallocated by ofpbuf_put(). */
1149 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1150 nested->nla_type = OVS_ACTION_ATTR_SET_MASKED;
1154 nl_msg_end_nested(actions, start_ofs);
1159 struct ovs_action_push_vlan push;
1160 int tpid = ETH_TYPE_VLAN;
1165 if (ovs_scan(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)
1166 || ovs_scan(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
1167 &vid, &pcp, &cfi, &n)
1168 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
1169 &tpid, &vid, &pcp, &n)
1170 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
1171 &tpid, &vid, &pcp, &cfi, &n)) {
1172 push.vlan_tpid = htons(tpid);
1173 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
1174 | (pcp << VLAN_PCP_SHIFT)
1175 | (cfi ? VLAN_CFI : 0));
1176 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
1177 &push, sizeof push);
1183 if (!strncmp(s, "pop_vlan", 8)) {
1184 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
1192 if (ovs_scan(s, "sample(sample=%lf%%,actions(%n", &percentage, &n)
1193 && percentage >= 0. && percentage <= 100.0) {
1194 size_t sample_ofs, actions_ofs;
1197 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
1198 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
1199 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
1200 (probability <= 0 ? 0
1201 : probability >= UINT32_MAX ? UINT32_MAX
1204 actions_ofs = nl_msg_start_nested(actions,
1205 OVS_SAMPLE_ATTR_ACTIONS);
1209 n += strspn(s + n, delimiters);
1214 retval = parse_odp_action(s + n, port_names, actions);
1220 nl_msg_end_nested(actions, actions_ofs);
1221 nl_msg_end_nested(actions, sample_ofs);
1223 return s[n + 1] == ')' ? n + 2 : -EINVAL;
1231 if (ovs_scan(s, "tnl_pop(%"SCNi32")%n", &port, &n)) {
1232 nl_msg_put_u32(actions, OVS_ACTION_ATTR_TUNNEL_POP, port);
1240 retval = parse_conntrack_action(s, actions);
1247 struct ovs_action_push_tnl data;
1250 n = ovs_parse_tnl_push(s, &data);
1252 odp_put_tnl_push_action(actions, &data);
1261 /* Parses the string representation of datapath actions, in the format output
1262 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
1263 * value. On success, the ODP actions are appended to 'actions' as a series of
1264 * Netlink attributes. On failure, no data is appended to 'actions'. Either
1265 * way, 'actions''s data might be reallocated. */
1267 odp_actions_from_string(const char *s, const struct simap *port_names,
1268 struct ofpbuf *actions)
1272 if (!strcasecmp(s, "drop")) {
1276 old_size = actions->size;
1280 s += strspn(s, delimiters);
1285 retval = parse_odp_action(s, port_names, actions);
1286 if (retval < 0 || !strchr(delimiters, s[retval])) {
1287 actions->size = old_size;
1296 static const struct attr_len_tbl ovs_vxlan_ext_attr_lens[OVS_VXLAN_EXT_MAX + 1] = {
1297 [OVS_VXLAN_EXT_GBP] = { .len = 4 },
1300 static const struct attr_len_tbl ovs_tun_key_attr_lens[OVS_TUNNEL_KEY_ATTR_MAX + 1] = {
1301 [OVS_TUNNEL_KEY_ATTR_ID] = { .len = 8 },
1302 [OVS_TUNNEL_KEY_ATTR_IPV4_SRC] = { .len = 4 },
1303 [OVS_TUNNEL_KEY_ATTR_IPV4_DST] = { .len = 4 },
1304 [OVS_TUNNEL_KEY_ATTR_TOS] = { .len = 1 },
1305 [OVS_TUNNEL_KEY_ATTR_TTL] = { .len = 1 },
1306 [OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT] = { .len = 0 },
1307 [OVS_TUNNEL_KEY_ATTR_CSUM] = { .len = 0 },
1308 [OVS_TUNNEL_KEY_ATTR_TP_SRC] = { .len = 2 },
1309 [OVS_TUNNEL_KEY_ATTR_TP_DST] = { .len = 2 },
1310 [OVS_TUNNEL_KEY_ATTR_OAM] = { .len = 0 },
1311 [OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS] = { .len = ATTR_LEN_VARIABLE },
1312 [OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS] = { .len = ATTR_LEN_NESTED,
1313 .next = ovs_vxlan_ext_attr_lens ,
1314 .next_max = OVS_VXLAN_EXT_MAX},
1317 static const struct attr_len_tbl ovs_flow_key_attr_lens[OVS_KEY_ATTR_MAX + 1] = {
1318 [OVS_KEY_ATTR_ENCAP] = { .len = ATTR_LEN_NESTED },
1319 [OVS_KEY_ATTR_PRIORITY] = { .len = 4 },
1320 [OVS_KEY_ATTR_SKB_MARK] = { .len = 4 },
1321 [OVS_KEY_ATTR_DP_HASH] = { .len = 4 },
1322 [OVS_KEY_ATTR_RECIRC_ID] = { .len = 4 },
1323 [OVS_KEY_ATTR_TUNNEL] = { .len = ATTR_LEN_NESTED,
1324 .next = ovs_tun_key_attr_lens,
1325 .next_max = OVS_TUNNEL_KEY_ATTR_MAX },
1326 [OVS_KEY_ATTR_IN_PORT] = { .len = 4 },
1327 [OVS_KEY_ATTR_ETHERNET] = { .len = sizeof(struct ovs_key_ethernet) },
1328 [OVS_KEY_ATTR_VLAN] = { .len = 2 },
1329 [OVS_KEY_ATTR_ETHERTYPE] = { .len = 2 },
1330 [OVS_KEY_ATTR_MPLS] = { .len = ATTR_LEN_VARIABLE },
1331 [OVS_KEY_ATTR_IPV4] = { .len = sizeof(struct ovs_key_ipv4) },
1332 [OVS_KEY_ATTR_IPV6] = { .len = sizeof(struct ovs_key_ipv6) },
1333 [OVS_KEY_ATTR_TCP] = { .len = sizeof(struct ovs_key_tcp) },
1334 [OVS_KEY_ATTR_TCP_FLAGS] = { .len = 2 },
1335 [OVS_KEY_ATTR_UDP] = { .len = sizeof(struct ovs_key_udp) },
1336 [OVS_KEY_ATTR_SCTP] = { .len = sizeof(struct ovs_key_sctp) },
1337 [OVS_KEY_ATTR_ICMP] = { .len = sizeof(struct ovs_key_icmp) },
1338 [OVS_KEY_ATTR_ICMPV6] = { .len = sizeof(struct ovs_key_icmpv6) },
1339 [OVS_KEY_ATTR_ARP] = { .len = sizeof(struct ovs_key_arp) },
1340 [OVS_KEY_ATTR_ND] = { .len = sizeof(struct ovs_key_nd) },
1341 [OVS_KEY_ATTR_CT_STATE] = { .len = 4 },
1342 [OVS_KEY_ATTR_CT_ZONE] = { .len = 2 },
1343 [OVS_KEY_ATTR_CT_MARK] = { .len = 4 },
1346 /* Returns the correct length of the payload for a flow key attribute of the
1347 * specified 'type', ATTR_LEN_INVALID if 'type' is unknown, ATTR_LEN_VARIABLE
1348 * if the attribute's payload is variable length, or ATTR_LEN_NESTED if the
1349 * payload is a nested type. */
1351 odp_key_attr_len(const struct attr_len_tbl tbl[], int max_len, uint16_t type)
1353 if (type > max_len) {
1354 return ATTR_LEN_INVALID;
1357 return tbl[type].len;
1361 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
1363 size_t len = nl_attr_get_size(a);
1365 const uint8_t *unspec;
1368 unspec = nl_attr_get(a);
1369 for (i = 0; i < len; i++) {
1371 ds_put_char(ds, ' ');
1373 ds_put_format(ds, "%02x", unspec[i]);
1379 ovs_frag_type_to_string(enum ovs_frag_type type)
1382 case OVS_FRAG_TYPE_NONE:
1384 case OVS_FRAG_TYPE_FIRST:
1386 case OVS_FRAG_TYPE_LATER:
1388 case __OVS_FRAG_TYPE_MAX:
1394 static enum odp_key_fitness
1395 odp_tun_key_from_attr__(const struct nlattr *attr,
1396 const struct nlattr *flow_attrs, size_t flow_attr_len,
1397 const struct flow_tnl *src_tun, struct flow_tnl *tun,
1401 const struct nlattr *a;
1403 bool unknown = false;
1405 NL_NESTED_FOR_EACH(a, left, attr) {
1406 uint16_t type = nl_attr_type(a);
1407 size_t len = nl_attr_get_size(a);
1408 int expected_len = odp_key_attr_len(ovs_tun_key_attr_lens,
1409 OVS_TUNNEL_ATTR_MAX, type);
1411 if (len != expected_len && expected_len >= 0) {
1412 return ODP_FIT_ERROR;
1416 case OVS_TUNNEL_KEY_ATTR_ID:
1417 tun->tun_id = nl_attr_get_be64(a);
1418 tun->flags |= FLOW_TNL_F_KEY;
1420 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1421 tun->ip_src = nl_attr_get_be32(a);
1423 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
1424 tun->ip_dst = nl_attr_get_be32(a);
1426 case OVS_TUNNEL_KEY_ATTR_TOS:
1427 tun->ip_tos = nl_attr_get_u8(a);
1429 case OVS_TUNNEL_KEY_ATTR_TTL:
1430 tun->ip_ttl = nl_attr_get_u8(a);
1433 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
1434 tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
1436 case OVS_TUNNEL_KEY_ATTR_CSUM:
1437 tun->flags |= FLOW_TNL_F_CSUM;
1439 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
1440 tun->tp_src = nl_attr_get_be16(a);
1442 case OVS_TUNNEL_KEY_ATTR_TP_DST:
1443 tun->tp_dst = nl_attr_get_be16(a);
1445 case OVS_TUNNEL_KEY_ATTR_OAM:
1446 tun->flags |= FLOW_TNL_F_OAM;
1448 case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS: {
1449 static const struct nl_policy vxlan_opts_policy[] = {
1450 [OVS_VXLAN_EXT_GBP] = { .type = NL_A_U32 },
1452 struct nlattr *ext[ARRAY_SIZE(vxlan_opts_policy)];
1454 if (!nl_parse_nested(a, vxlan_opts_policy, ext, ARRAY_SIZE(ext))) {
1455 return ODP_FIT_ERROR;
1458 if (ext[OVS_VXLAN_EXT_GBP]) {
1459 uint32_t gbp = nl_attr_get_u32(ext[OVS_VXLAN_EXT_GBP]);
1461 tun->gbp_id = htons(gbp & 0xFFFF);
1462 tun->gbp_flags = (gbp >> 16) & 0xFF;
1467 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
1468 if (tun_metadata_from_geneve_nlattr(a, flow_attrs, flow_attr_len,
1469 src_tun, udpif, tun)) {
1470 return ODP_FIT_ERROR;
1475 /* Allow this to show up as unexpected, if there are unknown
1476 * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
1483 return ODP_FIT_ERROR;
1486 return ODP_FIT_TOO_MUCH;
1488 return ODP_FIT_PERFECT;
1491 enum odp_key_fitness
1492 odp_tun_key_from_attr(const struct nlattr *attr, bool udpif,
1493 struct flow_tnl *tun)
1495 memset(tun, 0, sizeof *tun);
1496 return odp_tun_key_from_attr__(attr, NULL, 0, NULL, tun, udpif);
1500 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key,
1501 const struct flow_tnl *tun_flow_key,
1502 const struct ofpbuf *key_buf)
1506 tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
1508 /* tun_id != 0 without FLOW_TNL_F_KEY is valid if tun_key is a mask. */
1509 if (tun_key->tun_id || tun_key->flags & FLOW_TNL_F_KEY) {
1510 nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
1512 if (tun_key->ip_src) {
1513 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
1515 if (tun_key->ip_dst) {
1516 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
1518 if (tun_key->ip_tos) {
1519 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
1521 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
1522 if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
1523 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
1525 if (tun_key->flags & FLOW_TNL_F_CSUM) {
1526 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
1528 if (tun_key->tp_src) {
1529 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src);
1531 if (tun_key->tp_dst) {
1532 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst);
1534 if (tun_key->flags & FLOW_TNL_F_OAM) {
1535 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
1537 if (tun_key->gbp_flags || tun_key->gbp_id) {
1538 size_t vxlan_opts_ofs;
1540 vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
1541 nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP,
1542 (tun_key->gbp_flags << 16) | ntohs(tun_key->gbp_id));
1543 nl_msg_end_nested(a, vxlan_opts_ofs);
1545 tun_metadata_to_geneve_nlattr(tun_key, tun_flow_key, key_buf, a);
1547 nl_msg_end_nested(a, tun_key_ofs);
1551 odp_mask_attr_is_wildcard(const struct nlattr *ma)
1553 return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
1557 odp_mask_is_exact(enum ovs_key_attr attr, const void *mask, size_t size)
1559 if (attr == OVS_KEY_ATTR_TCP_FLAGS) {
1560 return TCP_FLAGS(*(ovs_be16 *)mask) == TCP_FLAGS(OVS_BE16_MAX);
1562 if (attr == OVS_KEY_ATTR_IPV6) {
1563 const struct ovs_key_ipv6 *ipv6_mask = mask;
1566 ((ipv6_mask->ipv6_label & htonl(IPV6_LABEL_MASK))
1567 == htonl(IPV6_LABEL_MASK))
1568 && ipv6_mask->ipv6_proto == UINT8_MAX
1569 && ipv6_mask->ipv6_tclass == UINT8_MAX
1570 && ipv6_mask->ipv6_hlimit == UINT8_MAX
1571 && ipv6_mask->ipv6_frag == UINT8_MAX
1572 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_src)
1573 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_dst);
1575 if (attr == OVS_KEY_ATTR_TUNNEL) {
1579 if (attr == OVS_KEY_ATTR_ARP) {
1580 /* ARP key has padding, ignore it. */
1581 BUILD_ASSERT_DECL(sizeof(struct ovs_key_arp) == 24);
1582 BUILD_ASSERT_DECL(offsetof(struct ovs_key_arp, arp_tha) == 10 + 6);
1583 size = offsetof(struct ovs_key_arp, arp_tha) + ETH_ADDR_LEN;
1584 ovs_assert(((uint16_t *)mask)[size/2] == 0);
1587 return is_all_ones(mask, size);
1591 odp_mask_attr_is_exact(const struct nlattr *ma)
1593 enum ovs_key_attr attr = nl_attr_type(ma);
1597 if (attr == OVS_KEY_ATTR_TUNNEL) {
1600 mask = nl_attr_get(ma);
1601 size = nl_attr_get_size(ma);
1604 return odp_mask_is_exact(attr, mask, size);
1608 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
1611 struct odp_portno_names *odp_portno_names;
1613 odp_portno_names = xmalloc(sizeof *odp_portno_names);
1614 odp_portno_names->port_no = port_no;
1615 odp_portno_names->name = xstrdup(port_name);
1616 hmap_insert(portno_names, &odp_portno_names->hmap_node,
1617 hash_odp_port(port_no));
1621 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
1623 struct odp_portno_names *odp_portno_names;
1625 HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
1626 hash_odp_port(port_no), portno_names) {
1627 if (odp_portno_names->port_no == port_no) {
1628 return odp_portno_names->name;
1635 odp_portno_names_destroy(struct hmap *portno_names)
1637 struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
1638 HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
1639 hmap_node, portno_names) {
1640 hmap_remove(portno_names, &odp_portno_names->hmap_node);
1641 free(odp_portno_names->name);
1642 free(odp_portno_names);
1646 /* Format helpers. */
1649 format_eth(struct ds *ds, const char *name, const struct eth_addr key,
1650 const struct eth_addr *mask, bool verbose)
1652 bool mask_empty = mask && eth_addr_is_zero(*mask);
1654 if (verbose || !mask_empty) {
1655 bool mask_full = !mask || eth_mask_is_exact(*mask);
1658 ds_put_format(ds, "%s="ETH_ADDR_FMT",", name, ETH_ADDR_ARGS(key));
1660 ds_put_format(ds, "%s=", name);
1661 eth_format_masked(key, mask, ds);
1662 ds_put_char(ds, ',');
1668 format_be64(struct ds *ds, const char *name, ovs_be64 key,
1669 const ovs_be64 *mask, bool verbose)
1671 bool mask_empty = mask && !*mask;
1673 if (verbose || !mask_empty) {
1674 bool mask_full = !mask || *mask == OVS_BE64_MAX;
1676 ds_put_format(ds, "%s=0x%"PRIx64, name, ntohll(key));
1677 if (!mask_full) { /* Partially masked. */
1678 ds_put_format(ds, "/%#"PRIx64, ntohll(*mask));
1680 ds_put_char(ds, ',');
1685 format_ipv4(struct ds *ds, const char *name, ovs_be32 key,
1686 const ovs_be32 *mask, bool verbose)
1688 bool mask_empty = mask && !*mask;
1690 if (verbose || !mask_empty) {
1691 bool mask_full = !mask || *mask == OVS_BE32_MAX;
1693 ds_put_format(ds, "%s="IP_FMT, name, IP_ARGS(key));
1694 if (!mask_full) { /* Partially masked. */
1695 ds_put_format(ds, "/"IP_FMT, IP_ARGS(*mask));
1697 ds_put_char(ds, ',');
1702 format_ipv6(struct ds *ds, const char *name, const ovs_be32 key_[4],
1703 const ovs_be32 (*mask_)[4], bool verbose)
1705 char buf[INET6_ADDRSTRLEN];
1706 const struct in6_addr *key = (const struct in6_addr *)key_;
1707 const struct in6_addr *mask = mask_ ? (const struct in6_addr *)*mask_
1709 bool mask_empty = mask && ipv6_mask_is_any(mask);
1711 if (verbose || !mask_empty) {
1712 bool mask_full = !mask || ipv6_mask_is_exact(mask);
1714 inet_ntop(AF_INET6, key, buf, sizeof buf);
1715 ds_put_format(ds, "%s=%s", name, buf);
1716 if (!mask_full) { /* Partially masked. */
1717 inet_ntop(AF_INET6, mask, buf, sizeof buf);
1718 ds_put_format(ds, "/%s", buf);
1720 ds_put_char(ds, ',');
1725 format_ipv6_label(struct ds *ds, const char *name, ovs_be32 key,
1726 const ovs_be32 *mask, bool verbose)
1728 bool mask_empty = mask && !*mask;
1730 if (verbose || !mask_empty) {
1731 bool mask_full = !mask
1732 || (*mask & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK);
1734 ds_put_format(ds, "%s=%#"PRIx32, name, ntohl(key));
1735 if (!mask_full) { /* Partially masked. */
1736 ds_put_format(ds, "/%#"PRIx32, ntohl(*mask));
1738 ds_put_char(ds, ',');
1743 format_u8x(struct ds *ds, const char *name, uint8_t key,
1744 const uint8_t *mask, bool verbose)
1746 bool mask_empty = mask && !*mask;
1748 if (verbose || !mask_empty) {
1749 bool mask_full = !mask || *mask == UINT8_MAX;
1751 ds_put_format(ds, "%s=%#"PRIx8, name, key);
1752 if (!mask_full) { /* Partially masked. */
1753 ds_put_format(ds, "/%#"PRIx8, *mask);
1755 ds_put_char(ds, ',');
1760 format_u8u(struct ds *ds, const char *name, uint8_t key,
1761 const uint8_t *mask, bool verbose)
1763 bool mask_empty = mask && !*mask;
1765 if (verbose || !mask_empty) {
1766 bool mask_full = !mask || *mask == UINT8_MAX;
1768 ds_put_format(ds, "%s=%"PRIu8, name, key);
1769 if (!mask_full) { /* Partially masked. */
1770 ds_put_format(ds, "/%#"PRIx8, *mask);
1772 ds_put_char(ds, ',');
1777 format_be16(struct ds *ds, const char *name, ovs_be16 key,
1778 const ovs_be16 *mask, bool verbose)
1780 bool mask_empty = mask && !*mask;
1782 if (verbose || !mask_empty) {
1783 bool mask_full = !mask || *mask == OVS_BE16_MAX;
1785 ds_put_format(ds, "%s=%"PRIu16, name, ntohs(key));
1786 if (!mask_full) { /* Partially masked. */
1787 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1789 ds_put_char(ds, ',');
1794 format_be16x(struct ds *ds, const char *name, ovs_be16 key,
1795 const ovs_be16 *mask, bool verbose)
1797 bool mask_empty = mask && !*mask;
1799 if (verbose || !mask_empty) {
1800 bool mask_full = !mask || *mask == OVS_BE16_MAX;
1802 ds_put_format(ds, "%s=%#"PRIx16, name, ntohs(key));
1803 if (!mask_full) { /* Partially masked. */
1804 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1806 ds_put_char(ds, ',');
1811 format_tun_flags(struct ds *ds, const char *name, uint16_t key,
1812 const uint16_t *mask, bool verbose)
1814 bool mask_empty = mask && !*mask;
1816 if (verbose || !mask_empty) {
1817 ds_put_cstr(ds, name);
1818 ds_put_char(ds, '(');
1820 format_flags_masked(ds, NULL, flow_tun_flag_to_string, key,
1821 *mask & FLOW_TNL_F_MASK, FLOW_TNL_F_MASK);
1822 } else { /* Fully masked. */
1823 format_flags(ds, flow_tun_flag_to_string, key, '|');
1825 ds_put_cstr(ds, "),");
1830 check_attr_len(struct ds *ds, const struct nlattr *a, const struct nlattr *ma,
1831 const struct attr_len_tbl tbl[], int max_len, bool need_key)
1835 expected_len = odp_key_attr_len(tbl, max_len, nl_attr_type(a));
1836 if (expected_len != ATTR_LEN_VARIABLE &&
1837 expected_len != ATTR_LEN_NESTED) {
1839 bool bad_key_len = nl_attr_get_size(a) != expected_len;
1840 bool bad_mask_len = ma && nl_attr_get_size(ma) != expected_len;
1842 if (bad_key_len || bad_mask_len) {
1844 ds_put_format(ds, "key%u", nl_attr_type(a));
1847 ds_put_format(ds, "(bad key length %"PRIuSIZE", expected %d)(",
1848 nl_attr_get_size(a), expected_len);
1850 format_generic_odp_key(a, ds);
1852 ds_put_char(ds, '/');
1854 ds_put_format(ds, "(bad mask length %"PRIuSIZE", expected %d)(",
1855 nl_attr_get_size(ma), expected_len);
1857 format_generic_odp_key(ma, ds);
1859 ds_put_char(ds, ')');
1868 format_unknown_key(struct ds *ds, const struct nlattr *a,
1869 const struct nlattr *ma)
1871 ds_put_format(ds, "key%u(", nl_attr_type(a));
1872 format_generic_odp_key(a, ds);
1873 if (ma && !odp_mask_attr_is_exact(ma)) {
1874 ds_put_char(ds, '/');
1875 format_generic_odp_key(ma, ds);
1877 ds_put_cstr(ds, "),");
1881 format_odp_tun_vxlan_opt(const struct nlattr *attr,
1882 const struct nlattr *mask_attr, struct ds *ds,
1886 const struct nlattr *a;
1889 ofpbuf_init(&ofp, 100);
1890 NL_NESTED_FOR_EACH(a, left, attr) {
1891 uint16_t type = nl_attr_type(a);
1892 const struct nlattr *ma = NULL;
1895 ma = nl_attr_find__(nl_attr_get(mask_attr),
1896 nl_attr_get_size(mask_attr), type);
1898 ma = generate_all_wildcard_mask(ovs_vxlan_ext_attr_lens,
1904 if (!check_attr_len(ds, a, ma, ovs_vxlan_ext_attr_lens,
1905 OVS_VXLAN_EXT_MAX, true)) {
1910 case OVS_VXLAN_EXT_GBP: {
1911 uint32_t key = nl_attr_get_u32(a);
1912 ovs_be16 id, id_mask;
1913 uint8_t flags, flags_mask;
1915 id = htons(key & 0xFFFF);
1916 flags = (key >> 16) & 0xFF;
1918 uint32_t mask = nl_attr_get_u32(ma);
1919 id_mask = htons(mask & 0xFFFF);
1920 flags_mask = (mask >> 16) & 0xFF;
1923 ds_put_cstr(ds, "gbp(");
1924 format_be16(ds, "id", id, ma ? &id_mask : NULL, verbose);
1925 format_u8x(ds, "flags", flags, ma ? &flags_mask : NULL, verbose);
1927 ds_put_cstr(ds, "),");
1932 format_unknown_key(ds, a, ma);
1938 ofpbuf_uninit(&ofp);
1941 #define MASK(PTR, FIELD) PTR ? &PTR->FIELD : NULL
1944 format_geneve_opts(const struct geneve_opt *opt,
1945 const struct geneve_opt *mask, int opts_len,
1946 struct ds *ds, bool verbose)
1948 while (opts_len > 0) {
1950 uint8_t data_len, data_len_mask;
1952 if (opts_len < sizeof *opt) {
1953 ds_put_format(ds, "opt len %u less than minimum %"PRIuSIZE,
1954 opts_len, sizeof *opt);
1958 data_len = opt->length * 4;
1960 if (mask->length == 0x1f) {
1961 data_len_mask = UINT8_MAX;
1963 data_len_mask = mask->length;
1966 len = sizeof *opt + data_len;
1967 if (len > opts_len) {
1968 ds_put_format(ds, "opt len %u greater than remaining %u",
1973 ds_put_char(ds, '{');
1974 format_be16x(ds, "class", opt->opt_class, MASK(mask, opt_class),
1976 format_u8x(ds, "type", opt->type, MASK(mask, type), verbose);
1977 format_u8u(ds, "len", data_len, mask ? &data_len_mask : NULL, verbose);
1979 (verbose || !mask || !is_all_zeros(mask + 1, data_len))) {
1980 ds_put_hex(ds, opt + 1, data_len);
1981 if (mask && !is_all_ones(mask + 1, data_len)) {
1982 ds_put_char(ds, '/');
1983 ds_put_hex(ds, mask + 1, data_len);
1988 ds_put_char(ds, '}');
1990 opt += len / sizeof(*opt);
1992 mask += len / sizeof(*opt);
1999 format_odp_tun_geneve(const struct nlattr *attr,
2000 const struct nlattr *mask_attr, struct ds *ds,
2003 int opts_len = nl_attr_get_size(attr);
2004 const struct geneve_opt *opt = nl_attr_get(attr);
2005 const struct geneve_opt *mask = mask_attr ?
2006 nl_attr_get(mask_attr) : NULL;
2008 if (mask && nl_attr_get_size(attr) != nl_attr_get_size(mask_attr)) {
2009 ds_put_format(ds, "value len %"PRIuSIZE" different from mask len %"PRIuSIZE,
2010 nl_attr_get_size(attr), nl_attr_get_size(mask_attr));
2014 format_geneve_opts(opt, mask, opts_len, ds, verbose);
2018 format_odp_tun_attr(const struct nlattr *attr, const struct nlattr *mask_attr,
2019 struct ds *ds, bool verbose)
2022 const struct nlattr *a;
2024 uint16_t mask_flags = 0;
2027 ofpbuf_init(&ofp, 100);
2028 NL_NESTED_FOR_EACH(a, left, attr) {
2029 enum ovs_tunnel_key_attr type = nl_attr_type(a);
2030 const struct nlattr *ma = NULL;
2033 ma = nl_attr_find__(nl_attr_get(mask_attr),
2034 nl_attr_get_size(mask_attr), type);
2036 ma = generate_all_wildcard_mask(ovs_tun_key_attr_lens,
2037 OVS_TUNNEL_KEY_ATTR_MAX,
2042 if (!check_attr_len(ds, a, ma, ovs_tun_key_attr_lens,
2043 OVS_TUNNEL_KEY_ATTR_MAX, true)) {
2048 case OVS_TUNNEL_KEY_ATTR_ID:
2049 format_be64(ds, "tun_id", nl_attr_get_be64(a),
2050 ma ? nl_attr_get(ma) : NULL, verbose);
2051 flags |= FLOW_TNL_F_KEY;
2053 mask_flags |= FLOW_TNL_F_KEY;
2056 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
2057 format_ipv4(ds, "src", nl_attr_get_be32(a),
2058 ma ? nl_attr_get(ma) : NULL, verbose);
2060 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
2061 format_ipv4(ds, "dst", nl_attr_get_be32(a),
2062 ma ? nl_attr_get(ma) : NULL, verbose);
2064 case OVS_TUNNEL_KEY_ATTR_TOS:
2065 format_u8x(ds, "tos", nl_attr_get_u8(a),
2066 ma ? nl_attr_get(ma) : NULL, verbose);
2068 case OVS_TUNNEL_KEY_ATTR_TTL:
2069 format_u8u(ds, "ttl", nl_attr_get_u8(a),
2070 ma ? nl_attr_get(ma) : NULL, verbose);
2072 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2073 flags |= FLOW_TNL_F_DONT_FRAGMENT;
2075 case OVS_TUNNEL_KEY_ATTR_CSUM:
2076 flags |= FLOW_TNL_F_CSUM;
2078 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
2079 format_be16(ds, "tp_src", nl_attr_get_be16(a),
2080 ma ? nl_attr_get(ma) : NULL, verbose);
2082 case OVS_TUNNEL_KEY_ATTR_TP_DST:
2083 format_be16(ds, "tp_dst", nl_attr_get_be16(a),
2084 ma ? nl_attr_get(ma) : NULL, verbose);
2086 case OVS_TUNNEL_KEY_ATTR_OAM:
2087 flags |= FLOW_TNL_F_OAM;
2089 case OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS:
2090 ds_put_cstr(ds, "vxlan(");
2091 format_odp_tun_vxlan_opt(a, ma, ds, verbose);
2092 ds_put_cstr(ds, "),");
2094 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS:
2095 ds_put_cstr(ds, "geneve(");
2096 format_odp_tun_geneve(a, ma, ds, verbose);
2097 ds_put_cstr(ds, "),");
2099 case __OVS_TUNNEL_KEY_ATTR_MAX:
2101 format_unknown_key(ds, a, ma);
2106 /* Flags can have a valid mask even if the attribute is not set, so
2107 * we need to collect these separately. */
2109 NL_NESTED_FOR_EACH(a, left, mask_attr) {
2110 switch (nl_attr_type(a)) {
2111 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
2112 mask_flags |= FLOW_TNL_F_DONT_FRAGMENT;
2114 case OVS_TUNNEL_KEY_ATTR_CSUM:
2115 mask_flags |= FLOW_TNL_F_CSUM;
2117 case OVS_TUNNEL_KEY_ATTR_OAM:
2118 mask_flags |= FLOW_TNL_F_OAM;
2124 format_tun_flags(ds, "flags", flags, mask_attr ? &mask_flags : NULL,
2127 ofpbuf_uninit(&ofp);
2131 odp_ct_state_to_string(uint32_t flag)
2134 case OVS_CS_F_REPLY_DIR:
2136 case OVS_CS_F_TRACKED:
2140 case OVS_CS_F_ESTABLISHED:
2142 case OVS_CS_F_RELATED:
2144 case OVS_CS_F_INVALID:
2152 format_frag(struct ds *ds, const char *name, uint8_t key,
2153 const uint8_t *mask, bool verbose)
2155 bool mask_empty = mask && !*mask;
2157 /* ODP frag is an enumeration field; partial masks are not meaningful. */
2158 if (verbose || !mask_empty) {
2159 bool mask_full = !mask || *mask == UINT8_MAX;
2161 if (!mask_full) { /* Partially masked. */
2162 ds_put_format(ds, "error: partial mask not supported for frag (%#"
2165 ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
2171 mask_empty(const struct nlattr *ma)
2179 mask = nl_attr_get(ma);
2180 n = nl_attr_get_size(ma);
2182 return is_all_zeros(mask, n);
2186 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
2187 const struct hmap *portno_names, struct ds *ds,
2190 enum ovs_key_attr attr = nl_attr_type(a);
2191 char namebuf[OVS_KEY_ATTR_BUFSIZE];
2194 is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
2196 ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
2198 if (!check_attr_len(ds, a, ma, ovs_flow_key_attr_lens,
2199 OVS_KEY_ATTR_MAX, false)) {
2203 ds_put_char(ds, '(');
2205 case OVS_KEY_ATTR_ENCAP:
2206 if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
2207 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
2208 nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
2210 } else if (nl_attr_get_size(a)) {
2211 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
2216 case OVS_KEY_ATTR_PRIORITY:
2217 case OVS_KEY_ATTR_SKB_MARK:
2218 case OVS_KEY_ATTR_DP_HASH:
2219 case OVS_KEY_ATTR_RECIRC_ID:
2220 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2222 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2226 case OVS_KEY_ATTR_CT_MARK:
2227 if (verbose || !mask_empty(ma)) {
2228 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2230 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2235 case OVS_KEY_ATTR_CT_STATE:
2237 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
2239 ds_put_format(ds, "/%#"PRIx32,
2240 mask_empty(ma) ? 0 : nl_attr_get_u32(ma));
2242 } else if (!is_exact) {
2243 format_flags_masked(ds, NULL, odp_ct_state_to_string,
2245 mask_empty(ma) ? 0 : nl_attr_get_u32(ma),
2248 format_flags(ds, odp_ct_state_to_string, nl_attr_get_u32(a), '|');
2252 case OVS_KEY_ATTR_CT_ZONE:
2253 if (verbose || !mask_empty(ma)) {
2254 ds_put_format(ds, "%#"PRIx16, nl_attr_get_u16(a));
2256 ds_put_format(ds, "/%#"PRIx16, nl_attr_get_u16(ma));
2262 case OVS_KEY_ATTR_TUNNEL:
2263 format_odp_tun_attr(a, ma, ds, verbose);
2266 case OVS_KEY_ATTR_IN_PORT:
2267 if (portno_names && verbose && is_exact) {
2268 char *name = odp_portno_names_get(portno_names,
2269 u32_to_odp(nl_attr_get_u32(a)));
2271 ds_put_format(ds, "%s", name);
2273 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2276 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
2278 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
2283 case OVS_KEY_ATTR_ETHERNET: {
2284 const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
2285 const struct ovs_key_ethernet *key = nl_attr_get(a);
2287 format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
2288 format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
2292 case OVS_KEY_ATTR_VLAN:
2293 format_vlan_tci(ds, nl_attr_get_be16(a),
2294 ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
2297 case OVS_KEY_ATTR_MPLS: {
2298 const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
2299 const struct ovs_key_mpls *mpls_mask = NULL;
2300 size_t size = nl_attr_get_size(a);
2302 if (!size || size % sizeof *mpls_key) {
2303 ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
2307 mpls_mask = nl_attr_get(ma);
2308 if (size != nl_attr_get_size(ma)) {
2309 ds_put_format(ds, "(key length %"PRIuSIZE" != "
2310 "mask length %"PRIuSIZE")",
2311 size, nl_attr_get_size(ma));
2315 format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
2318 case OVS_KEY_ATTR_ETHERTYPE:
2319 ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
2321 ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
2325 case OVS_KEY_ATTR_IPV4: {
2326 const struct ovs_key_ipv4 *key = nl_attr_get(a);
2327 const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
2329 format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
2330 format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
2331 format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
2333 format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
2334 format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
2335 format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
2340 case OVS_KEY_ATTR_IPV6: {
2341 const struct ovs_key_ipv6 *key = nl_attr_get(a);
2342 const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
2344 format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
2345 format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
2346 format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
2348 format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
2350 format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
2352 format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
2354 format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
2359 /* These have the same structure and format. */
2360 case OVS_KEY_ATTR_TCP:
2361 case OVS_KEY_ATTR_UDP:
2362 case OVS_KEY_ATTR_SCTP: {
2363 const struct ovs_key_tcp *key = nl_attr_get(a);
2364 const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
2366 format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
2367 format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
2371 case OVS_KEY_ATTR_TCP_FLAGS:
2373 format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
2374 ntohs(nl_attr_get_be16(a)),
2375 TCP_FLAGS(nl_attr_get_be16(ma)),
2376 TCP_FLAGS(OVS_BE16_MAX));
2378 format_flags(ds, packet_tcp_flag_to_string,
2379 ntohs(nl_attr_get_be16(a)), '|');
2383 case OVS_KEY_ATTR_ICMP: {
2384 const struct ovs_key_icmp *key = nl_attr_get(a);
2385 const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
2387 format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
2388 format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
2392 case OVS_KEY_ATTR_ICMPV6: {
2393 const struct ovs_key_icmpv6 *key = nl_attr_get(a);
2394 const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
2396 format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
2398 format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
2403 case OVS_KEY_ATTR_ARP: {
2404 const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
2405 const struct ovs_key_arp *key = nl_attr_get(a);
2407 format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
2408 format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
2409 format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
2410 format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
2411 format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
2415 case OVS_KEY_ATTR_ND: {
2416 const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
2417 const struct ovs_key_nd *key = nl_attr_get(a);
2419 format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
2421 format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
2422 format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
2427 case OVS_KEY_ATTR_UNSPEC:
2428 case __OVS_KEY_ATTR_MAX:
2430 format_generic_odp_key(a, ds);
2432 ds_put_char(ds, '/');
2433 format_generic_odp_key(ma, ds);
2437 ds_put_char(ds, ')');
2440 static struct nlattr *
2441 generate_all_wildcard_mask(const struct attr_len_tbl tbl[], int max,
2442 struct ofpbuf *ofp, const struct nlattr *key)
2444 const struct nlattr *a;
2446 int type = nl_attr_type(key);
2447 int size = nl_attr_get_size(key);
2449 if (odp_key_attr_len(tbl, max, type) != ATTR_LEN_NESTED) {
2450 nl_msg_put_unspec_zero(ofp, type, size);
2454 if (tbl[type].next) {
2455 tbl = tbl[type].next;
2456 max = tbl[type].next_max;
2459 nested_mask = nl_msg_start_nested(ofp, type);
2460 NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
2461 generate_all_wildcard_mask(tbl, max, ofp, nl_attr_get(a));
2463 nl_msg_end_nested(ofp, nested_mask);
2470 odp_ufid_from_string(const char *s_, ovs_u128 *ufid)
2474 if (ovs_scan(s, "ufid:")) {
2477 if (!uuid_from_string_prefix((struct uuid *)ufid, s)) {
2489 odp_format_ufid(const ovs_u128 *ufid, struct ds *ds)
2491 ds_put_format(ds, "ufid:"UUID_FMT, UUID_ARGS((struct uuid *)ufid));
2494 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2495 * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
2496 * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
2497 * non-null and 'verbose' is true, translates odp port number to its name. */
2499 odp_flow_format(const struct nlattr *key, size_t key_len,
2500 const struct nlattr *mask, size_t mask_len,
2501 const struct hmap *portno_names, struct ds *ds, bool verbose)
2504 const struct nlattr *a;
2506 bool has_ethtype_key = false;
2507 const struct nlattr *ma = NULL;
2509 bool first_field = true;
2511 ofpbuf_init(&ofp, 100);
2512 NL_ATTR_FOR_EACH (a, left, key, key_len) {
2513 bool is_nested_attr;
2514 bool is_wildcard = false;
2515 int attr_type = nl_attr_type(a);
2517 if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
2518 has_ethtype_key = true;
2521 is_nested_attr = odp_key_attr_len(ovs_flow_key_attr_lens,
2522 OVS_KEY_ATTR_MAX, attr_type) ==
2525 if (mask && mask_len) {
2526 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
2527 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
2530 if (verbose || !is_wildcard || is_nested_attr) {
2531 if (is_wildcard && !ma) {
2532 ma = generate_all_wildcard_mask(ovs_flow_key_attr_lens,
2537 ds_put_char(ds, ',');
2539 format_odp_key_attr(a, ma, portno_names, ds, verbose);
2540 first_field = false;
2544 ofpbuf_uninit(&ofp);
2549 if (left == key_len) {
2550 ds_put_cstr(ds, "<empty>");
2552 ds_put_format(ds, ",***%u leftover bytes*** (", left);
2553 for (i = 0; i < left; i++) {
2554 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
2556 ds_put_char(ds, ')');
2558 if (!has_ethtype_key) {
2559 ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
2561 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
2562 ntohs(nl_attr_get_be16(ma)));
2566 ds_put_cstr(ds, "<empty>");
2570 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2571 * OVS_KEY_ATTR_* attributes in 'key'. */
2573 odp_flow_key_format(const struct nlattr *key,
2574 size_t key_len, struct ds *ds)
2576 odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
2580 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
2582 if (!strcasecmp(s, "no")) {
2583 *type = OVS_FRAG_TYPE_NONE;
2584 } else if (!strcasecmp(s, "first")) {
2585 *type = OVS_FRAG_TYPE_FIRST;
2586 } else if (!strcasecmp(s, "later")) {
2587 *type = OVS_FRAG_TYPE_LATER;
2597 scan_eth(const char *s, struct eth_addr *key, struct eth_addr *mask)
2601 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n",
2602 ETH_ADDR_SCAN_ARGS(*key), &n)) {
2606 if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
2607 ETH_ADDR_SCAN_ARGS(*mask), &n)) {
2610 memset(mask, 0xff, sizeof *mask);
2619 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
2623 if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
2627 if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
2628 IP_SCAN_ARGS(mask), &n)) {
2631 *mask = OVS_BE32_MAX;
2640 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
2643 char ipv6_s[IPV6_SCAN_LEN + 1];
2645 if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
2646 && inet_pton(AF_INET6, ipv6_s, key) == 1) {
2650 if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
2651 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
2654 memset(mask, 0xff, sizeof *mask);
2663 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2668 if (ovs_scan(s, "%i%n", &key_, &n)
2669 && (key_ & ~IPV6_LABEL_MASK) == 0) {
2674 if (ovs_scan(s + len, "/%i%n", &mask_, &n)
2675 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
2677 *mask = htonl(mask_);
2679 *mask = htonl(IPV6_LABEL_MASK);
2688 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
2692 if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
2696 if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
2708 scan_u16(const char *s, uint16_t *key, uint16_t *mask)
2712 if (ovs_scan(s, "%"SCNi16"%n", key, &n)) {
2716 if (ovs_scan(s + len, "/%"SCNi16"%n", mask, &n)) {
2728 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
2732 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2736 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2748 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
2750 uint16_t key_, mask_;
2753 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2758 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2760 *mask = htons(mask_);
2762 *mask = OVS_BE16_MAX;
2771 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
2773 uint64_t key_, mask_;
2776 if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
2779 *key = htonll(key_);
2781 if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
2783 *mask = htonll(mask_);
2785 *mask = OVS_BE64_MAX;
2794 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
2796 uint32_t flags, fmask;
2799 n = parse_odp_flags(s, flow_tun_flag_to_string, &flags,
2800 FLOW_TNL_F_MASK, mask ? &fmask : NULL);
2801 if (n >= 0 && s[n] == ')') {
2812 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
2814 uint32_t flags, fmask;
2817 n = parse_odp_flags(s, packet_tcp_flag_to_string, &flags,
2818 TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
2820 *key = htons(flags);
2822 *mask = htons(fmask);
2830 ovs_to_odp_ct_state(uint8_t state)
2834 if (state & CS_NEW) {
2835 odp |= OVS_CS_F_NEW;
2837 if (state & CS_ESTABLISHED) {
2838 odp |= OVS_CS_F_ESTABLISHED;
2840 if (state & CS_RELATED) {
2841 odp |= OVS_CS_F_RELATED;
2843 if (state & CS_INVALID) {
2844 odp |= OVS_CS_F_INVALID;
2846 if (state & CS_REPLY_DIR) {
2847 odp |= OVS_CS_F_REPLY_DIR;
2849 if (state & CS_TRACKED) {
2850 odp |= OVS_CS_F_TRACKED;
2857 odp_to_ovs_ct_state(uint32_t flags)
2861 if (flags & OVS_CS_F_NEW) {
2864 if (flags & OVS_CS_F_ESTABLISHED) {
2865 state |= CS_ESTABLISHED;
2867 if (flags & OVS_CS_F_RELATED) {
2868 state |= CS_RELATED;
2870 if (flags & OVS_CS_F_INVALID) {
2871 state |= CS_INVALID;
2873 if (flags & OVS_CS_F_REPLY_DIR) {
2874 state |= CS_REPLY_DIR;
2876 if (flags & OVS_CS_F_TRACKED) {
2877 state |= CS_TRACKED;
2884 scan_ct_state(const char *s, uint32_t *key, uint32_t *mask)
2886 uint32_t flags, fmask;
2889 n = parse_flags(s, odp_ct_state_to_string, ')', NULL, NULL, &flags,
2890 ovs_to_odp_ct_state(CS_SUPPORTED_MASK),
2891 mask ? &fmask : NULL);
2904 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
2908 enum ovs_frag_type frag_type;
2910 if (ovs_scan(s, "%7[a-z]%n", frag, &n)
2911 && ovs_frag_type_from_string(frag, &frag_type)) {
2924 scan_port(const char *s, uint32_t *key, uint32_t *mask,
2925 const struct simap *port_names)
2929 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2933 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2940 } else if (port_names) {
2941 const struct simap_node *node;
2944 len = strcspn(s, ")");
2945 node = simap_find_len(port_names, s, len);
2958 /* Helper for vlan parsing. */
2959 struct ovs_key_vlan__ {
2964 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
2966 const uint16_t mask = ((1U << bits) - 1) << offset;
2968 if (value >> bits) {
2972 *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
2977 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
2980 uint16_t key_, mask_;
2983 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2986 if (set_be16_bf(key, bits, offset, key_)) {
2988 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2991 if (!set_be16_bf(mask, bits, offset, mask_)) {
2995 *mask |= htons(((1U << bits) - 1) << offset);
3005 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
3007 return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
3011 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
3013 return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
3017 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
3019 return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
3024 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
3026 const uint32_t mask = ((1U << bits) - 1) << offset;
3028 if (value >> bits) {
3032 *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
3037 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
3040 uint32_t key_, mask_;
3043 if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
3046 if (set_be32_bf(key, bits, offset, key_)) {
3048 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
3051 if (!set_be32_bf(mask, bits, offset, mask_)) {
3055 *mask |= htonl(((1U << bits) - 1) << offset);
3065 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
3067 return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
3071 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
3073 return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
3077 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
3079 return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
3083 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
3085 return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
3089 scan_vxlan_gbp(const char *s, uint32_t *key, uint32_t *mask)
3091 const char *s_base = s;
3092 ovs_be16 id = 0, id_mask = 0;
3093 uint8_t flags = 0, flags_mask = 0;
3095 if (!strncmp(s, "id=", 3)) {
3097 s += scan_be16(s, &id, mask ? &id_mask : NULL);
3103 if (!strncmp(s, "flags=", 6)) {
3105 s += scan_u8(s, &flags, mask ? &flags_mask : NULL);
3108 if (!strncmp(s, "))", 2)) {
3111 *key = (flags << 16) | ntohs(id);
3113 *mask = (flags_mask << 16) | ntohs(id_mask);
3123 scan_geneve(const char *s, struct geneve_scan *key, struct geneve_scan *mask)
3125 const char *s_base = s;
3126 struct geneve_opt *opt = key->d;
3127 struct geneve_opt *opt_mask = mask ? mask->d : NULL;
3128 int len_remain = sizeof key->d;
3130 while (s[0] == '{' && len_remain >= sizeof *opt) {
3134 len_remain -= sizeof *opt;
3136 if (!strncmp(s, "class=", 6)) {
3138 s += scan_be16(s, &opt->opt_class,
3139 mask ? &opt_mask->opt_class : NULL);
3141 memset(&opt_mask->opt_class, 0, sizeof opt_mask->opt_class);
3147 if (!strncmp(s, "type=", 5)) {
3149 s += scan_u8(s, &opt->type, mask ? &opt_mask->type : NULL);
3151 memset(&opt_mask->type, 0, sizeof opt_mask->type);
3157 if (!strncmp(s, "len=", 4)) {
3158 uint8_t opt_len, opt_len_mask;
3160 s += scan_u8(s, &opt_len, mask ? &opt_len_mask : NULL);
3162 if (opt_len > 124 || opt_len % 4 || opt_len > len_remain) {
3165 opt->length = opt_len / 4;
3167 opt_mask->length = opt_len_mask;
3171 memset(&opt_mask->type, 0, sizeof opt_mask->type);
3177 if (parse_int_string(s, (uint8_t *)(opt + 1), data_len, (char **)&s)) {
3184 if (parse_int_string(s, (uint8_t *)(opt_mask + 1),
3185 data_len, (char **)&s)) {
3196 opt += 1 + data_len / 4;
3198 opt_mask += 1 + data_len / 4;
3200 len_remain -= data_len;
3205 int len = sizeof key->d - len_remain;
3219 tun_flags_to_attr(struct ofpbuf *a, const void *data_)
3221 const uint16_t *flags = data_;
3223 if (*flags & FLOW_TNL_F_DONT_FRAGMENT) {
3224 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
3226 if (*flags & FLOW_TNL_F_CSUM) {
3227 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
3229 if (*flags & FLOW_TNL_F_OAM) {
3230 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
3235 vxlan_gbp_to_attr(struct ofpbuf *a, const void *data_)
3237 const uint32_t *gbp = data_;
3240 size_t vxlan_opts_ofs;
3242 vxlan_opts_ofs = nl_msg_start_nested(a, OVS_TUNNEL_KEY_ATTR_VXLAN_OPTS);
3243 nl_msg_put_u32(a, OVS_VXLAN_EXT_GBP, *gbp);
3244 nl_msg_end_nested(a, vxlan_opts_ofs);
3249 geneve_to_attr(struct ofpbuf *a, const void *data_)
3251 const struct geneve_scan *geneve = data_;
3253 nl_msg_put_unspec(a, OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS, geneve->d,
3257 #define SCAN_PUT_ATTR(BUF, ATTR, DATA, FUNC) \
3259 unsigned long call_fn = (unsigned long)FUNC; \
3261 typedef void (*fn)(struct ofpbuf *, const void *); \
3263 func(BUF, &(DATA)); \
3265 nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
3269 #define SCAN_IF(NAME) \
3270 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3271 const char *start = s; \
3276 /* Usually no special initialization is needed. */
3277 #define SCAN_BEGIN(NAME, TYPE) \
3280 memset(&skey, 0, sizeof skey); \
3281 memset(&smask, 0, sizeof smask); \
3285 /* Init as fully-masked as mask will not be scanned. */
3286 #define SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) \
3289 memset(&skey, 0, sizeof skey); \
3290 memset(&smask, 0xff, sizeof smask); \
3294 /* VLAN needs special initialization. */
3295 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT) \
3297 TYPE skey = KEY_INIT; \
3298 TYPE smask = MASK_INIT; \
3302 /* Scan unnamed entry as 'TYPE' */
3303 #define SCAN_TYPE(TYPE, KEY, MASK) \
3304 len = scan_##TYPE(s, KEY, MASK); \
3310 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
3311 #define SCAN_FIELD(NAME, TYPE, FIELD) \
3312 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3313 s += strlen(NAME); \
3314 SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL); \
3318 #define SCAN_FINISH() \
3319 } while (*s++ == ',' && len != 0); \
3320 if (s[-1] != ')') { \
3324 #define SCAN_FINISH_SINGLE() \
3326 if (*s++ != ')') { \
3330 /* Beginning of nested attribute. */
3331 #define SCAN_BEGIN_NESTED(NAME, ATTR) \
3333 size_t key_offset, mask_offset; \
3334 key_offset = nl_msg_start_nested(key, ATTR); \
3336 mask_offset = nl_msg_start_nested(mask, ATTR); \
3341 #define SCAN_END_NESTED() \
3343 nl_msg_end_nested(key, key_offset); \
3345 nl_msg_end_nested(mask, mask_offset); \
3350 #define SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, FUNC) \
3351 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
3353 memset(&skey, 0, sizeof skey); \
3354 memset(&smask, 0xff, sizeof smask); \
3355 s += strlen(NAME); \
3356 SCAN_TYPE(SCAN_AS, &skey, &smask); \
3357 SCAN_PUT(ATTR, FUNC); \
3361 #define SCAN_FIELD_NESTED(NAME, TYPE, SCAN_AS, ATTR) \
3362 SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, ATTR, NULL)
3364 #define SCAN_FIELD_NESTED_FUNC(NAME, TYPE, SCAN_AS, FUNC) \
3365 SCAN_FIELD_NESTED__(NAME, TYPE, SCAN_AS, 0, FUNC)
3367 #define SCAN_PUT(ATTR, FUNC) \
3368 if (!mask || !is_all_zeros(&smask, sizeof smask)) { \
3369 SCAN_PUT_ATTR(key, ATTR, skey, FUNC); \
3371 SCAN_PUT_ATTR(mask, ATTR, smask, FUNC); \
3375 #define SCAN_END(ATTR) \
3377 SCAN_PUT(ATTR, NULL); \
3381 #define SCAN_END_SINGLE(ATTR) \
3382 SCAN_FINISH_SINGLE(); \
3383 SCAN_PUT(ATTR, NULL); \
3387 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR) \
3388 SCAN_BEGIN(NAME, TYPE) { \
3389 SCAN_TYPE(SCAN_AS, &skey, &smask); \
3390 } SCAN_END_SINGLE(ATTR)
3392 #define SCAN_SINGLE_FULLY_MASKED(NAME, TYPE, SCAN_AS, ATTR) \
3393 SCAN_BEGIN_FULLY_MASKED(NAME, TYPE) { \
3394 SCAN_TYPE(SCAN_AS, &skey, NULL); \
3395 } SCAN_END_SINGLE(ATTR)
3397 /* scan_port needs one extra argument. */
3398 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR) \
3399 SCAN_BEGIN(NAME, TYPE) { \
3400 len = scan_port(s, &skey, &smask, port_names); \
3405 } SCAN_END_SINGLE(ATTR)
3408 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
3409 struct ofpbuf *key, struct ofpbuf *mask)
3415 len = odp_ufid_from_string(s, &ufid);
3420 SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
3421 SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
3422 SCAN_SINGLE_FULLY_MASKED("recirc_id(", uint32_t, u32,
3423 OVS_KEY_ATTR_RECIRC_ID);
3424 SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
3426 SCAN_SINGLE("ct_state(", uint32_t, ct_state, OVS_KEY_ATTR_CT_STATE);
3427 SCAN_SINGLE("ct_zone(", uint16_t, u16, OVS_KEY_ATTR_CT_ZONE);
3428 SCAN_SINGLE("ct_mark(", uint32_t, u32, OVS_KEY_ATTR_CT_MARK);
3430 SCAN_BEGIN_NESTED("tunnel(", OVS_KEY_ATTR_TUNNEL) {
3431 SCAN_FIELD_NESTED("tun_id=", ovs_be64, be64, OVS_TUNNEL_KEY_ATTR_ID);
3432 SCAN_FIELD_NESTED("src=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_SRC);
3433 SCAN_FIELD_NESTED("dst=", ovs_be32, ipv4, OVS_TUNNEL_KEY_ATTR_IPV4_DST);
3434 SCAN_FIELD_NESTED("tos=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TOS);
3435 SCAN_FIELD_NESTED("ttl=", uint8_t, u8, OVS_TUNNEL_KEY_ATTR_TTL);
3436 SCAN_FIELD_NESTED("tp_src=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_SRC);
3437 SCAN_FIELD_NESTED("tp_dst=", ovs_be16, be16, OVS_TUNNEL_KEY_ATTR_TP_DST);
3438 SCAN_FIELD_NESTED_FUNC("vxlan(gbp(", uint32_t, vxlan_gbp, vxlan_gbp_to_attr);
3439 SCAN_FIELD_NESTED_FUNC("geneve(", struct geneve_scan, geneve,
3441 SCAN_FIELD_NESTED_FUNC("flags(", uint16_t, tun_flags, tun_flags_to_attr);
3442 } SCAN_END_NESTED();
3444 SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
3446 SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
3447 SCAN_FIELD("src=", eth, eth_src);
3448 SCAN_FIELD("dst=", eth, eth_dst);
3449 } SCAN_END(OVS_KEY_ATTR_ETHERNET);
3451 SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
3452 { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
3453 SCAN_FIELD("vid=", vid, tci);
3454 SCAN_FIELD("pcp=", pcp, tci);
3455 SCAN_FIELD("cfi=", cfi, tci);
3456 } SCAN_END(OVS_KEY_ATTR_VLAN);
3458 SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
3460 SCAN_BEGIN("mpls(", struct ovs_key_mpls) {
3461 SCAN_FIELD("label=", mpls_label, mpls_lse);
3462 SCAN_FIELD("tc=", mpls_tc, mpls_lse);
3463 SCAN_FIELD("ttl=", mpls_ttl, mpls_lse);
3464 SCAN_FIELD("bos=", mpls_bos, mpls_lse);
3465 } SCAN_END(OVS_KEY_ATTR_MPLS);
3467 SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
3468 SCAN_FIELD("src=", ipv4, ipv4_src);
3469 SCAN_FIELD("dst=", ipv4, ipv4_dst);
3470 SCAN_FIELD("proto=", u8, ipv4_proto);
3471 SCAN_FIELD("tos=", u8, ipv4_tos);
3472 SCAN_FIELD("ttl=", u8, ipv4_ttl);
3473 SCAN_FIELD("frag=", frag, ipv4_frag);
3474 } SCAN_END(OVS_KEY_ATTR_IPV4);
3476 SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
3477 SCAN_FIELD("src=", ipv6, ipv6_src);
3478 SCAN_FIELD("dst=", ipv6, ipv6_dst);
3479 SCAN_FIELD("label=", ipv6_label, ipv6_label);
3480 SCAN_FIELD("proto=", u8, ipv6_proto);
3481 SCAN_FIELD("tclass=", u8, ipv6_tclass);
3482 SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
3483 SCAN_FIELD("frag=", frag, ipv6_frag);
3484 } SCAN_END(OVS_KEY_ATTR_IPV6);
3486 SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
3487 SCAN_FIELD("src=", be16, tcp_src);
3488 SCAN_FIELD("dst=", be16, tcp_dst);
3489 } SCAN_END(OVS_KEY_ATTR_TCP);
3491 SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
3493 SCAN_BEGIN("udp(", struct ovs_key_udp) {
3494 SCAN_FIELD("src=", be16, udp_src);
3495 SCAN_FIELD("dst=", be16, udp_dst);
3496 } SCAN_END(OVS_KEY_ATTR_UDP);
3498 SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
3499 SCAN_FIELD("src=", be16, sctp_src);
3500 SCAN_FIELD("dst=", be16, sctp_dst);
3501 } SCAN_END(OVS_KEY_ATTR_SCTP);
3503 SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
3504 SCAN_FIELD("type=", u8, icmp_type);
3505 SCAN_FIELD("code=", u8, icmp_code);
3506 } SCAN_END(OVS_KEY_ATTR_ICMP);
3508 SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
3509 SCAN_FIELD("type=", u8, icmpv6_type);
3510 SCAN_FIELD("code=", u8, icmpv6_code);
3511 } SCAN_END(OVS_KEY_ATTR_ICMPV6);
3513 SCAN_BEGIN("arp(", struct ovs_key_arp) {
3514 SCAN_FIELD("sip=", ipv4, arp_sip);
3515 SCAN_FIELD("tip=", ipv4, arp_tip);
3516 SCAN_FIELD("op=", be16, arp_op);
3517 SCAN_FIELD("sha=", eth, arp_sha);
3518 SCAN_FIELD("tha=", eth, arp_tha);
3519 } SCAN_END(OVS_KEY_ATTR_ARP);
3521 SCAN_BEGIN("nd(", struct ovs_key_nd) {
3522 SCAN_FIELD("target=", ipv6, nd_target);
3523 SCAN_FIELD("sll=", eth, nd_sll);
3524 SCAN_FIELD("tll=", eth, nd_tll);
3525 } SCAN_END(OVS_KEY_ATTR_ND);
3527 /* Encap open-coded. */
3528 if (!strncmp(s, "encap(", 6)) {
3529 const char *start = s;
3530 size_t encap, encap_mask = 0;
3532 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
3534 encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
3541 s += strspn(s, delimiters);
3544 } else if (*s == ')') {
3548 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3556 nl_msg_end_nested(key, encap);
3558 nl_msg_end_nested(mask, encap_mask);
3567 /* Parses the string representation of a datapath flow key, in the
3568 * format output by odp_flow_key_format(). Returns 0 if successful,
3569 * otherwise a positive errno value. On success, the flow key is
3570 * appended to 'key' as a series of Netlink attributes. On failure, no
3571 * data is appended to 'key'. Either way, 'key''s data might be
3574 * If 'port_names' is nonnull, it points to an simap that maps from a port name
3575 * to a port number. (Port names may be used instead of port numbers in
3578 * On success, the attributes appended to 'key' are individually syntactically
3579 * valid, but they may not be valid as a sequence. 'key' might, for example,
3580 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
3582 odp_flow_from_string(const char *s, const struct simap *port_names,
3583 struct ofpbuf *key, struct ofpbuf *mask)
3585 const size_t old_size = key->size;
3589 s += strspn(s, delimiters);
3594 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
3596 key->size = old_size;
3606 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
3609 /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
3610 * not a set of flags or bitfields. Hence, if the struct flow nw_frag
3611 * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
3612 * must use a zero mask for the netlink frag field, and all ones mask
3614 return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
3616 return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
3617 : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
3618 : OVS_FRAG_TYPE_FIRST;
3621 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
3622 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
3623 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
3625 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
3627 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
3629 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
3631 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
3632 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
3633 static void get_nd_key(const struct flow *, struct ovs_key_nd *);
3634 static void put_nd_key(const struct ovs_key_nd *, struct flow *);
3636 /* These share the same layout. */
3638 struct ovs_key_tcp tcp;
3639 struct ovs_key_udp udp;
3640 struct ovs_key_sctp sctp;
3643 static void get_tp_key(const struct flow *, union ovs_key_tp *);
3644 static void put_tp_key(const union ovs_key_tp *, struct flow *);
3647 odp_flow_key_from_flow__(const struct odp_flow_key_parms *parms,
3648 bool export_mask, struct ofpbuf *buf)
3650 struct ovs_key_ethernet *eth_key;
3652 const struct flow *flow = parms->flow;
3653 const struct flow *data = export_mask ? parms->mask : parms->flow;
3655 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
3657 if (flow->tunnel.ip_dst || export_mask) {
3658 tun_key_to_attr(buf, &data->tunnel, &parms->flow->tunnel,
3662 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
3664 if (parms->support.ct_state) {
3665 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
3666 ovs_to_odp_ct_state(data->ct_state));
3668 if (parms->support.ct_zone) {
3669 nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, data->ct_zone);
3671 if (parms->support.ct_mark) {
3672 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, data->ct_mark);
3674 if (parms->support.recirc) {
3675 nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
3676 nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
3679 /* Add an ingress port attribute if this is a mask or 'odp_in_port'
3680 * is not the magical value "ODPP_NONE". */
3681 if (export_mask || parms->odp_in_port != ODPP_NONE) {
3682 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, parms->odp_in_port);
3685 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
3687 get_ethernet_key(data, eth_key);
3689 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
3691 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3693 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
3695 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
3696 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
3697 if (flow->vlan_tci == htons(0)) {
3704 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3705 /* For backwards compatibility with kernels that don't support
3706 * wildcarding, the following convention is used to encode the
3707 * OVS_KEY_ATTR_ETHERTYPE for key and mask:
3710 * -------- -------- -------
3711 * >0x5ff 0xffff Specified Ethernet II Ethertype.
3712 * >0x5ff 0 Any Ethernet II or non-Ethernet II frame.
3713 * <none> 0xffff Any non-Ethernet II frame (except valid
3714 * 802.3 SNAP packet with valid eth_type).
3717 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
3722 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
3724 if (flow->dl_type == htons(ETH_TYPE_IP)) {
3725 struct ovs_key_ipv4 *ipv4_key;
3727 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
3729 get_ipv4_key(data, ipv4_key, export_mask);
3730 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
3731 struct ovs_key_ipv6 *ipv6_key;
3733 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
3735 get_ipv6_key(data, ipv6_key, export_mask);
3736 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
3737 flow->dl_type == htons(ETH_TYPE_RARP)) {
3738 struct ovs_key_arp *arp_key;
3740 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
3742 get_arp_key(data, arp_key);
3743 } else if (eth_type_mpls(flow->dl_type)) {
3744 struct ovs_key_mpls *mpls_key;
3747 n = flow_count_mpls_labels(flow, NULL);
3749 n = MIN(n, parms->support.max_mpls_depth);
3751 mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
3752 n * sizeof *mpls_key);
3753 for (i = 0; i < n; i++) {
3754 mpls_key[i].mpls_lse = data->mpls_lse[i];
3758 if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3759 if (flow->nw_proto == IPPROTO_TCP) {
3760 union ovs_key_tp *tcp_key;
3762 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
3764 get_tp_key(data, tcp_key);
3765 if (data->tcp_flags) {
3766 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
3768 } else if (flow->nw_proto == IPPROTO_UDP) {
3769 union ovs_key_tp *udp_key;
3771 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
3773 get_tp_key(data, udp_key);
3774 } else if (flow->nw_proto == IPPROTO_SCTP) {
3775 union ovs_key_tp *sctp_key;
3777 sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
3779 get_tp_key(data, sctp_key);
3780 } else if (flow->dl_type == htons(ETH_TYPE_IP)
3781 && flow->nw_proto == IPPROTO_ICMP) {
3782 struct ovs_key_icmp *icmp_key;
3784 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
3786 icmp_key->icmp_type = ntohs(data->tp_src);
3787 icmp_key->icmp_code = ntohs(data->tp_dst);
3788 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
3789 && flow->nw_proto == IPPROTO_ICMPV6) {
3790 struct ovs_key_icmpv6 *icmpv6_key;
3792 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
3793 sizeof *icmpv6_key);
3794 icmpv6_key->icmpv6_type = ntohs(data->tp_src);
3795 icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
3797 if (flow->tp_dst == htons(0)
3798 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
3799 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT))
3800 && (!export_mask || (data->tp_src == htons(0xffff)
3801 && data->tp_dst == htons(0xffff)))) {
3803 struct ovs_key_nd *nd_key;
3805 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
3807 memcpy(nd_key->nd_target, &data->nd_target,
3808 sizeof nd_key->nd_target);
3809 nd_key->nd_sll = data->arp_sha;
3810 nd_key->nd_tll = data->arp_tha;
3817 nl_msg_end_nested(buf, encap);
3821 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
3823 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3824 * capable of being expanded to allow for that much space. */
3826 odp_flow_key_from_flow(const struct odp_flow_key_parms *parms,
3829 odp_flow_key_from_flow__(parms, false, buf);
3832 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
3835 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3836 * capable of being expanded to allow for that much space. */
3838 odp_flow_key_from_mask(const struct odp_flow_key_parms *parms,
3841 odp_flow_key_from_flow__(parms, true, buf);
3844 /* Generate ODP flow key from the given packet metadata */
3846 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
3848 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
3850 if (md->tunnel.ip_dst) {
3851 tun_key_to_attr(buf, &md->tunnel, &md->tunnel, NULL);
3854 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
3857 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_STATE,
3858 ovs_to_odp_ct_state(md->ct_state));
3860 nl_msg_put_u16(buf, OVS_KEY_ATTR_CT_ZONE, md->ct_zone);
3863 nl_msg_put_u32(buf, OVS_KEY_ATTR_CT_MARK, md->ct_mark);
3867 /* Add an ingress port attribute if 'odp_in_port' is not the magical
3868 * value "ODPP_NONE". */
3869 if (md->in_port.odp_port != ODPP_NONE) {
3870 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
3874 /* Generate packet metadata from the given ODP flow key. */
3876 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
3877 struct pkt_metadata *md)
3879 const struct nlattr *nla;
3881 uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
3882 1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
3883 1u << OVS_KEY_ATTR_IN_PORT;
3885 pkt_metadata_init(md, ODPP_NONE);
3887 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3888 uint16_t type = nl_attr_type(nla);
3889 size_t len = nl_attr_get_size(nla);
3890 int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
3891 OVS_KEY_ATTR_MAX, type);
3893 if (len != expected_len && expected_len >= 0) {
3898 case OVS_KEY_ATTR_RECIRC_ID:
3899 md->recirc_id = nl_attr_get_u32(nla);
3900 wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
3902 case OVS_KEY_ATTR_DP_HASH:
3903 md->dp_hash = nl_attr_get_u32(nla);
3904 wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
3906 case OVS_KEY_ATTR_PRIORITY:
3907 md->skb_priority = nl_attr_get_u32(nla);
3908 wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
3910 case OVS_KEY_ATTR_SKB_MARK:
3911 md->pkt_mark = nl_attr_get_u32(nla);
3912 wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
3914 case OVS_KEY_ATTR_CT_STATE:
3915 md->ct_state = odp_to_ovs_ct_state(nl_attr_get_u32(nla));
3916 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_STATE);
3918 case OVS_KEY_ATTR_CT_ZONE:
3919 md->ct_zone = nl_attr_get_u16(nla);
3920 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_ZONE);
3922 case OVS_KEY_ATTR_CT_MARK:
3923 md->ct_mark = nl_attr_get_u32(nla);
3924 wanted_attrs &= ~(1u << OVS_KEY_ATTR_CT_MARK);
3926 case OVS_KEY_ATTR_TUNNEL: {
3927 enum odp_key_fitness res;
3929 res = odp_tun_key_from_attr(nla, true, &md->tunnel);
3930 if (res == ODP_FIT_ERROR) {
3931 memset(&md->tunnel, 0, sizeof md->tunnel);
3932 } else if (res == ODP_FIT_PERFECT) {
3933 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
3937 case OVS_KEY_ATTR_IN_PORT:
3938 md->in_port.odp_port = nl_attr_get_odp_port(nla);
3939 wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
3945 if (!wanted_attrs) {
3946 return; /* Have everything. */
3952 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
3954 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
3955 return hash_words(ALIGNED_CAST(const uint32_t *, key),
3956 key_len / sizeof(uint32_t), 0);
3960 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
3961 uint64_t attrs, int out_of_range_attr,
3962 const struct nlattr *key, size_t key_len)
3967 if (VLOG_DROP_DBG(rl)) {
3972 for (i = 0; i < 64; i++) {
3973 if (attrs & (UINT64_C(1) << i)) {
3974 char namebuf[OVS_KEY_ATTR_BUFSIZE];
3976 ds_put_format(&s, " %s",
3977 ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
3980 if (out_of_range_attr) {
3981 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
3984 ds_put_cstr(&s, ": ");
3985 odp_flow_key_format(key, key_len, &s);
3987 VLOG_DBG("%s:%s", title, ds_cstr(&s));
3992 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
3994 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3997 return odp_frag ? FLOW_NW_FRAG_MASK : 0;
4000 if (odp_frag > OVS_FRAG_TYPE_LATER) {
4001 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
4002 return 0xff; /* Error. */
4005 return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
4006 : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
4007 : FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
4011 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
4012 const struct nlattr *attrs[], uint64_t *present_attrsp,
4013 int *out_of_range_attrp)
4015 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4016 const struct nlattr *nla;
4017 uint64_t present_attrs;
4020 BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
4022 *out_of_range_attrp = 0;
4023 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
4024 uint16_t type = nl_attr_type(nla);
4025 size_t len = nl_attr_get_size(nla);
4026 int expected_len = odp_key_attr_len(ovs_flow_key_attr_lens,
4027 OVS_KEY_ATTR_MAX, type);
4029 if (len != expected_len && expected_len >= 0) {
4030 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4032 VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
4033 "length %d", ovs_key_attr_to_string(type, namebuf,
4039 if (type > OVS_KEY_ATTR_MAX) {
4040 *out_of_range_attrp = type;
4042 if (present_attrs & (UINT64_C(1) << type)) {
4043 char namebuf[OVS_KEY_ATTR_BUFSIZE];
4045 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
4046 ovs_key_attr_to_string(type,
4047 namebuf, sizeof namebuf));
4051 present_attrs |= UINT64_C(1) << type;
4056 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
4060 *present_attrsp = present_attrs;
4064 static enum odp_key_fitness
4065 check_expectations(uint64_t present_attrs, int out_of_range_attr,
4066 uint64_t expected_attrs,
4067 const struct nlattr *key, size_t key_len)
4069 uint64_t missing_attrs;
4070 uint64_t extra_attrs;
4072 missing_attrs = expected_attrs & ~present_attrs;
4073 if (missing_attrs) {
4074 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4075 log_odp_key_attributes(&rl, "expected but not present",
4076 missing_attrs, 0, key, key_len);
4077 return ODP_FIT_TOO_LITTLE;
4080 extra_attrs = present_attrs & ~expected_attrs;
4081 if (extra_attrs || out_of_range_attr) {
4082 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
4083 log_odp_key_attributes(&rl, "present but not expected",
4084 extra_attrs, out_of_range_attr, key, key_len);
4085 return ODP_FIT_TOO_MUCH;
4088 return ODP_FIT_PERFECT;
4092 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4093 uint64_t present_attrs, uint64_t *expected_attrs,
4094 struct flow *flow, const struct flow *src_flow)
4096 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4097 bool is_mask = flow != src_flow;
4099 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
4100 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
4101 if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
4102 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
4103 ntohs(flow->dl_type));
4106 if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
4107 flow->dl_type != htons(0xffff)) {
4110 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
4113 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
4114 } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
4115 /* See comments in odp_flow_key_from_flow__(). */
4116 VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
4123 static enum odp_key_fitness
4124 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4125 uint64_t present_attrs, int out_of_range_attr,
4126 uint64_t expected_attrs, struct flow *flow,
4127 const struct nlattr *key, size_t key_len,
4128 const struct flow *src_flow)
4130 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4131 bool is_mask = src_flow != flow;
4132 const void *check_start = NULL;
4133 size_t check_len = 0;
4134 enum ovs_key_attr expected_bit = 0xff;
4136 if (eth_type_mpls(src_flow->dl_type)) {
4137 if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4138 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
4140 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
4141 size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
4142 const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
4143 int n = size / sizeof(ovs_be32);
4146 if (!size || size % sizeof(ovs_be32)) {
4147 return ODP_FIT_ERROR;
4149 if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
4150 return ODP_FIT_ERROR;
4153 for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
4154 flow->mpls_lse[i] = mpls_lse[i];
4156 if (n > FLOW_MAX_MPLS_LABELS) {
4157 return ODP_FIT_TOO_MUCH;
4161 /* BOS may be set only in the innermost label. */
4162 for (i = 0; i < n - 1; i++) {
4163 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
4164 return ODP_FIT_ERROR;
4168 /* BOS must be set in the innermost label. */
4169 if (n < FLOW_MAX_MPLS_LABELS
4170 && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
4171 return ODP_FIT_TOO_LITTLE;
4177 } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
4179 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
4181 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
4182 const struct ovs_key_ipv4 *ipv4_key;
4184 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
4185 put_ipv4_key(ipv4_key, flow, is_mask);
4186 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4187 return ODP_FIT_ERROR;
4190 check_start = ipv4_key;
4191 check_len = sizeof *ipv4_key;
4192 expected_bit = OVS_KEY_ATTR_IPV4;
4195 } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
4197 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
4199 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
4200 const struct ovs_key_ipv6 *ipv6_key;
4202 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
4203 put_ipv6_key(ipv6_key, flow, is_mask);
4204 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
4205 return ODP_FIT_ERROR;
4208 check_start = ipv6_key;
4209 check_len = sizeof *ipv6_key;
4210 expected_bit = OVS_KEY_ATTR_IPV6;
4213 } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
4214 src_flow->dl_type == htons(ETH_TYPE_RARP)) {
4216 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
4218 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
4219 const struct ovs_key_arp *arp_key;
4221 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
4222 if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
4223 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
4224 "key", ntohs(arp_key->arp_op));
4225 return ODP_FIT_ERROR;
4227 put_arp_key(arp_key, flow);
4229 check_start = arp_key;
4230 check_len = sizeof *arp_key;
4231 expected_bit = OVS_KEY_ATTR_ARP;
4237 if (check_len > 0) { /* Happens only when 'is_mask'. */
4238 if (!is_all_zeros(check_start, check_len) &&
4239 flow->dl_type != htons(0xffff)) {
4240 return ODP_FIT_ERROR;
4242 expected_attrs |= UINT64_C(1) << expected_bit;
4246 expected_bit = OVS_KEY_ATTR_UNSPEC;
4247 if (src_flow->nw_proto == IPPROTO_TCP
4248 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4249 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4250 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4252 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
4254 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
4255 const union ovs_key_tp *tcp_key;
4257 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
4258 put_tp_key(tcp_key, flow);
4259 expected_bit = OVS_KEY_ATTR_TCP;
4261 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
4262 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
4263 flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
4265 } else if (src_flow->nw_proto == IPPROTO_UDP
4266 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4267 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4268 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4270 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
4272 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
4273 const union ovs_key_tp *udp_key;
4275 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
4276 put_tp_key(udp_key, flow);
4277 expected_bit = OVS_KEY_ATTR_UDP;
4279 } else if (src_flow->nw_proto == IPPROTO_SCTP
4280 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
4281 src_flow->dl_type == htons(ETH_TYPE_IPV6))
4282 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4284 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
4286 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
4287 const union ovs_key_tp *sctp_key;
4289 sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
4290 put_tp_key(sctp_key, flow);
4291 expected_bit = OVS_KEY_ATTR_SCTP;
4293 } else if (src_flow->nw_proto == IPPROTO_ICMP
4294 && src_flow->dl_type == htons(ETH_TYPE_IP)
4295 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4297 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
4299 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
4300 const struct ovs_key_icmp *icmp_key;
4302 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
4303 flow->tp_src = htons(icmp_key->icmp_type);
4304 flow->tp_dst = htons(icmp_key->icmp_code);
4305 expected_bit = OVS_KEY_ATTR_ICMP;
4307 } else if (src_flow->nw_proto == IPPROTO_ICMPV6
4308 && src_flow->dl_type == htons(ETH_TYPE_IPV6)
4309 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
4311 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
4313 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
4314 const struct ovs_key_icmpv6 *icmpv6_key;
4316 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
4317 flow->tp_src = htons(icmpv6_key->icmpv6_type);
4318 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
4319 expected_bit = OVS_KEY_ATTR_ICMPV6;
4320 if (src_flow->tp_dst == htons(0) &&
4321 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
4322 src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
4324 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4326 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
4327 const struct ovs_key_nd *nd_key;
4329 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
4330 memcpy(&flow->nd_target, nd_key->nd_target,
4331 sizeof flow->nd_target);
4332 flow->arp_sha = nd_key->nd_sll;
4333 flow->arp_tha = nd_key->nd_tll;
4335 if (!is_all_zeros(nd_key, sizeof *nd_key) &&
4336 (flow->tp_src != htons(0xffff) ||
4337 flow->tp_dst != htons(0xffff))) {
4338 return ODP_FIT_ERROR;
4340 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
4347 if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
4348 if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
4349 return ODP_FIT_ERROR;
4351 expected_attrs |= UINT64_C(1) << expected_bit;
4356 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
4360 /* Parse 802.1Q header then encapsulated L3 attributes. */
4361 static enum odp_key_fitness
4362 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
4363 uint64_t present_attrs, int out_of_range_attr,
4364 uint64_t expected_attrs, struct flow *flow,
4365 const struct nlattr *key, size_t key_len,
4366 const struct flow *src_flow)
4368 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
4369 bool is_mask = src_flow != flow;
4371 const struct nlattr *encap
4372 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
4373 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
4374 enum odp_key_fitness encap_fitness;
4375 enum odp_key_fitness fitness;
4377 /* Calculate fitness of outer attributes. */
4379 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
4380 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
4382 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4383 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4385 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
4386 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
4389 fitness = check_expectations(present_attrs, out_of_range_attr,
4390 expected_attrs, key, key_len);
4393 * Remove the TPID from dl_type since it's not the real Ethertype. */
4394 flow->dl_type = htons(0);
4395 flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
4396 ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
4399 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
4400 return ODP_FIT_TOO_LITTLE;
4401 } else if (flow->vlan_tci == htons(0)) {
4402 /* Corner case for a truncated 802.1Q header. */
4403 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
4404 return ODP_FIT_TOO_MUCH;
4407 } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
4408 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
4409 "but CFI bit is not set", ntohs(flow->vlan_tci));
4410 return ODP_FIT_ERROR;
4413 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
4418 /* Now parse the encapsulated attributes. */
4419 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
4420 attrs, &present_attrs, &out_of_range_attr)) {
4421 return ODP_FIT_ERROR;
4425 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
4426 return ODP_FIT_ERROR;
4428 encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4429 expected_attrs, flow, key, key_len,
4432 /* The overall fitness is the worse of the outer and inner attributes. */
4433 return MAX(fitness, encap_fitness);
4436 static enum odp_key_fitness
4437 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
4438 const struct nlattr *src_key, size_t src_key_len,
4439 struct flow *flow, const struct flow *src_flow,
4442 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
4443 uint64_t expected_attrs;
4444 uint64_t present_attrs;
4445 int out_of_range_attr;
4446 bool is_mask = src_flow != flow;
4448 memset(flow, 0, sizeof *flow);
4450 /* Parse attributes. */
4451 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
4452 &out_of_range_attr)) {
4453 return ODP_FIT_ERROR;
4458 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
4459 flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
4460 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
4461 } else if (is_mask) {
4462 /* Always exact match recirc_id if it is not specified. */
4463 flow->recirc_id = UINT32_MAX;
4466 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
4467 flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
4468 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
4470 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
4471 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
4472 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
4475 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
4476 flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
4477 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
4480 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_STATE)) {
4481 uint32_t odp_state = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_STATE]);
4483 flow->ct_state = odp_to_ovs_ct_state(odp_state);
4484 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_STATE;
4486 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE)) {
4487 flow->ct_zone = nl_attr_get_u16(attrs[OVS_KEY_ATTR_CT_ZONE]);
4488 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_ZONE;
4490 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_CT_MARK)) {
4491 flow->ct_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_CT_MARK]);
4492 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_CT_MARK;
4495 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
4496 enum odp_key_fitness res;
4498 res = odp_tun_key_from_attr__(attrs[OVS_KEY_ATTR_TUNNEL],
4499 is_mask ? src_key : NULL,
4500 src_key_len, &src_flow->tunnel,
4501 &flow->tunnel, udpif);
4502 if (res == ODP_FIT_ERROR) {
4503 return ODP_FIT_ERROR;
4504 } else if (res == ODP_FIT_PERFECT) {
4505 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
4509 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
4510 flow->in_port.odp_port
4511 = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
4512 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
4513 } else if (!is_mask) {
4514 flow->in_port.odp_port = ODPP_NONE;
4517 /* Ethernet header. */
4518 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
4519 const struct ovs_key_ethernet *eth_key;
4521 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
4522 put_ethernet_key(eth_key, flow);
4524 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4528 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
4531 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
4532 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
4534 return ODP_FIT_ERROR;
4538 ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
4539 : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
4540 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
4541 expected_attrs, flow, key, key_len, src_flow);
4544 /* A missing VLAN mask means exact match on vlan_tci 0 (== no VLAN). */
4545 flow->vlan_tci = htons(0xffff);
4546 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
4547 flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
4548 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
4551 return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
4552 expected_attrs, flow, key, key_len, src_flow);
4555 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
4556 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
4557 * 'key' fits our expectations for what a flow key should contain.
4559 * The 'in_port' will be the datapath's understanding of the port. The
4560 * caller will need to translate with odp_port_to_ofp_port() if the
4561 * OpenFlow port is needed.
4563 * This function doesn't take the packet itself as an argument because none of
4564 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
4565 * it is always possible to infer which additional attribute(s) should appear
4566 * by looking at the attributes for lower-level protocols, e.g. if the network
4567 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
4568 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
4569 * must be absent. */
4570 enum odp_key_fitness
4571 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
4574 return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, false);
4577 /* Converts the 'mask_key_len' bytes of OVS_KEY_ATTR_* attributes in 'mask_key'
4578 * to a mask structure in 'mask'. 'flow' must be a previously translated flow
4579 * corresponding to 'mask' and similarly flow_key/flow_key_len must be the
4580 * attributes from that flow. Returns an ODP_FIT_* value that indicates how
4581 * well 'key' fits our expectations for what a flow key should contain. */
4582 enum odp_key_fitness
4583 odp_flow_key_to_mask(const struct nlattr *mask_key, size_t mask_key_len,
4584 const struct nlattr *flow_key, size_t flow_key_len,
4585 struct flow *mask, const struct flow *flow)
4587 return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
4591 /* These functions are similar to their non-"_udpif" variants but output a
4592 * 'flow' that is suitable for fast-path packet processing.
4594 * Some fields have different representation for flow setup and per-
4595 * packet processing (i.e. different between ofproto-dpif and userspace
4596 * datapath). In particular, with the non-"_udpif" functions, struct
4597 * tun_metadata is in the per-flow format (using 'present.map' and 'opts.u8');
4598 * with these functions, struct tun_metadata is in the per-packet format
4599 * (using 'present.len' and 'opts.gnv'). */
4600 enum odp_key_fitness
4601 odp_flow_key_to_flow_udpif(const struct nlattr *key, size_t key_len,
4604 return odp_flow_key_to_flow__(key, key_len, NULL, 0, flow, flow, true);
4607 enum odp_key_fitness
4608 odp_flow_key_to_mask_udpif(const struct nlattr *mask_key, size_t mask_key_len,
4609 const struct nlattr *flow_key, size_t flow_key_len,
4610 struct flow *mask, const struct flow *flow)
4612 return odp_flow_key_to_flow__(mask_key, mask_key_len, flow_key, flow_key_len,
4616 /* Returns 'fitness' as a string, for use in debug messages. */
4618 odp_key_fitness_to_string(enum odp_key_fitness fitness)
4621 case ODP_FIT_PERFECT:
4623 case ODP_FIT_TOO_MUCH:
4625 case ODP_FIT_TOO_LITTLE:
4626 return "too_little";
4634 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
4635 * Netlink PID 'pid'. If 'userdata' is nonnull, adds a userdata attribute
4636 * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
4637 * offset within 'odp_actions' of the start of the cookie. (If 'userdata' is
4638 * null, then the return value is not meaningful.) */
4640 odp_put_userspace_action(uint32_t pid,
4641 const void *userdata, size_t userdata_size,
4642 odp_port_t tunnel_out_port,
4643 bool include_actions,
4644 struct ofpbuf *odp_actions)
4646 size_t userdata_ofs;
4649 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
4650 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
4652 userdata_ofs = odp_actions->size + NLA_HDRLEN;
4654 /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
4655 * module before Linux 3.10 required the userdata to be exactly 8 bytes
4658 * - The kernel rejected shorter userdata with -ERANGE.
4660 * - The kernel silently dropped userdata beyond the first 8 bytes.
4662 * Thus, for maximum compatibility, always put at least 8 bytes. (We
4663 * separately disable features that required more than 8 bytes.) */
4664 memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
4665 MAX(8, userdata_size)),
4666 userdata, userdata_size);
4670 if (tunnel_out_port != ODPP_NONE) {
4671 nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
4674 if (include_actions) {
4675 nl_msg_put_flag(odp_actions, OVS_USERSPACE_ATTR_ACTIONS);
4677 nl_msg_end_nested(odp_actions, offset);
4679 return userdata_ofs;
4683 odp_put_tunnel_action(const struct flow_tnl *tunnel,
4684 struct ofpbuf *odp_actions)
4686 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4687 tun_key_to_attr(odp_actions, tunnel, tunnel, NULL);
4688 nl_msg_end_nested(odp_actions, offset);
4692 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
4693 struct ovs_action_push_tnl *data)
4695 int size = offsetof(struct ovs_action_push_tnl, header);
4697 size += data->header_len;
4698 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
4702 /* The commit_odp_actions() function and its helpers. */
4705 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
4706 const void *key, size_t key_size)
4708 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
4709 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
4710 nl_msg_end_nested(odp_actions, offset);
4713 /* Masked set actions have a mask following the data within the netlink
4714 * attribute. The unmasked bits in the data will be cleared as the data
4715 * is copied to the action. */
4717 commit_masked_set_action(struct ofpbuf *odp_actions,
4718 enum ovs_key_attr key_type,
4719 const void *key_, const void *mask_, size_t key_size)
4721 size_t offset = nl_msg_start_nested(odp_actions,
4722 OVS_ACTION_ATTR_SET_MASKED);
4723 char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
4724 const char *key = key_, *mask = mask_;
4726 memcpy(data + key_size, mask, key_size);
4727 /* Clear unmasked bits while copying. */
4728 while (key_size--) {
4729 *data++ = *key++ & *mask++;
4731 nl_msg_end_nested(odp_actions, offset);
4734 /* If any of the flow key data that ODP actions can modify are different in
4735 * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
4736 * 'odp_actions' that change the flow tunneling information in key from
4737 * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
4738 * same way. In other words, operates the same as commit_odp_actions(), but
4739 * only on tunneling information. */
4741 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
4742 struct ofpbuf *odp_actions)
4744 /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
4745 if (flow->tunnel.ip_dst) {
4746 if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
4749 memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
4750 odp_put_tunnel_action(&base->tunnel, odp_actions);
4755 commit(enum ovs_key_attr attr, bool use_masked_set,
4756 const void *key, void *base, void *mask, size_t size,
4757 struct ofpbuf *odp_actions)
4759 if (memcmp(key, base, size)) {
4760 bool fully_masked = odp_mask_is_exact(attr, mask, size);
4762 if (use_masked_set && !fully_masked) {
4763 commit_masked_set_action(odp_actions, attr, key, mask, size);
4765 if (!fully_masked) {
4766 memset(mask, 0xff, size);
4768 commit_set_action(odp_actions, attr, key, size);
4770 memcpy(base, key, size);
4773 /* Mask bits are set when we have either read or set the corresponding
4774 * values. Masked bits will be exact-matched, no need to set them
4775 * if the value did not actually change. */
4781 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
4783 eth->eth_src = flow->dl_src;
4784 eth->eth_dst = flow->dl_dst;
4788 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
4790 flow->dl_src = eth->eth_src;
4791 flow->dl_dst = eth->eth_dst;
4795 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
4796 struct ofpbuf *odp_actions,
4797 struct flow_wildcards *wc,
4800 struct ovs_key_ethernet key, base, mask;
4802 get_ethernet_key(flow, &key);
4803 get_ethernet_key(base_flow, &base);
4804 get_ethernet_key(&wc->masks, &mask);
4806 if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
4807 &key, &base, &mask, sizeof key, odp_actions)) {
4808 put_ethernet_key(&base, base_flow);
4809 put_ethernet_key(&mask, &wc->masks);
4814 pop_vlan(struct flow *base,
4815 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4817 memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
4819 if (base->vlan_tci & htons(VLAN_CFI)) {
4820 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
4826 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
4827 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4829 if (base->vlan_tci == vlan_tci) {
4833 pop_vlan(base, odp_actions, wc);
4834 if (vlan_tci & htons(VLAN_CFI)) {
4835 struct ovs_action_push_vlan vlan;
4837 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
4838 vlan.vlan_tci = vlan_tci;
4839 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
4840 &vlan, sizeof vlan);
4842 base->vlan_tci = vlan_tci;
4845 /* Wildcarding already done at action translation time. */
4847 commit_mpls_action(const struct flow *flow, struct flow *base,
4848 struct ofpbuf *odp_actions)
4850 int base_n = flow_count_mpls_labels(base, NULL);
4851 int flow_n = flow_count_mpls_labels(flow, NULL);
4852 int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
4855 while (base_n > common_n) {
4856 if (base_n - 1 == common_n && flow_n > common_n) {
4857 /* If there is only one more LSE in base than there are common
4858 * between base and flow; and flow has at least one more LSE than
4859 * is common then the topmost LSE of base may be updated using
4861 struct ovs_key_mpls mpls_key;
4863 mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
4864 commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
4865 &mpls_key, sizeof mpls_key);
4866 flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
4869 /* Otherwise, if there more LSEs in base than are common between
4870 * base and flow then pop the topmost one. */
4874 /* If all the LSEs are to be popped and this is not the outermost
4875 * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
4876 * POP_MPLS action instead of flow->dl_type.
4878 * This is because the POP_MPLS action requires its ethertype
4879 * argument to be an MPLS ethernet type but in this case
4880 * flow->dl_type will be a non-MPLS ethernet type.
4882 * When the final POP_MPLS action occurs it use flow->dl_type and
4883 * the and the resulting packet will have the desired dl_type. */
4884 if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
4885 dl_type = htons(ETH_TYPE_MPLS);
4887 dl_type = flow->dl_type;
4889 nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
4890 popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
4896 /* If, after the above popping and setting, there are more LSEs in flow
4897 * than base then some LSEs need to be pushed. */
4898 while (base_n < flow_n) {
4899 struct ovs_action_push_mpls *mpls;
4901 mpls = nl_msg_put_unspec_zero(odp_actions,
4902 OVS_ACTION_ATTR_PUSH_MPLS,
4904 mpls->mpls_ethertype = flow->dl_type;
4905 mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
4906 flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
4907 flow_set_mpls_lse(base, 0, mpls->mpls_lse);
4913 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
4915 ipv4->ipv4_src = flow->nw_src;
4916 ipv4->ipv4_dst = flow->nw_dst;
4917 ipv4->ipv4_proto = flow->nw_proto;
4918 ipv4->ipv4_tos = flow->nw_tos;
4919 ipv4->ipv4_ttl = flow->nw_ttl;
4920 ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4924 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
4926 flow->nw_src = ipv4->ipv4_src;
4927 flow->nw_dst = ipv4->ipv4_dst;
4928 flow->nw_proto = ipv4->ipv4_proto;
4929 flow->nw_tos = ipv4->ipv4_tos;
4930 flow->nw_ttl = ipv4->ipv4_ttl;
4931 flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
4935 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
4936 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4939 struct ovs_key_ipv4 key, mask, base;
4941 /* Check that nw_proto and nw_frag remain unchanged. */
4942 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4943 flow->nw_frag == base_flow->nw_frag);
4945 get_ipv4_key(flow, &key, false);
4946 get_ipv4_key(base_flow, &base, false);
4947 get_ipv4_key(&wc->masks, &mask, true);
4948 mask.ipv4_proto = 0; /* Not writeable. */
4949 mask.ipv4_frag = 0; /* Not writable. */
4951 if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
4953 put_ipv4_key(&base, base_flow, false);
4954 if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
4955 put_ipv4_key(&mask, &wc->masks, true);
4961 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
4963 memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
4964 memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
4965 ipv6->ipv6_label = flow->ipv6_label;
4966 ipv6->ipv6_proto = flow->nw_proto;
4967 ipv6->ipv6_tclass = flow->nw_tos;
4968 ipv6->ipv6_hlimit = flow->nw_ttl;
4969 ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4973 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
4975 memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
4976 memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
4977 flow->ipv6_label = ipv6->ipv6_label;
4978 flow->nw_proto = ipv6->ipv6_proto;
4979 flow->nw_tos = ipv6->ipv6_tclass;
4980 flow->nw_ttl = ipv6->ipv6_hlimit;
4981 flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
4985 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
4986 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4989 struct ovs_key_ipv6 key, mask, base;
4991 /* Check that nw_proto and nw_frag remain unchanged. */
4992 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4993 flow->nw_frag == base_flow->nw_frag);
4995 get_ipv6_key(flow, &key, false);
4996 get_ipv6_key(base_flow, &base, false);
4997 get_ipv6_key(&wc->masks, &mask, true);
4998 mask.ipv6_proto = 0; /* Not writeable. */
4999 mask.ipv6_frag = 0; /* Not writable. */
5001 if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
5003 put_ipv6_key(&base, base_flow, false);
5004 if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
5005 put_ipv6_key(&mask, &wc->masks, true);
5011 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
5013 /* ARP key has padding, clear it. */
5014 memset(arp, 0, sizeof *arp);
5016 arp->arp_sip = flow->nw_src;
5017 arp->arp_tip = flow->nw_dst;
5018 arp->arp_op = htons(flow->nw_proto);
5019 arp->arp_sha = flow->arp_sha;
5020 arp->arp_tha = flow->arp_tha;
5024 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
5026 flow->nw_src = arp->arp_sip;
5027 flow->nw_dst = arp->arp_tip;
5028 flow->nw_proto = ntohs(arp->arp_op);
5029 flow->arp_sha = arp->arp_sha;
5030 flow->arp_tha = arp->arp_tha;
5033 static enum slow_path_reason
5034 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
5035 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
5037 struct ovs_key_arp key, mask, base;
5039 get_arp_key(flow, &key);
5040 get_arp_key(base_flow, &base);
5041 get_arp_key(&wc->masks, &mask);
5043 if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
5045 put_arp_key(&base, base_flow);
5046 put_arp_key(&mask, &wc->masks);
5053 get_nd_key(const struct flow *flow, struct ovs_key_nd *nd)
5055 memcpy(nd->nd_target, &flow->nd_target, sizeof flow->nd_target);
5056 /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5057 nd->nd_sll = flow->arp_sha;
5058 nd->nd_tll = flow->arp_tha;
5062 put_nd_key(const struct ovs_key_nd *nd, struct flow *flow)
5064 memcpy(&flow->nd_target, nd->nd_target, sizeof flow->nd_target);
5065 /* nd_sll and nd_tll are stored in arp_sha and arp_tha, respectively */
5066 flow->arp_sha = nd->nd_sll;
5067 flow->arp_tha = nd->nd_tll;
5070 static enum slow_path_reason
5071 commit_set_nd_action(const struct flow *flow, struct flow *base_flow,
5072 struct ofpbuf *odp_actions,
5073 struct flow_wildcards *wc, bool use_masked)
5075 struct ovs_key_nd key, mask, base;
5077 get_nd_key(flow, &key);
5078 get_nd_key(base_flow, &base);
5079 get_nd_key(&wc->masks, &mask);
5081 if (commit(OVS_KEY_ATTR_ND, use_masked, &key, &base, &mask, sizeof key,
5083 put_nd_key(&base, base_flow);
5084 put_nd_key(&mask, &wc->masks);
5091 static enum slow_path_reason
5092 commit_set_nw_action(const struct flow *flow, struct flow *base,
5093 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5096 /* Check if 'flow' really has an L3 header. */
5097 if (!flow->nw_proto) {
5101 switch (ntohs(base->dl_type)) {
5103 commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
5107 commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
5108 return commit_set_nd_action(flow, base, odp_actions, wc, use_masked);
5111 return commit_set_arp_action(flow, base, odp_actions, wc);
5117 /* TCP, UDP, and SCTP keys have the same layout. */
5118 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
5119 sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
5122 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
5124 tp->tcp.tcp_src = flow->tp_src;
5125 tp->tcp.tcp_dst = flow->tp_dst;
5129 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
5131 flow->tp_src = tp->tcp.tcp_src;
5132 flow->tp_dst = tp->tcp.tcp_dst;
5136 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
5137 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5140 enum ovs_key_attr key_type;
5141 union ovs_key_tp key, mask, base;
5143 /* Check if 'flow' really has an L3 header. */
5144 if (!flow->nw_proto) {
5148 if (!is_ip_any(base_flow)) {
5152 if (flow->nw_proto == IPPROTO_TCP) {
5153 key_type = OVS_KEY_ATTR_TCP;
5154 } else if (flow->nw_proto == IPPROTO_UDP) {
5155 key_type = OVS_KEY_ATTR_UDP;
5156 } else if (flow->nw_proto == IPPROTO_SCTP) {
5157 key_type = OVS_KEY_ATTR_SCTP;
5162 get_tp_key(flow, &key);
5163 get_tp_key(base_flow, &base);
5164 get_tp_key(&wc->masks, &mask);
5166 if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
5168 put_tp_key(&base, base_flow);
5169 put_tp_key(&mask, &wc->masks);
5174 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
5175 struct ofpbuf *odp_actions,
5176 struct flow_wildcards *wc,
5179 uint32_t key, mask, base;
5181 key = flow->skb_priority;
5182 base = base_flow->skb_priority;
5183 mask = wc->masks.skb_priority;
5185 if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
5186 sizeof key, odp_actions)) {
5187 base_flow->skb_priority = base;
5188 wc->masks.skb_priority = mask;
5193 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base_flow,
5194 struct ofpbuf *odp_actions,
5195 struct flow_wildcards *wc,
5198 uint32_t key, mask, base;
5200 key = flow->pkt_mark;
5201 base = base_flow->pkt_mark;
5202 mask = wc->masks.pkt_mark;
5204 if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
5205 sizeof key, odp_actions)) {
5206 base_flow->pkt_mark = base;
5207 wc->masks.pkt_mark = mask;
5211 /* If any of the flow key data that ODP actions can modify are different in
5212 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
5213 * key from 'base' into 'flow', and then changes 'base' the same way. Does not
5214 * commit set_tunnel actions. Users should call commit_odp_tunnel_action()
5215 * in addition to this function if needed. Sets fields in 'wc' that are
5216 * used as part of the action.
5218 * Returns a reason to force processing the flow's packets into the userspace
5219 * slow path, if there is one, otherwise 0. */
5220 enum slow_path_reason
5221 commit_odp_actions(const struct flow *flow, struct flow *base,
5222 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
5225 enum slow_path_reason slow;
5227 commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
5228 slow = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
5229 commit_set_port_action(flow, base, odp_actions, wc, use_masked);
5230 commit_mpls_action(flow, base, odp_actions);
5231 commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
5232 commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
5233 commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);