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
33 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
35 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/buffer_head.h>
39 #include <linux/kprobes.h>
40 #include <linux/list.h>
41 #include <linux/init.h>
42 #include <linux/interrupt.h>
43 #include <linux/hrtimer.h>
44 #include <linux/slab.h>
45 #include <scsi/scsi_cmnd.h>
46 #include <linux/debugfs.h>
47 #include <linux/vmalloc.h>
48 #include <linux/mman.h>
49 #include <asm/cacheflush.h>
52 #include <linux/ide.h>
56 * Make sure our attempts to over run the kernel stack doesn't trigger
57 * a compiler warning when CONFIG_FRAME_WARN is set. Then make sure we
58 * recurse past the end of THREAD_SIZE by default.
60 #if defined(CONFIG_FRAME_WARN) && (CONFIG_FRAME_WARN > 0)
61 #define REC_STACK_SIZE (CONFIG_FRAME_WARN / 2)
63 #define REC_STACK_SIZE (THREAD_SIZE / 8)
65 #define REC_NUM_DEFAULT ((THREAD_SIZE / REC_STACK_SIZE) * 2)
67 #define DEFAULT_COUNT 10
72 CN_INT_HARDWARE_ENTRY
,
92 CT_UNALIGNED_LOAD_STORE_WRITE
,
93 CT_OVERWRITE_ALLOCATION
,
109 static char* cp_name
[] = {
110 "INT_HARDWARE_ENTRY",
121 static char* cp_type
[] = {
129 "UNALIGNED_LOAD_STORE_WRITE",
130 "OVERWRITE_ALLOCATION",
146 static struct jprobe lkdtm
;
148 static int lkdtm_parse_commandline(void);
149 static void lkdtm_handler(void);
151 static char* cpoint_name
;
152 static char* cpoint_type
;
153 static int cpoint_count
= DEFAULT_COUNT
;
154 static int recur_count
= REC_NUM_DEFAULT
;
156 static enum cname cpoint
= CN_INVALID
;
157 static enum ctype cptype
= CT_NONE
;
158 static int count
= DEFAULT_COUNT
;
159 static DEFINE_SPINLOCK(count_lock
);
160 static DEFINE_SPINLOCK(lock_me_up
);
162 static u8 data_area
[EXEC_SIZE
];
164 static const unsigned long rodata
= 0xAA55AA55;
166 module_param(recur_count
, int, 0644);
167 MODULE_PARM_DESC(recur_count
, " Recursion level for the stack overflow test");
168 module_param(cpoint_name
, charp
, 0444);
169 MODULE_PARM_DESC(cpoint_name
, " Crash Point, where kernel is to be crashed");
170 module_param(cpoint_type
, charp
, 0444);
171 MODULE_PARM_DESC(cpoint_type
, " Crash Point Type, action to be taken on "\
172 "hitting the crash point");
173 module_param(cpoint_count
, int, 0644);
174 MODULE_PARM_DESC(cpoint_count
, " Crash Point Count, number of times the "\
175 "crash point is to be hit to trigger action");
177 static unsigned int jp_do_irq(unsigned int irq
)
184 static irqreturn_t
jp_handle_irq_event(unsigned int irq
,
185 struct irqaction
*action
)
192 static void jp_tasklet_action(struct softirq_action
*a
)
198 static void jp_ll_rw_block(int rw
, int nr
, struct buffer_head
*bhs
[])
206 static unsigned long jp_shrink_inactive_list(unsigned long max_scan
,
208 struct scan_control
*sc
)
215 static int jp_hrtimer_start(struct hrtimer
*timer
, ktime_t tim
,
216 const enum hrtimer_mode mode
)
223 static int jp_scsi_dispatch_cmd(struct scsi_cmnd
*cmd
)
231 static int jp_generic_ide_ioctl(ide_drive_t
*drive
, struct file
*file
,
232 struct block_device
*bdev
, unsigned int cmd
,
241 /* Return the crashpoint number or NONE if the name is invalid */
242 static enum ctype
parse_cp_type(const char *what
, size_t count
)
246 for (i
= 0; i
< ARRAY_SIZE(cp_type
); i
++) {
247 if (!strcmp(what
, cp_type
[i
]))
254 static const char *cp_type_to_str(enum ctype type
)
256 if (type
== CT_NONE
|| type
< 0 || type
> ARRAY_SIZE(cp_type
))
259 return cp_type
[type
- 1];
262 static const char *cp_name_to_str(enum cname name
)
264 if (name
== CN_INVALID
|| name
< 0 || name
> ARRAY_SIZE(cp_name
))
267 return cp_name
[name
- 1];
271 static int lkdtm_parse_commandline(void)
276 if (cpoint_count
< 1 || recur_count
< 1)
279 spin_lock_irqsave(&count_lock
, flags
);
280 count
= cpoint_count
;
281 spin_unlock_irqrestore(&count_lock
, flags
);
283 /* No special parameters */
284 if (!cpoint_type
&& !cpoint_name
)
287 /* Neither or both of these need to be set */
288 if (!cpoint_type
|| !cpoint_name
)
291 cptype
= parse_cp_type(cpoint_type
, strlen(cpoint_type
));
292 if (cptype
== CT_NONE
)
295 for (i
= 0; i
< ARRAY_SIZE(cp_name
); i
++) {
296 if (!strcmp(cpoint_name
, cp_name
[i
])) {
302 /* Could not find a valid crash point */
306 static int recursive_loop(int remaining
)
308 char buf
[REC_STACK_SIZE
];
310 /* Make sure compiler does not optimize this away. */
311 memset(buf
, (remaining
& 0xff) | 0x1, REC_STACK_SIZE
);
315 return recursive_loop(remaining
- 1);
318 static void do_nothing(void)
323 /* Must immediately follow do_nothing for size calculuations to work out. */
324 static void do_overwritten(void)
326 pr_info("do_overwritten wasn't overwritten!\n");
330 static noinline
void corrupt_stack(void)
332 /* Use default char array length that triggers stack protection. */
335 memset((void *)data
, 0, 64);
338 static void execute_location(void *dst
)
340 void (*func
)(void) = dst
;
342 pr_info("attempting ok execution at %p\n", do_nothing
);
345 memcpy(dst
, do_nothing
, EXEC_SIZE
);
346 flush_icache_range((unsigned long)dst
, (unsigned long)dst
+ EXEC_SIZE
);
347 pr_info("attempting bad execution at %p\n", func
);
351 static void execute_user_location(void *dst
)
353 /* Intentionally crossing kernel/user memory boundary. */
354 void (*func
)(void) = dst
;
356 pr_info("attempting ok execution at %p\n", do_nothing
);
359 if (copy_to_user((void __user
*)dst
, do_nothing
, EXEC_SIZE
))
361 flush_icache_range((unsigned long)dst
, (unsigned long)dst
+ EXEC_SIZE
);
362 pr_info("attempting bad execution at %p\n", func
);
366 static void lkdtm_do_action(enum ctype which
)
386 (void) recursive_loop(recur_count
);
388 case CT_CORRUPT_STACK
:
391 case CT_UNALIGNED_LOAD_STORE_WRITE
: {
392 static u8 data
[5] __attribute__((aligned(4))) = {1, 2,
395 u32 val
= 0x12345678;
397 p
= (u32
*)(data
+ 1);
403 case CT_OVERWRITE_ALLOCATION
: {
405 u32
*data
= kmalloc(len
, GFP_KERNEL
);
407 data
[1024 / sizeof(u32
)] = 0x12345678;
411 case CT_WRITE_AFTER_FREE
: {
413 u32
*data
= kmalloc(len
, GFP_KERNEL
);
417 memset(data
, 0x78, len
);
431 /* Must be called twice to trigger. */
432 spin_lock(&lock_me_up
);
433 /* Let sparse know we intended to exit holding the lock. */
434 __release(&lock_me_up
);
437 set_current_state(TASK_UNINTERRUPTIBLE
);
441 execute_location(data_area
);
443 case CT_EXEC_STACK
: {
444 u8 stack_area
[EXEC_SIZE
];
445 execute_location(stack_area
);
448 case CT_EXEC_KMALLOC
: {
449 u32
*kmalloc_area
= kmalloc(EXEC_SIZE
, GFP_KERNEL
);
450 execute_location(kmalloc_area
);
454 case CT_EXEC_VMALLOC
: {
455 u32
*vmalloc_area
= vmalloc(EXEC_SIZE
);
456 execute_location(vmalloc_area
);
460 case CT_EXEC_USERSPACE
: {
461 unsigned long user_addr
;
463 user_addr
= vm_mmap(NULL
, 0, PAGE_SIZE
,
464 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
465 MAP_ANONYMOUS
| MAP_PRIVATE
, 0);
466 if (user_addr
>= TASK_SIZE
) {
467 pr_warn("Failed to allocate user memory\n");
470 execute_user_location((void *)user_addr
);
471 vm_munmap(user_addr
, PAGE_SIZE
);
474 case CT_ACCESS_USERSPACE
: {
475 unsigned long user_addr
, tmp
= 0;
478 user_addr
= vm_mmap(NULL
, 0, PAGE_SIZE
,
479 PROT_READ
| PROT_WRITE
| PROT_EXEC
,
480 MAP_ANONYMOUS
| MAP_PRIVATE
, 0);
481 if (user_addr
>= TASK_SIZE
) {
482 pr_warn("Failed to allocate user memory\n");
486 if (copy_to_user((void __user
*)user_addr
, &tmp
, sizeof(tmp
))) {
487 pr_warn("copy_to_user failed\n");
488 vm_munmap(user_addr
, PAGE_SIZE
);
492 ptr
= (unsigned long *)user_addr
;
494 pr_info("attempting bad read at %p\n", ptr
);
498 pr_info("attempting bad write at %p\n", ptr
);
501 vm_munmap(user_addr
, PAGE_SIZE
);
508 ptr
= (unsigned long *)&rodata
;
510 pr_info("attempting bad write at %p\n", ptr
);
515 case CT_WRITE_KERN
: {
519 size
= (unsigned long)do_overwritten
-
520 (unsigned long)do_nothing
;
521 ptr
= (unsigned char *)do_overwritten
;
523 pr_info("attempting bad %zu byte write at %p\n", size
, ptr
);
524 memcpy(ptr
, (unsigned char *)do_nothing
, size
);
525 flush_icache_range((unsigned long)ptr
,
526 (unsigned long)(ptr
+ size
));
538 static void lkdtm_handler(void)
543 spin_lock_irqsave(&count_lock
, flags
);
545 pr_info("Crash point %s of type %s hit, trigger in %d rounds\n",
546 cp_name_to_str(cpoint
), cp_type_to_str(cptype
), count
);
550 count
= cpoint_count
;
552 spin_unlock_irqrestore(&count_lock
, flags
);
555 lkdtm_do_action(cptype
);
558 static int lkdtm_register_cpoint(enum cname which
)
563 if (lkdtm
.entry
!= NULL
)
564 unregister_jprobe(&lkdtm
);
568 lkdtm_do_action(cptype
);
570 case CN_INT_HARDWARE_ENTRY
:
571 lkdtm
.kp
.symbol_name
= "do_IRQ";
572 lkdtm
.entry
= (kprobe_opcode_t
*) jp_do_irq
;
574 case CN_INT_HW_IRQ_EN
:
575 lkdtm
.kp
.symbol_name
= "handle_IRQ_event";
576 lkdtm
.entry
= (kprobe_opcode_t
*) jp_handle_irq_event
;
578 case CN_INT_TASKLET_ENTRY
:
579 lkdtm
.kp
.symbol_name
= "tasklet_action";
580 lkdtm
.entry
= (kprobe_opcode_t
*) jp_tasklet_action
;
583 lkdtm
.kp
.symbol_name
= "ll_rw_block";
584 lkdtm
.entry
= (kprobe_opcode_t
*) jp_ll_rw_block
;
587 lkdtm
.kp
.symbol_name
= "shrink_inactive_list";
588 lkdtm
.entry
= (kprobe_opcode_t
*) jp_shrink_inactive_list
;
591 lkdtm
.kp
.symbol_name
= "hrtimer_start";
592 lkdtm
.entry
= (kprobe_opcode_t
*) jp_hrtimer_start
;
594 case CN_SCSI_DISPATCH_CMD
:
595 lkdtm
.kp
.symbol_name
= "scsi_dispatch_cmd";
596 lkdtm
.entry
= (kprobe_opcode_t
*) jp_scsi_dispatch_cmd
;
600 lkdtm
.kp
.symbol_name
= "generic_ide_ioctl";
601 lkdtm
.entry
= (kprobe_opcode_t
*) jp_generic_ide_ioctl
;
603 pr_info("Crash point not available\n");
608 pr_info("Invalid Crash Point\n");
613 if ((ret
= register_jprobe(&lkdtm
)) < 0) {
614 pr_info("Couldn't register jprobe\n");
621 static ssize_t
do_register_entry(enum cname which
, struct file
*f
,
622 const char __user
*user_buf
, size_t count
, loff_t
*off
)
627 if (count
>= PAGE_SIZE
)
630 buf
= (char *)__get_free_page(GFP_KERNEL
);
633 if (copy_from_user(buf
, user_buf
, count
)) {
634 free_page((unsigned long) buf
);
637 /* NULL-terminate and remove enter */
641 cptype
= parse_cp_type(buf
, count
);
642 free_page((unsigned long) buf
);
644 if (cptype
== CT_NONE
)
647 err
= lkdtm_register_cpoint(which
);
656 /* Generic read callback that just prints out the available crash types */
657 static ssize_t
lkdtm_debugfs_read(struct file
*f
, char __user
*user_buf
,
658 size_t count
, loff_t
*off
)
663 buf
= (char *)__get_free_page(GFP_KERNEL
);
667 n
= snprintf(buf
, PAGE_SIZE
, "Available crash types:\n");
668 for (i
= 0; i
< ARRAY_SIZE(cp_type
); i
++)
669 n
+= snprintf(buf
+ n
, PAGE_SIZE
- n
, "%s\n", cp_type
[i
]);
672 out
= simple_read_from_buffer(user_buf
, count
, off
,
674 free_page((unsigned long) buf
);
679 static int lkdtm_debugfs_open(struct inode
*inode
, struct file
*file
)
685 static ssize_t
int_hardware_entry(struct file
*f
, const char __user
*buf
,
686 size_t count
, loff_t
*off
)
688 return do_register_entry(CN_INT_HARDWARE_ENTRY
, f
, buf
, count
, off
);
691 static ssize_t
int_hw_irq_en(struct file
*f
, const char __user
*buf
,
692 size_t count
, loff_t
*off
)
694 return do_register_entry(CN_INT_HW_IRQ_EN
, f
, buf
, count
, off
);
697 static ssize_t
int_tasklet_entry(struct file
*f
, const char __user
*buf
,
698 size_t count
, loff_t
*off
)
700 return do_register_entry(CN_INT_TASKLET_ENTRY
, f
, buf
, count
, off
);
703 static ssize_t
fs_devrw_entry(struct file
*f
, const char __user
*buf
,
704 size_t count
, loff_t
*off
)
706 return do_register_entry(CN_FS_DEVRW
, f
, buf
, count
, off
);
709 static ssize_t
mem_swapout_entry(struct file
*f
, const char __user
*buf
,
710 size_t count
, loff_t
*off
)
712 return do_register_entry(CN_MEM_SWAPOUT
, f
, buf
, count
, off
);
715 static ssize_t
timeradd_entry(struct file
*f
, const char __user
*buf
,
716 size_t count
, loff_t
*off
)
718 return do_register_entry(CN_TIMERADD
, f
, buf
, count
, off
);
721 static ssize_t
scsi_dispatch_cmd_entry(struct file
*f
,
722 const char __user
*buf
, size_t count
, loff_t
*off
)
724 return do_register_entry(CN_SCSI_DISPATCH_CMD
, f
, buf
, count
, off
);
727 static ssize_t
ide_core_cp_entry(struct file
*f
, const char __user
*buf
,
728 size_t count
, loff_t
*off
)
730 return do_register_entry(CN_IDE_CORE_CP
, f
, buf
, count
, off
);
733 /* Special entry to just crash directly. Available without KPROBEs */
734 static ssize_t
direct_entry(struct file
*f
, const char __user
*user_buf
,
735 size_t count
, loff_t
*off
)
740 if (count
>= PAGE_SIZE
)
745 buf
= (char *)__get_free_page(GFP_KERNEL
);
748 if (copy_from_user(buf
, user_buf
, count
)) {
749 free_page((unsigned long) buf
);
752 /* NULL-terminate and remove enter */
756 type
= parse_cp_type(buf
, count
);
757 free_page((unsigned long) buf
);
761 pr_info("Performing direct entry %s\n", cp_type_to_str(type
));
762 lkdtm_do_action(type
);
770 const struct file_operations fops
;
773 static const struct crash_entry crash_entries
[] = {
774 {"DIRECT", {.read
= lkdtm_debugfs_read
,
775 .llseek
= generic_file_llseek
,
776 .open
= lkdtm_debugfs_open
,
777 .write
= direct_entry
} },
778 {"INT_HARDWARE_ENTRY", {.read
= lkdtm_debugfs_read
,
779 .llseek
= generic_file_llseek
,
780 .open
= lkdtm_debugfs_open
,
781 .write
= int_hardware_entry
} },
782 {"INT_HW_IRQ_EN", {.read
= lkdtm_debugfs_read
,
783 .llseek
= generic_file_llseek
,
784 .open
= lkdtm_debugfs_open
,
785 .write
= int_hw_irq_en
} },
786 {"INT_TASKLET_ENTRY", {.read
= lkdtm_debugfs_read
,
787 .llseek
= generic_file_llseek
,
788 .open
= lkdtm_debugfs_open
,
789 .write
= int_tasklet_entry
} },
790 {"FS_DEVRW", {.read
= lkdtm_debugfs_read
,
791 .llseek
= generic_file_llseek
,
792 .open
= lkdtm_debugfs_open
,
793 .write
= fs_devrw_entry
} },
794 {"MEM_SWAPOUT", {.read
= lkdtm_debugfs_read
,
795 .llseek
= generic_file_llseek
,
796 .open
= lkdtm_debugfs_open
,
797 .write
= mem_swapout_entry
} },
798 {"TIMERADD", {.read
= lkdtm_debugfs_read
,
799 .llseek
= generic_file_llseek
,
800 .open
= lkdtm_debugfs_open
,
801 .write
= timeradd_entry
} },
802 {"SCSI_DISPATCH_CMD", {.read
= lkdtm_debugfs_read
,
803 .llseek
= generic_file_llseek
,
804 .open
= lkdtm_debugfs_open
,
805 .write
= scsi_dispatch_cmd_entry
} },
806 {"IDE_CORE_CP", {.read
= lkdtm_debugfs_read
,
807 .llseek
= generic_file_llseek
,
808 .open
= lkdtm_debugfs_open
,
809 .write
= ide_core_cp_entry
} },
812 static struct dentry
*lkdtm_debugfs_root
;
814 static int __init
lkdtm_module_init(void)
817 int n_debugfs_entries
= 1; /* Assume only the direct entry */
820 /* Register debugfs interface */
821 lkdtm_debugfs_root
= debugfs_create_dir("provoke-crash", NULL
);
822 if (!lkdtm_debugfs_root
) {
823 pr_err("creating root dir failed\n");
827 #ifdef CONFIG_KPROBES
828 n_debugfs_entries
= ARRAY_SIZE(crash_entries
);
831 for (i
= 0; i
< n_debugfs_entries
; i
++) {
832 const struct crash_entry
*cur
= &crash_entries
[i
];
835 de
= debugfs_create_file(cur
->name
, 0644, lkdtm_debugfs_root
,
838 pr_err("could not create %s\n", cur
->name
);
843 if (lkdtm_parse_commandline() == -EINVAL
) {
844 pr_info("Invalid command\n");
848 if (cpoint
!= CN_INVALID
&& cptype
!= CT_NONE
) {
849 ret
= lkdtm_register_cpoint(cpoint
);
851 pr_info("Invalid crash point %d\n", cpoint
);
854 pr_info("Crash point %s of type %s registered\n",
855 cpoint_name
, cpoint_type
);
857 pr_info("No crash points registered, enable through debugfs\n");
863 debugfs_remove_recursive(lkdtm_debugfs_root
);
867 static void __exit
lkdtm_module_exit(void)
869 debugfs_remove_recursive(lkdtm_debugfs_root
);
871 unregister_jprobe(&lkdtm
);
872 pr_info("Crash point unregistered\n");
875 module_init(lkdtm_module_init
);
876 module_exit(lkdtm_module_exit
);
878 MODULE_LICENSE("GPL");
879 MODULE_DESCRIPTION("Kprobe module for testing crash dumps");