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