lustre/include/obd_support.h

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