2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * @(#)file.h 8.3 (Berkeley) 1/9/95
37 #include <sys/types.h> /* XXX */
38 #include <sys/fcntl.h>
39 #include <sys/unistd.h>
41 #include <sys/queue.h>
42 #include <sys/refcount.h>
43 #include <sys/_lock.h>
44 #include <sys/_mutex.h>
56 #define DTYPE_VNODE 1 /* file */
57 #define DTYPE_SOCKET 2 /* communications endpoint */
58 #define DTYPE_PIPE 3 /* pipe */
59 #define DTYPE_FIFO 4 /* fifo (named pipe) */
60 #define DTYPE_KQUEUE 5 /* event queue */
61 #define DTYPE_CRYPTO 6 /* crypto */
62 #define DTYPE_MQUEUE 7 /* posix message queue */
63 #define DTYPE_SHM 8 /* swap-backed shared memory */
64 #define DTYPE_SEM 9 /* posix semaphore */
65 #define DTYPE_PTS 10 /* pseudo teletype master device */
66 #define DTYPE_DEV 11 /* Device specific fd type */
67 #define DTYPE_PROCDESC 12 /* process descriptor */
75 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */
76 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */
77 #define FOF_NEXTOFF 0x04 /* Also update f_nextoff */
78 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */
79 off_t foffset_lock(struct file *fp, int flags);
80 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
81 void foffset_unlock(struct file *fp, off_t val, int flags);
82 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
85 foffset_get(struct file *fp)
88 return (foffset_lock(fp, FOF_NOLOCK));
91 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
92 struct ucred *active_cred, int flags,
94 typedef int fo_truncate_t(struct file *fp, off_t length,
95 struct ucred *active_cred, struct thread *td);
96 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
97 struct ucred *active_cred, struct thread *td);
98 typedef int fo_poll_t(struct file *fp, int events,
99 struct ucred *active_cred, struct thread *td);
100 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
101 typedef int fo_stat_t(struct file *fp, struct stat *sb,
102 struct ucred *active_cred, struct thread *td);
103 typedef int fo_close_t(struct file *fp, struct thread *td);
104 typedef int fo_chmod_t(struct file *fp, mode_t mode,
105 struct ucred *active_cred, struct thread *td);
106 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
107 struct ucred *active_cred, struct thread *td);
108 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
109 struct uio *trl_uio, off_t offset, size_t nbytes,
110 off_t *sent, int flags, int kflags, struct thread *td);
111 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
113 typedef int fo_flags_t;
118 fo_truncate_t *fo_truncate;
119 fo_ioctl_t *fo_ioctl;
121 fo_kqfilter_t *fo_kqfilter;
123 fo_close_t *fo_close;
124 fo_chmod_t *fo_chmod;
125 fo_chown_t *fo_chown;
126 fo_sendfile_t *fo_sendfile;
128 fo_flags_t fo_flags; /* DFLAG_* below */
131 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
132 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
135 #if defined(_KERNEL) || defined(_WANT_FILE)
137 * Kernel descriptor table.
138 * One entry for each open kernel vnode and socket.
140 * Below is the list of locks that protects members in struct file.
142 * (a) f_vnode lock required (shared allows both reads and writes)
143 * (f) protected with mtx_lock(mtx_pool_find(fp))
148 struct fadvise_info {
149 int fa_advice; /* (f) FADV_* type. */
150 off_t fa_start; /* (f) Region start. */
151 off_t fa_end; /* (f) Region end. */
152 off_t fa_prevstart; /* (f) Previous NOREUSE start. */
153 off_t fa_prevend; /* (f) Previous NOREUSE end. */
157 void *f_data; /* file descriptor specific data */
158 struct fileops *f_ops; /* File operations */
159 struct ucred *f_cred; /* associated credentials. */
160 struct vnode *f_vnode; /* NULL or applicable vnode */
161 short f_type; /* descriptor type */
162 short f_vnread_flags; /* (f) Sleep lock for f_offset */
163 volatile u_int f_flag; /* see fcntl.h */
164 volatile u_int f_count; /* reference count */
166 * DTYPE_VNODE specific fields.
168 int f_seqcount; /* (a) Count of sequential accesses. */
169 off_t f_nextoff; /* next expected read/write offset. */
171 struct cdev_privdata *fvn_cdevpriv;
172 /* (d) Private data for the cdev. */
173 struct fadvise_info *fvn_advice;
176 * DFLAG_SEEKABLE specific fields
180 * Mandatory Access control information.
182 void *f_label; /* Place-holder for MAC label. */
185 #define f_cdevpriv f_vnun.fvn_cdevpriv
186 #define f_advice f_vnun.fvn_advice
188 #define FOFFSET_LOCKED 0x1
189 #define FOFFSET_LOCK_WAITING 0x2
190 #define FDEVFS_VNODE 0x4
192 #endif /* _KERNEL || _WANT_FILE */
195 * Userland version of struct file, for sysctl
198 size_t xf_size; /* size of struct xfile */
199 pid_t xf_pid; /* owning process */
200 uid_t xf_uid; /* effective uid of owning process */
201 int xf_fd; /* descriptor number */
202 void *xf_file; /* address of struct file */
203 short xf_type; /* descriptor type */
204 int xf_count; /* reference count */
205 int xf_msgcount; /* references from message queue */
206 off_t xf_offset; /* file offset */
207 void *xf_data; /* file descriptor specific data */
208 void *xf_vnode; /* vnode pointer */
209 u_int xf_flag; /* flags (see fcntl.h) */
214 extern struct fileops vnops;
215 extern struct fileops badfileops;
216 extern struct fileops socketops;
217 extern int maxfiles; /* kernel limit on number of open files */
218 extern int maxfilesperproc; /* per process limit on number of open files */
219 extern volatile int openfiles; /* actual number of open files */
221 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp);
222 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp,
223 u_char *maxprotp, struct file **fpp);
224 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp,
226 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp,
228 int _fdrop(struct file *fp, struct thread *td);
231 * The socket operations are used a couple of places.
232 * XXX: This is wrong, they should go through the operations vector for
233 * XXX: sockets instead of going directly for the individual functions. /phk
237 fo_truncate_t soo_truncate;
238 fo_ioctl_t soo_ioctl;
240 fo_kqfilter_t soo_kqfilter;
242 fo_close_t soo_close;
244 fo_chmod_t invfo_chmod;
245 fo_chown_t invfo_chown;
246 fo_sendfile_t invfo_sendfile;
248 fo_sendfile_t vn_sendfile;
251 void finit(struct file *, u_int, short, void *, struct fileops *);
252 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp,
254 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp,
256 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
257 struct filecaps *havecaps, struct vnode **vpp);
258 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp,
260 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
263 int fgetsock(struct thread *td, int fd, cap_rights_t *rightsp,
264 struct socket **spp, u_int *fflagp);
265 void fputsock(struct socket *sp);
275 (refcount_acquire(&(fp)->f_count))
276 #define fdrop(fp, td) \
277 (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop())
279 static __inline fo_rdwr_t fo_read;
280 static __inline fo_rdwr_t fo_write;
281 static __inline fo_truncate_t fo_truncate;
282 static __inline fo_ioctl_t fo_ioctl;
283 static __inline fo_poll_t fo_poll;
284 static __inline fo_kqfilter_t fo_kqfilter;
285 static __inline fo_stat_t fo_stat;
286 static __inline fo_close_t fo_close;
287 static __inline fo_chmod_t fo_chmod;
288 static __inline fo_chown_t fo_chown;
289 static __inline fo_sendfile_t fo_sendfile;
292 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
293 int flags, struct thread *td)
296 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
300 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
301 int flags, struct thread *td)
304 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
308 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
312 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
316 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
320 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
324 fo_poll(struct file *fp, int events, struct ucred *active_cred,
328 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
332 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
336 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
340 fo_close(struct file *fp, struct thread *td)
343 return ((*fp->f_ops->fo_close)(fp, td));
347 fo_kqfilter(struct file *fp, struct knote *kn)
350 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
354 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
358 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
362 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
366 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
370 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
371 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
372 int kflags, struct thread *td)
375 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
376 nbytes, sent, flags, kflags, td));
380 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
383 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
388 #endif /* !SYS_FILE_H */