Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


Correct VM deallocation on fail before nested paging init
[palacios.git] / linux_module / palacios.h
1 #ifndef _PALACIOS_H
2 #define _PALACIOS_H
3
4 #include <linux/cdev.h>
5 #include <linux/list.h>
6 #include <linux/sched.h>
7 #include <linux/slab.h>
8
9
10 /* Global Control IOCTLs */
11 #define V3_CREATE_GUEST 12
12 #define V3_FREE_GUEST 13
13
14 #define V3_ADD_MEMORY    50
15 #define V3_RESET_MEMORY  51
16 #define V3_REMOVE_MEMORY 52
17
18 #define V3_ADD_PCI_HW_DEV 55
19 #define V3_ADD_PCI_USER_DEV 56
20
21 #define V3_DVFS_CTRL  60
22
23
24 /* VM Specific IOCTLs */
25 #define V3_VM_CONSOLE_CONNECT 20
26 #define V3_VM_STREAM_CONNECT 21
27
28 #define V3_VM_PAUSE 23
29 #define V3_VM_CONTINUE 24
30
31 #define V3_VM_LAUNCH 25
32 #define V3_VM_STOP 26
33 #define V3_VM_LOAD 27
34 #define V3_VM_SAVE 28
35 #define V3_VM_SIMULATE 29
36
37 #define V3_VM_INSPECT 30
38 #define V3_VM_DEBUG 31
39
40 #define V3_VM_MOVE_CORE 33
41
42 #define V3_VM_SEND    34
43 #define V3_VM_RECEIVE 35
44
45 #define V3_VM_MOVE_MEM 36
46
47 #define V3_VM_RESET    40
48
49 #define V3_VM_FB_INPUT 257
50 #define V3_VM_FB_QUERY 258
51
52 #define V3_VM_MEM_TRACK_SIZE 300
53 #define V3_VM_MEM_TRACK_CMD  301
54 #define V3_VM_MEM_TRACK_SNAP 302
55
56 #define V3_VM_HOST_DEV_CONNECT 10245
57
58 #define V3_VM_KSTREAM_USER_CONNECT 11245
59
60
61 struct v3_guest_img {
62     unsigned long long size;
63     void * guest_data;
64     char name[128];
65 } __attribute__((packed));
66
67 typedef enum { PREALLOCATED=0,         // user space-allocated (e.g. hot remove)
68               REQUESTED,               // kernel will attempt allocation (anywhere)
69               REQUESTED32,             // kernel will attempt allocation (<4GB)
70 } v3_mem_region_type_t;
71
72 struct v3_mem_region {
73     v3_mem_region_type_t type;         // 
74     int                  node;         // numa node for REQUESTED (-1 = any)
75     unsigned long long   base_addr;    // region start (hpa) for PREALLOCATED
76     unsigned long long   num_pages;    // size for PREALLOCATED or request size for REQUESTED
77                                        // should be power of 2 and > V3_CONFIG_MEM_BLOCK
78 } __attribute__((packed));
79
80 struct v3_debug_cmd {
81     unsigned int core; 
82     unsigned int cmd;
83 } __attribute__((packed));
84
85 struct v3_core_move_cmd {
86     unsigned short vcore_id;
87     unsigned short pcore_id;
88 } __attribute__((packed));
89
90 struct v3_mem_move_cmd{
91     unsigned long long gpa;
92     unsigned short     pcore_id;
93 } __attribute__((packed));
94
95 struct v3_reset_cmd {
96 #define V3_RESET_VM_ALL    0
97 #define V3_RESET_VM_HRT    1
98 #define V3_RESET_VM_ROS    2
99 #define V3_RESET_VM_CORE_RANGE  3
100     unsigned int type;
101     unsigned int first_core;  // for CORE_RANGE
102     unsigned int num_cores;   // for CORE_RANGE
103 } __attribute__((packed));
104     
105 struct v3_chkpt_info {
106     char store[128];
107     char url[256]; /* This might need to be bigger... */
108     unsigned long long opts;
109 #define V3_CHKPT_OPT_NONE         0
110 #define V3_CHKPT_OPT_SKIP_MEM     1  // don't write memory to store
111 #define V3_CHKPT_OPT_SKIP_DEVS    2  // don't write devices to store
112 #define V3_CHKPT_OPT_SKIP_CORES   4  // don't write core arch ind data to store
113 #define V3_CHKPT_OPT_SKIP_ARCHDEP 8  // don't write core arch dep data to store
114 } __attribute__((packed));
115
116
117 struct v3_hw_pci_dev {
118     char name[128];
119     unsigned int bus;
120     unsigned int dev;
121     unsigned int func;
122 } __attribute__((packed));
123
124 struct v3_user_pci_dev {
125     char name[128];
126     unsigned short vendor_id;
127     unsigned short dev_id;
128 } __attribute__((packed));
129
130
131
132 void * trace_malloc(size_t size, gfp_t flags);
133 void trace_free(const void * objp);
134
135
136 struct v3_guest {
137     void * v3_ctx;
138
139     void * img; 
140     u32 img_size;
141
142     char name[128];
143
144
145     struct rb_root vm_ctrls;
146     struct list_head exts;
147
148     dev_t vm_dev; 
149     struct cdev cdev;
150 };
151
152 // For now MAX_VMS must be a multiple of 8
153 // This is due to the minor number bitmap
154 #define MAX_VMS 32
155 #define MAX_THREADS (MAX_VMS*64)
156
157
158 int palacios_vmm_init( char *options );
159 int palacios_vmm_exit( void );
160
161
162 // This is how a component finds the proc dir we are using for global state
163 struct proc_dir_entry *palacios_get_procdir(void);
164
165 struct v3_resource_control;
166
167 // Selected exported stubs, for use in other palacios components, like vnet
168 // The idea is that everything uses the same stubs
169 void  palacios_print_scoped(void *vm, int vcore, const char *fmt, ...);
170 #define palacios_print(...) palacios_print_scoped(0,-1, __VA_ARGS__)
171 // node_id=-1 => no node constraint
172 void *palacios_allocate_pages(int num_pages, unsigned int alignment, int node_id, int (*filter_func)(void *paddr, void *filter_state), void *filter_state);
173 void  palacios_free_pages(void *page_addr, int num_pages);
174 void *palacios_alloc(unsigned int size);
175 // node_id=-1 => no node constraint
176 void *palacios_alloc_extended(unsigned int size, unsigned int flags, int node_id);
177 void  palacios_free(void *);
178 void *palacios_valloc(unsigned int size); // use instead of vmalloc
179 void  palacios_vfree(void *);             // use instead of vfree
180 void *palacios_vaddr_to_paddr(void *vaddr);
181 void *palacios_paddr_to_vaddr(void *paddr);
182 void  palacios_xcall(int cpu_id, void (*fn)(void *arg), void *arg);
183 void *palacios_create_and_start_kernel_thread(int (*fn)(void * arg), void *arg, char *thread_name, struct v3_resource_control *rc);
184 void *palacios_create_thread_on_cpu(int cpu_id, int (*fn)(void * arg), void *arg, char *thread_name, struct v3_resource_control *rc);
185 void  palacios_start_thread(void *thread_ptr);
186 void *palacios_creeate_and_start_thread_on_cpu(int cpu_id, int (*fn)(void * arg), void *arg, char *thread_name, struct v3_resource_control *rc);
187 int   palacios_move_thread_to_cpu(int new_cpu_id, void *thread_ptr);
188 void  palacios_yield_cpu(void);
189 void  palacios_sleep_cpu(unsigned int us);
190 unsigned int palacios_get_cpu(void);
191 unsigned int palacios_get_cpu_khz(void);
192 void  palacios_used_fpu(void);
193 void  palacios_need_fpu(void);
194 void *palacios_mutex_alloc(void);         // allocates and inits a lock
195 void  palacios_mutex_init(void *mutex);   // only inits a lock
196 void  palacios_mutex_deinit(void *mutex); // only deinits a lock
197 void  palacios_mutex_free(void *mutex);   // deinits and frees a lock
198 void  palacios_mutex_lock(void *mutex, int must_spin);
199 void  palacios_mutex_unlock(void *mutex);
200 void *palacios_mutex_lock_irqsave(void *mutex, int must_spin);
201 void  palacios_mutex_unlock_irqrestore(void *mutex, void *flags);
202 // Macros for spin-locks in the module code
203 // By using these macros, the lock checker will be able
204 // to see the module code as well as the core VMM
205 #define palacios_spinlock_init(l) palacios_mutex_init(l)
206 #define palacios_spinlock_deinit(l) palacios_mutex_deinit(l)
207 #define palacios_spinlock_lock(l) palacios_mutex_lock(l,0)
208 #define palacios_spinlock_unlock(l) palacios_mutex_unlock(l)
209 #define palacios_spinlock_lock_irqsave(l,f) do { f=(unsigned long)palacios_mutex_lock_irqsave(l,0); } while (0)
210 #define palacios_spinlock_unlock_irqrestore(l,f) palacios_mutex_unlock_irqrestore(l,(void*)f)
211
212
213 // Palacios Printing Support
214
215 // These macros affect how palacios_print will generate output
216 // Turn this on for unprefaced output from palacios_print
217 #define V3_PRINTK_OLD_STYLE_OUTPUT 0
218 // Maximum length output from palacios_print
219 #define V3_PRINTK_BUF_SIZE 1024
220 // Turn this on to check if new-style output for palacios_print  contains only 7-bit chars
221 #define V3_PRINTK_CHECK_7BIT 1
222
223 //
224 // The following macros are for printing in the linux module itself, even before
225 // Palacios is initialized and after it it deinitialized
226 // All printk's in linux_module use these macros, for easier control
227 #define ERROR(fmt, args...) printk((KERN_ERR "palacios (pcore %u) %s(%d): " fmt), palacios_get_cpu(), __FILE__, __LINE__, ##args)
228 #define WARNING(fmt, args...) printk((KERN_WARNING "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
229 #define NOTICE(fmt, args...) printk((KERN_NOTICE "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
230 #define INFO(fmt, args...) printk((KERN_INFO "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
231 #define DEBUG(fmt, args...) printk((KERN_DEBUG "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
232
233
234 #endif