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