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