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