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
 117 #define OBD_FAIL_OSC                     0x400
 118 #define OBD_FAIL_OSC_BRW_READ_BULK       0x401
 119 #define OBD_FAIL_OSC_BRW_WRITE_BULK      0x402
 120 #define OBD_FAIL_OSC_LOCK_BL_AST         0x403
 121 #define OBD_FAIL_OSC_LOCK_CP_AST         0x404
 122 #define OBD_FAIL_OSC_MATCH               0x405
 123
 124 #define OBD_FAIL_PTLRPC                  0x500
 125 #define OBD_FAIL_PTLRPC_ACK              0x501
 126 #define OBD_FAIL_PTLRPC_RQBD             0x502
 127
 128 #define OBD_FAIL_OBD_PING_NET            0x600
 129 #define OBD_FAIL_OBD_LOG_CANCEL_NET      0x601
 130 #define OBD_FAIL_OBD_LOGD_NET            0x602
 131
 132 #define OBD_FAIL_TGT_REPLY_NET           0x700
 133 #define OBD_FAIL_TGT_CONN_RACE           0x701
 134
 135 /* preparation for a more advanced failure testbed (not functional yet) */
 136 #define OBD_FAIL_MASK_SYS    0x0000FF00
 137 #define OBD_FAIL_MASK_LOC    (0x000000FF | OBD_FAIL_MASK_SYS)
 138 #define OBD_FAIL_ONCE        0x80000000
 139 #define OBD_FAILED           0x40000000
 140 #define OBD_FAIL_MDS_ALL_NET 0x01000000
 141 #define OBD_FAIL_OST_ALL_NET 0x02000000
 142
 143 #define OBD_FAIL_CHECK(id)   (((obd_fail_loc & OBD_FAIL_MASK_LOC) ==           \
 144                               ((id) & OBD_FAIL_MASK_LOC)) &&                   \
 145                               ((obd_fail_loc & (OBD_FAILED | OBD_FAIL_ONCE))!= \
 146                                 (OBD_FAILED | OBD_FAIL_ONCE)))
 147
 148 #define OBD_FAIL_CHECK_ONCE(id)                                              \
 149 ({      int _ret_ = 0;                                                       \
 150         if (OBD_FAIL_CHECK(id)) {                                            \
 151                 CERROR("obd_fail_loc=%x\n", id);                             \
 152                 obd_fail_loc |= OBD_FAILED;                                  \
 153                 if ((id) & OBD_FAIL_ONCE)                                    \
 154                         obd_fail_loc |= OBD_FAIL_ONCE;                       \
 155                 _ret_ = 1;                                                   \
 156         }                                                                    \
 157         _ret_;                                                               \
 158 })
 159
 160 #define OBD_FAIL_RETURN(id, ret)                                             \
 161 do {                                                                         \
 162         if (OBD_FAIL_CHECK_ONCE(id)) {                                       \
 163                 RETURN(ret);                                                 \
 164         }                                                                    \
 165 } while(0)
 166
 167 #define OBD_FAIL_TIMEOUT(id, secs)                                           \
 168 do {                                                                         \
 169         if  (OBD_FAIL_CHECK_ONCE(id)) {                                      \
 170                 CERROR("obd_fail_timeout id %x sleeping for %d secs\n",     \
 171                        (id), (secs));                                        \
 172                 set_current_state(TASK_UNINTERRUPTIBLE);                     \
 173                 schedule_timeout((secs) * HZ);                               \
 174                 set_current_state(TASK_RUNNING);                             \
 175                 CERROR("obd_fail_timeout id %x awake\n", (id));              \
 176        }                                                                     \
 177 } while(0)
 178
 179 /* The idea here is to synchronise two threads to force a race. The
 180  * first thread that calls this with a matching fail_loc is put to
 181  * sleep. The next thread that calls with the same fail_loc wakes up
 182  * the first and continues. */
 183 #define OBD_RACE(id)                                            \
 184 do {                                                            \
 185         if  (OBD_FAIL_CHECK_ONCE(id)) {                         \
 186                 CERROR("obd_race id %x sleeping\n", (id));      \
 187                 sleep_on(&obd_race_waitq);                      \
 188                 CERROR("obd_fail_race id %x awake\n", (id));    \
 189         } else if ((obd_fail_loc & OBD_FAIL_MASK_LOC) ==        \
 190                     ((id) & OBD_FAIL_MASK_LOC)) {               \
 191                 wake_up(&obd_race_waitq);                       \
 192         }                                                       \
 193 } while(0)
 194
 195 #define fixme() CDEBUG(D_OTHER, "FIXME\n");
 196
 197 #ifdef __KERNEL__
 198 # include <linux/types.h>
 199 # include <linux/blkdev.h>
 200
 201
 202 # if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0))
 203 #  define BDEVNAME_DECLARE_STORAGE(foo) char foo[BDEVNAME_SIZE]
 204 #  define ll_bdevname(SB, STORAGE) __bdevname(kdev_t_to_nr(SB->s_dev), STORAGE)
 205 #  define ll_lock_kernel lock_kernel()
 206 #  define ll_sbdev(SB)    ((SB)->s_bdev)
 207 void dev_set_rdonly(struct block_device *, int);
 208 # else
 209 #  define BDEVNAME_DECLARE_STORAGE(foo) char __unused_##foo
 210 #  define ll_sbdev(SB)    (kdev_t_to_nr((SB)->s_dev))
 211 #  define ll_bdevname(SB,STORAGE) ((void)__unused_##STORAGE,bdevname(ll_sbdev(SB)))
 212 #  define ll_lock_kernel
 213 void dev_set_rdonly(kdev_t, int);
 214 # endif
 215
 216 void dev_clear_rdonly(int);
 217
 218 static inline void OBD_FAIL_WRITE(int id, struct super_block *sb)
 219 {
 220         if (OBD_FAIL_CHECK(id)) {
 221                 BDEVNAME_DECLARE_STORAGE(tmp);
 222                 CERROR("obd_fail_loc=%x, fail write operation on %s\n",
 223                        id, ll_bdevname(sb, tmp));
 224                 dev_set_rdonly(ll_sbdev(sb), 2);
 225                 /* We set FAIL_ONCE because we never "un-fail" a device */
 226                 obd_fail_loc |= OBD_FAILED | OBD_FAIL_ONCE;
 227         }
 228 }
 229 #else /* !__KERNEL__ */
 230 # define LTIME_S(time) (time)
 231 /* for obd_class.h */
 232 # ifndef ERR_PTR
 233 #  define ERR_PTR(a) ((void *)(a))
 234 # endif
 235 #endif  /* __KERNEL__ */
 236
 237 extern atomic_t portal_kmemory;
 238
 239 #define OBD_ALLOC_GFP(ptr, size, gfp_mask)                                    \
 240 do {                                                                          \
 241         (ptr) = kmalloc(size, (gfp_mask));                                    \
 242         if ((ptr) == NULL) {                                                  \
 243                 CERROR("kmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 244                        (int)(size), __FILE__, __LINE__);                      \
 245                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 246                        atomic_read(&obd_memory), atomic_read(&portal_kmemory));\
 247         } else {                                                              \
 248                 memset(ptr, 0, size);                                         \
 249                 atomic_add(size, &obd_memory);                                \
 250                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 251                         obd_memmax = atomic_read(&obd_memory);                \
 252                 CDEBUG(D_MALLOC, "kmalloced '" #ptr "': %d at %p (tot %d)\n", \
 253                        (int)(size), ptr, atomic_read(&obd_memory));           \
 254         }                                                                     \
 255 } while (0)
 256
 257 #ifndef OBD_GFP_MASK
 258 # define OBD_GFP_MASK GFP_NOFS
 259 #endif
 260
 261 #define OBD_ALLOC(ptr, size) OBD_ALLOC_GFP(ptr, size, OBD_GFP_MASK)
 262 #define OBD_ALLOC_WAIT(ptr, size) OBD_ALLOC_GFP(ptr, size, GFP_KERNEL)
 263
 264 #ifdef __arch_um__
 265 # define OBD_VMALLOC(ptr, size) OBD_ALLOC(ptr, size)
 266 #else
 267 # define OBD_VMALLOC(ptr, size)                                               \
 268 do {                                                                          \
 269         (ptr) = vmalloc(size);                                                \
 270         if ((ptr) == NULL) {                                                  \
 271                 CERROR("vmalloc of '" #ptr "' (%d bytes) failed at %s:%d\n",  \
 272                        (int)(size), __FILE__, __LINE__);                      \
 273                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 274                        atomic_read(&obd_memory), atomic_read(&portal_kmemory));\
 275         } else {                                                              \
 276                 memset(ptr, 0, size);                                         \
 277                 atomic_add(size, &obd_memory);                                \
 278                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 279                         obd_memmax = atomic_read(&obd_memory);                \
 280                 CDEBUG(D_MALLOC, "vmalloced '" #ptr "': %d at %p (tot %d)\n", \
 281                        (int)(size), ptr, atomic_read(&obd_memory));           \
 282         }                                                                     \
 283 } while (0)
 284 #endif
 285
 286 #ifdef CONFIG_DEBUG_SLAB
 287 #define POISON(ptr, c, s) do {} while (0)
 288 #else
 289 #define POISON(ptr, c, s) memset(ptr, c, s)
 290 #endif
 291
 292 #if POISON_BULK
 293 #define POISON_PAGE(page, val) do { memset(kmap(page), val, PAGE_SIZE);       \
 294                                     kunmap(page); } while (0)
 295 #else
 296 #define POISON_PAGE(page, val) do { } while (0)
 297 #endif
 298
 299 #define OBD_FREE(ptr, size)                                                   \
 300 do {                                                                          \
 301         LASSERT(ptr);                                                         \
 302         atomic_sub(size, &obd_memory);                                        \
 303         CDEBUG(D_MALLOC, "kfreed '" #ptr "': %d at %p (tot %d).\n",           \
 304                (int)(size), ptr, atomic_read(&obd_memory));                   \
 305         POISON(ptr, 0x5a, size);                                              \
 306         kfree(ptr);                                                           \
 307         (ptr) = (void *)0xdeadbeef;                                           \
 308 } while (0)
 309
 310 #ifdef __arch_um__
 311 # define OBD_VFREE(ptr, size) OBD_FREE(ptr, size)
 312 #else
 313 # define OBD_VFREE(ptr, size)                                                 \
 314 do {                                                                          \
 315         LASSERT(ptr);                                                         \
 316         atomic_sub(size, &obd_memory);                                        \
 317         CDEBUG(D_MALLOC, "vfreed '" #ptr "': %d at %p (tot %d).\n",           \
 318                (int)(size), ptr, atomic_read(&obd_memory));                   \
 319         POISON(ptr, 0x5a, size);                                              \
 320         vfree(ptr);                                                           \
 321         (ptr) = (void *)0xdeadbeef;                                           \
 322 } while (0)
 323 #endif
 324
 325 /* we memset() the slab object to 0 when allocation succeeds, so DO NOT
 326  * HAVE A CTOR THAT DOES ANYTHING.  its work will be cleared here.  we'd
 327  * love to assert on that, but slab.c keeps kmem_cache_s all to itself. */
 328 #define OBD_SLAB_ALLOC(ptr, slab, type, size)                                 \
 329 do {                                                                          \
 330         LASSERT(!in_interrupt());                                             \
 331         (ptr) = kmem_cache_alloc(slab, (type));                               \
 332         if ((ptr) == NULL) {                                                  \
 333                 CERROR("slab-alloc of '"#ptr"' (%d bytes) failed at %s:%d\n", \
 334                        (int)(size), __FILE__, __LINE__);                      \
 335                 CERROR("%d total bytes allocated by Lustre, %d by Portals\n", \
 336                        atomic_read(&obd_memory), atomic_read(&portal_kmemory));\
 337         } else {                                                              \
 338                 memset(ptr, 0, size);                                         \
 339                 atomic_add(size, &obd_memory);                                \
 340                 if (atomic_read(&obd_memory) > obd_memmax)                    \
 341                         obd_memmax = atomic_read(&obd_memory);                \
 342                 CDEBUG(D_MALLOC, "slab-alloced '"#ptr"': %d at %p (tot %d)\n",\
 343                        (int)(size), ptr, atomic_read(&obd_memory));           \
 344         }                                                                     \
 345 } while (0)
 346
 347 #define OBD_SLAB_FREE(ptr, slab, size)                                        \
 348 do {                                                                          \
 349         LASSERT(ptr);                                                         \
 350         CDEBUG(D_MALLOC, "slab-freed '" #ptr "': %d at %p (tot %d).\n",       \
 351                (int)(size), ptr, atomic_read(&obd_memory));                   \
 352         atomic_sub(size, &obd_memory);                                        \
 353         POISON(ptr, 0x5a, size);                                              \
 354         kmem_cache_free(slab, ptr);                                           \
 355         (ptr) = (void *)0xdeadbeef;                                           \
 356 } while (0)
 357
 358 #endif