locks: add a new struct file_locking_context pointer to struct inode
[deliverable/linux.git] / include / linux / fs.h
1 #ifndef _LINUX_FS_H
2 #define _LINUX_FS_H
3
4
5 #include <linux/linkage.h>
6 #include <linux/wait.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/rbtree.h>
17 #include <linux/init.h>
18 #include <linux/pid.h>
19 #include <linux/bug.h>
20 #include <linux/mutex.h>
21 #include <linux/rwsem.h>
22 #include <linux/capability.h>
23 #include <linux/semaphore.h>
24 #include <linux/fiemap.h>
25 #include <linux/rculist_bl.h>
26 #include <linux/atomic.h>
27 #include <linux/shrinker.h>
28 #include <linux/migrate_mode.h>
29 #include <linux/uidgid.h>
30 #include <linux/lockdep.h>
31 #include <linux/percpu-rwsem.h>
32 #include <linux/blk_types.h>
33
34 #include <asm/byteorder.h>
35 #include <uapi/linux/fs.h>
36
37 struct export_operations;
38 struct hd_geometry;
39 struct iovec;
40 struct nameidata;
41 struct kiocb;
42 struct kobject;
43 struct pipe_inode_info;
44 struct poll_table_struct;
45 struct kstatfs;
46 struct vm_area_struct;
47 struct vfsmount;
48 struct cred;
49 struct swap_info_struct;
50 struct seq_file;
51 struct workqueue_struct;
52 struct iov_iter;
53
54 extern void __init inode_init(void);
55 extern void __init inode_init_early(void);
56 extern void __init files_init(unsigned long);
57
58 extern struct files_stat_struct files_stat;
59 extern unsigned long get_max_files(void);
60 extern int sysctl_nr_open;
61 extern struct inodes_stat_t inodes_stat;
62 extern int leases_enable, lease_break_time;
63 extern int sysctl_protected_symlinks;
64 extern int sysctl_protected_hardlinks;
65
66 struct buffer_head;
67 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
68 struct buffer_head *bh_result, int create);
69 typedef void (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
70 ssize_t bytes, void *private);
71
72 #define MAY_EXEC 0x00000001
73 #define MAY_WRITE 0x00000002
74 #define MAY_READ 0x00000004
75 #define MAY_APPEND 0x00000008
76 #define MAY_ACCESS 0x00000010
77 #define MAY_OPEN 0x00000020
78 #define MAY_CHDIR 0x00000040
79 /* called from RCU mode, don't block */
80 #define MAY_NOT_BLOCK 0x00000080
81
82 /*
83 * flags in file.f_mode. Note that FMODE_READ and FMODE_WRITE must correspond
84 * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
85 */
86
87 /* file is open for reading */
88 #define FMODE_READ ((__force fmode_t)0x1)
89 /* file is open for writing */
90 #define FMODE_WRITE ((__force fmode_t)0x2)
91 /* file is seekable */
92 #define FMODE_LSEEK ((__force fmode_t)0x4)
93 /* file can be accessed using pread */
94 #define FMODE_PREAD ((__force fmode_t)0x8)
95 /* file can be accessed using pwrite */
96 #define FMODE_PWRITE ((__force fmode_t)0x10)
97 /* File is opened for execution with sys_execve / sys_uselib */
98 #define FMODE_EXEC ((__force fmode_t)0x20)
99 /* File is opened with O_NDELAY (only set for block devices) */
100 #define FMODE_NDELAY ((__force fmode_t)0x40)
101 /* File is opened with O_EXCL (only set for block devices) */
102 #define FMODE_EXCL ((__force fmode_t)0x80)
103 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
104 (specialy hack for floppy.c) */
105 #define FMODE_WRITE_IOCTL ((__force fmode_t)0x100)
106 /* 32bit hashes as llseek() offset (for directories) */
107 #define FMODE_32BITHASH ((__force fmode_t)0x200)
108 /* 64bit hashes as llseek() offset (for directories) */
109 #define FMODE_64BITHASH ((__force fmode_t)0x400)
110
111 /*
112 * Don't update ctime and mtime.
113 *
114 * Currently a special hack for the XFS open_by_handle ioctl, but we'll
115 * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
116 */
117 #define FMODE_NOCMTIME ((__force fmode_t)0x800)
118
119 /* Expect random access pattern */
120 #define FMODE_RANDOM ((__force fmode_t)0x1000)
121
122 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
123 #define FMODE_UNSIGNED_OFFSET ((__force fmode_t)0x2000)
124
125 /* File is opened with O_PATH; almost nothing can be done with it */
126 #define FMODE_PATH ((__force fmode_t)0x4000)
127
128 /* File needs atomic accesses to f_pos */
129 #define FMODE_ATOMIC_POS ((__force fmode_t)0x8000)
130 /* Write access to underlying fs */
131 #define FMODE_WRITER ((__force fmode_t)0x10000)
132 /* Has read method(s) */
133 #define FMODE_CAN_READ ((__force fmode_t)0x20000)
134 /* Has write method(s) */
135 #define FMODE_CAN_WRITE ((__force fmode_t)0x40000)
136
137 /* File was opened by fanotify and shouldn't generate fanotify events */
138 #define FMODE_NONOTIFY ((__force fmode_t)0x4000000)
139
140 /*
141 * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
142 * that indicates that they should check the contents of the iovec are
143 * valid, but not check the memory that the iovec elements
144 * points too.
145 */
146 #define CHECK_IOVEC_ONLY -1
147
148 /*
149 * The below are the various read and write types that we support. Some of
150 * them include behavioral modifiers that send information down to the
151 * block layer and IO scheduler. Terminology:
152 *
153 * The block layer uses device plugging to defer IO a little bit, in
154 * the hope that we will see more IO very shortly. This increases
155 * coalescing of adjacent IO and thus reduces the number of IOs we
156 * have to send to the device. It also allows for better queuing,
157 * if the IO isn't mergeable. If the caller is going to be waiting
158 * for the IO, then he must ensure that the device is unplugged so
159 * that the IO is dispatched to the driver.
160 *
161 * All IO is handled async in Linux. This is fine for background
162 * writes, but for reads or writes that someone waits for completion
163 * on, we want to notify the block layer and IO scheduler so that they
164 * know about it. That allows them to make better scheduling
165 * decisions. So when the below references 'sync' and 'async', it
166 * is referencing this priority hint.
167 *
168 * With that in mind, the available types are:
169 *
170 * READ A normal read operation. Device will be plugged.
171 * READ_SYNC A synchronous read. Device is not plugged, caller can
172 * immediately wait on this read without caring about
173 * unplugging.
174 * READA Used for read-ahead operations. Lower priority, and the
175 * block layer could (in theory) choose to ignore this
176 * request if it runs into resource problems.
177 * WRITE A normal async write. Device will be plugged.
178 * WRITE_SYNC Synchronous write. Identical to WRITE, but passes down
179 * the hint that someone will be waiting on this IO
180 * shortly. The write equivalent of READ_SYNC.
181 * WRITE_ODIRECT Special case write for O_DIRECT only.
182 * WRITE_FLUSH Like WRITE_SYNC but with preceding cache flush.
183 * WRITE_FUA Like WRITE_SYNC but data is guaranteed to be on
184 * non-volatile media on completion.
185 * WRITE_FLUSH_FUA Combination of WRITE_FLUSH and FUA. The IO is preceded
186 * by a cache flush and data is guaranteed to be on
187 * non-volatile media on completion.
188 *
189 */
190 #define RW_MASK REQ_WRITE
191 #define RWA_MASK REQ_RAHEAD
192
193 #define READ 0
194 #define WRITE RW_MASK
195 #define READA RWA_MASK
196
197 #define READ_SYNC (READ | REQ_SYNC)
198 #define WRITE_SYNC (WRITE | REQ_SYNC | REQ_NOIDLE)
199 #define WRITE_ODIRECT (WRITE | REQ_SYNC)
200 #define WRITE_FLUSH (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FLUSH)
201 #define WRITE_FUA (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FUA)
202 #define WRITE_FLUSH_FUA (WRITE | REQ_SYNC | REQ_NOIDLE | REQ_FLUSH | REQ_FUA)
203
204 /*
205 * Attribute flags. These should be or-ed together to figure out what
206 * has been changed!
207 */
208 #define ATTR_MODE (1 << 0)
209 #define ATTR_UID (1 << 1)
210 #define ATTR_GID (1 << 2)
211 #define ATTR_SIZE (1 << 3)
212 #define ATTR_ATIME (1 << 4)
213 #define ATTR_MTIME (1 << 5)
214 #define ATTR_CTIME (1 << 6)
215 #define ATTR_ATIME_SET (1 << 7)
216 #define ATTR_MTIME_SET (1 << 8)
217 #define ATTR_FORCE (1 << 9) /* Not a change, but a change it */
218 #define ATTR_ATTR_FLAG (1 << 10)
219 #define ATTR_KILL_SUID (1 << 11)
220 #define ATTR_KILL_SGID (1 << 12)
221 #define ATTR_FILE (1 << 13)
222 #define ATTR_KILL_PRIV (1 << 14)
223 #define ATTR_OPEN (1 << 15) /* Truncating from open(O_TRUNC) */
224 #define ATTR_TIMES_SET (1 << 16)
225
226 /*
227 * Whiteout is represented by a char device. The following constants define the
228 * mode and device number to use.
229 */
230 #define WHITEOUT_MODE 0
231 #define WHITEOUT_DEV 0
232
233 /*
234 * This is the Inode Attributes structure, used for notify_change(). It
235 * uses the above definitions as flags, to know which values have changed.
236 * Also, in this manner, a Filesystem can look at only the values it cares
237 * about. Basically, these are the attributes that the VFS layer can
238 * request to change from the FS layer.
239 *
240 * Derek Atkins <warlord@MIT.EDU> 94-10-20
241 */
242 struct iattr {
243 unsigned int ia_valid;
244 umode_t ia_mode;
245 kuid_t ia_uid;
246 kgid_t ia_gid;
247 loff_t ia_size;
248 struct timespec ia_atime;
249 struct timespec ia_mtime;
250 struct timespec ia_ctime;
251
252 /*
253 * Not an attribute, but an auxiliary info for filesystems wanting to
254 * implement an ftruncate() like method. NOTE: filesystem should
255 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
256 */
257 struct file *ia_file;
258 };
259
260 /*
261 * Includes for diskquotas.
262 */
263 #include <linux/quota.h>
264
265 /*
266 * Maximum number of layers of fs stack. Needs to be limited to
267 * prevent kernel stack overflow
268 */
269 #define FILESYSTEM_MAX_STACK_DEPTH 2
270
271 /**
272 * enum positive_aop_returns - aop return codes with specific semantics
273 *
274 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
275 * completed, that the page is still locked, and
276 * should be considered active. The VM uses this hint
277 * to return the page to the active list -- it won't
278 * be a candidate for writeback again in the near
279 * future. Other callers must be careful to unlock
280 * the page if they get this return. Returned by
281 * writepage();
282 *
283 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
284 * unlocked it and the page might have been truncated.
285 * The caller should back up to acquiring a new page and
286 * trying again. The aop will be taking reasonable
287 * precautions not to livelock. If the caller held a page
288 * reference, it should drop it before retrying. Returned
289 * by readpage().
290 *
291 * address_space_operation functions return these large constants to indicate
292 * special semantics to the caller. These are much larger than the bytes in a
293 * page to allow for functions that return the number of bytes operated on in a
294 * given page.
295 */
296
297 enum positive_aop_returns {
298 AOP_WRITEPAGE_ACTIVATE = 0x80000,
299 AOP_TRUNCATED_PAGE = 0x80001,
300 };
301
302 #define AOP_FLAG_UNINTERRUPTIBLE 0x0001 /* will not do a short write */
303 #define AOP_FLAG_CONT_EXPAND 0x0002 /* called from cont_expand */
304 #define AOP_FLAG_NOFS 0x0004 /* used by filesystem to direct
305 * helper code (eg buffer layer)
306 * to clear GFP_FS from alloc */
307
308 /*
309 * oh the beauties of C type declarations.
310 */
311 struct page;
312 struct address_space;
313 struct writeback_control;
314
315 /*
316 * "descriptor" for what we're up to with a read.
317 * This allows us to use the same read code yet
318 * have multiple different users of the data that
319 * we read from a file.
320 *
321 * The simplest case just copies the data to user
322 * mode.
323 */
324 typedef struct {
325 size_t written;
326 size_t count;
327 union {
328 char __user *buf;
329 void *data;
330 } arg;
331 int error;
332 } read_descriptor_t;
333
334 typedef int (*read_actor_t)(read_descriptor_t *, struct page *,
335 unsigned long, unsigned long);
336
337 struct address_space_operations {
338 int (*writepage)(struct page *page, struct writeback_control *wbc);
339 int (*readpage)(struct file *, struct page *);
340
341 /* Write back some dirty pages from this mapping. */
342 int (*writepages)(struct address_space *, struct writeback_control *);
343
344 /* Set a page dirty. Return true if this dirtied it */
345 int (*set_page_dirty)(struct page *page);
346
347 int (*readpages)(struct file *filp, struct address_space *mapping,
348 struct list_head *pages, unsigned nr_pages);
349
350 int (*write_begin)(struct file *, struct address_space *mapping,
351 loff_t pos, unsigned len, unsigned flags,
352 struct page **pagep, void **fsdata);
353 int (*write_end)(struct file *, struct address_space *mapping,
354 loff_t pos, unsigned len, unsigned copied,
355 struct page *page, void *fsdata);
356
357 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
358 sector_t (*bmap)(struct address_space *, sector_t);
359 void (*invalidatepage) (struct page *, unsigned int, unsigned int);
360 int (*releasepage) (struct page *, gfp_t);
361 void (*freepage)(struct page *);
362 ssize_t (*direct_IO)(int, struct kiocb *, struct iov_iter *iter, loff_t offset);
363 int (*get_xip_mem)(struct address_space *, pgoff_t, int,
364 void **, unsigned long *);
365 /*
366 * migrate the contents of a page to the specified target. If
367 * migrate_mode is MIGRATE_ASYNC, it must not block.
368 */
369 int (*migratepage) (struct address_space *,
370 struct page *, struct page *, enum migrate_mode);
371 int (*launder_page) (struct page *);
372 int (*is_partially_uptodate) (struct page *, unsigned long,
373 unsigned long);
374 void (*is_dirty_writeback) (struct page *, bool *, bool *);
375 int (*error_remove_page)(struct address_space *, struct page *);
376
377 /* swapfile support */
378 int (*swap_activate)(struct swap_info_struct *sis, struct file *file,
379 sector_t *span);
380 void (*swap_deactivate)(struct file *file);
381 };
382
383 extern const struct address_space_operations empty_aops;
384
385 /*
386 * pagecache_write_begin/pagecache_write_end must be used by general code
387 * to write into the pagecache.
388 */
389 int pagecache_write_begin(struct file *, struct address_space *mapping,
390 loff_t pos, unsigned len, unsigned flags,
391 struct page **pagep, void **fsdata);
392
393 int pagecache_write_end(struct file *, struct address_space *mapping,
394 loff_t pos, unsigned len, unsigned copied,
395 struct page *page, void *fsdata);
396
397 struct backing_dev_info;
398 struct address_space {
399 struct inode *host; /* owner: inode, block_device */
400 struct radix_tree_root page_tree; /* radix tree of all pages */
401 spinlock_t tree_lock; /* and lock protecting it */
402 atomic_t i_mmap_writable;/* count VM_SHARED mappings */
403 struct rb_root i_mmap; /* tree of private and shared mappings */
404 struct list_head i_mmap_nonlinear;/*list VM_NONLINEAR mappings */
405 struct rw_semaphore i_mmap_rwsem; /* protect tree, count, list */
406 /* Protected by tree_lock together with the radix tree */
407 unsigned long nrpages; /* number of total pages */
408 unsigned long nrshadows; /* number of shadow entries */
409 pgoff_t writeback_index;/* writeback starts here */
410 const struct address_space_operations *a_ops; /* methods */
411 unsigned long flags; /* error bits/gfp mask */
412 struct backing_dev_info *backing_dev_info; /* device readahead, etc */
413 spinlock_t private_lock; /* for use by the address_space */
414 struct list_head private_list; /* ditto */
415 void *private_data; /* ditto */
416 } __attribute__((aligned(sizeof(long))));
417 /*
418 * On most architectures that alignment is already the case; but
419 * must be enforced here for CRIS, to let the least significant bit
420 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
421 */
422 struct request_queue;
423
424 struct block_device {
425 dev_t bd_dev; /* not a kdev_t - it's a search key */
426 int bd_openers;
427 struct inode * bd_inode; /* will die */
428 struct super_block * bd_super;
429 struct mutex bd_mutex; /* open/close mutex */
430 struct list_head bd_inodes;
431 void * bd_claiming;
432 void * bd_holder;
433 int bd_holders;
434 bool bd_write_holder;
435 #ifdef CONFIG_SYSFS
436 struct list_head bd_holder_disks;
437 #endif
438 struct block_device * bd_contains;
439 unsigned bd_block_size;
440 struct hd_struct * bd_part;
441 /* number of times partitions within this device have been opened. */
442 unsigned bd_part_count;
443 int bd_invalidated;
444 struct gendisk * bd_disk;
445 struct request_queue * bd_queue;
446 struct list_head bd_list;
447 /*
448 * Private data. You must have bd_claim'ed the block_device
449 * to use this. NOTE: bd_claim allows an owner to claim
450 * the same device multiple times, the owner must take special
451 * care to not mess up bd_private for that case.
452 */
453 unsigned long bd_private;
454
455 /* The counter of freeze processes */
456 int bd_fsfreeze_count;
457 /* Mutex for freeze */
458 struct mutex bd_fsfreeze_mutex;
459 };
460
461 /*
462 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
463 * radix trees
464 */
465 #define PAGECACHE_TAG_DIRTY 0
466 #define PAGECACHE_TAG_WRITEBACK 1
467 #define PAGECACHE_TAG_TOWRITE 2
468
469 int mapping_tagged(struct address_space *mapping, int tag);
470
471 static inline void i_mmap_lock_write(struct address_space *mapping)
472 {
473 down_write(&mapping->i_mmap_rwsem);
474 }
475
476 static inline void i_mmap_unlock_write(struct address_space *mapping)
477 {
478 up_write(&mapping->i_mmap_rwsem);
479 }
480
481 static inline void i_mmap_lock_read(struct address_space *mapping)
482 {
483 down_read(&mapping->i_mmap_rwsem);
484 }
485
486 static inline void i_mmap_unlock_read(struct address_space *mapping)
487 {
488 up_read(&mapping->i_mmap_rwsem);
489 }
490
491 /*
492 * Might pages of this file be mapped into userspace?
493 */
494 static inline int mapping_mapped(struct address_space *mapping)
495 {
496 return !RB_EMPTY_ROOT(&mapping->i_mmap) ||
497 !list_empty(&mapping->i_mmap_nonlinear);
498 }
499
500 /*
501 * Might pages of this file have been modified in userspace?
502 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
503 * marks vma as VM_SHARED if it is shared, and the file was opened for
504 * writing i.e. vma may be mprotected writable even if now readonly.
505 *
506 * If i_mmap_writable is negative, no new writable mappings are allowed. You
507 * can only deny writable mappings, if none exists right now.
508 */
509 static inline int mapping_writably_mapped(struct address_space *mapping)
510 {
511 return atomic_read(&mapping->i_mmap_writable) > 0;
512 }
513
514 static inline int mapping_map_writable(struct address_space *mapping)
515 {
516 return atomic_inc_unless_negative(&mapping->i_mmap_writable) ?
517 0 : -EPERM;
518 }
519
520 static inline void mapping_unmap_writable(struct address_space *mapping)
521 {
522 atomic_dec(&mapping->i_mmap_writable);
523 }
524
525 static inline int mapping_deny_writable(struct address_space *mapping)
526 {
527 return atomic_dec_unless_positive(&mapping->i_mmap_writable) ?
528 0 : -EBUSY;
529 }
530
531 static inline void mapping_allow_writable(struct address_space *mapping)
532 {
533 atomic_inc(&mapping->i_mmap_writable);
534 }
535
536 /*
537 * Use sequence counter to get consistent i_size on 32-bit processors.
538 */
539 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
540 #include <linux/seqlock.h>
541 #define __NEED_I_SIZE_ORDERED
542 #define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
543 #else
544 #define i_size_ordered_init(inode) do { } while (0)
545 #endif
546
547 struct posix_acl;
548 #define ACL_NOT_CACHED ((void *)(-1))
549
550 #define IOP_FASTPERM 0x0001
551 #define IOP_LOOKUP 0x0002
552 #define IOP_NOFOLLOW 0x0004
553
554 /*
555 * Keep mostly read-only and often accessed (especially for
556 * the RCU path lookup and 'stat' data) fields at the beginning
557 * of the 'struct inode'
558 */
559 struct inode {
560 umode_t i_mode;
561 unsigned short i_opflags;
562 kuid_t i_uid;
563 kgid_t i_gid;
564 unsigned int i_flags;
565
566 #ifdef CONFIG_FS_POSIX_ACL
567 struct posix_acl *i_acl;
568 struct posix_acl *i_default_acl;
569 #endif
570
571 const struct inode_operations *i_op;
572 struct super_block *i_sb;
573 struct address_space *i_mapping;
574
575 #ifdef CONFIG_SECURITY
576 void *i_security;
577 #endif
578
579 /* Stat data, not accessed from path walking */
580 unsigned long i_ino;
581 /*
582 * Filesystems may only read i_nlink directly. They shall use the
583 * following functions for modification:
584 *
585 * (set|clear|inc|drop)_nlink
586 * inode_(inc|dec)_link_count
587 */
588 union {
589 const unsigned int i_nlink;
590 unsigned int __i_nlink;
591 };
592 dev_t i_rdev;
593 loff_t i_size;
594 struct timespec i_atime;
595 struct timespec i_mtime;
596 struct timespec i_ctime;
597 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
598 unsigned short i_bytes;
599 unsigned int i_blkbits;
600 blkcnt_t i_blocks;
601
602 #ifdef __NEED_I_SIZE_ORDERED
603 seqcount_t i_size_seqcount;
604 #endif
605
606 /* Misc */
607 unsigned long i_state;
608 struct mutex i_mutex;
609
610 unsigned long dirtied_when; /* jiffies of first dirtying */
611
612 struct hlist_node i_hash;
613 struct list_head i_wb_list; /* backing dev IO list */
614 struct list_head i_lru; /* inode LRU list */
615 struct list_head i_sb_list;
616 union {
617 struct hlist_head i_dentry;
618 struct rcu_head i_rcu;
619 };
620 u64 i_version;
621 atomic_t i_count;
622 atomic_t i_dio_count;
623 atomic_t i_writecount;
624 #ifdef CONFIG_IMA
625 atomic_t i_readcount; /* struct files open RO */
626 #endif
627 const struct file_operations *i_fop; /* former ->i_op->default_file_ops */
628 struct file_lock *i_flock;
629 struct file_lock_context *i_flctx;
630 struct address_space i_data;
631 struct list_head i_devices;
632 union {
633 struct pipe_inode_info *i_pipe;
634 struct block_device *i_bdev;
635 struct cdev *i_cdev;
636 };
637
638 __u32 i_generation;
639
640 #ifdef CONFIG_FSNOTIFY
641 __u32 i_fsnotify_mask; /* all events this inode cares about */
642 struct hlist_head i_fsnotify_marks;
643 #endif
644
645 void *i_private; /* fs or device private pointer */
646 };
647
648 static inline int inode_unhashed(struct inode *inode)
649 {
650 return hlist_unhashed(&inode->i_hash);
651 }
652
653 /*
654 * inode->i_mutex nesting subclasses for the lock validator:
655 *
656 * 0: the object of the current VFS operation
657 * 1: parent
658 * 2: child/target
659 * 3: xattr
660 * 4: second non-directory
661 * 5: second parent (when locking independent directories in rename)
662 *
663 * I_MUTEX_NONDIR2 is for certain operations (such as rename) which lock two
664 * non-directories at once.
665 *
666 * The locking order between these classes is
667 * parent[2] -> child -> grandchild -> normal -> xattr -> second non-directory
668 */
669 enum inode_i_mutex_lock_class
670 {
671 I_MUTEX_NORMAL,
672 I_MUTEX_PARENT,
673 I_MUTEX_CHILD,
674 I_MUTEX_XATTR,
675 I_MUTEX_NONDIR2,
676 I_MUTEX_PARENT2,
677 };
678
679 void lock_two_nondirectories(struct inode *, struct inode*);
680 void unlock_two_nondirectories(struct inode *, struct inode*);
681
682 /*
683 * NOTE: in a 32bit arch with a preemptable kernel and
684 * an UP compile the i_size_read/write must be atomic
685 * with respect to the local cpu (unlike with preempt disabled),
686 * but they don't need to be atomic with respect to other cpus like in
687 * true SMP (so they need either to either locally disable irq around
688 * the read or for example on x86 they can be still implemented as a
689 * cmpxchg8b without the need of the lock prefix). For SMP compiles
690 * and 64bit archs it makes no difference if preempt is enabled or not.
691 */
692 static inline loff_t i_size_read(const struct inode *inode)
693 {
694 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
695 loff_t i_size;
696 unsigned int seq;
697
698 do {
699 seq = read_seqcount_begin(&inode->i_size_seqcount);
700 i_size = inode->i_size;
701 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
702 return i_size;
703 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
704 loff_t i_size;
705
706 preempt_disable();
707 i_size = inode->i_size;
708 preempt_enable();
709 return i_size;
710 #else
711 return inode->i_size;
712 #endif
713 }
714
715 /*
716 * NOTE: unlike i_size_read(), i_size_write() does need locking around it
717 * (normally i_mutex), otherwise on 32bit/SMP an update of i_size_seqcount
718 * can be lost, resulting in subsequent i_size_read() calls spinning forever.
719 */
720 static inline void i_size_write(struct inode *inode, loff_t i_size)
721 {
722 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
723 preempt_disable();
724 write_seqcount_begin(&inode->i_size_seqcount);
725 inode->i_size = i_size;
726 write_seqcount_end(&inode->i_size_seqcount);
727 preempt_enable();
728 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
729 preempt_disable();
730 inode->i_size = i_size;
731 preempt_enable();
732 #else
733 inode->i_size = i_size;
734 #endif
735 }
736
737 /* Helper functions so that in most cases filesystems will
738 * not need to deal directly with kuid_t and kgid_t and can
739 * instead deal with the raw numeric values that are stored
740 * in the filesystem.
741 */
742 static inline uid_t i_uid_read(const struct inode *inode)
743 {
744 return from_kuid(&init_user_ns, inode->i_uid);
745 }
746
747 static inline gid_t i_gid_read(const struct inode *inode)
748 {
749 return from_kgid(&init_user_ns, inode->i_gid);
750 }
751
752 static inline void i_uid_write(struct inode *inode, uid_t uid)
753 {
754 inode->i_uid = make_kuid(&init_user_ns, uid);
755 }
756
757 static inline void i_gid_write(struct inode *inode, gid_t gid)
758 {
759 inode->i_gid = make_kgid(&init_user_ns, gid);
760 }
761
762 static inline unsigned iminor(const struct inode *inode)
763 {
764 return MINOR(inode->i_rdev);
765 }
766
767 static inline unsigned imajor(const struct inode *inode)
768 {
769 return MAJOR(inode->i_rdev);
770 }
771
772 extern struct block_device *I_BDEV(struct inode *inode);
773
774 struct fown_struct {
775 rwlock_t lock; /* protects pid, uid, euid fields */
776 struct pid *pid; /* pid or -pgrp where SIGIO should be sent */
777 enum pid_type pid_type; /* Kind of process group SIGIO should be sent to */
778 kuid_t uid, euid; /* uid/euid of process setting the owner */
779 int signum; /* posix.1b rt signal to be delivered on IO */
780 };
781
782 /*
783 * Track a single file's readahead state
784 */
785 struct file_ra_state {
786 pgoff_t start; /* where readahead started */
787 unsigned int size; /* # of readahead pages */
788 unsigned int async_size; /* do asynchronous readahead when
789 there are only # of pages ahead */
790
791 unsigned int ra_pages; /* Maximum readahead window */
792 unsigned int mmap_miss; /* Cache miss stat for mmap accesses */
793 loff_t prev_pos; /* Cache last read() position */
794 };
795
796 /*
797 * Check if @index falls in the readahead windows.
798 */
799 static inline int ra_has_index(struct file_ra_state *ra, pgoff_t index)
800 {
801 return (index >= ra->start &&
802 index < ra->start + ra->size);
803 }
804
805 struct file {
806 union {
807 struct llist_node fu_llist;
808 struct rcu_head fu_rcuhead;
809 } f_u;
810 struct path f_path;
811 struct inode *f_inode; /* cached value */
812 const struct file_operations *f_op;
813
814 /*
815 * Protects f_ep_links, f_flags.
816 * Must not be taken from IRQ context.
817 */
818 spinlock_t f_lock;
819 atomic_long_t f_count;
820 unsigned int f_flags;
821 fmode_t f_mode;
822 struct mutex f_pos_lock;
823 loff_t f_pos;
824 struct fown_struct f_owner;
825 const struct cred *f_cred;
826 struct file_ra_state f_ra;
827
828 u64 f_version;
829 #ifdef CONFIG_SECURITY
830 void *f_security;
831 #endif
832 /* needed for tty driver, and maybe others */
833 void *private_data;
834
835 #ifdef CONFIG_EPOLL
836 /* Used by fs/eventpoll.c to link all the hooks to this file */
837 struct list_head f_ep_links;
838 struct list_head f_tfile_llink;
839 #endif /* #ifdef CONFIG_EPOLL */
840 struct address_space *f_mapping;
841 } __attribute__((aligned(4))); /* lest something weird decides that 2 is OK */
842
843 struct file_handle {
844 __u32 handle_bytes;
845 int handle_type;
846 /* file identifier */
847 unsigned char f_handle[0];
848 };
849
850 static inline struct file *get_file(struct file *f)
851 {
852 atomic_long_inc(&f->f_count);
853 return f;
854 }
855 #define fput_atomic(x) atomic_long_add_unless(&(x)->f_count, -1, 1)
856 #define file_count(x) atomic_long_read(&(x)->f_count)
857
858 #define MAX_NON_LFS ((1UL<<31) - 1)
859
860 /* Page cache limit. The filesystems should put that into their s_maxbytes
861 limits, otherwise bad things can happen in VM. */
862 #if BITS_PER_LONG==32
863 #define MAX_LFS_FILESIZE (((loff_t)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1)
864 #elif BITS_PER_LONG==64
865 #define MAX_LFS_FILESIZE ((loff_t)0x7fffffffffffffffLL)
866 #endif
867
868 #define FL_POSIX 1
869 #define FL_FLOCK 2
870 #define FL_DELEG 4 /* NFSv4 delegation */
871 #define FL_ACCESS 8 /* not trying to lock, just looking */
872 #define FL_EXISTS 16 /* when unlocking, test for existence */
873 #define FL_LEASE 32 /* lease held on this file */
874 #define FL_CLOSE 64 /* unlock on close */
875 #define FL_SLEEP 128 /* A blocking lock */
876 #define FL_DOWNGRADE_PENDING 256 /* Lease is being downgraded */
877 #define FL_UNLOCK_PENDING 512 /* Lease is being broken */
878 #define FL_OFDLCK 1024 /* lock is "owned" by struct file */
879
880 /*
881 * Special return value from posix_lock_file() and vfs_lock_file() for
882 * asynchronous locking.
883 */
884 #define FILE_LOCK_DEFERRED 1
885
886 /* legacy typedef, should eventually be removed */
887 typedef void *fl_owner_t;
888
889 struct file_lock_operations {
890 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
891 void (*fl_release_private)(struct file_lock *);
892 };
893
894 struct lock_manager_operations {
895 int (*lm_compare_owner)(struct file_lock *, struct file_lock *);
896 unsigned long (*lm_owner_key)(struct file_lock *);
897 void (*lm_get_owner)(struct file_lock *, struct file_lock *);
898 void (*lm_put_owner)(struct file_lock *);
899 void (*lm_notify)(struct file_lock *); /* unblock callback */
900 int (*lm_grant)(struct file_lock *, int);
901 bool (*lm_break)(struct file_lock *);
902 int (*lm_change)(struct file_lock **, int, struct list_head *);
903 void (*lm_setup)(struct file_lock *, void **);
904 };
905
906 struct lock_manager {
907 struct list_head list;
908 };
909
910 struct net;
911 void locks_start_grace(struct net *, struct lock_manager *);
912 void locks_end_grace(struct lock_manager *);
913 int locks_in_grace(struct net *);
914
915 /* that will die - we need it for nfs_lock_info */
916 #include <linux/nfs_fs_i.h>
917
918 /*
919 * struct file_lock represents a generic "file lock". It's used to represent
920 * POSIX byte range locks, BSD (flock) locks, and leases. It's important to
921 * note that the same struct is used to represent both a request for a lock and
922 * the lock itself, but the same object is never used for both.
923 *
924 * FIXME: should we create a separate "struct lock_request" to help distinguish
925 * these two uses?
926 *
927 * The i_flock list is ordered by:
928 *
929 * 1) lock type -- FL_LEASEs first, then FL_FLOCK, and finally FL_POSIX
930 * 2) lock owner
931 * 3) lock range start
932 * 4) lock range end
933 *
934 * Obviously, the last two criteria only matter for POSIX locks.
935 */
936 struct file_lock {
937 struct file_lock *fl_next; /* singly linked list for this inode */
938 struct list_head fl_list; /* link into file_lock_context */
939 struct hlist_node fl_link; /* node in global lists */
940 struct list_head fl_block; /* circular list of blocked processes */
941 fl_owner_t fl_owner;
942 unsigned int fl_flags;
943 unsigned char fl_type;
944 unsigned int fl_pid;
945 int fl_link_cpu; /* what cpu's list is this on? */
946 struct pid *fl_nspid;
947 wait_queue_head_t fl_wait;
948 struct file *fl_file;
949 loff_t fl_start;
950 loff_t fl_end;
951
952 struct fasync_struct * fl_fasync; /* for lease break notifications */
953 /* for lease breaks: */
954 unsigned long fl_break_time;
955 unsigned long fl_downgrade_time;
956
957 const struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
958 const struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
959 union {
960 struct nfs_lock_info nfs_fl;
961 struct nfs4_lock_info nfs4_fl;
962 struct {
963 struct list_head link; /* link in AFS vnode's pending_locks list */
964 int state; /* state of grant or error if -ve */
965 } afs;
966 } fl_u;
967 };
968
969 struct file_lock_context {
970 struct list_head flc_flock;
971 };
972
973 /* The following constant reflects the upper bound of the file/locking space */
974 #ifndef OFFSET_MAX
975 #define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
976 #define OFFSET_MAX INT_LIMIT(loff_t)
977 #define OFFT_OFFSET_MAX INT_LIMIT(off_t)
978 #endif
979
980 #include <linux/fcntl.h>
981
982 extern void send_sigio(struct fown_struct *fown, int fd, int band);
983
984 #ifdef CONFIG_FILE_LOCKING
985 extern int fcntl_getlk(struct file *, unsigned int, struct flock __user *);
986 extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
987 struct flock __user *);
988
989 #if BITS_PER_LONG == 32
990 extern int fcntl_getlk64(struct file *, unsigned int, struct flock64 __user *);
991 extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
992 struct flock64 __user *);
993 #endif
994
995 extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
996 extern int fcntl_getlease(struct file *filp);
997
998 /* fs/locks.c */
999 void locks_free_lock_context(struct file_lock_context *ctx);
1000 void locks_free_lock(struct file_lock *fl);
1001 extern void locks_init_lock(struct file_lock *);
1002 extern struct file_lock * locks_alloc_lock(void);
1003 extern void locks_copy_lock(struct file_lock *, struct file_lock *);
1004 extern void locks_copy_conflock(struct file_lock *, struct file_lock *);
1005 extern void locks_remove_posix(struct file *, fl_owner_t);
1006 extern void locks_remove_file(struct file *);
1007 extern void locks_release_private(struct file_lock *);
1008 extern void posix_test_lock(struct file *, struct file_lock *);
1009 extern int posix_lock_file(struct file *, struct file_lock *, struct file_lock *);
1010 extern int posix_lock_file_wait(struct file *, struct file_lock *);
1011 extern int posix_unblock_lock(struct file_lock *);
1012 extern int vfs_test_lock(struct file *, struct file_lock *);
1013 extern int vfs_lock_file(struct file *, unsigned int, struct file_lock *, struct file_lock *);
1014 extern int vfs_cancel_lock(struct file *filp, struct file_lock *fl);
1015 extern int flock_lock_file_wait(struct file *filp, struct file_lock *fl);
1016 extern int __break_lease(struct inode *inode, unsigned int flags, unsigned int type);
1017 extern void lease_get_mtime(struct inode *, struct timespec *time);
1018 extern int generic_setlease(struct file *, long, struct file_lock **, void **priv);
1019 extern int vfs_setlease(struct file *, long, struct file_lock **, void **);
1020 extern int lease_modify(struct file_lock **, int, struct list_head *);
1021 #else /* !CONFIG_FILE_LOCKING */
1022 static inline int fcntl_getlk(struct file *file, unsigned int cmd,
1023 struct flock __user *user)
1024 {
1025 return -EINVAL;
1026 }
1027
1028 static inline int fcntl_setlk(unsigned int fd, struct file *file,
1029 unsigned int cmd, struct flock __user *user)
1030 {
1031 return -EACCES;
1032 }
1033
1034 #if BITS_PER_LONG == 32
1035 static inline int fcntl_getlk64(struct file *file, unsigned int cmd,
1036 struct flock64 __user *user)
1037 {
1038 return -EINVAL;
1039 }
1040
1041 static inline int fcntl_setlk64(unsigned int fd, struct file *file,
1042 unsigned int cmd, struct flock64 __user *user)
1043 {
1044 return -EACCES;
1045 }
1046 #endif
1047 static inline int fcntl_setlease(unsigned int fd, struct file *filp, long arg)
1048 {
1049 return -EINVAL;
1050 }
1051
1052 static inline int fcntl_getlease(struct file *filp)
1053 {
1054 return F_UNLCK;
1055 }
1056
1057 static inline void
1058 locks_free_lock_context(struct file_lock_context *ctx)
1059 {
1060 }
1061
1062 static inline void locks_init_lock(struct file_lock *fl)
1063 {
1064 return;
1065 }
1066
1067 static inline void locks_copy_conflock(struct file_lock *new, struct file_lock *fl)
1068 {
1069 return;
1070 }
1071
1072 static inline void locks_copy_lock(struct file_lock *new, struct file_lock *fl)
1073 {
1074 return;
1075 }
1076
1077 static inline void locks_remove_posix(struct file *filp, fl_owner_t owner)
1078 {
1079 return;
1080 }
1081
1082 static inline void locks_remove_file(struct file *filp)
1083 {
1084 return;
1085 }
1086
1087 static inline void posix_test_lock(struct file *filp, struct file_lock *fl)
1088 {
1089 return;
1090 }
1091
1092 static inline int posix_lock_file(struct file *filp, struct file_lock *fl,
1093 struct file_lock *conflock)
1094 {
1095 return -ENOLCK;
1096 }
1097
1098 static inline int posix_lock_file_wait(struct file *filp, struct file_lock *fl)
1099 {
1100 return -ENOLCK;
1101 }
1102
1103 static inline int posix_unblock_lock(struct file_lock *waiter)
1104 {
1105 return -ENOENT;
1106 }
1107
1108 static inline int vfs_test_lock(struct file *filp, struct file_lock *fl)
1109 {
1110 return 0;
1111 }
1112
1113 static inline int vfs_lock_file(struct file *filp, unsigned int cmd,
1114 struct file_lock *fl, struct file_lock *conf)
1115 {
1116 return -ENOLCK;
1117 }
1118
1119 static inline int vfs_cancel_lock(struct file *filp, struct file_lock *fl)
1120 {
1121 return 0;
1122 }
1123
1124 static inline int flock_lock_file_wait(struct file *filp,
1125 struct file_lock *request)
1126 {
1127 return -ENOLCK;
1128 }
1129
1130 static inline int __break_lease(struct inode *inode, unsigned int mode, unsigned int type)
1131 {
1132 return 0;
1133 }
1134
1135 static inline void lease_get_mtime(struct inode *inode, struct timespec *time)
1136 {
1137 return;
1138 }
1139
1140 static inline int generic_setlease(struct file *filp, long arg,
1141 struct file_lock **flp, void **priv)
1142 {
1143 return -EINVAL;
1144 }
1145
1146 static inline int vfs_setlease(struct file *filp, long arg,
1147 struct file_lock **lease, void **priv)
1148 {
1149 return -EINVAL;
1150 }
1151
1152 static inline int lease_modify(struct file_lock **before, int arg,
1153 struct list_head *dispose)
1154 {
1155 return -EINVAL;
1156 }
1157 #endif /* !CONFIG_FILE_LOCKING */
1158
1159
1160 struct fasync_struct {
1161 spinlock_t fa_lock;
1162 int magic;
1163 int fa_fd;
1164 struct fasync_struct *fa_next; /* singly linked list */
1165 struct file *fa_file;
1166 struct rcu_head fa_rcu;
1167 };
1168
1169 #define FASYNC_MAGIC 0x4601
1170
1171 /* SMP safe fasync helpers: */
1172 extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
1173 extern struct fasync_struct *fasync_insert_entry(int, struct file *, struct fasync_struct **, struct fasync_struct *);
1174 extern int fasync_remove_entry(struct file *, struct fasync_struct **);
1175 extern struct fasync_struct *fasync_alloc(void);
1176 extern void fasync_free(struct fasync_struct *);
1177
1178 /* can be called from interrupts */
1179 extern void kill_fasync(struct fasync_struct **, int, int);
1180
1181 extern void __f_setown(struct file *filp, struct pid *, enum pid_type, int force);
1182 extern void f_setown(struct file *filp, unsigned long arg, int force);
1183 extern void f_delown(struct file *filp);
1184 extern pid_t f_getown(struct file *filp);
1185 extern int send_sigurg(struct fown_struct *fown);
1186
1187 struct mm_struct;
1188
1189 /*
1190 * Umount options
1191 */
1192
1193 #define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
1194 #define MNT_DETACH 0x00000002 /* Just detach from the tree */
1195 #define MNT_EXPIRE 0x00000004 /* Mark for expiry */
1196 #define UMOUNT_NOFOLLOW 0x00000008 /* Don't follow symlink on umount */
1197 #define UMOUNT_UNUSED 0x80000000 /* Flag guaranteed to be unused */
1198
1199 extern struct list_head super_blocks;
1200 extern spinlock_t sb_lock;
1201
1202 /* Possible states of 'frozen' field */
1203 enum {
1204 SB_UNFROZEN = 0, /* FS is unfrozen */
1205 SB_FREEZE_WRITE = 1, /* Writes, dir ops, ioctls frozen */
1206 SB_FREEZE_PAGEFAULT = 2, /* Page faults stopped as well */
1207 SB_FREEZE_FS = 3, /* For internal FS use (e.g. to stop
1208 * internal threads if needed) */
1209 SB_FREEZE_COMPLETE = 4, /* ->freeze_fs finished successfully */
1210 };
1211
1212 #define SB_FREEZE_LEVELS (SB_FREEZE_COMPLETE - 1)
1213
1214 struct sb_writers {
1215 /* Counters for counting writers at each level */
1216 struct percpu_counter counter[SB_FREEZE_LEVELS];
1217 wait_queue_head_t wait; /* queue for waiting for
1218 writers / faults to finish */
1219 int frozen; /* Is sb frozen? */
1220 wait_queue_head_t wait_unfrozen; /* queue for waiting for
1221 sb to be thawed */
1222 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1223 struct lockdep_map lock_map[SB_FREEZE_LEVELS];
1224 #endif
1225 };
1226
1227 struct super_block {
1228 struct list_head s_list; /* Keep this first */
1229 dev_t s_dev; /* search index; _not_ kdev_t */
1230 unsigned char s_blocksize_bits;
1231 unsigned long s_blocksize;
1232 loff_t s_maxbytes; /* Max file size */
1233 struct file_system_type *s_type;
1234 const struct super_operations *s_op;
1235 const struct dquot_operations *dq_op;
1236 const struct quotactl_ops *s_qcop;
1237 const struct export_operations *s_export_op;
1238 unsigned long s_flags;
1239 unsigned long s_magic;
1240 struct dentry *s_root;
1241 struct rw_semaphore s_umount;
1242 int s_count;
1243 atomic_t s_active;
1244 #ifdef CONFIG_SECURITY
1245 void *s_security;
1246 #endif
1247 const struct xattr_handler **s_xattr;
1248
1249 struct list_head s_inodes; /* all inodes */
1250 struct hlist_bl_head s_anon; /* anonymous dentries for (nfs) exporting */
1251 struct list_head s_mounts; /* list of mounts; _not_ for fs use */
1252 struct block_device *s_bdev;
1253 struct backing_dev_info *s_bdi;
1254 struct mtd_info *s_mtd;
1255 struct hlist_node s_instances;
1256 unsigned int s_quota_types; /* Bitmask of supported quota types */
1257 struct quota_info s_dquot; /* Diskquota specific options */
1258
1259 struct sb_writers s_writers;
1260
1261 char s_id[32]; /* Informational name */
1262 u8 s_uuid[16]; /* UUID */
1263
1264 void *s_fs_info; /* Filesystem private info */
1265 unsigned int s_max_links;
1266 fmode_t s_mode;
1267
1268 /* Granularity of c/m/atime in ns.
1269 Cannot be worse than a second */
1270 u32 s_time_gran;
1271
1272 /*
1273 * The next field is for VFS *only*. No filesystems have any business
1274 * even looking at it. You had been warned.
1275 */
1276 struct mutex s_vfs_rename_mutex; /* Kludge */
1277
1278 /*
1279 * Filesystem subtype. If non-empty the filesystem type field
1280 * in /proc/mounts will be "type.subtype"
1281 */
1282 char *s_subtype;
1283
1284 /*
1285 * Saved mount options for lazy filesystems using
1286 * generic_show_options()
1287 */
1288 char __rcu *s_options;
1289 const struct dentry_operations *s_d_op; /* default d_op for dentries */
1290
1291 /*
1292 * Saved pool identifier for cleancache (-1 means none)
1293 */
1294 int cleancache_poolid;
1295
1296 struct shrinker s_shrink; /* per-sb shrinker handle */
1297
1298 /* Number of inodes with nlink == 0 but still referenced */
1299 atomic_long_t s_remove_count;
1300
1301 /* Being remounted read-only */
1302 int s_readonly_remount;
1303
1304 /* AIO completions deferred from interrupt context */
1305 struct workqueue_struct *s_dio_done_wq;
1306 struct hlist_head s_pins;
1307
1308 /*
1309 * Keep the lru lists last in the structure so they always sit on their
1310 * own individual cachelines.
1311 */
1312 struct list_lru s_dentry_lru ____cacheline_aligned_in_smp;
1313 struct list_lru s_inode_lru ____cacheline_aligned_in_smp;
1314 struct rcu_head rcu;
1315
1316 /*
1317 * Indicates how deep in a filesystem stack this SB is
1318 */
1319 int s_stack_depth;
1320 };
1321
1322 extern struct timespec current_fs_time(struct super_block *sb);
1323
1324 /*
1325 * Snapshotting support.
1326 */
1327
1328 void __sb_end_write(struct super_block *sb, int level);
1329 int __sb_start_write(struct super_block *sb, int level, bool wait);
1330
1331 /**
1332 * sb_end_write - drop write access to a superblock
1333 * @sb: the super we wrote to
1334 *
1335 * Decrement number of writers to the filesystem. Wake up possible waiters
1336 * wanting to freeze the filesystem.
1337 */
1338 static inline void sb_end_write(struct super_block *sb)
1339 {
1340 __sb_end_write(sb, SB_FREEZE_WRITE);
1341 }
1342
1343 /**
1344 * sb_end_pagefault - drop write access to a superblock from a page fault
1345 * @sb: the super we wrote to
1346 *
1347 * Decrement number of processes handling write page fault to the filesystem.
1348 * Wake up possible waiters wanting to freeze the filesystem.
1349 */
1350 static inline void sb_end_pagefault(struct super_block *sb)
1351 {
1352 __sb_end_write(sb, SB_FREEZE_PAGEFAULT);
1353 }
1354
1355 /**
1356 * sb_end_intwrite - drop write access to a superblock for internal fs purposes
1357 * @sb: the super we wrote to
1358 *
1359 * Decrement fs-internal number of writers to the filesystem. Wake up possible
1360 * waiters wanting to freeze the filesystem.
1361 */
1362 static inline void sb_end_intwrite(struct super_block *sb)
1363 {
1364 __sb_end_write(sb, SB_FREEZE_FS);
1365 }
1366
1367 /**
1368 * sb_start_write - get write access to a superblock
1369 * @sb: the super we write to
1370 *
1371 * When a process wants to write data or metadata to a file system (i.e. dirty
1372 * a page or an inode), it should embed the operation in a sb_start_write() -
1373 * sb_end_write() pair to get exclusion against file system freezing. This
1374 * function increments number of writers preventing freezing. If the file
1375 * system is already frozen, the function waits until the file system is
1376 * thawed.
1377 *
1378 * Since freeze protection behaves as a lock, users have to preserve
1379 * ordering of freeze protection and other filesystem locks. Generally,
1380 * freeze protection should be the outermost lock. In particular, we have:
1381 *
1382 * sb_start_write
1383 * -> i_mutex (write path, truncate, directory ops, ...)
1384 * -> s_umount (freeze_super, thaw_super)
1385 */
1386 static inline void sb_start_write(struct super_block *sb)
1387 {
1388 __sb_start_write(sb, SB_FREEZE_WRITE, true);
1389 }
1390
1391 static inline int sb_start_write_trylock(struct super_block *sb)
1392 {
1393 return __sb_start_write(sb, SB_FREEZE_WRITE, false);
1394 }
1395
1396 /**
1397 * sb_start_pagefault - get write access to a superblock from a page fault
1398 * @sb: the super we write to
1399 *
1400 * When a process starts handling write page fault, it should embed the
1401 * operation into sb_start_pagefault() - sb_end_pagefault() pair to get
1402 * exclusion against file system freezing. This is needed since the page fault
1403 * is going to dirty a page. This function increments number of running page
1404 * faults preventing freezing. If the file system is already frozen, the
1405 * function waits until the file system is thawed.
1406 *
1407 * Since page fault freeze protection behaves as a lock, users have to preserve
1408 * ordering of freeze protection and other filesystem locks. It is advised to
1409 * put sb_start_pagefault() close to mmap_sem in lock ordering. Page fault
1410 * handling code implies lock dependency:
1411 *
1412 * mmap_sem
1413 * -> sb_start_pagefault
1414 */
1415 static inline void sb_start_pagefault(struct super_block *sb)
1416 {
1417 __sb_start_write(sb, SB_FREEZE_PAGEFAULT, true);
1418 }
1419
1420 /*
1421 * sb_start_intwrite - get write access to a superblock for internal fs purposes
1422 * @sb: the super we write to
1423 *
1424 * This is the third level of protection against filesystem freezing. It is
1425 * free for use by a filesystem. The only requirement is that it must rank
1426 * below sb_start_pagefault.
1427 *
1428 * For example filesystem can call sb_start_intwrite() when starting a
1429 * transaction which somewhat eases handling of freezing for internal sources
1430 * of filesystem changes (internal fs threads, discarding preallocation on file
1431 * close, etc.).
1432 */
1433 static inline void sb_start_intwrite(struct super_block *sb)
1434 {
1435 __sb_start_write(sb, SB_FREEZE_FS, true);
1436 }
1437
1438
1439 extern bool inode_owner_or_capable(const struct inode *inode);
1440
1441 /*
1442 * VFS helper functions..
1443 */
1444 extern int vfs_create(struct inode *, struct dentry *, umode_t, bool);
1445 extern int vfs_mkdir(struct inode *, struct dentry *, umode_t);
1446 extern int vfs_mknod(struct inode *, struct dentry *, umode_t, dev_t);
1447 extern int vfs_symlink(struct inode *, struct dentry *, const char *);
1448 extern int vfs_link(struct dentry *, struct inode *, struct dentry *, struct inode **);
1449 extern int vfs_rmdir(struct inode *, struct dentry *);
1450 extern int vfs_unlink(struct inode *, struct dentry *, struct inode **);
1451 extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *, struct inode **, unsigned int);
1452 extern int vfs_whiteout(struct inode *, struct dentry *);
1453
1454 /*
1455 * VFS dentry helper functions.
1456 */
1457 extern void dentry_unhash(struct dentry *dentry);
1458
1459 /*
1460 * VFS file helper functions.
1461 */
1462 extern void inode_init_owner(struct inode *inode, const struct inode *dir,
1463 umode_t mode);
1464 /*
1465 * VFS FS_IOC_FIEMAP helper definitions.
1466 */
1467 struct fiemap_extent_info {
1468 unsigned int fi_flags; /* Flags as passed from user */
1469 unsigned int fi_extents_mapped; /* Number of mapped extents */
1470 unsigned int fi_extents_max; /* Size of fiemap_extent array */
1471 struct fiemap_extent __user *fi_extents_start; /* Start of
1472 fiemap_extent array */
1473 };
1474 int fiemap_fill_next_extent(struct fiemap_extent_info *info, u64 logical,
1475 u64 phys, u64 len, u32 flags);
1476 int fiemap_check_flags(struct fiemap_extent_info *fieinfo, u32 fs_flags);
1477
1478 /*
1479 * File types
1480 *
1481 * NOTE! These match bits 12..15 of stat.st_mode
1482 * (ie "(i_mode >> 12) & 15").
1483 */
1484 #define DT_UNKNOWN 0
1485 #define DT_FIFO 1
1486 #define DT_CHR 2
1487 #define DT_DIR 4
1488 #define DT_BLK 6
1489 #define DT_REG 8
1490 #define DT_LNK 10
1491 #define DT_SOCK 12
1492 #define DT_WHT 14
1493
1494 /*
1495 * This is the "filldir" function type, used by readdir() to let
1496 * the kernel specify what kind of dirent layout it wants to have.
1497 * This allows the kernel to read directories into kernel space or
1498 * to have different dirent layouts depending on the binary type.
1499 */
1500 struct dir_context;
1501 typedef int (*filldir_t)(struct dir_context *, const char *, int, loff_t, u64,
1502 unsigned);
1503
1504 struct dir_context {
1505 const filldir_t actor;
1506 loff_t pos;
1507 };
1508
1509 struct block_device_operations;
1510
1511 /* These macros are for out of kernel modules to test that
1512 * the kernel supports the unlocked_ioctl and compat_ioctl
1513 * fields in struct file_operations. */
1514 #define HAVE_COMPAT_IOCTL 1
1515 #define HAVE_UNLOCKED_IOCTL 1
1516
1517 struct iov_iter;
1518
1519 struct file_operations {
1520 struct module *owner;
1521 loff_t (*llseek) (struct file *, loff_t, int);
1522 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1523 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1524 ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
1525 ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
1526 ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
1527 ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
1528 int (*iterate) (struct file *, struct dir_context *);
1529 unsigned int (*poll) (struct file *, struct poll_table_struct *);
1530 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1531 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1532 int (*mmap) (struct file *, struct vm_area_struct *);
1533 void (*mremap)(struct file *, struct vm_area_struct *);
1534 int (*open) (struct inode *, struct file *);
1535 int (*flush) (struct file *, fl_owner_t id);
1536 int (*release) (struct inode *, struct file *);
1537 int (*fsync) (struct file *, loff_t, loff_t, int datasync);
1538 int (*aio_fsync) (struct kiocb *, int datasync);
1539 int (*fasync) (int, struct file *, int);
1540 int (*lock) (struct file *, int, struct file_lock *);
1541 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1542 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1543 int (*check_flags)(int);
1544 int (*flock) (struct file *, int, struct file_lock *);
1545 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int);
1546 ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int);
1547 int (*setlease)(struct file *, long, struct file_lock **, void **);
1548 long (*fallocate)(struct file *file, int mode, loff_t offset,
1549 loff_t len);
1550 void (*show_fdinfo)(struct seq_file *m, struct file *f);
1551 };
1552
1553 struct inode_operations {
1554 struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1555 void * (*follow_link) (struct dentry *, struct nameidata *);
1556 int (*permission) (struct inode *, int);
1557 struct posix_acl * (*get_acl)(struct inode *, int);
1558
1559 int (*readlink) (struct dentry *, char __user *,int);
1560 void (*put_link) (struct dentry *, struct nameidata *, void *);
1561
1562 int (*create) (struct inode *,struct dentry *, umode_t, bool);
1563 int (*link) (struct dentry *,struct inode *,struct dentry *);
1564 int (*unlink) (struct inode *,struct dentry *);
1565 int (*symlink) (struct inode *,struct dentry *,const char *);
1566 int (*mkdir) (struct inode *,struct dentry *,umode_t);
1567 int (*rmdir) (struct inode *,struct dentry *);
1568 int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1569 int (*rename) (struct inode *, struct dentry *,
1570 struct inode *, struct dentry *);
1571 int (*rename2) (struct inode *, struct dentry *,
1572 struct inode *, struct dentry *, unsigned int);
1573 int (*setattr) (struct dentry *, struct iattr *);
1574 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1575 int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
1576 ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
1577 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1578 int (*removexattr) (struct dentry *, const char *);
1579 int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start,
1580 u64 len);
1581 int (*update_time)(struct inode *, struct timespec *, int);
1582 int (*atomic_open)(struct inode *, struct dentry *,
1583 struct file *, unsigned open_flag,
1584 umode_t create_mode, int *opened);
1585 int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1586 int (*set_acl)(struct inode *, struct posix_acl *, int);
1587
1588 /* WARNING: probably going away soon, do not use! */
1589 int (*dentry_open)(struct dentry *, struct file *, const struct cred *);
1590 } ____cacheline_aligned;
1591
1592 ssize_t rw_copy_check_uvector(int type, const struct iovec __user * uvector,
1593 unsigned long nr_segs, unsigned long fast_segs,
1594 struct iovec *fast_pointer,
1595 struct iovec **ret_pointer);
1596
1597 extern ssize_t __vfs_read(struct file *, char __user *, size_t, loff_t *);
1598 extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1599 extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1600 extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1601 unsigned long, loff_t *);
1602 extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1603 unsigned long, loff_t *);
1604
1605 struct super_operations {
1606 struct inode *(*alloc_inode)(struct super_block *sb);
1607 void (*destroy_inode)(struct inode *);
1608
1609 void (*dirty_inode) (struct inode *, int flags);
1610 int (*write_inode) (struct inode *, struct writeback_control *wbc);
1611 int (*drop_inode) (struct inode *);
1612 void (*evict_inode) (struct inode *);
1613 void (*put_super) (struct super_block *);
1614 int (*sync_fs)(struct super_block *sb, int wait);
1615 int (*freeze_super) (struct super_block *);
1616 int (*freeze_fs) (struct super_block *);
1617 int (*thaw_super) (struct super_block *);
1618 int (*unfreeze_fs) (struct super_block *);
1619 int (*statfs) (struct dentry *, struct kstatfs *);
1620 int (*remount_fs) (struct super_block *, int *, char *);
1621 void (*umount_begin) (struct super_block *);
1622
1623 int (*show_options)(struct seq_file *, struct dentry *);
1624 int (*show_devname)(struct seq_file *, struct dentry *);
1625 int (*show_path)(struct seq_file *, struct dentry *);
1626 int (*show_stats)(struct seq_file *, struct dentry *);
1627 #ifdef CONFIG_QUOTA
1628 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1629 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1630 struct dquot **(*get_dquots)(struct inode *);
1631 #endif
1632 int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1633 long (*nr_cached_objects)(struct super_block *, int);
1634 long (*free_cached_objects)(struct super_block *, long, int);
1635 };
1636
1637 /*
1638 * Inode flags - they have no relation to superblock flags now
1639 */
1640 #define S_SYNC 1 /* Writes are synced at once */
1641 #define S_NOATIME 2 /* Do not update access times */
1642 #define S_APPEND 4 /* Append-only file */
1643 #define S_IMMUTABLE 8 /* Immutable file */
1644 #define S_DEAD 16 /* removed, but still open directory */
1645 #define S_NOQUOTA 32 /* Inode is not counted to quota */
1646 #define S_DIRSYNC 64 /* Directory modifications are synchronous */
1647 #define S_NOCMTIME 128 /* Do not update file c/mtime */
1648 #define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
1649 #define S_PRIVATE 512 /* Inode is fs-internal */
1650 #define S_IMA 1024 /* Inode has an associated IMA struct */
1651 #define S_AUTOMOUNT 2048 /* Automount/referral quasi-directory */
1652 #define S_NOSEC 4096 /* no suid or xattr security attributes */
1653
1654 /*
1655 * Note that nosuid etc flags are inode-specific: setting some file-system
1656 * flags just means all the inodes inherit those flags by default. It might be
1657 * possible to override it selectively if you really wanted to with some
1658 * ioctl() that is not currently implemented.
1659 *
1660 * Exception: MS_RDONLY is always applied to the entire file system.
1661 *
1662 * Unfortunately, it is possible to change a filesystems flags with it mounted
1663 * with files in use. This means that all of the inodes will not have their
1664 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
1665 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
1666 */
1667 #define __IS_FLG(inode, flg) ((inode)->i_sb->s_flags & (flg))
1668
1669 #define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
1670 #define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
1671 ((inode)->i_flags & S_SYNC))
1672 #define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
1673 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
1674 #define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
1675 #define IS_NOATIME(inode) __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
1676 #define IS_I_VERSION(inode) __IS_FLG(inode, MS_I_VERSION)
1677
1678 #define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
1679 #define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
1680 #define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
1681 #define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
1682
1683 #define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
1684 #define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
1685 #define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
1686 #define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
1687 #define IS_IMA(inode) ((inode)->i_flags & S_IMA)
1688 #define IS_AUTOMOUNT(inode) ((inode)->i_flags & S_AUTOMOUNT)
1689 #define IS_NOSEC(inode) ((inode)->i_flags & S_NOSEC)
1690
1691 #define IS_WHITEOUT(inode) (S_ISCHR(inode->i_mode) && \
1692 (inode)->i_rdev == WHITEOUT_DEV)
1693
1694 /*
1695 * Inode state bits. Protected by inode->i_lock
1696 *
1697 * Three bits determine the dirty state of the inode, I_DIRTY_SYNC,
1698 * I_DIRTY_DATASYNC and I_DIRTY_PAGES.
1699 *
1700 * Four bits define the lifetime of an inode. Initially, inodes are I_NEW,
1701 * until that flag is cleared. I_WILL_FREE, I_FREEING and I_CLEAR are set at
1702 * various stages of removing an inode.
1703 *
1704 * Two bits are used for locking and completion notification, I_NEW and I_SYNC.
1705 *
1706 * I_DIRTY_SYNC Inode is dirty, but doesn't have to be written on
1707 * fdatasync(). i_atime is the usual cause.
1708 * I_DIRTY_DATASYNC Data-related inode changes pending. We keep track of
1709 * these changes separately from I_DIRTY_SYNC so that we
1710 * don't have to write inode on fdatasync() when only
1711 * mtime has changed in it.
1712 * I_DIRTY_PAGES Inode has dirty pages. Inode itself may be clean.
1713 * I_NEW Serves as both a mutex and completion notification.
1714 * New inodes set I_NEW. If two processes both create
1715 * the same inode, one of them will release its inode and
1716 * wait for I_NEW to be released before returning.
1717 * Inodes in I_WILL_FREE, I_FREEING or I_CLEAR state can
1718 * also cause waiting on I_NEW, without I_NEW actually
1719 * being set. find_inode() uses this to prevent returning
1720 * nearly-dead inodes.
1721 * I_WILL_FREE Must be set when calling write_inode_now() if i_count
1722 * is zero. I_FREEING must be set when I_WILL_FREE is
1723 * cleared.
1724 * I_FREEING Set when inode is about to be freed but still has dirty
1725 * pages or buffers attached or the inode itself is still
1726 * dirty.
1727 * I_CLEAR Added by clear_inode(). In this state the inode is
1728 * clean and can be destroyed. Inode keeps I_FREEING.
1729 *
1730 * Inodes that are I_WILL_FREE, I_FREEING or I_CLEAR are
1731 * prohibited for many purposes. iget() must wait for
1732 * the inode to be completely released, then create it
1733 * anew. Other functions will just ignore such inodes,
1734 * if appropriate. I_NEW is used for waiting.
1735 *
1736 * I_SYNC Writeback of inode is running. The bit is set during
1737 * data writeback, and cleared with a wakeup on the bit
1738 * address once it is done. The bit is also used to pin
1739 * the inode in memory for flusher thread.
1740 *
1741 * I_REFERENCED Marks the inode as recently references on the LRU list.
1742 *
1743 * I_DIO_WAKEUP Never set. Only used as a key for wait_on_bit().
1744 *
1745 * Q: What is the difference between I_WILL_FREE and I_FREEING?
1746 */
1747 #define I_DIRTY_SYNC (1 << 0)
1748 #define I_DIRTY_DATASYNC (1 << 1)
1749 #define I_DIRTY_PAGES (1 << 2)
1750 #define __I_NEW 3
1751 #define I_NEW (1 << __I_NEW)
1752 #define I_WILL_FREE (1 << 4)
1753 #define I_FREEING (1 << 5)
1754 #define I_CLEAR (1 << 6)
1755 #define __I_SYNC 7
1756 #define I_SYNC (1 << __I_SYNC)
1757 #define I_REFERENCED (1 << 8)
1758 #define __I_DIO_WAKEUP 9
1759 #define I_DIO_WAKEUP (1 << I_DIO_WAKEUP)
1760 #define I_LINKABLE (1 << 10)
1761
1762 #define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
1763
1764 extern void __mark_inode_dirty(struct inode *, int);
1765 static inline void mark_inode_dirty(struct inode *inode)
1766 {
1767 __mark_inode_dirty(inode, I_DIRTY);
1768 }
1769
1770 static inline void mark_inode_dirty_sync(struct inode *inode)
1771 {
1772 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1773 }
1774
1775 extern void inc_nlink(struct inode *inode);
1776 extern void drop_nlink(struct inode *inode);
1777 extern void clear_nlink(struct inode *inode);
1778 extern void set_nlink(struct inode *inode, unsigned int nlink);
1779
1780 static inline void inode_inc_link_count(struct inode *inode)
1781 {
1782 inc_nlink(inode);
1783 mark_inode_dirty(inode);
1784 }
1785
1786 static inline void inode_dec_link_count(struct inode *inode)
1787 {
1788 drop_nlink(inode);
1789 mark_inode_dirty(inode);
1790 }
1791
1792 /**
1793 * inode_inc_iversion - increments i_version
1794 * @inode: inode that need to be updated
1795 *
1796 * Every time the inode is modified, the i_version field will be incremented.
1797 * The filesystem has to be mounted with i_version flag
1798 */
1799
1800 static inline void inode_inc_iversion(struct inode *inode)
1801 {
1802 spin_lock(&inode->i_lock);
1803 inode->i_version++;
1804 spin_unlock(&inode->i_lock);
1805 }
1806
1807 enum file_time_flags {
1808 S_ATIME = 1,
1809 S_MTIME = 2,
1810 S_CTIME = 4,
1811 S_VERSION = 8,
1812 };
1813
1814 extern void touch_atime(const struct path *);
1815 static inline void file_accessed(struct file *file)
1816 {
1817 if (!(file->f_flags & O_NOATIME))
1818 touch_atime(&file->f_path);
1819 }
1820
1821 int sync_inode(struct inode *inode, struct writeback_control *wbc);
1822 int sync_inode_metadata(struct inode *inode, int wait);
1823
1824 struct file_system_type {
1825 const char *name;
1826 int fs_flags;
1827 #define FS_REQUIRES_DEV 1
1828 #define FS_BINARY_MOUNTDATA 2
1829 #define FS_HAS_SUBTYPE 4
1830 #define FS_USERNS_MOUNT 8 /* Can be mounted by userns root */
1831 #define FS_USERNS_DEV_MOUNT 16 /* A userns mount does not imply MNT_NODEV */
1832 #define FS_RENAME_DOES_D_MOVE 32768 /* FS will handle d_move() during rename() internally. */
1833 struct dentry *(*mount) (struct file_system_type *, int,
1834 const char *, void *);
1835 void (*kill_sb) (struct super_block *);
1836 struct module *owner;
1837 struct file_system_type * next;
1838 struct hlist_head fs_supers;
1839
1840 struct lock_class_key s_lock_key;
1841 struct lock_class_key s_umount_key;
1842 struct lock_class_key s_vfs_rename_key;
1843 struct lock_class_key s_writers_key[SB_FREEZE_LEVELS];
1844
1845 struct lock_class_key i_lock_key;
1846 struct lock_class_key i_mutex_key;
1847 struct lock_class_key i_mutex_dir_key;
1848 };
1849
1850 #define MODULE_ALIAS_FS(NAME) MODULE_ALIAS("fs-" NAME)
1851
1852 extern struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
1853 void *data, int (*fill_super)(struct super_block *, void *, int));
1854 extern struct dentry *mount_bdev(struct file_system_type *fs_type,
1855 int flags, const char *dev_name, void *data,
1856 int (*fill_super)(struct super_block *, void *, int));
1857 extern struct dentry *mount_single(struct file_system_type *fs_type,
1858 int flags, void *data,
1859 int (*fill_super)(struct super_block *, void *, int));
1860 extern struct dentry *mount_nodev(struct file_system_type *fs_type,
1861 int flags, void *data,
1862 int (*fill_super)(struct super_block *, void *, int));
1863 extern struct dentry *mount_subtree(struct vfsmount *mnt, const char *path);
1864 void generic_shutdown_super(struct super_block *sb);
1865 void kill_block_super(struct super_block *sb);
1866 void kill_anon_super(struct super_block *sb);
1867 void kill_litter_super(struct super_block *sb);
1868 void deactivate_super(struct super_block *sb);
1869 void deactivate_locked_super(struct super_block *sb);
1870 int set_anon_super(struct super_block *s, void *data);
1871 int get_anon_bdev(dev_t *);
1872 void free_anon_bdev(dev_t);
1873 struct super_block *sget(struct file_system_type *type,
1874 int (*test)(struct super_block *,void *),
1875 int (*set)(struct super_block *,void *),
1876 int flags, void *data);
1877 extern struct dentry *mount_pseudo(struct file_system_type *, char *,
1878 const struct super_operations *ops,
1879 const struct dentry_operations *dops,
1880 unsigned long);
1881
1882 /* Alas, no aliases. Too much hassle with bringing module.h everywhere */
1883 #define fops_get(fops) \
1884 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
1885 #define fops_put(fops) \
1886 do { if (fops) module_put((fops)->owner); } while(0)
1887 /*
1888 * This one is to be used *ONLY* from ->open() instances.
1889 * fops must be non-NULL, pinned down *and* module dependencies
1890 * should be sufficient to pin the caller down as well.
1891 */
1892 #define replace_fops(f, fops) \
1893 do { \
1894 struct file *__file = (f); \
1895 fops_put(__file->f_op); \
1896 BUG_ON(!(__file->f_op = (fops))); \
1897 } while(0)
1898
1899 extern int register_filesystem(struct file_system_type *);
1900 extern int unregister_filesystem(struct file_system_type *);
1901 extern struct vfsmount *kern_mount_data(struct file_system_type *, void *data);
1902 #define kern_mount(type) kern_mount_data(type, NULL)
1903 extern void kern_unmount(struct vfsmount *mnt);
1904 extern int may_umount_tree(struct vfsmount *);
1905 extern int may_umount(struct vfsmount *);
1906 extern long do_mount(const char *, const char __user *,
1907 const char *, unsigned long, void *);
1908 extern struct vfsmount *collect_mounts(struct path *);
1909 extern void drop_collected_mounts(struct vfsmount *);
1910 extern int iterate_mounts(int (*)(struct vfsmount *, void *), void *,
1911 struct vfsmount *);
1912 extern int vfs_statfs(struct path *, struct kstatfs *);
1913 extern int user_statfs(const char __user *, struct kstatfs *);
1914 extern int fd_statfs(int, struct kstatfs *);
1915 extern int vfs_ustat(dev_t, struct kstatfs *);
1916 extern int freeze_super(struct super_block *super);
1917 extern int thaw_super(struct super_block *super);
1918 extern bool our_mnt(struct vfsmount *mnt);
1919 extern bool fs_fully_visible(struct file_system_type *);
1920
1921 extern int current_umask(void);
1922
1923 extern void ihold(struct inode * inode);
1924 extern void iput(struct inode *);
1925
1926 static inline struct inode *file_inode(const struct file *f)
1927 {
1928 return f->f_inode;
1929 }
1930
1931 /* /sys/fs */
1932 extern struct kobject *fs_kobj;
1933
1934 #define MAX_RW_COUNT (INT_MAX & PAGE_CACHE_MASK)
1935
1936 #define FLOCK_VERIFY_READ 1
1937 #define FLOCK_VERIFY_WRITE 2
1938
1939 #ifdef CONFIG_FILE_LOCKING
1940 extern int locks_mandatory_locked(struct file *);
1941 extern int locks_mandatory_area(int, struct inode *, struct file *, loff_t, size_t);
1942
1943 /*
1944 * Candidates for mandatory locking have the setgid bit set
1945 * but no group execute bit - an otherwise meaningless combination.
1946 */
1947
1948 static inline int __mandatory_lock(struct inode *ino)
1949 {
1950 return (ino->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID;
1951 }
1952
1953 /*
1954 * ... and these candidates should be on MS_MANDLOCK mounted fs,
1955 * otherwise these will be advisory locks
1956 */
1957
1958 static inline int mandatory_lock(struct inode *ino)
1959 {
1960 return IS_MANDLOCK(ino) && __mandatory_lock(ino);
1961 }
1962
1963 static inline int locks_verify_locked(struct file *file)
1964 {
1965 if (mandatory_lock(file_inode(file)))
1966 return locks_mandatory_locked(file);
1967 return 0;
1968 }
1969
1970 static inline int locks_verify_truncate(struct inode *inode,
1971 struct file *filp,
1972 loff_t size)
1973 {
1974 if (inode->i_flock && mandatory_lock(inode))
1975 return locks_mandatory_area(
1976 FLOCK_VERIFY_WRITE, inode, filp,
1977 size < inode->i_size ? size : inode->i_size,
1978 (size < inode->i_size ? inode->i_size - size
1979 : size - inode->i_size)
1980 );
1981 return 0;
1982 }
1983
1984 static inline int break_lease(struct inode *inode, unsigned int mode)
1985 {
1986 /*
1987 * Since this check is lockless, we must ensure that any refcounts
1988 * taken are done before checking inode->i_flock. Otherwise, we could
1989 * end up racing with tasks trying to set a new lease on this file.
1990 */
1991 smp_mb();
1992 if (inode->i_flock)
1993 return __break_lease(inode, mode, FL_LEASE);
1994 return 0;
1995 }
1996
1997 static inline int break_deleg(struct inode *inode, unsigned int mode)
1998 {
1999 /*
2000 * Since this check is lockless, we must ensure that any refcounts
2001 * taken are done before checking inode->i_flock. Otherwise, we could
2002 * end up racing with tasks trying to set a new lease on this file.
2003 */
2004 smp_mb();
2005 if (inode->i_flock)
2006 return __break_lease(inode, mode, FL_DELEG);
2007 return 0;
2008 }
2009
2010 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2011 {
2012 int ret;
2013
2014 ret = break_deleg(inode, O_WRONLY|O_NONBLOCK);
2015 if (ret == -EWOULDBLOCK && delegated_inode) {
2016 *delegated_inode = inode;
2017 ihold(inode);
2018 }
2019 return ret;
2020 }
2021
2022 static inline int break_deleg_wait(struct inode **delegated_inode)
2023 {
2024 int ret;
2025
2026 ret = break_deleg(*delegated_inode, O_WRONLY);
2027 iput(*delegated_inode);
2028 *delegated_inode = NULL;
2029 return ret;
2030 }
2031
2032 #else /* !CONFIG_FILE_LOCKING */
2033 static inline int locks_mandatory_locked(struct file *file)
2034 {
2035 return 0;
2036 }
2037
2038 static inline int locks_mandatory_area(int rw, struct inode *inode,
2039 struct file *filp, loff_t offset,
2040 size_t count)
2041 {
2042 return 0;
2043 }
2044
2045 static inline int __mandatory_lock(struct inode *inode)
2046 {
2047 return 0;
2048 }
2049
2050 static inline int mandatory_lock(struct inode *inode)
2051 {
2052 return 0;
2053 }
2054
2055 static inline int locks_verify_locked(struct file *file)
2056 {
2057 return 0;
2058 }
2059
2060 static inline int locks_verify_truncate(struct inode *inode, struct file *filp,
2061 size_t size)
2062 {
2063 return 0;
2064 }
2065
2066 static inline int break_lease(struct inode *inode, unsigned int mode)
2067 {
2068 return 0;
2069 }
2070
2071 static inline int break_deleg(struct inode *inode, unsigned int mode)
2072 {
2073 return 0;
2074 }
2075
2076 static inline int try_break_deleg(struct inode *inode, struct inode **delegated_inode)
2077 {
2078 return 0;
2079 }
2080
2081 static inline int break_deleg_wait(struct inode **delegated_inode)
2082 {
2083 BUG();
2084 return 0;
2085 }
2086
2087 #endif /* CONFIG_FILE_LOCKING */
2088
2089 /* fs/open.c */
2090 struct audit_names;
2091 struct filename {
2092 const char *name; /* pointer to actual string */
2093 const __user char *uptr; /* original userland pointer */
2094 struct audit_names *aname;
2095 bool separate; /* should "name" be freed? */
2096 };
2097
2098 extern long vfs_truncate(struct path *, loff_t);
2099 extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
2100 struct file *filp);
2101 extern int vfs_fallocate(struct file *file, int mode, loff_t offset,
2102 loff_t len);
2103 extern long do_sys_open(int dfd, const char __user *filename, int flags,
2104 umode_t mode);
2105 extern struct file *file_open_name(struct filename *, int, umode_t);
2106 extern struct file *filp_open(const char *, int, umode_t);
2107 extern struct file *file_open_root(struct dentry *, struct vfsmount *,
2108 const char *, int);
2109 extern int vfs_open(const struct path *, struct file *, const struct cred *);
2110 extern struct file * dentry_open(const struct path *, int, const struct cred *);
2111 extern int filp_close(struct file *, fl_owner_t id);
2112
2113 extern struct filename *getname_flags(const char __user *, int, int *);
2114 extern struct filename *getname(const char __user *);
2115 extern struct filename *getname_kernel(const char *);
2116
2117 enum {
2118 FILE_CREATED = 1,
2119 FILE_OPENED = 2
2120 };
2121 extern int finish_open(struct file *file, struct dentry *dentry,
2122 int (*open)(struct inode *, struct file *),
2123 int *opened);
2124 extern int finish_no_open(struct file *file, struct dentry *dentry);
2125
2126 /* fs/ioctl.c */
2127
2128 extern int ioctl_preallocate(struct file *filp, void __user *argp);
2129
2130 /* fs/dcache.c */
2131 extern void __init vfs_caches_init_early(void);
2132 extern void __init vfs_caches_init(unsigned long);
2133
2134 extern struct kmem_cache *names_cachep;
2135
2136 extern void final_putname(struct filename *name);
2137
2138 #define __getname() kmem_cache_alloc(names_cachep, GFP_KERNEL)
2139 #define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
2140 #ifndef CONFIG_AUDITSYSCALL
2141 #define putname(name) final_putname(name)
2142 #else
2143 extern void putname(struct filename *name);
2144 #endif
2145
2146 #ifdef CONFIG_BLOCK
2147 extern int register_blkdev(unsigned int, const char *);
2148 extern void unregister_blkdev(unsigned int, const char *);
2149 extern struct block_device *bdget(dev_t);
2150 extern struct block_device *bdgrab(struct block_device *bdev);
2151 extern void bd_set_size(struct block_device *, loff_t size);
2152 extern void bd_forget(struct inode *inode);
2153 extern void bdput(struct block_device *);
2154 extern void invalidate_bdev(struct block_device *);
2155 extern void iterate_bdevs(void (*)(struct block_device *, void *), void *);
2156 extern int sync_blockdev(struct block_device *bdev);
2157 extern void kill_bdev(struct block_device *);
2158 extern struct super_block *freeze_bdev(struct block_device *);
2159 extern void emergency_thaw_all(void);
2160 extern int thaw_bdev(struct block_device *bdev, struct super_block *sb);
2161 extern int fsync_bdev(struct block_device *);
2162 extern int sb_is_blkdev_sb(struct super_block *sb);
2163 #else
2164 static inline void bd_forget(struct inode *inode) {}
2165 static inline int sync_blockdev(struct block_device *bdev) { return 0; }
2166 static inline void kill_bdev(struct block_device *bdev) {}
2167 static inline void invalidate_bdev(struct block_device *bdev) {}
2168
2169 static inline struct super_block *freeze_bdev(struct block_device *sb)
2170 {
2171 return NULL;
2172 }
2173
2174 static inline int thaw_bdev(struct block_device *bdev, struct super_block *sb)
2175 {
2176 return 0;
2177 }
2178
2179 static inline void iterate_bdevs(void (*f)(struct block_device *, void *), void *arg)
2180 {
2181 }
2182
2183 static inline int sb_is_blkdev_sb(struct super_block *sb)
2184 {
2185 return 0;
2186 }
2187 #endif
2188 extern int sync_filesystem(struct super_block *);
2189 extern const struct file_operations def_blk_fops;
2190 extern const struct file_operations def_chr_fops;
2191 #ifdef CONFIG_BLOCK
2192 extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
2193 extern int blkdev_ioctl(struct block_device *, fmode_t, unsigned, unsigned long);
2194 extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
2195 extern int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder);
2196 extern struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
2197 void *holder);
2198 extern struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode,
2199 void *holder);
2200 extern void blkdev_put(struct block_device *bdev, fmode_t mode);
2201 #ifdef CONFIG_SYSFS
2202 extern int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk);
2203 extern void bd_unlink_disk_holder(struct block_device *bdev,
2204 struct gendisk *disk);
2205 #else
2206 static inline int bd_link_disk_holder(struct block_device *bdev,
2207 struct gendisk *disk)
2208 {
2209 return 0;
2210 }
2211 static inline void bd_unlink_disk_holder(struct block_device *bdev,
2212 struct gendisk *disk)
2213 {
2214 }
2215 #endif
2216 #endif
2217
2218 /* fs/char_dev.c */
2219 #define CHRDEV_MAJOR_HASH_SIZE 255
2220 extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
2221 extern int register_chrdev_region(dev_t, unsigned, const char *);
2222 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
2223 unsigned int count, const char *name,
2224 const struct file_operations *fops);
2225 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
2226 unsigned int count, const char *name);
2227 extern void unregister_chrdev_region(dev_t, unsigned);
2228 extern void chrdev_show(struct seq_file *,off_t);
2229
2230 static inline int register_chrdev(unsigned int major, const char *name,
2231 const struct file_operations *fops)
2232 {
2233 return __register_chrdev(major, 0, 256, name, fops);
2234 }
2235
2236 static inline void unregister_chrdev(unsigned int major, const char *name)
2237 {
2238 __unregister_chrdev(major, 0, 256, name);
2239 }
2240
2241 /* fs/block_dev.c */
2242 #define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
2243 #define BDEVT_SIZE 10 /* Largest string for MAJ:MIN for blkdev */
2244
2245 #ifdef CONFIG_BLOCK
2246 #define BLKDEV_MAJOR_HASH_SIZE 255
2247 extern const char *__bdevname(dev_t, char *buffer);
2248 extern const char *bdevname(struct block_device *bdev, char *buffer);
2249 extern struct block_device *lookup_bdev(const char *);
2250 extern void blkdev_show(struct seq_file *,off_t);
2251
2252 #else
2253 #define BLKDEV_MAJOR_HASH_SIZE 0
2254 #endif
2255
2256 extern void init_special_inode(struct inode *, umode_t, dev_t);
2257
2258 /* Invalid inode operations -- fs/bad_inode.c */
2259 extern void make_bad_inode(struct inode *);
2260 extern int is_bad_inode(struct inode *);
2261
2262 #ifdef CONFIG_BLOCK
2263 /*
2264 * return READ, READA, or WRITE
2265 */
2266 #define bio_rw(bio) ((bio)->bi_rw & (RW_MASK | RWA_MASK))
2267
2268 /*
2269 * return data direction, READ or WRITE
2270 */
2271 #define bio_data_dir(bio) ((bio)->bi_rw & 1)
2272
2273 extern void check_disk_size_change(struct gendisk *disk,
2274 struct block_device *bdev);
2275 extern int revalidate_disk(struct gendisk *);
2276 extern int check_disk_change(struct block_device *);
2277 extern int __invalidate_device(struct block_device *, bool);
2278 extern int invalidate_partition(struct gendisk *, int);
2279 #endif
2280 unsigned long invalidate_mapping_pages(struct address_space *mapping,
2281 pgoff_t start, pgoff_t end);
2282
2283 static inline void invalidate_remote_inode(struct inode *inode)
2284 {
2285 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
2286 S_ISLNK(inode->i_mode))
2287 invalidate_mapping_pages(inode->i_mapping, 0, -1);
2288 }
2289 extern int invalidate_inode_pages2(struct address_space *mapping);
2290 extern int invalidate_inode_pages2_range(struct address_space *mapping,
2291 pgoff_t start, pgoff_t end);
2292 extern int write_inode_now(struct inode *, int);
2293 extern int filemap_fdatawrite(struct address_space *);
2294 extern int filemap_flush(struct address_space *);
2295 extern int filemap_fdatawait(struct address_space *);
2296 extern int filemap_fdatawait_range(struct address_space *, loff_t lstart,
2297 loff_t lend);
2298 extern int filemap_write_and_wait(struct address_space *mapping);
2299 extern int filemap_write_and_wait_range(struct address_space *mapping,
2300 loff_t lstart, loff_t lend);
2301 extern int __filemap_fdatawrite_range(struct address_space *mapping,
2302 loff_t start, loff_t end, int sync_mode);
2303 extern int filemap_fdatawrite_range(struct address_space *mapping,
2304 loff_t start, loff_t end);
2305
2306 extern int vfs_fsync_range(struct file *file, loff_t start, loff_t end,
2307 int datasync);
2308 extern int vfs_fsync(struct file *file, int datasync);
2309 static inline int generic_write_sync(struct file *file, loff_t pos, loff_t count)
2310 {
2311 if (!(file->f_flags & O_DSYNC) && !IS_SYNC(file->f_mapping->host))
2312 return 0;
2313 return vfs_fsync_range(file, pos, pos + count - 1,
2314 (file->f_flags & __O_SYNC) ? 0 : 1);
2315 }
2316 extern void emergency_sync(void);
2317 extern void emergency_remount(void);
2318 #ifdef CONFIG_BLOCK
2319 extern sector_t bmap(struct inode *, sector_t);
2320 #endif
2321 extern int notify_change(struct dentry *, struct iattr *, struct inode **);
2322 extern int inode_permission(struct inode *, int);
2323 extern int __inode_permission(struct inode *, int);
2324 extern int generic_permission(struct inode *, int);
2325 extern int __check_sticky(struct inode *dir, struct inode *inode);
2326
2327 static inline bool execute_ok(struct inode *inode)
2328 {
2329 return (inode->i_mode & S_IXUGO) || S_ISDIR(inode->i_mode);
2330 }
2331
2332 static inline void file_start_write(struct file *file)
2333 {
2334 if (!S_ISREG(file_inode(file)->i_mode))
2335 return;
2336 __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, true);
2337 }
2338
2339 static inline bool file_start_write_trylock(struct file *file)
2340 {
2341 if (!S_ISREG(file_inode(file)->i_mode))
2342 return true;
2343 return __sb_start_write(file_inode(file)->i_sb, SB_FREEZE_WRITE, false);
2344 }
2345
2346 static inline void file_end_write(struct file *file)
2347 {
2348 if (!S_ISREG(file_inode(file)->i_mode))
2349 return;
2350 __sb_end_write(file_inode(file)->i_sb, SB_FREEZE_WRITE);
2351 }
2352
2353 /*
2354 * get_write_access() gets write permission for a file.
2355 * put_write_access() releases this write permission.
2356 * This is used for regular files.
2357 * We cannot support write (and maybe mmap read-write shared) accesses and
2358 * MAP_DENYWRITE mmappings simultaneously. The i_writecount field of an inode
2359 * can have the following values:
2360 * 0: no writers, no VM_DENYWRITE mappings
2361 * < 0: (-i_writecount) vm_area_structs with VM_DENYWRITE set exist
2362 * > 0: (i_writecount) users are writing to the file.
2363 *
2364 * Normally we operate on that counter with atomic_{inc,dec} and it's safe
2365 * except for the cases where we don't hold i_writecount yet. Then we need to
2366 * use {get,deny}_write_access() - these functions check the sign and refuse
2367 * to do the change if sign is wrong.
2368 */
2369 static inline int get_write_access(struct inode *inode)
2370 {
2371 return atomic_inc_unless_negative(&inode->i_writecount) ? 0 : -ETXTBSY;
2372 }
2373 static inline int deny_write_access(struct file *file)
2374 {
2375 struct inode *inode = file_inode(file);
2376 return atomic_dec_unless_positive(&inode->i_writecount) ? 0 : -ETXTBSY;
2377 }
2378 static inline void put_write_access(struct inode * inode)
2379 {
2380 atomic_dec(&inode->i_writecount);
2381 }
2382 static inline void allow_write_access(struct file *file)
2383 {
2384 if (file)
2385 atomic_inc(&file_inode(file)->i_writecount);
2386 }
2387 static inline bool inode_is_open_for_write(const struct inode *inode)
2388 {
2389 return atomic_read(&inode->i_writecount) > 0;
2390 }
2391
2392 #ifdef CONFIG_IMA
2393 static inline void i_readcount_dec(struct inode *inode)
2394 {
2395 BUG_ON(!atomic_read(&inode->i_readcount));
2396 atomic_dec(&inode->i_readcount);
2397 }
2398 static inline void i_readcount_inc(struct inode *inode)
2399 {
2400 atomic_inc(&inode->i_readcount);
2401 }
2402 #else
2403 static inline void i_readcount_dec(struct inode *inode)
2404 {
2405 return;
2406 }
2407 static inline void i_readcount_inc(struct inode *inode)
2408 {
2409 return;
2410 }
2411 #endif
2412 extern int do_pipe_flags(int *, int);
2413
2414 extern int kernel_read(struct file *, loff_t, char *, unsigned long);
2415 extern ssize_t kernel_write(struct file *, const char *, size_t, loff_t);
2416 extern ssize_t __kernel_write(struct file *, const char *, size_t, loff_t *);
2417 extern struct file * open_exec(const char *);
2418
2419 /* fs/dcache.c -- generic fs support functions */
2420 extern int is_subdir(struct dentry *, struct dentry *);
2421 extern int path_is_under(struct path *, struct path *);
2422
2423 #include <linux/err.h>
2424
2425 /* needed for stackable file system support */
2426 extern loff_t default_llseek(struct file *file, loff_t offset, int whence);
2427
2428 extern loff_t vfs_llseek(struct file *file, loff_t offset, int whence);
2429
2430 extern int inode_init_always(struct super_block *, struct inode *);
2431 extern void inode_init_once(struct inode *);
2432 extern void address_space_init_once(struct address_space *mapping);
2433 extern struct inode * igrab(struct inode *);
2434 extern ino_t iunique(struct super_block *, ino_t);
2435 extern int inode_needs_sync(struct inode *inode);
2436 extern int generic_delete_inode(struct inode *inode);
2437 static inline int generic_drop_inode(struct inode *inode)
2438 {
2439 return !inode->i_nlink || inode_unhashed(inode);
2440 }
2441
2442 extern struct inode *ilookup5_nowait(struct super_block *sb,
2443 unsigned long hashval, int (*test)(struct inode *, void *),
2444 void *data);
2445 extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
2446 int (*test)(struct inode *, void *), void *data);
2447 extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
2448
2449 extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
2450 extern struct inode * iget_locked(struct super_block *, unsigned long);
2451 extern int insert_inode_locked4(struct inode *, unsigned long, int (*test)(struct inode *, void *), void *);
2452 extern int insert_inode_locked(struct inode *);
2453 #ifdef CONFIG_DEBUG_LOCK_ALLOC
2454 extern void lockdep_annotate_inode_mutex_key(struct inode *inode);
2455 #else
2456 static inline void lockdep_annotate_inode_mutex_key(struct inode *inode) { };
2457 #endif
2458 extern void unlock_new_inode(struct inode *);
2459 extern unsigned int get_next_ino(void);
2460
2461 extern void __iget(struct inode * inode);
2462 extern void iget_failed(struct inode *);
2463 extern void clear_inode(struct inode *);
2464 extern void __destroy_inode(struct inode *);
2465 extern struct inode *new_inode_pseudo(struct super_block *sb);
2466 extern struct inode *new_inode(struct super_block *sb);
2467 extern void free_inode_nonrcu(struct inode *inode);
2468 extern int should_remove_suid(struct dentry *);
2469 extern int file_remove_suid(struct file *);
2470
2471 extern void __insert_inode_hash(struct inode *, unsigned long hashval);
2472 static inline void insert_inode_hash(struct inode *inode)
2473 {
2474 __insert_inode_hash(inode, inode->i_ino);
2475 }
2476
2477 extern void __remove_inode_hash(struct inode *);
2478 static inline void remove_inode_hash(struct inode *inode)
2479 {
2480 if (!inode_unhashed(inode))
2481 __remove_inode_hash(inode);
2482 }
2483
2484 extern void inode_sb_list_add(struct inode *inode);
2485
2486 #ifdef CONFIG_BLOCK
2487 extern void submit_bio(int, struct bio *);
2488 extern int bdev_read_only(struct block_device *);
2489 #endif
2490 extern int set_blocksize(struct block_device *, int);
2491 extern int sb_set_blocksize(struct super_block *, int);
2492 extern int sb_min_blocksize(struct super_block *, int);
2493
2494 extern int generic_file_mmap(struct file *, struct vm_area_struct *);
2495 extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
2496 extern int generic_file_remap_pages(struct vm_area_struct *, unsigned long addr,
2497 unsigned long size, pgoff_t pgoff);
2498 int generic_write_checks(struct file *file, loff_t *pos, size_t *count, int isblk);
2499 extern ssize_t generic_file_read_iter(struct kiocb *, struct iov_iter *);
2500 extern ssize_t __generic_file_write_iter(struct kiocb *, struct iov_iter *);
2501 extern ssize_t generic_file_write_iter(struct kiocb *, struct iov_iter *);
2502 extern ssize_t generic_file_direct_write(struct kiocb *, struct iov_iter *, loff_t);
2503 extern ssize_t generic_perform_write(struct file *, struct iov_iter *, loff_t);
2504 extern ssize_t do_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos);
2505 extern ssize_t do_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos);
2506 extern ssize_t new_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos);
2507 extern ssize_t new_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos);
2508
2509 /* fs/block_dev.c */
2510 extern ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to);
2511 extern ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from);
2512 extern int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
2513 int datasync);
2514 extern void block_sync_page(struct page *page);
2515
2516 /* fs/splice.c */
2517 extern ssize_t generic_file_splice_read(struct file *, loff_t *,
2518 struct pipe_inode_info *, size_t, unsigned int);
2519 extern ssize_t default_file_splice_read(struct file *, loff_t *,
2520 struct pipe_inode_info *, size_t, unsigned int);
2521 extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
2522 struct file *, loff_t *, size_t, unsigned int);
2523 extern ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe,
2524 struct file *out, loff_t *, size_t len, unsigned int flags);
2525 extern long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
2526 loff_t *opos, size_t len, unsigned int flags);
2527
2528
2529 extern void
2530 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
2531 extern loff_t noop_llseek(struct file *file, loff_t offset, int whence);
2532 extern loff_t no_llseek(struct file *file, loff_t offset, int whence);
2533 extern loff_t vfs_setpos(struct file *file, loff_t offset, loff_t maxsize);
2534 extern loff_t generic_file_llseek(struct file *file, loff_t offset, int whence);
2535 extern loff_t generic_file_llseek_size(struct file *file, loff_t offset,
2536 int whence, loff_t maxsize, loff_t eof);
2537 extern loff_t fixed_size_llseek(struct file *file, loff_t offset,
2538 int whence, loff_t size);
2539 extern int generic_file_open(struct inode * inode, struct file * filp);
2540 extern int nonseekable_open(struct inode * inode, struct file * filp);
2541
2542 #ifdef CONFIG_FS_XIP
2543 extern ssize_t xip_file_read(struct file *filp, char __user *buf, size_t len,
2544 loff_t *ppos);
2545 extern int xip_file_mmap(struct file * file, struct vm_area_struct * vma);
2546 extern ssize_t xip_file_write(struct file *filp, const char __user *buf,
2547 size_t len, loff_t *ppos);
2548 extern int xip_truncate_page(struct address_space *mapping, loff_t from);
2549 #else
2550 static inline int xip_truncate_page(struct address_space *mapping, loff_t from)
2551 {
2552 return 0;
2553 }
2554 #endif
2555
2556 #ifdef CONFIG_BLOCK
2557 typedef void (dio_submit_t)(int rw, struct bio *bio, struct inode *inode,
2558 loff_t file_offset);
2559
2560 enum {
2561 /* need locking between buffered and direct access */
2562 DIO_LOCKING = 0x01,
2563
2564 /* filesystem does not support filling holes */
2565 DIO_SKIP_HOLES = 0x02,
2566
2567 /* filesystem can handle aio writes beyond i_size */
2568 DIO_ASYNC_EXTEND = 0x04,
2569 };
2570
2571 void dio_end_io(struct bio *bio, int error);
2572
2573 ssize_t __blockdev_direct_IO(int rw, struct kiocb *iocb, struct inode *inode,
2574 struct block_device *bdev, struct iov_iter *iter, loff_t offset,
2575 get_block_t get_block, dio_iodone_t end_io,
2576 dio_submit_t submit_io, int flags);
2577
2578 static inline ssize_t blockdev_direct_IO(int rw, struct kiocb *iocb,
2579 struct inode *inode, struct iov_iter *iter, loff_t offset,
2580 get_block_t get_block)
2581 {
2582 return __blockdev_direct_IO(rw, iocb, inode, inode->i_sb->s_bdev, iter,
2583 offset, get_block, NULL, NULL,
2584 DIO_LOCKING | DIO_SKIP_HOLES);
2585 }
2586 #endif
2587
2588 void inode_dio_wait(struct inode *inode);
2589 void inode_dio_done(struct inode *inode);
2590
2591 extern void inode_set_flags(struct inode *inode, unsigned int flags,
2592 unsigned int mask);
2593
2594 extern const struct file_operations generic_ro_fops;
2595
2596 #define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
2597
2598 extern int readlink_copy(char __user *, int, const char *);
2599 extern int page_readlink(struct dentry *, char __user *, int);
2600 extern void *page_follow_link_light(struct dentry *, struct nameidata *);
2601 extern void page_put_link(struct dentry *, struct nameidata *, void *);
2602 extern int __page_symlink(struct inode *inode, const char *symname, int len,
2603 int nofs);
2604 extern int page_symlink(struct inode *inode, const char *symname, int len);
2605 extern const struct inode_operations page_symlink_inode_operations;
2606 extern void kfree_put_link(struct dentry *, struct nameidata *, void *);
2607 extern int generic_readlink(struct dentry *, char __user *, int);
2608 extern void generic_fillattr(struct inode *, struct kstat *);
2609 int vfs_getattr_nosec(struct path *path, struct kstat *stat);
2610 extern int vfs_getattr(struct path *, struct kstat *);
2611 void __inode_add_bytes(struct inode *inode, loff_t bytes);
2612 void inode_add_bytes(struct inode *inode, loff_t bytes);
2613 void __inode_sub_bytes(struct inode *inode, loff_t bytes);
2614 void inode_sub_bytes(struct inode *inode, loff_t bytes);
2615 loff_t inode_get_bytes(struct inode *inode);
2616 void inode_set_bytes(struct inode *inode, loff_t bytes);
2617
2618 extern int vfs_readdir(struct file *, filldir_t, void *);
2619 extern int iterate_dir(struct file *, struct dir_context *);
2620
2621 extern int vfs_stat(const char __user *, struct kstat *);
2622 extern int vfs_lstat(const char __user *, struct kstat *);
2623 extern int vfs_fstat(unsigned int, struct kstat *);
2624 extern int vfs_fstatat(int , const char __user *, struct kstat *, int);
2625
2626 extern int do_vfs_ioctl(struct file *filp, unsigned int fd, unsigned int cmd,
2627 unsigned long arg);
2628 extern int __generic_block_fiemap(struct inode *inode,
2629 struct fiemap_extent_info *fieinfo,
2630 loff_t start, loff_t len,
2631 get_block_t *get_block);
2632 extern int generic_block_fiemap(struct inode *inode,
2633 struct fiemap_extent_info *fieinfo, u64 start,
2634 u64 len, get_block_t *get_block);
2635
2636 extern void get_filesystem(struct file_system_type *fs);
2637 extern void put_filesystem(struct file_system_type *fs);
2638 extern struct file_system_type *get_fs_type(const char *name);
2639 extern struct super_block *get_super(struct block_device *);
2640 extern struct super_block *get_super_thawed(struct block_device *);
2641 extern struct super_block *get_active_super(struct block_device *bdev);
2642 extern void drop_super(struct super_block *sb);
2643 extern void iterate_supers(void (*)(struct super_block *, void *), void *);
2644 extern void iterate_supers_type(struct file_system_type *,
2645 void (*)(struct super_block *, void *), void *);
2646
2647 extern int dcache_dir_open(struct inode *, struct file *);
2648 extern int dcache_dir_close(struct inode *, struct file *);
2649 extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
2650 extern int dcache_readdir(struct file *, struct dir_context *);
2651 extern int simple_setattr(struct dentry *, struct iattr *);
2652 extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
2653 extern int simple_statfs(struct dentry *, struct kstatfs *);
2654 extern int simple_open(struct inode *inode, struct file *file);
2655 extern int simple_link(struct dentry *, struct inode *, struct dentry *);
2656 extern int simple_unlink(struct inode *, struct dentry *);
2657 extern int simple_rmdir(struct inode *, struct dentry *);
2658 extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
2659 extern int noop_fsync(struct file *, loff_t, loff_t, int);
2660 extern int simple_empty(struct dentry *);
2661 extern int simple_readpage(struct file *file, struct page *page);
2662 extern int simple_write_begin(struct file *file, struct address_space *mapping,
2663 loff_t pos, unsigned len, unsigned flags,
2664 struct page **pagep, void **fsdata);
2665 extern int simple_write_end(struct file *file, struct address_space *mapping,
2666 loff_t pos, unsigned len, unsigned copied,
2667 struct page *page, void *fsdata);
2668 extern int always_delete_dentry(const struct dentry *);
2669 extern struct inode *alloc_anon_inode(struct super_block *);
2670 extern int simple_nosetlease(struct file *, long, struct file_lock **, void **);
2671 extern const struct dentry_operations simple_dentry_operations;
2672
2673 extern struct dentry *simple_lookup(struct inode *, struct dentry *, unsigned int flags);
2674 extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
2675 extern const struct file_operations simple_dir_operations;
2676 extern const struct inode_operations simple_dir_inode_operations;
2677 struct tree_descr { char *name; const struct file_operations *ops; int mode; };
2678 struct dentry *d_alloc_name(struct dentry *, const char *);
2679 extern int simple_fill_super(struct super_block *, unsigned long, struct tree_descr *);
2680 extern int simple_pin_fs(struct file_system_type *, struct vfsmount **mount, int *count);
2681 extern void simple_release_fs(struct vfsmount **mount, int *count);
2682
2683 extern ssize_t simple_read_from_buffer(void __user *to, size_t count,
2684 loff_t *ppos, const void *from, size_t available);
2685 extern ssize_t simple_write_to_buffer(void *to, size_t available, loff_t *ppos,
2686 const void __user *from, size_t count);
2687
2688 extern int __generic_file_fsync(struct file *, loff_t, loff_t, int);
2689 extern int generic_file_fsync(struct file *, loff_t, loff_t, int);
2690
2691 extern int generic_check_addressable(unsigned, u64);
2692
2693 #ifdef CONFIG_MIGRATION
2694 extern int buffer_migrate_page(struct address_space *,
2695 struct page *, struct page *,
2696 enum migrate_mode);
2697 #else
2698 #define buffer_migrate_page NULL
2699 #endif
2700
2701 extern int inode_change_ok(const struct inode *, struct iattr *);
2702 extern int inode_newsize_ok(const struct inode *, loff_t offset);
2703 extern void setattr_copy(struct inode *inode, const struct iattr *attr);
2704
2705 extern int file_update_time(struct file *file);
2706
2707 extern int generic_show_options(struct seq_file *m, struct dentry *root);
2708 extern void save_mount_options(struct super_block *sb, char *options);
2709 extern void replace_mount_options(struct super_block *sb, char *options);
2710
2711 static inline ino_t parent_ino(struct dentry *dentry)
2712 {
2713 ino_t res;
2714
2715 /*
2716 * Don't strictly need d_lock here? If the parent ino could change
2717 * then surely we'd have a deeper race in the caller?
2718 */
2719 spin_lock(&dentry->d_lock);
2720 res = dentry->d_parent->d_inode->i_ino;
2721 spin_unlock(&dentry->d_lock);
2722 return res;
2723 }
2724
2725 /* Transaction based IO helpers */
2726
2727 /*
2728 * An argresp is stored in an allocated page and holds the
2729 * size of the argument or response, along with its content
2730 */
2731 struct simple_transaction_argresp {
2732 ssize_t size;
2733 char data[0];
2734 };
2735
2736 #define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
2737
2738 char *simple_transaction_get(struct file *file, const char __user *buf,
2739 size_t size);
2740 ssize_t simple_transaction_read(struct file *file, char __user *buf,
2741 size_t size, loff_t *pos);
2742 int simple_transaction_release(struct inode *inode, struct file *file);
2743
2744 void simple_transaction_set(struct file *file, size_t n);
2745
2746 /*
2747 * simple attribute files
2748 *
2749 * These attributes behave similar to those in sysfs:
2750 *
2751 * Writing to an attribute immediately sets a value, an open file can be
2752 * written to multiple times.
2753 *
2754 * Reading from an attribute creates a buffer from the value that might get
2755 * read with multiple read calls. When the attribute has been read
2756 * completely, no further read calls are possible until the file is opened
2757 * again.
2758 *
2759 * All attributes contain a text representation of a numeric value
2760 * that are accessed with the get() and set() functions.
2761 */
2762 #define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
2763 static int __fops ## _open(struct inode *inode, struct file *file) \
2764 { \
2765 __simple_attr_check_format(__fmt, 0ull); \
2766 return simple_attr_open(inode, file, __get, __set, __fmt); \
2767 } \
2768 static const struct file_operations __fops = { \
2769 .owner = THIS_MODULE, \
2770 .open = __fops ## _open, \
2771 .release = simple_attr_release, \
2772 .read = simple_attr_read, \
2773 .write = simple_attr_write, \
2774 .llseek = generic_file_llseek, \
2775 }
2776
2777 static inline __printf(1, 2)
2778 void __simple_attr_check_format(const char *fmt, ...)
2779 {
2780 /* don't do anything, just let the compiler check the arguments; */
2781 }
2782
2783 int simple_attr_open(struct inode *inode, struct file *file,
2784 int (*get)(void *, u64 *), int (*set)(void *, u64),
2785 const char *fmt);
2786 int simple_attr_release(struct inode *inode, struct file *file);
2787 ssize_t simple_attr_read(struct file *file, char __user *buf,
2788 size_t len, loff_t *ppos);
2789 ssize_t simple_attr_write(struct file *file, const char __user *buf,
2790 size_t len, loff_t *ppos);
2791
2792 struct ctl_table;
2793 int proc_nr_files(struct ctl_table *table, int write,
2794 void __user *buffer, size_t *lenp, loff_t *ppos);
2795 int proc_nr_dentry(struct ctl_table *table, int write,
2796 void __user *buffer, size_t *lenp, loff_t *ppos);
2797 int proc_nr_inodes(struct ctl_table *table, int write,
2798 void __user *buffer, size_t *lenp, loff_t *ppos);
2799 int __init get_filesystem_list(char *buf);
2800
2801 #define __FMODE_EXEC ((__force int) FMODE_EXEC)
2802 #define __FMODE_NONOTIFY ((__force int) FMODE_NONOTIFY)
2803
2804 #define ACC_MODE(x) ("\004\002\006\006"[(x)&O_ACCMODE])
2805 #define OPEN_FMODE(flag) ((__force fmode_t)(((flag + 1) & O_ACCMODE) | \
2806 (flag & __FMODE_NONOTIFY)))
2807
2808 static inline int is_sxid(umode_t mode)
2809 {
2810 return (mode & S_ISUID) || ((mode & S_ISGID) && (mode & S_IXGRP));
2811 }
2812
2813 static inline int check_sticky(struct inode *dir, struct inode *inode)
2814 {
2815 if (!(dir->i_mode & S_ISVTX))
2816 return 0;
2817
2818 return __check_sticky(dir, inode);
2819 }
2820
2821 static inline void inode_has_no_xattr(struct inode *inode)
2822 {
2823 if (!is_sxid(inode->i_mode) && (inode->i_sb->s_flags & MS_NOSEC))
2824 inode->i_flags |= S_NOSEC;
2825 }
2826
2827 static inline bool is_root_inode(struct inode *inode)
2828 {
2829 return inode == inode->i_sb->s_root->d_inode;
2830 }
2831
2832 static inline bool dir_emit(struct dir_context *ctx,
2833 const char *name, int namelen,
2834 u64 ino, unsigned type)
2835 {
2836 return ctx->actor(ctx, name, namelen, ctx->pos, ino, type) == 0;
2837 }
2838 static inline bool dir_emit_dot(struct file *file, struct dir_context *ctx)
2839 {
2840 return ctx->actor(ctx, ".", 1, ctx->pos,
2841 file->f_path.dentry->d_inode->i_ino, DT_DIR) == 0;
2842 }
2843 static inline bool dir_emit_dotdot(struct file *file, struct dir_context *ctx)
2844 {
2845 return ctx->actor(ctx, "..", 2, ctx->pos,
2846 parent_ino(file->f_path.dentry), DT_DIR) == 0;
2847 }
2848 static inline bool dir_emit_dots(struct file *file, struct dir_context *ctx)
2849 {
2850 if (ctx->pos == 0) {
2851 if (!dir_emit_dot(file, ctx))
2852 return false;
2853 ctx->pos = 1;
2854 }
2855 if (ctx->pos == 1) {
2856 if (!dir_emit_dotdot(file, ctx))
2857 return false;
2858 ctx->pos = 2;
2859 }
2860 return true;
2861 }
2862 static inline bool dir_relax(struct inode *inode)
2863 {
2864 mutex_unlock(&inode->i_mutex);
2865 mutex_lock(&inode->i_mutex);
2866 return !IS_DEADDIR(inode);
2867 }
2868
2869 #endif /* _LINUX_FS_H */
This page took 0.127974 seconds and 5 git commands to generate.