1 /* Virtio balloon implementation, inspired by Dor Loar and Marcelo
2 * Tosatti's implementations.
4 * Copyright 2008 Rusty Russell IBM Corporation
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include <linux/virtio.h>
22 #include <linux/virtio_balloon.h>
23 #include <linux/swap.h>
24 #include <linux/kthread.h>
25 #include <linux/freezer.h>
26 #include <linux/delay.h>
30 struct virtio_device *vdev;
31 struct virtqueue *inflate_vq, *deflate_vq;
33 /* Where the ballooning thread waits for config to change. */
34 wait_queue_head_t config_change;
36 /* The thread servicing the balloon. */
37 struct task_struct *thread;
39 /* Waiting for host to ack the pages we released. */
40 struct completion acked;
42 /* Do we have to tell Host *before* we reuse pages? */
45 /* The pages we've told the Host we're not using. */
46 unsigned int num_pages;
47 struct list_head pages;
49 /* The array of pfns we tell the Host about. */
50 unsigned int num_pfns;
54 static struct virtio_device_id id_table[] = {
55 { VIRTIO_ID_BALLOON, VIRTIO_DEV_ANY_ID },
59 static u32 page_to_balloon_pfn(struct page *page)
61 unsigned long pfn = page_to_pfn(page);
63 BUILD_BUG_ON(PAGE_SHIFT < VIRTIO_BALLOON_PFN_SHIFT);
64 /* Convert pfn from Linux page size to balloon page size. */
65 return pfn >> (PAGE_SHIFT - VIRTIO_BALLOON_PFN_SHIFT);
68 static void balloon_ack(struct virtqueue *vq)
70 struct virtio_balloon *vb;
73 vb = vq->vq_ops->get_buf(vq, &len);
78 static void tell_host(struct virtio_balloon *vb, struct virtqueue *vq)
80 struct scatterlist sg;
82 sg_init_one(&sg, vb->pfns, sizeof(vb->pfns[0]) * vb->num_pfns);
84 init_completion(&vb->acked);
86 /* We should always be able to add one buffer to an empty queue. */
87 if (vq->vq_ops->add_buf(vq, &sg, 1, 0, vb) != 0)
91 /* When host has read buffer, this completes via balloon_ack */
92 wait_for_completion(&vb->acked);
95 static void fill_balloon(struct virtio_balloon *vb, size_t num)
97 /* We can only do one array worth at a time. */
98 num = min(num, ARRAY_SIZE(vb->pfns));
100 for (vb->num_pfns = 0; vb->num_pfns < num; vb->num_pfns++) {
101 struct page *page = alloc_page(GFP_HIGHUSER | __GFP_NORETRY);
103 if (printk_ratelimit())
104 dev_printk(KERN_INFO, &vb->vdev->dev,
105 "Out of puff! Can't get %zu pages\n",
107 /* Sleep for at least 1/5 of a second before retry. */
111 vb->pfns[vb->num_pfns] = page_to_balloon_pfn(page);
114 list_add(&page->lru, &vb->pages);
117 /* Didn't get any? Oh well. */
118 if (vb->num_pfns == 0)
121 tell_host(vb, vb->inflate_vq);
124 static void release_pages_by_pfn(const u32 pfns[], unsigned int num)
128 for (i = 0; i < num; i++) {
129 __free_page(pfn_to_page(pfns[i]));
134 static void leak_balloon(struct virtio_balloon *vb, size_t num)
138 /* We can only do one array worth at a time. */
139 num = min(num, ARRAY_SIZE(vb->pfns));
141 for (vb->num_pfns = 0; vb->num_pfns < num; vb->num_pfns++) {
142 page = list_first_entry(&vb->pages, struct page, lru);
143 list_del(&page->lru);
144 vb->pfns[vb->num_pfns] = page_to_balloon_pfn(page);
148 if (vb->tell_host_first) {
149 tell_host(vb, vb->deflate_vq);
150 release_pages_by_pfn(vb->pfns, vb->num_pfns);
152 release_pages_by_pfn(vb->pfns, vb->num_pfns);
153 tell_host(vb, vb->deflate_vq);
157 static void virtballoon_changed(struct virtio_device *vdev)
159 struct virtio_balloon *vb = vdev->priv;
161 wake_up(&vb->config_change);
164 static inline s64 towards_target(struct virtio_balloon *vb)
167 vb->vdev->config->get(vb->vdev,
168 offsetof(struct virtio_balloon_config, num_pages),
170 return (s64)v - vb->num_pages;
173 static void update_balloon_size(struct virtio_balloon *vb)
175 __le32 actual = cpu_to_le32(vb->num_pages);
177 vb->vdev->config->set(vb->vdev,
178 offsetof(struct virtio_balloon_config, actual),
179 &actual, sizeof(actual));
182 static int balloon(void *_vballoon)
184 struct virtio_balloon *vb = _vballoon;
187 while (!kthread_should_stop()) {
191 wait_event_interruptible(vb->config_change,
192 (diff = towards_target(vb)) != 0
193 || kthread_should_stop());
195 fill_balloon(vb, diff);
197 leak_balloon(vb, -diff);
198 update_balloon_size(vb);
203 static int virtballoon_probe(struct virtio_device *vdev)
205 struct virtio_balloon *vb;
208 vdev->priv = vb = kmalloc(sizeof(*vb), GFP_KERNEL);
214 INIT_LIST_HEAD(&vb->pages);
216 init_waitqueue_head(&vb->config_change);
219 /* We expect two virtqueues. */
220 vb->inflate_vq = vdev->config->find_vq(vdev, 0, balloon_ack);
221 if (IS_ERR(vb->inflate_vq)) {
222 err = PTR_ERR(vb->inflate_vq);
226 vb->deflate_vq = vdev->config->find_vq(vdev, 1, balloon_ack);
227 if (IS_ERR(vb->deflate_vq)) {
228 err = PTR_ERR(vb->deflate_vq);
229 goto out_del_inflate_vq;
232 vb->thread = kthread_run(balloon, vb, "vballoon");
233 if (IS_ERR(vb->thread)) {
234 err = PTR_ERR(vb->thread);
235 goto out_del_deflate_vq;
239 = virtio_has_feature(vdev, VIRTIO_BALLOON_F_MUST_TELL_HOST);
244 vdev->config->del_vq(vb->deflate_vq);
246 vdev->config->del_vq(vb->inflate_vq);
253 static void virtballoon_remove(struct virtio_device *vdev)
255 struct virtio_balloon *vb = vdev->priv;
257 kthread_stop(vb->thread);
259 /* There might be pages left in the balloon: free them. */
260 while (vb->num_pages)
261 leak_balloon(vb, vb->num_pages);
263 /* Now we reset the device so we can clean up the queues. */
264 vdev->config->reset(vdev);
266 vdev->config->del_vq(vb->deflate_vq);
267 vdev->config->del_vq(vb->inflate_vq);
271 static unsigned int features[] = { VIRTIO_BALLOON_F_MUST_TELL_HOST };
273 static struct virtio_driver virtio_balloon = {
274 .feature_table = features,
275 .feature_table_size = ARRAY_SIZE(features),
276 .driver.name = KBUILD_MODNAME,
277 .driver.owner = THIS_MODULE,
278 .id_table = id_table,
279 .probe = virtballoon_probe,
280 .remove = __devexit_p(virtballoon_remove),
281 .config_changed = virtballoon_changed,
284 static int __init init(void)
286 return register_virtio_driver(&virtio_balloon);
289 static void __exit fini(void)
291 unregister_virtio_driver(&virtio_balloon);
296 MODULE_DEVICE_TABLE(virtio, id_table);
297 MODULE_DESCRIPTION("Virtio balloon driver");
298 MODULE_LICENSE("GPL");