]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/filedesc.h
xnu-3789.1.32.tar.gz
[apple/xnu.git] / bsd / sys / filedesc.h
CommitLineData
1c79356b 1/*
39236c6e 2 * Copyright (c) 2000-2012 Apple Computer, Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
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.
8f6c56a5 14 *
2d21ac55
A
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
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
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
9bccf70c
A
67#include <sys/appleapiopts.h>
68
1c79356b
A
69/*
70 * This structure is used for the management of descriptors. It may be
71 * shared by multiple processes.
72 *
73 * A process is initially started out with NDFILE descriptors [XXXstored within
74 * this structureXXX], selected to be enough for typical applications based on
75 * the historical limit of 20 open files (and the usage of descriptors by
76 * shells). If these descriptors are exhausted, a larger descriptor table
77 * may be allocated, up to a process' resource limit; [XXXthe internal arrays
78 * are then unusedXXX]. The initial expansion is set to NDEXTENT; each time
79 * it runs out, it is doubled until the resource limit is reached. NDEXTENT
80 * should be selected to be the biggest multiple of OFILESIZE (see below)
81 * that will fit in a power-of-two sized piece of memory.
82 */
83#define NDFILE 25 /* 125 bytes */
84#define NDEXTENT 50 /* 250 bytes in 256-byte alloc. */
85
b0d623f7
A
86#ifdef BSD_KERNEL_PRIVATE
87
55e303ae
A
88struct klist;
89
1c79356b 90struct filedesc {
91447636 91 struct fileproc **fd_ofiles; /* file structures for open files */
1c79356b
A
92 char *fd_ofileflags; /* per-process open file flags */
93 struct vnode *fd_cdir; /* current directory */
94 struct vnode *fd_rdir; /* root directory */
95 int fd_nfiles; /* number of open files allocated */
2d21ac55
A
96 int fd_lastfile; /* high-water mark of fd_ofiles */
97 int fd_freefile; /* approx. next free file */
1c79356b 98 u_short fd_cmask; /* mask for file creation */
55e303ae
A
99 int fd_knlistsize; /* size of knlist */
100 struct klist *fd_knlist; /* list of attached knotes */
101 u_long fd_knhashmask; /* size of knhash */
102 struct klist *fd_knhash; /* hash table for attached knotes */
91447636 103 int fd_flags;
1c79356b
A
104};
105
91447636
A
106/*
107 * definitions for fd_flags;
108 */
109#define FD_CHROOT 0x01 /* process was chrooted... keep track even */
110 /* if we're force unmounted and unable to */
111 /* take a vnode_ref on fd_rdir during a fork */
112
1c79356b
A
113/*
114 * Per-process open flags.
115 */
39236c6e
A
116#define UF_EXCLOSE 0x01 /* auto-close on exec */
117#define UF_FORKCLOSE 0x02 /* auto-close on fork */
1c79356b 118#define UF_RESERVED 0x04 /* open pending / in progress */
91447636 119#define UF_CLOSING 0x08 /* close in progress */
1c79356b 120
6601e61a
A
121#ifdef KERNEL
122#define UF_RESVWAIT 0x10 /* close in progress */
6d2010ae 123#define UF_INHERIT 0x20 /* "inherit-on-exec" */
39236c6e 124
6d2010ae 125#define UF_VALID_FLAGS \
39236c6e
A
126 (UF_EXCLOSE | UF_FORKCLOSE | UF_RESERVED | UF_CLOSING |\
127 UF_RESVWAIT | UF_INHERIT)
2d21ac55
A
128#endif /* KERNEL */
129
1c79356b
A
130/*
131 * Storage required per open file descriptor.
132 */
133#define OFILESIZE (sizeof(struct file *) + sizeof(char))
134
135#ifdef KERNEL
136/*
137 * Kernel global variables and routines.
138 */
91447636
A
139extern int dupfdopen(struct filedesc *fdp,
140 int indx, int dfd, int mode, int error);
2d21ac55
A
141extern int fdalloc(proc_t p, int want, int *result);
142extern void fdrelse(proc_t p, int fd);
143extern int fdavail(proc_t p, int n);
1c79356b
A
144#define fdfile(p, fd) \
145 (&(p)->p_fd->fd_ofiles[(fd)])
146#define fdflags(p, fd) \
147 (&(p)->p_fd->fd_ofileflags[(fd)])
3e170ce0
A
148
149/*
150 * Accesor macros for fd flags
151 */
152#define FDFLAGS_GET(p, fd) (*fdflags(p, fd) & (UF_EXCLOSE|UF_FORKCLOSE))
153#define FDFLAGS_SET(p, fd, bits) \
154 (*fdflags(p, fd) |= ((bits) & (UF_EXCLOSE|UF_FORKCLOSE)))
155#define FDFLAGS_CLR(p, fd, bits) \
156 (*fdflags(p, fd) &= ~((bits) & (UF_EXCLOSE|UF_FORKCLOSE)))
157
2d21ac55 158extern int falloc(proc_t p, struct fileproc **resultfp, int *resultfd, vfs_context_t ctx);
9bccf70c
A
159
160#ifdef __APPLE_API_PRIVATE
39236c6e
A
161typedef struct fileproc *(*fp_allocfn_t)(void *);
162extern int falloc_withalloc(proc_t p, struct fileproc **resultfp,
163 int *resultfd, vfs_context_t ctx,
164 fp_allocfn_t fp_zalloc, void *crarg);
165
2d21ac55
A
166extern struct filedesc *fdcopy(proc_t p, struct vnode *uth_cdir);
167extern void fdfree(proc_t p);
6d2010ae 168extern void fdexec(proc_t p, short flags);
9bccf70c 169#endif /* __APPLE_API_PRIVATE */
1c79356b
A
170
171#endif /* KERNEL */
172
b0d623f7 173#endif /* BSD_KERNEL_PRIVATE */
9bccf70c 174
1c79356b 175#endif /* !_SYS_FILEDESC_H_ */