Major namecache work primarily to support NULLFS.
[dragonfly.git] / sys / sys / filedesc.h
CommitLineData
984263bc
MD
1/*
2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)filedesc.h 8.1 (Berkeley) 6/2/93
34 * $FreeBSD: src/sys/sys/filedesc.h,v 1.19.2.5 2003/06/06 20:21:32 tegge Exp $
28623bf9 35 * $DragonFly: src/sys/sys/filedesc.h,v 1.20 2006/10/27 04:56:33 dillon Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_FILEDESC_H_
39#define _SYS_FILEDESC_H_
40
1bd40720
MD
41#ifndef _SYS_TYPES_H_
42#include <sys/types.h>
43#endif
1bd40720 44#ifndef _SYS_QUEUE_H_
984263bc 45#include <sys/queue.h>
1bd40720 46#endif
85fceac1
MD
47#ifndef _SYS_SPINLOCK_H_
48#include <sys/spinlock.h>
49#endif
28623bf9
MD
50#ifndef _SYS_NAMECACHE_H_
51#include <sys/namecache.h>
52#endif
984263bc
MD
53
54/*
55 * This structure is used for the management of descriptors. It may be
56 * shared by multiple processes.
57 *
58 * A process is initially started out with NDFILE descriptors stored within
59 * this structure, selected to be enough for typical applications based on
60 * the historical limit of 20 open files (and the usage of descriptors by
69908319
JH
61 * shells) and the constraint of being one less than a power of 2.
62 * If these descriptors are exhausted, a larger descriptor table
984263bc 63 * may be allocated, up to a process' resource limit; the internal arrays
69908319
JH
64 * are then unused. Each time the file table runs out, it is doubled until
65 * the resource limit is reached.
984263bc 66 */
69908319 67#define NDFILE 15 /* must be of the form 2^n - 1 */
984263bc 68
0679adc4 69struct file;
984263bc
MD
70struct klist;
71
0679adc4
MD
72struct fdnode {
73 struct file *fp;
74 char fileflags;
75 char unused01;
76 char unused02;
259b8ea0
MD
77 char reserved; /* descriptor has been reserved */
78 int allocated; /* subtree allocation count */
0679adc4
MD
79};
80
984263bc 81struct filedesc {
0679adc4 82 struct fdnode *fd_files; /* file structures for open files */
bc0c094e
MD
83 struct vnode *fd_cdir; /* current directory (phaseout) */
84 struct vnode *fd_rdir; /* root directory (phaseout) */
85 struct vnode *fd_jdir; /* jail root directory (phaseout) */
28623bf9
MD
86 struct nchandle fd_ncdir; /* current directory */
87 struct nchandle fd_nrdir; /* root directory */
88 struct nchandle fd_njdir; /* jail directory */
984263bc 89 int fd_nfiles; /* number of open files allocated */
0679adc4 90 int fd_lastfile; /* high-water mark of fd_files */
a8530c06
MD
91 int fd_freefile; /* approx. next free file */
92 int fd_cmask; /* mask for file creation */
93 int fd_refcnt; /* reference count */
984263bc
MD
94
95 int fd_knlistsize; /* size of knlist */
96 struct klist *fd_knlist; /* list of attached knotes */
97 u_long fd_knhashmask; /* size of knhash */
98 struct klist *fd_knhash; /* hash table for attached knotes */
99 int fd_holdleaderscount; /* block fdfree() for shared close() */
100 int fd_holdleaderswakeup; /* fdfree() needs wakeup */
85fceac1 101 struct spinlock fd_spin;
0679adc4 102 struct fdnode fd_builtin_files[NDFILE];
984263bc
MD
103};
104
984263bc
MD
105/*
106 * Structure to keep track of (process leader, struct fildedesc) tuples.
107 * Each process has a pointer to such a structure when detailed tracking
108 * is needed. e.g. when rfork(RFPROC | RFMEM) causes a file descriptor
109 * table to be shared by processes having different "p_leader" pointers
110 * and thus distinct POSIX style locks.
111 */
112struct filedesc_to_leader {
113 int fdl_refcount; /* references from struct proc */
114 int fdl_holdcount; /* temporary hold during closef */
115 int fdl_wakeup; /* fdfree() waits on closef() */
116 struct proc *fdl_leader; /* owner of POSIX locks */
117 /* Circular list */
118 struct filedesc_to_leader *fdl_prev;
119 struct filedesc_to_leader *fdl_next;
120};
121
122/*
123 * Per-process open flags.
124 */
125#define UF_EXCLOSE 0x01 /* auto-close on exec */
984263bc 126
984263bc
MD
127/*
128 * This structure that holds the information needed to send a SIGIO or
129 * a SIGURG signal to a process or process group when new data arrives
130 * on a device or socket. The structure is placed on an SLIST belonging
131 * to the proc or pgrp so that the entire list may be revoked when the
132 * process exits or the process group disappears.
133 */
134struct sigio {
135 union {
136 struct proc *siu_proc; /* process to receive SIGIO/SIGURG */
137 struct pgrp *siu_pgrp; /* process group to receive ... */
138 } sio_u;
139 SLIST_ENTRY(sigio) sio_pgsigio; /* sigio's for process or group */
140 struct sigio **sio_myref; /* location of the pointer that holds
141 * the reference to this structure */
142 struct ucred *sio_ucred; /* current credentials */
143 uid_t sio_ruid; /* real user id */
144 pid_t sio_pgid; /* pgid for signals */
145};
146#define sio_proc sio_u.siu_proc
147#define sio_pgrp sio_u.siu_pgrp
148
149SLIST_HEAD(sigiolst, sigio);
150
151#ifdef _KERNEL
dadab5e9
MD
152
153struct thread;
154struct proc;
155
984263bc
MD
156/*
157 * Kernel global variables and routines.
158 */
259b8ea0 159int dupfdopen (struct proc *, int, int, int, int);
b153f746
RG
160int fdalloc (struct proc *p, int want, int *result);
161int fdavail (struct proc *p, int n);
162int falloc (struct proc *p, struct file **resultfp, int *resultfd);
259b8ea0 163void fsetfd (struct proc *p, struct file *fp, int fd);
85fceac1 164int fgetfdflags(struct filedesc *fdp, int fd, int *flagsp);
228b401d
MD
165int fsetfdflags(struct filedesc *fdp, int fd, int add_flags);
166int fclrfdflags(struct filedesc *fdp, int fd, int rem_flags);
fad57d0e 167void fsetcred (struct file *fp, struct ucred *cr);
228b401d 168void fdinit_bootstrap(struct proc *p0, struct filedesc *fdp0, int cmask);
b153f746
RG
169struct filedesc *fdinit (struct proc *p);
170struct filedesc *fdshare (struct proc *p);
171struct filedesc *fdcopy (struct proc *p);
172void fdfree (struct proc *p);
173int closef (struct file *fp, struct thread *td);
174void fdcloseexec (struct proc *p);
175int fdcheckstd (struct proc *p);
176struct file *holdfp (struct filedesc *fdp, int fd, int flag);
fa541be6 177int holdsock (struct filedesc *fdp, int fdes, struct file **fpp);
5b287bba 178int holdvnode (struct filedesc *fdp, int fd, struct file **fpp);
b153f746
RG
179int fdissequential (struct file *);
180void fdsequential (struct file *, int);
181pid_t fgetown (struct sigio *);
182int fsetown (pid_t, struct sigio **);
183void funsetown (struct sigio *);
184void funsetownlst (struct sigiolst *);
185void setugidsafety (struct proc *p);
2dd63755 186void allfiles_scan_exclusive(int (*callback)(struct file *, void *), void *data);
984263bc
MD
187
188struct filedesc_to_leader *
189filedesc_to_leader_alloc(struct filedesc_to_leader *old,
190 struct proc *leader);
191
192#endif
193
194#endif