blob: af73d93b14151250a2e3a400e8292c31227c148d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_FS_H
2#define _LINUX_FS_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/linkage.h>
5#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/kdev_t.h>
7#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04008#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/stat.h>
10#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100012#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070013#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/radix-tree.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070015#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040017#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050018#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080019#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080020#include <linux/rwsem.h>
Dan Williamsb29ea3c2018-02-23 14:05:49 -080021#include <linux/mm_types.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053022#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040023#include <linux/semaphore.h>
Jaegeuk Kimd9197652018-01-05 10:44:52 -080024#include <linux/fcntl.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040025#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110026#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040027#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080028#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110029#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080030#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020031#include <linux/lockdep.h>
Jens Axboec2b1ad802012-09-27 09:35:03 +020032#include <linux/percpu-rwsem.h>
David Howells08cce05c2012-10-13 10:45:06 +010033#include <linux/blk_types.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020034#include <linux/workqueue.h>
Oleg Nesterov8129ed22015-08-11 17:05:04 +020035#include <linux/percpu-rwsem.h>
Al Virofceef392015-12-29 15:58:39 -050036#include <linux/delayed_call.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010039#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010041struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040042struct bdi_writeback;
Christoph Hellwiga5694252007-07-17 04:04:28 -070043struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080044struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070046struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020047struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048struct pipe_inode_info;
49struct poll_table_struct;
50struct kstatfs;
51struct vm_area_struct;
52struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110053struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070054struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080055struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020056struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050057struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070058struct fscrypt_info;
59struct fscrypt_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Denis Cheng74bf17c2007-10-16 23:26:30 -070061extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070063extern void __init files_init(void);
64extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Jan Engelhardtdded4f42008-12-01 14:34:50 -080066extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070067extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030068extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080069extern struct inodes_stat_t inodes_stat;
70extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070071extern int sysctl_protected_symlinks;
72extern int sysctl_protected_hardlinks;
Salvatore Mesoraca0c41bee2018-08-23 17:00:35 -070073extern int sysctl_protected_fifos;
74extern int sysctl_protected_regular;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080075
Linus Torvalds1da177e2005-04-16 15:20:36 -070076struct buffer_head;
77typedef int (get_block_t)(struct inode *inode, sector_t iblock,
78 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110079typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020080 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
David Howellsbbc10962012-10-15 16:40:35 +010082#define MAY_EXEC 0x00000001
83#define MAY_WRITE 0x00000002
84#define MAY_READ 0x00000004
85#define MAY_APPEND 0x00000008
86#define MAY_ACCESS 0x00000010
87#define MAY_OPEN 0x00000020
88#define MAY_CHDIR 0x00000040
89/* called from RCU mode, don't block */
90#define MAY_NOT_BLOCK 0x00000080
91
92/*
93 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
94 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
95 */
96
97/* file is open for reading */
98#define FMODE_READ ((__force fmode_t)0x1)
99/* file is open for writing */
100#define FMODE_WRITE ((__force fmode_t)0x2)
101/* file is seekable */
102#define FMODE_LSEEK ((__force fmode_t)0x4)
103/* file can be accessed using pread */
104#define FMODE_PREAD ((__force fmode_t)0x8)
105/* file can be accessed using pwrite */
106#define FMODE_PWRITE ((__force fmode_t)0x10)
107/* File is opened for execution with sys_execve / sys_uselib */
108#define FMODE_EXEC ((__force fmode_t)0x20)
109/* File is opened with O_NDELAY (only set for block devices) */
110#define FMODE_NDELAY ((__force fmode_t)0x40)
111/* File is opened with O_EXCL (only set for block devices) */
112#define FMODE_EXCL ((__force fmode_t)0x80)
113/* File is opened using open(.., 3, ..) and is writeable only for ioctls
114 (specialy hack for floppy.c) */
115#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
116/* 32bit hashes as llseek() offset (for directories) */
117#define FMODE_32BITHASH ((__force fmode_t)0x200)
118/* 64bit hashes as llseek() offset (for directories) */
119#define FMODE_64BITHASH ((__force fmode_t)0x400)
120
121/*
122 * Don't update ctime and mtime.
123 *
124 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
125 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
126 */
127#define FMODE_NOCMTIME ((__force fmode_t)0x800)
128
129/* Expect random access pattern */
130#define FMODE_RANDOM ((__force fmode_t)0x1000)
131
132/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
133#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
134
135/* File is opened with O_PATH; almost nothing can be done with it */
136#define FMODE_PATH ((__force fmode_t)0x4000)
137
Linus Torvalds9c225f22014-03-03 09:36:58 -0800138/* File needs atomic accesses to f_pos */
139#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400140/* Write access to underlying fs */
141#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500142/* Has read method(s) */
143#define FMODE_CAN_READ ((__force fmode_t)0x20000)
144/* Has write method(s) */
145#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800146
Kirill Smelkov9c829b62019-03-26 22:20:43 +0000147/* File is stream-like */
148#define FMODE_STREAM ((__force fmode_t)0x200000)
149
David Howellsbbc10962012-10-15 16:40:35 +0100150/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800151#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100152
Jaegeuk Kimd9197652018-01-05 10:44:52 -0800153/* File is capable of returning -EAGAIN if I/O will block */
154#define FMODE_NOWAIT ((__force fmode_t)0x8000000)
155
David Howellsbbc10962012-10-15 16:40:35 +0100156/*
157 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
158 * that indicates that they should check the contents of the iovec are
159 * valid, but not check the memory that the iovec elements
160 * points too.
161 */
162#define CHECK_IOVEC_ONLY -1
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164/*
Mike Christie4e1b2d522016-06-05 14:32:22 -0500165 * The below are the various read and write flags that we support. Some of
David Howells08cce05c2012-10-13 10:45:06 +0100166 * them include behavioral modifiers that send information down to the
Mike Christie4e1b2d522016-06-05 14:32:22 -0500167 * block layer and IO scheduler. They should be used along with a req_op.
168 * Terminology:
David Howells08cce05c2012-10-13 10:45:06 +0100169 *
170 * The block layer uses device plugging to defer IO a little bit, in
171 * the hope that we will see more IO very shortly. This increases
172 * coalescing of adjacent IO and thus reduces the number of IOs we
173 * have to send to the device. It also allows for better queuing,
174 * if the IO isn't mergeable. If the caller is going to be waiting
175 * for the IO, then he must ensure that the device is unplugged so
176 * that the IO is dispatched to the driver.
177 *
178 * All IO is handled async in Linux. This is fine for background
179 * writes, but for reads or writes that someone waits for completion
180 * on, we want to notify the block layer and IO scheduler so that they
181 * know about it. That allows them to make better scheduling
182 * decisions. So when the below references 'sync' and 'async', it
183 * is referencing this priority hint.
184 *
185 * With that in mind, the available types are:
186 *
187 * READ A normal read operation. Device will be plugged.
188 * READ_SYNC A synchronous read. Device is not plugged, caller can
189 * immediately wait on this read without caring about
190 * unplugging.
David Howells08cce05c2012-10-13 10:45:06 +0100191 * WRITE A normal async write. Device will be plugged.
192 * WRITE_SYNC Synchronous write. Identical to WRITE, but passes down
193 * the hint that someone will be waiting on this IO
194 * shortly. The write equivalent of READ_SYNC.
195 * WRITE_ODIRECT Special case write for O_DIRECT only.
196 * WRITE_FLUSH Like WRITE_SYNC but with preceding cache flush.
197 * WRITE_FUA Like WRITE_SYNC but data is guaranteed to be on
198 * non-volatile media on completion.
199 * WRITE_FLUSH_FUA Combination of WRITE_FLUSH and FUA. The IO is preceded
200 * by a cache flush and data is guaranteed to be on
201 * non-volatile media on completion.
202 *
203 */
Mike Christie4e1b2d522016-06-05 14:32:22 -0500204#define RW_MASK REQ_OP_WRITE
David Howells08cce05c2012-10-13 10:45:06 +0100205
Mike Christie4e1b2d522016-06-05 14:32:22 -0500206#define READ REQ_OP_READ
Christoph Hellwig70246282016-07-19 11:28:41 +0200207#define WRITE REQ_OP_WRITE
David Howells08cce05c2012-10-13 10:45:06 +0100208
Mike Christie4e1b2d522016-06-05 14:32:22 -0500209#define READ_SYNC REQ_SYNC
210#define WRITE_SYNC (REQ_SYNC | REQ_NOIDLE)
211#define WRITE_ODIRECT REQ_SYNC
Mike Christie28a8f0d2016-06-05 14:32:25 -0500212#define WRITE_FLUSH (REQ_SYNC | REQ_NOIDLE | REQ_PREFLUSH)
Mike Christie4e1b2d522016-06-05 14:32:22 -0500213#define WRITE_FUA (REQ_SYNC | REQ_NOIDLE | REQ_FUA)
Mike Christie28a8f0d2016-06-05 14:32:25 -0500214#define WRITE_FLUSH_FUA (REQ_SYNC | REQ_NOIDLE | REQ_PREFLUSH | REQ_FUA)
David Howells08cce05c2012-10-13 10:45:06 +0100215
216/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 * Attribute flags. These should be or-ed together to figure out what
218 * has been changed!
219 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200220#define ATTR_MODE (1 << 0)
221#define ATTR_UID (1 << 1)
222#define ATTR_GID (1 << 2)
223#define ATTR_SIZE (1 << 3)
224#define ATTR_ATIME (1 << 4)
225#define ATTR_MTIME (1 << 5)
226#define ATTR_CTIME (1 << 6)
227#define ATTR_ATIME_SET (1 << 7)
228#define ATTR_MTIME_SET (1 << 8)
229#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
230#define ATTR_ATTR_FLAG (1 << 10)
231#define ATTR_KILL_SUID (1 << 11)
232#define ATTR_KILL_SGID (1 << 12)
233#define ATTR_FILE (1 << 13)
234#define ATTR_KILL_PRIV (1 << 14)
235#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
236#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200237#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200240 * Whiteout is represented by a char device. The following constants define the
241 * mode and device number to use.
242 */
243#define WHITEOUT_MODE 0
244#define WHITEOUT_DEV 0
245
246/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 * This is the Inode Attributes structure, used for notify_change(). It
248 * uses the above definitions as flags, to know which values have changed.
249 * Also, in this manner, a Filesystem can look at only the values it cares
250 * about. Basically, these are the attributes that the VFS layer can
251 * request to change from the FS layer.
252 *
253 * Derek Atkins <warlord@MIT.EDU> 94-10-20
254 */
255struct iattr {
256 unsigned int ia_valid;
257 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800258 kuid_t ia_uid;
259 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 loff_t ia_size;
261 struct timespec ia_atime;
262 struct timespec ia_mtime;
263 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800264
265 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300266 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800267 * implement an ftruncate() like method. NOTE: filesystem should
268 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
269 */
270 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271};
272
273/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 * Includes for diskquotas.
275 */
276#include <linux/quota.h>
277
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200278/*
279 * Maximum number of layers of fs stack. Needs to be limited to
280 * prevent kernel stack overflow
281 */
282#define FILESYSTEM_MAX_STACK_DEPTH 2
283
Zach Brown994fc28c2005-12-15 14:28:17 -0800284/**
285 * enum positive_aop_returns - aop return codes with specific semantics
286 *
287 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
288 * completed, that the page is still locked, and
289 * should be considered active. The VM uses this hint
290 * to return the page to the active list -- it won't
291 * be a candidate for writeback again in the near
292 * future. Other callers must be careful to unlock
293 * the page if they get this return. Returned by
294 * writepage();
295 *
296 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
297 * unlocked it and the page might have been truncated.
298 * The caller should back up to acquiring a new page and
299 * trying again. The aop will be taking reasonable
300 * precautions not to livelock. If the caller held a page
301 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700302 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800303 *
304 * address_space_operation functions return these large constants to indicate
305 * special semantics to the caller. These are much larger than the bytes in a
306 * page to allow for functions that return the number of bytes operated on in a
307 * given page.
308 */
309
310enum positive_aop_returns {
311 AOP_WRITEPAGE_ACTIVATE = 0x80000,
312 AOP_TRUNCATED_PAGE = 0x80001,
313};
314
Nick Pigginafddba42007-10-16 01:25:01 -0700315#define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
Nick Piggin89e10782007-10-16 01:25:07 -0700316#define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
Nick Piggin54566b22009-01-04 12:00:53 -0800317#define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
318 * helper code (eg buffer layer)
319 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321/*
322 * oh the beauties of C type declarations.
323 */
324struct page;
325struct address_space;
326struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Jaegeuk Kimd9197652018-01-05 10:44:52 -0800328/*
329 * Write life time hint values.
330 */
331enum rw_hint {
332 WRITE_LIFE_NOT_SET = 0,
333 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
334 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
335 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
336 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
337 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
338};
339
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800340#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400341#define IOCB_APPEND (1 << 1)
342#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100343#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700344#define IOCB_DSYNC (1 << 4)
345#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500346#define IOCB_WRITE (1 << 6)
Jaegeuk Kimd9197652018-01-05 10:44:52 -0800347#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800348
349struct kiocb {
350 struct file *ki_filp;
351 loff_t ki_pos;
352 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
353 void *private;
354 int ki_flags;
Jaegeuk Kimd9197652018-01-05 10:44:52 -0800355 enum rw_hint ki_hint;
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800356};
357
358static inline bool is_sync_kiocb(struct kiocb *kiocb)
359{
360 return kiocb->ki_complete == NULL;
361}
362
Al Viro2ba48ce2015-04-09 13:52:01 -0400363static inline int iocb_flags(struct file *file);
364
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800365static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
366{
367 *kiocb = (struct kiocb) {
368 .ki_filp = filp,
Al Viro2ba48ce2015-04-09 13:52:01 -0400369 .ki_flags = iocb_flags(filp),
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800370 };
371}
372
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700373/*
374 * "descriptor" for what we're up to with a read.
375 * This allows us to use the same read code yet
376 * have multiple different users of the data that
377 * we read from a file.
378 *
379 * The simplest case just copies the data to user
380 * mode.
381 */
382typedef struct {
383 size_t written;
384 size_t count;
385 union {
386 char __user *buf;
387 void *data;
388 } arg;
389 int error;
390} read_descriptor_t;
391
392typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
393 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395struct address_space_operations {
396 int (*writepage)(struct page *page, struct writeback_control *wbc);
397 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399 /* Write back some dirty pages from this mapping. */
400 int (*writepages)(struct address_space *, struct writeback_control *);
401
Andrew Morton4741c9f2006-03-24 03:18:11 -0800402 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 int (*set_page_dirty)(struct page *page);
404
405 int (*readpages)(struct file *filp, struct address_space *mapping,
406 struct list_head *pages, unsigned nr_pages);
407
Nick Pigginafddba42007-10-16 01:25:01 -0700408 int (*write_begin)(struct file *, struct address_space *mapping,
409 loff_t pos, unsigned len, unsigned flags,
410 struct page **pagep, void **fsdata);
411 int (*write_end)(struct file *, struct address_space *mapping,
412 loff_t pos, unsigned len, unsigned copied,
413 struct page *page, void *fsdata);
414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
416 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400417 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400418 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500419 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700420 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4a2012-01-12 17:19:34 -0800421 /*
Tang Chenef277c72013-07-08 16:00:21 -0700422 * migrate the contents of a page to the specified target. If
423 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4a2012-01-12 17:19:34 -0800424 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700425 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800426 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700427 bool (*isolate_page)(struct page *, isolate_mode_t);
428 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800429 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500430 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700431 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700432 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200433 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700434
435 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700436 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
437 sector_t *span);
438 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439};
440
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200441extern const struct address_space_operations empty_aops;
442
Nick Pigginafddba42007-10-16 01:25:01 -0700443/*
444 * pagecache_write_begin/pagecache_write_end must be used by general code
445 * to write into the pagecache.
446 */
447int pagecache_write_begin(struct file *, struct address_space *mapping,
448 loff_t pos, unsigned len, unsigned flags,
449 struct page **pagep, void **fsdata);
450
451int pagecache_write_end(struct file *, struct address_space *mapping,
452 loff_t pos, unsigned len, unsigned copied,
453 struct page *page, void *fsdata);
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455struct address_space {
456 struct inode *host; /* owner: inode, block_device */
457 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700458 spinlock_t tree_lock; /* and lock protecting it */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700459 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700460 struct rb_root i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800461 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Jan Kara08142572011-06-27 16:18:10 -0700462 /* Protected by tree_lock together with the radix tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800464 /* number of shadow or DAX exceptional entries */
465 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700467 const struct address_space_operations *a_ops; /* methods */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700468 unsigned long flags; /* error bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 spinlock_t private_lock; /* for use by the address_space */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700470 gfp_t gfp_mask; /* implicit gfp mask for allocations */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 struct list_head private_list; /* ditto */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800472 void *private_data; /* ditto */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473} __attribute__((aligned(sizeof(long))));
474 /*
475 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300476 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
478 */
Andi Kleen87192a22012-01-12 17:20:34 -0800479struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481struct block_device {
482 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700483 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500485 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800486 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900487 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 void * bd_holder;
489 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100490 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800491#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100492 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800493#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 struct block_device * bd_contains;
495 unsigned bd_block_size;
496 struct hd_struct * bd_part;
497 /* number of times partitions within this device have been opened. */
498 unsigned bd_part_count;
499 int bd_invalidated;
500 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800501 struct request_queue * bd_queue;
Jan Kara84972a92017-02-02 15:56:52 +0100502 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 /*
505 * Private data. You must have bd_claim'ed the block_device
506 * to use this. NOTE: bd_claim allows an owner to claim
507 * the same device multiple times, the owner must take special
508 * care to not mess up bd_private for that case.
509 */
510 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800511
512 /* The counter of freeze processes */
513 int bd_fsfreeze_count;
514 /* Mutex for freeze */
515 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516};
517
518/*
519 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
520 * radix trees
521 */
522#define PAGECACHE_TAG_DIRTY 0
523#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700524#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526int mapping_tagged(struct address_space *mapping, int tag);
527
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800528static inline void i_mmap_lock_write(struct address_space *mapping)
529{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800530 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800531}
532
533static inline void i_mmap_unlock_write(struct address_space *mapping)
534{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800535 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800536}
537
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800538static inline void i_mmap_lock_read(struct address_space *mapping)
539{
540 down_read(&mapping->i_mmap_rwsem);
541}
542
543static inline void i_mmap_unlock_read(struct address_space *mapping)
544{
545 up_read(&mapping->i_mmap_rwsem);
546}
547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548/*
549 * Might pages of this file be mapped into userspace?
550 */
551static inline int mapping_mapped(struct address_space *mapping)
552{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800553 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554}
555
556/*
557 * Might pages of this file have been modified in userspace?
558 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
559 * marks vma as VM_SHARED if it is shared, and the file was opened for
560 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700561 *
562 * If i_mmap_writable is negative, no new writable mappings are allowed. You
563 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
565static inline int mapping_writably_mapped(struct address_space *mapping)
566{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700567 return atomic_read(&mapping->i_mmap_writable) > 0;
568}
569
570static inline int mapping_map_writable(struct address_space *mapping)
571{
572 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
573 0 : -EPERM;
574}
575
576static inline void mapping_unmap_writable(struct address_space *mapping)
577{
578 atomic_dec(&mapping->i_mmap_writable);
579}
580
581static inline int mapping_deny_writable(struct address_space *mapping)
582{
583 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
584 0 : -EBUSY;
585}
586
587static inline void mapping_allow_writable(struct address_space *mapping)
588{
589 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
592/*
593 * Use sequence counter to get consistent i_size on 32-bit processors.
594 */
595#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
596#include <linux/seqlock.h>
597#define __NEED_I_SIZE_ORDERED
598#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
599#else
600#define i_size_ordered_init(inode) do { } while (0)
601#endif
602
Al Virof19d4a82009-06-08 19:50:45 -0400603struct posix_acl;
604#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200605#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400606
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100607static inline struct posix_acl *
608uncached_acl_sentinel(struct task_struct *task)
609{
610 return (void *)task + 1;
611}
612
613static inline bool
614is_uncached_acl(struct posix_acl *acl)
615{
616 return (long)acl & 1;
617}
618
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700619#define IOP_FASTPERM 0x0001
620#define IOP_LOOKUP 0x0002
621#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200622#define IOP_XATTR 0x0008
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700623
624/*
625 * Keep mostly read-only and often accessed (especially for
626 * the RCU path lookup and 'stat' data) fields at the beginning
627 * of the 'struct inode'
628 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100630 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700631 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800632 kuid_t i_uid;
633 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700634 unsigned int i_flags;
635
636#ifdef CONFIG_FS_POSIX_ACL
637 struct posix_acl *i_acl;
638 struct posix_acl *i_default_acl;
639#endif
640
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100641 const struct inode_operations *i_op;
642 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700643 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100644
Linus Torvalds13e12d12011-06-08 15:18:19 -0700645#ifdef CONFIG_SECURITY
646 void *i_security;
647#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100648
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700649 /* Stat data, not accessed from path walking */
650 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200651 /*
652 * Filesystems may only read i_nlink directly. They shall use the
653 * following functions for modification:
654 *
655 * (set|clear|inc|drop)_nlink
656 * inode_(inc|dec)_link_count
657 */
658 union {
659 const unsigned int i_nlink;
660 unsigned int __i_nlink;
661 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700662 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700663 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700664 struct timespec i_atime;
665 struct timespec i_mtime;
666 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400667 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
668 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700669 unsigned int i_blkbits;
Jaegeuk Kimd9197652018-01-05 10:44:52 -0800670 enum rw_hint i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700671 blkcnt_t i_blocks;
672
673#ifdef __NEED_I_SIZE_ORDERED
674 seqcount_t i_size_seqcount;
675#endif
676
677 /* Misc */
678 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400679 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700680
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100681 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400682 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100683
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500685 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400686#ifdef CONFIG_CGROUP_WRITEBACK
687 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400688
689 /* foreign inode detection, see wbc_detach_inode() */
690 int i_wb_frn_winner;
691 u16 i_wb_frn_avg_time;
692 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400693#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100694 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700696 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100697 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400698 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100699 struct rcu_head i_rcu;
700 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500701 u64 i_version;
Peter Zijlstrafb099f3b2020-03-04 11:28:31 +0100702 atomic64_t i_sequence; /* see futex */
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700703 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400704 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400705 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500706#ifdef CONFIG_IMA
707 atomic_t i_readcount; /* struct files open RO */
708#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800709 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500710 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700713 union {
714 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700715 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700716 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400717 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400718 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700719 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721 __u32 i_generation;
722
Eric Paris3be25f42009-05-21 17:01:26 -0400723#ifdef CONFIG_FSNOTIFY
724 __u32 i_fsnotify_mask; /* all events this inode cares about */
Eric Parise61ce862009-12-17 21:24:24 -0500725 struct hlist_head i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400726#endif
727
Chandan Rajendra3ce5fa32018-12-12 15:20:12 +0530728#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700729 struct fscrypt_info *i_crypt_info;
730#endif
731
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700732 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733};
734
Fabian Frederick61604a22017-02-27 14:28:32 -0800735static inline unsigned int i_blocksize(const struct inode *node)
736{
737 return (1 << node->i_blkbits);
738}
739
Al Viro1d3382cb2010-10-23 15:19:20 -0400740static inline int inode_unhashed(struct inode *inode)
741{
742 return hlist_unhashed(&inode->i_hash);
743}
744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700746 * inode->i_mutex nesting subclasses for the lock validator:
747 *
748 * 0: the object of the current VFS operation
749 * 1: parent
750 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400751 * 3: xattr
752 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100753 * 5: second parent (when locking independent directories in rename)
754 *
755 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400756 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700757 *
758 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100759 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700760 */
761enum inode_i_mutex_lock_class
762{
763 I_MUTEX_NORMAL,
764 I_MUTEX_PARENT,
765 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700766 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100767 I_MUTEX_NONDIR2,
768 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700769};
770
Al Viro59551022016-01-22 15:40:57 -0500771static inline void inode_lock(struct inode *inode)
772{
Al Viro9902af72016-04-15 15:08:36 -0400773 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500774}
775
776static inline void inode_unlock(struct inode *inode)
777{
Al Viro9902af72016-04-15 15:08:36 -0400778 up_write(&inode->i_rwsem);
779}
780
781static inline void inode_lock_shared(struct inode *inode)
782{
783 down_read(&inode->i_rwsem);
784}
785
786static inline void inode_unlock_shared(struct inode *inode)
787{
788 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500789}
790
791static inline int inode_trylock(struct inode *inode)
792{
Al Viro9902af72016-04-15 15:08:36 -0400793 return down_write_trylock(&inode->i_rwsem);
794}
795
796static inline int inode_trylock_shared(struct inode *inode)
797{
798 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500799}
800
801static inline int inode_is_locked(struct inode *inode)
802{
Al Viro9902af72016-04-15 15:08:36 -0400803 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500804}
805
806static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
807{
Al Viro9902af72016-04-15 15:08:36 -0400808 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500809}
810
J. Bruce Fields375e2892012-04-18 15:16:33 -0400811void lock_two_nondirectories(struct inode *, struct inode*);
812void unlock_two_nondirectories(struct inode *, struct inode*);
813
Ingo Molnarf2eace22006-07-03 00:25:05 -0700814/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 * NOTE: in a 32bit arch with a preemptable kernel and
816 * an UP compile the i_size_read/write must be atomic
817 * with respect to the local cpu (unlike with preempt disabled),
818 * but they don't need to be atomic with respect to other cpus like in
819 * true SMP (so they need either to either locally disable irq around
820 * the read or for example on x86 they can be still implemented as a
821 * cmpxchg8b without the need of the lock prefix). For SMP compiles
822 * and 64bit archs it makes no difference if preempt is enabled or not.
823 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800824static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
826#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
827 loff_t i_size;
828 unsigned int seq;
829
830 do {
831 seq = read_seqcount_begin(&inode->i_size_seqcount);
832 i_size = inode->i_size;
833 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
834 return i_size;
835#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
836 loff_t i_size;
837
838 preempt_disable();
839 i_size = inode->i_size;
840 preempt_enable();
841 return i_size;
842#else
843 return inode->i_size;
844#endif
845}
846
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700847/*
848 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
849 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
850 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
851 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852static inline void i_size_write(struct inode *inode, loff_t i_size)
853{
854#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700855 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 write_seqcount_begin(&inode->i_size_seqcount);
857 inode->i_size = i_size;
858 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700859 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
861 preempt_disable();
862 inode->i_size = i_size;
863 preempt_enable();
864#else
865 inode->i_size = i_size;
866#endif
867}
868
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800869static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870{
871 return MINOR(inode->i_rdev);
872}
873
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800874static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875{
876 return MAJOR(inode->i_rdev);
877}
878
879extern struct block_device *I_BDEV(struct inode *inode);
880
881struct fown_struct {
882 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700883 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
884 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800885 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 int signum; /* posix.1b rt signal to be delivered on IO */
887};
888
889/*
890 * Track a single file's readahead state
891 */
892struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700893 pgoff_t start; /* where readahead started */
894 unsigned int size; /* # of readahead pages */
895 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700896 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700897
Fengguang Wu937085a2007-10-16 01:24:31 -0700898 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700899 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700900 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Fengguang Wu5ce11102007-07-19 01:47:59 -0700903/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700904 * Check if @index falls in the readahead windows.
905 */
906static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
907{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700908 return (index >= ra->start &&
909 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700910}
911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800913 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700914 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800915 struct rcu_head fu_rcuhead;
916 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800917 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500918 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800919 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700920
921 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800922 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700923 * Must not be taken from IRQ context.
924 */
925 spinlock_t f_lock;
Al Viro516e0cc2008-07-26 00:39:17 -0400926 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400928 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800929 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 loff_t f_pos;
931 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100932 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 struct file_ra_state f_ra;
934
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700935 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700936#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700938#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 /* needed for tty driver, and maybe others */
940 void *private_data;
941
942#ifdef CONFIG_EPOLL
943 /* Used by fs/eventpoll.c to link all the hooks to this file */
944 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800945 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946#endif /* #ifdef CONFIG_EPOLL */
947 struct address_space *f_mapping;
Al Virobd2a31d2014-03-04 14:54:22 -0500948} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530950struct file_handle {
951 __u32 handle_bytes;
952 int handle_type;
953 /* file identifier */
954 unsigned char f_handle[0];
955};
956
Al Virocb0942b2012-08-27 14:48:26 -0400957static inline struct file *get_file(struct file *f)
958{
959 atomic_long_inc(&f->f_count);
960 return f;
961}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700962#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400963#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400964#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966#define MAX_NON_LFS ((1UL<<31) - 1)
967
968/* Page cache limit. The filesystems should put that into their s_maxbytes
969 limits, otherwise bad things can happen in VM. */
970#if BITS_PER_LONG==32
Linus Torvaldsb8fce382017-08-27 12:12:25 -0700971#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972#elif BITS_PER_LONG==64
Linus Torvaldsb8fce382017-08-27 12:12:25 -0700973#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974#endif
975
976#define FL_POSIX 1
977#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400978#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400980#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700982#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400984#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
985#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400986#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100987#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
989/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700990 * Special return value from posix_lock_file() and vfs_lock_file() for
991 * asynchronous locking.
992 */
993#define FILE_LOCK_DEFERRED 1
994
Jeff Layton7ca76312014-09-01 19:04:48 -0400995/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200996typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Jeff Laytona7231a92015-01-16 15:05:56 -0500998struct file_lock;
999
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1002 void (*fl_release_private)(struct file_lock *);
1003};
1004
1005struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001006 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -04001007 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -04001008 fl_owner_t (*lm_get_owner)(fl_owner_t);
1009 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001010 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -04001011 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001012 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -05001013 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001014 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015};
1016
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001017struct lock_manager {
1018 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001019 /*
1020 * NFSv4 and up also want opens blocked during the grace period;
1021 * NLM doesn't care:
1022 */
1023 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001024};
1025
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001026struct net;
1027void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001028void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001029int locks_in_grace(struct net *);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001030int opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032/* that will die - we need it for nfs_lock_info */
1033#include <linux/nfs_fs_i.h>
1034
Jeff Layton1cb36012013-06-21 08:58:12 -04001035/*
1036 * struct file_lock represents a generic "file lock". It's used to represent
1037 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1038 * note that the same struct is used to represent both a request for a lock and
1039 * the lock itself, but the same object is never used for both.
1040 *
1041 * FIXME: should we create a separate "struct lock_request" to help distinguish
1042 * these two uses?
1043 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001044 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -04001045 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001046 * 1) lock owner
1047 * 2) lock range start
1048 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001049 *
1050 * Obviously, the last two criteria only matter for POSIX locks.
1051 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052struct file_lock {
1053 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001054 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001055 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 struct list_head fl_block; /* circular list of blocked processes */
1057 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001058 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001059 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001061 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00001062 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 wait_queue_head_t fl_wait;
1064 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 loff_t fl_start;
1066 loff_t fl_end;
1067
1068 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001069 /* for lease breaks: */
1070 unsigned long fl_break_time;
1071 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001073 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001074 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 union {
1076 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001077 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001078 struct {
1079 struct list_head link; /* link in AFS vnode's pending_locks list */
1080 int state; /* state of grant or error if -ve */
1081 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 } fl_u;
1083};
1084
Jeff Layton4a075e32015-01-16 15:05:54 -05001085struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001086 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001087 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001088 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001089 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001090};
1091
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092/* The following constant reflects the upper bound of the file/locking space */
1093#ifndef OFFSET_MAX
1094#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1095#define OFFSET_MAX INT_LIMIT(loff_t)
1096#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1097#endif
1098
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001099extern void send_sigio(struct fown_struct *fown, int fd, int band);
1100
Miklos Szeredic568d682016-09-16 12:44:20 +02001101/*
1102 * Return the inode to use for locking
1103 *
1104 * For overlayfs this should be the overlay inode, not the real inode returned
1105 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1106 * equal.
1107 */
1108static inline struct inode *locks_inode(const struct file *f)
1109{
1110 return f->f_path.dentry->d_inode;
1111}
1112
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001113#ifdef CONFIG_FILE_LOCKING
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001114extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001115extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1116 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
1118#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001119extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001120extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1121 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122#endif
1123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1125extern int fcntl_getlease(struct file *filp);
1126
1127/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001128void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001129void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001131extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001133extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001135extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001136extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001137extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001138extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001139extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001140extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001141extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001142extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001143extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001144extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001146extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1147extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001148extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001149struct files_struct;
1150extern void show_fd_locks(struct seq_file *f,
1151 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001152#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001153static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1154 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001155{
1156 return -EINVAL;
1157}
1158
1159static inline int fcntl_setlk(unsigned int fd, struct file *file,
1160 unsigned int cmd, struct flock __user *user)
1161{
1162 return -EACCES;
1163}
1164
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001165#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001166static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1167 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001168{
1169 return -EINVAL;
1170}
1171
1172static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1173 unsigned int cmd, struct flock64 __user *user)
1174{
1175 return -EACCES;
1176}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001177#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001178static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1179{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001180 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001181}
1182
1183static inline int fcntl_getlease(struct file *filp)
1184{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001185 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001186}
1187
Jeff Layton4a075e32015-01-16 15:05:54 -05001188static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001189locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001190{
1191}
1192
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001193static inline void locks_init_lock(struct file_lock *fl)
1194{
1195 return;
1196}
1197
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001198static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001199{
1200 return;
1201}
1202
1203static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1204{
1205 return;
1206}
1207
1208static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1209{
1210 return;
1211}
1212
Jeff Layton78ed8a12014-02-03 12:13:08 -05001213static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001214{
1215 return;
1216}
1217
1218static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1219{
1220 return;
1221}
1222
1223static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1224 struct file_lock *conflock)
1225{
1226 return -ENOLCK;
1227}
1228
Jeff Laytonf891a292013-06-21 08:58:09 -04001229static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001230{
1231 return -ENOENT;
1232}
1233
1234static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1235{
1236 return 0;
1237}
1238
1239static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1240 struct file_lock *fl, struct file_lock *conf)
1241{
1242 return -ENOLCK;
1243}
1244
1245static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1246{
1247 return 0;
1248}
1249
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001250static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1251{
1252 return -ENOLCK;
1253}
1254
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001255static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001256{
1257 return 0;
1258}
1259
1260static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1261{
1262 return;
1263}
1264
1265static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001266 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001267{
1268 return -EINVAL;
1269}
1270
1271static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001272 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001273{
1274 return -EINVAL;
1275}
1276
Jeff Layton7448cc32015-01-16 15:05:57 -05001277static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001278 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001279{
1280 return -EINVAL;
1281}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001282
1283struct files_struct;
1284static inline void show_fd_locks(struct seq_file *f,
1285 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001286#endif /* !CONFIG_FILE_LOCKING */
1287
Jeff Laytonee296d72015-07-11 06:43:03 -04001288static inline struct inode *file_inode(const struct file *f)
1289{
1290 return f->f_inode;
1291}
1292
Miklos Szeredid101a122016-03-26 16:14:37 -04001293static inline struct dentry *file_dentry(const struct file *file)
1294{
Miklos Szeredi2d902672016-06-30 08:53:27 +02001295 return d_real(file->f_path.dentry, file_inode(file), 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001296}
1297
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001298static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1299{
Miklos Szeredic568d682016-09-16 12:44:20 +02001300 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001301}
1302
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001304 spinlock_t fa_lock;
1305 int magic;
1306 int fa_fd;
1307 struct fasync_struct *fa_next; /* singly linked list */
1308 struct file *fa_file;
1309 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310};
1311
1312#define FASYNC_MAGIC 0x4601
1313
1314/* SMP safe fasync helpers: */
1315extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001316extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1317extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1318extern struct fasync_struct *fasync_alloc(void);
1319extern void fasync_free(struct fasync_struct *);
1320
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321/* can be called from interrupts */
1322extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001324extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1325extern void f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001327extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328extern int send_sigurg(struct fown_struct *fown);
1329
Jan Kara5accdf82012-06-12 16:20:34 +02001330struct mm_struct;
1331
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332/*
1333 * Umount options
1334 */
1335
1336#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1337#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1338#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001339#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1340#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Tejun Heo46b15ca2015-06-16 18:48:31 -04001342/* sb->s_iflags */
1343#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001344#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001345#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Eric W. Biedermaneaa95922018-03-14 18:20:29 -05001346#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
Eric W. Biederman8654df42016-06-09 16:06:06 -05001348/* sb->s_iflags to limit user namespace mounts */
1349#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Jan Kara5accdf82012-06-12 16:20:34 +02001351/* Possible states of 'frozen' field */
1352enum {
1353 SB_UNFROZEN = 0, /* FS is unfrozen */
1354 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001355 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1356 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1357 * internal threads if needed) */
1358 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1359};
1360
1361#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1362
1363struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001364 int frozen; /* Is sb frozen? */
1365 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1366 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001367};
1368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369struct super_block {
1370 struct list_head s_list; /* Keep this first */
1371 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001372 unsigned char s_blocksize_bits;
1373 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001374 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001376 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001377 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001378 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001379 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001381 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 unsigned long s_magic;
1383 struct dentry *s_root;
1384 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001387#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001389#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001390 const struct xattr_handler **s_xattr;
Chandan Rajendra3ce5fa32018-12-12 15:20:12 +05301391#ifdef CONFIG_FS_ENCRYPTION
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001392 const struct fscrypt_operations *s_cop;
Chandan Rajendra3ce5fa32018-12-12 15:20:12 +05301393#endif
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001394
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001395 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001396 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001398 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001399 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001400 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001401 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 struct quota_info s_dquot; /* Diskquota specific options */
1403
Jan Kara5accdf82012-06-12 16:20:34 +02001404 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
1406 char s_id[32]; /* Informational name */
Linus Torvalds0bba0162011-04-12 15:21:04 -07001407 u8 s_uuid[16]; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
1409 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001410 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001411 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001413 /* Granularity of c/m/atime in ns.
1414 Cannot be worse than a second */
1415 u32 s_time_gran;
1416
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 /*
1418 * The next field is for VFS *only*. No filesystems have any business
1419 * even looking at it. You had been warned.
1420 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001421 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001423 /*
1424 * Filesystem subtype. If non-empty the filesystem type field
1425 * in /proc/mounts will be "type.subtype"
1426 */
1427 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001428
1429 /*
1430 * Saved mount options for lazy filesystems using
1431 * generic_show_options()
1432 */
Arnd Bergmann4d2deb42010-02-24 20:01:56 +01001433 char __rcu *s_options;
Al Viroc8aebb02010-12-18 10:22:30 -05001434 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001435
1436 /*
1437 * Saved pool identifier for cleancache (-1 means none)
1438 */
1439 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001440
1441 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e822011-11-21 12:11:31 +01001442
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001443 /* Number of inodes with nlink == 0 but still referenced */
1444 atomic_long_t s_remove_count;
1445
Miklos Szeredi4ed5e822011-11-21 12:11:31 +01001446 /* Being remounted read-only */
1447 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001448
1449 /* AIO completions deferred from interrupt context */
1450 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001451 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001452
1453 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001454 * Owning user namespace and default context in which to
1455 * interpret filesystem uids, gids, quotas, device nodes,
1456 * xattrs and security labels.
1457 */
1458 struct user_namespace *s_user_ns;
1459
1460 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001461 * Keep the lru lists last in the structure so they always sit on their
1462 * own individual cachelines.
1463 */
1464 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1465 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001466 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001467 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001468
Dave Chinnere97fedb2015-03-04 13:40:00 -05001469 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001470
1471 /*
1472 * Indicates how deep in a filesystem stack this SB is
1473 */
1474 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001475
1476 /* s_inode_list_lock protects s_inodes */
1477 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1478 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001479
1480 spinlock_t s_inode_wblist_lock;
1481 struct list_head s_inodes_wb; /* writeback inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482};
1483
Seth Forshee81754352014-12-11 10:15:45 -06001484/* Helper functions so that in most cases filesystems will
1485 * not need to deal directly with kuid_t and kgid_t and can
1486 * instead deal with the raw numeric values that are stored
1487 * in the filesystem.
1488 */
1489static inline uid_t i_uid_read(const struct inode *inode)
1490{
1491 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1492}
1493
1494static inline gid_t i_gid_read(const struct inode *inode)
1495{
1496 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1497}
1498
1499static inline void i_uid_write(struct inode *inode, uid_t uid)
1500{
1501 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1502}
1503
1504static inline void i_gid_write(struct inode *inode, gid_t gid)
1505{
1506 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1507}
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509extern struct timespec current_fs_time(struct super_block *sb);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07001510extern struct timespec current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
1512/*
1513 * Snapshotting support.
1514 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Jan Kara5accdf82012-06-12 16:20:34 +02001516void __sb_end_write(struct super_block *sb, int level);
1517int __sb_start_write(struct super_block *sb, int level, bool wait);
1518
Oleg Nesterovbee91822015-07-19 23:48:20 +02001519#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001520 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001521#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001522 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001523
Jan Kara5accdf82012-06-12 16:20:34 +02001524/**
1525 * sb_end_write - drop write access to a superblock
1526 * @sb: the super we wrote to
1527 *
1528 * Decrement number of writers to the filesystem. Wake up possible waiters
1529 * wanting to freeze the filesystem.
1530 */
1531static inline void sb_end_write(struct super_block *sb)
1532{
1533 __sb_end_write(sb, SB_FREEZE_WRITE);
1534}
1535
1536/**
1537 * sb_end_pagefault - drop write access to a superblock from a page fault
1538 * @sb: the super we wrote to
1539 *
1540 * Decrement number of processes handling write page fault to the filesystem.
1541 * Wake up possible waiters wanting to freeze the filesystem.
1542 */
1543static inline void sb_end_pagefault(struct super_block *sb)
1544{
1545 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1546}
1547
1548/**
1549 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1550 * @sb: the super we wrote to
1551 *
1552 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1553 * waiters wanting to freeze the filesystem.
1554 */
1555static inline void sb_end_intwrite(struct super_block *sb)
1556{
1557 __sb_end_write(sb, SB_FREEZE_FS);
1558}
1559
1560/**
1561 * sb_start_write - get write access to a superblock
1562 * @sb: the super we write to
1563 *
1564 * When a process wants to write data or metadata to a file system (i.e. dirty
1565 * a page or an inode), it should embed the operation in a sb_start_write() -
1566 * sb_end_write() pair to get exclusion against file system freezing. This
1567 * function increments number of writers preventing freezing. If the file
1568 * system is already frozen, the function waits until the file system is
1569 * thawed.
1570 *
1571 * Since freeze protection behaves as a lock, users have to preserve
1572 * ordering of freeze protection and other filesystem locks. Generally,
1573 * freeze protection should be the outermost lock. In particular, we have:
1574 *
1575 * sb_start_write
1576 * -> i_mutex (write path, truncate, directory ops, ...)
1577 * -> s_umount (freeze_super, thaw_super)
1578 */
1579static inline void sb_start_write(struct super_block *sb)
1580{
1581 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1582}
1583
1584static inline int sb_start_write_trylock(struct super_block *sb)
1585{
1586 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1587}
1588
1589/**
1590 * sb_start_pagefault - get write access to a superblock from a page fault
1591 * @sb: the super we write to
1592 *
1593 * When a process starts handling write page fault, it should embed the
1594 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1595 * exclusion against file system freezing. This is needed since the page fault
1596 * is going to dirty a page. This function increments number of running page
1597 * faults preventing freezing. If the file system is already frozen, the
1598 * function waits until the file system is thawed.
1599 *
1600 * Since page fault freeze protection behaves as a lock, users have to preserve
1601 * ordering of freeze protection and other filesystem locks. It is advised to
1602 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1603 * handling code implies lock dependency:
1604 *
1605 * mmap_sem
1606 * -> sb_start_pagefault
1607 */
1608static inline void sb_start_pagefault(struct super_block *sb)
1609{
1610 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1611}
1612
1613/*
1614 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1615 * @sb: the super we write to
1616 *
1617 * This is the third level of protection against filesystem freezing. It is
1618 * free for use by a filesystem. The only requirement is that it must rank
1619 * below sb_start_pagefault.
1620 *
1621 * For example filesystem can call sb_start_intwrite() when starting a
1622 * transaction which somewhat eases handling of freezing for internal sources
1623 * of filesystem changes (internal fs threads, discarding preallocation on file
1624 * close, etc.).
1625 */
1626static inline void sb_start_intwrite(struct super_block *sb)
1627{
1628 __sb_start_write(sb, SB_FREEZE_FS, true);
1629}
1630
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001632extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634/*
1635 * VFS helper functions..
1636 */
Al Viro312b63f2012-06-10 18:09:36 -04001637extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001638extern int vfs_create2(struct vfsmount *, struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001639extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001640extern int vfs_mkdir2(struct vfsmount *, struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001641extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001642extern int vfs_mknod2(struct vfsmount *, struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001643extern int vfs_symlink(struct inode *, struct dentry *, const char *);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001644extern int vfs_symlink2(struct vfsmount *, struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001645extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001646extern int vfs_link2(struct vfsmount *, struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647extern int vfs_rmdir(struct inode *, struct dentry *);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001648extern int vfs_rmdir2(struct vfsmount *, struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001649extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001650extern int vfs_unlink2(struct vfsmount *, struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001651extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001652extern int vfs_rename2(struct vfsmount *, struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001653extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
1655/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001656 * VFS file helper functions.
1657 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001658extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001659 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001660extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001661/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001662 * VFS FS_IOC_FIEMAP helper definitions.
1663 */
1664struct fiemap_extent_info {
1665 unsigned int fi_flags; /* Flags as passed from user */
1666 unsigned int fi_extents_mapped; /* Number of mapped extents */
1667 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001668 struct fiemap_extent __user *fi_extents_start; /* Start of
1669 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001670};
1671int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1672 u64 phys, u64 len, u32 flags);
1673int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1674
1675/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 * File types
1677 *
1678 * NOTE! These match bits 12..15 of stat.st_mode
1679 * (ie "(i_mode >> 12) & 15").
1680 */
1681#define DT_UNKNOWN 0
1682#define DT_FIFO 1
1683#define DT_CHR 2
1684#define DT_DIR 4
1685#define DT_BLK 6
1686#define DT_REG 8
1687#define DT_LNK 10
1688#define DT_SOCK 12
1689#define DT_WHT 14
1690
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691/*
1692 * This is the "filldir" function type, used by readdir() to let
1693 * the kernel specify what kind of dirent layout it wants to have.
1694 * This allows the kernel to read directories into kernel space or
1695 * to have different dirent layouts depending on the binary type.
1696 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001697struct dir_context;
1698typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1699 unsigned);
1700
Al Viro5c0ba4e2013-05-15 13:52:59 -04001701struct dir_context {
Al Viroac6614b2013-05-22 22:22:04 -04001702 const filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001703 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001704};
Al Virobb6f6192013-05-15 18:49:12 -04001705
Al Viro08f85852007-10-08 13:26:20 -04001706struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708/* These macros are for out of kernel modules to test that
1709 * the kernel supports the unlocked_ioctl and compat_ioctl
1710 * fields in struct file_operations. */
1711#define HAVE_COMPAT_IOCTL 1
1712#define HAVE_UNLOCKED_IOCTL 1
1713
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001714/*
1715 * These flags let !MMU mmap() govern direct device mapping vs immediate
1716 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1717 *
1718 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1719 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1720 * NOMMU_MAP_READ: Can be mapped for reading
1721 * NOMMU_MAP_WRITE: Can be mapped for writing
1722 * NOMMU_MAP_EXEC: Can be mapped for execution
1723 */
1724#define NOMMU_MAP_COPY 0x00000001
1725#define NOMMU_MAP_DIRECT 0x00000008
1726#define NOMMU_MAP_READ VM_MAYREAD
1727#define NOMMU_MAP_WRITE VM_MAYWRITE
1728#define NOMMU_MAP_EXEC VM_MAYEXEC
1729
1730#define NOMMU_VMFLAGS \
1731 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1732
1733
Al Viro293bc982014-02-11 18:37:41 -05001734struct iov_iter;
1735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736struct file_operations {
1737 struct module *owner;
1738 loff_t (*llseek) (struct file *, loff_t, int);
1739 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001741 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1742 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001743 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001744 int (*iterate_shared) (struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1747 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1748 int (*mmap) (struct file *, struct vm_area_struct *);
1749 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001750 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001752 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 int (*fasync) (int, struct file *, int);
1754 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1756 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1757 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001759 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1760 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001761 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001762 long (*fallocate)(struct file *file, int mode, loff_t offset,
1763 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001764 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001765#ifndef CONFIG_MMU
1766 unsigned (*mmap_capabilities)(struct file *);
1767#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001768 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1769 loff_t, size_t, unsigned int);
1770 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1771 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001772 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1773 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774};
1775
1776struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001777 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001778 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb2011-06-20 19:28:19 -04001779 int (*permission) (struct inode *, int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001780 int (*permission2) (struct vfsmount *, struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001781 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001782
1783 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001784
Al Viroebfc3b42012-06-10 18:05:36 -04001785 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 int (*link) (struct dentry *,struct inode *,struct dentry *);
1787 int (*unlink) (struct inode *,struct dentry *);
1788 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001789 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001791 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001793 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 int (*setattr) (struct dentry *, struct iattr *);
Daniel Rosenberg2757e9b2016-10-26 16:33:11 -07001795 int (*setattr2) (struct vfsmount *, struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001798 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1799 u64 len);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001800 int (*update_time)(struct inode *, struct timespec *, int);
Al Virod9585272012-06-22 12:39:14 +04001801 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001802 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001803 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001804 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001805 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001806} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001808ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001809 unsigned long nr_segs, unsigned long fast_segs,
1810 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001811 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001812
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001813extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001814extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1816extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1817extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001818 unsigned long, loff_t *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001820 unsigned long, loff_t *, int);
Zach Brown29732932015-11-10 16:53:30 -05001821extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1822 loff_t, size_t, unsigned int);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001823extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1824 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001825extern int vfs_dedupe_file_range(struct file *file,
1826 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828struct super_operations {
1829 struct inode *(*alloc_inode)(struct super_block *sb);
1830 void (*destroy_inode)(struct inode *);
1831
Christoph Hellwigaa385722011-05-27 06:53:02 -04001832 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001833 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001834 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001835 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001838 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001839 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001840 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001841 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001842 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 int (*remount_fs) (struct super_block *, int *, char *);
Daniel Rosenberg29f888e2016-10-26 15:58:22 -07001844 int (*remount_fs2) (struct vfsmount *, struct super_block *, int *, char *);
Daniel Rosenberg1aaf05b2016-10-26 15:29:51 -07001845 void *(*clone_mnt_data) (void *);
1846 void (*copy_mnt_data) (void *, void *);
Al Viro42faad92008-04-24 07:21:56 -04001847 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
Al Viro34c80b12011-12-08 21:32:45 -05001849 int (*show_options)(struct seq_file *, struct dentry *);
Daniel Rosenberg29f888e2016-10-26 15:58:22 -07001850 int (*show_options2)(struct vfsmount *,struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001851 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001852 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001853 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001854#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1856 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001857 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001858#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001859 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001860 long (*nr_cached_objects)(struct super_block *,
1861 struct shrink_control *);
1862 long (*free_cached_objects)(struct super_block *,
1863 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864};
1865
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001866/*
David Howellsbbc10962012-10-15 16:40:35 +01001867 * Inode flags - they have no relation to superblock flags now
1868 */
1869#define S_SYNC 1 /* Writes are synced at once */
1870#define S_NOATIME 2 /* Do not update access times */
1871#define S_APPEND 4 /* Append-only file */
1872#define S_IMMUTABLE 8 /* Immutable file */
1873#define S_DEAD 16 /* removed, but still open directory */
1874#define S_NOQUOTA 32 /* Inode is not counted to quota */
1875#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1876#define S_NOCMTIME 128 /* Do not update file c/mtime */
1877#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1878#define S_PRIVATE 512 /* Inode is fs-internal */
1879#define S_IMA 1024 /* Inode has an associated IMA struct */
1880#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1881#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001882#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001883#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1884#else
1885#define S_DAX 0 /* Make all the DAX code disappear */
1886#endif
Jaegeuk Kim8dec0742017-06-22 12:14:40 -07001887#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
David Howellsbbc10962012-10-15 16:40:35 +01001888
1889/*
1890 * Note that nosuid etc flags are inode-specific: setting some file-system
1891 * flags just means all the inodes inherit those flags by default. It might be
1892 * possible to override it selectively if you really wanted to with some
1893 * ioctl() that is not currently implemented.
1894 *
1895 * Exception: MS_RDONLY is always applied to the entire file system.
1896 *
1897 * Unfortunately, it is possible to change a filesystems flags with it mounted
1898 * with files in use. This means that all of the inodes will not have their
1899 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1900 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1901 */
1902#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1903
1904#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1905#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1906 ((inode)->i_flags & S_SYNC))
1907#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1908 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1909#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1910#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1911#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1912
1913#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1914#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1915#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1916#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1917
1918#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1919#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1920#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1921#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1922#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1923#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1924#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001925#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Jaegeuk Kim8dec0742017-06-22 12:14:40 -07001926#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
David Howellsbbc10962012-10-15 16:40:35 +01001927
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001928#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1929 (inode)->i_rdev == WHITEOUT_DEV)
1930
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001931static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1932{
1933 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1934}
1935
David Howellsbbc10962012-10-15 16:40:35 +01001936/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001937 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001938 *
1939 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1940 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1941 *
1942 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1943 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1944 * various stages of removing an inode.
1945 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001946 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001947 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001948 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1949 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001950 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1951 * these changes separately from I_DIRTY_SYNC so that we
1952 * don't have to write inode on fdatasync() when only
1953 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001954 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001955 * I_NEW Serves as both a mutex and completion notification.
1956 * New inodes set I_NEW. If two processes both create
1957 * the same inode, one of them will release its inode and
1958 * wait for I_NEW to be released before returning.
1959 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1960 * also cause waiting on I_NEW, without I_NEW actually
1961 * being set. find_inode() uses this to prevent returning
1962 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001963 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1964 * is zero. I_FREEING must be set when I_WILL_FREE is
1965 * cleared.
1966 * I_FREEING Set when inode is about to be freed but still has dirty
1967 * pages or buffers attached or the inode itself is still
1968 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001969 * I_CLEAR Added by clear_inode(). In this state the inode is
1970 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001971 *
1972 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1973 * prohibited for many purposes. iget() must wait for
1974 * the inode to be completely released, then create it
1975 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001976 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001977 *
Jan Kara169ebd92012-05-03 14:48:03 +02001978 * I_SYNC Writeback of inode is running. The bit is set during
1979 * data writeback, and cleared with a wakeup on the bit
1980 * address once it is done. The bit is also used to pin
1981 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001982 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001983 * I_REFERENCED Marks the inode as recently references on the LRU list.
1984 *
1985 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1986 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001987 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1988 * synchronize competing switching instances and to tell
1989 * wb stat updates to grab mapping->tree_lock. See
1990 * inode_switch_wb_work_fn() for details.
1991 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001992 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001993 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001994#define I_DIRTY_SYNC (1 << 0)
1995#define I_DIRTY_DATASYNC (1 << 1)
1996#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001997#define __I_NEW 3
1998#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001999#define I_WILL_FREE (1 << 4)
2000#define I_FREEING (1 << 5)
2001#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002002#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002003#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002004#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002005#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002006#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002007#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002008#define I_DIRTY_TIME (1 << 11)
2009#define __I_DIRTY_TIME_EXPIRED 12
2010#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002011#define I_WB_SWITCH (1 << 13)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002014#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
2016extern void __mark_inode_dirty(struct inode *, int);
2017static inline void mark_inode_dirty(struct inode *inode)
2018{
2019 __mark_inode_dirty(inode, I_DIRTY);
2020}
2021
2022static inline void mark_inode_dirty_sync(struct inode *inode)
2023{
2024 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2025}
2026
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002027extern void inc_nlink(struct inode *inode);
2028extern void drop_nlink(struct inode *inode);
2029extern void clear_nlink(struct inode *inode);
2030extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002031
2032static inline void inode_inc_link_count(struct inode *inode)
2033{
2034 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002035 mark_inode_dirty(inode);
2036}
2037
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002038static inline void inode_dec_link_count(struct inode *inode)
2039{
2040 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002041 mark_inode_dirty(inode);
2042}
2043
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05002044/**
2045 * inode_inc_iversion - increments i_version
2046 * @inode: inode that need to be updated
2047 *
2048 * Every time the inode is modified, the i_version field will be incremented.
2049 * The filesystem has to be mounted with i_version flag
2050 */
2051
2052static inline void inode_inc_iversion(struct inode *inode)
2053{
2054 spin_lock(&inode->i_lock);
2055 inode->i_version++;
2056 spin_unlock(&inode->i_lock);
2057}
2058
Josef Bacikc3b2da32012-03-26 09:59:21 -04002059enum file_time_flags {
2060 S_ATIME = 1,
2061 S_MTIME = 2,
2062 S_CTIME = 4,
2063 S_VERSION = 8,
2064};
2065
Al Virobadcf2b2013-07-16 18:15:46 +04002066extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067static inline void file_accessed(struct file *file)
2068{
2069 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002070 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071}
2072
2073int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002074int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076struct file_system_type {
2077 const char *name;
2078 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002079#define FS_REQUIRES_DEV 1
2080#define FS_BINARY_MOUNTDATA 2
2081#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002082#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002083#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002084 struct dentry *(*mount) (struct file_system_type *, int,
2085 const char *, void *);
Daniel Rosenberg29f888e2016-10-26 15:58:22 -07002086 struct dentry *(*mount2) (struct vfsmount *, struct file_system_type *, int,
2087 const char *, void *);
Daniel Rosenberg1aaf05b2016-10-26 15:29:51 -07002088 void *(*alloc_mnt_data) (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 void (*kill_sb) (struct super_block *);
2090 struct module *owner;
2091 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002092 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002093
Ingo Molnarcf516242006-07-03 00:25:27 -07002094 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002095 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002096 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002097 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002098
2099 struct lock_class_key i_lock_key;
2100 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002101 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102};
2103
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002104#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2105
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002106extern struct dentry *mount_ns(struct file_system_type *fs_type,
2107 int flags, void *data, void *ns, struct user_namespace *user_ns,
2108 int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04002109extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2110 int flags, const char *dev_name, void *data,
2111 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002112extern struct dentry *mount_single(struct file_system_type *fs_type,
2113 int flags, void *data,
2114 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002115extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2116 int flags, void *data,
2117 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002118extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119void generic_shutdown_super(struct super_block *sb);
2120void kill_block_super(struct super_block *sb);
2121void kill_anon_super(struct super_block *sb);
2122void kill_litter_super(struct super_block *sb);
2123void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002124void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002126int get_anon_bdev(dev_t *);
2127void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002128struct super_block *sget_userns(struct file_system_type *type,
2129 int (*test)(struct super_block *,void *),
2130 int (*set)(struct super_block *,void *),
2131 int flags, struct user_namespace *user_ns,
2132 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133struct super_block *sget(struct file_system_type *type,
2134 int (*test)(struct super_block *,void *),
2135 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002136 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002137extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2138 const struct super_operations *ops,
2139 const struct xattr_handler **xattr,
2140 const struct dentry_operations *dops,
2141 unsigned long);
2142
2143static inline struct dentry *
2144mount_pseudo(struct file_system_type *fs_type, char *name,
2145 const struct super_operations *ops,
2146 const struct dentry_operations *dops, unsigned long magic)
2147{
2148 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2149}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150
2151/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2152#define fops_get(fops) \
2153 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2154#define fops_put(fops) \
2155 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002156/*
2157 * This one is to be used *ONLY* from ->open() instances.
2158 * fops must be non-NULL, pinned down *and* module dependencies
2159 * should be sufficient to pin the caller down as well.
2160 */
2161#define replace_fops(f, fops) \
2162 do { \
2163 struct file *__file = (f); \
2164 fops_put(__file->f_op); \
2165 BUG_ON(!(__file->f_op = (fops))); \
2166 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167
2168extern int register_filesystem(struct file_system_type *);
2169extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002170extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2171#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002172extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173extern int may_umount_tree(struct vfsmount *);
2174extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002175extern long do_mount(const char *, const char __user *,
2176 const char *, unsigned long, void *);
Al Viro589ff872009-04-18 03:28:19 -04002177extern struct vfsmount *collect_mounts(struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002178extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002179extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2180 struct vfsmount *);
Christoph Hellwigebabe9a2010-07-07 18:53:11 +02002181extern int vfs_statfs(struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002182extern int user_statfs(const char __user *, struct kstatfs *);
2183extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002184extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002185extern int freeze_super(struct super_block *super);
2186extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002187extern bool our_mnt(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188
Al Viroce3b0f82009-03-29 19:08:22 -04002189extern int current_umask(void);
2190
J. Bruce Fields5a146962012-08-28 07:50:40 -07002191extern void ihold(struct inode * inode);
2192extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002193extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002194
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002195/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002196extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002197
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002198#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002199
Jeff Layton9e8925b2015-11-16 09:49:34 -05002200#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002201extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002202extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
2204/*
2205 * Candidates for mandatory locking have the setgid bit set
2206 * but no group execute bit - an otherwise meaningless combination.
2207 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002208
2209static inline int __mandatory_lock(struct inode *ino)
2210{
2211 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2212}
2213
2214/*
2215 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2216 * otherwise these will be advisory locks
2217 */
2218
2219static inline int mandatory_lock(struct inode *ino)
2220{
2221 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2222}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223
Jeff Laytond7a06982014-03-10 09:54:15 -04002224static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225{
Miklos Szeredic568d682016-09-16 12:44:20 +02002226 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002227 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 return 0;
2229}
2230
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002232 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 loff_t size)
2234{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002235 if (!inode->i_flctx || !mandatory_lock(inode))
2236 return 0;
2237
2238 if (size < inode->i_size) {
2239 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2240 F_WRLCK);
2241 } else {
2242 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2243 F_WRLCK);
2244 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245}
2246
Jeff Layton9e8925b2015-11-16 09:49:34 -05002247#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2248
2249static inline int locks_mandatory_locked(struct file *file)
2250{
2251 return 0;
2252}
2253
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002254static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2255 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002256{
2257 return 0;
2258}
2259
2260static inline int __mandatory_lock(struct inode *inode)
2261{
2262 return 0;
2263}
2264
2265static inline int mandatory_lock(struct inode *inode)
2266{
2267 return 0;
2268}
2269
2270static inline int locks_verify_locked(struct file *file)
2271{
2272 return 0;
2273}
2274
2275static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2276 size_t size)
2277{
2278 return 0;
2279}
2280
2281#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2282
2283
2284#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285static inline int break_lease(struct inode *inode, unsigned int mode)
2286{
Jeff Layton24cbe782014-02-03 12:13:06 -05002287 /*
2288 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002289 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2290 * could end up racing with tasks trying to set a new lease on this
2291 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002292 */
2293 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002294 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002295 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 return 0;
2297}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002298
2299static inline int break_deleg(struct inode *inode, unsigned int mode)
2300{
Jeff Layton962bd402014-06-10 12:24:40 -04002301 /*
2302 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002303 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2304 * could end up racing with tasks trying to set a new lease on this
2305 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002306 */
2307 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002308 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002309 return __break_lease(inode, mode, FL_DELEG);
2310 return 0;
2311}
2312
J. Bruce Fields5a146962012-08-28 07:50:40 -07002313static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2314{
2315 int ret;
2316
2317 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2318 if (ret == -EWOULDBLOCK && delegated_inode) {
2319 *delegated_inode = inode;
2320 ihold(inode);
2321 }
2322 return ret;
2323}
2324
2325static inline int break_deleg_wait(struct inode **delegated_inode)
2326{
2327 int ret;
2328
2329 ret = break_deleg(*delegated_inode, O_WRONLY);
2330 iput(*delegated_inode);
2331 *delegated_inode = NULL;
2332 return ret;
2333}
2334
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002335static inline int break_layout(struct inode *inode, bool wait)
2336{
2337 smp_mb();
2338 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2339 return __break_lease(inode,
2340 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2341 FL_LAYOUT);
2342 return 0;
2343}
2344
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002345#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002346static inline int break_lease(struct inode *inode, unsigned int mode)
2347{
2348 return 0;
2349}
2350
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002351static inline int break_deleg(struct inode *inode, unsigned int mode)
2352{
2353 return 0;
2354}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002355
2356static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2357{
2358 return 0;
2359}
2360
2361static inline int break_deleg_wait(struct inode **delegated_inode)
2362{
2363 BUG();
2364 return 0;
2365}
2366
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002367static inline int break_layout(struct inode *inode, bool wait)
2368{
2369 return 0;
2370}
2371
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002372#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373
2374/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002375struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002376struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002377 const char *name; /* pointer to actual string */
2378 const __user char *uptr; /* original userland pointer */
2379 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002380 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002381 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002382};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383
Al Viro7df818b2016-03-25 14:24:09 -04002384extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002385extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2386 struct file *filp);
Daniel Rosenberg2757e9b2016-10-26 16:33:11 -07002387extern int do_truncate2(struct vfsmount *, struct dentry *, loff_t start,
2388 unsigned int time_attrs, struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002389extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002390 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002391extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002392 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002393extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002394extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002395extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002396 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002397extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002399
David Drysdale51f39a12014-12-12 16:57:29 -08002400extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002401extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002402extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002403extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002404
Al Viro47237682012-06-10 05:01:45 -04002405enum {
2406 FILE_CREATED = 1,
2407 FILE_OPENED = 2
2408};
Al Viro30d90492012-06-22 12:40:19 +04002409extern int finish_open(struct file *file, struct dentry *dentry,
2410 int (*open)(struct inode *, struct file *),
2411 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002412extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002414/* fs/ioctl.c */
2415
2416extern int ioctl_preallocate(struct file *filp, void __user *argp);
2417
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418/* fs/dcache.c */
2419extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002420extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421
Christoph Lameterb86c0892006-12-06 20:32:57 -08002422extern struct kmem_cache *names_cachep;
2423
Jeff Laytona608ca22012-10-10 15:25:26 -04002424#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002425#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426
David Howells93614012006-09-30 20:45:40 +02002427#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002429extern void unregister_blkdev(unsigned int, const char *);
Jan Kara9507b392017-02-02 15:56:49 +01002430extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002432extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433extern void bd_set_size(struct block_device *, loff_t size);
2434extern void bd_forget(struct inode *inode);
2435extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002436extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002437extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002438extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb482011-09-16 02:31:11 -04002439extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002440extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002441extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002442extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2443extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002444
2445extern struct super_block *blockdev_superblock;
2446
2447static inline bool sb_is_blkdev_sb(struct super_block *sb)
2448{
2449 return sb == blockdev_superblock;
2450}
David Howells93614012006-09-30 20:45:40 +02002451#else
2452static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002453static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb482011-09-16 02:31:11 -04002454static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002455static inline void invalidate_bdev(struct block_device *bdev) {}
2456
2457static inline struct super_block *freeze_bdev(struct block_device *sb)
2458{
2459 return NULL;
2460}
2461
2462static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2463{
2464 return 0;
2465}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002466
2467static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2468{
2469}
Jan Karaa8855992013-07-09 22:36:45 +08002470
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002471static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002472{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002473 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002474}
David Howells93614012006-09-30 20:45:40 +02002475#endif
Jan Kara60b06802009-04-27 16:43:53 +02002476extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002477extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002478extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002479#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002481extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002483extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002484extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2485 void *holder);
2486extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2487 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002488extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002489extern int __blkdev_reread_part(struct block_device *bdev);
2490extern int blkdev_reread_part(struct block_device *bdev);
2491
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002492#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002493extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002494extern void bd_unlink_disk_holder(struct block_device *bdev,
2495 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002496#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002497static inline int bd_link_disk_holder(struct block_device *bdev,
2498 struct gendisk *disk)
2499{
2500 return 0;
2501}
Tejun Heo49731ba2011-01-14 18:43:57 +01002502static inline void bd_unlink_disk_holder(struct block_device *bdev,
2503 struct gendisk *disk)
2504{
2505}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002506#endif
David Howells93614012006-09-30 20:45:40 +02002507#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508
2509/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002510#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Walleij49db08c2016-02-19 15:36:07 +01002511/* Marks the bottom of the first segment of free char majors */
2512#define CHRDEV_MAJOR_DYN_END 234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2514extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002515extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2516 unsigned int count, const char *name,
2517 const struct file_operations *fops);
2518extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2519 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002521extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522
Tejun Heo1905b1b2009-08-06 18:13:23 +09002523static inline int register_chrdev(unsigned int major, const char *name,
2524 const struct file_operations *fops)
2525{
2526 return __register_chrdev(major, 0, 256, name, fops);
2527}
2528
2529static inline void unregister_chrdev(unsigned int major, const char *name)
2530{
2531 __unregister_chrdev(major, 0, 256, name);
2532}
2533
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534/* fs/block_dev.c */
2535#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002536#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002537
2538#ifdef CONFIG_BLOCK
2539#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540extern const char *__bdevname(dev_t, char *buffer);
2541extern const char *bdevname(struct block_device *bdev, char *buffer);
2542extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002543extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002544
David Howells93614012006-09-30 20:45:40 +02002545#else
2546#define BLKDEV_MAJOR_HASH_SIZE 0
2547#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
2549extern void init_special_inode(struct inode *, umode_t, dev_t);
2550
2551/* Invalid inode operations -- fs/bad_inode.c */
2552extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002553extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554
Jens Axboec11f0c02016-08-05 08:11:04 -06002555#ifdef CONFIG_BLOCK
Mike Christie4e1b2d522016-06-05 14:32:22 -05002556static inline bool op_is_write(unsigned int op)
Mike Christief2150822016-06-05 14:31:42 -05002557{
Mike Christie4e1b2d522016-06-05 14:32:22 -05002558 return op == REQ_OP_READ ? false : true;
Mike Christief2150822016-06-05 14:31:42 -05002559}
2560
2561/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 * return data direction, READ or WRITE
2563 */
Mike Christief2150822016-06-05 14:31:42 -05002564static inline int bio_data_dir(struct bio *bio)
2565{
Mike Christie4e1b2d522016-06-05 14:32:22 -05002566 return op_is_write(bio_op(bio)) ? WRITE : READ;
Mike Christief2150822016-06-05 14:31:42 -05002567}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002569extern void check_disk_size_change(struct gendisk *disk,
2570 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002571extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002573extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002575#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576unsigned long invalidate_mapping_pages(struct address_space *mapping,
2577 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002578
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579static inline void invalidate_remote_inode(struct inode *inode)
2580{
2581 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2582 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002583 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584}
2585extern int invalidate_inode_pages2(struct address_space *mapping);
2586extern int invalidate_inode_pages2_range(struct address_space *mapping,
2587 pgoff_t start, pgoff_t end);
2588extern int write_inode_now(struct inode *, int);
2589extern int filemap_fdatawrite(struct address_space *);
2590extern int filemap_flush(struct address_space *);
2591extern int filemap_fdatawait(struct address_space *);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -08002592extern void filemap_fdatawait_keep_errors(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002593extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2594 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595extern int filemap_write_and_wait(struct address_space *mapping);
2596extern int filemap_write_and_wait_range(struct address_space *mapping,
2597 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002598extern int __filemap_fdatawrite_range(struct address_space *mapping,
2599 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002600extern int filemap_fdatawrite_range(struct address_space *mapping,
2601 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002602extern int filemap_check_errors(struct address_space *mapping);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002603
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002604extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2605 int datasync);
2606extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002607
2608/*
2609 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2610 * to already be updated for the write, and will return either the amount
2611 * of bytes passed in, or an error if syncing the file failed.
2612 */
2613static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002614{
Christoph Hellwige2592212016-04-07 08:52:01 -07002615 if (iocb->ki_flags & IOCB_DSYNC) {
2616 int ret = vfs_fsync_range(iocb->ki_filp,
2617 iocb->ki_pos - count, iocb->ki_pos - 1,
2618 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2619 if (ret)
2620 return ret;
2621 }
2622
2623 return count;
Al Virod311d792014-02-09 15:18:09 -05002624}
Christoph Hellwige2592212016-04-07 08:52:01 -07002625
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626extern void emergency_sync(void);
2627extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002628#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002630#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002631extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Daniel Rosenberg2757e9b2016-10-26 16:33:11 -07002632extern int notify_change2(struct vfsmount *, struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002633extern int inode_permission(struct inode *, int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07002634extern int inode_permission2(struct vfsmount *, struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002635extern int __inode_permission(struct inode *, int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07002636extern int __inode_permission2(struct vfsmount *, struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002637extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002638extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
Miklos Szeredif696a362008-07-31 13:41:58 +02002640static inline bool execute_ok(struct inode *inode)
2641{
2642 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2643}
2644
Al Viro8d71db42013-03-19 21:01:03 -04002645static inline void file_start_write(struct file *file)
2646{
2647 if (!S_ISREG(file_inode(file)->i_mode))
2648 return;
2649 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2650}
2651
Jan Kara5ae98f12013-05-04 00:11:23 +02002652static inline bool file_start_write_trylock(struct file *file)
2653{
2654 if (!S_ISREG(file_inode(file)->i_mode))
2655 return true;
2656 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2657}
2658
Al Viro8d71db42013-03-19 21:01:03 -04002659static inline void file_end_write(struct file *file)
2660{
2661 if (!S_ISREG(file_inode(file)->i_mode))
2662 return;
2663 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2664}
2665
Al Viro07b8ce12011-06-20 10:52:57 -04002666/*
2667 * get_write_access() gets write permission for a file.
2668 * put_write_access() releases this write permission.
2669 * This is used for regular files.
2670 * We cannot support write (and maybe mmap read-write shared) accesses and
2671 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2672 * can have the following values:
2673 * 0: no writers, no VM_DENYWRITE mappings
2674 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2675 * > 0: (i_writecount) users are writing to the file.
2676 *
2677 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2678 * except for the cases where we don't hold i_writecount yet. Then we need to
2679 * use {get,deny}_write_access() - these functions check the sign and refuse
2680 * to do the change if sign is wrong.
2681 */
2682static inline int get_write_access(struct inode *inode)
2683{
2684 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2685}
2686static inline int deny_write_access(struct file *file)
2687{
Al Viro496ad9a2013-01-23 17:07:38 -05002688 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002689 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2690}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691static inline void put_write_access(struct inode * inode)
2692{
2693 atomic_dec(&inode->i_writecount);
2694}
2695static inline void allow_write_access(struct file *file)
2696{
2697 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002698 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699}
David Howellsf1fe29b2013-09-27 11:20:03 +01002700static inline bool inode_is_open_for_write(const struct inode *inode)
2701{
2702 return atomic_read(&inode->i_writecount) > 0;
2703}
2704
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002705#ifdef CONFIG_IMA
2706static inline void i_readcount_dec(struct inode *inode)
2707{
2708 BUG_ON(!atomic_read(&inode->i_readcount));
2709 atomic_dec(&inode->i_readcount);
2710}
2711static inline void i_readcount_inc(struct inode *inode)
2712{
2713 atomic_inc(&inode->i_readcount);
2714}
2715#else
2716static inline void i_readcount_dec(struct inode *inode)
2717{
2718 return;
2719}
2720static inline void i_readcount_inc(struct inode *inode)
2721{
2722 return;
2723}
2724#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002725extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726
Mimi Zohar1284ab52016-04-20 15:46:27 -07002727#define __kernel_read_file_id(id) \
2728 id(UNKNOWN, unknown) \
2729 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002730 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002731 id(MODULE, kernel-module) \
2732 id(KEXEC_IMAGE, kexec-image) \
2733 id(KEXEC_INITRAMFS, kexec-initramfs) \
2734 id(POLICY, security-policy) \
2735 id(MAX_ID, )
2736
2737#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2738#define __fid_stringify(dummy, str) #str,
2739
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002740enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002741 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002742};
2743
Mimi Zohar1284ab52016-04-20 15:46:27 -07002744static const char * const kernel_read_file_str[] = {
2745 __kernel_read_file_id(__fid_stringify)
2746};
2747
Kees Cookda20dfe2016-04-21 12:53:29 -07002748static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002749{
2750 if (id < 0 || id >= READING_MAX_ID)
2751 return kernel_read_file_str[READING_UNKNOWN];
2752
2753 return kernel_read_file_str[id];
2754}
2755
Mimi Zohar6777d772009-08-21 14:32:48 -04002756extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002757extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2758 enum kernel_read_file_id);
Mimi Zohar09596b92015-11-19 12:39:22 -05002759extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2760 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002761extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2762 enum kernel_read_file_id);
Al Viro7bb307e2013-02-23 14:51:48 -05002763extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002764extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765extern struct file * open_exec(const char *);
2766
2767/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002768extern bool is_subdir(struct dentry *, struct dentry *);
Yaowei Bai25ab4c92015-11-17 14:40:10 +08002769extern bool path_is_under(struct path *, struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002771extern char *file_path(struct file *, char *, int);
2772
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773#include <linux/err.h>
2774
2775/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002776extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777
Andrew Morton965c8e52012-12-17 15:59:39 -08002778extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779
Christoph Hellwig54e34622009-08-07 14:38:25 -03002780extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002782extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783extern struct inode * igrab(struct inode *);
2784extern ino_t iunique(struct super_block *, ino_t);
2785extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002786extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002787static inline int generic_drop_inode(struct inode *inode)
2788{
2789 return !inode->i_nlink || inode_unhashed(inode);
2790}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002792extern struct inode *ilookup5_nowait(struct super_block *sb,
2793 unsigned long hashval, int (*test)(struct inode *, void *),
2794 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2796 int (*test)(struct inode *, void *), void *data);
2797extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2798
2799extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2800extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002801extern struct inode *find_inode_nowait(struct super_block *,
2802 unsigned long,
2803 int (*match)(struct inode *,
2804 unsigned long, void *),
2805 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002806extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2807extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002808#ifdef CONFIG_DEBUG_LOCK_ALLOC
2809extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2810#else
2811static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2812#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002814extern unsigned int get_next_ino(void);
Darrick J. Wong63d184d2017-09-17 14:06:57 -07002815extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002818extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002819extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002820extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002821extern struct inode *new_inode_pseudo(struct super_block *sb);
2822extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002823extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002824extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002825extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826
2827extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002828static inline void insert_inode_hash(struct inode *inode)
2829{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830 __insert_inode_hash(inode, inode->i_ino);
2831}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002832
2833extern void __remove_inode_hash(struct inode *);
2834static inline void remove_inode_hash(struct inode *inode)
2835{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002836 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002837 __remove_inode_hash(inode);
2838}
2839
Christoph Hellwig646ec462010-10-23 07:15:32 -04002840extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841
David Howells93614012006-09-30 20:45:40 +02002842#ifdef CONFIG_BLOCK
Mike Christie4e49ea42016-06-05 14:31:41 -05002843extern blk_qc_t submit_bio(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002845#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002846extern int set_blocksize(struct block_device *, int);
2847extern int sb_set_blocksize(struct super_block *, int);
2848extern int sb_min_blocksize(struct super_block *, int);
2849
2850extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2851extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002852extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002853extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002854extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002855extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002856extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002857extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002858
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002859ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2860ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2861
Christoph Hellwigeef99382009-08-20 17:43:41 +02002862/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002863extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002864extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002865extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2866 int datasync);
Al Viroff01bb482011-09-16 02:31:11 -04002867extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002868
Andrew Morton88e6fae2006-04-11 13:59:36 +02002869/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002870extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002871 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002872extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002873 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002874extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002875 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002876extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2877 loff_t *opos, size_t len, unsigned int flags);
2878
Andrew Morton88e6fae2006-04-11 13:59:36 +02002879
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880extern void
2881file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002882extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2883extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002884extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002885extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002886extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002887 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002888extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2889 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002890extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2891extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892extern int generic_file_open(struct inode * inode, struct file * filp);
2893extern int nonseekable_open(struct inode * inode, struct file * filp);
Kirill Smelkov9c829b62019-03-26 22:20:43 +00002894extern int stream_open(struct inode * inode, struct file * filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895
David Howells93614012006-09-30 20:45:40 +02002896#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05002897typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04002898 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899
2900enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002901 /* need locking between buffered and direct access */
2902 DIO_LOCKING = 0x01,
2903
2904 /* filesystem does not support filling holes */
2905 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002906
2907 /* filesystem can handle aio writes beyond i_size */
2908 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002909
2910 /* inode/fs/bdev does not need truncate protection */
2911 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912};
2913
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002914void dio_end_io(struct bio *bio, int error);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002915
Omar Sandoval17f8c842015-03-16 04:33:50 -07002916ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2917 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002918 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002919 dio_iodone_t end_io, dio_submit_t submit_io,
2920 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002921
Omar Sandoval17f8c842015-03-16 04:33:50 -07002922static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2923 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002924 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002925 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002927 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002928 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929}
David Howells93614012006-09-30 20:45:40 +02002930#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931
Trond Myklebust1d59d612012-05-31 12:22:33 -04002932void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002933
2934/*
2935 * inode_dio_begin - signal start of a direct I/O requests
2936 * @inode: inode the direct I/O happens on
2937 *
2938 * This is called once we've finished processing a direct I/O request,
2939 * and is used to wake up callers waiting for direct I/O to be quiesced.
2940 */
2941static inline void inode_dio_begin(struct inode *inode)
2942{
2943 atomic_inc(&inode->i_dio_count);
2944}
2945
2946/*
2947 * inode_dio_end - signal finish of a direct I/O requests
2948 * @inode: inode the direct I/O happens on
2949 *
2950 * This is called once we've finished processing a direct I/O request,
2951 * and is used to wake up callers waiting for direct I/O to be quiesced.
2952 */
2953static inline void inode_dio_end(struct inode *inode)
2954{
2955 if (atomic_dec_and_test(&inode->i_dio_count))
2956 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2957}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002958
Neeraj Sonic692cb92018-04-18 17:20:22 +05302959struct inode *dio_bio_get_inode(struct bio *bio);
2960
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002961extern void inode_set_flags(struct inode *inode, unsigned int flags,
2962 unsigned int mask);
2963
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002964extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002965
2966#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2967
Al Viro5d826c82014-03-14 13:42:45 -04002968extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05002970extern const char *page_get_link(struct dentry *, struct inode *,
2971 struct delayed_call *);
2972extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002973extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002974 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002976extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05002977extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978extern int generic_readlink(struct dentry *, char __user *, int);
2979extern void generic_fillattr(struct inode *, struct kstat *);
J. Bruce Fieldsb7a6ec52013-10-02 17:01:18 -04002980int vfs_getattr_nosec(struct path *path, struct kstat *stat);
Al Viro3dadecc2013-01-24 02:18:08 -05002981extern int vfs_getattr(struct path *, struct kstat *);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002982void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002984void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985void inode_sub_bytes(struct inode *inode, loff_t bytes);
2986loff_t inode_get_bytes(struct inode *inode);
2987void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05002988const char *simple_get_link(struct dentry *, struct inode *,
2989 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04002990extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991
Al Viro5c0ba4e2013-05-15 13:52:59 -04002992extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993
David Howellsc7887322010-08-11 11:26:22 +01002994extern int vfs_stat(const char __user *, struct kstat *);
2995extern int vfs_lstat(const char __user *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996extern int vfs_fstat(unsigned int, struct kstat *);
David Howellsc7887322010-08-11 11:26:22 +01002997extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
Miklos Szeredid60874c2016-10-04 14:40:45 +02002998extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999
Steven Whitehousee9079cc2008-10-14 14:43:29 +01003000extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04003001 struct fiemap_extent_info *fieinfo,
3002 loff_t start, loff_t len,
3003 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04003004extern int generic_block_fiemap(struct inode *inode,
3005 struct fiemap_extent_info *fieinfo, u64 start,
3006 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007
Miklos Szeredic18479f2007-10-18 23:39:11 -07003008extern void get_filesystem(struct file_system_type *fs);
3009extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010extern struct file_system_type *get_fs_type(const char *name);
3011extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003012extern struct super_block *get_super_thawed(struct block_device *);
Christoph Hellwig45042302009-08-03 23:28:35 +02003013extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014extern void drop_super(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003015extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003016extern void iterate_supers_type(struct file_system_type *,
3017 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018
3019extern int dcache_dir_open(struct inode *, struct file *);
3020extern int dcache_dir_close(struct inode *, struct file *);
3021extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003022extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003023extern int simple_setattr(struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells726c3342006-06-23 02:02:58 -07003025extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003026extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3028extern int simple_unlink(struct inode *, struct dentry *);
3029extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003030extern int simple_rename(struct inode *, struct dentry *,
3031 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003032extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033extern int simple_empty(struct dentry *);
3034extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003035extern int simple_write_begin(struct file *file, struct address_space *mapping,
3036 loff_t pos, unsigned len, unsigned flags,
3037 struct page **pagep, void **fsdata);
3038extern int simple_write_end(struct file *file, struct address_space *mapping,
3039 loff_t pos, unsigned len, unsigned copied,
3040 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003041extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003042extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003043extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003044extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045
Al Viro00cd8dd2012-06-10 17:13:09 -04003046extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003048extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003049extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003050extern void make_empty_dir_inode(struct inode *inode);
3051extern bool is_empty_dir_inode(struct inode *inode);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003052struct tree_descr { char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003053struct dentry *d_alloc_name(struct dentry *, const char *);
Roberto Sassu7d683a02010-06-03 11:58:28 +02003054extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003055extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056extern void simple_release_fs(struct vfsmount **mount, int *count);
3057
Akinobu Mita93b07112008-06-05 22:46:21 -07003058extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3059 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003060extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3061 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062
Fabian Frederickac13a822014-06-04 16:06:27 -07003063extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003064extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003065
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003066extern int generic_check_addressable(unsigned, u64);
3067
Christoph Lametere965f962006-02-01 03:05:41 -08003068#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003069extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003070 struct page *, struct page *,
3071 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003072#else
3073#define buffer_migrate_page NULL
3074#endif
3075
Jan Kara31051c82016-05-26 16:55:18 +02003076extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003077extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003078extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003079
Josef Bacikc3b2da32012-03-26 09:59:21 -04003080extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003081
Al Viro34c80b12011-12-08 21:32:45 -05003082extern int generic_show_options(struct seq_file *m, struct dentry *root);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003083extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04003084extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003085
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003086static inline bool io_is_direct(struct file *filp)
3087{
Dan Williams65f87ee2016-01-25 17:23:18 -08003088 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003089}
3090
Dan Williamsb29ea3c2018-02-23 14:05:49 -08003091static inline bool vma_is_dax(struct vm_area_struct *vma)
3092{
3093 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3094}
3095
3096static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3097{
3098 struct inode *inode;
3099
3100 if (!vma->vm_file)
3101 return false;
3102 if (!vma_is_dax(vma))
3103 return false;
3104 inode = file_inode(vma->vm_file);
Dan Williams43672fa2018-02-21 17:08:01 -08003105 if (S_ISCHR(inode->i_mode))
Dan Williamsb29ea3c2018-02-23 14:05:49 -08003106 return false; /* device-dax */
3107 return true;
3108}
3109
Al Viro2ba48ce2015-04-09 13:52:01 -04003110static inline int iocb_flags(struct file *file)
3111{
3112 int res = 0;
3113 if (file->f_flags & O_APPEND)
3114 res |= IOCB_APPEND;
3115 if (io_is_direct(file))
3116 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003117 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3118 res |= IOCB_DSYNC;
3119 if (file->f_flags & __O_SYNC)
3120 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003121 return res;
3122}
3123
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124static inline ino_t parent_ino(struct dentry *dentry)
3125{
3126 ino_t res;
3127
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003128 /*
3129 * Don't strictly need d_lock here? If the parent ino could change
3130 * then surely we'd have a deeper race in the caller?
3131 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132 spin_lock(&dentry->d_lock);
3133 res = dentry->d_parent->d_inode->i_ino;
3134 spin_unlock(&dentry->d_lock);
3135 return res;
3136}
3137
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138/* Transaction based IO helpers */
3139
3140/*
3141 * An argresp is stored in an allocated page and holds the
3142 * size of the argument or response, along with its content
3143 */
3144struct simple_transaction_argresp {
3145 ssize_t size;
3146 char data[0];
3147};
3148
3149#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3150
3151char *simple_transaction_get(struct file *file, const char __user *buf,
3152 size_t size);
3153ssize_t simple_transaction_read(struct file *file, char __user *buf,
3154 size_t size, loff_t *pos);
3155int simple_transaction_release(struct inode *inode, struct file *file);
3156
Ingo Molnar76791ab2009-03-25 16:48:35 +01003157void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003159/*
3160 * simple attribute files
3161 *
3162 * These attributes behave similar to those in sysfs:
3163 *
3164 * Writing to an attribute immediately sets a value, an open file can be
3165 * written to multiple times.
3166 *
3167 * Reading from an attribute creates a buffer from the value that might get
3168 * read with multiple read calls. When the attribute has been read
3169 * completely, no further read calls are possible until the file is opened
3170 * again.
3171 *
3172 * All attributes contain a text representation of a numeric value
3173 * that are accessed with the get() and set() functions.
3174 */
3175#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3176static int __fops ## _open(struct inode *inode, struct file *file) \
3177{ \
3178 __simple_attr_check_format(__fmt, 0ull); \
3179 return simple_attr_open(inode, file, __get, __set, __fmt); \
3180} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003181static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003182 .owner = THIS_MODULE, \
3183 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003184 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003185 .read = simple_attr_read, \
3186 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003187 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003188}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003189
Joe Perchesb9075fa2011-10-31 17:11:33 -07003190static inline __printf(1, 2)
3191void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003192{
3193 /* don't do anything, just let the compiler check the arguments; */
3194}
3195
3196int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003197 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003198 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003199int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003200ssize_t simple_attr_read(struct file *file, char __user *buf,
3201 size_t len, loff_t *ppos);
3202ssize_t simple_attr_write(struct file *file, const char __user *buf,
3203 size_t len, loff_t *ppos);
3204
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003205struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003206int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003207 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003208int proc_nr_dentry(struct ctl_table *table, int write,
3209 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003210int proc_nr_inodes(struct ctl_table *table, int write,
3211 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003212int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003213
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003214#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003215#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3216
Al Viro6d125522009-12-24 06:58:56 -05003217#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003218#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003219 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003220
Yaowei Baid37177b2015-11-19 21:00:12 +08003221static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003222{
3223 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3224}
3225
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003226static inline int check_sticky(struct inode *dir, struct inode *inode)
3227{
3228 if (!(dir->i_mode & S_ISVTX))
3229 return 0;
3230
3231 return __check_sticky(dir, inode);
3232}
3233
Andi Kleen69b45732011-05-28 08:25:51 -07003234static inline void inode_has_no_xattr(struct inode *inode)
3235{
Al Viro9e1f1de2011-06-03 18:24:58 -04003236 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003237 inode->i_flags |= S_NOSEC;
3238}
3239
Al Viroa7400222014-10-21 15:20:42 -04003240static inline bool is_root_inode(struct inode *inode)
3241{
3242 return inode == inode->i_sb->s_root->d_inode;
3243}
3244
Al Viro5f99f4e2013-05-15 20:23:06 -04003245static inline bool dir_emit(struct dir_context *ctx,
3246 const char *name, int namelen,
3247 u64 ino, unsigned type)
3248{
3249 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3250}
3251static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3252{
3253 return ctx->actor(ctx, ".", 1, ctx->pos,
3254 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3255}
3256static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3257{
3258 return ctx->actor(ctx, "..", 2, ctx->pos,
3259 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3260}
3261static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3262{
3263 if (ctx->pos == 0) {
3264 if (!dir_emit_dot(file, ctx))
3265 return false;
3266 ctx->pos = 1;
3267 }
3268 if (ctx->pos == 1) {
3269 if (!dir_emit_dotdot(file, ctx))
3270 return false;
3271 ctx->pos = 2;
3272 }
3273 return true;
3274}
Al Viro5ded75e2013-05-15 21:02:48 -04003275static inline bool dir_relax(struct inode *inode)
3276{
Al Viro59551022016-01-22 15:40:57 -05003277 inode_unlock(inode);
3278 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003279 return !IS_DEADDIR(inode);
3280}
Al Viro5f99f4e2013-05-15 20:23:06 -04003281
Al Viroae053272016-05-12 20:36:01 -04003282static inline bool dir_relax_shared(struct inode *inode)
3283{
3284 inode_unlock_shared(inode);
3285 inode_lock_shared(inode);
3286 return !IS_DEADDIR(inode);
3287}
3288
Eric W. Biederman90f85722015-06-29 14:42:03 -05003289extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003290extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003291
Eric Biggers8040d8d2019-07-01 13:26:28 -07003292int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3293 unsigned int flags);
3294
Linus Torvalds1da177e2005-04-16 15:20:36 -07003295#endif /* _LINUX_FS_H */