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