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