[apple/xnu.git] / bsd / nfs / nfsmount.h

/*
 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Rick Macklem at The University of Guelph.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)nfsmount.h	8.3 (Berkeley) 3/30/95
 * FreeBSD-Id: nfsmount.h,v 1.13 1997/08/16 19:16:05 wollman Exp $
 */


#ifndef _NFS_NFSMOUNT_H_
#define _NFS_NFSMOUNT_H_

#include <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE

/*
 * NFS mount file system attributes
 */
struct nfs_fsattr {
	uint32_t	nfsa_flags;		/* file system flags */
	uint32_t	nfsa_lease;		/* lease time in seconds */
	uint32_t	nfsa_maxname;		/* maximum filename size */
	uint32_t	nfsa_maxlink;		/* maximum # links */
	uint32_t	nfsa_bsize;		/* block size */
	uint32_t	nfsa_pad;		/* UNUSED */
	uint64_t	nfsa_maxfilesize;	/* maximum file size */
	uint64_t	nfsa_maxread;		/* maximum read size */
	uint64_t	nfsa_maxwrite;		/* maximum write size */
	uint64_t	nfsa_files_avail;	/* file slots available */
	uint64_t	nfsa_files_free;	/* file slots free */
	uint64_t	nfsa_files_total;	/* file slots total */
	uint64_t	nfsa_space_avail;	/* disk space available */
	uint64_t	nfsa_space_free;	/* disk space free */
	uint64_t	nfsa_space_total;	/* disk space total */
	uint32_t	nfsa_supp_attr[NFS_ATTR_BITMAP_LEN]; /* attributes supported on this file system */
	uint32_t	nfsa_bitmap[NFS_ATTR_BITMAP_LEN]; /* valid attributes */
};
#define NFS_FSFLAG_LINK			0x00000001
#define NFS_FSFLAG_SYMLINK		0x00000002
#define NFS_FSFLAG_UNIQUE_FH		0x00000004
#define NFS_FSFLAG_ACL			0x00000008
#define NFS_FSFLAG_SET_TIME		0x00000010
#define NFS_FSFLAG_CASE_INSENSITIVE	0x00000020
#define NFS_FSFLAG_CASE_PRESERVING	0x00000040
#define NFS_FSFLAG_CHOWN_RESTRICTED	0x00000080
#define NFS_FSFLAG_HOMOGENEOUS		0x00000100
#define NFS_FSFLAG_NO_TRUNC		0x00000200
#define NFS_FSFLAG_FHTYPE_MASK		0xFF000000
#define NFS_FSFLAG_FHTYPE_SHIFT		24

/*
 * function table for calling version-specific NFS functions
 */
struct nfs_funcs {
	int	(*nf_mount)(struct nfsmount *, vfs_context_t, struct user_nfs_args *, nfsnode_t *);
	int	(*nf_update_statfs)(struct nfsmount *, vfs_context_t);
	int	(*nf_getquota)(struct nfsmount *, vfs_context_t, uid_t, int, struct dqblk *);
	int	(*nf_access_rpc)(nfsnode_t, u_int32_t *, vfs_context_t);
	int	(*nf_getattr_rpc)(nfsnode_t, mount_t, u_char *, size_t, vfs_context_t, struct nfs_vattr *, u_int64_t *);
	int	(*nf_setattr_rpc)(nfsnode_t, struct vnode_attr *, vfs_context_t);
	int	(*nf_read_rpc_async)(nfsnode_t, off_t, size_t, thread_t, kauth_cred_t, struct nfsreq_cbinfo *, struct nfsreq **);
	int	(*nf_read_rpc_async_finish)(nfsnode_t, struct nfsreq *, uio_t, size_t *, int *);
	int	(*nf_readlink_rpc)(nfsnode_t, char *, uint32_t *, vfs_context_t);
	int	(*nf_write_rpc_async)(nfsnode_t, uio_t, size_t, thread_t, kauth_cred_t, int, struct nfsreq_cbinfo *, struct nfsreq **);
	int	(*nf_write_rpc_async_finish)(nfsnode_t, struct nfsreq *, int *, size_t *, uint64_t *);
	int	(*nf_commit_rpc)(nfsnode_t, uint64_t, uint64_t, kauth_cred_t);
	int	(*nf_lookup_rpc_async)(nfsnode_t, char *, int, vfs_context_t, struct nfsreq **);
	int	(*nf_lookup_rpc_async_finish)(nfsnode_t, vfs_context_t, struct nfsreq *, u_int64_t *, fhandle_t *, struct nfs_vattr *);
	int	(*nf_remove_rpc)(nfsnode_t, char *, int, thread_t, kauth_cred_t);
	int	(*nf_rename_rpc)(nfsnode_t, char *, int, nfsnode_t, char *, int, vfs_context_t);
};

