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