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/rculist_bl.h>
28 #include <linux/atomic.h>
29 #include <linux/shrinker.h>
30 #include <linux/migrate_mode.h>
31 #include <linux/uidgid.h>
32 #include <linux/lockdep.h>
33 #include <linux/percpu-rwsem.h>
34 #include <linux/workqueue.h>
35 #include <linux/delayed_call.h>
36 #include <linux/uuid.h>
37 #include <linux/errseq.h>
38 #include <linux/ioprio.h>
39 #include <linux/fs_types.h>
40 #include <linux/build_bug.h>
41 #include <linux/stddef.h>
42 #include <linux/mount.h>
43 #include <linux/cred.h>
44 #include <linux/mnt_idmapping.h>
45 #include <linux/slab.h>
46 #include <linux/maple_tree.h>
47 #include <linux/rw_hint.h>
48 #include <linux/file_ref.h>
49 #include <linux/unicode.h>
50
51 #include <asm/byteorder.h>
52 #include <uapi/linux/fs.h>
53
54 struct backing_dev_info;
55 struct bdi_writeback;
56 struct bio;
57 struct io_comp_batch;
58 struct export_operations;
59 struct fiemap_extent_info;
60 struct hd_geometry;
61 struct iovec;
62 struct kiocb;
63 struct kobject;
64 struct pipe_inode_info;
65 struct poll_table_struct;
66 struct kstatfs;
67 struct vm_area_struct;
68 struct vfsmount;
69 struct cred;
70 struct swap_info_struct;
71 struct seq_file;
72 struct workqueue_struct;
73 struct iov_iter;
74 struct fscrypt_inode_info;
75 struct fscrypt_operations;
76 struct fsverity_info;
77 struct fsverity_operations;
78 struct fsnotify_mark_connector;
79 struct fsnotify_sb_info;
80 struct fs_context;
81 struct fs_parameter_spec;
82 struct fileattr;
83 struct iomap_ops;
84
85 extern void __init inode_init(void);
86 extern void __init inode_init_early(void);
87 extern void __init files_init(void);
88 extern void __init files_maxfiles_init(void);
89
90 extern unsigned long get_max_files(void);
91 extern unsigned int sysctl_nr_open;
92
93 typedef __kernel_rwf_t rwf_t;
94
95 struct buffer_head;
96 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
97 struct buffer_head *bh_result, int create);
98 typedef int (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
99 ssize_t bytes, void *private);
100
101 #define MAY_EXEC 0x00000001
102 #define MAY_WRITE 0x00000002
103 #define MAY_READ 0x00000004
104 #define MAY_APPEND 0x00000008
105 #define MAY_ACCESS 0x00000010
106 #define MAY_OPEN 0x00000020
107 #define MAY_CHDIR 0x00000040
108 /* called from RCU mode, don't block */
109 #define MAY_NOT_BLOCK 0x00000080
110
111 /*
112 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
113 * to O_WRONLY and O_RDWR via the strange trick in do_dentry_open()
114 */
115
116 /* file is open for reading */
117 #define FMODE_READ ((__force fmode_t)(1 << 0))
118 /* file is open for writing */
119 #define FMODE_WRITE ((__force fmode_t)(1 << 1))
120 /* file is seekable */
121 #define FMODE_LSEEK ((__force fmode_t)(1 << 2))
122 /* file can be accessed using pread */
123 #define FMODE_PREAD ((__force fmode_t)(1 << 3))
124 /* file can be accessed using pwrite */
125 #define FMODE_PWRITE ((__force fmode_t)(1 << 4))
126 /* File is opened for execution with sys_execve / sys_uselib */
127 #define FMODE_EXEC ((__force fmode_t)(1 << 5))
128 /* File writes are restricted (block device specific) */
129 #define FMODE_WRITE_RESTRICTED ((__force fmode_t)(1 << 6))
130 /* File supports atomic writes */
131 #define FMODE_CAN_ATOMIC_WRITE ((__force fmode_t)(1 << 7))
132
133 /* FMODE_* bit 8 */
134
135 /* 32bit hashes as llseek() offset (for directories) */
136 #define FMODE_32BITHASH ((__force fmode_t)(1 << 9))
137 /* 64bit hashes as llseek() offset (for directories) */
138 #define FMODE_64BITHASH ((__force fmode_t)(1 << 10))
139
140 /*
141 * Don't update ctime and mtime.
142 *
143 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
144 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
145 */
146 #define FMODE_NOCMTIME ((__force fmode_t)(1 << 11))
147
148 /* Expect random access pattern */
149 #define FMODE_RANDOM ((__force fmode_t)(1 << 12))
150
151 /* FMODE_* bit 13 */
152
153 /* File is opened with O_PATH; almost nothing can be done with it */
154 #define FMODE_PATH ((__force fmode_t)(1 << 14))
155
156 /* File needs atomic accesses to f_pos */
157 #define FMODE_ATOMIC_POS ((__force fmode_t)(1 << 15))
158 /* Write access to underlying fs */
159 #define FMODE_WRITER ((__force fmode_t)(1 << 16))
160 /* Has read method(s) */
161 #define FMODE_CAN_READ ((__force fmode_t)(1 << 17))
162 /* Has write method(s) */
163 #define FMODE_CAN_WRITE ((__force fmode_t)(1 << 18))
164
165 #define FMODE_OPENED ((__force fmode_t)(1 << 19))
166 #define FMODE_CREATED ((__force fmode_t)(1 << 20))
167
168 /* File is stream-like */
169 #define FMODE_STREAM ((__force fmode_t)(1 << 21))
170
171 /* File supports DIRECT IO */
172 #define FMODE_CAN_ODIRECT ((__force fmode_t)(1 << 22))
173
174 #define FMODE_NOREUSE ((__force fmode_t)(1 << 23))
175
176 /* File is embedded in backing_file object */
177 #define FMODE_BACKING ((__force fmode_t)(1 << 24))
178
179 /*
180 * Together with FMODE_NONOTIFY_PERM defines which fsnotify events shouldn't be
181 * generated (see below)
182 */
183 #define FMODE_NONOTIFY ((__force fmode_t)(1 << 25))
184
185 /*
186 * Together with FMODE_NONOTIFY defines which fsnotify events shouldn't be
187 * generated (see below)
188 */
189 #define FMODE_NONOTIFY_PERM ((__force fmode_t)(1 << 26))
190
191 /* File is capable of returning -EAGAIN if I/O will block */
192 #define FMODE_NOWAIT ((__force fmode_t)(1 << 27))
193
194 /* File represents mount that needs unmounting */
195 #define FMODE_NEED_UNMOUNT ((__force fmode_t)(1 << 28))
196
197 /* File does not contribute to nr_files count */
198 #define FMODE_NOACCOUNT ((__force fmode_t)(1 << 29))
199
200 /*
201 * The two FMODE_NONOTIFY* define which fsnotify events should not be generated
202 * for a file. These are the possible values of (f->f_mode &
203 * FMODE_FSNOTIFY_MASK) and their meaning:
204 *
205 * FMODE_NONOTIFY - suppress all (incl. non-permission) events.
206 * FMODE_NONOTIFY_PERM - suppress permission (incl. pre-content) events.
207 * FMODE_NONOTIFY | FMODE_NONOTIFY_PERM - suppress only pre-content events.
208 */
209 #define FMODE_FSNOTIFY_MASK \
210 (FMODE_NONOTIFY | FMODE_NONOTIFY_PERM)
211
212 #define FMODE_FSNOTIFY_NONE(mode) \
213 ((mode & FMODE_FSNOTIFY_MASK) == FMODE_NONOTIFY)
214 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
215 #define FMODE_FSNOTIFY_PERM(mode) \
216 ((mode & FMODE_FSNOTIFY_MASK) == 0 || \
217 (mode & FMODE_FSNOTIFY_MASK) == (FMODE_NONOTIFY | FMODE_NONOTIFY_PERM))
218 #define FMODE_FSNOTIFY_HSM(mode) \
219 ((mode & FMODE_FSNOTIFY_MASK) == 0)
220 #else
221 #define FMODE_FSNOTIFY_PERM(mode) 0
222 #define FMODE_FSNOTIFY_HSM(mode) 0
223 #endif
224
225 /*
226 * Attribute flags. These should be or-ed together to figure out what
227 * has been changed!
228 */
229 #define ATTR_MODE (1 << 0)
230 #define ATTR_UID (1 << 1)
231 #define ATTR_GID (1 << 2)
232 #define ATTR_SIZE (1 << 3)
233 #define ATTR_ATIME (1 << 4)
234 #define ATTR_MTIME (1 << 5)
235 #define ATTR_CTIME (1 << 6)
236 #define ATTR_ATIME_SET (1 << 7)
237 #define ATTR_MTIME_SET (1 << 8)
238 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
239 #define ATTR_KILL_SUID (1 << 11)
240 #define ATTR_KILL_SGID (1 << 12)
241 #define ATTR_FILE (1 << 13)
242 #define ATTR_KILL_PRIV (1 << 14)
243 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
244 #define ATTR_TIMES_SET (1 << 16)
245 #define ATTR_TOUCH (1 << 17)
246 #define ATTR_DELEG (1 << 18) /* Delegated attrs. Don't break write delegations */
247
248 /*
249 * Whiteout is represented by a char device. The following constants define the
250 * mode and device number to use.
251 */
252 #define WHITEOUT_MODE 0
253 #define WHITEOUT_DEV 0
254
255 /*
256 * This is the Inode Attributes structure, used for notify_change(). It
257 * uses the above definitions as flags, to know which values have changed.
258 * Also, in this manner, a Filesystem can look at only the values it cares
259 * about. Basically, these are the attributes that the VFS layer can
260 * request to change from the FS layer.
261 *
262 * Derek Atkins <warlord@MIT.EDU> 94-10-20
263 */
264 struct iattr {
265 unsigned int ia_valid;
266 umode_t ia_mode;
267 /*
268 * The two anonymous unions wrap structures with the same member.
269 *
270 * Filesystems raising FS_ALLOW_IDMAP need to use ia_vfs{g,u}id which
271 * are a dedicated type requiring the filesystem to use the dedicated
272 * helpers. Other filesystem can continue to use ia_{g,u}id until they
273 * have been ported.
274 *
275 * They always contain the same value. In other words FS_ALLOW_IDMAP
276 * pass down the same value on idmapped mounts as they would on regular
277 * mounts.
278 */
279 union {
280 kuid_t ia_uid;
281 vfsuid_t ia_vfsuid;
282 };
283 union {
284 kgid_t ia_gid;
285 vfsgid_t ia_vfsgid;
286 };
287 loff_t ia_size;
288 struct timespec64 ia_atime;
289 struct timespec64 ia_mtime;
290 struct timespec64 ia_ctime;
291
292 /*
293 * Not an attribute, but an auxiliary info for filesystems wanting to
294 * implement an ftruncate() like method. NOTE: filesystem should
295 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
296 */
297 struct file *ia_file;
298 };
299
300 /*
301 * Includes for diskquotas.
302 */
303 #include <linux/quota.h>
304
305 /*
306 * Maximum number of layers of fs stack. Needs to be limited to
307 * prevent kernel stack overflow
308 */
309 #define FILESYSTEM_MAX_STACK_DEPTH 2
310
311 /**
312 * enum positive_aop_returns - aop return codes with specific semantics
313 *
314 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
315 * completed, that the page is still locked, and
316 * should be considered active. The VM uses this hint
317 * to return the page to the active list -- it won't
318 * be a candidate for writeback again in the near
319 * future. Other callers must be careful to unlock
320 * the page if they get this return. Returned by
321 * writepage();
322 *
323 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
324 * unlocked it and the page might have been truncated.
325 * The caller should back up to acquiring a new page and
326 * trying again. The aop will be taking reasonable
327 * precautions not to livelock. If the caller held a page
328 * reference, it should drop it before retrying. Returned
329 * by read_folio().
330 *
331 * address_space_operation functions return these large constants to indicate
332 * special semantics to the caller. These are much larger than the bytes in a
333 * page to allow for functions that return the number of bytes operated on in a
334 * given page.
335 */
336
337 enum positive_aop_returns {
338 AOP_WRITEPAGE_ACTIVATE = 0x80000,
339 AOP_TRUNCATED_PAGE = 0x80001,
340 };
341
342 /*
343 * oh the beauties of C type declarations.
344 */
345 struct page;
346 struct address_space;
347 struct writeback_control;
348 struct readahead_control;
349
350 /* Match RWF_* bits to IOCB bits */
351 #define IOCB_HIPRI (__force int) RWF_HIPRI
352 #define IOCB_DSYNC (__force int) RWF_DSYNC
353 #define IOCB_SYNC (__force int) RWF_SYNC
354 #define IOCB_NOWAIT (__force int) RWF_NOWAIT
355 #define IOCB_APPEND (__force int) RWF_APPEND
356 #define IOCB_ATOMIC (__force int) RWF_ATOMIC
357 #define IOCB_DONTCACHE (__force int) RWF_DONTCACHE
358
359 /* non-RWF related bits - start at 16 */
360 #define IOCB_EVENTFD (1 << 16)
361 #define IOCB_DIRECT (1 << 17)
362 #define IOCB_WRITE (1 << 18)
363 /* iocb->ki_waitq is valid */
364 #define IOCB_WAITQ (1 << 19)
365 #define IOCB_NOIO (1 << 20)
366 /* can use bio alloc cache */
367 #define IOCB_ALLOC_CACHE (1 << 21)
368 /*
369 * IOCB_DIO_CALLER_COMP can be set by the iocb owner, to indicate that the
370 * iocb completion can be passed back to the owner for execution from a safe
371 * context rather than needing to be punted through a workqueue. If this
372 * flag is set, the bio completion handling may set iocb->dio_complete to a
373 * handler function and iocb->private to context information for that handler.
374 * The issuer should call the handler with that context information from task
375 * context to complete the processing of the iocb. Note that while this
376 * provides a task context for the dio_complete() callback, it should only be
377 * used on the completion side for non-IO generating completions. It's fine to
378 * call blocking functions from this callback, but they should not wait for
379 * unrelated IO (like cache flushing, new IO generation, etc).
380 */
381 #define IOCB_DIO_CALLER_COMP (1 << 22)
382 /* kiocb is a read or write operation submitted by fs/aio.c. */
383 #define IOCB_AIO_RW (1 << 23)
384 #define IOCB_HAS_METADATA (1 << 24)
385
386 /* for use in trace events */
387 #define TRACE_IOCB_STRINGS \
388 { IOCB_HIPRI, "HIPRI" }, \
389 { IOCB_DSYNC, "DSYNC" }, \
390 { IOCB_SYNC, "SYNC" }, \
391 { IOCB_NOWAIT, "NOWAIT" }, \
392 { IOCB_APPEND, "APPEND" }, \
393 { IOCB_ATOMIC, "ATOMIC" }, \
394 { IOCB_DONTCACHE, "DONTCACHE" }, \
395 { IOCB_EVENTFD, "EVENTFD"}, \
396 { IOCB_DIRECT, "DIRECT" }, \
397 { IOCB_WRITE, "WRITE" }, \
398 { IOCB_WAITQ, "WAITQ" }, \
399 { IOCB_NOIO, "NOIO" }, \
400 { IOCB_ALLOC_CACHE, "ALLOC_CACHE" }, \
401 { IOCB_DIO_CALLER_COMP, "CALLER_COMP" }
402
403 struct kiocb {
404 struct file *ki_filp;
405 loff_t ki_pos;
406 void (*ki_complete)(struct kiocb *iocb, long ret);
407 void *private;
408 int ki_flags;
409 u16 ki_ioprio; /* See linux/ioprio.h */
410 union {
411 /*
412 * Only used for async buffered reads, where it denotes the
413 * page waitqueue associated with completing the read. Valid
414 * IFF IOCB_WAITQ is set.
415 */
416 struct wait_page_queue *ki_waitq;
417 /*
418 * Can be used for O_DIRECT IO, where the completion handling
419 * is punted back to the issuer of the IO. May only be set
420 * if IOCB_DIO_CALLER_COMP is set by the issuer, and the issuer
421 * must then check for presence of this handler when ki_complete
422 * is invoked. The data passed in to this handler must be
423 * assigned to ->private when dio_complete is assigned.
424 */
425 ssize_t (*dio_complete)(void *data);
426 };
427 };
428
is_sync_kiocb(struct kiocb * kiocb)429 static inline bool is_sync_kiocb(struct kiocb *kiocb)
430 {
431 return kiocb->ki_complete == NULL;
432 }
433
434 struct address_space_operations {
435 int (*writepage)(struct page *page, struct writeback_control *wbc);
436 int (*read_folio)(struct file *, struct folio *);
437
438 /* Write back some dirty pages from this mapping. */
439 int (*writepages)(struct address_space *, struct writeback_control *);
440
441 /* Mark a folio dirty. Return true if this dirtied it */
442 bool (*dirty_folio)(struct address_space *, struct folio *);
443
444 void (*readahead)(struct readahead_control *);
445
446 int (*write_begin)(struct file *, struct address_space *mapping,
447 loff_t pos, unsigned len,
448 struct folio **foliop, void **fsdata);
449 int (*write_end)(struct file *, struct address_space *mapping,
450 loff_t pos, unsigned len, unsigned copied,
451 struct folio *folio, void *fsdata);
452
453 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
454 sector_t (*bmap)(struct address_space *, sector_t);
455 void (*invalidate_folio) (struct folio *, size_t offset, size_t len);
456 bool (*release_folio)(struct folio *, gfp_t);
457 void (*free_folio)(struct folio *folio);
458 ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter);
459 /*
460 * migrate the contents of a folio to the specified target. If
461 * migrate_mode is MIGRATE_ASYNC, it must not block.
462 */
463 int (*migrate_folio)(struct address_space *, struct folio *dst,
464 struct folio *src, enum migrate_mode);
465 int (*launder_folio)(struct folio *);
466 bool (*is_partially_uptodate) (struct folio *, size_t from,
467 size_t count);
468 void (*is_dirty_writeback) (struct folio *, bool *dirty, bool *wb);
469 int (*error_remove_folio)(struct address_space *, struct folio *);
470
471 /* swapfile support */
472 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
473 sector_t *span);
474 void (*swap_deactivate)(struct file *file);
475 int (*swap_rw)(struct kiocb *iocb, struct iov_iter *iter);
476 };
477
478 extern const struct address_space_operations empty_aops;
479
480 /**
481 * struct address_space - Contents of a cacheable, mappable object.
482 * @host: Owner, either the inode or the block_device.
483 * @i_pages: Cached pages.
484 * @invalidate_lock: Guards coherency between page cache contents and
485 * file offset->disk block mappings in the filesystem during invalidates.
486 * It is also used to block modification of page cache contents through
487 * memory mappings.
488 * @gfp_mask: Memory allocation flags to use for allocating pages.
489 * @i_mmap_writable: Number of VM_SHARED, VM_MAYWRITE mappings.
490 * @nr_thps: Number of THPs in the pagecache (non-shmem only).
491 * @i_mmap: Tree of private and shared mappings.
492 * @i_mmap_rwsem: Protects @i_mmap and @i_mmap_writable.
493 * @nrpages: Number of page entries, protected by the i_pages lock.
494 * @writeback_index: Writeback starts here.
495 * @a_ops: Methods.
496 * @flags: Error bits and flags (AS_*).
497 * @wb_err: The most recent error which has occurred.
498 * @i_private_lock: For use by the owner of the address_space.
499 * @i_private_list: For use by the owner of the address_space.
500 * @i_private_data: For use by the owner of the address_space.
501 */
502 struct address_space {
503 struct inode *host;
504 struct xarray i_pages;
505 struct rw_semaphore invalidate_lock;
506 gfp_t gfp_mask;
507 atomic_t i_mmap_writable;
508 #ifdef CONFIG_READ_ONLY_THP_FOR_FS
509 /* number of thp, only for non-shmem files */
510 atomic_t nr_thps;
511 #endif
512 struct rb_root_cached i_mmap;
513 unsigned long nrpages;
514 pgoff_t writeback_index;
515 const struct address_space_operations *a_ops;
516 unsigned long flags;
517 errseq_t wb_err;
518 spinlock_t i_private_lock;
519 struct list_head i_private_list;
520 struct rw_semaphore i_mmap_rwsem;
521 void * i_private_data;
522 } __attribute__((aligned(sizeof(long)))) __randomize_layout;
523 /*
524 * On most architectures that alignment is already the case; but
525 * must be enforced here for CRIS, to let the least significant bit
526 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
527 */
528
529 /* XArray tags, for tagging dirty and writeback pages in the pagecache. */
530 #define PAGECACHE_TAG_DIRTY XA_MARK_0
531 #define PAGECACHE_TAG_WRITEBACK XA_MARK_1
532 #define PAGECACHE_TAG_TOWRITE XA_MARK_2
533
534 /*
535 * Returns true if any of the pages in the mapping are marked with the tag.
536 */
mapping_tagged(struct address_space * mapping,xa_mark_t tag)537 static inline bool mapping_tagged(struct address_space *mapping, xa_mark_t tag)
538 {
539 return xa_marked(&mapping->i_pages, tag);
540 }
541
i_mmap_lock_write(struct address_space * mapping)542 static inline void i_mmap_lock_write(struct address_space *mapping)
543 {
544 down_write(&mapping->i_mmap_rwsem);
545 }
546
i_mmap_trylock_write(struct address_space * mapping)547 static inline int i_mmap_trylock_write(struct address_space *mapping)
548 {
549 return down_write_trylock(&mapping->i_mmap_rwsem);
550 }
551
i_mmap_unlock_write(struct address_space * mapping)552 static inline void i_mmap_unlock_write(struct address_space *mapping)
553 {
554 up_write(&mapping->i_mmap_rwsem);
555 }
556
i_mmap_trylock_read(struct address_space * mapping)557 static inline int i_mmap_trylock_read(struct address_space *mapping)
558 {
559 return down_read_trylock(&mapping->i_mmap_rwsem);
560 }
561
i_mmap_lock_read(struct address_space * mapping)562 static inline void i_mmap_lock_read(struct address_space *mapping)
563 {
564 down_read(&mapping->i_mmap_rwsem);
565 }
566
i_mmap_unlock_read(struct address_space * mapping)567 static inline void i_mmap_unlock_read(struct address_space *mapping)
568 {
569 up_read(&mapping->i_mmap_rwsem);
570 }
571
i_mmap_assert_locked(struct address_space * mapping)572 static inline void i_mmap_assert_locked(struct address_space *mapping)
573 {
574 lockdep_assert_held(&mapping->i_mmap_rwsem);
575 }
576
i_mmap_assert_write_locked(struct address_space * mapping)577 static inline void i_mmap_assert_write_locked(struct address_space *mapping)
578 {
579 lockdep_assert_held_write(&mapping->i_mmap_rwsem);
580 }
581
582 /*
583 * Might pages of this file be mapped into userspace?
584 */
mapping_mapped(struct address_space * mapping)585 static inline int mapping_mapped(struct address_space *mapping)
586 {
587 return !RB_EMPTY_ROOT(&mapping->i_mmap.rb_root);
588 }
589
590 /*
591 * Might pages of this file have been modified in userspace?
592 * Note that i_mmap_writable counts all VM_SHARED, VM_MAYWRITE vmas: do_mmap
593 * marks vma as VM_SHARED if it is shared, and the file was opened for
594 * writing i.e. vma may be mprotected writable even if now readonly.
595 *
596 * If i_mmap_writable is negative, no new writable mappings are allowed. You
597 * can only deny writable mappings, if none exists right now.
598 */
mapping_writably_mapped(struct address_space * mapping)599 static inline int mapping_writably_mapped(struct address_space *mapping)
600 {
601 return atomic_read(&mapping->i_mmap_writable) > 0;
602 }
603
mapping_map_writable(struct address_space * mapping)604 static inline int mapping_map_writable(struct address_space *mapping)
605 {
606 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
607 0 : -EPERM;
608 }
609
mapping_unmap_writable(struct address_space * mapping)610 static inline void mapping_unmap_writable(struct address_space *mapping)
611 {
612 atomic_dec(&mapping->i_mmap_writable);
613 }
614
mapping_deny_writable(struct address_space * mapping)615 static inline int mapping_deny_writable(struct address_space *mapping)
616 {
617 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
618 0 : -EBUSY;
619 }
620
mapping_allow_writable(struct address_space * mapping)621 static inline void mapping_allow_writable(struct address_space *mapping)
622 {
623 atomic_inc(&mapping->i_mmap_writable);
624 }
625
626 /*
627 * Use sequence counter to get consistent i_size on 32-bit processors.
628 */
629 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
630 #include <linux/seqlock.h>
631 #define __NEED_I_SIZE_ORDERED
632 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
633 #else
634 #define i_size_ordered_init(inode) do { } while (0)
635 #endif
636
637 struct posix_acl;
638 #define ACL_NOT_CACHED ((void *)(-1))
639 /*
640 * ACL_DONT_CACHE is for stacked filesystems, that rely on underlying fs to
641 * cache the ACL. This also means that ->get_inode_acl() can be called in RCU
642 * mode with the LOOKUP_RCU flag.
643 */
644 #define ACL_DONT_CACHE ((void *)(-3))
645
646 static inline struct posix_acl *
uncached_acl_sentinel(struct task_struct * task)647 uncached_acl_sentinel(struct task_struct *task)
648 {
649 return (void *)task + 1;
650 }
651
652 static inline bool
is_uncached_acl(struct posix_acl * acl)653 is_uncached_acl(struct posix_acl *acl)
654 {
655 return (long)acl & 1;
656 }
657
658 #define IOP_FASTPERM 0x0001
659 #define IOP_LOOKUP 0x0002
660 #define IOP_NOFOLLOW 0x0004
661 #define IOP_XATTR 0x0008
662 #define IOP_DEFAULT_READLINK 0x0010
663 #define IOP_MGTIME 0x0020
664 #define IOP_CACHED_LINK 0x0040
665
666 /*
667 * Keep mostly read-only and often accessed (especially for
668 * the RCU path lookup and 'stat' data) fields at the beginning
669 * of the 'struct inode'
670 */
671 struct inode {
672 umode_t i_mode;
673 unsigned short i_opflags;
674 kuid_t i_uid;
675 kgid_t i_gid;
676 unsigned int i_flags;
677
678 #ifdef CONFIG_FS_POSIX_ACL
679 struct posix_acl *i_acl;
680 struct posix_acl *i_default_acl;
681 #endif
682
683 const struct inode_operations *i_op;
684 struct super_block *i_sb;
685 struct address_space *i_mapping;
686
687 #ifdef CONFIG_SECURITY
688 void *i_security;
689 #endif
690
691 /* Stat data, not accessed from path walking */
692 unsigned long i_ino;
693 /*
694 * Filesystems may only read i_nlink directly. They shall use the
695 * following functions for modification:
696 *
697 * (set|clear|inc|drop)_nlink
698 * inode_(inc|dec)_link_count
699 */
700 union {
701 const unsigned int i_nlink;
702 unsigned int __i_nlink;
703 };
704 dev_t i_rdev;
705 loff_t i_size;
706 time64_t i_atime_sec;
707 time64_t i_mtime_sec;
708 time64_t i_ctime_sec;
709 u32 i_atime_nsec;
710 u32 i_mtime_nsec;
711 u32 i_ctime_nsec;
712 u32 i_generation;
713 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
714 unsigned short i_bytes;
715 u8 i_blkbits;
716 enum rw_hint i_write_hint;
717 blkcnt_t i_blocks;
718
719 #ifdef __NEED_I_SIZE_ORDERED
720 seqcount_t i_size_seqcount;
721 #endif
722
723 /* Misc */
724 u32 i_state;
725 /* 32-bit hole */
726 struct rw_semaphore i_rwsem;
727
728 unsigned long dirtied_when; /* jiffies of first dirtying */
729 unsigned long dirtied_time_when;
730
731 struct hlist_node i_hash;
732 struct list_head i_io_list; /* backing dev IO list */
733 #ifdef CONFIG_CGROUP_WRITEBACK
734 struct bdi_writeback *i_wb; /* the associated cgroup wb */
735
736 /* foreign inode detection, see wbc_detach_inode() */
737 int i_wb_frn_winner;
738 u16 i_wb_frn_avg_time;
739 u16 i_wb_frn_history;
740 #endif
741 struct list_head i_lru; /* inode LRU list */
742 struct list_head i_sb_list;
743 struct list_head i_wb_list; /* backing dev writeback list */
744 union {
745 struct hlist_head i_dentry;
746 struct rcu_head i_rcu;
747 };
748 atomic64_t i_version;
749 atomic64_t i_sequence; /* see futex */
750 atomic_t i_count;
751 atomic_t i_dio_count;
752 atomic_t i_writecount;
753 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
754 atomic_t i_readcount; /* struct files open RO */
755 #endif
756 union {
757 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
758 void (*free_inode)(struct inode *);
759 };
760 struct file_lock_context *i_flctx;
761 struct address_space i_data;
762 union {
763 struct list_head i_devices;
764 int i_linklen;
765 };
766 union {
767 struct pipe_inode_info *i_pipe;
768 struct cdev *i_cdev;
769 char *i_link;
770 unsigned i_dir_seq;
771 };
772
773
774 #ifdef CONFIG_FSNOTIFY
775 __u32 i_fsnotify_mask; /* all events this inode cares about */
776 /* 32-bit hole reserved for expanding i_fsnotify_mask */
777 struct fsnotify_mark_connector __rcu *i_fsnotify_marks;
778 #endif
779
780 #ifdef CONFIG_FS_ENCRYPTION
781 struct fscrypt_inode_info *i_crypt_info;
782 #endif
783
784 #ifdef CONFIG_FS_VERITY
785 struct fsverity_info *i_verity_info;
786 #endif
787
788 void *i_private; /* fs or device private pointer */
789 } __randomize_layout;
790
inode_set_cached_link(struct inode * inode,char * link,int linklen)791 static inline void inode_set_cached_link(struct inode *inode, char *link, int linklen)
792 {
793 int testlen;
794
795 /*
796 * TODO: patch it into a debug-only check if relevant macros show up.
797 * In the meantime, since we are suffering strlen even on production kernels
798 * to find the right length, do a fixup if the wrong value got passed.
799 */
800 testlen = strlen(link);
801 if (testlen != linklen) {
802 WARN_ONCE(1, "bad length passed for symlink [%s] (got %d, expected %d)",
803 link, linklen, testlen);
804 linklen = testlen;
805 }
806 inode->i_link = link;
807 inode->i_linklen = linklen;
808 inode->i_opflags |= IOP_CACHED_LINK;
809 }
810
811 /*
812 * Get bit address from inode->i_state to use with wait_var_event()
813 * infrastructre.
814 */
815 #define inode_state_wait_address(inode, bit) ((char *)&(inode)->i_state + (bit))
816
817 struct wait_queue_head *inode_bit_waitqueue(struct wait_bit_queue_entry *wqe,
818 struct inode *inode, u32 bit);
819
inode_wake_up_bit(struct inode * inode,u32 bit)820 static inline void inode_wake_up_bit(struct inode *inode, u32 bit)
821 {
822 /* Caller is responsible for correct memory barriers. */
823 wake_up_var(inode_state_wait_address(inode, bit));
824 }
825
826 struct timespec64 timestamp_truncate(struct timespec64 t, struct inode *inode);
827
i_blocksize(const struct inode * node)828 static inline unsigned int i_blocksize(const struct inode *node)
829 {
830 return (1 << node->i_blkbits);
831 }
832
inode_unhashed(struct inode * inode)833 static inline int inode_unhashed(struct inode *inode)
834 {
835 return hlist_unhashed(&inode->i_hash);
836 }
837
838 /*
839 * __mark_inode_dirty expects inodes to be hashed. Since we don't
840 * want special inodes in the fileset inode space, we make them
841 * appear hashed, but do not put on any lists. hlist_del()
842 * will work fine and require no locking.
843 */
inode_fake_hash(struct inode * inode)844 static inline void inode_fake_hash(struct inode *inode)
845 {
846 hlist_add_fake(&inode->i_hash);
847 }
848
849 /*
850 * inode->i_mutex nesting subclasses for the lock validator:
851 *
852 * 0: the object of the current VFS operation
853 * 1: parent
854 * 2: child/target
855 * 3: xattr
856 * 4: second non-directory
857 * 5: second parent (when locking independent directories in rename)
858 *
859 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
860 * non-directories at once.
861 *
862 * The locking order between these classes is
863 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
864 */
865 enum inode_i_mutex_lock_class
866 {
867 I_MUTEX_NORMAL,
868 I_MUTEX_PARENT,
869 I_MUTEX_CHILD,
870 I_MUTEX_XATTR,
871 I_MUTEX_NONDIR2,
872 I_MUTEX_PARENT2,
873 };
874
inode_lock(struct inode * inode)875 static inline void inode_lock(struct inode *inode)
876 {
877 down_write(&inode->i_rwsem);
878 }
879
inode_unlock(struct inode * inode)880 static inline void inode_unlock(struct inode *inode)
881 {
882 up_write(&inode->i_rwsem);
883 }
884
inode_lock_shared(struct inode * inode)885 static inline void inode_lock_shared(struct inode *inode)
886 {
887 down_read(&inode->i_rwsem);
888 }
889
inode_unlock_shared(struct inode * inode)890 static inline void inode_unlock_shared(struct inode *inode)
891 {
892 up_read(&inode->i_rwsem);
893 }
894
inode_trylock(struct inode * inode)895 static inline int inode_trylock(struct inode *inode)
896 {
897 return down_write_trylock(&inode->i_rwsem);
898 }
899
inode_trylock_shared(struct inode * inode)900 static inline int inode_trylock_shared(struct inode *inode)
901 {
902 return down_read_trylock(&inode->i_rwsem);
903 }
904
inode_is_locked(struct inode * inode)905 static inline int inode_is_locked(struct inode *inode)
906 {
907 return rwsem_is_locked(&inode->i_rwsem);
908 }
909
inode_lock_nested(struct inode * inode,unsigned subclass)910 static inline void inode_lock_nested(struct inode *inode, unsigned subclass)
911 {
912 down_write_nested(&inode->i_rwsem, subclass);
913 }
914
inode_lock_shared_nested(struct inode * inode,unsigned subclass)915 static inline void inode_lock_shared_nested(struct inode *inode, unsigned subclass)
916 {
917 down_read_nested(&inode->i_rwsem, subclass);
918 }
919
filemap_invalidate_lock(struct address_space * mapping)920 static inline void filemap_invalidate_lock(struct address_space *mapping)
921 {
922 down_write(&mapping->invalidate_lock);
923 }
924
filemap_invalidate_unlock(struct address_space * mapping)925 static inline void filemap_invalidate_unlock(struct address_space *mapping)
926 {
927 up_write(&mapping->invalidate_lock);
928 }
929
filemap_invalidate_lock_shared(struct address_space * mapping)930 static inline void filemap_invalidate_lock_shared(struct address_space *mapping)
931 {
932 down_read(&mapping->invalidate_lock);
933 }
934
filemap_invalidate_trylock_shared(struct address_space * mapping)935 static inline int filemap_invalidate_trylock_shared(
936 struct address_space *mapping)
937 {
938 return down_read_trylock(&mapping->invalidate_lock);
939 }
940
filemap_invalidate_unlock_shared(struct address_space * mapping)941 static inline void filemap_invalidate_unlock_shared(
942 struct address_space *mapping)
943 {
944 up_read(&mapping->invalidate_lock);
945 }
946
947 void lock_two_nondirectories(struct inode *, struct inode*);
948 void unlock_two_nondirectories(struct inode *, struct inode*);
949
950 void filemap_invalidate_lock_two(struct address_space *mapping1,
951 struct address_space *mapping2);
952 void filemap_invalidate_unlock_two(struct address_space *mapping1,
953 struct address_space *mapping2);
954
955
956 /*
957 * NOTE: in a 32bit arch with a preemptable kernel and
958 * an UP compile the i_size_read/write must be atomic
959 * with respect to the local cpu (unlike with preempt disabled),
960 * but they don't need to be atomic with respect to other cpus like in
961 * true SMP (so they need either to either locally disable irq around
962 * the read or for example on x86 they can be still implemented as a
963 * cmpxchg8b without the need of the lock prefix). For SMP compiles
964 * and 64bit archs it makes no difference if preempt is enabled or not.
965 */
i_size_read(const struct inode * inode)966 static inline loff_t i_size_read(const struct inode *inode)
967 {
968 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
969 loff_t i_size;
970 unsigned int seq;
971
972 do {
973 seq = read_seqcount_begin(&inode->i_size_seqcount);
974 i_size = inode->i_size;
975 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
976 return i_size;
977 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
978 loff_t i_size;
979
980 preempt_disable();
981 i_size = inode->i_size;
982 preempt_enable();
983 return i_size;
984 #else
985 /* Pairs with smp_store_release() in i_size_write() */
986 return smp_load_acquire(&inode->i_size);
987 #endif
988 }
989
990 /*
991 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
992 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
993 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
994 */
i_size_write(struct inode * inode,loff_t i_size)995 static inline void i_size_write(struct inode *inode, loff_t i_size)
996 {
997 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
998 preempt_disable();
999 write_seqcount_begin(&inode->i_size_seqcount);
1000 inode->i_size = i_size;
1001 write_seqcount_end(&inode->i_size_seqcount);
1002 preempt_enable();
1003 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
1004 preempt_disable();
1005 inode->i_size = i_size;
1006 preempt_enable();
1007 #else
1008 /*
1009 * Pairs with smp_load_acquire() in i_size_read() to ensure
1010 * changes related to inode size (such as page contents) are
1011 * visible before we see the changed inode size.
1012 */
1013 smp_store_release(&inode->i_size, i_size);
1014 #endif
1015 }
1016
iminor(const struct inode * inode)1017 static inline unsigned iminor(const struct inode *inode)
1018 {
1019 return MINOR(inode->i_rdev);
1020 }
1021
imajor(const struct inode * inode)1022 static inline unsigned imajor(const struct inode *inode)
1023 {
1024 return MAJOR(inode->i_rdev);
1025 }
1026
1027 struct fown_struct {
1028 struct file *file; /* backpointer for security modules */
1029 rwlock_t lock; /* protects pid, uid, euid fields */
1030 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
1031 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
1032 kuid_t uid, euid; /* uid/euid of process setting the owner */
1033 int signum; /* posix.1b rt signal to be delivered on IO */
1034 };
1035
1036 /**
1037 * struct file_ra_state - Track a file's readahead state.
1038 * @start: Where the most recent readahead started.
1039 * @size: Number of pages read in the most recent readahead.
1040 * @async_size: Numer of pages that were/are not needed immediately
1041 * and so were/are genuinely "ahead". Start next readahead when
1042 * the first of these pages is accessed.
1043 * @ra_pages: Maximum size of a readahead request, copied from the bdi.
1044 * @mmap_miss: How many mmap accesses missed in the page cache.
1045 * @prev_pos: The last byte in the most recent read request.
1046 *
1047 * When this structure is passed to ->readahead(), the "most recent"
1048 * readahead means the current readahead.
1049 */
1050 struct file_ra_state {
1051 pgoff_t start;
1052 unsigned int size;
1053 unsigned int async_size;
1054 unsigned int ra_pages;
1055 unsigned int mmap_miss;
1056 loff_t prev_pos;
1057 };
1058
1059 /*
1060 * Check if @index falls in the readahead windows.
1061 */
ra_has_index(struct file_ra_state * ra,pgoff_t index)1062 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
1063 {
1064 return (index >= ra->start &&
1065 index < ra->start + ra->size);
1066 }
1067
1068 /**
1069 * struct file - Represents a file
1070 * @f_ref: reference count
1071 * @f_lock: Protects f_ep, f_flags. Must not be taken from IRQ context.
1072 * @f_mode: FMODE_* flags often used in hotpaths
1073 * @f_op: file operations
1074 * @f_mapping: Contents of a cacheable, mappable object.
1075 * @private_data: filesystem or driver specific data
1076 * @f_inode: cached inode
1077 * @f_flags: file flags
1078 * @f_iocb_flags: iocb flags
1079 * @f_cred: stashed credentials of creator/opener
1080 * @f_path: path of the file
1081 * @f_pos_lock: lock protecting file position
1082 * @f_pipe: specific to pipes
1083 * @f_pos: file position
1084 * @f_security: LSM security context of this file
1085 * @f_owner: file owner
1086 * @f_wb_err: writeback error
1087 * @f_sb_err: per sb writeback errors
1088 * @f_ep: link of all epoll hooks for this file
1089 * @f_task_work: task work entry point
1090 * @f_llist: work queue entrypoint
1091 * @f_ra: file's readahead state
1092 * @f_freeptr: Pointer used by SLAB_TYPESAFE_BY_RCU file cache (don't touch.)
1093 */
1094 struct file {
1095 file_ref_t f_ref;
1096 spinlock_t f_lock;
1097 fmode_t f_mode;
1098 const struct file_operations *f_op;
1099 struct address_space *f_mapping;
1100 void *private_data;
1101 struct inode *f_inode;
1102 unsigned int f_flags;
1103 unsigned int f_iocb_flags;
1104 const struct cred *f_cred;
1105 /* --- cacheline 1 boundary (64 bytes) --- */
1106 struct path f_path;
1107 union {
1108 /* regular files (with FMODE_ATOMIC_POS) and directories */
1109 struct mutex f_pos_lock;
1110 /* pipes */
1111 u64 f_pipe;
1112 };
1113 loff_t f_pos;
1114 #ifdef CONFIG_SECURITY
1115 void *f_security;
1116 #endif
1117 /* --- cacheline 2 boundary (128 bytes) --- */
1118 struct fown_struct *f_owner;
1119 errseq_t f_wb_err;
1120 errseq_t f_sb_err;
1121 #ifdef CONFIG_EPOLL
1122 struct hlist_head *f_ep;
1123 #endif
1124 union {
1125 struct callback_head f_task_work;
1126 struct llist_node f_llist;
1127 struct file_ra_state f_ra;
1128 freeptr_t f_freeptr;
1129 };
1130 /* --- cacheline 3 boundary (192 bytes) --- */
1131 } __randomize_layout
1132 __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
1133
1134 struct file_handle {
1135 __u32 handle_bytes;
1136 int handle_type;
1137 /* file identifier */
1138 unsigned char f_handle[] __counted_by(handle_bytes);
1139 };
1140
get_file(struct file * f)1141 static inline struct file *get_file(struct file *f)
1142 {
1143 file_ref_inc(&f->f_ref);
1144 return f;
1145 }
1146
1147 struct file *get_file_rcu(struct file __rcu **f);
1148 struct file *get_file_active(struct file **f);
1149
1150 #define file_count(f) file_ref_read(&(f)->f_ref)
1151
1152 #define MAX_NON_LFS ((1UL<<31) - 1)
1153
1154 /* Page cache limit. The filesystems should put that into their s_maxbytes
1155 limits, otherwise bad things can happen in VM. */
1156 #if BITS_PER_LONG==32
1157 #define MAX_LFS_FILESIZE ((loff_t)ULONG_MAX << PAGE_SHIFT)
1158 #elif BITS_PER_LONG==64
1159 #define MAX_LFS_FILESIZE ((loff_t)LLONG_MAX)
1160 #endif
1161
1162 /* legacy typedef, should eventually be removed */
1163 typedef void *fl_owner_t;
1164
1165 struct file_lock;
1166 struct file_lease;
1167
1168 /* The following constant reflects the upper bound of the file/locking space */
1169 #ifndef OFFSET_MAX
1170 #define OFFSET_MAX type_max(loff_t)
1171 #define OFFT_OFFSET_MAX type_max(off_t)
1172 #endif
1173
1174 int file_f_owner_allocate(struct file *file);
file_f_owner(const struct file * file)1175 static inline struct fown_struct *file_f_owner(const struct file *file)
1176 {
1177 return READ_ONCE(file->f_owner);
1178 }
1179
1180 extern void send_sigio(struct fown_struct *fown, int fd, int band);
1181
file_inode(const struct file * f)1182 static inline struct inode *file_inode(const struct file *f)
1183 {
1184 return f->f_inode;
1185 }
1186
1187 /*
1188 * file_dentry() is a relic from the days that overlayfs was using files with a
1189 * "fake" path, meaning, f_path on overlayfs and f_inode on underlying fs.
1190 * In those days, file_dentry() was needed to get the underlying fs dentry that
1191 * matches f_inode.
1192 * Files with "fake" path should not exist nowadays, so use an assertion to make
1193 * sure that file_dentry() was not papering over filesystem bugs.
1194 */
file_dentry(const struct file * file)1195 static inline struct dentry *file_dentry(const struct file *file)
1196 {
1197 struct dentry *dentry = file->f_path.dentry;
1198
1199 WARN_ON_ONCE(d_inode(dentry) != file_inode(file));
1200 return dentry;
1201 }
1202
1203 struct fasync_struct {
1204 rwlock_t fa_lock;
1205 int magic;
1206 int fa_fd;
1207 struct fasync_struct *fa_next; /* singly linked list */
1208 struct file *fa_file;
1209 struct rcu_head fa_rcu;
1210 };
1211
1212 #define FASYNC_MAGIC 0x4601
1213
1214 /* SMP safe fasync helpers: */
1215 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1216 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1217 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1218 extern struct fasync_struct *fasync_alloc(void);
1219 extern void fasync_free(struct fasync_struct *);
1220
1221 /* can be called from interrupts */
1222 extern void kill_fasync(struct fasync_struct **, int, int);
1223
1224 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1225 extern int f_setown(struct file *filp, int who, int force);
1226 extern void f_delown(struct file *filp);
1227 extern pid_t f_getown(struct file *filp);
1228 extern int send_sigurg(struct file *file);
1229
1230 /*
1231 * sb->s_flags. Note that these mirror the equivalent MS_* flags where
1232 * represented in both.
1233 */
1234 #define SB_RDONLY BIT(0) /* Mount read-only */
1235 #define SB_NOSUID BIT(1) /* Ignore suid and sgid bits */
1236 #define SB_NODEV BIT(2) /* Disallow access to device special files */
1237 #define SB_NOEXEC BIT(3) /* Disallow program execution */
1238 #define SB_SYNCHRONOUS BIT(4) /* Writes are synced at once */
1239 #define SB_MANDLOCK BIT(6) /* Allow mandatory locks on an FS */
1240 #define SB_DIRSYNC BIT(7) /* Directory modifications are synchronous */
1241 #define SB_NOATIME BIT(10) /* Do not update access times. */
1242 #define SB_NODIRATIME BIT(11) /* Do not update directory access times */
1243 #define SB_SILENT BIT(15)
1244 #define SB_POSIXACL BIT(16) /* Supports POSIX ACLs */
1245 #define SB_INLINECRYPT BIT(17) /* Use blk-crypto for encrypted files */
1246 #define SB_KERNMOUNT BIT(22) /* this is a kern_mount call */
1247 #define SB_I_VERSION BIT(23) /* Update inode I_version field */
1248 #define SB_LAZYTIME BIT(25) /* Update the on-disk [acm]times lazily */
1249
1250 /* These sb flags are internal to the kernel */
1251 #define SB_DEAD BIT(21)
1252 #define SB_DYING BIT(24)
1253 #define SB_SUBMOUNT BIT(26)
1254 #define SB_FORCE BIT(27)
1255 #define SB_NOSEC BIT(28)
1256 #define SB_BORN BIT(29)
1257 #define SB_ACTIVE BIT(30)
1258 #define SB_NOUSER BIT(31)
1259
1260 /* These flags relate to encoding and casefolding */
1261 #define SB_ENC_STRICT_MODE_FL (1 << 0)
1262
1263 #define sb_has_strict_encoding(sb) \
1264 (sb->s_encoding_flags & SB_ENC_STRICT_MODE_FL)
1265
1266 /*
1267 * Umount options
1268 */
1269
1270 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1271 #define MNT_DETACH 0x00000002 /* Just detach from the tree */
1272 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */
1273 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1274 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1275
1276 /* sb->s_iflags */
1277 #define SB_I_CGROUPWB 0x00000001 /* cgroup-aware writeback enabled */
1278 #define SB_I_NOEXEC 0x00000002 /* Ignore executables on this fs */
1279 #define SB_I_NODEV 0x00000004 /* Ignore devices on this fs */
1280 #define SB_I_STABLE_WRITES 0x00000008 /* don't modify blks until WB is done */
1281
1282 /* sb->s_iflags to limit user namespace mounts */
1283 #define SB_I_USERNS_VISIBLE 0x00000010 /* fstype already mounted */
1284 #define SB_I_IMA_UNVERIFIABLE_SIGNATURE 0x00000020
1285 #define SB_I_UNTRUSTED_MOUNTER 0x00000040
1286 #define SB_I_EVM_HMAC_UNSUPPORTED 0x00000080
1287
1288 #define SB_I_SKIP_SYNC 0x00000100 /* Skip superblock at global sync */
1289 #define SB_I_PERSB_BDI 0x00000200 /* has a per-sb bdi */
1290 #define SB_I_TS_EXPIRY_WARNED 0x00000400 /* warned about timestamp range expiry */
1291 #define SB_I_RETIRED 0x00000800 /* superblock shouldn't be reused */
1292 #define SB_I_NOUMASK 0x00001000 /* VFS does not apply umask */
1293 #define SB_I_NOIDMAP 0x00002000 /* No idmapped mounts on this superblock */
1294 #define SB_I_ALLOW_HSM 0x00004000 /* Allow HSM events on this superblock */
1295
1296 /* Possible states of 'frozen' field */
1297 enum {
1298 SB_UNFROZEN = 0, /* FS is unfrozen */
1299 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
1300 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1301 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1302 * internal threads if needed) */
1303 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1304 };
1305
1306 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1307
1308 struct sb_writers {
1309 unsigned short frozen; /* Is sb frozen? */
1310 int freeze_kcount; /* How many kernel freeze requests? */
1311 int freeze_ucount; /* How many userspace freeze requests? */
1312 struct percpu_rw_semaphore rw_sem[SB_FREEZE_LEVELS];
1313 };
1314
1315 struct super_block {
1316 struct list_head s_list; /* Keep this first */
1317 dev_t s_dev; /* search index; _not_ kdev_t */
1318 unsigned char s_blocksize_bits;
1319 unsigned long s_blocksize;
1320 loff_t s_maxbytes; /* Max file size */
1321 struct file_system_type *s_type;
1322 const struct super_operations *s_op;
1323 const struct dquot_operations *dq_op;
1324 const struct quotactl_ops *s_qcop;
1325 const struct export_operations *s_export_op;
1326 unsigned long s_flags;
1327 unsigned long s_iflags; /* internal SB_I_* flags */
1328 unsigned long s_magic;
1329 struct dentry *s_root;
1330 struct rw_semaphore s_umount;
1331 int s_count;
1332 atomic_t s_active;
1333 #ifdef CONFIG_SECURITY
1334 void *s_security;
1335 #endif
1336 const struct xattr_handler * const *s_xattr;
1337 #ifdef CONFIG_FS_ENCRYPTION
1338 const struct fscrypt_operations *s_cop;
1339 struct fscrypt_keyring *s_master_keys; /* master crypto keys in use */
1340 #endif
1341 #ifdef CONFIG_FS_VERITY
1342 const struct fsverity_operations *s_vop;
1343 #endif
1344 #if IS_ENABLED(CONFIG_UNICODE)
1345 struct unicode_map *s_encoding;
1346 __u16 s_encoding_flags;
1347 #endif
1348 struct hlist_bl_head s_roots; /* alternate root dentries for NFS */
1349 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1350 struct block_device *s_bdev; /* can go away once we use an accessor for @s_bdev_file */
1351 struct file *s_bdev_file;
1352 struct backing_dev_info *s_bdi;
1353 struct mtd_info *s_mtd;
1354 struct hlist_node s_instances;
1355 unsigned int s_quota_types; /* Bitmask of supported quota types */
1356 struct quota_info s_dquot; /* Diskquota specific options */
1357
1358 struct sb_writers s_writers;
1359
1360 /*
1361 * Keep s_fs_info, s_time_gran, s_fsnotify_mask, and
1362 * s_fsnotify_info together for cache efficiency. They are frequently
1363 * accessed and rarely modified.
1364 */
1365 void *s_fs_info; /* Filesystem private info */
1366
1367 /* Granularity of c/m/atime in ns (cannot be worse than a second) */
1368 u32 s_time_gran;
1369 /* Time limits for c/m/atime in seconds */
1370 time64_t s_time_min;
1371 time64_t s_time_max;
1372 #ifdef CONFIG_FSNOTIFY
1373 u32 s_fsnotify_mask;
1374 struct fsnotify_sb_info *s_fsnotify_info;
1375 #endif
1376
1377 /*
1378 * q: why are s_id and s_sysfs_name not the same? both are human
1379 * readable strings that identify the filesystem
1380 * a: s_id is allowed to change at runtime; it's used in log messages,
1381 * and we want to when a device starts out as single device (s_id is dev
1382 * name) but then a device is hot added and we have to switch to
1383 * identifying it by UUID
1384 * but s_sysfs_name is a handle for programmatic access, and can't
1385 * change at runtime
1386 */
1387 char s_id[32]; /* Informational name */
1388 uuid_t s_uuid; /* UUID */
1389 u8 s_uuid_len; /* Default 16, possibly smaller for weird filesystems */
1390
1391 /* if set, fs shows up under sysfs at /sys/fs/$FSTYP/s_sysfs_name */
1392 char s_sysfs_name[UUID_STRING_LEN + 1];
1393
1394 unsigned int s_max_links;
1395
1396 /*
1397 * The next field is for VFS *only*. No filesystems have any business
1398 * even looking at it. You had been warned.
1399 */
1400 struct mutex s_vfs_rename_mutex; /* Kludge */
1401
1402 /*
1403 * Filesystem subtype. If non-empty the filesystem type field
1404 * in /proc/mounts will be "type.subtype"
1405 */
1406 const char *s_subtype;
1407
1408 const struct dentry_operations *s_d_op; /* default d_op for dentries */
1409
1410 struct shrinker *s_shrink; /* per-sb shrinker handle */
1411
1412 /* Number of inodes with nlink == 0 but still referenced */
1413 atomic_long_t s_remove_count;
1414
1415 /* Read-only state of the superblock is being changed */
1416 int s_readonly_remount;
1417
1418 /* per-sb errseq_t for reporting writeback errors via syncfs */
1419 errseq_t s_wb_err;
1420
1421 /* AIO completions deferred from interrupt context */
1422 struct workqueue_struct *s_dio_done_wq;
1423 struct hlist_head s_pins;
1424
1425 /*
1426 * Owning user namespace and default context in which to
1427 * interpret filesystem uids, gids, quotas, device nodes,
1428 * xattrs and security labels.
1429 */
1430 struct user_namespace *s_user_ns;
1431
1432 /*
1433 * The list_lru structure is essentially just a pointer to a table
1434 * of per-node lru lists, each of which has its own spinlock.
1435 * There is no need to put them into separate cachelines.
1436 */
1437 struct list_lru s_dentry_lru;
1438 struct list_lru s_inode_lru;
1439 struct rcu_head rcu;
1440 struct work_struct destroy_work;
1441
1442 struct mutex s_sync_lock; /* sync serialisation lock */
1443
1444 /*
1445 * Indicates how deep in a filesystem stack this SB is
1446 */
1447 int s_stack_depth;
1448
1449 /* s_inode_list_lock protects s_inodes */
1450 spinlock_t s_inode_list_lock ____cacheline_aligned_in_smp;
1451 struct list_head s_inodes; /* all inodes */
1452
1453 spinlock_t s_inode_wblist_lock;
1454 struct list_head s_inodes_wb; /* writeback inodes */
1455 } __randomize_layout;
1456
i_user_ns(const struct inode * inode)1457 static inline struct user_namespace *i_user_ns(const struct inode *inode)
1458 {
1459 return inode->i_sb->s_user_ns;
1460 }
1461
1462 /* Helper functions so that in most cases filesystems will
1463 * not need to deal directly with kuid_t and kgid_t and can
1464 * instead deal with the raw numeric values that are stored
1465 * in the filesystem.
1466 */
i_uid_read(const struct inode * inode)1467 static inline uid_t i_uid_read(const struct inode *inode)
1468 {
1469 return from_kuid(i_user_ns(inode), inode->i_uid);
1470 }
1471
i_gid_read(const struct inode * inode)1472 static inline gid_t i_gid_read(const struct inode *inode)
1473 {
1474 return from_kgid(i_user_ns(inode), inode->i_gid);
1475 }
1476
i_uid_write(struct inode * inode,uid_t uid)1477 static inline void i_uid_write(struct inode *inode, uid_t uid)
1478 {
1479 inode->i_uid = make_kuid(i_user_ns(inode), uid);
1480 }
1481
i_gid_write(struct inode * inode,gid_t gid)1482 static inline void i_gid_write(struct inode *inode, gid_t gid)
1483 {
1484 inode->i_gid = make_kgid(i_user_ns(inode), gid);
1485 }
1486
1487 /**
1488 * i_uid_into_vfsuid - map an inode's i_uid down according to an idmapping
1489 * @idmap: idmap of the mount the inode was found from
1490 * @inode: inode to map
1491 *
1492 * Return: whe inode's i_uid mapped down according to @idmap.
1493 * If the inode's i_uid has no mapping INVALID_VFSUID is returned.
1494 */
i_uid_into_vfsuid(struct mnt_idmap * idmap,const struct inode * inode)1495 static inline vfsuid_t i_uid_into_vfsuid(struct mnt_idmap *idmap,
1496 const struct inode *inode)
1497 {
1498 return make_vfsuid(idmap, i_user_ns(inode), inode->i_uid);
1499 }
1500
1501 /**
1502 * i_uid_needs_update - check whether inode's i_uid needs to be updated
1503 * @idmap: idmap of the mount the inode was found from
1504 * @attr: the new attributes of @inode
1505 * @inode: the inode to update
1506 *
1507 * Check whether the $inode's i_uid field needs to be updated taking idmapped
1508 * mounts into account if the filesystem supports it.
1509 *
1510 * Return: true if @inode's i_uid field needs to be updated, false if not.
1511 */
i_uid_needs_update(struct mnt_idmap * idmap,const struct iattr * attr,const struct inode * inode)1512 static inline bool i_uid_needs_update(struct mnt_idmap *idmap,
1513 const struct iattr *attr,
1514 const struct inode *inode)
1515 {
1516 return ((attr->ia_valid & ATTR_UID) &&
1517 !vfsuid_eq(attr->ia_vfsuid,
1518 i_uid_into_vfsuid(idmap, inode)));
1519 }
1520
1521 /**
1522 * i_uid_update - update @inode's i_uid field
1523 * @idmap: idmap of the mount the inode was found from
1524 * @attr: the new attributes of @inode
1525 * @inode: the inode to update
1526 *
1527 * Safely update @inode's i_uid field translating the vfsuid of any idmapped
1528 * mount into the filesystem kuid.
1529 */
i_uid_update(struct mnt_idmap * idmap,const struct iattr * attr,struct inode * inode)1530 static inline void i_uid_update(struct mnt_idmap *idmap,
1531 const struct iattr *attr,
1532 struct inode *inode)
1533 {
1534 if (attr->ia_valid & ATTR_UID)
1535 inode->i_uid = from_vfsuid(idmap, i_user_ns(inode),
1536 attr->ia_vfsuid);
1537 }
1538
1539 /**
1540 * i_gid_into_vfsgid - map an inode's i_gid down according to an idmapping
1541 * @idmap: idmap of the mount the inode was found from
1542 * @inode: inode to map
1543 *
1544 * Return: the inode's i_gid mapped down according to @idmap.
1545 * If the inode's i_gid has no mapping INVALID_VFSGID is returned.
1546 */
i_gid_into_vfsgid(struct mnt_idmap * idmap,const struct inode * inode)1547 static inline vfsgid_t i_gid_into_vfsgid(struct mnt_idmap *idmap,
1548 const struct inode *inode)
1549 {
1550 return make_vfsgid(idmap, i_user_ns(inode), inode->i_gid);
1551 }
1552
1553 /**
1554 * i_gid_needs_update - check whether inode's i_gid needs to be updated
1555 * @idmap: idmap of the mount the inode was found from
1556 * @attr: the new attributes of @inode
1557 * @inode: the inode to update
1558 *
1559 * Check whether the $inode's i_gid field needs to be updated taking idmapped
1560 * mounts into account if the filesystem supports it.
1561 *
1562 * Return: true if @inode's i_gid field needs to be updated, false if not.
1563 */
i_gid_needs_update(struct mnt_idmap * idmap,const struct iattr * attr,const struct inode * inode)1564 static inline bool i_gid_needs_update(struct mnt_idmap *idmap,
1565 const struct iattr *attr,
1566 const struct inode *inode)
1567 {
1568 return ((attr->ia_valid & ATTR_GID) &&
1569 !vfsgid_eq(attr->ia_vfsgid,
1570 i_gid_into_vfsgid(idmap, inode)));
1571 }
1572
1573 /**
1574 * i_gid_update - update @inode's i_gid field
1575 * @idmap: idmap of the mount the inode was found from
1576 * @attr: the new attributes of @inode
1577 * @inode: the inode to update
1578 *
1579 * Safely update @inode's i_gid field translating the vfsgid of any idmapped
1580 * mount into the filesystem kgid.
1581 */
i_gid_update(struct mnt_idmap * idmap,const struct iattr * attr,struct inode * inode)1582 static inline void i_gid_update(struct mnt_idmap *idmap,
1583 const struct iattr *attr,
1584 struct inode *inode)
1585 {
1586 if (attr->ia_valid & ATTR_GID)
1587 inode->i_gid = from_vfsgid(idmap, i_user_ns(inode),
1588 attr->ia_vfsgid);
1589 }
1590
1591 /**
1592 * inode_fsuid_set - initialize inode's i_uid field with callers fsuid
1593 * @inode: inode to initialize
1594 * @idmap: idmap of the mount the inode was found from
1595 *
1596 * Initialize the i_uid field of @inode. If the inode was found/created via
1597 * an idmapped mount map the caller's fsuid according to @idmap.
1598 */
inode_fsuid_set(struct inode * inode,struct mnt_idmap * idmap)1599 static inline void inode_fsuid_set(struct inode *inode,
1600 struct mnt_idmap *idmap)
1601 {
1602 inode->i_uid = mapped_fsuid(idmap, i_user_ns(inode));
1603 }
1604
1605 /**
1606 * inode_fsgid_set - initialize inode's i_gid field with callers fsgid
1607 * @inode: inode to initialize
1608 * @idmap: idmap of the mount the inode was found from
1609 *
1610 * Initialize the i_gid field of @inode. If the inode was found/created via
1611 * an idmapped mount map the caller's fsgid according to @idmap.
1612 */
inode_fsgid_set(struct inode * inode,struct mnt_idmap * idmap)1613 static inline void inode_fsgid_set(struct inode *inode,
1614 struct mnt_idmap *idmap)
1615 {
1616 inode->i_gid = mapped_fsgid(idmap, i_user_ns(inode));
1617 }
1618
1619 /**
1620 * fsuidgid_has_mapping() - check whether caller's fsuid/fsgid is mapped
1621 * @sb: the superblock we want a mapping in
1622 * @idmap: idmap of the relevant mount
1623 *
1624 * Check whether the caller's fsuid and fsgid have a valid mapping in the
1625 * s_user_ns of the superblock @sb. If the caller is on an idmapped mount map
1626 * the caller's fsuid and fsgid according to the @idmap first.
1627 *
1628 * Return: true if fsuid and fsgid is mapped, false if not.
1629 */
fsuidgid_has_mapping(struct super_block * sb,struct mnt_idmap * idmap)1630 static inline bool fsuidgid_has_mapping(struct super_block *sb,
1631 struct mnt_idmap *idmap)
1632 {
1633 struct user_namespace *fs_userns = sb->s_user_ns;
1634 kuid_t kuid;
1635 kgid_t kgid;
1636
1637 kuid = mapped_fsuid(idmap, fs_userns);
1638 if (!uid_valid(kuid))
1639 return false;
1640 kgid = mapped_fsgid(idmap, fs_userns);
1641 if (!gid_valid(kgid))
1642 return false;
1643 return kuid_has_mapping(fs_userns, kuid) &&
1644 kgid_has_mapping(fs_userns, kgid);
1645 }
1646
1647 struct timespec64 current_time(struct inode *inode);
1648 struct timespec64 inode_set_ctime_current(struct inode *inode);
1649 struct timespec64 inode_set_ctime_deleg(struct inode *inode,
1650 struct timespec64 update);
1651
inode_get_atime_sec(const struct inode * inode)1652 static inline time64_t inode_get_atime_sec(const struct inode *inode)
1653 {
1654 return inode->i_atime_sec;
1655 }
1656
inode_get_atime_nsec(const struct inode * inode)1657 static inline long inode_get_atime_nsec(const struct inode *inode)
1658 {
1659 return inode->i_atime_nsec;
1660 }
1661
inode_get_atime(const struct inode * inode)1662 static inline struct timespec64 inode_get_atime(const struct inode *inode)
1663 {
1664 struct timespec64 ts = { .tv_sec = inode_get_atime_sec(inode),
1665 .tv_nsec = inode_get_atime_nsec(inode) };
1666
1667 return ts;
1668 }
1669
inode_set_atime_to_ts(struct inode * inode,struct timespec64 ts)1670 static inline struct timespec64 inode_set_atime_to_ts(struct inode *inode,
1671 struct timespec64 ts)
1672 {
1673 inode->i_atime_sec = ts.tv_sec;
1674 inode->i_atime_nsec = ts.tv_nsec;
1675 return ts;
1676 }
1677
inode_set_atime(struct inode * inode,time64_t sec,long nsec)1678 static inline struct timespec64 inode_set_atime(struct inode *inode,
1679 time64_t sec, long nsec)
1680 {
1681 struct timespec64 ts = { .tv_sec = sec,
1682 .tv_nsec = nsec };
1683
1684 return inode_set_atime_to_ts(inode, ts);
1685 }
1686
inode_get_mtime_sec(const struct inode * inode)1687 static inline time64_t inode_get_mtime_sec(const struct inode *inode)
1688 {
1689 return inode->i_mtime_sec;
1690 }
1691
inode_get_mtime_nsec(const struct inode * inode)1692 static inline long inode_get_mtime_nsec(const struct inode *inode)
1693 {
1694 return inode->i_mtime_nsec;
1695 }
1696
inode_get_mtime(const struct inode * inode)1697 static inline struct timespec64 inode_get_mtime(const struct inode *inode)
1698 {
1699 struct timespec64 ts = { .tv_sec = inode_get_mtime_sec(inode),
1700 .tv_nsec = inode_get_mtime_nsec(inode) };
1701 return ts;
1702 }
1703
inode_set_mtime_to_ts(struct inode * inode,struct timespec64 ts)1704 static inline struct timespec64 inode_set_mtime_to_ts(struct inode *inode,
1705 struct timespec64 ts)
1706 {
1707 inode->i_mtime_sec = ts.tv_sec;
1708 inode->i_mtime_nsec = ts.tv_nsec;
1709 return ts;
1710 }
1711
inode_set_mtime(struct inode * inode,time64_t sec,long nsec)1712 static inline struct timespec64 inode_set_mtime(struct inode *inode,
1713 time64_t sec, long nsec)
1714 {
1715 struct timespec64 ts = { .tv_sec = sec,
1716 .tv_nsec = nsec };
1717 return inode_set_mtime_to_ts(inode, ts);
1718 }
1719
1720 /*
1721 * Multigrain timestamps
1722 *
1723 * Conditionally use fine-grained ctime and mtime timestamps when there
1724 * are users actively observing them via getattr. The primary use-case
1725 * for this is NFS clients that use the ctime to distinguish between
1726 * different states of the file, and that are often fooled by multiple
1727 * operations that occur in the same coarse-grained timer tick.
1728 */
1729 #define I_CTIME_QUERIED ((u32)BIT(31))
1730
inode_get_ctime_sec(const struct inode * inode)1731 static inline time64_t inode_get_ctime_sec(const struct inode *inode)
1732 {
1733 return inode->i_ctime_sec;
1734 }
1735
inode_get_ctime_nsec(const struct inode * inode)1736 static inline long inode_get_ctime_nsec(const struct inode *inode)
1737 {
1738 return inode->i_ctime_nsec & ~I_CTIME_QUERIED;
1739 }
1740
inode_get_ctime(const struct inode * inode)1741 static inline struct timespec64 inode_get_ctime(const struct inode *inode)
1742 {
1743 struct timespec64 ts = { .tv_sec = inode_get_ctime_sec(inode),
1744 .tv_nsec = inode_get_ctime_nsec(inode) };
1745
1746 return ts;
1747 }
1748
1749 struct timespec64 inode_set_ctime_to_ts(struct inode *inode, struct timespec64 ts);
1750
1751 /**
1752 * inode_set_ctime - set the ctime in the inode
1753 * @inode: inode in which to set the ctime
1754 * @sec: tv_sec value to set
1755 * @nsec: tv_nsec value to set
1756 *
1757 * Set the ctime in @inode to { @sec, @nsec }
1758 */
inode_set_ctime(struct inode * inode,time64_t sec,long nsec)1759 static inline struct timespec64 inode_set_ctime(struct inode *inode,
1760 time64_t sec, long nsec)
1761 {
1762 struct timespec64 ts = { .tv_sec = sec,
1763 .tv_nsec = nsec };
1764
1765 return inode_set_ctime_to_ts(inode, ts);
1766 }
1767
1768 struct timespec64 simple_inode_init_ts(struct inode *inode);
1769
1770 /*
1771 * Snapshotting support.
1772 */
1773
1774 /*
1775 * These are internal functions, please use sb_start_{write,pagefault,intwrite}
1776 * instead.
1777 */
__sb_end_write(struct super_block * sb,int level)1778 static inline void __sb_end_write(struct super_block *sb, int level)
1779 {
1780 percpu_up_read(sb->s_writers.rw_sem + level-1);
1781 }
1782
__sb_start_write(struct super_block * sb,int level)1783 static inline void __sb_start_write(struct super_block *sb, int level)
1784 {
1785 percpu_down_read(sb->s_writers.rw_sem + level - 1);
1786 }
1787
__sb_start_write_trylock(struct super_block * sb,int level)1788 static inline bool __sb_start_write_trylock(struct super_block *sb, int level)
1789 {
1790 return percpu_down_read_trylock(sb->s_writers.rw_sem + level - 1);
1791 }
1792
1793 #define __sb_writers_acquired(sb, lev) \
1794 percpu_rwsem_acquire(&(sb)->s_writers.rw_sem[(lev)-1], 1, _THIS_IP_)
1795 #define __sb_writers_release(sb, lev) \
1796 percpu_rwsem_release(&(sb)->s_writers.rw_sem[(lev)-1], _THIS_IP_)
1797
1798 /**
1799 * __sb_write_started - check if sb freeze level is held
1800 * @sb: the super we write to
1801 * @level: the freeze level
1802 *
1803 * * > 0 - sb freeze level is held
1804 * * 0 - sb freeze level is not held
1805 * * < 0 - !CONFIG_LOCKDEP/LOCK_STATE_UNKNOWN
1806 */
__sb_write_started(const struct super_block * sb,int level)1807 static inline int __sb_write_started(const struct super_block *sb, int level)
1808 {
1809 return lockdep_is_held_type(sb->s_writers.rw_sem + level - 1, 1);
1810 }
1811
1812 /**
1813 * sb_write_started - check if SB_FREEZE_WRITE is held
1814 * @sb: the super we write to
1815 *
1816 * May be false positive with !CONFIG_LOCKDEP/LOCK_STATE_UNKNOWN.
1817 */
sb_write_started(const struct super_block * sb)1818 static inline bool sb_write_started(const struct super_block *sb)
1819 {
1820 return __sb_write_started(sb, SB_FREEZE_WRITE);
1821 }
1822
1823 /**
1824 * sb_write_not_started - check if SB_FREEZE_WRITE is not held
1825 * @sb: the super we write to
1826 *
1827 * May be false positive with !CONFIG_LOCKDEP/LOCK_STATE_UNKNOWN.
1828 */
sb_write_not_started(const struct super_block * sb)1829 static inline bool sb_write_not_started(const struct super_block *sb)
1830 {
1831 return __sb_write_started(sb, SB_FREEZE_WRITE) <= 0;
1832 }
1833
1834 /**
1835 * file_write_started - check if SB_FREEZE_WRITE is held
1836 * @file: the file we write to
1837 *
1838 * May be false positive with !CONFIG_LOCKDEP/LOCK_STATE_UNKNOWN.
1839 * May be false positive with !S_ISREG, because file_start_write() has
1840 * no effect on !S_ISREG.
1841 */
file_write_started(const struct file * file)1842 static inline bool file_write_started(const struct file *file)
1843 {
1844 if (!S_ISREG(file_inode(file)->i_mode))
1845 return true;
1846 return sb_write_started(file_inode(file)->i_sb);
1847 }
1848
1849 /**
1850 * file_write_not_started - check if SB_FREEZE_WRITE is not held
1851 * @file: the file we write to
1852 *
1853 * May be false positive with !CONFIG_LOCKDEP/LOCK_STATE_UNKNOWN.
1854 * May be false positive with !S_ISREG, because file_start_write() has
1855 * no effect on !S_ISREG.
1856 */
file_write_not_started(const struct file * file)1857 static inline bool file_write_not_started(const struct file *file)
1858 {
1859 if (!S_ISREG(file_inode(file)->i_mode))
1860 return true;
1861 return sb_write_not_started(file_inode(file)->i_sb);
1862 }
1863
1864 /**
1865 * sb_end_write - drop write access to a superblock
1866 * @sb: the super we wrote to
1867 *
1868 * Decrement number of writers to the filesystem. Wake up possible waiters
1869 * wanting to freeze the filesystem.
1870 */
sb_end_write(struct super_block * sb)1871 static inline void sb_end_write(struct super_block *sb)
1872 {
1873 __sb_end_write(sb, SB_FREEZE_WRITE);
1874 }
1875
1876 /**
1877 * sb_end_pagefault - drop write access to a superblock from a page fault
1878 * @sb: the super we wrote to
1879 *
1880 * Decrement number of processes handling write page fault to the filesystem.
1881 * Wake up possible waiters wanting to freeze the filesystem.
1882 */
sb_end_pagefault(struct super_block * sb)1883 static inline void sb_end_pagefault(struct super_block *sb)
1884 {
1885 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1886 }
1887
1888 /**
1889 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1890 * @sb: the super we wrote to
1891 *
1892 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1893 * waiters wanting to freeze the filesystem.
1894 */
sb_end_intwrite(struct super_block * sb)1895 static inline void sb_end_intwrite(struct super_block *sb)
1896 {
1897 __sb_end_write(sb, SB_FREEZE_FS);
1898 }
1899
1900 /**
1901 * sb_start_write - get write access to a superblock
1902 * @sb: the super we write to
1903 *
1904 * When a process wants to write data or metadata to a file system (i.e. dirty
1905 * a page or an inode), it should embed the operation in a sb_start_write() -
1906 * sb_end_write() pair to get exclusion against file system freezing. This
1907 * function increments number of writers preventing freezing. If the file
1908 * system is already frozen, the function waits until the file system is
1909 * thawed.
1910 *
1911 * Since freeze protection behaves as a lock, users have to preserve
1912 * ordering of freeze protection and other filesystem locks. Generally,
1913 * freeze protection should be the outermost lock. In particular, we have:
1914 *
1915 * sb_start_write
1916 * -> i_mutex (write path, truncate, directory ops, ...)
1917 * -> s_umount (freeze_super, thaw_super)
1918 */
sb_start_write(struct super_block * sb)1919 static inline void sb_start_write(struct super_block *sb)
1920 {
1921 __sb_start_write(sb, SB_FREEZE_WRITE);
1922 }
1923
sb_start_write_trylock(struct super_block * sb)1924 static inline bool sb_start_write_trylock(struct super_block *sb)
1925 {
1926 return __sb_start_write_trylock(sb, SB_FREEZE_WRITE);
1927 }
1928
1929 /**
1930 * sb_start_pagefault - get write access to a superblock from a page fault
1931 * @sb: the super we write to
1932 *
1933 * When a process starts handling write page fault, it should embed the
1934 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1935 * exclusion against file system freezing. This is needed since the page fault
1936 * is going to dirty a page. This function increments number of running page
1937 * faults preventing freezing. If the file system is already frozen, the
1938 * function waits until the file system is thawed.
1939 *
1940 * Since page fault freeze protection behaves as a lock, users have to preserve
1941 * ordering of freeze protection and other filesystem locks. It is advised to
1942 * put sb_start_pagefault() close to mmap_lock in lock ordering. Page fault
1943 * handling code implies lock dependency:
1944 *
1945 * mmap_lock
1946 * -> sb_start_pagefault
1947 */
sb_start_pagefault(struct super_block * sb)1948 static inline void sb_start_pagefault(struct super_block *sb)
1949 {
1950 __sb_start_write(sb, SB_FREEZE_PAGEFAULT);
1951 }
1952
1953 /**
1954 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1955 * @sb: the super we write to
1956 *
1957 * This is the third level of protection against filesystem freezing. It is
1958 * free for use by a filesystem. The only requirement is that it must rank
1959 * below sb_start_pagefault.
1960 *
1961 * For example filesystem can call sb_start_intwrite() when starting a
1962 * transaction which somewhat eases handling of freezing for internal sources
1963 * of filesystem changes (internal fs threads, discarding preallocation on file
1964 * close, etc.).
1965 */
sb_start_intwrite(struct super_block * sb)1966 static inline void sb_start_intwrite(struct super_block *sb)
1967 {
1968 __sb_start_write(sb, SB_FREEZE_FS);
1969 }
1970
sb_start_intwrite_trylock(struct super_block * sb)1971 static inline bool sb_start_intwrite_trylock(struct super_block *sb)
1972 {
1973 return __sb_start_write_trylock(sb, SB_FREEZE_FS);
1974 }
1975
1976 bool inode_owner_or_capable(struct mnt_idmap *idmap,
1977 const struct inode *inode);
1978
1979 /*
1980 * VFS helper functions..
1981 */
1982 int vfs_create(struct mnt_idmap *, struct inode *,
1983 struct dentry *, umode_t, bool);
1984 int vfs_mkdir(struct mnt_idmap *, struct inode *,
1985 struct dentry *, umode_t);
1986 int vfs_mknod(struct mnt_idmap *, struct inode *, struct dentry *,
1987 umode_t, dev_t);
1988 int vfs_symlink(struct mnt_idmap *, struct inode *,
1989 struct dentry *, const char *);
1990 int vfs_link(struct dentry *, struct mnt_idmap *, struct inode *,
1991 struct dentry *, struct inode **);
1992 int vfs_rmdir(struct mnt_idmap *, struct inode *, struct dentry *);
1993 int vfs_unlink(struct mnt_idmap *, struct inode *, struct dentry *,
1994 struct inode **);
1995
1996 /**
1997 * struct renamedata - contains all information required for renaming
1998 * @old_mnt_idmap: idmap of the old mount the inode was found from
1999 * @old_dir: parent of source
2000 * @old_dentry: source
2001 * @new_mnt_idmap: idmap of the new mount the inode was found from
2002 * @new_dir: parent of destination
2003 * @new_dentry: destination
2004 * @delegated_inode: returns an inode needing a delegation break
2005 * @flags: rename flags
2006 */
2007 struct renamedata {
2008 struct mnt_idmap *old_mnt_idmap;
2009 struct inode *old_dir;
2010 struct dentry *old_dentry;
2011 struct mnt_idmap *new_mnt_idmap;
2012 struct inode *new_dir;
2013 struct dentry *new_dentry;
2014 struct inode **delegated_inode;
2015 unsigned int flags;
2016 } __randomize_layout;
2017
2018 int vfs_rename(struct renamedata *);
2019
vfs_whiteout(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry)2020 static inline int vfs_whiteout(struct mnt_idmap *idmap,
2021 struct inode *dir, struct dentry *dentry)
2022 {
2023 return vfs_mknod(idmap, dir, dentry, S_IFCHR | WHITEOUT_MODE,
2024 WHITEOUT_DEV);
2025 }
2026
2027 struct file *kernel_tmpfile_open(struct mnt_idmap *idmap,
2028 const struct path *parentpath,
2029 umode_t mode, int open_flag,
2030 const struct cred *cred);
2031 struct file *kernel_file_open(const struct path *path, int flags,
2032 const struct cred *cred);
2033
2034 int vfs_mkobj(struct dentry *, umode_t,
2035 int (*f)(struct dentry *, umode_t, void *),
2036 void *);
2037
2038 int vfs_fchown(struct file *file, uid_t user, gid_t group);
2039 int vfs_fchmod(struct file *file, umode_t mode);
2040 int vfs_utimes(const struct path *path, struct timespec64 *times);
2041
2042 extern long vfs_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
2043
2044 #ifdef CONFIG_COMPAT
2045 extern long compat_ptr_ioctl(struct file *file, unsigned int cmd,
2046 unsigned long arg);
2047 #else
2048 #define compat_ptr_ioctl NULL
2049 #endif
2050
2051 /*
2052 * VFS file helper functions.
2053 */
2054 void inode_init_owner(struct mnt_idmap *idmap, struct inode *inode,
2055 const struct inode *dir, umode_t mode);
2056 extern bool may_open_dev(const struct path *path);
2057 umode_t mode_strip_sgid(struct mnt_idmap *idmap,
2058 const struct inode *dir, umode_t mode);
2059 bool in_group_or_capable(struct mnt_idmap *idmap,
2060 const struct inode *inode, vfsgid_t vfsgid);
2061
2062 /*
2063 * This is the "filldir" function type, used by readdir() to let
2064 * the kernel specify what kind of dirent layout it wants to have.
2065 * This allows the kernel to read directories into kernel space or
2066 * to have different dirent layouts depending on the binary type.
2067 * Return 'true' to keep going and 'false' if there are no more entries.
2068 */
2069 struct dir_context;
2070 typedef bool (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
2071 unsigned);
2072
2073 struct dir_context {
2074 filldir_t actor;
2075 loff_t pos;
2076 };
2077
2078 /*
2079 * These flags let !MMU mmap() govern direct device mapping vs immediate
2080 * copying more easily for MAP_PRIVATE, especially for ROM filesystems.
2081 *
2082 * NOMMU_MAP_COPY: Copy can be mapped (MAP_PRIVATE)
2083 * NOMMU_MAP_DIRECT: Can be mapped directly (MAP_SHARED)
2084 * NOMMU_MAP_READ: Can be mapped for reading
2085 * NOMMU_MAP_WRITE: Can be mapped for writing
2086 * NOMMU_MAP_EXEC: Can be mapped for execution
2087 */
2088 #define NOMMU_MAP_COPY 0x00000001
2089 #define NOMMU_MAP_DIRECT 0x00000008
2090 #define NOMMU_MAP_READ VM_MAYREAD
2091 #define NOMMU_MAP_WRITE VM_MAYWRITE
2092 #define NOMMU_MAP_EXEC VM_MAYEXEC
2093
2094 #define NOMMU_VMFLAGS \
2095 (NOMMU_MAP_READ | NOMMU_MAP_WRITE | NOMMU_MAP_EXEC)
2096
2097 /*
2098 * These flags control the behavior of the remap_file_range function pointer.
2099 * If it is called with len == 0 that means "remap to end of source file".
2100 * See Documentation/filesystems/vfs.rst for more details about this call.
2101 *
2102 * REMAP_FILE_DEDUP: only remap if contents identical (i.e. deduplicate)
2103 * REMAP_FILE_CAN_SHORTEN: caller can handle a shortened request
2104 */
2105 #define REMAP_FILE_DEDUP (1 << 0)
2106 #define REMAP_FILE_CAN_SHORTEN (1 << 1)
2107
2108 /*
2109 * These flags signal that the caller is ok with altering various aspects of
2110 * the behavior of the remap operation. The changes must be made by the
2111 * implementation; the vfs remap helper functions can take advantage of them.
2112 * Flags in this category exist to preserve the quirky behavior of the hoisted
2113 * btrfs clone/dedupe ioctls.
2114 */
2115 #define REMAP_FILE_ADVISORY (REMAP_FILE_CAN_SHORTEN)
2116
2117 /*
2118 * These flags control the behavior of vfs_copy_file_range().
2119 * They are not available to the user via syscall.
2120 *
2121 * COPY_FILE_SPLICE: call splice direct instead of fs clone/copy ops
2122 */
2123 #define COPY_FILE_SPLICE (1 << 0)
2124
2125 struct iov_iter;
2126 struct io_uring_cmd;
2127 struct offset_ctx;
2128
2129 typedef unsigned int __bitwise fop_flags_t;
2130
2131 struct file_operations {
2132 struct module *owner;
2133 fop_flags_t fop_flags;
2134 loff_t (*llseek) (struct file *, loff_t, int);
2135 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
2136 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
2137 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
2138 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
2139 int (*iopoll)(struct kiocb *kiocb, struct io_comp_batch *,
2140 unsigned int flags);
2141 int (*iterate_shared) (struct file *, struct dir_context *);
2142 __poll_t (*poll) (struct file *, struct poll_table_struct *);
2143 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
2144 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
2145 int (*mmap) (struct file *, struct vm_area_struct *);
2146 int (*open) (struct inode *, struct file *);
2147 int (*flush) (struct file *, fl_owner_t id);
2148 int (*release) (struct inode *, struct file *);
2149 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
2150 int (*fasync) (int, struct file *, int);
2151 int (*lock) (struct file *, int, struct file_lock *);
2152 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
2153 int (*check_flags)(int);
2154 int (*flock) (struct file *, int, struct file_lock *);
2155 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
2156 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
2157 void (*splice_eof)(struct file *file);
2158 int (*setlease)(struct file *, int, struct file_lease **, void **);
2159 long (*fallocate)(struct file *file, int mode, loff_t offset,
2160 loff_t len);
2161 void (*show_fdinfo)(struct seq_file *m, struct file *f);
2162 #ifndef CONFIG_MMU
2163 unsigned (*mmap_capabilities)(struct file *);
2164 #endif
2165 ssize_t (*copy_file_range)(struct file *, loff_t, struct file *,
2166 loff_t, size_t, unsigned int);
2167 loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in,
2168 struct file *file_out, loff_t pos_out,
2169 loff_t len, unsigned int remap_flags);
2170 int (*fadvise)(struct file *, loff_t, loff_t, int);
2171 int (*uring_cmd)(struct io_uring_cmd *ioucmd, unsigned int issue_flags);
2172 int (*uring_cmd_iopoll)(struct io_uring_cmd *, struct io_comp_batch *,
2173 unsigned int poll_flags);
2174 } __randomize_layout;
2175
2176 /* Supports async buffered reads */
2177 #define FOP_BUFFER_RASYNC ((__force fop_flags_t)(1 << 0))
2178 /* Supports async buffered writes */
2179 #define FOP_BUFFER_WASYNC ((__force fop_flags_t)(1 << 1))
2180 /* Supports synchronous page faults for mappings */
2181 #define FOP_MMAP_SYNC ((__force fop_flags_t)(1 << 2))
2182 /* Supports non-exclusive O_DIRECT writes from multiple threads */
2183 #define FOP_DIO_PARALLEL_WRITE ((__force fop_flags_t)(1 << 3))
2184 /* Contains huge pages */
2185 #define FOP_HUGE_PAGES ((__force fop_flags_t)(1 << 4))
2186 /* Treat loff_t as unsigned (e.g., /dev/mem) */
2187 #define FOP_UNSIGNED_OFFSET ((__force fop_flags_t)(1 << 5))
2188 /* Supports asynchronous lock callbacks */
2189 #define FOP_ASYNC_LOCK ((__force fop_flags_t)(1 << 6))
2190 /* File system supports uncached read/write buffered IO */
2191 #define FOP_DONTCACHE ((__force fop_flags_t)(1 << 7))
2192
2193 /* Wrap a directory iterator that needs exclusive inode access */
2194 int wrap_directory_iterator(struct file *, struct dir_context *,
2195 int (*) (struct file *, struct dir_context *));
2196 #define WRAP_DIR_ITER(x) \
2197 static int shared_##x(struct file *file , struct dir_context *ctx) \
2198 { return wrap_directory_iterator(file, ctx, x); }
2199
2200 struct inode_operations {
2201 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
2202 const char * (*get_link) (struct dentry *, struct inode *, struct delayed_call *);
2203 int (*permission) (struct mnt_idmap *, struct inode *, int);
2204 struct posix_acl * (*get_inode_acl)(struct inode *, int, bool);
2205
2206 int (*readlink) (struct dentry *, char __user *,int);
2207
2208 int (*create) (struct mnt_idmap *, struct inode *,struct dentry *,
2209 umode_t, bool);
2210 int (*link) (struct dentry *,struct inode *,struct dentry *);
2211 int (*unlink) (struct inode *,struct dentry *);
2212 int (*symlink) (struct mnt_idmap *, struct inode *,struct dentry *,
2213 const char *);
2214 int (*mkdir) (struct mnt_idmap *, struct inode *,struct dentry *,
2215 umode_t);
2216 int (*rmdir) (struct inode *,struct dentry *);
2217 int (*mknod) (struct mnt_idmap *, struct inode *,struct dentry *,
2218 umode_t,dev_t);
2219 int (*rename) (struct mnt_idmap *, struct inode *, struct dentry *,
2220 struct inode *, struct dentry *, unsigned int);
2221 int (*setattr) (struct mnt_idmap *, struct dentry *, struct iattr *);
2222 int (*getattr) (struct mnt_idmap *, const struct path *,
2223 struct kstat *, u32, unsigned int);
2224 ssize_t (*listxattr) (struct dentry *, char *, size_t);
2225 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
2226 u64 len);
2227 int (*update_time)(struct inode *, int);
2228 int (*atomic_open)(struct inode *, struct dentry *,
2229 struct file *, unsigned open_flag,
2230 umode_t create_mode);
2231 int (*tmpfile) (struct mnt_idmap *, struct inode *,
2232 struct file *, umode_t);
2233 struct posix_acl *(*get_acl)(struct mnt_idmap *, struct dentry *,
2234 int);
2235 int (*set_acl)(struct mnt_idmap *, struct dentry *,
2236 struct posix_acl *, int);
2237 int (*fileattr_set)(struct mnt_idmap *idmap,
2238 struct dentry *dentry, struct fileattr *fa);
2239 int (*fileattr_get)(struct dentry *dentry, struct fileattr *fa);
2240 struct offset_ctx *(*get_offset_ctx)(struct inode *inode);
2241 } ____cacheline_aligned;
2242
call_mmap(struct file * file,struct vm_area_struct * vma)2243 static inline int call_mmap(struct file *file, struct vm_area_struct *vma)
2244 {
2245 return file->f_op->mmap(file, vma);
2246 }
2247
2248 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
2249 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
2250 extern ssize_t vfs_copy_file_range(struct file *, loff_t , struct file *,
2251 loff_t, size_t, unsigned int);
2252 int remap_verify_area(struct file *file, loff_t pos, loff_t len, bool write);
2253 int __generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
2254 struct file *file_out, loff_t pos_out,
2255 loff_t *len, unsigned int remap_flags,
2256 const struct iomap_ops *dax_read_ops);
2257 int generic_remap_file_range_prep(struct file *file_in, loff_t pos_in,
2258 struct file *file_out, loff_t pos_out,
2259 loff_t *count, unsigned int remap_flags);
2260 extern loff_t vfs_clone_file_range(struct file *file_in, loff_t pos_in,
2261 struct file *file_out, loff_t pos_out,
2262 loff_t len, unsigned int remap_flags);
2263 extern int vfs_dedupe_file_range(struct file *file,
2264 struct file_dedupe_range *same);
2265 extern loff_t vfs_dedupe_file_range_one(struct file *src_file, loff_t src_pos,
2266 struct file *dst_file, loff_t dst_pos,
2267 loff_t len, unsigned int remap_flags);
2268
2269 /**
2270 * enum freeze_holder - holder of the freeze
2271 * @FREEZE_HOLDER_KERNEL: kernel wants to freeze or thaw filesystem
2272 * @FREEZE_HOLDER_USERSPACE: userspace wants to freeze or thaw filesystem
2273 * @FREEZE_MAY_NEST: whether nesting freeze and thaw requests is allowed
2274 *
2275 * Indicate who the owner of the freeze or thaw request is and whether
2276 * the freeze needs to be exclusive or can nest.
2277 * Without @FREEZE_MAY_NEST, multiple freeze and thaw requests from the
2278 * same holder aren't allowed. It is however allowed to hold a single
2279 * @FREEZE_HOLDER_USERSPACE and a single @FREEZE_HOLDER_KERNEL freeze at
2280 * the same time. This is relied upon by some filesystems during online
2281 * repair or similar.
2282 */
2283 enum freeze_holder {
2284 FREEZE_HOLDER_KERNEL = (1U << 0),
2285 FREEZE_HOLDER_USERSPACE = (1U << 1),
2286 FREEZE_MAY_NEST = (1U << 2),
2287 };
2288
2289 struct super_operations {
2290 struct inode *(*alloc_inode)(struct super_block *sb);
2291 void (*destroy_inode)(struct inode *);
2292 void (*free_inode)(struct inode *);
2293
2294 void (*dirty_inode) (struct inode *, int flags);
2295 int (*write_inode) (struct inode *, struct writeback_control *wbc);
2296 int (*drop_inode) (struct inode *);
2297 void (*evict_inode) (struct inode *);
2298 void (*put_super) (struct super_block *);
2299 int (*sync_fs)(struct super_block *sb, int wait);
2300 int (*freeze_super) (struct super_block *, enum freeze_holder who);
2301 int (*freeze_fs) (struct super_block *);
2302 int (*thaw_super) (struct super_block *, enum freeze_holder who);
2303 int (*unfreeze_fs) (struct super_block *);
2304 int (*statfs) (struct dentry *, struct kstatfs *);
2305 int (*remount_fs) (struct super_block *, int *, char *);
2306 void (*umount_begin) (struct super_block *);
2307
2308 int (*show_options)(struct seq_file *, struct dentry *);
2309 int (*show_devname)(struct seq_file *, struct dentry *);
2310 int (*show_path)(struct seq_file *, struct dentry *);
2311 int (*show_stats)(struct seq_file *, struct dentry *);
2312 #ifdef CONFIG_QUOTA
2313 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
2314 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
2315 struct dquot __rcu **(*get_dquots)(struct inode *);
2316 #endif
2317 long (*nr_cached_objects)(struct super_block *,
2318 struct shrink_control *);
2319 long (*free_cached_objects)(struct super_block *,
2320 struct shrink_control *);
2321 void (*shutdown)(struct super_block *sb);
2322 };
2323
2324 /*
2325 * Inode flags - they have no relation to superblock flags now
2326 */
2327 #define S_SYNC (1 << 0) /* Writes are synced at once */
2328 #define S_NOATIME (1 << 1) /* Do not update access times */
2329 #define S_APPEND (1 << 2) /* Append-only file */
2330 #define S_IMMUTABLE (1 << 3) /* Immutable file */
2331 #define S_DEAD (1 << 4) /* removed, but still open directory */
2332 #define S_NOQUOTA (1 << 5) /* Inode is not counted to quota */
2333 #define S_DIRSYNC (1 << 6) /* Directory modifications are synchronous */
2334 #define S_NOCMTIME (1 << 7) /* Do not update file c/mtime */
2335 #define S_SWAPFILE (1 << 8) /* Do not truncate: swapon got its bmaps */
2336 #define S_PRIVATE (1 << 9) /* Inode is fs-internal */
2337 #define S_IMA (1 << 10) /* Inode has an associated IMA struct */
2338 #define S_AUTOMOUNT (1 << 11) /* Automount/referral quasi-directory */
2339 #define S_NOSEC (1 << 12) /* no suid or xattr security attributes */
2340 #ifdef CONFIG_FS_DAX
2341 #define S_DAX (1 << 13) /* Direct Access, avoiding the page cache */
2342 #else
2343 #define S_DAX 0 /* Make all the DAX code disappear */
2344 #endif
2345 #define S_ENCRYPTED (1 << 14) /* Encrypted file (using fs/crypto/) */
2346 #define S_CASEFOLD (1 << 15) /* Casefolded file */
2347 #define S_VERITY (1 << 16) /* Verity file (using fs/verity/) */
2348 #define S_KERNEL_FILE (1 << 17) /* File is in use by the kernel (eg. fs/cachefiles) */
2349
2350 /*
2351 * Note that nosuid etc flags are inode-specific: setting some file-system
2352 * flags just means all the inodes inherit those flags by default. It might be
2353 * possible to override it selectively if you really wanted to with some
2354 * ioctl() that is not currently implemented.
2355 *
2356 * Exception: SB_RDONLY is always applied to the entire file system.
2357 *
2358 * Unfortunately, it is possible to change a filesystems flags with it mounted
2359 * with files in use. This means that all of the inodes will not have their
2360 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
2361 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
2362 */
2363 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
2364
sb_rdonly(const struct super_block * sb)2365 static inline bool sb_rdonly(const struct super_block *sb) { return sb->s_flags & SB_RDONLY; }
2366 #define IS_RDONLY(inode) sb_rdonly((inode)->i_sb)
2367 #define IS_SYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS) || \
2368 ((inode)->i_flags & S_SYNC))
2369 #define IS_DIRSYNC(inode) (__IS_FLG(inode, SB_SYNCHRONOUS|SB_DIRSYNC) || \
2370 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
2371 #define IS_MANDLOCK(inode) __IS_FLG(inode, SB_MANDLOCK)
2372 #define IS_NOATIME(inode) __IS_FLG(inode, SB_RDONLY|SB_NOATIME)
2373 #define IS_I_VERSION(inode) __IS_FLG(inode, SB_I_VERSION)
2374
2375 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
2376 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
2377 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
2378
2379 #ifdef CONFIG_FS_POSIX_ACL
2380 #define IS_POSIXACL(inode) __IS_FLG(inode, SB_POSIXACL)
2381 #else
2382 #define IS_POSIXACL(inode) 0
2383 #endif
2384
2385 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
2386 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
2387
2388 #ifdef CONFIG_SWAP
2389 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
2390 #else
2391 #define IS_SWAPFILE(inode) ((void)(inode), 0U)
2392 #endif
2393
2394 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
2395 #define IS_IMA(inode) ((inode)->i_flags & S_IMA)
2396 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
2397 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
2398 #define IS_DAX(inode) ((inode)->i_flags & S_DAX)
2399 #define IS_ENCRYPTED(inode) ((inode)->i_flags & S_ENCRYPTED)
2400 #define IS_CASEFOLDED(inode) ((inode)->i_flags & S_CASEFOLD)
2401 #define IS_VERITY(inode) ((inode)->i_flags & S_VERITY)
2402
2403 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
2404 (inode)->i_rdev == WHITEOUT_DEV)
2405
HAS_UNMAPPED_ID(struct mnt_idmap * idmap,struct inode * inode)2406 static inline bool HAS_UNMAPPED_ID(struct mnt_idmap *idmap,
2407 struct inode *inode)
2408 {
2409 return !vfsuid_valid(i_uid_into_vfsuid(idmap, inode)) ||
2410 !vfsgid_valid(i_gid_into_vfsgid(idmap, inode));
2411 }
2412
init_sync_kiocb(struct kiocb * kiocb,struct file * filp)2413 static inline void init_sync_kiocb(struct kiocb *kiocb, struct file *filp)
2414 {
2415 *kiocb = (struct kiocb) {
2416 .ki_filp = filp,
2417 .ki_flags = filp->f_iocb_flags,
2418 .ki_ioprio = get_current_ioprio(),
2419 };
2420 }
2421
kiocb_clone(struct kiocb * kiocb,struct kiocb * kiocb_src,struct file * filp)2422 static inline void kiocb_clone(struct kiocb *kiocb, struct kiocb *kiocb_src,
2423 struct file *filp)
2424 {
2425 *kiocb = (struct kiocb) {
2426 .ki_filp = filp,
2427 .ki_flags = kiocb_src->ki_flags,
2428 .ki_ioprio = kiocb_src->ki_ioprio,
2429 .ki_pos = kiocb_src->ki_pos,
2430 };
2431 }
2432
2433 /*
2434 * Inode state bits. Protected by inode->i_lock
2435 *
2436 * Four bits determine the dirty state of the inode: I_DIRTY_SYNC,
2437 * I_DIRTY_DATASYNC, I_DIRTY_PAGES, and I_DIRTY_TIME.
2438 *
2439 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
2440 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
2441 * various stages of removing an inode.
2442 *
2443 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
2444 *
2445 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
2446 * fdatasync() (unless I_DIRTY_DATASYNC is also set).
2447 * Timestamp updates are the usual cause.
2448 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
2449 * these changes separately from I_DIRTY_SYNC so that we
2450 * don't have to write inode on fdatasync() when only
2451 * e.g. the timestamps have changed.
2452 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
2453 * I_DIRTY_TIME The inode itself has dirty timestamps, and the
2454 * lazytime mount option is enabled. We keep track of this
2455 * separately from I_DIRTY_SYNC in order to implement
2456 * lazytime. This gets cleared if I_DIRTY_INODE
2457 * (I_DIRTY_SYNC and/or I_DIRTY_DATASYNC) gets set. But
2458 * I_DIRTY_TIME can still be set if I_DIRTY_SYNC is already
2459 * in place because writeback might already be in progress
2460 * and we don't want to lose the time update
2461 * I_NEW Serves as both a mutex and completion notification.
2462 * New inodes set I_NEW. If two processes both create
2463 * the same inode, one of them will release its inode and
2464 * wait for I_NEW to be released before returning.
2465 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
2466 * also cause waiting on I_NEW, without I_NEW actually
2467 * being set. find_inode() uses this to prevent returning
2468 * nearly-dead inodes.
2469 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
2470 * is zero. I_FREEING must be set when I_WILL_FREE is
2471 * cleared.
2472 * I_FREEING Set when inode is about to be freed but still has dirty
2473 * pages or buffers attached or the inode itself is still
2474 * dirty.
2475 * I_CLEAR Added by clear_inode(). In this state the inode is
2476 * clean and can be destroyed. Inode keeps I_FREEING.
2477 *
2478 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
2479 * prohibited for many purposes. iget() must wait for
2480 * the inode to be completely released, then create it
2481 * anew. Other functions will just ignore such inodes,
2482 * if appropriate. I_NEW is used for waiting.
2483 *
2484 * I_SYNC Writeback of inode is running. The bit is set during
2485 * data writeback, and cleared with a wakeup on the bit
2486 * address once it is done. The bit is also used to pin
2487 * the inode in memory for flusher thread.
2488 *
2489 * I_REFERENCED Marks the inode as recently references on the LRU list.
2490 *
2491 * I_WB_SWITCH Cgroup bdi_writeback switching in progress. Used to
2492 * synchronize competing switching instances and to tell
2493 * wb stat updates to grab the i_pages lock. See
2494 * inode_switch_wbs_work_fn() for details.
2495 *
2496 * I_OVL_INUSE Used by overlayfs to get exclusive ownership on upper
2497 * and work dirs among overlayfs mounts.
2498 *
2499 * I_CREATING New object's inode in the middle of setting up.
2500 *
2501 * I_DONTCACHE Evict inode as soon as it is not used anymore.
2502 *
2503 * I_SYNC_QUEUED Inode is queued in b_io or b_more_io writeback lists.
2504 * Used to detect that mark_inode_dirty() should not move
2505 * inode between dirty lists.
2506 *
2507 * I_PINNING_FSCACHE_WB Inode is pinning an fscache object for writeback.
2508 *
2509 * I_LRU_ISOLATING Inode is pinned being isolated from LRU without holding
2510 * i_count.
2511 *
2512 * Q: What is the difference between I_WILL_FREE and I_FREEING?
2513 *
2514 * __I_{SYNC,NEW,LRU_ISOLATING} are used to derive unique addresses to wait
2515 * upon. There's one free address left.
2516 */
2517 #define __I_NEW 0
2518 #define I_NEW (1 << __I_NEW)
2519 #define __I_SYNC 1
2520 #define I_SYNC (1 << __I_SYNC)
2521 #define __I_LRU_ISOLATING 2
2522 #define I_LRU_ISOLATING (1 << __I_LRU_ISOLATING)
2523
2524 #define I_DIRTY_SYNC (1 << 3)
2525 #define I_DIRTY_DATASYNC (1 << 4)
2526 #define I_DIRTY_PAGES (1 << 5)
2527 #define I_WILL_FREE (1 << 6)
2528 #define I_FREEING (1 << 7)
2529 #define I_CLEAR (1 << 8)
2530 #define I_REFERENCED (1 << 9)
2531 #define I_LINKABLE (1 << 10)
2532 #define I_DIRTY_TIME (1 << 11)
2533 #define I_WB_SWITCH (1 << 12)
2534 #define I_OVL_INUSE (1 << 13)
2535 #define I_CREATING (1 << 14)
2536 #define I_DONTCACHE (1 << 15)
2537 #define I_SYNC_QUEUED (1 << 16)
2538 #define I_PINNING_NETFS_WB (1 << 17)
2539
2540 #define I_DIRTY_INODE (I_DIRTY_SYNC | I_DIRTY_DATASYNC)
2541 #define I_DIRTY (I_DIRTY_INODE | I_DIRTY_PAGES)
2542 #define I_DIRTY_ALL (I_DIRTY | I_DIRTY_TIME)
2543
2544 extern void __mark_inode_dirty(struct inode *, int);
mark_inode_dirty(struct inode * inode)2545 static inline void mark_inode_dirty(struct inode *inode)
2546 {
2547 __mark_inode_dirty(inode, I_DIRTY);
2548 }
2549
mark_inode_dirty_sync(struct inode * inode)2550 static inline void mark_inode_dirty_sync(struct inode *inode)
2551 {
2552 __mark_inode_dirty(inode, I_DIRTY_SYNC);
2553 }
2554
2555 /*
2556 * Returns true if the given inode itself only has dirty timestamps (its pages
2557 * may still be dirty) and isn't currently being allocated or freed.
2558 * Filesystems should call this if when writing an inode when lazytime is
2559 * enabled, they want to opportunistically write the timestamps of other inodes
2560 * located very nearby on-disk, e.g. in the same inode block. This returns true
2561 * if the given inode is in need of such an opportunistic update. Requires
2562 * i_lock, or at least later re-checking under i_lock.
2563 */
inode_is_dirtytime_only(struct inode * inode)2564 static inline bool inode_is_dirtytime_only(struct inode *inode)
2565 {
2566 return (inode->i_state & (I_DIRTY_TIME | I_NEW |
2567 I_FREEING | I_WILL_FREE)) == I_DIRTY_TIME;
2568 }
2569
2570 extern void inc_nlink(struct inode *inode);
2571 extern void drop_nlink(struct inode *inode);
2572 extern void clear_nlink(struct inode *inode);
2573 extern void set_nlink(struct inode *inode, unsigned int nlink);
2574
inode_inc_link_count(struct inode * inode)2575 static inline void inode_inc_link_count(struct inode *inode)
2576 {
2577 inc_nlink(inode);
2578 mark_inode_dirty(inode);
2579 }
2580
inode_dec_link_count(struct inode * inode)2581 static inline void inode_dec_link_count(struct inode *inode)
2582 {
2583 drop_nlink(inode);
2584 mark_inode_dirty(inode);
2585 }
2586
2587 enum file_time_flags {
2588 S_ATIME = 1,
2589 S_MTIME = 2,
2590 S_CTIME = 4,
2591 S_VERSION = 8,
2592 };
2593
2594 extern bool atime_needs_update(const struct path *, struct inode *);
2595 extern void touch_atime(const struct path *);
2596 int inode_update_time(struct inode *inode, int flags);
2597
file_accessed(struct file * file)2598 static inline void file_accessed(struct file *file)
2599 {
2600 if (!(file->f_flags & O_NOATIME))
2601 touch_atime(&file->f_path);
2602 }
2603
2604 extern int file_modified(struct file *file);
2605 int kiocb_modified(struct kiocb *iocb);
2606
2607 int sync_inode_metadata(struct inode *inode, int wait);
2608
2609 struct file_system_type {
2610 const char *name;
2611 int fs_flags;
2612 #define FS_REQUIRES_DEV 1
2613 #define FS_BINARY_MOUNTDATA 2
2614 #define FS_HAS_SUBTYPE 4
2615 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
2616 #define FS_DISALLOW_NOTIFY_PERM 16 /* Disable fanotify permission events */
2617 #define FS_ALLOW_IDMAP 32 /* FS has been updated to handle vfs idmappings. */
2618 #define FS_MGTIME 64 /* FS uses multigrain timestamps */
2619 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
2620 int (*init_fs_context)(struct fs_context *);
2621 const struct fs_parameter_spec *parameters;
2622 struct dentry *(*mount) (struct file_system_type *, int,
2623 const char *, void *);
2624 void (*kill_sb) (struct super_block *);
2625 struct module *owner;
2626 struct file_system_type * next;
2627 struct hlist_head fs_supers;
2628
2629 struct lock_class_key s_lock_key;
2630 struct lock_class_key s_umount_key;
2631 struct lock_class_key s_vfs_rename_key;
2632 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
2633
2634 struct lock_class_key i_lock_key;
2635 struct lock_class_key i_mutex_key;
2636 struct lock_class_key invalidate_lock_key;
2637 struct lock_class_key i_mutex_dir_key;
2638 };
2639
2640 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
2641
2642 /**
2643 * is_mgtime: is this inode using multigrain timestamps
2644 * @inode: inode to test for multigrain timestamps
2645 *
2646 * Return true if the inode uses multigrain timestamps, false otherwise.
2647 */
is_mgtime(const struct inode * inode)2648 static inline bool is_mgtime(const struct inode *inode)
2649 {
2650 return inode->i_opflags & IOP_MGTIME;
2651 }
2652
2653 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
2654 int flags, const char *dev_name, void *data,
2655 int (*fill_super)(struct super_block *, void *, int));
2656 extern struct dentry *mount_single(struct file_system_type *fs_type,
2657 int flags, void *data,
2658 int (*fill_super)(struct super_block *, void *, int));
2659 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
2660 int flags, void *data,
2661 int (*fill_super)(struct super_block *, void *, int));
2662 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
2663 void retire_super(struct super_block *sb);
2664 void generic_shutdown_super(struct super_block *sb);
2665 void kill_block_super(struct super_block *sb);
2666 void kill_anon_super(struct super_block *sb);
2667 void kill_litter_super(struct super_block *sb);
2668 void deactivate_super(struct super_block *sb);
2669 void deactivate_locked_super(struct super_block *sb);
2670 int set_anon_super(struct super_block *s, void *data);
2671 int set_anon_super_fc(struct super_block *s, struct fs_context *fc);
2672 int get_anon_bdev(dev_t *);
2673 void free_anon_bdev(dev_t);
2674 struct super_block *sget_fc(struct fs_context *fc,
2675 int (*test)(struct super_block *, struct fs_context *),
2676 int (*set)(struct super_block *, struct fs_context *));
2677 struct super_block *sget(struct file_system_type *type,
2678 int (*test)(struct super_block *,void *),
2679 int (*set)(struct super_block *,void *),
2680 int flags, void *data);
2681 struct super_block *sget_dev(struct fs_context *fc, dev_t dev);
2682
2683 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
2684 #define fops_get(fops) ({ \
2685 const struct file_operations *_fops = (fops); \
2686 (((_fops) && try_module_get((_fops)->owner) ? (_fops) : NULL)); \
2687 })
2688
2689 #define fops_put(fops) ({ \
2690 const struct file_operations *_fops = (fops); \
2691 if (_fops) \
2692 module_put((_fops)->owner); \
2693 })
2694
2695 /*
2696 * This one is to be used *ONLY* from ->open() instances.
2697 * fops must be non-NULL, pinned down *and* module dependencies
2698 * should be sufficient to pin the caller down as well.
2699 */
2700 #define replace_fops(f, fops) \
2701 do { \
2702 struct file *__file = (f); \
2703 fops_put(__file->f_op); \
2704 BUG_ON(!(__file->f_op = (fops))); \
2705 } while(0)
2706
2707 extern int register_filesystem(struct file_system_type *);
2708 extern int unregister_filesystem(struct file_system_type *);
2709 extern int vfs_statfs(const struct path *, struct kstatfs *);
2710 extern int user_statfs(const char __user *, struct kstatfs *);
2711 extern int fd_statfs(int, struct kstatfs *);
2712 int freeze_super(struct super_block *super, enum freeze_holder who);
2713 int thaw_super(struct super_block *super, enum freeze_holder who);
2714 extern __printf(2, 3)
2715 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...);
2716 extern int super_setup_bdi(struct super_block *sb);
2717
super_set_uuid(struct super_block * sb,const u8 * uuid,unsigned len)2718 static inline void super_set_uuid(struct super_block *sb, const u8 *uuid, unsigned len)
2719 {
2720 if (WARN_ON(len > sizeof(sb->s_uuid)))
2721 len = sizeof(sb->s_uuid);
2722 sb->s_uuid_len = len;
2723 memcpy(&sb->s_uuid, uuid, len);
2724 }
2725
2726 /* set sb sysfs name based on sb->s_bdev */
super_set_sysfs_name_bdev(struct super_block * sb)2727 static inline void super_set_sysfs_name_bdev(struct super_block *sb)
2728 {
2729 snprintf(sb->s_sysfs_name, sizeof(sb->s_sysfs_name), "%pg", sb->s_bdev);
2730 }
2731
2732 /* set sb sysfs name based on sb->s_uuid */
super_set_sysfs_name_uuid(struct super_block * sb)2733 static inline void super_set_sysfs_name_uuid(struct super_block *sb)
2734 {
2735 WARN_ON(sb->s_uuid_len != sizeof(sb->s_uuid));
2736 snprintf(sb->s_sysfs_name, sizeof(sb->s_sysfs_name), "%pU", sb->s_uuid.b);
2737 }
2738
2739 /* set sb sysfs name based on sb->s_id */
super_set_sysfs_name_id(struct super_block * sb)2740 static inline void super_set_sysfs_name_id(struct super_block *sb)
2741 {
2742 strscpy(sb->s_sysfs_name, sb->s_id, sizeof(sb->s_sysfs_name));
2743 }
2744
2745 /* try to use something standard before you use this */
2746 __printf(2, 3)
super_set_sysfs_name_generic(struct super_block * sb,const char * fmt,...)2747 static inline void super_set_sysfs_name_generic(struct super_block *sb, const char *fmt, ...)
2748 {
2749 va_list args;
2750
2751 va_start(args, fmt);
2752 vsnprintf(sb->s_sysfs_name, sizeof(sb->s_sysfs_name), fmt, args);
2753 va_end(args);
2754 }
2755
2756 extern int current_umask(void);
2757
2758 extern void ihold(struct inode * inode);
2759 extern void iput(struct inode *);
2760 int inode_update_timestamps(struct inode *inode, int flags);
2761 int generic_update_time(struct inode *, int);
2762
2763 /* /sys/fs */
2764 extern struct kobject *fs_kobj;
2765
2766 #define MAX_RW_COUNT (INT_MAX & PAGE_MASK)
2767
2768 /* fs/open.c */
2769 struct audit_names;
2770 struct filename {
2771 const char *name; /* pointer to actual string */
2772 const __user char *uptr; /* original userland pointer */
2773 atomic_t refcnt;
2774 struct audit_names *aname;
2775 const char iname[];
2776 };
2777 static_assert(offsetof(struct filename, iname) % sizeof(long) == 0);
2778
file_mnt_idmap(const struct file * file)2779 static inline struct mnt_idmap *file_mnt_idmap(const struct file *file)
2780 {
2781 return mnt_idmap(file->f_path.mnt);
2782 }
2783
2784 /**
2785 * is_idmapped_mnt - check whether a mount is mapped
2786 * @mnt: the mount to check
2787 *
2788 * If @mnt has an non @nop_mnt_idmap attached to it then @mnt is mapped.
2789 *
2790 * Return: true if mount is mapped, false if not.
2791 */
is_idmapped_mnt(const struct vfsmount * mnt)2792 static inline bool is_idmapped_mnt(const struct vfsmount *mnt)
2793 {
2794 return mnt_idmap(mnt) != &nop_mnt_idmap;
2795 }
2796
2797 extern long vfs_truncate(const struct path *, loff_t);
2798 int do_truncate(struct mnt_idmap *, struct dentry *, loff_t start,
2799 unsigned int time_attrs, struct file *filp);
2800 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2801 loff_t len);
2802 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2803 umode_t mode);
2804 extern struct file *file_open_name(struct filename *, int, umode_t);
2805 extern struct file *filp_open(const char *, int, umode_t);
2806 extern struct file *file_open_root(const struct path *,
2807 const char *, int, umode_t);
file_open_root_mnt(struct vfsmount * mnt,const char * name,int flags,umode_t mode)2808 static inline struct file *file_open_root_mnt(struct vfsmount *mnt,
2809 const char *name, int flags, umode_t mode)
2810 {
2811 return file_open_root(&(struct path){.mnt = mnt, .dentry = mnt->mnt_root},
2812 name, flags, mode);
2813 }
2814 struct file *dentry_open(const struct path *path, int flags,
2815 const struct cred *creds);
2816 struct file *dentry_open_nonotify(const struct path *path, int flags,
2817 const struct cred *cred);
2818 struct file *dentry_create(const struct path *path, int flags, umode_t mode,
2819 const struct cred *cred);
2820 struct path *backing_file_user_path(struct file *f);
2821
2822 /*
2823 * When mmapping a file on a stackable filesystem (e.g., overlayfs), the file
2824 * stored in ->vm_file is a backing file whose f_inode is on the underlying
2825 * filesystem. When the mapped file path and inode number are displayed to
2826 * user (e.g. via /proc/<pid>/maps), these helpers should be used to get the
2827 * path and inode number to display to the user, which is the path of the fd
2828 * that user has requested to map and the inode number that would be returned
2829 * by fstat() on that same fd.
2830 */
2831 /* Get the path to display in /proc/<pid>/maps */
file_user_path(struct file * f)2832 static inline const struct path *file_user_path(struct file *f)
2833 {
2834 if (unlikely(f->f_mode & FMODE_BACKING))
2835 return backing_file_user_path(f);
2836 return &f->f_path;
2837 }
2838 /* Get the inode whose inode number to display in /proc/<pid>/maps */
file_user_inode(struct file * f)2839 static inline const struct inode *file_user_inode(struct file *f)
2840 {
2841 if (unlikely(f->f_mode & FMODE_BACKING))
2842 return d_inode(backing_file_user_path(f)->dentry);
2843 return file_inode(f);
2844 }
2845
file_clone_open(struct file * file)2846 static inline struct file *file_clone_open(struct file *file)
2847 {
2848 return dentry_open(&file->f_path, file->f_flags, file->f_cred);
2849 }
2850 extern int filp_close(struct file *, fl_owner_t id);
2851
2852 extern struct filename *getname_flags(const char __user *, int);
2853 extern struct filename *getname_uflags(const char __user *, int);
2854 extern struct filename *getname(const char __user *);
2855 extern struct filename *getname_kernel(const char *);
2856 extern struct filename *__getname_maybe_null(const char __user *);
getname_maybe_null(const char __user * name,int flags)2857 static inline struct filename *getname_maybe_null(const char __user *name, int flags)
2858 {
2859 if (!(flags & AT_EMPTY_PATH))
2860 return getname(name);
2861
2862 if (!name)
2863 return NULL;
2864 return __getname_maybe_null(name);
2865 }
2866 extern void putname(struct filename *name);
2867
2868 extern int finish_open(struct file *file, struct dentry *dentry,
2869 int (*open)(struct inode *, struct file *));
2870 extern int finish_no_open(struct file *file, struct dentry *dentry);
2871
2872 /* Helper for the simple case when original dentry is used */
finish_open_simple(struct file * file,int error)2873 static inline int finish_open_simple(struct file *file, int error)
2874 {
2875 if (error)
2876 return error;
2877
2878 return finish_open(file, file->f_path.dentry, NULL);
2879 }
2880
2881 /* fs/dcache.c */
2882 extern void __init vfs_caches_init_early(void);
2883 extern void __init vfs_caches_init(void);
2884
2885 extern struct kmem_cache *names_cachep;
2886
2887 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
2888 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
2889
2890 extern struct super_block *blockdev_superblock;
sb_is_blkdev_sb(struct super_block * sb)2891 static inline bool sb_is_blkdev_sb(struct super_block *sb)
2892 {
2893 return IS_ENABLED(CONFIG_BLOCK) && sb == blockdev_superblock;
2894 }
2895
2896 void emergency_thaw_all(void);
2897 extern int sync_filesystem(struct super_block *);
2898 extern const struct file_operations def_blk_fops;
2899 extern const struct file_operations def_chr_fops;
2900
2901 /* fs/char_dev.c */
2902 #define CHRDEV_MAJOR_MAX 512
2903 /* Marks the bottom of the first segment of free char majors */
2904 #define CHRDEV_MAJOR_DYN_END 234
2905 /* Marks the top and bottom of the second segment of free char majors */
2906 #define CHRDEV_MAJOR_DYN_EXT_START 511
2907 #define CHRDEV_MAJOR_DYN_EXT_END 384
2908
2909 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2910 extern int register_chrdev_region(dev_t, unsigned, const char *);
2911 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2912 unsigned int count, const char *name,
2913 const struct file_operations *fops);
2914 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2915 unsigned int count, const char *name);
2916 extern void unregister_chrdev_region(dev_t, unsigned);
2917 extern void chrdev_show(struct seq_file *,off_t);
2918
register_chrdev(unsigned int major,const char * name,const struct file_operations * fops)2919 static inline int register_chrdev(unsigned int major, const char *name,
2920 const struct file_operations *fops)
2921 {
2922 return __register_chrdev(major, 0, 256, name, fops);
2923 }
2924
unregister_chrdev(unsigned int major,const char * name)2925 static inline void unregister_chrdev(unsigned int major, const char *name)
2926 {
2927 __unregister_chrdev(major, 0, 256, name);
2928 }
2929
2930 extern void init_special_inode(struct inode *, umode_t, dev_t);
2931
2932 /* Invalid inode operations -- fs/bad_inode.c */
2933 extern void make_bad_inode(struct inode *);
2934 extern bool is_bad_inode(struct inode *);
2935
2936 extern int __must_check file_fdatawait_range(struct file *file, loff_t lstart,
2937 loff_t lend);
2938 extern int __must_check file_check_and_advance_wb_err(struct file *file);
2939 extern int __must_check file_write_and_wait_range(struct file *file,
2940 loff_t start, loff_t end);
2941 int filemap_fdatawrite_range_kick(struct address_space *mapping, loff_t start,
2942 loff_t end);
2943
file_write_and_wait(struct file * file)2944 static inline int file_write_and_wait(struct file *file)
2945 {
2946 return file_write_and_wait_range(file, 0, LLONG_MAX);
2947 }
2948
2949 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2950 int datasync);
2951 extern int vfs_fsync(struct file *file, int datasync);
2952
2953 extern int sync_file_range(struct file *file, loff_t offset, loff_t nbytes,
2954 unsigned int flags);
2955
iocb_is_dsync(const struct kiocb * iocb)2956 static inline bool iocb_is_dsync(const struct kiocb *iocb)
2957 {
2958 return (iocb->ki_flags & IOCB_DSYNC) ||
2959 IS_SYNC(iocb->ki_filp->f_mapping->host);
2960 }
2961
2962 /*
2963 * Sync the bytes written if this was a synchronous write. Expect ki_pos
2964 * to already be updated for the write, and will return either the amount
2965 * of bytes passed in, or an error if syncing the file failed.
2966 */
generic_write_sync(struct kiocb * iocb,ssize_t count)2967 static inline ssize_t generic_write_sync(struct kiocb *iocb, ssize_t count)
2968 {
2969 if (iocb_is_dsync(iocb)) {
2970 int ret = vfs_fsync_range(iocb->ki_filp,
2971 iocb->ki_pos - count, iocb->ki_pos - 1,
2972 (iocb->ki_flags & IOCB_SYNC) ? 0 : 1);
2973 if (ret)
2974 return ret;
2975 } else if (iocb->ki_flags & IOCB_DONTCACHE) {
2976 struct address_space *mapping = iocb->ki_filp->f_mapping;
2977
2978 filemap_fdatawrite_range_kick(mapping, iocb->ki_pos - count,
2979 iocb->ki_pos - 1);
2980 }
2981
2982 return count;
2983 }
2984
2985 extern void emergency_sync(void);
2986 extern void emergency_remount(void);
2987
2988 #ifdef CONFIG_BLOCK
2989 extern int bmap(struct inode *inode, sector_t *block);
2990 #else
bmap(struct inode * inode,sector_t * block)2991 static inline int bmap(struct inode *inode, sector_t *block)
2992 {
2993 return -EINVAL;
2994 }
2995 #endif
2996
2997 int notify_change(struct mnt_idmap *, struct dentry *,
2998 struct iattr *, struct inode **);
2999 int inode_permission(struct mnt_idmap *, struct inode *, int);
3000 int generic_permission(struct mnt_idmap *, struct inode *, int);
file_permission(struct file * file,int mask)3001 static inline int file_permission(struct file *file, int mask)
3002 {
3003 return inode_permission(file_mnt_idmap(file),
3004 file_inode(file), mask);
3005 }
path_permission(const struct path * path,int mask)3006 static inline int path_permission(const struct path *path, int mask)
3007 {
3008 return inode_permission(mnt_idmap(path->mnt),
3009 d_inode(path->dentry), mask);
3010 }
3011 int __check_sticky(struct mnt_idmap *idmap, struct inode *dir,
3012 struct inode *inode);
3013
execute_ok(struct inode * inode)3014 static inline bool execute_ok(struct inode *inode)
3015 {
3016 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
3017 }
3018
inode_wrong_type(const struct inode * inode,umode_t mode)3019 static inline bool inode_wrong_type(const struct inode *inode, umode_t mode)
3020 {
3021 return (inode->i_mode ^ mode) & S_IFMT;
3022 }
3023
3024 /**
3025 * file_start_write - get write access to a superblock for regular file io
3026 * @file: the file we want to write to
3027 *
3028 * This is a variant of sb_start_write() which is a noop on non-regualr file.
3029 * Should be matched with a call to file_end_write().
3030 */
file_start_write(struct file * file)3031 static inline void file_start_write(struct file *file)
3032 {
3033 if (!S_ISREG(file_inode(file)->i_mode))
3034 return;
3035 sb_start_write(file_inode(file)->i_sb);
3036 }
3037
file_start_write_trylock(struct file * file)3038 static inline bool file_start_write_trylock(struct file *file)
3039 {
3040 if (!S_ISREG(file_inode(file)->i_mode))
3041 return true;
3042 return sb_start_write_trylock(file_inode(file)->i_sb);
3043 }
3044
3045 /**
3046 * file_end_write - drop write access to a superblock of a regular file
3047 * @file: the file we wrote to
3048 *
3049 * Should be matched with a call to file_start_write().
3050 */
file_end_write(struct file * file)3051 static inline void file_end_write(struct file *file)
3052 {
3053 if (!S_ISREG(file_inode(file)->i_mode))
3054 return;
3055 sb_end_write(file_inode(file)->i_sb);
3056 }
3057
3058 /**
3059 * kiocb_start_write - get write access to a superblock for async file io
3060 * @iocb: the io context we want to submit the write with
3061 *
3062 * This is a variant of sb_start_write() for async io submission.
3063 * Should be matched with a call to kiocb_end_write().
3064 */
kiocb_start_write(struct kiocb * iocb)3065 static inline void kiocb_start_write(struct kiocb *iocb)
3066 {
3067 struct inode *inode = file_inode(iocb->ki_filp);
3068
3069 sb_start_write(inode->i_sb);
3070 /*
3071 * Fool lockdep by telling it the lock got released so that it
3072 * doesn't complain about the held lock when we return to userspace.
3073 */
3074 __sb_writers_release(inode->i_sb, SB_FREEZE_WRITE);
3075 }
3076
3077 /**
3078 * kiocb_end_write - drop write access to a superblock after async file io
3079 * @iocb: the io context we sumbitted the write with
3080 *
3081 * Should be matched with a call to kiocb_start_write().
3082 */
kiocb_end_write(struct kiocb * iocb)3083 static inline void kiocb_end_write(struct kiocb *iocb)
3084 {
3085 struct inode *inode = file_inode(iocb->ki_filp);
3086
3087 /*
3088 * Tell lockdep we inherited freeze protection from submission thread.
3089 */
3090 __sb_writers_acquired(inode->i_sb, SB_FREEZE_WRITE);
3091 sb_end_write(inode->i_sb);
3092 }
3093
3094 /*
3095 * This is used for regular files where some users -- especially the
3096 * currently executed binary in a process, previously handled via
3097 * VM_DENYWRITE -- cannot handle concurrent write (and maybe mmap
3098 * read-write shared) accesses.
3099 *
3100 * get_write_access() gets write permission for a file.
3101 * put_write_access() releases this write permission.
3102 * deny_write_access() denies write access to a file.
3103 * allow_write_access() re-enables write access to a file.
3104 *
3105 * The i_writecount field of an inode can have the following values:
3106 * 0: no write access, no denied write access
3107 * < 0: (-i_writecount) users that denied write access to the file.
3108 * > 0: (i_writecount) users that have write access to the file.
3109 *
3110 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
3111 * except for the cases where we don't hold i_writecount yet. Then we need to
3112 * use {get,deny}_write_access() - these functions check the sign and refuse
3113 * to do the change if sign is wrong.
3114 */
get_write_access(struct inode * inode)3115 static inline int get_write_access(struct inode *inode)
3116 {
3117 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
3118 }
deny_write_access(struct file * file)3119 static inline int deny_write_access(struct file *file)
3120 {
3121 struct inode *inode = file_inode(file);
3122 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
3123 }
put_write_access(struct inode * inode)3124 static inline void put_write_access(struct inode * inode)
3125 {
3126 atomic_dec(&inode->i_writecount);
3127 }
allow_write_access(struct file * file)3128 static inline void allow_write_access(struct file *file)
3129 {
3130 if (file)
3131 atomic_inc(&file_inode(file)->i_writecount);
3132 }
3133
3134 /*
3135 * Do not prevent write to executable file when watched by pre-content events.
3136 *
3137 * Note that FMODE_FSNOTIFY_HSM mode is set depending on pre-content watches at
3138 * the time of file open and remains constant for entire lifetime of the file,
3139 * so if pre-content watches are added post execution or removed before the end
3140 * of the execution, it will not cause i_writecount reference leak.
3141 */
exe_file_deny_write_access(struct file * exe_file)3142 static inline int exe_file_deny_write_access(struct file *exe_file)
3143 {
3144 if (unlikely(FMODE_FSNOTIFY_HSM(exe_file->f_mode)))
3145 return 0;
3146 return deny_write_access(exe_file);
3147 }
exe_file_allow_write_access(struct file * exe_file)3148 static inline void exe_file_allow_write_access(struct file *exe_file)
3149 {
3150 if (unlikely(!exe_file || FMODE_FSNOTIFY_HSM(exe_file->f_mode)))
3151 return;
3152 allow_write_access(exe_file);
3153 }
3154
file_set_fsnotify_mode(struct file * file,fmode_t mode)3155 static inline void file_set_fsnotify_mode(struct file *file, fmode_t mode)
3156 {
3157 file->f_mode &= ~FMODE_FSNOTIFY_MASK;
3158 file->f_mode |= mode;
3159 }
3160
inode_is_open_for_write(const struct inode * inode)3161 static inline bool inode_is_open_for_write(const struct inode *inode)
3162 {
3163 return atomic_read(&inode->i_writecount) > 0;
3164 }
3165
3166 #if defined(CONFIG_IMA) || defined(CONFIG_FILE_LOCKING)
i_readcount_dec(struct inode * inode)3167 static inline void i_readcount_dec(struct inode *inode)
3168 {
3169 BUG_ON(atomic_dec_return(&inode->i_readcount) < 0);
3170 }
i_readcount_inc(struct inode * inode)3171 static inline void i_readcount_inc(struct inode *inode)
3172 {
3173 atomic_inc(&inode->i_readcount);
3174 }
3175 #else
i_readcount_dec(struct inode * inode)3176 static inline void i_readcount_dec(struct inode *inode)
3177 {
3178 return;
3179 }
i_readcount_inc(struct inode * inode)3180 static inline void i_readcount_inc(struct inode *inode)
3181 {
3182 return;
3183 }
3184 #endif
3185 extern int do_pipe_flags(int *, int);
3186
3187 extern ssize_t kernel_read(struct file *, void *, size_t, loff_t *);
3188 ssize_t __kernel_read(struct file *file, void *buf, size_t count, loff_t *pos);
3189 extern ssize_t kernel_write(struct file *, const void *, size_t, loff_t *);
3190 extern ssize_t __kernel_write(struct file *, const void *, size_t, loff_t *);
3191 extern struct file * open_exec(const char *);
3192
3193 /* fs/dcache.c -- generic fs support functions */
3194 extern bool is_subdir(struct dentry *, struct dentry *);
3195 extern bool path_is_under(const struct path *, const struct path *);
3196
3197 extern char *file_path(struct file *, char *, int);
3198
3199 /**
3200 * is_dot_dotdot - returns true only if @name is "." or ".."
3201 * @name: file name to check
3202 * @len: length of file name, in bytes
3203 */
is_dot_dotdot(const char * name,size_t len)3204 static inline bool is_dot_dotdot(const char *name, size_t len)
3205 {
3206 return len && unlikely(name[0] == '.') &&
3207 (len == 1 || (len == 2 && name[1] == '.'));
3208 }
3209
3210 #include <linux/err.h>
3211
3212 /* needed for stackable file system support */
3213 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
3214
3215 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
3216
3217 extern int inode_init_always_gfp(struct super_block *, struct inode *, gfp_t);
inode_init_always(struct super_block * sb,struct inode * inode)3218 static inline int inode_init_always(struct super_block *sb, struct inode *inode)
3219 {
3220 return inode_init_always_gfp(sb, inode, GFP_NOFS);
3221 }
3222
3223 extern void inode_init_once(struct inode *);
3224 extern void address_space_init_once(struct address_space *mapping);
3225 extern struct inode * igrab(struct inode *);
3226 extern ino_t iunique(struct super_block *, ino_t);
3227 extern int inode_needs_sync(struct inode *inode);
3228 extern int generic_delete_inode(struct inode *inode);
generic_drop_inode(struct inode * inode)3229 static inline int generic_drop_inode(struct inode *inode)
3230 {
3231 return !inode->i_nlink || inode_unhashed(inode);
3232 }
3233 extern void d_mark_dontcache(struct inode *inode);
3234
3235 extern struct inode *ilookup5_nowait(struct super_block *sb,
3236 unsigned long hashval, int (*test)(struct inode *, void *),
3237 void *data);
3238 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
3239 int (*test)(struct inode *, void *), void *data);
3240 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
3241
3242 extern struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
3243 int (*test)(struct inode *, void *),
3244 int (*set)(struct inode *, void *),
3245 void *data);
3246 struct inode *iget5_locked(struct super_block *, unsigned long,
3247 int (*test)(struct inode *, void *),
3248 int (*set)(struct inode *, void *), void *);
3249 struct inode *iget5_locked_rcu(struct super_block *, unsigned long,
3250 int (*test)(struct inode *, void *),
3251 int (*set)(struct inode *, void *), void *);
3252 extern struct inode * iget_locked(struct super_block *, unsigned long);
3253 extern struct inode *find_inode_nowait(struct super_block *,
3254 unsigned long,
3255 int (*match)(struct inode *,
3256 unsigned long, void *),
3257 void *data);
3258 extern struct inode *find_inode_rcu(struct super_block *, unsigned long,
3259 int (*)(struct inode *, void *), void *);
3260 extern struct inode *find_inode_by_ino_rcu(struct super_block *, unsigned long);
3261 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
3262 extern int insert_inode_locked(struct inode *);
3263 #ifdef CONFIG_DEBUG_LOCK_ALLOC
3264 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
3265 #else
lockdep_annotate_inode_mutex_key(struct inode * inode)3266 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
3267 #endif
3268 extern void unlock_new_inode(struct inode *);
3269 extern void discard_new_inode(struct inode *);
3270 extern unsigned int get_next_ino(void);
3271 extern void evict_inodes(struct super_block *sb);
3272 void dump_mapping(const struct address_space *);
3273
3274 /*
3275 * Userspace may rely on the inode number being non-zero. For example, glibc
3276 * simply ignores files with zero i_ino in unlink() and other places.
3277 *
3278 * As an additional complication, if userspace was compiled with
3279 * _FILE_OFFSET_BITS=32 on a 64-bit kernel we'll only end up reading out the
3280 * lower 32 bits, so we need to check that those aren't zero explicitly. With
3281 * _FILE_OFFSET_BITS=64, this may cause some harmless false-negatives, but
3282 * better safe than sorry.
3283 */
is_zero_ino(ino_t ino)3284 static inline bool is_zero_ino(ino_t ino)
3285 {
3286 return (u32)ino == 0;
3287 }
3288
3289 /*
3290 * inode->i_lock must be held
3291 */
__iget(struct inode * inode)3292 static inline void __iget(struct inode *inode)
3293 {
3294 atomic_inc(&inode->i_count);
3295 }
3296
3297 extern void iget_failed(struct inode *);
3298 extern void clear_inode(struct inode *);
3299 extern void __destroy_inode(struct inode *);
3300 extern struct inode *new_inode_pseudo(struct super_block *sb);
3301 extern struct inode *new_inode(struct super_block *sb);
3302 extern void free_inode_nonrcu(struct inode *inode);
3303 extern int setattr_should_drop_suidgid(struct mnt_idmap *, struct inode *);
3304 extern int file_remove_privs_flags(struct file *file, unsigned int flags);
3305 extern int file_remove_privs(struct file *);
3306 int setattr_should_drop_sgid(struct mnt_idmap *idmap,
3307 const struct inode *inode);
3308
3309 /*
3310 * This must be used for allocating filesystems specific inodes to set
3311 * up the inode reclaim context correctly.
3312 */
3313 #define alloc_inode_sb(_sb, _cache, _gfp) kmem_cache_alloc_lru(_cache, &_sb->s_inode_lru, _gfp)
3314
3315 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
insert_inode_hash(struct inode * inode)3316 static inline void insert_inode_hash(struct inode *inode)
3317 {
3318 __insert_inode_hash(inode, inode->i_ino);
3319 }
3320
3321 extern void __remove_inode_hash(struct inode *);
remove_inode_hash(struct inode * inode)3322 static inline void remove_inode_hash(struct inode *inode)
3323 {
3324 if (!inode_unhashed(inode) && !hlist_fake(&inode->i_hash))
3325 __remove_inode_hash(inode);
3326 }
3327
3328 extern void inode_sb_list_add(struct inode *inode);
3329 extern void inode_add_lru(struct inode *inode);
3330
3331 extern int sb_set_blocksize(struct super_block *, int);
3332 extern int sb_min_blocksize(struct super_block *, int);
3333
3334 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
3335 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
3336 extern ssize_t generic_write_checks(struct kiocb *, struct iov_iter *);
3337 int generic_write_checks_count(struct kiocb *iocb, loff_t *count);
3338 extern int generic_write_check_limits(struct file *file, loff_t pos,
3339 loff_t *count);
3340 extern int generic_file_rw_checks(struct file *file_in, struct file *file_out);
3341 ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *to,
3342 ssize_t already_read);
3343 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
3344 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
3345 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
3346 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *);
3347 ssize_t generic_perform_write(struct kiocb *, struct iov_iter *);
3348 ssize_t direct_write_fallback(struct kiocb *iocb, struct iov_iter *iter,
3349 ssize_t direct_written, ssize_t buffered_written);
3350
3351 ssize_t vfs_iter_read(struct file *file, struct iov_iter *iter, loff_t *ppos,
3352 rwf_t flags);
3353 ssize_t vfs_iter_write(struct file *file, struct iov_iter *iter, loff_t *ppos,
3354 rwf_t flags);
3355 ssize_t vfs_iocb_iter_read(struct file *file, struct kiocb *iocb,
3356 struct iov_iter *iter);
3357 ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb,
3358 struct iov_iter *iter);
3359
3360 /* fs/splice.c */
3361 ssize_t filemap_splice_read(struct file *in, loff_t *ppos,
3362 struct pipe_inode_info *pipe,
3363 size_t len, unsigned int flags);
3364 ssize_t copy_splice_read(struct file *in, loff_t *ppos,
3365 struct pipe_inode_info *pipe,
3366 size_t len, unsigned int flags);
3367 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
3368 struct file *, loff_t *, size_t, unsigned int);
3369
3370
3371 extern void
3372 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
3373 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
3374 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
3375 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
3376 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
3377 int whence, loff_t maxsize, loff_t eof);
3378 loff_t generic_llseek_cookie(struct file *file, loff_t offset, int whence,
3379 u64 *cookie);
3380 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
3381 int whence, loff_t size);
3382 extern loff_t no_seek_end_llseek_size(struct file *, loff_t, int, loff_t);
3383 extern loff_t no_seek_end_llseek(struct file *, loff_t, int);
3384 int rw_verify_area(int, struct file *, const loff_t *, size_t);
3385 extern int generic_file_open(struct inode * inode, struct file * filp);
3386 extern int nonseekable_open(struct inode * inode, struct file * filp);
3387 extern int stream_open(struct inode * inode, struct file * filp);
3388
3389 #ifdef CONFIG_BLOCK
3390 typedef void (dio_submit_t)(struct bio *bio, struct inode *inode,
3391 loff_t file_offset);
3392
3393 enum {
3394 /* need locking between buffered and direct access */
3395 DIO_LOCKING = 0x01,
3396
3397 /* filesystem does not support filling holes */
3398 DIO_SKIP_HOLES = 0x02,
3399 };
3400
3401 ssize_t __blockdev_direct_IO(struct kiocb *iocb, struct inode *inode,
3402 struct block_device *bdev, struct iov_iter *iter,
3403 get_block_t get_block,
3404 dio_iodone_t end_io,
3405 int flags);
3406
blockdev_direct_IO(struct kiocb * iocb,struct inode * inode,struct iov_iter * iter,get_block_t get_block)3407 static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
3408 struct inode *inode,
3409 struct iov_iter *iter,
3410 get_block_t get_block)
3411 {
3412 return __blockdev_direct_IO(iocb, inode, inode->i_sb->s_bdev, iter,
3413 get_block, NULL, DIO_LOCKING | DIO_SKIP_HOLES);
3414 }
3415 #endif
3416
3417 bool inode_dio_finished(const struct inode *inode);
3418 void inode_dio_wait(struct inode *inode);
3419 void inode_dio_wait_interruptible(struct inode *inode);
3420
3421 /**
3422 * inode_dio_begin - signal start of a direct I/O requests
3423 * @inode: inode the direct I/O happens on
3424 *
3425 * This is called once we've finished processing a direct I/O request,
3426 * and is used to wake up callers waiting for direct I/O to be quiesced.
3427 */
inode_dio_begin(struct inode * inode)3428 static inline void inode_dio_begin(struct inode *inode)
3429 {
3430 atomic_inc(&inode->i_dio_count);
3431 }
3432
3433 /**
3434 * inode_dio_end - signal finish of a direct I/O requests
3435 * @inode: inode the direct I/O happens on
3436 *
3437 * This is called once we've finished processing a direct I/O request,
3438 * and is used to wake up callers waiting for direct I/O to be quiesced.
3439 */
inode_dio_end(struct inode * inode)3440 static inline void inode_dio_end(struct inode *inode)
3441 {
3442 if (atomic_dec_and_test(&inode->i_dio_count))
3443 wake_up_var(&inode->i_dio_count);
3444 }
3445
3446 extern void inode_set_flags(struct inode *inode, unsigned int flags,
3447 unsigned int mask);
3448
3449 extern const struct file_operations generic_ro_fops;
3450
3451 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
3452
3453 extern int readlink_copy(char __user *, int, const char *, int);
3454 extern int page_readlink(struct dentry *, char __user *, int);
3455 extern const char *page_get_link_raw(struct dentry *, struct inode *,
3456 struct delayed_call *);
3457 extern const char *page_get_link(struct dentry *, struct inode *,
3458 struct delayed_call *);
3459 extern void page_put_link(void *);
3460 extern int page_symlink(struct inode *inode, const char *symname, int len);
3461 extern const struct inode_operations page_symlink_inode_operations;
3462 extern void kfree_link(void *);
3463 void fill_mg_cmtime(struct kstat *stat, u32 request_mask, struct inode *inode);
3464 void generic_fillattr(struct mnt_idmap *, u32, struct inode *, struct kstat *);
3465 void generic_fill_statx_attr(struct inode *inode, struct kstat *stat);
3466 void generic_fill_statx_atomic_writes(struct kstat *stat,
3467 unsigned int unit_min,
3468 unsigned int unit_max);
3469 extern int vfs_getattr_nosec(const struct path *, struct kstat *, u32, unsigned int);
3470 extern int vfs_getattr(const struct path *, struct kstat *, u32, unsigned int);
3471 void __inode_add_bytes(struct inode *inode, loff_t bytes);
3472 void inode_add_bytes(struct inode *inode, loff_t bytes);
3473 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
3474 void inode_sub_bytes(struct inode *inode, loff_t bytes);
__inode_get_bytes(struct inode * inode)3475 static inline loff_t __inode_get_bytes(struct inode *inode)
3476 {
3477 return (((loff_t)inode->i_blocks) << 9) + inode->i_bytes;
3478 }
3479 loff_t inode_get_bytes(struct inode *inode);
3480 void inode_set_bytes(struct inode *inode, loff_t bytes);
3481 const char *simple_get_link(struct dentry *, struct inode *,
3482 struct delayed_call *);
3483 extern const struct inode_operations simple_symlink_inode_operations;
3484
3485 extern int iterate_dir(struct file *, struct dir_context *);
3486
3487 int vfs_fstatat(int dfd, const char __user *filename, struct kstat *stat,
3488 int flags);
3489 int vfs_fstat(int fd, struct kstat *stat);
3490
vfs_stat(const char __user * filename,struct kstat * stat)3491 static inline int vfs_stat(const char __user *filename, struct kstat *stat)
3492 {
3493 return vfs_fstatat(AT_FDCWD, filename, stat, 0);
3494 }
vfs_lstat(const char __user * name,struct kstat * stat)3495 static inline int vfs_lstat(const char __user *name, struct kstat *stat)
3496 {
3497 return vfs_fstatat(AT_FDCWD, name, stat, AT_SYMLINK_NOFOLLOW);
3498 }
3499
3500 extern const char *vfs_get_link(struct dentry *, struct delayed_call *);
3501 extern int vfs_readlink(struct dentry *, char __user *, int);
3502
3503 extern struct file_system_type *get_filesystem(struct file_system_type *fs);
3504 extern void put_filesystem(struct file_system_type *fs);
3505 extern struct file_system_type *get_fs_type(const char *name);
3506 extern void drop_super(struct super_block *sb);
3507 extern void drop_super_exclusive(struct super_block *sb);
3508 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
3509 extern void iterate_supers_type(struct file_system_type *,
3510 void (*)(struct super_block *, void *), void *);
3511
3512 extern int dcache_dir_open(struct inode *, struct file *);
3513 extern int dcache_dir_close(struct inode *, struct file *);
3514 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
3515 extern int dcache_readdir(struct file *, struct dir_context *);
3516 extern int simple_setattr(struct mnt_idmap *, struct dentry *,
3517 struct iattr *);
3518 extern int simple_getattr(struct mnt_idmap *, const struct path *,
3519 struct kstat *, u32, unsigned int);
3520 extern int simple_statfs(struct dentry *, struct kstatfs *);
3521 extern int simple_open(struct inode *inode, struct file *file);
3522 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
3523 extern int simple_unlink(struct inode *, struct dentry *);
3524 extern int simple_rmdir(struct inode *, struct dentry *);
3525 void simple_rename_timestamp(struct inode *old_dir, struct dentry *old_dentry,
3526 struct inode *new_dir, struct dentry *new_dentry);
3527 extern int simple_rename_exchange(struct inode *old_dir, struct dentry *old_dentry,
3528 struct inode *new_dir, struct dentry *new_dentry);
3529 extern int simple_rename(struct mnt_idmap *, struct inode *,
3530 struct dentry *, struct inode *, struct dentry *,
3531 unsigned int);
3532 extern void simple_recursive_removal(struct dentry *,
3533 void (*callback)(struct dentry *));
3534 extern int noop_fsync(struct file *, loff_t, loff_t, int);
3535 extern ssize_t noop_direct_IO(struct kiocb *iocb, struct iov_iter *iter);
3536 extern int simple_empty(struct dentry *);
3537 extern int simple_write_begin(struct file *file, struct address_space *mapping,
3538 loff_t pos, unsigned len,
3539 struct folio **foliop, void **fsdata);
3540 extern const struct address_space_operations ram_aops;
3541 extern int always_delete_dentry(const struct dentry *);
3542 extern struct inode *alloc_anon_inode(struct super_block *);
3543 extern int simple_nosetlease(struct file *, int, struct file_lease **, void **);
3544 extern const struct dentry_operations simple_dentry_operations;
3545
3546 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
3547 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
3548 extern const struct file_operations simple_dir_operations;
3549 extern const struct inode_operations simple_dir_inode_operations;
3550 extern void make_empty_dir_inode(struct inode *inode);
3551 extern bool is_empty_dir_inode(struct inode *inode);
3552 struct tree_descr { const char *name; const struct file_operations *ops; int mode; };
3553 struct dentry *d_alloc_name(struct dentry *, const char *);
3554 extern int simple_fill_super(struct super_block *, unsigned long,
3555 const struct tree_descr *);
3556 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
3557 extern void simple_release_fs(struct vfsmount **mount, int *count);
3558
3559 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
3560 loff_t *ppos, const void *from, size_t available);
3561 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
3562 const void __user *from, size_t count);
3563
3564 struct offset_ctx {
3565 struct maple_tree mt;
3566 unsigned long next_offset;
3567 };
3568
3569 void simple_offset_init(struct offset_ctx *octx);
3570 int simple_offset_add(struct offset_ctx *octx, struct dentry *dentry);
3571 void simple_offset_remove(struct offset_ctx *octx, struct dentry *dentry);
3572 int simple_offset_rename(struct inode *old_dir, struct dentry *old_dentry,
3573 struct inode *new_dir, struct dentry *new_dentry);
3574 int simple_offset_rename_exchange(struct inode *old_dir,
3575 struct dentry *old_dentry,
3576 struct inode *new_dir,
3577 struct dentry *new_dentry);
3578 void simple_offset_destroy(struct offset_ctx *octx);
3579
3580 extern const struct file_operations simple_offset_dir_operations;
3581
3582 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
3583 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
3584
3585 extern int generic_check_addressable(unsigned, u64);
3586
3587 extern void generic_set_sb_d_ops(struct super_block *sb);
3588 extern int generic_ci_match(const struct inode *parent,
3589 const struct qstr *name,
3590 const struct qstr *folded_name,
3591 const u8 *de_name, u32 de_name_len);
3592
3593 #if IS_ENABLED(CONFIG_UNICODE)
3594 int generic_ci_d_hash(const struct dentry *dentry, struct qstr *str);
3595 int generic_ci_d_compare(const struct dentry *dentry, unsigned int len,
3596 const char *str, const struct qstr *name);
3597
3598 /**
3599 * generic_ci_validate_strict_name - Check if a given name is suitable
3600 * for a directory
3601 *
3602 * This functions checks if the proposed filename is valid for the
3603 * parent directory. That means that only valid UTF-8 filenames will be
3604 * accepted for casefold directories from filesystems created with the
3605 * strict encoding flag. That also means that any name will be
3606 * accepted for directories that doesn't have casefold enabled, or
3607 * aren't being strict with the encoding.
3608 *
3609 * @dir: inode of the directory where the new file will be created
3610 * @name: name of the new file
3611 *
3612 * Return:
3613 * * True: if the filename is suitable for this directory. It can be
3614 * true if a given name is not suitable for a strict encoding
3615 * directory, but the directory being used isn't strict
3616 * * False if the filename isn't suitable for this directory. This only
3617 * happens when a directory is casefolded and the filesystem is strict
3618 * about its encoding.
3619 */
generic_ci_validate_strict_name(struct inode * dir,struct qstr * name)3620 static inline bool generic_ci_validate_strict_name(struct inode *dir, struct qstr *name)
3621 {
3622 if (!IS_CASEFOLDED(dir) || !sb_has_strict_encoding(dir->i_sb))
3623 return true;
3624
3625 /*
3626 * A casefold dir must have a encoding set, unless the filesystem
3627 * is corrupted
3628 */
3629 if (WARN_ON_ONCE(!dir->i_sb->s_encoding))
3630 return true;
3631
3632 return !utf8_validate(dir->i_sb->s_encoding, name);
3633 }
3634 #else
generic_ci_validate_strict_name(struct inode * dir,struct qstr * name)3635 static inline bool generic_ci_validate_strict_name(struct inode *dir, struct qstr *name)
3636 {
3637 return true;
3638 }
3639 #endif
3640
sb_has_encoding(const struct super_block * sb)3641 static inline bool sb_has_encoding(const struct super_block *sb)
3642 {
3643 #if IS_ENABLED(CONFIG_UNICODE)
3644 return !!sb->s_encoding;
3645 #else
3646 return false;
3647 #endif
3648 }
3649
3650 int may_setattr(struct mnt_idmap *idmap, struct inode *inode,
3651 unsigned int ia_valid);
3652 int setattr_prepare(struct mnt_idmap *, struct dentry *, struct iattr *);
3653 extern int inode_newsize_ok(const struct inode *, loff_t offset);
3654 void setattr_copy(struct mnt_idmap *, struct inode *inode,
3655 const struct iattr *attr);
3656
3657 extern int file_update_time(struct file *file);
3658
vma_is_dax(const struct vm_area_struct * vma)3659 static inline bool vma_is_dax(const struct vm_area_struct *vma)
3660 {
3661 return vma->vm_file && IS_DAX(vma->vm_file->f_mapping->host);
3662 }
3663
vma_is_fsdax(struct vm_area_struct * vma)3664 static inline bool vma_is_fsdax(struct vm_area_struct *vma)
3665 {
3666 struct inode *inode;
3667
3668 if (!IS_ENABLED(CONFIG_FS_DAX) || !vma->vm_file)
3669 return false;
3670 if (!vma_is_dax(vma))
3671 return false;
3672 inode = file_inode(vma->vm_file);
3673 if (S_ISCHR(inode->i_mode))
3674 return false; /* device-dax */
3675 return true;
3676 }
3677
iocb_flags(struct file * file)3678 static inline int iocb_flags(struct file *file)
3679 {
3680 int res = 0;
3681 if (file->f_flags & O_APPEND)
3682 res |= IOCB_APPEND;
3683 if (file->f_flags & O_DIRECT)
3684 res |= IOCB_DIRECT;
3685 if (file->f_flags & O_DSYNC)
3686 res |= IOCB_DSYNC;
3687 if (file->f_flags & __O_SYNC)
3688 res |= IOCB_SYNC;
3689 return res;
3690 }
3691
kiocb_set_rw_flags(struct kiocb * ki,rwf_t flags,int rw_type)3692 static inline int kiocb_set_rw_flags(struct kiocb *ki, rwf_t flags,
3693 int rw_type)
3694 {
3695 int kiocb_flags = 0;
3696
3697 /* make sure there's no overlap between RWF and private IOCB flags */
3698 BUILD_BUG_ON((__force int) RWF_SUPPORTED & IOCB_EVENTFD);
3699
3700 if (!flags)
3701 return 0;
3702 if (unlikely(flags & ~RWF_SUPPORTED))
3703 return -EOPNOTSUPP;
3704 if (unlikely((flags & RWF_APPEND) && (flags & RWF_NOAPPEND)))
3705 return -EINVAL;
3706
3707 if (flags & RWF_NOWAIT) {
3708 if (!(ki->ki_filp->f_mode & FMODE_NOWAIT))
3709 return -EOPNOTSUPP;
3710 }
3711 if (flags & RWF_ATOMIC) {
3712 if (rw_type != WRITE)
3713 return -EOPNOTSUPP;
3714 if (!(ki->ki_filp->f_mode & FMODE_CAN_ATOMIC_WRITE))
3715 return -EOPNOTSUPP;
3716 }
3717 if (flags & RWF_DONTCACHE) {
3718 /* file system must support it */
3719 if (!(ki->ki_filp->f_op->fop_flags & FOP_DONTCACHE))
3720 return -EOPNOTSUPP;
3721 /* DAX mappings not supported */
3722 if (IS_DAX(ki->ki_filp->f_mapping->host))
3723 return -EOPNOTSUPP;
3724 }
3725 kiocb_flags |= (__force int) (flags & RWF_SUPPORTED);
3726 if (flags & RWF_SYNC)
3727 kiocb_flags |= IOCB_DSYNC;
3728
3729 if ((flags & RWF_NOAPPEND) && (ki->ki_flags & IOCB_APPEND)) {
3730 if (IS_APPEND(file_inode(ki->ki_filp)))
3731 return -EPERM;
3732 ki->ki_flags &= ~IOCB_APPEND;
3733 }
3734
3735 ki->ki_flags |= kiocb_flags;
3736 return 0;
3737 }
3738
3739 /* Transaction based IO helpers */
3740
3741 /*
3742 * An argresp is stored in an allocated page and holds the
3743 * size of the argument or response, along with its content
3744 */
3745 struct simple_transaction_argresp {
3746 ssize_t size;
3747 char data[];
3748 };
3749
3750 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
3751
3752 char *simple_transaction_get(struct file *file, const char __user *buf,
3753 size_t size);
3754 ssize_t simple_transaction_read(struct file *file, char __user *buf,
3755 size_t size, loff_t *pos);
3756 int simple_transaction_release(struct inode *inode, struct file *file);
3757
3758 void simple_transaction_set(struct file *file, size_t n);
3759
3760 /*
3761 * simple attribute files
3762 *
3763 * These attributes behave similar to those in sysfs:
3764 *
3765 * Writing to an attribute immediately sets a value, an open file can be
3766 * written to multiple times.
3767 *
3768 * Reading from an attribute creates a buffer from the value that might get
3769 * read with multiple read calls. When the attribute has been read
3770 * completely, no further read calls are possible until the file is opened
3771 * again.
3772 *
3773 * All attributes contain a text representation of a numeric value
3774 * that are accessed with the get() and set() functions.
3775 */
3776 #define DEFINE_SIMPLE_ATTRIBUTE_XSIGNED(__fops, __get, __set, __fmt, __is_signed) \
3777 static int __fops ## _open(struct inode *inode, struct file *file) \
3778 { \
3779 __simple_attr_check_format(__fmt, 0ull); \
3780 return simple_attr_open(inode, file, __get, __set, __fmt); \
3781 } \
3782 static const struct file_operations __fops = { \
3783 .owner = THIS_MODULE, \
3784 .open = __fops ## _open, \
3785 .release = simple_attr_release, \
3786 .read = simple_attr_read, \
3787 .write = (__is_signed) ? simple_attr_write_signed : simple_attr_write, \
3788 .llseek = generic_file_llseek, \
3789 }
3790
3791 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
3792 DEFINE_SIMPLE_ATTRIBUTE_XSIGNED(__fops, __get, __set, __fmt, false)
3793
3794 #define DEFINE_SIMPLE_ATTRIBUTE_SIGNED(__fops, __get, __set, __fmt) \
3795 DEFINE_SIMPLE_ATTRIBUTE_XSIGNED(__fops, __get, __set, __fmt, true)
3796
3797 static inline __printf(1, 2)
__simple_attr_check_format(const char * fmt,...)3798 void __simple_attr_check_format(const char *fmt, ...)
3799 {
3800 /* don't do anything, just let the compiler check the arguments; */
3801 }
3802
3803 int simple_attr_open(struct inode *inode, struct file *file,
3804 int (*get)(void *, u64 *), int (*set)(void *, u64),
3805 const char *fmt);
3806 int simple_attr_release(struct inode *inode, struct file *file);
3807 ssize_t simple_attr_read(struct file *file, char __user *buf,
3808 size_t len, loff_t *ppos);
3809 ssize_t simple_attr_write(struct file *file, const char __user *buf,
3810 size_t len, loff_t *ppos);
3811 ssize_t simple_attr_write_signed(struct file *file, const char __user *buf,
3812 size_t len, loff_t *ppos);
3813
3814 struct ctl_table;
3815 int __init list_bdev_fs_names(char *buf, size_t size);
3816
3817 #define __FMODE_EXEC ((__force int) FMODE_EXEC)
3818
3819 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
3820 #define OPEN_FMODE(flag) ((__force fmode_t)((flag + 1) & O_ACCMODE))
3821
is_sxid(umode_t mode)3822 static inline bool is_sxid(umode_t mode)
3823 {
3824 return mode & (S_ISUID | S_ISGID);
3825 }
3826
check_sticky(struct mnt_idmap * idmap,struct inode * dir,struct inode * inode)3827 static inline int check_sticky(struct mnt_idmap *idmap,
3828 struct inode *dir, struct inode *inode)
3829 {
3830 if (!(dir->i_mode & S_ISVTX))
3831 return 0;
3832
3833 return __check_sticky(idmap, dir, inode);
3834 }
3835
inode_has_no_xattr(struct inode * inode)3836 static inline void inode_has_no_xattr(struct inode *inode)
3837 {
3838 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & SB_NOSEC))
3839 inode->i_flags |= S_NOSEC;
3840 }
3841
is_root_inode(struct inode * inode)3842 static inline bool is_root_inode(struct inode *inode)
3843 {
3844 return inode == inode->i_sb->s_root->d_inode;
3845 }
3846
dir_emit(struct dir_context * ctx,const char * name,int namelen,u64 ino,unsigned type)3847 static inline bool dir_emit(struct dir_context *ctx,
3848 const char *name, int namelen,
3849 u64 ino, unsigned type)
3850 {
3851 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type);
3852 }
dir_emit_dot(struct file * file,struct dir_context * ctx)3853 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
3854 {
3855 return ctx->actor(ctx, ".", 1, ctx->pos,
3856 file->f_path.dentry->d_inode->i_ino, DT_DIR);
3857 }
dir_emit_dotdot(struct file * file,struct dir_context * ctx)3858 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
3859 {
3860 return ctx->actor(ctx, "..", 2, ctx->pos,
3861 d_parent_ino(file->f_path.dentry), DT_DIR);
3862 }
dir_emit_dots(struct file * file,struct dir_context * ctx)3863 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
3864 {
3865 if (ctx->pos == 0) {
3866 if (!dir_emit_dot(file, ctx))
3867 return false;
3868 ctx->pos = 1;
3869 }
3870 if (ctx->pos == 1) {
3871 if (!dir_emit_dotdot(file, ctx))
3872 return false;
3873 ctx->pos = 2;
3874 }
3875 return true;
3876 }
dir_relax(struct inode * inode)3877 static inline bool dir_relax(struct inode *inode)
3878 {
3879 inode_unlock(inode);
3880 inode_lock(inode);
3881 return !IS_DEADDIR(inode);
3882 }
3883
dir_relax_shared(struct inode * inode)3884 static inline bool dir_relax_shared(struct inode *inode)
3885 {
3886 inode_unlock_shared(inode);
3887 inode_lock_shared(inode);
3888 return !IS_DEADDIR(inode);
3889 }
3890
3891 extern bool path_noexec(const struct path *path);
3892 extern void inode_nohighmem(struct inode *inode);
3893
3894 /* mm/fadvise.c */
3895 extern int vfs_fadvise(struct file *file, loff_t offset, loff_t len,
3896 int advice);
3897 extern int generic_fadvise(struct file *file, loff_t offset, loff_t len,
3898 int advice);
3899
vfs_empty_path(int dfd,const char __user * path)3900 static inline bool vfs_empty_path(int dfd, const char __user *path)
3901 {
3902 char c;
3903
3904 if (dfd < 0)
3905 return false;
3906
3907 /* We now allow NULL to be used for empty path. */
3908 if (!path)
3909 return true;
3910
3911 if (unlikely(get_user(c, path)))
3912 return false;
3913
3914 return !c;
3915 }
3916
3917 int generic_atomic_write_valid(struct kiocb *iocb, struct iov_iter *iter);
3918
3919 #endif /* _LINUX_FS_H */
3920