bsd/sys/file_internal.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  31 /*
  32  * Copyright (c) 1982, 1986, 1989, 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)file.h      8.3 (Berkeley) 1/9/95
  64  */
  65
  66 #ifndef _SYS_FILE_INTERNAL_H_
  67 #define _SYS_FILE_INTERNAL_H_
  68
  69 #include <sys/appleapiopts.h>
  70 #include <sys/fcntl.h>
  71 #include <sys/unistd.h>
  72
  73 #ifdef KERNEL
  74 #include <sys/errno.h>
  75 #include <sys/queue.h>
  76 #include <sys/cdefs.h>
  77 #include <sys/lock.h>
  78 #include <sys/file.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         int32_t f_flags;
  94         int32_t f_iocount;
  95         struct fileglob * f_fglob;
  96         void *  f_waddr;
  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_INCHRREAD    0x0008
 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
 111
 112 /* defns of close_internal */
 113 #define CLOSEINT_LOCKED     1
 114 #define CLOSEINT_WAITONCLOSE 2
 115 #define CLOSEINT_NOFDRELSE  4
 116 #define CLOSEINT_NOFDNOREF  8
 117
 118 struct fileglob {
 119         LIST_ENTRY(fileglob) f_list;/* list of active files */
 120         LIST_ENTRY(fileglob) f_msglist;/* list of active files */
 121         int32_t fg_flag;                /* see fcntl.h */
 122         int32_t fg_type;                /* descriptor type */
 123         int32_t fg_count;       /* reference count */
 124         int32_t fg_msgcount;    /* references from message queue */
 125         struct  ucred *fg_cred; /* credentials associated with descriptor */
 126         struct  fileops {
 127                 int     (*fo_read)      __P((struct fileproc *fp, struct uio *uio,
 128                                             struct ucred *cred, int flags,
 129                                             struct proc *p));
 130                 int     (*fo_write)     __P((struct fileproc *fp, struct uio *uio,
 131                                             struct ucred *cred, int flags,
 132                                             struct proc *p));
 133 #define FOF_OFFSET      0x00000001      /* offset supplied to vn_write */
 134 #define FOF_PCRED       0x00000002      /* cred from proc, not current thread */
 135                 int     (*fo_ioctl)     __P((struct fileproc *fp, u_long com,
 136                                             caddr_t data, struct proc *p));
 137                 int     (*fo_select)    __P((struct fileproc *fp, int which,
 138                                                 void *wql, struct proc *p));
 139                 int     (*fo_close)     __P((struct fileglob *fg, struct proc *p));
 140                 int     (*fo_kqfilter)  __P((struct fileproc *fp, struct knote *kn,
 141                                              struct proc *p));
 142                 int     (*fo_drain)     (struct fileproc *fp, struct proc *p);
 143         } *fg_ops;
 144         off_t   fg_offset;
 145         caddr_t fg_data;                /* vnode or socket or SHM or semaphore */
 146         lck_mtx_t fg_lock;
 147         int32_t fg_lflags;              /* file global flags */
 148         unsigned int fg_lockpc[4];
 149         unsigned int fg_unlockpc[4];
 150 };
 151
 152 /* file types */
 153 #define DTYPE_VNODE     1       /* file */
 154 #define DTYPE_SOCKET    2       /* communications endpoint */
 155 #define DTYPE_PSXSHM    3       /* POSIX Shared memory */
 156 #define DTYPE_PSXSEM    4       /* POSIX Semaphores */
 157 #define DTYPE_KQUEUE    5       /* kqueue */
 158 #define DTYPE_PIPE      6       /* pipe */
 159 #define DTYPE_FSEVENTS  7       /* fsevents */
 160
 161 /* defines for fg_lflags */
 162 #define FG_TERM         0x01    /* the fileglob is terminating .. */
 163 #define FG_INSMSGQ      0x02    /* insert to msgqueue pending .. */
 164 #define FG_WINSMSGQ     0x04    /* wait for the fielglob is in msgque */
 165 #define FG_RMMSGQ       0x08    /* the fileglob is being removed from msgqueue */
 166 #define FG_WRMMSGQ      0x10    /* wait for the fileglob to  be removed from msgqueue */
 167
 168
 169 #ifdef __APPLE_API_PRIVATE
 170 LIST_HEAD(filelist, fileglob);
 171 LIST_HEAD(fmsglist, fileglob);
 172 extern struct filelist filehead;        /* head of list of open files */
 173 extern struct fmsglist fmsghead;        /* head of list of open files */
 174 extern int maxfiles;                    /* kernel limit on number of open files */
 175 extern int nfiles;                      /* actual number of open files */
 176 #endif /* __APPLE_API_PRIVATE */
 177
 178
 179 __BEGIN_DECLS
 180 int fo_read(struct fileproc *fp, struct uio *uio,
 181         struct ucred *cred, int flags, struct proc *p);
 182 int fo_write(struct fileproc *fp, struct uio *uio,
 183         struct ucred *cred, int flags, struct proc *p);
 184 int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data,
 185         struct proc *p);
 186 int fo_select(struct fileproc *fp, int which, void *wql,
 187         struct proc *p);
 188 int fo_close(struct fileglob *fg, struct proc *p);
 189 int fo_kqfilter(struct fileproc *fp, struct knote *kn,
 190         struct proc *p);
 191 void fileproc_drain(proc_t, struct fileproc *);
 192 void fp_setflags(proc_t, struct fileproc *, int);
 193 void fp_clearflags(proc_t, struct fileproc *, int);
 194 int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
 195 int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
 196 int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
 197 int fp_free(struct proc * p, int fd, struct fileproc * fp);
 198 struct kqueue;
 199 int fp_getfkq(struct proc *p, int fd, struct fileproc **resultfp, struct kqueue  **resultkq);
 200 struct psemnode;
 201 int fp_getfpsem(struct proc *p, int fd, struct fileproc **resultfp, struct psemnode  **resultpsem);
 202 struct vnode;
 203 int fp_getfvp(struct proc *p, int fd, struct fileproc **resultfp, struct vnode  **resultvp);
 204 struct socket;
 205 int fp_getfsock(struct proc *p, int fd, struct fileproc **resultfp, struct socket  **results);
 206 int fp_lookup(struct proc *p, int fd, struct fileproc **resultfp, int locked);
 207 int close_internal(struct proc *p, int fd, struct fileproc *fp, int flags);
 208 int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
 209 void fg_insertuipc(struct fileglob * fg);
 210 void fg_removeuipc(struct fileglob * fg);
 211 __END_DECLS
 212
 213 #endif /* __APPLE_API_UNSTABLE */
 214
 215 #endif /* KERNEL */
 216
 217 #endif /* !_SYS_FILE_INTERNAL_H_ */