lib/netdev.c

   1 /*
   2  * Copyright (c) 2008, 2009 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 "list.h"
  32 #include "netdev-provider.h"
  33 #include "ofpbuf.h"
  34 #include "packets.h"
  35 #include "poll-loop.h"
  36 #include "shash.h"
  37 #include "svec.h"
  38
  39 #define THIS_MODULE VLM_netdev
  40 #include "vlog.h"
  41
  42 static const struct netdev_class *netdev_classes[] = {
  43     &netdev_linux_class,
  44     &netdev_tap_class,
  45 };
  46 static int n_netdev_classes = ARRAY_SIZE(netdev_classes);
  47
  48 /* All open network devices. */
  49 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
  50
  51 /* This is set pretty low because we probably won't learn anything from the
  52  * additional log messages. */
  53 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
  54
  55 static void restore_all_flags(void *aux);
  56 static int restore_flags(struct netdev *netdev);
  57
  58 /* Attempts to initialize the netdev module.  Returns 0 if successful,
  59  * otherwise a positive errno value.
  60  *
  61  * Calling this function is optional.  If not called explicitly, it will
  62  * automatically be called upon the first attempt to open a network device. */
  63 int
  64 netdev_initialize(void)
  65 {
  66     static int status = -1;
  67     if (status < 0) {
  68         int i, j;
  69
  70         fatal_signal_add_hook(restore_all_flags, NULL, true);
  71
  72         status = 0;
  73         for (i = j = 0; i < n_netdev_classes; i++) {
  74             const struct netdev_class *class = netdev_classes[i];
  75             if (class->init) {
  76                 int retval = class->init();
  77                 if (!retval) {
  78                     netdev_classes[j++] = class;
  79                 } else {
  80                     VLOG_ERR("failed to initialize %s network device "
  81                              "class: %s", class->name, strerror(retval));
  82                     if (!status) {
  83                         status = retval;
  84                     }
  85                 }
  86             } else {
  87                 netdev_classes[j++] = class;
  88             }
  89         }
  90         n_netdev_classes = j;
  91     }
  92     return status;
  93 }
  94
  95 /* Performs periodic work needed by all the various kinds of netdevs.
  96  *
  97  * If your program opens any netdevs, it must call this function within its
  98  * main poll loop. */
  99 void
 100 netdev_run(void)
 101 {
 102     int i;
 103     for (i = 0; i < n_netdev_classes; i++) {
 104         const struct netdev_class *class = netdev_classes[i];
 105         if (class->run) {
 106             class->run();
 107         }
 108     }
 109 }
 110
 111 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
 112  *
 113  * If your program opens any netdevs, it must call this function within its
 114  * main poll loop. */
 115 void
 116 netdev_wait(void)
 117 {
 118     int i;
 119     for (i = 0; i < n_netdev_classes; i++) {
 120         const struct netdev_class *class = netdev_classes[i];
 121         if (class->wait) {
 122             class->wait();
 123         }
 124     }
 125 }
 126
 127 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
 128  * successful, otherwise a positive errno value.  On success, sets '*netdevp'
 129  * to the new network device, otherwise to null.
 130  *
 131  * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
 132  * capture frames of that type received on the device.  It may also be one of
 133  * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
 134  * categories. */
 135 int
 136 netdev_open(const char *name_, int ethertype, struct netdev **netdevp)
 137 {
 138     char *name = xstrdup(name_);
 139     char *prefix, *suffix, *colon;
 140     struct netdev *netdev = NULL;
 141     int error;
 142     int i;
 143
 144     netdev_initialize();
 145     colon = strchr(name, ':');
 146     if (colon) {
 147         *colon = '\0';
 148         prefix = name;
 149         suffix = colon + 1;
 150     } else {
 151         prefix = "";
 152         suffix = name;
 153     }
 154
 155     for (i = 0; i < n_netdev_classes; i++) {
 156         const struct netdev_class *class = netdev_classes[i];
 157         if (!strcmp(prefix, class->prefix)) {
 158             error = class->open(name_, suffix, ethertype, &netdev);
 159             goto exit;
 160         }
 161     }
 162     error = EAFNOSUPPORT;
 163
 164 exit:
 165     *netdevp = error ? NULL : netdev;
 166     free(name);
 167     return error;
 168 }
 169
 170 /* Closes and destroys 'netdev'. */
 171 void
 172 netdev_close(struct netdev *netdev)
 173 {
 174     if (netdev) {
 175         char *name;
 176         int error;
 177
 178         /* Restore flags that we changed, if any. */
 179         fatal_signal_block();
 180         error = restore_flags(netdev);
 181         list_remove(&netdev->node);
 182         fatal_signal_unblock();
 183         if (error) {
 184             VLOG_WARN("failed to restore network device flags on %s: %s",
 185                       netdev->name, strerror(error));
 186         }
 187
 188         /* Free. */
 189         name = netdev->name;
 190         netdev->class->close(netdev);
 191         free(name);
 192     }
 193 }
 194
 195 /* Returns true if a network device named 'name' exists and may be opened,
 196  * otherwise false. */
 197 bool
 198 netdev_exists(const char *name)
 199 {
 200     struct netdev *netdev;
 201     int error;
 202
 203     error = netdev_open(name, NETDEV_ETH_TYPE_NONE, &netdev);
 204     if (!error) {
 205         netdev_close(netdev);
 206         return true;
 207     } else {
 208         if (error != ENODEV) {
 209             VLOG_WARN("failed to open network device %s: %s",
 210                       name, strerror(error));
 211         }
 212         return false;
 213     }
 214 }
 215
 216 /* Initializes 'svec' with a list of the names of all known network devices. */
 217 int
 218 netdev_enumerate(struct svec *svec)
 219 {
 220     int error;
 221     int i;
 222
 223     svec_init(svec);
 224
 225     netdev_initialize();
 226
 227     error = 0;
 228     for (i = 0; i < n_netdev_classes; i++) {
 229         const struct netdev_class *class = netdev_classes[i];
 230         if (class->enumerate) {
 231             int retval = class->enumerate(svec);
 232             if (retval) {
 233                 VLOG_WARN("failed to enumerate %s network devices: %s",
 234                           class->name, strerror(retval));
 235                 if (!error) {
 236                     error = retval;
 237                 }
 238             }
 239         }
 240     }
 241     return error;
 242 }
 243
 244 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
 245  * must have initialized with sufficient room for the packet.  The space
 246  * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
 247  * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
 248  * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
 249  * need not be included.)
 250  *
 251  * If a packet is successfully retrieved, returns 0.  In this case 'buffer' is
 252  * guaranteed to contain at least ETH_TOTAL_MIN bytes.  Otherwise, returns a
 253  * positive errno value.  Returns EAGAIN immediately if no packet is ready to
 254  * be returned.
 255  */
 256 int
 257 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
 258 {
 259     int retval;
 260
 261     assert(buffer->size == 0);
 262     assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
 263
 264     retval = netdev->class->recv(netdev,
 265                                  buffer->data, ofpbuf_tailroom(buffer));
 266     if (retval >= 0) {
 267         COVERAGE_INC(netdev_received);
 268         buffer->size += retval;
 269         if (buffer->size < ETH_TOTAL_MIN) {
 270             ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
 271         }
 272         return 0;
 273     } else {
 274         return -retval;
 275     }
 276 }
 277
 278 /* Registers with the poll loop to wake up from the next call to poll_block()
 279  * when a packet is ready to be received with netdev_recv() on 'netdev'. */
 280 void
 281 netdev_recv_wait(struct netdev *netdev)
 282 {
 283     netdev->class->recv_wait(netdev);
 284 }
 285
 286 /* Discards all packets waiting to be received from 'netdev'. */
 287 int
 288 netdev_drain(struct netdev *netdev)
 289 {
 290     return netdev->class->drain(netdev);
 291 }
 292
 293 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
 294  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
 295  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
 296  * the packet is too big or too small to transmit on the device.
 297  *
 298  * The caller retains ownership of 'buffer' in all cases.
 299  *
 300  * The kernel maintains a packet transmission queue, so the caller is not
 301  * expected to do additional queuing of packets. */
 302 int
 303 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
 304 {
 305     int error = netdev->class->send(netdev, buffer->data, buffer->size);
 306     if (!error) {
 307         COVERAGE_INC(netdev_sent);
 308     }
 309     return error;
 310 }
 311
 312 /* Registers with the poll loop to wake up from the next call to poll_block()
 313  * when the packet transmission queue has sufficient room to transmit a packet
 314  * with netdev_send().
 315  *
 316  * The kernel maintains a packet transmission queue, so the client is not
 317  * expected to do additional queuing of packets.  Thus, this function is
 318  * unlikely to ever be used.  It is included for completeness. */
 319 void
 320 netdev_send_wait(struct netdev *netdev)
 321 {
 322     return netdev->class->send_wait(netdev);
 323 }
 324
 325 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
 326  * otherwise a positive errno value. */
 327 int
 328 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
 329 {
 330     return netdev->class->set_etheraddr(netdev, mac);
 331 }
 332
 333 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
 334  * the MAC address into 'mac'.  On failure, returns a positive errno value and
 335  * clears 'mac' to all-zeros. */
 336 int
 337 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
 338 {
 339     return netdev->class->get_etheraddr(netdev, mac);
 340 }
 341
 342 /* Returns the name of the network device that 'netdev' represents,
 343  * e.g. "eth0".  The caller must not modify or free the returned string. */
 344 const char *
 345 netdev_get_name(const struct netdev *netdev)
 346 {
 347     return netdev->name;
 348 }
 349
 350 /* Retrieves the MTU of 'netdev'.  The MTU is the maximum size of transmitted
 351  * (and received) packets, in bytes, not including the hardware header; thus,
 352  * this is typically 1500 bytes for Ethernet devices.
 353  *
 354  * If successful, returns 0 and stores the MTU size in '*mtup'.  On failure,
 355  * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
 356  * '*mtup'. */
 357 int
 358 netdev_get_mtu(const struct netdev *netdev, int *mtup)
 359 {
 360     int error = netdev->class->get_mtu(netdev, mtup);
 361     if (error) {
 362         VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
 363                      netdev_get_name(netdev), strerror(error));
 364         *mtup = ETH_PAYLOAD_MAX;
 365     }
 366     return error;
 367 }
 368
 369 /* Returns the ifindex of 'netdev', if successful, as a positive number.  On
 370  * failure, returns a negative errno value.
 371  *
 372  * The desired semantics of the ifindex value are a combination of those
 373  * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An ifindex
 374  * value should be unique within a host and remain stable at least until
 375  * reboot.  SNMP says an ifindex "ranges between 1 and the value of ifNumber"
 376  * but many systems do not follow this rule anyhow.
 377  */
 378 int
 379 netdev_get_ifindex(const struct netdev *netdev)
 380 {
 381     return netdev->class->get_ifindex(netdev);
 382 }
 383
 384 /* Stores the features supported by 'netdev' into each of '*current',
 385  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
 386  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
 387  * successful, otherwise a positive errno value.  On failure, all of the
 388  * passed-in values are set to 0. */
 389 int
 390 netdev_get_features(struct netdev *netdev,
 391                     uint32_t *current, uint32_t *advertised,
 392                     uint32_t *supported, uint32_t *peer)
 393 {
 394     uint32_t dummy[4];
 395     int error;
 396
 397     if (!current) {
 398         current = &dummy[0];
 399     }
 400     if (!advertised) {
 401         advertised = &dummy[1];
 402     }
 403     if (!supported) {
 404         supported = &dummy[2];
 405     }
 406     if (!peer) {
 407         peer = &dummy[3];
 408     }
 409
 410     error = netdev->class->get_features(netdev, current, advertised, supported,
 411                                         peer);
 412     if (error) {
 413         *current = *advertised = *supported = *peer = 0;
 414     }
 415     return error;
 416 }
 417
 418 /* Set the features advertised by 'netdev' to 'advertise'.  Returns 0 if
 419  * successful, otherwise a positive errno value. */
 420 int
 421 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
 422 {
 423     return (netdev->class->set_advertisements
 424             ? netdev->class->set_advertisements(netdev, advertise)
 425             : EOPNOTSUPP);
 426 }
 427
 428 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
 429  * and '*netmask' to its netmask and returns 0.  Otherwise, returns a positive
 430  * errno value and sets '*address' to 0 (INADDR_ANY).
 431  *
 432  * The following error values have well-defined meanings:
 433  *
 434  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 435  *
 436  *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 437  *
 438  * 'address' or 'netmask' or both may be null, in which case the address or netmask
 439  * is not reported. */
 440 int
 441 netdev_get_in4(const struct netdev *netdev,
 442                struct in_addr *address_, struct in_addr *netmask_)
 443 {
 444     struct in_addr address;
 445     struct in_addr netmask;
 446     int error;
 447
 448     error = (netdev->class->get_in4
 449              ? netdev->class->get_in4(netdev, &address, &netmask)
 450              : EOPNOTSUPP);
 451     if (address_) {
 452         address_->s_addr = error ? 0 : address.s_addr;
 453     }
 454     if (netmask_) {
 455         netmask_->s_addr = error ? 0 : netmask.s_addr;
 456     }
 457     return error;
 458 }
 459
 460 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 461  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
 462  * positive errno value. */
 463 int
 464 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
 465 {
 466     return (netdev->class->set_in4
 467             ? netdev->class->set_in4(netdev, addr, mask)
 468             : EOPNOTSUPP);
 469 }
 470
 471 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
 472  * to 'netdev'. */
 473 int
 474 netdev_add_router(struct netdev *netdev, struct in_addr router)
 475 {
 476     COVERAGE_INC(netdev_add_router);
 477     return (netdev->class->add_router
 478             ? netdev->class->add_router(netdev, router)
 479             : EOPNOTSUPP);
 480 }
 481
 482 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
 483  * 'netdev'.  If a route cannot not be determined, sets '*next_hop' to 0,
 484  * '*netdev_name' to null, and returns a positive errno value.  Otherwise, if a
 485  * next hop is found, stores the next hop gateway's address (0 if 'host' is on
 486  * a directly connected network) in '*next_hop' and a copy of the name of the
 487  * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
 488  * responsible for freeing '*netdev_name' (by calling free()). */
 489 int
 490 netdev_get_next_hop(const struct netdev *netdev,
 491                     const struct in_addr *host, struct in_addr *next_hop,
 492                     char **netdev_name)
 493 {
 494     int error = (netdev->class->get_next_hop
 495                  ? netdev->class->get_next_hop(host, next_hop, netdev_name)
 496                  : EOPNOTSUPP);
 497     if (error) {
 498         next_hop->s_addr = 0;
 499         *netdev_name = NULL;
 500     }
 501     return error;
 502 }
 503
 504 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
 505  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
 506  * all-zero-bits (in6addr_any).
 507  *
 508  * The following error values have well-defined meanings:
 509  *
 510  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 511  *
 512  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 513  *
 514  * 'in6' may be null, in which case the address itself is not reported. */
 515 int
 516 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 517 {
 518     struct in6_addr dummy;
 519     int error;
 520
 521     error = (netdev->class->get_in6
 522              ? netdev->class->get_in6(netdev, in6 ? in6 : &dummy)
 523              : EOPNOTSUPP);
 524     if (error && in6) {
 525         memset(in6, 0, sizeof *in6);
 526     }
 527     return error;
 528 }
 529
 530 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 531  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
 532  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
 533  * successful, otherwise a positive errno value. */
 534 static int
 535 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 536                 enum netdev_flags on, enum netdev_flags *old_flagsp,
 537                 bool permanent)
 538 {
 539     enum netdev_flags old_flags;
 540     int error;
 541
 542     error = netdev->class->update_flags(netdev, off & ~on, on, &old_flags);
 543     if (error) {
 544         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
 545                      off || on ? "set" : "get", netdev_get_name(netdev),
 546                      strerror(error));
 547         old_flags = 0;
 548     } else if ((off || on) && !permanent) {
 549         enum netdev_flags new_flags = (old_flags & ~off) | on;
 550         enum netdev_flags changed_flags = old_flags ^ new_flags;
 551         if (changed_flags) {
 552             if (!netdev->changed_flags) {
 553                 netdev->save_flags = old_flags;
 554             }
 555             netdev->changed_flags |= changed_flags;
 556         }
 557     }
 558     if (old_flagsp) {
 559         *old_flagsp = old_flags;
 560     }
 561     return error;
 562 }
 563
 564 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 565  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 566  * stores 0 into '*flagsp'. */
 567 int
 568 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
 569 {
 570     struct netdev *netdev = (struct netdev *) netdev_;
 571     return do_update_flags(netdev, 0, 0, flagsp, false);
 572 }
 573
 574 /* Sets the flags for 'netdev' to 'flags'.
 575  * If 'permanent' is true, the changes will persist; otherwise, they
 576  * will be reverted when 'netdev' is closed or the program exits.
 577  * Returns 0 if successful, otherwise a positive errno value. */
 578 int
 579 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
 580                  bool permanent)
 581 {
 582     return do_update_flags(netdev, -1, flags, NULL, permanent);
 583 }
 584
 585 /* Turns on the specified 'flags' on 'netdev'.
 586  * If 'permanent' is true, the changes will persist; otherwise, they
 587  * will be reverted when 'netdev' is closed or the program exits.
 588  * Returns 0 if successful, otherwise a positive errno value. */
 589 int
 590 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
 591                      bool permanent)
 592 {
 593     return do_update_flags(netdev, 0, flags, NULL, permanent);
 594 }
 595
 596 /* Turns off the specified 'flags' on 'netdev'.
 597  * If 'permanent' is true, the changes will persist; otherwise, they
 598  * will be reverted when 'netdev' is closed or the program exits.
 599  * Returns 0 if successful, otherwise a positive errno value. */
 600 int
 601 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
 602                       bool permanent)
 603 {
 604     return do_update_flags(netdev, flags, 0, NULL, permanent);
 605 }
 606
 607 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
 608  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
 609  * returns 0.  Otherwise, it returns a positive errno value; in particular,
 610  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
 611 int
 612 netdev_arp_lookup(const struct netdev *netdev,
 613                   uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
 614 {
 615     int error = (netdev->class->arp_lookup
 616                  ? netdev->class->arp_lookup(netdev, ip, mac)
 617                  : EOPNOTSUPP);
 618     if (error) {
 619         memset(mac, 0, ETH_ADDR_LEN);
 620     }
 621     return error;
 622 }
 623
 624 /* Sets 'carrier' to true if carrier is active (link light is on) on
 625  * 'netdev'. */
 626 int
 627 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
 628 {
 629     int error = (netdev->class->get_carrier
 630                  ? netdev->class->get_carrier(netdev, carrier)
 631                  : EOPNOTSUPP);
 632     if (error) {
 633         *carrier = false;
 634     }
 635     return error;
 636 }
 637
 638 /* Retrieves current device stats for 'netdev'. */
 639 int
 640 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 641 {
 642     int error;
 643
 644     COVERAGE_INC(netdev_get_stats);
 645     error = (netdev->class->get_stats
 646              ? netdev->class->get_stats(netdev, stats)
 647              : EOPNOTSUPP);
 648     if (error) {
 649         memset(stats, 0xff, sizeof *stats);
 650     }
 651     return error;
 652 }
 653
 654 /* Attempts to set input rate limiting (policing) policy, such that up to
 655  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
 656  * size of 'kbits' kb. */
 657 int
 658 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
 659                     uint32_t kbits_burst)
 660 {
 661     return (netdev->class->set_policing
 662             ? netdev->class->set_policing(netdev, kbits_rate, kbits_burst)
 663             : EOPNOTSUPP);
 664 }
 665
 666 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
 667  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
 668  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
 669  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
 670  * -1. */
 671 int
 672 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
 673 {
 674     int error = (netdev->class->get_vlan_vid
 675                  ? netdev->class->get_vlan_vid(netdev, vlan_vid)
 676                  : ENOENT);
 677     if (error) {
 678         *vlan_vid = 0;
 679     }
 680     return error;
 681 }
 682
 683 /* Returns a network device that has 'in4' as its IP address, if one exists,
 684  * otherwise a null pointer. */
 685 struct netdev *
 686 netdev_find_dev_by_in4(const struct in_addr *in4)
 687 {
 688     struct netdev *netdev;
 689     struct svec dev_list;
 690     size_t i;
 691
 692     netdev_enumerate(&dev_list);
 693     for (i = 0; i < dev_list.n; i++) {
 694         const char *name = dev_list.names[i];
 695         struct in_addr dev_in4;
 696
 697         if (!netdev_open(name, NETDEV_ETH_TYPE_NONE, &netdev)
 698             && !netdev_get_in4(netdev, &dev_in4, NULL)
 699             && dev_in4.s_addr == in4->s_addr) {
 700             goto exit;
 701         }
 702         netdev_close(netdev);
 703     }
 704     netdev = NULL;
 705
 706 exit:
 707     svec_destroy(&dev_list);
 708     return netdev;
 709 }
 710 \f
 711 /* Initializes 'netdev' as a netdev named 'name' of the specified 'class'.
 712  *
 713  * This function adds 'netdev' to a netdev-owned linked list, so it is very
 714  * important that 'netdev' only be freed after calling netdev_close(). */
 715 void
 716 netdev_init(struct netdev *netdev, const char *name,
 717             const struct netdev_class *class)
 718 {
 719     netdev->class = class;
 720     netdev->name = xstrdup(name);
 721     netdev->save_flags = 0;
 722     netdev->changed_flags = 0;
 723     list_push_back(&netdev_list, &netdev->node);
 724 }
 725
 726 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
 727  * notification will consist of calling 'cb', with auxiliary data 'aux'. */
 728 void
 729 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
 730                      void (*cb)(struct netdev_notifier *), void *aux)
 731 {
 732     notifier->netdev = netdev;
 733     notifier->cb = cb;
 734     notifier->aux = aux;
 735 }
 736 \f
 737 /* Tracks changes in the status of a set of network devices. */
 738 struct netdev_monitor {
 739     struct shash polled_netdevs;
 740     struct shash changed_netdevs;
 741 };
 742
 743 /* Creates and returns a new structure for monitor changes in the status of
 744  * network devices. */
 745 struct netdev_monitor *
 746 netdev_monitor_create(void)
 747 {
 748     struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
 749     shash_init(&monitor->polled_netdevs);
 750     shash_init(&monitor->changed_netdevs);
 751     return monitor;
 752 }
 753
 754 /* Destroys 'monitor'. */
 755 void
 756 netdev_monitor_destroy(struct netdev_monitor *monitor)
 757 {
 758     if (monitor) {
 759         struct shash_node *node;
 760
 761         SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
 762             struct netdev_notifier *notifier = node->data;
 763             notifier->netdev->class->poll_remove(notifier);
 764         }
 765
 766         shash_destroy(&monitor->polled_netdevs);
 767         shash_destroy(&monitor->changed_netdevs);
 768         free(monitor);
 769     }
 770 }
 771
 772 static void
 773 netdev_monitor_cb(struct netdev_notifier *notifier)
 774 {
 775     struct netdev_monitor *monitor = notifier->aux;
 776     const char *name = netdev_get_name(notifier->netdev);
 777     if (!shash_find(&monitor->changed_netdevs, name)) {
 778         shash_add(&monitor->changed_netdevs, name, NULL);
 779     }
 780 }
 781
 782 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'.  Returns 0 if
 783  * successful, otherwise a positive errno value.
 784  *
 785  * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
 786  * it once. */
 787 int
 788 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
 789 {
 790     const char *netdev_name = netdev_get_name(netdev);
 791     int error = 0;
 792     if (!shash_find(&monitor->polled_netdevs, netdev_name)
 793         && netdev->class->poll_add)
 794     {
 795         struct netdev_notifier *notifier;
 796         error = netdev->class->poll_add(netdev, netdev_monitor_cb, monitor,
 797                                         &notifier);
 798         if (!error) {
 799             assert(notifier->netdev == netdev);
 800             shash_add(&monitor->polled_netdevs, netdev_name, notifier);
 801         }
 802     }
 803     return error;
 804 }
 805
 806 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'.  (This has
 807  * no effect if 'netdev' is not in the set of devices monitored by
 808  * 'monitor'.) */
 809 void
 810 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
 811 {
 812     const char *netdev_name = netdev_get_name(netdev);
 813     struct shash_node *node;
 814
 815     node = shash_find(&monitor->polled_netdevs, netdev_name);
 816     if (node) {
 817         /* Cancel future notifications. */
 818         struct netdev_notifier *notifier = node->data;
 819         netdev->class->poll_remove(notifier);
 820         shash_delete(&monitor->polled_netdevs, node);
 821
 822         /* Drop any pending notification. */
 823         node = shash_find(&monitor->changed_netdevs, netdev_name);
 824         if (node) {
 825             shash_delete(&monitor->changed_netdevs, node);
 826         }
 827     }
 828 }
 829
 830 /* Checks for changes to netdevs in the set monitored by 'monitor'.  If any of
 831  * the attributes (Ethernet address, carrier status, speed or peer-advertised
 832  * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
 833  * sets '*devnamep' to the name of a device that has changed and returns 0.
 834  * The caller is responsible for freeing '*devnamep' (with free()).
 835  *
 836  * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
 837  */
 838 int
 839 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
 840 {
 841     struct shash_node *node = shash_first(&monitor->changed_netdevs);
 842     if (!node) {
 843         *devnamep = NULL;
 844         return EAGAIN;
 845     } else {
 846         *devnamep = xstrdup(node->name);
 847         shash_delete(&monitor->changed_netdevs, node);
 848         return 0;
 849     }
 850 }
 851
 852 /* Registers with the poll loop to wake up from the next call to poll_block()
 853  * when netdev_monitor_poll(monitor) would indicate that a device has
 854  * changed. */
 855 void
 856 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
 857 {
 858     if (!shash_is_empty(&monitor->changed_netdevs)) {
 859         poll_immediate_wake();
 860     } else {
 861         /* XXX Nothing needed here for netdev_linux, but maybe other netdev
 862          * classes need help. */
 863     }
 864 }
 865 \f
 866 /* Restore the network device flags on 'netdev' to those that were active
 867  * before we changed them.  Returns 0 if successful, otherwise a positive
 868  * errno value.
 869  *
 870  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
 871 static int
 872 restore_flags(struct netdev *netdev)
 873 {
 874     if (netdev->changed_flags) {
 875         enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
 876         enum netdev_flags old_flags;
 877         return netdev->class->update_flags(netdev,
 878                                            netdev->changed_flags & ~restore,
 879                                            restore, &old_flags);
 880     }
 881     return 0;
 882 }
 883
 884 /* Retores all the flags on all network devices that we modified.  Called from
 885  * a signal handler, so it does not attempt to report error conditions. */
 886 static void
 887 restore_all_flags(void *aux UNUSED)
 888 {
 889     struct netdev *netdev;
 890     LIST_FOR_EACH (netdev, struct netdev, node, &netdev_list) {
 891         restore_flags(netdev);
 892     }
 893 }