blob: 65adbddb31636559a1e6f65b585b7a6b733f0ae6 [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>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053021#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040022#include <linux/semaphore.h>
Jens Axboec75b1d92017-06-27 11:47:04 -060023#include <linux/fcntl.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040024#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110025#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040026#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080027#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110028#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080029#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020030#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020031#include <linux/percpu-rwsem.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020032#include <linux/workqueue.h>
Al Virofceef392015-12-29 15:58:39 -050033#include <linux/delayed_call.h>
Christoph Hellwig85787092017-05-10 15:06:33 +020034#include <linux/uuid.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010037#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010039struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040040struct bdi_writeback;
Christoph Hellwig2f8b5442016-11-01 07:40:13 -060041struct bio;
Christoph Hellwiga5694252007-07-17 04:04:28 -070042struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080043struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070045struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020046struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047struct pipe_inode_info;
48struct poll_table_struct;
49struct kstatfs;
50struct vm_area_struct;
51struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110052struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070053struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080054struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020055struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050056struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070057struct fscrypt_info;
58struct fscrypt_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Denis Cheng74bf17c2007-10-16 23:26:30 -070060extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070062extern void __init files_init(void);
63extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Jan Engelhardtdded4f42008-12-01 14:34:50 -080065extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070066extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030067extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080068extern struct inodes_stat_t inodes_stat;
69extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070070extern int sysctl_protected_symlinks;
71extern int sysctl_protected_hardlinks;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080072
Linus Torvalds1da177e2005-04-16 15:20:36 -070073struct buffer_head;
74typedef int (get_block_t)(struct inode *inode, sector_t iblock,
75 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110076typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020077 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
David Howellsbbc10962012-10-15 16:40:35 +010079#define MAY_EXEC 0x00000001
80#define MAY_WRITE 0x00000002
81#define MAY_READ 0x00000004
82#define MAY_APPEND 0x00000008
83#define MAY_ACCESS 0x00000010
84#define MAY_OPEN 0x00000020
85#define MAY_CHDIR 0x00000040
86/* called from RCU mode, don't block */
87#define MAY_NOT_BLOCK 0x00000080
88
89/*
90 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
91 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
92 */
93
94/* file is open for reading */
95#define FMODE_READ ((__force fmode_t)0x1)
96/* file is open for writing */
97#define FMODE_WRITE ((__force fmode_t)0x2)
98/* file is seekable */
99#define FMODE_LSEEK ((__force fmode_t)0x4)
100/* file can be accessed using pread */
101#define FMODE_PREAD ((__force fmode_t)0x8)
102/* file can be accessed using pwrite */
103#define FMODE_PWRITE ((__force fmode_t)0x10)
104/* File is opened for execution with sys_execve / sys_uselib */
105#define FMODE_EXEC ((__force fmode_t)0x20)
106/* File is opened with O_NDELAY (only set for block devices) */
107#define FMODE_NDELAY ((__force fmode_t)0x40)
108/* File is opened with O_EXCL (only set for block devices) */
109#define FMODE_EXCL ((__force fmode_t)0x80)
110/* File is opened using open(.., 3, ..) and is writeable only for ioctls
111 (specialy hack for floppy.c) */
112#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
113/* 32bit hashes as llseek() offset (for directories) */
114#define FMODE_32BITHASH ((__force fmode_t)0x200)
115/* 64bit hashes as llseek() offset (for directories) */
116#define FMODE_64BITHASH ((__force fmode_t)0x400)
117
118/*
119 * Don't update ctime and mtime.
120 *
121 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
122 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
123 */
124#define FMODE_NOCMTIME ((__force fmode_t)0x800)
125
126/* Expect random access pattern */
127#define FMODE_RANDOM ((__force fmode_t)0x1000)
128
129/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
130#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
131
132/* File is opened with O_PATH; almost nothing can be done with it */
133#define FMODE_PATH ((__force fmode_t)0x4000)
134
Linus Torvalds9c225f22014-03-03 09:36:58 -0800135/* File needs atomic accesses to f_pos */
136#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400137/* Write access to underlying fs */
138#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500139/* Has read method(s) */
140#define FMODE_CAN_READ ((__force fmode_t)0x20000)
141/* Has write method(s) */
142#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800143
David Howellsbbc10962012-10-15 16:40:35 +0100144/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800145#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100146
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500147/* File is capable of returning -EAGAIN if AIO will block */
148#define FMODE_AIO_NOWAIT ((__force fmode_t)0x8000000)
149
David Howellsbbc10962012-10-15 16:40:35 +0100150/*
151 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
152 * that indicates that they should check the contents of the iovec are
153 * valid, but not check the memory that the iovec elements
154 * points too.
155 */
156#define CHECK_IOVEC_ONLY -1
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158/*
159 * Attribute flags. These should be or-ed together to figure out what
160 * has been changed!
161 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200162#define ATTR_MODE (1 << 0)
163#define ATTR_UID (1 << 1)
164#define ATTR_GID (1 << 2)
165#define ATTR_SIZE (1 << 3)
166#define ATTR_ATIME (1 << 4)
167#define ATTR_MTIME (1 << 5)
168#define ATTR_CTIME (1 << 6)
169#define ATTR_ATIME_SET (1 << 7)
170#define ATTR_MTIME_SET (1 << 8)
171#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
172#define ATTR_ATTR_FLAG (1 << 10)
173#define ATTR_KILL_SUID (1 << 11)
174#define ATTR_KILL_SGID (1 << 12)
175#define ATTR_FILE (1 << 13)
176#define ATTR_KILL_PRIV (1 << 14)
177#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
178#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200179#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200182 * Whiteout is represented by a char device. The following constants define the
183 * mode and device number to use.
184 */
185#define WHITEOUT_MODE 0
186#define WHITEOUT_DEV 0
187
188/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 * This is the Inode Attributes structure, used for notify_change(). It
190 * uses the above definitions as flags, to know which values have changed.
191 * Also, in this manner, a Filesystem can look at only the values it cares
192 * about. Basically, these are the attributes that the VFS layer can
193 * request to change from the FS layer.
194 *
195 * Derek Atkins <warlord@MIT.EDU> 94-10-20
196 */
197struct iattr {
198 unsigned int ia_valid;
199 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800200 kuid_t ia_uid;
201 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 loff_t ia_size;
203 struct timespec ia_atime;
204 struct timespec ia_mtime;
205 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800206
207 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300208 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800209 * implement an ftruncate() like method. NOTE: filesystem should
210 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
211 */
212 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214
215/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 * Includes for diskquotas.
217 */
218#include <linux/quota.h>
219
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200220/*
221 * Maximum number of layers of fs stack. Needs to be limited to
222 * prevent kernel stack overflow
223 */
224#define FILESYSTEM_MAX_STACK_DEPTH 2
225
Zach Brown994fc28c2005-12-15 14:28:17 -0800226/**
227 * enum positive_aop_returns - aop return codes with specific semantics
228 *
229 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
230 * completed, that the page is still locked, and
231 * should be considered active. The VM uses this hint
232 * to return the page to the active list -- it won't
233 * be a candidate for writeback again in the near
234 * future. Other callers must be careful to unlock
235 * the page if they get this return. Returned by
236 * writepage();
237 *
238 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
239 * unlocked it and the page might have been truncated.
240 * The caller should back up to acquiring a new page and
241 * trying again. The aop will be taking reasonable
242 * precautions not to livelock. If the caller held a page
243 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700244 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800245 *
246 * address_space_operation functions return these large constants to indicate
247 * special semantics to the caller. These are much larger than the bytes in a
248 * page to allow for functions that return the number of bytes operated on in a
249 * given page.
250 */
251
252enum positive_aop_returns {
253 AOP_WRITEPAGE_ACTIVATE = 0x80000,
254 AOP_TRUNCATED_PAGE = 0x80001,
255};
256
Tetsuo Handac718a972017-05-08 15:58:59 -0700257#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
258#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800259 * helper code (eg buffer layer)
260 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262/*
263 * oh the beauties of C type declarations.
264 */
265struct page;
266struct address_space;
267struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Jens Axboec75b1d92017-06-27 11:47:04 -0600269/*
270 * Write life time hint values.
271 */
272enum rw_hint {
273 WRITE_LIFE_NOT_SET = 0,
274 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
275 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
276 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
277 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
278 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
279};
280
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800281#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400282#define IOCB_APPEND (1 << 1)
283#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100284#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700285#define IOCB_DSYNC (1 << 4)
286#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500287#define IOCB_WRITE (1 << 6)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500288#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800289
290struct kiocb {
291 struct file *ki_filp;
292 loff_t ki_pos;
293 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
294 void *private;
295 int ki_flags;
Jens Axboec75b1d92017-06-27 11:47:04 -0600296 enum rw_hint ki_hint;
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800297};
298
299static inline bool is_sync_kiocb(struct kiocb *kiocb)
300{
301 return kiocb->ki_complete == NULL;
302}
303
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700304/*
305 * "descriptor" for what we're up to with a read.
306 * This allows us to use the same read code yet
307 * have multiple different users of the data that
308 * we read from a file.
309 *
310 * The simplest case just copies the data to user
311 * mode.
312 */
313typedef struct {
314 size_t written;
315 size_t count;
316 union {
317 char __user *buf;
318 void *data;
319 } arg;
320 int error;
321} read_descriptor_t;
322
323typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
324 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700325
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326struct address_space_operations {
327 int (*writepage)(struct page *page, struct writeback_control *wbc);
328 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330 /* Write back some dirty pages from this mapping. */
331 int (*writepages)(struct address_space *, struct writeback_control *);
332
Andrew Morton4741c9f2006-03-24 03:18:11 -0800333 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 int (*set_page_dirty)(struct page *page);
335
336 int (*readpages)(struct file *filp, struct address_space *mapping,
337 struct list_head *pages, unsigned nr_pages);
338
Nick Pigginafddba42007-10-16 01:25:01 -0700339 int (*write_begin)(struct file *, struct address_space *mapping,
340 loff_t pos, unsigned len, unsigned flags,
341 struct page **pagep, void **fsdata);
342 int (*write_end)(struct file *, struct address_space *mapping,
343 loff_t pos, unsigned len, unsigned copied,
344 struct page *page, void *fsdata);
345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
347 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400348 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400349 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500350 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700351 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4a2012-01-12 17:19:34 -0800352 /*
Tang Chenef277c72013-07-08 16:00:21 -0700353 * migrate the contents of a page to the specified target. If
354 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4a2012-01-12 17:19:34 -0800355 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700356 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800357 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700358 bool (*isolate_page)(struct page *, isolate_mode_t);
359 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800360 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500361 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700362 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700363 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200364 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700365
366 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700367 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
368 sector_t *span);
369 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370};
371
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200372extern const struct address_space_operations empty_aops;
373
Nick Pigginafddba42007-10-16 01:25:01 -0700374/*
375 * pagecache_write_begin/pagecache_write_end must be used by general code
376 * to write into the pagecache.
377 */
378int pagecache_write_begin(struct file *, struct address_space *mapping,
379 loff_t pos, unsigned len, unsigned flags,
380 struct page **pagep, void **fsdata);
381
382int pagecache_write_end(struct file *, struct address_space *mapping,
383 loff_t pos, unsigned len, unsigned copied,
384 struct page *page, void *fsdata);
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386struct address_space {
387 struct inode *host; /* owner: inode, block_device */
388 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700389 spinlock_t tree_lock; /* and lock protecting it */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700390 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700391 struct rb_root i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800392 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Jan Kara08142572011-06-27 16:18:10 -0700393 /* Protected by tree_lock together with the radix tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800395 /* number of shadow or DAX exceptional entries */
396 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700398 const struct address_space_operations *a_ops; /* methods */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700399 unsigned long flags; /* error bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 spinlock_t private_lock; /* for use by the address_space */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700401 gfp_t gfp_mask; /* implicit gfp mask for allocations */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 struct list_head private_list; /* ditto */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800403 void *private_data; /* ditto */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404} __attribute__((aligned(sizeof(long))));
405 /*
406 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300407 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
409 */
Andi Kleen87192a22012-01-12 17:20:34 -0800410struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412struct block_device {
413 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700414 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500416 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800417 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900418 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 void * bd_holder;
420 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100421 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800422#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100423 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800424#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 struct block_device * bd_contains;
426 unsigned bd_block_size;
427 struct hd_struct * bd_part;
428 /* number of times partitions within this device have been opened. */
429 unsigned bd_part_count;
430 int bd_invalidated;
431 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800432 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100433 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 /*
436 * Private data. You must have bd_claim'ed the block_device
437 * to use this. NOTE: bd_claim allows an owner to claim
438 * the same device multiple times, the owner must take special
439 * care to not mess up bd_private for that case.
440 */
441 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800442
443 /* The counter of freeze processes */
444 int bd_fsfreeze_count;
445 /* Mutex for freeze */
446 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447};
448
449/*
450 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
451 * radix trees
452 */
453#define PAGECACHE_TAG_DIRTY 0
454#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700455#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457int mapping_tagged(struct address_space *mapping, int tag);
458
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800459static inline void i_mmap_lock_write(struct address_space *mapping)
460{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800461 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800462}
463
464static inline void i_mmap_unlock_write(struct address_space *mapping)
465{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800466 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800467}
468
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800469static inline void i_mmap_lock_read(struct address_space *mapping)
470{
471 down_read(&mapping->i_mmap_rwsem);
472}
473
474static inline void i_mmap_unlock_read(struct address_space *mapping)
475{
476 up_read(&mapping->i_mmap_rwsem);
477}
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479/*
480 * Might pages of this file be mapped into userspace?
481 */
482static inline int mapping_mapped(struct address_space *mapping)
483{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800484 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485}
486
487/*
488 * Might pages of this file have been modified in userspace?
489 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
490 * marks vma as VM_SHARED if it is shared, and the file was opened for
491 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700492 *
493 * If i_mmap_writable is negative, no new writable mappings are allowed. You
494 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 */
496static inline int mapping_writably_mapped(struct address_space *mapping)
497{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700498 return atomic_read(&mapping->i_mmap_writable) > 0;
499}
500
501static inline int mapping_map_writable(struct address_space *mapping)
502{
503 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
504 0 : -EPERM;
505}
506
507static inline void mapping_unmap_writable(struct address_space *mapping)
508{
509 atomic_dec(&mapping->i_mmap_writable);
510}
511
512static inline int mapping_deny_writable(struct address_space *mapping)
513{
514 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
515 0 : -EBUSY;
516}
517
518static inline void mapping_allow_writable(struct address_space *mapping)
519{
520 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521}
522
523/*
524 * Use sequence counter to get consistent i_size on 32-bit processors.
525 */
526#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
527#include <linux/seqlock.h>
528#define __NEED_I_SIZE_ORDERED
529#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
530#else
531#define i_size_ordered_init(inode) do { } while (0)
532#endif
533
Al Virof19d4a82009-06-08 19:50:45 -0400534struct posix_acl;
535#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200536#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400537
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100538static inline struct posix_acl *
539uncached_acl_sentinel(struct task_struct *task)
540{
541 return (void *)task + 1;
542}
543
544static inline bool
545is_uncached_acl(struct posix_acl *acl)
546{
547 return (long)acl & 1;
548}
549
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700550#define IOP_FASTPERM 0x0001
551#define IOP_LOOKUP 0x0002
552#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200553#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100554#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700555
Jan Kara9dd813c2017-03-14 12:31:02 +0100556struct fsnotify_mark_connector;
557
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700558/*
559 * Keep mostly read-only and often accessed (especially for
560 * the RCU path lookup and 'stat' data) fields at the beginning
561 * of the 'struct inode'
562 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100564 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700565 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800566 kuid_t i_uid;
567 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700568 unsigned int i_flags;
569
570#ifdef CONFIG_FS_POSIX_ACL
571 struct posix_acl *i_acl;
572 struct posix_acl *i_default_acl;
573#endif
574
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100575 const struct inode_operations *i_op;
576 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700577 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100578
Linus Torvalds13e12d12011-06-08 15:18:19 -0700579#ifdef CONFIG_SECURITY
580 void *i_security;
581#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100582
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700583 /* Stat data, not accessed from path walking */
584 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200585 /*
586 * Filesystems may only read i_nlink directly. They shall use the
587 * following functions for modification:
588 *
589 * (set|clear|inc|drop)_nlink
590 * inode_(inc|dec)_link_count
591 */
592 union {
593 const unsigned int i_nlink;
594 unsigned int __i_nlink;
595 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700596 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700597 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700598 struct timespec i_atime;
599 struct timespec i_mtime;
600 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400601 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
602 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700603 unsigned int i_blkbits;
Jens Axboec75b1d92017-06-27 11:47:04 -0600604 enum rw_hint i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700605 blkcnt_t i_blocks;
606
607#ifdef __NEED_I_SIZE_ORDERED
608 seqcount_t i_size_seqcount;
609#endif
610
611 /* Misc */
612 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400613 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700614
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100615 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400616 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500619 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400620#ifdef CONFIG_CGROUP_WRITEBACK
621 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400622
623 /* foreign inode detection, see wbc_detach_inode() */
624 int i_wb_frn_winner;
625 u16 i_wb_frn_avg_time;
626 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400627#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100628 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700630 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100631 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400632 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100633 struct rcu_head i_rcu;
634 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500635 u64 i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700636 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400637 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400638 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500639#ifdef CONFIG_IMA
640 atomic_t i_readcount; /* struct files open RO */
641#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800642 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500643 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700646 union {
647 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700648 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700649 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400650 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400651 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700652 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 __u32 i_generation;
655
Eric Paris3be25f42009-05-21 17:01:26 -0400656#ifdef CONFIG_FSNOTIFY
657 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100658 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400659#endif
660
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700661#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
662 struct fscrypt_info *i_crypt_info;
663#endif
664
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700665 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666};
667
Fabian Frederick93407472017-02-27 14:28:32 -0800668static inline unsigned int i_blocksize(const struct inode *node)
669{
670 return (1 << node->i_blkbits);
671}
672
Al Viro1d3382cb2010-10-23 15:19:20 -0400673static inline int inode_unhashed(struct inode *inode)
674{
675 return hlist_unhashed(&inode->i_hash);
676}
677
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700679 * inode->i_mutex nesting subclasses for the lock validator:
680 *
681 * 0: the object of the current VFS operation
682 * 1: parent
683 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400684 * 3: xattr
685 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100686 * 5: second parent (when locking independent directories in rename)
687 *
688 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400689 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700690 *
691 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100692 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700693 */
694enum inode_i_mutex_lock_class
695{
696 I_MUTEX_NORMAL,
697 I_MUTEX_PARENT,
698 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700699 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100700 I_MUTEX_NONDIR2,
701 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700702};
703
Al Viro59551022016-01-22 15:40:57 -0500704static inline void inode_lock(struct inode *inode)
705{
Al Viro9902af72016-04-15 15:08:36 -0400706 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500707}
708
709static inline void inode_unlock(struct inode *inode)
710{
Al Viro9902af72016-04-15 15:08:36 -0400711 up_write(&inode->i_rwsem);
712}
713
714static inline void inode_lock_shared(struct inode *inode)
715{
716 down_read(&inode->i_rwsem);
717}
718
719static inline void inode_unlock_shared(struct inode *inode)
720{
721 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500722}
723
724static inline int inode_trylock(struct inode *inode)
725{
Al Viro9902af72016-04-15 15:08:36 -0400726 return down_write_trylock(&inode->i_rwsem);
727}
728
729static inline int inode_trylock_shared(struct inode *inode)
730{
731 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500732}
733
734static inline int inode_is_locked(struct inode *inode)
735{
Al Viro9902af72016-04-15 15:08:36 -0400736 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500737}
738
739static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
740{
Al Viro9902af72016-04-15 15:08:36 -0400741 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500742}
743
J. Bruce Fields375e2892012-04-18 15:16:33 -0400744void lock_two_nondirectories(struct inode *, struct inode*);
745void unlock_two_nondirectories(struct inode *, struct inode*);
746
Ingo Molnarf2eace22006-07-03 00:25:05 -0700747/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 * NOTE: in a 32bit arch with a preemptable kernel and
749 * an UP compile the i_size_read/write must be atomic
750 * with respect to the local cpu (unlike with preempt disabled),
751 * but they don't need to be atomic with respect to other cpus like in
752 * true SMP (so they need either to either locally disable irq around
753 * the read or for example on x86 they can be still implemented as a
754 * cmpxchg8b without the need of the lock prefix). For SMP compiles
755 * and 64bit archs it makes no difference if preempt is enabled or not.
756 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800757static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
759#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
760 loff_t i_size;
761 unsigned int seq;
762
763 do {
764 seq = read_seqcount_begin(&inode->i_size_seqcount);
765 i_size = inode->i_size;
766 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
767 return i_size;
768#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
769 loff_t i_size;
770
771 preempt_disable();
772 i_size = inode->i_size;
773 preempt_enable();
774 return i_size;
775#else
776 return inode->i_size;
777#endif
778}
779
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700780/*
781 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
782 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
783 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
784 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785static inline void i_size_write(struct inode *inode, loff_t i_size)
786{
787#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700788 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 write_seqcount_begin(&inode->i_size_seqcount);
790 inode->i_size = i_size;
791 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700792 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
794 preempt_disable();
795 inode->i_size = i_size;
796 preempt_enable();
797#else
798 inode->i_size = i_size;
799#endif
800}
801
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800802static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803{
804 return MINOR(inode->i_rdev);
805}
806
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800807static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808{
809 return MAJOR(inode->i_rdev);
810}
811
812extern struct block_device *I_BDEV(struct inode *inode);
813
814struct fown_struct {
815 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700816 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
817 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800818 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 int signum; /* posix.1b rt signal to be delivered on IO */
820};
821
822/*
823 * Track a single file's readahead state
824 */
825struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700826 pgoff_t start; /* where readahead started */
827 unsigned int size; /* # of readahead pages */
828 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700829 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700830
Fengguang Wu937085a2007-10-16 01:24:31 -0700831 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700832 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700833 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Fengguang Wu5ce11102007-07-19 01:47:59 -0700836/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700837 * Check if @index falls in the readahead windows.
838 */
839static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
840{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700841 return (index >= ra->start &&
842 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700843}
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800846 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700847 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800848 struct rcu_head fu_rcuhead;
849 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800850 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500851 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800852 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700853
854 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800855 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700856 * Must not be taken from IRQ context.
857 */
858 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600859 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400860 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400862 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800863 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 loff_t f_pos;
865 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100866 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 struct file_ra_state f_ra;
868
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700869 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700870#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700872#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 /* needed for tty driver, and maybe others */
874 void *private_data;
875
876#ifdef CONFIG_EPOLL
877 /* Used by fs/eventpoll.c to link all the hooks to this file */
878 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800879 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880#endif /* #ifdef CONFIG_EPOLL */
881 struct address_space *f_mapping;
Al Virobd2a31d2014-03-04 14:54:22 -0500882} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530884struct file_handle {
885 __u32 handle_bytes;
886 int handle_type;
887 /* file identifier */
888 unsigned char f_handle[0];
889};
890
Al Virocb0942b2012-08-27 14:48:26 -0400891static inline struct file *get_file(struct file *f)
892{
893 atomic_long_inc(&f->f_count);
894 return f;
895}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700896#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400897#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400898#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
900#define MAX_NON_LFS ((1UL<<31) - 1)
901
902/* Page cache limit. The filesystems should put that into their s_maxbytes
903 limits, otherwise bad things can happen in VM. */
904#if BITS_PER_LONG==32
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300905#define MAX_LFS_FILESIZE (((loff_t)PAGE_SIZE << (BITS_PER_LONG-1))-1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906#elif BITS_PER_LONG==64
Al Viro614c3212012-10-10 01:06:20 -0400907#define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908#endif
909
910#define FL_POSIX 1
911#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400912#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400914#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700916#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400918#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
919#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400920#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100921#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Benjamin Coddington50f21122017-04-11 12:50:09 -0400923#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700926 * Special return value from posix_lock_file() and vfs_lock_file() for
927 * asynchronous locking.
928 */
929#define FILE_LOCK_DEFERRED 1
930
Jeff Layton7ca76312014-09-01 19:04:48 -0400931/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200932typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Jeff Laytona7231a92015-01-16 15:05:56 -0500934struct file_lock;
935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
938 void (*fl_release_private)(struct file_lock *);
939};
940
941struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400942 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400943 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400944 fl_owner_t (*lm_get_owner)(fl_owner_t);
945 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400946 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400947 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400948 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500949 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400950 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951};
952
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400953struct lock_manager {
954 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400955 /*
956 * NFSv4 and up also want opens blocked during the grace period;
957 * NLM doesn't care:
958 */
959 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400960};
961
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400962struct net;
963void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400964void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400965int locks_in_grace(struct net *);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400966int opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400967
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968/* that will die - we need it for nfs_lock_info */
969#include <linux/nfs_fs_i.h>
970
Jeff Layton1cb36012013-06-21 08:58:12 -0400971/*
972 * struct file_lock represents a generic "file lock". It's used to represent
973 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
974 * note that the same struct is used to represent both a request for a lock and
975 * the lock itself, but the same object is never used for both.
976 *
977 * FIXME: should we create a separate "struct lock_request" to help distinguish
978 * these two uses?
979 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500980 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -0400981 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500982 * 1) lock owner
983 * 2) lock range start
984 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -0400985 *
986 * Obviously, the last two criteria only matter for POSIX locks.
987 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988struct file_lock {
989 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -0500990 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -0400991 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 struct list_head fl_block; /* circular list of blocked processes */
993 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -0400994 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -0700995 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -0400997 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000998 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 wait_queue_head_t fl_wait;
1000 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 loff_t fl_start;
1002 loff_t fl_end;
1003
1004 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001005 /* for lease breaks: */
1006 unsigned long fl_break_time;
1007 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001009 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001010 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 union {
1012 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001013 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001014 struct {
1015 struct list_head link; /* link in AFS vnode's pending_locks list */
1016 int state; /* state of grant or error if -ve */
1017 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 } fl_u;
1019};
1020
Jeff Layton4a075e32015-01-16 15:05:54 -05001021struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001022 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001023 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001024 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001025 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001026};
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028/* The following constant reflects the upper bound of the file/locking space */
1029#ifndef OFFSET_MAX
1030#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1031#define OFFSET_MAX INT_LIMIT(loff_t)
1032#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1033#endif
1034
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001035extern void send_sigio(struct fown_struct *fown, int fd, int band);
1036
Miklos Szeredic568d682016-09-16 12:44:20 +02001037/*
1038 * Return the inode to use for locking
1039 *
1040 * For overlayfs this should be the overlay inode, not the real inode returned
1041 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1042 * equal.
1043 */
1044static inline struct inode *locks_inode(const struct file *f)
1045{
1046 return f->f_path.dentry->d_inode;
1047}
1048
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001049#ifdef CONFIG_FILE_LOCKING
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001050extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001051extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1052 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053
1054#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001055extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001056extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1057 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058#endif
1059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1061extern int fcntl_getlease(struct file *filp);
1062
1063/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001064void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001065void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001067extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001069extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001071extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001072extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001073extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001074extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001075extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001076extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001077extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001078extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001079extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001080extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001082extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1083extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001084extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001085struct files_struct;
1086extern void show_fd_locks(struct seq_file *f,
1087 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001088#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001089static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1090 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001091{
1092 return -EINVAL;
1093}
1094
1095static inline int fcntl_setlk(unsigned int fd, struct file *file,
1096 unsigned int cmd, struct flock __user *user)
1097{
1098 return -EACCES;
1099}
1100
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001101#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001102static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1103 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001104{
1105 return -EINVAL;
1106}
1107
1108static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1109 unsigned int cmd, struct flock64 __user *user)
1110{
1111 return -EACCES;
1112}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001113#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001114static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1115{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001116 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001117}
1118
1119static inline int fcntl_getlease(struct file *filp)
1120{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001121 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001122}
1123
Jeff Layton4a075e32015-01-16 15:05:54 -05001124static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001125locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001126{
1127}
1128
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001129static inline void locks_init_lock(struct file_lock *fl)
1130{
1131 return;
1132}
1133
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001134static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001135{
1136 return;
1137}
1138
1139static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1140{
1141 return;
1142}
1143
1144static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1145{
1146 return;
1147}
1148
Jeff Layton78ed8a12014-02-03 12:13:08 -05001149static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001150{
1151 return;
1152}
1153
1154static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1155{
1156 return;
1157}
1158
1159static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1160 struct file_lock *conflock)
1161{
1162 return -ENOLCK;
1163}
1164
Jeff Laytonf891a292013-06-21 08:58:09 -04001165static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001166{
1167 return -ENOENT;
1168}
1169
1170static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1171{
1172 return 0;
1173}
1174
1175static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1176 struct file_lock *fl, struct file_lock *conf)
1177{
1178 return -ENOLCK;
1179}
1180
1181static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1182{
1183 return 0;
1184}
1185
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001186static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1187{
1188 return -ENOLCK;
1189}
1190
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001191static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001192{
1193 return 0;
1194}
1195
1196static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1197{
1198 return;
1199}
1200
1201static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001202 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001203{
1204 return -EINVAL;
1205}
1206
1207static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001208 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001209{
1210 return -EINVAL;
1211}
1212
Jeff Layton7448cc32015-01-16 15:05:57 -05001213static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001214 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001215{
1216 return -EINVAL;
1217}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001218
1219struct files_struct;
1220static inline void show_fd_locks(struct seq_file *f,
1221 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001222#endif /* !CONFIG_FILE_LOCKING */
1223
Jeff Laytonee296d72015-07-11 06:43:03 -04001224static inline struct inode *file_inode(const struct file *f)
1225{
1226 return f->f_inode;
1227}
1228
Miklos Szeredid101a122016-03-26 16:14:37 -04001229static inline struct dentry *file_dentry(const struct file *file)
1230{
Miklos Szeredi2d902672016-06-30 08:53:27 +02001231 return d_real(file->f_path.dentry, file_inode(file), 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001232}
1233
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001234static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1235{
Miklos Szeredic568d682016-09-16 12:44:20 +02001236 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001237}
1238
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001240 spinlock_t fa_lock;
1241 int magic;
1242 int fa_fd;
1243 struct fasync_struct *fa_next; /* singly linked list */
1244 struct file *fa_file;
1245 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246};
1247
1248#define FASYNC_MAGIC 0x4601
1249
1250/* SMP safe fasync helpers: */
1251extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001252extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1253extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1254extern struct fasync_struct *fasync_alloc(void);
1255extern void fasync_free(struct fasync_struct *);
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257/* can be called from interrupts */
1258extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001260extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1261extern void f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001263extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264extern int send_sigurg(struct fown_struct *fown);
1265
Jan Kara5accdf82012-06-12 16:20:34 +02001266struct mm_struct;
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268/*
1269 * Umount options
1270 */
1271
1272#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1273#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1274#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001275#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1276#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Tejun Heo46b15ca2015-06-16 18:48:31 -04001278/* sb->s_iflags */
1279#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001280#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001281#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Eric W. Biederman8654df42016-06-09 16:06:06 -05001283/* sb->s_iflags to limit user namespace mounts */
1284#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285
Jan Kara5accdf82012-06-12 16:20:34 +02001286/* Possible states of 'frozen' field */
1287enum {
1288 SB_UNFROZEN = 0, /* FS is unfrozen */
1289 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001290 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1291 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1292 * internal threads if needed) */
1293 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1294};
1295
1296#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1297
1298struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001299 int frozen; /* Is sb frozen? */
1300 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1301 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001302};
1303
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304struct super_block {
1305 struct list_head s_list; /* Keep this first */
1306 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001307 unsigned char s_blocksize_bits;
1308 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001309 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001311 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001312 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001313 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001314 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001316 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 unsigned long s_magic;
1318 struct dentry *s_root;
1319 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001322#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001324#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001325 const struct xattr_handler **s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001327 const struct fscrypt_operations *s_cop;
1328
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001329 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001330 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001332 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001333 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001334 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001335 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 struct quota_info s_dquot; /* Diskquota specific options */
1337
Jan Kara5accdf82012-06-12 16:20:34 +02001338 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Christoph Hellwig85787092017-05-10 15:06:33 +02001340 char s_id[32]; /* Informational name */
1341 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
1343 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001344 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001345 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001347 /* Granularity of c/m/atime in ns.
1348 Cannot be worse than a second */
1349 u32 s_time_gran;
1350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 /*
1352 * The next field is for VFS *only*. No filesystems have any business
1353 * even looking at it. You had been warned.
1354 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001355 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001357 /*
1358 * Filesystem subtype. If non-empty the filesystem type field
1359 * in /proc/mounts will be "type.subtype"
1360 */
1361 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001362
1363 /*
1364 * Saved mount options for lazy filesystems using
1365 * generic_show_options()
1366 */
Arnd Bergmann4d2deb42010-02-24 20:01:56 +01001367 char __rcu *s_options;
Al Viroc8aebb02010-12-18 10:22:30 -05001368 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001369
1370 /*
1371 * Saved pool identifier for cleancache (-1 means none)
1372 */
1373 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001374
1375 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001376
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001377 /* Number of inodes with nlink == 0 but still referenced */
1378 atomic_long_t s_remove_count;
1379
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001380 /* Being remounted read-only */
1381 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001382
1383 /* AIO completions deferred from interrupt context */
1384 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001385 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001386
1387 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001388 * Owning user namespace and default context in which to
1389 * interpret filesystem uids, gids, quotas, device nodes,
1390 * xattrs and security labels.
1391 */
1392 struct user_namespace *s_user_ns;
1393
1394 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001395 * Keep the lru lists last in the structure so they always sit on their
1396 * own individual cachelines.
1397 */
1398 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1399 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001400 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001401 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001402
Dave Chinnere97fedb2015-03-04 13:40:00 -05001403 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001404
1405 /*
1406 * Indicates how deep in a filesystem stack this SB is
1407 */
1408 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001409
1410 /* s_inode_list_lock protects s_inodes */
1411 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1412 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001413
1414 spinlock_t s_inode_wblist_lock;
1415 struct list_head s_inodes_wb; /* writeback inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416};
1417
Seth Forshee81754352014-12-11 10:15:45 -06001418/* Helper functions so that in most cases filesystems will
1419 * not need to deal directly with kuid_t and kgid_t and can
1420 * instead deal with the raw numeric values that are stored
1421 * in the filesystem.
1422 */
1423static inline uid_t i_uid_read(const struct inode *inode)
1424{
1425 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1426}
1427
1428static inline gid_t i_gid_read(const struct inode *inode)
1429{
1430 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1431}
1432
1433static inline void i_uid_write(struct inode *inode, uid_t uid)
1434{
1435 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1436}
1437
1438static inline void i_gid_write(struct inode *inode, gid_t gid)
1439{
1440 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1441}
1442
Deepa Dinamani3cd88662016-09-14 07:48:02 -07001443extern struct timespec current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
1445/*
1446 * Snapshotting support.
1447 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
Jan Kara5accdf82012-06-12 16:20:34 +02001449void __sb_end_write(struct super_block *sb, int level);
1450int __sb_start_write(struct super_block *sb, int level, bool wait);
1451
Oleg Nesterovbee91822015-07-19 23:48:20 +02001452#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001453 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001454#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001455 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001456
Jan Kara5accdf82012-06-12 16:20:34 +02001457/**
1458 * sb_end_write - drop write access to a superblock
1459 * @sb: the super we wrote to
1460 *
1461 * Decrement number of writers to the filesystem. Wake up possible waiters
1462 * wanting to freeze the filesystem.
1463 */
1464static inline void sb_end_write(struct super_block *sb)
1465{
1466 __sb_end_write(sb, SB_FREEZE_WRITE);
1467}
1468
1469/**
1470 * sb_end_pagefault - drop write access to a superblock from a page fault
1471 * @sb: the super we wrote to
1472 *
1473 * Decrement number of processes handling write page fault to the filesystem.
1474 * Wake up possible waiters wanting to freeze the filesystem.
1475 */
1476static inline void sb_end_pagefault(struct super_block *sb)
1477{
1478 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1479}
1480
1481/**
1482 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1483 * @sb: the super we wrote to
1484 *
1485 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1486 * waiters wanting to freeze the filesystem.
1487 */
1488static inline void sb_end_intwrite(struct super_block *sb)
1489{
1490 __sb_end_write(sb, SB_FREEZE_FS);
1491}
1492
1493/**
1494 * sb_start_write - get write access to a superblock
1495 * @sb: the super we write to
1496 *
1497 * When a process wants to write data or metadata to a file system (i.e. dirty
1498 * a page or an inode), it should embed the operation in a sb_start_write() -
1499 * sb_end_write() pair to get exclusion against file system freezing. This
1500 * function increments number of writers preventing freezing. If the file
1501 * system is already frozen, the function waits until the file system is
1502 * thawed.
1503 *
1504 * Since freeze protection behaves as a lock, users have to preserve
1505 * ordering of freeze protection and other filesystem locks. Generally,
1506 * freeze protection should be the outermost lock. In particular, we have:
1507 *
1508 * sb_start_write
1509 * -> i_mutex (write path, truncate, directory ops, ...)
1510 * -> s_umount (freeze_super, thaw_super)
1511 */
1512static inline void sb_start_write(struct super_block *sb)
1513{
1514 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1515}
1516
1517static inline int sb_start_write_trylock(struct super_block *sb)
1518{
1519 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1520}
1521
1522/**
1523 * sb_start_pagefault - get write access to a superblock from a page fault
1524 * @sb: the super we write to
1525 *
1526 * When a process starts handling write page fault, it should embed the
1527 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1528 * exclusion against file system freezing. This is needed since the page fault
1529 * is going to dirty a page. This function increments number of running page
1530 * faults preventing freezing. If the file system is already frozen, the
1531 * function waits until the file system is thawed.
1532 *
1533 * Since page fault freeze protection behaves as a lock, users have to preserve
1534 * ordering of freeze protection and other filesystem locks. It is advised to
1535 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1536 * handling code implies lock dependency:
1537 *
1538 * mmap_sem
1539 * -> sb_start_pagefault
1540 */
1541static inline void sb_start_pagefault(struct super_block *sb)
1542{
1543 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1544}
1545
1546/*
1547 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1548 * @sb: the super we write to
1549 *
1550 * This is the third level of protection against filesystem freezing. It is
1551 * free for use by a filesystem. The only requirement is that it must rank
1552 * below sb_start_pagefault.
1553 *
1554 * For example filesystem can call sb_start_intwrite() when starting a
1555 * transaction which somewhat eases handling of freezing for internal sources
1556 * of filesystem changes (internal fs threads, discarding preallocation on file
1557 * close, etc.).
1558 */
1559static inline void sb_start_intwrite(struct super_block *sb)
1560{
1561 __sb_start_write(sb, SB_FREEZE_FS, true);
1562}
1563
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001565extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301566
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567/*
1568 * VFS helper functions..
1569 */
Al Viro312b63f2012-06-10 18:09:36 -04001570extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001571extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001572extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001573extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001574extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001576extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001577extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001578extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579
Amir Goldsteinaf7bd4d2017-01-17 06:34:52 +02001580extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1581 int open_flag);
1582
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001584 * VFS file helper functions.
1585 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001586extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001587 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001588extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001589/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001590 * VFS FS_IOC_FIEMAP helper definitions.
1591 */
1592struct fiemap_extent_info {
1593 unsigned int fi_flags; /* Flags as passed from user */
1594 unsigned int fi_extents_mapped; /* Number of mapped extents */
1595 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001596 struct fiemap_extent __user *fi_extents_start; /* Start of
1597 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001598};
1599int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1600 u64 phys, u64 len, u32 flags);
1601int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1602
1603/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 * File types
1605 *
1606 * NOTE! These match bits 12..15 of stat.st_mode
1607 * (ie "(i_mode >> 12) & 15").
1608 */
1609#define DT_UNKNOWN 0
1610#define DT_FIFO 1
1611#define DT_CHR 2
1612#define DT_DIR 4
1613#define DT_BLK 6
1614#define DT_REG 8
1615#define DT_LNK 10
1616#define DT_SOCK 12
1617#define DT_WHT 14
1618
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619/*
1620 * This is the "filldir" function type, used by readdir() to let
1621 * the kernel specify what kind of dirent layout it wants to have.
1622 * This allows the kernel to read directories into kernel space or
1623 * to have different dirent layouts depending on the binary type.
1624 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001625struct dir_context;
1626typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1627 unsigned);
1628
Al Viro5c0ba4e2013-05-15 13:52:59 -04001629struct dir_context {
Al Viroac6614b2013-05-22 22:22:04 -04001630 const filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001631 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001632};
Al Virobb6f6192013-05-15 18:49:12 -04001633
Al Viro08f85852007-10-08 13:26:20 -04001634struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636/* These macros are for out of kernel modules to test that
1637 * the kernel supports the unlocked_ioctl and compat_ioctl
1638 * fields in struct file_operations. */
1639#define HAVE_COMPAT_IOCTL 1
1640#define HAVE_UNLOCKED_IOCTL 1
1641
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001642/*
1643 * These flags let !MMU mmap() govern direct device mapping vs immediate
1644 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1645 *
1646 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1647 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1648 * NOMMU_MAP_READ: Can be mapped for reading
1649 * NOMMU_MAP_WRITE: Can be mapped for writing
1650 * NOMMU_MAP_EXEC: Can be mapped for execution
1651 */
1652#define NOMMU_MAP_COPY 0x00000001
1653#define NOMMU_MAP_DIRECT 0x00000008
1654#define NOMMU_MAP_READ VM_MAYREAD
1655#define NOMMU_MAP_WRITE VM_MAYWRITE
1656#define NOMMU_MAP_EXEC VM_MAYEXEC
1657
1658#define NOMMU_VMFLAGS \
1659 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1660
1661
Al Viro293bc982014-02-11 18:37:41 -05001662struct iov_iter;
1663
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664struct file_operations {
1665 struct module *owner;
1666 loff_t (*llseek) (struct file *, loff_t, int);
1667 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001669 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1670 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001671 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001672 int (*iterate_shared) (struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1675 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1676 int (*mmap) (struct file *, struct vm_area_struct *);
1677 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001678 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001680 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 int (*fasync) (int, struct file *, int);
1682 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1684 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1685 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001687 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1688 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001689 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001690 long (*fallocate)(struct file *file, int mode, loff_t offset,
1691 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001692 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001693#ifndef CONFIG_MMU
1694 unsigned (*mmap_capabilities)(struct file *);
1695#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001696 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1697 loff_t, size_t, unsigned int);
1698 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1699 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001700 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1701 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702};
1703
1704struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001705 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001706 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb2011-06-20 19:28:19 -04001707 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001708 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001709
1710 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001711
Al Viroebfc3b42012-06-10 18:05:36 -04001712 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 int (*link) (struct dentry *,struct inode *,struct dentry *);
1714 int (*unlink) (struct inode *,struct dentry *);
1715 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001716 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001718 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001720 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 int (*setattr) (struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00001722 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001724 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1725 u64 len);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001726 int (*update_time)(struct inode *, struct timespec *, int);
Al Virod9585272012-06-22 12:39:14 +04001727 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001728 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001729 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001730 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001731 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001732} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733
Miklos Szeredibb7462b2017-02-20 16:51:23 +01001734static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1735 struct iov_iter *iter)
1736{
1737 return file->f_op->read_iter(kio, iter);
1738}
1739
1740static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1741 struct iov_iter *iter)
1742{
1743 return file->f_op->write_iter(kio, iter);
1744}
1745
Miklos Szeredif74ac012017-02-20 16:51:23 +01001746static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1747{
1748 return file->f_op->mmap(file, vma);
1749}
1750
Miklos Szeredi0eb8af42017-02-20 16:51:23 +01001751static inline int call_fsync(struct file *file, loff_t start, loff_t end,
1752 int datasync)
1753{
1754 return file->f_op->fsync(file, start, end, datasync);
1755}
1756
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001757ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001758 unsigned long nr_segs, unsigned long fast_segs,
1759 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001760 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001761
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001762extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001763extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1765extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1766extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001767 unsigned long, loff_t *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001769 unsigned long, loff_t *, int);
Zach Brown29732932015-11-10 16:53:30 -05001770extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1771 loff_t, size_t, unsigned int);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001772extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1773 struct inode *inode_out, loff_t pos_out,
1774 u64 *len, bool is_dedupe);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001775extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1776 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001777extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1778 struct inode *dest, loff_t destoff,
1779 loff_t len, bool *is_same);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001780extern int vfs_dedupe_file_range(struct file *file,
1781 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783struct super_operations {
1784 struct inode *(*alloc_inode)(struct super_block *sb);
1785 void (*destroy_inode)(struct inode *);
1786
Christoph Hellwigaa385722011-05-27 06:53:02 -04001787 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001788 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001789 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001790 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001793 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001794 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001795 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001796 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001797 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001799 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
Al Viro34c80b12011-12-08 21:32:45 -05001801 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001802 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001803 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001804 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001805#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1807 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001808 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001809#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001810 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001811 long (*nr_cached_objects)(struct super_block *,
1812 struct shrink_control *);
1813 long (*free_cached_objects)(struct super_block *,
1814 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815};
1816
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001817/*
David Howellsbbc10962012-10-15 16:40:35 +01001818 * Inode flags - they have no relation to superblock flags now
1819 */
1820#define S_SYNC 1 /* Writes are synced at once */
1821#define S_NOATIME 2 /* Do not update access times */
1822#define S_APPEND 4 /* Append-only file */
1823#define S_IMMUTABLE 8 /* Immutable file */
1824#define S_DEAD 16 /* removed, but still open directory */
1825#define S_NOQUOTA 32 /* Inode is not counted to quota */
1826#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1827#define S_NOCMTIME 128 /* Do not update file c/mtime */
1828#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1829#define S_PRIVATE 512 /* Inode is fs-internal */
1830#define S_IMA 1024 /* Inode has an associated IMA struct */
1831#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1832#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001833#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001834#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1835#else
1836#define S_DAX 0 /* Make all the DAX code disappear */
1837#endif
David Howellsbbc10962012-10-15 16:40:35 +01001838
1839/*
1840 * Note that nosuid etc flags are inode-specific: setting some file-system
1841 * flags just means all the inodes inherit those flags by default. It might be
1842 * possible to override it selectively if you really wanted to with some
1843 * ioctl() that is not currently implemented.
1844 *
1845 * Exception: MS_RDONLY is always applied to the entire file system.
1846 *
1847 * Unfortunately, it is possible to change a filesystems flags with it mounted
1848 * with files in use. This means that all of the inodes will not have their
1849 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1850 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1851 */
1852#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1853
1854#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1855#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1856 ((inode)->i_flags & S_SYNC))
1857#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1858 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1859#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1860#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1861#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1862
1863#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1864#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1865#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1866#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1867
1868#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1869#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1870#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1871#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1872#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1873#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1874#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001875#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
David Howellsbbc10962012-10-15 16:40:35 +01001876
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001877#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1878 (inode)->i_rdev == WHITEOUT_DEV)
1879
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001880static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1881{
1882 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1883}
1884
Jens Axboec75b1d92017-06-27 11:47:04 -06001885static inline enum rw_hint file_write_hint(struct file *file)
1886{
1887 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1888 return file->f_write_hint;
1889
1890 return file_inode(file)->i_write_hint;
1891}
1892
1893static inline int iocb_flags(struct file *file);
1894
1895static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1896{
1897 *kiocb = (struct kiocb) {
1898 .ki_filp = filp,
1899 .ki_flags = iocb_flags(filp),
1900 .ki_hint = file_write_hint(filp),
1901 };
1902}
1903
David Howellsbbc10962012-10-15 16:40:35 +01001904/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001905 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001906 *
1907 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1908 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1909 *
1910 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1911 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1912 * various stages of removing an inode.
1913 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001914 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001915 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001916 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1917 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001918 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1919 * these changes separately from I_DIRTY_SYNC so that we
1920 * don't have to write inode on fdatasync() when only
1921 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001922 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001923 * I_NEW Serves as both a mutex and completion notification.
1924 * New inodes set I_NEW. If two processes both create
1925 * the same inode, one of them will release its inode and
1926 * wait for I_NEW to be released before returning.
1927 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1928 * also cause waiting on I_NEW, without I_NEW actually
1929 * being set. find_inode() uses this to prevent returning
1930 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001931 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1932 * is zero. I_FREEING must be set when I_WILL_FREE is
1933 * cleared.
1934 * I_FREEING Set when inode is about to be freed but still has dirty
1935 * pages or buffers attached or the inode itself is still
1936 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001937 * I_CLEAR Added by clear_inode(). In this state the inode is
1938 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001939 *
1940 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1941 * prohibited for many purposes. iget() must wait for
1942 * the inode to be completely released, then create it
1943 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001944 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001945 *
Jan Kara169ebd92012-05-03 14:48:03 +02001946 * I_SYNC Writeback of inode is running. The bit is set during
1947 * data writeback, and cleared with a wakeup on the bit
1948 * address once it is done. The bit is also used to pin
1949 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001950 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001951 * I_REFERENCED Marks the inode as recently references on the LRU list.
1952 *
1953 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1954 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001955 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1956 * synchronize competing switching instances and to tell
1957 * wb stat updates to grab mapping->tree_lock. See
1958 * inode_switch_wb_work_fn() for details.
1959 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001960 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001961 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001962#define I_DIRTY_SYNC (1 << 0)
1963#define I_DIRTY_DATASYNC (1 << 1)
1964#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001965#define __I_NEW 3
1966#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001967#define I_WILL_FREE (1 << 4)
1968#define I_FREEING (1 << 5)
1969#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001970#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001971#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04001972#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001973#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05001974#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04001975#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001976#define I_DIRTY_TIME (1 << 11)
1977#define __I_DIRTY_TIME_EXPIRED 12
1978#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04001979#define I_WB_SWITCH (1 << 13)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
1981#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001982#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
1984extern void __mark_inode_dirty(struct inode *, int);
1985static inline void mark_inode_dirty(struct inode *inode)
1986{
1987 __mark_inode_dirty(inode, I_DIRTY);
1988}
1989
1990static inline void mark_inode_dirty_sync(struct inode *inode)
1991{
1992 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1993}
1994
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001995extern void inc_nlink(struct inode *inode);
1996extern void drop_nlink(struct inode *inode);
1997extern void clear_nlink(struct inode *inode);
1998extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07001999
2000static inline void inode_inc_link_count(struct inode *inode)
2001{
2002 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002003 mark_inode_dirty(inode);
2004}
2005
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002006static inline void inode_dec_link_count(struct inode *inode)
2007{
2008 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002009 mark_inode_dirty(inode);
2010}
2011
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05002012/**
2013 * inode_inc_iversion - increments i_version
2014 * @inode: inode that need to be updated
2015 *
2016 * Every time the inode is modified, the i_version field will be incremented.
2017 * The filesystem has to be mounted with i_version flag
2018 */
2019
2020static inline void inode_inc_iversion(struct inode *inode)
2021{
2022 spin_lock(&inode->i_lock);
2023 inode->i_version++;
2024 spin_unlock(&inode->i_lock);
2025}
2026
Josef Bacikc3b2da32012-03-26 09:59:21 -04002027enum file_time_flags {
2028 S_ATIME = 1,
2029 S_MTIME = 2,
2030 S_CTIME = 4,
2031 S_VERSION = 8,
2032};
2033
Al Virobadcf2b2013-07-16 18:15:46 +04002034extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035static inline void file_accessed(struct file *file)
2036{
2037 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002038 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039}
2040
2041int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002042int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044struct file_system_type {
2045 const char *name;
2046 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002047#define FS_REQUIRES_DEV 1
2048#define FS_BINARY_MOUNTDATA 2
2049#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002050#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002051#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002052 struct dentry *(*mount) (struct file_system_type *, int,
2053 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 void (*kill_sb) (struct super_block *);
2055 struct module *owner;
2056 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002057 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002058
Ingo Molnarcf516242006-07-03 00:25:27 -07002059 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002060 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002061 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002062 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002063
2064 struct lock_class_key i_lock_key;
2065 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002066 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067};
2068
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002069#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2070
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002071extern struct dentry *mount_ns(struct file_system_type *fs_type,
2072 int flags, void *data, void *ns, struct user_namespace *user_ns,
2073 int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04002074extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2075 int flags, const char *dev_name, void *data,
2076 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002077extern struct dentry *mount_single(struct file_system_type *fs_type,
2078 int flags, void *data,
2079 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002080extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2081 int flags, void *data,
2082 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002083extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084void generic_shutdown_super(struct super_block *sb);
2085void kill_block_super(struct super_block *sb);
2086void kill_anon_super(struct super_block *sb);
2087void kill_litter_super(struct super_block *sb);
2088void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002089void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002091int get_anon_bdev(dev_t *);
2092void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002093struct super_block *sget_userns(struct file_system_type *type,
2094 int (*test)(struct super_block *,void *),
2095 int (*set)(struct super_block *,void *),
2096 int flags, struct user_namespace *user_ns,
2097 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098struct super_block *sget(struct file_system_type *type,
2099 int (*test)(struct super_block *,void *),
2100 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002101 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002102extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2103 const struct super_operations *ops,
2104 const struct xattr_handler **xattr,
2105 const struct dentry_operations *dops,
2106 unsigned long);
2107
2108static inline struct dentry *
2109mount_pseudo(struct file_system_type *fs_type, char *name,
2110 const struct super_operations *ops,
2111 const struct dentry_operations *dops, unsigned long magic)
2112{
2113 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2114}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
2116/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2117#define fops_get(fops) \
2118 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2119#define fops_put(fops) \
2120 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002121/*
2122 * This one is to be used *ONLY* from ->open() instances.
2123 * fops must be non-NULL, pinned down *and* module dependencies
2124 * should be sufficient to pin the caller down as well.
2125 */
2126#define replace_fops(f, fops) \
2127 do { \
2128 struct file *__file = (f); \
2129 fops_put(__file->f_op); \
2130 BUG_ON(!(__file->f_op = (fops))); \
2131 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
2133extern int register_filesystem(struct file_system_type *);
2134extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002135extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2136#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002137extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138extern int may_umount_tree(struct vfsmount *);
2139extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002140extern long do_mount(const char *, const char __user *,
2141 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002142extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002143extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002144extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2145 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002146extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002147extern int user_statfs(const char __user *, struct kstatfs *);
2148extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002149extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002150extern int freeze_super(struct super_block *super);
2151extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002152extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002153extern __printf(2, 3)
2154int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2155extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156
Al Viroce3b0f82009-03-29 19:08:22 -04002157extern int current_umask(void);
2158
J. Bruce Fields5a146962012-08-28 07:50:40 -07002159extern void ihold(struct inode * inode);
2160extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002161extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002162
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002163/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002164extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002165
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002166#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002167
Jeff Layton9e8925b2015-11-16 09:49:34 -05002168#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002169extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002170extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171
2172/*
2173 * Candidates for mandatory locking have the setgid bit set
2174 * but no group execute bit - an otherwise meaningless combination.
2175 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002176
2177static inline int __mandatory_lock(struct inode *ino)
2178{
2179 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2180}
2181
2182/*
2183 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2184 * otherwise these will be advisory locks
2185 */
2186
2187static inline int mandatory_lock(struct inode *ino)
2188{
2189 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2190}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
Jeff Laytond7a06982014-03-10 09:54:15 -04002192static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193{
Miklos Szeredic568d682016-09-16 12:44:20 +02002194 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002195 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 return 0;
2197}
2198
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002200 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 loff_t size)
2202{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002203 if (!inode->i_flctx || !mandatory_lock(inode))
2204 return 0;
2205
2206 if (size < inode->i_size) {
2207 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2208 F_WRLCK);
2209 } else {
2210 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2211 F_WRLCK);
2212 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213}
2214
Jeff Layton9e8925b2015-11-16 09:49:34 -05002215#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2216
2217static inline int locks_mandatory_locked(struct file *file)
2218{
2219 return 0;
2220}
2221
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002222static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2223 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002224{
2225 return 0;
2226}
2227
2228static inline int __mandatory_lock(struct inode *inode)
2229{
2230 return 0;
2231}
2232
2233static inline int mandatory_lock(struct inode *inode)
2234{
2235 return 0;
2236}
2237
2238static inline int locks_verify_locked(struct file *file)
2239{
2240 return 0;
2241}
2242
2243static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2244 size_t size)
2245{
2246 return 0;
2247}
2248
2249#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2250
2251
2252#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253static inline int break_lease(struct inode *inode, unsigned int mode)
2254{
Jeff Layton24cbe782014-02-03 12:13:06 -05002255 /*
2256 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002257 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2258 * could end up racing with tasks trying to set a new lease on this
2259 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002260 */
2261 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002262 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002263 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 return 0;
2265}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002266
2267static inline int break_deleg(struct inode *inode, unsigned int mode)
2268{
Jeff Layton962bd402014-06-10 12:24:40 -04002269 /*
2270 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002271 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2272 * could end up racing with tasks trying to set a new lease on this
2273 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002274 */
2275 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002276 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002277 return __break_lease(inode, mode, FL_DELEG);
2278 return 0;
2279}
2280
J. Bruce Fields5a146962012-08-28 07:50:40 -07002281static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2282{
2283 int ret;
2284
2285 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2286 if (ret == -EWOULDBLOCK && delegated_inode) {
2287 *delegated_inode = inode;
2288 ihold(inode);
2289 }
2290 return ret;
2291}
2292
2293static inline int break_deleg_wait(struct inode **delegated_inode)
2294{
2295 int ret;
2296
2297 ret = break_deleg(*delegated_inode, O_WRONLY);
2298 iput(*delegated_inode);
2299 *delegated_inode = NULL;
2300 return ret;
2301}
2302
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002303static inline int break_layout(struct inode *inode, bool wait)
2304{
2305 smp_mb();
2306 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2307 return __break_lease(inode,
2308 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2309 FL_LAYOUT);
2310 return 0;
2311}
2312
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002313#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002314static inline int break_lease(struct inode *inode, unsigned int mode)
2315{
2316 return 0;
2317}
2318
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002319static inline int break_deleg(struct inode *inode, unsigned int mode)
2320{
2321 return 0;
2322}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002323
2324static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2325{
2326 return 0;
2327}
2328
2329static inline int break_deleg_wait(struct inode **delegated_inode)
2330{
2331 BUG();
2332 return 0;
2333}
2334
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002335static inline int break_layout(struct inode *inode, bool wait)
2336{
2337 return 0;
2338}
2339
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002340#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341
2342/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002343struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002344struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002345 const char *name; /* pointer to actual string */
2346 const __user char *uptr; /* original userland pointer */
2347 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002348 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002349 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002350};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
Al Viro7df818b2016-03-25 14:24:09 -04002352extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002353extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2354 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002355extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002356 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002357extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002358 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002359extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002360extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002361extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002362 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002363extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002365
David Drysdale51f39a12014-12-12 16:57:29 -08002366extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002367extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002368extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002369extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002370
Al Viro47237682012-06-10 05:01:45 -04002371enum {
2372 FILE_CREATED = 1,
2373 FILE_OPENED = 2
2374};
Al Viro30d90492012-06-22 12:40:19 +04002375extern int finish_open(struct file *file, struct dentry *dentry,
2376 int (*open)(struct inode *, struct file *),
2377 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002378extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002380/* fs/ioctl.c */
2381
2382extern int ioctl_preallocate(struct file *filp, void __user *argp);
2383
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384/* fs/dcache.c */
2385extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002386extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387
Christoph Lameterb86c0892006-12-06 20:32:57 -08002388extern struct kmem_cache *names_cachep;
2389
Jeff Laytona608ca22012-10-10 15:25:26 -04002390#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002391#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392
David Howells93614012006-09-30 20:45:40 +02002393#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002395extern void unregister_blkdev(unsigned int, const char *);
Jan Karaf44f1ab2017-02-02 15:56:49 +01002396extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002398extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399extern void bd_set_size(struct block_device *, loff_t size);
2400extern void bd_forget(struct inode *inode);
2401extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002402extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002403extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002404extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002405extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002406extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002407extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002408extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2409extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002410
2411extern struct super_block *blockdev_superblock;
2412
2413static inline bool sb_is_blkdev_sb(struct super_block *sb)
2414{
2415 return sb == blockdev_superblock;
2416}
David Howells93614012006-09-30 20:45:40 +02002417#else
2418static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002419static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002420static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002421static inline void invalidate_bdev(struct block_device *bdev) {}
2422
2423static inline struct super_block *freeze_bdev(struct block_device *sb)
2424{
2425 return NULL;
2426}
2427
2428static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2429{
2430 return 0;
2431}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002432
2433static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2434{
2435}
Jan Karaa8855992013-07-09 22:36:45 +08002436
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002437static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002438{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002439 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002440}
David Howells93614012006-09-30 20:45:40 +02002441#endif
Jan Kara60b06802009-04-27 16:43:53 +02002442extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002443extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002444extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002445#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002447extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002449extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002450extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2451 void *holder);
2452extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2453 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002454extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002455extern int __blkdev_reread_part(struct block_device *bdev);
2456extern int blkdev_reread_part(struct block_device *bdev);
2457
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002458#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002459extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002460extern void bd_unlink_disk_holder(struct block_device *bdev,
2461 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002462#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002463static inline int bd_link_disk_holder(struct block_device *bdev,
2464 struct gendisk *disk)
2465{
2466 return 0;
2467}
Tejun Heo49731ba2011-01-14 18:43:57 +01002468static inline void bd_unlink_disk_holder(struct block_device *bdev,
2469 struct gendisk *disk)
2470{
2471}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002472#endif
David Howells93614012006-09-30 20:45:40 +02002473#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
2475/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002476#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Walleij49db08c2016-02-19 15:36:07 +01002477/* Marks the bottom of the first segment of free char majors */
2478#define CHRDEV_MAJOR_DYN_END 234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2480extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002481extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2482 unsigned int count, const char *name,
2483 const struct file_operations *fops);
2484extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2485 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002487extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488
Tejun Heo1905b1b2009-08-06 18:13:23 +09002489static inline int register_chrdev(unsigned int major, const char *name,
2490 const struct file_operations *fops)
2491{
2492 return __register_chrdev(major, 0, 256, name, fops);
2493}
2494
2495static inline void unregister_chrdev(unsigned int major, const char *name)
2496{
2497 __unregister_chrdev(major, 0, 256, name);
2498}
2499
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500/* fs/block_dev.c */
2501#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002502#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002503
2504#ifdef CONFIG_BLOCK
2505#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506extern const char *__bdevname(dev_t, char *buffer);
2507extern const char *bdevname(struct block_device *bdev, char *buffer);
2508extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002509extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002510
David Howells93614012006-09-30 20:45:40 +02002511#else
2512#define BLKDEV_MAJOR_HASH_SIZE 0
2513#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514
2515extern void init_special_inode(struct inode *, umode_t, dev_t);
2516
2517/* Invalid inode operations -- fs/bad_inode.c */
2518extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002519extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
Jens Axboec11f0c02016-08-05 08:11:04 -06002521#ifdef CONFIG_BLOCK
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002522extern void check_disk_size_change(struct gendisk *disk,
2523 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002524extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002526extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002528#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529unsigned long invalidate_mapping_pages(struct address_space *mapping,
2530 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002531
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532static inline void invalidate_remote_inode(struct inode *inode)
2533{
2534 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2535 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002536 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537}
2538extern int invalidate_inode_pages2(struct address_space *mapping);
2539extern int invalidate_inode_pages2_range(struct address_space *mapping,
2540 pgoff_t start, pgoff_t end);
2541extern int write_inode_now(struct inode *, int);
2542extern int filemap_fdatawrite(struct address_space *);
2543extern int filemap_flush(struct address_space *);
2544extern int filemap_fdatawait(struct address_space *);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -08002545extern void filemap_fdatawait_keep_errors(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002546extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2547 loff_t lend);
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002548extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2549 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550extern int filemap_write_and_wait(struct address_space *mapping);
2551extern int filemap_write_and_wait_range(struct address_space *mapping,
2552 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002553extern int __filemap_fdatawrite_range(struct address_space *mapping,
2554 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002555extern int filemap_fdatawrite_range(struct address_space *mapping,
2556 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002557extern int filemap_check_errors(struct address_space *mapping);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002558
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002559extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2560 int datasync);
2561extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002562
2563/*
2564 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2565 * to already be updated for the write, and will return either the amount
2566 * of bytes passed in, or an error if syncing the file failed.
2567 */
2568static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002569{
Christoph Hellwige2592212016-04-07 08:52:01 -07002570 if (iocb->ki_flags & IOCB_DSYNC) {
2571 int ret = vfs_fsync_range(iocb->ki_filp,
2572 iocb->ki_pos - count, iocb->ki_pos - 1,
2573 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2574 if (ret)
2575 return ret;
2576 }
2577
2578 return count;
Al Virod311d792014-02-09 15:18:09 -05002579}
Christoph Hellwige2592212016-04-07 08:52:01 -07002580
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581extern void emergency_sync(void);
2582extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002583#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002585#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002586extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002587extern int inode_permission(struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002588extern int __inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002589extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002590extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591
Miklos Szeredif696a362008-07-31 13:41:58 +02002592static inline bool execute_ok(struct inode *inode)
2593{
2594 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2595}
2596
Al Viro8d71db42013-03-19 21:01:03 -04002597static inline void file_start_write(struct file *file)
2598{
2599 if (!S_ISREG(file_inode(file)->i_mode))
2600 return;
2601 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2602}
2603
Jan Kara5ae98f12013-05-04 00:11:23 +02002604static inline bool file_start_write_trylock(struct file *file)
2605{
2606 if (!S_ISREG(file_inode(file)->i_mode))
2607 return true;
2608 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2609}
2610
Al Viro8d71db42013-03-19 21:01:03 -04002611static inline void file_end_write(struct file *file)
2612{
2613 if (!S_ISREG(file_inode(file)->i_mode))
2614 return;
2615 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2616}
2617
Amir Goldsteinbfe219d2017-01-31 10:34:57 +02002618static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
2619 struct file *file_out, loff_t pos_out,
2620 u64 len)
2621{
2622 int ret;
2623
2624 file_start_write(file_out);
2625 ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
2626 file_end_write(file_out);
2627
2628 return ret;
2629}
2630
Al Viro07b8ce12011-06-20 10:52:57 -04002631/*
2632 * get_write_access() gets write permission for a file.
2633 * put_write_access() releases this write permission.
2634 * This is used for regular files.
2635 * We cannot support write (and maybe mmap read-write shared) accesses and
2636 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2637 * can have the following values:
2638 * 0: no writers, no VM_DENYWRITE mappings
2639 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2640 * > 0: (i_writecount) users are writing to the file.
2641 *
2642 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2643 * except for the cases where we don't hold i_writecount yet. Then we need to
2644 * use {get,deny}_write_access() - these functions check the sign and refuse
2645 * to do the change if sign is wrong.
2646 */
2647static inline int get_write_access(struct inode *inode)
2648{
2649 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2650}
2651static inline int deny_write_access(struct file *file)
2652{
Al Viro496ad9a2013-01-23 17:07:38 -05002653 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002654 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2655}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656static inline void put_write_access(struct inode * inode)
2657{
2658 atomic_dec(&inode->i_writecount);
2659}
2660static inline void allow_write_access(struct file *file)
2661{
2662 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002663 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664}
David Howellsf1fe29b2013-09-27 11:20:03 +01002665static inline bool inode_is_open_for_write(const struct inode *inode)
2666{
2667 return atomic_read(&inode->i_writecount) > 0;
2668}
2669
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002670#ifdef CONFIG_IMA
2671static inline void i_readcount_dec(struct inode *inode)
2672{
2673 BUG_ON(!atomic_read(&inode->i_readcount));
2674 atomic_dec(&inode->i_readcount);
2675}
2676static inline void i_readcount_inc(struct inode *inode)
2677{
2678 atomic_inc(&inode->i_readcount);
2679}
2680#else
2681static inline void i_readcount_dec(struct inode *inode)
2682{
2683 return;
2684}
2685static inline void i_readcount_inc(struct inode *inode)
2686{
2687 return;
2688}
2689#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002690extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691
Mimi Zohar1284ab52016-04-20 15:46:27 -07002692#define __kernel_read_file_id(id) \
2693 id(UNKNOWN, unknown) \
2694 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002695 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002696 id(MODULE, kernel-module) \
2697 id(KEXEC_IMAGE, kexec-image) \
2698 id(KEXEC_INITRAMFS, kexec-initramfs) \
2699 id(POLICY, security-policy) \
2700 id(MAX_ID, )
2701
2702#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2703#define __fid_stringify(dummy, str) #str,
2704
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002705enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002706 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002707};
2708
Mimi Zohar1284ab52016-04-20 15:46:27 -07002709static const char * const kernel_read_file_str[] = {
2710 __kernel_read_file_id(__fid_stringify)
2711};
2712
Kees Cookda20dfe2016-04-21 12:53:29 -07002713static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002714{
Arnd Bergmanncbfd0c12017-03-09 16:16:57 -08002715 if ((unsigned)id >= READING_MAX_ID)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002716 return kernel_read_file_str[READING_UNKNOWN];
2717
2718 return kernel_read_file_str[id];
2719}
2720
Mimi Zohar6777d772009-08-21 14:32:48 -04002721extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002722extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2723 enum kernel_read_file_id);
Mimi Zohar09596b92015-11-19 12:39:22 -05002724extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2725 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002726extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2727 enum kernel_read_file_id);
Al Viro7bb307e2013-02-23 14:51:48 -05002728extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002729extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730extern struct file * open_exec(const char *);
2731
2732/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002733extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002734extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002736extern char *file_path(struct file *, char *, int);
2737
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738#include <linux/err.h>
2739
2740/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002741extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742
Andrew Morton965c8e52012-12-17 15:59:39 -08002743extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744
Christoph Hellwig54e34622009-08-07 14:38:25 -03002745extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002747extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748extern struct inode * igrab(struct inode *);
2749extern ino_t iunique(struct super_block *, ino_t);
2750extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002751extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002752static inline int generic_drop_inode(struct inode *inode)
2753{
2754 return !inode->i_nlink || inode_unhashed(inode);
2755}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002757extern struct inode *ilookup5_nowait(struct super_block *sb,
2758 unsigned long hashval, int (*test)(struct inode *, void *),
2759 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2761 int (*test)(struct inode *, void *), void *data);
2762extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2763
2764extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2765extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002766extern struct inode *find_inode_nowait(struct super_block *,
2767 unsigned long,
2768 int (*match)(struct inode *,
2769 unsigned long, void *),
2770 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002771extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2772extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002773#ifdef CONFIG_DEBUG_LOCK_ALLOC
2774extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2775#else
2776static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2777#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002779extern unsigned int get_next_ino(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002782extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002783extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002784extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002785extern struct inode *new_inode_pseudo(struct super_block *sb);
2786extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002787extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002788extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002789extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790
2791extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002792static inline void insert_inode_hash(struct inode *inode)
2793{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794 __insert_inode_hash(inode, inode->i_ino);
2795}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002796
2797extern void __remove_inode_hash(struct inode *);
2798static inline void remove_inode_hash(struct inode *inode)
2799{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002800 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002801 __remove_inode_hash(inode);
2802}
2803
Christoph Hellwig646ec462010-10-23 07:15:32 -04002804extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805
David Howells93614012006-09-30 20:45:40 +02002806#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002808#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809extern int set_blocksize(struct block_device *, int);
2810extern int sb_set_blocksize(struct super_block *, int);
2811extern int sb_min_blocksize(struct super_block *, int);
2812
2813extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2814extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002815extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002816extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002817extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002818extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002819extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002820extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002821
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002822ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2823ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2824
Christoph Hellwigeef99382009-08-20 17:43:41 +02002825/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002826extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002827extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002828extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2829 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002830extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002831
Andrew Morton88e6fae2006-04-11 13:59:36 +02002832/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002833extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002834 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002835extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002836 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002837extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002838 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002839extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2840 loff_t *opos, size_t len, unsigned int flags);
2841
Andrew Morton88e6fae2006-04-11 13:59:36 +02002842
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843extern void
2844file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002845extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2846extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002847extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002848extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002849extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002850 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002851extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2852 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002853extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2854extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002855extern int generic_file_open(struct inode * inode, struct file * filp);
2856extern int nonseekable_open(struct inode * inode, struct file * filp);
2857
David Howells93614012006-09-30 20:45:40 +02002858#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05002859typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04002860 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861
2862enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002863 /* need locking between buffered and direct access */
2864 DIO_LOCKING = 0x01,
2865
2866 /* filesystem does not support filling holes */
2867 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002868
2869 /* filesystem can handle aio writes beyond i_size */
2870 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002871
2872 /* inode/fs/bdev does not need truncate protection */
2873 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874};
2875
Christoph Hellwig40553512017-06-03 09:37:58 +02002876void dio_end_io(struct bio *bio);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002877
Omar Sandoval17f8c842015-03-16 04:33:50 -07002878ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2879 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002880 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002881 dio_iodone_t end_io, dio_submit_t submit_io,
2882 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002883
Omar Sandoval17f8c842015-03-16 04:33:50 -07002884static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2885 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002886 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002887 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002888{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002889 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002890 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891}
David Howells93614012006-09-30 20:45:40 +02002892#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893
Trond Myklebust1d59d612012-05-31 12:22:33 -04002894void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002895
2896/*
2897 * inode_dio_begin - signal start of a direct I/O requests
2898 * @inode: inode the direct I/O happens on
2899 *
2900 * This is called once we've finished processing a direct I/O request,
2901 * and is used to wake up callers waiting for direct I/O to be quiesced.
2902 */
2903static inline void inode_dio_begin(struct inode *inode)
2904{
2905 atomic_inc(&inode->i_dio_count);
2906}
2907
2908/*
2909 * inode_dio_end - signal finish of a direct I/O requests
2910 * @inode: inode the direct I/O happens on
2911 *
2912 * This is called once we've finished processing a direct I/O request,
2913 * and is used to wake up callers waiting for direct I/O to be quiesced.
2914 */
2915static inline void inode_dio_end(struct inode *inode)
2916{
2917 if (atomic_dec_and_test(&inode->i_dio_count))
2918 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2919}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002920
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002921extern void inode_set_flags(struct inode *inode, unsigned int flags,
2922 unsigned int mask);
2923
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002924extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925
2926#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2927
Al Viro5d826c82014-03-14 13:42:45 -04002928extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05002930extern const char *page_get_link(struct dentry *, struct inode *,
2931 struct delayed_call *);
2932extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002933extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002934 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002936extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05002937extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00002939extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
2940extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002941void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002943void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944void inode_sub_bytes(struct inode *inode, loff_t bytes);
2945loff_t inode_get_bytes(struct inode *inode);
2946void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05002947const char *simple_get_link(struct dentry *, struct inode *,
2948 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04002949extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950
Al Viro5c0ba4e2013-05-15 13:52:59 -04002951extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952
David Howellsa528d352017-01-31 16:46:22 +00002953extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
2954extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
2955
2956static inline int vfs_stat(const char __user *filename, struct kstat *stat)
2957{
David Howellsdeccf492017-05-04 23:30:16 +01002958 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
2959 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00002960}
2961static inline int vfs_lstat(const char __user *name, struct kstat *stat)
2962{
David Howellsdeccf492017-05-04 23:30:16 +01002963 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
David Howellsa528d352017-01-31 16:46:22 +00002964 stat, STATX_BASIC_STATS);
2965}
2966static inline int vfs_fstatat(int dfd, const char __user *filename,
2967 struct kstat *stat, int flags)
2968{
David Howellsdeccf492017-05-04 23:30:16 +01002969 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
2970 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00002971}
2972static inline int vfs_fstat(int fd, struct kstat *stat)
2973{
2974 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
2975}
2976
2977
Miklos Szeredid60874c2016-10-04 14:40:45 +02002978extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0ed2016-12-09 16:45:04 +01002979extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002980
Steven Whitehousee9079cc2008-10-14 14:43:29 +01002981extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04002982 struct fiemap_extent_info *fieinfo,
2983 loff_t start, loff_t len,
2984 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04002985extern int generic_block_fiemap(struct inode *inode,
2986 struct fiemap_extent_info *fieinfo, u64 start,
2987 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988
Miklos Szeredic18479f2007-10-18 23:39:11 -07002989extern void get_filesystem(struct file_system_type *fs);
2990extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991extern struct file_system_type *get_fs_type(const char *name);
2992extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01002993extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01002994extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02002995extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01002997extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04002998extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04002999extern void iterate_supers_type(struct file_system_type *,
3000 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
3002extern int dcache_dir_open(struct inode *, struct file *);
3003extern int dcache_dir_close(struct inode *, struct file *);
3004extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003005extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003006extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003007extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003008extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003009extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3011extern int simple_unlink(struct inode *, struct dentry *);
3012extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003013extern int simple_rename(struct inode *, struct dentry *,
3014 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003015extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003016extern int simple_empty(struct dentry *);
3017extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003018extern int simple_write_begin(struct file *file, struct address_space *mapping,
3019 loff_t pos, unsigned len, unsigned flags,
3020 struct page **pagep, void **fsdata);
3021extern int simple_write_end(struct file *file, struct address_space *mapping,
3022 loff_t pos, unsigned len, unsigned copied,
3023 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003024extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003025extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003026extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003027extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028
Al Viro00cd8dd2012-06-10 17:13:09 -04003029extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003031extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003032extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003033extern void make_empty_dir_inode(struct inode *inode);
3034extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003035struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003037extern int simple_fill_super(struct super_block *, unsigned long,
3038 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003039extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040extern void simple_release_fs(struct vfsmount **mount, int *count);
3041
Akinobu Mita93b07112008-06-05 22:46:21 -07003042extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3043 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003044extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3045 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003046
Fabian Frederickac13a822014-06-04 16:06:27 -07003047extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003048extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003049
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003050extern int generic_check_addressable(unsigned, u64);
3051
Christoph Lametere965f962006-02-01 03:05:41 -08003052#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003053extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003054 struct page *, struct page *,
3055 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003056#else
3057#define buffer_migrate_page NULL
3058#endif
3059
Jan Kara31051c82016-05-26 16:55:18 +02003060extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003061extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003062extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063
Josef Bacikc3b2da32012-03-26 09:59:21 -04003064extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065
Al Viro34c80b12011-12-08 21:32:45 -05003066extern int generic_show_options(struct seq_file *m, struct dentry *root);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003067extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04003068extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08003069
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003070static inline bool io_is_direct(struct file *filp)
3071{
Dan Williams65f87ee2016-01-25 17:23:18 -08003072 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003073}
3074
Al Viro2ba48ce2015-04-09 13:52:01 -04003075static inline int iocb_flags(struct file *file)
3076{
3077 int res = 0;
3078 if (file->f_flags & O_APPEND)
3079 res |= IOCB_APPEND;
3080 if (io_is_direct(file))
3081 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003082 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3083 res |= IOCB_DSYNC;
3084 if (file->f_flags & __O_SYNC)
3085 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003086 return res;
3087}
3088
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003089static inline int kiocb_set_rw_flags(struct kiocb *ki, int flags)
3090{
3091 if (unlikely(flags & ~RWF_SUPPORTED))
3092 return -EOPNOTSUPP;
3093
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003094 if (flags & RWF_NOWAIT) {
3095 if (!(ki->ki_filp->f_mode & FMODE_AIO_NOWAIT))
3096 return -EOPNOTSUPP;
3097 ki->ki_flags |= IOCB_NOWAIT;
3098 }
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003099 if (flags & RWF_HIPRI)
3100 ki->ki_flags |= IOCB_HIPRI;
3101 if (flags & RWF_DSYNC)
3102 ki->ki_flags |= IOCB_DSYNC;
3103 if (flags & RWF_SYNC)
3104 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3105 return 0;
3106}
3107
Linus Torvalds1da177e2005-04-16 15:20:36 -07003108static inline ino_t parent_ino(struct dentry *dentry)
3109{
3110 ino_t res;
3111
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003112 /*
3113 * Don't strictly need d_lock here? If the parent ino could change
3114 * then surely we'd have a deeper race in the caller?
3115 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003116 spin_lock(&dentry->d_lock);
3117 res = dentry->d_parent->d_inode->i_ino;
3118 spin_unlock(&dentry->d_lock);
3119 return res;
3120}
3121
Linus Torvalds1da177e2005-04-16 15:20:36 -07003122/* Transaction based IO helpers */
3123
3124/*
3125 * An argresp is stored in an allocated page and holds the
3126 * size of the argument or response, along with its content
3127 */
3128struct simple_transaction_argresp {
3129 ssize_t size;
3130 char data[0];
3131};
3132
3133#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3134
3135char *simple_transaction_get(struct file *file, const char __user *buf,
3136 size_t size);
3137ssize_t simple_transaction_read(struct file *file, char __user *buf,
3138 size_t size, loff_t *pos);
3139int simple_transaction_release(struct inode *inode, struct file *file);
3140
Ingo Molnar76791ab2009-03-25 16:48:35 +01003141void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003143/*
3144 * simple attribute files
3145 *
3146 * These attributes behave similar to those in sysfs:
3147 *
3148 * Writing to an attribute immediately sets a value, an open file can be
3149 * written to multiple times.
3150 *
3151 * Reading from an attribute creates a buffer from the value that might get
3152 * read with multiple read calls. When the attribute has been read
3153 * completely, no further read calls are possible until the file is opened
3154 * again.
3155 *
3156 * All attributes contain a text representation of a numeric value
3157 * that are accessed with the get() and set() functions.
3158 */
3159#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3160static int __fops ## _open(struct inode *inode, struct file *file) \
3161{ \
3162 __simple_attr_check_format(__fmt, 0ull); \
3163 return simple_attr_open(inode, file, __get, __set, __fmt); \
3164} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003165static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003166 .owner = THIS_MODULE, \
3167 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003168 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003169 .read = simple_attr_read, \
3170 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003171 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003172}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003173
Joe Perchesb9075fa2011-10-31 17:11:33 -07003174static inline __printf(1, 2)
3175void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003176{
3177 /* don't do anything, just let the compiler check the arguments; */
3178}
3179
3180int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003181 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003182 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003183int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003184ssize_t simple_attr_read(struct file *file, char __user *buf,
3185 size_t len, loff_t *ppos);
3186ssize_t simple_attr_write(struct file *file, const char __user *buf,
3187 size_t len, loff_t *ppos);
3188
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003189struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003190int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003191 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003192int proc_nr_dentry(struct ctl_table *table, int write,
3193 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003194int proc_nr_inodes(struct ctl_table *table, int write,
3195 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003196int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003197
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003198#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003199#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3200
Al Viro6d125522009-12-24 06:58:56 -05003201#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003202#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003203 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003204
Yaowei Baid37177b2015-11-19 21:00:12 +08003205static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003206{
3207 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3208}
3209
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003210static inline int check_sticky(struct inode *dir, struct inode *inode)
3211{
3212 if (!(dir->i_mode & S_ISVTX))
3213 return 0;
3214
3215 return __check_sticky(dir, inode);
3216}
3217
Andi Kleen69b45732011-05-28 08:25:51 -07003218static inline void inode_has_no_xattr(struct inode *inode)
3219{
Al Viro9e1f1de2011-06-03 18:24:58 -04003220 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003221 inode->i_flags |= S_NOSEC;
3222}
3223
Al Viroa7400222014-10-21 15:20:42 -04003224static inline bool is_root_inode(struct inode *inode)
3225{
3226 return inode == inode->i_sb->s_root->d_inode;
3227}
3228
Al Viro5f99f4e2013-05-15 20:23:06 -04003229static inline bool dir_emit(struct dir_context *ctx,
3230 const char *name, int namelen,
3231 u64 ino, unsigned type)
3232{
3233 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3234}
3235static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3236{
3237 return ctx->actor(ctx, ".", 1, ctx->pos,
3238 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3239}
3240static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3241{
3242 return ctx->actor(ctx, "..", 2, ctx->pos,
3243 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3244}
3245static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3246{
3247 if (ctx->pos == 0) {
3248 if (!dir_emit_dot(file, ctx))
3249 return false;
3250 ctx->pos = 1;
3251 }
3252 if (ctx->pos == 1) {
3253 if (!dir_emit_dotdot(file, ctx))
3254 return false;
3255 ctx->pos = 2;
3256 }
3257 return true;
3258}
Al Viro5ded75e2013-05-15 21:02:48 -04003259static inline bool dir_relax(struct inode *inode)
3260{
Al Viro59551022016-01-22 15:40:57 -05003261 inode_unlock(inode);
3262 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003263 return !IS_DEADDIR(inode);
3264}
Al Viro5f99f4e2013-05-15 20:23:06 -04003265
Al Viroae053272016-05-12 20:36:01 -04003266static inline bool dir_relax_shared(struct inode *inode)
3267{
3268 inode_unlock_shared(inode);
3269 inode_lock_shared(inode);
3270 return !IS_DEADDIR(inode);
3271}
3272
Eric W. Biederman90f85722015-06-29 14:42:03 -05003273extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003274extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003275
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276#endif /* _LINUX_FS_H */