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 #define OBD_FAIL_MDS_FAIL_LOV_LOG_ADD    0x140
 181
 182 #define OBD_FAIL_OST                     0x200
 183 #define OBD_FAIL_OST_CONNECT_NET         0x201
 184 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 185 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 186 #define OBD_FAIL_OST_CREATE_NET          0x204
 187 #define OBD_FAIL_OST_DESTROY_NET         0x205
 188 #define OBD_FAIL_OST_GETATTR_NET         0x206
 189 #define OBD_FAIL_OST_SETATTR_NET         0x207
 190 #define OBD_FAIL_OST_OPEN_NET            0x208
 191 #define OBD_FAIL_OST_CLOSE_NET           0x209
 192 #define OBD_FAIL_OST_BRW_NET             0x20a
 193 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 194 #define OBD_FAIL_OST_STATFS_NET          0x20c
 195 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 196 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 197 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 198 #define OBD_FAIL_OST_SYNC_NET            0x210
 199 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 200 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
 201 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 202 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 203 #define OBD_FAIL_OST_ENOSPC              0x215
 204 #define OBD_FAIL_OST_EROFS               0x216
 205 #define OBD_FAIL_OST_ENOENT              0x217
 206 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 207 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 208 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 209 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 210 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 211 #define OBD_FAIL_OST_DROP_REQ            0x21d
 212 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 213 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 214 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
 215 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 216 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 217 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
 218 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
 219 #define OBD_FAIL_OST_CONNECT_NET2        0x225
 220 #define OBD_FAIL_OST_NOMEM               0x226
 221
 222 #define OBD_FAIL_LDLM                    0x300
 223 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 224 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 225 #define OBD_FAIL_LDLM_CONVERT            0x303
 226 #define OBD_FAIL_LDLM_CANCEL             0x304
 227 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 228 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 229 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 230 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 231 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 232 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 233 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 234 #define OBD_FAIL_LDLM_REPLY              0x30c
 235 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 236 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 237 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 238 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 239 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 240 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
 241 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
 242 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
 243 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
 244 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
 245 #define OBD_FAIL_LDLM_INTR_CP_AST        0x317
 246 #define OBD_FAIL_LDLM_CP_BL_RACE         0x318
 247
 248 /* LOCKLESS IO */
 249 #define OBD_FAIL_LDLM_SET_CONTENTION     0x385
 250
 251 #define OBD_FAIL_OSC                     0x400
 252 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 253 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 254 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 255 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 256 #define OBD_FAIL_OSC_MATCH               0x405
 257 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
 258 #define OBD_FAIL_OSC_SHUTDOWN            0x407
 259 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
 260 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
 261 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
 262 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
 263 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
 264 #define OBD_FAIL_OSC_DIO_PAUSE           0x40d
 265 #define OBD_FAIL_OSC_OBJECT_CONTENTION   0x40e
 266
 267 #define OBD_FAIL_PTLRPC                  0x500
 268 #define OBD_FAIL_PTLRPC_ACK              0x501
 269 #define OBD_FAIL_PTLRPC_RQBD             0x502
 270 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 271 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 272 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 273 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 274 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 275 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
 276 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
 277 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
 278 #define OBD_FAIL_PTLRPC_IMP_DEACTIVE     0x50d
 279
 280 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
 281 #define OBD_FAIL_PTLRPC_LONG_REPL_UNLINK 0x50f
 282 #define OBD_FAIL_PTLRPC_LONG_BULK_UNLINK 0x510
 283 #define OBD_FAIL_PTLRPC_HPREQ_TIMEOUT    0x511
 284 #define OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT  0x512
 285
 286 #define OBD_FAIL_OBD_PING_NET            0x600
 287 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 288 #define OBD_FAIL_OBD_LOGD_NET            0x602
 289 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 290 #define OBD_FAIL_OBD_DQACQ               0x604
 291 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
 292 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
 293
 294 #define OBD_FAIL_TGT_REPLY_NET           0x700
 295 #define OBD_FAIL_TGT_CONN_RACE           0x701
 296 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 297 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 298 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 299 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 300 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
 301 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
 302 #define OBD_FAIL_TGT_FAKE_EXP            0x708
 303 #define OBD_FAIL_TGT_REPLAY_DELAY        0x709
 304 #define OBD_FAIL_TGT_LAST_REPLAY         0x710
 305
 306 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 307 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 308 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
 309 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
 310
 311 #define OBD_FAIL_MGS                     0x900
 312 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 313 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 314 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
 315 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
 316 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
 317
 318 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(1, 9, 0, 0)
 319 #define OBD_FAIL_QUOTA_WITHOUT_CHANGE_QS    0xA01
 320 #else
 321 #warning "remove quota code above for format obsolete in new release"
 322 #endif
 323
 324 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
 325 #define OBD_FAIL_QUOTA_DELAY_REL         0xA03
 326
 327 #define OBD_FAIL_LPROC_REMOVE            0xB00
 328
 329 #define OBD_FAIL_GENERAL_ALLOC           0xC00
 330
 331 /* Failure injection control */
 332 #define OBD_FAIL_MASK_SYS    0x0000FF00
 333 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
 334 #define OBD_FAIL_ONCE        0x80000000
 335 #define OBD_FAILED           0x40000000
 336 /* The following flags aren't made to be combined */
 337 #define OBD_FAIL_SKIP        0x20000000 /* skip N then fail */
 338 #define OBD_FAIL_SOME        0x10000000 /* fail N times */
 339 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the time */
 340 #define OBD_FAIL_USR1        0x04000000 /* user flag */
 341
 342 int obd_fail_check(__u32 id);
 343 #define OBD_FAIL_CHECK(id)                                                   \
 344 ({                                                                           \
 345         int _ret_ = 0;                                                       \
 346         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 347                 CERROR("*** obd_fail_loc=%x ***\n", id);                     \
 348         }                                                                    \
 349         _ret_;                                                               \
 350 })
 351
 352 #define OBD_FAIL_CHECK_QUIET(id)                                             \
 353         (unlikely(obd_fail_loc) ? obd_fail_check(id) : 0)
 354
 355 /* deprecated - just use OBD_FAIL_CHECK */
 356 #define OBD_FAIL_CHECK_ONCE OBD_FAIL_CHECK
 357
 358 #define OBD_FAIL_RETURN(id, ret)                                             \
 359 do {                                                                         \
 360         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 361                 CERROR("*** obd_fail_return=%x rc=%d ***\n", id, ret);       \
 362                 RETURN(ret);                                                 \
 363         }                                                                    \
 364 } while(0)
 365
 366 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 367 ({      int _ret_ = 0;                                                       \
 368         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 369                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
 370                        (id), (secs));                                        \
 371                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 372                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 373                                     cfs_time_seconds(secs));                 \
 374                 set_current_state(TASK_RUNNING);                             \
 375                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 376         }                                                                    \
 377         _ret_;                                                               \
 378 })
 379
 380 #define OBD_FAIL_TIMEOUT_MS(id, ms)                                          \
 381 ({      int _ret_ = 0;                                                       \
 382         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 383                 CERROR("obd_fail_timeout id %x sleeping for %d ms\n",        \
 384                        (id), (ms));                                          \
 385                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 386                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 387                                      cfs_time_seconds(ms)/1000);             \
 388                 set_current_state(TASK_RUNNING);                             \
 389                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 390         }                                                                    \
 391         _ret_;                                                               \
 392 })
 393
 394 #ifdef __KERNEL__
 395 /* The idea here is to synchronise two threads to force a race. The
 396  * first thread that calls this with a matching fail_loc is put to
 397  * sleep. The next thread that calls with the same fail_loc wakes up
 398  * the first and continues. */
 399 #define OBD_RACE(id)                                                         \
 400 do {                                                                         \
 401         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 402                 obd_race_state = 0;                                          \
 403                 CERROR("obd_race id %x sleeping\n", (id));                   \
 404                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
 405                 CERROR("obd_fail_race id %x awake\n", (id));                 \
 406         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
 407                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
 408                 CERROR("obd_fail_race id %x waking\n", (id));                \
 409                 obd_race_state = 1;                                          \
 410                 wake_up(&obd_race_waitq);                                    \
 411         }                                                                    \
 412 } while(0)
 413 #else
 414 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 415 #define OBD_RACE(foo) do {} while(0)
 416 #endif
 417
 418 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 419
 420 extern atomic_t libcfs_kmemory;
 421
 422 #ifdef RANDOM_FAIL_ALLOC
 423 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK_QUIET(OBD_FAIL_GENERAL_ALLOC)
 424 #else
 425 #define HAS_FAIL_ALLOC_FLAG 0
 426 #endif
 427
 428 #define OBD_ALLOC_FAIL_BITS 24
 429 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
 430 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
 431
 432 #ifdef LPROCFS
 433 #define obd_memory_add(size)                                                  \
 434         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
 435 #define obd_memory_sub(size)                                                  \
 436         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
 437 #define obd_memory_sum()                                                      \
 438         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
 439                                 LPROCFS_FIELDS_FLAGS_SUM)
 440 #define obd_pages_add(order)                                                  \
 441         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 442                             (long)(1 << (order)))
 443 #define obd_pages_sub(order)                                                  \
 444         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 445                             (long)(1 << (order)))
 446 #define obd_pages_sum()                                                       \
 447         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
 448                                 LPROCFS_FIELDS_FLAGS_SUM)
 449
 450 extern void obd_update_maxusage(void);
 451 extern __u64 obd_memory_max(void);
 452 extern __u64 obd_pages_max(void);
 453
 454 #else
 455
 456 extern __u64 obd_alloc;
 457 extern __u64 obd_pages;
 458
 459 extern __u64 obd_max_alloc;
 460 extern __u64 obd_max_pages;
 461
 462 static inline void obd_memory_add(long size)
 463 {
 464         obd_alloc += size;
 465         if (obd_alloc > obd_max_alloc)
 466                 obd_max_alloc = obd_alloc;
 467 }
 468
 469 static inline void obd_memory_sub(long size)
 470 {
 471         obd_alloc -= size;
 472 }
 473
 474 static inline void obd_pages_add(int order)
 475 {
 476         obd_pages += 1<< order;
 477         if (obd_pages > obd_max_pages)
 478                 obd_max_pages = obd_pages;
 479 }
 480
 481 static inline void obd_pages_sub(int order)
 482 {
 483         obd_pages -= 1<< order;
 484 }
 485
 486 #define obd_memory_sum() (obd_alloc)
 487 #define obd_pages_sum()  (obd_pages)
 488
 489 #define obd_memory_max() (obd_max_alloc)
 490 #define obd_pages_max() (obd_max_pages)
 491
 492 #endif
 493
 494 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 495 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 496 do {                                                                          \
 497         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 498         if (unlikely((ptr) == NULL)) {                                        \
 499                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed\n",           \
 500                        (int)(size));                                          \
 501         } else {                                                              \
 502                 memset(ptr, 0, size);                                         \
 503                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 504                        (int)(size), ptr);                                     \
 505         }                                                                     \
 506 } while (0)
 507 #else /* this version is for the kernel and liblustre */
 508 #define OBD_FREE_RTN0(ptr)                                                    \
 509 ({                                                                            \
 510         cfs_free(ptr);                                                        \
 511         (ptr) = NULL;                                                         \
 512         0;                                                                    \
 513 })
 514 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 515 do {                                                                          \
 516         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 517         if (likely((ptr) != NULL &&                                           \
 518                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 519                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
 520                                     __FILE__, __LINE__) ||                    \
 521                     OBD_FREE_RTN0(ptr)))){                                    \
 522                 memset(ptr, 0, size);                                         \
 523                 obd_memory_add(size);                                         \
 524                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p.\n",         \
 525                        (int)(size), ptr);                                     \
 526         }                                                                     \
 527 } while (0)
 528 #endif
 529
 530 #ifndef OBD_ALLOC_MASK
 531 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 532 #endif
 533
 534 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 535 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 536 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 537 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 538
 539 #ifdef __arch_um__
 540 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 541 #else
 542 # define OBD_VMALLOC(ptr, size)                                               \
 543 do {                                                                          \
 544         (ptr) = cfs_alloc_large(size);                                        \
 545         if (unlikely((ptr) == NULL)) {                                        \
 546                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
 547                        (int)(size));                                          \
 548                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
 549                        obd_memory_sum(), atomic_read(&libcfs_kmemory));      \
 550         } else {                                                              \
 551                 memset(ptr, 0, size);                                         \
 552                 obd_memory_add(size);                                         \
 553                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p.\n",         \
 554                        (int)(size), ptr);                                     \
 555         }                                                                     \
 556 } while (0)
 557 #endif
 558
 559 #ifdef CONFIG_DEBUG_SLAB
 560 #define POISON(ptr, c, s) do {} while (0)
 561 #else
 562 #define POISON(ptr, c, s) memset(ptr, c, s)
 563 #endif
 564
 565 #ifdef POISON_BULK
 566 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 567                                     kunmap(page); } while (0)
 568 #else
 569 #define POISON_PAGE(page, val) do { } while (0)
 570 #endif
 571
 572 #ifdef __KERNEL__
 573 #define OBD_FREE(ptr, size)                                                   \
 574 do {                                                                          \
 575         LASSERT(ptr);                                                         \
 576         obd_memory_sub(size);                                                 \
 577         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p.\n",                    \
 578                (int)(size), ptr);                                             \
 579         POISON(ptr, 0x5a, size);                                              \
 580         cfs_free(ptr);                                                        \
 581         (ptr) = (void *)0xdeadbeef;                                           \
 582 } while (0)
 583
 584 #ifdef HAVE_RCU
 585 # ifdef HAVE_CALL_RCU_PARAM
 586 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, (void (*) (void *))(cb), rcu)
 587 # else
 588 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 589 # endif
 590 #else
 591 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 592 #endif
 593
 594 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 595 do {                                                                          \
 596         struct portals_handle *__h = (handle);                                \
 597         LASSERT(handle);                                                      \
 598         __h->h_ptr = (ptr);                                                   \
 599         __h->h_size = (size);                                                 \
 600         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 601         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 602         (ptr) = (void *)0xdeadbeef;                                           \
 603 } while(0)
 604 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 605 #else
 606 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 607 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 608 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 609 #endif
 610
 611 #ifdef __arch_um__
 612 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 613 #else
 614 # define OBD_VFREE(ptr, size)                                                 \
 615 do {                                                                          \
 616         LASSERT(ptr);                                                         \
 617         obd_memory_sub(size);                                                 \
 618         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p.\n",                    \
 619                (int)(size), ptr);                                             \
 620         POISON(ptr, 0x5a, size);                                              \
 621         cfs_free_large(ptr);                                                  \
 622         (ptr) = (void *)0xdeadbeef;                                           \
 623 } while (0)
 624 #endif
 625
 626 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 627  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 628  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 629 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
 630 ({                                                                            \
 631         cfs_mem_cache_free((slab), (ptr));                                    \
 632         (ptr) = NULL;                                                         \
 633         0;                                                                    \
 634 })
 635 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 636 do {                                                                          \
 637         LASSERT(!in_interrupt());                                             \
 638         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 639         if (likely((ptr) != NULL &&                                           \
 640                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 641                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
 642                                     __FILE__, __LINE__) ||                    \
 643                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
 644                 memset(ptr, 0, size);                                         \
 645                 obd_memory_add(size);                                         \
 646                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p.\n",        \
 647                        (int)(size), ptr);                                     \
 648         }                                                                     \
 649 } while (0)
 650
 651 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 652
 653 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 654 do {                                                                          \
 655         LASSERT(ptr);                                                         \
 656         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p.\n",                \
 657                (int)(size), ptr);                                             \
 658         obd_memory_sub(size);                                                 \
 659         POISON(ptr, 0x5a, size);                                              \
 660         cfs_mem_cache_free(slab, ptr);                                        \
 661         (ptr) = (void *)0xdeadbeef;                                           \
 662 } while (0)
 663
 664 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 665         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 666 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 667         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 668
 669 #define KEY_IS(str) \
 670         (keylen >= (sizeof(str) - 1) && memcmp(key, str, sizeof(str) - 1) == 0)
 671
 672 /* Wrapper for contiguous page frame allocation */
 673 #define OBD_PAGES_ALLOC(ptr, order, gfp_mask)                                 \
 674 do {                                                                          \
 675         (ptr) = cfs_alloc_pages(gfp_mask, order);                             \
 676         if (unlikely((ptr) == NULL)) {                                        \
 677                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
 678                        "failed\n", (int)(1 << (order)),                       \
 679                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT));            \
 680                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
 681                        "("LPU64" bytes) allocated by Lustre, "                \
 682                        "%d total bytes by LNET\n",                            \
 683                        obd_memory_sum(),                                      \
 684                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
 685                        obd_pages_sum(),                                       \
 686                        atomic_read(&libcfs_kmemory));                         \
 687         } else {                                                              \
 688                 obd_pages_add(order);                                         \
 689                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
 690                        LPU64" bytes at %p.\n",                                \
 691                        (int)(1 << (order)),                                   \
 692                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT), ptr);       \
 693         }                                                                     \
 694 } while (0)
 695
 696 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
 697         OBD_PAGES_ALLOC(ptr, 0, gfp_mask)
 698
 699 #define OBD_PAGES_FREE(ptr, order)                                            \
 700 do {                                                                          \
 701         LASSERT(ptr);                                                         \
 702         obd_pages_sub(order);                                                 \
 703         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
 704                "at %p.\n",                                                    \
 705                (int)(1 << (order)), (__u64)((1 << (order)) << CFS_PAGE_SHIFT),\
 706                ptr);                                                          \
 707         __cfs_free_pages(ptr, order);                                         \
 708         (ptr) = (void *)0xdeadbeef;                                           \
 709 } while (0)
 710
 711 #define OBD_PAGE_FREE(ptr) OBD_PAGES_FREE(ptr, 0)
 712
 713 #if defined(__linux__)
 714 #include <linux/obd_support.h>
 715 #elif defined(__APPLE__)
 716 #include <darwin/obd_support.h>
 717 #elif defined(__WINNT__)
 718 #include <winnt/obd_support.h>
 719 #else
 720 #error Unsupported operating system.
 721 #endif
 722
 723 #endif