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 * 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.
20 *
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
31 * SUCH DAMAGE.
32 *
33 * @(#)file.h 8.3 (Berkeley) 1/9/95
34 * $FreeBSD: releng/5.2/sys/sys/file.h 116678 2003-06-22 08:41:43Z phk $
35 */
36
37 #ifndef _SYS_FILE_H_
38 #define _SYS_FILE_H_
39
40 #ifndef _KERNEL
41 #include <sys/types.h> /* XXX */
42 #include <sys/fcntl.h>
43 #include <sys/unistd.h>
44 #else
45 #include <sys/queue.h>
46 #include <sys/_lock.h>
47 #include <sys/_mutex.h>
48
49 struct stat;
50 struct thread;
51 struct uio;
52 struct knote;
53 struct vnode;
54 struct socket;
55
56
57 #endif /* _KERNEL */
58
59 #define DTYPE_VNODE 1 /* file */
60 #define DTYPE_SOCKET 2 /* communications endpoint */
61 #define DTYPE_PIPE 3 /* pipe */
62 #define DTYPE_FIFO 4 /* fifo (named pipe) */
63 #define DTYPE_KQUEUE 5 /* event queue */
64 #define DTYPE_CRYPTO 6 /* crypto */
65
66 #ifdef _KERNEL
67
68 struct file;
69 struct ucred;
70
71 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
72 struct ucred *active_cred, int flags,
73 struct thread *td);
74 #define FOF_OFFSET 1 /* Use the offset in uio argument */
75 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
76 struct ucred *active_cred, struct thread *td);
77 typedef int fo_poll_t(struct file *fp, int events,
78 struct ucred *active_cred, struct thread *td);
79 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
80 typedef int fo_stat_t(struct file *fp, struct stat *sb,
81 struct ucred *active_cred, struct thread *td);
82 typedef int fo_close_t(struct file *fp, struct thread *td);
83 typedef int fo_flags_t;
84
85 struct fileops {
86 fo_rdwr_t *fo_read;
87 fo_rdwr_t *fo_write;
88 fo_ioctl_t *fo_ioctl;
89 fo_poll_t *fo_poll;
90 fo_kqfilter_t *fo_kqfilter;
91 fo_stat_t *fo_stat;
92 fo_close_t *fo_close;
93 fo_flags_t fo_flags; /* DFLAG_* below */
94 };
95
96 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
97 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
98
99 /*
100 * Kernel descriptor table.
101 * One entry for each open kernel vnode and socket.
102 *
103 * Below is the list of locks that protects members in struct file.
104 *
105 * (fl) filelist_lock
106 * (f) f_mtx in struct file
107 * none not locked
108 */
109
110 struct file {
111 LIST_ENTRY(file) f_list;/* (fl) list of active files */
112 short f_type; /* descriptor type */
113 void *f_data; /* file descriptor specific data */
114 u_int f_flag; /* see fcntl.h */
115 struct mtx *f_mtxp; /* mutex to protect data */
116 struct fileops *f_ops; /* File operations */
117 struct ucred *f_cred; /* credentials associated with descriptor */
118 int f_count; /* (f) reference count */
119 struct vnode *f_vnode; /* NULL or applicable vnode */
120
121 /* DFLAG_SEEKABLE specific fields */
122 off_t f_offset;
123
124 /* DTYPE_SOCKET specific fields */
125 short f_gcflag; /* used by thread doing fd garbage collection */
126 #define FMARK 0x1 /* mark during gc() */
127 #define FDEFER 0x2 /* defer for next gc pass */
128 int f_msgcount; /* (f) references from message queue */
129
130 /* DTYPE_VNODE specific fields */
131 int f_seqcount; /*
132 * count of sequential accesses -- cleared
133 * by most seek operations.
134 */
135 off_t f_nextoff; /*
136 * offset of next expected read or write
137 */
138 };
139
140 #endif /* _KERNEL */
141
142 /*
143 * Userland version of struct file, for sysctl
144 */
145 struct xfile {
146 size_t xf_size; /* size of struct xfile */
147 pid_t xf_pid; /* owning process */
148 uid_t xf_uid; /* effective uid of owning process */
149 int xf_fd; /* descriptor number */
150 void *xf_file; /* address of struct file */
151 short xf_type; /* descriptor type */
152 int xf_count; /* reference count */
153 int xf_msgcount; /* references from message queue */
154 off_t xf_offset; /* file offset */
155 void *xf_data; /* file descriptor specific data */
156 u_int xf_flag; /* flags (see fcntl.h) */
157 };
158
159 #ifdef _KERNEL
160
161 #ifdef MALLOC_DECLARE
162 MALLOC_DECLARE(M_FILE);
163 #endif
164
165 LIST_HEAD(filelist, file);
166 extern struct filelist filehead; /* (fl) head of list of open files */
167 extern struct fileops vnops;
168 extern struct fileops badfileops;
169 extern struct fileops socketops;
170 extern int maxfiles; /* kernel limit on number of open files */
171 extern int maxfilesperproc; /* per process limit on number of open files */
172 extern int nfiles; /* (fl) actual number of open files */
173 extern struct sx filelist_lock; /* sx to protect filelist and nfiles */
174
175 int fget(struct thread *td, int fd, struct file **fpp);
176 int fget_read(struct thread *td, int fd, struct file **fpp);
177 int fget_write(struct thread *td, int fd, struct file **fpp);
178 int fdrop(struct file *fp, struct thread *td);
179 int fdrop_locked(struct file *fp, struct thread *td);
180
181 /*
182 * The socket operations are used a couple of places.
183 * XXX: This is wrong, they should go through the operations vector for
184 * XXX: sockets instead of going directly for the individual functions. /phk
185 */
186 fo_rdwr_t soo_read;
187 fo_rdwr_t soo_write;
188 fo_ioctl_t soo_ioctl;
189 fo_poll_t soo_poll;
190 fo_kqfilter_t soo_kqfilter;
191 fo_stat_t soo_stat;
192 fo_close_t soo_close;
193
194 /* Lock a file. */
195 #define FILE_LOCK(f) mtx_lock((f)->f_mtxp)
196 #define FILE_UNLOCK(f) mtx_unlock((f)->f_mtxp)
197 #define FILE_LOCKED(f) mtx_owned((f)->f_mtxp)
198 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
199
200 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
201 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
202 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
203
204 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
205 void fputsock(struct socket *sp);
206
207 #define fhold_locked(fp) \
208 do { \
209 FILE_LOCK_ASSERT(fp, MA_OWNED); \
210 (fp)->f_count++; \
211 } while (0)
212
213 #define fhold(fp) \
214 do { \
215 FILE_LOCK(fp); \
216 fhold_locked(fp); \
217 FILE_UNLOCK(fp); \
218 } while (0)
219
220 static __inline fo_rdwr_t fo_read;
221 static __inline fo_rdwr_t fo_write;
222 static __inline fo_ioctl_t fo_ioctl;
223 static __inline fo_poll_t fo_poll;
224 static __inline fo_kqfilter_t fo_kqfilter;
225 static __inline fo_stat_t fo_stat;
226 static __inline fo_close_t fo_close;
227
228 static __inline int
229 fo_read(fp, uio, active_cred, flags, td)
230 struct file *fp;
231 struct uio *uio;
232 struct ucred *active_cred;
233 int flags;
234 struct thread *td;
235 {
236
237 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
238 }
239
240 static __inline int
241 fo_write(fp, uio, active_cred, flags, td)
242 struct file *fp;
243 struct uio *uio;
244 struct ucred *active_cred;
245 int flags;
246 struct thread *td;
247 {
248
249 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
250 }
251
252 static __inline int
253 fo_ioctl(fp, com, data, active_cred, td)
254 struct file *fp;
255 u_long com;
256 void *data;
257 struct ucred *active_cred;
258 struct thread *td;
259 {
260
261 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
262 }
263
264 static __inline int
265 fo_poll(fp, events, active_cred, td)
266 struct file *fp;
267 int events;
268 struct ucred *active_cred;
269 struct thread *td;
270 {
271
272 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
273 }
274
275 static __inline int
276 fo_stat(fp, sb, active_cred, td)
277 struct file *fp;
278 struct stat *sb;
279 struct ucred *active_cred;
280 struct thread *td;
281 {
282
283 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
284 }
285
286 static __inline int
287 fo_close(fp, td)
288 struct file *fp;
289 struct thread *td;
290 {
291
292 return ((*fp->f_ops->fo_close)(fp, td));
293 }
294
295 static __inline int
296 fo_kqfilter(fp, kn)
297 struct file *fp;
298 struct knote *kn;
299 {
300
301 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
302 }
303
304 #endif /* _KERNEL */
305
306 #endif /* !SYS_FILE_H */
Cache object: 7d4d2fc75a0585df3b4c7d5b1b09ca0a
|