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 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
 106 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
 107 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
 108
 109 #define OBD_FAIL_OST                     0x200
 110 #define OBD_FAIL_OST_CONNECT_NET         0x201
 111 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 112 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 113 #define OBD_FAIL_OST_CREATE_NET          0x204
 114 #define OBD_FAIL_OST_DESTROY_NET         0x205
 115 #define OBD_FAIL_OST_GETATTR_NET         0x206
 116 #define OBD_FAIL_OST_SETATTR_NET         0x207
 117 #define OBD_FAIL_OST_OPEN_NET            0x208
 118 #define OBD_FAIL_OST_CLOSE_NET           0x209
 119 #define OBD_FAIL_OST_BRW_NET             0x20a
 120 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 121 #define OBD_FAIL_OST_STATFS_NET          0x20c
 122 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 123 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 124 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 125 #define OBD_FAIL_OST_SYNC_NET            0x210
 126 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 127 #define OBD_FAIL_OST_ALL_REQUESTS_NET    0x212
 128 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 129 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 130 #define OBD_FAIL_OST_ENOSPC              0x215
 131 #define OBD_FAIL_OST_EROFS               0x216
 132 #define OBD_FAIL_OST_ENOENT              0x217
 133 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 134 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 135 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 136 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 137 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 138 #define OBD_FAIL_OST_DROP_REQ            0x21d
 139 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 140 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 141 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
 142 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 143 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 144
 145 #define OBD_FAIL_LDLM                    0x300
 146 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 147 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 148 #define OBD_FAIL_LDLM_CONVERT            0x303
 149 #define OBD_FAIL_LDLM_CANCEL             0x304
 150 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 151 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 152 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 153 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 154 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 155 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 156 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 157 #define OBD_FAIL_LDLM_REPLY              0x30c
 158 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 159 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 160 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 161 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 162 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 163
 164 #define OBD_FAIL_OSC                     0x400
 165 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 166 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 167 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 168 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 169 #define OBD_FAIL_OSC_MATCH               0x405
 170 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
 171 #define OBD_FAIL_OSC_SHUTDOWN            0x407
 172 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
 173 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
 174 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
 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 /* Failure injection control */
 215 #define OBD_FAIL_MASK_SYS    0x0000FF00
 216 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
 217 #define OBD_FAIL_ONCE        0x80000000
 218 #define OBD_FAILED           0x40000000
 219 /* The following flags aren't made to be combined */
 220 #define OBD_FAIL_SKIP        0x20000000 /* skip N then fail */
 221 #define OBD_FAIL_SOME        0x10000000 /* fail N times */
 222 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the time */
 223 #define OBD_FAIL_USR1        0x04000000 /* user flag */
 224
 225 static inline int obd_fail_check(__u32 id)
 226 {
 227         static int count = 0;
 228         if (likely((obd_fail_loc & OBD_FAIL_MASK_LOC) !=
 229                    (id & OBD_FAIL_MASK_LOC)))
 230                 return 0;
 231
 232         if ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE)) ==
 233             (OBD_FAILED | OBD_FAIL_ONCE)) {
 234                 count = 0; /* paranoia */
 235                 return 0;
 236         }
 237
 238         if (obd_fail_loc & OBD_FAIL_RAND) {
 239                 unsigned int ll_rand(void);
 240                 if (obd_fail_val < 2)
 241                         return 0;
 242                 if (ll_rand() % obd_fail_val > 0)
 243                         return 0;
 244         }
 245
 246         if (obd_fail_loc & OBD_FAIL_SKIP) {
 247                 count++;
 248                 if (count < obd_fail_val)
 249                         return 0;
 250                 count = 0;
 251         }
 252
 253         /* Overridden by FAIL_ONCE */
 254         if (obd_fail_loc & OBD_FAIL_SOME) {
 255                 count++;
 256                 if (count >= obd_fail_val) {
 257                         count = 0;
 258                         /* Don't fail anymore */
 259                         obd_fail_loc |= OBD_FAIL_ONCE;
 260                 }
 261         }
 262
 263         obd_fail_loc |= OBD_FAILED;
 264         /* Handle old checks that OR in this */
 265         if (id & OBD_FAIL_ONCE)
 266                 obd_fail_loc |= OBD_FAIL_ONCE;
 267
 268         return 1;
 269 }
 270
 271 #define OBD_FAIL_CHECK(id)                                                   \
 272 ({                                                                           \
 273         int _ret_ = 0;                                                       \
 274         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 275                 CERROR("*** obd_fail_loc=%x ***\n", id);                     \
 276         }                                                                    \
 277         _ret_;                                                               \
 278 })
 279
 280 /* deprecated - just use OBD_FAIL_CHECK */
 281 #define OBD_FAIL_CHECK_ONCE OBD_FAIL_CHECK
 282
 283 #define OBD_FAIL_RETURN(id, ret)                                             \
 284 do {                                                                         \
 285         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 286                 CERROR("*** obd_fail_return=%x rc=%d ***\n", id, ret);       \
 287                 RETURN(ret);                                                 \
 288         }                                                                    \
 289 } while(0)
 290
 291 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 292 ({      int _ret_ = 0;                                                       \
 293         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 294                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
 295                        (id), (secs));                                        \
 296                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 297                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 298                                     cfs_time_seconds(secs));                 \
 299                 set_current_state(TASK_RUNNING);                             \
 300                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 301         }                                                                    \
 302         _ret_;                                                               \
 303 })
 304
 305 #define OBD_FAIL_TIMEOUT_MS(id, ms)                                          \
 306 ({      int _ret_ = 0;                                                       \
 307         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 308                 CERROR("obd_fail_timeout id %x sleeping for %d ms\n",        \
 309                        (id), (ms));                                          \
 310                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 311                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 312                                      cfs_time_seconds(ms)/1000);             \
 313                 set_current_state(TASK_RUNNING);                             \
 314                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 315         }                                                                    \
 316         _ret_;                                                               \
 317 })
 318
 319 #ifdef __KERNEL__
 320 /* The idea here is to synchronise two threads to force a race. The
 321  * first thread that calls this with a matching fail_loc is put to
 322  * sleep. The next thread that calls with the same fail_loc wakes up
 323  * the first and continues. */
 324 #define OBD_RACE(id)                                                         \
 325 do {                                                                         \
 326         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 327                 obd_race_state = 0;                                          \
 328                 CERROR("obd_race id %x sleeping\n", (id));                   \
 329                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
 330                 CERROR("obd_fail_race id %x awake\n", (id));                 \
 331         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
 332                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
 333                 CERROR("obd_fail_race id %x waking\n", (id));                \
 334                 obd_race_state = 1;                                          \
 335                 wake_up(&obd_race_waitq);                                    \
 336         }                                                                    \
 337 } while(0)
 338 #else
 339 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 340 #define OBD_RACE(foo) do {} while(0)
 341 #endif
 342
 343 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 344
 345 extern atomic_t libcfs_kmemory;
 346
 347 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 348 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 349 do {                                                                          \
 350         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 351         if ((ptr) == NULL) {                                                  \
 352                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 353                        (int)(size), __FILE__, __LINE__);                      \
 354         } else {                                                              \
 355                 memset(ptr, 0, size);                                         \
 356                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 357                        (int)(size), ptr);                                     \
 358         }                                                                     \
 359 } while (0)
 360 #else /* this version is for the kernel and liblustre */
 361 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 362 do {                                                                          \
 363         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 364         if ((ptr) == NULL) {                                                  \
 365                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 366                        (int)(size), __FILE__, __LINE__);                      \
 367                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 368                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 369         } else {                                                              \
 370                 memset(ptr, 0, size);                                         \
 371                 atomic_add(size, &obd_memory);                                \
 372                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 373                         obd_memmax = atomic_read(&obd_memory);                \
 374                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d)\n", \
 375                        (int)(size), ptr, atomic_read(&obd_memory));           \
 376         }                                                                     \
 377 } while (0)
 378 #endif
 379
 380 #ifndef OBD_ALLOC_MASK
 381 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 382 #endif
 383
 384 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 385 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 386 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 387 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 388
 389 #ifdef __arch_um__
 390 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 391 #else
 392 # define OBD_VMALLOC(ptr, size)                                               \
 393 do {                                                                          \
 394         (ptr) = cfs_alloc_large(size);                                        \
 395         if ((ptr) == NULL) {                                                  \
 396                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 397                        (int)(size), __FILE__, __LINE__);                      \
 398                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 399                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 400         } else {                                                              \
 401                 memset(ptr, 0, size);                                         \
 402                 atomic_add(size, &obd_memory);                                \
 403                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 404                         obd_memmax = atomic_read(&obd_memory);                \
 405                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p (tot %d)\n", \
 406                        (int)(size), ptr, atomic_read(&obd_memory));           \
 407         }                                                                     \
 408 } while (0)
 409 #endif
 410
 411 #ifdef CONFIG_DEBUG_SLAB
 412 #define POISON(ptr, c, s) do {} while (0)
 413 #else
 414 #define POISON(ptr, c, s) memset(ptr, c, s)
 415 #endif
 416
 417 #ifdef POISON_BULK
 418 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 419                                     kunmap(page); } while (0)
 420 #else
 421 #define POISON_PAGE(page, val) do { } while (0)
 422 #endif
 423
 424 #ifdef __KERNEL__
 425 #define OBD_FREE(ptr, size)                                                   \
 426 do {                                                                          \
 427         LASSERT(ptr);                                                         \
 428         atomic_sub(size, &obd_memory);                                        \
 429         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",           \
 430                (int)(size), ptr, atomic_read(&obd_memory));                   \
 431         POISON(ptr, 0x5a, size);                                              \
 432         cfs_free(ptr);                                                        \
 433         (ptr) = (void *)0xdeadbeef;                                           \
 434 } while (0)
 435
 436 #ifdef HAVE_RCU
 437 # ifdef HAVE_CALL_RCU_PARAM
 438 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 439 # else
 440 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 441 # endif
 442 #else
 443 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 444 #endif
 445
 446 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 447 do {                                                                          \
 448         struct portals_handle *__h = (handle);                                \
 449         LASSERT(handle);                                                      \
 450         __h->h_ptr = (ptr);                                                   \
 451         __h->h_size = (size);                                                 \
 452         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 453         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 454         (ptr) = (void *)0xdeadbeef;                                           \
 455 } while(0)
 456 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 457 #else
 458 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 459 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 460 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 461 #endif
 462
 463 #ifdef __arch_um__
 464 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 465 #else
 466 # define OBD_VFREE(ptr, size)                                                 \
 467 do {                                                                          \
 468         LASSERT(ptr);                                                         \
 469         atomic_sub(size, &obd_memory);                                        \
 470         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p (tot %d).\n",           \
 471                (int)(size), ptr, atomic_read(&obd_memory));                   \
 472         POISON(ptr, 0x5a, size);                                              \
 473         cfs_free_large(ptr);                                                  \
 474         (ptr) = (void *)0xdeadbeef;                                           \
 475 } while (0)
 476 #endif
 477
 478 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 479  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 480  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 481 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 482 do {                                                                          \
 483         LASSERT(!in_interrupt());                                             \
 484         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 485         if ((ptr) == NULL) {                                                  \
 486                 CERROR("slab-alloc of '"#ptr"' (%d bytes) failed at %s:%d\n", \
 487                        (int)(size), __FILE__, __LINE__);                      \
 488                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 489                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 490         } else {                                                              \
 491                 memset(ptr, 0, size);                                         \
 492                 atomic_add(size, &obd_memory);                                \
 493                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 494                         obd_memmax = atomic_read(&obd_memory);                \
 495                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p (tot %d)\n",\
 496                        (int)(size), ptr, atomic_read(&obd_memory));           \
 497         }                                                                     \
 498 } while (0)
 499
 500 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 501
 502 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 503 do {                                                                          \
 504         LASSERT(ptr);                                                         \
 505         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p (tot %d).\n",       \
 506                (int)(size), ptr, atomic_read(&obd_memory));                   \
 507         atomic_sub(size, &obd_memory);                                        \
 508         POISON(ptr, 0x5a, size);                                              \
 509         cfs_mem_cache_free(slab, ptr);                                        \
 510         (ptr) = (void *)0xdeadbeef;                                           \
 511 } while (0)
 512
 513 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 514         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 515 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 516         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 517
 518 #define KEY_IS(str) (keylen >= strlen(key) && strcmp(key, str) == 0)
 519
 520 #if defined(__linux__)
 521 #include <linux/obd_support.h>
 522 #elif defined(__APPLE__)
 523 #include <darwin/obd_support.h>
 524 #elif defined(__WINNT__)
 525 #include <winnt/obd_support.h>
 526 #else
 527 #error Unsupported operating system.
 528 #endif
 529
 530 #endif