Merge remote-tracking branch 'remotes/afaerber/tags/qom-devices-for-peter' into staging
[qemu/ar7.git] / hw / net / virtio-net.c
bloba877614e3e7a14c6891e798ff6f6d5264681af4c
1 /*
2 * Virtio Network Device
4 * Copyright IBM, Corp. 2007
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
14 #include "qemu/iov.h"
15 #include "hw/virtio/virtio.h"
16 #include "net/net.h"
17 #include "net/checksum.h"
18 #include "net/tap.h"
19 #include "qemu/error-report.h"
20 #include "qemu/timer.h"
21 #include "hw/virtio/virtio-net.h"
22 #include "net/vhost_net.h"
23 #include "hw/virtio/virtio-bus.h"
24 #include "qapi/qmp/qjson.h"
25 #include "qapi-event.h"
26 #include "hw/virtio/virtio-access.h"
28 #define VIRTIO_NET_VM_VERSION 11
30 #define MAC_TABLE_ENTRIES 64
31 #define MAX_VLAN (1 << 12) /* Per 802.1Q definition */
34 * Calculate the number of bytes up to and including the given 'field' of
35 * 'container'.
37 #define endof(container, field) \
38 (offsetof(container, field) + sizeof(((container *)0)->field))
40 typedef struct VirtIOFeature {
41 uint32_t flags;
42 size_t end;
43 } VirtIOFeature;
45 static VirtIOFeature feature_sizes[] = {
46 {.flags = 1 << VIRTIO_NET_F_MAC,
47 .end = endof(struct virtio_net_config, mac)},
48 {.flags = 1 << VIRTIO_NET_F_STATUS,
49 .end = endof(struct virtio_net_config, status)},
50 {.flags = 1 << VIRTIO_NET_F_MQ,
51 .end = endof(struct virtio_net_config, max_virtqueue_pairs)},
55 static VirtIONetQueue *virtio_net_get_subqueue(NetClientState *nc)
57 VirtIONet *n = qemu_get_nic_opaque(nc);
59 return &n->vqs[nc->queue_index];
62 static int vq2q(int queue_index)
64 return queue_index / 2;
67 /* TODO
68 * - we could suppress RX interrupt if we were so inclined.
71 static void virtio_net_get_config(VirtIODevice *vdev, uint8_t *config)
73 VirtIONet *n = VIRTIO_NET(vdev);
74 struct virtio_net_config netcfg;
76 virtio_stw_p(vdev, &netcfg.status, n->status);
77 virtio_stw_p(vdev, &netcfg.max_virtqueue_pairs, n->max_queues);
78 memcpy(netcfg.mac, n->mac, ETH_ALEN);
79 memcpy(config, &netcfg, n->config_size);
82 static void virtio_net_set_config(VirtIODevice *vdev, const uint8_t *config)
84 VirtIONet *n = VIRTIO_NET(vdev);
85 struct virtio_net_config netcfg = {};
87 memcpy(&netcfg, config, n->config_size);
89 if (!virtio_vdev_has_feature(vdev, VIRTIO_NET_F_CTRL_MAC_ADDR) &&
90 !virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1) &&
91 memcmp(netcfg.mac, n->mac, ETH_ALEN)) {
92 memcpy(n->mac, netcfg.mac, ETH_ALEN);
93 qemu_format_nic_info_str(qemu_get_queue(n->nic), n->mac);
97 static bool virtio_net_started(VirtIONet *n, uint8_t status)
99 VirtIODevice *vdev = VIRTIO_DEVICE(n);
100 return (status & VIRTIO_CONFIG_S_DRIVER_OK) &&
101 (n->status & VIRTIO_NET_S_LINK_UP) && vdev->vm_running;
104 static void virtio_net_announce_timer(void *opaque)
106 VirtIONet *n = opaque;
107 VirtIODevice *vdev = VIRTIO_DEVICE(n);
109 n->announce_counter--;
110 n->status |= VIRTIO_NET_S_ANNOUNCE;
111 virtio_notify_config(vdev);
114 static void virtio_net_vhost_status(VirtIONet *n, uint8_t status)
116 VirtIODevice *vdev = VIRTIO_DEVICE(n);
117 NetClientState *nc = qemu_get_queue(n->nic);
118 int queues = n->multiqueue ? n->max_queues : 1;
120 if (!get_vhost_net(nc->peer)) {
121 return;
124 if ((virtio_net_started(n, status) && !nc->peer->link_down) ==
125 !!n->vhost_started) {
126 return;
128 if (!n->vhost_started) {
129 int r, i;
131 /* Any packets outstanding? Purge them to avoid touching rings
132 * when vhost is running.
134 for (i = 0; i < queues; i++) {
135 NetClientState *qnc = qemu_get_subqueue(n->nic, i);
137 /* Purge both directions: TX and RX. */
138 qemu_net_queue_purge(qnc->peer->incoming_queue, qnc);
139 qemu_net_queue_purge(qnc->incoming_queue, qnc->peer);
142 n->vhost_started = 1;
143 r = vhost_net_start(vdev, n->nic->ncs, queues);
144 if (r < 0) {
145 error_report("unable to start vhost net: %d: "
146 "falling back on userspace virtio", -r);
147 n->vhost_started = 0;
149 } else {
150 vhost_net_stop(vdev, n->nic->ncs, queues);
151 n->vhost_started = 0;
155 static void virtio_net_set_status(struct VirtIODevice *vdev, uint8_t status)
157 VirtIONet *n = VIRTIO_NET(vdev);
158 VirtIONetQueue *q;
159 int i;
160 uint8_t queue_status;
162 virtio_net_vhost_status(n, status);
164 for (i = 0; i < n->max_queues; i++) {
165 NetClientState *ncs = qemu_get_subqueue(n->nic, i);
166 bool queue_started;
167 q = &n->vqs[i];
169 if ((!n->multiqueue && i != 0) || i >= n->curr_queues) {
170 queue_status = 0;
171 } else {
172 queue_status = status;
174 queue_started =
175 virtio_net_started(n, queue_status) && !n->vhost_started;
177 if (queue_started) {
178 qemu_flush_queued_packets(ncs);
181 if (!q->tx_waiting) {
182 continue;
185 if (queue_started) {
186 if (q->tx_timer) {
187 timer_mod(q->tx_timer,
188 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + n->tx_timeout);
189 } else {
190 qemu_bh_schedule(q->tx_bh);
192 } else {
193 if (q->tx_timer) {
194 timer_del(q->tx_timer);
195 } else {
196 qemu_bh_cancel(q->tx_bh);
202 static void virtio_net_set_link_status(NetClientState *nc)
204 VirtIONet *n = qemu_get_nic_opaque(nc);
205 VirtIODevice *vdev = VIRTIO_DEVICE(n);
206 uint16_t old_status = n->status;
208 if (nc->link_down)
209 n->status &= ~VIRTIO_NET_S_LINK_UP;
210 else
211 n->status |= VIRTIO_NET_S_LINK_UP;
213 if (n->status != old_status)
214 virtio_notify_config(vdev);
216 virtio_net_set_status(vdev, vdev->status);
219 static void rxfilter_notify(NetClientState *nc)
221 VirtIONet *n = qemu_get_nic_opaque(nc);
223 if (nc->rxfilter_notify_enabled) {
224 gchar *path = object_get_canonical_path(OBJECT(n->qdev));
225 qapi_event_send_nic_rx_filter_changed(!!n->netclient_name,
226 n->netclient_name, path, &error_abort);
227 g_free(path);
229 /* disable event notification to avoid events flooding */
230 nc->rxfilter_notify_enabled = 0;
234 static intList *get_vlan_table(VirtIONet *n)
236 intList *list, *entry;
237 int i, j;
239 list = NULL;
240 for (i = 0; i < MAX_VLAN >> 5; i++) {
241 for (j = 0; n->vlans[i] && j <= 0x1f; j++) {
242 if (n->vlans[i] & (1U << j)) {
243 entry = g_malloc0(sizeof(*entry));
244 entry->value = (i << 5) + j;
245 entry->next = list;
246 list = entry;
251 return list;
254 static RxFilterInfo *virtio_net_query_rxfilter(NetClientState *nc)
256 VirtIONet *n = qemu_get_nic_opaque(nc);
257 VirtIODevice *vdev = VIRTIO_DEVICE(n);
258 RxFilterInfo *info;
259 strList *str_list, *entry;
260 int i;
262 info = g_malloc0(sizeof(*info));
263 info->name = g_strdup(nc->name);
264 info->promiscuous = n->promisc;
266 if (n->nouni) {
267 info->unicast = RX_STATE_NONE;
268 } else if (n->alluni) {
269 info->unicast = RX_STATE_ALL;
270 } else {
271 info->unicast = RX_STATE_NORMAL;
274 if (n->nomulti) {
275 info->multicast = RX_STATE_NONE;
276 } else if (n->allmulti) {
277 info->multicast = RX_STATE_ALL;
278 } else {
279 info->multicast = RX_STATE_NORMAL;
282 info->broadcast_allowed = n->nobcast;
283 info->multicast_overflow = n->mac_table.multi_overflow;
284 info->unicast_overflow = n->mac_table.uni_overflow;
286 info->main_mac = qemu_mac_strdup_printf(n->mac);
288 str_list = NULL;
289 for (i = 0; i < n->mac_table.first_multi; i++) {
290 entry = g_malloc0(sizeof(*entry));
291 entry->value = qemu_mac_strdup_printf(n->mac_table.macs + i * ETH_ALEN);
292 entry->next = str_list;
293 str_list = entry;
295 info->unicast_table = str_list;
297 str_list = NULL;
298 for (i = n->mac_table.first_multi; i < n->mac_table.in_use; i++) {
299 entry = g_malloc0(sizeof(*entry));
300 entry->value = qemu_mac_strdup_printf(n->mac_table.macs + i * ETH_ALEN);
301 entry->next = str_list;
302 str_list = entry;
304 info->multicast_table = str_list;
305 info->vlan_table = get_vlan_table(n);
307 if (!virtio_vdev_has_feature(vdev, VIRTIO_NET_F_CTRL_VLAN)) {
308 info->vlan = RX_STATE_ALL;
309 } else if (!info->vlan_table) {
310 info->vlan = RX_STATE_NONE;
311 } else {
312 info->vlan = RX_STATE_NORMAL;
315 /* enable event notification after query */
316 nc->rxfilter_notify_enabled = 1;
318 return info;
321 static void virtio_net_reset(VirtIODevice *vdev)
323 VirtIONet *n = VIRTIO_NET(vdev);
325 /* Reset back to compatibility mode */
326 n->promisc = 1;
327 n->allmulti = 0;
328 n->alluni = 0;
329 n->nomulti = 0;
330 n->nouni = 0;
331 n->nobcast = 0;
332 /* multiqueue is disabled by default */
333 n->curr_queues = 1;
334 timer_del(n->announce_timer);
335 n->announce_counter = 0;
336 n->status &= ~VIRTIO_NET_S_ANNOUNCE;
338 /* Flush any MAC and VLAN filter table state */
339 n->mac_table.in_use = 0;
340 n->mac_table.first_multi = 0;
341 n->mac_table.multi_overflow = 0;
342 n->mac_table.uni_overflow = 0;
343 memset(n->mac_table.macs, 0, MAC_TABLE_ENTRIES * ETH_ALEN);
344 memcpy(&n->mac[0], &n->nic->conf->macaddr, sizeof(n->mac));
345 qemu_format_nic_info_str(qemu_get_queue(n->nic), n->mac);
346 memset(n->vlans, 0, MAX_VLAN >> 3);
349 static void peer_test_vnet_hdr(VirtIONet *n)
351 NetClientState *nc = qemu_get_queue(n->nic);
352 if (!nc->peer) {
353 return;
356 n->has_vnet_hdr = qemu_has_vnet_hdr(nc->peer);
359 static int peer_has_vnet_hdr(VirtIONet *n)
361 return n->has_vnet_hdr;
364 static int peer_has_ufo(VirtIONet *n)
366 if (!peer_has_vnet_hdr(n))
367 return 0;
369 n->has_ufo = qemu_has_ufo(qemu_get_queue(n->nic)->peer);
371 return n->has_ufo;
374 static void virtio_net_set_mrg_rx_bufs(VirtIONet *n, int mergeable_rx_bufs,
375 int version_1)
377 int i;
378 NetClientState *nc;
380 n->mergeable_rx_bufs = mergeable_rx_bufs;
382 if (version_1) {
383 n->guest_hdr_len = sizeof(struct virtio_net_hdr_mrg_rxbuf);
384 } else {
385 n->guest_hdr_len = n->mergeable_rx_bufs ?
386 sizeof(struct virtio_net_hdr_mrg_rxbuf) :
387 sizeof(struct virtio_net_hdr);
390 for (i = 0; i < n->max_queues; i++) {
391 nc = qemu_get_subqueue(n->nic, i);
393 if (peer_has_vnet_hdr(n) &&
394 qemu_has_vnet_hdr_len(nc->peer, n->guest_hdr_len)) {
395 qemu_set_vnet_hdr_len(nc->peer, n->guest_hdr_len);
396 n->host_hdr_len = n->guest_hdr_len;
401 static int peer_attach(VirtIONet *n, int index)
403 NetClientState *nc = qemu_get_subqueue(n->nic, index);
405 if (!nc->peer) {
406 return 0;
409 if (nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_VHOST_USER) {
410 vhost_set_vring_enable(nc->peer, 1);
413 if (nc->peer->info->type != NET_CLIENT_OPTIONS_KIND_TAP) {
414 return 0;
417 return tap_enable(nc->peer);
420 static int peer_detach(VirtIONet *n, int index)
422 NetClientState *nc = qemu_get_subqueue(n->nic, index);
424 if (!nc->peer) {
425 return 0;
428 if (nc->peer->info->type == NET_CLIENT_OPTIONS_KIND_VHOST_USER) {
429 vhost_set_vring_enable(nc->peer, 0);
432 if (nc->peer->info->type != NET_CLIENT_OPTIONS_KIND_TAP) {
433 return 0;
436 return tap_disable(nc->peer);
439 static void virtio_net_set_queues(VirtIONet *n)
441 int i;
442 int r;
444 for (i = 0; i < n->max_queues; i++) {
445 if (i < n->curr_queues) {
446 r = peer_attach(n, i);
447 assert(!r);
448 } else {
449 r = peer_detach(n, i);
450 assert(!r);
455 static void virtio_net_set_multiqueue(VirtIONet *n, int multiqueue);
457 static uint64_t virtio_net_get_features(VirtIODevice *vdev, uint64_t features,
458 Error **errp)
460 VirtIONet *n = VIRTIO_NET(vdev);
461 NetClientState *nc = qemu_get_queue(n->nic);
463 /* Firstly sync all virtio-net possible supported features */
464 features |= n->host_features;
466 virtio_add_feature(&features, VIRTIO_NET_F_MAC);
468 if (!peer_has_vnet_hdr(n)) {
469 virtio_clear_feature(&features, VIRTIO_NET_F_CSUM);
470 virtio_clear_feature(&features, VIRTIO_NET_F_HOST_TSO4);
471 virtio_clear_feature(&features, VIRTIO_NET_F_HOST_TSO6);
472 virtio_clear_feature(&features, VIRTIO_NET_F_HOST_ECN);
474 virtio_clear_feature(&features, VIRTIO_NET_F_GUEST_CSUM);
475 virtio_clear_feature(&features, VIRTIO_NET_F_GUEST_TSO4);
476 virtio_clear_feature(&features, VIRTIO_NET_F_GUEST_TSO6);
477 virtio_clear_feature(&features, VIRTIO_NET_F_GUEST_ECN);
480 if (!peer_has_vnet_hdr(n) || !peer_has_ufo(n)) {
481 virtio_clear_feature(&features, VIRTIO_NET_F_GUEST_UFO);
482 virtio_clear_feature(&features, VIRTIO_NET_F_HOST_UFO);
485 if (!get_vhost_net(nc->peer)) {
486 return features;
488 return vhost_net_get_features(get_vhost_net(nc->peer), features);
491 static uint64_t virtio_net_bad_features(VirtIODevice *vdev)
493 uint64_t features = 0;
495 /* Linux kernel 2.6.25. It understood MAC (as everyone must),
496 * but also these: */
497 virtio_add_feature(&features, VIRTIO_NET_F_MAC);
498 virtio_add_feature(&features, VIRTIO_NET_F_CSUM);
499 virtio_add_feature(&features, VIRTIO_NET_F_HOST_TSO4);
500 virtio_add_feature(&features, VIRTIO_NET_F_HOST_TSO6);
501 virtio_add_feature(&features, VIRTIO_NET_F_HOST_ECN);
503 return features;
506 static void virtio_net_apply_guest_offloads(VirtIONet *n)
508 qemu_set_offload(qemu_get_queue(n->nic)->peer,
509 !!(n->curr_guest_offloads & (1ULL << VIRTIO_NET_F_GUEST_CSUM)),
510 !!(n->curr_guest_offloads & (1ULL << VIRTIO_NET_F_GUEST_TSO4)),
511 !!(n->curr_guest_offloads & (1ULL << VIRTIO_NET_F_GUEST_TSO6)),
512 !!(n->curr_guest_offloads & (1ULL << VIRTIO_NET_F_GUEST_ECN)),
513 !!(n->curr_guest_offloads & (1ULL << VIRTIO_NET_F_GUEST_UFO)));
516 static uint64_t virtio_net_guest_offloads_by_features(uint32_t features)
518 static const uint64_t guest_offloads_mask =
519 (1ULL << VIRTIO_NET_F_GUEST_CSUM) |
520 (1ULL << VIRTIO_NET_F_GUEST_TSO4) |
521 (1ULL << VIRTIO_NET_F_GUEST_TSO6) |
522 (1ULL << VIRTIO_NET_F_GUEST_ECN) |
523 (1ULL << VIRTIO_NET_F_GUEST_UFO);
525 return guest_offloads_mask & features;
528 static inline uint64_t virtio_net_supported_guest_offloads(VirtIONet *n)
530 VirtIODevice *vdev = VIRTIO_DEVICE(n);
531 return virtio_net_guest_offloads_by_features(vdev->guest_features);
534 static void virtio_net_set_features(VirtIODevice *vdev, uint64_t features)
536 VirtIONet *n = VIRTIO_NET(vdev);
537 int i;
539 virtio_net_set_multiqueue(n,
540 virtio_has_feature(features, VIRTIO_NET_F_MQ));
542 virtio_net_set_mrg_rx_bufs(n,
543 virtio_has_feature(features,
544 VIRTIO_NET_F_MRG_RXBUF),
545 virtio_has_feature(features,
546 VIRTIO_F_VERSION_1));
548 if (n->has_vnet_hdr) {
549 n->curr_guest_offloads =
550 virtio_net_guest_offloads_by_features(features);
551 virtio_net_apply_guest_offloads(n);
554 for (i = 0; i < n->max_queues; i++) {
555 NetClientState *nc = qemu_get_subqueue(n->nic, i);
557 if (!get_vhost_net(nc->peer)) {
558 continue;
560 vhost_net_ack_features(get_vhost_net(nc->peer), features);
563 if (virtio_has_feature(features, VIRTIO_NET_F_CTRL_VLAN)) {
564 memset(n->vlans, 0, MAX_VLAN >> 3);
565 } else {
566 memset(n->vlans, 0xff, MAX_VLAN >> 3);
570 static int virtio_net_handle_rx_mode(VirtIONet *n, uint8_t cmd,
571 struct iovec *iov, unsigned int iov_cnt)
573 uint8_t on;
574 size_t s;
575 NetClientState *nc = qemu_get_queue(n->nic);
577 s = iov_to_buf(iov, iov_cnt, 0, &on, sizeof(on));
578 if (s != sizeof(on)) {
579 return VIRTIO_NET_ERR;
582 if (cmd == VIRTIO_NET_CTRL_RX_PROMISC) {
583 n->promisc = on;
584 } else if (cmd == VIRTIO_NET_CTRL_RX_ALLMULTI) {
585 n->allmulti = on;
586 } else if (cmd == VIRTIO_NET_CTRL_RX_ALLUNI) {
587 n->alluni = on;
588 } else if (cmd == VIRTIO_NET_CTRL_RX_NOMULTI) {
589 n->nomulti = on;
590 } else if (cmd == VIRTIO_NET_CTRL_RX_NOUNI) {
591 n->nouni = on;
592 } else if (cmd == VIRTIO_NET_CTRL_RX_NOBCAST) {
593 n->nobcast = on;
594 } else {
595 return VIRTIO_NET_ERR;
598 rxfilter_notify(nc);
600 return VIRTIO_NET_OK;
603 static int virtio_net_handle_offloads(VirtIONet *n, uint8_t cmd,
604 struct iovec *iov, unsigned int iov_cnt)
606 VirtIODevice *vdev = VIRTIO_DEVICE(n);
607 uint64_t offloads;
608 size_t s;
610 if (!virtio_vdev_has_feature(vdev, VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)) {
611 return VIRTIO_NET_ERR;
614 s = iov_to_buf(iov, iov_cnt, 0, &offloads, sizeof(offloads));
615 if (s != sizeof(offloads)) {
616 return VIRTIO_NET_ERR;
619 if (cmd == VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET) {
620 uint64_t supported_offloads;
622 if (!n->has_vnet_hdr) {
623 return VIRTIO_NET_ERR;
626 supported_offloads = virtio_net_supported_guest_offloads(n);
627 if (offloads & ~supported_offloads) {
628 return VIRTIO_NET_ERR;
631 n->curr_guest_offloads = offloads;
632 virtio_net_apply_guest_offloads(n);
634 return VIRTIO_NET_OK;
635 } else {
636 return VIRTIO_NET_ERR;
640 static int virtio_net_handle_mac(VirtIONet *n, uint8_t cmd,
641 struct iovec *iov, unsigned int iov_cnt)
643 VirtIODevice *vdev = VIRTIO_DEVICE(n);
644 struct virtio_net_ctrl_mac mac_data;
645 size_t s;
646 NetClientState *nc = qemu_get_queue(n->nic);
648 if (cmd == VIRTIO_NET_CTRL_MAC_ADDR_SET) {
649 if (iov_size(iov, iov_cnt) != sizeof(n->mac)) {
650 return VIRTIO_NET_ERR;
652 s = iov_to_buf(iov, iov_cnt, 0, &n->mac, sizeof(n->mac));
653 assert(s == sizeof(n->mac));
654 qemu_format_nic_info_str(qemu_get_queue(n->nic), n->mac);
655 rxfilter_notify(nc);
657 return VIRTIO_NET_OK;
660 if (cmd != VIRTIO_NET_CTRL_MAC_TABLE_SET) {
661 return VIRTIO_NET_ERR;
664 int in_use = 0;
665 int first_multi = 0;
666 uint8_t uni_overflow = 0;
667 uint8_t multi_overflow = 0;
668 uint8_t *macs = g_malloc0(MAC_TABLE_ENTRIES * ETH_ALEN);
670 s = iov_to_buf(iov, iov_cnt, 0, &mac_data.entries,
671 sizeof(mac_data.entries));
672 mac_data.entries = virtio_ldl_p(vdev, &mac_data.entries);
673 if (s != sizeof(mac_data.entries)) {
674 goto error;
676 iov_discard_front(&iov, &iov_cnt, s);
678 if (mac_data.entries * ETH_ALEN > iov_size(iov, iov_cnt)) {
679 goto error;
682 if (mac_data.entries <= MAC_TABLE_ENTRIES) {
683 s = iov_to_buf(iov, iov_cnt, 0, macs,
684 mac_data.entries * ETH_ALEN);
685 if (s != mac_data.entries * ETH_ALEN) {
686 goto error;
688 in_use += mac_data.entries;
689 } else {
690 uni_overflow = 1;
693 iov_discard_front(&iov, &iov_cnt, mac_data.entries * ETH_ALEN);
695 first_multi = in_use;
697 s = iov_to_buf(iov, iov_cnt, 0, &mac_data.entries,
698 sizeof(mac_data.entries));
699 mac_data.entries = virtio_ldl_p(vdev, &mac_data.entries);
700 if (s != sizeof(mac_data.entries)) {
701 goto error;
704 iov_discard_front(&iov, &iov_cnt, s);
706 if (mac_data.entries * ETH_ALEN != iov_size(iov, iov_cnt)) {
707 goto error;
710 if (mac_data.entries <= MAC_TABLE_ENTRIES - in_use) {
711 s = iov_to_buf(iov, iov_cnt, 0, &macs[in_use * ETH_ALEN],
712 mac_data.entries * ETH_ALEN);
713 if (s != mac_data.entries * ETH_ALEN) {
714 goto error;
716 in_use += mac_data.entries;
717 } else {
718 multi_overflow = 1;
721 n->mac_table.in_use = in_use;
722 n->mac_table.first_multi = first_multi;
723 n->mac_table.uni_overflow = uni_overflow;
724 n->mac_table.multi_overflow = multi_overflow;
725 memcpy(n->mac_table.macs, macs, MAC_TABLE_ENTRIES * ETH_ALEN);
726 g_free(macs);
727 rxfilter_notify(nc);
729 return VIRTIO_NET_OK;
731 error:
732 g_free(macs);
733 return VIRTIO_NET_ERR;
736 static int virtio_net_handle_vlan_table(VirtIONet *n, uint8_t cmd,
737 struct iovec *iov, unsigned int iov_cnt)
739 VirtIODevice *vdev = VIRTIO_DEVICE(n);
740 uint16_t vid;
741 size_t s;
742 NetClientState *nc = qemu_get_queue(n->nic);
744 s = iov_to_buf(iov, iov_cnt, 0, &vid, sizeof(vid));
745 vid = virtio_lduw_p(vdev, &vid);
746 if (s != sizeof(vid)) {
747 return VIRTIO_NET_ERR;
750 if (vid >= MAX_VLAN)
751 return VIRTIO_NET_ERR;
753 if (cmd == VIRTIO_NET_CTRL_VLAN_ADD)
754 n->vlans[vid >> 5] |= (1U << (vid & 0x1f));
755 else if (cmd == VIRTIO_NET_CTRL_VLAN_DEL)
756 n->vlans[vid >> 5] &= ~(1U << (vid & 0x1f));
757 else
758 return VIRTIO_NET_ERR;
760 rxfilter_notify(nc);
762 return VIRTIO_NET_OK;
765 static int virtio_net_handle_announce(VirtIONet *n, uint8_t cmd,
766 struct iovec *iov, unsigned int iov_cnt)
768 if (cmd == VIRTIO_NET_CTRL_ANNOUNCE_ACK &&
769 n->status & VIRTIO_NET_S_ANNOUNCE) {
770 n->status &= ~VIRTIO_NET_S_ANNOUNCE;
771 if (n->announce_counter) {
772 timer_mod(n->announce_timer,
773 qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) +
774 self_announce_delay(n->announce_counter));
776 return VIRTIO_NET_OK;
777 } else {
778 return VIRTIO_NET_ERR;
782 static int virtio_net_handle_mq(VirtIONet *n, uint8_t cmd,
783 struct iovec *iov, unsigned int iov_cnt)
785 VirtIODevice *vdev = VIRTIO_DEVICE(n);
786 struct virtio_net_ctrl_mq mq;
787 size_t s;
788 uint16_t queues;
790 s = iov_to_buf(iov, iov_cnt, 0, &mq, sizeof(mq));
791 if (s != sizeof(mq)) {
792 return VIRTIO_NET_ERR;
795 if (cmd != VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET) {
796 return VIRTIO_NET_ERR;
799 queues = virtio_lduw_p(vdev, &mq.virtqueue_pairs);
801 if (queues < VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN ||
802 queues > VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX ||
803 queues > n->max_queues ||
804 !n->multiqueue) {
805 return VIRTIO_NET_ERR;
808 n->curr_queues = queues;
809 /* stop the backend before changing the number of queues to avoid handling a
810 * disabled queue */
811 virtio_net_set_status(vdev, vdev->status);
812 virtio_net_set_queues(n);
814 return VIRTIO_NET_OK;
816 static void virtio_net_handle_ctrl(VirtIODevice *vdev, VirtQueue *vq)
818 VirtIONet *n = VIRTIO_NET(vdev);
819 struct virtio_net_ctrl_hdr ctrl;
820 virtio_net_ctrl_ack status = VIRTIO_NET_ERR;
821 VirtQueueElement elem;
822 size_t s;
823 struct iovec *iov, *iov2;
824 unsigned int iov_cnt;
826 while (virtqueue_pop(vq, &elem)) {
827 if (iov_size(elem.in_sg, elem.in_num) < sizeof(status) ||
828 iov_size(elem.out_sg, elem.out_num) < sizeof(ctrl)) {
829 error_report("virtio-net ctrl missing headers");
830 exit(1);
833 iov_cnt = elem.out_num;
834 iov2 = iov = g_memdup(elem.out_sg, sizeof(struct iovec) * elem.out_num);
835 s = iov_to_buf(iov, iov_cnt, 0, &ctrl, sizeof(ctrl));
836 iov_discard_front(&iov, &iov_cnt, sizeof(ctrl));
837 if (s != sizeof(ctrl)) {
838 status = VIRTIO_NET_ERR;
839 } else if (ctrl.class == VIRTIO_NET_CTRL_RX) {
840 status = virtio_net_handle_rx_mode(n, ctrl.cmd, iov, iov_cnt);
841 } else if (ctrl.class == VIRTIO_NET_CTRL_MAC) {
842 status = virtio_net_handle_mac(n, ctrl.cmd, iov, iov_cnt);
843 } else if (ctrl.class == VIRTIO_NET_CTRL_VLAN) {
844 status = virtio_net_handle_vlan_table(n, ctrl.cmd, iov, iov_cnt);
845 } else if (ctrl.class == VIRTIO_NET_CTRL_ANNOUNCE) {
846 status = virtio_net_handle_announce(n, ctrl.cmd, iov, iov_cnt);
847 } else if (ctrl.class == VIRTIO_NET_CTRL_MQ) {
848 status = virtio_net_handle_mq(n, ctrl.cmd, iov, iov_cnt);
849 } else if (ctrl.class == VIRTIO_NET_CTRL_GUEST_OFFLOADS) {
850 status = virtio_net_handle_offloads(n, ctrl.cmd, iov, iov_cnt);
853 s = iov_from_buf(elem.in_sg, elem.in_num, 0, &status, sizeof(status));
854 assert(s == sizeof(status));
856 virtqueue_push(vq, &elem, sizeof(status));
857 virtio_notify(vdev, vq);
858 g_free(iov2);
862 /* RX */
864 static void virtio_net_handle_rx(VirtIODevice *vdev, VirtQueue *vq)
866 VirtIONet *n = VIRTIO_NET(vdev);
867 int queue_index = vq2q(virtio_get_queue_index(vq));
869 qemu_flush_queued_packets(qemu_get_subqueue(n->nic, queue_index));
872 static int virtio_net_can_receive(NetClientState *nc)
874 VirtIONet *n = qemu_get_nic_opaque(nc);
875 VirtIODevice *vdev = VIRTIO_DEVICE(n);
876 VirtIONetQueue *q = virtio_net_get_subqueue(nc);
878 if (!vdev->vm_running) {
879 return 0;
882 if (nc->queue_index >= n->curr_queues) {
883 return 0;
886 if (!virtio_queue_ready(q->rx_vq) ||
887 !(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK)) {
888 return 0;
891 return 1;
894 static int virtio_net_has_buffers(VirtIONetQueue *q, int bufsize)
896 VirtIONet *n = q->n;
897 if (virtio_queue_empty(q->rx_vq) ||
898 (n->mergeable_rx_bufs &&
899 !virtqueue_avail_bytes(q->rx_vq, bufsize, 0))) {
900 virtio_queue_set_notification(q->rx_vq, 1);
902 /* To avoid a race condition where the guest has made some buffers
903 * available after the above check but before notification was
904 * enabled, check for available buffers again.
906 if (virtio_queue_empty(q->rx_vq) ||
907 (n->mergeable_rx_bufs &&
908 !virtqueue_avail_bytes(q->rx_vq, bufsize, 0))) {
909 return 0;
913 virtio_queue_set_notification(q->rx_vq, 0);
914 return 1;
917 static void virtio_net_hdr_swap(VirtIODevice *vdev, struct virtio_net_hdr *hdr)
919 virtio_tswap16s(vdev, &hdr->hdr_len);
920 virtio_tswap16s(vdev, &hdr->gso_size);
921 virtio_tswap16s(vdev, &hdr->csum_start);
922 virtio_tswap16s(vdev, &hdr->csum_offset);
925 /* dhclient uses AF_PACKET but doesn't pass auxdata to the kernel so
926 * it never finds out that the packets don't have valid checksums. This
927 * causes dhclient to get upset. Fedora's carried a patch for ages to
928 * fix this with Xen but it hasn't appeared in an upstream release of
929 * dhclient yet.
931 * To avoid breaking existing guests, we catch udp packets and add
932 * checksums. This is terrible but it's better than hacking the guest
933 * kernels.
935 * N.B. if we introduce a zero-copy API, this operation is no longer free so
936 * we should provide a mechanism to disable it to avoid polluting the host
937 * cache.
939 static void work_around_broken_dhclient(struct virtio_net_hdr *hdr,
940 uint8_t *buf, size_t size)
942 if ((hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM) && /* missing csum */
943 (size > 27 && size < 1500) && /* normal sized MTU */
944 (buf[12] == 0x08 && buf[13] == 0x00) && /* ethertype == IPv4 */
945 (buf[23] == 17) && /* ip.protocol == UDP */
946 (buf[34] == 0 && buf[35] == 67)) { /* udp.srcport == bootps */
947 net_checksum_calculate(buf, size);
948 hdr->flags &= ~VIRTIO_NET_HDR_F_NEEDS_CSUM;
952 static void receive_header(VirtIONet *n, const struct iovec *iov, int iov_cnt,
953 const void *buf, size_t size)
955 if (n->has_vnet_hdr) {
956 /* FIXME this cast is evil */
957 void *wbuf = (void *)buf;
958 work_around_broken_dhclient(wbuf, wbuf + n->host_hdr_len,
959 size - n->host_hdr_len);
960 virtio_net_hdr_swap(VIRTIO_DEVICE(n), wbuf);
961 iov_from_buf(iov, iov_cnt, 0, buf, sizeof(struct virtio_net_hdr));
962 } else {
963 struct virtio_net_hdr hdr = {
964 .flags = 0,
965 .gso_type = VIRTIO_NET_HDR_GSO_NONE
967 iov_from_buf(iov, iov_cnt, 0, &hdr, sizeof hdr);
971 static int receive_filter(VirtIONet *n, const uint8_t *buf, int size)
973 static const uint8_t bcast[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
974 static const uint8_t vlan[] = {0x81, 0x00};
975 uint8_t *ptr = (uint8_t *)buf;
976 int i;
978 if (n->promisc)
979 return 1;
981 ptr += n->host_hdr_len;
983 if (!memcmp(&ptr[12], vlan, sizeof(vlan))) {
984 int vid = be16_to_cpup((uint16_t *)(ptr + 14)) & 0xfff;
985 if (!(n->vlans[vid >> 5] & (1U << (vid & 0x1f))))
986 return 0;
989 if (ptr[0] & 1) { // multicast
990 if (!memcmp(ptr, bcast, sizeof(bcast))) {
991 return !n->nobcast;
992 } else if (n->nomulti) {
993 return 0;
994 } else if (n->allmulti || n->mac_table.multi_overflow) {
995 return 1;
998 for (i = n->mac_table.first_multi; i < n->mac_table.in_use; i++) {
999 if (!memcmp(ptr, &n->mac_table.macs[i * ETH_ALEN], ETH_ALEN)) {
1000 return 1;
1003 } else { // unicast
1004 if (n->nouni) {
1005 return 0;
1006 } else if (n->alluni || n->mac_table.uni_overflow) {
1007 return 1;
1008 } else if (!memcmp(ptr, n->mac, ETH_ALEN)) {
1009 return 1;
1012 for (i = 0; i < n->mac_table.first_multi; i++) {
1013 if (!memcmp(ptr, &n->mac_table.macs[i * ETH_ALEN], ETH_ALEN)) {
1014 return 1;
1019 return 0;
1022 static ssize_t virtio_net_receive(NetClientState *nc, const uint8_t *buf, size_t size)
1024 VirtIONet *n = qemu_get_nic_opaque(nc);
1025 VirtIONetQueue *q = virtio_net_get_subqueue(nc);
1026 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1027 struct iovec mhdr_sg[VIRTQUEUE_MAX_SIZE];
1028 struct virtio_net_hdr_mrg_rxbuf mhdr;
1029 unsigned mhdr_cnt = 0;
1030 size_t offset, i, guest_offset;
1032 if (!virtio_net_can_receive(nc)) {
1033 return -1;
1036 /* hdr_len refers to the header we supply to the guest */
1037 if (!virtio_net_has_buffers(q, size + n->guest_hdr_len - n->host_hdr_len)) {
1038 return 0;
1041 if (!receive_filter(n, buf, size))
1042 return size;
1044 offset = i = 0;
1046 while (offset < size) {
1047 VirtQueueElement elem;
1048 int len, total;
1049 const struct iovec *sg = elem.in_sg;
1051 total = 0;
1053 if (virtqueue_pop(q->rx_vq, &elem) == 0) {
1054 if (i == 0)
1055 return -1;
1056 error_report("virtio-net unexpected empty queue: "
1057 "i %zd mergeable %d offset %zd, size %zd, "
1058 "guest hdr len %zd, host hdr len %zd "
1059 "guest features 0x%" PRIx64,
1060 i, n->mergeable_rx_bufs, offset, size,
1061 n->guest_hdr_len, n->host_hdr_len,
1062 vdev->guest_features);
1063 exit(1);
1066 if (elem.in_num < 1) {
1067 error_report("virtio-net receive queue contains no in buffers");
1068 exit(1);
1071 if (i == 0) {
1072 assert(offset == 0);
1073 if (n->mergeable_rx_bufs) {
1074 mhdr_cnt = iov_copy(mhdr_sg, ARRAY_SIZE(mhdr_sg),
1075 sg, elem.in_num,
1076 offsetof(typeof(mhdr), num_buffers),
1077 sizeof(mhdr.num_buffers));
1080 receive_header(n, sg, elem.in_num, buf, size);
1081 offset = n->host_hdr_len;
1082 total += n->guest_hdr_len;
1083 guest_offset = n->guest_hdr_len;
1084 } else {
1085 guest_offset = 0;
1088 /* copy in packet. ugh */
1089 len = iov_from_buf(sg, elem.in_num, guest_offset,
1090 buf + offset, size - offset);
1091 total += len;
1092 offset += len;
1093 /* If buffers can't be merged, at this point we
1094 * must have consumed the complete packet.
1095 * Otherwise, drop it. */
1096 if (!n->mergeable_rx_bufs && offset < size) {
1097 virtqueue_discard(q->rx_vq, &elem, total);
1098 return size;
1101 /* signal other side */
1102 virtqueue_fill(q->rx_vq, &elem, total, i++);
1105 if (mhdr_cnt) {
1106 virtio_stw_p(vdev, &mhdr.num_buffers, i);
1107 iov_from_buf(mhdr_sg, mhdr_cnt,
1109 &mhdr.num_buffers, sizeof mhdr.num_buffers);
1112 virtqueue_flush(q->rx_vq, i);
1113 virtio_notify(vdev, q->rx_vq);
1115 return size;
1118 static int32_t virtio_net_flush_tx(VirtIONetQueue *q);
1120 static void virtio_net_tx_complete(NetClientState *nc, ssize_t len)
1122 VirtIONet *n = qemu_get_nic_opaque(nc);
1123 VirtIONetQueue *q = virtio_net_get_subqueue(nc);
1124 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1126 virtqueue_push(q->tx_vq, &q->async_tx.elem, 0);
1127 virtio_notify(vdev, q->tx_vq);
1129 q->async_tx.elem.out_num = 0;
1131 virtio_queue_set_notification(q->tx_vq, 1);
1132 virtio_net_flush_tx(q);
1135 /* TX */
1136 static int32_t virtio_net_flush_tx(VirtIONetQueue *q)
1138 VirtIONet *n = q->n;
1139 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1140 VirtQueueElement elem;
1141 int32_t num_packets = 0;
1142 int queue_index = vq2q(virtio_get_queue_index(q->tx_vq));
1143 if (!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK)) {
1144 return num_packets;
1147 if (q->async_tx.elem.out_num) {
1148 virtio_queue_set_notification(q->tx_vq, 0);
1149 return num_packets;
1152 while (virtqueue_pop(q->tx_vq, &elem)) {
1153 ssize_t ret;
1154 unsigned int out_num = elem.out_num;
1155 struct iovec *out_sg = &elem.out_sg[0];
1156 struct iovec sg[VIRTQUEUE_MAX_SIZE], sg2[VIRTQUEUE_MAX_SIZE + 1];
1157 struct virtio_net_hdr_mrg_rxbuf mhdr;
1159 if (out_num < 1) {
1160 error_report("virtio-net header not in first element");
1161 exit(1);
1164 if (n->has_vnet_hdr) {
1165 if (iov_to_buf(out_sg, out_num, 0, &mhdr, n->guest_hdr_len) <
1166 n->guest_hdr_len) {
1167 error_report("virtio-net header incorrect");
1168 exit(1);
1170 if (virtio_needs_swap(vdev)) {
1171 virtio_net_hdr_swap(vdev, (void *) &mhdr);
1172 sg2[0].iov_base = &mhdr;
1173 sg2[0].iov_len = n->guest_hdr_len;
1174 out_num = iov_copy(&sg2[1], ARRAY_SIZE(sg2) - 1,
1175 out_sg, out_num,
1176 n->guest_hdr_len, -1);
1177 if (out_num == VIRTQUEUE_MAX_SIZE) {
1178 goto drop;
1180 out_num += 1;
1181 out_sg = sg2;
1185 * If host wants to see the guest header as is, we can
1186 * pass it on unchanged. Otherwise, copy just the parts
1187 * that host is interested in.
1189 assert(n->host_hdr_len <= n->guest_hdr_len);
1190 if (n->host_hdr_len != n->guest_hdr_len) {
1191 unsigned sg_num = iov_copy(sg, ARRAY_SIZE(sg),
1192 out_sg, out_num,
1193 0, n->host_hdr_len);
1194 sg_num += iov_copy(sg + sg_num, ARRAY_SIZE(sg) - sg_num,
1195 out_sg, out_num,
1196 n->guest_hdr_len, -1);
1197 out_num = sg_num;
1198 out_sg = sg;
1201 ret = qemu_sendv_packet_async(qemu_get_subqueue(n->nic, queue_index),
1202 out_sg, out_num, virtio_net_tx_complete);
1203 if (ret == 0) {
1204 virtio_queue_set_notification(q->tx_vq, 0);
1205 q->async_tx.elem = elem;
1206 return -EBUSY;
1209 drop:
1210 virtqueue_push(q->tx_vq, &elem, 0);
1211 virtio_notify(vdev, q->tx_vq);
1213 if (++num_packets >= n->tx_burst) {
1214 break;
1217 return num_packets;
1220 static void virtio_net_handle_tx_timer(VirtIODevice *vdev, VirtQueue *vq)
1222 VirtIONet *n = VIRTIO_NET(vdev);
1223 VirtIONetQueue *q = &n->vqs[vq2q(virtio_get_queue_index(vq))];
1225 /* This happens when device was stopped but VCPU wasn't. */
1226 if (!vdev->vm_running) {
1227 q->tx_waiting = 1;
1228 return;
1231 if (q->tx_waiting) {
1232 virtio_queue_set_notification(vq, 1);
1233 timer_del(q->tx_timer);
1234 q->tx_waiting = 0;
1235 virtio_net_flush_tx(q);
1236 } else {
1237 timer_mod(q->tx_timer,
1238 qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + n->tx_timeout);
1239 q->tx_waiting = 1;
1240 virtio_queue_set_notification(vq, 0);
1244 static void virtio_net_handle_tx_bh(VirtIODevice *vdev, VirtQueue *vq)
1246 VirtIONet *n = VIRTIO_NET(vdev);
1247 VirtIONetQueue *q = &n->vqs[vq2q(virtio_get_queue_index(vq))];
1249 if (unlikely(q->tx_waiting)) {
1250 return;
1252 q->tx_waiting = 1;
1253 /* This happens when device was stopped but VCPU wasn't. */
1254 if (!vdev->vm_running) {
1255 return;
1257 virtio_queue_set_notification(vq, 0);
1258 qemu_bh_schedule(q->tx_bh);
1261 static void virtio_net_tx_timer(void *opaque)
1263 VirtIONetQueue *q = opaque;
1264 VirtIONet *n = q->n;
1265 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1266 /* This happens when device was stopped but BH wasn't. */
1267 if (!vdev->vm_running) {
1268 /* Make sure tx waiting is set, so we'll run when restarted. */
1269 assert(q->tx_waiting);
1270 return;
1273 q->tx_waiting = 0;
1275 /* Just in case the driver is not ready on more */
1276 if (!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK)) {
1277 return;
1280 virtio_queue_set_notification(q->tx_vq, 1);
1281 virtio_net_flush_tx(q);
1284 static void virtio_net_tx_bh(void *opaque)
1286 VirtIONetQueue *q = opaque;
1287 VirtIONet *n = q->n;
1288 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1289 int32_t ret;
1291 /* This happens when device was stopped but BH wasn't. */
1292 if (!vdev->vm_running) {
1293 /* Make sure tx waiting is set, so we'll run when restarted. */
1294 assert(q->tx_waiting);
1295 return;
1298 q->tx_waiting = 0;
1300 /* Just in case the driver is not ready on more */
1301 if (unlikely(!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK))) {
1302 return;
1305 ret = virtio_net_flush_tx(q);
1306 if (ret == -EBUSY) {
1307 return; /* Notification re-enable handled by tx_complete */
1310 /* If we flush a full burst of packets, assume there are
1311 * more coming and immediately reschedule */
1312 if (ret >= n->tx_burst) {
1313 qemu_bh_schedule(q->tx_bh);
1314 q->tx_waiting = 1;
1315 return;
1318 /* If less than a full burst, re-enable notification and flush
1319 * anything that may have come in while we weren't looking. If
1320 * we find something, assume the guest is still active and reschedule */
1321 virtio_queue_set_notification(q->tx_vq, 1);
1322 if (virtio_net_flush_tx(q) > 0) {
1323 virtio_queue_set_notification(q->tx_vq, 0);
1324 qemu_bh_schedule(q->tx_bh);
1325 q->tx_waiting = 1;
1329 static void virtio_net_add_queue(VirtIONet *n, int index)
1331 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1333 n->vqs[index].rx_vq = virtio_add_queue(vdev, 256, virtio_net_handle_rx);
1334 if (n->net_conf.tx && !strcmp(n->net_conf.tx, "timer")) {
1335 n->vqs[index].tx_vq =
1336 virtio_add_queue(vdev, 256, virtio_net_handle_tx_timer);
1337 n->vqs[index].tx_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
1338 virtio_net_tx_timer,
1339 &n->vqs[index]);
1340 } else {
1341 n->vqs[index].tx_vq =
1342 virtio_add_queue(vdev, 256, virtio_net_handle_tx_bh);
1343 n->vqs[index].tx_bh = qemu_bh_new(virtio_net_tx_bh, &n->vqs[index]);
1346 n->vqs[index].tx_waiting = 0;
1347 n->vqs[index].n = n;
1350 static void virtio_net_del_queue(VirtIONet *n, int index)
1352 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1353 VirtIONetQueue *q = &n->vqs[index];
1354 NetClientState *nc = qemu_get_subqueue(n->nic, index);
1356 qemu_purge_queued_packets(nc);
1358 virtio_del_queue(vdev, index * 2);
1359 if (q->tx_timer) {
1360 timer_del(q->tx_timer);
1361 timer_free(q->tx_timer);
1362 } else {
1363 qemu_bh_delete(q->tx_bh);
1365 virtio_del_queue(vdev, index * 2 + 1);
1368 static void virtio_net_change_num_queues(VirtIONet *n, int new_max_queues)
1370 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1371 int old_num_queues = virtio_get_num_queues(vdev);
1372 int new_num_queues = new_max_queues * 2 + 1;
1373 int i;
1375 assert(old_num_queues >= 3);
1376 assert(old_num_queues % 2 == 1);
1378 if (old_num_queues == new_num_queues) {
1379 return;
1383 * We always need to remove and add ctrl vq if
1384 * old_num_queues != new_num_queues. Remove ctrl_vq first,
1385 * and then we only enter one of the following too loops.
1387 virtio_del_queue(vdev, old_num_queues - 1);
1389 for (i = new_num_queues - 1; i < old_num_queues - 1; i += 2) {
1390 /* new_num_queues < old_num_queues */
1391 virtio_net_del_queue(n, i / 2);
1394 for (i = old_num_queues - 1; i < new_num_queues - 1; i += 2) {
1395 /* new_num_queues > old_num_queues */
1396 virtio_net_add_queue(n, i / 2);
1399 /* add ctrl_vq last */
1400 n->ctrl_vq = virtio_add_queue(vdev, 64, virtio_net_handle_ctrl);
1403 static void virtio_net_set_multiqueue(VirtIONet *n, int multiqueue)
1405 int max = multiqueue ? n->max_queues : 1;
1407 n->multiqueue = multiqueue;
1408 virtio_net_change_num_queues(n, max);
1410 virtio_net_set_queues(n);
1413 static void virtio_net_save(QEMUFile *f, void *opaque)
1415 VirtIONet *n = opaque;
1416 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1418 /* At this point, backend must be stopped, otherwise
1419 * it might keep writing to memory. */
1420 assert(!n->vhost_started);
1421 virtio_save(vdev, f);
1424 static void virtio_net_save_device(VirtIODevice *vdev, QEMUFile *f)
1426 VirtIONet *n = VIRTIO_NET(vdev);
1427 int i;
1429 qemu_put_buffer(f, n->mac, ETH_ALEN);
1430 qemu_put_be32(f, n->vqs[0].tx_waiting);
1431 qemu_put_be32(f, n->mergeable_rx_bufs);
1432 qemu_put_be16(f, n->status);
1433 qemu_put_byte(f, n->promisc);
1434 qemu_put_byte(f, n->allmulti);
1435 qemu_put_be32(f, n->mac_table.in_use);
1436 qemu_put_buffer(f, n->mac_table.macs, n->mac_table.in_use * ETH_ALEN);
1437 qemu_put_buffer(f, (uint8_t *)n->vlans, MAX_VLAN >> 3);
1438 qemu_put_be32(f, n->has_vnet_hdr);
1439 qemu_put_byte(f, n->mac_table.multi_overflow);
1440 qemu_put_byte(f, n->mac_table.uni_overflow);
1441 qemu_put_byte(f, n->alluni);
1442 qemu_put_byte(f, n->nomulti);
1443 qemu_put_byte(f, n->nouni);
1444 qemu_put_byte(f, n->nobcast);
1445 qemu_put_byte(f, n->has_ufo);
1446 if (n->max_queues > 1) {
1447 qemu_put_be16(f, n->max_queues);
1448 qemu_put_be16(f, n->curr_queues);
1449 for (i = 1; i < n->curr_queues; i++) {
1450 qemu_put_be32(f, n->vqs[i].tx_waiting);
1454 if (virtio_vdev_has_feature(vdev, VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)) {
1455 qemu_put_be64(f, n->curr_guest_offloads);
1459 static int virtio_net_load(QEMUFile *f, void *opaque, int version_id)
1461 VirtIONet *n = opaque;
1462 VirtIODevice *vdev = VIRTIO_DEVICE(n);
1463 int ret;
1465 if (version_id < 2 || version_id > VIRTIO_NET_VM_VERSION)
1466 return -EINVAL;
1468 ret = virtio_load(vdev, f, version_id);
1469 if (ret) {
1470 return ret;
1473 if (virtio_vdev_has_feature(vdev, VIRTIO_NET_F_CTRL_GUEST_OFFLOADS)) {
1474 n->curr_guest_offloads = qemu_get_be64(f);
1475 } else {
1476 n->curr_guest_offloads = virtio_net_supported_guest_offloads(n);
1479 if (peer_has_vnet_hdr(n)) {
1480 virtio_net_apply_guest_offloads(n);
1483 if (virtio_vdev_has_feature(vdev, VIRTIO_NET_F_GUEST_ANNOUNCE) &&
1484 virtio_vdev_has_feature(vdev, VIRTIO_NET_F_CTRL_VQ)) {
1485 n->announce_counter = SELF_ANNOUNCE_ROUNDS;
1486 timer_mod(n->announce_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL));
1489 return 0;
1492 static int virtio_net_load_device(VirtIODevice *vdev, QEMUFile *f,
1493 int version_id)
1495 VirtIONet *n = VIRTIO_NET(vdev);
1496 int i, link_down;
1498 qemu_get_buffer(f, n->mac, ETH_ALEN);
1499 n->vqs[0].tx_waiting = qemu_get_be32(f);
1501 virtio_net_set_mrg_rx_bufs(n, qemu_get_be32(f),
1502 virtio_vdev_has_feature(vdev,
1503 VIRTIO_F_VERSION_1));
1505 if (version_id >= 3)
1506 n->status = qemu_get_be16(f);
1508 if (version_id >= 4) {
1509 if (version_id < 8) {
1510 n->promisc = qemu_get_be32(f);
1511 n->allmulti = qemu_get_be32(f);
1512 } else {
1513 n->promisc = qemu_get_byte(f);
1514 n->allmulti = qemu_get_byte(f);
1518 if (version_id >= 5) {
1519 n->mac_table.in_use = qemu_get_be32(f);
1520 /* MAC_TABLE_ENTRIES may be different from the saved image */
1521 if (n->mac_table.in_use <= MAC_TABLE_ENTRIES) {
1522 qemu_get_buffer(f, n->mac_table.macs,
1523 n->mac_table.in_use * ETH_ALEN);
1524 } else {
1525 int64_t i;
1527 /* Overflow detected - can happen if source has a larger MAC table.
1528 * We simply set overflow flag so there's no need to maintain the
1529 * table of addresses, discard them all.
1530 * Note: 64 bit math to avoid integer overflow.
1532 for (i = 0; i < (int64_t)n->mac_table.in_use * ETH_ALEN; ++i) {
1533 qemu_get_byte(f);
1535 n->mac_table.multi_overflow = n->mac_table.uni_overflow = 1;
1536 n->mac_table.in_use = 0;
1540 if (version_id >= 6)
1541 qemu_get_buffer(f, (uint8_t *)n->vlans, MAX_VLAN >> 3);
1543 if (version_id >= 7) {
1544 if (qemu_get_be32(f) && !peer_has_vnet_hdr(n)) {
1545 error_report("virtio-net: saved image requires vnet_hdr=on");
1546 return -1;
1550 if (version_id >= 9) {
1551 n->mac_table.multi_overflow = qemu_get_byte(f);
1552 n->mac_table.uni_overflow = qemu_get_byte(f);
1555 if (version_id >= 10) {
1556 n->alluni = qemu_get_byte(f);
1557 n->nomulti = qemu_get_byte(f);
1558 n->nouni = qemu_get_byte(f);
1559 n->nobcast = qemu_get_byte(f);
1562 if (version_id >= 11) {
1563 if (qemu_get_byte(f) && !peer_has_ufo(n)) {
1564 error_report("virtio-net: saved image requires TUN_F_UFO support");
1565 return -1;
1569 if (n->max_queues > 1) {
1570 if (n->max_queues != qemu_get_be16(f)) {
1571 error_report("virtio-net: different max_queues ");
1572 return -1;
1575 n->curr_queues = qemu_get_be16(f);
1576 if (n->curr_queues > n->max_queues) {
1577 error_report("virtio-net: curr_queues %x > max_queues %x",
1578 n->curr_queues, n->max_queues);
1579 return -1;
1581 for (i = 1; i < n->curr_queues; i++) {
1582 n->vqs[i].tx_waiting = qemu_get_be32(f);
1586 virtio_net_set_queues(n);
1588 /* Find the first multicast entry in the saved MAC filter */
1589 for (i = 0; i < n->mac_table.in_use; i++) {
1590 if (n->mac_table.macs[i * ETH_ALEN] & 1) {
1591 break;
1594 n->mac_table.first_multi = i;
1596 /* nc.link_down can't be migrated, so infer link_down according
1597 * to link status bit in n->status */
1598 link_down = (n->status & VIRTIO_NET_S_LINK_UP) == 0;
1599 for (i = 0; i < n->max_queues; i++) {
1600 qemu_get_subqueue(n->nic, i)->link_down = link_down;
1603 return 0;
1606 static NetClientInfo net_virtio_info = {
1607 .type = NET_CLIENT_OPTIONS_KIND_NIC,
1608 .size = sizeof(NICState),
1609 .can_receive = virtio_net_can_receive,
1610 .receive = virtio_net_receive,
1611 .link_status_changed = virtio_net_set_link_status,
1612 .query_rx_filter = virtio_net_query_rxfilter,
1615 static bool virtio_net_guest_notifier_pending(VirtIODevice *vdev, int idx)
1617 VirtIONet *n = VIRTIO_NET(vdev);
1618 NetClientState *nc = qemu_get_subqueue(n->nic, vq2q(idx));
1619 assert(n->vhost_started);
1620 return vhost_net_virtqueue_pending(get_vhost_net(nc->peer), idx);
1623 static void virtio_net_guest_notifier_mask(VirtIODevice *vdev, int idx,
1624 bool mask)
1626 VirtIONet *n = VIRTIO_NET(vdev);
1627 NetClientState *nc = qemu_get_subqueue(n->nic, vq2q(idx));
1628 assert(n->vhost_started);
1629 vhost_net_virtqueue_mask(get_vhost_net(nc->peer),
1630 vdev, idx, mask);
1633 static void virtio_net_set_config_size(VirtIONet *n, uint64_t host_features)
1635 int i, config_size = 0;
1636 virtio_add_feature(&host_features, VIRTIO_NET_F_MAC);
1637 for (i = 0; feature_sizes[i].flags != 0; i++) {
1638 if (host_features & feature_sizes[i].flags) {
1639 config_size = MAX(feature_sizes[i].end, config_size);
1642 n->config_size = config_size;
1645 void virtio_net_set_netclient_name(VirtIONet *n, const char *name,
1646 const char *type)
1649 * The name can be NULL, the netclient name will be type.x.
1651 assert(type != NULL);
1653 g_free(n->netclient_name);
1654 g_free(n->netclient_type);
1655 n->netclient_name = g_strdup(name);
1656 n->netclient_type = g_strdup(type);
1659 static void virtio_net_device_realize(DeviceState *dev, Error **errp)
1661 VirtIODevice *vdev = VIRTIO_DEVICE(dev);
1662 VirtIONet *n = VIRTIO_NET(dev);
1663 NetClientState *nc;
1664 int i;
1666 virtio_net_set_config_size(n, n->host_features);
1667 virtio_init(vdev, "virtio-net", VIRTIO_ID_NET, n->config_size);
1669 n->max_queues = MAX(n->nic_conf.peers.queues, 1);
1670 if (n->max_queues * 2 + 1 > VIRTIO_QUEUE_MAX) {
1671 error_setg(errp, "Invalid number of queues (= %" PRIu32 "), "
1672 "must be a positive integer less than %d.",
1673 n->max_queues, (VIRTIO_QUEUE_MAX - 1) / 2);
1674 virtio_cleanup(vdev);
1675 return;
1677 n->vqs = g_malloc0(sizeof(VirtIONetQueue) * n->max_queues);
1678 n->curr_queues = 1;
1679 n->tx_timeout = n->net_conf.txtimer;
1681 if (n->net_conf.tx && strcmp(n->net_conf.tx, "timer")
1682 && strcmp(n->net_conf.tx, "bh")) {
1683 error_report("virtio-net: "
1684 "Unknown option tx=%s, valid options: \"timer\" \"bh\"",
1685 n->net_conf.tx);
1686 error_report("Defaulting to \"bh\"");
1689 for (i = 0; i < n->max_queues; i++) {
1690 virtio_net_add_queue(n, i);
1693 n->ctrl_vq = virtio_add_queue(vdev, 64, virtio_net_handle_ctrl);
1694 qemu_macaddr_default_if_unset(&n->nic_conf.macaddr);
1695 memcpy(&n->mac[0], &n->nic_conf.macaddr, sizeof(n->mac));
1696 n->status = VIRTIO_NET_S_LINK_UP;
1697 n->announce_timer = timer_new_ms(QEMU_CLOCK_VIRTUAL,
1698 virtio_net_announce_timer, n);
1700 if (n->netclient_type) {
1702 * Happen when virtio_net_set_netclient_name has been called.
1704 n->nic = qemu_new_nic(&net_virtio_info, &n->nic_conf,
1705 n->netclient_type, n->netclient_name, n);
1706 } else {
1707 n->nic = qemu_new_nic(&net_virtio_info, &n->nic_conf,
1708 object_get_typename(OBJECT(dev)), dev->id, n);
1711 peer_test_vnet_hdr(n);
1712 if (peer_has_vnet_hdr(n)) {
1713 for (i = 0; i < n->max_queues; i++) {
1714 qemu_using_vnet_hdr(qemu_get_subqueue(n->nic, i)->peer, true);
1716 n->host_hdr_len = sizeof(struct virtio_net_hdr);
1717 } else {
1718 n->host_hdr_len = 0;
1721 qemu_format_nic_info_str(qemu_get_queue(n->nic), n->nic_conf.macaddr.a);
1723 n->vqs[0].tx_waiting = 0;
1724 n->tx_burst = n->net_conf.txburst;
1725 virtio_net_set_mrg_rx_bufs(n, 0, 0);
1726 n->promisc = 1; /* for compatibility */
1728 n->mac_table.macs = g_malloc0(MAC_TABLE_ENTRIES * ETH_ALEN);
1730 n->vlans = g_malloc0(MAX_VLAN >> 3);
1732 nc = qemu_get_queue(n->nic);
1733 nc->rxfilter_notify_enabled = 1;
1735 n->qdev = dev;
1736 register_savevm(dev, "virtio-net", -1, VIRTIO_NET_VM_VERSION,
1737 virtio_net_save, virtio_net_load, n);
1740 static void virtio_net_device_unrealize(DeviceState *dev, Error **errp)
1742 VirtIODevice *vdev = VIRTIO_DEVICE(dev);
1743 VirtIONet *n = VIRTIO_NET(dev);
1744 int i, max_queues;
1746 /* This will stop vhost backend if appropriate. */
1747 virtio_net_set_status(vdev, 0);
1749 unregister_savevm(dev, "virtio-net", n);
1751 g_free(n->netclient_name);
1752 n->netclient_name = NULL;
1753 g_free(n->netclient_type);
1754 n->netclient_type = NULL;
1756 g_free(n->mac_table.macs);
1757 g_free(n->vlans);
1759 max_queues = n->multiqueue ? n->max_queues : 1;
1760 for (i = 0; i < max_queues; i++) {
1761 virtio_net_del_queue(n, i);
1764 timer_del(n->announce_timer);
1765 timer_free(n->announce_timer);
1766 g_free(n->vqs);
1767 qemu_del_nic(n->nic);
1768 virtio_cleanup(vdev);
1771 static void virtio_net_instance_init(Object *obj)
1773 VirtIONet *n = VIRTIO_NET(obj);
1776 * The default config_size is sizeof(struct virtio_net_config).
1777 * Can be overriden with virtio_net_set_config_size.
1779 n->config_size = sizeof(struct virtio_net_config);
1780 device_add_bootindex_property(obj, &n->nic_conf.bootindex,
1781 "bootindex", "/ethernet-phy@0",
1782 DEVICE(n), NULL);
1785 static Property virtio_net_properties[] = {
1786 DEFINE_PROP_BIT("csum", VirtIONet, host_features, VIRTIO_NET_F_CSUM, true),
1787 DEFINE_PROP_BIT("guest_csum", VirtIONet, host_features,
1788 VIRTIO_NET_F_GUEST_CSUM, true),
1789 DEFINE_PROP_BIT("gso", VirtIONet, host_features, VIRTIO_NET_F_GSO, true),
1790 DEFINE_PROP_BIT("guest_tso4", VirtIONet, host_features,
1791 VIRTIO_NET_F_GUEST_TSO4, true),
1792 DEFINE_PROP_BIT("guest_tso6", VirtIONet, host_features,
1793 VIRTIO_NET_F_GUEST_TSO6, true),
1794 DEFINE_PROP_BIT("guest_ecn", VirtIONet, host_features,
1795 VIRTIO_NET_F_GUEST_ECN, true),
1796 DEFINE_PROP_BIT("guest_ufo", VirtIONet, host_features,
1797 VIRTIO_NET_F_GUEST_UFO, true),
1798 DEFINE_PROP_BIT("guest_announce", VirtIONet, host_features,
1799 VIRTIO_NET_F_GUEST_ANNOUNCE, true),
1800 DEFINE_PROP_BIT("host_tso4", VirtIONet, host_features,
1801 VIRTIO_NET_F_HOST_TSO4, true),
1802 DEFINE_PROP_BIT("host_tso6", VirtIONet, host_features,
1803 VIRTIO_NET_F_HOST_TSO6, true),
1804 DEFINE_PROP_BIT("host_ecn", VirtIONet, host_features,
1805 VIRTIO_NET_F_HOST_ECN, true),
1806 DEFINE_PROP_BIT("host_ufo", VirtIONet, host_features,
1807 VIRTIO_NET_F_HOST_UFO, true),
1808 DEFINE_PROP_BIT("mrg_rxbuf", VirtIONet, host_features,
1809 VIRTIO_NET_F_MRG_RXBUF, true),
1810 DEFINE_PROP_BIT("status", VirtIONet, host_features,
1811 VIRTIO_NET_F_STATUS, true),
1812 DEFINE_PROP_BIT("ctrl_vq", VirtIONet, host_features,
1813 VIRTIO_NET_F_CTRL_VQ, true),
1814 DEFINE_PROP_BIT("ctrl_rx", VirtIONet, host_features,
1815 VIRTIO_NET_F_CTRL_RX, true),
1816 DEFINE_PROP_BIT("ctrl_vlan", VirtIONet, host_features,
1817 VIRTIO_NET_F_CTRL_VLAN, true),
1818 DEFINE_PROP_BIT("ctrl_rx_extra", VirtIONet, host_features,
1819 VIRTIO_NET_F_CTRL_RX_EXTRA, true),
1820 DEFINE_PROP_BIT("ctrl_mac_addr", VirtIONet, host_features,
1821 VIRTIO_NET_F_CTRL_MAC_ADDR, true),
1822 DEFINE_PROP_BIT("ctrl_guest_offloads", VirtIONet, host_features,
1823 VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, true),
1824 DEFINE_PROP_BIT("mq", VirtIONet, host_features, VIRTIO_NET_F_MQ, false),
1825 DEFINE_NIC_PROPERTIES(VirtIONet, nic_conf),
1826 DEFINE_PROP_UINT32("x-txtimer", VirtIONet, net_conf.txtimer,
1827 TX_TIMER_INTERVAL),
1828 DEFINE_PROP_INT32("x-txburst", VirtIONet, net_conf.txburst, TX_BURST),
1829 DEFINE_PROP_STRING("tx", VirtIONet, net_conf.tx),
1830 DEFINE_PROP_END_OF_LIST(),
1833 static void virtio_net_class_init(ObjectClass *klass, void *data)
1835 DeviceClass *dc = DEVICE_CLASS(klass);
1836 VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
1838 dc->props = virtio_net_properties;
1839 set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
1840 vdc->realize = virtio_net_device_realize;
1841 vdc->unrealize = virtio_net_device_unrealize;
1842 vdc->get_config = virtio_net_get_config;
1843 vdc->set_config = virtio_net_set_config;
1844 vdc->get_features = virtio_net_get_features;
1845 vdc->set_features = virtio_net_set_features;
1846 vdc->bad_features = virtio_net_bad_features;
1847 vdc->reset = virtio_net_reset;
1848 vdc->set_status = virtio_net_set_status;
1849 vdc->guest_notifier_mask = virtio_net_guest_notifier_mask;
1850 vdc->guest_notifier_pending = virtio_net_guest_notifier_pending;
1851 vdc->load = virtio_net_load_device;
1852 vdc->save = virtio_net_save_device;
1855 static const TypeInfo virtio_net_info = {
1856 .name = TYPE_VIRTIO_NET,
1857 .parent = TYPE_VIRTIO_DEVICE,
1858 .instance_size = sizeof(VirtIONet),
1859 .instance_init = virtio_net_instance_init,
1860 .class_init = virtio_net_class_init,
1863 static void virtio_register_types(void)
1865 type_register_static(&virtio_net_info);
1868 type_init(virtio_register_types)