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