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 <[email protected]>
  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 <[email protected]>
  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_USER_DS),
 203         CRASHTYPE(CORRUPT_STACK),
 204         CRASHTYPE(CORRUPT_STACK_STRONG),
 205         CRASHTYPE(STACK_GUARD_PAGE_LEADING),
 206         CRASHTYPE(STACK_GUARD_PAGE_TRAILING),
 207         CRASHTYPE(UNALIGNED_LOAD_STORE_WRITE),
 208         CRASHTYPE(OVERWRITE_ALLOCATION),
 209         CRASHTYPE(WRITE_AFTER_FREE),
 210         CRASHTYPE(READ_AFTER_FREE),
 211         CRASHTYPE(WRITE_BUDDY_AFTER_FREE),
 212         CRASHTYPE(READ_BUDDY_AFTER_FREE),
 213         CRASHTYPE(SOFTLOCKUP),
 214         CRASHTYPE(HARDLOCKUP),
 215         CRASHTYPE(SPINLOCKUP),
 216         CRASHTYPE(HUNG_TASK),
 217         CRASHTYPE(EXEC_DATA),
 218         CRASHTYPE(EXEC_STACK),
 219         CRASHTYPE(EXEC_KMALLOC),
 220         CRASHTYPE(EXEC_VMALLOC),
 221         CRASHTYPE(EXEC_RODATA),
 222         CRASHTYPE(EXEC_USERSPACE),
 223         CRASHTYPE(ACCESS_USERSPACE),
 224         CRASHTYPE(WRITE_RO),
 225         CRASHTYPE(WRITE_RO_AFTER_INIT),
 226         CRASHTYPE(WRITE_KERN),
 227         CRASHTYPE(REFCOUNT_INC_OVERFLOW),
 228         CRASHTYPE(REFCOUNT_ADD_OVERFLOW),
 229         CRASHTYPE(REFCOUNT_INC_NOT_ZERO_OVERFLOW),
 230         CRASHTYPE(REFCOUNT_ADD_NOT_ZERO_OVERFLOW),
 231         CRASHTYPE(REFCOUNT_DEC_ZERO),
 232         CRASHTYPE(REFCOUNT_DEC_NEGATIVE),
 233         CRASHTYPE(REFCOUNT_DEC_AND_TEST_NEGATIVE),
 234         CRASHTYPE(REFCOUNT_SUB_AND_TEST_NEGATIVE),
 235         CRASHTYPE(REFCOUNT_INC_ZERO),
 236         CRASHTYPE(REFCOUNT_ADD_ZERO),
 237         CRASHTYPE(REFCOUNT_INC_SATURATED),
 238         CRASHTYPE(REFCOUNT_DEC_SATURATED),
 239         CRASHTYPE(REFCOUNT_ADD_SATURATED),
 240         CRASHTYPE(REFCOUNT_INC_NOT_ZERO_SATURATED),
 241         CRASHTYPE(REFCOUNT_ADD_NOT_ZERO_SATURATED),
 242         CRASHTYPE(REFCOUNT_DEC_AND_TEST_SATURATED),
 243         CRASHTYPE(REFCOUNT_SUB_AND_TEST_SATURATED),
 244         CRASHTYPE(REFCOUNT_TIMING),
 245         CRASHTYPE(ATOMIC_TIMING),
 246         CRASHTYPE(USERCOPY_HEAP_SIZE_TO),
 247         CRASHTYPE(USERCOPY_HEAP_SIZE_FROM),
 248         CRASHTYPE(USERCOPY_HEAP_FLAG_TO),
 249         CRASHTYPE(USERCOPY_HEAP_FLAG_FROM),
 250         CRASHTYPE(USERCOPY_STACK_FRAME_TO),
 251         CRASHTYPE(USERCOPY_STACK_FRAME_FROM),
 252         CRASHTYPE(USERCOPY_STACK_BEYOND),
 253         CRASHTYPE(USERCOPY_KERNEL),
 254 };
 255
 256
 257 /* Global jprobe entry and crashtype. */
 258 static struct jprobe *lkdtm_jprobe;
 259 struct crashpoint *lkdtm_crashpoint;
 260 struct crashtype *lkdtm_crashtype;
 261
 262 /* Module parameters */
 263 static int recur_count = -1;
 264 module_param(recur_count, int, 0644);
 265 MODULE_PARM_DESC(recur_count, " Recursion level for the stack overflow test");
 266
 267 static char* cpoint_name;
 268 module_param(cpoint_name, charp, 0444);
 269 MODULE_PARM_DESC(cpoint_name, " Crash Point, where kernel is to be crashed");
 270
 271 static char* cpoint_type;
 272 module_param(cpoint_type, charp, 0444);
 273 MODULE_PARM_DESC(cpoint_type, " Crash Point Type, action to be taken on "\
 274                                 "hitting the crash point");
 275
 276 static int cpoint_count = DEFAULT_COUNT;
 277 module_param(cpoint_count, int, 0644);
 278 MODULE_PARM_DESC(cpoint_count, " Crash Point Count, number of times the "\
 279                                 "crash point is to be hit to trigger action");
 280
 281
 282 /* Return the crashtype number or NULL if the name is invalid */
 283 static struct crashtype *find_crashtype(const char *name)
 284 {
 285         int i;
 286
 287         for (i = 0; i < ARRAY_SIZE(crashtypes); i++) {
 288                 if (!strcmp(name, crashtypes[i].name))
 289                         return &crashtypes[i];
 290         }
 291
 292         return NULL;
 293 }
 294
 295 /*
 296  * This is forced noinline just so it distinctly shows up in the stackdump
 297  * which makes validation of expected lkdtm crashes easier.
 298  */
 299 static noinline void lkdtm_do_action(struct crashtype *crashtype)
 300 {
 301         BUG_ON(!crashtype || !crashtype->func);
 302         crashtype->func();
 303 }
 304
 305 static int lkdtm_register_cpoint(struct crashpoint *crashpoint,
 306                                  struct crashtype *crashtype)
 307 {
 308         int ret;
 309
 310         /* If this doesn't have a symbol, just call immediately. */
 311         if (!crashpoint->jprobe.kp.symbol_name) {
 312                 lkdtm_do_action(crashtype);
 313                 return 0;
 314         }
 315
 316         if (lkdtm_jprobe != NULL)
 317                 unregister_jprobe(lkdtm_jprobe);
 318
 319         lkdtm_crashpoint = crashpoint;
 320         lkdtm_crashtype = crashtype;
 321         lkdtm_jprobe = &crashpoint->jprobe;
 322         ret = register_jprobe(lkdtm_jprobe);
 323         if (ret < 0) {
 324                 pr_info("Couldn't register jprobe %s\n",
 325                         crashpoint->jprobe.kp.symbol_name);
 326                 lkdtm_jprobe = NULL;
 327                 lkdtm_crashpoint = NULL;
 328                 lkdtm_crashtype = NULL;
 329         }
 330
 331         return ret;
 332 }
 333
 334 #ifdef CONFIG_KPROBES
 335 /* Global crash counter and spinlock. */
 336 static int crash_count = DEFAULT_COUNT;
 337 static DEFINE_SPINLOCK(crash_count_lock);
 338
 339 /* Called by jprobe entry points. */
 340 static void lkdtm_handler(void)
 341 {
 342         unsigned long flags;
 343         bool do_it = false;
 344
 345         BUG_ON(!lkdtm_crashpoint || !lkdtm_crashtype);
 346
 347         spin_lock_irqsave(&crash_count_lock, flags);
 348         crash_count--;
 349         pr_info("Crash point %s of type %s hit, trigger in %d rounds\n",
 350                 lkdtm_crashpoint->name, lkdtm_crashtype->name, crash_count);
 351
 352         if (crash_count == 0) {
 353                 do_it = true;
 354                 crash_count = cpoint_count;
 355         }
 356         spin_unlock_irqrestore(&crash_count_lock, flags);
 357
 358         if (do_it)
 359                 lkdtm_do_action(lkdtm_crashtype);
 360 }
 361
 362 static ssize_t lkdtm_debugfs_entry(struct file *f,
 363                                    const char __user *user_buf,
 364                                    size_t count, loff_t *off)
 365 {
 366         struct crashpoint *crashpoint = file_inode(f)->i_private;
 367         struct crashtype *crashtype = NULL;
 368         char *buf;
 369         int err;
 370
 371         if (count >= PAGE_SIZE)
 372                 return -EINVAL;
 373
 374         buf = (char *)__get_free_page(GFP_KERNEL);
 375         if (!buf)
 376                 return -ENOMEM;
 377         if (copy_from_user(buf, user_buf, count)) {
 378                 free_page((unsigned long) buf);
 379                 return -EFAULT;
 380         }
 381         /* NULL-terminate and remove enter */
 382         buf[count] = '\0';
 383         strim(buf);
 384
 385         crashtype = find_crashtype(buf);
 386         free_page((unsigned long)buf);
 387
 388         if (!crashtype)
 389                 return -EINVAL;
 390
 391         err = lkdtm_register_cpoint(crashpoint, crashtype);
 392         if (err < 0)
 393                 return err;
 394
 395         *off += count;
 396
 397         return count;
 398 }
 399 #endif
 400
 401 /* Generic read callback that just prints out the available crash types */
 402 static ssize_t lkdtm_debugfs_read(struct file *f, char __user *user_buf,
 403                 size_t count, loff_t *off)
 404 {
 405         char *buf;
 406         int i, n, out;
 407
 408         buf = (char *)__get_free_page(GFP_KERNEL);
 409         if (buf == NULL)
 410                 return -ENOMEM;
 411
 412         n = snprintf(buf, PAGE_SIZE, "Available crash types:\n");
 413         for (i = 0; i < ARRAY_SIZE(crashtypes); i++) {
 414                 n += snprintf(buf + n, PAGE_SIZE - n, "%s\n",
 415                               crashtypes[i].name);
 416         }
 417         buf[n] = '\0';
 418
 419         out = simple_read_from_buffer(user_buf, count, off,
 420                                       buf, n);
 421         free_page((unsigned long) buf);
 422
 423         return out;
 424 }
 425
 426 static int lkdtm_debugfs_open(struct inode *inode, struct file *file)
 427 {
 428         return 0;
 429 }
 430
 431 /* Special entry to just crash directly. Available without KPROBEs */
 432 static ssize_t direct_entry(struct file *f, const char __user *user_buf,
 433                 size_t count, loff_t *off)
 434 {
 435         struct crashtype *crashtype;
 436         char *buf;
 437
 438         if (count >= PAGE_SIZE)
 439                 return -EINVAL;
 440         if (count < 1)
 441                 return -EINVAL;
 442
 443         buf = (char *)__get_free_page(GFP_KERNEL);
 444         if (!buf)
 445                 return -ENOMEM;
 446         if (copy_from_user(buf, user_buf, count)) {
 447                 free_page((unsigned long) buf);
 448                 return -EFAULT;
 449         }
 450         /* NULL-terminate and remove enter */
 451         buf[count] = '\0';
 452         strim(buf);
 453
 454         crashtype = find_crashtype(buf);
 455         free_page((unsigned long) buf);
 456         if (!crashtype)
 457                 return -EINVAL;
 458
 459         pr_info("Performing direct entry %s\n", crashtype->name);
 460         lkdtm_do_action(crashtype);
 461         *off += count;
 462
 463         return count;
 464 }
 465
 466 static struct dentry *lkdtm_debugfs_root;
 467
 468 static int __init lkdtm_module_init(void)
 469 {
 470         struct crashpoint *crashpoint = NULL;
 471         struct crashtype *crashtype = NULL;
 472         int ret = -EINVAL;
 473         int i;
 474
 475         /* Neither or both of these need to be set */
 476         if ((cpoint_type || cpoint_name) && !(cpoint_type && cpoint_name)) {
 477                 pr_err("Need both cpoint_type and cpoint_name or neither\n");
 478                 return -EINVAL;
 479         }
 480
 481         if (cpoint_type) {
 482                 crashtype = find_crashtype(cpoint_type);
 483                 if (!crashtype) {
 484                         pr_err("Unknown crashtype '%s'\n", cpoint_type);
 485                         return -EINVAL;
 486                 }
 487         }
 488
 489         if (cpoint_name) {
 490                 for (i = 0; i < ARRAY_SIZE(crashpoints); i++) {
 491                         if (!strcmp(cpoint_name, crashpoints[i].name))
 492                                 crashpoint = &crashpoints[i];
 493                 }
 494
 495                 /* Refuse unknown crashpoints. */
 496                 if (!crashpoint) {
 497                         pr_err("Invalid crashpoint %s\n", cpoint_name);
 498                         return -EINVAL;
 499                 }
 500         }
 501
 502 #ifdef CONFIG_KPROBES
 503         /* Set crash count. */
 504         crash_count = cpoint_count;
 505 #endif
 506
 507         /* Handle test-specific initialization. */
 508         lkdtm_bugs_init(&recur_count);
 509         lkdtm_perms_init();
 510         lkdtm_usercopy_init();
 511
 512         /* Register debugfs interface */
 513         lkdtm_debugfs_root = debugfs_create_dir("provoke-crash", NULL);
 514         if (!lkdtm_debugfs_root) {
 515                 pr_err("creating root dir failed\n");
 516                 return -ENODEV;
 517         }
 518
 519         /* Install debugfs trigger files. */
 520         for (i = 0; i < ARRAY_SIZE(crashpoints); i++) {
 521                 struct crashpoint *cur = &crashpoints[i];
 522                 struct dentry *de;
 523
 524                 de = debugfs_create_file(cur->name, 0644, lkdtm_debugfs_root,
 525                                          cur, &cur->fops);
 526                 if (de == NULL) {
 527                         pr_err("could not create crashpoint %s\n", cur->name);
 528                         goto out_err;
 529                 }
 530         }
 531
 532         /* Install crashpoint if one was selected. */
 533         if (crashpoint) {
 534                 ret = lkdtm_register_cpoint(crashpoint, crashtype);
 535                 if (ret < 0) {
 536                         pr_info("Invalid crashpoint %s\n", crashpoint->name);
 537                         goto out_err;
 538                 }
 539                 pr_info("Crash point %s of type %s registered\n",
 540                         crashpoint->name, cpoint_type);
 541         } else {
 542                 pr_info("No crash points registered, enable through debugfs\n");
 543         }
 544
 545         return 0;
 546
 547 out_err:
 548         debugfs_remove_recursive(lkdtm_debugfs_root);
 549         return ret;
 550 }
 551
 552 static void __exit lkdtm_module_exit(void)
 553 {
 554         debugfs_remove_recursive(lkdtm_debugfs_root);
 555
 556         /* Handle test-specific clean-up. */
 557         lkdtm_usercopy_exit();
 558
 559         if (lkdtm_jprobe != NULL)
 560                 unregister_jprobe(lkdtm_jprobe);
 561
 562         pr_info("Crash point unregistered\n");
 563 }
 564
 565 module_init(lkdtm_module_init);
 566 module_exit(lkdtm_module_exit);
 567
 568 MODULE_LICENSE("GPL");
 569 MODULE_DESCRIPTION("Kernel crash testing module");