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