lguest: per-vcpu lguest pgdir management
[linux-2.6.git] / drivers / lguest / lg.h
1 #ifndef _LGUEST_H
2 #define _LGUEST_H
3
4 #ifndef __ASSEMBLY__
5 #include <linux/types.h>
6 #include <linux/init.h>
7 #include <linux/stringify.h>
8 #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>
13
14 #include <asm/lguest.h>
15
16 void free_pagetables(void);
17 int init_pagetables(struct page **switcher_page, unsigned int pages);
18
19 struct pgdir
20 {
21         unsigned long gpgdir;
22         pgd_t *pgdir;
23 };
24
25 /* We have two pages shared with guests, per cpu.  */
26 struct 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 struct lguest;
42
43 struct lg_cpu {
44         unsigned int id;
45         struct lguest *lg;
46         struct task_struct *tsk;
47         struct mm_struct *mm;   /* == tsk->mm, but that becomes NULL on exit */
48
49         u32 cr2;
50         int ts;
51         u32 esp1;
52         u8 ss1;
53
54         unsigned long pending_notify; /* pfn from LHCALL_NOTIFY */
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
60         int cpu_pgd; /* which pgd this cpu is currently using */
61
62         /* If a hypercall was asked for, this points to the arguments. */
63         struct hcall_args *hcall;
64         u32 next_hcall;
65
66         /* Virtual clock device */
67         struct hrtimer hrt;
68
69         /* Do we need to stop what we're doing and return to userspace? */
70         int break_out;
71         wait_queue_head_t break_wq;
72         int halted;
73
74         /* Pending virtual interrupts */
75         DECLARE_BITMAP(irqs_pending, LGUEST_IRQS);
76
77         struct lg_cpu_arch arch;
78 };
79
80 /* The private info the thread maintains about the guest. */
81 struct lguest
82 {
83         struct lguest_data __user *lguest_data;
84         struct lg_cpu cpus[NR_CPUS];
85         unsigned int nr_cpus;
86
87         u32 pfn_limit;
88         /* This provides the offset to the base of guest-physical
89          * memory in the Launcher. */
90         void __user *mem_base;
91         unsigned long kernel_address;
92
93         /* Bitmap of what has changed: see CHANGED_* above. */
94         int changed;
95         struct lguest_pages *last_pages;
96
97         struct pgdir pgdirs[4];
98
99         unsigned long noirq_start, noirq_end;
100
101         unsigned int stack_pages;
102         u32 tsc_khz;
103
104         /* Dead? */
105         const char *dead;
106 };
107
108 extern struct mutex lguest_lock;
109
110 /* core.c: */
111 int lguest_address_ok(const struct lguest *lg,
112                       unsigned long addr, unsigned long len);
113 void __lgread(struct lguest *, void *, unsigned long, unsigned);
114 void __lgwrite(struct lguest *, unsigned long, const void *, unsigned);
115
116 /*H:035 Using memory-copy operations like that is usually inconvient, so we
117  * have the following helper macros which read and write a specific type (often
118  * an unsigned long).
119  *
120  * This reads into a variable of the given type then returns that. */
121 #define lgread(lg, addr, type)                                          \
122         ({ type _v; __lgread((lg), &_v, (addr), sizeof(_v)); _v; })
123
124 /* This checks that the variable is of the given type, then writes it out. */
125 #define lgwrite(lg, addr, type, val)                            \
126         do {                                                    \
127                 typecheck(type, val);                           \
128                 __lgwrite((lg), (addr), &(val), sizeof(val));   \
129         } while(0)
130 /* (end of memory access helper routines) :*/
131
132 int run_guest(struct lg_cpu *cpu, unsigned long __user *user);
133
134 /* Helper macros to obtain the first 12 or the last 20 bits, this is only the
135  * first step in the migration to the kernel types.  pte_pfn is already defined
136  * in the kernel. */
137 #define pgd_flags(x)    (pgd_val(x) & ~PAGE_MASK)
138 #define pte_flags(x)    (pte_val(x) & ~PAGE_MASK)
139 #define pgd_pfn(x)      (pgd_val(x) >> PAGE_SHIFT)
140
141 /* interrupts_and_traps.c: */
142 void maybe_do_interrupt(struct lg_cpu *cpu);
143 int deliver_trap(struct lg_cpu *cpu, unsigned int num);
144 void load_guest_idt_entry(struct lg_cpu *cpu, unsigned int i,
145                           u32 low, u32 hi);
146 void guest_set_stack(struct lg_cpu *cpu, u32 seg, u32 esp, unsigned int pages);
147 void pin_stack_pages(struct lg_cpu *cpu);
148 void setup_default_idt_entries(struct lguest_ro_state *state,
149                                const unsigned long *def);
150 void copy_traps(const struct lg_cpu *cpu, struct desc_struct *idt,
151                 const unsigned long *def);
152 void guest_set_clockevent(struct lg_cpu *cpu, unsigned long delta);
153 void init_clockdev(struct lg_cpu *cpu);
154 bool check_syscall_vector(struct lguest *lg);
155 int init_interrupts(void);
156 void free_interrupts(void);
157
158 /* segments.c: */
159 void setup_default_gdt_entries(struct lguest_ro_state *state);
160 void setup_guest_gdt(struct lg_cpu *cpu);
161 void load_guest_gdt(struct lg_cpu *cpu, unsigned long table, u32 num);
162 void guest_load_tls(struct lg_cpu *cpu, unsigned long tls_array);
163 void copy_gdt(const struct lg_cpu *cpu, struct desc_struct *gdt);
164 void copy_gdt_tls(const struct lg_cpu *cpu, struct desc_struct *gdt);
165
166 /* page_tables.c: */
167 int init_guest_pagetable(struct lguest *lg, unsigned long pgtable);
168 void free_guest_pagetable(struct lguest *lg);
169 void guest_new_pagetable(struct lg_cpu *cpu, unsigned long pgtable);
170 void guest_set_pmd(struct lguest *lg, unsigned long gpgdir, u32 i);
171 void guest_pagetable_clear_all(struct lg_cpu *cpu);
172 void guest_pagetable_flush_user(struct lg_cpu *cpu);
173 void guest_set_pte(struct lguest *lg, unsigned long gpgdir,
174                    unsigned long vaddr, pte_t val);
175 void map_switcher_in_guest(struct lg_cpu *cpu, struct lguest_pages *pages);
176 int demand_page(struct lg_cpu *cpu, unsigned long cr2, int errcode);
177 void pin_page(struct lg_cpu *cpu, unsigned long vaddr);
178 unsigned long guest_pa(struct lg_cpu *cpu, unsigned long vaddr);
179 void page_table_guest_data_init(struct lguest *lg);
180
181 /* <arch>/core.c: */
182 void lguest_arch_host_init(void);
183 void lguest_arch_host_fini(void);
184 void lguest_arch_run_guest(struct lg_cpu *cpu);
185 void lguest_arch_handle_trap(struct lg_cpu *cpu);
186 int lguest_arch_init_hypercalls(struct lg_cpu *cpu);
187 int lguest_arch_do_hcall(struct lg_cpu *cpu, struct hcall_args *args);
188 void lguest_arch_setup_regs(struct lg_cpu *cpu, unsigned long start);
189
190 /* <arch>/switcher.S: */
191 extern char start_switcher_text[], end_switcher_text[], switch_to_guest[];
192
193 /* lguest_user.c: */
194 int lguest_device_init(void);
195 void lguest_device_remove(void);
196
197 /* hypercalls.c: */
198 void do_hypercalls(struct lg_cpu *cpu);
199 void write_timestamp(struct lguest *lg);
200
201 /*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  *
205  * There are many cases where the Guest can do something invalid, like pass crap
206  * 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  */
225 #define kill_guest(lg, fmt...)                                  \
226 do {                                                            \
227         if (!(lg)->dead) {                                      \
228                 (lg)->dead = kasprintf(GFP_ATOMIC, fmt);        \
229                 if (!(lg)->dead)                                \
230                         (lg)->dead = ERR_PTR(-ENOMEM);          \
231         }                                                       \
232 } while(0)
233 /* (End of aside) :*/
234
235 #endif  /* __ASSEMBLY__ */
236 #endif  /* _LGUEST_H */