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.


first cut at nested paging
[palacios.git] / palacios / include / palacios / vmm.h
index 17dd7eb..4a4ed79 100644 (file)
  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  */
 
-#ifndef __VMM_H
-#define __VMM_H
+#ifndef __VMM_H__
+#define __VMM_H__
 
 
 #include <palacios/vm_guest.h>
 #include <palacios/vmm_mem.h>
+#include <palacios/vmm_types.h>
+
+
 
 #ifdef __V3VEE__
 
 
 /* utility definitions */
 
-#if VMM_DEBUG
+
 #define PrintDebug(fmt, args...)                       \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->print_debug) {       \
-      (os_hooks)->print_debug((fmt), ##args);          \
-    }                                                  \
-  } while (0)                                          
+    do {                                               \
+       extern struct v3_os_hooks * os_hooks;           \
+       if ((os_hooks) && (os_hooks)->print_debug) {    \
+           (os_hooks)->print_debug((fmt), ##args);     \
+       }                                               \
+    } while (0)                                                
+
+#if 1
 #else
 #define PrintDebug(fmt,args ...)
 #endif
 
 
 #define PrintError(fmt, args...)                                       \
-  do {                                                                 \
-    extern struct vmm_os_hooks * os_hooks;                             \
-    if ((os_hooks) && (os_hooks)->print_debug) {                       \
-      (os_hooks)->print_debug("%s(%d): " fmt, __FILE__, __LINE__, ##args); \
-    }                                                                  \
-  } while (0)                                          
+    do {                                                               \
+       extern struct v3_os_hooks * os_hooks;                           \
+       if ((os_hooks) && (os_hooks)->print_debug) {                    \
+           (os_hooks)->print_debug("%s(%d): " fmt, __FILE__, __LINE__, ##args); \
+       }                                                               \
+    } while (0)                                                
 
 
 
-#if VMM_INFO
+#ifdef VMM_INFO
 #define PrintInfo(fmt, args...)                        \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->print_info) {                \
-      (os_hooks)->print_info((fmt), ##args);           \
-    }                                                  \
-  } while (0)                                          
+    do {                                               \
+       extern struct v3_os_hooks * os_hooks;           \
+       if ((os_hooks) && (os_hooks)->print_info) {     \
+           (os_hooks)->print_info((fmt), ##args);      \
+       }                                               \
+    } while (0)                                                
 #else
 #define PrintInfo(fmt, args...)
 #endif
 
 
-#if VMM_TRACE
-#define PrintTrace(fmt, args...)                                       \
-  do {                                                                 \
-    extern struct vmm_os_hooks * os_hooks;                             \
-    if ((os_hooks) && (os_hooks)->print_trace) {                       \
-      (os_hooks)->print_trace(fmt, ##args);                            \
-    }                                                                  \
-  } while (0)                                          
+#ifdef VMM_TRACE
+#define PrintTrace(fmt, args...)                       \
+    do {                                               \
+       extern struct v3_os_hooks * os_hooks;           \
+       if ((os_hooks) && (os_hooks)->print_trace) {    \
+           (os_hooks)->print_trace(fmt, ##args);       \
+       }                                               \
+    } while (0)                                                
 #else
 #define PrintTrace(fmt, args...)
 #endif
 
 
-#define V3_AllocPages(num_pages)                       \
-  ({                                                   \
-    extern struct vmm_os_hooks * os_hooks;             \
-    void * ptr = 0;                                    \
-    if ((os_hooks) && (os_hooks)->allocate_pages) {    \
-      ptr = (os_hooks)->allocate_pages(num_pages);     \
-    }                                                  \
-    ptr;                                               \
-  })                                                   \
+#define V3_AllocPages(num_pages)                               \
+    ({                                                         \
+       extern struct v3_os_hooks * os_hooks;                   \
+       void * ptr = 0;                                         \
+       if ((os_hooks) && (os_hooks)->allocate_pages) {         \
+           ptr = (os_hooks)->allocate_pages(num_pages);        \
+       }                                                       \
+       ptr;                                                    \
+    })
 
 
-#define V3_FreePage(page)                      \
-  do {                                         \
-    extern struct vmm_os_hooks * os_hooks;     \
-    if ((os_hooks) && (os_hooks)->free_page) { \
-      (os_hooks)->free_page(page);             \
-    }                                          \
-  } while(0)                                   \
+#define V3_FreePage(page)                              \
+    do {                                               \
+       extern struct v3_os_hooks * os_hooks;           \
+       if ((os_hooks) && (os_hooks)->free_page) {      \
+           (os_hooks)->free_page(page);                \
+       }                                               \
+    } while(0)
 
 
+#define V3_VAddr(addr) ({                                      \
+           extern struct v3_os_hooks * os_hooks;               \
+           void * var = 0;                                     \
+           if ((os_hooks) && (os_hooks)->paddr_to_vaddr) {     \
+               var = (os_hooks)->paddr_to_vaddr(addr);         \
+           }                                                   \
+           var;                                                \
+       })
 
 
-#define V3_Malloc(size) ({                     \
-      extern struct vmm_os_hooks * os_hooks;   \
-      void * var = 0;                          \
-      if ((os_hooks) && (os_hooks)->malloc) {  \
-       var = (os_hooks)->malloc(size);         \
-      }                                                \
-      var;                                     \
-    })
-
-// We need to check the hook structure at runtime to ensure its SAFE
-#define V3_Free(addr)                                  \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->free) {              \
-      (os_hooks)->free(addr);                          \
-    }                                                  \
-  } while (0)                                          \
+#define V3_PAddr(addr) ({                                      \
+           extern struct v3_os_hooks * os_hooks;               \
+           void * var = 0;                                     \
+           if ((os_hooks) && (os_hooks)->vaddr_to_paddr) {     \
+               var = (os_hooks)->vaddr_to_paddr(addr);         \
+           }                                                   \
+           var;                                                \
+       })
 
 
-// uint_t V3_CPU_KHZ();
-#define V3_CPU_KHZ()                                   \
-  ({                                                   \
-    unsigned int khz = 0;                              \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->get_cpu_khz) {       \
-      khz = (os_hooks)->get_cpu_khz();                 \
-    }                                                  \
-    khz;                                               \
-  })                                                   \
-    
-
-
-#define V3_Hook_Interrupt(irq, opaque)                         \
-  ({                                                           \
-    int ret = 0;                                               \
-    extern struct vmm_os_hooks * os_hooks;                     \
-    if ((os_hooks) && (os_hooks)->hook_interrupt) {            \
-      ret = (os_hooks)->hook_interrupt(irq, opaque);           \
-    }                                                          \
-    ret;                                                       \
-  })                                                           \
-
-#define V3_Yield(addr)                                 \
-  do {                                                 \
-    extern struct vmm_os_hooks * os_hooks;             \
-    if ((os_hooks) && (os_hooks)->yield_cpu) {         \
-      (os_hooks)->yield_cpu();                         \
-    }                                                  \
-  } while (0)                                          \
 
