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