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