+#define V3_Malloc(size) ({                             \
+           extern struct v3_os_hooks * os_hooks;       \
+           void * var = 0;                             \
+           if ((os_hooks) && (os_hooks)->malloc) {     \
+               var = (os_hooks)->malloc(size);         \
+           }                                           \
+           var;                                        \
+       })
 
+// We need to check the hook structure at runtime to ensure its SAFE
+#define V3_Free(addr)                          \
+    do {                                       \
+       extern struct v3_os_hooks * os_hooks;   \
+       if ((os_hooks) && (os_hooks)->free) {   \
+           (os_hooks)->free(addr);             \
+       }                                       \
+    } while (0)
 
+// uint_t V3_CPU_KHZ();
+#define V3_CPU_KHZ() ({                                                        \
+           unsigned int khz = 0;                                       \
+           extern struct v3_os_hooks * os_hooks;                       \
+           if ((os_hooks) && (os_hooks)->get_cpu_khz) {                \
+               khz = (os_hooks)->get_cpu_khz();                        \
+           }                                                           \
+           khz;                                                        \
+       })                                                              \
+       
+
+
+#define V3_CREATE_THREAD(fn, arg, name)                                \
+    do {                                                       \
+       extern struct v3_os_hooks * os_hooks;                   \
+       if ((os_hooks) && (os_hooks)->start_kernel_thread) {    \
+           (os_hooks)->start_kernel_thread(fn, arg, name);     \
+       }                                                       \
+    } while (0)
+
+
+#define V3_Hook_Interrupt(irq, opaque) ({                              \
+           int ret = 0;                                                \
+           extern struct v3_os_hooks * os_hooks;                       \
+           if ((os_hooks) && (os_hooks)->hook_interrupt) {             \
+               ret = (os_hooks)->hook_interrupt(irq, opaque);          \
+           }                                                           \
+           ret;                                                        \
+       })                                                              \
+       
+
+#define V3_ACK_IRQ(irq)                                                \
+    do {                                                       \
+       extern struct v3_os_hooks * os_hooks;                   \
+       if ((os_hooks) && (os_hooks)->ack_irq) {                \
+           (os_hooks)->ack_irq(irq);                           \
+       }                                                       \
+    } while (0)
 
 
+#define V3_Yield(addr)                                 \
+    do {                                               \
+       extern struct v3_os_hooks * os_hooks;           \
+       if ((os_hooks) && (os_hooks)->yield_cpu) {      \
+           (os_hooks)->yield_cpu();                    \
+       }                                               \
+    } while (0)                                                \
+                                                       \
+                                                       \
+                                                       \
+                                                       \
+                                                       \
 /* ** */
 
 #define V3_ASSERT(x)                                                   \
-  do {                                                                 \
-    if (!(x)) {                                                                \
-      PrintDebug("Failed assertion in %s: %s at %s, line %d, RA=%lx\n",        \
-                __func__, #x, __FILE__, __LINE__,                      \
-                (ulong_t) __builtin_return_address(0));                \
-      while(1);                                                                \
-    }                                                                  \
-  } while(0)                                                           \
-    
+    do {                                                               \
+       if (!(x)) {                                                     \
+           PrintDebug("Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
+                      __func__, #x, __FILE__, __LINE__,                \
+                      (ulong_t) __builtin_return_address(0));          \
+           while(1);                                                   \
+       }                                                               \
+    } while(0)                                                         \
+       
 
 
 
