3 * This file is part of the Palacios Virtual Machine Monitor developed
4 * by the V3VEE Project with funding from the United States National
5 * Science Foundation and the Department of Energy.
7 * The V3VEE Project is a joint project between Northwestern University
8 * and the University of New Mexico. You can find out more at
11 * Copyright (c) 2010, Lei Xia <lxia@northwestern.edu>
12 * Copyright (c) 2010, Cui Zheng <cuizheng@cs.unm.edu>
13 * Copyright (c) 2010, The V3VEE Project <http://www.v3vee.org>
14 * All rights reserved.
16 * Author: Lei Xia <lxia@northwestern.edu>
17 * Cui Zheng <cuizheng@cs.unm.edu>
20 * This is free software. You are permitted to use,
21 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
24 #include <palacios/vmm.h>
25 #include <palacios/vmm_dev_mgr.h>
26 #include <devices/lnx_virtio_pci.h>
27 #include <palacios/vm_guest_mem.h>
28 #include <palacios/vmm_sprintf.h>
29 #include <vnet/vnet.h>
30 #include <palacios/vmm_lock.h>
31 #include <palacios/vmm_util.h>
32 #include <devices/pci.h>
33 #include <palacios/vmm_ethernet.h>
34 #include <palacios/vmm_time.h>
37 #ifndef V3_CONFIG_DEBUG_VIRTIO_NET
39 #define PrintDebug(fmt, args...)
42 #ifndef V3_CONFIG_VNET
43 static int net_debug = 0;
46 #define TX_QUEUE_SIZE 4096
47 #define RX_QUEUE_SIZE 4096
48 #define CTRL_QUEUE_SIZE 64
50 /* The feature bitmap for virtio nic
52 #define VIRTIO_NET_F_CSUM 0 /* Host handles pkts w/ partial csum */
53 #define VIRTIO_NET_F_GUEST_CSUM 1 /* Guest handles pkts w/ partial csum */
54 #define VIRTIO_NET_F_MAC 5 /* Host has given MAC address. */
55 #define VIRTIO_NET_F_GSO 6 /* Host handles pkts w/ any GSO type */
56 #define VIRTIO_NET_F_GUEST_TSO4 7 /* Guest can handle TSOv4 in. */
57 #define VIRTIO_NET_F_GUEST_TSO6 8 /* Guest can handle TSOv6 in. */
58 #define VIRTIO_NET_F_GUEST_ECN 9 /* Guest can handle TSO[6] w/ ECN in. */
59 #define VIRTIO_NET_F_GUEST_UFO 10 /* Guest can handle UFO in. */
60 #define VIRTIO_NET_F_HOST_TSO4 11 /* Host can handle TSOv4 in. */
61 #define VIRTIO_NET_F_HOST_TSO6 12 /* Host can handle TSOv6 in. */
62 #define VIRTIO_NET_F_HOST_ECN 13 /* Host can handle TSO[6] w/ ECN in. */
63 #define VIRTIO_NET_F_HOST_UFO 14 /* Host can handle UFO in. */
64 #define VIRTIO_NET_F_MRG_RXBUF 15 /* Host can merge receive buffers. */
65 #define VIRTIO_NET_F_STATUS 16 /* virtio_net_config.status available */
67 /* Port to get virtio config */
68 #define VIRTIO_NET_CONFIG 20
70 #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10))
72 /* for gso_type in virtio_net_hdr */
73 #define VIRTIO_NET_HDR_GSO_NONE 0
74 #define VIRTIO_NET_HDR_GSO_TCPV4 1 /* GSO frame, IPv4 TCP (TSO) */
75 #define VIRTIO_NET_HDR_GSO_UDP 3 /* GSO frame, IPv4 UDP (UFO) */
76 #define VIRTIO_NET_HDR_GSO_TCPV6 4 /* GSO frame, IPv6 TCP */
77 #define VIRTIO_NET_HDR_GSO_ECN 0x80 /* TCP has ECN set */
80 /* for flags in virtio_net_hdr */
81 #define VIRTIO_NET_HDR_F_NEEDS_CSUM 1 /* Use csum_start, csum_offset */
84 /* First element of the scatter-gather list, used with GSO or CSUM features */
89 uint16_t hdr_len; /* Ethernet + IP + tcp/udp hdrs */
90 uint16_t gso_size; /* Bytes to append to hdr_len per frame */
91 uint16_t csum_start; /* Position to start checksumming from */
92 uint16_t csum_offset; /* Offset after that to place checksum */
93 }__attribute__((packed));
96 /* The header to use when the MRG_RXBUF
97 * feature has been negotiated. */
98 struct virtio_net_hdr_mrg_rxbuf {
99 struct virtio_net_hdr hdr;
100 uint16_t num_buffers; /* Number of merged rx buffers */
103 struct virtio_net_config
105 uint8_t mac[ETH_ALEN]; /* VIRTIO_NET_F_MAC */
107 } __attribute__((packed));
109 struct virtio_dev_state {
110 struct vm_device * pci_bus;
111 struct list_head dev_list;
112 struct v3_vm_info *vm;
114 uint8_t mac[ETH_ALEN];
117 struct virtio_net_state {
118 struct virtio_net_config net_cfg;
119 struct virtio_config virtio_cfg;
121 struct v3_vm_info * vm;
122 struct vm_device * dev;
123 struct pci_device * pci_dev;
128 struct virtio_queue rx_vq; /* idx 0*/
129 struct virtio_queue tx_vq; /* idx 1*/
130 struct virtio_queue ctrl_vq; /* idx 2*/
132 uint8_t mergeable_rx_bufs;
134 struct v3_timer * timer;
135 struct nic_statistics stats;
137 struct v3_dev_net_ops * net_ops;
138 v3_lock_t rx_lock, tx_lock;
140 uint8_t tx_notify, rx_notify;
141 uint32_t tx_pkts, rx_pkts;
145 struct virtio_dev_state * virtio_dev;
146 struct list_head dev_link;
150 static int virtio_init_state(struct virtio_net_state * virtio)
152 virtio->rx_vq.queue_size = RX_QUEUE_SIZE;
153 virtio->tx_vq.queue_size = TX_QUEUE_SIZE;
154 virtio->ctrl_vq.queue_size = CTRL_QUEUE_SIZE;
156 virtio->rx_vq.ring_desc_addr = 0;
157 virtio->rx_vq.ring_avail_addr = 0;
158 virtio->rx_vq.ring_used_addr = 0;
159 virtio->rx_vq.pfn = 0;
160 virtio->rx_vq.cur_avail_idx = 0;
162 virtio->tx_vq.ring_desc_addr = 0;
163 virtio->tx_vq.ring_avail_addr = 0;
164 virtio->tx_vq.ring_used_addr = 0;
165 virtio->tx_vq.pfn = 0;
166 virtio->tx_vq.cur_avail_idx = 0;
168 virtio->ctrl_vq.ring_desc_addr = 0;
169 virtio->ctrl_vq.ring_avail_addr = 0;
170 virtio->ctrl_vq.ring_used_addr = 0;
171 virtio->ctrl_vq.pfn = 0;
172 virtio->ctrl_vq.cur_avail_idx = 0;
174 virtio->virtio_cfg.pci_isr = 0;
176 virtio->mergeable_rx_bufs = 1;
178 virtio->virtio_cfg.host_features = 0 | (1 << VIRTIO_NET_F_MAC);
179 if(virtio->mergeable_rx_bufs) {
180 virtio->virtio_cfg.host_features |= (1 << VIRTIO_NET_F_MRG_RXBUF);
183 if ((v3_lock_init(&(virtio->rx_lock)) == -1) ||
184 (v3_lock_init(&(virtio->tx_lock)) == -1)){
185 PrintError("Virtio NIC: Failure to init locks for net_state\n");
191 static int tx_one_pkt(struct guest_info * core,
192 struct virtio_net_state * virtio,
193 struct vring_desc * buf_desc)
195 uint8_t * buf = NULL;
196 uint32_t len = buf_desc->length;
198 if (v3_gpa_to_hva(core, buf_desc->addr_gpa, (addr_t *)&(buf)) == -1) {
199 PrintDebug("Could not translate buffer address\n");
203 V3_Net_Print(2, "Virtio-NIC: virtio_tx: size: %d\n", len);
205 v3_hexdump(buf, len, NULL, 0);
208 if(virtio->net_ops->send(buf, len, virtio->backend_data) < 0){
209 virtio->stats.tx_dropped ++;
213 virtio->stats.tx_pkts ++;
214 virtio->stats.tx_bytes += len;
220 /*copy data into ring buffer */
221 static inline int copy_data_to_desc(struct guest_info * core,
222 struct virtio_net_state * virtio_state,
223 struct vring_desc * desc,
228 uint8_t * desc_buf = NULL;
230 if (v3_gpa_to_hva(core, desc->addr_gpa, (addr_t *)&(desc_buf)) == -1) {
231 PrintDebug("Could not translate buffer address\n");
234 len = (desc->length < (buf_len+dst_offset))?(desc->length - dst_offset):buf_len;
235 memcpy(desc_buf + dst_offset, buf, len);
241 static inline int get_desc_count(struct virtio_queue * q, int index) {
242 struct vring_desc * tmp_desc = &(q->desc[index]);
245 while (tmp_desc->flags & VIRTIO_NEXT_FLAG) {
246 tmp_desc = &(q->desc[tmp_desc->next]);
253 static inline void enable_cb(struct virtio_queue *queue){
255 queue->used->flags &= ~ VRING_NO_NOTIFY_FLAG;
259 static inline void disable_cb(struct virtio_queue *queue) {
261 queue->used->flags |= VRING_NO_NOTIFY_FLAG;
265 static int handle_pkt_tx(struct guest_info * core,
266 struct virtio_net_state * virtio_state,
269 struct virtio_queue *q = &(virtio_state->tx_vq);
270 int txed = 0, left = 0;
273 if (!q->ring_avail_addr) {
277 flags = v3_lock_irqsave(virtio_state->tx_lock);
278 while (q->cur_avail_idx != q->avail->index) {
279 struct virtio_net_hdr_mrg_rxbuf * hdr = NULL;
280 struct vring_desc * hdr_desc = NULL;
282 uint16_t desc_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
283 int desc_cnt = get_desc_count(q, desc_idx);
286 PrintError("VNIC: merged rx buffer not supported, desc_cnt %d\n", desc_cnt);
290 hdr_desc = &(q->desc[desc_idx]);
291 if (v3_gpa_to_hva(core, hdr_desc->addr_gpa, &(hdr_addr)) == -1) {
292 PrintError("Could not translate block header address\n");
296 hdr = (struct virtio_net_hdr_mrg_rxbuf *)hdr_addr;
297 desc_idx = hdr_desc->next;
299 V3_Net_Print(2, "Virtio NIC: TX hdr count : %d\n", hdr->num_buffers);
301 /* here we assumed that one ethernet pkt is not splitted into multiple buffer */
302 struct vring_desc * buf_desc = &(q->desc[desc_idx]);
303 if (tx_one_pkt(core, virtio_state, buf_desc) == -1) {
304 PrintError("Virtio NIC: Error handling nic operation\n");
307 if(buf_desc->next & VIRTIO_NEXT_FLAG){
308 PrintError("Virtio NIC: TX more buffer need to read\n");
311 q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
312 q->used->ring[q->used->index % q->queue_size].length = buf_desc->length; /* What do we set this to???? */
317 if(++txed >= quote && quote > 0){
318 left = (q->cur_avail_idx != q->avail->index);
323 v3_unlock_irqrestore(virtio_state->tx_lock, flags);
325 if (txed && !(q->avail->flags & VIRTIO_NO_IRQ_FLAG)) {
326 v3_pci_raise_irq(virtio_state->virtio_dev->pci_bus,
327 0, virtio_state->pci_dev);
328 virtio_state->virtio_cfg.pci_isr = 0x1;
329 virtio_state->stats.rx_interrupts ++;
333 V3_Net_Print(2, "Virtio Handle TX: txed pkts: %d, left %d\n", txed, left);
340 v3_unlock_irqrestore(virtio_state->tx_lock, flags);
345 static int virtio_setup_queue(struct guest_info *core,
346 struct virtio_net_state * virtio_state,
347 struct virtio_queue * queue,
348 addr_t pfn, addr_t page_addr) {
351 queue->ring_desc_addr = page_addr;
352 queue->ring_avail_addr = page_addr + (queue->queue_size * sizeof(struct vring_desc));
353 queue->ring_used_addr = ((queue->ring_avail_addr) +
354 (sizeof(struct vring_avail)) +
355 (queue->queue_size * sizeof(uint16_t)));
357 // round up to next page boundary.
358 queue->ring_used_addr = (queue->ring_used_addr + 0xfff) & ~0xfff;
359 if (v3_gpa_to_hva(core, queue->ring_desc_addr, (addr_t *)&(queue->desc)) == -1) {
360 PrintError("Could not translate ring descriptor address\n");
364 if (v3_gpa_to_hva(core, queue->ring_avail_addr, (addr_t *)&(queue->avail)) == -1) {
365 PrintError("Could not translate ring available address\n");
369 if (v3_gpa_to_hva(core, queue->ring_used_addr, (addr_t *)&(queue->used)) == -1) {
370 PrintError("Could not translate ring used address\n");
374 PrintDebug("RingDesc_addr=%p, Avail_addr=%p, Used_addr=%p\n",
375 (void *)(queue->ring_desc_addr),
376 (void *)(queue->ring_avail_addr),
377 (void *)(queue->ring_used_addr));
379 PrintDebug("RingDesc=%p, Avail=%p, Used=%p\n",
380 queue->desc, queue->avail, queue->used);
385 static int virtio_io_write(struct guest_info *core,
386 uint16_t port, void * src,
387 uint_t length, void * private_data)
389 struct virtio_net_state * virtio = (struct virtio_net_state *)private_data;
390 int port_idx = port % virtio->io_range_size;
392 PrintDebug("VIRTIO NIC %p Write for port %d (index=%d) len=%d, value=%x\n",
393 private_data, port, port_idx,
394 length, *(uint32_t *)src);
397 case GUEST_FEATURES_PORT:
399 PrintError("Illegal write length for guest features\n");
402 virtio->virtio_cfg.guest_features = *(uint32_t *)src;
405 case VRING_PG_NUM_PORT:
407 PrintError("Illegal write length for page frame number\n");
410 addr_t pfn = *(uint32_t *)src;
411 addr_t page_addr = (pfn << VIRTIO_PAGE_SHIFT);
412 uint16_t queue_idx = virtio->virtio_cfg.vring_queue_selector;
415 virtio_setup_queue(core, virtio,
420 virtio_setup_queue(core, virtio,
423 if(virtio->tx_notify == 0){
424 disable_cb(&virtio->tx_vq);
429 virtio_setup_queue(core, virtio,
438 case VRING_Q_SEL_PORT:
439 virtio->virtio_cfg.vring_queue_selector = *(uint16_t *)src;
440 if (virtio->virtio_cfg.vring_queue_selector > 2) {
441 PrintError("Virtio NIC: wrong queue idx: %d\n",
442 virtio->virtio_cfg.vring_queue_selector);
447 case VRING_Q_NOTIFY_PORT:
449 uint16_t queue_idx = *(uint16_t *)src;
451 /* receive queue refill */
452 virtio->stats.tx_interrupts ++;
453 } else if (queue_idx == 1){
454 if (handle_pkt_tx(core, virtio, 0) < 0) {
455 PrintError("Virtio NIC: Error to handle packet TX\n");
458 virtio->stats.tx_interrupts ++;
459 } else if (queue_idx == 2){
462 PrintError("Virtio NIC: Wrong queue index %d\n", queue_idx);
467 case VIRTIO_STATUS_PORT:
468 virtio->virtio_cfg.status = *(uint8_t *)src;
469 if (virtio->virtio_cfg.status == 0) {
470 virtio_init_state(virtio);
474 case VIRTIO_ISR_PORT:
475 virtio->virtio_cfg.pci_isr = *(uint8_t *)src;
486 static int virtio_io_read(struct guest_info *core,
487 uint16_t port, void * dst,
488 uint_t length, void * private_data)
490 struct virtio_net_state * virtio = (struct virtio_net_state *)private_data;
491 int port_idx = port % virtio->io_range_size;
492 uint16_t queue_idx = virtio->virtio_cfg.vring_queue_selector;
494 PrintDebug("Virtio NIC %p: Read for port 0x%x (index =%d), length=%d\n",
495 private_data, port, port_idx, length);
498 case HOST_FEATURES_PORT:
500 PrintError("Virtio NIC: Illegal read length for host features\n");
503 *(uint32_t *)dst = virtio->virtio_cfg.host_features;
506 case VRING_PG_NUM_PORT:
508 PrintError("Virtio NIC: Illegal read length for page frame number\n");
513 *(uint32_t *)dst = virtio->rx_vq.pfn;
516 *(uint32_t *)dst = virtio->tx_vq.pfn;
519 *(uint32_t *)dst = virtio->ctrl_vq.pfn;
526 case VRING_SIZE_PORT:
528 PrintError("Virtio NIC: Illegal read length for vring size\n");
533 *(uint16_t *)dst = virtio->rx_vq.queue_size;
536 *(uint16_t *)dst = virtio->tx_vq.queue_size;
539 *(uint16_t *)dst = virtio->ctrl_vq.queue_size;
546 case VIRTIO_STATUS_PORT:
548 PrintError("Virtio NIC: Illegal read length for status\n");
551 *(uint8_t *)dst = virtio->virtio_cfg.status;
554 case VIRTIO_ISR_PORT:
555 *(uint8_t *)dst = virtio->virtio_cfg.pci_isr;
556 virtio->virtio_cfg.pci_isr = 0;
557 v3_pci_lower_irq(virtio->virtio_dev->pci_bus,
561 case VIRTIO_NET_CONFIG ... VIRTIO_NET_CONFIG + ETH_ALEN:
562 *(uint8_t *)dst = virtio->net_cfg.mac[port_idx-VIRTIO_NET_CONFIG];
566 PrintError("Virtio NIC: Read of Unhandled Virtio Read:%d\n",
575 /* receiving raw ethernet pkt from backend */
576 static int virtio_rx(uint8_t * buf, uint32_t size, void * private_data) {
577 struct virtio_net_state * virtio = (struct virtio_net_state *)private_data;
578 struct virtio_queue * q = &(virtio->rx_vq);
579 struct virtio_net_hdr_mrg_rxbuf hdr;
581 uint8_t kick_guest = 0;
583 V3_Net_Print(2, "Virtio NIC: virtio_rx: size: %d\n", size);
585 if (!q->ring_avail_addr) {
586 V3_Net_Print(2, "Virtio NIC: RX Queue not set\n");
587 virtio->stats.rx_dropped ++;
592 memset(&hdr, 0, sizeof(struct virtio_net_hdr_mrg_rxbuf));
594 flags = v3_lock_irqsave(virtio->rx_lock);
596 if (q->cur_avail_idx != q->avail->index){
598 struct vring_desc * buf_desc;
599 uint32_t hdr_len, len;
602 hdr_len = (virtio->mergeable_rx_bufs)?
603 sizeof(struct virtio_net_hdr_mrg_rxbuf):
604 sizeof(struct virtio_net_hdr);
606 if(virtio->mergeable_rx_bufs){/* merged buffer */
607 struct vring_desc * hdr_desc;
608 uint16_t old_idx = q->cur_avail_idx;
610 buf_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
611 hdr_desc = &(q->desc[buf_idx]);
613 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
614 virtio, hdr_desc, buf, size, hdr_len);
620 q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
621 q->used->ring[q->used->index % q->queue_size].length = hdr_len + offset;
625 while(offset < size) {
626 buf_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
627 buf_desc = &(q->desc[buf_idx]);
629 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
630 virtio, buf_desc, buf+offset, size-offset, 0);
632 V3_Net_Print(2, "Virtio NIC: merged buffer, %d buffer size %d\n",
633 hdr.num_buffers, len);
634 q->cur_avail_idx = old_idx;
638 buf_desc->flags &= ~VIRTIO_NEXT_FLAG;
640 q->used->ring[(q->used->index + hdr.num_buffers) % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
641 q->used->ring[(q->used->index + hdr.num_buffers) % q->queue_size].length = len;
647 copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
648 virtio, hdr_desc, (uchar_t *)&hdr, hdr_len, 0);
649 q->used->index += hdr.num_buffers;
651 buf_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
652 buf_desc = &(q->desc[buf_idx]);
655 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
656 virtio, buf_desc, (uchar_t *)&(hdr.hdr), hdr_len, 0);
658 V3_Net_Print(2, "Virtio NIC: rx copy header error %d, hdr_len %d\n",
663 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
664 virtio, buf_desc, buf, size, hdr_len);
666 V3_Net_Print(2, "Virtio NIC: rx copy data error %d\n", len);
671 /* copy rest of data */
672 while(offset < size &&
673 (buf_desc->flags & VIRTIO_NEXT_FLAG)){
674 buf_desc = &(q->desc[buf_desc->next]);
675 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
676 virtio, buf_desc, buf+offset, size-offset, 0);
682 buf_desc->flags &= ~VIRTIO_NEXT_FLAG;
685 V3_Net_Print(2, "Virtio NIC: rx not enough ring buffer, buffer size %d\n",
690 q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
691 q->used->ring[q->used->index % q->queue_size].length = size + hdr_len; /* This should be the total length of data sent to guest (header+pkt_data) */
696 virtio->stats.rx_pkts ++;
697 virtio->stats.rx_bytes += size;
699 V3_Net_Print(2, "Virtio NIC: Guest RX queue is full\n");
700 virtio->stats.rx_dropped ++;
702 /* kick guest to refill RX queue */
706 v3_unlock_irqrestore(virtio->rx_lock, flags);
708 if (!(q->avail->flags & VIRTIO_NO_IRQ_FLAG) || kick_guest) {
709 V3_Net_Print(2, "Virtio NIC: RX Raising IRQ %d\n",
710 virtio->pci_dev->config_header.intr_line);
712 virtio->virtio_cfg.pci_isr = 0x1;
713 v3_pci_raise_irq(virtio->virtio_dev->pci_bus, 0, virtio->pci_dev);
714 virtio->stats.rx_interrupts ++;
717 /* notify guest if it is in guest mode */
718 if((kick_guest || virtio->rx_notify == 1) &&
719 V3_Get_CPU() != virtio->virtio_dev->vm->cores[0].pcpu_id){
720 v3_interrupt_cpu(virtio->virtio_dev->vm,
721 virtio->virtio_dev->vm->cores[0].pcpu_id,
728 virtio->stats.rx_dropped ++;
729 v3_unlock_irqrestore(virtio->rx_lock, flags);
734 static int virtio_free(struct virtio_dev_state * virtio) {
735 struct virtio_net_state * backend = NULL;
736 struct virtio_net_state * tmp = NULL;
739 list_for_each_entry_safe(backend, tmp, &(virtio->dev_list), dev_link) {
741 // unregister from PCI
743 list_del(&(backend->dev_link));
752 static struct v3_device_ops dev_ops = {
753 .free = (int (*)(void *))virtio_free,
757 static int virtio_poll(int quote, void * data){
758 struct virtio_net_state * virtio = (struct virtio_net_state *)data;
760 if (virtio->status) {
762 return handle_pkt_tx(&(virtio->vm->cores[0]), virtio, quote);
768 static int register_dev(struct virtio_dev_state * virtio,
769 struct virtio_net_state * net_state)
771 struct pci_device * pci_dev = NULL;
772 struct v3_pci_bar bars[6];
773 int num_ports = sizeof(struct virtio_config);
774 int tmp_ports = num_ports;
777 /* This gets the number of ports, rounded up to a power of 2 */
778 net_state->io_range_size = 1;
779 while (tmp_ports > 0) {
781 net_state->io_range_size <<= 1;
784 /* this is to account for any low order bits being set in num_ports
785 * if there are none, then num_ports was already a power of 2 so we shift right to reset it
787 if ((num_ports & ((net_state->io_range_size >> 1) - 1)) == 0) {
788 net_state->io_range_size >>= 1;
791 for (i = 0; i < 6; i++) {
792 bars[i].type = PCI_BAR_NONE;
795 PrintDebug("Virtio NIC: io_range_size = %d\n",
796 net_state->io_range_size);
798 bars[0].type = PCI_BAR_IO;
799 bars[0].default_base_port = -1;
800 bars[0].num_ports = net_state->io_range_size;
801 bars[0].io_read = virtio_io_read;
802 bars[0].io_write = virtio_io_write;
803 bars[0].private_data = net_state;
805 pci_dev = v3_pci_register_device(virtio->pci_bus, PCI_STD_DEVICE,
806 0, PCI_AUTO_DEV_NUM, 0,
807 "LNX_VIRTIO_NIC", bars,
808 NULL, NULL, NULL, net_state);
811 PrintError("Virtio NIC: Could not register PCI Device\n");
815 PrintDebug("Virtio NIC: registered to PCI bus\n");
817 pci_dev->config_header.vendor_id = VIRTIO_VENDOR_ID;
818 pci_dev->config_header.subsystem_vendor_id = VIRTIO_SUBVENDOR_ID;
821 pci_dev->config_header.device_id = VIRTIO_NET_DEV_ID;
822 pci_dev->config_header.class = PCI_CLASS_NETWORK;
823 pci_dev->config_header.subclass = PCI_NET_SUBCLASS_OTHER;
824 pci_dev->config_header.subsystem_id = VIRTIO_NET_SUBDEVICE_ID;
825 pci_dev->config_header.intr_pin = 1;
826 pci_dev->config_header.max_latency = 1; // ?? (qemu does it...)
828 net_state->pci_dev = pci_dev;
829 net_state->virtio_dev = virtio;
831 memcpy(net_state->net_cfg.mac, virtio->mac, 6);
833 virtio_init_state(net_state);
835 V3_Print("Virtio NIC: Registered Intr Line %d\n", pci_dev->config_header.intr_line);
837 /* Add backend to list of devices */
838 list_add(&(net_state->dev_link), &(virtio->dev_list));
843 #define RATE_UPPER_THRESHOLD 10 /* 10000 pkts per second, around 100Mbits */
844 #define RATE_LOWER_THRESHOLD 1
845 #define PROFILE_PERIOD 10000 /*us*/
847 static void virtio_nic_timer(struct guest_info * core,
848 uint64_t cpu_cycles, uint64_t cpu_freq,
850 struct virtio_net_state * net_state = (struct virtio_net_state *)priv_data;
852 static int profile_ms = 0;
854 if(!net_state->status){ /* VNIC is not in working status */
858 period_us = (1000*cpu_cycles)/cpu_freq;
859 net_state->past_us += period_us;
861 if(net_state->past_us > PROFILE_PERIOD){
862 uint32_t tx_rate, rx_rate;
864 tx_rate = (net_state->stats.tx_pkts - net_state->tx_pkts)/(net_state->past_us/1000); /* pkts/per ms */
865 rx_rate = (net_state->stats.rx_pkts - net_state->rx_pkts)/(net_state->past_us/1000);
867 net_state->tx_pkts = net_state->stats.tx_pkts;
868 net_state->rx_pkts = net_state->stats.rx_pkts;
870 if(tx_rate > RATE_UPPER_THRESHOLD && net_state->tx_notify == 1){
871 V3_Print("Virtio NIC: Switch TX to VMM driven mode\n");
872 disable_cb(&(net_state->tx_vq));
873 net_state->tx_notify = 0;
874 vnet_thread_wakeup(net_state->poll_thread);
877 if(tx_rate < RATE_LOWER_THRESHOLD && net_state->tx_notify == 0){
878 V3_Print("Virtio NIC: Switch TX to Guest driven mode\n");
879 enable_cb(&(net_state->tx_vq));
880 net_state->tx_notify = 1;
883 if(rx_rate > RATE_UPPER_THRESHOLD && net_state->rx_notify == 1){
884 V3_Print("Virtio NIC: Switch RX to VMM None notify mode\n");
885 net_state->rx_notify = 0;
888 if(rx_rate < RATE_LOWER_THRESHOLD && net_state->rx_notify == 0){
889 V3_Print("Virtio NIC: Switch RX to VMM notify mode\n");
890 net_state->rx_notify = 1;
893 net_state->past_us = 0;
896 profile_ms += period_us/1000;
897 if(profile_ms > 20000){
898 V3_Net_Print(1, "Virtio NIC: TX: Pkt: %lld, Bytes: %lld\n\t\tRX Pkt: %lld. Bytes: %lld\n\t\tDropped: tx %lld, rx %lld\nInterrupts: tx %d, rx %d\nTotal Exit: %lld\n",
899 net_state->stats.tx_pkts, net_state->stats.tx_bytes,
900 net_state->stats.rx_pkts, net_state->stats.rx_bytes,
901 net_state->stats.tx_dropped, net_state->stats.rx_dropped,
902 net_state->stats.tx_interrupts, net_state->stats.rx_interrupts,
903 net_state->vm->cores[0].num_exits);
908 static struct v3_timer_ops timer_ops = {
909 .update_timer = virtio_nic_timer,
913 static int connect_fn(struct v3_vm_info * info,
914 void * frontend_data,
915 struct v3_dev_net_ops * ops,
917 void * private_data) {
918 struct virtio_dev_state * virtio = (struct virtio_dev_state *)frontend_data;
919 struct virtio_net_state * net_state = (struct virtio_net_state *)V3_Malloc(sizeof(struct virtio_net_state));
921 memset(net_state, 0, sizeof(struct virtio_net_state));
922 register_dev(virtio, net_state);
924 net_state->vm = info;
925 net_state->net_ops = ops;
926 net_state->backend_data = private_data;
927 net_state->virtio_dev = virtio;
929 net_state->tx_notify = 1;
930 net_state->rx_notify = 1;
932 net_state->timer = v3_add_timer(&(info->cores[0]),
933 &timer_ops,net_state);
935 ops->recv = virtio_rx;
936 ops->poll = virtio_poll;
937 ops->config.frontend_data = net_state;
938 ops->config.poll = 1;
939 ops->config.quote = 64;
940 ops->config.fnt_mac = V3_Malloc(ETH_ALEN);
941 memcpy(ops->config.fnt_mac, virtio->mac, ETH_ALEN);
946 static int virtio_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
947 struct vm_device * pci_bus = v3_find_dev(vm, v3_cfg_val(cfg, "bus"));
948 struct virtio_dev_state * virtio_state = NULL;
949 char * dev_id = v3_cfg_val(cfg, "ID");
951 char * str = v3_cfg_val(cfg, "mac");
952 memcpy(macstr, str, strlen(str));
954 if (pci_bus == NULL) {
955 PrintError("Virtio NIC: Virtio device require a PCI Bus");
959 virtio_state = (struct virtio_dev_state *)V3_Malloc(sizeof(struct virtio_dev_state));
960 memset(virtio_state, 0, sizeof(struct virtio_dev_state));
962 INIT_LIST_HEAD(&(virtio_state->dev_list));
963 virtio_state->pci_bus = pci_bus;
964 virtio_state->vm = vm;
966 if (macstr != NULL && !str2mac(macstr, virtio_state->mac)) {
967 PrintDebug("Virtio NIC: Mac specified %s\n", macstr);
969 random_ethaddr(virtio_state->mac);
972 struct vm_device * dev = v3_add_device(vm, dev_id, &dev_ops, virtio_state);
975 PrintError("Virtio NIC: Could not attach device %s\n", dev_id);
976 V3_Free(virtio_state);
980 if (v3_dev_add_net_frontend(vm, dev_id, connect_fn, (void *)virtio_state) == -1) {
981 PrintError("Virtio NIC: Could not register %s as net frontend\n", dev_id);
982 v3_remove_device(dev);
989 device_register("LNX_VIRTIO_NIC", virtio_init)