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 memset(saddr
, 0, sizeof(*saddr
));
80 substrings
= g_strsplit(str
, ":", 2);
81 if (!substrings
|| !substrings
[0] || !substrings
[1]) {
82 error_setg(errp
, "host address '%s' doesn't contain ':' "
83 "separating host from port", str
);
91 saddr
->sin_family
= AF_INET
;
92 if (addr
[0] == '\0') {
93 saddr
->sin_addr
.s_addr
= 0;
95 if (qemu_isdigit(addr
[0])) {
96 if (!inet_aton(addr
, &saddr
->sin_addr
)) {
97 error_setg(errp
, "host address '%s' is not a valid "
98 "IPv4 address", addr
);
103 he
= gethostbyname(addr
);
105 error_setg(errp
, "can't resolve host address '%s'", addr
);
109 saddr
->sin_addr
= *(struct in_addr
*)he
->h_addr
;
112 port
= strtol(p
, (char **)&r
, 0);
114 error_setg(errp
, "port number '%s' is invalid", p
);
118 saddr
->sin_port
= htons(port
);
121 g_strfreev(substrings
);
125 char *qemu_mac_strdup_printf(const uint8_t *macaddr
)
127 return g_strdup_printf("%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
128 macaddr
[0], macaddr
[1], macaddr
[2],
129 macaddr
[3], macaddr
[4], macaddr
[5]);
132 void qemu_format_nic_info_str(NetClientState
*nc
, uint8_t macaddr
[6])
134 snprintf(nc
->info_str
, sizeof(nc
->info_str
),
135 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
137 macaddr
[0], macaddr
[1], macaddr
[2],
138 macaddr
[3], macaddr
[4], macaddr
[5]);
141 static int mac_table
[256] = {0};
143 static void qemu_macaddr_set_used(MACAddr
*macaddr
)
147 for (index
= 0x56; index
< 0xFF; index
++) {
148 if (macaddr
->a
[5] == index
) {
154 static void qemu_macaddr_set_free(MACAddr
*macaddr
)
157 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
159 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
162 for (index
= 0x56; index
< 0xFF; index
++) {
163 if (macaddr
->a
[5] == index
) {
169 static int qemu_macaddr_get_free(void)
173 for (index
= 0x56; index
< 0xFF; index
++) {
174 if (mac_table
[index
] == 0) {
182 void qemu_macaddr_default_if_unset(MACAddr
*macaddr
)
184 static const MACAddr zero
= { .a
= { 0,0,0,0,0,0 } };
185 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
187 if (memcmp(macaddr
, &zero
, sizeof(zero
)) != 0) {
188 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
191 qemu_macaddr_set_used(macaddr
);
196 macaddr
->a
[0] = 0x52;
197 macaddr
->a
[1] = 0x54;
198 macaddr
->a
[2] = 0x00;
199 macaddr
->a
[3] = 0x12;
200 macaddr
->a
[4] = 0x34;
201 macaddr
->a
[5] = qemu_macaddr_get_free();
202 qemu_macaddr_set_used(macaddr
);
206 * Generate a name for net client
208 * Only net clients created with the legacy -net option and NICs need this.
210 static char *assign_name(NetClientState
*nc1
, const char *model
)
215 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
219 if (strcmp(nc
->model
, model
) == 0) {
224 return g_strdup_printf("%s.%d", model
, id
);
227 static void qemu_net_client_destructor(NetClientState
*nc
)
231 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
233 const struct iovec
*iov
,
237 static void qemu_net_client_setup(NetClientState
*nc
,
239 NetClientState
*peer
,
242 NetClientDestructor
*destructor
)
245 nc
->model
= g_strdup(model
);
247 nc
->name
= g_strdup(name
);
249 nc
->name
= assign_name(nc
, model
);
257 QTAILQ_INSERT_TAIL(&net_clients
, nc
, next
);
259 nc
->incoming_queue
= qemu_new_net_queue(qemu_deliver_packet_iov
, nc
);
260 nc
->destructor
= destructor
;
261 QTAILQ_INIT(&nc
->filters
);
264 NetClientState
*qemu_new_net_client(NetClientInfo
*info
,
265 NetClientState
*peer
,
271 assert(info
->size
>= sizeof(NetClientState
));
273 nc
= g_malloc0(info
->size
);
274 qemu_net_client_setup(nc
, info
, peer
, model
, name
,
275 qemu_net_client_destructor
);
280 NICState
*qemu_new_nic(NetClientInfo
*info
,
286 NetClientState
**peers
= conf
->peers
.ncs
;
288 int i
, queues
= MAX(1, conf
->peers
.queues
);
290 assert(info
->type
== NET_CLIENT_DRIVER_NIC
);
291 assert(info
->size
>= sizeof(NICState
));
293 nic
= g_malloc0(info
->size
+ sizeof(NetClientState
) * queues
);
294 nic
->ncs
= (void *)nic
+ info
->size
;
296 nic
->opaque
= opaque
;
298 for (i
= 0; i
< queues
; i
++) {
299 qemu_net_client_setup(&nic
->ncs
[i
], info
, peers
[i
], model
, name
,
301 nic
->ncs
[i
].queue_index
= i
;
307 NetClientState
*qemu_get_subqueue(NICState
*nic
, int queue_index
)
309 return nic
->ncs
+ queue_index
;
312 NetClientState
*qemu_get_queue(NICState
*nic
)
314 return qemu_get_subqueue(nic
, 0);
317 NICState
*qemu_get_nic(NetClientState
*nc
)
319 NetClientState
*nc0
= nc
- nc
->queue_index
;
321 return (NICState
*)((void *)nc0
- nc
->info
->size
);
324 void *qemu_get_nic_opaque(NetClientState
*nc
)
326 NICState
*nic
= qemu_get_nic(nc
);
331 NetClientState
*qemu_get_peer(NetClientState
*nc
, int queue_index
)
334 NetClientState
*ncs
= nc
+ queue_index
;
338 static void qemu_cleanup_net_client(NetClientState
*nc
)
340 QTAILQ_REMOVE(&net_clients
, nc
, next
);
342 if (nc
->info
->cleanup
) {
343 nc
->info
->cleanup(nc
);
347 static void qemu_free_net_client(NetClientState
*nc
)
349 if (nc
->incoming_queue
) {
350 qemu_del_net_queue(nc
->incoming_queue
);
353 nc
->peer
->peer
= NULL
;
357 if (nc
->destructor
) {
362 void qemu_del_net_client(NetClientState
*nc
)
364 NetClientState
*ncs
[MAX_QUEUE_NUM
];
366 NetFilterState
*nf
, *next
;
368 assert(nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
);
370 /* If the NetClientState belongs to a multiqueue backend, we will change all
371 * other NetClientStates also.
373 queues
= qemu_find_net_clients_except(nc
->name
, ncs
,
374 NET_CLIENT_DRIVER_NIC
,
378 QTAILQ_FOREACH_SAFE(nf
, &nc
->filters
, next
, next
) {
379 object_unparent(OBJECT(nf
));
382 /* If there is a peer NIC, delete and cleanup client, but do not free. */
383 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
384 NICState
*nic
= qemu_get_nic(nc
->peer
);
385 if (nic
->peer_deleted
) {
388 nic
->peer_deleted
= true;
390 for (i
= 0; i
< queues
; i
++) {
391 ncs
[i
]->peer
->link_down
= true;
394 if (nc
->peer
->info
->link_status_changed
) {
395 nc
->peer
->info
->link_status_changed(nc
->peer
);
398 for (i
= 0; i
< queues
; i
++) {
399 qemu_cleanup_net_client(ncs
[i
]);
405 for (i
= 0; i
< queues
; i
++) {
406 qemu_cleanup_net_client(ncs
[i
]);
407 qemu_free_net_client(ncs
[i
]);
411 void qemu_del_nic(NICState
*nic
)
413 int i
, queues
= MAX(nic
->conf
->peers
.queues
, 1);
415 qemu_macaddr_set_free(&nic
->conf
->macaddr
);
417 for (i
= 0; i
< queues
; i
++) {
418 NetClientState
*nc
= qemu_get_subqueue(nic
, i
);
419 /* If this is a peer NIC and peer has already been deleted, free it now. */
420 if (nic
->peer_deleted
) {
421 qemu_free_net_client(nc
->peer
);
422 } else if (nc
->peer
) {
423 /* if there are RX packets pending, complete them */
424 qemu_purge_queued_packets(nc
->peer
);
428 for (i
= queues
- 1; i
>= 0; i
--) {
429 NetClientState
*nc
= qemu_get_subqueue(nic
, i
);
431 qemu_cleanup_net_client(nc
);
432 qemu_free_net_client(nc
);
438 void qemu_foreach_nic(qemu_nic_foreach func
, void *opaque
)
442 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
443 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
444 if (nc
->queue_index
== 0) {
445 func(qemu_get_nic(nc
), opaque
);
451 bool qemu_has_ufo(NetClientState
*nc
)
453 if (!nc
|| !nc
->info
->has_ufo
) {
457 return nc
->info
->has_ufo(nc
);
460 bool qemu_has_vnet_hdr(NetClientState
*nc
)
462 if (!nc
|| !nc
->info
->has_vnet_hdr
) {
466 return nc
->info
->has_vnet_hdr(nc
);
469 bool qemu_has_vnet_hdr_len(NetClientState
*nc
, int len
)
471 if (!nc
|| !nc
->info
->has_vnet_hdr_len
) {
475 return nc
->info
->has_vnet_hdr_len(nc
, len
);
478 void qemu_using_vnet_hdr(NetClientState
*nc
, bool enable
)
480 if (!nc
|| !nc
->info
->using_vnet_hdr
) {
484 nc
->info
->using_vnet_hdr(nc
, enable
);
487 void qemu_set_offload(NetClientState
*nc
, int csum
, int tso4
, int tso6
,
490 if (!nc
|| !nc
->info
->set_offload
) {
494 nc
->info
->set_offload(nc
, csum
, tso4
, tso6
, ecn
, ufo
);
497 void qemu_set_vnet_hdr_len(NetClientState
*nc
, int len
)
499 if (!nc
|| !nc
->info
->set_vnet_hdr_len
) {
503 nc
->vnet_hdr_len
= len
;
504 nc
->info
->set_vnet_hdr_len(nc
, len
);
507 int qemu_set_vnet_le(NetClientState
*nc
, bool is_le
)
509 #ifdef HOST_WORDS_BIGENDIAN
510 if (!nc
|| !nc
->info
->set_vnet_le
) {
514 return nc
->info
->set_vnet_le(nc
, is_le
);
520 int qemu_set_vnet_be(NetClientState
*nc
, bool is_be
)
522 #ifdef HOST_WORDS_BIGENDIAN
525 if (!nc
|| !nc
->info
->set_vnet_be
) {
529 return nc
->info
->set_vnet_be(nc
, is_be
);
533 int qemu_can_receive_packet(NetClientState
*nc
)
535 if (nc
->receive_disabled
) {
537 } else if (nc
->info
->can_receive
&&
538 !nc
->info
->can_receive(nc
)) {
544 int qemu_can_send_packet(NetClientState
*sender
)
546 int vm_running
= runstate_is_running();
556 return qemu_can_receive_packet(sender
->peer
);
559 static ssize_t
filter_receive_iov(NetClientState
*nc
,
560 NetFilterDirection direction
,
561 NetClientState
*sender
,
563 const struct iovec
*iov
,
565 NetPacketSent
*sent_cb
)
568 NetFilterState
*nf
= NULL
;
570 if (direction
== NET_FILTER_DIRECTION_TX
) {
571 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
572 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
579 QTAILQ_FOREACH_REVERSE(nf
, &nc
->filters
, next
) {
580 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
591 static ssize_t
filter_receive(NetClientState
*nc
,
592 NetFilterDirection direction
,
593 NetClientState
*sender
,
597 NetPacketSent
*sent_cb
)
600 .iov_base
= (void *)data
,
604 return filter_receive_iov(nc
, direction
, sender
, flags
, &iov
, 1, sent_cb
);
607 void qemu_purge_queued_packets(NetClientState
*nc
)
613 qemu_net_queue_purge(nc
->peer
->incoming_queue
, nc
);
616 void qemu_flush_or_purge_queued_packets(NetClientState
*nc
, bool purge
)
618 nc
->receive_disabled
= 0;
620 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_HUBPORT
) {
621 if (net_hub_flush(nc
->peer
)) {
625 if (qemu_net_queue_flush(nc
->incoming_queue
)) {
626 /* We emptied the queue successfully, signal to the IO thread to repoll
627 * the file descriptor (for tap, for example).
631 /* Unable to empty the queue, purge remaining packets */
632 qemu_net_queue_purge(nc
->incoming_queue
, nc
->peer
);
636 void qemu_flush_queued_packets(NetClientState
*nc
)
638 qemu_flush_or_purge_queued_packets(nc
, false);
641 static ssize_t
qemu_send_packet_async_with_flags(NetClientState
*sender
,
643 const uint8_t *buf
, int size
,
644 NetPacketSent
*sent_cb
)
650 printf("qemu_send_packet_async:\n");
651 qemu_hexdump(stdout
, "net", buf
, size
);
654 if (sender
->link_down
|| !sender
->peer
) {
658 /* Let filters handle the packet first */
659 ret
= filter_receive(sender
, NET_FILTER_DIRECTION_TX
,
660 sender
, flags
, buf
, size
, sent_cb
);
665 ret
= filter_receive(sender
->peer
, NET_FILTER_DIRECTION_RX
,
666 sender
, flags
, buf
, size
, sent_cb
);
671 queue
= sender
->peer
->incoming_queue
;
673 return qemu_net_queue_send(queue
, sender
, flags
, buf
, size
, sent_cb
);
676 ssize_t
qemu_send_packet_async(NetClientState
*sender
,
677 const uint8_t *buf
, int size
,
678 NetPacketSent
*sent_cb
)
680 return qemu_send_packet_async_with_flags(sender
, QEMU_NET_PACKET_FLAG_NONE
,
684 ssize_t
qemu_send_packet(NetClientState
*nc
, const uint8_t *buf
, int size
)
686 return qemu_send_packet_async(nc
, buf
, size
, NULL
);
689 ssize_t
qemu_receive_packet(NetClientState
*nc
, const uint8_t *buf
, int size
)
691 if (!qemu_can_receive_packet(nc
)) {
695 return qemu_net_queue_receive(nc
->incoming_queue
, buf
, size
);
698 ssize_t
qemu_receive_packet_iov(NetClientState
*nc
, const struct iovec
*iov
,
701 if (!qemu_can_receive_packet(nc
)) {
705 return qemu_net_queue_receive_iov(nc
->incoming_queue
, iov
, iovcnt
);
708 ssize_t
qemu_send_packet_raw(NetClientState
*nc
, const uint8_t *buf
, int size
)
710 return qemu_send_packet_async_with_flags(nc
, QEMU_NET_PACKET_FLAG_RAW
,
714 static ssize_t
nc_sendv_compat(NetClientState
*nc
, const struct iovec
*iov
,
715 int iovcnt
, unsigned flags
)
723 buffer
= iov
[0].iov_base
;
724 offset
= iov
[0].iov_len
;
726 offset
= iov_size(iov
, iovcnt
);
727 if (offset
> NET_BUFSIZE
) {
730 buf
= g_malloc(offset
);
732 offset
= iov_to_buf(iov
, iovcnt
, 0, buf
, offset
);
735 if (flags
& QEMU_NET_PACKET_FLAG_RAW
&& nc
->info
->receive_raw
) {
736 ret
= nc
->info
->receive_raw(nc
, buffer
, offset
);
738 ret
= nc
->info
->receive(nc
, buffer
, offset
);
745 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
747 const struct iovec
*iov
,
751 NetClientState
*nc
= opaque
;
756 return iov_size(iov
, iovcnt
);
759 if (nc
->receive_disabled
) {
763 if (nc
->info
->receive_iov
&& !(flags
& QEMU_NET_PACKET_FLAG_RAW
)) {
764 ret
= nc
->info
->receive_iov(nc
, iov
, iovcnt
);
766 ret
= nc_sendv_compat(nc
, iov
, iovcnt
, flags
);
770 nc
->receive_disabled
= 1;
776 ssize_t
qemu_sendv_packet_async(NetClientState
*sender
,
777 const struct iovec
*iov
, int iovcnt
,
778 NetPacketSent
*sent_cb
)
781 size_t size
= iov_size(iov
, iovcnt
);
784 if (size
> NET_BUFSIZE
) {
788 if (sender
->link_down
|| !sender
->peer
) {
792 /* Let filters handle the packet first */
793 ret
= filter_receive_iov(sender
, NET_FILTER_DIRECTION_TX
, sender
,
794 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
799 ret
= filter_receive_iov(sender
->peer
, NET_FILTER_DIRECTION_RX
, sender
,
800 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
805 queue
= sender
->peer
->incoming_queue
;
807 return qemu_net_queue_send_iov(queue
, sender
,
808 QEMU_NET_PACKET_FLAG_NONE
,
809 iov
, iovcnt
, sent_cb
);
813 qemu_sendv_packet(NetClientState
*nc
, const struct iovec
*iov
, int iovcnt
)
815 return qemu_sendv_packet_async(nc
, iov
, iovcnt
, NULL
);
818 NetClientState
*qemu_find_netdev(const char *id
)
822 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
823 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
)
825 if (!strcmp(nc
->name
, id
)) {
833 int qemu_find_net_clients_except(const char *id
, NetClientState
**ncs
,
834 NetClientDriver type
, int max
)
839 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
840 if (nc
->info
->type
== type
) {
843 if (!id
|| !strcmp(nc
->name
, id
)) {
854 static int nic_get_free_idx(void)
858 for (index
= 0; index
< MAX_NICS
; index
++)
859 if (!nd_table
[index
].used
)
864 int qemu_show_nic_models(const char *arg
, const char *const *models
)
868 if (!arg
|| !is_help_option(arg
)) {
872 printf("Supported NIC models:\n");
873 for (i
= 0 ; models
[i
]; i
++) {
874 printf("%s\n", models
[i
]);
879 void qemu_check_nic_model(NICInfo
*nd
, const char *model
)
881 const char *models
[2];
886 if (qemu_show_nic_models(nd
->model
, models
))
888 if (qemu_find_nic_model(nd
, models
, model
) < 0)
892 int qemu_find_nic_model(NICInfo
*nd
, const char * const *models
,
893 const char *default_model
)
898 nd
->model
= g_strdup(default_model
);
900 for (i
= 0 ; models
[i
]; i
++) {
901 if (strcmp(nd
->model
, models
[i
]) == 0)
905 error_report("Unsupported NIC model: %s", nd
->model
);
909 static int net_init_nic(const Netdev
*netdev
, const char *name
,
910 NetClientState
*peer
, Error
**errp
)
914 const NetLegacyNicOptions
*nic
;
916 assert(netdev
->type
== NET_CLIENT_DRIVER_NIC
);
917 nic
= &netdev
->u
.nic
;
919 idx
= nic_get_free_idx();
920 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
921 error_setg(errp
, "too many NICs");
927 memset(nd
, 0, sizeof(*nd
));
929 if (nic
->has_netdev
) {
930 nd
->netdev
= qemu_find_netdev(nic
->netdev
);
932 error_setg(errp
, "netdev '%s' not found", nic
->netdev
);
939 nd
->name
= g_strdup(name
);
940 if (nic
->has_model
) {
941 nd
->model
= g_strdup(nic
->model
);
944 nd
->devaddr
= g_strdup(nic
->addr
);
947 if (nic
->has_macaddr
&&
948 net_parse_macaddr(nd
->macaddr
.a
, nic
->macaddr
) < 0) {
949 error_setg(errp
, "invalid syntax for ethernet address");
952 if (nic
->has_macaddr
&&
953 is_multicast_ether_addr(nd
->macaddr
.a
)) {
955 "NIC cannot have multicast MAC address (odd 1st byte)");
958 qemu_macaddr_default_if_unset(&nd
->macaddr
);
960 if (nic
->has_vectors
) {
961 if (nic
->vectors
> 0x7ffffff) {
962 error_setg(errp
, "invalid # of vectors: %"PRIu32
, nic
->vectors
);
965 nd
->nvectors
= nic
->vectors
;
967 nd
->nvectors
= DEV_NVECTORS_UNSPECIFIED
;
977 static int (* const net_client_init_fun
[NET_CLIENT_DRIVER__MAX
])(
978 const Netdev
*netdev
,
980 NetClientState
*peer
, Error
**errp
) = {
981 [NET_CLIENT_DRIVER_NIC
] = net_init_nic
,
983 [NET_CLIENT_DRIVER_USER
] = net_init_slirp
,
985 [NET_CLIENT_DRIVER_TAP
] = net_init_tap
,
986 [NET_CLIENT_DRIVER_SOCKET
] = net_init_socket
,
988 [NET_CLIENT_DRIVER_VDE
] = net_init_vde
,
991 [NET_CLIENT_DRIVER_NETMAP
] = net_init_netmap
,
993 #ifdef CONFIG_NET_BRIDGE
994 [NET_CLIENT_DRIVER_BRIDGE
] = net_init_bridge
,
996 [NET_CLIENT_DRIVER_HUBPORT
] = net_init_hubport
,
997 #ifdef CONFIG_VHOST_NET_USER
998 [NET_CLIENT_DRIVER_VHOST_USER
] = net_init_vhost_user
,
1000 #ifdef CONFIG_VHOST_NET_VDPA
1001 [NET_CLIENT_DRIVER_VHOST_VDPA
] = net_init_vhost_vdpa
,
1003 #ifdef CONFIG_L2TPV3
1004 [NET_CLIENT_DRIVER_L2TPV3
] = net_init_l2tpv3
,
1009 static int net_client_init1(const Netdev
*netdev
, bool is_netdev
, Error
**errp
)
1011 NetClientState
*peer
= NULL
;
1015 if (netdev
->type
== NET_CLIENT_DRIVER_NIC
||
1016 !net_client_init_fun
[netdev
->type
]) {
1017 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
1018 "a netdev backend type");
1022 if (netdev
->type
== NET_CLIENT_DRIVER_NONE
) {
1023 return 0; /* nothing to do */
1025 if (netdev
->type
== NET_CLIENT_DRIVER_HUBPORT
||
1026 !net_client_init_fun
[netdev
->type
]) {
1027 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
1028 "a net backend type (maybe it is not compiled "
1029 "into this binary)");
1033 /* Do not add to a hub if it's a nic with a netdev= parameter. */
1034 if (netdev
->type
!= NET_CLIENT_DRIVER_NIC
||
1035 !netdev
->u
.nic
.has_netdev
) {
1036 peer
= net_hub_add_port(0, NULL
, NULL
);
1040 nc
= qemu_find_netdev(netdev
->id
);
1042 error_setg(errp
, "Duplicate ID '%s'", netdev
->id
);
1046 if (net_client_init_fun
[netdev
->type
](netdev
, netdev
->id
, peer
, errp
) < 0) {
1047 /* FIXME drop when all init functions store an Error */
1048 if (errp
&& !*errp
) {
1049 error_setg(errp
, "Device '%s' could not be initialized",
1050 NetClientDriver_str(netdev
->type
));
1056 nc
= qemu_find_netdev(netdev
->id
);
1058 nc
->is_netdev
= true;
1064 void show_netdevs(void)
1067 const char *available_netdevs
[] = {
1074 #ifdef CONFIG_L2TPV3
1080 #ifdef CONFIG_NET_BRIDGE
1083 #ifdef CONFIG_NETMAP
1089 #ifdef CONFIG_VHOST_VDPA
1094 qemu_printf("Available netdev backend types:\n");
1095 for (idx
= 0; idx
< ARRAY_SIZE(available_netdevs
); idx
++) {
1096 qemu_printf("%s\n", available_netdevs
[idx
]);
1100 static int net_client_init(QemuOpts
*opts
, bool is_netdev
, Error
**errp
)
1102 gchar
**substrings
= NULL
;
1103 Netdev
*object
= NULL
;
1105 Visitor
*v
= opts_visitor_new(opts
);
1107 /* Parse convenience option format ip6-net=fec0::0[/64] */
1108 const char *ip6_net
= qemu_opt_get(opts
, "ipv6-net");
1112 unsigned long prefix_len
= 64; /* Default 64bit prefix length. */
1114 substrings
= g_strsplit(ip6_net
, "/", 2);
1115 if (!substrings
|| !substrings
[0]) {
1116 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "ipv6-net",
1117 "a valid IPv6 prefix");
1121 prefix_addr
= substrings
[0];
1123 /* Handle user-specified prefix length. */
1124 if (substrings
[1] &&
1125 qemu_strtoul(substrings
[1], NULL
, 10, &prefix_len
))
1127 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1128 "ipv6-prefixlen", "a number");
1132 qemu_opt_set(opts
, "ipv6-prefix", prefix_addr
, &error_abort
);
1133 qemu_opt_set_number(opts
, "ipv6-prefixlen", prefix_len
,
1135 qemu_opt_unset(opts
, "ipv6-net");
1138 /* Create an ID for -net if the user did not specify one */
1139 if (!is_netdev
&& !qemu_opts_id(opts
)) {
1140 qemu_opts_set_id(opts
, id_generate(ID_NET
));
1143 if (visit_type_Netdev(v
, NULL
, &object
, errp
)) {
1144 ret
= net_client_init1(object
, is_netdev
, errp
);
1147 qapi_free_Netdev(object
);
1150 g_strfreev(substrings
);
1155 void netdev_add(QemuOpts
*opts
, Error
**errp
)
1157 net_client_init(opts
, true, errp
);
1160 void qmp_netdev_add(Netdev
*netdev
, Error
**errp
)
1162 if (!id_wellformed(netdev
->id
)) {
1163 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "id", "an identifier");
1167 net_client_init1(netdev
, true, errp
);
1170 void qmp_netdev_del(const char *id
, Error
**errp
)
1175 nc
= qemu_find_netdev(id
);
1177 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1178 "Device '%s' not found", id
);
1182 if (!nc
->is_netdev
) {
1183 error_setg(errp
, "Device '%s' is not a netdev", id
);
1187 qemu_del_net_client(nc
);
1190 * Wart: we need to delete the QemuOpts associated with netdevs
1191 * created via CLI or HMP, to avoid bogus "Duplicate ID" errors in
1194 opts
= qemu_opts_find(qemu_find_opts("netdev"), id
);
1196 qemu_opts_del(opts
);
1200 static void netfilter_print_info(Monitor
*mon
, NetFilterState
*nf
)
1203 ObjectProperty
*prop
;
1204 ObjectPropertyIterator iter
;
1207 /* generate info str */
1208 object_property_iter_init(&iter
, OBJECT(nf
));
1209 while ((prop
= object_property_iter_next(&iter
))) {
1210 if (!strcmp(prop
->name
, "type")) {
1213 v
= string_output_visitor_new(false, &str
);
1214 object_property_get(OBJECT(nf
), prop
->name
, v
, NULL
);
1215 visit_complete(v
, &str
);
1217 monitor_printf(mon
, ",%s=%s", prop
->name
, str
);
1220 monitor_printf(mon
, "\n");
1223 void print_net_client(Monitor
*mon
, NetClientState
*nc
)
1227 monitor_printf(mon
, "%s: index=%d,type=%s,%s\n", nc
->name
,
1229 NetClientDriver_str(nc
->info
->type
),
1231 if (!QTAILQ_EMPTY(&nc
->filters
)) {
1232 monitor_printf(mon
, "filters:\n");
1234 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1235 monitor_printf(mon
, " - %s: type=%s",
1236 object_get_canonical_path_component(OBJECT(nf
)),
1237 object_get_typename(OBJECT(nf
)));
1238 netfilter_print_info(mon
, nf
);
1242 RxFilterInfoList
*qmp_query_rx_filter(bool has_name
, const char *name
,
1246 RxFilterInfoList
*filter_list
= NULL
, **tail
= &filter_list
;
1248 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1251 if (has_name
&& strcmp(nc
->name
, name
) != 0) {
1255 /* only query rx-filter information of NIC */
1256 if (nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
) {
1258 error_setg(errp
, "net client(%s) isn't a NIC", name
);
1259 assert(!filter_list
);
1265 /* only query information on queue 0 since the info is per nic,
1268 if (nc
->queue_index
!= 0)
1271 if (nc
->info
->query_rx_filter
) {
1272 info
= nc
->info
->query_rx_filter(nc
);
1273 QAPI_LIST_APPEND(tail
, info
);
1274 } else if (has_name
) {
1275 error_setg(errp
, "net client(%s) doesn't support"
1276 " rx-filter querying", name
);
1277 assert(!filter_list
);
1286 if (filter_list
== NULL
&& has_name
) {
1287 error_setg(errp
, "invalid net client name: %s", name
);
1293 void hmp_info_network(Monitor
*mon
, const QDict
*qdict
)
1295 NetClientState
*nc
, *peer
;
1296 NetClientDriver type
;
1300 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1302 type
= nc
->info
->type
;
1304 /* Skip if already printed in hub info */
1305 if (net_hub_id_for_client(nc
, NULL
) == 0) {
1309 if (!peer
|| type
== NET_CLIENT_DRIVER_NIC
) {
1310 print_net_client(mon
, nc
);
1311 } /* else it's a netdev connected to a NIC, printed with the NIC */
1312 if (peer
&& type
== NET_CLIENT_DRIVER_NIC
) {
1313 monitor_printf(mon
, " \\ ");
1314 print_net_client(mon
, peer
);
1319 void colo_notify_filters_event(int event
, Error
**errp
)
1323 NetFilterClass
*nfc
= NULL
;
1324 Error
*local_err
= NULL
;
1326 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1327 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1328 nfc
= NETFILTER_GET_CLASS(OBJECT(nf
));
1329 nfc
->handle_event(nf
, event
, &local_err
);
1331 error_propagate(errp
, local_err
);
1338 void qmp_set_link(const char *name
, bool up
, Error
**errp
)
1340 NetClientState
*ncs
[MAX_QUEUE_NUM
];
1344 queues
= qemu_find_net_clients_except(name
, ncs
,
1345 NET_CLIENT_DRIVER__MAX
,
1349 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1350 "Device '%s' not found", name
);
1355 for (i
= 0; i
< queues
; i
++) {
1356 ncs
[i
]->link_down
= !up
;
1359 if (nc
->info
->link_status_changed
) {
1360 nc
->info
->link_status_changed(nc
);
1364 /* Change peer link only if the peer is NIC and then notify peer.
1365 * If the peer is a HUBPORT or a backend, we do not change the
1368 * This behavior is compatible with qemu hubs where there could be
1369 * multiple clients that can still communicate with each other in
1370 * disconnected mode. For now maintain this compatibility.
1372 if (nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1373 for (i
= 0; i
< queues
; i
++) {
1374 ncs
[i
]->peer
->link_down
= !up
;
1377 if (nc
->peer
->info
->link_status_changed
) {
1378 nc
->peer
->info
->link_status_changed(nc
->peer
);
1383 static void net_vm_change_state_handler(void *opaque
, bool running
,
1387 NetClientState
*tmp
;
1389 QTAILQ_FOREACH_SAFE(nc
, &net_clients
, next
, tmp
) {
1391 /* Flush queued packets and wake up backends. */
1392 if (nc
->peer
&& qemu_can_send_packet(nc
)) {
1393 qemu_flush_queued_packets(nc
->peer
);
1396 /* Complete all queued packets, to guarantee we don't modify
1397 * state later when VM is not running.
1399 qemu_flush_or_purge_queued_packets(nc
, true);
1404 void net_cleanup(void)
1408 /*cleanup colo compare module for COLO*/
1409 colo_compare_cleanup();
1411 /* We may del multiple entries during qemu_del_net_client(),
1412 * so QTAILQ_FOREACH_SAFE() is also not safe here.
1414 while (!QTAILQ_EMPTY(&net_clients
)) {
1415 nc
= QTAILQ_FIRST(&net_clients
);
1416 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1417 qemu_del_nic(qemu_get_nic(nc
));
1419 qemu_del_net_client(nc
);
1423 qemu_del_vm_change_state_handler(net_change_state_entry
);
1426 void net_check_clients(void)
1431 net_hub_check_clients();
1433 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1435 warn_report("%s %s has no peer",
1436 nc
->info
->type
== NET_CLIENT_DRIVER_NIC
1442 /* Check that all NICs requested via -net nic actually got created.
1443 * NICs created via -device don't need to be checked here because
1444 * they are always instantiated.
1446 for (i
= 0; i
< MAX_NICS
; i
++) {
1447 NICInfo
*nd
= &nd_table
[i
];
1448 if (nd
->used
&& !nd
->instantiated
) {
1449 warn_report("requested NIC (%s, model %s) "
1450 "was not created (not supported by this machine?)",
1451 nd
->name
? nd
->name
: "anonymous",
1452 nd
->model
? nd
->model
: "unspecified");
1457 static int net_init_client(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1459 return net_client_init(opts
, false, errp
);
1462 static int net_init_netdev(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1464 const char *type
= qemu_opt_get(opts
, "type");
1466 if (type
&& is_help_option(type
)) {
1470 return net_client_init(opts
, true, errp
);
1473 /* For the convenience "--nic" parameter */
1474 static int net_param_nic(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1481 type
= qemu_opt_get(opts
, "type");
1482 if (type
&& g_str_equal(type
, "none")) {
1483 return 0; /* Nothing to do, default_net is cleared in vl.c */
1486 idx
= nic_get_free_idx();
1487 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
1488 error_setg(errp
, "no more on-board/default NIC slots available");
1493 qemu_opt_set(opts
, "type", "user", &error_abort
);
1496 ni
= &nd_table
[idx
];
1497 memset(ni
, 0, sizeof(*ni
));
1498 ni
->model
= qemu_opt_get_del(opts
, "model");
1500 /* Create an ID if the user did not specify one */
1501 nd_id
= g_strdup(qemu_opts_id(opts
));
1503 nd_id
= id_generate(ID_NET
);
1504 qemu_opts_set_id(opts
, nd_id
);
1507 /* Handle MAC address */
1508 mac
= qemu_opt_get_del(opts
, "mac");
1510 ret
= net_parse_macaddr(ni
->macaddr
.a
, mac
);
1513 error_setg(errp
, "invalid syntax for ethernet address");
1516 if (is_multicast_ether_addr(ni
->macaddr
.a
)) {
1517 error_setg(errp
, "NIC cannot have multicast MAC address");
1522 qemu_macaddr_default_if_unset(&ni
->macaddr
);
1524 ret
= net_client_init(opts
, true, errp
);
1526 ni
->netdev
= qemu_find_netdev(nd_id
);
1536 int net_init_clients(Error
**errp
)
1538 net_change_state_entry
=
1539 qemu_add_vm_change_state_handler(net_vm_change_state_handler
, NULL
);
1541 QTAILQ_INIT(&net_clients
);
1543 if (qemu_opts_foreach(qemu_find_opts("netdev"),
1544 net_init_netdev
, NULL
, errp
)) {
1548 if (qemu_opts_foreach(qemu_find_opts("nic"), net_param_nic
, NULL
, errp
)) {
1552 if (qemu_opts_foreach(qemu_find_opts("net"), net_init_client
, NULL
, errp
)) {
1559 int net_client_parse(QemuOptsList
*opts_list
, const char *optarg
)
1561 if (!qemu_opts_parse_noisily(opts_list
, optarg
, true)) {
1570 uint32_t net_crc32(const uint8_t *p
, int len
)
1577 for (i
= 0; i
< len
; i
++) {
1579 for (j
= 0; j
< 8; j
++) {
1580 carry
= ((crc
& 0x80000000L
) ? 1 : 0) ^ (b
& 0x01);
1584 crc
= ((crc
^ POLYNOMIAL_BE
) | carry
);
1592 uint32_t net_crc32_le(const uint8_t *p
, int len
)
1599 for (i
= 0; i
< len
; i
++) {
1601 for (j
= 0; j
< 8; j
++) {
1602 carry
= (crc
& 0x1) ^ (b
& 0x01);
1606 crc
^= POLYNOMIAL_LE
;
1614 QemuOptsList qemu_netdev_opts
= {
1616 .implied_opt_name
= "type",
1617 .head
= QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts
.head
),
1620 * no elements => accept any params
1621 * validation will happen later
1623 { /* end of list */ }
1627 QemuOptsList qemu_nic_opts
= {
1629 .implied_opt_name
= "type",
1630 .head
= QTAILQ_HEAD_INITIALIZER(qemu_nic_opts
.head
),
1633 * no elements => accept any params
1634 * validation will happen later
1636 { /* end of list */ }
1640 QemuOptsList qemu_net_opts
= {
1642 .implied_opt_name
= "type",
1643 .head
= QTAILQ_HEAD_INITIALIZER(qemu_net_opts
.head
),
1646 * no elements => accept any params
1647 * validation will happen later
1649 { /* end of list */ }
1653 void net_socket_rs_init(SocketReadState
*rs
,
1654 SocketReadStateFinalize
*finalize
,
1658 rs
->vnet_hdr
= vnet_hdr
;
1661 rs
->vnet_hdr_len
= 0;
1662 memset(rs
->buf
, 0, sizeof(rs
->buf
));
1663 rs
->finalize
= finalize
;
1671 int net_fill_rstate(SocketReadState
*rs
, const uint8_t *buf
, int size
)
1676 /* Reassemble a packet from the network.
1677 * 0 = getting length.
1678 * 1 = getting vnet header length.
1681 switch (rs
->state
) {
1687 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1691 if (rs
->index
== 4) {
1693 rs
->packet_len
= ntohl(*(uint32_t *)rs
->buf
);
1699 rs
->vnet_hdr_len
= 0;
1708 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1712 if (rs
->index
== 4) {
1713 /* got vnet header length */
1714 rs
->vnet_hdr_len
= ntohl(*(uint32_t *)rs
->buf
);
1720 l
= rs
->packet_len
- rs
->index
;
1724 if (rs
->index
+ l
<= sizeof(rs
->buf
)) {
1725 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1727 fprintf(stderr
, "serious error: oversized packet received,"
1728 "connection terminated.\n");
1729 rs
->index
= rs
->state
= 0;
1736 if (rs
->index
>= rs
->packet_len
) {
1739 assert(rs
->finalize
);