* 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>
#ifdef __V3VEE__
-
-//#include <palacios/vmm_types.h>
+#include <palacios/vmm_mem.h>
+#include <palacios/vmm_types.h>
#include <palacios/vmm_string.h>
-//#include <palacios/vmm_paging.h>
-/* utility definitions */
-#ifdef 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)
-#else
-#define PrintDebug(fmt,args ...)
-#endif
+/* utility definitions */
+#define VM_NONE ((struct v3_vm_info *)0)
+#define VCORE_NONE ((struct guest_info *)0)
+void *v3_get_host_vm(struct v3_vm_info *);
+int v3_get_vcore(struct guest_info *);
-#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); \
+#define V3_Print(vm, vcore, fmt, args...) \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->print) { \
+ (os_hooks)->print(v3_get_host_vm(vm), v3_get_vcore(vcore), (fmt), ##args); \
} \
- } while (0)
-
+ } while (0)
-#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)
-#else
-#define PrintInfo(fmt, args...)
-#endif
+#define PrintDebug(vm, vcore, fmt, args...) V3_Print(vm, vcore, "DEBUG: " fmt, ##args)
+#define PrintError(vm, vcore, fmt, args...) V3_Print(vm, vcore, "ERROR at %s(%d): " fmt, __FILE__, __LINE__, ##args)
-#ifdef 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)
-#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; \
- }) \
+/* 4KB-aligned */
+#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,PAGE_SIZE_4KB,-1,0); \
+ } \
+ 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) \
+// Use 32 bit constraints if the vm uses 32bit shadow paging at any point
+// Should be used for shadow page tables and any physical memory
+// mapped into the vm
+#define V3_AllocShadowSafePages(vm,num_pages) \
+ ({ \
+ extern struct v3_os_hooks * os_hooks; \
+ void * ptr = 0; \
+ int c; int shadow=0; \
+ for (c=0;c<(vm)->num_cores && !shadow;c++) { \
+ shadow|=vm->cores[c].shdw_pg_mode==SHADOW_PAGING; \
+ } \
+ if ((os_hooks) && (os_hooks)->allocate_pages) { \
+ ptr = (os_hooks)->allocate_pages(num_pages,PAGE_SIZE_4KB,-1,\
+ shadow ? V3_ALLOC_PAGES_CONSTRAINT_4GB : 0); \
+ } \
+ ptr; \
+ })
+#define V3_AllocAlignedPages(num_pages, align) \
+ ({ \
+ extern struct v3_os_hooks * os_hooks; \
+ void * ptr = 0; \
+ if ((os_hooks) && (os_hooks)->allocate_pages) { \
+ ptr = (os_hooks)->allocate_pages(num_pages,align,-1,0); \
+ } \
+ ptr; \
+ })
+#define V3_AllocPagesNode(num_pages, node_id) \
+ ({ \
+ extern struct v3_os_hooks * os_hooks; \
+ void * ptr = 0; \
+ if ((os_hooks) && (os_hooks)->allocate_pages) { \
+ ptr = (os_hooks)->allocate_pages(num_pages, PAGE_SIZE_4KB, node_id,0); \
+ } \
+ ptr; \
+ })
-#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; \
+#define V3_AllocPagesExtended(num_pages, align, node_id, constraints) \
+ ({ \
+ extern struct v3_os_hooks * os_hooks; \
+ void * ptr = 0; \
+ if ((os_hooks) && (os_hooks)->allocate_pages) { \
+ ptr = (os_hooks)->allocate_pages(num_pages, align, node_id,constraints); \
+ } \
+ ptr; \
})
-// 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) \
-// 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_FreePages(page, num_pages) \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->free_pages) { \
+ (os_hooks)->free_pages(page, num_pages); \
+ } \
+ } while(0)
-#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_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_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_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(VM_NONE,VCORE_NONE,"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)
-#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) \
+// 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_Hook_Interrupt(vm, irq) ({ \
+ int ret = 0; \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->hook_interrupt) { \
+ ret = (os_hooks)->hook_interrupt(vm, irq); \
+ } \
+ 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_Get_CPU() ({ \
+ int ret = 0; \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->get_cpu) { \
+ ret = (os_hooks)->get_cpu(); \
+ } \
+ ret; \
+ })
+
+
+
+
+#define V3_CREATE_THREAD(fn, arg, name) ({ \
+ void * thread = NULL; \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->start_kernel_thread) { \
+ thread = (os_hooks)->start_kernel_thread(fn, arg, name); \
+ } \
+ thread; \
+ })
+
+
+
+
+#define V3_Call_On_CPU(cpu, fn, arg) \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->call_on_cpu) { \
+ (os_hooks)->call_on_cpu(cpu, fn, arg); \
+ } \
+ } while (0)
+
+
+
+#define V3_CREATE_THREAD_ON_CPU(cpu, fn, arg, name) ({ \
+ void * thread = NULL; \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->start_thread_on_cpu) { \
+ thread = (os_hooks)->start_thread_on_cpu(cpu, fn, arg, name); \
+ } \
+ thread; \
+ })
+
+#define V3_MOVE_THREAD_TO_CPU(pcpu, thread) ({ \
+ int ret = -1; \
+ extern struct v3_os_hooks * os_hooks; \
+ if((os_hooks) && (os_hooks)->move_thread_to_cpu) { \
+ ret = (os_hooks)->move_thread_to_cpu(pcpu, thread); \
+ } \
+ ret; \
+ })
+/* ** */
-#define VMM_INVALID_CPU 0
-#define VMM_VMX_CPU 1
-#define VMM_SVM_CPU 2
+#define V3_ASSERT(vm, vcore, x) \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if (!(x)) { \
+ PrintDebug(vm, vcore, "Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
+ __func__, #x, __FILE__, __LINE__, \
+ (ulong_t) __builtin_return_address(0)); \
+ while(1){ \
+ if ((os_hooks) && (os_hooks)->yield_cpu) { \
+ (os_hooks)->yield_cpu(); \
+ } \
+ } \
+ } \
+ } while(0) \
+
+
+
+#define V3_Yield() \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->yield_cpu) { \
+ (os_hooks)->yield_cpu(); \
+ } \
+ } while (0) \
+
+
+#define V3_Sleep(usec) \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->sleep_cpu) {\
+ (os_hooks)->sleep_cpu(usec); \
+ } else { \
+ V3_Yield(); \
+ } \
+ } while (0) \
+
+#define V3_Wakeup(cpu) \
+ do { \
+ extern struct v3_os_hooks * os_hooks; \
+ if ((os_hooks) && (os_hooks)->wakeup_cpu) { \
+ (os_hooks)->wakeup_cpu(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_cpu_arch_t;
+typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU, V3_VMX_EPT_CPU, V3_VMX_EPT_UG_CPU} v3_cpu_arch_t;
-#endif //!__V3VEE__
+v3_cpu_mode_t v3_get_host_cpu_mode();
+void v3_yield(struct guest_info * info, int usec);
+void v3_yield_cond(struct guest_info * info, int usec);
+void v3_print_cond(const char * fmt, ...);
+void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu, int vector);
-struct guest_info;
-/* 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);
- void *(*malloc)(unsigned int size);
- void (*free)(void * addr);
+v3_cpu_arch_t v3_get_cpu_type(int cpu_id);
- void *(*paddr_to_vaddr)(void *addr);
- void *(*vaddr_to_paddr)(void *addr);
- // int (*hook_interrupt)(struct guest_info *s, int irq);
+int v3_vm_enter(struct guest_info * info);
+int v3_reset_vm_core(struct guest_info * core, addr_t rip);
- int (*hook_interrupt)(struct guest_info * vm, unsigned int irq);
- int (*ack_irq)(int irq);
+#endif /*!__V3VEE__ */
- unsigned int (*get_cpu_khz)();
+struct v3_vm_info;
- void (*start_kernel_thread)(); // include pointer to function
+/* This will contain function pointers that provide OS services */
+struct v3_os_hooks {
+ // the vm pointer is the host os's "priv_data" from v3_create_vm
+ // if vm is null, this is a general palacios printout
+ // if vm is not null, and vcore is negative, this is a general print form the vm
+ // if vm is not null, and vcore is non-negative, this is a print from a specific vcore
+ void (*print)(void *vm, int vcore, const char * format, ...)
+ __attribute__ ((format (printf, 3, 4)));
+
+ // For page allocation:
+ // - node_id -1 => any node, otherwise the numa node we want to alloc from
+ // - constraint = 0 => no constraints, otherwise a bitwise-or of the following flags
+#define V3_ALLOC_PAGES_CONSTRAINT_4GB 1
+ void *(*allocate_pages)(int num_pages, unsigned int alignment, int node_id, int constraint);
+ void (*free_pages)(void * page, int num_pages);
+
+ void *(*malloc)(unsigned int size);
+ void (*free)(void * addr);
+
+ void *(*paddr_to_vaddr)(void * addr);
+ void *(*vaddr_to_paddr)(void * addr);
+
+ int (*hook_interrupt)(struct v3_vm_info * vm, unsigned int irq);
+ int (*ack_irq)(int irq);
+
+ unsigned int (*get_cpu_khz)(void);
+
+ void (*yield_cpu)(void);
+ void (*sleep_cpu)(unsigned int usec);
+ void (*wakeup_cpu)(void *cpu);
+
+ void *(*mutex_alloc)(void);
+ void (*mutex_free)(void * mutex);
+ void (*mutex_lock)(void * mutex, int must_spin);
+ void (*mutex_unlock)(void * mutex);
+ void *(*mutex_lock_irqsave)(void * mutex, int must_spin);
+ void (*mutex_unlock_irqrestore)(void * mutex, void *flags);
+
+ unsigned int (*get_cpu)(void);
+
+ void * (*start_kernel_thread)(int (*fn)(void * arg), void * arg, char * thread_name);
+ void (*interrupt_cpu)(struct v3_vm_info * vm, int logical_cpu, int vector);
+ void (*call_on_cpu)(int logical_cpu, void (*fn)(void * arg), void * arg);
+ void * (*start_thread_on_cpu)(int cpu_id, int (*fn)(void * arg), void * arg, char * thread_name);
+ int (*move_thread_to_cpu)(int cpu_id, void * thread);
+};
- void (*yield_cpu)();
+/*
+ *
+ * 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? */
};
-struct v3_vm_config {
- void * vm_kernel;
- int use_ramdisk;
- void * ramdisk;
- int ramdisk_size;
-};
+typedef enum {V3_VM_UNKNOWN, V3_VM_INVALID, V3_VM_RUNNING, V3_VM_STOPPED, V3_VM_PAUSED, V3_VM_ERROR, V3_VM_SIMULATING} v3_vm_state_t;
+typedef enum {V3_VCORE_UNKNOWN, V3_VCORE_INVALID, V3_VCORE_RUNNING, V3_VCORE_STOPPED} v3_vcore_state_t;
+typedef enum {V3_VCORE_CPU_UNKNOWN, V3_VCORE_CPU_REAL, V3_VCORE_CPU_PROTECTED, V3_VCORE_CPU_PROTECTED_PAE, V3_VCORE_CPU_LONG, V3_VCORE_CPU_LONG_32_COMPAT, V3_VCORE_CPU_LONG_16_COMPAT} v3_vcore_cpu_mode_t;
+typedef enum {V3_VCORE_MEM_STATE_UNKNOWN, V3_VCORE_MEM_STATE_SHADOW, V3_VCORE_MEM_STATE_NESTED} v3_vcore_mem_state_t;
+typedef enum {V3_VCORE_MEM_MODE_UNKNOWN, V3_VCORE_MEM_MODE_PHYSICAL, V3_VCORE_MEM_MODE_VIRTUAL} v3_vcore_mem_mode_t;
-/* This will contain Function pointers that control the VMs */
-struct vmm_ctrl_ops {
- struct guest_info *(*allocate_guest)();
+struct v3_vm_base_state {
+ v3_vm_state_t state;
+};
- 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);
+struct v3_vm_vcore_state {
+ v3_vcore_state_t state;
+ v3_vcore_cpu_mode_t cpu_mode;
+ v3_vcore_mem_state_t mem_state;
+ v3_vcore_mem_mode_t mem_mode;
+ unsigned long pcore;
+ void * last_rip;
+ unsigned long long num_exits;
+};
- int (*has_nested_paging)();
+struct v3_vm_core_state {
+ unsigned long num_vcores;
+ struct v3_vm_vcore_state vcore[];
+};
- // v3_cpu_arch_t (*get_cpu_arch)();
+struct v3_vm_mem_region {
+ void *host_paddr;
+ unsigned long long size;
};
+struct v3_vm_mem_state {
+ unsigned long long mem_size;
+ unsigned long num_regions;
+ struct v3_vm_mem_region region[];
+};
+char *v3_lookup_option(char *name);
+void Init_V3(struct v3_os_hooks * hooks, char * cpus, int num_cpus, char *options);
+void Shutdown_V3( void );
-//
-//
-// This is the interrupt state that the VMM's interrupt handlers need to see
-//
-struct v3_interrupt {
- unsigned int irq;
- unsigned int error;
+struct v3_vm_info * v3_create_vm(void * cfg, void * priv_data, char * name);
+int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask);
+int v3_stop_vm(struct v3_vm_info * vm);
+int v3_pause_vm(struct v3_vm_info * vm);
+int v3_continue_vm(struct v3_vm_info * vm);
+int v3_simulate_vm(struct v3_vm_info * vm, unsigned int msecs);
- unsigned int should_ack; // Should the vmm ack this interrupt, or will
- // the host OS do it?
-};
+int v3_save_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
+int v3_load_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
+
+int v3_send_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
+int v3_receive_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
+int v3_move_vm_core(struct v3_vm_info * vm, int vcore_id, int target_cpu);
+int v3_move_vm_mem(struct v3_vm_info * vm, void *gpa, int target_cpu);
+int v3_free_vm(struct v3_vm_info * vm);
+int v3_get_state_vm(struct v3_vm_info *vm,
+ struct v3_vm_base_state *base,
+ struct v3_vm_core_state *core,
+ struct v3_vm_mem_state *mem);
-void Init_V3(struct vmm_os_hooks * hooks, struct vmm_ctrl_ops * vmm_ops);
+char *v3_lookup_option(char *key);
-int v3_deliver_irq(struct guest_info * vm, struct v3_interrupt * intr);
-int v3_deliver_keyboard_evt(struct guest_info * vm);
+int v3_deliver_irq(struct v3_vm_info * vm, struct v3_interrupt * intr);
#endif