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.


Added non-contiguous memory region support.
[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
17 #define V3_ADD_PCI_HW_DEV 55
18 #define V3_ADD_PCI_USER_DEV 56
19
20 /* VM Specific IOCTLs */
21 #define V3_VM_CONSOLE_CONNECT 20
22 #define V3_VM_STREAM_CONNECT 21
23
24 #define V3_VM_PAUSE 23
25 #define V3_VM_CONTINUE 24
26
27 #define V3_VM_LAUNCH 25
28 #define V3_VM_STOP 26
29 #define V3_VM_LOAD 27
30 #define V3_VM_SAVE 28
31 #define V3_VM_SIMULATE 29
32
33 #define V3_VM_INSPECT 30
34 #define V3_VM_DEBUG 31
35
36 #define V3_VM_MOVE_CORE 33
37
38 #define V3_VM_SEND    34
39 #define V3_VM_RECEIVE 35
40
41 #define V3_VM_FB_INPUT 257
42 #define V3_VM_FB_QUERY 258
43
44 #define V3_VM_HOST_DEV_CONNECT 10245
45
46 #define V3_VM_KSTREAM_USER_CONNECT 11245
47
48
49 struct v3_guest_img {
50     unsigned long long size;
51     void * guest_data;
52     char name[128];
53 } __attribute__((packed));
54
55 struct v3_mem_region {
56     unsigned long long base_addr;
57     unsigned long long num_pages;
58 } __attribute__((packed));
59
60 struct v3_debug_cmd {
61     unsigned int core; 
62     unsigned int cmd;
63 } __attribute__((packed));
64
65 struct v3_core_move_cmd {
66     unsigned short vcore_id;
67     unsigned short pcore_id;
68 } __attribute__((packed));
69
70 struct v3_chkpt_info {
71     char store[128];
72     char url[256]; /* This might need to be bigger... */
73     unsigned long long opts;
74 #define V3_CHKPT_OPT_NONE         0
75 #define V3_CHKPT_OPT_SKIP_MEM     1  // don't write memory to store
76 #define V3_CHKPT_OPT_SKIP_DEVS    2  // don't write devices to store
77 #define V3_CHKPT_OPT_SKIP_CORES   4  // don't write core arch ind data to store
78 #define V3_CHKPT_OPT_SKIP_ARCHDEP 8  // don't write core arch dep data to store
79 } __attribute__((packed));
80
81
82 struct v3_hw_pci_dev {
83     char name[128];
84     unsigned int bus;
85     unsigned int dev;
86     unsigned int func;
87 } __attribute__((packed));
88
89 struct v3_user_pci_dev {
90     char name[128];
91     unsigned short vendor_id;
92     unsigned short dev_id;
93 } __attribute__((packed));
94
95
96
97 void * trace_malloc(size_t size, gfp_t flags);
98 void trace_free(const void * objp);
99
100
101 struct v3_guest {
102     void * v3_ctx;
103
104     void * img; 
105     u32 img_size;
106
107     char name[128];
108
109
110     struct rb_root vm_ctrls;
111     struct list_head exts;
112
113     dev_t vm_dev; 
114     struct cdev cdev;
115 };
116
117 // For now MAX_VMS must be a multiple of 8
118 // This is due to the minor number bitmap
119 #define MAX_VMS 32
120
121
122
123 int palacios_vmm_init( char *options );
124 int palacios_vmm_exit( void );
125
126
127 // This is how a component finds the proc dir we are using for global state
128 struct proc_dir_entry *palacios_get_procdir(void);
129
130 // Selected exported stubs, for use in other palacios components, like vnet
131 // The idea is that everything uses the same stubs
132 void  palacios_print_scoped(void *vm, int vcore, const char *fmt, ...);
133 #define palacios_print(...) palacios_print_scoped(0,-1, __VA_ARGS__)
134 void *palacios_allocate_pages(int num_pages, unsigned int alignment, int node_id);
135 void  palacios_free_pages(void *page_addr, int num_pages);
136 void *palacios_alloc(unsigned int size);
137 void *palacios_alloc_extended(unsigned int size, unsigned int flags);
138 // FIX
139 // NEED A palacios_alloc_node wrapper
140 //
141 #define palacios_alloc_node_extended(size, flags, node) kmalloc_node(size,flags,node)
142 void  palacios_free(void *);
143 void *palacios_valloc(unsigned int size); // use instead of vmalloc
144 void  palacios_vfree(void *);             // use instead of vfree
145 void *palacios_vaddr_to_paddr(void *vaddr);
146 void *palacios_paddr_to_vaddr(void *paddr);
147 void *palacios_start_kernel_thread(int (*fn)(void * arg), void *arg, char *thread_name);
148 void *palacios_start_thread_on_cpu(int cpu_id, int (*fn)(void * arg), void *arg, char *thread_name);
149 int   palacios_move_thread_to_cpu(int new_cpu_id, void *thread_ptr);
150 void  palacios_yield_cpu(void);
151 void  palacios_yield_cpu_timed(unsigned int us);
152 unsigned int palacios_get_cpu(void);
153 unsigned int palacios_get_cpu_khz(void);
154 void *palacios_mutex_alloc(void);         // allocates and inits a lock
155 void  palacios_mutex_init(void *mutex);   // only inits a lock
156 void  palacios_mutex_deinit(void *mutex); // only deinits a lock
157 void  palacios_mutex_free(void *mutex);   // deinits and frees a lock
158 void  palacios_mutex_lock(void *mutex, int must_spin);
159 void  palacios_mutex_unlock(void *mutex);
160 void *palacios_mutex_lock_irqsave(void *mutex, int must_spin);
161 void  palacios_mutex_unlock_irqrestore(void *mutex, void *flags);
162 // Macros for spin-locks in the module code
163 // By using these macros, the lock checker will be able
164 // to see the module code as well as the core VMM
165 #define palacios_spinlock_init(l) palacios_mutex_init(l)
166 #define palacios_spinlock_deinit(l) palacios_mutex_deinit(l)
167 #define palacios_spinlock_lock(l) palacios_mutex_lock(l,0)
168 #define palacios_spinlock_unlock(l) palacios_mutex_unlock(l)
169 #define palacios_spinlock_lock_irqsave(l,f) do { f=(unsigned long)palacios_mutex_lock_irqsave(l,0); } while (0)
170 #define palacios_spinlock_unlock_irqrestore(l,f) palacios_mutex_unlock_irqrestore(l,(void*)f)
171
172
173 // Palacios Printing Support
174
175 // These macros affect how palacios_print will generate output
176 // Turn this on for unprefaced output from palacios_print
177 #define V3_PRINTK_OLD_STYLE_OUTPUT 0
178 // Maximum length output from palacios_print
179 #define V3_PRINTK_BUF_SIZE 1024
180 // Turn this on to check if new-style output for palacios_print  contains only 7-bit chars
181 #define V3_PRINTK_CHECK_7BIT 1
182
183 //
184 // The following macros are for printing in the linux module itself, even before
185 // Palacios is initialized and after it it deinitialized
186 // All printk's in linux_module use these macros, for easier control
187 #define ERROR(fmt, args...) printk((KERN_ERR "palacios (pcore %u) %s(%d): " fmt), palacios_get_cpu(), __FILE__, __LINE__, ##args)
188 #define WARNING(fmt, args...) printk((KERN_WARNING "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
189 #define NOTICE(fmt, args...) printk((KERN_NOTICE "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
190 #define INFO(fmt, args...) printk((KERN_INFO "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
191 #define DEBUG(fmt, args...) printk((KERN_DEBUG "palacios (pcore %u): " fmt), palacios_get_cpu(), ##args)
192
193
194 #endif