libcfs/include/libcfs/libcfs_fail.h

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