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