1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #ifndef _SYS_FILE_H_ 33 #define _SYS_FILE_H_ 34 35 #ifndef _KERNEL 36 #include <sys/types.h> /* XXX */ 37 #include <sys/fcntl.h> 38 #include <sys/unistd.h> 39 #else 40 #include <sys/queue.h> 41 #include <sys/refcount.h> 42 #include <sys/_lock.h> 43 #include <sys/_mutex.h> 44 #include <vm/vm.h> 45 46 struct filedesc; 47 struct stat; 48 struct thread; 49 struct uio; 50 struct knote; 51 struct vnode; 52 struct nameidata; 53 54 #endif /* _KERNEL */ 55 56 #define DTYPE_NONE 0 /* not yet initialized */ 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 */ 69 #define DTYPE_EVENTFD 13 /* eventfd */ 70 #define DTYPE_TIMERFD 14 /* timerfd */ 71 72 #ifdef _KERNEL 73 74 struct file; 75 struct filecaps; 76 struct kaiocb; 77 struct kinfo_file; 78 struct ucred; 79 80 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */ 81 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */ 82 #define FOF_NEXTOFF_R 0x04 /* Also update f_nextoff[UIO_READ] */ 83 #define FOF_NEXTOFF_W 0x08 /* Also update f_nextoff[UIO_WRITE] */ 84 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */ 85 off_t foffset_lock(struct file *fp, int flags); 86 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags); 87 void foffset_unlock(struct file *fp, off_t val, int flags); 88 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags); 89 90 static inline off_t 91 foffset_get(struct file *fp) 92 { 93 94 return (foffset_lock(fp, FOF_NOLOCK)); 95 } 96 97 typedef int fo_rdwr_t(struct file *fp, struct uio *uio, 98 struct ucred *active_cred, int flags, 99 struct thread *td); 100 typedef int fo_truncate_t(struct file *fp, off_t length, 101 struct ucred *active_cred, struct thread *td); 102 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data, 103 struct ucred *active_cred, struct thread *td); 104 typedef int fo_poll_t(struct file *fp, int events, 105 struct ucred *active_cred, struct thread *td); 106 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn); 107 typedef int fo_stat_t(struct file *fp, struct stat *sb, 108 struct ucred *active_cred); 109 typedef int fo_close_t(struct file *fp, struct thread *td); 110 typedef int fo_chmod_t(struct file *fp, mode_t mode, 111 struct ucred *active_cred, struct thread *td); 112 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid, 113 struct ucred *active_cred, struct thread *td); 114 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio, 115 struct uio *trl_uio, off_t offset, size_t nbytes, 116 off_t *sent, int flags, struct thread *td); 117 typedef int fo_seek_t(struct file *fp, off_t offset, int whence, 118 struct thread *td); 119 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif, 120 struct filedesc *fdp); 121 typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr, 122 vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot, 123 int flags, vm_ooffset_t foff, struct thread *td); 124 typedef int fo_aio_queue_t(struct file *fp, struct kaiocb *job); 125 typedef int fo_add_seals_t(struct file *fp, int flags); 126 typedef int fo_get_seals_t(struct file *fp, int *flags); 127 typedef int fo_fallocate_t(struct file *fp, off_t offset, off_t len, 128 struct thread *td); 129 typedef int fo_fspacectl_t(struct file *fp, int cmd, 130 off_t *offset, off_t *length, int flags, 131 struct ucred *active_cred, struct thread *td); 132 typedef int fo_spare_t(struct file *fp); 133 typedef int fo_flags_t; 134 135 struct fileops { 136 fo_rdwr_t *fo_read; 137 fo_rdwr_t *fo_write; 138 fo_truncate_t *fo_truncate; 139 fo_ioctl_t *fo_ioctl; 140 fo_poll_t *fo_poll; 141 fo_kqfilter_t *fo_kqfilter; 142 fo_stat_t *fo_stat; 143 fo_close_t *fo_close; 144 fo_chmod_t *fo_chmod; 145 fo_chown_t *fo_chown; 146 fo_sendfile_t *fo_sendfile; 147 fo_seek_t *fo_seek; 148 fo_fill_kinfo_t *fo_fill_kinfo; 149 fo_mmap_t *fo_mmap; 150 fo_aio_queue_t *fo_aio_queue; 151 fo_add_seals_t *fo_add_seals; 152 fo_get_seals_t *fo_get_seals; 153 fo_fallocate_t *fo_fallocate; 154 fo_fspacectl_t *fo_fspacectl; 155 fo_spare_t *fo_spares[8]; /* Spare slots */ 156 fo_flags_t fo_flags; /* DFLAG_* below */ 157 }; 158 159 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */ 160 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */ 161 #endif /* _KERNEL */ 162 163 #if defined(_KERNEL) || defined(_WANT_FILE) 164 /* 165 * Kernel descriptor table. 166 * One entry for each open kernel vnode and socket. 167 * 168 * Below is the list of locks that protects members in struct file. 169 * 170 * (a) f_vnode lock required (shared allows both reads and writes) 171 * (f) updated with atomics and blocking on sleepq 172 * (d) cdevpriv_mtx 173 * none not locked 174 */ 175 176 #if __BSD_VISIBLE 177 struct fadvise_info { 178 int fa_advice; /* (f) FADV_* type. */ 179 off_t fa_start; /* (f) Region start. */ 180 off_t fa_end; /* (f) Region end. */ 181 }; 182 183 struct file { 184 volatile u_int f_flag; /* see fcntl.h */ 185 volatile u_int f_count; /* reference count */ 186 void *f_data; /* file descriptor specific data */ 187 struct fileops *f_ops; /* File operations */ 188 struct vnode *f_vnode; /* NULL or applicable vnode */ 189 struct ucred *f_cred; /* associated credentials. */ 190 short f_type; /* descriptor type */ 191 short f_vnread_flags; /* (f) Sleep lock for f_offset */ 192 /* 193 * DTYPE_VNODE specific fields. 194 */ 195 union { 196 int16_t f_seqcount[2]; /* (a) Count of seq. reads and writes. */ 197 int f_pipegen; 198 }; 199 off_t f_nextoff[2]; /* next expected read/write offset. */ 200 union { 201 struct cdev_privdata *fvn_cdevpriv; 202 /* (d) Private data for the cdev. */ 203 struct fadvise_info *fvn_advice; 204 } f_vnun; 205 /* 206 * DFLAG_SEEKABLE specific fields 207 */ 208 off_t f_offset; 209 }; 210 211 #define f_cdevpriv f_vnun.fvn_cdevpriv 212 #define f_advice f_vnun.fvn_advice 213 214 #define FOFFSET_LOCKED 0x1 215 #define FOFFSET_LOCK_WAITING 0x2 216 #endif /* __BSD_VISIBLE */ 217 218 #endif /* _KERNEL || _WANT_FILE */ 219 220 /* 221 * Userland version of struct file, for sysctl 222 */ 223 #if __BSD_VISIBLE 224 struct xfile { 225 ksize_t xf_size; /* size of struct xfile */ 226 pid_t xf_pid; /* owning process */ 227 uid_t xf_uid; /* effective uid of owning process */ 228 int xf_fd; /* descriptor number */ 229 int _xf_int_pad1; 230 kvaddr_t xf_file; /* address of struct file */ 231 short xf_type; /* descriptor type */ 232 short _xf_short_pad1; 233 int xf_count; /* reference count */ 234 int xf_msgcount; /* references from message queue */ 235 int _xf_int_pad2; 236 off_t xf_offset; /* file offset */ 237 kvaddr_t xf_data; /* file descriptor specific data */ 238 kvaddr_t xf_vnode; /* vnode pointer */ 239 u_int xf_flag; /* flags (see fcntl.h) */ 240 int _xf_int_pad3; 241 int64_t _xf_int64_pad[6]; 242 }; 243 #endif /* __BSD_VISIBLE */ 244 245 #ifdef _KERNEL 246 247 extern struct fileops vnops; 248 extern struct fileops badfileops; 249 extern struct fileops path_fileops; 250 extern struct fileops socketops; 251 extern int maxfiles; /* kernel limit on number of open files */ 252 extern int maxfilesperproc; /* per process limit on number of open files */ 253 254 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp); 255 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp, 256 vm_prot_t *maxprotp, struct file **fpp); 257 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp, 258 struct file **fpp); 259 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp, 260 struct file **fpp); 261 int fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp, 262 int needfcntl, struct file **fpp); 263 int _fdrop(struct file *fp, struct thread *td); 264 265 fo_rdwr_t invfo_rdwr; 266 fo_truncate_t invfo_truncate; 267 fo_ioctl_t invfo_ioctl; 268 fo_poll_t invfo_poll; 269 fo_kqfilter_t invfo_kqfilter; 270 fo_chmod_t invfo_chmod; 271 fo_chown_t invfo_chown; 272 fo_sendfile_t invfo_sendfile; 273 fo_stat_t vn_statfile; 274 fo_sendfile_t vn_sendfile; 275 fo_seek_t vn_seek; 276 fo_fill_kinfo_t vn_fill_kinfo; 277 fo_kqfilter_t vn_kqfilter_opath; 278 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif); 279 280 void finit(struct file *, u_int, short, void *, struct fileops *); 281 void finit_vnode(struct file *, u_int, void *, struct fileops *); 282 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp, 283 struct vnode **vpp); 284 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp, 285 struct vnode **vpp); 286 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp, 287 struct filecaps *havecaps, struct vnode **vpp); 288 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp, 289 struct vnode **vpp); 290 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp, 291 struct vnode **vpp); 292 int fgetvp_lookup_smr(int fd, struct nameidata *ndp, struct vnode **vpp, bool *fsearch); 293 int fgetvp_lookup(int fd, struct nameidata *ndp, struct vnode **vpp); 294 295 static __inline __result_use_check bool 296 fhold(struct file *fp) 297 { 298 return (refcount_acquire_checked(&fp->f_count)); 299 } 300 301 #define fdrop(fp, td) ({ \ 302 struct file *_fp; \ 303 int _error; \ 304 \ 305 _error = 0; \ 306 _fp = (fp); \ 307 if (__predict_false(refcount_release(&_fp->f_count))) \ 308 _error = _fdrop(_fp, td); \ 309 _error; \ 310 }) 311 312 #define fdrop_close(fp, td) ({ \ 313 struct file *_fp; \ 314 int _error; \ 315 \ 316 _error = 0; \ 317 _fp = (fp); \ 318 if (__predict_true(refcount_release(&_fp->f_count))) \ 319 _error = _fdrop(_fp, td); \ 320 _error; \ 321 }) 322 323 static __inline fo_rdwr_t fo_read; 324 static __inline fo_rdwr_t fo_write; 325 static __inline fo_truncate_t fo_truncate; 326 static __inline fo_ioctl_t fo_ioctl; 327 static __inline fo_poll_t fo_poll; 328 static __inline fo_kqfilter_t fo_kqfilter; 329 static __inline fo_stat_t fo_stat; 330 static __inline fo_close_t fo_close; 331 static __inline fo_chmod_t fo_chmod; 332 static __inline fo_chown_t fo_chown; 333 static __inline fo_sendfile_t fo_sendfile; 334 335 static __inline int 336 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred, 337 int flags, struct thread *td) 338 { 339 340 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td)); 341 } 342 343 static __inline int 344 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred, 345 int flags, struct thread *td) 346 { 347 348 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td)); 349 } 350 351 static __inline int 352 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred, 353 struct thread *td) 354 { 355 356 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td)); 357 } 358 359 static __inline int 360 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred, 361 struct thread *td) 362 { 363 364 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td)); 365 } 366 367 static __inline int 368 fo_poll(struct file *fp, int events, struct ucred *active_cred, 369 struct thread *td) 370 { 371 372 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td)); 373 } 374 375 static __inline int 376 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred) 377 { 378 379 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred)); 380 } 381 382 static __inline int 383 fo_close(struct file *fp, struct thread *td) 384 { 385 386 return ((*fp->f_ops->fo_close)(fp, td)); 387 } 388 389 static __inline int 390 fo_kqfilter(struct file *fp, struct knote *kn) 391 { 392 393 return ((*fp->f_ops->fo_kqfilter)(fp, kn)); 394 } 395 396 static __inline int 397 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred, 398 struct thread *td) 399 { 400 401 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td)); 402 } 403 404 static __inline int 405 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred, 406 struct thread *td) 407 { 408 409 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td)); 410 } 411 412 static __inline int 413 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio, 414 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags, 415 struct thread *td) 416 { 417 418 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset, 419 nbytes, sent, flags, td)); 420 } 421 422 static __inline int 423 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td) 424 { 425 426 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td)); 427 } 428 429 static __inline int 430 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp) 431 { 432 433 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp)); 434 } 435 436 static __inline int 437 fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size, 438 vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff, 439 struct thread *td) 440 { 441 442 if (fp->f_ops->fo_mmap == NULL) 443 return (ENODEV); 444 return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot, 445 flags, foff, td)); 446 } 447 448 static __inline int 449 fo_aio_queue(struct file *fp, struct kaiocb *job) 450 { 451 452 return ((*fp->f_ops->fo_aio_queue)(fp, job)); 453 } 454 455 static __inline int 456 fo_add_seals(struct file *fp, int seals) 457 { 458 459 if (fp->f_ops->fo_add_seals == NULL) 460 return (EINVAL); 461 return ((*fp->f_ops->fo_add_seals)(fp, seals)); 462 } 463 464 static __inline int 465 fo_get_seals(struct file *fp, int *seals) 466 { 467 468 if (fp->f_ops->fo_get_seals == NULL) 469 return (EINVAL); 470 return ((*fp->f_ops->fo_get_seals)(fp, seals)); 471 } 472 473 static __inline int 474 fo_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td) 475 { 476 477 if (fp->f_ops->fo_fallocate == NULL) 478 return (ENODEV); 479 return ((*fp->f_ops->fo_fallocate)(fp, offset, len, td)); 480 } 481 482 static __inline int fo_fspacectl(struct file *fp, int cmd, off_t *offset, 483 off_t *length, int flags, struct ucred *active_cred, struct thread *td) 484 { 485 486 if (fp->f_ops->fo_fspacectl == NULL) 487 return (ENODEV); 488 return ((*fp->f_ops->fo_fspacectl)(fp, cmd, offset, length, flags, 489 active_cred, td)); 490 } 491 492 493 #endif /* _KERNEL */ 494 495 #endif /* !SYS_FILE_H */ 496