]> git.proxmox.com Git - ovs.git/blob - lib/odp-util.c
projects / ovs.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
datapath-windows: Avoid BSOD when switch context is NULL
[ovs.git] / lib / odp-util.c
1 /*
2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 *
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:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17 #include <config.h>
18 #include <arpa/inet.h>
19 #include "odp-util.h"
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <math.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
25 #include <stdlib.h>
26 #include <string.h>
27
28 #include "byte-order.h"
29 #include "coverage.h"
30 #include "dpif.h"
31 #include "dynamic-string.h"
32 #include "flow.h"
33 #include "netlink.h"
34 #include "ofpbuf.h"
35 #include "packets.h"
36 #include "simap.h"
37 #include "timeval.h"
38 #include "unaligned.h"
39 #include "util.h"
40 #include "vlog.h"
41
42 VLOG_DEFINE_THIS_MODULE(odp_util);
43
44 /* The interface between userspace and kernel uses an "OVS_*" prefix.
45 * Since this is fairly non-specific for the OVS userspace components,
46 * "ODP_*" (Open vSwitch Datapath) is used as the prefix for
47 * interactions with the datapath.
48 */
49
50 /* The set of characters that may separate one action or one key attribute
51 * from another. */
52 static const char *delimiters = ", \t\r\n";
53
54 static int parse_odp_key_mask_attr(const char *, const struct simap *port_names,
55 struct ofpbuf *, struct ofpbuf *);
56 static void format_odp_key_attr(const struct nlattr *a,
57 const struct nlattr *ma,
58 const struct hmap *portno_names, struct ds *ds,
59 bool verbose);
60
61 /* Returns one the following for the action with the given OVS_ACTION_ATTR_*
62 * 'type':
63 *
64 * - For an action whose argument has a fixed length, returned that
65 * nonnegative length in bytes.
66 *
67 * - For an action with a variable-length argument, returns -2.
68 *
69 * - For an invalid 'type', returns -1. */
70 static int
71 odp_action_len(uint16_t type)
72 {
73 if (type > OVS_ACTION_ATTR_MAX) {
74 return -1;
75 }
76
77 switch ((enum ovs_action_attr) type) {
78 case OVS_ACTION_ATTR_OUTPUT: return sizeof(uint32_t);
79 case OVS_ACTION_ATTR_TUNNEL_PUSH: return -2;
80 case OVS_ACTION_ATTR_TUNNEL_POP: return sizeof(uint32_t);
81 case OVS_ACTION_ATTR_USERSPACE: return -2;
82 case OVS_ACTION_ATTR_PUSH_VLAN: return sizeof(struct ovs_action_push_vlan);
83 case OVS_ACTION_ATTR_POP_VLAN: return 0;
84 case OVS_ACTION_ATTR_PUSH_MPLS: return sizeof(struct ovs_action_push_mpls);
85 case OVS_ACTION_ATTR_POP_MPLS: return sizeof(ovs_be16);
86 case OVS_ACTION_ATTR_RECIRC: return sizeof(uint32_t);
87 case OVS_ACTION_ATTR_HASH: return sizeof(struct ovs_action_hash);
88 case OVS_ACTION_ATTR_SET: return -2;
89 case OVS_ACTION_ATTR_SET_MASKED: return -2;
90 case OVS_ACTION_ATTR_SAMPLE: return -2;
91
92 case OVS_ACTION_ATTR_UNSPEC:
93 case __OVS_ACTION_ATTR_MAX:
94 return -1;
95 }
96
97 return -1;
98 }
99
100 /* Returns a string form of 'attr'. The return value is either a statically
101 * allocated constant string or the 'bufsize'-byte buffer 'namebuf'. 'bufsize'
102 * should be at least OVS_KEY_ATTR_BUFSIZE. */
103 enum { OVS_KEY_ATTR_BUFSIZE = 3 + INT_STRLEN(unsigned int) + 1 };
104 static const char *
105 ovs_key_attr_to_string(enum ovs_key_attr attr, char *namebuf, size_t bufsize)
106 {
107 switch (attr) {
108 case OVS_KEY_ATTR_UNSPEC: return "unspec";
109 case OVS_KEY_ATTR_ENCAP: return "encap";
110 case OVS_KEY_ATTR_PRIORITY: return "skb_priority";
111 case OVS_KEY_ATTR_SKB_MARK: return "skb_mark";
112 case OVS_KEY_ATTR_TUNNEL: return "tunnel";
113 case OVS_KEY_ATTR_IN_PORT: return "in_port";
114 case OVS_KEY_ATTR_ETHERNET: return "eth";
115 case OVS_KEY_ATTR_VLAN: return "vlan";
116 case OVS_KEY_ATTR_ETHERTYPE: return "eth_type";
117 case OVS_KEY_ATTR_IPV4: return "ipv4";
118 case OVS_KEY_ATTR_IPV6: return "ipv6";
119 case OVS_KEY_ATTR_TCP: return "tcp";
120 case OVS_KEY_ATTR_TCP_FLAGS: return "tcp_flags";
121 case OVS_KEY_ATTR_UDP: return "udp";
122 case OVS_KEY_ATTR_SCTP: return "sctp";
123 case OVS_KEY_ATTR_ICMP: return "icmp";
124 case OVS_KEY_ATTR_ICMPV6: return "icmpv6";
125 case OVS_KEY_ATTR_ARP: return "arp";
126 case OVS_KEY_ATTR_ND: return "nd";
127 case OVS_KEY_ATTR_MPLS: return "mpls";
128 case OVS_KEY_ATTR_DP_HASH: return "dp_hash";
129 case OVS_KEY_ATTR_RECIRC_ID: return "recirc_id";
130
131 case __OVS_KEY_ATTR_MAX:
132 default:
133 snprintf(namebuf, bufsize, "key%u", (unsigned int) attr);
134 return namebuf;
135 }
136 }
137
138 static void
139 format_generic_odp_action(struct ds *ds, const struct nlattr *a)
140 {
141 size_t len = nl_attr_get_size(a);
142
143 ds_put_format(ds, "action%"PRId16, nl_attr_type(a));
144 if (len) {
145 const uint8_t *unspec;
146 unsigned int i;
147
148 unspec = nl_attr_get(a);
149 for (i = 0; i < len; i++) {
150 ds_put_char(ds, i ? ' ': '(');
151 ds_put_format(ds, "%02x", unspec[i]);
152 }
153 ds_put_char(ds, ')');
154 }
155 }
156
157 static void
158 format_odp_sample_action(struct ds *ds, const struct nlattr *attr)
159 {
160 static const struct nl_policy ovs_sample_policy[] = {
161 [OVS_SAMPLE_ATTR_PROBABILITY] = { .type = NL_A_U32 },
162 [OVS_SAMPLE_ATTR_ACTIONS] = { .type = NL_A_NESTED }
163 };
164 struct nlattr *a[ARRAY_SIZE(ovs_sample_policy)];
165 double percentage;
166 const struct nlattr *nla_acts;
167 int len;
168
169 ds_put_cstr(ds, "sample");
170
171 if (!nl_parse_nested(attr, ovs_sample_policy, a, ARRAY_SIZE(a))) {
172 ds_put_cstr(ds, "(error)");
173 return;
174 }
175
176 percentage = (100.0 * nl_attr_get_u32(a[OVS_SAMPLE_ATTR_PROBABILITY])) /
177 UINT32_MAX;
178
179 ds_put_format(ds, "(sample=%.1f%%,", percentage);
180
181 ds_put_cstr(ds, "actions(");
182 nla_acts = nl_attr_get(a[OVS_SAMPLE_ATTR_ACTIONS]);
183 len = nl_attr_get_size(a[OVS_SAMPLE_ATTR_ACTIONS]);
184 format_odp_actions(ds, nla_acts, len);
185 ds_put_format(ds, "))");
186 }
187
188 static const char *
189 slow_path_reason_to_string(uint32_t reason)
190 {
191 switch ((enum slow_path_reason) reason) {
192 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return STRING;
193 SLOW_PATH_REASONS
194 #undef SPR
195 }
196
197 return NULL;
198 }
199
200 const char *
201 slow_path_reason_to_explanation(enum slow_path_reason reason)
202 {
203 switch (reason) {
204 #define SPR(ENUM, STRING, EXPLANATION) case ENUM: return EXPLANATION;
205 SLOW_PATH_REASONS
206 #undef SPR
207 }
208
209 return "<unknown>";
210 }
211
212 static int
213 parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
214 uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask)
215 {
216 uint32_t result = 0;
217 int n;
218
219 /* Parse masked flags in numeric format? */
220 if (res_mask && ovs_scan(s, "%"SCNi32"/%"SCNi32"%n",
221 res_flags, res_mask, &n) && n > 0) {
222 if (*res_flags & ~allowed || *res_mask & ~allowed) {
223 return -EINVAL;
224 }
225 return n;
226 }
227
228 n = 0;
229
230 if (res_mask && (*s == '+' || *s == '-')) {
231 uint32_t flags = 0, mask = 0;
232
233 /* Parse masked flags. */
234 while (s[n] != ')') {
235 bool set;
236 uint32_t bit;
237 int name_len;
238
239 if (s[n] == '+') {
240 set = true;
241 } else if (s[n] == '-') {
242 set = false;
243 } else {
244 return -EINVAL;
245 }
246 n++;
247
248 name_len = strcspn(s + n, "+-)");
249
250 for (bit = 1; bit; bit <<= 1) {
251 const char *fname = bit_to_string(bit);
252 size_t len;
253
254 if (!fname) {
255 continue;
256 }
257
258 len = strlen(fname);
259 if (len != name_len) {
260 continue;
261 }
262 if (!strncmp(s + n, fname, len)) {
263 if (mask & bit) {
264 /* bit already set. */
265 return -EINVAL;
266 }
267 if (!(bit & allowed)) {
268 return -EINVAL;
269 }
270 if (set) {
271 flags |= bit;
272 }
273 mask |= bit;
274 break;
275 }
276 }
277
278 if (!bit) {
279 return -EINVAL; /* Unknown flag name */
280 }
281 s += name_len;
282 }
283
284 *res_flags = flags;
285 *res_mask = mask;
286 return n;
287 }
288
289 /* Parse unmasked flags. If a flag is present, it is set, otherwise
290 * it is not set. */
291 while (s[n] != ')') {
292 unsigned long long int flags;
293 uint32_t bit;
294 int n0;
295
296 if (ovs_scan(&s[n], "%lli%n", &flags, &n0)) {
297 if (flags & ~allowed) {
298 return -EINVAL;
299 }
300 n += n0 + (s[n + n0] == ',');
301 result |= flags;
302 continue;
303 }
304
305 for (bit = 1; bit; bit <<= 1) {
306 const char *name = bit_to_string(bit);
307 size_t len;
308
309 if (!name) {
310 continue;
311 }
312
313 len = strlen(name);
314 if (!strncmp(s + n, name, len) &&
315 (s[n + len] == ',' || s[n + len] == ')')) {
316 if (!(bit & allowed)) {
317 return -EINVAL;
318 }
319 result |= bit;
320 n += len + (s[n + len] == ',');
321 break;
322 }
323 }
324
325 if (!bit) {
326 return -EINVAL;
327 }
328 }
329
330 *res_flags = result;
331 if (res_mask) {
332 *res_mask = UINT32_MAX;
333 }
334 return n;
335 }
336
337 static void
338 format_odp_userspace_action(struct ds *ds, const struct nlattr *attr)
339 {
340 static const struct nl_policy ovs_userspace_policy[] = {
341 [OVS_USERSPACE_ATTR_PID] = { .type = NL_A_U32 },
342 [OVS_USERSPACE_ATTR_USERDATA] = { .type = NL_A_UNSPEC,
343 .optional = true },
344 [OVS_USERSPACE_ATTR_EGRESS_TUN_PORT] = { .type = NL_A_U32,
345 .optional = true },
346 };
347 struct nlattr *a[ARRAY_SIZE(ovs_userspace_policy)];
348 const struct nlattr *userdata_attr;
349 const struct nlattr *tunnel_out_port_attr;
350
351 if (!nl_parse_nested(attr, ovs_userspace_policy, a, ARRAY_SIZE(a))) {
352 ds_put_cstr(ds, "userspace(error)");
353 return;
354 }
355
356 ds_put_format(ds, "userspace(pid=%"PRIu32,
357 nl_attr_get_u32(a[OVS_USERSPACE_ATTR_PID]));
358
359 userdata_attr = a[OVS_USERSPACE_ATTR_USERDATA];
360
361 if (userdata_attr) {
362 const uint8_t *userdata = nl_attr_get(userdata_attr);
363 size_t userdata_len = nl_attr_get_size(userdata_attr);
364 bool userdata_unspec = true;
365 union user_action_cookie cookie;
366
367 if (userdata_len >= sizeof cookie.type
368 && userdata_len <= sizeof cookie) {
369
370 memset(&cookie, 0, sizeof cookie);
371 memcpy(&cookie, userdata, userdata_len);
372
373 userdata_unspec = false;
374
375 if (userdata_len == sizeof cookie.sflow
376 && cookie.type == USER_ACTION_COOKIE_SFLOW) {
377 ds_put_format(ds, ",sFlow("
378 "vid=%"PRIu16",pcp=%"PRIu8",output=%"PRIu32")",
379 vlan_tci_to_vid(cookie.sflow.vlan_tci),
380 vlan_tci_to_pcp(cookie.sflow.vlan_tci),
381 cookie.sflow.output);
382 } else if (userdata_len == sizeof cookie.slow_path
383 && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
384 ds_put_cstr(ds, ",slow_path(");
385 format_flags(ds, slow_path_reason_to_string,
386 cookie.slow_path.reason, ',');
387 ds_put_format(ds, ")");
388 } else if (userdata_len == sizeof cookie.flow_sample
389 && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
390 ds_put_format(ds, ",flow_sample(probability=%"PRIu16
391 ",collector_set_id=%"PRIu32
392 ",obs_domain_id=%"PRIu32
393 ",obs_point_id=%"PRIu32")",
394 cookie.flow_sample.probability,
395 cookie.flow_sample.collector_set_id,
396 cookie.flow_sample.obs_domain_id,
397 cookie.flow_sample.obs_point_id);
398 } else if (userdata_len >= sizeof cookie.ipfix
399 && cookie.type == USER_ACTION_COOKIE_IPFIX) {
400 ds_put_format(ds, ",ipfix(output_port=%"PRIu32")",
401 cookie.ipfix.output_odp_port);
402 } else {
403 userdata_unspec = true;
404 }
405 }
406
407 if (userdata_unspec) {
408 size_t i;
409 ds_put_format(ds, ",userdata(");
410 for (i = 0; i < userdata_len; i++) {
411 ds_put_format(ds, "%02x", userdata[i]);
412 }
413 ds_put_char(ds, ')');
414 }
415 }
416
417 tunnel_out_port_attr = a[OVS_USERSPACE_ATTR_EGRESS_TUN_PORT];
418 if (tunnel_out_port_attr) {
419 ds_put_format(ds, ",tunnel_out_port=%"PRIu32,
420 nl_attr_get_u32(tunnel_out_port_attr));
421 }
422
423 ds_put_char(ds, ')');
424 }
425
426 static void
427 format_vlan_tci(struct ds *ds, ovs_be16 tci, ovs_be16 mask, bool verbose)
428 {
429 if (verbose || vlan_tci_to_vid(tci) || vlan_tci_to_vid(mask)) {
430 ds_put_format(ds, "vid=%"PRIu16, vlan_tci_to_vid(tci));
431 if (vlan_tci_to_vid(mask) != VLAN_VID_MASK) { /* Partially masked. */
432 ds_put_format(ds, "/0x%"PRIx16, vlan_tci_to_vid(mask));
433 };
434 ds_put_char(ds, ',');
435 }
436 if (verbose || vlan_tci_to_pcp(tci) || vlan_tci_to_pcp(mask)) {
437 ds_put_format(ds, "pcp=%d", vlan_tci_to_pcp(tci));
438 if (vlan_tci_to_pcp(mask) != (VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
439 ds_put_format(ds, "/0x%x", vlan_tci_to_pcp(mask));
440 }
441 ds_put_char(ds, ',');
442 }
443 if (!(tci & htons(VLAN_CFI))) {
444 ds_put_cstr(ds, "cfi=0");
445 ds_put_char(ds, ',');
446 }
447 ds_chomp(ds, ',');
448 }
449
450 static void
451 format_mpls_lse(struct ds *ds, ovs_be32 mpls_lse)
452 {
453 ds_put_format(ds, "label=%"PRIu32",tc=%d,ttl=%d,bos=%d",
454 mpls_lse_to_label(mpls_lse),
455 mpls_lse_to_tc(mpls_lse),
456 mpls_lse_to_ttl(mpls_lse),
457 mpls_lse_to_bos(mpls_lse));
458 }
459
460 static void
461 format_mpls(struct ds *ds, const struct ovs_key_mpls *mpls_key,
462 const struct ovs_key_mpls *mpls_mask, int n)
463 {
464 if (n == 1) {
465 ovs_be32 key = mpls_key->mpls_lse;
466
467 if (mpls_mask == NULL) {
468 format_mpls_lse(ds, key);
469 } else {
470 ovs_be32 mask = mpls_mask->mpls_lse;
471
472 ds_put_format(ds, "label=%"PRIu32"/0x%x,tc=%d/%x,ttl=%d/0x%x,bos=%d/%x",
473 mpls_lse_to_label(key), mpls_lse_to_label(mask),
474 mpls_lse_to_tc(key), mpls_lse_to_tc(mask),
475 mpls_lse_to_ttl(key), mpls_lse_to_ttl(mask),
476 mpls_lse_to_bos(key), mpls_lse_to_bos(mask));
477 }
478 } else {
479 int i;
480
481 for (i = 0; i < n; i++) {
482 ds_put_format(ds, "lse%d=%#"PRIx32,
483 i, ntohl(mpls_key[i].mpls_lse));
484 if (mpls_mask) {
485 ds_put_format(ds, "/%#"PRIx32, ntohl(mpls_mask[i].mpls_lse));
486 }
487 ds_put_char(ds, ',');
488 }
489 ds_chomp(ds, ',');
490 }
491 }
492
493 static void
494 format_odp_recirc_action(struct ds *ds, uint32_t recirc_id)
495 {
496 ds_put_format(ds, "recirc(%"PRIu32")", recirc_id);
497 }
498
499 static void
500 format_odp_hash_action(struct ds *ds, const struct ovs_action_hash *hash_act)
501 {
502 ds_put_format(ds, "hash(");
503
504 if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
505 ds_put_format(ds, "hash_l4(%"PRIu32")", hash_act->hash_basis);
506 } else {
507 ds_put_format(ds, "Unknown hash algorithm(%"PRIu32")",
508 hash_act->hash_alg);
509 }
510 ds_put_format(ds, ")");
511 }
512
513 static void
514 format_odp_tnl_push_header(struct ds *ds, struct ovs_action_push_tnl *data)
515 {
516 const struct eth_header *eth;
517 const struct ip_header *ip;
518 const void *l3;
519
520 eth = (const struct eth_header *)data->header;
521
522 l3 = eth + 1;
523 ip = (const struct ip_header *)l3;
524
525 /* Ethernet */
526 ds_put_format(ds, "header(size=%"PRIu8",type=%"PRIu8",eth(dst=",
527 data->header_len, data->tnl_type);
528 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_dst));
529 ds_put_format(ds, ",src=");
530 ds_put_format(ds, ETH_ADDR_FMT, ETH_ADDR_ARGS(eth->eth_src));
531 ds_put_format(ds, ",dl_type=0x%04"PRIx16"),", ntohs(eth->eth_type));
532
533 /* IPv4 */
534 ds_put_format(ds, "ipv4(src="IP_FMT",dst="IP_FMT",proto=%"PRIu8
535 ",tos=%#"PRIx8",ttl=%"PRIu8",frag=0x%"PRIx16"),",
536 IP_ARGS(get_16aligned_be32(&ip->ip_src)),
537 IP_ARGS(get_16aligned_be32(&ip->ip_dst)),
538 ip->ip_proto, ip->ip_tos,
539 ip->ip_ttl,
540 ip->ip_frag_off);
541
542 if (data->tnl_type == OVS_VPORT_TYPE_VXLAN) {
543 const struct vxlanhdr *vxh;
544 const struct udp_header *udp;
545
546 /* UDP */
547 udp = (const struct udp_header *) (ip + 1);
548 ds_put_format(ds, "udp(src=%"PRIu16",dst=%"PRIu16"),",
549 ntohs(udp->udp_src), ntohs(udp->udp_dst));
550
551 /* VxLan */
552 vxh = (const struct vxlanhdr *) (udp + 1);
553 ds_put_format(ds, "vxlan(flags=0x%"PRIx32",vni=0x%"PRIx32")",
554 ntohl(get_16aligned_be32(&vxh->vx_flags)),
555 ntohl(get_16aligned_be32(&vxh->vx_vni)));
556 } else if (data->tnl_type == OVS_VPORT_TYPE_GRE) {
557 const struct gre_base_hdr *greh;
558 ovs_16aligned_be32 *options;
559 void *l4;
560
561 l4 = ((uint8_t *)l3 + sizeof(struct ip_header));
562 greh = (const struct gre_base_hdr *) l4;
563
564 ds_put_format(ds, "gre((flags=0x%"PRIx16",proto=0x%"PRIx16")",
565 greh->flags, ntohs(greh->protocol));
566 options = (ovs_16aligned_be32 *)(greh + 1);
567 if (greh->flags & htons(GRE_CSUM)) {
568 ds_put_format(ds, ",csum=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
569 options++;
570 }
571 if (greh->flags & htons(GRE_KEY)) {
572 ds_put_format(ds, ",key=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
573 options++;
574 }
575 if (greh->flags & htons(GRE_SEQ)) {
576 ds_put_format(ds, ",seq=0x%"PRIx32, ntohl(get_16aligned_be32(options)));
577 options++;
578 }
579 ds_put_format(ds, ")");
580 }
581 ds_put_format(ds, ")");
582 }
583
584 static void
585 format_odp_tnl_push_action(struct ds *ds, const struct nlattr *attr)
586 {
587 struct ovs_action_push_tnl *data;
588
589 data = (struct ovs_action_push_tnl *) nl_attr_get(attr);
590
591 ds_put_format(ds, "tnl_push(tnl_port(%"PRIu32"),", data->tnl_port);
592 format_odp_tnl_push_header(ds, data);
593 ds_put_format(ds, ",out_port(%"PRIu32"))", data->out_port);
594 }
595
596 static void
597 format_odp_action(struct ds *ds, const struct nlattr *a)
598 {
599 int expected_len;
600 enum ovs_action_attr type = nl_attr_type(a);
601 const struct ovs_action_push_vlan *vlan;
602 size_t size;
603
604 expected_len = odp_action_len(nl_attr_type(a));
605 if (expected_len != -2 && nl_attr_get_size(a) != expected_len) {
606 ds_put_format(ds, "bad length %"PRIuSIZE", expected %d for: ",
607 nl_attr_get_size(a), expected_len);
608 format_generic_odp_action(ds, a);
609 return;
610 }
611
612 switch (type) {
613 case OVS_ACTION_ATTR_OUTPUT:
614 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
615 break;
616 case OVS_ACTION_ATTR_TUNNEL_POP:
617 ds_put_format(ds, "tnl_pop(%"PRIu32")", nl_attr_get_u32(a));
618 break;
619 case OVS_ACTION_ATTR_TUNNEL_PUSH:
620 format_odp_tnl_push_action(ds, a);
621 break;
622 case OVS_ACTION_ATTR_USERSPACE:
623 format_odp_userspace_action(ds, a);
624 break;
625 case OVS_ACTION_ATTR_RECIRC:
626 format_odp_recirc_action(ds, nl_attr_get_u32(a));
627 break;
628 case OVS_ACTION_ATTR_HASH:
629 format_odp_hash_action(ds, nl_attr_get(a));
630 break;
631 case OVS_ACTION_ATTR_SET_MASKED:
632 a = nl_attr_get(a);
633 size = nl_attr_get_size(a) / 2;
634 ds_put_cstr(ds, "set(");
635
636 /* Masked set action not supported for tunnel key, which is bigger. */
637 if (size <= sizeof(struct ovs_key_ipv6)) {
638 struct nlattr attr[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
639 sizeof(struct nlattr))];
640 struct nlattr mask[1 + DIV_ROUND_UP(sizeof(struct ovs_key_ipv6),
641 sizeof(struct nlattr))];
642
643 mask->nla_type = attr->nla_type = nl_attr_type(a);
644 mask->nla_len = attr->nla_len = NLA_HDRLEN + size;
645 memcpy(attr + 1, (char *)(a + 1), size);
646 memcpy(mask + 1, (char *)(a + 1) + size, size);
647 format_odp_key_attr(attr, mask, NULL, ds, false);
648 } else {
649 format_odp_key_attr(a, NULL, NULL, ds, false);
650 }
651 ds_put_cstr(ds, ")");
652 break;
653 case OVS_ACTION_ATTR_SET:
654 ds_put_cstr(ds, "set(");
655 format_odp_key_attr(nl_attr_get(a), NULL, NULL, ds, true);
656 ds_put_cstr(ds, ")");
657 break;
658 case OVS_ACTION_ATTR_PUSH_VLAN:
659 vlan = nl_attr_get(a);
660 ds_put_cstr(ds, "push_vlan(");
661 if (vlan->vlan_tpid != htons(ETH_TYPE_VLAN)) {
662 ds_put_format(ds, "tpid=0x%04"PRIx16",", ntohs(vlan->vlan_tpid));
663 }
664 format_vlan_tci(ds, vlan->vlan_tci, OVS_BE16_MAX, false);
665 ds_put_char(ds, ')');
666 break;
667 case OVS_ACTION_ATTR_POP_VLAN:
668 ds_put_cstr(ds, "pop_vlan");
669 break;
670 case OVS_ACTION_ATTR_PUSH_MPLS: {
671 const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
672 ds_put_cstr(ds, "push_mpls(");
673 format_mpls_lse(ds, mpls->mpls_lse);
674 ds_put_format(ds, ",eth_type=0x%"PRIx16")", ntohs(mpls->mpls_ethertype));
675 break;
676 }
677 case OVS_ACTION_ATTR_POP_MPLS: {
678 ovs_be16 ethertype = nl_attr_get_be16(a);
679 ds_put_format(ds, "pop_mpls(eth_type=0x%"PRIx16")", ntohs(ethertype));
680 break;
681 }
682 case OVS_ACTION_ATTR_SAMPLE:
683 format_odp_sample_action(ds, a);
684 break;
685 case OVS_ACTION_ATTR_UNSPEC:
686 case __OVS_ACTION_ATTR_MAX:
687 default:
688 format_generic_odp_action(ds, a);
689 break;
690 }
691 }
692
693 void
694 format_odp_actions(struct ds *ds, const struct nlattr *actions,
695 size_t actions_len)
696 {
697 if (actions_len) {
698 const struct nlattr *a;
699 unsigned int left;
700
701 NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
702 if (a != actions) {
703 ds_put_char(ds, ',');
704 }
705 format_odp_action(ds, a);
706 }
707 if (left) {
708 int i;
709
710 if (left == actions_len) {
711 ds_put_cstr(ds, "<empty>");
712 }
713 ds_put_format(ds, ",***%u leftover bytes*** (", left);
714 for (i = 0; i < left; i++) {
715 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
716 }
717 ds_put_char(ds, ')');
718 }
719 } else {
720 ds_put_cstr(ds, "drop");
721 }
722 }
723
724 /* Separate out parse_odp_userspace_action() function. */
725 static int
726 parse_odp_userspace_action(const char *s, struct ofpbuf *actions)
727 {
728 uint32_t pid;
729 union user_action_cookie cookie;
730 struct ofpbuf buf;
731 odp_port_t tunnel_out_port;
732 int n = -1;
733 void *user_data = NULL;
734 size_t user_data_size = 0;
735
736 if (!ovs_scan(s, "userspace(pid=%"SCNi32"%n", &pid, &n)) {
737 return -EINVAL;
738 }
739
740 {
741 uint32_t output;
742 uint32_t probability;
743 uint32_t collector_set_id;
744 uint32_t obs_domain_id;
745 uint32_t obs_point_id;
746 int vid, pcp;
747 int n1 = -1;
748 if (ovs_scan(&s[n], ",sFlow(vid=%i,"
749 "pcp=%i,output=%"SCNi32")%n",
750 &vid, &pcp, &output, &n1)) {
751 uint16_t tci;
752
753 n += n1;
754 tci = vid | (pcp << VLAN_PCP_SHIFT);
755 if (tci) {
756 tci |= VLAN_CFI;
757 }
758
759 cookie.type = USER_ACTION_COOKIE_SFLOW;
760 cookie.sflow.vlan_tci = htons(tci);
761 cookie.sflow.output = output;
762 user_data = &cookie;
763 user_data_size = sizeof cookie.sflow;
764 } else if (ovs_scan(&s[n], ",slow_path(%n",
765 &n1)) {
766 int res;
767
768 n += n1;
769 cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
770 cookie.slow_path.unused = 0;
771 cookie.slow_path.reason = 0;
772
773 res = parse_flags(&s[n], slow_path_reason_to_string,
774 &cookie.slow_path.reason,
775 SLOW_PATH_REASON_MASK, NULL);
776 if (res < 0 || s[n + res] != ')') {
777 return res;
778 }
779 n += res + 1;
780
781 user_data = &cookie;
782 user_data_size = sizeof cookie.slow_path;
783 } else if (ovs_scan(&s[n], ",flow_sample(probability=%"SCNi32","
784 "collector_set_id=%"SCNi32","
785 "obs_domain_id=%"SCNi32","
786 "obs_point_id=%"SCNi32")%n",
787 &probability, &collector_set_id,
788 &obs_domain_id, &obs_point_id, &n1)) {
789 n += n1;
790
791 cookie.type = USER_ACTION_COOKIE_FLOW_SAMPLE;
792 cookie.flow_sample.probability = probability;
793 cookie.flow_sample.collector_set_id = collector_set_id;
794 cookie.flow_sample.obs_domain_id = obs_domain_id;
795 cookie.flow_sample.obs_point_id = obs_point_id;
796 user_data = &cookie;
797 user_data_size = sizeof cookie.flow_sample;
798 } else if (ovs_scan(&s[n], ",ipfix(output_port=%"SCNi32")%n",
799 &output, &n1) ) {
800 n += n1;
801 cookie.type = USER_ACTION_COOKIE_IPFIX;
802 cookie.ipfix.output_odp_port = u32_to_odp(output);
803 user_data = &cookie;
804 user_data_size = sizeof cookie.ipfix;
805 } else if (ovs_scan(&s[n], ",userdata(%n",
806 &n1)) {
807 char *end;
808
809 n += n1;
810 ofpbuf_init(&buf, 16);
811 end = ofpbuf_put_hex(&buf, &s[n], NULL);
812 if (end[0] != ')') {
813 return -EINVAL;
814 }
815 user_data = ofpbuf_data(&buf);
816 user_data_size = ofpbuf_size(&buf);
817 n = (end + 1) - s;
818 }
819 }
820
821 {
822 int n1 = -1;
823 if (ovs_scan(&s[n], ",tunnel_out_port=%"SCNi32")%n",
824 &tunnel_out_port, &n1)) {
825 odp_put_userspace_action(pid, user_data, user_data_size, tunnel_out_port, actions);
826 return n + n1;
827 } else if (s[n] == ')') {
828 odp_put_userspace_action(pid, user_data, user_data_size, ODPP_NONE, actions);
829 return n + 1;
830 }
831 }
832
833 return -EINVAL;
834 }
835
836 static int
837 ovs_parse_tnl_push(const char *s, struct ovs_action_push_tnl *data)
838 {
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, dl_type, udp_src, udp_dst;
844 ovs_be32 sip, dip;
845 uint32_t tnl_type = 0, header_len = 0;
846 void *l3, *l4;
847 int n = 0;
848
849 if (!ovs_scan_len(s, &n, "tnl_push(tnl_port(%"SCNi32"),", &data->tnl_port)) {
850 return -EINVAL;
851 }
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",",
858 &data->header_len,
859 &data->tnl_type,
860 ETH_ADDR_SCAN_ARGS(eth->eth_dst))) {
861 return -EINVAL;
862 }
863
864 if (!ovs_scan_len(s, &n, "src="ETH_ADDR_SCAN_FMT",",
865 ETH_ADDR_SCAN_ARGS(eth->eth_src))) {
866 return -EINVAL;
867 }
868 if (!ovs_scan_len(s, &n, "dl_type=0x%"SCNx16"),", &dl_type)) {
869 return -EINVAL;
870 }
871 eth->eth_type = htons(dl_type);
872
873 /* IPv4 */
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"),",
876 IP_SCAN_ARGS(&sip),
877 IP_SCAN_ARGS(&dip),
878 &ip->ip_proto, &ip->ip_tos,
879 &ip->ip_ttl, &ip->ip_frag_off)) {
880 return -EINVAL;
881 }
882 put_16aligned_be32(&ip->ip_src, sip);
883 put_16aligned_be32(&ip->ip_dst, dip);
884
885 /* Tunnel header */
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"),",
889 &udp_src, &udp_dst)) {
890 struct vxlanhdr *vxh;
891 uint32_t vx_flags, vx_vni;
892
893 udp->udp_src = htons(udp_src);
894 udp->udp_dst = htons(udp_dst);
895 udp->udp_len = 0;
896 udp->udp_csum = 0;
897
898 vxh = (struct vxlanhdr *) (udp + 1);
899 if (!ovs_scan_len(s, &n, "vxlan(flags=0x%"SCNx32",vni=0x%"SCNx32"))",
900 &vx_flags, &vx_vni)) {
901 return -EINVAL;
902 }
903 put_16aligned_be32(&vxh->vx_flags, htonl(vx_flags));
904 put_16aligned_be32(&vxh->vx_vni, htonl(vx_vni));
905 tnl_type = OVS_VPORT_TYPE_VXLAN;
906 header_len = sizeof *eth + sizeof *ip +
907 sizeof *udp + sizeof *vxh;
908 } else if (ovs_scan_len(s, &n, "gre((flags=0x%"SCNx16",proto=0x%"SCNx16")",
909 &greh->flags, &gre_proto)){
910
911 tnl_type = OVS_VPORT_TYPE_GRE;
912 greh->protocol = htons(gre_proto);
913 ovs_16aligned_be32 *options = (ovs_16aligned_be32 *) (greh + 1);
914
915 if (greh->flags & htons(GRE_CSUM)) {
916 uint32_t csum;
917
918 if (!ovs_scan_len(s, &n, ",csum=0x%"SCNx32, &csum)) {
919 return -EINVAL;
920 }
921 put_16aligned_be32(options, htonl(csum));
922 options++;
923 }
924 if (greh->flags & htons(GRE_KEY)) {
925 uint32_t key;
926
927 if (!ovs_scan_len(s, &n, ",key=0x%"SCNx32, &key)) {
928 return -EINVAL;
929 }
930
931 put_16aligned_be32(options, htonl(key));
932 options++;
933 }
934 if (greh->flags & htons(GRE_SEQ)) {
935 uint32_t seq;
936
937 if (!ovs_scan_len(s, &n, ",seq=0x%"SCNx32, &seq)) {
938 return -EINVAL;
939 }
940 put_16aligned_be32(options, htonl(seq));
941 options++;
942 }
943
944 if (!ovs_scan_len(s, &n, "))")) {
945 return -EINVAL;
946 }
947
948 header_len = sizeof *eth + sizeof *ip +
949 ((uint8_t *) options - (uint8_t *) greh);
950 } else {
951 return -EINVAL;
952 }
953
954 /* check tunnel meta data. */
955 if (data->tnl_type != tnl_type) {
956 return -EINVAL;
957 }
958 if (data->header_len != header_len) {
959 return -EINVAL;
960 }
961
962 /* Out port */
963 if (!ovs_scan_len(s, &n, ",out_port(%"SCNi32"))", &data->out_port)) {
964 return -EINVAL;
965 }
966
967 return n;
968 }
969
970 static int
971 parse_odp_action(const char *s, const struct simap *port_names,
972 struct ofpbuf *actions)
973 {
974 {
975 uint32_t port;
976 int n;
977
978 if (ovs_scan(s, "%"SCNi32"%n", &port, &n)) {
979 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, port);
980 return n;
981 }
982 }
983
984 if (port_names) {
985 int len = strcspn(s, delimiters);
986 struct simap_node *node;
987
988 node = simap_find_len(port_names, s, len);
989 if (node) {
990 nl_msg_put_u32(actions, OVS_ACTION_ATTR_OUTPUT, node->data);
991 return len;
992 }
993 }
994
995 {
996 uint32_t recirc_id;
997 int n = -1;
998
999 if (ovs_scan(s, "recirc(%"PRIu32")%n", &recirc_id, &n)) {
1000 nl_msg_put_u32(actions, OVS_ACTION_ATTR_RECIRC, recirc_id);
1001 return n;
1002 }
1003 }
1004
1005 if (!strncmp(s, "userspace(", 10)) {
1006 return parse_odp_userspace_action(s, actions);
1007 }
1008
1009 if (!strncmp(s, "set(", 4)) {
1010 size_t start_ofs;
1011 int retval;
1012 struct nlattr mask[128 / sizeof(struct nlattr)];
1013 struct ofpbuf maskbuf;
1014 struct nlattr *nested, *key;
1015 size_t size;
1016
1017 /* 'mask' is big enough to hold any key. */
1018 ofpbuf_use_stack(&maskbuf, mask, sizeof mask);
1019
1020 start_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SET);
1021 retval = parse_odp_key_mask_attr(s + 4, port_names, actions, &maskbuf);
1022 if (retval < 0) {
1023 return retval;
1024 }
1025 if (s[retval + 4] != ')') {
1026 return -EINVAL;
1027 }
1028
1029 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1030 key = nested + 1;
1031
1032 size = nl_attr_get_size(mask);
1033 if (size == nl_attr_get_size(key)) {
1034 /* Change to masked set action if not fully masked. */
1035 if (!is_all_ones(mask + 1, size)) {
1036 key->nla_len += size;
1037 ofpbuf_put(actions, mask + 1, size);
1038 /* 'actions' may have been reallocated by ofpbuf_put(). */
1039 nested = ofpbuf_at_assert(actions, start_ofs, sizeof *nested);
1040 nested->nla_type = OVS_ACTION_ATTR_SET_MASKED;
1041 }
1042 }
1043
1044 nl_msg_end_nested(actions, start_ofs);
1045 return retval + 5;
1046 }
1047
1048 {
1049 struct ovs_action_push_vlan push;
1050 int tpid = ETH_TYPE_VLAN;
1051 int vid, pcp;
1052 int cfi = 1;
1053 int n = -1;
1054
1055 if (ovs_scan(s, "push_vlan(vid=%i,pcp=%i)%n", &vid, &pcp, &n)
1056 || ovs_scan(s, "push_vlan(vid=%i,pcp=%i,cfi=%i)%n",
1057 &vid, &pcp, &cfi, &n)
1058 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i)%n",
1059 &tpid, &vid, &pcp, &n)
1060 || ovs_scan(s, "push_vlan(tpid=%i,vid=%i,pcp=%i,cfi=%i)%n",
1061 &tpid, &vid, &pcp, &cfi, &n)) {
1062 push.vlan_tpid = htons(tpid);
1063 push.vlan_tci = htons((vid << VLAN_VID_SHIFT)
1064 | (pcp << VLAN_PCP_SHIFT)
1065 | (cfi ? VLAN_CFI : 0));
1066 nl_msg_put_unspec(actions, OVS_ACTION_ATTR_PUSH_VLAN,
1067 &push, sizeof push);
1068
1069 return n;
1070 }
1071 }
1072
1073 if (!strncmp(s, "pop_vlan", 8)) {
1074 nl_msg_put_flag(actions, OVS_ACTION_ATTR_POP_VLAN);
1075 return 8;
1076 }
1077
1078 {
1079 double percentage;
1080 int n = -1;
1081
1082 if (ovs_scan(s, "sample(sample=%lf%%,actions(%n", &percentage, &n)
1083 && percentage >= 0. && percentage <= 100.0) {
1084 size_t sample_ofs, actions_ofs;
1085 double probability;
1086
1087 probability = floor(UINT32_MAX * (percentage / 100.0) + .5);
1088 sample_ofs = nl_msg_start_nested(actions, OVS_ACTION_ATTR_SAMPLE);
1089 nl_msg_put_u32(actions, OVS_SAMPLE_ATTR_PROBABILITY,
1090 (probability <= 0 ? 0
1091 : probability >= UINT32_MAX ? UINT32_MAX
1092 : probability));
1093
1094 actions_ofs = nl_msg_start_nested(actions,
1095 OVS_SAMPLE_ATTR_ACTIONS);
1096 for (;;) {
1097 int retval;
1098
1099 n += strspn(s + n, delimiters);
1100 if (s[n] == ')') {
1101 break;
1102 }
1103
1104 retval = parse_odp_action(s + n, port_names, actions);
1105 if (retval < 0) {
1106 return retval;
1107 }
1108 n += retval;
1109 }
1110 nl_msg_end_nested(actions, actions_ofs);
1111 nl_msg_end_nested(actions, sample_ofs);
1112
1113 return s[n + 1] == ')' ? n + 2 : -EINVAL;
1114 }
1115 }
1116
1117 {
1118 uint32_t port;
1119 int n;
1120
1121 if (ovs_scan(s, "tnl_pop(%"SCNi32")%n", &port, &n)) {
1122 nl_msg_put_u32(actions, OVS_ACTION_ATTR_TUNNEL_POP, port);
1123 return n;
1124 }
1125 }
1126
1127 {
1128 struct ovs_action_push_tnl data;
1129 int n;
1130
1131 n = ovs_parse_tnl_push(s, &data);
1132 if (n > 0) {
1133 odp_put_tnl_push_action(actions, &data);
1134 return n;
1135 } else if (n < 0) {
1136 return n;
1137 }
1138 }
1139 return -EINVAL;
1140 }
1141
1142 /* Parses the string representation of datapath actions, in the format output
1143 * by format_odp_action(). Returns 0 if successful, otherwise a positive errno
1144 * value. On success, the ODP actions are appended to 'actions' as a series of
1145 * Netlink attributes. On failure, no data is appended to 'actions'. Either
1146 * way, 'actions''s data might be reallocated. */
1147 int
1148 odp_actions_from_string(const char *s, const struct simap *port_names,
1149 struct ofpbuf *actions)
1150 {
1151 size_t old_size;
1152
1153 if (!strcasecmp(s, "drop")) {
1154 return 0;
1155 }
1156
1157 old_size = ofpbuf_size(actions);
1158 for (;;) {
1159 int retval;
1160
1161 s += strspn(s, delimiters);
1162 if (!*s) {
1163 return 0;
1164 }
1165
1166 retval = parse_odp_action(s, port_names, actions);
1167 if (retval < 0 || !strchr(delimiters, s[retval])) {
1168 ofpbuf_set_size(actions, old_size);
1169 return -retval;
1170 }
1171 s += retval;
1172 }
1173
1174 return 0;
1175 }
1176 \f
1177 /* Returns the correct length of the payload for a flow key attribute of the
1178 * specified 'type', -1 if 'type' is unknown, or -2 if the attribute's payload
1179 * is variable length. */
1180 static int
1181 odp_flow_key_attr_len(uint16_t type)
1182 {
1183 if (type > OVS_KEY_ATTR_MAX) {
1184 return -1;
1185 }
1186
1187 switch ((enum ovs_key_attr) type) {
1188 case OVS_KEY_ATTR_ENCAP: return -2;
1189 case OVS_KEY_ATTR_PRIORITY: return 4;
1190 case OVS_KEY_ATTR_SKB_MARK: return 4;
1191 case OVS_KEY_ATTR_DP_HASH: return 4;
1192 case OVS_KEY_ATTR_RECIRC_ID: return 4;
1193 case OVS_KEY_ATTR_TUNNEL: return -2;
1194 case OVS_KEY_ATTR_IN_PORT: return 4;
1195 case OVS_KEY_ATTR_ETHERNET: return sizeof(struct ovs_key_ethernet);
1196 case OVS_KEY_ATTR_VLAN: return sizeof(ovs_be16);
1197 case OVS_KEY_ATTR_ETHERTYPE: return 2;
1198 case OVS_KEY_ATTR_MPLS: return -2;
1199 case OVS_KEY_ATTR_IPV4: return sizeof(struct ovs_key_ipv4);
1200 case OVS_KEY_ATTR_IPV6: return sizeof(struct ovs_key_ipv6);
1201 case OVS_KEY_ATTR_TCP: return sizeof(struct ovs_key_tcp);
1202 case OVS_KEY_ATTR_TCP_FLAGS: return 2;
1203 case OVS_KEY_ATTR_UDP: return sizeof(struct ovs_key_udp);
1204 case OVS_KEY_ATTR_SCTP: return sizeof(struct ovs_key_sctp);
1205 case OVS_KEY_ATTR_ICMP: return sizeof(struct ovs_key_icmp);
1206 case OVS_KEY_ATTR_ICMPV6: return sizeof(struct ovs_key_icmpv6);
1207 case OVS_KEY_ATTR_ARP: return sizeof(struct ovs_key_arp);
1208 case OVS_KEY_ATTR_ND: return sizeof(struct ovs_key_nd);
1209
1210 case OVS_KEY_ATTR_UNSPEC:
1211 case __OVS_KEY_ATTR_MAX:
1212 return -1;
1213 }
1214
1215 return -1;
1216 }
1217
1218 static void
1219 format_generic_odp_key(const struct nlattr *a, struct ds *ds)
1220 {
1221 size_t len = nl_attr_get_size(a);
1222 if (len) {
1223 const uint8_t *unspec;
1224 unsigned int i;
1225
1226 unspec = nl_attr_get(a);
1227 for (i = 0; i < len; i++) {
1228 if (i) {
1229 ds_put_char(ds, ' ');
1230 }
1231 ds_put_format(ds, "%02x", unspec[i]);
1232 }
1233 }
1234 }
1235
1236 static const char *
1237 ovs_frag_type_to_string(enum ovs_frag_type type)
1238 {
1239 switch (type) {
1240 case OVS_FRAG_TYPE_NONE:
1241 return "no";
1242 case OVS_FRAG_TYPE_FIRST:
1243 return "first";
1244 case OVS_FRAG_TYPE_LATER:
1245 return "later";
1246 case __OVS_FRAG_TYPE_MAX:
1247 default:
1248 return "<error>";
1249 }
1250 }
1251
1252 static int
1253 tunnel_key_attr_len(int type)
1254 {
1255 switch (type) {
1256 case OVS_TUNNEL_KEY_ATTR_ID: return 8;
1257 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC: return 4;
1258 case OVS_TUNNEL_KEY_ATTR_IPV4_DST: return 4;
1259 case OVS_TUNNEL_KEY_ATTR_TOS: return 1;
1260 case OVS_TUNNEL_KEY_ATTR_TTL: return 1;
1261 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT: return 0;
1262 case OVS_TUNNEL_KEY_ATTR_CSUM: return 0;
1263 case OVS_TUNNEL_KEY_ATTR_TP_SRC: return 2;
1264 case OVS_TUNNEL_KEY_ATTR_TP_DST: return 2;
1265 case OVS_TUNNEL_KEY_ATTR_OAM: return 0;
1266 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS: return -2;
1267 case __OVS_TUNNEL_KEY_ATTR_MAX:
1268 return -1;
1269 }
1270 return -1;
1271 }
1272
1273 #define GENEVE_OPT(class, type) ((OVS_FORCE uint32_t)(class) << 8 | (type))
1274 static int
1275 parse_geneve_opts(const struct nlattr *attr)
1276 {
1277 int opts_len = nl_attr_get_size(attr);
1278 const struct geneve_opt *opt = nl_attr_get(attr);
1279
1280 while (opts_len > 0) {
1281 int len;
1282
1283 if (opts_len < sizeof(*opt)) {
1284 return -EINVAL;
1285 }
1286
1287 len = sizeof(*opt) + opt->length * 4;
1288 if (len > opts_len) {
1289 return -EINVAL;
1290 }
1291
1292 switch (GENEVE_OPT(opt->opt_class, opt->type)) {
1293 default:
1294 if (opt->type & GENEVE_CRIT_OPT_TYPE) {
1295 return -EINVAL;
1296 }
1297 };
1298
1299 opt = opt + len / sizeof(*opt);
1300 opts_len -= len;
1301 };
1302
1303 return 0;
1304 }
1305
1306 enum odp_key_fitness
1307 odp_tun_key_from_attr(const struct nlattr *attr, struct flow_tnl *tun)
1308 {
1309 unsigned int left;
1310 const struct nlattr *a;
1311 bool ttl = false;
1312 bool unknown = false;
1313
1314 NL_NESTED_FOR_EACH(a, left, attr) {
1315 uint16_t type = nl_attr_type(a);
1316 size_t len = nl_attr_get_size(a);
1317 int expected_len = tunnel_key_attr_len(type);
1318
1319 if (len != expected_len && expected_len >= 0) {
1320 return ODP_FIT_ERROR;
1321 }
1322
1323 switch (type) {
1324 case OVS_TUNNEL_KEY_ATTR_ID:
1325 tun->tun_id = nl_attr_get_be64(a);
1326 tun->flags |= FLOW_TNL_F_KEY;
1327 break;
1328 case OVS_TUNNEL_KEY_ATTR_IPV4_SRC:
1329 tun->ip_src = nl_attr_get_be32(a);
1330 break;
1331 case OVS_TUNNEL_KEY_ATTR_IPV4_DST:
1332 tun->ip_dst = nl_attr_get_be32(a);
1333 break;
1334 case OVS_TUNNEL_KEY_ATTR_TOS:
1335 tun->ip_tos = nl_attr_get_u8(a);
1336 break;
1337 case OVS_TUNNEL_KEY_ATTR_TTL:
1338 tun->ip_ttl = nl_attr_get_u8(a);
1339 ttl = true;
1340 break;
1341 case OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT:
1342 tun->flags |= FLOW_TNL_F_DONT_FRAGMENT;
1343 break;
1344 case OVS_TUNNEL_KEY_ATTR_CSUM:
1345 tun->flags |= FLOW_TNL_F_CSUM;
1346 break;
1347 case OVS_TUNNEL_KEY_ATTR_TP_SRC:
1348 tun->tp_src = nl_attr_get_be16(a);
1349 break;
1350 case OVS_TUNNEL_KEY_ATTR_TP_DST:
1351 tun->tp_dst = nl_attr_get_be16(a);
1352 break;
1353 case OVS_TUNNEL_KEY_ATTR_OAM:
1354 tun->flags |= FLOW_TNL_F_OAM;
1355 break;
1356 case OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS: {
1357 if (parse_geneve_opts(a)) {
1358 return ODP_FIT_ERROR;
1359 }
1360 /* It is necessary to reproduce options exactly (including order)
1361 * so it's easiest to just echo them back. */
1362 unknown = true;
1363 break;
1364 }
1365 default:
1366 /* Allow this to show up as unexpected, if there are unknown
1367 * tunnel attribute, eventually resulting in ODP_FIT_TOO_MUCH. */
1368 unknown = true;
1369 break;
1370 }
1371 }
1372
1373 if (!ttl) {
1374 return ODP_FIT_ERROR;
1375 }
1376 if (unknown) {
1377 return ODP_FIT_TOO_MUCH;
1378 }
1379 return ODP_FIT_PERFECT;
1380 }
1381
1382 static void
1383 tun_key_to_attr(struct ofpbuf *a, const struct flow_tnl *tun_key)
1384 {
1385 size_t tun_key_ofs;
1386
1387 tun_key_ofs = nl_msg_start_nested(a, OVS_KEY_ATTR_TUNNEL);
1388
1389 /* tun_id != 0 without FLOW_TNL_F_KEY is valid if tun_key is a mask. */
1390 if (tun_key->tun_id || tun_key->flags & FLOW_TNL_F_KEY) {
1391 nl_msg_put_be64(a, OVS_TUNNEL_KEY_ATTR_ID, tun_key->tun_id);
1392 }
1393 if (tun_key->ip_src) {
1394 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_SRC, tun_key->ip_src);
1395 }
1396 if (tun_key->ip_dst) {
1397 nl_msg_put_be32(a, OVS_TUNNEL_KEY_ATTR_IPV4_DST, tun_key->ip_dst);
1398 }
1399 if (tun_key->ip_tos) {
1400 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TOS, tun_key->ip_tos);
1401 }
1402 nl_msg_put_u8(a, OVS_TUNNEL_KEY_ATTR_TTL, tun_key->ip_ttl);
1403 if (tun_key->flags & FLOW_TNL_F_DONT_FRAGMENT) {
1404 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT);
1405 }
1406 if (tun_key->flags & FLOW_TNL_F_CSUM) {
1407 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_CSUM);
1408 }
1409 if (tun_key->tp_src) {
1410 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_SRC, tun_key->tp_src);
1411 }
1412 if (tun_key->tp_dst) {
1413 nl_msg_put_be16(a, OVS_TUNNEL_KEY_ATTR_TP_DST, tun_key->tp_dst);
1414 }
1415 if (tun_key->flags & FLOW_TNL_F_OAM) {
1416 nl_msg_put_flag(a, OVS_TUNNEL_KEY_ATTR_OAM);
1417 }
1418
1419 nl_msg_end_nested(a, tun_key_ofs);
1420 }
1421
1422 static bool
1423 odp_mask_attr_is_wildcard(const struct nlattr *ma)
1424 {
1425 return is_all_zeros(nl_attr_get(ma), nl_attr_get_size(ma));
1426 }
1427
1428 static bool
1429 odp_mask_is_exact(enum ovs_key_attr attr, const void *mask, size_t size)
1430 {
1431 if (attr == OVS_KEY_ATTR_TCP_FLAGS) {
1432 return TCP_FLAGS(*(ovs_be16 *)mask) == TCP_FLAGS(OVS_BE16_MAX);
1433 }
1434 if (attr == OVS_KEY_ATTR_IPV6) {
1435 const struct ovs_key_ipv6 *ipv6_mask = mask;
1436
1437 return
1438 ((ipv6_mask->ipv6_label & htonl(IPV6_LABEL_MASK))
1439 == htonl(IPV6_LABEL_MASK))
1440 && ipv6_mask->ipv6_proto == UINT8_MAX
1441 && ipv6_mask->ipv6_tclass == UINT8_MAX
1442 && ipv6_mask->ipv6_hlimit == UINT8_MAX
1443 && ipv6_mask->ipv6_frag == UINT8_MAX
1444 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_src)
1445 && ipv6_mask_is_exact((const struct in6_addr *)ipv6_mask->ipv6_dst);
1446 }
1447 if (attr == OVS_KEY_ATTR_TUNNEL) {
1448 const struct flow_tnl *tun_mask = mask;
1449
1450 return tun_mask->flags == FLOW_TNL_F_MASK
1451 && tun_mask->tun_id == OVS_BE64_MAX
1452 && tun_mask->ip_src == OVS_BE32_MAX
1453 && tun_mask->ip_dst == OVS_BE32_MAX
1454 && tun_mask->ip_tos == UINT8_MAX
1455 && tun_mask->ip_ttl == UINT8_MAX
1456 && tun_mask->tp_src == OVS_BE16_MAX
1457 && tun_mask->tp_dst == OVS_BE16_MAX;
1458 }
1459
1460 if (attr == OVS_KEY_ATTR_ARP) {
1461 /* ARP key has padding, ignore it. */
1462 BUILD_ASSERT_DECL(sizeof(struct ovs_key_arp) == 24);
1463 BUILD_ASSERT_DECL(offsetof(struct ovs_key_arp, arp_tha) == 10 + 6);
1464 size = offsetof(struct ovs_key_arp, arp_tha) + ETH_ADDR_LEN;
1465 ovs_assert(((uint16_t *)mask)[size/2] == 0);
1466 }
1467
1468 return is_all_ones(mask, size);
1469 }
1470
1471 static bool
1472 odp_mask_attr_is_exact(const struct nlattr *ma)
1473 {
1474 struct flow_tnl tun_mask;
1475 enum ovs_key_attr attr = nl_attr_type(ma);
1476 const void *mask;
1477 size_t size;
1478
1479 if (attr == OVS_KEY_ATTR_TUNNEL) {
1480 memset(&tun_mask, 0, sizeof tun_mask);
1481 odp_tun_key_from_attr(ma, &tun_mask);
1482 mask = &tun_mask;
1483 size = sizeof tun_mask;
1484 } else {
1485 mask = nl_attr_get(ma);
1486 size = nl_attr_get_size(ma);
1487 }
1488
1489 return odp_mask_is_exact(attr, mask, size);
1490 }
1491
1492 void
1493 odp_portno_names_set(struct hmap *portno_names, odp_port_t port_no,
1494 char *port_name)
1495 {
1496 struct odp_portno_names *odp_portno_names;
1497
1498 odp_portno_names = xmalloc(sizeof *odp_portno_names);
1499 odp_portno_names->port_no = port_no;
1500 odp_portno_names->name = xstrdup(port_name);
1501 hmap_insert(portno_names, &odp_portno_names->hmap_node,
1502 hash_odp_port(port_no));
1503 }
1504
1505 static char *
1506 odp_portno_names_get(const struct hmap *portno_names, odp_port_t port_no)
1507 {
1508 struct odp_portno_names *odp_portno_names;
1509
1510 HMAP_FOR_EACH_IN_BUCKET (odp_portno_names, hmap_node,
1511 hash_odp_port(port_no), portno_names) {
1512 if (odp_portno_names->port_no == port_no) {
1513 return odp_portno_names->name;
1514 }
1515 }
1516 return NULL;
1517 }
1518
1519 void
1520 odp_portno_names_destroy(struct hmap *portno_names)
1521 {
1522 struct odp_portno_names *odp_portno_names, *odp_portno_names_next;
1523 HMAP_FOR_EACH_SAFE (odp_portno_names, odp_portno_names_next,
1524 hmap_node, portno_names) {
1525 hmap_remove(portno_names, &odp_portno_names->hmap_node);
1526 free(odp_portno_names->name);
1527 free(odp_portno_names);
1528 }
1529 }
1530
1531 /* Format helpers. */
1532
1533 static void
1534 format_eth(struct ds *ds, const char *name, const uint8_t key[ETH_ADDR_LEN],
1535 const uint8_t (*mask)[ETH_ADDR_LEN], bool verbose)
1536 {
1537 bool mask_empty = mask && eth_addr_is_zero(*mask);
1538
1539 if (verbose || !mask_empty) {
1540 bool mask_full = !mask || eth_mask_is_exact(*mask);
1541
1542 if (mask_full) {
1543 ds_put_format(ds, "%s="ETH_ADDR_FMT",", name, ETH_ADDR_ARGS(key));
1544 } else {
1545 ds_put_format(ds, "%s=", name);
1546 eth_format_masked(key, *mask, ds);
1547 ds_put_char(ds, ',');
1548 }
1549 }
1550 }
1551
1552 static void
1553 format_be64(struct ds *ds, const char *name, ovs_be64 key,
1554 const ovs_be64 *mask, bool verbose)
1555 {
1556 bool mask_empty = mask && !*mask;
1557
1558 if (verbose || !mask_empty) {
1559 bool mask_full = !mask || *mask == OVS_BE64_MAX;
1560
1561 ds_put_format(ds, "%s=0x%"PRIx64, name, ntohll(key));
1562 if (!mask_full) { /* Partially masked. */
1563 ds_put_format(ds, "/%#"PRIx64, ntohll(*mask));
1564 }
1565 ds_put_char(ds, ',');
1566 }
1567 }
1568
1569 static void
1570 format_ipv4(struct ds *ds, const char *name, ovs_be32 key,
1571 const ovs_be32 *mask, bool verbose)
1572 {
1573 bool mask_empty = mask && !*mask;
1574
1575 if (verbose || !mask_empty) {
1576 bool mask_full = !mask || *mask == OVS_BE32_MAX;
1577
1578 ds_put_format(ds, "%s="IP_FMT, name, IP_ARGS(key));
1579 if (!mask_full) { /* Partially masked. */
1580 ds_put_format(ds, "/"IP_FMT, IP_ARGS(*mask));
1581 }
1582 ds_put_char(ds, ',');
1583 }
1584 }
1585
1586 static void
1587 format_ipv6(struct ds *ds, const char *name, const ovs_be32 key_[4],
1588 const ovs_be32 (*mask_)[4], bool verbose)
1589 {
1590 char buf[INET6_ADDRSTRLEN];
1591 const struct in6_addr *key = (const struct in6_addr *)key_;
1592 const struct in6_addr *mask = mask_ ? (const struct in6_addr *)*mask_
1593 : NULL;
1594 bool mask_empty = mask && ipv6_mask_is_any(mask);
1595
1596 if (verbose || !mask_empty) {
1597 bool mask_full = !mask || ipv6_mask_is_exact(mask);
1598
1599 inet_ntop(AF_INET6, key, buf, sizeof buf);
1600 ds_put_format(ds, "%s=%s", name, buf);
1601 if (!mask_full) { /* Partially masked. */
1602 inet_ntop(AF_INET6, mask, buf, sizeof buf);
1603 ds_put_format(ds, "/%s", buf);
1604 }
1605 ds_put_char(ds, ',');
1606 }
1607 }
1608
1609 static void
1610 format_ipv6_label(struct ds *ds, const char *name, ovs_be32 key,
1611 const ovs_be32 *mask, bool verbose)
1612 {
1613 bool mask_empty = mask && !*mask;
1614
1615 if (verbose || !mask_empty) {
1616 bool mask_full = !mask
1617 || (*mask & htonl(IPV6_LABEL_MASK)) == htonl(IPV6_LABEL_MASK);
1618
1619 ds_put_format(ds, "%s=%#"PRIx32, name, ntohl(key));
1620 if (!mask_full) { /* Partially masked. */
1621 ds_put_format(ds, "/%#"PRIx32, ntohl(*mask));
1622 }
1623 ds_put_char(ds, ',');
1624 }
1625 }
1626
1627 static void
1628 format_u8x(struct ds *ds, const char *name, uint8_t key,
1629 const uint8_t *mask, bool verbose)
1630 {
1631 bool mask_empty = mask && !*mask;
1632
1633 if (verbose || !mask_empty) {
1634 bool mask_full = !mask || *mask == UINT8_MAX;
1635
1636 ds_put_format(ds, "%s=%#"PRIx8, name, key);
1637 if (!mask_full) { /* Partially masked. */
1638 ds_put_format(ds, "/%#"PRIx8, *mask);
1639 }
1640 ds_put_char(ds, ',');
1641 }
1642 }
1643
1644 static void
1645 format_u8u(struct ds *ds, const char *name, uint8_t key,
1646 const uint8_t *mask, bool verbose)
1647 {
1648 bool mask_empty = mask && !*mask;
1649
1650 if (verbose || !mask_empty) {
1651 bool mask_full = !mask || *mask == UINT8_MAX;
1652
1653 ds_put_format(ds, "%s=%"PRIu8, name, key);
1654 if (!mask_full) { /* Partially masked. */
1655 ds_put_format(ds, "/%#"PRIx8, *mask);
1656 }
1657 ds_put_char(ds, ',');
1658 }
1659 }
1660
1661 static void
1662 format_be16(struct ds *ds, const char *name, ovs_be16 key,
1663 const ovs_be16 *mask, bool verbose)
1664 {
1665 bool mask_empty = mask && !*mask;
1666
1667 if (verbose || !mask_empty) {
1668 bool mask_full = !mask || *mask == OVS_BE16_MAX;
1669
1670 ds_put_format(ds, "%s=%"PRIu16, name, ntohs(key));
1671 if (!mask_full) { /* Partially masked. */
1672 ds_put_format(ds, "/%#"PRIx16, ntohs(*mask));
1673 }
1674 ds_put_char(ds, ',');
1675 }
1676 }
1677
1678 static void
1679 format_tun_flags(struct ds *ds, const char *name, uint16_t key,
1680 const uint16_t *mask, bool verbose)
1681 {
1682 bool mask_empty = mask && !*mask;
1683
1684 if (verbose || !mask_empty) {
1685 bool mask_full = !mask || (*mask & FLOW_TNL_F_MASK) == FLOW_TNL_F_MASK;
1686
1687 ds_put_cstr(ds, name);
1688 ds_put_char(ds, '(');
1689 if (!mask_full) { /* Partially masked. */
1690 format_flags_masked(ds, NULL, flow_tun_flag_to_string, key, *mask);
1691 } else { /* Fully masked. */
1692 format_flags(ds, flow_tun_flag_to_string, key, ',');
1693 }
1694 ds_put_cstr(ds, "),");
1695 }
1696 }
1697
1698 static void
1699 format_frag(struct ds *ds, const char *name, uint8_t key,
1700 const uint8_t *mask, bool verbose)
1701 {
1702 bool mask_empty = mask && !*mask;
1703
1704 /* ODP frag is an enumeration field; partial masks are not meaningful. */
1705 if (verbose || !mask_empty) {
1706 bool mask_full = !mask || *mask == UINT8_MAX;
1707
1708 if (!mask_full) { /* Partially masked. */
1709 ds_put_format(ds, "error: partial mask not supported for frag (%#"
1710 PRIx8"),", *mask);
1711 } else {
1712 ds_put_format(ds, "%s=%s,", name, ovs_frag_type_to_string(key));
1713 }
1714 }
1715 }
1716
1717 #define MASK(PTR, FIELD) PTR ? &PTR->FIELD : NULL
1718
1719 static void
1720 format_odp_key_attr(const struct nlattr *a, const struct nlattr *ma,
1721 const struct hmap *portno_names, struct ds *ds,
1722 bool verbose)
1723 {
1724 enum ovs_key_attr attr = nl_attr_type(a);
1725 char namebuf[OVS_KEY_ATTR_BUFSIZE];
1726 int expected_len;
1727 bool is_exact;
1728
1729 is_exact = ma ? odp_mask_attr_is_exact(ma) : true;
1730
1731 ds_put_cstr(ds, ovs_key_attr_to_string(attr, namebuf, sizeof namebuf));
1732
1733 {
1734 expected_len = odp_flow_key_attr_len(nl_attr_type(a));
1735 if (expected_len != -2) {
1736 bool bad_key_len = nl_attr_get_size(a) != expected_len;
1737 bool bad_mask_len = ma && nl_attr_get_size(ma) != expected_len;
1738
1739 if (bad_key_len || bad_mask_len) {
1740 if (bad_key_len) {
1741 ds_put_format(ds, "(bad key length %"PRIuSIZE", expected %d)(",
1742 nl_attr_get_size(a), expected_len);
1743 }
1744 format_generic_odp_key(a, ds);
1745 if (ma) {
1746 ds_put_char(ds, '/');
1747 if (bad_mask_len) {
1748 ds_put_format(ds, "(bad mask length %"PRIuSIZE", expected %d)(",
1749 nl_attr_get_size(ma), expected_len);
1750 }
1751 format_generic_odp_key(ma, ds);
1752 }
1753 ds_put_char(ds, ')');
1754 return;
1755 }
1756 }
1757 }
1758
1759 ds_put_char(ds, '(');
1760 switch (attr) {
1761 case OVS_KEY_ATTR_ENCAP:
1762 if (ma && nl_attr_get_size(ma) && nl_attr_get_size(a)) {
1763 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a),
1764 nl_attr_get(ma), nl_attr_get_size(ma), NULL, ds,
1765 verbose);
1766 } else if (nl_attr_get_size(a)) {
1767 odp_flow_format(nl_attr_get(a), nl_attr_get_size(a), NULL, 0, NULL,
1768 ds, verbose);
1769 }
1770 break;
1771
1772 case OVS_KEY_ATTR_PRIORITY:
1773 case OVS_KEY_ATTR_SKB_MARK:
1774 case OVS_KEY_ATTR_DP_HASH:
1775 case OVS_KEY_ATTR_RECIRC_ID:
1776 ds_put_format(ds, "%#"PRIx32, nl_attr_get_u32(a));
1777 if (!is_exact) {
1778 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1779 }
1780 break;
1781
1782 case OVS_KEY_ATTR_TUNNEL: {
1783 struct flow_tnl key, mask_;
1784 struct flow_tnl *mask = ma ? &mask_ : NULL;
1785
1786 if (mask) {
1787 memset(mask, 0, sizeof *mask);
1788 odp_tun_key_from_attr(ma, mask);
1789 }
1790 memset(&key, 0, sizeof key);
1791 if (odp_tun_key_from_attr(a, &key) == ODP_FIT_ERROR) {
1792 ds_put_format(ds, "error");
1793 return;
1794 }
1795 format_be64(ds, "tun_id", key.tun_id, MASK(mask, tun_id), verbose);
1796 format_ipv4(ds, "src", key.ip_src, MASK(mask, ip_src), verbose);
1797 format_ipv4(ds, "dst", key.ip_dst, MASK(mask, ip_dst), verbose);
1798 format_u8x(ds, "tos", key.ip_tos, MASK(mask, ip_tos), verbose);
1799 format_u8u(ds, "ttl", key.ip_ttl, MASK(mask, ip_ttl), verbose);
1800 format_be16(ds, "tp_src", key.tp_src, MASK(mask, tp_src), verbose);
1801 format_be16(ds, "tp_dst", key.tp_dst, MASK(mask, tp_dst), verbose);
1802 format_tun_flags(ds, "flags", key.flags, MASK(mask, flags), verbose);
1803 ds_chomp(ds, ',');
1804 break;
1805 }
1806 case OVS_KEY_ATTR_IN_PORT:
1807 if (portno_names && verbose && is_exact) {
1808 char *name = odp_portno_names_get(portno_names,
1809 u32_to_odp(nl_attr_get_u32(a)));
1810 if (name) {
1811 ds_put_format(ds, "%s", name);
1812 } else {
1813 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1814 }
1815 } else {
1816 ds_put_format(ds, "%"PRIu32, nl_attr_get_u32(a));
1817 if (!is_exact) {
1818 ds_put_format(ds, "/%#"PRIx32, nl_attr_get_u32(ma));
1819 }
1820 }
1821 break;
1822
1823 case OVS_KEY_ATTR_ETHERNET: {
1824 const struct ovs_key_ethernet *mask = ma ? nl_attr_get(ma) : NULL;
1825 const struct ovs_key_ethernet *key = nl_attr_get(a);
1826
1827 format_eth(ds, "src", key->eth_src, MASK(mask, eth_src), verbose);
1828 format_eth(ds, "dst", key->eth_dst, MASK(mask, eth_dst), verbose);
1829 ds_chomp(ds, ',');
1830 break;
1831 }
1832 case OVS_KEY_ATTR_VLAN:
1833 format_vlan_tci(ds, nl_attr_get_be16(a),
1834 ma ? nl_attr_get_be16(ma) : OVS_BE16_MAX, verbose);
1835 break;
1836
1837 case OVS_KEY_ATTR_MPLS: {
1838 const struct ovs_key_mpls *mpls_key = nl_attr_get(a);
1839 const struct ovs_key_mpls *mpls_mask = NULL;
1840 size_t size = nl_attr_get_size(a);
1841
1842 if (!size || size % sizeof *mpls_key) {
1843 ds_put_format(ds, "(bad key length %"PRIuSIZE")", size);
1844 return;
1845 }
1846 if (!is_exact) {
1847 mpls_mask = nl_attr_get(ma);
1848 if (size != nl_attr_get_size(ma)) {
1849 ds_put_format(ds, "(key length %"PRIuSIZE" != "
1850 "mask length %"PRIuSIZE")",
1851 size, nl_attr_get_size(ma));
1852 return;
1853 }
1854 }
1855 format_mpls(ds, mpls_key, mpls_mask, size / sizeof *mpls_key);
1856 break;
1857 }
1858 case OVS_KEY_ATTR_ETHERTYPE:
1859 ds_put_format(ds, "0x%04"PRIx16, ntohs(nl_attr_get_be16(a)));
1860 if (!is_exact) {
1861 ds_put_format(ds, "/0x%04"PRIx16, ntohs(nl_attr_get_be16(ma)));
1862 }
1863 break;
1864
1865 case OVS_KEY_ATTR_IPV4: {
1866 const struct ovs_key_ipv4 *key = nl_attr_get(a);
1867 const struct ovs_key_ipv4 *mask = ma ? nl_attr_get(ma) : NULL;
1868
1869 format_ipv4(ds, "src", key->ipv4_src, MASK(mask, ipv4_src), verbose);
1870 format_ipv4(ds, "dst", key->ipv4_dst, MASK(mask, ipv4_dst), verbose);
1871 format_u8u(ds, "proto", key->ipv4_proto, MASK(mask, ipv4_proto),
1872 verbose);
1873 format_u8x(ds, "tos", key->ipv4_tos, MASK(mask, ipv4_tos), verbose);
1874 format_u8u(ds, "ttl", key->ipv4_ttl, MASK(mask, ipv4_ttl), verbose);
1875 format_frag(ds, "frag", key->ipv4_frag, MASK(mask, ipv4_frag),
1876 verbose);
1877 ds_chomp(ds, ',');
1878 break;
1879 }
1880 case OVS_KEY_ATTR_IPV6: {
1881 const struct ovs_key_ipv6 *key = nl_attr_get(a);
1882 const struct ovs_key_ipv6 *mask = ma ? nl_attr_get(ma) : NULL;
1883
1884 format_ipv6(ds, "src", key->ipv6_src, MASK(mask, ipv6_src), verbose);
1885 format_ipv6(ds, "dst", key->ipv6_dst, MASK(mask, ipv6_dst), verbose);
1886 format_ipv6_label(ds, "label", key->ipv6_label, MASK(mask, ipv6_label),
1887 verbose);
1888 format_u8u(ds, "proto", key->ipv6_proto, MASK(mask, ipv6_proto),
1889 verbose);
1890 format_u8x(ds, "tclass", key->ipv6_tclass, MASK(mask, ipv6_tclass),
1891 verbose);
1892 format_u8u(ds, "hlimit", key->ipv6_hlimit, MASK(mask, ipv6_hlimit),
1893 verbose);
1894 format_frag(ds, "frag", key->ipv6_frag, MASK(mask, ipv6_frag),
1895 verbose);
1896 ds_chomp(ds, ',');
1897 break;
1898 }
1899 /* These have the same structure and format. */
1900 case OVS_KEY_ATTR_TCP:
1901 case OVS_KEY_ATTR_UDP:
1902 case OVS_KEY_ATTR_SCTP: {
1903 const struct ovs_key_tcp *key = nl_attr_get(a);
1904 const struct ovs_key_tcp *mask = ma ? nl_attr_get(ma) : NULL;
1905
1906 format_be16(ds, "src", key->tcp_src, MASK(mask, tcp_src), verbose);
1907 format_be16(ds, "dst", key->tcp_dst, MASK(mask, tcp_dst), verbose);
1908 ds_chomp(ds, ',');
1909 break;
1910 }
1911 case OVS_KEY_ATTR_TCP_FLAGS:
1912 if (!is_exact) {
1913 format_flags_masked(ds, NULL, packet_tcp_flag_to_string,
1914 ntohs(nl_attr_get_be16(a)),
1915 ntohs(nl_attr_get_be16(ma)));
1916 } else {
1917 format_flags(ds, packet_tcp_flag_to_string,
1918 ntohs(nl_attr_get_be16(a)), ',');
1919 }
1920 break;
1921
1922 case OVS_KEY_ATTR_ICMP: {
1923 const struct ovs_key_icmp *key = nl_attr_get(a);
1924 const struct ovs_key_icmp *mask = ma ? nl_attr_get(ma) : NULL;
1925
1926 format_u8u(ds, "type", key->icmp_type, MASK(mask, icmp_type), verbose);
1927 format_u8u(ds, "code", key->icmp_code, MASK(mask, icmp_code), verbose);
1928 ds_chomp(ds, ',');
1929 break;
1930 }
1931 case OVS_KEY_ATTR_ICMPV6: {
1932 const struct ovs_key_icmpv6 *key = nl_attr_get(a);
1933 const struct ovs_key_icmpv6 *mask = ma ? nl_attr_get(ma) : NULL;
1934
1935 format_u8u(ds, "type", key->icmpv6_type, MASK(mask, icmpv6_type),
1936 verbose);
1937 format_u8u(ds, "code", key->icmpv6_code, MASK(mask, icmpv6_code),
1938 verbose);
1939 ds_chomp(ds, ',');
1940 break;
1941 }
1942 case OVS_KEY_ATTR_ARP: {
1943 const struct ovs_key_arp *mask = ma ? nl_attr_get(ma) : NULL;
1944 const struct ovs_key_arp *key = nl_attr_get(a);
1945
1946 format_ipv4(ds, "sip", key->arp_sip, MASK(mask, arp_sip), verbose);
1947 format_ipv4(ds, "tip", key->arp_tip, MASK(mask, arp_tip), verbose);
1948 format_be16(ds, "op", key->arp_op, MASK(mask, arp_op), verbose);
1949 format_eth(ds, "sha", key->arp_sha, MASK(mask, arp_sha), verbose);
1950 format_eth(ds, "tha", key->arp_tha, MASK(mask, arp_tha), verbose);
1951 ds_chomp(ds, ',');
1952 break;
1953 }
1954 case OVS_KEY_ATTR_ND: {
1955 const struct ovs_key_nd *mask = ma ? nl_attr_get(ma) : NULL;
1956 const struct ovs_key_nd *key = nl_attr_get(a);
1957
1958 format_ipv6(ds, "target", key->nd_target, MASK(mask, nd_target),
1959 verbose);
1960 format_eth(ds, "sll", key->nd_sll, MASK(mask, nd_sll), verbose);
1961 format_eth(ds, "tll", key->nd_tll, MASK(mask, nd_tll), verbose);
1962
1963 ds_chomp(ds, ',');
1964 break;
1965 }
1966 case OVS_KEY_ATTR_UNSPEC:
1967 case __OVS_KEY_ATTR_MAX:
1968 default:
1969 format_generic_odp_key(a, ds);
1970 if (!is_exact) {
1971 ds_put_char(ds, '/');
1972 format_generic_odp_key(ma, ds);
1973 }
1974 break;
1975 }
1976 ds_put_char(ds, ')');
1977 }
1978
1979 static struct nlattr *
1980 generate_all_wildcard_mask(struct ofpbuf *ofp, const struct nlattr *key)
1981 {
1982 const struct nlattr *a;
1983 unsigned int left;
1984 int type = nl_attr_type(key);
1985 int size = nl_attr_get_size(key);
1986
1987 if (odp_flow_key_attr_len(type) >=0) {
1988 nl_msg_put_unspec_zero(ofp, type, size);
1989 } else {
1990 size_t nested_mask;
1991
1992 nested_mask = nl_msg_start_nested(ofp, type);
1993 NL_ATTR_FOR_EACH(a, left, key, nl_attr_get_size(key)) {
1994 generate_all_wildcard_mask(ofp, nl_attr_get(a));
1995 }
1996 nl_msg_end_nested(ofp, nested_mask);
1997 }
1998
1999 return ofpbuf_base(ofp);
2000 }
2001
2002 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2003 * OVS_KEY_ATTR_* attributes in 'key'. If non-null, additionally formats the
2004 * 'mask_len' bytes of 'mask' which apply to 'key'. If 'portno_names' is
2005 * non-null and 'verbose' is true, translates odp port number to its name. */
2006 void
2007 odp_flow_format(const struct nlattr *key, size_t key_len,
2008 const struct nlattr *mask, size_t mask_len,
2009 const struct hmap *portno_names, struct ds *ds, bool verbose)
2010 {
2011 if (key_len) {
2012 const struct nlattr *a;
2013 unsigned int left;
2014 bool has_ethtype_key = false;
2015 const struct nlattr *ma = NULL;
2016 struct ofpbuf ofp;
2017 bool first_field = true;
2018
2019 ofpbuf_init(&ofp, 100);
2020 NL_ATTR_FOR_EACH (a, left, key, key_len) {
2021 bool is_nested_attr;
2022 bool is_wildcard = false;
2023 int attr_type = nl_attr_type(a);
2024
2025 if (attr_type == OVS_KEY_ATTR_ETHERTYPE) {
2026 has_ethtype_key = true;
2027 }
2028
2029 is_nested_attr = (odp_flow_key_attr_len(attr_type) == -2);
2030
2031 if (mask && mask_len) {
2032 ma = nl_attr_find__(mask, mask_len, nl_attr_type(a));
2033 is_wildcard = ma ? odp_mask_attr_is_wildcard(ma) : true;
2034 }
2035
2036 if (verbose || !is_wildcard || is_nested_attr) {
2037 if (is_wildcard && !ma) {
2038 ma = generate_all_wildcard_mask(&ofp, a);
2039 }
2040 if (!first_field) {
2041 ds_put_char(ds, ',');
2042 }
2043 format_odp_key_attr(a, ma, portno_names, ds, verbose);
2044 first_field = false;
2045 }
2046 ofpbuf_clear(&ofp);
2047 }
2048 ofpbuf_uninit(&ofp);
2049
2050 if (left) {
2051 int i;
2052
2053 if (left == key_len) {
2054 ds_put_cstr(ds, "<empty>");
2055 }
2056 ds_put_format(ds, ",***%u leftover bytes*** (", left);
2057 for (i = 0; i < left; i++) {
2058 ds_put_format(ds, "%02x", ((const uint8_t *) a)[i]);
2059 }
2060 ds_put_char(ds, ')');
2061 }
2062 if (!has_ethtype_key) {
2063 ma = nl_attr_find__(mask, mask_len, OVS_KEY_ATTR_ETHERTYPE);
2064 if (ma) {
2065 ds_put_format(ds, ",eth_type(0/0x%04"PRIx16")",
2066 ntohs(nl_attr_get_be16(ma)));
2067 }
2068 }
2069 } else {
2070 ds_put_cstr(ds, "<empty>");
2071 }
2072 }
2073
2074 /* Appends to 'ds' a string representation of the 'key_len' bytes of
2075 * OVS_KEY_ATTR_* attributes in 'key'. */
2076 void
2077 odp_flow_key_format(const struct nlattr *key,
2078 size_t key_len, struct ds *ds)
2079 {
2080 odp_flow_format(key, key_len, NULL, 0, NULL, ds, true);
2081 }
2082
2083 static bool
2084 ovs_frag_type_from_string(const char *s, enum ovs_frag_type *type)
2085 {
2086 if (!strcasecmp(s, "no")) {
2087 *type = OVS_FRAG_TYPE_NONE;
2088 } else if (!strcasecmp(s, "first")) {
2089 *type = OVS_FRAG_TYPE_FIRST;
2090 } else if (!strcasecmp(s, "later")) {
2091 *type = OVS_FRAG_TYPE_LATER;
2092 } else {
2093 return false;
2094 }
2095 return true;
2096 }
2097
2098 /* Parsing. */
2099
2100 static int
2101 scan_eth(const char *s, uint8_t (*key)[ETH_ADDR_LEN],
2102 uint8_t (*mask)[ETH_ADDR_LEN])
2103 {
2104 int n;
2105
2106 if (ovs_scan(s, ETH_ADDR_SCAN_FMT"%n", ETH_ADDR_SCAN_ARGS(*key), &n)) {
2107 int len = n;
2108
2109 if (mask) {
2110 if (ovs_scan(s + len, "/"ETH_ADDR_SCAN_FMT"%n",
2111 ETH_ADDR_SCAN_ARGS(*mask), &n)) {
2112 len += n;
2113 } else {
2114 memset(mask, 0xff, sizeof *mask);
2115 }
2116 }
2117 return len;
2118 }
2119 return 0;
2120 }
2121
2122 static int
2123 scan_ipv4(const char *s, ovs_be32 *key, ovs_be32 *mask)
2124 {
2125 int n;
2126
2127 if (ovs_scan(s, IP_SCAN_FMT"%n", IP_SCAN_ARGS(key), &n)) {
2128 int len = n;
2129
2130 if (mask) {
2131 if (ovs_scan(s + len, "/"IP_SCAN_FMT"%n",
2132 IP_SCAN_ARGS(mask), &n)) {
2133 len += n;
2134 } else {
2135 *mask = OVS_BE32_MAX;
2136 }
2137 }
2138 return len;
2139 }
2140 return 0;
2141 }
2142
2143 static int
2144 scan_ipv6(const char *s, ovs_be32 (*key)[4], ovs_be32 (*mask)[4])
2145 {
2146 int n;
2147 char ipv6_s[IPV6_SCAN_LEN + 1];
2148
2149 if (ovs_scan(s, IPV6_SCAN_FMT"%n", ipv6_s, &n)
2150 && inet_pton(AF_INET6, ipv6_s, key) == 1) {
2151 int len = n;
2152
2153 if (mask) {
2154 if (ovs_scan(s + len, "/"IPV6_SCAN_FMT"%n", ipv6_s, &n)
2155 && inet_pton(AF_INET6, ipv6_s, mask) == 1) {
2156 len += n;
2157 } else {
2158 memset(mask, 0xff, sizeof *mask);
2159 }
2160 }
2161 return len;
2162 }
2163 return 0;
2164 }
2165
2166 static int
2167 scan_ipv6_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2168 {
2169 int key_, mask_;
2170 int n;
2171
2172 if (ovs_scan(s, "%i%n", &key_, &n)
2173 && (key_ & ~IPV6_LABEL_MASK) == 0) {
2174 int len = n;
2175
2176 *key = htonl(key_);
2177 if (mask) {
2178 if (ovs_scan(s + len, "/%i%n", &mask_, &n)
2179 && (mask_ & ~IPV6_LABEL_MASK) == 0) {
2180 len += n;
2181 *mask = htonl(mask_);
2182 } else {
2183 *mask = htonl(IPV6_LABEL_MASK);
2184 }
2185 }
2186 return len;
2187 }
2188 return 0;
2189 }
2190
2191 static int
2192 scan_u8(const char *s, uint8_t *key, uint8_t *mask)
2193 {
2194 int n;
2195
2196 if (ovs_scan(s, "%"SCNi8"%n", key, &n)) {
2197 int len = n;
2198
2199 if (mask) {
2200 if (ovs_scan(s + len, "/%"SCNi8"%n", mask, &n)) {
2201 len += n;
2202 } else {
2203 *mask = UINT8_MAX;
2204 }
2205 }
2206 return len;
2207 }
2208 return 0;
2209 }
2210
2211 static int
2212 scan_u32(const char *s, uint32_t *key, uint32_t *mask)
2213 {
2214 int n;
2215
2216 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2217 int len = n;
2218
2219 if (mask) {
2220 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2221 len += n;
2222 } else {
2223 *mask = UINT32_MAX;
2224 }
2225 }
2226 return len;
2227 }
2228 return 0;
2229 }
2230
2231 static int
2232 scan_be16(const char *s, ovs_be16 *key, ovs_be16 *mask)
2233 {
2234 uint16_t key_, mask_;
2235 int n;
2236
2237 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2238 int len = n;
2239
2240 *key = htons(key_);
2241 if (mask) {
2242 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2243 len += n;
2244 *mask = htons(mask_);
2245 } else {
2246 *mask = OVS_BE16_MAX;
2247 }
2248 }
2249 return len;
2250 }
2251 return 0;
2252 }
2253
2254 static int
2255 scan_be64(const char *s, ovs_be64 *key, ovs_be64 *mask)
2256 {
2257 uint64_t key_, mask_;
2258 int n;
2259
2260 if (ovs_scan(s, "%"SCNi64"%n", &key_, &n)) {
2261 int len = n;
2262
2263 *key = htonll(key_);
2264 if (mask) {
2265 if (ovs_scan(s + len, "/%"SCNi64"%n", &mask_, &n)) {
2266 len += n;
2267 *mask = htonll(mask_);
2268 } else {
2269 *mask = OVS_BE64_MAX;
2270 }
2271 }
2272 return len;
2273 }
2274 return 0;
2275 }
2276
2277 static int
2278 scan_tun_flags(const char *s, uint16_t *key, uint16_t *mask)
2279 {
2280 uint32_t flags, fmask;
2281 int n;
2282
2283 n = parse_flags(s, flow_tun_flag_to_string, &flags,
2284 FLOW_TNL_F_MASK, mask ? &fmask : NULL);
2285 if (n >= 0 && s[n] == ')') {
2286 *key = flags;
2287 if (mask) {
2288 *mask = fmask;
2289 }
2290 return n + 1;
2291 }
2292 return 0;
2293 }
2294
2295 static int
2296 scan_tcp_flags(const char *s, ovs_be16 *key, ovs_be16 *mask)
2297 {
2298 uint32_t flags, fmask;
2299 int n;
2300
2301 n = parse_flags(s, packet_tcp_flag_to_string, &flags,
2302 TCP_FLAGS(OVS_BE16_MAX), mask ? &fmask : NULL);
2303 if (n >= 0) {
2304 *key = htons(flags);
2305 if (mask) {
2306 *mask = htons(fmask);
2307 }
2308 return n;
2309 }
2310 return 0;
2311 }
2312
2313 static int
2314 scan_frag(const char *s, uint8_t *key, uint8_t *mask)
2315 {
2316 int n;
2317 char frag[8];
2318 enum ovs_frag_type frag_type;
2319
2320 if (ovs_scan(s, "%7[a-z]%n", frag, &n)
2321 && ovs_frag_type_from_string(frag, &frag_type)) {
2322 int len = n;
2323
2324 *key = frag_type;
2325 if (mask) {
2326 *mask = UINT8_MAX;
2327 }
2328 return len;
2329 }
2330 return 0;
2331 }
2332
2333 static int
2334 scan_port(const char *s, uint32_t *key, uint32_t *mask,
2335 const struct simap *port_names)
2336 {
2337 int n;
2338
2339 if (ovs_scan(s, "%"SCNi32"%n", key, &n)) {
2340 int len = n;
2341
2342 if (mask) {
2343 if (ovs_scan(s + len, "/%"SCNi32"%n", mask, &n)) {
2344 len += n;
2345 } else {
2346 *mask = UINT32_MAX;
2347 }
2348 }
2349 return len;
2350 } else if (port_names) {
2351 const struct simap_node *node;
2352 int len;
2353
2354 len = strcspn(s, ")");
2355 node = simap_find_len(port_names, s, len);
2356 if (node) {
2357 *key = node->data;
2358
2359 if (mask) {
2360 *mask = UINT32_MAX;
2361 }
2362 return len;
2363 }
2364 }
2365 return 0;
2366 }
2367
2368 /* Helper for vlan parsing. */
2369 struct ovs_key_vlan__ {
2370 ovs_be16 tci;
2371 };
2372
2373 static bool
2374 set_be16_bf(ovs_be16 *bf, uint8_t bits, uint8_t offset, uint16_t value)
2375 {
2376 const uint16_t mask = ((1U << bits) - 1) << offset;
2377
2378 if (value >> bits) {
2379 return false;
2380 }
2381
2382 *bf = htons((ntohs(*bf) & ~mask) | (value << offset));
2383 return true;
2384 }
2385
2386 static int
2387 scan_be16_bf(const char *s, ovs_be16 *key, ovs_be16 *mask, uint8_t bits,
2388 uint8_t offset)
2389 {
2390 uint16_t key_, mask_;
2391 int n;
2392
2393 if (ovs_scan(s, "%"SCNi16"%n", &key_, &n)) {
2394 int len = n;
2395
2396 if (set_be16_bf(key, bits, offset, key_)) {
2397 if (mask) {
2398 if (ovs_scan(s + len, "/%"SCNi16"%n", &mask_, &n)) {
2399 len += n;
2400
2401 if (!set_be16_bf(mask, bits, offset, mask_)) {
2402 return 0;
2403 }
2404 } else {
2405 *mask |= htons(((1U << bits) - 1) << offset);
2406 }
2407 }
2408 return len;
2409 }
2410 }
2411 return 0;
2412 }
2413
2414 static int
2415 scan_vid(const char *s, ovs_be16 *key, ovs_be16 *mask)
2416 {
2417 return scan_be16_bf(s, key, mask, 12, VLAN_VID_SHIFT);
2418 }
2419
2420 static int
2421 scan_pcp(const char *s, ovs_be16 *key, ovs_be16 *mask)
2422 {
2423 return scan_be16_bf(s, key, mask, 3, VLAN_PCP_SHIFT);
2424 }
2425
2426 static int
2427 scan_cfi(const char *s, ovs_be16 *key, ovs_be16 *mask)
2428 {
2429 return scan_be16_bf(s, key, mask, 1, VLAN_CFI_SHIFT);
2430 }
2431
2432 /* For MPLS. */
2433 static bool
2434 set_be32_bf(ovs_be32 *bf, uint8_t bits, uint8_t offset, uint32_t value)
2435 {
2436 const uint32_t mask = ((1U << bits) - 1) << offset;
2437
2438 if (value >> bits) {
2439 return false;
2440 }
2441
2442 *bf = htonl((ntohl(*bf) & ~mask) | (value << offset));
2443 return true;
2444 }
2445
2446 static int
2447 scan_be32_bf(const char *s, ovs_be32 *key, ovs_be32 *mask, uint8_t bits,
2448 uint8_t offset)
2449 {
2450 uint32_t key_, mask_;
2451 int n;
2452
2453 if (ovs_scan(s, "%"SCNi32"%n", &key_, &n)) {
2454 int len = n;
2455
2456 if (set_be32_bf(key, bits, offset, key_)) {
2457 if (mask) {
2458 if (ovs_scan(s + len, "/%"SCNi32"%n", &mask_, &n)) {
2459 len += n;
2460
2461 if (!set_be32_bf(mask, bits, offset, mask_)) {
2462 return 0;
2463 }
2464 } else {
2465 *mask |= htonl(((1U << bits) - 1) << offset);
2466 }
2467 }
2468 return len;
2469 }
2470 }
2471 return 0;
2472 }
2473
2474 static int
2475 scan_mpls_label(const char *s, ovs_be32 *key, ovs_be32 *mask)
2476 {
2477 return scan_be32_bf(s, key, mask, 20, MPLS_LABEL_SHIFT);
2478 }
2479
2480 static int
2481 scan_mpls_tc(const char *s, ovs_be32 *key, ovs_be32 *mask)
2482 {
2483 return scan_be32_bf(s, key, mask, 3, MPLS_TC_SHIFT);
2484 }
2485
2486 static int
2487 scan_mpls_ttl(const char *s, ovs_be32 *key, ovs_be32 *mask)
2488 {
2489 return scan_be32_bf(s, key, mask, 8, MPLS_TTL_SHIFT);
2490 }
2491
2492 static int
2493 scan_mpls_bos(const char *s, ovs_be32 *key, ovs_be32 *mask)
2494 {
2495 return scan_be32_bf(s, key, mask, 1, MPLS_BOS_SHIFT);
2496 }
2497
2498 /* ATTR is compile-time constant, so only the case with correct data type
2499 * will be used. However, the compiler complains about the data type for
2500 * the other cases, so we must cast to make the compiler silent. */
2501 #define SCAN_PUT_ATTR(BUF, ATTR, DATA) \
2502 if ((ATTR) == OVS_KEY_ATTR_TUNNEL) { \
2503 tun_key_to_attr(BUF, (const struct flow_tnl *)(void *)&(DATA)); \
2504 } else { \
2505 nl_msg_put_unspec(BUF, ATTR, &(DATA), sizeof (DATA)); \
2506 }
2507
2508 #define SCAN_IF(NAME) \
2509 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
2510 const char *start = s; \
2511 int len; \
2512 \
2513 s += strlen(NAME)
2514
2515 /* Usually no special initialization is needed. */
2516 #define SCAN_BEGIN(NAME, TYPE) \
2517 SCAN_IF(NAME); \
2518 TYPE skey, smask; \
2519 memset(&skey, 0, sizeof skey); \
2520 memset(&smask, 0, sizeof smask); \
2521 do { \
2522 len = 0;
2523
2524 /* VLAN needs special initialization. */
2525 #define SCAN_BEGIN_INIT(NAME, TYPE, KEY_INIT, MASK_INIT) \
2526 SCAN_IF(NAME); \
2527 TYPE skey = KEY_INIT; \
2528 TYPE smask = MASK_INIT; \
2529 do { \
2530 len = 0;
2531
2532 /* Scan unnamed entry as 'TYPE' */
2533 #define SCAN_TYPE(TYPE, KEY, MASK) \
2534 len = scan_##TYPE(s, KEY, MASK); \
2535 if (len == 0) { \
2536 return -EINVAL; \
2537 } \
2538 s += len
2539
2540 /* Scan named ('NAME') entry 'FIELD' as 'TYPE'. */
2541 #define SCAN_FIELD(NAME, TYPE, FIELD) \
2542 if (strncmp(s, NAME, strlen(NAME)) == 0) { \
2543 s += strlen(NAME); \
2544 SCAN_TYPE(TYPE, &skey.FIELD, mask ? &smask.FIELD : NULL); \
2545 continue; \
2546 }
2547
2548 #define SCAN_FINISH() \
2549 } while (*s++ == ',' && len != 0); \
2550 if (s[-1] != ')') { \
2551 return -EINVAL; \
2552 }
2553
2554 #define SCAN_FINISH_SINGLE() \
2555 } while (false); \
2556 if (*s++ != ')') { \
2557 return -EINVAL; \
2558 }
2559
2560 #define SCAN_PUT(ATTR) \
2561 if (!mask || !is_all_zeros(&smask, sizeof smask)) { \
2562 SCAN_PUT_ATTR(key, ATTR, skey); \
2563 if (mask) { \
2564 SCAN_PUT_ATTR(mask, ATTR, smask); \
2565 } \
2566 }
2567
2568 #define SCAN_END(ATTR) \
2569 SCAN_FINISH(); \
2570 SCAN_PUT(ATTR); \
2571 return s - start; \
2572 }
2573
2574 #define SCAN_END_SINGLE(ATTR) \
2575 SCAN_FINISH_SINGLE(); \
2576 SCAN_PUT(ATTR); \
2577 return s - start; \
2578 }
2579
2580 #define SCAN_SINGLE(NAME, TYPE, SCAN_AS, ATTR) \
2581 SCAN_BEGIN(NAME, TYPE) { \
2582 SCAN_TYPE(SCAN_AS, &skey, &smask); \
2583 } SCAN_END_SINGLE(ATTR)
2584
2585 #define SCAN_SINGLE_NO_MASK(NAME, TYPE, SCAN_AS, ATTR) \
2586 SCAN_BEGIN(NAME, TYPE) { \
2587 SCAN_TYPE(SCAN_AS, &skey, NULL); \
2588 } SCAN_END_SINGLE(ATTR)
2589
2590 /* scan_port needs one extra argument. */
2591 #define SCAN_SINGLE_PORT(NAME, TYPE, ATTR) \
2592 SCAN_BEGIN(NAME, TYPE) { \
2593 len = scan_port(s, &skey, &smask, port_names); \
2594 if (len == 0) { \
2595 return -EINVAL; \
2596 } \
2597 s += len; \
2598 } SCAN_END_SINGLE(ATTR)
2599
2600 static int
2601 parse_odp_key_mask_attr(const char *s, const struct simap *port_names,
2602 struct ofpbuf *key, struct ofpbuf *mask)
2603 {
2604 SCAN_SINGLE("skb_priority(", uint32_t, u32, OVS_KEY_ATTR_PRIORITY);
2605 SCAN_SINGLE("skb_mark(", uint32_t, u32, OVS_KEY_ATTR_SKB_MARK);
2606 SCAN_SINGLE_NO_MASK("recirc_id(", uint32_t, u32, OVS_KEY_ATTR_RECIRC_ID);
2607 SCAN_SINGLE("dp_hash(", uint32_t, u32, OVS_KEY_ATTR_DP_HASH);
2608
2609 SCAN_BEGIN("tunnel(", struct flow_tnl) {
2610 SCAN_FIELD("tun_id=", be64, tun_id);
2611 SCAN_FIELD("src=", ipv4, ip_src);
2612 SCAN_FIELD("dst=", ipv4, ip_dst);
2613 SCAN_FIELD("tos=", u8, ip_tos);
2614 SCAN_FIELD("ttl=", u8, ip_ttl);
2615 SCAN_FIELD("tp_src=", be16, tp_src);
2616 SCAN_FIELD("tp_dst=", be16, tp_dst);
2617 SCAN_FIELD("flags(", tun_flags, flags);
2618 } SCAN_END(OVS_KEY_ATTR_TUNNEL);
2619
2620 SCAN_SINGLE_PORT("in_port(", uint32_t, OVS_KEY_ATTR_IN_PORT);
2621
2622 SCAN_BEGIN("eth(", struct ovs_key_ethernet) {
2623 SCAN_FIELD("src=", eth, eth_src);
2624 SCAN_FIELD("dst=", eth, eth_dst);
2625 } SCAN_END(OVS_KEY_ATTR_ETHERNET);
2626
2627 SCAN_BEGIN_INIT("vlan(", struct ovs_key_vlan__,
2628 { htons(VLAN_CFI) }, { htons(VLAN_CFI) }) {
2629 SCAN_FIELD("vid=", vid, tci);
2630 SCAN_FIELD("pcp=", pcp, tci);
2631 SCAN_FIELD("cfi=", cfi, tci);
2632 } SCAN_END(OVS_KEY_ATTR_VLAN);
2633
2634 SCAN_SINGLE("eth_type(", ovs_be16, be16, OVS_KEY_ATTR_ETHERTYPE);
2635
2636 SCAN_BEGIN("mpls(", struct ovs_key_mpls) {
2637 SCAN_FIELD("label=", mpls_label, mpls_lse);
2638 SCAN_FIELD("tc=", mpls_tc, mpls_lse);
2639 SCAN_FIELD("ttl=", mpls_ttl, mpls_lse);
2640 SCAN_FIELD("bos=", mpls_bos, mpls_lse);
2641 } SCAN_END(OVS_KEY_ATTR_MPLS);
2642
2643 SCAN_BEGIN("ipv4(", struct ovs_key_ipv4) {
2644 SCAN_FIELD("src=", ipv4, ipv4_src);
2645 SCAN_FIELD("dst=", ipv4, ipv4_dst);
2646 SCAN_FIELD("proto=", u8, ipv4_proto);
2647 SCAN_FIELD("tos=", u8, ipv4_tos);
2648 SCAN_FIELD("ttl=", u8, ipv4_ttl);
2649 SCAN_FIELD("frag=", frag, ipv4_frag);
2650 } SCAN_END(OVS_KEY_ATTR_IPV4);
2651
2652 SCAN_BEGIN("ipv6(", struct ovs_key_ipv6) {
2653 SCAN_FIELD("src=", ipv6, ipv6_src);
2654 SCAN_FIELD("dst=", ipv6, ipv6_dst);
2655 SCAN_FIELD("label=", ipv6_label, ipv6_label);
2656 SCAN_FIELD("proto=", u8, ipv6_proto);
2657 SCAN_FIELD("tclass=", u8, ipv6_tclass);
2658 SCAN_FIELD("hlimit=", u8, ipv6_hlimit);
2659 SCAN_FIELD("frag=", frag, ipv6_frag);
2660 } SCAN_END(OVS_KEY_ATTR_IPV6);
2661
2662 SCAN_BEGIN("tcp(", struct ovs_key_tcp) {
2663 SCAN_FIELD("src=", be16, tcp_src);
2664 SCAN_FIELD("dst=", be16, tcp_dst);
2665 } SCAN_END(OVS_KEY_ATTR_TCP);
2666
2667 SCAN_SINGLE("tcp_flags(", ovs_be16, tcp_flags, OVS_KEY_ATTR_TCP_FLAGS);
2668
2669 SCAN_BEGIN("udp(", struct ovs_key_udp) {
2670 SCAN_FIELD("src=", be16, udp_src);
2671 SCAN_FIELD("dst=", be16, udp_dst);
2672 } SCAN_END(OVS_KEY_ATTR_UDP);
2673
2674 SCAN_BEGIN("sctp(", struct ovs_key_sctp) {
2675 SCAN_FIELD("src=", be16, sctp_src);
2676 SCAN_FIELD("dst=", be16, sctp_dst);
2677 } SCAN_END(OVS_KEY_ATTR_SCTP);
2678
2679 SCAN_BEGIN("icmp(", struct ovs_key_icmp) {
2680 SCAN_FIELD("type=", u8, icmp_type);
2681 SCAN_FIELD("code=", u8, icmp_code);
2682 } SCAN_END(OVS_KEY_ATTR_ICMP);
2683
2684 SCAN_BEGIN("icmpv6(", struct ovs_key_icmpv6) {
2685 SCAN_FIELD("type=", u8, icmpv6_type);
2686 SCAN_FIELD("code=", u8, icmpv6_code);
2687 } SCAN_END(OVS_KEY_ATTR_ICMPV6);
2688
2689 SCAN_BEGIN("arp(", struct ovs_key_arp) {
2690 SCAN_FIELD("sip=", ipv4, arp_sip);
2691 SCAN_FIELD("tip=", ipv4, arp_tip);
2692 SCAN_FIELD("op=", be16, arp_op);
2693 SCAN_FIELD("sha=", eth, arp_sha);
2694 SCAN_FIELD("tha=", eth, arp_tha);
2695 } SCAN_END(OVS_KEY_ATTR_ARP);
2696
2697 SCAN_BEGIN("nd(", struct ovs_key_nd) {
2698 SCAN_FIELD("target=", ipv6, nd_target);
2699 SCAN_FIELD("sll=", eth, nd_sll);
2700 SCAN_FIELD("tll=", eth, nd_tll);
2701 } SCAN_END(OVS_KEY_ATTR_ND);
2702
2703 /* Encap open-coded. */
2704 if (!strncmp(s, "encap(", 6)) {
2705 const char *start = s;
2706 size_t encap, encap_mask = 0;
2707
2708 encap = nl_msg_start_nested(key, OVS_KEY_ATTR_ENCAP);
2709 if (mask) {
2710 encap_mask = nl_msg_start_nested(mask, OVS_KEY_ATTR_ENCAP);
2711 }
2712
2713 s += 6;
2714 for (;;) {
2715 int retval;
2716
2717 s += strspn(s, ", \t\r\n");
2718 if (!*s) {
2719 return -EINVAL;
2720 } else if (*s == ')') {
2721 break;
2722 }
2723
2724 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2725 if (retval < 0) {
2726 return retval;
2727 }
2728 s += retval;
2729 }
2730 s++;
2731
2732 nl_msg_end_nested(key, encap);
2733 if (mask) {
2734 nl_msg_end_nested(mask, encap_mask);
2735 }
2736
2737 return s - start;
2738 }
2739
2740 return -EINVAL;
2741 }
2742
2743 /* Parses the string representation of a datapath flow key, in the
2744 * format output by odp_flow_key_format(). Returns 0 if successful,
2745 * otherwise a positive errno value. On success, the flow key is
2746 * appended to 'key' as a series of Netlink attributes. On failure, no
2747 * data is appended to 'key'. Either way, 'key''s data might be
2748 * reallocated.
2749 *
2750 * If 'port_names' is nonnull, it points to an simap that maps from a port name
2751 * to a port number. (Port names may be used instead of port numbers in
2752 * in_port.)
2753 *
2754 * On success, the attributes appended to 'key' are individually syntactically
2755 * valid, but they may not be valid as a sequence. 'key' might, for example,
2756 * have duplicated keys. odp_flow_key_to_flow() will detect those errors. */
2757 int
2758 odp_flow_from_string(const char *s, const struct simap *port_names,
2759 struct ofpbuf *key, struct ofpbuf *mask)
2760 {
2761 const size_t old_size = ofpbuf_size(key);
2762 for (;;) {
2763 int retval;
2764
2765 s += strspn(s, delimiters);
2766 if (!*s) {
2767 return 0;
2768 }
2769
2770 retval = parse_odp_key_mask_attr(s, port_names, key, mask);
2771 if (retval < 0) {
2772 ofpbuf_set_size(key, old_size);
2773 return -retval;
2774 }
2775 s += retval;
2776 }
2777
2778 return 0;
2779 }
2780
2781 static uint8_t
2782 ovs_to_odp_frag(uint8_t nw_frag, bool is_mask)
2783 {
2784 if (is_mask) {
2785 /* Netlink interface 'enum ovs_frag_type' is an 8-bit enumeration type,
2786 * not a set of flags or bitfields. Hence, if the struct flow nw_frag
2787 * mask, which is a set of bits, has the FLOW_NW_FRAG_ANY as zero, we
2788 * must use a zero mask for the netlink frag field, and all ones mask
2789 * otherwise. */
2790 return (nw_frag & FLOW_NW_FRAG_ANY) ? UINT8_MAX : 0;
2791 }
2792 return !(nw_frag & FLOW_NW_FRAG_ANY) ? OVS_FRAG_TYPE_NONE
2793 : nw_frag & FLOW_NW_FRAG_LATER ? OVS_FRAG_TYPE_LATER
2794 : OVS_FRAG_TYPE_FIRST;
2795 }
2796
2797 static void get_ethernet_key(const struct flow *, struct ovs_key_ethernet *);
2798 static void put_ethernet_key(const struct ovs_key_ethernet *, struct flow *);
2799 static void get_ipv4_key(const struct flow *, struct ovs_key_ipv4 *,
2800 bool is_mask);
2801 static void put_ipv4_key(const struct ovs_key_ipv4 *, struct flow *,
2802 bool is_mask);
2803 static void get_ipv6_key(const struct flow *, struct ovs_key_ipv6 *,
2804 bool is_mask);
2805 static void put_ipv6_key(const struct ovs_key_ipv6 *, struct flow *,
2806 bool is_mask);
2807 static void get_arp_key(const struct flow *, struct ovs_key_arp *);
2808 static void put_arp_key(const struct ovs_key_arp *, struct flow *);
2809
2810 /* These share the same layout. */
2811 union ovs_key_tp {
2812 struct ovs_key_tcp tcp;
2813 struct ovs_key_udp udp;
2814 struct ovs_key_sctp sctp;
2815 };
2816
2817 static void get_tp_key(const struct flow *, union ovs_key_tp *);
2818 static void put_tp_key(const union ovs_key_tp *, struct flow *);
2819
2820 static void
2821 odp_flow_key_from_flow__(struct ofpbuf *buf, const struct flow *flow,
2822 const struct flow *mask, odp_port_t odp_in_port,
2823 size_t max_mpls_depth, bool recirc, bool export_mask)
2824 {
2825 struct ovs_key_ethernet *eth_key;
2826 size_t encap;
2827 const struct flow *data = export_mask ? mask : flow;
2828
2829 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, data->skb_priority);
2830
2831 if (flow->tunnel.ip_dst || export_mask) {
2832 tun_key_to_attr(buf, &data->tunnel);
2833 }
2834
2835 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, data->pkt_mark);
2836
2837 if (recirc) {
2838 nl_msg_put_u32(buf, OVS_KEY_ATTR_RECIRC_ID, data->recirc_id);
2839 nl_msg_put_u32(buf, OVS_KEY_ATTR_DP_HASH, data->dp_hash);
2840 }
2841
2842 /* Add an ingress port attribute if this is a mask or 'odp_in_port'
2843 * is not the magical value "ODPP_NONE". */
2844 if (export_mask || odp_in_port != ODPP_NONE) {
2845 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, odp_in_port);
2846 }
2847
2848 eth_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ETHERNET,
2849 sizeof *eth_key);
2850 get_ethernet_key(data, eth_key);
2851
2852 if (flow->vlan_tci != htons(0) || flow->dl_type == htons(ETH_TYPE_VLAN)) {
2853 if (export_mask) {
2854 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
2855 } else {
2856 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, htons(ETH_TYPE_VLAN));
2857 }
2858 nl_msg_put_be16(buf, OVS_KEY_ATTR_VLAN, data->vlan_tci);
2859 encap = nl_msg_start_nested(buf, OVS_KEY_ATTR_ENCAP);
2860 if (flow->vlan_tci == htons(0)) {
2861 goto unencap;
2862 }
2863 } else {
2864 encap = 0;
2865 }
2866
2867 if (ntohs(flow->dl_type) < ETH_TYPE_MIN) {
2868 /* For backwards compatibility with kernels that don't support
2869 * wildcarding, the following convention is used to encode the
2870 * OVS_KEY_ATTR_ETHERTYPE for key and mask:
2871 *
2872 * key mask matches
2873 * -------- -------- -------
2874 * >0x5ff 0xffff Specified Ethernet II Ethertype.
2875 * >0x5ff 0 Any Ethernet II or non-Ethernet II frame.
2876 * <none> 0xffff Any non-Ethernet II frame (except valid
2877 * 802.3 SNAP packet with valid eth_type).
2878 */
2879 if (export_mask) {
2880 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, OVS_BE16_MAX);
2881 }
2882 goto unencap;
2883 }
2884
2885 nl_msg_put_be16(buf, OVS_KEY_ATTR_ETHERTYPE, data->dl_type);
2886
2887 if (flow->dl_type == htons(ETH_TYPE_IP)) {
2888 struct ovs_key_ipv4 *ipv4_key;
2889
2890 ipv4_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV4,
2891 sizeof *ipv4_key);
2892 get_ipv4_key(data, ipv4_key, export_mask);
2893 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
2894 struct ovs_key_ipv6 *ipv6_key;
2895
2896 ipv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_IPV6,
2897 sizeof *ipv6_key);
2898 get_ipv6_key(data, ipv6_key, export_mask);
2899 } else if (flow->dl_type == htons(ETH_TYPE_ARP) ||
2900 flow->dl_type == htons(ETH_TYPE_RARP)) {
2901 struct ovs_key_arp *arp_key;
2902
2903 arp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ARP,
2904 sizeof *arp_key);
2905 get_arp_key(data, arp_key);
2906 } else if (eth_type_mpls(flow->dl_type)) {
2907 struct ovs_key_mpls *mpls_key;
2908 int i, n;
2909
2910 n = flow_count_mpls_labels(flow, NULL);
2911 n = MIN(n, max_mpls_depth);
2912 mpls_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_MPLS,
2913 n * sizeof *mpls_key);
2914 for (i = 0; i < n; i++) {
2915 mpls_key[i].mpls_lse = data->mpls_lse[i];
2916 }
2917 }
2918
2919 if (is_ip_any(flow) && !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
2920 if (flow->nw_proto == IPPROTO_TCP) {
2921 union ovs_key_tp *tcp_key;
2922
2923 tcp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_TCP,
2924 sizeof *tcp_key);
2925 get_tp_key(data, tcp_key);
2926 if (data->tcp_flags) {
2927 nl_msg_put_be16(buf, OVS_KEY_ATTR_TCP_FLAGS, data->tcp_flags);
2928 }
2929 } else if (flow->nw_proto == IPPROTO_UDP) {
2930 union ovs_key_tp *udp_key;
2931
2932 udp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_UDP,
2933 sizeof *udp_key);
2934 get_tp_key(data, udp_key);
2935 } else if (flow->nw_proto == IPPROTO_SCTP) {
2936 union ovs_key_tp *sctp_key;
2937
2938 sctp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_SCTP,
2939 sizeof *sctp_key);
2940 get_tp_key(data, sctp_key);
2941 } else if (flow->dl_type == htons(ETH_TYPE_IP)
2942 && flow->nw_proto == IPPROTO_ICMP) {
2943 struct ovs_key_icmp *icmp_key;
2944
2945 icmp_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMP,
2946 sizeof *icmp_key);
2947 icmp_key->icmp_type = ntohs(data->tp_src);
2948 icmp_key->icmp_code = ntohs(data->tp_dst);
2949 } else if (flow->dl_type == htons(ETH_TYPE_IPV6)
2950 && flow->nw_proto == IPPROTO_ICMPV6) {
2951 struct ovs_key_icmpv6 *icmpv6_key;
2952
2953 icmpv6_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ICMPV6,
2954 sizeof *icmpv6_key);
2955 icmpv6_key->icmpv6_type = ntohs(data->tp_src);
2956 icmpv6_key->icmpv6_code = ntohs(data->tp_dst);
2957
2958 if (flow->tp_dst == htons(0)
2959 && (flow->tp_src == htons(ND_NEIGHBOR_SOLICIT)
2960 || flow->tp_src == htons(ND_NEIGHBOR_ADVERT))
2961 && (!export_mask || (data->tp_src == htons(0xffff)
2962 && data->tp_dst == htons(0xffff)))) {
2963
2964 struct ovs_key_nd *nd_key;
2965
2966 nd_key = nl_msg_put_unspec_uninit(buf, OVS_KEY_ATTR_ND,
2967 sizeof *nd_key);
2968 memcpy(nd_key->nd_target, &data->nd_target,
2969 sizeof nd_key->nd_target);
2970 memcpy(nd_key->nd_sll, data->arp_sha, ETH_ADDR_LEN);
2971 memcpy(nd_key->nd_tll, data->arp_tha, ETH_ADDR_LEN);
2972 }
2973 }
2974 }
2975
2976 unencap:
2977 if (encap) {
2978 nl_msg_end_nested(buf, encap);
2979 }
2980 }
2981
2982 /* Appends a representation of 'flow' as OVS_KEY_ATTR_* attributes to 'buf'.
2983 * 'flow->in_port' is ignored (since it is likely to be an OpenFlow port
2984 * number rather than a datapath port number). Instead, if 'odp_in_port'
2985 * is anything other than ODPP_NONE, it is included in 'buf' as the input
2986 * port.
2987 *
2988 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
2989 * capable of being expanded to allow for that much space.
2990 *
2991 * 'recirc' indicates support for recirculation fields. If this is true, then
2992 * these fields will always be serialised. */
2993 void
2994 odp_flow_key_from_flow(struct ofpbuf *buf, const struct flow *flow,
2995 const struct flow *mask, odp_port_t odp_in_port,
2996 bool recirc)
2997 {
2998 odp_flow_key_from_flow__(buf, flow, mask, odp_in_port, SIZE_MAX, recirc,
2999 false);
3000 }
3001
3002 /* Appends a representation of 'mask' as OVS_KEY_ATTR_* attributes to
3003 * 'buf'. 'flow' is used as a template to determine how to interpret
3004 * 'mask'. For example, the 'dl_type' of 'mask' describes the mask, but
3005 * it doesn't indicate whether the other fields should be interpreted as
3006 * ARP, IPv4, IPv6, etc.
3007 *
3008 * 'buf' must have at least ODPUTIL_FLOW_KEY_BYTES bytes of space, or be
3009 * capable of being expanded to allow for that much space.
3010 *
3011 * 'recirc' indicates support for recirculation fields. If this is true, then
3012 * these fields will always be serialised. */
3013 void
3014 odp_flow_key_from_mask(struct ofpbuf *buf, const struct flow *mask,
3015 const struct flow *flow, uint32_t odp_in_port_mask,
3016 size_t max_mpls_depth, bool recirc)
3017 {
3018 odp_flow_key_from_flow__(buf, flow, mask, u32_to_odp(odp_in_port_mask),
3019 max_mpls_depth, recirc, true);
3020 }
3021
3022 /* Generate ODP flow key from the given packet metadata */
3023 void
3024 odp_key_from_pkt_metadata(struct ofpbuf *buf, const struct pkt_metadata *md)
3025 {
3026 nl_msg_put_u32(buf, OVS_KEY_ATTR_PRIORITY, md->skb_priority);
3027
3028 if (md->tunnel.ip_dst) {
3029 tun_key_to_attr(buf, &md->tunnel);
3030 }
3031
3032 nl_msg_put_u32(buf, OVS_KEY_ATTR_SKB_MARK, md->pkt_mark);
3033
3034 /* Add an ingress port attribute if 'odp_in_port' is not the magical
3035 * value "ODPP_NONE". */
3036 if (md->in_port.odp_port != ODPP_NONE) {
3037 nl_msg_put_odp_port(buf, OVS_KEY_ATTR_IN_PORT, md->in_port.odp_port);
3038 }
3039 }
3040
3041 /* Generate packet metadata from the given ODP flow key. */
3042 void
3043 odp_key_to_pkt_metadata(const struct nlattr *key, size_t key_len,
3044 struct pkt_metadata *md)
3045 {
3046 const struct nlattr *nla;
3047 size_t left;
3048 uint32_t wanted_attrs = 1u << OVS_KEY_ATTR_PRIORITY |
3049 1u << OVS_KEY_ATTR_SKB_MARK | 1u << OVS_KEY_ATTR_TUNNEL |
3050 1u << OVS_KEY_ATTR_IN_PORT;
3051
3052 *md = PKT_METADATA_INITIALIZER(ODPP_NONE);
3053
3054 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3055 uint16_t type = nl_attr_type(nla);
3056 size_t len = nl_attr_get_size(nla);
3057 int expected_len = odp_flow_key_attr_len(type);
3058
3059 if (len != expected_len && expected_len >= 0) {
3060 continue;
3061 }
3062
3063 switch (type) {
3064 case OVS_KEY_ATTR_RECIRC_ID:
3065 md->recirc_id = nl_attr_get_u32(nla);
3066 wanted_attrs &= ~(1u << OVS_KEY_ATTR_RECIRC_ID);
3067 break;
3068 case OVS_KEY_ATTR_DP_HASH:
3069 md->dp_hash = nl_attr_get_u32(nla);
3070 wanted_attrs &= ~(1u << OVS_KEY_ATTR_DP_HASH);
3071 break;
3072 case OVS_KEY_ATTR_PRIORITY:
3073 md->skb_priority = nl_attr_get_u32(nla);
3074 wanted_attrs &= ~(1u << OVS_KEY_ATTR_PRIORITY);
3075 break;
3076 case OVS_KEY_ATTR_SKB_MARK:
3077 md->pkt_mark = nl_attr_get_u32(nla);
3078 wanted_attrs &= ~(1u << OVS_KEY_ATTR_SKB_MARK);
3079 break;
3080 case OVS_KEY_ATTR_TUNNEL: {
3081 enum odp_key_fitness res;
3082
3083 res = odp_tun_key_from_attr(nla, &md->tunnel);
3084 if (res == ODP_FIT_ERROR) {
3085 memset(&md->tunnel, 0, sizeof md->tunnel);
3086 } else if (res == ODP_FIT_PERFECT) {
3087 wanted_attrs &= ~(1u << OVS_KEY_ATTR_TUNNEL);
3088 }
3089 break;
3090 }
3091 case OVS_KEY_ATTR_IN_PORT:
3092 md->in_port.odp_port = nl_attr_get_odp_port(nla);
3093 wanted_attrs &= ~(1u << OVS_KEY_ATTR_IN_PORT);
3094 break;
3095 default:
3096 break;
3097 }
3098
3099 if (!wanted_attrs) {
3100 return; /* Have everything. */
3101 }
3102 }
3103 }
3104
3105 uint32_t
3106 odp_flow_key_hash(const struct nlattr *key, size_t key_len)
3107 {
3108 BUILD_ASSERT_DECL(!(NLA_ALIGNTO % sizeof(uint32_t)));
3109 return hash_words(ALIGNED_CAST(const uint32_t *, key),
3110 key_len / sizeof(uint32_t), 0);
3111 }
3112
3113 static void
3114 log_odp_key_attributes(struct vlog_rate_limit *rl, const char *title,
3115 uint64_t attrs, int out_of_range_attr,
3116 const struct nlattr *key, size_t key_len)
3117 {
3118 struct ds s;
3119 int i;
3120
3121 if (VLOG_DROP_DBG(rl)) {
3122 return;
3123 }
3124
3125 ds_init(&s);
3126 for (i = 0; i < 64; i++) {
3127 if (attrs & (UINT64_C(1) << i)) {
3128 char namebuf[OVS_KEY_ATTR_BUFSIZE];
3129
3130 ds_put_format(&s, " %s",
3131 ovs_key_attr_to_string(i, namebuf, sizeof namebuf));
3132 }
3133 }
3134 if (out_of_range_attr) {
3135 ds_put_format(&s, " %d (and possibly others)", out_of_range_attr);
3136 }
3137
3138 ds_put_cstr(&s, ": ");
3139 odp_flow_key_format(key, key_len, &s);
3140
3141 VLOG_DBG("%s:%s", title, ds_cstr(&s));
3142 ds_destroy(&s);
3143 }
3144
3145 static uint8_t
3146 odp_to_ovs_frag(uint8_t odp_frag, bool is_mask)
3147 {
3148 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3149
3150 if (is_mask) {
3151 return odp_frag ? FLOW_NW_FRAG_MASK : 0;
3152 }
3153
3154 if (odp_frag > OVS_FRAG_TYPE_LATER) {
3155 VLOG_ERR_RL(&rl, "invalid frag %"PRIu8" in flow key", odp_frag);
3156 return 0xff; /* Error. */
3157 }
3158
3159 return (odp_frag == OVS_FRAG_TYPE_NONE) ? 0
3160 : (odp_frag == OVS_FRAG_TYPE_FIRST) ? FLOW_NW_FRAG_ANY
3161 : FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER;
3162 }
3163
3164 static bool
3165 parse_flow_nlattrs(const struct nlattr *key, size_t key_len,
3166 const struct nlattr *attrs[], uint64_t *present_attrsp,
3167 int *out_of_range_attrp)
3168 {
3169 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3170 const struct nlattr *nla;
3171 uint64_t present_attrs;
3172 size_t left;
3173
3174 BUILD_ASSERT(OVS_KEY_ATTR_MAX < CHAR_BIT * sizeof present_attrs);
3175 present_attrs = 0;
3176 *out_of_range_attrp = 0;
3177 NL_ATTR_FOR_EACH (nla, left, key, key_len) {
3178 uint16_t type = nl_attr_type(nla);
3179 size_t len = nl_attr_get_size(nla);
3180 int expected_len = odp_flow_key_attr_len(type);
3181
3182 if (len != expected_len && expected_len >= 0) {
3183 char namebuf[OVS_KEY_ATTR_BUFSIZE];
3184
3185 VLOG_ERR_RL(&rl, "attribute %s has length %"PRIuSIZE" but should have "
3186 "length %d", ovs_key_attr_to_string(type, namebuf,
3187 sizeof namebuf),
3188 len, expected_len);
3189 return false;
3190 }
3191
3192 if (type > OVS_KEY_ATTR_MAX) {
3193 *out_of_range_attrp = type;
3194 } else {
3195 if (present_attrs & (UINT64_C(1) << type)) {
3196 char namebuf[OVS_KEY_ATTR_BUFSIZE];
3197
3198 VLOG_ERR_RL(&rl, "duplicate %s attribute in flow key",
3199 ovs_key_attr_to_string(type,
3200 namebuf, sizeof namebuf));
3201 return false;
3202 }
3203
3204 present_attrs |= UINT64_C(1) << type;
3205 attrs[type] = nla;
3206 }
3207 }
3208 if (left) {
3209 VLOG_ERR_RL(&rl, "trailing garbage in flow key");
3210 return false;
3211 }
3212
3213 *present_attrsp = present_attrs;
3214 return true;
3215 }
3216
3217 static enum odp_key_fitness
3218 check_expectations(uint64_t present_attrs, int out_of_range_attr,
3219 uint64_t expected_attrs,
3220 const struct nlattr *key, size_t key_len)
3221 {
3222 uint64_t missing_attrs;
3223 uint64_t extra_attrs;
3224
3225 missing_attrs = expected_attrs & ~present_attrs;
3226 if (missing_attrs) {
3227 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3228 log_odp_key_attributes(&rl, "expected but not present",
3229 missing_attrs, 0, key, key_len);
3230 return ODP_FIT_TOO_LITTLE;
3231 }
3232
3233 extra_attrs = present_attrs & ~expected_attrs;
3234 if (extra_attrs || out_of_range_attr) {
3235 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3236 log_odp_key_attributes(&rl, "present but not expected",
3237 extra_attrs, out_of_range_attr, key, key_len);
3238 return ODP_FIT_TOO_MUCH;
3239 }
3240
3241 return ODP_FIT_PERFECT;
3242 }
3243
3244 static bool
3245 parse_ethertype(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3246 uint64_t present_attrs, uint64_t *expected_attrs,
3247 struct flow *flow, const struct flow *src_flow)
3248 {
3249 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3250 bool is_mask = flow != src_flow;
3251
3252 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE)) {
3253 flow->dl_type = nl_attr_get_be16(attrs[OVS_KEY_ATTR_ETHERTYPE]);
3254 if (!is_mask && ntohs(flow->dl_type) < ETH_TYPE_MIN) {
3255 VLOG_ERR_RL(&rl, "invalid Ethertype %"PRIu16" in flow key",
3256 ntohs(flow->dl_type));
3257 return false;
3258 }
3259 if (is_mask && ntohs(src_flow->dl_type) < ETH_TYPE_MIN &&
3260 flow->dl_type != htons(0xffff)) {
3261 return false;
3262 }
3263 *expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERTYPE;
3264 } else {
3265 if (!is_mask) {
3266 flow->dl_type = htons(FLOW_DL_TYPE_NONE);
3267 } else if (ntohs(src_flow->dl_type) < ETH_TYPE_MIN) {
3268 /* See comments in odp_flow_key_from_flow__(). */
3269 VLOG_ERR_RL(&rl, "mask expected for non-Ethernet II frame");
3270 return false;
3271 }
3272 }
3273 return true;
3274 }
3275
3276 static enum odp_key_fitness
3277 parse_l2_5_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3278 uint64_t present_attrs, int out_of_range_attr,
3279 uint64_t expected_attrs, struct flow *flow,
3280 const struct nlattr *key, size_t key_len,
3281 const struct flow *src_flow)
3282 {
3283 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3284 bool is_mask = src_flow != flow;
3285 const void *check_start = NULL;
3286 size_t check_len = 0;
3287 enum ovs_key_attr expected_bit = 0xff;
3288
3289 if (eth_type_mpls(src_flow->dl_type)) {
3290 if (!is_mask || present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
3291 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_MPLS);
3292 }
3293 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_MPLS)) {
3294 size_t size = nl_attr_get_size(attrs[OVS_KEY_ATTR_MPLS]);
3295 const ovs_be32 *mpls_lse = nl_attr_get(attrs[OVS_KEY_ATTR_MPLS]);
3296 int n = size / sizeof(ovs_be32);
3297 int i;
3298
3299 if (!size || size % sizeof(ovs_be32)) {
3300 return ODP_FIT_ERROR;
3301 }
3302 if (flow->mpls_lse[0] && flow->dl_type != htons(0xffff)) {
3303 return ODP_FIT_ERROR;
3304 }
3305
3306 for (i = 0; i < n && i < FLOW_MAX_MPLS_LABELS; i++) {
3307 flow->mpls_lse[i] = mpls_lse[i];
3308 }
3309 if (n > FLOW_MAX_MPLS_LABELS) {
3310 return ODP_FIT_TOO_MUCH;
3311 }
3312
3313 if (!is_mask) {
3314 /* BOS may be set only in the innermost label. */
3315 for (i = 0; i < n - 1; i++) {
3316 if (flow->mpls_lse[i] & htonl(MPLS_BOS_MASK)) {
3317 return ODP_FIT_ERROR;
3318 }
3319 }
3320
3321 /* BOS must be set in the innermost label. */
3322 if (n < FLOW_MAX_MPLS_LABELS
3323 && !(flow->mpls_lse[n - 1] & htonl(MPLS_BOS_MASK))) {
3324 return ODP_FIT_TOO_LITTLE;
3325 }
3326 }
3327 }
3328
3329 goto done;
3330 } else if (src_flow->dl_type == htons(ETH_TYPE_IP)) {
3331 if (!is_mask) {
3332 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV4;
3333 }
3334 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV4)) {
3335 const struct ovs_key_ipv4 *ipv4_key;
3336
3337 ipv4_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV4]);
3338 put_ipv4_key(ipv4_key, flow, is_mask);
3339 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
3340 return ODP_FIT_ERROR;
3341 }
3342 if (is_mask) {
3343 check_start = ipv4_key;
3344 check_len = sizeof *ipv4_key;
3345 expected_bit = OVS_KEY_ATTR_IPV4;
3346 }
3347 }
3348 } else if (src_flow->dl_type == htons(ETH_TYPE_IPV6)) {
3349 if (!is_mask) {
3350 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IPV6;
3351 }
3352 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IPV6)) {
3353 const struct ovs_key_ipv6 *ipv6_key;
3354
3355 ipv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_IPV6]);
3356 put_ipv6_key(ipv6_key, flow, is_mask);
3357 if (flow->nw_frag > FLOW_NW_FRAG_MASK) {
3358 return ODP_FIT_ERROR;
3359 }
3360 if (is_mask) {
3361 check_start = ipv6_key;
3362 check_len = sizeof *ipv6_key;
3363 expected_bit = OVS_KEY_ATTR_IPV6;
3364 }
3365 }
3366 } else if (src_flow->dl_type == htons(ETH_TYPE_ARP) ||
3367 src_flow->dl_type == htons(ETH_TYPE_RARP)) {
3368 if (!is_mask) {
3369 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ARP;
3370 }
3371 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ARP)) {
3372 const struct ovs_key_arp *arp_key;
3373
3374 arp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ARP]);
3375 if (!is_mask && (arp_key->arp_op & htons(0xff00))) {
3376 VLOG_ERR_RL(&rl, "unsupported ARP opcode %"PRIu16" in flow "
3377 "key", ntohs(arp_key->arp_op));
3378 return ODP_FIT_ERROR;
3379 }
3380 put_arp_key(arp_key, flow);
3381 if (is_mask) {
3382 check_start = arp_key;
3383 check_len = sizeof *arp_key;
3384 expected_bit = OVS_KEY_ATTR_ARP;
3385 }
3386 }
3387 } else {
3388 goto done;
3389 }
3390 if (check_len > 0) { /* Happens only when 'is_mask'. */
3391 if (!is_all_zeros(check_start, check_len) &&
3392 flow->dl_type != htons(0xffff)) {
3393 return ODP_FIT_ERROR;
3394 } else {
3395 expected_attrs |= UINT64_C(1) << expected_bit;
3396 }
3397 }
3398
3399 expected_bit = OVS_KEY_ATTR_UNSPEC;
3400 if (src_flow->nw_proto == IPPROTO_TCP
3401 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
3402 src_flow->dl_type == htons(ETH_TYPE_IPV6))
3403 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3404 if (!is_mask) {
3405 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP;
3406 }
3407 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP)) {
3408 const union ovs_key_tp *tcp_key;
3409
3410 tcp_key = nl_attr_get(attrs[OVS_KEY_ATTR_TCP]);
3411 put_tp_key(tcp_key, flow);
3412 expected_bit = OVS_KEY_ATTR_TCP;
3413 }
3414 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS)) {
3415 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TCP_FLAGS;
3416 flow->tcp_flags = nl_attr_get_be16(attrs[OVS_KEY_ATTR_TCP_FLAGS]);
3417 }
3418 } else if (src_flow->nw_proto == IPPROTO_UDP
3419 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
3420 src_flow->dl_type == htons(ETH_TYPE_IPV6))
3421 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3422 if (!is_mask) {
3423 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_UDP;
3424 }
3425 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_UDP)) {
3426 const union ovs_key_tp *udp_key;
3427
3428 udp_key = nl_attr_get(attrs[OVS_KEY_ATTR_UDP]);
3429 put_tp_key(udp_key, flow);
3430 expected_bit = OVS_KEY_ATTR_UDP;
3431 }
3432 } else if (src_flow->nw_proto == IPPROTO_SCTP
3433 && (src_flow->dl_type == htons(ETH_TYPE_IP) ||
3434 src_flow->dl_type == htons(ETH_TYPE_IPV6))
3435 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3436 if (!is_mask) {
3437 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SCTP;
3438 }
3439 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SCTP)) {
3440 const union ovs_key_tp *sctp_key;
3441
3442 sctp_key = nl_attr_get(attrs[OVS_KEY_ATTR_SCTP]);
3443 put_tp_key(sctp_key, flow);
3444 expected_bit = OVS_KEY_ATTR_SCTP;
3445 }
3446 } else if (src_flow->nw_proto == IPPROTO_ICMP
3447 && src_flow->dl_type == htons(ETH_TYPE_IP)
3448 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3449 if (!is_mask) {
3450 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMP;
3451 }
3452 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMP)) {
3453 const struct ovs_key_icmp *icmp_key;
3454
3455 icmp_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMP]);
3456 flow->tp_src = htons(icmp_key->icmp_type);
3457 flow->tp_dst = htons(icmp_key->icmp_code);
3458 expected_bit = OVS_KEY_ATTR_ICMP;
3459 }
3460 } else if (src_flow->nw_proto == IPPROTO_ICMPV6
3461 && src_flow->dl_type == htons(ETH_TYPE_IPV6)
3462 && !(src_flow->nw_frag & FLOW_NW_FRAG_LATER)) {
3463 if (!is_mask) {
3464 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ICMPV6;
3465 }
3466 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ICMPV6)) {
3467 const struct ovs_key_icmpv6 *icmpv6_key;
3468
3469 icmpv6_key = nl_attr_get(attrs[OVS_KEY_ATTR_ICMPV6]);
3470 flow->tp_src = htons(icmpv6_key->icmpv6_type);
3471 flow->tp_dst = htons(icmpv6_key->icmpv6_code);
3472 expected_bit = OVS_KEY_ATTR_ICMPV6;
3473 if (src_flow->tp_dst == htons(0) &&
3474 (src_flow->tp_src == htons(ND_NEIGHBOR_SOLICIT) ||
3475 src_flow->tp_src == htons(ND_NEIGHBOR_ADVERT))) {
3476 if (!is_mask) {
3477 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
3478 }
3479 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ND)) {
3480 const struct ovs_key_nd *nd_key;
3481
3482 nd_key = nl_attr_get(attrs[OVS_KEY_ATTR_ND]);
3483 memcpy(&flow->nd_target, nd_key->nd_target,
3484 sizeof flow->nd_target);
3485 memcpy(flow->arp_sha, nd_key->nd_sll, ETH_ADDR_LEN);
3486 memcpy(flow->arp_tha, nd_key->nd_tll, ETH_ADDR_LEN);
3487 if (is_mask) {
3488 if (!is_all_zeros(nd_key, sizeof *nd_key) &&
3489 (flow->tp_src != htons(0xffff) ||
3490 flow->tp_dst != htons(0xffff))) {
3491 return ODP_FIT_ERROR;
3492 } else {
3493 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ND;
3494 }
3495 }
3496 }
3497 }
3498 }
3499 }
3500 if (is_mask && expected_bit != OVS_KEY_ATTR_UNSPEC) {
3501 if ((flow->tp_src || flow->tp_dst) && flow->nw_proto != 0xff) {
3502 return ODP_FIT_ERROR;
3503 } else {
3504 expected_attrs |= UINT64_C(1) << expected_bit;
3505 }
3506 }
3507
3508 done:
3509 return check_expectations(present_attrs, out_of_range_attr, expected_attrs,
3510 key, key_len);
3511 }
3512
3513 /* Parse 802.1Q header then encapsulated L3 attributes. */
3514 static enum odp_key_fitness
3515 parse_8021q_onward(const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1],
3516 uint64_t present_attrs, int out_of_range_attr,
3517 uint64_t expected_attrs, struct flow *flow,
3518 const struct nlattr *key, size_t key_len,
3519 const struct flow *src_flow)
3520 {
3521 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3522 bool is_mask = src_flow != flow;
3523
3524 const struct nlattr *encap
3525 = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)
3526 ? attrs[OVS_KEY_ATTR_ENCAP] : NULL);
3527 enum odp_key_fitness encap_fitness;
3528 enum odp_key_fitness fitness;
3529
3530 /* Calculate fitness of outer attributes. */
3531 if (!is_mask) {
3532 expected_attrs |= ((UINT64_C(1) << OVS_KEY_ATTR_VLAN) |
3533 (UINT64_C(1) << OVS_KEY_ATTR_ENCAP));
3534 } else {
3535 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
3536 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
3537 }
3538 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP)) {
3539 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_ENCAP);
3540 }
3541 }
3542 fitness = check_expectations(present_attrs, out_of_range_attr,
3543 expected_attrs, key, key_len);
3544
3545 /* Set vlan_tci.
3546 * Remove the TPID from dl_type since it's not the real Ethertype. */
3547 flow->dl_type = htons(0);
3548 flow->vlan_tci = (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)
3549 ? nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN])
3550 : htons(0));
3551 if (!is_mask) {
3552 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN))) {
3553 return ODP_FIT_TOO_LITTLE;
3554 } else if (flow->vlan_tci == htons(0)) {
3555 /* Corner case for a truncated 802.1Q header. */
3556 if (fitness == ODP_FIT_PERFECT && nl_attr_get_size(encap)) {
3557 return ODP_FIT_TOO_MUCH;
3558 }
3559 return fitness;
3560 } else if (!(flow->vlan_tci & htons(VLAN_CFI))) {
3561 VLOG_ERR_RL(&rl, "OVS_KEY_ATTR_VLAN 0x%04"PRIx16" is nonzero "
3562 "but CFI bit is not set", ntohs(flow->vlan_tci));
3563 return ODP_FIT_ERROR;
3564 }
3565 } else {
3566 if (!(present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ENCAP))) {
3567 return fitness;
3568 }
3569 }
3570
3571 /* Now parse the encapsulated attributes. */
3572 if (!parse_flow_nlattrs(nl_attr_get(encap), nl_attr_get_size(encap),
3573 attrs, &present_attrs, &out_of_range_attr)) {
3574 return ODP_FIT_ERROR;
3575 }
3576 expected_attrs = 0;
3577
3578 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow, src_flow)) {
3579 return ODP_FIT_ERROR;
3580 }
3581 encap_fitness = parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
3582 expected_attrs, flow, key, key_len,
3583 src_flow);
3584
3585 /* The overall fitness is the worse of the outer and inner attributes. */
3586 return MAX(fitness, encap_fitness);
3587 }
3588
3589 static enum odp_key_fitness
3590 odp_flow_key_to_flow__(const struct nlattr *key, size_t key_len,
3591 struct flow *flow, const struct flow *src_flow)
3592 {
3593 const struct nlattr *attrs[OVS_KEY_ATTR_MAX + 1];
3594 uint64_t expected_attrs;
3595 uint64_t present_attrs;
3596 int out_of_range_attr;
3597 bool is_mask = src_flow != flow;
3598
3599 memset(flow, 0, sizeof *flow);
3600
3601 /* Parse attributes. */
3602 if (!parse_flow_nlattrs(key, key_len, attrs, &present_attrs,
3603 &out_of_range_attr)) {
3604 return ODP_FIT_ERROR;
3605 }
3606 expected_attrs = 0;
3607
3608 /* Metadata. */
3609 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID)) {
3610 flow->recirc_id = nl_attr_get_u32(attrs[OVS_KEY_ATTR_RECIRC_ID]);
3611 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_RECIRC_ID;
3612 } else if (is_mask) {
3613 /* Always exact match recirc_id if it is not specified. */
3614 flow->recirc_id = UINT32_MAX;
3615 }
3616
3617 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_DP_HASH)) {
3618 flow->dp_hash = nl_attr_get_u32(attrs[OVS_KEY_ATTR_DP_HASH]);
3619 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_DP_HASH;
3620 }
3621 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_PRIORITY)) {
3622 flow->skb_priority = nl_attr_get_u32(attrs[OVS_KEY_ATTR_PRIORITY]);
3623 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_PRIORITY;
3624 }
3625
3626 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK)) {
3627 flow->pkt_mark = nl_attr_get_u32(attrs[OVS_KEY_ATTR_SKB_MARK]);
3628 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_SKB_MARK;
3629 }
3630
3631 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_TUNNEL)) {
3632 enum odp_key_fitness res;
3633
3634 res = odp_tun_key_from_attr(attrs[OVS_KEY_ATTR_TUNNEL], &flow->tunnel);
3635 if (res == ODP_FIT_ERROR) {
3636 return ODP_FIT_ERROR;
3637 } else if (res == ODP_FIT_PERFECT) {
3638 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_TUNNEL;
3639 }
3640 }
3641
3642 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_IN_PORT)) {
3643 flow->in_port.odp_port
3644 = nl_attr_get_odp_port(attrs[OVS_KEY_ATTR_IN_PORT]);
3645 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_IN_PORT;
3646 } else if (!is_mask) {
3647 flow->in_port.odp_port = ODPP_NONE;
3648 }
3649
3650 /* Ethernet header. */
3651 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_ETHERNET)) {
3652 const struct ovs_key_ethernet *eth_key;
3653
3654 eth_key = nl_attr_get(attrs[OVS_KEY_ATTR_ETHERNET]);
3655 put_ethernet_key(eth_key, flow);
3656 if (is_mask) {
3657 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
3658 }
3659 }
3660 if (!is_mask) {
3661 expected_attrs |= UINT64_C(1) << OVS_KEY_ATTR_ETHERNET;
3662 }
3663
3664 /* Get Ethertype or 802.1Q TPID or FLOW_DL_TYPE_NONE. */
3665 if (!parse_ethertype(attrs, present_attrs, &expected_attrs, flow,
3666 src_flow)) {
3667 return ODP_FIT_ERROR;
3668 }
3669
3670 if (is_mask
3671 ? (src_flow->vlan_tci & htons(VLAN_CFI)) != 0
3672 : src_flow->dl_type == htons(ETH_TYPE_VLAN)) {
3673 return parse_8021q_onward(attrs, present_attrs, out_of_range_attr,
3674 expected_attrs, flow, key, key_len, src_flow);
3675 }
3676 if (is_mask) {
3677 flow->vlan_tci = htons(0xffff);
3678 if (present_attrs & (UINT64_C(1) << OVS_KEY_ATTR_VLAN)) {
3679 flow->vlan_tci = nl_attr_get_be16(attrs[OVS_KEY_ATTR_VLAN]);
3680 expected_attrs |= (UINT64_C(1) << OVS_KEY_ATTR_VLAN);
3681 }
3682 }
3683 return parse_l2_5_onward(attrs, present_attrs, out_of_range_attr,
3684 expected_attrs, flow, key, key_len, src_flow);
3685 }
3686
3687 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a flow
3688 * structure in 'flow'. Returns an ODP_FIT_* value that indicates how well
3689 * 'key' fits our expectations for what a flow key should contain.
3690 *
3691 * The 'in_port' will be the datapath's understanding of the port. The
3692 * caller will need to translate with odp_port_to_ofp_port() if the
3693 * OpenFlow port is needed.
3694 *
3695 * This function doesn't take the packet itself as an argument because none of
3696 * the currently understood OVS_KEY_ATTR_* attributes require it. Currently,
3697 * it is always possible to infer which additional attribute(s) should appear
3698 * by looking at the attributes for lower-level protocols, e.g. if the network
3699 * protocol in OVS_KEY_ATTR_IPV4 or OVS_KEY_ATTR_IPV6 is IPPROTO_TCP then we
3700 * know that a OVS_KEY_ATTR_TCP attribute must appear and that otherwise it
3701 * must be absent. */
3702 enum odp_key_fitness
3703 odp_flow_key_to_flow(const struct nlattr *key, size_t key_len,
3704 struct flow *flow)
3705 {
3706 return odp_flow_key_to_flow__(key, key_len, flow, flow);
3707 }
3708
3709 /* Converts the 'key_len' bytes of OVS_KEY_ATTR_* attributes in 'key' to a mask
3710 * structure in 'mask'. 'flow' must be a previously translated flow
3711 * corresponding to 'mask'. Returns an ODP_FIT_* value that indicates how well
3712 * 'key' fits our expectations for what a flow key should contain. */
3713 enum odp_key_fitness
3714 odp_flow_key_to_mask(const struct nlattr *key, size_t key_len,
3715 struct flow *mask, const struct flow *flow)
3716 {
3717 return odp_flow_key_to_flow__(key, key_len, mask, flow);
3718 }
3719
3720 /* Returns 'fitness' as a string, for use in debug messages. */
3721 const char *
3722 odp_key_fitness_to_string(enum odp_key_fitness fitness)
3723 {
3724 switch (fitness) {
3725 case ODP_FIT_PERFECT:
3726 return "OK";
3727 case ODP_FIT_TOO_MUCH:
3728 return "too_much";
3729 case ODP_FIT_TOO_LITTLE:
3730 return "too_little";
3731 case ODP_FIT_ERROR:
3732 return "error";
3733 default:
3734 return "<unknown>";
3735 }
3736 }
3737
3738 /* Appends an OVS_ACTION_ATTR_USERSPACE action to 'odp_actions' that specifies
3739 * Netlink PID 'pid'. If 'userdata' is nonnull, adds a userdata attribute
3740 * whose contents are the 'userdata_size' bytes at 'userdata' and returns the
3741 * offset within 'odp_actions' of the start of the cookie. (If 'userdata' is
3742 * null, then the return value is not meaningful.) */
3743 size_t
3744 odp_put_userspace_action(uint32_t pid,
3745 const void *userdata, size_t userdata_size,
3746 odp_port_t tunnel_out_port,
3747 struct ofpbuf *odp_actions)
3748 {
3749 size_t userdata_ofs;
3750 size_t offset;
3751
3752 offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_USERSPACE);
3753 nl_msg_put_u32(odp_actions, OVS_USERSPACE_ATTR_PID, pid);
3754 if (userdata) {
3755 userdata_ofs = ofpbuf_size(odp_actions) + NLA_HDRLEN;
3756
3757 /* The OVS kernel module before OVS 1.11 and the upstream Linux kernel
3758 * module before Linux 3.10 required the userdata to be exactly 8 bytes
3759 * long:
3760 *
3761 * - The kernel rejected shorter userdata with -ERANGE.
3762 *
3763 * - The kernel silently dropped userdata beyond the first 8 bytes.
3764 *
3765 * Thus, for maximum compatibility, always put at least 8 bytes. (We
3766 * separately disable features that required more than 8 bytes.) */
3767 memcpy(nl_msg_put_unspec_zero(odp_actions, OVS_USERSPACE_ATTR_USERDATA,
3768 MAX(8, userdata_size)),
3769 userdata, userdata_size);
3770 } else {
3771 userdata_ofs = 0;
3772 }
3773 if (tunnel_out_port != ODPP_NONE) {
3774 nl_msg_put_odp_port(odp_actions, OVS_USERSPACE_ATTR_EGRESS_TUN_PORT,
3775 tunnel_out_port);
3776 }
3777 nl_msg_end_nested(odp_actions, offset);
3778
3779 return userdata_ofs;
3780 }
3781
3782 void
3783 odp_put_tunnel_action(const struct flow_tnl *tunnel,
3784 struct ofpbuf *odp_actions)
3785 {
3786 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
3787 tun_key_to_attr(odp_actions, tunnel);
3788 nl_msg_end_nested(odp_actions, offset);
3789 }
3790
3791 void
3792 odp_put_tnl_push_action(struct ofpbuf *odp_actions,
3793 struct ovs_action_push_tnl *data)
3794 {
3795 int size = offsetof(struct ovs_action_push_tnl, header);
3796
3797 size += data->header_len;
3798 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_TUNNEL_PUSH, data, size);
3799 }
3800
3801 \f
3802 /* The commit_odp_actions() function and its helpers. */
3803
3804 static void
3805 commit_set_action(struct ofpbuf *odp_actions, enum ovs_key_attr key_type,
3806 const void *key, size_t key_size)
3807 {
3808 size_t offset = nl_msg_start_nested(odp_actions, OVS_ACTION_ATTR_SET);
3809 nl_msg_put_unspec(odp_actions, key_type, key, key_size);
3810 nl_msg_end_nested(odp_actions, offset);
3811 }
3812
3813 /* Masked set actions have a mask following the data within the netlink
3814 * attribute. The unmasked bits in the data will be cleared as the data
3815 * is copied to the action. */
3816 void
3817 commit_masked_set_action(struct ofpbuf *odp_actions,
3818 enum ovs_key_attr key_type,
3819 const void *key_, const void *mask_, size_t key_size)
3820 {
3821 size_t offset = nl_msg_start_nested(odp_actions,
3822 OVS_ACTION_ATTR_SET_MASKED);
3823 char *data = nl_msg_put_unspec_uninit(odp_actions, key_type, key_size * 2);
3824 const char *key = key_, *mask = mask_;
3825
3826 memcpy(data + key_size, mask, key_size);
3827 /* Clear unmasked bits while copying. */
3828 while (key_size--) {
3829 *data++ = *key++ & *mask++;
3830 }
3831 nl_msg_end_nested(odp_actions, offset);
3832 }
3833
3834 /* If any of the flow key data that ODP actions can modify are different in
3835 * 'base->tunnel' and 'flow->tunnel', appends a set_tunnel ODP action to
3836 * 'odp_actions' that change the flow tunneling information in key from
3837 * 'base->tunnel' into 'flow->tunnel', and then changes 'base->tunnel' in the
3838 * same way. In other words, operates the same as commit_odp_actions(), but
3839 * only on tunneling information. */
3840 void
3841 commit_odp_tunnel_action(const struct flow *flow, struct flow *base,
3842 struct ofpbuf *odp_actions)
3843 {
3844 /* A valid IPV4_TUNNEL must have non-zero ip_dst. */
3845 if (flow->tunnel.ip_dst) {
3846 if (!memcmp(&base->tunnel, &flow->tunnel, sizeof base->tunnel)) {
3847 return;
3848 }
3849 memcpy(&base->tunnel, &flow->tunnel, sizeof base->tunnel);
3850 odp_put_tunnel_action(&base->tunnel, odp_actions);
3851 }
3852 }
3853
3854 static bool
3855 commit(enum ovs_key_attr attr, bool use_masked_set,
3856 const void *key, void *base, void *mask, size_t size,
3857 struct ofpbuf *odp_actions)
3858 {
3859 if (memcmp(key, base, size)) {
3860 bool fully_masked = odp_mask_is_exact(attr, mask, size);
3861
3862 if (use_masked_set && !fully_masked) {
3863 commit_masked_set_action(odp_actions, attr, key, mask, size);
3864 } else {
3865 if (!fully_masked) {
3866 memset(mask, 0xff, size);
3867 }
3868 commit_set_action(odp_actions, attr, key, size);
3869 }
3870 memcpy(base, key, size);
3871 return true;
3872 } else {
3873 /* Mask bits are set when we have either read or set the corresponding
3874 * values. Masked bits will be exact-matched, no need to set them
3875 * if the value did not actually change. */
3876 return false;
3877 }
3878 }
3879
3880 static void
3881 get_ethernet_key(const struct flow *flow, struct ovs_key_ethernet *eth)
3882 {
3883 memcpy(eth->eth_src, flow->dl_src, ETH_ADDR_LEN);
3884 memcpy(eth->eth_dst, flow->dl_dst, ETH_ADDR_LEN);
3885 }
3886
3887 static void
3888 put_ethernet_key(const struct ovs_key_ethernet *eth, struct flow *flow)
3889 {
3890 memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
3891 memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
3892 }
3893
3894 static void
3895 commit_set_ether_addr_action(const struct flow *flow, struct flow *base_flow,
3896 struct ofpbuf *odp_actions,
3897 struct flow_wildcards *wc,
3898 bool use_masked)
3899 {
3900 struct ovs_key_ethernet key, base, mask;
3901
3902 get_ethernet_key(flow, &key);
3903 get_ethernet_key(base_flow, &base);
3904 get_ethernet_key(&wc->masks, &mask);
3905
3906 if (commit(OVS_KEY_ATTR_ETHERNET, use_masked,
3907 &key, &base, &mask, sizeof key, odp_actions)) {
3908 put_ethernet_key(&base, base_flow);
3909 put_ethernet_key(&mask, &wc->masks);
3910 }
3911 }
3912
3913 static void
3914 pop_vlan(struct flow *base,
3915 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3916 {
3917 memset(&wc->masks.vlan_tci, 0xff, sizeof wc->masks.vlan_tci);
3918
3919 if (base->vlan_tci & htons(VLAN_CFI)) {
3920 nl_msg_put_flag(odp_actions, OVS_ACTION_ATTR_POP_VLAN);
3921 base->vlan_tci = 0;
3922 }
3923 }
3924
3925 static void
3926 commit_vlan_action(ovs_be16 vlan_tci, struct flow *base,
3927 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
3928 {
3929 if (base->vlan_tci == vlan_tci) {
3930 return;
3931 }
3932
3933 pop_vlan(base, odp_actions, wc);
3934 if (vlan_tci & htons(VLAN_CFI)) {
3935 struct ovs_action_push_vlan vlan;
3936
3937 vlan.vlan_tpid = htons(ETH_TYPE_VLAN);
3938 vlan.vlan_tci = vlan_tci;
3939 nl_msg_put_unspec(odp_actions, OVS_ACTION_ATTR_PUSH_VLAN,
3940 &vlan, sizeof vlan);
3941 }
3942 base->vlan_tci = vlan_tci;
3943 }
3944
3945 /* Wildcarding already done at action translation time. */
3946 static void
3947 commit_mpls_action(const struct flow *flow, struct flow *base,
3948 struct ofpbuf *odp_actions)
3949 {
3950 int base_n = flow_count_mpls_labels(base, NULL);
3951 int flow_n = flow_count_mpls_labels(flow, NULL);
3952 int common_n = flow_count_common_mpls_labels(flow, flow_n, base, base_n,
3953 NULL);
3954
3955 while (base_n > common_n) {
3956 if (base_n - 1 == common_n && flow_n > common_n) {
3957 /* If there is only one more LSE in base than there are common
3958 * between base and flow; and flow has at least one more LSE than
3959 * is common then the topmost LSE of base may be updated using
3960 * set */
3961 struct ovs_key_mpls mpls_key;
3962
3963 mpls_key.mpls_lse = flow->mpls_lse[flow_n - base_n];
3964 commit_set_action(odp_actions, OVS_KEY_ATTR_MPLS,
3965 &mpls_key, sizeof mpls_key);
3966 flow_set_mpls_lse(base, 0, mpls_key.mpls_lse);
3967 common_n++;
3968 } else {
3969 /* Otherwise, if there more LSEs in base than are common between
3970 * base and flow then pop the topmost one. */
3971 ovs_be16 dl_type;
3972 bool popped;
3973
3974 /* If all the LSEs are to be popped and this is not the outermost
3975 * LSE then use ETH_TYPE_MPLS as the ethertype parameter of the
3976 * POP_MPLS action instead of flow->dl_type.
3977 *
3978 * This is because the POP_MPLS action requires its ethertype
3979 * argument to be an MPLS ethernet type but in this case
3980 * flow->dl_type will be a non-MPLS ethernet type.
3981 *
3982 * When the final POP_MPLS action occurs it use flow->dl_type and
3983 * the and the resulting packet will have the desired dl_type. */
3984 if ((!eth_type_mpls(flow->dl_type)) && base_n > 1) {
3985 dl_type = htons(ETH_TYPE_MPLS);
3986 } else {
3987 dl_type = flow->dl_type;
3988 }
3989 nl_msg_put_be16(odp_actions, OVS_ACTION_ATTR_POP_MPLS, dl_type);
3990 popped = flow_pop_mpls(base, base_n, flow->dl_type, NULL);
3991 ovs_assert(popped);
3992 base_n--;
3993 }
3994 }
3995
3996 /* If, after the above popping and setting, there are more LSEs in flow
3997 * than base then some LSEs need to be pushed. */
3998 while (base_n < flow_n) {
3999 struct ovs_action_push_mpls *mpls;
4000
4001 mpls = nl_msg_put_unspec_zero(odp_actions,
4002 OVS_ACTION_ATTR_PUSH_MPLS,
4003 sizeof *mpls);
4004 mpls->mpls_ethertype = flow->dl_type;
4005 mpls->mpls_lse = flow->mpls_lse[flow_n - base_n - 1];
4006 flow_push_mpls(base, base_n, mpls->mpls_ethertype, NULL);
4007 flow_set_mpls_lse(base, 0, mpls->mpls_lse);
4008 base_n++;
4009 }
4010 }
4011
4012 static void
4013 get_ipv4_key(const struct flow *flow, struct ovs_key_ipv4 *ipv4, bool is_mask)
4014 {
4015 ipv4->ipv4_src = flow->nw_src;
4016 ipv4->ipv4_dst = flow->nw_dst;
4017 ipv4->ipv4_proto = flow->nw_proto;
4018 ipv4->ipv4_tos = flow->nw_tos;
4019 ipv4->ipv4_ttl = flow->nw_ttl;
4020 ipv4->ipv4_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4021 }
4022
4023 static void
4024 put_ipv4_key(const struct ovs_key_ipv4 *ipv4, struct flow *flow, bool is_mask)
4025 {
4026 flow->nw_src = ipv4->ipv4_src;
4027 flow->nw_dst = ipv4->ipv4_dst;
4028 flow->nw_proto = ipv4->ipv4_proto;
4029 flow->nw_tos = ipv4->ipv4_tos;
4030 flow->nw_ttl = ipv4->ipv4_ttl;
4031 flow->nw_frag = odp_to_ovs_frag(ipv4->ipv4_frag, is_mask);
4032 }
4033
4034 static void
4035 commit_set_ipv4_action(const struct flow *flow, struct flow *base_flow,
4036 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4037 bool use_masked)
4038 {
4039 struct ovs_key_ipv4 key, mask, base;
4040
4041 /* Check that nw_proto and nw_frag remain unchanged. */
4042 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4043 flow->nw_frag == base_flow->nw_frag);
4044
4045 get_ipv4_key(flow, &key, false);
4046 get_ipv4_key(base_flow, &base, false);
4047 get_ipv4_key(&wc->masks, &mask, true);
4048 mask.ipv4_proto = 0; /* Not writeable. */
4049 mask.ipv4_frag = 0; /* Not writable. */
4050
4051 if (commit(OVS_KEY_ATTR_IPV4, use_masked, &key, &base, &mask, sizeof key,
4052 odp_actions)) {
4053 put_ipv4_key(&base, base_flow, false);
4054 if (mask.ipv4_proto != 0) { /* Mask was changed by commit(). */
4055 put_ipv4_key(&mask, &wc->masks, true);
4056 }
4057 }
4058 }
4059
4060 static void
4061 get_ipv6_key(const struct flow *flow, struct ovs_key_ipv6 *ipv6, bool is_mask)
4062 {
4063 memcpy(ipv6->ipv6_src, &flow->ipv6_src, sizeof ipv6->ipv6_src);
4064 memcpy(ipv6->ipv6_dst, &flow->ipv6_dst, sizeof ipv6->ipv6_dst);
4065 ipv6->ipv6_label = flow->ipv6_label;
4066 ipv6->ipv6_proto = flow->nw_proto;
4067 ipv6->ipv6_tclass = flow->nw_tos;
4068 ipv6->ipv6_hlimit = flow->nw_ttl;
4069 ipv6->ipv6_frag = ovs_to_odp_frag(flow->nw_frag, is_mask);
4070 }
4071
4072 static void
4073 put_ipv6_key(const struct ovs_key_ipv6 *ipv6, struct flow *flow, bool is_mask)
4074 {
4075 memcpy(&flow->ipv6_src, ipv6->ipv6_src, sizeof flow->ipv6_src);
4076 memcpy(&flow->ipv6_dst, ipv6->ipv6_dst, sizeof flow->ipv6_dst);
4077 flow->ipv6_label = ipv6->ipv6_label;
4078 flow->nw_proto = ipv6->ipv6_proto;
4079 flow->nw_tos = ipv6->ipv6_tclass;
4080 flow->nw_ttl = ipv6->ipv6_hlimit;
4081 flow->nw_frag = odp_to_ovs_frag(ipv6->ipv6_frag, is_mask);
4082 }
4083
4084 static void
4085 commit_set_ipv6_action(const struct flow *flow, struct flow *base_flow,
4086 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4087 bool use_masked)
4088 {
4089 struct ovs_key_ipv6 key, mask, base;
4090
4091 /* Check that nw_proto and nw_frag remain unchanged. */
4092 ovs_assert(flow->nw_proto == base_flow->nw_proto &&
4093 flow->nw_frag == base_flow->nw_frag);
4094
4095 get_ipv6_key(flow, &key, false);
4096 get_ipv6_key(base_flow, &base, false);
4097 get_ipv6_key(&wc->masks, &mask, true);
4098 mask.ipv6_proto = 0; /* Not writeable. */
4099 mask.ipv6_frag = 0; /* Not writable. */
4100
4101 if (commit(OVS_KEY_ATTR_IPV6, use_masked, &key, &base, &mask, sizeof key,
4102 odp_actions)) {
4103 put_ipv6_key(&base, base_flow, false);
4104 if (mask.ipv6_proto != 0) { /* Mask was changed by commit(). */
4105 put_ipv6_key(&mask, &wc->masks, true);
4106 }
4107 }
4108 }
4109
4110 static void
4111 get_arp_key(const struct flow *flow, struct ovs_key_arp *arp)
4112 {
4113 /* ARP key has padding, clear it. */
4114 memset(arp, 0, sizeof *arp);
4115
4116 arp->arp_sip = flow->nw_src;
4117 arp->arp_tip = flow->nw_dst;
4118 arp->arp_op = htons(flow->nw_proto);
4119 memcpy(arp->arp_sha, flow->arp_sha, ETH_ADDR_LEN);
4120 memcpy(arp->arp_tha, flow->arp_tha, ETH_ADDR_LEN);
4121 }
4122
4123 static void
4124 put_arp_key(const struct ovs_key_arp *arp, struct flow *flow)
4125 {
4126 flow->nw_src = arp->arp_sip;
4127 flow->nw_dst = arp->arp_tip;
4128 flow->nw_proto = ntohs(arp->arp_op);
4129 memcpy(flow->arp_sha, arp->arp_sha, ETH_ADDR_LEN);
4130 memcpy(flow->arp_tha, arp->arp_tha, ETH_ADDR_LEN);
4131 }
4132
4133 static enum slow_path_reason
4134 commit_set_arp_action(const struct flow *flow, struct flow *base_flow,
4135 struct ofpbuf *odp_actions, struct flow_wildcards *wc)
4136 {
4137 struct ovs_key_arp key, mask, base;
4138
4139 get_arp_key(flow, &key);
4140 get_arp_key(base_flow, &base);
4141 get_arp_key(&wc->masks, &mask);
4142
4143 if (commit(OVS_KEY_ATTR_ARP, true, &key, &base, &mask, sizeof key,
4144 odp_actions)) {
4145 put_arp_key(&base, base_flow);
4146 put_arp_key(&mask, &wc->masks);
4147 return SLOW_ACTION;
4148 }
4149 return 0;
4150 }
4151
4152 static enum slow_path_reason
4153 commit_set_nw_action(const struct flow *flow, struct flow *base,
4154 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4155 bool use_masked)
4156 {
4157 /* Check if 'flow' really has an L3 header. */
4158 if (!flow->nw_proto) {
4159 return 0;
4160 }
4161
4162 switch (ntohs(base->dl_type)) {
4163 case ETH_TYPE_IP:
4164 commit_set_ipv4_action(flow, base, odp_actions, wc, use_masked);
4165 break;
4166
4167 case ETH_TYPE_IPV6:
4168 commit_set_ipv6_action(flow, base, odp_actions, wc, use_masked);
4169 break;
4170
4171 case ETH_TYPE_ARP:
4172 return commit_set_arp_action(flow, base, odp_actions, wc);
4173 }
4174
4175 return 0;
4176 }
4177
4178 /* TCP, UDP, and SCTP keys have the same layout. */
4179 BUILD_ASSERT_DECL(sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_udp) &&
4180 sizeof(struct ovs_key_tcp) == sizeof(struct ovs_key_sctp));
4181
4182 static void
4183 get_tp_key(const struct flow *flow, union ovs_key_tp *tp)
4184 {
4185 tp->tcp.tcp_src = flow->tp_src;
4186 tp->tcp.tcp_dst = flow->tp_dst;
4187 }
4188
4189 static void
4190 put_tp_key(const union ovs_key_tp *tp, struct flow *flow)
4191 {
4192 flow->tp_src = tp->tcp.tcp_src;
4193 flow->tp_dst = tp->tcp.tcp_dst;
4194 }
4195
4196 static void
4197 commit_set_port_action(const struct flow *flow, struct flow *base_flow,
4198 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4199 bool use_masked)
4200 {
4201 enum ovs_key_attr key_type;
4202 union ovs_key_tp key, mask, base;
4203
4204 /* Check if 'flow' really has an L3 header. */
4205 if (!flow->nw_proto) {
4206 return;
4207 }
4208
4209 if (!is_ip_any(base_flow)) {
4210 return;
4211 }
4212
4213 if (flow->nw_proto == IPPROTO_TCP) {
4214 key_type = OVS_KEY_ATTR_TCP;
4215 } else if (flow->nw_proto == IPPROTO_UDP) {
4216 key_type = OVS_KEY_ATTR_UDP;
4217 } else if (flow->nw_proto == IPPROTO_SCTP) {
4218 key_type = OVS_KEY_ATTR_SCTP;
4219 } else {
4220 return;
4221 }
4222
4223 get_tp_key(flow, &key);
4224 get_tp_key(base_flow, &base);
4225 get_tp_key(&wc->masks, &mask);
4226
4227 if (commit(key_type, use_masked, &key, &base, &mask, sizeof key,
4228 odp_actions)) {
4229 put_tp_key(&base, base_flow);
4230 put_tp_key(&mask, &wc->masks);
4231 }
4232 }
4233
4234 static void
4235 commit_set_priority_action(const struct flow *flow, struct flow *base_flow,
4236 struct ofpbuf *odp_actions,
4237 struct flow_wildcards *wc,
4238 bool use_masked)
4239 {
4240 uint32_t key, mask, base;
4241
4242 key = flow->skb_priority;
4243 base = base_flow->skb_priority;
4244 mask = wc->masks.skb_priority;
4245
4246 if (commit(OVS_KEY_ATTR_PRIORITY, use_masked, &key, &base, &mask,
4247 sizeof key, odp_actions)) {
4248 base_flow->skb_priority = base;
4249 wc->masks.skb_priority = mask;
4250 }
4251 }
4252
4253 static void
4254 commit_set_pkt_mark_action(const struct flow *flow, struct flow *base_flow,
4255 struct ofpbuf *odp_actions,
4256 struct flow_wildcards *wc,
4257 bool use_masked)
4258 {
4259 uint32_t key, mask, base;
4260
4261 key = flow->pkt_mark;
4262 base = base_flow->pkt_mark;
4263 mask = wc->masks.pkt_mark;
4264
4265 if (commit(OVS_KEY_ATTR_SKB_MARK, use_masked, &key, &base, &mask,
4266 sizeof key, odp_actions)) {
4267 base_flow->pkt_mark = base;
4268 wc->masks.pkt_mark = mask;
4269 }
4270 }
4271
4272 /* If any of the flow key data that ODP actions can modify are different in
4273 * 'base' and 'flow', appends ODP actions to 'odp_actions' that change the flow
4274 * key from 'base' into 'flow', and then changes 'base' the same way. Does not
4275 * commit set_tunnel actions. Users should call commit_odp_tunnel_action()
4276 * in addition to this function if needed. Sets fields in 'wc' that are
4277 * used as part of the action.
4278 *
4279 * Returns a reason to force processing the flow's packets into the userspace
4280 * slow path, if there is one, otherwise 0. */
4281 enum slow_path_reason
4282 commit_odp_actions(const struct flow *flow, struct flow *base,
4283 struct ofpbuf *odp_actions, struct flow_wildcards *wc,
4284 bool use_masked)
4285 {
4286 enum slow_path_reason slow;
4287
4288 commit_set_ether_addr_action(flow, base, odp_actions, wc, use_masked);
4289 slow = commit_set_nw_action(flow, base, odp_actions, wc, use_masked);
4290 commit_set_port_action(flow, base, odp_actions, wc, use_masked);
4291 commit_mpls_action(flow, base, odp_actions);
4292 commit_vlan_action(flow->vlan_tci, base, odp_actions, wc);
4293 commit_set_priority_action(flow, base, odp_actions, wc, use_masked);
4294 commit_set_pkt_mark_action(flow, base, odp_actions, wc, use_masked);
4295
4296 return slow;
4297 }
openvswitch packages for PVE