lib/netdev.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 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 #include "netdev.h"
  19
  20 #include <assert.h>
  21 #include <errno.h>
  22 #include <inttypes.h>
  23 #include <netinet/in.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27
  28 #include "coverage.h"
  29 #include "dynamic-string.h"
  30 #include "fatal-signal.h"
  31 #include "hash.h"
  32 #include "list.h"
  33 #include "netdev-provider.h"
  34 #include "netdev-vport.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "shash.h"
  40 #include "svec.h"
  41 #include "vlog.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(netdev);
  44
  45 COVERAGE_DEFINE(netdev_received);
  46 COVERAGE_DEFINE(netdev_sent);
  47 COVERAGE_DEFINE(netdev_add_router);
  48 COVERAGE_DEFINE(netdev_get_stats);
  49
  50 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
  51
  52 /* All created network devices. */
  53 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
  54
  55 /* All open network devices. */
  56 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
  57
  58 /* This is set pretty low because we probably won't learn anything from the
  59  * additional log messages. */
  60 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
  61
  62 static void close_all_netdevs(void *aux OVS_UNUSED);
  63 static int restore_flags(struct netdev *netdev);
  64 void update_device_args(struct netdev_dev *, const struct shash *args);
  65
  66 static void
  67 netdev_initialize(void)
  68 {
  69     static bool inited;
  70
  71     if (!inited) {
  72         inited = true;
  73
  74         fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
  75
  76 #ifdef HAVE_NETLINK
  77         netdev_register_provider(&netdev_linux_class);
  78         netdev_register_provider(&netdev_tap_class);
  79         netdev_vport_register();
  80 #endif
  81     }
  82 }
  83
  84 /* Performs periodic work needed by all the various kinds of netdevs.
  85  *
  86  * If your program opens any netdevs, it must call this function within its
  87  * main poll loop. */
  88 void
  89 netdev_run(void)
  90 {
  91     struct shash_node *node;
  92     SHASH_FOR_EACH(node, &netdev_classes) {
  93         const struct netdev_class *netdev_class = node->data;
  94         if (netdev_class->run) {
  95             netdev_class->run();
  96         }
  97     }
  98 }
  99
 100 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
 101  *
 102  * If your program opens any netdevs, it must call this function within its
 103  * main poll loop. */
 104 void
 105 netdev_wait(void)
 106 {
 107     struct shash_node *node;
 108     SHASH_FOR_EACH(node, &netdev_classes) {
 109         const struct netdev_class *netdev_class = node->data;
 110         if (netdev_class->wait) {
 111             netdev_class->wait();
 112         }
 113     }
 114 }
 115
 116 /* Initializes and registers a new netdev provider.  After successful
 117  * registration, new netdevs of that type can be opened using netdev_open(). */
 118 int
 119 netdev_register_provider(const struct netdev_class *new_class)
 120 {
 121     if (shash_find(&netdev_classes, new_class->type)) {
 122         VLOG_WARN("attempted to register duplicate netdev provider: %s",
 123                    new_class->type);
 124         return EEXIST;
 125     }
 126
 127     if (new_class->init) {
 128         int error = new_class->init();
 129         if (error) {
 130             VLOG_ERR("failed to initialize %s network device class: %s",
 131                      new_class->type, strerror(error));
 132             return error;
 133         }
 134     }
 135
 136     shash_add(&netdev_classes, new_class->type, new_class);
 137
 138     return 0;
 139 }
 140
 141 /* Unregisters a netdev provider.  'type' must have been previously
 142  * registered and not currently be in use by any netdevs.  After unregistration
 143  * new netdevs of that type cannot be opened using netdev_open(). */
 144 int
 145 netdev_unregister_provider(const char *type)
 146 {
 147     struct shash_node *del_node, *netdev_dev_node;
 148
 149     del_node = shash_find(&netdev_classes, type);
 150     if (!del_node) {
 151         VLOG_WARN("attempted to unregister a netdev provider that is not "
 152                   "registered: %s", type);
 153         return EAFNOSUPPORT;
 154     }
 155
 156     SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
 157         struct netdev_dev *netdev_dev = netdev_dev_node->data;
 158         if (!strcmp(netdev_dev->netdev_class->type, type)) {
 159             VLOG_WARN("attempted to unregister in use netdev provider: %s",
 160                       type);
 161             return EBUSY;
 162         }
 163     }
 164
 165     shash_delete(&netdev_classes, del_node);
 166
 167     return 0;
 168 }
 169
 170 /* Clears 'types' and enumerates the types of all currently registered netdev
 171  * providers into it.  The caller must first initialize the svec. */
 172 void
 173 netdev_enumerate_types(struct svec *types)
 174 {
 175     struct shash_node *node;
 176
 177     netdev_initialize();
 178     svec_clear(types);
 179
 180     SHASH_FOR_EACH(node, &netdev_classes) {
 181         const struct netdev_class *netdev_class = node->data;
 182         svec_add(types, netdev_class->type);
 183     }
 184 }
 185
 186 /* Compares 'args' to those used to those used by 'dev'.  Returns true
 187  * if the arguments are the same, false otherwise.  Does not update the
 188  * values stored in 'dev'. */
 189 static bool
 190 compare_device_args(const struct netdev_dev *dev, const struct shash *args)
 191 {
 192     const struct shash_node **new_args;
 193     bool result = true;
 194     int i;
 195
 196     if (shash_count(args) != dev->n_args) {
 197         return false;
 198     }
 199
 200     new_args = shash_sort(args);
 201     for (i = 0; i < dev->n_args; i++) {
 202         if (strcmp(dev->args[i].key, new_args[i]->name) ||
 203             strcmp(dev->args[i].value, new_args[i]->data)) {
 204             result = false;
 205             goto finish;
 206         }
 207     }
 208
 209 finish:
 210     free(new_args);
 211     return result;
 212 }
 213
 214 static int
 215 compare_args(const void *a_, const void *b_)
 216 {
 217     const struct arg *a = a_;
 218     const struct arg *b = b_;
 219     return strcmp(a->key, b->key);
 220 }
 221
 222 void
 223 update_device_args(struct netdev_dev *dev, const struct shash *args)
 224 {
 225     struct shash_node *node;
 226     int i;
 227
 228     if (dev->n_args) {
 229         for (i = 0; i < dev->n_args; i++) {
 230             free(dev->args[i].key);
 231             free(dev->args[i].value);
 232         }
 233
 234         free(dev->args);
 235         dev->n_args = 0;
 236     }
 237
 238     if (!args || shash_is_empty(args)) {
 239         return;
 240     }
 241
 242     dev->n_args = shash_count(args);
 243     dev->args = xmalloc(dev->n_args * sizeof *dev->args);
 244
 245     i = 0;
 246     SHASH_FOR_EACH(node, args) {
 247         dev->args[i].key = xstrdup(node->name);
 248         dev->args[i].value = xstrdup(node->data);
 249         i++;
 250     }
 251
 252     qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
 253 }
 254
 255 static int
 256 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
 257 {
 258     struct netdev_class *netdev_class;
 259     int error;
 260
 261     if (!options->type || strlen(options->type) == 0) {
 262         /* Default to system. */
 263         options->type = "system";
 264     }
 265
 266     netdev_class = shash_find_data(&netdev_classes, options->type);
 267     if (!netdev_class) {
 268         return EAFNOSUPPORT;
 269     }
 270
 271     error = netdev_class->create(netdev_class, options->name, options->args,
 272                                  netdev_devp);
 273     assert(error || (*netdev_devp)->netdev_class == netdev_class);
 274     return error;
 275 }
 276
 277 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
 278  * successful, otherwise a positive errno value.  On success, sets '*netdevp'
 279  * to the new network device, otherwise to null.
 280  *
 281  * If this is the first time the device has been opened, then create is called
 282  * before opening.  The device is created using the given type and arguments.
 283  *
 284  * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
 285  * capture frames of that type received on the device.  It may also be one of
 286  * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
 287  * categories. */
 288 int
 289 netdev_open(struct netdev_options *options, struct netdev **netdevp)
 290 {
 291     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
 292     struct netdev_dev *netdev_dev;
 293     int error;
 294
 295     *netdevp = NULL;
 296     netdev_initialize();
 297
 298     if (!options->args) {
 299         options->args = &empty_args;
 300     }
 301
 302     netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
 303
 304     if (!netdev_dev) {
 305         error = create_device(options, &netdev_dev);
 306         if (error) {
 307             if (error == EAFNOSUPPORT) {
 308                 VLOG_WARN("could not create netdev %s of unknown type %s",
 309                           options->name, options->type);
 310             }
 311             return error;
 312         }
 313         update_device_args(netdev_dev, options->args);
 314
 315     } else if (!shash_is_empty(options->args) &&
 316                !compare_device_args(netdev_dev, options->args)) {
 317
 318         VLOG_WARN("%s: attempted to open already open netdev with "
 319                   "different arguments", options->name);
 320         return EINVAL;
 321     }
 322
 323     error = netdev_dev->netdev_class->open(netdev_dev, options->ethertype,
 324                 netdevp);
 325
 326     if (!error) {
 327         netdev_dev->ref_cnt++;
 328     } else {
 329         if (!netdev_dev->ref_cnt) {
 330             netdev_dev_uninit(netdev_dev, true);
 331         }
 332     }
 333
 334     return error;
 335 }
 336
 337 int
 338 netdev_open_default(const char *name, struct netdev **netdevp)
 339 {
 340     struct netdev_options options;
 341
 342     memset(&options, 0, sizeof options);
 343     options.name = name;
 344     options.ethertype = NETDEV_ETH_TYPE_NONE;
 345
 346     return netdev_open(&options, netdevp);
 347 }
 348
 349 /* Reconfigures the device 'netdev' with 'args'.  'args' may be empty
 350  * or NULL if none are needed. */
 351 int
 352 netdev_reconfigure(struct netdev *netdev, const struct shash *args)
 353 {
 354     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
 355     struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
 356
 357     if (!args) {
 358         args = &empty_args;
 359     }
 360
 361     if (netdev_dev->netdev_class->reconfigure) {
 362         if (!compare_device_args(netdev_dev, args)) {
 363             update_device_args(netdev_dev, args);
 364             return netdev_dev->netdev_class->reconfigure(netdev_dev, args);
 365         }
 366     } else if (!shash_is_empty(args)) {
 367         VLOG_WARN("%s: arguments provided to device that does not have a "
 368                   "reconfigure function", netdev_get_name(netdev));
 369     }
 370
 371     return 0;
 372 }
 373
 374 /* Closes and destroys 'netdev'. */
 375 void
 376 netdev_close(struct netdev *netdev)
 377 {
 378     if (netdev) {
 379         struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
 380
 381         assert(netdev_dev->ref_cnt);
 382         netdev_dev->ref_cnt--;
 383         netdev_uninit(netdev, true);
 384
 385         /* If the reference count for the netdev device is zero, destroy it. */
 386         if (!netdev_dev->ref_cnt) {
 387             netdev_dev_uninit(netdev_dev, true);
 388         }
 389     }
 390 }
 391
 392 /* Returns true if a network device named 'name' exists and may be opened,
 393  * otherwise false. */
 394 bool
 395 netdev_exists(const char *name)
 396 {
 397     struct netdev *netdev;
 398     int error;
 399
 400     error = netdev_open_default(name, &netdev);
 401     if (!error) {
 402         netdev_close(netdev);
 403         return true;
 404     } else {
 405         if (error != ENODEV) {
 406             VLOG_WARN("failed to open network device %s: %s",
 407                       name, strerror(error));
 408         }
 409         return false;
 410     }
 411 }
 412
 413 /* Returns true if a network device named 'name' is currently opened,
 414  * otherwise false. */
 415 bool
 416 netdev_is_open(const char *name)
 417 {
 418     return !!shash_find_data(&netdev_dev_shash, name);
 419 }
 420
 421 /*  Clears 'svec' and enumerates the names of all known network devices. */
 422 int
 423 netdev_enumerate(struct svec *svec)
 424 {
 425     struct shash_node *node;
 426     int error = 0;
 427
 428     netdev_initialize();
 429     svec_clear(svec);
 430
 431     SHASH_FOR_EACH(node, &netdev_classes) {
 432         const struct netdev_class *netdev_class = node->data;
 433         if (netdev_class->enumerate) {
 434             int retval = netdev_class->enumerate(svec);
 435             if (retval) {
 436                 VLOG_WARN("failed to enumerate %s network devices: %s",
 437                           netdev_class->type, strerror(retval));
 438                 if (!error) {
 439                     error = retval;
 440                 }
 441             }
 442         }
 443     }
 444
 445     return error;
 446 }
 447
 448 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
 449  * must have initialized with sufficient room for the packet.  The space
 450  * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
 451  * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
 452  * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
 453  * need not be included.)
 454  *
 455  * If a packet is successfully retrieved, returns 0.  In this case 'buffer' is
 456  * guaranteed to contain at least ETH_TOTAL_MIN bytes.  Otherwise, returns a
 457  * positive errno value.  Returns EAGAIN immediately if no packet is ready to
 458  * be returned.
 459  *
 460  * Some network devices may not implement support for this function.  In such
 461  * cases this function will always return EOPNOTSUPP. */
 462 int
 463 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
 464 {
 465     int (*recv)(struct netdev *, void *, size_t);
 466     int retval;
 467
 468     assert(buffer->size == 0);
 469     assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
 470
 471     recv = netdev_get_dev(netdev)->netdev_class->recv;
 472     retval = (recv
 473               ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
 474               : -EOPNOTSUPP);
 475     if (retval >= 0) {
 476         COVERAGE_INC(netdev_received);
 477         buffer->size += retval;
 478         if (buffer->size < ETH_TOTAL_MIN) {
 479             ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
 480         }
 481         return 0;
 482     } else {
 483         return -retval;
 484     }
 485 }
 486
 487 /* Registers with the poll loop to wake up from the next call to poll_block()
 488  * when a packet is ready to be received with netdev_recv() on 'netdev'. */
 489 void
 490 netdev_recv_wait(struct netdev *netdev)
 491 {
 492     void (*recv_wait)(struct netdev *);
 493
 494     recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
 495     if (recv_wait) {
 496         recv_wait(netdev);
 497     }
 498 }
 499
 500 /* Discards all packets waiting to be received from 'netdev'. */
 501 int
 502 netdev_drain(struct netdev *netdev)
 503 {
 504     int (*drain)(struct netdev *);
 505
 506     drain = netdev_get_dev(netdev)->netdev_class->drain;
 507     return drain ? drain(netdev) : 0;
 508 }
 509
 510 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
 511  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
 512  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
 513  * the packet is too big or too small to transmit on the device.
 514  *
 515  * The caller retains ownership of 'buffer' in all cases.
 516  *
 517  * The kernel maintains a packet transmission queue, so the caller is not
 518  * expected to do additional queuing of packets.
 519  *
 520  * Some network devices may not implement support for this function.  In such
 521  * cases this function will always return EOPNOTSUPP. */
 522 int
 523 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
 524 {
 525     int (*send)(struct netdev *, const void *, size_t);
 526     int error;
 527
 528     send = netdev_get_dev(netdev)->netdev_class->send;
 529     error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
 530     if (!error) {
 531         COVERAGE_INC(netdev_sent);
 532     }
 533     return error;
 534 }
 535
 536 /* Registers with the poll loop to wake up from the next call to poll_block()
 537  * when the packet transmission queue has sufficient room to transmit a packet
 538  * with netdev_send().
 539  *
 540  * The kernel maintains a packet transmission queue, so the client is not
 541  * expected to do additional queuing of packets.  Thus, this function is
 542  * unlikely to ever be used.  It is included for completeness. */
 543 void
 544 netdev_send_wait(struct netdev *netdev)
 545 {
 546     void (*send_wait)(struct netdev *);
 547
 548     send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
 549     if (send_wait) {
 550         send_wait(netdev);
 551     }
 552 }
 553
 554 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
 555  * otherwise a positive errno value. */
 556 int
 557 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
 558 {
 559     return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
 560 }
 561
 562 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
 563  * the MAC address into 'mac'.  On failure, returns a positive errno value and
 564  * clears 'mac' to all-zeros. */
 565 int
 566 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
 567 {
 568     return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
 569 }
 570
 571 /* Returns the name of the network device that 'netdev' represents,
 572  * e.g. "eth0".  The caller must not modify or free the returned string. */
 573 const char *
 574 netdev_get_name(const struct netdev *netdev)
 575 {
 576     return netdev_get_dev(netdev)->name;
 577 }
 578
 579 /* Retrieves the MTU of 'netdev'.  The MTU is the maximum size of transmitted
 580  * (and received) packets, in bytes, not including the hardware header; thus,
 581  * this is typically 1500 bytes for Ethernet devices.
 582  *
 583  * If successful, returns 0 and stores the MTU size in '*mtup'.  On failure,
 584  * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
 585  * '*mtup'. */
 586 int
 587 netdev_get_mtu(const struct netdev *netdev, int *mtup)
 588 {
 589     int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
 590     if (error) {
 591         VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
 592                      netdev_get_name(netdev), strerror(error));
 593         *mtup = ETH_PAYLOAD_MAX;
 594     }
 595     return error;
 596 }
 597
 598 /* Returns the ifindex of 'netdev', if successful, as a positive number.  On
 599  * failure, returns a negative errno value.
 600  *
 601  * The desired semantics of the ifindex value are a combination of those
 602  * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An ifindex
 603  * value should be unique within a host and remain stable at least until
 604  * reboot.  SNMP says an ifindex "ranges between 1 and the value of ifNumber"
 605  * but many systems do not follow this rule anyhow.
 606  *
 607  * Some network devices may not implement support for this function.  In such
 608  * cases this function will always return -EOPNOTSUPP.
 609  */
 610 int
 611 netdev_get_ifindex(const struct netdev *netdev)
 612 {
 613     int (*get_ifindex)(const struct netdev *);
 614
 615     get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
 616
 617     return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
 618 }
 619
 620 /* Stores the features supported by 'netdev' into each of '*current',
 621  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
 622  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
 623  * successful, otherwise a positive errno value.  On failure, all of the
 624  * passed-in values are set to 0.
 625  *
 626  * Some network devices may not implement support for this function.  In such
 627  * cases this function will always return EOPNOTSUPP. */
 628 int
 629 netdev_get_features(struct netdev *netdev,
 630                     uint32_t *current, uint32_t *advertised,
 631                     uint32_t *supported, uint32_t *peer)
 632 {
 633     int (*get_features)(struct netdev *netdev,
 634                         uint32_t *current, uint32_t *advertised,
 635                         uint32_t *supported, uint32_t *peer);
 636     uint32_t dummy[4];
 637     int error;
 638
 639     if (!current) {
 640         current = &dummy[0];
 641     }
 642     if (!advertised) {
 643         advertised = &dummy[1];
 644     }
 645     if (!supported) {
 646         supported = &dummy[2];
 647     }
 648     if (!peer) {
 649         peer = &dummy[3];
 650     }
 651
 652     get_features = netdev_get_dev(netdev)->netdev_class->get_features;
 653     error = get_features
 654                     ? get_features(netdev, current, advertised, supported, peer)
 655                     : EOPNOTSUPP;
 656     if (error) {
 657         *current = *advertised = *supported = *peer = 0;
 658     }
 659     return error;
 660 }
 661
 662 /* Returns the maximum speed of a network connection that has the "enum
 663  * ofp_port_features" bits in 'features', in bits per second.  If no bits that
 664  * indicate a speed are set in 'features', assumes 100Mbps. */
 665 uint64_t
 666 netdev_features_to_bps(uint32_t features)
 667 {
 668     enum {
 669         F_10000MB = OFPPF_10GB_FD,
 670         F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
 671         F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
 672         F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
 673     };
 674
 675     return (  features & F_10000MB  ? UINT64_C(10000000000)
 676             : features & F_1000MB   ? UINT64_C(1000000000)
 677             : features & F_100MB    ? UINT64_C(100000000)
 678             : features & F_10MB     ? UINT64_C(10000000)
 679                                     : UINT64_C(100000000));
 680 }
 681
 682 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
 683  * full-duplex link are set in 'features', otherwise false. */
 684 bool
 685 netdev_features_is_full_duplex(uint32_t features)
 686 {
 687     return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
 688                         | OFPPF_10GB_FD)) != 0;
 689 }
 690
 691 /* Set the features advertised by 'netdev' to 'advertise'.  Returns 0 if
 692  * successful, otherwise a positive errno value. */
 693 int
 694 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
 695 {
 696     return (netdev_get_dev(netdev)->netdev_class->set_advertisements
 697             ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
 698                     netdev, advertise)
 699             : EOPNOTSUPP);
 700 }
 701
 702 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
 703  * and '*netmask' to its netmask and returns 0.  Otherwise, returns a positive
 704  * errno value and sets '*address' to 0 (INADDR_ANY).
 705  *
 706  * The following error values have well-defined meanings:
 707  *
 708  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 709  *
 710  *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 711  *
 712  * 'address' or 'netmask' or both may be null, in which case the address or
 713  * netmask is not reported. */
 714 int
 715 netdev_get_in4(const struct netdev *netdev,
 716                struct in_addr *address_, struct in_addr *netmask_)
 717 {
 718     struct in_addr address;
 719     struct in_addr netmask;
 720     int error;
 721
 722     error = (netdev_get_dev(netdev)->netdev_class->get_in4
 723              ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
 724                     &address, &netmask)
 725              : EOPNOTSUPP);
 726     if (address_) {
 727         address_->s_addr = error ? 0 : address.s_addr;
 728     }
 729     if (netmask_) {
 730         netmask_->s_addr = error ? 0 : netmask.s_addr;
 731     }
 732     return error;
 733 }
 734
 735 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 736  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
 737  * positive errno value. */
 738 int
 739 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
 740 {
 741     return (netdev_get_dev(netdev)->netdev_class->set_in4
 742             ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
 743             : EOPNOTSUPP);
 744 }
 745
 746 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
 747  * to 'netdev'. */
 748 int
 749 netdev_add_router(struct netdev *netdev, struct in_addr router)
 750 {
 751     COVERAGE_INC(netdev_add_router);
 752     return (netdev_get_dev(netdev)->netdev_class->add_router
 753             ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
 754             : EOPNOTSUPP);
 755 }
 756
 757 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
 758  * 'netdev'.  If a route cannot not be determined, sets '*next_hop' to 0,
 759  * '*netdev_name' to null, and returns a positive errno value.  Otherwise, if a
 760  * next hop is found, stores the next hop gateway's address (0 if 'host' is on
 761  * a directly connected network) in '*next_hop' and a copy of the name of the
 762  * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
 763  * responsible for freeing '*netdev_name' (by calling free()). */
 764 int
 765 netdev_get_next_hop(const struct netdev *netdev,
 766                     const struct in_addr *host, struct in_addr *next_hop,
 767                     char **netdev_name)
 768 {
 769     int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
 770                  ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
 771                         host, next_hop, netdev_name)
 772                  : EOPNOTSUPP);
 773     if (error) {
 774         next_hop->s_addr = 0;
 775         *netdev_name = NULL;
 776     }
 777     return error;
 778 }
 779
 780 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
 781  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
 782  * all-zero-bits (in6addr_any).
 783  *
 784  * The following error values have well-defined meanings:
 785  *
 786  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 787  *
 788  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 789  *
 790  * 'in6' may be null, in which case the address itself is not reported. */
 791 int
 792 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 793 {
 794     struct in6_addr dummy;
 795     int error;
 796
 797     error = (netdev_get_dev(netdev)->netdev_class->get_in6
 798              ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
 799                     in6 ? in6 : &dummy)
 800              : EOPNOTSUPP);
 801     if (error && in6) {
 802         memset(in6, 0, sizeof *in6);
 803     }
 804     return error;
 805 }
 806
 807 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 808  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
 809  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
 810  * successful, otherwise a positive errno value. */
 811 static int
 812 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 813                 enum netdev_flags on, enum netdev_flags *old_flagsp,
 814                 bool permanent)
 815 {
 816     enum netdev_flags old_flags;
 817     int error;
 818
 819     error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
 820                 off & ~on, on, &old_flags);
 821     if (error) {
 822         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
 823                      off || on ? "set" : "get", netdev_get_name(netdev),
 824                      strerror(error));
 825         old_flags = 0;
 826     } else if ((off || on) && !permanent) {
 827         enum netdev_flags new_flags = (old_flags & ~off) | on;
 828         enum netdev_flags changed_flags = old_flags ^ new_flags;
 829         if (changed_flags) {
 830             if (!netdev->changed_flags) {
 831                 netdev->save_flags = old_flags;
 832             }
 833             netdev->changed_flags |= changed_flags;
 834         }
 835     }
 836     if (old_flagsp) {
 837         *old_flagsp = old_flags;
 838     }
 839     return error;
 840 }
 841
 842 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 843  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 844  * stores 0 into '*flagsp'. */
 845 int
 846 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
 847 {
 848     struct netdev *netdev = (struct netdev *) netdev_;
 849     return do_update_flags(netdev, 0, 0, flagsp, false);
 850 }
 851
 852 /* Sets the flags for 'netdev' to 'flags'.
 853  * If 'permanent' is true, the changes will persist; otherwise, they
 854  * will be reverted when 'netdev' is closed or the program exits.
 855  * Returns 0 if successful, otherwise a positive errno value. */
 856 int
 857 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
 858                  bool permanent)
 859 {
 860     return do_update_flags(netdev, -1, flags, NULL, permanent);
 861 }
 862
 863 /* Turns on the specified 'flags' on 'netdev'.
 864  * If 'permanent' is true, the changes will persist; otherwise, they
 865  * will be reverted when 'netdev' is closed or the program exits.
 866  * Returns 0 if successful, otherwise a positive errno value. */
 867 int
 868 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
 869                      bool permanent)
 870 {
 871     return do_update_flags(netdev, 0, flags, NULL, permanent);
 872 }
 873
 874 /* Turns off the specified 'flags' on 'netdev'.
 875  * If 'permanent' is true, the changes will persist; otherwise, they
 876  * will be reverted when 'netdev' is closed or the program exits.
 877  * Returns 0 if successful, otherwise a positive errno value. */
 878 int
 879 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
 880                       bool permanent)
 881 {
 882     return do_update_flags(netdev, flags, 0, NULL, permanent);
 883 }
 884
 885 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
 886  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
 887  * returns 0.  Otherwise, it returns a positive errno value; in particular,
 888  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
 889 int
 890 netdev_arp_lookup(const struct netdev *netdev,
 891                   uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
 892 {
 893     int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
 894                  ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
 895                         ip, mac)
 896                  : EOPNOTSUPP);
 897     if (error) {
 898         memset(mac, 0, ETH_ADDR_LEN);
 899     }
 900     return error;
 901 }
 902
 903 /* Returns true if carrier is active (link light is on) on 'netdev'. */
 904 bool
 905 netdev_get_carrier(const struct netdev *netdev)
 906 {
 907     int error;
 908     enum netdev_flags flags;
 909     bool carrier;
 910
 911     netdev_get_flags(netdev, &flags);
 912     if (!(flags & NETDEV_UP)) {
 913         return false;
 914     }
 915
 916     if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
 917         return true;
 918     }
 919
 920     error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
 921                                                               &carrier);
 922     if (error) {
 923         VLOG_DBG("%s: failed to get network device carrier status, assuming "
 924                  "down: %s", netdev_get_name(netdev), strerror(error));
 925         carrier = false;
 926     }
 927
 928     return carrier;
 929 }
 930
 931 /* Retrieves current device stats for 'netdev'. */
 932 int
 933 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 934 {
 935     int error;
 936
 937     COVERAGE_INC(netdev_get_stats);
 938     error = (netdev_get_dev(netdev)->netdev_class->get_stats
 939              ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
 940              : EOPNOTSUPP);
 941     if (error) {
 942         memset(stats, 0xff, sizeof *stats);
 943     }
 944     return error;
 945 }
 946
 947 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
 948  * Returns 0 if successful, otherwise a positive errno value.
 949  *
 950  * This will probably fail for most network devices.  Some devices might only
 951  * allow setting their stats to 0. */
 952 int
 953 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
 954 {
 955     return (netdev_get_dev(netdev)->netdev_class->set_stats
 956              ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
 957              : EOPNOTSUPP);
 958 }
 959
 960 /* Attempts to set input rate limiting (policing) policy, such that up to
 961  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
 962  * size of 'kbits' kb. */
 963 int
 964 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
 965                     uint32_t kbits_burst)
 966 {
 967     return (netdev_get_dev(netdev)->netdev_class->set_policing
 968             ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
 969                     kbits_rate, kbits_burst)
 970             : EOPNOTSUPP);
 971 }
 972
 973 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
 974  * empty if 'netdev' does not support QoS.  Any names added to 'types' should
 975  * be documented as valid for the "type" column in the "QoS" table in
 976  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 977  *
 978  * Every network device supports disabling QoS with a type of "", but this type
 979  * will not be added to 'types'.
 980  *
 981  * The caller must initialize 'types' (e.g. with svec_init()) before calling
 982  * this function.  The caller is responsible for destroying 'types' (e.g. with
 983  * svec_destroy()) when it is no longer needed.
 984  *
 985  * Returns 0 if successful, otherwise a positive errno value. */
 986 int
 987 netdev_get_qos_types(const struct netdev *netdev, struct svec *types)
 988 {
 989     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
 990     return (class->get_qos_types
 991             ? class->get_qos_types(netdev, types)
 992             : 0);
 993 }
 994
 995 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
 996  * which should be "" or one of the types returned by netdev_get_qos_types()
 997  * for 'netdev'.  Returns 0 if successful, otherwise a positive errno value.
 998  * On success, initializes 'caps' with the QoS capabilities; on failure, clears
 999  * 'caps' to all zeros. */
