2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
26 #include <palacios/vmm_mem.h>
27 #include <palacios/vmm_types.h>
28 #include <palacios/vmm_string.h>
33 /* utility definitions */
35 #define VM_NONE ((struct v3_vm_info *)0)
36 #define VCORE_NONE ((struct guest_info *)0)
38 void *v3_get_host_vm(struct v3_vm_info *);
39 int v3_get_vcore(struct guest_info *);
41 #define V3_Print(vm, vcore, fmt, args...) \
43 extern struct v3_os_hooks * os_hooks; \
44 if ((os_hooks) && (os_hooks)->print) { \
45 (os_hooks)->print(v3_get_host_vm(vm), v3_get_vcore(vcore), (fmt), ##args); \
50 #define PrintDebug(vm, vcore, fmt, args...) V3_Print(vm, vcore, "DEBUG: " fmt, ##args)
52 #define PrintError(vm, vcore, fmt, args...) V3_Print(vm, vcore, "ERROR at %s(%d): " fmt, __FILE__, __LINE__, ##args)
57 #define V3_AllocPages(num_pages) \
59 extern struct v3_os_hooks * os_hooks; \
61 if ((os_hooks) && (os_hooks)->allocate_pages) { \
62 ptr = (os_hooks)->allocate_pages(num_pages,PAGE_SIZE_4KB,-1,0); \
68 #define V3_AllocAlignedPages(num_pages, align) \
70 extern struct v3_os_hooks * os_hooks; \
72 if ((os_hooks) && (os_hooks)->allocate_pages) { \
73 ptr = (os_hooks)->allocate_pages(num_pages,align,-1,0); \
79 #define V3_AllocPagesNode(num_pages, node_id) \
81 extern struct v3_os_hooks * os_hooks; \
83 if ((os_hooks) && (os_hooks)->allocate_pages) { \
84 ptr = (os_hooks)->allocate_pages(num_pages, PAGE_SIZE_4KB, node_id,0); \
89 #define V3_AllocPagesExtended(num_pages, align, node_id, constraints) \
91 extern struct v3_os_hooks * os_hooks; \
93 if ((os_hooks) && (os_hooks)->allocate_pages) { \
94 ptr = (os_hooks)->allocate_pages(num_pages, align, node_id,constraints); \
101 #define V3_FreePages(page, num_pages) \
103 extern struct v3_os_hooks * os_hooks; \
104 if ((os_hooks) && (os_hooks)->free_pages) { \
105 (os_hooks)->free_pages(page, num_pages); \
110 #define V3_VAddr(addr) ({ \
111 extern struct v3_os_hooks * os_hooks; \
113 if ((os_hooks) && (os_hooks)->paddr_to_vaddr) { \
114 var = (os_hooks)->paddr_to_vaddr(addr); \
120 #define V3_PAddr(addr) ({ \
121 extern struct v3_os_hooks * os_hooks; \
123 if ((os_hooks) && (os_hooks)->vaddr_to_paddr) { \
124 var = (os_hooks)->vaddr_to_paddr(addr); \
131 #define V3_Malloc(size) ({ \
132 extern struct v3_os_hooks * os_hooks; \
134 if ((os_hooks) && (os_hooks)->malloc) { \
135 var = (os_hooks)->malloc(size); \
137 if (!var) PrintError(VM_NONE,VCORE_NONE,"MALLOC FAILURE. Memory LEAK!!\n"); \
141 // We need to check the hook structure at runtime to ensure its SAFE
142 #define V3_Free(addr) \
144 extern struct v3_os_hooks * os_hooks; \
145 if ((os_hooks) && (os_hooks)->free) { \
146 (os_hooks)->free(addr); \
150 // uint_t V3_CPU_KHZ();
151 #define V3_CPU_KHZ() ({ \
152 unsigned int khz = 0; \
153 extern struct v3_os_hooks * os_hooks; \
154 if ((os_hooks) && (os_hooks)->get_cpu_khz) { \
155 khz = (os_hooks)->get_cpu_khz(); \
163 #define V3_Hook_Interrupt(vm, irq) ({ \
165 extern struct v3_os_hooks * os_hooks; \
166 if ((os_hooks) && (os_hooks)->hook_interrupt) { \
167 ret = (os_hooks)->hook_interrupt(vm, irq); \
173 #define V3_ACK_IRQ(irq) \
175 extern struct v3_os_hooks * os_hooks; \
176 if ((os_hooks) && (os_hooks)->ack_irq) { \
177 (os_hooks)->ack_irq(irq); \
183 #define V3_Get_CPU() ({ \
185 extern struct v3_os_hooks * os_hooks; \
186 if ((os_hooks) && (os_hooks)->get_cpu) { \
187 ret = (os_hooks)->get_cpu(); \
195 #define V3_CREATE_THREAD(fn, arg, name) ({ \
196 void * thread = NULL; \
197 extern struct v3_os_hooks * os_hooks; \
198 if ((os_hooks) && (os_hooks)->start_kernel_thread) { \
199 thread = (os_hooks)->start_kernel_thread(fn, arg, name); \
207 #define V3_Call_On_CPU(cpu, fn, arg) \
209 extern struct v3_os_hooks * os_hooks; \
210 if ((os_hooks) && (os_hooks)->call_on_cpu) { \
211 (os_hooks)->call_on_cpu(cpu, fn, arg); \
217 #define V3_CREATE_THREAD_ON_CPU(cpu, fn, arg, name) ({ \
218 void * thread = NULL; \
219 extern struct v3_os_hooks * os_hooks; \
220 if ((os_hooks) && (os_hooks)->start_thread_on_cpu) { \
221 thread = (os_hooks)->start_thread_on_cpu(cpu, fn, arg, name); \
226 #define V3_MOVE_THREAD_TO_CPU(pcpu, thread) ({ \
228 extern struct v3_os_hooks * os_hooks; \
229 if((os_hooks) && (os_hooks)->move_thread_to_cpu) { \
230 ret = (os_hooks)->move_thread_to_cpu(pcpu, thread); \
239 #define V3_ASSERT(vm, vcore, x) \
241 extern struct v3_os_hooks * os_hooks; \
243 PrintDebug(vm, vcore, "Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
244 __func__, #x, __FILE__, __LINE__, \
245 (ulong_t) __builtin_return_address(0)); \
247 if ((os_hooks) && (os_hooks)->yield_cpu) { \
248 (os_hooks)->yield_cpu(); \
258 extern struct v3_os_hooks * os_hooks; \
259 if ((os_hooks) && (os_hooks)->yield_cpu) { \
260 (os_hooks)->yield_cpu(); \
265 #define V3_Sleep(usec) \
267 extern struct v3_os_hooks * os_hooks; \
268 if ((os_hooks) && (os_hooks)->sleep_cpu) {\
269 (os_hooks)->sleep_cpu(usec); \
275 #define V3_Wakeup(cpu) \
277 extern struct v3_os_hooks * os_hooks; \
278 if ((os_hooks) && (os_hooks)->wakeup_cpu) { \
279 (os_hooks)->wakeup_cpu(cpu); \
284 typedef enum v3_vm_class {V3_INVALID_VM, V3_PC_VM, V3_CRAY_VM} v3_vm_class_t;
287 // Maybe make this a define....
288 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;
291 v3_cpu_mode_t v3_get_host_cpu_mode();
293 void v3_yield(struct guest_info * info, int usec);
294 void v3_yield_cond(struct guest_info * info, int usec);
295 void v3_print_cond(const char * fmt, ...);
297 void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu, int vector);
301 v3_cpu_arch_t v3_get_cpu_type(int cpu_id);
304 int v3_vm_enter(struct guest_info * info);
305 int v3_reset_vm_core(struct guest_info * core, addr_t rip);
308 #endif /*!__V3VEE__ */
314 /* This will contain function pointers that provide OS services */
316 // the vm pointer is the host os's "priv_data" from v3_create_vm
317 // if vm is null, this is a general palacios printout
318 // if vm is not null, and vcore is negative, this is a general print form the vm
319 // if vm is not null, and vcore is non-negative, this is a print from a specific vcore
320 void (*print)(void *vm, int vcore, const char * format, ...)
321 __attribute__ ((format (printf, 3, 4)));
323 // For page allocation:
324 // - node_id -1 => any node, otherwise the numa node we want to alloc from
325 // - constraint = 0 => no constraints, otherwise a bitwise-or of the following flags
326 #define V3_ALLOC_PAGES_CONSTRAINT_4GB 1
327 void *(*allocate_pages)(int num_pages, unsigned int alignment, int node_id, int constraint);
328 void (*free_pages)(void * page, int num_pages);
330 void *(*malloc)(unsigned int size);
331 void (*free)(void * addr);
333 void *(*paddr_to_vaddr)(void * addr);
334 void *(*vaddr_to_paddr)(void * addr);
336 int (*hook_interrupt)(struct v3_vm_info * vm, unsigned int irq);
337 int (*ack_irq)(int irq);
339 unsigned int (*get_cpu_khz)(void);
341 void (*yield_cpu)(void);
342 void (*sleep_cpu)(unsigned int usec);
343 void (*wakeup_cpu)(void *cpu);
345 void *(*mutex_alloc)(void);
346 void (*mutex_free)(void * mutex);
347 void (*mutex_lock)(void * mutex, int must_spin);
348 void (*mutex_unlock)(void * mutex);
349 void *(*mutex_lock_irqsave)(void * mutex, int must_spin);
350 void (*mutex_unlock_irqrestore)(void * mutex, void *flags);
352 unsigned int (*get_cpu)(void);
354 void * (*start_kernel_thread)(int (*fn)(void * arg), void * arg, char * thread_name);
355 void (*interrupt_cpu)(struct v3_vm_info * vm, int logical_cpu, int vector);
356 void (*call_on_cpu)(int logical_cpu, void (*fn)(void * arg), void * arg);
357 void * (*start_thread_on_cpu)(int cpu_id, int (*fn)(void * arg), void * arg, char * thread_name);
358 int (*move_thread_to_cpu)(int cpu_id, void * thread);
364 * This is the interrupt state that the VMM's interrupt handlers need to see
366 struct v3_interrupt {
370 unsigned int should_ack; /* Should the vmm ack this interrupt, or will
371 * the host OS do it? */
375 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;
376 typedef enum {V3_VCORE_UNKNOWN, V3_VCORE_INVALID, V3_VCORE_RUNNING, V3_VCORE_STOPPED} v3_vcore_state_t;
377 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;
379 typedef enum {V3_VCORE_MEM_STATE_UNKNOWN, V3_VCORE_MEM_STATE_SHADOW, V3_VCORE_MEM_STATE_NESTED} v3_vcore_mem_state_t;
380 typedef enum {V3_VCORE_MEM_MODE_UNKNOWN, V3_VCORE_MEM_MODE_PHYSICAL, V3_VCORE_MEM_MODE_VIRTUAL} v3_vcore_mem_mode_t;
383 struct v3_vm_base_state {
387 struct v3_vm_vcore_state {
388 v3_vcore_state_t state;
389 v3_vcore_cpu_mode_t cpu_mode;
390 v3_vcore_mem_state_t mem_state;
391 v3_vcore_mem_mode_t mem_mode;
394 unsigned long long num_exits;
397 struct v3_vm_core_state {
398 unsigned long num_vcores;
399 struct v3_vm_vcore_state vcore[];
402 struct v3_vm_mem_region {
404 unsigned long long size;
407 struct v3_vm_mem_state {
408 unsigned long long mem_size;
409 unsigned long num_regions;
410 struct v3_vm_mem_region region[];
413 char *v3_lookup_option(char *name);
414 void Init_V3(struct v3_os_hooks * hooks, char * cpus, int num_cpus, char *options);
415 void Shutdown_V3( void );
418 struct v3_vm_info * v3_create_vm(void * cfg, void * priv_data, char * name);
419 int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask);
420 int v3_stop_vm(struct v3_vm_info * vm);
421 int v3_pause_vm(struct v3_vm_info * vm);
422 int v3_continue_vm(struct v3_vm_info * vm);
423 int v3_simulate_vm(struct v3_vm_info * vm, unsigned int msecs);
425 int v3_save_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
426 int v3_load_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
428 int v3_send_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
429 int v3_receive_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
431 int v3_move_vm_core(struct v3_vm_info * vm, int vcore_id, int target_cpu);
432 int v3_move_vm_mem(struct v3_vm_info * vm, void *gpa, int target_cpu);
434 int v3_free_vm(struct v3_vm_info * vm);
436 int v3_get_state_vm(struct v3_vm_info *vm,
437 struct v3_vm_base_state *base,
438 struct v3_vm_core_state *core,
439 struct v3_vm_mem_state *mem);
441 char *v3_lookup_option(char *key);
443 int v3_deliver_irq(struct v3_vm_info * vm, struct v3_interrupt * intr);