/*
 * The long form of the NFSv4 client ID.
 */
struct nfs_client_id {
	TAILQ_ENTRY(nfs_client_id)	nci_link;	/* list of client IDs */
	char				*nci_id;	/* client id buffer */
	int				nci_idlen;	/* length of client id buffer */
};
TAILQ_HEAD(nfsclientidlist, nfs_client_id);
__private_extern__ struct nfsclientidlist nfsclientids;

/*
 * Mount structure.
 * One allocated on every NFS mount.
 * Holds NFS specific information for mount.
 */
struct nfsmount {
	lck_mtx_t nm_lock;		/* nfs mount lock */
	int	nm_flag;		/* Flags for soft/hard... */
	int	nm_state;		/* Internal state flags */
	int	nm_vers;		/* NFS version */
	struct nfs_funcs *nm_funcs;	/* version-specific functions */
	mount_t	nm_mountp;		/* VFS structure for this filesystem */
	nfsnode_t nm_dnp;		/* root directory nfsnode pointer */
	int	nm_numgrps;		/* Max. size of groupslist */
	TAILQ_HEAD(, nfs_gss_clnt_ctx) nm_gsscl; /* GSS user contexts */
	int	nm_timeo;		/* Init timer for NFSMNT_DUMBTIMR */
	int	nm_retry;		/* Max retries */
	uint32_t nm_rsize;		/* Max size of read rpc */
	uint32_t nm_wsize;		/* Max size of write rpc */
	uint32_t nm_biosize;		/* buffer I/O size */
	uint32_t nm_readdirsize;	/* Size of a readdir rpc */
	int	nm_readahead;		/* Num. of blocks to readahead */
	int	nm_acregmin;		/* reg file min attr cache timeout */
	int	nm_acregmax;		/* reg file max attr cache timeout */
	int	nm_acdirmin;		/* dir min attr cache timeout */
	int	nm_acdirmax;		/* dir max attr cache timeout */
	uint32_t nm_auth;		/* security mechanism flavor */
	/* mount info */
	uint32_t nm_fsattrstamp;	/* timestamp for fs attrs */
	struct nfs_fsattr nm_fsattr;	/* file system attributes */
	uint64_t nm_verf;		/* v3/v4 write verifier */
	union {
	    struct {			/* v2/v3 specific fields */
		u_short rqport;		/* cached rquota port */
		uint32_t rqportstamp;	/* timestamp of rquota port */
	    } v3;
	    struct {			/* v4 specific fields */
		struct nfs_client_id *longid; /* client ID, long form */
		uint64_t mounttime;	/* used as client ID verifier */
		uint64_t clientid;	/* client ID, short form */
		thread_call_t renew_timer; /* RENEW timer call */
		TAILQ_HEAD(, nfs_open_owner) open_owners; /* list of open owners */
		TAILQ_HEAD(, nfsnode) recallq; /* list of nodes with recalled delegations */
		TAILQ_ENTRY(nfsmount) cblink; /* chain of mounts registered for callbacks */
		uint32_t stateinuse;	/* state in use counter */
		uint32_t stategenid;	/* state generation counter */
		kauth_cred_t mcred;	/* credential used for the mount */
		uint32_t cbid;		/* callback channel identifier */
		uint32_t cbrefs;	/* # callbacks using this mount */
	    } v4;
	} nm_un;
	/* async I/O queue */
	struct nfs_reqqhead nm_resendq;	/* async I/O resend queue */
	struct nfs_reqqhead nm_iodq;	/* async I/O request queue */
	struct nfsiod *nm_niod;		/* nfsiod processing this mount */
	TAILQ_ENTRY(nfsmount) nm_iodlink; /* chain of mounts awaiting nfsiod */
	int	nm_asyncwrites;		/* outstanding async I/O writes */
	/* socket state */
	int	nm_sotype;		/* Type of socket */
	int	nm_soproto;		/* and protocol */
	mbuf_t	nm_nam;			/* Address of server */
	u_short nm_sockflags;		/* socket state flags */
	socket_t nm_so;			/* RPC socket */
	time_t	nm_deadto_start;	/* dead timeout start time */
	time_t	nm_reconnect_start;	/* reconnect start time */
	int	nm_tprintf_initial_delay;	/* delay first "server down" */
	int	nm_tprintf_delay;	/* delay between "server down" */
	int	nm_deadtimeout;		/* delay between first "server down" and dead */
	int	nm_srtt[4];		/* Timers for RPCs */
	int	nm_sdrtt[4];
	int	nm_timeouts;		/* Request timeouts */
	int	nm_jbreqs;		/* # R_JBTPRINTFMSG requests */
	union {
		struct {
			int sent;	/* Request send count */
			int cwnd;	/* Request congestion window */
			struct nfs_reqqhead cwndq; /* requests waiting on cwnd */
		} udp;
		struct {
			u_int32_t mleft;/* marker bytes remaining */
			u_int32_t fleft;/* fragment bytes remaining */
			u_int32_t len;	/* length of RPC record */
			mbuf_t m;	/* mbufs for current record */
			mbuf_t mlast;
		} tcp;
	} nm_sockstate;
	TAILQ_ENTRY(nfsmount) nm_pokeq;	/* mount poke queue chain */
	thread_t nm_sockthd;		/* socket thread for this mount */
};

