blob: dcd1292664b3404b25bd93b9d40e58ab81d72376 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_LINUX__
19#define __XFS_LINUX__
20
21#include <linux/types.h>
Christoph Hellwigb1f359f2017-05-05 09:53:09 +020022#include <linux/uuid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24/*
Dave Chinner4f3d71f2013-08-12 20:49:54 +100025 * Kernel specific type declarations for XFS
26 */
Dave Chinner4f3d71f2013-08-12 20:49:54 +100027
Dave Chinner4f3d71f2013-08-12 20:49:54 +100028typedef __s64 xfs_off_t; /* <file offset> type */
29typedef unsigned long long xfs_ino_t; /* <inode> type */
30typedef __s64 xfs_daddr_t; /* <disk address> type */
Dave Chinner4f3d71f2013-08-12 20:49:54 +100031typedef __u32 xfs_dev_t;
32typedef __u32 xfs_nlink_t;
33
Alex Elder06f8e2d2011-08-12 13:57:55 -050034#include "xfs_types.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Alex Elder06f8e2d2011-08-12 13:57:55 -050036#include "kmem.h"
37#include "mrlock.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
David Chinnerab4a9b02008-08-13 16:42:10 +100039#include <linux/semaphore.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/mm.h>
41#include <linux/kernel.h>
42#include <linux/blkdev.h>
43#include <linux/slab.h>
Christoph Hellwigbc02e862012-11-16 09:20:37 +110044#include <linux/crc32c.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/module.h>
Christoph Hellwiga0b0b8a2009-03-29 09:51:00 +020046#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/file.h>
48#include <linux/swap.h>
49#include <linux/errno.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010050#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/bitops.h>
52#include <linux/major.h>
53#include <linux/pagemap.h>
54#include <linux/vfs.h>
55#include <linux/seq_file.h>
56#include <linux/init.h>
57#include <linux/list.h>
58#include <linux/proc_fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059#include <linux/sort.h>
David Chinnere8234a62006-03-14 13:23:52 +110060#include <linux/cpu.h>
61#include <linux/notifier.h>
David Chinner01e1b692006-03-14 13:29:16 +110062#include <linux/delay.h>
Eric Sandeenaf3a2e82007-08-16 16:25:23 +100063#include <linux/log2.h>
Eric Sandeen007c61c2007-10-11 17:43:56 +100064#include <linux/spinlock.h>
David Chinner64275ea2008-04-30 17:11:16 +100065#include <linux/random.h>
Barry Naujok189f4bf2008-05-21 16:58:55 +100066#include <linux/ctype.h>
David Chinner6bfb3d02008-10-30 18:32:43 +110067#include <linux/writeback.h>
Christoph Hellwig6c77b0e2010-10-06 18:41:17 +000068#include <linux/capability.h>
Christoph Hellwig00308072011-10-11 11:14:10 -040069#include <linux/kthread.h>
70#include <linux/freezer.h>
Christoph Hellwig8a072a42011-04-24 19:06:17 +000071#include <linux/list_sort.h>
Rich Johnston3d6e0362013-03-27 09:26:49 -050072#include <linux/ratelimit.h>
Lucas Stach6031e732016-12-07 17:36:36 +110073#include <linux/rhashtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75#include <asm/page.h>
76#include <asm/div64.h>
77#include <asm/param.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080078#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070079#include <asm/byteorder.h>
80#include <asm/unaligned.h>
81
Dave Chinnerb92cc59f62014-08-04 13:28:20 +100082#include "xfs_fs.h"
Alex Elder06f8e2d2011-08-12 13:57:55 -050083#include "xfs_stats.h"
84#include "xfs_sysctl.h"
85#include "xfs_iops.h"
86#include "xfs_aops.h"
87#include "xfs_super.h"
Eric Sandeen51582172014-02-27 15:17:27 +110088#include "xfs_cksum.h"
Alex Elder06f8e2d2011-08-12 13:57:55 -050089#include "xfs_buf.h"
90#include "xfs_message.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Christoph Hellwig218106a2011-07-08 14:35:58 +020092#ifdef __BIG_ENDIAN
93#define XFS_NATIVE_HOST 1
94#else
95#undef XFS_NATIVE_HOST
96#endif
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098#define irix_sgid_inherit xfs_params.sgid_inherit.val
99#define irix_symlink_mode xfs_params.symlink_mode.val
100#define xfs_panic_mask xfs_params.panic_mask.val
101#define xfs_error_level xfs_params.error_level.val
102#define xfs_syncd_centisecs xfs_params.syncd_timer.val
103#define xfs_stats_clear xfs_params.stats_clear.val
104#define xfs_inherit_sync xfs_params.inherit_sync.val
105#define xfs_inherit_nodump xfs_params.inherit_nodump.val
106#define xfs_inherit_noatime xfs_params.inherit_noatim.val
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107#define xfs_inherit_nosymlinks xfs_params.inherit_nosym.val
108#define xfs_rotorstep xfs_params.rotorstep.val
Barry Naujokd3446ea2006-06-09 14:54:19 +1000109#define xfs_inherit_nodefrag xfs_params.inherit_nodfrg.val
David Chinner2a82b8b2007-07-11 11:09:12 +1000110#define xfs_fstrm_centisecs xfs_params.fstrm_timer.val
Brian Foster579b62f2012-11-06 09:50:47 -0500111#define xfs_eofb_secs xfs_params.eofb_timer.val
Darrick J. Wong83104d42016-10-03 09:11:46 -0700112#define xfs_cowb_secs xfs_params.cowb_timer.val
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Nathan Scott59c1b082006-06-09 14:59:13 +1000114#define current_cpu() (raw_smp_processor_id())
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115#define current_pid() (current->pid)
Nathan Scott59c1b082006-06-09 14:59:13 +1000116#define current_test_flags(f) (current->flags & (f))
Nathan Scott59c1b082006-06-09 14:59:13 +1000117#define current_set_flags_nested(sp, f) \
118 (*(sp) = current->flags, current->flags |= (f))
119#define current_clear_flags_nested(sp, f) \
120 (*(sp) = current->flags, current->flags &= ~(f))
121#define current_restore_flags_nested(sp, f) \
122 (current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Eric Sandeen007c61c2007-10-11 17:43:56 +1000124#define spinlock_destroy(lock)
125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126#define NBBY 8 /* number of bits per byte */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128/*
129 * Size of block device i/o is parameterized here.
130 * Currently the system supports page-sized i/o.
131 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300132#define BLKDEV_IOSHIFT PAGE_SHIFT
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#define BLKDEV_IOSIZE (1<<BLKDEV_IOSHIFT)
134/* number of BB's per block device block */
135#define BLKDEV_BB BTOBB(BLKDEV_IOSIZE)
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137#define ENOATTR ENODATA /* Attribute not found */
Nathan Scottda2f4d62006-06-20 13:01:38 +1000138#define EWRONGFS EINVAL /* Mount with wrong filesystem type */
139#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
Eric Sandeenca23f8f2014-02-27 15:21:07 +1100140#define EFSBADCRC EBADMSG /* Bad CRC detected */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142#define SYNCHRONIZE() barrier()
143#define __return_address __builtin_return_address(0)
144
Arkadiusz Mi?kiewicz67430992010-09-26 06:10:18 +0000145#define XFS_PROJID_DEFAULT 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147#define MIN(a,b) (min(a,b))
148#define MAX(a,b) (max(a,b))
149#define howmany(x, y) (((x)+((y)-1))/(y))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Dave Chinnere076b0f2014-10-02 09:18:13 +1000151static inline void delay(long ticks)
152{
153 schedule_timeout_uninterruptible(ticks);
154}
155
Brian Fostera31b1d32014-07-15 08:07:01 +1000156/*
157 * XFS wrapper structure for sysfs support. It depends on external data
158 * structures and is embedded in various internal data structures to implement
159 * the XFS sysfs object heirarchy. Define it here for broad access throughout
160 * the codebase.
161 */
162struct xfs_kobj {
163 struct kobject kobject;
164 struct completion complete;
165};
166
Bill O'Donnell80529c42015-10-12 05:19:45 +1100167struct xstats {
168 struct xfsstats __percpu *xs_stats;
169 struct xfs_kobj xs_kobj;
170};
171
172extern struct xstats xfsstats;
173
Dwight Engenc5eeb7e2013-08-15 14:07:58 -0400174/* Kernel uid/gid conversion. These are used to convert to/from the on disk
175 * uid_t/gid_t types to the kuid_t/kgid_t types that the kernel uses internally.
176 * The conversion here is type only, the value will remain the same since we
177 * are converting to the init_user_ns. The uid is later mapped to a particular
178 * user namespace value when crossing the kernel/user boundary.
179 */
Darrick J. Wongc8ce5402017-06-16 11:00:05 -0700180static inline uint32_t xfs_kuid_to_uid(kuid_t uid)
Dwight Engenc5eeb7e2013-08-15 14:07:58 -0400181{
182 return from_kuid(&init_user_ns, uid);
183}
184
Darrick J. Wongc8ce5402017-06-16 11:00:05 -0700185static inline kuid_t xfs_uid_to_kuid(uint32_t uid)
Dwight Engenc5eeb7e2013-08-15 14:07:58 -0400186{
187 return make_kuid(&init_user_ns, uid);
188}
189
Darrick J. Wongc8ce5402017-06-16 11:00:05 -0700190static inline uint32_t xfs_kgid_to_gid(kgid_t gid)
Dwight Engenc5eeb7e2013-08-15 14:07:58 -0400191{
192 return from_kgid(&init_user_ns, gid);
193}
194
Darrick J. Wongc8ce5402017-06-16 11:00:05 -0700195static inline kgid_t xfs_gid_to_kgid(uint32_t gid)
Dwight Engenc5eeb7e2013-08-15 14:07:58 -0400196{
197 return make_kgid(&init_user_ns, gid);
198}
199
Nathan Scottcde410a2005-09-05 11:47:01 +1000200/*
201 * Various platform dependent calls that don't fit anywhere else
202 */
Nathan Scott380b5dc2005-11-02 11:43:18 +1100203#define xfs_sort(a,n,s,fn) sort(a,n,s,fn,NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204#define xfs_stack_trace() dump_stack()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206/* Side effect free 64 bit mod operation */
207static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
208{
209 switch (n) {
210 case 4:
211 return *(__u32 *)a % b;
212 case 8:
213 {
214 __u64 c = *(__u64 *)a;
215 return do_div(c, b);
216 }
217 }
218
219 /* NOTREACHED */
220 return 0;
221}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223#define do_mod(a, b) xfs_do_mod(&(a), (b), sizeof(a))
224
Darrick J. Wongc8ce5402017-06-16 11:00:05 -0700225static inline uint64_t roundup_64(uint64_t x, uint32_t y)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 x += y - 1;
228 do_div(x, y);
Eric Sandeend99831f2014-06-22 15:03:54 +1000229 return x * y;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230}
231
Darrick J. Wongc8ce5402017-06-16 11:00:05 -0700232static inline uint64_t howmany_64(uint64_t x, uint32_t y)
Nathan Scott68c32712006-09-28 11:03:53 +1000233{
234 x += y - 1;
235 do_div(x, y);
236 return x;
237}
238
Dave Chinner91300902011-03-07 10:09:35 +1100239#define ASSERT_ALWAYS(expr) \
Amir Goldsteinbf46ecc2017-01-17 11:41:41 -0800240 (likely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
Dave Chinner91300902011-03-07 10:09:35 +1100241
Dave Chinner742ae1e2013-04-30 21:39:34 +1000242#ifdef DEBUG
Dave Chinner91300902011-03-07 10:09:35 +1100243#define ASSERT(expr) \
Amir Goldsteinbf46ecc2017-01-17 11:41:41 -0800244 (likely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
Dave Chinner91300902011-03-07 10:09:35 +1100245
246#ifndef STATIC
247# define STATIC noinline
248#endif
249
Dave Chinner742ae1e2013-04-30 21:39:34 +1000250#else /* !DEBUG */
251
252#ifdef XFS_WARN
253
254#define ASSERT(expr) \
Amir Goldsteinbf46ecc2017-01-17 11:41:41 -0800255 (likely(expr) ? (void)0 : asswarn(#expr, __FILE__, __LINE__))
Dave Chinner742ae1e2013-04-30 21:39:34 +1000256
257#ifndef STATIC
258# define STATIC static noinline
259#endif
260
261#else /* !DEBUG && !XFS_WARN */
262
263#define ASSERT(expr) ((void)0)
264
265#ifndef STATIC
266# define STATIC static noinline
267#endif
268
269#endif /* XFS_WARN */
Dave Chinner91300902011-03-07 10:09:35 +1100270#endif /* DEBUG */
271
Christoph Hellwig6d3ebaa2014-11-28 14:24:06 +1100272#ifdef CONFIG_XFS_RT
Richard Wareingb31ff3c2017-09-13 09:09:35 +1000273
274/*
275 * make sure we ignore the inode flag if the filesystem doesn't have a
276 * configured realtime device.
277 */
278#define XFS_IS_REALTIME_INODE(ip) \
279 (((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME) && \
280 (ip)->i_mount->m_rtdev_targp)
Christoph Hellwig6d3ebaa2014-11-28 14:24:06 +1100281#else
282#define XFS_IS_REALTIME_INODE(ip) (0)
283#endif
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285#endif /* __XFS_LINUX__ */