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     v3_rw_lock_t     event_callback_lock;
  56     struct list_head event_callback_list;
  57
  58 };
  59
  60 struct v3_shdw_pg_state {
  61
  62     // virtualized control registers
  63     v3_reg_t guest_cr3;
  64     v3_reg_t guest_cr0;
  65     v3_msr_t guest_efer;
  66     v3_reg_t guest_cr4;
  67
  68     void * local_impl_data;
  69
  70 #ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
  71     uint_t guest_faults;
  72 #endif
  73
  74
  75 };
  76
  77
  78 struct v3_shdw_pg_event {
  79     enum {SHADOW_PAGEFAULT,SHADOW_INVLPG,SHADOW_INVALIDATE,SHADOW_ACTIVATE} event_type;
  80     enum {SHADOW_PREIMPL, SHADOW_POSTIMPL} event_order;
  81     addr_t     gva;        // for pf and invlpg
  82     pf_error_t error_code; // for pf
  83 };
  84
  85
  86
  87 int v3_init_shdw_impl(struct v3_vm_info * vm);
  88 int v3_deinit_shdw_impl(struct v3_vm_info * vm);
  89
  90 int v3_init_shdw_pg_state(struct guest_info * core);
  91 int v3_deinit_shdw_pg_state(struct guest_info * core);
  92
  93
  94 /* Handler implementations */
  95 int v3_handle_shadow_pagefault(struct guest_info * info, addr_t fault_addr, pf_error_t error_code);
  96 int v3_handle_shadow_invlpg(struct guest_info * info);
  97
  98 /* Actions.. */
  99 int v3_activate_shadow_pt(struct guest_info * info);
 100 int v3_invalidate_shadow_pts(struct guest_info * info);
 101
 102
 103 /* Utility functions for shadow paging implementations */
 104 int v3_inject_guest_pf(struct guest_info * info, addr_t fault_addr, pf_error_t error_code);
 105 int v3_is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access);
 106
 107
 108 int v3_register_shadow_paging_event_callback(struct v3_vm_info *vm,
 109                                           int (*callback)(struct guest_info *core,
 110                                                           struct v3_shdw_pg_event *event,
 111                                                           void      *priv_data),
 112                                           void *priv_data);
 113
 114 int v3_unregister_shadow_paging_event_callback(struct v3_vm_info *vm,
 115                                                int (*callback)(struct guest_info *core,
 116                                                                struct v3_shdw_pg_event *event,
 117                                                                void      *priv_data),
 118                                                void *priv_data);
 119
 120
 121
 122
 123 int V3_init_shdw_paging();
 124 int V3_deinit_shdw_paging();
 125
 126 #define register_shdw_pg_impl(impl)                                     \
 127     static struct v3_shdw_pg_impl * _v3_shdw_pg_impl                    \
 128     __attribute__((used))                                               \
 129         __attribute__((unused, __section__ ("_v3_shdw_pg_impls"),       \
 130                        aligned(sizeof(addr_t))))                        \
 131         = impl;
 132
 133
 134
 135
 136 #endif // ! __V3VEE__
 137
 138 #endif