]> git.saurik.com Git - apple/xnu.git/blame_incremental - bsd/sys/filedesc.h
xnu-344.21.73.tar.gz
[apple/xnu.git] / bsd / sys / filedesc.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
7 *
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * file.
14 *
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
22 *
23 * @APPLE_LICENSE_HEADER_END@
24 */
25/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
26/*
27 * Copyright (c) 1990, 1993
28 * The Regents of the University of California. All rights reserved.
29 *
30 * Redistribution and use in source and binary forms, with or without
31 * modification, are permitted provided that the following conditions
32 * are met:
33 * 1. Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * 2. Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in the
37 * documentation and/or other materials provided with the distribution.
38 * 3. All advertising materials mentioning features or use of this software
39 * must display the following acknowledgement:
40 * This product includes software developed by the University of
41 * California, Berkeley and its contributors.
42 * 4. Neither the name of the University nor the names of its contributors
43 * may be used to endorse or promote products derived from this software
44 * without specific prior written permission.
45 *
46 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 * SUCH DAMAGE.
57 *
58 * @(#)filedesc.h 8.1 (Berkeley) 6/2/93
59 */
60
61#ifndef _SYS_FILEDESC_H_
62#define _SYS_FILEDESC_H_
63
64#include <sys/appleapiopts.h>
65
66#ifdef __APPLE_API_UNSTABLE
67/*
68 * This structure is used for the management of descriptors. It may be
69 * shared by multiple processes.
70 *
71 * A process is initially started out with NDFILE descriptors [XXXstored within
72 * this structureXXX], selected to be enough for typical applications based on
73 * the historical limit of 20 open files (and the usage of descriptors by
74 * shells). If these descriptors are exhausted, a larger descriptor table
75 * may be allocated, up to a process' resource limit; [XXXthe internal arrays
76 * are then unusedXXX]. The initial expansion is set to NDEXTENT; each time
77 * it runs out, it is doubled until the resource limit is reached. NDEXTENT
78 * should be selected to be the biggest multiple of OFILESIZE (see below)
79 * that will fit in a power-of-two sized piece of memory.
80 */
81#define NDFILE 25 /* 125 bytes */
82#define NDEXTENT 50 /* 250 bytes in 256-byte alloc. */
83
84struct filedesc {
85 struct file **fd_ofiles; /* file structures for open files */
86 char *fd_ofileflags; /* per-process open file flags */
87 struct vnode *fd_cdir; /* current directory */
88 struct vnode *fd_rdir; /* root directory */
89 int fd_nfiles; /* number of open files allocated */
90 u_short fd_lastfile; /* high-water mark of fd_ofiles */
91 u_short fd_freefile; /* approx. next free file */
92 u_short fd_cmask; /* mask for file creation */
93 u_short fd_refcnt; /* reference count */
94};
95
96/*
97 * Per-process open flags.
98 */
99#define UF_EXCLOSE 0x01 /* auto-close on exec */
100#define UF_MAPPED 0x02 /* mapped from device */
101#define UF_RESERVED 0x04 /* open pending / in progress */
102
103/*
104 * Storage required per open file descriptor.
105 */
106#define OFILESIZE (sizeof(struct file *) + sizeof(char))
107
108#ifdef KERNEL
109/*
110 * Kernel global variables and routines.
111 */
112extern int dupfdopen __P((struct filedesc *fdp,
113 int indx, int dfd, int mode, int error));
114extern int fdalloc __P((struct proc *p, int want, int *result));
115extern void fdrelse __P((struct proc *p, int fd));
116extern int fdavail __P((struct proc *p, int n));
117extern int fdgetf __P((struct proc *p, int fd, struct file **resultfp));
118#define fdfile(p, fd) \
119 (&(p)->p_fd->fd_ofiles[(fd)])
120#define fdflags(p, fd) \
121 (&(p)->p_fd->fd_ofileflags[(fd)])
122extern int falloc __P((struct proc *p,
123 struct file **resultfp, int *resultfd));
124extern void ffree __P((struct file *fp));
125
126#ifdef __APPLE_API_PRIVATE
127extern struct filedesc *fdcopy __P((struct proc *p));
128extern void fdfree __P((struct proc *p));
129extern void fdexec __P((struct proc *p));
130#endif /* __APPLE_API_PRIVATE */
131
132#endif /* KERNEL */
133
134#endif /* __APPLE_API_UNSTABLE */
135
136#endif /* !_SYS_FILEDESC_H_ */