lib/netdev-vport.c

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