/*
 * NFS mount state flags (nm_state)
 */
#define NFSSTA_BIGCOOKIES	0x00000800  /* have seen >32bit dir cookies */
#define NFSSTA_JUKEBOXTIMEO	0x00001000  /* experienced a jukebox timeout */
#define NFSSTA_LOCKTIMEO	0x00002000  /* experienced a lock req timeout */
#define NFSSTA_MOUNTED		0x00004000  /* completely mounted */
#define NFSSTA_LOCKSWORK	0x00008000  /* lock ops have worked. */
#define NFSSTA_TIMEO		0x00010000  /* experienced a timeout. */
#define NFSSTA_FORCE		0x00020000  /* doing a forced unmount. */
#define NFSSTA_HASWRITEVERF	0x00040000  /* Has write verifier for V3 */
#define NFSSTA_GOTPATHCONF	0x00080000  /* Got the V3 pathconf info */
#define NFSSTA_GOTFSINFO	0x00100000  /* Got the V3 fsinfo */
#define NFSSTA_SNDLOCK		0x01000000  /* Send socket lock */
#define NFSSTA_WANTSND		0x02000000  /* Want above */
#define NFSSTA_DEAD		0x04000000  /* mount is dead */
#define NFSSTA_RECOVER		0x08000000  /* mount state needs to be recovered */

/* flags for nm_sockflags */
#define NMSOCK_READY		0x0001	/* socket is ready for use */
#define NMSOCK_CONNECTING	0x0002	/* socket is being connect()ed */
#define NMSOCK_SETUP		0x0004	/* socket/connection is being set up */
#define NMSOCK_UNMOUNT		0x0008	/* unmounted, no more socket activity */
#define NMSOCK_LASTFRAG		0x0010	/* on last fragment of RPC record */
#define NMSOCK_POKE		0x0020	/* socket needs to be poked */
#define NMSOCK_UPCALL		0x0040	/* socket upcall in progress */

/* aliases for socket state variables */
#define nm_sent		nm_sockstate.udp.sent
#define nm_cwnd		nm_sockstate.udp.cwnd
#define nm_cwndq	nm_sockstate.udp.cwndq
#define nm_markerleft	nm_sockstate.tcp.mleft
#define nm_fragleft	nm_sockstate.tcp.fleft
#define nm_reclen	nm_sockstate.tcp.len
#define nm_m		nm_sockstate.tcp.m
#define nm_mlast	nm_sockstate.tcp.mlast

