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