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