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/highmem.h>
45 #include <linux/list.h>
46 #include <linux/sysdev.h>
48 #include <asm/xen/hypervisor.h>
50 #include <asm/pgalloc.h>
51 #include <asm/pgtable.h>
52 #include <asm/uaccess.h>
55 #include <xen/interface/memory.h>
56 #include <xen/xenbus.h>
57 #include <xen/features.h>
60 #define PAGES2KB(_p) ((_p)<<(PAGE_SHIFT-10))
62 #define BALLOON_CLASS_NAME "xen_memory"
64 struct balloon_stats
{
65 /* We aim for 'current allocation' == 'target allocation'. */
66 unsigned long current_pages
;
67 unsigned long target_pages
;
68 /* We may hit the hard limit in Xen. If we do then we remember it. */
69 unsigned long hard_limit
;
71 * Drivers may alter the memory reservation independently, but they
72 * must inform the balloon driver so we avoid hitting the hard limit.
74 unsigned long driver_pages
;
75 /* Number of pages in high- and low-memory balloons. */
76 unsigned long balloon_low
;
77 unsigned long balloon_high
;
80 static DEFINE_MUTEX(balloon_mutex
);
82 static struct sys_device balloon_sysdev
;
84 static int register_balloon(struct sys_device
*sysdev
);
87 * Protects atomic reservation decrease/increase against concurrent increases.
88 * Also protects non-atomic updates of current_pages and driver_pages, and
91 static DEFINE_SPINLOCK(balloon_lock
);
93 static struct balloon_stats balloon_stats
;
95 /* We increase/decrease in batches which fit in a page */
96 static unsigned long frame_list
[PAGE_SIZE
/ sizeof(unsigned long)];
98 /* VM /proc information for memory */
99 extern unsigned long totalram_pages
;
101 #ifdef CONFIG_HIGHMEM
102 extern unsigned long totalhigh_pages
;
103 #define inc_totalhigh_pages() (totalhigh_pages++)
104 #define dec_totalhigh_pages() (totalhigh_pages--)
106 #define inc_totalhigh_pages() do {} while(0)
107 #define dec_totalhigh_pages() do {} while(0)
110 /* List of ballooned pages, threaded through the mem_map array. */
111 static LIST_HEAD(ballooned_pages
);
113 /* Main work function, always executed in process context. */
114 static void balloon_process(struct work_struct
*work
);
115 static DECLARE_WORK(balloon_worker
, balloon_process
);
116 static struct timer_list balloon_timer
;
118 /* When ballooning out (allocating memory to return to Xen) we don't really
119 want the kernel to try too hard since that can trigger the oom killer. */
120 #define GFP_BALLOON \
121 (GFP_HIGHUSER | __GFP_NOWARN | __GFP_NORETRY | __GFP_NOMEMALLOC)
123 static void scrub_page(struct page
*page
)
125 #ifdef CONFIG_XEN_SCRUB_PAGES
126 if (PageHighMem(page
)) {
127 void *v
= kmap(page
);
131 void *v
= page_address(page
);
137 /* balloon_append: add the given page to the balloon. */
138 static void balloon_append(struct page
*page
)
140 /* Lowmem is re-populated first, so highmem pages go at list tail. */
141 if (PageHighMem(page
)) {
142 list_add_tail(&page
->lru
, &ballooned_pages
);
143 balloon_stats
.balloon_high
++;
144 dec_totalhigh_pages();
146 list_add(&page
->lru
, &ballooned_pages
);
147 balloon_stats
.balloon_low
++;
151 /* balloon_retrieve: rescue a page from the balloon, if it is not empty. */
152 static struct page
*balloon_retrieve(void)
156 if (list_empty(&ballooned_pages
))
159 page
= list_entry(ballooned_pages
.next
, struct page
, lru
);
160 list_del(&page
->lru
);
162 if (PageHighMem(page
)) {
163 balloon_stats
.balloon_high
--;
164 inc_totalhigh_pages();
167 balloon_stats
.balloon_low
--;
172 static struct page
*balloon_first_page(void)
174 if (list_empty(&ballooned_pages
))
176 return list_entry(ballooned_pages
.next
, struct page
, lru
);
179 static struct page
*balloon_next_page(struct page
*page
)
181 struct list_head
*next
= page
->lru
.next
;
182 if (next
== &ballooned_pages
)
184 return list_entry(next
, struct page
, lru
);
187 static void balloon_alarm(unsigned long unused
)
189 schedule_work(&balloon_worker
);
192 static unsigned long current_target(void)
194 unsigned long target
= min(balloon_stats
.target_pages
, balloon_stats
.hard_limit
);
197 balloon_stats
.current_pages
+
198 balloon_stats
.balloon_low
+
199 balloon_stats
.balloon_high
);
204 static int increase_reservation(unsigned long nr_pages
)
206 unsigned long pfn
, i
, flags
;
209 struct xen_memory_reservation reservation
= {
215 if (nr_pages
> ARRAY_SIZE(frame_list
))
216 nr_pages
= ARRAY_SIZE(frame_list
);
218 spin_lock_irqsave(&balloon_lock
, flags
);
220 page
= balloon_first_page();
221 for (i
= 0; i
< nr_pages
; i
++) {
222 BUG_ON(page
== NULL
);
223 frame_list
[i
] = page_to_pfn(page
);;
224 page
= balloon_next_page(page
);
227 set_xen_guest_handle(reservation
.extent_start
, frame_list
);
228 reservation
.nr_extents
= nr_pages
;
229 rc
= HYPERVISOR_memory_op(XENMEM_populate_physmap
, &reservation
);
234 /* We hit the Xen hard limit: reprobe. */
235 reservation
.nr_extents
= rc
;
236 ret
= HYPERVISOR_memory_op(XENMEM_decrease_reservation
,
241 balloon_stats
.hard_limit
= (balloon_stats
.current_pages
+ rc
-
242 balloon_stats
.driver_pages
);
246 for (i
= 0; i
< nr_pages
; i
++) {
247 page
= balloon_retrieve();
248 BUG_ON(page
== NULL
);
250 pfn
= page_to_pfn(page
);
251 BUG_ON(!xen_feature(XENFEAT_auto_translated_physmap
) &&
252 phys_to_machine_mapping_valid(pfn
));
254 set_phys_to_machine(pfn
, frame_list
[i
]);
256 /* Link back into the page tables if not highmem. */
257 if (pfn
< max_low_pfn
) {
259 ret
= HYPERVISOR_update_va_mapping(
260 (unsigned long)__va(pfn
<< PAGE_SHIFT
),
261 mfn_pte(frame_list
[i
], PAGE_KERNEL
),
266 /* Relinquish the page back to the allocator. */
267 ClearPageReserved(page
);
268 init_page_count(page
);
272 balloon_stats
.current_pages
+= nr_pages
;
273 totalram_pages
= balloon_stats
.current_pages
;
276 spin_unlock_irqrestore(&balloon_lock
, flags
);
281 static int decrease_reservation(unsigned long nr_pages
)
283 unsigned long pfn
, i
, flags
;
287 struct xen_memory_reservation reservation
= {
293 if (nr_pages
> ARRAY_SIZE(frame_list
))
294 nr_pages
= ARRAY_SIZE(frame_list
);
296 for (i
= 0; i
< nr_pages
; i
++) {
297 if ((page
= alloc_page(GFP_BALLOON
)) == NULL
) {
303 pfn
= page_to_pfn(page
);
304 frame_list
[i
] = pfn_to_mfn(pfn
);
309 /* Ensure that ballooned highmem pages don't have kmaps. */
313 spin_lock_irqsave(&balloon_lock
, flags
);
315 /* No more mappings: invalidate P2M and add to balloon. */
316 for (i
= 0; i
< nr_pages
; i
++) {
317 pfn
= mfn_to_pfn(frame_list
[i
]);
318 set_phys_to_machine(pfn
, INVALID_P2M_ENTRY
);
319 balloon_append(pfn_to_page(pfn
));
322 set_xen_guest_handle(reservation
.extent_start
, frame_list
);
323 reservation
.nr_extents
= nr_pages
;
324 ret
= HYPERVISOR_memory_op(XENMEM_decrease_reservation
, &reservation
);
325 BUG_ON(ret
!= nr_pages
);
327 balloon_stats
.current_pages
-= nr_pages
;
328 totalram_pages
= balloon_stats
.current_pages
;
330 spin_unlock_irqrestore(&balloon_lock
, flags
);
336 * We avoid multiple worker processes conflicting via the balloon mutex.
337 * We may of course race updates of the target counts (which are protected
338 * by the balloon lock), or with changes to the Xen hard limit, but we will
339 * recover from these in time.
341 static void balloon_process(struct work_struct
*work
)
346 mutex_lock(&balloon_mutex
);
349 credit
= current_target() - balloon_stats
.current_pages
;
351 need_sleep
= (increase_reservation(credit
) != 0);
353 need_sleep
= (decrease_reservation(-credit
) != 0);
355 #ifndef CONFIG_PREEMPT
359 } while ((credit
!= 0) && !need_sleep
);
361 /* Schedule more work if there is some still to be done. */
362 if (current_target() != balloon_stats
.current_pages
)
363 mod_timer(&balloon_timer
, jiffies
+ HZ
);
365 mutex_unlock(&balloon_mutex
);
368 /* Resets the Xen limit, sets new target, and kicks off processing. */
369 static void balloon_set_new_target(unsigned long target
)
371 /* No need for lock. Not read-modify-write updates. */
372 balloon_stats
.hard_limit
= ~0UL;
373 balloon_stats
.target_pages
= target
;
374 schedule_work(&balloon_worker
);
377 static struct xenbus_watch target_watch
=
379 .node
= "memory/target"
382 /* React to a change in the target key */
383 static void watch_target(struct xenbus_watch
*watch
,
384 const char **vec
, unsigned int len
)
386 unsigned long long new_target
;
389 err
= xenbus_scanf(XBT_NIL
, "memory", "target", "%llu", &new_target
);
391 /* This is ok (for domain0 at least) - so just return */
395 /* The given memory/target value is in KiB, so it needs converting to
396 * pages. PAGE_SHIFT converts bytes to pages, hence PAGE_SHIFT - 10.
398 balloon_set_new_target(new_target
>> (PAGE_SHIFT
- 10));
401 static int balloon_init_watcher(struct notifier_block
*notifier
,
407 err
= register_xenbus_watch(&target_watch
);
409 printk(KERN_ERR
"Failed to set balloon watcher\n");
414 static struct notifier_block xenstore_notifier
;
416 static int __init
balloon_init(void)
421 if (!xen_pv_domain())
424 pr_info("xen_balloon: Initialising balloon driver.\n");
426 balloon_stats
.current_pages
= min(xen_start_info
->nr_pages
, max_pfn
);
427 totalram_pages
= balloon_stats
.current_pages
;
428 balloon_stats
.target_pages
= balloon_stats
.current_pages
;
429 balloon_stats
.balloon_low
= 0;
430 balloon_stats
.balloon_high
= 0;
431 balloon_stats
.driver_pages
= 0UL;
432 balloon_stats
.hard_limit
= ~0UL;
434 init_timer(&balloon_timer
);
435 balloon_timer
.data
= 0;
436 balloon_timer
.function
= balloon_alarm
;
438 register_balloon(&balloon_sysdev
);
440 /* Initialise the balloon with excess memory space. */
441 for (pfn
= xen_start_info
->nr_pages
; pfn
< max_pfn
; pfn
++) {
442 page
= pfn_to_page(pfn
);
443 if (!PageReserved(page
))
444 balloon_append(page
);
447 target_watch
.callback
= watch_target
;
448 xenstore_notifier
.notifier_call
= balloon_init_watcher
;
450 register_xenstore_notifier(&xenstore_notifier
);
455 subsys_initcall(balloon_init
);
457 static void balloon_exit(void)
459 /* XXX - release balloon here */
463 module_exit(balloon_exit
);
465 #define BALLOON_SHOW(name, format, args...) \
466 static ssize_t show_##name(struct sys_device *dev, \
467 struct sysdev_attribute *attr, \
470 return sprintf(buf, format, ##args); \
472 static SYSDEV_ATTR(name, S_IRUGO, show_##name, NULL)
474 BALLOON_SHOW(current_kb
, "%lu\n", PAGES2KB(balloon_stats
.current_pages
));
475 BALLOON_SHOW(low_kb
, "%lu\n", PAGES2KB(balloon_stats
.balloon_low
));
476 BALLOON_SHOW(high_kb
, "%lu\n", PAGES2KB(balloon_stats
.balloon_high
));
477 BALLOON_SHOW(hard_limit_kb
,
478 (balloon_stats
.hard_limit
!=~0UL) ? "%lu\n" : "???\n",
479 (balloon_stats
.hard_limit
!=~0UL) ? PAGES2KB(balloon_stats
.hard_limit
) : 0);
480 BALLOON_SHOW(driver_kb
, "%lu\n", PAGES2KB(balloon_stats
.driver_pages
));
482 static ssize_t
show_target_kb(struct sys_device
*dev
, struct sysdev_attribute
*attr
,
485 return sprintf(buf
, "%lu\n", PAGES2KB(balloon_stats
.target_pages
));
488 static ssize_t
store_target_kb(struct sys_device
*dev
,
489 struct sysdev_attribute
*attr
,
494 unsigned long long target_bytes
;
496 if (!capable(CAP_SYS_ADMIN
))
499 target_bytes
= memparse(buf
, &endchar
);
501 balloon_set_new_target(target_bytes
>> PAGE_SHIFT
);
506 static SYSDEV_ATTR(target_kb
, S_IRUGO
| S_IWUSR
,
507 show_target_kb
, store_target_kb
);
509 static struct sysdev_attribute
*balloon_attrs
[] = {
513 static struct attribute
*balloon_info_attrs
[] = {
514 &attr_current_kb
.attr
,
517 &attr_hard_limit_kb
.attr
,
518 &attr_driver_kb
.attr
,
522 static struct attribute_group balloon_info_group
= {
524 .attrs
= balloon_info_attrs
,
527 static struct sysdev_class balloon_sysdev_class
= {
528 .name
= BALLOON_CLASS_NAME
,
531 static int register_balloon(struct sys_device
*sysdev
)
535 error
= sysdev_class_register(&balloon_sysdev_class
);
540 sysdev
->cls
= &balloon_sysdev_class
;
542 error
= sysdev_register(sysdev
);
544 sysdev_class_unregister(&balloon_sysdev_class
);
548 for (i
= 0; i
< ARRAY_SIZE(balloon_attrs
); i
++) {
549 error
= sysdev_create_file(sysdev
, balloon_attrs
[i
]);
554 error
= sysfs_create_group(&sysdev
->kobj
, &balloon_info_group
);
562 sysdev_remove_file(sysdev
, balloon_attrs
[i
]);
563 sysdev_unregister(sysdev
);
564 sysdev_class_unregister(&balloon_sysdev_class
);
568 MODULE_LICENSE("GPL");