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