blob: 7408cebe995e60422b017c19050978ed964eefd3 [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/futex.h>
9#include <linux/lguest.h>
10#include <linux/lguest_launcher.h>
11#include <linux/wait.h>
12#include <linux/err.h>
13#include <asm/semaphore.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -070014
Jes Sorensen625efab2007-10-22 11:03:28 +100015#include <asm/lguest.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -070016
17void free_pagetables(void);
18int init_pagetables(struct page **switcher_page, unsigned int pages);
19
Rusty Russelld7e28ff2007-07-19 01:49:23 -070020struct lguest_dma_info
21{
22 struct list_head list;
23 union futex_key key;
24 unsigned long dmas;
Rusty Russell48245cc2007-10-22 11:03:27 +100025 struct lguest *owner;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070026 u16 next_dma;
27 u16 num_dmas;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070028 u8 interrupt; /* 0 when not registered */
29};
30
Rusty Russelld7e28ff2007-07-19 01:49:23 -070031struct pgdir
32{
Rusty Russellee3db0f2007-10-22 11:03:34 +100033 unsigned long gpgdir;
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +100034 pgd_t *pgdir;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070035};
36
Rusty Russelld7e28ff2007-07-19 01:49:23 -070037/* We have two pages shared with guests, per cpu. */
38struct lguest_pages
39{
40 /* This is the stack page mapped rw in guest */
41 char spare[PAGE_SIZE - sizeof(struct lguest_regs)];
42 struct lguest_regs regs;
43
44 /* This is the host state & guest descriptor page, ro in guest */
45 struct lguest_ro_state state;
46} __attribute__((aligned(PAGE_SIZE)));
47
48#define CHANGED_IDT 1
49#define CHANGED_GDT 2
50#define CHANGED_GDT_TLS 4 /* Actually a subset of CHANGED_GDT */
51#define CHANGED_ALL 3
52
53/* The private info the thread maintains about the guest. */
54struct lguest
55{
56 /* At end of a page shared mapped over lguest_pages in guest. */
57 unsigned long regs_page;
58 struct lguest_regs *regs;
59 struct lguest_data __user *lguest_data;
60 struct task_struct *tsk;
61 struct mm_struct *mm; /* == tsk->mm, but that becomes NULL on exit */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070062 u32 pfn_limit;
Rusty Russell3c6b5bf2007-10-22 11:03:26 +100063 /* This provides the offset to the base of guest-physical
64 * memory in the Launcher. */
65 void __user *mem_base;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070066 u32 page_offset;
67 u32 cr2;
68 int halted;
69 int ts;
70 u32 next_hcall;
71 u32 esp1;
72 u8 ss1;
73
Rusty Russellcc6d4fb2007-10-22 11:03:30 +100074 /* If a hypercall was asked for, this points to the arguments. */
Jes Sorensenb410e7b2007-10-22 11:03:31 +100075 struct hcall_args *hcall;
Rusty Russellcc6d4fb2007-10-22 11:03:30 +100076
Rusty Russelld7e28ff2007-07-19 01:49:23 -070077 /* Do we need to stop what we're doing and return to userspace? */
78 int break_out;
79 wait_queue_head_t break_wq;
80
81 /* Bitmap of what has changed: see CHANGED_* above. */
82 int changed;
83 struct lguest_pages *last_pages;
84
85 /* We keep a small number of these. */
86 u32 pgdidx;
87 struct pgdir pgdirs[4];
88
89 /* Cached wakeup: we hold a reference to this task. */
90 struct task_struct *wake;
91
92 unsigned long noirq_start, noirq_end;
93 int dma_is_pending;
94 unsigned long pending_dma; /* struct lguest_dma */
95 unsigned long pending_key; /* address they're sending to */
96
97 unsigned int stack_pages;
98 u32 tsc_khz;
99
100 struct lguest_dma_info dma[LGUEST_MAX_DMA];
101
102 /* Dead? */
103 const char *dead;
104
Jes Sorensen625efab2007-10-22 11:03:28 +1000105 struct lguest_arch arch;
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700106
107 /* Virtual clock device */
108 struct hrtimer hrt;
109
110 /* Pending virtual interrupts */
111 DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
112};
113
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700114extern struct mutex lguest_lock;
115
116/* core.c: */
117u32 lgread_u32(struct lguest *lg, unsigned long addr);
118void lgwrite_u32(struct lguest *lg, unsigned long addr, u32 val);
119void lgread(struct lguest *lg, void *buf, unsigned long addr, unsigned len);
120void lgwrite(struct lguest *lg, unsigned long, const void *buf, unsigned len);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700121int lguest_address_ok(const struct lguest *lg,
122 unsigned long addr, unsigned long len);
123int run_guest(struct lguest *lg, unsigned long __user *user);
124
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000125/* Helper macros to obtain the first 12 or the last 20 bits, this is only the
126 * first step in the migration to the kernel types. pte_pfn is already defined
127 * in the kernel. */
128#define pgd_flags(x) (pgd_val(x) & ~PAGE_MASK)
129#define pte_flags(x) (pte_val(x) & ~PAGE_MASK)
130#define pgd_pfn(x) (pgd_val(x) >> PAGE_SHIFT)
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700131
132/* interrupts_and_traps.c: */
133void maybe_do_interrupt(struct lguest *lg);
134int deliver_trap(struct lguest *lg, unsigned int num);
135void load_guest_idt_entry(struct lguest *lg, unsigned int i, u32 low, u32 hi);
136void guest_set_stack(struct lguest *lg, u32 seg, u32 esp, unsigned int pages);
137void pin_stack_pages(struct lguest *lg);
138void setup_default_idt_entries(struct lguest_ro_state *state,
139 const unsigned long *def);
140void copy_traps(const struct lguest *lg, struct desc_struct *idt,
141 const unsigned long *def);
142void guest_set_clockevent(struct lguest *lg, unsigned long delta);
143void init_clockdev(struct lguest *lg);
Rusty Russellc18acd72007-10-22 11:03:35 +1000144bool check_syscall_vector(struct lguest *lg);
145int init_interrupts(void);
146void free_interrupts(void);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700147
148/* segments.c: */
149void setup_default_gdt_entries(struct lguest_ro_state *state);
150void setup_guest_gdt(struct lguest *lg);
151void load_guest_gdt(struct lguest *lg, unsigned long table, u32 num);
152void guest_load_tls(struct lguest *lg, unsigned long tls_array);
153void copy_gdt(const struct lguest *lg, struct desc_struct *gdt);
154void copy_gdt_tls(const struct lguest *lg, struct desc_struct *gdt);
155
156/* page_tables.c: */
157int init_guest_pagetable(struct lguest *lg, unsigned long pgtable);
158void free_guest_pagetable(struct lguest *lg);
159void guest_new_pagetable(struct lguest *lg, unsigned long pgtable);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000160void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700161void guest_pagetable_clear_all(struct lguest *lg);
162void guest_pagetable_flush_user(struct lguest *lg);
Rusty Russellee3db0f2007-10-22 11:03:34 +1000163void guest_set_pte(struct lguest *lg, unsigned long gpgdir,
Matias Zabaljaureguidf29f432007-10-22 11:03:33 +1000164 unsigned long vaddr, pte_t val);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700165void map_switcher_in_guest(struct lguest *lg, struct lguest_pages *pages);
166int demand_page(struct lguest *info, unsigned long cr2, int errcode);
167void pin_page(struct lguest *lg, unsigned long vaddr);
168
Jes Sorensen625efab2007-10-22 11:03:28 +1000169/* <arch>/core.c: */
170void lguest_arch_host_init(void);
171void lguest_arch_host_fini(void);
172void lguest_arch_run_guest(struct lguest *lg);
173void lguest_arch_handle_trap(struct lguest *lg);
Jes Sorensenb410e7b2007-10-22 11:03:31 +1000174int lguest_arch_init_hypercalls(struct lguest *lg);
175int lguest_arch_do_hcall(struct lguest *lg, struct hcall_args *args);
Jes Sorensend612cde2007-10-22 11:03:32 +1000176void lguest_arch_setup_regs(struct lguest *lg, unsigned long start);
Jes Sorensen625efab2007-10-22 11:03:28 +1000177
178/* <arch>/switcher.S: */
179extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
180
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700181/* lguest_user.c: */
182int lguest_device_init(void);
183void lguest_device_remove(void);
184
185/* io.c: */
186void lguest_io_init(void);
187int bind_dma(struct lguest *lg,
188 unsigned long key, unsigned long udma, u16 numdmas, u8 interrupt);
189void send_dma(struct lguest *info, unsigned long key, unsigned long udma);
190void release_all_dma(struct lguest *lg);
191unsigned long get_dma_buffer(struct lguest *lg, unsigned long key,
192 unsigned long *interrupt);
193
194/* hypercalls.c: */
195void do_hypercalls(struct lguest *lg);
Rusty Russell6c8dca52007-07-27 13:42:52 +1000196void write_timestamp(struct lguest *lg);
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700197
Rusty Russelldde79782007-07-26 10:41:03 -0700198/*L:035
199 * Let's step aside for the moment, to study one important routine that's used
200 * widely in the Host code.
201 *
202 * There are many cases where the Guest does something invalid, like pass crap
203 * to a hypercall. Since only the Guest kernel can make hypercalls, it's quite
204 * acceptable to simply terminate the Guest and give the Launcher a nicely
205 * formatted reason. It's also simpler for the Guest itself, which doesn't
206 * need to check most hypercalls for "success"; if you're still running, it
207 * succeeded.
208 *
209 * Once this is called, the Guest will never run again, so most Host code can
210 * call this then continue as if nothing had happened. This means many
211 * functions don't have to explicitly return an error code, which keeps the
212 * code simple.
213 *
214 * It also means that this can be called more than once: only the first one is
215 * remembered. The only trick is that we still need to kill the Guest even if
216 * we can't allocate memory to store the reason. Linux has a neat way of
217 * packing error codes into invalid pointers, so we use that here.
218 *
219 * Like any macro which uses an "if", it is safely wrapped in a run-once "do {
220 * } while(0)".
221 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700222#define kill_guest(lg, fmt...) \
223do { \
224 if (!(lg)->dead) { \
225 (lg)->dead = kasprintf(GFP_ATOMIC, fmt); \
226 if (!(lg)->dead) \
227 (lg)->dead = ERR_PTR(-ENOMEM); \
228 } \
229} while(0)
Rusty Russelldde79782007-07-26 10:41:03 -0700230/* (End of aside) :*/
Rusty Russelld7e28ff2007-07-19 01:49:23 -0700231
232static inline unsigned long guest_pa(struct lguest *lg, unsigned long vaddr)
233{
234 return vaddr - lg->page_offset;
235}
236#endif /* __ASSEMBLY__ */
237#endif /* _LGUEST_H */