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 */
72 typedef int fo_rdwr_t(struct file *fp, struct uio *uio,
73 struct ucred *active_cred, int flags,
75 #define FOF_OFFSET 1 /* Use the offset in uio argument */
76 typedef int fo_truncate_t(struct file *fp, off_t length,
77 struct ucred *active_cred, struct thread *td);
78 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data,
79 struct ucred *active_cred, struct thread *td);
80 typedef int fo_poll_t(struct file *fp, int events,
81 struct ucred *active_cred, struct thread *td);
82 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn);
83 typedef int fo_stat_t(struct file *fp, struct stat *sb,
84 struct ucred *active_cred, struct thread *td);
85 typedef int fo_close_t(struct file *fp, struct thread *td);
86 typedef int fo_flags_t;
91 fo_truncate_t *fo_truncate;
94 fo_kqfilter_t *fo_kqfilter;
97 fo_flags_t fo_flags; /* DFLAG_* below */
100 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */
101 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */
104 #if defined(_KERNEL) || defined(_WANT_FILE)
106 * Kernel descriptor table.
107 * One entry for each open kernel vnode and socket.
109 * Below is the list of locks that protects members in struct file.
111 * (f) protected with mtx_lock(mtx_pool_find(fp))
116 struct fadvise_info {
117 int fa_advice; /* (f) FADV_* type. */
118 off_t fa_start; /* (f) Region start. */
119 off_t fa_end; /* (f) Region end. */
123 void *f_data; /* file descriptor specific data */
124 struct fileops *f_ops; /* File operations */
125 struct ucred *f_cred; /* associated credentials. */
126 struct vnode *f_vnode; /* NULL or applicable vnode */
127 short f_type; /* descriptor type */
128 short f_vnread_flags; /* (f) Sleep lock for f_offset */
129 volatile u_int f_flag; /* see fcntl.h */
130 volatile u_int f_count; /* reference count */
132 * DTYPE_VNODE specific fields.
134 int f_seqcount; /* Count of sequential accesses. */
135 off_t f_nextoff; /* next expected read/write offset. */
137 struct cdev_privdata *fvn_cdevpriv;
138 /* (d) Private data for the cdev. */
139 struct fadvise_info *fvn_advice;
142 * DFLAG_SEEKABLE specific fields
146 * Mandatory Access control information.
148 void *f_label; /* Place-holder for MAC label. */
151 #define f_cdevpriv f_vnun.fvn_cdevpriv
152 #define f_advice f_vnun.fvn_advice
154 #define FOFFSET_LOCKED 0x1
155 #define FOFFSET_LOCK_WAITING 0x2
157 #endif /* _KERNEL || _WANT_FILE */
160 * Userland version of struct file, for sysctl
163 size_t xf_size; /* size of struct xfile */
164 pid_t xf_pid; /* owning process */
165 uid_t xf_uid; /* effective uid of owning process */
166 int xf_fd; /* descriptor number */
167 void *xf_file; /* address of struct file */
168 short xf_type; /* descriptor type */
169 int xf_count; /* reference count */
170 int xf_msgcount; /* references from message queue */
171 off_t xf_offset; /* file offset */
172 void *xf_data; /* file descriptor specific data */
173 void *xf_vnode; /* vnode pointer */
174 u_int xf_flag; /* flags (see fcntl.h) */
179 #ifdef MALLOC_DECLARE
180 MALLOC_DECLARE(M_FILE);
183 extern struct fileops vnops;
184 extern struct fileops badfileops;
185 extern struct fileops socketops;
186 extern int maxfiles; /* kernel limit on number of open files */
187 extern int maxfilesperproc; /* per process limit on number of open files */
188 extern volatile int openfiles; /* actual number of open files */
190 int fget(struct thread *td, int fd, struct file **fpp);
191 int fget_read(struct thread *td, int fd, struct file **fpp);
192 int fget_write(struct thread *td, int fd, struct file **fpp);
193 int _fdrop(struct file *fp, struct thread *td);
196 * The socket operations are used a couple of places.
197 * XXX: This is wrong, they should go through the operations vector for
198 * XXX: sockets instead of going directly for the individual functions. /phk
202 fo_truncate_t soo_truncate;
203 fo_ioctl_t soo_ioctl;
205 fo_kqfilter_t soo_kqfilter;
207 fo_close_t soo_close;
209 void finit(struct file *, u_int, short, void *, struct fileops *);
210 int fgetvp(struct thread *td, int fd, struct vnode **vpp);
211 int fgetvp_read(struct thread *td, int fd, struct vnode **vpp);
212 int fgetvp_write(struct thread *td, int fd, struct vnode **vpp);
214 int fgetsock(struct thread *td, int fd, struct socket **spp, u_int *fflagp);
215 void fputsock(struct socket *sp);
218 (refcount_acquire(&(fp)->f_count))
219 #define fdrop(fp, td) \
220 (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : 0)
222 static __inline fo_rdwr_t fo_read;
223 static __inline fo_rdwr_t fo_write;
224 static __inline fo_truncate_t fo_truncate;
225 static __inline fo_ioctl_t fo_ioctl;
226 static __inline fo_poll_t fo_poll;
227 static __inline fo_kqfilter_t fo_kqfilter;
228 static __inline fo_stat_t fo_stat;
229 static __inline fo_close_t fo_close;
232 fo_read(fp, uio, active_cred, flags, td)
235 struct ucred *active_cred;
240 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td));
244 fo_write(fp, uio, active_cred, flags, td)
247 struct ucred *active_cred;
252 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td));
256 fo_truncate(fp, length, active_cred, td)
259 struct ucred *active_cred;
263 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td));
267 fo_ioctl(fp, com, data, active_cred, td)
271 struct ucred *active_cred;
275 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td));
279 fo_poll(fp, events, active_cred, td)
282 struct ucred *active_cred;
286 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td));
290 fo_stat(fp, sb, active_cred, td)
293 struct ucred *active_cred;
297 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td));
306 return ((*fp->f_ops->fo_close)(fp, td));
315 return ((*fp->f_ops->fo_kqfilter)(fp, kn));
320 #endif /* !SYS_FILE_H */