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  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  */
  38
  39 #ifndef _OBD_SUPPORT
  40 #define _OBD_SUPPORT
  41
  42 #include <libcfs/libcfs.h>
  43 #include <lvfs.h>
  44 #include <lprocfs_status.h>
  45
  46 #if defined(__linux__)
  47 #include <linux/obd_support.h>
  48 #elif defined(__APPLE__)
  49 #include <darwin/obd_support.h>
  50 #elif defined(__WINNT__)
  51 #include <winnt/obd_support.h>
  52 #else
  53 #error Unsupported operating system.
  54 #endif
  55
  56 /* global variables */
  57 extern struct lprocfs_stats *obd_memory;
  58 enum {
  59         OBD_MEMORY_STAT = 0,
  60         OBD_MEMORY_PAGES_STAT = 1,
  61         OBD_STATS_NUM,
  62 };
  63
  64 extern unsigned int obd_debug_peer_on_timeout;
  65 extern unsigned int obd_dump_on_timeout;
  66 extern unsigned int obd_dump_on_eviction;
  67 /* obd_timeout should only be used for recovery, not for
  68    networking / disk / timings affected by load (use Adaptive Timeouts) */
  69 extern unsigned int obd_timeout;          /* seconds */
  70 extern unsigned int ldlm_timeout;         /* seconds */
  71 extern unsigned int at_min;
  72 extern unsigned int at_max;
  73 extern unsigned int at_history;
  74 extern int at_early_margin;
  75 extern int at_extra;
  76 extern unsigned int obd_sync_filter;
  77 extern unsigned int obd_max_dirty_pages;
  78 extern cfs_atomic_t obd_dirty_pages;
  79 extern cfs_atomic_t obd_dirty_transit_pages;
  80 extern unsigned int obd_alloc_fail_rate;
  81
  82 /* lvfs.c */
  83 int obd_alloc_fail(const void *ptr, const char *name, const char *type,
  84                    size_t size, const char *file, int line);
  85
  86 /* Some hash init argument constants */
  87 #define HASH_POOLS_BKT_BITS 3
  88 #define HASH_POOLS_CUR_BITS 3
  89 #define HASH_POOLS_MAX_BITS 7
  90 #define HASH_UUID_BKT_BITS 5
  91 #define HASH_UUID_CUR_BITS 7
  92 #define HASH_UUID_MAX_BITS 12
  93 #define HASH_NID_BKT_BITS 5
  94 #define HASH_NID_CUR_BITS 7
  95 #define HASH_NID_MAX_BITS 12
  96 #define HASH_NID_STATS_BKT_BITS 5
  97 #define HASH_NID_STATS_CUR_BITS 7
  98 #define HASH_NID_STATS_MAX_BITS 12
  99 #define HASH_LQS_BKT_BITS 5
 100 #define HASH_LQS_CUR_BITS 7
 101 #define HASH_LQS_MAX_BITS 12
 102 #define HASH_CONN_BKT_BITS 5
 103 #define HASH_CONN_CUR_BITS 5
 104 #define HASH_CONN_MAX_BITS 15
 105 #define HASH_EXP_LOCK_BKT_BITS  5
 106 #define HASH_EXP_LOCK_CUR_BITS  7
 107 #define HASH_EXP_LOCK_MAX_BITS  16
 108 #define HASH_CL_ENV_BKT_BITS    5
 109 #define HASH_CL_ENV_BITS        10
 110
 111 /* Timeout definitions */
 112 #define OBD_TIMEOUT_DEFAULT             100
 113 #define LDLM_TIMEOUT_DEFAULT            20
 114 #define MDS_LDLM_TIMEOUT_DEFAULT        6
 115 /* Time to wait for all clients to reconnect during recovery (hard limit) */
 116 #define OBD_RECOVERY_TIME_HARD          (obd_timeout * 9)
 117 /* Time to wait for all clients to reconnect during recovery (soft limit) */
 118 /* Should be very conservative; must catch the first reconnect after reboot */
 119 #define OBD_RECOVERY_TIME_SOFT          (obd_timeout * 3)
 120 /* Change recovery-small 26b time if you change this */
 121 #define PING_INTERVAL max(obd_timeout / 4, 1U)
 122 /* a bit more than maximal journal commit time in seconds */
 123 #define PING_INTERVAL_SHORT min(PING_INTERVAL, 7U)
 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 /* The min time a target should wait for clients to reconnect in recovery */
 153 #define OBD_RECOVERY_TIME_MIN    (2*RECONNECT_DELAY_MAX)
 154 #define OBD_IR_FACTOR_MIN         1
 155 #define OBD_IR_FACTOR_MAX         10
 156 #define OBD_IR_FACTOR_DEFAULT    (OBD_IR_FACTOR_MAX/2)
 157 /* default timeout for the MGS to become IR_FULL */
 158 #define OBD_IR_MGS_TIMEOUT       (4*obd_timeout)
 159 #define LONG_UNLINK 300          /* Unlink should happen before now */
 160
 161 /**
 162  * Time interval of shrink, if the client is "idle" more than this interval,
 163  * then the ll_grant thread will return the requested grant space to filter
 164  */
 165 #define GRANT_SHRINK_INTERVAL            1200/*20 minutes*/
 166
 167 #define OBD_FAIL_MDS                     0x100
 168 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
 169 #define OBD_FAIL_MDS_GETATTR_NET         0x102
 170 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
 171 #define OBD_FAIL_MDS_READPAGE_NET        0x104
 172 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
 173 #define OBD_FAIL_MDS_SENDPAGE            0x106
 174 #define OBD_FAIL_MDS_REINT_NET           0x107
 175 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
 176 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
 177 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
 178 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
 179 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
 180 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
 181 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
 182 #define OBD_FAIL_MDS_REINT_LINK          0x10f
 183 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
 184 #define OBD_FAIL_MDS_REINT_RENAME        0x111
 185 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
 186 #define OBD_FAIL_MDS_OPEN_NET            0x113
 187 #define OBD_FAIL_MDS_OPEN_PACK           0x114
 188 #define OBD_FAIL_MDS_CLOSE_NET           0x115
 189 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
 190 #define OBD_FAIL_MDS_CONNECT_NET         0x117
 191 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
 192 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
 193 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
 194 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
 195 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
 196 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
 197 #define OBD_FAIL_MDS_STATFS_NET          0x11e
 198 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
 199 #define OBD_FAIL_MDS_PIN_NET             0x120
 200 #define OBD_FAIL_MDS_UNPIN_NET           0x121
 201 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
 202 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
 203 #define OBD_FAIL_MDS_SYNC_NET            0x124
 204 #define OBD_FAIL_MDS_SYNC_PACK           0x125
 205 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
 206 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
 207 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
 208 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
 209 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
 210 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
 211 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
 212 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
 213 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
 214 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
 215 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
 216 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
 217 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
 218 #define OBD_FAIL_MDS_SETXATTR            0x133
 219 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
 220 #define OBD_FAIL_MDS_FS_SETUP            0x135
 221 #define OBD_FAIL_MDS_RESEND              0x136
 222 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x137
 223 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
 224 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
 225 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
 226 #define OBD_FAIL_MDS_CLOSE_NET_REP       0x13b
 227 #define OBD_FAIL_MDS_BLOCK_QUOTA_REQ     0x13c
 228 #define OBD_FAIL_MDS_DROP_QUOTA_REQ      0x13d
 229 #define OBD_FAIL_MDS_REMOVE_COMMON_EA    0x13e
 230 #define OBD_FAIL_MDS_ALLOW_COMMON_EA_SETTING   0x13f
 231 #define OBD_FAIL_MDS_FAIL_LOV_LOG_ADD    0x140
 232 #define OBD_FAIL_MDS_LOV_PREP_CREATE     0x141
 233 #define OBD_FAIL_MDS_REINT_DELAY         0x142
 234 #define OBD_FAIL_MDS_READLINK_EPROTO     0x143
 235 #define OBD_FAIL_MDS_OPEN_WAIT_CREATE    0x144
 236 #define OBD_FAIL_MDS_PDO_LOCK            0x145
 237 #define OBD_FAIL_MDS_PDO_LOCK2           0x146
 238 #define OBD_FAIL_MDS_OSC_CREATE_FAIL     0x147
 239
 240 /* CMD */
 241 #define OBD_FAIL_MDS_IS_SUBDIR_NET       0x180
 242 #define OBD_FAIL_MDS_IS_SUBDIR_PACK      0x181
 243 #define OBD_FAIL_MDS_SET_INFO_NET        0x182
 244 #define OBD_FAIL_MDS_WRITEPAGE_NET       0x183
 245 #define OBD_FAIL_MDS_WRITEPAGE_PACK      0x184
 246 #define OBD_FAIL_MDS_RECOVERY_ACCEPTS_GAPS 0x185
 247 #define OBD_FAIL_MDS_GET_INFO_NET        0x186
 248
 249 #define OBD_FAIL_OST                     0x200
 250 #define OBD_FAIL_OST_CONNECT_NET         0x201
 251 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 252 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 253 #define OBD_FAIL_OST_CREATE_NET          0x204
 254 #define OBD_FAIL_OST_DESTROY_NET         0x205
 255 #define OBD_FAIL_OST_GETATTR_NET         0x206
 256 #define OBD_FAIL_OST_SETATTR_NET         0x207
 257 #define OBD_FAIL_OST_OPEN_NET            0x208
 258 #define OBD_FAIL_OST_CLOSE_NET           0x209
 259 #define OBD_FAIL_OST_BRW_NET             0x20a
 260 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 261 #define OBD_FAIL_OST_STATFS_NET          0x20c
 262 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 263 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 264 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 265 #define OBD_FAIL_OST_SYNC_NET            0x210
 266 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 267 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
 268 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 269 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 270 #define OBD_FAIL_OST_ENOSPC              0x215
 271 #define OBD_FAIL_OST_EROFS               0x216
 272 #define OBD_FAIL_OST_ENOENT              0x217
 273 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 274 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 275 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 276 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 277 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 278 #define OBD_FAIL_OST_DROP_REQ            0x21d
 279 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 280 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 281 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
 282 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 283 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 284 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
 285 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
 286 #define OBD_FAIL_OST_CONNECT_NET2        0x225
 287 #define OBD_FAIL_OST_NOMEM               0x226
 288 #define OBD_FAIL_OST_BRW_PAUSE_BULK2     0x227
 289 #define OBD_FAIL_OST_MAPBLK_ENOSPC       0x228
 290 #define OBD_FAIL_OST_ENOINO              0x229
 291
 292 #define OBD_FAIL_LDLM                    0x300
 293 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 294 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 295 #define OBD_FAIL_LDLM_CONVERT            0x303
 296 #define OBD_FAIL_LDLM_CANCEL             0x304
 297 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 298 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 299 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 300 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 301 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 302 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 303 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 304 #define OBD_FAIL_LDLM_REPLY              0x30c
 305 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 306 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 307 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 308 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 309 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 310 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
 311 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
 312 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
 313 #define OBD_FAIL_LDLM_CP_CB_WAIT         0x315
 314 #define OBD_FAIL_LDLM_OST_FAIL_RACE      0x316
 315 #define OBD_FAIL_LDLM_INTR_CP_AST        0x317
 316 #define OBD_FAIL_LDLM_CP_BL_RACE         0x318
 317 #define OBD_FAIL_LDLM_NEW_LOCK           0x319
 318 #define OBD_FAIL_LDLM_AGL_DELAY          0x31a
 319 #define OBD_FAIL_LDLM_AGL_NOLOCK         0x31b
 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 #define OBD_FAIL_OSC_NO_GRANT            0x411
 342
 343 #define OBD_FAIL_PTLRPC                  0x500
 344 #define OBD_FAIL_PTLRPC_ACK              0x501
 345 #define OBD_FAIL_PTLRPC_RQBD             0x502
 346 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 347 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 348 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 349 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 350 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 351 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
 352 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
 353 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
 354 #define OBD_FAIL_PTLRPC_IMP_DEACTIVE     0x50d
 355 #define OBD_FAIL_PTLRPC_DUMP_LOG         0x50e
 356 #define OBD_FAIL_PTLRPC_LONG_REPL_UNLINK 0x50f
 357 #define OBD_FAIL_PTLRPC_LONG_BULK_UNLINK 0x510
 358 #define OBD_FAIL_PTLRPC_HPREQ_TIMEOUT    0x511
 359 #define OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT  0x512
 360 #define OBD_FAIL_PTLRPC_DROP_REQ_OPC     0x513
 361 #define OBD_FAIL_PTLRPC_FINISH_REPLAY    0x514
 362 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB2  0x515
 363
 364 #define OBD_FAIL_OBD_PING_NET            0x600
 365 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 366 #define OBD_FAIL_OBD_LOGD_NET            0x602
 367 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 368 #define OBD_FAIL_OBD_DQACQ               0x604
 369 #define OBD_FAIL_OBD_LLOG_SETUP          0x605
 370 #define OBD_FAIL_OBD_LOG_CANCEL_REP      0x606
 371
 372 #define OBD_FAIL_TGT_REPLY_NET           0x700
 373 #define OBD_FAIL_TGT_CONN_RACE           0x701
 374 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 375 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 376 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 377 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 378 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
 379 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
 380 #define OBD_FAIL_TGT_FAKE_EXP            0x708
 381 #define OBD_FAIL_TGT_REPLAY_DELAY        0x709
 382 #define OBD_FAIL_TGT_LAST_REPLAY         0x710
 383 #define OBD_FAIL_TGT_CLIENT_ADD          0x711
 384 #define OBD_FAIL_TGT_RCVG_FLAG           0x712
 385
 386 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 387 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 388 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
 389 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
 390
 391 #define OBD_FAIL_MGS                     0x900
 392 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 393 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 394 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
 395 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
 396 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
 397
 398 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
 399 #define OBD_FAIL_QUOTA_DELAY_REL         0xA03
 400 #define OBD_FAIL_QUOTA_DELAY_SD          0xA04
 401
 402 #define OBD_FAIL_LPROC_REMOVE            0xB00
 403
 404 #define OBD_FAIL_GENERAL_ALLOC           0xC00
 405
 406 #define OBD_FAIL_SEQ                     0x1000
 407 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
 408
 409 #define OBD_FAIL_FLD                     0x1100
 410 #define OBD_FAIL_FLD_QUERY_NET           0x1101
 411
 412 #define OBD_FAIL_SEC_CTX                 0x1200
 413 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
 414 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
 415 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
 416 #define OBD_FAIL_SEC_CTX_HDL_PAUSE       0x1204
 417
 418 #define OBD_FAIL_LLOG                               0x1300
 419 #define OBD_FAIL_LLOG_ORIGIN_CONNECT_NET            0x1301
 420 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CREATE_NET      0x1302
 421 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_DESTROY_NET     0x1303
 422 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_READ_HEADER_NET 0x1304
 423 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_NEXT_BLOCK_NET  0x1305
 424 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_PREV_BLOCK_NET  0x1306
 425 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_WRITE_REC_NET   0x1307
 426 #define OBD_FAIL_LLOG_ORIGIN_HANDLE_CLOSE_NET       0x1308
 427 #define OBD_FAIL_LLOG_CATINFO_NET                   0x1309
 428 #define OBD_FAIL_MDS_SYNC_CAPA_SL                   0x1310
 429 #define OBD_FAIL_SEQ_ALLOC                          0x1311
 430
 431 #define OBD_FAIL_LLITE                              0x1400
 432 #define OBD_FAIL_LLITE_FAULT_TRUNC_RACE             0x1401
 433
 434 /* Assign references to moved code to reduce code changes */
 435 #define OBD_FAIL_PRECHECK(id)                   CFS_FAIL_PRECHECK(id)
 436 #define OBD_FAIL_CHECK(id)                      CFS_FAIL_CHECK(id)
 437 #define OBD_FAIL_CHECK_VALUE(id, value)         CFS_FAIL_CHECK_VALUE(id, value)
 438 #define OBD_FAIL_CHECK_ORSET(id, value)         CFS_FAIL_CHECK_ORSET(id, value)
 439 #define OBD_FAIL_CHECK_RESET(id, value)         CFS_FAIL_CHECK_RESET(id, value)
 440 #define OBD_FAIL_RETURN(id, ret)                CFS_FAIL_RETURN(id, ret)
 441 #define OBD_FAIL_TIMEOUT(id, secs)              CFS_FAIL_TIMEOUT(id, secs)
 442 #define OBD_FAIL_TIMEOUT_MS(id, ms)             CFS_FAIL_TIMEOUT_MS(id, ms)
 443 #define OBD_FAIL_TIMEOUT_ORSET(id, value, secs) CFS_FAIL_TIMEOUT_ORSET(id, value, secs)
 444 #define OBD_RACE(id)                            CFS_RACE(id)
 445 #define OBD_FAIL_ONCE                           CFS_FAIL_ONCE
 446 #define OBD_FAILED                              CFS_FAILED
 447
 448 #ifdef __KERNEL__
 449 static inline void obd_fail_write(int id, struct super_block *sb)
 450 {
 451         /* We set FAIL_ONCE because we never "un-fail" a device */
 452         if (OBD_FAIL_CHECK_ORSET(id & ~OBD_FAIL_ONCE, OBD_FAIL_ONCE)) {
 453 #ifdef LIBCFS_DEBUG
 454                 BDEVNAME_DECLARE_STORAGE(tmp);
 455                 CERROR("cfs_fail_loc=%x, fail write operation on %s\n",
 456                        id, ll_bdevname(sb, tmp));
 457 #endif
 458                 /* TODO-CMD: fix getting jdev */
 459                 __lvfs_set_rdonly(lvfs_sbdev(sb), (lvfs_sbdev_type)0);
 460         }
 461 }
 462 #define OBD_FAIL_WRITE(id, sb) obd_fail_write(id, sb)
 463 #endif
 464
 465 extern cfs_atomic_t libcfs_kmemory;
 466
 467 #ifdef LPROCFS
 468 #define obd_memory_add(size)                                                  \
 469         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
 470 #define obd_memory_sub(size)                                                  \
 471         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
 472 #define obd_memory_sum()                                                      \
 473         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
 474                                 LPROCFS_FIELDS_FLAGS_SUM)
 475 #define obd_pages_add(order)                                                  \
 476         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 477                             (long)(1 << (order)))
 478 #define obd_pages_sub(order)                                                  \
 479         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 480                             (long)(1 << (order)))
 481 #define obd_pages_sum()                                                       \
 482         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
 483                                 LPROCFS_FIELDS_FLAGS_SUM)
 484
 485 extern void obd_update_maxusage(void);
 486 extern __u64 obd_memory_max(void);
 487 extern __u64 obd_pages_max(void);
 488
 489 #else
 490
 491 extern __u64 obd_alloc;
 492 extern __u64 obd_pages;
 493
 494 extern __u64 obd_max_alloc;
 495 extern __u64 obd_max_pages;
 496
 497 static inline void obd_memory_add(long size)
 498 {
 499         obd_alloc += size;
 500         if (obd_alloc > obd_max_alloc)
 501                 obd_max_alloc = obd_alloc;
 502 }
 503
 504 static inline void obd_memory_sub(long size)
 505 {
 506         obd_alloc -= size;
 507 }
 508
 509 static inline void obd_pages_add(int order)
 510 {
 511         obd_pages += 1<< order;
 512         if (obd_pages > obd_max_pages)
 513                 obd_max_pages = obd_pages;
 514 }
 515
 516 static inline void obd_pages_sub(int order)
 517 {
 518         obd_pages -= 1<< order;
 519 }
 520
 521 #define obd_memory_sum() (obd_alloc)
 522 #define obd_pages_sum()  (obd_pages)
 523
 524 #define obd_memory_max() (obd_max_alloc)
 525 #define obd_pages_max() (obd_max_pages)
 526
 527 #endif
 528
 529 #define OBD_DEBUG_MEMUSAGE (1)
 530
 531 #if OBD_DEBUG_MEMUSAGE
 532 #define OBD_ALLOC_POST(ptr, size, name)                                 \
 533                 obd_memory_add(size);                                   \
 534                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",       \
 535                        (int)(size), ptr)
 536
 537 #define OBD_FREE_PRE(ptr, size, name)                                   \
 538         LASSERT(ptr);                                                   \
 539         obd_memory_sub(size);                                           \
 540         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p.\n",               \
 541                (int)(size), ptr);                                       \
 542         POISON(ptr, 0x5a, size)
 543
 544 #else /* !OBD_DEBUG_MEMUSAGE */
 545
 546 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
 547 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
 548
 549 #endif /* !OBD_DEBUG_MEMUSAGE */
 550
 551 #ifdef RANDOM_FAIL_ALLOC
 552 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
 553 #else
 554 #define HAS_FAIL_ALLOC_FLAG 0
 555 #endif
 556
 557 #define OBD_ALLOC_FAIL_BITS 24
 558 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
 559 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
 560
 561 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 562 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 563 do {                                                                          \
 564         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 565         if (unlikely((ptr) == NULL)) {                                        \
 566                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 567                        (int)(size), __FILE__, __LINE__);                      \
 568         } else {                                                              \
 569                 memset(ptr, 0, size);                                         \
 570                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 571                        (int)(size), ptr);                                     \
 572         }                                                                     \
 573 } while (0)
 574 #else /* this version is for the kernel and liblustre */
 575 #define OBD_FREE_RTN0(ptr)                                                    \
 576 ({                                                                            \
 577         cfs_free(ptr);                                                        \
 578         (ptr) = NULL;                                                         \
 579         0;                                                                    \
 580 })
 581 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 582 do {                                                                          \
 583         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 584         if (likely((ptr) != NULL &&                                           \
 585                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 586                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
 587                                     __FILE__, __LINE__) ||                    \
 588                     OBD_FREE_RTN0(ptr)))){                                    \
 589                 memset(ptr, 0, size);                                         \
 590                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
 591         }                                                                     \
 592 } while (0)
 593 #endif
 594
 595 #ifndef OBD_ALLOC_MASK
 596 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 597 #endif
 598
 599 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 600 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 601 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 602 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 603
 604 #ifdef __arch_um__
 605 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 606 #else
 607 # define OBD_VMALLOC(ptr, size)                                               \
 608 do {                                                                          \
 609         (ptr) = cfs_alloc_large(size);                                        \
 610         if (unlikely((ptr) == NULL)) {                                        \
 611                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
 612                        (int)(size));                                          \
 613                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
 614                        obd_memory_sum(), cfs_atomic_read(&libcfs_kmemory));   \
 615         } else {                                                              \
 616                 memset(ptr, 0, size);                                         \
 617                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
 618         }                                                                     \
 619 } while(0)
 620 #endif
 621
 622 #ifdef __KERNEL__
 623
 624 /* Allocations above this size are considered too big and could not be done
 625  * atomically.
 626  *
 627  * Be very careful when changing this value, especially when decreasing it,
 628  * since vmalloc in Linux doesn't perform well on multi-cores system, calling
 629  * vmalloc in critical path would hurt peformance badly. See LU-66.
 630  */
 631 #define OBD_ALLOC_BIG (4 * CFS_PAGE_SIZE)
 632
 633 #define OBD_ALLOC_LARGE(ptr, size)                                            \
 634 do {                                                                          \
 635         if (size > OBD_ALLOC_BIG)                                             \
 636                 OBD_VMALLOC(ptr, size);                                       \
 637         else                                                                  \
 638                 OBD_ALLOC(ptr, size);                                         \
 639 } while (0)
 640
 641 #define OBD_FREE_LARGE(ptr, size)                                             \
 642 do {                                                                          \
 643         if (size > OBD_ALLOC_BIG)                                             \
 644                 OBD_VFREE(ptr, size);                                         \
 645         else                                                                  \
 646                 OBD_FREE(ptr, size);                                          \
 647 } while (0)
 648 #else
 649 #define OBD_ALLOC_LARGE(ptr, size) OBD_ALLOC(ptr, size)
 650 #define OBD_FREE_LARGE(ptr, size) OBD_FREE(ptr,size)
 651 #endif
 652
 653 #ifdef CONFIG_DEBUG_SLAB
 654 #define POISON(ptr, c, s) do {} while (0)
 655 #define POISON_PTR(ptr)  ((void)0)
 656 #else
 657 #define POISON(ptr, c, s) memset(ptr, c, s)
 658 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
 659 #endif
 660
 661 #ifdef POISON_BULK
 662 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 663                                     kunmap(page); } while (0)
 664 #else
 665 #define POISON_PAGE(page, val) do { } while (0)
 666 #endif
 667
 668 #ifdef __KERNEL__
 669 #define OBD_FREE(ptr, size)                                                   \
 670 do {                                                                          \
 671         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
 672         cfs_free(ptr);                                                        \
 673         POISON_PTR(ptr);                                                      \
 674 } while(0)
 675
 676
 677 #ifdef HAVE_RCU
 678 # ifdef HAVE_CALL_RCU_PARAM
 679 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 680 # else
 681 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 682 # endif
 683 #else
 684 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 685 #endif
 686
 687 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 688 do {                                                                          \
 689         struct portals_handle *__h = (handle);                                \
 690         LASSERT(handle);                                                      \
 691         __h->h_ptr = (ptr);                                                   \
 692         __h->h_size = (size);                                                 \
 693         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 694         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 695         POISON_PTR(ptr);                                                      \
 696 } while(0)
 697 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 698
 699 #else
 700 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 701 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 702 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 703 #endif /* ifdef __KERNEL__ */
 704
 705 #ifdef __arch_um__
 706 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 707 #else
 708 # define OBD_VFREE(ptr, size)                                                 \
 709 do {                                                                          \
 710         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
 711         cfs_free_large(ptr);                                                  \
 712         POISON_PTR(ptr);                                                      \
 713 } while(0)
 714 #endif
 715
 716 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 717  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 718  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 719 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
 720 ({                                                                            \
 721         cfs_mem_cache_free((slab), (ptr));                                    \
 722         (ptr) = NULL;                                                         \
 723         0;                                                                    \
 724 })
 725 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 726 do {                                                                          \
 727         LASSERT(ergo(type != CFS_ALLOC_ATOMIC, !cfs_in_interrupt()));         \
 728         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 729         if (likely((ptr) != NULL &&                                           \
 730                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 731                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
 732                                     __FILE__, __LINE__) ||                    \
 733                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
 734                 memset(ptr, 0, size);                                         \
 735                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
 736         }                                                                     \
 737 } while(0)
 738
 739 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 740
 741 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 742 do {                                                                          \
 743         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
 744         cfs_mem_cache_free(slab, ptr);                                        \
 745         POISON_PTR(ptr);                                                      \
 746 } while(0)
 747
 748 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 749         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 750 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 751         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 752 #define OBD_SLAB_ALLOC_PTR_GFP(ptr, slab, gfp)                              \
 753         OBD_SLAB_ALLOC((ptr), (slab), (gfp), sizeof *(ptr))
 754
 755 #define KEY_IS(str) \
 756         (keylen >= (sizeof(str)-1) && memcmp(key, str, (sizeof(str)-1)) == 0)
 757
 758 /* Wrapper for contiguous page frame allocation */
 759 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
 760 do {                                                                          \
 761         (ptr) = cfs_alloc_page(gfp_mask);                                     \
 762         if (unlikely((ptr) == NULL)) {                                        \
 763                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
 764                        "failed\n", (int)1,                                    \
 765                        (__u64)(1 << CFS_PAGE_SHIFT));                         \
 766                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
 767                        "("LPU64" bytes) allocated by Lustre, "                \
 768                        "%d total bytes by LNET\n",                            \
 769                        obd_memory_sum(),                                      \
 770                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
 771                        obd_pages_sum(),                                       \
 772                        cfs_atomic_read(&libcfs_kmemory));                     \
 773         } else {                                                              \
 774                 obd_pages_add(0);                                             \
 775                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
 776                        LPU64" bytes at %p.\n",                                \
 777                        (int)1,                                                \
 778                        (__u64)(1 << CFS_PAGE_SHIFT), ptr);                    \
 779         }                                                                     \
 780 } while (0)
 781
 782 #define OBD_PAGE_FREE(ptr)                                                    \
 783 do {                                                                          \
 784         LASSERT(ptr);                                                         \
 785         obd_pages_sub(0);                                                     \
 786         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
 787                "at %p.\n",                                                    \
 788                (int)1, (__u64)(1 << CFS_PAGE_SHIFT),                          \
 789                ptr);                                                          \
 790         cfs_free_page(ptr);                                                   \
 791         (ptr) = (void *)0xdeadbeef;                                           \
 792 } while (0)
 793
 794 #endif