blob: 2ba8f38a4d632748b290c34f2fe41b78822a5ff7 [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>
Ingo Molnar5dd43ce2017-06-20 12:19:09 +02005#include <linux/wait_bit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/kdev_t.h>
7#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04008#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/stat.h>
10#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100012#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070013#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/radix-tree.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070015#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040017#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050018#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080019#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080020#include <linux/rwsem.h>
Dan Williamsbaabda22017-07-10 15:48:25 -070021#include <linux/mm_types.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053022#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040023#include <linux/semaphore.h>
Jens Axboec75b1d92017-06-27 11:47:04 -060024#include <linux/fcntl.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040025#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110026#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040027#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080028#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110029#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080030#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020031#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020032#include <linux/percpu-rwsem.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020033#include <linux/workqueue.h>
Al Virofceef392015-12-29 15:58:39 -050034#include <linux/delayed_call.h>
Christoph Hellwig85787092017-05-10 15:06:33 +020035#include <linux/uuid.h>
Jeff Layton5660e132017-07-06 07:02:25 -040036#include <linux/errseq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010039#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010041struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040042struct bdi_writeback;
Christoph Hellwig2f8b5442016-11-01 07:40:13 -060043struct bio;
Christoph Hellwiga5694252007-07-17 04:04:28 -070044struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080045struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070047struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020048struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049struct pipe_inode_info;
50struct poll_table_struct;
51struct kstatfs;
52struct vm_area_struct;
53struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110054struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070055struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080056struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020057struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050058struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070059struct fscrypt_info;
60struct fscrypt_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Denis Cheng74bf17c2007-10-16 23:26:30 -070062extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070064extern void __init files_init(void);
65extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Jan Engelhardtdded4f42008-12-01 14:34:50 -080067extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070068extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030069extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080070extern struct inodes_stat_t inodes_stat;
71extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070072extern int sysctl_protected_symlinks;
73extern int sysctl_protected_hardlinks;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080074
Linus Torvalds1da177e2005-04-16 15:20:36 -070075struct buffer_head;
76typedef int (get_block_t)(struct inode *inode, sector_t iblock,
77 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110078typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020079 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
David Howellsbbc10962012-10-15 16:40:35 +010081#define MAY_EXEC 0x00000001
82#define MAY_WRITE 0x00000002
83#define MAY_READ 0x00000004
84#define MAY_APPEND 0x00000008
85#define MAY_ACCESS 0x00000010
86#define MAY_OPEN 0x00000020
87#define MAY_CHDIR 0x00000040
88/* called from RCU mode, don't block */
89#define MAY_NOT_BLOCK 0x00000080
90
91/*
92 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
93 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
94 */
95
96/* file is open for reading */
97#define FMODE_READ ((__force fmode_t)0x1)
98/* file is open for writing */
99#define FMODE_WRITE ((__force fmode_t)0x2)
100/* file is seekable */
101#define FMODE_LSEEK ((__force fmode_t)0x4)
102/* file can be accessed using pread */
103#define FMODE_PREAD ((__force fmode_t)0x8)
104/* file can be accessed using pwrite */
105#define FMODE_PWRITE ((__force fmode_t)0x10)
106/* File is opened for execution with sys_execve / sys_uselib */
107#define FMODE_EXEC ((__force fmode_t)0x20)
108/* File is opened with O_NDELAY (only set for block devices) */
109#define FMODE_NDELAY ((__force fmode_t)0x40)
110/* File is opened with O_EXCL (only set for block devices) */
111#define FMODE_EXCL ((__force fmode_t)0x80)
112/* File is opened using open(.., 3, ..) and is writeable only for ioctls
113 (specialy hack for floppy.c) */
114#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
115/* 32bit hashes as llseek() offset (for directories) */
116#define FMODE_32BITHASH ((__force fmode_t)0x200)
117/* 64bit hashes as llseek() offset (for directories) */
118#define FMODE_64BITHASH ((__force fmode_t)0x400)
119
120/*
121 * Don't update ctime and mtime.
122 *
123 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
124 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
125 */
126#define FMODE_NOCMTIME ((__force fmode_t)0x800)
127
128/* Expect random access pattern */
129#define FMODE_RANDOM ((__force fmode_t)0x1000)
130
131/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
132#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
133
134/* File is opened with O_PATH; almost nothing can be done with it */
135#define FMODE_PATH ((__force fmode_t)0x4000)
136
Linus Torvalds9c225f22014-03-03 09:36:58 -0800137/* File needs atomic accesses to f_pos */
138#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400139/* Write access to underlying fs */
140#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500141/* Has read method(s) */
142#define FMODE_CAN_READ ((__force fmode_t)0x20000)
143/* Has write method(s) */
144#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800145
David Howellsbbc10962012-10-15 16:40:35 +0100146/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800147#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100148
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500149/* File is capable of returning -EAGAIN if AIO will block */
150#define FMODE_AIO_NOWAIT ((__force fmode_t)0x8000000)
151
David Howellsbbc10962012-10-15 16:40:35 +0100152/*
153 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
154 * that indicates that they should check the contents of the iovec are
155 * valid, but not check the memory that the iovec elements
156 * points too.
157 */
158#define CHECK_IOVEC_ONLY -1
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160/*
161 * Attribute flags. These should be or-ed together to figure out what
162 * has been changed!
163 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200164#define ATTR_MODE (1 << 0)
165#define ATTR_UID (1 << 1)
166#define ATTR_GID (1 << 2)
167#define ATTR_SIZE (1 << 3)
168#define ATTR_ATIME (1 << 4)
169#define ATTR_MTIME (1 << 5)
170#define ATTR_CTIME (1 << 6)
171#define ATTR_ATIME_SET (1 << 7)
172#define ATTR_MTIME_SET (1 << 8)
173#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
174#define ATTR_ATTR_FLAG (1 << 10)
175#define ATTR_KILL_SUID (1 << 11)
176#define ATTR_KILL_SGID (1 << 12)
177#define ATTR_FILE (1 << 13)
178#define ATTR_KILL_PRIV (1 << 14)
179#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
180#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200181#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200184 * Whiteout is represented by a char device. The following constants define the
185 * mode and device number to use.
186 */
187#define WHITEOUT_MODE 0
188#define WHITEOUT_DEV 0
189
190/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * This is the Inode Attributes structure, used for notify_change(). It
192 * uses the above definitions as flags, to know which values have changed.
193 * Also, in this manner, a Filesystem can look at only the values it cares
194 * about. Basically, these are the attributes that the VFS layer can
195 * request to change from the FS layer.
196 *
197 * Derek Atkins <warlord@MIT.EDU> 94-10-20
198 */
199struct iattr {
200 unsigned int ia_valid;
201 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800202 kuid_t ia_uid;
203 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 loff_t ia_size;
205 struct timespec ia_atime;
206 struct timespec ia_mtime;
207 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800208
209 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300210 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800211 * implement an ftruncate() like method. NOTE: filesystem should
212 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
213 */
214 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215};
216
217/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 * Includes for diskquotas.
219 */
220#include <linux/quota.h>
221
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200222/*
223 * Maximum number of layers of fs stack. Needs to be limited to
224 * prevent kernel stack overflow
225 */
226#define FILESYSTEM_MAX_STACK_DEPTH 2
227
Zach Brown994fc28c2005-12-15 14:28:17 -0800228/**
229 * enum positive_aop_returns - aop return codes with specific semantics
230 *
231 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
232 * completed, that the page is still locked, and
233 * should be considered active. The VM uses this hint
234 * to return the page to the active list -- it won't
235 * be a candidate for writeback again in the near
236 * future. Other callers must be careful to unlock
237 * the page if they get this return. Returned by
238 * writepage();
239 *
240 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
241 * unlocked it and the page might have been truncated.
242 * The caller should back up to acquiring a new page and
243 * trying again. The aop will be taking reasonable
244 * precautions not to livelock. If the caller held a page
245 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700246 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800247 *
248 * address_space_operation functions return these large constants to indicate
249 * special semantics to the caller. These are much larger than the bytes in a
250 * page to allow for functions that return the number of bytes operated on in a
251 * given page.
252 */
253
254enum positive_aop_returns {
255 AOP_WRITEPAGE_ACTIVATE = 0x80000,
256 AOP_TRUNCATED_PAGE = 0x80001,
257};
258
Tetsuo Handac718a972017-05-08 15:58:59 -0700259#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
260#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800261 * helper code (eg buffer layer)
262 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264/*
265 * oh the beauties of C type declarations.
266 */
267struct page;
268struct address_space;
269struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Jens Axboec75b1d92017-06-27 11:47:04 -0600271/*
272 * Write life time hint values.
273 */
274enum rw_hint {
275 WRITE_LIFE_NOT_SET = 0,
276 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
277 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
278 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
279 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
280 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
281};
282
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800283#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400284#define IOCB_APPEND (1 << 1)
285#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100286#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700287#define IOCB_DSYNC (1 << 4)
288#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500289#define IOCB_WRITE (1 << 6)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500290#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800291
292struct kiocb {
293 struct file *ki_filp;
294 loff_t ki_pos;
295 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
296 void *private;
297 int ki_flags;
Jens Axboec75b1d92017-06-27 11:47:04 -0600298 enum rw_hint ki_hint;
Kees Cook3859a272016-10-28 01:22:25 -0700299} __randomize_layout;
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800300
301static inline bool is_sync_kiocb(struct kiocb *kiocb)
302{
303 return kiocb->ki_complete == NULL;
304}
305
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700306/*
307 * "descriptor" for what we're up to with a read.
308 * This allows us to use the same read code yet
309 * have multiple different users of the data that
310 * we read from a file.
311 *
312 * The simplest case just copies the data to user
313 * mode.
314 */
315typedef struct {
316 size_t written;
317 size_t count;
318 union {
319 char __user *buf;
320 void *data;
321 } arg;
322 int error;
323} read_descriptor_t;
324
325typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
326 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328struct address_space_operations {
329 int (*writepage)(struct page *page, struct writeback_control *wbc);
330 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332 /* Write back some dirty pages from this mapping. */
333 int (*writepages)(struct address_space *, struct writeback_control *);
334
Andrew Morton4741c9f2006-03-24 03:18:11 -0800335 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 int (*set_page_dirty)(struct page *page);
337
338 int (*readpages)(struct file *filp, struct address_space *mapping,
339 struct list_head *pages, unsigned nr_pages);
340
Nick Pigginafddba42007-10-16 01:25:01 -0700341 int (*write_begin)(struct file *, struct address_space *mapping,
342 loff_t pos, unsigned len, unsigned flags,
343 struct page **pagep, void **fsdata);
344 int (*write_end)(struct file *, struct address_space *mapping,
345 loff_t pos, unsigned len, unsigned copied,
346 struct page *page, void *fsdata);
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
349 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400350 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400351 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500352 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700353 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4a2012-01-12 17:19:34 -0800354 /*
Tang Chenef277c72013-07-08 16:00:21 -0700355 * migrate the contents of a page to the specified target. If
356 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4a2012-01-12 17:19:34 -0800357 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700358 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800359 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700360 bool (*isolate_page)(struct page *, isolate_mode_t);
361 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800362 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500363 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700364 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700365 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200366 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700367
368 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700369 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
370 sector_t *span);
371 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372};
373
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200374extern const struct address_space_operations empty_aops;
375
Nick Pigginafddba42007-10-16 01:25:01 -0700376/*
377 * pagecache_write_begin/pagecache_write_end must be used by general code
378 * to write into the pagecache.
379 */
380int pagecache_write_begin(struct file *, struct address_space *mapping,
381 loff_t pos, unsigned len, unsigned flags,
382 struct page **pagep, void **fsdata);
383
384int pagecache_write_end(struct file *, struct address_space *mapping,
385 loff_t pos, unsigned len, unsigned copied,
386 struct page *page, void *fsdata);
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388struct address_space {
389 struct inode *host; /* owner: inode, block_device */
390 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700391 spinlock_t tree_lock; /* and lock protecting it */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700392 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700393 struct rb_root i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800394 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Jan Kara08142572011-06-27 16:18:10 -0700395 /* Protected by tree_lock together with the radix tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800397 /* number of shadow or DAX exceptional entries */
398 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700400 const struct address_space_operations *a_ops; /* methods */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700401 unsigned long flags; /* error bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 spinlock_t private_lock; /* for use by the address_space */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700403 gfp_t gfp_mask; /* implicit gfp mask for allocations */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 struct list_head private_list; /* ditto */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800405 void *private_data; /* ditto */
Jeff Layton5660e132017-07-06 07:02:25 -0400406 errseq_t wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700407} __attribute__((aligned(sizeof(long)))) __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 /*
409 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300410 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
412 */
Andi Kleen87192a22012-01-12 17:20:34 -0800413struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415struct block_device {
416 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700417 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500419 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800420 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900421 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 void * bd_holder;
423 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100424 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800425#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100426 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800427#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 struct block_device * bd_contains;
429 unsigned bd_block_size;
430 struct hd_struct * bd_part;
431 /* number of times partitions within this device have been opened. */
432 unsigned bd_part_count;
433 int bd_invalidated;
434 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800435 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100436 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 /*
439 * Private data. You must have bd_claim'ed the block_device
440 * to use this. NOTE: bd_claim allows an owner to claim
441 * the same device multiple times, the owner must take special
442 * care to not mess up bd_private for that case.
443 */
444 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800445
446 /* The counter of freeze processes */
447 int bd_fsfreeze_count;
448 /* Mutex for freeze */
449 struct mutex bd_fsfreeze_mutex;
Kees Cook3859a272016-10-28 01:22:25 -0700450} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452/*
453 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
454 * radix trees
455 */
456#define PAGECACHE_TAG_DIRTY 0
457#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700458#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460int mapping_tagged(struct address_space *mapping, int tag);
461
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800462static inline void i_mmap_lock_write(struct address_space *mapping)
463{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800464 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800465}
466
467static inline void i_mmap_unlock_write(struct address_space *mapping)
468{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800469 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800470}
471
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800472static inline void i_mmap_lock_read(struct address_space *mapping)
473{
474 down_read(&mapping->i_mmap_rwsem);
475}
476
477static inline void i_mmap_unlock_read(struct address_space *mapping)
478{
479 up_read(&mapping->i_mmap_rwsem);
480}
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482/*
483 * Might pages of this file be mapped into userspace?
484 */
485static inline int mapping_mapped(struct address_space *mapping)
486{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800487 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488}
489
490/*
491 * Might pages of this file have been modified in userspace?
492 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
493 * marks vma as VM_SHARED if it is shared, and the file was opened for
494 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700495 *
496 * If i_mmap_writable is negative, no new writable mappings are allowed. You
497 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 */
499static inline int mapping_writably_mapped(struct address_space *mapping)
500{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700501 return atomic_read(&mapping->i_mmap_writable) > 0;
502}
503
504static inline int mapping_map_writable(struct address_space *mapping)
505{
506 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
507 0 : -EPERM;
508}
509
510static inline void mapping_unmap_writable(struct address_space *mapping)
511{
512 atomic_dec(&mapping->i_mmap_writable);
513}
514
515static inline int mapping_deny_writable(struct address_space *mapping)
516{
517 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
518 0 : -EBUSY;
519}
520
521static inline void mapping_allow_writable(struct address_space *mapping)
522{
523 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524}
525
526/*
527 * Use sequence counter to get consistent i_size on 32-bit processors.
528 */
529#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
530#include <linux/seqlock.h>
531#define __NEED_I_SIZE_ORDERED
532#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
533#else
534#define i_size_ordered_init(inode) do { } while (0)
535#endif
536
Al Virof19d4a82009-06-08 19:50:45 -0400537struct posix_acl;
538#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200539#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400540
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100541static inline struct posix_acl *
542uncached_acl_sentinel(struct task_struct *task)
543{
544 return (void *)task + 1;
545}
546
547static inline bool
548is_uncached_acl(struct posix_acl *acl)
549{
550 return (long)acl & 1;
551}
552
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700553#define IOP_FASTPERM 0x0001
554#define IOP_LOOKUP 0x0002
555#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200556#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100557#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700558
Jan Kara9dd813c2017-03-14 12:31:02 +0100559struct fsnotify_mark_connector;
560
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700561/*
562 * Keep mostly read-only and often accessed (especially for
563 * the RCU path lookup and 'stat' data) fields at the beginning
564 * of the 'struct inode'
565 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100567 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700568 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800569 kuid_t i_uid;
570 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700571 unsigned int i_flags;
572
573#ifdef CONFIG_FS_POSIX_ACL
574 struct posix_acl *i_acl;
575 struct posix_acl *i_default_acl;
576#endif
577
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100578 const struct inode_operations *i_op;
579 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700580 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100581
Linus Torvalds13e12d12011-06-08 15:18:19 -0700582#ifdef CONFIG_SECURITY
583 void *i_security;
584#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100585
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700586 /* Stat data, not accessed from path walking */
587 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200588 /*
589 * Filesystems may only read i_nlink directly. They shall use the
590 * following functions for modification:
591 *
592 * (set|clear|inc|drop)_nlink
593 * inode_(inc|dec)_link_count
594 */
595 union {
596 const unsigned int i_nlink;
597 unsigned int __i_nlink;
598 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700599 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700600 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700601 struct timespec i_atime;
602 struct timespec i_mtime;
603 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400604 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
605 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700606 unsigned int i_blkbits;
Jens Axboec75b1d92017-06-27 11:47:04 -0600607 enum rw_hint i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700608 blkcnt_t i_blocks;
609
610#ifdef __NEED_I_SIZE_ORDERED
611 seqcount_t i_size_seqcount;
612#endif
613
614 /* Misc */
615 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400616 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700617
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100618 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400619 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500622 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400623#ifdef CONFIG_CGROUP_WRITEBACK
624 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400625
626 /* foreign inode detection, see wbc_detach_inode() */
627 int i_wb_frn_winner;
628 u16 i_wb_frn_avg_time;
629 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400630#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100631 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700633 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100634 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400635 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100636 struct rcu_head i_rcu;
637 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500638 u64 i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700639 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400640 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400641 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500642#ifdef CONFIG_IMA
643 atomic_t i_readcount; /* struct files open RO */
644#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800645 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500646 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700649 union {
650 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700651 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700652 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400653 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400654 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700655 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657 __u32 i_generation;
658
Eric Paris3be25f42009-05-21 17:01:26 -0400659#ifdef CONFIG_FSNOTIFY
660 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100661 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400662#endif
663
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700664#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
665 struct fscrypt_info *i_crypt_info;
666#endif
667
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700668 void *i_private; /* fs or device private pointer */
Kees Cook3859a272016-10-28 01:22:25 -0700669} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670
Fabian Frederick93407472017-02-27 14:28:32 -0800671static inline unsigned int i_blocksize(const struct inode *node)
672{
673 return (1 << node->i_blkbits);
674}
675
Al Viro1d3382cb2010-10-23 15:19:20 -0400676static inline int inode_unhashed(struct inode *inode)
677{
678 return hlist_unhashed(&inode->i_hash);
679}
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700682 * inode->i_mutex nesting subclasses for the lock validator:
683 *
684 * 0: the object of the current VFS operation
685 * 1: parent
686 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400687 * 3: xattr
688 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100689 * 5: second parent (when locking independent directories in rename)
690 *
691 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400692 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700693 *
694 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100695 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700696 */
697enum inode_i_mutex_lock_class
698{
699 I_MUTEX_NORMAL,
700 I_MUTEX_PARENT,
701 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700702 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100703 I_MUTEX_NONDIR2,
704 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700705};
706
Al Viro59551022016-01-22 15:40:57 -0500707static inline void inode_lock(struct inode *inode)
708{
Al Viro9902af72016-04-15 15:08:36 -0400709 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500710}
711
712static inline void inode_unlock(struct inode *inode)
713{
Al Viro9902af72016-04-15 15:08:36 -0400714 up_write(&inode->i_rwsem);
715}
716
717static inline void inode_lock_shared(struct inode *inode)
718{
719 down_read(&inode->i_rwsem);
720}
721
722static inline void inode_unlock_shared(struct inode *inode)
723{
724 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500725}
726
727static inline int inode_trylock(struct inode *inode)
728{
Al Viro9902af72016-04-15 15:08:36 -0400729 return down_write_trylock(&inode->i_rwsem);
730}
731
732static inline int inode_trylock_shared(struct inode *inode)
733{
734 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500735}
736
737static inline int inode_is_locked(struct inode *inode)
738{
Al Viro9902af72016-04-15 15:08:36 -0400739 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500740}
741
742static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
743{
Al Viro9902af72016-04-15 15:08:36 -0400744 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500745}
746
J. Bruce Fields375e2892012-04-18 15:16:33 -0400747void lock_two_nondirectories(struct inode *, struct inode*);
748void unlock_two_nondirectories(struct inode *, struct inode*);
749
Ingo Molnarf2eace22006-07-03 00:25:05 -0700750/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 * NOTE: in a 32bit arch with a preemptable kernel and
752 * an UP compile the i_size_read/write must be atomic
753 * with respect to the local cpu (unlike with preempt disabled),
754 * but they don't need to be atomic with respect to other cpus like in
755 * true SMP (so they need either to either locally disable irq around
756 * the read or for example on x86 they can be still implemented as a
757 * cmpxchg8b without the need of the lock prefix). For SMP compiles
758 * and 64bit archs it makes no difference if preempt is enabled or not.
759 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800760static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
762#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
763 loff_t i_size;
764 unsigned int seq;
765
766 do {
767 seq = read_seqcount_begin(&inode->i_size_seqcount);
768 i_size = inode->i_size;
769 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
770 return i_size;
771#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
772 loff_t i_size;
773
774 preempt_disable();
775 i_size = inode->i_size;
776 preempt_enable();
777 return i_size;
778#else
779 return inode->i_size;
780#endif
781}
782
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700783/*
784 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
785 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
786 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
787 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788static inline void i_size_write(struct inode *inode, loff_t i_size)
789{
790#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700791 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 write_seqcount_begin(&inode->i_size_seqcount);
793 inode->i_size = i_size;
794 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700795 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
797 preempt_disable();
798 inode->i_size = i_size;
799 preempt_enable();
800#else
801 inode->i_size = i_size;
802#endif
803}
804
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800805static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806{
807 return MINOR(inode->i_rdev);
808}
809
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800810static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
812 return MAJOR(inode->i_rdev);
813}
814
815extern struct block_device *I_BDEV(struct inode *inode);
816
817struct fown_struct {
818 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700819 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
820 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800821 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 int signum; /* posix.1b rt signal to be delivered on IO */
823};
824
825/*
826 * Track a single file's readahead state
827 */
828struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700829 pgoff_t start; /* where readahead started */
830 unsigned int size; /* # of readahead pages */
831 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700832 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700833
Fengguang Wu937085a2007-10-16 01:24:31 -0700834 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700835 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700836 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Fengguang Wu5ce11102007-07-19 01:47:59 -0700839/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700840 * Check if @index falls in the readahead windows.
841 */
842static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
843{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700844 return (index >= ra->start &&
845 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700846}
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800849 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700850 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800851 struct rcu_head fu_rcuhead;
852 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800853 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500854 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800855 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700856
857 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800858 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700859 * Must not be taken from IRQ context.
860 */
861 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600862 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400863 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400865 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800866 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 loff_t f_pos;
868 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100869 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 struct file_ra_state f_ra;
871
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700872 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700873#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700875#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 /* needed for tty driver, and maybe others */
877 void *private_data;
878
879#ifdef CONFIG_EPOLL
880 /* Used by fs/eventpoll.c to link all the hooks to this file */
881 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800882 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883#endif /* #ifdef CONFIG_EPOLL */
884 struct address_space *f_mapping;
Jeff Layton5660e132017-07-06 07:02:25 -0400885 errseq_t f_wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700886} __randomize_layout
887 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530889struct file_handle {
890 __u32 handle_bytes;
891 int handle_type;
892 /* file identifier */
893 unsigned char f_handle[0];
894};
895
Al Virocb0942b2012-08-27 14:48:26 -0400896static inline struct file *get_file(struct file *f)
897{
898 atomic_long_inc(&f->f_count);
899 return f;
900}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700901#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400902#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400903#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
905#define MAX_NON_LFS ((1UL<<31) - 1)
906
907/* Page cache limit. The filesystems should put that into their s_maxbytes
908 limits, otherwise bad things can happen in VM. */
909#if BITS_PER_LONG==32
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700910#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911#elif BITS_PER_LONG==64
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700912#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913#endif
914
915#define FL_POSIX 1
916#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400917#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400919#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700921#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400923#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
924#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400925#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100926#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Benjamin Coddington50f21122017-04-11 12:50:09 -0400928#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
929
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700931 * Special return value from posix_lock_file() and vfs_lock_file() for
932 * asynchronous locking.
933 */
934#define FILE_LOCK_DEFERRED 1
935
Jeff Layton7ca76312014-09-01 19:04:48 -0400936/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200937typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Jeff Laytona7231a92015-01-16 15:05:56 -0500939struct file_lock;
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
943 void (*fl_release_private)(struct file_lock *);
944};
945
946struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400947 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400948 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400949 fl_owner_t (*lm_get_owner)(fl_owner_t);
950 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400951 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400952 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400953 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500954 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400955 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956};
957
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400958struct lock_manager {
959 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400960 /*
961 * NFSv4 and up also want opens blocked during the grace period;
962 * NLM doesn't care:
963 */
964 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400965};
966
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400967struct net;
968void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400969void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400970int locks_in_grace(struct net *);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400971int opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973/* that will die - we need it for nfs_lock_info */
974#include <linux/nfs_fs_i.h>
975
Jeff Layton1cb36012013-06-21 08:58:12 -0400976/*
977 * struct file_lock represents a generic "file lock". It's used to represent
978 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
979 * note that the same struct is used to represent both a request for a lock and
980 * the lock itself, but the same object is never used for both.
981 *
982 * FIXME: should we create a separate "struct lock_request" to help distinguish
983 * these two uses?
984 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500985 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -0400986 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500987 * 1) lock owner
988 * 2) lock range start
989 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -0400990 *
991 * Obviously, the last two criteria only matter for POSIX locks.
992 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993struct file_lock {
994 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -0500995 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -0400996 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 struct list_head fl_block; /* circular list of blocked processes */
998 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -0400999 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001000 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001002 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +00001003 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 wait_queue_head_t fl_wait;
1005 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 loff_t fl_start;
1007 loff_t fl_end;
1008
1009 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001010 /* for lease breaks: */
1011 unsigned long fl_break_time;
1012 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001014 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001015 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 union {
1017 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001018 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001019 struct {
1020 struct list_head link; /* link in AFS vnode's pending_locks list */
1021 int state; /* state of grant or error if -ve */
1022 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 } fl_u;
Kees Cook3859a272016-10-28 01:22:25 -07001024} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
Jeff Layton4a075e32015-01-16 15:05:54 -05001026struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001027 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001028 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001029 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001030 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001031};
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033/* The following constant reflects the upper bound of the file/locking space */
1034#ifndef OFFSET_MAX
1035#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1036#define OFFSET_MAX INT_LIMIT(loff_t)
1037#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1038#endif
1039
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001040extern void send_sigio(struct fown_struct *fown, int fd, int band);
1041
Miklos Szeredic568d682016-09-16 12:44:20 +02001042/*
1043 * Return the inode to use for locking
1044 *
1045 * For overlayfs this should be the overlay inode, not the real inode returned
1046 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1047 * equal.
1048 */
1049static inline struct inode *locks_inode(const struct file *f)
1050{
1051 return f->f_path.dentry->d_inode;
1052}
1053
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001054#ifdef CONFIG_FILE_LOCKING
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001055extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
Peter Staubachc2936212005-07-27 11:45:09 -07001056extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001057 struct flock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058
1059#if BITS_PER_LONG == 32
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001060extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
Peter Staubachc2936212005-07-27 11:45:09 -07001061extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001062 struct flock64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063#endif
1064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1066extern int fcntl_getlease(struct file *filp);
1067
1068/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001069void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001070void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001072extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001074extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001076extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001077extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001078extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001079extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001080extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001081extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001082extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001083extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001084extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001085extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001087extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1088extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001089extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001090struct files_struct;
1091extern void show_fd_locks(struct seq_file *f,
1092 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001093#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001094static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1095 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001096{
1097 return -EINVAL;
1098}
1099
1100static inline int fcntl_setlk(unsigned int fd, struct file *file,
1101 unsigned int cmd, struct flock __user *user)
1102{
1103 return -EACCES;
1104}
1105
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001106#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001107static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1108 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001109{
1110 return -EINVAL;
1111}
1112
1113static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1114 unsigned int cmd, struct flock64 __user *user)
1115{
1116 return -EACCES;
1117}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001118#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001119static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1120{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001121 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001122}
1123
1124static inline int fcntl_getlease(struct file *filp)
1125{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001126 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001127}
1128
Jeff Layton4a075e32015-01-16 15:05:54 -05001129static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001130locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001131{
1132}
1133
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001134static inline void locks_init_lock(struct file_lock *fl)
1135{
1136 return;
1137}
1138
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001139static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001140{
1141 return;
1142}
1143
1144static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1145{
1146 return;
1147}
1148
1149static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1150{
1151 return;
1152}
1153
Jeff Layton78ed8a12014-02-03 12:13:08 -05001154static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001155{
1156 return;
1157}
1158
1159static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1160{
1161 return;
1162}
1163
1164static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1165 struct file_lock *conflock)
1166{
1167 return -ENOLCK;
1168}
1169
Jeff Laytonf891a292013-06-21 08:58:09 -04001170static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001171{
1172 return -ENOENT;
1173}
1174
1175static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1176{
1177 return 0;
1178}
1179
1180static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1181 struct file_lock *fl, struct file_lock *conf)
1182{
1183 return -ENOLCK;
1184}
1185
1186static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1187{
1188 return 0;
1189}
1190
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001191static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1192{
1193 return -ENOLCK;
1194}
1195
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001196static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001197{
1198 return 0;
1199}
1200
1201static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1202{
1203 return;
1204}
1205
1206static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001207 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001208{
1209 return -EINVAL;
1210}
1211
1212static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001213 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001214{
1215 return -EINVAL;
1216}
1217
Jeff Layton7448cc32015-01-16 15:05:57 -05001218static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001219 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001220{
1221 return -EINVAL;
1222}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001223
1224struct files_struct;
1225static inline void show_fd_locks(struct seq_file *f,
1226 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001227#endif /* !CONFIG_FILE_LOCKING */
1228
Jeff Laytonee296d72015-07-11 06:43:03 -04001229static inline struct inode *file_inode(const struct file *f)
1230{
1231 return f->f_inode;
1232}
1233
Miklos Szeredid101a122016-03-26 16:14:37 -04001234static inline struct dentry *file_dentry(const struct file *file)
1235{
Miklos Szeredi2d902672016-06-30 08:53:27 +02001236 return d_real(file->f_path.dentry, file_inode(file), 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001237}
1238
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001239static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1240{
Miklos Szeredic568d682016-09-16 12:44:20 +02001241 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001242}
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001245 spinlock_t fa_lock;
1246 int magic;
1247 int fa_fd;
1248 struct fasync_struct *fa_next; /* singly linked list */
1249 struct file *fa_file;
1250 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251};
1252
1253#define FASYNC_MAGIC 0x4601
1254
1255/* SMP safe fasync helpers: */
1256extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001257extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1258extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1259extern struct fasync_struct *fasync_alloc(void);
1260extern void fasync_free(struct fasync_struct *);
1261
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262/* can be called from interrupts */
1263extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001265extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Jiri Slaby393cc3f2017-06-13 13:35:50 +02001266extern int f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001268extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269extern int send_sigurg(struct fown_struct *fown);
1270
Jan Kara5accdf82012-06-12 16:20:34 +02001271struct mm_struct;
1272
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273/*
1274 * Umount options
1275 */
1276
1277#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1278#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1279#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001280#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1281#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Tejun Heo46b15ca2015-06-16 18:48:31 -04001283/* sb->s_iflags */
1284#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001285#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001286#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
Eric W. Biederman8654df42016-06-09 16:06:06 -05001288/* sb->s_iflags to limit user namespace mounts */
1289#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
Jan Kara5accdf82012-06-12 16:20:34 +02001291/* Possible states of 'frozen' field */
1292enum {
1293 SB_UNFROZEN = 0, /* FS is unfrozen */
1294 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001295 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1296 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1297 * internal threads if needed) */
1298 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1299};
1300
1301#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1302
1303struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001304 int frozen; /* Is sb frozen? */
1305 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1306 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001307};
1308
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309struct super_block {
1310 struct list_head s_list; /* Keep this first */
1311 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001312 unsigned char s_blocksize_bits;
1313 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001314 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001316 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001317 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001318 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001319 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001321 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 unsigned long s_magic;
1323 struct dentry *s_root;
1324 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001327#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001329#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001330 const struct xattr_handler **s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001332 const struct fscrypt_operations *s_cop;
1333
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001334 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001335 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001337 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001338 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001339 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001340 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 struct quota_info s_dquot; /* Diskquota specific options */
1342
Jan Kara5accdf82012-06-12 16:20:34 +02001343 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Christoph Hellwig85787092017-05-10 15:06:33 +02001345 char s_id[32]; /* Informational name */
1346 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
1348 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001349 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001350 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001352 /* Granularity of c/m/atime in ns.
1353 Cannot be worse than a second */
1354 u32 s_time_gran;
1355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 /*
1357 * The next field is for VFS *only*. No filesystems have any business
1358 * even looking at it. You had been warned.
1359 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001360 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001362 /*
1363 * Filesystem subtype. If non-empty the filesystem type field
1364 * in /proc/mounts will be "type.subtype"
1365 */
1366 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001367
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 */
Kees Cook3859a272016-10-28 01:22:25 -07001416} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417
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);
Kees Cook3859a272016-10-28 01:22:25 -07001702} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703
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
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001751ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001752 unsigned long nr_segs, unsigned long fast_segs,
1753 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001754 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001755
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001756extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001757extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1759extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1760extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001761 unsigned long, loff_t *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001763 unsigned long, loff_t *, int);
Zach Brown29732932015-11-10 16:53:30 -05001764extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1765 loff_t, size_t, unsigned int);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001766extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1767 struct inode *inode_out, loff_t pos_out,
1768 u64 *len, bool is_dedupe);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001769extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1770 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001771extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1772 struct inode *dest, loff_t destoff,
1773 loff_t len, bool *is_same);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001774extern int vfs_dedupe_file_range(struct file *file,
1775 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777struct super_operations {
1778 struct inode *(*alloc_inode)(struct super_block *sb);
1779 void (*destroy_inode)(struct inode *);
1780
Christoph Hellwigaa385722011-05-27 06:53:02 -04001781 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001782 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001783 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001784 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001787 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001788 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001789 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001790 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001791 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001793 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Al Viro34c80b12011-12-08 21:32:45 -05001795 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001796 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001797 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001798 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001799#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1801 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001802 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001803#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001804 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001805 long (*nr_cached_objects)(struct super_block *,
1806 struct shrink_control *);
1807 long (*free_cached_objects)(struct super_block *,
1808 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809};
1810
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001811/*
David Howellsbbc10962012-10-15 16:40:35 +01001812 * Inode flags - they have no relation to superblock flags now
1813 */
1814#define S_SYNC 1 /* Writes are synced at once */
1815#define S_NOATIME 2 /* Do not update access times */
1816#define S_APPEND 4 /* Append-only file */
1817#define S_IMMUTABLE 8 /* Immutable file */
1818#define S_DEAD 16 /* removed, but still open directory */
1819#define S_NOQUOTA 32 /* Inode is not counted to quota */
1820#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1821#define S_NOCMTIME 128 /* Do not update file c/mtime */
1822#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1823#define S_PRIVATE 512 /* Inode is fs-internal */
1824#define S_IMA 1024 /* Inode has an associated IMA struct */
1825#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1826#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001827#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001828#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1829#else
1830#define S_DAX 0 /* Make all the DAX code disappear */
1831#endif
David Howellsbbc10962012-10-15 16:40:35 +01001832
1833/*
1834 * Note that nosuid etc flags are inode-specific: setting some file-system
1835 * flags just means all the inodes inherit those flags by default. It might be
1836 * possible to override it selectively if you really wanted to with some
1837 * ioctl() that is not currently implemented.
1838 *
1839 * Exception: MS_RDONLY is always applied to the entire file system.
1840 *
1841 * Unfortunately, it is possible to change a filesystems flags with it mounted
1842 * with files in use. This means that all of the inodes will not have their
1843 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1844 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1845 */
1846#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1847
1848#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1849#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1850 ((inode)->i_flags & S_SYNC))
1851#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1852 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1853#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1854#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1855#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1856
1857#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1858#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1859#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1860#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1861
1862#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1863#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1864#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1865#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1866#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1867#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1868#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001869#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
David Howellsbbc10962012-10-15 16:40:35 +01001870
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001871#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1872 (inode)->i_rdev == WHITEOUT_DEV)
1873
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001874static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1875{
1876 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1877}
1878
Jens Axboec75b1d92017-06-27 11:47:04 -06001879static inline enum rw_hint file_write_hint(struct file *file)
1880{
1881 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1882 return file->f_write_hint;
1883
1884 return file_inode(file)->i_write_hint;
1885}
1886
1887static inline int iocb_flags(struct file *file);
1888
1889static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1890{
1891 *kiocb = (struct kiocb) {
1892 .ki_filp = filp,
1893 .ki_flags = iocb_flags(filp),
1894 .ki_hint = file_write_hint(filp),
1895 };
1896}
1897
David Howellsbbc10962012-10-15 16:40:35 +01001898/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001899 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001900 *
1901 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1902 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1903 *
1904 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1905 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1906 * various stages of removing an inode.
1907 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001908 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001909 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001910 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1911 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001912 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1913 * these changes separately from I_DIRTY_SYNC so that we
1914 * don't have to write inode on fdatasync() when only
1915 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001916 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001917 * I_NEW Serves as both a mutex and completion notification.
1918 * New inodes set I_NEW. If two processes both create
1919 * the same inode, one of them will release its inode and
1920 * wait for I_NEW to be released before returning.
1921 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1922 * also cause waiting on I_NEW, without I_NEW actually
1923 * being set. find_inode() uses this to prevent returning
1924 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001925 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1926 * is zero. I_FREEING must be set when I_WILL_FREE is
1927 * cleared.
1928 * I_FREEING Set when inode is about to be freed but still has dirty
1929 * pages or buffers attached or the inode itself is still
1930 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001931 * I_CLEAR Added by clear_inode(). In this state the inode is
1932 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001933 *
1934 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1935 * prohibited for many purposes. iget() must wait for
1936 * the inode to be completely released, then create it
1937 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001938 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001939 *
Jan Kara169ebd92012-05-03 14:48:03 +02001940 * I_SYNC Writeback of inode is running. The bit is set during
1941 * data writeback, and cleared with a wakeup on the bit
1942 * address once it is done. The bit is also used to pin
1943 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001944 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001945 * I_REFERENCED Marks the inode as recently references on the LRU list.
1946 *
1947 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1948 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001949 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1950 * synchronize competing switching instances and to tell
1951 * wb stat updates to grab mapping->tree_lock. See
1952 * inode_switch_wb_work_fn() for details.
1953 *
Amir Goldsteinad0af712017-06-21 15:28:32 +03001954 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
1955 * and work dirs among overlayfs mounts.
1956 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001957 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001958 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001959#define I_DIRTY_SYNC (1 << 0)
1960#define I_DIRTY_DATASYNC (1 << 1)
1961#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001962#define __I_NEW 3
1963#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001964#define I_WILL_FREE (1 << 4)
1965#define I_FREEING (1 << 5)
1966#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001967#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001968#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04001969#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001970#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05001971#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04001972#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001973#define I_DIRTY_TIME (1 << 11)
1974#define __I_DIRTY_TIME_EXPIRED 12
1975#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04001976#define I_WB_SWITCH (1 << 13)
Amir Goldsteinad0af712017-06-21 15:28:32 +03001977#define I_OVL_INUSE (1 << 14)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
1979#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001980#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
1982extern void __mark_inode_dirty(struct inode *, int);
1983static inline void mark_inode_dirty(struct inode *inode)
1984{
1985 __mark_inode_dirty(inode, I_DIRTY);
1986}
1987
1988static inline void mark_inode_dirty_sync(struct inode *inode)
1989{
1990 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1991}
1992
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001993extern void inc_nlink(struct inode *inode);
1994extern void drop_nlink(struct inode *inode);
1995extern void clear_nlink(struct inode *inode);
1996extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07001997
1998static inline void inode_inc_link_count(struct inode *inode)
1999{
2000 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002001 mark_inode_dirty(inode);
2002}
2003
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002004static inline void inode_dec_link_count(struct inode *inode)
2005{
2006 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002007 mark_inode_dirty(inode);
2008}
2009
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05002010/**
2011 * inode_inc_iversion - increments i_version
2012 * @inode: inode that need to be updated
2013 *
2014 * Every time the inode is modified, the i_version field will be incremented.
2015 * The filesystem has to be mounted with i_version flag
2016 */
2017
2018static inline void inode_inc_iversion(struct inode *inode)
2019{
2020 spin_lock(&inode->i_lock);
2021 inode->i_version++;
2022 spin_unlock(&inode->i_lock);
2023}
2024
Josef Bacikc3b2da32012-03-26 09:59:21 -04002025enum file_time_flags {
2026 S_ATIME = 1,
2027 S_MTIME = 2,
2028 S_CTIME = 4,
2029 S_VERSION = 8,
2030};
2031
Al Virobadcf2b2013-07-16 18:15:46 +04002032extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033static inline void file_accessed(struct file *file)
2034{
2035 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002036 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037}
2038
2039int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002040int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042struct file_system_type {
2043 const char *name;
2044 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002045#define FS_REQUIRES_DEV 1
2046#define FS_BINARY_MOUNTDATA 2
2047#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002048#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002049#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002050 struct dentry *(*mount) (struct file_system_type *, int,
2051 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 void (*kill_sb) (struct super_block *);
2053 struct module *owner;
2054 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002055 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002056
Ingo Molnarcf516242006-07-03 00:25:27 -07002057 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002058 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002059 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002060 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002061
2062 struct lock_class_key i_lock_key;
2063 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002064 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065};
2066
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002067#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2068
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002069extern struct dentry *mount_ns(struct file_system_type *fs_type,
2070 int flags, void *data, void *ns, struct user_namespace *user_ns,
2071 int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04002072extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2073 int flags, const char *dev_name, void *data,
2074 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002075extern struct dentry *mount_single(struct file_system_type *fs_type,
2076 int flags, void *data,
2077 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002078extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2079 int flags, void *data,
2080 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002081extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082void generic_shutdown_super(struct super_block *sb);
2083void kill_block_super(struct super_block *sb);
2084void kill_anon_super(struct super_block *sb);
2085void kill_litter_super(struct super_block *sb);
2086void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002087void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002089int get_anon_bdev(dev_t *);
2090void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002091struct super_block *sget_userns(struct file_system_type *type,
2092 int (*test)(struct super_block *,void *),
2093 int (*set)(struct super_block *,void *),
2094 int flags, struct user_namespace *user_ns,
2095 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096struct super_block *sget(struct file_system_type *type,
2097 int (*test)(struct super_block *,void *),
2098 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002099 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002100extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2101 const struct super_operations *ops,
2102 const struct xattr_handler **xattr,
2103 const struct dentry_operations *dops,
2104 unsigned long);
2105
2106static inline struct dentry *
2107mount_pseudo(struct file_system_type *fs_type, char *name,
2108 const struct super_operations *ops,
2109 const struct dentry_operations *dops, unsigned long magic)
2110{
2111 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2112}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
2114/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2115#define fops_get(fops) \
2116 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2117#define fops_put(fops) \
2118 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002119/*
2120 * This one is to be used *ONLY* from ->open() instances.
2121 * fops must be non-NULL, pinned down *and* module dependencies
2122 * should be sufficient to pin the caller down as well.
2123 */
2124#define replace_fops(f, fops) \
2125 do { \
2126 struct file *__file = (f); \
2127 fops_put(__file->f_op); \
2128 BUG_ON(!(__file->f_op = (fops))); \
2129 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
2131extern int register_filesystem(struct file_system_type *);
2132extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002133extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2134#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002135extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136extern int may_umount_tree(struct vfsmount *);
2137extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002138extern long do_mount(const char *, const char __user *,
2139 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002140extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002141extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002142extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2143 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002144extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002145extern int user_statfs(const char __user *, struct kstatfs *);
2146extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002147extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002148extern int freeze_super(struct super_block *super);
2149extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002150extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002151extern __printf(2, 3)
2152int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2153extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
Al Viroce3b0f82009-03-29 19:08:22 -04002155extern int current_umask(void);
2156
J. Bruce Fields5a146962012-08-28 07:50:40 -07002157extern void ihold(struct inode * inode);
2158extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002159extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002160
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002161/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002162extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002163
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002164#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002165
Jeff Layton9e8925b2015-11-16 09:49:34 -05002166#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002167extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002168extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
2170/*
2171 * Candidates for mandatory locking have the setgid bit set
2172 * but no group execute bit - an otherwise meaningless combination.
2173 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002174
2175static inline int __mandatory_lock(struct inode *ino)
2176{
2177 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2178}
2179
2180/*
2181 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2182 * otherwise these will be advisory locks
2183 */
2184
2185static inline int mandatory_lock(struct inode *ino)
2186{
2187 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2188}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
Jeff Laytond7a06982014-03-10 09:54:15 -04002190static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191{
Miklos Szeredic568d682016-09-16 12:44:20 +02002192 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002193 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 return 0;
2195}
2196
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002198 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 loff_t size)
2200{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002201 if (!inode->i_flctx || !mandatory_lock(inode))
2202 return 0;
2203
2204 if (size < inode->i_size) {
2205 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2206 F_WRLCK);
2207 } else {
2208 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2209 F_WRLCK);
2210 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211}
2212
Jeff Layton9e8925b2015-11-16 09:49:34 -05002213#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2214
2215static inline int locks_mandatory_locked(struct file *file)
2216{
2217 return 0;
2218}
2219
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002220static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2221 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002222{
2223 return 0;
2224}
2225
2226static inline int __mandatory_lock(struct inode *inode)
2227{
2228 return 0;
2229}
2230
2231static inline int mandatory_lock(struct inode *inode)
2232{
2233 return 0;
2234}
2235
2236static inline int locks_verify_locked(struct file *file)
2237{
2238 return 0;
2239}
2240
2241static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2242 size_t size)
2243{
2244 return 0;
2245}
2246
2247#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2248
2249
2250#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251static inline int break_lease(struct inode *inode, unsigned int mode)
2252{
Jeff Layton24cbe782014-02-03 12:13:06 -05002253 /*
2254 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002255 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2256 * could end up racing with tasks trying to set a new lease on this
2257 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002258 */
2259 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002260 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002261 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 return 0;
2263}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002264
2265static inline int break_deleg(struct inode *inode, unsigned int mode)
2266{
Jeff Layton962bd402014-06-10 12:24:40 -04002267 /*
2268 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002269 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2270 * could end up racing with tasks trying to set a new lease on this
2271 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002272 */
2273 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002274 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002275 return __break_lease(inode, mode, FL_DELEG);
2276 return 0;
2277}
2278
J. Bruce Fields5a146962012-08-28 07:50:40 -07002279static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2280{
2281 int ret;
2282
2283 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2284 if (ret == -EWOULDBLOCK && delegated_inode) {
2285 *delegated_inode = inode;
2286 ihold(inode);
2287 }
2288 return ret;
2289}
2290
2291static inline int break_deleg_wait(struct inode **delegated_inode)
2292{
2293 int ret;
2294
2295 ret = break_deleg(*delegated_inode, O_WRONLY);
2296 iput(*delegated_inode);
2297 *delegated_inode = NULL;
2298 return ret;
2299}
2300
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002301static inline int break_layout(struct inode *inode, bool wait)
2302{
2303 smp_mb();
2304 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2305 return __break_lease(inode,
2306 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2307 FL_LAYOUT);
2308 return 0;
2309}
2310
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002311#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002312static inline int break_lease(struct inode *inode, unsigned int mode)
2313{
2314 return 0;
2315}
2316
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002317static inline int break_deleg(struct inode *inode, unsigned int mode)
2318{
2319 return 0;
2320}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002321
2322static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2323{
2324 return 0;
2325}
2326
2327static inline int break_deleg_wait(struct inode **delegated_inode)
2328{
2329 BUG();
2330 return 0;
2331}
2332
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002333static inline int break_layout(struct inode *inode, bool wait)
2334{
2335 return 0;
2336}
2337
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002338#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339
2340/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002341struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002342struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002343 const char *name; /* pointer to actual string */
2344 const __user char *uptr; /* original userland pointer */
2345 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002346 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002347 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002348};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349
Al Viro7df818b2016-03-25 14:24:09 -04002350extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002351extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2352 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002353extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002354 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002355extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002356 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002357extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002358extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002359extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002360 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002361extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002363
David Drysdale51f39a12014-12-12 16:57:29 -08002364extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002365extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002366extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002367extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002368
Al Viro47237682012-06-10 05:01:45 -04002369enum {
2370 FILE_CREATED = 1,
2371 FILE_OPENED = 2
2372};
Al Viro30d90492012-06-22 12:40:19 +04002373extern int finish_open(struct file *file, struct dentry *dentry,
2374 int (*open)(struct inode *, struct file *),
2375 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002376extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002378/* fs/ioctl.c */
2379
2380extern int ioctl_preallocate(struct file *filp, void __user *argp);
2381
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382/* fs/dcache.c */
2383extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002384extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385
Christoph Lameterb86c0892006-12-06 20:32:57 -08002386extern struct kmem_cache *names_cachep;
2387
Jeff Laytona608ca22012-10-10 15:25:26 -04002388#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002389#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390
David Howells93614012006-09-30 20:45:40 +02002391#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002393extern void unregister_blkdev(unsigned int, const char *);
Jan Karaf44f1ab2017-02-02 15:56:49 +01002394extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002396extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397extern void bd_set_size(struct block_device *, loff_t size);
2398extern void bd_forget(struct inode *inode);
2399extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002400extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002401extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002402extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002403extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002404extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002405extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002406extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2407extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002408
2409extern struct super_block *blockdev_superblock;
2410
2411static inline bool sb_is_blkdev_sb(struct super_block *sb)
2412{
2413 return sb == blockdev_superblock;
2414}
David Howells93614012006-09-30 20:45:40 +02002415#else
2416static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002417static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002418static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002419static inline void invalidate_bdev(struct block_device *bdev) {}
2420
2421static inline struct super_block *freeze_bdev(struct block_device *sb)
2422{
2423 return NULL;
2424}
2425
2426static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2427{
2428 return 0;
2429}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002430
2431static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2432{
2433}
Jan Karaa8855992013-07-09 22:36:45 +08002434
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002435static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002436{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002437 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002438}
David Howells93614012006-09-30 20:45:40 +02002439#endif
Jan Kara60b06802009-04-27 16:43:53 +02002440extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002441extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002442extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002443#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002445extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002447extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002448extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2449 void *holder);
2450extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2451 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002452extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002453extern int __blkdev_reread_part(struct block_device *bdev);
2454extern int blkdev_reread_part(struct block_device *bdev);
2455
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002456#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002457extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002458extern void bd_unlink_disk_holder(struct block_device *bdev,
2459 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002460#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002461static inline int bd_link_disk_holder(struct block_device *bdev,
2462 struct gendisk *disk)
2463{
2464 return 0;
2465}
Tejun Heo49731ba2011-01-14 18:43:57 +01002466static inline void bd_unlink_disk_holder(struct block_device *bdev,
2467 struct gendisk *disk)
2468{
2469}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002470#endif
David Howells93614012006-09-30 20:45:40 +02002471#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472
2473/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002474#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Walleij49db08c2016-02-19 15:36:07 +01002475/* Marks the bottom of the first segment of free char majors */
2476#define CHRDEV_MAJOR_DYN_END 234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2478extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002479extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2480 unsigned int count, const char *name,
2481 const struct file_operations *fops);
2482extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2483 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002485extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486
Tejun Heo1905b1b2009-08-06 18:13:23 +09002487static inline int register_chrdev(unsigned int major, const char *name,
2488 const struct file_operations *fops)
2489{
2490 return __register_chrdev(major, 0, 256, name, fops);
2491}
2492
2493static inline void unregister_chrdev(unsigned int major, const char *name)
2494{
2495 __unregister_chrdev(major, 0, 256, name);
2496}
2497
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498/* fs/block_dev.c */
2499#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002500#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002501
2502#ifdef CONFIG_BLOCK
2503#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504extern const char *__bdevname(dev_t, char *buffer);
2505extern const char *bdevname(struct block_device *bdev, char *buffer);
2506extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002507extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002508
David Howells93614012006-09-30 20:45:40 +02002509#else
2510#define BLKDEV_MAJOR_HASH_SIZE 0
2511#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512
2513extern void init_special_inode(struct inode *, umode_t, dev_t);
2514
2515/* Invalid inode operations -- fs/bad_inode.c */
2516extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002517extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518
Jens Axboec11f0c02016-08-05 08:11:04 -06002519#ifdef CONFIG_BLOCK
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002520extern void check_disk_size_change(struct gendisk *disk,
2521 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002522extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002524extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002526#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527unsigned long invalidate_mapping_pages(struct address_space *mapping,
2528 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002529
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530static inline void invalidate_remote_inode(struct inode *inode)
2531{
2532 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2533 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002534 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535}
2536extern int invalidate_inode_pages2(struct address_space *mapping);
2537extern int invalidate_inode_pages2_range(struct address_space *mapping,
2538 pgoff_t start, pgoff_t end);
2539extern int write_inode_now(struct inode *, int);
2540extern int filemap_fdatawrite(struct address_space *);
2541extern int filemap_flush(struct address_space *);
2542extern int filemap_fdatawait(struct address_space *);
Jeff Layton76341ca2017-07-06 07:02:22 -04002543extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002544extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2545 loff_t lend);
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002546extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2547 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548extern int filemap_write_and_wait(struct address_space *mapping);
2549extern int filemap_write_and_wait_range(struct address_space *mapping,
2550 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002551extern int __filemap_fdatawrite_range(struct address_space *mapping,
2552 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002553extern int filemap_fdatawrite_range(struct address_space *mapping,
2554 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002555extern int filemap_check_errors(struct address_space *mapping);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002556
Jeff Layton5660e132017-07-06 07:02:25 -04002557extern void __filemap_set_wb_err(struct address_space *mapping, int err);
2558extern int __must_check file_check_and_advance_wb_err(struct file *file);
2559extern int __must_check file_write_and_wait_range(struct file *file,
2560 loff_t start, loff_t end);
2561
2562/**
2563 * filemap_set_wb_err - set a writeback error on an address_space
2564 * @mapping: mapping in which to set writeback error
2565 * @err: error to be set in mapping
2566 *
2567 * When writeback fails in some way, we must record that error so that
2568 * userspace can be informed when fsync and the like are called. We endeavor
2569 * to report errors on any file that was open at the time of the error. Some
2570 * internal callers also need to know when writeback errors have occurred.
2571 *
2572 * When a writeback error occurs, most filesystems will want to call
2573 * filemap_set_wb_err to record the error in the mapping so that it will be
2574 * automatically reported whenever fsync is called on the file.
2575 *
2576 * FIXME: mention FS_* flag here?
2577 */
2578static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2579{
2580 /* Fastpath for common case of no error */
2581 if (unlikely(err))
2582 __filemap_set_wb_err(mapping, err);
2583}
2584
2585/**
2586 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2587 * @mapping: mapping to check for writeback errors
2588 * @since: previously-sampled errseq_t
2589 *
2590 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2591 * the given value was sampled.
2592 *
2593 * If it has then report the latest error set, otherwise return 0.
2594 */
2595static inline int filemap_check_wb_err(struct address_space *mapping,
2596 errseq_t since)
2597{
2598 return errseq_check(&mapping->wb_err, since);
2599}
2600
2601/**
2602 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2603 * @mapping: mapping to be sampled
2604 *
2605 * Writeback errors are always reported relative to a particular sample point
2606 * in the past. This function provides those sample points.
2607 */
2608static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2609{
2610 return errseq_sample(&mapping->wb_err);
2611}
2612
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002613extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2614 int datasync);
2615extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002616
2617/*
2618 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2619 * to already be updated for the write, and will return either the amount
2620 * of bytes passed in, or an error if syncing the file failed.
2621 */
2622static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002623{
Christoph Hellwige2592212016-04-07 08:52:01 -07002624 if (iocb->ki_flags & IOCB_DSYNC) {
2625 int ret = vfs_fsync_range(iocb->ki_filp,
2626 iocb->ki_pos - count, iocb->ki_pos - 1,
2627 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2628 if (ret)
2629 return ret;
2630 }
2631
2632 return count;
Al Virod311d792014-02-09 15:18:09 -05002633}
Christoph Hellwige2592212016-04-07 08:52:01 -07002634
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635extern void emergency_sync(void);
2636extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002637#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002639#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002640extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002641extern int inode_permission(struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002642extern int __inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002643extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002644extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645
Miklos Szeredif696a362008-07-31 13:41:58 +02002646static inline bool execute_ok(struct inode *inode)
2647{
2648 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2649}
2650
Al Viro8d71db42013-03-19 21:01:03 -04002651static inline void file_start_write(struct file *file)
2652{
2653 if (!S_ISREG(file_inode(file)->i_mode))
2654 return;
2655 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2656}
2657
Jan Kara5ae98f12013-05-04 00:11:23 +02002658static inline bool file_start_write_trylock(struct file *file)
2659{
2660 if (!S_ISREG(file_inode(file)->i_mode))
2661 return true;
2662 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2663}
2664
Al Viro8d71db42013-03-19 21:01:03 -04002665static inline void file_end_write(struct file *file)
2666{
2667 if (!S_ISREG(file_inode(file)->i_mode))
2668 return;
2669 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2670}
2671
Amir Goldsteinbfe219d2017-01-31 10:34:57 +02002672static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
2673 struct file *file_out, loff_t pos_out,
2674 u64 len)
2675{
2676 int ret;
2677
2678 file_start_write(file_out);
2679 ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
2680 file_end_write(file_out);
2681
2682 return ret;
2683}
2684
Al Viro07b8ce12011-06-20 10:52:57 -04002685/*
2686 * get_write_access() gets write permission for a file.
2687 * put_write_access() releases this write permission.
2688 * This is used for regular files.
2689 * We cannot support write (and maybe mmap read-write shared) accesses and
2690 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2691 * can have the following values:
2692 * 0: no writers, no VM_DENYWRITE mappings
2693 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2694 * > 0: (i_writecount) users are writing to the file.
2695 *
2696 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2697 * except for the cases where we don't hold i_writecount yet. Then we need to
2698 * use {get,deny}_write_access() - these functions check the sign and refuse
2699 * to do the change if sign is wrong.
2700 */
2701static inline int get_write_access(struct inode *inode)
2702{
2703 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2704}
2705static inline int deny_write_access(struct file *file)
2706{
Al Viro496ad9a2013-01-23 17:07:38 -05002707 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002708 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2709}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710static inline void put_write_access(struct inode * inode)
2711{
2712 atomic_dec(&inode->i_writecount);
2713}
2714static inline void allow_write_access(struct file *file)
2715{
2716 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002717 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718}
David Howellsf1fe29b2013-09-27 11:20:03 +01002719static inline bool inode_is_open_for_write(const struct inode *inode)
2720{
2721 return atomic_read(&inode->i_writecount) > 0;
2722}
2723
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002724#ifdef CONFIG_IMA
2725static inline void i_readcount_dec(struct inode *inode)
2726{
2727 BUG_ON(!atomic_read(&inode->i_readcount));
2728 atomic_dec(&inode->i_readcount);
2729}
2730static inline void i_readcount_inc(struct inode *inode)
2731{
2732 atomic_inc(&inode->i_readcount);
2733}
2734#else
2735static inline void i_readcount_dec(struct inode *inode)
2736{
2737 return;
2738}
2739static inline void i_readcount_inc(struct inode *inode)
2740{
2741 return;
2742}
2743#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002744extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745
Mimi Zohar1284ab52016-04-20 15:46:27 -07002746#define __kernel_read_file_id(id) \
2747 id(UNKNOWN, unknown) \
2748 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002749 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002750 id(MODULE, kernel-module) \
2751 id(KEXEC_IMAGE, kexec-image) \
2752 id(KEXEC_INITRAMFS, kexec-initramfs) \
2753 id(POLICY, security-policy) \
2754 id(MAX_ID, )
2755
2756#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2757#define __fid_stringify(dummy, str) #str,
2758
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002759enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002760 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002761};
2762
Mimi Zohar1284ab52016-04-20 15:46:27 -07002763static const char * const kernel_read_file_str[] = {
2764 __kernel_read_file_id(__fid_stringify)
2765};
2766
Kees Cookda20dfe2016-04-21 12:53:29 -07002767static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002768{
Arnd Bergmanncbfd0c12017-03-09 16:16:57 -08002769 if ((unsigned)id >= READING_MAX_ID)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002770 return kernel_read_file_str[READING_UNKNOWN];
2771
2772 return kernel_read_file_str[id];
2773}
2774
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002775extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2776 enum kernel_read_file_id);
Mimi Zohar09596b92015-11-19 12:39:22 -05002777extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2778 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002779extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2780 enum kernel_read_file_id);
Christoph Hellwigbdd1d2d2017-09-01 17:39:13 +02002781extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
Al Viro7bb307e2013-02-23 14:51:48 -05002782extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002783extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784extern struct file * open_exec(const char *);
2785
2786/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002787extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002788extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002790extern char *file_path(struct file *, char *, int);
2791
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792#include <linux/err.h>
2793
2794/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002795extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796
Andrew Morton965c8e52012-12-17 15:59:39 -08002797extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798
Christoph Hellwig54e34622009-08-07 14:38:25 -03002799extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002801extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802extern struct inode * igrab(struct inode *);
2803extern ino_t iunique(struct super_block *, ino_t);
2804extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002805extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002806static inline int generic_drop_inode(struct inode *inode)
2807{
2808 return !inode->i_nlink || inode_unhashed(inode);
2809}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002811extern struct inode *ilookup5_nowait(struct super_block *sb,
2812 unsigned long hashval, int (*test)(struct inode *, void *),
2813 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2815 int (*test)(struct inode *, void *), void *data);
2816extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2817
2818extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2819extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002820extern struct inode *find_inode_nowait(struct super_block *,
2821 unsigned long,
2822 int (*match)(struct inode *,
2823 unsigned long, void *),
2824 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002825extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2826extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002827#ifdef CONFIG_DEBUG_LOCK_ALLOC
2828extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2829#else
2830static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2831#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002833extern unsigned int get_next_ino(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002836extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002837extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002838extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002839extern struct inode *new_inode_pseudo(struct super_block *sb);
2840extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002841extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002842extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002843extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844
2845extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002846static inline void insert_inode_hash(struct inode *inode)
2847{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848 __insert_inode_hash(inode, inode->i_ino);
2849}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002850
2851extern void __remove_inode_hash(struct inode *);
2852static inline void remove_inode_hash(struct inode *inode)
2853{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002854 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002855 __remove_inode_hash(inode);
2856}
2857
Christoph Hellwig646ec462010-10-23 07:15:32 -04002858extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002859
David Howells93614012006-09-30 20:45:40 +02002860#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002861extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002862#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863extern int set_blocksize(struct block_device *, int);
2864extern int sb_set_blocksize(struct super_block *, int);
2865extern int sb_min_blocksize(struct super_block *, int);
2866
2867extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2868extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002869extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002870extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002871extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002872extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002873extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002874extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002875
Christoph Hellwig18e97102017-05-27 11:16:51 +03002876ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
2877 int flags);
Christoph Hellwigabbb65892017-05-27 11:16:52 +03002878ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
2879 int flags);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002880
Christoph Hellwigeef99382009-08-20 17:43:41 +02002881/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002882extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002883extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002884extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2885 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002886extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002887
Andrew Morton88e6fae2006-04-11 13:59:36 +02002888/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002889extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002890 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002891extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002892 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002893extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002894 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002895extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2896 loff_t *opos, size_t len, unsigned int flags);
2897
Andrew Morton88e6fae2006-04-11 13:59:36 +02002898
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899extern void
2900file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002901extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2902extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002903extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002904extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002905extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002906 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002907extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2908 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002909extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2910extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911extern int generic_file_open(struct inode * inode, struct file * filp);
2912extern int nonseekable_open(struct inode * inode, struct file * filp);
2913
David Howells93614012006-09-30 20:45:40 +02002914#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05002915typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04002916 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917
2918enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002919 /* need locking between buffered and direct access */
2920 DIO_LOCKING = 0x01,
2921
2922 /* filesystem does not support filling holes */
2923 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002924
2925 /* filesystem can handle aio writes beyond i_size */
2926 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002927
2928 /* inode/fs/bdev does not need truncate protection */
2929 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930};
2931
Christoph Hellwig40553512017-06-03 09:37:58 +02002932void dio_end_io(struct bio *bio);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002933
Omar Sandoval17f8c842015-03-16 04:33:50 -07002934ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2935 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002936 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002937 dio_iodone_t end_io, dio_submit_t submit_io,
2938 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002939
Omar Sandoval17f8c842015-03-16 04:33:50 -07002940static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2941 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002942 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002943 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002945 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002946 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002947}
David Howells93614012006-09-30 20:45:40 +02002948#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002949
Trond Myklebust1d59d612012-05-31 12:22:33 -04002950void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002951
2952/*
2953 * inode_dio_begin - signal start of a direct I/O requests
2954 * @inode: inode the direct I/O happens on
2955 *
2956 * This is called once we've finished processing a direct I/O request,
2957 * and is used to wake up callers waiting for direct I/O to be quiesced.
2958 */
2959static inline void inode_dio_begin(struct inode *inode)
2960{
2961 atomic_inc(&inode->i_dio_count);
2962}
2963
2964/*
2965 * inode_dio_end - signal finish of a direct I/O requests
2966 * @inode: inode the direct I/O happens on
2967 *
2968 * This is called once we've finished processing a direct I/O request,
2969 * and is used to wake up callers waiting for direct I/O to be quiesced.
2970 */
2971static inline void inode_dio_end(struct inode *inode)
2972{
2973 if (atomic_dec_and_test(&inode->i_dio_count))
2974 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2975}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002976
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002977extern void inode_set_flags(struct inode *inode, unsigned int flags,
2978 unsigned int mask);
2979
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002980extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981
2982#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2983
Al Viro5d826c82014-03-14 13:42:45 -04002984extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05002986extern const char *page_get_link(struct dentry *, struct inode *,
2987 struct delayed_call *);
2988extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002989extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002990 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002992extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05002993extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00002995extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
2996extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002997void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002999void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000void inode_sub_bytes(struct inode *inode, loff_t bytes);
3001loff_t inode_get_bytes(struct inode *inode);
3002void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05003003const char *simple_get_link(struct dentry *, struct inode *,
3004 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04003005extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006
Al Viro5c0ba4e2013-05-15 13:52:59 -04003007extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008
David Howellsa528d352017-01-31 16:46:22 +00003009extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3010extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3011
3012static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3013{
David Howellsdeccf492017-05-04 23:30:16 +01003014 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3015 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003016}
3017static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3018{
David Howellsdeccf492017-05-04 23:30:16 +01003019 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
David Howellsa528d352017-01-31 16:46:22 +00003020 stat, STATX_BASIC_STATS);
3021}
3022static inline int vfs_fstatat(int dfd, const char __user *filename,
3023 struct kstat *stat, int flags)
3024{
David Howellsdeccf492017-05-04 23:30:16 +01003025 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3026 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003027}
3028static inline int vfs_fstat(int fd, struct kstat *stat)
3029{
3030 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3031}
3032
3033
Miklos Szeredid60874c2016-10-04 14:40:45 +02003034extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0ed2016-12-09 16:45:04 +01003035extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036
Steven Whitehousee9079cc2008-10-14 14:43:29 +01003037extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04003038 struct fiemap_extent_info *fieinfo,
3039 loff_t start, loff_t len,
3040 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04003041extern int generic_block_fiemap(struct inode *inode,
3042 struct fiemap_extent_info *fieinfo, u64 start,
3043 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044
David Howellsee416bc2017-07-04 17:25:16 +01003045extern struct file_system_type *get_filesystem(struct file_system_type *fs);
Miklos Szeredic18479f2007-10-18 23:39:11 -07003046extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047extern struct file_system_type *get_fs_type(const char *name);
3048extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003049extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01003050extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02003051extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01003053extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003054extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003055extern void iterate_supers_type(struct file_system_type *,
3056 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057
3058extern int dcache_dir_open(struct inode *, struct file *);
3059extern int dcache_dir_close(struct inode *, struct file *);
3060extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003061extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003062extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003063extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003064extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003065extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3067extern int simple_unlink(struct inode *, struct dentry *);
3068extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003069extern int simple_rename(struct inode *, struct dentry *,
3070 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003071extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072extern int simple_empty(struct dentry *);
3073extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003074extern int simple_write_begin(struct file *file, struct address_space *mapping,
3075 loff_t pos, unsigned len, unsigned flags,
3076 struct page **pagep, void **fsdata);
3077extern int simple_write_end(struct file *file, struct address_space *mapping,
3078 loff_t pos, unsigned len, unsigned copied,
3079 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003080extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003081extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003082extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003083extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003084
Al Viro00cd8dd2012-06-10 17:13:09 -04003085extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003086extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003087extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003088extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003089extern void make_empty_dir_inode(struct inode *inode);
3090extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003091struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003093extern int simple_fill_super(struct super_block *, unsigned long,
3094 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003095extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096extern void simple_release_fs(struct vfsmount **mount, int *count);
3097
Akinobu Mita93b07112008-06-05 22:46:21 -07003098extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3099 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003100extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3101 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102
Fabian Frederickac13a822014-06-04 16:06:27 -07003103extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003104extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003105
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003106extern int generic_check_addressable(unsigned, u64);
3107
Christoph Lametere965f962006-02-01 03:05:41 -08003108#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003109extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003110 struct page *, struct page *,
3111 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003112#else
3113#define buffer_migrate_page NULL
3114#endif
3115
Jan Kara31051c82016-05-26 16:55:18 +02003116extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003117extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003118extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119
Josef Bacikc3b2da32012-03-26 09:59:21 -04003120extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003122static inline bool io_is_direct(struct file *filp)
3123{
Dan Williams65f87ee2016-01-25 17:23:18 -08003124 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003125}
3126
Dan Williamsbaabda22017-07-10 15:48:25 -07003127static inline bool vma_is_dax(struct vm_area_struct *vma)
3128{
3129 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3130}
3131
Al Viro2ba48ce2015-04-09 13:52:01 -04003132static inline int iocb_flags(struct file *file)
3133{
3134 int res = 0;
3135 if (file->f_flags & O_APPEND)
3136 res |= IOCB_APPEND;
3137 if (io_is_direct(file))
3138 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003139 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3140 res |= IOCB_DSYNC;
3141 if (file->f_flags & __O_SYNC)
3142 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003143 return res;
3144}
3145
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003146static inline int kiocb_set_rw_flags(struct kiocb *ki, int flags)
3147{
3148 if (unlikely(flags & ~RWF_SUPPORTED))
3149 return -EOPNOTSUPP;
3150
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003151 if (flags & RWF_NOWAIT) {
3152 if (!(ki->ki_filp->f_mode & FMODE_AIO_NOWAIT))
3153 return -EOPNOTSUPP;
3154 ki->ki_flags |= IOCB_NOWAIT;
3155 }
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003156 if (flags & RWF_HIPRI)
3157 ki->ki_flags |= IOCB_HIPRI;
3158 if (flags & RWF_DSYNC)
3159 ki->ki_flags |= IOCB_DSYNC;
3160 if (flags & RWF_SYNC)
3161 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
3162 return 0;
3163}
3164
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165static inline ino_t parent_ino(struct dentry *dentry)
3166{
3167 ino_t res;
3168
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003169 /*
3170 * Don't strictly need d_lock here? If the parent ino could change
3171 * then surely we'd have a deeper race in the caller?
3172 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173 spin_lock(&dentry->d_lock);
3174 res = dentry->d_parent->d_inode->i_ino;
3175 spin_unlock(&dentry->d_lock);
3176 return res;
3177}
3178
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179/* Transaction based IO helpers */
3180
3181/*
3182 * An argresp is stored in an allocated page and holds the
3183 * size of the argument or response, along with its content
3184 */
3185struct simple_transaction_argresp {
3186 ssize_t size;
3187 char data[0];
3188};
3189
3190#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3191
3192char *simple_transaction_get(struct file *file, const char __user *buf,
3193 size_t size);
3194ssize_t simple_transaction_read(struct file *file, char __user *buf,
3195 size_t size, loff_t *pos);
3196int simple_transaction_release(struct inode *inode, struct file *file);
3197
Ingo Molnar76791ab2009-03-25 16:48:35 +01003198void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003200/*
3201 * simple attribute files
3202 *
3203 * These attributes behave similar to those in sysfs:
3204 *
3205 * Writing to an attribute immediately sets a value, an open file can be
3206 * written to multiple times.
3207 *
3208 * Reading from an attribute creates a buffer from the value that might get
3209 * read with multiple read calls. When the attribute has been read
3210 * completely, no further read calls are possible until the file is opened
3211 * again.
3212 *
3213 * All attributes contain a text representation of a numeric value
3214 * that are accessed with the get() and set() functions.
3215 */
3216#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3217static int __fops ## _open(struct inode *inode, struct file *file) \
3218{ \
3219 __simple_attr_check_format(__fmt, 0ull); \
3220 return simple_attr_open(inode, file, __get, __set, __fmt); \
3221} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003222static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003223 .owner = THIS_MODULE, \
3224 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003225 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003226 .read = simple_attr_read, \
3227 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003228 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003229}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003230
Joe Perchesb9075fa2011-10-31 17:11:33 -07003231static inline __printf(1, 2)
3232void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003233{
3234 /* don't do anything, just let the compiler check the arguments; */
3235}
3236
3237int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003238 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003239 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003240int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003241ssize_t simple_attr_read(struct file *file, char __user *buf,
3242 size_t len, loff_t *ppos);
3243ssize_t simple_attr_write(struct file *file, const char __user *buf,
3244 size_t len, loff_t *ppos);
3245
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003246struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003247int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003248 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003249int proc_nr_dentry(struct ctl_table *table, int write,
3250 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003251int proc_nr_inodes(struct ctl_table *table, int write,
3252 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003253int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003254
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003255#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003256#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3257
Al Viro6d125522009-12-24 06:58:56 -05003258#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003259#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003260 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003261
Yaowei Baid37177b2015-11-19 21:00:12 +08003262static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003263{
3264 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3265}
3266
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003267static inline int check_sticky(struct inode *dir, struct inode *inode)
3268{
3269 if (!(dir->i_mode & S_ISVTX))
3270 return 0;
3271
3272 return __check_sticky(dir, inode);
3273}
3274
Andi Kleen69b45732011-05-28 08:25:51 -07003275static inline void inode_has_no_xattr(struct inode *inode)
3276{
Al Viro9e1f1de2011-06-03 18:24:58 -04003277 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003278 inode->i_flags |= S_NOSEC;
3279}
3280
Al Viroa7400222014-10-21 15:20:42 -04003281static inline bool is_root_inode(struct inode *inode)
3282{
3283 return inode == inode->i_sb->s_root->d_inode;
3284}
3285
Al Viro5f99f4e2013-05-15 20:23:06 -04003286static inline bool dir_emit(struct dir_context *ctx,
3287 const char *name, int namelen,
3288 u64 ino, unsigned type)
3289{
3290 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3291}
3292static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3293{
3294 return ctx->actor(ctx, ".", 1, ctx->pos,
3295 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3296}
3297static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3298{
3299 return ctx->actor(ctx, "..", 2, ctx->pos,
3300 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3301}
3302static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3303{
3304 if (ctx->pos == 0) {
3305 if (!dir_emit_dot(file, ctx))
3306 return false;
3307 ctx->pos = 1;
3308 }
3309 if (ctx->pos == 1) {
3310 if (!dir_emit_dotdot(file, ctx))
3311 return false;
3312 ctx->pos = 2;
3313 }
3314 return true;
3315}
Al Viro5ded75e2013-05-15 21:02:48 -04003316static inline bool dir_relax(struct inode *inode)
3317{
Al Viro59551022016-01-22 15:40:57 -05003318 inode_unlock(inode);
3319 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003320 return !IS_DEADDIR(inode);
3321}
Al Viro5f99f4e2013-05-15 20:23:06 -04003322
Al Viroae053272016-05-12 20:36:01 -04003323static inline bool dir_relax_shared(struct inode *inode)
3324{
3325 inode_unlock_shared(inode);
3326 inode_lock_shared(inode);
3327 return !IS_DEADDIR(inode);
3328}
3329
Eric W. Biederman90f85722015-06-29 14:42:03 -05003330extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003331extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003332
Linus Torvalds1da177e2005-04-16 15:20:36 -07003333#endif /* _LINUX_FS_H */