blob: 86924891b5eb21e3f8f3f3b19b7c2353290f5351 [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
41/* The private info the thread maintains about the guest. */
42struct lguest
43{
44 /* At end of a page shared mapped over lguest_pages in guest. */
45 unsigned long regs_page;
46 struct lguest_regs *regs;
47 struct lguest_data __user *lguest_data;
48 struct task_struct *tsk;
49 struct mm_struct *mm; /* == tsk->mm, but that becomes NULL on exit */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070050 u32 pfn_limit;
Rusty Russell3c6b5bf2007-10-22 11:03:26 +100051 /* This provides the offset to the base of guest-physical
52 * memory in the Launcher. */
53 void __user *mem_base;
Rusty Russell47436aa2007-10-22 11:03:36 +100054 unsigned long kernel_address;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070055 u32 cr2;
56 int halted;
57 int ts;
58 u32 next_hcall;
59 u32 esp1;
60 u8 ss1;
61
Rusty Russellcc6d4fb2007-10-22 11:03:30 +100062 /* If a hypercall was asked for, this points to the arguments. */
Jes Sorensenb410e7b2007-10-22 11:03:31 +100063 struct hcall_args *hcall;
Rusty Russellcc6d4fb2007-10-22 11:03:30 +100064
Rusty Russelld7e28ff2007-07-19 01:49:23 -070065 /* Do we need to stop what we're doing and return to userspace? */
66 int break_out;
67 wait_queue_head_t break_wq;
68
69 /* Bitmap of what has changed: see CHANGED_* above. */
70 int changed;
71 struct lguest_pages *last_pages;
72
73 /* We keep a small number of these. */
74 u32 pgdidx;
75 struct pgdir pgdirs[4];
76
Rusty Russelld7e28ff2007-07-19 01:49:23 -070077 unsigned long noirq_start, noirq_end;
Rusty Russell15045272007-10-22 11:24:10 +100078 unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070079
80 unsigned int stack_pages;
81 u32 tsc_khz;
82
Rusty Russelld7e28ff2007-07-19 01:49:23 -070083 /* Dead? */
84 const char *dead;
85
Jes Sorensen625efab2007-10-22 11:03:28 +100086 struct lguest_arch arch;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070087
88 /* Virtual clock device */
89 struct hrtimer hrt;
90
91 /* Pending virtual interrupts */
92 DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
93};
94
Rusty Russelld7e28ff2007-07-19 01:49:23 -070095extern struct mutex lguest_lock;
96
97/* core.c: */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070098int lguest_address_ok(const struct lguest *lg,
99 unsigned long addr, unsigned long len);
Rusty Russell2d37f942007-10-22 11:24:24 +1000100void __lgread(struct lguest *, void *, unsigned long, unsigned);
101void __lgwrite(struct lguest *, unsigned long, const void *, unsigned);
102
Rusty Russelle1e72962007-10-25 15:02:50 +1000103/*H:035 Using memory-copy operations like that is usually inconvient, so we
Rusty Russell2d37f942007-10-22 11:24:24 +1000104 * have the following helper macros which read and write a specific type (often
105 * an unsigned long).
106 *
107 * This reads into a variable of the given type then returns that. */
108#define lgread(lg, addr, type) \
109 ({ type _v; __lgread((lg), &_v, (addr), sizeof(_v)); _v; })
110
111/* This checks that the variable is of the given type, then writes it out. */
112#define lgwrite(lg, addr, type, val) \
113 do { \
114 typecheck(type, val); \
115 __lgwrite((lg), (addr), &(val), sizeof(val)); \
116 } while(0)
117/* (end of memory access helper routines) :*/
118
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700119int run_guest(struct lguest *lg, unsigned long __user *user);
120
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000121/* Helper macros to obtain the first 12 or the last 20 bits, this is only the
122 * first step in the migration to the kernel types. pte_pfn is already defined
123 * in the kernel. */
124#define pgd_flags(x) (pgd_val(x) & ~PAGE_MASK)
125#define pte_flags(x) (pte_val(x) & ~PAGE_MASK)
126#define pgd_pfn(x) (pgd_val(x) >> PAGE_SHIFT)
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700127
128/* interrupts_and_traps.c: */
129void maybe_do_interrupt(struct lguest *lg);
130int deliver_trap(struct lguest *lg, unsigned int num);
131void load_guest_idt_entry(struct lguest *lg, unsigned int i, u32 low, u32 hi);
132void guest_set_stack(struct lguest *lg, u32 seg, u32 esp, unsigned int pages);
133void pin_stack_pages(struct lguest *lg);
134void setup_default_idt_entries(struct lguest_ro_state *state,
135 const unsigned long *def);
136void copy_traps(const struct lguest *lg, struct desc_struct *idt,
137 const unsigned long *def);
138void guest_set_clockevent(struct lguest *lg, unsigned long delta);
139void init_clockdev(struct lguest *lg);
Rusty Russellc18acd72007-10-22 11:03:35 +1000140bool check_syscall_vector(struct lguest *lg);
141int init_interrupts(void);
142void free_interrupts(void);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700143
144/* segments.c: */
145void setup_default_gdt_entries(struct lguest_ro_state *state);
146void setup_guest_gdt(struct lguest *lg);
147void load_guest_gdt(struct lguest *lg, unsigned long table, u32 num);
148void guest_load_tls(struct lguest *lg, unsigned long tls_array);
149void copy_gdt(const struct lguest *lg, struct desc_struct *gdt);
150void copy_gdt_tls(const struct lguest *lg, struct desc_struct *gdt);
151
152/* page_tables.c: */
153int init_guest_pagetable(struct lguest *lg, unsigned long pgtable);
154void free_guest_pagetable(struct lguest *lg);
155void guest_new_pagetable(struct lguest *lg, unsigned long pgtable);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000156void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700157void guest_pagetable_clear_all(struct lguest *lg);
158void guest_pagetable_flush_user(struct lguest *lg);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000159void guest_set_pte(struct lguest *lg, unsigned long gpgdir,
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000160 unsigned long vaddr, pte_t val);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700161void map_switcher_in_guest(struct lguest *lg, struct lguest_pages *pages);
162int demand_page(struct lguest *info, unsigned long cr2, int errcode);
163void pin_page(struct lguest *lg, unsigned long vaddr);
Rusty Russell47436aa2007-10-22 11:03:36 +1000164unsigned long guest_pa(struct lguest *lg, unsigned long vaddr);
165void page_table_guest_data_init(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700166
Jes Sorensen625efab2007-10-22 11:03:28 +1000167/* <arch>/core.c: */
168void lguest_arch_host_init(void);
169void lguest_arch_host_fini(void);
170void lguest_arch_run_guest(struct lguest *lg);
171void lguest_arch_handle_trap(struct lguest *lg);
Jes Sorensenb410e7b2007-10-22 11:03:31 +1000172int lguest_arch_init_hypercalls(struct lguest *lg);
173int lguest_arch_do_hcall(struct lguest *lg, struct hcall_args *args);
Jes Sorensend612cde2007-10-22 11:03:32 +1000174void lguest_arch_setup_regs(struct lguest *lg, unsigned long start);
Jes Sorensen625efab2007-10-22 11:03:28 +1000175
176/* <arch>/switcher.S: */
177extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
178
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700179/* lguest_user.c: */
180int lguest_device_init(void);
181void lguest_device_remove(void);
182
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700183/* hypercalls.c: */
184void do_hypercalls(struct lguest *lg);
Rusty Russell6c8dca52007-07-27 13:42:52 +1000185void write_timestamp(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700186
Rusty Russelldde79782007-07-26 10:41:03 -0700187/*L:035
188 * Let's step aside for the moment, to study one important routine that's used
189 * widely in the Host code.
190 *
Rusty Russelle1e72962007-10-25 15:02:50 +1000191 * There are many cases where the Guest can do something invalid, like pass crap
Rusty Russelldde79782007-07-26 10:41:03 -0700192 * to a hypercall. Since only the Guest kernel can make hypercalls, it's quite
193 * acceptable to simply terminate the Guest and give the Launcher a nicely
194 * formatted reason. It's also simpler for the Guest itself, which doesn't
195 * need to check most hypercalls for "success"; if you're still running, it
196 * succeeded.
197 *
198 * Once this is called, the Guest will never run again, so most Host code can
199 * call this then continue as if nothing had happened. This means many
200 * functions don't have to explicitly return an error code, which keeps the
201 * code simple.
202 *
203 * It also means that this can be called more than once: only the first one is
204 * remembered. The only trick is that we still need to kill the Guest even if
205 * we can't allocate memory to store the reason. Linux has a neat way of
206 * packing error codes into invalid pointers, so we use that here.
207 *
208 * Like any macro which uses an "if", it is safely wrapped in a run-once "do {
209 * } while(0)".
210 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700211#define kill_guest(lg, fmt...) \
212do { \
213 if (!(lg)->dead) { \
214 (lg)->dead = kasprintf(GFP_ATOMIC, fmt); \
215 if (!(lg)->dead) \
216 (lg)->dead = ERR_PTR(-ENOMEM); \
217 } \
218} while(0)
Rusty Russelldde79782007-07-26 10:41:03 -0700219/* (End of aside) :*/
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700220
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700221#endif /* __ASSEMBLY__ */
222#endif /* _LGUEST_H */