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>
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 #define DTYPE_MQUEUE 7 /* posix message queue */
65 #define DTYPE_SHM 8 /* swap-backed shared memory */
66 #define DTYPE_SEM 9 /* posix semaphore */
67 #define DTYPE_PTS 10 /* pseudo teletype master device */
68 #define DTYPE_DEV 11 /* Device specific fd type */
69 #define DTYPE_PROCDESC 12 /* process descriptor */
70 #define DTYPE_LINUXEFD 13 /* emulation eventfd type */
79 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */
80 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */
81 #define FOF_NEXTOFF 0x04 /* Also update f_nextoff */
82 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */
83 off_t foffset_lock(struct file *fp, int flags);
84 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags);
85 void foffset_unlock(struct file *fp, off_t val, int flags);
86 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags);
89 foffset_get(struct file *fp)
92 return (foffset_lock(fp, FOF_NOLOCK));
95 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
96 struct ucred *active_cred, int flags,
98 typedef int fo_truncate_t(struct file *fp, off_t length,
99 struct ucred *active_cred, struct thread *td);
100 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
101 struct ucred *active_cred, struct thread *td);
102 typedef int fo_poll_t(struct file *fp, int events,
103 struct ucred *active_cred, struct thread *td);
104 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
105 typedef int fo_stat_t(struct file *fp, struct stat *sb,
106 struct ucred *active_cred, struct thread *td);
107 typedef int fo_close_t(struct file *fp, struct thread *td);
108 typedef int fo_chmod_t(struct file *fp, mode_t mode,
109 struct ucred *active_cred, struct thread *td);
110 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid,
111 struct ucred *active_cred, struct thread *td);
112 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio,
113 struct uio *trl_uio, off_t offset, size_t nbytes,
114 off_t *sent, int flags, int kflags, struct thread *td);
115 typedef int fo_seek_t(struct file *fp, off_t offset, int whence,
117 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif,
118 struct filedesc *fdp);
119 typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr,
120 vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot,
121 int flags, vm_ooffset_t foff, struct thread *td);
122 typedef int fo_flags_t;
127 fo_truncate_t *fo_truncate;
128 fo_ioctl_t *fo_ioctl;
130 fo_kqfilter_t *fo_kqfilter;
132 fo_close_t *fo_close;
133 fo_chmod_t *fo_chmod;
134 fo_chown_t *fo_chown;
135 fo_sendfile_t *fo_sendfile;
137 fo_fill_kinfo_t *fo_fill_kinfo;
139 fo_flags_t fo_flags; /* DFLAG_* below */
142 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
143 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
146 #if defined(_KERNEL) || defined(_WANT_FILE)
148 * Kernel descriptor table.
149 * One entry for each open kernel vnode and socket.
151 * Below is the list of locks that protects members in struct file.
153 * (a) f_vnode lock required (shared allows both reads and writes)
154 * (f) protected with mtx_lock(mtx_pool_find(fp))
159 struct fadvise_info {
160 int fa_advice; /* (f) FADV_* type. */
161 off_t fa_start; /* (f) Region start. */
162 off_t fa_end; /* (f) Region end. */
163 off_t fa_prevstart; /* (f) Previous NOREUSE start. */
164 off_t fa_prevend; /* (f) Previous NOREUSE end. */
168 void *f_data; /* file descriptor specific data */
169 struct fileops *f_ops; /* File operations */
170 struct ucred *f_cred; /* associated credentials. */
171 struct vnode *f_vnode; /* NULL or applicable vnode */
172 short f_type; /* descriptor type */
173 short f_vnread_flags; /* (f) Sleep lock for f_offset */
174 volatile u_int f_flag; /* see fcntl.h */
175 volatile u_int f_count; /* reference count */
177 * DTYPE_VNODE specific fields.
179 int f_seqcount; /* (a) Count of sequential accesses. */
180 off_t f_nextoff; /* next expected read/write offset. */
182 struct cdev_privdata *fvn_cdevpriv;
183 /* (d) Private data for the cdev. */
184 struct fadvise_info *fvn_advice;
187 * DFLAG_SEEKABLE specific fields
191 * Mandatory Access control information.
193 void *f_label; /* Place-holder for MAC label. */
196 #define f_cdevpriv f_vnun.fvn_cdevpriv
197 #define f_advice f_vnun.fvn_advice
199 #define FOFFSET_LOCKED 0x1
200 #define FOFFSET_LOCK_WAITING 0x2
201 #define FDEVFS_VNODE 0x4
203 #endif /* _KERNEL || _WANT_FILE */
206 * Userland version of struct file, for sysctl
209 size_t xf_size; /* size of struct xfile */
210 pid_t xf_pid; /* owning process */
211 uid_t xf_uid; /* effective uid of owning process */
212 int xf_fd; /* descriptor number */
213 void *xf_file; /* address of struct file */
214 short xf_type; /* descriptor type */
215 int xf_count; /* reference count */
216 int xf_msgcount; /* references from message queue */
217 off_t xf_offset; /* file offset */
218 void *xf_data; /* file descriptor specific data */
219 void *xf_vnode; /* vnode pointer */
220 u_int xf_flag; /* flags (see fcntl.h) */
225 extern struct fileops vnops;
226 extern struct fileops badfileops;
227 extern struct fileops socketops;
228 extern int maxfiles; /* kernel limit on number of open files */
229 extern int maxfilesperproc; /* per process limit on number of open files */
230 extern volatile int openfiles; /* actual number of open files */
232 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp);
233 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp,
234 u_char *maxprotp, struct file **fpp);
235 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp,
237 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp,
239 int fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp,
240 int needfcntl, struct file **fpp);
241 int _fdrop(struct file *fp, struct thread *td);
243 fo_rdwr_t invfo_rdwr;
244 fo_truncate_t invfo_truncate;
245 fo_ioctl_t invfo_ioctl;
246 fo_poll_t invfo_poll;
247 fo_kqfilter_t invfo_kqfilter;
248 fo_chmod_t invfo_chmod;
249 fo_chown_t invfo_chown;
250 fo_sendfile_t invfo_sendfile;
252 fo_sendfile_t vn_sendfile;
254 fo_fill_kinfo_t vn_fill_kinfo;
255 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif);
257 void finit(struct file *, u_int, short, void *, struct fileops *);
258 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp,
260 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp,
262 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp,
263 struct filecaps *havecaps, struct vnode **vpp);
264 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp,
266 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp,
269 int fgetsock(struct thread *td, int fd, cap_rights_t *rightsp,
270 struct socket **spp, u_int *fflagp);
271 void fputsock(struct socket *sp);
281 (refcount_acquire(&(fp)->f_count))
282 #define fdrop(fp, td) \
283 (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop())
285 static __inline fo_rdwr_t fo_read;
286 static __inline fo_rdwr_t fo_write;
287 static __inline fo_truncate_t fo_truncate;
288 static __inline fo_ioctl_t fo_ioctl;
289 static __inline fo_poll_t fo_poll;
290 static __inline fo_kqfilter_t fo_kqfilter;
291 static __inline fo_stat_t fo_stat;
292 static __inline fo_close_t fo_close;
293 static __inline fo_chmod_t fo_chmod;
294 static __inline fo_chown_t fo_chown;
295 static __inline fo_sendfile_t fo_sendfile;
298 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
299 int flags, struct thread *td)
302 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
306 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
307 int flags, struct thread *td)
310 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
314 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred,
318 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
322 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred,
326 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
330 fo_poll(struct file *fp, int events, struct ucred *active_cred,
334 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
338 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred,
342 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
346 fo_close(struct file *fp, struct thread *td)
349 return ((*fp->f_ops->fo_close)(fp, td));
353 fo_kqfilter(struct file *fp, struct knote *kn)
356 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
360 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred,
364 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td));
368 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
372 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td));
376 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio,
377 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags,
378 int kflags, struct thread *td)
381 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset,
382 nbytes, sent, flags, kflags, td));
386 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td)
389 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td));
393 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
396 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp));
400 fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size,
401 vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff,
405 if (fp->f_ops->fo_mmap == NULL)
407 return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot,
413 #endif /* !SYS_FILE_H */