datapath-windows: Allow NdisSwitchPortTypeSynthetic to be updated
[cascardo/ovs.git] / lib / odp-execute.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
3  * Copyright (c) 2013 Simon Horman
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #include <config.h>
19 #include "odp-execute.h"
20 #include <arpa/inet.h>
21 #include <netinet/in.h>
22 #include <netinet/icmp6.h>
23 #include <netinet/ip6.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "dp-packet.h"
28 #include "dpif.h"
29 #include "netlink.h"
30 #include "odp-netlink.h"
31 #include "odp-util.h"
32 #include "packets.h"
33 #include "flow.h"
34 #include "unaligned.h"
35 #include "util.h"
36
37 /* Masked copy of an ethernet address. 'src' is already properly masked. */
38 static void
39 ether_addr_copy_masked(uint8_t *dst, const uint8_t *src,
40                        const uint8_t *mask)
41 {
42     int i;
43
44     for (i = 0; i < ETH_ADDR_LEN; i++) {
45         dst[i] = src[i] | (dst[i] & ~mask[i]);
46     }
47 }
48
49 static void
50 odp_eth_set_addrs(struct dp_packet *packet, const struct ovs_key_ethernet *key,
51                   const struct ovs_key_ethernet *mask)
52 {
53     struct eth_header *eh = dp_packet_l2(packet);
54
55     if (eh) {
56         if (!mask) {
57             memcpy(eh->eth_src, key->eth_src, sizeof eh->eth_src);
58             memcpy(eh->eth_dst, key->eth_dst, sizeof eh->eth_dst);
59         } else {
60             ether_addr_copy_masked(eh->eth_src, key->eth_src, mask->eth_src);
61             ether_addr_copy_masked(eh->eth_dst, key->eth_dst, mask->eth_dst);
62         }
63     }
64 }
65
66 static void
67 odp_set_ipv4(struct dp_packet *packet, const struct ovs_key_ipv4 *key,
68              const struct ovs_key_ipv4 *mask)
69 {
70     struct ip_header *nh = dp_packet_l3(packet);
71
72     packet_set_ipv4(
73         packet,
74         key->ipv4_src | (get_16aligned_be32(&nh->ip_src) & ~mask->ipv4_src),
75         key->ipv4_dst | (get_16aligned_be32(&nh->ip_dst) & ~mask->ipv4_dst),
76         key->ipv4_tos | (nh->ip_tos & ~mask->ipv4_tos),
77         key->ipv4_ttl | (nh->ip_ttl & ~mask->ipv4_ttl));
78 }
79
80 static const ovs_be32 *
81 mask_ipv6_addr(const ovs_16aligned_be32 *old, const ovs_be32 *addr,
82                const ovs_be32 *mask, ovs_be32 *masked)
83 {
84     for (int i = 0; i < 4; i++) {
85         masked[i] = addr[i] | (get_16aligned_be32(&old[i]) & ~mask[i]);
86     }
87
88     return masked;
89 }
90
91 static void
92 odp_set_ipv6(struct dp_packet *packet, const struct ovs_key_ipv6 *key,
93              const struct ovs_key_ipv6 *mask)
94 {
95     struct ovs_16aligned_ip6_hdr *nh = dp_packet_l3(packet);
96     ovs_be32 sbuf[4], dbuf[4];
97     uint8_t old_tc = ntohl(get_16aligned_be32(&nh->ip6_flow)) >> 20;
98     ovs_be32 old_fl = get_16aligned_be32(&nh->ip6_flow) & htonl(0xfffff);
99
100     packet_set_ipv6(
101         packet,
102         key->ipv6_proto,
103         mask_ipv6_addr(nh->ip6_src.be32, key->ipv6_src, mask->ipv6_src, sbuf),
104         mask_ipv6_addr(nh->ip6_dst.be32, key->ipv6_dst, mask->ipv6_dst, dbuf),
105         key->ipv6_tclass | (old_tc & ~mask->ipv6_tclass),
106         key->ipv6_label | (old_fl & ~mask->ipv6_label),
107         key->ipv6_hlimit | (nh->ip6_hlim & ~mask->ipv6_hlimit));
108 }
109
110 static void
111 odp_set_tcp(struct dp_packet *packet, const struct ovs_key_tcp *key,
112              const struct ovs_key_tcp *mask)
113 {
114     struct tcp_header *th = dp_packet_l4(packet);
115
116     if (OVS_LIKELY(th && dp_packet_get_tcp_payload(packet))) {
117         packet_set_tcp_port(packet,
118                             key->tcp_src | (th->tcp_src & ~mask->tcp_src),
119                             key->tcp_dst | (th->tcp_dst & ~mask->tcp_dst));
120     }
121 }
122
123 static void
124 odp_set_udp(struct dp_packet *packet, const struct ovs_key_udp *key,
125              const struct ovs_key_udp *mask)
126 {
127     struct udp_header *uh = dp_packet_l4(packet);
128
129     if (OVS_LIKELY(uh && dp_packet_get_udp_payload(packet))) {
130         packet_set_udp_port(packet,
131                             key->udp_src | (uh->udp_src & ~mask->udp_src),
132                             key->udp_dst | (uh->udp_dst & ~mask->udp_dst));
133     }
134 }
135
136 static void
137 odp_set_sctp(struct dp_packet *packet, const struct ovs_key_sctp *key,
138              const struct ovs_key_sctp *mask)
139 {
140     struct sctp_header *sh = dp_packet_l4(packet);
141
142     if (OVS_LIKELY(sh && dp_packet_get_sctp_payload(packet))) {
143         packet_set_sctp_port(packet,
144                              key->sctp_src | (sh->sctp_src & ~mask->sctp_src),
145                              key->sctp_dst | (sh->sctp_dst & ~mask->sctp_dst));
146     }
147 }
148
149 static void
150 odp_set_tunnel_action(const struct nlattr *a, struct flow_tnl *tun_key)
151 {
152     enum odp_key_fitness fitness;
153
154     fitness = odp_tun_key_from_attr(a, tun_key);
155     ovs_assert(fitness != ODP_FIT_ERROR);
156 }
157
158 static void
159 set_arp(struct dp_packet *packet, const struct ovs_key_arp *key,
160         const struct ovs_key_arp *mask)
161 {
162     struct arp_eth_header *arp = dp_packet_l3(packet);
163
164     if (!mask) {
165         arp->ar_op = key->arp_op;
166         memcpy(arp->ar_sha, key->arp_sha, ETH_ADDR_LEN);
167         put_16aligned_be32(&arp->ar_spa, key->arp_sip);
168         memcpy(arp->ar_tha, key->arp_tha, ETH_ADDR_LEN);
169         put_16aligned_be32(&arp->ar_tpa, key->arp_tip);
170     } else {
171         ovs_be32 ar_spa = get_16aligned_be32(&arp->ar_spa);
172         ovs_be32 ar_tpa = get_16aligned_be32(&arp->ar_tpa);
173
174         arp->ar_op = key->arp_op | (arp->ar_op & ~mask->arp_op);
175         ether_addr_copy_masked(arp->ar_sha, key->arp_sha, mask->arp_sha);
176         put_16aligned_be32(&arp->ar_spa,
177                            key->arp_sip | (ar_spa & ~mask->arp_sip));
178         ether_addr_copy_masked(arp->ar_tha, key->arp_tha, mask->arp_tha);
179         put_16aligned_be32(&arp->ar_tpa,
180                            key->arp_tip | (ar_tpa & ~mask->arp_tip));
181     }
182 }
183
184 static void
185 odp_set_nd(struct dp_packet *packet, const struct ovs_key_nd *key,
186            const struct ovs_key_nd *mask)
187 {
188     const struct ovs_nd_msg *ns = dp_packet_l4(packet);
189     const struct ovs_nd_opt *nd_opt = dp_packet_get_nd_payload(packet);
190
191     if (OVS_LIKELY(ns && nd_opt)) {
192         int bytes_remain = dp_packet_l4_size(packet) - sizeof(*ns);
193         ovs_be32 tgt_buf[4];
194         uint8_t sll_buf[ETH_ADDR_LEN] = {0};
195         uint8_t tll_buf[ETH_ADDR_LEN] = {0};
196
197         while (bytes_remain >= ND_OPT_LEN && nd_opt->nd_opt_len != 0) {
198             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
199                 && nd_opt->nd_opt_len == 1) {
200                 memcpy(sll_buf, nd_opt->nd_opt_data, ETH_ADDR_LEN);
201                 ether_addr_copy_masked(sll_buf, key->nd_sll, mask->nd_sll);
202
203                 /* A packet can only contain one SLL or TLL option */
204                 break;
205             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
206                        && nd_opt->nd_opt_len == 1) {
207                 memcpy(tll_buf, nd_opt->nd_opt_data, ETH_ADDR_LEN);
208                 ether_addr_copy_masked(tll_buf, key->nd_tll, mask->nd_tll);
209
210                 /* A packet can only contain one SLL or TLL option */
211                 break;
212             }
213
214             nd_opt += nd_opt->nd_opt_len;
215             bytes_remain -= nd_opt->nd_opt_len * ND_OPT_LEN;
216         }
217
218         packet_set_nd(packet,
219                       mask_ipv6_addr(ns->target.be32,
220                                      key->nd_target, mask->nd_target, tgt_buf),
221                       sll_buf,
222                       tll_buf);
223     }
224 }
225
226 static void
227 odp_execute_set_action(struct dp_packet *packet, const struct nlattr *a)
228 {
229     enum ovs_key_attr type = nl_attr_type(a);
230     const struct ovs_key_ipv4 *ipv4_key;
231     const struct ovs_key_ipv6 *ipv6_key;
232     struct pkt_metadata *md = &packet->md;
233
234     switch (type) {
235     case OVS_KEY_ATTR_PRIORITY:
236         md->skb_priority = nl_attr_get_u32(a);
237         break;
238
239     case OVS_KEY_ATTR_TUNNEL:
240         odp_set_tunnel_action(a, &md->tunnel);
241         break;
242
243     case OVS_KEY_ATTR_SKB_MARK:
244         md->pkt_mark = nl_attr_get_u32(a);
245         break;
246
247     case OVS_KEY_ATTR_ETHERNET:
248         odp_eth_set_addrs(packet, nl_attr_get(a), NULL);
249         break;
250
251     case OVS_KEY_ATTR_IPV4:
252         ipv4_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv4));
253         packet_set_ipv4(packet, ipv4_key->ipv4_src,
254                         ipv4_key->ipv4_dst, ipv4_key->ipv4_tos,
255                         ipv4_key->ipv4_ttl);
256         break;
257
258     case OVS_KEY_ATTR_IPV6:
259         ipv6_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv6));
260         packet_set_ipv6(packet, ipv6_key->ipv6_proto,
261                         ipv6_key->ipv6_src, ipv6_key->ipv6_dst,
262                         ipv6_key->ipv6_tclass, ipv6_key->ipv6_label,
263                         ipv6_key->ipv6_hlimit);
264         break;
265
266     case OVS_KEY_ATTR_TCP:
267         if (OVS_LIKELY(dp_packet_get_tcp_payload(packet))) {
268             const struct ovs_key_tcp *tcp_key
269                 = nl_attr_get_unspec(a, sizeof(struct ovs_key_tcp));
270
271             packet_set_tcp_port(packet, tcp_key->tcp_src,
272                                 tcp_key->tcp_dst);
273         }
274         break;
275
276     case OVS_KEY_ATTR_UDP:
277         if (OVS_LIKELY(dp_packet_get_udp_payload(packet))) {
278             const struct ovs_key_udp *udp_key
279                 = nl_attr_get_unspec(a, sizeof(struct ovs_key_udp));
280
281             packet_set_udp_port(packet, udp_key->udp_src,
282                                 udp_key->udp_dst);
283         }
284         break;
285
286     case OVS_KEY_ATTR_SCTP:
287         if (OVS_LIKELY(dp_packet_get_sctp_payload(packet))) {
288             const struct ovs_key_sctp *sctp_key
289                 = nl_attr_get_unspec(a, sizeof(struct ovs_key_sctp));
290
291             packet_set_sctp_port(packet, sctp_key->sctp_src,
292                                  sctp_key->sctp_dst);
293         }
294         break;
295
296     case OVS_KEY_ATTR_MPLS:
297         set_mpls_lse(packet, nl_attr_get_be32(a));
298         break;
299
300     case OVS_KEY_ATTR_ARP:
301         set_arp(packet, nl_attr_get(a), NULL);
302         break;
303
304     case OVS_KEY_ATTR_ND:
305         if (OVS_LIKELY(dp_packet_get_nd_payload(packet))) {
306             const struct ovs_key_nd *nd_key
307                    = nl_attr_get_unspec(a, sizeof(struct ovs_key_nd));
308             packet_set_nd(packet, nd_key->nd_target,
309                           nd_key->nd_sll, nd_key->nd_tll);
310         }
311         break;
312
313     case OVS_KEY_ATTR_DP_HASH:
314         md->dp_hash = nl_attr_get_u32(a);
315         dp_packet_set_dp_hash(packet, md->dp_hash);
316         break;
317
318     case OVS_KEY_ATTR_RECIRC_ID:
319         md->recirc_id = nl_attr_get_u32(a);
320         break;
321
322     case OVS_KEY_ATTR_UNSPEC:
323     case OVS_KEY_ATTR_ENCAP:
324     case OVS_KEY_ATTR_ETHERTYPE:
325     case OVS_KEY_ATTR_IN_PORT:
326     case OVS_KEY_ATTR_VLAN:
327     case OVS_KEY_ATTR_ICMP:
328     case OVS_KEY_ATTR_ICMPV6:
329     case OVS_KEY_ATTR_TCP_FLAGS:
330     case __OVS_KEY_ATTR_MAX:
331     default:
332         OVS_NOT_REACHED();
333     }
334 }
335
336 #define get_mask(a, type) ((const type *)(const void *)(a + 1) + 1)
337
338 static void
339 odp_execute_masked_set_action(struct dp_packet *packet,
340                               const struct nlattr *a)
341 {
342     struct pkt_metadata *md = &packet->md;
343     enum ovs_key_attr type = nl_attr_type(a);
344     struct mpls_hdr *mh;
345
346     switch (type) {
347     case OVS_KEY_ATTR_PRIORITY:
348         md->skb_priority = nl_attr_get_u32(a)
349             | (md->skb_priority & ~*get_mask(a, uint32_t));
350         break;
351
352     case OVS_KEY_ATTR_SKB_MARK:
353         md->pkt_mark = nl_attr_get_u32(a)
354             | (md->pkt_mark & ~*get_mask(a, uint32_t));
355         break;
356
357     case OVS_KEY_ATTR_ETHERNET:
358         odp_eth_set_addrs(packet, nl_attr_get(a),
359                           get_mask(a, struct ovs_key_ethernet));
360         break;
361
362     case OVS_KEY_ATTR_IPV4:
363         odp_set_ipv4(packet, nl_attr_get(a),
364                      get_mask(a, struct ovs_key_ipv4));
365         break;
366
367     case OVS_KEY_ATTR_IPV6:
368         odp_set_ipv6(packet, nl_attr_get(a),
369                      get_mask(a, struct ovs_key_ipv6));
370         break;
371
372     case OVS_KEY_ATTR_TCP:
373         odp_set_tcp(packet, nl_attr_get(a),
374                     get_mask(a, struct ovs_key_tcp));
375         break;
376
377     case OVS_KEY_ATTR_UDP:
378         odp_set_udp(packet, nl_attr_get(a),
379                     get_mask(a, struct ovs_key_udp));
380         break;
381
382     case OVS_KEY_ATTR_SCTP:
383         odp_set_sctp(packet, nl_attr_get(a),
384                      get_mask(a, struct ovs_key_sctp));
385         break;
386
387     case OVS_KEY_ATTR_MPLS:
388         mh = dp_packet_l2_5(packet);
389         if (mh) {
390             put_16aligned_be32(&mh->mpls_lse, nl_attr_get_be32(a)
391                                | (get_16aligned_be32(&mh->mpls_lse)
392                                   & ~*get_mask(a, ovs_be32)));
393         }
394         break;
395
396     case OVS_KEY_ATTR_ARP:
397         set_arp(packet, nl_attr_get(a),
398                 get_mask(a, struct ovs_key_arp));
399         break;
400
401     case OVS_KEY_ATTR_ND:
402         odp_set_nd(packet, nl_attr_get(a),
403                    get_mask(a, struct ovs_key_nd));
404         break;
405
406     case OVS_KEY_ATTR_DP_HASH:
407         md->dp_hash = nl_attr_get_u32(a)
408             | (dp_packet_get_dp_hash(packet) & ~*get_mask(a, uint32_t));
409         dp_packet_set_dp_hash(packet, md->dp_hash);
410         break;
411
412     case OVS_KEY_ATTR_RECIRC_ID:
413         md->recirc_id = nl_attr_get_u32(a)
414             | (md->recirc_id & ~*get_mask(a, uint32_t));
415         break;
416
417     case OVS_KEY_ATTR_TUNNEL:    /* Masked data not supported for tunnel. */
418     case OVS_KEY_ATTR_UNSPEC:
419     case OVS_KEY_ATTR_ENCAP:
420     case OVS_KEY_ATTR_ETHERTYPE:
421     case OVS_KEY_ATTR_IN_PORT:
422     case OVS_KEY_ATTR_VLAN:
423     case OVS_KEY_ATTR_ICMP:
424     case OVS_KEY_ATTR_ICMPV6:
425     case OVS_KEY_ATTR_TCP_FLAGS:
426     case __OVS_KEY_ATTR_MAX:
427     default:
428         OVS_NOT_REACHED();
429     }
430 }
431
432 static void
433 odp_execute_sample(void *dp, struct dp_packet *packet, bool steal,
434                    const struct nlattr *action,
435                    odp_execute_cb dp_execute_action)
436 {
437     const struct nlattr *subactions = NULL;
438     const struct nlattr *a;
439     size_t left;
440
441     NL_NESTED_FOR_EACH_UNSAFE (a, left, action) {
442         int type = nl_attr_type(a);
443
444         switch ((enum ovs_sample_attr) type) {
445         case OVS_SAMPLE_ATTR_PROBABILITY:
446             if (random_uint32() >= nl_attr_get_u32(a)) {
447                 if (steal) {
448                     dp_packet_delete(packet);
449                 }
450                 return;
451             }
452             break;
453
454         case OVS_SAMPLE_ATTR_ACTIONS:
455             subactions = a;
456             break;
457
458         case OVS_SAMPLE_ATTR_UNSPEC:
459         case __OVS_SAMPLE_ATTR_MAX:
460         default:
461             OVS_NOT_REACHED();
462         }
463     }
464
465     odp_execute_actions(dp, &packet, 1, steal, nl_attr_get(subactions),
466                         nl_attr_get_size(subactions), dp_execute_action);
467 }
468
469 void
470 odp_execute_actions(void *dp, struct dp_packet **packets, int cnt, bool steal,
471                     const struct nlattr *actions, size_t actions_len,
472                     odp_execute_cb dp_execute_action)
473 {
474     const struct nlattr *a;
475     unsigned int left;
476     int i;
477
478     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
479         int type = nl_attr_type(a);
480         bool last_action = (left <= NLA_ALIGN(a->nla_len));
481
482         switch ((enum ovs_action_attr) type) {
483             /* These only make sense in the context of a datapath. */
484         case OVS_ACTION_ATTR_OUTPUT:
485         case OVS_ACTION_ATTR_TUNNEL_PUSH:
486         case OVS_ACTION_ATTR_TUNNEL_POP:
487         case OVS_ACTION_ATTR_USERSPACE:
488         case OVS_ACTION_ATTR_RECIRC:
489             if (dp_execute_action) {
490                 /* Allow 'dp_execute_action' to steal the packet data if we do
491                  * not need it any more. */
492                 bool may_steal = steal && last_action;
493
494                 dp_execute_action(dp, packets, cnt, a, may_steal);
495
496                 if (last_action) {
497                     /* We do not need to free the packets. dp_execute_actions()
498                      * has stolen them */
499                     return;
500                 }
501             }
502             break;
503
504         case OVS_ACTION_ATTR_HASH: {
505             const struct ovs_action_hash *hash_act = nl_attr_get(a);
506
507             /* Calculate a hash value directly.  This might not match the
508              * value computed by the datapath, but it is much less expensive,
509              * and the current use case (bonding) does not require a strict
510              * match to work properly. */
511             if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
512                 struct flow flow;
513                 uint32_t hash;
514
515                 for (i = 0; i < cnt; i++) {
516                     flow_extract(packets[i], &flow);
517                     hash = flow_hash_5tuple(&flow, hash_act->hash_basis);
518
519                     /* We also store the hash value with each packet */
520                     dp_packet_set_dp_hash(packets[i], hash ? hash : 1);
521                 }
522             } else {
523                 /* Assert on unknown hash algorithm.  */
524                 OVS_NOT_REACHED();
525             }
526             break;
527         }
528
529         case OVS_ACTION_ATTR_PUSH_VLAN: {
530             const struct ovs_action_push_vlan *vlan = nl_attr_get(a);
531
532             for (i = 0; i < cnt; i++) {
533                 eth_push_vlan(packets[i], htons(ETH_TYPE_VLAN), vlan->vlan_tci);
534             }
535             break;
536         }
537
538         case OVS_ACTION_ATTR_POP_VLAN:
539             for (i = 0; i < cnt; i++) {
540                 eth_pop_vlan(packets[i]);
541             }
542             break;
543
544         case OVS_ACTION_ATTR_PUSH_MPLS: {
545             const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
546
547             for (i = 0; i < cnt; i++) {
548                 push_mpls(packets[i], mpls->mpls_ethertype, mpls->mpls_lse);
549             }
550             break;
551          }
552
553         case OVS_ACTION_ATTR_POP_MPLS:
554             for (i = 0; i < cnt; i++) {
555                 pop_mpls(packets[i], nl_attr_get_be16(a));
556             }
557             break;
558
559         case OVS_ACTION_ATTR_SET:
560             for (i = 0; i < cnt; i++) {
561                 odp_execute_set_action(packets[i], nl_attr_get(a));
562             }
563             break;
564
565         case OVS_ACTION_ATTR_SET_MASKED:
566             for (i = 0; i < cnt; i++) {
567                 odp_execute_masked_set_action(packets[i], nl_attr_get(a));
568             }
569             break;
570
571         case OVS_ACTION_ATTR_SAMPLE:
572             for (i = 0; i < cnt; i++) {
573                 odp_execute_sample(dp, packets[i], steal && last_action, a,
574                                    dp_execute_action);
575             }
576
577             if (last_action) {
578                 /* We do not need to free the packets. odp_execute_sample() has
579                  * stolen them*/
580                 return;
581             }
582             break;
583
584         case OVS_ACTION_ATTR_UNSPEC:
585         case __OVS_ACTION_ATTR_MAX:
586             OVS_NOT_REACHED();
587         }
588     }
589
590     if (steal) {
591         for (i = 0; i < cnt; i++) {
592             dp_packet_delete(packets[i]);
593         }
594     }
595 }