/* aliases for version-specific fields */
#define nm_rqport	nm_un.v3.rqport
#define nm_rqportstamp	nm_un.v3.rqportstamp
#define nm_longid	nm_un.v4.longid
#define nm_clientid	nm_un.v4.clientid
#define nm_mounttime	nm_un.v4.mounttime
#define nm_renew_timer	nm_un.v4.renew_timer
#define nm_open_owners	nm_un.v4.open_owners
#define nm_stateinuse	nm_un.v4.stateinuse
#define nm_stategenid	nm_un.v4.stategenid
#define nm_mcred	nm_un.v4.mcred
#define nm_cbid		nm_un.v4.cbid
#define nm_cblink	nm_un.v4.cblink
#define nm_cbrefs	nm_un.v4.cbrefs
#define nm_recallq	nm_un.v4.recallq

#if defined(KERNEL)
/*
 * Macros to convert from various things to mount structures.
 */
#define VFSTONFS(mp)	((mp) ? ((struct nfsmount *)vfs_fsprivate(mp)) : NULL)
#define VTONMP(vp)	VFSTONFS(vnode_mount(vp))
#define NFSTONMP(np)	VTONMP(NFSTOV(np))
#define NFSTOMP(np)	(vnode_mount(NFSTOV(np)))

#endif /* KERNEL */

#endif /* __APPLE_API_PRIVATE */
#endif /* _NFS_NFSMOUNT_H_ */
Commit	Line	Data
1c79356b	1	/*
b0d623f7	2	* Copyright (c) 2000-2009 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	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.
8f6c56a5	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.
	17	*
	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,
8f6c56a5 A	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.
8f6c56a5	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	* @(#)nfsmount.h 8.3 (Berkeley) 3/30/95
	65	* FreeBSD-Id: nfsmount.h,v 1.13 1997/08/16 19:16:05 wollman Exp $
	66	*/
	67
	68
	69	#ifndef _NFS_NFSMOUNT_H_
	70	#define _NFS_NFSMOUNT_H_
	71
9bccf70c A	72	#include <sys/appleapiopts.h>
	73
	74	#ifdef __APPLE_API_PRIVATE
2d21ac55 A	75
	76	/*
	77	* NFS mount file system attributes
	78	*/
	79	struct nfs_fsattr {
	80	uint32_t nfsa_flags; /* file system flags */
	81	uint32_t nfsa_lease; /* lease time in seconds */
	82	uint32_t nfsa_maxname; /* maximum filename size */
	83	uint32_t nfsa_maxlink; /* maximum # links */
	84	uint32_t nfsa_bsize; /* block size */
	85	uint32_t nfsa_pad; /* UNUSED */
	86	uint64_t nfsa_maxfilesize; /* maximum file size */
	87	uint64_t nfsa_maxread; /* maximum read size */
	88	uint64_t nfsa_maxwrite; /* maximum write size */
	89	uint64_t nfsa_files_avail; /* file slots available */
	90	uint64_t nfsa_files_free; /* file slots free */
	91	uint64_t nfsa_files_total; /* file slots total */
	92	uint64_t nfsa_space_avail; /* disk space available */
	93	uint64_t nfsa_space_free; /* disk space free */
	94	uint64_t nfsa_space_total; /* disk space total */
	95	uint32_t nfsa_supp_attr[NFS_ATTR_BITMAP_LEN]; /* attributes supported on this file system */
	96	uint32_t nfsa_bitmap[NFS_ATTR_BITMAP_LEN]; /* valid attributes */
	97	};
	98	#define NFS_FSFLAG_LINK 0x00000001
	99	#define NFS_FSFLAG_SYMLINK 0x00000002
	100	#define NFS_FSFLAG_UNIQUE_FH 0x00000004
	101	#define NFS_FSFLAG_ACL 0x00000008
	102	#define NFS_FSFLAG_SET_TIME 0x00000010
	103	#define NFS_FSFLAG_CASE_INSENSITIVE 0x00000020
	104	#define NFS_FSFLAG_CASE_PRESERVING 0x00000040
	105	#define NFS_FSFLAG_CHOWN_RESTRICTED 0x00000080
	106	#define NFS_FSFLAG_HOMOGENEOUS 0x00000100
	107	#define NFS_FSFLAG_NO_TRUNC 0x00000200
	108	#define NFS_FSFLAG_FHTYPE_MASK 0xFF000000
	109	#define NFS_FSFLAG_FHTYPE_SHIFT 24
	110
	111	/*
	112	* function table for calling version-specific NFS functions
	113	*/
	114	struct nfs_funcs {
	115	int (nf_mount)(struct nfsmount , vfs_context_t, struct user_nfs_args , nfsnode_t );
	116	int (nf_update_statfs)(struct nfsmount , vfs_context_t);
b0d623f7 A	117	int (nf_getquota)(struct nfsmount , vfs_context_t, uid_t, int, struct dqblk *);
b0d623f7 A	118	int (nf_access_rpc)(nfsnode_t, u_int32_t , vfs_context_t);
2d21ac55	119	int (nf_getattr_rpc)(nfsnode_t, mount_t, u_char , size_t, vfs_context_t, struct nfs_vattr , u_int64_t );
b0d623f7	120	int (nf_setattr_rpc)(nfsnode_t, struct vnode_attr , vfs_context_t);
2d21ac55	121	int (nf_read_rpc_async)(nfsnode_t, off_t, size_t, thread_t, kauth_cred_t, struct nfsreq_cbinfo , struct nfsreq **);
b0d623f7	122	int (nf_read_rpc_async_finish)(nfsnode_t, struct nfsreq , uio_t, size_t , int );
2d21ac55	123	int (nf_readlink_rpc)(nfsnode_t, char , uint32_t *, vfs_context_t);
b0d623f7	124	int (nf_write_rpc_async)(nfsnode_t, uio_t, size_t, thread_t, kauth_cred_t, int, struct nfsreq_cbinfo , struct nfsreq **);
2d21ac55 A	125	int (nf_write_rpc_async_finish)(nfsnode_t, struct nfsreq , int , size_t , uint64_t *);
	126	int (*nf_commit_rpc)(nfsnode_t, uint64_t, uint64_t, kauth_cred_t);
	127	int (nf_lookup_rpc_async)(nfsnode_t, char , int, vfs_context_t, struct nfsreq **);
	128	int (nf_lookup_rpc_async_finish)(nfsnode_t, vfs_context_t, struct nfsreq , u_int64_t , fhandle_t , struct nfs_vattr *);
	129	int (nf_remove_rpc)(nfsnode_t, char , int, thread_t, kauth_cred_t);
	130	int (nf_rename_rpc)(nfsnode_t, char , int, nfsnode_t, char *, int, vfs_context_t);
	131	};
	132
