Loading...
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
16typedef __s64 xfs_off_t; /* <file offset> type */
17typedef unsigned long long xfs_ino_t; /* <inode> type */
18typedef __s64 xfs_daddr_t; /* <disk address> type */
19typedef __u32 xfs_dev_t;
20typedef __u32 xfs_nlink_t;
21
22#include "xfs_types.h"
23
24#include <linux/semaphore.h>
25#include <linux/mm.h>
26#include <linux/sched/mm.h>
27#include <linux/kernel.h>
28#include <linux/blkdev.h>
29#include <linux/slab.h>
30#include <linux/vmalloc.h>
31#include <linux/crc32c.h>
32#include <linux/module.h>
33#include <linux/mutex.h>
34#include <linux/file.h>
35#include <linux/filelock.h>
36#include <linux/swap.h>
37#include <linux/errno.h>
38#include <linux/sched/signal.h>
39#include <linux/bitops.h>
40#include <linux/major.h>
41#include <linux/pagemap.h>
42#include <linux/vfs.h>
43#include <linux/seq_file.h>
44#include <linux/init.h>
45#include <linux/list.h>
46#include <linux/proc_fs.h>
47#include <linux/sort.h>
48#include <linux/cpu.h>
49#include <linux/notifier.h>
50#include <linux/delay.h>
51#include <linux/log2.h>
52#include <linux/rwsem.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#include <linux/debugfs.h>
66
67#include <asm/page.h>
68#include <asm/div64.h>
69#include <asm/param.h>
70#include <linux/uaccess.h>
71#include <asm/byteorder.h>
72#include <linux/unaligned.h>
73
74#include "xfs_fs.h"
75#include "xfs_stats.h"
76#include "xfs_sysctl.h"
77#include "xfs_iops.h"
78#include "xfs_aops.h"
79#include "xfs_super.h"
80#include "xfs_cksum.h"
81#include "xfs_buf.h"
82#include "xfs_message.h"
83#include "xfs_drain.h"
84#include "xfs_hooks.h"
85
86#ifdef __BIG_ENDIAN
87#define XFS_NATIVE_HOST 1
88#else
89#undef XFS_NATIVE_HOST
90#endif
91
92#define irix_sgid_inherit xfs_params.sgid_inherit.val
93#define irix_symlink_mode xfs_params.symlink_mode.val
94#define xfs_panic_mask xfs_params.panic_mask.val
95#define xfs_error_level xfs_params.error_level.val
96#define xfs_syncd_centisecs xfs_params.syncd_timer.val
97#define xfs_stats_clear xfs_params.stats_clear.val
98#define xfs_inherit_sync xfs_params.inherit_sync.val
99#define xfs_inherit_nodump xfs_params.inherit_nodump.val
100#define xfs_inherit_noatime xfs_params.inherit_noatim.val
101#define xfs_inherit_nosymlinks xfs_params.inherit_nosym.val
102#define xfs_rotorstep xfs_params.rotorstep.val
103#define xfs_inherit_nodefrag xfs_params.inherit_nodfrg.val
104#define xfs_fstrm_centisecs xfs_params.fstrm_timer.val
105#define xfs_blockgc_secs xfs_params.blockgc_timer.val
106
107#define current_cpu() (raw_smp_processor_id())
108#define current_set_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 __return_address __builtin_return_address(0)
130
131/*
132 * Return the address of a label. Use barrier() so that the optimizer
133 * won't reorder code to refactor the error jumpouts into a single
134 * return, which throws off the reported address.
135 */
136#define __this_address ({ __label__ __here; __here: barrier(); &&__here; })
137
138#define howmany(x, y) (((x)+((y)-1))/(y))
139
140static inline void delay(long ticks)
141{
142 schedule_timeout_uninterruptible(ticks);
143}
144
145/*
146 * XFS wrapper structure for sysfs support. It depends on external data
147 * structures and is embedded in various internal data structures to implement
148 * the XFS sysfs object heirarchy. Define it here for broad access throughout
149 * the codebase.
150 */
151struct xfs_kobj {
152 struct kobject kobject;
153 struct completion complete;
154};
155
156struct xstats {
157 struct xfsstats __percpu *xs_stats;
158 struct xfs_kobj xs_kobj;
159};
160
161extern struct xstats xfsstats;
162
163static inline dev_t xfs_to_linux_dev_t(xfs_dev_t dev)
164{
165 return MKDEV(sysv_major(dev) & 0x1ff, sysv_minor(dev));
166}
167
168static inline xfs_dev_t linux_to_xfs_dev_t(dev_t dev)
169{
170 return sysv_encode_dev(dev);
171}
172
173/*
174 * Various platform dependent calls that don't fit anywhere else
175 */
176#define xfs_sort(a,n,s,fn) sort(a,n,s,fn,NULL)
177#define xfs_stack_trace() dump_stack()
178
179static inline uint64_t rounddown_64(uint64_t x, uint32_t y)
180{
181 do_div(x, y);
182 return x * y;
183}
184
185static inline uint64_t roundup_64(uint64_t x, uint32_t y)
186{
187 x += y - 1;
188 do_div(x, y);
189 return x * y;
190}
191
192static inline uint64_t howmany_64(uint64_t x, uint32_t y)
193{
194 x += y - 1;
195 do_div(x, y);
196 return x;
197}
198
199static inline bool isaligned_64(uint64_t x, uint32_t y)
200{
201 return do_div(x, y) == 0;
202}
203
204/* If @b is a power of 2, return log2(b). Else return -1. */
205static inline int8_t log2_if_power2(unsigned long b)
206{
207 return is_power_of_2(b) ? ilog2(b) : -1;
208}
209
210/* If @b is a power of 2, return a mask of the lower bits, else return zero. */
211static inline unsigned long long mask64_if_power2(unsigned long b)
212{
213 return is_power_of_2(b) ? b - 1 : 0;
214}
215
216int xfs_rw_bdev(struct block_device *bdev, sector_t sector, unsigned int count,
217 char *data, enum req_op op);
218
219#define ASSERT_ALWAYS(expr) \
220 (likely(expr) ? (void)0 : assfail(NULL, #expr, __FILE__, __LINE__))
221
222#ifdef DEBUG
223#define ASSERT(expr) \
224 (likely(expr) ? (void)0 : assfail(NULL, #expr, __FILE__, __LINE__))
225
226#else /* !DEBUG */
227
228#ifdef XFS_WARN
229
230#define ASSERT(expr) \
231 (likely(expr) ? (void)0 : asswarn(NULL, #expr, __FILE__, __LINE__))
232
233#else /* !DEBUG && !XFS_WARN */
234
235#define ASSERT(expr) ((void)0)
236
237#endif /* XFS_WARN */
238#endif /* DEBUG */
239
240#define XFS_IS_CORRUPT(mp, expr) \
241 (unlikely(expr) ? xfs_corruption_error(#expr, XFS_ERRLEVEL_LOW, (mp), \
242 NULL, 0, __FILE__, __LINE__, \
243 __this_address), \
244 true : false)
245
246#define STATIC static noinline
247
248#ifdef CONFIG_XFS_RT
249
250/*
251 * make sure we ignore the inode flag if the filesystem doesn't have a
252 * configured realtime device.
253 */
254#define XFS_IS_REALTIME_INODE(ip) \
255 (((ip)->i_diflags & XFS_DIFLAG_REALTIME) && \
256 (ip)->i_mount->m_rtdev_targp)
257#define XFS_IS_REALTIME_MOUNT(mp) ((mp)->m_rtdev_targp ? 1 : 0)
258#else
259#define XFS_IS_REALTIME_INODE(ip) (0)
260#define XFS_IS_REALTIME_MOUNT(mp) (0)
261#endif
262
263/*
264 * Starting in Linux 4.15, the %p (raw pointer value) printk modifier
265 * prints a hashed version of the pointer to avoid leaking kernel
266 * pointers into dmesg. If we're trying to debug the kernel we want the
267 * raw values, so override this behavior as best we can.
268 */
269#ifdef DEBUG
270# define PTR_FMT "%px"
271#else
272# define PTR_FMT "%p"
273#endif
274
275/*
276 * Helper for IO routines to grab backing pages from allocated kernel memory.
277 */
278static inline struct page *
279kmem_to_page(void *addr)
280{
281 if (is_vmalloc_addr(addr))
282 return vmalloc_to_page(addr);
283 return virt_to_page(addr);
284}
285
286#endif /* __XFS_LINUX__ */
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 */
26typedef signed char __int8_t;
27typedef unsigned char __uint8_t;
28typedef signed short int __int16_t;
29typedef unsigned short int __uint16_t;
30typedef signed int __int32_t;
31typedef unsigned int __uint32_t;
32typedef signed long long int __int64_t;
33typedef unsigned long long int __uint64_t;
34
35typedef __s64 xfs_off_t; /* <file offset> type */
36typedef unsigned long long xfs_ino_t; /* <inode> type */
37typedef __s64 xfs_daddr_t; /* <disk address> type */
38typedef __u32 xfs_dev_t;
39typedef __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#include <linux/rhashtable.h>
82
83#include <asm/page.h>
84#include <asm/div64.h>
85#include <asm/param.h>
86#include <linux/uaccess.h>
87#include <asm/byteorder.h>
88#include <asm/unaligned.h>
89
90#include "xfs_fs.h"
91#include "xfs_stats.h"
92#include "xfs_sysctl.h"
93#include "xfs_iops.h"
94#include "xfs_aops.h"
95#include "xfs_super.h"
96#include "xfs_cksum.h"
97#include "xfs_buf.h"
98#include "xfs_message.h"
99
100#ifdef __BIG_ENDIAN
101#define XFS_NATIVE_HOST 1
102#else
103#undef XFS_NATIVE_HOST
104#endif
105
106#define irix_sgid_inherit xfs_params.sgid_inherit.val
107#define irix_symlink_mode xfs_params.symlink_mode.val
108#define xfs_panic_mask xfs_params.panic_mask.val
109#define xfs_error_level xfs_params.error_level.val
110#define xfs_syncd_centisecs xfs_params.syncd_timer.val
111#define xfs_stats_clear xfs_params.stats_clear.val
112#define xfs_inherit_sync xfs_params.inherit_sync.val
113#define xfs_inherit_nodump xfs_params.inherit_nodump.val
114#define xfs_inherit_noatime xfs_params.inherit_noatim.val
115#define xfs_inherit_nosymlinks xfs_params.inherit_nosym.val
116#define xfs_rotorstep xfs_params.rotorstep.val
117#define xfs_inherit_nodefrag xfs_params.inherit_nodfrg.val
118#define xfs_fstrm_centisecs xfs_params.fstrm_timer.val
119#define xfs_eofb_secs xfs_params.eofb_timer.val
120#define xfs_cowb_secs xfs_params.cowb_timer.val
121
122#define current_cpu() (raw_smp_processor_id())
123#define current_pid() (current->pid)
124#define current_test_flags(f) (current->flags & (f))
125#define current_set_flags_nested(sp, f) \
126 (*(sp) = current->flags, current->flags |= (f))
127#define current_clear_flags_nested(sp, f) \
128 (*(sp) = current->flags, current->flags &= ~(f))
129#define current_restore_flags_nested(sp, f) \
130 (current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
131
132#define spinlock_destroy(lock)
133
134#define NBBY 8 /* number of bits per byte */
135
136/*
137 * Size of block device i/o is parameterized here.
138 * Currently the system supports page-sized i/o.
139 */
140#define BLKDEV_IOSHIFT PAGE_SHIFT
141#define BLKDEV_IOSIZE (1<<BLKDEV_IOSHIFT)
142/* number of BB's per block device block */
143#define BLKDEV_BB BTOBB(BLKDEV_IOSIZE)
144
145#define ENOATTR ENODATA /* Attribute not found */
146#define EWRONGFS EINVAL /* Mount with wrong filesystem type */
147#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
148#define EFSBADCRC EBADMSG /* Bad CRC detected */
149
150#define SYNCHRONIZE() barrier()
151#define __return_address __builtin_return_address(0)
152
153#define XFS_PROJID_DEFAULT 0
154#define MAXPATHLEN 1024
155
156#define MIN(a,b) (min(a,b))
157#define MAX(a,b) (max(a,b))
158#define howmany(x, y) (((x)+((y)-1))/(y))
159
160static inline void delay(long ticks)
161{
162 schedule_timeout_uninterruptible(ticks);
163}
164
165/*
166 * XFS wrapper structure for sysfs support. It depends on external data
167 * structures and is embedded in various internal data structures to implement
168 * the XFS sysfs object heirarchy. Define it here for broad access throughout
169 * the codebase.
170 */
171struct xfs_kobj {
172 struct kobject kobject;
173 struct completion complete;
174};
175
176struct xstats {
177 struct xfsstats __percpu *xs_stats;
178 struct xfs_kobj xs_kobj;
179};
180
181extern struct xstats xfsstats;
182
183/* Kernel uid/gid conversion. These are used to convert to/from the on disk
184 * uid_t/gid_t types to the kuid_t/kgid_t types that the kernel uses internally.
185 * The conversion here is type only, the value will remain the same since we
186 * are converting to the init_user_ns. The uid is later mapped to a particular
187 * user namespace value when crossing the kernel/user boundary.
188 */
189static inline __uint32_t xfs_kuid_to_uid(kuid_t uid)
190{
191 return from_kuid(&init_user_ns, uid);
192}
193
194static inline kuid_t xfs_uid_to_kuid(__uint32_t uid)
195{
196 return make_kuid(&init_user_ns, uid);
197}
198
199static inline __uint32_t xfs_kgid_to_gid(kgid_t gid)
200{
201 return from_kgid(&init_user_ns, gid);
202}
203
204static inline kgid_t xfs_gid_to_kgid(__uint32_t gid)
205{
206 return make_kgid(&init_user_ns, gid);
207}
208
209/*
210 * Various platform dependent calls that don't fit anywhere else
211 */
212#define xfs_sort(a,n,s,fn) sort(a,n,s,fn,NULL)
213#define xfs_stack_trace() dump_stack()
214
215
216/* Move the kernel do_div definition off to one side */
217
218#if defined __i386__
219/* For ia32 we need to pull some tricks to get past various versions
220 * of the compiler which do not like us using do_div in the middle
221 * of large functions.
222 */
223static inline __u32 xfs_do_div(void *a, __u32 b, int n)
224{
225 __u32 mod;
226
227 switch (n) {
228 case 4:
229 mod = *(__u32 *)a % b;
230 *(__u32 *)a = *(__u32 *)a / b;
231 return mod;
232 case 8:
233 {
234 unsigned long __upper, __low, __high, __mod;
235 __u64 c = *(__u64 *)a;
236 __upper = __high = c >> 32;
237 __low = c;
238 if (__high) {
239 __upper = __high % (b);
240 __high = __high / (b);
241 }
242 asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
243 asm("":"=A" (c):"a" (__low),"d" (__high));
244 *(__u64 *)a = c;
245 return __mod;
246 }
247 }
248
249 /* NOTREACHED */
250 return 0;
251}
252
253/* Side effect free 64 bit mod operation */
254static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
255{
256 switch (n) {
257 case 4:
258 return *(__u32 *)a % b;
259 case 8:
260 {
261 unsigned long __upper, __low, __high, __mod;
262 __u64 c = *(__u64 *)a;
263 __upper = __high = c >> 32;
264 __low = c;
265 if (__high) {
266 __upper = __high % (b);
267 __high = __high / (b);
268 }
269 asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
270 asm("":"=A" (c):"a" (__low),"d" (__high));
271 return __mod;
272 }
273 }
274
275 /* NOTREACHED */
276 return 0;
277}
278#else
279static inline __u32 xfs_do_div(void *a, __u32 b, int n)
280{
281 __u32 mod;
282
283 switch (n) {
284 case 4:
285 mod = *(__u32 *)a % b;
286 *(__u32 *)a = *(__u32 *)a / b;
287 return mod;
288 case 8:
289 mod = do_div(*(__u64 *)a, b);
290 return mod;
291 }
292
293 /* NOTREACHED */
294 return 0;
295}
296
297/* Side effect free 64 bit mod operation */
298static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
299{
300 switch (n) {
301 case 4:
302 return *(__u32 *)a % b;
303 case 8:
304 {
305 __u64 c = *(__u64 *)a;
306 return do_div(c, b);
307 }
308 }
309
310 /* NOTREACHED */
311 return 0;
312}
313#endif
314
315#undef do_div
316#define do_div(a, b) xfs_do_div(&(a), (b), sizeof(a))
317#define do_mod(a, b) xfs_do_mod(&(a), (b), sizeof(a))
318
319static inline __uint64_t roundup_64(__uint64_t x, __uint32_t y)
320{
321 x += y - 1;
322 do_div(x, y);
323 return x * y;
324}
325
326static inline __uint64_t howmany_64(__uint64_t x, __uint32_t y)
327{
328 x += y - 1;
329 do_div(x, y);
330 return x;
331}
332
333#define ASSERT_ALWAYS(expr) \
334 (likely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
335
336#ifdef DEBUG
337#define ASSERT(expr) \
338 (likely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
339
340#ifndef STATIC
341# define STATIC noinline
342#endif
343
344#else /* !DEBUG */
345
346#ifdef XFS_WARN
347
348#define ASSERT(expr) \
349 (likely(expr) ? (void)0 : asswarn(#expr, __FILE__, __LINE__))
350
351#ifndef STATIC
352# define STATIC static noinline
353#endif
354
355#else /* !DEBUG && !XFS_WARN */
356
357#define ASSERT(expr) ((void)0)
358
359#ifndef STATIC
360# define STATIC static noinline
361#endif
362
363#endif /* XFS_WARN */
364#endif /* DEBUG */
365
366#ifdef CONFIG_XFS_RT
367#define XFS_IS_REALTIME_INODE(ip) ((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME)
368#else
369#define XFS_IS_REALTIME_INODE(ip) (0)
370#endif
371
372#endif /* __XFS_LINUX__ */