xfs_linux.h

  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 xfs_panic_mask		xfs_params.panic_mask.val
 93#define xfs_error_level		xfs_params.error_level.val
 94#define xfs_syncd_centisecs	xfs_params.syncd_timer.val
 95#define xfs_stats_clear		xfs_params.stats_clear.val
 96#define xfs_inherit_sync	xfs_params.inherit_sync.val
 97#define xfs_inherit_nodump	xfs_params.inherit_nodump.val
 98#define xfs_inherit_noatime	xfs_params.inherit_noatim.val
 99#define xfs_inherit_nosymlinks	xfs_params.inherit_nosym.val
100#define xfs_rotorstep		xfs_params.rotorstep.val
101#define xfs_inherit_nodefrag	xfs_params.inherit_nodfrg.val
102#define xfs_fstrm_centisecs	xfs_params.fstrm_timer.val
103#define xfs_blockgc_secs	xfs_params.blockgc_timer.val
104
105#define current_cpu()		(raw_smp_processor_id())
106#define current_set_flags_nested(sp, f)		\
107		(*(sp) = current->flags, current->flags |= (f))
108#define current_restore_flags_nested(sp, f)	\
109		(current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
110
111#define NBBY		8		/* number of bits per byte */
112
113/*
114 * Size of block device i/o is parameterized here.
115 * Currently the system supports page-sized i/o.
116 */
117#define	BLKDEV_IOSHIFT		PAGE_SHIFT
118#define	BLKDEV_IOSIZE		(1<<BLKDEV_IOSHIFT)
119/* number of BB's per block device block */
120#define	BLKDEV_BB		BTOBB(BLKDEV_IOSIZE)
121
122#define ENOATTR		ENODATA		/* Attribute not found */
123#define EWRONGFS	EINVAL		/* Mount with wrong filesystem type */
124#define EFSCORRUPTED	EUCLEAN		/* Filesystem is corrupted */
125#define EFSBADCRC	EBADMSG		/* Bad CRC detected */
126
127#define __return_address __builtin_return_address(0)
128
129/*
130 * Return the address of a label.  Use barrier() so that the optimizer
131 * won't reorder code to refactor the error jumpouts into a single
132 * return, which throws off the reported address.
133 */
134#define __this_address	({ __label__ __here; __here: barrier(); &&__here; })
135
136#define howmany(x, y)	(((x)+((y)-1))/(y))
137
138static inline void delay(long ticks)
139{
140	schedule_timeout_uninterruptible(ticks);
141}
142
143/*
144 * XFS wrapper structure for sysfs support. It depends on external data
145 * structures and is embedded in various internal data structures to implement
146 * the XFS sysfs object heirarchy. Define it here for broad access throughout
147 * the codebase.
148 */
149struct xfs_kobj {
150	struct kobject		kobject;
151	struct completion	complete;
152};
153
154struct xstats {
155	struct xfsstats __percpu	*xs_stats;
156	struct xfs_kobj			xs_kobj;
157};
158
159extern struct xstats xfsstats;
160
161static inline dev_t xfs_to_linux_dev_t(xfs_dev_t dev)
162{
163	return MKDEV(sysv_major(dev) & 0x1ff, sysv_minor(dev));
164}
165
166static inline xfs_dev_t linux_to_xfs_dev_t(dev_t dev)
167{
168	return sysv_encode_dev(dev);
169}
170
171/*
172 * Various platform dependent calls that don't fit anywhere else
173 */
174#define xfs_sort(a,n,s,fn)	sort(a,n,s,fn,NULL)
175#define xfs_stack_trace()	dump_stack()
176
177static inline uint64_t rounddown_64(uint64_t x, uint32_t y)
178{
179	do_div(x, y);
180	return x * y;
181}
182
183static inline uint64_t roundup_64(uint64_t x, uint32_t y)
184{
185	x += y - 1;
186	do_div(x, y);
187	return x * y;
188}
189
190static inline uint64_t howmany_64(uint64_t x, uint32_t y)
191{
192	x += y - 1;
193	do_div(x, y);
194	return x;
195}
196
197static inline bool isaligned_64(uint64_t x, uint32_t y)
198{
199	return do_div(x, y) == 0;
200}
201
202/* If @b is a power of 2, return log2(b).  Else return -1. */
203static inline int8_t log2_if_power2(unsigned long b)
204{
205	return is_power_of_2(b) ? ilog2(b) : -1;
206}
207
208/* If @b is a power of 2, return a mask of the lower bits, else return zero. */
209static inline unsigned long long mask64_if_power2(unsigned long b)
210{
211	return is_power_of_2(b) ? b - 1 : 0;
212}
213
214int xfs_rw_bdev(struct block_device *bdev, sector_t sector, unsigned int count,
215		char *data, enum req_op op);
216
217#define ASSERT_ALWAYS(expr)	\
218	(likely(expr) ? (void)0 : assfail(NULL, #expr, __FILE__, __LINE__))
219
220#ifdef DEBUG
221#define ASSERT(expr)	\
222	(likely(expr) ? (void)0 : assfail(NULL, #expr, __FILE__, __LINE__))
223
224#else	/* !DEBUG */
225
226#ifdef XFS_WARN
227
228#define ASSERT(expr)	\
229	(likely(expr) ? (void)0 : asswarn(NULL, #expr, __FILE__, __LINE__))
230
231#else	/* !DEBUG && !XFS_WARN */
232
233#define ASSERT(expr)		((void)0)
234
235#endif /* XFS_WARN */
236#endif /* DEBUG */
237
238#define XFS_IS_CORRUPT(mp, expr)	\
239	(unlikely(expr) ? xfs_corruption_error(#expr, XFS_ERRLEVEL_LOW, (mp), \
240					       NULL, 0, __FILE__, __LINE__, \
241					       __this_address), \
242			  true : false)
243
244#define STATIC static noinline
245
246#ifdef CONFIG_XFS_RT
247
248/*
249 * make sure we ignore the inode flag if the filesystem doesn't have a
250 * configured realtime device.
251 */
252#define XFS_IS_REALTIME_INODE(ip)			\
253	(((ip)->i_diflags & XFS_DIFLAG_REALTIME) &&	\
254	 (ip)->i_mount->m_rtdev_targp)
255#define XFS_IS_REALTIME_MOUNT(mp) ((mp)->m_rtdev_targp ? 1 : 0)
256#else
257#define XFS_IS_REALTIME_INODE(ip) (0)
258#define XFS_IS_REALTIME_MOUNT(mp) (0)
259#endif
260
261/*
262 * Starting in Linux 4.15, the %p (raw pointer value) printk modifier
263 * prints a hashed version of the pointer to avoid leaking kernel
264 * pointers into dmesg.  If we're trying to debug the kernel we want the
265 * raw values, so override this behavior as best we can.
266 */
267#ifdef DEBUG
268# define PTR_FMT "%px"
269#else
270# define PTR_FMT "%p"
271#endif
272
273/*
274 * Helper for IO routines to grab backing pages from allocated kernel memory.
275 */
276static inline struct page *
277kmem_to_page(void *addr)
278{
279	if (is_vmalloc_addr(addr))
280		return vmalloc_to_page(addr);
281	return virt_to_page(addr);
282}
283
284#endif /* __XFS_LINUX__ */