palacios/include/palacios/vmm_shadow_paging.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_SHADOW_PAGING_H__
  21 #define __VMM_SHADOW_PAGING_H__
  22
  23
  24 #ifdef __V3VEE__
  25
  26 #include <palacios/vmm_util.h>
  27 #include <palacios/vmm_paging.h>
  28 #include <palacios/vmm_hashtable.h>
  29 #include <palacios/vmm_list.h>
  30 #include <palacios/vmm_msr.h>
  31
  32 #include <palacios/vmm_config.h>
  33
  34
  35 struct guest_info;
  36
  37 struct v3_shdw_pg_impl {
  38     char * name;
  39     int (*init)(struct v3_vm_info * vm, v3_cfg_tree_t * cfg);
  40     int (*deinit)(struct v3_vm_info * vm);
  41     int (*local_init)(struct guest_info * core);
  42     int (*local_deinit)(struct guest_info * core);
  43     int (*handle_pagefault)(struct guest_info * core, addr_t fault_addr, pf_error_t error_code);
  44     int (*handle_invlpg)(struct guest_info * core, addr_t vaddr);
  45     int (*activate_shdw_pt)(struct guest_info * core);
  46     int (*invalidate_shdw_pt)(struct guest_info * core);
  47 };
  48
  49
  50 struct v3_shdw_impl_state {
  51
  52     struct v3_shdw_pg_impl * current_impl;
  53     void * impl_data;
  54
  55     struct list_head event_callback_list;
  56
  57 };
  58
  59 struct v3_shdw_pg_state {
  60
  61     // virtualized control registers
  62     v3_reg_t guest_cr3;
  63     v3_reg_t guest_cr0;
  64     v3_msr_t guest_efer;
  65
  66     void * local_impl_data;
  67
  68 #ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
  69     uint_t guest_faults;
  70 #endif
  71
  72
  73 };
  74
  75
  76 struct v3_shdw_pg_event {
  77     enum {SHADOW_PAGEFAULT,SHADOW_INVLPG,SHADOW_INVALIDATE,SHADOW_ACTIVATE} event_type;
  78     enum {SHADOW_PREIMPL, SHADOW_POSTIMPL} event_order;
  79     addr_t     gva;        // for pf and invlpg
  80     pf_error_t error_code; // for pf
  81 };
  82
  83
  84
  85 int v3_init_shdw_impl(struct v3_vm_info * vm);
  86 int v3_deinit_shdw_impl(struct v3_vm_info * vm);
  87
  88 int v3_init_shdw_pg_state(struct guest_info * core);
  89 int v3_deinit_shdw_pg_state(struct guest_info * core);
  90
  91
  92 /* Handler implementations */
  93 int v3_handle_shadow_pagefault(struct guest_info * info, addr_t fault_addr, pf_error_t error_code);
  94 int v3_handle_shadow_invlpg(struct guest_info * info);
  95
  96 /* Actions.. */
  97 int v3_activate_shadow_pt(struct guest_info * info);
  98 int v3_invalidate_shadow_pts(struct guest_info * info);
  99
 100
 101 /* Utility functions for shadow paging implementations */
 102 int v3_inject_guest_pf(struct guest_info * info, addr_t fault_addr, pf_error_t error_code);
 103 int v3_is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access);
 104
 105
 106 int v3_register_shadow_paging_event_callback(struct v3_vm_info *vm,
 107                                           int (*callback)(struct guest_info *core,
 108                                                           struct v3_shdw_pg_event *event,
 109                                                           void      *priv_data),
 110                                           void *priv_data);
 111
 112 int v3_unregister_shadow_paging_event_callback(struct v3_vm_info *vm,
 113                                                int (*callback)(struct guest_info *core,
 114                                                                struct v3_shdw_pg_event *event,
 115                                                                void      *priv_data),
 116                                                void *priv_data);
 117
 118
 119
 120
 121 int V3_init_shdw_paging();
 122 int V3_deinit_shdw_paging();
 123
 124 #define register_shdw_pg_impl(impl)                                     \
 125     static struct v3_shdw_pg_impl * _v3_shdw_pg_impl                    \
 126     __attribute__((used))                                               \
 127         __attribute__((unused, __section__ ("_v3_shdw_pg_impls"),       \
 128                        aligned(sizeof(addr_t))))                        \
 129         = impl;
 130
 131
 132
 133
 134 #endif // ! __V3VEE__
 135
 136 #endif