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
20 * Author: Ankita Garg <ankita@in.ibm.com>
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>
29 * Debugfs support added by Simon Kagstrom <simon.kagstrom@netinsight.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>
47 #include <linux/mman.h>
50 #include <linux/ide.h>
54 * Make sure our attempts to over run the kernel stack doesn't trigger
55 * a compiler warning when CONFIG_FRAME_WARN is set. Then make sure we
56 * recurse past the end of THREAD_SIZE by default.
58 #if defined(CONFIG_FRAME_WARN) && (CONFIG_FRAME_WARN > 0)
59 #define REC_STACK_SIZE (CONFIG_FRAME_WARN / 2)
61 #define REC_STACK_SIZE (THREAD_SIZE / 8)
63 #define REC_NUM_DEFAULT ((THREAD_SIZE / REC_STACK_SIZE) * 2)
65 #define DEFAULT_COUNT 10
70 CN_INT_HARDWARE_ENTRY
,
90 CT_UNALIGNED_LOAD_STORE_WRITE
,
91 CT_OVERWRITE_ALLOCATION
,
106 static char* cp_name
[] = {
107 "INT_HARDWARE_ENTRY",
118 static char* cp_type
[] = {
126 "UNALIGNED_LOAD_STORE_WRITE",
127 "OVERWRITE_ALLOCATION",
142 static struct jprobe lkdtm
;
144 static int lkdtm_parse_commandline(void);
145 static void lkdtm_handler(void);
147 static char* cpoint_name
;
148 static char* cpoint_type
;
149 static int cpoint_count
= DEFAULT_COUNT
;
150 static int recur_count
= REC_NUM_DEFAULT
;
152 static enum cname cpoint
= CN_INVALID
;
153 static enum ctype cptype
= CT_NONE
;
154 static int count
= DEFAULT_COUNT
;
155 static DEFINE_SPINLOCK(count_lock
);
156 static DEFINE_SPINLOCK(lock_me_up
);
158 static u8 data_area
[EXEC_SIZE
];
160 static const unsigned long rodata
= 0xAA55AA55;
162 module_param(recur_count
, int, 0644);
163 MODULE_PARM_DESC(recur_count
, " Recursion level for the stack overflow test");
164 module_param(cpoint_name
, charp
, 0444);
165 MODULE_PARM_DESC(cpoint_name
, " Crash Point, where kernel is to be crashed");
166 module_param(cpoint_type
, charp
, 0444);
167 MODULE_PARM_DESC(cpoint_type
, " Crash Point Type, action to be taken on "\
168 "hitting the crash point");
169 module_param(cpoint_count
, int, 0644);
170 MODULE_PARM_DESC(cpoint_count
, " Crash Point Count, number of times the "\
171 "crash point is to be hit to trigger action");
173 static unsigned int jp_do_irq(unsigned int irq
)
180 static irqreturn_t
jp_handle_irq_event(unsigned int irq
,
181 struct irqaction
*action
)
188 static void jp_tasklet_action(struct softirq_action
*a
)
194 static void jp_ll_rw_block(int rw
, int nr
, struct buffer_head
*bhs
[])
202 static unsigned long jp_shrink_inactive_list(unsigned long max_scan
,
204 struct scan_control
*sc
)
211 static int jp_hrtimer_start(struct hrtimer
*timer
, ktime_t tim
,
212 const enum hrtimer_mode mode
)
219 static int jp_scsi_dispatch_cmd(struct scsi_cmnd
*cmd
)
227 static int jp_generic_ide_ioctl(ide_drive_t
*drive
, struct file
*file
,
228 struct block_device
*bdev
, unsigned int cmd
,
237 /* Return the crashpoint number or NONE if the name is invalid */
238 static enum ctype
parse_cp_type(const char *what
, size_t count
)
242 for (i
= 0; i
< ARRAY_SIZE(cp_type
); i
++) {
243 if (!strcmp(what
, cp_type
[i
]))
250 static const char *cp_type_to_str(enum ctype type
)
252 if (type
== CT_NONE
|| type
< 0 || type
> ARRAY_SIZE(cp_type
))
255 return cp_type
[type
- 1];
258 static const char *cp_name_to_str(enum cname name
)
260 if (name
== CN_INVALID
|| name
< 0 || name
> ARRAY_SIZE(cp_name
))
263 return cp_name
[name
- 1];
267 static int lkdtm_parse_commandline(void)
272 if (cpoint_count
< 1 || recur_count
< 1)
275 spin_lock_irqsave(&count_lock
, flags
);
276 count
= cpoint_count
;
277 spin_unlock_irqrestore(&count_lock
, flags
);
279 /* No special parameters */
280 if (!cpoint_type
&& !cpoint_name
)
283 /* Neither or both of these need to be set */
284 if (!cpoint_type
|| !cpoint_name
)
287 cptype
= parse_cp_type(cpoint_type
, strlen(cpoint_type
));
288 if (cptype
== CT_NONE
)
291 for (i
= 0; i
< ARRAY_SIZE(cp_name
); i
++) {
292 if (!strcmp(cpoint_name
, cp_name
[i
])) {
298 /* Could not find a valid crash point */
302 static int recursive_loop(int remaining
)
304 char buf
[REC_STACK_SIZE
];
306 /* Make sure compiler does not optimize this away. */
307 memset(buf
, (remaining
& 0xff) | 0x1, REC_STACK_SIZE
);
311 return recursive_loop(remaining
- 1);
314 static void do_nothing(void)
319 static noinline
void corrupt_stack(void)
321 /* Use default char array length that triggers stack protection. */
324 memset((void *)data
, 0, 64);
327 static void execute_location(void *dst
)
329 void (*func
)(void) = dst
;
331 memcpy(dst
, do_nothing
, EXEC_SIZE
);
335 static void execute_user_location(void *dst
)
337 /* Intentionally crossing kernel/user memory boundary. */
338 void (*func
)(void) = dst
;
340 if (copy_to_user((void __user
*)dst
, do_nothing
, EXEC_SIZE
))
345 static void lkdtm_do_action(enum ctype which
)
365 (void) recursive_loop(recur_count
);
367 case CT_CORRUPT_STACK
:
370 case CT_UNALIGNED_LOAD_STORE_WRITE
: {
371 static u8 data
[5] __attribute__((aligned(4))) = {1, 2,
374 u32 val
= 0x12345678;
376 p
= (u32
*)(data
+ 1);
382 case CT_OVERWRITE_ALLOCATION
: {
384 u32
*data
= kmalloc(len
, GFP_KERNEL
);
386 data
[1024 / sizeof(u32
)] = 0x12345678;
390 case CT_WRITE_AFTER_FREE
: {
392 u32
*data
= kmalloc(len
, GFP_KERNEL
);
396 memset(data
, 0x78, len
);
410 /* Must be called twice to trigger. */
411 spin_lock(&lock_me_up
);
412 /* Let sparse know we intended to exit holding the lock. */
413 __release(&lock_me_up
);
416 set_current_state(TASK_UNINTERRUPTIBLE
);
420 execute_location(data_area
);
422 case CT_EXEC_STACK
: {
423 u8 stack_area
[EXEC_SIZE
];
424 execute_location(stack_area
);
427 case CT_EXEC_KMALLOC
: {
428 u32
*kmalloc_area
= kmalloc(EXEC_SIZE
, GFP_KERNEL
);
429 execute_location(kmalloc_area
);
433 case CT_EXEC_VMALLOC
: {
434 u32
*vmalloc_area
= vmalloc(EXEC_SIZE
);
435 execute_location(vmalloc_area
);
439 case CT_EXEC_USERSPACE
: {
440 unsigned long user_addr
;
442 user_addr
= vm_mmap(NULL
, 0, PAGE_SIZE
,
443 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
444 MAP_ANONYMOUS
| MAP_PRIVATE
, 0);
445 if (user_addr
>= TASK_SIZE
) {
446 pr_warn("Failed to allocate user memory\n");
449 execute_user_location((void *)user_addr
);
450 vm_munmap(user_addr
, PAGE_SIZE
);
453 case CT_ACCESS_USERSPACE
: {
454 unsigned long user_addr
, tmp
;
457 user_addr
= vm_mmap(NULL
, 0, PAGE_SIZE
,
458 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
459 MAP_ANONYMOUS
| MAP_PRIVATE
, 0);
460 if (user_addr
>= TASK_SIZE
) {
461 pr_warn("Failed to allocate user memory\n");
465 ptr
= (unsigned long *)user_addr
;
470 vm_munmap(user_addr
, PAGE_SIZE
);
477 ptr
= (unsigned long *)&rodata
;
489 static void lkdtm_handler(void)
494 spin_lock_irqsave(&count_lock
, flags
);
496 printk(KERN_INFO
"lkdtm: Crash point %s of type %s hit, trigger in %d rounds\n",
497 cp_name_to_str(cpoint
), cp_type_to_str(cptype
), count
);
501 count
= cpoint_count
;
503 spin_unlock_irqrestore(&count_lock
, flags
);
506 lkdtm_do_action(cptype
);
509 static int lkdtm_register_cpoint(enum cname which
)
514 if (lkdtm
.entry
!= NULL
)
515 unregister_jprobe(&lkdtm
);
519 lkdtm_do_action(cptype
);
521 case CN_INT_HARDWARE_ENTRY
:
522 lkdtm
.kp
.symbol_name
= "do_IRQ";
523 lkdtm
.entry
= (kprobe_opcode_t
*) jp_do_irq
;
525 case CN_INT_HW_IRQ_EN
:
526 lkdtm
.kp
.symbol_name
= "handle_IRQ_event";
527 lkdtm
.entry
= (kprobe_opcode_t
*) jp_handle_irq_event
;
529 case CN_INT_TASKLET_ENTRY
:
530 lkdtm
.kp
.symbol_name
= "tasklet_action";
531 lkdtm
.entry
= (kprobe_opcode_t
*) jp_tasklet_action
;
534 lkdtm
.kp
.symbol_name
= "ll_rw_block";
535 lkdtm
.entry
= (kprobe_opcode_t
*) jp_ll_rw_block
;
538 lkdtm
.kp
.symbol_name
= "shrink_inactive_list";
539 lkdtm
.entry
= (kprobe_opcode_t
*) jp_shrink_inactive_list
;
542 lkdtm
.kp
.symbol_name
= "hrtimer_start";
543 lkdtm
.entry
= (kprobe_opcode_t
*) jp_hrtimer_start
;
545 case CN_SCSI_DISPATCH_CMD
:
546 lkdtm
.kp
.symbol_name
= "scsi_dispatch_cmd";
547 lkdtm
.entry
= (kprobe_opcode_t
*) jp_scsi_dispatch_cmd
;
551 lkdtm
.kp
.symbol_name
= "generic_ide_ioctl";
552 lkdtm
.entry
= (kprobe_opcode_t
*) jp_generic_ide_ioctl
;
554 printk(KERN_INFO
"lkdtm: Crash point not available\n");
559 printk(KERN_INFO
"lkdtm: Invalid Crash Point\n");
564 if ((ret
= register_jprobe(&lkdtm
)) < 0) {
565 printk(KERN_INFO
"lkdtm: Couldn't register jprobe\n");
572 static ssize_t
do_register_entry(enum cname which
, struct file
*f
,
573 const char __user
*user_buf
, size_t count
, loff_t
*off
)
578 if (count
>= PAGE_SIZE
)
581 buf
= (char *)__get_free_page(GFP_KERNEL
);
584 if (copy_from_user(buf
, user_buf
, count
)) {
585 free_page((unsigned long) buf
);
588 /* NULL-terminate and remove enter */
592 cptype
= parse_cp_type(buf
, count
);
593 free_page((unsigned long) buf
);
595 if (cptype
== CT_NONE
)
598 err
= lkdtm_register_cpoint(which
);
607 /* Generic read callback that just prints out the available crash types */
608 static ssize_t
lkdtm_debugfs_read(struct file
*f
, char __user
*user_buf
,
609 size_t count
, loff_t
*off
)
614 buf
= (char *)__get_free_page(GFP_KERNEL
);
618 n
= snprintf(buf
, PAGE_SIZE
, "Available crash types:\n");
619 for (i
= 0; i
< ARRAY_SIZE(cp_type
); i
++)
620 n
+= snprintf(buf
+ n
, PAGE_SIZE
- n
, "%s\n", cp_type
[i
]);
623 out
= simple_read_from_buffer(user_buf
, count
, off
,
625 free_page((unsigned long) buf
);
630 static int lkdtm_debugfs_open(struct inode
*inode
, struct file
*file
)
636 static ssize_t
int_hardware_entry(struct file
*f
, const char __user
*buf
,
637 size_t count
, loff_t
*off
)
639 return do_register_entry(CN_INT_HARDWARE_ENTRY
, f
, buf
, count
, off
);
642 static ssize_t
int_hw_irq_en(struct file
*f
, const char __user
*buf
,
643 size_t count
, loff_t
*off
)
645 return do_register_entry(CN_INT_HW_IRQ_EN
, f
, buf
, count
, off
);
648 static ssize_t
int_tasklet_entry(struct file
*f
, const char __user
*buf
,
649 size_t count
, loff_t
*off
)
651 return do_register_entry(CN_INT_TASKLET_ENTRY
, f
, buf
, count
, off
);
654 static ssize_t
fs_devrw_entry(struct file
*f
, const char __user
*buf
,
655 size_t count
, loff_t
*off
)
657 return do_register_entry(CN_FS_DEVRW
, f
, buf
, count
, off
);
660 static ssize_t
mem_swapout_entry(struct file
*f
, const char __user
*buf
,
661 size_t count
, loff_t
*off
)
663 return do_register_entry(CN_MEM_SWAPOUT
, f
, buf
, count
, off
);
666 static ssize_t
timeradd_entry(struct file
*f
, const char __user
*buf
,
667 size_t count
, loff_t
*off
)
669 return do_register_entry(CN_TIMERADD
, f
, buf
, count
, off
);
672 static ssize_t
scsi_dispatch_cmd_entry(struct file
*f
,
673 const char __user
*buf
, size_t count
, loff_t
*off
)
675 return do_register_entry(CN_SCSI_DISPATCH_CMD
, f
, buf
, count
, off
);
678 static ssize_t
ide_core_cp_entry(struct file
*f
, const char __user
*buf
,
679 size_t count
, loff_t
*off
)
681 return do_register_entry(CN_IDE_CORE_CP
, f
, buf
, count
, off
);
684 /* Special entry to just crash directly. Available without KPROBEs */
685 static ssize_t
direct_entry(struct file
*f
, const char __user
*user_buf
,
686 size_t count
, loff_t
*off
)
691 if (count
>= PAGE_SIZE
)
696 buf
= (char *)__get_free_page(GFP_KERNEL
);
699 if (copy_from_user(buf
, user_buf
, count
)) {
700 free_page((unsigned long) buf
);
703 /* NULL-terminate and remove enter */
707 type
= parse_cp_type(buf
, count
);
708 free_page((unsigned long) buf
);
712 printk(KERN_INFO
"lkdtm: Performing direct entry %s\n",
713 cp_type_to_str(type
));
714 lkdtm_do_action(type
);
722 const struct file_operations fops
;
725 static const struct crash_entry crash_entries
[] = {
726 {"DIRECT", {.read
= lkdtm_debugfs_read
,
727 .llseek
= generic_file_llseek
,
728 .open
= lkdtm_debugfs_open
,
729 .write
= direct_entry
} },
730 {"INT_HARDWARE_ENTRY", {.read
= lkdtm_debugfs_read
,
731 .llseek
= generic_file_llseek
,
732 .open
= lkdtm_debugfs_open
,
733 .write
= int_hardware_entry
} },
734 {"INT_HW_IRQ_EN", {.read
= lkdtm_debugfs_read
,
735 .llseek
= generic_file_llseek
,
736 .open
= lkdtm_debugfs_open
,
737 .write
= int_hw_irq_en
} },
738 {"INT_TASKLET_ENTRY", {.read
= lkdtm_debugfs_read
,
739 .llseek
= generic_file_llseek
,
740 .open
= lkdtm_debugfs_open
,
741 .write
= int_tasklet_entry
} },
742 {"FS_DEVRW", {.read
= lkdtm_debugfs_read
,
743 .llseek
= generic_file_llseek
,
744 .open
= lkdtm_debugfs_open
,
745 .write
= fs_devrw_entry
} },
746 {"MEM_SWAPOUT", {.read
= lkdtm_debugfs_read
,
747 .llseek
= generic_file_llseek
,
748 .open
= lkdtm_debugfs_open
,
749 .write
= mem_swapout_entry
} },
750 {"TIMERADD", {.read
= lkdtm_debugfs_read
,
751 .llseek
= generic_file_llseek
,
752 .open
= lkdtm_debugfs_open
,
753 .write
= timeradd_entry
} },
754 {"SCSI_DISPATCH_CMD", {.read
= lkdtm_debugfs_read
,
755 .llseek
= generic_file_llseek
,
756 .open
= lkdtm_debugfs_open
,
757 .write
= scsi_dispatch_cmd_entry
} },
758 {"IDE_CORE_CP", {.read
= lkdtm_debugfs_read
,
759 .llseek
= generic_file_llseek
,
760 .open
= lkdtm_debugfs_open
,
761 .write
= ide_core_cp_entry
} },
764 static struct dentry
*lkdtm_debugfs_root
;
766 static int __init
lkdtm_module_init(void)
769 int n_debugfs_entries
= 1; /* Assume only the direct entry */
772 /* Register debugfs interface */
773 lkdtm_debugfs_root
= debugfs_create_dir("provoke-crash", NULL
);
774 if (!lkdtm_debugfs_root
) {
775 printk(KERN_ERR
"lkdtm: creating root dir failed\n");
779 #ifdef CONFIG_KPROBES
780 n_debugfs_entries
= ARRAY_SIZE(crash_entries
);
783 for (i
= 0; i
< n_debugfs_entries
; i
++) {
784 const struct crash_entry
*cur
= &crash_entries
[i
];
787 de
= debugfs_create_file(cur
->name
, 0644, lkdtm_debugfs_root
,
790 printk(KERN_ERR
"lkdtm: could not create %s\n",
796 if (lkdtm_parse_commandline() == -EINVAL
) {
797 printk(KERN_INFO
"lkdtm: Invalid command\n");
801 if (cpoint
!= CN_INVALID
&& cptype
!= CT_NONE
) {
802 ret
= lkdtm_register_cpoint(cpoint
);
804 printk(KERN_INFO
"lkdtm: Invalid crash point %d\n",
808 printk(KERN_INFO
"lkdtm: Crash point %s of type %s registered\n",
809 cpoint_name
, cpoint_type
);
811 printk(KERN_INFO
"lkdtm: No crash points registered, enable through debugfs\n");
817 debugfs_remove_recursive(lkdtm_debugfs_root
);
821 static void __exit
lkdtm_module_exit(void)
823 debugfs_remove_recursive(lkdtm_debugfs_root
);
825 unregister_jprobe(&lkdtm
);
826 printk(KERN_INFO
"lkdtm: Crash point unregistered\n");
829 module_init(lkdtm_module_init
);
830 module_exit(lkdtm_module_exit
);
832 MODULE_LICENSE("GPL");