blob: 9b00676f5d9d28fa1690c2048be381d6f1c512a2 [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 Sharma3bd858a2007-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 Dobriyan57cc7212011-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
David Howellsbbc10962012-10-15 16:40:35 +0100151/* File was opened by fanotify and shouldn't generate fanotify events */
David Drysdale75069f22015-01-08 14:32:29 -0800152#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
David Howellsbbc10962012-10-15 16:40:35 +0100153
Christoph Hellwig91f99432017-08-29 16:13:20 +0200154/* File is capable of returning -EAGAIN if I/O will block */
155#define FMODE_NOWAIT ((__force fmode_t)0x8000000)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500156
David Howellsbbc10962012-10-15 16:40:35 +0100157/*
158 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
159 * that indicates that they should check the contents of the iovec are
160 * valid, but not check the memory that the iovec elements
161 * points too.
162 */
163#define CHECK_IOVEC_ONLY -1
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165/*
166 * Attribute flags. These should be or-ed together to figure out what
167 * has been changed!
168 */
Miklos Szeredi9767d742008-07-01 15:01:26 +0200169#define ATTR_MODE (1 << 0)
170#define ATTR_UID (1 << 1)
171#define ATTR_GID (1 << 2)
172#define ATTR_SIZE (1 << 3)
173#define ATTR_ATIME (1 << 4)
174#define ATTR_MTIME (1 << 5)
175#define ATTR_CTIME (1 << 6)
176#define ATTR_ATIME_SET (1 << 7)
177#define ATTR_MTIME_SET (1 << 8)
178#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
179#define ATTR_ATTR_FLAG (1 << 10)
180#define ATTR_KILL_SUID (1 << 11)
181#define ATTR_KILL_SGID (1 << 12)
182#define ATTR_FILE (1 << 13)
183#define ATTR_KILL_PRIV (1 << 14)
184#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
185#define ATTR_TIMES_SET (1 << 16)
Miklos Szeredif2b20f62016-09-16 12:44:20 +0200186#define ATTR_TOUCH (1 << 17)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188/*
Miklos Szeredi787fb6b2014-10-24 00:14:36 +0200189 * Whiteout is represented by a char device. The following constants define the
190 * mode and device number to use.
191 */
192#define WHITEOUT_MODE 0
193#define WHITEOUT_DEV 0
194
195/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 * This is the Inode Attributes structure, used for notify_change(). It
197 * uses the above definitions as flags, to know which values have changed.
198 * Also, in this manner, a Filesystem can look at only the values it cares
199 * about. Basically, these are the attributes that the VFS layer can
200 * request to change from the FS layer.
201 *
202 * Derek Atkins <warlord@MIT.EDU> 94-10-20
203 */
204struct iattr {
205 unsigned int ia_valid;
206 umode_t ia_mode;
Eric W. Biederman92361632012-02-08 07:07:50 -0800207 kuid_t ia_uid;
208 kgid_t ia_gid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 loff_t ia_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700210 struct timespec64 ia_atime;
211 struct timespec64 ia_mtime;
212 struct timespec64 ia_ctime;
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800213
214 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300215 * Not an attribute, but an auxiliary info for filesystems wanting to
Miklos Szeredicc4e69d2005-11-07 00:59:49 -0800216 * implement an ftruncate() like method. NOTE: filesystem should
217 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
218 */
219 struct file *ia_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220};
221
222/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 * Includes for diskquotas.
224 */
225#include <linux/quota.h>
226
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200227/*
228 * Maximum number of layers of fs stack. Needs to be limited to
229 * prevent kernel stack overflow
230 */
231#define FILESYSTEM_MAX_STACK_DEPTH 2
232
Zach Brown994fc28c2005-12-15 14:28:17 -0800233/**
234 * enum positive_aop_returns - aop return codes with specific semantics
235 *
236 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
237 * completed, that the page is still locked, and
238 * should be considered active. The VM uses this hint
239 * to return the page to the active list -- it won't
240 * be a candidate for writeback again in the near
241 * future. Other callers must be careful to unlock
242 * the page if they get this return. Returned by
243 * writepage();
244 *
245 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
246 * unlocked it and the page might have been truncated.
247 * The caller should back up to acquiring a new page and
248 * trying again. The aop will be taking reasonable
249 * precautions not to livelock. If the caller held a page
250 * reference, it should drop it before retrying. Returned
Nick Piggin55144762007-10-16 01:25:26 -0700251 * by readpage().
Zach Brown994fc28c2005-12-15 14:28:17 -0800252 *
253 * address_space_operation functions return these large constants to indicate
254 * special semantics to the caller. These are much larger than the bytes in a
255 * page to allow for functions that return the number of bytes operated on in a
256 * given page.
257 */
258
259enum positive_aop_returns {
260 AOP_WRITEPAGE_ACTIVATE = 0x80000,
261 AOP_TRUNCATED_PAGE = 0x80001,
262};
263
Tetsuo Handac718a972017-05-08 15:58:59 -0700264#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
265#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
Nick Piggin54566b22009-01-04 12:00:53 -0800266 * helper code (eg buffer layer)
267 * to clear GFP_FS from alloc */
Nick Pigginafddba42007-10-16 01:25:01 -0700268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269/*
270 * oh the beauties of C type declarations.
271 */
272struct page;
273struct address_space;
274struct writeback_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
Jens Axboec75b1d92017-06-27 11:47:04 -0600276/*
277 * Write life time hint values.
Amir Goldstein69448862018-07-05 09:25:43 +0300278 * Stored in struct inode as u8.
Jens Axboec75b1d92017-06-27 11:47:04 -0600279 */
280enum rw_hint {
281 WRITE_LIFE_NOT_SET = 0,
282 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
283 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
284 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
285 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
286 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
287};
288
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800289#define IOCB_EVENTFD (1 << 0)
Al Viro2ba48ce2015-04-09 13:52:01 -0400290#define IOCB_APPEND (1 << 1)
291#define IOCB_DIRECT (1 << 2)
Christoph Hellwig97be7eb2016-03-03 16:04:01 +0100292#define IOCB_HIPRI (1 << 3)
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -0700293#define IOCB_DSYNC (1 << 4)
294#define IOCB_SYNC (1 << 5)
Jan Kara70fe2f42016-10-30 11:42:04 -0500295#define IOCB_WRITE (1 << 6)
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -0500296#define IOCB_NOWAIT (1 << 7)
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800297
298struct kiocb {
299 struct file *ki_filp;
300 loff_t ki_pos;
301 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
302 void *private;
303 int ki_flags;
Adam Manzanaresfc287242018-05-22 10:52:18 -0700304 u16 ki_hint;
Adam Manzanaresd9a08a92018-05-22 10:52:19 -0700305 u16 ki_ioprio; /* See linux/ioprio.h */
Kees Cook3859a272016-10-28 01:22:25 -0700306} __randomize_layout;
Christoph Hellwige2e40f22015-02-22 08:58:50 -0800307
308static inline bool is_sync_kiocb(struct kiocb *kiocb)
309{
310 return kiocb->ki_complete == NULL;
311}
312
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700313/*
314 * "descriptor" for what we're up to with a read.
315 * This allows us to use the same read code yet
316 * have multiple different users of the data that
317 * we read from a file.
318 *
319 * The simplest case just copies the data to user
320 * mode.
321 */
322typedef struct {
323 size_t written;
324 size_t count;
325 union {
326 char __user *buf;
327 void *data;
328 } arg;
329 int error;
330} read_descriptor_t;
331
332typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
333 unsigned long, unsigned long);
Nick Piggin2f718ff2007-10-16 01:24:59 -0700334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335struct address_space_operations {
336 int (*writepage)(struct page *page, struct writeback_control *wbc);
337 int (*readpage)(struct file *, struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339 /* Write back some dirty pages from this mapping. */
340 int (*writepages)(struct address_space *, struct writeback_control *);
341
Andrew Morton4741c9f2006-03-24 03:18:11 -0800342 /* Set a page dirty. Return true if this dirtied it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 int (*set_page_dirty)(struct page *page);
344
345 int (*readpages)(struct file *filp, struct address_space *mapping,
346 struct list_head *pages, unsigned nr_pages);
347
Nick Pigginafddba42007-10-16 01:25:01 -0700348 int (*write_begin)(struct file *, struct address_space *mapping,
349 loff_t pos, unsigned len, unsigned flags,
350 struct page **pagep, void **fsdata);
351 int (*write_end)(struct file *, struct address_space *mapping,
352 loff_t pos, unsigned len, unsigned copied,
353 struct page *page, void *fsdata);
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
356 sector_t (*bmap)(struct address_space *, sector_t);
Lukas Czernerd47992f2013-05-21 23:17:23 -0400357 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
Al Viro27496a82005-10-21 03:20:48 -0400358 int (*releasepage) (struct page *, gfp_t);
Linus Torvalds6072d132010-12-01 13:35:19 -0500359 void (*freepage)(struct page *);
Christoph Hellwigc8b8e322016-04-07 08:51:58 -0700360 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800361 /*
Tang Chenef277c72013-07-08 16:00:21 -0700362 * migrate the contents of a page to the specified target. If
363 * migrate_mode is MIGRATE_ASYNC, it must not block.
Mel Gormanb969c4ab2012-01-12 17:19:34 -0800364 */
Christoph Lameter2d1db3b2006-06-23 02:03:33 -0700365 int (*migratepage) (struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -0800366 struct page *, struct page *, enum migrate_mode);
Minchan Kimbda807d2016-07-26 15:23:05 -0700367 bool (*isolate_page)(struct page *, isolate_mode_t);
368 void (*putback_page)(struct page *);
Trond Myklebuste3db7692007-01-10 23:15:39 -0800369 int (*launder_page) (struct page *);
Al Viroc186afb42014-02-02 21:16:54 -0500370 int (*is_partially_uptodate) (struct page *, unsigned long,
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -0700371 unsigned long);
Mel Gormanb4597222013-07-03 15:02:05 -0700372 void (*is_dirty_writeback) (struct page *, bool *, bool *);
Andi Kleen25718732009-09-16 11:50:13 +0200373 int (*error_remove_page)(struct address_space *, struct page *);
Mel Gorman62c230b2012-07-31 16:44:55 -0700374
375 /* swapfile support */
Mel Gormana509bc12012-07-31 16:44:57 -0700376 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
377 sector_t *span);
378 void (*swap_deactivate)(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379};
380
Jens Axboe7dcda1c2011-04-05 23:51:48 +0200381extern const struct address_space_operations empty_aops;
382
Nick Pigginafddba42007-10-16 01:25:01 -0700383/*
384 * pagecache_write_begin/pagecache_write_end must be used by general code
385 * to write into the pagecache.
386 */
387int pagecache_write_begin(struct file *, struct address_space *mapping,
388 loff_t pos, unsigned len, unsigned flags,
389 struct page **pagep, void **fsdata);
390
391int pagecache_write_end(struct file *, struct address_space *mapping,
392 loff_t pos, unsigned len, unsigned copied,
393 struct page *page, void *fsdata);
394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395struct address_space {
396 struct inode *host; /* owner: inode, block_device */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700397 struct radix_tree_root i_pages; /* cached pages */
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700398 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
Davidlohr Buesof808c132017-09-08 16:15:08 -0700399 struct rb_root_cached i_mmap; /* tree of private and shared mappings */
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800400 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700401 /* Protected by the i_pages lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 unsigned long nrpages; /* number of total pages */
Ross Zwislerf9fe48b2016-01-22 15:10:40 -0800403 /* number of shadow or DAX exceptional entries */
404 unsigned long nrexceptional;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 pgoff_t writeback_index;/* writeback starts here */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -0700406 const struct address_space_operations *a_ops; /* methods */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700407 unsigned long flags; /* error bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 spinlock_t private_lock; /* for use by the address_space */
Michal Hocko9c5d7602016-10-11 13:56:04 -0700409 gfp_t gfp_mask; /* implicit gfp mask for allocations */
Mike Rapoport32e57c22017-10-03 16:16:54 -0700410 struct list_head private_list; /* for use by the address_space */
Rafael Aquini252aa6f2012-12-11 16:02:35 -0800411 void *private_data; /* ditto */
Jeff Layton5660e132017-07-06 07:02:25 -0400412 errseq_t wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700413} __attribute__((aligned(sizeof(long)))) __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 /*
415 * On most architectures that alignment is already the case; but
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300416 * must be enforced here for CRIS, to let the least significant bit
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
418 */
Andi Kleen87192a22012-01-12 17:20:34 -0800419struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421struct block_device {
422 dev_t bd_dev; /* not a kdev_t - it's a search key */
Richard Kennedyf3ccfcd2011-03-22 16:33:56 -0700423 int bd_openers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 struct inode * bd_inode; /* will die */
Theodore Ts'o87d8fe12009-01-03 09:47:09 -0500425 struct super_block * bd_super;
Arjan van de Venc039e312006-03-23 03:00:28 -0800426 struct mutex bd_mutex; /* open/close mutex */
Tejun Heo6b4517a2010-04-07 18:53:59 +0900427 void * bd_claiming;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 void * bd_holder;
429 int bd_holders;
Tejun Heo77ea8872010-12-08 20:57:37 +0100430 bool bd_write_holder;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800431#ifdef CONFIG_SYSFS
Tejun Heo49731ba2011-01-14 18:43:57 +0100432 struct list_head bd_holder_disks;
Jun'ichi Nomura641dc632006-03-27 01:17:57 -0800433#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 struct block_device * bd_contains;
435 unsigned bd_block_size;
Christoph Hellwigc2ee0702017-08-23 19:10:31 +0200436 u8 bd_partno;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 struct hd_struct * bd_part;
438 /* number of times partitions within this device have been opened. */
439 unsigned bd_part_count;
440 int bd_invalidated;
441 struct gendisk * bd_disk;
Andi Kleen87192a22012-01-12 17:20:34 -0800442 struct request_queue * bd_queue;
Jan Karab1d2dc562017-02-02 15:56:52 +0100443 struct backing_dev_info *bd_bdi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 struct list_head bd_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 /*
446 * Private data. You must have bd_claim'ed the block_device
447 * to use this. NOTE: bd_claim allows an owner to claim
448 * the same device multiple times, the owner must take special
449 * care to not mess up bd_private for that case.
450 */
451 unsigned long bd_private;
Takashi Satofcccf502009-01-09 16:40:59 -0800452
453 /* The counter of freeze processes */
454 int bd_fsfreeze_count;
455 /* Mutex for freeze */
456 struct mutex bd_fsfreeze_mutex;
Kees Cook3859a272016-10-28 01:22:25 -0700457} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459/*
460 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
461 * radix trees
462 */
463#define PAGECACHE_TAG_DIRTY 0
464#define PAGECACHE_TAG_WRITEBACK 1
Jan Karaf446daae2010-08-09 17:19:12 -0700465#define PAGECACHE_TAG_TOWRITE 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
467int mapping_tagged(struct address_space *mapping, int tag);
468
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800469static inline void i_mmap_lock_write(struct address_space *mapping)
470{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800471 down_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800472}
473
474static inline void i_mmap_unlock_write(struct address_space *mapping)
475{
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800476 up_write(&mapping->i_mmap_rwsem);
Davidlohr Bueso8b28f622014-12-12 16:54:18 -0800477}
478
Davidlohr Bueso3dec0ba2014-12-12 16:54:27 -0800479static inline void i_mmap_lock_read(struct address_space *mapping)
480{
481 down_read(&mapping->i_mmap_rwsem);
482}
483
484static inline void i_mmap_unlock_read(struct address_space *mapping)
485{
486 up_read(&mapping->i_mmap_rwsem);
487}
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489/*
490 * Might pages of this file be mapped into userspace?
491 */
492static inline int mapping_mapped(struct address_space *mapping)
493{
Davidlohr Buesof808c132017-09-08 16:15:08 -0700494 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495}
496
497/*
498 * Might pages of this file have been modified in userspace?
499 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
500 * marks vma as VM_SHARED if it is shared, and the file was opened for
501 * writing i.e. vma may be mprotected writable even if now readonly.
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700502 *
503 * If i_mmap_writable is negative, no new writable mappings are allowed. You
504 * can only deny writable mappings, if none exists right now.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 */
506static inline int mapping_writably_mapped(struct address_space *mapping)
507{
David Herrmann4bb5f5d2014-08-08 14:25:25 -0700508 return atomic_read(&mapping->i_mmap_writable) > 0;
509}
510
511static inline int mapping_map_writable(struct address_space *mapping)
512{
513 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
514 0 : -EPERM;
515}
516
517static inline void mapping_unmap_writable(struct address_space *mapping)
518{
519 atomic_dec(&mapping->i_mmap_writable);
520}
521
522static inline int mapping_deny_writable(struct address_space *mapping)
523{
524 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
525 0 : -EBUSY;
526}
527
528static inline void mapping_allow_writable(struct address_space *mapping)
529{
530 atomic_inc(&mapping->i_mmap_writable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531}
532
533/*
534 * Use sequence counter to get consistent i_size on 32-bit processors.
535 */
536#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
537#include <linux/seqlock.h>
538#define __NEED_I_SIZE_ORDERED
539#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
540#else
541#define i_size_ordered_init(inode) do { } while (0)
542#endif
543
Al Virof19d4a82009-06-08 19:50:45 -0400544struct posix_acl;
545#define ACL_NOT_CACHED ((void *)(-1))
Miklos Szeredi2a3a2a32016-09-01 11:11:59 +0200546#define ACL_DONT_CACHE ((void *)(-3))
Al Virof19d4a82009-06-08 19:50:45 -0400547
Andreas Gruenbacherb8a7a3a2016-03-24 14:38:37 +0100548static inline struct posix_acl *
549uncached_acl_sentinel(struct task_struct *task)
550{
551 return (void *)task + 1;
552}
553
554static inline bool
555is_uncached_acl(struct posix_acl *acl)
556{
557 return (long)acl & 1;
558}
559
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700560#define IOP_FASTPERM 0x0001
561#define IOP_LOOKUP 0x0002
562#define IOP_NOFOLLOW 0x0004
Andreas Gruenbacherd0a5b992016-09-29 17:48:39 +0200563#define IOP_XATTR 0x0008
Miklos Szeredi76fca902016-12-09 16:45:04 +0100564#define IOP_DEFAULT_READLINK 0x0010
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700565
Jan Kara9dd813c2017-03-14 12:31:02 +0100566struct fsnotify_mark_connector;
567
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700568/*
569 * Keep mostly read-only and often accessed (especially for
570 * the RCU path lookup and 'stat' data) fields at the beginning
571 * of the 'struct inode'
572 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573struct inode {
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100574 umode_t i_mode;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700575 unsigned short i_opflags;
Eric W. Biederman92361632012-02-08 07:07:50 -0800576 kuid_t i_uid;
577 kgid_t i_gid;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700578 unsigned int i_flags;
579
580#ifdef CONFIG_FS_POSIX_ACL
581 struct posix_acl *i_acl;
582 struct posix_acl *i_default_acl;
583#endif
584
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100585 const struct inode_operations *i_op;
586 struct super_block *i_sb;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700587 struct address_space *i_mapping;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100588
Linus Torvalds13e12d12011-06-08 15:18:19 -0700589#ifdef CONFIG_SECURITY
590 void *i_security;
591#endif
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100592
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700593 /* Stat data, not accessed from path walking */
594 unsigned long i_ino;
Miklos Szeredia78ef702011-10-28 14:13:30 +0200595 /*
596 * Filesystems may only read i_nlink directly. They shall use the
597 * following functions for modification:
598 *
599 * (set|clear|inc|drop)_nlink
600 * inode_(inc|dec)_link_count
601 */
602 union {
603 const unsigned int i_nlink;
604 unsigned int __i_nlink;
605 };
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700606 dev_t i_rdev;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700607 loff_t i_size;
Deepa Dinamani95582b02018-05-08 19:36:02 -0700608 struct timespec64 i_atime;
609 struct timespec64 i_mtime;
610 struct timespec64 i_ctime;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400611 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
612 unsigned short i_bytes;
Amir Goldstein69448862018-07-05 09:25:43 +0300613 u8 i_blkbits;
614 u8 i_write_hint;
Linus Torvalds3ddcd052011-08-06 22:45:50 -0700615 blkcnt_t i_blocks;
616
617#ifdef __NEED_I_SIZE_ORDERED
618 seqcount_t i_size_seqcount;
619#endif
620
621 /* Misc */
622 unsigned long i_state;
Al Viro9902af72016-04-15 15:08:36 -0400623 struct rw_semaphore i_rwsem;
Linus Torvalds13e12d12011-06-08 15:18:19 -0700624
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100625 unsigned long dirtied_when; /* jiffies of first dirtying */
Theodore Ts'oa2f48702015-03-17 12:23:19 -0400626 unsigned long dirtied_time_when;
Nick Piggin44a7d7a2011-01-07 17:49:56 +1100627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 struct hlist_node i_hash;
Dave Chinnerc7f54082015-03-04 14:07:22 -0500629 struct list_head i_io_list; /* backing dev IO list */
Tejun Heo52ebea72015-05-22 17:13:37 -0400630#ifdef CONFIG_CGROUP_WRITEBACK
631 struct bdi_writeback *i_wb; /* the associated cgroup wb */
Tejun Heo2a814902015-05-28 14:50:51 -0400632
633 /* foreign inode detection, see wbc_detach_inode() */
634 int i_wb_frn_winner;
635 u16 i_wb_frn_avg_time;
636 u16 i_wb_frn_history;
Tejun Heo52ebea72015-05-22 17:13:37 -0400637#endif
Nick Piggin7ccf19a2010-10-21 11:49:30 +1100638 struct list_head i_lru; /* inode LRU list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 struct list_head i_sb_list;
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700640 struct list_head i_wb_list; /* backing dev writeback list */
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100641 union {
Al Virob3d9b7a2012-06-09 13:51:19 -0400642 struct hlist_head i_dentry;
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100643 struct rcu_head i_rcu;
644 };
Jeff Laytonf02a9ad2017-12-21 07:45:44 -0500645 atomic64_t i_version;
Linus Torvalds2f9d3df2012-06-03 14:50:19 -0700646 atomic_t i_count;
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -0400647 atomic_t i_dio_count;
Theodore Ts'o6cdbb0e2011-10-29 08:24:18 -0400648 atomic_t i_writecount;
Mimi Zohard984ea62013-12-11 15:20:54 -0500649#ifdef CONFIG_IMA
650 atomic_t i_readcount; /* struct files open RO */
651#endif
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800652 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
Jeff Layton4a075e32015-01-16 15:05:54 -0500653 struct file_lock_context *i_flctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 struct address_space i_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 struct list_head i_devices;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700656 union {
657 struct pipe_inode_info *i_pipe;
Theodore Ts'oeaf796e2006-09-27 01:50:48 -0700658 struct block_device *i_bdev;
Theodore Ts'o577c4eb2006-09-27 01:50:49 -0700659 struct cdev *i_cdev;
Al Viro61ba64f2015-05-02 09:54:06 -0400660 char *i_link;
Al Viro84e710d2016-04-15 00:58:55 -0400661 unsigned i_dir_seq;
Theodore Ts'o4c154162006-09-27 01:50:47 -0700662 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
664 __u32 i_generation;
665
Eric Paris3be25f42009-05-21 17:01:26 -0400666#ifdef CONFIG_FSNOTIFY
667 __u32 i_fsnotify_mask; /* all events this inode cares about */
Jan Kara08991e82017-02-01 09:21:58 +0100668 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
Robert Love0eeca282005-07-12 17:06:03 -0400669#endif
670
Jaegeuk Kim0b81d072015-05-15 16:26:10 -0700671#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
672 struct fscrypt_info *i_crypt_info;
673#endif
674
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700675 void *i_private; /* fs or device private pointer */
Kees Cook3859a272016-10-28 01:22:25 -0700676} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Fabian Frederick93407472017-02-27 14:28:32 -0800678static inline unsigned int i_blocksize(const struct inode *node)
679{
680 return (1 << node->i_blkbits);
681}
682
Al Viro1d3382cb2010-10-23 15:19:20 -0400683static inline int inode_unhashed(struct inode *inode)
684{
685 return hlist_unhashed(&inode->i_hash);
686}
687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688/*
Ingo Molnarf2eace22006-07-03 00:25:05 -0700689 * inode->i_mutex nesting subclasses for the lock validator:
690 *
691 * 0: the object of the current VFS operation
692 * 1: parent
693 * 2: child/target
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400694 * 3: xattr
695 * 4: second non-directory
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100696 * 5: second parent (when locking independent directories in rename)
697 *
698 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
J. Bruce Fields40bd22c2012-04-18 15:21:34 -0400699 * non-directories at once.
Ingo Molnarf2eace22006-07-03 00:25:05 -0700700 *
701 * The locking order between these classes is
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100702 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
Ingo Molnarf2eace22006-07-03 00:25:05 -0700703 */
704enum inode_i_mutex_lock_class
705{
706 I_MUTEX_NORMAL,
707 I_MUTEX_PARENT,
708 I_MUTEX_CHILD,
Ingo Molnar4df46242006-08-27 01:23:56 -0700709 I_MUTEX_XATTR,
Miklos Szeredid1b72cc2014-10-27 15:42:01 +0100710 I_MUTEX_NONDIR2,
711 I_MUTEX_PARENT2,
Ingo Molnarf2eace22006-07-03 00:25:05 -0700712};
713
Al Viro59551022016-01-22 15:40:57 -0500714static inline void inode_lock(struct inode *inode)
715{
Al Viro9902af72016-04-15 15:08:36 -0400716 down_write(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500717}
718
719static inline void inode_unlock(struct inode *inode)
720{
Al Viro9902af72016-04-15 15:08:36 -0400721 up_write(&inode->i_rwsem);
722}
723
724static inline void inode_lock_shared(struct inode *inode)
725{
726 down_read(&inode->i_rwsem);
727}
728
729static inline void inode_unlock_shared(struct inode *inode)
730{
731 up_read(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500732}
733
734static inline int inode_trylock(struct inode *inode)
735{
Al Viro9902af72016-04-15 15:08:36 -0400736 return down_write_trylock(&inode->i_rwsem);
737}
738
739static inline int inode_trylock_shared(struct inode *inode)
740{
741 return down_read_trylock(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500742}
743
744static inline int inode_is_locked(struct inode *inode)
745{
Al Viro9902af72016-04-15 15:08:36 -0400746 return rwsem_is_locked(&inode->i_rwsem);
Al Viro59551022016-01-22 15:40:57 -0500747}
748
749static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
750{
Al Viro9902af72016-04-15 15:08:36 -0400751 down_write_nested(&inode->i_rwsem, subclass);
Al Viro59551022016-01-22 15:40:57 -0500752}
753
Darrick J. Wong01c2e132018-01-18 14:07:53 -0800754static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
755{
756 down_read_nested(&inode->i_rwsem, subclass);
757}
758
J. Bruce Fields375e2892012-04-18 15:16:33 -0400759void lock_two_nondirectories(struct inode *, struct inode*);
760void unlock_two_nondirectories(struct inode *, struct inode*);
761
Ingo Molnarf2eace22006-07-03 00:25:05 -0700762/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 * NOTE: in a 32bit arch with a preemptable kernel and
764 * an UP compile the i_size_read/write must be atomic
765 * with respect to the local cpu (unlike with preempt disabled),
766 * but they don't need to be atomic with respect to other cpus like in
767 * true SMP (so they need either to either locally disable irq around
768 * the read or for example on x86 they can be still implemented as a
769 * cmpxchg8b without the need of the lock prefix). For SMP compiles
770 * and 64bit archs it makes no difference if preempt is enabled or not.
771 */
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800772static inline loff_t i_size_read(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773{
774#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
775 loff_t i_size;
776 unsigned int seq;
777
778 do {
779 seq = read_seqcount_begin(&inode->i_size_seqcount);
780 i_size = inode->i_size;
781 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
782 return i_size;
783#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
784 loff_t i_size;
785
786 preempt_disable();
787 i_size = inode->i_size;
788 preempt_enable();
789 return i_size;
790#else
791 return inode->i_size;
792#endif
793}
794
Miklos Szeredi7762f5a2006-10-17 00:10:07 -0700795/*
796 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
797 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
798 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
799 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800static inline void i_size_write(struct inode *inode, loff_t i_size)
801{
802#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
Fan Du74e3d1e2013-04-30 15:27:27 -0700803 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 write_seqcount_begin(&inode->i_size_seqcount);
805 inode->i_size = i_size;
806 write_seqcount_end(&inode->i_size_seqcount);
Fan Du74e3d1e2013-04-30 15:27:27 -0700807 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
809 preempt_disable();
810 inode->i_size = i_size;
811 preempt_enable();
812#else
813 inode->i_size = i_size;
814#endif
815}
816
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800817static inline unsigned iminor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
819 return MINOR(inode->i_rdev);
820}
821
Jan Engelhardt48ed2142006-12-06 20:35:37 -0800822static inline unsigned imajor(const struct inode *inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
824 return MAJOR(inode->i_rdev);
825}
826
827extern struct block_device *I_BDEV(struct inode *inode);
828
829struct fown_struct {
830 rwlock_t lock; /* protects pid, uid, euid fields */
Eric W. Biederman609d7fa2006-10-02 02:17:15 -0700831 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
832 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
Eric W. Biederman92361632012-02-08 07:07:50 -0800833 kuid_t uid, euid; /* uid/euid of process setting the owner */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 int signum; /* posix.1b rt signal to be delivered on IO */
835};
836
837/*
838 * Track a single file's readahead state
839 */
840struct file_ra_state {
Fengguang Wu937085a2007-10-16 01:24:31 -0700841 pgoff_t start; /* where readahead started */
842 unsigned int size; /* # of readahead pages */
843 unsigned int async_size; /* do asynchronous readahead when
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700844 there are only # of pages ahead */
Fengguang Wu5ce11102007-07-19 01:47:59 -0700845
Fengguang Wu937085a2007-10-16 01:24:31 -0700846 unsigned int ra_pages; /* Maximum readahead window */
Wu Fengguang1ebf26a2009-06-16 15:31:19 -0700847 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700848 loff_t prev_pos; /* Cache last read() position */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Fengguang Wu5ce11102007-07-19 01:47:59 -0700851/*
Fengguang Wu5ce11102007-07-19 01:47:59 -0700852 * Check if @index falls in the readahead windows.
853 */
854static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
855{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700856 return (index >= ra->start &&
857 index < ra->start + ra->size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700858}
859
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860struct file {
Eric Dumazet2f512012005-10-30 15:02:16 -0800861 union {
Oleg Nesterov4f5e65a2013-07-08 14:24:16 -0700862 struct llist_node fu_llist;
Eric Dumazet2f512012005-10-30 15:02:16 -0800863 struct rcu_head fu_rcuhead;
864 } f_u;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800865 struct path f_path;
Al Virodd379782013-03-01 19:48:30 -0500866 struct inode *f_inode; /* cached value */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800867 const struct file_operations *f_op;
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700868
869 /*
Linus Torvalds9c225f22014-03-03 09:36:58 -0800870 * Protects f_ep_links, f_flags.
Andi Kleenef3d0fd2011-09-15 16:06:48 -0700871 * Must not be taken from IRQ context.
872 */
873 spinlock_t f_lock;
Jens Axboec75b1d92017-06-27 11:47:04 -0600874 enum rw_hint f_write_hint;
Al Viro516e0cc2008-07-26 00:39:17 -0400875 atomic_long_t f_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 unsigned int f_flags;
Al Viroaeb5d722008-09-02 15:28:45 -0400877 fmode_t f_mode;
Linus Torvalds9c225f22014-03-03 09:36:58 -0800878 struct mutex f_pos_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 loff_t f_pos;
880 struct fown_struct f_owner;
David Howellsd76b0d92008-11-14 10:39:25 +1100881 const struct cred *f_cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 struct file_ra_state f_ra;
883
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -0700884 u64 f_version;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700885#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 void *f_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -0700887#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 /* needed for tty driver, and maybe others */
889 void *private_data;
890
891#ifdef CONFIG_EPOLL
892 /* Used by fs/eventpoll.c to link all the hooks to this file */
893 struct list_head f_ep_links;
Jason Baron28d82dc2012-01-12 17:17:43 -0800894 struct list_head f_tfile_llink;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895#endif /* #ifdef CONFIG_EPOLL */
896 struct address_space *f_mapping;
Jeff Layton5660e132017-07-06 07:02:25 -0400897 errseq_t f_wb_err;
Kees Cook3859a272016-10-28 01:22:25 -0700898} __randomize_layout
899 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Aneesh Kumar K.V990d6c22011-01-29 18:43:26 +0530901struct file_handle {
902 __u32 handle_bytes;
903 int handle_type;
904 /* file identifier */
905 unsigned char f_handle[0];
906};
907
Al Virocb0942b2012-08-27 14:48:26 -0400908static inline struct file *get_file(struct file *f)
909{
910 atomic_long_inc(&f->f_count);
911 return f;
912}
Konstantin Khlebnikov90f31d02015-04-16 12:47:56 -0700913#define get_file_rcu(x) atomic_long_inc_not_zero(&(x)->f_count)
Al Virod7065da2010-05-26 15:13:55 -0400914#define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
Al Viro516e0cc2008-07-26 00:39:17 -0400915#define file_count(x) atomic_long_read(&(x)->f_count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
917#define MAX_NON_LFS ((1UL<<31) - 1)
918
919/* Page cache limit. The filesystems should put that into their s_maxbytes
920 limits, otherwise bad things can happen in VM. */
921#if BITS_PER_LONG==32
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700922#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923#elif BITS_PER_LONG==64
Linus Torvalds0cc3b0e2017-08-27 12:12:25 -0700924#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925#endif
926
927#define FL_POSIX 1
928#define FL_FLOCK 2
J. Bruce Fields617588d2011-07-01 15:18:34 -0400929#define FL_DELEG 4 /* NFSv4 delegation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930#define FL_ACCESS 8 /* not trying to lock, just looking */
Trond Myklebustf475ae92006-06-29 16:38:32 -0400931#define FL_EXISTS 16 /* when unlocking, test for existence */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932#define FL_LEASE 32 /* lease held on this file */
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -0700933#define FL_CLOSE 64 /* unlock on close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934#define FL_SLEEP 128 /* A blocking lock */
J. Bruce Fields778fc542011-07-26 18:25:49 -0400935#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
936#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
Jeff Laytoncff2fce2014-04-22 08:24:32 -0400937#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
Christoph Hellwig11afe9f2015-01-21 19:17:03 +0100938#define FL_LAYOUT 2048 /* outstanding pNFS layout */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Benjamin Coddington50f21122017-04-11 12:50:09 -0400940#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
941
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942/*
Miklos Szeredibde74e42008-07-25 01:48:57 -0700943 * Special return value from posix_lock_file() and vfs_lock_file() for
944 * asynchronous locking.
945 */
946#define FILE_LOCK_DEFERRED 1
947
Jeff Layton7ca76312014-09-01 19:04:48 -0400948/* legacy typedef, should eventually be removed */
Christoph Hellwig17fa3882014-07-13 17:00:37 +0200949typedef void *fl_owner_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Jeff Laytona7231a92015-01-16 15:05:56 -0500951struct file_lock;
952
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953struct file_lock_operations {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
955 void (*fl_release_private)(struct file_lock *);
956};
957
958struct lock_manager_operations {
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400959 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
Jeff Layton3999e492013-06-21 08:58:19 -0400960 unsigned long (*lm_owner_key)(struct file_lock *);
Jeff Laytoncae80b32015-04-03 09:04:04 -0400961 fl_owner_t (*lm_get_owner)(fl_owner_t);
962 void (*lm_put_owner)(fl_owner_t);
J. Bruce Fields8fb47a42011-07-20 20:21:59 -0400963 void (*lm_notify)(struct file_lock *); /* unblock callback */
Joe Perchesd0449b92014-08-22 10:18:42 -0400964 int (*lm_grant)(struct file_lock *, int);
Jeff Layton4d01b7f2014-09-01 15:06:54 -0400965 bool (*lm_break)(struct file_lock *);
Jeff Layton7448cc32015-01-16 15:05:57 -0500966 int (*lm_change)(struct file_lock *, int, struct list_head *);
Jeff Layton1c7dd2f2014-08-22 10:55:47 -0400967 void (*lm_setup)(struct file_lock *, void **);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968};
969
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400970struct lock_manager {
971 struct list_head list;
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400972 /*
973 * NFSv4 and up also want opens blocked during the grace period;
974 * NLM doesn't care:
975 */
976 bool block_opens;
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400977};
978
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400979struct net;
980void locks_start_grace(struct net *, struct lock_manager *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400981void locks_end_grace(struct lock_manager *);
Corentin Labbe003278e2017-09-26 09:14:07 +0200982bool locks_in_grace(struct net *);
983bool opens_in_grace(struct net *);
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985/* that will die - we need it for nfs_lock_info */
986#include <linux/nfs_fs_i.h>
987
Jeff Layton1cb36012013-06-21 08:58:12 -0400988/*
989 * struct file_lock represents a generic "file lock". It's used to represent
990 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
991 * note that the same struct is used to represent both a request for a lock and
992 * the lock itself, but the same object is never used for both.
993 *
994 * FIXME: should we create a separate "struct lock_request" to help distinguish
995 * these two uses?
996 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500997 * The varous i_flctx lists are ordered by:
Jeff Layton1cb36012013-06-21 08:58:12 -0400998 *
Jeff Layton8116bf42015-01-21 20:44:01 -0500999 * 1) lock owner
1000 * 2) lock range start
1001 * 3) lock range end
Jeff Layton1cb36012013-06-21 08:58:12 -04001002 *
1003 * Obviously, the last two criteria only matter for POSIX locks.
1004 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005struct file_lock {
1006 struct file_lock *fl_next; /* singly linked list for this inode */
Jeff Layton6dee60f2015-01-16 15:05:54 -05001007 struct list_head fl_list; /* link into file_lock_context */
Jeff Layton139ca042013-06-21 08:58:17 -04001008 struct hlist_node fl_link; /* node in global lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 struct list_head fl_block; /* circular list of blocked processes */
1010 fl_owner_t fl_owner;
J. Bruce Fields710b7212011-07-26 16:28:29 -04001011 unsigned int fl_flags;
Richard Kennedyafc12462008-07-11 17:20:49 -07001012 unsigned char fl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 unsigned int fl_pid;
Jeff Layton7012b022013-06-21 08:58:22 -04001014 int fl_link_cpu; /* what cpu's list is this on? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 wait_queue_head_t fl_wait;
1016 struct file *fl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 loff_t fl_start;
1018 loff_t fl_end;
1019
1020 struct fasync_struct * fl_fasync; /* for lease break notifications */
J. Bruce Fields778fc542011-07-26 18:25:49 -04001021 /* for lease breaks: */
1022 unsigned long fl_break_time;
1023 unsigned long fl_downgrade_time;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
Alexey Dobriyan6aed6282009-09-21 17:01:11 -07001025 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
Alexey Dobriyan7b021962009-09-21 17:01:12 -07001026 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 union {
1028 struct nfs_lock_info nfs_fl;
Trond Myklebust8d0a8a92005-06-22 17:16:32 +00001029 struct nfs4_lock_info nfs4_fl;
David Howellse8d6c552007-07-15 23:40:12 -07001030 struct {
1031 struct list_head link; /* link in AFS vnode's pending_locks list */
1032 int state; /* state of grant or error if -ve */
1033 } afs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 } fl_u;
Kees Cook3859a272016-10-28 01:22:25 -07001035} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
Jeff Layton4a075e32015-01-16 15:05:54 -05001037struct file_lock_context {
Jeff Layton6109c852015-01-16 15:05:57 -05001038 spinlock_t flc_lock;
Jeff Layton4a075e32015-01-16 15:05:54 -05001039 struct list_head flc_flock;
Jeff Laytonbd61e0a2015-01-16 15:05:55 -05001040 struct list_head flc_posix;
Jeff Layton8634b512015-01-16 15:05:55 -05001041 struct list_head flc_lease;
Jeff Layton4a075e32015-01-16 15:05:54 -05001042};
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044/* The following constant reflects the upper bound of the file/locking space */
1045#ifndef OFFSET_MAX
1046#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1047#define OFFSET_MAX INT_LIMIT(loff_t)
1048#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1049#endif
1050
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001051extern void send_sigio(struct fown_struct *fown, int fd, int band);
1052
Miklos Szeredic568d682016-09-16 12:44:20 +02001053/*
1054 * Return the inode to use for locking
1055 *
1056 * For overlayfs this should be the overlay inode, not the real inode returned
1057 * by file_inode(). For any other fs file_inode(filp) and locks_inode(filp) are
1058 * equal.
1059 */
1060static inline struct inode *locks_inode(const struct file *f)
1061{
1062 return f->f_path.dentry->d_inode;
1063}
1064
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001065#ifdef CONFIG_FILE_LOCKING
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001066extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
Peter Staubachc2936212005-07-27 11:45:09 -07001067extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001068 struct flock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
1070#if BITS_PER_LONG == 32
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001071extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
Peter Staubachc2936212005-07-27 11:45:09 -07001072extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
Christoph Hellwiga75d30c2017-05-27 06:07:19 -04001073 struct flock64 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074#endif
1075
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1077extern int fcntl_getlease(struct file *filp);
1078
1079/* fs/locks.c */
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001080void locks_free_lock_context(struct inode *inode);
J. Bruce Fields05fa3132010-10-30 17:31:15 -04001081void locks_free_lock(struct file_lock *fl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082extern void locks_init_lock(struct file_lock *);
Arnd Bergmannc5b1f0d2010-10-27 15:46:08 +02001083extern struct file_lock * locks_alloc_lock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084extern void locks_copy_lock(struct file_lock *, struct file_lock *);
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001085extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086extern void locks_remove_posix(struct file *, fl_owner_t);
Jeff Layton78ed8a12014-02-03 12:13:08 -05001087extern void locks_remove_file(struct file *);
Felix Blyakhera9e61e22009-03-31 15:12:56 -05001088extern void locks_release_private(struct file_lock *);
J. Bruce Fields6d34ac12007-05-11 16:09:32 -04001089extern void posix_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001090extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
Jeff Laytonf891a292013-06-21 08:58:09 -04001091extern int posix_unblock_lock(struct file_lock *);
J. Bruce Fields3ee17ab2007-02-21 00:58:50 -05001092extern int vfs_test_lock(struct file *, struct file_lock *);
Marc Eshel150b3932007-01-18 16:15:35 -05001093extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
Marc Eshel9b9d2ab2007-01-18 17:52:58 -05001094extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001095extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001096extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001097extern void lease_get_mtime(struct inode *, struct timespec64 *time);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001098extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1099extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
Jeff Layton7448cc32015-01-16 15:05:57 -05001100extern int lease_modify(struct file_lock *, int, struct list_head *);
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001101struct files_struct;
1102extern void show_fd_locks(struct seq_file *f,
1103 struct file *filp, struct files_struct *files);
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001104#else /* !CONFIG_FILE_LOCKING */
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001105static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1106 struct flock __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001107{
1108 return -EINVAL;
1109}
1110
1111static inline int fcntl_setlk(unsigned int fd, struct file *file,
1112 unsigned int cmd, struct flock __user *user)
1113{
1114 return -EACCES;
1115}
1116
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001117#if BITS_PER_LONG == 32
Jeff Laytonc1e62b82014-02-03 12:13:09 -05001118static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1119 struct flock64 __user *user)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001120{
1121 return -EINVAL;
1122}
1123
1124static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1125 unsigned int cmd, struct flock64 __user *user)
1126{
1127 return -EACCES;
1128}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001129#endif
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001130static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1131{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001132 return -EINVAL;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001133}
1134
1135static inline int fcntl_getlease(struct file *filp)
1136{
Jeff Layton1b2b32d2014-09-24 08:38:44 -04001137 return F_UNLCK;
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001138}
1139
Jeff Layton4a075e32015-01-16 15:05:54 -05001140static inline void
Jeff Laytonf27a0fe2016-01-07 15:08:51 -05001141locks_free_lock_context(struct inode *inode)
Jeff Layton4a075e32015-01-16 15:05:54 -05001142{
1143}
1144
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001145static inline void locks_init_lock(struct file_lock *fl)
1146{
1147 return;
1148}
1149
Kinglong Mee3fe0fff12014-08-22 10:18:42 -04001150static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001151{
1152 return;
1153}
1154
1155static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1156{
1157 return;
1158}
1159
1160static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1161{
1162 return;
1163}
1164
Jeff Layton78ed8a12014-02-03 12:13:08 -05001165static inline void locks_remove_file(struct file *filp)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001166{
1167 return;
1168}
1169
1170static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1171{
1172 return;
1173}
1174
1175static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1176 struct file_lock *conflock)
1177{
1178 return -ENOLCK;
1179}
1180
Jeff Laytonf891a292013-06-21 08:58:09 -04001181static inline int posix_unblock_lock(struct file_lock *waiter)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001182{
1183 return -ENOENT;
1184}
1185
1186static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1187{
1188 return 0;
1189}
1190
1191static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1192 struct file_lock *fl, struct file_lock *conf)
1193{
1194 return -ENOLCK;
1195}
1196
1197static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1198{
1199 return 0;
1200}
1201
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001202static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1203{
1204 return -ENOLCK;
1205}
1206
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05001207static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001208{
1209 return 0;
1210}
1211
Deepa Dinamani95582b02018-05-08 19:36:02 -07001212static inline void lease_get_mtime(struct inode *inode,
1213 struct timespec64 *time)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001214{
1215 return;
1216}
1217
1218static inline int generic_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001219 struct file_lock **flp, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001220{
1221 return -EINVAL;
1222}
1223
1224static inline int vfs_setlease(struct file *filp, long arg,
Jeff Laytone6f5c782014-08-22 10:40:25 -04001225 struct file_lock **lease, void **priv)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001226{
1227 return -EINVAL;
1228}
1229
Jeff Layton7448cc32015-01-16 15:05:57 -05001230static inline int lease_modify(struct file_lock *fl, int arg,
Jeff Laytonc45198e2014-09-01 07:12:07 -04001231 struct list_head *dispose)
Steven Whitehousec2aca5e2009-01-20 10:29:45 +00001232{
1233 return -EINVAL;
1234}
Andrey Vagin6c8c9032015-04-16 12:49:38 -07001235
1236struct files_struct;
1237static inline void show_fd_locks(struct seq_file *f,
1238 struct file *filp, struct files_struct *files) {}
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02001239#endif /* !CONFIG_FILE_LOCKING */
1240
Jeff Laytonee296d72015-07-11 06:43:03 -04001241static inline struct inode *file_inode(const struct file *f)
1242{
1243 return f->f_inode;
1244}
1245
Miklos Szeredid101a122016-03-26 16:14:37 -04001246static inline struct dentry *file_dentry(const struct file *file)
1247{
Miklos Szeredi495e6422017-09-04 21:42:22 +02001248 return d_real(file->f_path.dentry, file_inode(file), 0, 0);
Miklos Szeredid101a122016-03-26 16:14:37 -04001249}
1250
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001251static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1252{
Miklos Szeredic568d682016-09-16 12:44:20 +02001253 return locks_lock_inode_wait(locks_inode(filp), fl);
Benjamin Coddingtone55c34a2015-10-22 13:38:13 -04001254}
1255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256struct fasync_struct {
Kirill Tkhai7a107c02018-04-05 14:58:06 +03001257 rwlock_t fa_lock;
Eric Dumazet989a2972010-04-14 09:55:35 +00001258 int magic;
1259 int fa_fd;
1260 struct fasync_struct *fa_next; /* singly linked list */
1261 struct file *fa_file;
1262 struct rcu_head fa_rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263};
1264
1265#define FASYNC_MAGIC 0x4601
1266
1267/* SMP safe fasync helpers: */
1268extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
Linus Torvaldsf7347ce2010-10-27 12:38:12 -04001269extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1270extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1271extern struct fasync_struct *fasync_alloc(void);
1272extern void fasync_free(struct fasync_struct *);
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274/* can be called from interrupts */
1275extern void kill_fasync(struct fasync_struct **, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276
Jeff Laytone0b93ed2014-08-22 11:27:32 -04001277extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
Jiri Slaby393cc3f2017-06-13 13:35:50 +02001278extern int f_setown(struct file *filp, unsigned long arg, int force);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279extern void f_delown(struct file *filp);
Eric W. Biederman609d7fa2006-10-02 02:17:15 -07001280extern pid_t f_getown(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281extern int send_sigurg(struct fown_struct *fown);
1282
1283/*
David Howellse462ec52017-07-17 08:45:35 +01001284 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1285 * represented in both.
1286 */
1287#define SB_RDONLY 1 /* Mount read-only */
1288#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1289#define SB_NODEV 4 /* Disallow access to device special files */
1290#define SB_NOEXEC 8 /* Disallow program execution */
1291#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1292#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1293#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1294#define SB_NOATIME 1024 /* Do not update access times. */
1295#define SB_NODIRATIME 2048 /* Do not update directory access times */
1296#define SB_SILENT 32768
1297#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
1298#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1299#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1300#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1301
1302/* These sb flags are internal to the kernel */
1303#define SB_SUBMOUNT (1<<26)
1304#define SB_NOREMOTELOCK (1<<27)
1305#define SB_NOSEC (1<<28)
1306#define SB_BORN (1<<29)
1307#define SB_ACTIVE (1<<30)
1308#define SB_NOUSER (1<<31)
1309
1310/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 * Umount options
1312 */
1313
1314#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1315#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1316#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
Miklos Szeredidb1f05b2010-02-10 12:15:53 +01001317#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1318#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Tejun Heo46b15ca2015-06-16 18:48:31 -04001320/* sb->s_iflags */
1321#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
Eric W. Biederman90f85722015-06-29 14:42:03 -05001322#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001323#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
Eric W. Biederman95dd7752018-03-14 18:20:29 -05001324#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Eric W. Biederman8654df42016-06-09 16:06:06 -05001326/* sb->s_iflags to limit user namespace mounts */
1327#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
Mimi Zohar57b56ac2018-02-21 11:33:37 -05001328#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1329#define SB_I_UNTRUSTED_MOUNTER 0x00000040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Jan Kara5accdf82012-06-12 16:20:34 +02001331/* Possible states of 'frozen' field */
1332enum {
1333 SB_UNFROZEN = 0, /* FS is unfrozen */
1334 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
Jan Kara5accdf82012-06-12 16:20:34 +02001335 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1336 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1337 * internal threads if needed) */
1338 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1339};
1340
1341#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1342
1343struct sb_writers {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001344 int frozen; /* Is sb frozen? */
1345 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1346 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
Jan Kara5accdf82012-06-12 16:20:34 +02001347};
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349struct super_block {
1350 struct list_head s_list; /* Keep this first */
1351 dev_t s_dev; /* search index; _not_ kdev_t */
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001352 unsigned char s_blocksize_bits;
1353 unsigned long s_blocksize;
Jeff Layton42cb56a2009-09-18 13:05:53 -07001354 loff_t s_maxbytes; /* Max file size */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 struct file_system_type *s_type;
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -08001356 const struct super_operations *s_op;
Alexey Dobriyan61e225d2009-09-21 17:01:08 -07001357 const struct dquot_operations *dq_op;
Alexey Dobriyan0d54b212009-09-21 17:01:09 -07001358 const struct quotactl_ops *s_qcop;
Christoph Hellwig39655162007-10-21 16:42:17 -07001359 const struct export_operations *s_export_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 unsigned long s_flags;
Tejun Heo46b15ca2015-06-16 18:48:31 -04001361 unsigned long s_iflags; /* internal SB_I_* flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 unsigned long s_magic;
1363 struct dentry *s_root;
1364 struct rw_semaphore s_umount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 int s_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 atomic_t s_active;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001367#ifdef CONFIG_SECURITY
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 void *s_security;
Alexey Dobriyan50462062006-09-29 02:00:01 -07001369#endif
Stephen Hemmingerbb435452010-05-13 17:53:14 -07001370 const struct xattr_handler **s_xattr;
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001371#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
Jaegeuk Kim0b81d072015-05-15 16:26:10 -07001372 const struct fscrypt_operations *s_cop;
Eric Biggersbbbc3fb2018-04-30 15:51:35 -07001373#endif
NeilBrownf1ee6162017-12-21 09:45:40 +11001374 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
Miklos Szeredi39f7c4d2011-11-21 12:11:30 +01001375 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 struct block_device *s_bdev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001377 struct backing_dev_info *s_bdi;
David Howellsacaebfd2007-05-10 22:51:50 -07001378 struct mtd_info *s_mtd;
Al Viroa5166162011-12-12 22:53:00 -05001379 struct hlist_node s_instances;
Jan Kara2c5f6482014-09-30 10:43:09 +02001380 unsigned int s_quota_types; /* Bitmask of supported quota types */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 struct quota_info s_dquot; /* Diskquota specific options */
1382
Jan Kara5accdf82012-06-12 16:20:34 +02001383 struct sb_writers s_writers;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Christoph Hellwig85787092017-05-10 15:06:33 +02001385 char s_id[32]; /* Informational name */
1386 uuid_t s_uuid; /* UUID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
1388 void *s_fs_info; /* Filesystem private info */
Al Viro8de52772012-02-06 12:45:27 -05001389 unsigned int s_max_links;
Al Viro30c40d22008-02-22 19:50:45 -05001390 fmode_t s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391
Richard Kennedy270ba5f2010-01-26 14:12:43 +00001392 /* Granularity of c/m/atime in ns.
1393 Cannot be worse than a second */
1394 u32 s_time_gran;
1395
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 /*
1397 * The next field is for VFS *only*. No filesystems have any business
1398 * even looking at it. You had been warned.
1399 */
Arjan van de Vena11f3a02006-03-23 03:00:33 -08001400 struct mutex s_vfs_rename_mutex; /* Kludge */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Miklos Szeredi79c0b2d2007-05-08 00:25:43 -07001402 /*
1403 * Filesystem subtype. If non-empty the filesystem type field
1404 * in /proc/mounts will be "type.subtype"
1405 */
1406 char *s_subtype;
Miklos Szeredib3b304a2008-02-08 04:21:35 -08001407
Al Viroc8aebb02010-12-18 10:22:30 -05001408 const struct dentry_operations *s_d_op; /* default d_op for dentries */
Dan Magenheimer9fdfdcf2011-05-26 10:01:19 -06001409
1410 /*
1411 * Saved pool identifier for cleancache (-1 means none)
1412 */
1413 int cleancache_poolid;
Dave Chinnerb0d40c92011-07-08 14:14:42 +10001414
1415 struct shrinker s_shrink; /* per-sb shrinker handle */
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001416
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01001417 /* Number of inodes with nlink == 0 but still referenced */
1418 atomic_long_t s_remove_count;
1419
Miklos Szeredi4ed5e82f2011-11-21 12:11:31 +01001420 /* Being remounted read-only */
1421 int s_readonly_remount;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +02001422
1423 /* AIO completions deferred from interrupt context */
1424 struct workqueue_struct *s_dio_done_wq;
Al Viro215752f2014-08-07 06:23:41 -04001425 struct hlist_head s_pins;
Dave Chinnerf6041562013-08-28 10:18:00 +10001426
1427 /*
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001428 * Owning user namespace and default context in which to
1429 * interpret filesystem uids, gids, quotas, device nodes,
1430 * xattrs and security labels.
1431 */
1432 struct user_namespace *s_user_ns;
1433
1434 /*
Dave Chinnerf6041562013-08-28 10:18:00 +10001435 * Keep the lru lists last in the structure so they always sit on their
1436 * own individual cachelines.
1437 */
1438 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1439 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
Al Viroe2fec7c2013-10-04 17:06:56 -04001440 struct rcu_head rcu;
Oleg Nesterov853b39a2015-07-22 20:21:13 +02001441 struct work_struct destroy_work;
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001442
Dave Chinnere97fedb2015-03-04 13:40:00 -05001443 struct mutex s_sync_lock; /* sync serialisation lock */
Miklos Szeredi69c433e2014-10-24 00:14:39 +02001444
1445 /*
1446 * Indicates how deep in a filesystem stack this SB is
1447 */
1448 int s_stack_depth;
Dave Chinner74278da2015-03-04 12:37:22 -05001449
1450 /* s_inode_list_lock protects s_inodes */
1451 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1452 struct list_head s_inodes; /* all inodes */
Dave Chinner6c60d2b2016-07-26 15:21:50 -07001453
1454 spinlock_t s_inode_wblist_lock;
1455 struct list_head s_inodes_wb; /* writeback inodes */
Kees Cook3859a272016-10-28 01:22:25 -07001456} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Seth Forshee81754352014-12-11 10:15:45 -06001458/* Helper functions so that in most cases filesystems will
1459 * not need to deal directly with kuid_t and kgid_t and can
1460 * instead deal with the raw numeric values that are stored
1461 * in the filesystem.
1462 */
1463static inline uid_t i_uid_read(const struct inode *inode)
1464{
1465 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1466}
1467
1468static inline gid_t i_gid_read(const struct inode *inode)
1469{
1470 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1471}
1472
1473static inline void i_uid_write(struct inode *inode, uid_t uid)
1474{
1475 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1476}
1477
1478static inline void i_gid_write(struct inode *inode, gid_t gid)
1479{
1480 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1481}
1482
Deepa Dinamani8efd6892018-04-22 20:18:46 -07001483extern struct timespec64 timespec64_trunc(struct timespec64 t, unsigned gran);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001484extern struct timespec64 current_time(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485
1486/*
1487 * Snapshotting support.
1488 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
Jan Kara5accdf82012-06-12 16:20:34 +02001490void __sb_end_write(struct super_block *sb, int level);
1491int __sb_start_write(struct super_block *sb, int level, bool wait);
1492
Oleg Nesterovbee91822015-07-19 23:48:20 +02001493#define __sb_writers_acquired(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001494 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001495#define __sb_writers_release(sb, lev) \
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001496 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
Oleg Nesterovbee91822015-07-19 23:48:20 +02001497
Jan Kara5accdf82012-06-12 16:20:34 +02001498/**
1499 * sb_end_write - drop write access to a superblock
1500 * @sb: the super we wrote to
1501 *
1502 * Decrement number of writers to the filesystem. Wake up possible waiters
1503 * wanting to freeze the filesystem.
1504 */
1505static inline void sb_end_write(struct super_block *sb)
1506{
1507 __sb_end_write(sb, SB_FREEZE_WRITE);
1508}
1509
1510/**
1511 * sb_end_pagefault - drop write access to a superblock from a page fault
1512 * @sb: the super we wrote to
1513 *
1514 * Decrement number of processes handling write page fault to the filesystem.
1515 * Wake up possible waiters wanting to freeze the filesystem.
1516 */
1517static inline void sb_end_pagefault(struct super_block *sb)
1518{
1519 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1520}
1521
1522/**
1523 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1524 * @sb: the super we wrote to
1525 *
1526 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1527 * waiters wanting to freeze the filesystem.
1528 */
1529static inline void sb_end_intwrite(struct super_block *sb)
1530{
1531 __sb_end_write(sb, SB_FREEZE_FS);
1532}
1533
1534/**
1535 * sb_start_write - get write access to a superblock
1536 * @sb: the super we write to
1537 *
1538 * When a process wants to write data or metadata to a file system (i.e. dirty
1539 * a page or an inode), it should embed the operation in a sb_start_write() -
1540 * sb_end_write() pair to get exclusion against file system freezing. This
1541 * function increments number of writers preventing freezing. If the file
1542 * system is already frozen, the function waits until the file system is
1543 * thawed.
1544 *
1545 * Since freeze protection behaves as a lock, users have to preserve
1546 * ordering of freeze protection and other filesystem locks. Generally,
1547 * freeze protection should be the outermost lock. In particular, we have:
1548 *
1549 * sb_start_write
1550 * -> i_mutex (write path, truncate, directory ops, ...)
1551 * -> s_umount (freeze_super, thaw_super)
1552 */
1553static inline void sb_start_write(struct super_block *sb)
1554{
1555 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1556}
1557
1558static inline int sb_start_write_trylock(struct super_block *sb)
1559{
1560 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1561}
1562
1563/**
1564 * sb_start_pagefault - get write access to a superblock from a page fault
1565 * @sb: the super we write to
1566 *
1567 * When a process starts handling write page fault, it should embed the
1568 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1569 * exclusion against file system freezing. This is needed since the page fault
1570 * is going to dirty a page. This function increments number of running page
1571 * faults preventing freezing. If the file system is already frozen, the
1572 * function waits until the file system is thawed.
1573 *
1574 * Since page fault freeze protection behaves as a lock, users have to preserve
1575 * ordering of freeze protection and other filesystem locks. It is advised to
1576 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1577 * handling code implies lock dependency:
1578 *
1579 * mmap_sem
1580 * -> sb_start_pagefault
1581 */
1582static inline void sb_start_pagefault(struct super_block *sb)
1583{
1584 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1585}
1586
1587/*
1588 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1589 * @sb: the super we write to
1590 *
1591 * This is the third level of protection against filesystem freezing. It is
1592 * free for use by a filesystem. The only requirement is that it must rank
1593 * below sb_start_pagefault.
1594 *
1595 * For example filesystem can call sb_start_intwrite() when starting a
1596 * transaction which somewhat eases handling of freezing for internal sources
1597 * of filesystem changes (internal fs threads, discarding preallocation on file
1598 * close, etc.).
1599 */
1600static inline void sb_start_intwrite(struct super_block *sb)
1601{
1602 __sb_start_write(sb, SB_FREEZE_FS, true);
1603}
1604
Amir Goldstein0c8e3fe2018-05-13 22:40:30 -04001605static inline int sb_start_intwrite_trylock(struct super_block *sb)
1606{
1607 return __sb_start_write(sb, SB_FREEZE_FS, false);
1608}
1609
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Serge E. Hallyn2e149672011-03-23 16:43:26 -07001611extern bool inode_owner_or_capable(const struct inode *inode);
Satyam Sharma3bd858a2007-07-17 15:00:08 +05301612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613/*
1614 * VFS helper functions..
1615 */
Al Viro312b63f2012-06-10 18:09:36 -04001616extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
Al Viro18bb1db2011-07-26 01:41:39 -04001617extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
Al Viro1a67aaf2011-07-26 01:52:52 -04001618extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
Miklos Szeredidb2e7472008-06-24 16:50:16 +02001619extern int vfs_symlink(struct inode *, struct dentry *, const char *);
J. Bruce Fields146a8592011-09-20 17:14:31 -04001620extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621extern int vfs_rmdir(struct inode *, struct dentry *);
J. Bruce Fieldsb21996e2011-09-20 09:14:34 -04001622extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001623extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001624extern int vfs_whiteout(struct inode *, struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Amir Goldsteinaf7bd4d2017-01-17 06:34:52 +02001626extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1627 int open_flag);
1628
Al Viro8e6c8482017-12-01 17:12:45 -05001629int vfs_mkobj(struct dentry *, umode_t,
1630 int (*f)(struct dentry *, umode_t, void *),
1631 void *);
1632
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633/*
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001634 * VFS file helper functions.
1635 */
Dmitry Monakhova1bd1202010-03-04 17:29:14 +03001636extern void inode_init_owner(struct inode *inode, const struct inode *dir,
Al Viro62bb1092011-07-24 23:20:18 -04001637 umode_t mode);
Eric W. Biedermana2982cc2016-06-09 15:34:02 -05001638extern bool may_open_dev(const struct path *path);
Christoph Hellwig8c744fb2005-11-08 21:35:04 -08001639/*
Mark Fashehc4b929b2008-10-08 19:44:18 -04001640 * VFS FS_IOC_FIEMAP helper definitions.
1641 */
1642struct fiemap_extent_info {
1643 unsigned int fi_flags; /* Flags as passed from user */
1644 unsigned int fi_extents_mapped; /* Number of mapped extents */
1645 unsigned int fi_extents_max; /* Size of fiemap_extent array */
Namhyung Kimecf56322011-01-16 23:28:17 +09001646 struct fiemap_extent __user *fi_extents_start; /* Start of
1647 fiemap_extent array */
Mark Fashehc4b929b2008-10-08 19:44:18 -04001648};
1649int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1650 u64 phys, u64 len, u32 flags);
1651int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1652
1653/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 * File types
1655 *
1656 * NOTE! These match bits 12..15 of stat.st_mode
1657 * (ie "(i_mode >> 12) & 15").
1658 */
1659#define DT_UNKNOWN 0
1660#define DT_FIFO 1
1661#define DT_CHR 2
1662#define DT_DIR 4
1663#define DT_BLK 6
1664#define DT_REG 8
1665#define DT_LNK 10
1666#define DT_SOCK 12
1667#define DT_WHT 14
1668
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669/*
1670 * This is the "filldir" function type, used by readdir() to let
1671 * the kernel specify what kind of dirent layout it wants to have.
1672 * This allows the kernel to read directories into kernel space or
1673 * to have different dirent layouts depending on the binary type.
1674 */
Miklos Szerediac7576f2014-10-30 17:37:34 +01001675struct dir_context;
1676typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1677 unsigned);
1678
Al Viro5c0ba4e2013-05-15 13:52:59 -04001679struct dir_context {
David Howellsa09acf42018-04-09 21:12:30 +01001680 filldir_t actor;
Al Virobb6f6192013-05-15 18:49:12 -04001681 loff_t pos;
Al Viro5c0ba4e2013-05-15 13:52:59 -04001682};
Al Virobb6f6192013-05-15 18:49:12 -04001683
Al Viro08f85852007-10-08 13:26:20 -04001684struct block_device_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686/* These macros are for out of kernel modules to test that
1687 * the kernel supports the unlocked_ioctl and compat_ioctl
1688 * fields in struct file_operations. */
1689#define HAVE_COMPAT_IOCTL 1
1690#define HAVE_UNLOCKED_IOCTL 1
1691
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001692/*
1693 * These flags let !MMU mmap() govern direct device mapping vs immediate
1694 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1695 *
1696 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1697 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1698 * NOMMU_MAP_READ: Can be mapped for reading
1699 * NOMMU_MAP_WRITE: Can be mapped for writing
1700 * NOMMU_MAP_EXEC: Can be mapped for execution
1701 */
1702#define NOMMU_MAP_COPY 0x00000001
1703#define NOMMU_MAP_DIRECT 0x00000008
1704#define NOMMU_MAP_READ VM_MAYREAD
1705#define NOMMU_MAP_WRITE VM_MAYWRITE
1706#define NOMMU_MAP_EXEC VM_MAYEXEC
1707
1708#define NOMMU_VMFLAGS \
1709 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1710
1711
Al Viro293bc982014-02-11 18:37:41 -05001712struct iov_iter;
1713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714struct file_operations {
1715 struct module *owner;
1716 loff_t (*llseek) (struct file *, loff_t, int);
1717 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
Al Viro293bc982014-02-11 18:37:41 -05001719 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1720 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
Al Virobb6f6192013-05-15 18:49:12 -04001721 int (*iterate) (struct file *, struct dir_context *);
Al Viro61922692016-04-20 23:08:32 -04001722 int (*iterate_shared) (struct file *, struct dir_context *);
Al Viroa3f86832017-07-02 22:22:01 -04001723 __poll_t (*poll) (struct file *, struct poll_table_struct *);
Christoph Hellwig3deb6422018-01-09 15:29:24 +01001724 struct wait_queue_head * (*get_poll_head)(struct file *, __poll_t);
1725 __poll_t (*poll_mask) (struct file *, __poll_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1727 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1728 int (*mmap) (struct file *, struct vm_area_struct *);
Dan Williams1c972592017-11-01 16:36:30 +01001729 unsigned long mmap_supported_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 int (*open) (struct inode *, struct file *);
Miklos Szeredi75e1fcc2006-06-23 02:05:12 -07001731 int (*flush) (struct file *, fl_owner_t id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 int (*release) (struct inode *, struct file *);
Josef Bacik02c24a82011-07-16 20:44:56 -04001733 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 int (*fasync) (int, struct file *, int);
1735 int (*lock) (struct file *, int, struct file_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1737 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1738 int (*check_flags)(int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 int (*flock) (struct file *, int, struct file_lock *);
Jens Axboecbb7e572006-04-11 14:57:50 +02001740 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1741 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
Jeff Laytone6f5c782014-08-22 10:40:25 -04001742 int (*setlease)(struct file *, long, struct file_lock **, void **);
Christoph Hellwig2fe17c12011-01-14 13:07:43 +01001743 long (*fallocate)(struct file *file, int mode, loff_t offset,
1744 loff_t len);
Joe Perchesa3816ab2014-09-29 16:08:25 -07001745 void (*show_fdinfo)(struct seq_file *m, struct file *f);
Christoph Hellwigb4caecd2015-01-14 10:42:32 +01001746#ifndef CONFIG_MMU
1747 unsigned (*mmap_capabilities)(struct file *);
1748#endif
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001749 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1750 loff_t, size_t, unsigned int);
1751 int (*clone_file_range)(struct file *, loff_t, struct file *, loff_t,
1752 u64);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001753 ssize_t (*dedupe_file_range)(struct file *, u64, u64, struct file *,
1754 u64);
Kees Cook3859a272016-10-28 01:22:25 -07001755} __randomize_layout;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
1757struct inode_operations {
Al Viro00cd8dd2012-06-10 17:13:09 -04001758 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
Al Virofceef392015-12-29 15:58:39 -05001759 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
Al Viro10556cb22011-06-20 19:28:19 -04001760 int (*permission) (struct inode *, int);
Christoph Hellwig4e34e712011-07-23 17:37:31 +02001761 struct posix_acl * (*get_acl)(struct inode *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001762
1763 int (*readlink) (struct dentry *, char __user *,int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001764
Al Viroebfc3b42012-06-10 18:05:36 -04001765 int (*create) (struct inode *,struct dentry *, umode_t, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 int (*link) (struct dentry *,struct inode *,struct dentry *);
1767 int (*unlink) (struct inode *,struct dentry *);
1768 int (*symlink) (struct inode *,struct dentry *,const char *);
Al Viro18bb1db2011-07-26 01:41:39 -04001769 int (*mkdir) (struct inode *,struct dentry *,umode_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 int (*rmdir) (struct inode *,struct dentry *);
Al Viro1a67aaf2011-07-26 01:52:52 -04001771 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 int (*rename) (struct inode *, struct dentry *,
Miklos Szeredi520c8b12014-04-01 17:08:42 +02001773 struct inode *, struct dentry *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 int (*setattr) (struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00001775 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 ssize_t (*listxattr) (struct dentry *, char *, size_t);
Mark Fashehc4b929b2008-10-08 19:44:18 -04001777 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1778 u64 len);
Deepa Dinamani95582b02018-05-08 19:36:02 -07001779 int (*update_time)(struct inode *, struct timespec64 *, int);
Al Virod9585272012-06-22 12:39:14 +04001780 int (*atomic_open)(struct inode *, struct dentry *,
Al Viro30d90492012-06-22 12:40:19 +04001781 struct file *, unsigned open_flag,
Al Virod9585272012-06-22 12:39:14 +04001782 umode_t create_mode, int *opened);
Al Viro60545d02013-06-07 01:20:27 -04001783 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
Christoph Hellwig893d46e2013-12-20 05:16:39 -08001784 int (*set_acl)(struct inode *, struct posix_acl *, int);
Nick Piggin44a7d7a2011-01-07 17:49:56 +11001785} ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Miklos Szeredibb7462b2017-02-20 16:51:23 +01001787static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1788 struct iov_iter *iter)
1789{
1790 return file->f_op->read_iter(kio, iter);
1791}
1792
1793static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1794 struct iov_iter *iter)
1795{
1796 return file->f_op->write_iter(kio, iter);
1797}
1798
Miklos Szeredif74ac012017-02-20 16:51:23 +01001799static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1800{
1801 return file->f_op->mmap(file, vma);
1802}
1803
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001804ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
Christopher Yeohfcf63402011-10-31 17:06:39 -07001805 unsigned long nr_segs, unsigned long fast_segs,
1806 struct iovec *fast_pointer,
Christopher Yeohac34ebb2012-05-31 16:26:42 -07001807 struct iovec **ret_pointer);
Badari Pulavartyeed4e512006-09-30 23:28:49 -07001808
Dmitry Kasatkin6fb50322014-11-05 17:01:17 +02001809extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1811extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1812extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02001813 unsigned long, loff_t *, rwf_t);
Zach Brown29732932015-11-10 16:53:30 -05001814extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1815 loff_t, size_t, unsigned int);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001816extern int vfs_clone_file_prep_inodes(struct inode *inode_in, loff_t pos_in,
1817 struct inode *inode_out, loff_t pos_out,
1818 u64 *len, bool is_dedupe);
Christoph Hellwig04b38d62015-12-03 12:59:50 +01001819extern int vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1820 struct file *file_out, loff_t pos_out, u64 len);
Darrick J. Wong876bec6f2016-12-09 16:18:30 -08001821extern int vfs_dedupe_file_range_compare(struct inode *src, loff_t srcoff,
1822 struct inode *dest, loff_t destoff,
1823 loff_t len, bool *is_same);
Darrick J. Wong54dbc152015-12-19 00:55:59 -08001824extern int vfs_dedupe_file_range(struct file *file,
1825 struct file_dedupe_range *same);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827struct super_operations {
1828 struct inode *(*alloc_inode)(struct super_block *sb);
1829 void (*destroy_inode)(struct inode *);
1830
Christoph Hellwigaa385722011-05-27 06:53:02 -04001831 void (*dirty_inode) (struct inode *, int flags);
Christoph Hellwiga9185b42010-03-05 09:21:37 +01001832 int (*write_inode) (struct inode *, struct writeback_control *wbc);
Al Viro45321ac2010-06-07 13:43:19 -04001833 int (*drop_inode) (struct inode *);
Al Virobe7ce412010-06-04 19:40:39 -04001834 void (*evict_inode) (struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 void (*put_super) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 int (*sync_fs)(struct super_block *sb, int wait);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001837 int (*freeze_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001838 int (*freeze_fs) (struct super_block *);
Benjamin Marzinski48b6bca2014-11-13 20:42:03 -06001839 int (*thaw_super) (struct super_block *);
Takashi Satoc4be0c12009-01-09 16:40:58 -08001840 int (*unfreeze_fs) (struct super_block *);
David Howells726c3342006-06-23 02:02:58 -07001841 int (*statfs) (struct dentry *, struct kstatfs *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 int (*remount_fs) (struct super_block *, int *, char *);
Al Viro42faad92008-04-24 07:21:56 -04001843 void (*umount_begin) (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
Al Viro34c80b12011-12-08 21:32:45 -05001845 int (*show_options)(struct seq_file *, struct dentry *);
Al Virod861c632011-12-08 21:32:45 -05001846 int (*show_devname)(struct seq_file *, struct dentry *);
Al Viroa6322de2011-12-08 21:37:57 -05001847 int (*show_path)(struct seq_file *, struct dentry *);
Al Viro64132372011-12-08 20:51:13 -05001848 int (*show_stats)(struct seq_file *, struct dentry *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001849#ifdef CONFIG_QUOTA
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1851 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
Jan Kara2d0fa462014-09-25 16:36:14 +02001852 struct dquot **(*get_dquots)(struct inode *);
Alexey Dobriyan0e51a722006-09-29 01:59:56 -07001853#endif
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001854 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
Vladimir Davydov4101b622015-02-12 14:58:51 -08001855 long (*nr_cached_objects)(struct super_block *,
1856 struct shrink_control *);
1857 long (*free_cached_objects)(struct super_block *,
1858 struct shrink_control *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859};
1860
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001861/*
David Howellsbbc10962012-10-15 16:40:35 +01001862 * Inode flags - they have no relation to superblock flags now
1863 */
1864#define S_SYNC 1 /* Writes are synced at once */
1865#define S_NOATIME 2 /* Do not update access times */
1866#define S_APPEND 4 /* Append-only file */
1867#define S_IMMUTABLE 8 /* Immutable file */
1868#define S_DEAD 16 /* removed, but still open directory */
1869#define S_NOQUOTA 32 /* Inode is not counted to quota */
1870#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1871#define S_NOCMTIME 128 /* Do not update file c/mtime */
1872#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1873#define S_PRIVATE 512 /* Inode is fs-internal */
1874#define S_IMA 1024 /* Inode has an associated IMA struct */
1875#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1876#define S_NOSEC 4096 /* no suid or xattr security attributes */
Matthew Wilcox6cd176a2015-02-16 15:59:25 -08001877#ifdef CONFIG_FS_DAX
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001878#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1879#else
1880#define S_DAX 0 /* Make all the DAX code disappear */
1881#endif
Eric Biggers2ee6a572017-10-09 12:15:35 -07001882#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
David Howellsbbc10962012-10-15 16:40:35 +01001883
1884/*
1885 * Note that nosuid etc flags are inode-specific: setting some file-system
1886 * flags just means all the inodes inherit those flags by default. It might be
1887 * possible to override it selectively if you really wanted to with some
1888 * ioctl() that is not currently implemented.
1889 *
David Howellse462ec52017-07-17 08:45:35 +01001890 * Exception: SB_RDONLY is always applied to the entire file system.
David Howellsbbc10962012-10-15 16:40:35 +01001891 *
1892 * Unfortunately, it is possible to change a filesystems flags with it mounted
1893 * with files in use. This means that all of the inodes will not have their
1894 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1895 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1896 */
1897#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1898
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001899static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
David Howells94e92e72017-07-17 08:45:34 +01001900#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
David Howellse462ec52017-07-17 08:45:35 +01001901#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
David Howellsbbc10962012-10-15 16:40:35 +01001902 ((inode)->i_flags & S_SYNC))
David Howellse462ec52017-07-17 08:45:35 +01001903#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
David Howellsbbc10962012-10-15 16:40:35 +01001904 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
David Howellse462ec52017-07-17 08:45:35 +01001905#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
1906#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1907#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
David Howellsbbc10962012-10-15 16:40:35 +01001908
1909#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1910#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1911#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
David Howellse462ec52017-07-17 08:45:35 +01001912#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
David Howellsbbc10962012-10-15 16:40:35 +01001913
1914#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1915#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1916#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1917#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1918#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1919#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1920#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08001921#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
Eric Biggers2ee6a572017-10-09 12:15:35 -07001922#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
David Howellsbbc10962012-10-15 16:40:35 +01001923
Miklos Szeredi787fb6b2014-10-24 00:14:36 +02001924#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1925 (inode)->i_rdev == WHITEOUT_DEV)
1926
Eric W. Biederman0bd23d092016-06-29 14:54:46 -05001927static inline bool HAS_UNMAPPED_ID(struct inode *inode)
1928{
1929 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
1930}
1931
Jens Axboec75b1d92017-06-27 11:47:04 -06001932static inline enum rw_hint file_write_hint(struct file *file)
1933{
1934 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
1935 return file->f_write_hint;
1936
1937 return file_inode(file)->i_write_hint;
1938}
1939
1940static inline int iocb_flags(struct file *file);
1941
Adam Manzanaresfc287242018-05-22 10:52:18 -07001942static inline u16 ki_hint_validate(enum rw_hint hint)
1943{
1944 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
1945
1946 if (hint <= max_hint)
1947 return hint;
1948 return 0;
1949}
1950
Jens Axboec75b1d92017-06-27 11:47:04 -06001951static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
1952{
1953 *kiocb = (struct kiocb) {
1954 .ki_filp = filp,
1955 .ki_flags = iocb_flags(filp),
Adam Manzanaresfc287242018-05-22 10:52:18 -07001956 .ki_hint = ki_hint_validate(file_write_hint(filp)),
Adam Manzanaresd9a08a92018-05-22 10:52:19 -07001957 .ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0),
Jens Axboec75b1d92017-06-27 11:47:04 -06001958 };
1959}
1960
David Howellsbbc10962012-10-15 16:40:35 +01001961/*
Dave Chinner250df6e2011-03-22 22:23:36 +11001962 * Inode state bits. Protected by inode->i_lock
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001963 *
1964 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1965 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1966 *
1967 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1968 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1969 * various stages of removing an inode.
1970 *
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001971 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001972 *
Joern Engele7ca2d42008-02-06 01:36:59 -08001973 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1974 * fdatasync(). i_atime is the usual cause.
Jan Kara000cb482008-02-14 19:31:32 -08001975 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1976 * these changes separately from I_DIRTY_SYNC so that we
1977 * don't have to write inode on fdatasync() when only
1978 * mtime has changed in it.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001979 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001980 * I_NEW Serves as both a mutex and completion notification.
1981 * New inodes set I_NEW. If two processes both create
1982 * the same inode, one of them will release its inode and
1983 * wait for I_NEW to be released before returning.
1984 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1985 * also cause waiting on I_NEW, without I_NEW actually
1986 * being set. find_inode() uses this to prevent returning
1987 * nearly-dead inodes.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001988 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1989 * is zero. I_FREEING must be set when I_WILL_FREE is
1990 * cleared.
1991 * I_FREEING Set when inode is about to be freed but still has dirty
1992 * pages or buffers attached or the inode itself is still
1993 * dirty.
Jan Karadbd57682012-05-03 14:48:02 +02001994 * I_CLEAR Added by clear_inode(). In this state the inode is
1995 * clean and can be destroyed. Inode keeps I_FREEING.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07001996 *
1997 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1998 * prohibited for many purposes. iget() must wait for
1999 * the inode to be completely released, then create it
2000 * anew. Other functions will just ignore such inodes,
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002001 * if appropriate. I_NEW is used for waiting.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002002 *
Jan Kara169ebd92012-05-03 14:48:03 +02002003 * I_SYNC Writeback of inode is running. The bit is set during
2004 * data writeback, and cleared with a wakeup on the bit
2005 * address once it is done. The bit is also used to pin
2006 * the inode in memory for flusher thread.
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002007 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002008 * I_REFERENCED Marks the inode as recently references on the LRU list.
2009 *
2010 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2011 *
Tejun Heo682aa8e2015-05-28 14:50:53 -04002012 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2013 * synchronize competing switching instances and to tell
Matthew Wilcoxb93b0162018-04-10 16:36:56 -07002014 * wb stat updates to grab the i_pages lock. See
Tejun Heo682aa8e2015-05-28 14:50:53 -04002015 * inode_switch_wb_work_fn() for details.
2016 *
Amir Goldsteinad0af712017-06-21 15:28:32 +03002017 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2018 * and work dirs among overlayfs mounts.
2019 *
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002020 * Q: What is the difference between I_WILL_FREE and I_FREEING?
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002021 */
Nick Piggin9e38d862010-10-23 06:55:17 -04002022#define I_DIRTY_SYNC (1 << 0)
2023#define I_DIRTY_DATASYNC (1 << 1)
2024#define I_DIRTY_PAGES (1 << 2)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002025#define __I_NEW 3
2026#define I_NEW (1 << __I_NEW)
Nick Piggin9e38d862010-10-23 06:55:17 -04002027#define I_WILL_FREE (1 << 4)
2028#define I_FREEING (1 << 5)
2029#define I_CLEAR (1 << 6)
Christoph Hellwigeaff8072009-12-17 14:25:01 +01002030#define __I_SYNC 7
Joern Engel1c0eeaf2007-10-16 23:30:44 -07002031#define I_SYNC (1 << __I_SYNC)
Nick Piggin9e38d862010-10-23 06:55:17 -04002032#define I_REFERENCED (1 << 8)
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002033#define __I_DIO_WAKEUP 9
Eric Sandeenac74d8d2015-04-16 15:04:56 -05002034#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
Al Virof4e0c302013-06-11 08:34:36 +04002035#define I_LINKABLE (1 << 10)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002036#define I_DIRTY_TIME (1 << 11)
2037#define __I_DIRTY_TIME_EXPIRED 12
2038#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
Tejun Heo682aa8e2015-05-28 14:50:53 -04002039#define I_WB_SWITCH (1 << 13)
Amir Goldsteinad0af712017-06-21 15:28:32 +03002040#define I_OVL_INUSE (1 << 14)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
Christoph Hellwig0e11f642018-02-21 07:54:49 -08002042#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2043#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
Theodore Ts'o0ae45f62015-02-02 00:37:00 -05002044#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045
2046extern void __mark_inode_dirty(struct inode *, int);
2047static inline void mark_inode_dirty(struct inode *inode)
2048{
2049 __mark_inode_dirty(inode, I_DIRTY);
2050}
2051
2052static inline void mark_inode_dirty_sync(struct inode *inode)
2053{
2054 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2055}
2056
Miklos Szeredi7ada4db2011-11-21 12:11:32 +01002057extern void inc_nlink(struct inode *inode);
2058extern void drop_nlink(struct inode *inode);
2059extern void clear_nlink(struct inode *inode);
2060extern void set_nlink(struct inode *inode, unsigned int nlink);
Dave Hansend8c76e62006-09-30 23:29:04 -07002061
2062static inline void inode_inc_link_count(struct inode *inode)
2063{
2064 inc_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002065 mark_inode_dirty(inode);
2066}
2067
Dave Hansen9a53c3a2006-09-30 23:29:03 -07002068static inline void inode_dec_link_count(struct inode *inode)
2069{
2070 drop_nlink(inode);
Alexey Dobriyan66d21732006-03-23 03:00:51 -08002071 mark_inode_dirty(inode);
2072}
2073
Josef Bacikc3b2da32012-03-26 09:59:21 -04002074enum file_time_flags {
2075 S_ATIME = 1,
2076 S_MTIME = 2,
2077 S_CTIME = 4,
2078 S_VERSION = 8,
2079};
2080
Al Virobadcf2b2013-07-16 18:15:46 +04002081extern void touch_atime(const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082static inline void file_accessed(struct file *file)
2083{
2084 if (!(file->f_flags & O_NOATIME))
Al Viro68ac1232012-03-15 08:21:57 -04002085 touch_atime(&file->f_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086}
2087
2088int sync_inode(struct inode *inode, struct writeback_control *wbc);
Christoph Hellwigc37650162010-10-06 10:48:20 +02002089int sync_inode_metadata(struct inode *inode, int wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091struct file_system_type {
2092 const char *name;
2093 int fs_flags;
David Howellsbbc10962012-10-15 16:40:35 +01002094#define FS_REQUIRES_DEV 1
2095#define FS_BINARY_MOUNTDATA 2
2096#define FS_HAS_SUBTYPE 4
Eric W. Biederman0c55cfc2012-07-26 21:42:03 -07002097#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
David Howellsbbc10962012-10-15 16:40:35 +01002098#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
Al Viroc96e41e2010-07-25 00:17:56 +04002099 struct dentry *(*mount) (struct file_system_type *, int,
2100 const char *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 void (*kill_sb) (struct super_block *);
2102 struct module *owner;
2103 struct file_system_type * next;
Al Viroa5166162011-12-12 22:53:00 -05002104 struct hlist_head fs_supers;
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002105
Ingo Molnarcf516242006-07-03 00:25:27 -07002106 struct lock_class_key s_lock_key;
Arjan van de Ven897c6ff2006-07-03 00:25:28 -07002107 struct lock_class_key s_umount_key;
Roland Dreier51ee0492010-04-27 14:23:57 -07002108 struct lock_class_key s_vfs_rename_key;
Jan Kara5accdf82012-06-12 16:20:34 +02002109 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
Peter Zijlstrad475fd42007-10-15 14:51:31 +02002110
2111 struct lock_class_key i_lock_key;
2112 struct lock_class_key i_mutex_key;
Peter Zijlstra14358e62007-10-14 01:38:33 +02002113 struct lock_class_key i_mutex_dir_key;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114};
2115
Eric W. Biederman7f78e032013-03-02 19:39:14 -08002116#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2117
Eric W. Biedermand91ee872016-05-23 14:51:59 -05002118extern struct dentry *mount_ns(struct file_system_type *fs_type,
2119 int flags, void *data, void *ns, struct user_namespace *user_ns,
2120 int (*fill_super)(struct super_block *, void *, int));
Al Virof175f302017-10-15 00:38:00 -04002121#ifdef CONFIG_BLOCK
Al Viro152a0832010-07-25 00:46:55 +04002122extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2123 int flags, const char *dev_name, void *data,
2124 int (*fill_super)(struct super_block *, void *, int));
Al Virof175f302017-10-15 00:38:00 -04002125#else
2126static inline struct dentry *mount_bdev(struct file_system_type *fs_type,
2127 int flags, const char *dev_name, void *data,
2128 int (*fill_super)(struct super_block *, void *, int))
2129{
2130 return ERR_PTR(-ENODEV);
2131}
2132#endif
Al Virofc14f2f2010-07-25 01:48:30 +04002133extern struct dentry *mount_single(struct file_system_type *fs_type,
2134 int flags, void *data,
2135 int (*fill_super)(struct super_block *, void *, int));
Al Viro3c26ff62010-07-25 11:46:36 +04002136extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2137 int flags, void *data,
2138 int (*fill_super)(struct super_block *, void *, int));
Al Viroea441d12011-11-16 21:43:59 -05002139extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140void generic_shutdown_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002141#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142void kill_block_super(struct super_block *sb);
Al Virof175f302017-10-15 00:38:00 -04002143#else
2144static inline void kill_block_super(struct super_block *sb)
2145{
2146 BUG();
2147}
2148#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149void kill_anon_super(struct super_block *sb);
2150void kill_litter_super(struct super_block *sb);
2151void deactivate_super(struct super_block *sb);
Al Viro74dbbdd2009-05-06 01:07:50 -04002152void deactivate_locked_super(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153int set_anon_super(struct super_block *s, void *data);
Al Viro0ee5dc62011-07-07 15:44:25 -04002154int get_anon_bdev(dev_t *);
2155void free_anon_bdev(dev_t);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05002156struct super_block *sget_userns(struct file_system_type *type,
2157 int (*test)(struct super_block *,void *),
2158 int (*set)(struct super_block *,void *),
2159 int flags, struct user_namespace *user_ns,
2160 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161struct super_block *sget(struct file_system_type *type,
2162 int (*test)(struct super_block *,void *),
2163 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +01002164 int flags, void *data);
Andreas Gruenbacherbba0bd32016-09-29 17:48:35 +02002165extern struct dentry *mount_pseudo_xattr(struct file_system_type *, char *,
2166 const struct super_operations *ops,
2167 const struct xattr_handler **xattr,
2168 const struct dentry_operations *dops,
2169 unsigned long);
2170
2171static inline struct dentry *
2172mount_pseudo(struct file_system_type *fs_type, char *name,
2173 const struct super_operations *ops,
2174 const struct dentry_operations *dops, unsigned long magic)
2175{
2176 return mount_pseudo_xattr(fs_type, name, ops, NULL, dops, magic);
2177}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178
2179/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2180#define fops_get(fops) \
2181 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2182#define fops_put(fops) \
2183 do { if (fops) module_put((fops)->owner); } while(0)
Al Viroe84f9e52013-09-22 14:17:15 -04002184/*
2185 * This one is to be used *ONLY* from ->open() instances.
2186 * fops must be non-NULL, pinned down *and* module dependencies
2187 * should be sufficient to pin the caller down as well.
2188 */
2189#define replace_fops(f, fops) \
2190 do { \
2191 struct file *__file = (f); \
2192 fops_put(__file->f_op); \
2193 BUG_ON(!(__file->f_op = (fops))); \
2194 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195
2196extern int register_filesystem(struct file_system_type *);
2197extern int unregister_filesystem(struct file_system_type *);
Pavel Emelyanov8bf97252007-10-18 23:40:02 -07002198extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
2199#define kern_mount(type) kern_mount_data(type, NULL)
Tim Chen423e0ab2011-07-19 09:32:38 -07002200extern void kern_unmount(struct vfsmount *mnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201extern int may_umount_tree(struct vfsmount *);
2202extern int may_umount(struct vfsmount *);
Seunghun Lee5e6123f2014-09-14 22:15:10 +09002203extern long do_mount(const char *, const char __user *,
2204 const char *, unsigned long, void *);
Al Viroca71cf72016-11-20 19:45:28 -05002205extern struct vfsmount *collect_mounts(const struct path *);
Al Viro8aec0802007-06-07 12:20:32 -04002206extern void drop_collected_mounts(struct vfsmount *);
Al Viro1f707132010-01-30 22:51:25 -05002207extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2208 struct vfsmount *);
Al Virof0bb5aa2016-11-20 20:27:12 -05002209extern int vfs_statfs(const struct path *, struct kstatfs *);
Al Viroc8b91ac2011-03-12 10:41:39 -05002210extern int user_statfs(const char __user *, struct kstatfs *);
2211extern int fd_statfs(int, struct kstatfs *);
Josef Bacik18e9e512010-03-23 10:34:56 -04002212extern int freeze_super(struct super_block *super);
2213extern int thaw_super(struct super_block *super);
Al Viro02125a82011-12-05 08:43:34 -05002214extern bool our_mnt(struct vfsmount *mnt);
Jan Karafca39342017-04-12 12:24:28 +02002215extern __printf(2, 3)
2216int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2217extern int super_setup_bdi(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218
Al Viroce3b0f82009-03-29 19:08:22 -04002219extern int current_umask(void);
2220
J. Bruce Fields5a146962012-08-28 07:50:40 -07002221extern void ihold(struct inode * inode);
2222extern void iput(struct inode *);
Deepa Dinamani95582b02018-05-08 19:36:02 -07002223extern int generic_update_time(struct inode *, struct timespec64 *, int);
J. Bruce Fields5a146962012-08-28 07:50:40 -07002224
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002225/* /sys/fs */
Greg Kroah-Hartman00d26662007-10-29 14:17:23 -06002226extern struct kobject *fs_kobj;
Miklos Szeredif87fd4c2006-01-16 22:14:23 -08002227
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002228#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002229
Jeff Layton9e8925b2015-11-16 09:49:34 -05002230#ifdef CONFIG_MANDATORY_FILE_LOCKING
Jeff Laytond7a06982014-03-10 09:54:15 -04002231extern int locks_mandatory_locked(struct file *);
Christoph Hellwigacc15572015-12-03 12:59:49 +01002232extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233
2234/*
2235 * Candidates for mandatory locking have the setgid bit set
2236 * but no group execute bit - an otherwise meaningless combination.
2237 */
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002238
2239static inline int __mandatory_lock(struct inode *ino)
2240{
2241 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2242}
2243
2244/*
David Howellse462ec52017-07-17 08:45:35 +01002245 * ... and these candidates should be on SB_MANDLOCK mounted fs,
Pavel Emelyanova16877c2007-10-01 14:41:11 -07002246 * otherwise these will be advisory locks
2247 */
2248
2249static inline int mandatory_lock(struct inode *ino)
2250{
2251 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2252}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253
Jeff Laytond7a06982014-03-10 09:54:15 -04002254static inline int locks_verify_locked(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255{
Miklos Szeredic568d682016-09-16 12:44:20 +02002256 if (mandatory_lock(locks_inode(file)))
Jeff Laytond7a06982014-03-10 09:54:15 -04002257 return locks_mandatory_locked(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 return 0;
2259}
2260
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261static inline int locks_verify_truncate(struct inode *inode,
Christoph Hellwigacc15572015-12-03 12:59:49 +01002262 struct file *f,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 loff_t size)
2264{
Christoph Hellwigacc15572015-12-03 12:59:49 +01002265 if (!inode->i_flctx || !mandatory_lock(inode))
2266 return 0;
2267
2268 if (size < inode->i_size) {
2269 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2270 F_WRLCK);
2271 } else {
2272 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2273 F_WRLCK);
2274 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275}
2276
Jeff Layton9e8925b2015-11-16 09:49:34 -05002277#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2278
2279static inline int locks_mandatory_locked(struct file *file)
2280{
2281 return 0;
2282}
2283
Linus Torvaldsfce205e2016-01-12 16:30:34 -08002284static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2285 loff_t start, loff_t end, unsigned char type)
Jeff Layton9e8925b2015-11-16 09:49:34 -05002286{
2287 return 0;
2288}
2289
2290static inline int __mandatory_lock(struct inode *inode)
2291{
2292 return 0;
2293}
2294
2295static inline int mandatory_lock(struct inode *inode)
2296{
2297 return 0;
2298}
2299
2300static inline int locks_verify_locked(struct file *file)
2301{
2302 return 0;
2303}
2304
2305static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2306 size_t size)
2307{
2308 return 0;
2309}
2310
2311#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2312
2313
2314#ifdef CONFIG_FILE_LOCKING
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315static inline int break_lease(struct inode *inode, unsigned int mode)
2316{
Jeff Layton24cbe782014-02-03 12:13:06 -05002317 /*
2318 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002319 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2320 * could end up racing with tasks trying to set a new lease on this
2321 * file.
Jeff Layton24cbe782014-02-03 12:13:06 -05002322 */
2323 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002324 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002325 return __break_lease(inode, mode, FL_LEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 return 0;
2327}
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002328
2329static inline int break_deleg(struct inode *inode, unsigned int mode)
2330{
Jeff Layton962bd402014-06-10 12:24:40 -04002331 /*
2332 * Since this check is lockless, we must ensure that any refcounts
Jeff Layton8116bf42015-01-21 20:44:01 -05002333 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2334 * could end up racing with tasks trying to set a new lease on this
2335 * file.
Jeff Layton962bd402014-06-10 12:24:40 -04002336 */
2337 smp_mb();
Jeff Layton8634b512015-01-16 15:05:55 -05002338 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002339 return __break_lease(inode, mode, FL_DELEG);
2340 return 0;
2341}
2342
J. Bruce Fields5a146962012-08-28 07:50:40 -07002343static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2344{
2345 int ret;
2346
2347 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2348 if (ret == -EWOULDBLOCK && delegated_inode) {
2349 *delegated_inode = inode;
2350 ihold(inode);
2351 }
2352 return ret;
2353}
2354
2355static inline int break_deleg_wait(struct inode **delegated_inode)
2356{
2357 int ret;
2358
2359 ret = break_deleg(*delegated_inode, O_WRONLY);
2360 iput(*delegated_inode);
2361 *delegated_inode = NULL;
2362 return ret;
2363}
2364
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002365static inline int break_layout(struct inode *inode, bool wait)
2366{
2367 smp_mb();
2368 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2369 return __break_lease(inode,
2370 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2371 FL_LAYOUT);
2372 return 0;
2373}
2374
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002375#else /* !CONFIG_FILE_LOCKING */
Steven Whitehouseaf5df562009-01-20 10:29:46 +00002376static inline int break_lease(struct inode *inode, unsigned int mode)
2377{
2378 return 0;
2379}
2380
J. Bruce Fieldsdf4e8d22012-03-05 13:18:59 -05002381static inline int break_deleg(struct inode *inode, unsigned int mode)
2382{
2383 return 0;
2384}
J. Bruce Fields5a146962012-08-28 07:50:40 -07002385
2386static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2387{
2388 return 0;
2389}
2390
2391static inline int break_deleg_wait(struct inode **delegated_inode)
2392{
2393 BUG();
2394 return 0;
2395}
2396
Christoph Hellwig11afe9f2015-01-21 19:17:03 +01002397static inline int break_layout(struct inode *inode, bool wait)
2398{
2399 return 0;
2400}
2401
Thomas Petazzonibfcd17a2008-08-06 15:12:22 +02002402#endif /* CONFIG_FILE_LOCKING */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403
2404/* fs/open.c */
Jeff Laytonadb5c242012-10-10 16:43:13 -04002405struct audit_names;
Jeff Layton91a27b22012-10-10 15:25:28 -04002406struct filename {
Jeff Laytonadb5c242012-10-10 16:43:13 -04002407 const char *name; /* pointer to actual string */
2408 const __user char *uptr; /* original userland pointer */
Paul Moore55422d02015-01-22 00:00:23 -05002409 int refcnt;
Rasmus Villemoes1c9498432018-03-01 00:19:21 +01002410 struct audit_names *aname;
Al Virofd2f7cb2015-02-22 20:07:13 -05002411 const char iname[];
Jeff Layton91a27b22012-10-10 15:25:28 -04002412};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413
Al Viro7df818b2016-03-25 14:24:09 -04002414extern long vfs_truncate(const struct path *, loff_t);
NeilBrown4a301312006-01-08 01:02:39 -08002415extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2416 struct file *filp);
Anna Schumaker72c72bd2014-11-07 14:44:25 -05002417extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002418 loff_t len);
Jason Uhlenkott8e8a1402007-10-20 03:16:18 +02002419extern long do_sys_open(int dfd, const char __user *filename, int flags,
Al Viroa218d0f2011-11-21 14:59:34 -05002420 umode_t mode);
Jeff Layton669abf42012-10-10 16:43:10 -04002421extern struct file *file_open_name(struct filename *, int, umode_t);
Al Viroa218d0f2011-11-21 14:59:34 -05002422extern struct file *filp_open(const char *, int, umode_t);
Al Viro73d049a2011-03-11 12:08:24 -05002423extern struct file *file_open_root(struct dentry *, struct vfsmount *,
Jann Horn378c6522016-03-22 14:25:36 -07002424 const char *, int, umode_t);
Al Viro765927b2012-06-26 21:58:53 +04002425extern struct file * dentry_open(const struct path *, int, const struct cred *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426extern int filp_close(struct file *, fl_owner_t id);
Jeff Layton91a27b22012-10-10 15:25:28 -04002427
David Drysdale51f39a12014-12-12 16:57:29 -08002428extern struct filename *getname_flags(const char __user *, int, int *);
Jeff Layton91a27b22012-10-10 15:25:28 -04002429extern struct filename *getname(const char __user *);
Linus Torvaldsc4ad8f92014-02-05 12:54:53 -08002430extern struct filename *getname_kernel(const char *);
Paul Moore55422d02015-01-22 00:00:23 -05002431extern void putname(struct filename *name);
Jeff Layton91a27b22012-10-10 15:25:28 -04002432
Al Viro47237682012-06-10 05:01:45 -04002433enum {
2434 FILE_CREATED = 1,
2435 FILE_OPENED = 2
2436};
Al Viro30d90492012-06-22 12:40:19 +04002437extern int finish_open(struct file *file, struct dentry *dentry,
2438 int (*open)(struct inode *, struct file *),
2439 int *opened);
Al Viroe45198a2012-06-10 06:48:09 -04002440extern int finish_no_open(struct file *file, struct dentry *dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441
Ankit Jain3e63cbb2009-06-19 14:28:07 -04002442/* fs/ioctl.c */
2443
2444extern int ioctl_preallocate(struct file *filp, void __user *argp);
2445
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446/* fs/dcache.c */
2447extern void __init vfs_caches_init_early(void);
Mel Gorman4248b0d2015-08-06 15:46:20 -07002448extern void __init vfs_caches_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449
Christoph Lameterb86c0892006-12-06 20:32:57 -08002450extern struct kmem_cache *names_cachep;
2451
Jeff Laytona608ca22012-10-10 15:25:26 -04002452#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
Vegard Nossum3446a8a2009-05-16 11:22:14 +02002453#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454
David Howells93614012006-09-30 20:45:40 +02002455#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456extern int register_blkdev(unsigned int, const char *);
Akinobu Mitaf4480242007-07-17 04:03:47 -07002457extern void unregister_blkdev(unsigned int, const char *);
Jan Karaf44f1ab2017-02-02 15:56:49 +01002458extern void bdev_unhash_inode(dev_t dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459extern struct block_device *bdget(dev_t);
Alan Jenkinsdddac6a2009-07-29 21:07:55 +02002460extern struct block_device *bdgrab(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461extern void bd_set_size(struct block_device *, loff_t size);
2462extern void bd_forget(struct inode *inode);
2463extern void bdput(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002464extern void invalidate_bdev(struct block_device *);
Jan Kara5c0d6b62012-07-03 16:45:31 +02002465extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002466extern int sync_blockdev(struct block_device *bdev);
Al Viroff01bb42011-09-16 02:31:11 -04002467extern void kill_bdev(struct block_device *);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002468extern struct super_block *freeze_bdev(struct block_device *);
Eric Sandeenc2d75432009-03-31 15:23:46 -07002469extern void emergency_thaw_all(void);
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002470extern void emergency_thaw_bdev(struct super_block *sb);
Nick Piggin585d3bc2009-02-25 10:44:19 +01002471extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2472extern int fsync_bdev(struct block_device *);
Tejun Heoa212b102015-05-22 17:13:33 -04002473
2474extern struct super_block *blockdev_superblock;
2475
2476static inline bool sb_is_blkdev_sb(struct super_block *sb)
2477{
2478 return sb == blockdev_superblock;
2479}
David Howells93614012006-09-30 20:45:40 +02002480#else
2481static inline void bd_forget(struct inode *inode) {}
Al Viro47e44912009-04-01 07:07:16 -04002482static inline int sync_blockdev(struct block_device *bdev) { return 0; }
Al Viroff01bb42011-09-16 02:31:11 -04002483static inline void kill_bdev(struct block_device *bdev) {}
Al Viro47e44912009-04-01 07:07:16 -04002484static inline void invalidate_bdev(struct block_device *bdev) {}
2485
2486static inline struct super_block *freeze_bdev(struct block_device *sb)
2487{
2488 return NULL;
2489}
2490
2491static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2492{
2493 return 0;
2494}
Jan Kara5c0d6b62012-07-03 16:45:31 +02002495
Mateusz Guzik08fdc8a2017-10-03 18:17:41 +02002496static inline int emergency_thaw_bdev(struct super_block *sb)
2497{
2498 return 0;
2499}
2500
Jan Kara5c0d6b62012-07-03 16:45:31 +02002501static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2502{
2503}
Jan Karaa8855992013-07-09 22:36:45 +08002504
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002505static inline bool sb_is_blkdev_sb(struct super_block *sb)
Jan Karaa8855992013-07-09 22:36:45 +08002506{
Yaowei Bai3e004ee2015-11-17 14:40:09 +08002507 return false;
Jan Karaa8855992013-07-09 22:36:45 +08002508}
David Howells93614012006-09-30 20:45:40 +02002509#endif
Jan Kara60b06802009-04-27 16:43:53 +02002510extern int sync_filesystem(struct super_block *);
David Howells93614012006-09-30 20:45:40 +02002511extern const struct file_operations def_blk_fops;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08002512extern const struct file_operations def_chr_fops;
David Howells93614012006-09-30 20:45:40 +02002513#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
Al Viro56b26ad2008-09-19 03:17:36 -04002515extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
Tejun Heoe525fd82010-11-13 11:55:17 +01002517extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
Tejun Heod4d77622010-11-13 11:55:18 +01002518extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2519 void *holder);
2520extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2521 void *holder);
Al Viro4385bab2013-05-05 22:11:03 -04002522extern void blkdev_put(struct block_device *bdev, fmode_t mode);
Jarod Wilsonbe324172015-05-06 12:26:22 +08002523extern int __blkdev_reread_part(struct block_device *bdev);
2524extern int blkdev_reread_part(struct block_device *bdev);
2525
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002526#ifdef CONFIG_SYSFS
Tejun Heoe09b4572010-11-13 11:55:17 +01002527extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
Tejun Heo49731ba2011-01-14 18:43:57 +01002528extern void bd_unlink_disk_holder(struct block_device *bdev,
2529 struct gendisk *disk);
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002530#else
Tejun Heoe09b4572010-11-13 11:55:17 +01002531static inline int bd_link_disk_holder(struct block_device *bdev,
2532 struct gendisk *disk)
2533{
2534 return 0;
2535}
Tejun Heo49731ba2011-01-14 18:43:57 +01002536static inline void bd_unlink_disk_holder(struct block_device *bdev,
2537 struct gendisk *disk)
2538{
2539}
Jun'ichi Nomura641dc632006-03-27 01:17:57 -08002540#endif
David Howells93614012006-09-30 20:45:40 +02002541#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002542
2543/* fs/char_dev.c */
Logan Gunthorpe8a932f72017-06-15 14:05:21 -06002544#define CHRDEV_MAJOR_MAX 512
Linus Walleij49db08c2016-02-19 15:36:07 +01002545/* Marks the bottom of the first segment of free char majors */
2546#define CHRDEV_MAJOR_DYN_END 234
Logan Gunthorpea5d31a32017-06-15 14:05:20 -06002547/* Marks the top and bottom of the second segment of free char majors */
2548#define CHRDEV_MAJOR_DYN_EXT_START 511
2549#define CHRDEV_MAJOR_DYN_EXT_END 384
2550
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2552extern int register_chrdev_region(dev_t, unsigned, const char *);
Tejun Heo1905b1b2009-08-06 18:13:23 +09002553extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2554 unsigned int count, const char *name,
2555 const struct file_operations *fops);
2556extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2557 unsigned int count, const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558extern void unregister_chrdev_region(dev_t, unsigned);
Joe Korty68eef3b2006-03-31 02:30:32 -08002559extern void chrdev_show(struct seq_file *,off_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560
Tejun Heo1905b1b2009-08-06 18:13:23 +09002561static inline int register_chrdev(unsigned int major, const char *name,
2562 const struct file_operations *fops)
2563{
2564 return __register_chrdev(major, 0, 256, name, fops);
2565}
2566
2567static inline void unregister_chrdev(unsigned int major, const char *name)
2568{
2569 __unregister_chrdev(major, 0, 256, name);
2570}
2571
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572/* fs/block_dev.c */
2573#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
Tejun Heo1f014292008-08-25 19:47:23 +09002574#define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
David Howells93614012006-09-30 20:45:40 +02002575
2576#ifdef CONFIG_BLOCK
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002577#define BLKDEV_MAJOR_MAX 512
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578extern const char *__bdevname(dev_t, char *buffer);
2579extern const char *bdevname(struct block_device *bdev, char *buffer);
2580extern struct block_device *lookup_bdev(const char *);
Joe Korty68eef3b2006-03-31 02:30:32 -08002581extern void blkdev_show(struct seq_file *,off_t);
Al Viro30c40d22008-02-22 19:50:45 -05002582
David Howells93614012006-09-30 20:45:40 +02002583#else
Logan Gunthorpe133d55c2017-06-16 17:48:21 -06002584#define BLKDEV_MAJOR_MAX 0
David Howells93614012006-09-30 20:45:40 +02002585#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586
2587extern void init_special_inode(struct inode *, umode_t, dev_t);
2588
2589/* Invalid inode operations -- fs/bad_inode.c */
2590extern void make_bad_inode(struct inode *);
Yaowei Bai0e3ef1f2015-11-19 21:00:11 +08002591extern bool is_bad_inode(struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592
Jens Axboec11f0c02016-08-05 08:11:04 -06002593#ifdef CONFIG_BLOCK
Andrew Pattersonc3279d12008-09-04 14:27:25 -06002594extern void check_disk_size_change(struct gendisk *disk,
Christoph Hellwig5afb7832018-05-29 16:42:59 +02002595 struct block_device *bdev, bool verbose);
Andrew Patterson0c002c22008-09-04 14:27:20 -06002596extern int revalidate_disk(struct gendisk *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597extern int check_disk_change(struct block_device *);
NeilBrown93b270f2011-02-24 17:25:47 +11002598extern int __invalidate_device(struct block_device *, bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599extern int invalidate_partition(struct gendisk *, int);
David Howells93614012006-09-30 20:45:40 +02002600#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601unsigned long invalidate_mapping_pages(struct address_space *mapping,
2602 pgoff_t start, pgoff_t end);
Anton Altaparmakov54bc4852007-02-10 01:45:38 -08002603
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604static inline void invalidate_remote_inode(struct inode *inode)
2605{
2606 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2607 S_ISLNK(inode->i_mode))
Andrew Mortonfc0ecff2007-02-10 01:45:39 -08002608 invalidate_mapping_pages(inode->i_mapping, 0, -1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609}
2610extern int invalidate_inode_pages2(struct address_space *mapping);
2611extern int invalidate_inode_pages2_range(struct address_space *mapping,
2612 pgoff_t start, pgoff_t end);
2613extern int write_inode_now(struct inode *, int);
2614extern int filemap_fdatawrite(struct address_space *);
2615extern int filemap_flush(struct address_space *);
Jeff Layton76341ca2017-07-06 07:02:22 -04002616extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
Jan Karad3bccb6f2009-08-17 19:30:27 +02002617extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2618 loff_t lend);
Jeff Laytonffb959b2017-07-31 10:29:38 -04002619
2620static inline int filemap_fdatawait(struct address_space *mapping)
2621{
2622 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2623}
2624
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -05002625extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2626 loff_t lend);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627extern int filemap_write_and_wait(struct address_space *mapping);
2628extern int filemap_write_and_wait_range(struct address_space *mapping,
2629 loff_t lstart, loff_t lend);
Andrew Mortonebcf28e2006-03-24 03:18:04 -08002630extern int __filemap_fdatawrite_range(struct address_space *mapping,
2631 loff_t start, loff_t end, int sync_mode);
Jan Karaf4c0a0f2008-07-11 19:27:31 -04002632extern int filemap_fdatawrite_range(struct address_space *mapping,
2633 loff_t start, loff_t end);
Miklos Szeredid72d9e22016-07-29 14:10:57 +02002634extern int filemap_check_errors(struct address_space *mapping);
Jeff Layton5660e132017-07-06 07:02:25 -04002635extern void __filemap_set_wb_err(struct address_space *mapping, int err);
Jeff Laytona823e452017-07-28 07:24:43 -04002636
2637extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2638 loff_t lend);
Jeff Layton5660e132017-07-06 07:02:25 -04002639extern int __must_check file_check_and_advance_wb_err(struct file *file);
2640extern int __must_check file_write_and_wait_range(struct file *file,
2641 loff_t start, loff_t end);
2642
Jeff Laytona823e452017-07-28 07:24:43 -04002643static inline int file_write_and_wait(struct file *file)
2644{
2645 return file_write_and_wait_range(file, 0, LLONG_MAX);
2646}
2647
Jeff Layton5660e132017-07-06 07:02:25 -04002648/**
2649 * filemap_set_wb_err - set a writeback error on an address_space
2650 * @mapping: mapping in which to set writeback error
2651 * @err: error to be set in mapping
2652 *
2653 * When writeback fails in some way, we must record that error so that
2654 * userspace can be informed when fsync and the like are called. We endeavor
2655 * to report errors on any file that was open at the time of the error. Some
2656 * internal callers also need to know when writeback errors have occurred.
2657 *
2658 * When a writeback error occurs, most filesystems will want to call
2659 * filemap_set_wb_err to record the error in the mapping so that it will be
2660 * automatically reported whenever fsync is called on the file.
Jeff Layton5660e132017-07-06 07:02:25 -04002661 */
2662static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2663{
2664 /* Fastpath for common case of no error */
2665 if (unlikely(err))
2666 __filemap_set_wb_err(mapping, err);
2667}
2668
2669/**
2670 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2671 * @mapping: mapping to check for writeback errors
2672 * @since: previously-sampled errseq_t
2673 *
2674 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2675 * the given value was sampled.
2676 *
2677 * If it has then report the latest error set, otherwise return 0.
2678 */
2679static inline int filemap_check_wb_err(struct address_space *mapping,
2680 errseq_t since)
2681{
2682 return errseq_check(&mapping->wb_err, since);
2683}
2684
2685/**
2686 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2687 * @mapping: mapping to be sampled
2688 *
2689 * Writeback errors are always reported relative to a particular sample point
2690 * in the past. This function provides those sample points.
2691 */
2692static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2693{
2694 return errseq_sample(&mapping->wb_err);
2695}
2696
Christoph Hellwig8018ab02010-03-22 17:32:25 +01002697extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2698 int datasync);
2699extern int vfs_fsync(struct file *file, int datasync);
Christoph Hellwige2592212016-04-07 08:52:01 -07002700
2701/*
2702 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2703 * to already be updated for the write, and will return either the amount
2704 * of bytes passed in, or an error if syncing the file failed.
2705 */
2706static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
Al Virod311d792014-02-09 15:18:09 -05002707{
Christoph Hellwige2592212016-04-07 08:52:01 -07002708 if (iocb->ki_flags & IOCB_DSYNC) {
2709 int ret = vfs_fsync_range(iocb->ki_filp,
2710 iocb->ki_pos - count, iocb->ki_pos - 1,
2711 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2712 if (ret)
2713 return ret;
2714 }
2715
2716 return count;
Al Virod311d792014-02-09 15:18:09 -05002717}
Christoph Hellwige2592212016-04-07 08:52:01 -07002718
Linus Torvalds1da177e2005-04-16 15:20:36 -07002719extern void emergency_sync(void);
2720extern void emergency_remount(void);
David Howells93614012006-09-30 20:45:40 +02002721#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722extern sector_t bmap(struct inode *, sector_t);
David Howells93614012006-09-30 20:45:40 +02002723#endif
J. Bruce Fields27ac0ff2011-09-20 17:19:26 -04002724extern int notify_change(struct dentry *, struct iattr *, struct inode **);
Al Virof419a2e2008-07-22 00:07:17 -04002725extern int inode_permission(struct inode *, int);
Al Viro2830ba72011-06-20 19:16:29 -04002726extern int generic_permission(struct inode *, int);
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02002727extern int __check_sticky(struct inode *dir, struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728
Miklos Szeredif696a362008-07-31 13:41:58 +02002729static inline bool execute_ok(struct inode *inode)
2730{
2731 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2732}
2733
Al Viro8d71db42013-03-19 21:01:03 -04002734static inline void file_start_write(struct file *file)
2735{
2736 if (!S_ISREG(file_inode(file)->i_mode))
2737 return;
2738 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2739}
2740
Jan Kara5ae98f12013-05-04 00:11:23 +02002741static inline bool file_start_write_trylock(struct file *file)
2742{
2743 if (!S_ISREG(file_inode(file)->i_mode))
2744 return true;
2745 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2746}
2747
Al Viro8d71db42013-03-19 21:01:03 -04002748static inline void file_end_write(struct file *file)
2749{
2750 if (!S_ISREG(file_inode(file)->i_mode))
2751 return;
2752 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2753}
2754
Amir Goldsteinbfe219d2017-01-31 10:34:57 +02002755static inline int do_clone_file_range(struct file *file_in, loff_t pos_in,
2756 struct file *file_out, loff_t pos_out,
2757 u64 len)
2758{
2759 int ret;
2760
2761 file_start_write(file_out);
2762 ret = vfs_clone_file_range(file_in, pos_in, file_out, pos_out, len);
2763 file_end_write(file_out);
2764
2765 return ret;
2766}
2767
Al Viro07b8ce12011-06-20 10:52:57 -04002768/*
2769 * get_write_access() gets write permission for a file.
2770 * put_write_access() releases this write permission.
2771 * This is used for regular files.
2772 * We cannot support write (and maybe mmap read-write shared) accesses and
2773 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2774 * can have the following values:
2775 * 0: no writers, no VM_DENYWRITE mappings
2776 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2777 * > 0: (i_writecount) users are writing to the file.
2778 *
2779 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2780 * except for the cases where we don't hold i_writecount yet. Then we need to
2781 * use {get,deny}_write_access() - these functions check the sign and refuse
2782 * to do the change if sign is wrong.
2783 */
2784static inline int get_write_access(struct inode *inode)
2785{
2786 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2787}
2788static inline int deny_write_access(struct file *file)
2789{
Al Viro496ad9a2013-01-23 17:07:38 -05002790 struct inode *inode = file_inode(file);
Al Viro07b8ce12011-06-20 10:52:57 -04002791 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2792}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793static inline void put_write_access(struct inode * inode)
2794{
2795 atomic_dec(&inode->i_writecount);
2796}
2797static inline void allow_write_access(struct file *file)
2798{
2799 if (file)
Al Viro496ad9a2013-01-23 17:07:38 -05002800 atomic_inc(&file_inode(file)->i_writecount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801}
David Howellsf1fe29b2013-09-27 11:20:03 +01002802static inline bool inode_is_open_for_write(const struct inode *inode)
2803{
2804 return atomic_read(&inode->i_writecount) > 0;
2805}
2806
Mimi Zohara5c96eb2010-11-02 10:11:37 -04002807#ifdef CONFIG_IMA
2808static inline void i_readcount_dec(struct inode *inode)
2809{
2810 BUG_ON(!atomic_read(&inode->i_readcount));
2811 atomic_dec(&inode->i_readcount);
2812}
2813static inline void i_readcount_inc(struct inode *inode)
2814{
2815 atomic_inc(&inode->i_readcount);
2816}
2817#else
2818static inline void i_readcount_dec(struct inode *inode)
2819{
2820 return;
2821}
2822static inline void i_readcount_inc(struct inode *inode)
2823{
2824 return;
2825}
2826#endif
Ulrich Dreppered8cae82008-07-23 21:29:30 -07002827extern int do_pipe_flags(int *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828
Mimi Zohar1284ab52016-04-20 15:46:27 -07002829#define __kernel_read_file_id(id) \
2830 id(UNKNOWN, unknown) \
2831 id(FIRMWARE, firmware) \
Stephen Boyda098ecd2016-08-02 14:04:28 -07002832 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002833 id(MODULE, kernel-module) \
2834 id(KEXEC_IMAGE, kexec-image) \
2835 id(KEXEC_INITRAMFS, kexec-initramfs) \
2836 id(POLICY, security-policy) \
Christoph Hellwiga7d3d032017-09-10 09:49:45 +02002837 id(X509_CERTIFICATE, x509-certificate) \
Mimi Zohar1284ab52016-04-20 15:46:27 -07002838 id(MAX_ID, )
2839
2840#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2841#define __fid_stringify(dummy, str) #str,
2842
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002843enum kernel_read_file_id {
Mimi Zohar1284ab52016-04-20 15:46:27 -07002844 __kernel_read_file_id(__fid_enumify)
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002845};
2846
Mimi Zohar1284ab52016-04-20 15:46:27 -07002847static const char * const kernel_read_file_str[] = {
2848 __kernel_read_file_id(__fid_stringify)
2849};
2850
Kees Cookda20dfe2016-04-21 12:53:29 -07002851static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002852{
Arnd Bergmanncbfd0c12017-03-09 16:16:57 -08002853 if ((unsigned)id >= READING_MAX_ID)
Mimi Zohar1284ab52016-04-20 15:46:27 -07002854 return kernel_read_file_str[READING_UNKNOWN];
2855
2856 return kernel_read_file_str[id];
2857}
2858
Mimi Zoharbc8ca5b2016-01-24 10:07:32 -05002859extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2860 enum kernel_read_file_id);
Mimi Zohar711aab12017-09-12 22:45:33 -04002861extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
Mimi Zohar09596b92015-11-19 12:39:22 -05002862 enum kernel_read_file_id);
Mimi Zoharb844f0e2016-02-01 08:36:21 -05002863extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2864 enum kernel_read_file_id);
Christoph Hellwigbdd1d2d2017-09-01 17:39:13 +02002865extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
Christoph Hellwige13ec932017-09-01 17:39:14 +02002866extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
Christoph Hellwig73e18f72017-09-01 17:39:15 +02002867extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868extern struct file * open_exec(const char *);
2869
2870/* fs/dcache.c -- generic fs support functions */
Yaowei Baia6e57872015-11-17 14:40:11 +08002871extern bool is_subdir(struct dentry *, struct dentry *);
Mickaël Salaün640eb7e2016-11-14 22:14:35 +01002872extern bool path_is_under(const struct path *, const struct path *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873
Miklos Szeredi9bf39ab2015-06-19 10:29:13 +02002874extern char *file_path(struct file *, char *, int);
2875
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876#include <linux/err.h>
2877
2878/* needed for stackable file system support */
Andrew Morton965c8e52012-12-17 15:59:39 -08002879extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880
Andrew Morton965c8e52012-12-17 15:59:39 -08002881extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882
Christoph Hellwig54e34622009-08-07 14:38:25 -03002883extern int inode_init_always(struct super_block *, struct inode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002884extern void inode_init_once(struct inode *);
Miklos Szeredi2aa15892011-02-23 13:49:47 +01002885extern void address_space_init_once(struct address_space *mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002886extern struct inode * igrab(struct inode *);
2887extern ino_t iunique(struct super_block *, ino_t);
2888extern int inode_needs_sync(struct inode *inode);
Al Viro45321ac2010-06-07 13:43:19 -04002889extern int generic_delete_inode(struct inode *inode);
Al Viro9bcb4b72012-02-12 19:43:17 -05002890static inline int generic_drop_inode(struct inode *inode)
2891{
2892 return !inode->i_nlink || inode_unhashed(inode);
2893}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894
Anton Altaparmakov88bd5122005-07-13 01:10:44 -07002895extern struct inode *ilookup5_nowait(struct super_block *sb,
2896 unsigned long hashval, int (*test)(struct inode *, void *),
2897 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2899 int (*test)(struct inode *, void *), void *data);
2900extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2901
Miklos Szeredi80ea09a2018-05-17 10:53:05 +02002902extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2903 int (*test)(struct inode *, void *),
2904 int (*set)(struct inode *, void *),
2905 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2907extern struct inode * iget_locked(struct super_block *, unsigned long);
Theodore Ts'ofe032c42015-02-02 00:37:01 -05002908extern struct inode *find_inode_nowait(struct super_block *,
2909 unsigned long,
2910 int (*match)(struct inode *,
2911 unsigned long, void *),
2912 void *data);
Al Viro261bca82008-12-30 01:48:21 -05002913extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2914extern int insert_inode_locked(struct inode *);
Josh Boyere096d0c2011-08-25 07:48:12 -04002915#ifdef CONFIG_DEBUG_LOCK_ALLOC
2916extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2917#else
2918static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2919#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920extern void unlock_new_inode(struct inode *);
Christoph Hellwig85fe4022010-10-23 11:19:54 -04002921extern unsigned int get_next_ino(void);
Darrick J. Wong799ea9e2017-08-18 18:08:25 -07002922extern void evict_inodes(struct super_block *sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924extern void __iget(struct inode * inode);
David Howellsb46980f2008-02-07 00:15:27 -08002925extern void iget_failed(struct inode *);
Jan Karadbd57682012-05-03 14:48:02 +02002926extern void clear_inode(struct inode *);
Christoph Hellwig2e00c972009-08-07 14:38:29 -03002927extern void __destroy_inode(struct inode *);
Eric Dumazeta209dfc2011-07-26 11:36:34 +02002928extern struct inode *new_inode_pseudo(struct super_block *sb);
2929extern struct inode *new_inode(struct super_block *sb);
Nick Pigginff0c7d12011-01-07 17:49:50 +11002930extern void free_inode_nonrcu(struct inode *inode);
Jens Axboe01de85e2006-10-17 19:50:36 +02002931extern int should_remove_suid(struct dentry *);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002932extern int file_remove_privs(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933
2934extern void __insert_inode_hash(struct inode *, unsigned long hashval);
Christoph Hellwig646ec462010-10-23 07:15:32 -04002935static inline void insert_inode_hash(struct inode *inode)
2936{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 __insert_inode_hash(inode, inode->i_ino);
2938}
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002939
2940extern void __remove_inode_hash(struct inode *);
2941static inline void remove_inode_hash(struct inode *inode)
2942{
Josef Bacikcbedaac2015-03-12 08:19:11 -04002943 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
Eric Dumazetf2ee7ab2011-07-28 06:41:09 +02002944 __remove_inode_hash(inode);
2945}
2946
Christoph Hellwig646ec462010-10-23 07:15:32 -04002947extern void inode_sb_list_add(struct inode *inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948
David Howells93614012006-09-30 20:45:40 +02002949#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950extern int bdev_read_only(struct block_device *);
David Howells93614012006-09-30 20:45:40 +02002951#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952extern int set_blocksize(struct block_device *, int);
2953extern int sb_set_blocksize(struct super_block *, int);
2954extern int sb_min_blocksize(struct super_block *, int);
2955
2956extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2957extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
Al Viro3309dd02015-04-09 12:55:47 -04002958extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
Al Viroed978a82014-03-05 22:53:04 -05002959extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002960extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
Al Viro81742022014-04-03 03:17:43 -04002961extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002962extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
Al Viro3b93f912014-02-11 21:34:08 -05002963extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002964
Christoph Hellwig18e97102017-05-27 11:16:51 +03002965ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02002966 rwf_t flags);
Christoph Hellwigabbb65892017-05-27 11:16:52 +03002967ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02002968 rwf_t flags);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +01002969
Christoph Hellwigeef99382009-08-20 17:43:41 +02002970/* fs/block_dev.c */
David Jefferyb2de5252014-09-29 10:21:10 -04002971extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
Al Viro1456c0a2014-04-03 03:21:50 -04002972extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
Josef Bacik02c24a82011-07-16 20:44:56 -04002973extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2974 int datasync);
Al Viroff01bb42011-09-16 02:31:11 -04002975extern void block_sync_page(struct page *page);
Christoph Hellwigeef99382009-08-20 17:43:41 +02002976
Andrew Morton88e6fae2006-04-11 13:59:36 +02002977/* fs/splice.c */
Jens Axboecbb7e572006-04-11 14:57:50 +02002978extern ssize_t generic_file_splice_read(struct file *, loff_t *,
Andrew Morton88e6fae2006-04-11 13:59:36 +02002979 struct pipe_inode_info *, size_t, unsigned int);
Al Viro8d020762014-04-05 04:27:08 -04002980extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
Jens Axboecbb7e572006-04-11 14:57:50 +02002981 struct file *, loff_t *, size_t, unsigned int);
Andrew Morton88e6fae2006-04-11 13:59:36 +02002982extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
Jens Axboecbb7e572006-04-11 14:57:50 +02002983 struct file *out, loff_t *, size_t len, unsigned int flags);
Miklos Szeredi1c118592014-10-24 00:14:35 +02002984extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2985 loff_t *opos, size_t len, unsigned int flags);
2986
Andrew Morton88e6fae2006-04-11 13:59:36 +02002987
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988extern void
2989file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
Andrew Morton965c8e52012-12-17 15:59:39 -08002990extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2991extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
Jie Liu46a1c2c2013-06-25 12:02:13 +08002992extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
Andrew Morton965c8e52012-12-17 15:59:39 -08002993extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
Andi Kleen57604952011-09-15 16:06:50 -07002994extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
Andrew Morton965c8e52012-12-17 15:59:39 -08002995 int whence, loff_t maxsize, loff_t eof);
Al Viro1bf9d142013-06-16 20:27:42 +04002996extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2997 int whence, loff_t size);
Al Virob25472f2015-12-05 22:04:48 -05002998extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
2999extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000extern int generic_file_open(struct inode * inode, struct file * filp);
3001extern int nonseekable_open(struct inode * inode, struct file * filp);
3002
David Howells93614012006-09-30 20:45:40 +02003003#ifdef CONFIG_BLOCK
Mike Christie8a4c1e42016-06-05 14:31:50 -05003004typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
Josef Bacikfacd07b2010-05-23 11:00:55 -04003005 loff_t file_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006
3007enum {
Christoph Hellwig1e431f52009-11-03 16:44:53 +01003008 /* need locking between buffered and direct access */
3009 DIO_LOCKING = 0x01,
3010
3011 /* filesystem does not support filling holes */
3012 DIO_SKIP_HOLES = 0x02,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013};
3014
Christoph Hellwig40553512017-06-03 09:37:58 +02003015void dio_end_io(struct bio *bio);
Darrick J. Wong5a9d9292018-01-08 10:41:39 -08003016void dio_warn_stale_pagecache(struct file *filp);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003017
Omar Sandoval17f8c842015-03-16 04:33:50 -07003018ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3019 struct block_device *bdev, struct iov_iter *iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003020 get_block_t get_block,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003021 dio_iodone_t end_io, dio_submit_t submit_io,
3022 int flags);
Christoph Hellwigeafdc7d2010-06-04 11:29:53 +02003023
Omar Sandoval17f8c842015-03-16 04:33:50 -07003024static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3025 struct inode *inode,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003026 struct iov_iter *iter,
Omar Sandoval17f8c842015-03-16 04:33:50 -07003027 get_block_t get_block)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028{
Omar Sandoval17f8c842015-03-16 04:33:50 -07003029 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07003030 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031}
David Howells93614012006-09-30 20:45:40 +02003032#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033
Trond Myklebust1d59d612012-05-31 12:22:33 -04003034void inode_dio_wait(struct inode *inode);
Jens Axboefe0f07d2015-04-15 17:05:48 -06003035
3036/*
3037 * inode_dio_begin - signal start of a direct I/O requests
3038 * @inode: inode the direct I/O happens on
3039 *
3040 * This is called once we've finished processing a direct I/O request,
3041 * and is used to wake up callers waiting for direct I/O to be quiesced.
3042 */
3043static inline void inode_dio_begin(struct inode *inode)
3044{
3045 atomic_inc(&inode->i_dio_count);
3046}
3047
3048/*
3049 * inode_dio_end - signal finish of a direct I/O requests
3050 * @inode: inode the direct I/O happens on
3051 *
3052 * This is called once we've finished processing a direct I/O request,
3053 * and is used to wake up callers waiting for direct I/O to be quiesced.
3054 */
3055static inline void inode_dio_end(struct inode *inode)
3056{
3057 if (atomic_dec_and_test(&inode->i_dio_count))
3058 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3059}
Trond Myklebust1d59d612012-05-31 12:22:33 -04003060
Theodore Ts'o5f16f322014-03-24 14:43:12 -04003061extern void inode_set_flags(struct inode *inode, unsigned int flags,
3062 unsigned int mask);
3063
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003064extern const struct file_operations generic_ro_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065
3066#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3067
Al Viro5d826c82014-03-14 13:42:45 -04003068extern int readlink_copy(char __user *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003069extern int page_readlink(struct dentry *, char __user *, int);
Al Virofceef392015-12-29 15:58:39 -05003070extern const char *page_get_link(struct dentry *, struct inode *,
3071 struct delayed_call *);
3072extern void page_put_link(void *);
Kirill Korotaev0adb25d2006-03-11 03:27:13 -08003073extern int __page_symlink(struct inode *inode, const char *symname, int len,
Nick Piggin54566b22009-01-04 12:00:53 -08003074 int nofs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075extern int page_symlink(struct inode *inode, const char *symname, int len);
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003076extern const struct inode_operations page_symlink_inode_operations;
Al Virofceef392015-12-29 15:58:39 -05003077extern void kfree_link(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003078extern void generic_fillattr(struct inode *, struct kstat *);
David Howellsa528d352017-01-31 16:46:22 +00003079extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3080extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
Dmitry Monakhovb4627072009-12-14 15:21:12 +03003081void __inode_add_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082void inode_add_bytes(struct inode *inode, loff_t bytes);
Jan Kara1c8924e2013-08-17 09:32:32 -04003083void __inode_sub_bytes(struct inode *inode, loff_t bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003084void inode_sub_bytes(struct inode *inode, loff_t bytes);
Jan Karaf4a8116a2017-08-08 09:54:36 +02003085static inline loff_t __inode_get_bytes(struct inode *inode)
3086{
3087 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3088}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003089loff_t inode_get_bytes(struct inode *inode);
3090void inode_set_bytes(struct inode *inode, loff_t bytes);
Al Virofceef392015-12-29 15:58:39 -05003091const char *simple_get_link(struct dentry *, struct inode *,
3092 struct delayed_call *);
Al Viro61ba64f2015-05-02 09:54:06 -04003093extern const struct inode_operations simple_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094
Al Viro5c0ba4e2013-05-15 13:52:59 -04003095extern int iterate_dir(struct file *, struct dir_context *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096
David Howellsa528d352017-01-31 16:46:22 +00003097extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3098extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3099
3100static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3101{
David Howellsdeccf492017-05-04 23:30:16 +01003102 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3103 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003104}
3105static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3106{
David Howellsdeccf492017-05-04 23:30:16 +01003107 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
David Howellsa528d352017-01-31 16:46:22 +00003108 stat, STATX_BASIC_STATS);
3109}
3110static inline int vfs_fstatat(int dfd, const char __user *filename,
3111 struct kstat *stat, int flags)
3112{
Ian Kent5d38f042017-11-29 16:11:26 -08003113 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3114 stat, STATX_BASIC_STATS);
David Howellsa528d352017-01-31 16:46:22 +00003115}
3116static inline int vfs_fstat(int fd, struct kstat *stat)
3117{
3118 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3119}
3120
3121
Miklos Szeredid60874c2016-10-04 14:40:45 +02003122extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
Miklos Szeredifd4a0edf2016-12-09 16:45:04 +01003123extern int vfs_readlink(struct dentry *, char __user *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124
Steven Whitehousee9079cc2008-10-14 14:43:29 +01003125extern int __generic_block_fiemap(struct inode *inode,
Josef Bacik3a3076f2010-04-23 12:17:17 -04003126 struct fiemap_extent_info *fieinfo,
3127 loff_t start, loff_t len,
3128 get_block_t *get_block);
Josef Bacik68c9d702008-10-03 17:32:43 -04003129extern int generic_block_fiemap(struct inode *inode,
3130 struct fiemap_extent_info *fieinfo, u64 start,
3131 u64 len, get_block_t *get_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132
David Howellsee416bc2017-07-04 17:25:16 +01003133extern struct file_system_type *get_filesystem(struct file_system_type *fs);
Miklos Szeredic18479f2007-10-18 23:39:11 -07003134extern void put_filesystem(struct file_system_type *fs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135extern struct file_system_type *get_fs_type(const char *name);
3136extern struct super_block *get_super(struct block_device *);
Jan Kara6b6dc832012-02-10 11:03:00 +01003137extern struct super_block *get_super_thawed(struct block_device *);
Jan Karaba6379f2016-11-23 12:53:00 +01003138extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
Christoph Hellwig45042302009-08-03 23:28:35 +02003139extern struct super_block *get_active_super(struct block_device *bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003140extern void drop_super(struct super_block *sb);
Jan Karaba6379f2016-11-23 12:53:00 +01003141extern void drop_super_exclusive(struct super_block *sb);
Al Viro01a05b32010-03-23 06:06:58 -04003142extern void iterate_supers(void (*)(struct super_block *, void *), void *);
Al Viro43e15cd2011-06-03 20:16:57 -04003143extern void iterate_supers_type(struct file_system_type *,
3144 void (*)(struct super_block *, void *), void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145
3146extern int dcache_dir_open(struct inode *, struct file *);
3147extern int dcache_dir_close(struct inode *, struct file *);
3148extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
Al Viro5f99f4e2013-05-15 20:23:06 -04003149extern int dcache_readdir(struct file *, struct dir_context *);
npiggin@suse.de7bb46a62010-05-27 01:05:33 +10003150extern int simple_setattr(struct dentry *, struct iattr *);
David Howellsa528d352017-01-31 16:46:22 +00003151extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
David Howells726c3342006-06-23 02:02:58 -07003152extern int simple_statfs(struct dentry *, struct kstatfs *);
Stephen Boyd20955e82012-04-05 14:25:09 -07003153extern int simple_open(struct inode *inode, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3155extern int simple_unlink(struct inode *, struct dentry *);
3156extern int simple_rmdir(struct inode *, struct dentry *);
Miklos Szeredie0e0be82016-09-27 11:03:57 +02003157extern int simple_rename(struct inode *, struct dentry *,
3158 struct inode *, struct dentry *, unsigned int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003159extern int noop_fsync(struct file *, loff_t, loff_t, int);
Dan Williamsf44c7762018-03-07 15:26:44 -08003160extern int noop_set_page_dirty(struct page *page);
3161extern void noop_invalidatepage(struct page *page, unsigned int offset,
3162 unsigned int length);
3163extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164extern int simple_empty(struct dentry *);
3165extern int simple_readpage(struct file *file, struct page *page);
Nick Pigginafddba42007-10-16 01:25:01 -07003166extern int simple_write_begin(struct file *file, struct address_space *mapping,
3167 loff_t pos, unsigned len, unsigned flags,
3168 struct page **pagep, void **fsdata);
3169extern int simple_write_end(struct file *file, struct address_space *mapping,
3170 loff_t pos, unsigned len, unsigned copied,
3171 struct page *page, void *fsdata);
Al Virob26d4cd2013-10-25 18:47:37 -04003172extern int always_delete_dentry(const struct dentry *);
Al Viro69878432013-10-02 22:35:11 -04003173extern struct inode *alloc_anon_inode(struct super_block *);
Jeff Laytone6f5c782014-08-22 10:40:25 -04003174extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
Al Virob26d4cd2013-10-25 18:47:37 -04003175extern const struct dentry_operations simple_dentry_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176
Al Viro00cd8dd2012-06-10 17:13:09 -04003177extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -08003179extern const struct file_operations simple_dir_operations;
Arjan van de Venc5ef1c42007-02-12 00:55:40 -08003180extern const struct inode_operations simple_dir_inode_operations;
Eric W. Biedermanfbabfd02015-05-09 15:54:49 -05003181extern void make_empty_dir_inode(struct inode *inode);
3182extern bool is_empty_dir_inode(struct inode *inode);
Eric Biggerscda37122017-03-25 21:15:37 -07003183struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184struct dentry *d_alloc_name(struct dentry *, const char *);
Eric Biggerscda37122017-03-25 21:15:37 -07003185extern int simple_fill_super(struct super_block *, unsigned long,
3186 const struct tree_descr *);
Trond Myklebust1f5ce9e2006-06-09 09:34:16 -04003187extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188extern void simple_release_fs(struct vfsmount **mount, int *count);
3189
Akinobu Mita93b07112008-06-05 22:46:21 -07003190extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3191 loff_t *ppos, const void *from, size_t available);
Jiri Slaby6a727b42010-05-01 23:51:22 +02003192extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3193 const void __user *from, size_t count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003194
Fabian Frederickac13a822014-06-04 16:06:27 -07003195extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
Josef Bacik02c24a82011-07-16 20:44:56 -04003196extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
Al Virod5aacad2009-06-07 14:56:44 -04003197
Patrick J. LoPresti30ca22c2010-07-22 15:03:41 -07003198extern int generic_check_addressable(unsigned, u64);
3199
Christoph Lametere965f962006-02-01 03:05:41 -08003200#ifdef CONFIG_MIGRATION
Christoph Lameter2d1db3b2006-06-23 02:03:33 -07003201extern int buffer_migrate_page(struct address_space *,
Mel Gormana6bc32b2012-01-12 17:19:43 -08003202 struct page *, struct page *,
3203 enum migrate_mode);
Christoph Lametere965f962006-02-01 03:05:41 -08003204#else
3205#define buffer_migrate_page NULL
3206#endif
3207
Jan Kara31051c82016-05-26 16:55:18 +02003208extern int setattr_prepare(struct dentry *, struct iattr *);
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +10003209extern int inode_newsize_ok(const struct inode *, loff_t offset);
Christoph Hellwig6a1a90a2010-06-04 11:30:00 +02003210extern void setattr_copy(struct inode *inode, const struct iattr *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211
Josef Bacikc3b2da32012-03-26 09:59:21 -04003212extern int file_update_time(struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003214static inline bool io_is_direct(struct file *filp)
3215{
Dan Williams65f87ee2016-01-25 17:23:18 -08003216 return (filp->f_flags & O_DIRECT) || IS_DAX(filp->f_mapping->host);
Matthew Wilcoxd475c632015-02-16 15:58:56 -08003217}
3218
Dan Williamsbaabda22017-07-10 15:48:25 -07003219static inline bool vma_is_dax(struct vm_area_struct *vma)
3220{
3221 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3222}
3223
Dan Williams2bb6d282017-11-29 16:10:35 -08003224static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3225{
3226 struct inode *inode;
3227
3228 if (!vma->vm_file)
3229 return false;
3230 if (!vma_is_dax(vma))
3231 return false;
3232 inode = file_inode(vma->vm_file);
Dan Williams230f5a82018-02-21 17:08:01 -08003233 if (S_ISCHR(inode->i_mode))
Dan Williams2bb6d282017-11-29 16:10:35 -08003234 return false; /* device-dax */
3235 return true;
3236}
3237
Al Viro2ba48ce2015-04-09 13:52:01 -04003238static inline int iocb_flags(struct file *file)
3239{
3240 int res = 0;
3241 if (file->f_flags & O_APPEND)
3242 res |= IOCB_APPEND;
3243 if (io_is_direct(file))
3244 res |= IOCB_DIRECT;
Christoph Hellwigdde0c2e2016-04-07 08:52:00 -07003245 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3246 res |= IOCB_DSYNC;
3247 if (file->f_flags & __O_SYNC)
3248 res |= IOCB_SYNC;
Al Viro2ba48ce2015-04-09 13:52:01 -04003249 return res;
3250}
3251
Christoph Hellwigddef7ed22017-07-06 18:58:37 +02003252static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003253{
3254 if (unlikely(flags & ~RWF_SUPPORTED))
3255 return -EOPNOTSUPP;
3256
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003257 if (flags & RWF_NOWAIT) {
Christoph Hellwig91f99432017-08-29 16:13:20 +02003258 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
Goldwyn Rodriguesb745faf2017-06-20 07:05:43 -05003259 return -EOPNOTSUPP;
3260 ki->ki_flags |= IOCB_NOWAIT;
3261 }
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003262 if (flags & RWF_HIPRI)
3263 ki->ki_flags |= IOCB_HIPRI;
3264 if (flags & RWF_DSYNC)
3265 ki->ki_flags |= IOCB_DSYNC;
3266 if (flags & RWF_SYNC)
3267 ki->ki_flags |= (IOCB_DSYNC | IOCB_SYNC);
Jürg Billetere1fc7422017-09-29 14:07:17 +02003268 if (flags & RWF_APPEND)
3269 ki->ki_flags |= IOCB_APPEND;
Goldwyn Rodriguesfdd2f5b2017-06-20 07:05:40 -05003270 return 0;
3271}
3272
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273static inline ino_t parent_ino(struct dentry *dentry)
3274{
3275 ino_t res;
3276
Nick Pigginb5c84bf2011-01-07 17:49:38 +11003277 /*
3278 * Don't strictly need d_lock here? If the parent ino could change
3279 * then surely we'd have a deeper race in the caller?
3280 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281 spin_lock(&dentry->d_lock);
3282 res = dentry->d_parent->d_inode->i_ino;
3283 spin_unlock(&dentry->d_lock);
3284 return res;
3285}
3286
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287/* Transaction based IO helpers */
3288
3289/*
3290 * An argresp is stored in an allocated page and holds the
3291 * size of the argument or response, along with its content
3292 */
3293struct simple_transaction_argresp {
3294 ssize_t size;
3295 char data[0];
3296};
3297
3298#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3299
3300char *simple_transaction_get(struct file *file, const char __user *buf,
3301 size_t size);
3302ssize_t simple_transaction_read(struct file *file, char __user *buf,
3303 size_t size, loff_t *pos);
3304int simple_transaction_release(struct inode *inode, struct file *file);
3305
Ingo Molnar76791ab2009-03-25 16:48:35 +01003306void simple_transaction_set(struct file *file, size_t n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003308/*
3309 * simple attribute files
3310 *
3311 * These attributes behave similar to those in sysfs:
3312 *
3313 * Writing to an attribute immediately sets a value, an open file can be
3314 * written to multiple times.
3315 *
3316 * Reading from an attribute creates a buffer from the value that might get
3317 * read with multiple read calls. When the attribute has been read
3318 * completely, no further read calls are possible until the file is opened
3319 * again.
3320 *
3321 * All attributes contain a text representation of a numeric value
3322 * that are accessed with the get() and set() functions.
3323 */
3324#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3325static int __fops ## _open(struct inode *inode, struct file *file) \
3326{ \
3327 __simple_attr_check_format(__fmt, 0ull); \
3328 return simple_attr_open(inode, file, __get, __set, __fmt); \
3329} \
Alexey Dobriyan828c0952009-10-01 15:43:56 -07003330static const struct file_operations __fops = { \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003331 .owner = THIS_MODULE, \
3332 .open = __fops ## _open, \
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003333 .release = simple_attr_release, \
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003334 .read = simple_attr_read, \
3335 .write = simple_attr_write, \
Arnd Bergmann1ec55842010-08-15 21:50:52 +02003336 .llseek = generic_file_llseek, \
Joe Perches68be3022014-08-06 16:08:45 -07003337}
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003338
Joe Perchesb9075fa2011-10-31 17:11:33 -07003339static inline __printf(1, 2)
3340void __simple_attr_check_format(const char *fmt, ...)
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003341{
3342 /* don't do anything, just let the compiler check the arguments; */
3343}
3344
3345int simple_attr_open(struct inode *inode, struct file *file,
Christoph Hellwig8b88b092008-02-08 04:20:26 -08003346 int (*get)(void *, u64 *), int (*set)(void *, u64),
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003347 const char *fmt);
Christoph Hellwig74bedc42008-02-08 04:20:28 -08003348int simple_attr_release(struct inode *inode, struct file *file);
Arnd Bergmannacaefc22005-05-18 14:40:59 +02003349ssize_t simple_attr_read(struct file *file, char __user *buf,
3350 size_t len, loff_t *ppos);
3351ssize_t simple_attr_write(struct file *file, const char __user *buf,
3352 size_t len, loff_t *ppos);
3353
Alexey Dobriyan4be28542007-10-16 23:26:21 -07003354struct ctl_table;
Alexey Dobriyan8d65af72009-09-23 15:57:19 -07003355int proc_nr_files(struct ctl_table *table, int write,
Adrian Bunk62239ac2007-07-17 04:03:45 -07003356 void __user *buffer, size_t *lenp, loff_t *ppos);
Christoph Hellwig312d3ca2010-10-10 05:36:23 -04003357int proc_nr_dentry(struct ctl_table *table, int write,
3358 void __user *buffer, size_t *lenp, loff_t *ppos);
Dave Chinnercffbc8a2010-10-23 05:03:02 -04003359int proc_nr_inodes(struct ctl_table *table, int write,
3360 void __user *buffer, size_t *lenp, loff_t *ppos);
Tetsuo Handa38e23c92009-04-09 20:17:52 +09003361int __init get_filesystem_list(char *buf);
Adrian Bunk62239ac2007-07-17 04:03:45 -07003362
Namhyung Kim3cd90ea2011-02-01 15:52:46 -08003363#define __FMODE_EXEC ((__force int) FMODE_EXEC)
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003364#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3365
Al Viro6d125522009-12-24 06:58:56 -05003366#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
Eric Parisecf081d2009-12-17 21:24:25 -05003367#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
Namhyung Kim1a44bc82011-02-01 15:52:46 -08003368 (flag & __FMODE_NONOTIFY)))
Al Viro53009902009-12-19 10:15:07 -05003369
Yaowei Baid37177b2015-11-19 21:00:12 +08003370static inline bool is_sxid(umode_t mode)
Andi Kleen69b45732011-05-28 08:25:51 -07003371{
3372 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3373}
3374
Miklos Szeredicbdf35b2014-10-24 00:14:36 +02003375static inline int check_sticky(struct inode *dir, struct inode *inode)
3376{
3377 if (!(dir->i_mode & S_ISVTX))
3378 return 0;
3379
3380 return __check_sticky(dir, inode);
3381}
3382
Andi Kleen69b45732011-05-28 08:25:51 -07003383static inline void inode_has_no_xattr(struct inode *inode)
3384{
David Howellse462ec52017-07-17 08:45:35 +01003385 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
Andi Kleen69b45732011-05-28 08:25:51 -07003386 inode->i_flags |= S_NOSEC;
3387}
3388
Al Viroa7400222014-10-21 15:20:42 -04003389static inline bool is_root_inode(struct inode *inode)
3390{
3391 return inode == inode->i_sb->s_root->d_inode;
3392}
3393
Al Viro5f99f4e2013-05-15 20:23:06 -04003394static inline bool dir_emit(struct dir_context *ctx,
3395 const char *name, int namelen,
3396 u64 ino, unsigned type)
3397{
3398 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3399}
3400static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3401{
3402 return ctx->actor(ctx, ".", 1, ctx->pos,
3403 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3404}
3405static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3406{
3407 return ctx->actor(ctx, "..", 2, ctx->pos,
3408 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3409}
3410static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3411{
3412 if (ctx->pos == 0) {
3413 if (!dir_emit_dot(file, ctx))
3414 return false;
3415 ctx->pos = 1;
3416 }
3417 if (ctx->pos == 1) {
3418 if (!dir_emit_dotdot(file, ctx))
3419 return false;
3420 ctx->pos = 2;
3421 }
3422 return true;
3423}
Al Viro5ded75e2013-05-15 21:02:48 -04003424static inline bool dir_relax(struct inode *inode)
3425{
Al Viro59551022016-01-22 15:40:57 -05003426 inode_unlock(inode);
3427 inode_lock(inode);
Al Viro5ded75e2013-05-15 21:02:48 -04003428 return !IS_DEADDIR(inode);
3429}
Al Viro5f99f4e2013-05-15 20:23:06 -04003430
Al Viroae053272016-05-12 20:36:01 -04003431static inline bool dir_relax_shared(struct inode *inode)
3432{
3433 inode_unlock_shared(inode);
3434 inode_lock_shared(inode);
3435 return !IS_DEADDIR(inode);
3436}
3437
Eric W. Biederman90f85722015-06-29 14:42:03 -05003438extern bool path_noexec(const struct path *path);
Al Viro21fc61c2015-11-17 01:07:57 -05003439extern void inode_nohighmem(struct inode *inode);
Eric W. Biederman90f85722015-06-29 14:42:03 -05003440
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441#endif /* _LINUX_FS_H */