1 /******************************************************************************
2 * Xen balloon driver - enables returning/claiming memory to/from Xen.
4 * Copyright (c) 2003, B Dragovic
5 * Copyright (c) 2003-2004, M Williamson, K Fraser
6 * Copyright (c) 2005 Dan M. Smith, IBM Corporation
7 * Copyright (c) 2010 Daniel Kiper
9 * Memory hotplug support was written by Daniel Kiper. Work on
10 * it was sponsored by Google under Google Summer of Code 2010
11 * program. Jeremy Fitzhardinge from Citrix was the mentor for
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License version 2
16 * as published by the Free Software Foundation; or, when distributed
17 * separately from the Linux kernel or incorporated into other
18 * software packages, subject to the following license:
20 * Permission is hereby granted, free of charge, to any person obtaining a copy
21 * of this source file (the "Software"), to deal in the Software without
22 * restriction, including without limitation the rights to use, copy, modify,
23 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
24 * and to permit persons to whom the Software is furnished to do so, subject to
25 * the following conditions:
27 * The above copyright notice and this permission notice shall be included in
28 * all copies or substantial portions of the Software.
30 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
33 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
34 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
35 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
39 #define pr_fmt(fmt) "xen:" KBUILD_MODNAME ": " fmt
41 #include <linux/cpu.h>
42 #include <linux/kernel.h>
43 #include <linux/sched.h>
44 #include <linux/cred.h>
45 #include <linux/errno.h>
46 #include <linux/freezer.h>
47 #include <linux/kthread.h>
49 #include <linux/memblock.h>
50 #include <linux/pagemap.h>
51 #include <linux/highmem.h>
52 #include <linux/mutex.h>
53 #include <linux/list.h>
54 #include <linux/gfp.h>
55 #include <linux/notifier.h>
56 #include <linux/memory.h>
57 #include <linux/memory_hotplug.h>
58 #include <linux/percpu-defs.h>
59 #include <linux/slab.h>
60 #include <linux/sysctl.h>
61 #include <linux/moduleparam.h>
66 #include <asm/xen/hypervisor.h>
67 #include <asm/xen/hypercall.h>
70 #include <xen/interface/xen.h>
71 #include <xen/interface/memory.h>
72 #include <xen/balloon.h>
73 #include <xen/features.h>
75 #include <xen/mem-reservation.h>
77 #undef MODULE_PARAM_PREFIX
78 #define MODULE_PARAM_PREFIX "xen."
80 static uint __read_mostly balloon_boot_timeout = 180;
81 module_param(balloon_boot_timeout, uint, 0444);
83 #ifdef CONFIG_XEN_BALLOON_MEMORY_HOTPLUG
84 static int xen_hotplug_unpopulated;
86 static struct ctl_table balloon_table[] = {
88 .procname = "hotplug_unpopulated",
89 .data = &xen_hotplug_unpopulated,
90 .maxlen = sizeof(int),
92 .proc_handler = proc_dointvec_minmax,
93 .extra1 = SYSCTL_ZERO,
99 static struct ctl_table balloon_root[] = {
101 .procname = "balloon",
103 .child = balloon_table,
108 static struct ctl_table xen_root[] = {
112 .child = balloon_root,
118 #define xen_hotplug_unpopulated 0
122 * Use one extent per PAGE_SIZE to avoid to break down the page into
125 #define EXTENT_ORDER (fls(XEN_PFN_PER_PAGE) - 1)
128 * balloon_thread() state:
130 * BP_DONE: done or nothing to do,
131 * BP_WAIT: wait to be rescheduled,
132 * BP_EAGAIN: error, go to sleep,
133 * BP_ECANCELED: error, balloon operation canceled.
136 static enum bp_state {
141 } balloon_state = BP_DONE;
143 /* Main waiting point for xen-balloon thread. */
144 static DECLARE_WAIT_QUEUE_HEAD(balloon_thread_wq);
146 static DEFINE_MUTEX(balloon_mutex);
148 struct balloon_stats balloon_stats;
149 EXPORT_SYMBOL_GPL(balloon_stats);
151 /* We increase/decrease in batches which fit in a page */
152 static xen_pfn_t frame_list[PAGE_SIZE / sizeof(xen_pfn_t)];
155 /* List of ballooned pages, threaded through the mem_map array. */
156 static LIST_HEAD(ballooned_pages);
157 static DECLARE_WAIT_QUEUE_HEAD(balloon_wq);
159 /* When ballooning out (allocating memory to return to Xen) we don't really
160 want the kernel to try too hard since that can trigger the oom killer. */
161 #define GFP_BALLOON \
162 (GFP_HIGHUSER | __GFP_NOWARN | __GFP_NORETRY | __GFP_NOMEMALLOC)
164 /* balloon_append: add the given page to the balloon. */
165 static void balloon_append(struct page *page)
167 __SetPageOffline(page);
169 /* Lowmem is re-populated first, so highmem pages go at list tail. */
170 if (PageHighMem(page)) {
171 list_add_tail(&page->lru, &ballooned_pages);
172 balloon_stats.balloon_high++;
174 list_add(&page->lru, &ballooned_pages);
175 balloon_stats.balloon_low++;
177 wake_up(&balloon_wq);
180 /* balloon_retrieve: rescue a page from the balloon, if it is not empty. */
181 static struct page *balloon_retrieve(bool require_lowmem)
185 if (list_empty(&ballooned_pages))
188 page = list_entry(ballooned_pages.next, struct page, lru);
189 if (require_lowmem && PageHighMem(page))
191 list_del(&page->lru);
193 if (PageHighMem(page))
194 balloon_stats.balloon_high--;
196 balloon_stats.balloon_low--;
198 __ClearPageOffline(page);
202 static struct page *balloon_next_page(struct page *page)
204 struct list_head *next = page->lru.next;
205 if (next == &ballooned_pages)
207 return list_entry(next, struct page, lru);
210 static void update_schedule(void)
212 if (balloon_state == BP_WAIT || balloon_state == BP_ECANCELED)
215 if (balloon_state == BP_DONE) {
216 balloon_stats.schedule_delay = 1;
217 balloon_stats.retry_count = 1;
221 ++balloon_stats.retry_count;
223 if (balloon_stats.max_retry_count != RETRY_UNLIMITED &&
224 balloon_stats.retry_count > balloon_stats.max_retry_count) {
225 balloon_stats.schedule_delay = 1;
226 balloon_stats.retry_count = 1;
227 balloon_state = BP_ECANCELED;
231 balloon_stats.schedule_delay <<= 1;
233 if (balloon_stats.schedule_delay > balloon_stats.max_schedule_delay)
234 balloon_stats.schedule_delay = balloon_stats.max_schedule_delay;
236 balloon_state = BP_EAGAIN;
239 #ifdef CONFIG_XEN_BALLOON_MEMORY_HOTPLUG
240 static void release_memory_resource(struct resource *resource)
246 * No need to reset region to identity mapped since we now
247 * know that no I/O can be in this region
249 release_resource(resource);
253 static struct resource *additional_memory_resource(phys_addr_t size)
255 struct resource *res;
258 res = kzalloc(sizeof(*res), GFP_KERNEL);
262 res->name = "System RAM";
263 res->flags = IORESOURCE_SYSTEM_RAM | IORESOURCE_BUSY;
265 ret = allocate_resource(&iomem_resource, res,
267 PAGES_PER_SECTION * PAGE_SIZE, NULL, NULL);
269 pr_err("Cannot allocate new System RAM resource\n");
277 static enum bp_state reserve_additional_memory(void)
280 struct resource *resource;
282 unsigned long balloon_hotplug;
284 credit = balloon_stats.target_pages + balloon_stats.target_unpopulated
285 - balloon_stats.total_pages;
288 * Already hotplugged enough pages? Wait for them to be
294 balloon_hotplug = round_up(credit, PAGES_PER_SECTION);
296 resource = additional_memory_resource(balloon_hotplug * PAGE_SIZE);
300 nid = memory_add_physaddr_to_nid(resource->start);
302 #ifdef CONFIG_XEN_HAVE_PVMMU
304 * We don't support PV MMU when Linux and Xen is using
305 * different page granularity.
307 BUILD_BUG_ON(XEN_PAGE_SIZE != PAGE_SIZE);
310 * add_memory() will build page tables for the new memory so
311 * the p2m must contain invalid entries so the correct
312 * non-present PTEs will be written.
314 * If a failure occurs, the original (identity) p2m entries
315 * are not restored since this region is now known not to
316 * conflict with any devices.
318 if (!xen_feature(XENFEAT_auto_translated_physmap)) {
319 unsigned long pfn, i;
321 pfn = PFN_DOWN(resource->start);
322 for (i = 0; i < balloon_hotplug; i++) {
323 if (!set_phys_to_machine(pfn + i, INVALID_P2M_ENTRY)) {
324 pr_warn("set_phys_to_machine() failed, no memory added\n");
332 * add_memory_resource() will call online_pages() which in its turn
333 * will call xen_online_page() callback causing deadlock if we don't
334 * release balloon_mutex here. Unlocking here is safe because the
335 * callers drop the mutex before trying again.
337 mutex_unlock(&balloon_mutex);
338 /* add_memory_resource() requires the device_hotplug lock */
339 lock_device_hotplug();
340 rc = add_memory_resource(nid, resource, MHP_MERGE_RESOURCE);
341 unlock_device_hotplug();
342 mutex_lock(&balloon_mutex);
345 pr_warn("Cannot add additional memory (%i)\n", rc);
349 balloon_stats.total_pages += balloon_hotplug;
353 release_memory_resource(resource);
357 static void xen_online_page(struct page *page, unsigned int order)
359 unsigned long i, size = (1 << order);
360 unsigned long start_pfn = page_to_pfn(page);
363 pr_debug("Online %lu pages starting at pfn 0x%lx\n", size, start_pfn);
364 mutex_lock(&balloon_mutex);
365 for (i = 0; i < size; i++) {
366 p = pfn_to_page(start_pfn + i);
369 mutex_unlock(&balloon_mutex);
372 static int xen_memory_notifier(struct notifier_block *nb, unsigned long val, void *v)
374 if (val == MEM_ONLINE)
375 wake_up(&balloon_thread_wq);
380 static struct notifier_block xen_memory_nb = {
381 .notifier_call = xen_memory_notifier,
385 static enum bp_state reserve_additional_memory(void)
387 balloon_stats.target_pages = balloon_stats.current_pages +
388 balloon_stats.target_unpopulated;
391 #endif /* CONFIG_XEN_BALLOON_MEMORY_HOTPLUG */
393 static long current_credit(void)
395 return balloon_stats.target_pages - balloon_stats.current_pages;
398 static bool balloon_is_inflated(void)
400 return balloon_stats.balloon_low || balloon_stats.balloon_high;
403 static enum bp_state increase_reservation(unsigned long nr_pages)
409 if (nr_pages > ARRAY_SIZE(frame_list))
410 nr_pages = ARRAY_SIZE(frame_list);
412 page = list_first_entry_or_null(&ballooned_pages, struct page, lru);
413 for (i = 0; i < nr_pages; i++) {
419 frame_list[i] = page_to_xen_pfn(page);
420 page = balloon_next_page(page);
423 rc = xenmem_reservation_increase(nr_pages, frame_list);
427 for (i = 0; i < rc; i++) {
428 page = balloon_retrieve(false);
429 BUG_ON(page == NULL);
431 xenmem_reservation_va_mapping_update(1, &page, &frame_list[i]);
433 /* Relinquish the page back to the allocator. */
434 free_reserved_page(page);
437 balloon_stats.current_pages += rc;
442 static enum bp_state decrease_reservation(unsigned long nr_pages, gfp_t gfp)
444 enum bp_state state = BP_DONE;
446 struct page *page, *tmp;
450 if (nr_pages > ARRAY_SIZE(frame_list))
451 nr_pages = ARRAY_SIZE(frame_list);
453 for (i = 0; i < nr_pages; i++) {
454 page = alloc_page(gfp);
460 adjust_managed_page_count(page, -1);
461 xenmem_reservation_scrub_page(page);
462 list_add(&page->lru, &pages);
466 * Ensure that ballooned highmem pages don't have kmaps.
468 * Do this before changing the p2m as kmap_flush_unused()
469 * reads PTEs to obtain pages (and hence needs the original
475 * Setup the frame, update direct mapping, invalidate P2M,
476 * and add to balloon.
479 list_for_each_entry_safe(page, tmp, &pages, lru) {
480 frame_list[i++] = xen_page_to_gfn(page);
482 xenmem_reservation_va_mapping_reset(1, &page);
484 list_del(&page->lru);
486 balloon_append(page);
491 ret = xenmem_reservation_decrease(nr_pages, frame_list);
492 BUG_ON(ret != nr_pages);
494 balloon_stats.current_pages -= nr_pages;
500 * Stop waiting if either state is BP_DONE and ballooning action is
501 * needed, or if the credit has changed while state is not BP_DONE.
503 static bool balloon_thread_cond(long credit)
505 if (balloon_state == BP_DONE)
508 return current_credit() != credit || kthread_should_stop();
512 * As this is a kthread it is guaranteed to run as a single instance only.
513 * We may of course race updates of the target counts (which are protected
514 * by the balloon lock), or with changes to the Xen hard limit, but we will
515 * recover from these in time.
517 static int balloon_thread(void *unused)
520 unsigned long timeout;
524 switch (balloon_state) {
530 timeout = balloon_stats.schedule_delay * HZ;
537 credit = current_credit();
539 wait_event_freezable_timeout(balloon_thread_wq,
540 balloon_thread_cond(credit), timeout);
542 if (kthread_should_stop())
545 mutex_lock(&balloon_mutex);
547 credit = current_credit();
550 if (balloon_is_inflated())
551 balloon_state = increase_reservation(credit);
553 balloon_state = reserve_additional_memory();
559 n_pages = min(-credit, si_mem_available());
560 balloon_state = decrease_reservation(n_pages,
562 if (balloon_state == BP_DONE && n_pages != -credit &&
563 n_pages < totalreserve_pages)
564 balloon_state = BP_EAGAIN;
569 mutex_unlock(&balloon_mutex);
575 /* Resets the Xen limit, sets new target, and kicks off processing. */
576 void balloon_set_new_target(unsigned long target)
578 /* No need for lock. Not read-modify-write updates. */
579 balloon_stats.target_pages = target;
580 wake_up(&balloon_thread_wq);
582 EXPORT_SYMBOL_GPL(balloon_set_new_target);
584 #ifndef CONFIG_XEN_UNPOPULATED_ALLOC
585 static int add_ballooned_pages(unsigned int nr_pages)
589 if (xen_hotplug_unpopulated) {
590 st = reserve_additional_memory();
591 if (st != BP_ECANCELED) {
594 mutex_unlock(&balloon_mutex);
595 rc = wait_event_interruptible(balloon_wq,
596 !list_empty(&ballooned_pages));
597 mutex_lock(&balloon_mutex);
598 return rc ? -ENOMEM : 0;
602 if (si_mem_available() < nr_pages)
605 st = decrease_reservation(nr_pages, GFP_USER);
613 * xen_alloc_unpopulated_pages - get pages that have been ballooned out
614 * @nr_pages: Number of pages to get
615 * @pages: pages returned
616 * @return 0 on success, error otherwise
618 int xen_alloc_unpopulated_pages(unsigned int nr_pages, struct page **pages)
620 unsigned int pgno = 0;
624 mutex_lock(&balloon_mutex);
626 balloon_stats.target_unpopulated += nr_pages;
628 while (pgno < nr_pages) {
629 page = balloon_retrieve(true);
631 pages[pgno++] = page;
632 #ifdef CONFIG_XEN_HAVE_PVMMU
634 * We don't support PV MMU when Linux and Xen is using
635 * different page granularity.
637 BUILD_BUG_ON(XEN_PAGE_SIZE != PAGE_SIZE);
639 if (!xen_feature(XENFEAT_auto_translated_physmap)) {
640 ret = xen_alloc_p2m_entry(page_to_pfn(page));
646 ret = add_ballooned_pages(nr_pages - pgno);
651 mutex_unlock(&balloon_mutex);
654 mutex_unlock(&balloon_mutex);
655 xen_free_unpopulated_pages(pgno, pages);
657 * NB: free_xenballooned_pages will only subtract pgno pages, but since
658 * target_unpopulated is incremented with nr_pages at the start we need
659 * to remove the remaining ones also, or accounting will be screwed.
661 balloon_stats.target_unpopulated -= nr_pages - pgno;
664 EXPORT_SYMBOL(xen_alloc_unpopulated_pages);
667 * xen_free_unpopulated_pages - return pages retrieved with get_ballooned_pages
668 * @nr_pages: Number of pages
669 * @pages: pages to return
671 void xen_free_unpopulated_pages(unsigned int nr_pages, struct page **pages)
675 mutex_lock(&balloon_mutex);
677 for (i = 0; i < nr_pages; i++) {
679 balloon_append(pages[i]);
682 balloon_stats.target_unpopulated -= nr_pages;
684 /* The balloon may be too large now. Shrink it if needed. */
685 if (current_credit())
686 wake_up(&balloon_thread_wq);
688 mutex_unlock(&balloon_mutex);
690 EXPORT_SYMBOL(xen_free_unpopulated_pages);
692 #if defined(CONFIG_XEN_PV)
693 static void __init balloon_add_region(unsigned long start_pfn,
696 unsigned long pfn, extra_pfn_end;
699 * If the amount of usable memory has been limited (e.g., with
700 * the 'mem' command line parameter), don't add pages beyond
703 extra_pfn_end = min(max_pfn, start_pfn + pages);
705 for (pfn = start_pfn; pfn < extra_pfn_end; pfn++) {
706 /* totalram_pages and totalhigh_pages do not
707 include the boot-time balloon extension, so
708 don't subtract from it. */
709 balloon_append(pfn_to_page(pfn));
712 balloon_stats.total_pages += extra_pfn_end - start_pfn;
717 static int __init balloon_init(void)
719 struct task_struct *task;
724 pr_info("Initialising balloon driver\n");
727 balloon_stats.current_pages = xen_pv_domain()
728 ? min(xen_start_info->nr_pages - xen_released_pages, max_pfn)
729 : get_num_physpages();
731 balloon_stats.current_pages = get_num_physpages();
733 balloon_stats.target_pages = balloon_stats.current_pages;
734 balloon_stats.balloon_low = 0;
735 balloon_stats.balloon_high = 0;
736 balloon_stats.total_pages = balloon_stats.current_pages;
738 balloon_stats.schedule_delay = 1;
739 balloon_stats.max_schedule_delay = 32;
740 balloon_stats.retry_count = 1;
741 balloon_stats.max_retry_count = 4;
743 #ifdef CONFIG_XEN_BALLOON_MEMORY_HOTPLUG
744 set_online_page_callback(&xen_online_page);
745 register_memory_notifier(&xen_memory_nb);
746 register_sysctl_table(xen_root);
749 #if defined(CONFIG_XEN_PV) && !defined(CONFIG_XEN_UNPOPULATED_ALLOC)
754 * Initialize the balloon with pages from the extra memory
755 * regions (see arch/x86/xen/setup.c).
757 for (i = 0; i < XEN_EXTRA_MEM_MAX_REGIONS; i++)
758 if (xen_extra_mem[i].n_pfns)
759 balloon_add_region(xen_extra_mem[i].start_pfn,
760 xen_extra_mem[i].n_pfns);
764 task = kthread_run(balloon_thread, NULL, "xen-balloon");
766 pr_err("xen-balloon thread could not be started, ballooning will not work!\n");
767 return PTR_ERR(task);
770 /* Init the xen-balloon driver. */
775 subsys_initcall(balloon_init);
777 static int __init balloon_wait_finish(void)
779 long credit, last_credit = 0;
780 unsigned long last_changed = 0;
785 /* PV guests don't need to wait. */
786 if (xen_pv_domain() || !current_credit())
789 pr_notice("Waiting for initial ballooning down having finished.\n");
791 while ((credit = current_credit()) < 0) {
792 if (credit != last_credit) {
793 last_changed = jiffies;
794 last_credit = credit;
796 if (balloon_state == BP_ECANCELED) {
797 pr_warn_once("Initial ballooning failed, %ld pages need to be freed.\n",
799 if (jiffies - last_changed >= HZ * balloon_boot_timeout)
800 panic("Initial ballooning failed!\n");
803 schedule_timeout_interruptible(HZ / 10);
806 pr_notice("Initial ballooning down finished.\n");
810 late_initcall_sync(balloon_wait_finish);