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