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