virtio_console: Add support for remoteproc serial
[linux-3.10.git] / drivers / virtio / virtio_balloon.c
1 /*
2  * Virtio balloon implementation, inspired by Dor Laor and Marcelo
3  * Tosatti's implementations.
4  *
5  *  Copyright 2008 Rusty Russell IBM Corporation
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #include <linux/virtio.h>
23 #include <linux/virtio_balloon.h>
24 #include <linux/swap.h>
25 #include <linux/kthread.h>
26 #include <linux/freezer.h>
27 #include <linux/delay.h>
28 #include <linux/slab.h>
29 #include <linux/module.h>
30
31 /*
32  * Balloon device works in 4K page units.  So each page is pointed to by
33  * multiple balloon pages.  All memory counters in this driver are in balloon
34  * page units.
35  */
36 #define VIRTIO_BALLOON_PAGES_PER_PAGE (PAGE_SIZE >> VIRTIO_BALLOON_PFN_SHIFT)
37
38 struct virtio_balloon
39 {
40         struct virtio_device *vdev;
41         struct virtqueue *inflate_vq, *deflate_vq, *stats_vq;
42
43         /* Where the ballooning thread waits for config to change. */
44         wait_queue_head_t config_change;
45
46         /* The thread servicing the balloon. */
47         struct task_struct *thread;
48
49         /* Waiting for host to ack the pages we released. */
50         wait_queue_head_t acked;
51
52         /* Number of balloon pages we've told the Host we're not using. */
53         unsigned int num_pages;
54         /*
55          * The pages we've told the Host we're not using.
56          * Each page on this list adds VIRTIO_BALLOON_PAGES_PER_PAGE
57          * to num_pages above.
58          */
59         struct list_head pages;
60
61         /* The array of pfns we tell the Host about. */
62         unsigned int num_pfns;
63         u32 pfns[256];
64
65         /* Memory statistics */
66         int need_stats_update;
67         struct virtio_balloon_stat stats[VIRTIO_BALLOON_S_NR];
68 };
69
70 static struct virtio_device_id id_table[] = {
71         { VIRTIO_ID_BALLOON, VIRTIO_DEV_ANY_ID },
72         { 0 },
73 };
74
75 static u32 page_to_balloon_pfn(struct page *page)
76 {
77         unsigned long pfn = page_to_pfn(page);
78
79         BUILD_BUG_ON(PAGE_SHIFT < VIRTIO_BALLOON_PFN_SHIFT);
80         /* Convert pfn from Linux page size to balloon page size. */
81         return pfn * VIRTIO_BALLOON_PAGES_PER_PAGE;
82 }
83
84 static struct page *balloon_pfn_to_page(u32 pfn)
85 {
86         BUG_ON(pfn % VIRTIO_BALLOON_PAGES_PER_PAGE);
87         return pfn_to_page(pfn / VIRTIO_BALLOON_PAGES_PER_PAGE);
88 }
89
90 static void balloon_ack(struct virtqueue *vq)
91 {
92         struct virtio_balloon *vb = vq->vdev->priv;
93
94         wake_up(&vb->acked);
95 }
96
97 static void tell_host(struct virtio_balloon *vb, struct virtqueue *vq)
98 {
99         struct scatterlist sg;
100         unsigned int len;
101
102         sg_init_one(&sg, vb->pfns, sizeof(vb->pfns[0]) * vb->num_pfns);
103
104         /* We should always be able to add one buffer to an empty queue. */
105         if (virtqueue_add_buf(vq, &sg, 1, 0, vb, GFP_KERNEL) < 0)
106                 BUG();
107         virtqueue_kick(vq);
108
109         /* When host has read buffer, this completes via balloon_ack */
110         wait_event(vb->acked, virtqueue_get_buf(vq, &len));
111 }
112
113 static void set_page_pfns(u32 pfns[], struct page *page)
114 {
115         unsigned int i;
116
117         /* Set balloon pfns pointing at this page.
118          * Note that the first pfn points at start of the page. */
119         for (i = 0; i < VIRTIO_BALLOON_PAGES_PER_PAGE; i++)
120                 pfns[i] = page_to_balloon_pfn(page) + i;
121 }
122
123 static void fill_balloon(struct virtio_balloon *vb, size_t num)
124 {
125         /* We can only do one array worth at a time. */
126         num = min(num, ARRAY_SIZE(vb->pfns));
127
128         for (vb->num_pfns = 0; vb->num_pfns < num;
129              vb->num_pfns += VIRTIO_BALLOON_PAGES_PER_PAGE) {
130                 struct page *page = alloc_page(GFP_HIGHUSER | __GFP_NORETRY |
131                                         __GFP_NOMEMALLOC | __GFP_NOWARN);
132                 if (!page) {
133                         dev_info_ratelimited(&vb->vdev->dev,
134                                              "Out of puff! Can't get %zu pages\n",
135                                              num);
136                         /* Sleep for at least 1/5 of a second before retry. */
137                         msleep(200);
138                         break;
139                 }
140                 set_page_pfns(vb->pfns + vb->num_pfns, page);
141                 vb->num_pages += VIRTIO_BALLOON_PAGES_PER_PAGE;
142                 totalram_pages--;
143                 list_add(&page->lru, &vb->pages);
144         }
145
146         /* Didn't get any?  Oh well. */
147         if (vb->num_pfns == 0)
148                 return;
149
150         tell_host(vb, vb->inflate_vq);
151 }
152
153 static void release_pages_by_pfn(const u32 pfns[], unsigned int num)
154 {
155         unsigned int i;
156
157         /* Find pfns pointing at start of each page, get pages and free them. */
158         for (i = 0; i < num; i += VIRTIO_BALLOON_PAGES_PER_PAGE) {
159                 __free_page(balloon_pfn_to_page(pfns[i]));
160                 totalram_pages++;
161         }
162 }
163
164 static void leak_balloon(struct virtio_balloon *vb, size_t num)
165 {
166         struct page *page;
167
168         /* We can only do one array worth at a time. */
169         num = min(num, ARRAY_SIZE(vb->pfns));
170
171         for (vb->num_pfns = 0; vb->num_pfns < num;
172              vb->num_pfns += VIRTIO_BALLOON_PAGES_PER_PAGE) {
173                 page = list_first_entry(&vb->pages, struct page, lru);
174                 list_del(&page->lru);
175                 set_page_pfns(vb->pfns + vb->num_pfns, page);
176                 vb->num_pages -= VIRTIO_BALLOON_PAGES_PER_PAGE;
177         }
178
179         /*
180          * Note that if
181          * virtio_has_feature(vdev, VIRTIO_BALLOON_F_MUST_TELL_HOST);
182          * is true, we *have* to do it in this order
183          */
184         tell_host(vb, vb->deflate_vq);
185         release_pages_by_pfn(vb->pfns, vb->num_pfns);
186 }
187
188 static inline void update_stat(struct virtio_balloon *vb, int idx,
189                                u16 tag, u64 val)
190 {
191         BUG_ON(idx >= VIRTIO_BALLOON_S_NR);
192         vb->stats[idx].tag = tag;
193         vb->stats[idx].val = val;
194 }
195
196 #define pages_to_bytes(x) ((u64)(x) << PAGE_SHIFT)
197
198 static void update_balloon_stats(struct virtio_balloon *vb)
199 {
200         unsigned long events[NR_VM_EVENT_ITEMS];
201         struct sysinfo i;
202         int idx = 0;
203
204         all_vm_events(events);
205         si_meminfo(&i);
206
207         update_stat(vb, idx++, VIRTIO_BALLOON_S_SWAP_IN,
208                                 pages_to_bytes(events[PSWPIN]));
209         update_stat(vb, idx++, VIRTIO_BALLOON_S_SWAP_OUT,
210                                 pages_to_bytes(events[PSWPOUT]));
211         update_stat(vb, idx++, VIRTIO_BALLOON_S_MAJFLT, events[PGMAJFAULT]);
212         update_stat(vb, idx++, VIRTIO_BALLOON_S_MINFLT, events[PGFAULT]);
213         update_stat(vb, idx++, VIRTIO_BALLOON_S_MEMFREE,
214                                 pages_to_bytes(i.freeram));
215         update_stat(vb, idx++, VIRTIO_BALLOON_S_MEMTOT,
216                                 pages_to_bytes(i.totalram));
217 }
218
219 /*
220  * While most virtqueues communicate guest-initiated requests to the hypervisor,
221  * the stats queue operates in reverse.  The driver initializes the virtqueue
222  * with a single buffer.  From that point forward, all conversations consist of
223  * a hypervisor request (a call to this function) which directs us to refill
224  * the virtqueue with a fresh stats buffer.  Since stats collection can sleep,
225  * we notify our kthread which does the actual work via stats_handle_request().
226  */
227 static void stats_request(struct virtqueue *vq)
228 {
229         struct virtio_balloon *vb = vq->vdev->priv;
230
231         vb->need_stats_update = 1;
232         wake_up(&vb->config_change);
233 }
234
235 static void stats_handle_request(struct virtio_balloon *vb)
236 {
237         struct virtqueue *vq;
238         struct scatterlist sg;
239         unsigned int len;
240
241         vb->need_stats_update = 0;
242         update_balloon_stats(vb);
243
244         vq = vb->stats_vq;
245         if (!virtqueue_get_buf(vq, &len))
246                 return;
247         sg_init_one(&sg, vb->stats, sizeof(vb->stats));
248         if (virtqueue_add_buf(vq, &sg, 1, 0, vb, GFP_KERNEL) < 0)
249                 BUG();
250         virtqueue_kick(vq);
251 }
252
253 static void virtballoon_changed(struct virtio_device *vdev)
254 {
255         struct virtio_balloon *vb = vdev->priv;
256
257         wake_up(&vb->config_change);
258 }
259
260 static inline s64 towards_target(struct virtio_balloon *vb)
261 {
262         __le32 v;
263         s64 target;
264
265         vb->vdev->config->get(vb->vdev,
266                               offsetof(struct virtio_balloon_config, num_pages),
267                               &v, sizeof(v));
268         target = le32_to_cpu(v);
269         return target - vb->num_pages;
270 }
271
272 static void update_balloon_size(struct virtio_balloon *vb)
273 {
274         __le32 actual = cpu_to_le32(vb->num_pages);
275
276         vb->vdev->config->set(vb->vdev,
277                               offsetof(struct virtio_balloon_config, actual),
278                               &actual, sizeof(actual));
279 }
280
281 static int balloon(void *_vballoon)
282 {
283         struct virtio_balloon *vb = _vballoon;
284
285         set_freezable();
286         while (!kthread_should_stop()) {
287                 s64 diff;
288
289                 try_to_freeze();
290                 wait_event_interruptible(vb->config_change,
291                                          (diff = towards_target(vb)) != 0
292                                          || vb->need_stats_update
293                                          || kthread_should_stop()
294                                          || freezing(current));
295                 if (vb->need_stats_update)
296                         stats_handle_request(vb);
297                 if (diff > 0)
298                         fill_balloon(vb, diff);
299                 else if (diff < 0)
300                         leak_balloon(vb, -diff);
301                 update_balloon_size(vb);
302         }
303         return 0;
304 }
305
306 static int init_vqs(struct virtio_balloon *vb)
307 {
308         struct virtqueue *vqs[3];
309         vq_callback_t *callbacks[] = { balloon_ack, balloon_ack, stats_request };
310         const char *names[] = { "inflate", "deflate", "stats" };
311         int err, nvqs;
312
313         /*
314          * We expect two virtqueues: inflate and deflate, and
315          * optionally stat.
316          */
317         nvqs = virtio_has_feature(vb->vdev, VIRTIO_BALLOON_F_STATS_VQ) ? 3 : 2;
318         err = vb->vdev->config->find_vqs(vb->vdev, nvqs, vqs, callbacks, names);
319         if (err)
320                 return err;
321
322         vb->inflate_vq = vqs[0];
323         vb->deflate_vq = vqs[1];
324         if (virtio_has_feature(vb->vdev, VIRTIO_BALLOON_F_STATS_VQ)) {
325                 struct scatterlist sg;
326                 vb->stats_vq = vqs[2];
327
328                 /*
329                  * Prime this virtqueue with one buffer so the hypervisor can
330                  * use it to signal us later.
331                  */
332                 sg_init_one(&sg, vb->stats, sizeof vb->stats);
333                 if (virtqueue_add_buf(vb->stats_vq, &sg, 1, 0, vb, GFP_KERNEL)
334                     < 0)
335                         BUG();
336                 virtqueue_kick(vb->stats_vq);
337         }
338         return 0;
339 }
340
341 static int virtballoon_probe(struct virtio_device *vdev)
342 {
343         struct virtio_balloon *vb;
344         int err;
345
346         vdev->priv = vb = kmalloc(sizeof(*vb), GFP_KERNEL);
347         if (!vb) {
348                 err = -ENOMEM;
349                 goto out;
350         }
351
352         INIT_LIST_HEAD(&vb->pages);
353         vb->num_pages = 0;
354         init_waitqueue_head(&vb->config_change);
355         init_waitqueue_head(&vb->acked);
356         vb->vdev = vdev;
357         vb->need_stats_update = 0;
358
359         err = init_vqs(vb);
360         if (err)
361                 goto out_free_vb;
362
363         vb->thread = kthread_run(balloon, vb, "vballoon");
364         if (IS_ERR(vb->thread)) {
365                 err = PTR_ERR(vb->thread);
366                 goto out_del_vqs;
367         }
368
369         return 0;
370
371 out_del_vqs:
372         vdev->config->del_vqs(vdev);
373 out_free_vb:
374         kfree(vb);
375 out:
376         return err;
377 }
378
379 static void remove_common(struct virtio_balloon *vb)
380 {
381         /* There might be pages left in the balloon: free them. */
382         while (vb->num_pages)
383                 leak_balloon(vb, vb->num_pages);
384         update_balloon_size(vb);
385
386         /* Now we reset the device so we can clean up the queues. */
387         vb->vdev->config->reset(vb->vdev);
388
389         vb->vdev->config->del_vqs(vb->vdev);
390 }
391
392 static void __devexit virtballoon_remove(struct virtio_device *vdev)
393 {
394         struct virtio_balloon *vb = vdev->priv;
395
396         kthread_stop(vb->thread);
397         remove_common(vb);
398         kfree(vb);
399 }
400
401 #ifdef CONFIG_PM
402 static int virtballoon_freeze(struct virtio_device *vdev)
403 {
404         struct virtio_balloon *vb = vdev->priv;
405
406         /*
407          * The kthread is already frozen by the PM core before this
408          * function is called.
409          */
410
411         remove_common(vb);
412         return 0;
413 }
414
415 static int virtballoon_restore(struct virtio_device *vdev)
416 {
417         struct virtio_balloon *vb = vdev->priv;
418         int ret;
419
420         ret = init_vqs(vdev->priv);
421         if (ret)
422                 return ret;
423
424         fill_balloon(vb, towards_target(vb));
425         update_balloon_size(vb);
426         return 0;
427 }
428 #endif
429
430 static unsigned int features[] = {
431         VIRTIO_BALLOON_F_MUST_TELL_HOST,
432         VIRTIO_BALLOON_F_STATS_VQ,
433 };
434
435 static struct virtio_driver virtio_balloon_driver = {
436         .feature_table = features,
437         .feature_table_size = ARRAY_SIZE(features),
438         .driver.name =  KBUILD_MODNAME,
439         .driver.owner = THIS_MODULE,
440         .id_table =     id_table,
441         .probe =        virtballoon_probe,
442         .remove =       __devexit_p(virtballoon_remove),
443         .config_changed = virtballoon_changed,
444 #ifdef CONFIG_PM
445         .freeze =       virtballoon_freeze,
446         .restore =      virtballoon_restore,
447 #endif
448 };
449
450 static int __init init(void)
451 {
452         return register_virtio_driver(&virtio_balloon_driver);
453 }
454
455 static void __exit fini(void)
456 {
457         unregister_virtio_driver(&virtio_balloon_driver);
458 }
459 module_init(init);
460 module_exit(fini);
461
462 MODULE_DEVICE_TABLE(virtio, id_table);
463 MODULE_DESCRIPTION("Virtio balloon driver");
464 MODULE_LICENSE("GPL");