blob: 7239baac81a9e29dda405b16116762f260ed95f2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Wrapper functions for accessing the file_struct fd array.
3 */
4
5#ifndef __LINUX_FILE_H
6#define __LINUX_FILE_H
7
8#include <asm/atomic.h>
9#include <linux/posix_types.h>
10#include <linux/compiler.h>
11#include <linux/spinlock.h>
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070012#include <linux/rcupdate.h>
Eric Dumazet0c9e63f2006-03-23 03:00:12 -080013#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15/*
16 * The default fd array needs to be at least BITS_PER_LONG,
17 * as this is the granularity returned by copy_fdset().
18 */
19#define NR_OPEN_DEFAULT BITS_PER_LONG
20
Eric Dumazet0c9e63f2006-03-23 03:00:12 -080021/*
22 * The embedded_fd_set is a small fd_set,
23 * suitable for most tasks (which open <= BITS_PER_LONG files)
24 */
25struct embedded_fd_set {
26 unsigned long fds_bits[1];
27};
28
Dipankar Sarmabadf1662005-09-09 13:04:10 -070029struct fdtable {
30 unsigned int max_fds;
Dipankar Sarmabadf1662005-09-09 13:04:10 -070031 struct file ** fd; /* current fd array */
32 fd_set *close_on_exec;
33 fd_set *open_fds;
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070034 struct rcu_head rcu;
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070035 struct fdtable *next;
Dipankar Sarmabadf1662005-09-09 13:04:10 -070036};
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038/*
39 * Open file table structure
40 */
41struct files_struct {
Eric Dumazet0c9e63f2006-03-23 03:00:12 -080042 /*
43 * read mostly part
44 */
Eric Dumazet95e861d2005-11-13 16:06:24 -080045 atomic_t count;
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070046 struct fdtable *fdt;
Dipankar Sarmabadf1662005-09-09 13:04:10 -070047 struct fdtable fdtab;
Eric Dumazet0c9e63f2006-03-23 03:00:12 -080048 /*
49 * written part on a separate cache line in SMP
50 */
51 spinlock_t file_lock ____cacheline_aligned_in_smp;
52 int next_fd;
53 struct embedded_fd_set close_on_exec_init;
54 struct embedded_fd_set open_fds_init;
Eric Dumazet95e861d2005-11-13 16:06:24 -080055 struct file * fd_array[NR_OPEN_DEFAULT];
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070058#define files_fdtable(files) (rcu_dereference((files)->fdt))
Dipankar Sarmabadf1662005-09-09 13:04:10 -070059
Christoph Lameter8b7d91e2006-12-06 20:32:52 -080060extern struct kmem_cache *filp_cachep;
61
Harvey Harrisonb3c97522008-02-13 15:03:15 -080062extern void __fput(struct file *);
63extern void fput(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Dave Hansence8d2cd2007-10-16 23:31:13 -070065struct file_operations;
66struct vfsmount;
67struct dentry;
68extern int init_file(struct file *, struct vfsmount *mnt,
69 struct dentry *dentry, mode_t mode,
70 const struct file_operations *fop);
71extern struct file *alloc_file(struct vfsmount *, struct dentry *dentry,
72 mode_t mode, const struct file_operations *fop);
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074static inline void fput_light(struct file *file, int fput_needed)
75{
76 if (unlikely(fput_needed))
77 fput(file);
78}
79
Harvey Harrisonb3c97522008-02-13 15:03:15 -080080extern struct file *fget(unsigned int fd);
81extern struct file *fget_light(unsigned int fd, int *fput_needed);
82extern void set_close_on_exec(unsigned int fd, int flag);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083extern void put_filp(struct file *);
84extern int get_unused_fd(void);
Ulrich Drepper4a195422007-07-15 23:40:34 -070085extern int get_unused_fd_flags(int flags);
Harvey Harrisonb3c97522008-02-13 15:03:15 -080086extern void put_unused_fd(unsigned int fd);
Pekka J Enberg2109a2d2005-11-07 00:58:01 -080087struct kmem_cache;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Linus Torvalds1da177e2005-04-16 15:20:36 -070089extern int expand_files(struct files_struct *, int nr);
Vadim Lobanov4fd45812006-12-10 02:21:17 -080090extern void free_fdtable_rcu(struct rcu_head *rcu);
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -070091extern void __init files_defer_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Vadim Lobanov01b2d932006-12-22 01:10:43 -080093static inline void free_fdtable(struct fdtable *fdt)
94{
95 call_rcu(&fdt->rcu, free_fdtable_rcu);
96}
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098static inline struct file * fcheck_files(struct files_struct *files, unsigned int fd)
99{
100 struct file * file = NULL;
Dipankar Sarmabadf1662005-09-09 13:04:10 -0700101 struct fdtable *fdt = files_fdtable(files);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Dipankar Sarmabadf1662005-09-09 13:04:10 -0700103 if (fd < fdt->max_fds)
Dipankar Sarmaab2af1f2005-09-09 13:04:13 -0700104 file = rcu_dereference(fdt->fd[fd]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 return file;
106}
107
108/*
109 * Check whether the specified fd has an open file.
110 */
111#define fcheck(fd) fcheck_files(current->files, fd)
112
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800113extern void fd_install(unsigned int fd, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115struct task_struct;
116
117struct files_struct *get_files_struct(struct task_struct *);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800118void put_files_struct(struct files_struct *fs);
Kirill Korotaev3b9b8ab2006-09-29 02:00:05 -0700119void reset_files_struct(struct task_struct *, struct files_struct *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Christoph Lameter5d6538f2006-12-06 20:32:50 -0800121extern struct kmem_cache *files_cachep;
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123#endif /* __LINUX_FILE_H */