cnode.h revision 1.5.6.1 1 /* $NetBSD: cnode.h,v 1.5.6.1 1999/08/02 21:50:08 thorpej Exp $ */
2
3 /*
4 *
5 * Coda: an Experimental Distributed File System
6 * Release 3.1
7 *
8 * Copyright (c) 1987-1998 Carnegie Mellon University
9 * All Rights Reserved
10 *
11 * Permission to use, copy, modify and distribute this software and its
12 * documentation is hereby granted, provided that both the copyright
13 * notice and this permission notice appear in all copies of the
14 * software, derivative works or modified versions, and any portions
15 * thereof, and that both notices appear in supporting documentation, and
16 * that credit is given to Carnegie Mellon University in all documents
17 * and publicity pertaining to direct or indirect use of this code or its
18 * derivatives.
19 *
20 * CODA IS AN EXPERIMENTAL SOFTWARE SYSTEM AND IS KNOWN TO HAVE BUGS,
21 * SOME OF WHICH MAY HAVE SERIOUS CONSEQUENCES. CARNEGIE MELLON ALLOWS
22 * FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION. CARNEGIE MELLON
23 * DISCLAIMS ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER
24 * RESULTING DIRECTLY OR INDIRECTLY FROM THE USE OF THIS SOFTWARE OR OF
25 * ANY DERIVATIVE WORK.
26 *
27 * Carnegie Mellon encourages users of this software to return any
28 * improvements or extensions that they make, and to grant Carnegie
29 * Mellon the rights to redistribute these changes without encumbrance.
30 *
31 * @(#) coda/cnode.h,v 1.1.1.1 1998/08/29 21:26:46 rvb Exp $
32 */
33
34 /*
35 * Mach Operating System
36 * Copyright (c) 1990 Carnegie-Mellon University
37 * Copyright (c) 1989 Carnegie-Mellon University
38 * All rights reserved. The CMU software License Agreement specifies
39 * the terms and conditions for use and redistribution.
40 */
41
42 /*
43 * This code was written for the Coda file system at Carnegie Mellon University.
44 * Contributers include David Steere, James Kistler, and M. Satyanarayanan.
45 */
46
47 /*
48 * HISTORY
49 * $Log: cnode.h,v $
50 * Revision 1.5.6.1 1999/08/02 21:50:08 thorpej
51 * Update from trunk.
52 *
53 * Revision 1.6 1999/07/08 01:26:23 wrstuden
54 * Bump osrelease to 1.4E. Add layerfs files, remove null_subr.c.
55 *
56 * Update coda to new struct lock in struct vnode.
57 *
58 * make fdescfs, kernfs, portalfs, and procfs actually lock their vnodes.
59 * It's not that hard.
60 *
61 * Make unionfs set v_vnlock = NULL so any overlayed fs will call its
62 * VOP_LOCK.
63 *
64 * Revision 1.5 1998/11/11 19:22:08 rvb
65 * Lookup now passes up an extra flag. But old veni will
66 * be ok; new veni will check /dev/cfs0 to make sure that a new
67 * kernel is running.
68 * Also, a bug in vc_nb_close iff CODA_SIGNAL's were seen has been
69 * fixed.
70 *
71 * Revision 1.4 1998/09/15 02:02:58 rvb
72 * Final piece of rename cfs->coda
73 *
74 * Revision 1.3 1998/09/12 15:05:50 rvb
75 * Change cfs/CFS in symbols, strings and constants to coda/CODA
76 * to avoid fs conflicts.
77 *
78 * Revision 1.2 1998/09/08 17:12:49 rvb
79 * Pass2 complete
80 *
81 * Revision 1.1.1.1 1998/08/29 21:26:46 rvb
82 * Very Preliminary Coda
83 *
84 * Revision 1.10 1998/08/28 18:12:25 rvb
85 * Now it also works on FreeBSD -current. This code will be
86 * committed to the FreeBSD -current and NetBSD -current
87 * trees. It will then be tailored to the particular platform
88 * by flushing conditional code.
89 *
90 * Revision 1.9 1998/08/18 17:05:24 rvb
91 * Don't use __RCSID now
92 *
93 * Revision 1.8 1998/08/18 16:31:49 rvb
94 * Sync the code for NetBSD -current; test on 1.3 later
95 *
96 * Revision 1.7 98/02/24 22:22:53 rvb
97 * Fixes up mainly to flush iopen and friends
98 *
99 * Revision 1.6 98/01/31 20:53:19 rvb
100 * First version that works on FreeBSD 2.2.5
101 *
102 * Revision 1.5 98/01/23 11:53:51 rvb
103 * Bring RVB_CODA1_1 to HEAD
104 *
105 * Revision 1.4.2.5 98/01/23 11:21:14 rvb
106 * Sync with 2.2.5
107 *
108 * Revision 1.4.2.4 98/01/22 13:03:38 rvb
109 * Had Breaken ls .
110 *
111 * Revision 1.4.2.3 97/12/19 14:26:09 rvb
112 * session id
113 *
114 * Revision 1.4.2.2 97/12/16 12:40:24 rvb
115 * Sync with 1.3
116 *
117 * Revision 1.4.2.1 97/12/06 17:41:28 rvb
118 * Sync with peters coda.h
119 *
120 * Revision 1.4 97/12/05 10:39:30 rvb
121 * Read CHANGES
122 *
123 * Revision 1.3.18.2 97/11/12 12:09:45 rvb
124 * reorg pass1
125 *
126 * Revision 1.3.18.1 97/10/29 16:06:31 rvb
127 * Kill DYING
128 *
129 * Revision 1.3 1996/12/12 22:11:03 bnoble
130 * Fixed the "downcall invokes venus operation" deadlock in all known cases.
131 * There may be more.
132 *
133 * Revision 1.2 1996/01/02 16:57:26 bnoble
134 * Added support for Coda MiniCache and raw inode calls (final commit)
135 *
136 * Revision 1.1.2.1 1995/12/20 01:57:53 bnoble
137 * Added CODA-specific files
138 *
139 * Revision 3.1.1.1 1995/03/04 19:08:23 bnoble
140 * Branch for NetBSD port revisions
141 *
142 * Revision 3.1 1995/03/04 19:08:23 bnoble
143 * Bump to major revision 3 to prepare for NetBSD port
144 *
145 * Revision 2.2 1994/12/06 13:39:18 dcs
146 * Add a flag value to indicate a cnode was orphaned, e.g. the venus
147 * that created it has exited. This will allow one to restart venus
148 * even though some process may be cd'd into /coda.
149 *
150 * Revision 2.1 94/07/21 16:25:33 satya
151 * Conversion to C++ 3.0; start of Coda Release 2.0
152 *
153 * Revision 1.2.7.1 94/06/16 11:26:02 raiff
154 * Branch for release beta-16Jun1994_39118
155 *
156 * Revision 1.2 92/10/27 17:58:41 lily
157 * merge kernel/latest and alpha/src/cfs
158 *
159 * Revision 2.3 92/09/30 14:16:53 mja
160 * Picked up fixed #ifdef _KERNEL. Also...
161 *
162 * Substituted rvb's history blurb so that we agree with Mach 2.5 sources.
163 * [91/02/09 jjk]
164 *
165 * Added contributors blurb.
166 * [90/12/13 jjk]
167 *
168 * Revision 2.2 90/07/05 11:27:24 mrt
169 * Created for the Coda File System.
170 * [90/05/23 dcs]
171 *
172 * Revision 1.4 90/05/31 17:02:16 dcs
173 * Prepare for merge with facilities kernel.
174 *
175 *
176 *
177 */
178
179 #ifndef _CNODE_H_
180 #define _CNODE_H_
181
182 #include <sys/vnode.h>
183
184 /*
185 * tmp below since we need struct queue
186 */
187 #include <coda/coda_kernel.h>
188
189 /*
190 * Cnode lookup stuff.
191 * NOTE: CODA_CACHESIZE must be a power of 2 for cfshash to work!
192 */
193 #define CODA_CACHESIZE 512
194
195 #define CODA_ALLOC(ptr, cast, size) \
196 do { \
197 ptr = (cast)malloc((unsigned long) size, M_CODA, M_WAITOK); \
198 if (ptr == 0) { \
199 panic("kernel malloc returns 0 at %s:%d\n", __FILE__, __LINE__); \
200 } \
201 } while (0)
202
203 #define CODA_FREE(ptr, size) free((ptr), M_CODA)
204
205 /*
206 * global cache state control
207 */
208 extern int coda_nc_use;
209
210 /*
211 * Used to select debugging statements throughout the cfs code.
212 */
213 extern int codadebug;
214 extern int coda_nc_debug;
215 extern int coda_printf_delay;
216 extern int coda_vnop_print_entry;
217 extern int coda_psdev_print_entry;
218 extern int coda_vfsop_print_entry;
219
220 #define CODADBGMSK(N) (1 << N)
221 #define CODADEBUG(N, STMT) { if (codadebug & CODADBGMSK(N)) { STMT } }
222 #define myprintf(args) \
223 do { \
224 if (coda_printf_delay) \
225 DELAY(coda_printf_delay);\
226 printf args ; \
227 } while (0)
228
229 struct cnode {
230 struct vnode *c_vnode;
231 u_short c_flags; /* flags (see below) */
232 ViceFid c_fid; /* file handle */
233 struct vnode *c_ovp; /* open vnode pointer */
234 u_short c_ocount; /* count of openers */
235 u_short c_owrite; /* count of open for write */
236 struct vattr c_vattr; /* attributes */
237 char *c_symlink; /* pointer to symbolic link */
238 u_short c_symlen; /* length of symbolic link */
239 dev_t c_device; /* associated vnode device */
240 ino_t c_inode; /* associated vnode inode */
241 struct cnode *c_next; /* links if on NetBSD machine */
242 };
243 #define VTOC(vp) ((struct cnode *)(vp)->v_data)
244 #define CTOV(cp) ((struct vnode *)((cp)->c_vnode))
245
246 /* flags */
247 #define C_VATTR 0x01 /* Validity of vattr in the cnode */
248 #define C_SYMLINK 0x02 /* Validity of symlink pointer in the Code */
249 #define C_WANTED 0x08 /* Set if lock wanted */
250 #define C_LOCKED 0x10 /* Set if lock held */
251 #define C_UNMOUNTING 0X20 /* Set if unmounting */
252 #define C_PURGING 0x40 /* Set if purging a fid */
253
254 #define VALID_VATTR(cp) ((cp->c_flags) & C_VATTR)
255 #define VALID_SYMLINK(cp) ((cp->c_flags) & C_SYMLINK)
256 #define IS_UNMOUNTING(cp) ((cp)->c_flags & C_UNMOUNTING)
257
258 struct vcomm {
259 u_long vc_seq;
260 struct selinfo vc_selproc;
261 struct queue vc_requests;
262 struct queue vc_replys;
263 };
264
265 #define VC_OPEN(vcp) ((vcp)->vc_requests.forw != NULL)
266 #define MARK_VC_CLOSED(vcp) (vcp)->vc_requests.forw = NULL;
267 #define MARK_VC_OPEN(vcp) /* MT */
268
269 struct coda_clstat {
270 int ncalls; /* client requests */
271 int nbadcalls; /* upcall failures */
272 int reqs[CODA_NCALLS]; /* count of each request */
273 };
274 extern struct coda_clstat coda_clstat;
275
276 /*
277 * CODA structure to hold mount/file system information
278 */
279 struct coda_mntinfo {
280 struct vnode *mi_rootvp;
281 struct mount *mi_vfsp;
282 struct vcomm mi_vcomm;
283 };
284 extern struct coda_mntinfo coda_mnttbl[]; /* indexed by minor device number */
285
286 /*
287 * vfs pointer to mount info
288 */
289 #define vftomi(vfsp) ((struct coda_mntinfo *)(vfsp->mnt_data))
290 #define CODA_MOUNTED(vfsp) (vftomi((vfsp)) != (struct coda_mntinfo *)0)
291
292 /*
293 * vnode pointer to mount info
294 */
295 #define vtomi(vp) ((struct coda_mntinfo *)(vp->v_mount->mnt_data))
296
297 /*
298 * Used for identifying usage of "Control" object
299 */
300 extern struct vnode *coda_ctlvp;
301 #define IS_CTL_VP(vp) ((vp) == coda_ctlvp)
302 #define IS_CTL_NAME(vp, name, l)((l == CODA_CONTROLLEN) \
303 && ((vp) == vtomi((vp))->mi_rootvp) \
304 && strncmp(name, CODA_CONTROL, l) == 0)
305
306 /*
307 * An enum to tell us whether something that will remove a reference
308 * to a cnode was a downcall or not
309 */
310 enum dc_status {
311 IS_DOWNCALL = 6,
312 NOT_DOWNCALL = 7
313 };
314
315 /* cfs_psdev.h */
316 extern int coda_call(struct coda_mntinfo *mntinfo, int inSize, int *outSize, caddr_t buffer);
317 extern int coda_kernel_version;
318
319 /* cfs_subr.h */
320 extern int handleDownCall(int opcode, union outputArgs *out);
321 extern void coda_unmounting(struct mount *whoIam);
322 extern int coda_vmflush(struct cnode *cp);
323
324 /* cfs_vnodeops.h */
325 extern struct cnode *make_coda_node(ViceFid *fid, struct mount *vfsp, short type);
326 extern int coda_vnodeopstats_init(void);
327
328 /* coda_vfsops.h */
329 extern struct mount *devtomp(dev_t dev);
330
331 /* sigh */
332 #define CODA_RDWR ((u_long) 31)
333
334 #endif /* _CNODE_H_ */
335
336