blob: f2c641e0bdde508887809176774badcc31519622 [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 lguest;
42
43struct lg_cpu {
44 unsigned int id;
45 struct lguest *lg;
Glauber de Oliveira Costa66686c22008-01-07 11:05:34 -020046 struct task_struct *tsk;
47 struct mm_struct *mm; /* == tsk->mm, but that becomes NULL on exit */
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -020048
Glauber de Oliveira Costa4665ac82008-01-07 11:05:35 -020049 u32 cr2;
50 int ts;
51 u32 esp1;
52 u8 ss1;
53
Glauber de Oliveira Costaae3749d2008-01-17 19:14:46 -020054 /* Bitmap of what has changed: see CHANGED_* above. */
55 int changed;
56
Glauber de Oliveira Costa5e232f42008-01-07 11:05:36 -020057 unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */
58
Glauber de Oliveira Costaa53a35a2008-01-07 11:05:32 -020059 /* At end of a page shared mapped over lguest_pages in guest. */
60 unsigned long regs_page;
61 struct lguest_regs *regs;
62
Glauber de Oliveira Costaf34f8c52008-01-17 19:13:26 -020063 struct lguest_pages *last_pages;
64
Glauber de Oliveira Costa17136082008-01-07 11:05:37 -020065 int cpu_pgd; /* which pgd this cpu is currently using */
66
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -020067 /* If a hypercall was asked for, this points to the arguments. */
68 struct hcall_args *hcall;
69 u32 next_hcall;
Glauber de Oliveira Costaad8d8f32008-01-07 11:05:28 -020070
71 /* Virtual clock device */
72 struct hrtimer hrt;
Glauber de Oliveira Costa177e4492008-01-07 11:05:29 -020073
Glauber de Oliveira Costa66686c22008-01-07 11:05:34 -020074 /* Do we need to stop what we're doing and return to userspace? */
75 int break_out;
76 wait_queue_head_t break_wq;
77 int halted;
78
Glauber de Oliveira Costa177e4492008-01-07 11:05:29 -020079 /* Pending virtual interrupts */
80 DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -020081
82 struct lg_cpu_arch arch;
Glauber de Oliveira Costabadb1e02008-01-07 11:05:22 -020083};
84
Rusty Russelld7e28ff2007-07-19 01:49:23 -070085/* The private info the thread maintains about the guest. */
86struct lguest
87{
Rusty Russelld7e28ff2007-07-19 01:49:23 -070088 struct lguest_data __user *lguest_data;
Glauber de Oliveira Costabadb1e02008-01-07 11:05:22 -020089 struct lg_cpu cpus[NR_CPUS];
90 unsigned int nr_cpus;
91
Rusty Russelld7e28ff2007-07-19 01:49:23 -070092 u32 pfn_limit;
Rusty Russell3c6b5bf2007-10-22 11:03:26 +100093 /* This provides the offset to the base of guest-physical
94 * memory in the Launcher. */
95 void __user *mem_base;
Rusty Russell47436aa2007-10-22 11:03:36 +100096 unsigned long kernel_address;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070097
Rusty Russelld7e28ff2007-07-19 01:49:23 -070098 struct pgdir pgdirs[4];
99
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700100 unsigned long noirq_start, noirq_end;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700101
102 unsigned int stack_pages;
103 u32 tsc_khz;
104
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700105 /* Dead? */
106 const char *dead;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700107};
108
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700109extern struct mutex lguest_lock;
110
111/* core.c: */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700112int lguest_address_ok(const struct lguest *lg,
113 unsigned long addr, unsigned long len);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200114void __lgread(struct lg_cpu *, void *, unsigned long, unsigned);
115void __lgwrite(struct lg_cpu *, unsigned long, const void *, unsigned);
Rusty Russell2d37f942007-10-22 11:24:24 +1000116
Rusty Russelle1e72962007-10-25 15:02:50 +1000117/*H:035 Using memory-copy operations like that is usually inconvient, so we
Rusty Russell2d37f942007-10-22 11:24:24 +1000118 * have the following helper macros which read and write a specific type (often
119 * an unsigned long).
120 *
121 * This reads into a variable of the given type then returns that. */
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200122#define lgread(cpu, addr, type) \
123 ({ type _v; __lgread((cpu), &_v, (addr), sizeof(_v)); _v; })
Rusty Russell2d37f942007-10-22 11:24:24 +1000124
125/* This checks that the variable is of the given type, then writes it out. */
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200126#define lgwrite(cpu, addr, type, val) \
Rusty Russell2d37f942007-10-22 11:24:24 +1000127 do { \
128 typecheck(type, val); \
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200129 __lgwrite((cpu), (addr), &(val), sizeof(val)); \
Rusty Russell2d37f942007-10-22 11:24:24 +1000130 } while(0)
131/* (end of memory access helper routines) :*/
132
Glauber de Oliveira Costad0953d42008-01-07 11:05:25 -0200133int run_guest(struct lg_cpu *cpu, unsigned long __user *user);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700134
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000135/* Helper macros to obtain the first 12 or the last 20 bits, this is only the
136 * first step in the migration to the kernel types. pte_pfn is already defined
137 * in the kernel. */
138#define pgd_flags(x) (pgd_val(x) & ~PAGE_MASK)
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000139#define pgd_pfn(x) (pgd_val(x) >> PAGE_SHIFT)
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700140
141/* interrupts_and_traps.c: */
Glauber de Oliveira Costa177e4492008-01-07 11:05:29 -0200142void maybe_do_interrupt(struct lg_cpu *cpu);
143int deliver_trap(struct lg_cpu *cpu, unsigned int num);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200144void load_guest_idt_entry(struct lg_cpu *cpu, unsigned int i,
145 u32 low, u32 hi);
Glauber de Oliveira Costa4665ac82008-01-07 11:05:35 -0200146void guest_set_stack(struct lg_cpu *cpu, u32 seg, u32 esp, unsigned int pages);
147void pin_stack_pages(struct lg_cpu *cpu);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700148void setup_default_idt_entries(struct lguest_ro_state *state,
149 const unsigned long *def);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200150void copy_traps(const struct lg_cpu *cpu, struct desc_struct *idt,
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700151 const unsigned long *def);
Glauber de Oliveira Costaad8d8f32008-01-07 11:05:28 -0200152void guest_set_clockevent(struct lg_cpu *cpu, unsigned long delta);
153void init_clockdev(struct lg_cpu *cpu);
Rusty Russellc18acd72007-10-22 11:03:35 +1000154bool check_syscall_vector(struct lguest *lg);
155int init_interrupts(void);
156void free_interrupts(void);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700157
158/* segments.c: */
159void setup_default_gdt_entries(struct lguest_ro_state *state);
Glauber de Oliveira Costafc708b32008-01-07 11:05:33 -0200160void setup_guest_gdt(struct lg_cpu *cpu);
161void load_guest_gdt(struct lg_cpu *cpu, unsigned long table, u32 num);
162void guest_load_tls(struct lg_cpu *cpu, unsigned long tls_array);
163void copy_gdt(const struct lg_cpu *cpu, struct desc_struct *gdt);
164void copy_gdt_tls(const struct lg_cpu *cpu, struct desc_struct *gdt);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700165
166/* page_tables.c: */
Matias Zabaljauregui58a24562008-09-29 01:40:07 -0300167int init_guest_pagetable(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700168void free_guest_pagetable(struct lguest *lg);
Glauber de Oliveira Costa4665ac82008-01-07 11:05:35 -0200169void guest_new_pagetable(struct lg_cpu *cpu, unsigned long pgtable);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000170void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
Glauber de Oliveira Costa4665ac82008-01-07 11:05:35 -0200171void guest_pagetable_clear_all(struct lg_cpu *cpu);
Glauber de Oliveira Costa17136082008-01-07 11:05:37 -0200172void guest_pagetable_flush_user(struct lg_cpu *cpu);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200173void guest_set_pte(struct lg_cpu *cpu, unsigned long gpgdir,
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000174 unsigned long vaddr, pte_t val);
Glauber de Oliveira Costa0c784412008-01-07 11:05:30 -0200175void map_switcher_in_guest(struct lg_cpu *cpu, struct lguest_pages *pages);
Glauber de Oliveira Costa17136082008-01-07 11:05:37 -0200176int demand_page(struct lg_cpu *cpu, unsigned long cr2, int errcode);
177void pin_page(struct lg_cpu *cpu, unsigned long vaddr);
178unsigned long guest_pa(struct lg_cpu *cpu, unsigned long vaddr);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200179void page_table_guest_data_init(struct lg_cpu *cpu);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700180
Jes Sorensen625efab2007-10-22 11:03:28 +1000181/* <arch>/core.c: */
182void lguest_arch_host_init(void);
183void lguest_arch_host_fini(void);
Glauber de Oliveira Costad0953d42008-01-07 11:05:25 -0200184void lguest_arch_run_guest(struct lg_cpu *cpu);
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -0200185void lguest_arch_handle_trap(struct lg_cpu *cpu);
186int lguest_arch_init_hypercalls(struct lg_cpu *cpu);
187int lguest_arch_do_hcall(struct lg_cpu *cpu, struct hcall_args *args);
Glauber de Oliveira Costaa53a35a2008-01-07 11:05:32 -0200188void lguest_arch_setup_regs(struct lg_cpu *cpu, unsigned long start);
Jes Sorensen625efab2007-10-22 11:03:28 +1000189
190/* <arch>/switcher.S: */
191extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
192
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700193/* lguest_user.c: */
194int lguest_device_init(void);
195void lguest_device_remove(void);
196
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700197/* hypercalls.c: */
Glauber de Oliveira Costa73044f02008-01-07 11:05:27 -0200198void do_hypercalls(struct lg_cpu *cpu);
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200199void write_timestamp(struct lg_cpu *cpu);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700200
Rusty Russelldde79782007-07-26 10:41:03 -0700201/*L:035
202 * Let's step aside for the moment, to study one important routine that's used
203 * widely in the Host code.
204 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000205 * There are many cases where the Guest can do something invalid, like pass crap
Rusty Russelldde79782007-07-26 10:41:03 -0700206 * to a hypercall. Since only the Guest kernel can make hypercalls, it's quite
207 * acceptable to simply terminate the Guest and give the Launcher a nicely
208 * formatted reason. It's also simpler for the Guest itself, which doesn't
209 * need to check most hypercalls for "success"; if you're still running, it
210 * succeeded.
211 *
212 * Once this is called, the Guest will never run again, so most Host code can
213 * call this then continue as if nothing had happened. This means many
214 * functions don't have to explicitly return an error code, which keeps the
215 * code simple.
216 *
217 * It also means that this can be called more than once: only the first one is
218 * remembered. The only trick is that we still need to kill the Guest even if
219 * we can't allocate memory to store the reason. Linux has a neat way of
220 * packing error codes into invalid pointers, so we use that here.
221 *
222 * Like any macro which uses an "if", it is safely wrapped in a run-once "do {
223 * } while(0)".
224 */
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200225#define kill_guest(cpu, fmt...) \
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700226do { \
Glauber de Oliveira Costa382ac6b2008-01-17 19:19:42 -0200227 if (!(cpu)->lg->dead) { \
228 (cpu)->lg->dead = kasprintf(GFP_ATOMIC, fmt); \
229 if (!(cpu)->lg->dead) \
230 (cpu)->lg->dead = ERR_PTR(-ENOMEM); \
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700231 } \
232} while(0)
Rusty Russelldde79782007-07-26 10:41:03 -0700233/* (End of aside) :*/
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700234
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700235#endif /* __ASSEMBLY__ */
236#endif /* _LGUEST_H */