blob: 61eb82cbafbad4c61258cd8ab1754f60e3ca5910 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/compiler.h>
Eric Dumazet0c9e63f2006-03-23 03:00:12 -08009#include <linux/types.h>
Al Viro9f3acc32008-04-24 07:44:08 -040010#include <linux/posix_types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Al Viro9f3acc32008-04-24 07:44:08 -040012struct file;
Christoph Lameter8b7d91e2006-12-06 20:32:52 -080013
Harvey Harrisonb3c97522008-02-13 15:03:15 -080014extern void fput(struct file *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Dave Hansence8d2cd2007-10-16 23:31:13 -070016struct file_operations;
17struct vfsmount;
18struct dentry;
Al Viro2c48b9c2009-08-09 00:52:35 +040019struct path;
Al Viroa4141d72016-11-20 20:28:12 -050020extern struct file *alloc_file(const struct path *, fmode_t mode,
Al Viro2c48b9c2009-08-09 00:52:35 +040021 const struct file_operations *fop);
Dave Hansence8d2cd2007-10-16 23:31:13 -070022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023static inline void fput_light(struct file *file, int fput_needed)
24{
Steven Rostedtc2b3e742010-12-13 19:38:08 -050025 if (fput_needed)
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 fput(file);
27}
28
Al Viroa5b470b2012-08-27 19:55:01 -040029struct fd {
30 struct file *file;
Linus Torvalds9c225f22014-03-03 09:36:58 -080031 unsigned int flags;
Al Viroa5b470b2012-08-27 19:55:01 -040032};
Linus Torvalds9c225f22014-03-03 09:36:58 -080033#define FDPUT_FPUT 1
34#define FDPUT_POS_UNLOCK 2
Al Viroa5b470b2012-08-27 19:55:01 -040035
36static inline void fdput(struct fd fd)
37{
Linus Torvalds9c225f22014-03-03 09:36:58 -080038 if (fd.flags & FDPUT_FPUT)
Al Viroa5b470b2012-08-27 19:55:01 -040039 fput(fd.file);
40}
41
Harvey Harrisonb3c97522008-02-13 15:03:15 -080042extern struct file *fget(unsigned int fd);
Al Virobd2a31d2014-03-04 14:54:22 -050043extern struct file *fget_raw(unsigned int fd);
44extern unsigned long __fdget(unsigned int fd);
45extern unsigned long __fdget_raw(unsigned int fd);
46extern unsigned long __fdget_pos(unsigned int fd);
Al Viro63b6df12016-04-20 17:08:21 -040047extern void __f_unlock_pos(struct file *);
Al Virobd2a31d2014-03-04 14:54:22 -050048
49static inline struct fd __to_fd(unsigned long v)
50{
51 return (struct fd){(struct file *)(v & ~3),v & 3};
52}
Al Viroa5b470b2012-08-27 19:55:01 -040053
54static inline struct fd fdget(unsigned int fd)
55{
Al Virobd2a31d2014-03-04 14:54:22 -050056 return __to_fd(__fdget(fd));
Al Viroa5b470b2012-08-27 19:55:01 -040057}
58
59static inline struct fd fdget_raw(unsigned int fd)
60{
Al Virobd2a31d2014-03-04 14:54:22 -050061 return __to_fd(__fdget_raw(fd));
Al Viroa5b470b2012-08-27 19:55:01 -040062}
63
Al Viro63b6df12016-04-20 17:08:21 -040064static inline struct fd fdget_pos(int fd)
65{
66 return __to_fd(__fdget_pos(fd));
67}
68
69static inline void fdput_pos(struct fd f)
70{
71 if (f.flags & FDPUT_POS_UNLOCK)
72 __f_unlock_pos(f.file);
73 fdput(f);
74}
75
Al Virofe17f222012-08-21 11:48:11 -040076extern int f_dupfd(unsigned int from, struct file *file, unsigned flags);
Al Viro8280d162012-08-21 12:11:46 -040077extern int replace_fd(unsigned fd, struct file *file, unsigned flags);
Harvey Harrisonb3c97522008-02-13 15:03:15 -080078extern void set_close_on_exec(unsigned int fd, int flag);
Al Virofe17f222012-08-21 11:48:11 -040079extern bool get_close_on_exec(unsigned int fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080extern void put_filp(struct file *);
Al Viro1a7bd222012-08-12 17:18:05 -040081extern int get_unused_fd_flags(unsigned flags);
Harvey Harrisonb3c97522008-02-13 15:03:15 -080082extern void put_unused_fd(unsigned int fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
Harvey Harrisonb3c97522008-02-13 15:03:15 -080084extern void fd_install(unsigned int fd, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Al Viro4a9d4b02012-06-24 09:56:45 +040086extern void flush_delayed_fput(void);
87extern void __fput_sync(struct file *);
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#endif /* __LINUX_FILE_H */