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