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"
30 #include "net/slirp.h"
34 #include "monitor/monitor.h"
35 #include "qemu/help_option.h"
36 #include "qapi/qapi-commands-net.h"
37 #include "qapi/qapi-visit-net.h"
38 #include "qapi/qmp/qdict.h"
39 #include "qapi/qmp/qerror.h"
40 #include "qemu/error-report.h"
41 #include "qemu/sockets.h"
42 #include "qemu/cutils.h"
43 #include "qemu/config-file.h"
44 #include "qemu/ctype.h"
47 #include "qemu/main-loop.h"
48 #include "qemu/option.h"
49 #include "qapi/error.h"
50 #include "qapi/opts-visitor.h"
51 #include "sysemu/sysemu.h"
52 #include "sysemu/qtest.h"
53 #include "net/filter.h"
54 #include "qapi/string-output-visitor.h"
56 /* Net bridge is currently not supported for W32. */
58 # define CONFIG_NET_BRIDGE
61 static VMChangeStateEntry
*net_change_state_entry
;
62 static QTAILQ_HEAD(, NetClientState
) net_clients
;
64 /***********************************************************/
65 /* network device redirectors */
67 static int get_str_sep(char *buf
, int buf_size
, const char **pp
, int sep
)
78 if (len
> buf_size
- 1)
87 int parse_host_port(struct sockaddr_in
*saddr
, const char *str
,
96 if (get_str_sep(buf
, sizeof(buf
), &p
, ':') < 0) {
97 error_setg(errp
, "host address '%s' doesn't contain ':' "
98 "separating host from port", str
);
101 saddr
->sin_family
= AF_INET
;
102 if (buf
[0] == '\0') {
103 saddr
->sin_addr
.s_addr
= 0;
105 if (qemu_isdigit(buf
[0])) {
106 if (!inet_aton(buf
, &saddr
->sin_addr
)) {
107 error_setg(errp
, "host address '%s' is not a valid "
108 "IPv4 address", buf
);
112 he
= gethostbyname(buf
);
114 error_setg(errp
, "can't resolve host address '%s'", buf
);
117 saddr
->sin_addr
= *(struct in_addr
*)he
->h_addr
;
120 port
= strtol(p
, (char **)&r
, 0);
122 error_setg(errp
, "port number '%s' is invalid", p
);
125 saddr
->sin_port
= htons(port
);
129 char *qemu_mac_strdup_printf(const uint8_t *macaddr
)
131 return g_strdup_printf("%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
132 macaddr
[0], macaddr
[1], macaddr
[2],
133 macaddr
[3], macaddr
[4], macaddr
[5]);
136 void qemu_format_nic_info_str(NetClientState
*nc
, uint8_t macaddr
[6])
138 snprintf(nc
->info_str
, sizeof(nc
->info_str
),
139 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
141 macaddr
[0], macaddr
[1], macaddr
[2],
142 macaddr
[3], macaddr
[4], macaddr
[5]);
145 static int mac_table
[256] = {0};
147 static void qemu_macaddr_set_used(MACAddr
*macaddr
)
151 for (index
= 0x56; index
< 0xFF; index
++) {
152 if (macaddr
->a
[5] == index
) {
158 static void qemu_macaddr_set_free(MACAddr
*macaddr
)
161 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
163 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
166 for (index
= 0x56; index
< 0xFF; index
++) {
167 if (macaddr
->a
[5] == index
) {
173 static int qemu_macaddr_get_free(void)
177 for (index
= 0x56; index
< 0xFF; index
++) {
178 if (mac_table
[index
] == 0) {
186 void qemu_macaddr_default_if_unset(MACAddr
*macaddr
)
188 static const MACAddr zero
= { .a
= { 0,0,0,0,0,0 } };
189 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
191 if (memcmp(macaddr
, &zero
, sizeof(zero
)) != 0) {
192 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
195 qemu_macaddr_set_used(macaddr
);
200 macaddr
->a
[0] = 0x52;
201 macaddr
->a
[1] = 0x54;
202 macaddr
->a
[2] = 0x00;
203 macaddr
->a
[3] = 0x12;
204 macaddr
->a
[4] = 0x34;
205 macaddr
->a
[5] = qemu_macaddr_get_free();
206 qemu_macaddr_set_used(macaddr
);
210 * Generate a name for net client
212 * Only net clients created with the legacy -net option and NICs need this.
214 static char *assign_name(NetClientState
*nc1
, const char *model
)
219 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
223 if (strcmp(nc
->model
, model
) == 0) {
228 return g_strdup_printf("%s.%d", model
, id
);
231 static void qemu_net_client_destructor(NetClientState
*nc
)
235 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
237 const struct iovec
*iov
,
241 static void qemu_net_client_setup(NetClientState
*nc
,
243 NetClientState
*peer
,
246 NetClientDestructor
*destructor
)
249 nc
->model
= g_strdup(model
);
251 nc
->name
= g_strdup(name
);
253 nc
->name
= assign_name(nc
, model
);
261 QTAILQ_INSERT_TAIL(&net_clients
, nc
, next
);
263 nc
->incoming_queue
= qemu_new_net_queue(qemu_deliver_packet_iov
, nc
);
264 nc
->destructor
= destructor
;
265 QTAILQ_INIT(&nc
->filters
);
268 NetClientState
*qemu_new_net_client(NetClientInfo
*info
,
269 NetClientState
*peer
,
275 assert(info
->size
>= sizeof(NetClientState
));
277 nc
= g_malloc0(info
->size
);
278 qemu_net_client_setup(nc
, info
, peer
, model
, name
,
279 qemu_net_client_destructor
);
284 NICState
*qemu_new_nic(NetClientInfo
*info
,
290 NetClientState
**peers
= conf
->peers
.ncs
;
292 int i
, queues
= MAX(1, conf
->peers
.queues
);
294 assert(info
->type
== NET_CLIENT_DRIVER_NIC
);
295 assert(info
->size
>= sizeof(NICState
));
297 nic
= g_malloc0(info
->size
+ sizeof(NetClientState
) * queues
);
298 nic
->ncs
= (void *)nic
+ info
->size
;
300 nic
->opaque
= opaque
;
302 for (i
= 0; i
< queues
; i
++) {
303 qemu_net_client_setup(&nic
->ncs
[i
], info
, peers
[i
], model
, name
,
305 nic
->ncs
[i
].queue_index
= i
;
311 NetClientState
*qemu_get_subqueue(NICState
*nic
, int queue_index
)
313 return nic
->ncs
+ queue_index
;
316 NetClientState
*qemu_get_queue(NICState
*nic
)
318 return qemu_get_subqueue(nic
, 0);
321 NICState
*qemu_get_nic(NetClientState
*nc
)
323 NetClientState
*nc0
= nc
- nc
->queue_index
;
325 return (NICState
*)((void *)nc0
- nc
->info
->size
);
328 void *qemu_get_nic_opaque(NetClientState
*nc
)
330 NICState
*nic
= qemu_get_nic(nc
);
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 /* If this is a peer NIC and peer has already been deleted, free it now. */
415 if (nic
->peer_deleted
) {
416 for (i
= 0; i
< queues
; i
++) {
417 qemu_free_net_client(qemu_get_subqueue(nic
, i
)->peer
);
421 for (i
= queues
- 1; i
>= 0; i
--) {
422 NetClientState
*nc
= qemu_get_subqueue(nic
, i
);
424 qemu_cleanup_net_client(nc
);
425 qemu_free_net_client(nc
);
431 void qemu_foreach_nic(qemu_nic_foreach func
, void *opaque
)
435 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
436 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
437 if (nc
->queue_index
== 0) {
438 func(qemu_get_nic(nc
), opaque
);
444 bool qemu_has_ufo(NetClientState
*nc
)
446 if (!nc
|| !nc
->info
->has_ufo
) {
450 return nc
->info
->has_ufo(nc
);
453 bool qemu_has_vnet_hdr(NetClientState
*nc
)
455 if (!nc
|| !nc
->info
->has_vnet_hdr
) {
459 return nc
->info
->has_vnet_hdr(nc
);
462 bool qemu_has_vnet_hdr_len(NetClientState
*nc
, int len
)
464 if (!nc
|| !nc
->info
->has_vnet_hdr_len
) {
468 return nc
->info
->has_vnet_hdr_len(nc
, len
);
471 void qemu_using_vnet_hdr(NetClientState
*nc
, bool enable
)
473 if (!nc
|| !nc
->info
->using_vnet_hdr
) {
477 nc
->info
->using_vnet_hdr(nc
, enable
);
480 void qemu_set_offload(NetClientState
*nc
, int csum
, int tso4
, int tso6
,
483 if (!nc
|| !nc
->info
->set_offload
) {
487 nc
->info
->set_offload(nc
, csum
, tso4
, tso6
, ecn
, ufo
);
490 void qemu_set_vnet_hdr_len(NetClientState
*nc
, int len
)
492 if (!nc
|| !nc
->info
->set_vnet_hdr_len
) {
496 nc
->vnet_hdr_len
= len
;
497 nc
->info
->set_vnet_hdr_len(nc
, len
);
500 int qemu_set_vnet_le(NetClientState
*nc
, bool is_le
)
502 #ifdef HOST_WORDS_BIGENDIAN
503 if (!nc
|| !nc
->info
->set_vnet_le
) {
507 return nc
->info
->set_vnet_le(nc
, is_le
);
513 int qemu_set_vnet_be(NetClientState
*nc
, bool is_be
)
515 #ifdef HOST_WORDS_BIGENDIAN
518 if (!nc
|| !nc
->info
->set_vnet_be
) {
522 return nc
->info
->set_vnet_be(nc
, is_be
);
526 int qemu_can_send_packet(NetClientState
*sender
)
528 int vm_running
= runstate_is_running();
538 if (sender
->peer
->receive_disabled
) {
540 } else if (sender
->peer
->info
->can_receive
&&
541 !sender
->peer
->info
->can_receive(sender
->peer
)) {
547 static ssize_t
filter_receive_iov(NetClientState
*nc
,
548 NetFilterDirection direction
,
549 NetClientState
*sender
,
551 const struct iovec
*iov
,
553 NetPacketSent
*sent_cb
)
556 NetFilterState
*nf
= NULL
;
558 if (direction
== NET_FILTER_DIRECTION_TX
) {
559 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
560 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
567 QTAILQ_FOREACH_REVERSE(nf
, &nc
->filters
, next
) {
568 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
579 static ssize_t
filter_receive(NetClientState
*nc
,
580 NetFilterDirection direction
,
581 NetClientState
*sender
,
585 NetPacketSent
*sent_cb
)
588 .iov_base
= (void *)data
,
592 return filter_receive_iov(nc
, direction
, sender
, flags
, &iov
, 1, sent_cb
);
595 void qemu_purge_queued_packets(NetClientState
*nc
)
601 qemu_net_queue_purge(nc
->peer
->incoming_queue
, nc
);
604 void qemu_flush_or_purge_queued_packets(NetClientState
*nc
, bool purge
)
606 nc
->receive_disabled
= 0;
608 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_HUBPORT
) {
609 if (net_hub_flush(nc
->peer
)) {
613 if (qemu_net_queue_flush(nc
->incoming_queue
)) {
614 /* We emptied the queue successfully, signal to the IO thread to repoll
615 * the file descriptor (for tap, for example).
619 /* Unable to empty the queue, purge remaining packets */
620 qemu_net_queue_purge(nc
->incoming_queue
, nc
);
624 void qemu_flush_queued_packets(NetClientState
*nc
)
626 qemu_flush_or_purge_queued_packets(nc
, false);
629 static ssize_t
qemu_send_packet_async_with_flags(NetClientState
*sender
,
631 const uint8_t *buf
, int size
,
632 NetPacketSent
*sent_cb
)
638 printf("qemu_send_packet_async:\n");
639 qemu_hexdump((const char *)buf
, stdout
, "net", size
);
642 if (sender
->link_down
|| !sender
->peer
) {
646 /* Let filters handle the packet first */
647 ret
= filter_receive(sender
, NET_FILTER_DIRECTION_TX
,
648 sender
, flags
, buf
, size
, sent_cb
);
653 ret
= filter_receive(sender
->peer
, NET_FILTER_DIRECTION_RX
,
654 sender
, flags
, buf
, size
, sent_cb
);
659 queue
= sender
->peer
->incoming_queue
;
661 return qemu_net_queue_send(queue
, sender
, flags
, buf
, size
, sent_cb
);
664 ssize_t
qemu_send_packet_async(NetClientState
*sender
,
665 const uint8_t *buf
, int size
,
666 NetPacketSent
*sent_cb
)
668 return qemu_send_packet_async_with_flags(sender
, QEMU_NET_PACKET_FLAG_NONE
,
672 ssize_t
qemu_send_packet(NetClientState
*nc
, const uint8_t *buf
, int size
)
674 return qemu_send_packet_async(nc
, buf
, size
, NULL
);
677 ssize_t
qemu_send_packet_raw(NetClientState
*nc
, const uint8_t *buf
, int size
)
679 return qemu_send_packet_async_with_flags(nc
, QEMU_NET_PACKET_FLAG_RAW
,
683 static ssize_t
nc_sendv_compat(NetClientState
*nc
, const struct iovec
*iov
,
684 int iovcnt
, unsigned flags
)
692 buffer
= iov
[0].iov_base
;
693 offset
= iov
[0].iov_len
;
695 offset
= iov_size(iov
, iovcnt
);
696 if (offset
> NET_BUFSIZE
) {
699 buf
= g_malloc(offset
);
701 offset
= iov_to_buf(iov
, iovcnt
, 0, buf
, offset
);
704 if (flags
& QEMU_NET_PACKET_FLAG_RAW
&& nc
->info
->receive_raw
) {
705 ret
= nc
->info
->receive_raw(nc
, buffer
, offset
);
707 ret
= nc
->info
->receive(nc
, buffer
, offset
);
714 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
716 const struct iovec
*iov
,
720 NetClientState
*nc
= opaque
;
725 return iov_size(iov
, iovcnt
);
728 if (nc
->receive_disabled
) {
732 if (nc
->info
->receive_iov
&& !(flags
& QEMU_NET_PACKET_FLAG_RAW
)) {
733 ret
= nc
->info
->receive_iov(nc
, iov
, iovcnt
);
735 ret
= nc_sendv_compat(nc
, iov
, iovcnt
, flags
);
739 nc
->receive_disabled
= 1;
745 ssize_t
qemu_sendv_packet_async(NetClientState
*sender
,
746 const struct iovec
*iov
, int iovcnt
,
747 NetPacketSent
*sent_cb
)
750 size_t size
= iov_size(iov
, iovcnt
);
753 if (size
> NET_BUFSIZE
) {
757 if (sender
->link_down
|| !sender
->peer
) {
761 /* Let filters handle the packet first */
762 ret
= filter_receive_iov(sender
, NET_FILTER_DIRECTION_TX
, sender
,
763 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
768 ret
= filter_receive_iov(sender
->peer
, NET_FILTER_DIRECTION_RX
, sender
,
769 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
774 queue
= sender
->peer
->incoming_queue
;
776 return qemu_net_queue_send_iov(queue
, sender
,
777 QEMU_NET_PACKET_FLAG_NONE
,
778 iov
, iovcnt
, sent_cb
);
782 qemu_sendv_packet(NetClientState
*nc
, const struct iovec
*iov
, int iovcnt
)
784 return qemu_sendv_packet_async(nc
, iov
, iovcnt
, NULL
);
787 NetClientState
*qemu_find_netdev(const char *id
)
791 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
792 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
)
794 if (!strcmp(nc
->name
, id
)) {
802 int qemu_find_net_clients_except(const char *id
, NetClientState
**ncs
,
803 NetClientDriver type
, int max
)
808 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
809 if (nc
->info
->type
== type
) {
812 if (!id
|| !strcmp(nc
->name
, id
)) {
823 static int nic_get_free_idx(void)
827 for (index
= 0; index
< MAX_NICS
; index
++)
828 if (!nd_table
[index
].used
)
833 int qemu_show_nic_models(const char *arg
, const char *const *models
)
837 if (!arg
|| !is_help_option(arg
)) {
841 printf("Supported NIC models:\n");
842 for (i
= 0 ; models
[i
]; i
++) {
843 printf("%s\n", models
[i
]);
848 void qemu_check_nic_model(NICInfo
*nd
, const char *model
)
850 const char *models
[2];
855 if (qemu_show_nic_models(nd
->model
, models
))
857 if (qemu_find_nic_model(nd
, models
, model
) < 0)
861 int qemu_find_nic_model(NICInfo
*nd
, const char * const *models
,
862 const char *default_model
)
867 nd
->model
= g_strdup(default_model
);
869 for (i
= 0 ; models
[i
]; i
++) {
870 if (strcmp(nd
->model
, models
[i
]) == 0)
874 error_report("Unsupported NIC model: %s", nd
->model
);
878 static int net_init_nic(const Netdev
*netdev
, const char *name
,
879 NetClientState
*peer
, Error
**errp
)
883 const NetLegacyNicOptions
*nic
;
885 assert(netdev
->type
== NET_CLIENT_DRIVER_NIC
);
886 nic
= &netdev
->u
.nic
;
888 idx
= nic_get_free_idx();
889 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
890 error_setg(errp
, "too many NICs");
896 memset(nd
, 0, sizeof(*nd
));
898 if (nic
->has_netdev
) {
899 nd
->netdev
= qemu_find_netdev(nic
->netdev
);
901 error_setg(errp
, "netdev '%s' not found", nic
->netdev
);
908 nd
->name
= g_strdup(name
);
909 if (nic
->has_model
) {
910 nd
->model
= g_strdup(nic
->model
);
913 nd
->devaddr
= g_strdup(nic
->addr
);
916 if (nic
->has_macaddr
&&
917 net_parse_macaddr(nd
->macaddr
.a
, nic
->macaddr
) < 0) {
918 error_setg(errp
, "invalid syntax for ethernet address");
921 if (nic
->has_macaddr
&&
922 is_multicast_ether_addr(nd
->macaddr
.a
)) {
924 "NIC cannot have multicast MAC address (odd 1st byte)");
927 qemu_macaddr_default_if_unset(&nd
->macaddr
);
929 if (nic
->has_vectors
) {
930 if (nic
->vectors
> 0x7ffffff) {
931 error_setg(errp
, "invalid # of vectors: %"PRIu32
, nic
->vectors
);
934 nd
->nvectors
= nic
->vectors
;
936 nd
->nvectors
= DEV_NVECTORS_UNSPECIFIED
;
946 static int (* const net_client_init_fun
[NET_CLIENT_DRIVER__MAX
])(
947 const Netdev
*netdev
,
949 NetClientState
*peer
, Error
**errp
) = {
950 [NET_CLIENT_DRIVER_NIC
] = net_init_nic
,
952 [NET_CLIENT_DRIVER_USER
] = net_init_slirp
,
954 [NET_CLIENT_DRIVER_TAP
] = net_init_tap
,
955 [NET_CLIENT_DRIVER_SOCKET
] = net_init_socket
,
957 [NET_CLIENT_DRIVER_VDE
] = net_init_vde
,
960 [NET_CLIENT_DRIVER_NETMAP
] = net_init_netmap
,
962 #ifdef CONFIG_NET_BRIDGE
963 [NET_CLIENT_DRIVER_BRIDGE
] = net_init_bridge
,
965 [NET_CLIENT_DRIVER_HUBPORT
] = net_init_hubport
,
966 #ifdef CONFIG_VHOST_NET_USER
967 [NET_CLIENT_DRIVER_VHOST_USER
] = net_init_vhost_user
,
970 [NET_CLIENT_DRIVER_L2TPV3
] = net_init_l2tpv3
,
975 static int net_client_init1(const void *object
, bool is_netdev
, Error
**errp
)
978 const Netdev
*netdev
;
980 NetClientState
*peer
= NULL
;
986 if (netdev
->type
== NET_CLIENT_DRIVER_NIC
||
987 !net_client_init_fun
[netdev
->type
]) {
988 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
989 "a netdev backend type");
993 const NetLegacy
*net
= object
;
994 const NetLegacyOptions
*opts
= net
->opts
;
997 /* missing optional values have been initialized to "all bits zero" */
998 name
= net
->has_id
? net
->id
: net
->name
;
1000 if (net
->has_name
) {
1001 warn_report("The 'name' parameter is deprecated, use 'id' instead");
1004 /* Map the old options to the new flat type */
1005 switch (opts
->type
) {
1006 case NET_LEGACY_OPTIONS_TYPE_NONE
:
1007 return 0; /* nothing to do */
1008 case NET_LEGACY_OPTIONS_TYPE_NIC
:
1009 legacy
.type
= NET_CLIENT_DRIVER_NIC
;
1010 legacy
.u
.nic
= opts
->u
.nic
;
1012 case NET_LEGACY_OPTIONS_TYPE_USER
:
1013 legacy
.type
= NET_CLIENT_DRIVER_USER
;
1014 legacy
.u
.user
= opts
->u
.user
;
1016 case NET_LEGACY_OPTIONS_TYPE_TAP
:
1017 legacy
.type
= NET_CLIENT_DRIVER_TAP
;
1018 legacy
.u
.tap
= opts
->u
.tap
;
1020 case NET_LEGACY_OPTIONS_TYPE_L2TPV3
:
1021 legacy
.type
= NET_CLIENT_DRIVER_L2TPV3
;
1022 legacy
.u
.l2tpv3
= opts
->u
.l2tpv3
;
1024 case NET_LEGACY_OPTIONS_TYPE_SOCKET
:
1025 legacy
.type
= NET_CLIENT_DRIVER_SOCKET
;
1026 legacy
.u
.socket
= opts
->u
.socket
;
1028 case NET_LEGACY_OPTIONS_TYPE_VDE
:
1029 legacy
.type
= NET_CLIENT_DRIVER_VDE
;
1030 legacy
.u
.vde
= opts
->u
.vde
;
1032 case NET_LEGACY_OPTIONS_TYPE_BRIDGE
:
1033 legacy
.type
= NET_CLIENT_DRIVER_BRIDGE
;
1034 legacy
.u
.bridge
= opts
->u
.bridge
;
1036 case NET_LEGACY_OPTIONS_TYPE_NETMAP
:
1037 legacy
.type
= NET_CLIENT_DRIVER_NETMAP
;
1038 legacy
.u
.netmap
= opts
->u
.netmap
;
1040 case NET_LEGACY_OPTIONS_TYPE_VHOST_USER
:
1041 legacy
.type
= NET_CLIENT_DRIVER_VHOST_USER
;
1042 legacy
.u
.vhost_user
= opts
->u
.vhost_user
;
1048 if (!net_client_init_fun
[netdev
->type
]) {
1049 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
1050 "a net backend type (maybe it is not compiled "
1051 "into this binary)");
1055 /* Do not add to a hub if it's a nic with a netdev= parameter. */
1056 if (netdev
->type
!= NET_CLIENT_DRIVER_NIC
||
1057 !opts
->u
.nic
.has_netdev
) {
1058 peer
= net_hub_add_port(0, NULL
, NULL
);
1062 if (net_client_init_fun
[netdev
->type
](netdev
, name
, peer
, errp
) < 0) {
1063 /* FIXME drop when all init functions store an Error */
1064 if (errp
&& !*errp
) {
1065 error_setg(errp
, QERR_DEVICE_INIT_FAILED
,
1066 NetClientDriver_str(netdev
->type
));
1073 static void show_netdevs(void)
1076 const char *available_netdevs
[] = {
1083 #ifdef CONFIG_L2TPV3
1089 #ifdef CONFIG_NET_BRIDGE
1092 #ifdef CONFIG_NETMAP
1100 printf("Available netdev backend types:\n");
1101 for (idx
= 0; idx
< ARRAY_SIZE(available_netdevs
); idx
++) {
1102 puts(available_netdevs
[idx
]);
1106 static int net_client_init(QemuOpts
*opts
, bool is_netdev
, Error
**errp
)
1108 void *object
= NULL
;
1111 Visitor
*v
= opts_visitor_new(opts
);
1113 const char *type
= qemu_opt_get(opts
, "type");
1115 if (is_netdev
&& type
&& is_help_option(type
)) {
1119 /* Parse convenience option format ip6-net=fec0::0[/64] */
1120 const char *ip6_net
= qemu_opt_get(opts
, "ipv6-net");
1123 char buf
[strlen(ip6_net
) + 1];
1125 if (get_str_sep(buf
, sizeof(buf
), &ip6_net
, '/') < 0) {
1126 /* Default 64bit prefix length. */
1127 qemu_opt_set(opts
, "ipv6-prefix", ip6_net
, &error_abort
);
1128 qemu_opt_set_number(opts
, "ipv6-prefixlen", 64, &error_abort
);
1130 /* User-specified prefix length. */
1134 qemu_opt_set(opts
, "ipv6-prefix", buf
, &error_abort
);
1135 err
= qemu_strtoul(ip6_net
, NULL
, 10, &len
);
1138 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1139 "ipv6-prefix", "a number");
1141 qemu_opt_set_number(opts
, "ipv6-prefixlen", len
,
1145 qemu_opt_unset(opts
, "ipv6-net");
1150 visit_type_Netdev(v
, NULL
, (Netdev
**)&object
, &err
);
1152 visit_type_NetLegacy(v
, NULL
, (NetLegacy
**)&object
, &err
);
1156 ret
= net_client_init1(object
, is_netdev
, &err
);
1160 qapi_free_Netdev(object
);
1162 qapi_free_NetLegacy(object
);
1165 error_propagate(errp
, err
);
1170 void netdev_add(QemuOpts
*opts
, Error
**errp
)
1172 net_client_init(opts
, true, errp
);
1175 void qmp_netdev_add(QDict
*qdict
, QObject
**ret
, Error
**errp
)
1177 Error
*local_err
= NULL
;
1178 QemuOptsList
*opts_list
;
1181 opts_list
= qemu_find_opts_err("netdev", &local_err
);
1186 opts
= qemu_opts_from_qdict(opts_list
, qdict
, &local_err
);
1191 netdev_add(opts
, &local_err
);
1193 qemu_opts_del(opts
);
1198 error_propagate(errp
, local_err
);
1201 void qmp_netdev_del(const char *id
, Error
**errp
)
1206 nc
= qemu_find_netdev(id
);
1208 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1209 "Device '%s' not found", id
);
1213 opts
= qemu_opts_find(qemu_find_opts_err("netdev", NULL
), id
);
1215 error_setg(errp
, "Device '%s' is not a netdev", id
);
1219 qemu_del_net_client(nc
);
1220 qemu_opts_del(opts
);
1223 static void netfilter_print_info(Monitor
*mon
, NetFilterState
*nf
)
1226 ObjectProperty
*prop
;
1227 ObjectPropertyIterator iter
;
1230 /* generate info str */
1231 object_property_iter_init(&iter
, OBJECT(nf
));
1232 while ((prop
= object_property_iter_next(&iter
))) {
1233 if (!strcmp(prop
->name
, "type")) {
1236 v
= string_output_visitor_new(false, &str
);
1237 object_property_get(OBJECT(nf
), v
, prop
->name
, NULL
);
1238 visit_complete(v
, &str
);
1240 monitor_printf(mon
, ",%s=%s", prop
->name
, str
);
1243 monitor_printf(mon
, "\n");
1246 void print_net_client(Monitor
*mon
, NetClientState
*nc
)
1250 monitor_printf(mon
, "%s: index=%d,type=%s,%s\n", nc
->name
,
1252 NetClientDriver_str(nc
->info
->type
),
1254 if (!QTAILQ_EMPTY(&nc
->filters
)) {
1255 monitor_printf(mon
, "filters:\n");
1257 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1258 char *path
= object_get_canonical_path_component(OBJECT(nf
));
1260 monitor_printf(mon
, " - %s: type=%s", path
,
1261 object_get_typename(OBJECT(nf
)));
1262 netfilter_print_info(mon
, nf
);
1267 RxFilterInfoList
*qmp_query_rx_filter(bool has_name
, const char *name
,
1271 RxFilterInfoList
*filter_list
= NULL
, *last_entry
= NULL
;
1273 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1274 RxFilterInfoList
*entry
;
1277 if (has_name
&& strcmp(nc
->name
, name
) != 0) {
1281 /* only query rx-filter information of NIC */
1282 if (nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
) {
1284 error_setg(errp
, "net client(%s) isn't a NIC", name
);
1290 /* only query information on queue 0 since the info is per nic,
1293 if (nc
->queue_index
!= 0)
1296 if (nc
->info
->query_rx_filter
) {
1297 info
= nc
->info
->query_rx_filter(nc
);
1298 entry
= g_malloc0(sizeof(*entry
));
1299 entry
->value
= info
;
1302 filter_list
= entry
;
1304 last_entry
->next
= entry
;
1307 } else if (has_name
) {
1308 error_setg(errp
, "net client(%s) doesn't support"
1309 " rx-filter querying", name
);
1318 if (filter_list
== NULL
&& has_name
) {
1319 error_setg(errp
, "invalid net client name: %s", name
);
1325 void hmp_info_network(Monitor
*mon
, const QDict
*qdict
)
1327 NetClientState
*nc
, *peer
;
1328 NetClientDriver type
;
1332 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1334 type
= nc
->info
->type
;
1336 /* Skip if already printed in hub info */
1337 if (net_hub_id_for_client(nc
, NULL
) == 0) {
1341 if (!peer
|| type
== NET_CLIENT_DRIVER_NIC
) {
1342 print_net_client(mon
, nc
);
1343 } /* else it's a netdev connected to a NIC, printed with the NIC */
1344 if (peer
&& type
== NET_CLIENT_DRIVER_NIC
) {
1345 monitor_printf(mon
, " \\ ");
1346 print_net_client(mon
, peer
);
1351 void colo_notify_filters_event(int event
, Error
**errp
)
1355 NetFilterClass
*nfc
= NULL
;
1356 Error
*local_err
= NULL
;
1358 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1359 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1360 nfc
= NETFILTER_GET_CLASS(OBJECT(nf
));
1361 nfc
->handle_event(nf
, event
, &local_err
);
1363 error_propagate(errp
, local_err
);
1370 void qmp_set_link(const char *name
, bool up
, Error
**errp
)
1372 NetClientState
*ncs
[MAX_QUEUE_NUM
];
1376 queues
= qemu_find_net_clients_except(name
, ncs
,
1377 NET_CLIENT_DRIVER__MAX
,
1381 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1382 "Device '%s' not found", name
);
1387 for (i
= 0; i
< queues
; i
++) {
1388 ncs
[i
]->link_down
= !up
;
1391 if (nc
->info
->link_status_changed
) {
1392 nc
->info
->link_status_changed(nc
);
1396 /* Change peer link only if the peer is NIC and then notify peer.
1397 * If the peer is a HUBPORT or a backend, we do not change the
1400 * This behavior is compatible with qemu hubs where there could be
1401 * multiple clients that can still communicate with each other in
1402 * disconnected mode. For now maintain this compatibility.
1404 if (nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1405 for (i
= 0; i
< queues
; i
++) {
1406 ncs
[i
]->peer
->link_down
= !up
;
1409 if (nc
->peer
->info
->link_status_changed
) {
1410 nc
->peer
->info
->link_status_changed(nc
->peer
);
1415 static void net_vm_change_state_handler(void *opaque
, int running
,
1419 NetClientState
*tmp
;
1421 QTAILQ_FOREACH_SAFE(nc
, &net_clients
, next
, tmp
) {
1423 /* Flush queued packets and wake up backends. */
1424 if (nc
->peer
&& qemu_can_send_packet(nc
)) {
1425 qemu_flush_queued_packets(nc
->peer
);
1428 /* Complete all queued packets, to guarantee we don't modify
1429 * state later when VM is not running.
1431 qemu_flush_or_purge_queued_packets(nc
, true);
1436 void net_cleanup(void)
1440 /* We may del multiple entries during qemu_del_net_client(),
1441 * so QTAILQ_FOREACH_SAFE() is also not safe here.
1443 while (!QTAILQ_EMPTY(&net_clients
)) {
1444 nc
= QTAILQ_FIRST(&net_clients
);
1445 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1446 qemu_del_nic(qemu_get_nic(nc
));
1448 qemu_del_net_client(nc
);
1452 qemu_del_vm_change_state_handler(net_change_state_entry
);
1455 void net_check_clients(void)
1460 net_hub_check_clients();
1462 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1464 warn_report("%s %s has no peer",
1465 nc
->info
->type
== NET_CLIENT_DRIVER_NIC
1471 /* Check that all NICs requested via -net nic actually got created.
1472 * NICs created via -device don't need to be checked here because
1473 * they are always instantiated.
1475 for (i
= 0; i
< MAX_NICS
; i
++) {
1476 NICInfo
*nd
= &nd_table
[i
];
1477 if (nd
->used
&& !nd
->instantiated
) {
1478 warn_report("requested NIC (%s, model %s) "
1479 "was not created (not supported by this machine?)",
1480 nd
->name
? nd
->name
: "anonymous",
1481 nd
->model
? nd
->model
: "unspecified");
1486 static int net_init_client(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1488 return net_client_init(opts
, false, errp
);
1491 static int net_init_netdev(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1493 return net_client_init(opts
, true, errp
);
1496 /* For the convenience "--nic" parameter */
1497 static int net_param_nic(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1504 type
= qemu_opt_get(opts
, "type");
1505 if (type
&& g_str_equal(type
, "none")) {
1506 return 0; /* Nothing to do, default_net is cleared in vl.c */
1509 idx
= nic_get_free_idx();
1510 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
1511 error_setg(errp
, "no more on-board/default NIC slots available");
1516 qemu_opt_set(opts
, "type", "user", &error_abort
);
1519 ni
= &nd_table
[idx
];
1520 memset(ni
, 0, sizeof(*ni
));
1521 ni
->model
= qemu_opt_get_del(opts
, "model");
1523 /* Create an ID if the user did not specify one */
1524 nd_id
= g_strdup(qemu_opts_id(opts
));
1526 nd_id
= g_strdup_printf("__org.qemu.nic%i\n", idx
);
1527 qemu_opts_set_id(opts
, nd_id
);
1530 /* Handle MAC address */
1531 mac
= qemu_opt_get_del(opts
, "mac");
1533 ret
= net_parse_macaddr(ni
->macaddr
.a
, mac
);
1536 error_setg(errp
, "invalid syntax for ethernet address");
1539 if (is_multicast_ether_addr(ni
->macaddr
.a
)) {
1540 error_setg(errp
, "NIC cannot have multicast MAC address");
1545 qemu_macaddr_default_if_unset(&ni
->macaddr
);
1547 ret
= net_client_init(opts
, true, errp
);
1549 ni
->netdev
= qemu_find_netdev(nd_id
);
1559 int net_init_clients(Error
**errp
)
1561 net_change_state_entry
=
1562 qemu_add_vm_change_state_handler(net_vm_change_state_handler
, NULL
);
1564 QTAILQ_INIT(&net_clients
);
1566 if (qemu_opts_foreach(qemu_find_opts("netdev"),
1567 net_init_netdev
, NULL
, errp
)) {
1571 if (qemu_opts_foreach(qemu_find_opts("nic"), net_param_nic
, NULL
, errp
)) {
1575 if (qemu_opts_foreach(qemu_find_opts("net"), net_init_client
, NULL
, errp
)) {
1582 int net_client_parse(QemuOptsList
*opts_list
, const char *optarg
)
1584 if (!qemu_opts_parse_noisily(opts_list
, optarg
, true)) {
1593 uint32_t net_crc32(const uint8_t *p
, int len
)
1600 for (i
= 0; i
< len
; i
++) {
1602 for (j
= 0; j
< 8; j
++) {
1603 carry
= ((crc
& 0x80000000L
) ? 1 : 0) ^ (b
& 0x01);
1607 crc
= ((crc
^ POLYNOMIAL_BE
) | carry
);
1615 uint32_t net_crc32_le(const uint8_t *p
, int len
)
1622 for (i
= 0; i
< len
; i
++) {
1624 for (j
= 0; j
< 8; j
++) {
1625 carry
= (crc
& 0x1) ^ (b
& 0x01);
1629 crc
^= POLYNOMIAL_LE
;
1637 QemuOptsList qemu_netdev_opts
= {
1639 .implied_opt_name
= "type",
1640 .head
= QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts
.head
),
1643 * no elements => accept any params
1644 * validation will happen later
1646 { /* end of list */ }
1650 QemuOptsList qemu_nic_opts
= {
1652 .implied_opt_name
= "type",
1653 .head
= QTAILQ_HEAD_INITIALIZER(qemu_nic_opts
.head
),
1656 * no elements => accept any params
1657 * validation will happen later
1659 { /* end of list */ }
1663 QemuOptsList qemu_net_opts
= {
1665 .implied_opt_name
= "type",
1666 .head
= QTAILQ_HEAD_INITIALIZER(qemu_net_opts
.head
),
1669 * no elements => accept any params
1670 * validation will happen later
1672 { /* end of list */ }
1676 void net_socket_rs_init(SocketReadState
*rs
,
1677 SocketReadStateFinalize
*finalize
,
1681 rs
->vnet_hdr
= vnet_hdr
;
1684 rs
->vnet_hdr_len
= 0;
1685 memset(rs
->buf
, 0, sizeof(rs
->buf
));
1686 rs
->finalize
= finalize
;
1694 int net_fill_rstate(SocketReadState
*rs
, const uint8_t *buf
, int size
)
1699 /* Reassemble a packet from the network.
1700 * 0 = getting length.
1701 * 1 = getting vnet header length.
1704 switch (rs
->state
) {
1710 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1714 if (rs
->index
== 4) {
1716 rs
->packet_len
= ntohl(*(uint32_t *)rs
->buf
);
1722 rs
->vnet_hdr_len
= 0;
1731 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1735 if (rs
->index
== 4) {
1736 /* got vnet header length */
1737 rs
->vnet_hdr_len
= ntohl(*(uint32_t *)rs
->buf
);
1743 l
= rs
->packet_len
- rs
->index
;
1747 if (rs
->index
+ l
<= sizeof(rs
->buf
)) {
1748 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1750 fprintf(stderr
, "serious error: oversized packet received,"
1751 "connection terminated.\n");
1752 rs
->index
= rs
->state
= 0;
1759 if (rs
->index
>= rs
->packet_len
) {
1762 assert(rs
->finalize
);