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