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/filter.h"
56 #include "qapi/string-output-visitor.h"
58 /* Net bridge is currently not supported for W32. */
60 # define CONFIG_NET_BRIDGE
63 static VMChangeStateEntry
*net_change_state_entry
;
64 static QTAILQ_HEAD(, NetClientState
) net_clients
;
66 /***********************************************************/
67 /* network device redirectors */
69 int parse_host_port(struct sockaddr_in
*saddr
, const char *str
,
74 const char *addr
, *p
, *r
;
77 substrings
= g_strsplit(str
, ":", 2);
78 if (!substrings
|| !substrings
[0] || !substrings
[1]) {
79 error_setg(errp
, "host address '%s' doesn't contain ':' "
80 "separating host from port", str
);
88 saddr
->sin_family
= AF_INET
;
89 if (addr
[0] == '\0') {
90 saddr
->sin_addr
.s_addr
= 0;
92 if (qemu_isdigit(addr
[0])) {
93 if (!inet_aton(addr
, &saddr
->sin_addr
)) {
94 error_setg(errp
, "host address '%s' is not a valid "
95 "IPv4 address", addr
);
100 he
= gethostbyname(addr
);
102 error_setg(errp
, "can't resolve host address '%s'", addr
);
106 saddr
->sin_addr
= *(struct in_addr
*)he
->h_addr
;
109 port
= strtol(p
, (char **)&r
, 0);
111 error_setg(errp
, "port number '%s' is invalid", p
);
115 saddr
->sin_port
= htons(port
);
118 g_strfreev(substrings
);
122 char *qemu_mac_strdup_printf(const uint8_t *macaddr
)
124 return g_strdup_printf("%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
125 macaddr
[0], macaddr
[1], macaddr
[2],
126 macaddr
[3], macaddr
[4], macaddr
[5]);
129 void qemu_format_nic_info_str(NetClientState
*nc
, uint8_t macaddr
[6])
131 snprintf(nc
->info_str
, sizeof(nc
->info_str
),
132 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
134 macaddr
[0], macaddr
[1], macaddr
[2],
135 macaddr
[3], macaddr
[4], macaddr
[5]);
138 static int mac_table
[256] = {0};
140 static void qemu_macaddr_set_used(MACAddr
*macaddr
)
144 for (index
= 0x56; index
< 0xFF; index
++) {
145 if (macaddr
->a
[5] == index
) {
151 static void qemu_macaddr_set_free(MACAddr
*macaddr
)
154 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
156 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
159 for (index
= 0x56; index
< 0xFF; index
++) {
160 if (macaddr
->a
[5] == index
) {
166 static int qemu_macaddr_get_free(void)
170 for (index
= 0x56; index
< 0xFF; index
++) {
171 if (mac_table
[index
] == 0) {
179 void qemu_macaddr_default_if_unset(MACAddr
*macaddr
)
181 static const MACAddr zero
= { .a
= { 0,0,0,0,0,0 } };
182 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
184 if (memcmp(macaddr
, &zero
, sizeof(zero
)) != 0) {
185 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
188 qemu_macaddr_set_used(macaddr
);
193 macaddr
->a
[0] = 0x52;
194 macaddr
->a
[1] = 0x54;
195 macaddr
->a
[2] = 0x00;
196 macaddr
->a
[3] = 0x12;
197 macaddr
->a
[4] = 0x34;
198 macaddr
->a
[5] = qemu_macaddr_get_free();
199 qemu_macaddr_set_used(macaddr
);
203 * Generate a name for net client
205 * Only net clients created with the legacy -net option and NICs need this.
207 static char *assign_name(NetClientState
*nc1
, const char *model
)
212 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
216 if (strcmp(nc
->model
, model
) == 0) {
221 return g_strdup_printf("%s.%d", model
, id
);
224 static void qemu_net_client_destructor(NetClientState
*nc
)
228 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
230 const struct iovec
*iov
,
234 static void qemu_net_client_setup(NetClientState
*nc
,
236 NetClientState
*peer
,
239 NetClientDestructor
*destructor
)
242 nc
->model
= g_strdup(model
);
244 nc
->name
= g_strdup(name
);
246 nc
->name
= assign_name(nc
, model
);
254 QTAILQ_INSERT_TAIL(&net_clients
, nc
, next
);
256 nc
->incoming_queue
= qemu_new_net_queue(qemu_deliver_packet_iov
, nc
);
257 nc
->destructor
= destructor
;
258 QTAILQ_INIT(&nc
->filters
);
261 NetClientState
*qemu_new_net_client(NetClientInfo
*info
,
262 NetClientState
*peer
,
268 assert(info
->size
>= sizeof(NetClientState
));
270 nc
= g_malloc0(info
->size
);
271 qemu_net_client_setup(nc
, info
, peer
, model
, name
,
272 qemu_net_client_destructor
);
277 NICState
*qemu_new_nic(NetClientInfo
*info
,
283 NetClientState
**peers
= conf
->peers
.ncs
;
285 int i
, queues
= MAX(1, conf
->peers
.queues
);
287 assert(info
->type
== NET_CLIENT_DRIVER_NIC
);
288 assert(info
->size
>= sizeof(NICState
));
290 nic
= g_malloc0(info
->size
+ sizeof(NetClientState
) * queues
);
291 nic
->ncs
= (void *)nic
+ info
->size
;
293 nic
->opaque
= opaque
;
295 for (i
= 0; i
< queues
; i
++) {
296 qemu_net_client_setup(&nic
->ncs
[i
], info
, peers
[i
], model
, name
,
298 nic
->ncs
[i
].queue_index
= i
;
304 NetClientState
*qemu_get_subqueue(NICState
*nic
, int queue_index
)
306 return nic
->ncs
+ queue_index
;
309 NetClientState
*qemu_get_queue(NICState
*nic
)
311 return qemu_get_subqueue(nic
, 0);
314 NICState
*qemu_get_nic(NetClientState
*nc
)
316 NetClientState
*nc0
= nc
- nc
->queue_index
;
318 return (NICState
*)((void *)nc0
- nc
->info
->size
);
321 void *qemu_get_nic_opaque(NetClientState
*nc
)
323 NICState
*nic
= qemu_get_nic(nc
);
328 NetClientState
*qemu_get_peer(NetClientState
*nc
, int queue_index
)
331 NetClientState
*ncs
= nc
+ queue_index
;
335 static void qemu_cleanup_net_client(NetClientState
*nc
)
337 QTAILQ_REMOVE(&net_clients
, nc
, next
);
339 if (nc
->info
->cleanup
) {
340 nc
->info
->cleanup(nc
);
344 static void qemu_free_net_client(NetClientState
*nc
)
346 if (nc
->incoming_queue
) {
347 qemu_del_net_queue(nc
->incoming_queue
);
350 nc
->peer
->peer
= NULL
;
354 if (nc
->destructor
) {
359 void qemu_del_net_client(NetClientState
*nc
)
361 NetClientState
*ncs
[MAX_QUEUE_NUM
];
363 NetFilterState
*nf
, *next
;
365 assert(nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
);
367 /* If the NetClientState belongs to a multiqueue backend, we will change all
368 * other NetClientStates also.
370 queues
= qemu_find_net_clients_except(nc
->name
, ncs
,
371 NET_CLIENT_DRIVER_NIC
,
375 QTAILQ_FOREACH_SAFE(nf
, &nc
->filters
, next
, next
) {
376 object_unparent(OBJECT(nf
));
379 /* If there is a peer NIC, delete and cleanup client, but do not free. */
380 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
381 NICState
*nic
= qemu_get_nic(nc
->peer
);
382 if (nic
->peer_deleted
) {
385 nic
->peer_deleted
= true;
387 for (i
= 0; i
< queues
; i
++) {
388 ncs
[i
]->peer
->link_down
= true;
391 if (nc
->peer
->info
->link_status_changed
) {
392 nc
->peer
->info
->link_status_changed(nc
->peer
);
395 for (i
= 0; i
< queues
; i
++) {
396 qemu_cleanup_net_client(ncs
[i
]);
402 for (i
= 0; i
< queues
; i
++) {
403 qemu_cleanup_net_client(ncs
[i
]);
404 qemu_free_net_client(ncs
[i
]);
408 void qemu_del_nic(NICState
*nic
)
410 int i
, queues
= MAX(nic
->conf
->peers
.queues
, 1);
412 qemu_macaddr_set_free(&nic
->conf
->macaddr
);
414 for (i
= 0; i
< queues
; i
++) {
415 NetClientState
*nc
= qemu_get_subqueue(nic
, i
);
416 /* If this is a peer NIC and peer has already been deleted, free it now. */
417 if (nic
->peer_deleted
) {
418 qemu_free_net_client(nc
->peer
);
419 } else if (nc
->peer
) {
420 /* if there are RX packets pending, complete them */
421 qemu_purge_queued_packets(nc
->peer
);
425 for (i
= queues
- 1; i
>= 0; i
--) {
426 NetClientState
*nc
= qemu_get_subqueue(nic
, i
);
428 qemu_cleanup_net_client(nc
);
429 qemu_free_net_client(nc
);
435 void qemu_foreach_nic(qemu_nic_foreach func
, void *opaque
)
439 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
440 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
441 if (nc
->queue_index
== 0) {
442 func(qemu_get_nic(nc
), opaque
);
448 bool qemu_has_ufo(NetClientState
*nc
)
450 if (!nc
|| !nc
->info
->has_ufo
) {
454 return nc
->info
->has_ufo(nc
);
457 bool qemu_has_vnet_hdr(NetClientState
*nc
)
459 if (!nc
|| !nc
->info
->has_vnet_hdr
) {
463 return nc
->info
->has_vnet_hdr(nc
);
466 bool qemu_has_vnet_hdr_len(NetClientState
*nc
, int len
)
468 if (!nc
|| !nc
->info
->has_vnet_hdr_len
) {
472 return nc
->info
->has_vnet_hdr_len(nc
, len
);
475 void qemu_using_vnet_hdr(NetClientState
*nc
, bool enable
)
477 if (!nc
|| !nc
->info
->using_vnet_hdr
) {
481 nc
->info
->using_vnet_hdr(nc
, enable
);
484 void qemu_set_offload(NetClientState
*nc
, int csum
, int tso4
, int tso6
,
487 if (!nc
|| !nc
->info
->set_offload
) {
491 nc
->info
->set_offload(nc
, csum
, tso4
, tso6
, ecn
, ufo
);
494 void qemu_set_vnet_hdr_len(NetClientState
*nc
, int len
)
496 if (!nc
|| !nc
->info
->set_vnet_hdr_len
) {
500 nc
->vnet_hdr_len
= len
;
501 nc
->info
->set_vnet_hdr_len(nc
, len
);
504 int qemu_set_vnet_le(NetClientState
*nc
, bool is_le
)
506 #ifdef HOST_WORDS_BIGENDIAN
507 if (!nc
|| !nc
->info
->set_vnet_le
) {
511 return nc
->info
->set_vnet_le(nc
, is_le
);
517 int qemu_set_vnet_be(NetClientState
*nc
, bool is_be
)
519 #ifdef HOST_WORDS_BIGENDIAN
522 if (!nc
|| !nc
->info
->set_vnet_be
) {
526 return nc
->info
->set_vnet_be(nc
, is_be
);
530 int qemu_can_receive_packet(NetClientState
*nc
)
532 if (nc
->receive_disabled
) {
534 } else if (nc
->info
->can_receive
&&
535 !nc
->info
->can_receive(nc
)) {
541 int qemu_can_send_packet(NetClientState
*sender
)
543 int vm_running
= runstate_is_running();
553 return qemu_can_receive_packet(sender
->peer
);
556 static ssize_t
filter_receive_iov(NetClientState
*nc
,
557 NetFilterDirection direction
,
558 NetClientState
*sender
,
560 const struct iovec
*iov
,
562 NetPacketSent
*sent_cb
)
565 NetFilterState
*nf
= NULL
;
567 if (direction
== NET_FILTER_DIRECTION_TX
) {
568 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
569 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
576 QTAILQ_FOREACH_REVERSE(nf
, &nc
->filters
, next
) {
577 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
588 static ssize_t
filter_receive(NetClientState
*nc
,
589 NetFilterDirection direction
,
590 NetClientState
*sender
,
594 NetPacketSent
*sent_cb
)
597 .iov_base
= (void *)data
,
601 return filter_receive_iov(nc
, direction
, sender
, flags
, &iov
, 1, sent_cb
);
604 void qemu_purge_queued_packets(NetClientState
*nc
)
610 qemu_net_queue_purge(nc
->peer
->incoming_queue
, nc
);
613 void qemu_flush_or_purge_queued_packets(NetClientState
*nc
, bool purge
)
615 nc
->receive_disabled
= 0;
617 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_HUBPORT
) {
618 if (net_hub_flush(nc
->peer
)) {
622 if (qemu_net_queue_flush(nc
->incoming_queue
)) {
623 /* We emptied the queue successfully, signal to the IO thread to repoll
624 * the file descriptor (for tap, for example).
628 /* Unable to empty the queue, purge remaining packets */
629 qemu_net_queue_purge(nc
->incoming_queue
, nc
->peer
);
633 void qemu_flush_queued_packets(NetClientState
*nc
)
635 qemu_flush_or_purge_queued_packets(nc
, false);
638 static ssize_t
qemu_send_packet_async_with_flags(NetClientState
*sender
,
640 const uint8_t *buf
, int size
,
641 NetPacketSent
*sent_cb
)
647 printf("qemu_send_packet_async:\n");
648 qemu_hexdump(stdout
, "net", buf
, size
);
651 if (sender
->link_down
|| !sender
->peer
) {
655 /* Let filters handle the packet first */
656 ret
= filter_receive(sender
, NET_FILTER_DIRECTION_TX
,
657 sender
, flags
, buf
, size
, sent_cb
);
662 ret
= filter_receive(sender
->peer
, NET_FILTER_DIRECTION_RX
,
663 sender
, flags
, buf
, size
, sent_cb
);
668 queue
= sender
->peer
->incoming_queue
;
670 return qemu_net_queue_send(queue
, sender
, flags
, buf
, size
, sent_cb
);
673 ssize_t
qemu_send_packet_async(NetClientState
*sender
,
674 const uint8_t *buf
, int size
,
675 NetPacketSent
*sent_cb
)
677 return qemu_send_packet_async_with_flags(sender
, QEMU_NET_PACKET_FLAG_NONE
,
681 ssize_t
qemu_send_packet(NetClientState
*nc
, const uint8_t *buf
, int size
)
683 return qemu_send_packet_async(nc
, buf
, size
, NULL
);
686 ssize_t
qemu_receive_packet(NetClientState
*nc
, const uint8_t *buf
, int size
)
688 if (!qemu_can_receive_packet(nc
)) {
692 return qemu_net_queue_receive(nc
->incoming_queue
, buf
, size
);
695 ssize_t
qemu_receive_packet_iov(NetClientState
*nc
, const struct iovec
*iov
,
698 if (!qemu_can_receive_packet(nc
)) {
702 return qemu_net_queue_receive_iov(nc
->incoming_queue
, iov
, iovcnt
);
705 ssize_t
qemu_send_packet_raw(NetClientState
*nc
, const uint8_t *buf
, int size
)
707 return qemu_send_packet_async_with_flags(nc
, QEMU_NET_PACKET_FLAG_RAW
,
711 static ssize_t
nc_sendv_compat(NetClientState
*nc
, const struct iovec
*iov
,
712 int iovcnt
, unsigned flags
)
720 buffer
= iov
[0].iov_base
;
721 offset
= iov
[0].iov_len
;
723 offset
= iov_size(iov
, iovcnt
);
724 if (offset
> NET_BUFSIZE
) {
727 buf
= g_malloc(offset
);
729 offset
= iov_to_buf(iov
, iovcnt
, 0, buf
, offset
);
732 if (flags
& QEMU_NET_PACKET_FLAG_RAW
&& nc
->info
->receive_raw
) {
733 ret
= nc
->info
->receive_raw(nc
, buffer
, offset
);
735 ret
= nc
->info
->receive(nc
, buffer
, offset
);
742 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
744 const struct iovec
*iov
,
748 NetClientState
*nc
= opaque
;
753 return iov_size(iov
, iovcnt
);
756 if (nc
->receive_disabled
) {
760 if (nc
->info
->receive_iov
&& !(flags
& QEMU_NET_PACKET_FLAG_RAW
)) {
761 ret
= nc
->info
->receive_iov(nc
, iov
, iovcnt
);
763 ret
= nc_sendv_compat(nc
, iov
, iovcnt
, flags
);
767 nc
->receive_disabled
= 1;
773 ssize_t
qemu_sendv_packet_async(NetClientState
*sender
,
774 const struct iovec
*iov
, int iovcnt
,
775 NetPacketSent
*sent_cb
)
778 size_t size
= iov_size(iov
, iovcnt
);
781 if (size
> NET_BUFSIZE
) {
785 if (sender
->link_down
|| !sender
->peer
) {
789 /* Let filters handle the packet first */
790 ret
= filter_receive_iov(sender
, NET_FILTER_DIRECTION_TX
, sender
,
791 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
796 ret
= filter_receive_iov(sender
->peer
, NET_FILTER_DIRECTION_RX
, sender
,
797 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
802 queue
= sender
->peer
->incoming_queue
;
804 return qemu_net_queue_send_iov(queue
, sender
,
805 QEMU_NET_PACKET_FLAG_NONE
,
806 iov
, iovcnt
, sent_cb
);
810 qemu_sendv_packet(NetClientState
*nc
, const struct iovec
*iov
, int iovcnt
)
812 return qemu_sendv_packet_async(nc
, iov
, iovcnt
, NULL
);
815 NetClientState
*qemu_find_netdev(const char *id
)
819 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
820 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
)
822 if (!strcmp(nc
->name
, id
)) {
830 int qemu_find_net_clients_except(const char *id
, NetClientState
**ncs
,
831 NetClientDriver type
, int max
)
836 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
837 if (nc
->info
->type
== type
) {
840 if (!id
|| !strcmp(nc
->name
, id
)) {
851 static int nic_get_free_idx(void)
855 for (index
= 0; index
< MAX_NICS
; index
++)
856 if (!nd_table
[index
].used
)
861 int qemu_show_nic_models(const char *arg
, const char *const *models
)
865 if (!arg
|| !is_help_option(arg
)) {
869 printf("Supported NIC models:\n");
870 for (i
= 0 ; models
[i
]; i
++) {
871 printf("%s\n", models
[i
]);
876 void qemu_check_nic_model(NICInfo
*nd
, const char *model
)
878 const char *models
[2];
883 if (qemu_show_nic_models(nd
->model
, models
))
885 if (qemu_find_nic_model(nd
, models
, model
) < 0)
889 int qemu_find_nic_model(NICInfo
*nd
, const char * const *models
,
890 const char *default_model
)
895 nd
->model
= g_strdup(default_model
);
897 for (i
= 0 ; models
[i
]; i
++) {
898 if (strcmp(nd
->model
, models
[i
]) == 0)
902 error_report("Unsupported NIC model: %s", nd
->model
);
906 static int net_init_nic(const Netdev
*netdev
, const char *name
,
907 NetClientState
*peer
, Error
**errp
)
911 const NetLegacyNicOptions
*nic
;
913 assert(netdev
->type
== NET_CLIENT_DRIVER_NIC
);
914 nic
= &netdev
->u
.nic
;
916 idx
= nic_get_free_idx();
917 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
918 error_setg(errp
, "too many NICs");
924 memset(nd
, 0, sizeof(*nd
));
926 if (nic
->has_netdev
) {
927 nd
->netdev
= qemu_find_netdev(nic
->netdev
);
929 error_setg(errp
, "netdev '%s' not found", nic
->netdev
);
936 nd
->name
= g_strdup(name
);
937 if (nic
->has_model
) {
938 nd
->model
= g_strdup(nic
->model
);
941 nd
->devaddr
= g_strdup(nic
->addr
);
944 if (nic
->has_macaddr
&&
945 net_parse_macaddr(nd
->macaddr
.a
, nic
->macaddr
) < 0) {
946 error_setg(errp
, "invalid syntax for ethernet address");
949 if (nic
->has_macaddr
&&
950 is_multicast_ether_addr(nd
->macaddr
.a
)) {
952 "NIC cannot have multicast MAC address (odd 1st byte)");
955 qemu_macaddr_default_if_unset(&nd
->macaddr
);
957 if (nic
->has_vectors
) {
958 if (nic
->vectors
> 0x7ffffff) {
959 error_setg(errp
, "invalid # of vectors: %"PRIu32
, nic
->vectors
);
962 nd
->nvectors
= nic
->vectors
;
964 nd
->nvectors
= DEV_NVECTORS_UNSPECIFIED
;
974 static int (* const net_client_init_fun
[NET_CLIENT_DRIVER__MAX
])(
975 const Netdev
*netdev
,
977 NetClientState
*peer
, Error
**errp
) = {
978 [NET_CLIENT_DRIVER_NIC
] = net_init_nic
,
980 [NET_CLIENT_DRIVER_USER
] = net_init_slirp
,
982 [NET_CLIENT_DRIVER_TAP
] = net_init_tap
,
983 [NET_CLIENT_DRIVER_SOCKET
] = net_init_socket
,
985 [NET_CLIENT_DRIVER_VDE
] = net_init_vde
,
988 [NET_CLIENT_DRIVER_NETMAP
] = net_init_netmap
,
990 #ifdef CONFIG_NET_BRIDGE
991 [NET_CLIENT_DRIVER_BRIDGE
] = net_init_bridge
,
993 [NET_CLIENT_DRIVER_HUBPORT
] = net_init_hubport
,
994 #ifdef CONFIG_VHOST_NET_USER
995 [NET_CLIENT_DRIVER_VHOST_USER
] = net_init_vhost_user
,
997 #ifdef CONFIG_VHOST_NET_VDPA
998 [NET_CLIENT_DRIVER_VHOST_VDPA
] = net_init_vhost_vdpa
,
1000 #ifdef CONFIG_L2TPV3
1001 [NET_CLIENT_DRIVER_L2TPV3
] = net_init_l2tpv3
,
1006 static int net_client_init1(const Netdev
*netdev
, bool is_netdev
, Error
**errp
)
1008 NetClientState
*peer
= NULL
;
1012 if (netdev
->type
== NET_CLIENT_DRIVER_NIC
||
1013 !net_client_init_fun
[netdev
->type
]) {
1014 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
1015 "a netdev backend type");
1019 if (netdev
->type
== NET_CLIENT_DRIVER_NONE
) {
1020 return 0; /* nothing to do */
1022 if (netdev
->type
== NET_CLIENT_DRIVER_HUBPORT
||
1023 !net_client_init_fun
[netdev
->type
]) {
1024 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
1025 "a net backend type (maybe it is not compiled "
1026 "into this binary)");
1030 /* Do not add to a hub if it's a nic with a netdev= parameter. */
1031 if (netdev
->type
!= NET_CLIENT_DRIVER_NIC
||
1032 !netdev
->u
.nic
.has_netdev
) {
1033 peer
= net_hub_add_port(0, NULL
, NULL
);
1037 nc
= qemu_find_netdev(netdev
->id
);
1039 error_setg(errp
, "Duplicate ID '%s'", netdev
->id
);
1043 if (net_client_init_fun
[netdev
->type
](netdev
, netdev
->id
, peer
, errp
) < 0) {
1044 /* FIXME drop when all init functions store an Error */
1045 if (errp
&& !*errp
) {
1046 error_setg(errp
, "Device '%s' could not be initialized",
1047 NetClientDriver_str(netdev
->type
));
1053 nc
= qemu_find_netdev(netdev
->id
);
1055 nc
->is_netdev
= true;
1061 void show_netdevs(void)
1064 const char *available_netdevs
[] = {
1071 #ifdef CONFIG_L2TPV3
1077 #ifdef CONFIG_NET_BRIDGE
1080 #ifdef CONFIG_NETMAP
1086 #ifdef CONFIG_VHOST_VDPA
1091 qemu_printf("Available netdev backend types:\n");
1092 for (idx
= 0; idx
< ARRAY_SIZE(available_netdevs
); idx
++) {
1093 qemu_printf("%s\n", available_netdevs
[idx
]);
1097 static int net_client_init(QemuOpts
*opts
, bool is_netdev
, Error
**errp
)
1099 gchar
**substrings
= NULL
;
1100 Netdev
*object
= NULL
;
1102 Visitor
*v
= opts_visitor_new(opts
);
1104 /* Parse convenience option format ip6-net=fec0::0[/64] */
1105 const char *ip6_net
= qemu_opt_get(opts
, "ipv6-net");
1109 unsigned long prefix_len
= 64; /* Default 64bit prefix length. */
1111 substrings
= g_strsplit(ip6_net
, "/", 2);
1112 if (!substrings
|| !substrings
[0]) {
1113 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "ipv6-net",
1114 "a valid IPv6 prefix");
1118 prefix_addr
= substrings
[0];
1120 /* Handle user-specified prefix length. */
1121 if (substrings
[1] &&
1122 qemu_strtoul(substrings
[1], NULL
, 10, &prefix_len
))
1124 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1125 "ipv6-prefixlen", "a number");
1129 qemu_opt_set(opts
, "ipv6-prefix", prefix_addr
, &error_abort
);
1130 qemu_opt_set_number(opts
, "ipv6-prefixlen", prefix_len
,
1132 qemu_opt_unset(opts
, "ipv6-net");
1135 /* Create an ID for -net if the user did not specify one */
1136 if (!is_netdev
&& !qemu_opts_id(opts
)) {
1137 qemu_opts_set_id(opts
, id_generate(ID_NET
));
1140 if (visit_type_Netdev(v
, NULL
, &object
, errp
)) {
1141 ret
= net_client_init1(object
, is_netdev
, errp
);
1144 qapi_free_Netdev(object
);
1147 g_strfreev(substrings
);
1152 void netdev_add(QemuOpts
*opts
, Error
**errp
)
1154 net_client_init(opts
, true, errp
);
1157 void qmp_netdev_add(Netdev
*netdev
, Error
**errp
)
1159 if (!id_wellformed(netdev
->id
)) {
1160 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "id", "an identifier");
1164 net_client_init1(netdev
, true, errp
);
1167 void qmp_netdev_del(const char *id
, Error
**errp
)
1172 nc
= qemu_find_netdev(id
);
1174 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1175 "Device '%s' not found", id
);
1179 if (!nc
->is_netdev
) {
1180 error_setg(errp
, "Device '%s' is not a netdev", id
);
1184 qemu_del_net_client(nc
);
1187 * Wart: we need to delete the QemuOpts associated with netdevs
1188 * created via CLI or HMP, to avoid bogus "Duplicate ID" errors in
1191 opts
= qemu_opts_find(qemu_find_opts("netdev"), id
);
1193 qemu_opts_del(opts
);
1197 static void netfilter_print_info(Monitor
*mon
, NetFilterState
*nf
)
1200 ObjectProperty
*prop
;
1201 ObjectPropertyIterator iter
;
1204 /* generate info str */
1205 object_property_iter_init(&iter
, OBJECT(nf
));
1206 while ((prop
= object_property_iter_next(&iter
))) {
1207 if (!strcmp(prop
->name
, "type")) {
1210 v
= string_output_visitor_new(false, &str
);
1211 object_property_get(OBJECT(nf
), prop
->name
, v
, NULL
);
1212 visit_complete(v
, &str
);
1214 monitor_printf(mon
, ",%s=%s", prop
->name
, str
);
1217 monitor_printf(mon
, "\n");
1220 void print_net_client(Monitor
*mon
, NetClientState
*nc
)
1224 monitor_printf(mon
, "%s: index=%d,type=%s,%s\n", nc
->name
,
1226 NetClientDriver_str(nc
->info
->type
),
1228 if (!QTAILQ_EMPTY(&nc
->filters
)) {
1229 monitor_printf(mon
, "filters:\n");
1231 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1232 monitor_printf(mon
, " - %s: type=%s",
1233 object_get_canonical_path_component(OBJECT(nf
)),
1234 object_get_typename(OBJECT(nf
)));
1235 netfilter_print_info(mon
, nf
);
1239 RxFilterInfoList
*qmp_query_rx_filter(bool has_name
, const char *name
,
1243 RxFilterInfoList
*filter_list
= NULL
, **tail
= &filter_list
;
1245 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1248 if (has_name
&& strcmp(nc
->name
, name
) != 0) {
1252 /* only query rx-filter information of NIC */
1253 if (nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
) {
1255 error_setg(errp
, "net client(%s) isn't a NIC", name
);
1256 assert(!filter_list
);
1262 /* only query information on queue 0 since the info is per nic,
1265 if (nc
->queue_index
!= 0)
1268 if (nc
->info
->query_rx_filter
) {
1269 info
= nc
->info
->query_rx_filter(nc
);
1270 QAPI_LIST_APPEND(tail
, info
);
1271 } else if (has_name
) {
1272 error_setg(errp
, "net client(%s) doesn't support"
1273 " rx-filter querying", name
);
1274 assert(!filter_list
);
1283 if (filter_list
== NULL
&& has_name
) {
1284 error_setg(errp
, "invalid net client name: %s", name
);
1290 void hmp_info_network(Monitor
*mon
, const QDict
*qdict
)
1292 NetClientState
*nc
, *peer
;
1293 NetClientDriver type
;
1297 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1299 type
= nc
->info
->type
;
1301 /* Skip if already printed in hub info */
1302 if (net_hub_id_for_client(nc
, NULL
) == 0) {
1306 if (!peer
|| type
== NET_CLIENT_DRIVER_NIC
) {
1307 print_net_client(mon
, nc
);
1308 } /* else it's a netdev connected to a NIC, printed with the NIC */
1309 if (peer
&& type
== NET_CLIENT_DRIVER_NIC
) {
1310 monitor_printf(mon
, " \\ ");
1311 print_net_client(mon
, peer
);
1316 void colo_notify_filters_event(int event
, Error
**errp
)
1320 NetFilterClass
*nfc
= NULL
;
1321 Error
*local_err
= NULL
;
1323 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1324 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1325 nfc
= NETFILTER_GET_CLASS(OBJECT(nf
));
1326 nfc
->handle_event(nf
, event
, &local_err
);
1328 error_propagate(errp
, local_err
);
1335 void qmp_set_link(const char *name
, bool up
, Error
**errp
)
1337 NetClientState
*ncs
[MAX_QUEUE_NUM
];
1341 queues
= qemu_find_net_clients_except(name
, ncs
,
1342 NET_CLIENT_DRIVER__MAX
,
1346 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1347 "Device '%s' not found", name
);
1352 for (i
= 0; i
< queues
; i
++) {
1353 ncs
[i
]->link_down
= !up
;
1356 if (nc
->info
->link_status_changed
) {
1357 nc
->info
->link_status_changed(nc
);
1361 /* Change peer link only if the peer is NIC and then notify peer.
1362 * If the peer is a HUBPORT or a backend, we do not change the
1365 * This behavior is compatible with qemu hubs where there could be
1366 * multiple clients that can still communicate with each other in
1367 * disconnected mode. For now maintain this compatibility.
1369 if (nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1370 for (i
= 0; i
< queues
; i
++) {
1371 ncs
[i
]->peer
->link_down
= !up
;
1374 if (nc
->peer
->info
->link_status_changed
) {
1375 nc
->peer
->info
->link_status_changed(nc
->peer
);
1380 static void net_vm_change_state_handler(void *opaque
, bool running
,
1384 NetClientState
*tmp
;
1386 QTAILQ_FOREACH_SAFE(nc
, &net_clients
, next
, tmp
) {
1388 /* Flush queued packets and wake up backends. */
1389 if (nc
->peer
&& qemu_can_send_packet(nc
)) {
1390 qemu_flush_queued_packets(nc
->peer
);
1393 /* Complete all queued packets, to guarantee we don't modify
1394 * state later when VM is not running.
1396 qemu_flush_or_purge_queued_packets(nc
, true);
1401 void net_cleanup(void)
1405 /* We may del multiple entries during qemu_del_net_client(),
1406 * so QTAILQ_FOREACH_SAFE() is also not safe here.
1408 while (!QTAILQ_EMPTY(&net_clients
)) {
1409 nc
= QTAILQ_FIRST(&net_clients
);
1410 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1411 qemu_del_nic(qemu_get_nic(nc
));
1413 qemu_del_net_client(nc
);
1417 qemu_del_vm_change_state_handler(net_change_state_entry
);
1420 void net_check_clients(void)
1425 net_hub_check_clients();
1427 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1429 warn_report("%s %s has no peer",
1430 nc
->info
->type
== NET_CLIENT_DRIVER_NIC
1436 /* Check that all NICs requested via -net nic actually got created.
1437 * NICs created via -device don't need to be checked here because
1438 * they are always instantiated.
1440 for (i
= 0; i
< MAX_NICS
; i
++) {
1441 NICInfo
*nd
= &nd_table
[i
];
1442 if (nd
->used
&& !nd
->instantiated
) {
1443 warn_report("requested NIC (%s, model %s) "
1444 "was not created (not supported by this machine?)",
1445 nd
->name
? nd
->name
: "anonymous",
1446 nd
->model
? nd
->model
: "unspecified");
1451 static int net_init_client(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1453 return net_client_init(opts
, false, errp
);
1456 static int net_init_netdev(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1458 const char *type
= qemu_opt_get(opts
, "type");
1460 if (type
&& is_help_option(type
)) {
1464 return net_client_init(opts
, true, errp
);
1467 /* For the convenience "--nic" parameter */
1468 static int net_param_nic(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1475 type
= qemu_opt_get(opts
, "type");
1476 if (type
&& g_str_equal(type
, "none")) {
1477 return 0; /* Nothing to do, default_net is cleared in vl.c */
1480 idx
= nic_get_free_idx();
1481 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
1482 error_setg(errp
, "no more on-board/default NIC slots available");
1487 qemu_opt_set(opts
, "type", "user", &error_abort
);
1490 ni
= &nd_table
[idx
];
1491 memset(ni
, 0, sizeof(*ni
));
1492 ni
->model
= qemu_opt_get_del(opts
, "model");
1494 /* Create an ID if the user did not specify one */
1495 nd_id
= g_strdup(qemu_opts_id(opts
));
1497 nd_id
= id_generate(ID_NET
);
1498 qemu_opts_set_id(opts
, nd_id
);
1501 /* Handle MAC address */
1502 mac
= qemu_opt_get_del(opts
, "mac");
1504 ret
= net_parse_macaddr(ni
->macaddr
.a
, mac
);
1507 error_setg(errp
, "invalid syntax for ethernet address");
1510 if (is_multicast_ether_addr(ni
->macaddr
.a
)) {
1511 error_setg(errp
, "NIC cannot have multicast MAC address");
1516 qemu_macaddr_default_if_unset(&ni
->macaddr
);
1518 ret
= net_client_init(opts
, true, errp
);
1520 ni
->netdev
= qemu_find_netdev(nd_id
);
1530 int net_init_clients(Error
**errp
)
1532 net_change_state_entry
=
1533 qemu_add_vm_change_state_handler(net_vm_change_state_handler
, NULL
);
1535 QTAILQ_INIT(&net_clients
);
1537 if (qemu_opts_foreach(qemu_find_opts("netdev"),
1538 net_init_netdev
, NULL
, errp
)) {
1542 if (qemu_opts_foreach(qemu_find_opts("nic"), net_param_nic
, NULL
, errp
)) {
1546 if (qemu_opts_foreach(qemu_find_opts("net"), net_init_client
, NULL
, errp
)) {
1553 int net_client_parse(QemuOptsList
*opts_list
, const char *optarg
)
1555 if (!qemu_opts_parse_noisily(opts_list
, optarg
, true)) {
1564 uint32_t net_crc32(const uint8_t *p
, int len
)
1571 for (i
= 0; i
< len
; i
++) {
1573 for (j
= 0; j
< 8; j
++) {
1574 carry
= ((crc
& 0x80000000L
) ? 1 : 0) ^ (b
& 0x01);
1578 crc
= ((crc
^ POLYNOMIAL_BE
) | carry
);
1586 uint32_t net_crc32_le(const uint8_t *p
, int len
)
1593 for (i
= 0; i
< len
; i
++) {
1595 for (j
= 0; j
< 8; j
++) {
1596 carry
= (crc
& 0x1) ^ (b
& 0x01);
1600 crc
^= POLYNOMIAL_LE
;
1608 QemuOptsList qemu_netdev_opts
= {
1610 .implied_opt_name
= "type",
1611 .head
= QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts
.head
),
1614 * no elements => accept any params
1615 * validation will happen later
1617 { /* end of list */ }
1621 QemuOptsList qemu_nic_opts
= {
1623 .implied_opt_name
= "type",
1624 .head
= QTAILQ_HEAD_INITIALIZER(qemu_nic_opts
.head
),
1627 * no elements => accept any params
1628 * validation will happen later
1630 { /* end of list */ }
1634 QemuOptsList qemu_net_opts
= {
1636 .implied_opt_name
= "type",
1637 .head
= QTAILQ_HEAD_INITIALIZER(qemu_net_opts
.head
),
1640 * no elements => accept any params
1641 * validation will happen later
1643 { /* end of list */ }
1647 void net_socket_rs_init(SocketReadState
*rs
,
1648 SocketReadStateFinalize
*finalize
,
1652 rs
->vnet_hdr
= vnet_hdr
;
1655 rs
->vnet_hdr_len
= 0;
1656 memset(rs
->buf
, 0, sizeof(rs
->buf
));
1657 rs
->finalize
= finalize
;
1665 int net_fill_rstate(SocketReadState
*rs
, const uint8_t *buf
, int size
)
1670 /* Reassemble a packet from the network.
1671 * 0 = getting length.
1672 * 1 = getting vnet header length.
1675 switch (rs
->state
) {
1681 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1685 if (rs
->index
== 4) {
1687 rs
->packet_len
= ntohl(*(uint32_t *)rs
->buf
);
1693 rs
->vnet_hdr_len
= 0;
1702 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1706 if (rs
->index
== 4) {
1707 /* got vnet header length */
1708 rs
->vnet_hdr_len
= ntohl(*(uint32_t *)rs
->buf
);
1714 l
= rs
->packet_len
- rs
->index
;
1718 if (rs
->index
+ l
<= sizeof(rs
->buf
)) {
1719 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1721 fprintf(stderr
, "serious error: oversized packet received,"
1722 "connection terminated.\n");
1723 rs
->index
= rs
->state
= 0;
1730 if (rs
->index
>= rs
->packet_len
) {
1733 assert(rs
->finalize
);