b0d623f7 A	133	/*
	134	* The long form of the NFSv4 client ID.
	135	*/
	136	struct nfs_client_id {
	137	TAILQ_ENTRY(nfs_client_id) nci_link; /* list of client IDs */
	138	char nci_id; / client id buffer */
	139	int nci_idlen; /* length of client id buffer */
	140	};
	141	TAILQ_HEAD(nfsclientidlist, nfs_client_id);
	142	__private_extern__ struct nfsclientidlist nfsclientids;
	143
1c79356b A	144	/*
	145	* Mount structure.
	146	* One allocated on every NFS mount.
	147	* Holds NFS specific information for mount.
	148	*/
2d21ac55 A	149	struct nfsmount {
2d21ac55 A	150	lck_mtx_t nm_lock; /* nfs mount lock */
1c79356b	151	int nm_flag; /* Flags for soft/hard... */
55e303ae	152	int nm_state; /* Internal state flags */
2d21ac55 A	153	int nm_vers; /* NFS version */
	154	struct nfs_funcs nm_funcs; / version-specific functions */
	155	mount_t nm_mountp; /* VFS structure for this filesystem */
	156	nfsnode_t nm_dnp; /* root directory nfsnode pointer */
1c79356b	157	int nm_numgrps; /* Max. size of groupslist */
2d21ac55	158	TAILQ_HEAD(, nfs_gss_clnt_ctx) nm_gsscl; /* GSS user contexts */
1c79356b A	159	int nm_timeo; /* Init timer for NFSMNT_DUMBTIMR */
1c79356b A	160	int nm_retry; /* Max retries */
b0d623f7 A	161	uint32_t nm_rsize; /* Max size of read rpc */
	162	uint32_t nm_wsize; /* Max size of write rpc */
	163	uint32_t nm_biosize; /* buffer I/O size */
	164	uint32_t nm_readdirsize; /* Size of a readdir rpc */
1c79356b	165	int nm_readahead; /* Num. of blocks to readahead */
91447636 A	166	int nm_acregmin; /* reg file min attr cache timeout */
	167	int nm_acregmax; /* reg file max attr cache timeout */
	168	int nm_acdirmin; /* dir min attr cache timeout */
	169	int nm_acdirmax; /* dir max attr cache timeout */
2d21ac55 A	170	uint32_t nm_auth; /* security mechanism flavor */
	171	/* mount info */
	172	uint32_t nm_fsattrstamp; /* timestamp for fs attrs */
	173	struct nfs_fsattr nm_fsattr; /* file system attributes */
	174	uint64_t nm_verf; /* v3/v4 write verifier */
	175	union {
	176	struct { /* v2/v3 specific fields */
	177	u_short rqport; /* cached rquota port */
	178	uint32_t rqportstamp; /* timestamp of rquota port */
	179	} v3;
	180	struct { /* v4 specific fields */
b0d623f7 A	181	struct nfs_client_id longid; / client ID, long form */
	182	uint64_t mounttime; /* used as client ID verifier */
	183	uint64_t clientid; /* client ID, short form */
2d21ac55	184	thread_call_t renew_timer; /* RENEW timer call */
b0d623f7 A	185	TAILQ_HEAD(, nfs_open_owner) open_owners; /* list of open owners */
	186	TAILQ_HEAD(, nfsnode) recallq; /* list of nodes with recalled delegations */
	187	TAILQ_ENTRY(nfsmount) cblink; /* chain of mounts registered for callbacks */
	188	uint32_t stateinuse; /* state in use counter */
	189	uint32_t stategenid; /* state generation counter */
	190	kauth_cred_t mcred; /* credential used for the mount */
	191	uint32_t cbid; /* callback channel identifier */
	192	uint32_t cbrefs; /* # callbacks using this mount */
2d21ac55 A	193	} v4;
	194	} nm_un;
	195	/* async I/O queue */
	196	struct nfs_reqqhead nm_resendq; /* async I/O resend queue */
	197	struct nfs_reqqhead nm_iodq; /* async I/O request queue */
	198	struct nfsiod nm_niod; / nfsiod processing this mount */
	199	TAILQ_ENTRY(nfsmount) nm_iodlink; /* chain of mounts awaiting nfsiod */
	200	int nm_asyncwrites; /* outstanding async I/O writes */
	201	/* socket state */
	202	int nm_sotype; /* Type of socket */
	203	int nm_soproto; /* and protocol */
	204	mbuf_t nm_nam; /* Address of server */
	205	u_short nm_sockflags; /* socket state flags */
	206	socket_t nm_so; /* RPC socket */
b0d623f7 A	207	time_t nm_deadto_start; /* dead timeout start time */
b0d623f7 A	208	time_t nm_reconnect_start; /* reconnect start time */
55e303ae A	209	int nm_tprintf_initial_delay; /* delay first "server down" */
55e303ae A	210	int nm_tprintf_delay; /* delay between "server down" */
b0d623f7	211	int nm_deadtimeout; /* delay between first "server down" and dead */
2d21ac55 A	212	int nm_srtt[4]; /* Timers for RPCs */
	213	int nm_sdrtt[4];
	214	int nm_timeouts; /* Request timeouts */
b0d623f7	215	int nm_jbreqs; /* # R_JBTPRINTFMSG requests */
2d21ac55 A	216	union {
	217	struct {
	218	int sent; /* Request send count */
	219	int cwnd; /* Request congestion window */
	220	struct nfs_reqqhead cwndq; /* requests waiting on cwnd */
	221	} udp;
	222	struct {
	223	u_int32_t mleft;/* marker bytes remaining */
	224	u_int32_t fleft;/* fragment bytes remaining */
	225	u_int32_t len; /* length of RPC record */
	226	mbuf_t m; /* mbufs for current record */
	227	mbuf_t mlast;
	228	} tcp;
	229	} nm_sockstate;
	230	TAILQ_ENTRY(nfsmount) nm_pokeq; /* mount poke queue chain */
	231	thread_t nm_sockthd; /* socket thread for this mount */
1c79356b A	232	};
1c79356b A	233
2d21ac55 A	234	/*
	235	* NFS mount state flags (nm_state)
	236	*/
