cnode.h revision 1.3 1 /* $NetBSD: cnode.h,v 1.3 1998/09/12 15:05:50 rvb 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 * @(#) cfs/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.3 1998/09/12 15:05:50 rvb
51 * Change cfs/CFS in symbols, strings and constants to coda/CODA
52 * to avoid fs conflicts.
53 *
54 * Revision 1.2 1998/09/08 17:12:49 rvb
55 * Pass2 complete
56 *
57 * Revision 1.1.1.1 1998/08/29 21:26:46 rvb
58 * Very Preliminary Coda
59 *
60 * Revision 1.10 1998/08/28 18:12:25 rvb
61 * Now it also works on FreeBSD -current. This code will be
62 * committed to the FreeBSD -current and NetBSD -current
63 * trees. It will then be tailored to the particular platform
64 * by flushing conditional code.
65 *
66 * Revision 1.9 1998/08/18 17:05:24 rvb
67 * Don't use __RCSID now
68 *
69 * Revision 1.8 1998/08/18 16:31:49 rvb
70 * Sync the code for NetBSD -current; test on 1.3 later
71 *
72 * Revision 1.7 98/02/24 22:22:53 rvb
73 * Fixes up mainly to flush iopen and friends
74 *
75 * Revision 1.6 98/01/31 20:53:19 rvb
76 * First version that works on FreeBSD 2.2.5
77 *
78 * Revision 1.5 98/01/23 11:53:51 rvb
79 * Bring RVB_CODA1_1 to HEAD
80 *
81 * Revision 1.4.2.5 98/01/23 11:21:14 rvb
82 * Sync with 2.2.5
83 *
84 * Revision 1.4.2.4 98/01/22 13:03:38 rvb
85 * Had Breaken ls .
86 *
87 * Revision 1.4.2.3 97/12/19 14:26:09 rvb
88 * session id
89 *
90 * Revision 1.4.2.2 97/12/16 12:40:24 rvb
91 * Sync with 1.3
92 *
93 * Revision 1.4.2.1 97/12/06 17:41:28 rvb
94 * Sync with peters coda.h
95 *
96 * Revision 1.4 97/12/05 10:39:30 rvb
97 * Read CHANGES
98 *
99 * Revision 1.3.18.2 97/11/12 12:09:45 rvb
100 * reorg pass1
101 *
102 * Revision 1.3.18.1 97/10/29 16:06:31 rvb
103 * Kill DYING
104 *
105 * Revision 1.3 1996/12/12 22:11:03 bnoble
106 * Fixed the "downcall invokes venus operation" deadlock in all known cases.
107 * There may be more.
108 *
109 * Revision 1.2 1996/01/02 16:57:26 bnoble
110 * Added support for Coda MiniCache and raw inode calls (final commit)
111 *
112 * Revision 1.1.2.1 1995/12/20 01:57:53 bnoble
113 * Added CODA-specific files
114 *
115 * Revision 3.1.1.1 1995/03/04 19:08:23 bnoble
116 * Branch for NetBSD port revisions
117 *
118 * Revision 3.1 1995/03/04 19:08:23 bnoble
119 * Bump to major revision 3 to prepare for NetBSD port
120 *
121 * Revision 2.2 1994/12/06 13:39:18 dcs
122 * Add a flag value to indicate a cnode was orphaned, e.g. the venus
123 * that created it has exited. This will allow one to restart venus
124 * even though some process may be cd'd into /coda.
125 *
126 * Revision 2.1 94/07/21 16:25:33 satya
127 * Conversion to C++ 3.0; start of Coda Release 2.0
128 *
129 * Revision 1.2.7.1 94/06/16 11:26:02 raiff
130 * Branch for release beta-16Jun1994_39118
131 *
132 * Revision 1.2 92/10/27 17:58:41 lily
133 * merge kernel/latest and alpha/src/cfs
134 *
135 * Revision 2.3 92/09/30 14:16:53 mja
136 * Picked up fixed #ifdef _KERNEL. Also...
137 *
138 * Substituted rvb's history blurb so that we agree with Mach 2.5 sources.
139 * [91/02/09 jjk]
140 *
141 * Added contributors blurb.
142 * [90/12/13 jjk]
143 *
144 * Revision 2.2 90/07/05 11:27:24 mrt
145 * Created for the Coda File System.
146 * [90/05/23 dcs]
147 *
148 * Revision 1.4 90/05/31 17:02:16 dcs
149 * Prepare for merge with facilities kernel.
150 *
151 *
152 *
153 */
154
155 #ifndef _CNODE_H_
156 #define _CNODE_H_
157
158 #include <sys/vnode.h>
159
160 /*
161 * tmp below since we need struct queue
162 */
163 #include <cfs/cfsk.h>
164
165 /*
166 * Cnode lookup stuff.
167 * NOTE: CODA_CACHESIZE must be a power of 2 for cfshash to work!
168 */
169 #define CODA_CACHESIZE 512
170
171 #define CODA_ALLOC(ptr, cast, size) \
172 do { \
173 ptr = (cast)malloc((unsigned long) size, M_CODA, M_WAITOK); \
174 if (ptr == 0) { \
175 panic("kernel malloc returns 0 at %s:%d\n", __FILE__, __LINE__); \
176 } \
177 } while (0)
178
179 #define CODA_FREE(ptr, size) free((ptr), M_CODA)
180
181 /*
182 * global cache state control
183 */
184 extern int coda_nc_use;
185
186 /*
187 * Used to select debugging statements throughout the cfs code.
188 */
189 extern int codadebug;
190 extern int coda_nc_debug;
191 extern int coda_printf_delay;
192 extern int coda_vnop_print_entry;
193 extern int coda_psdev_print_entry;
194 extern int coda_vfsop_print_entry;
195
196 #define CODADBGMSK(N) (1 << N)
197 #define CODADEBUG(N, STMT) { if (codadebug & CODADBGMSK(N)) { STMT } }
198 #define myprintf(args) \
199 do { \
200 if (coda_printf_delay) \
201 DELAY(coda_printf_delay);\
202 printf args ; \
203 } while (0)
204
205 struct cnode {
206 struct vnode *c_vnode;
207 u_short c_flags; /* flags (see below) */
208 ViceFid c_fid; /* file handle */
209 struct lock c_lock; /* new lock protocol */
210 struct vnode *c_ovp; /* open vnode pointer */
211 u_short c_ocount; /* count of openers */
212 u_short c_owrite; /* count of open for write */
213 struct vattr c_vattr; /* attributes */
214 char *c_symlink; /* pointer to symbolic link */
215 u_short c_symlen; /* length of symbolic link */
216 dev_t c_device; /* associated vnode device */
217 ino_t c_inode; /* associated vnode inode */
218 struct cnode *c_next; /* links if on NetBSD machine */
219 };
220 #define VTOC(vp) ((struct cnode *)(vp)->v_data)
221 #define CTOV(cp) ((struct vnode *)((cp)->c_vnode))
222
223 /* flags */
224 #define C_VATTR 0x01 /* Validity of vattr in the cnode */
225 #define C_SYMLINK 0x02 /* Validity of symlink pointer in the Code */
226 #define C_WANTED 0x08 /* Set if lock wanted */
227 #define C_LOCKED 0x10 /* Set if lock held */
228 #define C_UNMOUNTING 0X20 /* Set if unmounting */
229 #define C_PURGING 0x40 /* Set if purging a fid */
230
231 #define VALID_VATTR(cp) ((cp->c_flags) & C_VATTR)
232 #define VALID_SYMLINK(cp) ((cp->c_flags) & C_SYMLINK)
233 #define IS_UNMOUNTING(cp) ((cp)->c_flags & C_UNMOUNTING)
234
235 struct vcomm {
236 u_long vc_seq;
237 struct selinfo vc_selproc;
238 struct queue vc_requests;
239 struct queue vc_replys;
240 };
241
242 #define VC_OPEN(vcp) ((vcp)->vc_requests.forw != NULL)
243 #define MARK_VC_CLOSED(vcp) (vcp)->vc_requests.forw = NULL;
244 #define MARK_VC_OPEN(vcp) /* MT */
245
246 struct coda_clstat {
247 int ncalls; /* client requests */
248 int nbadcalls; /* upcall failures */
249 int reqs[CODA_NCALLS]; /* count of each request */
250 };
251 extern struct coda_clstat coda_clstat;
252
253 /*
254 * CODA structure to hold mount/file system information
255 */
256 struct coda_mntinfo {
257 struct vnode *mi_rootvp;
258 struct mount *mi_vfsp;
259 struct vcomm mi_vcomm;
260 };
261 extern struct coda_mntinfo coda_mnttbl[]; /* indexed by minor device number */
262
263 /*
264 * vfs pointer to mount info
265 */
266 #define vftomi(vfsp) ((struct coda_mntinfo *)(vfsp->mnt_data))
267 #define CODA_MOUNTED(vfsp) (vftomi((vfsp)) != (struct coda_mntinfo *)0)
268
269 /*
270 * vnode pointer to mount info
271 */
272 #define vtomi(vp) ((struct coda_mntinfo *)(vp->v_mount->mnt_data))
273
274 /*
275 * Used for identifying usage of "Control" object
276 */
277 extern struct vnode *coda_ctlvp;
278 #define IS_CTL_VP(vp) ((vp) == coda_ctlvp)
279 #define IS_CTL_NAME(vp, name, l)((l == CODA_CONTROLLEN) \
280 && ((vp) == vtomi((vp))->mi_rootvp) \
281 && strncmp(name, CODA_CONTROL, l) == 0)
282
283 /*
284 * An enum to tell us whether something that will remove a reference
285 * to a cnode was a downcall or not
286 */
287 enum dc_status {
288 IS_DOWNCALL = 6,
289 NOT_DOWNCALL = 7
290 };
291
292 /* cfs_psdev.h */
293 int coda_call(struct coda_mntinfo *mntinfo, int inSize, int *outSize, caddr_t buffer);
294
295 /* cfs_subr.h */
296 int handleDownCall(int opcode, union outputArgs *out);
297 void coda_unmounting(struct mount *whoIam);
298 int coda_vmflush(struct cnode *cp);
299
300 /* cfs_vnodeops.h */
301 struct cnode *make_coda_node(ViceFid *fid, struct mount *vfsp, short type);
302 int coda_vnodeopstats_init(void);
303
304 /* coda_vfsops.h */
305 struct mount *devtomp(dev_t dev);
306
307 /* sigh */
308 #define CODA_RDWR ((u_long) 31)
309
310 #endif /* _CNODE_H_ */
311
312