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