1 /******************************************************************************
4 * Xen balloon driver - enables returning/claiming memory to/from Xen.
6 * Copyright (c) 2003, B Dragovic
7 * Copyright (c) 2003-2004, M Williamson, K Fraser
8 * Copyright (c) 2005 Dan M. Smith, IBM Corporation
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License version 2
12 * as published by the Free Software Foundation; or, when distributed
13 * separately from the Linux kernel or incorporated into other
14 * software packages, subject to the following license:
16 * Permission is hereby granted, free of charge, to any person obtaining a copy
17 * of this source file (the "Software"), to deal in the Software without
18 * restriction, including without limitation the rights to use, copy, modify,
19 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
20 * and to permit persons to whom the Software is furnished to do so, subject to
21 * the following conditions:
23 * The above copyright notice and this permission notice shall be included in
24 * all copies or substantial portions of the Software.
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
29 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
30 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
31 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/sched.h>
38 #include <linux/errno.h>
40 #include <linux/bootmem.h>
41 #include <linux/pagemap.h>
42 #include <linux/highmem.h>
43 #include <linux/mutex.h>
44 #include <linux/list.h>
45 #include <linux/sysdev.h>
46 #include <linux/gfp.h>
49 #include <asm/pgalloc.h>
50 #include <asm/pgtable.h>
51 #include <asm/uaccess.h>
54 #include <asm/xen/hypervisor.h>
55 #include <asm/xen/hypercall.h>
58 #include <xen/interface/xen.h>
59 #include <xen/interface/memory.h>
60 #include <xen/xenbus.h>
61 #include <xen/features.h>
64 #define PAGES2KB(_p) ((_p)<<(PAGE_SHIFT-10))
66 #define BALLOON_CLASS_NAME "xen_memory"
68 struct balloon_stats
{
69 /* We aim for 'current allocation' == 'target allocation'. */
70 unsigned long current_pages
;
71 unsigned long target_pages
;
73 * Drivers may alter the memory reservation independently, but they
74 * must inform the balloon driver so we avoid hitting the hard limit.
76 unsigned long driver_pages
;
77 /* Number of pages in high- and low-memory balloons. */
78 unsigned long balloon_low
;
79 unsigned long balloon_high
;
82 static DEFINE_MUTEX(balloon_mutex
);
84 static struct sys_device balloon_sysdev
;
86 static int register_balloon(struct sys_device
*sysdev
);
88 static struct balloon_stats balloon_stats
;
90 /* We increase/decrease in batches which fit in a page */
91 static unsigned long frame_list
[PAGE_SIZE
/ sizeof(unsigned long)];
94 #define inc_totalhigh_pages() (totalhigh_pages++)
95 #define dec_totalhigh_pages() (totalhigh_pages--)
97 #define inc_totalhigh_pages() do {} while(0)
98 #define dec_totalhigh_pages() do {} while(0)
101 /* List of ballooned pages, threaded through the mem_map array. */
102 static LIST_HEAD(ballooned_pages
);
104 /* Main work function, always executed in process context. */
105 static void balloon_process(struct work_struct
*work
);
106 static DECLARE_WORK(balloon_worker
, balloon_process
);
107 static struct timer_list balloon_timer
;
109 /* When ballooning out (allocating memory to return to Xen) we don't really
110 want the kernel to try too hard since that can trigger the oom killer. */
111 #define GFP_BALLOON \
112 (GFP_HIGHUSER | __GFP_NOWARN | __GFP_NORETRY | __GFP_NOMEMALLOC)
114 static void scrub_page(struct page
*page
)
116 #ifdef CONFIG_XEN_SCRUB_PAGES
117 clear_highpage(page
);
121 /* balloon_append: add the given page to the balloon. */
122 static void balloon_append(struct page
*page
)
124 /* Lowmem is re-populated first, so highmem pages go at list tail. */
125 if (PageHighMem(page
)) {
126 list_add_tail(&page
->lru
, &ballooned_pages
);
127 balloon_stats
.balloon_high
++;
128 dec_totalhigh_pages();
130 list_add(&page
->lru
, &ballooned_pages
);
131 balloon_stats
.balloon_low
++;
137 /* balloon_retrieve: rescue a page from the balloon, if it is not empty. */
138 static struct page
*balloon_retrieve(void)
142 if (list_empty(&ballooned_pages
))
145 page
= list_entry(ballooned_pages
.next
, struct page
, lru
);
146 list_del(&page
->lru
);
148 if (PageHighMem(page
)) {
149 balloon_stats
.balloon_high
--;
150 inc_totalhigh_pages();
153 balloon_stats
.balloon_low
--;
160 static struct page
*balloon_first_page(void)
162 if (list_empty(&ballooned_pages
))
164 return list_entry(ballooned_pages
.next
, struct page
, lru
);
167 static struct page
*balloon_next_page(struct page
*page
)
169 struct list_head
*next
= page
->lru
.next
;
170 if (next
== &ballooned_pages
)
172 return list_entry(next
, struct page
, lru
);
175 static void balloon_alarm(unsigned long unused
)
177 schedule_work(&balloon_worker
);
180 static unsigned long current_target(void)
182 unsigned long target
= balloon_stats
.target_pages
;
185 balloon_stats
.current_pages
+
186 balloon_stats
.balloon_low
+
187 balloon_stats
.balloon_high
);
192 static int increase_reservation(unsigned long nr_pages
)
194 unsigned long pfn
, i
, flags
;
197 struct xen_memory_reservation reservation
= {
203 if (nr_pages
> ARRAY_SIZE(frame_list
))
204 nr_pages
= ARRAY_SIZE(frame_list
);
206 spin_lock_irqsave(&xen_reservation_lock
, flags
);
208 page
= balloon_first_page();
209 for (i
= 0; i
< nr_pages
; i
++) {
210 BUG_ON(page
== NULL
);
211 frame_list
[i
] = page_to_pfn(page
);
212 page
= balloon_next_page(page
);
215 set_xen_guest_handle(reservation
.extent_start
, frame_list
);
216 reservation
.nr_extents
= nr_pages
;
217 rc
= HYPERVISOR_memory_op(XENMEM_populate_physmap
, &reservation
);
221 for (i
= 0; i
< rc
; i
++) {
222 page
= balloon_retrieve();
223 BUG_ON(page
== NULL
);
225 pfn
= page_to_pfn(page
);
226 BUG_ON(!xen_feature(XENFEAT_auto_translated_physmap
) &&
227 phys_to_machine_mapping_valid(pfn
));
229 set_phys_to_machine(pfn
, frame_list
[i
]);
231 /* Link back into the page tables if not highmem. */
232 if (pfn
< max_low_pfn
) {
234 ret
= HYPERVISOR_update_va_mapping(
235 (unsigned long)__va(pfn
<< PAGE_SHIFT
),
236 mfn_pte(frame_list
[i
], PAGE_KERNEL
),
241 /* Relinquish the page back to the allocator. */
242 ClearPageReserved(page
);
243 init_page_count(page
);
247 balloon_stats
.current_pages
+= rc
;
250 spin_unlock_irqrestore(&xen_reservation_lock
, flags
);
252 return rc
< 0 ? rc
: rc
!= nr_pages
;
255 static int decrease_reservation(unsigned long nr_pages
)
257 unsigned long pfn
, i
, flags
;
261 struct xen_memory_reservation reservation
= {
267 if (nr_pages
> ARRAY_SIZE(frame_list
))
268 nr_pages
= ARRAY_SIZE(frame_list
);
270 for (i
= 0; i
< nr_pages
; i
++) {
271 if ((page
= alloc_page(GFP_BALLOON
)) == NULL
) {
277 pfn
= page_to_pfn(page
);
278 frame_list
[i
] = pfn_to_mfn(pfn
);
282 if (!PageHighMem(page
)) {
283 ret
= HYPERVISOR_update_va_mapping(
284 (unsigned long)__va(pfn
<< PAGE_SHIFT
),
291 /* Ensure that ballooned highmem pages don't have kmaps. */
295 spin_lock_irqsave(&xen_reservation_lock
, flags
);
297 /* No more mappings: invalidate P2M and add to balloon. */
298 for (i
= 0; i
< nr_pages
; i
++) {
299 pfn
= mfn_to_pfn(frame_list
[i
]);
300 set_phys_to_machine(pfn
, INVALID_P2M_ENTRY
);
301 balloon_append(pfn_to_page(pfn
));
304 set_xen_guest_handle(reservation
.extent_start
, frame_list
);
305 reservation
.nr_extents
= nr_pages
;
306 ret
= HYPERVISOR_memory_op(XENMEM_decrease_reservation
, &reservation
);
307 BUG_ON(ret
!= nr_pages
);
309 balloon_stats
.current_pages
-= nr_pages
;
311 spin_unlock_irqrestore(&xen_reservation_lock
, flags
);
317 * We avoid multiple worker processes conflicting via the balloon mutex.
318 * We may of course race updates of the target counts (which are protected
319 * by the balloon lock), or with changes to the Xen hard limit, but we will
320 * recover from these in time.
322 static void balloon_process(struct work_struct
*work
)
327 mutex_lock(&balloon_mutex
);
330 credit
= current_target() - balloon_stats
.current_pages
;
332 need_sleep
= (increase_reservation(credit
) != 0);
334 need_sleep
= (decrease_reservation(-credit
) != 0);
336 #ifndef CONFIG_PREEMPT
340 } while ((credit
!= 0) && !need_sleep
);
342 /* Schedule more work if there is some still to be done. */
343 if (current_target() != balloon_stats
.current_pages
)
344 mod_timer(&balloon_timer
, jiffies
+ HZ
);
346 mutex_unlock(&balloon_mutex
);
349 /* Resets the Xen limit, sets new target, and kicks off processing. */
350 static void balloon_set_new_target(unsigned long target
)
352 /* No need for lock. Not read-modify-write updates. */
353 balloon_stats
.target_pages
= target
;
354 schedule_work(&balloon_worker
);
357 static struct xenbus_watch target_watch
=
359 .node
= "memory/target"
362 /* React to a change in the target key */
363 static void watch_target(struct xenbus_watch
*watch
,
364 const char **vec
, unsigned int len
)
366 unsigned long long new_target
;
369 err
= xenbus_scanf(XBT_NIL
, "memory", "target", "%llu", &new_target
);
371 /* This is ok (for domain0 at least) - so just return */
375 /* The given memory/target value is in KiB, so it needs converting to
376 * pages. PAGE_SHIFT converts bytes to pages, hence PAGE_SHIFT - 10.
378 balloon_set_new_target(new_target
>> (PAGE_SHIFT
- 10));
381 static int balloon_init_watcher(struct notifier_block
*notifier
,
387 err
= register_xenbus_watch(&target_watch
);
389 printk(KERN_ERR
"Failed to set balloon watcher\n");
394 static struct notifier_block xenstore_notifier
;
396 static int __init
balloon_init(void)
401 if (!xen_pv_domain())
404 pr_info("xen_balloon: Initialising balloon driver.\n");
406 balloon_stats
.current_pages
= min(xen_start_info
->nr_pages
, max_pfn
);
407 balloon_stats
.target_pages
= balloon_stats
.current_pages
;
408 balloon_stats
.balloon_low
= 0;
409 balloon_stats
.balloon_high
= 0;
410 balloon_stats
.driver_pages
= 0UL;
412 init_timer(&balloon_timer
);
413 balloon_timer
.data
= 0;
414 balloon_timer
.function
= balloon_alarm
;
416 register_balloon(&balloon_sysdev
);
418 /* Initialise the balloon with excess memory space. */
419 for (pfn
= xen_start_info
->nr_pages
; pfn
< max_pfn
; pfn
++) {
420 page
= pfn_to_page(pfn
);
421 if (!PageReserved(page
))
422 balloon_append(page
);
425 target_watch
.callback
= watch_target
;
426 xenstore_notifier
.notifier_call
= balloon_init_watcher
;
428 register_xenstore_notifier(&xenstore_notifier
);
433 subsys_initcall(balloon_init
);
435 static void balloon_exit(void)
437 /* XXX - release balloon here */
441 module_exit(balloon_exit
);
443 #define BALLOON_SHOW(name, format, args...) \
444 static ssize_t show_##name(struct sys_device *dev, \
445 struct sysdev_attribute *attr, \
448 return sprintf(buf, format, ##args); \
450 static SYSDEV_ATTR(name, S_IRUGO, show_##name, NULL)
452 BALLOON_SHOW(current_kb
, "%lu\n", PAGES2KB(balloon_stats
.current_pages
));
453 BALLOON_SHOW(low_kb
, "%lu\n", PAGES2KB(balloon_stats
.balloon_low
));
454 BALLOON_SHOW(high_kb
, "%lu\n", PAGES2KB(balloon_stats
.balloon_high
));
455 BALLOON_SHOW(driver_kb
, "%lu\n", PAGES2KB(balloon_stats
.driver_pages
));
457 static ssize_t
show_target_kb(struct sys_device
*dev
, struct sysdev_attribute
*attr
,
460 return sprintf(buf
, "%lu\n", PAGES2KB(balloon_stats
.target_pages
));
463 static ssize_t
store_target_kb(struct sys_device
*dev
,
464 struct sysdev_attribute
*attr
,
469 unsigned long long target_bytes
;
471 if (!capable(CAP_SYS_ADMIN
))
474 target_bytes
= simple_strtoull(buf
, &endchar
, 0) * 1024;
476 balloon_set_new_target(target_bytes
>> PAGE_SHIFT
);
481 static SYSDEV_ATTR(target_kb
, S_IRUGO
| S_IWUSR
,
482 show_target_kb
, store_target_kb
);
485 static ssize_t
show_target(struct sys_device
*dev
, struct sysdev_attribute
*attr
,
488 return sprintf(buf
, "%llu\n",
489 (unsigned long long)balloon_stats
.target_pages
493 static ssize_t
store_target(struct sys_device
*dev
,
494 struct sysdev_attribute
*attr
,
499 unsigned long long target_bytes
;
501 if (!capable(CAP_SYS_ADMIN
))
504 target_bytes
= memparse(buf
, &endchar
);
506 balloon_set_new_target(target_bytes
>> PAGE_SHIFT
);
511 static SYSDEV_ATTR(target
, S_IRUGO
| S_IWUSR
,
512 show_target
, store_target
);
515 static struct sysdev_attribute
*balloon_attrs
[] = {
520 static struct attribute
*balloon_info_attrs
[] = {
521 &attr_current_kb
.attr
,
524 &attr_driver_kb
.attr
,
528 static struct attribute_group balloon_info_group
= {
530 .attrs
= balloon_info_attrs
,
533 static struct sysdev_class balloon_sysdev_class
= {
534 .name
= BALLOON_CLASS_NAME
,
537 static int register_balloon(struct sys_device
*sysdev
)
541 error
= sysdev_class_register(&balloon_sysdev_class
);
546 sysdev
->cls
= &balloon_sysdev_class
;
548 error
= sysdev_register(sysdev
);
550 sysdev_class_unregister(&balloon_sysdev_class
);
554 for (i
= 0; i
< ARRAY_SIZE(balloon_attrs
); i
++) {
555 error
= sysdev_create_file(sysdev
, balloon_attrs
[i
]);
560 error
= sysfs_create_group(&sysdev
->kobj
, &balloon_info_group
);
568 sysdev_remove_file(sysdev
, balloon_attrs
[i
]);
569 sysdev_unregister(sysdev
);
570 sysdev_class_unregister(&balloon_sysdev_class
);
574 MODULE_LICENSE("GPL");