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