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