lguest: get rid of lg variable assignments
[linux-3.10.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 <asm/page.h>
27 #include <asm/pgtable.h>
28 #include "lg.h"
29
30 /*H:120 This is the core hypercall routine: where the Guest gets what it wants.
31  * Or gets killed.  Or, in the case of LHCALL_CRASH, both. */
32 static void do_hcall(struct lg_cpu *cpu, struct hcall_args *args)
33 {
34         switch (args->arg0) {
35         case LHCALL_FLUSH_ASYNC:
36                 /* This call does nothing, except by breaking out of the Guest
37                  * it makes us process all the asynchronous hypercalls. */
38                 break;
39         case LHCALL_LGUEST_INIT:
40                 /* You can't get here unless you're already initialized.  Don't
41                  * do that. */
42                 kill_guest(cpu, "already have lguest_data");
43                 break;
44         case LHCALL_SHUTDOWN: {
45                 /* Shutdown is such a trivial hypercall that we do it in four
46                  * lines right here. */
47                 char msg[128];
48                 /* If the lgread fails, it will call kill_guest() itself; the
49                  * kill_guest() with the message will be ignored. */
50                 __lgread(cpu, msg, args->arg1, sizeof(msg));
51                 msg[sizeof(msg)-1] = '\0';
52                 kill_guest(cpu, "CRASH: %s", msg);
53                 if (args->arg2 == LGUEST_SHUTDOWN_RESTART)
54                         cpu->lg->dead = ERR_PTR(-ERESTART);
55                 break;
56         }
57         case LHCALL_FLUSH_TLB:
58                 /* FLUSH_TLB comes in two flavors, depending on the
59                  * argument: */
60                 if (args->arg1)
61                         guest_pagetable_clear_all(cpu);
62                 else
63                         guest_pagetable_flush_user(cpu);
64                 break;
65
66         /* All these calls simply pass the arguments through to the right
67          * routines. */
68         case LHCALL_NEW_PGTABLE:
69                 guest_new_pagetable(cpu, args->arg1);
70                 break;
71         case LHCALL_SET_STACK:
72                 guest_set_stack(cpu, args->arg1, args->arg2, args->arg3);
73                 break;
74         case LHCALL_SET_PTE:
75                 guest_set_pte(cpu, args->arg1, args->arg2, __pte(args->arg3));
76                 break;
77         case LHCALL_SET_PMD:
78                 guest_set_pmd(cpu->lg, args->arg1, args->arg2);
79                 break;
80         case LHCALL_SET_CLOCKEVENT:
81                 guest_set_clockevent(cpu, args->arg1);
82                 break;
83         case LHCALL_TS:
84                 /* This sets the TS flag, as we saw used in run_guest(). */
85                 cpu->ts = args->arg1;
86                 break;
87         case LHCALL_HALT:
88                 /* Similarly, this sets the halted flag for run_guest(). */
89                 cpu->halted = 1;
90                 break;
91         case LHCALL_NOTIFY:
92                 cpu->pending_notify = args->arg1;
93                 break;
94         default:
95                 /* It should be an architecture-specific hypercall. */
96                 if (lguest_arch_do_hcall(cpu, args))
97                         kill_guest(cpu, "Bad hypercall %li\n", args->arg0);
98         }
99 }
100 /*:*/
101
102 /*H:124 Asynchronous hypercalls are easy: we just look in the array in the
103  * Guest's "struct lguest_data" to see if any new ones are marked "ready".
104  *
105  * We are careful to do these in order: obviously we respect the order the
106  * Guest put them in the ring, but we also promise the Guest that they will
107  * happen before any normal hypercall (which is why we check this before
108  * checking for a normal hcall). */
109 static void do_async_hcalls(struct lg_cpu *cpu)
110 {
111         unsigned int i;
112         u8 st[LHCALL_RING_SIZE];
113
114         /* For simplicity, we copy the entire call status array in at once. */
115         if (copy_from_user(&st, &cpu->lg->lguest_data->hcall_status, sizeof(st)))
116                 return;
117
118         /* We process "struct lguest_data"s hcalls[] ring once. */
119         for (i = 0; i < ARRAY_SIZE(st); i++) {
120                 struct hcall_args args;
121                 /* We remember where we were up to from last time.  This makes
122                  * sure that the hypercalls are done in the order the Guest
123                  * places them in the ring. */
124                 unsigned int n = cpu->next_hcall;
125
126                 /* 0xFF means there's no call here (yet). */
127                 if (st[n] == 0xFF)
128                         break;
129
130                 /* OK, we have hypercall.  Increment the "next_hcall" cursor,
131                  * and wrap back to 0 if we reach the end. */
132                 if (++cpu->next_hcall == LHCALL_RING_SIZE)
133                         cpu->next_hcall = 0;
134
135                 /* Copy the hypercall arguments into a local copy of
136                  * the hcall_args struct. */
137                 if (copy_from_user(&args, &cpu->lg->lguest_data->hcalls[n],
138                                    sizeof(struct hcall_args))) {
139                         kill_guest(cpu, "Fetching async hypercalls");
140                         break;
141                 }
142
143                 /* Do the hypercall, same as a normal one. */
144                 do_hcall(cpu, &args);
145
146                 /* Mark the hypercall done. */
147                 if (put_user(0xFF, &cpu->lg->lguest_data->hcall_status[n])) {
148                         kill_guest(cpu, "Writing result for async hypercall");
149                         break;
150                 }
151
152                 /* Stop doing hypercalls if they want to notify the Launcher:
153                  * it needs to service this first. */
154                 if (cpu->pending_notify)
155                         break;
156         }
157 }
158
159 /* Last of all, we look at what happens first of all.  The very first time the
160  * Guest makes a hypercall, we end up here to set things up: */
161 static void initialize(struct lg_cpu *cpu)
162 {
163         /* You can't do anything until you're initialized.  The Guest knows the
164          * rules, so we're unforgiving here. */
165         if (cpu->hcall->arg0 != LHCALL_LGUEST_INIT) {
166                 kill_guest(cpu, "hypercall %li before INIT", cpu->hcall->arg0);
167                 return;
168         }
169
170         if (lguest_arch_init_hypercalls(cpu))
171                 kill_guest(cpu, "bad guest page %p", cpu->lg->lguest_data);
172
173         /* The Guest tells us where we're not to deliver interrupts by putting
174          * the range of addresses into "struct lguest_data". */
175         if (get_user(cpu->lg->noirq_start, &cpu->lg->lguest_data->noirq_start)
176             || get_user(cpu->lg->noirq_end, &cpu->lg->lguest_data->noirq_end))
177                 kill_guest(cpu, "bad guest page %p", cpu->lg->lguest_data);
178
179         /* We write the current time into the Guest's data page once so it can
180          * set its clock. */
181         write_timestamp(cpu);
182
183         /* page_tables.c will also do some setup. */
184         page_table_guest_data_init(cpu);
185
186         /* This is the one case where the above accesses might have been the
187          * first write to a Guest page.  This may have caused a copy-on-write
188          * fault, but the old page might be (read-only) in the Guest
189          * pagetable. */
190         guest_pagetable_clear_all(cpu);
191 }
192
193 /*H:100
194  * Hypercalls
195  *
196  * Remember from the Guest, hypercalls come in two flavors: normal and
197  * asynchronous.  This file handles both of types.
198  */
199 void do_hypercalls(struct lg_cpu *cpu)
200 {
201         /* Not initialized yet?  This hypercall must do it. */
202         if (unlikely(!cpu->lg->lguest_data)) {
203                 /* Set up the "struct lguest_data" */
204                 initialize(cpu);
205                 /* Hcall is done. */
206                 cpu->hcall = NULL;
207                 return;
208         }
209
210         /* The Guest has initialized.
211          *
212          * Look in the hypercall ring for the async hypercalls: */
213         do_async_hcalls(cpu);
214
215         /* If we stopped reading the hypercall ring because the Guest did a
216          * NOTIFY to the Launcher, we want to return now.  Otherwise we do
217          * the hypercall. */
218         if (!cpu->pending_notify) {
219                 do_hcall(cpu, cpu->hcall);
220                 /* Tricky point: we reset the hcall pointer to mark the
221                  * hypercall as "done".  We use the hcall pointer rather than
222                  * the trap number to indicate a hypercall is pending.
223                  * Normally it doesn't matter: the Guest will run again and
224                  * update the trap number before we come back here.
225                  *
226                  * However, if we are signalled or the Guest sends I/O to the
227                  * Launcher, the run_guest() loop will exit without running the
228                  * Guest.  When it comes back it would try to re-run the
229                  * hypercall. */
230                 cpu->hcall = NULL;
231         }
232 }
233
234 /* This routine supplies the Guest with time: it's used for wallclock time at
235  * initial boot and as a rough time source if the TSC isn't available. */
236 void write_timestamp(struct lg_cpu *cpu)
237 {
238         struct timespec now;
239         ktime_get_real_ts(&now);
240         if (copy_to_user(&cpu->lg->lguest_data->time,
241                          &now, sizeof(struct timespec)))
242                 kill_guest(cpu, "Writing timestamp");
243 }