9b422db8c7f291efe5022fcc7e85cbb0a4d223db
[dragonfly.git] / sys / sys / filedesc.h
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 $
35  * $DragonFly: src/sys/sys/filedesc.h,v 1.10 2005/06/21 23:58:53 hsu Exp $
36  */
37
38 #ifndef _SYS_FILEDESC_H_
39 #define _SYS_FILEDESC_H_
40
41 #include <sys/queue.h>
42
43 /*
44  * This structure is used for the management of descriptors.  It may be
45  * shared by multiple processes.
46  *
47  * A process is initially started out with NDFILE descriptors stored within
48  * this structure, selected to be enough for typical applications based on
49  * the historical limit of 20 open files (and the usage of descriptors by
50  * shells) and the constraint of being one less than a power of 2.
51  * If these descriptors are exhausted, a larger descriptor table
52  * may be allocated, up to a process' resource limit; the internal arrays
53  * are then unused.  Each time the file table runs out, it is doubled until
54  * the resource limit is reached.
55  */
56 #define NDFILE          15              /* must be of the form 2^n - 1 */
57
58 struct klist;
59 struct namecache;
60
61 struct filedesc {
62         struct  file **fd_ofiles;       /* file structures for open files */
63         char    *fd_ofileflags;         /* per-process open file flags */
64         int     *fd_oallocated;         /* subtree allocation count */
65         struct  vnode *fd_cdir;         /* current directory (phaseout) */
66         struct  vnode *fd_rdir;         /* root directory (phaseout) */
67         struct  vnode *fd_jdir;         /* jail root directory (phaseout) */
68         struct  namecache *fd_ncdir;    /* current directory */
69         struct  namecache *fd_nrdir;    /* root directory */
70         struct  namecache *fd_njdir;    /* jail directory */
71         int     fd_nfiles;              /* number of open files allocated */
72         int     fd_lastfile;            /* high-water mark of fd_ofiles */
73         int     fd_freefile;            /* approx. next free file */
74         int     fd_cmask;               /* mask for file creation */
75         int     fd_refcnt;              /* reference count */
76
77         int     fd_knlistsize;          /* size of knlist */
78         struct  klist *fd_knlist;       /* list of attached knotes */
79         u_long  fd_knhashmask;          /* size of knhash */
80         struct  klist *fd_knhash;       /* hash table for attached knotes */
81         int     fd_holdleaderscount;    /* block fdfree() for shared close() */
82         int     fd_holdleaderswakeup;   /* fdfree() needs wakeup */
83 };
84
85 /*
86  * Basic allocation of descriptors:
87  * one of the above, plus arrays for NDFILE descriptors.
88  */
89 struct filedesc0 {
90         struct  filedesc fd_fd;
91         /*
92          * These arrays are used when the number of open files is
93          * <= NDFILE, and are then pointed to by the pointers above.
94          */
95         struct  file *fd_dfiles[NDFILE];
96         char    fd_dfileflags[NDFILE];
97         int     fd_dallocated[NDFILE];
98 };
99
100
101
102 /*
103  * Structure to keep track of (process leader, struct fildedesc) tuples.
104  * Each process has a pointer to such a structure when detailed tracking
105  * is needed. e.g. when rfork(RFPROC | RFMEM) causes a file descriptor
106  * table to be shared by processes having different "p_leader" pointers
107  * and thus distinct POSIX style locks.
108  */
109 struct filedesc_to_leader {
110         int             fdl_refcount;   /* references from struct proc */
111         int             fdl_holdcount;  /* temporary hold during closef */
112         int             fdl_wakeup;     /* fdfree() waits on closef() */
113         struct proc     *fdl_leader;    /* owner of POSIX locks */
114         /* Circular list */
115         struct filedesc_to_leader *fdl_prev;
116         struct filedesc_to_leader *fdl_next;
117 };
118
119 /*
120  * Per-process open flags.
121  */
122 #define UF_EXCLOSE      0x01            /* auto-close on exec */
123 #if 0
124 #define UF_MAPPED       0x02            /* mapped from device */
125 #endif
126
127 /*
128  * Storage required per open file descriptor.
129  */
130 #define OFILESIZE (sizeof(struct file *) + sizeof(char) + sizeof(int))
131
132 /*
133  * This structure that holds the information needed to send a SIGIO or
134  * a SIGURG signal to a process or process group when new data arrives
135  * on a device or socket.  The structure is placed on an SLIST belonging
136  * to the proc or pgrp so that the entire list may be revoked when the
137  * process exits or the process group disappears.
138  */
139 struct  sigio {
140         union {
141                 struct  proc *siu_proc; /* process to receive SIGIO/SIGURG */
142                 struct  pgrp *siu_pgrp; /* process group to receive ... */
143         } sio_u;
144         SLIST_ENTRY(sigio) sio_pgsigio; /* sigio's for process or group */
145         struct  sigio **sio_myref;      /* location of the pointer that holds
146                                          * the reference to this structure */
147         struct  ucred *sio_ucred;       /* current credentials */
148         uid_t   sio_ruid;               /* real user id */
149         pid_t   sio_pgid;               /* pgid for signals */
150 };
151 #define sio_proc        sio_u.siu_proc
152 #define sio_pgrp        sio_u.siu_pgrp
153
154 SLIST_HEAD(sigiolst, sigio);
155
156 #ifdef _KERNEL
157
158 struct thread;
159 struct proc;
160
161 /*
162  * Kernel global variables and routines.
163  */
164 int     dupfdopen (struct filedesc *, int, int, int, int);
165 int     fdalloc (struct proc *p, int want, int *result);
166 int     fdavail (struct proc *p, int n);
167 void    fdreserve (struct filedesc *fdp, int fd0, int incr);
168 int     falloc (struct proc *p, struct file **resultfp, int *resultfd);
169 int     fsetfd (struct proc *p, struct file *fp, int *resultfd);
170 void    funsetfd (struct filedesc *fdp, int fd);
171 void    fsetcred (struct file *fp, struct ucred *cr);
172 void    ffree (struct file *);
173 struct  filedesc *fdinit (struct proc *p);
174 struct  filedesc *fdshare (struct proc *p);
175 struct  filedesc *fdcopy (struct proc *p);
176 void    fdfree (struct proc *p);
177 int     closef (struct file *fp, struct thread *td);
178 void    fdcloseexec (struct proc *p);
179 int     fdcheckstd (struct proc *p);
180 struct  file *holdfp (struct filedesc *fdp, int fd, int flag);
181 int     getvnode (struct filedesc *fdp, int fd, struct file **fpp);
182 int     fdissequential (struct file *);
183 void    fdsequential (struct file *, int);
184 pid_t   fgetown (struct sigio *);
185 int     fsetown (pid_t, struct sigio **);
186 void    funsetown (struct sigio *);
187 void    funsetownlst (struct sigiolst *);
188 void    setugidsafety (struct proc *p);
189
190 struct filedesc_to_leader *
191 filedesc_to_leader_alloc(struct filedesc_to_leader *old,
192                          struct proc *leader);
193
194 #endif
195
196 #endif