xref: /linux/fs/xfs/xfs_linux.h (revision 23c48a124b469cee2eb0c75e6d22d366d1caa118)
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 #include <linux/xattr.h>
64 #include <linux/mnt_idmapping.h>
65 
66 #include <asm/page.h>
67 #include <asm/div64.h>
68 #include <asm/param.h>
69 #include <linux/uaccess.h>
70 #include <asm/byteorder.h>
71 #include <asm/unaligned.h>
72 
73 #include "xfs_fs.h"
74 #include "xfs_stats.h"
75 #include "xfs_sysctl.h"
76 #include "xfs_iops.h"
77 #include "xfs_aops.h"
78 #include "xfs_super.h"
79 #include "xfs_cksum.h"
80 #include "xfs_buf.h"
81 #include "xfs_message.h"
82 
83 #ifdef __BIG_ENDIAN
84 #define XFS_NATIVE_HOST 1
85 #else
86 #undef XFS_NATIVE_HOST
87 #endif
88 
89 #define irix_sgid_inherit	xfs_params.sgid_inherit.val
90 #define irix_symlink_mode	xfs_params.symlink_mode.val
91 #define xfs_panic_mask		xfs_params.panic_mask.val
92 #define xfs_error_level		xfs_params.error_level.val
93 #define xfs_syncd_centisecs	xfs_params.syncd_timer.val
94 #define xfs_stats_clear		xfs_params.stats_clear.val
95 #define xfs_inherit_sync	xfs_params.inherit_sync.val
96 #define xfs_inherit_nodump	xfs_params.inherit_nodump.val
97 #define xfs_inherit_noatime	xfs_params.inherit_noatim.val
98 #define xfs_inherit_nosymlinks	xfs_params.inherit_nosym.val
99 #define xfs_rotorstep		xfs_params.rotorstep.val
100 #define xfs_inherit_nodefrag	xfs_params.inherit_nodfrg.val
101 #define xfs_fstrm_centisecs	xfs_params.fstrm_timer.val
102 #define xfs_blockgc_secs	xfs_params.blockgc_timer.val
103 
104 #define current_cpu()		(raw_smp_processor_id())
105 #define current_set_flags_nested(sp, f)		\
106 		(*(sp) = current->flags, current->flags |= (f))
107 #define current_restore_flags_nested(sp, f)	\
108 		(current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
109 
110 #define NBBY		8		/* number of bits per byte */
111 
112 /*
113  * Size of block device i/o is parameterized here.
114  * Currently the system supports page-sized i/o.
115  */
116 #define	BLKDEV_IOSHIFT		PAGE_SHIFT
117 #define	BLKDEV_IOSIZE		(1<<BLKDEV_IOSHIFT)
118 /* number of BB's per block device block */
119 #define	BLKDEV_BB		BTOBB(BLKDEV_IOSIZE)
120 
121 #define ENOATTR		ENODATA		/* Attribute not found */
122 #define EWRONGFS	EINVAL		/* Mount with wrong filesystem type */
123 #define EFSCORRUPTED	EUCLEAN		/* Filesystem is corrupted */
124 #define EFSBADCRC	EBADMSG		/* Bad CRC detected */
125 
126 #define __return_address __builtin_return_address(0)
127 
128 /*
129  * Return the address of a label.  Use barrier() so that the optimizer
130  * won't reorder code to refactor the error jumpouts into a single
131  * return, which throws off the reported address.
132  */
133 #define __this_address	({ __label__ __here; __here: barrier(); &&__here; })
134 
135 #define XFS_PROJID_DEFAULT	0
136 
137 #define howmany(x, y)	(((x)+((y)-1))/(y))
138 
139 static inline void delay(long ticks)
140 {
141 	schedule_timeout_uninterruptible(ticks);
142 }
143 
144 /*
145  * XFS wrapper structure for sysfs support. It depends on external data
146  * structures and is embedded in various internal data structures to implement
147  * the XFS sysfs object heirarchy. Define it here for broad access throughout
148  * the codebase.
149  */
150 struct xfs_kobj {
151 	struct kobject		kobject;
152 	struct completion	complete;
153 };
154 
155 struct xstats {
156 	struct xfsstats __percpu	*xs_stats;
157 	struct xfs_kobj			xs_kobj;
158 };
159 
160 extern struct xstats xfsstats;
161 
162 static inline dev_t xfs_to_linux_dev_t(xfs_dev_t dev)
163 {
164 	return MKDEV(sysv_major(dev) & 0x1ff, sysv_minor(dev));
165 }
166 
167 static inline xfs_dev_t linux_to_xfs_dev_t(dev_t dev)
168 {
169 	return sysv_encode_dev(dev);
170 }
171 
172 /*
173  * Various platform dependent calls that don't fit anywhere else
174  */
175 #define xfs_sort(a,n,s,fn)	sort(a,n,s,fn,NULL)
176 #define xfs_stack_trace()	dump_stack()
177 
178 static inline uint64_t rounddown_64(uint64_t x, uint32_t y)
179 {
180 	do_div(x, y);
181 	return x * y;
182 }
183 
184 static inline uint64_t roundup_64(uint64_t x, uint32_t y)
185 {
186 	x += y - 1;
187 	do_div(x, y);
188 	return x * y;
189 }
190 
191 static inline uint64_t howmany_64(uint64_t x, uint32_t y)
192 {
193 	x += y - 1;
194 	do_div(x, y);
195 	return x;
196 }
197 
198 int xfs_rw_bdev(struct block_device *bdev, sector_t sector, unsigned int count,
199 		char *data, enum req_op op);
200 
201 #define ASSERT_ALWAYS(expr)	\
202 	(likely(expr) ? (void)0 : assfail(NULL, #expr, __FILE__, __LINE__))
203 
204 #ifdef DEBUG
205 #define ASSERT(expr)	\
206 	(likely(expr) ? (void)0 : assfail(NULL, #expr, __FILE__, __LINE__))
207 
208 #else	/* !DEBUG */
209 
210 #ifdef XFS_WARN
211 
212 #define ASSERT(expr)	\
213 	(likely(expr) ? (void)0 : asswarn(NULL, #expr, __FILE__, __LINE__))
214 
215 #else	/* !DEBUG && !XFS_WARN */
216 
217 #define ASSERT(expr)		((void)0)
218 
219 #endif /* XFS_WARN */
220 #endif /* DEBUG */
221 
222 #define XFS_IS_CORRUPT(mp, expr)	\
223 	(unlikely(expr) ? xfs_corruption_error(#expr, XFS_ERRLEVEL_LOW, (mp), \
224 					       NULL, 0, __FILE__, __LINE__, \
225 					       __this_address), \
226 			  true : false)
227 
228 #define STATIC static noinline
229 
230 #ifdef CONFIG_XFS_RT
231 
232 /*
233  * make sure we ignore the inode flag if the filesystem doesn't have a
234  * configured realtime device.
235  */
236 #define XFS_IS_REALTIME_INODE(ip)			\
237 	(((ip)->i_diflags & XFS_DIFLAG_REALTIME) &&	\
238 	 (ip)->i_mount->m_rtdev_targp)
239 #define XFS_IS_REALTIME_MOUNT(mp) ((mp)->m_rtdev_targp ? 1 : 0)
240 #else
241 #define XFS_IS_REALTIME_INODE(ip) (0)
242 #define XFS_IS_REALTIME_MOUNT(mp) (0)
243 #endif
244 
245 /*
246  * Starting in Linux 4.15, the %p (raw pointer value) printk modifier
247  * prints a hashed version of the pointer to avoid leaking kernel
248  * pointers into dmesg.  If we're trying to debug the kernel we want the
249  * raw values, so override this behavior as best we can.
250  */
251 #ifdef DEBUG
252 # define PTR_FMT "%px"
253 #else
254 # define PTR_FMT "%p"
255 #endif
256 
257 #endif /* __XFS_LINUX__ */
258