blob: 05f34726e29c3ce49b09a6d27eaca216953196bf [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _LINUX_FS_H
3#define _LINUX_FS_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/linkage.h>
Ingo Molnar5dd43ce2017-06-20 12:19:09 +02006#include <linux/wait_bit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#include <linux/kdev_t.h>
8#include <linux/dcache.h>
Al Viro3f8206d2008-07-26 03:46:43 -04009#include <linux/path.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/stat.h>
11#include <linux/cache.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/list.h>
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100013#include <linux/list_lru.h>
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -070014#include <linux/llist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/radix-tree.h>
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070016#include <linux/xarray.h>
Michel Lespinasse6b2dbba2012-10-08 16:31:25 -070017#include <linux/rbtree.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/init.h>
Al Viro914e2632006-10-18 13:55:46 -040019#include <linux/pid.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050020#include <linux/bug.h>
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080021#include <linux/mutex.h>
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080022#include <linux/rwsem.h>
Dan Williamsbaabda22017-07-10 15:48:25 -070023#include <linux/mm_types.h>
Satyam Sharma3bd858ab2007-07-17 15:00:08 +053024#include <linux/capability.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040025#include <linux/semaphore.h>
Jens Axboec75b1d92017-06-27 11:47:04 -060026#include <linux/fcntl.h>
Mark Fashehc4b929b2008-10-08 19:44:18 -040027#include <linux/fiemap.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110028#include <linux/rculist_bl.h>
Al Viro07b8ce12011-06-20 10:52:57 -040029#include <linux/atomic.h>
Konstantin Khlebnikov83aeead2011-12-08 14:33:54 -080030#include <linux/shrinker.h>
Stephen Rothwellc1aab022012-01-24 11:41:32 +110031#include <linux/migrate_mode.h>
Eric W. Biederman92361632012-02-08 07:07:50 -080032#include <linux/uidgid.h>
Jan Kara5accdf82012-06-12 16:20:34 +020033#include <linux/lockdep.h>
Jens Axboec2b1ad82012-09-27 09:35:03 +020034#include <linux/percpu-rwsem.h>
Oleg Nesterov853b39a2015-07-22 20:21:13 +020035#include <linux/workqueue.h>
Al Virofceef392015-12-29 15:58:39 -050036#include <linux/delayed_call.h>
Christoph Hellwig85787092017-05-10 15:06:33 +020037#include <linux/uuid.h>
Jeff Layton5660e132017-07-06 07:02:25 -040038#include <linux/errseq.h>
Adam Manzanaresd9a08a92018-05-22 10:52:19 -070039#include <linux/ioprio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <asm/byteorder.h>
David Howells607ca462012-10-13 10:46:48 +010042#include <uapi/linux/fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Christoph Hellwigb83ae6d2015-01-14 10:42:37 +010044struct backing_dev_info;
Tejun Heo52ebea72015-05-22 17:13:37 -040045struct bdi_writeback;
Christoph Hellwig2f8b5442016-11-01 07:40:13 -060046struct bio;
Christoph Hellwiga5694252007-07-17 04:04:28 -070047struct export_operations;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -080048struct hd_geometry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049struct iovec;
Christoph Hellwig92198f72005-06-23 22:00:59 -070050struct kiocb;
Alexey Dobriyan57cc72152011-01-10 08:18:25 +020051struct kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct pipe_inode_info;
53struct poll_table_struct;
54struct kstatfs;
55struct vm_area_struct;
56struct vfsmount;
David Howells745ca242008-11-14 10:39:22 +110057struct cred;
Mel Gormana509bc12012-07-31 16:44:57 -070058struct swap_info_struct;
Cyrill Gorcunov55985dd2012-12-17 16:04:55 -080059struct seq_file;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020060struct workqueue_struct;
Al Viro3b93f912014-02-11 21:34:08 -050061struct iov_iter;
Jaegeuk Kim0b81d072015-05-15 16:26:10 -070062struct fscrypt_info;
63struct fscrypt_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Denis Cheng74bf17c2007-10-16 23:26:30 -070065extern void __init inode_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066extern void __init inode_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -070067extern void __init files_init(void);
68extern void __init files_maxfiles_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Jan Engelhardtdded4f42008-12-01 14:34:50 -080070extern struct files_stat_struct files_stat;
Eric Dumazet518de9b2010-10-26 14:22:44 -070071extern unsigned long get_max_files(void);
Alexey Dobriyan9b80a182016-09-02 00:38:52 +030072extern unsigned int sysctl_nr_open;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080073extern struct inodes_stat_t inodes_stat;
74extern int leases_enable, lease_break_time;
Kees Cook800179c2012-07-25 17:29:07 -070075extern int sysctl_protected_symlinks;
76extern int sysctl_protected_hardlinks;
Jan Engelhardtdded4f42008-12-01 14:34:50 -080077
Christoph Hellwigddef7ed22017-07-06 18:58:37 +020078typedef __kernel_rwf_t rwf_t;
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080struct buffer_head;
81typedef int (get_block_t)(struct inode *inode, sector_t iblock,
82 struct buffer_head *bh_result, int create);
Christoph Hellwig187372a2016-02-08 14:40:51 +110083typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
Christoph Hellwig7b7a8662013-09-04 15:04:39 +020084 ssize_t bytes, void *private);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
David Howellsbbc10962012-10-15 16:40:35 +010086#define MAY_EXEC 0x00000001
87#define MAY_WRITE 0x00000002
88#define MAY_READ 0x00000004
89#define MAY_APPEND 0x00000008
90#define MAY_ACCESS 0x00000010
91#define MAY_OPEN 0x00000020
92#define MAY_CHDIR 0x00000040
93/* called from RCU mode, don't block */
94#define MAY_NOT_BLOCK 0x00000080
95
96/*
97 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
Li Qiang75abe322018-05-17 19:01:03 -070098 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
David Howellsbbc10962012-10-15 16:40:35 +010099 */
100
101/* file is open for reading */
102#define FMODE_READ ((__force fmode_t)0x1)
103/* file is open for writing */
104#define FMODE_WRITE ((__force fmode_t)0x2)
105/* file is seekable */
106#define FMODE_LSEEK ((__force fmode_t)0x4)
107/* file can be accessed using pread */
108#define FMODE_PREAD ((__force fmode_t)0x8)
109/* file can be accessed using pwrite */
110#define FMODE_PWRITE ((__force fmode_t)0x10)
111/* File is opened for execution with sys_execve / sys_uselib */
112#define FMODE_EXEC ((__force fmode_t)0x20)
113/* File is opened with O_NDELAY (only set for block devices) */
114#define FMODE_NDELAY ((__force fmode_t)0x40)
115/* File is opened with O_EXCL (only set for block devices) */
116#define FMODE_EXCL ((__force fmode_t)0x80)
117/* File is opened using open(.., 3, ..) and is writeable only for ioctls
118 (specialy hack for floppy.c) */
119#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
120/* 32bit hashes as llseek() offset (for directories) */
121#define FMODE_32BITHASH ((__force fmode_t)0x200)
122/* 64bit hashes as llseek() offset (for directories) */
123#define FMODE_64BITHASH ((__force fmode_t)0x400)
124
125/*
126 * Don't update ctime and mtime.
127 *
128 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
129 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
130 */
131#define FMODE_NOCMTIME ((__force fmode_t)0x800)
132
133/* Expect random access pattern */
134#define FMODE_RANDOM ((__force fmode_t)0x1000)
135
136/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
137#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
138
139/* File is opened with O_PATH; almost nothing can be done with it */
140#define FMODE_PATH ((__force fmode_t)0x4000)
141
Linus Torvalds9c225f22014-03-03 09:36:58 -0800142/* File needs atomic accesses to f_pos */
143#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
Al Viro83f936c2014-03-14 12:02:47 -0400144/* Write access to underlying fs */
145#define FMODE_WRITER ((__force fmode_t)0x10000)
Al Viro7f7f25e2014-02-11 17:49:24 -0500146/* Has read method(s) */
147#define FMODE_CAN_READ ((__force fmode_t)0x20000)
148/* Has write method(s) */
149#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
Linus Torvalds9c225f22014-03-03 09:36:58 -0800150
Al Virof5d11402018-07-09 02:35:08 -0400151#define FMODE_OPENED ((__force fmode_t)0x80000)
152
David Howellsbbc10962012-10-15 16:40:35 +0100153/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800154#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100155
Christoph Hellwig91f99432017-08-29 16:13:20 +0200156/* File is capable of returning -EAGAIN if I/O will block */
157#define FMODE_NOWAIT ((__force fmode_t)0x8000000)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500158
David Howellsbbc10962012-10-15 16:40:35 +0100159/*
160 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
161 * that indicates that they should check the contents of the iovec are
162 * valid, but not check the memory that the iovec elements
163 * points too.
164 */
165#define CHECK_IOVEC_ONLY -1
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167/*
168 * Attribute flags. These should be or-ed together to figure out what
169 * has been changed!
170 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200171#define ATTR_MODE (1 << 0)
172#define ATTR_UID (1 << 1)
173#define ATTR_GID (1 << 2)
174#define ATTR_SIZE (1 << 3)
175#define ATTR_ATIME (1 << 4)
176#define ATTR_MTIME (1 << 5)
177#define ATTR_CTIME (1 << 6)
178#define ATTR_ATIME_SET (1 << 7)
179#define ATTR_MTIME_SET (1 << 8)
180#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
181#define ATTR_ATTR_FLAG (1 << 10)
182#define ATTR_KILL_SUID (1 << 11)
183#define ATTR_KILL_SGID (1 << 12)
184#define ATTR_FILE (1 << 13)
185#define ATTR_KILL_PRIV (1 << 14)
186#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
187#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200188#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200191 * Whiteout is represented by a char device. The following constants define the
192 * mode and device number to use.
193 */
194#define WHITEOUT_MODE 0
195#define WHITEOUT_DEV 0
196
197/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 * This is the Inode Attributes structure, used for notify_change(). It
199 * uses the above definitions as flags, to know which values have changed.
200 * Also, in this manner, a Filesystem can look at only the values it cares
201 * about. Basically, these are the attributes that the VFS layer can
202 * request to change from the FS layer.
203 *
204 * Derek Atkins <warlord@MIT.EDU> 94-10-20
205 */
206struct iattr {
207 unsigned int ia_valid;
208 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800209 kuid_t ia_uid;
210 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 loff_t ia_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700212 struct timespec64 ia_atime;
213 struct timespec64 ia_mtime;
214 struct timespec64 ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800215
216 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300217 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800218 * implement an ftruncate() like method. NOTE: filesystem should
219 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
220 */
221 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222};
223
224/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 * Includes for diskquotas.
226 */
227#include <linux/quota.h>
228
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200229/*
230 * Maximum number of layers of fs stack. Needs to be limited to
231 * prevent kernel stack overflow
232 */
233#define FILESYSTEM_MAX_STACK_DEPTH 2
234
Zach Brown994fc28c2005-12-15 14:28:17 -0800235/**
236 * enum positive_aop_returns - aop return codes with specific semantics
237 *
238 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
239 * completed, that the page is still locked, and
240 * should be considered active. The VM uses this hint
241 * to return the page to the active list -- it won't
242 * be a candidate for writeback again in the near
243 * future. Other callers must be careful to unlock
244 * the page if they get this return. Returned by
245 * writepage();
246 *
247 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
248 * unlocked it and the page might have been truncated.
249 * The caller should back up to acquiring a new page and
250 * trying again. The aop will be taking reasonable
251 * precautions not to livelock. If the caller held a page
252 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700253 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800254 *
255 * address_space_operation functions return these large constants to indicate
256 * special semantics to the caller. These are much larger than the bytes in a
257 * page to allow for functions that return the number of bytes operated on in a
258 * given page.
259 */
260
261enum positive_aop_returns {
262 AOP_WRITEPAGE_ACTIVATE = 0x80000,
263 AOP_TRUNCATED_PAGE = 0x80001,
264};
265
Tetsuo Handac718a972017-05-08 15:58:59 -0700266#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
267#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800268 * helper code (eg buffer layer)
269 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700270
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271/*
272 * oh the beauties of C type declarations.
273 */
274struct page;
275struct address_space;
276struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Jens Axboec75b1d92017-06-27 11:47:04 -0600278/*
279 * Write life time hint values.
280 */
281enum rw_hint {
282 WRITE_LIFE_NOT_SET = 0,
283 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
284 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
285 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
286 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
287 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
288};
289
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800290#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400291#define IOCB_APPEND (1 << 1)
292#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100293#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700294#define IOCB_DSYNC (1 << 4)
295#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500296#define IOCB_WRITE (1 << 6)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500297#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800298
299struct kiocb {
300 struct file *ki_filp;
301 loff_t ki_pos;
302 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
303 void *private;
304 int ki_flags;
Adam Manzanaresfc287242018-05-22 10:52:18 -0700305 u16 ki_hint;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700306 u16 ki_ioprio; /* See linux/ioprio.h */
Kees Cook3859a272016-10-28 01:22:25 -0700307} __randomize_layout;
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800308
309static inline bool is_sync_kiocb(struct kiocb *kiocb)
310{
311 return kiocb->ki_complete == NULL;
312}
313
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700314/*
315 * "descriptor" for what we're up to with a read.
316 * This allows us to use the same read code yet
317 * have multiple different users of the data that
318 * we read from a file.
319 *
320 * The simplest case just copies the data to user
321 * mode.
322 */
323typedef struct {
324 size_t written;
325 size_t count;
326 union {
327 char __user *buf;
328 void *data;
329 } arg;
330 int error;
331} read_descriptor_t;
332
333typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
334 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336struct address_space_operations {
337 int (*writepage)(struct page *page, struct writeback_control *wbc);
338 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340 /* Write back some dirty pages from this mapping. */
341 int (*writepages)(struct address_space *, struct writeback_control *);
342
Andrew Morton4741c9f2006-03-24 03:18:11 -0800343 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 int (*set_page_dirty)(struct page *page);
345
346 int (*readpages)(struct file *filp, struct address_space *mapping,
347 struct list_head *pages, unsigned nr_pages);
348
Nick Pigginafddba42007-10-16 01:25:01 -0700349 int (*write_begin)(struct file *, struct address_space *mapping,
350 loff_t pos, unsigned len, unsigned flags,
351 struct page **pagep, void **fsdata);
352 int (*write_end)(struct file *, struct address_space *mapping,
353 loff_t pos, unsigned len, unsigned copied,
354 struct page *page, void *fsdata);
355
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
357 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400358 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400359 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500360 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700361 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800362 /*
Tang Chenef277c72013-07-08 16:00:21 -0700363 * migrate the contents of a page to the specified target. If
364 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800365 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700366 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800367 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700368 bool (*isolate_page)(struct page *, isolate_mode_t);
369 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800370 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500371 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700372 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700373 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200374 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700375
376 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700377 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
378 sector_t *span);
379 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380};
381
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200382extern const struct address_space_operations empty_aops;
383
Nick Pigginafddba42007-10-16 01:25:01 -0700384/*
385 * pagecache_write_begin/pagecache_write_end must be used by general code
386 * to write into the pagecache.
387 */
388int pagecache_write_begin(struct file *, struct address_space *mapping,
389 loff_t pos, unsigned len, unsigned flags,
390 struct page **pagep, void **fsdata);
391
392int pagecache_write_end(struct file *, struct address_space *mapping,
393 loff_t pos, unsigned len, unsigned copied,
394 struct page *page, void *fsdata);
395
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396struct address_space {
397 struct inode *host; /* owner: inode, block_device */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700398 struct radix_tree_root i_pages; /* cached pages */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700399 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Davidlohr Buesof808c132017-09-08 16:15:08 -0700400 struct rb_root_cached i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800401 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700402 /* Protected by the i_pages lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800404 /* number of shadow or DAX exceptional entries */
405 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700407 const struct address_space_operations *a_ops; /* methods */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700408 unsigned long flags; /* error bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 spinlock_t private_lock; /* for use by the address_space */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700410 gfp_t gfp_mask; /* implicit gfp mask for allocations */
Mike Rapoport32e57c22017-10-03 16:16:54 -0700411 struct list_head private_list; /* for use by the address_space */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800412 void *private_data; /* ditto */
Jeff Layton5660e132017-07-06 07:02:25 -0400413 errseq_t wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700414} __attribute__((aligned(sizeof(long)))) __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 /*
416 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300417 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
419 */
Andi Kleen87192a22012-01-12 17:20:34 -0800420struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422struct block_device {
423 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700424 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500426 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800427 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900428 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 void * bd_holder;
430 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100431 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800432#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100433 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800434#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 struct block_device * bd_contains;
436 unsigned bd_block_size;
Christoph Hellwigc2ee0702017-08-23 19:10:31 +0200437 u8 bd_partno;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 struct hd_struct * bd_part;
439 /* number of times partitions within this device have been opened. */
440 unsigned bd_part_count;
441 int bd_invalidated;
442 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800443 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100444 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 /*
447 * Private data. You must have bd_claim'ed the block_device
448 * to use this. NOTE: bd_claim allows an owner to claim
449 * the same device multiple times, the owner must take special
450 * care to not mess up bd_private for that case.
451 */
452 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800453
454 /* The counter of freeze processes */
455 int bd_fsfreeze_count;
456 /* Mutex for freeze */
457 struct mutex bd_fsfreeze_mutex;
Kees Cook3859a272016-10-28 01:22:25 -0700458} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
460/*
461 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
462 * radix trees
463 */
464#define PAGECACHE_TAG_DIRTY 0
465#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700466#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468int mapping_tagged(struct address_space *mapping, int tag);
469
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800470static inline void i_mmap_lock_write(struct address_space *mapping)
471{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800472 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800473}
474
475static inline void i_mmap_unlock_write(struct address_space *mapping)
476{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800477 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800478}
479
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800480static inline void i_mmap_lock_read(struct address_space *mapping)
481{
482 down_read(&mapping->i_mmap_rwsem);
483}
484
485static inline void i_mmap_unlock_read(struct address_space *mapping)
486{
487 up_read(&mapping->i_mmap_rwsem);
488}
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490/*
491 * Might pages of this file be mapped into userspace?
492 */
493static inline int mapping_mapped(struct address_space *mapping)
494{
Davidlohr Buesof808c132017-09-08 16:15:08 -0700495 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496}
497
498/*
499 * Might pages of this file have been modified in userspace?
500 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
501 * marks vma as VM_SHARED if it is shared, and the file was opened for
502 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700503 *
504 * If i_mmap_writable is negative, no new writable mappings are allowed. You
505 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 */
507static inline int mapping_writably_mapped(struct address_space *mapping)
508{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700509 return atomic_read(&mapping->i_mmap_writable) > 0;
510}
511
512static inline int mapping_map_writable(struct address_space *mapping)
513{
514 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
515 0 : -EPERM;
516}
517
518static inline void mapping_unmap_writable(struct address_space *mapping)
519{
520 atomic_dec(&mapping->i_mmap_writable);
521}
522
523static inline int mapping_deny_writable(struct address_space *mapping)
524{
525 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
526 0 : -EBUSY;
527}
528
529static inline void mapping_allow_writable(struct address_space *mapping)
530{
531 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533
534/*
535 * Use sequence counter to get consistent i_size on 32-bit processors.
536 */
537#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
538#include <linux/seqlock.h>
539#define __NEED_I_SIZE_ORDERED
540#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
541#else
542#define i_size_ordered_init(inode) do { } while (0)
543#endif
544
Al Virof19d4a82009-06-08 19:50:45 -0400545struct posix_acl;
546#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200547#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400548
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100549static inline struct posix_acl *
550uncached_acl_sentinel(struct task_struct *task)
551{
552 return (void *)task + 1;
553}
554
555static inline bool
556is_uncached_acl(struct posix_acl *acl)
557{
558 return (long)acl & 1;
559}
560
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700561#define IOP_FASTPERM 0x0001
562#define IOP_LOOKUP 0x0002
563#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200564#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100565#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700566
Jan Kara9dd813c2017-03-14 12:31:02 +0100567struct fsnotify_mark_connector;
568
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700569/*
570 * Keep mostly read-only and often accessed (especially for
571 * the RCU path lookup and 'stat' data) fields at the beginning
572 * of the 'struct inode'
573 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100575 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700576 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800577 kuid_t i_uid;
578 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700579 unsigned int i_flags;
580
581#ifdef CONFIG_FS_POSIX_ACL
582 struct posix_acl *i_acl;
583 struct posix_acl *i_default_acl;
584#endif
585
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100586 const struct inode_operations *i_op;
587 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700588 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100589
Linus Torvalds13e12d12011-06-08 15:18:19 -0700590#ifdef CONFIG_SECURITY
591 void *i_security;
592#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100593
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700594 /* Stat data, not accessed from path walking */
595 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200596 /*
597 * Filesystems may only read i_nlink directly. They shall use the
598 * following functions for modification:
599 *
600 * (set|clear|inc|drop)_nlink
601 * inode_(inc|dec)_link_count
602 */
603 union {
604 const unsigned int i_nlink;
605 unsigned int __i_nlink;
606 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700607 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700608 loff_t i_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700609 struct timespec64 i_atime;
610 struct timespec64 i_mtime;
611 struct timespec64 i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400612 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
613 unsigned short i_bytes;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700614 unsigned int i_blkbits;
Jens Axboec75b1d92017-06-27 11:47:04 -0600615 enum rw_hint i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700616 blkcnt_t i_blocks;
617
618#ifdef __NEED_I_SIZE_ORDERED
619 seqcount_t i_size_seqcount;
620#endif
621
622 /* Misc */
623 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400624 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700625
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100626 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400627 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500630 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400631#ifdef CONFIG_CGROUP_WRITEBACK
632 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400633
634 /* foreign inode detection, see wbc_detach_inode() */
635 int i_wb_frn_winner;
636 u16 i_wb_frn_avg_time;
637 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400638#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100639 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700641 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100642 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400643 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100644 struct rcu_head i_rcu;
645 };
Jeff Laytonf02a9ad2017-12-21 07:45:44 -0500646 atomic64_t i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700647 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400648 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400649 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500650#ifdef CONFIG_IMA
651 atomic_t i_readcount; /* struct files open RO */
652#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800653 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500654 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700657 union {
658 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700659 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700660 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400661 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400662 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700663 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
665 __u32 i_generation;
666
Eric Paris3be25f42009-05-21 17:01:26 -0400667#ifdef CONFIG_FSNOTIFY
668 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100669 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400670#endif
671
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700672#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
673 struct fscrypt_info *i_crypt_info;
674#endif
675
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700676 void *i_private; /* fs or device private pointer */
Kees Cook3859a272016-10-28 01:22:25 -0700677} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Fabian Frederick93407472017-02-27 14:28:32 -0800679static inline unsigned int i_blocksize(const struct inode *node)
680{
681 return (1 << node->i_blkbits);
682}
683
Al Viro1d3382cb2010-10-23 15:19:20 -0400684static inline int inode_unhashed(struct inode *inode)
685{
686 return hlist_unhashed(&inode->i_hash);
687}
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700690 * inode->i_mutex nesting subclasses for the lock validator:
691 *
692 * 0: the object of the current VFS operation
693 * 1: parent
694 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400695 * 3: xattr
696 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100697 * 5: second parent (when locking independent directories in rename)
698 *
699 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400700 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700701 *
702 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100703 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700704 */
705enum inode_i_mutex_lock_class
706{
707 I_MUTEX_NORMAL,
708 I_MUTEX_PARENT,
709 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700710 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100711 I_MUTEX_NONDIR2,
712 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700713};
714
Al Viro59551022016-01-22 15:40:57 -0500715static inline void inode_lock(struct inode *inode)
716{
Al Viro9902af72016-04-15 15:08:36 -0400717 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500718}
719
720static inline void inode_unlock(struct inode *inode)
721{
Al Viro9902af72016-04-15 15:08:36 -0400722 up_write(&inode->i_rwsem);
723}
724
725static inline void inode_lock_shared(struct inode *inode)
726{
727 down_read(&inode->i_rwsem);
728}
729
730static inline void inode_unlock_shared(struct inode *inode)
731{
732 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500733}
734
735static inline int inode_trylock(struct inode *inode)
736{
Al Viro9902af72016-04-15 15:08:36 -0400737 return down_write_trylock(&inode->i_rwsem);
738}
739
740static inline int inode_trylock_shared(struct inode *inode)
741{
742 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500743}
744
745static inline int inode_is_locked(struct inode *inode)
746{
Al Viro9902af72016-04-15 15:08:36 -0400747 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500748}
749
750static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
751{
Al Viro9902af72016-04-15 15:08:36 -0400752 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500753}
754
Darrick J. Wong01c2e132018-01-18 14:07:53 -0800755static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
756{
757 down_read_nested(&inode->i_rwsem, subclass);
758}
759
J. Bruce Fields375e2892012-04-18 15:16:33 -0400760void lock_two_nondirectories(struct inode *, struct inode*);
761void unlock_two_nondirectories(struct inode *, struct inode*);
762
Ingo Molnarf2eace22006-07-03 00:25:05 -0700763/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 * NOTE: in a 32bit arch with a preemptable kernel and
765 * an UP compile the i_size_read/write must be atomic
766 * with respect to the local cpu (unlike with preempt disabled),
767 * but they don't need to be atomic with respect to other cpus like in
768 * true SMP (so they need either to either locally disable irq around
769 * the read or for example on x86 they can be still implemented as a
770 * cmpxchg8b without the need of the lock prefix). For SMP compiles
771 * and 64bit archs it makes no difference if preempt is enabled or not.
772 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800773static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774{
775#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
776 loff_t i_size;
777 unsigned int seq;
778
779 do {
780 seq = read_seqcount_begin(&inode->i_size_seqcount);
781 i_size = inode->i_size;
782 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
783 return i_size;
784#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
785 loff_t i_size;
786
787 preempt_disable();
788 i_size = inode->i_size;
789 preempt_enable();
790 return i_size;
791#else
792 return inode->i_size;
793#endif
794}
795
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700796/*
797 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
798 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
799 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
800 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801static inline void i_size_write(struct inode *inode, loff_t i_size)
802{
803#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700804 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 write_seqcount_begin(&inode->i_size_seqcount);
806 inode->i_size = i_size;
807 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700808 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
810 preempt_disable();
811 inode->i_size = i_size;
812 preempt_enable();
813#else
814 inode->i_size = i_size;
815#endif
816}
817
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800818static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
820 return MINOR(inode->i_rdev);
821}
822
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800823static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824{
825 return MAJOR(inode->i_rdev);
826}
827
828extern struct block_device *I_BDEV(struct inode *inode);
829
830struct fown_struct {
831 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700832 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
833 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800834 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 int signum; /* posix.1b rt signal to be delivered on IO */
836};
837
838/*
839 * Track a single file's readahead state
840 */
841struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700842 pgoff_t start; /* where readahead started */
843 unsigned int size; /* # of readahead pages */
844 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700845 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700846
Fengguang Wu937085a2007-10-16 01:24:31 -0700847 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700848 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700849 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Fengguang Wu5ce11102007-07-19 01:47:59 -0700852/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700853 * Check if @index falls in the readahead windows.
854 */
855static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
856{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700857 return (index >= ra->start &&
858 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700859}
860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800862 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700863 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800864 struct rcu_head fu_rcuhead;
865 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800866 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500867 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800868 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700869
870 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800871 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700872 * Must not be taken from IRQ context.
873 */
874 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600875 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400876 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400878 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800879 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 loff_t f_pos;
881 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100882 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 struct file_ra_state f_ra;
884
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700885 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700886#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700888#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 /* needed for tty driver, and maybe others */
890 void *private_data;
891
892#ifdef CONFIG_EPOLL
893 /* Used by fs/eventpoll.c to link all the hooks to this file */
894 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800895 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896#endif /* #ifdef CONFIG_EPOLL */
897 struct address_space *f_mapping;
Jeff Layton5660e132017-07-06 07:02:25 -0400898 errseq_t f_wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700899} __randomize_layout
900 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530902struct file_handle {
903 __u32 handle_bytes;
904 int handle_type;
905 /* file identifier */
906 unsigned char f_handle[0];
907};
908
Al Virocb0942b2012-08-27 14:48:26 -0400909static inline struct file *get_file(struct file *f)
910{
911 atomic_long_inc(&f->f_count);
912 return f;
913}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700914#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400915#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400916#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
918#define MAX_NON_LFS ((1UL<<31) - 1)
919
920/* Page cache limit. The filesystems should put that into their s_maxbytes
921 limits, otherwise bad things can happen in VM. */
922#if BITS_PER_LONG==32
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700923#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924#elif BITS_PER_LONG==64
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700925#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926#endif
927
928#define FL_POSIX 1
929#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400930#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400932#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700934#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400936#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
937#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400938#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100939#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Benjamin Coddington50f21122017-04-11 12:50:09 -0400941#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
942
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700944 * Special return value from posix_lock_file() and vfs_lock_file() for
945 * asynchronous locking.
946 */
947#define FILE_LOCK_DEFERRED 1
948
Jeff Layton7ca76312014-09-01 19:04:48 -0400949/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200950typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951
Jeff Laytona7231a92015-01-16 15:05:56 -0500952struct file_lock;
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
956 void (*fl_release_private)(struct file_lock *);
957};
958
959struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400960 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400961 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400962 fl_owner_t (*lm_get_owner)(fl_owner_t);
963 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400964 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400965 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400966 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500967 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400968 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969};
970
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400971struct lock_manager {
972 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400973 /*
974 * NFSv4 and up also want opens blocked during the grace period;
975 * NLM doesn't care:
976 */
977 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400978};
979
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400980struct net;
981void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400982void locks_end_grace(struct lock_manager *);
Corentin Labbe003278e2017-09-26 09:14:07 +0200983bool locks_in_grace(struct net *);
984bool opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986/* that will die - we need it for nfs_lock_info */
987#include <linux/nfs_fs_i.h>
988
Jeff Layton1cb36012013-06-21 08:58:12 -0400989/*
990 * struct file_lock represents a generic "file lock". It's used to represent
991 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
992 * note that the same struct is used to represent both a request for a lock and
993 * the lock itself, but the same object is never used for both.
994 *
995 * FIXME: should we create a separate "struct lock_request" to help distinguish
996 * these two uses?
997 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500998 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -0400999 *
Jeff Layton8116bf42015-01-21 20:44:01 -05001000 * 1) lock owner
1001 * 2) lock range start
1002 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001003 *
1004 * Obviously, the last two criteria only matter for POSIX locks.
1005 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006struct file_lock {
1007 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001008 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001009 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 struct list_head fl_block; /* circular list of blocked processes */
1011 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001012 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001013 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001015 int fl_link_cpu; /* what cpu's list is this on? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 wait_queue_head_t fl_wait;
1017 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 loff_t fl_start;
1019 loff_t fl_end;
1020
1021 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001022 /* for lease breaks: */
1023 unsigned long fl_break_time;
1024 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001026 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001027 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 union {
1029 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001030 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001031 struct {
1032 struct list_head link; /* link in AFS vnode's pending_locks list */
1033 int state; /* state of grant or error if -ve */
1034 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 } fl_u;
Kees Cook3859a272016-10-28 01:22:25 -07001036} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
Jeff Layton4a075e32015-01-16 15:05:54 -05001038struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001039 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001040 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001041 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001042 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001043};
1044
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045/* The following constant reflects the upper bound of the file/locking space */
1046#ifndef OFFSET_MAX
1047#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1048#define OFFSET_MAX INT_LIMIT(loff_t)
1049#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1050#endif
1051
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001052extern void send_sigio(struct fown_struct *fown, int fd, int band);
1053
Miklos Szeredic568d682016-09-16 12:44:20 +02001054/*
1055 * Return the inode to use for locking
1056 *
1057 * For overlayfs this should be the overlay inode, not the real inode returned
1058 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1059 * equal.
1060 */
1061static inline struct inode *locks_inode(const struct file *f)
1062{
1063 return f->f_path.dentry->d_inode;
1064}
1065
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001066#ifdef CONFIG_FILE_LOCKING
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001067extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
Peter Staubachc2936212005-07-27 11:45:09 -07001068extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001069 struct flock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070
1071#if BITS_PER_LONG == 32
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001072extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
Peter Staubachc2936212005-07-27 11:45:09 -07001073extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001074 struct flock64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075#endif
1076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1078extern int fcntl_getlease(struct file *filp);
1079
1080/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001081void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001082void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001084extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001086extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001088extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001089extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001090extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001091extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001092extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001093extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001094extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001095extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001096extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001097extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001098extern void lease_get_mtime(struct inode *, struct timespec64 *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001099extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1100extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001101extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001102struct files_struct;
1103extern void show_fd_locks(struct seq_file *f,
1104 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001105#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001106static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1107 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001108{
1109 return -EINVAL;
1110}
1111
1112static inline int fcntl_setlk(unsigned int fd, struct file *file,
1113 unsigned int cmd, struct flock __user *user)
1114{
1115 return -EACCES;
1116}
1117
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001118#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001119static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1120 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001121{
1122 return -EINVAL;
1123}
1124
1125static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1126 unsigned int cmd, struct flock64 __user *user)
1127{
1128 return -EACCES;
1129}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001130#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001131static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1132{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001133 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001134}
1135
1136static inline int fcntl_getlease(struct file *filp)
1137{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001138 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001139}
1140
Jeff Layton4a075e32015-01-16 15:05:54 -05001141static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001142locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001143{
1144}
1145
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001146static inline void locks_init_lock(struct file_lock *fl)
1147{
1148 return;
1149}
1150
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001151static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001152{
1153 return;
1154}
1155
1156static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1157{
1158 return;
1159}
1160
1161static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1162{
1163 return;
1164}
1165
Jeff Layton78ed8a12014-02-03 12:13:08 -05001166static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001167{
1168 return;
1169}
1170
1171static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1172{
1173 return;
1174}
1175
1176static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1177 struct file_lock *conflock)
1178{
1179 return -ENOLCK;
1180}
1181
Jeff Laytonf891a292013-06-21 08:58:09 -04001182static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001183{
1184 return -ENOENT;
1185}
1186
1187static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1188{
1189 return 0;
1190}
1191
1192static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1193 struct file_lock *fl, struct file_lock *conf)
1194{
1195 return -ENOLCK;
1196}
1197
1198static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1199{
1200 return 0;
1201}
1202
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001203static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1204{
1205 return -ENOLCK;
1206}
1207
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001208static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001209{
1210 return 0;
1211}
1212
Deepa Dinamani95582b02018-05-08 19:36:02 -07001213static inline void lease_get_mtime(struct inode *inode,
1214 struct timespec64 *time)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001215{
1216 return;
1217}
1218
1219static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001220 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001221{
1222 return -EINVAL;
1223}
1224
1225static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001226 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001227{
1228 return -EINVAL;
1229}
1230
Jeff Layton7448cc32015-01-16 15:05:57 -05001231static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001232 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001233{
1234 return -EINVAL;
1235}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001236
1237struct files_struct;
1238static inline void show_fd_locks(struct seq_file *f,
1239 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001240#endif /* !CONFIG_FILE_LOCKING */
1241
Jeff Laytonee296d72015-07-11 06:43:03 -04001242static inline struct inode *file_inode(const struct file *f)
1243{
1244 return f->f_inode;
1245}
1246
Miklos Szeredid101a122016-03-26 16:14:37 -04001247static inline struct dentry *file_dentry(const struct file *file)
1248{
Miklos Szeredi495e6422017-09-04 21:42:22 +02001249 return d_real(file->f_path.dentry, file_inode(file), 0, 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001250}
1251
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001252static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1253{
Miklos Szeredic568d682016-09-16 12:44:20 +02001254 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001255}
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257struct fasync_struct {
Kirill Tkhai7a107c02018-04-05 14:58:06 +03001258 rwlock_t fa_lock;
Eric Dumazet989a2972010-04-14 09:55:35 +00001259 int magic;
1260 int fa_fd;
1261 struct fasync_struct *fa_next; /* singly linked list */
1262 struct file *fa_file;
1263 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264};
1265
1266#define FASYNC_MAGIC 0x4601
1267
1268/* SMP safe fasync helpers: */
1269extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001270extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1271extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1272extern struct fasync_struct *fasync_alloc(void);
1273extern void fasync_free(struct fasync_struct *);
1274
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275/* can be called from interrupts */
1276extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001278extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Jiri Slaby393cc3f2017-06-13 13:35:50 +02001279extern int f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001281extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282extern int send_sigurg(struct fown_struct *fown);
1283
1284/*
David Howellse462ec52017-07-17 08:45:35 +01001285 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1286 * represented in both.
1287 */
1288#define SB_RDONLY 1 /* Mount read-only */
1289#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1290#define SB_NODEV 4 /* Disallow access to device special files */
1291#define SB_NOEXEC 8 /* Disallow program execution */
1292#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1293#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1294#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1295#define SB_NOATIME 1024 /* Do not update access times. */
1296#define SB_NODIRATIME 2048 /* Do not update directory access times */
1297#define SB_SILENT 32768
1298#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1299#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1300#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1301#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1302
1303/* These sb flags are internal to the kernel */
1304#define SB_SUBMOUNT (1<<26)
1305#define SB_NOREMOTELOCK (1<<27)
1306#define SB_NOSEC (1<<28)
1307#define SB_BORN (1<<29)
1308#define SB_ACTIVE (1<<30)
1309#define SB_NOUSER (1<<31)
1310
1311/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 * Umount options
1313 */
1314
1315#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1316#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1317#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001318#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1319#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320
Tejun Heo46b15ca2015-06-16 18:48:31 -04001321/* sb->s_iflags */
1322#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001323#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001324#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Eric W. Biederman95dd7752018-03-14 18:20:29 -05001325#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
Eric W. Biederman8654df42016-06-09 16:06:06 -05001327/* sb->s_iflags to limit user namespace mounts */
1328#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Mimi Zohar57b56ac2018-02-21 11:33:37 -05001329#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1330#define SB_I_UNTRUSTED_MOUNTER 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Jan Kara5accdf82012-06-12 16:20:34 +02001332/* Possible states of 'frozen' field */
1333enum {
1334 SB_UNFROZEN = 0, /* FS is unfrozen */
1335 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001336 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1337 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1338 * internal threads if needed) */
1339 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1340};
1341
1342#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1343
1344struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001345 int frozen; /* Is sb frozen? */
1346 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1347 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001348};
1349
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350struct super_block {
1351 struct list_head s_list; /* Keep this first */
1352 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001353 unsigned char s_blocksize_bits;
1354 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001355 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001357 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001358 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001359 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001360 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001362 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 unsigned long s_magic;
1364 struct dentry *s_root;
1365 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001368#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001370#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001371 const struct xattr_handler **s_xattr;
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001372#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001373 const struct fscrypt_operations *s_cop;
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001374#endif
NeilBrownf1ee6162017-12-21 09:45:40 +11001375 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001376 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001378 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001379 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001380 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001381 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 struct quota_info s_dquot; /* Diskquota specific options */
1383
Jan Kara5accdf82012-06-12 16:20:34 +02001384 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Christoph Hellwig85787092017-05-10 15:06:33 +02001386 char s_id[32]; /* Informational name */
1387 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
1389 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001390 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001391 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001393 /* Granularity of c/m/atime in ns.
1394 Cannot be worse than a second */
1395 u32 s_time_gran;
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 /*
1398 * The next field is for VFS *only*. No filesystems have any business
1399 * even looking at it. You had been warned.
1400 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001401 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001403 /*
1404 * Filesystem subtype. If non-empty the filesystem type field
1405 * in /proc/mounts will be "type.subtype"
1406 */
1407 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001408
Al Viroc8aebb02010-12-18 10:22:30 -05001409 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001410
1411 /*
1412 * Saved pool identifier for cleancache (-1 means none)
1413 */
1414 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001415
1416 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001417
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001418 /* Number of inodes with nlink == 0 but still referenced */
1419 atomic_long_t s_remove_count;
1420
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001421 /* Being remounted read-only */
1422 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001423
1424 /* AIO completions deferred from interrupt context */
1425 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001426 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001427
1428 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001429 * Owning user namespace and default context in which to
1430 * interpret filesystem uids, gids, quotas, device nodes,
1431 * xattrs and security labels.
1432 */
1433 struct user_namespace *s_user_ns;
1434
1435 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001436 * Keep the lru lists last in the structure so they always sit on their
1437 * own individual cachelines.
1438 */
1439 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1440 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001441 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001442 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001443
Dave Chinnere97fedb2015-03-04 13:40:00 -05001444 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001445
1446 /*
1447 * Indicates how deep in a filesystem stack this SB is
1448 */
1449 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001450
1451 /* s_inode_list_lock protects s_inodes */
1452 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1453 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001454
1455 spinlock_t s_inode_wblist_lock;
1456 struct list_head s_inodes_wb; /* writeback inodes */
Kees Cook3859a272016-10-28 01:22:25 -07001457} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Seth Forshee81754352014-12-11 10:15:45 -06001459/* Helper functions so that in most cases filesystems will
1460 * not need to deal directly with kuid_t and kgid_t and can
1461 * instead deal with the raw numeric values that are stored
1462 * in the filesystem.
1463 */
1464static inline uid_t i_uid_read(const struct inode *inode)
1465{
1466 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1467}
1468
1469static inline gid_t i_gid_read(const struct inode *inode)
1470{
1471 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1472}
1473
1474static inline void i_uid_write(struct inode *inode, uid_t uid)
1475{
1476 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1477}
1478
1479static inline void i_gid_write(struct inode *inode, gid_t gid)
1480{
1481 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1482}
1483
Deepa Dinamani8efd6892018-04-22 20:18:46 -07001484extern struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001485extern struct timespec64 current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
1487/*
1488 * Snapshotting support.
1489 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
Jan Kara5accdf82012-06-12 16:20:34 +02001491void __sb_end_write(struct super_block *sb, int level);
1492int __sb_start_write(struct super_block *sb, int level, bool wait);
1493
Oleg Nesterovbee91822015-07-19 23:48:20 +02001494#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001495 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001496#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001497 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001498
Jan Kara5accdf82012-06-12 16:20:34 +02001499/**
1500 * sb_end_write - drop write access to a superblock
1501 * @sb: the super we wrote to
1502 *
1503 * Decrement number of writers to the filesystem. Wake up possible waiters
1504 * wanting to freeze the filesystem.
1505 */
1506static inline void sb_end_write(struct super_block *sb)
1507{
1508 __sb_end_write(sb, SB_FREEZE_WRITE);
1509}
1510
1511/**
1512 * sb_end_pagefault - drop write access to a superblock from a page fault
1513 * @sb: the super we wrote to
1514 *
1515 * Decrement number of processes handling write page fault to the filesystem.
1516 * Wake up possible waiters wanting to freeze the filesystem.
1517 */
1518static inline void sb_end_pagefault(struct super_block *sb)
1519{
1520 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1521}
1522
1523/**
1524 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1525 * @sb: the super we wrote to
1526 *
1527 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1528 * waiters wanting to freeze the filesystem.
1529 */
1530static inline void sb_end_intwrite(struct super_block *sb)
1531{
1532 __sb_end_write(sb, SB_FREEZE_FS);
1533}
1534
1535/**
1536 * sb_start_write - get write access to a superblock
1537 * @sb: the super we write to
1538 *
1539 * When a process wants to write data or metadata to a file system (i.e. dirty
1540 * a page or an inode), it should embed the operation in a sb_start_write() -
1541 * sb_end_write() pair to get exclusion against file system freezing. This
1542 * function increments number of writers preventing freezing. If the file
1543 * system is already frozen, the function waits until the file system is
1544 * thawed.
1545 *
1546 * Since freeze protection behaves as a lock, users have to preserve
1547 * ordering of freeze protection and other filesystem locks. Generally,
1548 * freeze protection should be the outermost lock. In particular, we have:
1549 *
1550 * sb_start_write
1551 * -> i_mutex (write path, truncate, directory ops, ...)
1552 * -> s_umount (freeze_super, thaw_super)
1553 */
1554static inline void sb_start_write(struct super_block *sb)
1555{
1556 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1557}
1558
1559static inline int sb_start_write_trylock(struct super_block *sb)
1560{
1561 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1562}
1563
1564/**
1565 * sb_start_pagefault - get write access to a superblock from a page fault
1566 * @sb: the super we write to
1567 *
1568 * When a process starts handling write page fault, it should embed the
1569 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1570 * exclusion against file system freezing. This is needed since the page fault
1571 * is going to dirty a page. This function increments number of running page
1572 * faults preventing freezing. If the file system is already frozen, the
1573 * function waits until the file system is thawed.
1574 *
1575 * Since page fault freeze protection behaves as a lock, users have to preserve
1576 * ordering of freeze protection and other filesystem locks. It is advised to
1577 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1578 * handling code implies lock dependency:
1579 *
1580 * mmap_sem
1581 * -> sb_start_pagefault
1582 */
1583static inline void sb_start_pagefault(struct super_block *sb)
1584{
1585 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1586}
1587
1588/*
1589 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1590 * @sb: the super we write to
1591 *
1592 * This is the third level of protection against filesystem freezing. It is
1593 * free for use by a filesystem. The only requirement is that it must rank
1594 * below sb_start_pagefault.
1595 *
1596 * For example filesystem can call sb_start_intwrite() when starting a
1597 * transaction which somewhat eases handling of freezing for internal sources
1598 * of filesystem changes (internal fs threads, discarding preallocation on file
1599 * close, etc.).
1600 */
1601static inline void sb_start_intwrite(struct super_block *sb)
1602{
1603 __sb_start_write(sb, SB_FREEZE_FS, true);
1604}
1605
Amir Goldstein0c8e3fe2018-05-13 22:40:30 -04001606static inline int sb_start_intwrite_trylock(struct super_block *sb)
1607{
1608 return __sb_start_write(sb, SB_FREEZE_FS, false);
1609}
1610
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001612extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858ab2007-07-17 15:00:08 +05301613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614/*
1615 * VFS helper functions..
1616 */
Al Viro312b63f2012-06-10 18:09:36 -04001617extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001618extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001619extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001620extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001621extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001623extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001624extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001625extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
Amir Goldsteinaf7bd4d2017-01-17 06:34:52 +02001627extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1628 int open_flag);
1629
Al Viro8e6c8482017-12-01 17:12:45 -05001630int vfs_mkobj(struct dentry *, umode_t,
1631 int (*f)(struct dentry *, umode_t, void *),
1632 void *);
1633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001635 * VFS file helper functions.
1636 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001637extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001638 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001639extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001640/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001641 * VFS FS_IOC_FIEMAP helper definitions.
1642 */
1643struct fiemap_extent_info {
1644 unsigned int fi_flags; /* Flags as passed from user */
1645 unsigned int fi_extents_mapped; /* Number of mapped extents */
1646 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001647 struct fiemap_extent __user *fi_extents_start; /* Start of
1648 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001649};
1650int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1651 u64 phys, u64 len, u32 flags);
1652int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1653
1654/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 * File types
1656 *
1657 * NOTE! These match bits 12..15 of stat.st_mode
1658 * (ie "(i_mode >> 12) & 15").
1659 */
1660#define DT_UNKNOWN 0
1661#define DT_FIFO 1
1662#define DT_CHR 2
1663#define DT_DIR 4
1664#define DT_BLK 6
1665#define DT_REG 8
1666#define DT_LNK 10
1667#define DT_SOCK 12
1668#define DT_WHT 14
1669
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670/*
1671 * This is the "filldir" function type, used by readdir() to let
1672 * the kernel specify what kind of dirent layout it wants to have.
1673 * This allows the kernel to read directories into kernel space or
1674 * to have different dirent layouts depending on the binary type.
1675 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001676struct dir_context;
1677typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1678 unsigned);
1679
Al Viro5c0ba4e2013-05-15 13:52:59 -04001680struct dir_context {
David Howellsa09acf42018-04-09 21:12:30 +01001681 filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001682 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001683};
Al Virobb6f6192013-05-15 18:49:12 -04001684
Al Viro08f85852007-10-08 13:26:20 -04001685struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687/* These macros are for out of kernel modules to test that
1688 * the kernel supports the unlocked_ioctl and compat_ioctl
1689 * fields in struct file_operations. */
1690#define HAVE_COMPAT_IOCTL 1
1691#define HAVE_UNLOCKED_IOCTL 1
1692
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001693/*
1694 * These flags let !MMU mmap() govern direct device mapping vs immediate
1695 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1696 *
1697 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1698 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1699 * NOMMU_MAP_READ: Can be mapped for reading
1700 * NOMMU_MAP_WRITE: Can be mapped for writing
1701 * NOMMU_MAP_EXEC: Can be mapped for execution
1702 */
1703#define NOMMU_MAP_COPY 0x00000001
1704#define NOMMU_MAP_DIRECT 0x00000008
1705#define NOMMU_MAP_READ VM_MAYREAD
1706#define NOMMU_MAP_WRITE VM_MAYWRITE
1707#define NOMMU_MAP_EXEC VM_MAYEXEC
1708
1709#define NOMMU_VMFLAGS \
1710 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1711
1712
Al Viro293bc982014-02-11 18:37:41 -05001713struct iov_iter;
1714
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715struct file_operations {
1716 struct module *owner;
1717 loff_t (*llseek) (struct file *, loff_t, int);
1718 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001720 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1721 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001722 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001723 int (*iterate_shared) (struct file *, struct dir_context *);
Al Viroa3f86832017-07-02 22:22:01 -04001724 __poll_t (*poll) (struct file *, struct poll_table_struct *);
Christoph Hellwig3deb6422018-01-09 15:29:24 +01001725 struct wait_queue_head * (*get_poll_head)(struct file *, __poll_t);
1726 __poll_t (*poll_mask) (struct file *, __poll_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1728 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1729 int (*mmap) (struct file *, struct vm_area_struct *);
Dan Williams1c972592017-11-01 16:36:30 +01001730 unsigned long mmap_supported_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001732 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001734 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 int (*fasync) (int, struct file *, int);
1736 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1738 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1739 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001741 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1742 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001743 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001744 long (*fallocate)(struct file *file, int mode, loff_t offset,
1745 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001746 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001747#ifndef CONFIG_MMU
1748 unsigned (*mmap_capabilities)(struct file *);
1749#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001750 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1751 loff_t, size_t, unsigned int);
1752 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1753 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001754 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1755 u64);
Kees Cook3859a272016-10-28 01:22:25 -07001756} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757
1758struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001759 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001760 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb22011-06-20 19:28:19 -04001761 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001762 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001763
1764 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001765
Al Viroebfc3b42012-06-10 18:05:36 -04001766 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 int (*link) (struct dentry *,struct inode *,struct dentry *);
1768 int (*unlink) (struct inode *,struct dentry *);
1769 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001770 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001772 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001774 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 int (*setattr) (struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00001776 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001778 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1779 u64 len);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001780 int (*update_time)(struct inode *, struct timespec64 *, int);
Al Virod9585272012-06-22 12:39:14 +04001781 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001782 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001783 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001784 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001785 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001786} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
Miklos Szeredibb7462b2017-02-20 16:51:23 +01001788static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1789 struct iov_iter *iter)
1790{
1791 return file->f_op->read_iter(kio, iter);
1792}
1793
1794static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1795 struct iov_iter *iter)
1796{
1797 return file->f_op->write_iter(kio, iter);
1798}
1799
Miklos Szeredif74ac012017-02-20 16:51:23 +01001800static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1801{
1802 return file->f_op->mmap(file, vma);
1803}
1804
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001805ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001806 unsigned long nr_segs, unsigned long fast_segs,
1807 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001808 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001809
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001810extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1812extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1813extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02001814 unsigned long, loff_t *, rwf_t);
Zach Brown29732932015-11-10 16:53:30 -05001815extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1816 loff_t, size_t, unsigned int);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001817extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1818 struct inode *inode_out, loff_t pos_out,
1819 u64 *len, bool is_dedupe);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001820extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1821 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001822extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1823 struct inode *dest, loff_t destoff,
1824 loff_t len, bool *is_same);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001825extern int vfs_dedupe_file_range(struct file *file,
1826 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828struct super_operations {
1829 struct inode *(*alloc_inode)(struct super_block *sb);
1830 void (*destroy_inode)(struct inode *);
1831
Christoph Hellwigaa385722011-05-27 06:53:02 -04001832 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001833 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001834 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001835 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001838 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001839 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001840 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001841 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001842 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001844 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
Al Viro34c80b12011-12-08 21:32:45 -05001846 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001847 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001848 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001849 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001850#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1852 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001853 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001854#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001855 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001856 long (*nr_cached_objects)(struct super_block *,
1857 struct shrink_control *);
1858 long (*free_cached_objects)(struct super_block *,
1859 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860};
1861
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001862/*
David Howellsbbc10962012-10-15 16:40:35 +01001863 * Inode flags - they have no relation to superblock flags now
1864 */
1865#define S_SYNC 1 /* Writes are synced at once */
1866#define S_NOATIME 2 /* Do not update access times */
1867#define S_APPEND 4 /* Append-only file */
1868#define S_IMMUTABLE 8 /* Immutable file */
1869#define S_DEAD 16 /* removed, but still open directory */
1870#define S_NOQUOTA 32 /* Inode is not counted to quota */
1871#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1872#define S_NOCMTIME 128 /* Do not update file c/mtime */
1873#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1874#define S_PRIVATE 512 /* Inode is fs-internal */
1875#define S_IMA 1024 /* Inode has an associated IMA struct */
1876#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1877#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001878#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001879#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1880#else
1881#define S_DAX 0 /* Make all the DAX code disappear */
1882#endif
Eric Biggers2ee6a572017-10-09 12:15:35 -07001883#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
David Howellsbbc10962012-10-15 16:40:35 +01001884
1885/*
1886 * Note that nosuid etc flags are inode-specific: setting some file-system
1887 * flags just means all the inodes inherit those flags by default. It might be
1888 * possible to override it selectively if you really wanted to with some
1889 * ioctl() that is not currently implemented.
1890 *
David Howellse462ec52017-07-17 08:45:35 +01001891 * Exception: SB_RDONLY is always applied to the entire file system.
David Howellsbbc10962012-10-15 16:40:35 +01001892 *
1893 * Unfortunately, it is possible to change a filesystems flags with it mounted
1894 * with files in use. This means that all of the inodes will not have their
1895 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1896 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1897 */
1898#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1899
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001900static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
David Howells94e92e72017-07-17 08:45:34 +01001901#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
David Howellse462ec52017-07-17 08:45:35 +01001902#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
David Howellsbbc10962012-10-15 16:40:35 +01001903 ((inode)->i_flags & S_SYNC))
David Howellse462ec52017-07-17 08:45:35 +01001904#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
David Howellsbbc10962012-10-15 16:40:35 +01001905 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
David Howellse462ec52017-07-17 08:45:35 +01001906#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
1907#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1908#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
David Howellsbbc10962012-10-15 16:40:35 +01001909
1910#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1911#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1912#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
David Howellse462ec52017-07-17 08:45:35 +01001913#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
David Howellsbbc10962012-10-15 16:40:35 +01001914
1915#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1916#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1917#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1918#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1919#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1920#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1921#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001922#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Eric Biggers2ee6a572017-10-09 12:15:35 -07001923#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
David Howellsbbc10962012-10-15 16:40:35 +01001924
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001925#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1926 (inode)->i_rdev == WHITEOUT_DEV)
1927
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001928static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1929{
1930 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1931}
1932
Jens Axboec75b1d92017-06-27 11:47:04 -06001933static inline enum rw_hint file_write_hint(struct file *file)
1934{
1935 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1936 return file->f_write_hint;
1937
1938 return file_inode(file)->i_write_hint;
1939}
1940
1941static inline int iocb_flags(struct file *file);
1942
Adam Manzanaresfc287242018-05-22 10:52:18 -07001943static inline u16 ki_hint_validate(enum rw_hint hint)
1944{
1945 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
1946
1947 if (hint <= max_hint)
1948 return hint;
1949 return 0;
1950}
1951
Jens Axboec75b1d92017-06-27 11:47:04 -06001952static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1953{
1954 *kiocb = (struct kiocb) {
1955 .ki_filp = filp,
1956 .ki_flags = iocb_flags(filp),
Adam Manzanaresfc287242018-05-22 10:52:18 -07001957 .ki_hint = ki_hint_validate(file_write_hint(filp)),
Adam Manzanaresd9a08a92018-05-22 10:52:19 -07001958 .ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0),
Jens Axboec75b1d92017-06-27 11:47:04 -06001959 };
1960}
1961
David Howellsbbc10962012-10-15 16:40:35 +01001962/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001963 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001964 *
1965 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1966 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1967 *
1968 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1969 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1970 * various stages of removing an inode.
1971 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001972 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001973 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001974 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1975 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001976 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1977 * these changes separately from I_DIRTY_SYNC so that we
1978 * don't have to write inode on fdatasync() when only
1979 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001980 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001981 * I_NEW Serves as both a mutex and completion notification.
1982 * New inodes set I_NEW. If two processes both create
1983 * the same inode, one of them will release its inode and
1984 * wait for I_NEW to be released before returning.
1985 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1986 * also cause waiting on I_NEW, without I_NEW actually
1987 * being set. find_inode() uses this to prevent returning
1988 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001989 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1990 * is zero. I_FREEING must be set when I_WILL_FREE is
1991 * cleared.
1992 * I_FREEING Set when inode is about to be freed but still has dirty
1993 * pages or buffers attached or the inode itself is still
1994 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001995 * I_CLEAR Added by clear_inode(). In this state the inode is
1996 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001997 *
1998 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1999 * prohibited for many purposes. iget() must wait for
2000 * the inode to be completely released, then create it
2001 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002002 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002003 *
Jan Kara169ebd92012-05-03 14:48:03 +02002004 * I_SYNC Writeback of inode is running. The bit is set during
2005 * data writeback, and cleared with a wakeup on the bit
2006 * address once it is done. The bit is also used to pin
2007 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002008 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002009 * I_REFERENCED Marks the inode as recently references on the LRU list.
2010 *
2011 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2012 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04002013 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2014 * synchronize competing switching instances and to tell
Matthew Wilcoxb93b0162018-04-10 16:36:56 -07002015 * wb stat updates to grab the i_pages lock. See
Tejun Heo682aa8e2015-05-28 14:50:53 -04002016 * inode_switch_wb_work_fn() for details.
2017 *
Amir Goldsteinad0af712017-06-21 15:28:32 +03002018 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2019 * and work dirs among overlayfs mounts.
2020 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002021 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002022 */
Nick Piggin9e38d862010-10-23 06:55:17 -04002023#define I_DIRTY_SYNC (1 << 0)
2024#define I_DIRTY_DATASYNC (1 << 1)
2025#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002026#define __I_NEW 3
2027#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04002028#define I_WILL_FREE (1 << 4)
2029#define I_FREEING (1 << 5)
2030#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002031#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002032#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002033#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002034#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002035#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002036#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002037#define I_DIRTY_TIME (1 << 11)
2038#define __I_DIRTY_TIME_EXPIRED 12
2039#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002040#define I_WB_SWITCH (1 << 13)
Amir Goldsteinad0af712017-06-21 15:28:32 +03002041#define I_OVL_INUSE (1 << 14)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Christoph Hellwig0e11f642018-02-21 07:54:49 -08002043#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2044#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002045#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
2047extern void __mark_inode_dirty(struct inode *, int);
2048static inline void mark_inode_dirty(struct inode *inode)
2049{
2050 __mark_inode_dirty(inode, I_DIRTY);
2051}
2052
2053static inline void mark_inode_dirty_sync(struct inode *inode)
2054{
2055 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2056}
2057
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002058extern void inc_nlink(struct inode *inode);
2059extern void drop_nlink(struct inode *inode);
2060extern void clear_nlink(struct inode *inode);
2061extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002062
2063static inline void inode_inc_link_count(struct inode *inode)
2064{
2065 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002066 mark_inode_dirty(inode);
2067}
2068
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002069static inline void inode_dec_link_count(struct inode *inode)
2070{
2071 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002072 mark_inode_dirty(inode);
2073}
2074
Josef Bacikc3b2da32012-03-26 09:59:21 -04002075enum file_time_flags {
2076 S_ATIME = 1,
2077 S_MTIME = 2,
2078 S_CTIME = 4,
2079 S_VERSION = 8,
2080};
2081
Al Virobadcf2b2013-07-16 18:15:46 +04002082extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083static inline void file_accessed(struct file *file)
2084{
2085 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002086 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087}
2088
2089int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002090int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092struct file_system_type {
2093 const char *name;
2094 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002095#define FS_REQUIRES_DEV 1
2096#define FS_BINARY_MOUNTDATA 2
2097#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002098#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002099#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002100 struct dentry *(*mount) (struct file_system_type *, int,
2101 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 void (*kill_sb) (struct super_block *);
2103 struct module *owner;
2104 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002105 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002106
Ingo Molnarcf516242006-07-03 00:25:27 -07002107 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002108 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002109 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002110 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002111
2112 struct lock_class_key i_lock_key;
2113 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002114 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115};
2116
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002117#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2118
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002119extern struct dentry *mount_ns(struct file_system_type *fs_type,
2120 int flags, void *data, void *ns, struct user_namespace *user_ns,
2121 int (*fill_super)(struct super_block *, void *, int));
Al Virof175f302017-10-15 00:38:00 -04002122#ifdef CONFIG_BLOCK
Al Viro152a0832010-07-25 00:46:55 +04002123extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2124 int flags, const char *dev_name, void *data,
2125 int (*fill_super)(struct super_block *, void *, int));
Al Virof175f302017-10-15 00:38:00 -04002126#else
2127static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2128 int flags, const char *dev_name, void *data,
2129 int (*fill_super)(struct super_block *, void *, int))
2130{
2131 return ERR_PTR(-ENODEV);
2132}
2133#endif
Al Virofc14f2f2010-07-25 01:48:30 +04002134extern struct dentry *mount_single(struct file_system_type *fs_type,
2135 int flags, void *data,
2136 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002137extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2138 int flags, void *data,
2139 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002140extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141void generic_shutdown_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002142#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143void kill_block_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002144#else
2145static inline void kill_block_super(struct super_block *sb)
2146{
2147 BUG();
2148}
2149#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150void kill_anon_super(struct super_block *sb);
2151void kill_litter_super(struct super_block *sb);
2152void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002153void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002155int get_anon_bdev(dev_t *);
2156void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002157struct super_block *sget_userns(struct file_system_type *type,
2158 int (*test)(struct super_block *,void *),
2159 int (*set)(struct super_block *,void *),
2160 int flags, struct user_namespace *user_ns,
2161 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162struct super_block *sget(struct file_system_type *type,
2163 int (*test)(struct super_block *,void *),
2164 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002165 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002166extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2167 const struct super_operations *ops,
2168 const struct xattr_handler **xattr,
2169 const struct dentry_operations *dops,
2170 unsigned long);
2171
2172static inline struct dentry *
2173mount_pseudo(struct file_system_type *fs_type, char *name,
2174 const struct super_operations *ops,
2175 const struct dentry_operations *dops, unsigned long magic)
2176{
2177 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2178}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
2180/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2181#define fops_get(fops) \
2182 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2183#define fops_put(fops) \
2184 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002185/*
2186 * This one is to be used *ONLY* from ->open() instances.
2187 * fops must be non-NULL, pinned down *and* module dependencies
2188 * should be sufficient to pin the caller down as well.
2189 */
2190#define replace_fops(f, fops) \
2191 do { \
2192 struct file *__file = (f); \
2193 fops_put(__file->f_op); \
2194 BUG_ON(!(__file->f_op = (fops))); \
2195 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196
2197extern int register_filesystem(struct file_system_type *);
2198extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002199extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2200#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002201extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202extern int may_umount_tree(struct vfsmount *);
2203extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002204extern long do_mount(const char *, const char __user *,
2205 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002206extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002207extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002208extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2209 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002210extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002211extern int user_statfs(const char __user *, struct kstatfs *);
2212extern int fd_statfs(int, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002213extern int freeze_super(struct super_block *super);
2214extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002215extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002216extern __printf(2, 3)
2217int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2218extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219
Al Viroce3b0f82009-03-29 19:08:22 -04002220extern int current_umask(void);
2221
J. Bruce Fields5a146962012-08-28 07:50:40 -07002222extern void ihold(struct inode * inode);
2223extern void iput(struct inode *);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002224extern int generic_update_time(struct inode *, struct timespec64 *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002225
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002226/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002227extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002228
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002229#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002230
Jeff Layton9e8925b2015-11-16 09:49:34 -05002231#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002232extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002233extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234
2235/*
2236 * Candidates for mandatory locking have the setgid bit set
2237 * but no group execute bit - an otherwise meaningless combination.
2238 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002239
2240static inline int __mandatory_lock(struct inode *ino)
2241{
2242 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2243}
2244
2245/*
David Howellse462ec52017-07-17 08:45:35 +01002246 * ... and these candidates should be on SB_MANDLOCK mounted fs,
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002247 * otherwise these will be advisory locks
2248 */
2249
2250static inline int mandatory_lock(struct inode *ino)
2251{
2252 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2253}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254
Jeff Laytond7a06982014-03-10 09:54:15 -04002255static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256{
Miklos Szeredic568d682016-09-16 12:44:20 +02002257 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002258 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 return 0;
2260}
2261
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002263 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 loff_t size)
2265{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002266 if (!inode->i_flctx || !mandatory_lock(inode))
2267 return 0;
2268
2269 if (size < inode->i_size) {
2270 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2271 F_WRLCK);
2272 } else {
2273 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2274 F_WRLCK);
2275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276}
2277
Jeff Layton9e8925b2015-11-16 09:49:34 -05002278#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2279
2280static inline int locks_mandatory_locked(struct file *file)
2281{
2282 return 0;
2283}
2284
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002285static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2286 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002287{
2288 return 0;
2289}
2290
2291static inline int __mandatory_lock(struct inode *inode)
2292{
2293 return 0;
2294}
2295
2296static inline int mandatory_lock(struct inode *inode)
2297{
2298 return 0;
2299}
2300
2301static inline int locks_verify_locked(struct file *file)
2302{
2303 return 0;
2304}
2305
2306static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2307 size_t size)
2308{
2309 return 0;
2310}
2311
2312#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2313
2314
2315#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316static inline int break_lease(struct inode *inode, unsigned int mode)
2317{
Jeff Layton24cbe782014-02-03 12:13:06 -05002318 /*
2319 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002320 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2321 * could end up racing with tasks trying to set a new lease on this
2322 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002323 */
2324 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002325 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002326 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 return 0;
2328}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002329
2330static inline int break_deleg(struct inode *inode, unsigned int mode)
2331{
Jeff Layton962bd402014-06-10 12:24:40 -04002332 /*
2333 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002334 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2335 * could end up racing with tasks trying to set a new lease on this
2336 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002337 */
2338 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002339 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002340 return __break_lease(inode, mode, FL_DELEG);
2341 return 0;
2342}
2343
J. Bruce Fields5a146962012-08-28 07:50:40 -07002344static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2345{
2346 int ret;
2347
2348 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2349 if (ret == -EWOULDBLOCK && delegated_inode) {
2350 *delegated_inode = inode;
2351 ihold(inode);
2352 }
2353 return ret;
2354}
2355
2356static inline int break_deleg_wait(struct inode **delegated_inode)
2357{
2358 int ret;
2359
2360 ret = break_deleg(*delegated_inode, O_WRONLY);
2361 iput(*delegated_inode);
2362 *delegated_inode = NULL;
2363 return ret;
2364}
2365
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002366static inline int break_layout(struct inode *inode, bool wait)
2367{
2368 smp_mb();
2369 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2370 return __break_lease(inode,
2371 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2372 FL_LAYOUT);
2373 return 0;
2374}
2375
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002376#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002377static inline int break_lease(struct inode *inode, unsigned int mode)
2378{
2379 return 0;
2380}
2381
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002382static inline int break_deleg(struct inode *inode, unsigned int mode)
2383{
2384 return 0;
2385}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002386
2387static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2388{
2389 return 0;
2390}
2391
2392static inline int break_deleg_wait(struct inode **delegated_inode)
2393{
2394 BUG();
2395 return 0;
2396}
2397
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002398static inline int break_layout(struct inode *inode, bool wait)
2399{
2400 return 0;
2401}
2402
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002403#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404
2405/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002406struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002407struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002408 const char *name; /* pointer to actual string */
2409 const __user char *uptr; /* original userland pointer */
Paul Moore55422d02015-01-22 00:00:23 -05002410 int refcnt;
Rasmus Villemoes1c9498432018-03-01 00:19:21 +01002411 struct audit_names *aname;
Al Virofd2f7cb2015-02-22 20:07:13 -05002412 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002413};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414
Al Viro7df818b2016-03-25 14:24:09 -04002415extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002416extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2417 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002418extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002419 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002420extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002421 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002422extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002423extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002424extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002425 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002426extern struct file * dentry_open(const struct path *, int, const struct cred *);
Al Viro19f391e2018-06-08 11:19:32 -04002427static inline struct file *file_clone_open(struct file *file)
2428{
2429 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2430}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002432
David Drysdale51f39a12014-12-12 16:57:29 -08002433extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002434extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002435extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002436extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002437
Al Viro47237682012-06-10 05:01:45 -04002438enum {
2439 FILE_CREATED = 1,
2440 FILE_OPENED = 2
2441};
Al Viro30d90492012-06-22 12:40:19 +04002442extern int finish_open(struct file *file, struct dentry *dentry,
2443 int (*open)(struct inode *, struct file *),
2444 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002445extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002447/* fs/ioctl.c */
2448
2449extern int ioctl_preallocate(struct file *filp, void __user *argp);
2450
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451/* fs/dcache.c */
2452extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002453extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454
Christoph Lameterb86c0892006-12-06 20:32:57 -08002455extern struct kmem_cache *names_cachep;
2456
Jeff Laytona608ca22012-10-10 15:25:26 -04002457#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002458#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459
David Howells93614012006-09-30 20:45:40 +02002460#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002462extern void unregister_blkdev(unsigned int, const char *);
Jan Karaf44f1ab2017-02-02 15:56:49 +01002463extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002465extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466extern void bd_set_size(struct block_device *, loff_t size);
2467extern void bd_forget(struct inode *inode);
2468extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002469extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002470extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002471extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002472extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002473extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002474extern void emergency_thaw_all(void);
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002475extern void emergency_thaw_bdev(struct super_block *sb);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002476extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2477extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002478
2479extern struct super_block *blockdev_superblock;
2480
2481static inline bool sb_is_blkdev_sb(struct super_block *sb)
2482{
2483 return sb == blockdev_superblock;
2484}
David Howells93614012006-09-30 20:45:40 +02002485#else
2486static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002487static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002488static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002489static inline void invalidate_bdev(struct block_device *bdev) {}
2490
2491static inline struct super_block *freeze_bdev(struct block_device *sb)
2492{
2493 return NULL;
2494}
2495
2496static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2497{
2498 return 0;
2499}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002500
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002501static inline int emergency_thaw_bdev(struct super_block *sb)
2502{
2503 return 0;
2504}
2505
Jan Kara5c0d6b62012-07-03 16:45:31 +02002506static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2507{
2508}
Jan Karaa8855992013-07-09 22:36:45 +08002509
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002510static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002511{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002512 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002513}
David Howells93614012006-09-30 20:45:40 +02002514#endif
Jan Kara60b06802009-04-27 16:43:53 +02002515extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002516extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002517extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002518#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002520extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002522extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002523extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2524 void *holder);
2525extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2526 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002527extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002528extern int __blkdev_reread_part(struct block_device *bdev);
2529extern int blkdev_reread_part(struct block_device *bdev);
2530
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002531#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002532extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002533extern void bd_unlink_disk_holder(struct block_device *bdev,
2534 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002535#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002536static inline int bd_link_disk_holder(struct block_device *bdev,
2537 struct gendisk *disk)
2538{
2539 return 0;
2540}
Tejun Heo49731ba2011-01-14 18:43:57 +01002541static inline void bd_unlink_disk_holder(struct block_device *bdev,
2542 struct gendisk *disk)
2543{
2544}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002545#endif
David Howells93614012006-09-30 20:45:40 +02002546#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547
2548/* fs/char_dev.c */
Logan Gunthorpe8a932f72017-06-15 14:05:21 -06002549#define CHRDEV_MAJOR_MAX 512
Linus Walleij49db08c2016-02-19 15:36:07 +01002550/* Marks the bottom of the first segment of free char majors */
2551#define CHRDEV_MAJOR_DYN_END 234
Logan Gunthorpea5d31a32017-06-15 14:05:20 -06002552/* Marks the top and bottom of the second segment of free char majors */
2553#define CHRDEV_MAJOR_DYN_EXT_START 511
2554#define CHRDEV_MAJOR_DYN_EXT_END 384
2555
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2557extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002558extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2559 unsigned int count, const char *name,
2560 const struct file_operations *fops);
2561extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2562 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002564extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565
Tejun Heo1905b1b2009-08-06 18:13:23 +09002566static inline int register_chrdev(unsigned int major, const char *name,
2567 const struct file_operations *fops)
2568{
2569 return __register_chrdev(major, 0, 256, name, fops);
2570}
2571
2572static inline void unregister_chrdev(unsigned int major, const char *name)
2573{
2574 __unregister_chrdev(major, 0, 256, name);
2575}
2576
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577/* fs/block_dev.c */
2578#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002579#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002580
2581#ifdef CONFIG_BLOCK
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002582#define BLKDEV_MAJOR_MAX 512
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583extern const char *__bdevname(dev_t, char *buffer);
2584extern const char *bdevname(struct block_device *bdev, char *buffer);
2585extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002586extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002587
David Howells93614012006-09-30 20:45:40 +02002588#else
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002589#define BLKDEV_MAJOR_MAX 0
David Howells93614012006-09-30 20:45:40 +02002590#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591
2592extern void init_special_inode(struct inode *, umode_t, dev_t);
2593
2594/* Invalid inode operations -- fs/bad_inode.c */
2595extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002596extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597
Jens Axboec11f0c02016-08-05 08:11:04 -06002598#ifdef CONFIG_BLOCK
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002599extern void check_disk_size_change(struct gendisk *disk,
Christoph Hellwig5afb7832018-05-29 16:42:59 +02002600 struct block_device *bdev, bool verbose);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002601extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002603extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002605#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606unsigned long invalidate_mapping_pages(struct address_space *mapping,
2607 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002608
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609static inline void invalidate_remote_inode(struct inode *inode)
2610{
2611 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2612 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002613 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614}
2615extern int invalidate_inode_pages2(struct address_space *mapping);
2616extern int invalidate_inode_pages2_range(struct address_space *mapping,
2617 pgoff_t start, pgoff_t end);
2618extern int write_inode_now(struct inode *, int);
2619extern int filemap_fdatawrite(struct address_space *);
2620extern int filemap_flush(struct address_space *);
Jeff Layton76341ca2017-07-06 07:02:22 -04002621extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002622extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2623 loff_t lend);
Jeff Laytonffb959b2017-07-31 10:29:38 -04002624
2625static inline int filemap_fdatawait(struct address_space *mapping)
2626{
2627 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2628}
2629
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002630extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2631 loff_t lend);
Jeff Laytona823e452017-07-28 07:24:43 -04002632extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2633 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634extern int filemap_write_and_wait(struct address_space *mapping);
2635extern int filemap_write_and_wait_range(struct address_space *mapping,
2636 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002637extern int __filemap_fdatawrite_range(struct address_space *mapping,
2638 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002639extern int filemap_fdatawrite_range(struct address_space *mapping,
2640 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002641extern int filemap_check_errors(struct address_space *mapping);
Jeff Layton5660e132017-07-06 07:02:25 -04002642extern void __filemap_set_wb_err(struct address_space *mapping, int err);
Jeff Laytona823e452017-07-28 07:24:43 -04002643
2644extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2645 loff_t lend);
Jeff Layton5660e132017-07-06 07:02:25 -04002646extern int __must_check file_check_and_advance_wb_err(struct file *file);
2647extern int __must_check file_write_and_wait_range(struct file *file,
2648 loff_t start, loff_t end);
2649
Jeff Laytona823e452017-07-28 07:24:43 -04002650static inline int file_write_and_wait(struct file *file)
2651{
2652 return file_write_and_wait_range(file, 0, LLONG_MAX);
2653}
2654
Jeff Layton5660e132017-07-06 07:02:25 -04002655/**
2656 * filemap_set_wb_err - set a writeback error on an address_space
2657 * @mapping: mapping in which to set writeback error
2658 * @err: error to be set in mapping
2659 *
2660 * When writeback fails in some way, we must record that error so that
2661 * userspace can be informed when fsync and the like are called. We endeavor
2662 * to report errors on any file that was open at the time of the error. Some
2663 * internal callers also need to know when writeback errors have occurred.
2664 *
2665 * When a writeback error occurs, most filesystems will want to call
2666 * filemap_set_wb_err to record the error in the mapping so that it will be
2667 * automatically reported whenever fsync is called on the file.
Jeff Layton5660e132017-07-06 07:02:25 -04002668 */
2669static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2670{
2671 /* Fastpath for common case of no error */
2672 if (unlikely(err))
2673 __filemap_set_wb_err(mapping, err);
2674}
2675
2676/**
2677 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2678 * @mapping: mapping to check for writeback errors
2679 * @since: previously-sampled errseq_t
2680 *
2681 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2682 * the given value was sampled.
2683 *
2684 * If it has then report the latest error set, otherwise return 0.
2685 */
2686static inline int filemap_check_wb_err(struct address_space *mapping,
2687 errseq_t since)
2688{
2689 return errseq_check(&mapping->wb_err, since);
2690}
2691
2692/**
2693 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2694 * @mapping: mapping to be sampled
2695 *
2696 * Writeback errors are always reported relative to a particular sample point
2697 * in the past. This function provides those sample points.
2698 */
2699static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2700{
2701 return errseq_sample(&mapping->wb_err);
2702}
2703
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002704extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2705 int datasync);
2706extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002707
2708/*
2709 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2710 * to already be updated for the write, and will return either the amount
2711 * of bytes passed in, or an error if syncing the file failed.
2712 */
2713static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002714{
Christoph Hellwige2592212016-04-07 08:52:01 -07002715 if (iocb->ki_flags & IOCB_DSYNC) {
2716 int ret = vfs_fsync_range(iocb->ki_filp,
2717 iocb->ki_pos - count, iocb->ki_pos - 1,
2718 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2719 if (ret)
2720 return ret;
2721 }
2722
2723 return count;
Al Virod311d792014-02-09 15:18:09 -05002724}
Christoph Hellwige2592212016-04-07 08:52:01 -07002725
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726extern void emergency_sync(void);
2727extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002728#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002730#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002731extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002732extern int inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002733extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002734extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735
Miklos Szeredif696a362008-07-31 13:41:58 +02002736static inline bool execute_ok(struct inode *inode)
2737{
2738 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2739}
2740
Al Viro8d71db42013-03-19 21:01:03 -04002741static inline void file_start_write(struct file *file)
2742{
2743 if (!S_ISREG(file_inode(file)->i_mode))
2744 return;
2745 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2746}
2747
Jan Kara5ae98f12013-05-04 00:11:23 +02002748static inline bool file_start_write_trylock(struct file *file)
2749{
2750 if (!S_ISREG(file_inode(file)->i_mode))
2751 return true;
2752 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2753}
2754
Al Viro8d71db42013-03-19 21:01:03 -04002755static inline void file_end_write(struct file *file)
2756{
2757 if (!S_ISREG(file_inode(file)->i_mode))
2758 return;
2759 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2760}
2761
Amir Goldsteinbfe219d2017-01-31 10:34:57 +02002762static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
2763 struct file *file_out, loff_t pos_out,
2764 u64 len)
2765{
2766 int ret;
2767
2768 file_start_write(file_out);
2769 ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
2770 file_end_write(file_out);
2771
2772 return ret;
2773}
2774
Al Viro07b8ce12011-06-20 10:52:57 -04002775/*
2776 * get_write_access() gets write permission for a file.
2777 * put_write_access() releases this write permission.
2778 * This is used for regular files.
2779 * We cannot support write (and maybe mmap read-write shared) accesses and
2780 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2781 * can have the following values:
2782 * 0: no writers, no VM_DENYWRITE mappings
2783 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2784 * > 0: (i_writecount) users are writing to the file.
2785 *
2786 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2787 * except for the cases where we don't hold i_writecount yet. Then we need to
2788 * use {get,deny}_write_access() - these functions check the sign and refuse
2789 * to do the change if sign is wrong.
2790 */
2791static inline int get_write_access(struct inode *inode)
2792{
2793 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2794}
2795static inline int deny_write_access(struct file *file)
2796{
Al Viro496ad9a2013-01-23 17:07:38 -05002797 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002798 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2799}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800static inline void put_write_access(struct inode * inode)
2801{
2802 atomic_dec(&inode->i_writecount);
2803}
2804static inline void allow_write_access(struct file *file)
2805{
2806 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002807 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808}
David Howellsf1fe29b2013-09-27 11:20:03 +01002809static inline bool inode_is_open_for_write(const struct inode *inode)
2810{
2811 return atomic_read(&inode->i_writecount) > 0;
2812}
2813
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002814#ifdef CONFIG_IMA
2815static inline void i_readcount_dec(struct inode *inode)
2816{
2817 BUG_ON(!atomic_read(&inode->i_readcount));
2818 atomic_dec(&inode->i_readcount);
2819}
2820static inline void i_readcount_inc(struct inode *inode)
2821{
2822 atomic_inc(&inode->i_readcount);
2823}
2824#else
2825static inline void i_readcount_dec(struct inode *inode)
2826{
2827 return;
2828}
2829static inline void i_readcount_inc(struct inode *inode)
2830{
2831 return;
2832}
2833#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002834extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835
Mimi Zohar1284ab52016-04-20 15:46:27 -07002836#define __kernel_read_file_id(id) \
2837 id(UNKNOWN, unknown) \
2838 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002839 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002840 id(MODULE, kernel-module) \
2841 id(KEXEC_IMAGE, kexec-image) \
2842 id(KEXEC_INITRAMFS, kexec-initramfs) \
2843 id(POLICY, security-policy) \
Christoph Hellwiga7d3d032017-09-10 09:49:45 +02002844 id(X509_CERTIFICATE, x509-certificate) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002845 id(MAX_ID, )
2846
2847#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2848#define __fid_stringify(dummy, str) #str,
2849
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002850enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002851 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002852};
2853
Mimi Zohar1284ab52016-04-20 15:46:27 -07002854static const char * const kernel_read_file_str[] = {
2855 __kernel_read_file_id(__fid_stringify)
2856};
2857
Kees Cookda20dfe2016-04-21 12:53:29 -07002858static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002859{
Arnd Bergmanncbfd0c12017-03-09 16:16:57 -08002860 if ((unsigned)id >= READING_MAX_ID)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002861 return kernel_read_file_str[READING_UNKNOWN];
2862
2863 return kernel_read_file_str[id];
2864}
2865
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002866extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2867 enum kernel_read_file_id);
Mimi Zohar711aab12017-09-12 22:45:33 -04002868extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
Mimi Zohar09596b92015-11-19 12:39:22 -05002869 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002870extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2871 enum kernel_read_file_id);
Christoph Hellwigbdd1d2d2017-09-01 17:39:13 +02002872extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
Christoph Hellwige13ec932017-09-01 17:39:14 +02002873extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
Christoph Hellwig73e18f72017-09-01 17:39:15 +02002874extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875extern struct file * open_exec(const char *);
2876
2877/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002878extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002879extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002881extern char *file_path(struct file *, char *, int);
2882
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883#include <linux/err.h>
2884
2885/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002886extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887
Andrew Morton965c8e52012-12-17 15:59:39 -08002888extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889
Christoph Hellwig54e34622009-08-07 14:38:25 -03002890extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002892extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893extern struct inode * igrab(struct inode *);
2894extern ino_t iunique(struct super_block *, ino_t);
2895extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002896extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002897static inline int generic_drop_inode(struct inode *inode)
2898{
2899 return !inode->i_nlink || inode_unhashed(inode);
2900}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002902extern struct inode *ilookup5_nowait(struct super_block *sb,
2903 unsigned long hashval, int (*test)(struct inode *, void *),
2904 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2906 int (*test)(struct inode *, void *), void *data);
2907extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2908
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02002909extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2910 int (*test)(struct inode *, void *),
2911 int (*set)(struct inode *, void *),
2912 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2914extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002915extern struct inode *find_inode_nowait(struct super_block *,
2916 unsigned long,
2917 int (*match)(struct inode *,
2918 unsigned long, void *),
2919 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002920extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2921extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002922#ifdef CONFIG_DEBUG_LOCK_ALLOC
2923extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2924#else
2925static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2926#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002928extern unsigned int get_next_ino(void);
Darrick J. Wong799ea9e2017-08-18 18:08:25 -07002929extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002932extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002933extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002934extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002935extern struct inode *new_inode_pseudo(struct super_block *sb);
2936extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002937extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002938extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002939extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940
2941extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002942static inline void insert_inode_hash(struct inode *inode)
2943{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944 __insert_inode_hash(inode, inode->i_ino);
2945}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002946
2947extern void __remove_inode_hash(struct inode *);
2948static inline void remove_inode_hash(struct inode *inode)
2949{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002950 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002951 __remove_inode_hash(inode);
2952}
2953
Christoph Hellwig646ec462010-10-23 07:15:32 -04002954extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955
David Howells93614012006-09-30 20:45:40 +02002956#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002958#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959extern int set_blocksize(struct block_device *, int);
2960extern int sb_set_blocksize(struct super_block *, int);
2961extern int sb_min_blocksize(struct super_block *, int);
2962
2963extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2964extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002965extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002966extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002967extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002968extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002969extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002970extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002971
Christoph Hellwig18e97102017-05-27 11:16:51 +03002972ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02002973 rwf_t flags);
Christoph Hellwigabbb65892017-05-27 11:16:52 +03002974ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02002975 rwf_t flags);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002976
Christoph Hellwigeef99382009-08-20 17:43:41 +02002977/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002978extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002979extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002980extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2981 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002982extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002983
Andrew Morton88e6fae2006-04-11 13:59:36 +02002984/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002985extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002986 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002987extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002988 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002989extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002990 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002991extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2992 loff_t *opos, size_t len, unsigned int flags);
2993
Andrew Morton88e6fae2006-04-11 13:59:36 +02002994
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995extern void
2996file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002997extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2998extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002999extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08003000extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07003001extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08003002 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04003003extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3004 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05003005extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3006extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007extern int generic_file_open(struct inode * inode, struct file * filp);
3008extern int nonseekable_open(struct inode * inode, struct file * filp);
3009
David Howells93614012006-09-30 20:45:40 +02003010#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05003011typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04003012 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013
3014enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01003015 /* need locking between buffered and direct access */
3016 DIO_LOCKING = 0x01,
3017
3018 /* filesystem does not support filling holes */
3019 DIO_SKIP_HOLES = 0x02,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020};
3021
Christoph Hellwig40553512017-06-03 09:37:58 +02003022void dio_end_io(struct bio *bio);
Darrick J. Wong5a9d9292018-01-08 10:41:39 -08003023void dio_warn_stale_pagecache(struct file *filp);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003024
Omar Sandoval17f8c842015-03-16 04:33:50 -07003025ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3026 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003027 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003028 dio_iodone_t end_io, dio_submit_t submit_io,
3029 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02003030
Omar Sandoval17f8c842015-03-16 04:33:50 -07003031static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3032 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003033 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003034 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035{
Omar Sandoval17f8c842015-03-16 04:33:50 -07003036 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003037 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038}
David Howells93614012006-09-30 20:45:40 +02003039#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040
Trond Myklebust1d59d612012-05-31 12:22:33 -04003041void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06003042
3043/*
3044 * inode_dio_begin - signal start of a direct I/O requests
3045 * @inode: inode the direct I/O happens on
3046 *
3047 * This is called once we've finished processing a direct I/O request,
3048 * and is used to wake up callers waiting for direct I/O to be quiesced.
3049 */
3050static inline void inode_dio_begin(struct inode *inode)
3051{
3052 atomic_inc(&inode->i_dio_count);
3053}
3054
3055/*
3056 * inode_dio_end - signal finish of a direct I/O requests
3057 * @inode: inode the direct I/O happens on
3058 *
3059 * This is called once we've finished processing a direct I/O request,
3060 * and is used to wake up callers waiting for direct I/O to be quiesced.
3061 */
3062static inline void inode_dio_end(struct inode *inode)
3063{
3064 if (atomic_dec_and_test(&inode->i_dio_count))
3065 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3066}
Trond Myklebust1d59d612012-05-31 12:22:33 -04003067
Theodore Ts'o5f16f322014-03-24 14:43:12 -04003068extern void inode_set_flags(struct inode *inode, unsigned int flags,
3069 unsigned int mask);
3070
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003071extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072
3073#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3074
Al Viro5d826c82014-03-14 13:42:45 -04003075extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05003077extern const char *page_get_link(struct dentry *, struct inode *,
3078 struct delayed_call *);
3079extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08003080extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08003081 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003083extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05003084extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00003086extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3087extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03003088void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04003090void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091void inode_sub_bytes(struct inode *inode, loff_t bytes);
Jan Karaf4a8116a2017-08-08 09:54:36 +02003092static inline loff_t __inode_get_bytes(struct inode *inode)
3093{
3094 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3095}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096loff_t inode_get_bytes(struct inode *inode);
3097void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05003098const char *simple_get_link(struct dentry *, struct inode *,
3099 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04003100extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101
Al Viro5c0ba4e2013-05-15 13:52:59 -04003102extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103
David Howellsa528d352017-01-31 16:46:22 +00003104extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3105extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3106
3107static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3108{
David Howellsdeccf492017-05-04 23:30:16 +01003109 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3110 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003111}
3112static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3113{
David Howellsdeccf492017-05-04 23:30:16 +01003114 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
David Howellsa528d352017-01-31 16:46:22 +00003115 stat, STATX_BASIC_STATS);
3116}
3117static inline int vfs_fstatat(int dfd, const char __user *filename,
3118 struct kstat *stat, int flags)
3119{
Ian Kent5d38f042017-11-29 16:11:26 -08003120 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3121 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003122}
3123static inline int vfs_fstat(int fd, struct kstat *stat)
3124{
3125 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3126}
3127
3128
Miklos Szeredid60874c2016-10-04 14:40:45 +02003129extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0edf2016-12-09 16:45:04 +01003130extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003131
Steven Whitehousee9079cc2008-10-14 14:43:29 +01003132extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04003133 struct fiemap_extent_info *fieinfo,
3134 loff_t start, loff_t len,
3135 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04003136extern int generic_block_fiemap(struct inode *inode,
3137 struct fiemap_extent_info *fieinfo, u64 start,
3138 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139
David Howellsee416bc2017-07-04 17:25:16 +01003140extern struct file_system_type *get_filesystem(struct file_system_type *fs);
Miklos Szeredic18479f2007-10-18 23:39:11 -07003141extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142extern struct file_system_type *get_fs_type(const char *name);
3143extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003144extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01003145extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02003146extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003147extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01003148extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003149extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003150extern void iterate_supers_type(struct file_system_type *,
3151 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003152
3153extern int dcache_dir_open(struct inode *, struct file *);
3154extern int dcache_dir_close(struct inode *, struct file *);
3155extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003156extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003157extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003158extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003159extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003160extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3162extern int simple_unlink(struct inode *, struct dentry *);
3163extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003164extern int simple_rename(struct inode *, struct dentry *,
3165 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003166extern int noop_fsync(struct file *, loff_t, loff_t, int);
Dan Williamsf44c7762018-03-07 15:26:44 -08003167extern int noop_set_page_dirty(struct page *page);
3168extern void noop_invalidatepage(struct page *page, unsigned int offset,
3169 unsigned int length);
3170extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003171extern int simple_empty(struct dentry *);
3172extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003173extern int simple_write_begin(struct file *file, struct address_space *mapping,
3174 loff_t pos, unsigned len, unsigned flags,
3175 struct page **pagep, void **fsdata);
3176extern int simple_write_end(struct file *file, struct address_space *mapping,
3177 loff_t pos, unsigned len, unsigned copied,
3178 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003179extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003180extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003181extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003182extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183
Al Viro00cd8dd2012-06-10 17:13:09 -04003184extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003186extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003187extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003188extern void make_empty_dir_inode(struct inode *inode);
3189extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003190struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003192extern int simple_fill_super(struct super_block *, unsigned long,
3193 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003194extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195extern void simple_release_fs(struct vfsmount **mount, int *count);
3196
Akinobu Mita93b07112008-06-05 22:46:21 -07003197extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3198 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003199extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3200 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003201
Fabian Frederickac13a822014-06-04 16:06:27 -07003202extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003203extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003204
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003205extern int generic_check_addressable(unsigned, u64);
3206
Christoph Lametere965f962006-02-01 03:05:41 -08003207#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003208extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003209 struct page *, struct page *,
3210 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003211#else
3212#define buffer_migrate_page NULL
3213#endif
3214
Jan Kara31051c82016-05-26 16:55:18 +02003215extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003216extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003217extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218
Josef Bacikc3b2da32012-03-26 09:59:21 -04003219extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003221static inline bool io_is_direct(struct file *filp)
3222{
Dan Williams65f87ee2016-01-25 17:23:18 -08003223 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003224}
3225
Dan Williamsbaabda22017-07-10 15:48:25 -07003226static inline bool vma_is_dax(struct vm_area_struct *vma)
3227{
3228 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3229}
3230
Dan Williams2bb6d282017-11-29 16:10:35 -08003231static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3232{
3233 struct inode *inode;
3234
3235 if (!vma->vm_file)
3236 return false;
3237 if (!vma_is_dax(vma))
3238 return false;
3239 inode = file_inode(vma->vm_file);
Dan Williams230f5a82018-02-21 17:08:01 -08003240 if (S_ISCHR(inode->i_mode))
Dan Williams2bb6d282017-11-29 16:10:35 -08003241 return false; /* device-dax */
3242 return true;
3243}
3244
Al Viro2ba48ce2015-04-09 13:52:01 -04003245static inline int iocb_flags(struct file *file)
3246{
3247 int res = 0;
3248 if (file->f_flags & O_APPEND)
3249 res |= IOCB_APPEND;
3250 if (io_is_direct(file))
3251 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003252 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3253 res |= IOCB_DSYNC;
3254 if (file->f_flags & __O_SYNC)
3255 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003256 return res;
3257}
3258
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003259static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003260{
3261 if (unlikely(flags & ~RWF_SUPPORTED))
3262 return -EOPNOTSUPP;
3263
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003264 if (flags & RWF_NOWAIT) {
Christoph Hellwig91f99432017-08-29 16:13:20 +02003265 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003266 return -EOPNOTSUPP;
3267 ki->ki_flags |= IOCB_NOWAIT;
3268 }
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003269 if (flags & RWF_HIPRI)
3270 ki->ki_flags |= IOCB_HIPRI;
3271 if (flags & RWF_DSYNC)
3272 ki->ki_flags |= IOCB_DSYNC;
3273 if (flags & RWF_SYNC)
3274 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
Jürg Billetere1fc7422017-09-29 14:07:17 +02003275 if (flags & RWF_APPEND)
3276 ki->ki_flags |= IOCB_APPEND;
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003277 return 0;
3278}
3279
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280static inline ino_t parent_ino(struct dentry *dentry)
3281{
3282 ino_t res;
3283
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003284 /*
3285 * Don't strictly need d_lock here? If the parent ino could change
3286 * then surely we'd have a deeper race in the caller?
3287 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288 spin_lock(&dentry->d_lock);
3289 res = dentry->d_parent->d_inode->i_ino;
3290 spin_unlock(&dentry->d_lock);
3291 return res;
3292}
3293
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294/* Transaction based IO helpers */
3295
3296/*
3297 * An argresp is stored in an allocated page and holds the
3298 * size of the argument or response, along with its content
3299 */
3300struct simple_transaction_argresp {
3301 ssize_t size;
3302 char data[0];
3303};
3304
3305#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3306
3307char *simple_transaction_get(struct file *file, const char __user *buf,
3308 size_t size);
3309ssize_t simple_transaction_read(struct file *file, char __user *buf,
3310 size_t size, loff_t *pos);
3311int simple_transaction_release(struct inode *inode, struct file *file);
3312
Ingo Molnar76791ab2009-03-25 16:48:35 +01003313void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003315/*
3316 * simple attribute files
3317 *
3318 * These attributes behave similar to those in sysfs:
3319 *
3320 * Writing to an attribute immediately sets a value, an open file can be
3321 * written to multiple times.
3322 *
3323 * Reading from an attribute creates a buffer from the value that might get
3324 * read with multiple read calls. When the attribute has been read
3325 * completely, no further read calls are possible until the file is opened
3326 * again.
3327 *
3328 * All attributes contain a text representation of a numeric value
3329 * that are accessed with the get() and set() functions.
3330 */
3331#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3332static int __fops ## _open(struct inode *inode, struct file *file) \
3333{ \
3334 __simple_attr_check_format(__fmt, 0ull); \
3335 return simple_attr_open(inode, file, __get, __set, __fmt); \
3336} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003337static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003338 .owner = THIS_MODULE, \
3339 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003340 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003341 .read = simple_attr_read, \
3342 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003343 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003344}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003345
Joe Perchesb9075fa2011-10-31 17:11:33 -07003346static inline __printf(1, 2)
3347void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003348{
3349 /* don't do anything, just let the compiler check the arguments; */
3350}
3351
3352int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003353 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003354 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003355int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003356ssize_t simple_attr_read(struct file *file, char __user *buf,
3357 size_t len, loff_t *ppos);
3358ssize_t simple_attr_write(struct file *file, const char __user *buf,
3359 size_t len, loff_t *ppos);
3360
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003361struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003362int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003363 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003364int proc_nr_dentry(struct ctl_table *table, int write,
3365 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003366int proc_nr_inodes(struct ctl_table *table, int write,
3367 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003368int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003369
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003370#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003371#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3372
Al Viro6d125522009-12-24 06:58:56 -05003373#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003374#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003375 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003376
Yaowei Baid37177b2015-11-19 21:00:12 +08003377static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003378{
3379 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3380}
3381
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003382static inline int check_sticky(struct inode *dir, struct inode *inode)
3383{
3384 if (!(dir->i_mode & S_ISVTX))
3385 return 0;
3386
3387 return __check_sticky(dir, inode);
3388}
3389
Andi Kleen69b45732011-05-28 08:25:51 -07003390static inline void inode_has_no_xattr(struct inode *inode)
3391{
David Howellse462ec52017-07-17 08:45:35 +01003392 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003393 inode->i_flags |= S_NOSEC;
3394}
3395
Al Viroa7400222014-10-21 15:20:42 -04003396static inline bool is_root_inode(struct inode *inode)
3397{
3398 return inode == inode->i_sb->s_root->d_inode;
3399}
3400
Al Viro5f99f4e2013-05-15 20:23:06 -04003401static inline bool dir_emit(struct dir_context *ctx,
3402 const char *name, int namelen,
3403 u64 ino, unsigned type)
3404{
3405 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3406}
3407static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3408{
3409 return ctx->actor(ctx, ".", 1, ctx->pos,
3410 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3411}
3412static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3413{
3414 return ctx->actor(ctx, "..", 2, ctx->pos,
3415 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3416}
3417static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3418{
3419 if (ctx->pos == 0) {
3420 if (!dir_emit_dot(file, ctx))
3421 return false;
3422 ctx->pos = 1;
3423 }
3424 if (ctx->pos == 1) {
3425 if (!dir_emit_dotdot(file, ctx))
3426 return false;
3427 ctx->pos = 2;
3428 }
3429 return true;
3430}
Al Viro5ded75e2013-05-15 21:02:48 -04003431static inline bool dir_relax(struct inode *inode)
3432{
Al Viro59551022016-01-22 15:40:57 -05003433 inode_unlock(inode);
3434 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003435 return !IS_DEADDIR(inode);
3436}
Al Viro5f99f4e2013-05-15 20:23:06 -04003437
Al Viroae053272016-05-12 20:36:01 -04003438static inline bool dir_relax_shared(struct inode *inode)
3439{
3440 inode_unlock_shared(inode);
3441 inode_lock_shared(inode);
3442 return !IS_DEADDIR(inode);
3443}
3444
Eric W. Biederman90f85722015-06-29 14:42:03 -05003445extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003446extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003447
Linus Torvalds1da177e2005-04-16 15:20:36 -07003448#endif /* _LINUX_FS_H */