]>
Commit | Line | Data |
---|---|---|
d7e28ffe RR |
1 | #ifndef _LGUEST_H |
2 | #define _LGUEST_H | |
3 | ||
d7e28ffe RR |
4 | #ifndef __ASSEMBLY__ |
5 | #include <linux/types.h> | |
6 | #include <linux/init.h> | |
7 | #include <linux/stringify.h> | |
d7e28ffe RR |
8 | #include <linux/lguest.h> |
9 | #include <linux/lguest_launcher.h> | |
10 | #include <linux/wait.h> | |
ca94f2bd | 11 | #include <linux/hrtimer.h> |
d7e28ffe | 12 | #include <linux/err.h> |
5a0e3ad6 | 13 | #include <linux/slab.h> |
d7e28ffe | 14 | |
625efab1 | 15 | #include <asm/lguest.h> |
d7e28ffe RR |
16 | |
17 | void free_pagetables(void); | |
18 | int init_pagetables(struct page **switcher_page, unsigned int pages); | |
19 | ||
1842f23c | 20 | struct pgdir { |
ee3db0f2 | 21 | unsigned long gpgdir; |
df29f43e | 22 | pgd_t *pgdir; |
d7e28ffe RR |
23 | }; |
24 | ||
d7e28ffe | 25 | /* We have two pages shared with guests, per cpu. */ |
1842f23c | 26 | struct lguest_pages { |
d7e28ffe RR |
27 | /* This is the stack page mapped rw in guest */ |
28 | char spare[PAGE_SIZE - sizeof(struct lguest_regs)]; | |
29 | struct lguest_regs regs; | |
30 | ||
31 | /* This is the host state & guest descriptor page, ro in guest */ | |
32 | struct lguest_ro_state state; | |
33 | } __attribute__((aligned(PAGE_SIZE))); | |
34 | ||
35 | #define CHANGED_IDT 1 | |
36 | #define CHANGED_GDT 2 | |
37 | #define CHANGED_GDT_TLS 4 /* Actually a subset of CHANGED_GDT */ | |
38 | #define CHANGED_ALL 3 | |
39 | ||
badb1e04 GOC |
40 | struct lg_cpu { |
41 | unsigned int id; | |
42 | struct lguest *lg; | |
66686c2a GOC |
43 | struct task_struct *tsk; |
44 | struct mm_struct *mm; /* == tsk->mm, but that becomes NULL on exit */ | |
73044f05 | 45 | |
4665ac8e GOC |
46 | u32 cr2; |
47 | int ts; | |
48 | u32 esp1; | |
f086122b | 49 | u16 ss1; |
4665ac8e | 50 | |
ae3749dc GOC |
51 | /* Bitmap of what has changed: see CHANGED_* above. */ |
52 | int changed; | |
53 | ||
5e232f4f GOC |
54 | unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */ |
55 | ||
2e04ef76 | 56 | /* At end of a page shared mapped over lguest_pages in guest. */ |
a53a35a8 GOC |
57 | unsigned long regs_page; |
58 | struct lguest_regs *regs; | |
59 | ||
f34f8c5f GOC |
60 | struct lguest_pages *last_pages; |
61 | ||
2e04ef76 | 62 | int cpu_pgd; /* Which pgd this cpu is currently using */ |
1713608f | 63 | |
73044f05 GOC |
64 | /* If a hypercall was asked for, this points to the arguments. */ |
65 | struct hcall_args *hcall; | |
66 | u32 next_hcall; | |
ad8d8f3b GOC |
67 | |
68 | /* Virtual clock device */ | |
69 | struct hrtimer hrt; | |
177e449d | 70 | |
5dac051b | 71 | /* Did the Guest tell us to halt? */ |
66686c2a GOC |
72 | int halted; |
73 | ||
177e449d GOC |
74 | /* Pending virtual interrupts */ |
75 | DECLARE_BITMAP(irqs_pending, LGUEST_IRQS); | |
fc708b3e GOC |
76 | |
77 | struct lg_cpu_arch arch; | |
badb1e04 GOC |
78 | }; |
79 | ||
df60aeef RR |
80 | struct lg_eventfd { |
81 | unsigned long addr; | |
13389010 | 82 | struct eventfd_ctx *event; |
df60aeef RR |
83 | }; |
84 | ||
85 | struct lg_eventfd_map { | |
86 | unsigned int num; | |
87 | struct lg_eventfd map[]; | |
88 | }; | |
89 | ||
d7e28ffe | 90 | /* The private info the thread maintains about the guest. */ |
1842f23c | 91 | struct lguest { |
d7e28ffe | 92 | struct lguest_data __user *lguest_data; |
badb1e04 GOC |
93 | struct lg_cpu cpus[NR_CPUS]; |
94 | unsigned int nr_cpus; | |
95 | ||
d7e28ffe | 96 | u32 pfn_limit; |
2e04ef76 RR |
97 | |
98 | /* | |
99 | * This provides the offset to the base of guest-physical memory in the | |
100 | * Launcher. | |
101 | */ | |
3c6b5bfa | 102 | void __user *mem_base; |
47436aa4 | 103 | unsigned long kernel_address; |
d7e28ffe | 104 | |
d7e28ffe RR |
105 | struct pgdir pgdirs[4]; |
106 | ||
d7e28ffe | 107 | unsigned long noirq_start, noirq_end; |
d7e28ffe RR |
108 | |
109 | unsigned int stack_pages; | |
110 | u32 tsc_khz; | |
111 | ||
df60aeef RR |
112 | struct lg_eventfd_map *eventfds; |
113 | ||
d7e28ffe RR |
114 | /* Dead? */ |
115 | const char *dead; | |
d7e28ffe RR |
116 | }; |
117 | ||
d7e28ffe RR |
118 | extern struct mutex lguest_lock; |
119 | ||
120 | /* core.c: */ | |
df1693ab MZ |
121 | bool lguest_address_ok(const struct lguest *lg, |
122 | unsigned long addr, unsigned long len); | |
382ac6b3 GOC |
123 | void __lgread(struct lg_cpu *, void *, unsigned long, unsigned); |
124 | void __lgwrite(struct lg_cpu *, unsigned long, const void *, unsigned); | |
2d37f94a | 125 | |
2e04ef76 RR |
126 | /*H:035 |
127 | * Using memory-copy operations like that is usually inconvient, so we | |
2d37f94a RR |
128 | * have the following helper macros which read and write a specific type (often |
129 | * an unsigned long). | |
130 | * | |
2e04ef76 RR |
131 | * This reads into a variable of the given type then returns that. |
132 | */ | |
382ac6b3 GOC |
133 | #define lgread(cpu, addr, type) \ |
134 | ({ type _v; __lgread((cpu), &_v, (addr), sizeof(_v)); _v; }) | |
2d37f94a RR |
135 | |
136 | /* This checks that the variable is of the given type, then writes it out. */ | |
382ac6b3 | 137 | #define lgwrite(cpu, addr, type, val) \ |
2d37f94a RR |
138 | do { \ |
139 | typecheck(type, val); \ | |
382ac6b3 | 140 | __lgwrite((cpu), (addr), &(val), sizeof(val)); \ |
2d37f94a RR |
141 | } while(0) |
142 | /* (end of memory access helper routines) :*/ | |
143 | ||
d0953d42 | 144 | int run_guest(struct lg_cpu *cpu, unsigned long __user *user); |
d7e28ffe | 145 | |
2e04ef76 RR |
146 | /* |
147 | * Helper macros to obtain the first 12 or the last 20 bits, this is only the | |
df29f43e | 148 | * first step in the migration to the kernel types. pte_pfn is already defined |
2e04ef76 RR |
149 | * in the kernel. |
150 | */ | |
df29f43e | 151 | #define pgd_flags(x) (pgd_val(x) & ~PAGE_MASK) |
df29f43e | 152 | #define pgd_pfn(x) (pgd_val(x) >> PAGE_SHIFT) |
acdd0b62 MZ |
153 | #define pmd_flags(x) (pmd_val(x) & ~PAGE_MASK) |
154 | #define pmd_pfn(x) (pmd_val(x) >> PAGE_SHIFT) | |
d7e28ffe RR |
155 | |
156 | /* interrupts_and_traps.c: */ | |
a32a8813 RR |
157 | unsigned int interrupt_pending(struct lg_cpu *cpu, bool *more); |
158 | void try_deliver_interrupt(struct lg_cpu *cpu, unsigned int irq, bool more); | |
9f155a9b | 159 | void set_interrupt(struct lg_cpu *cpu, unsigned int irq); |
df1693ab | 160 | bool deliver_trap(struct lg_cpu *cpu, unsigned int num); |
fc708b3e GOC |
161 | void load_guest_idt_entry(struct lg_cpu *cpu, unsigned int i, |
162 | u32 low, u32 hi); | |
4665ac8e GOC |
163 | void guest_set_stack(struct lg_cpu *cpu, u32 seg, u32 esp, unsigned int pages); |
164 | void pin_stack_pages(struct lg_cpu *cpu); | |
d7e28ffe RR |
165 | void setup_default_idt_entries(struct lguest_ro_state *state, |
166 | const unsigned long *def); | |
fc708b3e | 167 | void copy_traps(const struct lg_cpu *cpu, struct desc_struct *idt, |
d7e28ffe | 168 | const unsigned long *def); |
ad8d8f3b | 169 | void guest_set_clockevent(struct lg_cpu *cpu, unsigned long delta); |
df60aeef | 170 | bool send_notify_to_eventfd(struct lg_cpu *cpu); |
ad8d8f3b | 171 | void init_clockdev(struct lg_cpu *cpu); |
c18acd73 RR |
172 | bool check_syscall_vector(struct lguest *lg); |
173 | int init_interrupts(void); | |
174 | void free_interrupts(void); | |
d7e28ffe RR |
175 | |
176 | /* segments.c: */ | |
177 | void setup_default_gdt_entries(struct lguest_ro_state *state); | |
fc708b3e | 178 | void setup_guest_gdt(struct lg_cpu *cpu); |
a489f0b5 RR |
179 | void load_guest_gdt_entry(struct lg_cpu *cpu, unsigned int i, |
180 | u32 low, u32 hi); | |
fc708b3e GOC |
181 | void guest_load_tls(struct lg_cpu *cpu, unsigned long tls_array); |
182 | void copy_gdt(const struct lg_cpu *cpu, struct desc_struct *gdt); | |
183 | void copy_gdt_tls(const struct lg_cpu *cpu, struct desc_struct *gdt); | |
d7e28ffe RR |
184 | |
185 | /* page_tables.c: */ | |
58a24566 | 186 | int init_guest_pagetable(struct lguest *lg); |
d7e28ffe | 187 | void free_guest_pagetable(struct lguest *lg); |
4665ac8e | 188 | void guest_new_pagetable(struct lg_cpu *cpu, unsigned long pgtable); |
ebe0ba84 | 189 | void guest_set_pgd(struct lguest *lg, unsigned long gpgdir, u32 i); |
acdd0b62 MZ |
190 | #ifdef CONFIG_X86_PAE |
191 | void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i); | |
192 | #endif | |
4665ac8e | 193 | void guest_pagetable_clear_all(struct lg_cpu *cpu); |
1713608f | 194 | void guest_pagetable_flush_user(struct lg_cpu *cpu); |
382ac6b3 | 195 | void guest_set_pte(struct lg_cpu *cpu, unsigned long gpgdir, |
df29f43e | 196 | unsigned long vaddr, pte_t val); |
0c78441c | 197 | void map_switcher_in_guest(struct lg_cpu *cpu, struct lguest_pages *pages); |
df1693ab | 198 | bool demand_page(struct lg_cpu *cpu, unsigned long cr2, int errcode); |
1713608f GOC |
199 | void pin_page(struct lg_cpu *cpu, unsigned long vaddr); |
200 | unsigned long guest_pa(struct lg_cpu *cpu, unsigned long vaddr); | |
382ac6b3 | 201 | void page_table_guest_data_init(struct lg_cpu *cpu); |
d7e28ffe | 202 | |
625efab1 JS |
203 | /* <arch>/core.c: */ |
204 | void lguest_arch_host_init(void); | |
205 | void lguest_arch_host_fini(void); | |
d0953d42 | 206 | void lguest_arch_run_guest(struct lg_cpu *cpu); |
73044f05 GOC |
207 | void lguest_arch_handle_trap(struct lg_cpu *cpu); |
208 | int lguest_arch_init_hypercalls(struct lg_cpu *cpu); | |
209 | int lguest_arch_do_hcall(struct lg_cpu *cpu, struct hcall_args *args); | |
a53a35a8 | 210 | void lguest_arch_setup_regs(struct lg_cpu *cpu, unsigned long start); |
625efab1 JS |
211 | |
212 | /* <arch>/switcher.S: */ | |
213 | extern char start_switcher_text[], end_switcher_text[], switch_to_guest[]; | |
214 | ||
d7e28ffe RR |
215 | /* lguest_user.c: */ |
216 | int lguest_device_init(void); | |
217 | void lguest_device_remove(void); | |
218 | ||
d7e28ffe | 219 | /* hypercalls.c: */ |
73044f05 | 220 | void do_hypercalls(struct lg_cpu *cpu); |
382ac6b3 | 221 | void write_timestamp(struct lg_cpu *cpu); |
d7e28ffe | 222 | |
dde79789 RR |
223 | /*L:035 |
224 | * Let's step aside for the moment, to study one important routine that's used | |
225 | * widely in the Host code. | |
226 | * | |
e1e72965 | 227 | * There are many cases where the Guest can do something invalid, like pass crap |
dde79789 RR |
228 | * to a hypercall. Since only the Guest kernel can make hypercalls, it's quite |
229 | * acceptable to simply terminate the Guest and give the Launcher a nicely | |
230 | * formatted reason. It's also simpler for the Guest itself, which doesn't | |
231 | * need to check most hypercalls for "success"; if you're still running, it | |
232 | * succeeded. | |
233 | * | |
234 | * Once this is called, the Guest will never run again, so most Host code can | |
235 | * call this then continue as if nothing had happened. This means many | |
236 | * functions don't have to explicitly return an error code, which keeps the | |
237 | * code simple. | |
238 | * | |
239 | * It also means that this can be called more than once: only the first one is | |
240 | * remembered. The only trick is that we still need to kill the Guest even if | |
241 | * we can't allocate memory to store the reason. Linux has a neat way of | |
242 | * packing error codes into invalid pointers, so we use that here. | |
243 | * | |
244 | * Like any macro which uses an "if", it is safely wrapped in a run-once "do { | |
245 | * } while(0)". | |
246 | */ | |
382ac6b3 | 247 | #define kill_guest(cpu, fmt...) \ |
d7e28ffe | 248 | do { \ |
382ac6b3 GOC |
249 | if (!(cpu)->lg->dead) { \ |
250 | (cpu)->lg->dead = kasprintf(GFP_ATOMIC, fmt); \ | |
251 | if (!(cpu)->lg->dead) \ | |
252 | (cpu)->lg->dead = ERR_PTR(-ENOMEM); \ | |
d7e28ffe RR |
253 | } \ |
254 | } while(0) | |
dde79789 | 255 | /* (End of aside) :*/ |
d7e28ffe | 256 | |
d7e28ffe RR |
257 | #endif /* __ASSEMBLY__ */ |
258 | #endif /* _LGUEST_H */ |