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