]> git.ipfire.org Git - thirdparty/linux.git/blame - include/linux/fs.h
fs: document and rename fsid helpers
[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
1bd66c1a
CB
1577/**
1578 * kuid_into_mnt - map a kuid down into a mnt_userns
1579 * @mnt_userns: user namespace of the relevant mount
1580 * @kuid: kuid to be mapped
1581 *
1582 * Return: @kuid mapped according to @mnt_userns.
1583 * If @kuid has no mapping INVALID_UID is returned.
1584 */
e6c9a714
CB
1585static inline kuid_t kuid_into_mnt(struct user_namespace *mnt_userns,
1586 kuid_t kuid)
1587{
1588 return make_kuid(mnt_userns, __kuid_val(kuid));
1589}
1590
1bd66c1a
CB
1591/**
1592 * kgid_into_mnt - map a kgid down into a mnt_userns
1593 * @mnt_userns: user namespace of the relevant mount
1594 * @kgid: kgid to be mapped
1595 *
1596 * Return: @kgid mapped according to @mnt_userns.
1597 * If @kgid has no mapping INVALID_GID is returned.
1598 */
e6c9a714
CB
1599static inline kgid_t kgid_into_mnt(struct user_namespace *mnt_userns,
1600 kgid_t kgid)
1601{
1602 return make_kgid(mnt_userns, __kgid_val(kgid));
1603}
1604
1bd66c1a
CB
1605/**
1606 * i_uid_into_mnt - map an inode's i_uid down into a mnt_userns
1607 * @mnt_userns: user namespace of the mount the inode was found from
1608 * @inode: inode to map
1609 *
1610 * Return: the inode's i_uid mapped down according to @mnt_userns.
1611 * If the inode's i_uid has no mapping INVALID_UID is returned.
1612 */
e6c9a714
CB
1613static inline kuid_t i_uid_into_mnt(struct user_namespace *mnt_userns,
1614 const struct inode *inode)
1615{
1616 return kuid_into_mnt(mnt_userns, inode->i_uid);
1617}
1618
1bd66c1a
CB
1619/**
1620 * i_gid_into_mnt - map an inode's i_gid down into a mnt_userns
1621 * @mnt_userns: user namespace of the mount the inode was found from
1622 * @inode: inode to map
1623 *
1624 * Return: the inode's i_gid mapped down according to @mnt_userns.
1625 * If the inode's i_gid has no mapping INVALID_GID is returned.
1626 */
e6c9a714
CB
1627static inline kgid_t i_gid_into_mnt(struct user_namespace *mnt_userns,
1628 const struct inode *inode)
1629{
1630 return kgid_into_mnt(mnt_userns, inode->i_gid);
1631}
1632
1bd66c1a
CB
1633/**
1634 * kuid_from_mnt - map a kuid up into a mnt_userns
1635 * @mnt_userns: user namespace of the relevant mount
1636 * @kuid: kuid to be mapped
1637 *
1638 * Return: @kuid mapped up according to @mnt_userns.
1639 * If @kuid has no mapping INVALID_UID is returned.
1640 */
e6c9a714
CB
1641static inline kuid_t kuid_from_mnt(struct user_namespace *mnt_userns,
1642 kuid_t kuid)
1643{
1644 return KUIDT_INIT(from_kuid(mnt_userns, kuid));
1645}
1646
1bd66c1a
CB
1647/**
1648 * kgid_from_mnt - map a kgid up into a mnt_userns
1649 * @mnt_userns: user namespace of the relevant mount
1650 * @kgid: kgid to be mapped
1651 *
1652 * Return: @kgid mapped up according to @mnt_userns.
1653 * If @kgid has no mapping INVALID_GID is returned.
1654 */
e6c9a714
CB
1655static inline kgid_t kgid_from_mnt(struct user_namespace *mnt_userns,
1656 kgid_t kgid)
1657{
1658 return KGIDT_INIT(from_kgid(mnt_userns, kgid));
1659}
1660
a65e58e7
CB
1661/**
1662 * mapped_fsuid - return caller's fsuid mapped up into a mnt_userns
1663 * @mnt_userns: user namespace of the relevant mount
1664 *
1665 * Use this helper to initialize a new vfs or filesystem object based on
1666 * the caller's fsuid. A common example is initializing the i_uid field of
1667 * a newly allocated inode triggered by a creation event such as mkdir or
1668 * O_CREAT. Other examples include the allocation of quotas for a specific
1669 * user.
1670 *
1671 * Return: the caller's current fsuid mapped up according to @mnt_userns.
1672 */
1673static inline kuid_t mapped_fsuid(struct user_namespace *mnt_userns)
e6c9a714
CB
1674{
1675 return kuid_from_mnt(mnt_userns, current_fsuid());
1676}
1677
a65e58e7
CB
1678/**
1679 * mapped_fsgid - return caller's fsgid mapped up into a mnt_userns
1680 * @mnt_userns: user namespace of the relevant mount
1681 *
1682 * Use this helper to initialize a new vfs or filesystem object based on
1683 * the caller's fsgid. A common example is initializing the i_gid field of
1684 * a newly allocated inode triggered by a creation event such as mkdir or
1685 * O_CREAT. Other examples include the allocation of quotas for a specific
1686 * user.
1687 *
1688 * Return: the caller's current fsgid mapped up according to @mnt_userns.
1689 */
1690static inline kgid_t mapped_fsgid(struct user_namespace *mnt_userns)
e6c9a714
CB
1691{
1692 return kgid_from_mnt(mnt_userns, current_fsgid());
1693}
1694
95582b00 1695extern struct timespec64 current_time(struct inode *inode);
1da177e4
LT
1696
1697/*
1698 * Snapshotting support.
1699 */
1da177e4 1700
9b852342
DW
1701/*
1702 * These are internal functions, please use sb_start_{write,pagefault,intwrite}
1703 * instead.
1704 */
1705static inline void __sb_end_write(struct super_block *sb, int level)
1706{
1707 percpu_up_read(sb->s_writers.rw_sem + level-1);
1708}
1709
1710static inline void __sb_start_write(struct super_block *sb, int level)
1711{
1712 percpu_down_read(sb->s_writers.rw_sem + level - 1);
1713}
1714
1715static inline bool __sb_start_write_trylock(struct super_block *sb, int level)
1716{
1717 return percpu_down_read_trylock(sb->s_writers.rw_sem + level - 1);
1718}
5accdf82 1719
bee9182d 1720#define __sb_writers_acquired(sb, lev) \
8129ed29 1721 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
bee9182d 1722#define __sb_writers_release(sb, lev) \
8129ed29 1723 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
bee9182d 1724
5accdf82
JK
1725/**
1726 * sb_end_write - drop write access to a superblock
1727 * @sb: the super we wrote to
1728 *
1729 * Decrement number of writers to the filesystem. Wake up possible waiters
1730 * wanting to freeze the filesystem.
1731 */
1732static inline void sb_end_write(struct super_block *sb)
1733{
1734 __sb_end_write(sb, SB_FREEZE_WRITE);
1735}
1736
1737/**
1738 * sb_end_pagefault - drop write access to a superblock from a page fault
1739 * @sb: the super we wrote to
1740 *
1741 * Decrement number of processes handling write page fault to the filesystem.
1742 * Wake up possible waiters wanting to freeze the filesystem.
1743 */
1744static inline void sb_end_pagefault(struct super_block *sb)
1745{
1746 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1747}
1748
1749/**
1750 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1751 * @sb: the super we wrote to
1752 *
1753 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1754 * waiters wanting to freeze the filesystem.
1755 */
1756static inline void sb_end_intwrite(struct super_block *sb)
1757{
1758 __sb_end_write(sb, SB_FREEZE_FS);
1759}
1760
1761/**
1762 * sb_start_write - get write access to a superblock
1763 * @sb: the super we write to
1764 *
1765 * When a process wants to write data or metadata to a file system (i.e. dirty
1766 * a page or an inode), it should embed the operation in a sb_start_write() -
1767 * sb_end_write() pair to get exclusion against file system freezing. This
1768 * function increments number of writers preventing freezing. If the file
1769 * system is already frozen, the function waits until the file system is
1770 * thawed.
1771 *
1772 * Since freeze protection behaves as a lock, users have to preserve
1773 * ordering of freeze protection and other filesystem locks. Generally,
1774 * freeze protection should be the outermost lock. In particular, we have:
1775 *
1776 * sb_start_write
1777 * -> i_mutex (write path, truncate, directory ops, ...)
1778 * -> s_umount (freeze_super, thaw_super)
1779 */
1780static inline void sb_start_write(struct super_block *sb)
1781{
8a3c84b6 1782 __sb_start_write(sb, SB_FREEZE_WRITE);
5accdf82
JK
1783}
1784
8a3c84b6 1785static inline bool sb_start_write_trylock(struct super_block *sb)
5accdf82 1786{
8a3c84b6 1787 return __sb_start_write_trylock(sb, SB_FREEZE_WRITE);
5accdf82
JK
1788}
1789
1790/**
1791 * sb_start_pagefault - get write access to a superblock from a page fault
1792 * @sb: the super we write to
1793 *
1794 * When a process starts handling write page fault, it should embed the
1795 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1796 * exclusion against file system freezing. This is needed since the page fault
1797 * is going to dirty a page. This function increments number of running page
1798 * faults preventing freezing. If the file system is already frozen, the
1799 * function waits until the file system is thawed.
1800 *
1801 * Since page fault freeze protection behaves as a lock, users have to preserve
1802 * ordering of freeze protection and other filesystem locks. It is advised to
c1e8d7c6 1803 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
5accdf82
JK
1804 * handling code implies lock dependency:
1805 *
c1e8d7c6 1806 * mmap_lock
5accdf82
JK
1807 * -> sb_start_pagefault
1808 */
1809static inline void sb_start_pagefault(struct super_block *sb)
1810{
8a3c84b6 1811 __sb_start_write(sb, SB_FREEZE_PAGEFAULT);
5accdf82
JK
1812}
1813
1814/*
1815 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1816 * @sb: the super we write to
1817 *
1818 * This is the third level of protection against filesystem freezing. It is
1819 * free for use by a filesystem. The only requirement is that it must rank
1820 * below sb_start_pagefault.
1821 *
1822 * For example filesystem can call sb_start_intwrite() when starting a
1823 * transaction which somewhat eases handling of freezing for internal sources
1824 * of filesystem changes (internal fs threads, discarding preallocation on file
1825 * close, etc.).
1826 */
1827static inline void sb_start_intwrite(struct super_block *sb)
1828{
8a3c84b6 1829 __sb_start_write(sb, SB_FREEZE_FS);
5accdf82 1830}
1da177e4 1831
8a3c84b6 1832static inline bool sb_start_intwrite_trylock(struct super_block *sb)
0c8e3fe3 1833{
8a3c84b6 1834 return __sb_start_write_trylock(sb, SB_FREEZE_FS);
0c8e3fe3
AG
1835}
1836
21cb47be
CB
1837bool inode_owner_or_capable(struct user_namespace *mnt_userns,
1838 const struct inode *inode);
3bd858ab 1839
1da177e4
LT
1840/*
1841 * VFS helper functions..
1842 */
6521f891
CB
1843int vfs_create(struct user_namespace *, struct inode *,
1844 struct dentry *, umode_t, bool);
1845int vfs_mkdir(struct user_namespace *, struct inode *,
1846 struct dentry *, umode_t);
1847int vfs_mknod(struct user_namespace *, struct inode *, struct dentry *,
1848 umode_t, dev_t);
1849int vfs_symlink(struct user_namespace *, struct inode *,
1850 struct dentry *, const char *);
1851int vfs_link(struct dentry *, struct user_namespace *, struct inode *,
1852 struct dentry *, struct inode **);
1853int vfs_rmdir(struct user_namespace *, struct inode *, struct dentry *);
1854int vfs_unlink(struct user_namespace *, struct inode *, struct dentry *,
1855 struct inode **);
9fe61450
CB
1856
1857struct renamedata {
6521f891 1858 struct user_namespace *old_mnt_userns;
9fe61450
CB
1859 struct inode *old_dir;
1860 struct dentry *old_dentry;
6521f891 1861 struct user_namespace *new_mnt_userns;
9fe61450
CB
1862 struct inode *new_dir;
1863 struct dentry *new_dentry;
1864 struct inode **delegated_inode;
1865 unsigned int flags;
1866} __randomize_layout;
a3c751a5 1867
9fe61450 1868int vfs_rename(struct renamedata *);
a3c751a5 1869
6521f891
CB
1870static inline int vfs_whiteout(struct user_namespace *mnt_userns,
1871 struct inode *dir, struct dentry *dentry)
a3c751a5 1872{
6521f891
CB
1873 return vfs_mknod(mnt_userns, dir, dentry, S_IFCHR | WHITEOUT_MODE,
1874 WHITEOUT_DEV);
a3c751a5 1875}
1da177e4 1876
6521f891
CB
1877struct dentry *vfs_tmpfile(struct user_namespace *mnt_userns,
1878 struct dentry *dentry, umode_t mode, int open_flag);
af7bd4dc 1879
8e6c848e
AV
1880int vfs_mkobj(struct dentry *, umode_t,
1881 int (*f)(struct dentry *, umode_t, void *),
1882 void *);
1883
c04011fe 1884int vfs_fchown(struct file *file, uid_t user, gid_t group);
9e96c8c0 1885int vfs_fchmod(struct file *file, umode_t mode);
fd5ad30c 1886int vfs_utimes(const struct path *path, struct timespec64 *times);
c04011fe 1887
9df6702a
MS
1888extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1889
2952db0f
AB
1890#ifdef CONFIG_COMPAT
1891extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
1892 unsigned long arg);
1893#else
1894#define compat_ptr_ioctl NULL
1895#endif
1896
8c744fb8
CH
1897/*
1898 * VFS file helper functions.
1899 */
21cb47be
CB
1900void inode_init_owner(struct user_namespace *mnt_userns, struct inode *inode,
1901 const struct inode *dir, umode_t mode);
a2982cc9 1902extern bool may_open_dev(const struct path *path);
c4b929b8 1903
1da177e4
LT
1904/*
1905 * This is the "filldir" function type, used by readdir() to let
1906 * the kernel specify what kind of dirent layout it wants to have.
1907 * This allows the kernel to read directories into kernel space or
1908 * to have different dirent layouts depending on the binary type.
1909 */
ac7576f4
MS
1910struct dir_context;
1911typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1912 unsigned);
1913
5c0ba4e0 1914struct dir_context {
a09acf4b 1915 filldir_t actor;
bb6f619b 1916 loff_t pos;
5c0ba4e0 1917};
bb6f619b 1918
b4caecd4
CH
1919/*
1920 * These flags let !MMU mmap() govern direct device mapping vs immediate
1921 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
1922 *
1923 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
1924 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
1925 * NOMMU_MAP_READ: Can be mapped for reading
1926 * NOMMU_MAP_WRITE: Can be mapped for writing
1927 * NOMMU_MAP_EXEC: Can be mapped for execution
1928 */
1929#define NOMMU_MAP_COPY 0x00000001
1930#define NOMMU_MAP_DIRECT 0x00000008
1931#define NOMMU_MAP_READ VM_MAYREAD
1932#define NOMMU_MAP_WRITE VM_MAYWRITE
1933#define NOMMU_MAP_EXEC VM_MAYEXEC
1934
1935#define NOMMU_VMFLAGS \
1936 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
1937
2e5dfc99
DW
1938/*
1939 * These flags control the behavior of the remap_file_range function pointer.
1940 * If it is called with len == 0 that means "remap to end of source file".
5c437fa2 1941 * See Documentation/filesystems/vfs.rst for more details about this call.
2e5dfc99
DW
1942 *
1943 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
eca3654e 1944 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
2e5dfc99
DW
1945 */
1946#define REMAP_FILE_DEDUP (1 << 0)
eca3654e 1947#define REMAP_FILE_CAN_SHORTEN (1 << 1)
2e5dfc99
DW
1948
1949/*
1950 * These flags signal that the caller is ok with altering various aspects of
1951 * the behavior of the remap operation. The changes must be made by the
1952 * implementation; the vfs remap helper functions can take advantage of them.
1953 * Flags in this category exist to preserve the quirky behavior of the hoisted
1954 * btrfs clone/dedupe ioctls.
2e5dfc99 1955 */
eca3654e 1956#define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
b4caecd4 1957
293bc982
AV
1958struct iov_iter;
1959
1da177e4
LT
1960struct file_operations {
1961 struct module *owner;
1962 loff_t (*llseek) (struct file *, loff_t, int);
1963 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1da177e4 1964 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
293bc982
AV
1965 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1966 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
fb7e1600 1967 int (*iopoll)(struct kiocb *kiocb, bool spin);
bb6f619b 1968 int (*iterate) (struct file *, struct dir_context *);
61922694 1969 int (*iterate_shared) (struct file *, struct dir_context *);
a3f8683b 1970 __poll_t (*poll) (struct file *, struct poll_table_struct *);
1da177e4
LT
1971 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1972 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1973 int (*mmap) (struct file *, struct vm_area_struct *);
1c972597 1974 unsigned long mmap_supported_flags;
1da177e4 1975 int (*open) (struct inode *, struct file *);
75e1fcc0 1976 int (*flush) (struct file *, fl_owner_t id);
1da177e4 1977 int (*release) (struct inode *, struct file *);
02c24a82 1978 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1da177e4
LT
1979 int (*fasync) (int, struct file *, int);
1980 int (*lock) (struct file *, int, struct file_lock *);
1da177e4
LT
1981 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1982 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1983 int (*check_flags)(int);
1da177e4 1984 int (*flock) (struct file *, int, struct file_lock *);
cbb7e577
JA
1985 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1986 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
e6f5c789 1987 int (*setlease)(struct file *, long, struct file_lock **, void **);
2fe17c10
CH
1988 long (*fallocate)(struct file *file, int mode, loff_t offset,
1989 loff_t len);
a3816ab0 1990 void (*show_fdinfo)(struct seq_file *m, struct file *f);
b4caecd4
CH
1991#ifndef CONFIG_MMU
1992 unsigned (*mmap_capabilities)(struct file *);
1993#endif
04b38d60
CH
1994 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
1995 loff_t, size_t, unsigned int);
42ec3d4c
DW
1996 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
1997 struct file *file_out, loff_t pos_out,
1998 loff_t len, unsigned int remap_flags);
45cd0faa 1999 int (*fadvise)(struct file *, loff_t, loff_t, int);
3859a271 2000} __randomize_layout;
1da177e4
LT
2001
2002struct inode_operations {
00cd8dd3 2003 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
fceef393 2004 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
549c7297 2005 int (*permission) (struct user_namespace *, struct inode *, int);
4e34e719 2006 struct posix_acl * (*get_acl)(struct inode *, int);
44a7d7a8
NP
2007
2008 int (*readlink) (struct dentry *, char __user *,int);
44a7d7a8 2009
549c7297
CB
2010 int (*create) (struct user_namespace *, struct inode *,struct dentry *,
2011 umode_t, bool);
1da177e4
LT
2012 int (*link) (struct dentry *,struct inode *,struct dentry *);
2013 int (*unlink) (struct inode *,struct dentry *);
549c7297
CB
2014 int (*symlink) (struct user_namespace *, struct inode *,struct dentry *,
2015 const char *);
2016 int (*mkdir) (struct user_namespace *, struct inode *,struct dentry *,
2017 umode_t);
1da177e4 2018 int (*rmdir) (struct inode *,struct dentry *);
549c7297
CB
2019 int (*mknod) (struct user_namespace *, struct inode *,struct dentry *,
2020 umode_t,dev_t);
2021 int (*rename) (struct user_namespace *, struct inode *, struct dentry *,
520c8b16 2022 struct inode *, struct dentry *, unsigned int);
549c7297
CB
2023 int (*setattr) (struct user_namespace *, struct dentry *,
2024 struct iattr *);
2025 int (*getattr) (struct user_namespace *, const struct path *,
2026 struct kstat *, u32, unsigned int);
1da177e4 2027 ssize_t (*listxattr) (struct dentry *, char *, size_t);
c4b929b8
MF
2028 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
2029 u64 len);
95582b00 2030 int (*update_time)(struct inode *, struct timespec64 *, int);
d9585277 2031 int (*atomic_open)(struct inode *, struct dentry *,
30d90494 2032 struct file *, unsigned open_flag,
44907d79 2033 umode_t create_mode);
549c7297
CB
2034 int (*tmpfile) (struct user_namespace *, struct inode *,
2035 struct dentry *, umode_t);
2036 int (*set_acl)(struct user_namespace *, struct inode *,
2037 struct posix_acl *, int);
44a7d7a8 2038} ____cacheline_aligned;
1da177e4 2039
bb7462b6
MS
2040static inline ssize_t call_read_iter(struct file *file, struct kiocb *kio,
2041 struct iov_iter *iter)
2042{
2043 return file->f_op->read_iter(kio, iter);
2044}
2045
2046static inline ssize_t call_write_iter(struct file *file, struct kiocb *kio,
2047 struct iov_iter *iter)
2048{
2049 return file->f_op->write_iter(kio, iter);
2050}
2051
f74ac015
MS
2052static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
2053{
2054 return file->f_op->mmap(file, vma);
2055}
2056
1da177e4
LT
2057extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
2058extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
29732938
ZB
2059extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
2060 loff_t, size_t, unsigned int);
f16acc9d
DC
2061extern ssize_t generic_copy_file_range(struct file *file_in, loff_t pos_in,
2062 struct file *file_out, loff_t pos_out,
2063 size_t len, unsigned int flags);
a83ab01a
DW
2064extern int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
2065 struct file *file_out, loff_t pos_out,
42ec3d4c
DW
2066 loff_t *count,
2067 unsigned int remap_flags);
2068extern loff_t do_clone_file_range(struct file *file_in, loff_t pos_in,
2069 struct file *file_out, loff_t pos_out,
452ce659 2070 loff_t len, unsigned int remap_flags);
42ec3d4c
DW
2071extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
2072 struct file *file_out, loff_t pos_out,
452ce659 2073 loff_t len, unsigned int remap_flags);
54dbc151
DW
2074extern int vfs_dedupe_file_range(struct file *file,
2075 struct file_dedupe_range *same);
42ec3d4c
DW
2076extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
2077 struct file *dst_file, loff_t dst_pos,
df365836 2078 loff_t len, unsigned int remap_flags);
f1825366 2079
1da177e4 2080
1da177e4
LT
2081struct super_operations {
2082 struct inode *(*alloc_inode)(struct super_block *sb);
2083 void (*destroy_inode)(struct inode *);
fdb0da89 2084 void (*free_inode)(struct inode *);
1da177e4 2085
aa385729 2086 void (*dirty_inode) (struct inode *, int flags);
a9185b41 2087 int (*write_inode) (struct inode *, struct writeback_control *wbc);
45321ac5 2088 int (*drop_inode) (struct inode *);
be7ce416 2089 void (*evict_inode) (struct inode *);
1da177e4 2090 void (*put_super) (struct super_block *);
1da177e4 2091 int (*sync_fs)(struct super_block *sb, int wait);
48b6bca6 2092 int (*freeze_super) (struct super_block *);
c4be0c1d 2093 int (*freeze_fs) (struct super_block *);
48b6bca6 2094 int (*thaw_super) (struct super_block *);
c4be0c1d 2095 int (*unfreeze_fs) (struct super_block *);
726c3342 2096 int (*statfs) (struct dentry *, struct kstatfs *);
1da177e4 2097 int (*remount_fs) (struct super_block *, int *, char *);
42faad99 2098 void (*umount_begin) (struct super_block *);
1da177e4 2099
34c80b1d 2100 int (*show_options)(struct seq_file *, struct dentry *);
d861c630 2101 int (*show_devname)(struct seq_file *, struct dentry *);
a6322de6 2102 int (*show_path)(struct seq_file *, struct dentry *);
64132379 2103 int (*show_stats)(struct seq_file *, struct dentry *);
0e51a720 2104#ifdef CONFIG_QUOTA
1da177e4
LT
2105 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
2106 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
2d0fa467 2107 struct dquot **(*get_dquots)(struct inode *);
0e51a720 2108#endif
87d8fe1e 2109 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
4101b624
VD
2110 long (*nr_cached_objects)(struct super_block *,
2111 struct shrink_control *);
2112 long (*free_cached_objects)(struct super_block *,
2113 struct shrink_control *);
1da177e4
LT
2114};
2115
bbc1096a
DH
2116/*
2117 * Inode flags - they have no relation to superblock flags now
2118 */
6414e9b0
EB
2119#define S_SYNC (1 << 0) /* Writes are synced at once */
2120#define S_NOATIME (1 << 1) /* Do not update access times */
2121#define S_APPEND (1 << 2) /* Append-only file */
2122#define S_IMMUTABLE (1 << 3) /* Immutable file */
2123#define S_DEAD (1 << 4) /* removed, but still open directory */
2124#define S_NOQUOTA (1 << 5) /* Inode is not counted to quota */
2125#define S_DIRSYNC (1 << 6) /* Directory modifications are synchronous */
2126#define S_NOCMTIME (1 << 7) /* Do not update file c/mtime */
2127#define S_SWAPFILE (1 << 8) /* Do not truncate: swapon got its bmaps */
2128#define S_PRIVATE (1 << 9) /* Inode is fs-internal */
2129#define S_IMA (1 << 10) /* Inode has an associated IMA struct */
2130#define S_AUTOMOUNT (1 << 11) /* Automount/referral quasi-directory */
2131#define S_NOSEC (1 << 12) /* no suid or xattr security attributes */
6cd176a5 2132#ifdef CONFIG_FS_DAX
6414e9b0 2133#define S_DAX (1 << 13) /* Direct Access, avoiding the page cache */
fbbbad4b 2134#else
6414e9b0 2135#define S_DAX 0 /* Make all the DAX code disappear */
fbbbad4b 2136#endif
6414e9b0
EB
2137#define S_ENCRYPTED (1 << 14) /* Encrypted file (using fs/crypto/) */
2138#define S_CASEFOLD (1 << 15) /* Casefolded file */
2139#define S_VERITY (1 << 16) /* Verity file (using fs/verity/) */
bbc1096a
DH
2140
2141/*
2142 * Note that nosuid etc flags are inode-specific: setting some file-system
2143 * flags just means all the inodes inherit those flags by default. It might be
2144 * possible to override it selectively if you really wanted to with some
2145 * ioctl() that is not currently implemented.
2146 *
e462ec50 2147 * Exception: SB_RDONLY is always applied to the entire file system.
bbc1096a
DH
2148 *
2149 * Unfortunately, it is possible to change a filesystems flags with it mounted
2150 * with files in use. This means that all of the inodes will not have their
2151 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
2152 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
2153 */
2154#define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
2155
1751e8a6 2156static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
94e92e7a 2157#define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
e462ec50 2158#define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
bbc1096a 2159 ((inode)->i_flags & S_SYNC))
e462ec50 2160#define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
bbc1096a 2161 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
e462ec50
DH
2162#define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
2163#define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
2164#define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
bbc1096a
DH
2165
2166#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
2167#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
2168#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
e462ec50 2169#define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
bbc1096a
DH
2170
2171#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2172#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2173#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2174#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2175#define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2176#define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2177#define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
fbbbad4b 2178#define IS_DAX(inode) ((inode)->i_flags & S_DAX)
2ee6a576 2179#define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
b886ee3e 2180#define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
5585f2af 2181#define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
bbc1096a 2182
787fb6bc
MS
2183#define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2184 (inode)->i_rdev == WHITEOUT_DEV)
2185
ba73d987
CB
2186static inline bool HAS_UNMAPPED_ID(struct user_namespace *mnt_userns,
2187 struct inode *inode)
0bd23d09 2188{
ba73d987
CB
2189 return !uid_valid(i_uid_into_mnt(mnt_userns, inode)) ||
2190 !gid_valid(i_gid_into_mnt(mnt_userns, inode));
0bd23d09
EB
2191}
2192
c75b1d94
JA
2193static inline enum rw_hint file_write_hint(struct file *file)
2194{
2195 if (file->f_write_hint != WRITE_LIFE_NOT_SET)
2196 return file->f_write_hint;
2197
2198 return file_inode(file)->i_write_hint;
2199}
2200
2201static inline int iocb_flags(struct file *file);
2202
fc28724d
AM
2203static inline u16 ki_hint_validate(enum rw_hint hint)
2204{
2205 typeof(((struct kiocb *)0)->ki_hint) max_hint = -1;
2206
2207 if (hint <= max_hint)
2208 return hint;
2209 return 0;
2210}
2211
c75b1d94
JA
2212static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2213{
2214 *kiocb = (struct kiocb) {
2215 .ki_filp = filp,
2216 .ki_flags = iocb_flags(filp),
fc28724d 2217 .ki_hint = ki_hint_validate(file_write_hint(filp)),
20578bdf 2218 .ki_ioprio = get_current_ioprio(),
c75b1d94
JA
2219 };
2220}
2221
5dcdc43e
JX
2222static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2223 struct file *filp)
2224{
2225 *kiocb = (struct kiocb) {
2226 .ki_filp = filp,
2227 .ki_flags = kiocb_src->ki_flags,
2228 .ki_hint = kiocb_src->ki_hint,
2229 .ki_ioprio = kiocb_src->ki_ioprio,
2230 .ki_pos = kiocb_src->ki_pos,
2231 };
2232}
2233
1c0eeaf5 2234/*
250df6ed 2235 * Inode state bits. Protected by inode->i_lock
1c0eeaf5 2236 *
1e9d6333
EB
2237 * Four bits determine the dirty state of the inode: I_DIRTY_SYNC,
2238 * I_DIRTY_DATASYNC, I_DIRTY_PAGES, and I_DIRTY_TIME.
1c0eeaf5
JE
2239 *
2240 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2241 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2242 * various stages of removing an inode.
2243 *
eaff8079 2244 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1c0eeaf5 2245 *
e7ca2d41 2246 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1e9d6333
EB
2247 * fdatasync() (unless I_DIRTY_DATASYNC is also set).
2248 * Timestamp updates are the usual cause.
2249 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
000cb48e
JK
2250 * these changes separately from I_DIRTY_SYNC so that we
2251 * don't have to write inode on fdatasync() when only
1e9d6333 2252 * e.g. the timestamps have changed.
1c0eeaf5 2253 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
1e9d6333
EB
2254 * I_DIRTY_TIME The inode itself only has dirty timestamps, and the
2255 * lazytime mount option is enabled. We keep track of this
2256 * separately from I_DIRTY_SYNC in order to implement
2257 * lazytime. This gets cleared if I_DIRTY_INODE
2258 * (I_DIRTY_SYNC and/or I_DIRTY_DATASYNC) gets set. I.e.
2259 * either I_DIRTY_TIME *or* I_DIRTY_INODE can be set in
2260 * i_state, but not both. I_DIRTY_PAGES may still be set.
eaff8079
CH
2261 * I_NEW Serves as both a mutex and completion notification.
2262 * New inodes set I_NEW. If two processes both create
2263 * the same inode, one of them will release its inode and
2264 * wait for I_NEW to be released before returning.
2265 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2266 * also cause waiting on I_NEW, without I_NEW actually
2267 * being set. find_inode() uses this to prevent returning
2268 * nearly-dead inodes.
1c0eeaf5
JE
2269 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2270 * is zero. I_FREEING must be set when I_WILL_FREE is
2271 * cleared.
2272 * I_FREEING Set when inode is about to be freed but still has dirty
2273 * pages or buffers attached or the inode itself is still
2274 * dirty.
dbd5768f
JK
2275 * I_CLEAR Added by clear_inode(). In this state the inode is
2276 * clean and can be destroyed. Inode keeps I_FREEING.
1c0eeaf5
JE
2277 *
2278 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2279 * prohibited for many purposes. iget() must wait for
2280 * the inode to be completely released, then create it
2281 * anew. Other functions will just ignore such inodes,
eaff8079 2282 * if appropriate. I_NEW is used for waiting.
1c0eeaf5 2283 *
169ebd90
JK
2284 * I_SYNC Writeback of inode is running. The bit is set during
2285 * data writeback, and cleared with a wakeup on the bit
2286 * address once it is done. The bit is also used to pin
2287 * the inode in memory for flusher thread.
1c0eeaf5 2288 *
bd5fe6c5
CH
2289 * I_REFERENCED Marks the inode as recently references on the LRU list.
2290 *
2291 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
2292 *
682aa8e1
TH
2293 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2294 * synchronize competing switching instances and to tell
b93b0163 2295 * wb stat updates to grab the i_pages lock. See
a9519def 2296 * inode_switch_wbs_work_fn() for details.
682aa8e1 2297 *
ad0af710
AG
2298 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2299 * and work dirs among overlayfs mounts.
2300 *
c2b6d621
AV
2301 * I_CREATING New object's inode in the middle of setting up.
2302 *
dae2f8ed
IW
2303 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2304 *
5afced3b
JK
2305 * I_SYNC_QUEUED Inode is queued in b_io or b_more_io writeback lists.
2306 * Used to detect that mark_inode_dirty() should not move
2307 * inode between dirty lists.
2308 *
1c0eeaf5 2309 * Q: What is the difference between I_WILL_FREE and I_FREEING?
1c0eeaf5 2310 */
9e38d86f
NP
2311#define I_DIRTY_SYNC (1 << 0)
2312#define I_DIRTY_DATASYNC (1 << 1)
2313#define I_DIRTY_PAGES (1 << 2)
eaff8079
CH
2314#define __I_NEW 3
2315#define I_NEW (1 << __I_NEW)
9e38d86f
NP
2316#define I_WILL_FREE (1 << 4)
2317#define I_FREEING (1 << 5)
2318#define I_CLEAR (1 << 6)
eaff8079 2319#define __I_SYNC 7
1c0eeaf5 2320#define I_SYNC (1 << __I_SYNC)
9e38d86f 2321#define I_REFERENCED (1 << 8)
bd5fe6c5 2322#define __I_DIO_WAKEUP 9
ac74d8d6 2323#define I_DIO_WAKEUP (1 << __I_DIO_WAKEUP)
f4e0c30c 2324#define I_LINKABLE (1 << 10)
0ae45f63 2325#define I_DIRTY_TIME (1 << 11)
682aa8e1 2326#define I_WB_SWITCH (1 << 13)
c2b6d621
AV
2327#define I_OVL_INUSE (1 << 14)
2328#define I_CREATING (1 << 15)
dae2f8ed 2329#define I_DONTCACHE (1 << 16)
5afced3b 2330#define I_SYNC_QUEUED (1 << 17)
1da177e4 2331
0e11f644
CH
2332#define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2333#define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
0ae45f63 2334#define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
1da177e4
LT
2335
2336extern void __mark_inode_dirty(struct inode *, int);
2337static inline void mark_inode_dirty(struct inode *inode)
2338{
2339 __mark_inode_dirty(inode, I_DIRTY);
2340}
2341
2342static inline void mark_inode_dirty_sync(struct inode *inode)
2343{
2344 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2345}
2346
ed296c6c
EB
2347/*
2348 * Returns true if the given inode itself only has dirty timestamps (its pages
2349 * may still be dirty) and isn't currently being allocated or freed.
2350 * Filesystems should call this if when writing an inode when lazytime is
2351 * enabled, they want to opportunistically write the timestamps of other inodes
2352 * located very nearby on-disk, e.g. in the same inode block. This returns true
2353 * if the given inode is in need of such an opportunistic update. Requires
2354 * i_lock, or at least later re-checking under i_lock.
2355 */
2356static inline bool inode_is_dirtytime_only(struct inode *inode)
2357{
2358 return (inode->i_state & (I_DIRTY_TIME | I_NEW |
2359 I_FREEING | I_WILL_FREE)) == I_DIRTY_TIME;
2360}
2361
7ada4db8
MS
2362extern void inc_nlink(struct inode *inode);
2363extern void drop_nlink(struct inode *inode);
2364extern void clear_nlink(struct inode *inode);
2365extern void set_nlink(struct inode *inode, unsigned int nlink);
d8c76e6f
DH
2366
2367static inline void inode_inc_link_count(struct inode *inode)
2368{
2369 inc_nlink(inode);
66d21730
AD
2370 mark_inode_dirty(inode);
2371}
2372
9a53c3a7
DH
2373static inline void inode_dec_link_count(struct inode *inode)
2374{
2375 drop_nlink(inode);
66d21730
AD
2376 mark_inode_dirty(inode);
2377}
2378
c3b2da31
JB
2379enum file_time_flags {
2380 S_ATIME = 1,
2381 S_MTIME = 2,
2382 S_CTIME = 4,
2383 S_VERSION = 8,
2384};
2385
c6718543 2386extern bool atime_needs_update(const struct path *, struct inode *);
badcf2b7 2387extern void touch_atime(const struct path *);
1da177e4
LT
2388static inline void file_accessed(struct file *file)
2389{
2390 if (!(file->f_flags & O_NOATIME))
68ac1234 2391 touch_atime(&file->f_path);
1da177e4
LT
2392}
2393
e38f7f53
AG
2394extern int file_modified(struct file *file);
2395
1da177e4 2396int sync_inode(struct inode *inode, struct writeback_control *wbc);
c3765016 2397int sync_inode_metadata(struct inode *inode, int wait);
1da177e4 2398
1da177e4
LT
2399struct file_system_type {
2400 const char *name;
2401 int fs_flags;
bbc1096a
DH
2402#define FS_REQUIRES_DEV 1
2403#define FS_BINARY_MOUNTDATA 2
2404#define FS_HAS_SUBTYPE 4
0c55cfc4 2405#define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
0b3b094a 2406#define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
a6435940 2407#define FS_ALLOW_IDMAP 32 /* FS has been updated to handle vfs idmappings. */
01c70267 2408#define FS_THP_SUPPORT 8192 /* Remove once all fs converted */
bbc1096a 2409#define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
f3a09c92 2410 int (*init_fs_context)(struct fs_context *);
d7167b14 2411 const struct fs_parameter_spec *parameters;
c96e41e9
AV
2412 struct dentry *(*mount) (struct file_system_type *, int,
2413 const char *, void *);
1da177e4
LT
2414 void (*kill_sb) (struct super_block *);
2415 struct module *owner;
2416 struct file_system_type * next;
a5166169 2417 struct hlist_head fs_supers;
d475fd42 2418
cf516249 2419 struct lock_class_key s_lock_key;
897c6ff9 2420 struct lock_class_key s_umount_key;
51ee049e 2421 struct lock_class_key s_vfs_rename_key;
5accdf82 2422 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
d475fd42
PZ
2423
2424 struct lock_class_key i_lock_key;
2425 struct lock_class_key i_mutex_key;
14358e6d 2426 struct lock_class_key i_mutex_dir_key;
1da177e4
LT
2427};
2428
7f78e035
EB
2429#define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2430
152a0836
AV
2431extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2432 int flags, const char *dev_name, void *data,
2433 int (*fill_super)(struct super_block *, void *, int));
fc14f2fe
AV
2434extern struct dentry *mount_single(struct file_system_type *fs_type,
2435 int flags, void *data,
2436 int (*fill_super)(struct super_block *, void *, int));
3c26ff6e
AV
2437extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2438 int flags, void *data,
2439 int (*fill_super)(struct super_block *, void *, int));
ea441d11 2440extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
1da177e4
LT
2441void generic_shutdown_super(struct super_block *sb);
2442void kill_block_super(struct super_block *sb);
2443void kill_anon_super(struct super_block *sb);
2444void kill_litter_super(struct super_block *sb);
2445void deactivate_super(struct super_block *sb);
74dbbdd7 2446void deactivate_locked_super(struct super_block *sb);
1da177e4 2447int set_anon_super(struct super_block *s, void *data);
cb50b348 2448int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
0ee5dc67
AV
2449int get_anon_bdev(dev_t *);
2450void free_anon_bdev(dev_t);
cb50b348
AV
2451struct super_block *sget_fc(struct fs_context *fc,
2452 int (*test)(struct super_block *, struct fs_context *),
2453 int (*set)(struct super_block *, struct fs_context *));
1da177e4
LT
2454struct super_block *sget(struct file_system_type *type,
2455 int (*test)(struct super_block *,void *),
2456 int (*set)(struct super_block *,void *),
9249e17f 2457 int flags, void *data);
1da177e4
LT
2458
2459/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2460#define fops_get(fops) \
2461 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
2462#define fops_put(fops) \
2463 do { if (fops) module_put((fops)->owner); } while(0)
e84f9e57
AV
2464/*
2465 * This one is to be used *ONLY* from ->open() instances.
2466 * fops must be non-NULL, pinned down *and* module dependencies
2467 * should be sufficient to pin the caller down as well.
2468 */
2469#define replace_fops(f, fops) \
2470 do { \
2471 struct file *__file = (f); \
2472 fops_put(__file->f_op); \
2473 BUG_ON(!(__file->f_op = (fops))); \
2474 } while(0)
1da177e4
LT
2475
2476extern int register_filesystem(struct file_system_type *);
2477extern int unregister_filesystem(struct file_system_type *);
d911b458 2478extern struct vfsmount *kern_mount(struct file_system_type *);
423e0ab0 2479extern void kern_unmount(struct vfsmount *mnt);
1da177e4
LT
2480extern int may_umount_tree(struct vfsmount *);
2481extern int may_umount(struct vfsmount *);
5e6123f3
SL
2482extern long do_mount(const char *, const char __user *,
2483 const char *, unsigned long, void *);
ca71cf71 2484extern struct vfsmount *collect_mounts(const struct path *);
8aec0809 2485extern void drop_collected_mounts(struct vfsmount *);
1f707137
AV
2486extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
2487 struct vfsmount *);
f0bb5aaf 2488extern int vfs_statfs(const struct path *, struct kstatfs *);
c8b91acc
AV
2489extern int user_statfs(const char __user *, struct kstatfs *);
2490extern int fd_statfs(int, struct kstatfs *);
18e9e510
JB
2491extern int freeze_super(struct super_block *super);
2492extern int thaw_super(struct super_block *super);
02125a82 2493extern bool our_mnt(struct vfsmount *mnt);
fca39346
JK
2494extern __printf(2, 3)
2495int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2496extern int super_setup_bdi(struct super_block *sb);
1da177e4 2497
ce3b0f8d
AV
2498extern int current_umask(void);
2499
5a14696c
BF
2500extern void ihold(struct inode * inode);
2501extern void iput(struct inode *);
95582b00 2502extern int generic_update_time(struct inode *, struct timespec64 *, int);
5a14696c 2503
f87fd4c2 2504/* /sys/fs */
00d26666 2505extern struct kobject *fs_kobj;
f87fd4c2 2506
09cbfeaf 2507#define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
bfcd17a6 2508
9e8925b6 2509#ifdef CONFIG_MANDATORY_FILE_LOCKING
d7a06983 2510extern int locks_mandatory_locked(struct file *);
acc15575 2511extern int locks_mandatory_area(struct inode *, struct file *, loff_t, loff_t, unsigned char);
1da177e4
LT
2512
2513/*
2514 * Candidates for mandatory locking have the setgid bit set
2515 * but no group execute bit - an otherwise meaningless combination.
2516 */
a16877ca
PE
2517
2518static inline int __mandatory_lock(struct inode *ino)
2519{
2520 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
2521}
2522
2523/*
e462ec50 2524 * ... and these candidates should be on SB_MANDLOCK mounted fs,
a16877ca
PE
2525 * otherwise these will be advisory locks
2526 */
2527
2528static inline int mandatory_lock(struct inode *ino)
2529{
2530 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
2531}
1da177e4 2532
d7a06983 2533static inline int locks_verify_locked(struct file *file)
1da177e4 2534{
c568d683 2535 if (mandatory_lock(locks_inode(file)))
d7a06983 2536 return locks_mandatory_locked(file);
1da177e4
LT
2537 return 0;
2538}
2539
1da177e4 2540static inline int locks_verify_truncate(struct inode *inode,
acc15575 2541 struct file *f,
1da177e4
LT
2542 loff_t size)
2543{
acc15575
CH
2544 if (!inode->i_flctx || !mandatory_lock(inode))
2545 return 0;
2546
2547 if (size < inode->i_size) {
2548 return locks_mandatory_area(inode, f, size, inode->i_size - 1,
2549 F_WRLCK);
2550 } else {
2551 return locks_mandatory_area(inode, f, inode->i_size, size - 1,
2552 F_WRLCK);
2553 }
1da177e4
LT
2554}
2555
9e8925b6
JL
2556#else /* !CONFIG_MANDATORY_FILE_LOCKING */
2557
2558static inline int locks_mandatory_locked(struct file *file)
2559{
2560 return 0;
2561}
2562
fce205e9
LT
2563static inline int locks_mandatory_area(struct inode *inode, struct file *filp,
2564 loff_t start, loff_t end, unsigned char type)
9e8925b6
JL
2565{
2566 return 0;
2567}
2568
2569static inline int __mandatory_lock(struct inode *inode)
2570{
2571 return 0;
2572}
2573
2574static inline int mandatory_lock(struct inode *inode)
2575{
2576 return 0;
2577}
2578
2579static inline int locks_verify_locked(struct file *file)
2580{
2581 return 0;
2582}
2583
2584static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2585 size_t size)
2586{
2587 return 0;
2588}
2589
2590#endif /* CONFIG_MANDATORY_FILE_LOCKING */
2591
2592
2593#ifdef CONFIG_FILE_LOCKING
1da177e4
LT
2594static inline int break_lease(struct inode *inode, unsigned int mode)
2595{
24cbe784
JL
2596 /*
2597 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2598 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2599 * could end up racing with tasks trying to set a new lease on this
2600 * file.
24cbe784
JL
2601 */
2602 smp_mb();
8634b51f 2603 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2604 return __break_lease(inode, mode, FL_LEASE);
1da177e4
LT
2605 return 0;
2606}
df4e8d2c
BF
2607
2608static inline int break_deleg(struct inode *inode, unsigned int mode)
2609{
962bd40b
JL
2610 /*
2611 * Since this check is lockless, we must ensure that any refcounts
8116bf4c
JL
2612 * taken are done before checking i_flctx->flc_lease. Otherwise, we
2613 * could end up racing with tasks trying to set a new lease on this
2614 * file.
962bd40b
JL
2615 */
2616 smp_mb();
8634b51f 2617 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
df4e8d2c 2618 return __break_lease(inode, mode, FL_DELEG);
1da177e4
LT
2619 return 0;
2620}
df4e8d2c 2621
5a14696c
BF
2622static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2623{
2624 int ret;
2625
2626 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2627 if (ret == -EWOULDBLOCK && delegated_inode) {
2628 *delegated_inode = inode;
2629 ihold(inode);
2630 }
2631 return ret;
2632}
2633
2634static inline int break_deleg_wait(struct inode **delegated_inode)
2635{
2636 int ret;
2637
2638 ret = break_deleg(*delegated_inode, O_WRONLY);
2639 iput(*delegated_inode);
2640 *delegated_inode = NULL;
2641 return ret;
2642}
2643
11afe9f7
CH
2644static inline int break_layout(struct inode *inode, bool wait)
2645{
2646 smp_mb();
2647 if (inode->i_flctx && !list_empty_careful(&inode->i_flctx->flc_lease))
2648 return __break_lease(inode,
2649 wait ? O_WRONLY : O_WRONLY | O_NONBLOCK,
2650 FL_LAYOUT);
2651 return 0;
2652}
2653
bfcd17a6 2654#else /* !CONFIG_FILE_LOCKING */
af5df566
SW
2655static inline int break_lease(struct inode *inode, unsigned int mode)
2656{
2657 return 0;
2658}
2659
df4e8d2c
BF
2660static inline int break_deleg(struct inode *inode, unsigned int mode)
2661{
2662 return 0;
2663}
5a14696c
BF
2664
2665static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2666{
2667 return 0;
2668}
2669
2670static inline int break_deleg_wait(struct inode **delegated_inode)
2671{
2672 BUG();
2673 return 0;
2674}
2675
11afe9f7
CH
2676static inline int break_layout(struct inode *inode, bool wait)
2677{
2678 return 0;
2679}
2680
bfcd17a6 2681#endif /* CONFIG_FILE_LOCKING */
1da177e4
LT
2682
2683/* fs/open.c */
adb5c247 2684struct audit_names;
91a27b2a 2685struct filename {
adb5c247
JL
2686 const char *name; /* pointer to actual string */
2687 const __user char *uptr; /* original userland pointer */
55422d0b 2688 int refcnt;
1c949843 2689 struct audit_names *aname;
fd2f7cb5 2690 const char iname[];
91a27b2a 2691};
f1fffbd4 2692static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
1da177e4 2693
a6435940
CB
2694static inline struct user_namespace *file_mnt_user_ns(struct file *file)
2695{
2696 return mnt_user_ns(file->f_path.mnt);
2697}
7df818b2 2698extern long vfs_truncate(const struct path *, loff_t);
643fe55a
CB
2699int do_truncate(struct user_namespace *, struct dentry *, loff_t start,
2700 unsigned int time_attrs, struct file *filp);
72c72bdf 2701extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
3e63cbb1 2702 loff_t len);
8e8a1407 2703extern long do_sys_open(int dfd, const char __user *filename, int flags,
a218d0fd 2704 umode_t mode);
669abf4e 2705extern struct file *file_open_name(struct filename *, int, umode_t);
a218d0fd 2706extern struct file *filp_open(const char *, int, umode_t);
73d049a4 2707extern struct file *file_open_root(struct dentry *, struct vfsmount *,
378c6520 2708 const char *, int, umode_t);
765927b2 2709extern struct file * dentry_open(const struct path *, int, const struct cred *);
2abc77af
AV
2710extern struct file * open_with_fake_path(const struct path *, int,
2711 struct inode*, const struct cred *);
19f391eb
AV
2712static inline struct file *file_clone_open(struct file *file)
2713{
2714 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2715}
1da177e4 2716extern int filp_close(struct file *, fl_owner_t id);
91a27b2a 2717
51f39a1f 2718extern struct filename *getname_flags(const char __user *, int, int *);
91a27b2a 2719extern struct filename *getname(const char __user *);
c4ad8f98 2720extern struct filename *getname_kernel(const char *);
55422d0b 2721extern void putname(struct filename *name);
91a27b2a 2722
30d90494 2723extern int finish_open(struct file *file, struct dentry *dentry,
be12af3e 2724 int (*open)(struct inode *, struct file *));
e45198a6 2725extern int finish_no_open(struct file *file, struct dentry *dentry);
1da177e4
LT
2726
2727/* fs/dcache.c */
2728extern void __init vfs_caches_init_early(void);
4248b0da 2729extern void __init vfs_caches_init(void);
1da177e4 2730
b86c089b
CL
2731extern struct kmem_cache *names_cachep;
2732
a608ca21 2733#define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
3446a8aa 2734#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
1da177e4 2735
a212b105 2736extern struct super_block *blockdev_superblock;
a212b105
TH
2737static inline bool sb_is_blkdev_sb(struct super_block *sb)
2738{
dd0dca22 2739 return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
47e4491b 2740}
5c0d6b60 2741
b818f09e 2742void emergency_thaw_all(void);
60b0680f 2743extern int sync_filesystem(struct super_block *);
9361401e 2744extern const struct file_operations def_blk_fops;
4b6f5d20 2745extern const struct file_operations def_chr_fops;
1da177e4
LT
2746
2747/* fs/char_dev.c */
8a932f73 2748#define CHRDEV_MAJOR_MAX 512
49db08c3
LW
2749/* Marks the bottom of the first segment of free char majors */
2750#define CHRDEV_MAJOR_DYN_END 234
a5d31a3f
LG
2751/* Marks the top and bottom of the second segment of free char majors */
2752#define CHRDEV_MAJOR_DYN_EXT_START 511
2753#define CHRDEV_MAJOR_DYN_EXT_END 384
2754
1da177e4
LT
2755extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2756extern int register_chrdev_region(dev_t, unsigned, const char *);
1905b1bf
TH
2757extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2758 unsigned int count, const char *name,
2759 const struct file_operations *fops);
2760extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2761 unsigned int count, const char *name);
1da177e4 2762extern void unregister_chrdev_region(dev_t, unsigned);
68eef3b4 2763extern void chrdev_show(struct seq_file *,off_t);
1da177e4 2764
1905b1bf
TH
2765static inline int register_chrdev(unsigned int major, const char *name,
2766 const struct file_operations *fops)
2767{
2768 return __register_chrdev(major, 0, 256, name, fops);
2769}
2770
2771static inline void unregister_chrdev(unsigned int major, const char *name)
2772{
2773 __unregister_chrdev(major, 0, 256, name);
2774}
2775
1da177e4
LT
2776extern void init_special_inode(struct inode *, umode_t, dev_t);
2777
2778/* Invalid inode operations -- fs/bad_inode.c */
2779extern void make_bad_inode(struct inode *);
0e3ef1fe 2780extern bool is_bad_inode(struct inode *);
1da177e4 2781
1da177e4
LT
2782unsigned long invalidate_mapping_pages(struct address_space *mapping,
2783 pgoff_t start, pgoff_t end);
54bc4855 2784
eb1d7a65
YS
2785void invalidate_mapping_pagevec(struct address_space *mapping,
2786 pgoff_t start, pgoff_t end,
2787 unsigned long *nr_pagevec);
2788
1da177e4
LT
2789static inline void invalidate_remote_inode(struct inode *inode)
2790{
2791 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2792 S_ISLNK(inode->i_mode))
fc0ecff6 2793 invalidate_mapping_pages(inode->i_mapping, 0, -1);
1da177e4
LT
2794}
2795extern int invalidate_inode_pages2(struct address_space *mapping);
2796extern int invalidate_inode_pages2_range(struct address_space *mapping,
2797 pgoff_t start, pgoff_t end);
2798extern int write_inode_now(struct inode *, int);
2799extern int filemap_fdatawrite(struct address_space *);
2800extern int filemap_flush(struct address_space *);
76341cab 2801extern int filemap_fdatawait_keep_errors(struct address_space *mapping);
d3bccb6f
JK
2802extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2803 loff_t lend);
aa0bfcd9
RZ
2804extern int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
2805 loff_t start_byte, loff_t end_byte);
ffb959bb
JL
2806
2807static inline int filemap_fdatawait(struct address_space *mapping)
2808{
2809 return filemap_fdatawait_range(mapping, 0, LLONG_MAX);
2810}
2811
7fc9e472
GR
2812extern bool filemap_range_has_page(struct address_space *, loff_t lstart,
2813 loff_t lend);
1da177e4
LT
2814extern int filemap_write_and_wait_range(struct address_space *mapping,
2815 loff_t lstart, loff_t lend);
ebcf28e1
AM
2816extern int __filemap_fdatawrite_range(struct address_space *mapping,
2817 loff_t start, loff_t end, int sync_mode);
f4c0a0fd
JK
2818extern int filemap_fdatawrite_range(struct address_space *mapping,
2819 loff_t start, loff_t end);
d72d9e2a 2820extern int filemap_check_errors(struct address_space *mapping);
5660e13d 2821extern void __filemap_set_wb_err(struct address_space *mapping, int err);
a823e458 2822
ddf8f376
IW
2823static inline int filemap_write_and_wait(struct address_space *mapping)
2824{
2825 return filemap_write_and_wait_range(mapping, 0, LLONG_MAX);
2826}
2827
a823e458
JL
2828extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2829 loff_t lend);
5660e13d
JL
2830extern int __must_check file_check_and_advance_wb_err(struct file *file);
2831extern int __must_check file_write_and_wait_range(struct file *file,
2832 loff_t start, loff_t end);
2833
a823e458
JL
2834static inline int file_write_and_wait(struct file *file)
2835{
2836 return file_write_and_wait_range(file, 0, LLONG_MAX);
2837}
2838
5660e13d
JL
2839/**
2840 * filemap_set_wb_err - set a writeback error on an address_space
2841 * @mapping: mapping in which to set writeback error
2842 * @err: error to be set in mapping
2843 *
2844 * When writeback fails in some way, we must record that error so that
2845 * userspace can be informed when fsync and the like are called. We endeavor
2846 * to report errors on any file that was open at the time of the error. Some
2847 * internal callers also need to know when writeback errors have occurred.
2848 *
2849 * When a writeback error occurs, most filesystems will want to call
2850 * filemap_set_wb_err to record the error in the mapping so that it will be
2851 * automatically reported whenever fsync is called on the file.
5660e13d
JL
2852 */
2853static inline void filemap_set_wb_err(struct address_space *mapping, int err)
2854{
2855 /* Fastpath for common case of no error */
2856 if (unlikely(err))
2857 __filemap_set_wb_err(mapping, err);
2858}
2859
2860/**
c9dff084 2861 * filemap_check_wb_err - has an error occurred since the mark was sampled?
5660e13d
JL
2862 * @mapping: mapping to check for writeback errors
2863 * @since: previously-sampled errseq_t
2864 *
2865 * Grab the errseq_t value from the mapping, and see if it has changed "since"
2866 * the given value was sampled.
2867 *
2868 * If it has then report the latest error set, otherwise return 0.
2869 */
2870static inline int filemap_check_wb_err(struct address_space *mapping,
2871 errseq_t since)
2872{
2873 return errseq_check(&mapping->wb_err, since);
2874}
2875
2876/**
2877 * filemap_sample_wb_err - sample the current errseq_t to test for later errors
2878 * @mapping: mapping to be sampled
2879 *
2880 * Writeback errors are always reported relative to a particular sample point
2881 * in the past. This function provides those sample points.
2882 */
2883static inline errseq_t filemap_sample_wb_err(struct address_space *mapping)
2884{
2885 return errseq_sample(&mapping->wb_err);
2886}
2887
735e4ae5
JL
2888/**
2889 * file_sample_sb_err - sample the current errseq_t to test for later errors
21b9cb34 2890 * @file: file pointer to be sampled
735e4ae5
JL
2891 *
2892 * Grab the most current superblock-level errseq_t value for the given
2893 * struct file.
2894 */
2895static inline errseq_t file_sample_sb_err(struct file *file)
2896{
2897 return errseq_sample(&file->f_path.dentry->d_sb->s_wb_err);
2898}
2899
8018ab05
CH
2900extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2901 int datasync);
2902extern int vfs_fsync(struct file *file, int datasync);
e2592217 2903
22f96b38
JA
2904extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2905 unsigned int flags);
2906
e2592217
CH
2907/*
2908 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2909 * to already be updated for the write, and will return either the amount
2910 * of bytes passed in, or an error if syncing the file failed.
2911 */
2912static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2913{
2914 if (iocb->ki_flags & IOCB_DSYNC) {
2915 int ret = vfs_fsync_range(iocb->ki_filp,
2916 iocb->ki_pos - count, iocb->ki_pos - 1,
2917 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2918 if (ret)
2919 return ret;
2920 }
2921
2922 return count;
d311d79d 2923}
e2592217 2924
1da177e4
LT
2925extern void emergency_sync(void);
2926extern void emergency_remount(void);
30460e1e 2927
9361401e 2928#ifdef CONFIG_BLOCK
30460e1e
CM
2929extern int bmap(struct inode *inode, sector_t *block);
2930#else
2931static inline int bmap(struct inode *inode, sector_t *block)
2932{
2933 return -EINVAL;
2934}
9361401e 2935#endif
30460e1e 2936
2f221d6f
CB
2937int notify_change(struct user_namespace *, struct dentry *,
2938 struct iattr *, struct inode **);
47291baa
CB
2939int inode_permission(struct user_namespace *, struct inode *, int);
2940int generic_permission(struct user_namespace *, struct inode *, int);
02f92b38
CB
2941static inline int file_permission(struct file *file, int mask)
2942{
47291baa
CB
2943 return inode_permission(file_mnt_user_ns(file),
2944 file_inode(file), mask);
02f92b38
CB
2945}
2946static inline int path_permission(const struct path *path, int mask)
2947{
47291baa
CB
2948 return inode_permission(mnt_user_ns(path->mnt),
2949 d_inode(path->dentry), mask);
02f92b38 2950}
ba73d987
CB
2951int __check_sticky(struct user_namespace *mnt_userns, struct inode *dir,
2952 struct inode *inode);
1da177e4 2953
f696a365
MS
2954static inline bool execute_ok(struct inode *inode)
2955{
2956 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2957}
2958
8d71db4f
AV
2959static inline void file_start_write(struct file *file)
2960{
2961 if (!S_ISREG(file_inode(file)->i_mode))
2962 return;
8a3c84b6 2963 sb_start_write(file_inode(file)->i_sb);
8d71db4f
AV
2964}
2965
5ae98f15
JK
2966static inline bool file_start_write_trylock(struct file *file)
2967{
2968 if (!S_ISREG(file_inode(file)->i_mode))
2969 return true;
8a3c84b6 2970 return sb_start_write_trylock(file_inode(file)->i_sb);
5ae98f15
JK
2971}
2972
8d71db4f
AV
2973static inline void file_end_write(struct file *file)
2974{
2975 if (!S_ISREG(file_inode(file)->i_mode))
2976 return;
2977 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2978}
bfe219d3 2979
07b8ce1e
AV
2980/*
2981 * get_write_access() gets write permission for a file.
2982 * put_write_access() releases this write permission.
2983 * This is used for regular files.
2984 * We cannot support write (and maybe mmap read-write shared) accesses and
2985 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2986 * can have the following values:
2987 * 0: no writers, no VM_DENYWRITE mappings
2988 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2989 * > 0: (i_writecount) users are writing to the file.
2990 *
2991 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2992 * except for the cases where we don't hold i_writecount yet. Then we need to
2993 * use {get,deny}_write_access() - these functions check the sign and refuse
2994 * to do the change if sign is wrong.
2995 */
2996static inline int get_write_access(struct inode *inode)
2997{
2998 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2999}
3000static inline int deny_write_access(struct file *file)
3001{
496ad9aa 3002 struct inode *inode = file_inode(file);
07b8ce1e
AV
3003 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
3004}
1da177e4
LT
3005static inline void put_write_access(struct inode * inode)
3006{
3007 atomic_dec(&inode->i_writecount);
3008}
3009static inline void allow_write_access(struct file *file)
3010{
3011 if (file)
496ad9aa 3012 atomic_inc(&file_inode(file)->i_writecount);
1da177e4 3013}
f1fe29b4
DH
3014static inline bool inode_is_open_for_write(const struct inode *inode)
3015{
3016 return atomic_read(&inode->i_writecount) > 0;
3017}
3018
387e3746 3019#if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
a5c96ebf
MZ
3020static inline void i_readcount_dec(struct inode *inode)
3021{
3022 BUG_ON(!atomic_read(&inode->i_readcount));
3023 atomic_dec(&inode->i_readcount);
3024}
3025static inline void i_readcount_inc(struct inode *inode)
3026{
3027 atomic_inc(&inode->i_readcount);
3028}
3029#else
3030static inline void i_readcount_dec(struct inode *inode)
3031{
3032 return;
3033}
3034static inline void i_readcount_inc(struct inode *inode)
3035{
3036 return;
3037}
3038#endif
ed8cae8b 3039extern int do_pipe_flags(int *, int);
1da177e4 3040
bdd1d2d3 3041extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
61a707c5 3042ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
e13ec939 3043extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
73e18f7c 3044extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
1da177e4
LT
3045extern struct file * open_exec(const char *);
3046
3047/* fs/dcache.c -- generic fs support functions */
a6e5787f 3048extern bool is_subdir(struct dentry *, struct dentry *);
640eb7e7 3049extern bool path_is_under(const struct path *, const struct path *);
1da177e4 3050
9bf39ab2
MS
3051extern char *file_path(struct file *, char *, int);
3052
1da177e4
LT
3053#include <linux/err.h>
3054
3055/* needed for stackable file system support */
965c8e59 3056extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
1da177e4 3057
965c8e59 3058extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
1da177e4 3059
54e34621 3060extern int inode_init_always(struct super_block *, struct inode *);
1da177e4 3061extern void inode_init_once(struct inode *);
2aa15890 3062extern void address_space_init_once(struct address_space *mapping);
1da177e4
LT
3063extern struct inode * igrab(struct inode *);
3064extern ino_t iunique(struct super_block *, ino_t);
3065extern int inode_needs_sync(struct inode *inode);
45321ac5 3066extern int generic_delete_inode(struct inode *inode);
9bcb4b73
AV
3067static inline int generic_drop_inode(struct inode *inode)
3068{
88149082 3069 return !inode->i_nlink || inode_unhashed(inode);
9bcb4b73 3070}
2c567af4 3071extern void d_mark_dontcache(struct inode *inode);
1da177e4 3072
88bd5121
AA
3073extern struct inode *ilookup5_nowait(struct super_block *sb,
3074 unsigned long hashval, int (*test)(struct inode *, void *),
3075 void *data);
1da177e4
LT
3076extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
3077 int (*test)(struct inode *, void *), void *data);
3078extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
3079
80ea09a0
MS
3080extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
3081 int (*test)(struct inode *, void *),
3082 int (*set)(struct inode *, void *),
3083 void *data);
1da177e4
LT
3084extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
3085extern struct inode * iget_locked(struct super_block *, unsigned long);
fe032c42
TT
3086extern struct inode *find_inode_nowait(struct super_block *,
3087 unsigned long,
3088 int (*match)(struct inode *,
3089 unsigned long, void *),
3090 void *data);
3f19b2ab
DH
3091extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
3092 int (*)(struct inode *, void *), void *);
3093extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
261bca86
AV
3094extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
3095extern int insert_inode_locked(struct inode *);
e096d0c7
JB
3096#ifdef CONFIG_DEBUG_LOCK_ALLOC
3097extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
3098#else
3099static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
3100#endif
1da177e4 3101extern void unlock_new_inode(struct inode *);
c2b6d621 3102extern void discard_new_inode(struct inode *);
85fe4025 3103extern unsigned int get_next_ino(void);
799ea9e9 3104extern void evict_inodes(struct super_block *sb);
1da177e4 3105
e809d5f0
CD
3106/*
3107 * Userspace may rely on the the inode number being non-zero. For example, glibc
3108 * simply ignores files with zero i_ino in unlink() and other places.
3109 *
3110 * As an additional complication, if userspace was compiled with
3111 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
3112 * lower 32 bits, so we need to check that those aren't zero explicitly. With
3113 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
3114 * better safe than sorry.
3115 */
3116static inline bool is_zero_ino(ino_t ino)
3117{
3118 return (u32)ino == 0;
3119}
3120
1da177e4 3121extern void __iget(struct inode * inode);
b46980fe 3122extern void iget_failed(struct inode *);
dbd5768f 3123extern void clear_inode(struct inode *);
2e00c97e 3124extern void __destroy_inode(struct inode *);
a209dfc7
ED
3125extern struct inode *new_inode_pseudo(struct super_block *sb);
3126extern struct inode *new_inode(struct super_block *sb);
ff0c7d15 3127extern void free_inode_nonrcu(struct inode *inode);
01de85e0 3128extern int should_remove_suid(struct dentry *);
5fa8e0a1 3129extern int file_remove_privs(struct file *);
1da177e4
LT
3130
3131extern void __insert_inode_hash(struct inode *, unsigned long hashval);
646ec461
CH
3132static inline void insert_inode_hash(struct inode *inode)
3133{
1da177e4
LT
3134 __insert_inode_hash(inode, inode->i_ino);
3135}
f2ee7abf
ED
3136
3137extern void __remove_inode_hash(struct inode *);
3138static inline void remove_inode_hash(struct inode *inode)
3139{
cbedaac6 3140 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
f2ee7abf
ED
3141 __remove_inode_hash(inode);
3142}
3143
646ec461 3144extern void inode_sb_list_add(struct inode *inode);
1da177e4 3145
1da177e4
LT
3146extern int sb_set_blocksize(struct super_block *, int);
3147extern int sb_min_blocksize(struct super_block *, int);
3148
3149extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3150extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3309dd04 3151extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
02e83f46
DW
3152extern int generic_write_check_limits(struct file *file, loff_t pos,
3153 loff_t *count);
a3171351 3154extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
87fa0f3e
CH
3155ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *to,
3156 ssize_t already_read);
ed978a81 3157extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
8174202b 3158extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
8174202b 3159extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
1af5bb49 3160extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3b93f911 3161extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
88e6faef 3162
18e9710e 3163ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
ddef7ed2 3164 rwf_t flags);
abbb6589 3165ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
ddef7ed2 3166 rwf_t flags);
5dcdc43e
JX
3167ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
3168 struct iov_iter *iter);
3169ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
3170 struct iov_iter *iter);
dbe4e192 3171
eef99380 3172/* fs/block_dev.c */
b2de525f 3173extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
1456c0a8 3174extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
02c24a82
JB
3175extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
3176 int datasync);
ff01bb48 3177extern void block_sync_page(struct page *page);
eef99380 3178
88e6faef 3179/* fs/splice.c */
cbb7e577 3180extern ssize_t generic_file_splice_read(struct file *, loff_t *,
88e6faef 3181 struct pipe_inode_info *, size_t, unsigned int);
8d020765 3182extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
cbb7e577 3183 struct file *, loff_t *, size_t, unsigned int);
88e6faef 3184extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
cbb7e577 3185 struct file *out, loff_t *, size_t len, unsigned int flags);
1c118596
MS
3186extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
3187 loff_t *opos, size_t len, unsigned int flags);
3188
88e6faef 3189
1da177e4
LT
3190extern void
3191file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
965c8e59
AM
3192extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3193extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
46a1c2c7 3194extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
965c8e59 3195extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
5760495a 3196extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
965c8e59 3197 int whence, loff_t maxsize, loff_t eof);
1bf9d14d
AV
3198extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3199 int whence, loff_t size);
b25472f9
AV
3200extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3201extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
1da177e4
LT
3202extern int generic_file_open(struct inode * inode, struct file * filp);
3203extern int nonseekable_open(struct inode * inode, struct file * filp);
10dce8af 3204extern int stream_open(struct inode * inode, struct file * filp);
1da177e4 3205
9361401e 3206#ifdef CONFIG_BLOCK
8a4c1e42 3207typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
facd07b0 3208 loff_t file_offset);
1da177e4
LT
3209
3210enum {
1e431f5c
CH
3211 /* need locking between buffered and direct access */
3212 DIO_LOCKING = 0x01,
3213
3214 /* filesystem does not support filling holes */
3215 DIO_SKIP_HOLES = 0x02,
1da177e4
LT
3216};
3217
17f8c842
OS
3218ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3219 struct block_device *bdev, struct iov_iter *iter,
c8b8e32d 3220 get_block_t get_block,
17f8c842
OS
3221 dio_iodone_t end_io, dio_submit_t submit_io,
3222 int flags);
7bb46a67 3223
17f8c842
OS
3224static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3225 struct inode *inode,
c8b8e32d 3226 struct iov_iter *iter,
17f8c842 3227 get_block_t get_block)
1da177e4 3228{
17f8c842 3229 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
c8b8e32d 3230 get_block, NULL, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
1da177e4 3231}
9361401e 3232#endif
1da177e4 3233
1d59d61f 3234void inode_dio_wait(struct inode *inode);
fe0f07d0
JA
3235
3236/*
3237 * inode_dio_begin - signal start of a direct I/O requests
3238 * @inode: inode the direct I/O happens on
3239 *
3240 * This is called once we've finished processing a direct I/O request,
3241 * and is used to wake up callers waiting for direct I/O to be quiesced.
3242 */
3243static inline void inode_dio_begin(struct inode *inode)
3244{
3245 atomic_inc(&inode->i_dio_count);
3246}
3247
3248/*
3249 * inode_dio_end - signal finish of a direct I/O requests
3250 * @inode: inode the direct I/O happens on
3251 *
3252 * This is called once we've finished processing a direct I/O request,
3253 * and is used to wake up callers waiting for direct I/O to be quiesced.
3254 */
3255static inline void inode_dio_end(struct inode *inode)
3256{
3257 if (atomic_dec_and_test(&inode->i_dio_count))
3258 wake_up_bit(&inode->i_state, __I_DIO_WAKEUP);
3259}
1d59d61f 3260
a92853b6
KK
3261/*
3262 * Warn about a page cache invalidation failure diring a direct I/O write.
3263 */
3264void dio_warn_stale_pagecache(struct file *filp);
3265
5f16f322
TT
3266extern void inode_set_flags(struct inode *inode, unsigned int flags,
3267 unsigned int mask);
3268
4b6f5d20 3269extern const struct file_operations generic_ro_fops;
1da177e4
LT
3270
3271#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3272
5d826c84 3273extern int readlink_copy(char __user *, int, const char *);
1da177e4 3274extern int page_readlink(struct dentry *, char __user *, int);
fceef393
AV
3275extern const char *page_get_link(struct dentry *, struct inode *,
3276 struct delayed_call *);
3277extern void page_put_link(void *);
0adb25d2 3278extern int __page_symlink(struct inode *inode, const char *symname, int len,
54566b2c 3279 int nofs);
1da177e4 3280extern int page_symlink(struct inode *inode, const char *symname, int len);
c5ef1c42 3281extern const struct inode_operations page_symlink_inode_operations;
fceef393 3282extern void kfree_link(void *);
0d56a451 3283void generic_fillattr(struct user_namespace *, struct inode *, struct kstat *);
a528d35e
DH
3284extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3285extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
b462707e 3286void __inode_add_bytes(struct inode *inode, loff_t bytes);
1da177e4 3287void inode_add_bytes(struct inode *inode, loff_t bytes);
1c8924eb 3288void __inode_sub_bytes(struct inode *inode, loff_t bytes);
1da177e4 3289void inode_sub_bytes(struct inode *inode, loff_t bytes);
f4a8116a
JK
3290static inline loff_t __inode_get_bytes(struct inode *inode)
3291{
3292 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3293}
1da177e4
LT
3294loff_t inode_get_bytes(struct inode *inode);
3295void inode_set_bytes(struct inode *inode, loff_t bytes);
fceef393
AV
3296const char *simple_get_link(struct dentry *, struct inode *,
3297 struct delayed_call *);
61ba64fc 3298extern const struct inode_operations simple_symlink_inode_operations;
1da177e4 3299
5c0ba4e0 3300extern int iterate_dir(struct file *, struct dir_context *);
1da177e4 3301
09f1bde4
CH
3302int vfs_fstatat(int dfd, const char __user *filename, struct kstat *stat,
3303 int flags);
da9aa5d9 3304int vfs_fstat(int fd, struct kstat *stat);
a528d35e
DH
3305
3306static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3307{
0b2c6693 3308 return vfs_fstatat(AT_FDCWD, filename, stat, 0);
a528d35e
DH
3309}
3310static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3311{
0b2c6693 3312 return vfs_fstatat(AT_FDCWD, name, stat, AT_SYMLINK_NOFOLLOW);
a528d35e 3313}
a528d35e 3314
d60874cd 3315extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
fd4a0edf 3316extern int vfs_readlink(struct dentry *, char __user *, int);
1da177e4 3317
ee416bcd 3318extern struct file_system_type *get_filesystem(struct file_system_type *fs);
c18479fe 3319extern void put_filesystem(struct file_system_type *fs);
1da177e4
LT
3320extern struct file_system_type *get_fs_type(const char *name);
3321extern struct super_block *get_super(struct block_device *);
4504230a 3322extern struct super_block *get_active_super(struct block_device *bdev);
1da177e4 3323extern void drop_super(struct super_block *sb);
ba6379f7 3324extern void drop_super_exclusive(struct super_block *sb);
01a05b33 3325extern void iterate_supers(void (*)(struct super_block *, void *), void *);
43e15cdb
AV
3326extern void iterate_supers_type(struct file_system_type *,
3327 void (*)(struct super_block *, void *), void *);
1da177e4
LT
3328
3329extern int dcache_dir_open(struct inode *, struct file *);
3330extern int dcache_dir_close(struct inode *, struct file *);
3331extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
5f99f4e7 3332extern int dcache_readdir(struct file *, struct dir_context *);
549c7297
CB
3333extern int simple_setattr(struct user_namespace *, struct dentry *,
3334 struct iattr *);
3335extern int simple_getattr(struct user_namespace *, const struct path *,
3336 struct kstat *, u32, unsigned int);
726c3342 3337extern int simple_statfs(struct dentry *, struct kstatfs *);
20955e89 3338extern int simple_open(struct inode *inode, struct file *file);
1da177e4
LT
3339extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3340extern int simple_unlink(struct inode *, struct dentry *);
3341extern int simple_rmdir(struct inode *, struct dentry *);
549c7297
CB
3342extern int simple_rename(struct user_namespace *, struct inode *,
3343 struct dentry *, struct inode *, struct dentry *,
3344 unsigned int);
a3d1e7eb
AV
3345extern void simple_recursive_removal(struct dentry *,
3346 void (*callback)(struct dentry *));
02c24a82 3347extern int noop_fsync(struct file *, loff_t, loff_t, int);
f44c7763
DW
3348extern int noop_set_page_dirty(struct page *page);
3349extern void noop_invalidatepage(struct page *page, unsigned int offset,
3350 unsigned int length);
3351extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
1da177e4
LT
3352extern int simple_empty(struct dentry *);
3353extern int simple_readpage(struct file *file, struct page *page);
afddba49
NP
3354extern int simple_write_begin(struct file *file, struct address_space *mapping,
3355 loff_t pos, unsigned len, unsigned flags,
3356 struct page **pagep, void **fsdata);
3357extern int simple_write_end(struct file *file, struct address_space *mapping,
3358 loff_t pos, unsigned len, unsigned copied,
3359 struct page *page, void *fsdata);
b26d4cd3 3360extern int always_delete_dentry(const struct dentry *);
6987843f 3361extern struct inode *alloc_anon_inode(struct super_block *);
e6f5c789 3362extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
b26d4cd3 3363extern const struct dentry_operations simple_dentry_operations;
1da177e4 3364
00cd8dd3 3365extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
1da177e4 3366extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
4b6f5d20 3367extern const struct file_operations simple_dir_operations;
c5ef1c42 3368extern const struct inode_operations simple_dir_inode_operations;
fbabfd0f
EB
3369extern void make_empty_dir_inode(struct inode *inode);
3370extern bool is_empty_dir_inode(struct inode *inode);
cda37124 3371struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
1da177e4 3372struct dentry *d_alloc_name(struct dentry *, const char *);
cda37124
EB
3373extern int simple_fill_super(struct super_block *, unsigned long,
3374 const struct tree_descr *);
1f5ce9e9 3375extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
1da177e4
LT
3376extern void simple_release_fs(struct vfsmount **mount, int *count);
3377
93b07113
AM
3378extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3379 loff_t *ppos, const void *from, size_t available);
6a727b43
JS
3380extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3381 const void __user *from, size_t count);
1da177e4 3382
ac13a829 3383extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
02c24a82 3384extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
d5aacad5 3385
30ca22c7
PL
3386extern int generic_check_addressable(unsigned, u64);
3387
608af703 3388extern void generic_set_encrypted_ci_d_ops(struct dentry *dentry);
c843843e 3389
e965f963 3390#ifdef CONFIG_MIGRATION
2d1db3b1 3391extern int buffer_migrate_page(struct address_space *,
a6bc32b8
MG
3392 struct page *, struct page *,
3393 enum migrate_mode);
89cb0888
JK
3394extern int buffer_migrate_page_norefs(struct address_space *,
3395 struct page *, struct page *,
3396 enum migrate_mode);
e965f963
CL
3397#else
3398#define buffer_migrate_page NULL
89cb0888 3399#define buffer_migrate_page_norefs NULL
e965f963
CL
3400#endif
3401
2f221d6f 3402int setattr_prepare(struct user_namespace *, struct dentry *, struct iattr *);
25d9e2d1 3403extern int inode_newsize_ok(const struct inode *, loff_t offset);
2f221d6f
CB
3404void setattr_copy(struct user_namespace *, struct inode *inode,
3405 const struct iattr *attr);
1da177e4 3406
c3b2da31 3407extern int file_update_time(struct file *file);
1da177e4 3408
f05a3849 3409static inline bool vma_is_dax(const struct vm_area_struct *vma)
baabda26
DW
3410{
3411 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3412}
3413
2bb6d283
DW
3414static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3415{
3416 struct inode *inode;
3417
52650c8b 3418 if (!IS_ENABLED(CONFIG_FS_DAX) || !vma->vm_file)
2bb6d283
DW
3419 return false;
3420 if (!vma_is_dax(vma))
3421 return false;
3422 inode = file_inode(vma->vm_file);
230f5a89 3423 if (S_ISCHR(inode->i_mode))
2bb6d283
DW
3424 return false; /* device-dax */
3425 return true;
3426}
3427
2ba48ce5
AV
3428static inline int iocb_flags(struct file *file)
3429{
3430 int res = 0;
3431 if (file->f_flags & O_APPEND)
3432 res |= IOCB_APPEND;
efbe3c24 3433 if (file->f_flags & O_DIRECT)
2ba48ce5 3434 res |= IOCB_DIRECT;
dde0c2e7
CH
3435 if ((file->f_flags & O_DSYNC) || IS_SYNC(file->f_mapping->host))
3436 res |= IOCB_DSYNC;
3437 if (file->f_flags & __O_SYNC)
3438 res |= IOCB_SYNC;
2ba48ce5
AV
3439 return res;
3440}
3441
ddef7ed2 3442static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags)
fdd2f5b7 3443{
1752f0ad
PB
3444 int kiocb_flags = 0;
3445
ce71bfea
JA
3446 /* make sure there's no overlap between RWF and private IOCB flags */
3447 BUILD_BUG_ON((__force int) RWF_SUPPORTED & IOCB_EVENTFD);
3448
1752f0ad
PB
3449 if (!flags)
3450 return 0;
fdd2f5b7
GR
3451 if (unlikely(flags & ~RWF_SUPPORTED))
3452 return -EOPNOTSUPP;
3453
b745fafa 3454 if (flags & RWF_NOWAIT) {
91f9943e 3455 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
b745fafa 3456 return -EOPNOTSUPP;
ce71bfea 3457 kiocb_flags |= IOCB_NOIO;
b745fafa 3458 }
ce71bfea 3459 kiocb_flags |= (__force int) (flags & RWF_SUPPORTED);
fdd2f5b7 3460 if (flags & RWF_SYNC)
ce71bfea 3461 kiocb_flags |= IOCB_DSYNC;
1752f0ad
PB
3462
3463 ki->ki_flags |= kiocb_flags;
fdd2f5b7
GR
3464 return 0;
3465}
3466
1da177e4
LT
3467static inline ino_t parent_ino(struct dentry *dentry)
3468{
3469 ino_t res;
3470
b5c84bf6
NP
3471 /*
3472 * Don't strictly need d_lock here? If the parent ino could change
3473 * then surely we'd have a deeper race in the caller?
3474 */
1da177e4
LT
3475 spin_lock(&dentry->d_lock);
3476 res = dentry->d_parent->d_inode->i_ino;
3477 spin_unlock(&dentry->d_lock);
3478 return res;
3479}
3480
1da177e4
LT
3481/* Transaction based IO helpers */
3482
3483/*
3484 * An argresp is stored in an allocated page and holds the
3485 * size of the argument or response, along with its content
3486 */
3487struct simple_transaction_argresp {
3488 ssize_t size;
5e01fdff 3489 char data[];
1da177e4
LT
3490};
3491
3492#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3493
3494char *simple_transaction_get(struct file *file, const char __user *buf,
3495 size_t size);
3496ssize_t simple_transaction_read(struct file *file, char __user *buf,
3497 size_t size, loff_t *pos);
3498int simple_transaction_release(struct inode *inode, struct file *file);
3499
76791ab2 3500void simple_transaction_set(struct file *file, size_t n);
1da177e4 3501
acaefc25
AB
3502/*
3503 * simple attribute files
3504 *
3505 * These attributes behave similar to those in sysfs:
3506 *
3507 * Writing to an attribute immediately sets a value, an open file can be
3508 * written to multiple times.
3509 *
3510 * Reading from an attribute creates a buffer from the value that might get
3511 * read with multiple read calls. When the attribute has been read
3512 * completely, no further read calls are possible until the file is opened
3513 * again.
3514 *
3515 * All attributes contain a text representation of a numeric value
3516 * that are accessed with the get() and set() functions.
3517 */
3518#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3519static int __fops ## _open(struct inode *inode, struct file *file) \
3520{ \
3521 __simple_attr_check_format(__fmt, 0ull); \
3522 return simple_attr_open(inode, file, __get, __set, __fmt); \
3523} \
828c0950 3524static const struct file_operations __fops = { \
acaefc25
AB
3525 .owner = THIS_MODULE, \
3526 .open = __fops ## _open, \
74bedc4d 3527 .release = simple_attr_release, \
acaefc25
AB
3528 .read = simple_attr_read, \
3529 .write = simple_attr_write, \
1ec5584e 3530 .llseek = generic_file_llseek, \
68be3029 3531}
acaefc25 3532
b9075fa9
JP
3533static inline __printf(1, 2)
3534void __simple_attr_check_format(const char *fmt, ...)
acaefc25
AB
3535{
3536 /* don't do anything, just let the compiler check the arguments; */
3537}
3538
3539int simple_attr_open(struct inode *inode, struct file *file,
8b88b099 3540 int (*get)(void *, u64 *), int (*set)(void *, u64),
acaefc25 3541 const char *fmt);
74bedc4d 3542int simple_attr_release(struct inode *inode, struct file *file);
acaefc25
AB
3543ssize_t simple_attr_read(struct file *file, char __user *buf,
3544 size_t len, loff_t *ppos);
3545ssize_t simple_attr_write(struct file *file, const char __user *buf,
3546 size_t len, loff_t *ppos);
3547
4be28540 3548struct ctl_table;
8d65af78 3549int proc_nr_files(struct ctl_table *table, int write,
32927393 3550 void *buffer, size_t *lenp, loff_t *ppos);
312d3ca8 3551int proc_nr_dentry(struct ctl_table *table, int write,
32927393 3552 void *buffer, size_t *lenp, loff_t *ppos);
cffbc8aa 3553int proc_nr_inodes(struct ctl_table *table, int write,
32927393 3554 void *buffer, size_t *lenp, loff_t *ppos);
38e23c95 3555int __init get_filesystem_list(char *buf);
62239ac2 3556
3cd90ea4 3557#define __FMODE_EXEC ((__force int) FMODE_EXEC)
1a44bc8c
NK
3558#define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
3559
6d125529 3560#define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
ecf081d1 3561#define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
1a44bc8c 3562 (flag & __FMODE_NONOTIFY)))
5300990c 3563
d37177ba 3564static inline bool is_sxid(umode_t mode)
69b45732
AK
3565{
3566 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
3567}
3568
ba73d987
CB
3569static inline int check_sticky(struct user_namespace *mnt_userns,
3570 struct inode *dir, struct inode *inode)
cbdf35bc
MS
3571{
3572 if (!(dir->i_mode & S_ISVTX))
3573 return 0;
3574
ba73d987 3575 return __check_sticky(mnt_userns, dir, inode);
cbdf35bc
MS
3576}
3577
69b45732
AK
3578static inline void inode_has_no_xattr(struct inode *inode)
3579{
e462ec50 3580 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
69b45732
AK
3581 inode->i_flags |= S_NOSEC;
3582}
3583
a7400222
AV
3584static inline bool is_root_inode(struct inode *inode)
3585{
3586 return inode == inode->i_sb->s_root->d_inode;
3587}
3588
5f99f4e7
AV
3589static inline bool dir_emit(struct dir_context *ctx,
3590 const char *name, int namelen,
3591 u64 ino, unsigned type)
3592{
3593 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
3594}
3595static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3596{
3597 return ctx->actor(ctx, ".", 1, ctx->pos,
3598 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
3599}
3600static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3601{
3602 return ctx->actor(ctx, "..", 2, ctx->pos,
3603 parent_ino(file->f_path.dentry), DT_DIR) == 0;
3604}
3605static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3606{
3607 if (ctx->pos == 0) {
3608 if (!dir_emit_dot(file, ctx))
3609 return false;
3610 ctx->pos = 1;
3611 }
3612 if (ctx->pos == 1) {
3613 if (!dir_emit_dotdot(file, ctx))
3614 return false;
3615 ctx->pos = 2;
3616 }
3617 return true;
3618}
5ded75ec
AV
3619static inline bool dir_relax(struct inode *inode)
3620{
5955102c
AV
3621 inode_unlock(inode);
3622 inode_lock(inode);
5ded75ec
AV
3623 return !IS_DEADDIR(inode);
3624}
5f99f4e7 3625
ae05327a
AV
3626static inline bool dir_relax_shared(struct inode *inode)
3627{
3628 inode_unlock_shared(inode);
3629 inode_lock_shared(inode);
3630 return !IS_DEADDIR(inode);
3631}
3632
90f8572b 3633extern bool path_noexec(const struct path *path);
21fc61c7 3634extern void inode_nohighmem(struct inode *inode);
90f8572b 3635
45cd0faa
AG
3636/* mm/fadvise.c */
3637extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3638 int advice);
cf1ea059
JK
3639extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3640 int advice);
45cd0faa 3641
5aca2842
DW
3642int vfs_ioc_setflags_prepare(struct inode *inode, unsigned int oldflags,
3643 unsigned int flags);
3644
7b0e492e
DW
3645int vfs_ioc_fssetxattr_check(struct inode *inode, const struct fsxattr *old_fa,
3646 struct fsxattr *fa);
3647
3648static inline void simple_fill_fsxattr(struct fsxattr *fa, __u32 xflags)
3649{
3650 memset(fa, 0, sizeof(*fa));
3651 fa->fsx_xflags = xflags;
3652}
3653
dc617f29
DW
3654/*
3655 * Flush file data before changing attributes. Caller must hold any locks
3656 * required to prevent further writes to this file until we're done setting
3657 * flags.
3658 */
3659static inline int inode_drain_writes(struct inode *inode)
3660{
3661 inode_dio_wait(inode);
3662 return filemap_write_and_wait(inode->i_mapping);
3663}
3664
1da177e4 3665#endif /* _LINUX_FS_H */