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