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"
46 #include "qemu/main-loop.h"
47 #include "qemu/option.h"
48 #include "qapi/error.h"
49 #include "qapi/opts-visitor.h"
50 #include "sysemu/sysemu.h"
51 #include "sysemu/qtest.h"
52 #include "net/filter.h"
53 #include "qapi/string-output-visitor.h"
55 /* Net bridge is currently not supported for W32. */
57 # define CONFIG_NET_BRIDGE
60 static VMChangeStateEntry
*net_change_state_entry
;
61 static QTAILQ_HEAD(, NetClientState
) net_clients
;
63 /***********************************************************/
64 /* network device redirectors */
66 static int get_str_sep(char *buf
, int buf_size
, const char **pp
, int sep
)
77 if (len
> buf_size
- 1)
86 int parse_host_port(struct sockaddr_in
*saddr
, const char *str
,
95 if (get_str_sep(buf
, sizeof(buf
), &p
, ':') < 0) {
96 error_setg(errp
, "host address '%s' doesn't contain ':' "
97 "separating host from port", str
);
100 saddr
->sin_family
= AF_INET
;
101 if (buf
[0] == '\0') {
102 saddr
->sin_addr
.s_addr
= 0;
104 if (qemu_isdigit(buf
[0])) {
105 if (!inet_aton(buf
, &saddr
->sin_addr
)) {
106 error_setg(errp
, "host address '%s' is not a valid "
107 "IPv4 address", buf
);
111 he
= gethostbyname(buf
);
113 error_setg(errp
, "can't resolve host address '%s'", buf
);
116 saddr
->sin_addr
= *(struct in_addr
*)he
->h_addr
;
119 port
= strtol(p
, (char **)&r
, 0);
121 error_setg(errp
, "port number '%s' is invalid", p
);
124 saddr
->sin_port
= htons(port
);
128 char *qemu_mac_strdup_printf(const uint8_t *macaddr
)
130 return g_strdup_printf("%.2x:%.2x:%.2x:%.2x:%.2x:%.2x",
131 macaddr
[0], macaddr
[1], macaddr
[2],
132 macaddr
[3], macaddr
[4], macaddr
[5]);
135 void qemu_format_nic_info_str(NetClientState
*nc
, uint8_t macaddr
[6])
137 snprintf(nc
->info_str
, sizeof(nc
->info_str
),
138 "model=%s,macaddr=%02x:%02x:%02x:%02x:%02x:%02x",
140 macaddr
[0], macaddr
[1], macaddr
[2],
141 macaddr
[3], macaddr
[4], macaddr
[5]);
144 static int mac_table
[256] = {0};
146 static void qemu_macaddr_set_used(MACAddr
*macaddr
)
150 for (index
= 0x56; index
< 0xFF; index
++) {
151 if (macaddr
->a
[5] == index
) {
157 static void qemu_macaddr_set_free(MACAddr
*macaddr
)
160 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
162 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
165 for (index
= 0x56; index
< 0xFF; index
++) {
166 if (macaddr
->a
[5] == index
) {
172 static int qemu_macaddr_get_free(void)
176 for (index
= 0x56; index
< 0xFF; index
++) {
177 if (mac_table
[index
] == 0) {
185 void qemu_macaddr_default_if_unset(MACAddr
*macaddr
)
187 static const MACAddr zero
= { .a
= { 0,0,0,0,0,0 } };
188 static const MACAddr base
= { .a
= { 0x52, 0x54, 0x00, 0x12, 0x34, 0 } };
190 if (memcmp(macaddr
, &zero
, sizeof(zero
)) != 0) {
191 if (memcmp(macaddr
->a
, &base
.a
, (sizeof(base
.a
) - 1)) != 0) {
194 qemu_macaddr_set_used(macaddr
);
199 macaddr
->a
[0] = 0x52;
200 macaddr
->a
[1] = 0x54;
201 macaddr
->a
[2] = 0x00;
202 macaddr
->a
[3] = 0x12;
203 macaddr
->a
[4] = 0x34;
204 macaddr
->a
[5] = qemu_macaddr_get_free();
205 qemu_macaddr_set_used(macaddr
);
209 * Generate a name for net client
211 * Only net clients created with the legacy -net option and NICs need this.
213 static char *assign_name(NetClientState
*nc1
, const char *model
)
218 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
222 if (strcmp(nc
->model
, model
) == 0) {
227 return g_strdup_printf("%s.%d", model
, id
);
230 static void qemu_net_client_destructor(NetClientState
*nc
)
234 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
236 const struct iovec
*iov
,
240 static void qemu_net_client_setup(NetClientState
*nc
,
242 NetClientState
*peer
,
245 NetClientDestructor
*destructor
)
248 nc
->model
= g_strdup(model
);
250 nc
->name
= g_strdup(name
);
252 nc
->name
= assign_name(nc
, model
);
260 QTAILQ_INSERT_TAIL(&net_clients
, nc
, next
);
262 nc
->incoming_queue
= qemu_new_net_queue(qemu_deliver_packet_iov
, nc
);
263 nc
->destructor
= destructor
;
264 QTAILQ_INIT(&nc
->filters
);
267 NetClientState
*qemu_new_net_client(NetClientInfo
*info
,
268 NetClientState
*peer
,
274 assert(info
->size
>= sizeof(NetClientState
));
276 nc
= g_malloc0(info
->size
);
277 qemu_net_client_setup(nc
, info
, peer
, model
, name
,
278 qemu_net_client_destructor
);
283 NICState
*qemu_new_nic(NetClientInfo
*info
,
289 NetClientState
**peers
= conf
->peers
.ncs
;
291 int i
, queues
= MAX(1, conf
->peers
.queues
);
293 assert(info
->type
== NET_CLIENT_DRIVER_NIC
);
294 assert(info
->size
>= sizeof(NICState
));
296 nic
= g_malloc0(info
->size
+ sizeof(NetClientState
) * queues
);
297 nic
->ncs
= (void *)nic
+ info
->size
;
299 nic
->opaque
= opaque
;
301 for (i
= 0; i
< queues
; i
++) {
302 qemu_net_client_setup(&nic
->ncs
[i
], info
, peers
[i
], model
, name
,
304 nic
->ncs
[i
].queue_index
= i
;
310 NetClientState
*qemu_get_subqueue(NICState
*nic
, int queue_index
)
312 return nic
->ncs
+ queue_index
;
315 NetClientState
*qemu_get_queue(NICState
*nic
)
317 return qemu_get_subqueue(nic
, 0);
320 NICState
*qemu_get_nic(NetClientState
*nc
)
322 NetClientState
*nc0
= nc
- nc
->queue_index
;
324 return (NICState
*)((void *)nc0
- nc
->info
->size
);
327 void *qemu_get_nic_opaque(NetClientState
*nc
)
329 NICState
*nic
= qemu_get_nic(nc
);
334 static void qemu_cleanup_net_client(NetClientState
*nc
)
336 QTAILQ_REMOVE(&net_clients
, nc
, next
);
338 if (nc
->info
->cleanup
) {
339 nc
->info
->cleanup(nc
);
343 static void qemu_free_net_client(NetClientState
*nc
)
345 if (nc
->incoming_queue
) {
346 qemu_del_net_queue(nc
->incoming_queue
);
349 nc
->peer
->peer
= NULL
;
353 if (nc
->destructor
) {
358 void qemu_del_net_client(NetClientState
*nc
)
360 NetClientState
*ncs
[MAX_QUEUE_NUM
];
362 NetFilterState
*nf
, *next
;
364 assert(nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
);
366 /* If the NetClientState belongs to a multiqueue backend, we will change all
367 * other NetClientStates also.
369 queues
= qemu_find_net_clients_except(nc
->name
, ncs
,
370 NET_CLIENT_DRIVER_NIC
,
374 QTAILQ_FOREACH_SAFE(nf
, &nc
->filters
, next
, next
) {
375 object_unparent(OBJECT(nf
));
378 /* If there is a peer NIC, delete and cleanup client, but do not free. */
379 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
380 NICState
*nic
= qemu_get_nic(nc
->peer
);
381 if (nic
->peer_deleted
) {
384 nic
->peer_deleted
= true;
386 for (i
= 0; i
< queues
; i
++) {
387 ncs
[i
]->peer
->link_down
= true;
390 if (nc
->peer
->info
->link_status_changed
) {
391 nc
->peer
->info
->link_status_changed(nc
->peer
);
394 for (i
= 0; i
< queues
; i
++) {
395 qemu_cleanup_net_client(ncs
[i
]);
401 for (i
= 0; i
< queues
; i
++) {
402 qemu_cleanup_net_client(ncs
[i
]);
403 qemu_free_net_client(ncs
[i
]);
407 void qemu_del_nic(NICState
*nic
)
409 int i
, queues
= MAX(nic
->conf
->peers
.queues
, 1);
411 qemu_macaddr_set_free(&nic
->conf
->macaddr
);
413 /* If this is a peer NIC and peer has already been deleted, free it now. */
414 if (nic
->peer_deleted
) {
415 for (i
= 0; i
< queues
; i
++) {
416 qemu_free_net_client(qemu_get_subqueue(nic
, i
)->peer
);
420 for (i
= queues
- 1; i
>= 0; i
--) {
421 NetClientState
*nc
= qemu_get_subqueue(nic
, i
);
423 qemu_cleanup_net_client(nc
);
424 qemu_free_net_client(nc
);
430 void qemu_foreach_nic(qemu_nic_foreach func
, void *opaque
)
434 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
435 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
436 if (nc
->queue_index
== 0) {
437 func(qemu_get_nic(nc
), opaque
);
443 bool qemu_has_ufo(NetClientState
*nc
)
445 if (!nc
|| !nc
->info
->has_ufo
) {
449 return nc
->info
->has_ufo(nc
);
452 bool qemu_has_vnet_hdr(NetClientState
*nc
)
454 if (!nc
|| !nc
->info
->has_vnet_hdr
) {
458 return nc
->info
->has_vnet_hdr(nc
);
461 bool qemu_has_vnet_hdr_len(NetClientState
*nc
, int len
)
463 if (!nc
|| !nc
->info
->has_vnet_hdr_len
) {
467 return nc
->info
->has_vnet_hdr_len(nc
, len
);
470 void qemu_using_vnet_hdr(NetClientState
*nc
, bool enable
)
472 if (!nc
|| !nc
->info
->using_vnet_hdr
) {
476 nc
->info
->using_vnet_hdr(nc
, enable
);
479 void qemu_set_offload(NetClientState
*nc
, int csum
, int tso4
, int tso6
,
482 if (!nc
|| !nc
->info
->set_offload
) {
486 nc
->info
->set_offload(nc
, csum
, tso4
, tso6
, ecn
, ufo
);
489 void qemu_set_vnet_hdr_len(NetClientState
*nc
, int len
)
491 if (!nc
|| !nc
->info
->set_vnet_hdr_len
) {
495 nc
->vnet_hdr_len
= len
;
496 nc
->info
->set_vnet_hdr_len(nc
, len
);
499 int qemu_set_vnet_le(NetClientState
*nc
, bool is_le
)
501 #ifdef HOST_WORDS_BIGENDIAN
502 if (!nc
|| !nc
->info
->set_vnet_le
) {
506 return nc
->info
->set_vnet_le(nc
, is_le
);
512 int qemu_set_vnet_be(NetClientState
*nc
, bool is_be
)
514 #ifdef HOST_WORDS_BIGENDIAN
517 if (!nc
|| !nc
->info
->set_vnet_be
) {
521 return nc
->info
->set_vnet_be(nc
, is_be
);
525 int qemu_can_send_packet(NetClientState
*sender
)
527 int vm_running
= runstate_is_running();
537 if (sender
->peer
->receive_disabled
) {
539 } else if (sender
->peer
->info
->can_receive
&&
540 !sender
->peer
->info
->can_receive(sender
->peer
)) {
546 static ssize_t
filter_receive_iov(NetClientState
*nc
,
547 NetFilterDirection direction
,
548 NetClientState
*sender
,
550 const struct iovec
*iov
,
552 NetPacketSent
*sent_cb
)
555 NetFilterState
*nf
= NULL
;
557 if (direction
== NET_FILTER_DIRECTION_TX
) {
558 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
559 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
566 QTAILQ_FOREACH_REVERSE(nf
, &nc
->filters
, next
) {
567 ret
= qemu_netfilter_receive(nf
, direction
, sender
, flags
, iov
,
578 static ssize_t
filter_receive(NetClientState
*nc
,
579 NetFilterDirection direction
,
580 NetClientState
*sender
,
584 NetPacketSent
*sent_cb
)
587 .iov_base
= (void *)data
,
591 return filter_receive_iov(nc
, direction
, sender
, flags
, &iov
, 1, sent_cb
);
594 void qemu_purge_queued_packets(NetClientState
*nc
)
600 qemu_net_queue_purge(nc
->peer
->incoming_queue
, nc
);
603 void qemu_flush_or_purge_queued_packets(NetClientState
*nc
, bool purge
)
605 nc
->receive_disabled
= 0;
607 if (nc
->peer
&& nc
->peer
->info
->type
== NET_CLIENT_DRIVER_HUBPORT
) {
608 if (net_hub_flush(nc
->peer
)) {
612 if (qemu_net_queue_flush(nc
->incoming_queue
)) {
613 /* We emptied the queue successfully, signal to the IO thread to repoll
614 * the file descriptor (for tap, for example).
618 /* Unable to empty the queue, purge remaining packets */
619 qemu_net_queue_purge(nc
->incoming_queue
, nc
);
623 void qemu_flush_queued_packets(NetClientState
*nc
)
625 qemu_flush_or_purge_queued_packets(nc
, false);
628 static ssize_t
qemu_send_packet_async_with_flags(NetClientState
*sender
,
630 const uint8_t *buf
, int size
,
631 NetPacketSent
*sent_cb
)
637 printf("qemu_send_packet_async:\n");
638 qemu_hexdump((const char *)buf
, stdout
, "net", size
);
641 if (sender
->link_down
|| !sender
->peer
) {
645 /* Let filters handle the packet first */
646 ret
= filter_receive(sender
, NET_FILTER_DIRECTION_TX
,
647 sender
, flags
, buf
, size
, sent_cb
);
652 ret
= filter_receive(sender
->peer
, NET_FILTER_DIRECTION_RX
,
653 sender
, flags
, buf
, size
, sent_cb
);
658 queue
= sender
->peer
->incoming_queue
;
660 return qemu_net_queue_send(queue
, sender
, flags
, buf
, size
, sent_cb
);
663 ssize_t
qemu_send_packet_async(NetClientState
*sender
,
664 const uint8_t *buf
, int size
,
665 NetPacketSent
*sent_cb
)
667 return qemu_send_packet_async_with_flags(sender
, QEMU_NET_PACKET_FLAG_NONE
,
671 ssize_t
qemu_send_packet(NetClientState
*nc
, const uint8_t *buf
, int size
)
673 return qemu_send_packet_async(nc
, buf
, size
, NULL
);
676 ssize_t
qemu_send_packet_raw(NetClientState
*nc
, const uint8_t *buf
, int size
)
678 return qemu_send_packet_async_with_flags(nc
, QEMU_NET_PACKET_FLAG_RAW
,
682 static ssize_t
nc_sendv_compat(NetClientState
*nc
, const struct iovec
*iov
,
683 int iovcnt
, unsigned flags
)
691 buffer
= iov
[0].iov_base
;
692 offset
= iov
[0].iov_len
;
694 offset
= iov_size(iov
, iovcnt
);
695 if (offset
> NET_BUFSIZE
) {
698 buf
= g_malloc(offset
);
700 offset
= iov_to_buf(iov
, iovcnt
, 0, buf
, offset
);
703 if (flags
& QEMU_NET_PACKET_FLAG_RAW
&& nc
->info
->receive_raw
) {
704 ret
= nc
->info
->receive_raw(nc
, buffer
, offset
);
706 ret
= nc
->info
->receive(nc
, buffer
, offset
);
713 static ssize_t
qemu_deliver_packet_iov(NetClientState
*sender
,
715 const struct iovec
*iov
,
719 NetClientState
*nc
= opaque
;
724 return iov_size(iov
, iovcnt
);
727 if (nc
->receive_disabled
) {
731 if (nc
->info
->receive_iov
&& !(flags
& QEMU_NET_PACKET_FLAG_RAW
)) {
732 ret
= nc
->info
->receive_iov(nc
, iov
, iovcnt
);
734 ret
= nc_sendv_compat(nc
, iov
, iovcnt
, flags
);
738 nc
->receive_disabled
= 1;
744 ssize_t
qemu_sendv_packet_async(NetClientState
*sender
,
745 const struct iovec
*iov
, int iovcnt
,
746 NetPacketSent
*sent_cb
)
749 size_t size
= iov_size(iov
, iovcnt
);
752 if (size
> NET_BUFSIZE
) {
756 if (sender
->link_down
|| !sender
->peer
) {
760 /* Let filters handle the packet first */
761 ret
= filter_receive_iov(sender
, NET_FILTER_DIRECTION_TX
, sender
,
762 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
767 ret
= filter_receive_iov(sender
->peer
, NET_FILTER_DIRECTION_RX
, sender
,
768 QEMU_NET_PACKET_FLAG_NONE
, iov
, iovcnt
, sent_cb
);
773 queue
= sender
->peer
->incoming_queue
;
775 return qemu_net_queue_send_iov(queue
, sender
,
776 QEMU_NET_PACKET_FLAG_NONE
,
777 iov
, iovcnt
, sent_cb
);
781 qemu_sendv_packet(NetClientState
*nc
, const struct iovec
*iov
, int iovcnt
)
783 return qemu_sendv_packet_async(nc
, iov
, iovcnt
, NULL
);
786 NetClientState
*qemu_find_netdev(const char *id
)
790 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
791 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
)
793 if (!strcmp(nc
->name
, id
)) {
801 int qemu_find_net_clients_except(const char *id
, NetClientState
**ncs
,
802 NetClientDriver type
, int max
)
807 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
808 if (nc
->info
->type
== type
) {
811 if (!id
|| !strcmp(nc
->name
, id
)) {
822 static int nic_get_free_idx(void)
826 for (index
= 0; index
< MAX_NICS
; index
++)
827 if (!nd_table
[index
].used
)
832 int qemu_show_nic_models(const char *arg
, const char *const *models
)
836 if (!arg
|| !is_help_option(arg
)) {
840 printf("Supported NIC models:\n");
841 for (i
= 0 ; models
[i
]; i
++) {
842 printf("%s\n", models
[i
]);
847 void qemu_check_nic_model(NICInfo
*nd
, const char *model
)
849 const char *models
[2];
854 if (qemu_show_nic_models(nd
->model
, models
))
856 if (qemu_find_nic_model(nd
, models
, model
) < 0)
860 int qemu_find_nic_model(NICInfo
*nd
, const char * const *models
,
861 const char *default_model
)
866 nd
->model
= g_strdup(default_model
);
868 for (i
= 0 ; models
[i
]; i
++) {
869 if (strcmp(nd
->model
, models
[i
]) == 0)
873 error_report("Unsupported NIC model: %s", nd
->model
);
877 static int net_init_nic(const Netdev
*netdev
, const char *name
,
878 NetClientState
*peer
, Error
**errp
)
882 const NetLegacyNicOptions
*nic
;
884 assert(netdev
->type
== NET_CLIENT_DRIVER_NIC
);
885 nic
= &netdev
->u
.nic
;
887 idx
= nic_get_free_idx();
888 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
889 error_setg(errp
, "too many NICs");
895 memset(nd
, 0, sizeof(*nd
));
897 if (nic
->has_netdev
) {
898 nd
->netdev
= qemu_find_netdev(nic
->netdev
);
900 error_setg(errp
, "netdev '%s' not found", nic
->netdev
);
907 nd
->name
= g_strdup(name
);
908 if (nic
->has_model
) {
909 nd
->model
= g_strdup(nic
->model
);
912 nd
->devaddr
= g_strdup(nic
->addr
);
915 if (nic
->has_macaddr
&&
916 net_parse_macaddr(nd
->macaddr
.a
, nic
->macaddr
) < 0) {
917 error_setg(errp
, "invalid syntax for ethernet address");
920 if (nic
->has_macaddr
&&
921 is_multicast_ether_addr(nd
->macaddr
.a
)) {
923 "NIC cannot have multicast MAC address (odd 1st byte)");
926 qemu_macaddr_default_if_unset(&nd
->macaddr
);
928 if (nic
->has_vectors
) {
929 if (nic
->vectors
> 0x7ffffff) {
930 error_setg(errp
, "invalid # of vectors: %"PRIu32
, nic
->vectors
);
933 nd
->nvectors
= nic
->vectors
;
935 nd
->nvectors
= DEV_NVECTORS_UNSPECIFIED
;
945 static int (* const net_client_init_fun
[NET_CLIENT_DRIVER__MAX
])(
946 const Netdev
*netdev
,
948 NetClientState
*peer
, Error
**errp
) = {
949 [NET_CLIENT_DRIVER_NIC
] = net_init_nic
,
951 [NET_CLIENT_DRIVER_USER
] = net_init_slirp
,
953 [NET_CLIENT_DRIVER_TAP
] = net_init_tap
,
954 [NET_CLIENT_DRIVER_SOCKET
] = net_init_socket
,
956 [NET_CLIENT_DRIVER_VDE
] = net_init_vde
,
959 [NET_CLIENT_DRIVER_NETMAP
] = net_init_netmap
,
961 #ifdef CONFIG_NET_BRIDGE
962 [NET_CLIENT_DRIVER_BRIDGE
] = net_init_bridge
,
964 [NET_CLIENT_DRIVER_HUBPORT
] = net_init_hubport
,
965 #ifdef CONFIG_VHOST_NET_USER
966 [NET_CLIENT_DRIVER_VHOST_USER
] = net_init_vhost_user
,
969 [NET_CLIENT_DRIVER_L2TPV3
] = net_init_l2tpv3
,
974 static int net_client_init1(const void *object
, bool is_netdev
, Error
**errp
)
977 const Netdev
*netdev
;
979 NetClientState
*peer
= NULL
;
985 if (netdev
->type
== NET_CLIENT_DRIVER_NIC
||
986 !net_client_init_fun
[netdev
->type
]) {
987 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
988 "a netdev backend type");
992 const NetLegacy
*net
= object
;
993 const NetLegacyOptions
*opts
= net
->opts
;
996 /* missing optional values have been initialized to "all bits zero" */
997 name
= net
->has_id
? net
->id
: net
->name
;
1000 warn_report("The 'name' parameter is deprecated, use 'id' instead");
1003 /* Map the old options to the new flat type */
1004 switch (opts
->type
) {
1005 case NET_LEGACY_OPTIONS_TYPE_NONE
:
1006 return 0; /* nothing to do */
1007 case NET_LEGACY_OPTIONS_TYPE_NIC
:
1008 legacy
.type
= NET_CLIENT_DRIVER_NIC
;
1009 legacy
.u
.nic
= opts
->u
.nic
;
1011 case NET_LEGACY_OPTIONS_TYPE_USER
:
1012 legacy
.type
= NET_CLIENT_DRIVER_USER
;
1013 legacy
.u
.user
= opts
->u
.user
;
1015 case NET_LEGACY_OPTIONS_TYPE_TAP
:
1016 legacy
.type
= NET_CLIENT_DRIVER_TAP
;
1017 legacy
.u
.tap
= opts
->u
.tap
;
1019 case NET_LEGACY_OPTIONS_TYPE_L2TPV3
:
1020 legacy
.type
= NET_CLIENT_DRIVER_L2TPV3
;
1021 legacy
.u
.l2tpv3
= opts
->u
.l2tpv3
;
1023 case NET_LEGACY_OPTIONS_TYPE_SOCKET
:
1024 legacy
.type
= NET_CLIENT_DRIVER_SOCKET
;
1025 legacy
.u
.socket
= opts
->u
.socket
;
1027 case NET_LEGACY_OPTIONS_TYPE_VDE
:
1028 legacy
.type
= NET_CLIENT_DRIVER_VDE
;
1029 legacy
.u
.vde
= opts
->u
.vde
;
1031 case NET_LEGACY_OPTIONS_TYPE_BRIDGE
:
1032 legacy
.type
= NET_CLIENT_DRIVER_BRIDGE
;
1033 legacy
.u
.bridge
= opts
->u
.bridge
;
1035 case NET_LEGACY_OPTIONS_TYPE_NETMAP
:
1036 legacy
.type
= NET_CLIENT_DRIVER_NETMAP
;
1037 legacy
.u
.netmap
= opts
->u
.netmap
;
1039 case NET_LEGACY_OPTIONS_TYPE_VHOST_USER
:
1040 legacy
.type
= NET_CLIENT_DRIVER_VHOST_USER
;
1041 legacy
.u
.vhost_user
= opts
->u
.vhost_user
;
1047 if (!net_client_init_fun
[netdev
->type
]) {
1048 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "type",
1049 "a net backend type (maybe it is not compiled "
1050 "into this binary)");
1054 /* Do not add to a hub if it's a nic with a netdev= parameter. */
1055 if (netdev
->type
!= NET_CLIENT_DRIVER_NIC
||
1056 !opts
->u
.nic
.has_netdev
) {
1057 peer
= net_hub_add_port(0, NULL
, NULL
);
1061 if (net_client_init_fun
[netdev
->type
](netdev
, name
, peer
, errp
) < 0) {
1062 /* FIXME drop when all init functions store an Error */
1063 if (errp
&& !*errp
) {
1064 error_setg(errp
, QERR_DEVICE_INIT_FAILED
,
1065 NetClientDriver_str(netdev
->type
));
1072 static void show_netdevs(void)
1075 const char *available_netdevs
[] = {
1082 #ifdef CONFIG_L2TPV3
1088 #ifdef CONFIG_NET_BRIDGE
1091 #ifdef CONFIG_NETMAP
1099 printf("Available netdev backend types:\n");
1100 for (idx
= 0; idx
< ARRAY_SIZE(available_netdevs
); idx
++) {
1101 puts(available_netdevs
[idx
]);
1105 static int net_client_init(QemuOpts
*opts
, bool is_netdev
, Error
**errp
)
1107 void *object
= NULL
;
1110 Visitor
*v
= opts_visitor_new(opts
);
1112 const char *type
= qemu_opt_get(opts
, "type");
1114 if (is_netdev
&& type
&& is_help_option(type
)) {
1118 /* Parse convenience option format ip6-net=fec0::0[/64] */
1119 const char *ip6_net
= qemu_opt_get(opts
, "ipv6-net");
1122 char buf
[strlen(ip6_net
) + 1];
1124 if (get_str_sep(buf
, sizeof(buf
), &ip6_net
, '/') < 0) {
1125 /* Default 64bit prefix length. */
1126 qemu_opt_set(opts
, "ipv6-prefix", ip6_net
, &error_abort
);
1127 qemu_opt_set_number(opts
, "ipv6-prefixlen", 64, &error_abort
);
1129 /* User-specified prefix length. */
1133 qemu_opt_set(opts
, "ipv6-prefix", buf
, &error_abort
);
1134 err
= qemu_strtoul(ip6_net
, NULL
, 10, &len
);
1137 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
,
1138 "ipv6-prefix", "a number");
1140 qemu_opt_set_number(opts
, "ipv6-prefixlen", len
,
1144 qemu_opt_unset(opts
, "ipv6-net");
1149 visit_type_Netdev(v
, NULL
, (Netdev
**)&object
, &err
);
1151 visit_type_NetLegacy(v
, NULL
, (NetLegacy
**)&object
, &err
);
1155 ret
= net_client_init1(object
, is_netdev
, &err
);
1159 qapi_free_Netdev(object
);
1161 qapi_free_NetLegacy(object
);
1164 error_propagate(errp
, err
);
1169 void netdev_add(QemuOpts
*opts
, Error
**errp
)
1171 net_client_init(opts
, true, errp
);
1174 void qmp_netdev_add(QDict
*qdict
, QObject
**ret
, Error
**errp
)
1176 Error
*local_err
= NULL
;
1177 QemuOptsList
*opts_list
;
1180 opts_list
= qemu_find_opts_err("netdev", &local_err
);
1185 opts
= qemu_opts_from_qdict(opts_list
, qdict
, &local_err
);
1190 netdev_add(opts
, &local_err
);
1192 qemu_opts_del(opts
);
1197 error_propagate(errp
, local_err
);
1200 void qmp_netdev_del(const char *id
, Error
**errp
)
1205 nc
= qemu_find_netdev(id
);
1207 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1208 "Device '%s' not found", id
);
1212 opts
= qemu_opts_find(qemu_find_opts_err("netdev", NULL
), id
);
1214 error_setg(errp
, "Device '%s' is not a netdev", id
);
1218 qemu_del_net_client(nc
);
1219 qemu_opts_del(opts
);
1222 static void netfilter_print_info(Monitor
*mon
, NetFilterState
*nf
)
1225 ObjectProperty
*prop
;
1226 ObjectPropertyIterator iter
;
1229 /* generate info str */
1230 object_property_iter_init(&iter
, OBJECT(nf
));
1231 while ((prop
= object_property_iter_next(&iter
))) {
1232 if (!strcmp(prop
->name
, "type")) {
1235 v
= string_output_visitor_new(false, &str
);
1236 object_property_get(OBJECT(nf
), v
, prop
->name
, NULL
);
1237 visit_complete(v
, &str
);
1239 monitor_printf(mon
, ",%s=%s", prop
->name
, str
);
1242 monitor_printf(mon
, "\n");
1245 void print_net_client(Monitor
*mon
, NetClientState
*nc
)
1249 monitor_printf(mon
, "%s: index=%d,type=%s,%s\n", nc
->name
,
1251 NetClientDriver_str(nc
->info
->type
),
1253 if (!QTAILQ_EMPTY(&nc
->filters
)) {
1254 monitor_printf(mon
, "filters:\n");
1256 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1257 char *path
= object_get_canonical_path_component(OBJECT(nf
));
1259 monitor_printf(mon
, " - %s: type=%s", path
,
1260 object_get_typename(OBJECT(nf
)));
1261 netfilter_print_info(mon
, nf
);
1266 RxFilterInfoList
*qmp_query_rx_filter(bool has_name
, const char *name
,
1270 RxFilterInfoList
*filter_list
= NULL
, *last_entry
= NULL
;
1272 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1273 RxFilterInfoList
*entry
;
1276 if (has_name
&& strcmp(nc
->name
, name
) != 0) {
1280 /* only query rx-filter information of NIC */
1281 if (nc
->info
->type
!= NET_CLIENT_DRIVER_NIC
) {
1283 error_setg(errp
, "net client(%s) isn't a NIC", name
);
1289 /* only query information on queue 0 since the info is per nic,
1292 if (nc
->queue_index
!= 0)
1295 if (nc
->info
->query_rx_filter
) {
1296 info
= nc
->info
->query_rx_filter(nc
);
1297 entry
= g_malloc0(sizeof(*entry
));
1298 entry
->value
= info
;
1301 filter_list
= entry
;
1303 last_entry
->next
= entry
;
1306 } else if (has_name
) {
1307 error_setg(errp
, "net client(%s) doesn't support"
1308 " rx-filter querying", name
);
1317 if (filter_list
== NULL
&& has_name
) {
1318 error_setg(errp
, "invalid net client name: %s", name
);
1324 void hmp_info_network(Monitor
*mon
, const QDict
*qdict
)
1326 NetClientState
*nc
, *peer
;
1327 NetClientDriver type
;
1331 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1333 type
= nc
->info
->type
;
1335 /* Skip if already printed in hub info */
1336 if (net_hub_id_for_client(nc
, NULL
) == 0) {
1340 if (!peer
|| type
== NET_CLIENT_DRIVER_NIC
) {
1341 print_net_client(mon
, nc
);
1342 } /* else it's a netdev connected to a NIC, printed with the NIC */
1343 if (peer
&& type
== NET_CLIENT_DRIVER_NIC
) {
1344 monitor_printf(mon
, " \\ ");
1345 print_net_client(mon
, peer
);
1350 void colo_notify_filters_event(int event
, Error
**errp
)
1354 NetFilterClass
*nfc
= NULL
;
1355 Error
*local_err
= NULL
;
1357 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1358 QTAILQ_FOREACH(nf
, &nc
->filters
, next
) {
1359 nfc
= NETFILTER_GET_CLASS(OBJECT(nf
));
1360 nfc
->handle_event(nf
, event
, &local_err
);
1362 error_propagate(errp
, local_err
);
1369 void qmp_set_link(const char *name
, bool up
, Error
**errp
)
1371 NetClientState
*ncs
[MAX_QUEUE_NUM
];
1375 queues
= qemu_find_net_clients_except(name
, ncs
,
1376 NET_CLIENT_DRIVER__MAX
,
1380 error_set(errp
, ERROR_CLASS_DEVICE_NOT_FOUND
,
1381 "Device '%s' not found", name
);
1386 for (i
= 0; i
< queues
; i
++) {
1387 ncs
[i
]->link_down
= !up
;
1390 if (nc
->info
->link_status_changed
) {
1391 nc
->info
->link_status_changed(nc
);
1395 /* Change peer link only if the peer is NIC and then notify peer.
1396 * If the peer is a HUBPORT or a backend, we do not change the
1399 * This behavior is compatible with qemu hubs where there could be
1400 * multiple clients that can still communicate with each other in
1401 * disconnected mode. For now maintain this compatibility.
1403 if (nc
->peer
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1404 for (i
= 0; i
< queues
; i
++) {
1405 ncs
[i
]->peer
->link_down
= !up
;
1408 if (nc
->peer
->info
->link_status_changed
) {
1409 nc
->peer
->info
->link_status_changed(nc
->peer
);
1414 static void net_vm_change_state_handler(void *opaque
, int running
,
1418 NetClientState
*tmp
;
1420 QTAILQ_FOREACH_SAFE(nc
, &net_clients
, next
, tmp
) {
1422 /* Flush queued packets and wake up backends. */
1423 if (nc
->peer
&& qemu_can_send_packet(nc
)) {
1424 qemu_flush_queued_packets(nc
->peer
);
1427 /* Complete all queued packets, to guarantee we don't modify
1428 * state later when VM is not running.
1430 qemu_flush_or_purge_queued_packets(nc
, true);
1435 void net_cleanup(void)
1439 /* We may del multiple entries during qemu_del_net_client(),
1440 * so QTAILQ_FOREACH_SAFE() is also not safe here.
1442 while (!QTAILQ_EMPTY(&net_clients
)) {
1443 nc
= QTAILQ_FIRST(&net_clients
);
1444 if (nc
->info
->type
== NET_CLIENT_DRIVER_NIC
) {
1445 qemu_del_nic(qemu_get_nic(nc
));
1447 qemu_del_net_client(nc
);
1451 qemu_del_vm_change_state_handler(net_change_state_entry
);
1454 void net_check_clients(void)
1459 net_hub_check_clients();
1461 QTAILQ_FOREACH(nc
, &net_clients
, next
) {
1463 warn_report("%s %s has no peer",
1464 nc
->info
->type
== NET_CLIENT_DRIVER_NIC
1470 /* Check that all NICs requested via -net nic actually got created.
1471 * NICs created via -device don't need to be checked here because
1472 * they are always instantiated.
1474 for (i
= 0; i
< MAX_NICS
; i
++) {
1475 NICInfo
*nd
= &nd_table
[i
];
1476 if (nd
->used
&& !nd
->instantiated
) {
1477 warn_report("requested NIC (%s, model %s) "
1478 "was not created (not supported by this machine?)",
1479 nd
->name
? nd
->name
: "anonymous",
1480 nd
->model
? nd
->model
: "unspecified");
1485 static int net_init_client(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1487 return net_client_init(opts
, false, errp
);
1490 static int net_init_netdev(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1492 return net_client_init(opts
, true, errp
);
1495 /* For the convenience "--nic" parameter */
1496 static int net_param_nic(void *dummy
, QemuOpts
*opts
, Error
**errp
)
1503 type
= qemu_opt_get(opts
, "type");
1504 if (type
&& g_str_equal(type
, "none")) {
1505 return 0; /* Nothing to do, default_net is cleared in vl.c */
1508 idx
= nic_get_free_idx();
1509 if (idx
== -1 || nb_nics
>= MAX_NICS
) {
1510 error_setg(errp
, "no more on-board/default NIC slots available");
1515 qemu_opt_set(opts
, "type", "user", &error_abort
);
1518 ni
= &nd_table
[idx
];
1519 memset(ni
, 0, sizeof(*ni
));
1520 ni
->model
= qemu_opt_get_del(opts
, "model");
1522 /* Create an ID if the user did not specify one */
1523 nd_id
= g_strdup(qemu_opts_id(opts
));
1525 nd_id
= g_strdup_printf("__org.qemu.nic%i\n", idx
);
1526 qemu_opts_set_id(opts
, nd_id
);
1529 /* Handle MAC address */
1530 mac
= qemu_opt_get_del(opts
, "mac");
1532 ret
= net_parse_macaddr(ni
->macaddr
.a
, mac
);
1535 error_setg(errp
, "invalid syntax for ethernet address");
1538 if (is_multicast_ether_addr(ni
->macaddr
.a
)) {
1539 error_setg(errp
, "NIC cannot have multicast MAC address");
1544 qemu_macaddr_default_if_unset(&ni
->macaddr
);
1546 ret
= net_client_init(opts
, true, errp
);
1548 ni
->netdev
= qemu_find_netdev(nd_id
);
1558 int net_init_clients(Error
**errp
)
1560 net_change_state_entry
=
1561 qemu_add_vm_change_state_handler(net_vm_change_state_handler
, NULL
);
1563 QTAILQ_INIT(&net_clients
);
1565 if (qemu_opts_foreach(qemu_find_opts("netdev"),
1566 net_init_netdev
, NULL
, errp
)) {
1570 if (qemu_opts_foreach(qemu_find_opts("nic"), net_param_nic
, NULL
, errp
)) {
1574 if (qemu_opts_foreach(qemu_find_opts("net"), net_init_client
, NULL
, errp
)) {
1581 int net_client_parse(QemuOptsList
*opts_list
, const char *optarg
)
1583 if (!qemu_opts_parse_noisily(opts_list
, optarg
, true)) {
1592 uint32_t net_crc32(const uint8_t *p
, int len
)
1599 for (i
= 0; i
< len
; i
++) {
1601 for (j
= 0; j
< 8; j
++) {
1602 carry
= ((crc
& 0x80000000L
) ? 1 : 0) ^ (b
& 0x01);
1606 crc
= ((crc
^ POLYNOMIAL_BE
) | carry
);
1614 uint32_t net_crc32_le(const uint8_t *p
, int len
)
1621 for (i
= 0; i
< len
; i
++) {
1623 for (j
= 0; j
< 8; j
++) {
1624 carry
= (crc
& 0x1) ^ (b
& 0x01);
1628 crc
^= POLYNOMIAL_LE
;
1636 QemuOptsList qemu_netdev_opts
= {
1638 .implied_opt_name
= "type",
1639 .head
= QTAILQ_HEAD_INITIALIZER(qemu_netdev_opts
.head
),
1642 * no elements => accept any params
1643 * validation will happen later
1645 { /* end of list */ }
1649 QemuOptsList qemu_nic_opts
= {
1651 .implied_opt_name
= "type",
1652 .head
= QTAILQ_HEAD_INITIALIZER(qemu_nic_opts
.head
),
1655 * no elements => accept any params
1656 * validation will happen later
1658 { /* end of list */ }
1662 QemuOptsList qemu_net_opts
= {
1664 .implied_opt_name
= "type",
1665 .head
= QTAILQ_HEAD_INITIALIZER(qemu_net_opts
.head
),
1668 * no elements => accept any params
1669 * validation will happen later
1671 { /* end of list */ }
1675 void net_socket_rs_init(SocketReadState
*rs
,
1676 SocketReadStateFinalize
*finalize
,
1680 rs
->vnet_hdr
= vnet_hdr
;
1683 rs
->vnet_hdr_len
= 0;
1684 memset(rs
->buf
, 0, sizeof(rs
->buf
));
1685 rs
->finalize
= finalize
;
1693 int net_fill_rstate(SocketReadState
*rs
, const uint8_t *buf
, int size
)
1698 /* Reassemble a packet from the network.
1699 * 0 = getting length.
1700 * 1 = getting vnet header length.
1703 switch (rs
->state
) {
1709 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1713 if (rs
->index
== 4) {
1715 rs
->packet_len
= ntohl(*(uint32_t *)rs
->buf
);
1721 rs
->vnet_hdr_len
= 0;
1730 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1734 if (rs
->index
== 4) {
1735 /* got vnet header length */
1736 rs
->vnet_hdr_len
= ntohl(*(uint32_t *)rs
->buf
);
1742 l
= rs
->packet_len
- rs
->index
;
1746 if (rs
->index
+ l
<= sizeof(rs
->buf
)) {
1747 memcpy(rs
->buf
+ rs
->index
, buf
, l
);
1749 fprintf(stderr
, "serious error: oversized packet received,"
1750 "connection terminated.\n");
1751 rs
->index
= rs
->state
= 0;
1758 if (rs
->index
>= rs
->packet_len
) {
1761 assert(rs
->finalize
);