2 * Kprobe module for testing crash dumps
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 * Copyright (C) IBM Corporation, 2006
22 * This module induces system failures at predefined crashpoints to
23 * evaluate the reliability of crash dumps obtained using different dumping
26 * It is adapted from the Linux Kernel Dump Test Tool by
27 * Fernando Luis Vazquez Cao <http://lkdtt.sourceforge.net>
31 * See Documentation/fault-injection/provoke-crashes.txt for instructions
34 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/buffer_head.h>
38 #include <linux/kprobes.h>
39 #include <linux/list.h>
40 #include <linux/init.h>
41 #include <linux/interrupt.h>
42 #include <linux/hrtimer.h>
43 #include <linux/slab.h>
44 #include <scsi/scsi_cmnd.h>
45 #include <linux/debugfs.h>
46 #include <linux/vmalloc.h>
49 #include <linux/ide.h>
52 #define DEFAULT_COUNT 10
53 #define REC_NUM_DEFAULT 10
58 CN_INT_HARDWARE_ENTRY,
78 CT_UNALIGNED_LOAD_STORE_WRITE,
79 CT_OVERWRITE_ALLOCATION,
91 static char* cp_name[] = {
103 static char* cp_type[] = {
111 "UNALIGNED_LOAD_STORE_WRITE",
112 "OVERWRITE_ALLOCATION",
124 static struct jprobe lkdtm;
126 static int lkdtm_parse_commandline(void);
127 static void lkdtm_handler(void);
129 static char* cpoint_name;
130 static char* cpoint_type;
131 static int cpoint_count = DEFAULT_COUNT;
132 static int recur_count = REC_NUM_DEFAULT;
134 static enum cname cpoint = CN_INVALID;
135 static enum ctype cptype = CT_NONE;
136 static int count = DEFAULT_COUNT;
137 static DEFINE_SPINLOCK(count_lock);
138 static DEFINE_SPINLOCK(lock_me_up);
140 static u8 data_area[EXEC_SIZE];
142 module_param(recur_count, int, 0644);
143 MODULE_PARM_DESC(recur_count, " Recursion level for the stack overflow test, "\
145 module_param(cpoint_name, charp, 0444);
146 MODULE_PARM_DESC(cpoint_name, " Crash Point, where kernel is to be crashed");
147 module_param(cpoint_type, charp, 0444);
148 MODULE_PARM_DESC(cpoint_type, " Crash Point Type, action to be taken on "\
149 "hitting the crash point");
150 module_param(cpoint_count, int, 0644);
151 MODULE_PARM_DESC(cpoint_count, " Crash Point Count, number of times the "\
152 "crash point is to be hit to trigger action");
154 static unsigned int jp_do_irq(unsigned int irq)
161 static irqreturn_t jp_handle_irq_event(unsigned int irq,
162 struct irqaction *action)
169 static void jp_tasklet_action(struct softirq_action *a)
175 static void jp_ll_rw_block(int rw, int nr, struct buffer_head *bhs[])
183 static unsigned long jp_shrink_inactive_list(unsigned long max_scan,
185 struct scan_control *sc)
192 static int jp_hrtimer_start(struct hrtimer *timer, ktime_t tim,
193 const enum hrtimer_mode mode)
200 static int jp_scsi_dispatch_cmd(struct scsi_cmnd *cmd)
208 int jp_generic_ide_ioctl(ide_drive_t *drive, struct file *file,
209 struct block_device *bdev, unsigned int cmd,
218 /* Return the crashpoint number or NONE if the name is invalid */
219 static enum ctype parse_cp_type(const char *what, size_t count)
223 for (i = 0; i < ARRAY_SIZE(cp_type); i++) {
224 if (!strcmp(what, cp_type[i]))
231 static const char *cp_type_to_str(enum ctype type)
233 if (type == CT_NONE || type < 0 || type > ARRAY_SIZE(cp_type))
236 return cp_type[type - 1];
239 static const char *cp_name_to_str(enum cname name)
241 if (name == CN_INVALID || name < 0 || name > ARRAY_SIZE(cp_name))
244 return cp_name[name - 1];
248 static int lkdtm_parse_commandline(void)
253 if (cpoint_count < 1 || recur_count < 1)
256 spin_lock_irqsave(&count_lock, flags);
257 count = cpoint_count;
258 spin_unlock_irqrestore(&count_lock, flags);
260 /* No special parameters */
261 if (!cpoint_type && !cpoint_name)
264 /* Neither or both of these need to be set */
265 if (!cpoint_type || !cpoint_name)
268 cptype = parse_cp_type(cpoint_type, strlen(cpoint_type));
269 if (cptype == CT_NONE)
272 for (i = 0; i < ARRAY_SIZE(cp_name); i++) {
273 if (!strcmp(cpoint_name, cp_name[i])) {
279 /* Could not find a valid crash point */
283 static int recursive_loop(int a)
287 memset(buf,0xFF,1024);
292 return recursive_loop(a);
295 static void do_nothing(void)
300 static void execute_location(void *dst)
302 void (*func)(void) = dst;
304 memcpy(dst, do_nothing, EXEC_SIZE);
308 static void lkdtm_do_action(enum ctype which)
328 (void) recursive_loop(0);
330 case CT_CORRUPT_STACK: {
331 /* Make sure the compiler creates and uses an 8 char array. */
332 volatile char data[8];
334 memset((void *)data, 0, 64);
337 case CT_UNALIGNED_LOAD_STORE_WRITE: {
338 static u8 data[5] __attribute__((aligned(4))) = {1, 2,
341 u32 val = 0x12345678;
343 p = (u32 *)(data + 1);
349 case CT_OVERWRITE_ALLOCATION: {
351 u32 *data = kmalloc(len, GFP_KERNEL);
353 data[1024 / sizeof(u32)] = 0x12345678;
357 case CT_WRITE_AFTER_FREE: {
359 u32 *data = kmalloc(len, GFP_KERNEL);
363 memset(data, 0x78, len);
377 /* Must be called twice to trigger. */
378 spin_lock(&lock_me_up);
381 set_current_state(TASK_UNINTERRUPTIBLE);
385 execute_location(data_area);
387 case CT_EXEC_STACK: {
388 u8 stack_area[EXEC_SIZE];
389 execute_location(stack_area);
392 case CT_EXEC_KMALLOC: {
393 u32 *kmalloc_area = kmalloc(EXEC_SIZE, GFP_KERNEL);
394 execute_location(kmalloc_area);
398 case CT_EXEC_VMALLOC: {
399 u32 *vmalloc_area = vmalloc(EXEC_SIZE);
400 execute_location(vmalloc_area);
411 static void lkdtm_handler(void)
416 spin_lock_irqsave(&count_lock, flags);
418 printk(KERN_INFO "lkdtm: Crash point %s of type %s hit, trigger in %d rounds\n",
419 cp_name_to_str(cpoint), cp_type_to_str(cptype), count);
423 count = cpoint_count;
425 spin_unlock_irqrestore(&count_lock, flags);
428 lkdtm_do_action(cptype);
431 static int lkdtm_register_cpoint(enum cname which)
436 if (lkdtm.entry != NULL)
437 unregister_jprobe(&lkdtm);
441 lkdtm_do_action(cptype);
443 case CN_INT_HARDWARE_ENTRY:
444 lkdtm.kp.symbol_name = "do_IRQ";
445 lkdtm.entry = (kprobe_opcode_t*) jp_do_irq;
447 case CN_INT_HW_IRQ_EN:
448 lkdtm.kp.symbol_name = "handle_IRQ_event";
449 lkdtm.entry = (kprobe_opcode_t*) jp_handle_irq_event;
451 case CN_INT_TASKLET_ENTRY:
452 lkdtm.kp.symbol_name = "tasklet_action";
453 lkdtm.entry = (kprobe_opcode_t*) jp_tasklet_action;
456 lkdtm.kp.symbol_name = "ll_rw_block";
457 lkdtm.entry = (kprobe_opcode_t*) jp_ll_rw_block;
460 lkdtm.kp.symbol_name = "shrink_inactive_list";
461 lkdtm.entry = (kprobe_opcode_t*) jp_shrink_inactive_list;
464 lkdtm.kp.symbol_name = "hrtimer_start";
465 lkdtm.entry = (kprobe_opcode_t*) jp_hrtimer_start;
467 case CN_SCSI_DISPATCH_CMD:
468 lkdtm.kp.symbol_name = "scsi_dispatch_cmd";
469 lkdtm.entry = (kprobe_opcode_t*) jp_scsi_dispatch_cmd;
473 lkdtm.kp.symbol_name = "generic_ide_ioctl";
474 lkdtm.entry = (kprobe_opcode_t*) jp_generic_ide_ioctl;
476 printk(KERN_INFO "lkdtm: Crash point not available\n");
481 printk(KERN_INFO "lkdtm: Invalid Crash Point\n");
486 if ((ret = register_jprobe(&lkdtm)) < 0) {
487 printk(KERN_INFO "lkdtm: Couldn't register jprobe\n");
494 static ssize_t do_register_entry(enum cname which, struct file *f,
495 const char __user *user_buf, size_t count, loff_t *off)
500 if (count >= PAGE_SIZE)
503 buf = (char *)__get_free_page(GFP_KERNEL);
506 if (copy_from_user(buf, user_buf, count)) {
507 free_page((unsigned long) buf);
510 /* NULL-terminate and remove enter */
514 cptype = parse_cp_type(buf, count);
515 free_page((unsigned long) buf);
517 if (cptype == CT_NONE)
520 err = lkdtm_register_cpoint(which);
529 /* Generic read callback that just prints out the available crash types */
530 static ssize_t lkdtm_debugfs_read(struct file *f, char __user *user_buf,
531 size_t count, loff_t *off)
536 buf = (char *)__get_free_page(GFP_KERNEL);
540 n = snprintf(buf, PAGE_SIZE, "Available crash types:\n");
541 for (i = 0; i < ARRAY_SIZE(cp_type); i++)
542 n += snprintf(buf + n, PAGE_SIZE - n, "%s\n", cp_type[i]);
545 out = simple_read_from_buffer(user_buf, count, off,
547 free_page((unsigned long) buf);
552 static int lkdtm_debugfs_open(struct inode *inode, struct file *file)
558 static ssize_t int_hardware_entry(struct file *f, const char __user *buf,
559 size_t count, loff_t *off)
561 return do_register_entry(CN_INT_HARDWARE_ENTRY, f, buf, count, off);
564 static ssize_t int_hw_irq_en(struct file *f, const char __user *buf,
565 size_t count, loff_t *off)
567 return do_register_entry(CN_INT_HW_IRQ_EN, f, buf, count, off);
570 static ssize_t int_tasklet_entry(struct file *f, const char __user *buf,
571 size_t count, loff_t *off)
573 return do_register_entry(CN_INT_TASKLET_ENTRY, f, buf, count, off);
576 static ssize_t fs_devrw_entry(struct file *f, const char __user *buf,
577 size_t count, loff_t *off)
579 return do_register_entry(CN_FS_DEVRW, f, buf, count, off);
582 static ssize_t mem_swapout_entry(struct file *f, const char __user *buf,
583 size_t count, loff_t *off)
585 return do_register_entry(CN_MEM_SWAPOUT, f, buf, count, off);
588 static ssize_t timeradd_entry(struct file *f, const char __user *buf,
589 size_t count, loff_t *off)
591 return do_register_entry(CN_TIMERADD, f, buf, count, off);
594 static ssize_t scsi_dispatch_cmd_entry(struct file *f,
595 const char __user *buf, size_t count, loff_t *off)
597 return do_register_entry(CN_SCSI_DISPATCH_CMD, f, buf, count, off);
600 static ssize_t ide_core_cp_entry(struct file *f, const char __user *buf,
601 size_t count, loff_t *off)
603 return do_register_entry(CN_IDE_CORE_CP, f, buf, count, off);
606 /* Special entry to just crash directly. Available without KPROBEs */
607 static ssize_t direct_entry(struct file *f, const char __user *user_buf,
608 size_t count, loff_t *off)
613 if (count >= PAGE_SIZE)
618 buf = (char *)__get_free_page(GFP_KERNEL);
621 if (copy_from_user(buf, user_buf, count)) {
622 free_page((unsigned long) buf);
625 /* NULL-terminate and remove enter */
629 type = parse_cp_type(buf, count);
630 free_page((unsigned long) buf);
634 printk(KERN_INFO "lkdtm: Performing direct entry %s\n",
635 cp_type_to_str(type));
636 lkdtm_do_action(type);
644 const struct file_operations fops;
647 static const struct crash_entry crash_entries[] = {
648 {"DIRECT", {.read = lkdtm_debugfs_read,
649 .llseek = generic_file_llseek,
650 .open = lkdtm_debugfs_open,
651 .write = direct_entry} },
652 {"INT_HARDWARE_ENTRY", {.read = lkdtm_debugfs_read,
653 .llseek = generic_file_llseek,
654 .open = lkdtm_debugfs_open,
655 .write = int_hardware_entry} },
656 {"INT_HW_IRQ_EN", {.read = lkdtm_debugfs_read,
657 .llseek = generic_file_llseek,
658 .open = lkdtm_debugfs_open,
659 .write = int_hw_irq_en} },
660 {"INT_TASKLET_ENTRY", {.read = lkdtm_debugfs_read,
661 .llseek = generic_file_llseek,
662 .open = lkdtm_debugfs_open,
663 .write = int_tasklet_entry} },
664 {"FS_DEVRW", {.read = lkdtm_debugfs_read,
665 .llseek = generic_file_llseek,
666 .open = lkdtm_debugfs_open,
667 .write = fs_devrw_entry} },
668 {"MEM_SWAPOUT", {.read = lkdtm_debugfs_read,
669 .llseek = generic_file_llseek,
670 .open = lkdtm_debugfs_open,
671 .write = mem_swapout_entry} },
672 {"TIMERADD", {.read = lkdtm_debugfs_read,
673 .llseek = generic_file_llseek,
674 .open = lkdtm_debugfs_open,
675 .write = timeradd_entry} },
676 {"SCSI_DISPATCH_CMD", {.read = lkdtm_debugfs_read,
677 .llseek = generic_file_llseek,
678 .open = lkdtm_debugfs_open,
679 .write = scsi_dispatch_cmd_entry} },
680 {"IDE_CORE_CP", {.read = lkdtm_debugfs_read,
681 .llseek = generic_file_llseek,
682 .open = lkdtm_debugfs_open,
683 .write = ide_core_cp_entry} },
686 static struct dentry *lkdtm_debugfs_root;
688 static int __init lkdtm_module_init(void)
691 int n_debugfs_entries = 1; /* Assume only the direct entry */
694 /* Register debugfs interface */
695 lkdtm_debugfs_root = debugfs_create_dir("provoke-crash", NULL);
696 if (!lkdtm_debugfs_root) {
697 printk(KERN_ERR "lkdtm: creating root dir failed\n");
701 #ifdef CONFIG_KPROBES
702 n_debugfs_entries = ARRAY_SIZE(crash_entries);
705 for (i = 0; i < n_debugfs_entries; i++) {
706 const struct crash_entry *cur = &crash_entries[i];
709 de = debugfs_create_file(cur->name, 0644, lkdtm_debugfs_root,
712 printk(KERN_ERR "lkdtm: could not create %s\n",
718 if (lkdtm_parse_commandline() == -EINVAL) {
719 printk(KERN_INFO "lkdtm: Invalid command\n");
723 if (cpoint != CN_INVALID && cptype != CT_NONE) {
724 ret = lkdtm_register_cpoint(cpoint);
726 printk(KERN_INFO "lkdtm: Invalid crash point %d\n",
730 printk(KERN_INFO "lkdtm: Crash point %s of type %s registered\n",
731 cpoint_name, cpoint_type);
733 printk(KERN_INFO "lkdtm: No crash points registered, enable through debugfs\n");
739 debugfs_remove_recursive(lkdtm_debugfs_root);
743 static void __exit lkdtm_module_exit(void)
745 debugfs_remove_recursive(lkdtm_debugfs_root);
747 unregister_jprobe(&lkdtm);
748 printk(KERN_INFO "lkdtm: Crash point unregistered\n");
751 module_init(lkdtm_module_init);
752 module_exit(lkdtm_module_exit);
754 MODULE_LICENSE("GPL");