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