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