Print this page
*** NO COMMENTS ***
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/uts/common/fs/smbclnt/smbfs/smbfs_node.h
+++ new/usr/src/uts/common/fs/smbclnt/smbfs/smbfs_node.h
1 1 /*
2 2 * Copyright (c) 2000-2001, Boris Popov
3 3 * All rights reserved.
4 4 *
5 5 * Redistribution and use in source and binary forms, with or without
6 6 * modification, are permitted provided that the following conditions
7 7 * are met:
8 8 * 1. Redistributions of source code must retain the above copyright
9 9 * notice, this list of conditions and the following disclaimer.
10 10 * 2. Redistributions in binary form must reproduce the above copyright
11 11 * notice, this list of conditions and the following disclaimer in the
12 12 * documentation and/or other materials provided with the distribution.
13 13 * 3. All advertising materials mentioning features or use of this software
14 14 * must display the following acknowledgement:
15 15 * This product includes software developed by Boris Popov.
16 16 * 4. Neither the name of the author nor the names of any co-contributors
17 17 * may be used to endorse or promote products derived from this software
18 18 * without specific prior written permission.
19 19 *
20 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 30 * SUCH DAMAGE.
31 31 *
32 32 * $Id: smbfs_node.h,v 1.31.52.1 2005/05/27 02:35:28 lindak Exp $
33 33 */
34 34
35 35 /*
36 36 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
37 37 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
38 38 * Use is subject to license terms.
39 39 */
40 40
41 41 #ifndef _FS_SMBFS_NODE_H_
42 42 #define _FS_SMBFS_NODE_H_
43 43
44 44 /*
45 45 * Much code copied into here from Sun NFS.
46 46 * Compare with nfs_clnt.h
47 47 */
48 48
49 49 #include <sys/avl.h>
50 50 #include <sys/list.h>
51 51 #include <netsmb/smb_subr.h>
52 52
53 53 #ifdef __cplusplus
54 54 extern "C" {
55 55 #endif
56 56
57 57 /*
58 58 * Cache whole directories (not yet)
59 59 */
60 60 typedef struct rddir_cache {
61 61 lloff_t _cookie; /* cookie used to find this cache entry */
62 62 lloff_t _ncookie; /* cookie used to find the next cache entry */
63 63 char *entries; /* buffer containing dirent entries */
64 64 int eof; /* EOF reached after this request */
65 65 int entlen; /* size of dirent entries in buf */
66 66 int buflen; /* size of the buffer used to store entries */
67 67 int flags; /* control flags, see below */
68 68 kcondvar_t cv; /* cv for blocking */
69 69 int error; /* error from RPC operation */
70 70 kmutex_t lock;
71 71 uint_t count; /* reference count */
72 72 avl_node_t tree; /* AVL tree links */
73 73 } rddir_cache;
74 74
75 75 #define smbfs_cookie _cookie._p._l
76 76 #define smbfs_ncookie _ncookie._p._l
77 77 #define smbfs3_cookie _cookie._f
78 78 #define smbfs3_ncookie _ncookie._f
79 79
80 80 #define RDDIR 0x1 /* readdir operation in progress */
81 81 #define RDDIRWAIT 0x2 /* waiting on readdir in progress */
82 82 #define RDDIRREQ 0x4 /* a new readdir is required */
83 83 #define RDDIRCACHED 0x8 /* entry is in the cache */
84 84
85 85 #define HAVE_RDDIR_CACHE(rp) (avl_numnodes(&(rp)->r_dir) > 0)
86 86
87 87 /*
88 88 * A homegrown reader/writer lock implementation. It addresses
89 89 * two requirements not addressed by the system primitives. They
90 90 * are that the `enter" operation is optionally interruptible and
91 91 * that that they can be re`enter'ed by writers without deadlock.
92 92 */
93 93 typedef struct smbfs_rwlock {
94 94 int count;
95 95 int waiters;
96 96 kthread_t *owner;
97 97 kmutex_t lock;
98 98 kcondvar_t cv;
99 99 } smbfs_rwlock_t;
100 100
101 101 /*
102 102 * The format of the smbfs node header, which contains the
103 103 * fields used to link nodes in the AVL tree, and those
104 104 * fields needed by the AVL node comparison functions.
105 105 * It's a separate struct so we can call avl_find with
106 106 * this relatively small struct as a stack local.
107 107 *
108 108 * The AVL tree is mntinfo.smi_hash_avl,
109 109 * and its lock is mntinfo.smi_hash_lk.
110 110 */
111 111 typedef struct smbfs_node_hdr {
112 112 /*
113 113 * Our linkage in the node cache AVL tree.
114 114 */
115 115 avl_node_t hdr_avl_node;
116 116
117 117 /*
118 118 * Identity of this node: The full path name,
119 119 * in server form, relative to the share root.
120 120 */
121 121 char *hdr_n_rpath;
122 122 int hdr_n_rplen;
123 123 } smbfs_node_hdr_t;
124 124
125 125 /*
126 126 * Below is the SMBFS-specific representation of a "node".
127 127 * This struct is a mixture of Sun NFS and Darwin code.
128 128 * Fields starting with "r_" came from NFS struct "rnode"
129 129 * and fields starting with "n_" came from Darwin, or
130 130 * were added during the Solaris port. We have avoided
131 131 * renaming fields so we would not cause excessive
132 132 * changes in the code using this struct.
133 133 *
134 134 * Now using an AVL tree instead of hash lists, but kept the
135 135 * "hash" in some member names and functions to reduce churn.
136 136 * One AVL tree per mount replaces the global hash buckets.
137 137 *
138 138 * Notes carried over from the NFS code:
139 139 *
140 140 * The smbnode is the "inode" for remote files. It contains all the
141 141 * information necessary to handle remote file on the client side.
142 142 *
143 143 * Note on file sizes: we keep two file sizes in the smbnode: the size
144 144 * according to the client (r_size) and the size according to the server
145 145 * (r_attr.fa_size). They can differ because we modify r_size during a
146 146 * write system call (smbfs_rdwr), before the write request goes over the
147 147 * wire (before the file is actually modified on the server). If an OTW
148 148 * request occurs before the cached data is written to the server the file
149 149 * size returned from the server (r_attr.fa_size) may not match r_size.
150 150 * r_size is the one we use, in general. r_attr.fa_size is only used to
151 151 * determine whether or not our cached data is valid.
152 152 *
153 153 * Each smbnode has 3 locks associated with it (not including the smbnode
154 154 * "hash" AVL tree and free list locks):
155 155 *
156 156 * r_rwlock: Serializes smbfs_write and smbfs_setattr requests
157 157 * and allows smbfs_read requests to proceed in parallel.
158 158 * Serializes reads/updates to directories.
159 159 *
160 160 * r_lkserlock: Serializes lock requests with map, write, and
161 161 * readahead operations.
162 162 *
163 163 * r_statelock: Protects all fields in the smbnode except for
164 164 * those listed below. This lock is intented
165 165 * to be held for relatively short periods of
166 166 * time (not accross entire putpage operations,
167 167 * for example).
168 168 *
169 169 * The following members are protected by the mutex smbfreelist_lock:
170 170 * r_freef
171 171 * r_freeb
172 172 *
173 173 * The following members are protected by the AVL tree rwlock:
174 174 * r_avl_node (r__hdr.hdr_avl_node)
175 175 *
176 176 * Note: r_modaddr is only accessed when the r_statelock mutex is held.
177 177 * Its value is also controlled via r_rwlock. It is assumed that
178 178 * there will be only 1 writer active at a time, so it safe to
179 179 * set r_modaddr and release r_statelock as long as the r_rwlock
180 180 * writer lock is held.
181 181 *
182 182 * 64-bit offsets: the code formerly assumed that atomic reads of
183 183 * r_size were safe and reliable; on 32-bit architectures, this is
184 184 * not true since an intervening bus cycle from another processor
185 185 * could update half of the size field. The r_statelock must now
186 186 * be held whenever any kind of access of r_size is made.
187 187 *
188 188 * Lock ordering:
189 189 * r_rwlock > r_lkserlock > r_statelock
190 190 */
191 191
192 192 typedef struct smbnode {
193 193 /* Our linkage in the node cache AVL tree (see above). */
194 194 smbfs_node_hdr_t r__hdr;
195 195
196 196 /* short-hand names for r__hdr members */
197 197 #define r_avl_node r__hdr.hdr_avl_node
198 198 #define n_rpath r__hdr.hdr_n_rpath
199 199 #define n_rplen r__hdr.hdr_n_rplen
200 200
201 201 smbmntinfo_t *n_mount; /* VFS data */
202 202 vnode_t *r_vnode; /* associated vnode */
203 203
204 204 /*
205 205 * Linkage in smbfreelist, for reclaiming nodes.
206 206 * Lock for the free list is: smbfreelist_lock
207 207 */
208 208 struct smbnode *r_freef; /* free list forward pointer */
209 209 struct smbnode *r_freeb; /* free list back pointer */
210 210
211 211 smbfs_rwlock_t r_rwlock; /* serialize write/setattr requests */
212 212 smbfs_rwlock_t r_lkserlock; /* serialize lock with other ops */
213 213 kmutex_t r_statelock; /* protect (most) smbnode fields */
214 214
215 215 /*
216 216 * File handle, directory search handle,
217 217 * and reference counts for them, etc.
218 218 * Lock for these is: r_lkserlock
219 219 */
220 220 int n_dirrefs;
221 221 struct smbfs_fctx *n_dirseq; /* ff context */
222 222 int n_dirofs; /* last ff offset */
223 223 int n_fidrefs;
224 224 uint16_t n_fid; /* file handle */
225 225 enum vtype n_ovtype; /* vnode type opened */
226 226 uint32_t n_rights; /* granted rights */
227 227 int n_vcgenid; /* gereration no. (reconnect) */
|
↓ open down ↓ |
227 lines elided |
↑ open up ↑ |
228 228
229 229 /*
230 230 * Misc. bookkeeping
231 231 */
232 232 cred_t *r_cred; /* current credentials */
233 233 u_offset_t r_nextr; /* next read offset (read-ahead) */
234 234 long r_mapcnt; /* count of mmapped pages */
235 235 uint_t r_count; /* # of refs not reflect in v_count */
236 236 uint_t r_awcount; /* # of outstanding async write */
237 237 uint_t r_gcount; /* getattrs waiting to flush pages */
238 + u_offset_t r_modaddr; /* address for page in writenp */
238 239 uint_t r_flags; /* flags, see below */
239 240 uint32_t n_flag; /* NXXX flags below */
240 241 uint_t r_error; /* async write error */
241 242 kcondvar_t r_cv; /* condvar for blocked threads */
242 243 avl_tree_t r_dir; /* cache of readdir responses */
243 244 rddir_cache *r_direof; /* pointer to the EOF entry */
244 245 kthread_t *r_serial; /* id of purging thread */
245 246 list_t r_indelmap; /* list of delmap callers */
246 247
247 248 /*
248 249 * Attributes: local, and as last seen on the server.
249 250 * See notes above re: r_size vs r_attr.fa_size, etc.
250 251 */
251 252 smbfattr_t r_attr; /* attributes from the server */
252 253 hrtime_t r_attrtime; /* time attributes become invalid */
253 254 hrtime_t r_mtime; /* client time file last modified */
254 255 len_t r_size; /* client's view of file size */
255 256
256 257 /*
257 258 * Security attributes.
258 259 */
259 260 vsecattr_t r_secattr;
260 261 hrtime_t r_sectime;
261 262
262 263 /*
263 264 * Other attributes, not carried in smbfattr_t
264 265 */
265 266 u_longlong_t n_ino;
266 267 uid_t n_uid;
267 268 gid_t n_gid;
268 269 mode_t n_mode;
269 270 } smbnode_t;
270 271
271 272 /*
272 273 * Flag bits in: smbnode_t .n_flag
273 274 */
274 275 #define NFLUSHINPROG 0x00001
275 276 #define NFLUSHWANT 0x00002 /* they should gone ... */
276 277 #define NMODIFIED 0x00004 /* bogus, until async IO implemented */
277 278 #define NREFPARENT 0x00010 /* node holds parent from recycling */
278 279 #define NGOTIDS 0x00020
279 280 #define NRDIRSERIAL 0x00080 /* serialize readdir operation */
280 281 #define NISMAPPED 0x00800
281 282 #define NFLUSHWIRE 0x01000
282 283 #define NATTRCHANGED 0x02000 /* kill cached attributes at close */
283 284 #define NALLOC 0x04000 /* being created */
284 285 #define NWALLOC 0x08000 /* awaiting creation */
285 286 #define N_XATTR 0x10000 /* extended attribute (dir or file) */
286 287
287 288 /*
288 289 * Flag bits in: smbnode_t .r_flags
289 290 */
290 291 #define RREADDIRPLUS 0x1 /* issue a READDIRPLUS instead of READDIR */
291 292 #define RDIRTY 0x2 /* dirty pages from write operation */
292 293 #define RSTALE 0x4 /* file handle is stale */
293 294 #define RMODINPROGRESS 0x8 /* page modification happening */
294 295 #define RTRUNCATE 0x10 /* truncating, don't commit */
295 296 #define RHAVEVERF 0x20 /* have a write verifier to compare against */
296 297 #define RCOMMIT 0x40 /* commit in progress */
297 298 #define RCOMMITWAIT 0x80 /* someone is waiting to do a commit */
298 299 #define RHASHED 0x100 /* smbnode is in the "hash" AVL tree */
299 300 #define ROUTOFSPACE 0x200 /* an out of space error has happened */
300 301 #define RDIRECTIO 0x400 /* bypass the buffer cache */
301 302 #define RLOOKUP 0x800 /* a lookup has been performed */
302 303 #define RWRITEATTR 0x1000 /* attributes came from WRITE */
303 304 #define RINDNLCPURGE 0x2000 /* in the process of purging DNLC references */
304 305 #define RDELMAPLIST 0x4000 /* delmap callers tracking for as callback */
305 306
306 307 /*
307 308 * Convert between vnode and smbnode
308 309 */
309 310 #define VTOSMB(vp) ((smbnode_t *)((vp)->v_data))
310 311 #define SMBTOV(np) ((np)->r_vnode)
311 312
312 313 /*
313 314 * A macro to compute the separator that should be used for
314 315 * names under some directory. See smbfs_fullpath().
315 316 */
316 317 #define SMBFS_DNP_SEP(dnp) \
317 318 (((dnp->n_flag & N_XATTR) == 0 && dnp->n_rplen > 1) ? '\\' : '\0')
318 319
319 320 #ifdef __cplusplus
320 321 }
321 322 #endif
322 323
323 324 #endif /* _FS_SMBFS_NODE_H_ */
|
↓ open down ↓ |
76 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX