1 // SPDX-License-Identifier: GPL-2.0
3 * Base infrastructure for Linux-z/VM Monitor Stream, Stage 1.
4 * Exports appldata_register_ops() and appldata_unregister_ops() for the
5 * data gathering modules.
7 * Copyright IBM Corp. 2003, 2009
9 * Author: Gerald Schaefer <gerald.schaefer@de.ibm.com>
12 #define KMSG_COMPONENT "appldata"
13 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
15 #include <linux/module.h>
16 #include <linux/sched/stat.h>
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/errno.h>
20 #include <linux/interrupt.h>
21 #include <linux/proc_fs.h>
23 #include <linux/swap.h>
24 #include <linux/pagemap.h>
25 #include <linux/sysctl.h>
26 #include <linux/notifier.h>
27 #include <linux/cpu.h>
28 #include <linux/workqueue.h>
29 #include <linux/suspend.h>
30 #include <linux/platform_device.h>
31 #include <asm/appldata.h>
32 #include <asm/vtimer.h>
33 #include <linux/uaccess.h>
40 #define APPLDATA_CPU_INTERVAL 10000 /* default (CPU) time for
44 #define TOD_MICRO 0x01000 /* nr. of TOD clock units
47 static struct platform_device *appldata_pdev;
50 * /proc entries (sysctl)
52 static const char appldata_proc_name[APPLDATA_PROC_NAME_LENGTH] = "appldata";
53 static int appldata_timer_handler(struct ctl_table *ctl, int write,
54 void __user *buffer, size_t *lenp, loff_t *ppos);
55 static int appldata_interval_handler(struct ctl_table *ctl, int write,
57 size_t *lenp, loff_t *ppos);
59 static struct ctl_table_header *appldata_sysctl_header;
60 static struct ctl_table appldata_table[] = {
63 .mode = S_IRUGO | S_IWUSR,
64 .proc_handler = appldata_timer_handler,
67 .procname = "interval",
68 .mode = S_IRUGO | S_IWUSR,
69 .proc_handler = appldata_interval_handler,
74 static struct ctl_table appldata_dir_table[] = {
76 .procname = appldata_proc_name,
78 .mode = S_IRUGO | S_IXUGO,
79 .child = appldata_table,
87 static struct vtimer_list appldata_timer;
89 static DEFINE_SPINLOCK(appldata_timer_lock);
90 static int appldata_interval = APPLDATA_CPU_INTERVAL;
91 static int appldata_timer_active;
92 static int appldata_timer_suspended = 0;
97 static struct workqueue_struct *appldata_wq;
98 static void appldata_work_fn(struct work_struct *work);
99 static DECLARE_WORK(appldata_work, appldata_work_fn);
105 static DEFINE_MUTEX(appldata_ops_mutex);
106 static LIST_HEAD(appldata_ops_list);
109 /*************************** timer, work, DIAG *******************************/
111 * appldata_timer_function()
113 * schedule work and reschedule timer
115 static void appldata_timer_function(unsigned long data)
117 queue_work(appldata_wq, (struct work_struct *) data);
123 * call data gathering function for each (active) module
125 static void appldata_work_fn(struct work_struct *work)
127 struct list_head *lh;
128 struct appldata_ops *ops;
130 mutex_lock(&appldata_ops_mutex);
131 list_for_each(lh, &appldata_ops_list) {
132 ops = list_entry(lh, struct appldata_ops, list);
133 if (ops->active == 1) {
134 ops->callback(ops->data);
137 mutex_unlock(&appldata_ops_mutex);
140 static struct appldata_product_id appldata_id = {
141 .prod_nr = {0xD3, 0xC9, 0xD5, 0xE4,
142 0xE7, 0xD2, 0xD9}, /* "LINUXKR" */
143 .prod_fn = 0xD5D3, /* "NL" */
144 .version_nr = 0xF2F6, /* "26" */
145 .release_nr = 0xF0F1, /* "01" */
151 * prepare parameter list, issue DIAG 0xDC
153 int appldata_diag(char record_nr, u16 function, unsigned long buffer,
154 u16 length, char *mod_lvl)
156 struct appldata_parameter_list *parm_list;
157 struct appldata_product_id *id;
160 parm_list = kmalloc(sizeof(*parm_list), GFP_KERNEL);
161 id = kmemdup(&appldata_id, sizeof(appldata_id), GFP_KERNEL);
163 if (parm_list && id) {
164 id->record_nr = record_nr;
165 id->mod_lvl = (mod_lvl[0]) << 8 | mod_lvl[1];
166 rc = appldata_asm(parm_list, id, function,
167 (void *) buffer, length);
173 /************************ timer, work, DIAG <END> ****************************/
176 /****************************** /proc stuff **********************************/
178 #define APPLDATA_ADD_TIMER 0
179 #define APPLDATA_DEL_TIMER 1
180 #define APPLDATA_MOD_TIMER 2
183 * __appldata_vtimer_setup()
185 * Add, delete or modify virtual timers on all online cpus.
186 * The caller needs to get the appldata_timer_lock spinlock.
188 static void __appldata_vtimer_setup(int cmd)
190 u64 timer_interval = (u64) appldata_interval * 1000 * TOD_MICRO;
193 case APPLDATA_ADD_TIMER:
194 if (appldata_timer_active)
196 appldata_timer.expires = timer_interval;
197 add_virt_timer_periodic(&appldata_timer);
198 appldata_timer_active = 1;
200 case APPLDATA_DEL_TIMER:
201 del_virt_timer(&appldata_timer);
202 if (!appldata_timer_active)
204 appldata_timer_active = 0;
206 case APPLDATA_MOD_TIMER:
207 if (!appldata_timer_active)
209 mod_virt_timer_periodic(&appldata_timer, timer_interval);
214 * appldata_timer_handler()
216 * Start/Stop timer, show status of timer (0 = not active, 1 = active)
219 appldata_timer_handler(struct ctl_table *ctl, int write,
220 void __user *buffer, size_t *lenp, loff_t *ppos)
222 int timer_active = appldata_timer_active;
224 struct ctl_table ctl_entry = {
225 .procname = ctl->procname,
226 .data = &timer_active,
227 .maxlen = sizeof(int),
228 .extra1 = SYSCTL_ZERO,
229 .extra2 = SYSCTL_ONE,
232 rc = proc_douintvec_minmax(&ctl_entry, write, buffer, lenp, ppos);
233 if (rc < 0 || !write)
236 spin_lock(&appldata_timer_lock);
238 __appldata_vtimer_setup(APPLDATA_ADD_TIMER);
240 __appldata_vtimer_setup(APPLDATA_DEL_TIMER);
241 spin_unlock(&appldata_timer_lock);
246 * appldata_interval_handler()
248 * Set (CPU) timer interval for collection of data (in milliseconds), show
249 * current timer interval.
252 appldata_interval_handler(struct ctl_table *ctl, int write,
253 void __user *buffer, size_t *lenp, loff_t *ppos)
255 int interval = appldata_interval;
257 struct ctl_table ctl_entry = {
258 .procname = ctl->procname,
260 .maxlen = sizeof(int),
261 .extra1 = SYSCTL_ONE,
264 rc = proc_dointvec_minmax(&ctl_entry, write, buffer, lenp, ppos);
265 if (rc < 0 || !write)
268 spin_lock(&appldata_timer_lock);
269 appldata_interval = interval;
270 __appldata_vtimer_setup(APPLDATA_MOD_TIMER);
271 spin_unlock(&appldata_timer_lock);
276 * appldata_generic_handler()
278 * Generic start/stop monitoring and DIAG, show status of
279 * monitoring (0 = not in process, 1 = in process)
282 appldata_generic_handler(struct ctl_table *ctl, int write,
283 void __user *buffer, size_t *lenp, loff_t *ppos)
285 struct appldata_ops *ops = NULL, *tmp_ops;
286 struct list_head *lh;
289 struct ctl_table ctl_entry = {
291 .maxlen = sizeof(int),
292 .extra1 = SYSCTL_ZERO,
293 .extra2 = SYSCTL_ONE,
297 mutex_lock(&appldata_ops_mutex);
298 list_for_each(lh, &appldata_ops_list) {
299 tmp_ops = list_entry(lh, struct appldata_ops, list);
300 if (&tmp_ops->ctl_table[2] == ctl) {
305 mutex_unlock(&appldata_ops_mutex);
309 if (!try_module_get(ops->owner)) { // protect this function
310 mutex_unlock(&appldata_ops_mutex);
313 mutex_unlock(&appldata_ops_mutex);
315 active = ops->active;
316 rc = proc_douintvec_minmax(&ctl_entry, write, buffer, lenp, ppos);
317 if (rc < 0 || !write) {
318 module_put(ops->owner);
322 mutex_lock(&appldata_ops_mutex);
323 if (active && (ops->active == 0)) {
324 // protect work queue callback
325 if (!try_module_get(ops->owner)) {
326 mutex_unlock(&appldata_ops_mutex);
327 module_put(ops->owner);
330 ops->callback(ops->data); // init record
331 rc = appldata_diag(ops->record_nr,
332 APPLDATA_START_INTERVAL_REC,
333 (unsigned long) ops->data, ops->size,
336 pr_err("Starting the data collection for %s "
337 "failed with rc=%d\n", ops->name, rc);
338 module_put(ops->owner);
341 } else if (!active && (ops->active == 1)) {
343 rc = appldata_diag(ops->record_nr, APPLDATA_STOP_REC,
344 (unsigned long) ops->data, ops->size,
347 pr_err("Stopping the data collection for %s "
348 "failed with rc=%d\n", ops->name, rc);
349 module_put(ops->owner);
351 mutex_unlock(&appldata_ops_mutex);
352 module_put(ops->owner);
356 /*************************** /proc stuff <END> *******************************/
359 /************************* module-ops management *****************************/
361 * appldata_register_ops()
363 * update ops list, register /proc/sys entries
365 int appldata_register_ops(struct appldata_ops *ops)
367 if (ops->size > APPLDATA_MAX_REC_SIZE)
370 ops->ctl_table = kcalloc(4, sizeof(struct ctl_table), GFP_KERNEL);
374 mutex_lock(&appldata_ops_mutex);
375 list_add(&ops->list, &appldata_ops_list);
376 mutex_unlock(&appldata_ops_mutex);
378 ops->ctl_table[0].procname = appldata_proc_name;
379 ops->ctl_table[0].maxlen = 0;
380 ops->ctl_table[0].mode = S_IRUGO | S_IXUGO;
381 ops->ctl_table[0].child = &ops->ctl_table[2];
383 ops->ctl_table[2].procname = ops->name;
384 ops->ctl_table[2].mode = S_IRUGO | S_IWUSR;
385 ops->ctl_table[2].proc_handler = appldata_generic_handler;
386 ops->ctl_table[2].data = ops;
388 ops->sysctl_header = register_sysctl_table(ops->ctl_table);
389 if (!ops->sysctl_header)
393 mutex_lock(&appldata_ops_mutex);
394 list_del(&ops->list);
395 mutex_unlock(&appldata_ops_mutex);
396 kfree(ops->ctl_table);
401 * appldata_unregister_ops()
403 * update ops list, unregister /proc entries, stop DIAG if necessary
405 void appldata_unregister_ops(struct appldata_ops *ops)
407 mutex_lock(&appldata_ops_mutex);
408 list_del(&ops->list);
409 mutex_unlock(&appldata_ops_mutex);
410 unregister_sysctl_table(ops->sysctl_header);
411 kfree(ops->ctl_table);
413 /********************** module-ops management <END> **************************/
416 /**************************** suspend / resume *******************************/
417 static int appldata_freeze(struct device *dev)
419 struct appldata_ops *ops;
421 struct list_head *lh;
423 spin_lock(&appldata_timer_lock);
424 if (appldata_timer_active) {
425 __appldata_vtimer_setup(APPLDATA_DEL_TIMER);
426 appldata_timer_suspended = 1;
428 spin_unlock(&appldata_timer_lock);
430 mutex_lock(&appldata_ops_mutex);
431 list_for_each(lh, &appldata_ops_list) {
432 ops = list_entry(lh, struct appldata_ops, list);
433 if (ops->active == 1) {
434 rc = appldata_diag(ops->record_nr, APPLDATA_STOP_REC,
435 (unsigned long) ops->data, ops->size,
438 pr_err("Stopping the data collection for %s "
439 "failed with rc=%d\n", ops->name, rc);
442 mutex_unlock(&appldata_ops_mutex);
446 static int appldata_restore(struct device *dev)
448 struct appldata_ops *ops;
450 struct list_head *lh;
452 spin_lock(&appldata_timer_lock);
453 if (appldata_timer_suspended) {
454 __appldata_vtimer_setup(APPLDATA_ADD_TIMER);
455 appldata_timer_suspended = 0;
457 spin_unlock(&appldata_timer_lock);
459 mutex_lock(&appldata_ops_mutex);
460 list_for_each(lh, &appldata_ops_list) {
461 ops = list_entry(lh, struct appldata_ops, list);
462 if (ops->active == 1) {
463 ops->callback(ops->data); // init record
464 rc = appldata_diag(ops->record_nr,
465 APPLDATA_START_INTERVAL_REC,
466 (unsigned long) ops->data, ops->size,
469 pr_err("Starting the data collection for %s "
470 "failed with rc=%d\n", ops->name, rc);
474 mutex_unlock(&appldata_ops_mutex);
478 static int appldata_thaw(struct device *dev)
480 return appldata_restore(dev);
483 static const struct dev_pm_ops appldata_pm_ops = {
484 .freeze = appldata_freeze,
485 .thaw = appldata_thaw,
486 .restore = appldata_restore,
489 static struct platform_driver appldata_pdrv = {
492 .pm = &appldata_pm_ops,
495 /************************* suspend / resume <END> ****************************/
498 /******************************* init / exit *********************************/
503 * init timer, register /proc entries
505 static int __init appldata_init(void)
509 init_virt_timer(&appldata_timer);
510 appldata_timer.function = appldata_timer_function;
511 appldata_timer.data = (unsigned long) &appldata_work;
513 rc = platform_driver_register(&appldata_pdrv);
517 appldata_pdev = platform_device_register_simple("appldata", -1, NULL,
519 if (IS_ERR(appldata_pdev)) {
520 rc = PTR_ERR(appldata_pdev);
523 appldata_wq = alloc_ordered_workqueue("appldata", 0);
529 appldata_sysctl_header = register_sysctl_table(appldata_dir_table);
533 platform_device_unregister(appldata_pdev);
535 platform_driver_unregister(&appldata_pdrv);
539 __initcall(appldata_init);
541 /**************************** init / exit <END> ******************************/
543 EXPORT_SYMBOL_GPL(appldata_register_ops);
544 EXPORT_SYMBOL_GPL(appldata_unregister_ops);
545 EXPORT_SYMBOL_GPL(appldata_diag);
548 EXPORT_SYMBOL_GPL(si_swapinfo);
550 EXPORT_SYMBOL_GPL(nr_threads);
551 EXPORT_SYMBOL_GPL(nr_running);
552 EXPORT_SYMBOL_GPL(nr_iowait);