drivers/staging/lustre/include/linux/libcfs/libcfs_fail.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see http://www.gnu.org/licenses
  18  *
  19  * Please contact Oracle Corporation, Inc., 500 Oracle Parkway, Redwood Shores,
  20  * CA 94065 USA or visit www.oracle.com if you need additional information or
  21  * have any questions.
  22  *
  23  * GPL HEADER END
  24  */
  25 /*
  26  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  27  * Use is subject to license terms.
  28  *
  29  * Copyright (c) 2011, 2012, Intel Corporation.
  30  */
  31 /*
  32  * This file is part of Lustre, http://www.lustre.org/
  33  * Lustre is a trademark of Oracle Corporation, Inc.
  34  */
  35
  36 #ifndef _LIBCFS_FAIL_H
  37 #define _LIBCFS_FAIL_H
  38
  39 extern unsigned long cfs_fail_loc;
  40 extern unsigned int cfs_fail_val;
  41 extern int cfs_fail_err;
  42
  43 extern wait_queue_head_t cfs_race_waitq;
  44 extern int cfs_race_state;
  45
  46 int __cfs_fail_check_set(__u32 id, __u32 value, int set);
  47 int __cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set);
  48
  49 enum {
  50         CFS_FAIL_LOC_NOSET      = 0,
  51         CFS_FAIL_LOC_ORSET      = 1,
  52         CFS_FAIL_LOC_RESET      = 2,
  53         CFS_FAIL_LOC_VALUE      = 3
  54 };
  55
  56 /* Failure injection control */
  57 #define CFS_FAIL_MASK_SYS    0x0000FF00
  58 #define CFS_FAIL_MASK_LOC   (0x000000FF | CFS_FAIL_MASK_SYS)
  59
  60 #define CFS_FAILED_BIT       30
  61 /* CFS_FAILED is 0x40000000 */
  62 #define CFS_FAILED        (1 << CFS_FAILED_BIT)
  63
  64 #define CFS_FAIL_ONCE_BIT    31
  65 /* CFS_FAIL_ONCE is 0x80000000 */
  66 #define CFS_FAIL_ONCE       (1 << CFS_FAIL_ONCE_BIT)
  67
  68 /* The following flags aren't made to be combined */
  69 #define CFS_FAIL_SKIP   0x20000000 /* skip N times then fail */
  70 #define CFS_FAIL_SOME   0x10000000 /* only fail N times */
  71 #define CFS_FAIL_RAND   0x08000000 /* fail 1/N of the times */
  72 #define CFS_FAIL_USR1   0x04000000 /* user flag */
  73
  74 #define CFS_FAULT       0x02000000 /* match any CFS_FAULT_CHECK */
  75
  76 static inline bool CFS_FAIL_PRECHECK(__u32 id)
  77 {
  78         return cfs_fail_loc != 0 &&
  79                ((cfs_fail_loc & CFS_FAIL_MASK_LOC) == (id & CFS_FAIL_MASK_LOC) ||
  80                 (cfs_fail_loc & id & CFS_FAULT));
  81 }
  82
  83 static inline int cfs_fail_check_set(__u32 id, __u32 value,
  84                                      int set, int quiet)
  85 {
  86         int ret = 0;
  87
  88         if (unlikely(CFS_FAIL_PRECHECK(id))) {
  89                 ret = __cfs_fail_check_set(id, value, set);
  90                 if (ret) {
  91                         if (quiet) {
  92                                 CDEBUG(D_INFO, "*** cfs_fail_loc=%x, val=%u***\n",
  93                                        id, value);
  94                         } else {
  95                                 LCONSOLE_INFO("*** cfs_fail_loc=%x, val=%u***\n",
  96                                               id, value);
  97                         }
  98                 }
  99         }
 100
 101         return ret;
 102 }
 103
 104 /* If id hit cfs_fail_loc, return 1, otherwise return 0 */
 105 #define CFS_FAIL_CHECK(id) \
 106         cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 0)
 107 #define CFS_FAIL_CHECK_QUIET(id) \
 108         cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 1)
 109
 110 /* If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1,
 111  * otherwise return 0 */
 112 #define CFS_FAIL_CHECK_VALUE(id, value) \
 113         cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 0)
 114 #define CFS_FAIL_CHECK_VALUE_QUIET(id, value) \
 115         cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 1)
 116
 117 /* If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1,
 118  * otherwise return 0 */
 119 #define CFS_FAIL_CHECK_ORSET(id, value) \
 120         cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 0)
 121 #define CFS_FAIL_CHECK_ORSET_QUIET(id, value) \
 122         cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 1)
 123
 124 /* If id hit cfs_fail_loc, cfs_fail_loc = value and return 1,
 125  * otherwise return 0 */
 126 #define CFS_FAIL_CHECK_RESET(id, value) \
 127         cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 0)
 128 #define CFS_FAIL_CHECK_RESET_QUIET(id, value) \
 129         cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 1)
 130
 131 static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
 132 {
 133         if (unlikely(CFS_FAIL_PRECHECK(id)))
 134                 return __cfs_fail_timeout_set(id, value, ms, set);
 135         return 0;
 136 }
 137
 138 /* If id hit cfs_fail_loc, sleep for seconds or milliseconds */
 139 #define CFS_FAIL_TIMEOUT(id, secs) \
 140         cfs_fail_timeout_set(id, 0, secs * 1000, CFS_FAIL_LOC_NOSET)
 141
 142 #define CFS_FAIL_TIMEOUT_MS(id, ms) \
 143         cfs_fail_timeout_set(id, 0, ms, CFS_FAIL_LOC_NOSET)
 144
 145 /* If id hit cfs_fail_loc, cfs_fail_loc |= value and
 146  * sleep seconds or milliseconds */
 147 #define CFS_FAIL_TIMEOUT_ORSET(id, value, secs) \
 148         cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_ORSET)
 149
 150 #define CFS_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \
 151         cfs_fail_timeout_set(id, value, ms, CFS_FAIL_LOC_ORSET)
 152
 153 #define CFS_FAULT_CHECK(id)                     \
 154         CFS_FAIL_CHECK(CFS_FAULT | (id))
 155
 156 /* The idea here is to synchronise two threads to force a race. The
 157  * first thread that calls this with a matching fail_loc is put to
 158  * sleep. The next thread that calls with the same fail_loc wakes up
 159  * the first and continues. */
 160 static inline void cfs_race(__u32 id)
 161 {
 162
 163         if (CFS_FAIL_PRECHECK(id)) {
 164                 if (unlikely(__cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET))) {
 165                         int rc;
 166
 167                         cfs_race_state = 0;
 168                         CERROR("cfs_race id %x sleeping\n", id);
 169                         rc = wait_event_interruptible(cfs_race_waitq,
 170                                                       cfs_race_state != 0);
 171                         CERROR("cfs_fail_race id %x awake, rc=%d\n", id, rc);
 172                 } else {
 173                         CERROR("cfs_fail_race id %x waking\n", id);
 174                         cfs_race_state = 1;
 175                         wake_up(&cfs_race_waitq);
 176                 }
 177         }
 178 }
 179
 180 #define CFS_RACE(id) cfs_race(id)
 181
 182 #endif /* _LIBCFS_FAIL_H */