xref: /netbsd/sys/coda/cnode.h (revision c4a72b64)
1 /*	$NetBSD: cnode.h,v 1.9 2002/11/02 07:18:35 perry 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 #ifndef	_CNODE_H_
48 #define	_CNODE_H_
49 
50 #include <sys/vnode.h>
51 
52 /*
53  * tmp below since we need struct queue
54  */
55 #include <coda/coda_kernel.h>
56 
57 /*
58  * Cnode lookup stuff.
59  * NOTE: CODA_CACHESIZE must be a power of 2 for cfshash to work!
60  */
61 #define CODA_CACHESIZE 512
62 
63 #define CODA_ALLOC(ptr, cast, size)                                        \
64 do {                                                                      \
65     ptr = (cast)malloc((unsigned long) size, M_CODA, M_WAITOK);            \
66     if (ptr == 0) {                                                       \
67 	panic("kernel malloc returns 0 at %s:%d\n", __FILE__, __LINE__);  \
68     }                                                                     \
69 } while (/*CONSTCOND*/ 0)
70 
71 #define CODA_FREE(ptr, size)  free((ptr), M_CODA)
72 
73 /*
74  * global cache state control
75  */
76 extern int coda_nc_use;
77 
78 /*
79  * Used to select debugging statements throughout the cfs code.
80  */
81 extern int codadebug;
82 extern int coda_nc_debug;
83 extern int coda_printf_delay;
84 extern int coda_vnop_print_entry;
85 extern int coda_psdev_print_entry;
86 extern int coda_vfsop_print_entry;
87 
88 #define CODADBGMSK(N)            (1 << N)
89 #define CODADEBUG(N, STMT)       { if (codadebug & CODADBGMSK(N)) { STMT } }
90 #define myprintf(args)          \
91 do {                            \
92     if (coda_printf_delay)       \
93 	DELAY(coda_printf_delay);\
94     printf args ;               \
95 } while (/*CONSTCOND*/ 0)
96 
97 struct cnode {
98     struct vnode	*c_vnode;
99     u_short		 c_flags;	/* flags (see below) */
100     ViceFid		 c_fid;		/* file handle */
101     struct vnode	*c_ovp;		/* open vnode pointer */
102     u_short		 c_ocount;	/* count of openers */
103     u_short		 c_owrite;	/* count of open for write */
104     struct vattr	 c_vattr; 	/* attributes */
105     char		*c_symlink;	/* pointer to symbolic link */
106     u_short		 c_symlen;	/* length of symbolic link */
107     dev_t		 c_device;	/* associated vnode device */
108     ino_t		 c_inode;	/* associated vnode inode */
109     struct cnode	*c_next;	/* links if on NetBSD machine */
110 };
111 #define	VTOC(vp)	((struct cnode *)(vp)->v_data)
112 #define	SET_VTOC(vp)	((vp)->v_data)
113 #define	CTOV(cp)	((struct vnode *)((cp)->c_vnode))
114 
115 /* flags */
116 #define C_VATTR		0x01	/* Validity of vattr in the cnode */
117 #define C_SYMLINK	0x02	/* Validity of symlink pointer in the Code */
118 #define C_WANTED	0x08	/* Set if lock wanted */
119 #define C_LOCKED	0x10	/* Set if lock held */
120 #define C_UNMOUNTING	0X20	/* Set if unmounting */
121 #define C_PURGING	0x40	/* Set if purging a fid */
122 
123 #define VALID_VATTR(cp)		((cp->c_flags) & C_VATTR)
124 #define VALID_SYMLINK(cp)	((cp->c_flags) & C_SYMLINK)
125 #define IS_UNMOUNTING(cp)	((cp)->c_flags & C_UNMOUNTING)
126 
127 struct vcomm {
128 	u_long		vc_seq;
129 	struct selinfo	vc_selproc;
130 	struct queue	vc_requests;
131 	struct queue	vc_replys;
132 };
133 
134 #define	VC_OPEN(vcp)	    ((vcp)->vc_requests.forw != NULL)
135 #define MARK_VC_CLOSED(vcp) (vcp)->vc_requests.forw = NULL;
136 #define MARK_VC_OPEN(vcp)    /* MT */
137 
138 struct coda_clstat {
139 	int	ncalls;			/* client requests */
140 	int	nbadcalls;		/* upcall failures */
141 	int	reqs[CODA_NCALLS];	/* count of each request */
142 };
143 extern struct coda_clstat coda_clstat;
144 
145 /*
146  * CODA structure to hold mount/file system information
147  */
148 struct coda_mntinfo {
149     struct vnode	*mi_rootvp;
150     struct mount	*mi_vfsp;
151     struct vcomm	 mi_vcomm;
152 };
153 extern struct coda_mntinfo coda_mnttbl[]; /* indexed by minor device number */
154 
155 /*
156  * vfs pointer to mount info
157  */
158 #define vftomi(vfsp)    ((struct coda_mntinfo *)(vfsp->mnt_data))
159 #define	CODA_MOUNTED(vfsp)   (vftomi((vfsp)) != (struct coda_mntinfo *)0)
160 
161 /*
162  * vnode pointer to mount info
163  */
164 #define vtomi(vp)       ((struct coda_mntinfo *)(vp->v_mount->mnt_data))
165 
166 /*
167  * Used for identifying usage of "Control" object
168  */
169 extern struct vnode *coda_ctlvp;
170 #define	IS_CTL_VP(vp)		((vp) == coda_ctlvp)
171 #define	IS_CTL_NAME(vp, name, l)((l == CODA_CONTROLLEN) \
172  				 && ((vp) == vtomi((vp))->mi_rootvp)    \
173 				 && strncmp(name, CODA_CONTROL, l) == 0)
174 
175 /*
176  * An enum to tell us whether something that will remove a reference
177  * to a cnode was a downcall or not
178  */
179 enum dc_status {
180     IS_DOWNCALL = 6,
181     NOT_DOWNCALL = 7
182 };
183 
184 /* cfs_psdev.h */
185 extern int coda_call(struct coda_mntinfo *mntinfo, int inSize, int *outSize, caddr_t buffer);
186 extern int coda_kernel_version;
187 
188 /* cfs_subr.h */
189 extern int  handleDownCall(int opcode, union outputArgs *out);
190 extern void coda_unmounting(struct mount *whoIam);
191 extern int  coda_vmflush(struct cnode *cp);
192 
193 /* cfs_vnodeops.h */
194 extern struct cnode *make_coda_node(ViceFid *fid, struct mount *vfsp, short type);
195 extern int coda_vnodeopstats_init(void);
196 
197 /* coda_vfsops.h */
198 extern struct mount *devtomp(dev_t dev);
199 
200 /* sigh */
201 #define CODA_RDWR ((u_long) 31)
202 
203 #endif	/* _CNODE_H_ */
204 
205