blob: c930cbc193420978dc20b8310abc4f3a445fd69c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_FS_H
2#define _LINUX_FS_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004#include <linux/linkage.h>
5#include <linux/wait.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/kdev_t.h>
7#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04008#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/stat.h>
10#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100012#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070013#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/radix-tree.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070015#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040017#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050018#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080019#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080020#include <linux/rwsem.h>
Satyam Sharma3bd858a2007-07-17 15:00:08 +053021#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040022#include <linux/semaphore.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040023#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110024#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040025#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080026#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110027#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080028#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020029#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020030#include <linux/percpu-rwsem.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020031#include <linux/workqueue.h>
Oleg Nesterov8129ed22015-08-11 17:05:04 +020032#include <linux/percpu-rwsem.h>
Al Virofceef392015-12-29 15:58:39 -050033#include <linux/delayed_call.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010036#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010038struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040039struct bdi_writeback;
Christoph Hellwig2f8b5442016-11-01 07:40:13 -060040struct bio;
Christoph Hellwiga5694252007-07-17 04:04:28 -070041struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080042struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070043struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070044struct kiocb;
Alexey Dobriyan57cc7212011-01-10 08:18:25 +020045struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046struct pipe_inode_info;
47struct poll_table_struct;
48struct kstatfs;
49struct vm_area_struct;
50struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110051struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070052struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080053struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020054struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050055struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070056struct fscrypt_info;
57struct fscrypt_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Denis Cheng74bf17c2007-10-16 23:26:30 -070059extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070061extern void __init files_init(void);
62extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Jan Engelhardtdded4f42008-12-01 14:34:50 -080064extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070065extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030066extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080067extern struct inodes_stat_t inodes_stat;
68extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070069extern int sysctl_protected_symlinks;
70extern int sysctl_protected_hardlinks;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080071
Linus Torvalds1da177e2005-04-16 15:20:36 -070072struct buffer_head;
73typedef int (get_block_t)(struct inode *inode, sector_t iblock,
74 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110075typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020076 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
David Howellsbbc10962012-10-15 16:40:35 +010078#define MAY_EXEC 0x00000001
79#define MAY_WRITE 0x00000002
80#define MAY_READ 0x00000004
81#define MAY_APPEND 0x00000008
82#define MAY_ACCESS 0x00000010
83#define MAY_OPEN 0x00000020
84#define MAY_CHDIR 0x00000040
85/* called from RCU mode, don't block */
86#define MAY_NOT_BLOCK 0x00000080
87
88/*
89 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
90 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
91 */
92
93/* file is open for reading */
94#define FMODE_READ ((__force fmode_t)0x1)
95/* file is open for writing */
96#define FMODE_WRITE ((__force fmode_t)0x2)
97/* file is seekable */
98#define FMODE_LSEEK ((__force fmode_t)0x4)
99/* file can be accessed using pread */
100#define FMODE_PREAD ((__force fmode_t)0x8)
101/* file can be accessed using pwrite */
102#define FMODE_PWRITE ((__force fmode_t)0x10)
103/* File is opened for execution with sys_execve / sys_uselib */
104#define FMODE_EXEC ((__force fmode_t)0x20)
105/* File is opened with O_NDELAY (only set for block devices) */
106#define FMODE_NDELAY ((__force fmode_t)0x40)
107/* File is opened with O_EXCL (only set for block devices) */
108#define FMODE_EXCL ((__force fmode_t)0x80)
109/* File is opened using open(.., 3, ..) and is writeable only for ioctls
110 (specialy hack for floppy.c) */
111#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
112/* 32bit hashes as llseek() offset (for directories) */
113#define FMODE_32BITHASH ((__force fmode_t)0x200)
114/* 64bit hashes as llseek() offset (for directories) */
115#define FMODE_64BITHASH ((__force fmode_t)0x400)
116
117/*
118 * Don't update ctime and mtime.
119 *
120 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
121 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
122 */
123#define FMODE_NOCMTIME ((__force fmode_t)0x800)
124
125/* Expect random access pattern */
126#define FMODE_RANDOM ((__force fmode_t)0x1000)
127
128/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
129#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
130
131/* File is opened with O_PATH; almost nothing can be done with it */
132#define FMODE_PATH ((__force fmode_t)0x4000)
133
Linus Torvalds9c225f22014-03-03 09:36:58 -0800134/* File needs atomic accesses to f_pos */
135#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400136/* Write access to underlying fs */
137#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500138/* Has read method(s) */
139#define FMODE_CAN_READ ((__force fmode_t)0x20000)
140/* Has write method(s) */
141#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800142
David Howellsbbc10962012-10-15 16:40:35 +0100143/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800144#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100145
146/*
147 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
148 * that indicates that they should check the contents of the iovec are
149 * valid, but not check the memory that the iovec elements
150 * points too.
151 */
152#define CHECK_IOVEC_ONLY -1
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154/*
155 * Attribute flags. These should be or-ed together to figure out what
156 * has been changed!
157 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200158#define ATTR_MODE (1 << 0)
159#define ATTR_UID (1 << 1)
160#define ATTR_GID (1 << 2)
161#define ATTR_SIZE (1 << 3)
162#define ATTR_ATIME (1 << 4)
163#define ATTR_MTIME (1 << 5)
164#define ATTR_CTIME (1 << 6)
165#define ATTR_ATIME_SET (1 << 7)
166#define ATTR_MTIME_SET (1 << 8)
167#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
168#define ATTR_ATTR_FLAG (1 << 10)
169#define ATTR_KILL_SUID (1 << 11)
170#define ATTR_KILL_SGID (1 << 12)
171#define ATTR_FILE (1 << 13)
172#define ATTR_KILL_PRIV (1 << 14)
173#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
174#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200175#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200178 * Whiteout is represented by a char device. The following constants define the
179 * mode and device number to use.
180 */
181#define WHITEOUT_MODE 0
182#define WHITEOUT_DEV 0
183
184/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 * This is the Inode Attributes structure, used for notify_change(). It
186 * uses the above definitions as flags, to know which values have changed.
187 * Also, in this manner, a Filesystem can look at only the values it cares
188 * about. Basically, these are the attributes that the VFS layer can
189 * request to change from the FS layer.
190 *
191 * Derek Atkins <warlord@MIT.EDU> 94-10-20
192 */
193struct iattr {
194 unsigned int ia_valid;
195 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800196 kuid_t ia_uid;
197 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 loff_t ia_size;
199 struct timespec ia_atime;
200 struct timespec ia_mtime;
201 struct timespec ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800202
203 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300204 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800205 * implement an ftruncate() like method. NOTE: filesystem should
206 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
207 */
208 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210
211/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 * Includes for diskquotas.
213 */
214#include <linux/quota.h>
215
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200216/*
217 * Maximum number of layers of fs stack. Needs to be limited to
218 * prevent kernel stack overflow
219 */
220#define FILESYSTEM_MAX_STACK_DEPTH 2
221
Zach Brown994fc28c2005-12-15 14:28:17 -0800222/**
223 * enum positive_aop_returns - aop return codes with specific semantics
224 *
225 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
226 * completed, that the page is still locked, and
227 * should be considered active. The VM uses this hint
228 * to return the page to the active list -- it won't
229 * be a candidate for writeback again in the near
230 * future. Other callers must be careful to unlock
231 * the page if they get this return. Returned by
232 * writepage();
233 *
234 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
235 * unlocked it and the page might have been truncated.
236 * The caller should back up to acquiring a new page and
237 * trying again. The aop will be taking reasonable
238 * precautions not to livelock. If the caller held a page
239 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700240 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800241 *
242 * address_space_operation functions return these large constants to indicate
243 * special semantics to the caller. These are much larger than the bytes in a
244 * page to allow for functions that return the number of bytes operated on in a
245 * given page.
246 */
247
248enum positive_aop_returns {
249 AOP_WRITEPAGE_ACTIVATE = 0x80000,
250 AOP_TRUNCATED_PAGE = 0x80001,
251};
252
Nick Pigginafddba42007-10-16 01:25:01 -0700253#define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
Nick Piggin89e10782007-10-16 01:25:07 -0700254#define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
Nick Piggin54566b22009-01-04 12:00:53 -0800255#define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
256 * helper code (eg buffer layer)
257 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259/*
260 * oh the beauties of C type declarations.
261 */
262struct page;
263struct address_space;
264struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800266#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400267#define IOCB_APPEND (1 << 1)
268#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100269#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700270#define IOCB_DSYNC (1 << 4)
271#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500272#define IOCB_WRITE (1 << 6)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800273
274struct kiocb {
275 struct file *ki_filp;
276 loff_t ki_pos;
277 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
278 void *private;
279 int ki_flags;
280};
281
282static inline bool is_sync_kiocb(struct kiocb *kiocb)
283{
284 return kiocb->ki_complete == NULL;
285}
286
Al Viro2ba48ce2015-04-09 13:52:01 -0400287static inline int iocb_flags(struct file *file);
288
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800289static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
290{
291 *kiocb = (struct kiocb) {
292 .ki_filp = filp,
Al Viro2ba48ce2015-04-09 13:52:01 -0400293 .ki_flags = iocb_flags(filp),
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800294 };
295}
296
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700297/*
298 * "descriptor" for what we're up to with a read.
299 * This allows us to use the same read code yet
300 * have multiple different users of the data that
301 * we read from a file.
302 *
303 * The simplest case just copies the data to user
304 * mode.
305 */
306typedef struct {
307 size_t written;
308 size_t count;
309 union {
310 char __user *buf;
311 void *data;
312 } arg;
313 int error;
314} read_descriptor_t;
315
316typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
317 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319struct address_space_operations {
320 int (*writepage)(struct page *page, struct writeback_control *wbc);
321 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323 /* Write back some dirty pages from this mapping. */
324 int (*writepages)(struct address_space *, struct writeback_control *);
325
Andrew Morton4741c9f2006-03-24 03:18:11 -0800326 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 int (*set_page_dirty)(struct page *page);
328
329 int (*readpages)(struct file *filp, struct address_space *mapping,
330 struct list_head *pages, unsigned nr_pages);
331
Nick Pigginafddba42007-10-16 01:25:01 -0700332 int (*write_begin)(struct file *, struct address_space *mapping,
333 loff_t pos, unsigned len, unsigned flags,
334 struct page **pagep, void **fsdata);
335 int (*write_end)(struct file *, struct address_space *mapping,
336 loff_t pos, unsigned len, unsigned copied,
337 struct page *page, void *fsdata);
338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
340 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400341 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400342 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500343 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700344 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4a2012-01-12 17:19:34 -0800345 /*
Tang Chenef277c72013-07-08 16:00:21 -0700346 * migrate the contents of a page to the specified target. If
347 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4a2012-01-12 17:19:34 -0800348 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700349 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800350 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700351 bool (*isolate_page)(struct page *, isolate_mode_t);
352 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800353 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500354 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700355 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700356 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200357 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700358
359 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700360 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
361 sector_t *span);
362 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363};
364
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200365extern const struct address_space_operations empty_aops;
366
Nick Pigginafddba42007-10-16 01:25:01 -0700367/*
368 * pagecache_write_begin/pagecache_write_end must be used by general code
369 * to write into the pagecache.
370 */
371int pagecache_write_begin(struct file *, struct address_space *mapping,
372 loff_t pos, unsigned len, unsigned flags,
373 struct page **pagep, void **fsdata);
374
375int pagecache_write_end(struct file *, struct address_space *mapping,
376 loff_t pos, unsigned len, unsigned copied,
377 struct page *page, void *fsdata);
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379struct address_space {
380 struct inode *host; /* owner: inode, block_device */
381 struct radix_tree_root page_tree; /* radix tree of all pages */
Nick Piggin19fd6232008-07-25 19:45:32 -0700382 spinlock_t tree_lock; /* and lock protecting it */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700383 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -0700384 struct rb_root i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800385 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Jan Kara08142572011-06-27 16:18:10 -0700386 /* Protected by tree_lock together with the radix tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800388 /* number of shadow or DAX exceptional entries */
389 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700391 const struct address_space_operations *a_ops; /* methods */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700392 unsigned long flags; /* error bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 spinlock_t private_lock; /* for use by the address_space */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700394 gfp_t gfp_mask; /* implicit gfp mask for allocations */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 struct list_head private_list; /* ditto */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800396 void *private_data; /* ditto */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397} __attribute__((aligned(sizeof(long))));
398 /*
399 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300400 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
402 */
Andi Kleen87192a22012-01-12 17:20:34 -0800403struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405struct block_device {
406 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700407 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500409 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800410 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900411 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 void * bd_holder;
413 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100414 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800415#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100416 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800417#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 struct block_device * bd_contains;
419 unsigned bd_block_size;
420 struct hd_struct * bd_part;
421 /* number of times partitions within this device have been opened. */
422 unsigned bd_part_count;
423 int bd_invalidated;
424 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800425 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100426 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 /*
429 * Private data. You must have bd_claim'ed the block_device
430 * to use this. NOTE: bd_claim allows an owner to claim
431 * the same device multiple times, the owner must take special
432 * care to not mess up bd_private for that case.
433 */
434 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800435
436 /* The counter of freeze processes */
437 int bd_fsfreeze_count;
438 /* Mutex for freeze */
439 struct mutex bd_fsfreeze_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440};
441
442/*
443 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
444 * radix trees
445 */
446#define PAGECACHE_TAG_DIRTY 0
447#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700448#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450int mapping_tagged(struct address_space *mapping, int tag);
451
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800452static inline void i_mmap_lock_write(struct address_space *mapping)
453{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800454 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800455}
456
457static inline void i_mmap_unlock_write(struct address_space *mapping)
458{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800459 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800460}
461
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800462static inline void i_mmap_lock_read(struct address_space *mapping)
463{
464 down_read(&mapping->i_mmap_rwsem);
465}
466
467static inline void i_mmap_unlock_read(struct address_space *mapping)
468{
469 up_read(&mapping->i_mmap_rwsem);
470}
471
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472/*
473 * Might pages of this file be mapped into userspace?
474 */
475static inline int mapping_mapped(struct address_space *mapping)
476{
Kirill A. Shutemov27ba0642015-02-10 14:09:59 -0800477 return !RB_EMPTY_ROOT(&mapping->i_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
480/*
481 * Might pages of this file have been modified in userspace?
482 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
483 * marks vma as VM_SHARED if it is shared, and the file was opened for
484 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700485 *
486 * If i_mmap_writable is negative, no new writable mappings are allowed. You
487 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 */
489static inline int mapping_writably_mapped(struct address_space *mapping)
490{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700491 return atomic_read(&mapping->i_mmap_writable) > 0;
492}
493
494static inline int mapping_map_writable(struct address_space *mapping)
495{
496 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
497 0 : -EPERM;
498}
499
500static inline void mapping_unmap_writable(struct address_space *mapping)
501{
502 atomic_dec(&mapping->i_mmap_writable);
503}
504
505static inline int mapping_deny_writable(struct address_space *mapping)
506{
507 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
508 0 : -EBUSY;
509}
510
511static inline void mapping_allow_writable(struct address_space *mapping)
512{
513 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514}
515
516/*
517 * Use sequence counter to get consistent i_size on 32-bit processors.
518 */
519#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
520#include <linux/seqlock.h>
521#define __NEED_I_SIZE_ORDERED
522#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
523#else
524#define i_size_ordered_init(inode) do { } while (0)
525#endif
526
Al Virof19d4a82009-06-08 19:50:45 -0400527struct posix_acl;
528#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200529#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400530
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100531static inline struct posix_acl *
532uncached_acl_sentinel(struct task_struct *task)
533{
534 return (void *)task + 1;
535}
536
537static inline bool
538is_uncached_acl(struct posix_acl *acl)
539{
540 return (long)acl & 1;
541}
542
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700543#define IOP_FASTPERM 0x0001
544#define IOP_LOOKUP 0x0002
545#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200546#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100547#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700548
549/*
550 * Keep mostly read-only and often accessed (especially for
551 * the RCU path lookup and 'stat' data) fields at the beginning
552 * of the 'struct inode'
553 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100555 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700556 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800557 kuid_t i_uid;
558 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700559 unsigned int i_flags;
560
561#ifdef CONFIG_FS_POSIX_ACL
562 struct posix_acl *i_acl;
563 struct posix_acl *i_default_acl;
564#endif
565
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100566 const struct inode_operations *i_op;
567 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700568 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100569
Linus Torvalds13e12d12011-06-08 15:18:19 -0700570#ifdef CONFIG_SECURITY
571 void *i_security;
572#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100573
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700574 /* Stat data, not accessed from path walking */
575 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200576 /*
577 * Filesystems may only read i_nlink directly. They shall use the
578 * following functions for modification:
579 *
580 * (set|clear|inc|drop)_nlink
581 * inode_(inc|dec)_link_count
582 */
583 union {
584 const unsigned int i_nlink;
585 unsigned int __i_nlink;
586 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700587 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700588 loff_t i_size;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700589 struct timespec i_atime;
590 struct timespec i_mtime;
591 struct timespec i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400592 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
593 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700594 unsigned int i_blkbits;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700595 blkcnt_t i_blocks;
596
597#ifdef __NEED_I_SIZE_ORDERED
598 seqcount_t i_size_seqcount;
599#endif
600
601 /* Misc */
602 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400603 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700604
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100605 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400606 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500609 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400610#ifdef CONFIG_CGROUP_WRITEBACK
611 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400612
613 /* foreign inode detection, see wbc_detach_inode() */
614 int i_wb_frn_winner;
615 u16 i_wb_frn_avg_time;
616 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400617#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100618 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700620 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100621 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400622 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100623 struct rcu_head i_rcu;
624 };
Jean Noel Cordenner7a224222008-01-28 23:58:27 -0500625 u64 i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700626 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400627 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400628 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500629#ifdef CONFIG_IMA
630 atomic_t i_readcount; /* struct files open RO */
631#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800632 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500633 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700636 union {
637 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700638 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700639 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400640 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400641 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700642 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644 __u32 i_generation;
645
Eric Paris3be25f42009-05-21 17:01:26 -0400646#ifdef CONFIG_FSNOTIFY
647 __u32 i_fsnotify_mask; /* all events this inode cares about */
Eric Parise61ce862009-12-17 21:24:24 -0500648 struct hlist_head i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400649#endif
650
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700651#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
652 struct fscrypt_info *i_crypt_info;
653#endif
654
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700655 void *i_private; /* fs or device private pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656};
657
Al Viro1d3382cb2010-10-23 15:19:20 -0400658static inline int inode_unhashed(struct inode *inode)
659{
660 return hlist_unhashed(&inode->i_hash);
661}
662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700664 * inode->i_mutex nesting subclasses for the lock validator:
665 *
666 * 0: the object of the current VFS operation
667 * 1: parent
668 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400669 * 3: xattr
670 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100671 * 5: second parent (when locking independent directories in rename)
672 *
673 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400674 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700675 *
676 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100677 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700678 */
679enum inode_i_mutex_lock_class
680{
681 I_MUTEX_NORMAL,
682 I_MUTEX_PARENT,
683 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700684 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100685 I_MUTEX_NONDIR2,
686 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700687};
688
Al Viro59551022016-01-22 15:40:57 -0500689static inline void inode_lock(struct inode *inode)
690{
Al Viro9902af72016-04-15 15:08:36 -0400691 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500692}
693
694static inline void inode_unlock(struct inode *inode)
695{
Al Viro9902af72016-04-15 15:08:36 -0400696 up_write(&inode->i_rwsem);
697}
698
699static inline void inode_lock_shared(struct inode *inode)
700{
701 down_read(&inode->i_rwsem);
702}
703
704static inline void inode_unlock_shared(struct inode *inode)
705{
706 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500707}
708
709static inline int inode_trylock(struct inode *inode)
710{
Al Viro9902af72016-04-15 15:08:36 -0400711 return down_write_trylock(&inode->i_rwsem);
712}
713
714static inline int inode_trylock_shared(struct inode *inode)
715{
716 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500717}
718
719static inline int inode_is_locked(struct inode *inode)
720{
Al Viro9902af72016-04-15 15:08:36 -0400721 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500722}
723
724static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
725{
Al Viro9902af72016-04-15 15:08:36 -0400726 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500727}
728
J. Bruce Fields375e2892012-04-18 15:16:33 -0400729void lock_two_nondirectories(struct inode *, struct inode*);
730void unlock_two_nondirectories(struct inode *, struct inode*);
731
Ingo Molnarf2eace22006-07-03 00:25:05 -0700732/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 * NOTE: in a 32bit arch with a preemptable kernel and
734 * an UP compile the i_size_read/write must be atomic
735 * with respect to the local cpu (unlike with preempt disabled),
736 * but they don't need to be atomic with respect to other cpus like in
737 * true SMP (so they need either to either locally disable irq around
738 * the read or for example on x86 they can be still implemented as a
739 * cmpxchg8b without the need of the lock prefix). For SMP compiles
740 * and 64bit archs it makes no difference if preempt is enabled or not.
741 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800742static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
744#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
745 loff_t i_size;
746 unsigned int seq;
747
748 do {
749 seq = read_seqcount_begin(&inode->i_size_seqcount);
750 i_size = inode->i_size;
751 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
752 return i_size;
753#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
754 loff_t i_size;
755
756 preempt_disable();
757 i_size = inode->i_size;
758 preempt_enable();
759 return i_size;
760#else
761 return inode->i_size;
762#endif
763}
764
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700765/*
766 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
767 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
768 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
769 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770static inline void i_size_write(struct inode *inode, loff_t i_size)
771{
772#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700773 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 write_seqcount_begin(&inode->i_size_seqcount);
775 inode->i_size = i_size;
776 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700777 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
779 preempt_disable();
780 inode->i_size = i_size;
781 preempt_enable();
782#else
783 inode->i_size = i_size;
784#endif
785}
786
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800787static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788{
789 return MINOR(inode->i_rdev);
790}
791
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800792static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793{
794 return MAJOR(inode->i_rdev);
795}
796
797extern struct block_device *I_BDEV(struct inode *inode);
798
799struct fown_struct {
800 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700801 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
802 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800803 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 int signum; /* posix.1b rt signal to be delivered on IO */
805};
806
807/*
808 * Track a single file's readahead state
809 */
810struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700811 pgoff_t start; /* where readahead started */
812 unsigned int size; /* # of readahead pages */
813 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700814 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700815
Fengguang Wu937085a2007-10-16 01:24:31 -0700816 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700817 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700818 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
Fengguang Wu5ce11102007-07-19 01:47:59 -0700821/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700822 * Check if @index falls in the readahead windows.
823 */
824static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
825{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700826 return (index >= ra->start &&
827 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700828}
829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800831 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700832 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800833 struct rcu_head fu_rcuhead;
834 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800835 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500836 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800837 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700838
839 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800840 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700841 * Must not be taken from IRQ context.
842 */
843 spinlock_t f_lock;
Al Viro516e0cc2008-07-26 00:39:17 -0400844 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400846 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800847 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 loff_t f_pos;
849 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100850 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 struct file_ra_state f_ra;
852
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700853 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700854#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700856#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 /* needed for tty driver, and maybe others */
858 void *private_data;
859
860#ifdef CONFIG_EPOLL
861 /* Used by fs/eventpoll.c to link all the hooks to this file */
862 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800863 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864#endif /* #ifdef CONFIG_EPOLL */
865 struct address_space *f_mapping;
Al Virobd2a31d2014-03-04 14:54:22 -0500866} __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530868struct file_handle {
869 __u32 handle_bytes;
870 int handle_type;
871 /* file identifier */
872 unsigned char f_handle[0];
873};
874
Al Virocb0942b2012-08-27 14:48:26 -0400875static inline struct file *get_file(struct file *f)
876{
877 atomic_long_inc(&f->f_count);
878 return f;
879}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700880#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400881#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400882#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884#define MAX_NON_LFS ((1UL<<31) - 1)
885
886/* Page cache limit. The filesystems should put that into their s_maxbytes
887 limits, otherwise bad things can happen in VM. */
888#if BITS_PER_LONG==32
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300889#define MAX_LFS_FILESIZE (((loff_t)PAGE_SIZE << (BITS_PER_LONG-1))-1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890#elif BITS_PER_LONG==64
Al Viro614c3212012-10-10 01:06:20 -0400891#define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892#endif
893
894#define FL_POSIX 1
895#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400896#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400898#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700900#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400902#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
903#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400904#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100905#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
907/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700908 * Special return value from posix_lock_file() and vfs_lock_file() for
909 * asynchronous locking.
910 */
911#define FILE_LOCK_DEFERRED 1
912
Jeff Layton7ca76312014-09-01 19:04:48 -0400913/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200914typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Jeff Laytona7231a92015-01-16 15:05:56 -0500916struct file_lock;
917
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
920 void (*fl_release_private)(struct file_lock *);
921};
922
923struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400924 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400925 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400926 fl_owner_t (*lm_get_owner)(fl_owner_t);
927 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400928 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400929 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400930 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500931 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400932 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933};
934
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400935struct lock_manager {
936 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400937 /*
938 * NFSv4 and up also want opens blocked during the grace period;
939 * NLM doesn't care:
940 */
941 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400942};
943
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400944struct net;
945void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400946void locks_end_grace(struct lock_manager *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400947int locks_in_grace(struct net *);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400948int opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950/* that will die - we need it for nfs_lock_info */
951#include <linux/nfs_fs_i.h>
952
Jeff Layton1cb36012013-06-21 08:58:12 -0400953/*
954 * struct file_lock represents a generic "file lock". It's used to represent
955 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
956 * note that the same struct is used to represent both a request for a lock and
957 * the lock itself, but the same object is never used for both.
958 *
959 * FIXME: should we create a separate "struct lock_request" to help distinguish
960 * these two uses?
961 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500962 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -0400963 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500964 * 1) lock owner
965 * 2) lock range start
966 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -0400967 *
968 * Obviously, the last two criteria only matter for POSIX locks.
969 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970struct file_lock {
971 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -0500972 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -0400973 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 struct list_head fl_block; /* circular list of blocked processes */
975 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -0400976 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -0700977 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -0400979 int fl_link_cpu; /* what cpu's list is this on? */
Vitaliy Gusevab1f1612008-01-17 00:07:08 +0000980 struct pid *fl_nspid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 wait_queue_head_t fl_wait;
982 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 loff_t fl_start;
984 loff_t fl_end;
985
986 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400987 /* for lease breaks: */
988 unsigned long fl_break_time;
989 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Alexey Dobriyan6aed6282009-09-21 17:01:11 -0700991 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700992 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 union {
994 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000995 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -0700996 struct {
997 struct list_head link; /* link in AFS vnode's pending_locks list */
998 int state; /* state of grant or error if -ve */
999 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 } fl_u;
1001};
1002
Jeff Layton4a075e32015-01-16 15:05:54 -05001003struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001004 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001005 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001006 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001007 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001008};
1009
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010/* The following constant reflects the upper bound of the file/locking space */
1011#ifndef OFFSET_MAX
1012#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1013#define OFFSET_MAX INT_LIMIT(loff_t)
1014#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1015#endif
1016
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017#include <linux/fcntl.h>
1018
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001019extern void send_sigio(struct fown_struct *fown, int fd, int band);
1020
Miklos Szeredic568d682016-09-16 12:44:20 +02001021/*
1022 * Return the inode to use for locking
1023 *
1024 * For overlayfs this should be the overlay inode, not the real inode returned
1025 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1026 * equal.
1027 */
1028static inline struct inode *locks_inode(const struct file *f)
1029{
1030 return f->f_path.dentry->d_inode;
1031}
1032
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001033#ifdef CONFIG_FILE_LOCKING
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001034extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001035extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
1036 struct flock __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
1038#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001039extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
Peter Staubachc2936212005-07-27 11:45:09 -07001040extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
1041 struct flock64 __user *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042#endif
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1045extern int fcntl_getlease(struct file *filp);
1046
1047/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001048void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001049void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001051extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001053extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001055extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001056extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001057extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001058extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001059extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001060extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001061extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001062extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001063extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001064extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065extern void lease_get_mtime(struct inode *, struct timespec *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001066extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1067extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001068extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001069struct files_struct;
1070extern void show_fd_locks(struct seq_file *f,
1071 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001072#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001073static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1074 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001075{
1076 return -EINVAL;
1077}
1078
1079static inline int fcntl_setlk(unsigned int fd, struct file *file,
1080 unsigned int cmd, struct flock __user *user)
1081{
1082 return -EACCES;
1083}
1084
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001085#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001086static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1087 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001088{
1089 return -EINVAL;
1090}
1091
1092static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1093 unsigned int cmd, struct flock64 __user *user)
1094{
1095 return -EACCES;
1096}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001097#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001098static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1099{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001100 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001101}
1102
1103static inline int fcntl_getlease(struct file *filp)
1104{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001105 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001106}
1107
Jeff Layton4a075e32015-01-16 15:05:54 -05001108static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001109locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001110{
1111}
1112
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001113static inline void locks_init_lock(struct file_lock *fl)
1114{
1115 return;
1116}
1117
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001118static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001119{
1120 return;
1121}
1122
1123static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1124{
1125 return;
1126}
1127
1128static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1129{
1130 return;
1131}
1132
Jeff Layton78ed8a12014-02-03 12:13:08 -05001133static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001134{
1135 return;
1136}
1137
1138static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1139{
1140 return;
1141}
1142
1143static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1144 struct file_lock *conflock)
1145{
1146 return -ENOLCK;
1147}
1148
Jeff Laytonf891a292013-06-21 08:58:09 -04001149static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001150{
1151 return -ENOENT;
1152}
1153
1154static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1155{
1156 return 0;
1157}
1158
1159static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1160 struct file_lock *fl, struct file_lock *conf)
1161{
1162 return -ENOLCK;
1163}
1164
1165static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1166{
1167 return 0;
1168}
1169
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001170static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1171{
1172 return -ENOLCK;
1173}
1174
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001175static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001176{
1177 return 0;
1178}
1179
1180static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1181{
1182 return;
1183}
1184
1185static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001186 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001187{
1188 return -EINVAL;
1189}
1190
1191static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001192 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001193{
1194 return -EINVAL;
1195}
1196
Jeff Layton7448cc32015-01-16 15:05:57 -05001197static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001198 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001199{
1200 return -EINVAL;
1201}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001202
1203struct files_struct;
1204static inline void show_fd_locks(struct seq_file *f,
1205 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001206#endif /* !CONFIG_FILE_LOCKING */
1207
Jeff Laytonee296d72015-07-11 06:43:03 -04001208static inline struct inode *file_inode(const struct file *f)
1209{
1210 return f->f_inode;
1211}
1212
Miklos Szeredid101a122016-03-26 16:14:37 -04001213static inline struct dentry *file_dentry(const struct file *file)
1214{
Miklos Szeredi2d902672016-06-30 08:53:27 +02001215 return d_real(file->f_path.dentry, file_inode(file), 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001216}
1217
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001218static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1219{
Miklos Szeredic568d682016-09-16 12:44:20 +02001220 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001221}
1222
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223struct fasync_struct {
Eric Dumazet989a2972010-04-14 09:55:35 +00001224 spinlock_t fa_lock;
1225 int magic;
1226 int fa_fd;
1227 struct fasync_struct *fa_next; /* singly linked list */
1228 struct file *fa_file;
1229 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230};
1231
1232#define FASYNC_MAGIC 0x4601
1233
1234/* SMP safe fasync helpers: */
1235extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001236extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1237extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1238extern struct fasync_struct *fasync_alloc(void);
1239extern void fasync_free(struct fasync_struct *);
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241/* can be called from interrupts */
1242extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001244extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1245extern void f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001247extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248extern int send_sigurg(struct fown_struct *fown);
1249
Jan Kara5accdf82012-06-12 16:20:34 +02001250struct mm_struct;
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252/*
1253 * Umount options
1254 */
1255
1256#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1257#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1258#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001259#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1260#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Tejun Heo46b15ca2015-06-16 18:48:31 -04001262/* sb->s_iflags */
1263#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001264#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001265#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
Eric W. Biederman8654df42016-06-09 16:06:06 -05001267/* sb->s_iflags to limit user namespace mounts */
1268#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269
Jan Kara5accdf82012-06-12 16:20:34 +02001270/* Possible states of 'frozen' field */
1271enum {
1272 SB_UNFROZEN = 0, /* FS is unfrozen */
1273 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001274 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1275 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1276 * internal threads if needed) */
1277 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1278};
1279
1280#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1281
1282struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001283 int frozen; /* Is sb frozen? */
1284 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1285 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001286};
1287
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288struct super_block {
1289 struct list_head s_list; /* Keep this first */
1290 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001291 unsigned char s_blocksize_bits;
1292 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001293 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001295 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001296 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001297 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001298 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001300 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 unsigned long s_magic;
1302 struct dentry *s_root;
1303 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001306#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001308#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001309 const struct xattr_handler **s_xattr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001311 const struct fscrypt_operations *s_cop;
1312
Nick Pigginceb5bdc2011-01-07 17:50:05 +11001313 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001314 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001316 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001317 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001318 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001319 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 struct quota_info s_dquot; /* Diskquota specific options */
1321
Jan Kara5accdf82012-06-12 16:20:34 +02001322 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324 char s_id[32]; /* Informational name */
Linus Torvalds0bba0162011-04-12 15:21:04 -07001325 u8 s_uuid[16]; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
1327 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001328 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001329 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001331 /* Granularity of c/m/atime in ns.
1332 Cannot be worse than a second */
1333 u32 s_time_gran;
1334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 /*
1336 * The next field is for VFS *only*. No filesystems have any business
1337 * even looking at it. You had been warned.
1338 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001339 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001341 /*
1342 * Filesystem subtype. If non-empty the filesystem type field
1343 * in /proc/mounts will be "type.subtype"
1344 */
1345 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001346
1347 /*
1348 * Saved mount options for lazy filesystems using
1349 * generic_show_options()
1350 */
Arnd Bergmann4d2deb42010-02-24 20:01:56 +01001351 char __rcu *s_options;
Al Viroc8aebb02010-12-18 10:22:30 -05001352 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001353
1354 /*
1355 * Saved pool identifier for cleancache (-1 means none)
1356 */
1357 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001358
1359 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e822011-11-21 12:11:31 +01001360
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001361 /* Number of inodes with nlink == 0 but still referenced */
1362 atomic_long_t s_remove_count;
1363
Miklos Szeredi4ed5e822011-11-21 12:11:31 +01001364 /* Being remounted read-only */
1365 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001366
1367 /* AIO completions deferred from interrupt context */
1368 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001369 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001370
1371 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001372 * Owning user namespace and default context in which to
1373 * interpret filesystem uids, gids, quotas, device nodes,
1374 * xattrs and security labels.
1375 */
1376 struct user_namespace *s_user_ns;
1377
1378 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001379 * Keep the lru lists last in the structure so they always sit on their
1380 * own individual cachelines.
1381 */
1382 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1383 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001384 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001385 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001386
Dave Chinnere97fedb2015-03-04 13:40:00 -05001387 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001388
1389 /*
1390 * Indicates how deep in a filesystem stack this SB is
1391 */
1392 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001393
1394 /* s_inode_list_lock protects s_inodes */
1395 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1396 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001397
1398 spinlock_t s_inode_wblist_lock;
1399 struct list_head s_inodes_wb; /* writeback inodes */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400};
1401
Seth Forshee81754352014-12-11 10:15:45 -06001402/* Helper functions so that in most cases filesystems will
1403 * not need to deal directly with kuid_t and kgid_t and can
1404 * instead deal with the raw numeric values that are stored
1405 * in the filesystem.
1406 */
1407static inline uid_t i_uid_read(const struct inode *inode)
1408{
1409 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1410}
1411
1412static inline gid_t i_gid_read(const struct inode *inode)
1413{
1414 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1415}
1416
1417static inline void i_uid_write(struct inode *inode, uid_t uid)
1418{
1419 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1420}
1421
1422static inline void i_gid_write(struct inode *inode, gid_t gid)
1423{
1424 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1425}
1426
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427extern struct timespec current_fs_time(struct super_block *sb);
Deepa Dinamani3cd88662016-09-14 07:48:02 -07001428extern struct timespec current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430/*
1431 * Snapshotting support.
1432 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433
Jan Kara5accdf82012-06-12 16:20:34 +02001434void __sb_end_write(struct super_block *sb, int level);
1435int __sb_start_write(struct super_block *sb, int level, bool wait);
1436
Oleg Nesterovbee91822015-07-19 23:48:20 +02001437#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001438 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001439#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001440 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001441
Jan Kara5accdf82012-06-12 16:20:34 +02001442/**
1443 * sb_end_write - drop write access to a superblock
1444 * @sb: the super we wrote to
1445 *
1446 * Decrement number of writers to the filesystem. Wake up possible waiters
1447 * wanting to freeze the filesystem.
1448 */
1449static inline void sb_end_write(struct super_block *sb)
1450{
1451 __sb_end_write(sb, SB_FREEZE_WRITE);
1452}
1453
1454/**
1455 * sb_end_pagefault - drop write access to a superblock from a page fault
1456 * @sb: the super we wrote to
1457 *
1458 * Decrement number of processes handling write page fault to the filesystem.
1459 * Wake up possible waiters wanting to freeze the filesystem.
1460 */
1461static inline void sb_end_pagefault(struct super_block *sb)
1462{
1463 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1464}
1465
1466/**
1467 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1468 * @sb: the super we wrote to
1469 *
1470 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1471 * waiters wanting to freeze the filesystem.
1472 */
1473static inline void sb_end_intwrite(struct super_block *sb)
1474{
1475 __sb_end_write(sb, SB_FREEZE_FS);
1476}
1477
1478/**
1479 * sb_start_write - get write access to a superblock
1480 * @sb: the super we write to
1481 *
1482 * When a process wants to write data or metadata to a file system (i.e. dirty
1483 * a page or an inode), it should embed the operation in a sb_start_write() -
1484 * sb_end_write() pair to get exclusion against file system freezing. This
1485 * function increments number of writers preventing freezing. If the file
1486 * system is already frozen, the function waits until the file system is
1487 * thawed.
1488 *
1489 * Since freeze protection behaves as a lock, users have to preserve
1490 * ordering of freeze protection and other filesystem locks. Generally,
1491 * freeze protection should be the outermost lock. In particular, we have:
1492 *
1493 * sb_start_write
1494 * -> i_mutex (write path, truncate, directory ops, ...)
1495 * -> s_umount (freeze_super, thaw_super)
1496 */
1497static inline void sb_start_write(struct super_block *sb)
1498{
1499 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1500}
1501
1502static inline int sb_start_write_trylock(struct super_block *sb)
1503{
1504 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1505}
1506
1507/**
1508 * sb_start_pagefault - get write access to a superblock from a page fault
1509 * @sb: the super we write to
1510 *
1511 * When a process starts handling write page fault, it should embed the
1512 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1513 * exclusion against file system freezing. This is needed since the page fault
1514 * is going to dirty a page. This function increments number of running page
1515 * faults preventing freezing. If the file system is already frozen, the
1516 * function waits until the file system is thawed.
1517 *
1518 * Since page fault freeze protection behaves as a lock, users have to preserve
1519 * ordering of freeze protection and other filesystem locks. It is advised to
1520 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1521 * handling code implies lock dependency:
1522 *
1523 * mmap_sem
1524 * -> sb_start_pagefault
1525 */
1526static inline void sb_start_pagefault(struct super_block *sb)
1527{
1528 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1529}
1530
1531/*
1532 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1533 * @sb: the super we write to
1534 *
1535 * This is the third level of protection against filesystem freezing. It is
1536 * free for use by a filesystem. The only requirement is that it must rank
1537 * below sb_start_pagefault.
1538 *
1539 * For example filesystem can call sb_start_intwrite() when starting a
1540 * transaction which somewhat eases handling of freezing for internal sources
1541 * of filesystem changes (internal fs threads, discarding preallocation on file
1542 * close, etc.).
1543 */
1544static inline void sb_start_intwrite(struct super_block *sb)
1545{
1546 __sb_start_write(sb, SB_FREEZE_FS, true);
1547}
1548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001550extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301551
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552/*
1553 * VFS helper functions..
1554 */
Al Viro312b63f2012-06-10 18:09:36 -04001555extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001556extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001557extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001558extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001559extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001561extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001562extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001563extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
1565/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001566 * VFS file helper functions.
1567 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001568extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001569 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001570extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001571/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001572 * VFS FS_IOC_FIEMAP helper definitions.
1573 */
1574struct fiemap_extent_info {
1575 unsigned int fi_flags; /* Flags as passed from user */
1576 unsigned int fi_extents_mapped; /* Number of mapped extents */
1577 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001578 struct fiemap_extent __user *fi_extents_start; /* Start of
1579 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001580};
1581int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1582 u64 phys, u64 len, u32 flags);
1583int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1584
1585/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 * File types
1587 *
1588 * NOTE! These match bits 12..15 of stat.st_mode
1589 * (ie "(i_mode >> 12) & 15").
1590 */
1591#define DT_UNKNOWN 0
1592#define DT_FIFO 1
1593#define DT_CHR 2
1594#define DT_DIR 4
1595#define DT_BLK 6
1596#define DT_REG 8
1597#define DT_LNK 10
1598#define DT_SOCK 12
1599#define DT_WHT 14
1600
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601/*
1602 * This is the "filldir" function type, used by readdir() to let
1603 * the kernel specify what kind of dirent layout it wants to have.
1604 * This allows the kernel to read directories into kernel space or
1605 * to have different dirent layouts depending on the binary type.
1606 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001607struct dir_context;
1608typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1609 unsigned);
1610
Al Viro5c0ba4e2013-05-15 13:52:59 -04001611struct dir_context {
Al Viroac6614b2013-05-22 22:22:04 -04001612 const filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001613 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001614};
Al Virobb6f6192013-05-15 18:49:12 -04001615
Al Viro08f85852007-10-08 13:26:20 -04001616struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618/* These macros are for out of kernel modules to test that
1619 * the kernel supports the unlocked_ioctl and compat_ioctl
1620 * fields in struct file_operations. */
1621#define HAVE_COMPAT_IOCTL 1
1622#define HAVE_UNLOCKED_IOCTL 1
1623
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001624/*
1625 * These flags let !MMU mmap() govern direct device mapping vs immediate
1626 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1627 *
1628 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1629 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1630 * NOMMU_MAP_READ: Can be mapped for reading
1631 * NOMMU_MAP_WRITE: Can be mapped for writing
1632 * NOMMU_MAP_EXEC: Can be mapped for execution
1633 */
1634#define NOMMU_MAP_COPY 0x00000001
1635#define NOMMU_MAP_DIRECT 0x00000008
1636#define NOMMU_MAP_READ VM_MAYREAD
1637#define NOMMU_MAP_WRITE VM_MAYWRITE
1638#define NOMMU_MAP_EXEC VM_MAYEXEC
1639
1640#define NOMMU_VMFLAGS \
1641 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1642
1643
Al Viro293bc982014-02-11 18:37:41 -05001644struct iov_iter;
1645
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646struct file_operations {
1647 struct module *owner;
1648 loff_t (*llseek) (struct file *, loff_t, int);
1649 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001651 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1652 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001653 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001654 int (*iterate_shared) (struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 unsigned int (*poll) (struct file *, struct poll_table_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1657 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1658 int (*mmap) (struct file *, struct vm_area_struct *);
1659 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001660 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001662 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 int (*fasync) (int, struct file *, int);
1664 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1666 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1667 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001669 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1670 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001671 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001672 long (*fallocate)(struct file *file, int mode, loff_t offset,
1673 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001674 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001675#ifndef CONFIG_MMU
1676 unsigned (*mmap_capabilities)(struct file *);
1677#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001678 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1679 loff_t, size_t, unsigned int);
1680 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1681 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001682 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1683 u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684};
1685
1686struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001687 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001688 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb2011-06-20 19:28:19 -04001689 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001690 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001691
1692 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001693
Al Viroebfc3b42012-06-10 18:05:36 -04001694 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 int (*link) (struct dentry *,struct inode *,struct dentry *);
1696 int (*unlink) (struct inode *,struct dentry *);
1697 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001698 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001700 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001702 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 int (*setattr) (struct dentry *, struct iattr *);
1704 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001706 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1707 u64 len);
Josef Bacikc3b2da32012-03-26 09:59:21 -04001708 int (*update_time)(struct inode *, struct timespec *, int);
Al Virod9585272012-06-22 12:39:14 +04001709 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001710 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001711 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001712 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001713 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001714} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001716ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001717 unsigned long nr_segs, unsigned long fast_segs,
1718 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001719 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001720
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001721extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Al Viro493c84c2015-04-03 15:06:43 -04001722extern ssize_t __vfs_write(struct file *, const char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1724extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1725extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001726 unsigned long, loff_t *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
Christoph Hellwig793b80e2016-03-03 16:03:58 +01001728 unsigned long, loff_t *, int);
Zach Brown29732932015-11-10 16:53:30 -05001729extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1730 loff_t, size_t, unsigned int);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001731extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1732 struct inode *inode_out, loff_t pos_out,
1733 u64 *len, bool is_dedupe);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001734extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1735 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001736extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1737 struct inode *dest, loff_t destoff,
1738 loff_t len, bool *is_same);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001739extern int vfs_dedupe_file_range(struct file *file,
1740 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Amir Goldstein031a0722016-09-23 11:38:11 +03001742static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
1743 struct file *file_out, loff_t pos_out,
1744 u64 len)
1745{
1746 int ret;
1747
1748 sb_start_write(file_inode(file_out)->i_sb);
1749 ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
1750 sb_end_write(file_inode(file_out)->i_sb);
1751
1752 return ret;
1753}
1754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755struct super_operations {
1756 struct inode *(*alloc_inode)(struct super_block *sb);
1757 void (*destroy_inode)(struct inode *);
1758
Christoph Hellwigaa385722011-05-27 06:53:02 -04001759 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001760 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001761 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001762 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001765 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001766 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001767 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001768 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001769 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001771 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Al Viro34c80b12011-12-08 21:32:45 -05001773 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001774 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001775 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001776 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001777#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1779 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001780 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001781#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001782 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001783 long (*nr_cached_objects)(struct super_block *,
1784 struct shrink_control *);
1785 long (*free_cached_objects)(struct super_block *,
1786 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787};
1788
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001789/*
David Howellsbbc10962012-10-15 16:40:35 +01001790 * Inode flags - they have no relation to superblock flags now
1791 */
1792#define S_SYNC 1 /* Writes are synced at once */
1793#define S_NOATIME 2 /* Do not update access times */
1794#define S_APPEND 4 /* Append-only file */
1795#define S_IMMUTABLE 8 /* Immutable file */
1796#define S_DEAD 16 /* removed, but still open directory */
1797#define S_NOQUOTA 32 /* Inode is not counted to quota */
1798#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1799#define S_NOCMTIME 128 /* Do not update file c/mtime */
1800#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1801#define S_PRIVATE 512 /* Inode is fs-internal */
1802#define S_IMA 1024 /* Inode has an associated IMA struct */
1803#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1804#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001805#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001806#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1807#else
1808#define S_DAX 0 /* Make all the DAX code disappear */
1809#endif
David Howellsbbc10962012-10-15 16:40:35 +01001810
1811/*
1812 * Note that nosuid etc flags are inode-specific: setting some file-system
1813 * flags just means all the inodes inherit those flags by default. It might be
1814 * possible to override it selectively if you really wanted to with some
1815 * ioctl() that is not currently implemented.
1816 *
1817 * Exception: MS_RDONLY is always applied to the entire file system.
1818 *
1819 * Unfortunately, it is possible to change a filesystems flags with it mounted
1820 * with files in use. This means that all of the inodes will not have their
1821 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1822 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1823 */
1824#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1825
1826#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1827#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1828 ((inode)->i_flags & S_SYNC))
1829#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1830 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1831#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1832#define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1833#define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1834
1835#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1836#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1837#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1838#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1839
1840#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1841#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1842#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1843#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1844#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1845#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1846#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001847#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
David Howellsbbc10962012-10-15 16:40:35 +01001848
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001849#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1850 (inode)->i_rdev == WHITEOUT_DEV)
1851
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001852static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1853{
1854 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1855}
1856
David Howellsbbc10962012-10-15 16:40:35 +01001857/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001858 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001859 *
1860 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1861 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1862 *
1863 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1864 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1865 * various stages of removing an inode.
1866 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001867 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001868 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001869 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1870 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001871 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1872 * these changes separately from I_DIRTY_SYNC so that we
1873 * don't have to write inode on fdatasync() when only
1874 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001875 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001876 * I_NEW Serves as both a mutex and completion notification.
1877 * New inodes set I_NEW. If two processes both create
1878 * the same inode, one of them will release its inode and
1879 * wait for I_NEW to be released before returning.
1880 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1881 * also cause waiting on I_NEW, without I_NEW actually
1882 * being set. find_inode() uses this to prevent returning
1883 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001884 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1885 * is zero. I_FREEING must be set when I_WILL_FREE is
1886 * cleared.
1887 * I_FREEING Set when inode is about to be freed but still has dirty
1888 * pages or buffers attached or the inode itself is still
1889 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001890 * I_CLEAR Added by clear_inode(). In this state the inode is
1891 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001892 *
1893 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1894 * prohibited for many purposes. iget() must wait for
1895 * the inode to be completely released, then create it
1896 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001897 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001898 *
Jan Kara169ebd92012-05-03 14:48:03 +02001899 * I_SYNC Writeback of inode is running. The bit is set during
1900 * data writeback, and cleared with a wakeup on the bit
1901 * address once it is done. The bit is also used to pin
1902 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001903 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001904 * I_REFERENCED Marks the inode as recently references on the LRU list.
1905 *
1906 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1907 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04001908 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
1909 * synchronize competing switching instances and to tell
1910 * wb stat updates to grab mapping->tree_lock. See
1911 * inode_switch_wb_work_fn() for details.
1912 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001913 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001914 */
Nick Piggin9e38d862010-10-23 06:55:17 -04001915#define I_DIRTY_SYNC (1 << 0)
1916#define I_DIRTY_DATASYNC (1 << 1)
1917#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001918#define __I_NEW 3
1919#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04001920#define I_WILL_FREE (1 << 4)
1921#define I_FREEING (1 << 5)
1922#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001923#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001924#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04001925#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04001926#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05001927#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04001928#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001929#define I_DIRTY_TIME (1 << 11)
1930#define __I_DIRTY_TIME_EXPIRED 12
1931#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04001932#define I_WB_SWITCH (1 << 13)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
1934#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05001935#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936
1937extern void __mark_inode_dirty(struct inode *, int);
1938static inline void mark_inode_dirty(struct inode *inode)
1939{
1940 __mark_inode_dirty(inode, I_DIRTY);
1941}
1942
1943static inline void mark_inode_dirty_sync(struct inode *inode)
1944{
1945 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1946}
1947
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001948extern void inc_nlink(struct inode *inode);
1949extern void drop_nlink(struct inode *inode);
1950extern void clear_nlink(struct inode *inode);
1951extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07001952
1953static inline void inode_inc_link_count(struct inode *inode)
1954{
1955 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001956 mark_inode_dirty(inode);
1957}
1958
Dave Hansen9a53c3a2006-09-30 23:29:03 -07001959static inline void inode_dec_link_count(struct inode *inode)
1960{
1961 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08001962 mark_inode_dirty(inode);
1963}
1964
Jean Noel Cordenner25ec56b2008-01-28 23:58:27 -05001965/**
1966 * inode_inc_iversion - increments i_version
1967 * @inode: inode that need to be updated
1968 *
1969 * Every time the inode is modified, the i_version field will be incremented.
1970 * The filesystem has to be mounted with i_version flag
1971 */
1972
1973static inline void inode_inc_iversion(struct inode *inode)
1974{
1975 spin_lock(&inode->i_lock);
1976 inode->i_version++;
1977 spin_unlock(&inode->i_lock);
1978}
1979
Josef Bacikc3b2da32012-03-26 09:59:21 -04001980enum file_time_flags {
1981 S_ATIME = 1,
1982 S_MTIME = 2,
1983 S_CTIME = 4,
1984 S_VERSION = 8,
1985};
1986
Al Virobadcf2b2013-07-16 18:15:46 +04001987extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988static inline void file_accessed(struct file *file)
1989{
1990 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04001991 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992}
1993
1994int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02001995int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997struct file_system_type {
1998 const char *name;
1999 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002000#define FS_REQUIRES_DEV 1
2001#define FS_BINARY_MOUNTDATA 2
2002#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002003#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002004#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002005 struct dentry *(*mount) (struct file_system_type *, int,
2006 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 void (*kill_sb) (struct super_block *);
2008 struct module *owner;
2009 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002010 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002011
Ingo Molnarcf516242006-07-03 00:25:27 -07002012 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002013 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002014 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002015 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002016
2017 struct lock_class_key i_lock_key;
2018 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002019 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020};
2021
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002022#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2023
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002024extern struct dentry *mount_ns(struct file_system_type *fs_type,
2025 int flags, void *data, void *ns, struct user_namespace *user_ns,
2026 int (*fill_super)(struct super_block *, void *, int));
Al Viro152a0832010-07-25 00:46:55 +04002027extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2028 int flags, const char *dev_name, void *data,
2029 int (*fill_super)(struct super_block *, void *, int));
Al Virofc14f2f2010-07-25 01:48:30 +04002030extern struct dentry *mount_single(struct file_system_type *fs_type,
2031 int flags, void *data,
2032 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002033extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2034 int flags, void *data,
2035 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002036extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037void generic_shutdown_super(struct super_block *sb);
2038void kill_block_super(struct super_block *sb);
2039void kill_anon_super(struct super_block *sb);
2040void kill_litter_super(struct super_block *sb);
2041void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002042void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002044int get_anon_bdev(dev_t *);
2045void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002046struct super_block *sget_userns(struct file_system_type *type,
2047 int (*test)(struct super_block *,void *),
2048 int (*set)(struct super_block *,void *),
2049 int flags, struct user_namespace *user_ns,
2050 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051struct super_block *sget(struct file_system_type *type,
2052 int (*test)(struct super_block *,void *),
2053 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002054 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002055extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2056 const struct super_operations *ops,
2057 const struct xattr_handler **xattr,
2058 const struct dentry_operations *dops,
2059 unsigned long);
2060
2061static inline struct dentry *
2062mount_pseudo(struct file_system_type *fs_type, char *name,
2063 const struct super_operations *ops,
2064 const struct dentry_operations *dops, unsigned long magic)
2065{
2066 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2067}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
2069/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2070#define fops_get(fops) \
2071 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2072#define fops_put(fops) \
2073 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002074/*
2075 * This one is to be used *ONLY* from ->open() instances.
2076 * fops must be non-NULL, pinned down *and* module dependencies
2077 * should be sufficient to pin the caller down as well.
2078 */
2079#define replace_fops(f, fops) \
2080 do { \
2081 struct file *__file = (f); \
2082 fops_put(__file->f_op); \
2083 BUG_ON(!(__file->f_op = (fops))); \
2084 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
2086extern int register_filesystem(struct file_system_type *);
2087extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002088extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2089#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002090extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091extern int may_umount_tree(struct vfsmount *);
2092extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002093extern long do_mount(const char *, const char __user *,
2094 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002095extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002096extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002097extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2098 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002099extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002100extern int user_statfs(const char __user *, struct kstatfs *);
2101extern int fd_statfs(int, struct kstatfs *);
Al Virocf31e702012-01-02 22:28:36 -05002102extern int vfs_ustat(dev_t, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002103extern int freeze_super(struct super_block *super);
2104extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002105extern bool our_mnt(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
Al Viroce3b0f82009-03-29 19:08:22 -04002107extern int current_umask(void);
2108
J. Bruce Fields5a146962012-08-28 07:50:40 -07002109extern void ihold(struct inode * inode);
2110extern void iput(struct inode *);
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002111extern int generic_update_time(struct inode *, struct timespec *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002112
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002113/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002114extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002115
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002116#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002117
Jeff Layton9e8925b2015-11-16 09:49:34 -05002118#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002119extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002120extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
2122/*
2123 * Candidates for mandatory locking have the setgid bit set
2124 * but no group execute bit - an otherwise meaningless combination.
2125 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002126
2127static inline int __mandatory_lock(struct inode *ino)
2128{
2129 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2130}
2131
2132/*
2133 * ... and these candidates should be on MS_MANDLOCK mounted fs,
2134 * otherwise these will be advisory locks
2135 */
2136
2137static inline int mandatory_lock(struct inode *ino)
2138{
2139 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2140}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141
Jeff Laytond7a06982014-03-10 09:54:15 -04002142static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143{
Miklos Szeredic568d682016-09-16 12:44:20 +02002144 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002145 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 return 0;
2147}
2148
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002150 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 loff_t size)
2152{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002153 if (!inode->i_flctx || !mandatory_lock(inode))
2154 return 0;
2155
2156 if (size < inode->i_size) {
2157 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2158 F_WRLCK);
2159 } else {
2160 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2161 F_WRLCK);
2162 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163}
2164
Jeff Layton9e8925b2015-11-16 09:49:34 -05002165#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2166
2167static inline int locks_mandatory_locked(struct file *file)
2168{
2169 return 0;
2170}
2171
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002172static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2173 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002174{
2175 return 0;
2176}
2177
2178static inline int __mandatory_lock(struct inode *inode)
2179{
2180 return 0;
2181}
2182
2183static inline int mandatory_lock(struct inode *inode)
2184{
2185 return 0;
2186}
2187
2188static inline int locks_verify_locked(struct file *file)
2189{
2190 return 0;
2191}
2192
2193static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2194 size_t size)
2195{
2196 return 0;
2197}
2198
2199#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2200
2201
2202#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203static inline int break_lease(struct inode *inode, unsigned int mode)
2204{
Jeff Layton24cbe782014-02-03 12:13:06 -05002205 /*
2206 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002207 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2208 * could end up racing with tasks trying to set a new lease on this
2209 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002210 */
2211 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002212 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002213 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 return 0;
2215}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002216
2217static inline int break_deleg(struct inode *inode, unsigned int mode)
2218{
Jeff Layton962bd402014-06-10 12:24:40 -04002219 /*
2220 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002221 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2222 * could end up racing with tasks trying to set a new lease on this
2223 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002224 */
2225 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002226 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002227 return __break_lease(inode, mode, FL_DELEG);
2228 return 0;
2229}
2230
J. Bruce Fields5a146962012-08-28 07:50:40 -07002231static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2232{
2233 int ret;
2234
2235 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2236 if (ret == -EWOULDBLOCK && delegated_inode) {
2237 *delegated_inode = inode;
2238 ihold(inode);
2239 }
2240 return ret;
2241}
2242
2243static inline int break_deleg_wait(struct inode **delegated_inode)
2244{
2245 int ret;
2246
2247 ret = break_deleg(*delegated_inode, O_WRONLY);
2248 iput(*delegated_inode);
2249 *delegated_inode = NULL;
2250 return ret;
2251}
2252
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002253static inline int break_layout(struct inode *inode, bool wait)
2254{
2255 smp_mb();
2256 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2257 return __break_lease(inode,
2258 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2259 FL_LAYOUT);
2260 return 0;
2261}
2262
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002263#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002264static inline int break_lease(struct inode *inode, unsigned int mode)
2265{
2266 return 0;
2267}
2268
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002269static inline int break_deleg(struct inode *inode, unsigned int mode)
2270{
2271 return 0;
2272}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002273
2274static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2275{
2276 return 0;
2277}
2278
2279static inline int break_deleg_wait(struct inode **delegated_inode)
2280{
2281 BUG();
2282 return 0;
2283}
2284
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002285static inline int break_layout(struct inode *inode, bool wait)
2286{
2287 return 0;
2288}
2289
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002290#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
2292/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002293struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002294struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002295 const char *name; /* pointer to actual string */
2296 const __user char *uptr; /* original userland pointer */
2297 struct audit_names *aname;
Paul Moore55422d02015-01-22 00:00:23 -05002298 int refcnt;
Al Virofd2f7cb2015-02-22 20:07:13 -05002299 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002300};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301
Al Viro7df818b2016-03-25 14:24:09 -04002302extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002303extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2304 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002305extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002306 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002307extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002308 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002309extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002310extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002311extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002312 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002313extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002315
David Drysdale51f39a12014-12-12 16:57:29 -08002316extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002317extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002318extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002319extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002320
Al Viro47237682012-06-10 05:01:45 -04002321enum {
2322 FILE_CREATED = 1,
2323 FILE_OPENED = 2
2324};
Al Viro30d90492012-06-22 12:40:19 +04002325extern int finish_open(struct file *file, struct dentry *dentry,
2326 int (*open)(struct inode *, struct file *),
2327 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002328extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002330/* fs/ioctl.c */
2331
2332extern int ioctl_preallocate(struct file *filp, void __user *argp);
2333
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334/* fs/dcache.c */
2335extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002336extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
Christoph Lameterb86c0892006-12-06 20:32:57 -08002338extern struct kmem_cache *names_cachep;
2339
Jeff Laytona608ca22012-10-10 15:25:26 -04002340#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002341#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342
David Howells93614012006-09-30 20:45:40 +02002343#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002345extern void unregister_blkdev(unsigned int, const char *);
Jan Karaf44f1ab2017-02-02 15:56:49 +01002346extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002348extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349extern void bd_set_size(struct block_device *, loff_t size);
2350extern void bd_forget(struct inode *inode);
2351extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002352extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002353extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002354extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002355extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002356extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002357extern void emergency_thaw_all(void);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002358extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2359extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002360
2361extern struct super_block *blockdev_superblock;
2362
2363static inline bool sb_is_blkdev_sb(struct super_block *sb)
2364{
2365 return sb == blockdev_superblock;
2366}
David Howells93614012006-09-30 20:45:40 +02002367#else
2368static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002369static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002370static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002371static inline void invalidate_bdev(struct block_device *bdev) {}
2372
2373static inline struct super_block *freeze_bdev(struct block_device *sb)
2374{
2375 return NULL;
2376}
2377
2378static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2379{
2380 return 0;
2381}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002382
2383static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2384{
2385}
Jan Karaa8855992013-07-09 22:36:45 +08002386
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002387static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002388{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002389 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002390}
David Howells93614012006-09-30 20:45:40 +02002391#endif
Jan Kara60b06802009-04-27 16:43:53 +02002392extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002393extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002394extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002395#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002397extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002399extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002400extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2401 void *holder);
2402extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2403 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002404extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002405extern int __blkdev_reread_part(struct block_device *bdev);
2406extern int blkdev_reread_part(struct block_device *bdev);
2407
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002408#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002409extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002410extern void bd_unlink_disk_holder(struct block_device *bdev,
2411 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002412#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002413static inline int bd_link_disk_holder(struct block_device *bdev,
2414 struct gendisk *disk)
2415{
2416 return 0;
2417}
Tejun Heo49731ba2011-01-14 18:43:57 +01002418static inline void bd_unlink_disk_holder(struct block_device *bdev,
2419 struct gendisk *disk)
2420{
2421}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002422#endif
David Howells93614012006-09-30 20:45:40 +02002423#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424
2425/* fs/char_dev.c */
Joe Korty68eef3b2006-03-31 02:30:32 -08002426#define CHRDEV_MAJOR_HASH_SIZE 255
Linus Walleij49db08c2016-02-19 15:36:07 +01002427/* Marks the bottom of the first segment of free char majors */
2428#define CHRDEV_MAJOR_DYN_END 234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2430extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002431extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2432 unsigned int count, const char *name,
2433 const struct file_operations *fops);
2434extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2435 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002437extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438
Tejun Heo1905b1b2009-08-06 18:13:23 +09002439static inline int register_chrdev(unsigned int major, const char *name,
2440 const struct file_operations *fops)
2441{
2442 return __register_chrdev(major, 0, 256, name, fops);
2443}
2444
2445static inline void unregister_chrdev(unsigned int major, const char *name)
2446{
2447 __unregister_chrdev(major, 0, 256, name);
2448}
2449
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450/* fs/block_dev.c */
2451#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002452#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002453
2454#ifdef CONFIG_BLOCK
2455#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456extern const char *__bdevname(dev_t, char *buffer);
2457extern const char *bdevname(struct block_device *bdev, char *buffer);
2458extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002459extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002460
David Howells93614012006-09-30 20:45:40 +02002461#else
2462#define BLKDEV_MAJOR_HASH_SIZE 0
2463#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
2465extern void init_special_inode(struct inode *, umode_t, dev_t);
2466
2467/* Invalid inode operations -- fs/bad_inode.c */
2468extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002469extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470
Jens Axboec11f0c02016-08-05 08:11:04 -06002471#ifdef CONFIG_BLOCK
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002472extern void check_disk_size_change(struct gendisk *disk,
2473 struct block_device *bdev);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002474extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002476extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002478#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479unsigned long invalidate_mapping_pages(struct address_space *mapping,
2480 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002481
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482static inline void invalidate_remote_inode(struct inode *inode)
2483{
2484 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2485 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002486 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487}
2488extern int invalidate_inode_pages2(struct address_space *mapping);
2489extern int invalidate_inode_pages2_range(struct address_space *mapping,
2490 pgoff_t start, pgoff_t end);
2491extern int write_inode_now(struct inode *, int);
2492extern int filemap_fdatawrite(struct address_space *);
2493extern int filemap_flush(struct address_space *);
2494extern int filemap_fdatawait(struct address_space *);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -08002495extern void filemap_fdatawait_keep_errors(struct address_space *);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002496extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2497 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498extern int filemap_write_and_wait(struct address_space *mapping);
2499extern int filemap_write_and_wait_range(struct address_space *mapping,
2500 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002501extern int __filemap_fdatawrite_range(struct address_space *mapping,
2502 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002503extern int filemap_fdatawrite_range(struct address_space *mapping,
2504 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002505extern int filemap_check_errors(struct address_space *mapping);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002506
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002507extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2508 int datasync);
2509extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002510
2511/*
2512 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2513 * to already be updated for the write, and will return either the amount
2514 * of bytes passed in, or an error if syncing the file failed.
2515 */
2516static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002517{
Christoph Hellwige2592212016-04-07 08:52:01 -07002518 if (iocb->ki_flags & IOCB_DSYNC) {
2519 int ret = vfs_fsync_range(iocb->ki_filp,
2520 iocb->ki_pos - count, iocb->ki_pos - 1,
2521 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2522 if (ret)
2523 return ret;
2524 }
2525
2526 return count;
Al Virod311d792014-02-09 15:18:09 -05002527}
Christoph Hellwige2592212016-04-07 08:52:01 -07002528
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529extern void emergency_sync(void);
2530extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002531#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002533#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002534extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002535extern int inode_permission(struct inode *, int);
Miklos Szeredibd5d0852014-10-24 00:14:35 +02002536extern int __inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002537extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002538extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539
Miklos Szeredif696a362008-07-31 13:41:58 +02002540static inline bool execute_ok(struct inode *inode)
2541{
2542 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2543}
2544
Al Viro8d71db42013-03-19 21:01:03 -04002545static inline void file_start_write(struct file *file)
2546{
2547 if (!S_ISREG(file_inode(file)->i_mode))
2548 return;
2549 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2550}
2551
Jan Kara5ae98f12013-05-04 00:11:23 +02002552static inline bool file_start_write_trylock(struct file *file)
2553{
2554 if (!S_ISREG(file_inode(file)->i_mode))
2555 return true;
2556 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2557}
2558
Al Viro8d71db42013-03-19 21:01:03 -04002559static inline void file_end_write(struct file *file)
2560{
2561 if (!S_ISREG(file_inode(file)->i_mode))
2562 return;
2563 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2564}
2565
Al Viro07b8ce12011-06-20 10:52:57 -04002566/*
2567 * get_write_access() gets write permission for a file.
2568 * put_write_access() releases this write permission.
2569 * This is used for regular files.
2570 * We cannot support write (and maybe mmap read-write shared) accesses and
2571 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2572 * can have the following values:
2573 * 0: no writers, no VM_DENYWRITE mappings
2574 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2575 * > 0: (i_writecount) users are writing to the file.
2576 *
2577 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2578 * except for the cases where we don't hold i_writecount yet. Then we need to
2579 * use {get,deny}_write_access() - these functions check the sign and refuse
2580 * to do the change if sign is wrong.
2581 */
2582static inline int get_write_access(struct inode *inode)
2583{
2584 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2585}
2586static inline int deny_write_access(struct file *file)
2587{
Al Viro496ad9a2013-01-23 17:07:38 -05002588 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002589 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2590}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591static inline void put_write_access(struct inode * inode)
2592{
2593 atomic_dec(&inode->i_writecount);
2594}
2595static inline void allow_write_access(struct file *file)
2596{
2597 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002598 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599}
David Howellsf1fe29b2013-09-27 11:20:03 +01002600static inline bool inode_is_open_for_write(const struct inode *inode)
2601{
2602 return atomic_read(&inode->i_writecount) > 0;
2603}
2604
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002605#ifdef CONFIG_IMA
2606static inline void i_readcount_dec(struct inode *inode)
2607{
2608 BUG_ON(!atomic_read(&inode->i_readcount));
2609 atomic_dec(&inode->i_readcount);
2610}
2611static inline void i_readcount_inc(struct inode *inode)
2612{
2613 atomic_inc(&inode->i_readcount);
2614}
2615#else
2616static inline void i_readcount_dec(struct inode *inode)
2617{
2618 return;
2619}
2620static inline void i_readcount_inc(struct inode *inode)
2621{
2622 return;
2623}
2624#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002625extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626
Mimi Zohar1284ab52016-04-20 15:46:27 -07002627#define __kernel_read_file_id(id) \
2628 id(UNKNOWN, unknown) \
2629 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002630 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002631 id(MODULE, kernel-module) \
2632 id(KEXEC_IMAGE, kexec-image) \
2633 id(KEXEC_INITRAMFS, kexec-initramfs) \
2634 id(POLICY, security-policy) \
2635 id(MAX_ID, )
2636
2637#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2638#define __fid_stringify(dummy, str) #str,
2639
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002640enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002641 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002642};
2643
Mimi Zohar1284ab52016-04-20 15:46:27 -07002644static const char * const kernel_read_file_str[] = {
2645 __kernel_read_file_id(__fid_stringify)
2646};
2647
Kees Cookda20dfe2016-04-21 12:53:29 -07002648static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002649{
2650 if (id < 0 || id >= READING_MAX_ID)
2651 return kernel_read_file_str[READING_UNKNOWN];
2652
2653 return kernel_read_file_str[id];
2654}
2655
Mimi Zohar6777d772009-08-21 14:32:48 -04002656extern int kernel_read(struct file *, loff_t, char *, unsigned long);
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002657extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2658 enum kernel_read_file_id);
Mimi Zohar09596b92015-11-19 12:39:22 -05002659extern int kernel_read_file_from_path(char *, void **, loff_t *, loff_t,
2660 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002661extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2662 enum kernel_read_file_id);
Al Viro7bb307e2013-02-23 14:51:48 -05002663extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
Al Viroed447242014-04-19 14:37:20 -04002664extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665extern struct file * open_exec(const char *);
2666
2667/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002668extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002669extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002671extern char *file_path(struct file *, char *, int);
2672
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673#include <linux/err.h>
2674
2675/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002676extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677
Andrew Morton965c8e52012-12-17 15:59:39 -08002678extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679
Christoph Hellwig54e34622009-08-07 14:38:25 -03002680extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002682extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683extern struct inode * igrab(struct inode *);
2684extern ino_t iunique(struct super_block *, ino_t);
2685extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002686extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002687static inline int generic_drop_inode(struct inode *inode)
2688{
2689 return !inode->i_nlink || inode_unhashed(inode);
2690}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002692extern struct inode *ilookup5_nowait(struct super_block *sb,
2693 unsigned long hashval, int (*test)(struct inode *, void *),
2694 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2696 int (*test)(struct inode *, void *), void *data);
2697extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2698
2699extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2700extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002701extern struct inode *find_inode_nowait(struct super_block *,
2702 unsigned long,
2703 int (*match)(struct inode *,
2704 unsigned long, void *),
2705 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002706extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2707extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002708#ifdef CONFIG_DEBUG_LOCK_ALLOC
2709extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2710#else
2711static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2712#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002714extern unsigned int get_next_ino(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002717extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002718extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002719extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002720extern struct inode *new_inode_pseudo(struct super_block *sb);
2721extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002722extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002723extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002724extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
2726extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002727static inline void insert_inode_hash(struct inode *inode)
2728{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729 __insert_inode_hash(inode, inode->i_ino);
2730}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002731
2732extern void __remove_inode_hash(struct inode *);
2733static inline void remove_inode_hash(struct inode *inode)
2734{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002735 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002736 __remove_inode_hash(inode);
2737}
2738
Christoph Hellwig646ec462010-10-23 07:15:32 -04002739extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740
David Howells93614012006-09-30 20:45:40 +02002741#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002743#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744extern int set_blocksize(struct block_device *, int);
2745extern int sb_set_blocksize(struct super_block *, int);
2746extern int sb_min_blocksize(struct super_block *, int);
2747
2748extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2749extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002750extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002751extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002752extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002753extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002754extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002755extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002756
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002757ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos);
2758ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos);
2759
Christoph Hellwigeef99382009-08-20 17:43:41 +02002760/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002761extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002762extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002763extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2764 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002765extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002766
Andrew Morton88e6fae2006-04-11 13:59:36 +02002767/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002768extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002769 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002770extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002771 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002772extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002773 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002774extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2775 loff_t *opos, size_t len, unsigned int flags);
2776
Andrew Morton88e6fae2006-04-11 13:59:36 +02002777
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778extern void
2779file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002780extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2781extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002782extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002783extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002784extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002785 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002786extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2787 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002788extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2789extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790extern int generic_file_open(struct inode * inode, struct file * filp);
2791extern int nonseekable_open(struct inode * inode, struct file * filp);
2792
David Howells93614012006-09-30 20:45:40 +02002793#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05002794typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04002795 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796
2797enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01002798 /* need locking between buffered and direct access */
2799 DIO_LOCKING = 0x01,
2800
2801 /* filesystem does not support filling holes */
2802 DIO_SKIP_HOLES = 0x02,
Christoph Hellwig60392572014-02-10 10:27:11 +11002803
2804 /* filesystem can handle aio writes beyond i_size */
2805 DIO_ASYNC_EXTEND = 0x04,
Jens Axboefe0f07d2015-04-15 17:05:48 -06002806
2807 /* inode/fs/bdev does not need truncate protection */
2808 DIO_SKIP_DIO_COUNT = 0x08,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809};
2810
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002811void dio_end_io(struct bio *bio, int error);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002812
Omar Sandoval17f8c842015-03-16 04:33:50 -07002813ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
2814 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002815 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002816 dio_iodone_t end_io, dio_submit_t submit_io,
2817 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02002818
Omar Sandoval17f8c842015-03-16 04:33:50 -07002819static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
2820 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002821 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07002822 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823{
Omar Sandoval17f8c842015-03-16 04:33:50 -07002824 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002825 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826}
David Howells93614012006-09-30 20:45:40 +02002827#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828
Trond Myklebust1d59d612012-05-31 12:22:33 -04002829void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06002830
2831/*
2832 * inode_dio_begin - signal start of a direct I/O requests
2833 * @inode: inode the direct I/O happens on
2834 *
2835 * This is called once we've finished processing a direct I/O request,
2836 * and is used to wake up callers waiting for direct I/O to be quiesced.
2837 */
2838static inline void inode_dio_begin(struct inode *inode)
2839{
2840 atomic_inc(&inode->i_dio_count);
2841}
2842
2843/*
2844 * inode_dio_end - signal finish of a direct I/O requests
2845 * @inode: inode the direct I/O happens on
2846 *
2847 * This is called once we've finished processing a direct I/O request,
2848 * and is used to wake up callers waiting for direct I/O to be quiesced.
2849 */
2850static inline void inode_dio_end(struct inode *inode)
2851{
2852 if (atomic_dec_and_test(&inode->i_dio_count))
2853 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
2854}
Trond Myklebust1d59d612012-05-31 12:22:33 -04002855
Theodore Ts'o5f16f322014-03-24 14:43:12 -04002856extern void inode_set_flags(struct inode *inode, unsigned int flags,
2857 unsigned int mask);
2858
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002859extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860
2861#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2862
Al Viro5d826c82014-03-14 13:42:45 -04002863extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002864extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05002865extern const char *page_get_link(struct dentry *, struct inode *,
2866 struct delayed_call *);
2867extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08002868extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08002869 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002870extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002871extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05002872extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873extern void generic_fillattr(struct inode *, struct kstat *);
J. Bruce Fieldsb7a6ec52013-10-02 17:01:18 -04002874int vfs_getattr_nosec(struct path *path, struct kstat *stat);
Al Viro3dadecc2013-01-24 02:18:08 -05002875extern int vfs_getattr(struct path *, struct kstat *);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03002876void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04002878void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879void inode_sub_bytes(struct inode *inode, loff_t bytes);
2880loff_t inode_get_bytes(struct inode *inode);
2881void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05002882const char *simple_get_link(struct dentry *, struct inode *,
2883 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04002884extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885
Al Viro5c0ba4e2013-05-15 13:52:59 -04002886extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887
David Howellsc7887322010-08-11 11:26:22 +01002888extern int vfs_stat(const char __user *, struct kstat *);
2889extern int vfs_lstat(const char __user *, struct kstat *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890extern int vfs_fstat(unsigned int, struct kstat *);
David Howellsc7887322010-08-11 11:26:22 +01002891extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
Miklos Szeredid60874c2016-10-04 14:40:45 +02002892extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0ed2016-12-09 16:45:04 +01002893extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894
Steven Whitehousee9079cc2008-10-14 14:43:29 +01002895extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04002896 struct fiemap_extent_info *fieinfo,
2897 loff_t start, loff_t len,
2898 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04002899extern int generic_block_fiemap(struct inode *inode,
2900 struct fiemap_extent_info *fieinfo, u64 start,
2901 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902
Miklos Szeredic18479f2007-10-18 23:39:11 -07002903extern void get_filesystem(struct file_system_type *fs);
2904extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905extern struct file_system_type *get_fs_type(const char *name);
2906extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01002907extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01002908extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02002909extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002910extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01002911extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04002912extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04002913extern void iterate_supers_type(struct file_system_type *,
2914 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002915
2916extern int dcache_dir_open(struct inode *, struct file *);
2917extern int dcache_dir_close(struct inode *, struct file *);
2918extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04002919extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10002920extern int simple_setattr(struct dentry *, struct iattr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
David Howells726c3342006-06-23 02:02:58 -07002922extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07002923extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2925extern int simple_unlink(struct inode *, struct dentry *);
2926extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02002927extern int simple_rename(struct inode *, struct dentry *,
2928 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04002929extern int noop_fsync(struct file *, loff_t, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930extern int simple_empty(struct dentry *);
2931extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07002932extern int simple_write_begin(struct file *file, struct address_space *mapping,
2933 loff_t pos, unsigned len, unsigned flags,
2934 struct page **pagep, void **fsdata);
2935extern int simple_write_end(struct file *file, struct address_space *mapping,
2936 loff_t pos, unsigned len, unsigned copied,
2937 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04002938extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04002939extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04002940extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04002941extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942
Al Viro00cd8dd2012-06-10 17:13:09 -04002943extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002945extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08002946extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05002947extern void make_empty_dir_inode(struct inode *inode);
2948extern bool is_empty_dir_inode(struct inode *inode);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002949struct tree_descr { char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950struct dentry *d_alloc_name(struct dentry *, const char *);
Roberto Sassu7d683a02010-06-03 11:58:28 +02002951extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04002952extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953extern void simple_release_fs(struct vfsmount **mount, int *count);
2954
Akinobu Mita93b07112008-06-05 22:46:21 -07002955extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2956 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02002957extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2958 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959
Fabian Frederickac13a822014-06-04 16:06:27 -07002960extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04002961extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04002962
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07002963extern int generic_check_addressable(unsigned, u64);
2964
Christoph Lametere965f962006-02-01 03:05:41 -08002965#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07002966extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08002967 struct page *, struct page *,
2968 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08002969#else
2970#define buffer_migrate_page NULL
2971#endif
2972
Jan Kara31051c82016-05-26 16:55:18 +02002973extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10002974extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02002975extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976
Josef Bacikc3b2da32012-03-26 09:59:21 -04002977extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978
Al Viro34c80b12011-12-08 21:32:45 -05002979extern int generic_show_options(struct seq_file *m, struct dentry *root);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08002980extern void save_mount_options(struct super_block *sb, char *options);
Al Viro2a32ceb2009-05-08 16:05:57 -04002981extern void replace_mount_options(struct super_block *sb, char *options);
Miklos Szeredib3b304a2008-02-08 04:21:35 -08002982
Matthew Wilcoxd475c632015-02-16 15:58:56 -08002983static inline bool io_is_direct(struct file *filp)
2984{
Dan Williams65f87ee2016-01-25 17:23:18 -08002985 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08002986}
2987
Al Viro2ba48ce2015-04-09 13:52:01 -04002988static inline int iocb_flags(struct file *file)
2989{
2990 int res = 0;
2991 if (file->f_flags & O_APPEND)
2992 res |= IOCB_APPEND;
2993 if (io_is_direct(file))
2994 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07002995 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
2996 res |= IOCB_DSYNC;
2997 if (file->f_flags & __O_SYNC)
2998 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04002999 return res;
3000}
3001
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002static inline ino_t parent_ino(struct dentry *dentry)
3003{
3004 ino_t res;
3005
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003006 /*
3007 * Don't strictly need d_lock here? If the parent ino could change
3008 * then surely we'd have a deeper race in the caller?
3009 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 spin_lock(&dentry->d_lock);
3011 res = dentry->d_parent->d_inode->i_ino;
3012 spin_unlock(&dentry->d_lock);
3013 return res;
3014}
3015
Linus Torvalds1da177e2005-04-16 15:20:36 -07003016/* Transaction based IO helpers */
3017
3018/*
3019 * An argresp is stored in an allocated page and holds the
3020 * size of the argument or response, along with its content
3021 */
3022struct simple_transaction_argresp {
3023 ssize_t size;
3024 char data[0];
3025};
3026
3027#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3028
3029char *simple_transaction_get(struct file *file, const char __user *buf,
3030 size_t size);
3031ssize_t simple_transaction_read(struct file *file, char __user *buf,
3032 size_t size, loff_t *pos);
3033int simple_transaction_release(struct inode *inode, struct file *file);
3034
Ingo Molnar76791ab2009-03-25 16:48:35 +01003035void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003037/*
3038 * simple attribute files
3039 *
3040 * These attributes behave similar to those in sysfs:
3041 *
3042 * Writing to an attribute immediately sets a value, an open file can be
3043 * written to multiple times.
3044 *
3045 * Reading from an attribute creates a buffer from the value that might get
3046 * read with multiple read calls. When the attribute has been read
3047 * completely, no further read calls are possible until the file is opened
3048 * again.
3049 *
3050 * All attributes contain a text representation of a numeric value
3051 * that are accessed with the get() and set() functions.
3052 */
3053#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3054static int __fops ## _open(struct inode *inode, struct file *file) \
3055{ \
3056 __simple_attr_check_format(__fmt, 0ull); \
3057 return simple_attr_open(inode, file, __get, __set, __fmt); \
3058} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003059static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003060 .owner = THIS_MODULE, \
3061 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003062 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003063 .read = simple_attr_read, \
3064 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003065 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003066}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003067
Joe Perchesb9075fa2011-10-31 17:11:33 -07003068static inline __printf(1, 2)
3069void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003070{
3071 /* don't do anything, just let the compiler check the arguments; */
3072}
3073
3074int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003075 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003076 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003077int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003078ssize_t simple_attr_read(struct file *file, char __user *buf,
3079 size_t len, loff_t *ppos);
3080ssize_t simple_attr_write(struct file *file, const char __user *buf,
3081 size_t len, loff_t *ppos);
3082
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003083struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003084int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003085 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003086int proc_nr_dentry(struct ctl_table *table, int write,
3087 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003088int proc_nr_inodes(struct ctl_table *table, int write,
3089 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003090int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003091
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003092#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003093#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3094
Al Viro6d125522009-12-24 06:58:56 -05003095#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003096#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003097 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003098
Yaowei Baid37177b2015-11-19 21:00:12 +08003099static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003100{
3101 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3102}
3103
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003104static inline int check_sticky(struct inode *dir, struct inode *inode)
3105{
3106 if (!(dir->i_mode & S_ISVTX))
3107 return 0;
3108
3109 return __check_sticky(dir, inode);
3110}
3111
Andi Kleen69b45732011-05-28 08:25:51 -07003112static inline void inode_has_no_xattr(struct inode *inode)
3113{
Al Viro9e1f1de2011-06-03 18:24:58 -04003114 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003115 inode->i_flags |= S_NOSEC;
3116}
3117
Al Viroa7400222014-10-21 15:20:42 -04003118static inline bool is_root_inode(struct inode *inode)
3119{
3120 return inode == inode->i_sb->s_root->d_inode;
3121}
3122
Al Viro5f99f4e2013-05-15 20:23:06 -04003123static inline bool dir_emit(struct dir_context *ctx,
3124 const char *name, int namelen,
3125 u64 ino, unsigned type)
3126{
3127 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3128}
3129static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3130{
3131 return ctx->actor(ctx, ".", 1, ctx->pos,
3132 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3133}
3134static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3135{
3136 return ctx->actor(ctx, "..", 2, ctx->pos,
3137 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3138}
3139static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3140{
3141 if (ctx->pos == 0) {
3142 if (!dir_emit_dot(file, ctx))
3143 return false;
3144 ctx->pos = 1;
3145 }
3146 if (ctx->pos == 1) {
3147 if (!dir_emit_dotdot(file, ctx))
3148 return false;
3149 ctx->pos = 2;
3150 }
3151 return true;
3152}
Al Viro5ded75e2013-05-15 21:02:48 -04003153static inline bool dir_relax(struct inode *inode)
3154{
Al Viro59551022016-01-22 15:40:57 -05003155 inode_unlock(inode);
3156 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003157 return !IS_DEADDIR(inode);
3158}
Al Viro5f99f4e2013-05-15 20:23:06 -04003159
Al Viroae053272016-05-12 20:36:01 -04003160static inline bool dir_relax_shared(struct inode *inode)
3161{
3162 inode_unlock_shared(inode);
3163 inode_lock_shared(inode);
3164 return !IS_DEADDIR(inode);
3165}
3166
Eric W. Biederman90f85722015-06-29 14:42:03 -05003167extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003168extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003169
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170#endif /* _LINUX_FS_H */