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