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_debug_peer_on_timeout;
  33 extern unsigned int obd_dump_on_timeout;
  34 extern unsigned int obd_dump_on_eviction;
  35 extern unsigned int obd_timeout;          /* seconds */
  36 #define PING_INTERVAL max(obd_timeout / 4, 1U)
  37 #define RECONNECT_INTERVAL max(obd_timeout / 10, 10U)
  38 #define LDLM_TIMEOUT_DEFAULT 20
  39 extern unsigned int ldlm_timeout;
  40 extern unsigned int obd_health_check_timeout;
  41 extern unsigned int obd_sync_filter;
  42 extern unsigned int obd_max_dirty_pages;
  43 extern atomic_t obd_dirty_pages;
  44 extern cfs_waitq_t obd_race_waitq;
  45 extern int obd_race_state;
  46
  47 #define OBD_FAIL_MDS                     0x100
  48 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
  49 #define OBD_FAIL_MDS_GETATTR_NET         0x102
  50 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
  51 #define OBD_FAIL_MDS_READPAGE_NET        0x104
  52 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
  53 #define OBD_FAIL_MDS_SENDPAGE            0x106
  54 #define OBD_FAIL_MDS_REINT_NET           0x107
  55 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
  56 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
  57 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
  58 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
  59 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
  60 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
  61 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
  62 #define OBD_FAIL_MDS_REINT_LINK          0x10f
  63 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
  64 #define OBD_FAIL_MDS_REINT_RENAME        0x111
  65 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
  66 #define OBD_FAIL_MDS_OPEN_NET            0x113
  67 #define OBD_FAIL_MDS_OPEN_PACK           0x114
  68 #define OBD_FAIL_MDS_CLOSE_NET           0x115
  69 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
  70 #define OBD_FAIL_MDS_CONNECT_NET         0x117
  71 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
  72 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
  73 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
  74 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
  75 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
  76 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
  77 #define OBD_FAIL_MDS_STATFS_NET          0x11e
  78 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
  79 #define OBD_FAIL_MDS_PIN_NET             0x120
  80 #define OBD_FAIL_MDS_UNPIN_NET           0x121
  81 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
  82 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
  83 #define OBD_FAIL_MDS_SYNC_NET            0x124
  84 #define OBD_FAIL_MDS_SYNC_PACK           0x125
  85 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
  86 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
  87 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
  88 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
  89 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
  90 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
  91 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
  92 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
  93 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
  94 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
  95 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
  96 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
  97 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
  98 #define OBD_FAIL_MDS_SETXATTR            0x133
  99 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
 100 #define OBD_FAIL_MDS_FS_SETUP            0x135
 101 #define OBD_FAIL_MDS_RESEND              0x136
 102 #define OBD_FAIL_MDS_IS_SUBDIR_NET       0x137
 103 #define OBD_FAIL_MDS_IS_SUBDIR_PACK      0x138
 104 #define OBD_FAIL_MDS_SET_INFO_NET        0x139
 105 #define OBD_FAIL_MDS_WRITEPAGE_NET       0x13a
 106 #define OBD_FAIL_MDS_WRITEPAGE_PACK      0x13b
 107 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x13c
 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
 142 #define OBD_FAIL_LDLM                    0x300
 143 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 144 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 145 #define OBD_FAIL_LDLM_CONVERT            0x303
 146 #define OBD_FAIL_LDLM_CANCEL             0x304
 147 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 148 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 149 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 150 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 151 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 152 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 153 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 154 #define OBD_FAIL_LDLM_REPLY              0x30c
 155 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 156 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 157 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 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
 170 #define OBD_FAIL_PTLRPC                  0x500
 171 #define OBD_FAIL_PTLRPC_ACK              0x501
 172 #define OBD_FAIL_PTLRPC_RQBD             0x502
 173 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 174 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 175 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 176 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 177 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 178
 179 #define OBD_FAIL_OBD_PING_NET            0x600
 180 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 181 #define OBD_FAIL_OBD_LOGD_NET            0x602
 182 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 183 #define OBD_FAIL_OBD_DQACQ               0x604
 184
 185 #define OBD_FAIL_TGT_REPLY_NET           0x700
 186 #define OBD_FAIL_TGT_CONN_RACE           0x701
 187 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 188 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 189 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 190 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 191
 192 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 193 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 194
 195 #define OBD_FAIL_MGS                     0x900
 196 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 197 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 198 #define OBD_FAIL_MGC_PROCESS_LOG         0x903
 199 #define OBD_FAIL_MGS_SLOW_REQUEST_NET    0x904
 200 #define OBD_FAIL_MGS_SLOW_TARGET_REG     0x905
 201
 202 #define OBD_FAIL_QUOTA_QD_COUNT_32BIT    0xa00
 203
 204 #define OBD_FAIL_LPROC_REMOVE            0xb00
 205
 206 #define OBD_FAIL_SEQ                     0x1000
 207 #define OBD_FAIL_SEQ_QUERY_NET           0x1001
 208
 209 #define OBD_FAIL_FLD                     0x1100
 210 #define OBD_FAIL_FLD_QUERY_NET           0x1101
 211
 212 #define OBD_FAIL_SEC_CTX                 0x1200
 213 #define OBD_FAIL_SEC_CTX_INIT_NET        0x1201
 214 #define OBD_FAIL_SEC_CTX_INIT_CONT_NET   0x1202
 215 #define OBD_FAIL_SEC_CTX_FINI_NET        0x1203
 216
 217 /* preparation for a more advanced failure testbed (not functional yet) */
 218 #define OBD_FAIL_MASK_SYS    0x0000FF00
 219 #define OBD_FAIL_MASK_LOC    (0x000000FF | OBD_FAIL_MASK_SYS)
 220 #define OBD_FAIL_ONCE        0x80000000
 221 #define OBD_FAILED           0x40000000
 222
 223 #define OBD_FAIL_CHECK(id)   (((obd_fail_loc & OBD_FAIL_MASK_LOC) ==           \
 224                               ((id) & OBD_FAIL_MASK_LOC)) &&                   \
 225                               ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE))!= \
 226                                 (OBD_FAILED | OBD_FAIL_ONCE)))
 227
 228 #define OBD_FAIL_CHECK_ONCE(id)                                              \
 229 ({      int _ret_ = 0;                                                       \
 230         if (unlikely(OBD_FAIL_CHECK(id))) {                                  \
 231                 CERROR("*** obd_fail_loc=0x%x ***\n", id);                   \
 232                 obd_fail_loc |= OBD_FAILED;                                  \
 233                 if ((id) & OBD_FAIL_ONCE)                                    \
 234                         obd_fail_loc |= OBD_FAIL_ONCE;                       \
 235                 _ret_ = 1;                                                   \
 236         }                                                                    \
 237         _ret_;                                                               \
 238 })
 239
 240 #define OBD_FAIL_RETURN(id, ret)                                             \
 241 do {                                                                         \
 242         if (unlikely(OBD_FAIL_CHECK_ONCE(id))) {                             \
 243                 RETURN(ret);                                                 \
 244         }                                                                    \
 245 } while(0)
 246
 247 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 248 do {                                                                         \
 249         if (unlikely(OBD_FAIL_CHECK_ONCE(id))) {                             \
 250                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
 251                        (id), (secs));                                        \
 252                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 253                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 254                                     cfs_time_seconds(secs));                 \
 255                 set_current_state(TASK_RUNNING);                             \
 256                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 257        }                                                                     \
 258 } while(0)
 259
 260 #ifdef __KERNEL__
 261 /* The idea here is to synchronise two threads to force a race. The
 262  * first thread that calls this with a matching fail_loc is put to
 263  * sleep. The next thread that calls with the same fail_loc wakes up
 264  * the first and continues. */
 265 #define OBD_RACE(id)                                                         \
 266 do {                                                                         \
 267         if (unlikely(OBD_FAIL_CHECK_ONCE(id))) {                             \
 268                 obd_race_state = 0;                                          \
 269                 CERROR("obd_race id %x sleeping\n", (id));                   \
 270                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
 271                 CERROR("obd_fail_race id %x awake\n", (id));                 \
 272         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
 273                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
 274                 CERROR("obd_fail_race id %x waking\n", (id));                \
 275                 obd_race_state = 1;                                          \
 276                 wake_up(&obd_race_waitq);                                    \
 277         }                                                                    \
 278 } while(0)
 279 #else
 280 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 281 #define OBD_RACE(foo) do {} while(0)
 282 #endif
 283
 284 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 285
 286 extern atomic_t libcfs_kmemory;
 287
 288 #if defined (CONFIG_DEBUG_MEMORY) && defined(__KERNEL__)
 289
 290 #define OBD_MT_WRONG_SIZE    (1 << 0)
 291 #define OBD_MT_ALREADY_FREED (1 << 1)
 292 #define OBD_MT_LOC_LEN       128
 293
 294 struct obd_mem_track {
 295         struct hlist_node mt_hash;
 296         char              mt_loc[OBD_MT_LOC_LEN];
 297         int               mt_flags;
 298         void             *mt_ptr;
 299         int               mt_size;
 300 };
 301
 302 void lvfs_memdbg_show(void);
 303 void lvfs_memdbg_insert(struct obd_mem_track *mt);
 304 void lvfs_memdbg_remove(struct obd_mem_track *mt);
 305 struct obd_mem_track *lvfs_memdbg_find(void *ptr);
 306
 307 int lvfs_memdbg_check_insert(struct obd_mem_track *mt);
 308 struct obd_mem_track *lvfs_memdbg_check_remove(void *ptr);
 309
 310 static inline struct obd_mem_track *
 311 __new_mem_track(void *ptr, int size,
 312                 char *file, int line)
 313 {
 314         struct obd_mem_track *mt;
 315
 316         mt = kmalloc(sizeof(*mt), GFP_KERNEL);
 317         if (unlikely(!mt))
 318                 return NULL;
 319
 320         snprintf(mt->mt_loc, sizeof(mt->mt_loc) - 1,
 321                  "%s:%d", file, line);
 322
 323         mt->mt_size = size;
 324         mt->mt_ptr = ptr;
 325         mt->mt_flags = 0;
 326         return mt;
 327 }
 328
 329 static inline void
 330 __free_mem_track(struct obd_mem_track *mt)
 331 {
 332         kfree(mt);
 333 }
 334
 335 static inline int
 336 __get_mem_track(void *ptr, int size,
 337                 char *file, int line)
 338 {
 339         struct obd_mem_track *mt;
 340
 341         mt = __new_mem_track(ptr, size, file, line);
 342         if (unlikely(!mt)) {
 343                 CWARN("Can't allocate new memory track\n");
 344                 return 0;
 345         }
 346
 347         if (!lvfs_memdbg_check_insert(mt))
 348                 __free_mem_track(mt);
 349
 350         return 1;
 351 }
 352
 353 static inline int
 354 __put_mem_track(void *ptr, int size,
 355                 char *file, int line)
 356 {
 357         struct obd_mem_track *mt;
 358
 359         if (unlikely(!(mt = lvfs_memdbg_check_remove(ptr)))) {
 360                 CWARN("Ptr 0x%p is not allocated. Attempt to free "
 361                       "not allocated memory at %s:%d\n", ptr,
 362                       file, line);
 363                 LBUG();
 364                 return 0;
 365         } else {
 366                 if (unlikely(mt->mt_size != size)) {
 367                         if (!(mt->mt_flags & OBD_MT_ALREADY_FREED)) {
 368                                 mt->mt_flags |= (OBD_MT_WRONG_SIZE |
 369                                                  OBD_MT_ALREADY_FREED);
 370
 371                                 CWARN("Freeing memory chunk (at 0x%p) of "
 372                                       "different size than allocated "
 373                                       "(%d != %d) at %s:%d, allocated at %s\n",
 374                                       ptr, mt->mt_size, size, file, line,
 375                                       mt->mt_loc);
 376                         }
 377                 } else {
 378                         __free_mem_track(mt);
 379                 }
 380                 return 1;
 381         }
 382 }
 383
 384 #define get_mem_track(ptr, size, file, line)                                         \
 385         __get_mem_track((ptr), (size), (file), (line))
 386
 387 #define put_mem_track(ptr, size, file, line)                                         \
 388         __put_mem_track((ptr), (size), (file), (line))
 389
 390 #else /* !CONFIG_DEBUG_MEMORY */
 391
 392 #define get_mem_track(ptr, size, file, line)                                         \
 393         do {} while (0)
 394
 395 #define put_mem_track(ptr, size, file, line)                                         \
 396         do {} while (0)
 397 #endif /* !CONFIG_DEBUG_MEMORY */
 398
 399 #define OBD_DEBUG_MEMUSAGE (1)
 400
 401 #if OBD_DEBUG_MEMUSAGE
 402 #define OBD_ALLOC_POST(ptr, size, name)                                 \
 403                 atomic_add(size, &obd_memory);                          \
 404                 if (atomic_read(&obd_memory) > obd_memmax)              \
 405                         obd_memmax = atomic_read(&obd_memory);          \
 406                 get_mem_track((ptr), (size), __FILE__, __LINE__);       \
 407                 CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p (tot %d)\n", \
 408                        (int)(size), ptr, atomic_read(&obd_memory))
 409
 410 #define OBD_FREE_PRE(ptr, size, name)                                   \
 411         LASSERT(ptr);                                                   \
 412         put_mem_track((ptr), (size), __FILE__, __LINE__);               \
 413         atomic_sub(size, &obd_memory);                                  \
 414         CDEBUG(D_MALLOC, name " '" #ptr "': %d at %p (tot %d).\n",      \
 415                (int)(size), ptr, atomic_read(&obd_memory));             \
 416         POISON(ptr, 0x5a, size)
 417
 418 #else /* !OBD_DEBUG_MEMUSAGE */
 419
 420 #define OBD_ALLOC_POST(ptr, size, name) ((void)0)
 421 #define OBD_FREE_PRE(ptr, size, name)   ((void)0)
 422
 423 #endif /* !OBD_DEBUG_MEMUSAGE */
 424
 425 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 426 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 427 do {                                                                          \
 428         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 429         if (unlikely((ptr) == NULL)) {                                        \
 430                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 431                        (int)(size), __FILE__, __LINE__);                      \
 432         } else {                                                              \
 433                 memset(ptr, 0, size);                                         \
 434                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 435                        (int)(size), ptr);                                     \
 436         }                                                                     \
 437 } while (0)
 438 #else /* this version is for the kernel and liblustre */
 439 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 440 do {                                                                          \
 441         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 442         if (unlikely((ptr) == NULL)) {                                        \
 443                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 444                        (int)(size), __FILE__, __LINE__);                      \
 445                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 446                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 447         } else {                                                              \
 448                 memset(ptr, 0, size);                                         \
 449                 OBD_ALLOC_POST(ptr, size, "kmalloced");                       \
 450         }                                                                     \
 451 } while (0)
 452 #endif
 453
 454 #ifndef OBD_ALLOC_MASK
 455 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 456 #endif
 457
 458 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 459 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 460 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 461 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 462
 463 #ifdef __arch_um__
 464 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 465 #else
 466 # define OBD_VMALLOC(ptr, size)                                               \
 467 do {                                                                          \
 468         (ptr) = cfs_alloc_large(size);                                        \
 469         if (unlikely((ptr) == NULL)) {                                        \
 470                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 471                        (int)(size), __FILE__, __LINE__);                      \
 472                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 473                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 474         } else {                                                              \
 475                 memset(ptr, 0, size);                                         \
 476                 OBD_ALLOC_POST(ptr, size, "vmalloced");                       \
 477         }                                                                     \
 478 } while(0)
 479 #endif
 480
 481 #ifdef CONFIG_DEBUG_SLAB
 482 #define POISON(ptr, c, s) do {} while (0)
 483 #define POISON_PTR(ptr)  ((void)0)
 484 #else
 485 #define POISON(ptr, c, s) memset(ptr, c, s)
 486 #define POISON_PTR(ptr)  (ptr) = (void *)0xdeadbeef
 487 #endif
 488
 489 #ifdef POISON_BULK
 490 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 491                                     kunmap(page); } while (0)
 492 #else
 493 #define POISON_PAGE(page, val) do { } while (0)
 494 #endif
 495
 496 #ifdef __KERNEL__
 497 #define OBD_FREE(ptr, size)                                                   \
 498 do {                                                                          \
 499         OBD_FREE_PRE(ptr, size, "kfreed");                                    \
 500         cfs_free(ptr);                                                        \
 501         POISON_PTR(ptr);                                                      \
 502 } while(0)
 503
 504
 505 #ifdef HAVE_RCU
 506 # ifdef HAVE_CALL_RCU_PARAM
 507 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 508 # else
 509 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 510 # endif
 511 #else
 512 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 513 #endif
 514
 515 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 516 do {                                                                          \
 517         struct portals_handle *__h = (handle);                                \
 518         LASSERT(handle);                                                      \
 519         __h->h_ptr = (ptr);                                                   \
 520         __h->h_size = (size);                                                 \
 521         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 522         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 523         POISON_PTR(ptr);                                                      \
 524 } while(0)
 525 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 526
 527 #else
 528 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 529 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 530 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 531 #endif /* ifdef __KERNEL__ */
 532
 533 #ifdef __arch_um__
 534 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 535 #else
 536 # define OBD_VFREE(ptr, size)                                                 \
 537 do {                                                                          \
 538         OBD_FREE_PRE(ptr, size, "vfreed");                                    \
 539         cfs_free_large(ptr);                                                  \
 540         POISON_PTR(ptr);                                                      \
 541 } while(0)
 542 #endif
 543
 544 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 545  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 546  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 547 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 548 do {                                                                          \
 549         LASSERT(!in_interrupt());                                             \
 550         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 551         if (unlikely((ptr) == NULL)) {                                        \
 552                 CERROR("slab-alloc of '"#ptr"' (%d bytes) failed at %s:%d\n", \
 553                        (int)(size), __FILE__, __LINE__);                      \
 554                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 555                        atomic_read(&obd_memory), atomic_read(&libcfs_kmemory));\
 556         } else {                                                              \
 557                 memset(ptr, 0, size);                                         \
 558                 OBD_ALLOC_POST(ptr, size, "slab-alloced");                    \
 559         }                                                                     \
 560 } while(0)
 561
 562 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 563
 564 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 565 do {                                                                          \
 566         OBD_FREE_PRE(ptr, size, "slab-freed");                                \
 567         cfs_mem_cache_free(slab, ptr);                                        \
 568         POISON_PTR(ptr);                                                      \
 569 } while(0)
 570
 571 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 572         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 573 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 574         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 575
 576 #define KEY_IS(str) (keylen >= strlen(str) && strcmp(key, str) == 0)
 577
 578 #if defined(__linux__)
 579 #include <linux/obd_support.h>
 580 #elif defined(__APPLE__)
 581 #include <darwin/obd_support.h>
 582 #elif defined(__WINNT__)
 583 #include <winnt/obd_support.h>
 584 #else
 585 #error Unsupported operating system.
 586 #endif
 587
 588 #endif