FreeBSD/Linux Kernel Cross Reference
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 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)filedesc.h 8.1 (Berkeley) 6/2/93
30 * $FreeBSD: releng/6.3/sys/sys/filedesc.h 173886 2007-11-24 19:45:58Z cvs2svn $
31 */
32
33 #ifndef _SYS_FILEDESC_H_
34 #define _SYS_FILEDESC_H_
35
36 #include <sys/queue.h>
37 #include <sys/event.h>
38 #include <sys/priority.h>
39 #include <sys/_lock.h>
40 #include <sys/_mutex.h>
41
42 #include <machine/_limits.h>
43
44 /*
45 * This structure is used for the management of descriptors. It may be
46 * shared by multiple processes.
47 */
48 #define NDSLOTTYPE u_long
49
50 struct filedesc {
51 struct file **fd_ofiles; /* file structures for open files */
52 char *fd_ofileflags; /* per-process open file flags */
53 struct vnode *fd_cdir; /* current directory */
54 struct vnode *fd_rdir; /* root directory */
55 struct vnode *fd_jdir; /* jail root directory */
56 int fd_nfiles; /* number of open files allocated */
57 NDSLOTTYPE *fd_map; /* bitmap of free fds */
58 int fd_lastfile; /* high-water mark of fd_ofiles */
59 int fd_freefile; /* approx. next free file */
60 u_short fd_cmask; /* mask for file creation */
61 u_short fd_refcnt; /* thread reference count */
62 u_short fd_holdcnt; /* hold count on structure + mutex */
63
64 struct mtx fd_mtx; /* protects members of this struct */
65 int fd_locked; /* long lock flag */
66 int fd_wanted; /* "" */
67 struct kqlist fd_kqlist; /* list of kqueues on this filedesc */
68 int fd_holdleaderscount; /* block fdfree() for shared close() */
69 int fd_holdleaderswakeup; /* fdfree() needs wakeup */
70 };
71
72 /*
73 * Structure to keep track of (process leader, struct fildedesc) tuples.
74 * Each process has a pointer to such a structure when detailed tracking
75 * is needed, e.g., when rfork(RFPROC | RFMEM) causes a file descriptor
76 * table to be shared by processes having different "p_leader" pointers
77 * and thus distinct POSIX style locks.
78 *
79 * fdl_refcount and fdl_holdcount are protected by struct filedesc mtx.
80 */
81 struct filedesc_to_leader {
82 int fdl_refcount; /* references from struct proc */
83 int fdl_holdcount; /* temporary hold during closef */
84 int fdl_wakeup; /* fdfree() waits on closef() */
85 struct proc *fdl_leader; /* owner of POSIX locks */
86 /* Circular list: */
87 struct filedesc_to_leader *fdl_prev;
88 struct filedesc_to_leader *fdl_next;
89 };
90
91 /*
92 * Per-process open flags.
93 */
94 #define UF_EXCLOSE 0x01 /* auto-close on exec */
95 #define UF_OPENING 0x02 /* file is being opened */
96
97 #ifdef _KERNEL
98
99 /* Lock a file descriptor table. */
100 #define FILEDESC_LOCK(fd) \
101 do { \
102 mtx_lock(&(fd)->fd_mtx); \
103 (fd)->fd_wanted++; \
104 while ((fd)->fd_locked) \
105 msleep(&(fd)->fd_locked, &(fd)->fd_mtx, PLOCK, "fdesc", 0); \
106 (fd)->fd_locked = 2; \
107 (fd)->fd_wanted--; \
108 mtx_unlock(&(fd)->fd_mtx); \
109 } while (0)
110
111 #define FILEDESC_UNLOCK(fd) \
112 do { \
113 mtx_lock(&(fd)->fd_mtx); \
114 KASSERT((fd)->fd_locked == 2, \
115 ("fdesc locking mistake %d should be %d", (fd)->fd_locked, 2)); \
116 (fd)->fd_locked = 0; \
117 if ((fd)->fd_wanted) \
118 wakeup(&(fd)->fd_locked); \
119 mtx_unlock(&(fd)->fd_mtx); \
120 } while (0)
121
122 #define FILEDESC_LOCK_FAST(fd) \
123 do { \
124 mtx_lock(&(fd)->fd_mtx); \
125 (fd)->fd_wanted++; \
126 while ((fd)->fd_locked) \
127 msleep(&(fd)->fd_locked, &(fd)->fd_mtx, PLOCK, "fdesc", 0); \
128 (fd)->fd_locked = 1; \
129 (fd)->fd_wanted--; \
130 } while (0)
131
132 #define FILEDESC_UNLOCK_FAST(fd) \
133 do { \
134 KASSERT((fd)->fd_locked == 1, \
135 ("fdesc locking mistake %d should be %d", (fd)->fd_locked, 1)); \
136 (fd)->fd_locked = 0; \
137 if ((fd)->fd_wanted) \
138 wakeup(&(fd)->fd_locked); \
139 mtx_unlock(&(fd)->fd_mtx); \
140 } while (0)
141
142 #ifdef INVARIANT_SUPPORT
143 #define FILEDESC_LOCK_ASSERT(fd, arg) \
144 do { \
145 if ((arg) == MA_OWNED) \
146 KASSERT((fd)->fd_locked != 0, ("fdesc locking mistake")); \
147 else \
148 KASSERT((fd)->fd_locked == 0, ("fdesc locking mistake")); \
149 } while (0)
150 #else
151 #define FILEDESC_LOCK_ASSERT(fd, arg)
152 #endif
153
154 #define FILEDESC_LOCK_DESC "filedesc structure"
155
156 struct thread;
157
158 int closef(struct file *fp, struct thread *td);
159 int dupfdopen(struct thread *td, struct filedesc *fdp, int indx, int dfd,
160 int mode, int error);
161 int falloc(struct thread *td, struct file **resultfp, int *resultfd);
162 int fdalloc(struct thread *td, int minfd, int *result);
163 int fdavail(struct thread *td, int n);
164 int fdcheckstd(struct thread *td);
165 void fdclose(struct filedesc *fdp, struct file *fp, int idx, struct thread *td);
166 void fdcloseexec(struct thread *td);
167 struct filedesc *fdcopy(struct filedesc *fdp);
168 void fdunshare(struct proc *p, struct thread *td);
169 void fdfree(struct thread *td);
170 struct filedesc *fdinit(struct filedesc *fdp);
171 struct filedesc *fdshare(struct filedesc *fdp);
172 struct filedesc_to_leader *
173 filedesc_to_leader_alloc(struct filedesc_to_leader *old,
174 struct filedesc *fdp, struct proc *leader);
175 int getvnode(struct filedesc *fdp, int fd, struct file **fpp);
176 void mountcheckdirs(struct vnode *olddp, struct vnode *newdp);
177 void setugidsafety(struct thread *td);
178
179 static __inline struct file *
180 fget_locked(struct filedesc *fdp, int fd)
181 {
182
183 return (fd < 0 || fd >= fdp->fd_nfiles ? NULL : fdp->fd_ofiles[fd]);
184 }
185
186 #endif /* _KERNEL */
187
188 #endif /* !_SYS_FILEDESC_H_ */
Cache object: c23fd6c4250cc788f61f0ad9cdb574ae
|