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.


updated comments for compiler compatibility
[palacios.git] / palacios / include / palacios / vmm.h
index 549ccb1..4640c01 100644 (file)
 #define __VMM_H__
 
 
-#include <palacios/vm_guest.h>
+/*#include <palacios/vm_guest.h>*/
 #include <palacios/vmm_mem.h>
+#include <palacios/vmm_types.h>
+
+struct guest_info;
 
 
 #ifdef __V3VEE__
 
-//#include <palacios/vmm_types.h>
+/*#include <palacios/vmm_types.h>*/
 #include <palacios/vmm_string.h>
 
 
-//#include <palacios/vmm_paging.h>
+/*#include <palacios/vmm_paging.h>*/
 
 /* utility definitions */
 
 
-#define PrintDebug(fmt, args...)                       \
-  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 V3_Print(fmt, args...)                                 \
+    do {                                                       \
+       extern struct v3_os_hooks * os_hooks;                   \
+       if ((os_hooks) && (os_hooks)->print) {                  \
+           (os_hooks)->print((fmt), ##args);                   \
+       }                                                       \
+    } while (0)        
 
-#define PrintError(fmt, args...)                                       \
-  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)                                          
-
-
-
-#ifdef VMM_INFO
-#define PrintInfo(fmt, args...)                        \
-  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
 
-
-#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 PrintDebug(fmt, args...)                       \
+    do {                                               \
+       extern struct v3_os_hooks * os_hooks;           \
+       if ((os_hooks) && (os_hooks)->print) {  \
+           (os_hooks)->print((fmt), ##args);   \
+       }                                               \
+    } while (0)                                                
 
 
-#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 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 PrintError(fmt, args...)                                       \
+    do {                                                               \
+       extern struct v3_os_hooks * os_hooks;                           \
+       if ((os_hooks) && (os_hooks)->print) {                  \
+           (os_hooks)->print("%s(%d): " fmt, __FILE__, __LINE__, ##args); \
+       }                                                               \
+    } while (0)                                                
+
+
+
+#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_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;                                             \
-    })
+#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_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;                                                \
+       })
+
+
+
+#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);         \
+           }                                           \
+           if (!var) PrintError("MALLOC FAILURE. Memory LEAK!!\n");    \
+           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_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_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)                                                         \
+       
 
 
-#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_Yield(addr)                                 \
-  do {                                                 \
-    extern struct v3_os_hooks * os_hooks;              \
-    if ((os_hooks) && (os_hooks)->yield_cpu) {         \
-      (os_hooks)->yield_cpu();                         \
-    }                                                  \
-  } while (0)                                          \
 
+typedef enum v3_vm_class {V3_INVALID_VM, V3_PC_VM, V3_CRAY_VM} v3_vm_class_t;
 
 
+/* Maybe make this a define.... */
+typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU, V3_VMX_EPT_CPU} v3_cpu_arch_t;
 
 
-/* ** */
+v3_cpu_mode_t v3_get_host_cpu_mode();
+
+void v3_yield(struct guest_info * info);
+void v3_yield_cond(struct guest_info * info);
+void v3_print_cond(const char * fmt, ...);
 
-#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)                                                           \
-    
 
+void v3_interrupt_cpu(struct guest_info * vm, int logical_cpu);
 
+unsigned int v3_get_cpu_id();
 
-#define VMM_INVALID_CPU 0
-#define VMM_VMX_CPU 1
-#define VMM_SVM_CPU 2
+v3_cpu_arch_t v3_get_cpu_type(int cpu_id);
 
 
-// Maybe make this a define....
-typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU} v3_cpu_arch_t;
+int v3_vm_enter(struct guest_info * info);
 
 
-#endif //!__V3VEE__
+#endif /* !__V3VEE__ */
 
 
 
@@ -214,93 +218,69 @@ struct guest_info;
 
 /* 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, ...)
+    void (*print)(const char * format, ...)
        __attribute__ ((format (printf, 1, 2)));
   
-  void *(*allocate_pages)(int numPages);
-  void (*free_page)(void * page);
-
-  void *(*malloc)(unsigned int size);
-  void (*free)(void * addr);
+    void *(*allocate_pages)(int numPages);
+    void (*free_page)(void * page);
 
-  void *(*paddr_to_vaddr)(void *addr);
-  void *(*vaddr_to_paddr)(void *addr);
+    void *(*malloc)(unsigned int size);
+    void (*free)(void * addr);
 
-  //  int (*hook_interrupt)(struct guest_info *s, int irq);
+    void *(*paddr_to_vaddr)(void *addr);
+    void *(*vaddr_to_paddr)(void *addr);
 
-  int (*hook_interrupt)(struct guest_info * vm, unsigned int irq);
+    int (*hook_interrupt)(struct guest_info * vm, unsigned int irq);
 
-  int (*ack_irq)(int irq);
+    int (*ack_irq)(int irq);
 
+    unsigned int (*get_cpu_khz)(void);
 
-  unsigned int (*get_cpu_khz)(void);
+    void (*start_kernel_thread)(int (*fn)(void * arg), void * arg, char * thread_name); 
 
+    void (*yield_cpu)(void); 
 
-  void (*start_kernel_thread)(void); // include pointer to function
-
-  void (*yield_cpu)(void);
+    void *(*mutex_alloc)(void);
+    void (*mutex_free)(void * mutex);
+    void (*mutex_lock)(void * mutex, int must_spin);
+    void (*mutex_unlock)(void * mutex);
 
+    unsigned int (*get_cpu)(void);
+    void (*interrupt_cpu)(struct guest_info * vm, int logical_cpu);
+    void (*call_on_cpu)(int logical_cpu, void (*fn)(void * arg), void * arg);
+    void (*start_thread_on_cpu)(int logical_cpu, int (*fn)(void * arg), void * arg, char * thread_name);
 };
 
 
-struct v3_vm_config {
-  void * rombios;
-  int rombios_size;
 
-  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)
 
-  int use_ramdisk;
-  void * ramdisk;
-  int ramdisk_size;
-};
 
 
+/*
+ *
+ * This is the interrupt state that the VMM's interrupt handlers need to see
+ */
+struct v3_interrupt {
+    unsigned int irq;
+    unsigned int error;
 
-/* This will contain Function pointers that control the VMs */
-struct v3_ctrl_ops {
-  struct guest_info *(*allocate_guest)(void);
-
-  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)(void);
-
-  //  v3_cpu_arch_t (*get_cpu_arch)();
+    unsigned int should_ack;  /* Should the vmm ack this interrupt, or will
+                               * the host OS do it?
+                               */
 };
 
 
 
 
-//
-//
-// This is the interrupt state that the VMM's interrupt handlers need to see
-//
-struct v3_interrupt {
-  unsigned int irq;
-  unsigned int error;
+void Init_V3(struct v3_os_hooks * hooks,  int num_cpus);
 
-  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_start_vm(struct guest_info * info, unsigned int cpu_mask);
+struct guest_info * v3_create_vm(void * cfg);
 
 int v3_deliver_irq(struct guest_info * vm, struct v3_interrupt * intr);
-int v3_deliver_keyboard_evt(struct guest_info * vm);
+
 
 
 #endif