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