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