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 * 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. 16 * 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 27 * SUCH DAMAGE. 28 * 29 * @(#)file.h 8.3 (Berkeley) 1/9/95 30 * $FreeBSD$ 31 */ 32 33 #ifndef _SYS_FILE_H_ 34 #define _SYS_FILE_H_ 35 36 #ifndef _KERNEL 37 #include <sys/types.h> /* XXX */ 38 #include <sys/fcntl.h> 39 #include <sys/unistd.h> 40 #else 41 #include <sys/queue.h> 42 #include <sys/refcount.h> 43 #include <sys/_lock.h> 44 #include <sys/_mutex.h> 45 46 struct stat; 47 struct thread; 48 struct uio; 49 struct knote; 50 struct vnode; 51 struct socket; 52 53 54 #endif /* _KERNEL */ 55 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 */ 68 69 #ifdef _KERNEL 70 71 struct file; 72 struct filecaps; 73 struct ucred; 74 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); 83 84 static inline off_t 85 foffset_get(struct file *fp) 86 { 87 88 return (foffset_lock(fp, FOF_NOLOCK)); 89 } 90 91 typedef int fo_rdwr_t(struct file *fp, struct uio *uio, 92 struct ucred *active_cred, int flags, 93 struct thread *td); 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_flags_t; 109 110 struct fileops { 111 fo_rdwr_t *fo_read; 112 fo_rdwr_t *fo_write; 113 fo_truncate_t *fo_truncate; 114 fo_ioctl_t *fo_ioctl; 115 fo_poll_t *fo_poll; 116 fo_kqfilter_t *fo_kqfilter; 117 fo_stat_t *fo_stat; 118 fo_close_t *fo_close; 119 fo_chmod_t *fo_chmod; 120 fo_chown_t *fo_chown; 121 fo_flags_t fo_flags; /* DFLAG_* below */ 122 }; 123 124 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */ 125 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */ 126 #endif /* _KERNEL */ 127 128 #if defined(_KERNEL) || defined(_WANT_FILE) 129 /* 130 * Kernel descriptor table. 131 * One entry for each open kernel vnode and socket. 132 * 133 * Below is the list of locks that protects members in struct file. 134 * 135 * (f) protected with mtx_lock(mtx_pool_find(fp)) 136 * (d) cdevpriv_mtx 137 * none not locked 138 */ 139 140 struct fadvise_info { 141 int fa_advice; /* (f) FADV_* type. */ 142 off_t fa_start; /* (f) Region start. */ 143 off_t fa_end; /* (f) Region end. */ 144 off_t fa_prevstart; /* (f) Previous NOREUSE start. */ 145 off_t fa_prevend; /* (f) Previous NOREUSE end. */ 146 }; 147 148 struct file { 149 void *f_data; /* file descriptor specific data */ 150 struct fileops *f_ops; /* File operations */ 151 struct ucred *f_cred; /* associated credentials. */ 152 struct vnode *f_vnode; /* NULL or applicable vnode */ 153 short f_type; /* descriptor type */ 154 short f_vnread_flags; /* (f) Sleep lock for f_offset */ 155 volatile u_int f_flag; /* see fcntl.h */ 156 volatile u_int f_count; /* reference count */ 157 /* 158 * DTYPE_VNODE specific fields. 159 */ 160 int f_seqcount; /* Count of sequential accesses. */ 161 off_t f_nextoff; /* next expected read/write offset. */ 162 union { 163 struct cdev_privdata *fvn_cdevpriv; 164 /* (d) Private data for the cdev. */ 165 struct fadvise_info *fvn_advice; 166 } f_vnun; 167 /* 168 * DFLAG_SEEKABLE specific fields 169 */ 170 off_t f_offset; 171 /* 172 * Mandatory Access control information. 173 */ 174 void *f_label; /* Place-holder for MAC label. */ 175 }; 176 177 #define f_cdevpriv f_vnun.fvn_cdevpriv 178 #define f_advice f_vnun.fvn_advice 179 180 #define FOFFSET_LOCKED 0x1 181 #define FOFFSET_LOCK_WAITING 0x2 182 #define FDEVFS_VNODE 0x4 183 184 #endif /* _KERNEL || _WANT_FILE */ 185 186 /* 187 * Userland version of struct file, for sysctl 188 */ 189 struct xfile { 190 size_t xf_size; /* size of struct xfile */ 191 pid_t xf_pid; /* owning process */ 192 uid_t xf_uid; /* effective uid of owning process */ 193 int xf_fd; /* descriptor number */ 194 void *xf_file; /* address of struct file */ 195 short xf_type; /* descriptor type */ 196 int xf_count; /* reference count */ 197 int xf_msgcount; /* references from message queue */ 198 off_t xf_offset; /* file offset */ 199 void *xf_data; /* file descriptor specific data */ 200 void *xf_vnode; /* vnode pointer */ 201 u_int xf_flag; /* flags (see fcntl.h) */ 202 }; 203 204 #ifdef _KERNEL 205 206 extern struct fileops vnops; 207 extern struct fileops badfileops; 208 extern struct fileops socketops; 209 extern int maxfiles; /* kernel limit on number of open files */ 210 extern int maxfilesperproc; /* per process limit on number of open files */ 211 extern volatile int openfiles; /* actual number of open files */ 212 213 int fget(struct thread *td, int fd, cap_rights_t rights, struct file **fpp); 214 int fget_mmap(struct thread *td, int fd, cap_rights_t rights, 215 u_char *maxprotp, struct file **fpp); 216 int fget_read(struct thread *td, int fd, cap_rights_t rights, 217 struct file **fpp); 218 int fget_write(struct thread *td, int fd, cap_rights_t rights, 219 struct file **fpp); 220 int _fdrop(struct file *fp, struct thread *td); 221 222 /* 223 * The socket operations are used a couple of places. 224 * XXX: This is wrong, they should go through the operations vector for 225 * XXX: sockets instead of going directly for the individual functions. /phk 226 */ 227 fo_rdwr_t soo_read; 228 fo_rdwr_t soo_write; 229 fo_truncate_t soo_truncate; 230 fo_ioctl_t soo_ioctl; 231 fo_poll_t soo_poll; 232 fo_kqfilter_t soo_kqfilter; 233 fo_stat_t soo_stat; 234 fo_close_t soo_close; 235 236 fo_chmod_t invfo_chmod; 237 fo_chown_t invfo_chown; 238 239 void finit(struct file *, u_int, short, void *, struct fileops *); 240 int fgetvp(struct thread *td, int fd, cap_rights_t rights, struct vnode **vpp); 241 int fgetvp_exec(struct thread *td, int fd, cap_rights_t rights, 242 struct vnode **vpp); 243 int fgetvp_rights(struct thread *td, int fd, cap_rights_t need, 244 struct filecaps *havecaps, struct vnode **vpp); 245 int fgetvp_read(struct thread *td, int fd, cap_rights_t rights, 246 struct vnode **vpp); 247 int fgetvp_write(struct thread *td, int fd, cap_rights_t rights, 248 struct vnode **vpp); 249 250 int fgetsock(struct thread *td, int fd, cap_rights_t rights, 251 struct socket **spp, u_int *fflagp); 252 void fputsock(struct socket *sp); 253 254 static __inline int 255 _fnoop(void) 256 { 257 258 return (0); 259 } 260 261 #define fhold(fp) \ 262 (refcount_acquire(&(fp)->f_count)) 263 #define fdrop(fp, td) \ 264 (refcount_release(&(fp)->f_count) ? _fdrop((fp), (td)) : _fnoop()) 265 266 static __inline fo_rdwr_t fo_read; 267 static __inline fo_rdwr_t fo_write; 268 static __inline fo_truncate_t fo_truncate; 269 static __inline fo_ioctl_t fo_ioctl; 270 static __inline fo_poll_t fo_poll; 271 static __inline fo_kqfilter_t fo_kqfilter; 272 static __inline fo_stat_t fo_stat; 273 static __inline fo_close_t fo_close; 274 static __inline fo_chmod_t fo_chmod; 275 static __inline fo_chown_t fo_chown; 276 277 static __inline int 278 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred, 279 int flags, struct thread *td) 280 { 281 282 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td)); 283 } 284 285 static __inline int 286 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred, 287 int flags, struct thread *td) 288 { 289 290 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td)); 291 } 292 293 static __inline int 294 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred, 295 struct thread *td) 296 { 297 298 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td)); 299 } 300 301 static __inline int 302 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred, 303 struct thread *td) 304 { 305 306 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td)); 307 } 308 309 static __inline int 310 fo_poll(struct file *fp, int events, struct ucred *active_cred, 311 struct thread *td) 312 { 313 314 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td)); 315 } 316 317 static __inline int 318 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred, 319 struct thread *td) 320 { 321 322 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred, td)); 323 } 324 325 static __inline int 326 fo_close(struct file *fp, struct thread *td) 327 { 328 329 return ((*fp->f_ops->fo_close)(fp, td)); 330 } 331 332 static __inline int 333 fo_kqfilter(struct file *fp, struct knote *kn) 334 { 335 336 return ((*fp->f_ops->fo_kqfilter)(fp, kn)); 337 } 338 339 static __inline int 340 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred, 341 struct thread *td) 342 { 343 344 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td)); 345 } 346 347 static __inline int 348 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred, 349 struct thread *td) 350 { 351 352 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td)); 353 } 354 355 #endif /* _KERNEL */ 356 357 #endif /* !SYS_FILE_H */ 358