b0d623f7	237	#define NFSSTA_BIGCOOKIES 0x00000800 /* have seen >32bit dir cookies */
2d21ac55 A	238	#define NFSSTA_JUKEBOXTIMEO 0x00001000 /* experienced a jukebox timeout */
	239	#define NFSSTA_LOCKTIMEO 0x00002000 /* experienced a lock req timeout */
	240	#define NFSSTA_MOUNTED 0x00004000 /* completely mounted */
	241	#define NFSSTA_LOCKSWORK 0x00008000 /* lock ops have worked. */
	242	#define NFSSTA_TIMEO 0x00010000 /* experienced a timeout. */
	243	#define NFSSTA_FORCE 0x00020000 /* doing a forced unmount. */
	244	#define NFSSTA_HASWRITEVERF 0x00040000 /* Has write verifier for V3 */
	245	#define NFSSTA_GOTPATHCONF 0x00080000 /* Got the V3 pathconf info */
	246	#define NFSSTA_GOTFSINFO 0x00100000 /* Got the V3 fsinfo */
	247	#define NFSSTA_SNDLOCK 0x01000000 /* Send socket lock */
	248	#define NFSSTA_WANTSND 0x02000000 /* Want above */
b0d623f7 A	249	#define NFSSTA_DEAD 0x04000000 /* mount is dead */
b0d623f7 A	250	#define NFSSTA_RECOVER 0x08000000 /* mount state needs to be recovered */
2d21ac55 A	251
	252	/* flags for nm_sockflags */
	253	#define NMSOCK_READY 0x0001 /* socket is ready for use */
	254	#define NMSOCK_CONNECTING 0x0002 /* socket is being connect()ed */
	255	#define NMSOCK_SETUP 0x0004 /* socket/connection is being set up */
	256	#define NMSOCK_UNMOUNT 0x0008 /* unmounted, no more socket activity */
	257	#define NMSOCK_LASTFRAG 0x0010 /* on last fragment of RPC record */
	258	#define NMSOCK_POKE 0x0020 /* socket needs to be poked */
	259	#define NMSOCK_UPCALL 0x0040 /* socket upcall in progress */
	260
	261	/* aliases for socket state variables */
	262	#define nm_sent nm_sockstate.udp.sent
	263	#define nm_cwnd nm_sockstate.udp.cwnd
	264	#define nm_cwndq nm_sockstate.udp.cwndq
	265	#define nm_markerleft nm_sockstate.tcp.mleft
	266	#define nm_fragleft nm_sockstate.tcp.fleft
	267	#define nm_reclen nm_sockstate.tcp.len
	268	#define nm_m nm_sockstate.tcp.m
	269	#define nm_mlast nm_sockstate.tcp.mlast
	270
	271	/* aliases for version-specific fields */
	272	#define nm_rqport nm_un.v3.rqport
	273	#define nm_rqportstamp nm_un.v3.rqportstamp
