2 * Virtio balloon implementation, inspired by Dor Laor and Marcelo
3 * Tosatti's implementations.
5 * Copyright 2008 Rusty Russell IBM Corporation
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.
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.
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
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>
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
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
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");
48 struct virtio_balloon
{
49 struct virtio_device
*vdev
;
50 struct virtqueue
*inflate_vq
, *deflate_vq
, *stats_vq
;
52 /* Where the ballooning thread waits for config to change. */
53 wait_queue_head_t config_change
;
55 /* The thread servicing the balloon. */
56 struct task_struct
*thread
;
58 /* Waiting for host to ack the pages we released. */
59 wait_queue_head_t acked
;
61 /* Number of balloon pages we've told the Host we're not using. */
62 unsigned int num_pages
;
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
69 struct balloon_dev_info vb_dev_info
;
71 /* Synchronize access/update to this struct virtio_balloon elements */
72 struct mutex balloon_lock
;
74 /* The array of pfns we tell the Host about. */
75 unsigned int num_pfns
;
76 u32 pfns
[VIRTIO_BALLOON_ARRAY_PFNS_MAX
];
78 /* Memory statistics */
79 int need_stats_update
;
80 struct virtio_balloon_stat stats
[VIRTIO_BALLOON_S_NR
];
82 /* To register callback in oom notifier call chain */
83 struct notifier_block nb
;
86 static struct virtio_device_id id_table
[] = {
87 { VIRTIO_ID_BALLOON
, VIRTIO_DEV_ANY_ID
},
91 static u32
page_to_balloon_pfn(struct page
*page
)
93 unsigned long pfn
= page_to_pfn(page
);
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
;
100 static struct page
*balloon_pfn_to_page(u32 pfn
)
102 BUG_ON(pfn
% VIRTIO_BALLOON_PAGES_PER_PAGE
);
103 return pfn_to_page(pfn
/ VIRTIO_BALLOON_PAGES_PER_PAGE
);
106 static void balloon_ack(struct virtqueue
*vq
)
108 struct virtio_balloon
*vb
= vq
->vdev
->priv
;
113 static void tell_host(struct virtio_balloon
*vb
, struct virtqueue
*vq
)
115 struct scatterlist sg
;
118 sg_init_one(&sg
, vb
->pfns
, sizeof(vb
->pfns
[0]) * vb
->num_pfns
);
120 /* We should always be able to add one buffer to an empty queue. */
121 virtqueue_add_outbuf(vq
, &sg
, 1, vb
, GFP_KERNEL
);
124 /* When host has read buffer, this completes via balloon_ack */
125 wait_event(vb
->acked
, virtqueue_get_buf(vq
, &len
));
128 static void set_page_pfns(u32 pfns
[], struct page
*page
)
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
;
138 static void fill_balloon(struct virtio_balloon
*vb
, size_t num
)
140 struct balloon_dev_info
*vb_dev_info
= &vb
->vb_dev_info
;
142 /* We can only do one array worth at a time. */
143 num
= min(num
, ARRAY_SIZE(vb
->pfns
));
145 mutex_lock(&vb
->balloon_lock
);
146 for (vb
->num_pfns
= 0; vb
->num_pfns
< num
;
147 vb
->num_pfns
+= VIRTIO_BALLOON_PAGES_PER_PAGE
) {
148 struct page
*page
= balloon_page_enqueue(vb_dev_info
);
151 dev_info_ratelimited(&vb
->vdev
->dev
,
152 "Out of puff! Can't get %u pages\n",
153 VIRTIO_BALLOON_PAGES_PER_PAGE
);
154 /* Sleep for at least 1/5 of a second before retry. */
158 set_page_pfns(vb
->pfns
+ vb
->num_pfns
, page
);
159 vb
->num_pages
+= VIRTIO_BALLOON_PAGES_PER_PAGE
;
160 adjust_managed_page_count(page
, -1);
163 /* Did we get any? */
164 if (vb
->num_pfns
!= 0)
165 tell_host(vb
, vb
->inflate_vq
);
166 mutex_unlock(&vb
->balloon_lock
);
169 static void release_pages_by_pfn(const u32 pfns
[], unsigned int num
)
173 /* Find pfns pointing at start of each page, get pages and free them. */
174 for (i
= 0; i
< num
; i
+= VIRTIO_BALLOON_PAGES_PER_PAGE
) {
175 struct page
*page
= balloon_pfn_to_page(pfns
[i
]);
176 adjust_managed_page_count(page
, 1);
177 put_page(page
); /* balloon reference */
181 static unsigned leak_balloon(struct virtio_balloon
*vb
, size_t num
)
183 unsigned num_freed_pages
;
185 struct balloon_dev_info
*vb_dev_info
= &vb
->vb_dev_info
;
187 /* We can only do one array worth at a time. */
188 num
= min(num
, ARRAY_SIZE(vb
->pfns
));
190 mutex_lock(&vb
->balloon_lock
);
191 for (vb
->num_pfns
= 0; vb
->num_pfns
< num
;
192 vb
->num_pfns
+= VIRTIO_BALLOON_PAGES_PER_PAGE
) {
193 page
= balloon_page_dequeue(vb_dev_info
);
196 set_page_pfns(vb
->pfns
+ vb
->num_pfns
, page
);
197 vb
->num_pages
-= VIRTIO_BALLOON_PAGES_PER_PAGE
;
200 num_freed_pages
= vb
->num_pfns
;
203 * virtio_has_feature(vdev, VIRTIO_BALLOON_F_MUST_TELL_HOST);
204 * is true, we *have* to do it in this order
206 if (vb
->num_pfns
!= 0)
207 tell_host(vb
, vb
->deflate_vq
);
208 mutex_unlock(&vb
->balloon_lock
);
209 release_pages_by_pfn(vb
->pfns
, vb
->num_pfns
);
210 return num_freed_pages
;
213 static inline void update_stat(struct virtio_balloon
*vb
, int idx
,
216 BUG_ON(idx
>= VIRTIO_BALLOON_S_NR
);
217 vb
->stats
[idx
].tag
= cpu_to_virtio16(vb
->vdev
, tag
);
218 vb
->stats
[idx
].val
= cpu_to_virtio64(vb
->vdev
, val
);
221 #define pages_to_bytes(x) ((u64)(x) << PAGE_SHIFT)
223 static void update_balloon_stats(struct virtio_balloon
*vb
)
225 unsigned long events
[NR_VM_EVENT_ITEMS
];
229 all_vm_events(events
);
232 update_stat(vb
, idx
++, VIRTIO_BALLOON_S_SWAP_IN
,
233 pages_to_bytes(events
[PSWPIN
]));
234 update_stat(vb
, idx
++, VIRTIO_BALLOON_S_SWAP_OUT
,
235 pages_to_bytes(events
[PSWPOUT
]));
236 update_stat(vb
, idx
++, VIRTIO_BALLOON_S_MAJFLT
, events
[PGMAJFAULT
]);
237 update_stat(vb
, idx
++, VIRTIO_BALLOON_S_MINFLT
, events
[PGFAULT
]);
238 update_stat(vb
, idx
++, VIRTIO_BALLOON_S_MEMFREE
,
239 pages_to_bytes(i
.freeram
));
240 update_stat(vb
, idx
++, VIRTIO_BALLOON_S_MEMTOT
,
241 pages_to_bytes(i
.totalram
));
245 * While most virtqueues communicate guest-initiated requests to the hypervisor,
246 * the stats queue operates in reverse. The driver initializes the virtqueue
247 * with a single buffer. From that point forward, all conversations consist of
248 * a hypervisor request (a call to this function) which directs us to refill
249 * the virtqueue with a fresh stats buffer. Since stats collection can sleep,
250 * we notify our kthread which does the actual work via stats_handle_request().
252 static void stats_request(struct virtqueue
*vq
)
254 struct virtio_balloon
*vb
= vq
->vdev
->priv
;
256 vb
->need_stats_update
= 1;
257 wake_up(&vb
->config_change
);
260 static void stats_handle_request(struct virtio_balloon
*vb
)
262 struct virtqueue
*vq
;
263 struct scatterlist sg
;
266 vb
->need_stats_update
= 0;
267 update_balloon_stats(vb
);
270 if (!virtqueue_get_buf(vq
, &len
))
272 sg_init_one(&sg
, vb
->stats
, sizeof(vb
->stats
));
273 virtqueue_add_outbuf(vq
, &sg
, 1, vb
, GFP_KERNEL
);
277 static void virtballoon_changed(struct virtio_device
*vdev
)
279 struct virtio_balloon
*vb
= vdev
->priv
;
281 wake_up(&vb
->config_change
);
284 static inline s64
towards_target(struct virtio_balloon
*vb
)
289 virtio_cread(vb
->vdev
, struct virtio_balloon_config
, num_pages
,
292 /* Legacy balloon config space is LE, unlike all other devices. */
293 if (!virtio_has_feature(vb
->vdev
, VIRTIO_F_VERSION_1
))
294 num_pages
= le32_to_cpu((__force __le32
)num_pages
);
297 return target
- vb
->num_pages
;
300 static void update_balloon_size(struct virtio_balloon
*vb
)
302 u32 actual
= vb
->num_pages
;
304 /* Legacy balloon config space is LE, unlike all other devices. */
305 if (!virtio_has_feature(vb
->vdev
, VIRTIO_F_VERSION_1
))
306 actual
= (__force u32
)cpu_to_le32(actual
);
308 virtio_cwrite(vb
->vdev
, struct virtio_balloon_config
, actual
,
313 * virtballoon_oom_notify - release pages when system is under severe
314 * memory pressure (called from out_of_memory())
315 * @self : notifier block struct
317 * @parm : returned - number of freed pages
319 * The balancing of memory by use of the virtio balloon should not cause
320 * the termination of processes while there are pages in the balloon.
321 * If virtio balloon manages to release some memory, it will make the
322 * system return and retry the allocation that forced the OOM killer
325 static int virtballoon_oom_notify(struct notifier_block
*self
,
326 unsigned long dummy
, void *parm
)
328 struct virtio_balloon
*vb
;
329 unsigned long *freed
;
330 unsigned num_freed_pages
;
332 vb
= container_of(self
, struct virtio_balloon
, nb
);
333 if (!virtio_has_feature(vb
->vdev
, VIRTIO_BALLOON_F_DEFLATE_ON_OOM
))
337 num_freed_pages
= leak_balloon(vb
, oom_pages
);
338 update_balloon_size(vb
);
339 *freed
+= num_freed_pages
;
344 static int balloon(void *_vballoon
)
346 struct virtio_balloon
*vb
= _vballoon
;
347 DEFINE_WAIT_FUNC(wait
, woken_wake_function
);
350 while (!kthread_should_stop()) {
355 add_wait_queue(&vb
->config_change
, &wait
);
357 if ((diff
= towards_target(vb
)) != 0 ||
358 vb
->need_stats_update
||
359 kthread_should_stop() ||
362 wait_woken(&wait
, TASK_INTERRUPTIBLE
, MAX_SCHEDULE_TIMEOUT
);
364 remove_wait_queue(&vb
->config_change
, &wait
);
366 if (vb
->need_stats_update
)
367 stats_handle_request(vb
);
369 fill_balloon(vb
, diff
);
371 leak_balloon(vb
, -diff
);
372 update_balloon_size(vb
);
375 * For large balloon changes, we could spend a lot of time
376 * and always have work to do. Be nice if preempt disabled.
383 static int init_vqs(struct virtio_balloon
*vb
)
385 struct virtqueue
*vqs
[3];
386 vq_callback_t
*callbacks
[] = { balloon_ack
, balloon_ack
, stats_request
};
387 const char *names
[] = { "inflate", "deflate", "stats" };
391 * We expect two virtqueues: inflate and deflate, and
394 nvqs
= virtio_has_feature(vb
->vdev
, VIRTIO_BALLOON_F_STATS_VQ
) ? 3 : 2;
395 err
= vb
->vdev
->config
->find_vqs(vb
->vdev
, nvqs
, vqs
, callbacks
, names
);
399 vb
->inflate_vq
= vqs
[0];
400 vb
->deflate_vq
= vqs
[1];
401 if (virtio_has_feature(vb
->vdev
, VIRTIO_BALLOON_F_STATS_VQ
)) {
402 struct scatterlist sg
;
403 vb
->stats_vq
= vqs
[2];
406 * Prime this virtqueue with one buffer so the hypervisor can
407 * use it to signal us later (it can't be broken yet!).
409 sg_init_one(&sg
, vb
->stats
, sizeof vb
->stats
);
410 if (virtqueue_add_outbuf(vb
->stats_vq
, &sg
, 1, vb
, GFP_KERNEL
)
413 virtqueue_kick(vb
->stats_vq
);
418 #ifdef CONFIG_BALLOON_COMPACTION
420 * virtballoon_migratepage - perform the balloon page migration on behalf of
421 * a compation thread. (called under page lock)
422 * @vb_dev_info: the balloon device
423 * @newpage: page that will replace the isolated page after migration finishes.
424 * @page : the isolated (old) page that is about to be migrated to newpage.
425 * @mode : compaction mode -- not used for balloon page migration.
427 * After a ballooned page gets isolated by compaction procedures, this is the
428 * function that performs the page migration on behalf of a compaction thread
429 * The page migration for virtio balloon is done in a simple swap fashion which
430 * follows these two macro steps:
431 * 1) insert newpage into vb->pages list and update the host about it;
432 * 2) update the host about the old page removed from vb->pages list;
434 * This function preforms the balloon page migration task.
435 * Called through balloon_mapping->a_ops->migratepage
437 static int virtballoon_migratepage(struct balloon_dev_info
*vb_dev_info
,
438 struct page
*newpage
, struct page
*page
, enum migrate_mode mode
)
440 struct virtio_balloon
*vb
= container_of(vb_dev_info
,
441 struct virtio_balloon
, vb_dev_info
);
445 * In order to avoid lock contention while migrating pages concurrently
446 * to leak_balloon() or fill_balloon() we just give up the balloon_lock
447 * this turn, as it is easier to retry the page migration later.
448 * This also prevents fill_balloon() getting stuck into a mutex
449 * recursion in the case it ends up triggering memory compaction
450 * while it is attempting to inflate the ballon.
452 if (!mutex_trylock(&vb
->balloon_lock
))
455 get_page(newpage
); /* balloon reference */
457 /* balloon's page migration 1st step -- inflate "newpage" */
458 spin_lock_irqsave(&vb_dev_info
->pages_lock
, flags
);
459 balloon_page_insert(vb_dev_info
, newpage
);
460 vb_dev_info
->isolated_pages
--;
461 __count_vm_event(BALLOON_MIGRATE
);
462 spin_unlock_irqrestore(&vb_dev_info
->pages_lock
, flags
);
463 vb
->num_pfns
= VIRTIO_BALLOON_PAGES_PER_PAGE
;
464 set_page_pfns(vb
->pfns
, newpage
);
465 tell_host(vb
, vb
->inflate_vq
);
467 /* balloon's page migration 2nd step -- deflate "page" */
468 balloon_page_delete(page
);
469 vb
->num_pfns
= VIRTIO_BALLOON_PAGES_PER_PAGE
;
470 set_page_pfns(vb
->pfns
, page
);
471 tell_host(vb
, vb
->deflate_vq
);
473 mutex_unlock(&vb
->balloon_lock
);
475 put_page(page
); /* balloon reference */
477 return MIGRATEPAGE_SUCCESS
;
479 #endif /* CONFIG_BALLOON_COMPACTION */
481 static int virtballoon_probe(struct virtio_device
*vdev
)
483 struct virtio_balloon
*vb
;
486 if (!vdev
->config
->get
) {
487 dev_err(&vdev
->dev
, "%s failure: config access disabled\n",
492 vdev
->priv
= vb
= kmalloc(sizeof(*vb
), GFP_KERNEL
);
499 mutex_init(&vb
->balloon_lock
);
500 init_waitqueue_head(&vb
->config_change
);
501 init_waitqueue_head(&vb
->acked
);
503 vb
->need_stats_update
= 0;
505 balloon_devinfo_init(&vb
->vb_dev_info
);
506 #ifdef CONFIG_BALLOON_COMPACTION
507 vb
->vb_dev_info
.migratepage
= virtballoon_migratepage
;
514 vb
->nb
.notifier_call
= virtballoon_oom_notify
;
515 vb
->nb
.priority
= VIRTBALLOON_OOM_NOTIFY_PRIORITY
;
516 err
= register_oom_notifier(&vb
->nb
);
520 virtio_device_ready(vdev
);
522 vb
->thread
= kthread_run(balloon
, vb
, "vballoon");
523 if (IS_ERR(vb
->thread
)) {
524 err
= PTR_ERR(vb
->thread
);
531 unregister_oom_notifier(&vb
->nb
);
533 vdev
->config
->del_vqs(vdev
);
540 static void remove_common(struct virtio_balloon
*vb
)
542 /* There might be pages left in the balloon: free them. */
543 while (vb
->num_pages
)
544 leak_balloon(vb
, vb
->num_pages
);
545 update_balloon_size(vb
);
547 /* Now we reset the device so we can clean up the queues. */
548 vb
->vdev
->config
->reset(vb
->vdev
);
550 vb
->vdev
->config
->del_vqs(vb
->vdev
);
553 static void virtballoon_remove(struct virtio_device
*vdev
)
555 struct virtio_balloon
*vb
= vdev
->priv
;
557 unregister_oom_notifier(&vb
->nb
);
558 kthread_stop(vb
->thread
);
563 #ifdef CONFIG_PM_SLEEP
564 static int virtballoon_freeze(struct virtio_device
*vdev
)
566 struct virtio_balloon
*vb
= vdev
->priv
;
569 * The kthread is already frozen by the PM core before this
570 * function is called.
577 static int virtballoon_restore(struct virtio_device
*vdev
)
579 struct virtio_balloon
*vb
= vdev
->priv
;
582 ret
= init_vqs(vdev
->priv
);
586 virtio_device_ready(vdev
);
588 fill_balloon(vb
, towards_target(vb
));
589 update_balloon_size(vb
);
594 static unsigned int features
[] = {
595 VIRTIO_BALLOON_F_MUST_TELL_HOST
,
596 VIRTIO_BALLOON_F_STATS_VQ
,
597 VIRTIO_BALLOON_F_DEFLATE_ON_OOM
,
600 static struct virtio_driver virtio_balloon_driver
= {
601 .feature_table
= features
,
602 .feature_table_size
= ARRAY_SIZE(features
),
603 .driver
.name
= KBUILD_MODNAME
,
604 .driver
.owner
= THIS_MODULE
,
605 .id_table
= id_table
,
606 .probe
= virtballoon_probe
,
607 .remove
= virtballoon_remove
,
608 .config_changed
= virtballoon_changed
,
609 #ifdef CONFIG_PM_SLEEP
610 .freeze
= virtballoon_freeze
,
611 .restore
= virtballoon_restore
,
615 module_virtio_driver(virtio_balloon_driver
);
616 MODULE_DEVICE_TABLE(virtio
, id_table
);
617 MODULE_DESCRIPTION("Virtio balloon driver");
618 MODULE_LICENSE("GPL");