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