b0d623f7	274	#define nm_longid nm_un.v4.longid
2d21ac55 A	275	#define nm_clientid nm_un.v4.clientid
	276	#define nm_mounttime nm_un.v4.mounttime
	277	#define nm_renew_timer nm_un.v4.renew_timer
b0d623f7 A	278	#define nm_open_owners nm_un.v4.open_owners
	279	#define nm_stateinuse nm_un.v4.stateinuse
	280	#define nm_stategenid nm_un.v4.stategenid
	281	#define nm_mcred nm_un.v4.mcred
	282	#define nm_cbid nm_un.v4.cbid
	283	#define nm_cblink nm_un.v4.cblink
	284	#define nm_cbrefs nm_un.v4.cbrefs
	285	#define nm_recallq nm_un.v4.recallq
55e303ae	286
1c79356b A	287	#if defined(KERNEL)
1c79356b A	288	/*
2d21ac55	289	* Macros to convert from various things to mount structures.
1c79356b	290	*/
91447636	291	#define VFSTONFS(mp) ((mp) ? ((struct nfsmount *)vfs_fsprivate(mp)) : NULL)
2d21ac55 A	292	#define VTONMP(vp) VFSTONFS(vnode_mount(vp))
	293	#define NFSTONMP(np) VTONMP(NFSTOV(np))
	294	#define NFSTOMP(np) (vnode_mount(NFSTOV(np)))
1c79356b A	295
	296	#endif /* KERNEL */
	297
9bccf70c A	298	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	299	#endif /* _NFS_NFSMOUNT_H_ */