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 * @(#)file.h 8.3 (Berkeley) 1/9/95 32 * $FreeBSD$ 33 */ 34 35 #ifndef _SYS_FILE_H_ 36 #define _SYS_FILE_H_ 37 38 #ifndef _KERNEL 39 #include <sys/types.h> /* XXX */ 40 #include <sys/fcntl.h> 41 #include <sys/unistd.h> 42 #else 43 #include <sys/queue.h> 44 #include <sys/refcount.h> 45 #include <sys/_lock.h> 46 #include <sys/_mutex.h> 47 #include <vm/vm.h> 48 49 struct filedesc; 50 struct stat; 51 struct thread; 52 struct uio; 53 struct knote; 54 struct vnode; 55 struct nameidata; 56 57 #endif /* _KERNEL */ 58 59 #define DTYPE_NONE 0 /* not yet initialized */ 60 #define DTYPE_VNODE 1 /* file */ 61 #define DTYPE_SOCKET 2 /* communications endpoint */ 62 #define DTYPE_PIPE 3 /* pipe */ 63 #define DTYPE_FIFO 4 /* fifo (named pipe) */ 64 #define DTYPE_KQUEUE 5 /* event queue */ 65 #define DTYPE_CRYPTO 6 /* crypto */ 66 #define DTYPE_MQUEUE 7 /* posix message queue */ 67 #define DTYPE_SHM 8 /* swap-backed shared memory */ 68 #define DTYPE_SEM 9 /* posix semaphore */ 69 #define DTYPE_PTS 10 /* pseudo teletype master device */ 70 #define DTYPE_DEV 11 /* Device specific fd type */ 71 #define DTYPE_PROCDESC 12 /* process descriptor */ 72 #define DTYPE_EVENTFD 13 /* eventfd */ 73 #define DTYPE_LINUXTFD 14 /* emulation timerfd type */ 74 75 #ifdef _KERNEL 76 77 struct file; 78 struct filecaps; 79 struct kaiocb; 80 struct kinfo_file; 81 struct ucred; 82 83 #define FOF_OFFSET 0x01 /* Use the offset in uio argument */ 84 #define FOF_NOLOCK 0x02 /* Do not take FOFFSET_LOCK */ 85 #define FOF_NEXTOFF_R 0x04 /* Also update f_nextoff[UIO_READ] */ 86 #define FOF_NEXTOFF_W 0x08 /* Also update f_nextoff[UIO_WRITE] */ 87 #define FOF_NOUPDATE 0x10 /* Do not update f_offset */ 88 off_t foffset_lock(struct file *fp, int flags); 89 void foffset_lock_uio(struct file *fp, struct uio *uio, int flags); 90 void foffset_unlock(struct file *fp, off_t val, int flags); 91 void foffset_unlock_uio(struct file *fp, struct uio *uio, int flags); 92 93 static inline off_t 94 foffset_get(struct file *fp) 95 { 96 97 return (foffset_lock(fp, FOF_NOLOCK)); 98 } 99 100 typedef int fo_rdwr_t(struct file *fp, struct uio *uio, 101 struct ucred *active_cred, int flags, 102 struct thread *td); 103 typedef int fo_truncate_t(struct file *fp, off_t length, 104 struct ucred *active_cred, struct thread *td); 105 typedef int fo_ioctl_t(struct file *fp, u_long com, void *data, 106 struct ucred *active_cred, struct thread *td); 107 typedef int fo_poll_t(struct file *fp, int events, 108 struct ucred *active_cred, struct thread *td); 109 typedef int fo_kqfilter_t(struct file *fp, struct knote *kn); 110 typedef int fo_stat_t(struct file *fp, struct stat *sb, 111 struct ucred *active_cred); 112 typedef int fo_close_t(struct file *fp, struct thread *td); 113 typedef int fo_chmod_t(struct file *fp, mode_t mode, 114 struct ucred *active_cred, struct thread *td); 115 typedef int fo_chown_t(struct file *fp, uid_t uid, gid_t gid, 116 struct ucred *active_cred, struct thread *td); 117 typedef int fo_sendfile_t(struct file *fp, int sockfd, struct uio *hdr_uio, 118 struct uio *trl_uio, off_t offset, size_t nbytes, 119 off_t *sent, int flags, struct thread *td); 120 typedef int fo_seek_t(struct file *fp, off_t offset, int whence, 121 struct thread *td); 122 typedef int fo_fill_kinfo_t(struct file *fp, struct kinfo_file *kif, 123 struct filedesc *fdp); 124 typedef int fo_mmap_t(struct file *fp, vm_map_t map, vm_offset_t *addr, 125 vm_size_t size, vm_prot_t prot, vm_prot_t cap_maxprot, 126 int flags, vm_ooffset_t foff, struct thread *td); 127 typedef int fo_aio_queue_t(struct file *fp, struct kaiocb *job); 128 typedef int fo_add_seals_t(struct file *fp, int flags); 129 typedef int fo_get_seals_t(struct file *fp, int *flags); 130 typedef int fo_fallocate_t(struct file *fp, off_t offset, off_t len, 131 struct thread *td); 132 typedef int fo_fspacectl_t(struct file *fp, int cmd, 133 off_t *offset, off_t *length, int flags, 134 struct ucred *active_cred, struct thread *td); 135 typedef int fo_spare_t(struct file *fp); 136 typedef int fo_flags_t; 137 138 struct fileops { 139 fo_rdwr_t *fo_read; 140 fo_rdwr_t *fo_write; 141 fo_truncate_t *fo_truncate; 142 fo_ioctl_t *fo_ioctl; 143 fo_poll_t *fo_poll; 144 fo_kqfilter_t *fo_kqfilter; 145 fo_stat_t *fo_stat; 146 fo_close_t *fo_close; 147 fo_chmod_t *fo_chmod; 148 fo_chown_t *fo_chown; 149 fo_sendfile_t *fo_sendfile; 150 fo_seek_t *fo_seek; 151 fo_fill_kinfo_t *fo_fill_kinfo; 152 fo_mmap_t *fo_mmap; 153 fo_aio_queue_t *fo_aio_queue; 154 fo_add_seals_t *fo_add_seals; 155 fo_get_seals_t *fo_get_seals; 156 fo_fallocate_t *fo_fallocate; 157 fo_fspacectl_t *fo_fspacectl; 158 fo_spare_t *fo_spares[8]; /* Spare slots */ 159 fo_flags_t fo_flags; /* DFLAG_* below */ 160 }; 161 162 #define DFLAG_PASSABLE 0x01 /* may be passed via unix sockets. */ 163 #define DFLAG_SEEKABLE 0x02 /* seekable / nonsequential */ 164 #endif /* _KERNEL */ 165 166 #if defined(_KERNEL) || defined(_WANT_FILE) 167 /* 168 * Kernel descriptor table. 169 * One entry for each open kernel vnode and socket. 170 * 171 * Below is the list of locks that protects members in struct file. 172 * 173 * (a) f_vnode lock required (shared allows both reads and writes) 174 * (f) updated with atomics and blocking on sleepq 175 * (d) cdevpriv_mtx 176 * none not locked 177 */ 178 179 #if __BSD_VISIBLE 180 struct fadvise_info { 181 int fa_advice; /* (f) FADV_* type. */ 182 off_t fa_start; /* (f) Region start. */ 183 off_t fa_end; /* (f) Region end. */ 184 }; 185 186 struct file { 187 volatile u_int f_flag; /* see fcntl.h */ 188 volatile u_int f_count; /* reference count */ 189 void *f_data; /* file descriptor specific data */ 190 struct fileops *f_ops; /* File operations */ 191 struct vnode *f_vnode; /* NULL or applicable vnode */ 192 struct ucred *f_cred; /* associated credentials. */ 193 short f_type; /* descriptor type */ 194 short f_vnread_flags; /* (f) Sleep lock for f_offset */ 195 /* 196 * DTYPE_VNODE specific fields. 197 */ 198 union { 199 int16_t f_seqcount[2]; /* (a) Count of seq. reads and writes. */ 200 int f_pipegen; 201 }; 202 off_t f_nextoff[2]; /* next expected read/write offset. */ 203 union { 204 struct cdev_privdata *fvn_cdevpriv; 205 /* (d) Private data for the cdev. */ 206 struct fadvise_info *fvn_advice; 207 } f_vnun; 208 /* 209 * DFLAG_SEEKABLE specific fields 210 */ 211 off_t f_offset; 212 }; 213 214 #define f_cdevpriv f_vnun.fvn_cdevpriv 215 #define f_advice f_vnun.fvn_advice 216 217 #define FOFFSET_LOCKED 0x1 218 #define FOFFSET_LOCK_WAITING 0x2 219 #endif /* __BSD_VISIBLE */ 220 221 #endif /* _KERNEL || _WANT_FILE */ 222 223 /* 224 * Userland version of struct file, for sysctl 225 */ 226 #if __BSD_VISIBLE 227 struct xfile { 228 ksize_t xf_size; /* size of struct xfile */ 229 pid_t xf_pid; /* owning process */ 230 uid_t xf_uid; /* effective uid of owning process */ 231 int xf_fd; /* descriptor number */ 232 int _xf_int_pad1; 233 kvaddr_t xf_file; /* address of struct file */ 234 short xf_type; /* descriptor type */ 235 short _xf_short_pad1; 236 int xf_count; /* reference count */ 237 int xf_msgcount; /* references from message queue */ 238 int _xf_int_pad2; 239 off_t xf_offset; /* file offset */ 240 kvaddr_t xf_data; /* file descriptor specific data */ 241 kvaddr_t xf_vnode; /* vnode pointer */ 242 u_int xf_flag; /* flags (see fcntl.h) */ 243 int _xf_int_pad3; 244 int64_t _xf_int64_pad[6]; 245 }; 246 #endif /* __BSD_VISIBLE */ 247 248 #ifdef _KERNEL 249 250 extern struct fileops vnops; 251 extern struct fileops badfileops; 252 extern struct fileops path_fileops; 253 extern struct fileops socketops; 254 extern int maxfiles; /* kernel limit on number of open files */ 255 extern int maxfilesperproc; /* per process limit on number of open files */ 256 257 int fget(struct thread *td, int fd, cap_rights_t *rightsp, struct file **fpp); 258 int fget_mmap(struct thread *td, int fd, cap_rights_t *rightsp, 259 vm_prot_t *maxprotp, struct file **fpp); 260 int fget_read(struct thread *td, int fd, cap_rights_t *rightsp, 261 struct file **fpp); 262 int fget_write(struct thread *td, int fd, cap_rights_t *rightsp, 263 struct file **fpp); 264 int fget_fcntl(struct thread *td, int fd, cap_rights_t *rightsp, 265 int needfcntl, struct file **fpp); 266 int _fdrop(struct file *fp, struct thread *td); 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(int fd, struct nameidata *ndp, struct vnode **vpp, bool *fsearch); 296 int fgetvp_lookup(int fd, 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 fo_fspacectl(struct file *fp, int cmd, off_t *offset, 486 off_t *length, int flags, struct ucred *active_cred, struct thread *td) 487 { 488 489 if (fp->f_ops->fo_fspacectl == NULL) 490 return (ENODEV); 491 return ((*fp->f_ops->fo_fspacectl)(fp, cmd, offset, length, flags, 492 active_cred, td)); 493 } 494 495 496 #endif /* _KERNEL */ 497 498 #endif /* !SYS_FILE_H */ 499