drivers/misc/lkdtm_core.c

   1 /*
   2  * Linux Kernel Dump Test Module for testing kernel crashes conditions:
   3  * induces system failures at predefined crashpoints and under predefined
   4  * operational conditions in order to evaluate the reliability of kernel
   5  * sanity checking and crash dumps obtained using different dumping
   6  * solutions.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  21  *
  22  * Copyright (C) IBM Corporation, 2006
  23  *
  24  * Author: Ankita Garg <ankita@in.ibm.com>
  25  *
  26  * It is adapted from the Linux Kernel Dump Test Tool by
  27  * Fernando Luis Vazquez Cao <http://lkdtt.sourceforge.net>
  28  *
  29  * Debugfs support added by Simon Kagstrom <simon.kagstrom@netinsight.net>
  30  *
  31  * See Documentation/fault-injection/provoke-crashes.txt for instructions
  32  */
  33 #include "lkdtm.h"
  34 #include <linux/fs.h>
  35 #include <linux/module.h>
  36 #include <linux/buffer_head.h>
  37 #include <linux/kprobes.h>
  38 #include <linux/list.h>
  39 #include <linux/init.h>
  40 #include <linux/interrupt.h>
  41 #include <linux/hrtimer.h>
  42 #include <linux/slab.h>
  43 #include <scsi/scsi_cmnd.h>
  44 #include <linux/debugfs.h>
  45
  46 #ifdef CONFIG_IDE
  47 #include <linux/ide.h>
  48 #endif
  49
  50 #define DEFAULT_COUNT 10
  51
  52 static int lkdtm_debugfs_open(struct inode *inode, struct file *file);
  53 static ssize_t lkdtm_debugfs_read(struct file *f, char __user *user_buf,
  54                 size_t count, loff_t *off);
  55 static ssize_t direct_entry(struct file *f, const char __user *user_buf,
  56                             size_t count, loff_t *off);
  57
  58 #ifdef CONFIG_KPROBES
  59 static void lkdtm_handler(void);
  60 static ssize_t lkdtm_debugfs_entry(struct file *f,
  61                                    const char __user *user_buf,
  62                                    size_t count, loff_t *off);
  63
  64
  65 /* jprobe entry point handlers. */
  66 static unsigned int jp_do_irq(unsigned int irq)
  67 {
  68         lkdtm_handler();
  69         jprobe_return();
  70         return 0;
  71 }
  72
  73 static irqreturn_t jp_handle_irq_event(unsigned int irq,
  74                                        struct irqaction *action)
  75 {
  76         lkdtm_handler();
  77         jprobe_return();
  78         return 0;
  79 }
  80
  81 static void jp_tasklet_action(struct softirq_action *a)
  82 {
  83         lkdtm_handler();
  84         jprobe_return();
  85 }
  86
  87 static void jp_ll_rw_block(int rw, int nr, struct buffer_head *bhs[])
  88 {
  89         lkdtm_handler();
  90         jprobe_return();
  91 }
  92
  93 struct scan_control;
  94
  95 static unsigned long jp_shrink_inactive_list(unsigned long max_scan,
  96                                              struct zone *zone,
  97                                              struct scan_control *sc)
  98 {
  99         lkdtm_handler();
 100         jprobe_return();
 101         return 0;
 102 }
 103
 104 static int jp_hrtimer_start(struct hrtimer *timer, ktime_t tim,
 105                             const enum hrtimer_mode mode)
 106 {
 107         lkdtm_handler();
 108         jprobe_return();
 109         return 0;
 110 }
 111
 112 static int jp_scsi_dispatch_cmd(struct scsi_cmnd *cmd)
 113 {
 114         lkdtm_handler();
 115         jprobe_return();
 116         return 0;
 117 }
 118
 119 # ifdef CONFIG_IDE
 120 static int jp_generic_ide_ioctl(ide_drive_t *drive, struct file *file,
 121                         struct block_device *bdev, unsigned int cmd,
 122                         unsigned long arg)
 123 {
 124         lkdtm_handler();
 125         jprobe_return();
 126         return 0;
 127 }
 128 # endif
 129 #endif
 130
 131 /* Crash points */
 132 struct crashpoint {
 133         const char *name;
 134         const struct file_operations fops;
 135         struct jprobe jprobe;
 136 };
 137
 138 #define CRASHPOINT(_name, _write, _symbol, _entry)              \
 139         {                                                       \
 140                 .name = _name,                                  \
 141                 .fops = {                                       \
 142                         .read   = lkdtm_debugfs_read,           \
 143                         .llseek = generic_file_llseek,          \
 144                         .open   = lkdtm_debugfs_open,           \
 145                         .write  = _write,                       \
 146                 },                                              \
 147                 .jprobe = {                                     \
 148                         .kp.symbol_name = _symbol,              \
 149                         .entry = (kprobe_opcode_t *)_entry,     \
 150                 },                                              \
 151         }
 152
 153 /* Define the possible places where we can trigger a crash point. */
 154 struct crashpoint crashpoints[] = {
 155         CRASHPOINT("DIRECT",                    direct_entry,
 156                    NULL,                        NULL),
 157 #ifdef CONFIG_KPROBES
 158         CRASHPOINT("INT_HARDWARE_ENTRY",        lkdtm_debugfs_entry,
 159                    "do_IRQ",                    jp_do_irq),
 160         CRASHPOINT("INT_HW_IRQ_EN",             lkdtm_debugfs_entry,
 161                    "handle_IRQ_event",          jp_handle_irq_event),
 162         CRASHPOINT("INT_TASKLET_ENTRY",         lkdtm_debugfs_entry,
 163                    "tasklet_action",            jp_tasklet_action),
 164         CRASHPOINT("FS_DEVRW",                  lkdtm_debugfs_entry,
 165                    "ll_rw_block",               jp_ll_rw_block),
 166         CRASHPOINT("MEM_SWAPOUT",               lkdtm_debugfs_entry,
 167                    "shrink_inactive_list",      jp_shrink_inactive_list),
 168         CRASHPOINT("TIMERADD",                  lkdtm_debugfs_entry,
 169                    "hrtimer_start",             jp_hrtimer_start),
 170         CRASHPOINT("SCSI_DISPATCH_CMD",         lkdtm_debugfs_entry,
 171                    "scsi_dispatch_cmd",         jp_scsi_dispatch_cmd),
 172 # ifdef CONFIG_IDE
 173         CRASHPOINT("IDE_CORE_CP",               lkdtm_debugfs_entry,
 174                    "generic_ide_ioctl",         jp_generic_ide_ioctl),
 175 # endif
 176 #endif
 177 };
 178
 179
 180 /* Crash types. */
 181 struct crashtype {
 182         const char *name;
 183         void (*func)(void);
 184 };
 185
 186 #define CRASHTYPE(_name)                        \
 187         {                                       \
 188                 .name = __stringify(_name),     \
 189                 .func = lkdtm_ ## _name,        \
 190         }
 191
 192 /* Define the possible types of crashes that can be triggered. */
 193 struct crashtype crashtypes[] = {
 194         CRASHTYPE(PANIC),
 195         CRASHTYPE(BUG),
 196         CRASHTYPE(WARNING),
 197         CRASHTYPE(EXCEPTION),
 198         CRASHTYPE(LOOP),
 199         CRASHTYPE(OVERFLOW),
 200         CRASHTYPE(CORRUPT_LIST_ADD),
 201         CRASHTYPE(CORRUPT_LIST_DEL),
 202         CRASHTYPE(CORRUPT_STACK),
 203         CRASHTYPE(UNALIGNED_LOAD_STORE_WRITE),
 204         CRASHTYPE(OVERWRITE_ALLOCATION),
 205         CRASHTYPE(WRITE_AFTER_FREE),
 206         CRASHTYPE(READ_AFTER_FREE),
 207         CRASHTYPE(WRITE_BUDDY_AFTER_FREE),
 208         CRASHTYPE(READ_BUDDY_AFTER_FREE),
 209         CRASHTYPE(SOFTLOCKUP),
 210         CRASHTYPE(HARDLOCKUP),
 211         CRASHTYPE(SPINLOCKUP),
 212         CRASHTYPE(HUNG_TASK),
 213         CRASHTYPE(EXEC_DATA),
 214         CRASHTYPE(EXEC_STACK),
 215         CRASHTYPE(EXEC_KMALLOC),
 216         CRASHTYPE(EXEC_VMALLOC),
 217         CRASHTYPE(EXEC_RODATA),
 218         CRASHTYPE(EXEC_USERSPACE),
 219         CRASHTYPE(ACCESS_USERSPACE),
 220         CRASHTYPE(WRITE_RO),
 221         CRASHTYPE(WRITE_RO_AFTER_INIT),
 222         CRASHTYPE(WRITE_KERN),
 223         CRASHTYPE(REFCOUNT_SATURATE_INC),
 224         CRASHTYPE(REFCOUNT_SATURATE_ADD),
 225         CRASHTYPE(REFCOUNT_ZERO_DEC),
 226         CRASHTYPE(REFCOUNT_ZERO_INC),
 227         CRASHTYPE(REFCOUNT_ZERO_SUB),
 228         CRASHTYPE(REFCOUNT_ZERO_ADD),
 229         CRASHTYPE(USERCOPY_HEAP_SIZE_TO),
 230         CRASHTYPE(USERCOPY_HEAP_SIZE_FROM),
 231         CRASHTYPE(USERCOPY_HEAP_FLAG_TO),
 232         CRASHTYPE(USERCOPY_HEAP_FLAG_FROM),
 233         CRASHTYPE(USERCOPY_STACK_FRAME_TO),
 234         CRASHTYPE(USERCOPY_STACK_FRAME_FROM),
 235         CRASHTYPE(USERCOPY_STACK_BEYOND),
 236         CRASHTYPE(USERCOPY_KERNEL),
 237 };
 238
 239
 240 /* Global jprobe entry and crashtype. */
 241 static struct jprobe *lkdtm_jprobe;
 242 struct crashpoint *lkdtm_crashpoint;
 243 struct crashtype *lkdtm_crashtype;
 244
 245 /* Module parameters */
 246 static int recur_count = -1;
 247 module_param(recur_count, int, 0644);
 248 MODULE_PARM_DESC(recur_count, " Recursion level for the stack overflow test");
 249
 250 static char* cpoint_name;
 251 module_param(cpoint_name, charp, 0444);
 252 MODULE_PARM_DESC(cpoint_name, " Crash Point, where kernel is to be crashed");
 253
 254 static char* cpoint_type;
 255 module_param(cpoint_type, charp, 0444);
 256 MODULE_PARM_DESC(cpoint_type, " Crash Point Type, action to be taken on "\
 257                                 "hitting the crash point");
 258
 259 static int cpoint_count = DEFAULT_COUNT;
 260 module_param(cpoint_count, int, 0644);
 261 MODULE_PARM_DESC(cpoint_count, " Crash Point Count, number of times the "\
 262                                 "crash point is to be hit to trigger action");
 263
 264
 265 /* Return the crashtype number or NULL if the name is invalid */
 266 static struct crashtype *find_crashtype(const char *name)
 267 {
 268         int i;
 269
 270         for (i = 0; i < ARRAY_SIZE(crashtypes); i++) {
 271                 if (!strcmp(name, crashtypes[i].name))
 272                         return &crashtypes[i];
 273         }
 274
 275         return NULL;
 276 }
 277
 278 /*
 279  * This is forced noinline just so it distinctly shows up in the stackdump
 280  * which makes validation of expected lkdtm crashes easier.
 281  */
 282 static noinline void lkdtm_do_action(struct crashtype *crashtype)
 283 {
 284         BUG_ON(!crashtype || !crashtype->func);
 285         crashtype->func();
 286 }
 287
 288 static int lkdtm_register_cpoint(struct crashpoint *crashpoint,
 289                                  struct crashtype *crashtype)
 290 {
 291         int ret;
 292
 293         /* If this doesn't have a symbol, just call immediately. */
 294         if (!crashpoint->jprobe.kp.symbol_name) {
 295                 lkdtm_do_action(crashtype);
 296                 return 0;
 297         }
 298
 299         if (lkdtm_jprobe != NULL)
 300                 unregister_jprobe(lkdtm_jprobe);
 301
 302         lkdtm_crashpoint = crashpoint;
 303         lkdtm_crashtype = crashtype;
 304         lkdtm_jprobe = &crashpoint->jprobe;
 305         ret = register_jprobe(lkdtm_jprobe);
 306         if (ret < 0) {
 307                 pr_info("Couldn't register jprobe %s\n",
 308                         crashpoint->jprobe.kp.symbol_name);
 309                 lkdtm_jprobe = NULL;
 310                 lkdtm_crashpoint = NULL;
 311                 lkdtm_crashtype = NULL;
 312         }
 313
 314         return ret;
 315 }
 316
 317 #ifdef CONFIG_KPROBES
 318 /* Global crash counter and spinlock. */
 319 static int crash_count = DEFAULT_COUNT;
 320 static DEFINE_SPINLOCK(crash_count_lock);
 321
 322 /* Called by jprobe entry points. */
 323 static void lkdtm_handler(void)
 324 {
 325         unsigned long flags;
 326         bool do_it = false;
 327
 328         BUG_ON(!lkdtm_crashpoint || !lkdtm_crashtype);
 329
 330         spin_lock_irqsave(&crash_count_lock, flags);
 331         crash_count--;
 332         pr_info("Crash point %s of type %s hit, trigger in %d rounds\n",
 333                 lkdtm_crashpoint->name, lkdtm_crashtype->name, crash_count);
 334
 335         if (crash_count == 0) {
 336                 do_it = true;
 337                 crash_count = cpoint_count;
 338         }
 339         spin_unlock_irqrestore(&crash_count_lock, flags);
 340
 341         if (do_it)
 342                 lkdtm_do_action(lkdtm_crashtype);
 343 }
 344
 345 static ssize_t lkdtm_debugfs_entry(struct file *f,
 346                                    const char __user *user_buf,
 347                                    size_t count, loff_t *off)
 348 {
 349         struct crashpoint *crashpoint = file_inode(f)->i_private;
 350         struct crashtype *crashtype = NULL;
 351         char *buf;
 352         int err;
 353
 354         if (count >= PAGE_SIZE)
 355                 return -EINVAL;
 356
 357         buf = (char *)__get_free_page(GFP_KERNEL);
 358         if (!buf)
 359                 return -ENOMEM;
 360         if (copy_from_user(buf, user_buf, count)) {
 361                 free_page((unsigned long) buf);
 362                 return -EFAULT;
 363         }
 364         /* NULL-terminate and remove enter */
 365         buf[count] = '\0';
 366         strim(buf);
 367
 368         crashtype = find_crashtype(buf);
 369         free_page((unsigned long)buf);
 370
 371         if (!crashtype)
 372                 return -EINVAL;
 373
 374         err = lkdtm_register_cpoint(crashpoint, crashtype);
 375         if (err < 0)
 376                 return err;
 377
 378         *off += count;
 379
 380         return count;
 381 }
 382 #endif
 383
 384 /* Generic read callback that just prints out the available crash types */
 385 static ssize_t lkdtm_debugfs_read(struct file *f, char __user *user_buf,
 386                 size_t count, loff_t *off)
 387 {
 388         char *buf;
 389         int i, n, out;
 390
 391         buf = (char *)__get_free_page(GFP_KERNEL);
 392         if (buf == NULL)
 393                 return -ENOMEM;
 394
 395         n = snprintf(buf, PAGE_SIZE, "Available crash types:\n");
 396         for (i = 0; i < ARRAY_SIZE(crashtypes); i++) {
 397                 n += snprintf(buf + n, PAGE_SIZE - n, "%s\n",
 398                               crashtypes[i].name);
 399         }
 400         buf[n] = '\0';
 401
 402         out = simple_read_from_buffer(user_buf, count, off,
 403                                       buf, n);
 404         free_page((unsigned long) buf);
 405
 406         return out;
 407 }
 408
 409 static int lkdtm_debugfs_open(struct inode *inode, struct file *file)
 410 {
 411         return 0;
 412 }
 413
 414 /* Special entry to just crash directly. Available without KPROBEs */
 415 static ssize_t direct_entry(struct file *f, const char __user *user_buf,
 416                 size_t count, loff_t *off)
 417 {
 418         struct crashtype *crashtype;
 419         char *buf;
 420
 421         if (count >= PAGE_SIZE)
 422                 return -EINVAL;
 423         if (count < 1)
 424                 return -EINVAL;
 425
 426         buf = (char *)__get_free_page(GFP_KERNEL);
 427         if (!buf)
 428                 return -ENOMEM;
 429         if (copy_from_user(buf, user_buf, count)) {
 430                 free_page((unsigned long) buf);
 431                 return -EFAULT;
 432         }
 433         /* NULL-terminate and remove enter */
 434         buf[count] = '\0';
 435         strim(buf);
 436
 437         crashtype = find_crashtype(buf);
 438         free_page((unsigned long) buf);
 439         if (!crashtype)
 440                 return -EINVAL;
 441
 442         pr_info("Performing direct entry %s\n", crashtype->name);
 443         lkdtm_do_action(crashtype);
 444         *off += count;
 445
 446         return count;
 447 }
 448
 449 static struct dentry *lkdtm_debugfs_root;
 450
 451 static int __init lkdtm_module_init(void)
 452 {
 453         struct crashpoint *crashpoint = NULL;
 454         struct crashtype *crashtype = NULL;
 455         int ret = -EINVAL;
 456         int i;
 457
 458         /* Neither or both of these need to be set */
 459         if ((cpoint_type || cpoint_name) && !(cpoint_type && cpoint_name)) {
 460                 pr_err("Need both cpoint_type and cpoint_name or neither\n");
 461                 return -EINVAL;
 462         }
 463
 464         if (cpoint_type) {
 465                 crashtype = find_crashtype(cpoint_type);
 466                 if (!crashtype) {
 467                         pr_err("Unknown crashtype '%s'\n", cpoint_type);
 468                         return -EINVAL;
 469                 }
 470         }
 471
 472         if (cpoint_name) {
 473                 for (i = 0; i < ARRAY_SIZE(crashpoints); i++) {
 474                         if (!strcmp(cpoint_name, crashpoints[i].name))
 475                                 crashpoint = &crashpoints[i];
 476                 }
 477
 478                 /* Refuse unknown crashpoints. */
 479                 if (!crashpoint) {
 480                         pr_err("Invalid crashpoint %s\n", cpoint_name);
 481                         return -EINVAL;
 482                 }
 483         }
 484
 485 #ifdef CONFIG_KPROBES
 486         /* Set crash count. */
 487         crash_count = cpoint_count;
 488 #endif
 489
 490         /* Handle test-specific initialization. */
 491         lkdtm_bugs_init(&recur_count);
 492         lkdtm_perms_init();
 493         lkdtm_usercopy_init();
 494
 495         /* Register debugfs interface */
 496         lkdtm_debugfs_root = debugfs_create_dir("provoke-crash", NULL);
 497         if (!lkdtm_debugfs_root) {
 498                 pr_err("creating root dir failed\n");
 499                 return -ENODEV;
 500         }
 501
 502         /* Install debugfs trigger files. */
 503         for (i = 0; i < ARRAY_SIZE(crashpoints); i++) {
 504                 struct crashpoint *cur = &crashpoints[i];
 505                 struct dentry *de;
 506
 507                 de = debugfs_create_file(cur->name, 0644, lkdtm_debugfs_root,
 508                                          cur, &cur->fops);
 509                 if (de == NULL) {
 510                         pr_err("could not create crashpoint %s\n", cur->name);
 511                         goto out_err;
 512                 }
 513         }
 514
 515         /* Install crashpoint if one was selected. */
 516         if (crashpoint) {
 517                 ret = lkdtm_register_cpoint(crashpoint, crashtype);
 518                 if (ret < 0) {
 519                         pr_info("Invalid crashpoint %s\n", crashpoint->name);
 520                         goto out_err;
 521                 }
 522                 pr_info("Crash point %s of type %s registered\n",
 523                         crashpoint->name, cpoint_type);
 524         } else {
 525                 pr_info("No crash points registered, enable through debugfs\n");
 526         }
 527
 528         return 0;
 529
 530 out_err:
 531         debugfs_remove_recursive(lkdtm_debugfs_root);
 532         return ret;
 533 }
 534
 535 static void __exit lkdtm_module_exit(void)
 536 {
 537         debugfs_remove_recursive(lkdtm_debugfs_root);
 538
 539         /* Handle test-specific clean-up. */
 540         lkdtm_usercopy_exit();
 541
 542         if (lkdtm_jprobe != NULL)
 543                 unregister_jprobe(lkdtm_jprobe);
 544
 545         pr_info("Crash point unregistered\n");
 546 }
 547
 548 module_init(lkdtm_module_init);
 549 module_exit(lkdtm_module_exit);
 550
 551 MODULE_LICENSE("GPL");
 552 MODULE_DESCRIPTION("Kernel crash testing module");