fs/xfs/xfs_linux.h

   1 /*
   2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #ifndef __XFS_LINUX__
  19 #define __XFS_LINUX__
  20
  21 #include <linux/types.h>
  22
  23 /*
  24  * XFS_BIG_BLKNOS needs block layer disk addresses to be 64 bits.
  25  * XFS_BIG_INUMS requires XFS_BIG_BLKNOS to be set.
  26  */
  27 #if defined(CONFIG_LBDAF) || (BITS_PER_LONG == 64)
  28 # define XFS_BIG_BLKNOS 1
  29 # define XFS_BIG_INUMS  1
  30 #else
  31 # define XFS_BIG_BLKNOS 0
  32 # define XFS_BIG_INUMS  0
  33 #endif
  34
  35 /*
  36  * Kernel specific type declarations for XFS
  37  */
  38 typedef signed char             __int8_t;
  39 typedef unsigned char           __uint8_t;
  40 typedef signed short int        __int16_t;
  41 typedef unsigned short int      __uint16_t;
  42 typedef signed int              __int32_t;
  43 typedef unsigned int            __uint32_t;
  44 typedef signed long long int    __int64_t;
  45 typedef unsigned long long int  __uint64_t;
  46
  47 typedef __uint32_t              inst_t;         /* an instruction */
  48
  49 typedef __s64                   xfs_off_t;      /* <file offset> type */
  50 typedef unsigned long long      xfs_ino_t;      /* <inode> type */
  51 typedef __s64                   xfs_daddr_t;    /* <disk address> type */
  52 typedef char *                  xfs_caddr_t;    /* <core address> type */
  53 typedef __u32                   xfs_dev_t;
  54 typedef __u32                   xfs_nlink_t;
  55
  56 /* __psint_t is the same size as a pointer */
  57 #if (BITS_PER_LONG == 32)
  58 typedef __int32_t __psint_t;
  59 typedef __uint32_t __psunsigned_t;
  60 #elif (BITS_PER_LONG == 64)
  61 typedef __int64_t __psint_t;
  62 typedef __uint64_t __psunsigned_t;
  63 #else
  64 #error BITS_PER_LONG must be 32 or 64
  65 #endif
  66
  67 #include "xfs_types.h"
  68
  69 #include "kmem.h"
  70 #include "mrlock.h"
  71 #include "time.h"
  72 #include "uuid.h"
  73
  74 #include <linux/semaphore.h>
  75 #include <linux/mm.h>
  76 #include <linux/kernel.h>
  77 #include <linux/blkdev.h>
  78 #include <linux/slab.h>
  79 #include <linux/crc32c.h>
  80 #include <linux/module.h>
  81 #include <linux/mutex.h>
  82 #include <linux/file.h>
  83 #include <linux/swap.h>
  84 #include <linux/errno.h>
  85 #include <linux/sched.h>
  86 #include <linux/bitops.h>
  87 #include <linux/major.h>
  88 #include <linux/pagemap.h>
  89 #include <linux/vfs.h>
  90 #include <linux/seq_file.h>
  91 #include <linux/init.h>
  92 #include <linux/list.h>
  93 #include <linux/proc_fs.h>
  94 #include <linux/sort.h>
  95 #include <linux/cpu.h>
  96 #include <linux/notifier.h>
  97 #include <linux/delay.h>
  98 #include <linux/log2.h>
  99 #include <linux/spinlock.h>
 100 #include <linux/random.h>
 101 #include <linux/ctype.h>
 102 #include <linux/writeback.h>
 103 #include <linux/capability.h>
 104 #include <linux/kthread.h>
 105 #include <linux/freezer.h>
 106 #include <linux/list_sort.h>
 107 #include <linux/ratelimit.h>
 108
 109 #include <asm/page.h>
 110 #include <asm/div64.h>
 111 #include <asm/param.h>
 112 #include <asm/uaccess.h>
 113 #include <asm/byteorder.h>
 114 #include <asm/unaligned.h>
 115
 116 #include "xfs_vnode.h"
 117 #include "xfs_stats.h"
 118 #include "xfs_sysctl.h"
 119 #include "xfs_iops.h"
 120 #include "xfs_aops.h"
 121 #include "xfs_super.h"
 122 #include "xfs_cksum.h"
 123 #include "xfs_buf.h"
 124 #include "xfs_message.h"
 125
 126 #ifdef __BIG_ENDIAN
 127 #define XFS_NATIVE_HOST 1
 128 #else
 129 #undef XFS_NATIVE_HOST
 130 #endif
 131
 132 /*
 133  * Feature macros (disable/enable)
 134  */
 135 #ifdef CONFIG_SMP
 136 #define HAVE_PERCPU_SB  /* per cpu superblock counters are a 2.6 feature */
 137 #else
 138 #undef  HAVE_PERCPU_SB  /* per cpu superblock counters are a 2.6 feature */
 139 #endif
 140
 141 #define irix_sgid_inherit       xfs_params.sgid_inherit.val
 142 #define irix_symlink_mode       xfs_params.symlink_mode.val
 143 #define xfs_panic_mask          xfs_params.panic_mask.val
 144 #define xfs_error_level         xfs_params.error_level.val
 145 #define xfs_syncd_centisecs     xfs_params.syncd_timer.val
 146 #define xfs_stats_clear         xfs_params.stats_clear.val
 147 #define xfs_inherit_sync        xfs_params.inherit_sync.val
 148 #define xfs_inherit_nodump      xfs_params.inherit_nodump.val
 149 #define xfs_inherit_noatime     xfs_params.inherit_noatim.val
 150 #define xfs_inherit_nosymlinks  xfs_params.inherit_nosym.val
 151 #define xfs_rotorstep           xfs_params.rotorstep.val
 152 #define xfs_inherit_nodefrag    xfs_params.inherit_nodfrg.val
 153 #define xfs_fstrm_centisecs     xfs_params.fstrm_timer.val
 154 #define xfs_eofb_secs           xfs_params.eofb_timer.val
 155
 156 #define current_cpu()           (raw_smp_processor_id())
 157 #define current_pid()           (current->pid)
 158 #define current_test_flags(f)   (current->flags & (f))
 159 #define current_set_flags_nested(sp, f)         \
 160                 (*(sp) = current->flags, current->flags |= (f))
 161 #define current_clear_flags_nested(sp, f)       \
 162                 (*(sp) = current->flags, current->flags &= ~(f))
 163 #define current_restore_flags_nested(sp, f)     \
 164                 (current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
 165
 166 #define spinlock_destroy(lock)
 167
 168 #define NBBY            8               /* number of bits per byte */
 169
 170 /*
 171  * Size of block device i/o is parameterized here.
 172  * Currently the system supports page-sized i/o.
 173  */
 174 #define BLKDEV_IOSHIFT          PAGE_CACHE_SHIFT
 175 #define BLKDEV_IOSIZE           (1<<BLKDEV_IOSHIFT)
 176 /* number of BB's per block device block */
 177 #define BLKDEV_BB               BTOBB(BLKDEV_IOSIZE)
 178
 179 #define ENOATTR         ENODATA         /* Attribute not found */
 180 #define EWRONGFS        EINVAL          /* Mount with wrong filesystem type */
 181 #define EFSCORRUPTED    EUCLEAN         /* Filesystem is corrupted */
 182 #define EFSBADCRC       EBADMSG         /* Bad CRC detected */
 183
 184 #define SYNCHRONIZE()   barrier()
 185 #define __return_address __builtin_return_address(0)
 186
 187 #define XFS_PROJID_DEFAULT      0
 188 #define MAXPATHLEN      1024
 189
 190 #define MIN(a,b)        (min(a,b))
 191 #define MAX(a,b)        (max(a,b))
 192 #define howmany(x, y)   (((x)+((y)-1))/(y))
 193
 194 /*
 195  * XFS wrapper structure for sysfs support. It depends on external data
 196  * structures and is embedded in various internal data structures to implement
 197  * the XFS sysfs object heirarchy. Define it here for broad access throughout
 198  * the codebase.
 199  */
 200 struct xfs_kobj {
 201         struct kobject          kobject;
 202         struct completion       complete;
 203 };
 204
 205 /* Kernel uid/gid conversion. These are used to convert to/from the on disk
 206  * uid_t/gid_t types to the kuid_t/kgid_t types that the kernel uses internally.
 207  * The conversion here is type only, the value will remain the same since we
 208  * are converting to the init_user_ns. The uid is later mapped to a particular
 209  * user namespace value when crossing the kernel/user boundary.
 210  */
 211 static inline __uint32_t xfs_kuid_to_uid(kuid_t uid)
 212 {
 213         return from_kuid(&init_user_ns, uid);
 214 }
 215
 216 static inline kuid_t xfs_uid_to_kuid(__uint32_t uid)
 217 {
 218         return make_kuid(&init_user_ns, uid);
 219 }
 220
 221 static inline __uint32_t xfs_kgid_to_gid(kgid_t gid)
 222 {
 223         return from_kgid(&init_user_ns, gid);
 224 }
 225
 226 static inline kgid_t xfs_gid_to_kgid(__uint32_t gid)
 227 {
 228         return make_kgid(&init_user_ns, gid);
 229 }
 230
 231 /*
 232  * Various platform dependent calls that don't fit anywhere else
 233  */
 234 #define xfs_sort(a,n,s,fn)      sort(a,n,s,fn,NULL)
 235 #define xfs_stack_trace()       dump_stack()
 236
 237
 238 /* Move the kernel do_div definition off to one side */
 239
 240 #if defined __i386__
 241 /* For ia32 we need to pull some tricks to get past various versions
 242  * of the compiler which do not like us using do_div in the middle
 243  * of large functions.
 244  */
 245 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
 246 {
 247         __u32   mod;
 248
 249         switch (n) {
 250                 case 4:
 251                         mod = *(__u32 *)a % b;
 252                         *(__u32 *)a = *(__u32 *)a / b;
 253                         return mod;
 254                 case 8:
 255                         {
 256                         unsigned long __upper, __low, __high, __mod;
 257                         __u64   c = *(__u64 *)a;
 258                         __upper = __high = c >> 32;
 259                         __low = c;
 260                         if (__high) {
 261                                 __upper = __high % (b);
 262                                 __high = __high / (b);
 263                         }
 264                         asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
 265                         asm("":"=A" (c):"a" (__low),"d" (__high));
 266                         *(__u64 *)a = c;
 267                         return __mod;
 268                         }
 269         }
 270
 271         /* NOTREACHED */
 272         return 0;
 273 }
 274
 275 /* Side effect free 64 bit mod operation */
 276 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 277 {
 278         switch (n) {
 279                 case 4:
 280                         return *(__u32 *)a % b;
 281                 case 8:
 282                         {
 283                         unsigned long __upper, __low, __high, __mod;
 284                         __u64   c = *(__u64 *)a;
 285                         __upper = __high = c >> 32;
 286                         __low = c;
 287                         if (__high) {
 288                                 __upper = __high % (b);
 289                                 __high = __high / (b);
 290                         }
 291                         asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
 292                         asm("":"=A" (c):"a" (__low),"d" (__high));
 293                         return __mod;
 294                         }
 295         }
 296
 297         /* NOTREACHED */
 298         return 0;
 299 }
 300 #else
 301 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
 302 {
 303         __u32   mod;
 304
 305         switch (n) {
 306                 case 4:
 307                         mod = *(__u32 *)a % b;
 308                         *(__u32 *)a = *(__u32 *)a / b;
 309                         return mod;
 310                 case 8:
 311                         mod = do_div(*(__u64 *)a, b);
 312                         return mod;
 313         }
 314
 315         /* NOTREACHED */
 316         return 0;
 317 }
 318
 319 /* Side effect free 64 bit mod operation */
 320 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 321 {
 322         switch (n) {
 323                 case 4:
 324                         return *(__u32 *)a % b;
 325                 case 8:
 326                         {
 327                         __u64   c = *(__u64 *)a;
 328                         return do_div(c, b);
 329                         }
 330         }
 331
 332         /* NOTREACHED */
 333         return 0;
 334 }
 335 #endif
 336
 337 #undef do_div
 338 #define do_div(a, b)    xfs_do_div(&(a), (b), sizeof(a))
 339 #define do_mod(a, b)    xfs_do_mod(&(a), (b), sizeof(a))
 340
 341 static inline __uint64_t roundup_64(__uint64_t x, __uint32_t y)
 342 {
 343         x += y - 1;
 344         do_div(x, y);
 345         return x * y;
 346 }
 347
 348 static inline __uint64_t howmany_64(__uint64_t x, __uint32_t y)
 349 {
 350         x += y - 1;
 351         do_div(x, y);
 352         return x;
 353 }
 354
 355 /* ARM old ABI has some weird alignment/padding */
 356 #if defined(__arm__) && !defined(__ARM_EABI__)
 357 #define __arch_pack __attribute__((packed))
 358 #else
 359 #define __arch_pack
 360 #endif
 361
 362 #define ASSERT_ALWAYS(expr)     \
 363         (unlikely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
 364
 365 #ifdef DEBUG
 366 #define ASSERT(expr)    \
 367         (unlikely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
 368
 369 #ifndef STATIC
 370 # define STATIC noinline
 371 #endif
 372
 373 #else   /* !DEBUG */
 374
 375 #ifdef XFS_WARN
 376
 377 #define ASSERT(expr)    \
 378         (unlikely(expr) ? (void)0 : asswarn(#expr, __FILE__, __LINE__))
 379
 380 #ifndef STATIC
 381 # define STATIC static noinline
 382 #endif
 383
 384 #else   /* !DEBUG && !XFS_WARN */
 385
 386 #define ASSERT(expr)    ((void)0)
 387
 388 #ifndef STATIC
 389 # define STATIC static noinline
 390 #endif
 391
 392 #endif /* XFS_WARN */
 393 #endif /* DEBUG */
 394
 395 #endif /* __XFS_LINUX__ */