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>
57 #define DTYPE_VNODE 1 /* file */
58 #define DTYPE_SOCKET 2 /* communications endpoint */
59 #define DTYPE_PIPE 3 /* pipe */
60 #define DTYPE_FIFO 4 /* fifo (named pipe) */
61 #define DTYPE_KQUEUE 5 /* event queue */
62 #define DTYPE_CRYPTO 6 /* crypto */
63 #define DTYPE_MQUEUE 7 /* posix message queue */
64 #define DTYPE_SHM 8 /* swap-backed shared memory */
65 #define DTYPE_SEM 9 /* posix semaphore */
66 #define DTYPE_PTS 10 /* pseudo teletype master device */
67 #define DTYPE_DEV 11 /* Device specific fd type */
68 #define DTYPE_PROCDESC 12 /* process descriptor */
77 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */
78 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */
79 #define FOF_NEXTOFF 0x04 /* Also update f_nextoff */
80 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */
81 off_t foffset_lock(struct file *fp, int flags);
82 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
83 void foffset_unlock(struct file *fp, off_t val, int flags);
84 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
87 foffset_get(struct file *fp)
90 return (foffset_lock(fp, FOF_NOLOCK));
93 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
94 struct ucred *active_cred, int flags,
96 typedef int fo_truncate_t(struct file *fp, off_t length,
97 struct ucred *active_cred, struct thread *td);
98 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
99 struct ucred *active_cred, struct thread *td);
100 typedef int fo_poll_t(struct file *fp, int events,
101 struct ucred *active_cred, struct thread *td);
102 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
103 typedef int fo_stat_t(struct file *fp, struct stat *sb,
104 struct ucred *active_cred, struct thread *td);
105 typedef int fo_close_t(struct file *fp, struct thread *td);
106 typedef int fo_chmod_t(struct file *fp, mode_t mode,
107 struct ucred *active_cred, struct thread *td);
108 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
109 struct ucred *active_cred, struct thread *td);
110 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
111 struct uio *trl_uio, off_t offset, size_t nbytes,
112 off_t *sent, int flags, int kflags, struct thread *td);
113 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
115 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
116 struct filedesc *fdp);
117 typedef int fo_flags_t;
122 fo_truncate_t *fo_truncate;
123 fo_ioctl_t *fo_ioctl;
125 fo_kqfilter_t *fo_kqfilter;
127 fo_close_t *fo_close;
128 fo_chmod_t *fo_chmod;
129 fo_chown_t *fo_chown;
130 fo_sendfile_t *fo_sendfile;
132 fo_fill_kinfo_t *fo_fill_kinfo;
133 fo_flags_t fo_flags; /* DFLAG_* below */
136 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
137 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
140 #if defined(_KERNEL) || defined(_WANT_FILE)
142 * Kernel descriptor table.
143 * One entry for each open kernel vnode and socket.
145 * Below is the list of locks that protects members in struct file.
147 * (a) f_vnode lock required (shared allows both reads and writes)
148 * (f) protected with mtx_lock(mtx_pool_find(fp))
153 struct fadvise_info {
154 int fa_advice; /* (f) FADV_* type. */
155 off_t fa_start; /* (f) Region start. */
156 off_t fa_end; /* (f) Region end. */
157 off_t fa_prevstart; /* (f) Previous NOREUSE start. */
158 off_t fa_prevend; /* (f) Previous NOREUSE end. */
162 void *f_data; /* file descriptor specific data */
163 struct fileops *f_ops; /* File operations */
164 struct ucred *f_cred; /* associated credentials. */
165 struct vnode *f_vnode; /* NULL or applicable vnode */
166 short f_type; /* descriptor type */
167 short f_vnread_flags; /* (f) Sleep lock for f_offset */
168 volatile u_int f_flag; /* see fcntl.h */
169 volatile u_int f_count; /* reference count */
171 * DTYPE_VNODE specific fields.
173 int f_seqcount; /* (a) Count of sequential accesses. */
174 off_t f_nextoff; /* next expected read/write offset. */
176 struct cdev_privdata *fvn_cdevpriv;
177 /* (d) Private data for the cdev. */
178 struct fadvise_info *fvn_advice;
181 * DFLAG_SEEKABLE specific fields
185 * Mandatory Access control information.
187 void *f_label; /* Place-holder for MAC label. */
190 #define f_cdevpriv f_vnun.fvn_cdevpriv
191 #define f_advice f_vnun.fvn_advice
193 #define FOFFSET_LOCKED 0x1
194 #define FOFFSET_LOCK_WAITING 0x2
195 #define FDEVFS_VNODE 0x4
197 #endif /* _KERNEL || _WANT_FILE */
200 * Userland version of struct file, for sysctl
203 size_t xf_size; /* size of struct xfile */
204 pid_t xf_pid; /* owning process */
205 uid_t xf_uid; /* effective uid of owning process */
206 int xf_fd; /* descriptor number */
207 void *xf_file; /* address of struct file */
208 short xf_type; /* descriptor type */
209 int xf_count; /* reference count */
210 int xf_msgcount; /* references from message queue */
211 off_t xf_offset; /* file offset */
212 void *xf_data; /* file descriptor specific data */
213 void *xf_vnode; /* vnode pointer */
214 u_int xf_flag; /* flags (see fcntl.h) */
219 extern struct fileops vnops;
220 extern struct fileops badfileops;
221 extern struct fileops socketops;
222 extern int maxfiles; /* kernel limit on number of open files */
223 extern int maxfilesperproc; /* per process limit on number of open files */
224 extern volatile int openfiles; /* actual number of open files */
226 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp);
227 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp,
228 u_char *maxprotp, struct file **fpp);
229 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp,
231 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp,
233 int _fdrop(struct file *fp, struct thread *td);
235 fo_rdwr_t invfo_rdwr;
236 fo_truncate_t invfo_truncate;
237 fo_ioctl_t invfo_ioctl;
238 fo_poll_t invfo_poll;
239 fo_kqfilter_t invfo_kqfilter;
240 fo_chmod_t invfo_chmod;
241 fo_chown_t invfo_chown;
242 fo_sendfile_t invfo_sendfile;
244 fo_sendfile_t vn_sendfile;
246 fo_fill_kinfo_t vn_fill_kinfo;
247 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
249 void finit(struct file *, u_int, short, void *, struct fileops *);
250 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp,
252 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp,
254 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
255 struct filecaps *havecaps, struct vnode **vpp);
256 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp,
258 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
261 int fgetsock(struct thread *td, int fd, cap_rights_t *rightsp,
262 struct socket **spp, u_int *fflagp);
263 void fputsock(struct socket *sp);
273 (refcount_acquire(&(fp)->f_count))
274 #define fdrop(fp, td) \
275 (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop())
277 static __inline fo_rdwr_t fo_read;
278 static __inline fo_rdwr_t fo_write;
279 static __inline fo_truncate_t fo_truncate;
280 static __inline fo_ioctl_t fo_ioctl;
281 static __inline fo_poll_t fo_poll;
282 static __inline fo_kqfilter_t fo_kqfilter;
283 static __inline fo_stat_t fo_stat;
284 static __inline fo_close_t fo_close;
285 static __inline fo_chmod_t fo_chmod;
286 static __inline fo_chown_t fo_chown;
287 static __inline fo_sendfile_t fo_sendfile;
290 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
291 int flags, struct thread *td)
294 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
298 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
299 int flags, struct thread *td)
302 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
306 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
310 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
314 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
318 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
322 fo_poll(struct file *fp, int events, struct ucred *active_cred,
326 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
330 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
334 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
338 fo_close(struct file *fp, struct thread *td)
341 return ((*fp->f_ops->fo_close)(fp, td));
345 fo_kqfilter(struct file *fp, struct knote *kn)
348 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
352 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
356 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
360 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
364 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
368 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
369 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
370 int kflags, struct thread *td)
373 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
374 nbytes, sent, flags, kflags, td));
378 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
381 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
385 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
388 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
393 #endif /* !SYS_FILE_H */