palacios/include/palacios/vmm.h

   1 #ifndef __VMM_H
   2 #define __VMM_H
   3
   4
   5 #include <palacios/vm_guest.h>
   6 #include <palacios/vmm_mem.h>
   7
   8 #ifdef __V3VEE__
   9
  10 //#include <palacios/vmm_types.h>
  11 #include <palacios/vmm_string.h>
  12
  13
  14 //#include <palacios/vmm_paging.h>
  15
  16 /* utility definitions */
  17
  18 #if VMM_DEBUG
  19 #define PrintDebug(fmt, args...)                        \
  20   do {                                                  \
  21     extern struct vmm_os_hooks * os_hooks;              \
  22     if ((os_hooks) && (os_hooks)->print_debug) {        \
  23       (os_hooks)->print_debug((fmt), ##args);           \
  24     }                                                   \
  25   } while (0)
  26 #else
  27 #define PrintDebug(fmt,args ...)
  28 #endif
  29
  30
  31
  32 #define PrintError(fmt, args...)                        \
  33   do {                                                  \
  34     extern struct vmm_os_hooks * os_hooks;              \
  35     if ((os_hooks) && (os_hooks)->print_debug) {        \
  36       (os_hooks)->print_debug((fmt), ##args);           \
  37     }                                                   \
  38   } while (0)
  39
  40
  41
  42 #if VMM_INFO
  43 #define PrintInfo(fmt, args...)                         \
  44   do {                                                  \
  45     extern struct vmm_os_hooks * os_hooks;              \
  46     if ((os_hooks) && (os_hooks)->print_info) {         \
  47       (os_hooks)->print_info((fmt), ##args);            \
  48     }                                                   \
  49   } while (0)
  50 #else
  51 #define PrintInfo(fmt, args...)
  52 #endif
  53
  54
  55 #if VMM_TRACE
  56 #define PrintTrace(fmt, args...)                        \
  57   do {                                                  \
  58     extern struct vmm_os_hooks * os_hooks;              \
  59     if ((os_hooks) && (os_hooks)->print_trace) {        \
  60       (os_hooks)->print_trace((fmt), ##args);           \
  61     }                                                   \
  62   } while (0)
  63 #else
  64 #define PrintTrace(fmt, args...)
  65 #endif
  66
  67
  68 #define V3_AllocPages(num_pages)                        \
  69   ({                                                    \
  70     extern struct vmm_os_hooks * os_hooks;              \
  71     void * ptr = 0;                                     \
  72     if ((os_hooks) && (os_hooks)->allocate_pages) {     \
  73       ptr = (os_hooks)->allocate_pages(num_pages);      \
  74     }                                                   \
  75     ptr;                                                \
  76   })                                                    \
  77
  78
  79 #define V3_FreePage(page)                       \
  80   do {                                          \
  81     extern struct vmm_os_hooks * os_hooks;      \
  82     if ((os_hooks) && (os_hooks)->free_page) {  \
  83       (os_hooks)->free_page(page);              \
  84     }                                           \
  85   } while(0)                                    \
  86
  87
  88
  89
  90 #define V3_Malloc(size) ({                      \
  91       extern struct vmm_os_hooks * os_hooks;    \
  92       void * var = 0;                           \
  93       if ((os_hooks) && (os_hooks)->malloc) {   \
  94         var = (os_hooks)->malloc(size);         \
  95       }                                         \
  96       var;                                      \
  97     })
  98
  99 // We need to check the hook structure at runtime to ensure its SAFE
 100 #define V3_Free(addr)                                   \
 101   do {                                                  \
 102     extern struct vmm_os_hooks * os_hooks;              \
 103     if ((os_hooks) && (os_hooks)->free) {               \
 104       (os_hooks)->free(addr);                           \
 105     }                                                   \
 106   } while (0)                                           \
 107
 108
 109 // uint_t V3_CPU_KHZ();
 110 #define V3_CPU_KHZ()                                    \
 111   ({                                                    \
 112     unsigned int khz = 0;                               \
 113     extern struct vmm_os_hooks * os_hooks;              \
 114     if ((os_hooks) && (os_hooks)->get_cpu_khz) {        \
 115       khz = (os_hooks)->get_cpu_khz();                  \
 116     }                                                   \
 117     khz;                                                \
 118   })                                                    \
 119
 120
 121
 122 #define V3_Hook_Interrupt(irq, opaque)                          \
 123   ({                                                            \
 124     int ret = 0;                                                        \
 125     extern struct vmm_os_hooks * os_hooks;                      \
 126     if ((os_hooks) && (os_hooks)->hook_interrupt) {             \
 127       ret = (os_hooks)->hook_interrupt(irq, opaque);            \
 128     }                                                           \
 129     ret;                                                        \
 130   })                                                            \
 131
 132
 133 /* ** */
 134
 135 #define V3_ASSERT(x)                                                    \
 136   do {                                                                  \
 137     if (!(x)) {                                                         \
 138       PrintDebug("Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
 139                  __func__, #x, __FILE__, __LINE__,                      \
 140                  (ulong_t) __builtin_return_address(0));                \
 141       while(1);                                                         \
 142     }                                                                   \
 143   } while(0)                                                            \
 144
 145
 146
 147
 148 #define VMM_INVALID_CPU 0
 149 #define VMM_VMX_CPU 1
 150 #define VMM_SVM_CPU 2
 151
 152
 153 // Maybe make this a define....
 154 typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU} v3_cpu_arch_t;
 155
 156
 157 #endif //!__V3VEE__
 158
 159 #ifdef __V3VEE__
 160 typedef struct guest_info v3_guest_t;
 161 #else
 162 typedef void v3_guest_t;
 163 #endif
 164
 165
 166
 167 //
 168 //
 169 // This is the interrupt state that the VMM's interrupt handlers need to see
 170 //
 171 struct vmm_intr_state {
 172   unsigned int irq;
 173   unsigned int error;
 174
 175   unsigned int should_ack;  // Should the vmm ack this interrupt, or will
 176                       // the host OS do it?
 177
 178   // This is the value given when the interrupt is hooked.
 179   // This will never be NULL
 180   void *opaque;
 181 };
 182
 183 void deliver_interrupt_to_vmm(struct vmm_intr_state *state);
 184
 185
 186 /* This will contain function pointers that provide OS services */
 187 struct vmm_os_hooks {
 188   void (*print_info)(const char * format, ...);
 189   void (*print_debug)(const char * format, ...);
 190   void (*print_trace)(const char * format, ...);
 191
 192   void *(*allocate_pages)(int numPages);
 193   void (*free_page)(void * page);
 194
 195   void *(*malloc)(unsigned int size);
 196   void (*free)(void * addr);
 197
 198   void *(*paddr_to_vaddr)(void *addr);
 199   void *(*vaddr_to_paddr)(void *addr);
 200
 201   //  int (*hook_interrupt)(struct guest_info *s, int irq);
 202
 203   int (*hook_interrupt)(unsigned int irq, void *opaque);
 204
 205   int (*ack_irq)(int irq);
 206
 207
 208   unsigned int (*get_cpu_khz)();
 209
 210
 211   void (*start_kernel_thread)(); // include pointer to function
 212
 213
 214
 215   // Filled in by initialization
 216
 217 };
 218
 219
 220 /* This will contain Function pointers that control the VMs */
 221 struct vmm_ctrl_ops {
 222   void *(*allocate_guest)();
 223
 224   int (*config_guest)(v3_guest_t * info, void * config_ptr);
 225   int (*init_guest)(v3_guest_t * info);
 226   int (*start_guest)(v3_guest_t * info);
 227   //  int (*stop_vm)(uint_t vm_id);
 228
 229   int (*has_nested_paging)();
 230
 231   //  v3_cpu_arch_t (*get_cpu_arch)();
 232 };
 233
 234
 235
 236
 237 void Init_V3(struct vmm_os_hooks * hooks, struct vmm_ctrl_ops * vmm_ops);
 238
 239
 240
 241
 242
 243 #endif