blob: 564b8d4e1e8bbdf710a4a1fa70a82831b04de834 [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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 /*
504 * Private data. You must have bd_claim'ed the block_device
505 * to use this. NOTE: bd_claim allows an owner to claim
506 * the same device multiple times, the owner must take special
507 * care to not mess up bd_private for that case.
508 */
509 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800510
511 /* The counter of freeze processes */
512 int bd_fsfreeze_count;
513 /* Mutex for freeze */
514 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515};
516
517/*
518 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
519 * radix trees
520 */
521#define PAGECACHE_TAG_DIRTY 0
522#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700523#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
525int mapping_tagged(struct address_space *mapping, int tag);
526
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800527static inline void i_mmap_lock_write(struct address_space *mapping)
528{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800529 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800530}
531
532static inline void i_mmap_unlock_write(struct address_space *mapping)
533{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800534 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800535}
536
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800537static inline void i_mmap_lock_read(struct address_space *mapping)
538{
539 down_read(&mapping->i_mmap_rwsem);
540}
541
542static inline void i_mmap_unlock_read(struct address_space *mapping)
543{
544 up_read(&mapping->i_mmap_rwsem);
545}
546
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547/*
548 * Might pages of this file be mapped into userspace?
549 */
550static inline int mapping_mapped(struct address_space *mapping)
551{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800552 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553}
554
555/*
556 * Might pages of this file have been modified in userspace?
557 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
558 * marks vma as VM_SHARED if it is shared, and the file was opened for
559 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700560 *
561 * If i_mmap_writable is negative, no new writable mappings are allowed. You
562 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 */
564static inline int mapping_writably_mapped(struct address_space *mapping)
565{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700566 return atomic_read(&mapping->i_mmap_writable) > 0;
567}
568
569static inline int mapping_map_writable(struct address_space *mapping)
570{
571 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
572 0 : -EPERM;
573}
574
575static inline void mapping_unmap_writable(struct address_space *mapping)
576{
577 atomic_dec(&mapping->i_mmap_writable);
578}
579
580static inline int mapping_deny_writable(struct address_space *mapping)
581{
582 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
583 0 : -EBUSY;
584}
585
586static inline void mapping_allow_writable(struct address_space *mapping)
587{
588 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589}
590
591/*
592 * Use sequence counter to get consistent i_size on 32-bit processors.
593 */
594#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
595#include <linux/seqlock.h>
596#define __NEED_I_SIZE_ORDERED
597#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
598#else
599#define i_size_ordered_init(inode) do { } while (0)
600#endif
601
Al Virof19d4a82009-06-08 19:50:45 -0400602struct posix_acl;
603#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200604#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400605
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100606static inline struct posix_acl *
607uncached_acl_sentinel(struct task_struct *task)
608{
609 return (void *)task + 1;
610}
611
612static inline bool
613is_uncached_acl(struct posix_acl *acl)
614{
615 return (long)acl & 1;
616}
617
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700618#define IOP_FASTPERM 0x0001
619#define IOP_LOOKUP 0x0002
620#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200621#define IOP_XATTR 0x0008
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700622
623/*
624 * Keep mostly read-only and often accessed (especially for
625 * the RCU path lookup and 'stat' data) fields at the beginning
626 * of the 'struct inode'
627 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100629 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700630 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800631 kuid_t i_uid;
632 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700633 unsigned int i_flags;
634
635#ifdef CONFIG_FS_POSIX_ACL
636 struct posix_acl *i_acl;
637 struct posix_acl *i_default_acl;
638#endif
639
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100640 const struct inode_operations *i_op;
641 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700642 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100643
Linus Torvalds13e12d12011-06-08 15:18:19 -0700644#ifdef CONFIG_SECURITY
645 void *i_security;
646#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100647
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700648 /* Stat data, not accessed from path walking */
649 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200650 /*
651 * Filesystems may only read i_nlink directly. They shall use the
652 * following functions for modification:
653 *
654 * (set|clear|inc|drop)_nlink
655 * inode_(inc|dec)_link_count
656 */
657 union {
658 const unsigned int i_nlink;
659 unsigned int __i_nlink;
660 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700661 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700662 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700663 struct timespec i_atime;
664 struct timespec i_mtime;
665 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400666 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
667 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700668 unsigned int i_blkbits;
Jaegeuk Kimd9197652018-01-05 10:44:52 -0800669 enum rw_hint i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700670 blkcnt_t i_blocks;
671
672#ifdef __NEED_I_SIZE_ORDERED
673 seqcount_t i_size_seqcount;
674#endif
675
676 /* Misc */
677 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400678 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700679
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100680 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400681 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500684 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400685#ifdef CONFIG_CGROUP_WRITEBACK
686 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400687
688 /* foreign inode detection, see wbc_detach_inode() */
689 int i_wb_frn_winner;
690 u16 i_wb_frn_avg_time;
691 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400692#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100693 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700695 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100696 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400697 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100698 struct rcu_head i_rcu;
699 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500700 u64 i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700701 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400702 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400703 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500704#ifdef CONFIG_IMA
705 atomic_t i_readcount; /* struct files open RO */
706#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800707 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500708 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700711 union {
712 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700713 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700714 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400715 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400716 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700717 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 __u32 i_generation;
720
Eric Paris3be25f42009-05-21 17:01:26 -0400721#ifdef CONFIG_FSNOTIFY
722 __u32 i_fsnotify_mask; /* all events this inode cares about */
Eric Parise61ce862009-12-17 21:24:24 -0500723 struct hlist_head i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400724#endif
725
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700726#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
727 struct fscrypt_info *i_crypt_info;
728#endif
729
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700730 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731};
732
Fabian Frederick61604a22017-02-27 14:28:32 -0800733static inline unsigned int i_blocksize(const struct inode *node)
734{
735 return (1 << node->i_blkbits);
736}
737
Al Viro1d3382cb2010-10-23 15:19:20 -0400738static inline int inode_unhashed(struct inode *inode)
739{
740 return hlist_unhashed(&inode->i_hash);
741}
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700744 * inode->i_mutex nesting subclasses for the lock validator:
745 *
746 * 0: the object of the current VFS operation
747 * 1: parent
748 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400749 * 3: xattr
750 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100751 * 5: second parent (when locking independent directories in rename)
752 *
753 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400754 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700755 *
756 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100757 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700758 */
759enum inode_i_mutex_lock_class
760{
761 I_MUTEX_NORMAL,
762 I_MUTEX_PARENT,
763 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700764 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100765 I_MUTEX_NONDIR2,
766 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700767};
768
Al Viro59551022016-01-22 15:40:57 -0500769static inline void inode_lock(struct inode *inode)
770{
Al Viro9902af72016-04-15 15:08:36 -0400771 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500772}
773
774static inline void inode_unlock(struct inode *inode)
775{
Al Viro9902af72016-04-15 15:08:36 -0400776 up_write(&inode->i_rwsem);
777}
778
779static inline void inode_lock_shared(struct inode *inode)
780{
781 down_read(&inode->i_rwsem);
782}
783
784static inline void inode_unlock_shared(struct inode *inode)
785{
786 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500787}
788
789static inline int inode_trylock(struct inode *inode)
790{
Al Viro9902af72016-04-15 15:08:36 -0400791 return down_write_trylock(&inode->i_rwsem);
792}
793
794static inline int inode_trylock_shared(struct inode *inode)
795{
796 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500797}
798
799static inline int inode_is_locked(struct inode *inode)
800{
Al Viro9902af72016-04-15 15:08:36 -0400801 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500802}
803
804static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
805{
Al Viro9902af72016-04-15 15:08:36 -0400806 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500807}
808
J. Bruce Fields375e2892012-04-18 15:16:33 -0400809void lock_two_nondirectories(struct inode *, struct inode*);
810void unlock_two_nondirectories(struct inode *, struct inode*);
811
Ingo Molnarf2eace22006-07-03 00:25:05 -0700812/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 * NOTE: in a 32bit arch with a preemptable kernel and
814 * an UP compile the i_size_read/write must be atomic
815 * with respect to the local cpu (unlike with preempt disabled),
816 * but they don't need to be atomic with respect to other cpus like in
817 * true SMP (so they need either to either locally disable irq around
818 * the read or for example on x86 they can be still implemented as a
819 * cmpxchg8b without the need of the lock prefix). For SMP compiles
820 * and 64bit archs it makes no difference if preempt is enabled or not.
821 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800822static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
824#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
825 loff_t i_size;
826 unsigned int seq;
827
828 do {
829 seq = read_seqcount_begin(&inode->i_size_seqcount);
830 i_size = inode->i_size;
831 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
832 return i_size;
833#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
834 loff_t i_size;
835
836 preempt_disable();
837 i_size = inode->i_size;
838 preempt_enable();
839 return i_size;
840#else
841 return inode->i_size;
842#endif
843}
844
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700845/*
846 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
847 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
848 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
849 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850static inline void i_size_write(struct inode *inode, loff_t i_size)
851{
852#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700853 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 write_seqcount_begin(&inode->i_size_seqcount);
855 inode->i_size = i_size;
856 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700857 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
859 preempt_disable();
860 inode->i_size = i_size;
861 preempt_enable();
862#else
863 inode->i_size = i_size;
864#endif
865}
866
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800867static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868{
869 return MINOR(inode->i_rdev);
870}
871
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800872static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873{
874 return MAJOR(inode->i_rdev);
875}
876
877extern struct block_device *I_BDEV(struct inode *inode);
878
879struct fown_struct {
880 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700881 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
882 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800883 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 int signum; /* posix.1b rt signal to be delivered on IO */
885};
886
887/*
888 * Track a single file's readahead state
889 */
890struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700891 pgoff_t start; /* where readahead started */
892 unsigned int size; /* # of readahead pages */
893 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700894 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700895
Fengguang Wu937085a2007-10-16 01:24:31 -0700896 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700897 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700898 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Fengguang Wu5ce11102007-07-19 01:47:59 -0700901/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700902 * Check if @index falls in the readahead windows.
903 */
904static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
905{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700906 return (index >= ra->start &&
907 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700908}
909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800911 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700912 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800913 struct rcu_head fu_rcuhead;
914 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800915 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500916 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800917 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700918
919 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800920 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700921 * Must not be taken from IRQ context.
922 */
923 spinlock_t f_lock;
Al Viro516e0cc2008-07-26 00:39:17 -0400924 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400926 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800927 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 loff_t f_pos;
929 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100930 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 struct file_ra_state f_ra;
932
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700933 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700934#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700936#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 /* needed for tty driver, and maybe others */
938 void *private_data;
939
940#ifdef CONFIG_EPOLL
941 /* Used by fs/eventpoll.c to link all the hooks to this file */
942 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800943 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944#endif /* #ifdef CONFIG_EPOLL */
945 struct address_space *f_mapping;
Al Virobd2a31d2014-03-04 14:54:22 -0500946} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530948struct file_handle {
949 __u32 handle_bytes;
950 int handle_type;
951 /* file identifier */
952 unsigned char f_handle[0];
953};
954
Al Virocb0942b2012-08-27 14:48:26 -0400955static inline struct file *get_file(struct file *f)
956{
957 atomic_long_inc(&f->f_count);
958 return f;
959}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700960#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400961#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400962#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
964#define MAX_NON_LFS ((1UL<<31) - 1)
965
966/* Page cache limit. The filesystems should put that into their s_maxbytes
967 limits, otherwise bad things can happen in VM. */
968#if BITS_PER_LONG==32
Linus Torvaldsb8fce382017-08-27 12:12:25 -0700969#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970#elif BITS_PER_LONG==64
Linus Torvaldsb8fce382017-08-27 12:12:25 -0700971#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972#endif
973
974#define FL_POSIX 1
975#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400976#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400978#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700980#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400982#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
983#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400984#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100985#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
987/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700988 * Special return value from posix_lock_file() and vfs_lock_file() for
989 * asynchronous locking.
990 */
991#define FILE_LOCK_DEFERRED 1
992
Jeff Layton7ca76312014-09-01 19:04:48 -0400993/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200994typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
Jeff Laytona7231a92015-01-16 15:05:56 -0500996struct file_lock;
997
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1000 void (*fl_release_private)(struct file_lock *);
1001};
1002
1003struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001004 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -04001005 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -04001006 fl_owner_t (*lm_get_owner)(fl_owner_t);
1007 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -04001008 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -04001009 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -04001010 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -05001011 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -04001012 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013};
1014
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001015struct lock_manager {
1016 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001017 /*
1018 * NFSv4 and up also want opens blocked during the grace period;
1019 * NLM doesn't care:
1020 */
1021 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001022};
1023
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001024struct net;
1025void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001026void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +04001027int locks_in_grace(struct net *);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -04001028int opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -04001029
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030/* that will die - we need it for nfs_lock_info */
1031#include <linux/nfs_fs_i.h>
1032
Jeff Layton1cb36012013-06-21 08:58:12 -04001033/*
1034 * struct file_lock represents a generic "file lock". It's used to represent
1035 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1036 * note that the same struct is used to represent both a request for a lock and
1037 * the lock itself, but the same object is never used for both.
1038 *
1039 * FIXME: should we create a separate "struct lock_request" to help distinguish
1040 * these two uses?
1041 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001042 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -04001043 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001044 * 1) lock owner
1045 * 2) lock range start
1046 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001047 *
1048 * Obviously, the last two criteria only matter for POSIX locks.
1049 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050struct file_lock {
1051 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001052 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001053 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 struct list_head fl_block; /* circular list of blocked processes */
1055 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001056 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001057 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001059 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00001060 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 wait_queue_head_t fl_wait;
1062 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 loff_t fl_start;
1064 loff_t fl_end;
1065
1066 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001067 /* for lease breaks: */
1068 unsigned long fl_break_time;
1069 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001071 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001072 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 union {
1074 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001075 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001076 struct {
1077 struct list_head link; /* link in AFS vnode's pending_locks list */
1078 int state; /* state of grant or error if -ve */
1079 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 } fl_u;
1081};
1082
Jeff Layton4a075e32015-01-16 15:05:54 -05001083struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001084 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001085 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001086 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001087 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001088};
1089
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090/* The following constant reflects the upper bound of the file/locking space */
1091#ifndef OFFSET_MAX
1092#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1093#define OFFSET_MAX INT_LIMIT(loff_t)
1094#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1095#endif
1096
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001097extern void send_sigio(struct fown_struct *fown, int fd, int band);
1098
Miklos Szeredic568d682016-09-16 12:44:20 +02001099/*
1100 * Return the inode to use for locking
1101 *
1102 * For overlayfs this should be the overlay inode, not the real inode returned
1103 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1104 * equal.
1105 */
1106static inline struct inode *locks_inode(const struct file *f)
1107{
1108 return f->f_path.dentry->d_inode;
1109}
1110
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001111#ifdef CONFIG_FILE_LOCKING
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001112extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001113extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1114 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115
1116#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001117extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001118extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1119 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120#endif
1121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1123extern int fcntl_getlease(struct file *filp);
1124
1125/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001126void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001127void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001129extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001131extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001133extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001134extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001135extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001136extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001137extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001138extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001139extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001140extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001141extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001142extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001144extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1145extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001146extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001147struct files_struct;
1148extern void show_fd_locks(struct seq_file *f,
1149 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001150#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001151static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1152 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001153{
1154 return -EINVAL;
1155}
1156
1157static inline int fcntl_setlk(unsigned int fd, struct file *file,
1158 unsigned int cmd, struct flock __user *user)
1159{
1160 return -EACCES;
1161}
1162
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001163#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001164static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1165 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001166{
1167 return -EINVAL;
1168}
1169
1170static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1171 unsigned int cmd, struct flock64 __user *user)
1172{
1173 return -EACCES;
1174}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001175#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001176static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1177{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001178 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001179}
1180
1181static inline int fcntl_getlease(struct file *filp)
1182{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001183 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001184}
1185
Jeff Layton4a075e32015-01-16 15:05:54 -05001186static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001187locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001188{
1189}
1190
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001191static inline void locks_init_lock(struct file_lock *fl)
1192{
1193 return;
1194}
1195
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001196static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001197{
1198 return;
1199}
1200
1201static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1202{
1203 return;
1204}
1205
1206static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1207{
1208 return;
1209}
1210
Jeff Layton78ed8a12014-02-03 12:13:08 -05001211static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001212{
1213 return;
1214}
1215
1216static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1217{
1218 return;
1219}
1220
1221static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1222 struct file_lock *conflock)
1223{
1224 return -ENOLCK;
1225}
1226
Jeff Laytonf891a292013-06-21 08:58:09 -04001227static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001228{
1229 return -ENOENT;
1230}
1231
1232static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1233{
1234 return 0;
1235}
1236
1237static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1238 struct file_lock *fl, struct file_lock *conf)
1239{
1240 return -ENOLCK;
1241}
1242
1243static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1244{
1245 return 0;
1246}
1247
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001248static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1249{
1250 return -ENOLCK;
1251}
1252
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001253static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001254{
1255 return 0;
1256}
1257
1258static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1259{
1260 return;
1261}
1262
1263static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001264 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001265{
1266 return -EINVAL;
1267}
1268
1269static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001270 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001271{
1272 return -EINVAL;
1273}
1274
Jeff Layton7448cc32015-01-16 15:05:57 -05001275static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001276 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001277{
1278 return -EINVAL;
1279}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001280
1281struct files_struct;
1282static inline void show_fd_locks(struct seq_file *f,
1283 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001284#endif /* !CONFIG_FILE_LOCKING */
1285
Jeff Laytonee296d72015-07-11 06:43:03 -04001286static inline struct inode *file_inode(const struct file *f)
1287{
1288 return f->f_inode;
1289}
1290
Miklos Szeredid101a122016-03-26 16:14:37 -04001291static inline struct dentry *file_dentry(const struct file *file)
1292{
Miklos Szeredi2d902672016-06-30 08:53:27 +02001293 return d_real(file->f_path.dentry, file_inode(file), 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001294}
1295
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001296static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1297{
Miklos Szeredic568d682016-09-16 12:44:20 +02001298 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001299}
1300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001302 spinlock_t fa_lock;
1303 int magic;
1304 int fa_fd;
1305 struct fasync_struct *fa_next; /* singly linked list */
1306 struct file *fa_file;
1307 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308};
1309
1310#define FASYNC_MAGIC 0x4601
1311
1312/* SMP safe fasync helpers: */
1313extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001314extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1315extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1316extern struct fasync_struct *fasync_alloc(void);
1317extern void fasync_free(struct fasync_struct *);
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319/* can be called from interrupts */
1320extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001322extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1323extern void f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001325extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326extern int send_sigurg(struct fown_struct *fown);
1327
Jan Kara5accdf82012-06-12 16:20:34 +02001328struct mm_struct;
1329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330/*
1331 * Umount options
1332 */
1333
1334#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1335#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1336#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001337#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1338#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Tejun Heo46b15ca2015-06-16 18:48:31 -04001340/* sb->s_iflags */
1341#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001342#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001343#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Eric W. Biedermaneaa95922018-03-14 18:20:29 -05001344#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
Eric W. Biederman8654df42016-06-09 16:06:06 -05001346/* sb->s_iflags to limit user namespace mounts */
1347#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
Jan Kara5accdf82012-06-12 16:20:34 +02001349/* Possible states of 'frozen' field */
1350enum {
1351 SB_UNFROZEN = 0, /* FS is unfrozen */
1352 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001353 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1354 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1355 * internal threads if needed) */
1356 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1357};
1358
1359#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1360
1361struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001362 int frozen; /* Is sb frozen? */
1363 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1364 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001365};
1366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367struct super_block {
1368 struct list_head s_list; /* Keep this first */
1369 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001370 unsigned char s_blocksize_bits;
1371 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001372 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001374 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001375 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001376 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001377 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001379 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 unsigned long s_magic;
1381 struct dentry *s_root;
1382 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001385#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001387#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001388 const struct xattr_handler **s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001390 const struct fscrypt_operations *s_cop;
1391
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001392 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001393 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001395 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001396 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001397 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001398 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 struct quota_info s_dquot; /* Diskquota specific options */
1400
Jan Kara5accdf82012-06-12 16:20:34 +02001401 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403 char s_id[32]; /* Informational name */
Linus Torvalds0bba0162011-04-12 15:21:04 -07001404 u8 s_uuid[16]; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
1406 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001407 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001408 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001410 /* Granularity of c/m/atime in ns.
1411 Cannot be worse than a second */
1412 u32 s_time_gran;
1413
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 /*
1415 * The next field is for VFS *only*. No filesystems have any business
1416 * even looking at it. You had been warned.
1417 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001418 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001420 /*
1421 * Filesystem subtype. If non-empty the filesystem type field
1422 * in /proc/mounts will be "type.subtype"
1423 */
1424 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001425
1426 /*
1427 * Saved mount options for lazy filesystems using
1428 * generic_show_options()
1429 */
Arnd Bergmann4d2deb42010-02-24 20:01:56 +01001430 char __rcu *s_options;
Al Viroc8aebb02010-12-18 10:22:30 -05001431 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001432
1433 /*
1434 * Saved pool identifier for cleancache (-1 means none)
1435 */
1436 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001437
1438 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e822011-11-21 12:11:31 +01001439
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001440 /* Number of inodes with nlink == 0 but still referenced */
1441 atomic_long_t s_remove_count;
1442
Miklos Szeredi4ed5e822011-11-21 12:11:31 +01001443 /* Being remounted read-only */
1444 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001445
1446 /* AIO completions deferred from interrupt context */
1447 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001448 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001449
1450 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001451 * Owning user namespace and default context in which to
1452 * interpret filesystem uids, gids, quotas, device nodes,
1453 * xattrs and security labels.
1454 */
1455 struct user_namespace *s_user_ns;
1456
1457 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001458 * Keep the lru lists last in the structure so they always sit on their
1459 * own individual cachelines.
1460 */
1461 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1462 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001463 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001464 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001465
Dave Chinnere97fedb2015-03-04 13:40:00 -05001466 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001467
1468 /*
1469 * Indicates how deep in a filesystem stack this SB is
1470 */
1471 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001472
1473 /* s_inode_list_lock protects s_inodes */
1474 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1475 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001476
1477 spinlock_t s_inode_wblist_lock;
1478 struct list_head s_inodes_wb; /* writeback inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479};
1480
Seth Forshee81754352014-12-11 10:15:45 -06001481/* Helper functions so that in most cases filesystems will
1482 * not need to deal directly with kuid_t and kgid_t and can
1483 * instead deal with the raw numeric values that are stored
1484 * in the filesystem.
1485 */
1486static inline uid_t i_uid_read(const struct inode *inode)
1487{
1488 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1489}
1490
1491static inline gid_t i_gid_read(const struct inode *inode)
1492{
1493 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1494}
1495
1496static inline void i_uid_write(struct inode *inode, uid_t uid)
1497{
1498 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1499}
1500
1501static inline void i_gid_write(struct inode *inode, gid_t gid)
1502{
1503 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1504}
1505
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506extern struct timespec current_fs_time(struct super_block *sb);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07001507extern struct timespec current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
1509/*
1510 * Snapshotting support.
1511 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
Jan Kara5accdf82012-06-12 16:20:34 +02001513void __sb_end_write(struct super_block *sb, int level);
1514int __sb_start_write(struct super_block *sb, int level, bool wait);
1515
Oleg Nesterovbee91822015-07-19 23:48:20 +02001516#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001517 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001518#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001519 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001520
Jan Kara5accdf82012-06-12 16:20:34 +02001521/**
1522 * sb_end_write - drop write access to a superblock
1523 * @sb: the super we wrote to
1524 *
1525 * Decrement number of writers to the filesystem. Wake up possible waiters
1526 * wanting to freeze the filesystem.
1527 */
1528static inline void sb_end_write(struct super_block *sb)
1529{
1530 __sb_end_write(sb, SB_FREEZE_WRITE);
1531}
1532
1533/**
1534 * sb_end_pagefault - drop write access to a superblock from a page fault
1535 * @sb: the super we wrote to
1536 *
1537 * Decrement number of processes handling write page fault to the filesystem.
1538 * Wake up possible waiters wanting to freeze the filesystem.
1539 */
1540static inline void sb_end_pagefault(struct super_block *sb)
1541{
1542 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1543}
1544
1545/**
1546 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1547 * @sb: the super we wrote to
1548 *
1549 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1550 * waiters wanting to freeze the filesystem.
1551 */
1552static inline void sb_end_intwrite(struct super_block *sb)
1553{
1554 __sb_end_write(sb, SB_FREEZE_FS);
1555}
1556
1557/**
1558 * sb_start_write - get write access to a superblock
1559 * @sb: the super we write to
1560 *
1561 * When a process wants to write data or metadata to a file system (i.e. dirty
1562 * a page or an inode), it should embed the operation in a sb_start_write() -
1563 * sb_end_write() pair to get exclusion against file system freezing. This
1564 * function increments number of writers preventing freezing. If the file
1565 * system is already frozen, the function waits until the file system is
1566 * thawed.
1567 *
1568 * Since freeze protection behaves as a lock, users have to preserve
1569 * ordering of freeze protection and other filesystem locks. Generally,
1570 * freeze protection should be the outermost lock. In particular, we have:
1571 *
1572 * sb_start_write
1573 * -> i_mutex (write path, truncate, directory ops, ...)
1574 * -> s_umount (freeze_super, thaw_super)
1575 */
1576static inline void sb_start_write(struct super_block *sb)
1577{
1578 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1579}
1580
1581static inline int sb_start_write_trylock(struct super_block *sb)
1582{
1583 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1584}
1585
1586/**
1587 * sb_start_pagefault - get write access to a superblock from a page fault
1588 * @sb: the super we write to
1589 *
1590 * When a process starts handling write page fault, it should embed the
1591 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1592 * exclusion against file system freezing. This is needed since the page fault
1593 * is going to dirty a page. This function increments number of running page
1594 * faults preventing freezing. If the file system is already frozen, the
1595 * function waits until the file system is thawed.
1596 *
1597 * Since page fault freeze protection behaves as a lock, users have to preserve
1598 * ordering of freeze protection and other filesystem locks. It is advised to
1599 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1600 * handling code implies lock dependency:
1601 *
1602 * mmap_sem
1603 * -> sb_start_pagefault
1604 */
1605static inline void sb_start_pagefault(struct super_block *sb)
1606{
1607 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1608}
1609
1610/*
1611 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1612 * @sb: the super we write to
1613 *
1614 * This is the third level of protection against filesystem freezing. It is
1615 * free for use by a filesystem. The only requirement is that it must rank
1616 * below sb_start_pagefault.
1617 *
1618 * For example filesystem can call sb_start_intwrite() when starting a
1619 * transaction which somewhat eases handling of freezing for internal sources
1620 * of filesystem changes (internal fs threads, discarding preallocation on file
1621 * close, etc.).
1622 */
1623static inline void sb_start_intwrite(struct super_block *sb)
1624{
1625 __sb_start_write(sb, SB_FREEZE_FS, true);
1626}
1627
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001629extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301630
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631/*
1632 * VFS helper functions..
1633 */
Al Viro312b63f2012-06-10 18:09:36 -04001634extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001635extern int vfs_create2(struct vfsmount *, struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001636extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001637extern int vfs_mkdir2(struct vfsmount *, struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001638extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001639extern int vfs_mknod2(struct vfsmount *, struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001640extern int vfs_symlink(struct inode *, struct dentry *, const char *);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001641extern int vfs_symlink2(struct vfsmount *, struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001642extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001643extern int vfs_link2(struct vfsmount *, struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644extern int vfs_rmdir(struct inode *, struct dentry *);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001645extern int vfs_rmdir2(struct vfsmount *, struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001646extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001647extern int vfs_unlink2(struct vfsmount *, struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001648extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001649extern int vfs_rename2(struct vfsmount *, struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001650extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
1652/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001653 * VFS file helper functions.
1654 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001655extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001656 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001657extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001658/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001659 * VFS FS_IOC_FIEMAP helper definitions.
1660 */
1661struct fiemap_extent_info {
1662 unsigned int fi_flags; /* Flags as passed from user */
1663 unsigned int fi_extents_mapped; /* Number of mapped extents */
1664 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001665 struct fiemap_extent __user *fi_extents_start; /* Start of
1666 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001667};
1668int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1669 u64 phys, u64 len, u32 flags);
1670int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1671
1672/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 * File types
1674 *
1675 * NOTE! These match bits 12..15 of stat.st_mode
1676 * (ie "(i_mode >> 12) & 15").
1677 */
1678#define DT_UNKNOWN 0
1679#define DT_FIFO 1
1680#define DT_CHR 2
1681#define DT_DIR 4
1682#define DT_BLK 6
1683#define DT_REG 8
1684#define DT_LNK 10
1685#define DT_SOCK 12
1686#define DT_WHT 14
1687
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688/*
1689 * This is the "filldir" function type, used by readdir() to let
1690 * the kernel specify what kind of dirent layout it wants to have.
1691 * This allows the kernel to read directories into kernel space or
1692 * to have different dirent layouts depending on the binary type.
1693 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001694struct dir_context;
1695typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1696 unsigned);
1697
Al Viro5c0ba4e2013-05-15 13:52:59 -04001698struct dir_context {
Al Viroac6614b2013-05-22 22:22:04 -04001699 const filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001700 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001701};
Al Virobb6f6192013-05-15 18:49:12 -04001702
Al Viro08f85852007-10-08 13:26:20 -04001703struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705/* These macros are for out of kernel modules to test that
1706 * the kernel supports the unlocked_ioctl and compat_ioctl
1707 * fields in struct file_operations. */
1708#define HAVE_COMPAT_IOCTL 1
1709#define HAVE_UNLOCKED_IOCTL 1
1710
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001711/*
1712 * These flags let !MMU mmap() govern direct device mapping vs immediate
1713 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1714 *
1715 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1716 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1717 * NOMMU_MAP_READ: Can be mapped for reading
1718 * NOMMU_MAP_WRITE: Can be mapped for writing
1719 * NOMMU_MAP_EXEC: Can be mapped for execution
1720 */
1721#define NOMMU_MAP_COPY 0x00000001
1722#define NOMMU_MAP_DIRECT 0x00000008
1723#define NOMMU_MAP_READ VM_MAYREAD
1724#define NOMMU_MAP_WRITE VM_MAYWRITE
1725#define NOMMU_MAP_EXEC VM_MAYEXEC
1726
1727#define NOMMU_VMFLAGS \
1728 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1729
1730
Al Viro293bc982014-02-11 18:37:41 -05001731struct iov_iter;
1732
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733struct file_operations {
1734 struct module *owner;
1735 loff_t (*llseek) (struct file *, loff_t, int);
1736 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001738 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1739 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001740 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001741 int (*iterate_shared) (struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1744 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1745 int (*mmap) (struct file *, struct vm_area_struct *);
1746 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001747 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001749 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 int (*fasync) (int, struct file *, int);
1751 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1753 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1754 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001756 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1757 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001758 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001759 long (*fallocate)(struct file *file, int mode, loff_t offset,
1760 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001761 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001762#ifndef CONFIG_MMU
1763 unsigned (*mmap_capabilities)(struct file *);
1764#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001765 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1766 loff_t, size_t, unsigned int);
1767 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1768 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001769 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1770 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771};
1772
1773struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001774 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001775 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb2011-06-20 19:28:19 -04001776 int (*permission) (struct inode *, int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07001777 int (*permission2) (struct vfsmount *, struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001778 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001779
1780 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001781
Al Viroebfc3b42012-06-10 18:05:36 -04001782 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 int (*link) (struct dentry *,struct inode *,struct dentry *);
1784 int (*unlink) (struct inode *,struct dentry *);
1785 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001786 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001788 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001790 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 int (*setattr) (struct dentry *, struct iattr *);
Daniel Rosenberg2757e9b2016-10-26 16:33:11 -07001792 int (*setattr2) (struct vfsmount *, struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001795 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1796 u64 len);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001797 int (*update_time)(struct inode *, struct timespec *, int);
Al Virod9585272012-06-22 12:39:14 +04001798 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001799 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001800 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001801 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001802 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001803} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001805ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001806 unsigned long nr_segs, unsigned long fast_segs,
1807 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001808 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001809
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001810extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001811extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1813extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1814extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001815 unsigned long, loff_t *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001817 unsigned long, loff_t *, int);
Zach Brown29732932015-11-10 16:53:30 -05001818extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1819 loff_t, size_t, unsigned int);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001820extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1821 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001822extern int vfs_dedupe_file_range(struct file *file,
1823 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825struct super_operations {
1826 struct inode *(*alloc_inode)(struct super_block *sb);
1827 void (*destroy_inode)(struct inode *);
1828
Christoph Hellwigaa385722011-05-27 06:53:02 -04001829 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001830 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001831 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001832 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001835 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001836 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001837 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001838 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001839 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 int (*remount_fs) (struct super_block *, int *, char *);
Daniel Rosenberg29f888e2016-10-26 15:58:22 -07001841 int (*remount_fs2) (struct vfsmount *, struct super_block *, int *, char *);
Daniel Rosenberg1aaf05b2016-10-26 15:29:51 -07001842 void *(*clone_mnt_data) (void *);
1843 void (*copy_mnt_data) (void *, void *);
Al Viro42faad92008-04-24 07:21:56 -04001844 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
Al Viro34c80b12011-12-08 21:32:45 -05001846 int (*show_options)(struct seq_file *, struct dentry *);
Daniel Rosenberg29f888e2016-10-26 15:58:22 -07001847 int (*show_options2)(struct vfsmount *,struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001848 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001849 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001850 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001851#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1853 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001854 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001855#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001856 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001857 long (*nr_cached_objects)(struct super_block *,
1858 struct shrink_control *);
1859 long (*free_cached_objects)(struct super_block *,
1860 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861};
1862
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001863/*
David Howellsbbc10962012-10-15 16:40:35 +01001864 * Inode flags - they have no relation to superblock flags now
1865 */
1866#define S_SYNC 1 /* Writes are synced at once */
1867#define S_NOATIME 2 /* Do not update access times */
1868#define S_APPEND 4 /* Append-only file */
1869#define S_IMMUTABLE 8 /* Immutable file */
1870#define S_DEAD 16 /* removed, but still open directory */
1871#define S_NOQUOTA 32 /* Inode is not counted to quota */
1872#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1873#define S_NOCMTIME 128 /* Do not update file c/mtime */
1874#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1875#define S_PRIVATE 512 /* Inode is fs-internal */
1876#define S_IMA 1024 /* Inode has an associated IMA struct */
1877#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1878#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001879#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001880#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1881#else
1882#define S_DAX 0 /* Make all the DAX code disappear */
1883#endif
Jaegeuk Kim8dec0742017-06-22 12:14:40 -07001884#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
David Howellsbbc10962012-10-15 16:40:35 +01001885
1886/*
1887 * Note that nosuid etc flags are inode-specific: setting some file-system
1888 * flags just means all the inodes inherit those flags by default. It might be
1889 * possible to override it selectively if you really wanted to with some
1890 * ioctl() that is not currently implemented.
1891 *
1892 * Exception: MS_RDONLY is always applied to the entire file system.
1893 *
1894 * Unfortunately, it is possible to change a filesystems flags with it mounted
1895 * with files in use. This means that all of the inodes will not have their
1896 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1897 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1898 */
1899#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1900
1901#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1902#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1903 ((inode)->i_flags & S_SYNC))
1904#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1905 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1906#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1907#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1908#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1909
1910#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1911#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1912#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1913#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1914
1915#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1916#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1917#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1918#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1919#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1920#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1921#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001922#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Jaegeuk Kim8dec0742017-06-22 12:14:40 -07001923#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
David Howellsbbc10962012-10-15 16:40:35 +01001924
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001925#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1926 (inode)->i_rdev == WHITEOUT_DEV)
1927
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001928static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1929{
1930 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1931}
1932
David Howellsbbc10962012-10-15 16:40:35 +01001933/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001934 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001935 *
1936 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1937 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1938 *
1939 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1940 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1941 * various stages of removing an inode.
1942 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001943 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001944 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001945 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1946 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001947 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1948 * these changes separately from I_DIRTY_SYNC so that we
1949 * don't have to write inode on fdatasync() when only
1950 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001951 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001952 * I_NEW Serves as both a mutex and completion notification.
1953 * New inodes set I_NEW. If two processes both create
1954 * the same inode, one of them will release its inode and
1955 * wait for I_NEW to be released before returning.
1956 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1957 * also cause waiting on I_NEW, without I_NEW actually
1958 * being set. find_inode() uses this to prevent returning
1959 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001960 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1961 * is zero. I_FREEING must be set when I_WILL_FREE is
1962 * cleared.
1963 * I_FREEING Set when inode is about to be freed but still has dirty
1964 * pages or buffers attached or the inode itself is still
1965 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001966 * I_CLEAR Added by clear_inode(). In this state the inode is
1967 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001968 *
1969 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1970 * prohibited for many purposes. iget() must wait for
1971 * the inode to be completely released, then create it
1972 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001973 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001974 *
Jan Kara169ebd92012-05-03 14:48:03 +02001975 * I_SYNC Writeback of inode is running. The bit is set during
1976 * data writeback, and cleared with a wakeup on the bit
1977 * address once it is done. The bit is also used to pin
1978 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001979 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001980 * I_REFERENCED Marks the inode as recently references on the LRU list.
1981 *
1982 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1983 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001984 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1985 * synchronize competing switching instances and to tell
1986 * wb stat updates to grab mapping->tree_lock. See
1987 * inode_switch_wb_work_fn() for details.
1988 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001989 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001990 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001991#define I_DIRTY_SYNC (1 << 0)
1992#define I_DIRTY_DATASYNC (1 << 1)
1993#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001994#define __I_NEW 3
1995#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001996#define I_WILL_FREE (1 << 4)
1997#define I_FREEING (1 << 5)
1998#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001999#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002000#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002001#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002002#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002003#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002004#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002005#define I_DIRTY_TIME (1 << 11)
2006#define __I_DIRTY_TIME_EXPIRED 12
2007#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002008#define I_WB_SWITCH (1 << 13)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
2010#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002011#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012
2013extern void __mark_inode_dirty(struct inode *, int);
2014static inline void mark_inode_dirty(struct inode *inode)
2015{
2016 __mark_inode_dirty(inode, I_DIRTY);
2017}
2018
2019static inline void mark_inode_dirty_sync(struct inode *inode)
2020{
2021 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2022}
2023
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002024extern void inc_nlink(struct inode *inode);
2025extern void drop_nlink(struct inode *inode);
2026extern void clear_nlink(struct inode *inode);
2027extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002028
2029static inline void inode_inc_link_count(struct inode *inode)
2030{
2031 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002032 mark_inode_dirty(inode);
2033}
2034
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002035static inline void inode_dec_link_count(struct inode *inode)
2036{
2037 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002038 mark_inode_dirty(inode);
2039}
2040
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05002041/**
2042 * inode_inc_iversion - increments i_version
2043 * @inode: inode that need to be updated
2044 *
2045 * Every time the inode is modified, the i_version field will be incremented.
2046 * The filesystem has to be mounted with i_version flag
2047 */
2048
2049static inline void inode_inc_iversion(struct inode *inode)
2050{
2051 spin_lock(&inode->i_lock);
2052 inode->i_version++;
2053 spin_unlock(&inode->i_lock);
2054}
2055
Josef Bacikc3b2da32012-03-26 09:59:21 -04002056enum file_time_flags {
2057 S_ATIME = 1,
2058 S_MTIME = 2,
2059 S_CTIME = 4,
2060 S_VERSION = 8,
2061};
2062
Al Virobadcf2b2013-07-16 18:15:46 +04002063extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064static inline void file_accessed(struct file *file)
2065{
2066 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002067 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068}
2069
2070int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002071int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073struct file_system_type {
2074 const char *name;
2075 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002076#define FS_REQUIRES_DEV 1
2077#define FS_BINARY_MOUNTDATA 2
2078#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002079#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002080#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002081 struct dentry *(*mount) (struct file_system_type *, int,
2082 const char *, void *);
Daniel Rosenberg29f888e2016-10-26 15:58:22 -07002083 struct dentry *(*mount2) (struct vfsmount *, struct file_system_type *, int,
2084 const char *, void *);
Daniel Rosenberg1aaf05b2016-10-26 15:29:51 -07002085 void *(*alloc_mnt_data) (void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 void (*kill_sb) (struct super_block *);
2087 struct module *owner;
2088 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002089 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002090
Ingo Molnarcf516242006-07-03 00:25:27 -07002091 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002092 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002093 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002094 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002095
2096 struct lock_class_key i_lock_key;
2097 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002098 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099};
2100
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002101#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2102
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002103extern struct dentry *mount_ns(struct file_system_type *fs_type,
2104 int flags, void *data, void *ns, struct user_namespace *user_ns,
2105 int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04002106extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2107 int flags, const char *dev_name, void *data,
2108 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002109extern struct dentry *mount_single(struct file_system_type *fs_type,
2110 int flags, void *data,
2111 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002112extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2113 int flags, void *data,
2114 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002115extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116void generic_shutdown_super(struct super_block *sb);
2117void kill_block_super(struct super_block *sb);
2118void kill_anon_super(struct super_block *sb);
2119void kill_litter_super(struct super_block *sb);
2120void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002121void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002123int get_anon_bdev(dev_t *);
2124void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002125struct super_block *sget_userns(struct file_system_type *type,
2126 int (*test)(struct super_block *,void *),
2127 int (*set)(struct super_block *,void *),
2128 int flags, struct user_namespace *user_ns,
2129 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130struct super_block *sget(struct file_system_type *type,
2131 int (*test)(struct super_block *,void *),
2132 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002133 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002134extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2135 const struct super_operations *ops,
2136 const struct xattr_handler **xattr,
2137 const struct dentry_operations *dops,
2138 unsigned long);
2139
2140static inline struct dentry *
2141mount_pseudo(struct file_system_type *fs_type, char *name,
2142 const struct super_operations *ops,
2143 const struct dentry_operations *dops, unsigned long magic)
2144{
2145 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2146}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147
2148/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2149#define fops_get(fops) \
2150 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2151#define fops_put(fops) \
2152 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002153/*
2154 * This one is to be used *ONLY* from ->open() instances.
2155 * fops must be non-NULL, pinned down *and* module dependencies
2156 * should be sufficient to pin the caller down as well.
2157 */
2158#define replace_fops(f, fops) \
2159 do { \
2160 struct file *__file = (f); \
2161 fops_put(__file->f_op); \
2162 BUG_ON(!(__file->f_op = (fops))); \
2163 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164
2165extern int register_filesystem(struct file_system_type *);
2166extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002167extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2168#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002169extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170extern int may_umount_tree(struct vfsmount *);
2171extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002172extern long do_mount(const char *, const char __user *,
2173 const char *, unsigned long, void *);
Al Viro589ff872009-04-18 03:28:19 -04002174extern struct vfsmount *collect_mounts(struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002175extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002176extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2177 struct vfsmount *);
Christoph Hellwigebabe9a2010-07-07 18:53:11 +02002178extern int vfs_statfs(struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002179extern int user_statfs(const char __user *, struct kstatfs *);
2180extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002181extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002182extern int freeze_super(struct super_block *super);
2183extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002184extern bool our_mnt(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185
Al Viroce3b0f82009-03-29 19:08:22 -04002186extern int current_umask(void);
2187
J. Bruce Fields5a146962012-08-28 07:50:40 -07002188extern void ihold(struct inode * inode);
2189extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002190extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002191
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002192/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002193extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002194
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002195#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002196
Jeff Layton9e8925b2015-11-16 09:49:34 -05002197#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002198extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002199extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201/*
2202 * Candidates for mandatory locking have the setgid bit set
2203 * but no group execute bit - an otherwise meaningless combination.
2204 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002205
2206static inline int __mandatory_lock(struct inode *ino)
2207{
2208 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2209}
2210
2211/*
2212 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2213 * otherwise these will be advisory locks
2214 */
2215
2216static inline int mandatory_lock(struct inode *ino)
2217{
2218 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2219}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220
Jeff Laytond7a06982014-03-10 09:54:15 -04002221static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222{
Miklos Szeredic568d682016-09-16 12:44:20 +02002223 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002224 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 return 0;
2226}
2227
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002229 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 loff_t size)
2231{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002232 if (!inode->i_flctx || !mandatory_lock(inode))
2233 return 0;
2234
2235 if (size < inode->i_size) {
2236 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2237 F_WRLCK);
2238 } else {
2239 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2240 F_WRLCK);
2241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242}
2243
Jeff Layton9e8925b2015-11-16 09:49:34 -05002244#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2245
2246static inline int locks_mandatory_locked(struct file *file)
2247{
2248 return 0;
2249}
2250
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002251static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2252 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002253{
2254 return 0;
2255}
2256
2257static inline int __mandatory_lock(struct inode *inode)
2258{
2259 return 0;
2260}
2261
2262static inline int mandatory_lock(struct inode *inode)
2263{
2264 return 0;
2265}
2266
2267static inline int locks_verify_locked(struct file *file)
2268{
2269 return 0;
2270}
2271
2272static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2273 size_t size)
2274{
2275 return 0;
2276}
2277
2278#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2279
2280
2281#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282static inline int break_lease(struct inode *inode, unsigned int mode)
2283{
Jeff Layton24cbe782014-02-03 12:13:06 -05002284 /*
2285 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002286 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2287 * could end up racing with tasks trying to set a new lease on this
2288 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002289 */
2290 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002291 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002292 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 return 0;
2294}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002295
2296static inline int break_deleg(struct inode *inode, unsigned int mode)
2297{
Jeff Layton962bd402014-06-10 12:24:40 -04002298 /*
2299 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002300 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2301 * could end up racing with tasks trying to set a new lease on this
2302 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002303 */
2304 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002305 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002306 return __break_lease(inode, mode, FL_DELEG);
2307 return 0;
2308}
2309
J. Bruce Fields5a146962012-08-28 07:50:40 -07002310static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2311{
2312 int ret;
2313
2314 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2315 if (ret == -EWOULDBLOCK && delegated_inode) {
2316 *delegated_inode = inode;
2317 ihold(inode);
2318 }
2319 return ret;
2320}
2321
2322static inline int break_deleg_wait(struct inode **delegated_inode)
2323{
2324 int ret;
2325
2326 ret = break_deleg(*delegated_inode, O_WRONLY);
2327 iput(*delegated_inode);
2328 *delegated_inode = NULL;
2329 return ret;
2330}
2331
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002332static inline int break_layout(struct inode *inode, bool wait)
2333{
2334 smp_mb();
2335 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2336 return __break_lease(inode,
2337 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2338 FL_LAYOUT);
2339 return 0;
2340}
2341
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002342#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002343static inline int break_lease(struct inode *inode, unsigned int mode)
2344{
2345 return 0;
2346}
2347
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002348static inline int break_deleg(struct inode *inode, unsigned int mode)
2349{
2350 return 0;
2351}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002352
2353static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2354{
2355 return 0;
2356}
2357
2358static inline int break_deleg_wait(struct inode **delegated_inode)
2359{
2360 BUG();
2361 return 0;
2362}
2363
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002364static inline int break_layout(struct inode *inode, bool wait)
2365{
2366 return 0;
2367}
2368
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002369#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370
2371/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002372struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002373struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002374 const char *name; /* pointer to actual string */
2375 const __user char *uptr; /* original userland pointer */
2376 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002377 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002378 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002379};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380
Al Viro7df818b2016-03-25 14:24:09 -04002381extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002382extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2383 struct file *filp);
Daniel Rosenberg2757e9b2016-10-26 16:33:11 -07002384extern int do_truncate2(struct vfsmount *, struct dentry *, loff_t start,
2385 unsigned int time_attrs, struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002386extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002387 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002388extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002389 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002390extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002391extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002392extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002393 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002394extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002396
David Drysdale51f39a12014-12-12 16:57:29 -08002397extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002398extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002399extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002400extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002401
Al Viro47237682012-06-10 05:01:45 -04002402enum {
2403 FILE_CREATED = 1,
2404 FILE_OPENED = 2
2405};
Al Viro30d90492012-06-22 12:40:19 +04002406extern int finish_open(struct file *file, struct dentry *dentry,
2407 int (*open)(struct inode *, struct file *),
2408 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002409extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002411/* fs/ioctl.c */
2412
2413extern int ioctl_preallocate(struct file *filp, void __user *argp);
2414
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415/* fs/dcache.c */
2416extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002417extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418
Christoph Lameterb86c0892006-12-06 20:32:57 -08002419extern struct kmem_cache *names_cachep;
2420
Jeff Laytona608ca22012-10-10 15:25:26 -04002421#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002422#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423
David Howells93614012006-09-30 20:45:40 +02002424#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002426extern void unregister_blkdev(unsigned int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002428extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429extern void bd_set_size(struct block_device *, loff_t size);
2430extern void bd_forget(struct inode *inode);
2431extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002432extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002433extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002434extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb482011-09-16 02:31:11 -04002435extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002436extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002437extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002438extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2439extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002440
2441extern struct super_block *blockdev_superblock;
2442
2443static inline bool sb_is_blkdev_sb(struct super_block *sb)
2444{
2445 return sb == blockdev_superblock;
2446}
David Howells93614012006-09-30 20:45:40 +02002447#else
2448static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002449static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb482011-09-16 02:31:11 -04002450static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002451static inline void invalidate_bdev(struct block_device *bdev) {}
2452
2453static inline struct super_block *freeze_bdev(struct block_device *sb)
2454{
2455 return NULL;
2456}
2457
2458static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2459{
2460 return 0;
2461}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002462
2463static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2464{
2465}
Jan Karaa8855992013-07-09 22:36:45 +08002466
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002467static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002468{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002469 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002470}
David Howells93614012006-09-30 20:45:40 +02002471#endif
Jan Kara60b06802009-04-27 16:43:53 +02002472extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002473extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002474extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002475#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002477extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002479extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002480extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2481 void *holder);
2482extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2483 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002484extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002485extern int __blkdev_reread_part(struct block_device *bdev);
2486extern int blkdev_reread_part(struct block_device *bdev);
2487
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002488#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002489extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002490extern void bd_unlink_disk_holder(struct block_device *bdev,
2491 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002492#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002493static inline int bd_link_disk_holder(struct block_device *bdev,
2494 struct gendisk *disk)
2495{
2496 return 0;
2497}
Tejun Heo49731ba2011-01-14 18:43:57 +01002498static inline void bd_unlink_disk_holder(struct block_device *bdev,
2499 struct gendisk *disk)
2500{
2501}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002502#endif
David Howells93614012006-09-30 20:45:40 +02002503#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504
2505/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002506#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Walleij49db08c2016-02-19 15:36:07 +01002507/* Marks the bottom of the first segment of free char majors */
2508#define CHRDEV_MAJOR_DYN_END 234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2510extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002511extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2512 unsigned int count, const char *name,
2513 const struct file_operations *fops);
2514extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2515 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002517extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518
Tejun Heo1905b1b2009-08-06 18:13:23 +09002519static inline int register_chrdev(unsigned int major, const char *name,
2520 const struct file_operations *fops)
2521{
2522 return __register_chrdev(major, 0, 256, name, fops);
2523}
2524
2525static inline void unregister_chrdev(unsigned int major, const char *name)
2526{
2527 __unregister_chrdev(major, 0, 256, name);
2528}
2529
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530/* fs/block_dev.c */
2531#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002532#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002533
2534#ifdef CONFIG_BLOCK
2535#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536extern const char *__bdevname(dev_t, char *buffer);
2537extern const char *bdevname(struct block_device *bdev, char *buffer);
2538extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002539extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002540
David Howells93614012006-09-30 20:45:40 +02002541#else
2542#define BLKDEV_MAJOR_HASH_SIZE 0
2543#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544
2545extern void init_special_inode(struct inode *, umode_t, dev_t);
2546
2547/* Invalid inode operations -- fs/bad_inode.c */
2548extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002549extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550
Jens Axboec11f0c02016-08-05 08:11:04 -06002551#ifdef CONFIG_BLOCK
Mike Christie4e1b2d522016-06-05 14:32:22 -05002552static inline bool op_is_write(unsigned int op)
Mike Christief2150822016-06-05 14:31:42 -05002553{
Mike Christie4e1b2d522016-06-05 14:32:22 -05002554 return op == REQ_OP_READ ? false : true;
Mike Christief2150822016-06-05 14:31:42 -05002555}
2556
2557/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 * return data direction, READ or WRITE
2559 */
Mike Christief2150822016-06-05 14:31:42 -05002560static inline int bio_data_dir(struct bio *bio)
2561{
Mike Christie4e1b2d522016-06-05 14:32:22 -05002562 return op_is_write(bio_op(bio)) ? WRITE : READ;
Mike Christief2150822016-06-05 14:31:42 -05002563}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002565extern void check_disk_size_change(struct gendisk *disk,
2566 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002567extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002569extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002571#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572unsigned long invalidate_mapping_pages(struct address_space *mapping,
2573 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002574
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575static inline void invalidate_remote_inode(struct inode *inode)
2576{
2577 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2578 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002579 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580}
2581extern int invalidate_inode_pages2(struct address_space *mapping);
2582extern int invalidate_inode_pages2_range(struct address_space *mapping,
2583 pgoff_t start, pgoff_t end);
2584extern int write_inode_now(struct inode *, int);
2585extern int filemap_fdatawrite(struct address_space *);
2586extern int filemap_flush(struct address_space *);
2587extern int filemap_fdatawait(struct address_space *);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -08002588extern void filemap_fdatawait_keep_errors(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002589extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2590 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591extern int filemap_write_and_wait(struct address_space *mapping);
2592extern int filemap_write_and_wait_range(struct address_space *mapping,
2593 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002594extern int __filemap_fdatawrite_range(struct address_space *mapping,
2595 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002596extern int filemap_fdatawrite_range(struct address_space *mapping,
2597 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002598extern int filemap_check_errors(struct address_space *mapping);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002599
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002600extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2601 int datasync);
2602extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002603
2604/*
2605 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2606 * to already be updated for the write, and will return either the amount
2607 * of bytes passed in, or an error if syncing the file failed.
2608 */
2609static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002610{
Christoph Hellwige2592212016-04-07 08:52:01 -07002611 if (iocb->ki_flags & IOCB_DSYNC) {
2612 int ret = vfs_fsync_range(iocb->ki_filp,
2613 iocb->ki_pos - count, iocb->ki_pos - 1,
2614 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2615 if (ret)
2616 return ret;
2617 }
2618
2619 return count;
Al Virod311d792014-02-09 15:18:09 -05002620}
Christoph Hellwige2592212016-04-07 08:52:01 -07002621
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622extern void emergency_sync(void);
2623extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002624#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002626#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002627extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Daniel Rosenberg2757e9b2016-10-26 16:33:11 -07002628extern int notify_change2(struct vfsmount *, struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002629extern int inode_permission(struct inode *, int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07002630extern int inode_permission2(struct vfsmount *, struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002631extern int __inode_permission(struct inode *, int);
Daniel Rosenbergbbcd0ff2016-10-26 16:27:45 -07002632extern int __inode_permission2(struct vfsmount *, struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002633extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002634extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Miklos Szeredif696a362008-07-31 13:41:58 +02002636static inline bool execute_ok(struct inode *inode)
2637{
2638 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2639}
2640
Al Viro8d71db42013-03-19 21:01:03 -04002641static inline void file_start_write(struct file *file)
2642{
2643 if (!S_ISREG(file_inode(file)->i_mode))
2644 return;
2645 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2646}
2647
Jan Kara5ae98f12013-05-04 00:11:23 +02002648static inline bool file_start_write_trylock(struct file *file)
2649{
2650 if (!S_ISREG(file_inode(file)->i_mode))
2651 return true;
2652 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2653}
2654
Al Viro8d71db42013-03-19 21:01:03 -04002655static inline void file_end_write(struct file *file)
2656{
2657 if (!S_ISREG(file_inode(file)->i_mode))
2658 return;
2659 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2660}
2661
Al Viro07b8ce12011-06-20 10:52:57 -04002662/*
2663 * get_write_access() gets write permission for a file.
2664 * put_write_access() releases this write permission.
2665 * This is used for regular files.
2666 * We cannot support write (and maybe mmap read-write shared) accesses and
2667 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2668 * can have the following values:
2669 * 0: no writers, no VM_DENYWRITE mappings
2670 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2671 * > 0: (i_writecount) users are writing to the file.
2672 *
2673 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2674 * except for the cases where we don't hold i_writecount yet. Then we need to
2675 * use {get,deny}_write_access() - these functions check the sign and refuse
2676 * to do the change if sign is wrong.
2677 */
2678static inline int get_write_access(struct inode *inode)
2679{
2680 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2681}
2682static inline int deny_write_access(struct file *file)
2683{
Al Viro496ad9a2013-01-23 17:07:38 -05002684 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002685 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2686}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687static inline void put_write_access(struct inode * inode)
2688{
2689 atomic_dec(&inode->i_writecount);
2690}
2691static inline void allow_write_access(struct file *file)
2692{
2693 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002694 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695}
David Howellsf1fe29b2013-09-27 11:20:03 +01002696static inline bool inode_is_open_for_write(const struct inode *inode)
2697{
2698 return atomic_read(&inode->i_writecount) > 0;
2699}
2700
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002701#ifdef CONFIG_IMA
2702static inline void i_readcount_dec(struct inode *inode)
2703{
2704 BUG_ON(!atomic_read(&inode->i_readcount));
2705 atomic_dec(&inode->i_readcount);
2706}
2707static inline void i_readcount_inc(struct inode *inode)
2708{
2709 atomic_inc(&inode->i_readcount);
2710}
2711#else
2712static inline void i_readcount_dec(struct inode *inode)
2713{
2714 return;
2715}
2716static inline void i_readcount_inc(struct inode *inode)
2717{
2718 return;
2719}
2720#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002721extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
Mimi Zohar1284ab52016-04-20 15:46:27 -07002723#define __kernel_read_file_id(id) \
2724 id(UNKNOWN, unknown) \
2725 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002726 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002727 id(MODULE, kernel-module) \
2728 id(KEXEC_IMAGE, kexec-image) \
2729 id(KEXEC_INITRAMFS, kexec-initramfs) \
2730 id(POLICY, security-policy) \
2731 id(MAX_ID, )
2732
2733#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2734#define __fid_stringify(dummy, str) #str,
2735
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002736enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002737 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002738};
2739
Mimi Zohar1284ab52016-04-20 15:46:27 -07002740static const char * const kernel_read_file_str[] = {
2741 __kernel_read_file_id(__fid_stringify)
2742};
2743
Kees Cookda20dfe2016-04-21 12:53:29 -07002744static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002745{
2746 if (id < 0 || id >= READING_MAX_ID)
2747 return kernel_read_file_str[READING_UNKNOWN];
2748
2749 return kernel_read_file_str[id];
2750}
2751
Mimi Zohar6777d772009-08-21 14:32:48 -04002752extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002753extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2754 enum kernel_read_file_id);
Mimi Zohar09596b92015-11-19 12:39:22 -05002755extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2756 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002757extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2758 enum kernel_read_file_id);
Al Viro7bb307e2013-02-23 14:51:48 -05002759extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002760extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761extern struct file * open_exec(const char *);
2762
2763/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002764extern bool is_subdir(struct dentry *, struct dentry *);
Yaowei Bai25ab4c92015-11-17 14:40:10 +08002765extern bool path_is_under(struct path *, struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002767extern char *file_path(struct file *, char *, int);
2768
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769#include <linux/err.h>
2770
2771/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002772extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773
Andrew Morton965c8e52012-12-17 15:59:39 -08002774extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775
Christoph Hellwig54e34622009-08-07 14:38:25 -03002776extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002778extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779extern struct inode * igrab(struct inode *);
2780extern ino_t iunique(struct super_block *, ino_t);
2781extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002782extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002783static inline int generic_drop_inode(struct inode *inode)
2784{
2785 return !inode->i_nlink || inode_unhashed(inode);
2786}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002788extern struct inode *ilookup5_nowait(struct super_block *sb,
2789 unsigned long hashval, int (*test)(struct inode *, void *),
2790 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2792 int (*test)(struct inode *, void *), void *data);
2793extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2794
2795extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2796extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002797extern struct inode *find_inode_nowait(struct super_block *,
2798 unsigned long,
2799 int (*match)(struct inode *,
2800 unsigned long, void *),
2801 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002802extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2803extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002804#ifdef CONFIG_DEBUG_LOCK_ALLOC
2805extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2806#else
2807static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2808#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002810extern unsigned int get_next_ino(void);
Darrick J. Wong63d184d2017-09-17 14:06:57 -07002811extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002814extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002815extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002816extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002817extern struct inode *new_inode_pseudo(struct super_block *sb);
2818extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002819extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002820extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002821extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822
2823extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002824static inline void insert_inode_hash(struct inode *inode)
2825{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826 __insert_inode_hash(inode, inode->i_ino);
2827}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002828
2829extern void __remove_inode_hash(struct inode *);
2830static inline void remove_inode_hash(struct inode *inode)
2831{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002832 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002833 __remove_inode_hash(inode);
2834}
2835
Christoph Hellwig646ec462010-10-23 07:15:32 -04002836extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002837
David Howells93614012006-09-30 20:45:40 +02002838#ifdef CONFIG_BLOCK
Mike Christie4e49ea42016-06-05 14:31:41 -05002839extern blk_qc_t submit_bio(struct bio *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002841#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842extern int set_blocksize(struct block_device *, int);
2843extern int sb_set_blocksize(struct super_block *, int);
2844extern int sb_min_blocksize(struct super_block *, int);
2845
2846extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2847extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002848extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002849extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002850extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002851extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002852extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002853extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002854
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002855ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2856ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2857
Christoph Hellwigeef99382009-08-20 17:43:41 +02002858/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002859extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002860extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002861extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2862 int datasync);
Al Viroff01bb482011-09-16 02:31:11 -04002863extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002864
Andrew Morton88e6fae2006-04-11 13:59:36 +02002865/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002866extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002867 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002868extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002869 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002870extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002871 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002872extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2873 loff_t *opos, size_t len, unsigned int flags);
2874
Andrew Morton88e6fae2006-04-11 13:59:36 +02002875
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876extern void
2877file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002878extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2879extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002880extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002881extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002882extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002883 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002884extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2885 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002886extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2887extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002888extern int generic_file_open(struct inode * inode, struct file * filp);
2889extern int nonseekable_open(struct inode * inode, struct file * filp);
Kirill Smelkov9c829b62019-03-26 22:20:43 +00002890extern int stream_open(struct inode * inode, struct file * filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891
David Howells93614012006-09-30 20:45:40 +02002892#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05002893typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04002894 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895
2896enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002897 /* need locking between buffered and direct access */
2898 DIO_LOCKING = 0x01,
2899
2900 /* filesystem does not support filling holes */
2901 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002902
2903 /* filesystem can handle aio writes beyond i_size */
2904 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002905
2906 /* inode/fs/bdev does not need truncate protection */
2907 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908};
2909
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002910void dio_end_io(struct bio *bio, int error);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002911
Omar Sandoval17f8c842015-03-16 04:33:50 -07002912ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2913 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002914 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002915 dio_iodone_t end_io, dio_submit_t submit_io,
2916 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002917
Omar Sandoval17f8c842015-03-16 04:33:50 -07002918static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2919 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002920 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002921 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002922{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002923 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002924 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925}
David Howells93614012006-09-30 20:45:40 +02002926#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927
Trond Myklebust1d59d612012-05-31 12:22:33 -04002928void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002929
2930/*
2931 * inode_dio_begin - signal start of a direct I/O requests
2932 * @inode: inode the direct I/O happens on
2933 *
2934 * This is called once we've finished processing a direct I/O request,
2935 * and is used to wake up callers waiting for direct I/O to be quiesced.
2936 */
2937static inline void inode_dio_begin(struct inode *inode)
2938{
2939 atomic_inc(&inode->i_dio_count);
2940}
2941
2942/*
2943 * inode_dio_end - signal finish of a direct I/O requests
2944 * @inode: inode the direct I/O happens on
2945 *
2946 * This is called once we've finished processing a direct I/O request,
2947 * and is used to wake up callers waiting for direct I/O to be quiesced.
2948 */
2949static inline void inode_dio_end(struct inode *inode)
2950{
2951 if (atomic_dec_and_test(&inode->i_dio_count))
2952 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2953}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002954
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002955extern void inode_set_flags(struct inode *inode, unsigned int flags,
2956 unsigned int mask);
2957
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002958extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959
2960#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2961
Al Viro5d826c82014-03-14 13:42:45 -04002962extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05002964extern const char *page_get_link(struct dentry *, struct inode *,
2965 struct delayed_call *);
2966extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002967extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002968 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002970extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05002971extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972extern int generic_readlink(struct dentry *, char __user *, int);
2973extern void generic_fillattr(struct inode *, struct kstat *);
J. Bruce Fieldsb7a6ec52013-10-02 17:01:18 -04002974int vfs_getattr_nosec(struct path *path, struct kstat *stat);
Al Viro3dadecc2013-01-24 02:18:08 -05002975extern int vfs_getattr(struct path *, struct kstat *);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002976void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002977void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002978void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979void inode_sub_bytes(struct inode *inode, loff_t bytes);
2980loff_t inode_get_bytes(struct inode *inode);
2981void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05002982const char *simple_get_link(struct dentry *, struct inode *,
2983 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04002984extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985
Al Viro5c0ba4e2013-05-15 13:52:59 -04002986extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987
David Howellsc7887322010-08-11 11:26:22 +01002988extern int vfs_stat(const char __user *, struct kstat *);
2989extern int vfs_lstat(const char __user *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990extern int vfs_fstat(unsigned int, struct kstat *);
David Howellsc7887322010-08-11 11:26:22 +01002991extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
Miklos Szeredid60874c2016-10-04 14:40:45 +02002992extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993
Steven Whitehousee9079cc2008-10-14 14:43:29 +01002994extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04002995 struct fiemap_extent_info *fieinfo,
2996 loff_t start, loff_t len,
2997 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04002998extern int generic_block_fiemap(struct inode *inode,
2999 struct fiemap_extent_info *fieinfo, u64 start,
3000 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
Miklos Szeredic18479f2007-10-18 23:39:11 -07003002extern void get_filesystem(struct file_system_type *fs);
3003extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003004extern struct file_system_type *get_fs_type(const char *name);
3005extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003006extern struct super_block *get_super_thawed(struct block_device *);
Christoph Hellwig45042302009-08-03 23:28:35 +02003007extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008extern void drop_super(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003009extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003010extern void iterate_supers_type(struct file_system_type *,
3011 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012
3013extern int dcache_dir_open(struct inode *, struct file *);
3014extern int dcache_dir_close(struct inode *, struct file *);
3015extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003016extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003017extern int simple_setattr(struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells726c3342006-06-23 02:02:58 -07003019extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003020extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003021extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3022extern int simple_unlink(struct inode *, struct dentry *);
3023extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003024extern int simple_rename(struct inode *, struct dentry *,
3025 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003026extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027extern int simple_empty(struct dentry *);
3028extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003029extern int simple_write_begin(struct file *file, struct address_space *mapping,
3030 loff_t pos, unsigned len, unsigned flags,
3031 struct page **pagep, void **fsdata);
3032extern int simple_write_end(struct file *file, struct address_space *mapping,
3033 loff_t pos, unsigned len, unsigned copied,
3034 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003035extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003036extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003037extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003038extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003039
Al Viro00cd8dd2012-06-10 17:13:09 -04003040extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003042extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003043extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003044extern void make_empty_dir_inode(struct inode *inode);
3045extern bool is_empty_dir_inode(struct inode *inode);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003046struct tree_descr { char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047struct dentry *d_alloc_name(struct dentry *, const char *);
Roberto Sassu7d683a02010-06-03 11:58:28 +02003048extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003049extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050extern void simple_release_fs(struct vfsmount **mount, int *count);
3051
Akinobu Mita93b07112008-06-05 22:46:21 -07003052extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3053 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003054extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3055 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056
Fabian Frederickac13a822014-06-04 16:06:27 -07003057extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003058extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003059
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003060extern int generic_check_addressable(unsigned, u64);
3061
Christoph Lametere965f962006-02-01 03:05:41 -08003062#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003063extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003064 struct page *, struct page *,
3065 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003066#else
3067#define buffer_migrate_page NULL
3068#endif
3069
Jan Kara31051c82016-05-26 16:55:18 +02003070extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003071extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003072extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073
Josef Bacikc3b2da32012-03-26 09:59:21 -04003074extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075
Al Viro34c80b12011-12-08 21:32:45 -05003076extern int generic_show_options(struct seq_file *m, struct dentry *root);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003077extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04003078extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003079
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003080static inline bool io_is_direct(struct file *filp)
3081{
Dan Williams65f87ee2016-01-25 17:23:18 -08003082 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003083}
3084
Dan Williamsb29ea3c2018-02-23 14:05:49 -08003085static inline bool vma_is_dax(struct vm_area_struct *vma)
3086{
3087 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3088}
3089
3090static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3091{
3092 struct inode *inode;
3093
3094 if (!vma->vm_file)
3095 return false;
3096 if (!vma_is_dax(vma))
3097 return false;
3098 inode = file_inode(vma->vm_file);
Dan Williams43672fa2018-02-21 17:08:01 -08003099 if (S_ISCHR(inode->i_mode))
Dan Williamsb29ea3c2018-02-23 14:05:49 -08003100 return false; /* device-dax */
3101 return true;
3102}
3103
Al Viro2ba48ce2015-04-09 13:52:01 -04003104static inline int iocb_flags(struct file *file)
3105{
3106 int res = 0;
3107 if (file->f_flags & O_APPEND)
3108 res |= IOCB_APPEND;
3109 if (io_is_direct(file))
3110 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003111 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3112 res |= IOCB_DSYNC;
3113 if (file->f_flags & __O_SYNC)
3114 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003115 return res;
3116}
3117
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118static inline ino_t parent_ino(struct dentry *dentry)
3119{
3120 ino_t res;
3121
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003122 /*
3123 * Don't strictly need d_lock here? If the parent ino could change
3124 * then surely we'd have a deeper race in the caller?
3125 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126 spin_lock(&dentry->d_lock);
3127 res = dentry->d_parent->d_inode->i_ino;
3128 spin_unlock(&dentry->d_lock);
3129 return res;
3130}
3131
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132/* Transaction based IO helpers */
3133
3134/*
3135 * An argresp is stored in an allocated page and holds the
3136 * size of the argument or response, along with its content
3137 */
3138struct simple_transaction_argresp {
3139 ssize_t size;
3140 char data[0];
3141};
3142
3143#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3144
3145char *simple_transaction_get(struct file *file, const char __user *buf,
3146 size_t size);
3147ssize_t simple_transaction_read(struct file *file, char __user *buf,
3148 size_t size, loff_t *pos);
3149int simple_transaction_release(struct inode *inode, struct file *file);
3150
Ingo Molnar76791ab2009-03-25 16:48:35 +01003151void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003153/*
3154 * simple attribute files
3155 *
3156 * These attributes behave similar to those in sysfs:
3157 *
3158 * Writing to an attribute immediately sets a value, an open file can be
3159 * written to multiple times.
3160 *
3161 * Reading from an attribute creates a buffer from the value that might get
3162 * read with multiple read calls. When the attribute has been read
3163 * completely, no further read calls are possible until the file is opened
3164 * again.
3165 *
3166 * All attributes contain a text representation of a numeric value
3167 * that are accessed with the get() and set() functions.
3168 */
3169#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3170static int __fops ## _open(struct inode *inode, struct file *file) \
3171{ \
3172 __simple_attr_check_format(__fmt, 0ull); \
3173 return simple_attr_open(inode, file, __get, __set, __fmt); \
3174} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003175static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003176 .owner = THIS_MODULE, \
3177 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003178 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003179 .read = simple_attr_read, \
3180 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003181 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003182}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003183
Joe Perchesb9075fa2011-10-31 17:11:33 -07003184static inline __printf(1, 2)
3185void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003186{
3187 /* don't do anything, just let the compiler check the arguments; */
3188}
3189
3190int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003191 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003192 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003193int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003194ssize_t simple_attr_read(struct file *file, char __user *buf,
3195 size_t len, loff_t *ppos);
3196ssize_t simple_attr_write(struct file *file, const char __user *buf,
3197 size_t len, loff_t *ppos);
3198
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003199struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003200int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003201 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003202int proc_nr_dentry(struct ctl_table *table, int write,
3203 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003204int proc_nr_inodes(struct ctl_table *table, int write,
3205 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003206int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003207
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003208#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003209#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3210
Al Viro6d125522009-12-24 06:58:56 -05003211#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003212#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003213 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003214
Yaowei Baid37177b2015-11-19 21:00:12 +08003215static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003216{
3217 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3218}
3219
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003220static inline int check_sticky(struct inode *dir, struct inode *inode)
3221{
3222 if (!(dir->i_mode & S_ISVTX))
3223 return 0;
3224
3225 return __check_sticky(dir, inode);
3226}
3227
Andi Kleen69b45732011-05-28 08:25:51 -07003228static inline void inode_has_no_xattr(struct inode *inode)
3229{
Al Viro9e1f1de2011-06-03 18:24:58 -04003230 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003231 inode->i_flags |= S_NOSEC;
3232}
3233
Al Viroa7400222014-10-21 15:20:42 -04003234static inline bool is_root_inode(struct inode *inode)
3235{
3236 return inode == inode->i_sb->s_root->d_inode;
3237}
3238
Al Viro5f99f4e2013-05-15 20:23:06 -04003239static inline bool dir_emit(struct dir_context *ctx,
3240 const char *name, int namelen,
3241 u64 ino, unsigned type)
3242{
3243 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3244}
3245static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3246{
3247 return ctx->actor(ctx, ".", 1, ctx->pos,
3248 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3249}
3250static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3251{
3252 return ctx->actor(ctx, "..", 2, ctx->pos,
3253 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3254}
3255static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3256{
3257 if (ctx->pos == 0) {
3258 if (!dir_emit_dot(file, ctx))
3259 return false;
3260 ctx->pos = 1;
3261 }
3262 if (ctx->pos == 1) {
3263 if (!dir_emit_dotdot(file, ctx))
3264 return false;
3265 ctx->pos = 2;
3266 }
3267 return true;
3268}
Al Viro5ded75e2013-05-15 21:02:48 -04003269static inline bool dir_relax(struct inode *inode)
3270{
Al Viro59551022016-01-22 15:40:57 -05003271 inode_unlock(inode);
3272 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003273 return !IS_DEADDIR(inode);
3274}
Al Viro5f99f4e2013-05-15 20:23:06 -04003275
Al Viroae053272016-05-12 20:36:01 -04003276static inline bool dir_relax_shared(struct inode *inode)
3277{
3278 inode_unlock_shared(inode);
3279 inode_lock_shared(inode);
3280 return !IS_DEADDIR(inode);
3281}
3282
Eric W. Biederman90f85722015-06-29 14:42:03 -05003283extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003284extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003285
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286#endif /* _LINUX_FS_H */