2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @(#)file.h 8.3 (Berkeley) 1/9/95
41 #include <sys/fcntl.h>
42 #include <sys/unistd.h>
46 #include <sys/queue.h>
47 #include <sys/_lock.h>
48 #include <sys/_mutex.h>
58 * Kernel descriptor table.
59 * One entry for each open kernel vnode and socket.
61 * Below is the list of locks that protects members in struct file.
64 * (f) f_mtx in struct file
68 LIST_ENTRY(file) f_list;/* (fl) list of active files */
69 short f_gcflag; /* used by thread doing fd garbage collection */
70 #define DTYPE_VNODE 1 /* file */
71 #define DTYPE_SOCKET 2 /* communications endpoint */
72 #define DTYPE_PIPE 3 /* pipe */
73 #define DTYPE_FIFO 4 /* fifo (named pipe) */
74 #define DTYPE_KQUEUE 5 /* event queue */
75 short f_type; /* descriptor type */
76 int f_count; /* (f) reference count */
77 int f_msgcount; /* (f) references from message queue */
78 struct ucred *f_cred; /* credentials associated with descriptor */
80 int (*fo_read)(struct file *fp, struct uio *uio,
81 struct ucred *cred, int flags, struct thread *td);
82 int (*fo_write)(struct file *fp, struct uio *uio,
83 struct ucred *cred, int flags, struct thread *td);
85 int (*fo_ioctl)(struct file *fp, u_long com, caddr_t data,
87 int (*fo_poll)(struct file *fp, int events,
88 struct ucred *cred, struct thread *td);
89 int (*fo_kqfilter)(struct file *fp, struct knote *kn);
90 int (*fo_stat)(struct file *fp, struct stat *sb,
92 int (*fo_close)(struct file *fp, struct thread *td);
95 * count of sequential accesses -- cleared
96 * by most seek operations.
99 * offset of next expected read or write
102 caddr_t f_data; /* vnode or socket */
103 u_int f_flag; /* see fcntl.h */
104 struct mtx *f_mtxp; /* mutex to protect data */
107 #ifdef MALLOC_DECLARE
108 MALLOC_DECLARE(M_FILE);
111 LIST_HEAD(filelist, file);
112 extern struct filelist filehead; /* (fl) head of list of open files */
113 extern struct fileops vnops;
114 extern struct fileops badfileops;
115 extern int maxfiles; /* kernel limit on number of open files */
116 extern int maxfilesperproc; /* per process limit on number of open files */
117 extern int nfiles; /* (fl) actual number of open files */
118 extern struct sx filelist_lock; /* sx to protect filelist and nfiles */
120 int fget(struct thread *td, int fd, struct file **fpp);
121 int fget_read(struct thread *td, int fd, struct file **fpp);
122 int fget_write(struct thread *td, int fd, struct file **fpp);
123 int fdrop(struct file *fp, struct thread *td);
124 int fdrop_locked(struct file *fp, struct thread *td);
127 #define FILE_LOCK(f) mtx_lock((f)->f_mtxp)
128 #define FILE_UNLOCK(f) mtx_unlock((f)->f_mtxp)
129 #define FILE_LOCKED(f) mtx_owned((f)->f_mtxp)
130 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
132 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
133 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
134 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
136 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
137 void fputsock(struct socket *sp);
139 #define fhold_locked(fp) \
141 FILE_LOCK_ASSERT(fp, MA_OWNED); \
152 static __inline int fo_read(struct file *fp, struct uio *uio,
153 struct ucred *cred, int flags, struct thread *td);
154 static __inline int fo_write(struct file *fp, struct uio *uio,
155 struct ucred *cred, int flags, struct thread *td);
156 static __inline int fo_ioctl(struct file *fp, u_long com, caddr_t data,
158 static __inline int fo_poll(struct file *fp, int events,
159 struct ucred *cred, struct thread *td);
160 static __inline int fo_stat(struct file *fp, struct stat *sb,
162 static __inline int fo_close(struct file *fp, struct thread *td);
163 static __inline int fo_kqfilter(struct file *fp, struct knote *kn);
167 fo_read(fp, uio, cred, flags, td)
175 return ((*fp->f_ops->fo_read)(fp, uio, cred, flags, td));
179 fo_write(fp, uio, cred, flags, td)
186 return ((*fp->f_ops->fo_write)(fp, uio, cred, flags, td));
190 fo_ioctl(fp, com, data, td)
196 return ((*fp->f_ops->fo_ioctl)(fp, com, data, td));
200 fo_poll(fp, events, cred, td)
206 /* select(2) and poll(2) hold file descriptors. */
207 return ((*fp->f_ops->fo_poll)(fp, events, cred, td));
216 return ((*fp->f_ops->fo_stat)(fp, sb, td));
225 return ((*fp->f_ops->fo_close)(fp, td));
234 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
239 #endif /* !SYS_FILE_H */