1/* 2 * Copyright (c) 2000-2003 Apple Computer, 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) 1990, 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 * @(#)filedesc.h 8.1 (Berkeley) 6/2/93 62 */ 63 64#ifndef _SYS_FILEDESC_H_ 65#define _SYS_FILEDESC_H_ 66 67#include <sys/appleapiopts.h> 68 69#ifdef __APPLE_API_UNSTABLE 70/* 71 * This structure is used for the management of descriptors. It may be 72 * shared by multiple processes. 73 * 74 * A process is initially started out with NDFILE descriptors [XXXstored within 75 * this structureXXX], selected to be enough for typical applications based on 76 * the historical limit of 20 open files (and the usage of descriptors by 77 * shells). If these descriptors are exhausted, a larger descriptor table 78 * may be allocated, up to a process' resource limit; [XXXthe internal arrays 79 * are then unusedXXX]. The initial expansion is set to NDEXTENT; each time 80 * it runs out, it is doubled until the resource limit is reached. NDEXTENT 81 * should be selected to be the biggest multiple of OFILESIZE (see below) 82 * that will fit in a power-of-two sized piece of memory. 83 */ 84#define NDFILE 25 /* 125 bytes */ 85#define NDEXTENT 50 /* 250 bytes in 256-byte alloc. */ 86 87struct klist; 88 89struct filedesc { 90 struct fileproc **fd_ofiles; /* file structures for open files */ 91 char *fd_ofileflags; /* per-process open file flags */ 92 struct vnode *fd_cdir; /* current directory */ 93 struct vnode *fd_rdir; /* root directory */ 94 int fd_nfiles; /* number of open files allocated */ 95 int fd_lastfile; /* high-water mark of fd_ofiles */ 96 int fd_freefile; /* approx. next free file */ 97 u_short fd_cmask; /* mask for file creation */ 98 u_long fd_refcnt; /* reference count */ 99 100 int fd_knlistsize; /* size of knlist */ 101 struct klist *fd_knlist; /* list of attached knotes */ 102 u_long fd_knhashmask; /* size of knhash */ 103 struct klist *fd_knhash; /* hash table for attached knotes */ 104 int fd_flags; 105}; 106 107/* 108 * definitions for fd_flags; 109 */ 110#define FD_CHROOT 0x01 /* process was chrooted... keep track even */ 111 /* if we're force unmounted and unable to */ 112 /* take a vnode_ref on fd_rdir during a fork */ 113 114/* 115 * Per-process open flags. 116 */ 117#define UF_EXCLOSE 0x01 /* auto-close on exec */ 118#define UF_RESERVED 0x04 /* open pending / in progress */ 119#define UF_CLOSING 0x08 /* close in progress */ 120 121#ifdef KERNEL 122#define UF_RESVWAIT 0x10 /* close in progress */ 123#define UF_VALID_FLAGS (UF_EXCLOSE| UF_RESERVED | UF_CLOSING | UF_RESVWAIT) 124#endif /* KERNEL */ 125 126/* 127 * Storage required per open file descriptor. 128 */ 129#define OFILESIZE (sizeof(struct file *) + sizeof(char)) 130 131#ifdef KERNEL 132/* 133 * Kernel global variables and routines. 134 */ 135extern int dupfdopen(struct filedesc *fdp, 136 int indx, int dfd, int mode, int error); 137extern int fdalloc(proc_t p, int want, int *result); 138extern void fdrelse(proc_t p, int fd); 139extern int fdavail(proc_t p, int n); 140#define fdfile(p, fd) \ 141 (&(p)->p_fd->fd_ofiles[(fd)]) 142#define fdflags(p, fd) \ 143 (&(p)->p_fd->fd_ofileflags[(fd)]) 144extern int falloc(proc_t p, struct fileproc **resultfp, int *resultfd, vfs_context_t ctx); 145extern void ffree(struct file *fp); 146 147#ifdef __APPLE_API_PRIVATE 148extern struct filedesc *fdcopy(proc_t p, struct vnode *uth_cdir); 149extern void fdfree(proc_t p); 150extern void fdexec(proc_t p); 151#endif /* __APPLE_API_PRIVATE */ 152 153#endif /* KERNEL */ 154 155#endif /* __APPLE_API_UNSTABLE */ 156 157#endif /* !_SYS_FILEDESC_H_ */ 158