drivers/lguest/lg.h

   1 #ifndef _LGUEST_H
   2 #define _LGUEST_H
   3
   4 #ifndef __ASSEMBLY__
   5 #include <linux/types.h>
   6 #include <linux/init.h>
   7 #include <linux/stringify.h>
   8 #include <linux/lguest.h>
   9 #include <linux/lguest_launcher.h>
  10 #include <linux/wait.h>
  11 #include <linux/hrtimer.h>
  12 #include <linux/err.h>
  13 #include <linux/slab.h>
  14
  15 #include <asm/lguest.h>
  16
  17 struct pgdir {
  18         unsigned long gpgdir;
  19         bool switcher_mapped;
  20         int last_host_cpu;
  21         pgd_t *pgdir;
  22 };
  23
  24 /* We have two pages shared with guests, per cpu.  */
  25 struct lguest_pages {
  26         /* This is the stack page mapped rw in guest */
  27         char spare[PAGE_SIZE - sizeof(struct lguest_regs)];
  28         struct lguest_regs regs;
  29
  30         /* This is the host state & guest descriptor page, ro in guest */
  31         struct lguest_ro_state state;
  32 } __attribute__((aligned(PAGE_SIZE)));
  33
  34 #define CHANGED_IDT             1
  35 #define CHANGED_GDT             2
  36 #define CHANGED_GDT_TLS         4 /* Actually a subset of CHANGED_GDT */
  37 #define CHANGED_ALL             3
  38
  39 struct lg_cpu {
  40         unsigned int id;
  41         struct lguest *lg;
  42         struct task_struct *tsk;
  43         struct mm_struct *mm;   /* == tsk->mm, but that becomes NULL on exit */
  44
  45         u32 cr2;
  46         int ts;
  47         u32 esp1;
  48         u16 ss1;
  49
  50         /* Bitmap of what has changed: see CHANGED_* above. */
  51         int changed;
  52
  53         unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */
  54
  55         unsigned long *reg_read; /* register from LHREQ_GETREG */
  56
  57         /* At end of a page shared mapped over lguest_pages in guest. */
  58         unsigned long regs_page;
  59         struct lguest_regs *regs;
  60
  61         struct lguest_pages *last_pages;
  62
  63         /* Initialization mode: linear map everything. */
  64         bool linear_pages;
  65         int cpu_pgd; /* Which pgd this cpu is currently using */
  66
  67         /* If a hypercall was asked for, this points to the arguments. */
  68         struct hcall_args *hcall;
  69         u32 next_hcall;
  70
  71         /* Virtual clock device */
  72         struct hrtimer hrt;
  73
  74         /* Did the Guest tell us to halt? */
  75         int halted;
  76
  77         /* Pending virtual interrupts */
  78         DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
  79
  80         struct lg_cpu_arch arch;
  81 };
  82
  83 struct lg_eventfd {
  84         unsigned long addr;
  85         struct eventfd_ctx *event;
  86 };
  87
  88 struct lg_eventfd_map {
  89         unsigned int num;
  90         struct lg_eventfd map[];
  91 };
  92
  93 /* The private info the thread maintains about the guest. */
  94 struct lguest {
  95         struct lguest_data __user *lguest_data;
  96         struct lg_cpu cpus[NR_CPUS];
  97         unsigned int nr_cpus;
  98
  99         u32 pfn_limit;
 100
 101         /*
 102          * This provides the offset to the base of guest-physical memory in the
 103          * Launcher.
 104          */
 105         void __user *mem_base;
 106         unsigned long kernel_address;
 107
 108         struct pgdir pgdirs[4];
 109
 110         unsigned long noirq_start, noirq_end;
 111
 112         unsigned int stack_pages;
 113         u32 tsc_khz;
 114
 115         struct lg_eventfd_map *eventfds;
 116
 117         /* Dead? */
 118         const char *dead;
 119 };
 120
 121 extern struct mutex lguest_lock;
 122
 123 /* core.c: */
 124 bool lguest_address_ok(const struct lguest *lg,
 125                        unsigned long addr, unsigned long len);
 126 void __lgread(struct lg_cpu *, void *, unsigned long, unsigned);
 127 void __lgwrite(struct lg_cpu *, unsigned long, const void *, unsigned);
 128 extern struct page **lg_switcher_pages;
 129
 130 /*H:035
 131  * Using memory-copy operations like that is usually inconvient, so we
 132  * have the following helper macros which read and write a specific type (often
 133  * an unsigned long).
 134  *
 135  * This reads into a variable of the given type then returns that.
 136  */
 137 #define lgread(cpu, addr, type)                                         \
 138         ({ type _v; __lgread((cpu), &_v, (addr), sizeof(_v)); _v; })
 139
 140 /* This checks that the variable is of the given type, then writes it out. */
 141 #define lgwrite(cpu, addr, type, val)                           \
 142         do {                                                    \
 143                 typecheck(type, val);                           \
 144                 __lgwrite((cpu), (addr), &(val), sizeof(val));  \
 145         } while(0)
 146 /* (end of memory access helper routines) :*/
 147
 148 int run_guest(struct lg_cpu *cpu, unsigned long __user *user);
 149
 150 /*
 151  * Helper macros to obtain the first 12 or the last 20 bits, this is only the
 152  * first step in the migration to the kernel types.  pte_pfn is already defined
 153  * in the kernel.
 154  */
 155 #define pgd_flags(x)    (pgd_val(x) & ~PAGE_MASK)
 156 #define pgd_pfn(x)      (pgd_val(x) >> PAGE_SHIFT)
 157 #define pmd_flags(x)    (pmd_val(x) & ~PAGE_MASK)
 158 #define pmd_pfn(x)      (pmd_val(x) >> PAGE_SHIFT)
 159
 160 /* interrupts_and_traps.c: */
 161 unsigned int interrupt_pending(struct lg_cpu *cpu, bool *more);
 162 void try_deliver_interrupt(struct lg_cpu *cpu, unsigned int irq, bool more);
 163 void set_interrupt(struct lg_cpu *cpu, unsigned int irq);
 164 bool deliver_trap(struct lg_cpu *cpu, unsigned int num);
 165 void load_guest_idt_entry(struct lg_cpu *cpu, unsigned int i,
 166                           u32 low, u32 hi);
 167 void guest_set_stack(struct lg_cpu *cpu, u32 seg, u32 esp, unsigned int pages);
 168 void pin_stack_pages(struct lg_cpu *cpu);
 169 void setup_default_idt_entries(struct lguest_ro_state *state,
 170                                const unsigned long *def);
 171 void copy_traps(const struct lg_cpu *cpu, struct desc_struct *idt,
 172                 const unsigned long *def);
 173 void guest_set_clockevent(struct lg_cpu *cpu, unsigned long delta);
 174 bool send_notify_to_eventfd(struct lg_cpu *cpu);
 175 void init_clockdev(struct lg_cpu *cpu);
 176 bool check_syscall_vector(struct lguest *lg);
 177 int init_interrupts(void);
 178 void free_interrupts(void);
 179
 180 /* segments.c: */
 181 void setup_default_gdt_entries(struct lguest_ro_state *state);
 182 void setup_guest_gdt(struct lg_cpu *cpu);
 183 void load_guest_gdt_entry(struct lg_cpu *cpu, unsigned int i,
 184                           u32 low, u32 hi);
 185 void guest_load_tls(struct lg_cpu *cpu, unsigned long tls_array);
 186 void copy_gdt(const struct lg_cpu *cpu, struct desc_struct *gdt);
 187 void copy_gdt_tls(const struct lg_cpu *cpu, struct desc_struct *gdt);
 188
 189 /* page_tables.c: */
 190 int init_guest_pagetable(struct lguest *lg);
 191 void free_guest_pagetable(struct lguest *lg);
 192 void guest_new_pagetable(struct lg_cpu *cpu, unsigned long pgtable);
 193 void guest_set_pgd(struct lguest *lg, unsigned long gpgdir, u32 i);
 194 #ifdef CONFIG_X86_PAE
 195 void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
 196 #endif
 197 void guest_pagetable_clear_all(struct lg_cpu *cpu);
 198 void guest_pagetable_flush_user(struct lg_cpu *cpu);
 199 void guest_set_pte(struct lg_cpu *cpu, unsigned long gpgdir,
 200                    unsigned long vaddr, pte_t val);
 201 void map_switcher_in_guest(struct lg_cpu *cpu, struct lguest_pages *pages);
 202 bool demand_page(struct lg_cpu *cpu, unsigned long cr2, int errcode);
 203 void pin_page(struct lg_cpu *cpu, unsigned long vaddr);
 204 unsigned long guest_pa(struct lg_cpu *cpu, unsigned long vaddr);
 205 void page_table_guest_data_init(struct lg_cpu *cpu);
 206
 207 /* <arch>/core.c: */
 208 void lguest_arch_host_init(void);
 209 void lguest_arch_host_fini(void);
 210 void lguest_arch_run_guest(struct lg_cpu *cpu);
 211 void lguest_arch_handle_trap(struct lg_cpu *cpu);
 212 int lguest_arch_init_hypercalls(struct lg_cpu *cpu);
 213 int lguest_arch_do_hcall(struct lg_cpu *cpu, struct hcall_args *args);
 214 void lguest_arch_setup_regs(struct lg_cpu *cpu, unsigned long start);
 215 unsigned long *lguest_arch_regptr(struct lg_cpu *cpu, size_t reg_off, bool any);
 216
 217 /* <arch>/switcher.S: */
 218 extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
 219
 220 /* lguest_user.c: */
 221 int lguest_device_init(void);
 222 void lguest_device_remove(void);
 223
 224 /* hypercalls.c: */
 225 void do_hypercalls(struct lg_cpu *cpu);
 226 void write_timestamp(struct lg_cpu *cpu);
 227
 228 /*L:035
 229  * Let's step aside for the moment, to study one important routine that's used
 230  * widely in the Host code.
 231  *
 232  * There are many cases where the Guest can do something invalid, like pass crap
 233  * to a hypercall.  Since only the Guest kernel can make hypercalls, it's quite
 234  * acceptable to simply terminate the Guest and give the Launcher a nicely
 235  * formatted reason.  It's also simpler for the Guest itself, which doesn't
 236  * need to check most hypercalls for "success"; if you're still running, it
 237  * succeeded.
 238  *
 239  * Once this is called, the Guest will never run again, so most Host code can
 240  * call this then continue as if nothing had happened.  This means many
 241  * functions don't have to explicitly return an error code, which keeps the
 242  * code simple.
 243  *
 244  * It also means that this can be called more than once: only the first one is
 245  * remembered.  The only trick is that we still need to kill the Guest even if
 246  * we can't allocate memory to store the reason.  Linux has a neat way of
 247  * packing error codes into invalid pointers, so we use that here.
 248  *
 249  * Like any macro which uses an "if", it is safely wrapped in a run-once "do {
 250  * } while(0)".
 251  */
 252 #define kill_guest(cpu, fmt...)                                 \
 253 do {                                                            \
 254         if (!(cpu)->lg->dead) {                                 \
 255                 (cpu)->lg->dead = kasprintf(GFP_ATOMIC, fmt);   \
 256                 if (!(cpu)->lg->dead)                           \
 257                         (cpu)->lg->dead = ERR_PTR(-ENOMEM);     \
 258         }                                                       \
 259 } while(0)
 260 /* (End of aside) :*/
 261
 262 #endif  /* __ASSEMBLY__ */
 263 #endif  /* _LGUEST_H */