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