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