blob: bfca2716ad114d8413451519df05c9497cd01f7d [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>
11#include <linux/err.h>
12#include <asm/semaphore.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;
46};
47
Rusty Russelld7e28ff2007-07-19 01:49:23 -070048/* The private info the thread maintains about the guest. */
49struct lguest
50{
51 /* At end of a page shared mapped over lguest_pages in guest. */
52 unsigned long regs_page;
53 struct lguest_regs *regs;
54 struct lguest_data __user *lguest_data;
55 struct task_struct *tsk;
56 struct mm_struct *mm; /* == tsk->mm, but that becomes NULL on exit */
Glauber de Oliveira Costabadb1e02008-01-07 11:05:22 -020057 struct lg_cpu cpus[NR_CPUS];
58 unsigned int nr_cpus;
59
Rusty Russelld7e28ff2007-07-19 01:49:23 -070060 u32 pfn_limit;
Rusty Russell3c6b5bf2007-10-22 11:03:26 +100061 /* This provides the offset to the base of guest-physical
62 * memory in the Launcher. */
63 void __user *mem_base;
Rusty Russell47436aa2007-10-22 11:03:36 +100064 unsigned long kernel_address;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070065 u32 cr2;
66 int halted;
67 int ts;
68 u32 next_hcall;
69 u32 esp1;
70 u8 ss1;
71
Rusty Russellcc6d4fb2007-10-22 11:03:30 +100072 /* If a hypercall was asked for, this points to the arguments. */
Jes Sorensenb410e7b2007-10-22 11:03:31 +100073 struct hcall_args *hcall;
Rusty Russellcc6d4fb2007-10-22 11:03:30 +100074
Rusty Russelld7e28ff2007-07-19 01:49:23 -070075 /* Do we need to stop what we're doing and return to userspace? */
76 int break_out;
77 wait_queue_head_t break_wq;
78
79 /* Bitmap of what has changed: see CHANGED_* above. */
80 int changed;
81 struct lguest_pages *last_pages;
82
83 /* We keep a small number of these. */
84 u32 pgdidx;
85 struct pgdir pgdirs[4];
86
Rusty Russelld7e28ff2007-07-19 01:49:23 -070087 unsigned long noirq_start, noirq_end;
Rusty Russell15045272007-10-22 11:24:10 +100088 unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070089
90 unsigned int stack_pages;
91 u32 tsc_khz;
92
Rusty Russelld7e28ff2007-07-19 01:49:23 -070093 /* Dead? */
94 const char *dead;
95
Jes Sorensen625efab2007-10-22 11:03:28 +100096 struct lguest_arch arch;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070097
98 /* Virtual clock device */
99 struct hrtimer hrt;
100
101 /* Pending virtual interrupts */
102 DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
103};
104
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700105extern struct mutex lguest_lock;
106
107/* core.c: */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700108int lguest_address_ok(const struct lguest *lg,
109 unsigned long addr, unsigned long len);
Rusty Russell2d37f942007-10-22 11:24:24 +1000110void __lgread(struct lguest *, void *, unsigned long, unsigned);
111void __lgwrite(struct lguest *, unsigned long, const void *, unsigned);
112
Rusty Russelle1e72962007-10-25 15:02:50 +1000113/*H:035 Using memory-copy operations like that is usually inconvient, so we
Rusty Russell2d37f942007-10-22 11:24:24 +1000114 * have the following helper macros which read and write a specific type (often
115 * an unsigned long).
116 *
117 * This reads into a variable of the given type then returns that. */
118#define lgread(lg, addr, type) \
119 ({ type _v; __lgread((lg), &_v, (addr), sizeof(_v)); _v; })
120
121/* This checks that the variable is of the given type, then writes it out. */
122#define lgwrite(lg, addr, type, val) \
123 do { \
124 typecheck(type, val); \
125 __lgwrite((lg), (addr), &(val), sizeof(val)); \
126 } while(0)
127/* (end of memory access helper routines) :*/
128
Glauber de Oliveira Costad0953d42008-01-07 11:05:25 -0200129int run_guest(struct lg_cpu *cpu, unsigned long __user *user);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700130
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000131/* Helper macros to obtain the first 12 or the last 20 bits, this is only the
132 * first step in the migration to the kernel types. pte_pfn is already defined
133 * in the kernel. */
134#define pgd_flags(x) (pgd_val(x) & ~PAGE_MASK)
135#define pte_flags(x) (pte_val(x) & ~PAGE_MASK)
136#define pgd_pfn(x) (pgd_val(x) >> PAGE_SHIFT)
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700137
138/* interrupts_and_traps.c: */
139void maybe_do_interrupt(struct lguest *lg);
140int deliver_trap(struct lguest *lg, unsigned int num);
141void load_guest_idt_entry(struct lguest *lg, unsigned int i, u32 low, u32 hi);
142void guest_set_stack(struct lguest *lg, u32 seg, u32 esp, unsigned int pages);
143void pin_stack_pages(struct lguest *lg);
144void setup_default_idt_entries(struct lguest_ro_state *state,
145 const unsigned long *def);
146void copy_traps(const struct lguest *lg, struct desc_struct *idt,
147 const unsigned long *def);
148void guest_set_clockevent(struct lguest *lg, unsigned long delta);
149void init_clockdev(struct lguest *lg);
Rusty Russellc18acd72007-10-22 11:03:35 +1000150bool check_syscall_vector(struct lguest *lg);
151int init_interrupts(void);
152void free_interrupts(void);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700153
154/* segments.c: */
155void setup_default_gdt_entries(struct lguest_ro_state *state);
156void setup_guest_gdt(struct lguest *lg);
157void load_guest_gdt(struct lguest *lg, unsigned long table, u32 num);
158void guest_load_tls(struct lguest *lg, unsigned long tls_array);
159void copy_gdt(const struct lguest *lg, struct desc_struct *gdt);
160void copy_gdt_tls(const struct lguest *lg, struct desc_struct *gdt);
161
162/* page_tables.c: */
163int init_guest_pagetable(struct lguest *lg, unsigned long pgtable);
164void free_guest_pagetable(struct lguest *lg);
165void guest_new_pagetable(struct lguest *lg, unsigned long pgtable);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000166void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700167void guest_pagetable_clear_all(struct lguest *lg);
168void guest_pagetable_flush_user(struct lguest *lg);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000169void guest_set_pte(struct lguest *lg, unsigned long gpgdir,
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000170 unsigned long vaddr, pte_t val);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700171void map_switcher_in_guest(struct lguest *lg, struct lguest_pages *pages);
172int demand_page(struct lguest *info, unsigned long cr2, int errcode);
173void pin_page(struct lguest *lg, unsigned long vaddr);
Rusty Russell47436aa2007-10-22 11:03:36 +1000174unsigned long guest_pa(struct lguest *lg, unsigned long vaddr);
175void page_table_guest_data_init(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700176
Jes Sorensen625efab2007-10-22 11:03:28 +1000177/* <arch>/core.c: */
178void lguest_arch_host_init(void);
179void lguest_arch_host_fini(void);
Glauber de Oliveira Costad0953d42008-01-07 11:05:25 -0200180void lguest_arch_run_guest(struct lg_cpu *cpu);
Jes Sorensen625efab2007-10-22 11:03:28 +1000181void lguest_arch_handle_trap(struct lguest *lg);
Jes Sorensenb410e7b2007-10-22 11:03:31 +1000182int lguest_arch_init_hypercalls(struct lguest *lg);
183int lguest_arch_do_hcall(struct lguest *lg, struct hcall_args *args);
Jes Sorensend612cde2007-10-22 11:03:32 +1000184void lguest_arch_setup_regs(struct lguest *lg, unsigned long start);
Jes Sorensen625efab2007-10-22 11:03:28 +1000185
186/* <arch>/switcher.S: */
187extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
188
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700189/* lguest_user.c: */
190int lguest_device_init(void);
191void lguest_device_remove(void);
192
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700193/* hypercalls.c: */
194void do_hypercalls(struct lguest *lg);
Rusty Russell6c8dca52007-07-27 13:42:52 +1000195void write_timestamp(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700196
Rusty Russelldde79782007-07-26 10:41:03 -0700197/*L:035
198 * Let's step aside for the moment, to study one important routine that's used
199 * widely in the Host code.
200 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000201 * There are many cases where the Guest can do something invalid, like pass crap
Rusty Russelldde79782007-07-26 10:41:03 -0700202 * to a hypercall. Since only the Guest kernel can make hypercalls, it's quite
203 * acceptable to simply terminate the Guest and give the Launcher a nicely
204 * formatted reason. It's also simpler for the Guest itself, which doesn't
205 * need to check most hypercalls for "success"; if you're still running, it
206 * succeeded.
207 *
208 * Once this is called, the Guest will never run again, so most Host code can
209 * call this then continue as if nothing had happened. This means many
210 * functions don't have to explicitly return an error code, which keeps the
211 * code simple.
212 *
213 * It also means that this can be called more than once: only the first one is
214 * remembered. The only trick is that we still need to kill the Guest even if
215 * we can't allocate memory to store the reason. Linux has a neat way of
216 * packing error codes into invalid pointers, so we use that here.
217 *
218 * Like any macro which uses an "if", it is safely wrapped in a run-once "do {
219 * } while(0)".
220 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700221#define kill_guest(lg, fmt...) \
222do { \
223 if (!(lg)->dead) { \
224 (lg)->dead = kasprintf(GFP_ATOMIC, fmt); \
225 if (!(lg)->dead) \
226 (lg)->dead = ERR_PTR(-ENOMEM); \
227 } \
228} while(0)
Rusty Russelldde79782007-07-26 10:41:03 -0700229/* (End of aside) :*/
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700230
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700231#endif /* __ASSEMBLY__ */
232#endif /* _LGUEST_H */