fs/xfs/linux-2.6/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 #include <linux/config.h>
  23
  24 /*
  25  * Some types are conditional depending on the target system.
  26  * XFS_BIG_BLKNOS needs block layer disk addresses to be 64 bits.
  27  * XFS_BIG_INUMS needs the VFS inode number to be 64 bits, as well
  28  * as requiring XFS_BIG_BLKNOS to be set.
  29  */
  30 #if defined(CONFIG_LBD) || (BITS_PER_LONG == 64)
  31 # define XFS_BIG_BLKNOS 1
  32 # if BITS_PER_LONG == 64
  33 #  define XFS_BIG_INUMS 1
  34 # else
  35 #  define XFS_BIG_INUMS 0
  36 # endif
  37 #else
  38 # define XFS_BIG_BLKNOS 0
  39 # define XFS_BIG_INUMS  0
  40 #endif
  41
  42 #include <xfs_types.h>
  43 #include <xfs_arch.h>
  44
  45 #include <kmem.h>
  46 #include <mrlock.h>
  47 #include <spin.h>
  48 #include <sv.h>
  49 #include <mutex.h>
  50 #include <sema.h>
  51 #include <time.h>
  52
  53 #include <support/ktrace.h>
  54 #include <support/debug.h>
  55 #include <support/move.h>
  56 #include <support/uuid.h>
  57
  58 #include <linux/mm.h>
  59 #include <linux/kernel.h>
  60 #include <linux/blkdev.h>
  61 #include <linux/slab.h>
  62 #include <linux/module.h>
  63 #include <linux/file.h>
  64 #include <linux/swap.h>
  65 #include <linux/errno.h>
  66 #include <linux/sched.h>
  67 #include <linux/bitops.h>
  68 #include <linux/major.h>
  69 #include <linux/pagemap.h>
  70 #include <linux/vfs.h>
  71 #include <linux/seq_file.h>
  72 #include <linux/init.h>
  73 #include <linux/list.h>
  74 #include <linux/proc_fs.h>
  75 #include <linux/sort.h>
  76 #include <linux/cpu.h>
  77 #include <linux/notifier.h>
  78 #include <linux/delay.h>
  79
  80 #include <asm/page.h>
  81 #include <asm/div64.h>
  82 #include <asm/param.h>
  83 #include <asm/uaccess.h>
  84 #include <asm/byteorder.h>
  85 #include <asm/unaligned.h>
  86
  87 #include <xfs_behavior.h>
  88 #include <xfs_vfs.h>
  89 #include <xfs_cred.h>
  90 #include <xfs_vnode.h>
  91 #include <xfs_stats.h>
  92 #include <xfs_sysctl.h>
  93 #include <xfs_iops.h>
  94 #include <xfs_aops.h>
  95 #include <xfs_super.h>
  96 #include <xfs_globals.h>
  97 #include <xfs_fs_subr.h>
  98 #include <xfs_lrw.h>
  99 #include <xfs_buf.h>
 100
 101 /*
 102  * Feature macros (disable/enable)
 103  */
 104 #undef  HAVE_REFCACHE   /* reference cache not needed for NFS in 2.6 */
 105 #define HAVE_SENDFILE   /* sendfile(2) exists in 2.6, but not in 2.4 */
 106 #define HAVE_SPLICE     /* a splice(2) exists in 2.6, but not in 2.4 */
 107 #ifdef CONFIG_SMP
 108 #define HAVE_PERCPU_SB  /* per cpu superblock counters are a 2.6 feature */
 109 #else
 110 #undef  HAVE_PERCPU_SB  /* per cpu superblock counters are a 2.6 feature */
 111 #endif
 112
 113 /*
 114  * State flag for unwritten extent buffers.
 115  *
 116  * We need to be able to distinguish between these and delayed
 117  * allocate buffers within XFS.  The generic IO path code does
 118  * not need to distinguish - we use the BH_Delay flag for both
 119  * delalloc and these ondisk-uninitialised buffers.
 120  */
 121 BUFFER_FNS(PrivateStart, unwritten);
 122
 123 #define restricted_chown        xfs_params.restrict_chown.val
 124 #define irix_sgid_inherit       xfs_params.sgid_inherit.val
 125 #define irix_symlink_mode       xfs_params.symlink_mode.val
 126 #define xfs_panic_mask          xfs_params.panic_mask.val
 127 #define xfs_error_level         xfs_params.error_level.val
 128 #define xfs_syncd_centisecs     xfs_params.syncd_timer.val
 129 #define xfs_stats_clear         xfs_params.stats_clear.val
 130 #define xfs_inherit_sync        xfs_params.inherit_sync.val
 131 #define xfs_inherit_nodump      xfs_params.inherit_nodump.val
 132 #define xfs_inherit_noatime     xfs_params.inherit_noatim.val
 133 #define xfs_buf_timer_centisecs xfs_params.xfs_buf_timer.val
 134 #define xfs_buf_age_centisecs   xfs_params.xfs_buf_age.val
 135 #define xfs_inherit_nosymlinks  xfs_params.inherit_nosym.val
 136 #define xfs_rotorstep           xfs_params.rotorstep.val
 137
 138 #ifndef raw_smp_processor_id
 139 #define raw_smp_processor_id()  smp_processor_id()
 140 #endif
 141 #define current_cpu()           raw_smp_processor_id()
 142 #define current_pid()           (current->pid)
 143 #define current_fsuid(cred)     (current->fsuid)
 144 #define current_fsgid(cred)     (current->fsgid)
 145
 146 #define NBPP            PAGE_SIZE
 147 #define DPPSHFT         (PAGE_SHIFT - 9)
 148 #define NDPP            (1 << (PAGE_SHIFT - 9))
 149 #define dtop(DD)        (((DD) + NDPP - 1) >> DPPSHFT)
 150 #define dtopt(DD)       ((DD) >> DPPSHFT)
 151 #define dpoff(DD)       ((DD) & (NDPP-1))
 152
 153 #define NBBY            8               /* number of bits per byte */
 154 #define NBPC            PAGE_SIZE       /* Number of bytes per click */
 155 #define BPCSHIFT        PAGE_SHIFT      /* LOG2(NBPC) if exact */
 156
 157 /*
 158  * Size of block device i/o is parameterized here.
 159  * Currently the system supports page-sized i/o.
 160  */
 161 #define BLKDEV_IOSHIFT          BPCSHIFT
 162 #define BLKDEV_IOSIZE           (1<<BLKDEV_IOSHIFT)
 163 /* number of BB's per block device block */
 164 #define BLKDEV_BB               BTOBB(BLKDEV_IOSIZE)
 165
 166 /* bytes to clicks */
 167 #define btoc(x)         (((__psunsigned_t)(x)+(NBPC-1))>>BPCSHIFT)
 168 #define btoct(x)        ((__psunsigned_t)(x)>>BPCSHIFT)
 169 #define btoc64(x)       (((__uint64_t)(x)+(NBPC-1))>>BPCSHIFT)
 170 #define btoct64(x)      ((__uint64_t)(x)>>BPCSHIFT)
 171 #define io_btoc(x)      (((__psunsigned_t)(x)+(IO_NBPC-1))>>IO_BPCSHIFT)
 172 #define io_btoct(x)     ((__psunsigned_t)(x)>>IO_BPCSHIFT)
 173
 174 /* off_t bytes to clicks */
 175 #define offtoc(x)       (((__uint64_t)(x)+(NBPC-1))>>BPCSHIFT)
 176 #define offtoct(x)      ((xfs_off_t)(x)>>BPCSHIFT)
 177
 178 /* clicks to off_t bytes */
 179 #define ctooff(x)       ((xfs_off_t)(x)<<BPCSHIFT)
 180
 181 /* clicks to bytes */
 182 #define ctob(x)         ((__psunsigned_t)(x)<<BPCSHIFT)
 183 #define btoct(x)        ((__psunsigned_t)(x)>>BPCSHIFT)
 184 #define ctob64(x)       ((__uint64_t)(x)<<BPCSHIFT)
 185 #define io_ctob(x)      ((__psunsigned_t)(x)<<IO_BPCSHIFT)
 186
 187 /* bytes to clicks */
 188 #define btoc(x)         (((__psunsigned_t)(x)+(NBPC-1))>>BPCSHIFT)
 189
 190 #ifndef ENOATTR
 191 #define ENOATTR         ENODATA         /* Attribute not found */
 192 #endif
 193
 194 /* Note: EWRONGFS never visible outside the kernel */
 195 #define EWRONGFS        EINVAL          /* Mount with wrong filesystem type */
 196
 197 /*
 198  * XXX EFSCORRUPTED needs a real value in errno.h. asm-i386/errno.h won't
 199  *     return codes out of its known range in errno.
 200  * XXX Also note: needs to be < 1000 and fairly unique on Linux (mustn't
 201  *     conflict with any code we use already or any code a driver may use)
 202  * XXX Some options (currently we do #2):
 203  *      1/ New error code ["Filesystem is corrupted", _after_ glibc updated]
 204  *      2/ 990 ["Unknown error 990"]
 205  *      3/ EUCLEAN ["Structure needs cleaning"]
 206  *      4/ Convert EFSCORRUPTED to EIO [just prior to return into userspace]
 207  */
 208 #define EFSCORRUPTED    990             /* Filesystem is corrupted */
 209
 210 #define SYNCHRONIZE()   barrier()
 211 #define __return_address __builtin_return_address(0)
 212
 213 /*
 214  * IRIX (BSD) quotactl makes use of separate commands for user/group,
 215  * whereas on Linux the syscall encodes this information into the cmd
 216  * field (see the QCMD macro in quota.h).  These macros help keep the
 217  * code portable - they are not visible from the syscall interface.
 218  */
 219 #define Q_XSETGQLIM     XQM_CMD(8)      /* set groups disk limits */
 220 #define Q_XGETGQUOTA    XQM_CMD(9)      /* get groups disk limits */
 221 #define Q_XSETPQLIM     XQM_CMD(10)     /* set projects disk limits */
 222 #define Q_XGETPQUOTA    XQM_CMD(11)     /* get projects disk limits */
 223
 224 #define dfltprid        0
 225 #define MAXPATHLEN      1024
 226
 227 #define MIN(a,b)        (min(a,b))
 228 #define MAX(a,b)        (max(a,b))
 229 #define howmany(x, y)   (((x)+((y)-1))/(y))
 230 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
 231
 232 /*
 233  * Various platform dependent calls that don't fit anywhere else
 234  */
 235 #define xfs_sort(a,n,s,fn)      sort(a,n,s,fn,NULL)
 236 #define xfs_stack_trace()       dump_stack()
 237 #define xfs_itruncate_data(ip, off)     \
 238         (-vmtruncate(vn_to_inode(XFS_ITOV(ip)), (off)))
 239 #define xfs_statvfs_fsid(statp, mp)     \
 240         ({ u64 id = huge_encode_dev((mp)->m_ddev_targp->bt_dev); \
 241            __kernel_fsid_t *fsid = &(statp)->f_fsid;    \
 242         (fsid->val[0] = (u32)id, fsid->val[1] = (u32)(id >> 32)); })
 243
 244
 245 /* Move the kernel do_div definition off to one side */
 246
 247 #if defined __i386__
 248 /* For ia32 we need to pull some tricks to get past various versions
 249  * of the compiler which do not like us using do_div in the middle
 250  * of large functions.
 251  */
 252 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
 253 {
 254         __u32   mod;
 255
 256         switch (n) {
 257                 case 4:
 258                         mod = *(__u32 *)a % b;
 259                         *(__u32 *)a = *(__u32 *)a / b;
 260                         return mod;
 261                 case 8:
 262                         {
 263                         unsigned long __upper, __low, __high, __mod;
 264                         __u64   c = *(__u64 *)a;
 265                         __upper = __high = c >> 32;
 266                         __low = c;
 267                         if (__high) {
 268                                 __upper = __high % (b);
 269                                 __high = __high / (b);
 270                         }
 271                         asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
 272                         asm("":"=A" (c):"a" (__low),"d" (__high));
 273                         *(__u64 *)a = c;
 274                         return __mod;
 275                         }
 276         }
 277
 278         /* NOTREACHED */
 279         return 0;
 280 }
 281
 282 /* Side effect free 64 bit mod operation */
 283 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 284 {
 285         switch (n) {
 286                 case 4:
 287                         return *(__u32 *)a % b;
 288                 case 8:
 289                         {
 290                         unsigned long __upper, __low, __high, __mod;
 291                         __u64   c = *(__u64 *)a;
 292                         __upper = __high = c >> 32;
 293                         __low = c;
 294                         if (__high) {
 295                                 __upper = __high % (b);
 296                                 __high = __high / (b);
 297                         }
 298                         asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
 299                         asm("":"=A" (c):"a" (__low),"d" (__high));
 300                         return __mod;
 301                         }
 302         }
 303
 304         /* NOTREACHED */
 305         return 0;
 306 }
 307 #else
 308 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
 309 {
 310         __u32   mod;
 311
 312         switch (n) {
 313                 case 4:
 314                         mod = *(__u32 *)a % b;
 315                         *(__u32 *)a = *(__u32 *)a / b;
 316                         return mod;
 317                 case 8:
 318                         mod = do_div(*(__u64 *)a, b);
 319                         return mod;
 320         }
 321
 322         /* NOTREACHED */
 323         return 0;
 324 }
 325
 326 /* Side effect free 64 bit mod operation */
 327 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 328 {
 329         switch (n) {
 330                 case 4:
 331                         return *(__u32 *)a % b;
 332                 case 8:
 333                         {
 334                         __u64   c = *(__u64 *)a;
 335                         return do_div(c, b);
 336                         }
 337         }
 338
 339         /* NOTREACHED */
 340         return 0;
 341 }
 342 #endif
 343
 344 #undef do_div
 345 #define do_div(a, b)    xfs_do_div(&(a), (b), sizeof(a))
 346 #define do_mod(a, b)    xfs_do_mod(&(a), (b), sizeof(a))
 347
 348 static inline __uint64_t roundup_64(__uint64_t x, __uint32_t y)
 349 {
 350         x += y - 1;
 351         do_div(x, y);
 352         return(x * y);
 353 }
 354
 355 #endif /* __XFS_LINUX__ */