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