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.


VM reset capability
[palacios.git] / palacios / include / palacios / vm_guest.h
index e1a9199..7a78c0a 100644 (file)
 
 #include <palacios/vmm_types.h>
 #include <palacios/vmm_mem.h>
+#include <palacios/vmm_mem_hook.h>
 #include <palacios/vmm_io.h>
 #include <palacios/vmm_shadow_paging.h>
+#include <palacios/vmm_direct_paging.h>
 #include <palacios/vmm_intr.h>
+#include <palacios/vmm_excp.h>
 #include <palacios/vmm_dev_mgr.h>
 #include <palacios/vmm_time.h>
-#include <palacios/vmm_emulator.h>
 #include <palacios/vmm_host_events.h>
 #include <palacios/vmm_msr.h>
+#include <palacios/vmm_hypercall.h>
+#include <palacios/vmm_cpuid.h>
+#include <palacios/vmm_regs.h>
+#include <palacios/vmm_extensions.h>
+#include <palacios/vmm_barrier.h>
+#include <palacios/vmm_subset.h>
+#include <palacios/vmm_timeout.h>
+#include <palacios/vmm_exits.h>
+#include <palacios/vmm_events.h>
+#include <palacios/vmm_scheduler.h>
+#include <palacios/vmm_fw_cfg.h>
+#include <palacios/vmm_fp.h>
+#include <palacios/vmm_perftune.h>
+
+
+#ifdef V3_CONFIG_TELEMETRY
+#include <palacios/vmm_telemetry.h>
+#endif
 
+#ifdef V3_CONFIG_PMU_TELEMETRY
+#include <palacios/vmm_pmu_telemetry.h>
+#endif
 
+#ifdef V3_CONFIG_PWRSTAT_TELEMETRY
+#include <palacios/vmm_pwrstat_telemetry.h>
+#endif
 
-struct v3_gprs {
-  v3_reg_t rdi;
-  v3_reg_t rsi;
-  v3_reg_t rbp;
-  v3_reg_t rsp;
-  v3_reg_t rbx;
-  v3_reg_t rdx;
-  v3_reg_t rcx;
-  v3_reg_t rax;
-};
+#ifdef V3_CONFIG_SYMBIOTIC
+#include <palacios/vmm_symbiotic.h>
+struct v3_sym_core_state;
+#endif
 
+#ifdef V3_CONFIG_MEM_TRACK
+#include <palacios/vmm_mem_track.h>
+#endif
 
-struct v3_ctrl_regs {
-  v3_reg_t cr0;
-  v3_reg_t cr2;
-  v3_reg_t cr3;
-  v3_reg_t cr4;
-  v3_reg_t cr8;
-  v3_reg_t rflags;
-  v3_reg_t efer;
-};
+#ifdef V3_CONFIG_MULTIBOOT
+#include <palacios/vmm_multiboot.h>
+#endif
+
+#ifdef V3_CONFIG_HVM
+#include <palacios/vmm_hvm.h>
+#endif
 
 
 
-struct v3_dbg_regs {
-  v3_reg_t dr0;
-  v3_reg_t dr1;
-  v3_reg_t dr2;
-  v3_reg_t dr3;
-  v3_reg_t dr6;
-  v3_reg_t dr7;
-};
+#include <palacios/vmm_config.h>
 
