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  *  Copyright (C) 2001, 2002 Cluster File Systems, Inc.
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  */
  22
  23 #ifndef _OBD_SUPPORT
  24 #define _OBD_SUPPORT
  25
  26 #include <libcfs/kp30.h>
  27 #include <lvfs.h>
  28 #include <lprocfs_status.h>
  29
  30 /* global variables */
  31 extern struct lprocfs_stats *obd_memory;
  32 enum {
  33         OBD_MEMORY_STAT = 0,
  34         OBD_MEMORY_PAGES_STAT = 1,
  35         OBD_STATS_NUM,
  36 };
  37
  38 extern unsigned int obd_fail_loc;
  39 extern unsigned int obd_fail_val;
  40 extern unsigned int obd_debug_peer_on_timeout;
  41 extern unsigned int obd_dump_on_timeout;
  42 extern unsigned int obd_dump_on_eviction;
  43 /* obd_timeout should only be used for recovery, not for
  44    networking / disk / timings affected by load (use Adaptive Timeouts) */
  45 extern unsigned int obd_timeout;          /* seconds */
  46 extern unsigned int ldlm_timeout;         /* seconds */
  47 extern unsigned int obd_sync_filter;
  48 extern unsigned int obd_max_dirty_pages;
  49 extern atomic_t obd_dirty_pages;
  50 extern cfs_waitq_t obd_race_waitq;
  51 extern int obd_race_state;
  52 extern unsigned int obd_alloc_fail_rate;
  53
  54 /* Timeout definitions */
  55 #define OBD_TIMEOUT_DEFAULT 100
  56 #define LDLM_TIMEOUT_DEFAULT 20
  57 /* Time to wait for all clients to reconnect during recovery */
  58 /* Should be very conservative; must catch the first reconnect after reboot */
  59 #define OBD_RECOVERY_FACTOR (5 / 2) /* times obd_timeout */
  60 /* Change recovery-small 26b time if you change this */
  61 #define PING_INTERVAL max(obd_timeout / 4, 1U)
  62 /* Client may skip 1 ping; wait for 2.5 */
  63 #define PING_EVICT_TIMEOUT (PING_INTERVAL * 5 / 2)
  64 #define DISK_TIMEOUT 50          /* Beyond this we warn about disk speed */
  65 #define CONNECTION_SWITCH_MIN 5U /* Connection switching rate limiter */
  66  /* Max connect interval for nonresponsive servers; ~50s to avoid building up
  67     connect requests in the LND queues, but within obd_timeout so we don't
  68     miss the recovery window */
  69 #define CONNECTION_SWITCH_MAX min(50U, max(CONNECTION_SWITCH_MIN,obd_timeout))
  70 #define CONNECTION_SWITCH_INC 5  /* Connection timeout backoff */
  71 #ifndef CRAY_XT3
  72 /* In general this should be low to have quick detection of a system
  73    running on a backup server. (If it's too low, import_select_connection
  74    will increase the timeout anyhow.)  */
  75 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/20)
  76 #else
  77 /* ...but for very large systems (e.g. CRAY) we need to keep the initial
  78    connect t.o. high (bz 10803), because they will nearly ALWAYS be doing the
  79    connects for the first time (clients "reboot" after every process, so no
  80    chance to generate adaptive timeout data. */
  81 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/2)
  82 #endif
  83 #define LONG_UNLINK 300          /* Unlink should happen before now */
  84
  85
  86 #define OBD_FAIL_MDS                     0x100
  87 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
  88 #define OBD_FAIL_MDS_GETATTR_NET         0x102
  89 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
  90 #define OBD_FAIL_MDS_READPAGE_NET        0x104
  91 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
  92 #define OBD_FAIL_MDS_SENDPAGE            0x106
  93 #define OBD_FAIL_MDS_REINT_NET           0x107
  94 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
  95 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
  96 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
  97 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
  98 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
  99 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
 100 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
 101 #define OBD_FAIL_MDS_REINT_LINK          0x10f
 102 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
 103 #define OBD_FAIL_MDS_REINT_RENAME        0x111
 104 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
 105 #define OBD_FAIL_MDS_OPEN_NET            0x113
 106 #define OBD_FAIL_MDS_OPEN_PACK           0x114
 107 #define OBD_FAIL_MDS_CLOSE_NET           0x115
 108 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
 109 #define OBD_FAIL_MDS_CONNECT_NET         0x117
 110 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
 111 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
 112 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
 113 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
 114 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
 115 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
 116 #define OBD_FAIL_MDS_STATFS_NET          0x11e
 117 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
 118 #define OBD_FAIL_MDS_PIN_NET             0x120
 119 #define OBD_FAIL_MDS_UNPIN_NET           0x121
 120 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
 121 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
 122 #define OBD_FAIL_MDS_SYNC_NET            0x124
 123 #define OBD_FAIL_MDS_SYNC_PACK           0x125
 124 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
 125 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
 126 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
 127 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
 128 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
 129 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
 130 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
 131 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
 132 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
 133 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
 134 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
 135 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
 136 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
 137 #define OBD_FAIL_MDS_SETXATTR            0x133
 138 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
 139 #define OBD_FAIL_MDS_FS_SETUP            0x135
 140 #define OBD_FAIL_MDS_RESEND              0x136
 141 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x137
 142 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
 143 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
 144 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
 145 #define OBD_FAIL_MDS_CLOSE_NET_REP       0x13b
 146
 147 #define OBD_FAIL_OST                     0x200
 148 #define OBD_FAIL_OST_CONNECT_NET         0x201
 149 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 150 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 151 #define OBD_FAIL_OST_CREATE_NET          0x204
 152 #define OBD_FAIL_OST_DESTROY_NET         0x205
 153 #define OBD_FAIL_OST_GETATTR_NET         0x206
 154 #define OBD_FAIL_OST_SETATTR_NET         0x207
 155 #define OBD_FAIL_OST_OPEN_NET            0x208
 156 #define OBD_FAIL_OST_CLOSE_NET           0x209
 157 #define OBD_FAIL_OST_BRW_NET             0x20a
 158 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 159 #define OBD_FAIL_OST_STATFS_NET          0x20c
 160 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 161 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 162 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 163 #define OBD_FAIL_OST_SYNC_NET            0x210
 164 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 165 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
 166 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 167 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 168 #define OBD_FAIL_OST_ENOSPC              0x215
 169 #define OBD_FAIL_OST_EROFS               0x216
 170 #define OBD_FAIL_OST_ENOENT              0x217
 171 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 172 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 173 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 174 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 175 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 176 #define OBD_FAIL_OST_DROP_REQ            0x21d
 177 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 178 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 179 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
 180 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 181 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 182 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
 183 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
 184
 185 #define OBD_FAIL_LDLM                    0x300
 186 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 187 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 188 #define OBD_FAIL_LDLM_CONVERT            0x303
 189 #define OBD_FAIL_LDLM_CANCEL             0x304
 190 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 191 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 192 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 193 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 194 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 195 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 196 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 197 #define OBD_FAIL_LDLM_REPLY              0x30c
 198 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 199 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 200 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 201 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 202 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 203 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
 204 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
 205
 206 #define OBD_FAIL_OSC                     0x400
 207 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 208 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 209 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 210 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 211 #define OBD_FAIL_OSC_MATCH               0x405
 212 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
 213 #define OBD_FAIL_OSC_SHUTDOWN            0x407
 214 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
 215 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
 216 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
 217
 218 #define OBD_FAIL_PTLRPC                  0x500
 219 #define OBD_FAIL_PTLRPC_ACK              0x501
 220 #define OBD_FAIL_PTLRPC_RQBD             0x502
 221 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 222 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 223 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 224 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 225 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 226 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
 227 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
 228 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
 229
 230 #define OBD_FAIL_OBD_PING_NET            0x600
 231 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 232 #define OBD_FAIL_OBD_LOGD_NET            0x602
 233 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 234 #define OBD_FAIL_OBD_DQACQ               0x604
 235
 236 #define OBD_FAIL_TGT_REPLY_NET           0x700
 237 #define OBD_FAIL_TGT_CONN_RACE           0x701
 238 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 239 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 240 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 241 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 242
 243 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 244 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 245 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
 246
 247 #define OBD_FAIL_MGS                     0x900
 248 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 249 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 250 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
 251 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
 252 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
 253
 254 #define OBD_FAIL_QUOTA_QD_COUNT_32BIT    0xA00
 255
 256 #define OBD_FAIL_LPROC_REMOVE            0xB00
 257
 258 #define OBD_FAIL_GENERAL_ALLOC           0xC00
 259
 260 /* Failure injection control */
 261 #define OBD_FAIL_MASK_SYS    0x0000FF00
 262 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
 263 #define OBD_FAIL_ONCE        0x80000000
 264 #define OBD_FAILED           0x40000000
 265 /* The following flags aren't made to be combined */
 266 #define OBD_FAIL_SKIP        0x20000000 /* skip N then fail */
 267 #define OBD_FAIL_SOME        0x10000000 /* fail N times */
 268 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the time */
 269 #define OBD_FAIL_USR1        0x04000000 /* user flag */
 270
 271 static inline int obd_fail_check(__u32 id)
 272 {
 273         static int count = 0;
 274         if (likely((obd_fail_loc & OBD_FAIL_MASK_LOC) !=
 275                    (id & OBD_FAIL_MASK_LOC)))
 276                 return 0;
 277
 278         if ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE)) ==
 279             (OBD_FAILED | OBD_FAIL_ONCE)) {
 280                 count = 0; /* paranoia */
 281                 return 0;
 282         }
 283
 284         if (obd_fail_loc & OBD_FAIL_RAND) {
 285                 unsigned int ll_rand(void);
 286                 if (obd_fail_val < 2)
 287                         return 0;
 288                 if (ll_rand() % obd_fail_val > 0)
 289                         return 0;
 290         }
 291
 292         if (obd_fail_loc & OBD_FAIL_SKIP) {
 293                 count++;
 294                 if (count < obd_fail_val)
 295                         return 0;
 296                 count = 0;
 297         }
 298
 299         /* Overridden by FAIL_ONCE */
 300         if (obd_fail_loc & OBD_FAIL_SOME) {
 301                 count++;
 302                 if (count >= obd_fail_val) {
 303                         count = 0;
 304                         /* Don't fail anymore */
 305                         obd_fail_loc |= OBD_FAIL_ONCE;
 306                 }
 307         }
 308
 309         obd_fail_loc |= OBD_FAILED;
 310         /* Handle old checks that OR in this */
 311         if (id & OBD_FAIL_ONCE)
 312                 obd_fail_loc |= OBD_FAIL_ONCE;
 313
 314         return 1;
 315 }
 316
 317 #define OBD_FAIL_CHECK(id)                                                   \
 318 ({                                                                           \
 319         int _ret_ = 0;                                                       \
 320         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 321                 CERROR("*** obd_fail_loc=%x ***\n", id);                     \
 322         }                                                                    \
 323         _ret_;                                                               \
 324 })
 325
 326 #define OBD_FAIL_CHECK_QUIET(id)                                             \
 327         (unlikely(obd_fail_loc) ? obd_fail_check(id) : 0)
 328
 329 /* deprecated - just use OBD_FAIL_CHECK */
 330 #define OBD_FAIL_CHECK_ONCE OBD_FAIL_CHECK
 331
 332 #define OBD_FAIL_RETURN(id, ret)                                             \
 333 do {                                                                         \
 334         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 335                 CERROR("*** obd_fail_return=%x rc=%d ***\n", id, ret);       \
 336                 RETURN(ret);                                                 \
 337         }                                                                    \
 338 } while(0)
 339
 340 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 341 ({      int _ret_ = 0;                                                       \
 342         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 343                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
 344                        (id), (secs));                                        \
 345                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 346                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 347                                     cfs_time_seconds(secs));                 \
 348                 set_current_state(TASK_RUNNING);                             \
 349                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 350         }                                                                    \
 351         _ret_;                                                               \
 352 })
 353
 354 #define OBD_FAIL_TIMEOUT_MS(id, ms)                                          \
 355 ({      int _ret_ = 0;                                                       \
 356         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 357                 CERROR("obd_fail_timeout id %x sleeping for %d ms\n",        \
 358                        (id), (ms));                                          \
 359                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 360                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 361                                      cfs_time_seconds(ms)/1000);             \
 362                 set_current_state(TASK_RUNNING);                             \
 363                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 364         }                                                                    \
 365         _ret_;                                                               \
 366 })
 367
 368 #ifdef __KERNEL__
 369 /* The idea here is to synchronise two threads to force a race. The
 370  * first thread that calls this with a matching fail_loc is put to
 371  * sleep. The next thread that calls with the same fail_loc wakes up
 372  * the first and continues. */
 373 #define OBD_RACE(id)                                                         \
 374 do {                                                                         \
 375         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 376                 obd_race_state = 0;                                          \
 377                 CERROR("obd_race id %x sleeping\n", (id));                   \
 378                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
 379                 CERROR("obd_fail_race id %x awake\n", (id));                 \
 380         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
 381                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
 382                 CERROR("obd_fail_race id %x waking\n", (id));                \
 383                 obd_race_state = 1;                                          \
 384                 wake_up(&obd_race_waitq);                                    \
 385         }                                                                    \
 386 } while(0)
 387 #else
 388 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 389 #define OBD_RACE(foo) do {} while(0)
 390 #endif
 391
 392 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 393
 394 extern atomic_t libcfs_kmemory;
 395
 396 #ifdef RANDOM_FAIL_ALLOC
 397 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK_QUIET(OBD_FAIL_GENERAL_ALLOC)
 398 #else
 399 #define HAS_FAIL_ALLOC_FLAG 0
 400 #endif
 401
 402 #define OBD_ALLOC_FAIL_BITS 24
 403 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
 404 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
 405
 406 #ifdef LPROCFS
 407 #define obd_memory_add(size)                                                  \
 408         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
 409 #define obd_memory_sub(size)                                                  \
 410         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
 411 #define obd_memory_sum()                                                      \
 412         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
 413                                 LPROCFS_FIELDS_FLAGS_SUM)
 414 #define obd_pages_add(order)                                                  \
 415         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 416                             (long)(1 << (order)))
 417 #define obd_pages_sub(order)                                                  \
 418         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 419                             (long)(1 << (order)))
 420 #define obd_pages_sum()                                                       \
 421         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
 422                                 LPROCFS_FIELDS_FLAGS_SUM)
 423
 424 extern void obd_update_maxusage(void);
 425 extern __u64 obd_memory_max(void);
 426 extern __u64 obd_pages_max(void);
 427
 428 #else
 429
 430 extern __u64 obd_alloc;
 431 extern __u64 obd_pages;
 432
 433 extern __u64 obd_max_alloc;
 434 extern __u64 obd_max_pages;
 435
 436 static inline void obd_memory_add(long size)
 437 {
 438         obd_alloc += size;
 439         if (obd_alloc > obd_max_alloc)
 440                 obd_max_alloc = obd_alloc;
 441 }
 442
 443 static inline void obd_memory_sub(long size)
 444 {
 445         obd_alloc -= size;
 446 }
 447
 448 static inline void obd_pages_add(int order)
 449 {
 450         obd_pages += 1<< order;
 451         if (obd_pages > obd_max_pages)
 452                 obd_max_pages = obd_pages;
 453 }
 454
 455 static inline void obd_pages_sub(int order)
 456 {
 457         obd_pages -= 1<< order;
 458 }
 459
 460 #define obd_memory_sum() (obd_alloc)
 461 #define obd_pages_sum()  (obd_pages)
 462
 463 #define obd_memory_max() (obd_max_alloc)
 464 #define obd_pages_max() (obd_max_pages)
 465
 466 #endif
 467
 468 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 469 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 470 do {                                                                          \
 471         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 472         if (unlikely((ptr) == NULL)) {                                        \
 473                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed\n",           \
 474                        (int)(size));                                          \
 475         } else {                                                              \
 476                 memset(ptr, 0, size);                                         \
 477                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 478                        (int)(size), ptr);                                     \
 479         }                                                                     \
 480 } while (0)
 481 #else /* this version is for the kernel and liblustre */
 482 #define OBD_FREE_RTN0(ptr)                                                    \
 483 ({                                                                            \
 484         cfs_free(ptr);                                                        \
 485         (ptr) = NULL;                                                         \
 486         0;                                                                    \
 487 })
 488 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 489 do {                                                                          \
 490         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 491         if (likely((ptr) != NULL &&                                           \
 492                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 493                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
 494                                     __FILE__, __LINE__) ||                    \
 495                     OBD_FREE_RTN0(ptr)))){                                    \
 496                 memset(ptr, 0, size);                                         \
 497                 obd_memory_add(size);                                         \
 498                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p.\n",         \
 499                        (int)(size), ptr);                                     \
 500         }                                                                     \
 501 } while (0)
 502 #endif
 503
 504 #ifndef OBD_ALLOC_MASK
 505 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 506 #endif
 507
 508 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 509 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 510 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 511 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 512
 513 #ifdef __arch_um__
 514 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 515 #else
 516 # define OBD_VMALLOC(ptr, size)                                               \
 517 do {                                                                          \
 518         (ptr) = cfs_alloc_large(size);                                        \
 519         if (unlikely((ptr) == NULL)) {                                        \
 520                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
 521                        (int)(size));                                          \
 522                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
 523                        obd_memory_sum(), atomic_read(&libcfs_kmemory));      \
 524         } else {                                                              \
 525                 memset(ptr, 0, size);                                         \
 526                 obd_memory_add(size);                                         \
 527                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p.\n",         \
 528                        (int)(size), ptr);                                     \
 529         }                                                                     \
 530 } while (0)
 531 #endif
 532
 533 #ifdef CONFIG_DEBUG_SLAB
 534 #define POISON(ptr, c, s) do {} while (0)
 535 #else
 536 #define POISON(ptr, c, s) memset(ptr, c, s)
 537 #endif
 538
 539 #ifdef POISON_BULK
 540 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 541                                     kunmap(page); } while (0)
 542 #else
 543 #define POISON_PAGE(page, val) do { } while (0)
 544 #endif
 545
 546 #ifdef __KERNEL__
 547 #define OBD_FREE(ptr, size)                                                   \
 548 do {                                                                          \
 549         LASSERT(ptr);                                                         \
 550         obd_memory_sub(size);                                                 \
 551         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p.\n",                    \
 552                (int)(size), ptr);                                             \
 553         POISON(ptr, 0x5a, size);                                              \
 554         cfs_free(ptr);                                                        \
 555         (ptr) = (void *)0xdeadbeef;                                           \
 556 } while (0)
 557
 558 #ifdef HAVE_RCU
 559 # ifdef HAVE_CALL_RCU_PARAM
 560 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 561 # else
 562 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 563 # endif
 564 #else
 565 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 566 #endif
 567
 568 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 569 do {                                                                          \
 570         struct portals_handle *__h = (handle);                                \
 571         LASSERT(handle);                                                      \
 572         __h->h_ptr = (ptr);                                                   \
 573         __h->h_size = (size);                                                 \
 574         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 575         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 576         (ptr) = (void *)0xdeadbeef;                                           \
 577 } while(0)
 578 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 579 #else
 580 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 581 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 582 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 583 #endif
 584
 585 #ifdef __arch_um__
 586 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 587 #else
 588 # define OBD_VFREE(ptr, size)                                                 \
 589 do {                                                                          \
 590         LASSERT(ptr);                                                         \
 591         obd_memory_sub(size);                                                 \
 592         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p.\n",                    \
 593                (int)(size), ptr);                                             \
 594         POISON(ptr, 0x5a, size);                                              \
 595         cfs_free_large(ptr);                                                  \
 596         (ptr) = (void *)0xdeadbeef;                                           \
 597 } while (0)
 598 #endif
 599
 600 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 601  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 602  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 603 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
 604 ({                                                                            \
 605         cfs_mem_cache_free((slab), (ptr));                                    \
 606         (ptr) = NULL;                                                         \
 607         0;                                                                    \
 608 })
 609 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 610 do {                                                                          \
 611         LASSERT(!in_interrupt());                                             \
 612         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 613         if (likely((ptr) != NULL &&                                           \
 614                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 615                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
 616                                     __FILE__, __LINE__) ||                    \
 617                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
 618                 memset(ptr, 0, size);                                         \
 619                 obd_memory_add(size);                                         \
 620                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p.\n",        \
 621                        (int)(size), ptr);                                     \
 622         }                                                                     \
 623 } while (0)
 624
 625 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 626
 627 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 628 do {                                                                          \
 629         LASSERT(ptr);                                                         \
 630         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p.\n",                \
 631                (int)(size), ptr);                                             \
 632         obd_memory_sub(size);                                                 \
 633         POISON(ptr, 0x5a, size);                                              \
 634         cfs_mem_cache_free(slab, ptr);                                        \
 635         (ptr) = (void *)0xdeadbeef;                                           \
 636 } while (0)
 637
 638 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 639         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 640 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 641         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 642
 643 #define KEY_IS(str) (keylen >= strlen(str) && strcmp(key, str) == 0)
 644
 645 /* Wrapper for contiguous page frame allocation */
 646 #define OBD_PAGES_ALLOC(ptr, order, gfp_mask)                                 \
 647 do {                                                                          \
 648         (ptr) = cfs_alloc_pages(gfp_mask, order);                             \
 649         if (unlikely((ptr) == NULL)) {                                        \
 650                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
 651                        "failed\n", (int)(1 << (order)),                       \
 652                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT));            \
 653                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
 654                        "("LPU64" bytes) allocated by Lustre, "                \
 655                        "%d total bytes by LNET\n",                            \
 656                        obd_memory_sum(),                                      \
 657                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
 658                        obd_pages_sum(),                                       \
 659                        atomic_read(&libcfs_kmemory));                         \
 660         } else {                                                              \
 661                 obd_pages_add(order);                                         \
 662                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
 663                        LPU64" bytes at %p.\n",                                \
 664                        (int)(1 << (order)),                                   \
 665                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT), ptr);       \
 666         }                                                                     \
 667 } while (0)
 668
 669 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
 670         OBD_PAGES_ALLOC(ptr, 0, gfp_mask)
 671
 672 #define OBD_PAGES_FREE(ptr, order)                                            \
 673 do {                                                                          \
 674         LASSERT(ptr);                                                         \
 675         obd_pages_sub(order);                                                 \
 676         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
 677                "at %p.\n",                                                    \
 678                (int)(1 << (order)), (__u64)((1 << (order)) << CFS_PAGE_SHIFT),\
 679                ptr);                                                          \
 680         __cfs_free_pages(ptr, order);                                         \
 681         (ptr) = (void *)0xdeadbeef;                                           \
 682 } while (0)
 683
 684 #define OBD_PAGE_FREE(ptr) OBD_PAGES_FREE(ptr, 0)
 685
 686 #if defined(__linux__)
 687 #include <linux/obd_support.h>
 688 #elif defined(__APPLE__)
 689 #include <darwin/obd_support.h>
 690 #elif defined(__WINNT__)
 691 #include <winnt/obd_support.h>
 692 #else
 693 #error Unsupported operating system.
 694 #endif
 695
 696 #endif