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.0/sys/sys/file.h 104480 2002-10-04 20:34:30Z sam $
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 #endif /* _KERNEL */
57
58 #define DTYPE_VNODE 1 /* file */
59 #define DTYPE_SOCKET 2 /* communications endpoint */
60 #define DTYPE_PIPE 3 /* pipe */
61 #define DTYPE_FIFO 4 /* fifo (named pipe) */
62 #define DTYPE_KQUEUE 5 /* event queue */
63 #define DTYPE_CRYPTO 6 /* crypto */
64
65 #ifdef _KERNEL
66
67 /*
68 * Kernel descriptor table.
69 * One entry for each open kernel vnode and socket.
70 *
71 * Below is the list of locks that protects members in struct file.
72 *
73 * (fl) filelist_lock
74 * (f) f_mtx in struct file
75 * none not locked
76 */
77 struct file {
78 LIST_ENTRY(file) f_list;/* (fl) list of active files */
79 short f_gcflag; /* used by thread doing fd garbage collection */
80 short f_type; /* descriptor type */
81 int f_count; /* (f) reference count */
82 int f_msgcount; /* (f) references from message queue */
83 struct ucred *f_cred; /* credentials associated with descriptor */
84 struct fileops {
85 int (*fo_read)(struct file *fp, struct uio *uio,
86 struct ucred *active_cred, int flags,
87 struct thread *td);
88 int (*fo_write)(struct file *fp, struct uio *uio,
89 struct ucred *active_cred, int flags,
90 struct thread *td);
91 #define FOF_OFFSET 1
92 int (*fo_ioctl)(struct file *fp, u_long com, void *data,
93 struct ucred *active_cred, struct thread *td);
94 int (*fo_poll)(struct file *fp, int events,
95 struct ucred *active_cred, struct thread *td);
96 int (*fo_kqfilter)(struct file *fp, struct knote *kn);
97 int (*fo_stat)(struct file *fp, struct stat *sb,
98 struct ucred *active_cred, struct thread *td);
99 int (*fo_close)(struct file *fp, struct thread *td);
100 } *f_ops;
101 int f_seqcount; /*
102 * count of sequential accesses -- cleared
103 * by most seek operations.
104 */
105 off_t f_nextoff; /*
106 * offset of next expected read or write
107 */
108 off_t f_offset;
109 void *f_data; /* vnode or socket */
110 u_int f_flag; /* see fcntl.h */
111 struct mtx *f_mtxp; /* mutex to protect data */
112 };
113
114 #endif /* _KERNEL */
115
116 /*
117 * Userland version of struct file, for sysctl
118 */
119 struct xfile {
120 size_t xf_size; /* size of struct xfile */
121 pid_t xf_pid; /* owning process */
122 uid_t xf_uid; /* effective uid of owning process */
123 int xf_fd; /* descriptor number */
124 void *xf_file; /* address of struct file */
125 short xf_type; /* descriptor type */
126 int xf_count; /* reference count */
127 int xf_msgcount; /* references from message queue */
128 off_t xf_offset; /* file offset */
129 void *xf_data; /* pointer to vnode or socket */
130 u_int xf_flag; /* flags (see fcntl.h) */
131 };
132
133 #ifdef _KERNEL
134
135 #ifdef MALLOC_DECLARE
136 MALLOC_DECLARE(M_FILE);
137 #endif
138
139 LIST_HEAD(filelist, file);
140 extern struct filelist filehead; /* (fl) head of list of open files */
141 extern struct fileops vnops;
142 extern struct fileops badfileops;
143 extern int maxfiles; /* kernel limit on number of open files */
144 extern int maxfilesperproc; /* per process limit on number of open files */
145 extern int nfiles; /* (fl) actual number of open files */
146 extern struct sx filelist_lock; /* sx to protect filelist and nfiles */
147
148 int fget(struct thread *td, int fd, struct file **fpp);
149 int fget_read(struct thread *td, int fd, struct file **fpp);
150 int fget_write(struct thread *td, int fd, struct file **fpp);
151 int fdrop(struct file *fp, struct thread *td);
152 int fdrop_locked(struct file *fp, struct thread *td);
153
154 /* Lock a file. */
155 #define FILE_LOCK(f) mtx_lock((f)->f_mtxp)
156 #define FILE_UNLOCK(f) mtx_unlock((f)->f_mtxp)
157 #define FILE_LOCKED(f) mtx_owned((f)->f_mtxp)
158 #define FILE_LOCK_ASSERT(f, type) mtx_assert((f)->f_mtxp, (type))
159
160 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
161 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
162 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
163
164 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
165 void fputsock(struct socket *sp);
166
167 #define fhold_locked(fp) \
168 do { \
169 FILE_LOCK_ASSERT(fp, MA_OWNED); \
170 (fp)->f_count++; \
171 } while (0)
172
173 #define fhold(fp) \
174 do { \
175 FILE_LOCK(fp); \
176 fhold_locked(fp); \
177 FILE_UNLOCK(fp); \
178 } while (0)
179
180 static __inline int fo_read(struct file *fp, struct uio *uio,
181 struct ucred *active_cred, int flags, struct thread *td);
182 static __inline int fo_write(struct file *fp, struct uio *uio,
183 struct ucred *active_cred, int flags, struct thread *td);
184 static __inline int fo_ioctl(struct file *fp, u_long com, void *data,
185 struct ucred *active_cred, struct thread *td);
186 static __inline int fo_poll(struct file *fp, int events,
187 struct ucred *active_cred, struct thread *td);
188 static __inline int fo_stat(struct file *fp, struct stat *sb,
189 struct ucred *active_cred, struct thread *td);
190 static __inline int fo_close(struct file *fp, struct thread *td);
191 static __inline int fo_kqfilter(struct file *fp, struct knote *kn);
192 struct proc;
193
194 static __inline int
195 fo_read(fp, uio, active_cred, flags, td)
196 struct file *fp;
197 struct uio *uio;
198 struct ucred *active_cred;
199 int flags;
200 struct thread *td;
201 {
202
203 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
204 }
205
206 static __inline int
207 fo_write(fp, uio, active_cred, flags, td)
208 struct file *fp;
209 struct uio *uio;
210 struct ucred *active_cred;
211 struct thread *td;
212 int flags;
213 {
214
215 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
216 }
217
218 static __inline int
219 fo_ioctl(fp, com, data, active_cred, td)
220 struct file *fp;
221 u_long com;
222 void *data;
223 struct ucred *active_cred;
224 struct thread *td;
225 {
226
227 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
228 }
229
230 static __inline int
231 fo_poll(fp, events, active_cred, td)
232 struct file *fp;
233 int events;
234 struct ucred *active_cred;
235 struct thread *td;
236 {
237
238 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
239 }
240
241 static __inline int
242 fo_stat(fp, sb, active_cred, td)
243 struct file *fp;
244 struct stat *sb;
245 struct ucred *active_cred;
246 struct thread *td;
247 {
248
249 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
250 }
251
252 static __inline int
253 fo_close(fp, td)
254 struct file *fp;
255 struct thread *td;
256 {
257
258 return ((*fp->f_ops->fo_close)(fp, td));
259 }
260
261 static __inline int
262 fo_kqfilter(fp, kn)
263 struct file *fp;
264 struct knote *kn;
265 {
266
267 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
268 }
269
270 #endif /* _KERNEL */
271
272 #endif /* !SYS_FILE_H */
Cache object: 2b6fbfbb73357f8373b485af6cf8e9f8
|