FreeBSD/Linux Kernel Cross Reference
sys/sys/file.h
1 /*-
2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)file.h 8.3 (Berkeley) 1/9/95
30 * $FreeBSD$
31 */
32
33 #ifndef _SYS_FILE_H_
34 #define _SYS_FILE_H_
35
36 #ifndef _KERNEL
37 #include <sys/types.h> /* XXX */
38 #include <sys/fcntl.h>
39 #include <sys/unistd.h>
40 #else
41 #include <sys/queue.h>
42 #include <sys/_lock.h>
43 #include <sys/_mutex.h>
44
45 struct stat;
46 struct thread;
47 struct uio;
48 struct knote;
49 struct vnode;
50 struct socket;
51
52
53 #endif /* _KERNEL */
54
55 #define DTYPE_VNODE 1 /* file */
56 #define DTYPE_SOCKET 2 /* communications endpoint */
57 #define DTYPE_PIPE 3 /* pipe */
58 #define DTYPE_FIFO 4 /* fifo (named pipe) */
59 #define DTYPE_KQUEUE 5 /* event queue */
60 #define DTYPE_CRYPTO 6 /* crypto */
61 #define DTYPE_MQUEUE 7 /* posix message queue */
62 #define DTYPE_SEM 9 /* posix semaphore */
63
64 #ifdef _KERNEL
65
66 struct file;
67 struct ucred;
68
69 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
70 struct ucred *active_cred, int flags,
71 struct thread *td);
72 #define FOF_OFFSET 1 /* Use the offset in uio argument */
73 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
74 struct ucred *active_cred, struct thread *td);
75 typedef int fo_poll_t(struct file *fp, int events,
76 struct ucred *active_cred, struct thread *td);
77 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
78 typedef int fo_stat_t(struct file *fp, struct stat *sb,
79 struct ucred *active_cred, struct thread *td);
80 typedef int fo_close_t(struct file *fp, struct thread *td);
81 typedef int fo_flags_t;
82
83 struct fileops {
84 fo_rdwr_t *fo_read;
85 fo_rdwr_t *fo_write;
86 fo_ioctl_t *fo_ioctl;
87 fo_poll_t *fo_poll;
88 fo_kqfilter_t *fo_kqfilter;
89 fo_stat_t *fo_stat;
90 fo_close_t *fo_close;
91 fo_flags_t fo_flags; /* DFLAG_* below */
92 };
93
94 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
95 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
96
97 /*
98 * Kernel descriptor table.
99 * One entry for each open kernel vnode and socket.
100 *
101 * Below is the list of locks that protects members in struct file.
102 *
103 * (fl) filelist_lock
104 * (f) f_mtx in struct file
105 * (d) cdevpriv_mtx
106 * none not locked
107 */
108
109 struct file {
110 LIST_ENTRY(file) f_list;/* (fl) list of active files */
111 short f_type; /* descriptor type */
112 void *f_data; /* file descriptor specific data */
113 u_int f_flag; /* see fcntl.h */
114 struct mtx *f_mtxp; /* mutex to protect data */
115 struct fileops *f_ops; /* File operations */
116 struct ucred *f_cred; /* credentials associated with descriptor */
117 int f_count; /* (f) reference count */
118 struct vnode *f_vnode; /* NULL or applicable vnode */
119
120 /* DFLAG_SEEKABLE specific fields */
121 off_t f_offset;
122 short f_vnread_flags; /*
123 * (f) home grown sleep lock for f_offset
124 * Used only for shared vnode locking in
125 * vnread()
126 */
127 #define FOFFSET_LOCKED 0x1
128 #define FOFFSET_LOCK_WAITING 0x2
129 /* DTYPE_SOCKET specific fields */
130 short f_gcflag; /* used by thread doing fd garbage collection */
131 #define FMARK 0x1 /* mark during gc() */
132 #define FDEFER 0x2 /* defer for next gc pass */
133 #define FWAIT 0x4 /* gc is scanning message buffers */
134 int f_msgcount; /* (f) references from message queue */
135
136 /* DTYPE_VNODE specific fields */
137 int f_seqcount; /*
138 * count of sequential accesses -- cleared
139 * by most seek operations.
140 */
141 off_t f_nextoff; /*
142 * offset of next expected read or write
143 */
144 void *f_label; /* Place-holder for struct label pointer. */
145 struct cdev_privdata *f_cdevpriv; /* (d) Private data for the cdev. */
146 };
147
148 #endif /* _KERNEL */
149
150 /*
151 * Userland version of struct file, for sysctl
152 */
153 struct xfile {
154 size_t xf_size; /* size of struct xfile */
155 pid_t xf_pid; /* owning process */
156 uid_t xf_uid; /* effective uid of owning process */
157 int xf_fd; /* descriptor number */
158 void *xf_file; /* address of struct file */
159 short xf_type; /* descriptor type */
160 int xf_count; /* reference count */
161 int xf_msgcount; /* references from message queue */
162 off_t xf_offset; /* file offset */
163 void *xf_data; /* file descriptor specific data */
164 void *xf_vnode; /* vnode pointer */
165 u_int xf_flag; /* flags (see fcntl.h) */
166 };
167
168 #ifdef _KERNEL
169
170 #ifdef MALLOC_DECLARE
171 MALLOC_DECLARE(M_FILE);
172 #endif
173
174 LIST_HEAD(filelist, file);
175 extern struct filelist filehead; /* (fl) head of list of open files */
176 extern struct fileops vnops;
177 extern struct fileops badfileops;
178 extern struct fileops socketops;
179 extern int maxfiles; /* kernel limit on number of open files */
180 extern int maxfilesperproc; /* per process limit on number of open files */
181 extern int openfiles; /* (fl) actual number of open files */
182 extern struct sx filelist_lock; /* sx to protect filelist and openfiles */
183
184 int fget(struct thread *td, int fd, struct file **fpp);
185 int fget_read(struct thread *td, int fd, struct file **fpp);
186 int fget_write(struct thread *td, int fd, struct file **fpp);
187 int fdrop(struct file *fp, struct thread *td);
188
189 /*
190 * The socket operations are used a couple of places.
191 * XXX: This is wrong, they should go through the operations vector for
192 * XXX: sockets instead of going directly for the individual functions. /phk
193 */
194 fo_rdwr_t soo_read;
195 fo_rdwr_t soo_write;
196 fo_ioctl_t soo_ioctl;
197 fo_poll_t soo_poll;
198 fo_kqfilter_t soo_kqfilter;
199 fo_stat_t soo_stat;
200 fo_close_t soo_close;
201
202 /* Lock a file. */
203 #define FILE_LOCK(f) mtx_lock((f)->f_mtxp)
204 #define FILE_UNLOCK(f) mtx_unlock((f)->f_mtxp)
205 #define FILE_LOCKED(f) mtx_owned((f)->f_mtxp)
206 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
207
208 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
209 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
210 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
211
212 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
213 void fputsock(struct socket *sp);
214
215 #define fhold_locked(fp) \
216 do { \
217 FILE_LOCK_ASSERT(fp, MA_OWNED); \
218 (fp)->f_count++; \
219 } while (0)
220
221 #define fhold(fp) \
222 do { \
223 FILE_LOCK(fp); \
224 (fp)->f_count++; \
225 FILE_UNLOCK(fp); \
226 } while (0)
227
228 static __inline fo_rdwr_t fo_read;
229 static __inline fo_rdwr_t fo_write;
230 static __inline fo_ioctl_t fo_ioctl;
231 static __inline fo_poll_t fo_poll;
232 static __inline fo_kqfilter_t fo_kqfilter;
233 static __inline fo_stat_t fo_stat;
234 static __inline fo_close_t fo_close;
235
236 static __inline int
237 fo_read(fp, uio, active_cred, flags, td)
238 struct file *fp;
239 struct uio *uio;
240 struct ucred *active_cred;
241 int flags;
242 struct thread *td;
243 {
244
245 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
246 }
247
248 static __inline int
249 fo_write(fp, uio, active_cred, flags, td)
250 struct file *fp;
251 struct uio *uio;
252 struct ucred *active_cred;
253 int flags;
254 struct thread *td;
255 {
256
257 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
258 }
259
260 static __inline int
261 fo_ioctl(fp, com, data, active_cred, td)
262 struct file *fp;
263 u_long com;
264 void *data;
265 struct ucred *active_cred;
266 struct thread *td;
267 {
268
269 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
270 }
271
272 static __inline int
273 fo_poll(fp, events, active_cred, td)
274 struct file *fp;
275 int events;
276 struct ucred *active_cred;
277 struct thread *td;
278 {
279
280 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
281 }
282
283 static __inline int
284 fo_stat(fp, sb, active_cred, td)
285 struct file *fp;
286 struct stat *sb;
287 struct ucred *active_cred;
288 struct thread *td;
289 {
290
291 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
292 }
293
294 static __inline int
295 fo_close(fp, td)
296 struct file *fp;
297 struct thread *td;
298 {
299
300 return ((*fp->f_ops->fo_close)(fp, td));
301 }
302
303 static __inline int
304 fo_kqfilter(fp, kn)
305 struct file *fp;
306 struct knote *kn;
307 {
308
309 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
310 }
311
312 #endif /* _KERNEL */
313
314 #endif /* !SYS_FILE_H */
Cache object: a2c7e53cd1b7910a6bc547f18a3e3d48
|