cnode.h revision 119832 
1/*
2 *
3 *             Coda: an Experimental Distributed File System
4 *                              Release 3.1
5 *
6 *           Copyright (c) 1987-1998 Carnegie Mellon University
7 *                          All Rights Reserved
8 *
9 * Permission  to  use, copy, modify and distribute this software and its
10 * documentation is hereby granted,  provided  that  both  the  copyright
11 * notice  and  this  permission  notice  appear  in  all  copies  of the
12 * software, derivative works or  modified  versions,  and  any  portions
13 * thereof, and that both notices appear in supporting documentation, and
14 * that credit is given to Carnegie Mellon University  in  all  documents
15 * and publicity pertaining to direct or indirect use of this code or its
16 * derivatives.
17 *
18 * CODA IS AN EXPERIMENTAL SOFTWARE SYSTEM AND IS  KNOWN  TO  HAVE  BUGS,
19 * SOME  OF  WHICH MAY HAVE SERIOUS CONSEQUENCES.  CARNEGIE MELLON ALLOWS
20 * FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION.   CARNEGIE  MELLON
21 * DISCLAIMS  ANY  LIABILITY  OF  ANY  KIND  FOR  ANY  DAMAGES WHATSOEVER
22 * RESULTING DIRECTLY OR INDIRECTLY FROM THE USE OF THIS SOFTWARE  OR  OF
23 * ANY DERIVATIVE WORK.
24 *
25 * Carnegie  Mellon  encourages  users  of  this  software  to return any
26 * improvements or extensions that  they  make,  and  to  grant  Carnegie
27 * Mellon the rights to redistribute these changes without encumbrance.
28 *
29 * 	@(#) src/sys/coda/cnode.h,v 1.1.1.1 1998/08/29 21:14:52 rvb Exp $
30 * $FreeBSD: head/sys/fs/coda/cnode.h 119832 2003-09-07 07:43:10Z tjr $
31 *
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 filesystem 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#include <sys/lock.h>
52#include <machine/clock.h>
53
54MALLOC_DECLARE(M_CODA);
55
56/*
57 * tmp below since we need struct queue
58 */
59#include <coda/coda_kernel.h>
60
61/*
62 * Cnode lookup stuff.
63 * NOTE: CODA_CACHESIZE must be a power of 2 for cfshash to work!
64 */
65#define CODA_CACHESIZE 512
66
67#define CODA_ALLOC(ptr, cast, size)                                        \
68do {                                                                      \
69    ptr = (cast)malloc((unsigned long) size, M_CODA, M_WAITOK);            \
70    if (ptr == 0) {                                                       \
71	panic("kernel malloc returns 0 at %s:%d\n", __FILE__, __LINE__);  \
72    }                                                                     \
73} while (0)
74
75#define CODA_FREE(ptr, size)  free((ptr), M_CODA)
76
77/*
78 * global cache state control
79 */
80extern int coda_nc_use;
81
82/*
83 * Used to select debugging statements throughout the cfs code.
84 */
85extern int codadebug;
86extern int coda_nc_debug;
87extern int coda_printf_delay;
88extern int coda_vnop_print_entry;
89extern int coda_psdev_print_entry;
90extern int coda_vfsop_print_entry;
91
92#define CODADBGMSK(N)            (1 << N)
93#define CODADEBUG(N, STMT)       { if (codadebug & CODADBGMSK(N)) { STMT } }
94#define myprintf(args)          \
95do {                            \
96    if (coda_printf_delay)       \
97	DELAY(coda_printf_delay);\
98    printf args ;               \
99} while (0)
100
101struct cnode {
102    struct vnode	*c_vnode;
103    u_short		 c_flags;	/* flags (see below) */
104    CodaFid		 c_fid;		/* file handle */
105    struct lock		 c_lock;	/* new lock protocol */
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	CTOV(cp)	((struct vnode *)((cp)->c_vnode))
118
119/* flags */
120#define C_VATTR		0x01	/* Validity of vattr in the cnode */
121#define C_SYMLINK	0x02	/* Validity of symlink pointer in the Code */
122#define C_WANTED	0x08	/* Set if lock wanted */
123#define C_LOCKED	0x10	/* Set if lock held */
124#define C_UNMOUNTING	0X20	/* Set if unmounting */
125#define C_PURGING	0x40	/* Set if purging a fid */
126
127#define VALID_VATTR(cp)		((cp->c_flags) & C_VATTR)
128#define VALID_SYMLINK(cp)	((cp->c_flags) & C_SYMLINK)
129#define IS_UNMOUNTING(cp)	((cp)->c_flags & C_UNMOUNTING)
130
131struct vcomm {
132	u_long		vc_seq;
133	struct selinfo	vc_selproc;
134	struct queue	vc_requests;
135	struct queue	vc_replys;
136};
137
138#define	VC_OPEN(vcp)	    ((vcp)->vc_requests.forw != NULL)
139#define MARK_VC_CLOSED(vcp) (vcp)->vc_requests.forw = NULL;
140#define MARK_VC_OPEN(vcp)    /* MT */
141
142struct coda_clstat {
143	int	ncalls;			/* client requests */
144	int	nbadcalls;		/* upcall failures */
145	int	reqs[CODA_NCALLS];	/* count of each request */
146};
147extern struct coda_clstat coda_clstat;
148
149/*
150 * CODA structure to hold mount/filesystem information
151 */
152struct coda_mntinfo {
153    struct vnode	*mi_rootvp;
154    struct mount	*mi_vfsp;
155    struct vcomm	 mi_vcomm;
156    dev_t                dev;
157    int                  mi_started;
158};
159extern 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
167/*
168 * vnode pointer to mount info
169 */
170#define vtomi(vp)       ((struct coda_mntinfo *)(vp->v_mount->mnt_data))
171
172/*
173 * Used for identifying usage of "Control" object
174 */
175extern struct vnode *coda_ctlvp;
176#define	IS_CTL_VP(vp)		((vp) == coda_ctlvp)
177#define	IS_CTL_NAME(vp, name, l)((l == CODA_CONTROLLEN) \
178 				 && ((vp) == vtomi((vp))->mi_rootvp)    \
179				 && strncmp(name, CODA_CONTROL, l) == 0)
180
181/*
182 * An enum to tell us whether something that will remove a reference
183 * to a cnode was a downcall or not
184 */
185enum dc_status {
186    IS_DOWNCALL = 6,
187    NOT_DOWNCALL = 7
188};
189
190/* cfs_psdev.h */
191extern int coda_call(struct coda_mntinfo *mntinfo, int inSize, int *outSize, caddr_t buffer);
192extern int coda_kernel_version;
193
194/* cfs_subr.h */
195extern int  handleDownCall(int opcode, union outputArgs *out);
196extern void coda_unmounting(struct mount *whoIam);
197extern int  coda_vmflush(struct cnode *cp);
198
199/* cfs_vnodeops.h */
200extern struct cnode *make_coda_node(CodaFid *fid, struct mount *vfsp, short type);
201extern int coda_vnodeopstats_init(void);
202
203/* coda_vfsops.h */
204extern struct mount *devtomp(dev_t dev);
205
206/* sigh */
207#define CODA_RDWR ((u_long) 31)
208
209#endif	/* _CNODE_H_ */
210
211