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
26 #include "config-host.h"
29 #include "net/socket.h"
31 #include "net/slirp.h"
36 #include "qemu-common.h"
37 #include "qemu_socket.h"
38 #include "qmp-commands.h"
41 #include "qapi-visit.h"
42 #include "qapi/opts-visitor.h"
43 #include "qapi/qapi-dealloc-visitor.h"
45 /* Net bridge is currently not supported for W32. */
47 # define CONFIG_NET_BRIDGE
50 static QTAILQ_HEAD(, NetClientState) net_clients;
54 /***********************************************************/
55 /* network device redirectors */
57 #if defined(DEBUG_NET)
58 static void hex_dump(FILE *f, const uint8_t *buf, int size)
62 for(i=0;i<size;i+=16) {
66 fprintf(f, "%08x ", i);
69 fprintf(f, " %02x", buf[i+j]);
76 if (c < ' ' || c > '~')
85 static int get_str_sep(char *buf, int buf_size, const char **pp, int sep)
96 if (len > buf_size - 1)
105 int parse_host_port(struct sockaddr_in *saddr, const char *str)
113 if (get_str_sep(buf, sizeof(buf), &p, ':') < 0)
115 saddr->sin_family = AF_INET;
116 if (buf[0] == '\0') {
117 saddr->sin_addr.s_addr = 0;
119 if (qemu_isdigit(buf[0])) {
120 if (!inet_aton(buf, &saddr->sin_addr))
123 if ((he = gethostbyname(buf)) == NULL)
125 saddr->sin_addr = *(struct in_addr *)he->h_addr;
128 port = strtol(p, (char **)&r, 0);
131 saddr->sin_port = htons(port);
135 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6])
137 snprintf(nc->info_str, sizeof(nc->info_str),
138 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
140 macaddr[0], macaddr[1], macaddr[2],
141 macaddr[3], macaddr[4], macaddr[5]);
144 void qemu_macaddr_default_if_unset(MACAddr *macaddr)
146 static int index = 0;
147 static const MACAddr zero = { .a = { 0,0,0,0,0,0 } };
149 if (memcmp(macaddr, &zero, sizeof(zero)) != 0)
151 macaddr->a[0] = 0x52;
152 macaddr->a[1] = 0x54;
153 macaddr->a[2] = 0x00;
154 macaddr->a[3] = 0x12;
155 macaddr->a[4] = 0x34;
156 macaddr->a[5] = 0x56 + index++;
160 * Generate a name for net client
162 * Only net clients created with the legacy -net option need this. Naming is
163 * mandatory for net clients created with -netdev.
165 static char *assign_name(NetClientState *nc1, const char *model)
171 QTAILQ_FOREACH(nc, &net_clients, next) {
175 /* For compatibility only bump id for net clients on a vlan */
176 if (strcmp(nc->model, model) == 0 &&
177 net_hub_id_for_client(nc, NULL) == 0) {
182 snprintf(buf, sizeof(buf), "%s.%d", model, id);
184 return g_strdup(buf);
187 NetClientState *qemu_new_net_client(NetClientInfo *info,
188 NetClientState *peer,
194 assert(info->size >= sizeof(NetClientState));
196 nc = g_malloc0(info->size);
199 nc->model = g_strdup(model);
201 nc->name = g_strdup(name);
203 nc->name = assign_name(nc, model);
211 QTAILQ_INSERT_TAIL(&net_clients, nc, next);
213 nc->send_queue = qemu_new_net_queue(nc);
218 NICState *qemu_new_nic(NetClientInfo *info,
227 assert(info->type == NET_CLIENT_OPTIONS_KIND_NIC);
228 assert(info->size >= sizeof(NICState));
230 nc = qemu_new_net_client(info, conf->peer, model, name);
232 nic = DO_UPCAST(NICState, nc, nc);
234 nic->opaque = opaque;
239 static void qemu_cleanup_net_client(NetClientState *nc)
241 QTAILQ_REMOVE(&net_clients, nc, next);
243 if (nc->info->cleanup) {
244 nc->info->cleanup(nc);
248 static void qemu_free_net_client(NetClientState *nc)
250 if (nc->send_queue) {
251 qemu_del_net_queue(nc->send_queue);
254 nc->peer->peer = NULL;
261 void qemu_del_net_client(NetClientState *nc)
263 /* If there is a peer NIC, delete and cleanup client, but do not free. */
264 if (nc->peer && nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
265 NICState *nic = DO_UPCAST(NICState, nc, nc->peer);
266 if (nic->peer_deleted) {
269 nic->peer_deleted = true;
270 /* Let NIC know peer is gone. */
271 nc->peer->link_down = true;
272 if (nc->peer->info->link_status_changed) {
273 nc->peer->info->link_status_changed(nc->peer);
275 qemu_cleanup_net_client(nc);
279 /* If this is a peer NIC and peer has already been deleted, free it now. */
280 if (nc->peer && nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
281 NICState *nic = DO_UPCAST(NICState, nc, nc);
282 if (nic->peer_deleted) {
283 qemu_free_net_client(nc->peer);
287 qemu_cleanup_net_client(nc);
288 qemu_free_net_client(nc);
291 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque)
295 QTAILQ_FOREACH(nc, &net_clients, next) {
296 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
297 func(DO_UPCAST(NICState, nc, nc), opaque);
302 int qemu_can_send_packet(NetClientState *sender)
308 if (sender->peer->receive_disabled) {
310 } else if (sender->peer->info->can_receive &&
311 !sender->peer->info->can_receive(sender->peer)) {
317 ssize_t qemu_deliver_packet(NetClientState *sender,
323 NetClientState *nc = opaque;
330 if (nc->receive_disabled) {
334 if (flags & QEMU_NET_PACKET_FLAG_RAW && nc->info->receive_raw) {
335 ret = nc->info->receive_raw(nc, data, size);
337 ret = nc->info->receive(nc, data, size);
341 nc->receive_disabled = 1;
347 void qemu_purge_queued_packets(NetClientState *nc)
353 qemu_net_queue_purge(nc->peer->send_queue, nc);
356 void qemu_flush_queued_packets(NetClientState *nc)
358 nc->receive_disabled = 0;
360 if (qemu_net_queue_flush(nc->send_queue)) {
361 /* We emptied the queue successfully, signal to the IO thread to repoll
362 * the file descriptor (for tap, for example).
368 static ssize_t qemu_send_packet_async_with_flags(NetClientState *sender,
370 const uint8_t *buf, int size,
371 NetPacketSent *sent_cb)
376 printf("qemu_send_packet_async:\n");
377 hex_dump(stdout, buf, size);
380 if (sender->link_down || !sender->peer) {
384 queue = sender->peer->send_queue;
386 return qemu_net_queue_send(queue, sender, flags, buf, size, sent_cb);
389 ssize_t qemu_send_packet_async(NetClientState *sender,
390 const uint8_t *buf, int size,
391 NetPacketSent *sent_cb)
393 return qemu_send_packet_async_with_flags(sender, QEMU_NET_PACKET_FLAG_NONE,
397 void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size)
399 qemu_send_packet_async(nc, buf, size, NULL);
402 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size)
404 return qemu_send_packet_async_with_flags(nc, QEMU_NET_PACKET_FLAG_RAW,
408 static ssize_t nc_sendv_compat(NetClientState *nc, const struct iovec *iov,
411 uint8_t buffer[4096];
414 offset = iov_to_buf(iov, iovcnt, 0, buffer, sizeof(buffer));
416 return nc->info->receive(nc, buffer, offset);
419 ssize_t qemu_deliver_packet_iov(NetClientState *sender,
421 const struct iovec *iov,
425 NetClientState *nc = opaque;
429 return iov_size(iov, iovcnt);
432 if (nc->receive_disabled) {
436 if (nc->info->receive_iov) {
437 ret = nc->info->receive_iov(nc, iov, iovcnt);
439 ret = nc_sendv_compat(nc, iov, iovcnt);
443 nc->receive_disabled = 1;
449 ssize_t qemu_sendv_packet_async(NetClientState *sender,
450 const struct iovec *iov, int iovcnt,
451 NetPacketSent *sent_cb)
455 if (sender->link_down || !sender->peer) {
456 return iov_size(iov, iovcnt);
459 queue = sender->peer->send_queue;
461 return qemu_net_queue_send_iov(queue, sender,
462 QEMU_NET_PACKET_FLAG_NONE,
463 iov, iovcnt, sent_cb);
467 qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, int iovcnt)
469 return qemu_sendv_packet_async(nc, iov, iovcnt, NULL);
472 NetClientState *qemu_find_netdev(const char *id)
476 QTAILQ_FOREACH(nc, &net_clients, next) {
477 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC)
479 if (!strcmp(nc->name, id)) {
487 static int nic_get_free_idx(void)
491 for (index = 0; index < MAX_NICS; index++)
492 if (!nd_table[index].used)
497 int qemu_show_nic_models(const char *arg, const char *const *models)
501 if (!arg || !is_help_option(arg)) {
505 fprintf(stderr, "qemu: Supported NIC models: ");
506 for (i = 0 ; models[i]; i++)
507 fprintf(stderr, "%s%c", models[i], models[i+1] ? ',' : '\n');
511 void qemu_check_nic_model(NICInfo *nd, const char *model)
513 const char *models[2];
518 if (qemu_show_nic_models(nd->model, models))
520 if (qemu_find_nic_model(nd, models, model) < 0)
524 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
525 const char *default_model)
530 nd->model = g_strdup(default_model);
532 for (i = 0 ; models[i]; i++) {
533 if (strcmp(nd->model, models[i]) == 0)
537 error_report("Unsupported NIC model: %s", nd->model);
541 static int net_init_nic(const NetClientOptions *opts, const char *name,
542 NetClientState *peer)
546 const NetLegacyNicOptions *nic;
548 assert(opts->kind == NET_CLIENT_OPTIONS_KIND_NIC);
551 idx = nic_get_free_idx();
552 if (idx == -1 || nb_nics >= MAX_NICS) {
553 error_report("Too Many NICs");
559 memset(nd, 0, sizeof(*nd));
561 if (nic->has_netdev) {
562 nd->netdev = qemu_find_netdev(nic->netdev);
564 error_report("netdev '%s' not found", nic->netdev);
572 nd->name = g_strdup(name);
574 if (nic->has_model) {
575 nd->model = g_strdup(nic->model);
578 nd->devaddr = g_strdup(nic->addr);
581 if (nic->has_macaddr &&
582 net_parse_macaddr(nd->macaddr.a, nic->macaddr) < 0) {
583 error_report("invalid syntax for ethernet address");
586 qemu_macaddr_default_if_unset(&nd->macaddr);
588 if (nic->has_vectors) {
589 if (nic->vectors > 0x7ffffff) {
590 error_report("invalid # of vectors: %"PRIu32, nic->vectors);
593 nd->nvectors = nic->vectors;
595 nd->nvectors = DEV_NVECTORS_UNSPECIFIED;
605 static int (* const net_client_init_fun[NET_CLIENT_OPTIONS_KIND_MAX])(
606 const NetClientOptions *opts,
608 NetClientState *peer) = {
609 [NET_CLIENT_OPTIONS_KIND_NIC] = net_init_nic,
611 [NET_CLIENT_OPTIONS_KIND_USER] = net_init_slirp,
613 [NET_CLIENT_OPTIONS_KIND_TAP] = net_init_tap,
614 [NET_CLIENT_OPTIONS_KIND_SOCKET] = net_init_socket,
616 [NET_CLIENT_OPTIONS_KIND_VDE] = net_init_vde,
618 [NET_CLIENT_OPTIONS_KIND_DUMP] = net_init_dump,
619 #ifdef CONFIG_NET_BRIDGE
620 [NET_CLIENT_OPTIONS_KIND_BRIDGE] = net_init_bridge,
622 [NET_CLIENT_OPTIONS_KIND_HUBPORT] = net_init_hubport,
626 static int net_client_init1(const void *object, int is_netdev, Error **errp)
629 const Netdev *netdev;
630 const NetLegacy *net;
632 const NetClientOptions *opts;
637 opts = u.netdev->opts;
640 switch (opts->kind) {
642 case NET_CLIENT_OPTIONS_KIND_USER:
644 case NET_CLIENT_OPTIONS_KIND_TAP:
645 case NET_CLIENT_OPTIONS_KIND_SOCKET:
647 case NET_CLIENT_OPTIONS_KIND_VDE:
649 #ifdef CONFIG_NET_BRIDGE
650 case NET_CLIENT_OPTIONS_KIND_BRIDGE:
652 case NET_CLIENT_OPTIONS_KIND_HUBPORT:
656 error_set(errp, QERR_INVALID_PARAMETER_VALUE, "type",
657 "a netdev backend type");
663 /* missing optional values have been initialized to "all bits zero" */
664 name = u.net->has_id ? u.net->id : u.net->name;
667 if (net_client_init_fun[opts->kind]) {
668 NetClientState *peer = NULL;
670 /* Do not add to a vlan if it's a -netdev or a nic with a netdev=
673 (opts->kind != NET_CLIENT_OPTIONS_KIND_NIC ||
674 !opts->nic->has_netdev)) {
675 peer = net_hub_add_port(u.net->has_vlan ? u.net->vlan : 0, NULL);
678 if (net_client_init_fun[opts->kind](opts, name, peer) < 0) {
679 /* TODO push error reporting into init() methods */
680 error_set(errp, QERR_DEVICE_INIT_FAILED,
681 NetClientOptionsKind_lookup[opts->kind]);
689 static void net_visit(Visitor *v, int is_netdev, void **object, Error **errp)
692 visit_type_Netdev(v, (Netdev **)object, NULL, errp);
694 visit_type_NetLegacy(v, (NetLegacy **)object, NULL, errp);
699 int net_client_init(QemuOpts *opts, int is_netdev, Error **errp)
706 OptsVisitor *ov = opts_visitor_new(opts);
708 net_visit(opts_get_visitor(ov), is_netdev, &object, &err);
709 opts_visitor_cleanup(ov);
713 ret = net_client_init1(object, is_netdev, &err);
717 QapiDeallocVisitor *dv = qapi_dealloc_visitor_new();
719 net_visit(qapi_dealloc_get_visitor(dv), is_netdev, &object, NULL);
720 qapi_dealloc_visitor_cleanup(dv);
723 error_propagate(errp, err);
728 static int net_host_check_device(const char *device)
731 const char *valid_param_list[] = { "tap", "socket", "dump"
732 #ifdef CONFIG_NET_BRIDGE
742 for (i = 0; i < sizeof(valid_param_list) / sizeof(char *); i++) {
743 if (!strncmp(valid_param_list[i], device,
744 strlen(valid_param_list[i])))
751 void net_host_device_add(Monitor *mon, const QDict *qdict)
753 const char *device = qdict_get_str(qdict, "device");
754 const char *opts_str = qdict_get_try_str(qdict, "opts");
755 Error *local_err = NULL;
758 if (!net_host_check_device(device)) {
759 monitor_printf(mon, "invalid host network device %s\n", device);
763 opts = qemu_opts_parse(qemu_find_opts("net"), opts_str ? opts_str : "", 0);
768 qemu_opt_set(opts, "type", device);
770 net_client_init(opts, 0, &local_err);
771 if (error_is_set(&local_err)) {
772 qerror_report_err(local_err);
773 error_free(local_err);
774 monitor_printf(mon, "adding host network device %s failed\n", device);
778 void net_host_device_remove(Monitor *mon, const QDict *qdict)
781 int vlan_id = qdict_get_int(qdict, "vlan_id");
782 const char *device = qdict_get_str(qdict, "device");
784 nc = net_hub_find_client_by_name(vlan_id, device);
788 if (!net_host_check_device(nc->model)) {
789 monitor_printf(mon, "invalid host network device %s\n", device);
792 qemu_del_net_client(nc);
795 void netdev_add(QemuOpts *opts, Error **errp)
797 net_client_init(opts, 1, errp);
800 int qmp_netdev_add(Monitor *mon, const QDict *qdict, QObject **ret)
802 Error *local_err = NULL;
803 QemuOptsList *opts_list;
806 opts_list = qemu_find_opts_err("netdev", &local_err);
807 if (error_is_set(&local_err)) {
811 opts = qemu_opts_from_qdict(opts_list, qdict, &local_err);
812 if (error_is_set(&local_err)) {
816 netdev_add(opts, &local_err);
817 if (error_is_set(&local_err)) {
825 qerror_report_err(local_err);
826 error_free(local_err);
830 void qmp_netdev_del(const char *id, Error **errp)
834 nc = qemu_find_netdev(id);
836 error_set(errp, QERR_DEVICE_NOT_FOUND, id);
840 qemu_del_net_client(nc);
841 qemu_opts_del(qemu_opts_find(qemu_find_opts_err("netdev", errp), id));
844 void print_net_client(Monitor *mon, NetClientState *nc)
846 monitor_printf(mon, "%s: type=%s,%s\n", nc->name,
847 NetClientOptionsKind_lookup[nc->info->type], nc->info_str);
850 void do_info_network(Monitor *mon)
852 NetClientState *nc, *peer;
853 NetClientOptionsKind type;
857 QTAILQ_FOREACH(nc, &net_clients, next) {
859 type = nc->info->type;
861 /* Skip if already printed in hub info */
862 if (net_hub_id_for_client(nc, NULL) == 0) {
866 if (!peer || type == NET_CLIENT_OPTIONS_KIND_NIC) {
867 print_net_client(mon, nc);
868 } /* else it's a netdev connected to a NIC, printed with the NIC */
869 if (peer && type == NET_CLIENT_OPTIONS_KIND_NIC) {
870 monitor_printf(mon, " \\ ");
871 print_net_client(mon, peer);
876 void qmp_set_link(const char *name, bool up, Error **errp)
878 NetClientState *nc = NULL;
880 QTAILQ_FOREACH(nc, &net_clients, next) {
881 if (!strcmp(nc->name, name)) {
887 error_set(errp, QERR_DEVICE_NOT_FOUND, name);
893 if (nc->info->link_status_changed) {
894 nc->info->link_status_changed(nc);
897 /* Notify peer. Don't update peer link status: this makes it possible to
898 * disconnect from host network without notifying the guest.
899 * FIXME: is disconnected link status change operation useful?
901 * Current behaviour is compatible with qemu vlans where there could be
902 * multiple clients that can still communicate with each other in
903 * disconnected mode. For now maintain this compatibility. */
904 if (nc->peer && nc->peer->info->link_status_changed) {
905 nc->peer->info->link_status_changed(nc->peer);
909 void net_cleanup(void)
911 NetClientState *nc, *next_vc;
913 QTAILQ_FOREACH_SAFE(nc, &net_clients, next, next_vc) {
914 qemu_del_net_client(nc);
918 void net_check_clients(void)
923 /* Don't warn about the default network setup that you get if
924 * no command line -net or -netdev options are specified. There
925 * are two cases that we would otherwise complain about:
926 * (1) board doesn't support a NIC but the implicit "-net nic"
928 * (2) CONFIG_SLIRP not set, in which case the implicit "-net nic"
929 * sets up a nic that isn't connected to anything.
935 net_hub_check_clients();
937 QTAILQ_FOREACH(nc, &net_clients, next) {
939 fprintf(stderr, "Warning: %s %s has no peer\n",
940 nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC ?
941 "nic" : "netdev", nc->name);
945 /* Check that all NICs requested via -net nic actually got created.
946 * NICs created via -device don't need to be checked here because
947 * they are always instantiated.
949 for (i = 0; i < MAX_NICS; i++) {
950 NICInfo *nd = &nd_table[i];
951 if (nd->used && !nd->instantiated) {
952 fprintf(stderr, "Warning: requested NIC (%s, model %s) "
953 "was not created (not supported by this machine?)\n",
954 nd->name ? nd->name : "anonymous",
955 nd->model ? nd->model : "unspecified");
960 static int net_init_client(QemuOpts *opts, void *dummy)
962 Error *local_err = NULL;
964 net_client_init(opts, 0, &local_err);
965 if (error_is_set(&local_err)) {
966 qerror_report_err(local_err);
967 error_free(local_err);
974 static int net_init_netdev(QemuOpts *opts, void *dummy)
976 Error *local_err = NULL;
979 ret = net_client_init(opts, 1, &local_err);
980 if (error_is_set(&local_err)) {
981 qerror_report_err(local_err);
982 error_free(local_err);
989 int net_init_clients(void)
991 QemuOptsList *net = qemu_find_opts("net");
994 /* if no clients, we use a default config */
995 qemu_opts_set(net, NULL, "type", "nic");
997 qemu_opts_set(net, NULL, "type", "user");
1001 QTAILQ_INIT(&net_clients);
1003 if (qemu_opts_foreach(qemu_find_opts("netdev"), net_init_netdev, NULL, 1) == -1)
1006 if (qemu_opts_foreach(net, net_init_client, NULL, 1) == -1) {
1013 int net_client_parse(QemuOptsList *opts_list, const char *optarg)
1015 #if defined(CONFIG_SLIRP)
1017 if (net_slirp_parse_legacy(opts_list, optarg, &ret)) {
1022 if (!qemu_opts_parse(opts_list, optarg, 1)) {
1032 unsigned compute_mcast_idx(const uint8_t *ep)
1039 for (i = 0; i < 6; i++) {
1041 for (j = 0; j < 8; j++) {
1042 carry = ((crc & 0x80000000L) ? 1 : 0) ^ (b & 0x01);
1046 crc = ((crc ^ POLYNOMIAL) | carry);