2 * Copyright (c) 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <arpa/inet.h>
23 #include <linux/if_tun.h>
25 #include <linux/types.h>
26 #include <linux/ethtool.h>
27 #include <linux/rtnetlink.h>
28 #include <linux/sockios.h>
29 #include <linux/version.h>
30 #include <sys/types.h>
31 #include <sys/ioctl.h>
32 #include <sys/socket.h>
33 #include <netpacket/packet.h>
34 #include <net/ethernet.h>
36 #include <linux/if_tunnel.h>
37 #include <net/if_arp.h>
38 #include <net/if_packet.h>
39 #include <net/route.h>
40 #include <netinet/in.h>
47 #include "dynamic-string.h"
48 #include "fatal-signal.h"
49 #include "netdev-provider.h"
52 #include "openflow/openflow.h"
53 #include "openvswitch/gre.h"
55 #include "poll-loop.h"
56 #include "rtnetlink.h"
57 #include "socket-util.h"
61 #ifndef GRE_IOCTL_ONLY
62 #include <linux/if_link.h>
65 #define THIS_MODULE VLM_netdev_linux
68 /* These were introduced in Linux 2.6.14, so they might be missing if we have
70 #ifndef ADVERTISED_Pause
71 #define ADVERTISED_Pause (1 << 13)
73 #ifndef ADVERTISED_Asym_Pause
74 #define ADVERTISED_Asym_Pause (1 << 14)
77 static struct rtnetlink_notifier netdev_linux_cache_notifier;
78 static int cache_notifier_refcount;
81 VALID_IFINDEX = 1 << 0,
82 VALID_ETHERADDR = 1 << 1,
86 VALID_CARRIER = 1 << 5,
87 VALID_IS_INTERNAL = 1 << 6
94 struct netdev_dev_linux {
95 struct netdev_dev netdev_dev;
97 struct shash_node *shash_node;
98 unsigned int cache_valid;
101 uint8_t etheraddr[ETH_ADDR_LEN];
102 struct in_addr address, netmask;
109 struct tap_state tap;
113 struct netdev_linux {
114 struct netdev netdev;
118 /* An AF_INET socket (used for ioctl operations). */
119 static int af_inet_sock = -1;
134 struct nl_sock *nl_sock;
140 struct netdev_linux_notifier {
141 struct netdev_notifier notifier;
145 static struct shash netdev_linux_notifiers =
146 SHASH_INITIALIZER(&netdev_linux_notifiers);
147 static struct rtnetlink_notifier netdev_linux_poll_notifier;
149 /* This is set pretty low because we probably won't learn anything from the
150 * additional log messages. */
151 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
153 static int destroy_gre(const char *name);
154 static int netdev_linux_do_ethtool(const char *name, struct ethtool_cmd *,
155 int cmd, const char *cmd_name);
156 static int netdev_linux_do_ioctl(const char *name, struct ifreq *, int cmd,
157 const char *cmd_name);
158 static int netdev_linux_get_ipv4(const struct netdev *, struct in_addr *,
159 int cmd, const char *cmd_name);
160 static int get_flags(const struct netdev *, int *flagsp);
161 static int set_flags(struct netdev *, int flags);
162 static int do_get_ifindex(const char *netdev_name);
163 static int get_ifindex(const struct netdev *, int *ifindexp);
164 static int do_set_addr(struct netdev *netdev,
165 int ioctl_nr, const char *ioctl_name,
166 struct in_addr addr);
167 static int get_etheraddr(const char *netdev_name, uint8_t ea[ETH_ADDR_LEN]);
168 static int set_etheraddr(const char *netdev_name, int hwaddr_family,
169 const uint8_t[ETH_ADDR_LEN]);
170 static int get_stats_via_netlink(int ifindex, struct netdev_stats *stats);
171 static int get_stats_via_proc(const char *netdev_name, struct netdev_stats *stats);
173 static struct netdev_dev_linux *
174 netdev_dev_linux_cast(const struct netdev_dev *netdev_dev)
176 const char *type = netdev_dev_get_type(netdev_dev);
177 assert(!strcmp(type, "system") || !strcmp(type, "tap")
178 || !strcmp(type, "gre"));
179 return CONTAINER_OF(netdev_dev, struct netdev_dev_linux, netdev_dev);
182 static struct netdev_linux *
183 netdev_linux_cast(const struct netdev *netdev)
185 const char *type = netdev_get_type(netdev);
186 assert(!strcmp(type, "system") || !strcmp(type, "tap")
187 || !strcmp(type, "gre"));
188 return CONTAINER_OF(netdev, struct netdev_linux, netdev);
192 netdev_linux_init(void)
194 static int status = -1;
196 af_inet_sock = socket(AF_INET, SOCK_DGRAM, 0);
197 status = af_inet_sock >= 0 ? 0 : errno;
199 VLOG_ERR("failed to create inet socket: %s", strerror(status));
206 netdev_linux_run(void)
208 rtnetlink_notifier_run();
212 netdev_linux_wait(void)
214 rtnetlink_notifier_wait();
218 netdev_linux_cache_cb(const struct rtnetlink_change *change,
219 void *aux OVS_UNUSED)
221 struct netdev_dev_linux *dev;
223 struct netdev_dev *base_dev = netdev_dev_from_name(change->ifname);
225 dev = netdev_dev_linux_cast(base_dev);
226 dev->cache_valid = 0;
229 struct shash device_shash;
230 struct shash_node *node;
232 shash_init(&device_shash);
233 netdev_dev_get_devices(&netdev_linux_class, &device_shash);
234 SHASH_FOR_EACH (node, &device_shash) {
236 dev->cache_valid = 0;
238 shash_destroy(&device_shash);
242 /* The arguments are marked as unused to prevent warnings on platforms where
243 * the Netlink interface isn't supported. */
245 setup_gre_netlink(const char *name OVS_UNUSED,
246 struct gre_config *config OVS_UNUSED, bool create OVS_UNUSED)
248 #ifdef GRE_IOCTL_ONLY
252 struct ofpbuf request, *reply;
253 unsigned int nl_flags;
254 struct ifinfomsg ifinfomsg;
255 struct nlattr *linkinfo_hdr;
256 struct nlattr *info_data_hdr;
259 uint8_t pmtudisc = 0;
261 VLOG_DBG("%s: attempting to create gre device using netlink", name);
263 if (!gre_descriptors.nl_sock) {
264 error = nl_sock_create(NETLINK_ROUTE, 0, 0, 0,
265 &gre_descriptors.nl_sock);
267 VLOG_WARN("couldn't create netlink socket: %s", strerror(error));
272 ofpbuf_init(&request, 0);
274 nl_flags = NLM_F_REQUEST;
276 nl_flags |= NLM_F_CREATE|NLM_F_EXCL;
279 /* We over-reserve space, because we do some pointer arithmetic
280 * and don't want the buffer address shifting under us. */
281 nl_msg_put_nlmsghdr(&request, gre_descriptors.nl_sock, 2048, RTM_NEWLINK,
284 memset(&ifinfomsg, 0, sizeof ifinfomsg);
285 ifinfomsg.ifi_family = AF_UNSPEC;
286 nl_msg_put(&request, &ifinfomsg, sizeof ifinfomsg);
288 linkinfo_hdr = ofpbuf_tail(&request);
289 nl_msg_put_unspec(&request, IFLA_LINKINFO, NULL, 0);
291 nl_msg_put_unspec(&request, IFLA_INFO_KIND, "gretap", 6);
293 info_data_hdr = ofpbuf_tail(&request);
294 nl_msg_put_unspec(&request, IFLA_INFO_DATA, NULL, 0);
297 if (config->have_in_key) {
300 if (config->have_out_key) {
304 if (config->in_csum) {
307 if (config->out_csum) {
312 nl_msg_put_u32(&request, IFLA_GRE_IKEY, config->in_key);
313 nl_msg_put_u32(&request, IFLA_GRE_OKEY, config->out_key);
314 nl_msg_put_u16(&request, IFLA_GRE_IFLAGS, iflags);
315 nl_msg_put_u16(&request, IFLA_GRE_OFLAGS, oflags);
316 nl_msg_put_u32(&request, IFLA_GRE_LOCAL, config->local_ip);
317 nl_msg_put_u32(&request, IFLA_GRE_REMOTE, config->remote_ip);
318 nl_msg_put_u8(&request, IFLA_GRE_PMTUDISC, pmtudisc);
319 nl_msg_put_u8(&request, IFLA_GRE_TTL, IPDEFTTL);
320 nl_msg_put_u8(&request, IFLA_GRE_TOS, 0);
322 info_data_hdr->nla_len = (char *)ofpbuf_tail(&request)
323 - (char *)info_data_hdr;
324 linkinfo_hdr->nla_len = (char *)ofpbuf_tail(&request)
325 - (char *)linkinfo_hdr;
327 nl_msg_put_string(&request, IFLA_IFNAME, name);
329 error = nl_sock_transact(gre_descriptors.nl_sock, &request, &reply);
330 ofpbuf_uninit(&request);
332 VLOG_WARN("couldn't transact netlink socket: %s", strerror(error));
335 ofpbuf_delete(reply);
343 setup_gre_ioctl(const char *name, struct gre_config *config, bool create)
345 struct ip_tunnel_parm p;
348 VLOG_DBG("%s: attempting to create gre device using ioctl", name);
350 memset(&p, 0, sizeof p);
352 strncpy(p.name, name, IFNAMSIZ);
356 p.iph.protocol = IPPROTO_GRE;
357 p.iph.saddr = config->local_ip;
358 p.iph.daddr = config->remote_ip;
359 p.iph.ttl = IPDEFTTL;
361 if (config->have_in_key) {
362 p.i_flags |= GRE_KEY;
363 p.i_key = config->in_key;
365 if (config->have_out_key) {
366 p.o_flags |= GRE_KEY;
367 p.o_key = config->out_key;
370 if (config->in_csum) {
371 p.i_flags |= GRE_CSUM;
373 if (config->out_csum) {
374 p.o_flags |= GRE_CSUM;
377 strncpy(ifr.ifr_name, create ? GRE_IOCTL_DEVICE : name, IFNAMSIZ);
378 ifr.ifr_ifru.ifru_data = (void *)&p;
380 if (!gre_descriptors.ioctl_fd) {
381 gre_descriptors.ioctl_fd = socket(AF_INET, SOCK_DGRAM, 0);
382 if (gre_descriptors.ioctl_fd < 0) {
383 VLOG_WARN("couldn't create gre ioctl socket: %s", strerror(errno));
384 gre_descriptors.ioctl_fd = 0;
389 if (ioctl(gre_descriptors.ioctl_fd, create ? SIOCADDGRETAP : SIOCCHGGRETAP,
391 VLOG_WARN("couldn't do gre ioctl: %s", strerror(errno));
398 /* The arguments are marked as unused to prevent warnings on platforms where
399 * the Netlink interface isn't supported. */
401 check_gre_device_netlink(const char *name OVS_UNUSED)
403 #ifdef GRE_IOCTL_ONLY
406 static const struct nl_policy getlink_policy[] = {
407 [IFLA_LINKINFO] = { .type = NL_A_NESTED, .optional = false },
410 static const struct nl_policy linkinfo_policy[] = {
411 [IFLA_INFO_KIND] = { .type = NL_A_STRING, .optional = false },
416 struct ofpbuf request, *reply;
417 struct ifinfomsg ifinfomsg;
418 struct nlattr *getlink_attrs[ARRAY_SIZE(getlink_policy)];
419 struct nlattr *linkinfo_attrs[ARRAY_SIZE(linkinfo_policy)];
420 struct ofpbuf linkinfo;
421 const char *device_kind;
423 ofpbuf_init(&request, 0);
425 nl_msg_put_nlmsghdr(&request, gre_descriptors.nl_sock,
426 NLMSG_LENGTH(sizeof ifinfomsg), RTM_GETLINK,
429 memset(&ifinfomsg, 0, sizeof ifinfomsg);
430 ifinfomsg.ifi_family = AF_UNSPEC;
431 ifinfomsg.ifi_index = do_get_ifindex(name);
432 nl_msg_put(&request, &ifinfomsg, sizeof ifinfomsg);
434 error = nl_sock_transact(gre_descriptors.nl_sock, &request, &reply);
435 ofpbuf_uninit(&request);
437 VLOG_WARN("couldn't transact netlink socket: %s", strerror(error));
441 if (!nl_policy_parse(reply, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
442 getlink_policy, getlink_attrs,
443 ARRAY_SIZE(getlink_policy))) {
444 VLOG_WARN("received bad rtnl message (getlink policy)");
448 linkinfo.data = (void *)nl_attr_get(getlink_attrs[IFLA_LINKINFO]);
449 linkinfo.size = nl_attr_get_size(getlink_attrs[IFLA_LINKINFO]);
450 if (!nl_policy_parse(&linkinfo, 0, linkinfo_policy,
451 linkinfo_attrs, ARRAY_SIZE(linkinfo_policy))) {
452 VLOG_WARN("received bad rtnl message (linkinfo policy)");
456 device_kind = nl_attr_get_string(linkinfo_attrs[IFLA_INFO_KIND]);
457 ret = !strcmp(device_kind, "gretap");
460 ofpbuf_delete(reply);
466 check_gre_device_ioctl(const char *name)
468 struct ethtool_drvinfo drvinfo;
471 memset(&drvinfo, 0, sizeof drvinfo);
472 error = netdev_linux_do_ethtool(name, (struct ethtool_cmd *)&drvinfo,
473 ETHTOOL_GDRVINFO, "ETHTOOL_GDRVINFO");
475 return !error && !strcmp(drvinfo.driver, "ip_gre")
476 && !strcmp(drvinfo.bus_info, "gretap");
480 setup_gre(const char *name, const struct shash *args, bool create)
483 struct in_addr in_addr;
484 struct shash_node *node;
485 struct gre_config config;
487 memset(&config, 0, sizeof config);
488 config.in_csum = true;
489 config.out_csum = true;
491 SHASH_FOR_EACH (node, args) {
492 if (!strcmp(node->name, "remote_ip")) {
493 if (lookup_ip(node->data, &in_addr)) {
494 VLOG_WARN("bad 'remote_ip' for gre device %s ", name);
496 config.remote_ip = in_addr.s_addr;
498 } else if (!strcmp(node->name, "local_ip")) {
499 if (lookup_ip(node->data, &in_addr)) {
500 VLOG_WARN("bad 'local_ip' for gre device %s ", name);
502 config.local_ip = in_addr.s_addr;
504 } else if (!strcmp(node->name, "key")) {
505 config.have_in_key = true;
506 config.have_out_key = true;
507 config.in_key = htonl(atoi(node->data));
508 config.out_key = htonl(atoi(node->data));
509 } else if (!strcmp(node->name, "in_key")) {
510 config.have_in_key = true;
511 config.in_key = htonl(atoi(node->data));
512 } else if (!strcmp(node->name, "out_key")) {
513 config.have_out_key = true;
514 config.out_key = htonl(atoi(node->data));
515 } else if (!strcmp(node->name, "csum")) {
516 if (!strcmp(node->data, "false")) {
517 config.in_csum = false;
518 config.out_csum = false;
521 VLOG_WARN("unknown gre argument '%s'", node->name);
525 if (!config.remote_ip) {
526 VLOG_WARN("gre type requires valid 'remote_ip' argument");
531 if (!gre_descriptors.use_ioctl) {
532 error = setup_gre_netlink(name, &config, create);
533 if (error == EOPNOTSUPP) {
534 gre_descriptors.use_ioctl = true;
537 if (gre_descriptors.use_ioctl) {
538 error = setup_gre_ioctl(name, &config, create);
541 if (create && error == EEXIST) {
544 if (gre_descriptors.use_ioctl) {
545 gre_device = check_gre_device_ioctl(name);
547 gre_device = check_gre_device_netlink(name);
554 VLOG_WARN("replacing existing gre device %s", name);
555 error = destroy_gre(name);
560 if (gre_descriptors.use_ioctl) {
561 error = setup_gre_ioctl(name, &config, create);
563 error = setup_gre_netlink(name, &config, create);
571 /* Creates the netdev device of 'type' with 'name'. */
573 netdev_linux_create_system(const char *name, const char *type OVS_UNUSED,
574 const struct shash *args, struct netdev_dev **netdev_devp)
576 struct netdev_dev_linux *netdev_dev;
579 if (!shash_is_empty(args)) {
580 VLOG_WARN("%s: arguments for system devices should be empty", name);
583 if (!cache_notifier_refcount) {
584 error = rtnetlink_notifier_register(&netdev_linux_cache_notifier,
585 netdev_linux_cache_cb, NULL);
590 cache_notifier_refcount++;
592 netdev_dev = xzalloc(sizeof *netdev_dev);
593 netdev_dev_init(&netdev_dev->netdev_dev, name, &netdev_linux_class);
595 *netdev_devp = &netdev_dev->netdev_dev;
599 /* For most types of netdevs we open the device for each call of
600 * netdev_open(). However, this is not the case with tap devices,
601 * since it is only possible to open the device once. In this
602 * situation we share a single file descriptor, and consequently
603 * buffers, across all readers. Therefore once data is read it will
604 * be unavailable to other reads for tap devices. */
606 netdev_linux_create_tap(const char *name, const char *type OVS_UNUSED,
607 const struct shash *args, struct netdev_dev **netdev_devp)
609 struct netdev_dev_linux *netdev_dev;
610 struct tap_state *state;
611 static const char tap_dev[] = "/dev/net/tun";
615 if (!shash_is_empty(args)) {
616 VLOG_WARN("%s: arguments for TAP devices should be empty", name);
619 netdev_dev = xzalloc(sizeof *netdev_dev);
620 state = &netdev_dev->state.tap;
622 /* Open tap device. */
623 state->fd = open(tap_dev, O_RDWR);
626 VLOG_WARN("opening \"%s\" failed: %s", tap_dev, strerror(error));
630 /* Create tap device. */
631 ifr.ifr_flags = IFF_TAP | IFF_NO_PI;
632 strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
633 if (ioctl(state->fd, TUNSETIFF, &ifr) == -1) {
634 VLOG_WARN("%s: creating tap device failed: %s", name,
640 /* Make non-blocking. */
641 error = set_nonblocking(state->fd);
646 netdev_dev_init(&netdev_dev->netdev_dev, name, &netdev_tap_class);
647 *netdev_devp = &netdev_dev->netdev_dev;
656 if_up(const char *name)
660 strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
661 ifr.ifr_flags = IFF_UP;
663 if (ioctl(af_inet_sock, SIOCSIFFLAGS, &ifr) == -1) {
664 VLOG_DBG_RL(&rl, "%s: failed to bring device up: %s",
665 name, strerror(errno));
673 netdev_linux_create_gre(const char *name, const char *type OVS_UNUSED,
674 const struct shash *args, struct netdev_dev **netdev_devp)
676 struct netdev_dev_linux *netdev_dev;
679 netdev_dev = xzalloc(sizeof *netdev_dev);
681 error = setup_gre(name, args, true);
691 netdev_dev_init(&netdev_dev->netdev_dev, name, &netdev_gre_class);
692 *netdev_devp = &netdev_dev->netdev_dev;
701 netdev_linux_reconfigure_gre(struct netdev_dev *netdev_dev_,
702 const struct shash *args)
704 const char *name = netdev_dev_get_name(netdev_dev_);
706 return setup_gre(name, args, false);
709 /* The arguments are marked as unused to prevent warnings on platforms where
710 * the Netlink interface isn't supported. */
712 destroy_gre_netlink(const char *name OVS_UNUSED)
714 #ifdef GRE_IOCTL_ONLY
718 struct ofpbuf request, *reply;
719 struct ifinfomsg ifinfomsg;
722 ofpbuf_init(&request, 0);
724 nl_msg_put_nlmsghdr(&request, gre_descriptors.nl_sock, 0, RTM_DELLINK,
727 memset(&ifinfomsg, 0, sizeof ifinfomsg);
728 ifinfomsg.ifi_family = AF_UNSPEC;
729 nl_msg_put(&request, &ifinfomsg, sizeof ifinfomsg);
731 ifindex = do_get_ifindex(name);
732 nl_msg_put_u32(&request, IFLA_LINK, ifindex);
734 nl_msg_put_string(&request, IFLA_IFNAME, name);
736 error = nl_sock_transact(gre_descriptors.nl_sock, &request, &reply);
737 ofpbuf_uninit(&request);
739 VLOG_WARN("couldn't transact netlink socket: %s", strerror(error));
742 ofpbuf_delete(reply);
750 destroy_gre_ioctl(const char *name)
752 struct ip_tunnel_parm p;
755 memset(&p, 0, sizeof p);
756 strncpy(p.name, name, IFNAMSIZ);
758 strncpy(ifr.ifr_name, name, IFNAMSIZ);
759 ifr.ifr_ifru.ifru_data = (void *)&p;
761 if (ioctl(gre_descriptors.ioctl_fd, SIOCDELGRETAP, &ifr) < 0) {
762 VLOG_WARN("couldn't do gre ioctl: %s\n", strerror(errno));
770 destroy_tap(struct netdev_dev_linux *netdev_dev)
772 struct tap_state *state = &netdev_dev->state.tap;
774 if (state->fd >= 0) {
780 destroy_gre(const char *name)
782 if (gre_descriptors.use_ioctl) {
783 return destroy_gre_ioctl(name);
785 return destroy_gre_netlink(name);
789 /* Destroys the netdev device 'netdev_dev_'. */
791 netdev_linux_destroy(struct netdev_dev *netdev_dev_)
793 struct netdev_dev_linux *netdev_dev = netdev_dev_linux_cast(netdev_dev_);
794 const char *type = netdev_dev_get_type(netdev_dev_);
796 if (!strcmp(type, "system")) {
797 cache_notifier_refcount--;
799 if (!cache_notifier_refcount) {
800 rtnetlink_notifier_unregister(&netdev_linux_cache_notifier);
802 } else if (!strcmp(type, "tap")) {
803 destroy_tap(netdev_dev);
804 } else if (!strcmp(type, "gre")) {
805 destroy_gre(netdev_dev_get_name(&netdev_dev->netdev_dev));
812 netdev_linux_open(struct netdev_dev *netdev_dev_, int ethertype,
813 struct netdev **netdevp)
815 struct netdev_dev_linux *netdev_dev = netdev_dev_linux_cast(netdev_dev_);
816 struct netdev_linux *netdev;
817 enum netdev_flags flags;
820 /* Allocate network device. */
821 netdev = xzalloc(sizeof *netdev);
823 netdev_init(&netdev->netdev, netdev_dev_);
825 error = netdev_get_flags(&netdev->netdev, &flags);
826 if (error == ENODEV) {
830 if (!strcmp(netdev_dev_get_type(netdev_dev_), "tap")) {
831 netdev->fd = netdev_dev->state.tap.fd;
832 } else if (ethertype != NETDEV_ETH_TYPE_NONE) {
833 struct sockaddr_ll sll;
837 /* Create file descriptor. */
838 protocol = (ethertype == NETDEV_ETH_TYPE_ANY ? ETH_P_ALL
839 : ethertype == NETDEV_ETH_TYPE_802_2 ? ETH_P_802_2
841 netdev->fd = socket(PF_PACKET, SOCK_RAW, htons(protocol));
842 if (netdev->fd < 0) {
847 /* Set non-blocking mode. */
848 error = set_nonblocking(netdev->fd);
853 /* Get ethernet device index. */
854 error = get_ifindex(&netdev->netdev, &ifindex);
859 /* Bind to specific ethernet device. */
860 memset(&sll, 0, sizeof sll);
861 sll.sll_family = AF_PACKET;
862 sll.sll_ifindex = ifindex;
864 (struct sockaddr *) &sll, sizeof sll) < 0) {
866 VLOG_ERR("bind to %s failed: %s", netdev_dev_get_name(netdev_dev_),
871 /* Between the socket() and bind() calls above, the socket receives all
872 * packets of the requested type on all system interfaces. We do not
873 * want to receive that data, but there is no way to avoid it. So we
874 * must now drain out the receive queue. */
875 error = drain_rcvbuf(netdev->fd);
881 *netdevp = &netdev->netdev;
885 netdev_uninit(&netdev->netdev, true);
889 /* Closes and destroys 'netdev'. */
891 netdev_linux_close(struct netdev *netdev_)
893 struct netdev_linux *netdev = netdev_linux_cast(netdev_);
895 if (netdev->fd > 0 && strcmp(netdev_get_type(netdev_), "tap")) {
901 /* Initializes 'svec' with a list of the names of all known network devices. */
903 netdev_linux_enumerate(struct svec *svec)
905 struct if_nameindex *names;
907 names = if_nameindex();
911 for (i = 0; names[i].if_name != NULL; i++) {
912 svec_add(svec, names[i].if_name);
914 if_freenameindex(names);
917 VLOG_WARN("could not obtain list of network device names: %s",
924 netdev_linux_recv(struct netdev *netdev_, void *data, size_t size)
926 struct netdev_linux *netdev = netdev_linux_cast(netdev_);
928 if (netdev->fd < 0) {
929 /* Device was opened with NETDEV_ETH_TYPE_NONE. */
934 ssize_t retval = read(netdev->fd, data, size);
937 } else if (errno != EINTR) {
938 if (errno != EAGAIN) {
939 VLOG_WARN_RL(&rl, "error receiving Ethernet packet on %s: %s",
940 strerror(errno), netdev_get_name(netdev_));
947 /* Registers with the poll loop to wake up from the next call to poll_block()
948 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
950 netdev_linux_recv_wait(struct netdev *netdev_)
952 struct netdev_linux *netdev = netdev_linux_cast(netdev_);
953 if (netdev->fd >= 0) {
954 poll_fd_wait(netdev->fd, POLLIN);
958 /* Discards all packets waiting to be received from 'netdev'. */
960 netdev_linux_drain(struct netdev *netdev_)
962 struct netdev_linux *netdev = netdev_linux_cast(netdev_);
963 if (netdev->fd < 0) {
965 } else if (!strcmp(netdev_get_type(netdev_), "tap")) {
967 int error = netdev_linux_do_ioctl(netdev_get_name(netdev_), &ifr,
968 SIOCGIFTXQLEN, "SIOCGIFTXQLEN");
972 drain_fd(netdev->fd, ifr.ifr_qlen);
975 return drain_rcvbuf(netdev->fd);
979 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
980 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
981 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
982 * the packet is too big or too small to transmit on the device.
984 * The caller retains ownership of 'buffer' in all cases.
986 * The kernel maintains a packet transmission queue, so the caller is not
987 * expected to do additional queuing of packets. */
989 netdev_linux_send(struct netdev *netdev_, const void *data, size_t size)
991 struct netdev_linux *netdev = netdev_linux_cast(netdev_);
993 /* XXX should support sending even if 'ethertype' was NETDEV_ETH_TYPE_NONE.
995 if (netdev->fd < 0) {
1000 ssize_t retval = write(netdev->fd, data, size);
1002 /* The Linux AF_PACKET implementation never blocks waiting for room
1003 * for packets, instead returning ENOBUFS. Translate this into
1004 * EAGAIN for the caller. */
1005 if (errno == ENOBUFS) {
1007 } else if (errno == EINTR) {
1009 } else if (errno != EAGAIN) {
1010 VLOG_WARN_RL(&rl, "error sending Ethernet packet on %s: %s",
1011 netdev_get_name(netdev_), strerror(errno));
1014 } else if (retval != size) {
1015 VLOG_WARN_RL(&rl, "sent partial Ethernet packet (%zd bytes of "
1016 "%zu) on %s", retval, size, netdev_get_name(netdev_));
1024 /* Registers with the poll loop to wake up from the next call to poll_block()
1025 * when the packet transmission queue has sufficient room to transmit a packet
1026 * with netdev_send().
1028 * The kernel maintains a packet transmission queue, so the client is not
1029 * expected to do additional queuing of packets. Thus, this function is
1030 * unlikely to ever be used. It is included for completeness. */
1032 netdev_linux_send_wait(struct netdev *netdev_)
1034 struct netdev_linux *netdev = netdev_linux_cast(netdev_);
1035 if (netdev->fd < 0) {
1036 /* Nothing to do. */
1037 } else if (strcmp(netdev_get_type(netdev_), "tap")) {
1038 poll_fd_wait(netdev->fd, POLLOUT);
1040 /* TAP device always accepts packets.*/
1041 poll_immediate_wake();
1045 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
1046 * otherwise a positive errno value. */
1048 netdev_linux_set_etheraddr(struct netdev *netdev_,
1049 const uint8_t mac[ETH_ADDR_LEN])
1051 struct netdev_dev_linux *netdev_dev =
1052 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1055 if (!(netdev_dev->cache_valid & VALID_ETHERADDR)
1056 || !eth_addr_equals(netdev_dev->etheraddr, mac)) {
1057 error = set_etheraddr(netdev_get_name(netdev_), ARPHRD_ETHER, mac);
1059 netdev_dev->cache_valid |= VALID_ETHERADDR;
1060 memcpy(netdev_dev->etheraddr, mac, ETH_ADDR_LEN);
1068 /* Returns a pointer to 'netdev''s MAC address. The caller must not modify or
1069 * free the returned buffer. */
1071 netdev_linux_get_etheraddr(const struct netdev *netdev_,
1072 uint8_t mac[ETH_ADDR_LEN])
1074 struct netdev_dev_linux *netdev_dev =
1075 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1076 if (!(netdev_dev->cache_valid & VALID_ETHERADDR)) {
1077 int error = get_etheraddr(netdev_get_name(netdev_),
1078 netdev_dev->etheraddr);
1082 netdev_dev->cache_valid |= VALID_ETHERADDR;
1084 memcpy(mac, netdev_dev->etheraddr, ETH_ADDR_LEN);
1088 /* Returns the maximum size of transmitted (and received) packets on 'netdev',
1089 * in bytes, not including the hardware header; thus, this is typically 1500
1090 * bytes for Ethernet devices. */
1092 netdev_linux_get_mtu(const struct netdev *netdev_, int *mtup)
1094 struct netdev_dev_linux *netdev_dev =
1095 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1096 if (!(netdev_dev->cache_valid & VALID_MTU)) {
1100 error = netdev_linux_do_ioctl(netdev_get_name(netdev_), &ifr,
1101 SIOCGIFMTU, "SIOCGIFMTU");
1105 netdev_dev->mtu = ifr.ifr_mtu;
1106 netdev_dev->cache_valid |= VALID_MTU;
1108 *mtup = netdev_dev->mtu;
1112 /* Returns the ifindex of 'netdev', if successful, as a positive number.
1113 * On failure, returns a negative errno value. */
1115 netdev_linux_get_ifindex(const struct netdev *netdev)
1119 error = get_ifindex(netdev, &ifindex);
1120 return error ? -error : ifindex;
1124 netdev_linux_get_carrier(const struct netdev *netdev_, bool *carrier)
1126 struct netdev_dev_linux *netdev_dev =
1127 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1132 if (!(netdev_dev->cache_valid & VALID_CARRIER)) {
1136 fn = xasprintf("/sys/class/net/%s/carrier",
1137 netdev_get_name(netdev_));
1138 fd = open(fn, O_RDONLY);
1141 VLOG_WARN_RL(&rl, "%s: open failed: %s", fn, strerror(error));
1145 retval = read(fd, line, sizeof line);
1148 if (error == EINVAL) {
1149 /* This is the normal return value when we try to check carrier
1150 * if the network device is not up. */
1152 VLOG_WARN_RL(&rl, "%s: read failed: %s", fn, strerror(error));
1155 } else if (retval == 0) {
1157 VLOG_WARN_RL(&rl, "%s: unexpected end of file", fn);
1161 if (line[0] != '0' && line[0] != '1') {
1163 VLOG_WARN_RL(&rl, "%s: value is %c (expected 0 or 1)",
1167 netdev_dev->carrier = line[0] != '0';
1168 netdev_dev->cache_valid |= VALID_CARRIER;
1170 *carrier = netdev_dev->carrier;
1181 /* Check whether we can we use RTM_GETLINK to get network device statistics.
1182 * In pre-2.6.19 kernels, this was only available if wireless extensions were
1185 check_for_working_netlink_stats(void)
1187 /* Decide on the netdev_get_stats() implementation to use. Netlink is
1188 * preferable, so if that works, we'll use it. */
1189 int ifindex = do_get_ifindex("lo");
1191 VLOG_WARN("failed to get ifindex for lo, "
1192 "obtaining netdev stats from proc");
1195 struct netdev_stats stats;
1196 int error = get_stats_via_netlink(ifindex, &stats);
1198 VLOG_DBG("obtaining netdev stats via rtnetlink");
1201 VLOG_INFO("RTM_GETLINK failed (%s), obtaining netdev stats "
1202 "via proc (you are probably running a pre-2.6.19 "
1203 "kernel)", strerror(error));
1209 /* Retrieves current device stats for 'netdev'.
1211 * XXX All of the members of struct netdev_stats are 64 bits wide, but on
1212 * 32-bit architectures the Linux network stats are only 32 bits. */
1214 netdev_linux_get_stats(const struct netdev *netdev_,
1215 struct netdev_stats *stats)
1217 struct netdev_dev_linux *netdev_dev =
1218 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1219 static int use_netlink_stats = -1;
1221 struct netdev_stats raw_stats;
1222 struct netdev_stats *collect_stats = stats;
1224 COVERAGE_INC(netdev_get_stats);
1226 if (!(netdev_dev->cache_valid & VALID_IS_INTERNAL)) {
1227 netdev_dev->is_internal = !strcmp(netdev_get_type(netdev_), "tap");
1228 if (!netdev_dev->is_internal) {
1229 struct ethtool_drvinfo drvinfo;
1231 memset(&drvinfo, 0, sizeof drvinfo);
1232 error = netdev_linux_do_ethtool(netdev_get_name(netdev_),
1233 (struct ethtool_cmd *)&drvinfo,
1235 "ETHTOOL_GDRVINFO");
1238 netdev_dev->is_internal = !strcmp(drvinfo.driver,
1243 netdev_dev->cache_valid |= VALID_IS_INTERNAL;
1246 if (netdev_dev->is_internal) {
1247 collect_stats = &raw_stats;
1250 if (use_netlink_stats < 0) {
1251 use_netlink_stats = check_for_working_netlink_stats();
1253 if (use_netlink_stats) {
1256 error = get_ifindex(netdev_, &ifindex);
1258 error = get_stats_via_netlink(ifindex, collect_stats);
1261 error = get_stats_via_proc(netdev_get_name(netdev_), collect_stats);
1264 /* If this port is an internal port then the transmit and receive stats
1265 * will appear to be swapped relative to the other ports since we are the
1266 * one sending the data, not a remote computer. For consistency, we swap
1267 * them back here. */
1268 if (!error && netdev_dev->is_internal) {
1269 stats->rx_packets = raw_stats.tx_packets;
1270 stats->tx_packets = raw_stats.rx_packets;
1271 stats->rx_bytes = raw_stats.tx_bytes;
1272 stats->tx_bytes = raw_stats.rx_bytes;
1273 stats->rx_errors = raw_stats.tx_errors;
1274 stats->tx_errors = raw_stats.rx_errors;
1275 stats->rx_dropped = raw_stats.tx_dropped;
1276 stats->tx_dropped = raw_stats.rx_dropped;
1277 stats->multicast = raw_stats.multicast;
1278 stats->collisions = raw_stats.collisions;
1279 stats->rx_length_errors = 0;
1280 stats->rx_over_errors = 0;
1281 stats->rx_crc_errors = 0;
1282 stats->rx_frame_errors = 0;
1283 stats->rx_fifo_errors = 0;
1284 stats->rx_missed_errors = 0;
1285 stats->tx_aborted_errors = 0;
1286 stats->tx_carrier_errors = 0;
1287 stats->tx_fifo_errors = 0;
1288 stats->tx_heartbeat_errors = 0;
1289 stats->tx_window_errors = 0;
1295 /* Stores the features supported by 'netdev' into each of '*current',
1296 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
1297 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
1298 * successful, otherwise a positive errno value. */
1300 netdev_linux_get_features(struct netdev *netdev,
1301 uint32_t *current, uint32_t *advertised,
1302 uint32_t *supported, uint32_t *peer)
1304 struct ethtool_cmd ecmd;
1307 memset(&ecmd, 0, sizeof ecmd);
1308 error = netdev_linux_do_ethtool(netdev_get_name(netdev), &ecmd,
1309 ETHTOOL_GSET, "ETHTOOL_GSET");
1314 /* Supported features. */
1316 if (ecmd.supported & SUPPORTED_10baseT_Half) {
1317 *supported |= OFPPF_10MB_HD;
1319 if (ecmd.supported & SUPPORTED_10baseT_Full) {
1320 *supported |= OFPPF_10MB_FD;
1322 if (ecmd.supported & SUPPORTED_100baseT_Half) {
1323 *supported |= OFPPF_100MB_HD;
1325 if (ecmd.supported & SUPPORTED_100baseT_Full) {
1326 *supported |= OFPPF_100MB_FD;
1328 if (ecmd.supported & SUPPORTED_1000baseT_Half) {
1329 *supported |= OFPPF_1GB_HD;
1331 if (ecmd.supported & SUPPORTED_1000baseT_Full) {
1332 *supported |= OFPPF_1GB_FD;
1334 if (ecmd.supported & SUPPORTED_10000baseT_Full) {
1335 *supported |= OFPPF_10GB_FD;
1337 if (ecmd.supported & SUPPORTED_TP) {
1338 *supported |= OFPPF_COPPER;
1340 if (ecmd.supported & SUPPORTED_FIBRE) {
1341 *supported |= OFPPF_FIBER;
1343 if (ecmd.supported & SUPPORTED_Autoneg) {
1344 *supported |= OFPPF_AUTONEG;
1346 if (ecmd.supported & SUPPORTED_Pause) {
1347 *supported |= OFPPF_PAUSE;
1349 if (ecmd.supported & SUPPORTED_Asym_Pause) {
1350 *supported |= OFPPF_PAUSE_ASYM;
1353 /* Advertised features. */
1355 if (ecmd.advertising & ADVERTISED_10baseT_Half) {
1356 *advertised |= OFPPF_10MB_HD;
1358 if (ecmd.advertising & ADVERTISED_10baseT_Full) {
1359 *advertised |= OFPPF_10MB_FD;
1361 if (ecmd.advertising & ADVERTISED_100baseT_Half) {
1362 *advertised |= OFPPF_100MB_HD;
1364 if (ecmd.advertising & ADVERTISED_100baseT_Full) {
1365 *advertised |= OFPPF_100MB_FD;
1367 if (ecmd.advertising & ADVERTISED_1000baseT_Half) {
1368 *advertised |= OFPPF_1GB_HD;
1370 if (ecmd.advertising & ADVERTISED_1000baseT_Full) {
1371 *advertised |= OFPPF_1GB_FD;
1373 if (ecmd.advertising & ADVERTISED_10000baseT_Full) {
1374 *advertised |= OFPPF_10GB_FD;
1376 if (ecmd.advertising & ADVERTISED_TP) {
1377 *advertised |= OFPPF_COPPER;
1379 if (ecmd.advertising & ADVERTISED_FIBRE) {
1380 *advertised |= OFPPF_FIBER;
1382 if (ecmd.advertising & ADVERTISED_Autoneg) {
1383 *advertised |= OFPPF_AUTONEG;
1385 if (ecmd.advertising & ADVERTISED_Pause) {
1386 *advertised |= OFPPF_PAUSE;
1388 if (ecmd.advertising & ADVERTISED_Asym_Pause) {
1389 *advertised |= OFPPF_PAUSE_ASYM;
1392 /* Current settings. */
1393 if (ecmd.speed == SPEED_10) {
1394 *current = ecmd.duplex ? OFPPF_10MB_FD : OFPPF_10MB_HD;
1395 } else if (ecmd.speed == SPEED_100) {
1396 *current = ecmd.duplex ? OFPPF_100MB_FD : OFPPF_100MB_HD;
1397 } else if (ecmd.speed == SPEED_1000) {
1398 *current = ecmd.duplex ? OFPPF_1GB_FD : OFPPF_1GB_HD;
1399 } else if (ecmd.speed == SPEED_10000) {
1400 *current = OFPPF_10GB_FD;
1405 if (ecmd.port == PORT_TP) {
1406 *current |= OFPPF_COPPER;
1407 } else if (ecmd.port == PORT_FIBRE) {
1408 *current |= OFPPF_FIBER;
1412 *current |= OFPPF_AUTONEG;
1415 /* Peer advertisements. */
1416 *peer = 0; /* XXX */
1421 /* Set the features advertised by 'netdev' to 'advertise'. */
1423 netdev_linux_set_advertisements(struct netdev *netdev, uint32_t advertise)
1425 struct ethtool_cmd ecmd;
1428 memset(&ecmd, 0, sizeof ecmd);
1429 error = netdev_linux_do_ethtool(netdev_get_name(netdev), &ecmd,
1430 ETHTOOL_GSET, "ETHTOOL_GSET");
1435 ecmd.advertising = 0;
1436 if (advertise & OFPPF_10MB_HD) {
1437 ecmd.advertising |= ADVERTISED_10baseT_Half;
1439 if (advertise & OFPPF_10MB_FD) {
1440 ecmd.advertising |= ADVERTISED_10baseT_Full;
1442 if (advertise & OFPPF_100MB_HD) {
1443 ecmd.advertising |= ADVERTISED_100baseT_Half;
1445 if (advertise & OFPPF_100MB_FD) {
1446 ecmd.advertising |= ADVERTISED_100baseT_Full;
1448 if (advertise & OFPPF_1GB_HD) {
1449 ecmd.advertising |= ADVERTISED_1000baseT_Half;
1451 if (advertise & OFPPF_1GB_FD) {
1452 ecmd.advertising |= ADVERTISED_1000baseT_Full;
1454 if (advertise & OFPPF_10GB_FD) {
1455 ecmd.advertising |= ADVERTISED_10000baseT_Full;
1457 if (advertise & OFPPF_COPPER) {
1458 ecmd.advertising |= ADVERTISED_TP;
1460 if (advertise & OFPPF_FIBER) {
1461 ecmd.advertising |= ADVERTISED_FIBRE;
1463 if (advertise & OFPPF_AUTONEG) {
1464 ecmd.advertising |= ADVERTISED_Autoneg;
1466 if (advertise & OFPPF_PAUSE) {
1467 ecmd.advertising |= ADVERTISED_Pause;
1469 if (advertise & OFPPF_PAUSE_ASYM) {
1470 ecmd.advertising |= ADVERTISED_Asym_Pause;
1472 return netdev_linux_do_ethtool(netdev_get_name(netdev), &ecmd,
1473 ETHTOOL_SSET, "ETHTOOL_SSET");
1476 /* If 'netdev_name' is the name of a VLAN network device (e.g. one created with
1477 * vconfig(8)), sets '*vlan_vid' to the VLAN VID associated with that device
1478 * and returns 0. Otherwise returns a errno value (specifically ENOENT if
1479 * 'netdev_name' is the name of a network device that is not a VLAN device) and
1480 * sets '*vlan_vid' to -1. */
1482 netdev_linux_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1484 const char *netdev_name = netdev_get_name(netdev);
1485 struct ds line = DS_EMPTY_INITIALIZER;
1486 FILE *stream = NULL;
1490 COVERAGE_INC(netdev_get_vlan_vid);
1491 fn = xasprintf("/proc/net/vlan/%s", netdev_name);
1492 stream = fopen(fn, "r");
1498 if (ds_get_line(&line, stream)) {
1499 if (ferror(stream)) {
1501 VLOG_ERR_RL(&rl, "error reading \"%s\": %s", fn, strerror(errno));
1504 VLOG_ERR_RL(&rl, "unexpected end of file reading \"%s\"", fn);
1509 if (!sscanf(ds_cstr(&line), "%*s VID: %d", vlan_vid)) {
1511 VLOG_ERR_RL(&rl, "parse error reading \"%s\" line 1: \"%s\"",
1512 fn, ds_cstr(&line));
1530 #define POLICE_ADD_CMD "/sbin/tc qdisc add dev %s handle ffff: ingress"
1531 #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"
1532 /* We redirect stderr to /dev/null because we often want to remove all
1533 * traffic control configuration on a port so its in a known state. If
1534 * this done when there is no such configuration, tc complains, so we just
1537 #define POLICE_DEL_CMD "/sbin/tc qdisc del dev %s handle ffff: ingress 2>/dev/null"
1539 /* Attempts to set input rate limiting (policing) policy. */
1541 netdev_linux_set_policing(struct netdev *netdev,
1542 uint32_t kbits_rate, uint32_t kbits_burst)
1544 const char *netdev_name = netdev_get_name(netdev);
1547 COVERAGE_INC(netdev_set_policing);
1550 /* Default to 1000 kilobits if not specified. */
1554 /* xxx This should be more careful about only adding if it
1555 * xxx actually exists, as opposed to always deleting it. */
1556 snprintf(command, sizeof(command), POLICE_DEL_CMD, netdev_name);
1557 if (system(command) == -1) {
1558 VLOG_WARN_RL(&rl, "%s: problem removing policing", netdev_name);
1561 snprintf(command, sizeof(command), POLICE_ADD_CMD, netdev_name);
1562 if (system(command) != 0) {
1563 VLOG_WARN_RL(&rl, "%s: problem adding policing", netdev_name);
1567 snprintf(command, sizeof(command), POLICE_CONFIG_CMD, netdev_name,
1568 kbits_rate, kbits_burst);
1569 if (system(command) != 0) {
1570 VLOG_WARN_RL(&rl, "%s: problem configuring policing",
1575 snprintf(command, sizeof(command), POLICE_DEL_CMD, netdev_name);
1576 if (system(command) == -1) {
1577 VLOG_WARN_RL(&rl, "%s: problem removing policing", netdev_name);
1585 netdev_linux_get_in4(const struct netdev *netdev_,
1586 struct in_addr *address, struct in_addr *netmask)
1588 struct netdev_dev_linux *netdev_dev =
1589 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1591 if (!(netdev_dev->cache_valid & VALID_IN4)) {
1594 error = netdev_linux_get_ipv4(netdev_, &netdev_dev->address,
1595 SIOCGIFADDR, "SIOCGIFADDR");
1600 error = netdev_linux_get_ipv4(netdev_, &netdev_dev->netmask,
1601 SIOCGIFNETMASK, "SIOCGIFNETMASK");
1606 netdev_dev->cache_valid |= VALID_IN4;
1608 *address = netdev_dev->address;
1609 *netmask = netdev_dev->netmask;
1610 return address->s_addr == INADDR_ANY ? EADDRNOTAVAIL : 0;
1614 netdev_linux_set_in4(struct netdev *netdev_, struct in_addr address,
1615 struct in_addr netmask)
1617 struct netdev_dev_linux *netdev_dev =
1618 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1621 error = do_set_addr(netdev_, SIOCSIFADDR, "SIOCSIFADDR", address);
1623 netdev_dev->cache_valid |= VALID_IN4;
1624 netdev_dev->address = address;
1625 netdev_dev->netmask = netmask;
1626 if (address.s_addr != INADDR_ANY) {
1627 error = do_set_addr(netdev_, SIOCSIFNETMASK,
1628 "SIOCSIFNETMASK", netmask);
1635 parse_if_inet6_line(const char *line,
1636 struct in6_addr *in6, char ifname[16 + 1])
1638 uint8_t *s6 = in6->s6_addr;
1639 #define X8 "%2"SCNx8
1641 " "X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8 X8
1642 "%*x %*x %*x %*x %16s\n",
1643 &s6[0], &s6[1], &s6[2], &s6[3],
1644 &s6[4], &s6[5], &s6[6], &s6[7],
1645 &s6[8], &s6[9], &s6[10], &s6[11],
1646 &s6[12], &s6[13], &s6[14], &s6[15],
1650 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address (if
1651 * 'in6' is non-null) and returns true. Otherwise, returns false. */
1653 netdev_linux_get_in6(const struct netdev *netdev_, struct in6_addr *in6)
1655 struct netdev_dev_linux *netdev_dev =
1656 netdev_dev_linux_cast(netdev_get_dev(netdev_));
1657 if (!(netdev_dev->cache_valid & VALID_IN6)) {
1661 netdev_dev->in6 = in6addr_any;
1663 file = fopen("/proc/net/if_inet6", "r");
1665 const char *name = netdev_get_name(netdev_);
1666 while (fgets(line, sizeof line, file)) {
1667 struct in6_addr in6;
1668 char ifname[16 + 1];
1669 if (parse_if_inet6_line(line, &in6, ifname)
1670 && !strcmp(name, ifname))
1672 netdev_dev->in6 = in6;
1678 netdev_dev->cache_valid |= VALID_IN6;
1680 *in6 = netdev_dev->in6;
1685 make_in4_sockaddr(struct sockaddr *sa, struct in_addr addr)
1687 struct sockaddr_in sin;
1688 memset(&sin, 0, sizeof sin);
1689 sin.sin_family = AF_INET;
1690 sin.sin_addr = addr;
1693 memset(sa, 0, sizeof *sa);
1694 memcpy(sa, &sin, sizeof sin);
1698 do_set_addr(struct netdev *netdev,
1699 int ioctl_nr, const char *ioctl_name, struct in_addr addr)
1702 strncpy(ifr.ifr_name, netdev_get_name(netdev), sizeof ifr.ifr_name);
1703 make_in4_sockaddr(&ifr.ifr_addr, addr);
1705 return netdev_linux_do_ioctl(netdev_get_name(netdev), &ifr, ioctl_nr,
1709 /* Adds 'router' as a default IP gateway. */
1711 netdev_linux_add_router(struct netdev *netdev OVS_UNUSED, struct in_addr router)
1713 struct in_addr any = { INADDR_ANY };
1717 memset(&rt, 0, sizeof rt);
1718 make_in4_sockaddr(&rt.rt_dst, any);
1719 make_in4_sockaddr(&rt.rt_gateway, router);
1720 make_in4_sockaddr(&rt.rt_genmask, any);
1721 rt.rt_flags = RTF_UP | RTF_GATEWAY;
1722 COVERAGE_INC(netdev_add_router);
1723 error = ioctl(af_inet_sock, SIOCADDRT, &rt) < 0 ? errno : 0;
1725 VLOG_WARN("ioctl(SIOCADDRT): %s", strerror(error));
1731 netdev_linux_get_next_hop(const struct in_addr *host, struct in_addr *next_hop,
1734 static const char fn[] = "/proc/net/route";
1739 *netdev_name = NULL;
1740 stream = fopen(fn, "r");
1741 if (stream == NULL) {
1742 VLOG_WARN_RL(&rl, "%s: open failed: %s", fn, strerror(errno));
1747 while (fgets(line, sizeof line, stream)) {
1750 uint32_t dest, gateway, mask;
1751 int refcnt, metric, mtu;
1752 unsigned int flags, use, window, irtt;
1755 "%16s %"SCNx32" %"SCNx32" %04X %d %u %d %"SCNx32
1757 iface, &dest, &gateway, &flags, &refcnt,
1758 &use, &metric, &mask, &mtu, &window, &irtt) != 11) {
1760 VLOG_WARN_RL(&rl, "%s: could not parse line %d: %s",
1764 if (!(flags & RTF_UP)) {
1765 /* Skip routes that aren't up. */
1769 /* The output of 'dest', 'mask', and 'gateway' were given in
1770 * network byte order, so we don't need need any endian
1771 * conversions here. */
1772 if ((dest & mask) == (host->s_addr & mask)) {
1774 /* The host is directly reachable. */
1775 next_hop->s_addr = 0;
1777 /* To reach the host, we must go through a gateway. */
1778 next_hop->s_addr = gateway;
1780 *netdev_name = xstrdup(iface);
1791 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1792 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1793 * returns 0. Otherwise, it returns a positive errno value; in particular,
1794 * ENXIO indicates that there is not ARP table entry for 'ip' on 'netdev'. */
1796 netdev_linux_arp_lookup(const struct netdev *netdev,
1797 uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
1800 struct sockaddr_in sin;
1803 memset(&r, 0, sizeof r);
1804 sin.sin_family = AF_INET;
1805 sin.sin_addr.s_addr = ip;
1807 memcpy(&r.arp_pa, &sin, sizeof sin);
1808 r.arp_ha.sa_family = ARPHRD_ETHER;
1810 strncpy(r.arp_dev, netdev_get_name(netdev), sizeof r.arp_dev);
1811 COVERAGE_INC(netdev_arp_lookup);
1812 retval = ioctl(af_inet_sock, SIOCGARP, &r) < 0 ? errno : 0;
1814 memcpy(mac, r.arp_ha.sa_data, ETH_ADDR_LEN);
1815 } else if (retval != ENXIO) {
1816 VLOG_WARN_RL(&rl, "%s: could not look up ARP entry for "IP_FMT": %s",
1817 netdev_get_name(netdev), IP_ARGS(&ip), strerror(retval));
1823 nd_to_iff_flags(enum netdev_flags nd)
1826 if (nd & NETDEV_UP) {
1829 if (nd & NETDEV_PROMISC) {
1836 iff_to_nd_flags(int iff)
1838 enum netdev_flags nd = 0;
1842 if (iff & IFF_PROMISC) {
1843 nd |= NETDEV_PROMISC;
1849 netdev_linux_update_flags(struct netdev *netdev, enum netdev_flags off,
1850 enum netdev_flags on, enum netdev_flags *old_flagsp)
1852 int old_flags, new_flags;
1855 error = get_flags(netdev, &old_flags);
1857 *old_flagsp = iff_to_nd_flags(old_flags);
1858 new_flags = (old_flags & ~nd_to_iff_flags(off)) | nd_to_iff_flags(on);
1859 if (new_flags != old_flags) {
1860 error = set_flags(netdev, new_flags);
1867 poll_notify(struct list *list)
1869 struct netdev_linux_notifier *notifier;
1870 LIST_FOR_EACH (notifier, struct netdev_linux_notifier, node, list) {
1871 struct netdev_notifier *n = ¬ifier->notifier;
1877 netdev_linux_poll_cb(const struct rtnetlink_change *change,
1878 void *aux OVS_UNUSED)
1881 struct list *list = shash_find_data(&netdev_linux_notifiers,
1887 struct shash_node *node;
1888 SHASH_FOR_EACH (node, &netdev_linux_notifiers) {
1889 poll_notify(node->data);
1895 netdev_linux_poll_add(struct netdev *netdev,
1896 void (*cb)(struct netdev_notifier *), void *aux,
1897 struct netdev_notifier **notifierp)
1899 const char *netdev_name = netdev_get_name(netdev);
1900 struct netdev_linux_notifier *notifier;
1903 if (shash_is_empty(&netdev_linux_notifiers)) {
1904 int error = rtnetlink_notifier_register(&netdev_linux_poll_notifier,
1905 netdev_linux_poll_cb, NULL);
1911 list = shash_find_data(&netdev_linux_notifiers, netdev_name);
1913 list = xmalloc(sizeof *list);
1915 shash_add(&netdev_linux_notifiers, netdev_name, list);
1918 notifier = xmalloc(sizeof *notifier);
1919 netdev_notifier_init(¬ifier->notifier, netdev, cb, aux);
1920 list_push_back(list, ¬ifier->node);
1921 *notifierp = ¬ifier->notifier;
1926 netdev_linux_poll_remove(struct netdev_notifier *notifier_)
1928 struct netdev_linux_notifier *notifier =
1929 CONTAINER_OF(notifier_, struct netdev_linux_notifier, notifier);
1932 /* Remove 'notifier' from its list. */
1933 list = list_remove(¬ifier->node);
1934 if (list_is_empty(list)) {
1935 /* The list is now empty. Remove it from the hash and free it. */
1936 const char *netdev_name = netdev_get_name(notifier->notifier.netdev);
1937 shash_delete(&netdev_linux_notifiers,
1938 shash_find(&netdev_linux_notifiers, netdev_name));
1943 /* If that was the last notifier, unregister. */
1944 if (shash_is_empty(&netdev_linux_notifiers)) {
1945 rtnetlink_notifier_unregister(&netdev_linux_poll_notifier);
1949 const struct netdev_class netdev_linux_class = {
1956 netdev_linux_create_system,
1957 netdev_linux_destroy,
1958 NULL, /* reconfigure */
1963 netdev_linux_enumerate,
1966 netdev_linux_recv_wait,
1970 netdev_linux_send_wait,
1972 netdev_linux_set_etheraddr,
1973 netdev_linux_get_etheraddr,
1974 netdev_linux_get_mtu,
1975 netdev_linux_get_ifindex,
1976 netdev_linux_get_carrier,
1977 netdev_linux_get_stats,
1979 netdev_linux_get_features,
1980 netdev_linux_set_advertisements,
1981 netdev_linux_get_vlan_vid,
1982 netdev_linux_set_policing,
1984 netdev_linux_get_in4,
1985 netdev_linux_set_in4,
1986 netdev_linux_get_in6,
1987 netdev_linux_add_router,
1988 netdev_linux_get_next_hop,
1989 netdev_linux_arp_lookup,
1991 netdev_linux_update_flags,
1993 netdev_linux_poll_add,
1994 netdev_linux_poll_remove,
1997 const struct netdev_class netdev_tap_class = {
2004 netdev_linux_create_tap,
2005 netdev_linux_destroy,
2006 NULL, /* reconfigure */
2011 NULL, /* enumerate */
2014 netdev_linux_recv_wait,
2018 netdev_linux_send_wait,
2020 netdev_linux_set_etheraddr,
2021 netdev_linux_get_etheraddr,
2022 netdev_linux_get_mtu,
2023 netdev_linux_get_ifindex,
2024 netdev_linux_get_carrier,
2025 netdev_linux_get_stats,
2027 netdev_linux_get_features,
2028 netdev_linux_set_advertisements,
2029 netdev_linux_get_vlan_vid,
2030 netdev_linux_set_policing,
2032 netdev_linux_get_in4,
2033 netdev_linux_set_in4,
2034 netdev_linux_get_in6,
2035 netdev_linux_add_router,
2036 netdev_linux_get_next_hop,
2037 netdev_linux_arp_lookup,
2039 netdev_linux_update_flags,
2041 netdev_linux_poll_add,
2042 netdev_linux_poll_remove,
2045 const struct netdev_class netdev_gre_class = {
2052 netdev_linux_create_gre,
2053 netdev_linux_destroy,
2054 netdev_linux_reconfigure_gre,
2059 NULL, /* enumerate */
2062 netdev_linux_recv_wait,
2066 netdev_linux_send_wait,
2068 netdev_linux_set_etheraddr,
2069 netdev_linux_get_etheraddr,
2070 netdev_linux_get_mtu,
2071 netdev_linux_get_ifindex,
2072 netdev_linux_get_carrier,
2073 netdev_linux_get_stats,
2075 netdev_linux_get_features,
2076 netdev_linux_set_advertisements,
2077 netdev_linux_get_vlan_vid,
2078 netdev_linux_set_policing,
2080 netdev_linux_get_in4,
2081 netdev_linux_set_in4,
2082 netdev_linux_get_in6,
2083 netdev_linux_add_router,
2084 netdev_linux_get_next_hop,
2085 netdev_linux_arp_lookup,
2087 netdev_linux_update_flags,
2089 netdev_linux_poll_add,
2090 netdev_linux_poll_remove,
2094 get_stats_via_netlink(int ifindex, struct netdev_stats *stats)
2096 /* Policy for RTNLGRP_LINK messages.
2098 * There are *many* more fields in these messages, but currently we only
2099 * care about these fields. */
2100 static const struct nl_policy rtnlgrp_link_policy[] = {
2101 [IFLA_IFNAME] = { .type = NL_A_STRING, .optional = false },
2102 [IFLA_STATS] = { .type = NL_A_UNSPEC, .optional = true,
2103 .min_len = sizeof(struct rtnl_link_stats) },
2107 static struct nl_sock *rtnl_sock;
2108 struct ofpbuf request;
2109 struct ofpbuf *reply;
2110 struct ifinfomsg *ifi;
2111 const struct rtnl_link_stats *rtnl_stats;
2112 struct nlattr *attrs[ARRAY_SIZE(rtnlgrp_link_policy)];
2116 error = nl_sock_create(NETLINK_ROUTE, 0, 0, 0, &rtnl_sock);
2118 VLOG_ERR_RL(&rl, "failed to create rtnetlink socket: %s",
2124 ofpbuf_init(&request, 0);
2125 nl_msg_put_nlmsghdr(&request, rtnl_sock, sizeof *ifi,
2126 RTM_GETLINK, NLM_F_REQUEST);
2127 ifi = ofpbuf_put_zeros(&request, sizeof *ifi);
2128 ifi->ifi_family = PF_UNSPEC;
2129 ifi->ifi_index = ifindex;
2130 error = nl_sock_transact(rtnl_sock, &request, &reply);
2131 ofpbuf_uninit(&request);
2136 if (!nl_policy_parse(reply, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
2137 rtnlgrp_link_policy,
2138 attrs, ARRAY_SIZE(rtnlgrp_link_policy))) {
2139 ofpbuf_delete(reply);
2143 if (!attrs[IFLA_STATS]) {
2144 VLOG_WARN_RL(&rl, "RTM_GETLINK reply lacks stats");
2145 ofpbuf_delete(reply);
2149 rtnl_stats = nl_attr_get(attrs[IFLA_STATS]);
2150 stats->rx_packets = rtnl_stats->rx_packets;
2151 stats->tx_packets = rtnl_stats->tx_packets;
2152 stats->rx_bytes = rtnl_stats->rx_bytes;
2153 stats->tx_bytes = rtnl_stats->tx_bytes;
2154 stats->rx_errors = rtnl_stats->rx_errors;
2155 stats->tx_errors = rtnl_stats->tx_errors;
2156 stats->rx_dropped = rtnl_stats->rx_dropped;
2157 stats->tx_dropped = rtnl_stats->tx_dropped;
2158 stats->multicast = rtnl_stats->multicast;
2159 stats->collisions = rtnl_stats->collisions;
2160 stats->rx_length_errors = rtnl_stats->rx_length_errors;
2161 stats->rx_over_errors = rtnl_stats->rx_over_errors;
2162 stats->rx_crc_errors = rtnl_stats->rx_crc_errors;
2163 stats->rx_frame_errors = rtnl_stats->rx_frame_errors;
2164 stats->rx_fifo_errors = rtnl_stats->rx_fifo_errors;
2165 stats->rx_missed_errors = rtnl_stats->rx_missed_errors;
2166 stats->tx_aborted_errors = rtnl_stats->tx_aborted_errors;
2167 stats->tx_carrier_errors = rtnl_stats->tx_carrier_errors;
2168 stats->tx_fifo_errors = rtnl_stats->tx_fifo_errors;
2169 stats->tx_heartbeat_errors = rtnl_stats->tx_heartbeat_errors;
2170 stats->tx_window_errors = rtnl_stats->tx_window_errors;
2172 ofpbuf_delete(reply);
2178 get_stats_via_proc(const char *netdev_name, struct netdev_stats *stats)
2180 static const char fn[] = "/proc/net/dev";
2185 stream = fopen(fn, "r");
2187 VLOG_WARN_RL(&rl, "%s: open failed: %s", fn, strerror(errno));
2192 while (fgets(line, sizeof line, stream)) {
2195 #define X64 "%"SCNu64
2198 X64 X64 X64 X64 X64 X64 X64 "%*u"
2199 X64 X64 X64 X64 X64 X64 X64 "%*u",
2205 &stats->rx_fifo_errors,
2206 &stats->rx_frame_errors,
2212 &stats->tx_fifo_errors,
2214 &stats->tx_carrier_errors) != 15) {
2215 VLOG_WARN_RL(&rl, "%s:%d: parse error", fn, ln);
2216 } else if (!strcmp(devname, netdev_name)) {
2217 stats->rx_length_errors = UINT64_MAX;
2218 stats->rx_over_errors = UINT64_MAX;
2219 stats->rx_crc_errors = UINT64_MAX;
2220 stats->rx_missed_errors = UINT64_MAX;
2221 stats->tx_aborted_errors = UINT64_MAX;
2222 stats->tx_heartbeat_errors = UINT64_MAX;
2223 stats->tx_window_errors = UINT64_MAX;
2229 VLOG_WARN_RL(&rl, "%s: no stats for %s", fn, netdev_name);
2235 get_flags(const struct netdev *netdev, int *flags)
2240 error = netdev_linux_do_ioctl(netdev_get_name(netdev), &ifr, SIOCGIFFLAGS,
2242 *flags = ifr.ifr_flags;
2247 set_flags(struct netdev *netdev, int flags)
2251 ifr.ifr_flags = flags;
2252 return netdev_linux_do_ioctl(netdev_get_name(netdev), &ifr, SIOCSIFFLAGS,
2257 do_get_ifindex(const char *netdev_name)
2261 strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
2262 COVERAGE_INC(netdev_get_ifindex);
2263 if (ioctl(af_inet_sock, SIOCGIFINDEX, &ifr) < 0) {
2264 VLOG_WARN_RL(&rl, "ioctl(SIOCGIFINDEX) on %s device failed: %s",
2265 netdev_name, strerror(errno));
2268 return ifr.ifr_ifindex;
2272 get_ifindex(const struct netdev *netdev_, int *ifindexp)
2274 struct netdev_dev_linux *netdev_dev =
2275 netdev_dev_linux_cast(netdev_get_dev(netdev_));
2277 if (!(netdev_dev->cache_valid & VALID_IFINDEX)) {
2278 int ifindex = do_get_ifindex(netdev_get_name(netdev_));
2282 netdev_dev->cache_valid |= VALID_IFINDEX;
2283 netdev_dev->ifindex = ifindex;
2285 *ifindexp = netdev_dev->ifindex;
2290 get_etheraddr(const char *netdev_name, uint8_t ea[ETH_ADDR_LEN])
2295 memset(&ifr, 0, sizeof ifr);
2296 strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
2297 COVERAGE_INC(netdev_get_hwaddr);
2298 if (ioctl(af_inet_sock, SIOCGIFHWADDR, &ifr) < 0) {
2299 VLOG_ERR("ioctl(SIOCGIFHWADDR) on %s device failed: %s",
2300 netdev_name, strerror(errno));
2303 hwaddr_family = ifr.ifr_hwaddr.sa_family;
2304 if (hwaddr_family != AF_UNSPEC && hwaddr_family != ARPHRD_ETHER) {
2305 VLOG_WARN("%s device has unknown hardware address family %d",
2306 netdev_name, hwaddr_family);
2308 memcpy(ea, ifr.ifr_hwaddr.sa_data, ETH_ADDR_LEN);
2313 set_etheraddr(const char *netdev_name, int hwaddr_family,
2314 const uint8_t mac[ETH_ADDR_LEN])
2318 memset(&ifr, 0, sizeof ifr);
2319 strncpy(ifr.ifr_name, netdev_name, sizeof ifr.ifr_name);
2320 ifr.ifr_hwaddr.sa_family = hwaddr_family;
2321 memcpy(ifr.ifr_hwaddr.sa_data, mac, ETH_ADDR_LEN);
2322 COVERAGE_INC(netdev_set_hwaddr);
2323 if (ioctl(af_inet_sock, SIOCSIFHWADDR, &ifr) < 0) {
2324 VLOG_ERR("ioctl(SIOCSIFHWADDR) on %s device failed: %s",
2325 netdev_name, strerror(errno));
2332 netdev_linux_do_ethtool(const char *name, struct ethtool_cmd *ecmd,
2333 int cmd, const char *cmd_name)
2337 memset(&ifr, 0, sizeof ifr);
2338 strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
2339 ifr.ifr_data = (caddr_t) ecmd;
2342 COVERAGE_INC(netdev_ethtool);
2343 if (ioctl(af_inet_sock, SIOCETHTOOL, &ifr) == 0) {
2346 if (errno != EOPNOTSUPP) {
2347 VLOG_WARN_RL(&rl, "ethtool command %s on network device %s "
2348 "failed: %s", cmd_name, name, strerror(errno));
2350 /* The device doesn't support this operation. That's pretty
2351 * common, so there's no point in logging anything. */
2358 netdev_linux_do_ioctl(const char *name, struct ifreq *ifr, int cmd,
2359 const char *cmd_name)
2361 strncpy(ifr->ifr_name, name, sizeof ifr->ifr_name);
2362 if (ioctl(af_inet_sock, cmd, ifr) == -1) {
2363 VLOG_DBG_RL(&rl, "%s: ioctl(%s) failed: %s", name, cmd_name,
2371 netdev_linux_get_ipv4(const struct netdev *netdev, struct in_addr *ip,
2372 int cmd, const char *cmd_name)
2377 ifr.ifr_addr.sa_family = AF_INET;
2378 error = netdev_linux_do_ioctl(netdev_get_name(netdev), &ifr, cmd, cmd_name);
2380 const struct sockaddr_in *sin = (struct sockaddr_in *) &ifr.ifr_addr;
2381 *ip = sin->sin_addr;