]> git.ipfire.org Git - thirdparty/linux.git/blame - include/linux/fs.h
mm: mmap: merge vma after call_mmap() if possible
[thirdparty/linux.git] / include / linux / fs.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_FS_H
3#define _LINUX_FS_H
4
1da177e4 5#include <linux/linkage.h>
5dd43ce2 6#include <linux/wait_bit.h>
1da177e4
LT
7#include <linux/kdev_t.h>
8#include <linux/dcache.h>
3f8206d4 9#include <linux/path.h>
1da177e4
LT
10#include <linux/stat.h>
11#include <linux/cache.h>
1da177e4 12#include <linux/list.h>
bc3b14cb 13#include <linux/list_lru.h>
4f5e65a1 14#include <linux/llist.h>
1da177e4 15#include <linux/radix-tree.h>
b93b0163 16#include <linux/xarray.h>
6b2dbba8 17#include <linux/rbtree.h>
1da177e4 18#include <linux/init.h>
914e2637 19#include <linux/pid.h>
187f1882 20#include <linux/bug.h>
1b1dcc1b 21#include <linux/mutex.h>
c8c06efa 22#include <linux/rwsem.h>
baabda26 23#include <linux/mm_types.h>
3bd858ab 24#include <linux/capability.h>
6188e10d 25#include <linux/semaphore.h>
c75b1d94 26#include <linux/fcntl.h>
ceb5bdc2 27#include <linux/rculist_bl.h>
07b8ce1e 28#include <linux/atomic.h>
83aeeada 29#include <linux/shrinker.h>
c1aab02d 30#include <linux/migrate_mode.h>
92361636 31#include <linux/uidgid.h>
5accdf82 32#include <linux/lockdep.h>
c2b1ad80 33#include <linux/percpu-rwsem.h>
853b39a7 34#include <linux/workqueue.h>
fceef393 35#include <linux/delayed_call.h>
85787090 36#include <linux/uuid.h>
5660e13d 37#include <linux/errseq.h>
d9a08a9e 38#include <linux/ioprio.h>
bbe7449e 39#include <linux/fs_types.h>
f1fffbd4
RV
40#include <linux/build_bug.h>
41#include <linux/stddef.h>
1da177e4 42
1da177e4 43#include <asm/byteorder.h>
607ca46e 44#include <uapi/linux/fs.h>
1da177e4 45
b83ae6d4 46struct backing_dev_info;
52ebea74 47struct bdi_writeback;
2f8b5444 48struct bio;
a5694255 49struct export_operations;
10c5db28 50struct fiemap_extent_info;
a885c8c4 51struct hd_geometry;
1da177e4 52struct iovec;
92198f7e 53struct kiocb;
57cc7215 54struct kobject;
1da177e4
LT
55struct pipe_inode_info;
56struct poll_table_struct;
57struct kstatfs;
58struct vm_area_struct;
59struct vfsmount;
745ca247 60struct cred;
a509bc1a 61struct swap_info_struct;
55985dd7 62struct seq_file;
7b7a8665 63struct workqueue_struct;
3b93f911 64struct iov_iter;
0b81d077
JK
65struct fscrypt_info;
66struct fscrypt_operations;
5585f2af
EB
67struct fsverity_info;
68struct fsverity_operations;
f3a09c92 69struct fs_context;
d7167b14 70struct fs_parameter_spec;
1da177e4 71
74bf17cf 72extern void __init inode_init(void);
1da177e4 73extern void __init inode_init_early(void);
4248b0da
MG
74extern void __init files_init(void);
75extern void __init files_maxfiles_init(void);
1da177e4 76
dded4f4d 77extern struct files_stat_struct files_stat;
518de9b3 78extern unsigned long get_max_files(void);
9b80a184 79extern unsigned int sysctl_nr_open;
dded4f4d
JE
80extern struct inodes_stat_t inodes_stat;
81extern int leases_enable, lease_break_time;
800179c9
KC
82extern int sysctl_protected_symlinks;
83extern int sysctl_protected_hardlinks;
30aba665
SM
84extern int sysctl_protected_fifos;
85extern int sysctl_protected_regular;
dded4f4d 86
ddef7ed2
CH
87typedef __kernel_rwf_t rwf_t;
88
1da177e4
LT
89struct buffer_head;
90typedef int (get_block_t)(struct inode *inode, sector_t iblock,
91 struct buffer_head *bh_result, int create);
187372a3 92typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
7b7a8665 93 ssize_t bytes, void *private);
1da177e4 94
bbc1096a
DH
95#define MAY_EXEC 0x00000001
96#define MAY_WRITE 0x00000002
97#define MAY_READ 0x00000004
98#define MAY_APPEND 0x00000008
99#define MAY_ACCESS 0x00000010
100#define MAY_OPEN 0x00000020
101#define MAY_CHDIR 0x00000040
102/* called from RCU mode, don't block */
103#define MAY_NOT_BLOCK 0x00000080
104
105/*
106 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
75abe329 107 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
bbc1096a
DH
108 */
109
110/* file is open for reading */
111#define FMODE_READ ((__force fmode_t)0x1)
112/* file is open for writing */
113#define FMODE_WRITE ((__force fmode_t)0x2)
114/* file is seekable */
115#define FMODE_LSEEK ((__force fmode_t)0x4)
116/* file can be accessed using pread */
117#define FMODE_PREAD ((__force fmode_t)0x8)
118/* file can be accessed using pwrite */
119#define FMODE_PWRITE ((__force fmode_t)0x10)
120/* File is opened for execution with sys_execve / sys_uselib */
121#define FMODE_EXEC ((__force fmode_t)0x20)
122/* File is opened with O_NDELAY (only set for block devices) */
123#define FMODE_NDELAY ((__force fmode_t)0x40)
124/* File is opened with O_EXCL (only set for block devices) */
125#define FMODE_EXCL ((__force fmode_t)0x80)
126/* File is opened using open(.., 3, ..) and is writeable only for ioctls
127 (specialy hack for floppy.c) */
128#define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
129/* 32bit hashes as llseek() offset (for directories) */
130#define FMODE_32BITHASH ((__force fmode_t)0x200)
131/* 64bit hashes as llseek() offset (for directories) */
132#define FMODE_64BITHASH ((__force fmode_t)0x400)
133
134/*
135 * Don't update ctime and mtime.
136 *
137 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
138 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
139 */
140#define FMODE_NOCMTIME ((__force fmode_t)0x800)
141
142/* Expect random access pattern */
143#define FMODE_RANDOM ((__force fmode_t)0x1000)
144
145/* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
146#define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
147
148/* File is opened with O_PATH; almost nothing can be done with it */
149#define FMODE_PATH ((__force fmode_t)0x4000)
150
2be7d348
LT
151/* File needs atomic accesses to f_pos */
152#define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
83f936c7
AV
153/* Write access to underlying fs */
154#define FMODE_WRITER ((__force fmode_t)0x10000)
7f7f25e8
AV
155/* Has read method(s) */
156#define FMODE_CAN_READ ((__force fmode_t)0x20000)
157/* Has write method(s) */
158#define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
9c225f26 159
f5d11409 160#define FMODE_OPENED ((__force fmode_t)0x80000)
73a09dd9 161#define FMODE_CREATED ((__force fmode_t)0x100000)
f5d11409 162
10dce8af
KS
163/* File is stream-like */
164#define FMODE_STREAM ((__force fmode_t)0x200000)
165
bbc1096a 166/* File was opened by fanotify and shouldn't generate fanotify events */
75069f2b 167#define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
bbc1096a 168
91f9943e 169/* File is capable of returning -EAGAIN if I/O will block */
a07b2000
AV
170#define FMODE_NOWAIT ((__force fmode_t)0x8000000)
171
172/* File represents mount that needs unmounting */
173#define FMODE_NEED_UNMOUNT ((__force fmode_t)0x10000000)
b745fafa 174
d3b1084d 175/* File does not contribute to nr_files count */
a07b2000 176#define FMODE_NOACCOUNT ((__force fmode_t)0x20000000)
d3b1084d 177
c2a25ec0
JA
178/* File supports async buffered reads */
179#define FMODE_BUF_RASYNC ((__force fmode_t)0x40000000)
180
bbc1096a
DH
181/*
182 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
183 * that indicates that they should check the contents of the iovec are
184 * valid, but not check the memory that the iovec elements
185 * points too.
186 */
187#define CHECK_IOVEC_ONLY -1
188
1da177e4
LT
189/*
190 * Attribute flags. These should be or-ed together to figure out what
191 * has been changed!
192 */
9767d749
MS
193#define ATTR_MODE (1 << 0)
194#define ATTR_UID (1 << 1)
195#define ATTR_GID (1 << 2)
196#define ATTR_SIZE (1 << 3)
197#define ATTR_ATIME (1 << 4)
198#define ATTR_MTIME (1 << 5)
199#define ATTR_CTIME (1 << 6)
200#define ATTR_ATIME_SET (1 << 7)
201#define ATTR_MTIME_SET (1 << 8)
202#define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
9767d749
MS
203#define ATTR_KILL_SUID (1 << 11)
204#define ATTR_KILL_SGID (1 << 12)
205#define ATTR_FILE (1 << 13)
206#define ATTR_KILL_PRIV (1 << 14)
207#define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
208#define ATTR_TIMES_SET (1 << 16)
f2b20f6e 209#define ATTR_TOUCH (1 << 17)
1da177e4 210
787fb6bc
MS
211/*
212 * Whiteout is represented by a char device. The following constants define the
213 * mode and device number to use.
214 */
215#define WHITEOUT_MODE 0
216#define WHITEOUT_DEV 0
217
1da177e4
LT
218/*
219 * This is the Inode Attributes structure, used for notify_change(). It
220 * uses the above definitions as flags, to know which values have changed.
221 * Also, in this manner, a Filesystem can look at only the values it cares
222 * about. Basically, these are the attributes that the VFS layer can
223 * request to change from the FS layer.
224 *
225 * Derek Atkins <warlord@MIT.EDU> 94-10-20
226 */
227struct iattr {
228 unsigned int ia_valid;
229 umode_t ia_mode;
92361636
EB
230 kuid_t ia_uid;
231 kgid_t ia_gid;
1da177e4 232 loff_t ia_size;
95582b00
DD
233 struct timespec64 ia_atime;
234 struct timespec64 ia_mtime;
235 struct timespec64 ia_ctime;
cc4e69de
MS
236
237 /*
25985edc 238 * Not an attribute, but an auxiliary info for filesystems wanting to
cc4e69de
MS
239 * implement an ftruncate() like method. NOTE: filesystem should
240 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
241 */
242 struct file *ia_file;
1da177e4
LT
243};
244
1da177e4
LT
245/*
246 * Includes for diskquotas.
247 */
248#include <linux/quota.h>
249
69c433ed
MS
250/*
251 * Maximum number of layers of fs stack. Needs to be limited to
252 * prevent kernel stack overflow
253 */
254#define FILESYSTEM_MAX_STACK_DEPTH 2
255
994fc28c
ZB
256/**
257 * enum positive_aop_returns - aop return codes with specific semantics
258 *
259 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
260 * completed, that the page is still locked, and
261 * should be considered active. The VM uses this hint
262 * to return the page to the active list -- it won't
263 * be a candidate for writeback again in the near
264 * future. Other callers must be careful to unlock
265 * the page if they get this return. Returned by
266 * writepage();
267 *
268 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
269 * unlocked it and the page might have been truncated.
270 * The caller should back up to acquiring a new page and
271 * trying again. The aop will be taking reasonable
272 * precautions not to livelock. If the caller held a page
273 * reference, it should drop it before retrying. Returned
55144768 274 * by readpage().
994fc28c
ZB
275 *
276 * address_space_operation functions return these large constants to indicate
277 * special semantics to the caller. These are much larger than the bytes in a
278 * page to allow for functions that return the number of bytes operated on in a
279 * given page.
280 */
281
282enum positive_aop_returns {
283 AOP_WRITEPAGE_ACTIVATE = 0x80000,
284 AOP_TRUNCATED_PAGE = 0x80001,
285};
286
c718a975
TH
287#define AOP_FLAG_CONT_EXPAND 0x0001 /* called from cont_expand */
288#define AOP_FLAG_NOFS 0x0002 /* used by filesystem to direct
54566b2c
NP
289 * helper code (eg buffer layer)
290 * to clear GFP_FS from alloc */
afddba49 291
1da177e4
LT
292/*
293 * oh the beauties of C type declarations.
294 */
295struct page;
296struct address_space;
297struct writeback_control;
8151b4c8 298struct readahead_control;
1da177e4 299
c75b1d94
JA
300/*
301 * Write life time hint values.
69448867 302 * Stored in struct inode as u8.
c75b1d94
JA
303 */
304enum rw_hint {
305 WRITE_LIFE_NOT_SET = 0,
306 WRITE_LIFE_NONE = RWH_WRITE_LIFE_NONE,
307 WRITE_LIFE_SHORT = RWH_WRITE_LIFE_SHORT,
308 WRITE_LIFE_MEDIUM = RWH_WRITE_LIFE_MEDIUM,
309 WRITE_LIFE_LONG = RWH_WRITE_LIFE_LONG,
310 WRITE_LIFE_EXTREME = RWH_WRITE_LIFE_EXTREME,
311};
312
e2e40f2c 313#define IOCB_EVENTFD (1 << 0)
2ba48ce5
AV
314#define IOCB_APPEND (1 << 1)
315#define IOCB_DIRECT (1 << 2)
97be7ebe 316#define IOCB_HIPRI (1 << 3)
dde0c2e7
CH
317#define IOCB_DSYNC (1 << 4)
318#define IOCB_SYNC (1 << 5)
70fe2f48 319#define IOCB_WRITE (1 << 6)
b745fafa 320#define IOCB_NOWAIT (1 << 7)
dd3e6d50
JA
321/* iocb->ki_waitq is valid */
322#define IOCB_WAITQ (1 << 8)
41da51bc 323#define IOCB_NOIO (1 << 9)
e2e40f2c
CH
324
325struct kiocb {
326 struct file *ki_filp;
84c4e1f8
LT
327
328 /* The 'ki_filp' pointer is shared in a union for aio */
329 randomized_struct_fields_start
330
e2e40f2c
CH
331 loff_t ki_pos;
332 void (*ki_complete)(struct kiocb *iocb, long ret, long ret2);
333 void *private;
334 int ki_flags;
fc28724d 335 u16 ki_hint;
d9a08a9e 336 u16 ki_ioprio; /* See linux/ioprio.h */
dd3e6d50
JA
337 union {
338 unsigned int ki_cookie; /* for ->iopoll */
339 struct wait_page_queue *ki_waitq; /* for async buffered IO */
340 };
84c4e1f8
LT
341
342 randomized_struct_fields_end
343};
e2e40f2c
CH
344
345static inline bool is_sync_kiocb(struct kiocb *kiocb)
346{
347 return kiocb->ki_complete == NULL;
348}
349
8ab22b9a
HH
350/*
351 * "descriptor" for what we're up to with a read.
352 * This allows us to use the same read code yet
353 * have multiple different users of the data that
354 * we read from a file.
355 *
356 * The simplest case just copies the data to user
357 * mode.
358 */
359typedef struct {
360 size_t written;
361 size_t count;
362 union {
363 char __user *buf;
364 void *data;
365 } arg;
366 int error;
367} read_descriptor_t;
368
369typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
370 unsigned long, unsigned long);
2f718ffc 371
1da177e4
LT
372struct address_space_operations {
373 int (*writepage)(struct page *page, struct writeback_control *wbc);
374 int (*readpage)(struct file *, struct page *);
1da177e4
LT
375
376 /* Write back some dirty pages from this mapping. */
377 int (*writepages)(struct address_space *, struct writeback_control *);
378
4741c9fd 379 /* Set a page dirty. Return true if this dirtied it */
1da177e4
LT
380 int (*set_page_dirty)(struct page *page);
381
74c8164e
JA
382 /*
383 * Reads in the requested pages. Unlike ->readpage(), this is
384 * PURELY used for read-ahead!.
385 */
1da177e4
LT
386 int (*readpages)(struct file *filp, struct address_space *mapping,
387 struct list_head *pages, unsigned nr_pages);
8151b4c8 388 void (*readahead)(struct readahead_control *);
1da177e4 389
afddba49
NP
390 int (*write_begin)(struct file *, struct address_space *mapping,
391 loff_t pos, unsigned len, unsigned flags,
392 struct page **pagep, void **fsdata);
393 int (*write_end)(struct file *, struct address_space *mapping,
394 loff_t pos, unsigned len, unsigned copied,
395 struct page *page, void *fsdata);
396
1da177e4
LT
397 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
398 sector_t (*bmap)(struct address_space *, sector_t);
d47992f8 399 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
27496a8c 400 int (*releasepage) (struct page *, gfp_t);
6072d13c 401 void (*freepage)(struct page *);
c8b8e32d 402 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
b969c4ab 403 /*
ef277c73
TC
404 * migrate the contents of a page to the specified target. If
405 * migrate_mode is MIGRATE_ASYNC, it must not block.
b969c4ab 406 */
2d1db3b1 407 int (*migratepage) (struct address_space *,
a6bc32b8 408 struct page *, struct page *, enum migrate_mode);
bda807d4
MK
409 bool (*isolate_page)(struct page *, isolate_mode_t);
410 void (*putback_page)(struct page *);
e3db7691 411 int (*launder_page) (struct page *);
c186afb4 412 int (*is_partially_uptodate) (struct page *, unsigned long,
8ab22b9a 413 unsigned long);
b4597226 414 void (*is_dirty_writeback) (struct page *, bool *, bool *);
25718736 415 int (*error_remove_page)(struct address_space *, struct page *);
62c230bc
MG
416
417 /* swapfile support */
a509bc1a
MG
418 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
419 sector_t *span);
420 void (*swap_deactivate)(struct file *file);
1da177e4
LT
421};
422
7dcda1c9
JA
423extern const struct address_space_operations empty_aops;
424
afddba49
NP
425/*
426 * pagecache_write_begin/pagecache_write_end must be used by general code
427 * to write into the pagecache.
428 */
429int pagecache_write_begin(struct file *, struct address_space *mapping,
430 loff_t pos, unsigned len, unsigned flags,
431 struct page **pagep, void **fsdata);
432
433int pagecache_write_end(struct file *, struct address_space *mapping,
434 loff_t pos, unsigned len, unsigned copied,
435 struct page *page, void *fsdata);
436
eb797a8e
MW
437/**
438 * struct address_space - Contents of a cacheable, mappable object.
439 * @host: Owner, either the inode or the block_device.
440 * @i_pages: Cached pages.
441 * @gfp_mask: Memory allocation flags to use for allocating pages.
442 * @i_mmap_writable: Number of VM_SHARED mappings.
09d91cda 443 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
eb797a8e
MW
444 * @i_mmap: Tree of private and shared mappings.
445 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
446 * @nrpages: Number of page entries, protected by the i_pages lock.
447 * @nrexceptional: Shadow or DAX entries, protected by the i_pages lock.
448 * @writeback_index: Writeback starts here.
449 * @a_ops: Methods.
450 * @flags: Error bits and flags (AS_*).
451 * @wb_err: The most recent error which has occurred.
452 * @private_lock: For use by the owner of the address_space.
453 * @private_list: For use by the owner of the address_space.
454 * @private_data: For use by the owner of the address_space.
455 */
1da177e4 456struct address_space {
eb797a8e
MW
457 struct inode *host;
458 struct xarray i_pages;
459 gfp_t gfp_mask;
460 atomic_t i_mmap_writable;
09d91cda
SL
461#ifdef CONFIG_READ_ONLY_THP_FOR_FS
462 /* number of thp, only for non-shmem files */
463 atomic_t nr_thps;
464#endif
eb797a8e
MW
465 struct rb_root_cached i_mmap;
466 struct rw_semaphore i_mmap_rwsem;
467 unsigned long nrpages;
f9fe48be 468 unsigned long nrexceptional;
eb797a8e
MW
469 pgoff_t writeback_index;
470 const struct address_space_operations *a_ops;
471 unsigned long flags;
5660e13d 472 errseq_t wb_err;
eb797a8e
MW
473 spinlock_t private_lock;
474 struct list_head private_list;
475 void *private_data;
3859a271 476} __attribute__((aligned(sizeof(long)))) __randomize_layout;
1da177e4
LT
477 /*
478 * On most architectures that alignment is already the case; but
25985edc 479 * must be enforced here for CRIS, to let the least significant bit
1da177e4
LT
480 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
481 */
1da177e4 482
ff9c745b
MW
483/* XArray tags, for tagging dirty and writeback pages in the pagecache. */
484#define PAGECACHE_TAG_DIRTY XA_MARK_0
485#define PAGECACHE_TAG_WRITEBACK XA_MARK_1
486#define PAGECACHE_TAG_TOWRITE XA_MARK_2
487
1da177e4 488/*
ff9c745b 489 * Returns true if any of the pages in the mapping are marked with the tag.
1da177e4 490 */
ff9c745b
MW
491static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
492{
493 return xa_marked(&mapping->i_pages, tag);
494}
1da177e4 495
8b28f621
DB
496static inline void i_mmap_lock_write(struct address_space *mapping)
497{
c8c06efa 498 down_write(&mapping->i_mmap_rwsem);
8b28f621
DB
499}
500
c0d0381a
MK
501static inline int i_mmap_trylock_write(struct address_space *mapping)
502{
503 return down_write_trylock(&mapping->i_mmap_rwsem);
504}
505
8b28f621
DB
506static inline void i_mmap_unlock_write(struct address_space *mapping)
507{
c8c06efa 508 up_write(&mapping->i_mmap_rwsem);
8b28f621
DB
509}
510
3dec0ba0
DB
511static inline void i_mmap_lock_read(struct address_space *mapping)
512{
513 down_read(&mapping->i_mmap_rwsem);
514}
515
516static inline void i_mmap_unlock_read(struct address_space *mapping)
517{
518 up_read(&mapping->i_mmap_rwsem);
519}
520
1da177e4
LT
521/*
522 * Might pages of this file be mapped into userspace?
523 */
524static inline int mapping_mapped(struct address_space *mapping)
525{
f808c13f 526 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
1da177e4
LT
527}
528
529/*
530 * Might pages of this file have been modified in userspace?
531 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
532 * marks vma as VM_SHARED if it is shared, and the file was opened for
533 * writing i.e. vma may be mprotected writable even if now readonly.
4bb5f5d9
DR
534 *
535 * If i_mmap_writable is negative, no new writable mappings are allowed. You
536 * can only deny writable mappings, if none exists right now.
1da177e4
LT
537 */
538static inline int mapping_writably_mapped(struct address_space *mapping)
539{
4bb5f5d9
DR
540 return atomic_read(&mapping->i_mmap_writable) > 0;
541}
542
543static inline int mapping_map_writable(struct address_space *mapping)
544{
545 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
546 0 : -EPERM;
547}
548
549static inline void mapping_unmap_writable(struct address_space *mapping)
550{
551 atomic_dec(&mapping->i_mmap_writable);
552}
553
554static inline int mapping_deny_writable(struct address_space *mapping)
555{
556 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
557 0 : -EBUSY;
558}
559
560static inline void mapping_allow_writable(struct address_space *mapping)
561{
562 atomic_inc(&mapping->i_mmap_writable);
1da177e4
LT
563}
564
565/*
566 * Use sequence counter to get consistent i_size on 32-bit processors.
567 */
568#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
569#include <linux/seqlock.h>
570#define __NEED_I_SIZE_ORDERED
571#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
572#else
573#define i_size_ordered_init(inode) do { } while (0)
574#endif
575
f19d4a8f
AV
576struct posix_acl;
577#define ACL_NOT_CACHED ((void *)(-1))
2a3a2a3f 578#define ACL_DONT_CACHE ((void *)(-3))
f19d4a8f 579
b8a7a3a6
AG
580static inline struct posix_acl *
581uncached_acl_sentinel(struct task_struct *task)
582{
583 return (void *)task + 1;
584}
585
586static inline bool
587is_uncached_acl(struct posix_acl *acl)
588{
589 return (long)acl & 1;
590}
591
3ddcd056
LT
592#define IOP_FASTPERM 0x0001
593#define IOP_LOOKUP 0x0002
594#define IOP_NOFOLLOW 0x0004
d0a5b995 595#define IOP_XATTR 0x0008
76fca90e 596#define IOP_DEFAULT_READLINK 0x0010
3ddcd056 597
9dd813c1
JK
598struct fsnotify_mark_connector;
599
3ddcd056
LT
600/*
601 * Keep mostly read-only and often accessed (especially for
602 * the RCU path lookup and 'stat' data) fields at the beginning
603 * of the 'struct inode'
604 */
1da177e4 605struct inode {
44a7d7a8 606 umode_t i_mode;
3ddcd056 607 unsigned short i_opflags;
92361636
EB
608 kuid_t i_uid;
609 kgid_t i_gid;
3ddcd056
LT
610 unsigned int i_flags;
611
612#ifdef CONFIG_FS_POSIX_ACL
613 struct posix_acl *i_acl;
614 struct posix_acl *i_default_acl;
615#endif
616
44a7d7a8
NP
617 const struct inode_operations *i_op;
618 struct super_block *i_sb;
3ddcd056 619 struct address_space *i_mapping;
44a7d7a8 620
13e12d14
LT
621#ifdef CONFIG_SECURITY
622 void *i_security;
623#endif
44a7d7a8 624
3ddcd056
LT
625 /* Stat data, not accessed from path walking */
626 unsigned long i_ino;
a78ef704
MS
627 /*
628 * Filesystems may only read i_nlink directly. They shall use the
629 * following functions for modification:
630 *
631 * (set|clear|inc|drop)_nlink
632 * inode_(inc|dec)_link_count
633 */
634 union {
635 const unsigned int i_nlink;
636 unsigned int __i_nlink;
637 };
3ddcd056 638 dev_t i_rdev;
2f9d3df8 639 loff_t i_size;
95582b00
DD
640 struct timespec64 i_atime;
641 struct timespec64 i_mtime;
642 struct timespec64 i_ctime;
6cdbb0ef
TT
643 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
644 unsigned short i_bytes;
69448867
AG
645 u8 i_blkbits;
646 u8 i_write_hint;
3ddcd056
LT
647 blkcnt_t i_blocks;
648
649#ifdef __NEED_I_SIZE_ORDERED
650 seqcount_t i_size_seqcount;
651#endif
652
653 /* Misc */
654 unsigned long i_state;
9902af79 655 struct rw_semaphore i_rwsem;
13e12d14 656
44a7d7a8 657 unsigned long dirtied_when; /* jiffies of first dirtying */
a2f48706 658 unsigned long dirtied_time_when;
44a7d7a8 659
1da177e4 660 struct hlist_node i_hash;
c7f54084 661 struct list_head i_io_list; /* backing dev IO list */
52ebea74
TH
662#ifdef CONFIG_CGROUP_WRITEBACK
663 struct bdi_writeback *i_wb; /* the associated cgroup wb */
2a814908
TH
664
665 /* foreign inode detection, see wbc_detach_inode() */
666 int i_wb_frn_winner;
667 u16 i_wb_frn_avg_time;
668 u16 i_wb_frn_history;
52ebea74 669#endif
7ccf19a8 670 struct list_head i_lru; /* inode LRU list */
1da177e4 671 struct list_head i_sb_list;
6c60d2b5 672 struct list_head i_wb_list; /* backing dev writeback list */
fa0d7e3d 673 union {
b3d9b7a3 674 struct hlist_head i_dentry;
fa0d7e3d
NP
675 struct rcu_head i_rcu;
676 };
f02a9ad1 677 atomic64_t i_version;
8019ad13 678 atomic64_t i_sequence; /* see futex */
2f9d3df8 679 atomic_t i_count;
bd5fe6c5 680 atomic_t i_dio_count;
6cdbb0ef 681 atomic_t i_writecount;
387e3746 682#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
d984ea60
MZ
683 atomic_t i_readcount; /* struct files open RO */
684#endif
fdb0da89
AV
685 union {
686 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
687 void (*free_inode)(struct inode *);
688 };
4a075e39 689 struct file_lock_context *i_flctx;
1da177e4 690 struct address_space i_data;
1da177e4 691 struct list_head i_devices;
4c154168
TT
692 union {
693 struct pipe_inode_info *i_pipe;
eaf796e7 694 struct block_device *i_bdev;
577c4eb0 695 struct cdev *i_cdev;
61ba64fc 696 char *i_link;
84e710da 697 unsigned i_dir_seq;
4c154168 698 };
1da177e4
LT
699
700 __u32 i_generation;
701
3be25f49
EP
702#ifdef CONFIG_FSNOTIFY
703 __u32 i_fsnotify_mask; /* all events this inode cares about */
08991e83 704 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
0eeca283
RL
705#endif
706
643fa961 707#ifdef CONFIG_FS_ENCRYPTION
0b81d077
JK
708 struct fscrypt_info *i_crypt_info;
709#endif
710
5585f2af
EB
711#ifdef CONFIG_FS_VERITY
712 struct fsverity_info *i_verity_info;
713#endif
714
8e18e294 715 void *i_private; /* fs or device private pointer */
3859a271 716} __randomize_layout;
1da177e4 717
50e17c00
DD
718struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);
719
93407472
FF
720static inline unsigned int i_blocksize(const struct inode *node)
721{
722 return (1 << node->i_blkbits);
723}
724
1d3382cb
AV
725static inline int inode_unhashed(struct inode *inode)
726{
727 return hlist_unhashed(&inode->i_hash);
728}
729
5bef9151
AV
730/*
731 * __mark_inode_dirty expects inodes to be hashed. Since we don't
732 * want special inodes in the fileset inode space, we make them
733 * appear hashed, but do not put on any lists. hlist_del()
734 * will work fine and require no locking.
735 */
736static inline void inode_fake_hash(struct inode *inode)
737{
738 hlist_add_fake(&inode->i_hash);
739}
740
f2eace23
IM
741/*
742 * inode->i_mutex nesting subclasses for the lock validator:
743 *
744 * 0: the object of the current VFS operation
745 * 1: parent
746 * 2: child/target
40bd22c9
BF
747 * 3: xattr
748 * 4: second non-directory
d1b72cc6
MS
749 * 5: second parent (when locking independent directories in rename)
750 *
751 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
40bd22c9 752 * non-directories at once.
f2eace23
IM
753 *
754 * The locking order between these classes is
d1b72cc6 755 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
f2eace23
IM
756 */
757enum inode_i_mutex_lock_class
758{
759 I_MUTEX_NORMAL,
760 I_MUTEX_PARENT,
761 I_MUTEX_CHILD,
4df46240 762 I_MUTEX_XATTR,
d1b72cc6
MS
763 I_MUTEX_NONDIR2,
764 I_MUTEX_PARENT2,
f2eace23
IM
765};
766
5955102c
AV
767static inline void inode_lock(struct inode *inode)
768{
9902af79 769 down_write(&inode->i_rwsem);
5955102c
AV
770}
771
772static inline void inode_unlock(struct inode *inode)
773{
9902af79
AV
774 up_write(&inode->i_rwsem);
775}
776
777static inline void inode_lock_shared(struct inode *inode)
778{
779 down_read(&inode->i_rwsem);
780}
781
782static inline void inode_unlock_shared(struct inode *inode)
783{
784 up_read(&inode->i_rwsem);
5955102c
AV
785}
786
787static inline int inode_trylock(struct inode *inode)
788{
9902af79
AV
789 return down_write_trylock(&inode->i_rwsem);
790}
791
792static inline int inode_trylock_shared(struct inode *inode)
793{
794 return down_read_trylock(&inode->i_rwsem);
5955102c
AV
795}
796
797static inline int inode_is_locked(struct inode *inode)
798{
9902af79 799 return rwsem_is_locked(&inode->i_rwsem);
5955102c
AV
800}
801
802static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
803{
9902af79 804 down_write_nested(&inode->i_rwsem, subclass);
5955102c
AV
805}
806
01c2e13d
DW
807static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
808{
809 down_read_nested(&inode->i_rwsem, subclass);
810}
811
375e289e
BF
812void lock_two_nondirectories(struct inode *, struct inode*);
813void unlock_two_nondirectories(struct inode *, struct inode*);
814
1da177e4
LT
815/*
816 * NOTE: in a 32bit arch with a preemptable kernel and
817 * an UP compile the i_size_read/write must be atomic
818 * with respect to the local cpu (unlike with preempt disabled),
819 * but they don't need to be atomic with respect to other cpus like in
820 * true SMP (so they need either to either locally disable irq around
821 * the read or for example on x86 they can be still implemented as a
822 * cmpxchg8b without the need of the lock prefix). For SMP compiles
823 * and 64bit archs it makes no difference if preempt is enabled or not.
824 */
48ed214d 825static inline loff_t i_size_read(const struct inode *inode)
1da177e4
LT
826{
827#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
828 loff_t i_size;
829 unsigned int seq;
830
831 do {
832 seq = read_seqcount_begin(&inode->i_size_seqcount);
833 i_size = inode->i_size;
834 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
835 return i_size;
2496396f 836#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
1da177e4
LT
837 loff_t i_size;
838
839 preempt_disable();
840 i_size = inode->i_size;
841 preempt_enable();
842 return i_size;
843#else
844 return inode->i_size;
845#endif
846}
847
7762f5a0
MS
848/*
849 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
850 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
851 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
852 */
1da177e4
LT
853static inline void i_size_write(struct inode *inode, loff_t i_size)
854{
855#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
74e3d1e1 856 preempt_disable();
1da177e4
LT
857 write_seqcount_begin(&inode->i_size_seqcount);
858 inode->i_size = i_size;
859 write_seqcount_end(&inode->i_size_seqcount);
74e3d1e1 860 preempt_enable();
2496396f 861#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
1da177e4
LT
862 preempt_disable();
863 inode->i_size = i_size;
864 preempt_enable();
865#else
866 inode->i_size = i_size;
867#endif
868}
869
48ed214d 870static inline unsigned iminor(const struct inode *inode)
1da177e4
LT
871{
872 return MINOR(inode->i_rdev);
873}
874
48ed214d 875static inline unsigned imajor(const struct inode *inode)
1da177e4
LT
876{
877 return MAJOR(inode->i_rdev);
878}
879
1da177e4
LT
880struct fown_struct {
881 rwlock_t lock; /* protects pid, uid, euid fields */
609d7fa9
EB
882 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
883 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
92361636 884 kuid_t uid, euid; /* uid/euid of process setting the owner */
1da177e4
LT
885 int signum; /* posix.1b rt signal to be delivered on IO */
886};
887
888/*
889 * Track a single file's readahead state
890 */
891struct file_ra_state {
937085aa
FW
892 pgoff_t start; /* where readahead started */
893 unsigned int size; /* # of readahead pages */
894 unsigned int async_size; /* do asynchronous readahead when
f9acc8c7 895 there are only # of pages ahead */
5ce1110b 896
937085aa 897 unsigned int ra_pages; /* Maximum readahead window */
1ebf26a9 898 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
f4e6b498 899 loff_t prev_pos; /* Cache last read() position */
1da177e4 900};
1da177e4 901
5ce1110b
FW
902/*
903 * Check if @index falls in the readahead windows.
904 */
905static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
906{
f9acc8c7
FW
907 return (index >= ra->start &&
908 index < ra->start + ra->size);
5ce1110b
FW
909}
910
1da177e4 911struct file {
2f512016 912 union {
4f5e65a1 913 struct llist_node fu_llist;
2f512016
ED
914 struct rcu_head fu_rcuhead;
915 } f_u;
0f7fc9e4 916 struct path f_path;
dd37978c 917 struct inode *f_inode; /* cached value */
99ac48f5 918 const struct file_operations *f_op;
ef3d0fd2
AK
919
920 /*
9c225f26 921 * Protects f_ep_links, f_flags.
ef3d0fd2
AK
922 * Must not be taken from IRQ context.
923 */
924 spinlock_t f_lock;
c75b1d94 925 enum rw_hint f_write_hint;
516e0cc5 926 atomic_long_t f_count;
1da177e4 927 unsigned int f_flags;
aeb5d727 928 fmode_t f_mode;
9c225f26 929 struct mutex f_pos_lock;
1da177e4
LT
930 loff_t f_pos;
931 struct fown_struct f_owner;
d76b0d9b 932 const struct cred *f_cred;
1da177e4
LT
933 struct file_ra_state f_ra;
934
2b47c361 935 u64 f_version;
50462062 936#ifdef CONFIG_SECURITY
1da177e4 937 void *f_security;
50462062 938#endif
1da177e4
LT
939 /* needed for tty driver, and maybe others */
940 void *private_data;
941
942#ifdef CONFIG_EPOLL
943 /* Used by fs/eventpoll.c to link all the hooks to this file */
944 struct list_head f_ep_links;
28d82dc1 945 struct list_head f_tfile_llink;
1da177e4
LT
946#endif /* #ifdef CONFIG_EPOLL */
947 struct address_space *f_mapping;
5660e13d 948 errseq_t f_wb_err;
735e4ae5 949 errseq_t f_sb_err; /* for syncfs */
3859a271
KC
950} __randomize_layout
951 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
1da177e4 952
990d6c2d
AK
953struct file_handle {
954 __u32 handle_bytes;
955 int handle_type;
956 /* file identifier */
9d82973e 957 unsigned char f_handle[];
990d6c2d
AK
958};
959
cb0942b8
AV
960static inline struct file *get_file(struct file *f)
961{
962 atomic_long_inc(&f->f_count);
963 return f;
964}
091141a4
JA
965#define get_file_rcu_many(x, cnt) \
966 atomic_long_add_unless(&(x)->f_count, (cnt), 0)
967#define get_file_rcu(x) get_file_rcu_many((x), 1)
516e0cc5 968#define file_count(x) atomic_long_read(&(x)->f_count)
1da177e4
LT
969
970#define MAX_NON_LFS ((1UL<<31) - 1)
971
972/* Page cache limit. The filesystems should put that into their s_maxbytes
973 limits, otherwise bad things can happen in VM. */
974#if BITS_PER_LONG==32
0cc3b0ec 975#define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
1da177e4 976#elif BITS_PER_LONG==64
0cc3b0ec 977#define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
1da177e4
LT
978#endif
979
980#define FL_POSIX 1
981#define FL_FLOCK 2
617588d5 982#define FL_DELEG 4 /* NFSv4 delegation */
1da177e4 983#define FL_ACCESS 8 /* not trying to lock, just looking */
f475ae95 984#define FL_EXISTS 16 /* when unlocking, test for existence */
1da177e4 985#define FL_LEASE 32 /* lease held on this file */
75e1fcc0 986#define FL_CLOSE 64 /* unlock on close */
1da177e4 987#define FL_SLEEP 128 /* A blocking lock */
778fc546
BF
988#define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
989#define FL_UNLOCK_PENDING 512 /* Lease is being broken */
cff2fce5 990#define FL_OFDLCK 1024 /* lock is "owned" by struct file */
11afe9f7 991#define FL_LAYOUT 2048 /* outstanding pNFS layout */
1da177e4 992
50f2112c
BC
993#define FL_CLOSE_POSIX (FL_POSIX | FL_CLOSE)
994
bde74e4b
MS
995/*
996 * Special return value from posix_lock_file() and vfs_lock_file() for
997 * asynchronous locking.
998 */
999#define FILE_LOCK_DEFERRED 1
1000
7ca76311 1001/* legacy typedef, should eventually be removed */
17fa388d 1002typedef void *fl_owner_t;
1da177e4 1003
a7231a97
JL
1004struct file_lock;
1005
1da177e4 1006struct file_lock_operations {
1da177e4
LT
1007 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
1008 void (*fl_release_private)(struct file_lock *);
1009};
1010
1011struct lock_manager_operations {
cae80b30
JL
1012 fl_owner_t (*lm_get_owner)(fl_owner_t);
1013 void (*lm_put_owner)(fl_owner_t);
8fb47a4f 1014 void (*lm_notify)(struct file_lock *); /* unblock callback */
d0449b90 1015 int (*lm_grant)(struct file_lock *, int);
4d01b7f5 1016 bool (*lm_break)(struct file_lock *);
7448cc37 1017 int (*lm_change)(struct file_lock *, int, struct list_head *);
1c7dd2ff 1018 void (*lm_setup)(struct file_lock *, void **);
28df3d15 1019 bool (*lm_breaker_owns_lease)(struct file_lock *);
1da177e4
LT
1020};
1021
af558e33
BF
1022struct lock_manager {
1023 struct list_head list;
c87fb4a3
BF
1024 /*
1025 * NFSv4 and up also want opens blocked during the grace period;
1026 * NLM doesn't care:
1027 */
1028 bool block_opens;
af558e33
BF
1029};
1030
5ccb0066
SK
1031struct net;
1032void locks_start_grace(struct net *, struct lock_manager *);
af558e33 1033void locks_end_grace(struct lock_manager *);
003278e4
CL
1034bool locks_in_grace(struct net *);
1035bool opens_in_grace(struct net *);
af558e33 1036
1da177e4
LT
1037/* that will die - we need it for nfs_lock_info */
1038#include <linux/nfs_fs_i.h>
1039
1cb36012
JL
1040/*
1041 * struct file_lock represents a generic "file lock". It's used to represent
1042 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
1043 * note that the same struct is used to represent both a request for a lock and
1044 * the lock itself, but the same object is never used for both.
1045 *
1046 * FIXME: should we create a separate "struct lock_request" to help distinguish
1047 * these two uses?
1048 *
8116bf4c 1049 * The varous i_flctx lists are ordered by:
1cb36012 1050 *
8116bf4c
JL
1051 * 1) lock owner
1052 * 2) lock range start
1053 * 3) lock range end
1cb36012
JL
1054 *
1055 * Obviously, the last two criteria only matter for POSIX locks.
1056 */
1da177e4 1057struct file_lock {
ada5c1da 1058 struct file_lock *fl_blocker; /* The lock, that is blocking us */
6dee60f6 1059 struct list_head fl_list; /* link into file_lock_context */
139ca04e 1060 struct hlist_node fl_link; /* node in global lists */
ada5c1da
N
1061 struct list_head fl_blocked_requests; /* list of requests with
1062 * ->fl_blocker pointing here
1063 */
1064 struct list_head fl_blocked_member; /* node in
1065 * ->fl_blocker->fl_blocked_requests
1066 */
1da177e4 1067 fl_owner_t fl_owner;
710b7216 1068 unsigned int fl_flags;
afc1246f 1069 unsigned char fl_type;
1da177e4 1070 unsigned int fl_pid;
7012b02a 1071 int fl_link_cpu; /* what cpu's list is this on? */
1da177e4
LT
1072 wait_queue_head_t fl_wait;
1073 struct file *fl_file;
1da177e4
LT
1074 loff_t fl_start;
1075 loff_t fl_end;
1076
1077 struct fasync_struct * fl_fasync; /* for lease break notifications */
778fc546
BF
1078 /* for lease breaks: */
1079 unsigned long fl_break_time;
1080 unsigned long fl_downgrade_time;
1da177e4 1081
6aed6285 1082 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
7b021967 1083 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
1da177e4
LT
1084 union {
1085 struct nfs_lock_info nfs_fl;
8d0a8a9d 1086 struct nfs4_lock_info nfs4_fl;
e8d6c554
DH
1087 struct {
1088 struct list_head link; /* link in AFS vnode's pending_locks list */
1089 int state; /* state of grant or error if -ve */
d4696601 1090 unsigned int debug_id;
e8d6c554 1091 } afs;
1da177e4 1092 } fl_u;
3859a271 1093} __randomize_layout;
1da177e4 1094
4a075e39 1095struct file_lock_context {
6109c850 1096 spinlock_t flc_lock;
4a075e39 1097 struct list_head flc_flock;
bd61e0a9 1098 struct list_head flc_posix;
8634b51f 1099 struct list_head flc_lease;
4a075e39
JL
1100};
1101
1da177e4
LT
1102/* The following constant reflects the upper bound of the file/locking space */
1103#ifndef OFFSET_MAX
1104#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
1105#define OFFSET_MAX INT_LIMIT(loff_t)
1106#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
1107#endif
1108
bfcd17a6
TP
1109extern void send_sigio(struct fown_struct *fown, int fd, int band);
1110
de2a4a50 1111#define locks_inode(f) file_inode(f)
c568d683 1112
bfcd17a6 1113#ifdef CONFIG_FILE_LOCKING
a75d30c7 1114extern int fcntl_getlk(struct file *, unsigned int, struct flock *);
c293621b 1115extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
a75d30c7 1116 struct flock *);
1da177e4
LT
1117
1118#if BITS_PER_LONG == 32
a75d30c7 1119extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 *);
c293621b 1120extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
a75d30c7 1121 struct flock64 *);
1da177e4
LT
1122#endif
1123
1da177e4
LT
1124extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
1125extern int fcntl_getlease(struct file *filp);
1126
1127/* fs/locks.c */
f27a0fe0 1128void locks_free_lock_context(struct inode *inode);
05fa3135 1129void locks_free_lock(struct file_lock *fl);
1da177e4 1130extern void locks_init_lock(struct file_lock *);
c5b1f0d9 1131extern struct file_lock * locks_alloc_lock(void);
1da177e4 1132extern void locks_copy_lock(struct file_lock *, struct file_lock *);
3fe0fff1 1133extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1da177e4 1134extern void locks_remove_posix(struct file *, fl_owner_t);
78ed8a13 1135extern void locks_remove_file(struct file *);
a9e61e25 1136extern void locks_release_private(struct file_lock *);
6d34ac19 1137extern void posix_test_lock(struct file *, struct file_lock *);
150b3934 1138extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
cb03f94f 1139extern int locks_delete_block(struct file_lock *);
3ee17abd 1140extern int vfs_test_lock(struct file *, struct file_lock *);
150b3934 1141extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
9b9d2ab4 1142extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
e55c34a6 1143extern int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl);
df4e8d2c 1144extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
95582b00 1145extern void lease_get_mtime(struct inode *, struct timespec64 *time);
e6f5c789
JL
1146extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1147extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
7448cc37 1148extern int lease_modify(struct file_lock *, int, struct list_head *);
18f6622e
JL
1149
1150struct notifier_block;
1151extern int lease_register_notifier(struct notifier_block *);
1152extern void lease_unregister_notifier(struct notifier_block *);
1153
6c8c9031
AV
1154struct files_struct;
1155extern void show_fd_locks(struct seq_file *f,
1156 struct file *filp, struct files_struct *files);
bfcd17a6 1157#else /* !CONFIG_FILE_LOCKING */
c1e62b8f
JL
1158static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1159 struct flock __user *user)
c2aca5e5
SW
1160{
1161 return -EINVAL;
1162}
1163
1164static inline int fcntl_setlk(unsigned int fd, struct file *file,
1165 unsigned int cmd, struct flock __user *user)
1166{
1167 return -EACCES;
1168}
1169
bfcd17a6 1170#if BITS_PER_LONG == 32
c1e62b8f
JL
1171static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1172 struct flock64 __user *user)
c2aca5e5
SW
1173{
1174 return -EINVAL;
1175}
1176
1177static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1178 unsigned int cmd, struct flock64 __user *user)
1179{
1180 return -EACCES;
1181}
bfcd17a6 1182#endif
c2aca5e5
SW
1183static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1184{
1b2b32dc 1185 return -EINVAL;
c2aca5e5
SW
1186}
1187
1188static inline int fcntl_getlease(struct file *filp)
1189{
1b2b32dc 1190 return F_UNLCK;
c2aca5e5
SW
1191}
1192
4a075e39 1193static inline void
f27a0fe0 1194locks_free_lock_context(struct inode *inode)
4a075e39
JL
1195{
1196}
1197
c2aca5e5
SW
1198static inline void locks_init_lock(struct file_lock *fl)
1199{
1200 return;
1201}
1202
3fe0fff1 1203static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
c2aca5e5
SW
1204{
1205 return;
1206}
1207
1208static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1209{
1210 return;
1211}
1212
1213static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1214{
1215 return;
1216}
1217
78ed8a13 1218static inline void locks_remove_file(struct file *filp)
c2aca5e5
SW
1219{
1220 return;
1221}
1222
1223static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1224{
1225 return;
1226}
1227
1228static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1229 struct file_lock *conflock)
1230{
1231 return -ENOLCK;
1232}
1233
cb03f94f 1234static inline int locks_delete_block(struct file_lock *waiter)
c2aca5e5
SW
1235{
1236 return -ENOENT;
1237}
1238
1239static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1240{
1241 return 0;
1242}
1243
1244static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1245 struct file_lock *fl, struct file_lock *conf)
1246{
1247 return -ENOLCK;
1248}
1249
1250static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1251{
1252 return 0;
1253}
1254
e55c34a6
BC
1255static inline int locks_lock_inode_wait(struct inode *inode, struct file_lock *fl)
1256{
1257 return -ENOLCK;
1258}
1259
df4e8d2c 1260static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
c2aca5e5
SW
1261{
1262 return 0;
1263}
1264
95582b00
DD
1265static inline void lease_get_mtime(struct inode *inode,
1266 struct timespec64 *time)
c2aca5e5
SW
1267{
1268 return;
1269}
1270
1271static inline int generic_setlease(struct file *filp, long arg,
e6f5c789 1272 struct file_lock **flp, void **priv)
c2aca5e5
SW
1273{
1274 return -EINVAL;
1275}
1276
1277static inline int vfs_setlease(struct file *filp, long arg,
e6f5c789 1278 struct file_lock **lease, void **priv)
c2aca5e5
SW
1279{
1280 return -EINVAL;
1281}
1282
7448cc37 1283static inline int lease_modify(struct file_lock *fl, int arg,
c45198ed 1284 struct list_head *dispose)
c2aca5e5
SW
1285{
1286 return -EINVAL;
1287}
6c8c9031
AV
1288
1289struct files_struct;
1290static inline void show_fd_locks(struct seq_file *f,
1291 struct file *filp, struct files_struct *files) {}
bfcd17a6
TP
1292#endif /* !CONFIG_FILE_LOCKING */
1293
ee296d7c
JL
1294static inline struct inode *file_inode(const struct file *f)
1295{
1296 return f->f_inode;
1297}
1298
d101a125
MS
1299static inline struct dentry *file_dentry(const struct file *file)
1300{
fb16043b 1301 return d_real(file->f_path.dentry, file_inode(file));
d101a125
MS
1302}
1303
e55c34a6
BC
1304static inline int locks_lock_file_wait(struct file *filp, struct file_lock *fl)
1305{
c568d683 1306 return locks_lock_inode_wait(locks_inode(filp), fl);
e55c34a6
BC
1307}
1308
1da177e4 1309struct fasync_struct {
7a107c0f 1310 rwlock_t fa_lock;
989a2979
ED
1311 int magic;
1312 int fa_fd;
1313 struct fasync_struct *fa_next; /* singly linked list */
1314 struct file *fa_file;
1315 struct rcu_head fa_rcu;
1da177e4
LT
1316};
1317
1318#define FASYNC_MAGIC 0x4601
1319
1320/* SMP safe fasync helpers: */
1321extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
f7347ce4
LT
1322extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1323extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1324extern struct fasync_struct *fasync_alloc(void);
1325extern void fasync_free(struct fasync_struct *);
1326
1da177e4
LT
1327/* can be called from interrupts */
1328extern void kill_fasync(struct fasync_struct **, int, int);
1da177e4 1329
e0b93edd 1330extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
393cc3f5 1331extern int f_setown(struct file *filp, unsigned long arg, int force);
1da177e4 1332extern void f_delown(struct file *filp);
609d7fa9 1333extern pid_t f_getown(struct file *filp);
1da177e4
LT
1334extern int send_sigurg(struct fown_struct *fown);
1335
e462ec50
DH
1336/*
1337 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1338 * represented in both.
1339 */
1340#define SB_RDONLY 1 /* Mount read-only */
1341#define SB_NOSUID 2 /* Ignore suid and sgid bits */
1342#define SB_NODEV 4 /* Disallow access to device special files */
1343#define SB_NOEXEC 8 /* Disallow program execution */
1344#define SB_SYNCHRONOUS 16 /* Writes are synced at once */
1345#define SB_MANDLOCK 64 /* Allow mandatory locks on an FS */
1346#define SB_DIRSYNC 128 /* Directory modifications are synchronous */
1347#define SB_NOATIME 1024 /* Do not update access times. */
1348#define SB_NODIRATIME 2048 /* Do not update directory access times */
1349#define SB_SILENT 32768
1350#define SB_POSIXACL (1<<16) /* VFS does not apply the umask */
457e7a13 1351#define SB_INLINECRYPT (1<<17) /* Use blk-crypto for encrypted files */
e462ec50
DH
1352#define SB_KERNMOUNT (1<<22) /* this is a kern_mount call */
1353#define SB_I_VERSION (1<<23) /* Update inode I_version field */
1354#define SB_LAZYTIME (1<<25) /* Update the on-disk [acm]times lazily */
1355
1356/* These sb flags are internal to the kernel */
1357#define SB_SUBMOUNT (1<<26)
8d0347f6 1358#define SB_FORCE (1<<27)
e462ec50
DH
1359#define SB_NOSEC (1<<28)
1360#define SB_BORN (1<<29)
1361#define SB_ACTIVE (1<<30)
1362#define SB_NOUSER (1<<31)
1363
1da177e4
LT
1364/*
1365 * Umount options
1366 */
1367
1368#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1369#define MNT_DETACH 0x00000002 /* Just detach from the tree */
1370#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
db1f05bb
MS
1371#define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1372#define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1da177e4 1373
46b15caa
TH
1374/* sb->s_iflags */
1375#define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
90f8572b 1376#define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
a2982cc9 1377#define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
95dd7758 1378#define SB_I_MULTIROOT 0x00000008 /* Multiple roots to the dentry tree */
1da177e4 1379
8654df4e
EB
1380/* sb->s_iflags to limit user namespace mounts */
1381#define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
57b56ac6
MZ
1382#define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1383#define SB_I_UNTRUSTED_MOUNTER 0x00000040
1da177e4 1384
32b1924b
KK
1385#define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */
1386
5accdf82
JK
1387/* Possible states of 'frozen' field */
1388enum {
1389 SB_UNFROZEN = 0, /* FS is unfrozen */
1390 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
5accdf82
JK
1391 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1392 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1393 * internal threads if needed) */
1394 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1395};
1396
1397#define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1398
1399struct sb_writers {
8129ed29
ON
1400 int frozen; /* Is sb frozen? */
1401 wait_queue_head_t wait_unfrozen; /* for get_super_thawed() */
1402 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
5accdf82
JK
1403};
1404
1da177e4
LT
1405struct super_block {
1406 struct list_head s_list; /* Keep this first */
1407 dev_t s_dev; /* search index; _not_ kdev_t */
270ba5f7
RK
1408 unsigned char s_blocksize_bits;
1409 unsigned long s_blocksize;
42cb56ae 1410 loff_t s_maxbytes; /* Max file size */
1da177e4 1411 struct file_system_type *s_type;
ee9b6d61 1412 const struct super_operations *s_op;
61e225dc 1413 const struct dquot_operations *dq_op;
0d54b217 1414 const struct quotactl_ops *s_qcop;
39655164 1415 const struct export_operations *s_export_op;
1da177e4 1416 unsigned long s_flags;
46b15caa 1417 unsigned long s_iflags; /* internal SB_I_* flags */
1da177e4
LT
1418 unsigned long s_magic;
1419 struct dentry *s_root;
1420 struct rw_semaphore s_umount;
1da177e4 1421 int s_count;
1da177e4 1422 atomic_t s_active;
50462062 1423#ifdef CONFIG_SECURITY
1da177e4 1424 void *s_security;
50462062 1425#endif
bb435453 1426 const struct xattr_handler **s_xattr;
643fa961 1427#ifdef CONFIG_FS_ENCRYPTION
0b81d077 1428 const struct fscrypt_operations *s_cop;
22d94f49 1429 struct key *s_master_keys; /* master crypto keys in use */
5585f2af
EB
1430#endif
1431#ifdef CONFIG_FS_VERITY
1432 const struct fsverity_operations *s_vop;
bbbc3fb6 1433#endif
f1ee6162 1434 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
39f7c4db 1435 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1da177e4 1436 struct block_device *s_bdev;
32a88aa1 1437 struct backing_dev_info *s_bdi;
acaebfd8 1438 struct mtd_info *s_mtd;
a5166169 1439 struct hlist_node s_instances;
2c5f648a 1440 unsigned int s_quota_types; /* Bitmask of supported quota types */
1da177e4
LT
1441 struct quota_info s_dquot; /* Diskquota specific options */
1442
5accdf82 1443 struct sb_writers s_writers;
1da177e4 1444
99c228a9
AG
1445 /*
1446 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1447 * s_fsnotify_marks together for cache efficiency. They are frequently
1448 * accessed and rarely modified.
1449 */
1450 void *s_fs_info; /* Filesystem private info */
1451
1452 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1453 u32 s_time_gran;
188d20bc
DD
1454 /* Time limits for c/m/atime in seconds */
1455 time64_t s_time_min;
1456 time64_t s_time_max;
99c228a9
AG
1457#ifdef CONFIG_FSNOTIFY
1458 __u32 s_fsnotify_mask;
1459 struct fsnotify_mark_connector __rcu *s_fsnotify_marks;
1460#endif
1461
85787090
CH
1462 char s_id[32]; /* Informational name */
1463 uuid_t s_uuid; /* UUID */
1da177e4 1464
8de52778 1465 unsigned int s_max_links;
30c40d2c 1466 fmode_t s_mode;
1da177e4
LT
1467
1468 /*
1469 * The next field is for VFS *only*. No filesystems have any business
1470 * even looking at it. You had been warned.
1471 */
a11f3a05 1472 struct mutex s_vfs_rename_mutex; /* Kludge */
1da177e4 1473
79c0b2df
MS
1474 /*
1475 * Filesystem subtype. If non-empty the filesystem type field
1476 * in /proc/mounts will be "type.subtype"
1477 */
a0c9a8b8 1478 const char *s_subtype;
b3b304a2 1479
c8aebb0c 1480 const struct dentry_operations *s_d_op; /* default d_op for dentries */
9fdfdcf1
DM
1481
1482 /*
1483 * Saved pool identifier for cleancache (-1 means none)
1484 */
1485 int cleancache_poolid;
b0d40c92
DC
1486
1487 struct shrinker s_shrink; /* per-sb shrinker handle */
4ed5e82f 1488
7ada4db8
MS
1489 /* Number of inodes with nlink == 0 but still referenced */
1490 atomic_long_t s_remove_count;
1491
721fb6fb
JK
1492 /* Pending fsnotify inode refs */
1493 atomic_long_t s_fsnotify_inode_refs;
1494
4ed5e82f
MS
1495 /* Being remounted read-only */
1496 int s_readonly_remount;
7b7a8665 1497
735e4ae5
JL
1498 /* per-sb errseq_t for reporting writeback errors via syncfs */
1499 errseq_t s_wb_err;
1500
7b7a8665
CH
1501 /* AIO completions deferred from interrupt context */
1502 struct workqueue_struct *s_dio_done_wq;
215752fc 1503 struct hlist_head s_pins;
f6041567 1504
6e4eab57
EB
1505 /*
1506 * Owning user namespace and default context in which to
1507 * interpret filesystem uids, gids, quotas, device nodes,
1508 * xattrs and security labels.
1509 */
1510 struct user_namespace *s_user_ns;
1511
f6041567 1512 /*
7d10f70f
WL
1513 * The list_lru structure is essentially just a pointer to a table
1514 * of per-node lru lists, each of which has its own spinlock.
1515 * There is no need to put them into separate cachelines.
f6041567 1516 */
7d10f70f
WL
1517 struct list_lru s_dentry_lru;
1518 struct list_lru s_inode_lru;
e2fec7c3 1519 struct rcu_head rcu;
853b39a7 1520 struct work_struct destroy_work;
69c433ed 1521
e97fedb9 1522 struct mutex s_sync_lock; /* sync serialisation lock */
69c433ed
MS
1523
1524 /*
1525 * Indicates how deep in a filesystem stack this SB is
1526 */
1527 int s_stack_depth;
74278da9
DC
1528
1529 /* s_inode_list_lock protects s_inodes */
1530 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1531 struct list_head s_inodes; /* all inodes */
6c60d2b5
DC
1532
1533 spinlock_t s_inode_wblist_lock;
1534 struct list_head s_inodes_wb; /* writeback inodes */
3859a271 1535} __randomize_layout;
1da177e4 1536
81754357
SF
1537/* Helper functions so that in most cases filesystems will
1538 * not need to deal directly with kuid_t and kgid_t and can
1539 * instead deal with the raw numeric values that are stored
1540 * in the filesystem.
1541 */
1542static inline uid_t i_uid_read(const struct inode *inode)
1543{
1544 return from_kuid(inode->i_sb->s_user_ns, inode->i_uid);
1545}
1546
1547static inline gid_t i_gid_read(const struct inode *inode)
1548{
1549 return from_kgid(inode->i_sb->s_user_ns, inode->i_gid);
1550}
1551
1552static inline void i_uid_write(struct inode *inode, uid_t uid)
1553{
1554 inode->i_uid = make_kuid(inode->i_sb->s_user_ns, uid);
1555}
1556
1557static inline void i_gid_write(struct inode *inode, gid_t gid)
1558{
1559 inode->i_gid = make_kgid(inode->i_sb->s_user_ns, gid);
1560}
1561
95582b00 1562extern struct timespec64 current_time(struct inode *inode);
1da177e4
LT
1563
1564/*
1565 * Snapshotting support.
1566 */
1da177e4 1567
5accdf82
JK
1568void __sb_end_write(struct super_block *sb, int level);
1569int __sb_start_write(struct super_block *sb, int level, bool wait);
1570
bee9182d 1571#define __sb_writers_acquired(sb, lev) \
8129ed29 1572 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
bee9182d 1573#define __sb_writers_release(sb, lev) \
8129ed29 1574 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
bee9182d 1575
5accdf82
JK
1576/**
1577 * sb_end_write - drop write access to a superblock
1578 * @sb: the super we wrote to
1579 *
1580 * Decrement number of writers to the filesystem. Wake up possible waiters
1581 * wanting to freeze the filesystem.
1582 */
1583static inline void sb_end_write(struct super_block *sb)
1584{
1585 __sb_end_write(sb, SB_FREEZE_WRITE);
1586}
1587
1588/**
1589 * sb_end_pagefault - drop write access to a superblock from a page fault
1590 * @sb: the super we wrote to
1591 *
1592 * Decrement number of processes handling write page fault to the filesystem.
1593 * Wake up possible waiters wanting to freeze the filesystem.
1594 */
1595static inline void sb_end_pagefault(struct super_block *sb)
1596{
1597 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1598}
1599
1600/**
1601 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1602 * @sb: the super we wrote to
1603 *
1604 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1605 * waiters wanting to freeze the filesystem.
1606 */
1607static inline void sb_end_intwrite(struct super_block *sb)
1608{
1609 __sb_end_write(sb, SB_FREEZE_FS);
1610}
1611
1612/**
1613 * sb_start_write - get write access to a superblock
1614 * @sb: the super we write to
1615 *
1616 * When a process wants to write data or metadata to a file system (i.e. dirty
1617 * a page or an inode), it should embed the operation in a sb_start_write() -
1618 * sb_end_write() pair to get exclusion against file system freezing. This
1619 * function increments number of writers preventing freezing. If the file
1620 * system is already frozen, the function waits until the file system is
1621 * thawed.
1622 *
1623 * Since freeze protection behaves as a lock, users have to preserve
1624 * ordering of freeze protection and other filesystem locks. Generally,
1625 * freeze protection should be the outermost lock. In particular, we have:
1626 *
1627 * sb_start_write
1628 * -> i_mutex (write path, truncate, directory ops, ...)
1629 * -> s_umount (freeze_super, thaw_super)
1630 */
1631static inline void sb_start_write(struct super_block *sb)
1632{
1633 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1634}
1635
1636static inline int sb_start_write_trylock(struct super_block *sb)
1637{
1638 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1639}
1640
1641/**
1642 * sb_start_pagefault - get write access to a superblock from a page fault
1643 * @sb: the super we write to
1644 *
1645 * When a process starts handling write page fault, it should embed the
1646 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1647 * exclusion against file system freezing. This is needed since the page fault
1648 * is going to dirty a page. This function increments number of running page
1649 * faults preventing freezing. If the file system is already frozen, the
1650 * function waits until the file system is thawed.
1651 *
1652 * Since page fault freeze protection behaves as a lock, users have to preserve
1653 * ordering of freeze protection and other filesystem locks. It is advised to
c1e8d7c6 1654 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
5accdf82
JK
1655 * handling code implies lock dependency:
1656 *
c1e8d7c6 1657 * mmap_lock
5accdf82
JK
1658 * -> sb_start_pagefault
1659 */
1660static inline void sb_start_pagefault(struct super_block *sb)
1661{
1662 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1663}
1664
1665/*
1666 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1667 * @sb: the super we write to
1668 *
1669 * This is the third level of protection against filesystem freezing. It is
1670 * free for use by a filesystem. The only requirement is that it must rank
1671 * below sb_start_pagefault.
1672 *
1673 * For example filesystem can call sb_start_intwrite() when starting a
1674 * transaction which somewhat eases handling of freezing for internal sources
1675 * of filesystem changes (internal fs threads, discarding preallocation on file
1676 * close, etc.).
1677 */
1678static inline void sb_start_intwrite(struct super_block *sb)
1679{
1680 __sb_start_write(sb, SB_FREEZE_FS, true);
1681}
1da177e4 1682
0c8e3fe3
AG
1683static inline int sb_start_intwrite_trylock(struct super_block *sb)
1684{
1685 return __sb_start_write(sb, SB_FREEZE_FS, false);
1686}
1687
1da177e4 1688
2e149670 1689extern bool inode_owner_or_capable(const struct inode *inode);
3bd858ab 1690
1da177e4
LT
1691/*
1692 * VFS helper functions..
1693 */
312b63fb 1694extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
18bb1db3 1695extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1a67aafb 1696extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
db2e747b 1697extern int vfs_symlink(struct inode *, struct dentry *, const char *);
146a8595 1698extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1da177e4 1699extern int vfs_rmdir(struct inode *, struct dentry *);
b21996e3 1700extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
520c8b16 1701extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
a3c751a5
MS
1702
1703static inline int vfs_whiteout(struct inode *dir, struct dentry *dentry)
1704{
1705 return vfs_mknod(dir, dentry, S_IFCHR | WHITEOUT_MODE, WHITEOUT_DEV);
1706}
1da177e4 1707
af7bd4dc
AG
1708extern struct dentry *vfs_tmpfile(struct dentry *dentry, umode_t mode,
1709 int open_flag);
1710
8e6c848e
AV
1711int vfs_mkobj(struct dentry *, umode_t,
1712 int (*f)(struct dentry *, umode_t, void *),
1713 void *);
1714
9df6702a
MS
1715extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1716
2952db0f
AB
1717#ifdef CONFIG_COMPAT
1718extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1719 unsigned long arg);
1720#else
1721#define compat_ptr_ioctl NULL
1722#endif
1723
8c744fb8
CH
1724/*
1725 * VFS file helper functions.
1726 */
a1bd120d 1727extern void inode_init_owner(struct inode *inode, const struct inode *dir,
62bb1091 1728 umode_t mode);
a2982cc9 1729extern bool may_open_dev(const struct path *path);
c4b929b8 1730
1da177e4
LT
1731/*
1732 * This is the "filldir" function type, used by readdir() to let
1733 * the kernel specify what kind of dirent layout it wants to have.
1734 * This allows the kernel to read directories into kernel space or
1735 * to have different dirent layouts depending on the binary type.
1736 */
ac7576f4
MS
1737struct dir_context;
1738typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1739 unsigned);
1740
5c0ba4e0 1741struct dir_context {
a09acf4b 1742 filldir_t actor;
bb6f619b 1743 loff_t pos;
5c0ba4e0 1744};
bb6f619b 1745
b4caecd4
CH
1746/*
1747 * These flags let !MMU mmap() govern direct device mapping vs immediate
1748 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1749 *
1750 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1751 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1752 * NOMMU_MAP_READ: Can be mapped for reading
1753 * NOMMU_MAP_WRITE: Can be mapped for writing
1754 * NOMMU_MAP_EXEC: Can be mapped for execution
1755 */
1756#define NOMMU_MAP_COPY 0x00000001
1757#define NOMMU_MAP_DIRECT 0x00000008
1758#define NOMMU_MAP_READ VM_MAYREAD
1759#define NOMMU_MAP_WRITE VM_MAYWRITE
1760#define NOMMU_MAP_EXEC VM_MAYEXEC
1761
1762#define NOMMU_VMFLAGS \
1763 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1764
2e5dfc99
DW
1765/*
1766 * These flags control the behavior of the remap_file_range function pointer.
1767 * If it is called with len == 0 that means "remap to end of source file".
5c437fa2 1768 * See Documentation/filesystems/vfs.rst for more details about this call.
2e5dfc99
DW
1769 *
1770 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
eca3654e 1771 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
2e5dfc99
DW
1772 */
1773#define REMAP_FILE_DEDUP (1 << 0)
eca3654e 1774#define REMAP_FILE_CAN_SHORTEN (1 << 1)
2e5dfc99
DW
1775
1776/*
1777 * These flags signal that the caller is ok with altering various aspects of
1778 * the behavior of the remap operation. The changes must be made by the
1779 * implementation; the vfs remap helper functions can take advantage of them.
1780 * Flags in this category exist to preserve the quirky behavior of the hoisted
1781 * btrfs clone/dedupe ioctls.
2e5dfc99 1782 */
eca3654e 1783#define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
b4caecd4 1784
293bc982
AV
1785struct iov_iter;
1786
1da177e4
LT
1787struct file_operations {
1788 struct module *owner;
1789 loff_t (*llseek) (struct file *, loff_t, int);
1790 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1da177e4 1791 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
293bc982
AV
1792 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1793 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
fb7e1600 1794 int (*iopoll)(struct kiocb *kiocb, bool spin);
bb6f619b 1795 int (*iterate) (struct file *, struct dir_context *);
61922694 1796 int (*iterate_shared) (struct file *, struct dir_context *);
a3f8683b 1797 __poll_t (*poll) (struct file *, struct poll_table_struct *);
1da177e4
LT
1798 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1799 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1800 int (*mmap) (struct file *, struct vm_area_struct *);
1c972597 1801 unsigned long mmap_supported_flags;
1da177e4 1802 int (*open) (struct inode *, struct file *);
75e1fcc0 1803 int (*flush) (struct file *, fl_owner_t id);
1da177e4 1804 int (*release) (struct inode *, struct file *);
02c24a82 1805 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1da177e4
LT
1806 int (*fasync) (int, struct file *, int);
1807 int (*lock) (struct file *, int, struct file_lock *);
1da177e4
LT
1808 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1809 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1810 int (*check_flags)(int);
1da177e4 1811 int (*flock) (struct file *, int, struct file_lock *);
cbb7e577
JA
1812 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1813 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
e6f5c789 1814 int (*setlease)(struct file *, long, struct file_lock **, void **);
2fe17c10
CH
1815 long (*fallocate)(struct file *file, int mode, loff_t offset,
1816 loff_t len);
a3816ab0 1817 void (*show_fdinfo)(struct seq_file *m, struct file *f);
b4caecd4
CH
1818#ifndef CONFIG_MMU
1819 unsigned (*mmap_capabilities)(struct file *);
1820#endif
04b38d60
CH
1821 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1822 loff_t, size_t, unsigned int);
42ec3d4c
DW
1823 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1824 struct file *file_out, loff_t pos_out,
1825 loff_t len, unsigned int remap_flags);
45cd0faa 1826 int (*fadvise)(struct file *, loff_t, loff_t, int);
3859a271 1827} __randomize_layout;
1da177e4
LT
1828
1829struct inode_operations {
00cd8dd3 1830 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
fceef393 1831 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
10556cb2 1832 int (*permission) (struct inode *, int);
4e34e719 1833 struct posix_acl * (*get_acl)(struct inode *, int);
44a7d7a8
NP
1834
1835 int (*readlink) (struct dentry *, char __user *,int);
44a7d7a8 1836
ebfc3b49 1837 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1da177e4
LT
1838 int (*link) (struct dentry *,struct inode *,struct dentry *);
1839 int (*unlink) (struct inode *,struct dentry *);
1840 int (*symlink) (struct inode *,struct dentry *,const char *);
18bb1db3 1841 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1da177e4 1842 int (*rmdir) (struct inode *,struct dentry *);
1a67aafb 1843 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1da177e4 1844 int (*rename) (struct inode *, struct dentry *,
520c8b16 1845 struct inode *, struct dentry *, unsigned int);
1da177e4 1846 int (*setattr) (struct dentry *, struct iattr *);
a528d35e 1847 int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1da177e4 1848 ssize_t (*listxattr) (struct dentry *, char *, size_t);
c4b929b8
MF
1849 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1850 u64 len);
95582b00 1851 int (*update_time)(struct inode *, struct timespec64 *, int);
d9585277 1852 int (*atomic_open)(struct inode *, struct dentry *,
30d90494 1853 struct file *, unsigned open_flag,
44907d79 1854 umode_t create_mode);
60545d0d 1855 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
893d46e4 1856 int (*set_acl)(struct inode *, struct posix_acl *, int);
44a7d7a8 1857} ____cacheline_aligned;
1da177e4 1858
bb7462b6
MS
1859static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
1860 struct iov_iter *iter)
1861{
1862 return file->f_op->read_iter(kio, iter);
1863}
1864
1865static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
1866 struct iov_iter *iter)
1867{
1868 return file->f_op->write_iter(kio, iter);
1869}
1870
f74ac015
MS
1871static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
1872{
1873 return file->f_op->mmap(file, vma);
1874}
1875
eed4e51f 1876ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
fcf63409
CY
1877 unsigned long nr_segs, unsigned long fast_segs,
1878 struct iovec *fast_pointer,
ac34ebb3 1879 struct iovec **ret_pointer);
eed4e51f 1880
1da177e4
LT
1881extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1882extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1883extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
ddef7ed2 1884 unsigned long, loff_t *, rwf_t);
29732938
ZB
1885extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
1886 loff_t, size_t, unsigned int);
f16acc9d
DC
1887extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
1888 struct file *file_out, loff_t pos_out,
1889 size_t len, unsigned int flags);
a83ab01a
DW
1890extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
1891 struct file *file_out, loff_t pos_out,
42ec3d4c
DW
1892 loff_t *count,
1893 unsigned int remap_flags);
1894extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
1895 struct file *file_out, loff_t pos_out,
452ce659 1896 loff_t len, unsigned int remap_flags);
42ec3d4c
DW
1897extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
1898 struct file *file_out, loff_t pos_out,
452ce659 1899 loff_t len, unsigned int remap_flags);
54dbc151
DW
1900extern int vfs_dedupe_file_range(struct file *file,
1901 struct file_dedupe_range *same);
42ec3d4c
DW
1902extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
1903 struct file *dst_file, loff_t dst_pos,
df365836 1904 loff_t len, unsigned int remap_flags);
f1825366 1905
1da177e4 1906
1da177e4
LT
1907struct super_operations {
1908 struct inode *(*alloc_inode)(struct super_block *sb);
1909 void (*destroy_inode)(struct inode *);
fdb0da89 1910 void (*free_inode)(struct inode *);
1da177e4 1911
aa385729 1912 void (*dirty_inode) (struct inode *, int flags);
a9185b41 1913 int (*write_inode) (struct inode *, struct writeback_control *wbc);
45321ac5 1914 int (*drop_inode) (struct inode *);
be7ce416 1915 void (*evict_inode) (struct inode *);
1da177e4 1916 void (*put_super) (struct super_block *);
1da177e4 1917 int (*sync_fs)(struct super_block *sb, int wait);
48b6bca6 1918 int (*freeze_super) (struct super_block *);
c4be0c1d 1919 int (*freeze_fs) (struct super_block *);
48b6bca6 1920 int (*thaw_super) (struct super_block *);
c4be0c1d 1921 int (*unfreeze_fs) (struct super_block *);
726c3342 1922 int (*statfs) (struct dentry *, struct kstatfs *);
1da177e4 1923 int (*remount_fs) (struct super_block *, int *, char *);
42faad99 1924 void (*umount_begin) (struct super_block *);
1da177e4 1925
34c80b1d 1926 int (*show_options)(struct seq_file *, struct dentry *);
d861c630 1927 int (*show_devname)(struct seq_file *, struct dentry *);
a6322de6 1928 int (*show_path)(struct seq_file *, struct dentry *);
64132379 1929 int (*show_stats)(struct seq_file *, struct dentry *);
0e51a720 1930#ifdef CONFIG_QUOTA
1da177e4
LT
1931 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1932 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
2d0fa467 1933 struct dquot **(*get_dquots)(struct inode *);
0e51a720 1934#endif
87d8fe1e 1935 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
4101b624
VD
1936 long (*nr_cached_objects)(struct super_block *,
1937 struct shrink_control *);
1938 long (*free_cached_objects)(struct super_block *,
1939 struct shrink_control *);
1da177e4
LT
1940};
1941
bbc1096a
DH
1942/*
1943 * Inode flags - they have no relation to superblock flags now
1944 */
1945#define S_SYNC 1 /* Writes are synced at once */
1946#define S_NOATIME 2 /* Do not update access times */
1947#define S_APPEND 4 /* Append-only file */
1948#define S_IMMUTABLE 8 /* Immutable file */
1949#define S_DEAD 16 /* removed, but still open directory */
1950#define S_NOQUOTA 32 /* Inode is not counted to quota */
1951#define S_DIRSYNC 64 /* Directory modifications are synchronous */
1952#define S_NOCMTIME 128 /* Do not update file c/mtime */
1953#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1954#define S_PRIVATE 512 /* Inode is fs-internal */
1955#define S_IMA 1024 /* Inode has an associated IMA struct */
1956#define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1957#define S_NOSEC 4096 /* no suid or xattr security attributes */
6cd176a5 1958#ifdef CONFIG_FS_DAX
fbbbad4b
MW
1959#define S_DAX 8192 /* Direct Access, avoiding the page cache */
1960#else
1961#define S_DAX 0 /* Make all the DAX code disappear */
1962#endif
2ee6a576 1963#define S_ENCRYPTED 16384 /* Encrypted file (using fs/crypto/) */
b886ee3e 1964#define S_CASEFOLD 32768 /* Casefolded file */
5585f2af 1965#define S_VERITY 65536 /* Verity file (using fs/verity/) */
bbc1096a
DH
1966
1967/*
1968 * Note that nosuid etc flags are inode-specific: setting some file-system
1969 * flags just means all the inodes inherit those flags by default. It might be
1970 * possible to override it selectively if you really wanted to with some
1971 * ioctl() that is not currently implemented.
1972 *
e462ec50 1973 * Exception: SB_RDONLY is always applied to the entire file system.
bbc1096a
DH
1974 *
1975 * Unfortunately, it is possible to change a filesystems flags with it mounted
1976 * with files in use. This means that all of the inodes will not have their
1977 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1978 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1979 */
1980#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1981
1751e8a6 1982static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
94e92e7a 1983#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
e462ec50 1984#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
bbc1096a 1985 ((inode)->i_flags & S_SYNC))
e462ec50 1986#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
bbc1096a 1987 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
e462ec50
DH
1988#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
1989#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
1990#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
bbc1096a
DH
1991
1992#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1993#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1994#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
e462ec50 1995#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
bbc1096a
DH
1996
1997#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1998#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1999#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2000#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2001#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2002#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2003#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
fbbbad4b 2004#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
2ee6a576 2005#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
b886ee3e 2006#define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
5585f2af 2007#define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
bbc1096a 2008
787fb6bc
MS
2009#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2010 (inode)->i_rdev == WHITEOUT_DEV)
2011
0bd23d09
EB
2012static inline bool HAS_UNMAPPED_ID(struct inode *inode)
2013{
2014 return !uid_valid(inode->i_uid) || !gid_valid(inode->i_gid);
2015}
2016
c75b1d94
JA
2017static inline enum rw_hint file_write_hint(struct file *file)
2018{
2019 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2020 return file->f_write_hint;
2021
2022 return file_inode(file)->i_write_hint;
2023}
2024
2025static inline int iocb_flags(struct file *file);
2026
fc28724d
AM
2027static inline u16 ki_hint_validate(enum rw_hint hint)
2028{
2029 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2030
2031 if (hint <= max_hint)
2032 return hint;
2033 return 0;
2034}
2035
c75b1d94
JA
2036static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2037{
2038 *kiocb = (struct kiocb) {
2039 .ki_filp = filp,
2040 .ki_flags = iocb_flags(filp),
fc28724d 2041 .ki_hint = ki_hint_validate(file_write_hint(filp)),
20578bdf 2042 .ki_ioprio = get_current_ioprio(),
c75b1d94
JA
2043 };
2044}
2045
5dcdc43e
JX
2046static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2047 struct file *filp)
2048{
2049 *kiocb = (struct kiocb) {
2050 .ki_filp = filp,
2051 .ki_flags = kiocb_src->ki_flags,
2052 .ki_hint = kiocb_src->ki_hint,
2053 .ki_ioprio = kiocb_src->ki_ioprio,
2054 .ki_pos = kiocb_src->ki_pos,
2055 };
2056}
2057
1c0eeaf5 2058/*
250df6ed 2059 * Inode state bits. Protected by inode->i_lock
1c0eeaf5
JE
2060 *
2061 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
2062 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
2063 *
2064 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2065 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2066 * various stages of removing an inode.
2067 *
eaff8079 2068 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1c0eeaf5 2069 *
e7ca2d41
JE
2070 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2071 * fdatasync(). i_atime is the usual cause.
000cb48e
JK
2072 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2073 * these changes separately from I_DIRTY_SYNC so that we
2074 * don't have to write inode on fdatasync() when only
2075 * mtime has changed in it.
1c0eeaf5 2076 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
eaff8079
CH
2077 * I_NEW Serves as both a mutex and completion notification.
2078 * New inodes set I_NEW. If two processes both create
2079 * the same inode, one of them will release its inode and
2080 * wait for I_NEW to be released before returning.
2081 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2082 * also cause waiting on I_NEW, without I_NEW actually
2083 * being set. find_inode() uses this to prevent returning
2084 * nearly-dead inodes.
1c0eeaf5
JE
2085 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2086 * is zero. I_FREEING must be set when I_WILL_FREE is
2087 * cleared.
2088 * I_FREEING Set when inode is about to be freed but still has dirty
2089 * pages or buffers attached or the inode itself is still
2090 * dirty.
dbd5768f
JK
2091 * I_CLEAR Added by clear_inode(). In this state the inode is
2092 * clean and can be destroyed. Inode keeps I_FREEING.
1c0eeaf5
JE
2093 *
2094 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2095 * prohibited for many purposes. iget() must wait for
2096 * the inode to be completely released, then create it
2097 * anew. Other functions will just ignore such inodes,
eaff8079 2098 * if appropriate. I_NEW is used for waiting.
1c0eeaf5 2099 *
169ebd90
JK
2100 * I_SYNC Writeback of inode is running. The bit is set during
2101 * data writeback, and cleared with a wakeup on the bit
2102 * address once it is done. The bit is also used to pin
2103 * the inode in memory for flusher thread.
1c0eeaf5 2104 *
bd5fe6c5
CH
2105 * I_REFERENCED Marks the inode as recently references on the LRU list.
2106 *
2107 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2108 *
682aa8e1
TH
2109 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2110 * synchronize competing switching instances and to tell
b93b0163 2111 * wb stat updates to grab the i_pages lock. See
a9519def 2112 * inode_switch_wbs_work_fn() for details.
682aa8e1 2113 *
ad0af710
AG
2114 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2115 * and work dirs among overlayfs mounts.
2116 *
c2b6d621
AV
2117 * I_CREATING New object's inode in the middle of setting up.
2118 *
dae2f8ed
IW
2119 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2120 *
1c0eeaf5 2121 * Q: What is the difference between I_WILL_FREE and I_FREEING?
1c0eeaf5 2122 */
9e38d86f
NP
2123#define I_DIRTY_SYNC (1 << 0)
2124#define I_DIRTY_DATASYNC (1 << 1)
2125#define I_DIRTY_PAGES (1 << 2)
eaff8079
CH
2126#define __I_NEW 3
2127#define I_NEW (1 << __I_NEW)
9e38d86f
NP
2128#define I_WILL_FREE (1 << 4)
2129#define I_FREEING (1 << 5)
2130#define I_CLEAR (1 << 6)
eaff8079 2131#define __I_SYNC 7
1c0eeaf5 2132#define I_SYNC (1 << __I_SYNC)
9e38d86f 2133#define I_REFERENCED (1 << 8)
bd5fe6c5 2134#define __I_DIO_WAKEUP 9
ac74d8d6 2135#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
f4e0c30c 2136#define I_LINKABLE (1 << 10)
0ae45f63
TT
2137#define I_DIRTY_TIME (1 << 11)
2138#define __I_DIRTY_TIME_EXPIRED 12
2139#define I_DIRTY_TIME_EXPIRED (1 << __I_DIRTY_TIME_EXPIRED)
682aa8e1 2140#define I_WB_SWITCH (1 << 13)
c2b6d621
AV
2141#define I_OVL_INUSE (1 << 14)
2142#define I_CREATING (1 << 15)
dae2f8ed 2143#define I_DONTCACHE (1 << 16)
1da177e4 2144
0e11f644
CH
2145#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2146#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
0ae45f63 2147#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
1da177e4
LT
2148
2149extern void __mark_inode_dirty(struct inode *, int);
2150static inline void mark_inode_dirty(struct inode *inode)
2151{
2152 __mark_inode_dirty(inode, I_DIRTY);
2153}
2154
2155static inline void mark_inode_dirty_sync(struct inode *inode)
2156{
2157 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2158}
2159
7ada4db8
MS
2160extern void inc_nlink(struct inode *inode);
2161extern void drop_nlink(struct inode *inode);
2162extern void clear_nlink(struct inode *inode);
2163extern void set_nlink(struct inode *inode, unsigned int nlink);
d8c76e6f
DH
2164
2165static inline void inode_inc_link_count(struct inode *inode)
2166{
2167 inc_nlink(inode);
66d21730
AD
2168 mark_inode_dirty(inode);
2169}
2170
9a53c3a7
DH
2171static inline void inode_dec_link_count(struct inode *inode)
2172{
2173 drop_nlink(inode);
66d21730
AD
2174 mark_inode_dirty(inode);
2175}
2176
c3b2da31
JB
2177enum file_time_flags {
2178 S_ATIME = 1,
2179 S_MTIME = 2,
2180 S_CTIME = 4,
2181 S_VERSION = 8,
2182};
2183
c6718543 2184extern bool atime_needs_update(const struct path *, struct inode *);
badcf2b7 2185extern void touch_atime(const struct path *);
1da177e4
LT
2186static inline void file_accessed(struct file *file)
2187{
2188 if (!(file->f_flags & O_NOATIME))
68ac1234 2189 touch_atime(&file->f_path);
1da177e4
LT
2190}
2191
e38f7f53
AG
2192extern int file_modified(struct file *file);
2193
1da177e4 2194int sync_inode(struct inode *inode, struct writeback_control *wbc);
c3765016 2195int sync_inode_metadata(struct inode *inode, int wait);
1da177e4 2196
1da177e4
LT
2197struct file_system_type {
2198 const char *name;
2199 int fs_flags;
bbc1096a
DH
2200#define FS_REQUIRES_DEV 1
2201#define FS_BINARY_MOUNTDATA 2
2202#define FS_HAS_SUBTYPE 4
0c55cfc4 2203#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
0b3b094a 2204#define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
bbc1096a 2205#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
f3a09c92 2206 int (*init_fs_context)(struct fs_context *);
d7167b14 2207 const struct fs_parameter_spec *parameters;
c96e41e9
AV
2208 struct dentry *(*mount) (struct file_system_type *, int,
2209 const char *, void *);
1da177e4
LT
2210 void (*kill_sb) (struct super_block *);
2211 struct module *owner;
2212 struct file_system_type * next;
a5166169 2213 struct hlist_head fs_supers;
d475fd42 2214
cf516249 2215 struct lock_class_key s_lock_key;
897c6ff9 2216 struct lock_class_key s_umount_key;
51ee049e 2217 struct lock_class_key s_vfs_rename_key;
5accdf82 2218 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
d475fd42
PZ
2219
2220 struct lock_class_key i_lock_key;
2221 struct lock_class_key i_mutex_key;
14358e6d 2222 struct lock_class_key i_mutex_dir_key;
1da177e4
LT
2223};
2224
7f78e035
EB
2225#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2226
152a0836
AV
2227extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2228 int flags, const char *dev_name, void *data,
2229 int (*fill_super)(struct super_block *, void *, int));
fc14f2fe
AV
2230extern struct dentry *mount_single(struct file_system_type *fs_type,
2231 int flags, void *data,
2232 int (*fill_super)(struct super_block *, void *, int));
3c26ff6e
AV
2233extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2234 int flags, void *data,
2235 int (*fill_super)(struct super_block *, void *, int));
ea441d11 2236extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
1da177e4
LT
2237void generic_shutdown_super(struct super_block *sb);
2238void kill_block_super(struct super_block *sb);
2239void kill_anon_super(struct super_block *sb);
2240void kill_litter_super(struct super_block *sb);
2241void deactivate_super(struct super_block *sb);
74dbbdd7 2242void deactivate_locked_super(struct super_block *sb);
1da177e4 2243int set_anon_super(struct super_block *s, void *data);
cb50b348 2244int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
0ee5dc67
AV
2245int get_anon_bdev(dev_t *);
2246void free_anon_bdev(dev_t);
cb50b348
AV
2247struct super_block *sget_fc(struct fs_context *fc,
2248 int (*test)(struct super_block *, struct fs_context *),
2249 int (*set)(struct super_block *, struct fs_context *));
1da177e4
LT
2250struct super_block *sget(struct file_system_type *type,
2251 int (*test)(struct super_block *,void *),
2252 int (*set)(struct super_block *,void *),
9249e17f 2253 int flags, void *data);
1da177e4
LT
2254
2255/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2256#define fops_get(fops) \
2257 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2258#define fops_put(fops) \
2259 do { if (fops) module_put((fops)->owner); } while(0)
e84f9e57
AV
2260/*
2261 * This one is to be used *ONLY* from ->open() instances.
2262 * fops must be non-NULL, pinned down *and* module dependencies
2263 * should be sufficient to pin the caller down as well.
2264 */
2265#define replace_fops(f, fops) \
2266 do { \
2267 struct file *__file = (f); \
2268 fops_put(__file->f_op); \
2269 BUG_ON(!(__file->f_op = (fops))); \
2270 } while(0)
1da177e4
LT
2271
2272extern int register_filesystem(struct file_system_type *);
2273extern int unregister_filesystem(struct file_system_type *);
d911b458 2274extern struct vfsmount *kern_mount(struct file_system_type *);
423e0ab0 2275extern void kern_unmount(struct vfsmount *mnt);
1da177e4
LT
2276extern int may_umount_tree(struct vfsmount *);
2277extern int may_umount(struct vfsmount *);
5e6123f3
SL
2278extern long do_mount(const char *, const char __user *,
2279 const char *, unsigned long, void *);
ca71cf71 2280extern struct vfsmount *collect_mounts(const struct path *);
8aec0809 2281extern void drop_collected_mounts(struct vfsmount *);
1f707137
AV
2282extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2283 struct vfsmount *);
f0bb5aaf 2284extern int vfs_statfs(const struct path *, struct kstatfs *);
c8b91acc
AV
2285extern int user_statfs(const char __user *, struct kstatfs *);
2286extern int fd_statfs(int, struct kstatfs *);
18e9e510
JB
2287extern int freeze_super(struct super_block *super);
2288extern int thaw_super(struct super_block *super);
02125a82 2289extern bool our_mnt(struct vfsmount *mnt);
fca39346
JK
2290extern __printf(2, 3)
2291int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2292extern int super_setup_bdi(struct super_block *sb);
1da177e4 2293
ce3b0f8d
AV
2294extern int current_umask(void);
2295
5a14696c
BF
2296extern void ihold(struct inode * inode);
2297extern void iput(struct inode *);
95582b00 2298extern int generic_update_time(struct inode *, struct timespec64 *, int);
5a14696c 2299
f87fd4c2 2300/* /sys/fs */
00d26666 2301extern struct kobject *fs_kobj;
f87fd4c2 2302
09cbfeaf 2303#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
bfcd17a6 2304
9e8925b6 2305#ifdef CONFIG_MANDATORY_FILE_LOCKING
d7a06983 2306extern int locks_mandatory_locked(struct file *);
acc15575 2307extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
1da177e4
LT
2308
2309/*
2310 * Candidates for mandatory locking have the setgid bit set
2311 * but no group execute bit - an otherwise meaningless combination.
2312 */
a16877ca
PE
2313
2314static inline int __mandatory_lock(struct inode *ino)
2315{
2316 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2317}
2318
2319/*
e462ec50 2320 * ... and these candidates should be on SB_MANDLOCK mounted fs,
a16877ca
PE
2321 * otherwise these will be advisory locks
2322 */
2323
2324static inline int mandatory_lock(struct inode *ino)
2325{
2326 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2327}
1da177e4 2328
d7a06983 2329static inline int locks_verify_locked(struct file *file)
1da177e4 2330{
c568d683 2331 if (mandatory_lock(locks_inode(file)))
d7a06983 2332 return locks_mandatory_locked(file);
1da177e4
LT
2333 return 0;
2334}
2335
1da177e4 2336static inline int locks_verify_truncate(struct inode *inode,
acc15575 2337 struct file *f,
1da177e4
LT
2338 loff_t size)
2339{
acc15575
CH
2340 if (!inode->i_flctx || !mandatory_lock(inode))
2341 return 0;
2342
2343 if (size < inode->i_size) {
2344 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2345 F_WRLCK);
2346 } else {
2347 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2348 F_WRLCK);
2349 }
1da177e4
LT
2350}
2351
9e8925b6
JL
2352#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2353
2354static inline int locks_mandatory_locked(struct file *file)
2355{
2356 return 0;
2357}
2358
fce205e9
LT
2359static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2360 loff_t start, loff_t end, unsigned char type)
9e8925b6
JL
2361{
2362 return 0;
2363}
2364
2365static inline int __mandatory_lock(struct inode *inode)
2366{
2367 return 0;
2368}
2369
2370static inline int mandatory_lock(struct inode *inode)
2371{
2372 return 0;
2373}
2374
2375static inline int locks_verify_locked(struct file *file)
2376{
2377 return 0;
2378}
2379
2380static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2381 size_t size)
2382{
2383 return 0;
2384}
2385
2386#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2387
2388
2389#ifdef CONFIG_FILE_LOCKING
1da177e4
LT
2390static inline int break_lease(struct inode *inode, unsigned int mode)
2391{
24cbe784
JL
2392 /*
2393 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2394 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2395 * could end up racing with tasks trying to set a new lease on this
2396 * file.
24cbe784
JL
2397 */
2398 smp_mb();
8634b51f 2399 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2400 return __break_lease(inode, mode, FL_LEASE);
1da177e4
LT
2401 return 0;
2402}
df4e8d2c
BF
2403
2404static inline int break_deleg(struct inode *inode, unsigned int mode)
2405{
962bd40b
JL
2406 /*
2407 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2408 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2409 * could end up racing with tasks trying to set a new lease on this
2410 * file.
962bd40b
JL
2411 */
2412 smp_mb();
8634b51f 2413 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2414 return __break_lease(inode, mode, FL_DELEG);
1da177e4
LT
2415 return 0;
2416}
df4e8d2c 2417
5a14696c
BF
2418static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2419{
2420 int ret;
2421
2422 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2423 if (ret == -EWOULDBLOCK && delegated_inode) {
2424 *delegated_inode = inode;
2425 ihold(inode);
2426 }
2427 return ret;
2428}
2429
2430static inline int break_deleg_wait(struct inode **delegated_inode)
2431{
2432 int ret;
2433
2434 ret = break_deleg(*delegated_inode, O_WRONLY);
2435 iput(*delegated_inode);
2436 *delegated_inode = NULL;
2437 return ret;
2438}
2439
11afe9f7
CH
2440static inline int break_layout(struct inode *inode, bool wait)
2441{
2442 smp_mb();
2443 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2444 return __break_lease(inode,
2445 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2446 FL_LAYOUT);
2447 return 0;
2448}
2449
bfcd17a6 2450#else /* !CONFIG_FILE_LOCKING */
af5df566
SW
2451static inline int break_lease(struct inode *inode, unsigned int mode)
2452{
2453 return 0;
2454}
2455
df4e8d2c
BF
2456static inline int break_deleg(struct inode *inode, unsigned int mode)
2457{
2458 return 0;
2459}
5a14696c
BF
2460
2461static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2462{
2463 return 0;
2464}
2465
2466static inline int break_deleg_wait(struct inode **delegated_inode)
2467{
2468 BUG();
2469 return 0;
2470}
2471
11afe9f7
CH
2472static inline int break_layout(struct inode *inode, bool wait)
2473{
2474 return 0;
2475}
2476
bfcd17a6 2477#endif /* CONFIG_FILE_LOCKING */
1da177e4
LT
2478
2479/* fs/open.c */
adb5c247 2480struct audit_names;
91a27b2a 2481struct filename {
adb5c247
JL
2482 const char *name; /* pointer to actual string */
2483 const __user char *uptr; /* original userland pointer */
55422d0b 2484 int refcnt;
1c949843 2485 struct audit_names *aname;
fd2f7cb5 2486 const char iname[];
91a27b2a 2487};
f1fffbd4 2488static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
1da177e4 2489
7df818b2 2490extern long vfs_truncate(const struct path *, loff_t);
4a30131e
N
2491extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2492 struct file *filp);
72c72bdf 2493extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
3e63cbb1 2494 loff_t len);
8e8a1407 2495extern long do_sys_open(int dfd, const char __user *filename, int flags,
a218d0fd 2496 umode_t mode);
669abf4e 2497extern struct file *file_open_name(struct filename *, int, umode_t);
a218d0fd 2498extern struct file *filp_open(const char *, int, umode_t);
73d049a4 2499extern struct file *file_open_root(struct dentry *, struct vfsmount *,
378c6520 2500 const char *, int, umode_t);
765927b2 2501extern struct file * dentry_open(const struct path *, int, const struct cred *);
2abc77af
AV
2502extern struct file * open_with_fake_path(const struct path *, int,
2503 struct inode*, const struct cred *);
19f391eb
AV
2504static inline struct file *file_clone_open(struct file *file)
2505{
2506 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2507}
1da177e4 2508extern int filp_close(struct file *, fl_owner_t id);
91a27b2a 2509
51f39a1f 2510extern struct filename *getname_flags(const char __user *, int, int *);
91a27b2a 2511extern struct filename *getname(const char __user *);
c4ad8f98 2512extern struct filename *getname_kernel(const char *);
55422d0b 2513extern void putname(struct filename *name);
91a27b2a 2514
30d90494 2515extern int finish_open(struct file *file, struct dentry *dentry,
be12af3e 2516 int (*open)(struct inode *, struct file *));
e45198a6 2517extern int finish_no_open(struct file *file, struct dentry *dentry);
1da177e4
LT
2518
2519/* fs/dcache.c */
2520extern void __init vfs_caches_init_early(void);
4248b0da 2521extern void __init vfs_caches_init(void);
1da177e4 2522
b86c089b
CL
2523extern struct kmem_cache *names_cachep;
2524
a608ca21 2525#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
3446a8aa 2526#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
1da177e4 2527
a212b105 2528extern struct super_block *blockdev_superblock;
a212b105
TH
2529static inline bool sb_is_blkdev_sb(struct super_block *sb)
2530{
dd0dca22 2531 return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
47e4491b 2532}
5c0d6b60 2533
b818f09e 2534void emergency_thaw_all(void);
60b0680f 2535extern int sync_filesystem(struct super_block *);
9361401e 2536extern const struct file_operations def_blk_fops;
4b6f5d20 2537extern const struct file_operations def_chr_fops;
1da177e4
LT
2538
2539/* fs/char_dev.c */
8a932f73 2540#define CHRDEV_MAJOR_MAX 512
49db08c3
LW
2541/* Marks the bottom of the first segment of free char majors */
2542#define CHRDEV_MAJOR_DYN_END 234
a5d31a3f
LG
2543/* Marks the top and bottom of the second segment of free char majors */
2544#define CHRDEV_MAJOR_DYN_EXT_START 511
2545#define CHRDEV_MAJOR_DYN_EXT_END 384
2546
1da177e4
LT
2547extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2548extern int register_chrdev_region(dev_t, unsigned, const char *);
1905b1bf
TH
2549extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2550 unsigned int count, const char *name,
2551 const struct file_operations *fops);
2552extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2553 unsigned int count, const char *name);
1da177e4 2554extern void unregister_chrdev_region(dev_t, unsigned);
68eef3b4 2555extern void chrdev_show(struct seq_file *,off_t);
1da177e4 2556
1905b1bf
TH
2557static inline int register_chrdev(unsigned int major, const char *name,
2558 const struct file_operations *fops)
2559{
2560 return __register_chrdev(major, 0, 256, name, fops);
2561}
2562
2563static inline void unregister_chrdev(unsigned int major, const char *name)
2564{
2565 __unregister_chrdev(major, 0, 256, name);
2566}
2567
1da177e4
LT
2568extern void init_special_inode(struct inode *, umode_t, dev_t);
2569
2570/* Invalid inode operations -- fs/bad_inode.c */
2571extern void make_bad_inode(struct inode *);
0e3ef1fe 2572extern bool is_bad_inode(struct inode *);
1da177e4 2573
1da177e4
LT
2574unsigned long invalidate_mapping_pages(struct address_space *mapping,
2575 pgoff_t start, pgoff_t end);
54bc4855 2576
1da177e4
LT
2577static inline void invalidate_remote_inode(struct inode *inode)
2578{
2579 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2580 S_ISLNK(inode->i_mode))
fc0ecff6 2581 invalidate_mapping_pages(inode->i_mapping, 0, -1);
1da177e4
LT
2582}
2583extern int invalidate_inode_pages2(struct address_space *mapping);
2584extern int invalidate_inode_pages2_range(struct address_space *mapping,
2585 pgoff_t start, pgoff_t end);
2586extern int write_inode_now(struct inode *, int);
2587extern int filemap_fdatawrite(struct address_space *);
2588extern int filemap_flush(struct address_space *);
76341cab 2589extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
d3bccb6f
JK
2590extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2591 loff_t lend);
aa0bfcd9
RZ
2592extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2593 loff_t start_byte, loff_t end_byte);
ffb959bb
JL
2594
2595static inline int filemap_fdatawait(struct address_space *mapping)
2596{
2597 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2598}
2599
7fc9e472
GR
2600extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2601 loff_t lend);
1da177e4
LT
2602extern int filemap_write_and_wait_range(struct address_space *mapping,
2603 loff_t lstart, loff_t lend);
ebcf28e1
AM
2604extern int __filemap_fdatawrite_range(struct address_space *mapping,
2605 loff_t start, loff_t end, int sync_mode);
f4c0a0fd
JK
2606extern int filemap_fdatawrite_range(struct address_space *mapping,
2607 loff_t start, loff_t end);
d72d9e2a 2608extern int filemap_check_errors(struct address_space *mapping);
5660e13d 2609extern void __filemap_set_wb_err(struct address_space *mapping, int err);
a823e458 2610
ddf8f376
IW
2611static inline int filemap_write_and_wait(struct address_space *mapping)
2612{
2613 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2614}
2615
a823e458
JL
2616extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2617 loff_t lend);
5660e13d
JL
2618extern int __must_check file_check_and_advance_wb_err(struct file *file);
2619extern int __must_check file_write_and_wait_range(struct file *file,
2620 loff_t start, loff_t end);
2621
a823e458
JL
2622static inline int file_write_and_wait(struct file *file)
2623{
2624 return file_write_and_wait_range(file, 0, LLONG_MAX);
2625}
2626
5660e13d
JL
2627/**
2628 * filemap_set_wb_err - set a writeback error on an address_space
2629 * @mapping: mapping in which to set writeback error
2630 * @err: error to be set in mapping
2631 *
2632 * When writeback fails in some way, we must record that error so that
2633 * userspace can be informed when fsync and the like are called. We endeavor
2634 * to report errors on any file that was open at the time of the error. Some
2635 * internal callers also need to know when writeback errors have occurred.
2636 *
2637 * When a writeback error occurs, most filesystems will want to call
2638 * filemap_set_wb_err to record the error in the mapping so that it will be
2639 * automatically reported whenever fsync is called on the file.
5660e13d
JL
2640 */
2641static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2642{
2643 /* Fastpath for common case of no error */
2644 if (unlikely(err))
2645 __filemap_set_wb_err(mapping, err);
2646}
2647
2648/**
2649 * filemap_check_wb_error - has an error occurred since the mark was sampled?
2650 * @mapping: mapping to check for writeback errors
2651 * @since: previously-sampled errseq_t
2652 *
2653 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2654 * the given value was sampled.
2655 *
2656 * If it has then report the latest error set, otherwise return 0.
2657 */
2658static inline int filemap_check_wb_err(struct address_space *mapping,
2659 errseq_t since)
2660{
2661 return errseq_check(&mapping->wb_err, since);
2662}
2663
2664/**
2665 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2666 * @mapping: mapping to be sampled
2667 *
2668 * Writeback errors are always reported relative to a particular sample point
2669 * in the past. This function provides those sample points.
2670 */
2671static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2672{
2673 return errseq_sample(&mapping->wb_err);
2674}
2675
735e4ae5
JL
2676/**
2677 * file_sample_sb_err - sample the current errseq_t to test for later errors
21b9cb34 2678 * @file: file pointer to be sampled
735e4ae5
JL
2679 *
2680 * Grab the most current superblock-level errseq_t value for the given
2681 * struct file.
2682 */
2683static inline errseq_t file_sample_sb_err(struct file *file)
2684{
2685 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
2686}
2687
09d91cda
SL
2688static inline int filemap_nr_thps(struct address_space *mapping)
2689{
2690#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2691 return atomic_read(&mapping->nr_thps);
2692#else
2693 return 0;
2694#endif
2695}
2696
2697static inline void filemap_nr_thps_inc(struct address_space *mapping)
2698{
2699#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2700 atomic_inc(&mapping->nr_thps);
2701#else
2702 WARN_ON_ONCE(1);
2703#endif
2704}
2705
2706static inline void filemap_nr_thps_dec(struct address_space *mapping)
2707{
2708#ifdef CONFIG_READ_ONLY_THP_FOR_FS
2709 atomic_dec(&mapping->nr_thps);
2710#else
2711 WARN_ON_ONCE(1);
2712#endif
2713}
2714
8018ab05
CH
2715extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2716 int datasync);
2717extern int vfs_fsync(struct file *file, int datasync);
e2592217 2718
22f96b38
JA
2719extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2720 unsigned int flags);
2721
e2592217
CH
2722/*
2723 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2724 * to already be updated for the write, and will return either the amount
2725 * of bytes passed in, or an error if syncing the file failed.
2726 */
2727static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2728{
2729 if (iocb->ki_flags & IOCB_DSYNC) {
2730 int ret = vfs_fsync_range(iocb->ki_filp,
2731 iocb->ki_pos - count, iocb->ki_pos - 1,
2732 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2733 if (ret)
2734 return ret;
2735 }
2736
2737 return count;
d311d79d 2738}
e2592217 2739
1da177e4
LT
2740extern void emergency_sync(void);
2741extern void emergency_remount(void);
30460e1e 2742
9361401e 2743#ifdef CONFIG_BLOCK
30460e1e
CM
2744extern int bmap(struct inode *inode, sector_t *block);
2745#else
2746static inline int bmap(struct inode *inode, sector_t *block)
2747{
2748 return -EINVAL;
2749}
9361401e 2750#endif
30460e1e 2751
27ac0ffe 2752extern int notify_change(struct dentry *, struct iattr *, struct inode **);
f419a2e3 2753extern int inode_permission(struct inode *, int);
2830ba7f 2754extern int generic_permission(struct inode *, int);
cbdf35bc 2755extern int __check_sticky(struct inode *dir, struct inode *inode);
1da177e4 2756
f696a365
MS
2757static inline bool execute_ok(struct inode *inode)
2758{
2759 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2760}
2761
8d71db4f
AV
2762static inline void file_start_write(struct file *file)
2763{
2764 if (!S_ISREG(file_inode(file)->i_mode))
2765 return;
2766 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2767}
2768
5ae98f15
JK
2769static inline bool file_start_write_trylock(struct file *file)
2770{
2771 if (!S_ISREG(file_inode(file)->i_mode))
2772 return true;
2773 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2774}
2775
8d71db4f
AV
2776static inline void file_end_write(struct file *file)
2777{
2778 if (!S_ISREG(file_inode(file)->i_mode))
2779 return;
2780 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2781}
bfe219d3 2782
07b8ce1e
AV
2783/*
2784 * get_write_access() gets write permission for a file.
2785 * put_write_access() releases this write permission.
2786 * This is used for regular files.
2787 * We cannot support write (and maybe mmap read-write shared) accesses and
2788 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2789 * can have the following values:
2790 * 0: no writers, no VM_DENYWRITE mappings
2791 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2792 * > 0: (i_writecount) users are writing to the file.
2793 *
2794 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2795 * except for the cases where we don't hold i_writecount yet. Then we need to
2796 * use {get,deny}_write_access() - these functions check the sign and refuse
2797 * to do the change if sign is wrong.
2798 */
2799static inline int get_write_access(struct inode *inode)
2800{
2801 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2802}
2803static inline int deny_write_access(struct file *file)
2804{
496ad9aa 2805 struct inode *inode = file_inode(file);
07b8ce1e
AV
2806 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2807}
1da177e4
LT
2808static inline void put_write_access(struct inode * inode)
2809{
2810 atomic_dec(&inode->i_writecount);
2811}
2812static inline void allow_write_access(struct file *file)
2813{
2814 if (file)
496ad9aa 2815 atomic_inc(&file_inode(file)->i_writecount);
1da177e4 2816}
f1fe29b4
DH
2817static inline bool inode_is_open_for_write(const struct inode *inode)
2818{
2819 return atomic_read(&inode->i_writecount) > 0;
2820}
2821
387e3746 2822#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
a5c96ebf
MZ
2823static inline void i_readcount_dec(struct inode *inode)
2824{
2825 BUG_ON(!atomic_read(&inode->i_readcount));
2826 atomic_dec(&inode->i_readcount);
2827}
2828static inline void i_readcount_inc(struct inode *inode)
2829{
2830 atomic_inc(&inode->i_readcount);
2831}
2832#else
2833static inline void i_readcount_dec(struct inode *inode)
2834{
2835 return;
2836}
2837static inline void i_readcount_inc(struct inode *inode)
2838{
2839 return;
2840}
2841#endif
ed8cae8b 2842extern int do_pipe_flags(int *, int);
1da177e4 2843
1284ab5b
MZ
2844#define __kernel_read_file_id(id) \
2845 id(UNKNOWN, unknown) \
2846 id(FIRMWARE, firmware) \
a098ecd2 2847 id(FIRMWARE_PREALLOC_BUFFER, firmware) \
e4c2c0ff 2848 id(FIRMWARE_EFI_EMBEDDED, firmware) \
1284ab5b
MZ
2849 id(MODULE, kernel-module) \
2850 id(KEXEC_IMAGE, kexec-image) \
2851 id(KEXEC_INITRAMFS, kexec-initramfs) \
2852 id(POLICY, security-policy) \
a7d3d039 2853 id(X509_CERTIFICATE, x509-certificate) \
1284ab5b
MZ
2854 id(MAX_ID, )
2855
2856#define __fid_enumify(ENUM, dummy) READING_ ## ENUM,
2857#define __fid_stringify(dummy, str) #str,
2858
bc8ca5b9 2859enum kernel_read_file_id {
1284ab5b
MZ
2860 __kernel_read_file_id(__fid_enumify)
2861};
2862
2863static const char * const kernel_read_file_str[] = {
2864 __kernel_read_file_id(__fid_stringify)
bc8ca5b9
MZ
2865};
2866
da20dfe6 2867static inline const char *kernel_read_file_id_str(enum kernel_read_file_id id)
1284ab5b 2868{
cbfd0c10 2869 if ((unsigned)id >= READING_MAX_ID)
1284ab5b
MZ
2870 return kernel_read_file_str[READING_UNKNOWN];
2871
2872 return kernel_read_file_str[id];
2873}
2874
bc8ca5b9
MZ
2875extern int kernel_read_file(struct file *, void **, loff_t *, loff_t,
2876 enum kernel_read_file_id);
711aab1d 2877extern int kernel_read_file_from_path(const char *, void **, loff_t *, loff_t,
09596b94 2878 enum kernel_read_file_id);
901cff7c
TM
2879extern int kernel_read_file_from_path_initns(const char *, void **, loff_t *, loff_t,
2880 enum kernel_read_file_id);
b844f0ec
MZ
2881extern int kernel_read_file_from_fd(int, void **, loff_t *, loff_t,
2882 enum kernel_read_file_id);
bdd1d2d3 2883extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
61a707c5 2884ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
e13ec939 2885extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
73e18f7c 2886extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
1da177e4
LT
2887extern struct file * open_exec(const char *);
2888
2889/* fs/dcache.c -- generic fs support functions */
a6e5787f 2890extern bool is_subdir(struct dentry *, struct dentry *);
640eb7e7 2891extern bool path_is_under(const struct path *, const struct path *);
1da177e4 2892
9bf39ab2
MS
2893extern char *file_path(struct file *, char *, int);
2894
1da177e4
LT
2895#include <linux/err.h>
2896
2897/* needed for stackable file system support */
965c8e59 2898extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
1da177e4 2899
965c8e59 2900extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
1da177e4 2901
54e34621 2902extern int inode_init_always(struct super_block *, struct inode *);
1da177e4 2903extern void inode_init_once(struct inode *);
2aa15890 2904extern void address_space_init_once(struct address_space *mapping);
1da177e4
LT
2905extern struct inode * igrab(struct inode *);
2906extern ino_t iunique(struct super_block *, ino_t);
2907extern int inode_needs_sync(struct inode *inode);
45321ac5 2908extern int generic_delete_inode(struct inode *inode);
9bcb4b73
AV
2909static inline int generic_drop_inode(struct inode *inode)
2910{
dae2f8ed
IW
2911 return !inode->i_nlink || inode_unhashed(inode) ||
2912 (inode->i_state & I_DONTCACHE);
9bcb4b73 2913}
2c567af4 2914extern void d_mark_dontcache(struct inode *inode);
1da177e4 2915
88bd5121
AA
2916extern struct inode *ilookup5_nowait(struct super_block *sb,
2917 unsigned long hashval, int (*test)(struct inode *, void *),
2918 void *data);
1da177e4
LT
2919extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2920 int (*test)(struct inode *, void *), void *data);
2921extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2922
80ea09a0
MS
2923extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
2924 int (*test)(struct inode *, void *),
2925 int (*set)(struct inode *, void *),
2926 void *data);
1da177e4
LT
2927extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2928extern struct inode * iget_locked(struct super_block *, unsigned long);
fe032c42
TT
2929extern struct inode *find_inode_nowait(struct super_block *,
2930 unsigned long,
2931 int (*match)(struct inode *,
2932 unsigned long, void *),
2933 void *data);
3f19b2ab
DH
2934extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
2935 int (*)(struct inode *, void *), void *);
2936extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
261bca86
AV
2937extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2938extern int insert_inode_locked(struct inode *);
e096d0c7
JB
2939#ifdef CONFIG_DEBUG_LOCK_ALLOC
2940extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2941#else
2942static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2943#endif
1da177e4 2944extern void unlock_new_inode(struct inode *);
c2b6d621 2945extern void discard_new_inode(struct inode *);
85fe4025 2946extern unsigned int get_next_ino(void);
799ea9e9 2947extern void evict_inodes(struct super_block *sb);
1da177e4 2948
e809d5f0
CD
2949/*
2950 * Userspace may rely on the the inode number being non-zero. For example, glibc
2951 * simply ignores files with zero i_ino in unlink() and other places.
2952 *
2953 * As an additional complication, if userspace was compiled with
2954 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
2955 * lower 32 bits, so we need to check that those aren't zero explicitly. With
2956 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
2957 * better safe than sorry.
2958 */
2959static inline bool is_zero_ino(ino_t ino)
2960{
2961 return (u32)ino == 0;
2962}
2963
1da177e4 2964extern void __iget(struct inode * inode);
b46980fe 2965extern void iget_failed(struct inode *);
dbd5768f 2966extern void clear_inode(struct inode *);
2e00c97e 2967extern void __destroy_inode(struct inode *);
a209dfc7
ED
2968extern struct inode *new_inode_pseudo(struct super_block *sb);
2969extern struct inode *new_inode(struct super_block *sb);
ff0c7d15 2970extern void free_inode_nonrcu(struct inode *inode);
01de85e0 2971extern int should_remove_suid(struct dentry *);
5fa8e0a1 2972extern int file_remove_privs(struct file *);
1da177e4
LT
2973
2974extern void __insert_inode_hash(struct inode *, unsigned long hashval);
646ec461
CH
2975static inline void insert_inode_hash(struct inode *inode)
2976{
1da177e4
LT
2977 __insert_inode_hash(inode, inode->i_ino);
2978}
f2ee7abf
ED
2979
2980extern void __remove_inode_hash(struct inode *);
2981static inline void remove_inode_hash(struct inode *inode)
2982{
cbedaac6 2983 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
f2ee7abf
ED
2984 __remove_inode_hash(inode);
2985}
2986
646ec461 2987extern void inode_sb_list_add(struct inode *inode);
1da177e4 2988
1da177e4
LT
2989extern int sb_set_blocksize(struct super_block *, int);
2990extern int sb_min_blocksize(struct super_block *, int);
2991
2992extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2993extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3309dd04 2994extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
1383a7ed
DW
2995extern int generic_remap_checks(struct file *file_in, loff_t pos_in,
2996 struct file *file_out, loff_t pos_out,
42ec3d4c 2997 loff_t *count, unsigned int remap_flags);
a3171351 2998extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
96e6e8f4
AG
2999extern int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3000 struct file *file_out, loff_t pos_out,
3001 size_t *count, unsigned int flags);
d85dc2e1
GR
3002extern ssize_t generic_file_buffered_read(struct kiocb *iocb,
3003 struct iov_iter *to, ssize_t already_read);
ed978a81 3004extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
8174202b 3005extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
8174202b 3006extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
1af5bb49 3007extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3b93f911 3008extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
88e6faef 3009
18e9710e 3010ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
ddef7ed2 3011 rwf_t flags);
abbb6589 3012ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
ddef7ed2 3013 rwf_t flags);
5dcdc43e
JX
3014ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
3015 struct iov_iter *iter);
3016ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
3017 struct iov_iter *iter);
dbe4e192 3018
eef99380 3019/* fs/block_dev.c */
b2de525f 3020extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
1456c0a8 3021extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
02c24a82
JB
3022extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3023 int datasync);
ff01bb48 3024extern void block_sync_page(struct page *page);
eef99380 3025
88e6faef 3026/* fs/splice.c */
cbb7e577 3027extern ssize_t generic_file_splice_read(struct file *, loff_t *,
88e6faef 3028 struct pipe_inode_info *, size_t, unsigned int);
8d020765 3029extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
cbb7e577 3030 struct file *, loff_t *, size_t, unsigned int);
88e6faef 3031extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
cbb7e577 3032 struct file *out, loff_t *, size_t len, unsigned int flags);
1c118596
MS
3033extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3034 loff_t *opos, size_t len, unsigned int flags);
3035
88e6faef 3036
1da177e4
LT
3037extern void
3038file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
965c8e59
AM
3039extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3040extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
46a1c2c7 3041extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
965c8e59 3042extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
5760495a 3043extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
965c8e59 3044 int whence, loff_t maxsize, loff_t eof);
1bf9d14d
AV
3045extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3046 int whence, loff_t size);
b25472f9
AV
3047extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3048extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
1da177e4
LT
3049extern int generic_file_open(struct inode * inode, struct file * filp);
3050extern int nonseekable_open(struct inode * inode, struct file * filp);
10dce8af 3051extern int stream_open(struct inode * inode, struct file * filp);
1da177e4 3052
9361401e 3053#ifdef CONFIG_BLOCK
8a4c1e42 3054typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
facd07b0 3055 loff_t file_offset);
1da177e4
LT
3056
3057enum {
1e431f5c
CH
3058 /* need locking between buffered and direct access */
3059 DIO_LOCKING = 0x01,
3060
3061 /* filesystem does not support filling holes */
3062 DIO_SKIP_HOLES = 0x02,
1da177e4
LT
3063};
3064
f1084bc6
DS
3065void dio_end_io(struct bio *bio);
3066
17f8c842
OS
3067ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3068 struct block_device *bdev, struct iov_iter *iter,
c8b8e32d 3069 get_block_t get_block,
17f8c842
OS
3070 dio_iodone_t end_io, dio_submit_t submit_io,
3071 int flags);
7bb46a67 3072
17f8c842
OS
3073static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3074 struct inode *inode,
c8b8e32d 3075 struct iov_iter *iter,
17f8c842 3076 get_block_t get_block)
1da177e4 3077{
17f8c842 3078 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
c8b8e32d 3079 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
1da177e4 3080}
9361401e 3081#endif
1da177e4 3082
1d59d61f 3083void inode_dio_wait(struct inode *inode);
fe0f07d0
JA
3084
3085/*
3086 * inode_dio_begin - signal start of a direct I/O requests
3087 * @inode: inode the direct I/O happens on
3088 *
3089 * This is called once we've finished processing a direct I/O request,
3090 * and is used to wake up callers waiting for direct I/O to be quiesced.
3091 */
3092static inline void inode_dio_begin(struct inode *inode)
3093{
3094 atomic_inc(&inode->i_dio_count);
3095}
3096
3097/*
3098 * inode_dio_end - signal finish of a direct I/O requests
3099 * @inode: inode the direct I/O happens on
3100 *
3101 * This is called once we've finished processing a direct I/O request,
3102 * and is used to wake up callers waiting for direct I/O to be quiesced.
3103 */
3104static inline void inode_dio_end(struct inode *inode)
3105{
3106 if (atomic_dec_and_test(&inode->i_dio_count))
3107 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3108}
1d59d61f 3109
a92853b6
KK
3110/*
3111 * Warn about a page cache invalidation failure diring a direct I/O write.
3112 */
3113void dio_warn_stale_pagecache(struct file *filp);
3114
5f16f322
TT
3115extern void inode_set_flags(struct inode *inode, unsigned int flags,
3116 unsigned int mask);
3117
4b6f5d20 3118extern const struct file_operations generic_ro_fops;
1da177e4
LT
3119
3120#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3121
5d826c84 3122extern int readlink_copy(char __user *, int, const char *);
1da177e4 3123extern int page_readlink(struct dentry *, char __user *, int);
fceef393
AV
3124extern const char *page_get_link(struct dentry *, struct inode *,
3125 struct delayed_call *);
3126extern void page_put_link(void *);
0adb25d2 3127extern int __page_symlink(struct inode *inode, const char *symname, int len,
54566b2c 3128 int nofs);
1da177e4 3129extern int page_symlink(struct inode *inode, const char *symname, int len);
c5ef1c42 3130extern const struct inode_operations page_symlink_inode_operations;
fceef393 3131extern void kfree_link(void *);
1da177e4 3132extern void generic_fillattr(struct inode *, struct kstat *);
a528d35e
DH
3133extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3134extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
b462707e 3135void __inode_add_bytes(struct inode *inode, loff_t bytes);
1da177e4 3136void inode_add_bytes(struct inode *inode, loff_t bytes);
1c8924eb 3137void __inode_sub_bytes(struct inode *inode, loff_t bytes);
1da177e4 3138void inode_sub_bytes(struct inode *inode, loff_t bytes);
f4a8116a
JK
3139static inline loff_t __inode_get_bytes(struct inode *inode)
3140{
3141 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3142}
1da177e4
LT
3143loff_t inode_get_bytes(struct inode *inode);
3144void inode_set_bytes(struct inode *inode, loff_t bytes);
fceef393
AV
3145const char *simple_get_link(struct dentry *, struct inode *,
3146 struct delayed_call *);
61ba64fc 3147extern const struct inode_operations simple_symlink_inode_operations;
1da177e4 3148
5c0ba4e0 3149extern int iterate_dir(struct file *, struct dir_context *);
1da177e4 3150
a528d35e
DH
3151extern int vfs_statx(int, const char __user *, int, struct kstat *, u32);
3152extern int vfs_statx_fd(unsigned int, struct kstat *, u32, unsigned int);
3153
3154static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3155{
deccf497
DH
3156 return vfs_statx(AT_FDCWD, filename, AT_NO_AUTOMOUNT,
3157 stat, STATX_BASIC_STATS);
a528d35e
DH
3158}
3159static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3160{
deccf497 3161 return vfs_statx(AT_FDCWD, name, AT_SYMLINK_NOFOLLOW | AT_NO_AUTOMOUNT,
a528d35e
DH
3162 stat, STATX_BASIC_STATS);
3163}
3164static inline int vfs_fstatat(int dfd, const char __user *filename,
3165 struct kstat *stat, int flags)
3166{
5d38f049
IK
3167 return vfs_statx(dfd, filename, flags | AT_NO_AUTOMOUNT,
3168 stat, STATX_BASIC_STATS);
a528d35e
DH
3169}
3170static inline int vfs_fstat(int fd, struct kstat *stat)
3171{
3172 return vfs_statx_fd(fd, stat, STATX_BASIC_STATS, 0);
3173}
3174
3175
d60874cd 3176extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
fd4a0edf 3177extern int vfs_readlink(struct dentry *, char __user *, int);
1da177e4 3178
ee416bcd 3179extern struct file_system_type *get_filesystem(struct file_system_type *fs);
c18479fe 3180extern void put_filesystem(struct file_system_type *fs);
1da177e4
LT
3181extern struct file_system_type *get_fs_type(const char *name);
3182extern struct super_block *get_super(struct block_device *);
6b6dc836 3183extern struct super_block *get_super_thawed(struct block_device *);
ba6379f7 3184extern struct super_block *get_super_exclusive_thawed(struct block_device *bdev);
4504230a 3185extern struct super_block *get_active_super(struct block_device *bdev);
1da177e4 3186extern void drop_super(struct super_block *sb);
ba6379f7 3187extern void drop_super_exclusive(struct super_block *sb);
01a05b33 3188extern void iterate_supers(void (*)(struct super_block *, void *), void *);
43e15cdb
AV
3189extern void iterate_supers_type(struct file_system_type *,
3190 void (*)(struct super_block *, void *), void *);
1da177e4
LT
3191
3192extern int dcache_dir_open(struct inode *, struct file *);
3193extern int dcache_dir_close(struct inode *, struct file *);
3194extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
5f99f4e7 3195extern int dcache_readdir(struct file *, struct dir_context *);
7bb46a67 3196extern int simple_setattr(struct dentry *, struct iattr *);
a528d35e 3197extern int simple_getattr(const struct path *, struct kstat *, u32, unsigned int);
726c3342 3198extern int simple_statfs(struct dentry *, struct kstatfs *);
20955e89 3199extern int simple_open(struct inode *inode, struct file *file);
1da177e4
LT
3200extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3201extern int simple_unlink(struct inode *, struct dentry *);
3202extern int simple_rmdir(struct inode *, struct dentry *);
e0e0be8a
MS
3203extern int simple_rename(struct inode *, struct dentry *,
3204 struct inode *, struct dentry *, unsigned int);
a3d1e7eb
AV
3205extern void simple_recursive_removal(struct dentry *,
3206 void (*callback)(struct dentry *));
02c24a82 3207extern int noop_fsync(struct file *, loff_t, loff_t, int);
f44c7763
DW
3208extern int noop_set_page_dirty(struct page *page);
3209extern void noop_invalidatepage(struct page *page, unsigned int offset,
3210 unsigned int length);
3211extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
1da177e4
LT
3212extern int simple_empty(struct dentry *);
3213extern int simple_readpage(struct file *file, struct page *page);
afddba49
NP
3214extern int simple_write_begin(struct file *file, struct address_space *mapping,
3215 loff_t pos, unsigned len, unsigned flags,
3216 struct page **pagep, void **fsdata);
3217extern int simple_write_end(struct file *file, struct address_space *mapping,
3218 loff_t pos, unsigned len, unsigned copied,
3219 struct page *page, void *fsdata);
b26d4cd3 3220extern int always_delete_dentry(const struct dentry *);
6987843f 3221extern struct inode *alloc_anon_inode(struct super_block *);
e6f5c789 3222extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
b26d4cd3 3223extern const struct dentry_operations simple_dentry_operations;
1da177e4 3224
00cd8dd3 3225extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
1da177e4 3226extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
4b6f5d20 3227extern const struct file_operations simple_dir_operations;
c5ef1c42 3228extern const struct inode_operations simple_dir_inode_operations;
fbabfd0f
EB
3229extern void make_empty_dir_inode(struct inode *inode);
3230extern bool is_empty_dir_inode(struct inode *inode);
cda37124 3231struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
1da177e4 3232struct dentry *d_alloc_name(struct dentry *, const char *);
cda37124
EB
3233extern int simple_fill_super(struct super_block *, unsigned long,
3234 const struct tree_descr *);
1f5ce9e9 3235extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
1da177e4
LT
3236extern void simple_release_fs(struct vfsmount **mount, int *count);
3237
93b07113
AM
3238extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3239 loff_t *ppos, const void *from, size_t available);
6a727b43
JS
3240extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3241 const void __user *from, size_t count);
1da177e4 3242
ac13a829 3243extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
02c24a82 3244extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
d5aacad5 3245
30ca22c7
PL
3246extern int generic_check_addressable(unsigned, u64);
3247
e965f963 3248#ifdef CONFIG_MIGRATION
2d1db3b1 3249extern int buffer_migrate_page(struct address_space *,
a6bc32b8
MG
3250 struct page *, struct page *,
3251 enum migrate_mode);
89cb0888
JK
3252extern int buffer_migrate_page_norefs(struct address_space *,
3253 struct page *, struct page *,
3254 enum migrate_mode);
e965f963
CL
3255#else
3256#define buffer_migrate_page NULL
89cb0888 3257#define buffer_migrate_page_norefs NULL
e965f963
CL
3258#endif
3259
31051c85 3260extern int setattr_prepare(struct dentry *, struct iattr *);
25d9e2d1 3261extern int inode_newsize_ok(const struct inode *, loff_t offset);
6a1a90ad 3262extern void setattr_copy(struct inode *inode, const struct iattr *attr);
1da177e4 3263
c3b2da31 3264extern int file_update_time(struct file *file);
1da177e4 3265
f05a3849 3266static inline bool vma_is_dax(const struct vm_area_struct *vma)
baabda26
DW
3267{
3268 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3269}
3270
2bb6d283
DW
3271static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3272{
3273 struct inode *inode;
3274
3275 if (!vma->vm_file)
3276 return false;
3277 if (!vma_is_dax(vma))
3278 return false;
3279 inode = file_inode(vma->vm_file);
230f5a89 3280 if (S_ISCHR(inode->i_mode))
2bb6d283
DW
3281 return false; /* device-dax */
3282 return true;
3283}
3284
2ba48ce5
AV
3285static inline int iocb_flags(struct file *file)
3286{
3287 int res = 0;
3288 if (file->f_flags & O_APPEND)
3289 res |= IOCB_APPEND;
efbe3c24 3290 if (file->f_flags & O_DIRECT)
2ba48ce5 3291 res |= IOCB_DIRECT;
dde0c2e7
CH
3292 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3293 res |= IOCB_DSYNC;
3294 if (file->f_flags & __O_SYNC)
3295 res |= IOCB_SYNC;
2ba48ce5
AV
3296 return res;
3297}
3298
ddef7ed2 3299static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
fdd2f5b7 3300{
1752f0ad
PB
3301 int kiocb_flags = 0;
3302
3303 if (!flags)
3304 return 0;
fdd2f5b7
GR
3305 if (unlikely(flags & ~RWF_SUPPORTED))
3306 return -EOPNOTSUPP;
3307
b745fafa 3308 if (flags & RWF_NOWAIT) {
91f9943e 3309 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
b745fafa 3310 return -EOPNOTSUPP;
1752f0ad 3311 kiocb_flags |= IOCB_NOWAIT;
b745fafa 3312 }
fdd2f5b7 3313 if (flags & RWF_HIPRI)
1752f0ad 3314 kiocb_flags |= IOCB_HIPRI;
fdd2f5b7 3315 if (flags & RWF_DSYNC)
1752f0ad 3316 kiocb_flags |= IOCB_DSYNC;
fdd2f5b7 3317 if (flags & RWF_SYNC)
1752f0ad 3318 kiocb_flags |= (IOCB_DSYNC | IOCB_SYNC);
e1fc742e 3319 if (flags & RWF_APPEND)
1752f0ad
PB
3320 kiocb_flags |= IOCB_APPEND;
3321
3322 ki->ki_flags |= kiocb_flags;
fdd2f5b7
GR
3323 return 0;
3324}
3325
1da177e4
LT
3326static inline ino_t parent_ino(struct dentry *dentry)
3327{
3328 ino_t res;
3329
b5c84bf6
NP
3330 /*
3331 * Don't strictly need d_lock here? If the parent ino could change
3332 * then surely we'd have a deeper race in the caller?
3333 */
1da177e4
LT
3334 spin_lock(&dentry->d_lock);
3335 res = dentry->d_parent->d_inode->i_ino;
3336 spin_unlock(&dentry->d_lock);
3337 return res;
3338}
3339
1da177e4
LT
3340/* Transaction based IO helpers */
3341
3342/*
3343 * An argresp is stored in an allocated page and holds the
3344 * size of the argument or response, along with its content
3345 */
3346struct simple_transaction_argresp {
3347 ssize_t size;
3348 char data[0];
3349};
3350
3351#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3352
3353char *simple_transaction_get(struct file *file, const char __user *buf,
3354 size_t size);
3355ssize_t simple_transaction_read(struct file *file, char __user *buf,
3356 size_t size, loff_t *pos);
3357int simple_transaction_release(struct inode *inode, struct file *file);
3358
76791ab2 3359void simple_transaction_set(struct file *file, size_t n);
1da177e4 3360
acaefc25
AB
3361/*
3362 * simple attribute files
3363 *
3364 * These attributes behave similar to those in sysfs:
3365 *
3366 * Writing to an attribute immediately sets a value, an open file can be
3367 * written to multiple times.
3368 *
3369 * Reading from an attribute creates a buffer from the value that might get
3370 * read with multiple read calls. When the attribute has been read
3371 * completely, no further read calls are possible until the file is opened
3372 * again.
3373 *
3374 * All attributes contain a text representation of a numeric value
3375 * that are accessed with the get() and set() functions.
3376 */
3377#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3378static int __fops ## _open(struct inode *inode, struct file *file) \
3379{ \
3380 __simple_attr_check_format(__fmt, 0ull); \
3381 return simple_attr_open(inode, file, __get, __set, __fmt); \
3382} \
828c0950 3383static const struct file_operations __fops = { \
acaefc25
AB
3384 .owner = THIS_MODULE, \
3385 .open = __fops ## _open, \
74bedc4d 3386 .release = simple_attr_release, \
acaefc25
AB
3387 .read = simple_attr_read, \
3388 .write = simple_attr_write, \
1ec5584e 3389 .llseek = generic_file_llseek, \
68be3029 3390}
acaefc25 3391
b9075fa9
JP
3392static inline __printf(1, 2)
3393void __simple_attr_check_format(const char *fmt, ...)
acaefc25
AB
3394{
3395 /* don't do anything, just let the compiler check the arguments; */
3396}
3397
3398int simple_attr_open(struct inode *inode, struct file *file,
8b88b099 3399 int (*get)(void *, u64 *), int (*set)(void *, u64),
acaefc25 3400 const char *fmt);
74bedc4d 3401int simple_attr_release(struct inode *inode, struct file *file);
acaefc25
AB
3402ssize_t simple_attr_read(struct file *file, char __user *buf,
3403 size_t len, loff_t *ppos);
3404ssize_t simple_attr_write(struct file *file, const char __user *buf,
3405 size_t len, loff_t *ppos);
3406
4be28540 3407struct ctl_table;
8d65af78 3408int proc_nr_files(struct ctl_table *table, int write,
32927393 3409 void *buffer, size_t *lenp, loff_t *ppos);
312d3ca8 3410int proc_nr_dentry(struct ctl_table *table, int write,
32927393 3411 void *buffer, size_t *lenp, loff_t *ppos);
cffbc8aa 3412int proc_nr_inodes(struct ctl_table *table, int write,
32927393 3413 void *buffer, size_t *lenp, loff_t *ppos);
38e23c95 3414int __init get_filesystem_list(char *buf);
62239ac2 3415
3cd90ea4 3416#define __FMODE_EXEC ((__force int) FMODE_EXEC)
1a44bc8c
NK
3417#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3418
6d125529 3419#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
ecf081d1 3420#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
1a44bc8c 3421 (flag & __FMODE_NONOTIFY)))
5300990c 3422
d37177ba 3423static inline bool is_sxid(umode_t mode)
69b45732
AK
3424{
3425 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3426}
3427
cbdf35bc
MS
3428static inline int check_sticky(struct inode *dir, struct inode *inode)
3429{
3430 if (!(dir->i_mode & S_ISVTX))
3431 return 0;
3432
3433 return __check_sticky(dir, inode);
3434}
3435
69b45732
AK
3436static inline void inode_has_no_xattr(struct inode *inode)
3437{
e462ec50 3438 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
69b45732
AK
3439 inode->i_flags |= S_NOSEC;
3440}
3441
a7400222
AV
3442static inline bool is_root_inode(struct inode *inode)
3443{
3444 return inode == inode->i_sb->s_root->d_inode;
3445}
3446
5f99f4e7
AV
3447static inline bool dir_emit(struct dir_context *ctx,
3448 const char *name, int namelen,
3449 u64 ino, unsigned type)
3450{
3451 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3452}
3453static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3454{
3455 return ctx->actor(ctx, ".", 1, ctx->pos,
3456 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3457}
3458static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3459{
3460 return ctx->actor(ctx, "..", 2, ctx->pos,
3461 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3462}
3463static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3464{
3465 if (ctx->pos == 0) {
3466 if (!dir_emit_dot(file, ctx))
3467 return false;
3468 ctx->pos = 1;
3469 }
3470 if (ctx->pos == 1) {
3471 if (!dir_emit_dotdot(file, ctx))
3472 return false;
3473 ctx->pos = 2;
3474 }
3475 return true;
3476}
5ded75ec
AV
3477static inline bool dir_relax(struct inode *inode)
3478{
5955102c
AV
3479 inode_unlock(inode);
3480 inode_lock(inode);
5ded75ec
AV
3481 return !IS_DEADDIR(inode);
3482}
5f99f4e7 3483
ae05327a
AV
3484static inline bool dir_relax_shared(struct inode *inode)
3485{
3486 inode_unlock_shared(inode);
3487 inode_lock_shared(inode);
3488 return !IS_DEADDIR(inode);
3489}
3490
90f8572b 3491extern bool path_noexec(const struct path *path);
21fc61c7 3492extern void inode_nohighmem(struct inode *inode);
90f8572b 3493
45cd0faa
AG
3494/* mm/fadvise.c */
3495extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3496 int advice);
cf1ea059
JK
3497extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3498 int advice);
45cd0faa 3499
2b188cc1
JA
3500#if defined(CONFIG_IO_URING)
3501extern struct sock *io_uring_get_socket(struct file *file);
3502#else
3503static inline struct sock *io_uring_get_socket(struct file *file)
3504{
3505 return NULL;
3506}
3507#endif
3508
5aca2842
DW
3509int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3510 unsigned int flags);
3511
7b0e492e
DW
3512int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3513 struct fsxattr *fa);
3514
3515static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3516{
3517 memset(fa, 0, sizeof(*fa));
3518 fa->fsx_xflags = xflags;
3519}
3520
dc617f29
DW
3521/*
3522 * Flush file data before changing attributes. Caller must hold any locks
3523 * required to prevent further writes to this file until we're done setting
3524 * flags.
3525 */
3526static inline int inode_drain_writes(struct inode *inode)
3527{
3528 inode_dio_wait(inode);
3529 return filemap_write_and_wait(inode->i_mapping);
3530}
3531
1da177e4 3532#endif /* _LINUX_FS_H */