1/*
2 * Copyright (c) 2000-2016 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#include <sys/filedesc.h>
78#include <sys/guarded.h>
79
80struct proc;
81struct uio;
82struct knote;
83struct kevent_internal_s;
84
85#ifdef __APPLE_API_UNSTABLE
86
87struct file;
88
89
90/*
91 * Kernel descriptor table.
92 * One entry for each open kernel vnode and socket.
93 */
94struct fileproc {
95 unsigned int f_flags;
96 int32_t f_iocount;
97 struct fileglob * f_fglob;
98 void *f_wset;
99};
100
101#define FILEPROC_NULL (struct fileproc *)0
102
103#define FP_INCREATE 0x0001
104#define FP_INCLOSE 0x0002
105#define FP_INSELECT 0x0004
106#define FP_UNUSED 0x0008 /* unused (was FP_INCHRREAD) */
107#define FP_WRITTEN 0x0010
108#define FP_CLOSING 0x0020
109#define FP_WAITCLOSE 0x0040
110#define FP_AIOISSUED 0x0080
111#define FP_WAITEVENT 0x0100
112#define FP_SELCONFLICT 0x0200 /* select conflict on an individual fp */
113
114/* squeeze a "type" value into the upper flag bits */
115
116#define _FP_TYPESHIFT 24
117#define FP_TYPEMASK (0x7 << _FP_TYPESHIFT) /* 8 "types" of fileproc */
118
119#define FILEPROC_TYPE(fp) ((fp)->f_flags & FP_TYPEMASK)
120
121#define FP_ISGUARDED(fp, attribs) \
122 ((FILEPROC_TYPE(fp) == FTYPE_GUARDED) ? fp_isguarded(fp, attribs) : 0)
123
124typedef enum {
125 FTYPE_SIMPLE = 0,
126 FTYPE_GUARDED = (1 << _FP_TYPESHIFT)
127} fileproc_type_t;
128
129#define FP_VALID_FLAGS (FP_INCREATE | FP_INCLOSE | FP_INSELECT |\
130 FP_WRITTEN | FP_CLOSING | FP_WAITCLOSE |\
131 FP_AIOISSUED | FP_WAITEVENT | FP_SELCONFLICT | _FP_TYPEMASK)
132
133#ifndef _KAUTH_CRED_T
134#define _KAUTH_CRED_T
135struct ucred;
136typedef struct ucred *kauth_cred_t;
137struct posix_cred;
138typedef struct posix_cred *posix_cred_t;
139#endif /* !_KAUTH_CRED_T */
140
141/* file types */
142typedef enum {
143 DTYPE_VNODE = 1, /* file */
144 DTYPE_SOCKET, /* communications endpoint */
145 DTYPE_PSXSHM, /* POSIX Shared memory */
146 DTYPE_PSXSEM, /* POSIX Semaphores */
147 DTYPE_KQUEUE, /* kqueue */
148 DTYPE_PIPE, /* pipe */
149 DTYPE_FSEVENTS, /* fsevents */
150 DTYPE_ATALK, /* (obsolete) */
151 DTYPE_NETPOLICY, /* networking policy */
152} file_type_t;
153
154/* defines for fg_lflags */
155#define FG_TERM 0x01 /* the fileglob is terminating .. */
156#define FG_INSMSGQ 0x02 /* insert to msgqueue pending .. */
157#define FG_WINSMSGQ 0x04 /* wait for the fielglob is in msgque */
158#define FG_RMMSGQ 0x08 /* the fileglob is being removed from msgqueue */
159#define FG_WRMMSGQ 0x10 /* wait for the fileglob to be removed from msgqueue */
160#define FG_PORTMADE 0x20 /* a port was at some point created for this fileglob */
161#define FG_NOSIGPIPE 0x40 /* don't deliver SIGPIPE with EPIPE return */
162#define FG_OFF_LOCKED 0x80 /* Used as a mutex for offset changes (for vnodes) */
163#define FG_OFF_LOCKWANT 0x100 /* Somebody's wating for the lock */
164#define FG_CONFINED 0x200 /* fileglob confined to process, immutably */
165#define FG_HAS_OFDLOCK 0x400 /* Has or has had an OFD lock */
166
167struct fileglob {
168 LIST_ENTRY(fileglob) f_msglist;/* list of active files */
169 int32_t fg_flag; /* see fcntl.h */
170 int32_t fg_count; /* reference count */
171 int32_t fg_msgcount; /* references from message queue */
172 int32_t fg_lflags; /* file global flags */
173 kauth_cred_t fg_cred; /* credentials associated with descriptor */
174 const struct fileops {
175 file_type_t fo_type; /* descriptor type */
176 int (*fo_read) (struct fileproc *fp, struct uio *uio,
177 int flags, vfs_context_t ctx);
178 int (*fo_write) (struct fileproc *fp, struct uio *uio,
179 int flags, vfs_context_t ctx);
180#define FOF_OFFSET 0x00000001 /* offset supplied to vn_write */
181#define FOF_PCRED 0x00000002 /* cred from proc, not current thread */
182 int (*fo_ioctl) (struct fileproc *fp, u_long com,
183 caddr_t data, vfs_context_t ctx);
184 int (*fo_select) (struct fileproc *fp, int which,
185 void *wql, vfs_context_t ctx);
186 int (*fo_close) (struct fileglob *fg, vfs_context_t ctx);
187 int (*fo_kqfilter) (struct fileproc *fp, struct knote *kn,
188 struct kevent_internal_s *kev, vfs_context_t ctx);
189 int (*fo_drain) (struct fileproc *fp, vfs_context_t ctx);
190 } *fg_ops;
191 off_t fg_offset;
192 void *fg_data; /* vnode or socket or SHM or semaphore */
193 void *fg_vn_data; /* Per fd vnode data, used for directories */
194 lck_mtx_t fg_lock;
195#if CONFIG_MACF
196 struct label *fg_label; /* JMM - use the one in the cred? */
197#endif
198};
199
200#ifdef __APPLE_API_PRIVATE
201LIST_HEAD(fmsglist, fileglob);
202extern struct fmsglist fmsghead; /* head of list of open files */
203extern int maxfiles; /* kernel limit on number of open files */
204extern int nfiles; /* actual number of open files */
205extern int maxfilesperproc;
206
207#define FILEGLOB_DTYPE(fg) ((const file_type_t)((fg)->fg_ops->fo_type))
208#endif /* __APPLE_API_PRIVATE */
209
210
211__BEGIN_DECLS
212int fo_read(struct fileproc *fp, struct uio *uio, int flags, vfs_context_t ctx);
213int fo_write(struct fileproc *fp, struct uio *uio, int flags,
214 vfs_context_t ctx);
215int fo_ioctl(struct fileproc *fp, u_long com, caddr_t data, vfs_context_t ctx);
216int fo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx);
217int fo_close(struct fileglob *fg, vfs_context_t ctx);
218int fo_kqfilter(struct fileproc *fp, struct knote *kn,
219 struct kevent_internal_s *kev, vfs_context_t ctx);
220void fileproc_drain(proc_t, struct fileproc *);
221int fp_tryswap(proc_t, int fd, struct fileproc *nfp);
222int fp_drop(struct proc *p, int fd, struct fileproc *fp, int locked);
223int fp_drop_written(proc_t p, int fd, struct fileproc *fp);
224int fp_drop_event(proc_t p, int fd, struct fileproc *fp);
225int fp_free(struct proc * p, int fd, struct fileproc * fp);
226struct kqueue;
227int fp_getfkq(struct proc *p, int fd, struct fileproc **resultfp, struct kqueue **resultkq);
228struct psemnode;
229int fp_getfpsem(struct proc *p, int fd, struct fileproc **resultfp, struct psemnode **resultpsem);
230struct pshmnode;
231int fp_getfpshm(struct proc *p, int fd, struct fileproc **resultfp, struct pshmnode **resultpshm);
232struct pipe;
233int fp_getfpipe(struct proc *p, int fd, struct fileproc **resultfp, struct pipe **resultpipe);
234struct atalk;
235int fp_getfatalk(struct proc *p, int fd, struct fileproc **resultfp, struct atalk **resultatalk);
236struct vnode;
237int fp_getfvpandvid(struct proc *p, int fd, struct fileproc **resultfp, struct vnode **resultvp, uint32_t * vidp);
238struct socket;
239int fp_getfsock(struct proc *p, int fd, struct fileproc **resultfp, struct socket **results);
240int fp_lookup(struct proc *p, int fd, struct fileproc **resultfp, int locked);
241int fp_isguarded(struct fileproc *fp, u_int attribs);
242int fp_guard_exception(proc_t p, int fd, struct fileproc *fp, u_int attribs);
243int closef_locked(struct fileproc *fp, struct fileglob *fg, struct proc *p);
244int close_internal_locked(proc_t p, int fd, struct fileproc *fp, int flags);
245struct nameidata;
246struct vnode_attr;
247int open1(vfs_context_t ctx, struct nameidata *ndp, int uflags,
248 struct vnode_attr *vap, fp_allocfn_t fp_zalloc, void *cra,
249 int32_t *retval);
250int kqueue_body(struct proc *p, fp_allocfn_t, void *cra, int32_t *retval);
251void fg_insertuipc(struct fileglob * fg);
252boolean_t fg_insertuipc_mark(struct fileglob * fg);
253void fg_removeuipc(struct fileglob * fg);
254boolean_t fg_removeuipc_mark(struct fileglob * fg);
255void unp_gc_wait(void);
256void procfdtbl_reservefd(struct proc * p, int fd);
257void procfdtbl_markclosefd(struct proc * p, int fd);
258void procfdtbl_releasefd(struct proc * p, int fd, struct fileproc * fp);
259void procfdtbl_waitfd(struct proc * p, int fd);
260void procfdtbl_clearfd(struct proc * p, int fd);
261boolean_t file_issendable(struct proc * p, struct fileproc *fp);
262extern int fdgetf_noref(proc_t, int, struct fileproc **);
263extern struct fileproc *fileproc_alloc_init(void *crargs);
264extern void fileproc_free(struct fileproc *fp);
265extern void guarded_fileproc_free(struct fileproc *fp);
266extern void fg_vn_data_free(void *fgvndata);
267extern int nameiat(struct nameidata *ndp, int dirfd);
268extern int falloc_guarded(struct proc *p, struct fileproc **fp, int *fd,
269 vfs_context_t ctx, const guardid_t *guard, u_int attrs);
270__END_DECLS
271
272#endif /* __APPLE_API_UNSTABLE */
273
274#endif /* KERNEL */
275
276#endif /* !_SYS_FILE_INTERNAL_H_ */
277