palacios/include/palacios/vmm_hvm.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) 2015, The V3VEE Project <http://www.v3vee.org>
  11  * All rights reserved.
  12  *
  13  * Author: Peter Dinda <pdinda@northwestern.edu>
  14  *
  15  * This is free software.  You are permitted to use,
  16  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  17  */
  18
  19
  20 #ifndef __VMM_HVM_H
  21 #define __VMM_HVM_H
  22
  23
  24 #ifdef __V3VEE__
  25
  26 #include <palacios/vmm_types.h>
  27 #include <palacios/vmm_multiboot.h>
  28
  29 struct v3_ros_event {
  30     enum { ROS_NONE=0, ROS_PAGE_FAULT=1, ROS_SYSCALL=2 } event_type;
  31     uint64_t       last_ros_event_result; // valid when ROS_NONE
  32     union {
  33         struct {   // valid when ROS_PAGE_FAULT
  34             uint64_t rip;
  35             uint64_t cr2;
  36             enum {ROS_READ, ROS_WRITE} action;
  37         } page_fault;
  38         struct { // valid when ROS_SYSCALL
  39             uint64_t args[8];
  40         } syscall;
  41     };
  42 };
  43
  44 struct v3_vm_hvm {
  45     uint8_t   is_hvm;
  46     uint32_t  first_hrt_core;
  47     uint64_t  first_hrt_gpa;
  48     struct v3_cfg_file *hrt_file;
  49     uint64_t  hrt_entry_addr;
  50     enum { HRT_BLOB, HRT_ELF64, HRT_MBOOT2, HRT_MBOOT64 } hrt_type;
  51
  52     // The following parallel the content of mb_info_hrt_t in
  53     // the extended multiboot header.   They reflect how the
  54     // HRT has actually been mapped, as opposed to the requested
  55     // mapping/flags from the mb_mb64_hrt_t
  56     uint64_t  hrt_flags;
  57     uint64_t  max_mem_mapped;
  58     uint64_t  gva_offset;
  59     uint64_t  gva_entry;
  60     uint64_t  comm_page_gpa;
  61     uint8_t   hrt_int_vector;
  62
  63     void     *comm_page_hpa;
  64     void     *comm_page_hva;
  65
  66     enum {HRT_IDLE=0, HRT_CALL=1, HRT_PARCALL=2, HRT_SYNCSETUP=3, HRT_SYNC=4, HRT_SYNCTEARDOWN=5, HRT_MERGE=6} trans_state;
  67     uint64_t  trans_count;
  68
  69     // the ROS event to be handed back
  70     struct v3_ros_event ros_event;
  71
  72 };
  73
  74 struct v3_core_hvm {
  75     uint8_t   is_hrt;
  76     uint64_t  last_boot_start;
  77 };
  78
  79
  80
  81 struct v3_xml;
  82
  83 int v3_init_hvm();
  84 int v3_deinit_hvm();
  85
  86 int v3_init_hvm_vm(struct v3_vm_info *vm, struct v3_xml *config);
  87 int v3_deinit_hvm_vm(struct v3_vm_info *vm);
  88
  89
  90 int v3_init_hvm_core(struct guest_info *core);
  91 int v3_deinit_hvm_core(struct guest_info *core);
  92
  93
  94 uint64_t v3_get_hvm_ros_memsize(struct v3_vm_info *vm);
  95 uint64_t v3_get_hvm_hrt_memsize(struct v3_vm_info *vm);
  96 int      v3_is_hvm_ros_mem_gpa(struct v3_vm_info *vm, addr_t gpa);
  97 int      v3_is_hvm_hrt_mem_gpa(struct v3_vm_info *vm, addr_t gpa);
  98
  99 uint32_t v3_get_hvm_ros_cores(struct v3_vm_info *vm);
 100 uint32_t v3_get_hvm_hrt_cores(struct v3_vm_info *vm);
 101 int      v3_is_hvm_ros_core(struct guest_info *core);
 102 int      v3_is_hvm_hrt_core(struct guest_info *core);
 103
 104
 105 int      v3_hvm_should_deliver_ipi(struct guest_info *src, struct guest_info *dest);
 106 void     v3_hvm_find_apics_seen_by_core(struct guest_info *core, struct v3_vm_info *vm,
 107                                         uint32_t *start_apic, uint32_t *num_apics);
 108
 109
 110 int v3_build_hrt_multiboot_tag(struct guest_info *core, mb_info_hrt_t *hrt);
 111
 112 int v3_setup_hvm_vm_for_boot(struct v3_vm_info *vm);
 113 int v3_setup_hvm_hrt_core_for_boot(struct guest_info *core);
 114
 115 int v3_handle_hvm_reset(struct guest_info *core);
 116
 117 /*
 118   HVM/HRT interaction is as follows:
 119
 120   1. MB_TAG_MB64_HRT tag in the HRT multiboot kernel signifies it
 121      is handled by the HVM.
 122   2. The flags and other info in the the tag indicate the properties of the HRT
 123      to the HVM.  (see vmm_multiboot.h), in particular:
 124          - position independence
 125          - ability to be initially mapped with an offset
 126            between virtual and physical addresses, for example
 127            to hoist it into the same position that the ROS kernel
 128            will occupy in the virtual address space of a ROS
 129            process
 130          - how much physical address space we will intiially map
 131            and what kind of page tables are used to map it
 132          - what physical page (4KB) should we reserve for use
 133            in HVM/HRT communication (particularly upcalls)
 134          - the interrupt vector used to upcall from the HVM to the HRT
 135   3. The MB_INFO_HRT_TAG within the multiboot info structures the
 136      HRT sees on boot indicates that HRT functionality is established and
 137      gives details of operation to the HRT, including the following.
 138      See vmm_multiboot.c for more info
 139          - apics and ioapic ids, and indications of which apics
 140            and which entries on ioapics are exclusively for HRT use
 141          - physical address range that is exclusively for HRT use
 142          - where the the physical address range exclusively for HRT use
 143            is mapped into the virtual address space (offset).  The
 144            ROS part of the physical address space is always identity mapped
 145            initially.
 146          - the amount of physical memory that has been mapped
 147          - the physical address of the page the HVM will use to
 148            communicate with the HRT
 149          - the interrupt vector the HVM will use to upcall the HRT
 150          - flags copied from the HRT's HRT tag (position independence,
 151            page table model, offset, etc)
 152   4. Downcalls:
 153          hypercall 0xf00df00d with arguments depending on operation
 154          with examples described below.
 155   5. Upcalls
 156          interrupt injected by VMM or a magic #PF
 157          communication via a shared memory page, contents below
 158
 159   Upcalls
 160
 161    Type of upcall is determined by the first 64 bits in the commm page
 162
 163    0x0  =>  Null (test)
 164    0x20 =>  Invoke function in HRT
 165             Next 64 bits contains address of structure
 166             describing function call.   This is typically the ROS
 167             trying to get the HRT to run a function for it.
 168             ROS is resposible for assuring that this address
 169             (and other addresses) are correct with respect to
 170             mappings.   That is, for a non-merged address space,
 171             the ROS needs to supply physical addresses so that
 172             they can be used (with the identity-mapped ROS physical
 173             memory.)  If it wants to use virtual addresses, it
 174             needs to first merge the address spaces.
 175    0x21 =>  Invoke function in HRT in parallel
 176             Exactly like previos, but the upcall is happening
 177             simultaneously on all HRT cores.
 178    0x30 =>  Merge address space
 179             Next 64 bits contains the ROS CR3 that we will use
 180             to map the user portion of ROS address space into
 181             the HRT address space
 182    0x31 =>  Unmerge address space
 183             return the ROS memory mapping to normal (physical/virtual identity)
 184
 185   Downcalls
 186
 187    HVM_HCALL is the general hypercall number used to talk to the HVM
 188      The first argument is the request number (below).   The other arguments
 189      depend on the first.
 190
 191    0x0  =>  Null, just for timing
 192    0x1  =>  Reboot ROS
 193    0x2  =>  Reboot HRT
 194    0x3  =>  Reboot Both
 195    0xf  =>  Get HRT transaction state and current ROS event
 196             first argument is pointer to the ROS event state
 197             to be filled out
 198
 199    0x10 =>  ROS event request (HRT->ROS)
 200             first argument is pointer where to write the ROS event state
 201    0x1f =>  ROS event completion (ROS->HRT)
 202             first argument is the result code
 203
 204    0x20 =>  Invoke function (ROS->HRT)
 205             first argument is pointer to structure describing call
 206    0x21 =>  Invoke function in parallel (ROS->HRT)
 207             same as above, but simultaneously on all HRT cores
 208    0x2f =>  Function execution complete (HRT->ROS, once per core)
 209    0x30 =>  Merge address space (ROS->HRT)
 210             no arguments (CR3 implicit).   Merge the current
 211             address space in the ROS with the address space on
 212             the HRT
 213    0x31 =>  Unmerge address apce (ROS->HRT)
 214             release any address space merger and restore identity mapping
 215    0x3f =>  Merge request complete (HRT->ROS)
 216
 217 */
 218
 219
 220
 221 #endif /* ! __V3VEE__ */
 222
 223
 224 #endif