palacios/src/devices/lnx_virtio_nic.c

   1
   2 /*
   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.
   6  *
   7  * The V3VEE Project is a joint project between Northwestern University
   8  * and the University of New Mexico.  You can find out more at
   9  * http://www.v3vee.org
  10  *
  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.
  15  *
  16  * Author: Lei Xia <lxia@northwestern.edu>
  17  *         Cui Zheng <cuizheng@cs.unm.edu>
  18  *
  19  *
  20  * This is free software.  You are permitted to use,
  21  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  22  */
  23
  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>
  35
  36
  37 #ifndef V3_CONFIG_DEBUG_VIRTIO_NET
  38 #undef PrintDebug
  39 #define PrintDebug(fmt, args...)
  40 #endif
  41
  42 #ifndef V3_CONFIG_VNET
  43 static int net_debug = 0;
  44 #endif
  45
  46 #define TX_QUEUE_SIZE 4096
  47 #define RX_QUEUE_SIZE 4096
  48 #define CTRL_QUEUE_SIZE 64
  49
  50 /* The feature bitmap for virtio nic
  51   * from Linux */
  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 */
  66
  67 /* Port to get virtio config */
  68 #define VIRTIO_NET_CONFIG 20
  69
  70 #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10))
  71
  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 */
  78
  79
  80 /* for flags in virtio_net_hdr */
  81 #define VIRTIO_NET_HDR_F_NEEDS_CSUM     1       /* Use csum_start, csum_offset */
  82
  83
  84 /* First element of the scatter-gather list, used with GSO or CSUM features */
  85 struct virtio_net_hdr
  86 {
  87     uint8_t flags;
  88     uint8_t gso_type;
  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));
  94
  95
  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 */
 101 };
 102
 103 struct virtio_net_config
 104 {
 105     uint8_t mac[ETH_ALEN];      /* VIRTIO_NET_F_MAC */
 106     uint16_t status;
 107 } __attribute__((packed));
 108
 109 struct virtio_dev_state {
 110     struct vm_device * pci_bus;
 111     struct list_head dev_list;
 112     struct v3_vm_info *vm;
 113
 114     uint8_t mac[ETH_ALEN];
 115 };
 116
 117 struct virtio_net_state {
 118     struct virtio_net_config net_cfg;
 119     struct virtio_config virtio_cfg;
 120
 121     struct v3_vm_info * vm;
 122     struct vm_device * dev;
 123     struct pci_device * pci_dev;
 124     int io_range_size;
 125
 126     uint16_t status;
 127
 128     struct virtio_queue rx_vq;          /* idx 0*/
 129     struct virtio_queue tx_vq;          /* idx 1*/
 130     struct virtio_queue ctrl_vq;        /* idx 2*/
 131
 132     uint8_t mergeable_rx_bufs;
 133
 134     struct v3_timer * timer;
 135     struct nic_statistics stats;
 136
 137     struct v3_dev_net_ops * net_ops;
 138     v3_lock_t rx_lock, tx_lock;
 139
 140     uint8_t tx_notify, rx_notify;
 141     uint32_t tx_pkts, rx_pkts;
 142     uint64_t past_us;
 143
 144     void * backend_data;
 145     struct virtio_dev_state * virtio_dev;
 146     struct list_head dev_link;
 147 };
 148
 149
 150 static int virtio_init_state(struct virtio_net_state * virtio)
 151 {
 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;
 155
 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;
 161
 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;
 167
 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;
 173
 174     virtio->virtio_cfg.pci_isr = 0;
 175
 176     virtio->mergeable_rx_bufs = 1;
 177
 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);
 181     }
 182
 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");
 186     }
 187
 188     return 0;
 189 }
 190
 191 static int tx_one_pkt(struct guest_info * core,
 192                       struct virtio_net_state * virtio,
 193                       struct vring_desc * buf_desc)
 194 {
 195     uint8_t * buf = NULL;
 196     uint32_t len = buf_desc->length;
 197
 198     if (v3_gpa_to_hva(core, buf_desc->addr_gpa, (addr_t *)&(buf)) == -1) {
 199         PrintDebug("Could not translate buffer address\n");
 200         return -1;
 201     }
 202
 203     V3_Net_Print(2, "Virtio-NIC: virtio_tx: size: %d\n", len);
 204     if(net_debug >= 4){
 205         v3_hexdump(buf, len, NULL, 0);
 206     }
 207
 208     if(virtio->net_ops->send(buf, len, virtio->backend_data) < 0){
 209         virtio->stats.tx_dropped ++;
 210         return -1;
 211     }
 212
 213     virtio->stats.tx_pkts ++;
 214     virtio->stats.tx_bytes += len;
 215
 216     return 0;
 217 }
 218
 219
 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,
 224                                     uchar_t * buf,
 225                                     uint_t buf_len,
 226                                     uint_t dst_offset){
 227     uint32_t len;
 228     uint8_t * desc_buf = NULL;
 229
 230     if (v3_gpa_to_hva(core, desc->addr_gpa, (addr_t *)&(desc_buf)) == -1) {
 231         PrintDebug("Could not translate buffer address\n");
 232         return -1;
 233     }
 234     len = (desc->length < (buf_len+dst_offset))?(desc->length - dst_offset):buf_len;
 235     memcpy(desc_buf + dst_offset, buf, len);
 236
 237     return len;
 238 }
 239
 240
 241 static inline int get_desc_count(struct virtio_queue * q, int index) {
 242     struct vring_desc * tmp_desc = &(q->desc[index]);
 243     int cnt = 1;
 244
 245     while (tmp_desc->flags & VIRTIO_NEXT_FLAG) {
 246         tmp_desc = &(q->desc[tmp_desc->next]);
 247         cnt++;
 248     }
 249
 250     return cnt;
 251 }
 252
 253 static inline void enable_cb(struct virtio_queue *queue){
 254     if(queue->used){
 255         queue->used->flags &= ~ VRING_NO_NOTIFY_FLAG;
 256     }
 257 }
 258
 259 static inline void disable_cb(struct virtio_queue *queue) {
 260     if(queue->used){
 261         queue->used->flags |= VRING_NO_NOTIFY_FLAG;
 262     }
 263 }
 264
 265 static int handle_pkt_tx(struct guest_info * core,
 266                          struct virtio_net_state * virtio_state,
 267                          int quote)
 268 {
 269     struct virtio_queue * q;
 270     int txed = 0, left = 0;
 271     unsigned long flags;
 272
 273     q = &(virtio_state->tx_vq);
 274     if (!q->ring_avail_addr) {
 275         return -1;
 276     }
 277
 278     while (1) {
 279         struct vring_desc * hdr_desc = NULL;
 280         addr_t hdr_addr = 0;
 281         uint16_t desc_idx, tmp_idx;
 282         int desc_cnt;
 283
 284         flags = v3_lock_irqsave(virtio_state->tx_lock);
 285
 286         if(q->cur_avail_idx == q->avail->index ||
 287             (quote > 0 && txed >= quote)) {
 288             left = (q->cur_avail_idx != q->avail->index);
 289             v3_unlock_irqrestore(virtio_state->tx_lock, flags);
 290             break;
 291         }
 292
 293         desc_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
 294         tmp_idx = q->cur_avail_idx ++;
 295
 296         v3_unlock_irqrestore(virtio_state->tx_lock, flags);
 297
 298         desc_cnt = get_desc_count(q, desc_idx);
 299         if(desc_cnt != 2){
 300             PrintError("VNIC: merged rx buffer not supported, desc_cnt %d\n", desc_cnt);
 301         }
 302
 303         hdr_desc = &(q->desc[desc_idx]);
 304         if (v3_gpa_to_hva(core, hdr_desc->addr_gpa, &(hdr_addr)) != -1) {
 305             struct virtio_net_hdr_mrg_rxbuf * hdr;
 306             struct vring_desc * buf_desc;
 307
 308             hdr = (struct virtio_net_hdr_mrg_rxbuf *)hdr_addr;
 309             desc_idx = hdr_desc->next;
 310
 311             /* here we assumed that one ethernet pkt is not splitted into multiple buffer */
 312             buf_desc = &(q->desc[desc_idx]);
 313             if (tx_one_pkt(core, virtio_state, buf_desc) == -1) {
 314                 PrintError("Virtio NIC: Fails to send packet\n");
 315             }
 316         } else {
 317             PrintError("Could not translate block header address\n");
 318         }
 319
 320         flags = v3_lock_irqsave(virtio_state->tx_lock);
 321
 322         q->used->ring[q->used->index % q->queue_size].id =
 323             q->avail->ring[tmp_idx % q->queue_size];
 324
 325         q->used->index ++;
 326
 327         v3_unlock_irqrestore(virtio_state->tx_lock, flags);
 328
 329         txed ++;
 330     }
 331
 332     if (txed && !(q->avail->flags & VIRTIO_NO_IRQ_FLAG)) {
 333         v3_pci_raise_irq(virtio_state->virtio_dev->pci_bus,
 334                          virtio_state->pci_dev, 0);
 335         virtio_state->virtio_cfg.pci_isr = 0x1;
 336         virtio_state->stats.rx_interrupts ++;
 337     }
 338
 339     return left;
 340 }
 341
 342
 343 static int virtio_setup_queue(struct guest_info *core,
 344                               struct virtio_net_state * virtio_state,
 345                               struct virtio_queue * queue,
 346                               addr_t pfn, addr_t page_addr) {
 347     queue->pfn = pfn;
 348
 349     queue->ring_desc_addr = page_addr;
 350     queue->ring_avail_addr = page_addr + (queue->queue_size * sizeof(struct vring_desc));
 351     queue->ring_used_addr = ((queue->ring_avail_addr) +
 352                              (sizeof(struct vring_avail)) +
 353                              (queue->queue_size * sizeof(uint16_t)));
 354
 355     // round up to next page boundary.
 356     queue->ring_used_addr = (queue->ring_used_addr + 0xfff) & ~0xfff;
 357     if (v3_gpa_to_hva(core, queue->ring_desc_addr, (addr_t *)&(queue->desc)) == -1) {
 358         PrintError("Could not translate ring descriptor address\n");
 359          return -1;
 360     }
 361
 362     if (v3_gpa_to_hva(core, queue->ring_avail_addr, (addr_t *)&(queue->avail)) == -1) {
 363         PrintError("Could not translate ring available address\n");
 364         return -1;
 365     }
 366
 367     if (v3_gpa_to_hva(core, queue->ring_used_addr, (addr_t *)&(queue->used)) == -1) {
 368         PrintError("Could not translate ring used address\n");
 369         return -1;
 370     }
 371
 372     PrintDebug("RingDesc_addr=%p, Avail_addr=%p, Used_addr=%p\n",
 373                (void *)(queue->ring_desc_addr),
 374                (void *)(queue->ring_avail_addr),
 375                (void *)(queue->ring_used_addr));
 376
 377     PrintDebug("RingDesc=%p, Avail=%p, Used=%p\n",
 378                queue->desc, queue->avail, queue->used);
 379
 380     return 0;
 381 }
 382
 383 static int virtio_io_write(struct guest_info *core,
 384                            uint16_t port, void * src,
 385                            uint_t length, void * private_data)
 386 {
 387     struct virtio_net_state * virtio = (struct virtio_net_state *)private_data;
 388     int port_idx = port % virtio->io_range_size;
 389
 390     PrintDebug("VIRTIO NIC %p Write for port %d (index=%d) len=%d, value=%x\n",
 391                private_data, port, port_idx,
 392                length, *(uint32_t *)src);
 393
 394     switch (port_idx) {
 395         case GUEST_FEATURES_PORT:
 396             if (length != 4) {
 397                 PrintError("Illegal write length for guest features\n");
 398                 return -1;
 399             }
 400             virtio->virtio_cfg.guest_features = *(uint32_t *)src;
 401             break;
 402
 403         case VRING_PG_NUM_PORT:
 404             if (length != 4) {
 405                 PrintError("Illegal write length for page frame number\n");
 406                 return -1;
 407             }
 408             addr_t pfn = *(uint32_t *)src;
 409             addr_t page_addr = (pfn << VIRTIO_PAGE_SHIFT);
 410             uint16_t queue_idx = virtio->virtio_cfg.vring_queue_selector;
 411             switch (queue_idx) {
 412                 case 0:
 413                     virtio_setup_queue(core, virtio,
 414                                        &virtio->rx_vq,
 415                                        pfn, page_addr);
 416                     break;
 417                 case 1:
 418                     virtio_setup_queue(core, virtio,
 419                                        &virtio->tx_vq,
 420                                        pfn, page_addr);
 421                     if(virtio->tx_notify == 0){
 422                         disable_cb(&virtio->tx_vq);
 423                     }
 424                     virtio->status = 1;
 425                     break;
 426                 case 2:
 427                     virtio_setup_queue(core, virtio,
 428                                        &virtio->ctrl_vq,
 429                                        pfn, page_addr);
 430                     break;
 431                 default:
 432                     break;
 433             }
 434             break;
 435
 436         case VRING_Q_SEL_PORT:
 437             virtio->virtio_cfg.vring_queue_selector = *(uint16_t *)src;
 438             if (virtio->virtio_cfg.vring_queue_selector > 2) {
 439                 PrintError("Virtio NIC: wrong queue idx: %d\n",
 440                            virtio->virtio_cfg.vring_queue_selector);
 441                 return -1;
 442             }
 443             break;
 444
 445         case VRING_Q_NOTIFY_PORT:
 446             {
 447                 uint16_t queue_idx = *(uint16_t *)src;
 448                 if (queue_idx == 0){
 449                     /* receive queue refill */
 450                     virtio->stats.tx_interrupts ++;
 451                 } else if (queue_idx == 1){
 452                     if (handle_pkt_tx(core, virtio, 0) < 0) {
 453                         PrintError("Virtio NIC: Error to handle packet TX\n");
 454                         return -1;
 455                     }
 456                     virtio->stats.tx_interrupts ++;
 457                 } else if (queue_idx == 2){
 458                     /* ctrl */
 459                 } else {
 460                     PrintError("Virtio NIC: Wrong queue index %d\n", queue_idx);
 461                 }
 462                 break;
 463             }
 464
 465         case VIRTIO_STATUS_PORT:
 466             virtio->virtio_cfg.status = *(uint8_t *)src;
 467             if (virtio->virtio_cfg.status == 0) {
 468                 virtio_init_state(virtio);
 469             }
 470             break;
 471
 472         case VIRTIO_ISR_PORT:
 473             virtio->virtio_cfg.pci_isr = *(uint8_t *)src;
 474             break;
 475
 476         default:
 477             return -1;
 478             break;
 479     }
 480
 481     return length;
 482 }
 483
 484 static int virtio_io_read(struct guest_info *core,
 485                           uint16_t port, void * dst,
 486                           uint_t length, void * private_data)
 487 {
 488     struct virtio_net_state * virtio = (struct virtio_net_state *)private_data;
 489     int port_idx = port % virtio->io_range_size;
 490     uint16_t queue_idx = virtio->virtio_cfg.vring_queue_selector;
 491
 492     PrintDebug("Virtio NIC %p: Read  for port 0x%x (index =%d), length=%d\n",
 493                private_data, port, port_idx, length);
 494
 495     switch (port_idx) {
 496         case HOST_FEATURES_PORT:
 497             if (length != 4) {
 498                 PrintError("Virtio NIC: Illegal read length for host features\n");
 499                 //return -1;
 500             }
 501             *(uint32_t *)dst = virtio->virtio_cfg.host_features;
 502             break;
 503
 504         case VRING_PG_NUM_PORT:
 505             if (length != 4) {
 506                 PrintError("Virtio NIC: Illegal read length for page frame number\n");
 507                 return -1;
 508             }
 509             switch (queue_idx) {
 510                 case 0:
 511                     *(uint32_t *)dst = virtio->rx_vq.pfn;
 512                     break;
 513                 case 1:
 514                     *(uint32_t *)dst = virtio->tx_vq.pfn;
 515                     break;
 516                 case 2:
 517                     *(uint32_t *)dst = virtio->ctrl_vq.pfn;
 518                     break;
 519                 default:
 520                     break;
 521             }
 522             break;
 523
 524         case VRING_SIZE_PORT:
 525             if (length != 2) {
 526                 PrintError("Virtio NIC: Illegal read length for vring size\n");
 527                 return -1;
 528             }
 529             switch (queue_idx) {
 530                 case 0:
 531                     *(uint16_t *)dst = virtio->rx_vq.queue_size;
 532                     break;
 533                 case 1:
 534                     *(uint16_t *)dst = virtio->tx_vq.queue_size;
 535                     break;
 536                 case 2:
 537                     *(uint16_t *)dst = virtio->ctrl_vq.queue_size;
 538                     break;
 539                 default:
 540                     break;
 541             }
 542             break;
 543
 544         case VIRTIO_STATUS_PORT:
 545             if (length != 1) {
 546                 PrintError("Virtio NIC: Illegal read length for status\n");
 547                 return -1;
 548             }
 549             *(uint8_t *)dst = virtio->virtio_cfg.status;
 550             break;
 551
 552         case VIRTIO_ISR_PORT:
 553             *(uint8_t *)dst = virtio->virtio_cfg.pci_isr;
 554             virtio->virtio_cfg.pci_isr = 0;
 555             v3_pci_lower_irq(virtio->virtio_dev->pci_bus,
 556                              virtio->pci_dev, 0);
 557             break;
 558
 559         case VIRTIO_NET_CONFIG ... VIRTIO_NET_CONFIG + ETH_ALEN:
 560             *(uint8_t *)dst = virtio->net_cfg.mac[port_idx-VIRTIO_NET_CONFIG];
 561             break;
 562
 563         default:
 564             PrintError("Virtio NIC: Read of Unhandled Virtio Read:%d\n",
 565                        port_idx);
 566             return -1;
 567     }
 568
 569     return length;
 570 }
 571
 572
 573 /* receiving raw ethernet pkt from backend */
 574 static int virtio_rx(uint8_t * buf, uint32_t size, void * private_data) {
 575     struct virtio_net_state * virtio = (struct virtio_net_state *)private_data;
 576     struct virtio_queue * q = &(virtio->rx_vq);
 577     struct virtio_net_hdr_mrg_rxbuf hdr;
 578     unsigned long flags;
 579     uint8_t kick_guest = 0;
 580
 581     V3_Net_Print(2, "Virtio NIC: virtio_rx: size: %d\n", size);
 582
 583     if (!q->ring_avail_addr) {
 584         V3_Net_Print(2, "Virtio NIC: RX Queue not set\n");
 585         virtio->stats.rx_dropped ++;
 586
 587         return -1;
 588     }
 589
 590     memset(&hdr, 0, sizeof(struct virtio_net_hdr_mrg_rxbuf));
 591
 592     flags = v3_lock_irqsave(virtio->rx_lock);
 593
 594     if (q->cur_avail_idx != q->avail->index){
 595         uint16_t buf_idx;
 596         struct vring_desc * buf_desc;
 597         uint32_t hdr_len, len;
 598         uint32_t offset = 0;
 599
 600         hdr_len = (virtio->mergeable_rx_bufs)?
 601             sizeof(struct virtio_net_hdr_mrg_rxbuf):
 602             sizeof(struct virtio_net_hdr);
 603
 604         if(virtio->mergeable_rx_bufs){/* merged buffer */
 605             struct vring_desc * hdr_desc;
 606             uint16_t old_idx = q->cur_avail_idx;
 607
 608             buf_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
 609             hdr_desc = &(q->desc[buf_idx]);
 610
 611             len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
 612                                     virtio, hdr_desc, buf, size, hdr_len);
 613             if(len < 0){
 614                 goto err_exit;
 615             }
 616             offset += len;
 617
 618             q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
 619             q->used->ring[q->used->index % q->queue_size].length = hdr_len + offset;
 620             q->cur_avail_idx ++;
 621             hdr.num_buffers ++;
 622
 623             while(offset < size) {
 624                 buf_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
 625                 buf_desc = &(q->desc[buf_idx]);
 626
 627                 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
 628                                         virtio, buf_desc, buf+offset, size-offset, 0);
 629                 if (len < 0){
 630                     V3_Net_Print(2, "Virtio NIC: merged buffer, %d buffer size %d\n",
 631                                  hdr.num_buffers, len);
 632                     q->cur_avail_idx = old_idx;
 633                     goto err_exit;
 634                 }
 635                 offset += len;
 636                 buf_desc->flags &= ~VIRTIO_NEXT_FLAG;
 637
 638                 q->used->ring[(q->used->index + hdr.num_buffers) % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
 639                 q->used->ring[(q->used->index + hdr.num_buffers) % q->queue_size].length = len;
 640                 q->cur_avail_idx ++;
 641
 642                 hdr.num_buffers ++;
 643             }
 644
 645             copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
 646                               virtio, hdr_desc, (uchar_t *)&hdr, hdr_len, 0);
 647             q->used->index += hdr.num_buffers;
 648         }else{
 649             buf_idx = q->avail->ring[q->cur_avail_idx % q->queue_size];
 650             buf_desc = &(q->desc[buf_idx]);
 651
 652             /* copy header */
 653             len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
 654                                     virtio, buf_desc, (uchar_t *)&(hdr.hdr), hdr_len, 0);
 655             if(len < hdr_len){
 656                 V3_Net_Print(2, "Virtio NIC: rx copy header error %d, hdr_len %d\n",
 657                              len, hdr_len);
 658                 goto err_exit;
 659             }
 660
 661             len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
 662                                     virtio, buf_desc, buf, size, hdr_len);
 663             if(len < 0){
 664                 V3_Net_Print(2, "Virtio NIC: rx copy data error %d\n", len);
 665                 goto err_exit;
 666             }
 667             offset += len;
 668
 669             /* copy rest of data */
 670             while(offset < size &&
 671                   (buf_desc->flags & VIRTIO_NEXT_FLAG)){
 672                 buf_desc = &(q->desc[buf_desc->next]);
 673                 len = copy_data_to_desc(&(virtio->virtio_dev->vm->cores[0]),
 674                                         virtio, buf_desc, buf+offset, size-offset, 0);
 675                 if (len < 0) {
 676                     break;
 677                 }
 678                 offset += len;
 679             }
 680             buf_desc->flags &= ~VIRTIO_NEXT_FLAG;
 681
 682             if(offset < size){
 683                 V3_Net_Print(2, "Virtio NIC: rx not enough ring buffer, buffer size %d\n",
 684                              len);
 685                 goto err_exit;
 686             }
 687
 688             q->used->ring[q->used->index % q->queue_size].id = q->avail->ring[q->cur_avail_idx % q->queue_size];
 689             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) */
 690             q->used->index ++;
 691             q->cur_avail_idx ++;
 692         }
 693
 694         virtio->stats.rx_pkts ++;
 695         virtio->stats.rx_bytes += size;
 696     } else {
 697         V3_Net_Print(2, "Virtio NIC: Guest RX queue is full\n");
 698         virtio->stats.rx_dropped ++;
 699
 700         /* kick guest to refill RX queue */
 701         kick_guest = 1;
 702     }
 703
 704     v3_unlock_irqrestore(virtio->rx_lock, flags);
 705
 706     if (!(q->avail->flags & VIRTIO_NO_IRQ_FLAG) || kick_guest) {
 707         V3_Net_Print(2, "Virtio NIC: RX Raising IRQ %d\n",
 708                      virtio->pci_dev->config_header.intr_line);
 709
 710         virtio->virtio_cfg.pci_isr = 0x1;
 711         v3_pci_raise_irq(virtio->virtio_dev->pci_bus, virtio->pci_dev, 0);
 712         virtio->stats.rx_interrupts ++;
 713     }
 714
 715     /* notify guest if it is in guest mode */
 716     if((kick_guest || virtio->rx_notify == 1) &&
 717         V3_Get_CPU() != virtio->virtio_dev->vm->cores[0].pcpu_id){
 718         v3_interrupt_cpu(virtio->virtio_dev->vm,
 719                          virtio->virtio_dev->vm->cores[0].pcpu_id,
 720                          0);
 721     }
 722
 723     return 0;
 724
 725 err_exit:
 726     virtio->stats.rx_dropped ++;
 727     v3_unlock_irqrestore(virtio->rx_lock, flags);
 728
 729     return -1;
 730 }
 731
 732 static int virtio_free(struct virtio_dev_state * virtio) {
 733     struct virtio_net_state * backend = NULL;
 734     struct virtio_net_state * tmp = NULL;
 735
 736
 737     list_for_each_entry_safe(backend, tmp, &(virtio->dev_list), dev_link) {
 738
 739         // unregister from PCI
 740
 741         list_del(&(backend->dev_link));
 742         V3_Free(backend);
 743     }
 744
 745     V3_Free(virtio);
 746     return 0;
 747 }
 748
 749
 750 static struct v3_device_ops dev_ops = {
 751     .free = (int (*)(void *))virtio_free,
 752 };
 753
 754
 755 static int virtio_poll(int quote, void * data){
 756     struct virtio_net_state * virtio  = (struct virtio_net_state *)data;
 757
 758     if (virtio->status) {
 759
 760         return handle_pkt_tx(&(virtio->vm->cores[0]), virtio, quote);
 761     }
 762
 763     return 0;
 764 }
 765
 766 static int register_dev(struct virtio_dev_state * virtio,
 767                         struct virtio_net_state * net_state)
 768 {
 769     struct pci_device * pci_dev = NULL;
 770     struct v3_pci_bar bars[6];
 771     int num_ports = sizeof(struct virtio_config);
 772     int tmp_ports = num_ports;
 773     int i;
 774
 775     /* This gets the number of ports, rounded up to a power of 2 */
 776     net_state->io_range_size = 1;
 777     while (tmp_ports > 0) {
 778         tmp_ports >>= 1;
 779         net_state->io_range_size <<= 1;
 780     }
 781
 782     /* this is to account for any low order bits being set in num_ports
 783      * if there are none, then num_ports was already a power of 2 so we shift right to reset it
 784      */
 785     if ((num_ports & ((net_state->io_range_size >> 1) - 1)) == 0) {
 786         net_state->io_range_size >>= 1;
 787     }
 788
 789     for (i = 0; i < 6; i++) {
 790         bars[i].type = PCI_BAR_NONE;
 791     }
 792
 793     PrintDebug("Virtio NIC: io_range_size = %d\n",
 794                net_state->io_range_size);
 795
 796     bars[0].type = PCI_BAR_IO;
 797     bars[0].default_base_port = -1;
 798     bars[0].num_ports = net_state->io_range_size;
 799     bars[0].io_read = virtio_io_read;
 800     bars[0].io_write = virtio_io_write;
 801     bars[0].private_data = net_state;
 802
 803     pci_dev = v3_pci_register_device(virtio->pci_bus, PCI_STD_DEVICE,
 804                                      0, PCI_AUTO_DEV_NUM, 0,
 805                                      "LNX_VIRTIO_NIC", bars,
 806                                      NULL, NULL, NULL, NULL, net_state);
 807
 808     if (!pci_dev) {
 809         PrintError("Virtio NIC: Could not register PCI Device\n");
 810         return -1;
 811     }
 812
 813     PrintDebug("Virtio NIC:  registered to PCI bus\n");
 814
 815     pci_dev->config_header.vendor_id = VIRTIO_VENDOR_ID;
 816     pci_dev->config_header.subsystem_vendor_id = VIRTIO_SUBVENDOR_ID;
 817
 818
 819     pci_dev->config_header.device_id = VIRTIO_NET_DEV_ID;
 820     pci_dev->config_header.class = PCI_CLASS_NETWORK;
 821     pci_dev->config_header.subclass = PCI_NET_SUBCLASS_OTHER;
 822     pci_dev->config_header.subsystem_id = VIRTIO_NET_SUBDEVICE_ID;
 823     pci_dev->config_header.intr_pin = 1;
 824     pci_dev->config_header.max_latency = 1; // ?? (qemu does it...)
 825
 826     net_state->pci_dev = pci_dev;
 827     net_state->virtio_dev = virtio;
 828
 829     memcpy(net_state->net_cfg.mac, virtio->mac, 6);
 830
 831     virtio_init_state(net_state);
 832
 833     V3_Print("Virtio NIC: Registered Intr Line %d\n", pci_dev->config_header.intr_line);
 834
 835     /* Add backend to list of devices */
 836     list_add(&(net_state->dev_link), &(virtio->dev_list));
 837
 838     return 0;
 839 }
 840
 841 #if 0
 842 #define RATE_UPPER_THRESHOLD 10  /* 10000 pkts per second, around 100Mbits */
 843 #define RATE_LOWER_THRESHOLD 1
 844 #define PROFILE_PERIOD 10000 /*us*/
 845
 846 static void virtio_nic_timer(struct guest_info * core,
 847                              uint64_t cpu_cycles, uint64_t cpu_freq,
 848                              void * priv_data) {
 849     struct virtio_net_state * net_state = (struct virtio_net_state *)priv_data;
 850     uint64_t period_us;
 851     static int profile_ms = 0;
 852
 853     if(!net_state->status){ /* VNIC is not in working status */
 854         return;
 855     }
 856
 857     period_us = (1000*cpu_cycles)/cpu_freq;
 858     net_state->past_us += period_us;
 859
 860     if(net_state->past_us > PROFILE_PERIOD){
 861         uint32_t tx_rate, rx_rate;
 862
 863         tx_rate = (net_state->stats.tx_pkts - net_state->tx_pkts)/(net_state->past_us/1000); /* pkts/per ms */
 864         rx_rate = (net_state->stats.rx_pkts - net_state->rx_pkts)/(net_state->past_us/1000);
 865
 866         net_state->tx_pkts = net_state->stats.tx_pkts;
 867         net_state->rx_pkts = net_state->stats.rx_pkts;
 868
 869         if(tx_rate > RATE_UPPER_THRESHOLD && net_state->tx_notify == 1){
 870             V3_Print("Virtio NIC: Switch TX to VMM driven mode\n");
 871             disable_cb(&(net_state->tx_vq));
 872             net_state->tx_notify = 0;
 873         }
 874
 875         if(tx_rate < RATE_LOWER_THRESHOLD && net_state->tx_notify == 0){
 876             V3_Print("Virtio NIC: Switch TX to Guest  driven mode\n");
 877             enable_cb(&(net_state->tx_vq));
 878             net_state->tx_notify = 1;
 879         }
 880
 881         if(rx_rate > RATE_UPPER_THRESHOLD && net_state->rx_notify == 1){
 882             V3_Print("Virtio NIC: Switch RX to VMM None notify mode\n");
 883             net_state->rx_notify = 0;
 884         }
 885
 886         if(rx_rate < RATE_LOWER_THRESHOLD && net_state->rx_notify == 0){
 887             V3_Print("Virtio NIC: Switch RX to VMM notify mode\n");
 888             net_state->rx_notify = 1;
 889         }
 890
 891         net_state->past_us = 0;
 892     }
 893
 894     profile_ms += period_us/1000;
 895     if(profile_ms > 20000){
 896         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",
 897                 net_state->stats.tx_pkts, net_state->stats.tx_bytes,
 898                 net_state->stats.rx_pkts, net_state->stats.rx_bytes,
 899                 net_state->stats.tx_dropped, net_state->stats.rx_dropped,
 900                 net_state->stats.tx_interrupts, net_state->stats.rx_interrupts,
 901                 net_state->vm->cores[0].num_exits);
 902         profile_ms = 0;
 903     }
 904 }
 905
 906 static struct v3_timer_ops timer_ops = {
 907     .update_timer = virtio_nic_timer,
 908 };
 909 #endif
 910
 911 static int connect_fn(struct v3_vm_info * info,
 912                       void * frontend_data,
 913                       struct v3_dev_net_ops * ops,
 914                       v3_cfg_tree_t * cfg,
 915                       void * private_data) {
 916     struct virtio_dev_state * virtio = (struct virtio_dev_state *)frontend_data;
 917     struct virtio_net_state * net_state  = (struct virtio_net_state *)V3_Malloc(sizeof(struct virtio_net_state));
 918
 919     if (!net_state) {
 920         PrintError("Cannot allocate in connect\n");
 921         return -1;
 922     }
 923
 924     memset(net_state, 0, sizeof(struct virtio_net_state));
 925     register_dev(virtio, net_state);
 926
 927     net_state->vm = info;
 928     net_state->net_ops = ops;
 929     net_state->backend_data = private_data;
 930     net_state->virtio_dev = virtio;
 931
 932     net_state->tx_notify = 1;
 933     net_state->rx_notify = 1;
 934
 935     //net_state->timer = v3_add_timer(&(info->cores[0]), &timer_ops,net_state);
 936
 937     ops->recv = virtio_rx;
 938     ops->poll = virtio_poll;
 939     ops->config.frontend_data = net_state;
 940     ops->config.poll = 1;
 941     ops->config.quote = 64;
 942     ops->config.fnt_mac = V3_Malloc(ETH_ALEN);
 943     memcpy(ops->config.fnt_mac, virtio->mac, ETH_ALEN);
 944
 945     return 0;
 946 }
 947
 948 static int virtio_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
 949     struct vm_device * pci_bus = v3_find_dev(vm, v3_cfg_val(cfg, "bus"));
 950     struct virtio_dev_state * virtio_state = NULL;
 951     char * dev_id = v3_cfg_val(cfg, "ID");
 952     char macstr[128];
 953     char * str = v3_cfg_val(cfg, "mac");
 954     memcpy(macstr, str, strlen(str));
 955
 956     if (pci_bus == NULL) {
 957         PrintError("Virtio NIC: Virtio device require a PCI Bus");
 958         return -1;
 959     }
 960
 961     virtio_state  = (struct virtio_dev_state *)V3_Malloc(sizeof(struct virtio_dev_state));
 962
 963     if (!virtio_state) {
 964         PrintError("Cannot allocate in init\n");
 965         return -1;
 966     }
 967
 968     memset(virtio_state, 0, sizeof(struct virtio_dev_state));
 969
 970     INIT_LIST_HEAD(&(virtio_state->dev_list));
 971     virtio_state->pci_bus = pci_bus;
 972     virtio_state->vm = vm;
 973
 974     if (macstr != NULL && !str2mac(macstr, virtio_state->mac)) {
 975         PrintDebug("Virtio NIC: Mac specified %s\n", macstr);
 976     }else {
 977         random_ethaddr(virtio_state->mac);
 978     }
 979
 980     struct vm_device * dev = v3_add_device(vm, dev_id, &dev_ops, virtio_state);
 981
 982     if (dev == NULL) {
 983         PrintError("Virtio NIC: Could not attach device %s\n", dev_id);
 984         V3_Free(virtio_state);
 985         return -1;
 986     }
 987
 988     if (v3_dev_add_net_frontend(vm, dev_id, connect_fn, (void *)virtio_state) == -1) {
 989         PrintError("Virtio NIC: Could not register %s as net frontend\n", dev_id);
 990         v3_remove_device(dev);
 991         return -1;
 992     }
 993
 994     return 0;
 995 }
 996
 997 device_register("LNX_VIRTIO_NIC", virtio_init)
 998