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