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