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 <fcntl.h>
  23 #include <arpa/inet.h>
  24 #include <inttypes.h>
  25 #include <linux/if_tun.h>
  26 #include <linux/types.h>
  27 #include <linux/ethtool.h>
  28 #include <linux/rtnetlink.h>
  29 #include <linux/sockios.h>
  30 #include <linux/version.h>
  31 #include <sys/types.h>
  32 #include <sys/ioctl.h>
  33 #include <sys/socket.h>
  34 #include <netpacket/packet.h>
  35 #include <net/ethernet.h>
  36 #include <net/if.h>
  37 #include <net/if_arp.h>
  38 #include <net/if_packet.h>
  39 #include <net/route.h>
  40 #include <netinet/in.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <unistd.h>
  44
  45 #include "coverage.h"
  46 #include "dynamic-string.h"
  47 #include "fatal-signal.h"
  48 #include "list.h"
  49 #include "netdev-linux.h"
  50 #include "netlink.h"
  51 #include "ofpbuf.h"
  52 #include "openflow/openflow.h"
  53 #include "packets.h"
  54 #include "poll-loop.h"
  55 #include "shash.h"
  56 #include "socket-util.h"
  57 #include "svec.h"
  58
  59 /* linux/if.h defines IFF_LOWER_UP, net/if.h doesn't.
  60  * net/if.h defines if_nameindex(), linux/if.h doesn't.
  61  * We can't include both headers, so define IFF_LOWER_UP ourselves. */
  62 #ifndef IFF_LOWER_UP
  63 #define IFF_LOWER_UP 0x10000
  64 #endif
  65
  66 /* These were introduced in Linux 2.6.14, so they might be missing if we have
  67  * old headers. */
  68 #ifndef ADVERTISED_Pause
  69 #define ADVERTISED_Pause                (1 << 13)
  70 #endif
  71 #ifndef ADVERTISED_Asym_Pause
  72 #define ADVERTISED_Asym_Pause           (1 << 14)
  73 #endif
  74
  75 #define THIS_MODULE VLM_netdev
  76 #include "vlog.h"
  77
  78 struct netdev {
  79     struct list node;
  80     char *name;
  81
  82     /* File descriptors.  For ordinary network devices, the two fds below are
  83      * the same; for tap devices, they differ. */
  84     int netdev_fd;              /* Network device. */
  85     int tap_fd;                 /* TAP character device, if any, otherwise the
  86                                  * network device. */
  87
  88     /* Cached network device information. */
  89     int ifindex;                /* -1 if not known. */
  90     uint8_t etheraddr[ETH_ADDR_LEN];
  91     struct in6_addr in6;
  92     int speed;
  93     int mtu;
  94     int txqlen;
  95     int hwaddr_family;
  96
  97     int save_flags;             /* Initial device flags. */
  98     int changed_flags;          /* Flags that we changed. */
  99 };
 100
 101 /* Policy for RTNLGRP_LINK messages.
 102  *
 103  * There are *many* more fields in these messages, but currently we only care
 104  * about interface names. */
 105 static const struct nl_policy rtnlgrp_link_policy[] = {
 106     [IFLA_IFNAME] = { .type = NL_A_STRING, .optional = false },
 107     [IFLA_STATS] = { .type = NL_A_UNSPEC, .optional = true,
 108                      .min_len = sizeof(struct rtnl_link_stats) },
 109 };
 110
 111 /* All open network devices. */
 112 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
 113
 114 /* An AF_INET socket (used for ioctl operations). */
 115 static int af_inet_sock = -1;
 116
 117 /* NETLINK_ROUTE socket. */
 118 static struct nl_sock *rtnl_sock;
 119
 120 /* Can we use RTM_GETLINK to get network device statistics?  (In pre-2.6.19
 121  * kernels, this was only available if wireless extensions were enabled.) */
 122 static bool use_netlink_stats;
 123
 124 /* This is set pretty low because we probably won't learn anything from the
 125  * additional log messages. */
 126 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
 127
 128 static void init_netdev(void);
 129 static int do_open_netdev(const char *name, int ethertype, int tap_fd,
 130                           struct netdev **netdev_);
 131 static int restore_flags(struct netdev *netdev);
 132 static int get_flags(const char *netdev_name, int *flagsp);
 133 static int set_flags(const char *netdev_name, int flags);
 134 static int do_get_ifindex(const char *netdev_name);
 135 static int get_ifindex(const struct netdev *, int *ifindexp);
 136 static int get_etheraddr(const char *netdev_name, uint8_t ea[ETH_ADDR_LEN],
 137                          int *hwaddr_familyp);
 138 static int set_etheraddr(const char *netdev_name, int hwaddr_family,
 139                          const uint8_t[ETH_ADDR_LEN]);
 140
 141 /* Obtains the IPv6 address for 'name' into 'in6'. */
 142 static void
 143 get_ipv6_address(const char *name, struct in6_addr *in6)
 144 {
 145     FILE *file;
 146     char line[128];
 147
 148     file = fopen("/proc/net/if_inet6", "r");
 149     if (file == NULL) {
 150         /* This most likely indicates that the host doesn't have IPv6 support,
 151          * so it's not really a failure condition.*/
 152         *in6 = in6addr_any;
 153         return;
 154     }
 155
 156     while (fgets(line, sizeof line, file)) {
 157         uint8_t *s6 = in6->s6_addr;
 158         char ifname[16 + 1];
 159
 160 #define X8 "%2"SCNx8
 161         if (sscanf(line, " "X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8
 162                    "%*x %*x %*x %*x %16s\n",
 163                    &s6[0], &s6[1], &s6[2], &s6[3],
 164                    &s6[4], &s6[5], &s6[6], &s6[7],
 165                    &s6[8], &s6[9], &s6[10], &s6[11],
 166                    &s6[12], &s6[13], &s6[14], &s6[15],
 167                    ifname) == 17
 168             && !strcmp(name, ifname))
 169         {
 170             fclose(file);
 171             return;
 172         }
 173     }
 174     *in6 = in6addr_any;
 175
 176     fclose(file);
 177 }
 178
 179 static int
 180 do_ethtool(struct netdev *netdev, struct ethtool_cmd *ecmd,
 181            int cmd, const char *cmd_name)
 182 {
 183     struct ifreq ifr;
 184
 185     memset(&ifr, 0, sizeof ifr);
 186     strncpy(ifr.ifr_name, netdev->name, sizeof ifr.ifr_name);
 187     ifr.ifr_data = (caddr_t) ecmd;
 188
 189     ecmd->cmd = cmd;
 190     COVERAGE_INC(netdev_ethtool);
 191     if (ioctl(netdev->netdev_fd, SIOCETHTOOL, &ifr) == 0) {
 192         return 0;
 193     } else {
 194         if (errno != EOPNOTSUPP) {
 195             VLOG_WARN_RL(&rl, "ethtool command %s on network device %s "
 196                          "failed: %s", cmd_name, netdev->name,
 197                          strerror(errno));
 198         } else {
 199             /* The device doesn't support this operation.  That's pretty
 200              * common, so there's no point in logging anything. */
 201         }
 202         return errno;
 203     }
 204 }
 205
 206 static int
 207 do_get_features(struct netdev *netdev,
 208                 uint32_t *current, uint32_t *advertised,
 209                 uint32_t *supported, uint32_t *peer)
 210 {
 211     struct ethtool_cmd ecmd;
 212     int error;
 213
 214     *current = 0;
 215     *supported = 0;
 216     *advertised = 0;
 217     *peer = 0;
 218
 219     memset(&ecmd, 0, sizeof ecmd);
 220     error = do_ethtool(netdev, &ecmd, ETHTOOL_GSET, "ETHTOOL_GSET");
 221     if (error) {
 222         return error;
 223     }
 224
 225     if (ecmd.supported & SUPPORTED_10baseT_Half) {
 226         *supported |= OFPPF_10MB_HD;
 227     }
 228     if (ecmd.supported & SUPPORTED_10baseT_Full) {
 229         *supported |= OFPPF_10MB_FD;
 230     }
 231     if (ecmd.supported & SUPPORTED_100baseT_Half)  {
 232         *supported |= OFPPF_100MB_HD;
 233     }
 234     if (ecmd.supported & SUPPORTED_100baseT_Full) {
 235         *supported |= OFPPF_100MB_FD;
 236     }
 237     if (ecmd.supported & SUPPORTED_1000baseT_Half) {
 238         *supported |= OFPPF_1GB_HD;
 239     }
 240     if (ecmd.supported & SUPPORTED_1000baseT_Full) {
 241         *supported |= OFPPF_1GB_FD;
 242     }
 243     if (ecmd.supported & SUPPORTED_10000baseT_Full) {
 244         *supported |= OFPPF_10GB_FD;
 245     }
 246     if (ecmd.supported & SUPPORTED_TP) {
 247         *supported |= OFPPF_COPPER;
 248     }
 249     if (ecmd.supported & SUPPORTED_FIBRE) {
 250         *supported |= OFPPF_FIBER;
 251     }
 252     if (ecmd.supported & SUPPORTED_Autoneg) {
 253         *supported |= OFPPF_AUTONEG;
 254     }
 255     if (ecmd.supported & SUPPORTED_Pause) {
 256         *supported |= OFPPF_PAUSE;
 257     }
 258     if (ecmd.supported & SUPPORTED_Asym_Pause) {
 259         *supported |= OFPPF_PAUSE_ASYM;
 260     }
 261
 262     /* Set the advertised features */
 263     if (ecmd.advertising & ADVERTISED_10baseT_Half) {
 264         *advertised |= OFPPF_10MB_HD;
 265     }
 266     if (ecmd.advertising & ADVERTISED_10baseT_Full) {
 267         *advertised |= OFPPF_10MB_FD;
 268     }
 269     if (ecmd.advertising & ADVERTISED_100baseT_Half) {
 270         *advertised |= OFPPF_100MB_HD;
 271     }
 272     if (ecmd.advertising & ADVERTISED_100baseT_Full) {
 273         *advertised |= OFPPF_100MB_FD;
 274     }
 275     if (ecmd.advertising & ADVERTISED_1000baseT_Half) {
 276         *advertised |= OFPPF_1GB_HD;
 277     }
 278     if (ecmd.advertising & ADVERTISED_1000baseT_Full) {
 279         *advertised |= OFPPF_1GB_FD;
 280     }
 281     if (ecmd.advertising & ADVERTISED_10000baseT_Full) {
 282         *advertised |= OFPPF_10GB_FD;
 283     }
 284     if (ecmd.advertising & ADVERTISED_TP) {
 285         *advertised |= OFPPF_COPPER;
 286     }
 287     if (ecmd.advertising & ADVERTISED_FIBRE) {
 288         *advertised |= OFPPF_FIBER;
 289     }
 290     if (ecmd.advertising & ADVERTISED_Autoneg) {
 291         *advertised |= OFPPF_AUTONEG;
 292     }
 293     if (ecmd.advertising & ADVERTISED_Pause) {
 294         *advertised |= OFPPF_PAUSE;
 295     }
 296     if (ecmd.advertising & ADVERTISED_Asym_Pause) {
 297         *advertised |= OFPPF_PAUSE_ASYM;
 298     }
 299
 300     /* Set the current features */
 301     if (ecmd.speed == SPEED_10) {
 302         *current = (ecmd.duplex) ? OFPPF_10MB_FD : OFPPF_10MB_HD;
 303     }
 304     else if (ecmd.speed == SPEED_100) {
 305         *current = (ecmd.duplex) ? OFPPF_100MB_FD : OFPPF_100MB_HD;
 306     }
 307     else if (ecmd.speed == SPEED_1000) {
 308         *current = (ecmd.duplex) ? OFPPF_1GB_FD : OFPPF_1GB_HD;
 309     }
 310     else if (ecmd.speed == SPEED_10000) {
 311         *current = OFPPF_10GB_FD;
 312     }
 313
 314     if (ecmd.port == PORT_TP) {
 315         *current |= OFPPF_COPPER;
 316     }
 317     else if (ecmd.port == PORT_FIBRE) {
 318         *current |= OFPPF_FIBER;
 319     }
 320
 321     if (ecmd.autoneg) {
 322         *current |= OFPPF_AUTONEG;
 323     }
 324     return 0;
 325 }
 326
 327 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
 328  * successful, otherwise a positive errno value.  On success, sets '*netdevp'
 329  * to the new network device, otherwise to null.
 330  *
 331  * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
 332  * capture frames of that type received on the device.  It may also be one of
 333  * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
 334  * categories. */
 335 int
 336 netdev_open(const char *name, int ethertype, struct netdev **netdevp)
 337 {
 338     if (!strncmp(name, "tap:", 4)) {
 339         return netdev_open_tap(name + 4, netdevp);
 340     } else {
 341         return do_open_netdev(name, ethertype, -1, netdevp);
 342     }
 343 }
 344
 345 /* Opens a TAP virtual network device.  If 'name' is a nonnull, non-empty
 346  * string, attempts to assign that name to the TAP device (failing if the name
 347  * is already in use); otherwise, a name is automatically assigned.  Returns
 348  * zero if successful, otherwise a positive errno value.  On success, sets
 349  * '*netdevp' to the new network device, otherwise to null.  */
 350 int
 351 netdev_open_tap(const char *name, struct netdev **netdevp)
 352 {
 353     static const char tap_dev[] = "/dev/net/tun";
 354     struct ifreq ifr;
 355     int error;
 356     int tap_fd;
 357
 358     tap_fd = open(tap_dev, O_RDWR);
 359     if (tap_fd < 0) {
 360         ovs_error(errno, "opening \"%s\" failed", tap_dev);
 361         return errno;
 362     }
 363
 364     memset(&ifr, 0, sizeof ifr);
 365     ifr.ifr_flags = IFF_TAP | IFF_NO_PI;
 366     if (name) {
 367         strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
 368     }
 369     if (ioctl(tap_fd, TUNSETIFF, &ifr) < 0) {
 370         int error = errno;
 371         ovs_error(error, "ioctl(TUNSETIFF) on \"%s\" failed", tap_dev);
 372         close(tap_fd);
 373         return error;
 374     }
 375
 376     error = set_nonblocking(tap_fd);
 377     if (error) {
 378         ovs_error(error, "set_nonblocking on \"%s\" failed", tap_dev);
 379         close(tap_fd);
 380         return error;
 381     }
 382
 383     error = do_open_netdev(ifr.ifr_name, NETDEV_ETH_TYPE_NONE, tap_fd,
 384                            netdevp);
 385     if (error) {
 386         close(tap_fd);
 387     }
 388     return error;
 389 }
 390
 391 static int
 392 do_open_netdev(const char *name, int ethertype, int tap_fd,
 393                struct netdev **netdev_)
 394 {
 395     int netdev_fd;
 396     struct sockaddr_ll sll;
 397     struct ifreq ifr;
 398     int ifindex = -1;
 399     uint8_t etheraddr[ETH_ADDR_LEN];
 400     struct in6_addr in6;
 401     int mtu;
 402     int txqlen;
 403     int hwaddr_family;
 404     int error;
 405     struct netdev *netdev;
 406
 407     init_netdev();
 408     *netdev_ = NULL;
 409     COVERAGE_INC(netdev_open);
 410
 411     /* Create raw socket. */
 412     netdev_fd = socket(PF_PACKET, SOCK_RAW,
 413                        htons(ethertype == NETDEV_ETH_TYPE_NONE ? 0
 414                              : ethertype == NETDEV_ETH_TYPE_ANY ? ETH_P_ALL
 415                              : ethertype == NETDEV_ETH_TYPE_802_2 ? ETH_P_802_2
 416                              : ethertype));
 417     if (netdev_fd < 0) {
 418         return errno;
 419     }
 420
 421     if (ethertype != NETDEV_ETH_TYPE_NONE) {
 422         /* Set non-blocking mode. */
 423         error = set_nonblocking(netdev_fd);
 424         if (error) {
 425             goto error_already_set;
 426         }
 427
 428         /* Get ethernet device index. */
 429         ifindex = do_get_ifindex(name);
 430         if (ifindex < 0) {
 431             return -ifindex;
 432         }
 433
 434         /* Bind to specific ethernet device. */
 435         memset(&sll, 0, sizeof sll);
 436         sll.sll_family = AF_PACKET;
 437         sll.sll_ifindex = ifindex;
 438         if (bind(netdev_fd, (struct sockaddr *) &sll, sizeof sll) < 0) {
 439             VLOG_ERR("bind to %s failed: %s", name, strerror(errno));
 440             goto error;
 441         }
 442
 443         /* Between the socket() and bind() calls above, the socket receives all
 444          * packets of the requested type on all system interfaces.  We do not
 445          * want to receive that data, but there is no way to avoid it.  So we
 446          * must now drain out the receive queue. */
 447         error = drain_rcvbuf(netdev_fd);
 448         if (error) {
 449             goto error_already_set;
 450         }
 451     }
 452
 453     /* Get MAC address. */
 454     error = get_etheraddr(name, etheraddr, &hwaddr_family);
 455     if (error) {
 456         goto error_already_set;
 457     }
 458
 459     /* Get MTU. */
 460     strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
 461     if (ioctl(netdev_fd, SIOCGIFMTU, &ifr) < 0) {
 462         VLOG_ERR("ioctl(SIOCGIFMTU) on %s device failed: %s",
 463                  name, strerror(errno));
 464         goto error;
 465     }
 466     mtu = ifr.ifr_mtu;
 467
 468     /* Get TX queue length. */
 469     if (ioctl(netdev_fd, SIOCGIFTXQLEN, &ifr) < 0) {
 470         VLOG_ERR("ioctl(SIOCGIFTXQLEN) on %s device failed: %s",
 471                  name, strerror(errno));
 472         goto error;
 473     }
 474     txqlen = ifr.ifr_qlen;
 475
 476     get_ipv6_address(name, &in6);
 477
 478     /* Allocate network device. */
 479     netdev = xmalloc(sizeof *netdev);
 480     netdev->name = xstrdup(name);
 481     netdev->ifindex = ifindex;
 482     netdev->txqlen = txqlen;
 483     netdev->hwaddr_family = hwaddr_family;
 484     netdev->netdev_fd = netdev_fd;
 485     netdev->tap_fd = tap_fd < 0 ? netdev_fd : tap_fd;
 486     memcpy(netdev->etheraddr, etheraddr, sizeof etheraddr);
 487     netdev->mtu = mtu;
 488     netdev->in6 = in6;
 489
 490     /* Save flags to restore at close or exit. */
 491     error = get_flags(netdev->name, &netdev->save_flags);
 492     if (error) {
 493         goto error_already_set;
 494     }
 495     netdev->changed_flags = 0;
 496     fatal_signal_block();
 497     list_push_back(&netdev_list, &netdev->node);
 498     fatal_signal_unblock();
 499
 500     /* Success! */
 501     *netdev_ = netdev;
 502     return 0;
 503
 504 error:
 505     error = errno;
 506 error_already_set:
 507     close(netdev_fd);
 508     if (tap_fd >= 0) {
 509         close(tap_fd);
 510     }
 511     return error;
 512 }
 513
 514 /* Closes and destroys 'netdev'. */
 515 void
 516 netdev_close(struct netdev *netdev)
 517 {
 518     if (netdev) {
 519         /* Bring down interface and drop promiscuous mode, if we brought up
 520          * the interface or enabled promiscuous mode. */
 521         int error;
 522         fatal_signal_block();
 523         error = restore_flags(netdev);
 524         list_remove(&netdev->node);
 525         fatal_signal_unblock();
 526         if (error) {
 527             VLOG_WARN("failed to restore network device flags on %s: %s",
 528                       netdev->name, strerror(error));
 529         }
 530
 531         /* Free. */
 532         free(netdev->name);
 533         close(netdev->netdev_fd);
 534         if (netdev->netdev_fd != netdev->tap_fd) {
 535             close(netdev->tap_fd);
 536         }
 537         free(netdev);
 538     }
 539 }
 540
 541 /* Pads 'buffer' out with zero-bytes to the minimum valid length of an
 542  * Ethernet packet, if necessary.  */
 543 static void
 544 pad_to_minimum_length(struct ofpbuf *buffer)
 545 {
 546     if (buffer->size < ETH_TOTAL_MIN) {
 547         ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
 548     }
 549 }
 550
 551 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
 552  * must have initialized with sufficient room for the packet.  The space
 553  * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
 554  * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
 555  * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
 556  * need not be included.)
 557  *
 558  * If a packet is successfully retrieved, returns 0.  In this case 'buffer' is
 559  * guaranteed to contain at least ETH_TOTAL_MIN bytes.  Otherwise, returns a
 560  * positive errno value.  Returns EAGAIN immediately if no packet is ready to
 561  * be returned.
 562  */
 563 int
 564 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
 565 {
 566     ssize_t n_bytes;
 567
 568     assert(buffer->size == 0);
 569     assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
 570     do {
 571         n_bytes = read(netdev->tap_fd,
 572                        ofpbuf_tail(buffer), ofpbuf_tailroom(buffer));
 573     } while (n_bytes < 0 && errno == EINTR);
 574     if (n_bytes < 0) {
 575         if (errno != EAGAIN) {
 576             VLOG_WARN_RL(&rl, "error receiving Ethernet packet on %s: %s",
 577                          strerror(errno), netdev->name);
 578         }
 579         return errno;
 580     } else {
 581         COVERAGE_INC(netdev_received);
 582         buffer->size += n_bytes;
 583
 584         /* When the kernel internally sends out an Ethernet frame on an
 585          * interface, it gives us a copy *before* padding the frame to the
 586          * minimum length.  Thus, when it sends out something like an ARP
 587          * request, we see a too-short frame.  So pad it out to the minimum
 588          * length. */
 589         pad_to_minimum_length(buffer);
 590         return 0;
 591     }
 592 }
 593
 594 /* Registers with the poll loop to wake up from the next call to poll_block()
 595  * when a packet is ready to be received with netdev_recv() on 'netdev'. */
 596 void
 597 netdev_recv_wait(struct netdev *netdev)
 598 {
 599     poll_fd_wait(netdev->tap_fd, POLLIN);
 600 }
 601
 602 /* Discards all packets waiting to be received from 'netdev'. */
 603 int
 604 netdev_drain(struct netdev *netdev)
 605 {
 606     if (netdev->tap_fd != netdev->netdev_fd) {
 607         drain_fd(netdev->tap_fd, netdev->txqlen);
 608         return 0;
 609     } else {
 610         return drain_rcvbuf(netdev->netdev_fd);
 611     }
 612 }
 613
 614 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
 615  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
 616  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
 617  * the packet is too big or too small to transmit on the device.
 618  *
 619  * The caller retains ownership of 'buffer' in all cases.
 620  *
 621  * The kernel maintains a packet transmission queue, so the caller is not
 622  * expected to do additional queuing of packets. */
 623 int
 624 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
 625 {
 626     ssize_t n_bytes;
 627
 628     do {
 629         n_bytes = write(netdev->tap_fd, buffer->data, buffer->size);
 630     } while (n_bytes < 0 && errno == EINTR);
 631
 632     if (n_bytes < 0) {
 633         /* The Linux AF_PACKET implementation never blocks waiting for room
 634          * for packets, instead returning ENOBUFS.  Translate this into EAGAIN
 635          * for the caller. */
 636         if (errno == ENOBUFS) {
 637             return EAGAIN;
 638         } else if (errno != EAGAIN) {
 639             VLOG_WARN_RL(&rl, "error sending Ethernet packet on %s: %s",
 640                          netdev->name, strerror(errno));
 641         }
 642         return errno;
 643     } else if (n_bytes != buffer->size) {
 644         VLOG_WARN_RL(&rl,
 645                      "send partial Ethernet packet (%d bytes of %zu) on %s",
 646                      (int) n_bytes, buffer->size, netdev->name);
 647         return EMSGSIZE;
 648     } else {
 649         COVERAGE_INC(netdev_sent);
 650         return 0;
 651     }
 652 }
 653
 654 /* Registers with the poll loop to wake up from the next call to poll_block()
 655  * when the packet transmission queue has sufficient room to transmit a packet
 656  * with netdev_send().
 657  *
 658  * The kernel maintains a packet transmission queue, so the client is not
 659  * expected to do additional queuing of packets.  Thus, this function is
 660  * unlikely to ever be used.  It is included for completeness. */
 661 void
 662 netdev_send_wait(struct netdev *netdev)
 663 {
 664     if (netdev->tap_fd == netdev->netdev_fd) {
 665         poll_fd_wait(netdev->tap_fd, POLLOUT);
 666     } else {
 667         /* TAP device always accepts packets.*/
 668         poll_immediate_wake();
 669     }
 670 }
 671
 672 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
 673  * otherwise a positive errno value. */
 674 int
 675 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
 676 {
 677     int error = set_etheraddr(netdev->name, netdev->hwaddr_family, mac);
 678     if (!error) {
 679         memcpy(netdev->etheraddr, mac, ETH_ADDR_LEN);
 680     }
 681     return error;
 682 }
 683
 684 int
 685 netdev_nodev_set_etheraddr(const char *name, const uint8_t mac[ETH_ADDR_LEN])
 686 {
 687     init_netdev();
 688     return set_etheraddr(name, ARPHRD_ETHER, mac);
 689 }
 690
 691 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
 692  * the MAC address into 'mac'.  On failure, returns a positive errno value and
 693  * clears 'mac' to all-zeros. */
 694 int
 695 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
 696 {
 697     memcpy(mac, netdev->etheraddr, ETH_ADDR_LEN);
 698     return 0;
 699 }
 700
 701 /* Returns the name of the network device that 'netdev' represents,
 702  * e.g. "eth0".  The caller must not modify or free the returned string. */
 703 const char *
 704 netdev_get_name(const struct netdev *netdev)
 705 {
 706     return netdev->name;
 707 }
 708
 709 /* Returns the maximum size of transmitted (and received) packets on 'netdev',
 710  * in bytes, not including the hardware header; thus, this is typically 1500
 711  * bytes for Ethernet devices. */
 712 int
 713 netdev_get_mtu(const struct netdev *netdev)
 714 {
 715     return netdev->mtu;
 716 }
 717
 718 /* Stores the features supported by 'netdev' into each of '*current',
 719  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
 720  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
 721  * successful, otherwise a positive errno value.  On failure, all of the
 722  * passed-in values are set to 0. */
 723 int
 724 netdev_get_features(struct netdev *netdev,
 725                     uint32_t *current, uint32_t *advertised,
 726                     uint32_t *supported, uint32_t *peer)
 727 {
 728     uint32_t dummy[4];
 729     return do_get_features(netdev,
 730                            current ? current : &dummy[0],
 731                            advertised ? advertised : &dummy[1],
 732                            supported ? supported : &dummy[2],
 733                            peer ? peer : &dummy[3]);
 734 }
 735
 736 /* Set the features advertised by 'netdev' to 'advertise'. */
 737 int
 738 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
 739 {
 740     struct ethtool_cmd ecmd;
 741     int error;
 742
 743     memset(&ecmd, 0, sizeof ecmd);
 744     error = do_ethtool(netdev, &ecmd, ETHTOOL_GSET, "ETHTOOL_GSET");
 745     if (error) {
 746         return error;
 747     }
 748
 749     ecmd.advertising = 0;
 750     if (advertise & OFPPF_10MB_HD) {
 751         ecmd.advertising |= ADVERTISED_10baseT_Half;
 752     }
 753     if (advertise & OFPPF_10MB_FD) {
 754         ecmd.advertising |= ADVERTISED_10baseT_Full;
 755     }
 756     if (advertise & OFPPF_100MB_HD) {
 757         ecmd.advertising |= ADVERTISED_100baseT_Half;
 758     }
 759     if (advertise & OFPPF_100MB_FD) {
 760         ecmd.advertising |= ADVERTISED_100baseT_Full;
 761     }
 762     if (advertise & OFPPF_1GB_HD) {
 763         ecmd.advertising |= ADVERTISED_1000baseT_Half;
 764     }
 765     if (advertise & OFPPF_1GB_FD) {
 766         ecmd.advertising |= ADVERTISED_1000baseT_Full;
 767     }
 768     if (advertise & OFPPF_10GB_FD) {
 769         ecmd.advertising |= ADVERTISED_10000baseT_Full;
 770     }
 771     if (advertise & OFPPF_COPPER) {
 772         ecmd.advertising |= ADVERTISED_TP;
 773     }
 774     if (advertise & OFPPF_FIBER) {
 775         ecmd.advertising |= ADVERTISED_FIBRE;
 776     }
 777     if (advertise & OFPPF_AUTONEG) {
 778         ecmd.advertising |= ADVERTISED_Autoneg;
 779     }
 780     if (advertise & OFPPF_PAUSE) {
 781         ecmd.advertising |= ADVERTISED_Pause;
 782     }
 783     if (advertise & OFPPF_PAUSE_ASYM) {
 784         ecmd.advertising |= ADVERTISED_Asym_Pause;
 785     }
 786     return do_ethtool(netdev, &ecmd, ETHTOOL_SSET, "ETHTOOL_SSET");
 787 }
 788
 789 /* If 'netdev' has an assigned IPv4 address, sets '*in4' to that address (if
 790  * 'in4' is non-null) and returns true.  Otherwise, returns false. */
 791 bool
 792 netdev_nodev_get_in4(const char *netdev_name, struct in_addr *in4)
 793 {
 794     struct ifreq ifr;
 795     struct in_addr ip = { INADDR_ANY };
 796
 797     init_netdev();
 798
 799     strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
 800     ifr.ifr_addr.sa_family = AF_INET;
 801     COVERAGE_INC(netdev_get_in4);
 802     if (ioctl(af_inet_sock, SIOCGIFADDR, &ifr) == 0) {
 803         struct sockaddr_in *sin = (struct sockaddr_in *) &ifr.ifr_addr;
 804         ip = sin->sin_addr;
 805     } else {
 806         VLOG_DBG_RL(&rl, "%s: ioctl(SIOCGIFADDR) failed: %s",
 807                     netdev_name, strerror(errno));
 808     }
 809     if (in4) {
 810         *in4 = ip;
 811     }
 812     return ip.s_addr != INADDR_ANY;
 813 }
 814
 815 bool
 816 netdev_get_in4(const struct netdev *netdev, struct in_addr *in4)
 817 {
 818     return netdev_nodev_get_in4(netdev->name, in4);
 819 }
 820
 821 static void
 822 make_in4_sockaddr(struct sockaddr *sa, struct in_addr addr)
 823 {
 824     struct sockaddr_in sin;
 825     memset(&sin, 0, sizeof sin);
 826     sin.sin_family = AF_INET;
 827     sin.sin_addr = addr;
 828     sin.sin_port = 0;
 829
 830     memset(sa, 0, sizeof *sa);
 831     memcpy(sa, &sin, sizeof sin);
 832 }
 833
 834 static int
 835 do_set_addr(struct netdev *netdev, int sock,
 836             int ioctl_nr, const char *ioctl_name, struct in_addr addr)
 837 {
 838     struct ifreq ifr;
 839     int error;
 840
 841     strncpy(ifr.ifr_name, netdev->name, sizeof ifr.ifr_name);
 842     make_in4_sockaddr(&ifr.ifr_addr, addr);
 843     COVERAGE_INC(netdev_set_in4);
 844     error = ioctl(sock, ioctl_nr, &ifr) < 0 ? errno : 0;
 845     if (error) {
 846         VLOG_WARN("ioctl(%s): %s", ioctl_name, strerror(error));
 847     }
 848     return error;
 849 }
 850
 851 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 852  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
 853  * positive errno value. */
 854 int
 855 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
 856 {
 857     int error;
 858
 859     error = do_set_addr(netdev, af_inet_sock,
 860                         SIOCSIFADDR, "SIOCSIFADDR", addr);
 861     if (!error && addr.s_addr != INADDR_ANY) {
 862         error = do_set_addr(netdev, af_inet_sock,
 863                             SIOCSIFNETMASK, "SIOCSIFNETMASK", mask);
 864     }
 865     return error;
 866 }
 867
 868 /* Adds 'router' as a default IP gateway. */
 869 int
 870 netdev_add_router(struct in_addr router)
 871 {
 872     struct in_addr any = { INADDR_ANY };
 873     struct rtentry rt;
 874     int error;
 875
 876     memset(&rt, 0, sizeof rt);
 877     make_in4_sockaddr(&rt.rt_dst, any);
 878     make_in4_sockaddr(&rt.rt_gateway, router);
 879     make_in4_sockaddr(&rt.rt_genmask, any);
 880     rt.rt_flags = RTF_UP | RTF_GATEWAY;
 881     COVERAGE_INC(netdev_add_router);
 882     error = ioctl(af_inet_sock, SIOCADDRT, &rt) < 0 ? errno : 0;
 883     if (error) {
 884         VLOG_WARN("ioctl(SIOCADDRT): %s", strerror(error));
 885     }
 886     return error;
 887 }
 888
 889 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address (if
 890  * 'in6' is non-null) and returns true.  Otherwise, returns false. */
 891 bool
 892 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 893 {
 894     if (in6) {
 895         *in6 = netdev->in6;
 896     }
 897     return memcmp(&netdev->in6, &in6addr_any, sizeof netdev->in6) != 0;
 898 }
 899
 900 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 901  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 902  * stores 0 into '*flagsp'. */
 903 int
 904 netdev_get_flags(const struct netdev *netdev, enum netdev_flags *flagsp)
 905 {
 906     return netdev_nodev_get_flags(netdev->name, flagsp);
 907 }
 908
 909 static int
 910 nd_to_iff_flags(enum netdev_flags nd)
 911 {
 912     int iff = 0;
 913     if (nd & NETDEV_UP) {
 914         iff |= IFF_UP;
 915     }
 916     if (nd & NETDEV_PROMISC) {
 917         iff |= IFF_PROMISC;
 918     }
 919     return iff;
 920 }
 921
 922 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 923  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
 924  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
 925  * successful, otherwise a positive errno value. */
 926 static int
 927 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 928                 enum netdev_flags on, bool permanent)
 929 {
 930     int old_flags, new_flags;
 931     int error;
 932
 933     error = get_flags(netdev->name, &old_flags);
 934     if (error) {
 935         return error;
 936     }
 937
 938     new_flags = (old_flags & ~nd_to_iff_flags(off)) | nd_to_iff_flags(on);
 939     if (!permanent) {
 940         netdev->changed_flags |= new_flags ^ old_flags;
 941     }
 942     if (new_flags != old_flags) {
 943         error = set_flags(netdev->name, new_flags);
 944     }
 945     return error;
 946 }
 947
 948 /* Sets the flags for 'netdev' to 'flags'.
 949  * If 'permanent' is true, the changes will persist; otherwise, they
 950  * will be reverted when 'netdev' is closed or the program exits.
 951  * Returns 0 if successful, otherwise a positive errno value. */
 952 int
 953 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
 954                  bool permanent)
 955 {
 956     return do_update_flags(netdev, -1, flags, permanent);
 957 }
 958
 959 /* Turns on the specified 'flags' on 'netdev'.
 960  * If 'permanent' is true, the changes will persist; otherwise, they
 961  * will be reverted when 'netdev' is closed or the program exits.
 962  * Returns 0 if successful, otherwise a positive errno value. */
 963 int
 964 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
 965                      bool permanent)
 966 {
 967     return do_update_flags(netdev, 0, flags, permanent);
 968 }
 969
 970 /* Turns off the specified 'flags' on 'netdev'.
 971  * If 'permanent' is true, the changes will persist; otherwise, they
 972  * will be reverted when 'netdev' is closed or the program exits.
 973  * Returns 0 if successful, otherwise a positive errno value. */
 974 int
 975 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
 976                       bool permanent)
 977 {
 978     return do_update_flags(netdev, flags, 0, permanent);
 979 }
 980
 981 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
 982  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
 983  * returns 0.  Otherwise, it returns a positive errno value; in particular,
 984  * ENXIO indicates that there is not ARP table entry for 'ip' on 'netdev'. */
 985 int
 986 netdev_nodev_arp_lookup(const char *netdev_name, uint32_t ip,
 987                         uint8_t mac[ETH_ADDR_LEN])
 988 {
 989     struct arpreq r;
 990     struct sockaddr_in *pa;
 991     int retval;
 992
 993     init_netdev();
 994
 995     memset(&r, 0, sizeof r);
 996     pa = (struct sockaddr_in *) &r.arp_pa;
 997     pa->sin_family = AF_INET;
 998     pa->sin_addr.s_addr = ip;
 999     pa->sin_port = 0;
1000     r.arp_ha.sa_family = ARPHRD_ETHER;
1001     r.arp_flags = 0;
1002     strncpy(r.arp_dev, netdev_name, sizeof r.arp_dev);
1003     COVERAGE_INC(netdev_arp_lookup);
1004     retval = ioctl(af_inet_sock, SIOCGARP, &r) < 0 ? errno : 0;
1005     if (!retval) {
1006         memcpy(mac, r.arp_ha.sa_data, ETH_ADDR_LEN);
1007     } else if (retval != ENXIO) {
1008         VLOG_WARN_RL(&rl, "%s: could not look up ARP entry for "IP_FMT": %s",
1009                      netdev_name, IP_ARGS(&ip), strerror(retval));
1010     }
1011     return retval;
1012 }
1013
1014 int
1015 netdev_arp_lookup(const struct netdev *netdev, uint32_t ip,
1016                   uint8_t mac[ETH_ADDR_LEN])
1017 {
1018     return netdev_nodev_arp_lookup(netdev->name, ip, mac);
1019 }
1020
1021 static int
1022 get_stats_via_netlink(int ifindex, struct netdev_stats *stats)
1023 {
1024     struct ofpbuf request;
1025     struct ofpbuf *reply;
1026     struct ifinfomsg *ifi;
1027     const struct rtnl_link_stats *rtnl_stats;
1028     struct nlattr *attrs[ARRAY_SIZE(rtnlgrp_link_policy)];
1029     int error;
1030
1031     ofpbuf_init(&request, 0);
1032     nl_msg_put_nlmsghdr(&request, rtnl_sock, sizeof *ifi,
1033                         RTM_GETLINK, NLM_F_REQUEST);
1034     ifi = ofpbuf_put_zeros(&request, sizeof *ifi);
1035     ifi->ifi_family = PF_UNSPEC;
1036     ifi->ifi_index = ifindex;
1037     error = nl_sock_transact(rtnl_sock, &request, &reply);
1038     ofpbuf_uninit(&request);
1039     if (error) {
1040         return error;
1041     }
1042
1043     if (!nl_policy_parse(reply, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
1044                          rtnlgrp_link_policy,
1045                          attrs, ARRAY_SIZE(rtnlgrp_link_policy))) {
1046         ofpbuf_delete(reply);
1047         return EPROTO;
1048     }
1049
1050     if (!attrs[IFLA_STATS]) {
1051         VLOG_WARN_RL(&rl, "RTM_GETLINK reply lacks stats");
1052         return EPROTO;
1053     }
1054
1055     rtnl_stats = nl_attr_get(attrs[IFLA_STATS]);
1056     stats->rx_packets = rtnl_stats->rx_packets;
1057     stats->tx_packets = rtnl_stats->tx_packets;
1058     stats->rx_bytes = rtnl_stats->rx_bytes;
1059     stats->tx_bytes = rtnl_stats->tx_bytes;
1060     stats->rx_errors = rtnl_stats->rx_errors;
1061     stats->tx_errors = rtnl_stats->tx_errors;
1062     stats->rx_dropped = rtnl_stats->rx_dropped;
1063     stats->tx_dropped = rtnl_stats->tx_dropped;
1064     stats->multicast = rtnl_stats->multicast;
1065     stats->collisions = rtnl_stats->collisions;
1066     stats->rx_length_errors = rtnl_stats->rx_length_errors;
1067     stats->rx_over_errors = rtnl_stats->rx_over_errors;
1068     stats->rx_crc_errors = rtnl_stats->rx_crc_errors;
1069     stats->rx_frame_errors = rtnl_stats->rx_frame_errors;
1070     stats->rx_fifo_errors = rtnl_stats->rx_fifo_errors;
1071     stats->rx_missed_errors = rtnl_stats->rx_missed_errors;
1072     stats->tx_aborted_errors = rtnl_stats->tx_aborted_errors;
1073     stats->tx_carrier_errors = rtnl_stats->tx_carrier_errors;
1074     stats->tx_fifo_errors = rtnl_stats->tx_fifo_errors;
1075     stats->tx_heartbeat_errors = rtnl_stats->tx_heartbeat_errors;
1076     stats->tx_window_errors = rtnl_stats->tx_window_errors;
1077
1078     return 0;
1079 }
1080
1081 static int
1082 get_stats_via_proc(const char *netdev_name, struct netdev_stats *stats)
1083 {
1084     static const char fn[] = "/proc/net/dev";
1085     char line[1024];
1086     FILE *stream;
1087     int ln;
1088
1089     stream = fopen(fn, "r");
1090     if (!stream) {
1091         VLOG_WARN_RL(&rl, "%s: open failed: %s", fn, strerror(errno));
1092         return errno;
1093     }
1094
1095     ln = 0;
1096     while (fgets(line, sizeof line, stream)) {
1097         if (++ln >= 3) {
1098             char devname[16];
1099 #define X64 "%"SCNu64
1100             if (sscanf(line,
1101                        " %15[^:]:"
1102                        X64 X64 X64 X64 X64 X64 X64 "%*u"
1103                        X64 X64 X64 X64 X64 X64 X64 "%*u",
1104                        devname,
1105                        &stats->rx_bytes,
1106                        &stats->rx_packets,
1107                        &stats->rx_errors,
1108                        &stats->rx_dropped,
1109                        &stats->rx_fifo_errors,
1110                        &stats->rx_frame_errors,
1111                        &stats->multicast,
1112                        &stats->tx_bytes,
1113                        &stats->tx_packets,
1114                        &stats->tx_errors,
1115                        &stats->tx_dropped,
1116                        &stats->tx_fifo_errors,
1117                        &stats->collisions,
1118                        &stats->tx_carrier_errors) != 15) {
1119                 VLOG_WARN_RL(&rl, "%s:%d: parse error", fn, ln);
1120             } else if (!strcmp(devname, netdev_name)) {
1121                 stats->rx_length_errors = UINT64_MAX;
1122                 stats->rx_over_errors = UINT64_MAX;
1123                 stats->rx_crc_errors = UINT64_MAX;
1124                 stats->rx_missed_errors = UINT64_MAX;
1125                 stats->tx_aborted_errors = UINT64_MAX;
1126                 stats->tx_heartbeat_errors = UINT64_MAX;
1127                 stats->tx_window_errors = UINT64_MAX;
1128                 fclose(stream);
1129                 return 0;
1130             }
1131         }
1132     }
1133     VLOG_WARN_RL(&rl, "%s: no stats for %s", fn, netdev_name);
1134     fclose(stream);
1135     return ENODEV;
1136 }
1137
1138 /* Sets 'carrier' to true if carrier is active (link light is on) on
1139  * 'netdev'. */
1140 int
1141 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
1142 {
1143     return netdev_nodev_get_carrier(netdev->name, carrier);
1144 }
1145
1146 int
1147 netdev_nodev_get_carrier(const char *netdev_name, bool *carrier)
1148 {
1149     char line[8];
1150     int retval;
1151     int error;
1152     char *fn;
1153     int fd;
1154
1155     *carrier = false;
1156
1157     fn = xasprintf("/sys/class/net/%s/carrier", netdev_name);
1158     fd = open(fn, O_RDONLY);
1159     if (fd < 0) {
1160         error = errno;
1161         VLOG_WARN_RL(&rl, "%s: open failed: %s", fn, strerror(error));
1162         goto exit;
1163     }
1164
1165     retval = read(fd, line, sizeof line);
1166     if (retval < 0) {
1167         error = errno;
1168         if (error == EINVAL) {
1169             /* This is the normal return value when we try to check carrier if
1170              * the network device is not up. */
1171         } else {
1172             VLOG_WARN_RL(&rl, "%s: read failed: %s", fn, strerror(error));
1173         }
1174         goto exit_close;
1175     } else if (retval == 0) {
1176         error = EPROTO;
1177         VLOG_WARN_RL(&rl, "%s: unexpected end of file", fn);
1178         goto exit_close;
1179     }
1180
1181     if (line[0] != '0' && line[0] != '1') {
1182         error = EPROTO;
1183         VLOG_WARN_RL(&rl, "%s: value is %c (expected 0 or 1)", fn, line[0]);
1184         goto exit_close;
1185     }
1186     *carrier = line[0] != '0';
1187     error = 0;
1188
1189 exit_close:
1190     close(fd);
1191 exit:
1192     free(fn);
1193     return error;
1194 }
1195
1196 /* Retrieves current device stats for 'netdev'. */
1197 int
1198 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1199 {
1200     int error;
1201
1202     COVERAGE_INC(netdev_get_stats);
1203     if (use_netlink_stats) {
1204         int ifindex;
1205
1206         error = get_ifindex(netdev, &ifindex);
1207         if (!error) {
1208             error = get_stats_via_netlink(ifindex, stats);
1209         }
1210     } else {
1211         error = get_stats_via_proc(netdev->name, stats);
1212     }
1213
1214     if (error) {
1215         memset(stats, 0xff, sizeof *stats);
1216     }
1217     return error;
1218 }
1219
1220 #define POLICE_ADD_CMD "/sbin/tc qdisc add dev %s handle ffff: ingress"
1221 #define POLICE_CONFIG_CMD "/sbin/tc filter add dev %s parent ffff: protocol ip prio 50 u32 match ip src 0.0.0.0/0 police rate %dkbit burst %dk mtu 65535 drop flowid :1"
1222 /* We redirect stderr to /dev/null because we often want to remove all
1223  * traffic control configuration on a port so its in a known state.  If
1224  * this done when there is no such configuration, tc complains, so we just
1225  * always ignore it.
1226  */
1227 #define POLICE_DEL_CMD "/sbin/tc qdisc del dev %s handle ffff: ingress 2>/dev/null"
1228
1229 /* Attempts to set input rate limiting (policing) policy. */
1230 int
1231 netdev_nodev_set_policing(const char *netdev_name, uint32_t kbits_rate,
1232                           uint32_t kbits_burst)
1233 {
1234     char command[1024];
1235
1236     init_netdev();
1237
1238     COVERAGE_INC(netdev_set_policing);
1239     if (kbits_rate) {
1240         if (!kbits_burst) {
1241             /* Default to 10 kilobits if not specified. */
1242             kbits_burst = 10;
1243         }
1244
1245         /* xxx This should be more careful about only adding if it
1246          * xxx actually exists, as opposed to always deleting it. */
1247         snprintf(command, sizeof(command), POLICE_DEL_CMD, netdev_name);
1248         if (system(command) == -1) {
1249             VLOG_WARN_RL(&rl, "%s: problem removing policing", netdev_name);
1250         }
1251
1252         snprintf(command, sizeof(command), POLICE_ADD_CMD, netdev_name);
1253         if (system(command) != 0) {
1254             VLOG_WARN_RL(&rl, "%s: problem adding policing", netdev_name);
1255             return -1;
1256         }
1257
1258         snprintf(command, sizeof(command), POLICE_CONFIG_CMD, netdev_name,
1259                 kbits_rate, kbits_burst);
1260         if (system(command) != 0) {
1261             VLOG_WARN_RL(&rl, "%s: problem configuring policing",
1262                     netdev_name);
1263             return -1;
1264         }
1265     } else {
1266         snprintf(command, sizeof(command), POLICE_DEL_CMD, netdev_name);
1267         if (system(command) == -1) {
1268             VLOG_WARN_RL(&rl, "%s: problem removing policing", netdev_name);
1269         }
1270     }
1271
1272     return 0;
1273 }
1274
1275 int
1276 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1277                     uint32_t kbits_burst)
1278 {
1279     return netdev_nodev_set_policing(netdev->name, kbits_rate, kbits_burst);
1280 }
1281
1282 /* Initializes 'svec' with a list of the names of all known network devices. */
1283 void
1284 netdev_enumerate(struct svec *svec)
1285 {
1286     struct if_nameindex *names;
1287
1288     svec_init(svec);
1289     names = if_nameindex();
1290     if (names) {
1291         size_t i;
1292
1293         for (i = 0; names[i].if_name != NULL; i++) {
1294             svec_add(svec, names[i].if_name);
1295         }
1296         if_freenameindex(names);
1297     } else {
1298         VLOG_WARN("could not obtain list of network device names: %s",
1299                   strerror(errno));
1300     }
1301 }
1302
1303 /* Attempts to locate a device based on its IPv4 address.  The caller
1304  * may provide a hint as to the device by setting 'netdev_name' to a
1305  * likely device name.  This string must be malloc'd, since if it is
1306  * not correct then it will be freed.  If there is no hint, then
1307  * 'netdev_name' must be the NULL pointer.
1308  *
1309  * If the device is found, the return value will be true and 'netdev_name'
1310  * contains the device's name as a string, which the caller is responsible
1311  * for freeing.  If the device is not found, the return value is false. */
1312 bool
1313 netdev_find_dev_by_in4(const struct in_addr *in4, char **netdev_name)
1314 {
1315     int i;
1316     struct in_addr dev_in4;
1317     struct svec dev_list;
1318
1319     /* Check the hint first. */
1320     if (*netdev_name && (netdev_nodev_get_in4(*netdev_name, &dev_in4))
1321             && (dev_in4.s_addr == in4->s_addr)) {
1322         return true;
1323     }
1324
1325     free(*netdev_name);
1326     *netdev_name = NULL;
1327     netdev_enumerate(&dev_list);
1328
1329     for (i=0; i<dev_list.n; i++) {
1330         if ((netdev_nodev_get_in4(dev_list.names[i], &dev_in4))
1331                 && (dev_in4.s_addr == in4->s_addr)) {
1332             *netdev_name = xstrdup(dev_list.names[i]);
1333             svec_destroy(&dev_list);
1334             return true;
1335         }
1336     }
1337
1338     svec_destroy(&dev_list);
1339     return false;
1340 }
1341
1342 /* Obtains the current flags for the network device named 'netdev_name' and
1343  * stores them into '*flagsp'.  Returns 0 if successful, otherwise a positive
1344  * errno value.  On error, stores 0 into '*flagsp'.
1345  *
1346  * If only device flags are needed, this is more efficient than calling
1347  * netdev_open(), netdev_get_flags(), netdev_close(). */
1348 int
1349 netdev_nodev_get_flags(const char *netdev_name, enum netdev_flags *flagsp)
1350 {
1351     int error, flags;
1352
1353     init_netdev();
1354
1355     *flagsp = 0;
1356     error = get_flags(netdev_name, &flags);
1357     if (error) {
1358         return error;
1359     }
1360
1361     if (flags & IFF_UP) {
1362         *flagsp |= NETDEV_UP;
1363     }
1364     if (flags & IFF_PROMISC) {
1365         *flagsp |= NETDEV_PROMISC;
1366     }
1367     return 0;
1368 }
1369
1370 int
1371 netdev_nodev_get_etheraddr(const char *netdev_name, uint8_t mac[6])
1372 {
1373     init_netdev();
1374
1375     return get_etheraddr(netdev_name, mac, NULL);
1376 }
1377
1378 /* If 'netdev_name' is the name of a VLAN network device (e.g. one created with
1379  * vconfig(8)), sets '*vlan_vid' to the VLAN VID associated with that device
1380  * and returns 0.  Otherwise returns a errno value (specifically ENOENT if
1381  * 'netdev_name' is the name of a network device that is not a VLAN device) and
1382  * sets '*vlan_vid' to -1. */
1383 int
1384 netdev_get_vlan_vid(const char *netdev_name, int *vlan_vid)
1385 {
1386     struct ds line = DS_EMPTY_INITIALIZER;
1387     FILE *stream = NULL;
1388     int error;
1389     char *fn;
1390
1391     COVERAGE_INC(netdev_get_vlan_vid);
1392     fn = xasprintf("/proc/net/vlan/%s", netdev_name);
1393     stream = fopen(fn, "r");
1394     if (!stream) {
1395         error = errno;
1396         goto done;
1397     }
1398
1399     if (ds_get_line(&line, stream)) {
1400         if (ferror(stream)) {
1401             error = errno;
1402             VLOG_ERR_RL(&rl, "error reading \"%s\": %s", fn, strerror(errno));
1403         } else {
1404             error = EPROTO;
1405             VLOG_ERR_RL(&rl, "unexpected end of file reading \"%s\"", fn);
1406         }
1407         goto done;
1408     }
1409
1410     if (!sscanf(ds_cstr(&line), "%*s VID: %d", vlan_vid)) {
1411         error = EPROTO;
1412         VLOG_ERR_RL(&rl, "parse error reading \"%s\" line 1: \"%s\"",
1413                     fn, ds_cstr(&line));
1414         goto done;
1415     }
1416
1417     error = 0;
1418
1419 done:
1420     free(fn);
1421     if (stream) {
1422         fclose(stream);
1423     }
1424     ds_destroy(&line);
1425     if (error) {
1426         *vlan_vid = -1;
1427     }
1428     return error;
1429 }
1430 \f
1431 struct netdev_monitor {
1432     struct linux_netdev_notifier notifier;
1433     struct shash polled_netdevs;
1434     struct shash changed_netdevs;
1435 };
1436
1437 static void netdev_monitor_change(const struct linux_netdev_change *change,
1438                                   void *monitor);
1439
1440 int
1441 netdev_monitor_create(struct netdev_monitor **monitorp)
1442 {
1443     struct netdev_monitor *monitor;
1444     int error;
1445
1446     monitor = xmalloc(sizeof *monitor);
1447     error = linux_netdev_notifier_register(&monitor->notifier,
1448                                            netdev_monitor_change, monitor);
1449     if (error) {
1450         free(monitor);
1451         return error;
1452     }
1453     shash_init(&monitor->polled_netdevs);
1454     shash_init(&monitor->changed_netdevs);
1455     *monitorp = monitor;
1456     return 0;
1457 }
1458
1459 void
1460 netdev_monitor_destroy(struct netdev_monitor *monitor)
1461 {
1462     if (monitor) {
1463         linux_netdev_notifier_unregister(&monitor->notifier);
1464         shash_destroy(&monitor->polled_netdevs);
1465         free(monitor);
1466     }
1467 }
1468
1469 void
1470 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1471 {
1472     if (!shash_find(&monitor->polled_netdevs, netdev_get_name(netdev))) {
1473         shash_add(&monitor->polled_netdevs, netdev_get_name(netdev), NULL);
1474     }
1475 }
1476
1477 void
1478 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1479 {
1480     struct shash_node *node;
1481
1482     node = shash_find(&monitor->polled_netdevs, netdev_get_name(netdev));
1483     if (node) {
1484         shash_delete(&monitor->polled_netdevs, node);
1485         node = shash_find(&monitor->changed_netdevs, netdev_get_name(netdev));
1486         if (node) {
1487             shash_delete(&monitor->changed_netdevs, node);
1488         }
1489     }
1490 }
1491
1492 int
1493 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1494 {
1495     int error = linux_netdev_notifier_get_error(&monitor->notifier);
1496     *devnamep = NULL;
1497     if (!error) {
1498         struct shash_node *node = shash_first(&monitor->changed_netdevs);
1499         if (!node) {
1500             return EAGAIN;
1501         }
1502         *devnamep = xstrdup(node->name);
1503         shash_delete(&monitor->changed_netdevs, node);
1504     } else {
1505         shash_clear(&monitor->changed_netdevs);
1506     }
1507     return error;
1508 }
1509
1510 void
1511 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1512 {
1513     if (!shash_is_empty(&monitor->changed_netdevs)
1514         || linux_netdev_notifier_peek_error(&monitor->notifier)) {
1515         poll_immediate_wake();
1516     } else {
1517         linux_netdev_notifier_wait();
1518     }
1519 }
1520
1521 static void
1522 netdev_monitor_change(const struct linux_netdev_change *change, void *monitor_)
1523 {
1524     struct netdev_monitor *monitor = monitor_;
1525     if (shash_find(&monitor->polled_netdevs, change->ifname)
1526         && !shash_find(&monitor->changed_netdevs, change->ifname)) {
1527         shash_add(&monitor->changed_netdevs, change->ifname, NULL);
1528     }
1529 }
1530 \f
1531 static void restore_all_flags(void *aux);
1532
1533 /* Set up a signal hook to restore network device flags on program
1534  * termination.  */
1535 static void
1536 init_netdev(void)
1537 {
1538     static bool inited;
1539     if (!inited) {
1540         int ifindex;
1541         int error;
1542
1543         inited = true;
1544
1545         fatal_signal_add_hook(restore_all_flags, NULL, true);
1546
1547         af_inet_sock = socket(AF_INET, SOCK_DGRAM, 0);
1548         if (af_inet_sock < 0) {
1549             ovs_fatal(errno, "socket(AF_INET)");
1550         }
1551
1552         error = nl_sock_create(NETLINK_ROUTE, 0, 0, 0, &rtnl_sock);
1553         if (error) {
1554             ovs_fatal(error, "socket(AF_NETLINK, NETLINK_ROUTE)");
1555         }
1556
1557         /* Decide on the netdev_get_stats() implementation to use.  Netlink is
1558          * preferable, so if that works, we'll use it. */
1559         ifindex = do_get_ifindex("lo");
1560         if (ifindex < 0) {
1561             VLOG_WARN("failed to get ifindex for lo, "
1562                       "obtaining netdev stats from proc");
1563             use_netlink_stats = false;
1564         } else {
1565             struct netdev_stats stats;
1566             error = get_stats_via_netlink(ifindex, &stats);
1567             if (!error) {
1568                 VLOG_DBG("obtaining netdev stats via rtnetlink");
1569                 use_netlink_stats = true;
1570             } else {
1571                 VLOG_INFO("RTM_GETLINK failed (%s), obtaining netdev stats "
1572                           "via proc (you are probably running a pre-2.6.19 "
1573                           "kernel)", strerror(error));
1574                 use_netlink_stats = false;
1575             }
1576         }
1577     }
1578 }
1579
1580 /* Restore the network device flags on 'netdev' to those that were active
1581  * before we changed them.  Returns 0 if successful, otherwise a positive
1582  * errno value.
1583  *
1584  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1585 static int
1586 restore_flags(struct netdev *netdev)
1587 {
1588     struct ifreq ifr;
1589     int restore_flags;
1590
1591     /* Get current flags. */
1592     strncpy(ifr.ifr_name, netdev->name, sizeof ifr.ifr_name);
1593     COVERAGE_INC(netdev_get_flags);
1594     if (ioctl(netdev->netdev_fd, SIOCGIFFLAGS, &ifr) < 0) {
1595         return errno;
1596     }
1597
1598     /* Restore flags that we might have changed, if necessary. */
1599     restore_flags = netdev->changed_flags & (IFF_PROMISC | IFF_UP);
1600     if ((ifr.ifr_flags ^ netdev->save_flags) & restore_flags) {
1601         ifr.ifr_flags &= ~restore_flags;
1602         ifr.ifr_flags |= netdev->save_flags & restore_flags;
1603         COVERAGE_INC(netdev_set_flags);
1604         if (ioctl(netdev->netdev_fd, SIOCSIFFLAGS, &ifr) < 0) {
1605             return errno;
1606         }
1607     }
1608
1609     return 0;
1610 }
1611
1612 /* Retores all the flags on all network devices that we modified.  Called from
1613  * a signal handler, so it does not attempt to report error conditions. */
1614 static void
1615 restore_all_flags(void *aux UNUSED)
1616 {
1617     struct netdev *netdev;
1618     LIST_FOR_EACH (netdev, struct netdev, node, &netdev_list) {
1619         restore_flags(netdev);
1620     }
1621 }
1622
1623 static int
1624 get_flags(const char *netdev_name, int *flags)
1625 {
1626     struct ifreq ifr;
1627     strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
1628     COVERAGE_INC(netdev_get_flags);
1629     if (ioctl(af_inet_sock, SIOCGIFFLAGS, &ifr) < 0) {
1630         VLOG_ERR("ioctl(SIOCGIFFLAGS) on %s device failed: %s",
1631                  netdev_name, strerror(errno));
1632         return errno;
1633     }
1634     *flags = ifr.ifr_flags;
1635     return 0;
1636 }
1637
1638 static int
1639 set_flags(const char *netdev_name, int flags)
1640 {
1641     struct ifreq ifr;
1642     strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
1643     ifr.ifr_flags = flags;
1644     COVERAGE_INC(netdev_set_flags);
1645     if (ioctl(af_inet_sock, SIOCSIFFLAGS, &ifr) < 0) {
1646         VLOG_ERR("ioctl(SIOCSIFFLAGS) on %s device failed: %s",
1647                  netdev_name, strerror(errno));
1648         return errno;
1649     }
1650     return 0;
1651 }
1652
1653 static int
1654 do_get_ifindex(const char *netdev_name)
1655 {
1656     struct ifreq ifr;
1657
1658     strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
1659     COVERAGE_INC(netdev_get_ifindex);
1660     if (ioctl(af_inet_sock, SIOCGIFINDEX, &ifr) < 0) {
1661         VLOG_WARN_RL(&rl, "ioctl(SIOCGIFINDEX) on %s device failed: %s",
1662                      netdev_name, strerror(errno));
1663         return -errno;
1664     }
1665     return ifr.ifr_ifindex;
1666 }
1667
1668 static int
1669 get_ifindex(const struct netdev *netdev, int *ifindexp)
1670 {
1671     *ifindexp = 0;
1672     if (netdev->ifindex < 0) {
1673         int ifindex = do_get_ifindex(netdev->name);
1674         if (ifindex < 0) {
1675             return -ifindex;
1676         }
1677         ((struct netdev *) netdev)->ifindex = ifindex;
1678     }
1679     *ifindexp = netdev->ifindex;
1680     return 0;
1681 }
1682
1683 static int
1684 get_etheraddr(const char *netdev_name, uint8_t ea[ETH_ADDR_LEN],
1685               int *hwaddr_familyp)
1686 {
1687     struct ifreq ifr;
1688
1689     memset(&ifr, 0, sizeof ifr);
1690     strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
1691     COVERAGE_INC(netdev_get_hwaddr);
1692     if (ioctl(af_inet_sock, SIOCGIFHWADDR, &ifr) < 0) {
1693         VLOG_ERR("ioctl(SIOCGIFHWADDR) on %s device failed: %s",
1694                  netdev_name, strerror(errno));
1695         return errno;
1696     }
1697     if (hwaddr_familyp) {
1698         int hwaddr_family = ifr.ifr_hwaddr.sa_family;
1699         *hwaddr_familyp = hwaddr_family;
1700         if (hwaddr_family != AF_UNSPEC && hwaddr_family != ARPHRD_ETHER) {
1701             VLOG_WARN("%s device has unknown hardware address family %d",
1702                       netdev_name, hwaddr_family);
1703         }
1704     }
1705     memcpy(ea, ifr.ifr_hwaddr.sa_data, ETH_ADDR_LEN);
1706     return 0;
1707 }
1708
1709 static int
1710 set_etheraddr(const char *netdev_name, int hwaddr_family,
1711               const uint8_t mac[ETH_ADDR_LEN])
1712 {
1713     struct ifreq ifr;
1714
1715     memset(&ifr, 0, sizeof ifr);
1716     strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
1717     ifr.ifr_hwaddr.sa_family = hwaddr_family;
1718     memcpy(ifr.ifr_hwaddr.sa_data, mac, ETH_ADDR_LEN);
1719     COVERAGE_INC(netdev_set_hwaddr);
1720     if (ioctl(af_inet_sock, SIOCSIFHWADDR, &ifr) < 0) {
1721         VLOG_ERR("ioctl(SIOCSIFHWADDR) on %s device failed: %s",
1722                  netdev_name, strerror(errno));
1723         return errno;
1724     }
1725     return 0;
1726 }