4 * Copyright (c) 2003-2008 Fabrice Bellard
5 * Copyright (c) 2009 Red Hat, Inc.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 #include "qemu/osdep.h"
30 #include <sys/ioctl.h>
32 #include <sys/socket.h>
37 #include "monitor/monitor.h"
38 #include "sysemu/sysemu.h"
39 #include "qapi/error.h"
40 #include "qemu-common.h"
41 #include "qemu/cutils.h"
42 #include "qemu/error-report.h"
46 #include "net/vhost_net.h"
48 typedef struct TAPState {
51 char down_script[1024];
52 char down_script_arg[128];
53 uint8_t buf[NET_BUFSIZE];
59 VHostNetState *vhost_net;
60 unsigned host_vnet_hdr_len;
64 static void launch_script(const char *setup_script, const char *ifname,
65 int fd, Error **errp);
67 static void tap_send(void *opaque);
68 static void tap_writable(void *opaque);
70 static void tap_update_fd_handler(TAPState *s)
72 qemu_set_fd_handler(s->fd,
73 s->read_poll && s->enabled ? tap_send : NULL,
74 s->write_poll && s->enabled ? tap_writable : NULL,
78 static void tap_read_poll(TAPState *s, bool enable)
80 s->read_poll = enable;
81 tap_update_fd_handler(s);
84 static void tap_write_poll(TAPState *s, bool enable)
86 s->write_poll = enable;
87 tap_update_fd_handler(s);
90 static void tap_writable(void *opaque)
94 tap_write_poll(s, false);
96 qemu_flush_queued_packets(&s->nc);
99 static ssize_t tap_write_packet(TAPState *s, const struct iovec *iov, int iovcnt)
104 len = writev(s->fd, iov, iovcnt);
105 } while (len == -1 && errno == EINTR);
107 if (len == -1 && errno == EAGAIN) {
108 tap_write_poll(s, true);
115 static ssize_t tap_receive_iov(NetClientState *nc, const struct iovec *iov,
118 TAPState *s = DO_UPCAST(TAPState, nc, nc);
119 const struct iovec *iovp = iov;
120 struct iovec iov_copy[iovcnt + 1];
121 struct virtio_net_hdr_mrg_rxbuf hdr = { };
123 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
124 iov_copy[0].iov_base = &hdr;
125 iov_copy[0].iov_len = s->host_vnet_hdr_len;
126 memcpy(&iov_copy[1], iov, iovcnt * sizeof(*iov));
131 return tap_write_packet(s, iovp, iovcnt);
134 static ssize_t tap_receive_raw(NetClientState *nc, const uint8_t *buf, size_t size)
136 TAPState *s = DO_UPCAST(TAPState, nc, nc);
139 struct virtio_net_hdr_mrg_rxbuf hdr = { };
141 if (s->host_vnet_hdr_len) {
142 iov[iovcnt].iov_base = &hdr;
143 iov[iovcnt].iov_len = s->host_vnet_hdr_len;
147 iov[iovcnt].iov_base = (char *)buf;
148 iov[iovcnt].iov_len = size;
151 return tap_write_packet(s, iov, iovcnt);
154 static ssize_t tap_receive(NetClientState *nc, const uint8_t *buf, size_t size)
156 TAPState *s = DO_UPCAST(TAPState, nc, nc);
159 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
160 return tap_receive_raw(nc, buf, size);
163 iov[0].iov_base = (char *)buf;
164 iov[0].iov_len = size;
166 return tap_write_packet(s, iov, 1);
170 ssize_t tap_read_packet(int tapfd, uint8_t *buf, int maxlen)
172 return read(tapfd, buf, maxlen);
176 static void tap_send_completed(NetClientState *nc, ssize_t len)
178 TAPState *s = DO_UPCAST(TAPState, nc, nc);
179 tap_read_poll(s, true);
182 static void tap_send(void *opaque)
184 TAPState *s = opaque;
189 uint8_t *buf = s->buf;
191 size = tap_read_packet(s->fd, s->buf, sizeof(s->buf));
196 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
197 buf += s->host_vnet_hdr_len;
198 size -= s->host_vnet_hdr_len;
201 size = qemu_send_packet_async(&s->nc, buf, size, tap_send_completed);
203 tap_read_poll(s, false);
205 } else if (size < 0) {
210 * When the host keeps receiving more packets while tap_send() is
211 * running we can hog the QEMU global mutex. Limit the number of
212 * packets that are processed per tap_send() callback to prevent
213 * stalling the guest.
222 static bool tap_has_ufo(NetClientState *nc)
224 TAPState *s = DO_UPCAST(TAPState, nc, nc);
226 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
231 static bool tap_has_vnet_hdr(NetClientState *nc)
233 TAPState *s = DO_UPCAST(TAPState, nc, nc);
235 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
237 return !!s->host_vnet_hdr_len;
240 static bool tap_has_vnet_hdr_len(NetClientState *nc, int len)
242 TAPState *s = DO_UPCAST(TAPState, nc, nc);
244 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
246 return !!tap_probe_vnet_hdr_len(s->fd, len);
249 static void tap_set_vnet_hdr_len(NetClientState *nc, int len)
251 TAPState *s = DO_UPCAST(TAPState, nc, nc);
253 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
254 assert(len == sizeof(struct virtio_net_hdr_mrg_rxbuf) ||
255 len == sizeof(struct virtio_net_hdr));
257 tap_fd_set_vnet_hdr_len(s->fd, len);
258 s->host_vnet_hdr_len = len;
261 static void tap_using_vnet_hdr(NetClientState *nc, bool using_vnet_hdr)
263 TAPState *s = DO_UPCAST(TAPState, nc, nc);
265 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
266 assert(!!s->host_vnet_hdr_len == using_vnet_hdr);
268 s->using_vnet_hdr = using_vnet_hdr;
271 static int tap_set_vnet_le(NetClientState *nc, bool is_le)
273 TAPState *s = DO_UPCAST(TAPState, nc, nc);
275 return tap_fd_set_vnet_le(s->fd, is_le);
278 static int tap_set_vnet_be(NetClientState *nc, bool is_be)
280 TAPState *s = DO_UPCAST(TAPState, nc, nc);
282 return tap_fd_set_vnet_be(s->fd, is_be);
285 static void tap_set_offload(NetClientState *nc, int csum, int tso4,
286 int tso6, int ecn, int ufo)
288 TAPState *s = DO_UPCAST(TAPState, nc, nc);
293 tap_fd_set_offload(s->fd, csum, tso4, tso6, ecn, ufo);
296 static void tap_exit_notify(Notifier *notifier, void *data)
298 TAPState *s = container_of(notifier, TAPState, exit);
301 if (s->down_script[0]) {
302 launch_script(s->down_script, s->down_script_arg, s->fd, &err);
304 error_report_err(err);
309 static void tap_cleanup(NetClientState *nc)
311 TAPState *s = DO_UPCAST(TAPState, nc, nc);
314 vhost_net_cleanup(s->vhost_net);
315 g_free(s->vhost_net);
319 qemu_purge_queued_packets(nc);
321 tap_exit_notify(&s->exit, NULL);
322 qemu_remove_exit_notifier(&s->exit);
324 tap_read_poll(s, false);
325 tap_write_poll(s, false);
330 static void tap_poll(NetClientState *nc, bool enable)
332 TAPState *s = DO_UPCAST(TAPState, nc, nc);
333 tap_read_poll(s, enable);
334 tap_write_poll(s, enable);
337 int tap_get_fd(NetClientState *nc)
339 TAPState *s = DO_UPCAST(TAPState, nc, nc);
340 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
346 static NetClientInfo net_tap_info = {
347 .type = NET_CLIENT_DRIVER_TAP,
348 .size = sizeof(TAPState),
349 .receive = tap_receive,
350 .receive_raw = tap_receive_raw,
351 .receive_iov = tap_receive_iov,
353 .cleanup = tap_cleanup,
354 .has_ufo = tap_has_ufo,
355 .has_vnet_hdr = tap_has_vnet_hdr,
356 .has_vnet_hdr_len = tap_has_vnet_hdr_len,
357 .using_vnet_hdr = tap_using_vnet_hdr,
358 .set_offload = tap_set_offload,
359 .set_vnet_hdr_len = tap_set_vnet_hdr_len,
360 .set_vnet_le = tap_set_vnet_le,
361 .set_vnet_be = tap_set_vnet_be,
364 static TAPState *net_tap_fd_init(NetClientState *peer,
373 nc = qemu_new_net_client(&net_tap_info, peer, model, name);
375 s = DO_UPCAST(TAPState, nc, nc);
378 s->host_vnet_hdr_len = vnet_hdr ? sizeof(struct virtio_net_hdr) : 0;
379 s->using_vnet_hdr = false;
380 s->has_ufo = tap_probe_has_ufo(s->fd);
382 tap_set_offload(&s->nc, 0, 0, 0, 0, 0);
384 * Make sure host header length is set correctly in tap:
385 * it might have been modified by another instance of qemu.
387 if (tap_probe_vnet_hdr_len(s->fd, s->host_vnet_hdr_len)) {
388 tap_fd_set_vnet_hdr_len(s->fd, s->host_vnet_hdr_len);
390 tap_read_poll(s, true);
393 s->exit.notify = tap_exit_notify;
394 qemu_add_exit_notifier(&s->exit);
399 static void launch_script(const char *setup_script, const char *ifname,
400 int fd, Error **errp)
406 /* try to launch network script */
409 error_setg_errno(errp, errno, "could not launch network script %s",
414 int open_max = sysconf(_SC_OPEN_MAX), i;
416 for (i = 3; i < open_max; i++) {
422 *parg++ = (char *)setup_script;
423 *parg++ = (char *)ifname;
425 execv(setup_script, args);
428 while (waitpid(pid, &status, 0) != pid) {
432 if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
435 error_setg(errp, "network script %s failed with status %d",
436 setup_script, status);
440 static int recv_fd(int c)
443 uint8_t msgbuf[CMSG_SPACE(sizeof(fd))];
444 struct msghdr msg = {
445 .msg_control = msgbuf,
446 .msg_controllen = sizeof(msgbuf),
448 struct cmsghdr *cmsg;
453 cmsg = CMSG_FIRSTHDR(&msg);
454 cmsg->cmsg_level = SOL_SOCKET;
455 cmsg->cmsg_type = SCM_RIGHTS;
456 cmsg->cmsg_len = CMSG_LEN(sizeof(fd));
457 msg.msg_controllen = cmsg->cmsg_len;
460 iov.iov_len = sizeof(req);
465 len = recvmsg(c, &msg, 0);
467 memcpy(&fd, CMSG_DATA(cmsg), sizeof(fd));
474 static int net_bridge_run_helper(const char *helper, const char *bridge,
477 sigset_t oldmask, mask;
484 sigaddset(&mask, SIGCHLD);
485 sigprocmask(SIG_BLOCK, &mask, &oldmask);
487 if (socketpair(PF_UNIX, SOCK_STREAM, 0, sv) == -1) {
488 error_setg_errno(errp, errno, "socketpair() failed");
492 /* try to launch bridge helper */
495 error_setg_errno(errp, errno, "Can't fork bridge helper");
499 int open_max = sysconf(_SC_OPEN_MAX), i;
501 char br_buf[6+IFNAMSIZ] = {0};
502 char helper_cmd[PATH_MAX + sizeof(fd_buf) + sizeof(br_buf) + 15];
504 for (i = 3; i < open_max; i++) {
510 snprintf(fd_buf, sizeof(fd_buf), "%s%d", "--fd=", sv[1]);
512 if (strrchr(helper, ' ') || strrchr(helper, '\t')) {
513 /* assume helper is a command */
515 if (strstr(helper, "--br=") == NULL) {
516 snprintf(br_buf, sizeof(br_buf), "%s%s", "--br=", bridge);
519 snprintf(helper_cmd, sizeof(helper_cmd), "%s %s %s %s",
520 helper, "--use-vnet", fd_buf, br_buf);
523 *parg++ = (char *)"sh";
524 *parg++ = (char *)"-c";
525 *parg++ = helper_cmd;
528 execv("/bin/sh", args);
530 /* assume helper is just the executable path name */
532 snprintf(br_buf, sizeof(br_buf), "%s%s", "--br=", bridge);
535 *parg++ = (char *)helper;
536 *parg++ = (char *)"--use-vnet";
553 } while (fd == -1 && errno == EINTR);
558 while (waitpid(pid, &status, 0) != pid) {
561 sigprocmask(SIG_SETMASK, &oldmask, NULL);
563 error_setg_errno(errp, saved_errno,
564 "failed to recv file descriptor");
567 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
568 error_setg(errp, "bridge helper failed");
575 int net_init_bridge(const Netdev *netdev, const char *name,
576 NetClientState *peer, Error **errp)
578 const NetdevBridgeOptions *bridge;
579 const char *helper, *br;
583 assert(netdev->type == NET_CLIENT_DRIVER_BRIDGE);
584 bridge = &netdev->u.bridge;
586 helper = bridge->has_helper ? bridge->helper : DEFAULT_BRIDGE_HELPER;
587 br = bridge->has_br ? bridge->br : DEFAULT_BRIDGE_INTERFACE;
589 fd = net_bridge_run_helper(helper, br, errp);
594 fcntl(fd, F_SETFL, O_NONBLOCK);
595 vnet_hdr = tap_probe_vnet_hdr(fd);
596 s = net_tap_fd_init(peer, "bridge", name, fd, vnet_hdr);
598 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "helper=%s,br=%s", helper,
604 static int net_tap_init(const NetdevTapOptions *tap, int *vnet_hdr,
605 const char *setup_script, char *ifname,
606 size_t ifname_sz, int mq_required, Error **errp)
609 int fd, vnet_hdr_required;
611 if (tap->has_vnet_hdr) {
612 *vnet_hdr = tap->vnet_hdr;
613 vnet_hdr_required = *vnet_hdr;
616 vnet_hdr_required = 0;
619 TFR(fd = tap_open(ifname, ifname_sz, vnet_hdr, vnet_hdr_required,
626 setup_script[0] != '\0' &&
627 strcmp(setup_script, "no") != 0) {
628 launch_script(setup_script, ifname, fd, &err);
630 error_propagate(errp, err);
639 #define MAX_TAP_QUEUES 1024
641 static void net_init_tap_one(const NetdevTapOptions *tap, NetClientState *peer,
642 const char *model, const char *name,
643 const char *ifname, const char *script,
644 const char *downscript, const char *vhostfdname,
645 int vnet_hdr, int fd, Error **errp)
648 TAPState *s = net_tap_fd_init(peer, model, name, fd, vnet_hdr);
651 tap_set_sndbuf(s->fd, tap, &err);
653 error_propagate(errp, err);
657 if (tap->has_fd || tap->has_fds) {
658 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "fd=%d", fd);
659 } else if (tap->has_helper) {
660 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "helper=%s",
663 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
664 "ifname=%s,script=%s,downscript=%s", ifname, script,
667 if (strcmp(downscript, "no") != 0) {
668 snprintf(s->down_script, sizeof(s->down_script), "%s", downscript);
669 snprintf(s->down_script_arg, sizeof(s->down_script_arg),
674 if (tap->has_vhost ? tap->vhost :
675 vhostfdname || (tap->has_vhostforce && tap->vhostforce)) {
676 VhostNetOptions options;
678 options.backend_type = VHOST_BACKEND_TYPE_KERNEL;
679 options.net_backend = &s->nc;
680 if (tap->has_poll_us) {
681 options.busyloop_timeout = tap->poll_us;
683 options.busyloop_timeout = 0;
687 vhostfd = monitor_fd_param(cur_mon, vhostfdname, &err);
689 error_propagate(errp, err);
693 vhostfd = open("/dev/vhost-net", O_RDWR);
695 error_setg_errno(errp, errno,
696 "tap: open vhost char device failed");
699 fcntl(vhostfd, F_SETFL, O_NONBLOCK);
701 options.opaque = (void *)(uintptr_t)vhostfd;
703 s->vhost_net = vhost_net_init(&options);
706 "vhost-net requested but could not be initialized");
709 } else if (vhostfdname) {
710 error_setg(errp, "vhostfd(s)= is not valid without vhost");
714 static int get_fds(char *str, char *fds[], int max)
716 char *ptr = str, *this;
717 size_t len = strlen(str);
720 while (i < max && ptr < str + len) {
721 this = strchr(ptr, ':');
724 fds[i] = g_strdup(ptr);
726 fds[i] = g_strndup(ptr, this - ptr);
740 int net_init_tap(const Netdev *netdev, const char *name,
741 NetClientState *peer, Error **errp)
743 const NetdevTapOptions *tap;
744 int fd, vnet_hdr = 0, i = 0, queues;
745 /* for the no-fd, no-helper case */
746 const char *script = NULL; /* suppress wrong "uninit'd use" gcc warning */
747 const char *downscript = NULL;
749 const char *vhostfdname;
752 assert(netdev->type == NET_CLIENT_DRIVER_TAP);
753 tap = &netdev->u.tap;
754 queues = tap->has_queues ? tap->queues : 1;
755 vhostfdname = tap->has_vhostfd ? tap->vhostfd : NULL;
757 /* QEMU vlans does not support multiqueue tap, in this case peer is set.
758 * For -netdev, peer is always NULL. */
759 if (peer && (tap->has_queues || tap->has_fds || tap->has_vhostfds)) {
760 error_setg(errp, "Multiqueue tap cannot be used with QEMU vlans");
765 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
766 tap->has_vnet_hdr || tap->has_helper || tap->has_queues ||
767 tap->has_fds || tap->has_vhostfds) {
768 error_setg(errp, "ifname=, script=, downscript=, vnet_hdr=, "
769 "helper=, queues=, fds=, and vhostfds= "
770 "are invalid with fd=");
774 fd = monitor_fd_param(cur_mon, tap->fd, &err);
776 error_propagate(errp, err);
780 fcntl(fd, F_SETFL, O_NONBLOCK);
782 vnet_hdr = tap_probe_vnet_hdr(fd);
784 net_init_tap_one(tap, peer, "tap", name, NULL,
786 vhostfdname, vnet_hdr, fd, &err);
788 error_propagate(errp, err);
791 } else if (tap->has_fds) {
796 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
797 tap->has_vnet_hdr || tap->has_helper || tap->has_queues ||
799 error_setg(errp, "ifname=, script=, downscript=, vnet_hdr=, "
800 "helper=, queues=, and vhostfd= "
801 "are invalid with fds=");
805 fds = g_new0(char *, MAX_TAP_QUEUES);
806 vhost_fds = g_new0(char *, MAX_TAP_QUEUES);
808 nfds = get_fds(tap->fds, fds, MAX_TAP_QUEUES);
809 if (tap->has_vhostfds) {
810 nvhosts = get_fds(tap->vhostfds, vhost_fds, MAX_TAP_QUEUES);
811 if (nfds != nvhosts) {
812 error_setg(errp, "The number of fds passed does not match "
813 "the number of vhostfds passed");
818 for (i = 0; i < nfds; i++) {
819 fd = monitor_fd_param(cur_mon, fds[i], &err);
821 error_propagate(errp, err);
825 fcntl(fd, F_SETFL, O_NONBLOCK);
828 vnet_hdr = tap_probe_vnet_hdr(fd);
829 } else if (vnet_hdr != tap_probe_vnet_hdr(fd)) {
831 "vnet_hdr not consistent across given tap fds");
835 net_init_tap_one(tap, peer, "tap", name, ifname,
837 tap->has_vhostfds ? vhost_fds[i] : NULL,
840 error_propagate(errp, err);
849 for (i = 0; i < nfds; i++) {
851 g_free(vhost_fds[i]);
856 } else if (tap->has_helper) {
857 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
858 tap->has_vnet_hdr || tap->has_queues || tap->has_vhostfds) {
859 error_setg(errp, "ifname=, script=, downscript=, vnet_hdr=, "
860 "queues=, and vhostfds= are invalid with helper=");
864 fd = net_bridge_run_helper(tap->helper,
866 tap->br : DEFAULT_BRIDGE_INTERFACE,
872 fcntl(fd, F_SETFL, O_NONBLOCK);
873 vnet_hdr = tap_probe_vnet_hdr(fd);
875 net_init_tap_one(tap, peer, "bridge", name, ifname,
876 script, downscript, vhostfdname,
879 error_propagate(errp, err);
884 if (tap->has_vhostfds) {
885 error_setg(errp, "vhostfds= is invalid if fds= wasn't specified");
888 script = tap->has_script ? tap->script : DEFAULT_NETWORK_SCRIPT;
889 downscript = tap->has_downscript ? tap->downscript :
890 DEFAULT_NETWORK_DOWN_SCRIPT;
892 if (tap->has_ifname) {
893 pstrcpy(ifname, sizeof ifname, tap->ifname);
898 for (i = 0; i < queues; i++) {
899 fd = net_tap_init(tap, &vnet_hdr, i >= 1 ? "no" : script,
900 ifname, sizeof ifname, queues > 1, errp);
905 if (queues > 1 && i == 0 && !tap->has_ifname) {
906 if (tap_fd_get_ifname(fd, ifname)) {
907 error_setg(errp, "Fail to get ifname");
913 net_init_tap_one(tap, peer, "tap", name, ifname,
914 i >= 1 ? "no" : script,
915 i >= 1 ? "no" : downscript,
916 vhostfdname, vnet_hdr, fd, &err);
918 error_propagate(errp, err);
928 VHostNetState *tap_get_vhost_net(NetClientState *nc)
930 TAPState *s = DO_UPCAST(TAPState, nc, nc);
931 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
935 int tap_enable(NetClientState *nc)
937 TAPState *s = DO_UPCAST(TAPState, nc, nc);
943 ret = tap_fd_enable(s->fd);
946 tap_update_fd_handler(s);
952 int tap_disable(NetClientState *nc)
954 TAPState *s = DO_UPCAST(TAPState, nc, nc);
957 if (s->enabled == 0) {
960 ret = tap_fd_disable(s->fd);
962 qemu_purge_queued_packets(nc);
964 tap_update_fd_handler(s);