]>
Commit | Line | Data |
---|---|---|
1c79356b | 1 | /* |
cb323159 | 2 | * Copyright (c) 2000-2019 Apple Inc. All rights reserved. |
5d5c5d0d | 3 | * |
2d21ac55 | 4 | * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ |
0a7de745 | 5 | * |
2d21ac55 A |
6 | * This file contains Original Code and/or Modifications of Original Code |
7 | * as defined in and that are subject to the Apple Public Source License | |
8 | * Version 2.0 (the 'License'). You may not use this file except in | |
9 | * compliance with the License. The rights granted to you under the License | |
10 | * may not be used to create, or enable the creation or redistribution of, | |
11 | * unlawful or unlicensed copies of an Apple operating system, or to | |
12 | * circumvent, violate, or enable the circumvention or violation of, any | |
13 | * terms of an Apple operating system software license agreement. | |
0a7de745 | 14 | * |
2d21ac55 A |
15 | * Please obtain a copy of the License at |
16 | * http://www.opensource.apple.com/apsl/ and read it before using this file. | |
0a7de745 | 17 | * |
2d21ac55 A |
18 | * The Original Code and all software distributed under the License are |
19 | * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER | |
8f6c56a5 A |
20 | * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, |
21 | * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, | |
2d21ac55 A |
22 | * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. |
23 | * Please see the License for the specific language governing rights and | |
24 | * limitations under the License. | |
0a7de745 | 25 | * |
2d21ac55 | 26 | * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ |
1c79356b A |
27 | */ |
28 | /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ | |
29 | /* | |
30 | * Copyright (c) 1989, 1993 | |
31 | * The Regents of the University of California. All rights reserved. | |
32 | * | |
33 | * This code is derived from software contributed to Berkeley by | |
34 | * Rick Macklem at The University of Guelph. | |
35 | * | |
36 | * Redistribution and use in source and binary forms, with or without | |
37 | * modification, are permitted provided that the following conditions | |
38 | * are met: | |
39 | * 1. Redistributions of source code must retain the above copyright | |
40 | * notice, this list of conditions and the following disclaimer. | |
41 | * 2. Redistributions in binary form must reproduce the above copyright | |
42 | * notice, this list of conditions and the following disclaimer in the | |
43 | * documentation and/or other materials provided with the distribution. | |
44 | * 3. All advertising materials mentioning features or use of this software | |
45 | * must display the following acknowledgement: | |
46 | * This product includes software developed by the University of | |
47 | * California, Berkeley and its contributors. | |
48 | * 4. Neither the name of the University nor the names of its contributors | |
49 | * may be used to endorse or promote products derived from this software | |
50 | * without specific prior written permission. | |
51 | * | |
52 | * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
53 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
54 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
55 | * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
56 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
57 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
58 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
59 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
60 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
61 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
62 | * SUCH DAMAGE. | |
63 | * | |
64 | * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95 | |
65 | * FreeBSD-Id: nfsnode.h,v 1.24 1997/10/28 14:06:25 bde Exp $ | |
66 | */ | |
67 | ||
68 | ||
69 | #ifndef _NFS_NFSNODE_H_ | |
70 | #define _NFS_NFSNODE_H_ | |
71 | ||
9bccf70c A |
72 | #include <sys/appleapiopts.h> |
73 | ||
74 | #ifdef __APPLE_API_PRIVATE | |
1c79356b A |
75 | #ifndef _NFS_NFS_H_ |
76 | #include <nfs/nfs.h> | |
77 | #endif | |
6d2010ae | 78 | #include <sys/kauth.h> |
0a7de745 | 79 | #include <os/refcnt.h> |
1c79356b A |
80 | |
81 | /* | |
82 | * Silly rename structure that hangs off the nfsnode until the name | |
2d21ac55 | 83 | * can be removed by nfs_vnop_inactive() |
1c79356b | 84 | */ |
2d21ac55 | 85 | struct nfs_sillyrename { |
0a7de745 A |
86 | kauth_cred_t nsr_cred; |
87 | struct nfsnode *nsr_dnp; | |
88 | int nsr_namlen; | |
89 | char nsr_name[20]; | |
1c79356b A |
90 | }; |
91 | ||
f427ee49 A |
92 | /* |
93 | * NFS buf pages struct | |
94 | */ | |
95 | typedef struct { | |
96 | uint64_t pages[8]; | |
97 | } nfsbufpgs; | |
98 | ||
55e303ae A |
99 | /* |
100 | * The nfsbuf is the nfs equivalent to a struct buf. | |
101 | */ | |
102 | struct nfsbuf { | |
0a7de745 A |
103 | LIST_ENTRY(nfsbuf) nb_hash; /* hash chain */ |
104 | LIST_ENTRY(nfsbuf) nb_vnbufs; /* nfsnode's nfsbuf chain */ | |
105 | TAILQ_ENTRY(nfsbuf) nb_free; /* free list position if not active. */ | |
cb323159 | 106 | os_refcnt_t nb_refs; /* outstanding references. */ |
0a7de745 A |
107 | daddr64_t nb_lblkno; /* logical block number. */ |
108 | uint64_t nb_verf; /* V3 write verifier */ | |
0a7de745 | 109 | time_t nb_timestamp; /* buffer timestamp */ |
f427ee49 A |
110 | nfsbufpgs nb_valid; /* valid pages in buf */ |
111 | nfsbufpgs nb_dirty; /* dirty pages in buf */ | |
0a7de745 A |
112 | caddr_t nb_data; /* mapped buffer */ |
113 | nfsnode_t nb_np; /* nfsnode buffer belongs to */ | |
114 | kauth_cred_t nb_rcred; /* read credentials reference */ | |
115 | kauth_cred_t nb_wcred; /* write credentials reference */ | |
116 | void * nb_pagelist; /* upl */ | |
f427ee49 A |
117 | volatile uint32_t nb_flags; /* NB_* flags. */ |
118 | volatile uint32_t nb_lflags; /* NBL_* flags. */ | |
119 | uint32_t nb_bufsize; /* buffer size */ | |
120 | int nb_error; /* errno value. */ | |
121 | int nb_commitlevel; /* lowest write commit level */ | |
122 | off_t nb_validoff; /* offset in buffer of valid region. */ | |
123 | off_t nb_validend; /* offset of end of valid region. */ | |
124 | off_t nb_dirtyoff; /* offset in buffer of dirty region. */ | |
125 | off_t nb_dirtyend; /* offset of end of dirty region. */ | |
126 | off_t nb_offio; /* offset in buffer of I/O region. */ | |
127 | off_t nb_endio; /* offset of end of I/O region. */ | |
128 | uint64_t nb_rpcs; /* Count of RPCs remaining for this buffer. */ | |
55e303ae A |
129 | }; |
130 | ||
f427ee49 | 131 | #define NFS_MAXBSIZE (8 * 64 * PAGE_SIZE) /* valid/dirty page masks limit buffer size */ |
0c530ab8 | 132 | |
0a7de745 A |
133 | #define NFS_A_LOT_OF_NEEDCOMMITS 256 /* max# uncommitted buffers for a node */ |
134 | #define NFS_A_LOT_OF_DELAYED_WRITES MAX(nfsbufcnt/8,512) /* max# "delwri" buffers in system */ | |
2d21ac55 | 135 | |
91447636 | 136 | /* |
2d21ac55 | 137 | * These flags are kept in b_lflags... |
91447636 A |
138 | * nfs_buf_mutex must be held before examining/updating |
139 | */ | |
0a7de745 A |
140 | #define NBL_BUSY 0x00000001 /* I/O in progress. */ |
141 | #define NBL_WANTED 0x00000002 /* Process wants this buffer. */ | |
91447636 | 142 | |
55e303ae A |
143 | /* |
144 | * These flags are kept in nb_flags and they're (purposefully) | |
145 | * very similar to the B_* flags for struct buf. | |
91447636 | 146 | * nfs_buf_mutex is not needed to examine/update these. |
55e303ae | 147 | */ |
0a7de745 A |
148 | #define NB_STALEWVERF 0x00000001 /* write verifier changed on us */ |
149 | #define NB_NEEDCOMMIT 0x00000002 /* buffer needs to be committed */ | |
150 | #define NB_ASYNC 0x00000004 /* Start I/O, do not wait. */ | |
151 | #define NB_CACHE 0x00000020 /* buffer data found in the cache */ | |
152 | #define NB_STABLE 0x00000040 /* write FILESYNC not UNSTABLE */ | |
153 | #define NB_DELWRI 0x00000080 /* delayed write: dirty range needs to be written */ | |
154 | #define NB_DONE 0x00000200 /* I/O completed. */ | |
155 | #define NB_EINTR 0x00000400 /* I/O was interrupted */ | |
156 | #define NB_ERROR 0x00000800 /* I/O error occurred. */ | |
157 | #define NB_INVAL 0x00002000 /* Does not contain valid info. */ | |
158 | #define NB_NCRDAHEAD 0x00004000 /* "nocache readahead" data */ | |
159 | #define NB_NOCACHE 0x00008000 /* Do not cache block after use. */ | |
160 | #define NB_WRITE 0x00000000 /* Write buffer (pseudo flag). */ | |
161 | #define NB_READ 0x00100000 /* Read buffer. */ | |
162 | #define NB_MULTASYNCRPC 0x00200000 /* multiple async RPCs issued for buffer */ | |
163 | #define NB_PAGELIST 0x00400000 /* Buffer describes pagelist I/O. */ | |
164 | #define NB_WRITEINPROG 0x01000000 /* Write in progress. */ | |
165 | #define NB_META 0x40000000 /* buffer contains meta-data. */ | |
55e303ae | 166 | |
91447636 | 167 | /* Flags for operation type in nfs_buf_get() */ |
0a7de745 A |
168 | #define NBLK_READ 0x00000001 /* buffer for read */ |
169 | #define NBLK_WRITE 0x00000002 /* buffer for write */ | |
170 | #define NBLK_META 0x00000004 /* buffer for metadata */ | |
171 | #define NBLK_OPMASK 0x00000007 /* operation mask */ | |
91447636 | 172 | /* modifiers for above flags... */ |
0a7de745 A |
173 | #define NBLK_NOWAIT 0x40000000 /* don't wait on busy buffer */ |
174 | #define NBLK_ONLYVALID 0x80000000 /* only return cached buffer */ | |
91447636 A |
175 | |
176 | /* These flags are used for nfsbuf iterating */ | |
0a7de745 A |
177 | #define NBI_ITER 0x01 /* iteration in progress */ |
178 | #define NBI_ITERWANT 0x02 /* waiting to iterate */ | |
179 | #define NBI_CLEAN 0x04 /* requesting clean buffers */ | |
180 | #define NBI_DIRTY 0x08 /* requesting dirty buffers */ | |
181 | #define NBI_NOWAIT 0x10 /* don't block on NBI_ITER */ | |
91447636 A |
182 | |
183 | /* Flags for nfs_buf_acquire */ | |
0a7de745 A |
184 | #define NBAC_NOWAIT 0x01 /* Don't wait if buffer is busy */ |
185 | #define NBAC_REMOVE 0x02 /* Remove from free list once buffer is acquired */ | |
91447636 | 186 | |
f427ee49 A |
187 | /* macros for nfsbufpgs */ |
188 | #define NBPGS_STRUCT_SIZE sizeof(nfsbufpgs) | |
189 | #define NBPGS_ELEMENT_SIZE sizeof(((nfsbufpgs *)0)->pages[0]) | |
190 | #define NBPGS_ELEMENT_PAGES (8 * NBPGS_ELEMENT_SIZE) | |
191 | #define NBPGS_ELEMENTS (NBPGS_STRUCT_SIZE / NBPGS_ELEMENT_SIZE) | |
192 | #define NBPGS_ERASE(NFSBP) bzero((NFSBP), NBPGS_STRUCT_SIZE) | |
193 | #define NBPGS_COPY(NFSBPDST, NFSBPSRC) memcpy((NFSBPDST), (NFSBPSRC), NBPGS_STRUCT_SIZE) | |
194 | #define NBPGS_IS_EQUAL(NFSBP1, NFSBP2) (memcmp((NFSBP1), (NFSBP2), NBPGS_STRUCT_SIZE) == 0) | |
195 | #define NBPGS_GET(NFSBP, P) ((NFSBP)->pages[((P)/NBPGS_ELEMENT_PAGES)] & (1LLU << ((P) % NBPGS_ELEMENT_PAGES))) | |
196 | #define NBPGS_SET(NFSBP, P) ((NFSBP)->pages[((P)/NBPGS_ELEMENT_PAGES)] |= (1LLU << ((P) % NBPGS_ELEMENT_PAGES))) | |
197 | #define NBPGS_UNSET(NFSBP, P) ((NFSBP)->pages[((P)/NBPGS_ELEMENT_PAGES)] &= ~(1LLU << ((P) % NBPGS_ELEMENT_PAGES))) | |
198 | ||
91447636 | 199 | /* some convenience macros... */ |
0a7de745 | 200 | #define NBOFF(BP) ((off_t)(BP)->nb_lblkno * (off_t)(BP)->nb_bufsize) |
f427ee49 A |
201 | #define NBPGVALID(BP, P) NBPGS_GET(&((BP)->nb_valid), (P)) |
202 | #define NBPGDIRTY(BP, P) NBPGS_GET(&((BP)->nb_dirty), (P)) | |
203 | #define NBPGVALID_SET(BP, P) NBPGS_SET(&((BP)->nb_valid), (P)) | |
204 | #define NBPGDIRTY_SET(BP, P) NBPGS_SET(&((BP)->nb_dirty), (P)) | |
55e303ae | 205 | |
0a7de745 A |
206 | #define NBUFSTAMPVALID(BP) ((BP)->nb_timestamp != ~0) |
207 | #define NBUFSTAMPINVALIDATE(BP) ((BP)->nb_timestamp = ~0) | |
91447636 | 208 | |
55e303ae A |
209 | #define NFS_BUF_MAP(BP) \ |
210 | do { \ | |
0a7de745 A |
211 | if (!(BP)->nb_data && nfs_buf_map(BP)) \ |
212 | panic("nfs_buf_map failed"); \ | |
55e303ae A |
213 | } while (0) |
214 | ||
215 | LIST_HEAD(nfsbuflists, nfsbuf); | |
216 | TAILQ_HEAD(nfsbuffreehead, nfsbuf); | |
217 | ||
c3c9b80d | 218 | extern lck_mtx_t nfs_buf_mutex; |
39236c6e A |
219 | extern int nfsbufcnt, nfsbufmin, nfsbufmax, nfsbufmetacnt, nfsbufmetamax; |
220 | extern int nfsbuffreecnt, nfsbuffreemetacnt, nfsbufdelwricnt, nfsneedbuffer; | |
221 | extern int nfs_nbdwrite; | |
222 | extern struct nfsbuffreehead nfsbuffree, nfsbufdelwri; | |
55e303ae | 223 | |
2d21ac55 A |
224 | #ifdef NFSBUFDEBUG |
225 | #define NFSBUFCNTCHK() \ | |
55e303ae A |
226 | do { \ |
227 | if ( (nfsbufcnt < 0) || \ | |
0a7de745 A |
228 | (nfsbufcnt > nfsbufmax) || \ |
229 | (nfsbufmetacnt < 0) || \ | |
230 | (nfsbufmetacnt > nfsbufmetamax) || \ | |
231 | (nfsbufmetacnt > nfsbufcnt) || \ | |
232 | (nfsbuffreecnt < 0) || \ | |
233 | (nfsbuffreecnt > nfsbufmax) || \ | |
234 | (nfsbuffreecnt > nfsbufcnt) || \ | |
235 | (nfsbuffreemetacnt < 0) || \ | |
236 | (nfsbuffreemetacnt > nfsbufmax) || \ | |
237 | (nfsbuffreemetacnt > nfsbufcnt) || \ | |
238 | (nfsbuffreemetacnt > nfsbufmetamax) || \ | |
239 | (nfsbuffreemetacnt > nfsbufmetacnt) || \ | |
240 | (nfsbufdelwricnt < 0) || \ | |
241 | (nfsbufdelwricnt > nfsbufmax) || \ | |
242 | (nfsbufdelwricnt > nfsbufcnt) || \ | |
243 | (nfs_nbdwrite < 0) || \ | |
244 | (nfs_nbdwrite > nfsbufcnt) || \ | |
245 | 0) \ | |
246 | panic("nfsbuf count error: max %d meta %d cnt %d meta %d free %d meta %d delwr %d bdw %d\n", \ | |
247 | nfsbufmax, nfsbufmetamax, nfsbufcnt, nfsbufmetacnt, nfsbuffreecnt, nfsbuffreemetacnt, \ | |
248 | nfsbufdelwricnt, nfs_nbdwrite); \ | |
2d21ac55 A |
249 | } while (0) |
250 | #else | |
251 | #define NFSBUFCNTCHK() | |
252 | #endif | |
253 | ||
b0d623f7 A |
254 | /* |
255 | * NFS directory buffer | |
256 | * | |
257 | * Each buffer for a directory consists of: | |
258 | * | |
259 | * - a small header | |
260 | * - a packed list of direntry structures | |
261 | * (if RDIRPLUS is enabled, a file handle and attrstamp are | |
262 | * packed after the direntry name.) | |
263 | * - free/unused space | |
264 | * - if RDIRPLUS is enabled, an array of attributes | |
265 | * that is indexed backwards from the end of the buffer. | |
266 | */ | |
267 | struct nfs_dir_buf_header { | |
0a7de745 A |
268 | uint16_t ndbh_flags; /* flags (see below) */ |
269 | uint16_t ndbh_count; /* # of entries */ | |
f427ee49 | 270 | off_t ndbh_entry_end; /* end offset of direntry data */ |
0a7de745 A |
271 | uint32_t ndbh_ncgen; /* name cache generation# */ |
272 | uint32_t ndbh_pad; /* reserved */ | |
b0d623f7 A |
273 | }; |
274 | /* ndbh_flags */ | |
0a7de745 A |
275 | #define NDB_FULL 0x0001 /* buffer has been filled */ |
276 | #define NDB_EOF 0x0002 /* buffer contains EOF */ | |
277 | #define NDB_PLUS 0x0004 /* buffer contains RDIRPLUS data */ | |
b0d623f7 A |
278 | |
279 | #define NFS_DIR_BUF_FIRST_DIRENTRY(BP) \ | |
280 | ((struct direntry*)((char*)((BP)->nb_data) + sizeof(*ndbhp))) | |
281 | #define NFS_DIR_BUF_NVATTR(BP, IDX) \ | |
282 | (&((struct nfs_vattr*)((char*)((BP)->nb_data) + (BP)->nb_bufsize))[-((IDX)+1)]) | |
283 | #define NFS_DIRENTRY_LEN(namlen) \ | |
284 | ((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 7) & ~7) | |
f427ee49 A |
285 | #define NFS_DIRENTRY_LEN_16(namlen) \ |
286 | (uint16_t)(NFS_DIRENTRY_LEN(namlen)); assert((namlen) <= UINT16_MAX); | |
b0d623f7 A |
287 | #define NFS_DIRENT_LEN(namlen) \ |
288 | ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen) + 1 + 3) &~ 3)) | |
289 | #define NFS_DIRENTRY_NEXT(DP) \ | |
290 | ((struct direntry*)((char*)(DP) + (DP)->d_reclen)) | |
291 | #define NFS_DIR_COOKIE_POTENTIALLY_TRUNCATED(C) \ | |
292 | ((C) && ((((C) >> 32) == 0) || (((C) & 0x80000000ULL) && (((C) >> 32) == 0xffffffff)))) | |
293 | #define NFS_DIR_COOKIE_SAME32(C1, C2) \ | |
294 | (((C1) & 0xffffffffULL) == ((C2) & 0xffffffffULL)) | |
295 | ||
296 | /* | |
297 | * NFS directory cookie cache | |
298 | * | |
299 | * This structure is used to cache cookie-to-buffer mappings for | |
300 | * cookies recently returned from READDIR. The entries are kept in an | |
301 | * array. The most-recently-used (MRU) list is headed by the entry at | |
302 | * index "mru". The index of the next entry in the list is kept in the | |
303 | * "next" array. (An index value of -1 marks an invalid entry.) | |
304 | */ | |
0a7de745 | 305 | #define NFSNUMCOOKIES 14 |
b0d623f7 | 306 | struct nfsdmap { |
0a7de745 A |
307 | int8_t free; /* next unused slot */ |
308 | int8_t mru; /* head of MRU list */ | |
309 | int8_t next[NFSNUMCOOKIES]; /* MRU list links */ | |
b0d623f7 | 310 | struct { |
0a7de745 A |
311 | uint64_t key; /* cookie */ |
312 | uint64_t lbn; /* lbn of buffer */ | |
313 | } cookies[NFSNUMCOOKIES]; /* MRU list entries */ | |
b0d623f7 A |
314 | }; |
315 | ||
2d21ac55 A |
316 | /* |
317 | * NFS vnode attribute structure | |
318 | */ | |
0a7de745 A |
319 | #define NFSTIME_ACCESS 0 /* time of last access */ |
320 | #define NFSTIME_MODIFY 1 /* time of last modification */ | |
321 | #define NFSTIME_CHANGE 2 /* time file changed */ | |
322 | #define NFSTIME_CREATE 3 /* time file created */ | |
323 | #define NFSTIME_BACKUP 4 /* time of last backup */ | |
cb323159 A |
324 | #define NFSTIME_ADDED 5 /* time added (FPnfs only) */ |
325 | #define NFSTIME_COUNT 6 | |
2d21ac55 A |
326 | |
327 | #define NFS_COMPARE_MTIME(TVP, NVAP, CMP) \ | |
0a7de745 A |
328 | (((TVP)->tv_sec == (NVAP)->nva_timesec[NFSTIME_MODIFY]) ? \ |
329 | ((TVP)->tv_nsec CMP (NVAP)->nva_timensec[NFSTIME_MODIFY]) : \ | |
2d21ac55 A |
330 | ((TVP)->tv_sec CMP (NVAP)->nva_timesec[NFSTIME_MODIFY])) |
331 | #define NFS_COPY_TIME(TVP, NVAP, WHICH) \ | |
332 | do { \ | |
333 | (TVP)->tv_sec = (NVAP)->nva_timesec[NFSTIME_##WHICH]; \ | |
334 | (TVP)->tv_nsec = (NVAP)->nva_timensec[NFSTIME_##WHICH]; \ | |
55e303ae A |
335 | } while (0) |
336 | ||
91447636 | 337 | struct nfs_vattr { |
0a7de745 | 338 | enum vtype nva_type; /* vnode type (for create) */ |
f427ee49 | 339 | mode_t nva_mode; /* file's access mode (and type) */ |
0a7de745 A |
340 | uid_t nva_uid; /* owner user id */ |
341 | gid_t nva_gid; /* owner group id */ | |
342 | guid_t nva_uuuid; /* owner user UUID */ | |
343 | guid_t nva_guuid; /* owner group UUID */ | |
344 | kauth_acl_t nva_acl; /* access control list */ | |
345 | nfs_specdata nva_rawdev; /* device the special file represents */ | |
346 | uint32_t nva_flags; /* file flags (see below) */ | |
347 | uint32_t nva_maxlink; /* maximum # of links (v4) */ | |
348 | uint64_t nva_nlink; /* number of references to file */ | |
349 | uint64_t nva_fileid; /* file id */ | |
350 | nfs_fsid nva_fsid; /* file system id */ | |
351 | uint64_t nva_size; /* file size in bytes */ | |
352 | uint64_t nva_bytes; /* bytes of disk space held by file */ | |
353 | uint64_t nva_change; /* change attribute */ | |
f427ee49 A |
354 | time_t nva_timesec[NFSTIME_COUNT]; |
355 | long nva_timensec[NFSTIME_COUNT]; | |
0a7de745 | 356 | uint32_t nva_bitmap[NFS_ATTR_BITMAP_LEN]; /* attributes that are valid */ |
cb323159 A |
357 | |
358 | /* FPnfs only. */ | |
359 | uint32_t nva_bsd_flags; /* BSD flags */ | |
360 | uint64_t nva_parentid; /* parent file id */ | |
361 | uint64_t nva_allocsize; /* size allocated on disk */ | |
91447636 A |
362 | }; |
363 | ||
6d2010ae | 364 | /* nva_flags */ |
0a7de745 A |
365 | #define NFS_FFLAG_ARCHIVED 0x0001 |
366 | #define NFS_FFLAG_HIDDEN 0x0002 | |
367 | #define NFS_FFLAG_HAS_NAMED_ATTRS 0x0004 /* file has named attributes */ | |
368 | #define NFS_FFLAG_TRIGGER 0x0008 /* node is a trigger/mirror mount point */ | |
369 | #define NFS_FFLAG_TRIGGER_REFERRAL 0x0010 /* trigger is a referral */ | |
f427ee49 A |
370 | #define NFS_FFLAG_PARTIAL_WRITE 0x0020 /* partial attribute for NFSv4 writes */ |
371 | #define NFS_FFLAG_FILEID_CONTAINS_XID 0x0040 /* xid might be stashed in nva_fileid is rdirplus is enabled */ | |
0a7de745 | 372 | #define NFS_FFLAG_IS_ATTR 0x8000 /* file is a named attribute file/directory */ |
cb323159 A |
373 | /* FPnfs only */ |
374 | #define NFS_FFLAG_FPNFS_BSD_FLAGS 0x01000000 | |
375 | #define NFS_FFLAG_FPNFS_PARENTID 0x02000000 | |
376 | #define NFS_FFLAG_FPNFS_ADDEDTIME 0x04000000 | |
2d21ac55 | 377 | |
b0d623f7 | 378 | /* flags for nfs_getattr() */ |
0a7de745 A |
379 | #define NGA_CACHED 0x0001 /* use cached attributes (if still valid) */ |
380 | #define NGA_UNCACHED 0x0002 /* fetch new attributes */ | |
381 | #define NGA_ACL 0x0004 /* fetch ACL */ | |
382 | #define NGA_MONITOR 0x0008 /* vnode monitor attr update poll */ | |
383 | #define NGA_SOFT 0x0010 /* use cached attributes if ETIMEOUT */ | |
6d2010ae A |
384 | |
385 | /* macros for initting/cleaning up nfs_vattr structures */ | |
0a7de745 | 386 | #define NVATTR_INIT(NVAP) \ |
6d2010ae | 387 | do { \ |
0a7de745 A |
388 | NFS_CLEAR_ATTRIBUTES((NVAP)->nva_bitmap); \ |
389 | (NVAP)->nva_flags = 0; \ | |
390 | (NVAP)->nva_acl = NULL; \ | |
6d2010ae | 391 | } while (0) |
0a7de745 | 392 | #define NVATTR_CLEANUP(NVAP) \ |
6d2010ae | 393 | do { \ |
0a7de745 A |
394 | NFS_CLEAR_ATTRIBUTES((NVAP)->nva_bitmap); \ |
395 | if ((NVAP)->nva_acl) { \ | |
396 | kauth_acl_free((NVAP)->nva_acl); \ | |
397 | (NVAP)->nva_acl = NULL; \ | |
398 | } \ | |
6d2010ae | 399 | } while (0) |
b0d623f7 | 400 | |
2d21ac55 A |
401 | /* |
402 | * macros for detecting node changes | |
403 | * | |
404 | * These macros help us determine if a file has been changed on the server and | |
405 | * thus whether or not we need to invalidate any cached data. | |
406 | * | |
407 | * For NFSv2/v3, the modification time is used. | |
408 | * For NFSv4, the change attribute is used. | |
409 | */ | |
410 | #define NFS_CHANGED(VERS, NP, NVAP) \ | |
0a7de745 A |
411 | (((VERS) >= NFS_VER4) ? \ |
412 | ((NP)->n_change != (NVAP)->nva_change) : \ | |
413 | NFS_COMPARE_MTIME(&(NP)->n_mtime, (NVAP), !=)) | |
2d21ac55 | 414 | #define NFS_CHANGED_NC(VERS, NP, NVAP) \ |
0a7de745 A |
415 | (((VERS) >= NFS_VER4) ? \ |
416 | ((NP)->n_ncchange != (NVAP)->nva_change) : \ | |
417 | NFS_COMPARE_MTIME(&(NP)->n_ncmtime, (NVAP), !=)) | |
2d21ac55 A |
418 | #define NFS_CHANGED_UPDATE(VERS, NP, NVAP) \ |
419 | do { \ | |
0a7de745 A |
420 | if ((VERS) >= NFS_VER4) \ |
421 | (NP)->n_change = (NVAP)->nva_change; \ | |
422 | else \ | |
423 | NFS_COPY_TIME(&(NP)->n_mtime, (NVAP), MODIFY); \ | |
2d21ac55 A |
424 | } while (0) |
425 | #define NFS_CHANGED_UPDATE_NC(VERS, NP, NVAP) \ | |
426 | do { \ | |
0a7de745 A |
427 | if ((VERS) >= NFS_VER4) \ |
428 | (NP)->n_ncchange = (NVAP)->nva_change; \ | |
429 | else \ | |
430 | NFS_COPY_TIME(&(NP)->n_ncmtime, (NVAP), MODIFY); \ | |
2d21ac55 A |
431 | } while (0) |
432 | ||
b0d623f7 | 433 | |
c3c9b80d | 434 | extern lck_grp_t nfs_open_grp; |
39236c6e | 435 | extern uint32_t nfs_open_owner_seqnum, nfs_lock_owner_seqnum; |
b0d623f7 A |
436 | |
437 | /* | |
438 | * NFSv4 open owner structure - one per cred per mount | |
439 | */ | |
440 | struct nfs_open_owner { | |
0a7de745 A |
441 | TAILQ_ENTRY(nfs_open_owner) noo_link; /* List of open owners (on mount) */ |
442 | lck_mtx_t noo_lock; /* owner mutex */ | |
443 | struct nfsmount * noo_mount; /* NFS mount */ | |
444 | os_refcnt_t noo_refcnt; /* # outstanding references */ | |
445 | uint32_t noo_flags; /* see below */ | |
446 | kauth_cred_t noo_cred; /* credentials of open owner */ | |
447 | uint32_t noo_name; /* unique name used otw */ | |
448 | uint32_t noo_seqid; /* client-side sequence ID */ | |
449 | TAILQ_HEAD(, nfs_open_file) noo_opens; /* list of open files */ | |
b0d623f7 A |
450 | }; |
451 | /* noo_flags */ | |
0a7de745 A |
452 | #define NFS_OPEN_OWNER_LINK 0x1 /* linked into mount's open owner list */ |
453 | #define NFS_OPEN_OWNER_BUSY 0x2 /* open state-modifying operation in progress */ | |
454 | #define NFS_OPEN_OWNER_WANT 0x4 /* someone else wants to mark busy */ | |
b0d623f7 A |
455 | |
456 | /* | |
457 | * NFS open file structure - one per open owner per nfsnode | |
458 | */ | |
459 | struct nfs_open_file { | |
0a7de745 A |
460 | lck_mtx_t nof_lock; /* open file mutex */ |
461 | TAILQ_ENTRY(nfs_open_file) nof_link; /* list of open files */ | |
462 | TAILQ_ENTRY(nfs_open_file) nof_oolink; /* list of open owner's open files */ | |
463 | struct nfs_open_owner * nof_owner; /* open owner */ | |
464 | nfsnode_t nof_np; /* nfsnode this open is for */ | |
465 | nfs_stateid nof_stateid; /* open stateid */ | |
466 | thread_t nof_creator; /* thread that created file */ | |
467 | uint32_t nof_opencnt; /* open file count */ | |
468 | uint16_t nof_flags; /* see below */ | |
469 | uint8_t nof_access:4; /* access mode for this open */ | |
470 | uint8_t nof_deny:4; /* deny mode for this open */ | |
471 | uint8_t nof_mmap_access:4; /* mmap open access mode */ | |
472 | uint8_t nof_mmap_deny:4; /* mmap open deny mode */ | |
b0d623f7 | 473 | /* counts of access/deny mode open combinations */ |
0a7de745 A |
474 | uint32_t nof_r; /* read opens (deny none) */ |
475 | uint32_t nof_w; /* write opens (deny none) */ | |
476 | uint32_t nof_rw; /* read/write opens (deny none) */ | |
477 | uint32_t nof_r_dw; /* read deny-write opens */ | |
b0d623f7 | 478 | /* the rest of the counts have a max of 2 (1 for open + 1 for mmap) */ |
0a7de745 A |
479 | uint32_t nof_w_dw:2; /* write deny-write opens (max 2) */ |
480 | uint32_t nof_rw_dw:2; /* read/write deny-write opens (max 2) */ | |
481 | uint32_t nof_r_drw:2; /* read deny-read/write opens (max 2) */ | |
482 | uint32_t nof_w_drw:2; /* write deny-read/write opens (max 2) */ | |
483 | uint32_t nof_rw_drw:2; /* read/write deny-read/write opens (max 2) */ | |
6d2010ae | 484 | /* counts of DELEGATED access/deny mode open combinations */ |
0a7de745 A |
485 | uint32_t nof_d_w_dw:2; /* write deny-write opens (max 2) */ |
486 | uint32_t nof_d_rw_dw:2; /* read/write deny-write opens (max 2) */ | |
487 | uint32_t nof_d_r_drw:2; /* read deny-read/write opens (max 2) */ | |
488 | uint32_t nof_d_w_drw:2; /* write deny-read/write opens (max 2) */ | |
489 | uint32_t nof_d_rw_drw:2; /* read/write deny-read/write opens (max 2) */ | |
490 | uint32_t nof_d_r; /* read opens (deny none) */ | |
491 | uint32_t nof_d_w; /* write opens (deny none) */ | |
492 | uint32_t nof_d_rw; /* read/write opens (deny none) */ | |
493 | uint32_t nof_d_r_dw; /* read deny-write opens */ | |
b0d623f7 A |
494 | }; |
495 | /* nof_flags */ | |
0a7de745 A |
496 | #define NFS_OPEN_FILE_BUSY 0x0001 /* open state-modifying operation in progress */ |
497 | #define NFS_OPEN_FILE_WANT 0x0002 /* someone else wants to mark busy */ | |
498 | #define NFS_OPEN_FILE_CREATE 0x0004 /* has an open(RW) from a "CREATE" call */ | |
499 | #define NFS_OPEN_FILE_NEEDCLOSE 0x0008 /* has an open(R) from an (unopen) VNOP_READ or VNOP_MMAP call */ | |
500 | #define NFS_OPEN_FILE_SETATTR 0x0020 /* has an open(W) to perform a SETATTR(size) */ | |
501 | #define NFS_OPEN_FILE_POSIXLOCK 0x0040 /* server supports POSIX locking semantics */ | |
502 | #define NFS_OPEN_FILE_LOST 0x0080 /* open state has been lost */ | |
503 | #define NFS_OPEN_FILE_REOPEN 0x0100 /* file needs to be reopened */ | |
504 | #define NFS_OPEN_FILE_REOPENING 0x0200 /* file is being reopened */ | |
b0d623f7 A |
505 | |
506 | struct nfs_lock_owner; | |
507 | /* | |
508 | * NFS file lock | |
509 | * | |
510 | * Each lock request (pending or granted) has an | |
511 | * nfs_file_lock structure representing its state. | |
512 | */ | |
513 | struct nfs_file_lock { | |
0a7de745 A |
514 | TAILQ_ENTRY(nfs_file_lock) nfl_link; /* List of locks on nfsnode */ |
515 | TAILQ_ENTRY(nfs_file_lock) nfl_lolink; /* List of locks held by locker */ | |
516 | struct nfs_lock_owner * nfl_owner; /* lock owner that holds this lock */ | |
517 | uint64_t nfl_start; /* starting offset */ | |
518 | uint64_t nfl_end; /* ending offset (inclusive) */ | |
519 | uint32_t nfl_blockcnt; /* # locks blocked on this lock */ | |
520 | uint16_t nfl_flags; /* see below */ | |
f427ee49 | 521 | uint16_t nfl_type; /* lock type: read/write */ |
b0d623f7 A |
522 | }; |
523 | /* nfl_flags */ | |
0a7de745 A |
524 | #define NFS_FILE_LOCK_ALLOC 0x01 /* lock was allocated */ |
525 | #define NFS_FILE_LOCK_STYLE_POSIX 0x02 /* POSIX-style fcntl() lock */ | |
526 | #define NFS_FILE_LOCK_STYLE_FLOCK 0x04 /* flock(2)-style lock */ | |
527 | #define NFS_FILE_LOCK_STYLE_MASK 0x06 /* lock style mask */ | |
528 | #define NFS_FILE_LOCK_WAIT 0x08 /* may block on conflicting locks */ | |
529 | #define NFS_FILE_LOCK_BLOCKED 0x10 /* request is blocked */ | |
530 | #define NFS_FILE_LOCK_DEAD 0x20 /* lock (request) no longer exists */ | |
531 | #define NFS_FILE_LOCK_DELEGATED 0x40 /* lock acquired via delegation */ | |
b0d623f7 A |
532 | |
533 | TAILQ_HEAD(nfs_file_lock_queue, nfs_file_lock); | |
534 | ||
535 | /* | |
536 | * Calculate length of lock range given the endpoints. | |
537 | * Note that struct flock has "to EOF" reported as 0 but | |
538 | * the NFSv4 protocol has "to EOF" reported as UINT64_MAX. | |
539 | */ | |
0a7de745 A |
540 | #define NFS_FLOCK_LENGTH(S, E) (((E) == UINT64_MAX) ? 0 : ((E) - (S) + 1)) |
541 | #define NFS_LOCK_LENGTH(S, E) (((E) == UINT64_MAX) ? UINT64_MAX : ((E) - (S) + 1)) | |
b0d623f7 A |
542 | |
543 | /* | |
544 | * NFSv4 lock owner structure - per open owner per process per nfsnode | |
545 | * | |
546 | * A lock owner is a process + an nfsnode. | |
547 | * | |
548 | * Note that flock(2) locks technically should have the lock owner be | |
549 | * an fglob pointer instead of a process. However, implementing that | |
550 | * correctly would not be trivial. So, for now, flock(2) locks are | |
551 | * essentially treated like whole-file POSIX locks. | |
552 | */ | |
553 | struct nfs_lock_owner { | |
0a7de745 A |
554 | lck_mtx_t nlo_lock; /* owner mutex */ |
555 | TAILQ_ENTRY(nfs_lock_owner) nlo_link; /* List of lock owners (on nfsnode) */ | |
556 | struct nfs_open_owner * nlo_open_owner; /* corresponding open owner */ | |
557 | struct nfs_file_lock_queue nlo_locks; /* list of locks held */ | |
558 | struct nfs_file_lock nlo_alock; /* most lockers will only ever have one */ | |
559 | struct timeval nlo_pid_start; /* Start time of process id */ | |
560 | pid_t nlo_pid; /* lock-owning process ID */ | |
561 | os_refcnt_t nlo_refcnt; /* # outstanding references */ | |
562 | uint32_t nlo_flags; /* see below */ | |
563 | uint32_t nlo_name; /* unique name used otw */ | |
564 | uint32_t nlo_seqid; /* client-side sequence ID */ | |
565 | uint32_t nlo_stategenid; /* mount state generation ID */ | |
566 | nfs_stateid nlo_stateid; /* lock stateid */ | |
b0d623f7 A |
567 | }; |
568 | /* nlo_flags */ | |
0a7de745 A |
569 | #define NFS_LOCK_OWNER_LINK 0x1 /* linked into mount's lock owner list */ |
570 | #define NFS_LOCK_OWNER_BUSY 0x2 /* lock state-modifying operation in progress */ | |
571 | #define NFS_LOCK_OWNER_WANT 0x4 /* someone else wants to mark busy */ | |
b0d623f7 | 572 | |
1c79356b | 573 | /* |
2d21ac55 A |
574 | * The nfsnode is the NFS equivalent of an inode. |
575 | * There is a unique nfsnode for each NFS vnode. | |
1c79356b | 576 | * An nfsnode is 'named' by its file handle. (nget/nfs_node.c) |
1c79356b A |
577 | * NB: Hopefully the current order of the fields is such that everything will |
578 | * be well aligned and, therefore, tightly packed. | |
579 | */ | |
2d21ac55 | 580 | |
0a7de745 | 581 | #define NFS_ACCESS_CACHE_SIZE 3 |
2d21ac55 | 582 | |
1c79356b | 583 | struct nfsnode { |
0a7de745 A |
584 | lck_mtx_t n_lock; /* nfs node lock */ |
585 | lck_rw_t n_datalock; /* nfs node data lock */ | |
586 | void *n_datalockowner;/* nfs node data lock owner (exclusive) */ | |
587 | LIST_ENTRY(nfsnode) n_hash; /* Hash chain */ | |
588 | LIST_ENTRY(nfsnode) n_monlink; /* list of monitored nodes */ | |
589 | u_quad_t n_size; /* Current size of file */ | |
590 | u_quad_t n_newsize; /* new size of file (pending update) */ | |
591 | u_int64_t n_xid; /* last xid to loadattr */ | |
592 | struct nfs_vattr n_vattr; /* Vnode attribute cache */ | |
593 | time_t n_attrstamp; /* Attr. cache timestamp */ | |
594 | time_t n_aclstamp; /* ACL cache timestamp */ | |
595 | time_t n_evtstamp; /* last vnode event timestamp */ | |
596 | uint32_t n_events; /* pending vnode events */ | |
f427ee49 | 597 | uint32_t n_access[NFS_ACCESS_CACHE_SIZE + 1]; /* ACCESS cache */ |
0a7de745 A |
598 | uid_t n_accessuid[NFS_ACCESS_CACHE_SIZE]; /* credentials having access */ |
599 | time_t n_accessstamp[NFS_ACCESS_CACHE_SIZE]; /* access cache timestamp */ | |
ea3f0419 A |
600 | time_t n_rdirplusstamp_sof; /* Readdirplus sof timestamp */ |
601 | time_t n_rdirplusstamp_eof; /* Readdirplus eof timestamp */ | |
55e303ae | 602 | union { |
0a7de745 A |
603 | struct { |
604 | struct timespec n3_mtime; /* Prev modify time. */ | |
605 | struct timespec n3_ncmtime; /* namecache modify time. */ | |
606 | } v3; | |
607 | struct { | |
608 | uint64_t n4_change;/* prev change attribute */ | |
609 | uint64_t n4_ncchange;/* namecache change attribute */ | |
610 | u_char *n4_attrdirfh;/* associated attr directory fh */ | |
611 | struct timeval n4_lastio;/* time of most recent I/O on attr */ | |
612 | } v4; | |
2d21ac55 | 613 | } n_un4; |
0a7de745 A |
614 | vnode_t n_parent; /* this node's parent */ |
615 | u_char *n_fhp; /* NFS File Handle */ | |
616 | vnode_t n_vnode; /* associated vnode */ | |
617 | mount_t n_mount; /* associated mount (NHINIT) */ | |
618 | int n_error; /* Save write error value */ | |
1c79356b | 619 | union { |
0a7de745 A |
620 | struct timespec ns_atim; /* Special file times */ |
621 | struct timespec nl_rltim; /* Time of last readlink */ | |
622 | daddr64_t nf_lastread; /* last block# read from (for readahead) */ | |
623 | uint64_t nd_cookieverf; /* Cookie verifier (dir only) */ | |
1c79356b A |
624 | } n_un1; |
625 | union { | |
0a7de745 A |
626 | struct timespec ns_mtim; /* Special file times */ |
627 | daddr64_t nf_lastrahead; /* last block# read ahead */ | |
628 | uint64_t nd_eofcookie; /* Dir. EOF cookie cache */ | |
1c79356b A |
629 | } n_un2; |
630 | union { | |
2d21ac55 | 631 | struct nfs_sillyrename *nf_silly;/* Ptr to silly rename struct */ |
b0d623f7 | 632 | struct nfsdmap *nd_cookiecache; /* dir cookie cache */ |
1c79356b | 633 | } n_un3; |
0a7de745 | 634 | uint32_t n_flag; /* node flags */ |
f427ee49 | 635 | uint32_t n_fhsize; /* size in bytes, of fh */ |
0a7de745 A |
636 | u_short n_hflag; /* node hash flags */ |
637 | u_short n_bflag; /* node buffer flags */ | |
638 | u_short n_mflag; /* node mount flags */ | |
639 | u_char n_fh[NFS_SMALLFH];/* Small File Handle */ | |
640 | uint32_t n_auth; /* security flavor used for this node */ | |
641 | struct nfsbuflists n_cleanblkhd; /* clean blocklist head */ | |
642 | struct nfsbuflists n_dirtyblkhd; /* dirty blocklist head */ | |
b0d623f7 | 643 | union { |
0a7de745 A |
644 | int nf_wrbusy; /* # threads in write/fsync */ |
645 | uint32_t nd_ncgen; /* dir name cache generation# */ | |
b0d623f7 A |
646 | } n_un5; |
647 | union { | |
0a7de745 A |
648 | int nf_needcommitcnt;/* # bufs that need committing */ |
649 | daddr64_t nd_lastdbl; /* last dir buf lookup block# */ | |
b0d623f7 | 650 | } n_un6; |
0a7de745 | 651 | int n_bufiterflags; /* buf iterator flags */ |
6d2010ae | 652 | union { |
0a7de745 A |
653 | int nf_numoutput; /* write I/Os in progress */ |
654 | int nd_trigseq; /* vnode trigger seq# */ | |
6d2010ae | 655 | } n_un7; |
b0d623f7 | 656 | /* open state */ |
0a7de745 A |
657 | lck_mtx_t n_openlock; /* nfs node open lock */ |
658 | uint32_t n_openflags; /* open state flags */ | |
659 | uint32_t n_openrefcnt; /* # non-file opens */ | |
660 | TAILQ_HEAD(, nfs_open_file) n_opens; /* list of open files */ | |
b0d623f7 A |
661 | /* lock state */ |
662 | TAILQ_HEAD(, nfs_lock_owner) n_lock_owners; /* list of lock owners */ | |
0a7de745 | 663 | struct nfs_file_lock_queue n_locks; /* list of locks */ |
b0d623f7 | 664 | /* delegation state */ |
0a7de745 A |
665 | nfs_stateid n_dstateid; /* delegation stateid */ |
666 | TAILQ_ENTRY(nfsnode) n_dlink; /* delegation list link */ | |
667 | TAILQ_ENTRY(nfsnode) n_dreturn; /* delegation return list link */ | |
668 | struct kauth_ace n_dace; /* delegation ACE */ | |
1c79356b A |
669 | }; |
670 | ||
0a7de745 A |
671 | #define NFS_DATA_LOCK_SHARED 1 |
672 | #define NFS_DATA_LOCK_EXCLUSIVE 2 | |
2d21ac55 | 673 | |
0a7de745 A |
674 | #define nfstimespeccmp(tvp, uvp, cmp) \ |
675 | (((tvp)->tv_sec == (uvp)->tv_sec) ? \ | |
676 | ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \ | |
91447636 A |
677 | ((tvp)->tv_sec cmp (uvp)->tv_sec)) |
678 | ||
55e303ae A |
679 | #define CHECK_NEEDCOMMITCNT(np) \ |
680 | do { \ | |
0a7de745 A |
681 | if ((np)->n_needcommitcnt < 0) { \ |
682 | printf("nfs: n_needcommitcnt negative\n"); \ | |
683 | (np)->n_needcommitcnt = 0; \ | |
684 | } \ | |
55e303ae A |
685 | } while (0) |
686 | ||
0a7de745 A |
687 | #define n_atim n_un1.ns_atim |
688 | #define n_mtim n_un2.ns_mtim | |
689 | #define n_rltim n_un1.nl_rltim | |
690 | #define n_lastread n_un1.nf_lastread | |
691 | #define n_lastrahead n_un2.nf_lastrahead | |
692 | #define n_sillyrename n_un3.nf_silly | |
693 | #define n_wrbusy n_un5.nf_wrbusy | |
694 | #define n_needcommitcnt n_un6.nf_needcommitcnt | |
695 | #define n_numoutput n_un7.nf_numoutput | |
696 | #define n_cookieverf n_un1.nd_cookieverf | |
697 | #define n_eofcookie n_un2.nd_eofcookie | |
698 | #define n_cookiecache n_un3.nd_cookiecache | |
699 | #define n_ncgen n_un5.nd_ncgen | |
700 | #define n_lastdbl n_un6.nd_lastdbl | |
701 | #define n_trigseq n_un7.nd_trigseq | |
702 | #define n_mtime n_un4.v3.n3_mtime | |
703 | #define n_ncmtime n_un4.v3.n3_ncmtime | |
704 | #define n_change n_un4.v4.n4_change | |
705 | #define n_ncchange n_un4.v4.n4_ncchange | |
706 | #define n_attrdirfh n_un4.v4.n4_attrdirfh | |
707 | #define n_lastio n_un4.v4.n4_lastio | |
1c79356b A |
708 | |
709 | /* | |
710 | * Flags for n_flag | |
711 | */ | |
0a7de745 A |
712 | #define NUPDATESIZE 0x00001 /* size of file needs updating */ |
713 | #define NREVOKE 0x00002 /* node revoked */ | |
714 | #define NMODIFIED 0x00004 /* Might have a modified buffer in bio */ | |
715 | #define NWRITEERR 0x00008 /* Flag write errors so close will know */ | |
716 | #define NNEEDINVALIDATE 0x00010 /* need to call vinvalbuf() */ | |
717 | #define NGETATTRINPROG 0x00020 /* GETATTR RPC in progress */ | |
718 | #define NGETATTRWANT 0x00040 /* waiting for GETATTR RPC */ | |
719 | #define NACC 0x00100 /* Special file accessed */ | |
720 | #define NUPD 0x00200 /* Special file updated */ | |
721 | #define NCHG 0x00400 /* Special file times changed */ | |
722 | #define NNEGNCENTRIES 0x00800 /* directory has negative name cache entries */ | |
723 | #define NBUSY 0x01000 /* node is busy */ | |
724 | #define NBUSYWANT 0x02000 /* waiting on busy node */ | |
725 | #define NISDOTZFS 0x04000 /* a ".zfs" directory */ | |
726 | #define NISDOTZFSCHILD 0x08000 /* a child of a ".zfs" directory */ | |
727 | #define NISMAPPED 0x10000 /* node is mmapped */ | |
728 | #define NREFRESH 0x20000 /* node's fh needs to be refreshed */ | |
729 | #define NREFRESHWANT 0x40000 /* Waiting for fh to be refreshed */ | |
cb323159 | 730 | #define NDISARMTRIGGER 0x80000 /* Ignore node's mirror mount trigger */ |
1c79356b | 731 | |
2d21ac55 A |
732 | /* |
733 | * Flags for n_hflag | |
734 | * Note: protected by nfs_node_hash_mutex | |
735 | */ | |
0a7de745 A |
736 | #define NHHASHED 0x0001 /* node is in hash table */ |
737 | #define NHINIT 0x0002 /* node is being initialized */ | |
738 | #define NHLOCKED 0x0004 /* node is locked (initting or deleting) */ | |
739 | #define NHLOCKWANT 0x0008 /* someone wants to lock */ | |
2d21ac55 A |
740 | |
741 | /* | |
742 | * Flags for n_bflag | |
743 | * Note: protected by nfs_buf_mutex | |
744 | */ | |
0a7de745 A |
745 | #define NBFLUSHINPROG 0x0001 /* Avoid multiple calls to nfs_flush() */ |
746 | #define NBFLUSHWANT 0x0002 /* waiting for nfs_flush() to complete */ | |
747 | #define NBINVALINPROG 0x0004 /* Avoid multiple calls to nfs_vinvalbuf() */ | |
748 | #define NBINVALWANT 0x0008 /* waiting for nfs_vinvalbuf() to complete */ | |
2d21ac55 | 749 | |
6d2010ae A |
750 | /* |
751 | * Flags for n_mflag | |
752 | * Note: protected by nfsmount's nm_lock | |
753 | */ | |
0a7de745 A |
754 | #define NMMONSCANINPROG 0x0001 /* monitored node is currently updating attributes */ |
755 | #define NMMONSCANWANT 0x0002 /* waiting for attribute update to complete */ | |
6d2010ae | 756 | |
b0d623f7 A |
757 | /* |
758 | * n_openflags | |
759 | * Note: protected by n_openlock | |
760 | */ | |
0a7de745 A |
761 | #define N_OPENBUSY 0x0001 /* open state is busy - being updated */ |
762 | #define N_OPENWANT 0x0002 /* someone wants to mark busy */ | |
763 | #define N_DELEG_READ 0x0004 /* we have a read delegation */ | |
764 | #define N_DELEG_WRITE 0x0008 /* we have a write delegation */ | |
765 | #define N_DELEG_MASK 0x000c /* delegation mask */ | |
766 | #define N_DELEG_RETURN 0x0010 /* delegation queued for return */ | |
767 | #define N_DELEG_RETURNING 0x0020 /* delegation being returned */ | |
b0d623f7 | 768 | |
6d2010ae | 769 | /* attr/access/ACL cache timestamp macros */ |
0a7de745 A |
770 | #define NATTRVALID(np) ((np)->n_attrstamp != ~0) |
771 | #define NATTRINVALIDATE(np) ((np)->n_attrstamp = ~0) | |
772 | #define NACCESSVALID(np, slot) (((slot) >= 0) && ((slot) < NFS_ACCESS_CACHE_SIZE) && ((np)->n_accessstamp[(slot)] != ~0)) | |
6d2010ae | 773 | #define NACCESSINVALIDATE(np) \ |
2d21ac55 | 774 | do { \ |
0a7de745 A |
775 | int __i; \ |
776 | for (__i=0; __i < NFS_ACCESS_CACHE_SIZE; __i++) \ | |
777 | (np)->n_accessstamp[__i] = ~0; \ | |
778 | (np)->n_access[NFS_ACCESS_CACHE_SIZE] = 0; \ | |
2d21ac55 | 779 | } while (0) |
0a7de745 A |
780 | #define NACLVALID(np) ((np)->n_aclstamp != ~0) |
781 | #define NACLINVALIDATE(np) ((np)->n_aclstamp = ~0) | |
91447636 A |
782 | |
783 | /* | |
784 | * NFS-specific flags for nfs_vinvalbuf/nfs_flush | |
785 | */ | |
0a7de745 | 786 | #define V_IGNORE_WRITEERR 0x8000 |
91447636 A |
787 | |
788 | /* | |
789 | * Flags for nfs_nget() | |
790 | */ | |
0a7de745 A |
791 | #define NG_MARKROOT 0x0001 /* mark vnode as root of FS */ |
792 | #define NG_MAKEENTRY 0x0002 /* add name cache entry for vnode */ | |
793 | #define NG_NOCREATE 0x0004 /* don't create a new node, return existing one */ | |
91447636 | 794 | |
1c79356b A |
795 | /* |
796 | * Convert between nfsnode pointers and vnode pointers | |
797 | */ | |
0a7de745 A |
798 | #define VTONFS(vp) ((nfsnode_t)vnode_fsnode(vp)) |
799 | #define NFSTOV(np) ((np)->n_vnode) | |
91447636 A |
800 | |
801 | /* nfsnode hash table mutex */ | |
c3c9b80d | 802 | extern lck_mtx_t nfs_node_hash_mutex; |
1c79356b | 803 | |
6d2010ae A |
804 | /* |
805 | * printf-like helper macro that also outputs node name. | |
806 | */ | |
807 | #define NP(NP, FMT, ...) \ | |
808 | do { \ | |
0a7de745 A |
809 | const char *__vname = (NP) ? vnode_getname(NFSTOV(NP)) : NULL; \ |
810 | printf(FMT " %s\n", ##__VA_ARGS__, __vname ? __vname : "???"); \ | |
811 | if (__vname) vnode_putname(__vname); \ | |
6d2010ae A |
812 | } while (0) |
813 | ||
1c79356b | 814 | /* |
91447636 | 815 | * nfsiod structures |
1c79356b | 816 | */ |
2d21ac55 | 817 | struct nfsiod { |
0a7de745 A |
818 | TAILQ_ENTRY(nfsiod) niod_link; /* List of nfsiods */ |
819 | struct nfsmount * niod_nmp; /* mount point for this nfsiod */ | |
2d21ac55 A |
820 | }; |
821 | TAILQ_HEAD(nfsiodlist, nfsiod); | |
822 | TAILQ_HEAD(nfsiodmountlist, nfsmount); | |
39236c6e A |
823 | extern struct nfsiodlist nfsiodfree, nfsiodwork; |
824 | extern struct nfsiodmountlist nfsiodmounts; | |
c3c9b80d | 825 | extern lck_mtx_t nfsiod_mutex; |
1c79356b A |
826 | |
827 | #if defined(KERNEL) | |
fa4905b1 | 828 | |
91447636 | 829 | typedef int vnop_t(void *); |
0a7de745 A |
830 | extern vnop_t **fifo_nfsv2nodeop_p; |
831 | extern vnop_t **nfsv2_vnodeop_p; | |
cb323159 | 832 | extern vnop_t **fpnfs_vnodeop_p; |
0a7de745 | 833 | extern vnop_t **spec_nfsv2nodeop_p; |
cb323159 | 834 | #if CONFIG_NFS4 |
0a7de745 A |
835 | extern vnop_t **fifo_nfsv4nodeop_p; |
836 | extern vnop_t **nfsv4_vnodeop_p; | |
837 | extern vnop_t **spec_nfsv4nodeop_p; | |
cb323159 | 838 | #endif |
1c79356b A |
839 | /* |
840 | * Prototypes for NFS vnode operations | |
841 | */ | |
2d21ac55 | 842 | #define nfs_vnop_revoke nop_revoke |
0a7de745 A |
843 | int nfs_vnop_inactive(struct vnop_inactive_args *); |
844 | int nfs_vnop_reclaim(struct vnop_reclaim_args *); | |
2d21ac55 | 845 | |
b0d623f7 A |
846 | int nfs_node_lock(nfsnode_t); |
847 | int nfs_node_lock_internal(nfsnode_t, int); | |
848 | void nfs_node_lock_force(nfsnode_t); | |
849 | void nfs_node_unlock(nfsnode_t); | |
850 | int nfs_node_lock2(nfsnode_t, nfsnode_t); | |
851 | void nfs_node_unlock2(nfsnode_t, nfsnode_t); | |
852 | int nfs_node_set_busy(nfsnode_t, thread_t); | |
853 | int nfs_node_set_busy2(nfsnode_t, nfsnode_t, thread_t); | |
854 | int nfs_node_set_busy4(nfsnode_t, nfsnode_t, nfsnode_t, nfsnode_t, thread_t); | |
855 | void nfs_node_clear_busy(nfsnode_t); | |
856 | void nfs_node_clear_busy2(nfsnode_t, nfsnode_t); | |
857 | void nfs_node_clear_busy4(nfsnode_t, nfsnode_t, nfsnode_t, nfsnode_t); | |
2d21ac55 | 858 | void nfs_data_lock(nfsnode_t, int); |
b0d623f7 A |
859 | void nfs_data_lock_noupdate(nfsnode_t, int); |
860 | void nfs_data_lock_internal(nfsnode_t, int, int); | |
2d21ac55 | 861 | void nfs_data_unlock(nfsnode_t); |
b0d623f7 A |
862 | void nfs_data_unlock_noupdate(nfsnode_t); |
863 | void nfs_data_unlock_internal(nfsnode_t, int); | |
2d21ac55 | 864 | void nfs_data_update_size(nfsnode_t, int); |
1c79356b | 865 | |
91447636 | 866 | /* other stuff */ |
2d21ac55 | 867 | int nfs_removeit(struct nfs_sillyrename *); |
f427ee49 | 868 | int nfs_nget(mount_t, nfsnode_t, struct componentname *, u_char *, uint32_t, struct nfs_vattr *, u_int64_t *, uint32_t, int, nfsnode_t*); |
316670eb | 869 | int nfs_mount_is_dirty(mount_t); |
b0d623f7 A |
870 | void nfs_dir_cookie_cache(nfsnode_t, uint64_t, uint64_t); |
871 | int nfs_dir_cookie_to_lbn(nfsnode_t, uint64_t, int *, uint64_t *); | |
2d21ac55 | 872 | void nfs_invaldir(nfsnode_t); |
f427ee49 | 873 | uint64_t nfs_dir_buf_freespace(struct nfsbuf *, int); |
1c79356b | 874 | |
55e303ae A |
875 | /* nfsbuf functions */ |
876 | void nfs_nbinit(void); | |
2d21ac55 | 877 | void nfs_buf_timer(void *, void *); |
55e303ae | 878 | void nfs_buf_remfree(struct nfsbuf *); |
2d21ac55 A |
879 | boolean_t nfs_buf_is_incore(nfsnode_t, daddr64_t); |
880 | struct nfsbuf * nfs_buf_incore(nfsnode_t, daddr64_t); | |
b0d623f7 | 881 | int nfs_buf_get(nfsnode_t, daddr64_t, uint32_t, thread_t, int, struct nfsbuf **); |
55e303ae A |
882 | int nfs_buf_upl_setup(struct nfsbuf *bp); |
883 | void nfs_buf_upl_check(struct nfsbuf *bp); | |
2d21ac55 A |
884 | void nfs_buf_normalize_valid_range(nfsnode_t, struct nfsbuf *); |
885 | int nfs_buf_map(struct nfsbuf *); | |
483a1d10 | 886 | void nfs_buf_release(struct nfsbuf *, int); |
55e303ae A |
887 | int nfs_buf_iowait(struct nfsbuf *); |
888 | void nfs_buf_iodone(struct nfsbuf *); | |
2d21ac55 A |
889 | void nfs_buf_write_delayed(struct nfsbuf *); |
890 | void nfs_buf_check_write_verifier(nfsnode_t, struct nfsbuf *); | |
483a1d10 | 891 | void nfs_buf_freeup(int); |
91447636 A |
892 | void nfs_buf_refget(struct nfsbuf *bp); |
893 | void nfs_buf_refrele(struct nfsbuf *bp); | |
894 | void nfs_buf_drop(struct nfsbuf *); | |
895 | errno_t nfs_buf_acquire(struct nfsbuf *, int, int, int); | |
2d21ac55 A |
896 | int nfs_buf_iterprepare(nfsnode_t, struct nfsbuflists *, int); |
897 | void nfs_buf_itercomplete(nfsnode_t, struct nfsbuflists *, int); | |
898 | ||
f427ee49 A |
899 | void nfs_buf_pgs_get_page_mask(nfsbufpgs *, off_t); |
900 | void nfs_buf_pgs_bit_not(nfsbufpgs *); | |
901 | void nfs_buf_pgs_bit_and(nfsbufpgs *, nfsbufpgs *, nfsbufpgs *); | |
902 | void nfs_buf_pgs_set_pages_between(nfsbufpgs *, off_t, off_t); | |
903 | int nfs_buf_pgs_is_set(nfsbufpgs *); | |
904 | ||
b0d623f7 A |
905 | int nfs_bioread(nfsnode_t, uio_t, int, vfs_context_t); |
906 | int nfs_buf_readahead(nfsnode_t, int, daddr64_t *, daddr64_t, thread_t, kauth_cred_t); | |
2d21ac55 A |
907 | int nfs_buf_readdir(struct nfsbuf *, vfs_context_t); |
908 | int nfs_buf_read(struct nfsbuf *); | |
909 | void nfs_buf_read_finish(struct nfsbuf *); | |
910 | int nfs_buf_read_rpc(struct nfsbuf *, thread_t, kauth_cred_t); | |
911 | void nfs_buf_read_rpc_finish(struct nfsreq *); | |
912 | int nfs_buf_write(struct nfsbuf *); | |
913 | void nfs_buf_write_finish(struct nfsbuf *, thread_t, kauth_cred_t); | |
914 | int nfs_buf_write_rpc(struct nfsbuf *, int, thread_t, kauth_cred_t); | |
915 | void nfs_buf_write_rpc_finish(struct nfsreq *); | |
916 | int nfs_buf_write_dirty_pages(struct nfsbuf *, thread_t, kauth_cred_t); | |
917 | ||
918 | int nfs_flushcommits(nfsnode_t, int); | |
919 | int nfs_flush(nfsnode_t, int, thread_t, int); | |
b0d623f7 A |
920 | void nfs_buf_delwri_push(int); |
921 | void nfs_buf_delwri_service(void); | |
cb323159 | 922 | void nfs_buf_delwri_thread(void *, wait_result_t); |
2d21ac55 A |
923 | |
924 | int nfsiod_start(void); | |
b0d623f7 A |
925 | void nfsiod_terminate(struct nfsiod *); |
926 | void nfsiod_thread(void); | |
927 | int nfsiod_continue(int); | |
2d21ac55 A |
928 | void nfs_asyncio_finish(struct nfsreq *); |
929 | void nfs_asyncio_resend(struct nfsreq *); | |
b0d623f7 A |
930 | int nfs_async_write_start(struct nfsmount *); |
931 | void nfs_async_write_done(struct nfsmount *); | |
55e303ae | 932 | |
1c79356b A |
933 | #endif /* KERNEL */ |
934 | ||
9bccf70c A |
935 | #endif /* __APPLE_API_PRIVATE */ |
936 | #endif /* _NFS_NFSNODE_H_ */ |