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"
43 #include "qemu/main-loop.h"
44 #include "qemu/sockets.h"
48 #include "net/vhost_net.h"
50 typedef struct TAPState {
53 char down_script[1024];
54 char down_script_arg[128];
55 uint8_t buf[NET_BUFSIZE];
61 VHostNetState *vhost_net;
62 unsigned host_vnet_hdr_len;
66 static void launch_script(const char *setup_script, const char *ifname,
67 int fd, Error **errp);
69 static void tap_send(void *opaque);
70 static void tap_writable(void *opaque);
72 static void tap_update_fd_handler(TAPState *s)
74 qemu_set_fd_handler(s->fd,
75 s->read_poll && s->enabled ? tap_send : NULL,
76 s->write_poll && s->enabled ? tap_writable : NULL,
80 static void tap_read_poll(TAPState *s, bool enable)
82 s->read_poll = enable;
83 tap_update_fd_handler(s);
86 static void tap_write_poll(TAPState *s, bool enable)
88 s->write_poll = enable;
89 tap_update_fd_handler(s);
92 static void tap_writable(void *opaque)
96 tap_write_poll(s, false);
98 qemu_flush_queued_packets(&s->nc);
101 static ssize_t tap_write_packet(TAPState *s, const struct iovec *iov, int iovcnt)
106 len = writev(s->fd, iov, iovcnt);
107 } while (len == -1 && errno == EINTR);
109 if (len == -1 && errno == EAGAIN) {
110 tap_write_poll(s, true);
117 static ssize_t tap_receive_iov(NetClientState *nc, const struct iovec *iov,
120 TAPState *s = DO_UPCAST(TAPState, nc, nc);
121 const struct iovec *iovp = iov;
122 struct iovec iov_copy[iovcnt + 1];
123 struct virtio_net_hdr_mrg_rxbuf hdr = { };
125 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
126 iov_copy[0].iov_base = &hdr;
127 iov_copy[0].iov_len = s->host_vnet_hdr_len;
128 memcpy(&iov_copy[1], iov, iovcnt * sizeof(*iov));
133 return tap_write_packet(s, iovp, iovcnt);
136 static ssize_t tap_receive_raw(NetClientState *nc, const uint8_t *buf, size_t size)
138 TAPState *s = DO_UPCAST(TAPState, nc, nc);
141 struct virtio_net_hdr_mrg_rxbuf hdr = { };
143 if (s->host_vnet_hdr_len) {
144 iov[iovcnt].iov_base = &hdr;
145 iov[iovcnt].iov_len = s->host_vnet_hdr_len;
149 iov[iovcnt].iov_base = (char *)buf;
150 iov[iovcnt].iov_len = size;
153 return tap_write_packet(s, iov, iovcnt);
156 static ssize_t tap_receive(NetClientState *nc, const uint8_t *buf, size_t size)
158 TAPState *s = DO_UPCAST(TAPState, nc, nc);
161 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
162 return tap_receive_raw(nc, buf, size);
165 iov[0].iov_base = (char *)buf;
166 iov[0].iov_len = size;
168 return tap_write_packet(s, iov, 1);
172 ssize_t tap_read_packet(int tapfd, uint8_t *buf, int maxlen)
174 return read(tapfd, buf, maxlen);
178 static void tap_send_completed(NetClientState *nc, ssize_t len)
180 TAPState *s = DO_UPCAST(TAPState, nc, nc);
181 tap_read_poll(s, true);
184 static void tap_send(void *opaque)
186 TAPState *s = opaque;
191 uint8_t *buf = s->buf;
193 size = tap_read_packet(s->fd, s->buf, sizeof(s->buf));
198 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
199 buf += s->host_vnet_hdr_len;
200 size -= s->host_vnet_hdr_len;
203 size = qemu_send_packet_async(&s->nc, buf, size, tap_send_completed);
205 tap_read_poll(s, false);
207 } else if (size < 0) {
212 * When the host keeps receiving more packets while tap_send() is
213 * running we can hog the QEMU global mutex. Limit the number of
214 * packets that are processed per tap_send() callback to prevent
215 * stalling the guest.
224 static bool tap_has_ufo(NetClientState *nc)
226 TAPState *s = DO_UPCAST(TAPState, nc, nc);
228 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
233 static bool tap_has_vnet_hdr(NetClientState *nc)
235 TAPState *s = DO_UPCAST(TAPState, nc, nc);
237 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
239 return !!s->host_vnet_hdr_len;
242 static bool tap_has_vnet_hdr_len(NetClientState *nc, int len)
244 TAPState *s = DO_UPCAST(TAPState, nc, nc);
246 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
248 return !!tap_probe_vnet_hdr_len(s->fd, len);
251 static void tap_set_vnet_hdr_len(NetClientState *nc, int len)
253 TAPState *s = DO_UPCAST(TAPState, nc, nc);
255 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
256 assert(len == sizeof(struct virtio_net_hdr_mrg_rxbuf) ||
257 len == sizeof(struct virtio_net_hdr));
259 tap_fd_set_vnet_hdr_len(s->fd, len);
260 s->host_vnet_hdr_len = len;
263 static void tap_using_vnet_hdr(NetClientState *nc, bool using_vnet_hdr)
265 TAPState *s = DO_UPCAST(TAPState, nc, nc);
267 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
268 assert(!!s->host_vnet_hdr_len == using_vnet_hdr);
270 s->using_vnet_hdr = using_vnet_hdr;
273 static int tap_set_vnet_le(NetClientState *nc, bool is_le)
275 TAPState *s = DO_UPCAST(TAPState, nc, nc);
277 return tap_fd_set_vnet_le(s->fd, is_le);
280 static int tap_set_vnet_be(NetClientState *nc, bool is_be)
282 TAPState *s = DO_UPCAST(TAPState, nc, nc);
284 return tap_fd_set_vnet_be(s->fd, is_be);
287 static void tap_set_offload(NetClientState *nc, int csum, int tso4,
288 int tso6, int ecn, int ufo)
290 TAPState *s = DO_UPCAST(TAPState, nc, nc);
295 tap_fd_set_offload(s->fd, csum, tso4, tso6, ecn, ufo);
298 static void tap_exit_notify(Notifier *notifier, void *data)
300 TAPState *s = container_of(notifier, TAPState, exit);
303 if (s->down_script[0]) {
304 launch_script(s->down_script, s->down_script_arg, s->fd, &err);
306 error_report_err(err);
311 static void tap_cleanup(NetClientState *nc)
313 TAPState *s = DO_UPCAST(TAPState, nc, nc);
316 vhost_net_cleanup(s->vhost_net);
317 g_free(s->vhost_net);
321 qemu_purge_queued_packets(nc);
323 tap_exit_notify(&s->exit, NULL);
324 qemu_remove_exit_notifier(&s->exit);
326 tap_read_poll(s, false);
327 tap_write_poll(s, false);
332 static void tap_poll(NetClientState *nc, bool enable)
334 TAPState *s = DO_UPCAST(TAPState, nc, nc);
335 tap_read_poll(s, enable);
336 tap_write_poll(s, enable);
339 int tap_get_fd(NetClientState *nc)
341 TAPState *s = DO_UPCAST(TAPState, nc, nc);
342 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
348 static NetClientInfo net_tap_info = {
349 .type = NET_CLIENT_DRIVER_TAP,
350 .size = sizeof(TAPState),
351 .receive = tap_receive,
352 .receive_raw = tap_receive_raw,
353 .receive_iov = tap_receive_iov,
355 .cleanup = tap_cleanup,
356 .has_ufo = tap_has_ufo,
357 .has_vnet_hdr = tap_has_vnet_hdr,
358 .has_vnet_hdr_len = tap_has_vnet_hdr_len,
359 .using_vnet_hdr = tap_using_vnet_hdr,
360 .set_offload = tap_set_offload,
361 .set_vnet_hdr_len = tap_set_vnet_hdr_len,
362 .set_vnet_le = tap_set_vnet_le,
363 .set_vnet_be = tap_set_vnet_be,
366 static TAPState *net_tap_fd_init(NetClientState *peer,
375 nc = qemu_new_net_client(&net_tap_info, peer, model, name);
377 s = DO_UPCAST(TAPState, nc, nc);
380 s->host_vnet_hdr_len = vnet_hdr ? sizeof(struct virtio_net_hdr) : 0;
381 s->using_vnet_hdr = false;
382 s->has_ufo = tap_probe_has_ufo(s->fd);
384 tap_set_offload(&s->nc, 0, 0, 0, 0, 0);
386 * Make sure host header length is set correctly in tap:
387 * it might have been modified by another instance of qemu.
389 if (tap_probe_vnet_hdr_len(s->fd, s->host_vnet_hdr_len)) {
390 tap_fd_set_vnet_hdr_len(s->fd, s->host_vnet_hdr_len);
392 tap_read_poll(s, true);
395 s->exit.notify = tap_exit_notify;
396 qemu_add_exit_notifier(&s->exit);
401 static void launch_script(const char *setup_script, const char *ifname,
402 int fd, Error **errp)
408 /* try to launch network script */
411 error_setg_errno(errp, errno, "could not launch network script %s",
416 int open_max = sysconf(_SC_OPEN_MAX), i;
418 for (i = 3; i < open_max; i++) {
424 *parg++ = (char *)setup_script;
425 *parg++ = (char *)ifname;
427 execv(setup_script, args);
430 while (waitpid(pid, &status, 0) != pid) {
434 if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
437 error_setg(errp, "network script %s failed with status %d",
438 setup_script, status);
442 static int recv_fd(int c)
445 uint8_t msgbuf[CMSG_SPACE(sizeof(fd))];
446 struct msghdr msg = {
447 .msg_control = msgbuf,
448 .msg_controllen = sizeof(msgbuf),
450 struct cmsghdr *cmsg;
455 cmsg = CMSG_FIRSTHDR(&msg);
456 cmsg->cmsg_level = SOL_SOCKET;
457 cmsg->cmsg_type = SCM_RIGHTS;
458 cmsg->cmsg_len = CMSG_LEN(sizeof(fd));
459 msg.msg_controllen = cmsg->cmsg_len;
462 iov.iov_len = sizeof(req);
467 len = recvmsg(c, &msg, 0);
469 memcpy(&fd, CMSG_DATA(cmsg), sizeof(fd));
476 static int net_bridge_run_helper(const char *helper, const char *bridge,
479 sigset_t oldmask, mask;
486 sigaddset(&mask, SIGCHLD);
487 sigprocmask(SIG_BLOCK, &mask, &oldmask);
489 if (socketpair(PF_UNIX, SOCK_STREAM, 0, sv) == -1) {
490 error_setg_errno(errp, errno, "socketpair() failed");
494 /* try to launch bridge helper */
497 error_setg_errno(errp, errno, "Can't fork bridge helper");
501 int open_max = sysconf(_SC_OPEN_MAX), i;
504 char *helper_cmd = NULL;
506 for (i = 3; i < open_max; i++) {
512 fd_buf = g_strdup_printf("%s%d", "--fd=", sv[1]);
514 if (strrchr(helper, ' ') || strrchr(helper, '\t')) {
515 /* assume helper is a command */
517 if (strstr(helper, "--br=") == NULL) {
518 br_buf = g_strdup_printf("%s%s", "--br=", bridge);
521 helper_cmd = g_strdup_printf("%s %s %s %s", helper,
522 "--use-vnet", fd_buf, br_buf ? br_buf : "");
525 *parg++ = (char *)"sh";
526 *parg++ = (char *)"-c";
527 *parg++ = helper_cmd;
530 execv("/bin/sh", args);
533 /* assume helper is just the executable path name */
535 br_buf = g_strdup_printf("%s%s", "--br=", bridge);
538 *parg++ = (char *)helper;
539 *parg++ = (char *)"--use-vnet";
558 } while (fd == -1 && errno == EINTR);
563 while (waitpid(pid, &status, 0) != pid) {
566 sigprocmask(SIG_SETMASK, &oldmask, NULL);
568 error_setg_errno(errp, saved_errno,
569 "failed to recv file descriptor");
572 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
573 error_setg(errp, "bridge helper failed");
580 int net_init_bridge(const Netdev *netdev, const char *name,
581 NetClientState *peer, Error **errp)
583 const NetdevBridgeOptions *bridge;
584 const char *helper, *br;
588 assert(netdev->type == NET_CLIENT_DRIVER_BRIDGE);
589 bridge = &netdev->u.bridge;
591 helper = bridge->has_helper ? bridge->helper : DEFAULT_BRIDGE_HELPER;
592 br = bridge->has_br ? bridge->br : DEFAULT_BRIDGE_INTERFACE;
594 fd = net_bridge_run_helper(helper, br, errp);
599 qemu_set_nonblock(fd);
600 vnet_hdr = tap_probe_vnet_hdr(fd);
601 s = net_tap_fd_init(peer, "bridge", name, fd, vnet_hdr);
603 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "helper=%s,br=%s", helper,
609 static int net_tap_init(const NetdevTapOptions *tap, int *vnet_hdr,
610 const char *setup_script, char *ifname,
611 size_t ifname_sz, int mq_required, Error **errp)
614 int fd, vnet_hdr_required;
616 if (tap->has_vnet_hdr) {
617 *vnet_hdr = tap->vnet_hdr;
618 vnet_hdr_required = *vnet_hdr;
621 vnet_hdr_required = 0;
624 TFR(fd = tap_open(ifname, ifname_sz, vnet_hdr, vnet_hdr_required,
631 setup_script[0] != '\0' &&
632 strcmp(setup_script, "no") != 0) {
633 launch_script(setup_script, ifname, fd, &err);
635 error_propagate(errp, err);
644 #define MAX_TAP_QUEUES 1024
646 static void net_init_tap_one(const NetdevTapOptions *tap, NetClientState *peer,
647 const char *model, const char *name,
648 const char *ifname, const char *script,
649 const char *downscript, const char *vhostfdname,
650 int vnet_hdr, int fd, Error **errp)
653 TAPState *s = net_tap_fd_init(peer, model, name, fd, vnet_hdr);
656 tap_set_sndbuf(s->fd, tap, &err);
658 error_propagate(errp, err);
662 if (tap->has_fd || tap->has_fds) {
663 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "fd=%d", fd);
664 } else if (tap->has_helper) {
665 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "helper=%s",
668 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
669 "ifname=%s,script=%s,downscript=%s", ifname, script,
672 if (strcmp(downscript, "no") != 0) {
673 snprintf(s->down_script, sizeof(s->down_script), "%s", downscript);
674 snprintf(s->down_script_arg, sizeof(s->down_script_arg),
679 if (tap->has_vhost ? tap->vhost :
680 vhostfdname || (tap->has_vhostforce && tap->vhostforce)) {
681 VhostNetOptions options;
683 options.backend_type = VHOST_BACKEND_TYPE_KERNEL;
684 options.net_backend = &s->nc;
685 if (tap->has_poll_us) {
686 options.busyloop_timeout = tap->poll_us;
688 options.busyloop_timeout = 0;
692 vhostfd = monitor_fd_param(cur_mon, vhostfdname, &err);
694 if (tap->has_vhostforce && tap->vhostforce) {
695 error_propagate(errp, err);
697 warn_report_err(err);
701 qemu_set_nonblock(vhostfd);
703 vhostfd = open("/dev/vhost-net", O_RDWR);
705 if (tap->has_vhostforce && tap->vhostforce) {
706 error_setg_errno(errp, errno,
707 "tap: open vhost char device failed");
709 warn_report("tap: open vhost char device failed: %s",
714 qemu_set_nonblock(vhostfd);
716 options.opaque = (void *)(uintptr_t)vhostfd;
718 s->vhost_net = vhost_net_init(&options);
720 if (tap->has_vhostforce && tap->vhostforce) {
721 error_setg(errp, VHOST_NET_INIT_FAILED);
723 warn_report(VHOST_NET_INIT_FAILED);
727 } else if (vhostfdname) {
728 error_setg(errp, "vhostfd(s)= is not valid without vhost");
732 static int get_fds(char *str, char *fds[], int max)
734 char *ptr = str, *this;
735 size_t len = strlen(str);
738 while (i < max && ptr < str + len) {
739 this = strchr(ptr, ':');
742 fds[i] = g_strdup(ptr);
744 fds[i] = g_strndup(ptr, this - ptr);
758 int net_init_tap(const Netdev *netdev, const char *name,
759 NetClientState *peer, Error **errp)
761 const NetdevTapOptions *tap;
762 int fd, vnet_hdr = 0, i = 0, queues;
763 /* for the no-fd, no-helper case */
764 const char *script = NULL; /* suppress wrong "uninit'd use" gcc warning */
765 const char *downscript = NULL;
767 const char *vhostfdname;
770 assert(netdev->type == NET_CLIENT_DRIVER_TAP);
771 tap = &netdev->u.tap;
772 queues = tap->has_queues ? tap->queues : 1;
773 vhostfdname = tap->has_vhostfd ? tap->vhostfd : NULL;
775 /* QEMU hubs do not support multiqueue tap, in this case peer is set.
776 * For -netdev, peer is always NULL. */
777 if (peer && (tap->has_queues || tap->has_fds || tap->has_vhostfds)) {
778 error_setg(errp, "Multiqueue tap cannot be used with hubs");
783 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
784 tap->has_vnet_hdr || tap->has_helper || tap->has_queues ||
785 tap->has_fds || tap->has_vhostfds) {
786 error_setg(errp, "ifname=, script=, downscript=, vnet_hdr=, "
787 "helper=, queues=, fds=, and vhostfds= "
788 "are invalid with fd=");
792 fd = monitor_fd_param(cur_mon, tap->fd, &err);
794 error_propagate(errp, err);
798 qemu_set_nonblock(fd);
800 vnet_hdr = tap_probe_vnet_hdr(fd);
802 net_init_tap_one(tap, peer, "tap", name, NULL,
804 vhostfdname, vnet_hdr, fd, &err);
806 error_propagate(errp, err);
809 } else if (tap->has_fds) {
812 int nfds = 0, nvhosts = 0;
815 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
816 tap->has_vnet_hdr || tap->has_helper || tap->has_queues ||
818 error_setg(errp, "ifname=, script=, downscript=, vnet_hdr=, "
819 "helper=, queues=, and vhostfd= "
820 "are invalid with fds=");
824 fds = g_new0(char *, MAX_TAP_QUEUES);
825 vhost_fds = g_new0(char *, MAX_TAP_QUEUES);
827 nfds = get_fds(tap->fds, fds, MAX_TAP_QUEUES);
828 if (tap->has_vhostfds) {
829 nvhosts = get_fds(tap->vhostfds, vhost_fds, MAX_TAP_QUEUES);
830 if (nfds != nvhosts) {
831 error_setg(errp, "The number of fds passed does not match "
832 "the number of vhostfds passed");
838 for (i = 0; i < nfds; i++) {
839 fd = monitor_fd_param(cur_mon, fds[i], &err);
841 error_propagate(errp, err);
846 qemu_set_nonblock(fd);
849 vnet_hdr = tap_probe_vnet_hdr(fd);
850 } else if (vnet_hdr != tap_probe_vnet_hdr(fd)) {
852 "vnet_hdr not consistent across given tap fds");
857 net_init_tap_one(tap, peer, "tap", name, ifname,
859 tap->has_vhostfds ? vhost_fds[i] : NULL,
862 error_propagate(errp, err);
869 for (i = 0; i < nvhosts; i++) {
870 g_free(vhost_fds[i]);
872 for (i = 0; i < nfds; i++) {
878 } else if (tap->has_helper) {
879 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
880 tap->has_vnet_hdr || tap->has_queues || tap->has_vhostfds) {
881 error_setg(errp, "ifname=, script=, downscript=, vnet_hdr=, "
882 "queues=, and vhostfds= are invalid with helper=");
886 fd = net_bridge_run_helper(tap->helper,
888 tap->br : DEFAULT_BRIDGE_INTERFACE,
894 qemu_set_nonblock(fd);
895 vnet_hdr = tap_probe_vnet_hdr(fd);
897 net_init_tap_one(tap, peer, "bridge", name, ifname,
898 script, downscript, vhostfdname,
901 error_propagate(errp, err);
906 if (tap->has_vhostfds) {
907 error_setg(errp, "vhostfds= is invalid if fds= wasn't specified");
910 script = tap->has_script ? tap->script : DEFAULT_NETWORK_SCRIPT;
911 downscript = tap->has_downscript ? tap->downscript :
912 DEFAULT_NETWORK_DOWN_SCRIPT;
914 if (tap->has_ifname) {
915 pstrcpy(ifname, sizeof ifname, tap->ifname);
920 for (i = 0; i < queues; i++) {
921 fd = net_tap_init(tap, &vnet_hdr, i >= 1 ? "no" : script,
922 ifname, sizeof ifname, queues > 1, errp);
927 if (queues > 1 && i == 0 && !tap->has_ifname) {
928 if (tap_fd_get_ifname(fd, ifname)) {
929 error_setg(errp, "Fail to get ifname");
935 net_init_tap_one(tap, peer, "tap", name, ifname,
936 i >= 1 ? "no" : script,
937 i >= 1 ? "no" : downscript,
938 vhostfdname, vnet_hdr, fd, &err);
940 error_propagate(errp, err);
950 VHostNetState *tap_get_vhost_net(NetClientState *nc)
952 TAPState *s = DO_UPCAST(TAPState, nc, nc);
953 assert(nc->info->type == NET_CLIENT_DRIVER_TAP);
957 int tap_enable(NetClientState *nc)
959 TAPState *s = DO_UPCAST(TAPState, nc, nc);
965 ret = tap_fd_enable(s->fd);
968 tap_update_fd_handler(s);
974 int tap_disable(NetClientState *nc)
976 TAPState *s = DO_UPCAST(TAPState, nc, nc);
979 if (s->enabled == 0) {
982 ret = tap_fd_disable(s->fd);
984 qemu_purge_queued_packets(nc);
986 tap_update_fd_handler(s);