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