lustre/include/obd_support.h

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