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
  29 /* global variables */
  30 extern atomic_t obd_memory;
  31 extern int obd_memmax;
  32 extern unsigned int obd_fail_loc;
  33 extern unsigned int obd_fail_val;
  34 extern unsigned int obd_debug_peer_on_timeout;
  35 extern unsigned int obd_dump_on_timeout;
  36 extern unsigned int obd_dump_on_eviction;
  37 extern unsigned int obd_timeout;          /* seconds */
  38 #define PING_INTERVAL max(obd_timeout / 4, 1U)
  39 #define RECONNECT_INTERVAL max(obd_timeout / 10, 10U)
  40 #define LDLM_TIMEOUT_DEFAULT 20
  41 extern unsigned int ldlm_timeout;
  42 extern unsigned int obd_health_check_timeout;
  43 extern unsigned int obd_sync_filter;
  44 extern unsigned int obd_max_dirty_pages;
  45 extern atomic_t obd_dirty_pages;
  46 extern cfs_waitq_t obd_race_waitq;
  47 extern int obd_race_state;
  48 extern unsigned int obd_alloc_fail_rate;
  49
  50
  51 #define OBD_FAIL_MDS                     0x100
  52 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
  53 #define OBD_FAIL_MDS_GETATTR_NET         0x102
  54 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
  55 #define OBD_FAIL_MDS_READPAGE_NET        0x104
  56 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
  57 #define OBD_FAIL_MDS_SENDPAGE            0x106
  58 #define OBD_FAIL_MDS_REINT_NET           0x107
  59 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
  60 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
  61 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
  62 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
  63 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
  64 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
  65 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
  66 #define OBD_FAIL_MDS_REINT_LINK          0x10f
  67 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
  68 #define OBD_FAIL_MDS_REINT_RENAME        0x111
  69 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
  70 #define OBD_FAIL_MDS_OPEN_NET            0x113
  71 #define OBD_FAIL_MDS_OPEN_PACK           0x114
  72 #define OBD_FAIL_MDS_CLOSE_NET           0x115
  73 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
  74 #define OBD_FAIL_MDS_CONNECT_NET         0x117
  75 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
  76 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
  77 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
  78 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
  79 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
  80 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
  81 #define OBD_FAIL_MDS_STATFS_NET          0x11e
  82 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
  83 #define OBD_FAIL_MDS_PIN_NET             0x120
  84 #define OBD_FAIL_MDS_UNPIN_NET           0x121
  85 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
  86 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
  87 #define OBD_FAIL_MDS_SYNC_NET            0x124
  88 #define OBD_FAIL_MDS_SYNC_PACK           0x125
  89 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
  90 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
  91 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
  92 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
  93 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
  94 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
  95 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
  96 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
  97 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
  98 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
  99 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
 100 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
 101 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
 102 #define OBD_FAIL_MDS_SETXATTR            0x133
 103 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
 104 #define OBD_FAIL_MDS_FS_SETUP            0x135
 105 #define OBD_FAIL_MDS_RESEND              0x136
 106 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x137
 107 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
 108 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
 109 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
 110
 111 #define OBD_FAIL_OST                     0x200
 112 #define OBD_FAIL_OST_CONNECT_NET         0x201
 113 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 114 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 115 #define OBD_FAIL_OST_CREATE_NET          0x204
 116 #define OBD_FAIL_OST_DESTROY_NET         0x205
 117 #define OBD_FAIL_OST_GETATTR_NET         0x206
 118 #define OBD_FAIL_OST_SETATTR_NET         0x207
 119 #define OBD_FAIL_OST_OPEN_NET            0x208
 120 #define OBD_FAIL_OST_CLOSE_NET           0x209
 121 #define OBD_FAIL_OST_BRW_NET             0x20a
 122 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 123 #define OBD_FAIL_OST_STATFS_NET          0x20c
 124 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 125 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 126 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 127 #define OBD_FAIL_OST_SYNC_NET            0x210
 128 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 129 #define OBD_FAIL_OST_ALL_REQUESTS_NET    0x212
 130 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 131 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 132 #define OBD_FAIL_OST_ENOSPC              0x215
 133 #define OBD_FAIL_OST_EROFS               0x216
 134 #define OBD_FAIL_OST_ENOENT              0x217
 135 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 136 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 137 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 138 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 139 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 140 #define OBD_FAIL_OST_DROP_REQ            0x21d
 141 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 142 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 143 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 144 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 145
 146 #define OBD_FAIL_LDLM                    0x300
 147 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 148 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 149 #define OBD_FAIL_LDLM_CONVERT            0x303
 150 #define OBD_FAIL_LDLM_CANCEL             0x304
 151 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 152 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 153 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 154 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 155 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 156 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 157 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 158 #define OBD_FAIL_LDLM_REPLY              0x30c
 159 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 160 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 161 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 162 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 163 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 164
 165 #define OBD_FAIL_OSC                     0x400
 166 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 167 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 168 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 169 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 170 #define OBD_FAIL_OSC_MATCH               0x405
 171 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
 172 #define OBD_FAIL_OSC_SHUTDOWN            0x407
 173 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
 174 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
 175
 176 #define OBD_FAIL_PTLRPC                  0x500
 177 #define OBD_FAIL_PTLRPC_ACK              0x501
 178 #define OBD_FAIL_PTLRPC_RQBD             0x502
 179 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 180 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 181 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 182 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 183 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 184 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
 185
 186 #define OBD_FAIL_OBD_PING_NET            0x600
 187 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 188 #define OBD_FAIL_OBD_LOGD_NET            0x602
 189 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 190 #define OBD_FAIL_OBD_DQACQ               0x604
 191
 192 #define OBD_FAIL_TGT_REPLY_NET           0x700
 193 #define OBD_FAIL_TGT_CONN_RACE           0x701
 194 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 195 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 196 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 197 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 198
 199 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 200 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 201 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
 202
 203 #define OBD_FAIL_MGS                     0x900
 204 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 205 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 206 #define OBD_FAIL_MGC_PROCESS_LOG         0x903
 207 #define OBD_FAIL_MGS_SLOW_REQUEST_NET    0x904
 208 #define OBD_FAIL_MGS_SLOW_TARGET_REG     0x905
 209
 210 #define OBD_FAIL_QUOTA_QD_COUNT_32BIT    0xA00
 211
 212 #define OBD_FAIL_LPROC_REMOVE            0xB00
 213
 214 #define OBD_FAIL_GENERAL_ALLOC           0xC00
 215
 216 /* Failure injection control */
 217 #define OBD_FAIL_MASK_SYS    0x0000FF00
 218 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
 219 #define OBD_FAIL_ONCE        0x80000000
 220 #define OBD_FAILED           0x40000000
 221 /* The following flags aren't made to be combined */
 222 #define OBD_FAIL_SKIP        0x20000000 /* skip N then fail */
 223 #define OBD_FAIL_SOME        0x10000000 /* fail N times */
 224 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the time */
 225 #define OBD_FAIL_USR1        0x04000000 /* user flag */
 226
 227 static inline int obd_fail_check(__u32 id)
 228 {
 229         static int count = 0;
 230         if (likely((obd_fail_loc & OBD_FAIL_MASK_LOC) !=
 231                    (id & OBD_FAIL_MASK_LOC)))
 232                 return 0;
 233
 234         if ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE)) ==
 235             (OBD_FAILED | OBD_FAIL_ONCE)) {
 236                 count = 0; /* paranoia */
 237                 return 0;
 238         }
 239
 240         if (obd_fail_loc & OBD_FAIL_RAND) {
 241                 unsigned int ll_rand(void);
 242                 if (obd_fail_val < 2)
 243                         return 0;
 244                 if (ll_rand() % obd_fail_val > 0)
 245                         return 0;
 246         }
 247
 248         if (obd_fail_loc & OBD_FAIL_SKIP) {
 249                 count++;
 250                 if (count < obd_fail_val)
 251                         return 0;
 252                 count = 0;
 253         }
 254
 255         /* Overridden by FAIL_ONCE */
 256         if (obd_fail_loc & OBD_FAIL_SOME) {
 257                 count++;
 258                 if (count >= obd_fail_val) {
 259                         count = 0;
 260                         /* Don't fail anymore */
 261                         obd_fail_loc |= OBD_FAIL_ONCE;
 262                 }
 263         }
 264
 265         obd_fail_loc |= OBD_FAILED;
 266         /* Handle old checks that OR in this */
 267         if (id & OBD_FAIL_ONCE)
 268                 obd_fail_loc |= OBD_FAIL_ONCE;
 269
 270         return 1;
 271 }
 272
 273 #define OBD_FAIL_CHECK(id)                                                   \
 274 ({                                                                           \
 275         int _ret_ = 0;                                                       \
 276         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 277                 CERROR("*** obd_fail_loc=%x ***\n", id);                     \
 278         }                                                                    \
 279         _ret_;                                                               \
 280 })
 281
 282 /* deprecated - just use OBD_FAIL_CHECK */
 283 #define OBD_FAIL_CHECK_ONCE OBD_FAIL_CHECK
 284
 285 #define OBD_FAIL_RETURN(id, ret)                                             \
 286 do {                                                                         \
 287         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 288                 CERROR("*** obd_fail_return=%x rc=%d ***\n", id, ret);       \
 289                 RETURN(ret);                                                 \
 290         }                                                                    \
 291 } while(0)
 292
 293 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 294 ({      int _ret_ = 0;                                                       \
 295         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 296                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
 297                        (id), (secs));                                        \
 298                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 299                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 300                                     cfs_time_seconds(secs));                 \
 301                 set_current_state(TASK_RUNNING);                             \
 302                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 303         }                                                                    \
 304         _ret_;                                                               \
 305 })
 306
 307 #define OBD_FAIL_TIMEOUT_MS(id, ms)                                          \
 308 ({      int _ret_ = 0;                                                       \
 309         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 310                 CERROR("obd_fail_timeout id %x sleeping for %d ms\n",        \
 311                        (id), (ms));                                          \
 312                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 313                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 314                                      cfs_time_seconds(ms)/1000);             \
 315                 set_current_state(TASK_RUNNING);                             \
 316                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 317         }                                                                    \
 318         _ret_;                                                               \
 319 })
 320
 321 #ifdef __KERNEL__
 322 /* The idea here is to synchronise two threads to force a race. The
 323  * first thread that calls this with a matching fail_loc is put to
 324  * sleep. The next thread that calls with the same fail_loc wakes up
 325  * the first and continues. */
 326 #define OBD_RACE(id)                                                         \
 327 do {                                                                         \
 328         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 329                 obd_race_state = 0;                                          \
 330                 CERROR("obd_race id %x sleeping\n", (id));                   \
 331                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
 332                 CERROR("obd_fail_race id %x awake\n", (id));                 \
 333         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
 334                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
 335                 CERROR("obd_fail_race id %x waking\n", (id));                \
 336                 obd_race_state = 1;                                          \
 337                 wake_up(&obd_race_waitq);                                    \
 338         }                                                                    \
 339 } while(0)
 340 #else
 341 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 342 #define OBD_RACE(foo) do {} while(0)
 343 #endif
 344
 345 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 346
 347 extern atomic_t libcfs_kmemory;
 348
 349 #ifdef RANDOM_FAIL_ALLOC
 350 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK(OBD_FAIL_GENERAL_ALLOC)
 351 #else
 352 #define HAS_FAIL_ALLOC_FLAG 0
 353 #endif
 354
 355 #define OBD_ALLOC_FAIL_BITS 24
 356 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
 357 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
 358
 359 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 360 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 361 do {                                                                          \
 362         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 363         if ((ptr) == NULL) {                                                  \
 364                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 365                        (int)(size), __FILE__, __LINE__);                      \
 366         } else {                                                              \
 367                 memset(ptr, 0, size);                                         \
 368                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 369                        (int)(size), ptr);                                     \
 370         }                                                                     \
 371 } while (0)
 372 #else /* this version is for the kernel and liblustre */
 373 #define OBD_FREE_RTN0(ptr)                                                    \
 374 ({                                                                            \
 375         cfs_free(ptr);                                                        \
 376         (ptr) = NULL;                                                         \
 377         0;                                                                    \
 378 })
 379 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 380 do {                                                                          \
 381         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 382         if (likely((ptr) != NULL &&                                           \
 383                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 384                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
 385                                     __FILE__, __LINE__) ||                    \
 386                     OBD_FREE_RTN0(ptr)))){                                    \
 387                 memset(ptr, 0, size);                                         \
 388                 atomic_add(size, &obd_memory);                                \
 389                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 390                         obd_memmax = atomic_read(&obd_memory);                \
 391                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d)\n", \
 392                        (int)(size), ptr, atomic_read(&obd_memory));           \
 393         }                                                                     \
 394 } while (0)
 395 #endif
 396
 397 #ifndef OBD_ALLOC_MASK
 398 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 399 #endif
 400
 401 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 402 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 403 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 404 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 405
 406 #ifdef __arch_um__
 407 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 408 #else
 409 # define OBD_VMALLOC(ptr, size)                                               \
 410 do {                                                                          \
 411         (ptr) = cfs_alloc_large(size);                                        \
 412         if ((ptr) == NULL) {                                                  \
 413                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 414                        (int)(size), __FILE__, __LINE__);                      \
 415                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 416                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 417         } else {                                                              \
 418                 memset(ptr, 0, size);                                         \
 419                 atomic_add(size, &obd_memory);                                \
 420                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 421                         obd_memmax = atomic_read(&obd_memory);                \
 422                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p (tot %d)\n", \
 423                        (int)(size), ptr, atomic_read(&obd_memory));           \
 424         }                                                                     \
 425 } while (0)
 426 #endif
 427
 428 #ifdef CONFIG_DEBUG_SLAB
 429 #define POISON(ptr, c, s) do {} while (0)
 430 #else
 431 #define POISON(ptr, c, s) memset(ptr, c, s)
 432 #endif
 433
 434 #ifdef POISON_BULK
 435 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 436                                     kunmap(page); } while (0)
 437 #else
 438 #define POISON_PAGE(page, val) do { } while (0)
 439 #endif
 440
 441 #ifdef __KERNEL__
 442 #define OBD_FREE(ptr, size)                                                   \
 443 do {                                                                          \
 444         LASSERT(ptr);                                                         \
 445         atomic_sub(size, &obd_memory);                                        \
 446         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",           \
 447                (int)(size), ptr, atomic_read(&obd_memory));                   \
 448         POISON(ptr, 0x5a, size);                                              \
 449         cfs_free(ptr);                                                        \
 450         (ptr) = (void *)0xdeadbeef;                                           \
 451 } while (0)
 452
 453 #ifdef HAVE_RCU
 454 # ifdef HAVE_CALL_RCU_PARAM
 455 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 456 # else
 457 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 458 # endif
 459 #else
 460 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 461 #endif
 462
 463 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 464 do {                                                                          \
 465         struct portals_handle *__h = (handle);                                \
 466         LASSERT(handle);                                                      \
 467         __h->h_ptr = (ptr);                                                   \
 468         __h->h_size = (size);                                                 \
 469         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 470         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 471         (ptr) = (void *)0xdeadbeef;                                           \
 472 } while(0)
 473 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 474 #else
 475 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 476 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 477 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 478 #endif
 479
 480 #ifdef __arch_um__
 481 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 482 #else
 483 # define OBD_VFREE(ptr, size)                                                 \
 484 do {                                                                          \
 485         LASSERT(ptr);                                                         \
 486         atomic_sub(size, &obd_memory);                                        \
 487         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p (tot %d).\n",           \
 488                (int)(size), ptr, atomic_read(&obd_memory));                   \
 489         POISON(ptr, 0x5a, size);                                              \
 490         cfs_free_large(ptr);                                                  \
 491         (ptr) = (void *)0xdeadbeef;                                           \
 492 } while (0)
 493 #endif
 494
 495 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 496  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 497  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 498 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
 499 ({                                                                            \
 500         cfs_mem_cache_free((slab), (ptr));                                    \
 501         (ptr) = NULL;                                                         \
 502         0;                                                                    \
 503 })
 504 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 505 do {                                                                          \
 506         LASSERT(!in_interrupt());                                             \
 507         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 508         if (likely((ptr) != NULL &&                                           \
 509                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 510                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
 511                                     __FILE__, __LINE__) ||                    \
 512                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
 513                 memset(ptr, 0, size);                                         \
 514                 atomic_add(size, &obd_memory);                                \
 515                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 516                         obd_memmax = atomic_read(&obd_memory);                \
 517                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p (tot %d)\n",\
 518                        (int)(size), ptr, atomic_read(&obd_memory));           \
 519         }                                                                     \
 520 } while (0)
 521
 522 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 523
 524 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 525 do {                                                                          \
 526         LASSERT(ptr);                                                         \
 527         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p (tot %d).\n",       \
 528                (int)(size), ptr, atomic_read(&obd_memory));                   \
 529         atomic_sub(size, &obd_memory);                                        \
 530         POISON(ptr, 0x5a, size);                                              \
 531         cfs_mem_cache_free(slab, ptr);                                        \
 532         (ptr) = (void *)0xdeadbeef;                                           \
 533 } while (0)
 534
 535 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 536         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 537 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 538         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 539
 540 #define KEY_IS(str) (keylen >= strlen(key) && strcmp(key, str) == 0)
 541
 542 #if defined(__linux__)
 543 #include <linux/obd_support.h>
 544 #elif defined(__APPLE__)
 545 #include <darwin/obd_support.h>
 546 #elif defined(__WINNT__)
 547 #include <winnt/obd_support.h>
 548 #else
 549 #error Unsupported operating system.
 550 #endif
 551
 552 #endif