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