netdev-vport: Remove set_stats() implementation.
[sliver-openvswitch.git] / lib / netdev-vport.c
1 /*
2  * Copyright (c) 2010, 2011, 2012 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
19 #include "netdev-vport.h"
20
21 #include <errno.h>
22 #include <fcntl.h>
23 #include <sys/socket.h>
24 #include <linux/openvswitch.h>
25 #include <linux/rtnetlink.h>
26 #include <net/if.h>
27 #include <sys/ioctl.h>
28
29 #include "byte-order.h"
30 #include "daemon.h"
31 #include "dirs.h"
32 #include "dpif-linux.h"
33 #include "hash.h"
34 #include "hmap.h"
35 #include "list.h"
36 #include "netdev-linux.h"
37 #include "netdev-provider.h"
38 #include "netlink.h"
39 #include "netlink-notifier.h"
40 #include "netlink-socket.h"
41 #include "ofpbuf.h"
42 #include "openvswitch/tunnel.h"
43 #include "packets.h"
44 #include "route-table.h"
45 #include "shash.h"
46 #include "socket-util.h"
47 #include "unaligned.h"
48 #include "vlog.h"
49
50 VLOG_DEFINE_THIS_MODULE(netdev_vport);
51
52 /* Default to the OTV port, per the VXLAN IETF draft. */
53 #define VXLAN_DST_PORT 8472
54
55 struct netdev_dev_vport {
56     struct netdev_dev netdev_dev;
57     struct ofpbuf *options;
58     unsigned int change_seq;
59 };
60
61 struct netdev_vport {
62     struct netdev netdev;
63 };
64
65 struct vport_class {
66     enum ovs_vport_type type;
67     struct netdev_class netdev_class;
68     int (*parse_config)(const char *name, const char *type,
69                         const struct smap *args, struct ofpbuf *options);
70     int (*unparse_config)(const char *name, const char *type,
71                           const struct nlattr *options, size_t options_len,
72                           struct smap *args);
73 };
74
75 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
76
77 static int netdev_vport_create(const struct netdev_class *, const char *,
78                                struct netdev_dev **);
79 static void netdev_vport_poll_notify(const struct netdev *);
80 static int tnl_port_config_from_nlattr(const struct nlattr *options,
81                                        size_t options_len,
82                                        struct nlattr *a[OVS_TUNNEL_ATTR_MAX + 1]);
83
84 static const char *netdev_vport_get_tnl_iface(const struct netdev *netdev);
85
86 static bool
87 is_vport_class(const struct netdev_class *class)
88 {
89     return class->create == netdev_vport_create;
90 }
91
92 static const struct vport_class *
93 vport_class_cast(const struct netdev_class *class)
94 {
95     assert(is_vport_class(class));
96     return CONTAINER_OF(class, struct vport_class, netdev_class);
97 }
98
99 static struct netdev_dev_vport *
100 netdev_dev_vport_cast(const struct netdev_dev *netdev_dev)
101 {
102     assert(is_vport_class(netdev_dev_get_class(netdev_dev)));
103     return CONTAINER_OF(netdev_dev, struct netdev_dev_vport, netdev_dev);
104 }
105
106 static struct netdev_vport *
107 netdev_vport_cast(const struct netdev *netdev)
108 {
109     struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
110     assert(is_vport_class(netdev_dev_get_class(netdev_dev)));
111     return CONTAINER_OF(netdev, struct netdev_vport, netdev);
112 }
113
114 /* If 'netdev' is a vport netdev, returns an ofpbuf that contains Netlink
115  * options to include in OVS_VPORT_ATTR_OPTIONS for configuring that vport.
116  * Otherwise returns NULL. */
117 const struct ofpbuf *
118 netdev_vport_get_options(const struct netdev *netdev)
119 {
120     const struct netdev_dev *dev = netdev_get_dev(netdev);
121
122     return (is_vport_class(netdev_dev_get_class(dev))
123             ? netdev_dev_vport_cast(dev)->options
124             : NULL);
125 }
126
127 enum ovs_vport_type
128 netdev_vport_get_vport_type(const struct netdev *netdev)
129 {
130     const struct netdev_dev *dev = netdev_get_dev(netdev);
131     const struct netdev_class *class = netdev_dev_get_class(dev);
132
133     return (is_vport_class(class) ? vport_class_cast(class)->type
134             : class == &netdev_internal_class ? OVS_VPORT_TYPE_INTERNAL
135             : (class == &netdev_linux_class ||
136                class == &netdev_tap_class) ? OVS_VPORT_TYPE_NETDEV
137             : OVS_VPORT_TYPE_UNSPEC);
138 }
139
140 const char *
141 netdev_vport_get_netdev_type(const struct dpif_linux_vport *vport)
142 {
143     struct nlattr *a[OVS_TUNNEL_ATTR_MAX + 1];
144
145     switch (vport->type) {
146     case OVS_VPORT_TYPE_UNSPEC:
147         break;
148
149     case OVS_VPORT_TYPE_NETDEV:
150         return "system";
151
152     case OVS_VPORT_TYPE_INTERNAL:
153         return "internal";
154
155     case OVS_VPORT_TYPE_PATCH:
156         return "patch";
157
158     case OVS_VPORT_TYPE_GRE:
159         if (tnl_port_config_from_nlattr(vport->options, vport->options_len,
160                                         a)) {
161             break;
162         }
163         return (nl_attr_get_u32(a[OVS_TUNNEL_ATTR_FLAGS]) & TNL_F_IPSEC
164                 ? "ipsec_gre" : "gre");
165
166     case OVS_VPORT_TYPE_GRE64:
167         if (tnl_port_config_from_nlattr(vport->options, vport->options_len,
168                                         a)) {
169             break;
170         }
171         return (nl_attr_get_u32(a[OVS_TUNNEL_ATTR_FLAGS]) & TNL_F_IPSEC
172                 ? "ipsec_gre64" : "gre64");
173
174     case OVS_VPORT_TYPE_CAPWAP:
175         return "capwap";
176
177     case OVS_VPORT_TYPE_VXLAN:
178         return "vxlan";
179
180     case OVS_VPORT_TYPE_FT_GRE:
181     case __OVS_VPORT_TYPE_MAX:
182         break;
183     }
184
185     VLOG_WARN_RL(&rl, "dp%d: port `%s' has unsupported type %u",
186                  vport->dp_ifindex, vport->name, (unsigned int) vport->type);
187     return "unknown";
188 }
189
190 static int
191 netdev_vport_create(const struct netdev_class *netdev_class, const char *name,
192                     struct netdev_dev **netdev_devp)
193 {
194     struct netdev_dev_vport *dev;
195
196     dev = xmalloc(sizeof *dev);
197     netdev_dev_init(&dev->netdev_dev, name, netdev_class);
198     dev->options = NULL;
199     dev->change_seq = 1;
200
201     *netdev_devp = &dev->netdev_dev;
202     route_table_register();
203
204     return 0;
205 }
206
207 static void
208 netdev_vport_destroy(struct netdev_dev *netdev_dev_)
209 {
210     struct netdev_dev_vport *netdev_dev = netdev_dev_vport_cast(netdev_dev_);
211
212     ofpbuf_delete(netdev_dev->options);
213     route_table_unregister();
214     free(netdev_dev);
215 }
216
217 static int
218 netdev_vport_open(struct netdev_dev *netdev_dev_, struct netdev **netdevp)
219 {
220     struct netdev_vport *netdev;
221
222     netdev = xmalloc(sizeof *netdev);
223     netdev_init(&netdev->netdev, netdev_dev_);
224
225     *netdevp = &netdev->netdev;
226     return 0;
227 }
228
229 static void
230 netdev_vport_close(struct netdev *netdev_)
231 {
232     struct netdev_vport *netdev = netdev_vport_cast(netdev_);
233     free(netdev);
234 }
235
236 static int
237 netdev_vport_get_config(struct netdev_dev *dev_, struct smap *args)
238 {
239     const struct netdev_class *netdev_class = netdev_dev_get_class(dev_);
240     const struct vport_class *vport_class = vport_class_cast(netdev_class);
241     struct netdev_dev_vport *dev = netdev_dev_vport_cast(dev_);
242     const char *name = netdev_dev_get_name(dev_);
243     int error;
244
245     if (!dev->options) {
246         struct dpif_linux_vport reply;
247         struct ofpbuf *buf;
248
249         error = dpif_linux_vport_get(name, &reply, &buf);
250         if (error) {
251             VLOG_ERR_RL(&rl, "%s: vport query failed (%s)",
252                         name, strerror(error));
253             return error;
254         }
255
256         dev->options = ofpbuf_clone_data(reply.options, reply.options_len);
257         ofpbuf_delete(buf);
258     }
259
260     error = vport_class->unparse_config(name, netdev_class->type,
261                                         dev->options->data,
262                                         dev->options->size,
263                                         args);
264     if (error) {
265         VLOG_ERR_RL(&rl, "%s: failed to parse kernel config (%s)",
266                     name, strerror(error));
267     }
268     return error;
269 }
270
271 static int
272 netdev_vport_set_config(struct netdev_dev *dev_, const struct smap *args)
273 {
274     const struct netdev_class *netdev_class = netdev_dev_get_class(dev_);
275     const struct vport_class *vport_class = vport_class_cast(netdev_class);
276     struct netdev_dev_vport *dev = netdev_dev_vport_cast(dev_);
277     const char *name = netdev_dev_get_name(dev_);
278     struct ofpbuf *options;
279     int error;
280
281     options = ofpbuf_new(64);
282     error = vport_class->parse_config(name, netdev_dev_get_type(dev_),
283                                       args, options);
284     if (!error
285         && (!dev->options
286             || options->size != dev->options->size
287             || memcmp(options->data, dev->options->data, options->size))) {
288         struct dpif_linux_vport vport;
289
290         dpif_linux_vport_init(&vport);
291         vport.cmd = OVS_VPORT_CMD_SET;
292         vport.name = name;
293         vport.options = options->data;
294         vport.options_len = options->size;
295         error = dpif_linux_vport_transact(&vport, NULL, NULL);
296         if (!error || error == ENODEV) {
297             /* Either reconfiguration succeeded or this vport is not installed
298              * in the kernel (e.g. it hasn't been added to a dpif yet with
299              * dpif_port_add()). */
300             ofpbuf_delete(dev->options);
301             dev->options = options;
302             options = NULL;
303             error = 0;
304         }
305     }
306     ofpbuf_delete(options);
307
308     return error;
309 }
310
311 static int
312 netdev_vport_set_etheraddr(struct netdev *netdev,
313                            const uint8_t mac[ETH_ADDR_LEN])
314 {
315     struct dpif_linux_vport vport;
316     int error;
317
318     dpif_linux_vport_init(&vport);
319     vport.cmd = OVS_VPORT_CMD_SET;
320     vport.name = netdev_get_name(netdev);
321     vport.address = mac;
322
323     error = dpif_linux_vport_transact(&vport, NULL, NULL);
324     if (!error) {
325         netdev_vport_poll_notify(netdev);
326     }
327     return error;
328 }
329
330 static int
331 netdev_vport_get_etheraddr(const struct netdev *netdev,
332                            uint8_t mac[ETH_ADDR_LEN])
333 {
334     struct dpif_linux_vport reply;
335     struct ofpbuf *buf;
336     int error;
337
338     error = dpif_linux_vport_get(netdev_get_name(netdev), &reply, &buf);
339     if (!error) {
340         if (reply.address) {
341             memcpy(mac, reply.address, ETH_ADDR_LEN);
342         } else {
343             error = EOPNOTSUPP;
344         }
345         ofpbuf_delete(buf);
346     }
347     return error;
348 }
349
350 /* Copies 'src' into 'dst', performing format conversion in the process.
351  *
352  * 'src' is allowed to be misaligned. */
353 static void
354 netdev_stats_from_ovs_vport_stats(struct netdev_stats *dst,
355                                   const struct ovs_vport_stats *src)
356 {
357     dst->rx_packets = get_unaligned_u64(&src->rx_packets);
358     dst->tx_packets = get_unaligned_u64(&src->tx_packets);
359     dst->rx_bytes = get_unaligned_u64(&src->rx_bytes);
360     dst->tx_bytes = get_unaligned_u64(&src->tx_bytes);
361     dst->rx_errors = get_unaligned_u64(&src->rx_errors);
362     dst->tx_errors = get_unaligned_u64(&src->tx_errors);
363     dst->rx_dropped = get_unaligned_u64(&src->rx_dropped);
364     dst->tx_dropped = get_unaligned_u64(&src->tx_dropped);
365     dst->multicast = 0;
366     dst->collisions = 0;
367     dst->rx_length_errors = 0;
368     dst->rx_over_errors = 0;
369     dst->rx_crc_errors = 0;
370     dst->rx_frame_errors = 0;
371     dst->rx_fifo_errors = 0;
372     dst->rx_missed_errors = 0;
373     dst->tx_aborted_errors = 0;
374     dst->tx_carrier_errors = 0;
375     dst->tx_fifo_errors = 0;
376     dst->tx_heartbeat_errors = 0;
377     dst->tx_window_errors = 0;
378 }
379
380 int
381 netdev_vport_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
382 {
383     struct dpif_linux_vport reply;
384     struct ofpbuf *buf;
385     int error;
386
387     error = dpif_linux_vport_get(netdev_get_name(netdev), &reply, &buf);
388     if (error) {
389         return error;
390     } else if (!reply.stats) {
391         ofpbuf_delete(buf);
392         return EOPNOTSUPP;
393     }
394
395     netdev_stats_from_ovs_vport_stats(stats, reply.stats);
396
397     ofpbuf_delete(buf);
398
399     return 0;
400 }
401
402 static int
403 netdev_vport_get_drv_info(const struct netdev *netdev, struct smap *smap)
404 {
405     const char *iface = netdev_vport_get_tnl_iface(netdev);
406
407     if (iface) {
408         struct netdev *egress_netdev;
409
410         smap_add(smap, "tunnel_egress_iface", iface);
411
412         if (!netdev_open(iface, "system", &egress_netdev)) {
413             smap_add(smap, "tunnel_egress_iface_carrier",
414                      netdev_get_carrier(egress_netdev) ? "up" : "down");
415             netdev_close(egress_netdev);
416         }
417     }
418
419     return 0;
420 }
421
422 static int
423 netdev_vport_update_flags(struct netdev *netdev OVS_UNUSED,
424                         enum netdev_flags off, enum netdev_flags on OVS_UNUSED,
425                         enum netdev_flags *old_flagsp)
426 {
427     if (off & (NETDEV_UP | NETDEV_PROMISC)) {
428         return EOPNOTSUPP;
429     }
430
431     *old_flagsp = NETDEV_UP | NETDEV_PROMISC;
432     return 0;
433 }
434
435 static unsigned int
436 netdev_vport_change_seq(const struct netdev *netdev)
437 {
438     return netdev_dev_vport_cast(netdev_get_dev(netdev))->change_seq;
439 }
440
441 static void
442 netdev_vport_run(void)
443 {
444     route_table_run();
445 }
446
447 static void
448 netdev_vport_wait(void)
449 {
450     route_table_wait();
451 }
452 \f
453 /* get_tnl_iface() implementation. */
454 static const char *
455 netdev_vport_get_tnl_iface(const struct netdev *netdev)
456 {
457     struct nlattr *a[OVS_TUNNEL_ATTR_MAX + 1];
458     ovs_be32 route;
459     struct netdev_dev_vport *ndv;
460     static char name[IFNAMSIZ];
461
462     ndv = netdev_dev_vport_cast(netdev_get_dev(netdev));
463     if (tnl_port_config_from_nlattr(ndv->options->data, ndv->options->size,
464                                     a)) {
465         return NULL;
466     }
467     route = nl_attr_get_be32(a[OVS_TUNNEL_ATTR_DST_IPV4]);
468
469     if (route_table_get_name(route, name)) {
470         return name;
471     }
472
473     return NULL;
474 }
475 \f
476 /* Helper functions. */
477
478 static void
479 netdev_vport_poll_notify(const struct netdev *netdev)
480 {
481     struct netdev_dev_vport *ndv;
482
483     ndv = netdev_dev_vport_cast(netdev_get_dev(netdev));
484
485     ndv->change_seq++;
486     if (!ndv->change_seq) {
487         ndv->change_seq++;
488     }
489 }
490 \f
491 /* Code specific to individual vport types. */
492
493 static void
494 set_key(const struct smap *args, const char *name, uint16_t type,
495         struct ofpbuf *options)
496 {
497     const char *s;
498
499     s = smap_get(args, name);
500     if (!s) {
501         s = smap_get(args, "key");
502         if (!s) {
503             s = "0";
504         }
505     }
506
507     if (!strcmp(s, "flow")) {
508         /* This is the default if no attribute is present. */
509     } else {
510         nl_msg_put_be64(options, type, htonll(strtoull(s, NULL, 0)));
511     }
512 }
513
514 static int
515 parse_tunnel_config(const char *name, const char *type,
516                     const struct smap *args, struct ofpbuf *options)
517 {
518     bool is_gre = false;
519     bool is_ipsec = false;
520     bool needs_dst_port = false;
521     bool found_dst_port = false;
522     struct smap_node *node;
523     bool ipsec_mech_set = false;
524     ovs_be32 daddr = htonl(0);
525     ovs_be32 saddr = htonl(0);
526     uint32_t flags;
527
528     if (!strcmp(type, "capwap")) {
529         VLOG_WARN_ONCE("CAPWAP tunnel support is deprecated.");
530     }
531
532     flags = TNL_F_DF_DEFAULT;
533     if (!strcmp(type, "gre") || !strcmp(type, "gre64")) {
534         is_gre = true;
535     } else if (!strcmp(type, "ipsec_gre") || !strcmp(type, "ipsec_gre64")) {
536         is_gre = true;
537         is_ipsec = true;
538         flags |= TNL_F_IPSEC;
539     } else if (!strcmp(type, "vxlan")) {
540         needs_dst_port = true;
541     }
542
543     SMAP_FOR_EACH (node, args) {
544         if (!strcmp(node->key, "remote_ip")) {
545             struct in_addr in_addr;
546             if (lookup_ip(node->value, &in_addr)) {
547                 VLOG_WARN("%s: bad %s 'remote_ip'", name, type);
548             } else {
549                 daddr = in_addr.s_addr;
550             }
551         } else if (!strcmp(node->key, "local_ip")) {
552             struct in_addr in_addr;
553             if (lookup_ip(node->value, &in_addr)) {
554                 VLOG_WARN("%s: bad %s 'local_ip'", name, type);
555             } else {
556                 saddr = in_addr.s_addr;
557             }
558         } else if (!strcmp(node->key, "tos")) {
559             if (!strcmp(node->value, "inherit")) {
560                 flags |= TNL_F_TOS_INHERIT;
561             } else {
562                 char *endptr;
563                 int tos;
564                 tos = strtol(node->value, &endptr, 0);
565                 if (*endptr == '\0' && tos == (tos & IP_DSCP_MASK)) {
566                     nl_msg_put_u8(options, OVS_TUNNEL_ATTR_TOS, tos);
567                 } else {
568                     VLOG_WARN("%s: invalid TOS %s", name, node->value);
569                 }
570             }
571         } else if (!strcmp(node->key, "ttl")) {
572             if (!strcmp(node->value, "inherit")) {
573                 flags |= TNL_F_TTL_INHERIT;
574             } else {
575                 nl_msg_put_u8(options, OVS_TUNNEL_ATTR_TTL, atoi(node->value));
576             }
577         } else if (!strcmp(node->key, "dst_port") && needs_dst_port) {
578             nl_msg_put_u16(options, OVS_TUNNEL_ATTR_DST_PORT,
579                            atoi(node->value));
580             found_dst_port = true;
581         } else if (!strcmp(node->key, "csum") && is_gre) {
582             if (!strcmp(node->value, "true")) {
583                 flags |= TNL_F_CSUM;
584             }
585         } else if (!strcmp(node->key, "df_inherit")) {
586             if (!strcmp(node->value, "true")) {
587                 flags |= TNL_F_DF_INHERIT;
588             }
589         } else if (!strcmp(node->key, "df_default")) {
590             if (!strcmp(node->value, "false")) {
591                 flags &= ~TNL_F_DF_DEFAULT;
592             }
593         } else if (!strcmp(node->key, "pmtud")) {
594             if (!strcmp(node->value, "true")) {
595                 VLOG_WARN_ONCE("%s: The tunnel Path MTU discovery is "
596                                "deprecated and may be removed in February "
597                                "2013. Please email dev@openvswitch.org with "
598                                "concerns.", name);
599                 flags |= TNL_F_PMTUD;
600             }
601         } else if (!strcmp(node->key, "peer_cert") && is_ipsec) {
602             if (smap_get(args, "certificate")) {
603                 ipsec_mech_set = true;
604             } else {
605                 const char *use_ssl_cert;
606
607                 /* If the "use_ssl_cert" is true, then "certificate" and
608                  * "private_key" will be pulled from the SSL table.  The
609                  * use of this option is strongly discouraged, since it
610                  * will like be removed when multiple SSL configurations
611                  * are supported by OVS.
612                  */
613                 use_ssl_cert = smap_get(args, "use_ssl_cert");
614                 if (!use_ssl_cert || strcmp(use_ssl_cert, "true")) {
615                     VLOG_ERR("%s: 'peer_cert' requires 'certificate' argument",
616                              name);
617                     return EINVAL;
618                 }
619                 ipsec_mech_set = true;
620             }
621         } else if (!strcmp(node->key, "psk") && is_ipsec) {
622             ipsec_mech_set = true;
623         } else if (is_ipsec
624                 && (!strcmp(node->key, "certificate")
625                     || !strcmp(node->key, "private_key")
626                     || !strcmp(node->key, "use_ssl_cert"))) {
627             /* Ignore options not used by the netdev. */
628         } else if (!strcmp(node->key, "key") ||
629                    !strcmp(node->key, "in_key") ||
630                    !strcmp(node->key, "out_key")) {
631             /* Handled separately below. */
632         } else {
633             VLOG_WARN("%s: unknown %s argument '%s'", name, type, node->key);
634         }
635     }
636
637     /* Add a default destination port for VXLAN if none specified. */
638     if (needs_dst_port && !found_dst_port) {
639         nl_msg_put_u16(options, OVS_TUNNEL_ATTR_DST_PORT, VXLAN_DST_PORT);
640     }
641
642     if (is_ipsec) {
643         static pid_t pid = 0;
644         if (pid <= 0) {
645             char *file_name = xasprintf("%s/%s", ovs_rundir(),
646                                         "ovs-monitor-ipsec.pid");
647             pid = read_pidfile(file_name);
648             free(file_name);
649         }
650
651         if (pid < 0) {
652             VLOG_ERR("%s: IPsec requires the ovs-monitor-ipsec daemon",
653                      name);
654             return EINVAL;
655         }
656
657         if (smap_get(args, "peer_cert") && smap_get(args, "psk")) {
658             VLOG_ERR("%s: cannot define both 'peer_cert' and 'psk'", name);
659             return EINVAL;
660         }
661
662         if (!ipsec_mech_set) {
663             VLOG_ERR("%s: IPsec requires an 'peer_cert' or psk' argument",
664                      name);
665             return EINVAL;
666         }
667     }
668
669     set_key(args, "in_key", OVS_TUNNEL_ATTR_IN_KEY, options);
670     set_key(args, "out_key", OVS_TUNNEL_ATTR_OUT_KEY, options);
671
672     if (!daddr) {
673         VLOG_ERR("%s: %s type requires valid 'remote_ip' argument",
674                  name, type);
675         return EINVAL;
676     }
677     nl_msg_put_be32(options, OVS_TUNNEL_ATTR_DST_IPV4, daddr);
678
679     if (saddr) {
680         if (ip_is_multicast(daddr)) {
681             VLOG_WARN("%s: remote_ip is multicast, ignoring local_ip", name);
682         } else {
683             nl_msg_put_be32(options, OVS_TUNNEL_ATTR_SRC_IPV4, saddr);
684         }
685     }
686
687     nl_msg_put_u32(options, OVS_TUNNEL_ATTR_FLAGS, flags);
688
689     return 0;
690 }
691
692 static int
693 tnl_port_config_from_nlattr(const struct nlattr *options, size_t options_len,
694                             struct nlattr *a[OVS_TUNNEL_ATTR_MAX + 1])
695 {
696     static const struct nl_policy ovs_tunnel_policy[] = {
697         [OVS_TUNNEL_ATTR_FLAGS] = { .type = NL_A_U32 },
698         [OVS_TUNNEL_ATTR_DST_IPV4] = { .type = NL_A_BE32 },
699         [OVS_TUNNEL_ATTR_SRC_IPV4] = { .type = NL_A_BE32, .optional = true },
700         [OVS_TUNNEL_ATTR_IN_KEY] = { .type = NL_A_BE64, .optional = true },
701         [OVS_TUNNEL_ATTR_OUT_KEY] = { .type = NL_A_BE64, .optional = true },
702         [OVS_TUNNEL_ATTR_TOS] = { .type = NL_A_U8, .optional = true },
703         [OVS_TUNNEL_ATTR_TTL] = { .type = NL_A_U8, .optional = true },
704         [OVS_TUNNEL_ATTR_DST_PORT] = { .type = NL_A_U16, .optional = true },
705     };
706     struct ofpbuf buf;
707
708     ofpbuf_use_const(&buf, options, options_len);
709     if (!nl_policy_parse(&buf, 0, ovs_tunnel_policy,
710                          a, ARRAY_SIZE(ovs_tunnel_policy))) {
711         return EINVAL;
712     }
713     return 0;
714 }
715
716 static uint64_t
717 get_be64_or_zero(const struct nlattr *a)
718 {
719     return a ? ntohll(nl_attr_get_be64(a)) : 0;
720 }
721
722 static int
723 unparse_tunnel_config(const char *name OVS_UNUSED, const char *type OVS_UNUSED,
724                       const struct nlattr *options, size_t options_len,
725                       struct smap *args)
726 {
727     struct nlattr *a[OVS_TUNNEL_ATTR_MAX + 1];
728     ovs_be32 daddr;
729     uint32_t flags;
730     int error;
731
732     error = tnl_port_config_from_nlattr(options, options_len, a);
733     if (error) {
734         return error;
735     }
736
737
738     daddr = nl_attr_get_be32(a[OVS_TUNNEL_ATTR_DST_IPV4]);
739     smap_add_format(args, "remote_ip", IP_FMT, IP_ARGS(daddr));
740
741     if (a[OVS_TUNNEL_ATTR_SRC_IPV4]) {
742         ovs_be32 saddr = nl_attr_get_be32(a[OVS_TUNNEL_ATTR_SRC_IPV4]);
743         smap_add_format(args, "local_ip", IP_FMT, IP_ARGS(saddr));
744     }
745
746     if (!a[OVS_TUNNEL_ATTR_IN_KEY] && !a[OVS_TUNNEL_ATTR_OUT_KEY]) {
747         smap_add(args, "key", "flow");
748     } else {
749         uint64_t in_key = get_be64_or_zero(a[OVS_TUNNEL_ATTR_IN_KEY]);
750         uint64_t out_key = get_be64_or_zero(a[OVS_TUNNEL_ATTR_OUT_KEY]);
751
752         if (in_key && in_key == out_key) {
753             smap_add_format(args, "key", "%"PRIu64, in_key);
754         } else {
755             if (!a[OVS_TUNNEL_ATTR_IN_KEY]) {
756                 smap_add(args, "in_key", "flow");
757             } else if (in_key) {
758                 smap_add_format(args, "in_key", "%"PRIu64, in_key);
759             }
760
761             if (!a[OVS_TUNNEL_ATTR_OUT_KEY]) {
762                 smap_add(args, "out_key", "flow");
763             } else if (out_key) {
764                 smap_add_format(args, "out_key", "%"PRIu64, out_key);
765             }
766         }
767     }
768
769     flags = nl_attr_get_u32(a[OVS_TUNNEL_ATTR_FLAGS]);
770     if (flags & TNL_F_TTL_INHERIT) {
771         smap_add(args, "ttl", "inherit");
772     } else if (a[OVS_TUNNEL_ATTR_TTL]) {
773         int ttl = nl_attr_get_u8(a[OVS_TUNNEL_ATTR_TTL]);
774         smap_add_format(args, "ttl", "%d", ttl);
775     }
776
777     if (flags & TNL_F_TOS_INHERIT) {
778         smap_add(args, "tos", "inherit");
779     } else if (a[OVS_TUNNEL_ATTR_TOS]) {
780         int tos = nl_attr_get_u8(a[OVS_TUNNEL_ATTR_TOS]);
781         smap_add_format(args, "tos", "0x%x", tos);
782     }
783
784     if (a[OVS_TUNNEL_ATTR_DST_PORT]) {
785         uint16_t dst_port = nl_attr_get_u16(a[OVS_TUNNEL_ATTR_DST_PORT]);
786         if (dst_port != VXLAN_DST_PORT) {
787             smap_add_format(args, "dst_port", "%d", dst_port);
788         }
789     }
790
791     if (flags & TNL_F_CSUM) {
792         smap_add(args, "csum", "true");
793     }
794     if (flags & TNL_F_DF_INHERIT) {
795         smap_add(args, "df_inherit", "true");
796     }
797     if (!(flags & TNL_F_DF_DEFAULT)) {
798         smap_add(args, "df_default", "false");
799     }
800     if (flags & TNL_F_PMTUD) {
801         smap_add(args, "pmtud", "true");
802     }
803
804     return 0;
805 }
806
807 static int
808 parse_patch_config(const char *name, const char *type OVS_UNUSED,
809                    const struct smap *args, struct ofpbuf *options)
810 {
811     const char *peer;
812
813     peer = smap_get(args, "peer");
814     if (!peer) {
815         VLOG_ERR("%s: patch type requires valid 'peer' argument", name);
816         return EINVAL;
817     }
818
819     if (smap_count(args) > 1) {
820         VLOG_ERR("%s: patch type takes only a 'peer' argument", name);
821         return EINVAL;
822     }
823
824     if (strlen(peer) >= IFNAMSIZ) {
825         VLOG_ERR("%s: patch 'peer' arg too long", name);
826         return EINVAL;
827     }
828
829     if (!strcmp(name, peer)) {
830         VLOG_ERR("%s: patch peer must not be self", name);
831         return EINVAL;
832     }
833
834     nl_msg_put_string(options, OVS_PATCH_ATTR_PEER, peer);
835
836     return 0;
837 }
838
839 static int
840 unparse_patch_config(const char *name OVS_UNUSED, const char *type OVS_UNUSED,
841                      const struct nlattr *options, size_t options_len,
842                      struct smap *args)
843 {
844     static const struct nl_policy ovs_patch_policy[] = {
845         [OVS_PATCH_ATTR_PEER] = { .type = NL_A_STRING,
846                                .max_len = IFNAMSIZ,
847                                .optional = false }
848     };
849
850     struct nlattr *a[ARRAY_SIZE(ovs_patch_policy)];
851     struct ofpbuf buf;
852
853     ofpbuf_use_const(&buf, options, options_len);
854     if (!nl_policy_parse(&buf, 0, ovs_patch_policy,
855                          a, ARRAY_SIZE(ovs_patch_policy))) {
856         return EINVAL;
857     }
858
859     smap_add(args, "peer", nl_attr_get_string(a[OVS_PATCH_ATTR_PEER]));
860     return 0;
861 }
862 \f
863 #define VPORT_FUNCTIONS(GET_STATUS)                         \
864     NULL,                                                   \
865     netdev_vport_run,                                       \
866     netdev_vport_wait,                                      \
867                                                             \
868     netdev_vport_create,                                    \
869     netdev_vport_destroy,                                   \
870     netdev_vport_get_config,                                \
871     netdev_vport_set_config,                                \
872                                                             \
873     netdev_vport_open,                                      \
874     netdev_vport_close,                                     \
875                                                             \
876     NULL,                       /* listen */                \
877     NULL,                       /* recv */                  \
878     NULL,                       /* recv_wait */             \
879     NULL,                       /* drain */                 \
880                                                             \
881     NULL,                       /* send */                  \
882     NULL,                       /* send_wait */             \
883                                                             \
884     netdev_vport_set_etheraddr,                             \
885     netdev_vport_get_etheraddr,                             \
886     NULL,                       /* get_mtu */               \
887     NULL,                       /* set_mtu */               \
888     NULL,                       /* get_ifindex */           \
889     NULL,                       /* get_carrier */           \
890     NULL,                       /* get_carrier_resets */    \
891     NULL,                       /* get_miimon */            \
892     netdev_vport_get_stats,                                 \
893     NULL,                       /* set_stats */             \
894                                                             \
895     NULL,                       /* get_features */          \
896     NULL,                       /* set_advertisements */    \
897                                                             \
898     NULL,                       /* set_policing */          \
899     NULL,                       /* get_qos_types */         \
900     NULL,                       /* get_qos_capabilities */  \
901     NULL,                       /* get_qos */               \
902     NULL,                       /* set_qos */               \
903     NULL,                       /* get_queue */             \
904     NULL,                       /* set_queue */             \
905     NULL,                       /* delete_queue */          \
906     NULL,                       /* get_queue_stats */       \
907     NULL,                       /* dump_queues */           \
908     NULL,                       /* dump_queue_stats */      \
909                                                             \
910     NULL,                       /* get_in4 */               \
911     NULL,                       /* set_in4 */               \
912     NULL,                       /* get_in6 */               \
913     NULL,                       /* add_router */            \
914     NULL,                       /* get_next_hop */          \
915     GET_STATUS,                                             \
916     NULL,                       /* arp_lookup */            \
917                                                             \
918     netdev_vport_update_flags,                              \
919                                                             \
920     netdev_vport_change_seq
921
922 void
923 netdev_vport_register(void)
924 {
925     static const struct vport_class vport_classes[] = {
926         { OVS_VPORT_TYPE_GRE,
927           { "gre", VPORT_FUNCTIONS(netdev_vport_get_drv_info) },
928           parse_tunnel_config, unparse_tunnel_config },
929
930         { OVS_VPORT_TYPE_GRE,
931           { "ipsec_gre", VPORT_FUNCTIONS(netdev_vport_get_drv_info) },
932           parse_tunnel_config, unparse_tunnel_config },
933
934         { OVS_VPORT_TYPE_GRE64,
935           { "gre64", VPORT_FUNCTIONS(netdev_vport_get_drv_info) },
936           parse_tunnel_config, unparse_tunnel_config },
937
938         { OVS_VPORT_TYPE_GRE64,
939           { "ipsec_gre64", VPORT_FUNCTIONS(netdev_vport_get_drv_info) },
940           parse_tunnel_config, unparse_tunnel_config },
941
942         { OVS_VPORT_TYPE_CAPWAP,
943           { "capwap", VPORT_FUNCTIONS(netdev_vport_get_drv_info) },
944           parse_tunnel_config, unparse_tunnel_config },
945
946         { OVS_VPORT_TYPE_VXLAN,
947           { "vxlan", VPORT_FUNCTIONS(netdev_vport_get_drv_info) },
948           parse_tunnel_config, unparse_tunnel_config },
949
950         { OVS_VPORT_TYPE_PATCH,
951           { "patch", VPORT_FUNCTIONS(NULL) },
952           parse_patch_config, unparse_patch_config }
953     };
954
955     int i;
956
957     for (i = 0; i < ARRAY_SIZE(vport_classes); i++) {
958         netdev_register_provider(&vport_classes[i].netdev_class);
959     }
960 }