51149ca1461751b76992f7a6a5c2e6e5ff578906
[linux-2.6.git] / drivers / lguest / hypercalls.c
1 /*P:500 Just as userspace programs request kernel operations through a system
2  * call, the Guest requests Host operations through a "hypercall".  You might
3  * notice this nomenclature doesn't really follow any logic, but the name has
4  * been around for long enough that we're stuck with it.  As you'd expect, this
5  * code is basically a one big switch statement. :*/
6
7 /*  Copyright (C) 2006 Rusty Russell IBM Corporation
8
9     This program is free software; you can redistribute it and/or modify
10     it under the terms of the GNU General Public License as published by
11     the Free Software Foundation; either version 2 of the License, or
12     (at your option) any later version.
13
14     This program is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17     GNU General Public License for more details.
18
19     You should have received a copy of the GNU General Public License
20     along with this program; if not, write to the Free Software
21     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
22 */
23 #include <linux/uaccess.h>
24 #include <linux/syscalls.h>
25 #include <linux/mm.h>
26 #include <linux/ktime.h>
27 #include <asm/page.h>
28 #include <asm/pgtable.h>
29 #include "lg.h"
30
31 /*H:120 This is the core hypercall routine: where the Guest gets what it wants.
32  * Or gets killed.  Or, in the case of LHCALL_SHUTDOWN, both. */
33 static void do_hcall(struct lg_cpu *cpu, struct hcall_args *args)
34 {
35         switch (args->arg0) {
36         case LHCALL_FLUSH_ASYNC:
37                 /* This call does nothing, except by breaking out of the Guest
38                  * it makes us process all the asynchronous hypercalls. */
39                 break;
40         case LHCALL_SEND_INTERRUPTS:
41                 /* This call does nothing too, but by breaking out of the Guest
42                  * it makes us process any pending interrupts. */
43                 break;
44         case LHCALL_LGUEST_INIT:
45                 /* You can't get here unless you're already initialized.  Don't
46                  * do that. */
47                 kill_guest(cpu, "already have lguest_data");
48                 break;
49         case LHCALL_SHUTDOWN: {
50                 /* Shutdown is such a trivial hypercall that we do it in four
51                  * lines right here. */
52                 char msg[128];
53                 /* If the lgread fails, it will call kill_guest() itself; the
54                  * kill_guest() with the message will be ignored. */
55                 __lgread(cpu, msg, args->arg1, sizeof(msg));
56                 msg[sizeof(msg)-1] = '\0';
57                 kill_guest(cpu, "CRASH: %s", msg);
58                 if (args->arg2 == LGUEST_SHUTDOWN_RESTART)
59                         cpu->lg->dead = ERR_PTR(-ERESTART);
60                 break;
61         }
62         case LHCALL_FLUSH_TLB:
63                 /* FLUSH_TLB comes in two flavors, depending on the
64                  * argument: */
65                 if (args->arg1)
66                         guest_pagetable_clear_all(cpu);
67                 else
68                         guest_pagetable_flush_user(cpu);
69                 break;
70
71         /* All these calls simply pass the arguments through to the right
72          * routines. */
73         case LHCALL_NEW_PGTABLE:
74                 guest_new_pagetable(cpu, args->arg1);
75                 break;
76         case LHCALL_SET_STACK:
77                 guest_set_stack(cpu, args->arg1, args->arg2, args->arg3);
78                 break;
79         case LHCALL_SET_PTE:
80                 guest_set_pte(cpu, args->arg1, args->arg2, __pte(args->arg3));
81                 break;
82         case LHCALL_SET_PGD:
83                 guest_set_pgd(cpu->lg, args->arg1, args->arg2);
84                 break;
85         case LHCALL_SET_CLOCKEVENT:
86                 guest_set_clockevent(cpu, args->arg1);
87                 break;
88         case LHCALL_TS:
89                 /* This sets the TS flag, as we saw used in run_guest(). */
90                 cpu->ts = args->arg1;
91                 break;
92         case LHCALL_HALT:
93                 /* Similarly, this sets the halted flag for run_guest(). */
94                 cpu->halted = 1;
95                 break;
96         case LHCALL_NOTIFY:
97                 cpu->pending_notify = args->arg1;
98                 break;
99         default:
100                 /* It should be an architecture-specific hypercall. */
101                 if (lguest_arch_do_hcall(cpu, args))
102                         kill_guest(cpu, "Bad hypercall %li\n", args->arg0);
103         }
104 }
105 /*:*/
106
107 /*H:124 Asynchronous hypercalls are easy: we just look in the array in the
108  * Guest's "struct lguest_data" to see if any new ones are marked "ready".
109  *
110  * We are careful to do these in order: obviously we respect the order the
111  * Guest put them in the ring, but we also promise the Guest that they will
112  * happen before any normal hypercall (which is why we check this before
113  * checking for a normal hcall). */
114 static void do_async_hcalls(struct lg_cpu *cpu)
115 {
116         unsigned int i;
117         u8 st[LHCALL_RING_SIZE];
118
119         /* For simplicity, we copy the entire call status array in at once. */
120         if (copy_from_user(&st, &cpu->lg->lguest_data->hcall_status, sizeof(st)))
121                 return;
122
123         /* We process "struct lguest_data"s hcalls[] ring once. */
124         for (i = 0; i < ARRAY_SIZE(st); i++) {
125                 struct hcall_args args;
126                 /* We remember where we were up to from last time.  This makes
127                  * sure that the hypercalls are done in the order the Guest
128                  * places them in the ring. */
129                 unsigned int n = cpu->next_hcall;
130
131                 /* 0xFF means there's no call here (yet). */
132                 if (st[n] == 0xFF)
133                         break;
134
135                 /* OK, we have hypercall.  Increment the "next_hcall" cursor,
136                  * and wrap back to 0 if we reach the end. */
137                 if (++cpu->next_hcall == LHCALL_RING_SIZE)
138                         cpu->next_hcall = 0;
139
140                 /* Copy the hypercall arguments into a local copy of
141                  * the hcall_args struct. */
142                 if (copy_from_user(&args, &cpu->lg->lguest_data->hcalls[n],
143                                    sizeof(struct hcall_args))) {
144                         kill_guest(cpu, "Fetching async hypercalls");
145                         break;
146                 }
147
148                 /* Do the hypercall, same as a normal one. */
149                 do_hcall(cpu, &args);
150
151                 /* Mark the hypercall done. */
152                 if (put_user(0xFF, &cpu->lg->lguest_data->hcall_status[n])) {
153                         kill_guest(cpu, "Writing result for async hypercall");
154                         break;
155                 }
156
157                 /* Stop doing hypercalls if they want to notify the Launcher:
158                  * it needs to service this first. */
159                 if (cpu->pending_notify)
160                         break;
161         }
162 }
163
164 /* Last of all, we look at what happens first of all.  The very first time the
165  * Guest makes a hypercall, we end up here to set things up: */
166 static void initialize(struct lg_cpu *cpu)
167 {
168         /* You can't do anything until you're initialized.  The Guest knows the
169          * rules, so we're unforgiving here. */
170         if (cpu->hcall->arg0 != LHCALL_LGUEST_INIT) {
171                 kill_guest(cpu, "hypercall %li before INIT", cpu->hcall->arg0);
172                 return;
173         }
174
175         if (lguest_arch_init_hypercalls(cpu))
176                 kill_guest(cpu, "bad guest page %p", cpu->lg->lguest_data);
177
178         /* The Guest tells us where we're not to deliver interrupts by putting
179          * the range of addresses into "struct lguest_data". */
180         if (get_user(cpu->lg->noirq_start, &cpu->lg->lguest_data->noirq_start)
181             || get_user(cpu->lg->noirq_end, &cpu->lg->lguest_data->noirq_end))
182                 kill_guest(cpu, "bad guest page %p", cpu->lg->lguest_data);
183
184         /* We write the current time into the Guest's data page once so it can
185          * set its clock. */
186         write_timestamp(cpu);
187
188         /* page_tables.c will also do some setup. */
189         page_table_guest_data_init(cpu);
190
191         /* This is the one case where the above accesses might have been the
192          * first write to a Guest page.  This may have caused a copy-on-write
193          * fault, but the old page might be (read-only) in the Guest
194          * pagetable. */
195         guest_pagetable_clear_all(cpu);
196 }
197 /*:*/
198
199 /*M:013 If a Guest reads from a page (so creates a mapping) that it has never
200  * written to, and then the Launcher writes to it (ie. the output of a virtual
201  * device), the Guest will still see the old page.  In practice, this never
202  * happens: why would the Guest read a page which it has never written to?  But
203  * a similar scenario might one day bite us, so it's worth mentioning. :*/
204
205 /*H:100
206  * Hypercalls
207  *
208  * Remember from the Guest, hypercalls come in two flavors: normal and
209  * asynchronous.  This file handles both of types.
210  */
211 void do_hypercalls(struct lg_cpu *cpu)
212 {
213         /* Not initialized yet?  This hypercall must do it. */
214         if (unlikely(!cpu->lg->lguest_data)) {
215                 /* Set up the "struct lguest_data" */
216                 initialize(cpu);
217                 /* Hcall is done. */
218                 cpu->hcall = NULL;
219                 return;
220         }
221
222         /* The Guest has initialized.
223          *
224          * Look in the hypercall ring for the async hypercalls: */
225         do_async_hcalls(cpu);
226
227         /* If we stopped reading the hypercall ring because the Guest did a
228          * NOTIFY to the Launcher, we want to return now.  Otherwise we do
229          * the hypercall. */
230         if (!cpu->pending_notify) {
231                 do_hcall(cpu, cpu->hcall);
232                 /* Tricky point: we reset the hcall pointer to mark the
233                  * hypercall as "done".  We use the hcall pointer rather than
234                  * the trap number to indicate a hypercall is pending.
235                  * Normally it doesn't matter: the Guest will run again and
236                  * update the trap number before we come back here.
237                  *
238                  * However, if we are signalled or the Guest sends I/O to the
239                  * Launcher, the run_guest() loop will exit without running the
240                  * Guest.  When it comes back it would try to re-run the
241                  * hypercall.  Finding that bug sucked. */
242                 cpu->hcall = NULL;
243         }
244 }
245
246 /* This routine supplies the Guest with time: it's used for wallclock time at
247  * initial boot and as a rough time source if the TSC isn't available. */
248 void write_timestamp(struct lg_cpu *cpu)
249 {
250         struct timespec now;
251         ktime_get_real_ts(&now);
252         if (copy_to_user(&cpu->lg->lguest_data->time,
253                          &now, sizeof(struct timespec)))
254                 kill_guest(cpu, "Writing timestamp");
255 }