blob: 68640fb63a542346cac31553dd0aad1a78421a16 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23/*
Dave Chinner4f3d71f2013-08-12 20:49:54 +100024 * 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
Dave Chinner4f3d71f2013-08-12 20:49:54 +100035typedef __s64 xfs_off_t; /* <file offset> type */
36typedef unsigned long long xfs_ino_t; /* <inode> type */
37typedef __s64 xfs_daddr_t; /* <disk address> type */
Dave Chinner4f3d71f2013-08-12 20:49:54 +100038typedef __u32 xfs_dev_t;
39typedef __u32 xfs_nlink_t;
40
Alex Elder06f8e2d2011-08-12 13:57:55 -050041#include "xfs_types.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Alex Elder06f8e2d2011-08-12 13:57:55 -050043#include "kmem.h"
44#include "mrlock.h"
Alex Elder06f8e2d2011-08-12 13:57:55 -050045#include "uuid.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
David Chinnerab4a9b02008-08-13 16:42:10 +100047#include <linux/semaphore.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/mm.h>
49#include <linux/kernel.h>
50#include <linux/blkdev.h>
51#include <linux/slab.h>
Christoph Hellwigbc02e862012-11-16 09:20:37 +110052#include <linux/crc32c.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <linux/module.h>
Christoph Hellwiga0b0b8a2009-03-29 09:51:00 +020054#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <linux/sort.h>
David Chinnere8234a62006-03-14 13:23:52 +110068#include <linux/cpu.h>
69#include <linux/notifier.h>
David Chinner01e1b692006-03-14 13:29:16 +110070#include <linux/delay.h>
Eric Sandeenaf3a2e82007-08-16 16:25:23 +100071#include <linux/log2.h>
Eric Sandeen007c61c2007-10-11 17:43:56 +100072#include <linux/spinlock.h>
David Chinner64275ea2008-04-30 17:11:16 +100073#include <linux/random.h>
Barry Naujok189f4bf2008-05-21 16:58:55 +100074#include <linux/ctype.h>
David Chinner6bfb3d02008-10-30 18:32:43 +110075#include <linux/writeback.h>
Christoph Hellwig6c77b0e2010-10-06 18:41:17 +000076#include <linux/capability.h>
Christoph Hellwig00308072011-10-11 11:14:10 -040077#include <linux/kthread.h>
78#include <linux/freezer.h>
Christoph Hellwig8a072a42011-04-24 19:06:17 +000079#include <linux/list_sort.h>
Rich Johnston3d6e0362013-03-27 09:26:49 -050080#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82#include <asm/page.h>
83#include <asm/div64.h>
84#include <asm/param.h>
85#include <asm/uaccess.h>
86#include <asm/byteorder.h>
87#include <asm/unaligned.h>
88
Dave Chinnerb92cc59f62014-08-04 13:28:20 +100089#include "xfs_fs.h"
Alex Elder06f8e2d2011-08-12 13:57:55 -050090#include "xfs_stats.h"
91#include "xfs_sysctl.h"
92#include "xfs_iops.h"
93#include "xfs_aops.h"
94#include "xfs_super.h"
Eric Sandeen51582172014-02-27 15:17:27 +110095#include "xfs_cksum.h"
Alex Elder06f8e2d2011-08-12 13:57:55 -050096#include "xfs_buf.h"
97#include "xfs_message.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Christoph Hellwig218106a2011-07-08 14:35:58 +020099#ifdef __BIG_ENDIAN
100#define XFS_NATIVE_HOST 1
101#else
102#undef XFS_NATIVE_HOST
103#endif
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105#define irix_sgid_inherit xfs_params.sgid_inherit.val
106#define irix_symlink_mode xfs_params.symlink_mode.val
107#define xfs_panic_mask xfs_params.panic_mask.val
108#define xfs_error_level xfs_params.error_level.val
109#define xfs_syncd_centisecs xfs_params.syncd_timer.val
110#define xfs_stats_clear xfs_params.stats_clear.val
111#define xfs_inherit_sync xfs_params.inherit_sync.val
112#define xfs_inherit_nodump xfs_params.inherit_nodump.val
113#define xfs_inherit_noatime xfs_params.inherit_noatim.val
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114#define xfs_inherit_nosymlinks xfs_params.inherit_nosym.val
115#define xfs_rotorstep xfs_params.rotorstep.val
Barry Naujokd3446ea2006-06-09 14:54:19 +1000116#define xfs_inherit_nodefrag xfs_params.inherit_nodfrg.val
David Chinner2a82b8b2007-07-11 11:09:12 +1000117#define xfs_fstrm_centisecs xfs_params.fstrm_timer.val
Brian Foster579b62f2012-11-06 09:50:47 -0500118#define xfs_eofb_secs xfs_params.eofb_timer.val
Darrick J. Wong83104d42016-10-03 09:11:46 -0700119#define xfs_cowb_secs xfs_params.cowb_timer.val
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Nathan Scott59c1b082006-06-09 14:59:13 +1000121#define current_cpu() (raw_smp_processor_id())
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122#define current_pid() (current->pid)
Nathan Scott59c1b082006-06-09 14:59:13 +1000123#define current_test_flags(f) (current->flags & (f))
Nathan Scott59c1b082006-06-09 14:59:13 +1000124#define current_set_flags_nested(sp, f) \
125 (*(sp) = current->flags, current->flags |= (f))
126#define current_clear_flags_nested(sp, f) \
127 (*(sp) = current->flags, current->flags &= ~(f))
128#define current_restore_flags_nested(sp, f) \
129 (current->flags = ((current->flags & ~(f)) | (*(sp) & (f))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Eric Sandeen007c61c2007-10-11 17:43:56 +1000131#define spinlock_destroy(lock)
132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#define NBBY 8 /* number of bits per byte */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135/*
136 * Size of block device i/o is parameterized here.
137 * Currently the system supports page-sized i/o.
138 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300139#define BLKDEV_IOSHIFT PAGE_SHIFT
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140#define BLKDEV_IOSIZE (1<<BLKDEV_IOSHIFT)
141/* number of BB's per block device block */
142#define BLKDEV_BB BTOBB(BLKDEV_IOSIZE)
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144#define ENOATTR ENODATA /* Attribute not found */
Nathan Scottda2f4d62006-06-20 13:01:38 +1000145#define EWRONGFS EINVAL /* Mount with wrong filesystem type */
146#define EFSCORRUPTED EUCLEAN /* Filesystem is corrupted */
Eric Sandeenca23f8f2014-02-27 15:21:07 +1100147#define EFSBADCRC EBADMSG /* Bad CRC detected */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149#define SYNCHRONIZE() barrier()
150#define __return_address __builtin_return_address(0)
151
Arkadiusz Mi?kiewicz67430992010-09-26 06:10:18 +0000152#define XFS_PROJID_DEFAULT 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#define MAXPATHLEN 1024
154
155#define MIN(a,b) (min(a,b))
156#define MAX(a,b) (max(a,b))
157#define howmany(x, y) (((x)+((y)-1))/(y))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Dave Chinnere076b0f2014-10-02 09:18:13 +1000159static inline void delay(long ticks)
160{
161 schedule_timeout_uninterruptible(ticks);
162}
163
Brian Fostera31b1d32014-07-15 08:07:01 +1000164/*
165 * XFS wrapper structure for sysfs support. It depends on external data
166 * structures and is embedded in various internal data structures to implement
167 * the XFS sysfs object heirarchy. Define it here for broad access throughout
168 * the codebase.
169 */
170struct xfs_kobj {
171 struct kobject kobject;
172 struct completion complete;
173};
174
Bill O'Donnell80529c42015-10-12 05:19:45 +1100175struct xstats {
176 struct xfsstats __percpu *xs_stats;
177 struct xfs_kobj xs_kobj;
178};
179
180extern struct xstats xfsstats;
181
Dwight Engenc5eeb7e2013-08-15 14:07:58 -0400182/* Kernel uid/gid conversion. These are used to convert to/from the on disk
183 * uid_t/gid_t types to the kuid_t/kgid_t types that the kernel uses internally.
184 * The conversion here is type only, the value will remain the same since we
185 * are converting to the init_user_ns. The uid is later mapped to a particular
186 * user namespace value when crossing the kernel/user boundary.
187 */
188static inline __uint32_t xfs_kuid_to_uid(kuid_t uid)
189{
190 return from_kuid(&init_user_ns, uid);
191}
192
193static inline kuid_t xfs_uid_to_kuid(__uint32_t uid)
194{
195 return make_kuid(&init_user_ns, uid);
196}
197
198static inline __uint32_t xfs_kgid_to_gid(kgid_t gid)
199{
200 return from_kgid(&init_user_ns, gid);
201}
202
203static inline kgid_t xfs_gid_to_kgid(__uint32_t gid)
204{
205 return make_kgid(&init_user_ns, gid);
206}
207
Nathan Scottcde410a2005-09-05 11:47:01 +1000208/*
209 * Various platform dependent calls that don't fit anywhere else
210 */
Nathan Scott380b5dc2005-11-02 11:43:18 +1100211#define xfs_sort(a,n,s,fn) sort(a,n,s,fn,NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212#define xfs_stack_trace() dump_stack()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214
215/* Move the kernel do_div definition off to one side */
216
217#if defined __i386__
218/* For ia32 we need to pull some tricks to get past various versions
219 * of the compiler which do not like us using do_div in the middle
220 * of large functions.
221 */
222static inline __u32 xfs_do_div(void *a, __u32 b, int n)
223{
224 __u32 mod;
225
226 switch (n) {
227 case 4:
228 mod = *(__u32 *)a % b;
229 *(__u32 *)a = *(__u32 *)a / b;
230 return mod;
231 case 8:
232 {
233 unsigned long __upper, __low, __high, __mod;
234 __u64 c = *(__u64 *)a;
235 __upper = __high = c >> 32;
236 __low = c;
237 if (__high) {
238 __upper = __high % (b);
239 __high = __high / (b);
240 }
241 asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
242 asm("":"=A" (c):"a" (__low),"d" (__high));
243 *(__u64 *)a = c;
244 return __mod;
245 }
246 }
247
248 /* NOTREACHED */
249 return 0;
250}
251
252/* Side effect free 64 bit mod operation */
253static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
254{
255 switch (n) {
256 case 4:
257 return *(__u32 *)a % b;
258 case 8:
259 {
260 unsigned long __upper, __low, __high, __mod;
261 __u64 c = *(__u64 *)a;
262 __upper = __high = c >> 32;
263 __low = c;
264 if (__high) {
265 __upper = __high % (b);
266 __high = __high / (b);
267 }
268 asm("divl %2":"=a" (__low), "=d" (__mod):"rm" (b), "0" (__low), "1" (__upper));
269 asm("":"=A" (c):"a" (__low),"d" (__high));
270 return __mod;
271 }
272 }
273
274 /* NOTREACHED */
275 return 0;
276}
277#else
278static inline __u32 xfs_do_div(void *a, __u32 b, int n)
279{
280 __u32 mod;
281
282 switch (n) {
283 case 4:
284 mod = *(__u32 *)a % b;
285 *(__u32 *)a = *(__u32 *)a / b;
286 return mod;
287 case 8:
288 mod = do_div(*(__u64 *)a, b);
289 return mod;
290 }
291
292 /* NOTREACHED */
293 return 0;
294}
295
296/* Side effect free 64 bit mod operation */
297static inline __u32 xfs_do_mod(void *a, __u32 b, int n)
298{
299 switch (n) {
300 case 4:
301 return *(__u32 *)a % b;
302 case 8:
303 {
304 __u64 c = *(__u64 *)a;
305 return do_div(c, b);
306 }
307 }
308
309 /* NOTREACHED */
310 return 0;
311}
312#endif
313
314#undef do_div
315#define do_div(a, b) xfs_do_div(&(a), (b), sizeof(a))
316#define do_mod(a, b) xfs_do_mod(&(a), (b), sizeof(a))
317
318static inline __uint64_t roundup_64(__uint64_t x, __uint32_t y)
319{
320 x += y - 1;
321 do_div(x, y);
Eric Sandeend99831f2014-06-22 15:03:54 +1000322 return x * y;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323}
324
Nathan Scott68c32712006-09-28 11:03:53 +1000325static inline __uint64_t howmany_64(__uint64_t x, __uint32_t y)
326{
327 x += y - 1;
328 do_div(x, y);
329 return x;
330}
331
Dave Chinner91300902011-03-07 10:09:35 +1100332#define ASSERT_ALWAYS(expr) \
333 (unlikely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
334
Dave Chinner742ae1e2013-04-30 21:39:34 +1000335#ifdef DEBUG
Dave Chinner91300902011-03-07 10:09:35 +1100336#define ASSERT(expr) \
337 (unlikely(expr) ? (void)0 : assfail(#expr, __FILE__, __LINE__))
338
339#ifndef STATIC
340# define STATIC noinline
341#endif
342
Dave Chinner742ae1e2013-04-30 21:39:34 +1000343#else /* !DEBUG */
344
345#ifdef XFS_WARN
346
347#define ASSERT(expr) \
348 (unlikely(expr) ? (void)0 : asswarn(#expr, __FILE__, __LINE__))
349
350#ifndef STATIC
351# define STATIC static noinline
352#endif
353
354#else /* !DEBUG && !XFS_WARN */
355
356#define ASSERT(expr) ((void)0)
357
358#ifndef STATIC
359# define STATIC static noinline
360#endif
361
362#endif /* XFS_WARN */
Dave Chinner91300902011-03-07 10:09:35 +1100363#endif /* DEBUG */
364
Christoph Hellwig6d3ebaa2014-11-28 14:24:06 +1100365#ifdef CONFIG_XFS_RT
366#define XFS_IS_REALTIME_INODE(ip) ((ip)->i_d.di_flags & XFS_DIFLAG_REALTIME)
367#else
368#define XFS_IS_REALTIME_INODE(ip) (0)
369#endif
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371#endif /* __XFS_LINUX__ */