fs/xfs/linux/xfs_linux.h

   1 /*
   2  * Copyright (c) 2000-2003 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32 #ifndef __XFS_LINUX__
  33 #define __XFS_LINUX__
  34
  35 #include <linux/types.h>
  36 #include <linux/config.h>
  37
  38 /*
  39  * Some types are conditional depending on the target system.
  40  * XFS_BIG_BLKNOS needs block layer disk addresses to be 64 bits.
  41  * XFS_BIG_INUMS needs the VFS inode number to be 64 bits, as well
  42  * as requiring XFS_BIG_BLKNOS to be set.
  43  */
  44 #if defined(CONFIG_LBD) || (BITS_PER_LONG == 64)
  45 # define XFS_BIG_BLKNOS 1
  46 # if BITS_PER_LONG == 64
  47 #  define XFS_BIG_INUMS 1
  48 # else
  49 #  define XFS_BIG_INUMS 0
  50 # endif
  51 #else
  52 # define XFS_BIG_BLKNOS 0
  53 # define XFS_BIG_INUMS  0
  54 #endif
  55
  56 #include <xfs_types.h>
  57 #include <xfs_arch.h>
  58
  59 #include <kmem.h>
  60 #include <mrlock.h>
  61 #include <spin.h>
  62 #include <sv.h>
  63 #include <mutex.h>
  64 #include <sema.h>
  65 #include <time.h>
  66
  67 #include <support/qsort.h>
  68 #include <support/ktrace.h>
  69 #include <support/debug.h>
  70 #include <support/move.h>
  71 #include <support/uuid.h>
  72
  73 #include <linux/mm.h>
  74 #include <linux/kernel.h>
  75 #include <linux/blkdev.h>
  76 #include <linux/slab.h>
  77 #include <linux/module.h>
  78 #include <linux/file.h>
  79 #include <linux/swap.h>
  80 #include <linux/errno.h>
  81 #include <linux/sched.h>
  82 #include <linux/bitops.h>
  83 #include <linux/major.h>
  84 #include <linux/pagemap.h>
  85 #include <linux/vfs.h>
  86 #include <linux/seq_file.h>
  87 #include <linux/init.h>
  88 #include <linux/proc_fs.h>
  89 #include <linux/version.h>
  90
  91 #include <asm/page.h>
  92 #include <asm/div64.h>
  93 #include <asm/param.h>
  94 #include <asm/uaccess.h>
  95 #include <asm/byteorder.h>
  96 #include <asm/unaligned.h>
  97
  98 #include <xfs_behavior.h>
  99 #include <xfs_vfs.h>
 100 #include <xfs_cred.h>
 101 #include <xfs_vnode.h>
 102 #include <xfs_stats.h>
 103 #include <xfs_sysctl.h>
 104 #include <xfs_iops.h>
 105 #include <xfs_super.h>
 106 #include <xfs_globals.h>
 107 #include <xfs_fs_subr.h>
 108 #include <xfs_lrw.h>
 109 #include <xfs_buf.h>
 110
 111 /*
 112  * Feature macros (disable/enable)
 113  */
 114 #undef  HAVE_REFCACHE   /* reference cache not needed for NFS in 2.6 */
 115 #define HAVE_SENDFILE   /* sendfile(2) exists in 2.6, but not in 2.4 */
 116
 117 /*
 118  * State flag for unwritten extent buffers.
 119  *
 120  * We need to be able to distinguish between these and delayed
 121  * allocate buffers within XFS.  The generic IO path code does
 122  * not need to distinguish - we use the BH_Delay flag for both
 123  * delalloc and these ondisk-uninitialised buffers.
 124  */
 125 BUFFER_FNS(PrivateStart, unwritten);
 126 static inline void set_buffer_unwritten_io(struct buffer_head *bh)
 127 {
 128         bh->b_end_io = linvfs_unwritten_done;
 129 }
 130
 131 #define xfs_refcache_size       xfs_params.refcache_size.val
 132 #define xfs_refcache_purge_count xfs_params.refcache_purge.val
 133 #define restricted_chown        xfs_params.restrict_chown.val
 134 #define irix_sgid_inherit       xfs_params.sgid_inherit.val
 135 #define irix_symlink_mode       xfs_params.symlink_mode.val
 136 #define xfs_panic_mask          xfs_params.panic_mask.val
 137 #define xfs_error_level         xfs_params.error_level.val
 138 #define xfs_syncd_interval      (xfs_params.sync_interval.val * HZ / USER_HZ)
 139 #define xfs_stats_clear         xfs_params.stats_clear.val
 140 #define xfs_inherit_sync        xfs_params.inherit_sync.val
 141 #define xfs_inherit_nodump      xfs_params.inherit_nodump.val
 142 #define xfs_inherit_noatime     xfs_params.inherit_noatim.val
 143 #define xfs_flush_interval      (xfs_params.flush_interval.val * HZ / USER_HZ)
 144 #define xfs_age_buffer          (xfs_params.age_buffer.val * HZ / USER_HZ)
 145
 146 #define current_cpu()           smp_processor_id()
 147 #define current_pid()           (current->pid)
 148 #define current_fsuid(cred)     (current->fsuid)
 149 #define current_fsgid(cred)     (current->fsgid)
 150
 151 #define NBPP            PAGE_SIZE
 152 #define DPPSHFT         (PAGE_SHIFT - 9)
 153 #define NDPP            (1 << (PAGE_SHIFT - 9))
 154 #define dtop(DD)        (((DD) + NDPP - 1) >> DPPSHFT)
 155 #define dtopt(DD)       ((DD) >> DPPSHFT)
 156 #define dpoff(DD)       ((DD) & (NDPP-1))
 157
 158 #define NBBY            8               /* number of bits per byte */
 159 #define NBPC            PAGE_SIZE       /* Number of bytes per click */
 160 #define BPCSHIFT        PAGE_SHIFT      /* LOG2(NBPC) if exact */
 161
 162 /*
 163  * Size of block device i/o is parameterized here.
 164  * Currently the system supports page-sized i/o.
 165  */
 166 #define BLKDEV_IOSHIFT          BPCSHIFT
 167 #define BLKDEV_IOSIZE           (1<<BLKDEV_IOSHIFT)
 168 /* number of BB's per block device block */
 169 #define BLKDEV_BB               BTOBB(BLKDEV_IOSIZE)
 170
 171 /* bytes to clicks */
 172 #define btoc(x)         (((__psunsigned_t)(x)+(NBPC-1))>>BPCSHIFT)
 173 #define btoct(x)        ((__psunsigned_t)(x)>>BPCSHIFT)
 174 #define btoc64(x)       (((__uint64_t)(x)+(NBPC-1))>>BPCSHIFT)
 175 #define btoct64(x)      ((__uint64_t)(x)>>BPCSHIFT)
 176 #define io_btoc(x)      (((__psunsigned_t)(x)+(IO_NBPC-1))>>IO_BPCSHIFT)
 177 #define io_btoct(x)     ((__psunsigned_t)(x)>>IO_BPCSHIFT)
 178
 179 /* off_t bytes to clicks */
 180 #define offtoc(x)       (((__uint64_t)(x)+(NBPC-1))>>BPCSHIFT)
 181 #define offtoct(x)      ((xfs_off_t)(x)>>BPCSHIFT)
 182
 183 /* clicks to off_t bytes */
 184 #define ctooff(x)       ((xfs_off_t)(x)<<BPCSHIFT)
 185
 186 /* clicks to bytes */
 187 #define ctob(x)         ((__psunsigned_t)(x)<<BPCSHIFT)
 188 #define btoct(x)        ((__psunsigned_t)(x)>>BPCSHIFT)
 189 #define ctob64(x)       ((__uint64_t)(x)<<BPCSHIFT)
 190 #define io_ctob(x)      ((__psunsigned_t)(x)<<IO_BPCSHIFT)
 191
 192 /* bytes to clicks */
 193 #define btoc(x)         (((__psunsigned_t)(x)+(NBPC-1))>>BPCSHIFT)
 194
 195 #ifndef CELL_CAPABLE
 196 #define FSC_NOTIFY_NAME_CHANGED(vp)
 197 #endif
 198
 199 #ifndef ENOATTR
 200 #define ENOATTR         ENODATA         /* Attribute not found */
 201 #endif
 202
 203 /* Note: EWRONGFS never visible outside the kernel */
 204 #define EWRONGFS        EINVAL          /* Mount with wrong filesystem type */
 205
 206 /*
 207  * XXX EFSCORRUPTED needs a real value in errno.h. asm-i386/errno.h won't
 208  *     return codes out of its known range in errno.
 209  * XXX Also note: needs to be < 1000 and fairly unique on Linux (mustn't
 210  *     conflict with any code we use already or any code a driver may use)
 211  * XXX Some options (currently we do #2):
 212  *      1/ New error code ["Filesystem is corrupted", _after_ glibc updated]
 213  *      2/ 990 ["Unknown error 990"]
 214  *      3/ EUCLEAN ["Structure needs cleaning"]
 215  *      4/ Convert EFSCORRUPTED to EIO [just prior to return into userspace]
 216  */
 217 #define EFSCORRUPTED    990             /* Filesystem is corrupted */
 218
 219 #define SYNCHRONIZE()   barrier()
 220 #define __return_address __builtin_return_address(0)
 221
 222 /*
 223  * IRIX (BSD) quotactl makes use of separate commands for user/group,
 224  * whereas on Linux the syscall encodes this information into the cmd
 225  * field (see the QCMD macro in quota.h).  These macros help keep the
 226  * code portable - they are not visible from the syscall interface.
 227  */
 228 #define Q_XSETGQLIM     XQM_CMD(0x8)    /* set groups disk limits */
 229 #define Q_XGETGQUOTA    XQM_CMD(0x9)    /* get groups disk limits */
 230
 231 /* IRIX uses a dynamic sizing algorithm (ndquot = 200 + numprocs*2) */
 232 /* we may well need to fine-tune this if it ever becomes an issue.  */
 233 #define DQUOT_MAX_HEURISTIC     1024    /* NR_DQUOTS */
 234 #define ndquot                  DQUOT_MAX_HEURISTIC
 235
 236 /* IRIX uses the current size of the name cache to guess a good value */
 237 /* - this isn't the same but is a good enough starting point for now. */
 238 #define DQUOT_HASH_HEURISTIC    files_stat.nr_files
 239
 240 /* IRIX inodes maintain the project ID also, zero this field on Linux */
 241 #define DEFAULT_PROJID  0
 242 #define dfltprid        DEFAULT_PROJID
 243
 244 #define MAXPATHLEN      1024
 245
 246 #define MIN(a,b)        (min(a,b))
 247 #define MAX(a,b)        (max(a,b))
 248 #define howmany(x, y)   (((x)+((y)-1))/(y))
 249 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
 250
 251 #define xfs_stack_trace()       dump_stack()
 252
 253 #define xfs_itruncate_data(ip, off)     \
 254         (-vmtruncate(LINVFS_GET_IP(XFS_ITOV(ip)), (off)))
 255
 256
 257 /* Move the kernel do_div definition off to one side */
 258
 259 #if defined __i386__
 260 /* For ia32 we need to pull some tricks to get past various versions
 261  * of the compiler which do not like us using do_div in the middle
 262  * of large functions.
 263  */
 264 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
 265 {
 266         __u32   mod;
 267
 268         switch (n) {
 269                 case 4:
 270                         mod = *(__u32 *)a % b;
 271                         *(__u32 *)a = *(__u32 *)a / b;
 272                         return mod;
 273                 case 8:
 274                         {
 275                         unsigned long __upper, __low, __high, __mod;
 276                         __u64   c = *(__u64 *)a;
 277                         __upper = __high = c >> 32;
 278                         __low = c;
 279                         if (__high) {
 280                                 __upper = __high % (b);
 281                                 __high = __high / (b);
 282                         }
 283                         asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
 284                         asm("":"=A" (c):"a" (__low),"d" (__high));
 285                         *(__u64 *)a = c;
 286                         return __mod;
 287                         }
 288         }
 289
 290         /* NOTREACHED */
 291         return 0;
 292 }
 293
 294 /* Side effect free 64 bit mod operation */
 295 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 296 {
 297         switch (n) {
 298                 case 4:
 299                         return *(__u32 *)a % b;
 300                 case 8:
 301                         {
 302                         unsigned long __upper, __low, __high, __mod;
 303                         __u64   c = *(__u64 *)a;
 304                         __upper = __high = c >> 32;
 305                         __low = c;
 306                         if (__high) {
 307                                 __upper = __high % (b);
 308                                 __high = __high / (b);
 309                         }
 310                         asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
 311                         asm("":"=A" (c):"a" (__low),"d" (__high));
 312                         return __mod;
 313                         }
 314         }
 315
 316         /* NOTREACHED */
 317         return 0;
 318 }
 319 #else
 320 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
 321 {
 322         __u32   mod;
 323
 324         switch (n) {
 325                 case 4:
 326                         mod = *(__u32 *)a % b;
 327                         *(__u32 *)a = *(__u32 *)a / b;
 328                         return mod;
 329                 case 8:
 330                         mod = do_div(*(__u64 *)a, b);
 331                         return mod;
 332         }
 333
 334         /* NOTREACHED */
 335         return 0;
 336 }
 337
 338 /* Side effect free 64 bit mod operation */
 339 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 340 {
 341         switch (n) {
 342                 case 4:
 343                         return *(__u32 *)a % b;
 344                 case 8:
 345                         {
 346                         __u64   c = *(__u64 *)a;
 347                         return do_div(c, b);
 348                         }
 349         }
 350
 351         /* NOTREACHED */
 352         return 0;
 353 }
 354 #endif
 355
 356 #undef do_div
 357 #define do_div(a, b)    xfs_do_div(&(a), (b), sizeof(a))
 358 #define do_mod(a, b)    xfs_do_mod(&(a), (b), sizeof(a))
 359
 360 static inline __uint64_t roundup_64(__uint64_t x, __uint32_t y)
 361 {
 362         x += y - 1;
 363         do_div(x, y);
 364         return(x * y);
 365 }
 366
 367 #endif /* __XFS_LINUX__ */