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