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 #include <lustre/lustre_idl.h>
  30
  31 /* global variables */
  32 extern struct lprocfs_stats *obd_memory;
  33 enum {
  34         OBD_MEMORY_STAT = 0,
  35         OBD_MEMORY_PAGES_STAT = 1,
  36         OBD_STATS_NUM,
  37 };
  38
  39 extern unsigned int obd_fail_loc;
  40 extern unsigned int obd_fail_val;
  41 extern unsigned int obd_debug_peer_on_timeout;
  42 extern unsigned int obd_dump_on_timeout;
  43 extern unsigned int obd_dump_on_eviction;
  44 /* obd_timeout should only be used for recovery, not for
  45    networking / disk / timings affected by load (use Adaptive Timeouts) */
  46 extern unsigned int obd_timeout;          /* seconds */
  47 extern unsigned int ldlm_timeout;         /* seconds */
  48 extern unsigned int obd_sync_filter;
  49 extern unsigned int obd_max_dirty_pages;
  50 extern atomic_t obd_dirty_pages;
  51 extern cfs_waitq_t obd_race_waitq;
  52 extern int obd_race_state;
  53 extern unsigned int obd_alloc_fail_rate;
  54
  55 /* Timeout definitions */
  56 #define OBD_TIMEOUT_DEFAULT 100
  57 #define LDLM_TIMEOUT_DEFAULT 20
  58 #ifdef CRAY_XT3
  59  #define OBD_RECOVERY_MAX_TIME (obd_timeout * 18) /* b13079 */
  60 #endif
  61 /* Time to wait for all clients to reconnect during recovery */
  62 /* Should be very conservative; must catch the first reconnect after reboot */
  63 #define OBD_RECOVERY_FACTOR (3) /* times obd_timeout */
  64 /* Change recovery-small 26b time if you change this */
  65 #define PING_INTERVAL max(obd_timeout / 4, 1U)
  66 /* Client may skip 1 ping; we must wait at least 2.5. But for multiple
  67  * failover targets the client only pings one server at a time, and pings
  68  * can be lost on a loaded network. Since eviction has serious consequences,
  69  * and there's no urgent need to evict a client just because it's idle, we
  70  * should be very conservative here. */
  71 #define PING_EVICT_TIMEOUT (PING_INTERVAL * 6)
  72 #define DISK_TIMEOUT 50          /* Beyond this we warn about disk speed */
  73 #define CONNECTION_SWITCH_MIN 5U /* Connection switching rate limiter */
  74  /* Max connect interval for nonresponsive servers; ~50s to avoid building up
  75     connect requests in the LND queues, but within obd_timeout so we don't
  76     miss the recovery window */
  77 #define CONNECTION_SWITCH_MAX min(50U, max(CONNECTION_SWITCH_MIN,obd_timeout))
  78 #define CONNECTION_SWITCH_INC 5  /* Connection timeout backoff */
  79 #ifndef CRAY_XT3
  80 /* In general this should be low to have quick detection of a system
  81    running on a backup server. (If it's too low, import_select_connection
  82    will increase the timeout anyhow.)  */
  83 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/20)
  84 #else
  85 /* ...but for very large systems (e.g. CRAY) we need to keep the initial
  86    connect t.o. high (bz 10803), because they will nearly ALWAYS be doing the
  87    connects for the first time (clients "reboot" after every process, so no
  88    chance to generate adaptive timeout data. */
  89 #define INITIAL_CONNECT_TIMEOUT max(CONNECTION_SWITCH_MIN,obd_timeout/2)
  90 #endif
  91 #define LONG_UNLINK 300          /* Unlink should happen before now */
  92
  93
  94 #define OBD_FAIL_MDS                     0x100
  95 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
  96 #define OBD_FAIL_MDS_GETATTR_NET         0x102
  97 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
  98 #define OBD_FAIL_MDS_READPAGE_NET        0x104
  99 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
 100 #define OBD_FAIL_MDS_SENDPAGE            0x106
 101 #define OBD_FAIL_MDS_REINT_NET           0x107
 102 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
 103 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
 104 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
 105 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
 106 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
 107 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
 108 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
 109 #define OBD_FAIL_MDS_REINT_LINK          0x10f
 110 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
 111 #define OBD_FAIL_MDS_REINT_RENAME        0x111
 112 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
 113 #define OBD_FAIL_MDS_OPEN_NET            0x113
 114 #define OBD_FAIL_MDS_OPEN_PACK           0x114
 115 #define OBD_FAIL_MDS_CLOSE_NET           0x115
 116 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
 117 #define OBD_FAIL_MDS_CONNECT_NET         0x117
 118 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
 119 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
 120 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
 121 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
 122 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
 123 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
 124 #define OBD_FAIL_MDS_STATFS_NET          0x11e
 125 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
 126 #define OBD_FAIL_MDS_PIN_NET             0x120
 127 #define OBD_FAIL_MDS_UNPIN_NET           0x121
 128 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
 129 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
 130 #define OBD_FAIL_MDS_SYNC_NET            0x124
 131 #define OBD_FAIL_MDS_SYNC_PACK           0x125
 132 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
 133 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
 134 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
 135 #define OBD_FAIL_MDS_PAUSE_OPEN          0x129
 136 #define OBD_FAIL_MDS_STATFS_LCW_SLEEP    0x12a
 137 #define OBD_FAIL_MDS_OPEN_CREATE         0x12b
 138 #define OBD_FAIL_MDS_OST_SETATTR         0x12c
 139 #define OBD_FAIL_MDS_QUOTACHECK_NET      0x12d
 140 #define OBD_FAIL_MDS_QUOTACTL_NET        0x12e
 141 #define OBD_FAIL_MDS_CLIENT_ADD          0x12f
 142 #define OBD_FAIL_MDS_GETXATTR_NET        0x130
 143 #define OBD_FAIL_MDS_GETXATTR_PACK       0x131
 144 #define OBD_FAIL_MDS_SETXATTR_NET        0x132
 145 #define OBD_FAIL_MDS_SETXATTR            0x133
 146 #define OBD_FAIL_MDS_SETXATTR_WRITE      0x134
 147 #define OBD_FAIL_MDS_FS_SETUP            0x135
 148 #define OBD_FAIL_MDS_RESEND              0x136
 149 #define OBD_FAIL_MDS_LLOG_CREATE_FAILED  0x137
 150 #define OBD_FAIL_MDS_LOV_SYNC_RACE       0x138
 151 #define OBD_FAIL_MDS_OSC_PRECREATE       0x139
 152 #define OBD_FAIL_MDS_LLOG_SYNC_TIMEOUT   0x13a
 153 #define OBD_FAIL_MDS_CLOSE_NET_REP       0x13b
 154 #define OBD_FAIL_MDS_BLOCK_QUOTA_REQ     0x13c
 155 #define OBD_FAIL_MDS_DROP_QUOTA_REQ      0x13d
 156
 157 #define OBD_FAIL_OST                     0x200
 158 #define OBD_FAIL_OST_CONNECT_NET         0x201
 159 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
 160 #define OBD_FAIL_OST_GET_INFO_NET        0x203
 161 #define OBD_FAIL_OST_CREATE_NET          0x204
 162 #define OBD_FAIL_OST_DESTROY_NET         0x205
 163 #define OBD_FAIL_OST_GETATTR_NET         0x206
 164 #define OBD_FAIL_OST_SETATTR_NET         0x207
 165 #define OBD_FAIL_OST_OPEN_NET            0x208
 166 #define OBD_FAIL_OST_CLOSE_NET           0x209
 167 #define OBD_FAIL_OST_BRW_NET             0x20a
 168 #define OBD_FAIL_OST_PUNCH_NET           0x20b
 169 #define OBD_FAIL_OST_STATFS_NET          0x20c
 170 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 171 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 172 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 173 #define OBD_FAIL_OST_SYNC_NET            0x210
 174 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 175 #define OBD_FAIL_OST_ALL_REQUEST_NET     0x212
 176 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 177 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 178 #define OBD_FAIL_OST_ENOSPC              0x215
 179 #define OBD_FAIL_OST_EROFS               0x216
 180 #define OBD_FAIL_OST_ENOENT              0x217
 181 #define OBD_FAIL_OST_QUOTACHECK_NET      0x218
 182 #define OBD_FAIL_OST_QUOTACTL_NET        0x219
 183 #define OBD_FAIL_OST_CHECKSUM_RECEIVE    0x21a
 184 #define OBD_FAIL_OST_CHECKSUM_SEND       0x21b
 185 #define OBD_FAIL_OST_BRW_SIZE            0x21c
 186 #define OBD_FAIL_OST_DROP_REQ            0x21d
 187 #define OBD_FAIL_OST_SETATTR_CREDITS     0x21e
 188 #define OBD_FAIL_OST_HOLD_WRITE_RPC      0x21f
 189 #define OBD_FAIL_OST_BRW_WRITE_BULK2     0x220
 190 #define OBD_FAIL_OST_LLOG_RECOVERY_TIMEOUT 0x221
 191 #define OBD_FAIL_OST_CANCEL_COOKIE_TIMEOUT 0x222
 192 #define OBD_FAIL_OST_PAUSE_CREATE        0x223
 193 #define OBD_FAIL_OST_BRW_PAUSE_PACK      0x224
 194 #define OBD_FAIL_OST_CONNECT_NET2        0x225
 195
 196 #define OBD_FAIL_LDLM                    0x300
 197 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 198 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 199 #define OBD_FAIL_LDLM_CONVERT            0x303
 200 #define OBD_FAIL_LDLM_CANCEL             0x304
 201 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 202 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 203 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 204 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 205 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 206 #define OBD_FAIL_LDLM_CREATE_RESOURCE    0x30a
 207 #define OBD_FAIL_LDLM_ENQUEUE_BLOCKED    0x30b
 208 #define OBD_FAIL_LDLM_REPLY              0x30c
 209 #define OBD_FAIL_LDLM_RECOV_CLIENTS      0x30d
 210 #define OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT 0x30e
 211 #define OBD_FAIL_LDLM_GLIMPSE            0x30f
 212 #define OBD_FAIL_LDLM_CANCEL_RACE        0x310
 213 #define OBD_FAIL_LDLM_CANCEL_EVICT_RACE  0x311
 214 #define OBD_FAIL_LDLM_PAUSE_CANCEL       0x312
 215 #define OBD_FAIL_LDLM_CLOSE_THREAD       0x313
 216 #define OBD_FAIL_LDLM_CANCEL_BL_CB_RACE  0x314
 217
 218 #define OBD_FAIL_OSC                     0x400
 219 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 220 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 221 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 222 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 223 #define OBD_FAIL_OSC_MATCH               0x405
 224 #define OBD_FAIL_OSC_BRW_PREP_REQ        0x406
 225 #define OBD_FAIL_OSC_SHUTDOWN            0x407
 226 #define OBD_FAIL_OSC_CHECKSUM_RECEIVE    0x408
 227 #define OBD_FAIL_OSC_CHECKSUM_SEND       0x409
 228 #define OBD_FAIL_OSC_BRW_PREP_REQ2       0x40a
 229 #define OBD_FAIL_OSC_CONNECT_CKSUM       0x40b
 230 #define OBD_FAIL_OSC_CKSUM_ADLER_ONLY    0x40c
 231
 232 #define OBD_FAIL_PTLRPC                  0x500
 233 #define OBD_FAIL_PTLRPC_ACK              0x501
 234 #define OBD_FAIL_PTLRPC_RQBD             0x502
 235 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 236 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 237 #define OBD_FAIL_PTLRPC_DROP_RPC         0x505
 238 #define OBD_FAIL_PTLRPC_DELAY_SEND       0x506
 239 #define OBD_FAIL_PTLRPC_DELAY_RECOV      0x507
 240 #define OBD_FAIL_PTLRPC_CLIENT_BULK_CB   0x508
 241 #define OBD_FAIL_PTLRPC_PAUSE_REQ        0x50a
 242 #define OBD_FAIL_PTLRPC_PAUSE_REP        0x50c
 243
 244 #define OBD_FAIL_OBD_PING_NET            0x600
 245 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 246 #define OBD_FAIL_OBD_LOGD_NET            0x602
 247 #define OBD_FAIL_OBD_QC_CALLBACK_NET     0x603
 248 #define OBD_FAIL_OBD_DQACQ               0x604
 249
 250 #define OBD_FAIL_TGT_REPLY_NET           0x700
 251 #define OBD_FAIL_TGT_CONN_RACE           0x701
 252 #define OBD_FAIL_TGT_FORCE_RECONNECT     0x702
 253 #define OBD_FAIL_TGT_DELAY_CONNECT       0x703
 254 #define OBD_FAIL_TGT_DELAY_RECONNECT     0x704
 255 #define OBD_FAIL_TGT_DELAY_PRECREATE     0x705
 256 #define OBD_FAIL_TGT_TOOMANY_THREADS     0x706
 257 #define OBD_FAIL_TGT_REPLAY_DROP         0x707
 258
 259 #define OBD_FAIL_MDC_REVALIDATE_PAUSE    0x800
 260 #define OBD_FAIL_MDC_ENQUEUE_PAUSE       0x801
 261 #define OBD_FAIL_MDC_OLD_EXT_FLAGS       0x802
 262 #define OBD_FAIL_MDC_GETATTR_ENQUEUE     0x803
 263
 264 #define OBD_FAIL_MGS                     0x900
 265 #define OBD_FAIL_MGS_ALL_REQUEST_NET     0x901
 266 #define OBD_FAIL_MGS_ALL_REPLY_NET       0x902
 267 #define OBD_FAIL_MGC_PAUSE_PROCESS_LOG   0x903
 268 #define OBD_FAIL_MGS_PAUSE_REQ           0x904
 269 #define OBD_FAIL_MGS_PAUSE_TARGET_REG    0x905
 270
 271 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(1, 9, 0, 0)
 272 #define OBD_FAIL_QUOTA_WITHOUT_CHANGE_QS    0xA01
 273 #else
 274 #warning "remove quota code above for format obsolete in new release"
 275 #endif
 276
 277 #define OBD_FAIL_QUOTA_RET_QDATA         0xA02
 278
 279 #define OBD_FAIL_LPROC_REMOVE            0xB00
 280
 281 #define OBD_FAIL_GENERAL_ALLOC           0xC00
 282
 283 /* Failure injection control */
 284 #define OBD_FAIL_MASK_SYS    0x0000FF00
 285 #define OBD_FAIL_MASK_LOC   (0x000000FF | OBD_FAIL_MASK_SYS)
 286 #define OBD_FAIL_ONCE        0x80000000
 287 #define OBD_FAILED           0x40000000
 288 /* The following flags aren't made to be combined */
 289 #define OBD_FAIL_SKIP        0x20000000 /* skip N then fail */
 290 #define OBD_FAIL_SOME        0x10000000 /* fail N times */
 291 #define OBD_FAIL_RAND        0x08000000 /* fail 1/N of the time */
 292 #define OBD_FAIL_USR1        0x04000000 /* user flag */
 293
 294 int obd_fail_check(__u32 id);
 295 #define OBD_FAIL_CHECK(id)                                                   \
 296 ({                                                                           \
 297         int _ret_ = 0;                                                       \
 298         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 299                 CERROR("*** obd_fail_loc=%x ***\n", id);                     \
 300         }                                                                    \
 301         _ret_;                                                               \
 302 })
 303
 304 #define OBD_FAIL_CHECK_QUIET(id)                                             \
 305         (unlikely(obd_fail_loc) ? obd_fail_check(id) : 0)
 306
 307 /* deprecated - just use OBD_FAIL_CHECK */
 308 #define OBD_FAIL_CHECK_ONCE OBD_FAIL_CHECK
 309
 310 #define OBD_FAIL_RETURN(id, ret)                                             \
 311 do {                                                                         \
 312         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 313                 CERROR("*** obd_fail_return=%x rc=%d ***\n", id, ret);       \
 314                 RETURN(ret);                                                 \
 315         }                                                                    \
 316 } while(0)
 317
 318 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 319 ({      int _ret_ = 0;                                                       \
 320         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 321                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",      \
 322                        (id), (secs));                                        \
 323                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 324                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 325                                     cfs_time_seconds(secs));                 \
 326                 set_current_state(TASK_RUNNING);                             \
 327                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 328         }                                                                    \
 329         _ret_;                                                               \
 330 })
 331
 332 #define OBD_FAIL_TIMEOUT_MS(id, ms)                                          \
 333 ({      int _ret_ = 0;                                                       \
 334         if (unlikely(obd_fail_loc && (_ret_ = obd_fail_check(id)))) {        \
 335                 CERROR("obd_fail_timeout id %x sleeping for %d ms\n",        \
 336                        (id), (ms));                                          \
 337                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 338                 cfs_schedule_timeout(CFS_TASK_UNINT,                         \
 339                                      cfs_time_seconds(ms)/1000);             \
 340                 set_current_state(TASK_RUNNING);                             \
 341                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 342         }                                                                    \
 343         _ret_;                                                               \
 344 })
 345
 346 #ifdef __KERNEL__
 347 /* The idea here is to synchronise two threads to force a race. The
 348  * first thread that calls this with a matching fail_loc is put to
 349  * sleep. The next thread that calls with the same fail_loc wakes up
 350  * the first and continues. */
 351 #define OBD_RACE(id)                                                         \
 352 do {                                                                         \
 353         if (unlikely(obd_fail_loc && obd_fail_check(id))) {                  \
 354                 obd_race_state = 0;                                          \
 355                 CERROR("obd_race id %x sleeping\n", (id));                   \
 356                 OBD_SLEEP_ON(obd_race_waitq, obd_race_state != 0);           \
 357                 CERROR("obd_fail_race id %x awake\n", (id));                 \
 358         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==                     \
 359                     ((id) & OBD_FAIL_MASK_LOC)) {                            \
 360                 CERROR("obd_fail_race id %x waking\n", (id));                \
 361                 obd_race_state = 1;                                          \
 362                 wake_up(&obd_race_waitq);                                    \
 363         }                                                                    \
 364 } while(0)
 365 #else
 366 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 367 #define OBD_RACE(foo) do {} while(0)
 368 #endif
 369
 370 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 371
 372 extern atomic_t libcfs_kmemory;
 373
 374 #ifdef RANDOM_FAIL_ALLOC
 375 #define HAS_FAIL_ALLOC_FLAG OBD_FAIL_CHECK_QUIET(OBD_FAIL_GENERAL_ALLOC)
 376 #else
 377 #define HAS_FAIL_ALLOC_FLAG 0
 378 #endif
 379
 380 #define OBD_ALLOC_FAIL_BITS 24
 381 #define OBD_ALLOC_FAIL_MASK ((1 << OBD_ALLOC_FAIL_BITS) - 1)
 382 #define OBD_ALLOC_FAIL_MULT (OBD_ALLOC_FAIL_MASK / 100)
 383
 384 #ifdef LPROCFS
 385 #define obd_memory_add(size)                                                  \
 386         lprocfs_counter_add(obd_memory, OBD_MEMORY_STAT, (long)(size))
 387 #define obd_memory_sub(size)                                                  \
 388         lprocfs_counter_sub(obd_memory, OBD_MEMORY_STAT, (long)(size))
 389 #define obd_memory_sum()                                                      \
 390         lprocfs_stats_collector(obd_memory, OBD_MEMORY_STAT,                  \
 391                                 LPROCFS_FIELDS_FLAGS_SUM)
 392 #define obd_pages_add(order)                                                  \
 393         lprocfs_counter_add(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 394                             (long)(1 << (order)))
 395 #define obd_pages_sub(order)                                                  \
 396         lprocfs_counter_sub(obd_memory, OBD_MEMORY_PAGES_STAT,                \
 397                             (long)(1 << (order)))
 398 #define obd_pages_sum()                                                       \
 399         lprocfs_stats_collector(obd_memory, OBD_MEMORY_PAGES_STAT,            \
 400                                 LPROCFS_FIELDS_FLAGS_SUM)
 401
 402 extern void obd_update_maxusage(void);
 403 extern __u64 obd_memory_max(void);
 404 extern __u64 obd_pages_max(void);
 405
 406 #else
 407
 408 extern __u64 obd_alloc;
 409 extern __u64 obd_pages;
 410
 411 extern __u64 obd_max_alloc;
 412 extern __u64 obd_max_pages;
 413
 414 static inline void obd_memory_add(long size)
 415 {
 416         obd_alloc += size;
 417         if (obd_alloc > obd_max_alloc)
 418                 obd_max_alloc = obd_alloc;
 419 }
 420
 421 static inline void obd_memory_sub(long size)
 422 {
 423         obd_alloc -= size;
 424 }
 425
 426 static inline void obd_pages_add(int order)
 427 {
 428         obd_pages += 1<< order;
 429         if (obd_pages > obd_max_pages)
 430                 obd_max_pages = obd_pages;
 431 }
 432
 433 static inline void obd_pages_sub(int order)
 434 {
 435         obd_pages -= 1<< order;
 436 }
 437
 438 #define obd_memory_sum() (obd_alloc)
 439 #define obd_pages_sum()  (obd_pages)
 440
 441 #define obd_memory_max() (obd_max_alloc)
 442 #define obd_pages_max() (obd_max_pages)
 443
 444 #endif
 445
 446 #if defined(LUSTRE_UTILS) /* this version is for utils only */
 447 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 448 do {                                                                          \
 449         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 450         if (unlikely((ptr) == NULL)) {                                        \
 451                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed\n",           \
 452                        (int)(size));                                          \
 453         } else {                                                              \
 454                 memset(ptr, 0, size);                                         \
 455                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p\n",          \
 456                        (int)(size), ptr);                                     \
 457         }                                                                     \
 458 } while (0)
 459 #else /* this version is for the kernel and liblustre */
 460 #define OBD_FREE_RTN0(ptr)                                                    \
 461 ({                                                                            \
 462         cfs_free(ptr);                                                        \
 463         (ptr) = NULL;                                                         \
 464         0;                                                                    \
 465 })
 466 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 467 do {                                                                          \
 468         (ptr) = cfs_alloc(size, (gfp_mask));                                  \
 469         if (likely((ptr) != NULL &&                                           \
 470                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 471                     !obd_alloc_fail(ptr, #ptr, "km", size,                    \
 472                                     __FILE__, __LINE__) ||                    \
 473                     OBD_FREE_RTN0(ptr)))){                                    \
 474                 memset(ptr, 0, size);                                         \
 475                 obd_memory_add(size);                                         \
 476                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p.\n",         \
 477                        (int)(size), ptr);                                     \
 478         }                                                                     \
 479 } while (0)
 480 #endif
 481
 482 #ifndef OBD_ALLOC_MASK
 483 # define OBD_ALLOC_MASK CFS_ALLOC_IO
 484 #endif
 485
 486 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_ALLOC_MASK)
 487 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, CFS_ALLOC_STD)
 488 #define OBD_ALLOC_PTR(ptr) OBD_ALLOC(ptr, sizeof *(ptr))
 489 #define OBD_ALLOC_PTR_WAIT(ptr) OBD_ALLOC_WAIT(ptr, sizeof *(ptr))
 490
 491 #ifdef __arch_um__
 492 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 493 #else
 494 # define OBD_VMALLOC(ptr, size)                                               \
 495 do {                                                                          \
 496         (ptr) = cfs_alloc_large(size);                                        \
 497         if (unlikely((ptr) == NULL)) {                                        \
 498                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed\n",           \
 499                        (int)(size));                                          \
 500                 CERROR(LPU64" total bytes allocated by Lustre, %d by LNET\n", \
 501                        obd_memory_sum(), atomic_read(&libcfs_kmemory));      \
 502         } else {                                                              \
 503                 memset(ptr, 0, size);                                         \
 504                 obd_memory_add(size);                                         \
 505                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p.\n",         \
 506                        (int)(size), ptr);                                     \
 507         }                                                                     \
 508 } while (0)
 509 #endif
 510
 511 #ifdef CONFIG_DEBUG_SLAB
 512 #define POISON(ptr, c, s) do {} while (0)
 513 #else
 514 #define POISON(ptr, c, s) memset(ptr, c, s)
 515 #endif
 516
 517 #ifdef POISON_BULK
 518 #define POISON_PAGE(page, val) do { memset(kmap(page), val, CFS_PAGE_SIZE);   \
 519                                     kunmap(page); } while (0)
 520 #else
 521 #define POISON_PAGE(page, val) do { } while (0)
 522 #endif
 523
 524 #ifdef __KERNEL__
 525 #define OBD_FREE(ptr, size)                                                   \
 526 do {                                                                          \
 527         LASSERT(ptr);                                                         \
 528         obd_memory_sub(size);                                                 \
 529         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p.\n",                    \
 530                (int)(size), ptr);                                             \
 531         POISON(ptr, 0x5a, size);                                              \
 532         cfs_free(ptr);                                                        \
 533         (ptr) = (void *)0xdeadbeef;                                           \
 534 } while (0)
 535
 536 #ifdef HAVE_RCU
 537 # ifdef HAVE_CALL_RCU_PARAM
 538 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb, rcu)
 539 # else
 540 #  define my_call_rcu(rcu, cb)            call_rcu(rcu, cb)
 541 # endif
 542 #else
 543 # define my_call_rcu(rcu, cb)             (cb)(rcu)
 544 #endif
 545
 546 #define OBD_FREE_RCU_CB(ptr, size, handle, free_cb)                           \
 547 do {                                                                          \
 548         struct portals_handle *__h = (handle);                                \
 549         LASSERT(handle);                                                      \
 550         __h->h_ptr = (ptr);                                                   \
 551         __h->h_size = (size);                                                 \
 552         __h->h_free_cb = (void (*)(void *, size_t))(free_cb);                 \
 553         my_call_rcu(&__h->h_rcu, class_handle_free_cb);                       \
 554         (ptr) = (void *)0xdeadbeef;                                           \
 555 } while(0)
 556 #define OBD_FREE_RCU(ptr, size, handle) OBD_FREE_RCU_CB(ptr, size, handle, NULL)
 557 #else
 558 #define OBD_FREE(ptr, size) ((void)(size), free((ptr)))
 559 #define OBD_FREE_RCU(ptr, size, handle) (OBD_FREE(ptr, size))
 560 #define OBD_FREE_RCU_CB(ptr, size, handle, cb)     ((*(cb))(ptr, size))
 561 #endif
 562
 563 #ifdef __arch_um__
 564 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 565 #else
 566 # define OBD_VFREE(ptr, size)                                                 \
 567 do {                                                                          \
 568         LASSERT(ptr);                                                         \
 569         obd_memory_sub(size);                                                 \
 570         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p.\n",                    \
 571                (int)(size), ptr);                                             \
 572         POISON(ptr, 0x5a, size);                                              \
 573         cfs_free_large(ptr);                                                  \
 574         (ptr) = (void *)0xdeadbeef;                                           \
 575 } while (0)
 576 #endif
 577
 578 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 579  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 580  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 581 #define OBD_SLAB_FREE_RTN0(ptr, slab)                                         \
 582 ({                                                                            \
 583         cfs_mem_cache_free((slab), (ptr));                                    \
 584         (ptr) = NULL;                                                         \
 585         0;                                                                    \
 586 })
 587 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 588 do {                                                                          \
 589         LASSERT(!in_interrupt());                                             \
 590         (ptr) = cfs_mem_cache_alloc(slab, (type));                            \
 591         if (likely((ptr) != NULL &&                                           \
 592                    (!HAS_FAIL_ALLOC_FLAG || obd_alloc_fail_rate == 0 ||       \
 593                     !obd_alloc_fail(ptr, #ptr, "slab-", size,                 \
 594                                     __FILE__, __LINE__) ||                    \
 595                     OBD_SLAB_FREE_RTN0(ptr, slab)))) {                        \
 596                 memset(ptr, 0, size);                                         \
 597                 obd_memory_add(size);                                         \
 598                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p.\n",        \
 599                        (int)(size), ptr);                                     \
 600         }                                                                     \
 601 } while (0)
 602
 603 #define OBD_FREE_PTR(ptr) OBD_FREE(ptr, sizeof *(ptr))
 604
 605 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 606 do {                                                                          \
 607         LASSERT(ptr);                                                         \
 608         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p.\n",                \
 609                (int)(size), ptr);                                             \
 610         obd_memory_sub(size);                                                 \
 611         POISON(ptr, 0x5a, size);                                              \
 612         cfs_mem_cache_free(slab, ptr);                                        \
 613         (ptr) = (void *)0xdeadbeef;                                           \
 614 } while (0)
 615
 616 #define OBD_SLAB_ALLOC_PTR(ptr, slab)                                         \
 617         OBD_SLAB_ALLOC((ptr), (slab), CFS_ALLOC_STD, sizeof *(ptr))
 618 #define OBD_SLAB_FREE_PTR(ptr, slab)                                          \
 619         OBD_SLAB_FREE((ptr), (slab), sizeof *(ptr))
 620
 621 #define KEY_IS(str) (keylen >= strlen(str) && strcmp(key, str) == 0)
 622
 623 /* Wrapper for contiguous page frame allocation */
 624 #define OBD_PAGES_ALLOC(ptr, order, gfp_mask)                                 \
 625 do {                                                                          \
 626         (ptr) = cfs_alloc_pages(gfp_mask, order);                             \
 627         if (unlikely((ptr) == NULL)) {                                        \
 628                 CERROR("alloc_pages of '" #ptr "' %d page(s) / "LPU64" bytes "\
 629                        "failed\n", (int)(1 << (order)),                       \
 630                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT));            \
 631                 CERROR(LPU64" total bytes and "LPU64" total pages "           \
 632                        "("LPU64" bytes) allocated by Lustre, "                \
 633                        "%d total bytes by LNET\n",                            \
 634                        obd_memory_sum(),                                      \
 635                        obd_pages_sum() << CFS_PAGE_SHIFT,                     \
 636                        obd_pages_sum(),                                       \
 637                        atomic_read(&libcfs_kmemory));                         \
 638         } else {                                                              \
 639                 obd_pages_add(order);                                         \
 640                 CDEBUG(D_MALLOC, "alloc_pages '" #ptr "': %d page(s) / "      \
 641                        LPU64" bytes at %p.\n",                                \
 642                        (int)(1 << (order)),                                   \
 643                        (__u64)((1 << (order)) << CFS_PAGE_SHIFT), ptr);       \
 644         }                                                                     \
 645 } while (0)
 646
 647 #define OBD_PAGE_ALLOC(ptr, gfp_mask)                                         \
 648         OBD_PAGES_ALLOC(ptr, 0, gfp_mask)
 649
 650 #define OBD_PAGES_FREE(ptr, order)                                            \
 651 do {                                                                          \
 652         LASSERT(ptr);                                                         \
 653         obd_pages_sub(order);                                                 \
 654         CDEBUG(D_MALLOC, "free_pages '" #ptr "': %d page(s) / "LPU64" bytes " \
 655                "at %p.\n",                                                    \
 656                (int)(1 << (order)), (__u64)((1 << (order)) << CFS_PAGE_SHIFT),\
 657                ptr);                                                          \
 658         __cfs_free_pages(ptr, order);                                         \
 659         (ptr) = (void *)0xdeadbeef;                                           \
 660 } while (0)
 661
 662 #define OBD_PAGE_FREE(ptr) OBD_PAGES_FREE(ptr, 0)
 663
 664 #if defined(__linux__)
 665 #include <linux/obd_support.h>
 666 #elif defined(__APPLE__)
 667 #include <darwin/obd_support.h>
 668 #elif defined(__WINNT__)
 669 #include <winnt/obd_support.h>
 670 #else
 671 #error Unsupported operating system.
 672 #endif
 673
 674 #endif