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>
29 //#include <palacios/vmm_types.h>
30 #include <palacios/vmm_string.h>
33 //#include <palacios/vmm_paging.h>
35 /* utility definitions */
38 #define PrintDebug(fmt, args...) \
40 extern struct v3_os_hooks * os_hooks; \
41 if ((os_hooks) && (os_hooks)->print_debug) { \
42 (os_hooks)->print_debug((fmt), ##args); \
46 #define PrintDebug(fmt,args ...)
51 #define PrintError(fmt, args...) \
53 extern struct v3_os_hooks * os_hooks; \
54 if ((os_hooks) && (os_hooks)->print_debug) { \
55 (os_hooks)->print_debug("%s(%d): " fmt, __FILE__, __LINE__, ##args); \
62 #define PrintInfo(fmt, args...) \
64 extern struct v3_os_hooks * os_hooks; \
65 if ((os_hooks) && (os_hooks)->print_info) { \
66 (os_hooks)->print_info((fmt), ##args); \
70 #define PrintInfo(fmt, args...)
75 #define PrintTrace(fmt, args...) \
77 extern struct v3_os_hooks * os_hooks; \
78 if ((os_hooks) && (os_hooks)->print_trace) { \
79 (os_hooks)->print_trace(fmt, ##args); \
83 #define PrintTrace(fmt, args...)
87 #define V3_AllocPages(num_pages) \
89 extern struct v3_os_hooks * os_hooks; \
91 if ((os_hooks) && (os_hooks)->allocate_pages) { \
92 ptr = (os_hooks)->allocate_pages(num_pages); \
98 #define V3_FreePage(page) \
100 extern struct v3_os_hooks * os_hooks; \
101 if ((os_hooks) && (os_hooks)->free_page) { \
102 (os_hooks)->free_page(page); \
107 #define V3_VAddr(addr) ({ \
108 extern struct v3_os_hooks * os_hooks; \
110 if ((os_hooks) && (os_hooks)->paddr_to_vaddr) { \
111 var = (os_hooks)->paddr_to_vaddr(addr); \
117 #define V3_PAddr(addr) ({ \
118 extern struct v3_os_hooks * os_hooks; \
120 if ((os_hooks) && (os_hooks)->vaddr_to_paddr) { \
121 var = (os_hooks)->vaddr_to_paddr(addr); \
128 #define V3_Malloc(size) ({ \
129 extern struct v3_os_hooks * os_hooks; \
131 if ((os_hooks) && (os_hooks)->malloc) { \
132 var = (os_hooks)->malloc(size); \
137 // We need to check the hook structure at runtime to ensure its SAFE
138 #define V3_Free(addr) \
140 extern struct v3_os_hooks * os_hooks; \
141 if ((os_hooks) && (os_hooks)->free) { \
142 (os_hooks)->free(addr); \
147 // uint_t V3_CPU_KHZ();
148 #define V3_CPU_KHZ() \
150 unsigned int khz = 0; \
151 extern struct v3_os_hooks * os_hooks; \
152 if ((os_hooks) && (os_hooks)->get_cpu_khz) { \
153 khz = (os_hooks)->get_cpu_khz(); \
160 #define V3_Hook_Interrupt(irq, opaque) \
163 extern struct v3_os_hooks * os_hooks; \
164 if ((os_hooks) && (os_hooks)->hook_interrupt) { \
165 ret = (os_hooks)->hook_interrupt(irq, opaque); \
170 #define V3_Yield(addr) \
172 extern struct v3_os_hooks * os_hooks; \
173 if ((os_hooks) && (os_hooks)->yield_cpu) { \
174 (os_hooks)->yield_cpu(); \
184 #define V3_ASSERT(x) \
187 PrintDebug("Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
188 __func__, #x, __FILE__, __LINE__, \
189 (ulong_t) __builtin_return_address(0)); \
197 #define VMM_INVALID_CPU 0
198 #define VMM_VMX_CPU 1
199 #define VMM_SVM_CPU 2
202 // Maybe make this a define....
203 typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU} v3_cpu_arch_t;
212 /* This will contain function pointers that provide OS services */
214 void (*print_info)(const char * format, ...)
215 __attribute__ ((format (printf, 1, 2)));
216 void (*print_debug)(const char * format, ...)
217 __attribute__ ((format (printf, 1, 2)));
218 void (*print_trace)(const char * format, ...)
219 __attribute__ ((format (printf, 1, 2)));
221 void *(*allocate_pages)(int numPages);
222 void (*free_page)(void * page);
224 void *(*malloc)(unsigned int size);
225 void (*free)(void * addr);
227 void *(*paddr_to_vaddr)(void *addr);
228 void *(*vaddr_to_paddr)(void *addr);
230 // int (*hook_interrupt)(struct guest_info *s, int irq);
232 int (*hook_interrupt)(struct guest_info * vm, unsigned int irq);
234 int (*ack_irq)(int irq);
237 unsigned int (*get_cpu_khz)(void);
240 void (*start_kernel_thread)(void); // include pointer to function
242 void (*yield_cpu)(void);
247 struct v3_vm_config {
254 unsigned long mem_size; // in bytes, var should be natural size of cpu
255 // so we can specify maximum physical address size
256 // (We're screwed if we want to do 32 bit host/64 bit guest)
265 /* This will contain Function pointers that control the VMs */
267 struct guest_info *(*allocate_guest)(void);
269 int (*config_guest)(struct guest_info * info, struct v3_vm_config * config_ptr);
270 int (*init_guest)(struct guest_info * info);
271 int (*start_guest)(struct guest_info * info);
272 // int (*stop_vm)(uint_t vm_id);
274 int (*has_nested_paging)(void);
276 // v3_cpu_arch_t (*get_cpu_arch)();
284 // This is the interrupt state that the VMM's interrupt handlers need to see
286 struct v3_interrupt {
290 unsigned int should_ack; // Should the vmm ack this interrupt, or will
291 // the host OS do it?
297 void Init_V3(struct v3_os_hooks * hooks, struct v3_ctrl_ops * vmm_ops);
299 int v3_deliver_irq(struct guest_info * vm, struct v3_interrupt * intr);
300 int v3_deliver_keyboard_evt(struct guest_info * vm);