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