virtio_balloon: Use a workqueue instead of "vballoon" kthread
[cascardo/linux.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/workqueue.h>
26 #include <linux/delay.h>
27 #include <linux/slab.h>
28 #include <linux/module.h>
29 #include <linux/balloon_compaction.h>
30 #include <linux/oom.h>
31 #include <linux/wait.h>
32
33 /*
34  * Balloon device works in 4K page units.  So each page is pointed to by
35  * multiple balloon pages.  All memory counters in this driver are in balloon
36  * page units.
37  */
38 #define VIRTIO_BALLOON_PAGES_PER_PAGE (unsigned)(PAGE_SIZE >> VIRTIO_BALLOON_PFN_SHIFT)
39 #define VIRTIO_BALLOON_ARRAY_PFNS_MAX 256
40 #define OOM_VBALLOON_DEFAULT_PAGES 256
41 #define VIRTBALLOON_OOM_NOTIFY_PRIORITY 80
42
43 static int oom_pages = OOM_VBALLOON_DEFAULT_PAGES;
44 module_param(oom_pages, int, S_IRUSR | S_IWUSR);
45 MODULE_PARM_DESC(oom_pages, "pages to free on OOM");
46
47 struct virtio_balloon {
48         struct virtio_device *vdev;
49         struct virtqueue *inflate_vq, *deflate_vq, *stats_vq;
50
51         /* The balloon servicing is delegated to a freezable workqueue. */
52         struct work_struct work;
53
54         /* Prevent updating balloon when it is being canceled. */
55         spinlock_t stop_update_lock;
56         bool stop_update;
57
58         /* Waiting for host to ack the pages we released. */
59         wait_queue_head_t acked;
60
61         /* Number of balloon pages we've told the Host we're not using. */
62         unsigned int num_pages;
63         /*
64          * The pages we've told the Host we're not using are enqueued
65          * at vb_dev_info->pages list.
66          * Each page on this list adds VIRTIO_BALLOON_PAGES_PER_PAGE
67          * to num_pages above.
68          */
69         struct balloon_dev_info vb_dev_info;
70
71         /* Synchronize access/update to this struct virtio_balloon elements */
72         struct mutex balloon_lock;
73
74         /* The array of pfns we tell the Host about. */
75         unsigned int num_pfns;
76         u32 pfns[VIRTIO_BALLOON_ARRAY_PFNS_MAX];
77
78         /* Memory statistics */
79         int need_stats_update;
80         struct virtio_balloon_stat stats[VIRTIO_BALLOON_S_NR];
81
82         /* To register callback in oom notifier call chain */
83         struct notifier_block nb;
84 };
85
86 static struct virtio_device_id id_table[] = {
87         { VIRTIO_ID_BALLOON, VIRTIO_DEV_ANY_ID },
88         { 0 },
89 };
90
91 static u32 page_to_balloon_pfn(struct page *page)
92 {
93         unsigned long pfn = page_to_pfn(page);
94
95         BUILD_BUG_ON(PAGE_SHIFT < VIRTIO_BALLOON_PFN_SHIFT);
96         /* Convert pfn from Linux page size to balloon page size. */
97         return pfn * VIRTIO_BALLOON_PAGES_PER_PAGE;
98 }
99
100 static struct page *balloon_pfn_to_page(u32 pfn)
101 {
102         BUG_ON(pfn % VIRTIO_BALLOON_PAGES_PER_PAGE);
103         return pfn_to_page(pfn / VIRTIO_BALLOON_PAGES_PER_PAGE);
104 }
105
106 static void balloon_ack(struct virtqueue *vq)
107 {
108         struct virtio_balloon *vb = vq->vdev->priv;
109
110         wake_up(&vb->acked);
111 }
112
113 static void tell_host(struct virtio_balloon *vb, struct virtqueue *vq)
114 {
115         struct scatterlist sg;
116         unsigned int len;
117
118         sg_init_one(&sg, vb->pfns, sizeof(vb->pfns[0]) * vb->num_pfns);
119
120         /* We should always be able to add one buffer to an empty queue. */
121         virtqueue_add_outbuf(vq, &sg, 1, vb, GFP_KERNEL);
122         virtqueue_kick(vq);
123
124         /* When host has read buffer, this completes via balloon_ack */
125         wait_event(vb->acked, virtqueue_get_buf(vq, &len));
126 }
127
128 static void set_page_pfns(u32 pfns[], struct page *page)
129 {
130         unsigned int i;
131
132         /* Set balloon pfns pointing at this page.
133          * Note that the first pfn points at start of the page. */
134         for (i = 0; i < VIRTIO_BALLOON_PAGES_PER_PAGE; i++)
135                 pfns[i] = page_to_balloon_pfn(page) + i;
136 }
137
138 static unsigned fill_balloon(struct virtio_balloon *vb, size_t num)
139 {
140         struct balloon_dev_info *vb_dev_info = &vb->vb_dev_info;
141         unsigned num_allocated_pages;
142
143         /* We can only do one array worth at a time. */
144         num = min(num, ARRAY_SIZE(vb->pfns));
145
146         mutex_lock(&vb->balloon_lock);
147         for (vb->num_pfns = 0; vb->num_pfns < num;
148              vb->num_pfns += VIRTIO_BALLOON_PAGES_PER_PAGE) {
149                 struct page *page = balloon_page_enqueue(vb_dev_info);
150
151                 if (!page) {
152                         dev_info_ratelimited(&vb->vdev->dev,
153                                              "Out of puff! Can't get %u pages\n",
154                                              VIRTIO_BALLOON_PAGES_PER_PAGE);
155                         /* Sleep for at least 1/5 of a second before retry. */
156                         msleep(200);
157                         break;
158                 }
159                 set_page_pfns(vb->pfns + vb->num_pfns, page);
160                 vb->num_pages += VIRTIO_BALLOON_PAGES_PER_PAGE;
161                 if (!virtio_has_feature(vb->vdev,
162                                         VIRTIO_BALLOON_F_DEFLATE_ON_OOM))
163                         adjust_managed_page_count(page, -1);
164         }
165
166         num_allocated_pages = vb->num_pfns;
167         /* Did we get any? */
168         if (vb->num_pfns != 0)
169                 tell_host(vb, vb->inflate_vq);
170         mutex_unlock(&vb->balloon_lock);
171
172         return num_allocated_pages;
173 }
174
175 static void release_pages_balloon(struct virtio_balloon *vb)
176 {
177         unsigned int i;
178
179         /* Find pfns pointing at start of each page, get pages and free them. */
180         for (i = 0; i < vb->num_pfns; i += VIRTIO_BALLOON_PAGES_PER_PAGE) {
181                 struct page *page = balloon_pfn_to_page(vb->pfns[i]);
182                 if (!virtio_has_feature(vb->vdev,
183                                         VIRTIO_BALLOON_F_DEFLATE_ON_OOM))
184                         adjust_managed_page_count(page, 1);
185                 put_page(page); /* balloon reference */
186         }
187 }
188
189 static unsigned leak_balloon(struct virtio_balloon *vb, size_t num)
190 {
191         unsigned num_freed_pages;
192         struct page *page;
193         struct balloon_dev_info *vb_dev_info = &vb->vb_dev_info;
194
195         /* We can only do one array worth at a time. */
196         num = min(num, ARRAY_SIZE(vb->pfns));
197
198         mutex_lock(&vb->balloon_lock);
199         for (vb->num_pfns = 0; vb->num_pfns < num;
200              vb->num_pfns += VIRTIO_BALLOON_PAGES_PER_PAGE) {
201                 page = balloon_page_dequeue(vb_dev_info);
202                 if (!page)
203                         break;
204                 set_page_pfns(vb->pfns + vb->num_pfns, page);
205                 vb->num_pages -= VIRTIO_BALLOON_PAGES_PER_PAGE;
206         }
207
208         num_freed_pages = vb->num_pfns;
209         /*
210          * Note that if
211          * virtio_has_feature(vdev, VIRTIO_BALLOON_F_MUST_TELL_HOST);
212          * is true, we *have* to do it in this order
213          */
214         if (vb->num_pfns != 0)
215                 tell_host(vb, vb->deflate_vq);
216         release_pages_balloon(vb);
217         mutex_unlock(&vb->balloon_lock);
218         return num_freed_pages;
219 }
220
221 static inline void update_stat(struct virtio_balloon *vb, int idx,
222                                u16 tag, u64 val)
223 {
224         BUG_ON(idx >= VIRTIO_BALLOON_S_NR);
225         vb->stats[idx].tag = cpu_to_virtio16(vb->vdev, tag);
226         vb->stats[idx].val = cpu_to_virtio64(vb->vdev, val);
227 }
228
229 #define pages_to_bytes(x) ((u64)(x) << PAGE_SHIFT)
230
231 static void update_balloon_stats(struct virtio_balloon *vb)
232 {
233         unsigned long events[NR_VM_EVENT_ITEMS];
234         struct sysinfo i;
235         int idx = 0;
236
237         all_vm_events(events);
238         si_meminfo(&i);
239
240         update_stat(vb, idx++, VIRTIO_BALLOON_S_SWAP_IN,
241                                 pages_to_bytes(events[PSWPIN]));
242         update_stat(vb, idx++, VIRTIO_BALLOON_S_SWAP_OUT,
243                                 pages_to_bytes(events[PSWPOUT]));
244         update_stat(vb, idx++, VIRTIO_BALLOON_S_MAJFLT, events[PGMAJFAULT]);
245         update_stat(vb, idx++, VIRTIO_BALLOON_S_MINFLT, events[PGFAULT]);
246         update_stat(vb, idx++, VIRTIO_BALLOON_S_MEMFREE,
247                                 pages_to_bytes(i.freeram));
248         update_stat(vb, idx++, VIRTIO_BALLOON_S_MEMTOT,
249                                 pages_to_bytes(i.totalram));
250 }
251
252 /*
253  * While most virtqueues communicate guest-initiated requests to the hypervisor,
254  * the stats queue operates in reverse.  The driver initializes the virtqueue
255  * with a single buffer.  From that point forward, all conversations consist of
256  * a hypervisor request (a call to this function) which directs us to refill
257  * the virtqueue with a fresh stats buffer.  Since stats collection can sleep,
258  * we delegate the job to a freezable workqueue that will do the actual work via
259  * stats_handle_request().
260  */
261 static void stats_request(struct virtqueue *vq)
262 {
263         struct virtio_balloon *vb = vq->vdev->priv;
264
265         vb->need_stats_update = 1;
266
267         spin_lock(&vb->stop_update_lock);
268         if (!vb->stop_update)
269                 queue_work(system_freezable_wq, &vb->work);
270         spin_unlock(&vb->stop_update_lock);
271 }
272
273 static void stats_handle_request(struct virtio_balloon *vb)
274 {
275         struct virtqueue *vq;
276         struct scatterlist sg;
277         unsigned int len;
278
279         vb->need_stats_update = 0;
280         update_balloon_stats(vb);
281
282         vq = vb->stats_vq;
283         if (!virtqueue_get_buf(vq, &len))
284                 return;
285         sg_init_one(&sg, vb->stats, sizeof(vb->stats));
286         virtqueue_add_outbuf(vq, &sg, 1, vb, GFP_KERNEL);
287         virtqueue_kick(vq);
288 }
289
290 static void virtballoon_changed(struct virtio_device *vdev)
291 {
292         struct virtio_balloon *vb = vdev->priv;
293         unsigned long flags;
294
295         spin_lock_irqsave(&vb->stop_update_lock, flags);
296         if (!vb->stop_update)
297                 queue_work(system_freezable_wq, &vb->work);
298         spin_unlock_irqrestore(&vb->stop_update_lock, flags);
299 }
300
301 static inline s64 towards_target(struct virtio_balloon *vb)
302 {
303         s64 target;
304         u32 num_pages;
305
306         virtio_cread(vb->vdev, struct virtio_balloon_config, num_pages,
307                      &num_pages);
308
309         /* Legacy balloon config space is LE, unlike all other devices. */
310         if (!virtio_has_feature(vb->vdev, VIRTIO_F_VERSION_1))
311                 num_pages = le32_to_cpu((__force __le32)num_pages);
312
313         target = num_pages;
314         return target - vb->num_pages;
315 }
316
317 static void update_balloon_size(struct virtio_balloon *vb)
318 {
319         u32 actual = vb->num_pages;
320
321         /* Legacy balloon config space is LE, unlike all other devices. */
322         if (!virtio_has_feature(vb->vdev, VIRTIO_F_VERSION_1))
323                 actual = (__force u32)cpu_to_le32(actual);
324
325         virtio_cwrite(vb->vdev, struct virtio_balloon_config, actual,
326                       &actual);
327 }
328
329 /*
330  * virtballoon_oom_notify - release pages when system is under severe
331  *                          memory pressure (called from out_of_memory())
332  * @self : notifier block struct
333  * @dummy: not used
334  * @parm : returned - number of freed pages
335  *
336  * The balancing of memory by use of the virtio balloon should not cause
337  * the termination of processes while there are pages in the balloon.
338  * If virtio balloon manages to release some memory, it will make the
339  * system return and retry the allocation that forced the OOM killer
340  * to run.
341  */
342 static int virtballoon_oom_notify(struct notifier_block *self,
343                                   unsigned long dummy, void *parm)
344 {
345         struct virtio_balloon *vb;
346         unsigned long *freed;
347         unsigned num_freed_pages;
348
349         vb = container_of(self, struct virtio_balloon, nb);
350         if (!virtio_has_feature(vb->vdev, VIRTIO_BALLOON_F_DEFLATE_ON_OOM))
351                 return NOTIFY_OK;
352
353         freed = parm;
354         num_freed_pages = leak_balloon(vb, oom_pages);
355         update_balloon_size(vb);
356         *freed += num_freed_pages;
357
358         return NOTIFY_OK;
359 }
360
361 static void balloon(struct work_struct *work)
362 {
363         struct virtio_balloon *vb;
364         s64 diff;
365
366         vb = container_of(work, struct virtio_balloon, work);
367         diff = towards_target(vb);
368
369         if (vb->need_stats_update)
370                 stats_handle_request(vb);
371
372         if (diff > 0)
373                 diff -= fill_balloon(vb, diff);
374         else if (diff < 0)
375                 diff += leak_balloon(vb, -diff);
376         update_balloon_size(vb);
377
378         if (diff)
379                 queue_work(system_freezable_wq, work);
380 }
381
382 static int init_vqs(struct virtio_balloon *vb)
383 {
384         struct virtqueue *vqs[3];
385         vq_callback_t *callbacks[] = { balloon_ack, balloon_ack, stats_request };
386         static const char * const names[] = { "inflate", "deflate", "stats" };
387         int err, nvqs;
388
389         /*
390          * We expect two virtqueues: inflate and deflate, and
391          * optionally stat.
392          */
393         nvqs = virtio_has_feature(vb->vdev, VIRTIO_BALLOON_F_STATS_VQ) ? 3 : 2;
394         err = vb->vdev->config->find_vqs(vb->vdev, nvqs, vqs, callbacks, names);
395         if (err)
396                 return err;
397
398         vb->inflate_vq = vqs[0];
399         vb->deflate_vq = vqs[1];
400         if (virtio_has_feature(vb->vdev, VIRTIO_BALLOON_F_STATS_VQ)) {
401                 struct scatterlist sg;
402                 vb->stats_vq = vqs[2];
403
404                 /*
405                  * Prime this virtqueue with one buffer so the hypervisor can
406                  * use it to signal us later (it can't be broken yet!).
407                  */
408                 sg_init_one(&sg, vb->stats, sizeof vb->stats);
409                 if (virtqueue_add_outbuf(vb->stats_vq, &sg, 1, vb, GFP_KERNEL)
410                     < 0)
411                         BUG();
412                 virtqueue_kick(vb->stats_vq);
413         }
414         return 0;
415 }
416
417 #ifdef CONFIG_BALLOON_COMPACTION
418 /*
419  * virtballoon_migratepage - perform the balloon page migration on behalf of
420  *                           a compation thread.     (called under page lock)
421  * @vb_dev_info: the balloon device
422  * @newpage: page that will replace the isolated page after migration finishes.
423  * @page   : the isolated (old) page that is about to be migrated to newpage.
424  * @mode   : compaction mode -- not used for balloon page migration.
425  *
426  * After a ballooned page gets isolated by compaction procedures, this is the
427  * function that performs the page migration on behalf of a compaction thread
428  * The page migration for virtio balloon is done in a simple swap fashion which
429  * follows these two macro steps:
430  *  1) insert newpage into vb->pages list and update the host about it;
431  *  2) update the host about the old page removed from vb->pages list;
432  *
433  * This function preforms the balloon page migration task.
434  * Called through balloon_mapping->a_ops->migratepage
435  */
436 static int virtballoon_migratepage(struct balloon_dev_info *vb_dev_info,
437                 struct page *newpage, struct page *page, enum migrate_mode mode)
438 {
439         struct virtio_balloon *vb = container_of(vb_dev_info,
440                         struct virtio_balloon, vb_dev_info);
441         unsigned long flags;
442
443         /*
444          * In order to avoid lock contention while migrating pages concurrently
445          * to leak_balloon() or fill_balloon() we just give up the balloon_lock
446          * this turn, as it is easier to retry the page migration later.
447          * This also prevents fill_balloon() getting stuck into a mutex
448          * recursion in the case it ends up triggering memory compaction
449          * while it is attempting to inflate the ballon.
450          */
451         if (!mutex_trylock(&vb->balloon_lock))
452                 return -EAGAIN;
453
454         get_page(newpage); /* balloon reference */
455
456         /* balloon's page migration 1st step  -- inflate "newpage" */
457         spin_lock_irqsave(&vb_dev_info->pages_lock, flags);
458         balloon_page_insert(vb_dev_info, newpage);
459         vb_dev_info->isolated_pages--;
460         __count_vm_event(BALLOON_MIGRATE);
461         spin_unlock_irqrestore(&vb_dev_info->pages_lock, flags);
462         vb->num_pfns = VIRTIO_BALLOON_PAGES_PER_PAGE;
463         set_page_pfns(vb->pfns, newpage);
464         tell_host(vb, vb->inflate_vq);
465
466         /* balloon's page migration 2nd step -- deflate "page" */
467         balloon_page_delete(page);
468         vb->num_pfns = VIRTIO_BALLOON_PAGES_PER_PAGE;
469         set_page_pfns(vb->pfns, page);
470         tell_host(vb, vb->deflate_vq);
471
472         mutex_unlock(&vb->balloon_lock);
473
474         put_page(page); /* balloon reference */
475
476         return MIGRATEPAGE_SUCCESS;
477 }
478 #endif /* CONFIG_BALLOON_COMPACTION */
479
480 static int virtballoon_probe(struct virtio_device *vdev)
481 {
482         struct virtio_balloon *vb;
483         int err;
484
485         if (!vdev->config->get) {
486                 dev_err(&vdev->dev, "%s failure: config access disabled\n",
487                         __func__);
488                 return -EINVAL;
489         }
490
491         vdev->priv = vb = kmalloc(sizeof(*vb), GFP_KERNEL);
492         if (!vb) {
493                 err = -ENOMEM;
494                 goto out;
495         }
496
497         INIT_WORK(&vb->work, balloon);
498         spin_lock_init(&vb->stop_update_lock);
499         vb->stop_update = false;
500         vb->num_pages = 0;
501         mutex_init(&vb->balloon_lock);
502         init_waitqueue_head(&vb->acked);
503         vb->vdev = vdev;
504         vb->need_stats_update = 0;
505
506         balloon_devinfo_init(&vb->vb_dev_info);
507 #ifdef CONFIG_BALLOON_COMPACTION
508         vb->vb_dev_info.migratepage = virtballoon_migratepage;
509 #endif
510
511         err = init_vqs(vb);
512         if (err)
513                 goto out_free_vb;
514
515         vb->nb.notifier_call = virtballoon_oom_notify;
516         vb->nb.priority = VIRTBALLOON_OOM_NOTIFY_PRIORITY;
517         err = register_oom_notifier(&vb->nb);
518         if (err < 0)
519                 goto out_oom_notify;
520
521         virtio_device_ready(vdev);
522
523         return 0;
524
525 out_oom_notify:
526         vdev->config->del_vqs(vdev);
527 out_free_vb:
528         kfree(vb);
529 out:
530         return err;
531 }
532
533 static void remove_common(struct virtio_balloon *vb)
534 {
535         /* There might be pages left in the balloon: free them. */
536         while (vb->num_pages)
537                 leak_balloon(vb, vb->num_pages);
538         update_balloon_size(vb);
539
540         /* Now we reset the device so we can clean up the queues. */
541         vb->vdev->config->reset(vb->vdev);
542
543         vb->vdev->config->del_vqs(vb->vdev);
544 }
545
546 static void virtballoon_remove(struct virtio_device *vdev)
547 {
548         struct virtio_balloon *vb = vdev->priv;
549
550         unregister_oom_notifier(&vb->nb);
551
552         spin_lock_irq(&vb->stop_update_lock);
553         vb->stop_update = true;
554         spin_unlock_irq(&vb->stop_update_lock);
555         cancel_work_sync(&vb->work);
556
557         remove_common(vb);
558         kfree(vb);
559 }
560
561 #ifdef CONFIG_PM_SLEEP
562 static int virtballoon_freeze(struct virtio_device *vdev)
563 {
564         struct virtio_balloon *vb = vdev->priv;
565
566         /*
567          * The workqueue is already frozen by the PM core before this
568          * function is called.
569          */
570         remove_common(vb);
571         return 0;
572 }
573
574 static int virtballoon_restore(struct virtio_device *vdev)
575 {
576         struct virtio_balloon *vb = vdev->priv;
577         int ret;
578
579         ret = init_vqs(vdev->priv);
580         if (ret)
581                 return ret;
582
583         virtio_device_ready(vdev);
584
585         if (towards_target(vb))
586                 virtballoon_changed(vdev);
587         update_balloon_size(vb);
588         return 0;
589 }
590 #endif
591
592 static unsigned int features[] = {
593         VIRTIO_BALLOON_F_MUST_TELL_HOST,
594         VIRTIO_BALLOON_F_STATS_VQ,
595         VIRTIO_BALLOON_F_DEFLATE_ON_OOM,
596 };
597
598 static struct virtio_driver virtio_balloon_driver = {
599         .feature_table = features,
600         .feature_table_size = ARRAY_SIZE(features),
601         .driver.name =  KBUILD_MODNAME,
602         .driver.owner = THIS_MODULE,
603         .id_table =     id_table,
604         .probe =        virtballoon_probe,
605         .remove =       virtballoon_remove,
606         .config_changed = virtballoon_changed,
607 #ifdef CONFIG_PM_SLEEP
608         .freeze =       virtballoon_freeze,
609         .restore =      virtballoon_restore,
610 #endif
611 };
612
613 module_virtio_driver(virtio_balloon_driver);
614 MODULE_DEVICE_TABLE(virtio, id_table);
615 MODULE_DESCRIPTION("Virtio balloon driver");
616 MODULE_LICENSE("GPL");