blob: 01c591923793f4d494fffef7d86a17f0da43f479 [file] [log] [blame]
Rusty Russelld7e28ff2007-07-19 01:49:23 -07001#ifndef _LGUEST_H
2#define _LGUEST_H
3
Rusty Russelld7e28ff2007-07-19 01:49:23 -07004#ifndef __ASSEMBLY__
5#include <linux/types.h>
6#include <linux/init.h>
7#include <linux/stringify.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -07008#include <linux/lguest.h>
9#include <linux/lguest_launcher.h>
10#include <linux/wait.h>
Glauber de Oliveira Costaca94f2b2008-01-18 23:59:07 -020011#include <linux/hrtimer.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -070012#include <linux/err.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -070013
Jes Sorensen625efab2007-10-22 11:03:28 +100014#include <asm/lguest.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -070015
16void free_pagetables(void);
17int init_pagetables(struct page **switcher_page, unsigned int pages);
18
Rusty Russelld7e28ff2007-07-19 01:49:23 -070019struct pgdir
20{
Rusty Russellee3db0f2007-10-22 11:03:34 +100021 unsigned long gpgdir;
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +100022 pgd_t *pgdir;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070023};
24
Rusty Russelld7e28ff2007-07-19 01:49:23 -070025/* We have two pages shared with guests, per cpu. */
26struct lguest_pages
27{
28 /* This is the stack page mapped rw in guest */
29 char spare[PAGE_SIZE - sizeof(struct lguest_regs)];
30 struct lguest_regs regs;
31
32 /* This is the host state & guest descriptor page, ro in guest */
33 struct lguest_ro_state state;
34} __attribute__((aligned(PAGE_SIZE)));
35
36#define CHANGED_IDT 1
37#define CHANGED_GDT 2
38#define CHANGED_GDT_TLS 4 /* Actually a subset of CHANGED_GDT */
39#define CHANGED_ALL 3
40
Glauber de Oliveira Costabadb1e02008-01-07 11:05:22 -020041struct lg_cpu {
42 unsigned int id;
43 struct lguest *lg;
Glauber de Oliveira Costa66686c22008-01-07 11:05:34 -020044 struct task_struct *tsk;
45 struct mm_struct *mm; /* == tsk->mm, but that becomes NULL on exit */
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -020046
Glauber de Oliveira Costa4665ac8e2008-01-07 11:05:35 -020047 u32 cr2;
48 int ts;
49 u32 esp1;
Matias Zabaljaureguif0861222009-06-12 22:27:04 -060050 u16 ss1;
Glauber de Oliveira Costa4665ac8e2008-01-07 11:05:35 -020051
Glauber de Oliveira Costaae3749d2008-01-17 19:14:46 -020052 /* Bitmap of what has changed: see CHANGED_* above. */
53 int changed;
54
Glauber de Oliveira Costa5e232f42008-01-07 11:05:36 -020055 unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */
56
Glauber de Oliveira Costaa53a35a2008-01-07 11:05:32 -020057 /* At end of a page shared mapped over lguest_pages in guest. */
58 unsigned long regs_page;
59 struct lguest_regs *regs;
60
Glauber de Oliveira Costaf34f8c52008-01-17 19:13:26 -020061 struct lguest_pages *last_pages;
62
Glauber de Oliveira Costa17136082008-01-07 11:05:37 -020063 int cpu_pgd; /* which pgd this cpu is currently using */
64
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -020065 /* If a hypercall was asked for, this points to the arguments. */
66 struct hcall_args *hcall;
67 u32 next_hcall;
Glauber de Oliveira Costaad8d8f32008-01-07 11:05:28 -020068
69 /* Virtual clock device */
70 struct hrtimer hrt;
Glauber de Oliveira Costa177e4492008-01-07 11:05:29 -020071
Rusty Russell5dac0512009-06-12 22:27:10 -060072 /* Did the Guest tell us to halt? */
Glauber de Oliveira Costa66686c22008-01-07 11:05:34 -020073 int halted;
74
Glauber de Oliveira Costa177e4492008-01-07 11:05:29 -020075 /* Pending virtual interrupts */
76 DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -020077
78 struct lg_cpu_arch arch;
Glauber de Oliveira Costabadb1e02008-01-07 11:05:22 -020079};
80
Rusty Russelldf60aee2009-06-12 22:27:09 -060081struct lg_eventfd {
82 unsigned long addr;
Davide Libenzi13389012009-06-30 11:41:11 -070083 struct eventfd_ctx *event;
Rusty Russelldf60aee2009-06-12 22:27:09 -060084};
85
86struct lg_eventfd_map {
87 unsigned int num;
88 struct lg_eventfd map[];
89};
90
Rusty Russelld7e28ff2007-07-19 01:49:23 -070091/* The private info the thread maintains about the guest. */
92struct lguest
93{
Rusty Russelld7e28ff2007-07-19 01:49:23 -070094 struct lguest_data __user *lguest_data;
Glauber de Oliveira Costabadb1e02008-01-07 11:05:22 -020095 struct lg_cpu cpus[NR_CPUS];
96 unsigned int nr_cpus;
97
Rusty Russelld7e28ff2007-07-19 01:49:23 -070098 u32 pfn_limit;
Rusty Russell3c6b5bf2007-10-22 11:03:26 +100099 /* This provides the offset to the base of guest-physical
100 * memory in the Launcher. */
101 void __user *mem_base;
Rusty Russell47436aa2007-10-22 11:03:36 +1000102 unsigned long kernel_address;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700103
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700104 struct pgdir pgdirs[4];
105
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700106 unsigned long noirq_start, noirq_end;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700107
108 unsigned int stack_pages;
109 u32 tsc_khz;
110
Rusty Russelldf60aee2009-06-12 22:27:09 -0600111 struct lg_eventfd_map *eventfds;
112
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700113 /* Dead? */
114 const char *dead;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700115};
116
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700117extern struct mutex lguest_lock;
118
119/* core.c: */
Matias Zabaljaureguidf1693a2009-03-18 13:38:35 -0300120bool lguest_address_ok(const struct lguest *lg,
121 unsigned long addr, unsigned long len);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200122void __lgread(struct lg_cpu *, void *, unsigned long, unsigned);
123void __lgwrite(struct lg_cpu *, unsigned long, const void *, unsigned);
Rusty Russell2d37f942007-10-22 11:24:24 +1000124
Rusty Russelle1e72962007-10-25 15:02:50 +1000125/*H:035 Using memory-copy operations like that is usually inconvient, so we
Rusty Russell2d37f942007-10-22 11:24:24 +1000126 * have the following helper macros which read and write a specific type (often
127 * an unsigned long).
128 *
129 * This reads into a variable of the given type then returns that. */
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200130#define lgread(cpu, addr, type) \
131 ({ type _v; __lgread((cpu), &_v, (addr), sizeof(_v)); _v; })
Rusty Russell2d37f942007-10-22 11:24:24 +1000132
133/* This checks that the variable is of the given type, then writes it out. */
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200134#define lgwrite(cpu, addr, type, val) \
Rusty Russell2d37f942007-10-22 11:24:24 +1000135 do { \
136 typecheck(type, val); \
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200137 __lgwrite((cpu), (addr), &(val), sizeof(val)); \
Rusty Russell2d37f942007-10-22 11:24:24 +1000138 } while(0)
139/* (end of memory access helper routines) :*/
140
Glauber de Oliveira Costad0953d42008-01-07 11:05:25 -0200141int run_guest(struct lg_cpu *cpu, unsigned long __user *user);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700142
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000143/* Helper macros to obtain the first 12 or the last 20 bits, this is only the
144 * first step in the migration to the kernel types. pte_pfn is already defined
145 * in the kernel. */
146#define pgd_flags(x) (pgd_val(x) & ~PAGE_MASK)
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000147#define pgd_pfn(x) (pgd_val(x) >> PAGE_SHIFT)
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600148#define pmd_flags(x) (pmd_val(x) & ~PAGE_MASK)
149#define pmd_pfn(x) (pmd_val(x) >> PAGE_SHIFT)
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700150
151/* interrupts_and_traps.c: */
Rusty Russella32a88132009-06-12 22:27:02 -0600152unsigned int interrupt_pending(struct lg_cpu *cpu, bool *more);
153void try_deliver_interrupt(struct lg_cpu *cpu, unsigned int irq, bool more);
Rusty Russell9f155a92009-06-12 22:27:08 -0600154void set_interrupt(struct lg_cpu *cpu, unsigned int irq);
Matias Zabaljaureguidf1693a2009-03-18 13:38:35 -0300155bool deliver_trap(struct lg_cpu *cpu, unsigned int num);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200156void load_guest_idt_entry(struct lg_cpu *cpu, unsigned int i,
157 u32 low, u32 hi);
Glauber de Oliveira Costa4665ac8e2008-01-07 11:05:35 -0200158void guest_set_stack(struct lg_cpu *cpu, u32 seg, u32 esp, unsigned int pages);
159void pin_stack_pages(struct lg_cpu *cpu);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700160void setup_default_idt_entries(struct lguest_ro_state *state,
161 const unsigned long *def);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200162void copy_traps(const struct lg_cpu *cpu, struct desc_struct *idt,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700163 const unsigned long *def);
Glauber de Oliveira Costaad8d8f32008-01-07 11:05:28 -0200164void guest_set_clockevent(struct lg_cpu *cpu, unsigned long delta);
Rusty Russelldf60aee2009-06-12 22:27:09 -0600165bool send_notify_to_eventfd(struct lg_cpu *cpu);
Glauber de Oliveira Costaad8d8f32008-01-07 11:05:28 -0200166void init_clockdev(struct lg_cpu *cpu);
Rusty Russellc18acd72007-10-22 11:03:35 +1000167bool check_syscall_vector(struct lguest *lg);
168int init_interrupts(void);
169void free_interrupts(void);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700170
171/* segments.c: */
172void setup_default_gdt_entries(struct lguest_ro_state *state);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200173void setup_guest_gdt(struct lg_cpu *cpu);
Rusty Russella489f0b2009-04-19 23:14:00 -0600174void load_guest_gdt_entry(struct lg_cpu *cpu, unsigned int i,
175 u32 low, u32 hi);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200176void guest_load_tls(struct lg_cpu *cpu, unsigned long tls_array);
177void copy_gdt(const struct lg_cpu *cpu, struct desc_struct *gdt);
178void copy_gdt_tls(const struct lg_cpu *cpu, struct desc_struct *gdt);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700179
180/* page_tables.c: */
Matias Zabaljauregui58a24562008-09-29 01:40:07 -0300181int init_guest_pagetable(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700182void free_guest_pagetable(struct lguest *lg);
Glauber de Oliveira Costa4665ac8e2008-01-07 11:05:35 -0200183void guest_new_pagetable(struct lg_cpu *cpu, unsigned long pgtable);
Matias Zabaljaureguiebe0ba82009-05-30 15:48:08 -0300184void guest_set_pgd(struct lguest *lg, unsigned long gpgdir, u32 i);
Matias Zabaljaureguiacdd0b62009-06-12 22:27:07 -0600185#ifdef CONFIG_X86_PAE
186void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
187#endif
Glauber de Oliveira Costa4665ac8e2008-01-07 11:05:35 -0200188void guest_pagetable_clear_all(struct lg_cpu *cpu);
Glauber de Oliveira Costa17136082008-01-07 11:05:37 -0200189void guest_pagetable_flush_user(struct lg_cpu *cpu);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200190void guest_set_pte(struct lg_cpu *cpu, unsigned long gpgdir,
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000191 unsigned long vaddr, pte_t val);
Glauber de Oliveira Costa0c784412008-01-07 11:05:30 -0200192void map_switcher_in_guest(struct lg_cpu *cpu, struct lguest_pages *pages);
Matias Zabaljaureguidf1693a2009-03-18 13:38:35 -0300193bool demand_page(struct lg_cpu *cpu, unsigned long cr2, int errcode);
Glauber de Oliveira Costa17136082008-01-07 11:05:37 -0200194void pin_page(struct lg_cpu *cpu, unsigned long vaddr);
195unsigned long guest_pa(struct lg_cpu *cpu, unsigned long vaddr);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200196void page_table_guest_data_init(struct lg_cpu *cpu);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700197
Jes Sorensen625efab2007-10-22 11:03:28 +1000198/* <arch>/core.c: */
199void lguest_arch_host_init(void);
200void lguest_arch_host_fini(void);
Glauber de Oliveira Costad0953d42008-01-07 11:05:25 -0200201void lguest_arch_run_guest(struct lg_cpu *cpu);
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -0200202void lguest_arch_handle_trap(struct lg_cpu *cpu);
203int lguest_arch_init_hypercalls(struct lg_cpu *cpu);
204int lguest_arch_do_hcall(struct lg_cpu *cpu, struct hcall_args *args);
Glauber de Oliveira Costaa53a35a2008-01-07 11:05:32 -0200205void lguest_arch_setup_regs(struct lg_cpu *cpu, unsigned long start);
Jes Sorensen625efab2007-10-22 11:03:28 +1000206
207/* <arch>/switcher.S: */
208extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
209
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700210/* lguest_user.c: */
211int lguest_device_init(void);
212void lguest_device_remove(void);
213
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700214/* hypercalls.c: */
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -0200215void do_hypercalls(struct lg_cpu *cpu);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200216void write_timestamp(struct lg_cpu *cpu);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700217
Rusty Russelldde79782007-07-26 10:41:03 -0700218/*L:035
219 * Let's step aside for the moment, to study one important routine that's used
220 * widely in the Host code.
221 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000222 * There are many cases where the Guest can do something invalid, like pass crap
Rusty Russelldde79782007-07-26 10:41:03 -0700223 * to a hypercall. Since only the Guest kernel can make hypercalls, it's quite
224 * acceptable to simply terminate the Guest and give the Launcher a nicely
225 * formatted reason. It's also simpler for the Guest itself, which doesn't
226 * need to check most hypercalls for "success"; if you're still running, it
227 * succeeded.
228 *
229 * Once this is called, the Guest will never run again, so most Host code can
230 * call this then continue as if nothing had happened. This means many
231 * functions don't have to explicitly return an error code, which keeps the
232 * code simple.
233 *
234 * It also means that this can be called more than once: only the first one is
235 * remembered. The only trick is that we still need to kill the Guest even if
236 * we can't allocate memory to store the reason. Linux has a neat way of
237 * packing error codes into invalid pointers, so we use that here.
238 *
239 * Like any macro which uses an "if", it is safely wrapped in a run-once "do {
240 * } while(0)".
241 */
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200242#define kill_guest(cpu, fmt...) \
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700243do { \
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200244 if (!(cpu)->lg->dead) { \
245 (cpu)->lg->dead = kasprintf(GFP_ATOMIC, fmt); \
246 if (!(cpu)->lg->dead) \
247 (cpu)->lg->dead = ERR_PTR(-ENOMEM); \
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700248 } \
249} while(0)
Rusty Russelldde79782007-07-26 10:41:03 -0700250/* (End of aside) :*/
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700251
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700252#endif /* __ASSEMBLY__ */
253#endif /* _LGUEST_H */