]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/fs.h
[PATCH] docs: updated some code docs
[net-next-2.6.git] / include / linux / fs.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_FS_H
2#define _LINUX_FS_H
3
4/*
5 * This file has definitions for some important file table
6 * structures etc.
7 */
8
9#include <linux/config.h>
10#include <linux/limits.h>
11#include <linux/ioctl.h>
12
13/*
14 * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
15 * the file limit at runtime and only root can increase the per-process
16 * nr_file rlimit, so it's safe to set up a ridiculously high absolute
17 * upper limit on files-per-process.
18 *
19 * Some programs (notably those using select()) may have to be
20 * recompiled to take full advantage of the new limits..
21 */
22
23/* Fixed constants first: */
24#undef NR_OPEN
25#define NR_OPEN (1024*1024) /* Absolute upper limit on fd num */
26#define INR_OPEN 1024 /* Initial setting for nfile rlimits */
27
28#define BLOCK_SIZE_BITS 10
29#define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
30
31/* And dynamically-tunable limits and defaults: */
32struct files_stat_struct {
33 int nr_files; /* read only */
34 int nr_free_files; /* read only */
35 int max_files; /* tunable */
36};
37extern struct files_stat_struct files_stat;
38
39struct inodes_stat_t {
40 int nr_inodes;
41 int nr_unused;
42 int dummy[5];
43};
44extern struct inodes_stat_t inodes_stat;
45
46extern int leases_enable, lease_break_time;
47
48#ifdef CONFIG_DNOTIFY
49extern int dir_notify_enable;
50#endif
51
52#define NR_FILE 8192 /* this can well be larger on a larger system */
53
54#define MAY_EXEC 1
55#define MAY_WRITE 2
56#define MAY_READ 4
57#define MAY_APPEND 8
58
59#define FMODE_READ 1
60#define FMODE_WRITE 2
61
62/* Internal kernel extensions */
63#define FMODE_LSEEK 4
64#define FMODE_PREAD 8
65#define FMODE_PWRITE FMODE_PREAD /* These go hand in hand */
66
67#define RW_MASK 1
68#define RWA_MASK 2
69#define READ 0
70#define WRITE 1
71#define READA 2 /* read-ahead - don't block if no resources */
a7662236 72#define SWRITE 3 /* for ll_rw_block() - wait for buffer lock */
1da177e4
LT
73#define SPECIAL 4 /* For non-blockdevice requests in request queue */
74#define READ_SYNC (READ | (1 << BIO_RW_SYNC))
75#define WRITE_SYNC (WRITE | (1 << BIO_RW_SYNC))
76#define WRITE_BARRIER ((1 << BIO_RW) | (1 << BIO_RW_BARRIER))
77
78#define SEL_IN 1
79#define SEL_OUT 2
80#define SEL_EX 4
81
82/* public flags for file_system_type */
83#define FS_REQUIRES_DEV 1
84#define FS_BINARY_MOUNTDATA 2
85#define FS_REVAL_DOT 16384 /* Check the paths ".", ".." for staleness */
86#define FS_ODD_RENAME 32768 /* Temporary stuff; will go away as soon
87 * as nfs_rename() will be cleaned up
88 */
89/*
90 * These are the fs-independent mount-flags: up to 32 flags are supported
91 */
92#define MS_RDONLY 1 /* Mount read-only */
93#define MS_NOSUID 2 /* Ignore suid and sgid bits */
94#define MS_NODEV 4 /* Disallow access to device special files */
95#define MS_NOEXEC 8 /* Disallow program execution */
96#define MS_SYNCHRONOUS 16 /* Writes are synced at once */
97#define MS_REMOUNT 32 /* Alter flags of a mounted FS */
98#define MS_MANDLOCK 64 /* Allow mandatory locks on an FS */
99#define MS_DIRSYNC 128 /* Directory modifications are synchronous */
100#define MS_NOATIME 1024 /* Do not update access times. */
101#define MS_NODIRATIME 2048 /* Do not update directory access times */
102#define MS_BIND 4096
103#define MS_MOVE 8192
104#define MS_REC 16384
105#define MS_VERBOSE 32768
9676f0c6 106#define MS_UNBINDABLE (1<<17) /* change to unbindable */
07b20889 107#define MS_PRIVATE (1<<18) /* change to private */
a58b0eb8 108#define MS_SLAVE (1<<19) /* change to slave */
03e06e68 109#define MS_SHARED (1<<20) /* change to shared */
1da177e4
LT
110#define MS_POSIXACL (1<<16) /* VFS does not apply the umask */
111#define MS_ACTIVE (1<<30)
112#define MS_NOUSER (1<<31)
113
114/*
115 * Superblock flags that can be altered by MS_REMOUNT
116 */
117#define MS_RMT_MASK (MS_RDONLY|MS_SYNCHRONOUS|MS_MANDLOCK|MS_NOATIME|\
118 MS_NODIRATIME)
119
120/*
121 * Old magic mount flag and mask
122 */
123#define MS_MGC_VAL 0xC0ED0000
124#define MS_MGC_MSK 0xffff0000
125
126/* Inode flags - they have nothing to superblock flags now */
127
128#define S_SYNC 1 /* Writes are synced at once */
129#define S_NOATIME 2 /* Do not update access times */
130#define S_APPEND 4 /* Append-only file */
131#define S_IMMUTABLE 8 /* Immutable file */
132#define S_DEAD 16 /* removed, but still open directory */
133#define S_NOQUOTA 32 /* Inode is not counted to quota */
134#define S_DIRSYNC 64 /* Directory modifications are synchronous */
135#define S_NOCMTIME 128 /* Do not update file c/mtime */
136#define S_SWAPFILE 256 /* Do not truncate: swapon got its bmaps */
137#define S_PRIVATE 512 /* Inode is fs-internal */
138
139/*
140 * Note that nosuid etc flags are inode-specific: setting some file-system
141 * flags just means all the inodes inherit those flags by default. It might be
142 * possible to override it selectively if you really wanted to with some
143 * ioctl() that is not currently implemented.
144 *
145 * Exception: MS_RDONLY is always applied to the entire file system.
146 *
147 * Unfortunately, it is possible to change a filesystems flags with it mounted
148 * with files in use. This means that all of the inodes will not have their
149 * i_flags updated. Hence, i_flags no longer inherit the superblock mount
150 * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
151 */
152#define __IS_FLG(inode,flg) ((inode)->i_sb->s_flags & (flg))
153
154#define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
155#define IS_SYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS) || \
156 ((inode)->i_flags & S_SYNC))
157#define IS_DIRSYNC(inode) (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
158 ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
159#define IS_MANDLOCK(inode) __IS_FLG(inode, MS_MANDLOCK)
160
161#define IS_NOQUOTA(inode) ((inode)->i_flags & S_NOQUOTA)
162#define IS_APPEND(inode) ((inode)->i_flags & S_APPEND)
163#define IS_IMMUTABLE(inode) ((inode)->i_flags & S_IMMUTABLE)
164#define IS_NOATIME(inode) (__IS_FLG(inode, MS_NOATIME) || ((inode)->i_flags & S_NOATIME))
165#define IS_NODIRATIME(inode) __IS_FLG(inode, MS_NODIRATIME)
166#define IS_POSIXACL(inode) __IS_FLG(inode, MS_POSIXACL)
167
168#define IS_DEADDIR(inode) ((inode)->i_flags & S_DEAD)
169#define IS_NOCMTIME(inode) ((inode)->i_flags & S_NOCMTIME)
170#define IS_SWAPFILE(inode) ((inode)->i_flags & S_SWAPFILE)
171#define IS_PRIVATE(inode) ((inode)->i_flags & S_PRIVATE)
172
173/* the read-only stuff doesn't really belong here, but any other place is
174 probably as bad and I don't want to create yet another include file. */
175
176#define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */
177#define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */
178#define BLKRRPART _IO(0x12,95) /* re-read partition table */
179#define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
180#define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */
181#define BLKRASET _IO(0x12,98) /* set read ahead for block device */
182#define BLKRAGET _IO(0x12,99) /* get current read ahead setting */
183#define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
184#define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
185#define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
186#define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
187#define BLKSSZGET _IO(0x12,104)/* get block device sector size */
188#if 0
189#define BLKPG _IO(0x12,105)/* See blkpg.h */
190
191/* Some people are morons. Do not use sizeof! */
192
193#define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */
194#define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */
195/* This was here just to show that the number is taken -
196 probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
197#endif
198/* A jump here: 108-111 have been used for various private purposes. */
199#define BLKBSZGET _IOR(0x12,112,size_t)
200#define BLKBSZSET _IOW(0x12,113,size_t)
201#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
202
203#define BMAP_IOCTL 1 /* obsolete - kept for compatibility */
204#define FIBMAP _IO(0x00,1) /* bmap access */
205#define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */
206
207#ifdef __KERNEL__
208
209#include <linux/linkage.h>
210#include <linux/wait.h>
211#include <linux/types.h>
212#include <linux/kdev_t.h>
213#include <linux/dcache.h>
214#include <linux/stat.h>
215#include <linux/cache.h>
216#include <linux/kobject.h>
217#include <linux/list.h>
218#include <linux/radix-tree.h>
219#include <linux/prio_tree.h>
220#include <linux/init.h>
22e2c507 221#include <linux/sched.h>
1da177e4
LT
222
223#include <asm/atomic.h>
224#include <asm/semaphore.h>
225#include <asm/byteorder.h>
226
227struct iovec;
228struct nameidata;
92198f7e 229struct kiocb;
1da177e4
LT
230struct pipe_inode_info;
231struct poll_table_struct;
232struct kstatfs;
233struct vm_area_struct;
234struct vfsmount;
235
236/* Used to be a macro which just called the function, now just a function */
237extern void update_atime (struct inode *);
238
239extern void __init inode_init(unsigned long);
240extern void __init inode_init_early(void);
241extern void __init mnt_init(unsigned long);
242extern void __init files_init(unsigned long);
243
244struct buffer_head;
245typedef int (get_block_t)(struct inode *inode, sector_t iblock,
246 struct buffer_head *bh_result, int create);
247typedef int (get_blocks_t)(struct inode *inode, sector_t iblock,
248 unsigned long max_blocks,
249 struct buffer_head *bh_result, int create);
92198f7e 250typedef void (dio_iodone_t)(struct kiocb *iocb, loff_t offset,
1da177e4
LT
251 ssize_t bytes, void *private);
252
253/*
254 * Attribute flags. These should be or-ed together to figure out what
255 * has been changed!
256 */
257#define ATTR_MODE 1
258#define ATTR_UID 2
259#define ATTR_GID 4
260#define ATTR_SIZE 8
261#define ATTR_ATIME 16
262#define ATTR_MTIME 32
263#define ATTR_CTIME 64
264#define ATTR_ATIME_SET 128
265#define ATTR_MTIME_SET 256
266#define ATTR_FORCE 512 /* Not a change, but a change it */
267#define ATTR_ATTR_FLAG 1024
268#define ATTR_KILL_SUID 2048
269#define ATTR_KILL_SGID 4096
cc4e69de 270#define ATTR_FILE 8192
1da177e4
LT
271
272/*
273 * This is the Inode Attributes structure, used for notify_change(). It
274 * uses the above definitions as flags, to know which values have changed.
275 * Also, in this manner, a Filesystem can look at only the values it cares
276 * about. Basically, these are the attributes that the VFS layer can
277 * request to change from the FS layer.
278 *
279 * Derek Atkins <warlord@MIT.EDU> 94-10-20
280 */
281struct iattr {
282 unsigned int ia_valid;
283 umode_t ia_mode;
284 uid_t ia_uid;
285 gid_t ia_gid;
286 loff_t ia_size;
287 struct timespec ia_atime;
288 struct timespec ia_mtime;
289 struct timespec ia_ctime;
cc4e69de
MS
290
291 /*
292 * Not an attribute, but an auxilary info for filesystems wanting to
293 * implement an ftruncate() like method. NOTE: filesystem should
294 * check for (ia_valid & ATTR_FILE), and not for (ia_file != NULL).
295 */
296 struct file *ia_file;
1da177e4
LT
297};
298
1da177e4
LT
299/*
300 * Includes for diskquotas.
301 */
302#include <linux/quota.h>
303
994fc28c
ZB
304/**
305 * enum positive_aop_returns - aop return codes with specific semantics
306 *
307 * @AOP_WRITEPAGE_ACTIVATE: Informs the caller that page writeback has
308 * completed, that the page is still locked, and
309 * should be considered active. The VM uses this hint
310 * to return the page to the active list -- it won't
311 * be a candidate for writeback again in the near
312 * future. Other callers must be careful to unlock
313 * the page if they get this return. Returned by
314 * writepage();
315 *
316 * @AOP_TRUNCATED_PAGE: The AOP method that was handed a locked page has
317 * unlocked it and the page might have been truncated.
318 * The caller should back up to acquiring a new page and
319 * trying again. The aop will be taking reasonable
320 * precautions not to livelock. If the caller held a page
321 * reference, it should drop it before retrying. Returned
322 * by readpage(), prepare_write(), and commit_write().
323 *
324 * address_space_operation functions return these large constants to indicate
325 * special semantics to the caller. These are much larger than the bytes in a
326 * page to allow for functions that return the number of bytes operated on in a
327 * given page.
328 */
329
330enum positive_aop_returns {
331 AOP_WRITEPAGE_ACTIVATE = 0x80000,
332 AOP_TRUNCATED_PAGE = 0x80001,
333};
334
1da177e4
LT
335/*
336 * oh the beauties of C type declarations.
337 */
338struct page;
339struct address_space;
340struct writeback_control;
1da177e4
LT
341
342struct address_space_operations {
343 int (*writepage)(struct page *page, struct writeback_control *wbc);
344 int (*readpage)(struct file *, struct page *);
345 int (*sync_page)(struct page *);
346
347 /* Write back some dirty pages from this mapping. */
348 int (*writepages)(struct address_space *, struct writeback_control *);
349
350 /* Set a page dirty */
351 int (*set_page_dirty)(struct page *page);
352
353 int (*readpages)(struct file *filp, struct address_space *mapping,
354 struct list_head *pages, unsigned nr_pages);
355
356 /*
357 * ext3 requires that a successful prepare_write() call be followed
358 * by a commit_write() call - they must be balanced
359 */
360 int (*prepare_write)(struct file *, struct page *, unsigned, unsigned);
361 int (*commit_write)(struct file *, struct page *, unsigned, unsigned);
362 /* Unfortunately this kludge is needed for FIBMAP. Don't use it */
363 sector_t (*bmap)(struct address_space *, sector_t);
364 int (*invalidatepage) (struct page *, unsigned long);
27496a8c 365 int (*releasepage) (struct page *, gfp_t);
1da177e4
LT
366 ssize_t (*direct_IO)(int, struct kiocb *, const struct iovec *iov,
367 loff_t offset, unsigned long nr_segs);
ceffc078
CO
368 struct page* (*get_xip_page)(struct address_space *, sector_t,
369 int);
1da177e4
LT
370};
371
372struct backing_dev_info;
373struct address_space {
374 struct inode *host; /* owner: inode, block_device */
375 struct radix_tree_root page_tree; /* radix tree of all pages */
376 rwlock_t tree_lock; /* and rwlock protecting it */
377 unsigned int i_mmap_writable;/* count VM_SHARED mappings */
378 struct prio_tree_root i_mmap; /* tree of private and shared mappings */
379 struct list_head i_mmap_nonlinear;/*list VM_NONLINEAR mappings */
380 spinlock_t i_mmap_lock; /* protect tree, count, list */
381 unsigned int truncate_count; /* Cover race condition with truncate */
382 unsigned long nrpages; /* number of total pages */
383 pgoff_t writeback_index;/* writeback starts here */
384 struct address_space_operations *a_ops; /* methods */
385 unsigned long flags; /* error bits/gfp mask */
386 struct backing_dev_info *backing_dev_info; /* device readahead, etc */
387 spinlock_t private_lock; /* for use by the address_space */
388 struct list_head private_list; /* ditto */
389 struct address_space *assoc_mapping; /* ditto */
390} __attribute__((aligned(sizeof(long))));
391 /*
392 * On most architectures that alignment is already the case; but
393 * must be enforced here for CRIS, to let the least signficant bit
394 * of struct page's "mapping" pointer be used for PAGE_MAPPING_ANON.
395 */
396
397struct block_device {
398 dev_t bd_dev; /* not a kdev_t - it's a search key */
399 struct inode * bd_inode; /* will die */
400 int bd_openers;
401 struct semaphore bd_sem; /* open/close mutex */
402 struct semaphore bd_mount_sem; /* mount mutex */
403 struct list_head bd_inodes;
404 void * bd_holder;
405 int bd_holders;
406 struct block_device * bd_contains;
407 unsigned bd_block_size;
408 struct hd_struct * bd_part;
409 /* number of times partitions within this device have been opened. */
410 unsigned bd_part_count;
411 int bd_invalidated;
412 struct gendisk * bd_disk;
413 struct list_head bd_list;
414 struct backing_dev_info *bd_inode_backing_dev_info;
415 /*
416 * Private data. You must have bd_claim'ed the block_device
417 * to use this. NOTE: bd_claim allows an owner to claim
418 * the same device multiple times, the owner must take special
419 * care to not mess up bd_private for that case.
420 */
421 unsigned long bd_private;
422};
423
424/*
425 * Radix-tree tags, for tagging dirty and writeback pages within the pagecache
426 * radix trees
427 */
428#define PAGECACHE_TAG_DIRTY 0
429#define PAGECACHE_TAG_WRITEBACK 1
430
431int mapping_tagged(struct address_space *mapping, int tag);
432
433/*
434 * Might pages of this file be mapped into userspace?
435 */
436static inline int mapping_mapped(struct address_space *mapping)
437{
438 return !prio_tree_empty(&mapping->i_mmap) ||
439 !list_empty(&mapping->i_mmap_nonlinear);
440}
441
442/*
443 * Might pages of this file have been modified in userspace?
444 * Note that i_mmap_writable counts all VM_SHARED vmas: do_mmap_pgoff
445 * marks vma as VM_SHARED if it is shared, and the file was opened for
446 * writing i.e. vma may be mprotected writable even if now readonly.
447 */
448static inline int mapping_writably_mapped(struct address_space *mapping)
449{
450 return mapping->i_mmap_writable != 0;
451}
452
453/*
454 * Use sequence counter to get consistent i_size on 32-bit processors.
455 */
456#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
457#include <linux/seqlock.h>
458#define __NEED_I_SIZE_ORDERED
459#define i_size_ordered_init(inode) seqcount_init(&inode->i_size_seqcount)
460#else
461#define i_size_ordered_init(inode) do { } while (0)
462#endif
463
464struct inode {
465 struct hlist_node i_hash;
466 struct list_head i_list;
467 struct list_head i_sb_list;
468 struct list_head i_dentry;
469 unsigned long i_ino;
470 atomic_t i_count;
471 umode_t i_mode;
472 unsigned int i_nlink;
473 uid_t i_uid;
474 gid_t i_gid;
475 dev_t i_rdev;
476 loff_t i_size;
477 struct timespec i_atime;
478 struct timespec i_mtime;
479 struct timespec i_ctime;
480 unsigned int i_blkbits;
481 unsigned long i_blksize;
482 unsigned long i_version;
483 unsigned long i_blocks;
484 unsigned short i_bytes;
485 spinlock_t i_lock; /* i_blocks, i_bytes, maybe i_size */
486 struct semaphore i_sem;
487 struct rw_semaphore i_alloc_sem;
488 struct inode_operations *i_op;
489 struct file_operations *i_fop; /* former ->i_op->default_file_ops */
490 struct super_block *i_sb;
491 struct file_lock *i_flock;
492 struct address_space *i_mapping;
493 struct address_space i_data;
494#ifdef CONFIG_QUOTA
495 struct dquot *i_dquot[MAXQUOTAS];
496#endif
497 /* These three should probably be a union */
498 struct list_head i_devices;
499 struct pipe_inode_info *i_pipe;
500 struct block_device *i_bdev;
501 struct cdev *i_cdev;
502 int i_cindex;
503
504 __u32 i_generation;
505
506#ifdef CONFIG_DNOTIFY
507 unsigned long i_dnotify_mask; /* Directory notify events */
508 struct dnotify_struct *i_dnotify; /* for directory notifications */
509#endif
510
0eeca283
RL
511#ifdef CONFIG_INOTIFY
512 struct list_head inotify_watches; /* watches on this inode */
513 struct semaphore inotify_sem; /* protects the watches list */
514#endif
515
1da177e4
LT
516 unsigned long i_state;
517 unsigned long dirtied_when; /* jiffies of first dirtying */
518
519 unsigned int i_flags;
520
521 atomic_t i_writecount;
522 void *i_security;
523 union {
524 void *generic_ip;
525 } u;
526#ifdef __NEED_I_SIZE_ORDERED
527 seqcount_t i_size_seqcount;
528#endif
529};
530
531/*
532 * NOTE: in a 32bit arch with a preemptable kernel and
533 * an UP compile the i_size_read/write must be atomic
534 * with respect to the local cpu (unlike with preempt disabled),
535 * but they don't need to be atomic with respect to other cpus like in
536 * true SMP (so they need either to either locally disable irq around
537 * the read or for example on x86 they can be still implemented as a
538 * cmpxchg8b without the need of the lock prefix). For SMP compiles
539 * and 64bit archs it makes no difference if preempt is enabled or not.
540 */
541static inline loff_t i_size_read(struct inode *inode)
542{
543#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
544 loff_t i_size;
545 unsigned int seq;
546
547 do {
548 seq = read_seqcount_begin(&inode->i_size_seqcount);
549 i_size = inode->i_size;
550 } while (read_seqcount_retry(&inode->i_size_seqcount, seq));
551 return i_size;
552#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
553 loff_t i_size;
554
555 preempt_disable();
556 i_size = inode->i_size;
557 preempt_enable();
558 return i_size;
559#else
560 return inode->i_size;
561#endif
562}
563
564
565static inline void i_size_write(struct inode *inode, loff_t i_size)
566{
567#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
568 write_seqcount_begin(&inode->i_size_seqcount);
569 inode->i_size = i_size;
570 write_seqcount_end(&inode->i_size_seqcount);
571#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
572 preempt_disable();
573 inode->i_size = i_size;
574 preempt_enable();
575#else
576 inode->i_size = i_size;
577#endif
578}
579
580static inline unsigned iminor(struct inode *inode)
581{
582 return MINOR(inode->i_rdev);
583}
584
585static inline unsigned imajor(struct inode *inode)
586{
587 return MAJOR(inode->i_rdev);
588}
589
590extern struct block_device *I_BDEV(struct inode *inode);
591
592struct fown_struct {
593 rwlock_t lock; /* protects pid, uid, euid fields */
594 int pid; /* pid or -pgrp where SIGIO should be sent */
595 uid_t uid, euid; /* uid/euid of process setting the owner */
596 void *security;
597 int signum; /* posix.1b rt signal to be delivered on IO */
598};
599
600/*
601 * Track a single file's readahead state
602 */
603struct file_ra_state {
604 unsigned long start; /* Current window */
605 unsigned long size;
606 unsigned long flags; /* ra flags RA_FLAG_xxx*/
607 unsigned long cache_hit; /* cache hit count*/
608 unsigned long prev_page; /* Cache last read() position */
609 unsigned long ahead_start; /* Ahead window */
610 unsigned long ahead_size;
611 unsigned long ra_pages; /* Maximum readahead window */
612 unsigned long mmap_hit; /* Cache hit stat for mmap accesses */
613 unsigned long mmap_miss; /* Cache miss stat for mmap accesses */
614};
615#define RA_FLAG_MISS 0x01 /* a cache miss occured against this file */
616#define RA_FLAG_INCACHE 0x02 /* file is already in cache */
617
618struct file {
2f512016
ED
619 /*
620 * fu_list becomes invalid after file_free is called and queued via
621 * fu_rcuhead for RCU freeing
622 */
623 union {
624 struct list_head fu_list;
625 struct rcu_head fu_rcuhead;
626 } f_u;
1da177e4
LT
627 struct dentry *f_dentry;
628 struct vfsmount *f_vfsmnt;
629 struct file_operations *f_op;
630 atomic_t f_count;
631 unsigned int f_flags;
632 mode_t f_mode;
1da177e4
LT
633 loff_t f_pos;
634 struct fown_struct f_owner;
635 unsigned int f_uid, f_gid;
636 struct file_ra_state f_ra;
637
1da177e4
LT
638 unsigned long f_version;
639 void *f_security;
640
641 /* needed for tty driver, and maybe others */
642 void *private_data;
643
644#ifdef CONFIG_EPOLL
645 /* Used by fs/eventpoll.c to link all the hooks to this file */
646 struct list_head f_ep_links;
647 spinlock_t f_ep_lock;
648#endif /* #ifdef CONFIG_EPOLL */
649 struct address_space *f_mapping;
650};
651extern spinlock_t files_lock;
652#define file_list_lock() spin_lock(&files_lock);
653#define file_list_unlock() spin_unlock(&files_lock);
654
095975da 655#define get_file(x) atomic_inc(&(x)->f_count)
1da177e4
LT
656#define file_count(x) atomic_read(&(x)->f_count)
657
658#define MAX_NON_LFS ((1UL<<31) - 1)
659
660/* Page cache limit. The filesystems should put that into their s_maxbytes
661 limits, otherwise bad things can happen in VM. */
662#if BITS_PER_LONG==32
663#define MAX_LFS_FILESIZE (((u64)PAGE_CACHE_SIZE << (BITS_PER_LONG-1))-1)
664#elif BITS_PER_LONG==64
665#define MAX_LFS_FILESIZE 0x7fffffffffffffffUL
666#endif
667
668#define FL_POSIX 1
669#define FL_FLOCK 2
670#define FL_ACCESS 8 /* not trying to lock, just looking */
671#define FL_LOCKD 16 /* lock held by rpc.lockd */
672#define FL_LEASE 32 /* lease held on this file */
673#define FL_SLEEP 128 /* A blocking lock */
674
675/*
676 * The POSIX file lock owner is determined by
677 * the "struct files_struct" in the thread group
678 * (or NULL for no owner - BSD locks).
679 *
680 * Lockd stuffs a "host" pointer into this.
681 */
682typedef struct files_struct *fl_owner_t;
683
684struct file_lock_operations {
685 void (*fl_insert)(struct file_lock *); /* lock insertion callback */
686 void (*fl_remove)(struct file_lock *); /* lock removal callback */
687 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
688 void (*fl_release_private)(struct file_lock *);
689};
690
691struct lock_manager_operations {
692 int (*fl_compare_owner)(struct file_lock *, struct file_lock *);
693 void (*fl_notify)(struct file_lock *); /* unblock callback */
694 void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
695 void (*fl_release_private)(struct file_lock *);
696 void (*fl_break)(struct file_lock *);
697 int (*fl_mylease)(struct file_lock *, struct file_lock *);
698 int (*fl_change)(struct file_lock **, int);
699};
700
701/* that will die - we need it for nfs_lock_info */
702#include <linux/nfs_fs_i.h>
703
704struct file_lock {
705 struct file_lock *fl_next; /* singly linked list for this inode */
706 struct list_head fl_link; /* doubly linked list of all locks */
707 struct list_head fl_block; /* circular list of blocked processes */
708 fl_owner_t fl_owner;
709 unsigned int fl_pid;
710 wait_queue_head_t fl_wait;
711 struct file *fl_file;
712 unsigned char fl_flags;
713 unsigned char fl_type;
714 loff_t fl_start;
715 loff_t fl_end;
716
717 struct fasync_struct * fl_fasync; /* for lease break notifications */
718 unsigned long fl_break_time; /* for nonblocking lease breaks */
719
720 struct file_lock_operations *fl_ops; /* Callbacks for filesystems */
721 struct lock_manager_operations *fl_lmops; /* Callbacks for lockmanagers */
722 union {
723 struct nfs_lock_info nfs_fl;
8d0a8a9d 724 struct nfs4_lock_info nfs4_fl;
1da177e4
LT
725 } fl_u;
726};
727
728/* The following constant reflects the upper bound of the file/locking space */
729#ifndef OFFSET_MAX
730#define INT_LIMIT(x) (~((x)1 << (sizeof(x)*8 - 1)))
731#define OFFSET_MAX INT_LIMIT(loff_t)
732#define OFFT_OFFSET_MAX INT_LIMIT(off_t)
733#endif
734
735extern struct list_head file_lock_list;
736
737#include <linux/fcntl.h>
738
739extern int fcntl_getlk(struct file *, struct flock __user *);
c293621b
PS
740extern int fcntl_setlk(unsigned int, struct file *, unsigned int,
741 struct flock __user *);
1da177e4
LT
742
743#if BITS_PER_LONG == 32
744extern int fcntl_getlk64(struct file *, struct flock64 __user *);
c293621b
PS
745extern int fcntl_setlk64(unsigned int, struct file *, unsigned int,
746 struct flock64 __user *);
1da177e4
LT
747#endif
748
749extern void send_sigio(struct fown_struct *fown, int fd, int band);
750extern int fcntl_setlease(unsigned int fd, struct file *filp, long arg);
751extern int fcntl_getlease(struct file *filp);
752
753/* fs/locks.c */
754extern void locks_init_lock(struct file_lock *);
755extern void locks_copy_lock(struct file_lock *, struct file_lock *);
756extern void locks_remove_posix(struct file *, fl_owner_t);
757extern void locks_remove_flock(struct file *);
758extern struct file_lock *posix_test_lock(struct file *, struct file_lock *);
759extern int posix_lock_file(struct file *, struct file_lock *);
760extern int posix_lock_file_wait(struct file *, struct file_lock *);
761extern void posix_block_lock(struct file_lock *, struct file_lock *);
64a318ee 762extern int posix_unblock_lock(struct file *, struct file_lock *);
1da177e4
LT
763extern int posix_locks_deadlock(struct file_lock *, struct file_lock *);
764extern int flock_lock_file_wait(struct file *filp, struct file_lock *fl);
765extern int __break_lease(struct inode *inode, unsigned int flags);
766extern void lease_get_mtime(struct inode *, struct timespec *time);
767extern int setlease(struct file *, long, struct file_lock **);
768extern int lease_modify(struct file_lock **, int);
769extern int lock_may_read(struct inode *, loff_t start, unsigned long count);
770extern int lock_may_write(struct inode *, loff_t start, unsigned long count);
771extern void steal_locks(fl_owner_t from);
772
773struct fasync_struct {
774 int magic;
775 int fa_fd;
776 struct fasync_struct *fa_next; /* singly linked list */
777 struct file *fa_file;
778};
779
780#define FASYNC_MAGIC 0x4601
781
782/* SMP safe fasync helpers: */
783extern int fasync_helper(int, struct file *, int, struct fasync_struct **);
784/* can be called from interrupts */
785extern void kill_fasync(struct fasync_struct **, int, int);
786/* only for net: no internal synchronization */
787extern void __kill_fasync(struct fasync_struct *, int, int);
788
789extern int f_setown(struct file *filp, unsigned long arg, int force);
790extern void f_delown(struct file *filp);
791extern int send_sigurg(struct fown_struct *fown);
792
793/*
794 * Umount options
795 */
796
797#define MNT_FORCE 0x00000001 /* Attempt to forcibily umount */
798#define MNT_DETACH 0x00000002 /* Just detach from the tree */
799#define MNT_EXPIRE 0x00000004 /* Mark for expiry */
800
801extern struct list_head super_blocks;
802extern spinlock_t sb_lock;
803
804#define sb_entry(list) list_entry((list), struct super_block, s_list)
805#define S_BIAS (1<<30)
806struct super_block {
807 struct list_head s_list; /* Keep this first */
808 dev_t s_dev; /* search index; _not_ kdev_t */
809 unsigned long s_blocksize;
810 unsigned long s_old_blocksize;
811 unsigned char s_blocksize_bits;
812 unsigned char s_dirt;
813 unsigned long long s_maxbytes; /* Max file size */
814 struct file_system_type *s_type;
815 struct super_operations *s_op;
816 struct dquot_operations *dq_op;
817 struct quotactl_ops *s_qcop;
818 struct export_operations *s_export_op;
819 unsigned long s_flags;
820 unsigned long s_magic;
821 struct dentry *s_root;
822 struct rw_semaphore s_umount;
823 struct semaphore s_lock;
824 int s_count;
825 int s_syncing;
826 int s_need_sync_fs;
827 atomic_t s_active;
828 void *s_security;
829 struct xattr_handler **s_xattr;
830
831 struct list_head s_inodes; /* all inodes */
832 struct list_head s_dirty; /* dirty inodes */
833 struct list_head s_io; /* parked for writeback */
834 struct hlist_head s_anon; /* anonymous dentries for (nfs) exporting */
835 struct list_head s_files;
836
837 struct block_device *s_bdev;
838 struct list_head s_instances;
839 struct quota_info s_dquot; /* Diskquota specific options */
840
841 int s_frozen;
842 wait_queue_head_t s_wait_unfrozen;
843
844 char s_id[32]; /* Informational name */
845
846 void *s_fs_info; /* Filesystem private info */
847
848 /*
849 * The next field is for VFS *only*. No filesystems have any business
850 * even looking at it. You had been warned.
851 */
852 struct semaphore s_vfs_rename_sem; /* Kludge */
853
854 /* Granuality of c/m/atime in ns.
855 Cannot be worse than a second */
856 u32 s_time_gran;
857};
858
859extern struct timespec current_fs_time(struct super_block *sb);
860
861/*
862 * Snapshotting support.
863 */
864enum {
865 SB_UNFROZEN = 0,
866 SB_FREEZE_WRITE = 1,
867 SB_FREEZE_TRANS = 2,
868};
869
870#define vfs_check_frozen(sb, level) \
871 wait_event((sb)->s_wait_unfrozen, ((sb)->s_frozen < (level)))
872
22e2c507
JA
873static inline void get_fs_excl(void)
874{
875 atomic_inc(&current->fs_excl);
876}
877
878static inline void put_fs_excl(void)
879{
880 atomic_dec(&current->fs_excl);
881}
882
883static inline int has_fs_excl(void)
884{
885 return atomic_read(&current->fs_excl);
886}
887
888
1da177e4
LT
889/*
890 * Superblock locking.
891 */
892static inline void lock_super(struct super_block * sb)
893{
22e2c507 894 get_fs_excl();
1da177e4
LT
895 down(&sb->s_lock);
896}
897
898static inline void unlock_super(struct super_block * sb)
899{
22e2c507 900 put_fs_excl();
1da177e4
LT
901 up(&sb->s_lock);
902}
903
904/*
905 * VFS helper functions..
906 */
e4543edd 907extern int vfs_permission(struct nameidata *, int);
1da177e4
LT
908extern int vfs_create(struct inode *, struct dentry *, int, struct nameidata *);
909extern int vfs_mkdir(struct inode *, struct dentry *, int);
910extern int vfs_mknod(struct inode *, struct dentry *, int, dev_t);
911extern int vfs_symlink(struct inode *, struct dentry *, const char *, int);
912extern int vfs_link(struct dentry *, struct inode *, struct dentry *);
913extern int vfs_rmdir(struct inode *, struct dentry *);
914extern int vfs_unlink(struct inode *, struct dentry *);
915extern int vfs_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
916
917/*
918 * VFS dentry helper functions.
919 */
920extern void dentry_unhash(struct dentry *dentry);
921
8c744fb8
CH
922/*
923 * VFS file helper functions.
924 */
925extern int file_permission(struct file *, int);
926
1da177e4
LT
927/*
928 * File types
929 *
930 * NOTE! These match bits 12..15 of stat.st_mode
931 * (ie "(i_mode >> 12) & 15").
932 */
933#define DT_UNKNOWN 0
934#define DT_FIFO 1
935#define DT_CHR 2
936#define DT_DIR 4
937#define DT_BLK 6
938#define DT_REG 8
939#define DT_LNK 10
940#define DT_SOCK 12
941#define DT_WHT 14
942
943#define OSYNC_METADATA (1<<0)
944#define OSYNC_DATA (1<<1)
945#define OSYNC_INODE (1<<2)
946int generic_osync_inode(struct inode *, struct address_space *, int);
947
948/*
949 * This is the "filldir" function type, used by readdir() to let
950 * the kernel specify what kind of dirent layout it wants to have.
951 * This allows the kernel to read directories into kernel space or
952 * to have different dirent layouts depending on the binary type.
953 */
954typedef int (*filldir_t)(void *, const char *, int, loff_t, ino_t, unsigned);
955
956struct block_device_operations {
957 int (*open) (struct inode *, struct file *);
958 int (*release) (struct inode *, struct file *);
959 int (*ioctl) (struct inode *, struct file *, unsigned, unsigned long);
bb93e3a5 960 long (*unlocked_ioctl) (struct file *, unsigned, unsigned long);
1da177e4 961 long (*compat_ioctl) (struct file *, unsigned, unsigned long);
420edbcc 962 int (*direct_access) (struct block_device *, sector_t, unsigned long *);
1da177e4
LT
963 int (*media_changed) (struct gendisk *);
964 int (*revalidate_disk) (struct gendisk *);
965 struct module *owner;
966};
967
968/*
969 * "descriptor" for what we're up to with a read for sendfile().
970 * This allows us to use the same read code yet
971 * have multiple different users of the data that
972 * we read from a file.
973 *
974 * The simplest case just copies the data to user
975 * mode.
976 */
977typedef struct {
978 size_t written;
979 size_t count;
980 union {
981 char __user * buf;
982 void *data;
983 } arg;
984 int error;
985} read_descriptor_t;
986
987typedef int (*read_actor_t)(read_descriptor_t *, struct page *, unsigned long, unsigned long);
988
989/* These macros are for out of kernel modules to test that
990 * the kernel supports the unlocked_ioctl and compat_ioctl
991 * fields in struct file_operations. */
992#define HAVE_COMPAT_IOCTL 1
993#define HAVE_UNLOCKED_IOCTL 1
994
995/*
996 * NOTE:
997 * read, write, poll, fsync, readv, writev, unlocked_ioctl and compat_ioctl
998 * can be called without the big kernel lock held in all filesystems.
999 */
1000struct file_operations {
1001 struct module *owner;
1002 loff_t (*llseek) (struct file *, loff_t, int);
1003 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1004 ssize_t (*aio_read) (struct kiocb *, char __user *, size_t, loff_t);
1005 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
1006 ssize_t (*aio_write) (struct kiocb *, const char __user *, size_t, loff_t);
1007 int (*readdir) (struct file *, void *, filldir_t);
1008 unsigned int (*poll) (struct file *, struct poll_table_struct *);
1009 int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long);
1010 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
1011 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1012 int (*mmap) (struct file *, struct vm_area_struct *);
1013 int (*open) (struct inode *, struct file *);
1014 int (*flush) (struct file *);
1015 int (*release) (struct inode *, struct file *);
1016 int (*fsync) (struct file *, struct dentry *, int datasync);
1017 int (*aio_fsync) (struct kiocb *, int datasync);
1018 int (*fasync) (int, struct file *, int);
1019 int (*lock) (struct file *, int, struct file_lock *);
1020 ssize_t (*readv) (struct file *, const struct iovec *, unsigned long, loff_t *);
1021 ssize_t (*writev) (struct file *, const struct iovec *, unsigned long, loff_t *);
1022 ssize_t (*sendfile) (struct file *, loff_t *, size_t, read_actor_t, void *);
1023 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
1024 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
1025 int (*check_flags)(int);
1026 int (*dir_notify)(struct file *filp, unsigned long arg);
1027 int (*flock) (struct file *, int, struct file_lock *);
1028};
1029
1030struct inode_operations {
1031 int (*create) (struct inode *,struct dentry *,int, struct nameidata *);
1032 struct dentry * (*lookup) (struct inode *,struct dentry *, struct nameidata *);
1033 int (*link) (struct dentry *,struct inode *,struct dentry *);
1034 int (*unlink) (struct inode *,struct dentry *);
1035 int (*symlink) (struct inode *,struct dentry *,const char *);
1036 int (*mkdir) (struct inode *,struct dentry *,int);
1037 int (*rmdir) (struct inode *,struct dentry *);
1038 int (*mknod) (struct inode *,struct dentry *,int,dev_t);
1039 int (*rename) (struct inode *, struct dentry *,
1040 struct inode *, struct dentry *);
1041 int (*readlink) (struct dentry *, char __user *,int);
cc314eef
LT
1042 void * (*follow_link) (struct dentry *, struct nameidata *);
1043 void (*put_link) (struct dentry *, struct nameidata *, void *);
1da177e4
LT
1044 void (*truncate) (struct inode *);
1045 int (*permission) (struct inode *, int, struct nameidata *);
1046 int (*setattr) (struct dentry *, struct iattr *);
1047 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
1048 int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
1049 ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
1050 ssize_t (*listxattr) (struct dentry *, char *, size_t);
1051 int (*removexattr) (struct dentry *, const char *);
f6b3ec23 1052 void (*truncate_range)(struct inode *, loff_t, loff_t);
1da177e4
LT
1053};
1054
1055struct seq_file;
1056
1057extern ssize_t vfs_read(struct file *, char __user *, size_t, loff_t *);
1058extern ssize_t vfs_write(struct file *, const char __user *, size_t, loff_t *);
1059extern ssize_t vfs_readv(struct file *, const struct iovec __user *,
1060 unsigned long, loff_t *);
1061extern ssize_t vfs_writev(struct file *, const struct iovec __user *,
1062 unsigned long, loff_t *);
1063
1064/*
1065 * NOTE: write_inode, delete_inode, clear_inode, put_inode can be called
1066 * without the big kernel lock held in all filesystems.
1067 */
1068struct super_operations {
1069 struct inode *(*alloc_inode)(struct super_block *sb);
1070 void (*destroy_inode)(struct inode *);
1071
1072 void (*read_inode) (struct inode *);
1073
1074 void (*dirty_inode) (struct inode *);
1075 int (*write_inode) (struct inode *, int);
1076 void (*put_inode) (struct inode *);
1077 void (*drop_inode) (struct inode *);
1078 void (*delete_inode) (struct inode *);
1079 void (*put_super) (struct super_block *);
1080 void (*write_super) (struct super_block *);
1081 int (*sync_fs)(struct super_block *sb, int wait);
1082 void (*write_super_lockfs) (struct super_block *);
1083 void (*unlockfs) (struct super_block *);
1084 int (*statfs) (struct super_block *, struct kstatfs *);
1085 int (*remount_fs) (struct super_block *, int *, char *);
1086 void (*clear_inode) (struct inode *);
1087 void (*umount_begin) (struct super_block *);
1088
1089 int (*show_options)(struct seq_file *, struct vfsmount *);
1090
1091 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
1092 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1093};
1094
1095/* Inode state bits. Protected by inode_lock. */
1096#define I_DIRTY_SYNC 1 /* Not dirty enough for O_DATASYNC */
1097#define I_DIRTY_DATASYNC 2 /* Data-related inode changes pending */
1098#define I_DIRTY_PAGES 4 /* Data-related inode changes pending */
1099#define __I_LOCK 3
1100#define I_LOCK (1 << __I_LOCK)
1101#define I_FREEING 16
1102#define I_CLEAR 32
1103#define I_NEW 64
991114c6 1104#define I_WILL_FREE 128
1da177e4
LT
1105
1106#define I_DIRTY (I_DIRTY_SYNC | I_DIRTY_DATASYNC | I_DIRTY_PAGES)
1107
1108extern void __mark_inode_dirty(struct inode *, int);
1109static inline void mark_inode_dirty(struct inode *inode)
1110{
1111 __mark_inode_dirty(inode, I_DIRTY);
1112}
1113
1114static inline void mark_inode_dirty_sync(struct inode *inode)
1115{
1116 __mark_inode_dirty(inode, I_DIRTY_SYNC);
1117}
1118
1119static inline void touch_atime(struct vfsmount *mnt, struct dentry *dentry)
1120{
1121 /* per-mountpoint checks will go here */
1122 update_atime(dentry->d_inode);
1123}
1124
1125static inline void file_accessed(struct file *file)
1126{
1127 if (!(file->f_flags & O_NOATIME))
1128 touch_atime(file->f_vfsmnt, file->f_dentry);
1129}
1130
1131int sync_inode(struct inode *inode, struct writeback_control *wbc);
1132
1133/**
4dc3b16b
PP
1134 * struct export_operations - for nfsd to communicate with file systems
1135 * @decode_fh: decode a file handle fragment and return a &struct dentry
1136 * @encode_fh: encode a file handle fragment from a dentry
1137 * @get_name: find the name for a given inode in a given directory
1138 * @get_parent: find the parent of a given directory
1139 * @get_dentry: find a dentry for the inode given a file handle sub-fragment
8f2709b5
RD
1140 * @find_exported_dentry:
1141 * set by the exporting module to a standard helper function.
1da177e4
LT
1142 *
1143 * Description:
1144 * The export_operations structure provides a means for nfsd to communicate
1145 * with a particular exported file system - particularly enabling nfsd and
1146 * the filesystem to co-operate when dealing with file handles.
1147 *
67be2dd1
MW
1148 * export_operations contains two basic operation for dealing with file
1149 * handles, decode_fh() and encode_fh(), and allows for some other
1150 * operations to be defined which standard helper routines use to get
1151 * specific information from the filesystem.
1da177e4
LT
1152 *
1153 * nfsd encodes information use to determine which filesystem a filehandle
67be2dd1
MW
1154 * applies to in the initial part of the file handle. The remainder, termed
1155 * a file handle fragment, is controlled completely by the filesystem. The
1156 * standard helper routines assume that this fragment will contain one or
1157 * two sub-fragments, one which identifies the file, and one which may be
1158 * used to identify the (a) directory containing the file.
1da177e4
LT
1159 *
1160 * In some situations, nfsd needs to get a dentry which is connected into a
67be2dd1
MW
1161 * specific part of the file tree. To allow for this, it passes the
1162 * function acceptable() together with a @context which can be used to see
1163 * if the dentry is acceptable. As there can be multiple dentrys for a
1164 * given file, the filesystem should check each one for acceptability before
1165 * looking for the next. As soon as an acceptable one is found, it should
1166 * be returned.
1da177e4
LT
1167 *
1168 * decode_fh:
67be2dd1
MW
1169 * @decode_fh is given a &struct super_block (@sb), a file handle fragment
1170 * (@fh, @fh_len) and an acceptability testing function (@acceptable,
1171 * @context). It should return a &struct dentry which refers to the same
1172 * file that the file handle fragment refers to, and which passes the
1173 * acceptability test. If it cannot, it should return a %NULL pointer if
1174 * the file was found but no acceptable &dentries were available, or a
1175 * %ERR_PTR error code indicating why it couldn't be found (e.g. %ENOENT or
1176 * %ENOMEM).
1da177e4
LT
1177 *
1178 * encode_fh:
67be2dd1
MW
1179 * @encode_fh should store in the file handle fragment @fh (using at most
1180 * @max_len bytes) information that can be used by @decode_fh to recover the
1181 * file refered to by the &struct dentry @de. If the @connectable flag is
1182 * set, the encode_fh() should store sufficient information so that a good
1183 * attempt can be made to find not only the file but also it's place in the
1184 * filesystem. This typically means storing a reference to de->d_parent in
1185 * the filehandle fragment. encode_fh() should return the number of bytes
1186 * stored or a negative error code such as %-ENOSPC
1da177e4
LT
1187 *
1188 * get_name:
67be2dd1
MW
1189 * @get_name should find a name for the given @child in the given @parent
1190 * directory. The name should be stored in the @name (with the
1191 * understanding that it is already pointing to a a %NAME_MAX+1 sized
1192 * buffer. get_name() should return %0 on success, a negative error code
1193 * or error. @get_name will be called without @parent->i_sem held.
1da177e4
LT
1194 *
1195 * get_parent:
67be2dd1
MW
1196 * @get_parent should find the parent directory for the given @child which
1197 * is also a directory. In the event that it cannot be found, or storage
1198 * space cannot be allocated, a %ERR_PTR should be returned.
1da177e4
LT
1199 *
1200 * get_dentry:
67be2dd1
MW
1201 * Given a &super_block (@sb) and a pointer to a file-system specific inode
1202 * identifier, possibly an inode number, (@inump) get_dentry() should find
1203 * the identified inode and return a dentry for that inode. Any suitable
1204 * dentry can be returned including, if necessary, a new dentry created with
1205 * d_alloc_root. The caller can then find any other extant dentrys by
1206 * following the d_alias links. If a new dentry was created using
1207 * d_alloc_root, DCACHE_NFSD_DISCONNECTED should be set, and the dentry
1208 * should be d_rehash()ed.
1da177e4 1209 *
67be2dd1
MW
1210 * If the inode cannot be found, either a %NULL pointer or an %ERR_PTR code
1211 * can be returned. The @inump will be whatever was passed to
1212 * nfsd_find_fh_dentry() in either the @obj or @parent parameters.
1da177e4
LT
1213 *
1214 * Locking rules:
67be2dd1
MW
1215 * get_parent is called with child->d_inode->i_sem down
1216 * get_name is not (which is possibly inconsistent)
1da177e4
LT
1217 */
1218
1219struct export_operations {
1220 struct dentry *(*decode_fh)(struct super_block *sb, __u32 *fh, int fh_len, int fh_type,
1221 int (*acceptable)(void *context, struct dentry *de),
1222 void *context);
1223 int (*encode_fh)(struct dentry *de, __u32 *fh, int *max_len,
1224 int connectable);
1225
1226 /* the following are only called from the filesystem itself */
1227 int (*get_name)(struct dentry *parent, char *name,
1228 struct dentry *child);
1229 struct dentry * (*get_parent)(struct dentry *child);
1230 struct dentry * (*get_dentry)(struct super_block *sb, void *inump);
1231
1232 /* This is set by the exporting module to a standard helper */
1233 struct dentry * (*find_exported_dentry)(
1234 struct super_block *sb, void *obj, void *parent,
1235 int (*acceptable)(void *context, struct dentry *de),
1236 void *context);
1237
1238
1239};
1240
1241extern struct dentry *
1242find_exported_dentry(struct super_block *sb, void *obj, void *parent,
1243 int (*acceptable)(void *context, struct dentry *de),
1244 void *context);
1245
1246struct file_system_type {
1247 const char *name;
1248 int fs_flags;
1249 struct super_block *(*get_sb) (struct file_system_type *, int,
1250 const char *, void *);
1251 void (*kill_sb) (struct super_block *);
1252 struct module *owner;
1253 struct file_system_type * next;
1254 struct list_head fs_supers;
1255};
1256
1257struct super_block *get_sb_bdev(struct file_system_type *fs_type,
1258 int flags, const char *dev_name, void *data,
1259 int (*fill_super)(struct super_block *, void *, int));
1260struct super_block *get_sb_single(struct file_system_type *fs_type,
1261 int flags, void *data,
1262 int (*fill_super)(struct super_block *, void *, int));
1263struct super_block *get_sb_nodev(struct file_system_type *fs_type,
1264 int flags, void *data,
1265 int (*fill_super)(struct super_block *, void *, int));
1266void generic_shutdown_super(struct super_block *sb);
1267void kill_block_super(struct super_block *sb);
1268void kill_anon_super(struct super_block *sb);
1269void kill_litter_super(struct super_block *sb);
1270void deactivate_super(struct super_block *sb);
1271int set_anon_super(struct super_block *s, void *data);
1272struct super_block *sget(struct file_system_type *type,
1273 int (*test)(struct super_block *,void *),
1274 int (*set)(struct super_block *,void *),
1275 void *data);
1276struct super_block *get_sb_pseudo(struct file_system_type *, char *,
1277 struct super_operations *ops, unsigned long);
1278int __put_super(struct super_block *sb);
1279int __put_super_and_need_restart(struct super_block *sb);
1280void unnamed_dev_init(void);
1281
1282/* Alas, no aliases. Too much hassle with bringing module.h everywhere */
1283#define fops_get(fops) \
1284 (((fops) && try_module_get((fops)->owner) ? (fops) : NULL))
1285#define fops_put(fops) \
1286 do { if (fops) module_put((fops)->owner); } while(0)
1287
1288extern int register_filesystem(struct file_system_type *);
1289extern int unregister_filesystem(struct file_system_type *);
1290extern struct vfsmount *kern_mount(struct file_system_type *);
1291extern int may_umount_tree(struct vfsmount *);
1292extern int may_umount(struct vfsmount *);
a05964f3 1293extern void umount_tree(struct vfsmount *, int, struct list_head *);
b90fa9ae 1294extern void release_mounts(struct list_head *);
1da177e4 1295extern long do_mount(char *, char *, char *, unsigned long, void *);
b90fa9ae
RP
1296extern struct vfsmount *copy_tree(struct vfsmount *, struct dentry *, int);
1297extern void mnt_set_mountpoint(struct vfsmount *, struct dentry *,
1298 struct vfsmount *);
1da177e4
LT
1299
1300extern int vfs_statfs(struct super_block *, struct kstatfs *);
1301
1302#define FLOCK_VERIFY_READ 1
1303#define FLOCK_VERIFY_WRITE 2
1304
1305extern int locks_mandatory_locked(struct inode *);
1306extern int locks_mandatory_area(int, struct inode *, struct file *, loff_t, size_t);
1307
1308/*
1309 * Candidates for mandatory locking have the setgid bit set
1310 * but no group execute bit - an otherwise meaningless combination.
1311 */
1312#define MANDATORY_LOCK(inode) \
1313 (IS_MANDLOCK(inode) && ((inode)->i_mode & (S_ISGID | S_IXGRP)) == S_ISGID)
1314
1315static inline int locks_verify_locked(struct inode *inode)
1316{
1317 if (MANDATORY_LOCK(inode))
1318 return locks_mandatory_locked(inode);
1319 return 0;
1320}
1321
1322extern int rw_verify_area(int, struct file *, loff_t *, size_t);
1323
1324static inline int locks_verify_truncate(struct inode *inode,
1325 struct file *filp,
1326 loff_t size)
1327{
1328 if (inode->i_flock && MANDATORY_LOCK(inode))
1329 return locks_mandatory_area(
1330 FLOCK_VERIFY_WRITE, inode, filp,
1331 size < inode->i_size ? size : inode->i_size,
1332 (size < inode->i_size ? inode->i_size - size
1333 : size - inode->i_size)
1334 );
1335 return 0;
1336}
1337
1338static inline int break_lease(struct inode *inode, unsigned int mode)
1339{
1340 if (inode->i_flock)
1341 return __break_lease(inode, mode);
1342 return 0;
1343}
1344
1345/* fs/open.c */
1346
4a30131e
N
1347extern int do_truncate(struct dentry *, loff_t start, unsigned int time_attrs,
1348 struct file *filp);
e922efc3 1349extern long do_sys_open(const char __user *filename, int flags, int mode);
1da177e4
LT
1350extern struct file *filp_open(const char *, int, int);
1351extern struct file * dentry_open(struct dentry *, struct vfsmount *, int);
1352extern int filp_close(struct file *, fl_owner_t id);
1353extern char * getname(const char __user *);
1354
1355/* fs/dcache.c */
1356extern void __init vfs_caches_init_early(void);
1357extern void __init vfs_caches_init(unsigned long);
1358
1359#define __getname() kmem_cache_alloc(names_cachep, SLAB_KERNEL)
1360#define __putname(name) kmem_cache_free(names_cachep, (void *)(name))
1361#ifndef CONFIG_AUDITSYSCALL
1362#define putname(name) __putname(name)
1363#else
1364extern void putname(const char *name);
1365#endif
1366
1367extern int register_blkdev(unsigned int, const char *);
1368extern int unregister_blkdev(unsigned int, const char *);
1369extern struct block_device *bdget(dev_t);
1370extern void bd_set_size(struct block_device *, loff_t size);
1371extern void bd_forget(struct inode *inode);
1372extern void bdput(struct block_device *);
1373extern struct block_device *open_by_devnum(dev_t, unsigned);
1374extern struct file_operations def_blk_fops;
1375extern struct address_space_operations def_blk_aops;
1376extern struct file_operations def_chr_fops;
1377extern struct file_operations bad_sock_fops;
1378extern struct file_operations def_fifo_fops;
1379extern int ioctl_by_bdev(struct block_device *, unsigned, unsigned long);
1380extern int blkdev_ioctl(struct inode *, struct file *, unsigned, unsigned long);
1381extern long compat_blkdev_ioctl(struct file *, unsigned, unsigned long);
1382extern int blkdev_get(struct block_device *, mode_t, unsigned);
1383extern int blkdev_put(struct block_device *);
1384extern int bd_claim(struct block_device *, void *);
1385extern void bd_release(struct block_device *);
1386
1387/* fs/char_dev.c */
1388extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
1389extern int register_chrdev_region(dev_t, unsigned, const char *);
1390extern int register_chrdev(unsigned int, const char *,
1391 struct file_operations *);
1392extern int unregister_chrdev(unsigned int, const char *);
1393extern void unregister_chrdev_region(dev_t, unsigned);
1394extern int chrdev_open(struct inode *, struct file *);
1395
1396/* fs/block_dev.c */
1397#define BDEVNAME_SIZE 32 /* Largest string for a blockdev identifier */
1398extern const char *__bdevname(dev_t, char *buffer);
1399extern const char *bdevname(struct block_device *bdev, char *buffer);
1400extern struct block_device *lookup_bdev(const char *);
1401extern struct block_device *open_bdev_excl(const char *, int, void *);
1402extern void close_bdev_excl(struct block_device *);
1403
1404extern void init_special_inode(struct inode *, umode_t, dev_t);
1405
1406/* Invalid inode operations -- fs/bad_inode.c */
1407extern void make_bad_inode(struct inode *);
1408extern int is_bad_inode(struct inode *);
1409
1410extern struct file_operations read_fifo_fops;
1411extern struct file_operations write_fifo_fops;
1412extern struct file_operations rdwr_fifo_fops;
1413extern struct file_operations read_pipe_fops;
1414extern struct file_operations write_pipe_fops;
1415extern struct file_operations rdwr_pipe_fops;
1416
1417extern int fs_may_remount_ro(struct super_block *);
1418
1419/*
1420 * return READ, READA, or WRITE
1421 */
1422#define bio_rw(bio) ((bio)->bi_rw & (RW_MASK | RWA_MASK))
1423
1424/*
1425 * return data direction, READ or WRITE
1426 */
1427#define bio_data_dir(bio) ((bio)->bi_rw & 1)
1428
1429extern int check_disk_change(struct block_device *);
1430extern int invalidate_inodes(struct super_block *);
2ef41634 1431extern int __invalidate_device(struct block_device *);
1da177e4
LT
1432extern int invalidate_partition(struct gendisk *, int);
1433unsigned long invalidate_mapping_pages(struct address_space *mapping,
1434 pgoff_t start, pgoff_t end);
1435unsigned long invalidate_inode_pages(struct address_space *mapping);
1436static inline void invalidate_remote_inode(struct inode *inode)
1437{
1438 if (S_ISREG(inode->i_mode) || S_ISDIR(inode->i_mode) ||
1439 S_ISLNK(inode->i_mode))
1440 invalidate_inode_pages(inode->i_mapping);
1441}
1442extern int invalidate_inode_pages2(struct address_space *mapping);
1443extern int invalidate_inode_pages2_range(struct address_space *mapping,
1444 pgoff_t start, pgoff_t end);
1445extern int write_inode_now(struct inode *, int);
1446extern int filemap_fdatawrite(struct address_space *);
1447extern int filemap_flush(struct address_space *);
1448extern int filemap_fdatawait(struct address_space *);
1449extern int filemap_write_and_wait(struct address_space *mapping);
1450extern int filemap_write_and_wait_range(struct address_space *mapping,
1451 loff_t lstart, loff_t lend);
1452extern void sync_supers(void);
1453extern void sync_filesystems(int wait);
1454extern void emergency_sync(void);
1455extern void emergency_remount(void);
1456extern int do_remount_sb(struct super_block *sb, int flags,
1457 void *data, int force);
1458extern sector_t bmap(struct inode *, sector_t);
1da177e4
LT
1459extern int notify_change(struct dentry *, struct iattr *);
1460extern int permission(struct inode *, int, struct nameidata *);
1461extern int generic_permission(struct inode *, int,
1462 int (*check_acl)(struct inode *, int));
1463
1464extern int get_write_access(struct inode *);
1465extern int deny_write_access(struct file *);
1466static inline void put_write_access(struct inode * inode)
1467{
1468 atomic_dec(&inode->i_writecount);
1469}
1470static inline void allow_write_access(struct file *file)
1471{
1472 if (file)
1473 atomic_inc(&file->f_dentry->d_inode->i_writecount);
1474}
1475extern int do_pipe(int *);
1476
1477extern int open_namei(const char *, int, int, struct nameidata *);
1478extern int may_open(struct nameidata *, int, int);
1479
1480extern int kernel_read(struct file *, unsigned long, char *, unsigned long);
1481extern struct file * open_exec(const char *);
1482
1483/* fs/dcache.c -- generic fs support functions */
1484extern int is_subdir(struct dentry *, struct dentry *);
1485extern ino_t find_inode_number(struct dentry *, struct qstr *);
1486
1487#include <linux/err.h>
1488
1489/* needed for stackable file system support */
1490extern loff_t default_llseek(struct file *file, loff_t offset, int origin);
1491
1492extern loff_t vfs_llseek(struct file *file, loff_t offset, int origin);
1493
1494extern void inode_init_once(struct inode *);
1495extern void iput(struct inode *);
1496extern struct inode * igrab(struct inode *);
1497extern ino_t iunique(struct super_block *, ino_t);
1498extern int inode_needs_sync(struct inode *inode);
1499extern void generic_delete_inode(struct inode *inode);
cb2c0233 1500extern void generic_drop_inode(struct inode *inode);
1da177e4 1501
88bd5121
AA
1502extern struct inode *ilookup5_nowait(struct super_block *sb,
1503 unsigned long hashval, int (*test)(struct inode *, void *),
1504 void *data);
1da177e4
LT
1505extern struct inode *ilookup5(struct super_block *sb, unsigned long hashval,
1506 int (*test)(struct inode *, void *), void *data);
1507extern struct inode *ilookup(struct super_block *sb, unsigned long ino);
1508
1509extern struct inode * iget5_locked(struct super_block *, unsigned long, int (*test)(struct inode *, void *), int (*set)(struct inode *, void *), void *);
1510extern struct inode * iget_locked(struct super_block *, unsigned long);
1511extern void unlock_new_inode(struct inode *);
1512
1513static inline struct inode *iget(struct super_block *sb, unsigned long ino)
1514{
1515 struct inode *inode = iget_locked(sb, ino);
1516
1517 if (inode && (inode->i_state & I_NEW)) {
1518 sb->s_op->read_inode(inode);
1519 unlock_new_inode(inode);
1520 }
1521
1522 return inode;
1523}
1524
1525extern void __iget(struct inode * inode);
1526extern void clear_inode(struct inode *);
1527extern void destroy_inode(struct inode *);
1528extern struct inode *new_inode(struct super_block *);
1529extern int remove_suid(struct dentry *);
1530extern void remove_dquot_ref(struct super_block *, int, struct list_head *);
1531extern struct semaphore iprune_sem;
1532
1533extern void __insert_inode_hash(struct inode *, unsigned long hashval);
1534extern void remove_inode_hash(struct inode *);
1535static inline void insert_inode_hash(struct inode *inode) {
1536 __insert_inode_hash(inode, inode->i_ino);
1537}
1538
1539extern struct file * get_empty_filp(void);
1540extern void file_move(struct file *f, struct list_head *list);
1541extern void file_kill(struct file *f);
1542struct bio;
1543extern void submit_bio(int, struct bio *);
1544extern int bdev_read_only(struct block_device *);
1545extern int set_blocksize(struct block_device *, int);
1546extern int sb_set_blocksize(struct super_block *, int);
1547extern int sb_min_blocksize(struct super_block *, int);
1548
1549extern int generic_file_mmap(struct file *, struct vm_area_struct *);
1550extern int generic_file_readonly_mmap(struct file *, struct vm_area_struct *);
1551extern int file_read_actor(read_descriptor_t * desc, struct page *page, unsigned long offset, unsigned long size);
1552extern int file_send_actor(read_descriptor_t * desc, struct page *page, unsigned long offset, unsigned long size);
1553extern ssize_t generic_file_read(struct file *, char __user *, size_t, loff_t *);
1554int generic_write_checks(struct file *file, loff_t *pos, size_t *count, int isblk);
1555extern ssize_t generic_file_write(struct file *, const char __user *, size_t, loff_t *);
1556extern ssize_t generic_file_aio_read(struct kiocb *, char __user *, size_t, loff_t);
1557extern ssize_t __generic_file_aio_read(struct kiocb *, const struct iovec *, unsigned long, loff_t *);
1558extern ssize_t generic_file_aio_write(struct kiocb *, const char __user *, size_t, loff_t);
1559extern ssize_t generic_file_aio_write_nolock(struct kiocb *, const struct iovec *,
1560 unsigned long, loff_t *);
1561extern ssize_t generic_file_direct_write(struct kiocb *, const struct iovec *,
1562 unsigned long *, loff_t, loff_t *, size_t, size_t);
1563extern ssize_t generic_file_buffered_write(struct kiocb *, const struct iovec *,
1564 unsigned long, loff_t, loff_t *, size_t, ssize_t);
1565extern ssize_t do_sync_read(struct file *filp, char __user *buf, size_t len, loff_t *ppos);
1566extern ssize_t do_sync_write(struct file *filp, const char __user *buf, size_t len, loff_t *ppos);
1567ssize_t generic_file_write_nolock(struct file *file, const struct iovec *iov,
1568 unsigned long nr_segs, loff_t *ppos);
1569extern ssize_t generic_file_sendfile(struct file *, loff_t *, size_t, read_actor_t, void *);
1570extern void do_generic_mapping_read(struct address_space *mapping,
1571 struct file_ra_state *, struct file *,
1572 loff_t *, read_descriptor_t *, read_actor_t);
1573extern void
1574file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping);
1da177e4
LT
1575extern ssize_t generic_file_readv(struct file *filp, const struct iovec *iov,
1576 unsigned long nr_segs, loff_t *ppos);
1577ssize_t generic_file_writev(struct file *filp, const struct iovec *iov,
1578 unsigned long nr_segs, loff_t *ppos);
1579extern loff_t no_llseek(struct file *file, loff_t offset, int origin);
1580extern loff_t generic_file_llseek(struct file *file, loff_t offset, int origin);
1581extern loff_t remote_llseek(struct file *file, loff_t offset, int origin);
1582extern int generic_file_open(struct inode * inode, struct file * filp);
1583extern int nonseekable_open(struct inode * inode, struct file * filp);
1584
ceffc078 1585#ifdef CONFIG_FS_XIP
eb6fe0c3
CO
1586extern ssize_t xip_file_read(struct file *filp, char __user *buf, size_t len,
1587 loff_t *ppos);
ceffc078
CO
1588extern ssize_t xip_file_sendfile(struct file *in_file, loff_t *ppos,
1589 size_t count, read_actor_t actor,
1590 void *target);
1591extern int xip_file_mmap(struct file * file, struct vm_area_struct * vma);
eb6fe0c3
CO
1592extern ssize_t xip_file_write(struct file *filp, const char __user *buf,
1593 size_t len, loff_t *ppos);
ceffc078 1594extern int xip_truncate_page(struct address_space *mapping, loff_t from);
6d79125b
CO
1595#else
1596static inline int xip_truncate_page(struct address_space *mapping, loff_t from)
1597{
1598 return 0;
1599}
ceffc078
CO
1600#endif
1601
1da177e4
LT
1602static inline void do_generic_file_read(struct file * filp, loff_t *ppos,
1603 read_descriptor_t * desc,
1604 read_actor_t actor)
1605{
1606 do_generic_mapping_read(filp->f_mapping,
1607 &filp->f_ra,
1608 filp,
1609 ppos,
1610 desc,
1611 actor);
1612}
1613
1614ssize_t __blockdev_direct_IO(int rw, struct kiocb *iocb, struct inode *inode,
1615 struct block_device *bdev, const struct iovec *iov, loff_t offset,
1616 unsigned long nr_segs, get_blocks_t get_blocks, dio_iodone_t end_io,
1617 int lock_type);
1618
1619enum {
1620 DIO_LOCKING = 1, /* need locking between buffered and direct access */
1621 DIO_NO_LOCKING, /* bdev; no locking at all between buffered/direct */
1622 DIO_OWN_LOCKING, /* filesystem locks buffered and direct internally */
1623};
1624
1625static inline ssize_t blockdev_direct_IO(int rw, struct kiocb *iocb,
1626 struct inode *inode, struct block_device *bdev, const struct iovec *iov,
1627 loff_t offset, unsigned long nr_segs, get_blocks_t get_blocks,
1628 dio_iodone_t end_io)
1629{
1630 return __blockdev_direct_IO(rw, iocb, inode, bdev, iov, offset,
1631 nr_segs, get_blocks, end_io, DIO_LOCKING);
1632}
1633
1634static inline ssize_t blockdev_direct_IO_no_locking(int rw, struct kiocb *iocb,
1635 struct inode *inode, struct block_device *bdev, const struct iovec *iov,
1636 loff_t offset, unsigned long nr_segs, get_blocks_t get_blocks,
1637 dio_iodone_t end_io)
1638{
1639 return __blockdev_direct_IO(rw, iocb, inode, bdev, iov, offset,
1640 nr_segs, get_blocks, end_io, DIO_NO_LOCKING);
1641}
1642
1643static inline ssize_t blockdev_direct_IO_own_locking(int rw, struct kiocb *iocb,
1644 struct inode *inode, struct block_device *bdev, const struct iovec *iov,
1645 loff_t offset, unsigned long nr_segs, get_blocks_t get_blocks,
1646 dio_iodone_t end_io)
1647{
1648 return __blockdev_direct_IO(rw, iocb, inode, bdev, iov, offset,
1649 nr_segs, get_blocks, end_io, DIO_OWN_LOCKING);
1650}
1651
1652extern struct file_operations generic_ro_fops;
1653
1654#define special_file(m) (S_ISCHR(m)||S_ISBLK(m)||S_ISFIFO(m)||S_ISSOCK(m))
1655
1656extern int vfs_readlink(struct dentry *, char __user *, int, const char *);
1657extern int vfs_follow_link(struct nameidata *, const char *);
1658extern int page_readlink(struct dentry *, char __user *, int);
cc314eef
LT
1659extern void *page_follow_link_light(struct dentry *, struct nameidata *);
1660extern void page_put_link(struct dentry *, struct nameidata *, void *);
1da177e4
LT
1661extern int page_symlink(struct inode *inode, const char *symname, int len);
1662extern struct inode_operations page_symlink_inode_operations;
1663extern int generic_readlink(struct dentry *, char __user *, int);
1664extern void generic_fillattr(struct inode *, struct kstat *);
1665extern int vfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
1666void inode_add_bytes(struct inode *inode, loff_t bytes);
1667void inode_sub_bytes(struct inode *inode, loff_t bytes);
1668loff_t inode_get_bytes(struct inode *inode);
1669void inode_set_bytes(struct inode *inode, loff_t bytes);
1670
1671extern int vfs_readdir(struct file *, filldir_t, void *);
1672
1673extern int vfs_stat(char __user *, struct kstat *);
1674extern int vfs_lstat(char __user *, struct kstat *);
1675extern int vfs_fstat(unsigned int, struct kstat *);
1676
1677extern int vfs_ioctl(struct file *, unsigned int, unsigned int, unsigned long);
1678
1679extern struct file_system_type *get_fs_type(const char *name);
1680extern struct super_block *get_super(struct block_device *);
1681extern struct super_block *user_get_super(dev_t);
1682extern void drop_super(struct super_block *sb);
1683
1684extern int dcache_dir_open(struct inode *, struct file *);
1685extern int dcache_dir_close(struct inode *, struct file *);
1686extern loff_t dcache_dir_lseek(struct file *, loff_t, int);
1687extern int dcache_readdir(struct file *, void *, filldir_t);
1688extern int simple_getattr(struct vfsmount *, struct dentry *, struct kstat *);
1689extern int simple_statfs(struct super_block *, struct kstatfs *);
1690extern int simple_link(struct dentry *, struct inode *, struct dentry *);
1691extern int simple_unlink(struct inode *, struct dentry *);
1692extern int simple_rmdir(struct inode *, struct dentry *);
1693extern int simple_rename(struct inode *, struct dentry *, struct inode *, struct dentry *);
1694extern int simple_sync_file(struct file *, struct dentry *, int);
1695extern int simple_empty(struct dentry *);
1696extern int simple_readpage(struct file *file, struct page *page);
1697extern int simple_prepare_write(struct file *file, struct page *page,
1698 unsigned offset, unsigned to);
1699extern int simple_commit_write(struct file *file, struct page *page,
1700 unsigned offset, unsigned to);
1701
1702extern struct dentry *simple_lookup(struct inode *, struct dentry *, struct nameidata *);
1703extern ssize_t generic_read_dir(struct file *, char __user *, size_t, loff_t *);
1704extern struct file_operations simple_dir_operations;
1705extern struct inode_operations simple_dir_inode_operations;
1706struct tree_descr { char *name; struct file_operations *ops; int mode; };
1707struct dentry *d_alloc_name(struct dentry *, const char *);
1708extern int simple_fill_super(struct super_block *, int, struct tree_descr *);
1709extern int simple_pin_fs(char *name, struct vfsmount **mount, int *count);
1710extern void simple_release_fs(struct vfsmount **mount, int *count);
1711
1712extern ssize_t simple_read_from_buffer(void __user *, size_t, loff_t *, const void *, size_t);
1713
1714extern int inode_change_ok(struct inode *, struct iattr *);
1715extern int __must_check inode_setattr(struct inode *, struct iattr *);
1716
1717extern void inode_update_time(struct inode *inode, int ctime_too);
1718
1719static inline ino_t parent_ino(struct dentry *dentry)
1720{
1721 ino_t res;
1722
1723 spin_lock(&dentry->d_lock);
1724 res = dentry->d_parent->d_inode->i_ino;
1725 spin_unlock(&dentry->d_lock);
1726 return res;
1727}
1728
1729/* kernel/fork.c */
1730extern int unshare_files(void);
1731
1732/* Transaction based IO helpers */
1733
1734/*
1735 * An argresp is stored in an allocated page and holds the
1736 * size of the argument or response, along with its content
1737 */
1738struct simple_transaction_argresp {
1739 ssize_t size;
1740 char data[0];
1741};
1742
1743#define SIMPLE_TRANSACTION_LIMIT (PAGE_SIZE - sizeof(struct simple_transaction_argresp))
1744
1745char *simple_transaction_get(struct file *file, const char __user *buf,
1746 size_t size);
1747ssize_t simple_transaction_read(struct file *file, char __user *buf,
1748 size_t size, loff_t *pos);
1749int simple_transaction_release(struct inode *inode, struct file *file);
1750
1751static inline void simple_transaction_set(struct file *file, size_t n)
1752{
1753 struct simple_transaction_argresp *ar = file->private_data;
1754
1755 BUG_ON(n > SIMPLE_TRANSACTION_LIMIT);
1756
1757 /*
1758 * The barrier ensures that ar->size will really remain zero until
1759 * ar->data is ready for reading.
1760 */
1761 smp_mb();
1762 ar->size = n;
1763}
1764
acaefc25
AB
1765/*
1766 * simple attribute files
1767 *
1768 * These attributes behave similar to those in sysfs:
1769 *
1770 * Writing to an attribute immediately sets a value, an open file can be
1771 * written to multiple times.
1772 *
1773 * Reading from an attribute creates a buffer from the value that might get
1774 * read with multiple read calls. When the attribute has been read
1775 * completely, no further read calls are possible until the file is opened
1776 * again.
1777 *
1778 * All attributes contain a text representation of a numeric value
1779 * that are accessed with the get() and set() functions.
1780 */
1781#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt) \
1782static int __fops ## _open(struct inode *inode, struct file *file) \
1783{ \
1784 __simple_attr_check_format(__fmt, 0ull); \
1785 return simple_attr_open(inode, file, __get, __set, __fmt); \
1786} \
1787static struct file_operations __fops = { \
1788 .owner = THIS_MODULE, \
1789 .open = __fops ## _open, \
1790 .release = simple_attr_close, \
1791 .read = simple_attr_read, \
1792 .write = simple_attr_write, \
1793};
1794
1795static inline void __attribute__((format(printf, 1, 2)))
1796__simple_attr_check_format(const char *fmt, ...)
1797{
1798 /* don't do anything, just let the compiler check the arguments; */
1799}
1800
1801int simple_attr_open(struct inode *inode, struct file *file,
1802 u64 (*get)(void *), void (*set)(void *, u64),
1803 const char *fmt);
1804int simple_attr_close(struct inode *inode, struct file *file);
1805ssize_t simple_attr_read(struct file *file, char __user *buf,
1806 size_t len, loff_t *ppos);
1807ssize_t simple_attr_write(struct file *file, const char __user *buf,
1808 size_t len, loff_t *ppos);
1809
1810
1da177e4
LT
1811#ifdef CONFIG_SECURITY
1812static inline char *alloc_secdata(void)
1813{
1814 return (char *)get_zeroed_page(GFP_KERNEL);
1815}
1816
1817static inline void free_secdata(void *secdata)
1818{
1819 free_page((unsigned long)secdata);
1820}
1821#else
1822static inline char *alloc_secdata(void)
1823{
1824 return (char *)1;
1825}
1826
1827static inline void free_secdata(void *secdata)
1828{ }
1829#endif /* CONFIG_SECURITY */
1830
1831#endif /* __KERNEL__ */
1832#endif /* _LINUX_FS_H */