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