xref: /openbmc/linux/fs/xfs/xfs_linux.h (revision 3805e6a1)
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 
120 #define current_cpu()		(raw_smp_processor_id())
121 #define current_pid()		(current->pid)
122 #define current_test_flags(f)	(current->flags & (f))
123 #define current_set_flags_nested(sp, f)		\
124 		(*(sp) = current->flags, current->flags |= (f))
125 #define current_clear_flags_nested(sp, f)	\
126 		(*(sp) = current->flags, current->flags &= ~(f))
127 #define current_restore_flags_nested(sp, f)	\
128 		(current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
129 
130 #define spinlock_destroy(lock)
131 
132 #define NBBY		8		/* number of bits per byte */
133 
134 /*
135  * Size of block device i/o is parameterized here.
136  * Currently the system supports page-sized i/o.
137  */
138 #define	BLKDEV_IOSHIFT		PAGE_SHIFT
139 #define	BLKDEV_IOSIZE		(1<<BLKDEV_IOSHIFT)
140 /* number of BB's per block device block */
141 #define	BLKDEV_BB		BTOBB(BLKDEV_IOSIZE)
142 
143 #define ENOATTR		ENODATA		/* Attribute not found */
144 #define EWRONGFS	EINVAL		/* Mount with wrong filesystem type */
145 #define EFSCORRUPTED	EUCLEAN		/* Filesystem is corrupted */
146 #define EFSBADCRC	EBADMSG		/* Bad CRC detected */
147 
148 #define SYNCHRONIZE()	barrier()
149 #define __return_address __builtin_return_address(0)
150 
151 #define XFS_PROJID_DEFAULT	0
152 #define MAXPATHLEN	1024
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 /*
208  * Various platform dependent calls that don't fit anywhere else
209  */
210 #define xfs_sort(a,n,s,fn)	sort(a,n,s,fn,NULL)
211 #define xfs_stack_trace()	dump_stack()
212 
213 
214 /* Move the kernel do_div definition off to one side */
215 
216 #if defined __i386__
217 /* For ia32 we need to pull some tricks to get past various versions
218  * of the compiler which do not like us using do_div in the middle
219  * of large functions.
220  */
221 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
222 {
223 	__u32	mod;
224 
225 	switch (n) {
226 		case 4:
227 			mod = *(__u32 *)a % b;
228 			*(__u32 *)a = *(__u32 *)a / b;
229 			return mod;
230 		case 8:
231 			{
232 			unsigned long __upper, __low, __high, __mod;
233 			__u64	c = *(__u64 *)a;
234 			__upper = __high = c >> 32;
235 			__low = c;
236 			if (__high) {
237 				__upper = __high % (b);
238 				__high = __high / (b);
239 			}
240 			asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
241 			asm("":"=A" (c):"a" (__low),"d" (__high));
242 			*(__u64 *)a = c;
243 			return __mod;
244 			}
245 	}
246 
247 	/* NOTREACHED */
248 	return 0;
249 }
250 
251 /* Side effect free 64 bit mod operation */
252 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
253 {
254 	switch (n) {
255 		case 4:
256 			return *(__u32 *)a % b;
257 		case 8:
258 			{
259 			unsigned long __upper, __low, __high, __mod;
260 			__u64	c = *(__u64 *)a;
261 			__upper = __high = c >> 32;
262 			__low = c;
263 			if (__high) {
264 				__upper = __high % (b);
265 				__high = __high / (b);
266 			}
267 			asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
268 			asm("":"=A" (c):"a" (__low),"d" (__high));
269 			return __mod;
270 			}
271 	}
272 
273 	/* NOTREACHED */
274 	return 0;
275 }
276 #else
277 static inline __u32 xfs_do_div(void *a, __u32 b, int n)
278 {
279 	__u32	mod;
280 
281 	switch (n) {
282 		case 4:
283 			mod = *(__u32 *)a % b;
284 			*(__u32 *)a = *(__u32 *)a / b;
285 			return mod;
286 		case 8:
287 			mod = do_div(*(__u64 *)a, b);
288 			return mod;
289 	}
290 
291 	/* NOTREACHED */
292 	return 0;
293 }
294 
295 /* Side effect free 64 bit mod operation */
296 static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
297 {
298 	switch (n) {
299 		case 4:
300 			return *(__u32 *)a % b;
301 		case 8:
302 			{
303 			__u64	c = *(__u64 *)a;
304 			return do_div(c, b);
305 			}
306 	}
307 
308 	/* NOTREACHED */
309 	return 0;
310 }
311 #endif
312 
313 #undef do_div
314 #define do_div(a, b)	xfs_do_div(&(a), (b), sizeof(a))
315 #define do_mod(a, b)	xfs_do_mod(&(a), (b), sizeof(a))
316 
317 static inline __uint64_t roundup_64(__uint64_t x, __uint32_t y)
318 {
319 	x += y - 1;
320 	do_div(x, y);
321 	return x * y;
322 }
323 
324 static inline __uint64_t howmany_64(__uint64_t x, __uint32_t y)
325 {
326 	x += y - 1;
327 	do_div(x, y);
328 	return x;
329 }
330 
331 /* ARM old ABI has some weird alignment/padding */
332 #if defined(__arm__) && !defined(__ARM_EABI__)
333 #define __arch_pack __attribute__((packed))
334 #else
335 #define __arch_pack
336 #endif
337 
338 #define ASSERT_ALWAYS(expr)	\
339 	(unlikely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
340 
341 #ifdef DEBUG
342 #define ASSERT(expr)	\
343 	(unlikely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
344 
345 #ifndef STATIC
346 # define STATIC noinline
347 #endif
348 
349 #else	/* !DEBUG */
350 
351 #ifdef XFS_WARN
352 
353 #define ASSERT(expr)	\
354 	(unlikely(expr) ? (void)0 : asswarn(#expr, __FILE__, __LINE__))
355 
356 #ifndef STATIC
357 # define STATIC static noinline
358 #endif
359 
360 #else	/* !DEBUG && !XFS_WARN */
361 
362 #define ASSERT(expr)	((void)0)
363 
364 #ifndef STATIC
365 # define STATIC static noinline
366 #endif
367 
368 #endif /* XFS_WARN */
369 #endif /* DEBUG */
370 
371 #ifdef CONFIG_XFS_RT
372 #define XFS_IS_REALTIME_INODE(ip) ((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME)
373 #else
374 #define XFS_IS_REALTIME_INODE(ip) (0)
375 #endif
376 
377 #endif /* __XFS_LINUX__ */
378