palacios/include/palacios/vmm.h

   1 /*
   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.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  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.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  20 #ifndef __VMM_H__
  21 #define __VMM_H__
  22
  23
  24
  25 #ifdef __V3VEE__
  26 #include <palacios/vmm_mem.h>
  27 #include <palacios/vmm_types.h>
  28 #include <palacios/vmm_string.h>
  29
  30
  31
  32
  33 /* utility definitions */
  34
  35 #define VM_NONE ((struct v3_vm_info *)0)
  36 #define VCORE_NONE ((struct guest_info *)0)
  37
  38 void    *v3_get_host_vm(struct v3_vm_info *);
  39 int      v3_get_vcore(struct guest_info *);
  40
  41 #define V3_Print(vm, vcore, fmt, args...)       \
  42   do {                                                          \
  43     extern struct v3_os_hooks * os_hooks;                       \
  44     if ((os_hooks) && (os_hooks)->print) {                      \
  45       (os_hooks)->print(v3_get_host_vm(vm), v3_get_vcore(vcore), (fmt), ##args); \
  46     }                                                                   \
  47   } while (0)
  48
  49
  50 #define PrintDebug(vm, vcore, fmt, args...)   V3_Print(vm, vcore, "DEBUG: " fmt, ##args)
  51
  52 #define PrintError(vm, vcore, fmt, args...)  V3_Print(vm, vcore, "ERROR at %s(%d): " fmt, __FILE__, __LINE__, ##args)
  53
  54
  55
  56 /* 4KB-aligned */
  57 #define V3_AllocPages(num_pages)                                        \
  58     ({                                                                  \
  59         extern struct v3_os_hooks * os_hooks;                           \
  60         void * ptr = 0;                                                 \
  61         if ((os_hooks) && (os_hooks)->allocate_pages) {                 \
  62             ptr = (os_hooks)->allocate_pages(num_pages,PAGE_SIZE_4KB,-1,0,0); \
  63         }                                                               \
  64         ptr;                                                            \
  65     })
  66
  67
  68 #define V3_AllocAlignedPages(num_pages, align)                          \
  69     ({                                                                  \
  70         extern struct v3_os_hooks * os_hooks;                           \
  71         void * ptr = 0;                                                 \
  72         if ((os_hooks) && (os_hooks)->allocate_pages) {                 \
  73             ptr = (os_hooks)->allocate_pages(num_pages,align,-1,0,0);   \
  74         }                                                               \
  75         ptr;                                                            \
  76     })
  77
  78
  79 #define V3_AllocPagesNode(num_pages, node_id)                           \
  80     ({                                                                  \
  81         extern struct v3_os_hooks * os_hooks;                           \
  82         void * ptr = 0;                                                 \
  83         if ((os_hooks) && (os_hooks)->allocate_pages) {                 \
  84             ptr = (os_hooks)->allocate_pages(num_pages, PAGE_SIZE_4KB, node_id,0,0); \
  85         }                                                               \
  86         ptr;                                                            \
  87     })
  88
  89 #define V3_AllocPagesExtended(num_pages, align, node_id, filter_func, filter_state) \
  90     ({                                                                  \
  91         extern struct v3_os_hooks * os_hooks;                           \
  92         void * ptr = 0;                                                 \
  93         if ((os_hooks) && (os_hooks)->allocate_pages) {                 \
  94             ptr = (os_hooks)->allocate_pages(num_pages, align, node_id, filter_func, filter_state); \
  95         }                                                               \
  96         ptr;                                                            \
  97     })
  98
  99
 100
 101 #define V3_FreePages(page, num_pages)                   \
 102     do {                                                \
 103         extern struct v3_os_hooks * os_hooks;           \
 104         if ((os_hooks) && (os_hooks)->free_pages) {     \
 105             (os_hooks)->free_pages(page, num_pages);    \
 106         }                                               \
 107     } while(0)
 108
 109
 110 #define V3_VAddr(addr) ({                                       \
 111             extern struct v3_os_hooks * os_hooks;               \
 112             void * var = 0;                                     \
 113             if ((os_hooks) && (os_hooks)->paddr_to_vaddr) {     \
 114                 var = (os_hooks)->paddr_to_vaddr(addr);         \
 115             }                                                   \
 116             var;                                                \
 117         })
 118
 119
 120 #define V3_PAddr(addr) ({                                       \
 121             extern struct v3_os_hooks * os_hooks;               \
 122             void * var = 0;                                     \
 123             if ((os_hooks) && (os_hooks)->vaddr_to_paddr) {     \
 124                 var = (os_hooks)->vaddr_to_paddr(addr);         \
 125             }                                                   \
 126             var;                                                \
 127         })
 128
 129
 130
 131 #define V3_Malloc(size) ({                              \
 132             extern struct v3_os_hooks * os_hooks;       \
 133             void * var = 0;                             \
 134             if ((os_hooks) && (os_hooks)->malloc) {     \
 135                 var = (os_hooks)->malloc(size);         \
 136             }                                           \
 137             if (!var) PrintError(VM_NONE,VCORE_NONE,"MALLOC FAILURE. Memory LEAK!!\n"); \
 138             var;                                        \
 139         })
 140
 141 // We need to check the hook structure at runtime to ensure its SAFE
 142 #define V3_Free(addr)                           \
 143     do {                                        \
 144         extern struct v3_os_hooks * os_hooks;   \
 145         if ((os_hooks) && (os_hooks)->free) {   \
 146             (os_hooks)->free(addr);             \
 147         }                                       \
 148     } while (0)
 149
 150 #define V3_VMalloc(size) ({                             \
 151             extern struct v3_os_hooks * os_hooks;       \
 152             void * var = 0;                             \
 153             if ((os_hooks) && (os_hooks)->vmalloc) {    \
 154                 var = (os_hooks)->vmalloc(size);                \
 155             }                                           \
 156             if (!var) PrintError(VM_NONE,VCORE_NONE,"VMALLOC FAILURE. Memory LEAK!!\n"); \
 157             var;                                        \
 158         })
 159
 160 #define V3_VFree(addr)                          \
 161     do {                                        \
 162         extern struct v3_os_hooks * os_hooks;   \
 163         if ((os_hooks) && (os_hooks)->vfree) {  \
 164             (os_hooks)->vfree(addr);            \
 165         }                                       \
 166     } while (0)
 167
 168 // uint_t V3_CPU_KHZ();
 169 #define V3_CPU_KHZ() ({                                                 \
 170             unsigned int khz = 0;                                       \
 171             extern struct v3_os_hooks * os_hooks;                       \
 172             if ((os_hooks) && (os_hooks)->get_cpu_khz) {                \
 173                 khz = (os_hooks)->get_cpu_khz();                        \
 174             }                                                           \
 175             khz;                                                        \
 176         })                                                              \
 177
 178
 179
 180
 181 #define V3_Hook_Interrupt(vm, irq) ({                                   \
 182             int ret = 0;                                                \
 183             extern struct v3_os_hooks * os_hooks;                       \
 184             if ((os_hooks) && (os_hooks)->hook_interrupt) {             \
 185                 ret = (os_hooks)->hook_interrupt(vm, irq);              \
 186             }                                                           \
 187             ret;                                                        \
 188         })                                                              \
 189
 190
 191 #define V3_ACK_IRQ(irq)                                         \
 192     do {                                                        \
 193         extern struct v3_os_hooks * os_hooks;                   \
 194         if ((os_hooks) && (os_hooks)->ack_irq) {                \
 195             (os_hooks)->ack_irq(irq);                           \
 196         }                                                       \
 197     } while (0)
 198
 199
 200
 201 #define V3_Get_CPU() ({                                                 \
 202             int ret = 0;                                                \
 203             extern struct v3_os_hooks * os_hooks;                       \
 204             if ((os_hooks) && (os_hooks)->get_cpu) {                    \
 205                 ret = (os_hooks)->get_cpu();                            \
 206             }                                                           \
 207             ret;                                                        \
 208         })
 209
 210
 211
 212
 213 #define V3_CREATE_AND_START_THREAD(fn, arg, name, rctl) ({              \
 214             void * thread = NULL;                                       \
 215             extern struct v3_os_hooks * os_hooks;                       \
 216             if ((os_hooks) && (os_hooks)->start_kernel_thread) {        \
 217                 thread = (os_hooks)->start_kernel_thread(fn, arg, name,rctl); \
 218             }                                                           \
 219             thread;                                                     \
 220         })
 221
 222
 223
 224
 225 #define V3_Call_On_CPU(cpu, fn, arg)                    \
 226     do {                                                \
 227         extern struct v3_os_hooks * os_hooks;           \
 228         if ((os_hooks) && (os_hooks)->call_on_cpu) {    \
 229             (os_hooks)->call_on_cpu(cpu, fn, arg);      \
 230         }                                               \
 231     } while (0)
 232
 233
 234
 235 #define V3_CREATE_THREAD_ON_CPU(cpu, fn, arg, name, rctl) ({                    \
 236             void * thread = NULL;                                       \
 237             extern struct v3_os_hooks * os_hooks;                       \
 238             if ((os_hooks) && (os_hooks)->create_thread_on_cpu) {       \
 239                 thread = (os_hooks)->create_thread_on_cpu(cpu, fn, arg, name, rctl); \
 240             }                                                           \
 241             thread;                                                     \
 242         })
 243
 244 #define V3_START_THREAD(thread) ({                                      \
 245        extern struct v3_os_hooks * os_hooks;                            \
 246        if((os_hooks) && (os_hooks)->start_thread){                      \
 247            (os_hooks)->start_thread(thread);                            \
 248        }                                                                \
 249   })
 250
 251 #define V3_CREATE_AND_START_THREAD_ON_CPU(cpu, fn, arg, name, rctl) ({  \
 252             void *thread = V3_CREATE_THREAD_ON_CPU(cpu,fn,arg,name,rctl);       \
 253             if (thread) {                                               \
 254                 V3_START_THREAD(thread);                                \
 255             }                                                           \
 256             thread;                                                     \
 257         })
 258
 259 #define V3_MOVE_THREAD_TO_CPU(pcpu, thread) ({                          \
 260         int ret = -1;                                                   \
 261         extern struct v3_os_hooks * os_hooks;                           \
 262         if((os_hooks) && (os_hooks)->move_thread_to_cpu) {              \
 263             ret = (os_hooks)->move_thread_to_cpu(pcpu, thread);         \
 264         }                                                               \
 265         ret;                                                            \
 266     })
 267
 268
 269 /* ** */
 270
 271
 272 #define V3_ASSERT(vm, vcore, x)                                         \
 273     do {                                                                \
 274         extern struct v3_os_hooks * os_hooks;                           \
 275         if (!(x)) {                                                     \
 276           PrintDebug(vm, vcore, "Failed assertion in %s: %s at %s, line %d, RA=%lx\n", \
 277                        __func__, #x, __FILE__, __LINE__,                \
 278                        (ulong_t) __builtin_return_address(0));          \
 279             while(1){                                                   \
 280                 if ((os_hooks) && (os_hooks)->yield_cpu) {              \
 281                         (os_hooks)->yield_cpu();                        \
 282                 }                                                       \
 283             }                                                           \
 284         }                                                               \
 285     } while(0)                                                          \
 286
 287
 288
 289 #define V3_Yield()                                      \
 290     do {                                                \
 291         extern struct v3_os_hooks * os_hooks;           \
 292         if ((os_hooks) && (os_hooks)->yield_cpu) {      \
 293             (os_hooks)->yield_cpu();                    \
 294         }                                               \
 295     } while (0)                                         \
 296
 297
 298 #define V3_Sleep(usec)                          \
 299     do {                                                \
 300         extern struct v3_os_hooks * os_hooks;           \
 301         if ((os_hooks) && (os_hooks)->sleep_cpu) {\
 302             (os_hooks)->sleep_cpu(usec);                \
 303         } else {                                        \
 304             V3_Yield();                                 \
 305         }                                               \
 306     }  while (0)                                        \
 307
 308 #define V3_Wakeup(cpu)                                  \
 309     do {                                                \
 310         extern struct v3_os_hooks * os_hooks;           \
 311         if ((os_hooks) && (os_hooks)->wakeup_cpu) {     \
 312             (os_hooks)->wakeup_cpu(cpu);                        \
 313         }                                               \
 314     } while (0)                                         \
 315
 316
 317 typedef enum v3_vm_class {V3_INVALID_VM, V3_PC_VM, V3_CRAY_VM} v3_vm_class_t;
 318
 319
 320 // Maybe make this a define....
 321 typedef enum v3_cpu_arch {V3_INVALID_CPU, V3_SVM_CPU, V3_SVM_REV3_CPU, V3_VMX_CPU, V3_VMX_EPT_CPU, V3_VMX_EPT_UG_CPU} v3_cpu_arch_t;
 322
 323
 324 v3_cpu_mode_t v3_get_host_cpu_mode();
 325
 326 void v3_yield(struct guest_info * info, int usec);
 327 void v3_yield_cond(struct guest_info * info, int usec);
 328
 329 void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu, int vector);
 330
 331
 332
 333 v3_cpu_arch_t v3_get_cpu_type(int cpu_id);
 334
 335
 336 int v3_vm_enter(struct guest_info * info);
 337 int v3_reset_vm_core(struct guest_info * core, addr_t rip);
 338
 339
 340 #endif /*!__V3VEE__ */
 341
 342
 343
 344 struct v3_vm_info;
 345
 346 // Resource management constraints placed
 347 // on a thread
 348 typedef struct v3_resource_control {
 349     // Page allocations, including for the thread stack
 350     unsigned int pg_alignment;   // alignment e.g., large pages
 351     int          pg_node_id;     // numa node
 352     int         (*pg_filter_func)(void *paddr, void *filter_state);
 353     void        *pg_filter_state;
 354 } v3_resource_control_t;
 355
 356 /* This will contain function pointers that provide OS services */
 357 struct v3_os_hooks {
 358     // the vm pointer is the host os's "priv_data" from v3_create_vm
 359     // if vm is null, this is a general palacios printout
 360     // if vm is not null, and vcore is negative, this is a general print form the vm
 361     // if vm is not null, and vcore is non-negative, this is a print from a specific vcore
 362     void (*print)(void *vm, int vcore, const char * format, ...)
 363         __attribute__ ((format (printf, 3, 4)));
 364
 365     // For page allocation:
 366     //   - node_id -1 => any node, otherwise the numa node we want to alloc from
 367     //   - constraint = 0 => no constraints, otherwise a bitwise-or of the following flags
 368     // Allocates physically contiguous pages
 369     //   - with desired alignment
 370     //   - that the filter_func returns nonzero on (if filter_func is given)
 371     // For any constraint that is not given, if a resource control struture
 372     // exists for the thread, its fields are used.  This allows Palacios
 373     // to manage resources using its internal knowledge of what the
 374     // purpose of thread is
 375     void *(*allocate_pages)(int num_pages, unsigned int alignment, int node_id, int (*filter_func)(void *paddr, void *filter_state), void *filter_state);
 376     void (*free_pages)(void * page, int num_pages);
 377
 378     // Allocates virtually contiguous memory
 379     // the resource control structure for the thread is used, if it exists
 380     void *(*vmalloc)(unsigned int size);
 381     void (*vfree)(void * addr);
 382
 383     // Allocates virtually and physically contiguous memory
 384     // the resource control structure for the thread is used, if it exists
 385     void *(*malloc)(unsigned int size);
 386     void (*free)(void * addr);
 387
 388     void *(*paddr_to_vaddr)(void * addr);
 389     void *(*vaddr_to_paddr)(void * addr);
 390
 391     int (*hook_interrupt)(struct v3_vm_info * vm, unsigned int irq);
 392     int (*ack_irq)(int irq);
 393
 394     unsigned int (*get_cpu_khz)(void);
 395
 396     void (*yield_cpu)(void);
 397     void (*sleep_cpu)(unsigned int usec);
 398     void (*wakeup_cpu)(void *cpu);
 399
 400     void *(*mutex_alloc)(void);
 401     void (*mutex_free)(void * mutex);
 402     void (*mutex_lock)(void * mutex, int must_spin);
 403     void (*mutex_unlock)(void * mutex);
 404     void *(*mutex_lock_irqsave)(void * mutex, int must_spin);
 405     void (*mutex_unlock_irqrestore)(void * mutex, void *flags);
 406
 407     unsigned int (*get_cpu)(void);
 408
 409     // Resource allocations to instantiate a thread obey the resource
 410     // control structure, if it exists, and if it is possible.
 411     // The structure is then bound to the thread and used for subsequent
 412     // allocations, etc.
 413     void * (*start_kernel_thread)(int (*fn)(void * arg), void * arg, char * thread_name, v3_resource_control_t *rctl);
 414     void (*interrupt_cpu)(struct v3_vm_info * vm, int logical_cpu, int vector);
 415     void (*call_on_cpu)(int logical_cpu, void (*fn)(void * arg), void * arg);
 416     void * (*create_thread_on_cpu)(int cpu_id, int (*fn)(void * arg), void * arg, char * thread_name, v3_resource_control_t *rctl);
 417     void (*start_thread)(void * core_thread);
 418     int (*move_thread_to_cpu)(int cpu_id,  void * thread);
 419 };
 420
 421
 422 /*
 423  *
 424  * This is the interrupt state that the VMM's interrupt handlers need to see
 425  */
 426 struct v3_interrupt {
 427     unsigned int irq;
 428     unsigned int error;
 429
 430     unsigned int should_ack;  /* Should the vmm ack this interrupt, or will
 431                                * the host OS do it? */
 432 };
 433
 434
 435 typedef enum {V3_VM_UNKNOWN, V3_VM_INVALID, V3_VM_RUNNING, V3_VM_STOPPED, V3_VM_PAUSED, V3_VM_ERROR, V3_VM_SIMULATING, V3_VM_RESETTING} v3_vm_state_t;
 436 typedef enum {V3_VCORE_UNKNOWN, V3_VCORE_INVALID, V3_VCORE_RUNNING, V3_VCORE_STOPPED, V3_VCORE_RESETTING } v3_vcore_state_t;
 437 typedef enum {V3_VCORE_CPU_UNKNOWN, V3_VCORE_CPU_REAL, V3_VCORE_CPU_PROTECTED, V3_VCORE_CPU_PROTECTED_PAE, V3_VCORE_CPU_LONG, V3_VCORE_CPU_LONG_32_COMPAT, V3_VCORE_CPU_LONG_16_COMPAT} v3_vcore_cpu_mode_t;
 438
 439 typedef enum {V3_VCORE_MEM_STATE_UNKNOWN, V3_VCORE_MEM_STATE_SHADOW, V3_VCORE_MEM_STATE_NESTED} v3_vcore_mem_state_t;
 440 typedef enum {V3_VCORE_MEM_MODE_UNKNOWN, V3_VCORE_MEM_MODE_PHYSICAL, V3_VCORE_MEM_MODE_VIRTUAL} v3_vcore_mem_mode_t;
 441
 442 typedef enum {V3_VM_GENERAL, V3_VM_HVM} v3_vm_type_t;
 443 typedef enum {V3_VCORE_GENERAL, V3_VCORE_ROS, V3_VCORE_HRT} v3_vcore_type_t;
 444
 445
 446 struct v3_vm_base_state {
 447     v3_vm_state_t       state;
 448     v3_vm_type_t        vm_type;
 449 };
 450
 451 struct v3_vm_vcore_state {
 452   v3_vcore_state_t state;
 453   v3_vcore_cpu_mode_t cpu_mode;
 454   v3_vcore_mem_state_t mem_state;
 455   v3_vcore_mem_mode_t mem_mode;
 456   v3_vcore_type_t  vcore_type;
 457   unsigned long pcore;
 458   void *   last_rip;
 459   unsigned long long num_exits;
 460 };
 461
 462 struct v3_vm_core_state {
 463     unsigned long long       num_vcores;
 464     struct v3_vm_vcore_state vcore[];
 465 };
 466
 467 struct v3_vm_mem_region {
 468     void               *guest_paddr;
 469     void               *host_paddr;
 470     unsigned long long  size;
 471     int                 swapped:1;
 472     int                 pinned:1;
 473 };
 474
 475 struct v3_vm_mem_state {
 476     unsigned long long      mem_size;
 477     unsigned long long      ros_mem_size;
 478     unsigned long long      num_regions;
 479     struct v3_vm_mem_region region[];
 480 };
 481
 482 char *v3_lookup_option(char *name);
 483 void Init_V3(struct v3_os_hooks * hooks, char * cpus, int num_cpus, char *options);
 484 void Shutdown_V3( void );
 485
 486
 487 struct v3_vm_info * v3_create_vm(void * cfg, void * priv_data, char * name, unsigned int cpu_mask);
 488 int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask);
 489 int v3_stop_vm(struct v3_vm_info * vm);
 490 int v3_pause_vm(struct v3_vm_info * vm);
 491 int v3_continue_vm(struct v3_vm_info * vm);
 492 int v3_simulate_vm(struct v3_vm_info * vm, unsigned int msecs);
 493
 494 int v3_reset_vm(struct v3_vm_info *vm);
 495 typedef enum {V3_VM_RESET_ALL,V3_VM_RESET_HRT,V3_VM_RESET_ROS,V3_VM_RESET_CORE_RANGE} v3_vm_reset_type;
 496 int v3_reset_vm_extended(struct v3_vm_info *vm, v3_vm_reset_type t, void *data);
 497
 498 int v3_save_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
 499 int v3_load_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
 500
 501 int v3_send_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
 502 int v3_receive_vm(struct v3_vm_info * vm, char * store, char * url, unsigned long long opts);
 503
 504 int v3_move_vm_core(struct v3_vm_info * vm, int vcore_id, int target_cpu);
 505 int v3_move_vm_mem(struct v3_vm_info * vm, void *gpa, int target_cpu);
 506
 507 int v3_free_vm(struct v3_vm_info * vm);
 508
 509 int v3_get_state_sizes_vm(struct v3_vm_info        *vm,
 510                           unsigned long long       *num_vcores,
 511                           unsigned long long       *num_regions);
 512
 513 int v3_get_state_vm(struct v3_vm_info        *vm,
 514                     struct v3_vm_base_state  *base,
 515                     struct v3_vm_core_state  *core,
 516                     struct v3_vm_mem_state   *mem);
 517
 518 char *v3_lookup_option(char *key);
 519
 520 int v3_deliver_irq(struct v3_vm_info * vm, struct v3_interrupt * intr);
 521
 522
 523 #endif