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
  80 struct proc;
  81 struct uio;
  82 struct knote;
  83 #ifdef __APPLE_API_UNSTABLE
  84
  85 struct file;
  86
  87
  88 /*
  89  * Kernel descriptor table.
  90  * One entry for each open kernel vnode and socket.
  91  */
  92 struct fileproc {
  93         unsigned int f_flags;
  94         int32_t f_iocount;
  95         struct fileglob * f_fglob;
  96         void *f_wset;
  97 };
  98
  99 #define FILEPROC_NULL (struct fileproc *)0
 100
 101 #define FP_INCREATE     0x0001
 102 #define FP_INCLOSE      0x0002
 103 #define FP_INSELECT     0x0004
 104 #define FP_UNUSED       0x0008  /* unused (was FP_INCHRREAD) */
 105 #define FP_WRITTEN      0x0010
 106 #define FP_CLOSING      0x0020
 107 #define FP_WAITCLOSE    0x0040
 108 #define FP_AIOISSUED    0x0080
 109 #define FP_WAITEVENT    0x0100
 110 #define FP_SELCONFLICT  0x0200  /* select conflict on an individual fp */
 111
 112 /* squeeze a "type" value into the upper flag bits */
 113
 114 #define _FP_TYPESHIFT   24
 115 #define FP_TYPEMASK     (0x7 << _FP_TYPESHIFT)  /* 8 "types" of fileproc */
 116
 117 #define FILEPROC_TYPE(fp)       ((fp)->f_flags & FP_TYPEMASK)
 118
 119 #define FP_ISGUARDED(fp, attribs)  \
 120                 ((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)
 121
 122 typedef enum {
 123         FTYPE_SIMPLE    = 0,
 124         FTYPE_GUARDED   = (1 << _FP_TYPESHIFT)
 125 } fileproc_type_t;
 126
 127 #define FP_VALID_FLAGS  (FP_INCREATE | FP_INCLOSE | FP_INSELECT |\
 128                 FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE |\
 129                 FP_AIOISSUED | FP_WAITEVENT | FP_SELCONFLICT | _FP_TYPEMASK)
 130
 131 #ifndef _KAUTH_CRED_T
 132 #define _KAUTH_CRED_T
 133 struct ucred;
 134 typedef struct ucred *kauth_cred_t;
 135 struct posix_cred;
 136 typedef struct posix_cred *posix_cred_t;
 137 #endif  /* !_KAUTH_CRED_T */
 138
 139 /* file types */
 140 typedef enum {
 141         DTYPE_VNODE     = 1,    /* file */
 142         DTYPE_SOCKET,           /* communications endpoint */
 143         DTYPE_PSXSHM,           /* POSIX Shared memory */
 144         DTYPE_PSXSEM,           /* POSIX Semaphores */
 145         DTYPE_KQUEUE,           /* kqueue */
 146         DTYPE_PIPE,             /* pipe */
 147         DTYPE_FSEVENTS,         /* fsevents */
 148         DTYPE_ATALK,            /* (obsolete) */
 149         DTYPE_NETPOLICY,        /* networking policy */
 150 } file_type_t;
 151
 152 /* defines for fg_lflags */
 153 #define FG_TERM         0x01    /* the fileglob is terminating .. */
 154 #define FG_INSMSGQ      0x02    /* insert to msgqueue pending .. */
 155 #define FG_WINSMSGQ     0x04    /* wait for the fielglob is in msgque */
 156 #define FG_RMMSGQ       0x08    /* the fileglob is being removed from msgqueue */
 157 #define FG_WRMMSGQ      0x10    /* wait for the fileglob to  be removed from msgqueue */
 158 #define FG_PORTMADE     0x20    /* a port was at some point created for this fileglob */
 159 #define FG_NOSIGPIPE    0x40    /* don't deliver SIGPIPE with EPIPE return */
 160 #define FG_OFF_LOCKED   0x80    /* Used as a mutex for offset changes (for vnodes) */
 161 #define FG_OFF_LOCKWANT 0x100   /* Somebody's wating for the lock */
 162 #define FG_CONFINED     0x200   /* fileglob confined to process, immutably */
 163 #define FG_HAS_OFDLOCK  0x400   /* Has or has had an OFD lock */
 164
 165 struct fileglob {
 166         LIST_ENTRY(fileglob) f_msglist;/* list of active files */
 167         int32_t fg_flag;                /* see fcntl.h */
 168         int32_t fg_count;       /* reference count */
 169         int32_t fg_msgcount;    /* references from message queue */
 170         int32_t fg_lflags;      /* file global flags */
 171         kauth_cred_t fg_cred;   /* credentials associated with descriptor */
 172         const struct fileops {
 173                 file_type_t     fo_type;        /* descriptor type */
 174                 int     (*fo_read)      (struct fileproc *fp, struct uio *uio,
 175                                          int flags, vfs_context_t ctx);
 176                 int     (*fo_write)     (struct fileproc *fp, struct uio *uio,
 177                                          int flags, vfs_context_t ctx);
 178 #define FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
 179 #define FOF_PCRED       0x00000002      /* cred from proc, not current thread */
 180                 int     (*fo_ioctl)     (struct fileproc *fp, u_long com,
 181                                          caddr_t data, vfs_context_t ctx);
 182                 int     (*fo_select)    (struct fileproc *fp, int which,
 183                                          void *wql, vfs_context_t ctx);
 184                 int     (*fo_close)     (struct fileglob *fg, vfs_context_t ctx);
 185                 int     (*fo_kqfilter)  (struct fileproc *fp, struct knote *kn,
 186                                          vfs_context_t ctx);
 187                 int     (*fo_drain)     (struct fileproc *fp, vfs_context_t ctx);
 188         } *fg_ops;
 189         off_t   fg_offset;
 190         void    *fg_data;       /* vnode or socket or SHM or semaphore */
 191         void    *fg_vn_data;    /* Per fd vnode data, used for directories */
 192         lck_mtx_t fg_lock;
 193 #if CONFIG_MACF
 194         struct label *fg_label;  /* JMM - use the one in the cred? */
 195 #endif
 196 };
 197
 198 #ifdef __APPLE_API_PRIVATE
 199 LIST_HEAD(fmsglist, fileglob);
 200 extern struct fmsglist fmsghead;        /* head of list of open files */
 201 extern int maxfiles;                    /* kernel limit on number of open files */
 202 extern int nfiles;                      /* actual number of open files */
 203 extern int maxfilesperproc;
 204
 205 #define FILEGLOB_DTYPE(fg)              ((const file_type_t)((fg)->fg_ops->fo_type))
 206 #endif /* __APPLE_API_PRIVATE */
 207
 208
 209 __BEGIN_DECLS
 210 int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
 211 int fo_write(struct fileproc *fp, struct uio *uio, int flags,
 212                 vfs_context_t ctx);
 213 int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
 214 int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
 215 int fo_close(struct fileglob *fg, vfs_context_t ctx);
 216 int fo_kqfilter(struct fileproc *fp, struct knote *kn, vfs_context_t ctx);
 217 void fileproc_drain(proc_t, struct fileproc *);
 218 int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
 219 int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
 220 int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
 221 int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
 222 int fp_free(struct proc * p, int fd, struct fileproc * fp);
 223 struct kqueue;
 224 int fp_getfkq(struct proc *p, int fd, struct fileproc **resultfp, struct kqueue  **resultkq);
 225 struct psemnode;
 226 int fp_getfpsem(struct proc *p, int fd, struct fileproc **resultfp, struct psemnode  **resultpsem);
 227 struct pshmnode;
 228 int fp_getfpshm(struct proc *p, int fd, struct fileproc **resultfp, struct pshmnode  **resultpshm);
 229 struct pipe;
 230 int fp_getfpipe(struct proc *p, int fd, struct fileproc **resultfp, struct pipe  **resultpipe);
 231 struct atalk;
 232 int fp_getfatalk(struct proc *p, int fd, struct fileproc **resultfp, struct atalk  **resultatalk);
 233 struct vnode;
 234 int fp_getfvpandvid(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp, uint32_t * vidp);
 235 struct socket;
 236 int fp_getfsock(struct proc *p, int fd, struct fileproc **resultfp, struct socket  **results);
 237 int fp_lookup(struct proc *p, int fd, struct fileproc **resultfp, int locked);
 238 int fp_isguarded(struct fileproc *fp, u_int attribs);
 239 int fp_guard_exception(proc_t p, int fd, struct fileproc *fp, u_int attribs);
 240 int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
 241 int close_internal_locked(proc_t p, int fd, struct fileproc *fp, int flags);
 242 struct nameidata;
 243 struct vnode_attr;
 244 int open1(vfs_context_t ctx, struct nameidata *ndp, int uflags,
 245     struct vnode_attr *vap, fp_allocfn_t fp_zalloc, void *cra,
 246     int32_t *retval);
 247 int kqueue_body(struct proc *p, fp_allocfn_t, void *cra, int32_t *retval);
 248 void fg_insertuipc(struct fileglob * fg);
 249 boolean_t fg_insertuipc_mark(struct fileglob * fg);
 250 void fg_removeuipc(struct fileglob * fg);
 251 boolean_t fg_removeuipc_mark(struct fileglob * fg);
 252 void unp_gc_wait(void);
 253 void procfdtbl_reservefd(struct proc * p, int fd);
 254 void procfdtbl_markclosefd(struct proc * p, int fd);
 255 void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
 256 void procfdtbl_waitfd(struct proc * p, int fd);
 257 void procfdtbl_clearfd(struct proc * p, int fd);
 258 boolean_t file_issendable(struct proc * p, struct fileproc *fp);
 259 extern int fdgetf_noref(proc_t, int, struct fileproc **);
 260 extern struct fileproc *fileproc_alloc_init(void *crargs);
 261 extern void fileproc_free(struct fileproc *fp);
 262 extern void guarded_fileproc_free(struct fileproc *fp);
 263 extern void fg_vn_data_free(void *fgvndata);
 264 extern int nameiat(struct nameidata *ndp, int dirfd);
 265 extern int falloc_guarded(struct proc *p, struct fileproc **fp, int *fd,
 266     vfs_context_t ctx, const guardid_t *guard, u_int attrs);
 267 __END_DECLS
 268
 269 #endif /* __APPLE_API_UNSTABLE */
 270
 271 #endif /* KERNEL */
 272
 273 #endif /* !_SYS_FILE_INTERNAL_H_ */