1000 int
1001 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1002                             struct netdev_qos_capabilities *caps)
1003 {
1004     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1005
1006     if (*type) {
1007         int retval = (class->get_qos_capabilities
1008                       ? class->get_qos_capabilities(netdev, type, caps)
1009                       : EOPNOTSUPP);
1010         if (retval) {
1011             memset(caps, 0, sizeof *caps);
1012         }
1013         return retval;
1014     } else {
1015         /* Every netdev supports turning off QoS. */
1016         memset(caps, 0, sizeof *caps);
1017         return 0;
1018     }
1019 }
1020
1021 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1022  * of QoS.  Returns 0 if successful, otherwise a positive errno value.  Stores
1023  * the number of queues (zero on failure) in '*n_queuesp'.
1024  *
1025  * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1026 int
1027 netdev_get_n_queues(const struct netdev *netdev,
1028                     const char *type, unsigned int *n_queuesp)
1029 {
1030     struct netdev_qos_capabilities caps;
1031     int retval;
1032
1033     retval = netdev_get_qos_capabilities(netdev, type, &caps);
1034     *n_queuesp = caps.n_queues;
1035     return retval;
1036 }
1037
1038 /* Queries 'netdev' about its currently configured form of QoS.  If successful,
1039  * stores the name of the current form of QoS into '*typep', stores any details
1040  * of configuration as string key-value pairs in 'details', and returns 0.  On
1041  * failure, sets '*typep' to NULL and returns a positive errno value.
1042  *
1043  * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1044  *
1045  * The caller must initialize 'details' as an empty shash (e.g. with
1046  * shash_init()) before calling this function.  The caller must free 'details',
1047  * including 'data' members, when it is no longer needed (e.g. with
1048  * shash_destroy_free_data()).
1049  *
1050  * The caller must not modify or free '*typep'.
1051  *
1052  * '*typep' will be one of the types returned by netdev_get_qos_types() for
1053  * 'netdev'.  The contents of 'details' should be documented as valid for
1054  * '*typep' in the "other_config" column in the "QoS" table in
1055  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1056 int
1057 netdev_get_qos(const struct netdev *netdev,
1058                const char **typep, struct shash *details)
1059 {
1060     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1061     int retval;
1062
1063     if (class->get_qos) {
1064         retval = class->get_qos(netdev, typep, details);
1065         if (retval) {
1066             *typep = NULL;
1067             shash_clear_free_data(details);
1068         }
1069         return retval;
1070     } else {
1071         /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1072         *typep = "";
1073         return 0;
1074     }
1075 }
1076
1077 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1078  * with details of configuration from 'details'.  Returns 0 if successful,
1079  * otherwise a positive errno value.  On error, the previous QoS configuration
1080  * is retained.
1081  *
1082  * When this function changes the type of QoS (not just 'details'), this also
1083  * resets all queue configuration for 'netdev' to their defaults (which depend
1084  * on the specific type of QoS).  Otherwise, the queue configuration for
1085  * 'netdev' is unchanged.
1086  *
1087  * 'type' should be "" (to disable QoS) or one of the types returned by
1088  * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should be
1089  * documented as valid for the given 'type' in the "other_config" column in the
1090  * "QoS" table in vswitchd/vswitch.xml (which is built as
1091  * ovs-vswitchd.conf.db(8)).
1092  *
1093  * NULL may be specified for 'details' if there are no configuration
1094  * details. */
1095 int
1096 netdev_set_qos(struct netdev *netdev,
1097                const char *type, const struct shash *details)
1098 {
1099     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1100
1101     if (!type) {
1102         type = "";
1103     }
1104
1105     if (class->set_qos) {
1106         if (!details) {
1107             static struct shash empty = SHASH_INITIALIZER(&empty);
1108             details = &empty;
1109         }
1110         return class->set_qos(netdev, type, details);
1111     } else {
1112         return *type ? EOPNOTSUPP : 0;
1113     }
1114 }
1115
1116 /* Queries 'netdev' for information about the queue numbered 'queue_id'.  If
1117  * successful, adds that information as string key-value pairs to 'details'.
1118  * Returns 0 if successful, otherwise a positive errno value.
1119  *
1120  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1121  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1122  *
1123  * The returned contents of 'details' should be documented as valid for the
1124  * given 'type' in the "other_config" column in the "Queue" table in
1125  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1126  *
1127  * The caller must initialize 'details' (e.g. with shash_init()) before calling
1128  * this function.  The caller must free 'details', including 'data' members,
1129  * when it is no longer needed (e.g. with shash_destroy_free_data()). */
1130 int
1131 netdev_get_queue(const struct netdev *netdev,
1132                  unsigned int queue_id, struct shash *details)
1133 {
1134     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1135     int retval;
1136
1137     retval = (class->get_queue
1138               ? class->get_queue(netdev, queue_id, details)
1139               : EOPNOTSUPP);
1140     if (retval) {
1141         shash_clear_free_data(details);
1142     }
1143     return retval;
1144 }
1145
1146 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1147  * string pairs in 'details'.  The contents of 'details' should be documented
1148  * as valid for the given 'type' in the "other_config" column in the "Queue"
1149  * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1150  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1151  * given queue's configuration should be unmodified.
1152  *
1153  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1154  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1155  *
1156  * This function does not modify 'details', and the caller retains ownership of
1157  * it. */
1158 int
1159 netdev_set_queue(struct netdev *netdev,
1160                  unsigned int queue_id, const struct shash *details)
1161 {
1162     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1163     return (class->set_queue
1164             ? class->set_queue(netdev, queue_id, details)
1165             : EOPNOTSUPP);
1166 }
1167
1168 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.  Some kinds
1169  * of QoS may have a fixed set of queues, in which case attempts to delete them
1170  * will fail with EOPNOTSUPP.
1171  *
1172  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1173  * given queue will be unmodified.
1174  *
1175  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1176  * the current form of QoS (e.g. as returned by
1177  * netdev_get_n_queues(netdev)). */
1178 int
1179 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1180 {
1181     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1182     return (class->delete_queue
1183             ? class->delete_queue(netdev, queue_id)
1184             : EOPNOTSUPP);
1185 }
1186
1187 /* Obtains statistics about 'queue_id' on 'netdev'.  On success, returns 0 and
1188  * fills 'stats' with the queue's statistics; individual members of 'stats' may
1189  * be set to all-1-bits if the statistic is unavailable.  On failure, returns a
1190  * positive errno value and fills 'stats' with all-1-bits. */
1191 int
1192 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1193                        struct netdev_queue_stats *stats)
1194 {
1195     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1196     int retval;
1197
1198     retval = (class->get_queue_stats
1199               ? class->get_queue_stats(netdev, queue_id, stats)
1200               : EOPNOTSUPP);
1201     if (retval) {
1202         memset(stats, 0xff, sizeof *stats);
1203     }
1204     return retval;
1205 }
1206
1207 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1208  * its configuration, and the 'aux' specified by the caller.  The order of
1209  * iteration is unspecified, but (when successful) each queue is visited
1210  * exactly once.
1211  *
1212  * Calling this function may be more efficient than calling netdev_get_queue()
1213  * for every queue.
1214  *
1215  * 'cb' must not modify or free the 'details' argument passed in.
1216  *
1217  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1218  * configured queues may not have been included in the iteration. */
1219 int
1220 netdev_dump_queues(const struct netdev *netdev,
1221                    netdev_dump_queues_cb *cb, void *aux)
1222 {
1223     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1224     return (class->dump_queues
1225             ? class->dump_queues(netdev, cb, aux)
1226             : EOPNOTSUPP);
1227 }
1228
1229 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1230  * its statistics, and the 'aux' specified by the caller.  The order of
1231  * iteration is unspecified, but (when successful) each queue is visited
1232  * exactly once.
1233  *
1234  * Calling this function may be more efficient than calling
1235  * netdev_get_queue_stats() for every queue.
1236  *
1237  * 'cb' must not modify or free the statistics passed in.
1238  *
1239  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1240  * configured queues may not have been included in the iteration. */
1241 int
1242 netdev_dump_queue_stats(const struct netdev *netdev,
1243                         netdev_dump_queue_stats_cb *cb, void *aux)
1244 {
1245     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1246     return (class->dump_queue_stats
1247             ? class->dump_queue_stats(netdev, cb, aux)
1248             : EOPNOTSUPP);
1249 }
1250
1251 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
1252  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
1253  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
1254  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
1255  * -1. */
1256 int
1257 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1258 {
1259     int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
1260                  ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
1261                         vlan_vid)
1262                  : ENOENT);
1263     if (error) {
1264         *vlan_vid = 0;
1265     }
1266     return error;
1267 }
1268
1269 /* Returns a network device that has 'in4' as its IP address, if one exists,
1270  * otherwise a null pointer. */
1271 struct netdev *
1272 netdev_find_dev_by_in4(const struct in_addr *in4)
1273 {
1274     struct netdev *netdev;
1275     struct svec dev_list = SVEC_EMPTY_INITIALIZER;
1276     size_t i;
1277
1278     netdev_enumerate(&dev_list);
1279     for (i = 0; i < dev_list.n; i++) {
1280         const char *name = dev_list.names[i];
1281         struct in_addr dev_in4;
1282
1283         if (!netdev_open_default(name, &netdev)
1284             && !netdev_get_in4(netdev, &dev_in4, NULL)
1285             && dev_in4.s_addr == in4->s_addr) {
1286             goto exit;
1287         }
1288         netdev_close(netdev);
1289     }
1290     netdev = NULL;
1291
1292 exit:
1293     svec_destroy(&dev_list);
1294     return netdev;
1295 }
1296 \f
1297 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
1298  * specified 'netdev_class'.
1299  *
1300  * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1301  * very important that 'netdev_dev' only be freed after calling
1302  * the refcount drops to zero.  */
1303 void
1304 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1305                 const struct netdev_class *netdev_class)
1306 {
1307     assert(!shash_find(&netdev_dev_shash, name));
1308
1309     memset(netdev_dev, 0, sizeof *netdev_dev);
1310     netdev_dev->netdev_class = netdev_class;
1311     netdev_dev->name = xstrdup(name);
1312     netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1313 }
1314
1315 /* Undoes the results of initialization.
1316  *
1317  * Normally this function does not need to be called as netdev_close has
1318  * the same effect when the refcount drops to zero.
1319  * However, it may be called by providers due to an error on creation
1320  * that occurs after initialization.  It this case netdev_close() would
1321  * never be called. */
1322 void
1323 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1324 {
1325     char *name = netdev_dev->name;
1326
1327     assert(!netdev_dev->ref_cnt);
1328
1329     shash_delete(&netdev_dev_shash, netdev_dev->node);
1330     update_device_args(netdev_dev, NULL);
1331
1332     if (destroy) {
1333         netdev_dev->netdev_class->destroy(netdev_dev);
1334     }
1335     free(name);
1336 }
1337
1338 /* Returns the class type of 'netdev_dev'.
1339  *
1340  * The caller must not free the returned value. */
1341 const char *
1342 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1343 {
1344     return netdev_dev->netdev_class->type;
1345 }
1346
1347 /* Returns the class associated with 'netdev_dev'. */
1348 const struct netdev_class *
1349 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1350 {
1351     return netdev_dev->netdev_class;
1352 }
1353
1354 /* Returns the name of 'netdev_dev'.
1355  *
1356  * The caller must not free the returned value. */
1357 const char *
1358 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1359 {
1360     return netdev_dev->name;
1361 }
1362
1363 /* Returns the netdev_dev with 'name' or NULL if there is none.
1364  *
1365  * The caller must not free the returned value. */
1366 struct netdev_dev *
1367 netdev_dev_from_name(const char *name)
1368 {
1369     return shash_find_data(&netdev_dev_shash, name);
1370 }
1371
1372 /* Fills 'device_list' with devices that match 'netdev_class'.
1373  *
1374  * The caller is responsible for initializing and destroying 'device_list'
1375  * but the contained netdev_devs must not be freed. */
1376 void
1377 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1378                        struct shash *device_list)
1379 {
1380     struct shash_node *node;
1381     SHASH_FOR_EACH (node, &netdev_dev_shash) {
1382         struct netdev_dev *dev = node->data;
1383
1384         if (dev->netdev_class == netdev_class) {
1385             shash_add(device_list, node->name, node->data);
1386         }
1387     }
1388 }
1389
1390 /* Initializes 'netdev' as a instance of the netdev_dev.
1391  *
1392  * This function adds 'netdev' to a netdev-owned linked list, so it is very
1393  * important that 'netdev' only be freed after calling netdev_close(). */
1394 void
1395 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1396 {
1397     memset(netdev, 0, sizeof *netdev);
1398     netdev->netdev_dev = netdev_dev;
1399     list_push_back(&netdev_list, &netdev->node);
1400 }
1401
1402 /* Undoes the results of initialization.
1403  *
1404  * Normally this function only needs to be called from netdev_close().
1405  * However, it may be called by providers due to an error on opening
1406  * that occurs after initialization.  It this case netdev_close() would
1407  * never be called. */
1408 void
1409 netdev_uninit(struct netdev *netdev, bool close)
1410 {
1411     /* Restore flags that we changed, if any. */
1412     int error = restore_flags(netdev);
1413     list_remove(&netdev->node);
1414     if (error) {
1415         VLOG_WARN("failed to restore network device flags on %s: %s",
1416                   netdev_get_name(netdev), strerror(error));
1417     }
1418
1419     if (close) {
1420         netdev_get_dev(netdev)->netdev_class->close(netdev);
1421     }
1422 }
1423
1424
1425 /* Returns the class type of 'netdev'.
1426  *
1427  * The caller must not free the returned value. */
1428 const char *
1429 netdev_get_type(const struct netdev *netdev)
1430 {
1431     return netdev_get_dev(netdev)->netdev_class->type;
1432 }
1433
1434 struct netdev_dev *
1435 netdev_get_dev(const struct netdev *netdev)
1436 {
1437     return netdev->netdev_dev;
1438 }
1439
1440 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
1441  * notification will consist of calling 'cb', with auxiliary data 'aux'. */
1442 void
1443 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
1444                      void (*cb)(struct netdev_notifier *), void *aux)
1445 {
1446     notifier->netdev = netdev;
1447     notifier->cb = cb;
1448     notifier->aux = aux;
1449 }
1450 \f
1451 /* Tracks changes in the status of a set of network devices. */
1452 struct netdev_monitor {
1453     struct shash polled_netdevs;
1454     struct shash changed_netdevs;
1455 };
1456
1457 /* Creates and returns a new structure for monitor changes in the status of
1458  * network devices. */
1459 struct netdev_monitor *
1460 netdev_monitor_create(void)
1461 {
1462     struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
1463     shash_init(&monitor->polled_netdevs);
1464     shash_init(&monitor->changed_netdevs);
1465     return monitor;
1466 }
1467
1468 /* Destroys 'monitor'. */
1469 void
1470 netdev_monitor_destroy(struct netdev_monitor *monitor)
1471 {
1472     if (monitor) {
1473         struct shash_node *node;
1474
1475         SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
1476             struct netdev_notifier *notifier = node->data;
1477             netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
1478                     notifier);
1479         }
1480
1481         shash_destroy(&monitor->polled_netdevs);
1482         shash_destroy(&monitor->changed_netdevs);
1483         free(monitor);
1484     }
1485 }
1486
1487 static void
1488 netdev_monitor_cb(struct netdev_notifier *notifier)
1489 {
1490     struct netdev_monitor *monitor = notifier->aux;
1491     const char *name = netdev_get_name(notifier->netdev);
1492     shash_add_once(&monitor->changed_netdevs, name, NULL);
1493 }
1494
1495 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'.  Returns 0 if
1496  * successful, otherwise a positive errno value.
1497  *
1498  * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1499  * it once. */
1500 int
1501 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1502 {
1503     const char *netdev_name = netdev_get_name(netdev);
1504     int error = 0;
1505     if (!shash_find(&monitor->polled_netdevs, netdev_name)
1506             && netdev_get_dev(netdev)->netdev_class->poll_add)
1507     {
1508         struct netdev_notifier *notifier;
1509         error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
1510                     netdev_monitor_cb, monitor, &notifier);
1511         if (!error) {
1512             assert(notifier->netdev == netdev);
1513             shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1514         }
1515     }
1516     return error;
1517 }
1518
1519 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'.  (This has
1520  * no effect if 'netdev' is not in the set of devices monitored by
1521  * 'monitor'.) */
1522 void
1523 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1524 {
1525     const char *netdev_name = netdev_get_name(netdev);
1526     struct shash_node *node;
1527
1528     node = shash_find(&monitor->polled_netdevs, netdev_name);
1529     if (node) {
1530         /* Cancel future notifications. */
1531         struct netdev_notifier *notifier = node->data;
1532         netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
1533         shash_delete(&monitor->polled_netdevs, node);
1534
1535         /* Drop any pending notification. */
1536         node = shash_find(&monitor->changed_netdevs, netdev_name);
1537         if (node) {
1538             shash_delete(&monitor->changed_netdevs, node);
1539         }
1540     }
1541 }
1542
1543 /* Checks for changes to netdevs in the set monitored by 'monitor'.  If any of
1544  * the attributes (Ethernet address, carrier status, speed or peer-advertised
1545  * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1546  * sets '*devnamep' to the name of a device that has changed and returns 0.
1547  * The caller is responsible for freeing '*devnamep' (with free()).
1548  *
1549  * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN. */
1550 int
1551 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1552 {
1553     struct shash_node *node = shash_first(&monitor->changed_netdevs);
1554     if (!node) {
1555         *devnamep = NULL;
1556         return EAGAIN;
1557     } else {
1558         *devnamep = shash_steal(&monitor->changed_netdevs, node);
1559         return 0;
1560     }
1561 }
1562
1563 /* Registers with the poll loop to wake up from the next call to poll_block()
1564  * when netdev_monitor_poll(monitor) would indicate that a device has
1565  * changed. */
1566 void
1567 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1568 {
1569     if (!shash_is_empty(&monitor->changed_netdevs)) {
1570         poll_immediate_wake();
1571     } else {
1572         /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1573          * classes need help. */
1574     }
1575 }
1576 \f
1577 /* Restore the network device flags on 'netdev' to those that were active
1578  * before we changed them.  Returns 0 if successful, otherwise a positive
1579  * errno value.
1580  *
1581  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1582 static int
1583 restore_flags(struct netdev *netdev)
1584 {
1585     if (netdev->changed_flags) {
1586         enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1587         enum netdev_flags old_flags;
1588         return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1589                                            netdev->changed_flags & ~restore,
1590                                            restore, &old_flags);
1591     }
1592     return 0;
1593 }
1594
1595 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1596  * destroying devices, restoring flags, etc. */
1597 static void
1598 close_all_netdevs(void *aux OVS_UNUSED)
1599 {
1600     struct netdev *netdev, *next;
1601     LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1602         netdev_close(netdev);
1603     }
1604 }