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
28 #include "config-host.h"
30 #include <sys/ioctl.h>
33 #include <sys/socket.h>
38 #include "monitor/monitor.h"
39 #include "sysemu/sysemu.h"
40 #include "qemu-common.h"
41 #include "qemu/error-report.h"
45 #include "net/vhost_net.h"
47 typedef struct TAPState {
50 char down_script[1024];
51 char down_script_arg[128];
52 uint8_t buf[NET_BUFSIZE];
58 VHostNetState *vhost_net;
59 unsigned host_vnet_hdr_len;
62 static int launch_script(const char *setup_script, const char *ifname, int fd);
64 static int tap_can_send(void *opaque);
65 static void tap_send(void *opaque);
66 static void tap_writable(void *opaque);
68 static void tap_update_fd_handler(TAPState *s)
70 qemu_set_fd_handler2(s->fd,
71 s->read_poll && s->enabled ? tap_can_send : NULL,
72 s->read_poll && s->enabled ? tap_send : NULL,
73 s->write_poll && s->enabled ? tap_writable : NULL,
77 static void tap_read_poll(TAPState *s, bool enable)
79 s->read_poll = enable;
80 tap_update_fd_handler(s);
83 static void tap_write_poll(TAPState *s, bool enable)
85 s->write_poll = enable;
86 tap_update_fd_handler(s);
89 static void tap_writable(void *opaque)
93 tap_write_poll(s, false);
95 qemu_flush_queued_packets(&s->nc);
98 static ssize_t tap_write_packet(TAPState *s, const struct iovec *iov, int iovcnt)
103 len = writev(s->fd, iov, iovcnt);
104 } while (len == -1 && errno == EINTR);
106 if (len == -1 && errno == EAGAIN) {
107 tap_write_poll(s, true);
114 static ssize_t tap_receive_iov(NetClientState *nc, const struct iovec *iov,
117 TAPState *s = DO_UPCAST(TAPState, nc, nc);
118 const struct iovec *iovp = iov;
119 struct iovec iov_copy[iovcnt + 1];
120 struct virtio_net_hdr_mrg_rxbuf hdr = { };
122 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
123 iov_copy[0].iov_base = &hdr;
124 iov_copy[0].iov_len = s->host_vnet_hdr_len;
125 memcpy(&iov_copy[1], iov, iovcnt * sizeof(*iov));
130 return tap_write_packet(s, iovp, iovcnt);
133 static ssize_t tap_receive_raw(NetClientState *nc, const uint8_t *buf, size_t size)
135 TAPState *s = DO_UPCAST(TAPState, nc, nc);
138 struct virtio_net_hdr_mrg_rxbuf hdr = { };
140 if (s->host_vnet_hdr_len) {
141 iov[iovcnt].iov_base = &hdr;
142 iov[iovcnt].iov_len = s->host_vnet_hdr_len;
146 iov[iovcnt].iov_base = (char *)buf;
147 iov[iovcnt].iov_len = size;
150 return tap_write_packet(s, iov, iovcnt);
153 static ssize_t tap_receive(NetClientState *nc, const uint8_t *buf, size_t size)
155 TAPState *s = DO_UPCAST(TAPState, nc, nc);
158 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
159 return tap_receive_raw(nc, buf, size);
162 iov[0].iov_base = (char *)buf;
163 iov[0].iov_len = size;
165 return tap_write_packet(s, iov, 1);
168 static int tap_can_send(void *opaque)
170 TAPState *s = opaque;
172 return qemu_can_send_packet(&s->nc);
176 ssize_t tap_read_packet(int tapfd, uint8_t *buf, int maxlen)
178 return read(tapfd, buf, maxlen);
182 static void tap_send_completed(NetClientState *nc, ssize_t len)
184 TAPState *s = DO_UPCAST(TAPState, nc, nc);
185 tap_read_poll(s, true);
188 static void tap_send(void *opaque)
190 TAPState *s = opaque;
193 while (qemu_can_send_packet(&s->nc)) {
194 uint8_t *buf = s->buf;
196 size = tap_read_packet(s->fd, s->buf, sizeof(s->buf));
201 if (s->host_vnet_hdr_len && !s->using_vnet_hdr) {
202 buf += s->host_vnet_hdr_len;
203 size -= s->host_vnet_hdr_len;
206 size = qemu_send_packet_async(&s->nc, buf, size, tap_send_completed);
208 tap_read_poll(s, false);
210 } else if (size < 0) {
216 static bool tap_has_ufo(NetClientState *nc)
218 TAPState *s = DO_UPCAST(TAPState, nc, nc);
220 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
225 static bool tap_has_vnet_hdr(NetClientState *nc)
227 TAPState *s = DO_UPCAST(TAPState, nc, nc);
229 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
231 return !!s->host_vnet_hdr_len;
234 static bool tap_has_vnet_hdr_len(NetClientState *nc, int len)
236 TAPState *s = DO_UPCAST(TAPState, nc, nc);
238 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
240 return !!tap_probe_vnet_hdr_len(s->fd, len);
243 static void tap_set_vnet_hdr_len(NetClientState *nc, int len)
245 TAPState *s = DO_UPCAST(TAPState, nc, nc);
247 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
248 assert(len == sizeof(struct virtio_net_hdr_mrg_rxbuf) ||
249 len == sizeof(struct virtio_net_hdr));
251 tap_fd_set_vnet_hdr_len(s->fd, len);
252 s->host_vnet_hdr_len = len;
255 static void tap_using_vnet_hdr(NetClientState *nc, bool using_vnet_hdr)
257 TAPState *s = DO_UPCAST(TAPState, nc, nc);
259 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
260 assert(!!s->host_vnet_hdr_len == using_vnet_hdr);
262 s->using_vnet_hdr = using_vnet_hdr;
265 static void tap_set_offload(NetClientState *nc, int csum, int tso4,
266 int tso6, int ecn, int ufo)
268 TAPState *s = DO_UPCAST(TAPState, nc, nc);
273 tap_fd_set_offload(s->fd, csum, tso4, tso6, ecn, ufo);
276 static void tap_cleanup(NetClientState *nc)
278 TAPState *s = DO_UPCAST(TAPState, nc, nc);
281 vhost_net_cleanup(s->vhost_net);
285 qemu_purge_queued_packets(nc);
287 if (s->down_script[0])
288 launch_script(s->down_script, s->down_script_arg, s->fd);
290 tap_read_poll(s, false);
291 tap_write_poll(s, false);
296 static void tap_poll(NetClientState *nc, bool enable)
298 TAPState *s = DO_UPCAST(TAPState, nc, nc);
299 tap_read_poll(s, enable);
300 tap_write_poll(s, enable);
303 int tap_get_fd(NetClientState *nc)
305 TAPState *s = DO_UPCAST(TAPState, nc, nc);
306 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
312 static NetClientInfo net_tap_info = {
313 .type = NET_CLIENT_OPTIONS_KIND_TAP,
314 .size = sizeof(TAPState),
315 .receive = tap_receive,
316 .receive_raw = tap_receive_raw,
317 .receive_iov = tap_receive_iov,
319 .cleanup = tap_cleanup,
320 .has_ufo = tap_has_ufo,
321 .has_vnet_hdr = tap_has_vnet_hdr,
322 .has_vnet_hdr_len = tap_has_vnet_hdr_len,
323 .using_vnet_hdr = tap_using_vnet_hdr,
324 .set_offload = tap_set_offload,
325 .set_vnet_hdr_len = tap_set_vnet_hdr_len,
328 static TAPState *net_tap_fd_init(NetClientState *peer,
337 nc = qemu_new_net_client(&net_tap_info, peer, model, name);
339 s = DO_UPCAST(TAPState, nc, nc);
342 s->host_vnet_hdr_len = vnet_hdr ? sizeof(struct virtio_net_hdr) : 0;
343 s->using_vnet_hdr = false;
344 s->has_ufo = tap_probe_has_ufo(s->fd);
346 tap_set_offload(&s->nc, 0, 0, 0, 0, 0);
348 * Make sure host header length is set correctly in tap:
349 * it might have been modified by another instance of qemu.
351 if (tap_probe_vnet_hdr_len(s->fd, s->host_vnet_hdr_len)) {
352 tap_fd_set_vnet_hdr_len(s->fd, s->host_vnet_hdr_len);
354 tap_read_poll(s, true);
359 static int launch_script(const char *setup_script, const char *ifname, int fd)
365 /* try to launch network script */
368 int open_max = sysconf(_SC_OPEN_MAX), i;
370 for (i = 3; i < open_max; i++) {
376 *parg++ = (char *)setup_script;
377 *parg++ = (char *)ifname;
379 execv(setup_script, args);
381 } else if (pid > 0) {
382 while (waitpid(pid, &status, 0) != pid) {
386 if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
390 fprintf(stderr, "%s: could not launch network script\n", setup_script);
394 static int recv_fd(int c)
397 uint8_t msgbuf[CMSG_SPACE(sizeof(fd))];
398 struct msghdr msg = {
399 .msg_control = msgbuf,
400 .msg_controllen = sizeof(msgbuf),
402 struct cmsghdr *cmsg;
407 cmsg = CMSG_FIRSTHDR(&msg);
408 cmsg->cmsg_level = SOL_SOCKET;
409 cmsg->cmsg_type = SCM_RIGHTS;
410 cmsg->cmsg_len = CMSG_LEN(sizeof(fd));
411 msg.msg_controllen = cmsg->cmsg_len;
414 iov.iov_len = sizeof(req);
419 len = recvmsg(c, &msg, 0);
421 memcpy(&fd, CMSG_DATA(cmsg), sizeof(fd));
428 static int net_bridge_run_helper(const char *helper, const char *bridge)
430 sigset_t oldmask, mask;
437 sigaddset(&mask, SIGCHLD);
438 sigprocmask(SIG_BLOCK, &mask, &oldmask);
440 if (socketpair(PF_UNIX, SOCK_STREAM, 0, sv) == -1) {
444 /* try to launch bridge helper */
447 int open_max = sysconf(_SC_OPEN_MAX), i;
449 char br_buf[6+IFNAMSIZ] = {0};
450 char helper_cmd[PATH_MAX + sizeof(fd_buf) + sizeof(br_buf) + 15];
452 for (i = 3; i < open_max; i++) {
458 snprintf(fd_buf, sizeof(fd_buf), "%s%d", "--fd=", sv[1]);
460 if (strrchr(helper, ' ') || strrchr(helper, '\t')) {
461 /* assume helper is a command */
463 if (strstr(helper, "--br=") == NULL) {
464 snprintf(br_buf, sizeof(br_buf), "%s%s", "--br=", bridge);
467 snprintf(helper_cmd, sizeof(helper_cmd), "%s %s %s %s",
468 helper, "--use-vnet", fd_buf, br_buf);
471 *parg++ = (char *)"sh";
472 *parg++ = (char *)"-c";
473 *parg++ = helper_cmd;
476 execv("/bin/sh", args);
478 /* assume helper is just the executable path name */
480 snprintf(br_buf, sizeof(br_buf), "%s%s", "--br=", bridge);
483 *parg++ = (char *)helper;
484 *parg++ = (char *)"--use-vnet";
493 } else if (pid > 0) {
500 } while (fd == -1 && errno == EINTR);
504 while (waitpid(pid, &status, 0) != pid) {
507 sigprocmask(SIG_SETMASK, &oldmask, NULL);
509 fprintf(stderr, "failed to recv file descriptor\n");
513 if (WIFEXITED(status) && WEXITSTATUS(status) == 0) {
517 fprintf(stderr, "failed to launch bridge helper\n");
521 int net_init_bridge(const NetClientOptions *opts, const char *name,
522 NetClientState *peer)
524 const NetdevBridgeOptions *bridge;
525 const char *helper, *br;
530 assert(opts->kind == NET_CLIENT_OPTIONS_KIND_BRIDGE);
531 bridge = opts->bridge;
533 helper = bridge->has_helper ? bridge->helper : DEFAULT_BRIDGE_HELPER;
534 br = bridge->has_br ? bridge->br : DEFAULT_BRIDGE_INTERFACE;
536 fd = net_bridge_run_helper(helper, br);
541 fcntl(fd, F_SETFL, O_NONBLOCK);
543 vnet_hdr = tap_probe_vnet_hdr(fd);
545 s = net_tap_fd_init(peer, "bridge", name, fd, vnet_hdr);
551 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "helper=%s,br=%s", helper,
557 static int net_tap_init(const NetdevTapOptions *tap, int *vnet_hdr,
558 const char *setup_script, char *ifname,
559 size_t ifname_sz, int mq_required)
561 int fd, vnet_hdr_required;
563 if (tap->has_vnet_hdr) {
564 *vnet_hdr = tap->vnet_hdr;
565 vnet_hdr_required = *vnet_hdr;
568 vnet_hdr_required = 0;
571 TFR(fd = tap_open(ifname, ifname_sz, vnet_hdr, vnet_hdr_required,
578 setup_script[0] != '\0' &&
579 strcmp(setup_script, "no") != 0 &&
580 launch_script(setup_script, ifname, fd)) {
588 #define MAX_TAP_QUEUES 1024
590 static int net_init_tap_one(const NetdevTapOptions *tap, NetClientState *peer,
591 const char *model, const char *name,
592 const char *ifname, const char *script,
593 const char *downscript, const char *vhostfdname,
594 int vnet_hdr, int fd)
599 s = net_tap_fd_init(peer, model, name, fd, vnet_hdr);
605 if (tap_set_sndbuf(s->fd, tap) < 0) {
609 if (tap->has_fd || tap->has_fds) {
610 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "fd=%d", fd);
611 } else if (tap->has_helper) {
612 snprintf(s->nc.info_str, sizeof(s->nc.info_str), "helper=%s",
615 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
616 "ifname=%s,script=%s,downscript=%s", ifname, script,
619 if (strcmp(downscript, "no") != 0) {
620 snprintf(s->down_script, sizeof(s->down_script), "%s", downscript);
621 snprintf(s->down_script_arg, sizeof(s->down_script_arg),
626 if (tap->has_vhost ? tap->vhost :
627 vhostfdname || (tap->has_vhostforce && tap->vhostforce)) {
628 VhostNetOptions options;
630 options.backend_type = VHOST_BACKEND_TYPE_KERNEL;
631 options.net_backend = &s->nc;
632 options.force = tap->has_vhostforce && tap->vhostforce;
634 if (tap->has_vhostfd || tap->has_vhostfds) {
635 vhostfd = monitor_handle_fd_param(cur_mon, vhostfdname);
640 vhostfd = open("/dev/vhost-net", O_RDWR);
642 error_report("tap: open vhost char device failed: %s",
647 options.opaque = (void *)(uintptr_t)vhostfd;
649 s->vhost_net = vhost_net_init(&options);
651 error_report("vhost-net requested but could not be initialized");
654 } else if (tap->has_vhostfd || tap->has_vhostfds) {
655 error_report("vhostfd= is not valid without vhost");
662 static int get_fds(char *str, char *fds[], int max)
664 char *ptr = str, *this;
665 size_t len = strlen(str);
668 while (i < max && ptr < str + len) {
669 this = strchr(ptr, ':');
672 fds[i] = g_strdup(ptr);
674 fds[i] = g_strndup(ptr, this - ptr);
688 int net_init_tap(const NetClientOptions *opts, const char *name,
689 NetClientState *peer)
691 const NetdevTapOptions *tap;
692 int fd, vnet_hdr = 0, i = 0, queues;
693 /* for the no-fd, no-helper case */
694 const char *script = NULL; /* suppress wrong "uninit'd use" gcc warning */
695 const char *downscript = NULL;
696 const char *vhostfdname;
699 assert(opts->kind == NET_CLIENT_OPTIONS_KIND_TAP);
701 queues = tap->has_queues ? tap->queues : 1;
702 vhostfdname = tap->has_vhostfd ? tap->vhostfd : NULL;
704 /* QEMU vlans does not support multiqueue tap, in this case peer is set.
705 * For -netdev, peer is always NULL. */
706 if (peer && (tap->has_queues || tap->has_fds || tap->has_vhostfds)) {
707 error_report("Multiqueue tap cannot be used with QEMU vlans");
712 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
713 tap->has_vnet_hdr || tap->has_helper || tap->has_queues ||
714 tap->has_fds || tap->has_vhostfds) {
715 error_report("ifname=, script=, downscript=, vnet_hdr=, "
716 "helper=, queues=, fds=, and vhostfds= "
717 "are invalid with fd=");
721 fd = monitor_handle_fd_param(cur_mon, tap->fd);
726 fcntl(fd, F_SETFL, O_NONBLOCK);
728 vnet_hdr = tap_probe_vnet_hdr(fd);
730 if (net_init_tap_one(tap, peer, "tap", name, NULL,
732 vhostfdname, vnet_hdr, fd)) {
735 } else if (tap->has_fds) {
736 char *fds[MAX_TAP_QUEUES];
737 char *vhost_fds[MAX_TAP_QUEUES];
740 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
741 tap->has_vnet_hdr || tap->has_helper || tap->has_queues ||
743 error_report("ifname=, script=, downscript=, vnet_hdr=, "
744 "helper=, queues=, and vhostfd= "
745 "are invalid with fds=");
749 nfds = get_fds(tap->fds, fds, MAX_TAP_QUEUES);
750 if (tap->has_vhostfds) {
751 nvhosts = get_fds(tap->vhostfds, vhost_fds, MAX_TAP_QUEUES);
752 if (nfds != nvhosts) {
753 error_report("The number of fds passed does not match the "
754 "number of vhostfds passed");
759 for (i = 0; i < nfds; i++) {
760 fd = monitor_handle_fd_param(cur_mon, fds[i]);
765 fcntl(fd, F_SETFL, O_NONBLOCK);
768 vnet_hdr = tap_probe_vnet_hdr(fd);
769 } else if (vnet_hdr != tap_probe_vnet_hdr(fd)) {
770 error_report("vnet_hdr not consistent across given tap fds");
774 if (net_init_tap_one(tap, peer, "tap", name, ifname,
776 tap->has_vhostfds ? vhost_fds[i] : NULL,
781 } else if (tap->has_helper) {
782 if (tap->has_ifname || tap->has_script || tap->has_downscript ||
783 tap->has_vnet_hdr || tap->has_queues || tap->has_vhostfds) {
784 error_report("ifname=, script=, downscript=, and vnet_hdr= "
785 "queues=, and vhostfds= are invalid with helper=");
789 fd = net_bridge_run_helper(tap->helper, DEFAULT_BRIDGE_INTERFACE);
794 fcntl(fd, F_SETFL, O_NONBLOCK);
795 vnet_hdr = tap_probe_vnet_hdr(fd);
797 if (net_init_tap_one(tap, peer, "bridge", name, ifname,
798 script, downscript, vhostfdname,
803 if (tap->has_vhostfds) {
804 error_report("vhostfds= is invalid if fds= wasn't specified");
807 script = tap->has_script ? tap->script : DEFAULT_NETWORK_SCRIPT;
808 downscript = tap->has_downscript ? tap->downscript :
809 DEFAULT_NETWORK_DOWN_SCRIPT;
811 if (tap->has_ifname) {
812 pstrcpy(ifname, sizeof ifname, tap->ifname);
817 for (i = 0; i < queues; i++) {
818 fd = net_tap_init(tap, &vnet_hdr, i >= 1 ? "no" : script,
819 ifname, sizeof ifname, queues > 1);
824 if (queues > 1 && i == 0 && !tap->has_ifname) {
825 if (tap_fd_get_ifname(fd, ifname)) {
826 error_report("Fail to get ifname");
831 if (net_init_tap_one(tap, peer, "tap", name, ifname,
832 i >= 1 ? "no" : script,
833 i >= 1 ? "no" : downscript,
834 vhostfdname, vnet_hdr, fd)) {
843 VHostNetState *tap_get_vhost_net(NetClientState *nc)
845 TAPState *s = DO_UPCAST(TAPState, nc, nc);
846 assert(nc->info->type == NET_CLIENT_OPTIONS_KIND_TAP);
850 int tap_enable(NetClientState *nc)
852 TAPState *s = DO_UPCAST(TAPState, nc, nc);
858 ret = tap_fd_enable(s->fd);
861 tap_update_fd_handler(s);
867 int tap_disable(NetClientState *nc)
869 TAPState *s = DO_UPCAST(TAPState, nc, nc);
872 if (s->enabled == 0) {
875 ret = tap_fd_disable(s->fd);
877 qemu_purge_queued_packets(nc);
879 tap_update_fd_handler(s);