lustre/include/obd_support.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
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _OBD_SUPPORT
  38 #define _OBD_SUPPORT
  39
  40 #include <libcfs/libcfs.h>
  41 #include <lvfs.h>
  42 #include <lprocfs_status.h>
  43
  44 #if defined(__linux__)
  45 #include <linux/obd_support.h>
  46 #elif defined(__APPLE__)
  47 #include <darwin/obd_support.h>
  48 #elif defined(__WINNT__)
  49 #include <winnt/obd_support.h>
  50 #else
  51 #error Unsupported operating system.
  52 #endif
  53
  54 /* global variables */
  55 extern struct lprocfs_stats *obd_memory;
  56 enum {
  57         OBD_MEMORY_STAT = 0,
  58         OBD_MEMORY_PAGES_STAT = 1,
  59         OBD_STATS_NUM,
  60 };
  61
  62 enum {
  63         OBD_FAIL_LOC_NOSET      = 0,
  64         OBD_FAIL_LOC_ORSET      = 1,
  65         OBD_FAIL_LOC_RESET      = 2
  66 };
  67
  68 extern unsigned long obd_fail_loc;
  69 extern unsigned int obd_fail_val;
  70 extern unsigned int obd_debug_peer_on_timeout;
  71 extern unsigned int obd_dump_on_timeout;
  72 extern unsigned int obd_dump_on_eviction;
  73 /* obd_timeout should only be used for recovery, not for
  74    networking / disk / timings affected by load (use Adaptive Timeouts) */
  75 extern unsigned int obd_timeout;          /* seconds */
  76 extern unsigned int ldlm_timeout;         /* seconds */
  77 extern unsigned int obd_sync_filter;
  78 extern unsigned int obd_max_dirty_pages;
  79 extern atomic_t obd_dirty_pages;
  80 extern cfs_waitq_t obd_race_waitq;
  81 extern int obd_race_state;
  82 extern unsigned int obd_alloc_fail_rate;
  83
  84 int __obd_fail_check_set(__u32 id, __u32 value, int set);
  85 int __obd_fail_timeout_set(__u32 id, __u32 value, int ms, int set);
  86
  87 /* lvfs.c */
  88 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
  89                    size_t size, const char *file, int line);
  90
  91 /* Timeout definitions */
  92 #define OBD_TIMEOUT_DEFAULT             100
  93 #define LDLM_TIMEOUT_DEFAULT            20
  94 #define MDS_LDLM_TIMEOUT_DEFAULT        6
  95 /* Time to wait for all clients to reconnect during recovery */
  96 /* Should be very conservative; must catch the first reconnect after reboot */
  97 #define OBD_RECOVERY_FACTOR (3) /* times obd_timeout */
  98 /* Change recovery-small 26b time if you change this */
  99 #define PING_INTERVAL max(obd_timeout / 4, 1U)
 100 /* Client may skip 1 ping; we must wait at least 2.5. But for multiple
 101  * failover targets the client only pings one server at a time, and pings
 102  * can be lost on a loaded network. Since eviction has serious consequences,
 103  * and there's no urgent need to evict a client just because it's idle, we
 104  * should be very conservative here. */
 105 #define PING_EVICT_TIMEOUT (PING_INTERVAL * 6)
 106 #define DISK_TIMEOUT 50          /* Beyond this we warn about disk speed */
 107 #define CONNECTION_SWITCH_MIN 5U /* Connection switching rate limiter */
 108  /* Max connect interval for nonresponsive servers; ~50s to avoid building up
 109     connect requests in the LND queues, but within obd_timeout so we don't
 110     miss the recovery window */
 111 #define CONNECTION_SWITCH_MAX min(50U, max(CONNECTION_SWITCH_MIN,obd_timeout))
 112 #define CONNECTION_SWITCH_INC 5  /* Connection timeout backoff */
 113 #ifndef CRAY_XT3
 114 /* In general this should be low to have quick detection of a system
 115    running on a backup server. (If it's too low, import_select_connection
 116    will increase the timeout anyhow.)  */
 117 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/20)
 118 #else
 119 /* ...but for very large systems (e.g. CRAY) we need to keep the initial
 120    connect t.o. high (bz 10803), because they will nearly ALWAYS be doing the
 121    connects for the first time (clients "reboot" after every process, so no
 122    chance to generate adaptive timeout data. */
 123 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/2)
 124 #endif
 125 #define LONG_UNLINK 300          /* Unlink should happen before now */
 126
 127
 128 #define OBD_FAIL_MDS                     0x100
 129 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
 130 #define OBD_FAIL_MDS_GETATTR_NET         0x102
 131 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
 132 #define OBD_FAIL_MDS_READPAGE_NET        0x104
 133 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
 134 #define OBD_FAIL_MDS_SENDPAGE            0x106
 135 #define OBD_FAIL_MDS_REINT_NET           0x107
 136 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
 137 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
 138 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
 139 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
 140 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
 141 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
 142 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
 143 #define OBD_FAIL_MDS_REINT_LINK          0x10f
 144 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
 145 #define OBD_FAIL_MDS_REINT_RENAME        0x111
 146 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
 147 #define OBD_FAIL_MDS_OPEN_NET            0x113
 148 #define OBD_FAIL_MDS_OPEN_PACK           0x114
 149 #define OBD_FAIL_MDS_CLOSE_NET           0x115
 150 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
 151 #define OBD_FAIL_MDS_CONNECT_NET         0x117
 152 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
 153 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
 154 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
 155 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
 156 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
 157 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
 158 #define OBD_FAIL_MDS_STATFS_NET          0x11e
 159 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
 160 #define OBD_FAIL_MDS_PIN_NET             0x120
 161 #define OBD_FAIL_MDS_UNPIN_NET           0x121
 162 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
 163 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
 164 #define OBD_FAIL_MDS_SYNC_NET            0x124
 165 #define OBD_FAIL_MDS_SYNC_PACK           0x125
 166 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
 167 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
 168 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
 169 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
 170 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
 171 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
 172 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
 173 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
 174 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
 175 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
 176 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
 177 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
 178 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
 179 #define OBD_FAIL_MDS_SETXATTR            0x133
 180 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
 181 #define OBD_FAIL_MDS_FS_SETUP            0x135
 182 #define OBD_FAIL_MDS_RESEND              0x136
 183 #define OBD_FAIL_MDS_IS_SUBDIR_NET       0x137
 184 #define OBD_FAIL_MDS_IS_SUBDIR_PACK      0x138
 185 #define OBD_FAIL_MDS_SET_INFO_NET        0x139
 186 #define OBD_FAIL_MDS_WRITEPAGE_NET       0x13a
 187 #define OBD_FAIL_MDS_WRITEPAGE_PACK      0x13b
 188 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x13c
 189 #define OBD_FAIL_MDS_OSC_PRECREATE       0x13d
 190 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x13e
 191 #define OBD_FAIL_MDS_CLOSE_NET_REP       0x13f
 192 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x140
 193
 194 #define OBD_FAIL_OST                     0x200
 195 #define OBD_FAIL_OST_CONNECT_NET         0x201
 196 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 197 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 198 #define OBD_FAIL_OST_CREATE_NET          0x204
 199 #define OBD_FAIL_OST_DESTROY_NET         0x205
 200 #define OBD_FAIL_OST_GETATTR_NET         0x206
 201 #define OBD_FAIL_OST_SETATTR_NET         0x207
 202 #define OBD_FAIL_OST_OPEN_NET            0x208
 203 #define OBD_FAIL_OST_CLOSE_NET           0x209
 204 #define OBD_FAIL_OST_BRW_NET             0x20a
 205 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 206 #define OBD_FAIL_OST_STATFS_NET          0x20c
 207 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 208 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 209 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 210 #define OBD_FAIL_OST_SYNC_NET            0x210
 211 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 212 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
 213 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 214 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 215 #define OBD_FAIL_OST_ENOSPC              0x215
 216 #define OBD_FAIL_OST_EROFS               0x216
 217 #define OBD_FAIL_OST_ENOENT              0x217
 218 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 219 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 220 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 221 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 222 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 223 #define OBD_FAIL_OST_DROP_REQ            0x21d
 224 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 225 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 226 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
 227 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 228 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 229 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
 230 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
 231 #define OBD_FAIL_OST_CONNECT_NET2        0x225
 232 #define OBD_FAIL_OST_NOMEM               0x226
 233
 234 #define OBD_FAIL_LDLM                    0x300
 235 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 236 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 237 #define OBD_FAIL_LDLM_CONVERT            0x303
 238 #define OBD_FAIL_LDLM_CANCEL             0x304
 239 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 240 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 241 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 242 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 243 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 244 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 245 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 246 #define OBD_FAIL_LDLM_REPLY              0x30c
 247 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 248 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 249 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 250 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 251 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 252 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
 253 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
 254 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
 255 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
 256 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
 257
 258 /* LOCKLESS IO */
 259 #define OBD_FAIL_LDLM_SET_CONTENTION     0x315
 260
 261 #define OBD_FAIL_OSC                     0x400
 262 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 263 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 264 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 265 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 266 #define OBD_FAIL_OSC_MATCH               0x405
 267 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
 268 #define OBD_FAIL_OSC_SHUTDOWN            0x407
 269 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
 270 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
 271 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
 272 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
 273 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
 274 #define OBD_FAIL_OSC_DIO_PAUSE           0x40d
 275 #define OBD_FAIL_OSC_OBJECT_CONTENTION   0x40e
 276
 277 #define OBD_FAIL_PTLRPC                  0x500
 278 #define OBD_FAIL_PTLRPC_ACK              0x501
 279 #define OBD_FAIL_PTLRPC_RQBD             0x502
 280 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 281 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 282 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 283 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 284 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 285 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
 286 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
 287 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
 288
 289 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
 290
 291 #define OBD_FAIL_OBD_PING_NET            0x600
 292 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 293 #define OBD_FAIL_OBD_LOGD_NET            0x602
 294 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 295 #define OBD_FAIL_OBD_DQACQ               0x604
 296 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
 297 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
 298
 299 #define OBD_FAIL_TGT_REPLY_NET           0x700
 300 #define OBD_FAIL_TGT_CONN_RACE           0x701
 301 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 302 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 303 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 304 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 305 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
 306 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
 307
 308 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 309 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 310 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
 311 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
 312
 313 #define OBD_FAIL_MGS                     0x900
 314 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 315 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 316 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
 317 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
 318 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
 319
 320 #define OBD_FAIL_QUOTA_QD_COUNT_32BIT    0xA00
 321
 322 #define OBD_FAIL_LPROC_REMOVE            0xB00
 323
 324 #define OBD_FAIL_GENERAL_ALLOC           0xC00
 325
 326 #define OBD_FAIL_SEQ                     0x1000
 327 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
 328
 329 #define OBD_FAIL_FLD                     0x1100
 330 #define OBD_FAIL_FLD_QUERY_NET           0x1101
 331
 332 #define OBD_FAIL_SEC_CTX                 0x1200
 333 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
 334 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
 335 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
 336 #define OBD_FAIL_SEC_CTX_HDL_PAUSE       0x1204
 337
 338 /* Failure injection control */
 339 #define OBD_FAIL_MASK_SYS    0x0000FF00
 340 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
 341
 342 #define OBD_FAILED_BIT       30
 343 /* OBD_FAILED is 0x40000000 */
 344 #define OBD_FAILED          (1 << OBD_FAILED_BIT)
 345
 346 #define OBD_FAIL_ONCE_BIT    31
 347 /* OBD_FAIL_ONCE is 0x80000000 */
 348 #define OBD_FAIL_ONCE       (1 << OBD_FAIL_ONCE_BIT)
 349
 350 /* The following flags aren't made to be combined */
 351 #define OBD_FAIL_SKIP        0x20000000 /* skip N times then fail */
 352 #define OBD_FAIL_SOME        0x10000000 /* only fail N times */
 353 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the times */
 354 #define OBD_FAIL_USR1        0x04000000 /* user flag */
 355
 356 #define OBD_FAIL_PRECHECK(id) (obd_fail_loc &&                                \
 357                               (obd_fail_loc & OBD_FAIL_MASK_LOC) ==           \
 358                               ((id) & OBD_FAIL_MASK_LOC))
 359
 360 static inline int obd_fail_check_set(__u32 id, __u32 value, int set)
 361 {
 362         int ret = 0;
 363         if (unlikely(OBD_FAIL_PRECHECK(id) &&
 364             (ret = __obd_fail_check_set(id, value, set)))) {
 365                 CERROR("*** obd_fail_loc=%x ***\n", id);
 366         }
 367         return ret;
 368 }
 369
 370 /* If id hit obd_fail_loc, return 1, otherwise return 0 */
 371 #define OBD_FAIL_CHECK(id) \
 372         obd_fail_check_set(id, 0, OBD_FAIL_LOC_NOSET)
 373
 374 /* If id hit obd_fail_loc, obd_fail_loc |= value and return 1,
 375  * otherwise return 0 */
 376 #define OBD_FAIL_CHECK_ORSET(id, value) \
 377         obd_fail_check_set(id, value, OBD_FAIL_LOC_ORSET)
 378
 379 /* If id hit obd_fail_loc, obd_fail_loc = value and return 1,
 380  * otherwise return 0 */
 381 #define OBD_FAIL_CHECK_RESET(id, value) \
 382         obd_fail_check_set(id, value, OBD_FAIL_LOC_RESET)
 383
 384
 385 static inline int obd_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
 386 {
 387         if (unlikely(OBD_FAIL_PRECHECK(id)))
 388                 return __obd_fail_timeout_set(id, value, ms, set);
 389         else
 390                 return 0;
 391 }
 392
 393 /* If id hit obd_fail_loc, sleep for seconds or milliseconds */
 394 #define OBD_FAIL_TIMEOUT(id, secs) \
 395         obd_fail_timeout_set(id, 0, secs * 1000, OBD_FAIL_LOC_NOSET)
 396
 397 #define OBD_FAIL_TIMEOUT_MS(id, ms) \
 398         obd_fail_timeout_set(id, 0, ms, OBD_FAIL_LOC_NOSET)
 399
 400 /* If id hit obd_fail_loc, obd_fail_loc |= value and
 401  * sleep seconds or milliseconds */
 402 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) \
 403         obd_fail_timeout_set(id, value, secs * 1000, OBD_FAIL_LOC_ORSET)
 404
 405 #define OBD_FAIL_TIMEOUT_MS_ORSET(id, value, ms) \
 406         obd_fail_timeout_set(id, value, ms, OBD_FAIL_LOC_ORSET)
 407
 408 #ifdef __KERNEL__
 409 static inline void obd_fail_write(int id, struct super_block *sb)
 410 {
 411         /* We set FAIL_ONCE because we never "un-fail" a device */
 412         if (OBD_FAIL_CHECK_ORSET(id & ~OBD_FAIL_ONCE, OBD_FAIL_ONCE)) {
 413 #ifdef LIBCFS_DEBUG
 414                 BDEVNAME_DECLARE_STORAGE(tmp);
 415                 CERROR("obd_fail_loc=%x, fail write operation on %s\n",
 416                        id, ll_bdevname(sb, tmp));
 417 #endif
 418                 /* TODO-CMD: fix getting jdev */
 419                 __lvfs_set_rdonly(lvfs_sbdev(sb), (lvfs_sbdev_type)0);
 420         }
 421 }
 422 #define OBD_FAIL_WRITE(id, sb) obd_fail_write(id, sb)
 423
 424 /* The idea here is to synchronise two threads to force a race. The
 425  * first thread that calls this with a matching fail_loc is put to
 426  * sleep. The next thread that calls with the same fail_loc wakes up
 427  * the first and continues. */
 428 static inline void obd_race(__u32 id)
 429 {
 430         if (OBD_FAIL_PRECHECK(id)) {
 431                 if (unlikely(__obd_fail_check_set(id, 0, OBD_FAIL_LOC_NOSET))) {
 432                         obd_race_state = 0;
 433                         CERROR("obd_race id %x sleeping\n", id);
 434                         OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);
 435                         CERROR("obd_fail_race id %x awake\n", id);
 436                 } else {
 437                         CERROR("obd_fail_race id %x waking\n", id);
 438                         obd_race_state = 1;
 439                         wake_up(&obd_race_waitq);
 440                 }
 441         }
 442 }
 443 #define OBD_RACE(id) obd_race(id)
 444 #else
 445 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 446 #define OBD_RACE(foo) do {} while(0)
 447 #endif
 448
 449 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 450
 451 extern atomic_t libcfs_kmemory;
 452
 453 #ifdef LPROCFS
 454 #define obd_memory_add(size)                                                  \
 455         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
 456 #define obd_memory_sub(size)                                                  \
 457         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
 458 #define obd_memory_sum()                                                      \
 459         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
 460                                 LPROCFS_FIELDS_FLAGS_SUM)
 461 #define obd_pages_add(order)                                                  \
 462         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 463                             (long)(1 << (order)))
 464 #define obd_pages_sub(order)                                                  \
 465         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 466                             (long)(1 << (order)))
 467 #define obd_pages_sum()                                                       \
 468         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
 469                                 LPROCFS_FIELDS_FLAGS_SUM)
 470
 471 extern void obd_update_maxusage(void);
 472 extern __u64 obd_memory_max(void);
 473 extern __u64 obd_pages_max(void);
 474
 475 #else
 476
 477 extern __u64 obd_alloc;
 478 extern __u64 obd_pages;
 479
 480 extern __u64 obd_max_alloc;
 481 extern __u64 obd_max_pages;
 482
 483 static inline void obd_memory_add(long size)
 484 {
 485         obd_alloc += size;
 486         if (obd_alloc > obd_max_alloc)
 487                 obd_max_alloc = obd_alloc;
 488 }
 489
 490 static inline void obd_memory_sub(long size)
 491 {
 492         obd_alloc -= size;
 493 }
 494
 495 static inline void obd_pages_add(int order)
 496 {
 497         obd_pages += 1<< order;
 498         if (obd_pages > obd_max_pages)
 499                 obd_max_pages = obd_pages;
 500 }
 501
 502 static inline void obd_pages_sub(int order)
 503 {
 504         obd_pages -= 1<< order;
 505 }
 506
 507 #define obd_memory_sum() (obd_alloc)
 508 #define obd_pages_sum()  (obd_pages)
 509
 510 #define obd_memory_max() (obd_max_alloc)
 511 #define obd_pages_max() (obd_max_pages)
 512
 513 #endif
 514
 515 #define OBD_DEBUG_MEMUSAGE (1)
 516
 517 #if OBD_DEBUG_MEMUSAGE
 518 #define OBD_ALLOC_POST(ptr, size, name)                                 \
 519                 obd_memory_add(size);                                   \
 520                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",       \
 521                        (int)(size), ptr)
 522
 523 #define OBD_FREE_PRE(ptr, size, name)                                   \
 524         LASSERT(ptr);                                                   \
 525         obd_memory_sub(size);                                           \
 526         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",               \
 527                (int)(size), ptr);                                       \
 528         POISON(ptr, 0x5a, size)
 529
 530 #else /* !OBD_DEBUG_MEMUSAGE */
 531
 532 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
 533 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
 534
 535 #endif /* !OBD_DEBUG_MEMUSAGE */
 536
 537 #ifdef RANDOM_FAIL_ALLOC
 538 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
 539 #else
 540 #define HAS_FAIL_ALLOC_FLAG 0
 541 #endif
 542
 543 #define OBD_ALLOC_FAIL_BITS 24
 544 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
 545 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
 546
 547 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 548 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 549 do {                                                                          \
 550         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 551         if (unlikely((ptr) == NULL)) {                                        \
 552                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 553                        (int)(size), __FILE__, __LINE__);                      \
 554         } else {                                                              \
 555                 memset(ptr, 0, size);                                         \
 556                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 557                        (int)(size), ptr);                                     \
 558         }                                                                     \
 559 } while (0)
 560 #else /* this version is for the kernel and liblustre */
 561 #define OBD_FREE_RTN0(ptr)                                                    \
 562 ({                                                                            \
 563         cfs_free(ptr);                                                        \
 564         (ptr) = NULL;                                                         \
 565         0;                                                                    \
 566 })
 567 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 568 do {                                                                          \
 569         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 570         if (likely((ptr) != NULL &&                                           \
 571                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 572                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
 573                                     __FILE__, __LINE__) ||                    \
 574                     OBD_FREE_RTN0(ptr)))){                                    \
 575                 memset(ptr, 0, size);                                         \
 576                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
 577         }                                                                     \
 578 } while (0)
 579 #endif
 580
 581 #ifndef OBD_ALLOC_MASK
 582 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 583 #endif
 584
 585 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 586 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 587 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 588 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 589
 590 #ifdef __arch_um__
 591 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 592 #else
 593 # define OBD_VMALLOC(ptr, size)                                               \
 594 do {                                                                          \
 595         (ptr) = cfs_alloc_large(size);                                        \
 596         if (unlikely((ptr) == NULL)) {                                        \
 597                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
 598                        (int)(size));                                          \
 599                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
 600                        obd_memory_sum(), atomic_read(&libcfs_kmemory));       \
 601         } else {                                                              \
 602                 memset(ptr, 0, size);                                         \
 603                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
 604         }                                                                     \
 605 } while(0)
 606 #endif
 607
 608 #ifdef CONFIG_DEBUG_SLAB
 609 #define POISON(ptr, c, s) do {} while (0)
 610 #define POISON_PTR(ptr)  ((void)0)
 611 #else
 612 #define POISON(ptr, c, s) memset(ptr, c, s)
 613 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
 614 #endif
 615
 616 #ifdef POISON_BULK
 617 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 618                                     kunmap(page); } while (0)
 619 #else
 620 #define POISON_PAGE(page, val) do { } while (0)
 621 #endif
 622
 623 #ifdef __KERNEL__
 624 #define OBD_FREE(ptr, size)                                                   \
 625 do {                                                                          \
 626         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
 627         cfs_free(ptr);                                                        \
 628         POISON_PTR(ptr);                                                      \
 629 } while(0)
 630
 631
 632 #ifdef HAVE_RCU
 633 # ifdef HAVE_CALL_RCU_PARAM
 634 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 635 # else
 636 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 637 # endif
 638 #else
 639 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 640 #endif
 641
 642 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 643 do {                                                                          \
 644         struct portals_handle *__h = (handle);                                \
 645         LASSERT(handle);                                                      \
 646         __h->h_ptr = (ptr);                                                   \
 647         __h->h_size = (size);                                                 \
 648         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 649         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 650         POISON_PTR(ptr);                                                      \
 651 } while(0)
 652 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 653
 654 #else
 655 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 656 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 657 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 658 #endif /* ifdef __KERNEL__ */
 659
 660 #ifdef __arch_um__
 661 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 662 #else
 663 # define OBD_VFREE(ptr, size)                                                 \
 664 do {                                                                          \
 665         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
 666         cfs_free_large(ptr);                                                  \
 667         POISON_PTR(ptr);                                                      \
 668 } while(0)
 669 #endif
 670
 671 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 672  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 673  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 674 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
 675 ({                                                                            \
 676         cfs_mem_cache_free((slab), (ptr));                                    \
 677         (ptr) = NULL;                                                         \
 678         0;                                                                    \
 679 })
 680 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 681 do {                                                                          \
 682         LASSERT(!in_interrupt());                                             \
 683         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 684         if (likely((ptr) != NULL &&                                           \
 685                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 686                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
 687                                     __FILE__, __LINE__) ||                    \
 688                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
 689                 memset(ptr, 0, size);                                         \
 690                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
 691         }                                                                     \
 692 } while(0)
 693
 694 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 695
 696 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 697 do {                                                                          \
 698         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
 699         cfs_mem_cache_free(slab, ptr);                                        \
 700         POISON_PTR(ptr);                                                      \
 701 } while(0)
 702
 703 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 704         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 705 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 706         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 707
 708 #define KEY_IS(str) \
 709         (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
 710
 711 /* Wrapper for contiguous page frame allocation */
 712 #define OBD_PAGES_ALLOC(ptr, order, gfp_mask)                                 \
 713 do {                                                                          \
 714         (ptr) = cfs_alloc_pages(gfp_mask, order);                             \
 715         if (unlikely((ptr) == NULL)) {                                        \
 716                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
 717                        "failed\n", (int)(1 << (order)),                       \
 718                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT));            \
 719                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
 720                        "("LPU64" bytes) allocated by Lustre, "                \
 721                        "%d total bytes by LNET\n",                            \
 722                        obd_memory_sum(),                                      \
 723                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
 724                        obd_pages_sum(),                                       \
 725                        atomic_read(&libcfs_kmemory));                         \
 726         } else {                                                              \
 727                 obd_pages_add(order);                                         \
 728                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
 729                        LPU64" bytes at %p.\n",                                \
 730                        (int)(1 << (order)),                                   \
 731                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT), ptr);       \
 732         }                                                                     \
 733 } while (0)
 734
 735 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
 736         OBD_PAGES_ALLOC(ptr, 0, gfp_mask)
 737
 738 #define OBD_PAGES_FREE(ptr, order)                                            \
 739 do {                                                                          \
 740         LASSERT(ptr);                                                         \
 741         obd_pages_sub(order);                                                 \
 742         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
 743                "at %p.\n",                                                    \
 744                (int)(1 << (order)), (__u64)((1 << (order)) << CFS_PAGE_SHIFT),\
 745                ptr);                                                          \
 746         __cfs_free_pages(ptr, order);                                         \
 747         (ptr) = (void *)0xdeadbeef;                                           \
 748 } while (0)
 749
 750 #define OBD_PAGE_FREE(ptr) OBD_PAGES_FREE(ptr, 0)
 751
 752 #endif