2 * Collaborative memory management interface.
4 * Copyright (C) 2008 IBM Corporation
5 * Author(s): Brian King (brking@linux.vnet.ibm.com),
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/ctype.h>
24 #include <linux/delay.h>
25 #include <linux/errno.h>
27 #include <linux/init.h>
28 #include <linux/kthread.h>
29 #include <linux/module.h>
30 #include <linux/oom.h>
31 #include <linux/sched.h>
32 #include <linux/stringify.h>
33 #include <linux/swap.h>
34 #include <linux/sysdev.h>
35 #include <asm/firmware.h>
36 #include <asm/hvcall.h>
38 #include <asm/pgalloc.h>
39 #include <asm/uaccess.h>
41 #include "plpar_wrappers.h"
43 #define CMM_DRIVER_VERSION "1.0.0"
44 #define CMM_DEFAULT_DELAY 1
47 #define CMM_OOM_KB 1024
48 #define CMM_MIN_MEM_MB 256
49 #define KB2PAGES(_p) ((_p)>>(PAGE_SHIFT-10))
50 #define PAGES2KB(_p) ((_p)<<(PAGE_SHIFT-10))
52 static unsigned int delay = CMM_DEFAULT_DELAY;
53 static unsigned int oom_kb = CMM_OOM_KB;
54 static unsigned int cmm_debug = CMM_DEBUG;
55 static unsigned int cmm_disabled = CMM_DISABLE;
56 static unsigned long min_mem_mb = CMM_MIN_MEM_MB;
57 static struct sys_device cmm_sysdev;
59 MODULE_AUTHOR("Brian King <brking@linux.vnet.ibm.com>");
60 MODULE_DESCRIPTION("IBM System p Collaborative Memory Manager");
61 MODULE_LICENSE("GPL");
62 MODULE_VERSION(CMM_DRIVER_VERSION);
64 module_param_named(delay, delay, uint, S_IRUGO | S_IWUSR);
65 MODULE_PARM_DESC(delay, "Delay (in seconds) between polls to query hypervisor paging requests. "
66 "[Default=" __stringify(CMM_DEFAULT_DELAY) "]");
67 module_param_named(oom_kb, oom_kb, uint, S_IRUGO | S_IWUSR);
68 MODULE_PARM_DESC(oom_kb, "Amount of memory in kb to free on OOM. "
69 "[Default=" __stringify(CMM_OOM_KB) "]");
70 module_param_named(min_mem_mb, min_mem_mb, ulong, S_IRUGO | S_IWUSR);
71 MODULE_PARM_DESC(min_mem_mb, "Minimum amount of memory (in MB) to not balloon. "
72 "[Default=" __stringify(CMM_MIN_MEM_MB) "]");
73 module_param_named(debug, cmm_debug, uint, S_IRUGO | S_IWUSR);
74 MODULE_PARM_DESC(debug, "Enable module debugging logging. Set to 1 to enable. "
75 "[Default=" __stringify(CMM_DEBUG) "]");
77 #define CMM_NR_PAGES ((PAGE_SIZE - sizeof(void *) - sizeof(unsigned long)) / sizeof(unsigned long))
79 #define cmm_dbg(...) if (cmm_debug) { printk(KERN_INFO "cmm: "__VA_ARGS__); }
81 struct cmm_page_array {
82 struct cmm_page_array *next;
84 unsigned long page[CMM_NR_PAGES];
87 static unsigned long loaned_pages;
88 static unsigned long loaned_pages_target;
89 static unsigned long oom_freed_pages;
91 static struct cmm_page_array *cmm_page_list;
92 static DEFINE_SPINLOCK(cmm_lock);
94 static struct task_struct *cmm_thread_ptr;
97 * cmm_alloc_pages - Allocate pages and mark them as loaned
98 * @nr: number of pages to allocate
101 * number of pages requested to be allocated which were not
103 static long cmm_alloc_pages(long nr)
105 struct cmm_page_array *pa, *npa;
109 cmm_dbg("Begin request for %ld pages\n", nr);
112 addr = __get_free_page(GFP_NOIO | __GFP_NOWARN |
113 __GFP_NORETRY | __GFP_NOMEMALLOC);
116 spin_lock(&cmm_lock);
118 if (!pa || pa->index >= CMM_NR_PAGES) {
119 /* Need a new page for the page list. */
120 spin_unlock(&cmm_lock);
121 npa = (struct cmm_page_array *)__get_free_page(GFP_NOIO | __GFP_NOWARN |
122 __GFP_NORETRY | __GFP_NOMEMALLOC);
124 pr_info("%s: Can not allocate new page list\n", __func__);
128 spin_lock(&cmm_lock);
131 if (!pa || pa->index >= CMM_NR_PAGES) {
137 free_page((unsigned long) npa);
140 if ((rc = plpar_page_set_loaned(__pa(addr)))) {
141 pr_err("%s: Can not set page to loaned. rc=%ld\n", __func__, rc);
142 spin_unlock(&cmm_lock);
147 pa->page[pa->index++] = addr;
150 spin_unlock(&cmm_lock);
154 cmm_dbg("End request with %ld pages unfulfilled\n", nr);
159 * cmm_free_pages - Free pages and mark them as active
160 * @nr: number of pages to free
163 * number of pages requested to be freed which were not
165 static long cmm_free_pages(long nr)
167 struct cmm_page_array *pa;
170 cmm_dbg("Begin free of %ld pages.\n", nr);
171 spin_lock(&cmm_lock);
174 if (!pa || pa->index <= 0)
176 addr = pa->page[--pa->index];
178 if (pa->index == 0) {
180 free_page((unsigned long) cmm_page_list);
184 plpar_page_set_active(__pa(addr));
190 spin_unlock(&cmm_lock);
191 cmm_dbg("End request with %ld pages unfulfilled\n", nr);
196 * cmm_oom_notify - OOM notifier
197 * @self: notifier block struct
199 * @parm: returned - number of pages freed
204 static int cmm_oom_notify(struct notifier_block *self,
205 unsigned long dummy, void *parm)
207 unsigned long *freed = parm;
208 long nr = KB2PAGES(oom_kb);
210 cmm_dbg("OOM processing started\n");
211 nr = cmm_free_pages(nr);
212 loaned_pages_target = loaned_pages;
213 *freed += KB2PAGES(oom_kb) - nr;
214 oom_freed_pages += KB2PAGES(oom_kb) - nr;
215 cmm_dbg("OOM processing complete\n");
220 * cmm_get_mpp - Read memory performance parameters
222 * Makes hcall to query the current page loan request from the hypervisor.
227 static void cmm_get_mpp(void)
230 struct hvcall_mpp_data mpp_data;
231 unsigned long active_pages_target;
232 signed long page_loan_request;
234 rc = h_get_mpp(&mpp_data);
239 page_loan_request = div_s64((s64)mpp_data.loan_request, PAGE_SIZE);
240 loaned_pages_target = page_loan_request + loaned_pages;
241 if (loaned_pages_target > oom_freed_pages)
242 loaned_pages_target -= oom_freed_pages;
244 loaned_pages_target = 0;
246 active_pages_target = totalram_pages + loaned_pages - loaned_pages_target;
248 if ((min_mem_mb * 1024 * 1024) > (active_pages_target * PAGE_SIZE))
249 loaned_pages_target = totalram_pages + loaned_pages -
250 ((min_mem_mb * 1024 * 1024) / PAGE_SIZE);
252 cmm_dbg("delta = %ld, loaned = %lu, target = %lu, oom = %lu, totalram = %lu\n",
253 page_loan_request, loaned_pages, loaned_pages_target,
254 oom_freed_pages, totalram_pages);
257 static struct notifier_block cmm_oom_nb = {
258 .notifier_call = cmm_oom_notify
262 * cmm_thread - CMM task thread
268 static int cmm_thread(void *dummy)
270 unsigned long timeleft;
273 timeleft = msleep_interruptible(delay * 1000);
275 if (kthread_should_stop() || timeleft) {
276 loaned_pages_target = loaned_pages;
282 if (loaned_pages_target > loaned_pages) {
283 if (cmm_alloc_pages(loaned_pages_target - loaned_pages))
284 loaned_pages_target = loaned_pages;
285 } else if (loaned_pages_target < loaned_pages)
286 cmm_free_pages(loaned_pages - loaned_pages_target);
291 #define CMM_SHOW(name, format, args...) \
292 static ssize_t show_##name(struct sys_device *dev, \
293 struct sysdev_attribute *attr, \
296 return sprintf(buf, format, ##args); \
298 static SYSDEV_ATTR(name, S_IRUGO, show_##name, NULL)
300 CMM_SHOW(loaned_kb, "%lu\n", PAGES2KB(loaned_pages));
301 CMM_SHOW(loaned_target_kb, "%lu\n", PAGES2KB(loaned_pages_target));
303 static ssize_t show_oom_pages(struct sys_device *dev,
304 struct sysdev_attribute *attr, char *buf)
306 return sprintf(buf, "%lu\n", PAGES2KB(oom_freed_pages));
309 static ssize_t store_oom_pages(struct sys_device *dev,
310 struct sysdev_attribute *attr,
311 const char *buf, size_t count)
313 unsigned long val = simple_strtoul (buf, NULL, 10);
315 if (!capable(CAP_SYS_ADMIN))
324 static SYSDEV_ATTR(oom_freed_kb, S_IWUSR| S_IRUGO,
325 show_oom_pages, store_oom_pages);
327 static struct sysdev_attribute *cmm_attrs[] = {
329 &attr_loaned_target_kb,
333 static struct sysdev_class cmm_sysdev_class = {
338 * cmm_sysfs_register - Register with sysfs
341 * 0 on success / other on failure
343 static int cmm_sysfs_register(struct sys_device *sysdev)
347 if ((rc = sysdev_class_register(&cmm_sysdev_class)))
351 sysdev->cls = &cmm_sysdev_class;
353 if ((rc = sysdev_register(sysdev)))
354 goto class_unregister;
356 for (i = 0; i < ARRAY_SIZE(cmm_attrs); i++) {
357 if ((rc = sysdev_create_file(sysdev, cmm_attrs[i])))
365 sysdev_remove_file(sysdev, cmm_attrs[i]);
366 sysdev_unregister(sysdev);
368 sysdev_class_unregister(&cmm_sysdev_class);
373 * cmm_unregister_sysfs - Unregister from sysfs
376 static void cmm_unregister_sysfs(struct sys_device *sysdev)
380 for (i = 0; i < ARRAY_SIZE(cmm_attrs); i++)
381 sysdev_remove_file(sysdev, cmm_attrs[i]);
382 sysdev_unregister(sysdev);
383 sysdev_class_unregister(&cmm_sysdev_class);
387 * cmm_init - Module initialization
390 * 0 on success / other on failure
392 static int cmm_init(void)
396 if (!firmware_has_feature(FW_FEATURE_CMO))
399 if ((rc = register_oom_notifier(&cmm_oom_nb)) < 0)
402 if ((rc = cmm_sysfs_register(&cmm_sysdev)))
403 goto out_oom_notifier;
408 cmm_thread_ptr = kthread_run(cmm_thread, NULL, "cmmthread");
409 if (IS_ERR(cmm_thread_ptr)) {
410 rc = PTR_ERR(cmm_thread_ptr);
411 goto out_unregister_sysfs;
416 out_unregister_sysfs:
417 cmm_unregister_sysfs(&cmm_sysdev);
419 unregister_oom_notifier(&cmm_oom_nb);
424 * cmm_exit - Module exit
429 static void cmm_exit(void)
432 kthread_stop(cmm_thread_ptr);
433 unregister_oom_notifier(&cmm_oom_nb);
434 cmm_free_pages(loaned_pages);
435 cmm_unregister_sysfs(&cmm_sysdev);
439 * cmm_set_disable - Disable/Enable CMM
442 * 0 on success / other on failure
444 static int cmm_set_disable(const char *val, struct kernel_param *kp)
446 int disable = simple_strtoul(val, NULL, 10);
448 if (disable != 0 && disable != 1)
451 if (disable && !cmm_disabled) {
453 kthread_stop(cmm_thread_ptr);
454 cmm_thread_ptr = NULL;
455 cmm_free_pages(loaned_pages);
456 } else if (!disable && cmm_disabled) {
457 cmm_thread_ptr = kthread_run(cmm_thread, NULL, "cmmthread");
458 if (IS_ERR(cmm_thread_ptr))
459 return PTR_ERR(cmm_thread_ptr);
462 cmm_disabled = disable;
466 module_param_call(disable, cmm_set_disable, param_get_uint,
467 &cmm_disabled, S_IRUGO | S_IWUSR);
468 MODULE_PARM_DESC(disable, "Disable CMM. Set to 1 to disable. "
469 "[Default=" __stringify(CMM_DISABLE) "]");
471 module_init(cmm_init);
472 module_exit(cmm_exit);