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>
49 #include <linux/ide.h>
53 * Make sure our attempts to over run the kernel stack doesn't trigger
54 * a compiler warning when CONFIG_FRAME_WARN is set. Then make sure we
55 * recurse past the end of THREAD_SIZE by default.
57 #if defined(CONFIG_FRAME_WARN) && (CONFIG_FRAME_WARN > 0)
58 #define REC_STACK_SIZE (CONFIG_FRAME_WARN / 2)
60 #define REC_STACK_SIZE (THREAD_SIZE / 8)
62 #define REC_NUM_DEFAULT ((THREAD_SIZE / REC_STACK_SIZE) * 2)
64 #define DEFAULT_COUNT 10
69 CN_INT_HARDWARE_ENTRY
,
89 CT_UNALIGNED_LOAD_STORE_WRITE
,
90 CT_OVERWRITE_ALLOCATION
,
102 static char* cp_name
[] = {
103 "INT_HARDWARE_ENTRY",
114 static char* cp_type
[] = {
122 "UNALIGNED_LOAD_STORE_WRITE",
123 "OVERWRITE_ALLOCATION",
135 static struct jprobe lkdtm
;
137 static int lkdtm_parse_commandline(void);
138 static void lkdtm_handler(void);
140 static char* cpoint_name
;
141 static char* cpoint_type
;
142 static int cpoint_count
= DEFAULT_COUNT
;
143 static int recur_count
= REC_NUM_DEFAULT
;
145 static enum cname cpoint
= CN_INVALID
;
146 static enum ctype cptype
= CT_NONE
;
147 static int count
= DEFAULT_COUNT
;
148 static DEFINE_SPINLOCK(count_lock
);
149 static DEFINE_SPINLOCK(lock_me_up
);
151 static u8 data_area
[EXEC_SIZE
];
153 module_param(recur_count
, int, 0644);
154 MODULE_PARM_DESC(recur_count
, " Recursion level for the stack overflow test");
155 module_param(cpoint_name
, charp
, 0444);
156 MODULE_PARM_DESC(cpoint_name
, " Crash Point, where kernel is to be crashed");
157 module_param(cpoint_type
, charp
, 0444);
158 MODULE_PARM_DESC(cpoint_type
, " Crash Point Type, action to be taken on "\
159 "hitting the crash point");
160 module_param(cpoint_count
, int, 0644);
161 MODULE_PARM_DESC(cpoint_count
, " Crash Point Count, number of times the "\
162 "crash point is to be hit to trigger action");
164 static unsigned int jp_do_irq(unsigned int irq
)
171 static irqreturn_t
jp_handle_irq_event(unsigned int irq
,
172 struct irqaction
*action
)
179 static void jp_tasklet_action(struct softirq_action
*a
)
185 static void jp_ll_rw_block(int rw
, int nr
, struct buffer_head
*bhs
[])
193 static unsigned long jp_shrink_inactive_list(unsigned long max_scan
,
195 struct scan_control
*sc
)
202 static int jp_hrtimer_start(struct hrtimer
*timer
, ktime_t tim
,
203 const enum hrtimer_mode mode
)
210 static int jp_scsi_dispatch_cmd(struct scsi_cmnd
*cmd
)
218 int jp_generic_ide_ioctl(ide_drive_t
*drive
, struct file
*file
,
219 struct block_device
*bdev
, unsigned int cmd
,
228 /* Return the crashpoint number or NONE if the name is invalid */
229 static enum ctype
parse_cp_type(const char *what
, size_t count
)
233 for (i
= 0; i
< ARRAY_SIZE(cp_type
); i
++) {
234 if (!strcmp(what
, cp_type
[i
]))
241 static const char *cp_type_to_str(enum ctype type
)
243 if (type
== CT_NONE
|| type
< 0 || type
> ARRAY_SIZE(cp_type
))
246 return cp_type
[type
- 1];
249 static const char *cp_name_to_str(enum cname name
)
251 if (name
== CN_INVALID
|| name
< 0 || name
> ARRAY_SIZE(cp_name
))
254 return cp_name
[name
- 1];
258 static int lkdtm_parse_commandline(void)
263 if (cpoint_count
< 1 || recur_count
< 1)
266 spin_lock_irqsave(&count_lock
, flags
);
267 count
= cpoint_count
;
268 spin_unlock_irqrestore(&count_lock
, flags
);
270 /* No special parameters */
271 if (!cpoint_type
&& !cpoint_name
)
274 /* Neither or both of these need to be set */
275 if (!cpoint_type
|| !cpoint_name
)
278 cptype
= parse_cp_type(cpoint_type
, strlen(cpoint_type
));
279 if (cptype
== CT_NONE
)
282 for (i
= 0; i
< ARRAY_SIZE(cp_name
); i
++) {
283 if (!strcmp(cpoint_name
, cp_name
[i
])) {
289 /* Could not find a valid crash point */
293 static int recursive_loop(int remaining
)
295 char buf
[REC_STACK_SIZE
];
297 /* Make sure compiler does not optimize this away. */
298 memset(buf
, (remaining
& 0xff) | 0x1, REC_STACK_SIZE
);
302 return recursive_loop(remaining
- 1);
305 static void do_nothing(void)
310 static noinline
void corrupt_stack(void)
312 /* Use default char array length that triggers stack protection. */
315 memset((void *)data
, 0, 64);
318 static void execute_location(void *dst
)
320 void (*func
)(void) = dst
;
322 memcpy(dst
, do_nothing
, EXEC_SIZE
);
326 static void lkdtm_do_action(enum ctype which
)
346 (void) recursive_loop(recur_count
);
348 case CT_CORRUPT_STACK
:
351 case CT_UNALIGNED_LOAD_STORE_WRITE
: {
352 static u8 data
[5] __attribute__((aligned(4))) = {1, 2,
355 u32 val
= 0x12345678;
357 p
= (u32
*)(data
+ 1);
363 case CT_OVERWRITE_ALLOCATION
: {
365 u32
*data
= kmalloc(len
, GFP_KERNEL
);
367 data
[1024 / sizeof(u32
)] = 0x12345678;
371 case CT_WRITE_AFTER_FREE
: {
373 u32
*data
= kmalloc(len
, GFP_KERNEL
);
377 memset(data
, 0x78, len
);
391 /* Must be called twice to trigger. */
392 spin_lock(&lock_me_up
);
395 set_current_state(TASK_UNINTERRUPTIBLE
);
399 execute_location(data_area
);
401 case CT_EXEC_STACK
: {
402 u8 stack_area
[EXEC_SIZE
];
403 execute_location(stack_area
);
406 case CT_EXEC_KMALLOC
: {
407 u32
*kmalloc_area
= kmalloc(EXEC_SIZE
, GFP_KERNEL
);
408 execute_location(kmalloc_area
);
412 case CT_EXEC_VMALLOC
: {
413 u32
*vmalloc_area
= vmalloc(EXEC_SIZE
);
414 execute_location(vmalloc_area
);
425 static void lkdtm_handler(void)
430 spin_lock_irqsave(&count_lock
, flags
);
432 printk(KERN_INFO
"lkdtm: Crash point %s of type %s hit, trigger in %d rounds\n",
433 cp_name_to_str(cpoint
), cp_type_to_str(cptype
), count
);
437 count
= cpoint_count
;
439 spin_unlock_irqrestore(&count_lock
, flags
);
442 lkdtm_do_action(cptype
);
445 static int lkdtm_register_cpoint(enum cname which
)
450 if (lkdtm
.entry
!= NULL
)
451 unregister_jprobe(&lkdtm
);
455 lkdtm_do_action(cptype
);
457 case CN_INT_HARDWARE_ENTRY
:
458 lkdtm
.kp
.symbol_name
= "do_IRQ";
459 lkdtm
.entry
= (kprobe_opcode_t
*) jp_do_irq
;
461 case CN_INT_HW_IRQ_EN
:
462 lkdtm
.kp
.symbol_name
= "handle_IRQ_event";
463 lkdtm
.entry
= (kprobe_opcode_t
*) jp_handle_irq_event
;
465 case CN_INT_TASKLET_ENTRY
:
466 lkdtm
.kp
.symbol_name
= "tasklet_action";
467 lkdtm
.entry
= (kprobe_opcode_t
*) jp_tasklet_action
;
470 lkdtm
.kp
.symbol_name
= "ll_rw_block";
471 lkdtm
.entry
= (kprobe_opcode_t
*) jp_ll_rw_block
;
474 lkdtm
.kp
.symbol_name
= "shrink_inactive_list";
475 lkdtm
.entry
= (kprobe_opcode_t
*) jp_shrink_inactive_list
;
478 lkdtm
.kp
.symbol_name
= "hrtimer_start";
479 lkdtm
.entry
= (kprobe_opcode_t
*) jp_hrtimer_start
;
481 case CN_SCSI_DISPATCH_CMD
:
482 lkdtm
.kp
.symbol_name
= "scsi_dispatch_cmd";
483 lkdtm
.entry
= (kprobe_opcode_t
*) jp_scsi_dispatch_cmd
;
487 lkdtm
.kp
.symbol_name
= "generic_ide_ioctl";
488 lkdtm
.entry
= (kprobe_opcode_t
*) jp_generic_ide_ioctl
;
490 printk(KERN_INFO
"lkdtm: Crash point not available\n");
495 printk(KERN_INFO
"lkdtm: Invalid Crash Point\n");
500 if ((ret
= register_jprobe(&lkdtm
)) < 0) {
501 printk(KERN_INFO
"lkdtm: Couldn't register jprobe\n");
508 static ssize_t
do_register_entry(enum cname which
, struct file
*f
,
509 const char __user
*user_buf
, size_t count
, loff_t
*off
)
514 if (count
>= PAGE_SIZE
)
517 buf
= (char *)__get_free_page(GFP_KERNEL
);
520 if (copy_from_user(buf
, user_buf
, count
)) {
521 free_page((unsigned long) buf
);
524 /* NULL-terminate and remove enter */
528 cptype
= parse_cp_type(buf
, count
);
529 free_page((unsigned long) buf
);
531 if (cptype
== CT_NONE
)
534 err
= lkdtm_register_cpoint(which
);
543 /* Generic read callback that just prints out the available crash types */
544 static ssize_t
lkdtm_debugfs_read(struct file
*f
, char __user
*user_buf
,
545 size_t count
, loff_t
*off
)
550 buf
= (char *)__get_free_page(GFP_KERNEL
);
554 n
= snprintf(buf
, PAGE_SIZE
, "Available crash types:\n");
555 for (i
= 0; i
< ARRAY_SIZE(cp_type
); i
++)
556 n
+= snprintf(buf
+ n
, PAGE_SIZE
- n
, "%s\n", cp_type
[i
]);
559 out
= simple_read_from_buffer(user_buf
, count
, off
,
561 free_page((unsigned long) buf
);
566 static int lkdtm_debugfs_open(struct inode
*inode
, struct file
*file
)
572 static ssize_t
int_hardware_entry(struct file
*f
, const char __user
*buf
,
573 size_t count
, loff_t
*off
)
575 return do_register_entry(CN_INT_HARDWARE_ENTRY
, f
, buf
, count
, off
);
578 static ssize_t
int_hw_irq_en(struct file
*f
, const char __user
*buf
,
579 size_t count
, loff_t
*off
)
581 return do_register_entry(CN_INT_HW_IRQ_EN
, f
, buf
, count
, off
);
584 static ssize_t
int_tasklet_entry(struct file
*f
, const char __user
*buf
,
585 size_t count
, loff_t
*off
)
587 return do_register_entry(CN_INT_TASKLET_ENTRY
, f
, buf
, count
, off
);
590 static ssize_t
fs_devrw_entry(struct file
*f
, const char __user
*buf
,
591 size_t count
, loff_t
*off
)
593 return do_register_entry(CN_FS_DEVRW
, f
, buf
, count
, off
);
596 static ssize_t
mem_swapout_entry(struct file
*f
, const char __user
*buf
,
597 size_t count
, loff_t
*off
)
599 return do_register_entry(CN_MEM_SWAPOUT
, f
, buf
, count
, off
);
602 static ssize_t
timeradd_entry(struct file
*f
, const char __user
*buf
,
603 size_t count
, loff_t
*off
)
605 return do_register_entry(CN_TIMERADD
, f
, buf
, count
, off
);
608 static ssize_t
scsi_dispatch_cmd_entry(struct file
*f
,
609 const char __user
*buf
, size_t count
, loff_t
*off
)
611 return do_register_entry(CN_SCSI_DISPATCH_CMD
, f
, buf
, count
, off
);
614 static ssize_t
ide_core_cp_entry(struct file
*f
, const char __user
*buf
,
615 size_t count
, loff_t
*off
)
617 return do_register_entry(CN_IDE_CORE_CP
, f
, buf
, count
, off
);
620 /* Special entry to just crash directly. Available without KPROBEs */
621 static ssize_t
direct_entry(struct file
*f
, const char __user
*user_buf
,
622 size_t count
, loff_t
*off
)
627 if (count
>= PAGE_SIZE
)
632 buf
= (char *)__get_free_page(GFP_KERNEL
);
635 if (copy_from_user(buf
, user_buf
, count
)) {
636 free_page((unsigned long) buf
);
639 /* NULL-terminate and remove enter */
643 type
= parse_cp_type(buf
, count
);
644 free_page((unsigned long) buf
);
648 printk(KERN_INFO
"lkdtm: Performing direct entry %s\n",
649 cp_type_to_str(type
));
650 lkdtm_do_action(type
);
658 const struct file_operations fops
;
661 static const struct crash_entry crash_entries
[] = {
662 {"DIRECT", {.read
= lkdtm_debugfs_read
,
663 .llseek
= generic_file_llseek
,
664 .open
= lkdtm_debugfs_open
,
665 .write
= direct_entry
} },
666 {"INT_HARDWARE_ENTRY", {.read
= lkdtm_debugfs_read
,
667 .llseek
= generic_file_llseek
,
668 .open
= lkdtm_debugfs_open
,
669 .write
= int_hardware_entry
} },
670 {"INT_HW_IRQ_EN", {.read
= lkdtm_debugfs_read
,
671 .llseek
= generic_file_llseek
,
672 .open
= lkdtm_debugfs_open
,
673 .write
= int_hw_irq_en
} },
674 {"INT_TASKLET_ENTRY", {.read
= lkdtm_debugfs_read
,
675 .llseek
= generic_file_llseek
,
676 .open
= lkdtm_debugfs_open
,
677 .write
= int_tasklet_entry
} },
678 {"FS_DEVRW", {.read
= lkdtm_debugfs_read
,
679 .llseek
= generic_file_llseek
,
680 .open
= lkdtm_debugfs_open
,
681 .write
= fs_devrw_entry
} },
682 {"MEM_SWAPOUT", {.read
= lkdtm_debugfs_read
,
683 .llseek
= generic_file_llseek
,
684 .open
= lkdtm_debugfs_open
,
685 .write
= mem_swapout_entry
} },
686 {"TIMERADD", {.read
= lkdtm_debugfs_read
,
687 .llseek
= generic_file_llseek
,
688 .open
= lkdtm_debugfs_open
,
689 .write
= timeradd_entry
} },
690 {"SCSI_DISPATCH_CMD", {.read
= lkdtm_debugfs_read
,
691 .llseek
= generic_file_llseek
,
692 .open
= lkdtm_debugfs_open
,
693 .write
= scsi_dispatch_cmd_entry
} },
694 {"IDE_CORE_CP", {.read
= lkdtm_debugfs_read
,
695 .llseek
= generic_file_llseek
,
696 .open
= lkdtm_debugfs_open
,
697 .write
= ide_core_cp_entry
} },
700 static struct dentry
*lkdtm_debugfs_root
;
702 static int __init
lkdtm_module_init(void)
705 int n_debugfs_entries
= 1; /* Assume only the direct entry */
708 /* Register debugfs interface */
709 lkdtm_debugfs_root
= debugfs_create_dir("provoke-crash", NULL
);
710 if (!lkdtm_debugfs_root
) {
711 printk(KERN_ERR
"lkdtm: creating root dir failed\n");
715 #ifdef CONFIG_KPROBES
716 n_debugfs_entries
= ARRAY_SIZE(crash_entries
);
719 for (i
= 0; i
< n_debugfs_entries
; i
++) {
720 const struct crash_entry
*cur
= &crash_entries
[i
];
723 de
= debugfs_create_file(cur
->name
, 0644, lkdtm_debugfs_root
,
726 printk(KERN_ERR
"lkdtm: could not create %s\n",
732 if (lkdtm_parse_commandline() == -EINVAL
) {
733 printk(KERN_INFO
"lkdtm: Invalid command\n");
737 if (cpoint
!= CN_INVALID
&& cptype
!= CT_NONE
) {
738 ret
= lkdtm_register_cpoint(cpoint
);
740 printk(KERN_INFO
"lkdtm: Invalid crash point %d\n",
744 printk(KERN_INFO
"lkdtm: Crash point %s of type %s registered\n",
745 cpoint_name
, cpoint_type
);
747 printk(KERN_INFO
"lkdtm: No crash points registered, enable through debugfs\n");
753 debugfs_remove_recursive(lkdtm_debugfs_root
);
757 static void __exit
lkdtm_module_exit(void)
759 debugfs_remove_recursive(lkdtm_debugfs_root
);
761 unregister_jprobe(&lkdtm
);
762 printk(KERN_INFO
"lkdtm: Crash point unregistered\n");
765 module_init(lkdtm_module_init
);
766 module_exit(lkdtm_module_exit
);
768 MODULE_LICENSE("GPL");