@@ -188,78 +228,96 @@ typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CP
 
 
 
-//
-//
-// This is the interrupt state that the VMM's interrupt handlers need to see
-//
-struct vmm_intr_state {
-  unsigned int irq;
-  unsigned int error;
+struct guest_info;
 
-  unsigned int should_ack;  // Should the vmm ack this interrupt, or will
-                      // the host OS do it?
-
-  // This is the value given when the interrupt is hooked.
-  // This will never be NULL
-  void * opaque;
-};
+/* This will contain function pointers that provide OS services */
+struct v3_os_hooks {
+    void (*print_info)(const char * format, ...)
+       __attribute__ ((format (printf, 1, 2)));
+    void (*print_debug)(const char * format, ...)
+       __attribute__ ((format (printf, 1, 2)));
+    void (*print_trace)(const char * format, ...)
+       __attribute__ ((format (printf, 1, 2)));
+  
+    void *(*allocate_pages)(int numPages);
+    void (*free_page)(void * page);
 
-void deliver_interrupt_to_vmm(struct vmm_intr_state * state);
+    void *(*malloc)(unsigned int size);
+    void (*free)(void * addr);
 
+    void *(*paddr_to_vaddr)(void *addr);
+    void *(*vaddr_to_paddr)(void *addr);
 
-/* This will contain function pointers that provide OS services */
-struct vmm_os_hooks {
-  void (*print_info)(const char * format, ...);
-  void (*print_debug)(const char * format, ...);
-  void (*print_trace)(const char * format, ...);
-  
-  void *(*allocate_pages)(int numPages);
-  void (*free_page)(void * page);
+    int (*hook_interrupt)(struct guest_info * vm, unsigned int irq);
 
-  void *(*malloc)(unsigned int size);
-  void (*free)(void * addr);
+    int (*ack_irq)(int irq);
 
-  void *(*paddr_to_vaddr)(void *addr);
-  void *(*vaddr_to_paddr)(void *addr);
+    unsigned int (*get_cpu_khz)(void);
 
-  //  int (*hook_interrupt)(struct guest_info *s, int irq);
+    void (*start_kernel_thread)(int (*fn)(void * arg), void * arg, char * thread_name); 
 
-  int (*hook_interrupt)(unsigned int irq, void *opaque);
+    void (*yield_cpu)(void); 
+};
 
-  int (*ack_irq)(int irq);
 
+struct v3_vm_config {
+    void * rombios;
+    int rombios_size;
 
-  unsigned int (*get_cpu_khz)();
+    void * vgabios;
+    int vgabios_size;
 
+    unsigned long mem_size; // in bytes, var should be natural size of cpu
+    // so we can specify maximum physical address size
+    // (We're screwed if we want to do 32 bit host/64 bit guest)
 
-  void (*start_kernel_thread)(); // include pointer to function
 
-  void (*yield_cpu)();
+    int enable_profiling;
+    int enable_nested_paging;
 
+    int use_ramdisk;
+    void * ramdisk;
+    int ramdisk_size;
 };
 
 
+
 /* This will contain Function pointers that control the VMs */
-struct vmm_ctrl_ops {
-  struct guest_info *(*allocate_guest)();
+struct v3_ctrl_ops {
+    struct guest_info *(*allocate_guest)(void);
 
-  int (*config_guest)(struct guest_info * info, void * config_ptr);
-  int (*init_guest)(struct guest_info * info);
-  int (*start_guest)(struct guest_info * info);
-  //  int (*stop_vm)(uint_t vm_id);
+    int (*config_guest)(struct guest_info * info, struct v3_vm_config * config_ptr);
+    int (*init_guest)(struct guest_info * info);
+    int (*start_guest)(struct guest_info * info);
+    //  int (*stop_vm)(uint_t vm_id);
 
-  int (*has_nested_paging)();
+    int (*has_nested_paging)(void);
 
-  //  v3_cpu_arch_t (*get_cpu_arch)();
+    //  v3_cpu_arch_t (*get_cpu_arch)();
 };
 
 
 
 
-void Init_V3(struct vmm_os_hooks * hooks, struct vmm_ctrl_ops * vmm_ops);
+//
+//
+// This is the interrupt state that the VMM's interrupt handlers need to see
+//
+struct v3_interrupt {
+    unsigned int irq;
+    unsigned int error;
+
+    unsigned int should_ack;  // Should the vmm ack this interrupt, or will
+    // the host OS do it?
+};
+
+
 
 
+void Init_V3(struct v3_os_hooks * hooks, struct v3_ctrl_ops * vmm_ops);
 
+int v3_deliver_irq(struct guest_info * vm, struct v3_interrupt * intr);
+int v3_deliver_keyboard_evt(struct guest_info * vm);
 
 
 #endif