bsd/sys/file_internal.h

   1 /*
   2  * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1982, 1986, 1989, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)file.h      8.3 (Berkeley) 1/9/95
  62  */
  63
  64 #ifndef _SYS_FILE_INTERNAL_H_
  65 #define _SYS_FILE_INTERNAL_H_
  66
  67 #include <sys/appleapiopts.h>
  68 #include <sys/fcntl.h>
  69 #include <sys/unistd.h>
  70
  71 #ifdef KERNEL
  72 #include <sys/errno.h>
  73 #include <sys/queue.h>
  74 #include <sys/cdefs.h>
  75 #include <sys/lock.h>
  76 #include <sys/file.h>
  77 #include <sys/filedesc.h>
  78 #include <sys/guarded.h>
  79 #include <os/refcnt.h>
  80
  81 struct proc;
  82 struct uio;
  83 struct knote;
  84 struct kevent_qos_s;
  85
  86 #ifdef __APPLE_API_UNSTABLE
  87
  88 struct file;
  89
  90 __options_decl(fileproc_vflags_t, unsigned int, {
  91         FPV_NONE        = 0,
  92         FPV_DRAIN       = 0x01,
  93 });
  94
  95 /*
  96  * Kernel descriptor table.
  97  * One entry for each open kernel vnode and socket.
  98  */
  99 struct fileproc {
 100         unsigned int f_flags;
 101         _Atomic fileproc_vflags_t f_vflags;
 102         os_refcnt_t f_iocount;
 103         struct fileglob * f_fglob;
 104         void *f_wset;
 105 };
 106
 107 #define FILEPROC_NULL (struct fileproc *)0
 108
 109 #define FP_INCREATE     0x0001
 110 #define FP_INCLOSE      0x0002
 111 #define FP_INSELECT     0x0004
 112 #define FP_UNUSED       0x0008  /* unused (was FP_INCHRREAD) */
 113 #define FP_WRITTEN      0x0010
 114 #define FP_CLOSING      0x0020
 115 #define FP_WAITCLOSE    0x0040
 116 #define FP_AIOISSUED    0x0080
 117 #define FP_WAITEVENT    0x0100
 118 #define FP_SELCONFLICT  0x0200  /* select conflict on an individual fp */
 119
 120 /* squeeze a "type" value into the upper flag bits */
 121
 122 #define _FP_TYPESHIFT   24
 123 #define FP_TYPEMASK     (0x7 << _FP_TYPESHIFT)  /* 8 "types" of fileproc */
 124
 125 #define FILEPROC_TYPE(fp)       ((fp)->f_flags & FP_TYPEMASK)
 126
 127 #define FP_ISGUARDED(fp, attribs)  \
 128                 ((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)
 129
 130 typedef enum {
 131         FTYPE_SIMPLE    = 0,
 132         FTYPE_GUARDED   = (1 << _FP_TYPESHIFT)
 133 } fileproc_type_t;
 134
 135 #define FP_VALID_FLAGS  (FP_INCREATE | FP_INCLOSE | FP_INSELECT |\
 136                 FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE |\
 137                 FP_AIOISSUED | FP_WAITEVENT | FP_SELCONFLICT | _FP_TYPEMASK)
 138
 139 #ifndef _KAUTH_CRED_T
 140 #define _KAUTH_CRED_T
 141 struct ucred;
 142 typedef struct ucred *kauth_cred_t;
 143 struct posix_cred;
 144 typedef struct posix_cred *posix_cred_t;
 145 #endif  /* !_KAUTH_CRED_T */
 146
 147 /* file types */
 148 typedef enum {
 149         DTYPE_VNODE     = 1,    /* file */
 150         DTYPE_SOCKET,           /* communications endpoint */
 151         DTYPE_PSXSHM,           /* POSIX Shared memory */
 152         DTYPE_PSXSEM,           /* POSIX Semaphores */
 153         DTYPE_KQUEUE,           /* kqueue */
 154         DTYPE_PIPE,             /* pipe */
 155         DTYPE_FSEVENTS,         /* fsevents */
 156         DTYPE_ATALK,            /* (obsolete) */
 157         DTYPE_NETPOLICY,        /* networking policy */
 158 } file_type_t;
 159
 160 /* defines for fg_lflags */
 161 #define FG_TERM         0x01    /* the fileglob is terminating .. */
 162 #define FG_INSMSGQ      0x02    /* insert to msgqueue pending .. */
 163 #define FG_WINSMSGQ     0x04    /* wait for the fielglob is in msgque */
 164 #define FG_RMMSGQ       0x08    /* the fileglob is being removed from msgqueue */
 165 #define FG_WRMMSGQ      0x10    /* wait for the fileglob to  be removed from msgqueue */
 166 #define FG_PORTMADE     0x20    /* a port was at some point created for this fileglob */
 167 #define FG_NOSIGPIPE    0x40    /* don't deliver SIGPIPE with EPIPE return */
 168 #define FG_OFF_LOCKED   0x80    /* Used as a mutex for offset changes (for vnodes) */
 169 #define FG_OFF_LOCKWANT 0x100   /* Somebody's wating for the lock */
 170 #define FG_CONFINED     0x200   /* fileglob confined to process, immutably */
 171 #define FG_HAS_OFDLOCK  0x400   /* Has or has had an OFD lock */
 172
 173 struct fileops {
 174         file_type_t     fo_type;        /* descriptor type */
 175         int (*fo_read)      (struct fileproc *fp, struct uio *uio,
 176             int flags, vfs_context_t ctx);
 177         int (*fo_write)     (struct fileproc *fp, struct uio *uio,
 178             int flags, vfs_context_t ctx);
 179 #define FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
 180 #define FOF_PCRED       0x00000002      /* cred from proc, not current thread */
 181         int (*fo_ioctl)(struct fileproc *fp, u_long com,
 182             caddr_t data, vfs_context_t ctx);
 183         int (*fo_select)    (struct fileproc *fp, int which,
 184             void *wql, vfs_context_t ctx);
 185         int (*fo_close)     (struct fileglob *fg, vfs_context_t ctx);
 186         int (*fo_kqfilter)  (struct fileproc *fp, struct knote *, struct kevent_qos_s *);
 187         int (*fo_drain)     (struct fileproc *fp, vfs_context_t ctx);
 188 };
 189
 190 struct fileglob {
 191         LIST_ENTRY(fileglob) f_msglist;/* list of active files */
 192         int32_t fg_flag;        /* see fcntl.h */
 193         int32_t fg_count;       /* reference count */
 194         int32_t fg_msgcount;    /* references from message queue */
 195         int32_t fg_lflags;      /* file global flags */
 196         kauth_cred_t fg_cred;   /* credentials associated with descriptor */
 197         const struct fileops *fg_ops;
 198         off_t   fg_offset;
 199         void   *fg_data;        /* vnode or socket or SHM or semaphore */
 200         void   *fg_vn_data;     /* Per fd vnode data, used for directories */
 201         lck_mtx_t fg_lock;
 202 #if CONFIG_MACF
 203         struct label *fg_label; /* JMM - use the one in the cred? */
 204 #endif
 205 };
 206
 207 #ifdef __APPLE_API_PRIVATE
 208 LIST_HEAD(fmsglist, fileglob);
 209 extern struct fmsglist fmsghead;        /* head of list of open files */
 210 extern int maxfiles;                    /* kernel limit on number of open files */
 211 extern int nfiles;                      /* actual number of open files */
 212 extern int maxfilesperproc;
 213
 214 #define FILEGLOB_DTYPE(fg)              ((const file_type_t)((fg)->fg_ops->fo_type))
 215 #endif /* __APPLE_API_PRIVATE */
 216
 217
 218 __BEGIN_DECLS
 219
 220 /* wrappers for fp->f_ops->fo_... */
 221 int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
 222 int fo_write(struct fileproc *fp, struct uio *uio, int flags,
 223     vfs_context_t ctx);
 224 int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
 225 int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
 226 int fo_close(struct fileglob *fg, vfs_context_t ctx);
 227 int fo_drain(struct fileproc *fp, vfs_context_t ctx);
 228 int fo_kqfilter(struct fileproc *fp, struct knote *kn, struct kevent_qos_s *kev);
 229
 230 /* Functions to use for unsupported fileops */
 231 int fo_no_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
 232 int fo_no_write(struct fileproc *fp, struct uio *uio, int flags,
 233     vfs_context_t ctx);
 234 int fo_no_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
 235 int fo_no_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
 236 int fo_no_drain(struct fileproc *fp, vfs_context_t ctx);
 237 int fo_no_kqfilter(struct fileproc *, struct knote *, struct kevent_qos_s *kev);
 238
 239 void fileproc_drain(proc_t, struct fileproc *);
 240 int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
 241 int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
 242 int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
 243 int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
 244 void fp_free(struct proc * p, int fd, struct fileproc * fp);
 245 struct kqueue;
 246 int fp_getfkq(struct proc *p, int fd, struct fileproc **resultfp, struct kqueue  **resultkq);
 247 struct psemnode;
 248 int fp_getfpsem(struct proc *p, int fd, struct fileproc **resultfp, struct psemnode  **resultpsem);
 249 struct pshmnode;
 250 int fp_getfpshm(struct proc *p, int fd, struct fileproc **resultfp, struct pshmnode  **resultpshm);
 251 struct pipe;
 252 int fp_getfpipe(struct proc *p, int fd, struct fileproc **resultfp, struct pipe  **resultpipe);
 253 struct atalk;
 254 int fp_getfatalk(struct proc *p, int fd, struct fileproc **resultfp, struct atalk  **resultatalk);
 255 struct vnode;
 256 int fp_getfvpandvid(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp, uint32_t * vidp);
 257 struct socket;
 258 int fp_getfsock(struct proc *p, int fd, struct fileproc **resultfp, struct socket  **results);
 259 int fp_lookup(struct proc *p, int fd, struct fileproc **resultfp, int locked);
 260 int fp_isguarded(struct fileproc *fp, u_int attribs);
 261 int fp_guard_exception(proc_t p, int fd, struct fileproc *fp, u_int attribs);
 262 int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
 263 int close_internal_locked(proc_t p, int fd, struct fileproc *fp, int flags);
 264 int fileport_makefd_internal(proc_t p, ipc_port_t port, int uf_flags, int *fd);
 265 struct nameidata;
 266 struct vnode_attr;
 267 int open1(vfs_context_t ctx, struct nameidata *ndp, int uflags,
 268     struct vnode_attr *vap, fp_allocfn_t fp_zalloc, void *cra,
 269     int32_t *retval);
 270 int chdir_internal(proc_t p, vfs_context_t ctx, struct nameidata *ndp, int per_thread);
 271 int kqueue_internal(struct proc *p, fp_allocfn_t, void *cra, int32_t *retval);
 272 void fg_insertuipc(struct fileglob * fg);
 273 boolean_t fg_insertuipc_mark(struct fileglob * fg);
 274 void fg_removeuipc(struct fileglob * fg);
 275 boolean_t fg_removeuipc_mark(struct fileglob * fg);
 276 void unp_gc_wait(void);
 277 void procfdtbl_reservefd(struct proc * p, int fd);
 278 void procfdtbl_markclosefd(struct proc * p, int fd);
 279 void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
 280 void procfdtbl_waitfd(struct proc * p, int fd);
 281 void procfdtbl_clearfd(struct proc * p, int fd);
 282 boolean_t file_issendable(struct proc * p, struct fileproc *fp);
 283 extern int fdgetf_noref(proc_t, int, struct fileproc **);
 284 extern struct fileproc *fileproc_alloc_init(void *crargs);
 285 extern void fileproc_free(struct fileproc *fp);
 286 extern void guarded_fileproc_free(struct fileproc *fp);
 287 extern void fg_vn_data_free(void *fgvndata);
 288 extern int nameiat(struct nameidata *ndp, int dirfd);
 289 extern int falloc_guarded(struct proc *p, struct fileproc **fp, int *fd,
 290     vfs_context_t ctx, const guardid_t *guard, u_int attrs);
 291 extern void fileproc_modify_vflags(struct fileproc *fp, fileproc_vflags_t vflags, boolean_t clearflags);
 292 fileproc_vflags_t fileproc_get_vflags(struct fileproc *fp);
 293 __END_DECLS
 294
 295 #endif /* __APPLE_API_UNSTABLE */
 296
 297 #endif /* KERNEL */
 298
 299 #endif /* !_SYS_FILE_INTERNAL_H_ */