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_cmp_t(struct file *fp, struct file *fp1, struct thread *td); 133 typedef int fo_spare_t(struct file *fp); 134 typedef int fo_flags_t; 135 136 struct fileops { 137 fo_rdwr_t *fo_read; 138 fo_rdwr_t *fo_write; 139 fo_truncate_t *fo_truncate; 140 fo_ioctl_t *fo_ioctl; 141 fo_poll_t *fo_poll; 142 fo_kqfilter_t *fo_kqfilter; 143 fo_stat_t *fo_stat; 144 fo_close_t *fo_close; 145 fo_chmod_t *fo_chmod; 146 fo_chown_t *fo_chown; 147 fo_sendfile_t *fo_sendfile; 148 fo_seek_t *fo_seek; 149 fo_fill_kinfo_t *fo_fill_kinfo; 150 fo_mmap_t *fo_mmap; 151 fo_aio_queue_t *fo_aio_queue; 152 fo_add_seals_t *fo_add_seals; 153 fo_get_seals_t *fo_get_seals; 154 fo_fallocate_t *fo_fallocate; 155 fo_fspacectl_t *fo_fspacectl; 156 fo_cmp_t *fo_cmp; 157 fo_spare_t *fo_spares[8]; /* Spare slots */ 158 fo_flags_t fo_flags; /* DFLAG_* below */ 159 }; 160 161 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */ 162 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */ 163 #endif /* _KERNEL */ 164 165 #if defined(_KERNEL) || defined(_WANT_FILE) 166 /* 167 * Kernel descriptor table. 168 * One entry for each open kernel vnode and socket. 169 * 170 * Below is the list of locks that protects members in struct file. 171 * 172 * (a) f_vnode lock required (shared allows both reads and writes) 173 * (f) updated with atomics and blocking on sleepq 174 * (d) cdevpriv_mtx 175 * none not locked 176 */ 177 178 #if __BSD_VISIBLE 179 struct fadvise_info { 180 int fa_advice; /* (f) FADV_* type. */ 181 off_t fa_start; /* (f) Region start. */ 182 off_t fa_end; /* (f) Region end. */ 183 }; 184 185 struct file { 186 volatile u_int f_flag; /* see fcntl.h */ 187 volatile u_int f_count; /* reference count */ 188 void *f_data; /* file descriptor specific data */ 189 struct fileops *f_ops; /* File operations */ 190 struct vnode *f_vnode; /* NULL or applicable vnode */ 191 struct ucred *f_cred; /* associated credentials. */ 192 short f_type; /* descriptor type */ 193 short f_vnread_flags; /* (f) Sleep lock for f_offset */ 194 /* 195 * DTYPE_VNODE specific fields. 196 */ 197 union { 198 int16_t f_seqcount[2]; /* (a) Count of seq. reads and writes. */ 199 int f_pipegen; 200 }; 201 off_t f_nextoff[2]; /* next expected read/write offset. */ 202 union { 203 struct cdev_privdata *fvn_cdevpriv; 204 /* (d) Private data for the cdev. */ 205 struct fadvise_info *fvn_advice; 206 } f_vnun; 207 /* 208 * DFLAG_SEEKABLE specific fields 209 */ 210 off_t f_offset; 211 }; 212 213 #define f_cdevpriv f_vnun.fvn_cdevpriv 214 #define f_advice f_vnun.fvn_advice 215 216 #define FOFFSET_LOCKED 0x1 217 #define FOFFSET_LOCK_WAITING 0x2 218 #endif /* __BSD_VISIBLE */ 219 220 #endif /* _KERNEL || _WANT_FILE */ 221 222 /* 223 * Userland version of struct file, for sysctl 224 */ 225 #if __BSD_VISIBLE 226 struct xfile { 227 ksize_t xf_size; /* size of struct xfile */ 228 pid_t xf_pid; /* owning process */ 229 uid_t xf_uid; /* effective uid of owning process */ 230 int xf_fd; /* descriptor number */ 231 int _xf_int_pad1; 232 kvaddr_t xf_file; /* address of struct file */ 233 short xf_type; /* descriptor type */ 234 short _xf_short_pad1; 235 int xf_count; /* reference count */ 236 int xf_msgcount; /* references from message queue */ 237 int _xf_int_pad2; 238 off_t xf_offset; /* file offset */ 239 kvaddr_t xf_data; /* file descriptor specific data */ 240 kvaddr_t xf_vnode; /* vnode pointer */ 241 u_int xf_flag; /* flags (see fcntl.h) */ 242 int _xf_int_pad3; 243 int64_t _xf_int64_pad[6]; 244 }; 245 #endif /* __BSD_VISIBLE */ 246 247 #ifdef _KERNEL 248 249 extern struct fileops vnops; 250 extern struct fileops badfileops; 251 extern struct fileops path_fileops; 252 extern struct fileops socketops; 253 extern int maxfiles; /* kernel limit on number of open files */ 254 extern int maxfilesperproc; /* per process limit on number of open files */ 255 256 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp); 257 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp, 258 vm_prot_t *maxprotp, struct file **fpp); 259 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp, 260 struct file **fpp); 261 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp, 262 struct file **fpp); 263 int fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp, 264 int needfcntl, struct file **fpp); 265 int _fdrop(struct file *fp, struct thread *td); 266 int fget_remote(struct thread *td, struct proc *p, int fd, struct file **fpp); 267 268 fo_rdwr_t invfo_rdwr; 269 fo_truncate_t invfo_truncate; 270 fo_ioctl_t invfo_ioctl; 271 fo_poll_t invfo_poll; 272 fo_kqfilter_t invfo_kqfilter; 273 fo_chmod_t invfo_chmod; 274 fo_chown_t invfo_chown; 275 fo_sendfile_t invfo_sendfile; 276 fo_stat_t vn_statfile; 277 fo_sendfile_t vn_sendfile; 278 fo_seek_t vn_seek; 279 fo_fill_kinfo_t vn_fill_kinfo; 280 fo_kqfilter_t vn_kqfilter_opath; 281 int vn_fill_kinfo_vnode(struct vnode *vp, struct kinfo_file *kif); 282 283 void finit(struct file *, u_int, short, void *, struct fileops *); 284 void finit_vnode(struct file *, u_int, void *, struct fileops *); 285 int fgetvp(struct thread *td, int fd, cap_rights_t *rightsp, 286 struct vnode **vpp); 287 int fgetvp_exec(struct thread *td, int fd, cap_rights_t *rightsp, 288 struct vnode **vpp); 289 int fgetvp_rights(struct thread *td, int fd, cap_rights_t *needrightsp, 290 struct filecaps *havecaps, struct vnode **vpp); 291 int fgetvp_read(struct thread *td, int fd, cap_rights_t *rightsp, 292 struct vnode **vpp); 293 int fgetvp_write(struct thread *td, int fd, cap_rights_t *rightsp, 294 struct vnode **vpp); 295 int fgetvp_lookup_smr(struct nameidata *ndp, struct vnode **vpp, bool *fsearch); 296 int fgetvp_lookup(struct nameidata *ndp, struct vnode **vpp); 297 298 static __inline __result_use_check bool 299 fhold(struct file *fp) 300 { 301 return (refcount_acquire_checked(&fp->f_count)); 302 } 303 304 #define fdrop(fp, td) ({ \ 305 struct file *_fp; \ 306 int _error; \ 307 \ 308 _error = 0; \ 309 _fp = (fp); \ 310 if (__predict_false(refcount_release(&_fp->f_count))) \ 311 _error = _fdrop(_fp, td); \ 312 _error; \ 313 }) 314 315 #define fdrop_close(fp, td) ({ \ 316 struct file *_fp; \ 317 int _error; \ 318 \ 319 _error = 0; \ 320 _fp = (fp); \ 321 if (__predict_true(refcount_release(&_fp->f_count))) \ 322 _error = _fdrop(_fp, td); \ 323 _error; \ 324 }) 325 326 static __inline fo_rdwr_t fo_read; 327 static __inline fo_rdwr_t fo_write; 328 static __inline fo_truncate_t fo_truncate; 329 static __inline fo_ioctl_t fo_ioctl; 330 static __inline fo_poll_t fo_poll; 331 static __inline fo_kqfilter_t fo_kqfilter; 332 static __inline fo_stat_t fo_stat; 333 static __inline fo_close_t fo_close; 334 static __inline fo_chmod_t fo_chmod; 335 static __inline fo_chown_t fo_chown; 336 static __inline fo_sendfile_t fo_sendfile; 337 338 static __inline int 339 fo_read(struct file *fp, struct uio *uio, struct ucred *active_cred, 340 int flags, struct thread *td) 341 { 342 343 return ((*fp->f_ops->fo_read)(fp, uio, active_cred, flags, td)); 344 } 345 346 static __inline int 347 fo_write(struct file *fp, struct uio *uio, struct ucred *active_cred, 348 int flags, struct thread *td) 349 { 350 351 return ((*fp->f_ops->fo_write)(fp, uio, active_cred, flags, td)); 352 } 353 354 static __inline int 355 fo_truncate(struct file *fp, off_t length, struct ucred *active_cred, 356 struct thread *td) 357 { 358 359 return ((*fp->f_ops->fo_truncate)(fp, length, active_cred, td)); 360 } 361 362 static __inline int 363 fo_ioctl(struct file *fp, u_long com, void *data, struct ucred *active_cred, 364 struct thread *td) 365 { 366 367 return ((*fp->f_ops->fo_ioctl)(fp, com, data, active_cred, td)); 368 } 369 370 static __inline int 371 fo_poll(struct file *fp, int events, struct ucred *active_cred, 372 struct thread *td) 373 { 374 375 return ((*fp->f_ops->fo_poll)(fp, events, active_cred, td)); 376 } 377 378 static __inline int 379 fo_stat(struct file *fp, struct stat *sb, struct ucred *active_cred) 380 { 381 382 return ((*fp->f_ops->fo_stat)(fp, sb, active_cred)); 383 } 384 385 static __inline int 386 fo_close(struct file *fp, struct thread *td) 387 { 388 389 return ((*fp->f_ops->fo_close)(fp, td)); 390 } 391 392 static __inline int 393 fo_kqfilter(struct file *fp, struct knote *kn) 394 { 395 396 return ((*fp->f_ops->fo_kqfilter)(fp, kn)); 397 } 398 399 static __inline int 400 fo_chmod(struct file *fp, mode_t mode, struct ucred *active_cred, 401 struct thread *td) 402 { 403 404 return ((*fp->f_ops->fo_chmod)(fp, mode, active_cred, td)); 405 } 406 407 static __inline int 408 fo_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred, 409 struct thread *td) 410 { 411 412 return ((*fp->f_ops->fo_chown)(fp, uid, gid, active_cred, td)); 413 } 414 415 static __inline int 416 fo_sendfile(struct file *fp, int sockfd, struct uio *hdr_uio, 417 struct uio *trl_uio, off_t offset, size_t nbytes, off_t *sent, int flags, 418 struct thread *td) 419 { 420 421 return ((*fp->f_ops->fo_sendfile)(fp, sockfd, hdr_uio, trl_uio, offset, 422 nbytes, sent, flags, td)); 423 } 424 425 static __inline int 426 fo_seek(struct file *fp, off_t offset, int whence, struct thread *td) 427 { 428 429 return ((*fp->f_ops->fo_seek)(fp, offset, whence, td)); 430 } 431 432 static __inline int 433 fo_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp) 434 { 435 436 return ((*fp->f_ops->fo_fill_kinfo)(fp, kif, fdp)); 437 } 438 439 static __inline int 440 fo_mmap(struct file *fp, vm_map_t map, vm_offset_t *addr, vm_size_t size, 441 vm_prot_t prot, vm_prot_t cap_maxprot, int flags, vm_ooffset_t foff, 442 struct thread *td) 443 { 444 445 if (fp->f_ops->fo_mmap == NULL) 446 return (ENODEV); 447 return ((*fp->f_ops->fo_mmap)(fp, map, addr, size, prot, cap_maxprot, 448 flags, foff, td)); 449 } 450 451 static __inline int 452 fo_aio_queue(struct file *fp, struct kaiocb *job) 453 { 454 455 return ((*fp->f_ops->fo_aio_queue)(fp, job)); 456 } 457 458 static __inline int 459 fo_add_seals(struct file *fp, int seals) 460 { 461 462 if (fp->f_ops->fo_add_seals == NULL) 463 return (EINVAL); 464 return ((*fp->f_ops->fo_add_seals)(fp, seals)); 465 } 466 467 static __inline int 468 fo_get_seals(struct file *fp, int *seals) 469 { 470 471 if (fp->f_ops->fo_get_seals == NULL) 472 return (EINVAL); 473 return ((*fp->f_ops->fo_get_seals)(fp, seals)); 474 } 475 476 static __inline int 477 fo_fallocate(struct file *fp, off_t offset, off_t len, struct thread *td) 478 { 479 480 if (fp->f_ops->fo_fallocate == NULL) 481 return (ENODEV); 482 return ((*fp->f_ops->fo_fallocate)(fp, offset, len, td)); 483 } 484 485 static __inline int 486 fo_fspacectl(struct file *fp, int cmd, off_t *offset, off_t *length, 487 int flags, struct ucred *active_cred, struct thread *td) 488 { 489 490 if (fp->f_ops->fo_fspacectl == NULL) 491 return (ENODEV); 492 return ((*fp->f_ops->fo_fspacectl)(fp, cmd, offset, length, flags, 493 active_cred, td)); 494 } 495 496 static __inline int 497 fo_cmp(struct file *fp1, struct file *fp2, struct thread *td) 498 { 499 500 if (fp1->f_ops->fo_cmp == NULL) 501 return (ENODEV); 502 return ((*fp1->f_ops->fo_cmp)(fp1, fp2, td)); 503 } 504 505 #endif /* _KERNEL */ 506 507 #endif /* !SYS_FILE_H */ 508