2 * Copyright (c) 2008, 2009, 2010, 2011 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.
19 #include "dpif-linux.h"
27 #include <linux/types.h>
28 #include <linux/ethtool.h>
29 #include <linux/pkt_sched.h>
30 #include <linux/rtnetlink.h>
31 #include <linux/sockios.h>
33 #include <sys/ioctl.h>
37 #include "dpif-provider.h"
39 #include "netdev-vport.h"
42 #include "openvswitch/tunnel.h"
44 #include "poll-loop.h"
45 #include "rtnetlink.h"
46 #include "rtnetlink-link.h"
52 VLOG_DEFINE_THIS_MODULE(dpif_linux);
54 /* Datapath interface for the openvswitch Linux kernel module. */
59 /* Used by dpif_linux_get_all_names(). */
63 /* Change notification. */
64 int local_ifindex; /* Ifindex of local port. */
65 struct shash changed_ports; /* Ports that have changed. */
66 struct rtnetlink_notifier port_notifier;
70 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
72 static int do_ioctl(const struct dpif *, int cmd, const void *arg);
73 static int lookup_internal_device(const char *name, int *dp_idx, int *port_no);
74 static int lookup_minor(const char *name, int *minor);
75 static int finish_open(struct dpif *, const char *local_ifname);
76 static int get_openvswitch_major(void);
77 static int create_minor(const char *name, int minor, struct dpif **dpifp);
78 static int open_minor(int minor, struct dpif **dpifp);
79 static int make_openvswitch_device(int minor, char **fnp);
80 static void dpif_linux_port_changed(const struct rtnetlink_link_change *,
83 static struct dpif_linux *
84 dpif_linux_cast(const struct dpif *dpif)
86 dpif_assert_class(dpif, &dpif_linux_class);
87 return CONTAINER_OF(dpif, struct dpif_linux, dpif);
91 dpif_linux_enumerate(struct svec *all_dps)
97 /* Check that the Open vSwitch module is loaded. */
98 major = get_openvswitch_major();
104 for (i = 0; i < ODP_MAX; i++) {
109 sprintf(devname, "dp%d", i);
110 retval = dpif_open(devname, "system", &dpif);
112 svec_add(all_dps, devname);
113 dpif_uninit(dpif, true);
114 } else if (retval != ENODEV && !error) {
122 dpif_linux_open(const struct dpif_class *class OVS_UNUSED, const char *name,
123 bool create, struct dpif **dpifp)
127 minor = !strncmp(name, "dp", 2)
128 && isdigit((unsigned char)name[2]) ? atoi(name + 2) : -1;
131 return create_minor(name, minor, dpifp);
133 /* Scan for unused minor number. */
134 for (minor = 0; minor < ODP_MAX; minor++) {
135 int error = create_minor(name, minor, dpifp);
136 if (error != EBUSY) {
141 /* All datapath numbers in use. */
145 struct dpif_linux *dpif;
146 struct odp_port port;
150 error = lookup_minor(name, &minor);
156 error = open_minor(minor, dpifp);
160 dpif = dpif_linux_cast(*dpifp);
162 /* We need the local port's ifindex for the poll function. Start by
163 * getting the local port's name. */
164 memset(&port, 0, sizeof port);
165 port.port = ODPP_LOCAL;
166 if (ioctl(dpif->fd, ODP_VPORT_QUERY, &port)) {
168 if (error != ENODEV) {
169 VLOG_WARN("%s: probe returned unexpected error: %s",
170 dpif_name(*dpifp), strerror(error));
172 dpif_uninit(*dpifp, true);
176 /* Then use that to finish up opening. */
177 return finish_open(&dpif->dpif, port.devname);
182 dpif_linux_close(struct dpif *dpif_)
184 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
185 rtnetlink_link_notifier_unregister(&dpif->port_notifier);
186 shash_destroy(&dpif->changed_ports);
187 free(dpif->local_ifname);
193 dpif_linux_get_all_names(const struct dpif *dpif_, struct svec *all_names)
195 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
197 svec_add_nocopy(all_names, xasprintf("dp%d", dpif->minor));
198 svec_add(all_names, dpif->local_ifname);
203 dpif_linux_destroy(struct dpif *dpif_)
205 return do_ioctl(dpif_, ODP_DP_DESTROY, NULL);
209 dpif_linux_get_stats(const struct dpif *dpif_, struct odp_stats *stats)
211 memset(stats, 0, sizeof *stats);
212 return do_ioctl(dpif_, ODP_DP_STATS, stats);
216 dpif_linux_get_drop_frags(const struct dpif *dpif_, bool *drop_fragsp)
221 error = do_ioctl(dpif_, ODP_GET_DROP_FRAGS, &drop_frags);
223 *drop_fragsp = drop_frags & 1;
229 dpif_linux_set_drop_frags(struct dpif *dpif_, bool drop_frags)
231 int drop_frags_int = drop_frags;
232 return do_ioctl(dpif_, ODP_SET_DROP_FRAGS, &drop_frags_int);
236 translate_vport_type_to_netdev_type(struct odp_port *port)
238 char *type = port->type;
240 if (!strcmp(type, "netdev")) {
241 ovs_strlcpy(type, "system", sizeof port->type);
242 } else if (!strcmp(type, "gre")) {
243 const struct tnl_port_config *config;
245 config = (struct tnl_port_config *)port->config;
246 if (config->flags & TNL_F_IPSEC) {
247 ovs_strlcpy(type, "ipsec_gre", sizeof port->type);
253 translate_netdev_type_to_vport_type(struct odp_port *port)
255 char *type = port->type;
257 if (!strcmp(type, "system")) {
258 ovs_strlcpy(type, "netdev", sizeof port->type);
259 } else if (!strcmp(type, "ipsec_gre")) {
260 ovs_strlcpy(type, "gre", sizeof port->type);
265 dpif_linux_port_add(struct dpif *dpif, struct netdev *netdev,
268 const char *name = netdev_get_name(netdev);
269 const char *type = netdev_get_type(netdev);
270 struct odp_port port;
273 memset(&port, 0, sizeof port);
274 strncpy(port.devname, name, sizeof port.devname);
275 strncpy(port.type, type, sizeof port.type);
276 netdev_vport_get_config(netdev, port.config);
277 translate_netdev_type_to_vport_type(&port);
279 error = do_ioctl(dpif, ODP_VPORT_ATTACH, &port);
281 *port_nop = port.port;
288 dpif_linux_port_del(struct dpif *dpif_, uint16_t port_no_)
290 int port_no = port_no_; /* Kernel expects an "int". */
291 return do_ioctl(dpif_, ODP_VPORT_DETACH, &port_no);
295 dpif_linux_port_query__(const struct dpif *dpif, uint32_t port_no,
296 const char *port_name, struct dpif_port *dpif_port)
298 struct odp_port odp_port;
301 memset(&odp_port, 0, sizeof odp_port);
302 odp_port.port = port_no;
303 strncpy(odp_port.devname, port_name, sizeof odp_port.devname);
305 error = do_ioctl(dpif, ODP_VPORT_QUERY, &odp_port);
308 } else if (odp_port.dp_idx != dpif_linux_cast(dpif)->minor) {
309 /* A vport named 'port_name' exists but in some other datapath. */
312 translate_vport_type_to_netdev_type(&odp_port);
313 dpif_port->name = xstrdup(odp_port.devname);
314 dpif_port->type = xstrdup(odp_port.type);
315 dpif_port->port_no = odp_port.port;
321 dpif_linux_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
322 struct dpif_port *dpif_port)
324 return dpif_linux_port_query__(dpif, port_no, "", dpif_port);
328 dpif_linux_port_query_by_name(const struct dpif *dpif, const char *devname,
329 struct dpif_port *dpif_port)
331 return dpif_linux_port_query__(dpif, 0, devname, dpif_port);
335 dpif_linux_flow_flush(struct dpif *dpif_)
337 return do_ioctl(dpif_, ODP_FLOW_FLUSH, NULL);
341 dpif_linux_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
343 *statep = xzalloc(sizeof(struct odp_port));
348 dpif_linux_port_dump_next(const struct dpif *dpif, void *state,
349 struct dpif_port *dpif_port)
351 struct odp_port *odp_port = state;
352 struct odp_vport_dump dump;
355 dump.port = odp_port;
356 dump.port_no = odp_port->port;
357 error = do_ioctl(dpif, ODP_VPORT_DUMP, &dump);
360 } else if (odp_port->devname[0] == '\0') {
363 translate_vport_type_to_netdev_type(odp_port);
364 dpif_port->name = odp_port->devname;
365 dpif_port->type = odp_port->type;
366 dpif_port->port_no = odp_port->port;
373 dpif_linux_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state)
380 dpif_linux_port_poll(const struct dpif *dpif_, char **devnamep)
382 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
384 if (dpif->change_error) {
385 dpif->change_error = false;
386 shash_clear(&dpif->changed_ports);
388 } else if (!shash_is_empty(&dpif->changed_ports)) {
389 struct shash_node *node = shash_first(&dpif->changed_ports);
390 *devnamep = shash_steal(&dpif->changed_ports, node);
398 dpif_linux_port_poll_wait(const struct dpif *dpif_)
400 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
401 if (!shash_is_empty(&dpif->changed_ports) || dpif->change_error) {
402 poll_immediate_wake();
404 rtnetlink_link_notifier_wait();
409 dpif_linux_flow_get(const struct dpif *dpif_, struct odp_flow flows[], int n)
411 struct odp_flowvec fv;
414 return do_ioctl(dpif_, ODP_FLOW_GET, &fv);
418 dpif_linux_flow_put(struct dpif *dpif_, struct odp_flow_put *put)
420 return do_ioctl(dpif_, ODP_FLOW_PUT, put);
424 dpif_linux_flow_del(struct dpif *dpif_, struct odp_flow *flow)
426 return do_ioctl(dpif_, ODP_FLOW_DEL, flow);
430 dpif_linux_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
432 *statep = xzalloc(sizeof(struct odp_flow_dump));
437 dpif_linux_flow_dump_next(const struct dpif *dpif, void *state,
438 struct odp_flow *flow)
440 struct odp_flow_dump *dump = state;
444 error = do_ioctl(dpif, ODP_FLOW_DUMP, dump);
445 return error ? error : flow->flags & ODPFF_EOF ? EOF : 0;
449 dpif_linux_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state)
456 dpif_linux_execute(struct dpif *dpif_,
457 const struct nlattr *actions, size_t actions_len,
458 const struct ofpbuf *buf)
460 struct odp_execute execute;
461 memset(&execute, 0, sizeof execute);
462 execute.actions = (struct nlattr *) actions;
463 execute.actions_len = actions_len;
464 execute.data = buf->data;
465 execute.length = buf->size;
466 return do_ioctl(dpif_, ODP_EXECUTE, &execute);
470 dpif_linux_recv_get_mask(const struct dpif *dpif_, int *listen_mask)
472 return do_ioctl(dpif_, ODP_GET_LISTEN_MASK, listen_mask);
476 dpif_linux_recv_set_mask(struct dpif *dpif_, int listen_mask)
478 return do_ioctl(dpif_, ODP_SET_LISTEN_MASK, &listen_mask);
482 dpif_linux_get_sflow_probability(const struct dpif *dpif_,
483 uint32_t *probability)
485 return do_ioctl(dpif_, ODP_GET_SFLOW_PROBABILITY, probability);
489 dpif_linux_set_sflow_probability(struct dpif *dpif_, uint32_t probability)
491 return do_ioctl(dpif_, ODP_SET_SFLOW_PROBABILITY, &probability);
495 dpif_linux_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
496 uint32_t queue_id, uint32_t *priority)
498 if (queue_id < 0xf000) {
499 *priority = TC_H_MAKE(1 << 16, queue_id + 1);
507 parse_odp_packet(struct ofpbuf *buf, struct dpif_upcall *upcall)
509 static const struct nl_policy odp_packet_policy[] = {
510 /* Always present. */
511 [ODP_PACKET_ATTR_TYPE] = { .type = NL_A_U32 },
512 [ODP_PACKET_ATTR_PACKET] = { .type = NL_A_UNSPEC,
513 .min_len = ETH_HEADER_LEN },
514 [ODP_PACKET_ATTR_KEY] = { .type = NL_A_NESTED },
516 /* _ODPL_ACTION_NR only. */
517 [ODP_PACKET_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
519 /* _ODPL_SFLOW_NR only. */
520 [ODP_PACKET_ATTR_SAMPLE_POOL] = { .type = NL_A_U32, .optional = true },
521 [ODP_PACKET_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
524 struct odp_packet *odp_packet = buf->data;
525 struct nlattr *a[ARRAY_SIZE(odp_packet_policy)];
527 if (!nl_policy_parse(buf, sizeof *odp_packet, odp_packet_policy,
528 a, ARRAY_SIZE(odp_packet_policy))) {
532 memset(upcall, 0, sizeof *upcall);
533 upcall->type = nl_attr_get_u32(a[ODP_PACKET_ATTR_TYPE]);
534 upcall->packet = buf;
535 upcall->packet->data = (void *) nl_attr_get(a[ODP_PACKET_ATTR_PACKET]);
536 upcall->packet->size = nl_attr_get_size(a[ODP_PACKET_ATTR_PACKET]);
537 upcall->key = (void *) nl_attr_get(a[ODP_PACKET_ATTR_KEY]);
538 upcall->key_len = nl_attr_get_size(a[ODP_PACKET_ATTR_KEY]);
539 upcall->userdata = (a[ODP_PACKET_ATTR_USERDATA]
540 ? nl_attr_get_u64(a[ODP_PACKET_ATTR_USERDATA])
542 upcall->sample_pool = (a[ODP_PACKET_ATTR_SAMPLE_POOL]
543 ? nl_attr_get_u32(a[ODP_PACKET_ATTR_SAMPLE_POOL])
545 if (a[ODP_PACKET_ATTR_ACTIONS]) {
546 upcall->actions = (void *) nl_attr_get(a[ODP_PACKET_ATTR_ACTIONS]);
547 upcall->actions_len = nl_attr_get_size(a[ODP_PACKET_ATTR_ACTIONS]);
554 dpif_linux_recv(struct dpif *dpif_, struct dpif_upcall *upcall)
556 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
561 buf = ofpbuf_new(65536);
562 retval = read(dpif->fd, ofpbuf_tail(buf), ofpbuf_tailroom(buf));
565 if (error != EAGAIN) {
566 VLOG_WARN_RL(&error_rl, "%s: read failed: %s",
567 dpif_name(dpif_), strerror(error));
569 } else if (retval >= sizeof(struct odp_packet)) {
570 struct odp_packet *odp_packet = buf->data;
573 if (odp_packet->len <= retval) {
574 error = parse_odp_packet(buf, upcall);
576 VLOG_WARN_RL(&error_rl, "%s: discarding message truncated "
577 "from %"PRIu32" bytes to %d",
578 dpif_name(dpif_), odp_packet->len, retval);
581 } else if (!retval) {
582 VLOG_WARN_RL(&error_rl, "%s: unexpected end of file", dpif_name(dpif_));
585 VLOG_WARN_RL(&error_rl, "%s: discarding too-short message (%d bytes)",
586 dpif_name(dpif_), retval);
597 dpif_linux_recv_wait(struct dpif *dpif_)
599 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
600 poll_fd_wait(dpif->fd, POLLIN);
603 const struct dpif_class dpif_linux_class = {
607 dpif_linux_enumerate,
610 dpif_linux_get_all_names,
612 dpif_linux_get_stats,
613 dpif_linux_get_drop_frags,
614 dpif_linux_set_drop_frags,
617 dpif_linux_port_query_by_number,
618 dpif_linux_port_query_by_name,
619 dpif_linux_port_dump_start,
620 dpif_linux_port_dump_next,
621 dpif_linux_port_dump_done,
622 dpif_linux_port_poll,
623 dpif_linux_port_poll_wait,
627 dpif_linux_flow_flush,
628 dpif_linux_flow_dump_start,
629 dpif_linux_flow_dump_next,
630 dpif_linux_flow_dump_done,
632 dpif_linux_recv_get_mask,
633 dpif_linux_recv_set_mask,
634 dpif_linux_get_sflow_probability,
635 dpif_linux_set_sflow_probability,
636 dpif_linux_queue_to_priority,
638 dpif_linux_recv_wait,
641 static int get_openvswitch_major(void);
642 static int get_major(const char *target);
645 do_ioctl(const struct dpif *dpif_, int cmd, const void *arg)
647 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
648 return ioctl(dpif->fd, cmd, arg) ? errno : 0;
652 lookup_internal_device(const char *name, int *dp_idx, int *port_no)
654 struct odp_port odp_port;
655 static int dp0_fd = -1;
661 error = make_openvswitch_device(0, &fn);
666 dp0_fd = open(fn, O_RDONLY | O_NONBLOCK);
668 VLOG_WARN_RL(&error_rl, "%s: open failed (%s)",
669 fn, strerror(errno));
676 memset(&odp_port, 0, sizeof odp_port);
677 strncpy(odp_port.devname, name, sizeof odp_port.devname);
678 if (ioctl(dp0_fd, ODP_VPORT_QUERY, &odp_port)) {
679 if (errno != ENODEV) {
680 VLOG_WARN_RL(&error_rl, "%s: vport query failed (%s)",
681 name, strerror(errno));
684 } else if (!strcmp(odp_port.type, "internal")) {
685 *dp_idx = odp_port.dp_idx;
686 *port_no = odp_port.port;
694 lookup_minor(const char *name, int *minorp)
699 error = lookup_internal_device(name, &minor, &port_no);
702 } else if (port_no != ODPP_LOCAL) {
703 /* This is an Open vSwitch device but not the local port. We
704 * intentionally support only using the name of the local port as the
705 * name of a datapath; otherwise, it would be too difficult to
706 * enumerate all the names of a datapath. */
715 dpif_linux_is_internal_device(const char *name)
719 return !lookup_internal_device(name, &minor, &port_no);
723 make_openvswitch_device(int minor, char **fnp)
725 const char dirname[] = "/dev/net";
733 major = get_openvswitch_major();
737 dev = makedev(major, minor);
739 sprintf(fn, "%s/dp%d", dirname, minor);
741 if (!S_ISCHR(s.st_mode)) {
742 VLOG_WARN_RL(&error_rl, "%s is not a character device, fixing",
744 } else if (s.st_rdev != dev) {
745 VLOG_WARN_RL(&error_rl,
746 "%s is device %u:%u but should be %u:%u, fixing",
747 fn, major(s.st_rdev), minor(s.st_rdev),
748 major(dev), minor(dev));
753 VLOG_WARN_RL(&error_rl, "%s: unlink failed (%s)",
754 fn, strerror(errno));
757 } else if (errno == ENOENT) {
758 if (stat(dirname, &s)) {
759 if (errno == ENOENT) {
760 if (mkdir(dirname, 0755)) {
761 VLOG_WARN_RL(&error_rl, "%s: mkdir failed (%s)",
762 dirname, strerror(errno));
766 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)",
767 dirname, strerror(errno));
772 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)", fn, strerror(errno));
776 /* The device needs to be created. */
777 if (mknod(fn, S_IFCHR | 0700, dev)) {
778 VLOG_WARN_RL(&error_rl,
779 "%s: creating character device %u:%u failed (%s)",
780 fn, major(dev), minor(dev), strerror(errno));
789 /* Return the major device number of the Open vSwitch device. If it
790 * cannot be determined, a negative errno is returned. */
792 get_openvswitch_major(void)
794 static int openvswitch_major = -1;
795 if (openvswitch_major < 0) {
796 openvswitch_major = get_major("openvswitch");
798 return openvswitch_major;
802 get_major(const char *target)
804 const char fn[] = "/proc/devices";
809 file = fopen(fn, "r");
811 VLOG_ERR("opening %s failed (%s)", fn, strerror(errno));
815 for (ln = 1; fgets(line, sizeof line, file); ln++) {
819 if (!strncmp(line, "Character", 9) || line[0] == '\0') {
821 } else if (!strncmp(line, "Block", 5)) {
822 /* We only want character devices, so skip the rest of the file. */
824 } else if (sscanf(line, "%d %63s", &major, name)) {
825 if (!strcmp(name, target)) {
830 VLOG_WARN_ONCE("%s:%d: syntax error", fn, ln);
836 VLOG_ERR("%s: %s major not found (is the module loaded?)", fn, target);
841 finish_open(struct dpif *dpif_, const char *local_ifname)
843 struct dpif_linux *dpif = dpif_linux_cast(dpif_);
844 dpif->local_ifname = xstrdup(local_ifname);
845 dpif->local_ifindex = if_nametoindex(local_ifname);
846 if (!dpif->local_ifindex) {
848 dpif_uninit(dpif_, true);
849 VLOG_WARN("could not get ifindex of %s device: %s",
850 local_ifname, strerror(errno));
857 create_minor(const char *name, int minor, struct dpif **dpifp)
859 int error = open_minor(minor, dpifp);
861 error = do_ioctl(*dpifp, ODP_DP_CREATE, name);
863 error = finish_open(*dpifp, name);
865 dpif_uninit(*dpifp, true);
872 open_minor(int minor, struct dpif **dpifp)
878 error = make_openvswitch_device(minor, &fn);
883 fd = open(fn, O_RDONLY | O_NONBLOCK);
885 struct dpif_linux *dpif = xmalloc(sizeof *dpif);
886 error = rtnetlink_link_notifier_register(&dpif->port_notifier,
887 dpif_linux_port_changed,
892 name = xasprintf("dp%d", minor);
893 dpif_init(&dpif->dpif, &dpif_linux_class, name, minor, minor);
897 dpif->local_ifname = NULL;
899 dpif->local_ifindex = 0;
900 shash_init(&dpif->changed_ports);
901 dpif->change_error = false;
902 *dpifp = &dpif->dpif;
908 VLOG_WARN("%s: open failed (%s)", fn, strerror(error));
916 dpif_linux_port_changed(const struct rtnetlink_link_change *change,
919 struct dpif_linux *dpif = dpif_;
922 if (change->master_ifindex == dpif->local_ifindex
923 && (change->nlmsg_type == RTM_NEWLINK
924 || change->nlmsg_type == RTM_DELLINK))
926 /* Our datapath changed, either adding a new port or deleting an
928 shash_add_once(&dpif->changed_ports, change->ifname, NULL);
931 dpif->change_error = true;