84f85e23cca7a65a86b3ffa3647953373c5339b3
[linux-2.6.git] / drivers / lguest / lguest_device.c
1 /*P:050 Lguest guests use a very simple method to describe devices.  It's a
2  * series of device descriptors contained just above the top of normal
3  * memory.
4  *
5  * We use the standard "virtio" device infrastructure, which provides us with a
6  * console, a network and a block driver.  Each one expects some configuration
7  * information and a "virtqueue" mechanism to send and receive data. :*/
8 #include <linux/init.h>
9 #include <linux/bootmem.h>
10 #include <linux/lguest_launcher.h>
11 #include <linux/virtio.h>
12 #include <linux/virtio_config.h>
13 #include <linux/interrupt.h>
14 #include <linux/virtio_ring.h>
15 #include <linux/err.h>
16 #include <asm/io.h>
17 #include <asm/paravirt.h>
18 #include <asm/lguest_hcall.h>
19
20 /* The pointer to our (page) of device descriptions. */
21 static void *lguest_devices;
22
23 /* Unique numbering for lguest devices. */
24 static unsigned int dev_index;
25
26 /* For Guests, device memory can be used as normal memory, so we cast away the
27  * __iomem to quieten sparse. */
28 static inline void *lguest_map(unsigned long phys_addr, unsigned long pages)
29 {
30         return (__force void *)ioremap(phys_addr, PAGE_SIZE*pages);
31 }
32
33 static inline void lguest_unmap(void *addr)
34 {
35         iounmap((__force void __iomem *)addr);
36 }
37
38 /*D:100 Each lguest device is just a virtio device plus a pointer to its entry
39  * in the lguest_devices page. */
40 struct lguest_device {
41         struct virtio_device vdev;
42
43         /* The entry in the lguest_devices page for this device. */
44         struct lguest_device_desc *desc;
45 };
46
47 /* Since the virtio infrastructure hands us a pointer to the virtio_device all
48  * the time, it helps to have a curt macro to get a pointer to the struct
49  * lguest_device it's enclosed in.  */
50 #define to_lgdev(vdev) container_of(vdev, struct lguest_device, vdev)
51
52 /*D:130
53  * Device configurations
54  *
55  * The configuration information for a device consists of one or more
56  * virtqueues, a feature bitmaks, and some configuration bytes.  The
57  * configuration bytes don't really matter to us: the Launcher sets them up, and
58  * the driver will look at them during setup.
59  *
60  * A convenient routine to return the device's virtqueue config array:
61  * immediately after the descriptor. */
62 static struct lguest_vqconfig *lg_vq(const struct lguest_device_desc *desc)
63 {
64         return (void *)(desc + 1);
65 }
66
67 /* The features come immediately after the virtqueues. */
68 static u8 *lg_features(const struct lguest_device_desc *desc)
69 {
70         return (void *)(lg_vq(desc) + desc->num_vq);
71 }
72
73 /* The config space comes after the two feature bitmasks. */
74 static u8 *lg_config(const struct lguest_device_desc *desc)
75 {
76         return lg_features(desc) + desc->feature_len * 2;
77 }
78
79 /* The total size of the config page used by this device (incl. desc) */
80 static unsigned desc_size(const struct lguest_device_desc *desc)
81 {
82         return sizeof(*desc)
83                 + desc->num_vq * sizeof(struct lguest_vqconfig)
84                 + desc->feature_len * 2
85                 + desc->config_len;
86 }
87
88 /* This tests (and acknowleges) a feature bit. */
89 static bool lg_feature(struct virtio_device *vdev, unsigned fbit)
90 {
91         struct lguest_device_desc *desc = to_lgdev(vdev)->desc;
92         u8 *features;
93
94         /* Obviously if they ask for a feature off the end of our feature
95          * bitmap, it's not set. */
96         if (fbit / 8 > desc->feature_len)
97                 return false;
98
99         /* The feature bitmap comes after the virtqueues. */
100         features = lg_features(desc);
101         if (!(features[fbit / 8] & (1 << (fbit % 8))))
102                 return false;
103
104         /* We set the matching bit in the other half of the bitmap to tell the
105          * Host we want to use this feature.  We don't use this yet, but we
106          * could in future. */
107         features[desc->feature_len + fbit / 8] |= (1 << (fbit % 8));
108         return true;
109 }
110
111 /* Once they've found a field, getting a copy of it is easy. */
112 static void lg_get(struct virtio_device *vdev, unsigned int offset,
113                    void *buf, unsigned len)
114 {
115         struct lguest_device_desc *desc = to_lgdev(vdev)->desc;
116
117         /* Check they didn't ask for more than the length of the config! */
118         BUG_ON(offset + len > desc->config_len);
119         memcpy(buf, lg_config(desc) + offset, len);
120 }
121
122 /* Setting the contents is also trivial. */
123 static void lg_set(struct virtio_device *vdev, unsigned int offset,
124                    const void *buf, unsigned len)
125 {
126         struct lguest_device_desc *desc = to_lgdev(vdev)->desc;
127
128         /* Check they didn't ask for more than the length of the config! */
129         BUG_ON(offset + len > desc->config_len);
130         memcpy(lg_config(desc) + offset, buf, len);
131 }
132
133 /* The operations to get and set the status word just access the status field
134  * of the device descriptor. */
135 static u8 lg_get_status(struct virtio_device *vdev)
136 {
137         return to_lgdev(vdev)->desc->status;
138 }
139
140 static void lg_set_status(struct virtio_device *vdev, u8 status)
141 {
142         BUG_ON(!status);
143         to_lgdev(vdev)->desc->status = status;
144 }
145
146 /* To reset the device, we (ab)use the NOTIFY hypercall, with the descriptor
147  * address of the device.  The Host will zero the status and all the
148  * features. */
149 static void lg_reset(struct virtio_device *vdev)
150 {
151         unsigned long offset = (void *)to_lgdev(vdev)->desc - lguest_devices;
152
153         hcall(LHCALL_NOTIFY, (max_pfn<<PAGE_SHIFT) + offset, 0, 0);
154 }
155
156 /*
157  * Virtqueues
158  *
159  * The other piece of infrastructure virtio needs is a "virtqueue": a way of
160  * the Guest device registering buffers for the other side to read from or
161  * write into (ie. send and receive buffers).  Each device can have multiple
162  * virtqueues: for example the console driver uses one queue for sending and
163  * another for receiving.
164  *
165  * Fortunately for us, a very fast shared-memory-plus-descriptors virtqueue
166  * already exists in virtio_ring.c.  We just need to connect it up.
167  *
168  * We start with the information we need to keep about each virtqueue.
169  */
170
171 /*D:140 This is the information we remember about each virtqueue. */
172 struct lguest_vq_info
173 {
174         /* A copy of the information contained in the device config. */
175         struct lguest_vqconfig config;
176
177         /* The address where we mapped the virtio ring, so we can unmap it. */
178         void *pages;
179 };
180
181 /* When the virtio_ring code wants to prod the Host, it calls us here and we
182  * make a hypercall.  We hand the page number of the virtqueue so the Host
183  * knows which virtqueue we're talking about. */
184 static void lg_notify(struct virtqueue *vq)
185 {
186         /* We store our virtqueue information in the "priv" pointer of the
187          * virtqueue structure. */
188         struct lguest_vq_info *lvq = vq->priv;
189
190         hcall(LHCALL_NOTIFY, lvq->config.pfn << PAGE_SHIFT, 0, 0);
191 }
192
193 /* This routine finds the first virtqueue described in the configuration of
194  * this device and sets it up.
195  *
196  * This is kind of an ugly duckling.  It'd be nicer to have a standard
197  * representation of a virtqueue in the configuration space, but it seems that
198  * everyone wants to do it differently.  The KVM coders want the Guest to
199  * allocate its own pages and tell the Host where they are, but for lguest it's
200  * simpler for the Host to simply tell us where the pages are.
201  *
202  * So we provide devices with a "find virtqueue and set it up" function. */
203 static struct virtqueue *lg_find_vq(struct virtio_device *vdev,
204                                     unsigned index,
205                                     void (*callback)(struct virtqueue *vq))
206 {
207         struct lguest_device *ldev = to_lgdev(vdev);
208         struct lguest_vq_info *lvq;
209         struct virtqueue *vq;
210         int err;
211
212         /* We must have this many virtqueues. */
213         if (index >= ldev->desc->num_vq)
214                 return ERR_PTR(-ENOENT);
215
216         lvq = kmalloc(sizeof(*lvq), GFP_KERNEL);
217         if (!lvq)
218                 return ERR_PTR(-ENOMEM);
219
220         /* Make a copy of the "struct lguest_vqconfig" entry, which sits after
221          * the descriptor.  We need a copy because the config space might not
222          * be aligned correctly. */
223         memcpy(&lvq->config, lg_vq(ldev->desc)+index, sizeof(lvq->config));
224
225         printk("Mapping virtqueue %i addr %lx\n", index,
226                (unsigned long)lvq->config.pfn << PAGE_SHIFT);
227         /* Figure out how many pages the ring will take, and map that memory */
228         lvq->pages = lguest_map((unsigned long)lvq->config.pfn << PAGE_SHIFT,
229                                 DIV_ROUND_UP(vring_size(lvq->config.num,
230                                                         PAGE_SIZE),
231                                              PAGE_SIZE));
232         if (!lvq->pages) {
233                 err = -ENOMEM;
234                 goto free_lvq;
235         }
236
237         /* OK, tell virtio_ring.c to set up a virtqueue now we know its size
238          * and we've got a pointer to its pages. */
239         vq = vring_new_virtqueue(lvq->config.num, vdev, lvq->pages,
240                                  lg_notify, callback);
241         if (!vq) {
242                 err = -ENOMEM;
243                 goto unmap;
244         }
245
246         /* Tell the interrupt for this virtqueue to go to the virtio_ring
247          * interrupt handler. */
248         /* FIXME: We used to have a flag for the Host to tell us we could use
249          * the interrupt as a source of randomness: it'd be nice to have that
250          * back.. */
251         err = request_irq(lvq->config.irq, vring_interrupt, IRQF_SHARED,
252                           vdev->dev.bus_id, vq);
253         if (err)
254                 goto destroy_vring;
255
256         /* Last of all we hook up our 'struct lguest_vq_info" to the
257          * virtqueue's priv pointer. */
258         vq->priv = lvq;
259         return vq;
260
261 destroy_vring:
262         vring_del_virtqueue(vq);
263 unmap:
264         lguest_unmap(lvq->pages);
265 free_lvq:
266         kfree(lvq);
267         return ERR_PTR(err);
268 }
269 /*:*/
270
271 /* Cleaning up a virtqueue is easy */
272 static void lg_del_vq(struct virtqueue *vq)
273 {
274         struct lguest_vq_info *lvq = vq->priv;
275
276         /* Release the interrupt */
277         free_irq(lvq->config.irq, vq);
278         /* Tell virtio_ring.c to free the virtqueue. */
279         vring_del_virtqueue(vq);
280         /* Unmap the pages containing the ring. */
281         lguest_unmap(lvq->pages);
282         /* Free our own queue information. */
283         kfree(lvq);
284 }
285
286 /* The ops structure which hooks everything together. */
287 static struct virtio_config_ops lguest_config_ops = {
288         .feature = lg_feature,
289         .get = lg_get,
290         .set = lg_set,
291         .get_status = lg_get_status,
292         .set_status = lg_set_status,
293         .reset = lg_reset,
294         .find_vq = lg_find_vq,
295         .del_vq = lg_del_vq,
296 };
297
298 /* The root device for the lguest virtio devices.  This makes them appear as
299  * /sys/devices/lguest/0,1,2 not /sys/devices/0,1,2. */
300 static struct device lguest_root = {
301         .parent = NULL,
302         .bus_id = "lguest",
303 };
304
305 /*D:120 This is the core of the lguest bus: actually adding a new device.
306  * It's a separate function because it's neater that way, and because an
307  * earlier version of the code supported hotplug and unplug.  They were removed
308  * early on because they were never used.
309  *
310  * As Andrew Tridgell says, "Untested code is buggy code".
311  *
312  * It's worth reading this carefully: we start with a pointer to the new device
313  * descriptor in the "lguest_devices" page. */
314 static void add_lguest_device(struct lguest_device_desc *d)
315 {
316         struct lguest_device *ldev;
317
318         /* Start with zeroed memory; Linux's device layer seems to count on
319          * it. */
320         ldev = kzalloc(sizeof(*ldev), GFP_KERNEL);
321         if (!ldev) {
322                 printk(KERN_EMERG "Cannot allocate lguest dev %u\n",
323                        dev_index++);
324                 return;
325         }
326
327         /* This devices' parent is the lguest/ dir. */
328         ldev->vdev.dev.parent = &lguest_root;
329         /* We have a unique device index thanks to the dev_index counter. */
330         ldev->vdev.index = dev_index++;
331         /* The device type comes straight from the descriptor.  There's also a
332          * device vendor field in the virtio_device struct, which we leave as
333          * 0. */
334         ldev->vdev.id.device = d->type;
335         /* We have a simple set of routines for querying the device's
336          * configuration information and setting its status. */
337         ldev->vdev.config = &lguest_config_ops;
338         /* And we remember the device's descriptor for lguest_config_ops. */
339         ldev->desc = d;
340
341         /* register_virtio_device() sets up the generic fields for the struct
342          * virtio_device and calls device_register().  This makes the bus
343          * infrastructure look for a matching driver. */
344         if (register_virtio_device(&ldev->vdev) != 0) {
345                 printk(KERN_ERR "Failed to register lguest device %u\n",
346                        ldev->vdev.index);
347                 kfree(ldev);
348         }
349 }
350
351 /*D:110 scan_devices() simply iterates through the device page.  The type 0 is
352  * reserved to mean "end of devices". */
353 static void scan_devices(void)
354 {
355         unsigned int i;
356         struct lguest_device_desc *d;
357
358         /* We start at the page beginning, and skip over each entry. */
359         for (i = 0; i < PAGE_SIZE; i += desc_size(d)) {
360                 d = lguest_devices + i;
361
362                 /* Once we hit a zero, stop. */
363                 if (d->type == 0)
364                         break;
365
366                 printk("Device at %i has size %u\n", i, desc_size(d));
367                 add_lguest_device(d);
368         }
369 }
370
371 /*D:105 Fairly early in boot, lguest_devices_init() is called to set up the
372  * lguest device infrastructure.  We check that we are a Guest by checking
373  * pv_info.name: there are other ways of checking, but this seems most
374  * obvious to me.
375  *
376  * So we can access the "struct lguest_device_desc"s easily, we map that memory
377  * and store the pointer in the global "lguest_devices".  Then we register a
378  * root device from which all our devices will hang (this seems to be the
379  * correct sysfs incantation).
380  *
381  * Finally we call scan_devices() which adds all the devices found in the
382  * lguest_devices page. */
383 static int __init lguest_devices_init(void)
384 {
385         if (strcmp(pv_info.name, "lguest") != 0)
386                 return 0;
387
388         if (device_register(&lguest_root) != 0)
389                 panic("Could not register lguest root");
390
391         /* Devices are in a single page above top of "normal" mem */
392         lguest_devices = lguest_map(max_pfn<<PAGE_SHIFT, 1);
393
394         scan_devices();
395         return 0;
396 }
397 /* We do this after core stuff, but before the drivers. */
398 postcore_initcall(lguest_devices_init);
399
400 /*D:150 At this point in the journey we used to now wade through the lguest
401  * devices themselves: net, block and console.  Since they're all now virtio
402  * devices rather than lguest-specific, I've decided to ignore them.  Mostly,
403  * they're kind of boring.  But this does mean you'll never experience the
404  * thrill of reading the forbidden love scene buried deep in the block driver.
405  *
406  * "make Launcher" beckons, where we answer questions like "Where do Guests
407  * come from?", and "What do you do when someone asks for optimization?". */