lustre/include/obd_support.h

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