2 * Copyright (c) 2000-2019 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
30 * Copyright (c) 1989, 1993
31 * The Regents of the University of California. All rights reserved.
33 * This code is derived from software contributed to Berkeley by
34 * Rick Macklem at The University of Guelph.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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.
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
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 $
69 #ifndef _NFS_NFSNODE_H_
70 #define _NFS_NFSNODE_H_
72 #include <sys/appleapiopts.h>
74 #ifdef __APPLE_API_PRIVATE
78 #include <sys/kauth.h>
79 #include <os/refcnt.h>
82 * Silly rename structure that hangs off the nfsnode until the name
83 * can be removed by nfs_vnop_inactive()
85 struct nfs_sillyrename
{
86 kauth_cred_t nsr_cred
;
87 struct nfsnode
*nsr_dnp
;
93 * The nfsbuf is the nfs equivalent to a struct buf.
96 LIST_ENTRY(nfsbuf
) nb_hash
; /* hash chain */
97 LIST_ENTRY(nfsbuf
) nb_vnbufs
; /* nfsnode's nfsbuf chain */
98 TAILQ_ENTRY(nfsbuf
) nb_free
; /* free list position if not active. */
99 volatile uint32_t nb_flags
; /* NB_* flags. */
100 volatile uint32_t nb_lflags
; /* NBL_* flags. */
101 os_refcnt_t nb_refs
; /* outstanding references. */
102 uint32_t nb_bufsize
; /* buffer size */
103 daddr64_t nb_lblkno
; /* logical block number. */
104 uint64_t nb_verf
; /* V3 write verifier */
105 int nb_commitlevel
; /* lowest write commit level */
106 time_t nb_timestamp
; /* buffer timestamp */
107 int nb_error
; /* errno value. */
108 u_int32_t nb_valid
; /* valid pages in buf */
109 u_int32_t nb_dirty
; /* dirty pages in buf */
110 int nb_validoff
; /* offset in buffer of valid region. */
111 int nb_validend
; /* offset of end of valid region. */
112 int nb_dirtyoff
; /* offset in buffer of dirty region. */
113 int nb_dirtyend
; /* offset of end of dirty region. */
114 int nb_offio
; /* offset in buffer of I/O region. */
115 int nb_endio
; /* offset of end of I/O region. */
116 int nb_rpcs
; /* Count of RPCs remaining for this buffer. */
117 caddr_t nb_data
; /* mapped buffer */
118 nfsnode_t nb_np
; /* nfsnode buffer belongs to */
119 kauth_cred_t nb_rcred
; /* read credentials reference */
120 kauth_cred_t nb_wcred
; /* write credentials reference */
121 void * nb_pagelist
; /* upl */
124 #define NFS_MAXBSIZE (32 * PAGE_SIZE) /* valid/dirty page masks limit buffer size */
126 #define NFS_A_LOT_OF_NEEDCOMMITS 256 /* max# uncommitted buffers for a node */
127 #define NFS_A_LOT_OF_DELAYED_WRITES MAX(nfsbufcnt/8,512) /* max# "delwri" buffers in system */
130 * These flags are kept in b_lflags...
131 * nfs_buf_mutex must be held before examining/updating
133 #define NBL_BUSY 0x00000001 /* I/O in progress. */
134 #define NBL_WANTED 0x00000002 /* Process wants this buffer. */
137 * These flags are kept in nb_flags and they're (purposefully)
138 * very similar to the B_* flags for struct buf.
139 * nfs_buf_mutex is not needed to examine/update these.
141 #define NB_STALEWVERF 0x00000001 /* write verifier changed on us */
142 #define NB_NEEDCOMMIT 0x00000002 /* buffer needs to be committed */
143 #define NB_ASYNC 0x00000004 /* Start I/O, do not wait. */
144 #define NB_CACHE 0x00000020 /* buffer data found in the cache */
145 #define NB_STABLE 0x00000040 /* write FILESYNC not UNSTABLE */
146 #define NB_DELWRI 0x00000080 /* delayed write: dirty range needs to be written */
147 #define NB_DONE 0x00000200 /* I/O completed. */
148 #define NB_EINTR 0x00000400 /* I/O was interrupted */
149 #define NB_ERROR 0x00000800 /* I/O error occurred. */
150 #define NB_INVAL 0x00002000 /* Does not contain valid info. */
151 #define NB_NCRDAHEAD 0x00004000 /* "nocache readahead" data */
152 #define NB_NOCACHE 0x00008000 /* Do not cache block after use. */
153 #define NB_WRITE 0x00000000 /* Write buffer (pseudo flag). */
154 #define NB_READ 0x00100000 /* Read buffer. */
155 #define NB_MULTASYNCRPC 0x00200000 /* multiple async RPCs issued for buffer */
156 #define NB_PAGELIST 0x00400000 /* Buffer describes pagelist I/O. */
157 #define NB_WRITEINPROG 0x01000000 /* Write in progress. */
158 #define NB_META 0x40000000 /* buffer contains meta-data. */
160 /* Flags for operation type in nfs_buf_get() */
161 #define NBLK_READ 0x00000001 /* buffer for read */
162 #define NBLK_WRITE 0x00000002 /* buffer for write */
163 #define NBLK_META 0x00000004 /* buffer for metadata */
164 #define NBLK_OPMASK 0x00000007 /* operation mask */
165 /* modifiers for above flags... */
166 #define NBLK_NOWAIT 0x40000000 /* don't wait on busy buffer */
167 #define NBLK_ONLYVALID 0x80000000 /* only return cached buffer */
169 /* These flags are used for nfsbuf iterating */
170 #define NBI_ITER 0x01 /* iteration in progress */
171 #define NBI_ITERWANT 0x02 /* waiting to iterate */
172 #define NBI_CLEAN 0x04 /* requesting clean buffers */
173 #define NBI_DIRTY 0x08 /* requesting dirty buffers */
174 #define NBI_NOWAIT 0x10 /* don't block on NBI_ITER */
176 /* Flags for nfs_buf_acquire */
177 #define NBAC_NOWAIT 0x01 /* Don't wait if buffer is busy */
178 #define NBAC_REMOVE 0x02 /* Remove from free list once buffer is acquired */
180 /* some convenience macros... */
181 #define NBOFF(BP) ((off_t)(BP)->nb_lblkno * (off_t)(BP)->nb_bufsize)
182 #define NBPGVALID(BP, P) (((BP)->nb_valid >> (P)) & 0x1)
183 #define NBPGDIRTY(BP, P) (((BP)->nb_dirty >> (P)) & 0x1)
184 #define NBPGVALID_SET(BP, P) ((BP)->nb_valid |= (1 << (P)))
185 #define NBPGDIRTY_SET(BP, P) ((BP)->nb_dirty |= (1 << (P)))
187 #define NBUFSTAMPVALID(BP) ((BP)->nb_timestamp != ~0)
188 #define NBUFSTAMPINVALIDATE(BP) ((BP)->nb_timestamp = ~0)
190 #define NFS_BUF_MAP(BP) \
192 if (!(BP)->nb_data && nfs_buf_map(BP)) \
193 panic("nfs_buf_map failed"); \
196 LIST_HEAD(nfsbuflists
, nfsbuf
);
197 TAILQ_HEAD(nfsbuffreehead
, nfsbuf
);
199 extern lck_mtx_t
*nfs_buf_mutex
;
200 extern int nfsbufcnt
, nfsbufmin
, nfsbufmax
, nfsbufmetacnt
, nfsbufmetamax
;
201 extern int nfsbuffreecnt
, nfsbuffreemetacnt
, nfsbufdelwricnt
, nfsneedbuffer
;
202 extern int nfs_nbdwrite
;
203 extern struct nfsbuffreehead nfsbuffree
, nfsbufdelwri
;
206 #define NFSBUFCNTCHK() \
208 if ( (nfsbufcnt < 0) || \
209 (nfsbufcnt > nfsbufmax) || \
210 (nfsbufmetacnt < 0) || \
211 (nfsbufmetacnt > nfsbufmetamax) || \
212 (nfsbufmetacnt > nfsbufcnt) || \
213 (nfsbuffreecnt < 0) || \
214 (nfsbuffreecnt > nfsbufmax) || \
215 (nfsbuffreecnt > nfsbufcnt) || \
216 (nfsbuffreemetacnt < 0) || \
217 (nfsbuffreemetacnt > nfsbufmax) || \
218 (nfsbuffreemetacnt > nfsbufcnt) || \
219 (nfsbuffreemetacnt > nfsbufmetamax) || \
220 (nfsbuffreemetacnt > nfsbufmetacnt) || \
221 (nfsbufdelwricnt < 0) || \
222 (nfsbufdelwricnt > nfsbufmax) || \
223 (nfsbufdelwricnt > nfsbufcnt) || \
224 (nfs_nbdwrite < 0) || \
225 (nfs_nbdwrite > nfsbufcnt) || \
227 panic("nfsbuf count error: max %d meta %d cnt %d meta %d free %d meta %d delwr %d bdw %d\n", \
228 nfsbufmax, nfsbufmetamax, nfsbufcnt, nfsbufmetacnt, nfsbuffreecnt, nfsbuffreemetacnt, \
229 nfsbufdelwricnt, nfs_nbdwrite); \
232 #define NFSBUFCNTCHK()
236 * NFS directory buffer
238 * Each buffer for a directory consists of:
241 * - a packed list of direntry structures
242 * (if RDIRPLUS is enabled, a file handle and attrstamp are
243 * packed after the direntry name.)
244 * - free/unused space
245 * - if RDIRPLUS is enabled, an array of attributes
246 * that is indexed backwards from the end of the buffer.
248 struct nfs_dir_buf_header
{
249 uint16_t ndbh_flags
; /* flags (see below) */
250 uint16_t ndbh_count
; /* # of entries */
251 uint32_t ndbh_entry_end
; /* end offset of direntry data */
252 uint32_t ndbh_ncgen
; /* name cache generation# */
253 uint32_t ndbh_pad
; /* reserved */
256 #define NDB_FULL 0x0001 /* buffer has been filled */
257 #define NDB_EOF 0x0002 /* buffer contains EOF */
258 #define NDB_PLUS 0x0004 /* buffer contains RDIRPLUS data */
260 #define NFS_DIR_BUF_FIRST_DIRENTRY(BP) \
261 ((struct direntry*)((char*)((BP)->nb_data) + sizeof(*ndbhp)))
262 #define NFS_DIR_BUF_NVATTR(BP, IDX) \
263 (&((struct nfs_vattr*)((char*)((BP)->nb_data) + (BP)->nb_bufsize))[-((IDX)+1)])
264 #define NFS_DIRENTRY_LEN(namlen) \
265 ((sizeof(struct direntry) + (namlen) - (MAXPATHLEN-1) + 7) & ~7)
266 #define NFS_DIRENT_LEN(namlen) \
267 ((sizeof(struct dirent) - (NAME_MAX+1)) + (((namlen) + 1 + 3) &~ 3))
268 #define NFS_DIRENTRY_NEXT(DP) \
269 ((struct direntry*)((char*)(DP) + (DP)->d_reclen))
270 #define NFS_DIR_COOKIE_POTENTIALLY_TRUNCATED(C) \
271 ((C) && ((((C) >> 32) == 0) || (((C) & 0x80000000ULL) && (((C) >> 32) == 0xffffffff))))
272 #define NFS_DIR_COOKIE_SAME32(C1, C2) \
273 (((C1) & 0xffffffffULL) == ((C2) & 0xffffffffULL))
276 * NFS directory cookie cache
278 * This structure is used to cache cookie-to-buffer mappings for
279 * cookies recently returned from READDIR. The entries are kept in an
280 * array. The most-recently-used (MRU) list is headed by the entry at
281 * index "mru". The index of the next entry in the list is kept in the
282 * "next" array. (An index value of -1 marks an invalid entry.)
284 #define NFSNUMCOOKIES 14
286 int8_t free
; /* next unused slot */
287 int8_t mru
; /* head of MRU list */
288 int8_t next
[NFSNUMCOOKIES
]; /* MRU list links */
290 uint64_t key
; /* cookie */
291 uint64_t lbn
; /* lbn of buffer */
292 } cookies
[NFSNUMCOOKIES
]; /* MRU list entries */
296 * NFS vnode attribute structure
298 #define NFSTIME_ACCESS 0 /* time of last access */
299 #define NFSTIME_MODIFY 1 /* time of last modification */
300 #define NFSTIME_CHANGE 2 /* time file changed */
301 #define NFSTIME_CREATE 3 /* time file created */
302 #define NFSTIME_BACKUP 4 /* time of last backup */
303 #define NFSTIME_ADDED 5 /* time added (FPnfs only) */
304 #define NFSTIME_COUNT 6
306 #define NFS_COMPARE_MTIME(TVP, NVAP, CMP) \
307 (((TVP)->tv_sec == (NVAP)->nva_timesec[NFSTIME_MODIFY]) ? \
308 ((TVP)->tv_nsec CMP (NVAP)->nva_timensec[NFSTIME_MODIFY]) : \
309 ((TVP)->tv_sec CMP (NVAP)->nva_timesec[NFSTIME_MODIFY]))
310 #define NFS_COPY_TIME(TVP, NVAP, WHICH) \
312 (TVP)->tv_sec = (NVAP)->nva_timesec[NFSTIME_##WHICH]; \
313 (TVP)->tv_nsec = (NVAP)->nva_timensec[NFSTIME_##WHICH]; \
317 enum vtype nva_type
; /* vnode type (for create) */
318 uint32_t nva_mode
; /* file's access mode (and type) */
319 uid_t nva_uid
; /* owner user id */
320 gid_t nva_gid
; /* owner group id */
321 guid_t nva_uuuid
; /* owner user UUID */
322 guid_t nva_guuid
; /* owner group UUID */
323 kauth_acl_t nva_acl
; /* access control list */
324 nfs_specdata nva_rawdev
; /* device the special file represents */
325 uint32_t nva_flags
; /* file flags (see below) */
326 uint32_t nva_maxlink
; /* maximum # of links (v4) */
327 uint64_t nva_nlink
; /* number of references to file */
328 uint64_t nva_fileid
; /* file id */
329 nfs_fsid nva_fsid
; /* file system id */
330 uint64_t nva_size
; /* file size in bytes */
331 uint64_t nva_bytes
; /* bytes of disk space held by file */
332 uint64_t nva_change
; /* change attribute */
333 int64_t nva_timesec
[NFSTIME_COUNT
];
334 int32_t nva_timensec
[NFSTIME_COUNT
];
335 uint32_t nva_bitmap
[NFS_ATTR_BITMAP_LEN
]; /* attributes that are valid */
338 uint32_t nva_bsd_flags
; /* BSD flags */
339 uint64_t nva_parentid
; /* parent file id */
340 uint64_t nva_allocsize
; /* size allocated on disk */
344 #define NFS_FFLAG_ARCHIVED 0x0001
345 #define NFS_FFLAG_HIDDEN 0x0002
346 #define NFS_FFLAG_HAS_NAMED_ATTRS 0x0004 /* file has named attributes */
347 #define NFS_FFLAG_TRIGGER 0x0008 /* node is a trigger/mirror mount point */
348 #define NFS_FFLAG_TRIGGER_REFERRAL 0x0010 /* trigger is a referral */
349 #define NFS_FFLAG_IS_ATTR 0x8000 /* file is a named attribute file/directory */
351 #define NFS_FFLAG_FPNFS_BSD_FLAGS 0x01000000
352 #define NFS_FFLAG_FPNFS_PARENTID 0x02000000
353 #define NFS_FFLAG_FPNFS_ADDEDTIME 0x04000000
355 /* flags for nfs_getattr() */
356 #define NGA_CACHED 0x0001 /* use cached attributes (if still valid) */
357 #define NGA_UNCACHED 0x0002 /* fetch new attributes */
358 #define NGA_ACL 0x0004 /* fetch ACL */
359 #define NGA_MONITOR 0x0008 /* vnode monitor attr update poll */
360 #define NGA_SOFT 0x0010 /* use cached attributes if ETIMEOUT */
362 /* macros for initting/cleaning up nfs_vattr structures */
363 #define NVATTR_INIT(NVAP) \
365 NFS_CLEAR_ATTRIBUTES((NVAP)->nva_bitmap); \
366 (NVAP)->nva_flags = 0; \
367 (NVAP)->nva_acl = NULL; \
369 #define NVATTR_CLEANUP(NVAP) \
371 NFS_CLEAR_ATTRIBUTES((NVAP)->nva_bitmap); \
372 if ((NVAP)->nva_acl) { \
373 kauth_acl_free((NVAP)->nva_acl); \
374 (NVAP)->nva_acl = NULL; \
379 * macros for detecting node changes
381 * These macros help us determine if a file has been changed on the server and
382 * thus whether or not we need to invalidate any cached data.
384 * For NFSv2/v3, the modification time is used.
385 * For NFSv4, the change attribute is used.
387 #define NFS_CHANGED(VERS, NP, NVAP) \
388 (((VERS) >= NFS_VER4) ? \
389 ((NP)->n_change != (NVAP)->nva_change) : \
390 NFS_COMPARE_MTIME(&(NP)->n_mtime, (NVAP), !=))
391 #define NFS_CHANGED_NC(VERS, NP, NVAP) \
392 (((VERS) >= NFS_VER4) ? \
393 ((NP)->n_ncchange != (NVAP)->nva_change) : \
394 NFS_COMPARE_MTIME(&(NP)->n_ncmtime, (NVAP), !=))
395 #define NFS_CHANGED_UPDATE(VERS, NP, NVAP) \
397 if ((VERS) >= NFS_VER4) \
398 (NP)->n_change = (NVAP)->nva_change; \
400 NFS_COPY_TIME(&(NP)->n_mtime, (NVAP), MODIFY); \
402 #define NFS_CHANGED_UPDATE_NC(VERS, NP, NVAP) \
404 if ((VERS) >= NFS_VER4) \
405 (NP)->n_ncchange = (NVAP)->nva_change; \
407 NFS_COPY_TIME(&(NP)->n_ncmtime, (NVAP), MODIFY); \
411 extern lck_grp_t
*nfs_open_grp
;
412 extern uint32_t nfs_open_owner_seqnum
, nfs_lock_owner_seqnum
;
415 * NFSv4 open owner structure - one per cred per mount
417 struct nfs_open_owner
{
418 TAILQ_ENTRY(nfs_open_owner
) noo_link
; /* List of open owners (on mount) */
419 lck_mtx_t noo_lock
; /* owner mutex */
420 struct nfsmount
* noo_mount
; /* NFS mount */
421 os_refcnt_t noo_refcnt
; /* # outstanding references */
422 uint32_t noo_flags
; /* see below */
423 kauth_cred_t noo_cred
; /* credentials of open owner */
424 uint32_t noo_name
; /* unique name used otw */
425 uint32_t noo_seqid
; /* client-side sequence ID */
426 TAILQ_HEAD(, nfs_open_file
) noo_opens
; /* list of open files */
429 #define NFS_OPEN_OWNER_LINK 0x1 /* linked into mount's open owner list */
430 #define NFS_OPEN_OWNER_BUSY 0x2 /* open state-modifying operation in progress */
431 #define NFS_OPEN_OWNER_WANT 0x4 /* someone else wants to mark busy */
434 * NFS open file structure - one per open owner per nfsnode
436 struct nfs_open_file
{
437 lck_mtx_t nof_lock
; /* open file mutex */
438 TAILQ_ENTRY(nfs_open_file
) nof_link
; /* list of open files */
439 TAILQ_ENTRY(nfs_open_file
) nof_oolink
; /* list of open owner's open files */
440 struct nfs_open_owner
* nof_owner
; /* open owner */
441 nfsnode_t nof_np
; /* nfsnode this open is for */
442 nfs_stateid nof_stateid
; /* open stateid */
443 thread_t nof_creator
; /* thread that created file */
444 uint32_t nof_opencnt
; /* open file count */
445 uint16_t nof_flags
; /* see below */
446 uint8_t nof_access
:4; /* access mode for this open */
447 uint8_t nof_deny
:4; /* deny mode for this open */
448 uint8_t nof_mmap_access
:4; /* mmap open access mode */
449 uint8_t nof_mmap_deny
:4; /* mmap open deny mode */
450 /* counts of access/deny mode open combinations */
451 uint32_t nof_r
; /* read opens (deny none) */
452 uint32_t nof_w
; /* write opens (deny none) */
453 uint32_t nof_rw
; /* read/write opens (deny none) */
454 uint32_t nof_r_dw
; /* read deny-write opens */
455 /* the rest of the counts have a max of 2 (1 for open + 1 for mmap) */
456 uint32_t nof_w_dw
:2; /* write deny-write opens (max 2) */
457 uint32_t nof_rw_dw
:2; /* read/write deny-write opens (max 2) */
458 uint32_t nof_r_drw
:2; /* read deny-read/write opens (max 2) */
459 uint32_t nof_w_drw
:2; /* write deny-read/write opens (max 2) */
460 uint32_t nof_rw_drw
:2; /* read/write deny-read/write opens (max 2) */
461 /* counts of DELEGATED access/deny mode open combinations */
462 uint32_t nof_d_w_dw
:2; /* write deny-write opens (max 2) */
463 uint32_t nof_d_rw_dw
:2; /* read/write deny-write opens (max 2) */
464 uint32_t nof_d_r_drw
:2; /* read deny-read/write opens (max 2) */
465 uint32_t nof_d_w_drw
:2; /* write deny-read/write opens (max 2) */
466 uint32_t nof_d_rw_drw
:2; /* read/write deny-read/write opens (max 2) */
467 uint32_t nof_d_r
; /* read opens (deny none) */
468 uint32_t nof_d_w
; /* write opens (deny none) */
469 uint32_t nof_d_rw
; /* read/write opens (deny none) */
470 uint32_t nof_d_r_dw
; /* read deny-write opens */
473 #define NFS_OPEN_FILE_BUSY 0x0001 /* open state-modifying operation in progress */
474 #define NFS_OPEN_FILE_WANT 0x0002 /* someone else wants to mark busy */
475 #define NFS_OPEN_FILE_CREATE 0x0004 /* has an open(RW) from a "CREATE" call */
476 #define NFS_OPEN_FILE_NEEDCLOSE 0x0008 /* has an open(R) from an (unopen) VNOP_READ or VNOP_MMAP call */
477 #define NFS_OPEN_FILE_SETATTR 0x0020 /* has an open(W) to perform a SETATTR(size) */
478 #define NFS_OPEN_FILE_POSIXLOCK 0x0040 /* server supports POSIX locking semantics */
479 #define NFS_OPEN_FILE_LOST 0x0080 /* open state has been lost */
480 #define NFS_OPEN_FILE_REOPEN 0x0100 /* file needs to be reopened */
481 #define NFS_OPEN_FILE_REOPENING 0x0200 /* file is being reopened */
483 struct nfs_lock_owner
;
487 * Each lock request (pending or granted) has an
488 * nfs_file_lock structure representing its state.
490 struct nfs_file_lock
{
491 TAILQ_ENTRY(nfs_file_lock
) nfl_link
; /* List of locks on nfsnode */
492 TAILQ_ENTRY(nfs_file_lock
) nfl_lolink
; /* List of locks held by locker */
493 struct nfs_lock_owner
* nfl_owner
; /* lock owner that holds this lock */
494 uint64_t nfl_start
; /* starting offset */
495 uint64_t nfl_end
; /* ending offset (inclusive) */
496 uint32_t nfl_blockcnt
; /* # locks blocked on this lock */
497 uint16_t nfl_flags
; /* see below */
498 uint8_t nfl_type
; /* lock type: read/write */
501 #define NFS_FILE_LOCK_ALLOC 0x01 /* lock was allocated */
502 #define NFS_FILE_LOCK_STYLE_POSIX 0x02 /* POSIX-style fcntl() lock */
503 #define NFS_FILE_LOCK_STYLE_FLOCK 0x04 /* flock(2)-style lock */
504 #define NFS_FILE_LOCK_STYLE_MASK 0x06 /* lock style mask */
505 #define NFS_FILE_LOCK_WAIT 0x08 /* may block on conflicting locks */
506 #define NFS_FILE_LOCK_BLOCKED 0x10 /* request is blocked */
507 #define NFS_FILE_LOCK_DEAD 0x20 /* lock (request) no longer exists */
508 #define NFS_FILE_LOCK_DELEGATED 0x40 /* lock acquired via delegation */
510 TAILQ_HEAD(nfs_file_lock_queue
, nfs_file_lock
);
513 * Calculate length of lock range given the endpoints.
514 * Note that struct flock has "to EOF" reported as 0 but
515 * the NFSv4 protocol has "to EOF" reported as UINT64_MAX.
517 #define NFS_FLOCK_LENGTH(S, E) (((E) == UINT64_MAX) ? 0 : ((E) - (S) + 1))
518 #define NFS_LOCK_LENGTH(S, E) (((E) == UINT64_MAX) ? UINT64_MAX : ((E) - (S) + 1))
521 * NFSv4 lock owner structure - per open owner per process per nfsnode
523 * A lock owner is a process + an nfsnode.
525 * Note that flock(2) locks technically should have the lock owner be
526 * an fglob pointer instead of a process. However, implementing that
527 * correctly would not be trivial. So, for now, flock(2) locks are
528 * essentially treated like whole-file POSIX locks.
530 struct nfs_lock_owner
{
531 lck_mtx_t nlo_lock
; /* owner mutex */
532 TAILQ_ENTRY(nfs_lock_owner
) nlo_link
; /* List of lock owners (on nfsnode) */
533 struct nfs_open_owner
* nlo_open_owner
; /* corresponding open owner */
534 struct nfs_file_lock_queue nlo_locks
; /* list of locks held */
535 struct nfs_file_lock nlo_alock
; /* most lockers will only ever have one */
536 struct timeval nlo_pid_start
; /* Start time of process id */
537 pid_t nlo_pid
; /* lock-owning process ID */
538 os_refcnt_t nlo_refcnt
; /* # outstanding references */
539 uint32_t nlo_flags
; /* see below */
540 uint32_t nlo_name
; /* unique name used otw */
541 uint32_t nlo_seqid
; /* client-side sequence ID */
542 uint32_t nlo_stategenid
; /* mount state generation ID */
543 nfs_stateid nlo_stateid
; /* lock stateid */
546 #define NFS_LOCK_OWNER_LINK 0x1 /* linked into mount's lock owner list */
547 #define NFS_LOCK_OWNER_BUSY 0x2 /* lock state-modifying operation in progress */
548 #define NFS_LOCK_OWNER_WANT 0x4 /* someone else wants to mark busy */
551 * The nfsnode is the NFS equivalent of an inode.
552 * There is a unique nfsnode for each NFS vnode.
553 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
554 * NB: Hopefully the current order of the fields is such that everything will
555 * be well aligned and, therefore, tightly packed.
558 #define NFS_ACCESS_CACHE_SIZE 3
561 lck_mtx_t n_lock
; /* nfs node lock */
562 lck_rw_t n_datalock
; /* nfs node data lock */
563 void *n_datalockowner
;/* nfs node data lock owner (exclusive) */
564 LIST_ENTRY(nfsnode
) n_hash
; /* Hash chain */
565 LIST_ENTRY(nfsnode
) n_monlink
; /* list of monitored nodes */
566 u_quad_t n_size
; /* Current size of file */
567 u_quad_t n_newsize
; /* new size of file (pending update) */
568 u_int64_t n_xid
; /* last xid to loadattr */
569 struct nfs_vattr n_vattr
; /* Vnode attribute cache */
570 time_t n_attrstamp
; /* Attr. cache timestamp */
571 time_t n_aclstamp
; /* ACL cache timestamp */
572 time_t n_evtstamp
; /* last vnode event timestamp */
573 uint32_t n_events
; /* pending vnode events */
574 u_int8_t n_access
[NFS_ACCESS_CACHE_SIZE
+ 1]; /* ACCESS cache */
575 uid_t n_accessuid
[NFS_ACCESS_CACHE_SIZE
]; /* credentials having access */
576 time_t n_accessstamp
[NFS_ACCESS_CACHE_SIZE
]; /* access cache timestamp */
577 time_t n_rdirplusstamp_sof
; /* Readdirplus sof timestamp */
578 time_t n_rdirplusstamp_eof
; /* Readdirplus eof timestamp */
581 struct timespec n3_mtime
; /* Prev modify time. */
582 struct timespec n3_ncmtime
; /* namecache modify time. */
585 uint64_t n4_change
;/* prev change attribute */
586 uint64_t n4_ncchange
;/* namecache change attribute */
587 u_char
*n4_attrdirfh
;/* associated attr directory fh */
588 struct timeval n4_lastio
;/* time of most recent I/O on attr */
591 vnode_t n_parent
; /* this node's parent */
592 u_char
*n_fhp
; /* NFS File Handle */
593 vnode_t n_vnode
; /* associated vnode */
594 mount_t n_mount
; /* associated mount (NHINIT) */
595 int n_error
; /* Save write error value */
597 struct timespec ns_atim
; /* Special file times */
598 struct timespec nl_rltim
; /* Time of last readlink */
599 daddr64_t nf_lastread
; /* last block# read from (for readahead) */
600 uint64_t nd_cookieverf
; /* Cookie verifier (dir only) */
603 struct timespec ns_mtim
; /* Special file times */
604 daddr64_t nf_lastrahead
; /* last block# read ahead */
605 uint64_t nd_eofcookie
; /* Dir. EOF cookie cache */
608 struct nfs_sillyrename
*nf_silly
;/* Ptr to silly rename struct */
609 struct nfsdmap
*nd_cookiecache
; /* dir cookie cache */
611 uint32_t n_flag
; /* node flags */
612 u_short n_fhsize
; /* size in bytes, of fh */
613 u_short n_hflag
; /* node hash flags */
614 u_short n_bflag
; /* node buffer flags */
615 u_short n_mflag
; /* node mount flags */
616 u_char n_fh
[NFS_SMALLFH
];/* Small File Handle */
617 uint32_t n_auth
; /* security flavor used for this node */
618 struct nfsbuflists n_cleanblkhd
; /* clean blocklist head */
619 struct nfsbuflists n_dirtyblkhd
; /* dirty blocklist head */
621 int nf_wrbusy
; /* # threads in write/fsync */
622 uint32_t nd_ncgen
; /* dir name cache generation# */
625 int nf_needcommitcnt
;/* # bufs that need committing */
626 daddr64_t nd_lastdbl
; /* last dir buf lookup block# */
628 int n_bufiterflags
; /* buf iterator flags */
630 int nf_numoutput
; /* write I/Os in progress */
631 int nd_trigseq
; /* vnode trigger seq# */
634 lck_mtx_t n_openlock
; /* nfs node open lock */
635 uint32_t n_openflags
; /* open state flags */
636 uint32_t n_openrefcnt
; /* # non-file opens */
637 TAILQ_HEAD(, nfs_open_file
) n_opens
; /* list of open files */
639 TAILQ_HEAD(, nfs_lock_owner
) n_lock_owners
; /* list of lock owners */
640 struct nfs_file_lock_queue n_locks
; /* list of locks */
641 /* delegation state */
642 nfs_stateid n_dstateid
; /* delegation stateid */
643 TAILQ_ENTRY(nfsnode
) n_dlink
; /* delegation list link */
644 TAILQ_ENTRY(nfsnode
) n_dreturn
; /* delegation return list link */
645 struct kauth_ace n_dace
; /* delegation ACE */
648 #define NFS_DATA_LOCK_SHARED 1
649 #define NFS_DATA_LOCK_EXCLUSIVE 2
651 #define nfstimespeccmp(tvp, uvp, cmp) \
652 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
653 ((tvp)->tv_nsec cmp (uvp)->tv_nsec) : \
654 ((tvp)->tv_sec cmp (uvp)->tv_sec))
656 #define CHECK_NEEDCOMMITCNT(np) \
658 if ((np)->n_needcommitcnt < 0) { \
659 printf("nfs: n_needcommitcnt negative\n"); \
660 (np)->n_needcommitcnt = 0; \
664 #define n_atim n_un1.ns_atim
665 #define n_mtim n_un2.ns_mtim
666 #define n_rltim n_un1.nl_rltim
667 #define n_lastread n_un1.nf_lastread
668 #define n_lastrahead n_un2.nf_lastrahead
669 #define n_sillyrename n_un3.nf_silly
670 #define n_wrbusy n_un5.nf_wrbusy
671 #define n_needcommitcnt n_un6.nf_needcommitcnt
672 #define n_numoutput n_un7.nf_numoutput
673 #define n_cookieverf n_un1.nd_cookieverf
674 #define n_eofcookie n_un2.nd_eofcookie
675 #define n_cookiecache n_un3.nd_cookiecache
676 #define n_ncgen n_un5.nd_ncgen
677 #define n_lastdbl n_un6.nd_lastdbl
678 #define n_trigseq n_un7.nd_trigseq
679 #define n_mtime n_un4.v3.n3_mtime
680 #define n_ncmtime n_un4.v3.n3_ncmtime
681 #define n_change n_un4.v4.n4_change
682 #define n_ncchange n_un4.v4.n4_ncchange
683 #define n_attrdirfh n_un4.v4.n4_attrdirfh
684 #define n_lastio n_un4.v4.n4_lastio
689 #define NUPDATESIZE 0x00001 /* size of file needs updating */
690 #define NREVOKE 0x00002 /* node revoked */
691 #define NMODIFIED 0x00004 /* Might have a modified buffer in bio */
692 #define NWRITEERR 0x00008 /* Flag write errors so close will know */
693 #define NNEEDINVALIDATE 0x00010 /* need to call vinvalbuf() */
694 #define NGETATTRINPROG 0x00020 /* GETATTR RPC in progress */
695 #define NGETATTRWANT 0x00040 /* waiting for GETATTR RPC */
696 #define NACC 0x00100 /* Special file accessed */
697 #define NUPD 0x00200 /* Special file updated */
698 #define NCHG 0x00400 /* Special file times changed */
699 #define NNEGNCENTRIES 0x00800 /* directory has negative name cache entries */
700 #define NBUSY 0x01000 /* node is busy */
701 #define NBUSYWANT 0x02000 /* waiting on busy node */
702 #define NISDOTZFS 0x04000 /* a ".zfs" directory */
703 #define NISDOTZFSCHILD 0x08000 /* a child of a ".zfs" directory */
704 #define NISMAPPED 0x10000 /* node is mmapped */
705 #define NREFRESH 0x20000 /* node's fh needs to be refreshed */
706 #define NREFRESHWANT 0x40000 /* Waiting for fh to be refreshed */
707 #define NDISARMTRIGGER 0x80000 /* Ignore node's mirror mount trigger */
711 * Note: protected by nfs_node_hash_mutex
713 #define NHHASHED 0x0001 /* node is in hash table */
714 #define NHINIT 0x0002 /* node is being initialized */
715 #define NHLOCKED 0x0004 /* node is locked (initting or deleting) */
716 #define NHLOCKWANT 0x0008 /* someone wants to lock */
720 * Note: protected by nfs_buf_mutex
722 #define NBFLUSHINPROG 0x0001 /* Avoid multiple calls to nfs_flush() */
723 #define NBFLUSHWANT 0x0002 /* waiting for nfs_flush() to complete */
724 #define NBINVALINPROG 0x0004 /* Avoid multiple calls to nfs_vinvalbuf() */
725 #define NBINVALWANT 0x0008 /* waiting for nfs_vinvalbuf() to complete */
729 * Note: protected by nfsmount's nm_lock
731 #define NMMONSCANINPROG 0x0001 /* monitored node is currently updating attributes */
732 #define NMMONSCANWANT 0x0002 /* waiting for attribute update to complete */
736 * Note: protected by n_openlock
738 #define N_OPENBUSY 0x0001 /* open state is busy - being updated */
739 #define N_OPENWANT 0x0002 /* someone wants to mark busy */
740 #define N_DELEG_READ 0x0004 /* we have a read delegation */
741 #define N_DELEG_WRITE 0x0008 /* we have a write delegation */
742 #define N_DELEG_MASK 0x000c /* delegation mask */
743 #define N_DELEG_RETURN 0x0010 /* delegation queued for return */
744 #define N_DELEG_RETURNING 0x0020 /* delegation being returned */
746 /* attr/access/ACL cache timestamp macros */
747 #define NATTRVALID(np) ((np)->n_attrstamp != ~0)
748 #define NATTRINVALIDATE(np) ((np)->n_attrstamp = ~0)
749 #define NACCESSVALID(np, slot) (((slot) >= 0) && ((slot) < NFS_ACCESS_CACHE_SIZE) && ((np)->n_accessstamp[(slot)] != ~0))
750 #define NACCESSINVALIDATE(np) \
753 for (__i=0; __i < NFS_ACCESS_CACHE_SIZE; __i++) \
754 (np)->n_accessstamp[__i] = ~0; \
755 (np)->n_access[NFS_ACCESS_CACHE_SIZE] = 0; \
757 #define NACLVALID(np) ((np)->n_aclstamp != ~0)
758 #define NACLINVALIDATE(np) ((np)->n_aclstamp = ~0)
761 * NFS-specific flags for nfs_vinvalbuf/nfs_flush
763 #define V_IGNORE_WRITEERR 0x8000
766 * Flags for nfs_nget()
768 #define NG_MARKROOT 0x0001 /* mark vnode as root of FS */
769 #define NG_MAKEENTRY 0x0002 /* add name cache entry for vnode */
770 #define NG_NOCREATE 0x0004 /* don't create a new node, return existing one */
773 * Convert between nfsnode pointers and vnode pointers
775 #define VTONFS(vp) ((nfsnode_t)vnode_fsnode(vp))
776 #define NFSTOV(np) ((np)->n_vnode)
778 /* nfsnode hash table mutex */
779 extern lck_mtx_t
*nfs_node_hash_mutex
;
782 * printf-like helper macro that also outputs node name.
784 #define NP(NP, FMT, ...) \
786 const char *__vname = (NP) ? vnode_getname(NFSTOV(NP)) : NULL; \
787 printf(FMT " %s\n", ##__VA_ARGS__, __vname ? __vname : "???"); \
788 if (__vname) vnode_putname(__vname); \
795 TAILQ_ENTRY(nfsiod
) niod_link
; /* List of nfsiods */
796 struct nfsmount
* niod_nmp
; /* mount point for this nfsiod */
798 TAILQ_HEAD(nfsiodlist
, nfsiod
);
799 TAILQ_HEAD(nfsiodmountlist
, nfsmount
);
800 extern struct nfsiodlist nfsiodfree
, nfsiodwork
;
801 extern struct nfsiodmountlist nfsiodmounts
;
802 extern lck_mtx_t
*nfsiod_mutex
;
806 typedef int vnop_t(void *);
807 extern vnop_t
**fifo_nfsv2nodeop_p
;
808 extern vnop_t
**nfsv2_vnodeop_p
;
809 extern vnop_t
**fpnfs_vnodeop_p
;
810 extern vnop_t
**spec_nfsv2nodeop_p
;
812 extern vnop_t
**fifo_nfsv4nodeop_p
;
813 extern vnop_t
**nfsv4_vnodeop_p
;
814 extern vnop_t
**spec_nfsv4nodeop_p
;
817 * Prototypes for NFS vnode operations
819 #define nfs_vnop_revoke nop_revoke
820 int nfs_vnop_inactive(struct vnop_inactive_args
*);
821 int nfs_vnop_reclaim(struct vnop_reclaim_args
*);
823 int nfs_node_lock(nfsnode_t
);
824 int nfs_node_lock_internal(nfsnode_t
, int);
825 void nfs_node_lock_force(nfsnode_t
);
826 void nfs_node_unlock(nfsnode_t
);
827 int nfs_node_lock2(nfsnode_t
, nfsnode_t
);
828 void nfs_node_unlock2(nfsnode_t
, nfsnode_t
);
829 int nfs_node_set_busy(nfsnode_t
, thread_t
);
830 int nfs_node_set_busy2(nfsnode_t
, nfsnode_t
, thread_t
);
831 int nfs_node_set_busy4(nfsnode_t
, nfsnode_t
, nfsnode_t
, nfsnode_t
, thread_t
);
832 void nfs_node_clear_busy(nfsnode_t
);
833 void nfs_node_clear_busy2(nfsnode_t
, nfsnode_t
);
834 void nfs_node_clear_busy4(nfsnode_t
, nfsnode_t
, nfsnode_t
, nfsnode_t
);
835 void nfs_data_lock(nfsnode_t
, int);
836 void nfs_data_lock_noupdate(nfsnode_t
, int);
837 void nfs_data_lock_internal(nfsnode_t
, int, int);
838 void nfs_data_unlock(nfsnode_t
);
839 void nfs_data_unlock_noupdate(nfsnode_t
);
840 void nfs_data_unlock_internal(nfsnode_t
, int);
841 void nfs_data_update_size(nfsnode_t
, int);
844 int nfs_removeit(struct nfs_sillyrename
*);
845 int nfs_nget(mount_t
, nfsnode_t
, struct componentname
*, u_char
*, int, struct nfs_vattr
*, u_int64_t
*, uint32_t, int, nfsnode_t
*);
846 int nfs_mount_is_dirty(mount_t
);
847 void nfs_dir_cookie_cache(nfsnode_t
, uint64_t, uint64_t);
848 int nfs_dir_cookie_to_lbn(nfsnode_t
, uint64_t, int *, uint64_t *);
849 void nfs_invaldir(nfsnode_t
);
850 uint32_t nfs_dir_buf_freespace(struct nfsbuf
*, int);
852 /* nfsbuf functions */
853 void nfs_nbinit(void);
854 void nfs_buf_timer(void *, void *);
855 void nfs_buf_remfree(struct nfsbuf
*);
856 boolean_t
nfs_buf_is_incore(nfsnode_t
, daddr64_t
);
857 struct nfsbuf
* nfs_buf_incore(nfsnode_t
, daddr64_t
);
858 int nfs_buf_get(nfsnode_t
, daddr64_t
, uint32_t, thread_t
, int, struct nfsbuf
**);
859 int nfs_buf_upl_setup(struct nfsbuf
*bp
);
860 void nfs_buf_upl_check(struct nfsbuf
*bp
);
861 void nfs_buf_normalize_valid_range(nfsnode_t
, struct nfsbuf
*);
862 int nfs_buf_map(struct nfsbuf
*);
863 void nfs_buf_release(struct nfsbuf
*, int);
864 int nfs_buf_iowait(struct nfsbuf
*);
865 void nfs_buf_iodone(struct nfsbuf
*);
866 void nfs_buf_write_delayed(struct nfsbuf
*);
867 void nfs_buf_check_write_verifier(nfsnode_t
, struct nfsbuf
*);
868 void nfs_buf_freeup(int);
869 void nfs_buf_refget(struct nfsbuf
*bp
);
870 void nfs_buf_refrele(struct nfsbuf
*bp
);
871 void nfs_buf_drop(struct nfsbuf
*);
872 errno_t
nfs_buf_acquire(struct nfsbuf
*, int, int, int);
873 int nfs_buf_iterprepare(nfsnode_t
, struct nfsbuflists
*, int);
874 void nfs_buf_itercomplete(nfsnode_t
, struct nfsbuflists
*, int);
876 int nfs_bioread(nfsnode_t
, uio_t
, int, vfs_context_t
);
877 int nfs_buf_readahead(nfsnode_t
, int, daddr64_t
*, daddr64_t
, thread_t
, kauth_cred_t
);
878 int nfs_buf_readdir(struct nfsbuf
*, vfs_context_t
);
879 int nfs_buf_read(struct nfsbuf
*);
880 void nfs_buf_read_finish(struct nfsbuf
*);
881 int nfs_buf_read_rpc(struct nfsbuf
*, thread_t
, kauth_cred_t
);
882 void nfs_buf_read_rpc_finish(struct nfsreq
*);
883 int nfs_buf_write(struct nfsbuf
*);
884 void nfs_buf_write_finish(struct nfsbuf
*, thread_t
, kauth_cred_t
);
885 int nfs_buf_write_rpc(struct nfsbuf
*, int, thread_t
, kauth_cred_t
);
886 void nfs_buf_write_rpc_finish(struct nfsreq
*);
887 int nfs_buf_write_dirty_pages(struct nfsbuf
*, thread_t
, kauth_cred_t
);
889 int nfs_flushcommits(nfsnode_t
, int);
890 int nfs_flush(nfsnode_t
, int, thread_t
, int);
891 void nfs_buf_delwri_push(int);
892 void nfs_buf_delwri_service(void);
893 void nfs_buf_delwri_thread(void *, wait_result_t
);
895 int nfsiod_start(void);
896 void nfsiod_terminate(struct nfsiod
*);
897 void nfsiod_thread(void);
898 int nfsiod_continue(int);
899 void nfs_asyncio_finish(struct nfsreq
*);
900 void nfs_asyncio_resend(struct nfsreq
*);
901 int nfs_async_write_start(struct nfsmount
*);
902 void nfs_async_write_done(struct nfsmount
*);
906 #endif /* __APPLE_API_PRIVATE */
907 #endif /* _NFS_NFSNODE_H_ */