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