2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #include <palacios/vmm.h>
21 #include <palacios/vmm_dev_mgr.h>
22 #include <palacios/vm_guest_mem.h>
23 #include <devices/lnx_virtio_pci.h>
24 #include <palacios/vmm_vnet.h>
25 #include <palacios/vmm_sprintf.h>
26 #include <devices/pci.h>
29 #ifndef CONFIG_LINUX_VIRTIO_VNET_DEBUG
31 #define PrintDebug(fmt, args...)
35 #define QUEUE_SIZE 128
41 } __attribute__((packed));
48 struct virtio_vnet_state {
49 struct v3_vm_info * vm;
50 struct vnet_config vnet_cfg;
51 struct virtio_config virtio_cfg;
53 struct vm_device * pci_bus;
54 struct pci_device * pci_dev;
56 struct virtio_queue queue[NUM_QUEUES];
58 struct virtio_queue * cur_queue;
64 #define VNET_GET_ROUTES 10
65 #define VNET_ADD_ROUTE 11
66 #define VNET_DEL_ROUTE 12
68 #define VNET_GET_LINKS 20
69 #define VNET_ADD_LINK 21
70 #define VNET_DEL_LINK 22
72 // structure of the vnet command header
73 struct vnet_ctrl_hdr {
76 } __attribute__((packed));
78 struct vnet_virtio_pkt {
84 static int virtio_reset(struct virtio_vnet_state * vnet_state) {
86 memset(vnet_state->queue, 0, sizeof(struct virtio_queue) * 2);
88 vnet_state->cur_queue = &(vnet_state->queue[0]);
90 vnet_state->virtio_cfg.status = 0;
91 vnet_state->virtio_cfg.pci_isr = 0;
93 vnet_state->queue[0].queue_size = QUEUE_SIZE;
94 vnet_state->queue[1].queue_size = QUEUE_SIZE;
95 vnet_state->queue[2].queue_size = QUEUE_SIZE;
97 memset(&(vnet_state->vnet_cfg), 0, sizeof(struct vnet_config));
98 v3_lock_init(&(vnet_state->lock));
105 static int get_desc_count(struct virtio_queue * q, int index) {
106 struct vring_desc * tmp_desc = &(q->desc[index]);
109 while (tmp_desc->flags & VIRTIO_NEXT_FLAG) {
110 tmp_desc = &(q->desc[tmp_desc->next]);
120 static int handle_cmd_kick(struct guest_info * core, struct virtio_vnet_state * vnet_state) {
121 struct virtio_queue * q = &(vnet_state->queue[0]);
123 PrintDebug("VNET Bridge: Handling command queue\n");
125 while (q->cur_avail_idx != q->avail->index) {
126 struct vring_desc * hdr_desc = NULL;
127 struct vring_desc * buf_desc = NULL;
128 struct vring_desc * status_desc = NULL;
129 uint16_t desc_idx = q->avail->ring[q->cur_avail_idx % QUEUE_SIZE];
130 uint16_t desc_cnt = get_desc_count(q, desc_idx);
131 struct vnet_ctrl_hdr * hdr = NULL;
134 uint8_t * status_ptr = NULL;
138 PrintDebug("VNET Bridge: CMD: Descriptor Count=%d, index=%d, desc_idx=%d\n", desc_cnt, q->cur_avail_idx % QUEUE_SIZE, desc_idx);
141 PrintError("VNET Bridge cmd must include at least 3 descriptors (cnt=%d)\n", desc_cnt);
145 hdr_desc = &(q->desc[desc_idx]);
147 if (guest_pa_to_host_va(core, hdr_desc->addr_gpa, (addr_t *)&hdr) == -1) {
148 PrintError("Could not translate VirtioVNET header address\n");
152 desc_idx = hdr_desc->next;
154 if (hdr->cmd_type == VNET_ADD_ROUTE) {
156 for (i = 0; i < hdr->num_cmds; i++) {
157 uint8_t tmp_status = 0;
158 struct v3_vnet_route * route = NULL;
160 buf_desc = &(q->desc[desc_idx]);
162 if (guest_pa_to_host_va(core, buf_desc->addr_gpa, (addr_t *)&(route)) == -1) {
163 PrintError("Could not translate route address\n");
168 PrintDebug("VNET Bridge: Adding VNET Route\n");
170 tmp_status = v3_vnet_add_route(*route);
172 PrintDebug("VNET Route Added\n");
174 if (tmp_status != 0) {
175 PrintError("Error adding VNET ROUTE\n");
179 xfer_len += buf_desc->length;
180 desc_idx = buf_desc->next;
187 status_desc = &(q->desc[desc_idx]);
189 if (guest_pa_to_host_va(core, status_desc->addr_gpa, (addr_t *)&status_ptr) == -1) {
190 PrintError("VirtioVNET Error could not translate status address\n");
194 xfer_len += status_desc->length;
195 *status_ptr = status;
197 PrintDebug("Transferred %d bytes (xfer_len)\n", xfer_len);
198 q->used->ring[q->used->index % QUEUE_SIZE].id = q->avail->ring[q->cur_avail_idx % QUEUE_SIZE];
199 q->used->ring[q->used->index % QUEUE_SIZE].length = xfer_len; // set to total inbound xfer length
206 if (!(q->avail->flags & VIRTIO_NO_IRQ_FLAG)) {
207 PrintDebug("Raising IRQ %d\n", vnet_state->pci_dev->config_header.intr_line);
208 v3_pci_raise_irq(vnet_state->pci_bus, 0, vnet_state->pci_dev);
209 vnet_state->virtio_cfg.pci_isr = 1;
217 static int vnet_pkt_input_cb(struct v3_vm_info * vm, struct v3_vnet_pkt * pkt, void * private_data){
218 struct virtio_vnet_state * vnet_state = (struct virtio_vnet_state *)private_data;
219 struct virtio_queue * q = &(vnet_state->queue[RECV_QUEUE]);
223 flags = v3_lock_irqsave(vnet_state->lock);
225 PrintDebug("VNET Bridge: RX: pkt sent to guest size: %d\n, pkt_header_len: %d\n", data_len, pkt_head_len);
227 if (q->ring_avail_addr == 0) {
228 PrintError("Queue is not set\n");
233 if (q->cur_avail_idx != q->avail->index) {
234 uint16_t pkt_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
235 struct vring_desc * pkt_desc = NULL;
236 struct vnet_virtio_pkt * virtio_pkt = NULL;
239 pkt_desc = &(q->desc[pkt_idx]);
240 PrintDebug("VNET Bridge RX: buffer desc len: %d\n", pkt_desc->length);
242 if (guest_pa_to_host_va(&(vm->cores[0]), pkt_desc->addr_gpa, (addr_t *)&(virtio_pkt)) == -1) {
243 PrintError("Could not translate buffer address\n");
247 // Fill in dst packet buffer
248 virtio_pkt->link_id = pkt->dst_id;
249 virtio_pkt->pkt_size = pkt->size;
250 memcpy(virtio_pkt->pkt, pkt->data, pkt->size);
253 q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
254 q->used->ring[q->used->index % q->queue_size].length = sizeof(struct vnet_virtio_pkt); // This should be the total length of data sent to guest (header+pkt_data)
259 PrintError("Packet buffer overflow in the guest\n");
262 if (!(q->avail->flags & VIRTIO_NO_IRQ_FLAG)) {
263 v3_pci_raise_irq(vnet_state->pci_bus, 0, vnet_state->pci_dev);
264 vnet_state->virtio_cfg.pci_isr = 0x1;
265 PrintDebug("Raising IRQ %d\n", vnet_state->pci_dev->config_header.intr_line);
272 v3_unlock_irqrestore(vnet_state->lock, flags);
278 static int handle_pkt_kick(struct guest_info *core, struct virtio_vnet_state * vnet_state)
280 struct virtio_queue * q = &(vnet_state->queue[XMIT_QUEUE]);
282 PrintDebug("VNET Bridge Device: Handle TX\n");
284 while (q->cur_avail_idx != q->avail->index) {
285 uint16_t desc_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
286 struct vring_desc * pkt_desc = NULL;
287 struct vnet_virtio_pkt * virtio_pkt = NULL;
289 pkt_desc = &(q->desc[desc_idx]);
291 PrintDebug("VNET Bridge: Handle TX buf_len: %d\n", pkt_desc->length);
293 if (guest_pa_to_host_va(core, pkt_desc->addr_gpa, (addr_t *)&(virtio_pkt)) == -1) {
294 PrintError("Could not translate buffer address\n");
298 //TODO: SETUP VNET PACKET data structure
301 if (v3_vnet_send_pkt(pkt, (void *)core) == -1) {
302 PrintError("Error sending packet to vnet\n");
306 q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
307 q->used->ring[q->used->index % q->queue_size].length = pkt_desc->length; // What do we set this to????
313 if (!(q->avail->flags & VIRTIO_NO_IRQ_FLAG)) {
314 v3_pci_raise_irq(vnet_state->pci_bus, 0, vnet_state->pci_dev);
315 vnet_state->virtio_cfg.pci_isr = 0x1;
318 #ifdef CONFIG_VNET_PROFILE
321 core->vnet_times.total_handle_time = time - core->vnet_times.virtio_handle_start;
322 core->vnet_times.print = true;
328 static int virtio_io_write(struct guest_info * core, uint16_t port, void * src, uint_t length, void * private_data) {
329 struct virtio_vnet_state * vnet_state = (struct virtio_vnet_state *)private_data;
330 int port_idx = port % vnet_state->io_range_size;
332 PrintDebug("VNET Bridge: VIRTIO VNET Write for port %d len=%d, value=%x\n",
333 port, length, *(uint32_t *)src);
334 PrintDebug("VNET Bridge: port idx=%d\n", port_idx);
338 case GUEST_FEATURES_PORT:
340 PrintError("Illegal write length for guest features\n");
343 vnet_state->virtio_cfg.guest_features = *(uint32_t *)src;
346 case VRING_PG_NUM_PORT:
348 addr_t pfn = *(uint32_t *)src;
349 addr_t page_addr = (pfn << VIRTIO_PAGE_SHIFT);
351 vnet_state->cur_queue->pfn = pfn;
353 vnet_state->cur_queue->ring_desc_addr = page_addr ;
354 vnet_state->cur_queue->ring_avail_addr = page_addr + (QUEUE_SIZE * sizeof(struct vring_desc));
355 vnet_state->cur_queue->ring_used_addr = ( vnet_state->cur_queue->ring_avail_addr + \
356 sizeof(struct vring_avail) + \
357 (QUEUE_SIZE * sizeof(uint16_t)));
359 // round up to next page boundary.
360 vnet_state->cur_queue->ring_used_addr = (vnet_state->cur_queue->ring_used_addr + 0xfff) & ~0xfff;
362 if (guest_pa_to_host_va(core, vnet_state->cur_queue->ring_desc_addr, (addr_t *)&(vnet_state->cur_queue->desc)) == -1) {
363 PrintError("Could not translate ring descriptor address\n");
367 if (guest_pa_to_host_va(core, vnet_state->cur_queue->ring_avail_addr, (addr_t *)&(vnet_state->cur_queue->avail)) == -1) {
368 PrintError("Could not translate ring available address\n");
372 if (guest_pa_to_host_va(core, vnet_state->cur_queue->ring_used_addr, (addr_t *)&(vnet_state->cur_queue->used)) == -1) {
373 PrintError("Could not translate ring used address\n");
377 PrintDebug("VNET Bridge: RingDesc_addr=%p, Avail_addr=%p, Used_addr=%p\n",
378 (void *)(vnet_state->cur_queue->ring_desc_addr),
379 (void *)(vnet_state->cur_queue->ring_avail_addr),
380 (void *)(vnet_state->cur_queue->ring_used_addr));
382 PrintDebug("VNET Bridge: RingDesc=%p, Avail=%p, Used=%p\n",
383 vnet_state->cur_queue->desc, vnet_state->cur_queue->avail, vnet_state->cur_queue->used);
386 PrintError("Illegal write length for page frame number\n");
390 case VRING_Q_SEL_PORT:
391 vnet_state->virtio_cfg.vring_queue_selector = *(uint16_t *)src;
393 if (vnet_state->virtio_cfg.vring_queue_selector > NUM_QUEUES) {
394 PrintError("VNET Bridge device has no qeueues. Selected %d\n",
395 vnet_state->virtio_cfg.vring_queue_selector);
399 vnet_state->cur_queue = &(vnet_state->queue[vnet_state->virtio_cfg.vring_queue_selector]);
402 case VRING_Q_NOTIFY_PORT: {
403 uint16_t queue_idx = *(uint16_t *)src;
405 PrintDebug("VNET Bridge: Handling Kick\n");
407 if (queue_idx == 0) {
408 if (handle_cmd_kick(core, vnet_state) == -1) {
409 PrintError("Could not handle Virtio VNET Control command\n");
412 } else if (queue_idx == 1) {
413 if (handle_pkt_kick(core, vnet_state) == -1){
414 PrintError("Could not handle Virtio VNET TX\n");
417 } else if (queue_idx == 2) {
418 PrintDebug("VNET Bridge: receive kick on RX Queue\n");
420 PrintError("VNET Bridge: Kick on invalid queue (%d)\n", queue_idx);
426 case VIRTIO_STATUS_PORT:
427 vnet_state->virtio_cfg.status = *(uint8_t *)src;
429 if (vnet_state->virtio_cfg.status == 0) {
430 PrintDebug("VNET Bridge: Resetting device\n");
431 virtio_reset(vnet_state);
436 case VIRTIO_ISR_PORT:
437 vnet_state->virtio_cfg.pci_isr = *(uint8_t *)src;
448 static int vnetbrg_io_read(struct guest_info * core, uint16_t port, void * dst, uint_t length, void * private_data) {
450 struct virtio_vnet_state * vnet_state = (struct virtio_vnet_state *)private_data;
451 int port_idx = port % vnet_state->io_range_size;
454 PrintDebug("VirtioVNET: VIRTIO SYMBIOTIC Read for port %d (index =%d), length=%d\n",
455 port, port_idx, length);
458 case HOST_FEATURES_PORT:
460 PrintError("Illegal read length for host features\n");
464 *(uint32_t *)dst = vnet_state->virtio_cfg.host_features;
467 case VRING_PG_NUM_PORT:
469 PrintError("Illegal read length for page frame number\n");
473 *(uint32_t *)dst = vnet_state->cur_queue->pfn;
476 case VRING_SIZE_PORT:
478 PrintError("Illegal read length for vring size\n");
482 *(uint16_t *)dst = vnet_state->cur_queue->queue_size;
486 case VIRTIO_STATUS_PORT:
488 PrintError("Illegal read length for status\n");
492 *(uint8_t *)dst = vnet_state->virtio_cfg.status;
495 case VIRTIO_ISR_PORT:
496 *(uint8_t *)dst = vnet_state->virtio_cfg.pci_isr;
497 vnet_state->virtio_cfg.pci_isr = 0;
498 v3_pci_lower_irq(vnet_state->pci_bus, 0, vnet_state->pci_dev);
502 if ( (port_idx >= sizeof(struct virtio_config)) &&
503 (port_idx < (sizeof(struct virtio_config) + sizeof(struct vnet_config))) ) {
504 int cfg_offset = port_idx - sizeof(struct virtio_config);
505 uint8_t * cfg_ptr = (uint8_t *)&(vnet_state->vnet_cfg);
507 memcpy(dst, cfg_ptr + cfg_offset, length);
510 PrintError("Read of Unhandled Virtio Read\n");
522 static struct v3_device_ops dev_ops = {
530 static int dev_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
531 struct vm_device * pci_bus = v3_find_dev(vm, v3_cfg_val(cfg, "bus"));
532 struct virtio_vnet_state * vnet_state = NULL;
533 struct pci_device * pci_dev = NULL;
534 char * name = v3_cfg_val(cfg, "name");
536 PrintDebug("VNET Bridge: Initializing VNET Bridge Control device: %s\n", name);
538 if (pci_bus == NULL) {
539 PrintError("VNET Bridge device require a PCI Bus");
543 vnet_state = (struct virtio_vnet_state *)V3_Malloc(sizeof(struct virtio_vnet_state));
544 memset(vnet_state, 0, sizeof(struct virtio_vnet_state));
548 struct vm_device * dev = v3_allocate_device(name, &dev_ops, vnet_state);
550 if (v3_attach_device(vm, dev) == -1) {
551 PrintError("Could not attach device %s\n", name);
556 // PCI initialization
558 struct v3_pci_bar bars[6];
559 int num_ports = sizeof(struct virtio_config) + sizeof(struct vnet_config);
560 int tmp_ports = num_ports;
563 // This gets the number of ports, rounded up to a power of 2
564 vnet_state->io_range_size = 1; // must be a power of 2
566 while (tmp_ports > 0) {
568 vnet_state->io_range_size <<= 1;
571 // this is to account for any low order bits being set in num_ports
572 // if there are none, then num_ports was already a power of 2 so we shift right to reset it
573 if ((num_ports & ((vnet_state->io_range_size >> 1) - 1)) == 0) {
574 vnet_state->io_range_size >>= 1;
577 for (i = 0; i < 6; i++) {
578 bars[i].type = PCI_BAR_NONE;
581 bars[0].type = PCI_BAR_IO;
582 bars[0].default_base_port = -1;
583 bars[0].num_ports = vnet_state->io_range_size;
584 bars[0].io_read = virtio_io_read;
585 bars[0].io_write = virtio_io_write;
586 bars[0].private_data = vnet_state;
588 pci_dev = v3_pci_register_device(pci_bus, PCI_STD_DEVICE,
589 0, PCI_AUTO_DEV_NUM, 0,
590 "LNX_VIRTIO_VNET", bars,
591 NULL, NULL, NULL, vnet_state);
594 PrintError("Could not register PCI Device\n");
598 pci_dev->config_header.vendor_id = VIRTIO_VENDOR_ID;
599 pci_dev->config_header.subsystem_vendor_id = VIRTIO_SUBVENDOR_ID;
600 pci_dev->config_header.device_id = VIRTIO_VNET_DEV_ID;
601 pci_dev->config_header.class = PCI_CLASS_MEMORY;
602 pci_dev->config_header.subclass = PCI_MEM_SUBCLASS_RAM;
603 pci_dev->config_header.subsystem_id = VIRTIO_VNET_SUBDEVICE_ID;
604 pci_dev->config_header.intr_pin = 1;
605 pci_dev->config_header.max_latency = 1; // ?? (qemu does it...)
608 vnet_state->pci_dev = pci_dev;
609 vnet_state->pci_bus = pci_bus;
612 virtio_reset(vnet_state);
614 V3_Print("Registering Virtio device as vnet bridge\n");
615 v3_vnet_add_bridge(vm, vnet_pkt_input_cb, (void *)vnet_state);
621 device_register("LNX_VIRTIO_VNET", dev_init)