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 #include <linux/uuid.h>
  23
  24 /*
  25  * Kernel specific type declarations for XFS
  26  */
  27
  28 typedef __s64                   xfs_off_t;      /* <file offset> type */
  29 typedef unsigned long long      xfs_ino_t;      /* <inode> type */
  30 typedef __s64                   xfs_daddr_t;    /* <disk address> type */
  31 typedef __u32                   xfs_dev_t;
  32 typedef __u32                   xfs_nlink_t;
  33
  34 #include "xfs_types.h"
  35
  36 #include "kmem.h"
  37 #include "mrlock.h"
  38
  39 #include <linux/semaphore.h>
  40 #include <linux/mm.h>
  41 #include <linux/kernel.h>
  42 #include <linux/blkdev.h>
  43 #include <linux/slab.h>
  44 #include <linux/crc32c.h>
  45 #include <linux/module.h>
  46 #include <linux/mutex.h>
  47 #include <linux/file.h>
  48 #include <linux/swap.h>
  49 #include <linux/errno.h>
  50 #include <linux/sched/signal.h>
  51 #include <linux/bitops.h>
  52 #include <linux/major.h>
  53 #include <linux/pagemap.h>
  54 #include <linux/vfs.h>
  55 #include <linux/seq_file.h>
  56 #include <linux/init.h>
  57 #include <linux/list.h>
  58 #include <linux/proc_fs.h>
  59 #include <linux/sort.h>
  60 #include <linux/cpu.h>
  61 #include <linux/notifier.h>
  62 #include <linux/delay.h>
  63 #include <linux/log2.h>
  64 #include <linux/spinlock.h>
  65 #include <linux/random.h>
  66 #include <linux/ctype.h>
  67 #include <linux/writeback.h>
  68 #include <linux/capability.h>
  69 #include <linux/kthread.h>
  70 #include <linux/freezer.h>
  71 #include <linux/list_sort.h>
  72 #include <linux/ratelimit.h>
  73 #include <linux/rhashtable.h>
  74
  75 #include <asm/page.h>
  76 #include <asm/div64.h>
  77 #include <asm/param.h>
  78 #include <linux/uaccess.h>
  79 #include <asm/byteorder.h>
  80 #include <asm/unaligned.h>
  81
  82 #include "xfs_fs.h"
  83 #include "xfs_stats.h"
  84 #include "xfs_sysctl.h"
  85 #include "xfs_iops.h"
  86 #include "xfs_aops.h"
  87 #include "xfs_super.h"
  88 #include "xfs_cksum.h"
  89 #include "xfs_buf.h"
  90 #include "xfs_message.h"
  91
  92 #ifdef __BIG_ENDIAN
  93 #define XFS_NATIVE_HOST 1
  94 #else
  95 #undef XFS_NATIVE_HOST
  96 #endif
  97
  98 #define irix_sgid_inherit       xfs_params.sgid_inherit.val
  99 #define irix_symlink_mode       xfs_params.symlink_mode.val
 100 #define xfs_panic_mask          xfs_params.panic_mask.val
 101 #define xfs_error_level         xfs_params.error_level.val
 102 #define xfs_syncd_centisecs     xfs_params.syncd_timer.val
 103 #define xfs_stats_clear         xfs_params.stats_clear.val
 104 #define xfs_inherit_sync        xfs_params.inherit_sync.val
 105 #define xfs_inherit_nodump      xfs_params.inherit_nodump.val
 106 #define xfs_inherit_noatime     xfs_params.inherit_noatim.val
 107 #define xfs_inherit_nosymlinks  xfs_params.inherit_nosym.val
 108 #define xfs_rotorstep           xfs_params.rotorstep.val
 109 #define xfs_inherit_nodefrag    xfs_params.inherit_nodfrg.val
 110 #define xfs_fstrm_centisecs     xfs_params.fstrm_timer.val
 111 #define xfs_eofb_secs           xfs_params.eofb_timer.val
 112 #define xfs_cowb_secs           xfs_params.cowb_timer.val
 113
 114 #define current_cpu()           (raw_smp_processor_id())
 115 #define current_pid()           (current->pid)
 116 #define current_test_flags(f)   (current->flags & (f))
 117 #define current_set_flags_nested(sp, f)         \
 118                 (*(sp) = current->flags, current->flags |= (f))
 119 #define current_clear_flags_nested(sp, f)       \
 120                 (*(sp) = current->flags, current->flags &= ~(f))
 121 #define current_restore_flags_nested(sp, f)     \
 122                 (current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
 123
 124 #define spinlock_destroy(lock)
 125
 126 #define NBBY            8               /* number of bits per byte */
 127
 128 /*
 129  * Size of block device i/o is parameterized here.
 130  * Currently the system supports page-sized i/o.
 131  */
 132 #define BLKDEV_IOSHIFT          PAGE_SHIFT
 133 #define BLKDEV_IOSIZE           (1<<BLKDEV_IOSHIFT)
 134 /* number of BB's per block device block */
 135 #define BLKDEV_BB               BTOBB(BLKDEV_IOSIZE)
 136
 137 #define ENOATTR         ENODATA         /* Attribute not found */
 138 #define EWRONGFS        EINVAL          /* Mount with wrong filesystem type */
 139 #define EFSCORRUPTED    EUCLEAN         /* Filesystem is corrupted */
 140 #define EFSBADCRC       EBADMSG         /* Bad CRC detected */
 141
 142 #define SYNCHRONIZE()   barrier()
 143 #define __return_address __builtin_return_address(0)
 144
 145 /*
 146  * Return the address of a label.  Use barrier() so that the optimizer
 147  * won't reorder code to refactor the error jumpouts into a single
 148  * return, which throws off the reported address.
 149  */
 150 #define __this_address  ({ __label__ __here; __here: barrier(); &&__here; })
 151
 152 #define XFS_PROJID_DEFAULT      0
 153
 154 #define MIN(a,b)        (min(a,b))
 155 #define MAX(a,b)        (max(a,b))
 156 #define howmany(x, y)   (((x)+((y)-1))/(y))
 157
 158 static inline void delay(long ticks)
 159 {
 160         schedule_timeout_uninterruptible(ticks);
 161 }
 162
 163 /*
 164  * XFS wrapper structure for sysfs support. It depends on external data
 165  * structures and is embedded in various internal data structures to implement
 166  * the XFS sysfs object heirarchy. Define it here for broad access throughout
 167  * the codebase.
 168  */
 169 struct xfs_kobj {
 170         struct kobject          kobject;
 171         struct completion       complete;
 172 };
 173
 174 struct xstats {
 175         struct xfsstats __percpu        *xs_stats;
 176         struct xfs_kobj                 xs_kobj;
 177 };
 178
 179 extern struct xstats xfsstats;
 180
 181 /* Kernel uid/gid conversion. These are used to convert to/from the on disk
 182  * uid_t/gid_t types to the kuid_t/kgid_t types that the kernel uses internally.
 183  * The conversion here is type only, the value will remain the same since we
 184  * are converting to the init_user_ns. The uid is later mapped to a particular
 185  * user namespace value when crossing the kernel/user boundary.
 186  */
 187 static inline uint32_t xfs_kuid_to_uid(kuid_t uid)
 188 {
 189         return from_kuid(&init_user_ns, uid);
 190 }
 191
 192 static inline kuid_t xfs_uid_to_kuid(uint32_t uid)
 193 {
 194         return make_kuid(&init_user_ns, uid);
 195 }
 196
 197 static inline uint32_t xfs_kgid_to_gid(kgid_t gid)
 198 {
 199         return from_kgid(&init_user_ns, gid);
 200 }
 201
 202 static inline kgid_t xfs_gid_to_kgid(uint32_t gid)
 203 {
 204         return make_kgid(&init_user_ns, gid);
 205 }
 206
 207 static inline dev_t xfs_to_linux_dev_t(xfs_dev_t dev)
 208 {
 209         return MKDEV(sysv_major(dev) & 0x1ff, sysv_minor(dev));
 210 }
 211
 212 static inline xfs_dev_t linux_to_xfs_dev_t(dev_t dev)
 213 {
 214         return sysv_encode_dev(dev);
 215 }
 216
 217 /*
 218  * Various platform dependent calls that don't fit anywhere else
 219  */
 220 #define xfs_sort(a,n,s,fn)      sort(a,n,s,fn,NULL)
 221 #define xfs_stack_trace()       dump_stack()
 222
 223 /* Side effect free 64 bit mod operation */
 224 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
 225 {
 226         switch (n) {
 227                 case 4:
 228                         return *(__u32 *)a % b;
 229                 case 8:
 230                         {
 231                         __u64   c = *(__u64 *)a;
 232                         return do_div(c, b);
 233                         }
 234         }
 235
 236         /* NOTREACHED */
 237         return 0;
 238 }
 239
 240 #define do_mod(a, b)    xfs_do_mod(&(a), (b), sizeof(a))
 241
 242 static inline uint64_t roundup_64(uint64_t x, uint32_t y)
 243 {
 244         x += y - 1;
 245         do_div(x, y);
 246         return x * y;
 247 }
 248
 249 static inline uint64_t howmany_64(uint64_t x, uint32_t y)
 250 {
 251         x += y - 1;
 252         do_div(x, y);
 253         return x;
 254 }
 255
 256 #define ASSERT_ALWAYS(expr)     \
 257         (likely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
 258
 259 #ifdef DEBUG
 260 #define ASSERT(expr)    \
 261         (likely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
 262
 263 #else   /* !DEBUG */
 264
 265 #ifdef XFS_WARN
 266
 267 #define ASSERT(expr)    \
 268         (likely(expr) ? (void)0 : asswarn(#expr, __FILE__, __LINE__))
 269
 270 #else   /* !DEBUG && !XFS_WARN */
 271
 272 #define ASSERT(expr)    ((void)0)
 273
 274 #endif /* XFS_WARN */
 275 #endif /* DEBUG */
 276
 277 #define STATIC static noinline
 278
 279 #ifdef CONFIG_XFS_RT
 280
 281 /*
 282  * make sure we ignore the inode flag if the filesystem doesn't have a
 283  * configured realtime device.
 284  */
 285 #define XFS_IS_REALTIME_INODE(ip)                       \
 286         (((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME) &&  \
 287          (ip)->i_mount->m_rtdev_targp)
 288 #else
 289 #define XFS_IS_REALTIME_INODE(ip) (0)
 290 #endif
 291
 292 #endif /* __XFS_LINUX__ */