qapi: promote input-send-event to stable
[qemu/rayw.git] / net / net.c
blobaebf7531a8f91050ab22ba344af4bfffa1077c6f
1 /*
2 * QEMU System Emulator
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
22 * THE SOFTWARE.
24 #include "qemu/osdep.h"
26 #include "net/net.h"
27 #include "clients.h"
28 #include "hub.h"
29 #include "net/slirp.h"
30 #include "net/eth.h"
31 #include "util.h"
33 #include "monitor/monitor.h"
34 #include "qemu-common.h"
35 #include "qapi/qmp/qerror.h"
36 #include "qemu/error-report.h"
37 #include "qemu/sockets.h"
38 #include "qemu/config-file.h"
39 #include "qmp-commands.h"
40 #include "hw/qdev.h"
41 #include "qemu/iov.h"
42 #include "qemu/main-loop.h"
43 #include "qapi-visit.h"
44 #include "qapi/opts-visitor.h"
45 #include "qapi/dealloc-visitor.h"
46 #include "sysemu/sysemu.h"
47 #include "net/filter.h"
48 #include "qapi/string-output-visitor.h"
50 /* Net bridge is currently not supported for W32. */
51 #if !defined(_WIN32)
52 # define CONFIG_NET_BRIDGE
53 #endif
55 static VMChangeStateEntry *net_change_state_entry;
56 static QTAILQ_HEAD(, NetClientState) net_clients;
58 const char *host_net_devices[] = {
59 "tap",
60 "socket",
61 "dump",
62 #ifdef CONFIG_NET_BRIDGE
63 "bridge",
64 #endif
65 #ifdef CONFIG_NETMAP
66 "netmap",
67 #endif
68 #ifdef CONFIG_SLIRP
69 "user",
70 #endif
71 #ifdef CONFIG_VDE
72 "vde",
73 #endif
74 "vhost-user",
75 NULL,
78 int default_net = 1;
80 /***********************************************************/
81 /* network device redirectors */
83 #if defined(DEBUG_NET)
84 static void hex_dump(FILE *f, const uint8_t *buf, int size)
86 int len, i, j, c;
88 for(i=0;i<size;i+=16) {
89 len = size - i;
90 if (len > 16)
91 len = 16;
92 fprintf(f, "%08x ", i);
93 for(j=0;j<16;j++) {
94 if (j < len)
95 fprintf(f, " %02x", buf[i+j]);
96 else
97 fprintf(f, " ");
99 fprintf(f, " ");
100 for(j=0;j<len;j++) {
101 c = buf[i+j];
102 if (c < ' ' || c > '~')
103 c = '.';
104 fprintf(f, "%c", c);
106 fprintf(f, "\n");
109 #endif
111 static int get_str_sep(char *buf, int buf_size, const char **pp, int sep)
113 const char *p, *p1;
114 int len;
115 p = *pp;
116 p1 = strchr(p, sep);
117 if (!p1)
118 return -1;
119 len = p1 - p;
120 p1++;
121 if (buf_size > 0) {
122 if (len > buf_size - 1)
123 len = buf_size - 1;
124 memcpy(buf, p, len);
125 buf[len] = '\0';
127 *pp = p1;
128 return 0;
131 int parse_host_port(struct sockaddr_in *saddr, const char *str)
133 char buf[512];
134 struct hostent *he;
135 const char *p, *r;
136 int port;
138 p = str;
139 if (get_str_sep(buf, sizeof(buf), &p, ':') < 0)
140 return -1;
141 saddr->sin_family = AF_INET;
142 if (buf[0] == '\0') {
143 saddr->sin_addr.s_addr = 0;
144 } else {
145 if (qemu_isdigit(buf[0])) {
146 if (!inet_aton(buf, &saddr->sin_addr))
147 return -1;
148 } else {
149 if ((he = gethostbyname(buf)) == NULL)
150 return - 1;
151 saddr->sin_addr = *(struct in_addr *)he->h_addr;
154 port = strtol(p, (char **)&r, 0);
155 if (r == p)
156 return -1;
157 saddr->sin_port = htons(port);
158 return 0;
161 char *qemu_mac_strdup_printf(const uint8_t *macaddr)
163 return g_strdup_printf("%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
164 macaddr[0], macaddr[1], macaddr[2],
165 macaddr[3], macaddr[4], macaddr[5]);
168 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6])
170 snprintf(nc->info_str, sizeof(nc->info_str),
171 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
172 nc->model,
173 macaddr[0], macaddr[1], macaddr[2],
174 macaddr[3], macaddr[4], macaddr[5]);
177 static int mac_table[256] = {0};
179 static void qemu_macaddr_set_used(MACAddr *macaddr)
181 int index;
183 for (index = 0x56; index < 0xFF; index++) {
184 if (macaddr->a[5] == index) {
185 mac_table[index]++;
190 static void qemu_macaddr_set_free(MACAddr *macaddr)
192 int index;
193 static const MACAddr base = { .a = { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
195 if (memcmp(macaddr->a, &base.a, (sizeof(base.a) - 1)) != 0) {
196 return;
198 for (index = 0x56; index < 0xFF; index++) {
199 if (macaddr->a[5] == index) {
200 mac_table[index]--;
205 static int qemu_macaddr_get_free(void)
207 int index;
209 for (index = 0x56; index < 0xFF; index++) {
210 if (mac_table[index] == 0) {
211 return index;
215 return -1;
218 void qemu_macaddr_default_if_unset(MACAddr *macaddr)
220 static const MACAddr zero = { .a = { 0,0,0,0,0,0 } };
221 static const MACAddr base = { .a = { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
223 if (memcmp(macaddr, &zero, sizeof(zero)) != 0) {
224 if (memcmp(macaddr->a, &base.a, (sizeof(base.a) - 1)) != 0) {
225 return;
226 } else {
227 qemu_macaddr_set_used(macaddr);
228 return;
232 macaddr->a[0] = 0x52;
233 macaddr->a[1] = 0x54;
234 macaddr->a[2] = 0x00;
235 macaddr->a[3] = 0x12;
236 macaddr->a[4] = 0x34;
237 macaddr->a[5] = qemu_macaddr_get_free();
238 qemu_macaddr_set_used(macaddr);
242 * Generate a name for net client
244 * Only net clients created with the legacy -net option and NICs need this.
246 static char *assign_name(NetClientState *nc1, const char *model)
248 NetClientState *nc;
249 int id = 0;
251 QTAILQ_FOREACH(nc, &net_clients, next) {
252 if (nc == nc1) {
253 continue;
255 if (strcmp(nc->model, model) == 0) {
256 id++;
260 return g_strdup_printf("%s.%d", model, id);
263 static void qemu_net_client_destructor(NetClientState *nc)
265 g_free(nc);
268 static void qemu_net_client_setup(NetClientState *nc,
269 NetClientInfo *info,
270 NetClientState *peer,
271 const char *model,
272 const char *name,
273 NetClientDestructor *destructor)
275 nc->info = info;
276 nc->model = g_strdup(model);
277 if (name) {
278 nc->name = g_strdup(name);
279 } else {
280 nc->name = assign_name(nc, model);
283 if (peer) {
284 assert(!peer->peer);
285 nc->peer = peer;
286 peer->peer = nc;
288 QTAILQ_INSERT_TAIL(&net_clients, nc, next);
290 nc->incoming_queue = qemu_new_net_queue(qemu_deliver_packet_iov, nc);
291 nc->destructor = destructor;
292 QTAILQ_INIT(&nc->filters);
295 NetClientState *qemu_new_net_client(NetClientInfo *info,
296 NetClientState *peer,
297 const char *model,
298 const char *name)
300 NetClientState *nc;
302 assert(info->size >= sizeof(NetClientState));
304 nc = g_malloc0(info->size);
305 qemu_net_client_setup(nc, info, peer, model, name,
306 qemu_net_client_destructor);
308 return nc;
311 NICState *qemu_new_nic(NetClientInfo *info,
312 NICConf *conf,
313 const char *model,
314 const char *name,
315 void *opaque)
317 NetClientState **peers = conf->peers.ncs;
318 NICState *nic;
319 int i, queues = MAX(1, conf->peers.queues);
321 assert(info->type == NET_CLIENT_OPTIONS_KIND_NIC);
322 assert(info->size >= sizeof(NICState));
324 nic = g_malloc0(info->size + sizeof(NetClientState) * queues);
325 nic->ncs = (void *)nic + info->size;
326 nic->conf = conf;
327 nic->opaque = opaque;
329 for (i = 0; i < queues; i++) {
330 qemu_net_client_setup(&nic->ncs[i], info, peers[i], model, name,
331 NULL);
332 nic->ncs[i].queue_index = i;
335 return nic;
338 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index)
340 return nic->ncs + queue_index;
343 NetClientState *qemu_get_queue(NICState *nic)
345 return qemu_get_subqueue(nic, 0);
348 NICState *qemu_get_nic(NetClientState *nc)
350 NetClientState *nc0 = nc - nc->queue_index;
352 return (NICState *)((void *)nc0 - nc->info->size);
355 void *qemu_get_nic_opaque(NetClientState *nc)
357 NICState *nic = qemu_get_nic(nc);
359 return nic->opaque;
362 static void qemu_cleanup_net_client(NetClientState *nc)
364 QTAILQ_REMOVE(&net_clients, nc, next);
366 if (nc->info->cleanup) {
367 nc->info->cleanup(nc);
371 static void qemu_free_net_client(NetClientState *nc)
373 if (nc->incoming_queue) {
374 qemu_del_net_queue(nc->incoming_queue);
376 if (nc->peer) {
377 nc->peer->peer = NULL;
379 g_free(nc->name);
380 g_free(nc->model);
381 if (nc->destructor) {
382 nc->destructor(nc);
386 void qemu_del_net_client(NetClientState *nc)
388 NetClientState *ncs[MAX_QUEUE_NUM];
389 int queues, i;
390 NetFilterState *nf, *next;
392 assert(nc->info->type != NET_CLIENT_OPTIONS_KIND_NIC);
394 /* If the NetClientState belongs to a multiqueue backend, we will change all
395 * other NetClientStates also.
397 queues = qemu_find_net_clients_except(nc->name, ncs,
398 NET_CLIENT_OPTIONS_KIND_NIC,
399 MAX_QUEUE_NUM);
400 assert(queues != 0);
402 QTAILQ_FOREACH_SAFE(nf, &nc->filters, next, next) {
403 object_unparent(OBJECT(nf));
406 /* If there is a peer NIC, delete and cleanup client, but do not free. */
407 if (nc->peer && nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
408 NICState *nic = qemu_get_nic(nc->peer);
409 if (nic->peer_deleted) {
410 return;
412 nic->peer_deleted = true;
414 for (i = 0; i < queues; i++) {
415 ncs[i]->peer->link_down = true;
418 if (nc->peer->info->link_status_changed) {
419 nc->peer->info->link_status_changed(nc->peer);
422 for (i = 0; i < queues; i++) {
423 qemu_cleanup_net_client(ncs[i]);
426 return;
429 for (i = 0; i < queues; i++) {
430 qemu_cleanup_net_client(ncs[i]);
431 qemu_free_net_client(ncs[i]);
435 void qemu_del_nic(NICState *nic)
437 int i, queues = MAX(nic->conf->peers.queues, 1);
439 qemu_macaddr_set_free(&nic->conf->macaddr);
441 /* If this is a peer NIC and peer has already been deleted, free it now. */
442 if (nic->peer_deleted) {
443 for (i = 0; i < queues; i++) {
444 qemu_free_net_client(qemu_get_subqueue(nic, i)->peer);
448 for (i = queues - 1; i >= 0; i--) {
449 NetClientState *nc = qemu_get_subqueue(nic, i);
451 qemu_cleanup_net_client(nc);
452 qemu_free_net_client(nc);
455 g_free(nic);
458 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque)
460 NetClientState *nc;
462 QTAILQ_FOREACH(nc, &net_clients, next) {
463 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
464 if (nc->queue_index == 0) {
465 func(qemu_get_nic(nc), opaque);
471 bool qemu_has_ufo(NetClientState *nc)
473 if (!nc || !nc->info->has_ufo) {
474 return false;
477 return nc->info->has_ufo(nc);
480 bool qemu_has_vnet_hdr(NetClientState *nc)
482 if (!nc || !nc->info->has_vnet_hdr) {
483 return false;
486 return nc->info->has_vnet_hdr(nc);
489 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len)
491 if (!nc || !nc->info->has_vnet_hdr_len) {
492 return false;
495 return nc->info->has_vnet_hdr_len(nc, len);
498 void qemu_using_vnet_hdr(NetClientState *nc, bool enable)
500 if (!nc || !nc->info->using_vnet_hdr) {
501 return;
504 nc->info->using_vnet_hdr(nc, enable);
507 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
508 int ecn, int ufo)
510 if (!nc || !nc->info->set_offload) {
511 return;
514 nc->info->set_offload(nc, csum, tso4, tso6, ecn, ufo);
517 void qemu_set_vnet_hdr_len(NetClientState *nc, int len)
519 if (!nc || !nc->info->set_vnet_hdr_len) {
520 return;
523 nc->info->set_vnet_hdr_len(nc, len);
526 int qemu_set_vnet_le(NetClientState *nc, bool is_le)
528 #ifdef HOST_WORDS_BIGENDIAN
529 if (!nc || !nc->info->set_vnet_le) {
530 return -ENOSYS;
533 return nc->info->set_vnet_le(nc, is_le);
534 #else
535 return 0;
536 #endif
539 int qemu_set_vnet_be(NetClientState *nc, bool is_be)
541 #ifdef HOST_WORDS_BIGENDIAN
542 return 0;
543 #else
544 if (!nc || !nc->info->set_vnet_be) {
545 return -ENOSYS;
548 return nc->info->set_vnet_be(nc, is_be);
549 #endif
552 int qemu_can_send_packet(NetClientState *sender)
554 int vm_running = runstate_is_running();
556 if (!vm_running) {
557 return 0;
560 if (!sender->peer) {
561 return 1;
564 if (sender->peer->receive_disabled) {
565 return 0;
566 } else if (sender->peer->info->can_receive &&
567 !sender->peer->info->can_receive(sender->peer)) {
568 return 0;
570 return 1;
573 static ssize_t filter_receive_iov(NetClientState *nc,
574 NetFilterDirection direction,
575 NetClientState *sender,
576 unsigned flags,
577 const struct iovec *iov,
578 int iovcnt,
579 NetPacketSent *sent_cb)
581 ssize_t ret = 0;
582 NetFilterState *nf = NULL;
584 if (direction == NET_FILTER_DIRECTION_TX) {
585 QTAILQ_FOREACH(nf, &nc->filters, next) {
586 ret = qemu_netfilter_receive(nf, direction, sender, flags, iov,
587 iovcnt, sent_cb);
588 if (ret) {
589 return ret;
592 } else {
593 QTAILQ_FOREACH_REVERSE(nf, &nc->filters, NetFilterHead, next) {
594 ret = qemu_netfilter_receive(nf, direction, sender, flags, iov,
595 iovcnt, sent_cb);
596 if (ret) {
597 return ret;
602 return ret;
605 static ssize_t filter_receive(NetClientState *nc,
606 NetFilterDirection direction,
607 NetClientState *sender,
608 unsigned flags,
609 const uint8_t *data,
610 size_t size,
611 NetPacketSent *sent_cb)
613 struct iovec iov = {
614 .iov_base = (void *)data,
615 .iov_len = size
618 return filter_receive_iov(nc, direction, sender, flags, &iov, 1, sent_cb);
621 void qemu_purge_queued_packets(NetClientState *nc)
623 if (!nc->peer) {
624 return;
627 qemu_net_queue_purge(nc->peer->incoming_queue, nc);
630 static
631 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge)
633 nc->receive_disabled = 0;
635 if (nc->peer && nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_HUBPORT) {
636 if (net_hub_flush(nc->peer)) {
637 qemu_notify_event();
640 if (qemu_net_queue_flush(nc->incoming_queue)) {
641 /* We emptied the queue successfully, signal to the IO thread to repoll
642 * the file descriptor (for tap, for example).
644 qemu_notify_event();
645 } else if (purge) {
646 /* Unable to empty the queue, purge remaining packets */
647 qemu_net_queue_purge(nc->incoming_queue, nc);
651 void qemu_flush_queued_packets(NetClientState *nc)
653 qemu_flush_or_purge_queued_packets(nc, false);
656 static ssize_t qemu_send_packet_async_with_flags(NetClientState *sender,
657 unsigned flags,
658 const uint8_t *buf, int size,
659 NetPacketSent *sent_cb)
661 NetQueue *queue;
662 int ret;
664 #ifdef DEBUG_NET
665 printf("qemu_send_packet_async:\n");
666 hex_dump(stdout, buf, size);
667 #endif
669 if (sender->link_down || !sender->peer) {
670 return size;
673 /* Let filters handle the packet first */
674 ret = filter_receive(sender, NET_FILTER_DIRECTION_TX,
675 sender, flags, buf, size, sent_cb);
676 if (ret) {
677 return ret;
680 ret = filter_receive(sender->peer, NET_FILTER_DIRECTION_RX,
681 sender, flags, buf, size, sent_cb);
682 if (ret) {
683 return ret;
686 queue = sender->peer->incoming_queue;
688 return qemu_net_queue_send(queue, sender, flags, buf, size, sent_cb);
691 ssize_t qemu_send_packet_async(NetClientState *sender,
692 const uint8_t *buf, int size,
693 NetPacketSent *sent_cb)
695 return qemu_send_packet_async_with_flags(sender, QEMU_NET_PACKET_FLAG_NONE,
696 buf, size, sent_cb);
699 void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size)
701 qemu_send_packet_async(nc, buf, size, NULL);
704 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size)
706 return qemu_send_packet_async_with_flags(nc, QEMU_NET_PACKET_FLAG_RAW,
707 buf, size, NULL);
710 static ssize_t nc_sendv_compat(NetClientState *nc, const struct iovec *iov,
711 int iovcnt, unsigned flags)
713 uint8_t buf[NET_BUFSIZE];
714 uint8_t *buffer;
715 size_t offset;
717 if (iovcnt == 1) {
718 buffer = iov[0].iov_base;
719 offset = iov[0].iov_len;
720 } else {
721 buffer = buf;
722 offset = iov_to_buf(iov, iovcnt, 0, buf, sizeof(buf));
725 if (flags & QEMU_NET_PACKET_FLAG_RAW && nc->info->receive_raw) {
726 return nc->info->receive_raw(nc, buffer, offset);
727 } else {
728 return nc->info->receive(nc, buffer, offset);
732 ssize_t qemu_deliver_packet_iov(NetClientState *sender,
733 unsigned flags,
734 const struct iovec *iov,
735 int iovcnt,
736 void *opaque)
738 NetClientState *nc = opaque;
739 int ret;
741 if (nc->link_down) {
742 return iov_size(iov, iovcnt);
745 if (nc->receive_disabled) {
746 return 0;
749 if (nc->info->receive_iov) {
750 ret = nc->info->receive_iov(nc, iov, iovcnt);
751 } else {
752 ret = nc_sendv_compat(nc, iov, iovcnt, flags);
755 if (ret == 0) {
756 nc->receive_disabled = 1;
759 return ret;
762 ssize_t qemu_sendv_packet_async(NetClientState *sender,
763 const struct iovec *iov, int iovcnt,
764 NetPacketSent *sent_cb)
766 NetQueue *queue;
767 int ret;
769 if (sender->link_down || !sender->peer) {
770 return iov_size(iov, iovcnt);
773 /* Let filters handle the packet first */
774 ret = filter_receive_iov(sender, NET_FILTER_DIRECTION_TX, sender,
775 QEMU_NET_PACKET_FLAG_NONE, iov, iovcnt, sent_cb);
776 if (ret) {
777 return ret;
780 ret = filter_receive_iov(sender->peer, NET_FILTER_DIRECTION_RX, sender,
781 QEMU_NET_PACKET_FLAG_NONE, iov, iovcnt, sent_cb);
782 if (ret) {
783 return ret;
786 queue = sender->peer->incoming_queue;
788 return qemu_net_queue_send_iov(queue, sender,
789 QEMU_NET_PACKET_FLAG_NONE,
790 iov, iovcnt, sent_cb);
793 ssize_t
794 qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, int iovcnt)
796 return qemu_sendv_packet_async(nc, iov, iovcnt, NULL);
799 NetClientState *qemu_find_netdev(const char *id)
801 NetClientState *nc;
803 QTAILQ_FOREACH(nc, &net_clients, next) {
804 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC)
805 continue;
806 if (!strcmp(nc->name, id)) {
807 return nc;
811 return NULL;
814 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
815 NetClientOptionsKind type, int max)
817 NetClientState *nc;
818 int ret = 0;
820 QTAILQ_FOREACH(nc, &net_clients, next) {
821 if (nc->info->type == type) {
822 continue;
824 if (!id || !strcmp(nc->name, id)) {
825 if (ret < max) {
826 ncs[ret] = nc;
828 ret++;
832 return ret;
835 static int nic_get_free_idx(void)
837 int index;
839 for (index = 0; index < MAX_NICS; index++)
840 if (!nd_table[index].used)
841 return index;
842 return -1;
845 int qemu_show_nic_models(const char *arg, const char *const *models)
847 int i;
849 if (!arg || !is_help_option(arg)) {
850 return 0;
853 fprintf(stderr, "qemu: Supported NIC models: ");
854 for (i = 0 ; models[i]; i++)
855 fprintf(stderr, "%s%c", models[i], models[i+1] ? ',' : '\n');
856 return 1;
859 void qemu_check_nic_model(NICInfo *nd, const char *model)
861 const char *models[2];
863 models[0] = model;
864 models[1] = NULL;
866 if (qemu_show_nic_models(nd->model, models))
867 exit(0);
868 if (qemu_find_nic_model(nd, models, model) < 0)
869 exit(1);
872 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
873 const char *default_model)
875 int i;
877 if (!nd->model)
878 nd->model = g_strdup(default_model);
880 for (i = 0 ; models[i]; i++) {
881 if (strcmp(nd->model, models[i]) == 0)
882 return i;
885 error_report("Unsupported NIC model: %s", nd->model);
886 return -1;
889 static int net_init_nic(const NetClientOptions *opts, const char *name,
890 NetClientState *peer, Error **errp)
892 int idx;
893 NICInfo *nd;
894 const NetLegacyNicOptions *nic;
896 assert(opts->type == NET_CLIENT_OPTIONS_KIND_NIC);
897 nic = opts->u.nic;
899 idx = nic_get_free_idx();
900 if (idx == -1 || nb_nics >= MAX_NICS) {
901 error_setg(errp, "too many NICs");
902 return -1;
905 nd = &nd_table[idx];
907 memset(nd, 0, sizeof(*nd));
909 if (nic->has_netdev) {
910 nd->netdev = qemu_find_netdev(nic->netdev);
911 if (!nd->netdev) {
912 error_setg(errp, "netdev '%s' not found", nic->netdev);
913 return -1;
915 } else {
916 assert(peer);
917 nd->netdev = peer;
919 nd->name = g_strdup(name);
920 if (nic->has_model) {
921 nd->model = g_strdup(nic->model);
923 if (nic->has_addr) {
924 nd->devaddr = g_strdup(nic->addr);
927 if (nic->has_macaddr &&
928 net_parse_macaddr(nd->macaddr.a, nic->macaddr) < 0) {
929 error_setg(errp, "invalid syntax for ethernet address");
930 return -1;
932 if (nic->has_macaddr &&
933 is_multicast_ether_addr(nd->macaddr.a)) {
934 error_setg(errp,
935 "NIC cannot have multicast MAC address (odd 1st byte)");
936 return -1;
938 qemu_macaddr_default_if_unset(&nd->macaddr);
940 if (nic->has_vectors) {
941 if (nic->vectors > 0x7ffffff) {
942 error_setg(errp, "invalid # of vectors: %"PRIu32, nic->vectors);
943 return -1;
945 nd->nvectors = nic->vectors;
946 } else {
947 nd->nvectors = DEV_NVECTORS_UNSPECIFIED;
950 nd->used = 1;
951 nb_nics++;
953 return idx;
957 static int (* const net_client_init_fun[NET_CLIENT_OPTIONS_KIND__MAX])(
958 const NetClientOptions *opts,
959 const char *name,
960 NetClientState *peer, Error **errp) = {
961 [NET_CLIENT_OPTIONS_KIND_NIC] = net_init_nic,
962 #ifdef CONFIG_SLIRP
963 [NET_CLIENT_OPTIONS_KIND_USER] = net_init_slirp,
964 #endif
965 [NET_CLIENT_OPTIONS_KIND_TAP] = net_init_tap,
966 [NET_CLIENT_OPTIONS_KIND_SOCKET] = net_init_socket,
967 #ifdef CONFIG_VDE
968 [NET_CLIENT_OPTIONS_KIND_VDE] = net_init_vde,
969 #endif
970 #ifdef CONFIG_NETMAP
971 [NET_CLIENT_OPTIONS_KIND_NETMAP] = net_init_netmap,
972 #endif
973 [NET_CLIENT_OPTIONS_KIND_DUMP] = net_init_dump,
974 #ifdef CONFIG_NET_BRIDGE
975 [NET_CLIENT_OPTIONS_KIND_BRIDGE] = net_init_bridge,
976 #endif
977 [NET_CLIENT_OPTIONS_KIND_HUBPORT] = net_init_hubport,
978 #ifdef CONFIG_VHOST_NET_USED
979 [NET_CLIENT_OPTIONS_KIND_VHOST_USER] = net_init_vhost_user,
980 #endif
981 #ifdef CONFIG_L2TPV3
982 [NET_CLIENT_OPTIONS_KIND_L2TPV3] = net_init_l2tpv3,
983 #endif
987 static int net_client_init1(const void *object, int is_netdev, Error **errp)
989 const NetClientOptions *opts;
990 const char *name;
991 NetClientState *peer = NULL;
993 if (is_netdev) {
994 const Netdev *netdev = object;
995 opts = netdev->opts;
996 name = netdev->id;
998 if (opts->type == NET_CLIENT_OPTIONS_KIND_DUMP ||
999 opts->type == NET_CLIENT_OPTIONS_KIND_NIC ||
1000 !net_client_init_fun[opts->type]) {
1001 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "type",
1002 "a netdev backend type");
1003 return -1;
1005 } else {
1006 const NetLegacy *net = object;
1007 opts = net->opts;
1008 /* missing optional values have been initialized to "all bits zero" */
1009 name = net->has_id ? net->id : net->name;
1011 if (opts->type == NET_CLIENT_OPTIONS_KIND_NONE) {
1012 return 0; /* nothing to do */
1014 if (opts->type == NET_CLIENT_OPTIONS_KIND_HUBPORT) {
1015 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "type",
1016 "a net type");
1017 return -1;
1020 if (!net_client_init_fun[opts->type]) {
1021 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "type",
1022 "a net backend type (maybe it is not compiled "
1023 "into this binary)");
1024 return -1;
1027 /* Do not add to a vlan if it's a nic with a netdev= parameter. */
1028 if (opts->type != NET_CLIENT_OPTIONS_KIND_NIC ||
1029 !opts->u.nic->has_netdev) {
1030 peer = net_hub_add_port(net->has_vlan ? net->vlan : 0, NULL);
1034 if (net_client_init_fun[opts->type](opts, name, peer, errp) < 0) {
1035 /* FIXME drop when all init functions store an Error */
1036 if (errp && !*errp) {
1037 error_setg(errp, QERR_DEVICE_INIT_FAILED,
1038 NetClientOptionsKind_lookup[opts->type]);
1040 return -1;
1042 return 0;
1046 static void net_visit(Visitor *v, int is_netdev, void **object, Error **errp)
1048 if (is_netdev) {
1049 visit_type_Netdev(v, NULL, (Netdev **)object, errp);
1050 } else {
1051 visit_type_NetLegacy(v, NULL, (NetLegacy **)object, errp);
1056 int net_client_init(QemuOpts *opts, int is_netdev, Error **errp)
1058 void *object = NULL;
1059 Error *err = NULL;
1060 int ret = -1;
1063 OptsVisitor *ov = opts_visitor_new(opts);
1065 net_visit(opts_get_visitor(ov), is_netdev, &object, &err);
1066 opts_visitor_cleanup(ov);
1069 if (!err) {
1070 ret = net_client_init1(object, is_netdev, &err);
1073 if (object) {
1074 QapiDeallocVisitor *dv = qapi_dealloc_visitor_new();
1076 net_visit(qapi_dealloc_get_visitor(dv), is_netdev, &object, NULL);
1077 qapi_dealloc_visitor_cleanup(dv);
1080 error_propagate(errp, err);
1081 return ret;
1085 static int net_host_check_device(const char *device)
1087 int i;
1088 for (i = 0; host_net_devices[i]; i++) {
1089 if (!strncmp(host_net_devices[i], device,
1090 strlen(host_net_devices[i]))) {
1091 return 1;
1095 return 0;
1098 void hmp_host_net_add(Monitor *mon, const QDict *qdict)
1100 const char *device = qdict_get_str(qdict, "device");
1101 const char *opts_str = qdict_get_try_str(qdict, "opts");
1102 Error *local_err = NULL;
1103 QemuOpts *opts;
1105 if (!net_host_check_device(device)) {
1106 monitor_printf(mon, "invalid host network device %s\n", device);
1107 return;
1110 opts = qemu_opts_parse_noisily(qemu_find_opts("net"),
1111 opts_str ? opts_str : "", false);
1112 if (!opts) {
1113 return;
1116 qemu_opt_set(opts, "type", device, &error_abort);
1118 net_client_init(opts, 0, &local_err);
1119 if (local_err) {
1120 error_report_err(local_err);
1121 monitor_printf(mon, "adding host network device %s failed\n", device);
1125 void hmp_host_net_remove(Monitor *mon, const QDict *qdict)
1127 NetClientState *nc;
1128 int vlan_id = qdict_get_int(qdict, "vlan_id");
1129 const char *device = qdict_get_str(qdict, "device");
1131 nc = net_hub_find_client_by_name(vlan_id, device);
1132 if (!nc) {
1133 error_report("Host network device '%s' on hub '%d' not found",
1134 device, vlan_id);
1135 return;
1137 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
1138 error_report("invalid host network device '%s'", device);
1139 return;
1142 qemu_del_net_client(nc->peer);
1143 qemu_del_net_client(nc);
1146 void netdev_add(QemuOpts *opts, Error **errp)
1148 net_client_init(opts, 1, errp);
1151 void qmp_netdev_add(QDict *qdict, QObject **ret, Error **errp)
1153 Error *local_err = NULL;
1154 QemuOptsList *opts_list;
1155 QemuOpts *opts;
1157 opts_list = qemu_find_opts_err("netdev", &local_err);
1158 if (local_err) {
1159 goto out;
1162 opts = qemu_opts_from_qdict(opts_list, qdict, &local_err);
1163 if (local_err) {
1164 goto out;
1167 netdev_add(opts, &local_err);
1168 if (local_err) {
1169 qemu_opts_del(opts);
1170 goto out;
1173 out:
1174 error_propagate(errp, local_err);
1177 void qmp_netdev_del(const char *id, Error **errp)
1179 NetClientState *nc;
1180 QemuOpts *opts;
1182 nc = qemu_find_netdev(id);
1183 if (!nc) {
1184 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1185 "Device '%s' not found", id);
1186 return;
1189 opts = qemu_opts_find(qemu_find_opts_err("netdev", NULL), id);
1190 if (!opts) {
1191 error_setg(errp, "Device '%s' is not a netdev", id);
1192 return;
1195 qemu_del_net_client(nc);
1196 qemu_opts_del(opts);
1199 static void netfilter_print_info(Monitor *mon, NetFilterState *nf)
1201 char *str;
1202 ObjectProperty *prop;
1203 ObjectPropertyIterator iter;
1204 StringOutputVisitor *ov;
1206 /* generate info str */
1207 object_property_iter_init(&iter, OBJECT(nf));
1208 while ((prop = object_property_iter_next(&iter))) {
1209 if (!strcmp(prop->name, "type")) {
1210 continue;
1212 ov = string_output_visitor_new(false);
1213 object_property_get(OBJECT(nf), string_output_get_visitor(ov),
1214 prop->name, NULL);
1215 str = string_output_get_string(ov);
1216 string_output_visitor_cleanup(ov);
1217 monitor_printf(mon, ",%s=%s", prop->name, str);
1218 g_free(str);
1220 monitor_printf(mon, "\n");
1223 void print_net_client(Monitor *mon, NetClientState *nc)
1225 NetFilterState *nf;
1227 monitor_printf(mon, "%s: index=%d,type=%s,%s\n", nc->name,
1228 nc->queue_index,
1229 NetClientOptionsKind_lookup[nc->info->type],
1230 nc->info_str);
1231 if (!QTAILQ_EMPTY(&nc->filters)) {
1232 monitor_printf(mon, "filters:\n");
1234 QTAILQ_FOREACH(nf, &nc->filters, next) {
1235 char *path = object_get_canonical_path_component(OBJECT(nf));
1237 monitor_printf(mon, " - %s: type=%s", path,
1238 object_get_typename(OBJECT(nf)));
1239 netfilter_print_info(mon, nf);
1240 g_free(path);
1244 RxFilterInfoList *qmp_query_rx_filter(bool has_name, const char *name,
1245 Error **errp)
1247 NetClientState *nc;
1248 RxFilterInfoList *filter_list = NULL, *last_entry = NULL;
1250 QTAILQ_FOREACH(nc, &net_clients, next) {
1251 RxFilterInfoList *entry;
1252 RxFilterInfo *info;
1254 if (has_name && strcmp(nc->name, name) != 0) {
1255 continue;
1258 /* only query rx-filter information of NIC */
1259 if (nc->info->type != NET_CLIENT_OPTIONS_KIND_NIC) {
1260 if (has_name) {
1261 error_setg(errp, "net client(%s) isn't a NIC", name);
1262 return NULL;
1264 continue;
1267 /* only query information on queue 0 since the info is per nic,
1268 * not per queue
1270 if (nc->queue_index != 0)
1271 continue;
1273 if (nc->info->query_rx_filter) {
1274 info = nc->info->query_rx_filter(nc);
1275 entry = g_malloc0(sizeof(*entry));
1276 entry->value = info;
1278 if (!filter_list) {
1279 filter_list = entry;
1280 } else {
1281 last_entry->next = entry;
1283 last_entry = entry;
1284 } else if (has_name) {
1285 error_setg(errp, "net client(%s) doesn't support"
1286 " rx-filter querying", name);
1287 return NULL;
1290 if (has_name) {
1291 break;
1295 if (filter_list == NULL && has_name) {
1296 error_setg(errp, "invalid net client name: %s", name);
1299 return filter_list;
1302 void hmp_info_network(Monitor *mon, const QDict *qdict)
1304 NetClientState *nc, *peer;
1305 NetClientOptionsKind type;
1307 net_hub_info(mon);
1309 QTAILQ_FOREACH(nc, &net_clients, next) {
1310 peer = nc->peer;
1311 type = nc->info->type;
1313 /* Skip if already printed in hub info */
1314 if (net_hub_id_for_client(nc, NULL) == 0) {
1315 continue;
1318 if (!peer || type == NET_CLIENT_OPTIONS_KIND_NIC) {
1319 print_net_client(mon, nc);
1320 } /* else it's a netdev connected to a NIC, printed with the NIC */
1321 if (peer && type == NET_CLIENT_OPTIONS_KIND_NIC) {
1322 monitor_printf(mon, " \\ ");
1323 print_net_client(mon, peer);
1328 void qmp_set_link(const char *name, bool up, Error **errp)
1330 NetClientState *ncs[MAX_QUEUE_NUM];
1331 NetClientState *nc;
1332 int queues, i;
1334 queues = qemu_find_net_clients_except(name, ncs,
1335 NET_CLIENT_OPTIONS_KIND__MAX,
1336 MAX_QUEUE_NUM);
1338 if (queues == 0) {
1339 error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1340 "Device '%s' not found", name);
1341 return;
1343 nc = ncs[0];
1345 for (i = 0; i < queues; i++) {
1346 ncs[i]->link_down = !up;
1349 if (nc->info->link_status_changed) {
1350 nc->info->link_status_changed(nc);
1353 if (nc->peer) {
1354 /* Change peer link only if the peer is NIC and then notify peer.
1355 * If the peer is a HUBPORT or a backend, we do not change the
1356 * link status.
1358 * This behavior is compatible with qemu vlans where there could be
1359 * multiple clients that can still communicate with each other in
1360 * disconnected mode. For now maintain this compatibility.
1362 if (nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
1363 for (i = 0; i < queues; i++) {
1364 ncs[i]->peer->link_down = !up;
1367 if (nc->peer->info->link_status_changed) {
1368 nc->peer->info->link_status_changed(nc->peer);
1373 static void net_vm_change_state_handler(void *opaque, int running,
1374 RunState state)
1376 NetClientState *nc;
1377 NetClientState *tmp;
1379 QTAILQ_FOREACH_SAFE(nc, &net_clients, next, tmp) {
1380 if (running) {
1381 /* Flush queued packets and wake up backends. */
1382 if (nc->peer && qemu_can_send_packet(nc)) {
1383 qemu_flush_queued_packets(nc->peer);
1385 } else {
1386 /* Complete all queued packets, to guarantee we don't modify
1387 * state later when VM is not running.
1389 qemu_flush_or_purge_queued_packets(nc, true);
1394 void net_cleanup(void)
1396 NetClientState *nc;
1398 /* We may del multiple entries during qemu_del_net_client(),
1399 * so QTAILQ_FOREACH_SAFE() is also not safe here.
1401 while (!QTAILQ_EMPTY(&net_clients)) {
1402 nc = QTAILQ_FIRST(&net_clients);
1403 if (nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC) {
1404 qemu_del_nic(qemu_get_nic(nc));
1405 } else {
1406 qemu_del_net_client(nc);
1410 qemu_del_vm_change_state_handler(net_change_state_entry);
1413 void net_check_clients(void)
1415 NetClientState *nc;
1416 int i;
1418 /* Don't warn about the default network setup that you get if
1419 * no command line -net or -netdev options are specified. There
1420 * are two cases that we would otherwise complain about:
1421 * (1) board doesn't support a NIC but the implicit "-net nic"
1422 * requested one
1423 * (2) CONFIG_SLIRP not set, in which case the implicit "-net nic"
1424 * sets up a nic that isn't connected to anything.
1426 if (default_net) {
1427 return;
1430 net_hub_check_clients();
1432 QTAILQ_FOREACH(nc, &net_clients, next) {
1433 if (!nc->peer) {
1434 fprintf(stderr, "Warning: %s %s has no peer\n",
1435 nc->info->type == NET_CLIENT_OPTIONS_KIND_NIC ?
1436 "nic" : "netdev", nc->name);
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 fprintf(stderr, "Warning: requested NIC (%s, model %s) "
1448 "was not created (not supported by this machine?)\n",
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 Error *local_err = NULL;
1459 net_client_init(opts, 0, &local_err);
1460 if (local_err) {
1461 error_report_err(local_err);
1462 return -1;
1465 return 0;
1468 static int net_init_netdev(void *dummy, QemuOpts *opts, Error **errp)
1470 Error *local_err = NULL;
1471 int ret;
1473 ret = net_client_init(opts, 1, &local_err);
1474 if (local_err) {
1475 error_report_err(local_err);
1476 return -1;
1479 return ret;
1482 int net_init_clients(void)
1484 QemuOptsList *net = qemu_find_opts("net");
1486 if (default_net) {
1487 /* if no clients, we use a default config */
1488 qemu_opts_set(net, NULL, "type", "nic", &error_abort);
1489 #ifdef CONFIG_SLIRP
1490 qemu_opts_set(net, NULL, "type", "user", &error_abort);
1491 #endif
1494 net_change_state_entry =
1495 qemu_add_vm_change_state_handler(net_vm_change_state_handler, NULL);
1497 QTAILQ_INIT(&net_clients);
1499 if (qemu_opts_foreach(qemu_find_opts("netdev"),
1500 net_init_netdev, NULL, NULL)) {
1501 return -1;
1504 if (qemu_opts_foreach(net, net_init_client, NULL, NULL)) {
1505 return -1;
1508 return 0;
1511 int net_client_parse(QemuOptsList *opts_list, const char *optarg)
1513 #if defined(CONFIG_SLIRP)
1514 int ret;
1515 if (net_slirp_parse_legacy(opts_list, optarg, &ret)) {
1516 return ret;
1518 #endif
1520 if (!qemu_opts_parse_noisily(opts_list, optarg, true)) {
1521 return -1;
1524 default_net = 0;
1525 return 0;
1528 /* From FreeBSD */
1529 /* XXX: optimize */
1530 unsigned compute_mcast_idx(const uint8_t *ep)
1532 uint32_t crc;
1533 int carry, i, j;
1534 uint8_t b;
1536 crc = 0xffffffff;
1537 for (i = 0; i < 6; i++) {
1538 b = *ep++;
1539 for (j = 0; j < 8; j++) {
1540 carry = ((crc & 0x80000000L) ? 1 : 0) ^ (b & 0x01);
1541 crc <<= 1;
1542 b >>= 1;
1543 if (carry) {
1544 crc = ((crc ^ POLYNOMIAL) | carry);
1548 return crc >> 26;
1551 QemuOptsList qemu_netdev_opts = {
1552 .name = "netdev",
1553 .implied_opt_name = "type",
1554 .head = QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts.head),
1555 .desc = {
1557 * no elements => accept any params
1558 * validation will happen later
1560 { /* end of list */ }
1564 QemuOptsList qemu_net_opts = {
1565 .name = "net",
1566 .implied_opt_name = "type",
1567 .head = QTAILQ_HEAD_INITIALIZER(qemu_net_opts.head),
1568 .desc = {
1570 * no elements => accept any params
1571 * validation will happen later
1573 { /* end of list */ }