bsd/sys/file_internal.h

   1 /*
   2  * Copyright (c) 2000-2007 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
  78 struct proc;
  79 struct uio;
  80 struct knote;
  81 #ifdef __APPLE_API_UNSTABLE
  82
  83 struct file;
  84
  85
  86 /*
  87  * Kernel descriptor table.
  88  * One entry for each open kernel vnode and socket.
  89  */
  90 struct fileproc {
  91         unsigned int f_flags;
  92         int32_t f_iocount;
  93         struct fileglob * f_fglob;
  94         void *  f_waddr;
  95 };
  96
  97 #define FILEPROC_NULL (struct fileproc *)0
  98
  99 #define FP_INCREATE     0x0001
 100 #define FP_INCLOSE      0x0002
 101 #define FP_INSELECT     0x0004
 102 /*
 103  * see <rdar://problem/6647955>
 104  */
 105 #if CONFIG_EMBEDDED
 106 #define FP_INCHRREAD    0x0000
 107 #else
 108 #define FP_INCHRREAD    0x0008
 109 #endif
 110 #define FP_WRITTEN      0x0010
 111 #define FP_CLOSING      0x0020
 112 #define FP_WAITCLOSE    0x0040
 113 #define FP_AIOISSUED    0x0080
 114 #define FP_WAITEVENT    0x0100
 115
 116 #define FP_VALID_FLAGS (FP_INCREATE | FP_INCLOSE | FP_INSELECT | FP_INCHRREAD | FP_WRITTEN | FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE | FP_AIOISSUED | FP_WAITEVENT)
 117
 118
 119 #ifndef _KAUTH_CRED_T
 120 #define _KAUTH_CRED_T
 121 struct ucred;
 122 typedef struct ucred *kauth_cred_t;
 123 #endif  /* !_KAUTH_CRED_T */
 124
 125 /* file types */
 126 typedef enum {
 127         DTYPE_VNODE     = 1,    /* file */
 128         DTYPE_SOCKET,           /* communications endpoint */
 129         DTYPE_PSXSHM,           /* POSIX Shared memory */
 130         DTYPE_PSXSEM,           /* POSIX Semaphores */
 131         DTYPE_KQUEUE,           /* kqueue */
 132         DTYPE_PIPE,             /* pipe */
 133         DTYPE_FSEVENTS          /* fsevents */
 134 } file_type_t;
 135
 136 /* defines for fg_lflags */
 137 #define FG_TERM         0x01    /* the fileglob is terminating .. */
 138 #define FG_INSMSGQ      0x02    /* insert to msgqueue pending .. */
 139 #define FG_WINSMSGQ     0x04    /* wait for the fielglob is in msgque */
 140 #define FG_RMMSGQ       0x08    /* the fileglob is being removed from msgqueue */
 141 #define FG_WRMMSGQ      0x10    /* wait for the fileglob to  be removed from msgqueue */
 142
 143 struct fileglob {
 144         LIST_ENTRY(fileglob) f_list;/* list of active files */
 145         LIST_ENTRY(fileglob) f_msglist;/* list of active files */
 146         int32_t fg_flag;                /* see fcntl.h */
 147         file_type_t fg_type;            /* descriptor type */
 148         int32_t fg_count;       /* reference count */
 149         int32_t fg_msgcount;    /* references from message queue */
 150         kauth_cred_t fg_cred;   /* credentials associated with descriptor */
 151         struct  fileops {
 152                 int     (*fo_read)      (struct fileproc *fp, struct uio *uio,
 153                                          int flags, vfs_context_t ctx);
 154                 int     (*fo_write)     (struct fileproc *fp, struct uio *uio,
 155                                          int flags, vfs_context_t ctx);
 156 #define FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
 157 #define FOF_PCRED       0x00000002      /* cred from proc, not current thread */
 158                 int     (*fo_ioctl)     (struct fileproc *fp, u_long com,
 159                                          caddr_t data, vfs_context_t ctx);
 160                 int     (*fo_select)    (struct fileproc *fp, int which,
 161                                          void *wql, vfs_context_t ctx);
 162                 int     (*fo_close)     (struct fileglob *fg, vfs_context_t ctx);
 163                 int     (*fo_kqfilter)  (struct fileproc *fp, struct knote *kn,
 164                                          vfs_context_t ctx);
 165                 int     (*fo_drain)     (struct fileproc *fp, vfs_context_t ctx);
 166         } *fg_ops;
 167         off_t   fg_offset;
 168         caddr_t fg_data;                /* vnode or socket or SHM or semaphore */
 169         lck_mtx_t fg_lock;
 170         int32_t fg_lflags;              /* file global flags */
 171         unsigned int fg_lockpc[4];
 172         unsigned int fg_unlockpc[4];
 173 #if CONFIG_MACF
 174         struct label *fg_label;  /* JMM - use the one in the cred? */
 175 #endif
 176 };
 177
 178 #ifdef __APPLE_API_PRIVATE
 179 LIST_HEAD(filelist, fileglob);
 180 LIST_HEAD(fmsglist, fileglob);
 181 extern struct filelist filehead;        /* head of list of open files */
 182 extern struct fmsglist fmsghead;        /* head of list of open files */
 183 extern int maxfiles;                    /* kernel limit on number of open files */
 184 extern int nfiles;                      /* actual number of open files */
 185 extern int maxfilesperproc;
 186 #endif /* __APPLE_API_PRIVATE */
 187
 188
 189 __BEGIN_DECLS
 190 int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
 191 int fo_write(struct fileproc *fp, struct uio *uio, int flags,
 192                 vfs_context_t ctx);
 193 int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
 194 int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
 195 int fo_close(struct fileglob *fg, vfs_context_t ctx);
 196 int fo_kqfilter(struct fileproc *fp, struct knote *kn, vfs_context_t ctx);
 197 void fileproc_drain(proc_t, struct fileproc *);
 198 int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
 199 int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
 200 int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
 201 int fp_free(struct proc * p, int fd, struct fileproc * fp);
 202 struct kqueue;
 203 int fp_getfkq(struct proc *p, int fd, struct fileproc **resultfp, struct kqueue  **resultkq);
 204 struct psemnode;
 205 int fp_getfpsem(struct proc *p, int fd, struct fileproc **resultfp, struct psemnode  **resultpsem);
 206 struct pshmnode;
 207 int fp_getfpshm(struct proc *p, int fd, struct fileproc **resultfp, struct pshmnode  **resultpshm);
 208 struct pipe;
 209 int fp_getfpipe(struct proc *p, int fd, struct fileproc **resultfp, struct pipe  **resultpipe);
 210 struct atalk;
 211 int fp_getfatalk(struct proc *p, int fd, struct fileproc **resultfp, struct atalk  **resultatalk);
 212 struct vnode;
 213 int fp_getfvp(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp);
 214 int fp_getfvpandvid(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp, uint32_t * vidp);
 215 struct socket;
 216 int fp_getfsock(struct proc *p, int fd, struct fileproc **resultfp, struct socket  **results);
 217 int fp_lookup(struct proc *p, int fd, struct fileproc **resultfp, int locked);
 218 int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
 219 void fg_insertuipc(struct fileglob * fg);
 220 void fg_removeuipc(struct fileglob * fg);
 221 void unp_gc_wait(void);
 222 void procfdtbl_reservefd(struct proc * p, int fd);
 223 void procfdtbl_markclosefd(struct proc * p, int fd);
 224 void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
 225 void procfdtbl_waitfd(struct proc * p, int fd);
 226 void procfdtbl_clearfd(struct proc * p, int fd);
 227 boolean_t filetype_issendable(file_type_t type);
 228 extern int fdgetf_noref(proc_t, int, struct fileproc **);
 229 __END_DECLS
 230
 231 #endif /* __APPLE_API_UNSTABLE */
 232
 233 #endif /* KERNEL */
 234
 235 #endif /* !_SYS_FILE_INTERNAL_H_ */