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
25 #include "qemu/osdep.h"
26 #include "qemu-common.h"
31 #include "hw/qdev-properties.h"
32 #include "net/slirp.h"
36 #include "monitor/monitor.h"
37 #include "qemu/help_option.h"
38 #include "qapi/qapi-commands-net.h"
39 #include "qapi/qapi-visit-net.h"
40 #include "qapi/qmp/qdict.h"
41 #include "qapi/qmp/qerror.h"
42 #include "qemu/error-report.h"
43 #include "qemu/sockets.h"
44 #include "qemu/cutils.h"
45 #include "qemu/config-file.h"
46 #include "qemu/ctype.h"
49 #include "qemu/qemu-print.h"
50 #include "qemu/main-loop.h"
51 #include "qemu/option.h"
52 #include "qapi/error.h"
53 #include "qapi/opts-visitor.h"
54 #include "sysemu/runstate.h"
55 #include "net/colo-compare.h"
56 #include "net/filter.h"
57 #include "qapi/string-output-visitor.h"
59 /* Net bridge is currently not supported for W32. */
61 # define CONFIG_NET_BRIDGE
64 static VMChangeStateEntry *net_change_state_entry;
65 static QTAILQ_HEAD(, NetClientState) net_clients;
67 /***********************************************************/
68 /* network device redirectors */
70 int parse_host_port(struct sockaddr_in *saddr, const char *str,
75 const char *addr, *p, *r;
78 substrings = g_strsplit(str, ":", 2);
79 if (!substrings || !substrings[0] || !substrings[1]) {
80 error_setg(errp, "host address '%s' doesn't contain ':' "
81 "separating host from port", str);
89 saddr->sin_family = AF_INET;
90 if (addr[0] == '\0') {
91 saddr->sin_addr.s_addr = 0;
93 if (qemu_isdigit(addr[0])) {
94 if (!inet_aton(addr, &saddr->sin_addr)) {
95 error_setg(errp, "host address '%s' is not a valid "
96 "IPv4 address", addr);
101 he = gethostbyname(addr);
103 error_setg(errp, "can't resolve host address '%s'", addr);
107 saddr->sin_addr = *(struct in_addr *)he->h_addr;
110 port = strtol(p, (char **)&r, 0);
112 error_setg(errp, "port number '%s' is invalid", p);
116 saddr->sin_port = htons(port);
119 g_strfreev(substrings);
123 char *qemu_mac_strdup_printf(const uint8_t *macaddr)
125 return g_strdup_printf("%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
126 macaddr[0], macaddr[1], macaddr[2],
127 macaddr[3], macaddr[4], macaddr[5]);
130 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6])
132 snprintf(nc->info_str, sizeof(nc->info_str),
133 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
135 macaddr[0], macaddr[1], macaddr[2],
136 macaddr[3], macaddr[4], macaddr[5]);
139 static int mac_table[256] = {0};
141 static void qemu_macaddr_set_used(MACAddr *macaddr)
145 for (index = 0x56; index < 0xFF; index++) {
146 if (macaddr->a[5] == index) {
152 static void qemu_macaddr_set_free(MACAddr *macaddr)
155 static const MACAddr base = { .a = { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
157 if (memcmp(macaddr->a, &base.a, (sizeof(base.a) - 1)) != 0) {
160 for (index = 0x56; index < 0xFF; index++) {
161 if (macaddr->a[5] == index) {
167 static int qemu_macaddr_get_free(void)
171 for (index = 0x56; index < 0xFF; index++) {
172 if (mac_table[index] == 0) {
180 void qemu_macaddr_default_if_unset(MACAddr *macaddr)
182 static const MACAddr zero = { .a = { 0,0,0,0,0,0 } };
183 static const MACAddr base = { .a = { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
185 if (memcmp(macaddr, &zero, sizeof(zero)) != 0) {
186 if (memcmp(macaddr->a, &base.a, (sizeof(base.a) - 1)) != 0) {
189 qemu_macaddr_set_used(macaddr);
194 macaddr->a[0] = 0x52;
195 macaddr->a[1] = 0x54;
196 macaddr->a[2] = 0x00;
197 macaddr->a[3] = 0x12;
198 macaddr->a[4] = 0x34;
199 macaddr->a[5] = qemu_macaddr_get_free();
200 qemu_macaddr_set_used(macaddr);
204 * Generate a name for net client
206 * Only net clients created with the legacy -net option and NICs need this.
208 static char *assign_name(NetClientState *nc1, const char *model)
213 QTAILQ_FOREACH(nc, &net_clients, next) {
217 if (strcmp(nc->model, model) == 0) {
222 return g_strdup_printf("%s.%d", model, id);
225 static void qemu_net_client_destructor(NetClientState *nc)
229 static ssize_t qemu_deliver_packet_iov(NetClientState *sender,
231 const struct iovec *iov,
235 static void qemu_net_client_setup(NetClientState *nc,
237 NetClientState *peer,
240 NetClientDestructor *destructor)
243 nc->model = g_strdup(model);
245 nc->name = g_strdup(name);
247 nc->name = assign_name(nc, model);
255 QTAILQ_INSERT_TAIL(&net_clients, nc, next);
257 nc->incoming_queue = qemu_new_net_queue(qemu_deliver_packet_iov, nc);
258 nc->destructor = destructor;
259 QTAILQ_INIT(&nc->filters);
262 NetClientState *qemu_new_net_client(NetClientInfo *info,
263 NetClientState *peer,
269 assert(info->size >= sizeof(NetClientState));
271 nc = g_malloc0(info->size);
272 qemu_net_client_setup(nc, info, peer, model, name,
273 qemu_net_client_destructor);
278 NICState *qemu_new_nic(NetClientInfo *info,
284 NetClientState **peers = conf->peers.ncs;
286 int i, queues = MAX(1, conf->peers.queues);
288 assert(info->type == NET_CLIENT_DRIVER_NIC);
289 assert(info->size >= sizeof(NICState));
291 nic = g_malloc0(info->size + sizeof(NetClientState) * queues);
292 nic->ncs = (void *)nic + info->size;
294 nic->opaque = opaque;
296 for (i = 0; i < queues; i++) {
297 qemu_net_client_setup(&nic->ncs[i], info, peers[i], model, name,
299 nic->ncs[i].queue_index = i;
305 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index)
307 return nic->ncs + queue_index;
310 NetClientState *qemu_get_queue(NICState *nic)
312 return qemu_get_subqueue(nic, 0);
315 NICState *qemu_get_nic(NetClientState *nc)
317 NetClientState *nc0 = nc - nc->queue_index;
319 return (NICState *)((void *)nc0 - nc->info->size);
322 void *qemu_get_nic_opaque(NetClientState *nc)
324 NICState *nic = qemu_get_nic(nc);
329 NetClientState *qemu_get_peer(NetClientState *nc, int queue_index)
332 NetClientState *ncs = nc + queue_index;
336 static void qemu_cleanup_net_client(NetClientState *nc)
338 QTAILQ_REMOVE(&net_clients, nc, next);
340 if (nc->info->cleanup) {
341 nc->info->cleanup(nc);
345 static void qemu_free_net_client(NetClientState *nc)
347 if (nc->incoming_queue) {
348 qemu_del_net_queue(nc->incoming_queue);
351 nc->peer->peer = NULL;
355 if (nc->destructor) {
360 void qemu_del_net_client(NetClientState *nc)
362 NetClientState *ncs[MAX_QUEUE_NUM];
364 NetFilterState *nf, *next;
366 assert(nc->info->type != NET_CLIENT_DRIVER_NIC);
368 /* If the NetClientState belongs to a multiqueue backend, we will change all
369 * other NetClientStates also.
371 queues = qemu_find_net_clients_except(nc->name, ncs,
372 NET_CLIENT_DRIVER_NIC,
376 QTAILQ_FOREACH_SAFE(nf, &nc->filters, next, next) {
377 object_unparent(OBJECT(nf));
380 /* If there is a peer NIC, delete and cleanup client, but do not free. */
381 if (nc->peer && nc->peer->info->type == NET_CLIENT_DRIVER_NIC) {
382 NICState *nic = qemu_get_nic(nc->peer);
383 if (nic->peer_deleted) {
386 nic->peer_deleted = true;
388 for (i = 0; i < queues; i++) {
389 ncs[i]->peer->link_down = true;
392 if (nc->peer->info->link_status_changed) {
393 nc->peer->info->link_status_changed(nc->peer);
396 for (i = 0; i < queues; i++) {
397 qemu_cleanup_net_client(ncs[i]);
403 for (i = 0; i < queues; i++) {
404 qemu_cleanup_net_client(ncs[i]);
405 qemu_free_net_client(ncs[i]);
409 void qemu_del_nic(NICState *nic)
411 int i, queues = MAX(nic->conf->peers.queues, 1);
413 qemu_macaddr_set_free(&nic->conf->macaddr);
415 for (i = 0; i < queues; i++) {
416 NetClientState *nc = qemu_get_subqueue(nic, i);
417 /* If this is a peer NIC and peer has already been deleted, free it now. */
418 if (nic->peer_deleted) {
419 qemu_free_net_client(nc->peer);
420 } else if (nc->peer) {
421 /* if there are RX packets pending, complete them */
422 qemu_purge_queued_packets(nc->peer);
426 for (i = queues - 1; i >= 0; i--) {
427 NetClientState *nc = qemu_get_subqueue(nic, i);
429 qemu_cleanup_net_client(nc);
430 qemu_free_net_client(nc);
436 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque)
440 QTAILQ_FOREACH(nc, &net_clients, next) {
441 if (nc->info->type == NET_CLIENT_DRIVER_NIC) {
442 if (nc->queue_index == 0) {
443 func(qemu_get_nic(nc), opaque);
449 bool qemu_has_ufo(NetClientState *nc)
451 if (!nc || !nc->info->has_ufo) {
455 return nc->info->has_ufo(nc);
458 bool qemu_has_vnet_hdr(NetClientState *nc)
460 if (!nc || !nc->info->has_vnet_hdr) {
464 return nc->info->has_vnet_hdr(nc);
467 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len)
469 if (!nc || !nc->info->has_vnet_hdr_len) {
473 return nc->info->has_vnet_hdr_len(nc, len);
476 void qemu_using_vnet_hdr(NetClientState *nc, bool enable)
478 if (!nc || !nc->info->using_vnet_hdr) {
482 nc->info->using_vnet_hdr(nc, enable);
485 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
488 if (!nc || !nc->info->set_offload) {
492 nc->info->set_offload(nc, csum, tso4, tso6, ecn, ufo);
495 void qemu_set_vnet_hdr_len(NetClientState *nc, int len)
497 if (!nc || !nc->info->set_vnet_hdr_len) {
501 nc->vnet_hdr_len = len;
502 nc->info->set_vnet_hdr_len(nc, len);
505 int qemu_set_vnet_le(NetClientState *nc, bool is_le)
507 #ifdef HOST_WORDS_BIGENDIAN
508 if (!nc || !nc->info->set_vnet_le) {
512 return nc->info->set_vnet_le(nc, is_le);
518 int qemu_set_vnet_be(NetClientState *nc, bool is_be)
520 #ifdef HOST_WORDS_BIGENDIAN
523 if (!nc || !nc->info->set_vnet_be) {
527 return nc->info->set_vnet_be(nc, is_be);
531 int qemu_can_receive_packet(NetClientState *nc)
533 if (nc->receive_disabled) {
535 } else if (nc->info->can_receive &&
536 !nc->info->can_receive(nc)) {
542 int qemu_can_send_packet(NetClientState *sender)
544 int vm_running = runstate_is_running();
554 return qemu_can_receive_packet(sender->peer);
557 static ssize_t filter_receive_iov(NetClientState *nc,
558 NetFilterDirection direction,
559 NetClientState *sender,
561 const struct iovec *iov,
563 NetPacketSent *sent_cb)
566 NetFilterState *nf = NULL;
568 if (direction == NET_FILTER_DIRECTION_TX) {
569 QTAILQ_FOREACH(nf, &nc->filters, next) {
570 ret = qemu_netfilter_receive(nf, direction, sender, flags, iov,
577 QTAILQ_FOREACH_REVERSE(nf, &nc->filters, next) {
578 ret = qemu_netfilter_receive(nf, direction, sender, flags, iov,
589 static ssize_t filter_receive(NetClientState *nc,
590 NetFilterDirection direction,
591 NetClientState *sender,
595 NetPacketSent *sent_cb)
598 .iov_base = (void *)data,
602 return filter_receive_iov(nc, direction, sender, flags, &iov, 1, sent_cb);
605 void qemu_purge_queued_packets(NetClientState *nc)
611 qemu_net_queue_purge(nc->peer->incoming_queue, nc);
614 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge)
616 nc->receive_disabled = 0;
618 if (nc->peer && nc->peer->info->type == NET_CLIENT_DRIVER_HUBPORT) {
619 if (net_hub_flush(nc->peer)) {
623 if (qemu_net_queue_flush(nc->incoming_queue)) {
624 /* We emptied the queue successfully, signal to the IO thread to repoll
625 * the file descriptor (for tap, for example).
629 /* Unable to empty the queue, purge remaining packets */
630 qemu_net_queue_purge(nc->incoming_queue, nc->peer);
634 void qemu_flush_queued_packets(NetClientState *nc)
636 qemu_flush_or_purge_queued_packets(nc, false);
639 static ssize_t qemu_send_packet_async_with_flags(NetClientState *sender,
641 const uint8_t *buf, int size,
642 NetPacketSent *sent_cb)
648 printf("qemu_send_packet_async:\n");
649 qemu_hexdump(stdout, "net", buf, size);
652 if (sender->link_down || !sender->peer) {
656 /* Let filters handle the packet first */
657 ret = filter_receive(sender, NET_FILTER_DIRECTION_TX,
658 sender, flags, buf, size, sent_cb);
663 ret = filter_receive(sender->peer, NET_FILTER_DIRECTION_RX,
664 sender, flags, buf, size, sent_cb);
669 queue = sender->peer->incoming_queue;
671 return qemu_net_queue_send(queue, sender, flags, buf, size, sent_cb);
674 ssize_t qemu_send_packet_async(NetClientState *sender,
675 const uint8_t *buf, int size,
676 NetPacketSent *sent_cb)
678 return qemu_send_packet_async_with_flags(sender, QEMU_NET_PACKET_FLAG_NONE,
682 ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size)
684 return qemu_send_packet_async(nc, buf, size, NULL);
687 ssize_t qemu_receive_packet(NetClientState *nc, const uint8_t *buf, int size)
689 if (!qemu_can_receive_packet(nc)) {
693 return qemu_net_queue_receive(nc->incoming_queue, buf, size);
696 ssize_t qemu_receive_packet_iov(NetClientState *nc, const struct iovec *iov,
699 if (!qemu_can_receive_packet(nc)) {
703 return qemu_net_queue_receive_iov(nc->incoming_queue, iov, iovcnt);
706 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size)
708 return qemu_send_packet_async_with_flags(nc, QEMU_NET_PACKET_FLAG_RAW,
712 static ssize_t nc_sendv_compat(NetClientState *nc, const struct iovec *iov,
713 int iovcnt, unsigned flags)
721 buffer = iov[0].iov_base;
722 offset = iov[0].iov_len;
724 offset = iov_size(iov, iovcnt);
725 if (offset > NET_BUFSIZE) {
728 buf = g_malloc(offset);
730 offset = iov_to_buf(iov, iovcnt, 0, buf, offset);
733 if (flags & QEMU_NET_PACKET_FLAG_RAW && nc->info->receive_raw) {
734 ret = nc->info->receive_raw(nc, buffer, offset);
736 ret = nc->info->receive(nc, buffer, offset);
743 static ssize_t qemu_deliver_packet_iov(NetClientState *sender,
745 const struct iovec *iov,
749 NetClientState *nc = opaque;
754 return iov_size(iov, iovcnt);
757 if (nc->receive_disabled) {
761 if (nc->info->receive_iov && !(flags & QEMU_NET_PACKET_FLAG_RAW)) {
762 ret = nc->info->receive_iov(nc, iov, iovcnt);
764 ret = nc_sendv_compat(nc, iov, iovcnt, flags);
768 nc->receive_disabled = 1;
774 ssize_t qemu_sendv_packet_async(NetClientState *sender,
775 const struct iovec *iov, int iovcnt,
776 NetPacketSent *sent_cb)
779 size_t size = iov_size(iov, iovcnt);
782 if (size > NET_BUFSIZE) {
786 if (sender->link_down || !sender->peer) {
790 /* Let filters handle the packet first */
791 ret = filter_receive_iov(sender, NET_FILTER_DIRECTION_TX, sender,
792 QEMU_NET_PACKET_FLAG_NONE, iov, iovcnt, sent_cb);
797 ret = filter_receive_iov(sender->peer, NET_FILTER_DIRECTION_RX, sender,
798 QEMU_NET_PACKET_FLAG_NONE, iov, iovcnt, sent_cb);
803 queue = sender->peer->incoming_queue;
805 return qemu_net_queue_send_iov(queue, sender,
806 QEMU_NET_PACKET_FLAG_NONE,
807 iov, iovcnt, sent_cb);
811 qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, int iovcnt)
813 return qemu_sendv_packet_async(nc, iov, iovcnt, NULL);
816 NetClientState *qemu_find_netdev(const char *id)
820 QTAILQ_FOREACH(nc, &net_clients, next) {
821 if (nc->info->type == NET_CLIENT_DRIVER_NIC)
823 if (!strcmp(nc->name, id)) {
831 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
832 NetClientDriver type, int max)
837 QTAILQ_FOREACH(nc, &net_clients, next) {
838 if (nc->info->type == type) {
841 if (!id || !strcmp(nc->name, id)) {
852 static int nic_get_free_idx(void)
856 for (index = 0; index < MAX_NICS; index++)
857 if (!nd_table[index].used)
862 int qemu_show_nic_models(const char *arg, const char *const *models)
866 if (!arg || !is_help_option(arg)) {
870 printf("Supported NIC models:\n");
871 for (i = 0 ; models[i]; i++) {
872 printf("%s\n", models[i]);
877 void qemu_check_nic_model(NICInfo *nd, const char *model)
879 const char *models[2];
884 if (qemu_show_nic_models(nd->model, models))
886 if (qemu_find_nic_model(nd, models, model) < 0)
890 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
891 const char *default_model)
896 nd->model = g_strdup(default_model);
898 for (i = 0 ; models[i]; i++) {
899 if (strcmp(nd->model, models[i]) == 0)
903 error_report("Unsupported NIC model: %s", nd->model);
907 static int net_init_nic(const Netdev *netdev, const char *name,
908 NetClientState *peer, Error **errp)
912 const NetLegacyNicOptions *nic;
914 assert(netdev->type == NET_CLIENT_DRIVER_NIC);
915 nic = &netdev->u.nic;
917 idx = nic_get_free_idx();
918 if (idx == -1 || nb_nics >= MAX_NICS) {
919 error_setg(errp, "too many NICs");
925 memset(nd, 0, sizeof(*nd));
927 if (nic->has_netdev) {
928 nd->netdev = qemu_find_netdev(nic->netdev);
930 error_setg(errp, "netdev '%s' not found", nic->netdev);
937 nd->name = g_strdup(name);
938 if (nic->has_model) {
939 nd->model = g_strdup(nic->model);
942 nd->devaddr = g_strdup(nic->addr);
945 if (nic->has_macaddr &&
946 net_parse_macaddr(nd->macaddr.a, nic->macaddr) < 0) {
947 error_setg(errp, "invalid syntax for ethernet address");
950 if (nic->has_macaddr &&
951 is_multicast_ether_addr(nd->macaddr.a)) {
953 "NIC cannot have multicast MAC address (odd 1st byte)");
956 qemu_macaddr_default_if_unset(&nd->macaddr);
958 if (nic->has_vectors) {
959 if (nic->vectors > 0x7ffffff) {
960 error_setg(errp, "invalid # of vectors: %"PRIu32, nic->vectors);
963 nd->nvectors = nic->vectors;
965 nd->nvectors = DEV_NVECTORS_UNSPECIFIED;
975 static int (* const net_client_init_fun[NET_CLIENT_DRIVER__MAX])(
976 const Netdev *netdev,
978 NetClientState *peer, Error **errp) = {
979 [NET_CLIENT_DRIVER_NIC] = net_init_nic,
981 [NET_CLIENT_DRIVER_USER] = net_init_slirp,
983 [NET_CLIENT_DRIVER_TAP] = net_init_tap,
984 [NET_CLIENT_DRIVER_SOCKET] = net_init_socket,
986 [NET_CLIENT_DRIVER_VDE] = net_init_vde,
989 [NET_CLIENT_DRIVER_NETMAP] = net_init_netmap,
991 #ifdef CONFIG_NET_BRIDGE
992 [NET_CLIENT_DRIVER_BRIDGE] = net_init_bridge,
994 [NET_CLIENT_DRIVER_HUBPORT] = net_init_hubport,
995 #ifdef CONFIG_VHOST_NET_USER
996 [NET_CLIENT_DRIVER_VHOST_USER] = net_init_vhost_user,
998 #ifdef CONFIG_VHOST_NET_VDPA
999 [NET_CLIENT_DRIVER_VHOST_VDPA] = net_init_vhost_vdpa,
1001 #ifdef CONFIG_L2TPV3
1002 [NET_CLIENT_DRIVER_L2TPV3] = net_init_l2tpv3,
1007 static int net_client_init1(const Netdev *netdev, bool is_netdev, Error **errp)
1009 NetClientState *peer = NULL;
1013 if (netdev->type == NET_CLIENT_DRIVER_NIC ||
1014 !net_client_init_fun[netdev->type]) {
1015 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "type",
1016 "a netdev backend type");
1020 if (netdev->type == NET_CLIENT_DRIVER_NONE) {
1021 return 0; /* nothing to do */
1023 if (netdev->type == NET_CLIENT_DRIVER_HUBPORT ||
1024 !net_client_init_fun[netdev->type]) {
1025 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "type",
1026 "a net backend type (maybe it is not compiled "
1027 "into this binary)");
1031 /* Do not add to a hub if it's a nic with a netdev= parameter. */
1032 if (netdev->type != NET_CLIENT_DRIVER_NIC ||
1033 !netdev->u.nic.has_netdev) {
1034 peer = net_hub_add_port(0, NULL, NULL);
1038 nc = qemu_find_netdev(netdev->id);
1040 error_setg(errp, "Duplicate ID '%s'", netdev->id);
1044 if (net_client_init_fun[netdev->type](netdev, netdev->id, peer, errp) < 0) {
1045 /* FIXME drop when all init functions store an Error */
1046 if (errp && !*errp) {
1047 error_setg(errp, "Device '%s' could not be initialized",
1048 NetClientDriver_str(netdev->type));
1054 nc = qemu_find_netdev(netdev->id);
1056 nc->is_netdev = true;
1062 void show_netdevs(void)
1065 const char *available_netdevs[] = {
1072 #ifdef CONFIG_L2TPV3
1078 #ifdef CONFIG_NET_BRIDGE
1081 #ifdef CONFIG_NETMAP
1087 #ifdef CONFIG_VHOST_VDPA
1092 qemu_printf("Available netdev backend types:\n");
1093 for (idx = 0; idx < ARRAY_SIZE(available_netdevs); idx++) {
1094 qemu_printf("%s\n", available_netdevs[idx]);
1098 static int net_client_init(QemuOpts *opts, bool is_netdev, Error **errp)
1100 gchar **substrings = NULL;
1101 Netdev *object = NULL;
1103 Visitor *v = opts_visitor_new(opts);
1105 /* Parse convenience option format ip6-net=fec0::0[/64] */
1106 const char *ip6_net = qemu_opt_get(opts, "ipv6-net");
1110 unsigned long prefix_len = 64; /* Default 64bit prefix length. */
1112 substrings = g_strsplit(ip6_net, "/", 2);
1113 if (!substrings || !substrings[0]) {
1114 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "ipv6-net",
1115 "a valid IPv6 prefix");
1119 prefix_addr = substrings[0];
1121 /* Handle user-specified prefix length. */
1122 if (substrings[1] &&
1123 qemu_strtoul(substrings[1], NULL, 10, &prefix_len))
1125 error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
1126 "ipv6-prefixlen", "a number");
1130 qemu_opt_set(opts, "ipv6-prefix", prefix_addr, &error_abort);
1131 qemu_opt_set_number(opts, "ipv6-prefixlen", prefix_len,
1133 qemu_opt_unset(opts, "ipv6-net");
1136 /* Create an ID for -net if the user did not specify one */
1137 if (!is_netdev && !qemu_opts_id(opts)) {
1138 qemu_opts_set_id(opts, id_generate(ID_NET));
1141 if (visit_type_Netdev(v, NULL, &object, errp)) {
1142 ret = net_client_init1(object, is_netdev, errp);
1145 qapi_free_Netdev(object);
1148 g_strfreev(substrings);
1153 void netdev_add(QemuOpts *opts, Error **errp)
1155 net_client_init(opts, true, errp);
1158 void qmp_netdev_add(Netdev *netdev, Error **errp)
1160 if (!id_wellformed(netdev->id)) {
1161 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "id", "an identifier");
1165 net_client_init1(netdev, true, errp);
1168 void qmp_netdev_del(const char *id, Error **errp)
1173 nc = qemu_find_netdev(id);
1175 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1176 "Device '%s' not found", id);
1180 if (!nc->is_netdev) {
1181 error_setg(errp, "Device '%s' is not a netdev", id);
1185 qemu_del_net_client(nc);
1188 * Wart: we need to delete the QemuOpts associated with netdevs
1189 * created via CLI or HMP, to avoid bogus "Duplicate ID" errors in
1192 opts = qemu_opts_find(qemu_find_opts("netdev"), id);
1194 qemu_opts_del(opts);
1198 static void netfilter_print_info(Monitor *mon, NetFilterState *nf)
1201 ObjectProperty *prop;
1202 ObjectPropertyIterator iter;
1205 /* generate info str */
1206 object_property_iter_init(&iter, OBJECT(nf));
1207 while ((prop = object_property_iter_next(&iter))) {
1208 if (!strcmp(prop->name, "type")) {
1211 v = string_output_visitor_new(false, &str);
1212 object_property_get(OBJECT(nf), prop->name, v, NULL);
1213 visit_complete(v, &str);
1215 monitor_printf(mon, ",%s=%s", prop->name, str);
1218 monitor_printf(mon, "\n");
1221 void print_net_client(Monitor *mon, NetClientState *nc)
1225 monitor_printf(mon, "%s: index=%d,type=%s,%s\n", nc->name,
1227 NetClientDriver_str(nc->info->type),
1229 if (!QTAILQ_EMPTY(&nc->filters)) {
1230 monitor_printf(mon, "filters:\n");
1232 QTAILQ_FOREACH(nf, &nc->filters, next) {
1233 monitor_printf(mon, " - %s: type=%s",
1234 object_get_canonical_path_component(OBJECT(nf)),
1235 object_get_typename(OBJECT(nf)));
1236 netfilter_print_info(mon, nf);
1240 RxFilterInfoList *qmp_query_rx_filter(bool has_name, const char *name,
1244 RxFilterInfoList *filter_list = NULL, **tail = &filter_list;
1246 QTAILQ_FOREACH(nc, &net_clients, next) {
1249 if (has_name && strcmp(nc->name, name) != 0) {
1253 /* only query rx-filter information of NIC */
1254 if (nc->info->type != NET_CLIENT_DRIVER_NIC) {
1256 error_setg(errp, "net client(%s) isn't a NIC", name);
1257 assert(!filter_list);
1263 /* only query information on queue 0 since the info is per nic,
1266 if (nc->queue_index != 0)
1269 if (nc->info->query_rx_filter) {
1270 info = nc->info->query_rx_filter(nc);
1271 QAPI_LIST_APPEND(tail, info);
1272 } else if (has_name) {
1273 error_setg(errp, "net client(%s) doesn't support"
1274 " rx-filter querying", name);
1275 assert(!filter_list);
1284 if (filter_list == NULL && has_name) {
1285 error_setg(errp, "invalid net client name: %s", name);
1291 void hmp_info_network(Monitor *mon, const QDict *qdict)
1293 NetClientState *nc, *peer;
1294 NetClientDriver type;
1298 QTAILQ_FOREACH(nc, &net_clients, next) {
1300 type = nc->info->type;
1302 /* Skip if already printed in hub info */
1303 if (net_hub_id_for_client(nc, NULL) == 0) {
1307 if (!peer || type == NET_CLIENT_DRIVER_NIC) {
1308 print_net_client(mon, nc);
1309 } /* else it's a netdev connected to a NIC, printed with the NIC */
1310 if (peer && type == NET_CLIENT_DRIVER_NIC) {
1311 monitor_printf(mon, " \\ ");
1312 print_net_client(mon, peer);
1317 void colo_notify_filters_event(int event, Error **errp)
1321 NetFilterClass *nfc = NULL;
1322 Error *local_err = NULL;
1324 QTAILQ_FOREACH(nc, &net_clients, next) {
1325 QTAILQ_FOREACH(nf, &nc->filters, next) {
1326 nfc = NETFILTER_GET_CLASS(OBJECT(nf));
1327 nfc->handle_event(nf, event, &local_err);
1329 error_propagate(errp, local_err);
1336 void qmp_set_link(const char *name, bool up, Error **errp)
1338 NetClientState *ncs[MAX_QUEUE_NUM];
1342 queues = qemu_find_net_clients_except(name, ncs,
1343 NET_CLIENT_DRIVER__MAX,
1347 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1348 "Device '%s' not found", name);
1353 for (i = 0; i < queues; i++) {
1354 ncs[i]->link_down = !up;
1357 if (nc->info->link_status_changed) {
1358 nc->info->link_status_changed(nc);
1362 /* Change peer link only if the peer is NIC and then notify peer.
1363 * If the peer is a HUBPORT or a backend, we do not change the
1366 * This behavior is compatible with qemu hubs where there could be
1367 * multiple clients that can still communicate with each other in
1368 * disconnected mode. For now maintain this compatibility.
1370 if (nc->peer->info->type == NET_CLIENT_DRIVER_NIC) {
1371 for (i = 0; i < queues; i++) {
1372 ncs[i]->peer->link_down = !up;
1375 if (nc->peer->info->link_status_changed) {
1376 nc->peer->info->link_status_changed(nc->peer);
1381 static void net_vm_change_state_handler(void *opaque, bool running,
1385 NetClientState *tmp;
1387 QTAILQ_FOREACH_SAFE(nc, &net_clients, next, tmp) {
1389 /* Flush queued packets and wake up backends. */
1390 if (nc->peer && qemu_can_send_packet(nc)) {
1391 qemu_flush_queued_packets(nc->peer);
1394 /* Complete all queued packets, to guarantee we don't modify
1395 * state later when VM is not running.
1397 qemu_flush_or_purge_queued_packets(nc, true);
1402 void net_cleanup(void)
1406 /*cleanup colo compare module for COLO*/
1407 colo_compare_cleanup();
1409 /* We may del multiple entries during qemu_del_net_client(),
1410 * so QTAILQ_FOREACH_SAFE() is also not safe here.
1412 while (!QTAILQ_EMPTY(&net_clients)) {
1413 nc = QTAILQ_FIRST(&net_clients);
1414 if (nc->info->type == NET_CLIENT_DRIVER_NIC) {
1415 qemu_del_nic(qemu_get_nic(nc));
1417 qemu_del_net_client(nc);
1421 qemu_del_vm_change_state_handler(net_change_state_entry);
1424 void net_check_clients(void)
1429 net_hub_check_clients();
1431 QTAILQ_FOREACH(nc, &net_clients, next) {
1433 warn_report("%s %s has no peer",
1434 nc->info->type == NET_CLIENT_DRIVER_NIC
1440 /* Check that all NICs requested via -net nic actually got created.
1441 * NICs created via -device don't need to be checked here because
1442 * they are always instantiated.
1444 for (i = 0; i < MAX_NICS; i++) {
1445 NICInfo *nd = &nd_table[i];
1446 if (nd->used && !nd->instantiated) {
1447 warn_report("requested NIC (%s, model %s) "
1448 "was not created (not supported by this machine?)",
1449 nd->name ? nd->name : "anonymous",
1450 nd->model ? nd->model : "unspecified");
1455 static int net_init_client(void *dummy, QemuOpts *opts, Error **errp)
1457 return net_client_init(opts, false, errp);
1460 static int net_init_netdev(void *dummy, QemuOpts *opts, Error **errp)
1462 const char *type = qemu_opt_get(opts, "type");
1464 if (type && is_help_option(type)) {
1468 return net_client_init(opts, true, errp);
1471 /* For the convenience "--nic" parameter */
1472 static int net_param_nic(void *dummy, QemuOpts *opts, Error **errp)
1479 type = qemu_opt_get(opts, "type");
1480 if (type && g_str_equal(type, "none")) {
1481 return 0; /* Nothing to do, default_net is cleared in vl.c */
1484 idx = nic_get_free_idx();
1485 if (idx == -1 || nb_nics >= MAX_NICS) {
1486 error_setg(errp, "no more on-board/default NIC slots available");
1491 qemu_opt_set(opts, "type", "user", &error_abort);
1494 ni = &nd_table[idx];
1495 memset(ni, 0, sizeof(*ni));
1496 ni->model = qemu_opt_get_del(opts, "model");
1498 /* Create an ID if the user did not specify one */
1499 nd_id = g_strdup(qemu_opts_id(opts));
1501 nd_id = id_generate(ID_NET);
1502 qemu_opts_set_id(opts, nd_id);
1505 /* Handle MAC address */
1506 mac = qemu_opt_get_del(opts, "mac");
1508 ret = net_parse_macaddr(ni->macaddr.a, mac);
1511 error_setg(errp, "invalid syntax for ethernet address");
1514 if (is_multicast_ether_addr(ni->macaddr.a)) {
1515 error_setg(errp, "NIC cannot have multicast MAC address");
1520 qemu_macaddr_default_if_unset(&ni->macaddr);
1522 ret = net_client_init(opts, true, errp);
1524 ni->netdev = qemu_find_netdev(nd_id);
1534 int net_init_clients(Error **errp)
1536 net_change_state_entry =
1537 qemu_add_vm_change_state_handler(net_vm_change_state_handler, NULL);
1539 QTAILQ_INIT(&net_clients);
1541 if (qemu_opts_foreach(qemu_find_opts("netdev"),
1542 net_init_netdev, NULL, errp)) {
1546 if (qemu_opts_foreach(qemu_find_opts("nic"), net_param_nic, NULL, errp)) {
1550 if (qemu_opts_foreach(qemu_find_opts("net"), net_init_client, NULL, errp)) {
1557 int net_client_parse(QemuOptsList *opts_list, const char *optarg)
1559 if (!qemu_opts_parse_noisily(opts_list, optarg, true)) {
1568 uint32_t net_crc32(const uint8_t *p, int len)
1575 for (i = 0; i < len; i++) {
1577 for (j = 0; j < 8; j++) {
1578 carry = ((crc & 0x80000000L) ? 1 : 0) ^ (b & 0x01);
1582 crc = ((crc ^ POLYNOMIAL_BE) | carry);
1590 uint32_t net_crc32_le(const uint8_t *p, int len)
1597 for (i = 0; i < len; i++) {
1599 for (j = 0; j < 8; j++) {
1600 carry = (crc & 0x1) ^ (b & 0x01);
1604 crc ^= POLYNOMIAL_LE;
1612 QemuOptsList qemu_netdev_opts = {
1614 .implied_opt_name = "type",
1615 .head = QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts.head),
1618 * no elements => accept any params
1619 * validation will happen later
1621 { /* end of list */ }
1625 QemuOptsList qemu_nic_opts = {
1627 .implied_opt_name = "type",
1628 .head = QTAILQ_HEAD_INITIALIZER(qemu_nic_opts.head),
1631 * no elements => accept any params
1632 * validation will happen later
1634 { /* end of list */ }
1638 QemuOptsList qemu_net_opts = {
1640 .implied_opt_name = "type",
1641 .head = QTAILQ_HEAD_INITIALIZER(qemu_net_opts.head),
1644 * no elements => accept any params
1645 * validation will happen later
1647 { /* end of list */ }
1651 void net_socket_rs_init(SocketReadState *rs,
1652 SocketReadStateFinalize *finalize,
1656 rs->vnet_hdr = vnet_hdr;
1659 rs->vnet_hdr_len = 0;
1660 memset(rs->buf, 0, sizeof(rs->buf));
1661 rs->finalize = finalize;
1669 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size)
1674 /* Reassemble a packet from the network.
1675 * 0 = getting length.
1676 * 1 = getting vnet header length.
1679 switch (rs->state) {
1685 memcpy(rs->buf + rs->index, buf, l);
1689 if (rs->index == 4) {
1691 rs->packet_len = ntohl(*(uint32_t *)rs->buf);
1697 rs->vnet_hdr_len = 0;
1706 memcpy(rs->buf + rs->index, buf, l);
1710 if (rs->index == 4) {
1711 /* got vnet header length */
1712 rs->vnet_hdr_len = ntohl(*(uint32_t *)rs->buf);
1718 l = rs->packet_len - rs->index;
1722 if (rs->index + l <= sizeof(rs->buf)) {
1723 memcpy(rs->buf + rs->index, buf, l);
1725 fprintf(stderr, "serious error: oversized packet received,"
1726 "connection terminated.\n");
1727 rs->index = rs->state = 0;
1734 if (rs->index >= rs->packet_len) {
1737 assert(rs->finalize);