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.


integrated new configuration system
[palacios.git] / palacios / include / palacios / vm_guest.h
index bb1afbb..6506658 100644 (file)
-#ifndef __VM_GUEST_H
-#define __VM_GUEST_H
+/*
+ * This file is part of the Palacios Virtual Machine Monitor developed
+ * by the V3VEE Project with funding from the United States National 
+ * Science Foundation and the Department of Energy.  
+ *
+ * The V3VEE Project is a joint project between Northwestern University
+ * and the University of New Mexico.  You can find out more at 
+ * http://www.v3vee.org
+ *
+ * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
+ * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
+ * All rights reserved.
+ *
+ * Author: Jack Lange <jarusl@cs.northwestern.edu>
+ *
+ * This is free software.  You are permitted to use,
+ * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
+ */
+
+#ifndef __VM_GUEST_H__
+#define __VM_GUEST_H__
 
 #ifdef __V3VEE__
 
-
-#include <palacios/vmm_mem.h>
 #include <palacios/vmm_types.h>
+#include <palacios/vmm_mem.h>
 #include <palacios/vmm_io.h>
 #include <palacios/vmm_shadow_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>
+
+
+#ifdef CONFIG_TELEMETRY
+#include <palacios/vmm_telemetry.h>
+#endif
+
+#ifdef CONFIG_SYMBIOTIC_SWAP
+#include <palacios/vmm_sym_swap.h>
+#endif
+
+
+
 
-typedef ullong_t v3_reg_t;
 
 
 
 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;
-};
+    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;
+
+    v3_reg_t r8;
+    v3_reg_t r9;
+    v3_reg_t r10;
+    v3_reg_t r11;
+    v3_reg_t r12;
+    v3_reg_t r13;
+    v3_reg_t r14;
+    v3_reg_t r15;
+  
+} __attribute__((packed));
 
 
 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;
+    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;
 };
 
 
 
 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;
+    v3_reg_t dr0;
+    v3_reg_t dr1;
+    v3_reg_t dr2;
+    v3_reg_t dr3;
+    v3_reg_t dr6;
+    v3_reg_t dr7;
 };
 
 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;
-};
+    uint16_t selector;
+    uint_t limit;
+    uint64_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;
+} __attribute__((packed));
 
 
 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 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;
-
-/*Zheng 07/30/2008*/
-struct vm_ctrl_ops {
-  int (*raise_irq)(struct guest_info * info, int irq);
-  int (*lower_irq)(struct guest_info * info, int irq);
-};
 
+#ifdef CONFIG_SYMBIOTIC
+#include <palacios/vmm_sym_iface.h>
+#endif
 
+#include <palacios/vmm_config.h>
 
+struct shadow_page_state;
+struct v3_intr_state;
 
-typedef enum {SHADOW_PAGING, NESTED_PAGING} vmm_paging_mode_t;
-typedef enum {VM_RUNNING, VM_STOPPED, VM_SUSPENDED, VM_ERROR, VM_EMULATING} vm_operating_mode_t;
+#ifdef CONFIG_TELEMETRY
+struct v3_telemetry;
+#endif
 
+#ifdef CONFIG_SYMBIOTIC_SWAP
+struct v3_sym_swap_state;
+#endif
 
-typedef enum {REAL, /*UNREAL,*/ PROTECTED, PROTECTED_PAE, LONG, LONG_32_COMPAT, LONG_16_COMPAT} vm_cpu_mode_t;
-typedef enum {PHYSICAL_MEM, VIRTUAL_MEM} vm_mem_mode_t;
+#ifdef CONFIG_SYMBIOTIC
+struct v3_sym_state;
+#endif
 
+struct guest_info {
+    uint64_t rip;
 
+    uint_t cpl;
 
-struct guest_info {
-  ullong_t rip;
+    addr_t mem_size; // In bytes for now
+    v3_shdw_map_t mem_map;
 
-  uint_t cpl;
+    struct v3_config * cfg_data;
+    v3_vm_class_t vm_class;
 
-  struct shadow_map mem_map;
+    struct vm_time time_state;
 
-  struct vm_time time_state;
   
-  vmm_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_paging_mode_t shdw_pg_mode;
+    struct shadow_page_state shdw_pg_state;
+    addr_t direct_map_pt;
 
 
-  // This structure is how we get interrupts for the guest
-  struct vm_intr intr_state;
+    // This structure is how we get interrupts for the guest
+    struct v3_intr_state intr_state;
 
-  struct vmm_io_map io_map;
-  // device_map
+    // This structure is how we get exceptions for the guest
+    struct v3_excp_state excp_state;
 
-  struct vmm_dev_mgr  dev_mgr;
+    struct v3_io_map io_map;
 
-  vm_cpu_mode_t cpu_mode;
-  vm_mem_mode_t mem_mode;
+    struct v3_msr_map msr_map;
 
+    struct v3_cpuid_map cpuid_map;
 
-  struct v3_gprs vm_regs;
-  struct v3_ctrl_regs ctrl_regs;
-  struct v3_dbg_regs dbg_regs;
-  struct v3_segments segments;
+#ifdef CONFIG_SYMBIOTIC
+    // Symbiotic state
+    struct v3_sym_state sym_state;
+#endif
 
-  struct vm_ctrl_ops vm_ops;
+    v3_hypercall_map_t hcall_map;
 
-  struct emulation_state emulator;
+    // device_map
+    struct vmm_dev_mgr  dev_mgr;
 
-  vm_operating_mode_t run_state;
-  void * vmm_data;
-};
+    struct v3_host_events host_event_hooks;
 
+    v3_cpu_mode_t cpu_mode;
+    v3_mem_mode_t mem_mode;
+    uint_t addr_width;
 
-vm_cpu_mode_t get_cpu_mode(struct guest_info * info);
-vm_mem_mode_t get_mem_mode(struct guest_info * info);
 
+    struct v3_gprs vm_regs;
+    struct v3_ctrl_regs ctrl_regs;
+    struct v3_dbg_regs dbg_regs;
+    struct v3_segments segments;
 
-void PrintV3Segments(struct guest_info * info);
-void PrintV3CtrlRegs(struct guest_info * info);
-void PrintV3GPRs(struct guest_info * info);
+    v3_vm_operating_mode_t run_state;
+    void * vmm_data;
 
+    uint64_t yield_cycle_period;
+    uint64_t yield_start_cycle;
+    
+    uint64_t num_exits;
+
+#ifdef CONFIG_TELEMETRY
+    uint_t enable_telemetry;
+    struct v3_telemetry_state telemetry;
 #endif
 
 
+#ifdef CONFIG_SYMBIOTIC_SWAP
+    struct v3_sym_swap_state swap_state;
+#endif
+
+    void * decoder_state;
+
+    // the logical cpu this guest context is executing on
+    int cpu_id;
+};
+
+
+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_cpu_mode_t mode);
+const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode);
+
+int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg);
+
+
+void v3_print_guest_state(struct guest_info * info);
+
+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);
+
+void v3_print_stack(struct guest_info * info);
+
+#endif // ! __V3VEE__
 
 #endif