lustre/include/linux/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 #ifdef __KERNEL__
  27 #include <linux/config.h>
  28 #include <linux/autoconf.h>
  29 #include <linux/slab.h>
  30 #include <linux/highmem.h>
  31 #endif
  32 #include <linux/kp30.h>
  33 #include <linux/lustre_compat25.h>
  34
  35 /* global variables */
  36 extern atomic_t obd_memory;
  37 extern int obd_memmax;
  38 extern unsigned int obd_fail_loc;
  39 extern unsigned int obd_timeout;
  40 extern char obd_lustre_upcall[128];
  41 extern unsigned int obd_sync_filter;
  42 extern wait_queue_head_t obd_race_waitq;
  43
  44 #define OBD_FAIL_MDS                     0x100
  45 #define OBD_FAIL_MDS_HANDLE_UNPACK       0x101
  46 #define OBD_FAIL_MDS_GETATTR_NET         0x102
  47 #define OBD_FAIL_MDS_GETATTR_PACK        0x103
  48 #define OBD_FAIL_MDS_READPAGE_NET        0x104
  49 #define OBD_FAIL_MDS_READPAGE_PACK       0x105
  50 #define OBD_FAIL_MDS_SENDPAGE            0x106
  51 #define OBD_FAIL_MDS_REINT_NET           0x107
  52 #define OBD_FAIL_MDS_REINT_UNPACK        0x108
  53 #define OBD_FAIL_MDS_REINT_SETATTR       0x109
  54 #define OBD_FAIL_MDS_REINT_SETATTR_WRITE 0x10a
  55 #define OBD_FAIL_MDS_REINT_CREATE        0x10b
  56 #define OBD_FAIL_MDS_REINT_CREATE_WRITE  0x10c
  57 #define OBD_FAIL_MDS_REINT_UNLINK        0x10d
  58 #define OBD_FAIL_MDS_REINT_UNLINK_WRITE  0x10e
  59 #define OBD_FAIL_MDS_REINT_LINK          0x10f
  60 #define OBD_FAIL_MDS_REINT_LINK_WRITE    0x110
  61 #define OBD_FAIL_MDS_REINT_RENAME        0x111
  62 #define OBD_FAIL_MDS_REINT_RENAME_WRITE  0x112
  63 #define OBD_FAIL_MDS_OPEN_NET            0x113
  64 #define OBD_FAIL_MDS_OPEN_PACK           0x114
  65 #define OBD_FAIL_MDS_CLOSE_NET           0x115
  66 #define OBD_FAIL_MDS_CLOSE_PACK          0x116
  67 #define OBD_FAIL_MDS_CONNECT_NET         0x117
  68 #define OBD_FAIL_MDS_CONNECT_PACK        0x118
  69 #define OBD_FAIL_MDS_REINT_NET_REP       0x119
  70 #define OBD_FAIL_MDS_DISCONNECT_NET      0x11a
  71 #define OBD_FAIL_MDS_GETSTATUS_NET       0x11b
  72 #define OBD_FAIL_MDS_GETSTATUS_PACK      0x11c
  73 #define OBD_FAIL_MDS_STATFS_PACK         0x11d
  74 #define OBD_FAIL_MDS_STATFS_NET          0x11e
  75 #define OBD_FAIL_MDS_GETATTR_NAME_NET    0x11f
  76 #define OBD_FAIL_MDS_PIN_NET             0x120
  77 #define OBD_FAIL_MDS_UNPIN_NET           0x121
  78 #define OBD_FAIL_MDS_ALL_REPLY_NET       0x122
  79 #define OBD_FAIL_MDS_ALL_REQUEST_NET     0x123
  80 #define OBD_FAIL_MDS_SYNC_NET            0x124
  81 #define OBD_FAIL_MDS_SYNC_PACK           0x125
  82 #define OBD_FAIL_MDS_DONE_WRITING_NET    0x126
  83 #define OBD_FAIL_MDS_DONE_WRITING_PACK   0x127
  84 #define OBD_FAIL_MDS_ALLOC_OBDO          0x128
  85
  86 #define OBD_FAIL_OST                     0x200
  87 #define OBD_FAIL_OST_CONNECT_NET         0x201
  88 #define OBD_FAIL_OST_DISCONNECT_NET      0x202
  89 #define OBD_FAIL_OST_GET_INFO_NET        0x203
  90 #define OBD_FAIL_OST_CREATE_NET          0x204
  91 #define OBD_FAIL_OST_DESTROY_NET         0x205
  92 #define OBD_FAIL_OST_GETATTR_NET         0x206
  93 #define OBD_FAIL_OST_SETATTR_NET         0x207
  94 #define OBD_FAIL_OST_OPEN_NET            0x208
  95 #define OBD_FAIL_OST_CLOSE_NET           0x209
  96 #define OBD_FAIL_OST_BRW_NET             0x20a
  97 #define OBD_FAIL_OST_PUNCH_NET           0x20b
  98 #define OBD_FAIL_OST_STATFS_NET          0x20c
  99 #define OBD_FAIL_OST_HANDLE_UNPACK       0x20d
 100 #define OBD_FAIL_OST_BRW_WRITE_BULK      0x20e
 101 #define OBD_FAIL_OST_BRW_READ_BULK       0x20f
 102 #define OBD_FAIL_OST_SYNC_NET            0x210
 103 #define OBD_FAIL_OST_ALL_REPLY_NET       0x211
 104 #define OBD_FAIL_OST_ALL_REQUESTS_NET    0x212
 105 #define OBD_FAIL_OST_LDLM_REPLY_NET      0x213
 106 #define OBD_FAIL_OST_BRW_PAUSE_BULK      0x214
 107
 108 #define OBD_FAIL_LDLM                    0x300
 109 #define OBD_FAIL_LDLM_NAMESPACE_NEW      0x301
 110 #define OBD_FAIL_LDLM_ENQUEUE            0x302
 111 #define OBD_FAIL_LDLM_CONVERT            0x303
 112 #define OBD_FAIL_LDLM_CANCEL             0x304
 113 #define OBD_FAIL_LDLM_BL_CALLBACK        0x305
 114 #define OBD_FAIL_LDLM_CP_CALLBACK        0x306
 115 #define OBD_FAIL_LDLM_GL_CALLBACK        0x307
 116 #define OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR 0x308
 117 #define OBD_FAIL_LDLM_ENQUEUE_INTENT_ERR 0x309
 118
 119 #define OBD_FAIL_OSC                     0x400
 120 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 121 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 122 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 123 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 124 #define OBD_FAIL_OSC_MATCH               0x405
 125
 126 #define OBD_FAIL_PTLRPC                  0x500
 127 #define OBD_FAIL_PTLRPC_ACK              0x501
 128 #define OBD_FAIL_PTLRPC_RQBD             0x502
 129 #define OBD_FAIL_PTLRPC_BULK_GET_NET     0x503
 130 #define OBD_FAIL_PTLRPC_BULK_PUT_NET     0x504
 131
 132 #define OBD_FAIL_OBD_PING_NET            0x600
 133 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 134 #define OBD_FAIL_OBD_LOGD_NET            0x602
 135
 136 #define OBD_FAIL_TGT_REPLY_NET           0x700
 137 #define OBD_FAIL_TGT_CONN_RACE           0x701
 138
 139 /* preparation for a more advanced failure testbed (not functional yet) */
 140 #define OBD_FAIL_MASK_SYS    0x0000FF00
 141 #define OBD_FAIL_MASK_LOC    (0x000000FF | OBD_FAIL_MASK_SYS)
 142 #define OBD_FAIL_ONCE        0x80000000
 143 #define OBD_FAILED           0x40000000
 144 #define OBD_FAIL_MDS_ALL_NET 0x01000000
 145 #define OBD_FAIL_OST_ALL_NET 0x02000000
 146
 147 #define OBD_FAIL_CHECK(id)   (((obd_fail_loc & OBD_FAIL_MASK_LOC) ==           \
 148                               ((id) & OBD_FAIL_MASK_LOC)) &&                   \
 149                               ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE))!= \
 150                                 (OBD_FAILED | OBD_FAIL_ONCE)))
 151
 152 #define OBD_FAIL_CHECK_ONCE(id)                                              \
 153 ({      int _ret_ = 0;                                                       \
 154         if (OBD_FAIL_CHECK(id)) {                                            \
 155                 CERROR("obd_fail_loc=%x\n", id);                             \
 156                 obd_fail_loc |= OBD_FAILED;                                  \
 157                 if ((id) & OBD_FAIL_ONCE)                                    \
 158                         obd_fail_loc |= OBD_FAIL_ONCE;                       \
 159                 _ret_ = 1;                                                   \
 160         }                                                                    \
 161         _ret_;                                                               \
 162 })
 163
 164 #define OBD_FAIL_RETURN(id, ret)                                             \
 165 do {                                                                         \
 166         if (OBD_FAIL_CHECK_ONCE(id)) {                                       \
 167                 RETURN(ret);                                                 \
 168         }                                                                    \
 169 } while(0)
 170
 171 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 172 do {                                                                         \
 173         if  (OBD_FAIL_CHECK_ONCE(id)) {                                      \
 174                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",     \
 175                        (id), (secs));                                        \
 176                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 177                 schedule_timeout((secs) * HZ);                               \
 178                 set_current_state(TASK_RUNNING);                             \
 179                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 180        }                                                                     \
 181 } while(0)
 182
 183 #ifdef __KERNEL__
 184 /* The idea here is to synchronise two threads to force a race. The
 185  * first thread that calls this with a matching fail_loc is put to
 186  * sleep. The next thread that calls with the same fail_loc wakes up
 187  * the first and continues. */
 188 #define OBD_RACE(id)                                            \
 189 do {                                                            \
 190         if  (OBD_FAIL_CHECK_ONCE(id)) {                         \
 191                 CERROR("obd_race id %x sleeping\n", (id));      \
 192                 sleep_on(&obd_race_waitq);                      \
 193                 CERROR("obd_fail_race id %x awake\n", (id));    \
 194         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==        \
 195                     ((id) & OBD_FAIL_MASK_LOC)) {               \
 196                 wake_up(&obd_race_waitq);                       \
 197         }                                                       \
 198 } while(0)
 199 #else
 200 /* sigh.  an expedient fix until OBD_RACE is fixed up */
 201 #define OBD_RACE(foo) LBUG()
 202 #endif
 203
 204 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 205
 206 #ifdef __KERNEL__
 207 # include <linux/types.h>
 208 # include <linux/blkdev.h>
 209
 210
 211 # if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 212 #  define BDEVNAME_DECLARE_STORAGE(foo) char foo[BDEVNAME_SIZE]
 213 #  define ll_bdevname(SB, STORAGE) __bdevname(kdev_t_to_nr(SB->s_dev), STORAGE)
 214 #  define ll_lock_kernel lock_kernel()
 215 #  define ll_sbdev(SB)    ((SB)->s_bdev)
 216 void dev_set_rdonly(struct block_device *, int);
 217 # else
 218 #  define BDEVNAME_DECLARE_STORAGE(foo) char __unused_##foo
 219 #  define ll_sbdev(SB)    (kdev_t_to_nr((SB)->s_dev))
 220 #  define ll_bdevname(SB,STORAGE) ((void)__unused_##STORAGE,bdevname(ll_sbdev(SB)))
 221 #  define ll_lock_kernel
 222 void dev_set_rdonly(kdev_t, int);
 223 # endif
 224
 225 void dev_clear_rdonly(int);
 226
 227 static inline void OBD_FAIL_WRITE(int id, struct super_block *sb)
 228 {
 229         if (OBD_FAIL_CHECK(id)) {
 230                 BDEVNAME_DECLARE_STORAGE(tmp);
 231                 CERROR("obd_fail_loc=%x, fail write operation on %s\n",
 232                        id, ll_bdevname(sb, tmp));
 233                 dev_set_rdonly(ll_sbdev(sb), 2);
 234                 /* We set FAIL_ONCE because we never "un-fail" a device */
 235                 obd_fail_loc |= OBD_FAILED | OBD_FAIL_ONCE;
 236         }
 237 }
 238 #else /* !__KERNEL__ */
 239 # define LTIME_S(time) (time)
 240 /* for obd_class.h */
 241 # ifndef ERR_PTR
 242 #  define ERR_PTR(a) ((void *)(a))
 243 # endif
 244 #endif  /* __KERNEL__ */
 245
 246 extern atomic_t portal_kmemory;
 247
 248 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 249 do {                                                                          \
 250         (ptr) = kmalloc(size, (gfp_mask));                                    \
 251         if ((ptr) == NULL) {                                                  \
 252                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 253                        (int)(size), __FILE__, __LINE__);                      \
 254                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 255                        atomic_read(&obd_memory), atomic_read(&portal_kmemory));\
 256         } else {                                                              \
 257                 memset(ptr, 0, size);                                         \
 258                 atomic_add(size, &obd_memory);                                \
 259                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 260                         obd_memmax = atomic_read(&obd_memory);                \
 261                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d)\n", \
 262                        (int)(size), ptr, atomic_read(&obd_memory));           \
 263         }                                                                     \
 264 } while (0)
 265
 266 #ifndef OBD_GFP_MASK
 267 # define OBD_GFP_MASK GFP_NOFS
 268 #endif
 269
 270 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_GFP_MASK)
 271 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, GFP_KERNEL)
 272
 273 #ifdef __arch_um__
 274 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 275 #else
 276 # define OBD_VMALLOC(ptr, size)                                               \
 277 do {                                                                          \
 278         (ptr) = vmalloc(size);                                                \
 279         if ((ptr) == NULL) {                                                  \
 280                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 281                        (int)(size), __FILE__, __LINE__);                      \
 282                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 283                        atomic_read(&obd_memory), atomic_read(&portal_kmemory));\
 284         } else {                                                              \
 285                 memset(ptr, 0, size);                                         \
 286                 atomic_add(size, &obd_memory);                                \
 287                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 288                         obd_memmax = atomic_read(&obd_memory);                \
 289                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p (tot %d)\n", \
 290                        (int)(size), ptr, atomic_read(&obd_memory));           \
 291         }                                                                     \
 292 } while (0)
 293 #endif
 294
 295 #ifdef CONFIG_DEBUG_SLAB
 296 #define POISON(ptr, c, s) do {} while (0)
 297 #else
 298 #define POISON(ptr, c, s) memset(ptr, c, s)
 299 #endif
 300
 301 #if POISON_BULK
 302 #define POISON_PAGE(page, val) do { memset(kmap(page), val, PAGE_SIZE);       \
 303                                     kunmap(page); } while (0)
 304 #else
 305 #define POISON_PAGE(page, val) do { } while (0)
 306 #endif
 307
 308 #define OBD_FREE(ptr, size)                                                   \
 309 do {                                                                          \
 310         LASSERT(ptr);                                                         \
 311         atomic_sub(size, &obd_memory);                                        \
 312         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",           \
 313                (int)(size), ptr, atomic_read(&obd_memory));                   \
 314         POISON(ptr, 0x5a, size);                                              \
 315         kfree(ptr);                                                           \
 316         (ptr) = (void *)0xdeadbeef;                                           \
 317 } while (0)
 318
 319 #ifdef __arch_um__
 320 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 321 #else
 322 # define OBD_VFREE(ptr, size)                                                 \
 323 do {                                                                          \
 324         LASSERT(ptr);                                                         \
 325         atomic_sub(size, &obd_memory);                                        \
 326         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p (tot %d).\n",           \
 327                (int)(size), ptr, atomic_read(&obd_memory));                   \
 328         POISON(ptr, 0x5a, size);                                              \
 329         vfree(ptr);                                                           \
 330         (ptr) = (void *)0xdeadbeef;                                           \
 331 } while (0)
 332 #endif
 333
 334 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 335  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 336  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 337 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 338 do {                                                                          \
 339         LASSERT(!in_interrupt());                                             \
 340         (ptr) = kmem_cache_alloc(slab, (type));                               \
 341         if ((ptr) == NULL) {                                                  \
 342                 CERROR("slab-alloc of '"#ptr"' (%d bytes) failed at %s:%d\n", \
 343                        (int)(size), __FILE__, __LINE__);                      \
 344                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 345                        atomic_read(&obd_memory), atomic_read(&portal_kmemory));\
 346         } else {                                                              \
 347                 memset(ptr, 0, size);                                         \
 348                 atomic_add(size, &obd_memory);                                \
 349                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 350                         obd_memmax = atomic_read(&obd_memory);                \
 351                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p (tot %d)\n",\
 352                        (int)(size), ptr, atomic_read(&obd_memory));           \
 353         }                                                                     \
 354 } while (0)
 355
 356 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 357 do {                                                                          \
 358         LASSERT(ptr);                                                         \
 359         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p (tot %d).\n",       \
 360                (int)(size), ptr, atomic_read(&obd_memory));                   \
 361         atomic_sub(size, &obd_memory);                                        \
 362         POISON(ptr, 0x5a, size);                                              \
 363         kmem_cache_free(slab, ptr);                                           \
 364         (ptr) = (void *)0xdeadbeef;                                           \
 365 } while (0)
 366
 367 #endif