4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "config-host.h"
29 #include "net/slirp.h"
32 #include "monitor/monitor.h"
33 #include "qemu-common.h"
34 #include "qemu/sockets.h"
35 #include "qemu/config-file.h"
36 #include "qmp-commands.h"
39 #include "qapi-visit.h"
40 #include "qapi/opts-visitor.h"
41 #include "qapi/dealloc-visitor.h"
43 /* Net bridge is currently not supported for W32. */
45 # define CONFIG_NET_BRIDGE
48 static QTAILQ_HEAD(, NetClientState) net_clients;
52 /***********************************************************/
53 /* network device redirectors */
55 #if defined(DEBUG_NET)
56 static void hex_dump(FILE *f, const uint8_t *buf, int size)
60 for(i=0;i<size;i+=16) {
64 fprintf(f, "%08x ", i);
67 fprintf(f, " %02x", buf[i+j]);
74 if (c < ' ' || c > '~')
83 static int get_str_sep(char *buf, int buf_size, const char **pp, int sep)
94 if (len > buf_size - 1)
103 int parse_host_port(struct sockaddr_in *saddr, const char *str)
111 if (get_str_sep(buf, sizeof(buf), &p, ':') < 0)
113 saddr->sin_family = AF_INET;
114 if (buf[0] == '\0') {
115 saddr->sin_addr.s_addr = 0;
117 if (qemu_isdigit(buf[0])) {
118 if (!inet_aton(buf, &saddr->sin_addr))
121 if ((he = gethostbyname(buf)) == NULL)
123 saddr->sin_addr = *(struct in_addr *)he->h_addr;
126 port = strtol(p, (char **)&r, 0);
129 saddr->sin_port = htons(port);
133 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6])
135 snprintf(nc->info_str, sizeof(nc->info_str),
136 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
138 macaddr[0], macaddr[1], macaddr[2],
139 macaddr[3], macaddr[4], macaddr[5]);
142 void qemu_macaddr_default_if_unset(MACAddr *macaddr)
144 static int index = 0;
145 static const MACAddr zero = { .a = { 0,0,0,0,0,0 } };
147 if (memcmp(macaddr, &zero, sizeof(zero)) != 0)
149 macaddr->a[0] = 0x52;
150 macaddr->a[1] = 0x54;
151 macaddr->a[2] = 0x00;
152 macaddr->a[3] = 0x12;
153 macaddr->a[4] = 0x34;
154 macaddr->a[5] = 0x56 + index++;
158 * Generate a name for net client
160 * Only net clients created with the legacy -net option need this. Naming is
161 * mandatory for net clients created with -netdev.
163 static char *assign_name(NetClientState *nc1, const char *model)
169 QTAILQ_FOREACH(nc, &net_clients, next) {
173 /* For compatibility only bump id for net clients on a vlan */
174 if (strcmp(nc->model, model) == 0 &&
175 net_hub_id_for_client(nc, NULL) == 0) {
180 snprintf(buf, sizeof(buf), "%s.%d", model, id);
182 return g_strdup(buf);
185 NetClientState *qemu_new_net_client(NetClientInfo *info,
186 NetClientState *peer,
192 assert(info->size >= sizeof(NetClientState));
194 nc = g_malloc0(info->size);
197 nc->model = g_strdup(model);
199 nc->name = g_strdup(name);
201 nc->name = assign_name(nc, model);
209 QTAILQ_INSERT_TAIL(&net_clients, nc, next);
211 nc->send_queue = qemu_new_net_queue(nc);
216 NICState *qemu_new_nic(NetClientInfo *info,
225 assert(info->type == NET_CLIENT_OPTIONS_KIND_NIC);
226 assert(info->size >= sizeof(NICState));
228 nc = qemu_new_net_client(info, conf->peer, model, name);
230 nic = DO_UPCAST(NICState, nc, nc);
232 nic->opaque = opaque;
237 static void qemu_cleanup_net_client(NetClientState *nc)
239 QTAILQ_REMOVE(&net_clients, nc, next);
241 if (nc->info->cleanup) {
242 nc->info->cleanup(nc);
246 static void qemu_free_net_client(NetClientState *nc)
248 if (nc->send_queue) {
249 qemu_del_net_queue(nc->send_queue);
252 nc->peer->peer = NULL;
259 void qemu_del_net_client(NetClientState *nc)
261 /* If there is a peer NIC, delete and cleanup client, but do not free. */
262 if (nc->peer && nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
263 NICState *nic = DO_UPCAST(NICState, nc, nc->peer);
264 if (nic->peer_deleted) {
267 nic->peer_deleted = true;
268 /* Let NIC know peer is gone. */
269 nc->peer->link_down = true;
270 if (nc->peer->info->link_status_changed) {
271 nc->peer->info->link_status_changed(nc->peer);
273 qemu_cleanup_net_client(nc);
277 /* If this is a peer NIC and peer has already been deleted, free it now. */
278 if (nc->peer && nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
279 NICState *nic = DO_UPCAST(NICState, nc, nc);
280 if (nic->peer_deleted) {
281 qemu_free_net_client(nc->peer);
285 qemu_cleanup_net_client(nc);
286 qemu_free_net_client(nc);
289 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque)
293 QTAILQ_FOREACH(nc, &net_clients, next) {
294 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
295 func(DO_UPCAST(NICState, nc, nc), opaque);
300 int qemu_can_send_packet(NetClientState *sender)
306 if (sender->peer->receive_disabled) {
308 } else if (sender->peer->info->can_receive &&
309 !sender->peer->info->can_receive(sender->peer)) {
315 ssize_t qemu_deliver_packet(NetClientState *sender,
321 NetClientState *nc = opaque;
328 if (nc->receive_disabled) {
332 if (flags & QEMU_NET_PACKET_FLAG_RAW && nc->info->receive_raw) {
333 ret = nc->info->receive_raw(nc, data, size);
335 ret = nc->info->receive(nc, data, size);
339 nc->receive_disabled = 1;
345 void qemu_purge_queued_packets(NetClientState *nc)
351 qemu_net_queue_purge(nc->peer->send_queue, nc);
354 void qemu_flush_queued_packets(NetClientState *nc)
356 nc->receive_disabled = 0;
358 if (qemu_net_queue_flush(nc->send_queue)) {
359 /* We emptied the queue successfully, signal to the IO thread to repoll
360 * the file descriptor (for tap, for example).
366 static ssize_t qemu_send_packet_async_with_flags(NetClientState *sender,
368 const uint8_t *buf, int size,
369 NetPacketSent *sent_cb)
374 printf("qemu_send_packet_async:\n");
375 hex_dump(stdout, buf, size);
378 if (sender->link_down || !sender->peer) {
382 queue = sender->peer->send_queue;
384 return qemu_net_queue_send(queue, sender, flags, buf, size, sent_cb);
387 ssize_t qemu_send_packet_async(NetClientState *sender,
388 const uint8_t *buf, int size,
389 NetPacketSent *sent_cb)
391 return qemu_send_packet_async_with_flags(sender, QEMU_NET_PACKET_FLAG_NONE,
395 void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size)
397 qemu_send_packet_async(nc, buf, size, NULL);
400 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size)
402 return qemu_send_packet_async_with_flags(nc, QEMU_NET_PACKET_FLAG_RAW,
406 static ssize_t nc_sendv_compat(NetClientState *nc, const struct iovec *iov,
409 uint8_t buffer[4096];
412 offset = iov_to_buf(iov, iovcnt, 0, buffer, sizeof(buffer));
414 return nc->info->receive(nc, buffer, offset);
417 ssize_t qemu_deliver_packet_iov(NetClientState *sender,
419 const struct iovec *iov,
423 NetClientState *nc = opaque;
427 return iov_size(iov, iovcnt);
430 if (nc->receive_disabled) {
434 if (nc->info->receive_iov) {
435 ret = nc->info->receive_iov(nc, iov, iovcnt);
437 ret = nc_sendv_compat(nc, iov, iovcnt);
441 nc->receive_disabled = 1;
447 ssize_t qemu_sendv_packet_async(NetClientState *sender,
448 const struct iovec *iov, int iovcnt,
449 NetPacketSent *sent_cb)
453 if (sender->link_down || !sender->peer) {
454 return iov_size(iov, iovcnt);
457 queue = sender->peer->send_queue;
459 return qemu_net_queue_send_iov(queue, sender,
460 QEMU_NET_PACKET_FLAG_NONE,
461 iov, iovcnt, sent_cb);
465 qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, int iovcnt)
467 return qemu_sendv_packet_async(nc, iov, iovcnt, NULL);
470 NetClientState *qemu_find_netdev(const char *id)
474 QTAILQ_FOREACH(nc, &net_clients, next) {
475 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC)
477 if (!strcmp(nc->name, id)) {
485 static int nic_get_free_idx(void)
489 for (index = 0; index < MAX_NICS; index++)
490 if (!nd_table[index].used)
495 int qemu_show_nic_models(const char *arg, const char *const *models)
499 if (!arg || !is_help_option(arg)) {
503 fprintf(stderr, "qemu: Supported NIC models: ");
504 for (i = 0 ; models[i]; i++)
505 fprintf(stderr, "%s%c", models[i], models[i+1] ? ',' : '\n');
509 void qemu_check_nic_model(NICInfo *nd, const char *model)
511 const char *models[2];
516 if (qemu_show_nic_models(nd->model, models))
518 if (qemu_find_nic_model(nd, models, model) < 0)
522 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
523 const char *default_model)
528 nd->model = g_strdup(default_model);
530 for (i = 0 ; models[i]; i++) {
531 if (strcmp(nd->model, models[i]) == 0)
535 error_report("Unsupported NIC model: %s", nd->model);
539 static int net_init_nic(const NetClientOptions *opts, const char *name,
540 NetClientState *peer)
544 const NetLegacyNicOptions *nic;
546 assert(opts->kind == NET_CLIENT_OPTIONS_KIND_NIC);
549 idx = nic_get_free_idx();
550 if (idx == -1 || nb_nics >= MAX_NICS) {
551 error_report("Too Many NICs");
557 memset(nd, 0, sizeof(*nd));
559 if (nic->has_netdev) {
560 nd->netdev = qemu_find_netdev(nic->netdev);
562 error_report("netdev '%s' not found", nic->netdev);
570 nd->name = g_strdup(name);
572 if (nic->has_model) {
573 nd->model = g_strdup(nic->model);
576 nd->devaddr = g_strdup(nic->addr);
579 if (nic->has_macaddr &&
580 net_parse_macaddr(nd->macaddr.a, nic->macaddr) < 0) {
581 error_report("invalid syntax for ethernet address");
584 qemu_macaddr_default_if_unset(&nd->macaddr);
586 if (nic->has_vectors) {
587 if (nic->vectors > 0x7ffffff) {
588 error_report("invalid # of vectors: %"PRIu32, nic->vectors);
591 nd->nvectors = nic->vectors;
593 nd->nvectors = DEV_NVECTORS_UNSPECIFIED;
603 static int (* const net_client_init_fun[NET_CLIENT_OPTIONS_KIND_MAX])(
604 const NetClientOptions *opts,
606 NetClientState *peer) = {
607 [NET_CLIENT_OPTIONS_KIND_NIC] = net_init_nic,
609 [NET_CLIENT_OPTIONS_KIND_USER] = net_init_slirp,
611 [NET_CLIENT_OPTIONS_KIND_TAP] = net_init_tap,
612 [NET_CLIENT_OPTIONS_KIND_SOCKET] = net_init_socket,
614 [NET_CLIENT_OPTIONS_KIND_VDE] = net_init_vde,
616 [NET_CLIENT_OPTIONS_KIND_DUMP] = net_init_dump,
617 #ifdef CONFIG_NET_BRIDGE
618 [NET_CLIENT_OPTIONS_KIND_BRIDGE] = net_init_bridge,
620 [NET_CLIENT_OPTIONS_KIND_HUBPORT] = net_init_hubport,
624 static int net_client_init1(const void *object, int is_netdev, Error **errp)
627 const Netdev *netdev;
628 const NetLegacy *net;
630 const NetClientOptions *opts;
635 opts = u.netdev->opts;
638 switch (opts->kind) {
640 case NET_CLIENT_OPTIONS_KIND_USER:
642 case NET_CLIENT_OPTIONS_KIND_TAP:
643 case NET_CLIENT_OPTIONS_KIND_SOCKET:
645 case NET_CLIENT_OPTIONS_KIND_VDE:
647 #ifdef CONFIG_NET_BRIDGE
648 case NET_CLIENT_OPTIONS_KIND_BRIDGE:
650 case NET_CLIENT_OPTIONS_KIND_HUBPORT:
654 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "type",
655 "a netdev backend type");
661 /* missing optional values have been initialized to "all bits zero" */
662 name = u.net->has_id ? u.net->id : u.net->name;
665 if (net_client_init_fun[opts->kind]) {
666 NetClientState *peer = NULL;
668 /* Do not add to a vlan if it's a -netdev or a nic with a netdev=
671 (opts->kind != NET_CLIENT_OPTIONS_KIND_NIC ||
672 !opts->nic->has_netdev)) {
673 peer = net_hub_add_port(u.net->has_vlan ? u.net->vlan : 0, NULL);
676 if (net_client_init_fun[opts->kind](opts, name, peer) < 0) {
677 /* TODO push error reporting into init() methods */
678 error_set(errp, QERR_DEVICE_INIT_FAILED,
679 NetClientOptionsKind_lookup[opts->kind]);
687 static void net_visit(Visitor *v, int is_netdev, void **object, Error **errp)
690 visit_type_Netdev(v, (Netdev **)object, NULL, errp);
692 visit_type_NetLegacy(v, (NetLegacy **)object, NULL, errp);
697 int net_client_init(QemuOpts *opts, int is_netdev, Error **errp)
704 OptsVisitor *ov = opts_visitor_new(opts);
706 net_visit(opts_get_visitor(ov), is_netdev, &object, &err);
707 opts_visitor_cleanup(ov);
711 ret = net_client_init1(object, is_netdev, &err);
715 QapiDeallocVisitor *dv = qapi_dealloc_visitor_new();
717 net_visit(qapi_dealloc_get_visitor(dv), is_netdev, &object, NULL);
718 qapi_dealloc_visitor_cleanup(dv);
721 error_propagate(errp, err);
726 static int net_host_check_device(const char *device)
729 const char *valid_param_list[] = { "tap", "socket", "dump"
730 #ifdef CONFIG_NET_BRIDGE
740 for (i = 0; i < sizeof(valid_param_list) / sizeof(char *); i++) {
741 if (!strncmp(valid_param_list[i], device,
742 strlen(valid_param_list[i])))
749 void net_host_device_add(Monitor *mon, const QDict *qdict)
751 const char *device = qdict_get_str(qdict, "device");
752 const char *opts_str = qdict_get_try_str(qdict, "opts");
753 Error *local_err = NULL;
756 if (!net_host_check_device(device)) {
757 monitor_printf(mon, "invalid host network device %s\n", device);
761 opts = qemu_opts_parse(qemu_find_opts("net"), opts_str ? opts_str : "", 0);
766 qemu_opt_set(opts, "type", device);
768 net_client_init(opts, 0, &local_err);
769 if (error_is_set(&local_err)) {
770 qerror_report_err(local_err);
771 error_free(local_err);
772 monitor_printf(mon, "adding host network device %s failed\n", device);
776 void net_host_device_remove(Monitor *mon, const QDict *qdict)
779 int vlan_id = qdict_get_int(qdict, "vlan_id");
780 const char *device = qdict_get_str(qdict, "device");
782 nc = net_hub_find_client_by_name(vlan_id, device);
786 if (!net_host_check_device(nc->model)) {
787 monitor_printf(mon, "invalid host network device %s\n", device);
790 qemu_del_net_client(nc);
793 void netdev_add(QemuOpts *opts, Error **errp)
795 net_client_init(opts, 1, errp);
798 int qmp_netdev_add(Monitor *mon, const QDict *qdict, QObject **ret)
800 Error *local_err = NULL;
801 QemuOptsList *opts_list;
804 opts_list = qemu_find_opts_err("netdev", &local_err);
805 if (error_is_set(&local_err)) {
809 opts = qemu_opts_from_qdict(opts_list, qdict, &local_err);
810 if (error_is_set(&local_err)) {
814 netdev_add(opts, &local_err);
815 if (error_is_set(&local_err)) {
823 qerror_report_err(local_err);
824 error_free(local_err);
828 void qmp_netdev_del(const char *id, Error **errp)
833 nc = qemu_find_netdev(id);
835 error_set(errp, QERR_DEVICE_NOT_FOUND, id);
839 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), id);
841 error_setg(errp, "Device '%s' is not a netdev", id);
845 qemu_del_net_client(nc);
849 void print_net_client(Monitor *mon, NetClientState *nc)
851 monitor_printf(mon, "%s: type=%s,%s\n", nc->name,
852 NetClientOptionsKind_lookup[nc->info->type], nc->info_str);
855 void do_info_network(Monitor *mon)
857 NetClientState *nc, *peer;
858 NetClientOptionsKind type;
862 QTAILQ_FOREACH(nc, &net_clients, next) {
864 type = nc->info->type;
866 /* Skip if already printed in hub info */
867 if (net_hub_id_for_client(nc, NULL) == 0) {
871 if (!peer || type == NET_CLIENT_OPTIONS_KIND_NIC) {
872 print_net_client(mon, nc);
873 } /* else it's a netdev connected to a NIC, printed with the NIC */
874 if (peer && type == NET_CLIENT_OPTIONS_KIND_NIC) {
875 monitor_printf(mon, " \\ ");
876 print_net_client(mon, peer);
881 void qmp_set_link(const char *name, bool up, Error **errp)
883 NetClientState *nc = NULL;
885 QTAILQ_FOREACH(nc, &net_clients, next) {
886 if (!strcmp(nc->name, name)) {
892 error_set(errp, QERR_DEVICE_NOT_FOUND, name);
898 if (nc->info->link_status_changed) {
899 nc->info->link_status_changed(nc);
902 /* Notify peer. Don't update peer link status: this makes it possible to
903 * disconnect from host network without notifying the guest.
904 * FIXME: is disconnected link status change operation useful?
906 * Current behaviour is compatible with qemu vlans where there could be
907 * multiple clients that can still communicate with each other in
908 * disconnected mode. For now maintain this compatibility. */
909 if (nc->peer && nc->peer->info->link_status_changed) {
910 nc->peer->info->link_status_changed(nc->peer);
914 void net_cleanup(void)
916 NetClientState *nc, *next_vc;
918 QTAILQ_FOREACH_SAFE(nc, &net_clients, next, next_vc) {
919 qemu_del_net_client(nc);
923 void net_check_clients(void)
928 /* Don't warn about the default network setup that you get if
929 * no command line -net or -netdev options are specified. There
930 * are two cases that we would otherwise complain about:
931 * (1) board doesn't support a NIC but the implicit "-net nic"
933 * (2) CONFIG_SLIRP not set, in which case the implicit "-net nic"
934 * sets up a nic that isn't connected to anything.
940 net_hub_check_clients();
942 QTAILQ_FOREACH(nc, &net_clients, next) {
944 fprintf(stderr, "Warning: %s %s has no peer\n",
945 nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC ?
946 "nic" : "netdev", nc->name);
950 /* Check that all NICs requested via -net nic actually got created.
951 * NICs created via -device don't need to be checked here because
952 * they are always instantiated.
954 for (i = 0; i < MAX_NICS; i++) {
955 NICInfo *nd = &nd_table[i];
956 if (nd->used && !nd->instantiated) {
957 fprintf(stderr, "Warning: requested NIC (%s, model %s) "
958 "was not created (not supported by this machine?)\n",
959 nd->name ? nd->name : "anonymous",
960 nd->model ? nd->model : "unspecified");
965 static int net_init_client(QemuOpts *opts, void *dummy)
967 Error *local_err = NULL;
969 net_client_init(opts, 0, &local_err);
970 if (error_is_set(&local_err)) {
971 qerror_report_err(local_err);
972 error_free(local_err);
979 static int net_init_netdev(QemuOpts *opts, void *dummy)
981 Error *local_err = NULL;
984 ret = net_client_init(opts, 1, &local_err);
985 if (error_is_set(&local_err)) {
986 qerror_report_err(local_err);
987 error_free(local_err);
994 int net_init_clients(void)
996 QemuOptsList *net = qemu_find_opts("net");
999 /* if no clients, we use a default config */
1000 qemu_opts_set(net, NULL, "type", "nic");
1002 qemu_opts_set(net, NULL, "type", "user");
1006 QTAILQ_INIT(&net_clients);
1008 if (qemu_opts_foreach(qemu_find_opts("netdev"), net_init_netdev, NULL, 1) == -1)
1011 if (qemu_opts_foreach(net, net_init_client, NULL, 1) == -1) {
1018 int net_client_parse(QemuOptsList *opts_list, const char *optarg)
1020 #if defined(CONFIG_SLIRP)
1022 if (net_slirp_parse_legacy(opts_list, optarg, &ret)) {
1027 if (!qemu_opts_parse(opts_list, optarg, 1)) {
1037 unsigned compute_mcast_idx(const uint8_t *ep)
1044 for (i = 0; i < 6; i++) {
1046 for (j = 0; j < 8; j++) {
1047 carry = ((crc & 0x80000000L) ? 1 : 0) ^ (b & 0x01);
1051 crc = ((crc ^ POLYNOMIAL) | carry);
1058 QemuOptsList qemu_netdev_opts = {
1060 .implied_opt_name = "type",
1061 .head = QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts.head),
1064 * no elements => accept any params
1065 * validation will happen later
1067 { /* end of list */ }
1071 QemuOptsList qemu_net_opts = {
1073 .implied_opt_name = "type",
1074 .head = QTAILQ_HEAD_INITIALIZER(qemu_net_opts.head),
1077 * no elements => accept any params
1078 * validation will happen later
1080 { /* end of list */ }