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