Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


reworked device IO hook framework
[palacios.git] / palacios / src / palacios / vmm_dev_mgr.c
index 81f053c..4783492 100644 (file)
+/* 
+ * This file is part of the Palacios Virtual Machine Monitor developed
+ * by the V3VEE Project with funding from the United States National 
+ * Science Foundation and the Department of Energy.  
+ *
+ * The V3VEE Project is a joint project between Northwestern University
+ * and the University of New Mexico.  You can find out more at 
+ * http://www.v3vee.org
+ *
+ * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
+ * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
+ * All rights reserved.
+ *
+ * Author: Jack Lange <jarusl@cs.northwestern.edu>
+ *
+ * This is free software.  You are permitted to use,
+ * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
+ */
 
-#include <palacios/vmm_dev.h>
 #include <palacios/vmm_dev_mgr.h>
 #include <palacios/vm_guest.h>
 #include <palacios/vmm.h>
+#include <palacios/vmm_decoder.h>
 
-extern struct vmm_os_hooks *os_hooks;
 
-#ifndef NULL
-#define NULL 0
+#ifndef CONFIG_DEBUG_DEV_MGR
+#undef PrintDebug
+#define PrintDebug(fmt, args...)
 #endif
 
-int dev_mgr_init(struct vmm_dev_mgr *mgr, struct guest_info *vm)
-{
-  mgr->vm=vm;
-  mgr->dev_list=NULL;
-  mgr->num_devices=0;
-  return 0;
+
+static struct hashtable * master_dev_table = NULL;
+
+static uint_t dev_hash_fn(addr_t key) {
+    char * name = (char *)key;
+    return v3_hash_buffer((uchar_t *)name, strlen(name));
 }
 
+static int dev_eq_fn(addr_t key1, addr_t key2) {
+    char * name1 = (char *)key1;
+    char * name2 = (char *)key2;
+    
+    return (strcmp(name1, name2) == 0);
+}
+
+
+int v3_init_devices() {
+    extern struct v3_device_info __start__v3_devices[];
+    extern struct v3_device_info __stop__v3_devices[];
+    struct v3_device_info * tmp_dev =  __start__v3_devices;
+    int i = 0;
+
+#ifdef CONFIG_DEBUG_DEV_MGR
+    {
+       int num_devices = (__stop__v3_devices - __start__v3_devices) / sizeof(struct v3_device_info);
+       PrintDebug("%d Virtual devices registered with Palacios\n", num_devices);
+    }
+#endif
+
+    PrintDebug("Start addres=%p, Stop address=%p\n", __start__v3_devices, __stop__v3_devices);
+
+    master_dev_table = v3_create_htable(0, dev_hash_fn, dev_eq_fn);
+
 
-int dev_mgr_deinit(struct vmm_dev_mgr *mgr)
-{
-  int rc;
 
-  while (mgr->dev_list) { 
-    rc=dev_mgr_detach_device(mgr->vm,mgr->dev_list);
-    if (rc) { 
-      // Bad bad bad
+    while (tmp_dev != __stop__v3_devices) {
+       PrintDebug("Device: %s\n", tmp_dev->name);
+
+       if (v3_htable_search(master_dev_table, (addr_t)(tmp_dev->name))) {
+           PrintError("Multiple instance of device (%s)\n", tmp_dev->name);
+           return -1;
+       }
+
+       if (v3_htable_insert(master_dev_table, 
+                            (addr_t)(tmp_dev->name), 
+                            (addr_t)(tmp_dev->init)) == 0) {
+           PrintError("Could not add device %s to master list\n", tmp_dev->name);
+           return -1;
+       }
+
+       tmp_dev = &(__start__v3_devices[++i]);
     }
-  }
-  return 0;
+
+
+    return 0;
 }
 
-int dev_mgr_attach_device(struct guest_info *vm, struct vm_device *device)
-{
-  struct vmm_dev_mgr *mgr= &(vm->dev_mgr);
-  
-  if (device->io_hooks || device->mem_hooks) { 
-    return -1;
-  }
-
-  device->next = mgr->dev_list;
-  device->prev = 0;
-  if (device->next) { 
-    device->next->prev = device;
-  }
-  mgr->dev_list = device;
-  
-  device->vm=vm;
-
-  return 0;
+
+int v3_init_dev_mgr(struct v3_vm_info * vm) {
+    struct vmm_dev_mgr * mgr = &(vm->dev_mgr);
+
+    INIT_LIST_HEAD(&(mgr->dev_list));
+    mgr->num_devs = 0;
+
+    mgr->dev_table = v3_create_htable(0, dev_hash_fn, dev_eq_fn);
+
+    INIT_LIST_HEAD(&(mgr->blk_list));
+    INIT_LIST_HEAD(&(mgr->net_list));
+    INIT_LIST_HEAD(&(mgr->char_list));
+    INIT_LIST_HEAD(&(mgr->console_list));
+
+    mgr->blk_table = v3_create_htable(0, dev_hash_fn, dev_eq_fn);
+    mgr->net_table = v3_create_htable(0, dev_hash_fn, dev_eq_fn);
+    mgr->char_table = v3_create_htable(0, dev_hash_fn, dev_eq_fn);
+    mgr->console_table = v3_create_htable(0, dev_hash_fn, dev_eq_fn);
+    
+    return 0;
 }
 
-int dev_mgr_detach_device(struct guest_info *vm, struct vm_device *device)
-{
-  if (device->prev==0) { 
-    vm->dev_mgr.dev_list = device->next;
-  } else {
-    device->prev->next = device->next;
-  }
-  if (device->next) { 
-    device->next->prev=device->prev;
-  }
-  
-  // avoid interrupts here
-
-  device->deinit_device(device);
-
-  device->vm=NULL;
-  return 0;
+
+int v3_dev_mgr_deinit(struct v3_vm_info * vm) {
+    struct vm_device * dev;
+    struct vmm_dev_mgr * mgr = &(vm->dev_mgr);
+    struct vm_device * tmp;
+
+    list_for_each_entry_safe(dev, tmp, &(mgr->dev_list), dev_link) {
+       v3_detach_device(dev);
+    }
+
+    v3_free_htable(mgr->blk_table, 0, 0);
+    v3_free_htable(mgr->net_table, 0, 0);
+    v3_free_htable(mgr->char_table, 0, 0);
+    v3_free_htable(mgr->console_table, 0, 0);
+
+    v3_free_htable(mgr->dev_table, 0, 0);
+
+    return 0;
 }
 
 
-#define INSERT_FRONT(listhead,item)         \
-  do {                                      \
-    if (!(listhead)) {                      \
-      (listhead)=(item);                    \
-      (item)->prev=NULL;                    \
-      (item)->next=NULL;                    \
-    }  else {                               \
-      (item)->prev=NULL;                    \
-      (item)->next=(listhead);              \
-      if ((listhead)->next) {               \
-       (listhead)->next->prev=(item);      \
-      }                                     \
-      (listhead)=(item);                    \
-    }                                       \
-  } while (0)
-
-#define DELETE(listhead,item)               \
-  do {                                      \
-    if ((item)->prev) {                     \
-      (item)->prev->next=(item)->next;      \
-    } else {                                \
-      (listhead)=(item)->next;              \
-    }                                       \
-    if ((item)->next) {                     \
-      (item)->next->prev=(item)->prev;      \
-    }                                       \
-  } while (0)
-    
 
-   
+int v3_create_device(struct v3_vm_info * vm, const char * dev_name, v3_cfg_tree_t * cfg) {
+    int (*dev_init)(struct v3_vm_info * vm, void * cfg_data);
 
-int dev_mgr_hook_io(struct guest_info    *vm,
-                   struct vm_device   *device,
-                   ushort_t            portno,
-                   enum access_control control,
-                   enum access_type    atype)
-{
-  struct vm_device_io_hook *hook = os_hooks->malloc(sizeof(struct vm_device_io_hook));
-  
-  if (!hook) { 
-    return -1;
-  }
-
-  int (*read)(ushort_t, void *, uint_t, void *) = NULL;
-  int (*write)(ushort_t, void *, uint_t, void *) = NULL;
-
-  switch (control) { 
-  case DEVICE_EMULATED:
-    switch (atype) { 
-    case DEVICE_READ:
-      read = (int (*)(ushort_t, void *,uint_t, void *))  (device->read_io_port);
-      break;
-    case DEVICE_WRITE:
-      write = (int (*)(ushort_t, void *, uint_t, void *)) (device->write_io_port);
-      break;
-    case DEVICE_READWRITE:
-      read = (int (*)(ushort_t, void *, uint_t, void *)) (device->read_io_port);
-      write = (int (*)(ushort_t, void *, uint_t, void *)) (device->write_io_port);
-      break;
+    dev_init = (void *)v3_htable_search(master_dev_table, (addr_t)dev_name);
+
+    if (dev_init == NULL) {
+       PrintError("Could not find device %s in master device table\n", dev_name);
+       return -1;
+    }
+
+
+    if (dev_init(vm, cfg) == -1) {
+       PrintError("Could not initialize Device %s\n", dev_name);
+       return -1;
+    }
+
+    return 0;
+}
+
+
+void v3_free_device(struct vm_device * dev) {
+    V3_Free(dev);
+}
+
+
+
+struct vm_device * v3_find_dev(struct v3_vm_info * vm, const char * dev_name) {
+    struct vmm_dev_mgr * mgr = &(vm->dev_mgr);
+
+    if (!dev_name) {
+       return NULL;
     }
-    break;
-  case DEVICE_PASSTHROUGH:
-    read=write=NULL;
-    break;
-  }
+
+    return (struct vm_device *)v3_htable_search(mgr->dev_table, (addr_t)dev_name);
+}
+
+
+/****************************************************************/
+/* The remaining functions are called by the devices themselves */
+/****************************************************************/
+
+struct dev_io_hook {
+    uint16_t port;
+
+    struct list_head node;
+
+};
+
+/* IO HOOKS */
+int v3_dev_hook_io(struct vm_device * dev, uint16_t port,
+                  int (*read)(struct guest_info * core, uint16_t port, void * dst, uint_t length, void * priv_data),
+                  int (*write)(struct guest_info * core, uint16_t port, void * src, uint_t length, void * priv_data)) {
+    struct dev_io_hook * io_hook = NULL;
+    int ret = 0;
     
-  hook_io_port(&(vm->io_map), 
-              portno, 
-              read,
-              write,
-              device);
-
-  hook->control=control;
-  hook->atype=atype;
-  hook->guest_port = portno;
-  
-  INSERT_FRONT(device->io_hooks,hook);
-  
-  return 0;
+   ret = v3_hook_io_port(dev->vm, port, 
+                        (int (*)(struct guest_info * core, ushort_t, void *, uint_t, void *))read, 
+                        (int (*)(struct guest_info * core, ushort_t, void *, uint_t, void *))write, 
+                        (void *)dev->private_data);
+
+   if (ret == -1) {
+       return -1;
+   }
+
+   io_hook = V3_Malloc(sizeof(struct dev_io_hook));
+
+   if (io_hook == NULL) {
+       PrintError("Could not allocate io hook dev state\n");
+       return -1;
+   }
+
+   io_hook->port = port;
+   list_add(&(io_hook->node), &(dev->io_hooks));
+
+   return 0;
 }
 
 
-int dev_mgr_unhook_io(struct guest_info    *vm,
-                     struct vm_device   *device,
-                     ushort_t            portno)
-{
-  struct vm_device_io_hook *hook = device->io_hooks;
+int v3_dev_unhook_io(struct vm_device * dev, uint16_t port) {
+    struct dev_io_hook * io_hook = NULL;
+    struct dev_io_hook * tmp;
 
-  while (hook) { 
-    if (hook->guest_port==portno) { 
-      DELETE(device->io_hooks,hook);
-      break;
+    list_for_each_entry_safe(io_hook, tmp, &(dev->io_hooks), node) {
+       if (io_hook->port == port) {
+
+           list_del(&(io_hook->node));
+           V3_Free(io_hook);
+           
+           return v3_unhook_io_port(dev->vm, port);        
+       }
     }
-  }
 
-  if (!hook) { 
-    // Very bad - unhooking something that doesn't exist!
     return -1;
-  }
-
-  return unhook_io_port(&(vm->io_map),
-                       portno);
 }
 
 
 
-int dev_mgr_hook_mem(struct guest_info    *vm,
-                    struct vm_device   *device,
-                    void               *guest_physical_address_start,
-                    void               *guest_physical_address_end,
-                    enum access_control control,
-                    enum access_type    atype)
-{
+int v3_detach_device(struct vm_device * dev) {
+    struct vmm_dev_mgr * mgr = &(dev->vm->dev_mgr);
+
+    if (dev->ops->free) {
+       dev->ops->free(dev);
+    } else {
+       PrintError("Error: %s free() not implemented\n",  dev->name);
+    }
+
+    list_del(&(dev->dev_link));
+    mgr->num_devs--;
 
-  struct vm_device_mem_hook *hook = os_hooks->malloc(sizeof(struct vm_device_mem_hook));
-  
-  if (!hook) { 
+    dev->vm = NULL;
+
+    v3_free_device(dev);
     return -1;
-  }
-
-  int (*read)(ushort_t, void *, uint_t, void *) = NULL;
-  int (*write)(ushort_t, void *, uint_t, void *) = NULL;
-
-  switch (control) { 
-  case DEVICE_EMULATED:
-    switch (atype) { 
-    case DEVICE_READ:
-      read = (int (*)(ushort_t, void *, uint_t, void *))(device->read_mapped_memory);
-      break;
-    case DEVICE_WRITE:
-      write = (int (*)(ushort_t, void *, uint_t, void *))(device->write_mapped_memory);
-      break;
-    case DEVICE_READWRITE:
-      read = (int (*)(ushort_t, void *, uint_t, void *))(device->read_mapped_memory);
-      write = (int (*)(ushort_t, void *, uint_t, void *))(device->write_mapped_memory);
-      break;
+}
+
+
+struct vm_device * v3_allocate_device(char * name, 
+                                     struct v3_device_ops * ops, 
+                                     void * private_data) {
+    struct vm_device * dev = NULL;
+
+    dev = (struct vm_device*)V3_Malloc(sizeof(struct vm_device));
+
+    INIT_LIST_HEAD(&(dev->io_hooks));
+
+    strncpy(dev->name, name, 32);
+    dev->ops = ops;
+    dev->private_data = private_data;
+
+    dev->vm = NULL;
+
+    return dev;
+}
+
+
+int v3_attach_device(struct v3_vm_info * vm, struct vm_device * dev ) {
+    struct vmm_dev_mgr * mgr = &(vm->dev_mgr);
+
+    dev->vm = vm;
+
+    list_add(&(dev->dev_link), &(mgr->dev_list));
+    mgr->num_devs++;
+
+
+    v3_htable_insert(mgr->dev_table, (addr_t)(dev->name), (addr_t)dev);
+
+    return 0;
+}
+
+
+
+void v3_print_dev_mgr(struct v3_vm_info * vm) {
+    struct vmm_dev_mgr * mgr = &(vm->dev_mgr);
+    struct vm_device * dev;
+
+    V3_Print("%d devices registered with manager\n", mgr->num_devs);
+
+    list_for_each_entry(dev, &(mgr->dev_list), dev_link) {
+       V3_Print("Device: %s\n", dev->name);
+    }
+
+    return;
+}
+
+
+
+
+struct blk_frontend {
+    int (*connect)(struct v3_vm_info * vm, 
+                   void * frontend_data, 
+                   struct v3_dev_blk_ops * ops, 
+                   v3_cfg_tree_t * cfg, 
+                   void * priv_data);
+       
+
+    struct list_head blk_node;
+
+    void * priv_data;
+};
+
+
+
+int v3_dev_add_blk_frontend(struct v3_vm_info * vm, 
+                           char * name, 
+                           int (*connect)(struct v3_vm_info * vm, 
+                                           void * frontend_data, 
+                                           struct v3_dev_blk_ops * ops, 
+                                           v3_cfg_tree_t * cfg, 
+                                           void * priv_data), 
+                           void * priv_data) {
+
+    struct blk_frontend * frontend = NULL;
+
+    frontend = (struct blk_frontend *)V3_Malloc(sizeof(struct blk_frontend));
+    memset(frontend, 0, sizeof(struct blk_frontend));
+    
+    frontend->connect = connect;
+    frontend->priv_data = priv_data;
+       
+    list_add(&(frontend->blk_node), &(vm->dev_mgr.blk_list));
+    v3_htable_insert(vm->dev_mgr.blk_table, (addr_t)(name), (addr_t)frontend);
+
+    return 0;
+}
+
+int v3_dev_connect_blk(struct v3_vm_info * vm, 
+                      char * frontend_name, 
+                      struct v3_dev_blk_ops * ops, 
+                      v3_cfg_tree_t * cfg, 
+                      void * private_data) {
+
+    struct blk_frontend * frontend = NULL;
+
+    frontend = (struct blk_frontend *)v3_htable_search(vm->dev_mgr.blk_table,
+                                                      (addr_t)frontend_name);
+    
+    if (frontend == NULL) {
+       PrintError("Could not find frontend blk device %s\n", frontend_name);
+       return 0;
     }
-    break;
-  case DEVICE_PASSTHROUGH:
-    read=write=NULL;
-    break;
-  }
+
+    if (frontend->connect(vm, frontend->priv_data, ops, cfg, private_data) == -1) {
+       PrintError("Error connecting to block frontend %s\n", frontend_name);
+       return -1;
+    }
+
+    return 0;
+}
+
+
+
+struct net_frontend {
+    int (*connect)(struct v3_vm_info * vm, 
+                   void * frontend_data, 
+                   struct v3_dev_net_ops * ops, 
+                   v3_cfg_tree_t * cfg, 
+                   void * priv_data);
     
 
-  /* not implemented yet
-  hook_memory(vm->mem_map, 
-             guest_physical_address_start, 
-             guest_physical_address_end, 
-             read,
-             write,
-             device);
+    struct list_head net_node;
 
-  */
+    void * priv_data;
+};
 
-  return -1;   // remove when hook_memory works
 
-  hook->control=control;
-  hook->atype=atype;
-  hook->guest_physical_start = guest_physical_address_start;
-  hook->guest_physical_end = guest_physical_address_end;
+int v3_dev_add_net_frontend(struct v3_vm_info * vm, 
+                           char * name, 
+                           int (*connect)(struct v3_vm_info * vm, 
+                                           void * frontend_data, 
+                                           struct v3_dev_net_ops * ops, 
+                                           v3_cfg_tree_t * cfg, 
+                                           void * private_data), 
+                           void * priv_data)
+{
+    struct net_frontend * frontend = NULL;
 
-  
-  INSERT_FRONT(device->mem_hooks,hook);
+    frontend = (struct net_frontend *)V3_Malloc(sizeof(struct net_frontend));
+    memset(frontend, 0, sizeof(struct net_frontend));
+    
+    frontend->connect = connect;
+    frontend->priv_data = priv_data;
+       
+    list_add(&(frontend->net_node), &(vm->dev_mgr.net_list));
+    v3_htable_insert(vm->dev_mgr.net_table, (addr_t)(name), (addr_t)frontend);
 
-  return 0;
-  
+    return 0;
 }
 
 
-int dev_mgr_unhook_mem(struct guest_info    *vm,
-                      struct vm_device   *device,
-                      void               *guest_physical_start,
-                      void               *guest_physical_end) 
+int v3_dev_connect_net(struct v3_vm_info * vm, 
+                      char * frontend_name, 
+                      struct v3_dev_net_ops * ops, 
+                      v3_cfg_tree_t * cfg, 
+                      void * private_data)
 {
-  struct vm_device_mem_hook *hook = device->mem_hooks;
+    struct net_frontend * frontend = NULL;
 
-  while (hook) { 
-    if (hook->guest_physical_start==guest_physical_start &&
-       hook->guest_physical_end==guest_physical_end) {
-      DELETE(device->mem_hooks,hook);
-      break;
+    frontend = (struct net_frontend *)v3_htable_search(vm->dev_mgr.net_table,
+                                                      (addr_t)frontend_name);
+    
+    if (frontend == NULL) {
+       PrintError("Could not find frontend net device %s\n", frontend_name);
+       return 0;
     }
-  }
 
-  if (!hook) { 
-    // Very bad - unhooking something that doesn't exist!
-    return -1;
-  }
+    if (frontend->connect(vm, frontend->priv_data, ops, cfg, private_data) == -1) {
+       PrintError("Error connecting to net frontend %s\n", frontend_name);
+       return -1;
+    }
+
+    return 0;
+}
+
+
+struct char_frontend {
+    int (*connect)(struct v3_vm_info * vm, 
+                  void * frontend_data, 
+                  struct v3_dev_char_ops * ops, 
+                  v3_cfg_tree_t * cfg, 
+                  void * priv_data, 
+                  void ** push_fn_arg);
+    
+
+    struct list_head char_node;
 
+    void * priv_data;
+};
 
-  /* not implemented yet
-  return unhook_mem_port(vm->mem_map,
-                        guest_physical_start,
-                        guest_physical_end) ;
 
-  */
-  return -1;
+
+int v3_dev_add_char_frontend(struct v3_vm_info * vm, 
+                            char * name, 
+                            int (*connect)(struct v3_vm_info * vm, 
+                                           void * frontend_data, 
+                                           struct v3_dev_char_ops * ops, 
+                                           v3_cfg_tree_t * cfg, 
+                                           void * private_data, 
+                                           void ** push_fn_arg), 
+                            void * priv_data)
+{
+    struct char_frontend * frontend = NULL;
+
+    frontend = (struct char_frontend *)V3_Malloc(sizeof(struct char_frontend));
+    memset(frontend, 0, sizeof(struct char_frontend));
+    
+    frontend->connect = connect;
+    frontend->priv_data = priv_data;
+       
+    list_add(&(frontend->char_node), &(vm->dev_mgr.char_list));
+    v3_htable_insert(vm->dev_mgr.char_table, (addr_t)(name), (addr_t)frontend);
+
+    return 0;
 }
 
 
-int dev_mgr_unhook_device(struct guest_info  *vm,
-                         struct vm_device *device)
+int v3_dev_connect_char(struct v3_vm_info * vm, 
+                       char * frontend_name, 
+                       struct v3_dev_char_ops * ops, 
+                       v3_cfg_tree_t * cfg, 
+                       void * private_data, 
+                       void ** push_fn_arg)
 {
-  struct vm_device_io_hook *iohook=device->io_hooks;
-  struct vm_device_mem_hook *memhook=device->mem_hooks;
+    struct char_frontend * frontend = NULL;
 
-  while (iohook) { 
-    if (dev_mgr_unhook_io(vm,device,iohook->guest_port)) { 
-      return -1;
+    frontend = (struct char_frontend *)v3_htable_search(vm->dev_mgr.char_table,
+                                                       (addr_t)frontend_name);
+    
+    if (frontend == NULL) {
+       PrintError("Could not find frontend char device %s\n", frontend_name);
+       return 0;
     }
-  }
-
-  while (memhook) { 
-    if (dev_mgr_unhook_mem(vm,device,memhook->guest_physical_start, memhook->guest_physical_end)) {
-      return -1;
+    
+    if (frontend->connect(vm, frontend->priv_data, ops, cfg, private_data, push_fn_arg) == -1) {
+       PrintError("Error connecting to char frontend %s\n", frontend_name);
+       return -1;
     }
-  }
 
-  return 0;
+    return 0;
 }