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 <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  
delay(long ticks)140  static 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   */
151  struct xfs_kobj {
152  	struct kobject		kobject;
153  	struct completion	complete;
154  };
155  
156  struct xstats {
157  	struct xfsstats __percpu	*xs_stats;
158  	struct xfs_kobj			xs_kobj;
159  };
160  
161  extern struct xstats xfsstats;
162  
xfs_to_linux_dev_t(xfs_dev_t dev)163  static 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  
linux_to_xfs_dev_t(dev_t dev)168  static 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  
rounddown_64(uint64_t x,uint32_t y)179  static inline uint64_t rounddown_64(uint64_t x, uint32_t y)
180  {
181  	do_div(x, y);
182  	return x * y;
183  }
184  
roundup_64(uint64_t x,uint32_t y)185  static 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  
howmany_64(uint64_t x,uint32_t y)192  static 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  
isaligned_64(uint64_t x,uint32_t y)199  static 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. */
log2_if_power2(unsigned long b)205  static 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. */
mask64_if_power2(unsigned long b)211  static inline unsigned long long mask64_if_power2(unsigned long b)
212  {
213  	return is_power_of_2(b) ? b - 1 : 0;
214  }
215  
216  int 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   */
278  static inline struct page *
kmem_to_page(void * addr)279  kmem_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__ */
287