-struct v3_segment {
-  ushort_t selector;
-  uint_t limit;
-  ullong_t base;
-  uint_t type           : 4;
-  uint_t system         : 1;
-  uint_t dpl            : 2;
-  uint_t present        : 1;
-  uint_t avail          : 1;
-  uint_t long_mode      : 1;
-  uint_t db             : 1;
-  uint_t granularity    : 1;
-};
+struct v3_intr_state;
+
+
+
+
+/* per-core state */
+struct guest_info {
+    char exec_name[256];
+    
+    uint64_t rip;
 
+    uint_t cpl;
+
+    struct vm_core_time time_state;
+    struct v3_core_timeouts timeouts;
+    void * sched_priv_data;
+
+    v3_paging_mode_t shdw_pg_mode;
+    // arch-independent state of shadow pager
+    struct v3_shdw_pg_state shdw_pg_state;
+    // arch-indepedent state of the passthrough pager
+    addr_t direct_map_pt;
+    // arch-independent state of the nested pager (currently none)
+    // struct v3_nested_pg_state nested_pg_state;
+    // per-core state of the swapper (currently none)
+    //#ifdef V3_CONFIG_SWAPPING
+    //   struct v3_swap_impl_state swap_impl;
+    //#endif
+    
+
+    union {
+       uint32_t flags;
+       struct {
+           uint8_t use_large_pages        : 1;    /* Enable virtual page tables to use large pages */
+           uint8_t use_giant_pages        : 1;    /* Enable virtual page tables to use giant (1GB) pages */
+           uint32_t rsvd                  : 30;
+       } __attribute__((packed));
+    } __attribute__((packed));
+
+
+    /* This structure is how we get interrupts for the guest */
+    struct v3_intr_core_state intr_core_state;
+
+    /* This structure is how we get exceptions for the guest */
+    struct v3_excp_state excp_state;
+
+
+    v3_cpu_mode_t cpu_mode;
+    v3_mem_mode_t mem_mode;
+
+
+    struct v3_gprs vm_regs;
+    struct v3_ctrl_regs ctrl_regs;
+    struct v3_dbg_regs dbg_regs;
+    struct v3_segments segments;
+    struct v3_msrs     msrs;
+
+    struct v3_fp_state fp_state;
+
+    // the arch-dependent state (SVM or VMX)
+    void * vmm_data;
+
+    uint64_t yield_start_cycle;
+    
+    uint64_t num_exits;
+
+#ifdef V3_CONFIG_TELEMETRY
+    struct v3_core_telemetry core_telem;
+#endif
+
+#ifdef V3_CONFIG_PMU_TELEMETRY
+    struct v3_core_pmu_telemetry pmu_telem;
+#endif
+
+#ifdef V3_CONFIG_PWRSTAT_TELEMETRY
+    struct v3_core_pwrstat_telemetry pwrstat_telem;
+#endif
+
+#ifdef V3_CONFIG_MEM_TRACK
+    struct v3_core_mem_track memtrack_state;
+#endif
+
+#ifdef V3_CONFIG_HVM
+    struct v3_core_hvm  hvm_state;
+#endif
+
+
+    /* struct v3_core_dev_mgr core_dev_mgr; */
+
+    void * decoder_state;
+
+#ifdef V3_CONFIG_SYMBIOTIC
+    /* Symbiotic state */
+    struct v3_sym_core_state sym_core_state;
+#endif
+
+    /* Per-core config tree data. */
+    v3_cfg_tree_t * core_cfg_data;
+
+    struct v3_vm_info * vm_info;
+
+    v3_core_operating_mode_t core_run_state;
+
+    void * core_thread; /* thread struct for virtual core */
+
+    /* the logical cpu on which this core runs */
+    uint32_t pcpu_id;
+    
+    /* The virtual core # of this cpu (what the guest sees this core as) */
+    uint32_t vcpu_id;
 
-struct v3_segments {
-  struct v3_segment cs;
-  struct v3_segment ds;
-  struct v3_segment es;
-  struct v3_segment fs;
-  struct v3_segment gs;
-  struct v3_segment ss;
-  struct v3_segment ldtr;
-  struct v3_segment gdtr;
-  struct v3_segment idtr;
-  struct v3_segment tr;
 };
 
-struct shadow_page_state;
-struct shadow_map;
-struct vmm_io_map;
-struct emulation_state;
-struct v3_intr_state;
 
 
+/* shared state across cores */
+struct v3_vm_info {
+    char name[128];
 
+    v3_vm_class_t vm_class;
+    struct v3_fw_cfg_state fw_cfg_state;
 
+    // This is always the total RAM (addresses 0...mem_size)
+    // in the VM.  
+    // With an HVM, this is partitioned as per hvm_state
+    addr_t mem_size; /* In bytes for now */
+    uint32_t mem_align;
+    struct v3_mem_map mem_map;
 
-struct guest_info {
-  ullong_t rip;
+    struct v3_mem_hooks mem_hooks;
 
-  uint_t cpl;
+    // arch-indepentent state of shadow pager
+    struct v3_shdw_impl_state shdw_impl;
+    // arch-independent state of passthrough pager (currently none)
+    struct v3_passthrough_impl_state passthrough_impl;
+    // arch-independent state of the nested pager
+    struct v3_nested_impl_state nested_impl;
+#ifdef V3_CONFIG_SWAPPING
+    // swapping state, if enabled
+    struct v3_swap_impl_state swap_state;
+#endif
 
-  addr_t mem_size; // Probably in bytes for now....
-  struct shadow_map mem_map;
+    void * sched_priv_data;
 
-  struct vm_time time_state;
+    struct v3_io_map io_map;
+    struct v3_msr_map msr_map;
+    struct v3_cpuid_map cpuid_map;
+    struct v3_exit_map exit_map;
+    struct v3_event_map event_map;
 
-  
-  v3_paging_mode_t shdw_pg_mode;
-  struct shadow_page_state shdw_pg_state;
-  addr_t direct_map_pt;
-  // nested_paging_t nested_page_state;
+    v3_hypercall_map_t hcall_map;
 
 
-  // This structure is how we get interrupts for the guest
-  struct v3_intr_state intr_state;
+    struct v3_intr_routers intr_routers;
 
-  struct vmm_io_map io_map;
+    /* device_map */
+    struct vmm_dev_mgr  dev_mgr;
 
-  struct v3_msr_map msr_map;
-  // device_map
+    struct v3_time time_state;
 
-  struct vmm_dev_mgr  dev_mgr;
+    struct v3_host_events host_event_hooks;
 
-  struct v3_host_events host_event_hooks;
+    struct v3_config * cfg_data;
 
-  v3_vm_cpu_mode_t cpu_mode;
-  v3_vm_mem_mode_t mem_mode;
+    v3_vm_operating_mode_t run_state;
 
+    struct v3_barrier barrier;
 
-  struct v3_gprs vm_regs;
-  struct v3_ctrl_regs ctrl_regs;
-  struct v3_dbg_regs dbg_regs;
-  struct v3_segments segments;
 
-  struct emulation_state emulator;
+    struct v3_extensions extensions;
 
-  v3_vm_operating_mode_t run_state;
-  void * vmm_data;
+    struct v3_perf_options perf_options;
 
+#ifdef V3_CONFIG_SYMBIOTIC
+    /* Symbiotic state */
+    struct v3_sym_vm_state sym_vm_state;
+#endif
 
-  struct v3_msr guest_efer;
+#ifdef V3_CONFIG_TELEMETRY
+    uint_t enable_telemetry;
+    struct v3_telemetry_state telemetry;
+#endif
 
-  /* TEMP */
-  //ullong_t exit_tsc;
+#ifdef V3_CONFIG_MEM_TRACK
+    struct v3_vm_mem_track memtrack_state;
+#endif
+
+#ifdef V3_CONFIG_MULTIBOOT
+    struct v3_vm_multiboot  mb_state;
+#endif
+
+#ifdef V3_CONFIG_HVM
+    struct v3_vm_hvm  hvm_state;
+#endif
 
+    // used to implement reset of regular VM and ROS
+    v3_counting_barrier_t  reset_barrier;
+
+    uint64_t yield_cycle_period;  
+
+
+    void * host_priv_data;
+
+    // This is always the total number of vcores in the VM 
+    // With an HVM, these are partitioned as per hvm_state
+    int num_cores;
+
+    int avail_cores; // Available logical cores
+
+    // JRL: This MUST be the last entry...
+    struct guest_info cores[0];
 };
 
+int v3_init_vm(struct v3_vm_info * vm);
+int v3_init_core(struct guest_info * core);
+
+int v3_free_vm_internal(struct v3_vm_info * vm);
+int v3_free_core(struct guest_info * core);
+
 
-v3_vm_cpu_mode_t v3_get_cpu_mode(struct guest_info * info);
-v3_vm_mem_mode_t v3_get_mem_mode(struct guest_info * info);
+uint_t v3_get_addr_width(struct guest_info * info);
+v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info);
+v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info);
 
 
-const uchar_t * v3_cpu_mode_to_str(v3_vm_cpu_mode_t mode);
-const uchar_t * v3_mem_mode_to_str(v3_vm_mem_mode_t mode);
+const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode);
+const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
 
 
-void v3_print_segments(struct guest_info * info);
-void v3_print_ctrl_regs(struct guest_info * info);
-void v3_print_GPRs(struct guest_info * info);
 
-#endif // ! __V3VEE__
+#endif /* ! __V3VEE__ */