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