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