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.1/sys/sys/file.h 110908 2003-02-15 06:04:55Z alfred $
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
98 /*
99 * Kernel descriptor table.
100 * One entry for each open kernel vnode and socket.
101 *
102 * Below is the list of locks that protects members in struct file.
103 *
104 * (fl) filelist_lock
105 * (f) f_mtx in struct file
106 * none not locked
107 */
108
109 struct file {
110 LIST_ENTRY(file) f_list;/* (fl) list of active files */
111 short f_gcflag; /* used by thread doing fd garbage collection */
112 short f_type; /* descriptor type */
113 int f_count; /* (f) reference count */
114 int f_msgcount; /* (f) references from message queue */
115 struct ucred *f_cred; /* credentials associated with descriptor */
116 struct fileops *f_ops; /* File operations */
117 int f_seqcount; /*
118 * count of sequential accesses -- cleared
119 * by most seek operations.
120 */
121 off_t f_nextoff; /*
122 * offset of next expected read or write
123 */
124 off_t f_offset;
125 void *f_data; /* file descriptor specific data */
126 u_int f_flag; /* see fcntl.h */
127 struct mtx *f_mtxp; /* mutex to protect data */
128 };
129
130 #endif /* _KERNEL */
131
132 /*
133 * Userland version of struct file, for sysctl
134 */
135 struct xfile {
136 size_t xf_size; /* size of struct xfile */
137 pid_t xf_pid; /* owning process */
138 uid_t xf_uid; /* effective uid of owning process */
139 int xf_fd; /* descriptor number */
140 void *xf_file; /* address of struct file */
141 short xf_type; /* descriptor type */
142 int xf_count; /* reference count */
143 int xf_msgcount; /* references from message queue */
144 off_t xf_offset; /* file offset */
145 void *xf_data; /* file descriptor specific data */
146 u_int xf_flag; /* flags (see fcntl.h) */
147 };
148
149 #ifdef _KERNEL
150
151 #ifdef MALLOC_DECLARE
152 MALLOC_DECLARE(M_FILE);
153 #endif
154
155 LIST_HEAD(filelist, file);
156 extern struct filelist filehead; /* (fl) head of list of open files */
157 extern struct fileops vnops;
158 extern struct fileops badfileops;
159 extern struct fileops socketops;
160 extern int maxfiles; /* kernel limit on number of open files */
161 extern int maxfilesperproc; /* per process limit on number of open files */
162 extern int nfiles; /* (fl) actual number of open files */
163 extern struct sx filelist_lock; /* sx to protect filelist and nfiles */
164
165 int fget(struct thread *td, int fd, struct file **fpp);
166 int fget_read(struct thread *td, int fd, struct file **fpp);
167 int fget_write(struct thread *td, int fd, struct file **fpp);
168 int fdrop(struct file *fp, struct thread *td);
169 int fdrop_locked(struct file *fp, struct thread *td);
170
171 /*
172 * The socket operations are used a couple of places.
173 * XXX: This is wrong, they should go through the operations vector for
174 * XXX: sockets instead of going directly for the individual functions. /phk
175 */
176 fo_rdwr_t soo_read;
177 fo_rdwr_t soo_write;
178 fo_ioctl_t soo_ioctl;
179 fo_poll_t soo_poll;
180 fo_kqfilter_t soo_kqfilter;
181 fo_stat_t soo_stat;
182 fo_close_t soo_close;
183
184 /* Lock a file. */
185 #define FILE_LOCK(f) mtx_lock((f)->f_mtxp)
186 #define FILE_UNLOCK(f) mtx_unlock((f)->f_mtxp)
187 #define FILE_LOCKED(f) mtx_owned((f)->f_mtxp)
188 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
189
190 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
191 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
192 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
193
194 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
195 void fputsock(struct socket *sp);
196
197 #define fhold_locked(fp) \
198 do { \
199 FILE_LOCK_ASSERT(fp, MA_OWNED); \
200 (fp)->f_count++; \
201 } while (0)
202
203 #define fhold(fp) \
204 do { \
205 FILE_LOCK(fp); \
206 fhold_locked(fp); \
207 FILE_UNLOCK(fp); \
208 } while (0)
209
210 static __inline fo_rdwr_t fo_read;
211 static __inline fo_rdwr_t fo_write;
212 static __inline fo_ioctl_t fo_ioctl;
213 static __inline fo_poll_t fo_poll;
214 static __inline fo_kqfilter_t fo_kqfilter;
215 static __inline fo_stat_t fo_stat;
216 static __inline fo_close_t fo_close;
217
218 static __inline int
219 fo_read(fp, uio, active_cred, flags, td)
220 struct file *fp;
221 struct uio *uio;
222 struct ucred *active_cred;
223 int flags;
224 struct thread *td;
225 {
226
227 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
228 }
229
230 static __inline int
231 fo_write(fp, uio, active_cred, flags, td)
232 struct file *fp;
233 struct uio *uio;
234 struct ucred *active_cred;
235 int flags;
236 struct thread *td;
237 {
238
239 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
240 }
241
242 static __inline int
243 fo_ioctl(fp, com, data, active_cred, td)
244 struct file *fp;
245 u_long com;
246 void *data;
247 struct ucred *active_cred;
248 struct thread *td;
249 {
250
251 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
252 }
253
254 static __inline int
255 fo_poll(fp, events, active_cred, td)
256 struct file *fp;
257 int events;
258 struct ucred *active_cred;
259 struct thread *td;
260 {
261
262 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
263 }
264
265 static __inline int
266 fo_stat(fp, sb, active_cred, td)
267 struct file *fp;
268 struct stat *sb;
269 struct ucred *active_cred;
270 struct thread *td;
271 {
272
273 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
274 }
275
276 static __inline int
277 fo_close(fp, td)
278 struct file *fp;
279 struct thread *td;
280 {
281
282 return ((*fp->f_ops->fo_close)(fp, td));
283 }
284
285 static __inline int
286 fo_kqfilter(fp, kn)
287 struct file *fp;
288 struct knote *kn;
289 {
290
291 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
292 }
293
294 #endif /* _KERNEL */
295
296 #endif /* !SYS_FILE_H */
Cache object: 38d192318f89b1865f6370e9ef09e71f
|