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".
24 //#include <palacios/vm_guest.h>
25 #include <palacios/vmm_mem.h>
26 #include <palacios/vmm_types.h>
33 //#include <palacios/vmm_types.h>
34 #include <palacios/vmm_string.h>
37 //#include <palacios/vmm_paging.h>
39 /* utility definitions */
42 #define V3_Print(fmt, args...) \
44 extern struct v3_os_hooks * os_hooks; \
45 if ((os_hooks) && (os_hooks)->print) { \
46 (os_hooks)->print((fmt), ##args); \
51 #define PrintDebug(fmt, args...) \
53 extern struct v3_os_hooks * os_hooks; \
54 if ((os_hooks) && (os_hooks)->print) { \
55 (os_hooks)->print((fmt), ##args); \
60 #define PrintError(fmt, args...) \
62 extern struct v3_os_hooks * os_hooks; \
63 if ((os_hooks) && (os_hooks)->print) { \
64 (os_hooks)->print("%s(%d): " fmt, __FILE__, __LINE__, ##args); \
70 #define V3_AllocPages(num_pages) \
72 extern struct v3_os_hooks * os_hooks; \
74 if ((os_hooks) && (os_hooks)->allocate_pages) { \
75 ptr = (os_hooks)->allocate_pages(num_pages); \
81 #define V3_FreePage(page) \
83 extern struct v3_os_hooks * os_hooks; \
84 if ((os_hooks) && (os_hooks)->free_page) { \
85 (os_hooks)->free_page(page); \
90 #define V3_VAddr(addr) ({ \
91 extern struct v3_os_hooks * os_hooks; \
93 if ((os_hooks) && (os_hooks)->paddr_to_vaddr) { \
94 var = (os_hooks)->paddr_to_vaddr(addr); \
100 #define V3_PAddr(addr) ({ \
101 extern struct v3_os_hooks * os_hooks; \
103 if ((os_hooks) && (os_hooks)->vaddr_to_paddr) { \
104 var = (os_hooks)->vaddr_to_paddr(addr); \
111 #define V3_Malloc(size) ({ \
112 extern struct v3_os_hooks * os_hooks; \
114 if ((os_hooks) && (os_hooks)->malloc) { \
115 var = (os_hooks)->malloc(size); \
117 if (!var) PrintError("MALLOC FAILURE. Memory LEAK!!\n"); \
121 // We need to check the hook structure at runtime to ensure its SAFE
122 #define V3_Free(addr) \
124 extern struct v3_os_hooks * os_hooks; \
125 if ((os_hooks) && (os_hooks)->free) { \
126 (os_hooks)->free(addr); \
130 // uint_t V3_CPU_KHZ();
131 #define V3_CPU_KHZ() ({ \
132 unsigned int khz = 0; \
133 extern struct v3_os_hooks * os_hooks; \
134 if ((os_hooks) && (os_hooks)->get_cpu_khz) { \
135 khz = (os_hooks)->get_cpu_khz(); \
142 #define V3_CREATE_THREAD(fn, arg, name) \
144 extern struct v3_os_hooks * os_hooks; \
145 if ((os_hooks) && (os_hooks)->start_kernel_thread) { \
146 (os_hooks)->start_kernel_thread(fn, arg, name); \
151 #define V3_Hook_Interrupt(vm, irq) ({ \
153 extern struct v3_os_hooks * os_hooks; \
154 if ((os_hooks) && (os_hooks)->hook_interrupt) { \
155 ret = (os_hooks)->hook_interrupt(vm, irq); \
161 #define V3_Get_CPU() ({ \
163 extern struct v3_os_hooks * os_hooks; \
164 if ((os_hooks) && (os_hooks)->get_cpu) { \
165 ret = (os_hooks)->get_cpu(); \
170 #define V3_Call_On_CPU(cpu, fn, arg) \
172 extern struct v3_os_hooks * os_hooks; \
173 if ((os_hooks) && (os_hooks)->call_on_cpu) { \
174 (os_hooks)->call_on_cpu(cpu, fn, arg); \
179 #define V3_ACK_IRQ(irq) \
181 extern struct v3_os_hooks * os_hooks; \
182 if ((os_hooks) && (os_hooks)->ack_irq) { \
183 (os_hooks)->ack_irq(irq); \
193 #define V3_ASSERT(x) \
196 PrintDebug("Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
197 __func__, #x, __FILE__, __LINE__, \
198 (ulong_t) __builtin_return_address(0)); \
207 typedef enum v3_vm_class {V3_INVALID_VM, V3_PC_VM, V3_CRAY_VM} v3_vm_class_t;
210 // Maybe make this a define....
211 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;
214 v3_cpu_mode_t v3_get_host_cpu_mode();
216 void v3_yield(struct guest_info * info);
217 void v3_yield_cond(struct guest_info * info);
218 void v3_print_cond(const char * fmt, ...);
221 void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu);
223 unsigned int v3_get_cpu_id();
225 v3_cpu_arch_t v3_get_cpu_type(int cpu_id);
228 int v3_vm_enter(struct guest_info * info);
237 /* This will contain function pointers that provide OS services */
239 void (*print)(const char * format, ...)
240 __attribute__ ((format (printf, 1, 2)));
242 void *(*allocate_pages)(int numPages);
243 void (*free_page)(void * page);
245 void *(*malloc)(unsigned int size);
246 void (*free)(void * addr);
248 void *(*paddr_to_vaddr)(void *addr);
249 void *(*vaddr_to_paddr)(void *addr);
251 int (*hook_interrupt)(struct v3_vm_info * vm, unsigned int irq);
253 int (*ack_irq)(int irq);
255 unsigned int (*get_cpu_khz)(void);
257 void (*start_kernel_thread)(int (*fn)(void * arg), void * arg, char * thread_name);
259 void (*yield_cpu)(void);
261 void *(*mutex_alloc)(void);
262 void (*mutex_free)(void * mutex);
263 void (*mutex_lock)(void * mutex, int must_spin);
264 void (*mutex_unlock)(void * mutex);
266 unsigned int (*get_cpu)(void);
267 void (*interrupt_cpu)(struct v3_vm_info * vm, int logical_cpu);
268 void (*call_on_cpu)(int logical_cpu, void (*fn)(void * arg), void * arg);
269 void (*start_thread_on_cpu)(int logical_cpu, int (*fn)(void * arg), void * arg, char * thread_name);
280 // This is the interrupt state that the VMM's interrupt handlers need to see
282 struct v3_interrupt {
286 unsigned int should_ack; // Should the vmm ack this interrupt, or will
287 // the host OS do it?
293 void Init_V3(struct v3_os_hooks * hooks, int num_cpus);
296 int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask);
297 struct v3_vm_info * v3_create_vm(void * cfg);
299 int v3_deliver_irq(struct v3_vm_info * vm, struct v3_interrupt * intr);