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

/*
 * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
 * 
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_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
/*
 * Mount structure.
 * One allocated on every NFS mount.
 * Holds NFS specific information for mount.
 */
struct	nfsmount {
	int	nm_flag;		/* Flags for soft/hard... */
	int	nm_state;		/* Internal state flags */
	mount_t	nm_mountp;		/* Vfs structure for this filesystem */
	int	nm_numgrps;		/* Max. size of groupslist */
	struct vnode *nm_dvp;		/* root directory vnode pointer */
	socket_t nm_so;			/* Rpc socket */
	int	nm_sotype;		/* Type of socket */
	int	nm_soproto;		/* and protocol */
	mbuf_t	nm_nam;			/* Addr of server */
	int	nm_timeo;		/* Init timer for NFSMNT_DUMBTIMR */
	int	nm_retry;		/* Max retries */
	int	nm_srtt[4];		/* Timers for rpcs */
	int	nm_sdrtt[4];
	int	nm_sent;		/* Request send count */
	int	nm_cwnd;		/* Request send window */
	int	nm_timeouts;		/* Request timeouts */
	int	nm_rsize;		/* Max size of read rpc */
	int	nm_wsize;		/* Max size of write rpc */
	int	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 */
	uid_t	nm_authuid;		/* Uid for authenticator */
	int	nm_authtype;		/* Authenticator type */
	int	nm_authlen;		/* and length */
	char	*nm_authstr;		/* Authenticator string */
	char	*nm_verfstr;		/* and the verifier */
	int	nm_verflen;
	u_char	nm_verf[NFSX_V3WRITEVERF]; /* V3 write verifier */
	NFSKERBKEY_T nm_key;		/* and the session key */
	int	nm_numuids;		/* Number of nfsuid mappings */
	TAILQ_HEAD(, nfsuid) nm_uidlruhead; /* Lists of nfsuid mappings */
	LIST_HEAD(, nfsuid) nm_uidhashtbl[NFS_MUIDHASHSIZ];
	TAILQ_HEAD(, nfsbuf) nm_bufq;	/* async io buffer queue */
	short	nm_bufqlen;		/* number of buffers in queue */
	short	nm_bufqwant;		/* process wants to add to the queue */
	int	nm_bufqiods;		/* number of iods processing queue */
	int	nm_tprintf_initial_delay;	/* delay first "server down" */
	int	nm_tprintf_delay;	/* delay between "server down" */
	struct {			/* fsinfo & (homogenous) pathconf info */
		u_int64_t maxfilesize;	/* max size of a file */
		u_long	linkmax;	/* max # hard links to an object */
		u_long	namemax;	/* max length of filename component */
		u_char	pcflags;	/* boolean pathconf properties */
		u_char	fsproperties;	/* fsinfo properties */
	} nm_fsinfo;
};


#if defined(KERNEL)
/*
 * Convert mount_t to struct nfsmount*
 */
#define VFSTONFS(mp)	((mp) ? ((struct nfsmount *)vfs_fsprivate(mp)) : NULL)

#ifndef NFS_TPRINTF_INITIAL_DELAY
#define NFS_TPRINTF_INITIAL_DELAY	12
#endif

#ifndef NFS_TPRINTF_DELAY
#define NFS_TPRINTF_DELAY		30
#endif

#endif /* KERNEL */

#endif /* __APPLE_API_PRIVATE */
#endif /* _NFS_NFSMOUNT_H_ */
Commit	Line	Data
1c79356b	1	/*
8ad349bb	2	* Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
1c79356b	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b A	29	*/
	30	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	31	/*
	32	* Copyright (c) 1989, 1993
	33	* The Regents of the University of California. All rights reserved.
	34	*
	35	* This code is derived from software contributed to Berkeley by
	36	* Rick Macklem at The University of Guelph.
	37	*
	38	* Redistribution and use in source and binary forms, with or without
	39	* modification, are permitted provided that the following conditions
	40	* are met:
	41	* 1. Redistributions of source code must retain the above copyright
	42	* notice, this list of conditions and the following disclaimer.
	43	* 2. Redistributions in binary form must reproduce the above copyright
	44	* notice, this list of conditions and the following disclaimer in the
	45	* documentation and/or other materials provided with the distribution.
	46	* 3. All advertising materials mentioning features or use of this software
	47	* must display the following acknowledgement:
	48	* This product includes software developed by the University of
	49	* California, Berkeley and its contributors.
	50	* 4. Neither the name of the University nor the names of its contributors
	51	* may be used to endorse or promote products derived from this software
	52	* without specific prior written permission.
	53	*
	54	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	55	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	56	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	57	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	58	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	59	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	60	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	61	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	62	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	63	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	64	* SUCH DAMAGE.
	65	*
	66	* @(#)nfsmount.h 8.3 (Berkeley) 3/30/95
	67	* FreeBSD-Id: nfsmount.h,v 1.13 1997/08/16 19:16:05 wollman Exp $
	68	*/
	69
	70
	71	#ifndef _NFS_NFSMOUNT_H_
	72	#define _NFS_NFSMOUNT_H_
	73
9bccf70c A	74	#include <sys/appleapiopts.h>
	75
	76	#ifdef __APPLE_API_PRIVATE
1c79356b A	77	/*
	78	* Mount structure.
	79	* One allocated on every NFS mount.
	80	* Holds NFS specific information for mount.
	81	*/
	82	struct nfsmount {
	83	int nm_flag; /* Flags for soft/hard... */
55e303ae	84	int nm_state; /* Internal state flags */
91447636	85	mount_t nm_mountp; /* Vfs structure for this filesystem */
1c79356b A	86	int nm_numgrps; /* Max. size of groupslist */
1c79356b A	87	struct vnode nm_dvp; / root directory vnode pointer */
91447636	88	socket_t nm_so; /* Rpc socket */
1c79356b A	89	int nm_sotype; /* Type of socket */
1c79356b A	90	int nm_soproto; /* and protocol */
91447636	91	mbuf_t nm_nam; /* Addr of server */
1c79356b A	92	int nm_timeo; /* Init timer for NFSMNT_DUMBTIMR */
	93	int nm_retry; /* Max retries */
	94	int nm_srtt[4]; /* Timers for rpcs */
	95	int nm_sdrtt[4];
	96	int nm_sent; /* Request send count */
	97	int nm_cwnd; /* Request send window */
	98	int nm_timeouts; /* Request timeouts */
1c79356b A	99	int nm_rsize; /* Max size of read rpc */
	100	int nm_wsize; /* Max size of write rpc */
	101	int nm_readdirsize; /* Size of a readdir rpc */
	102	int nm_readahead; /* Num. of blocks to readahead */
91447636 A	103	int nm_acregmin; /* reg file min attr cache timeout */
	104	int nm_acregmax; /* reg file max attr cache timeout */
	105	int nm_acdirmin; /* dir min attr cache timeout */
	106	int nm_acdirmax; /* dir max attr cache timeout */
1c79356b A	107	uid_t nm_authuid; /* Uid for authenticator */
	108	int nm_authtype; /* Authenticator type */
	109	int nm_authlen; /* and length */
	110	char nm_authstr; / Authenticator string */
	111	char nm_verfstr; / and the verifier */
	112	int nm_verflen;
	113	u_char nm_verf[NFSX_V3WRITEVERF]; /* V3 write verifier */
	114	NFSKERBKEY_T nm_key; /* and the session key */
	115	int nm_numuids; /* Number of nfsuid mappings */
	116	TAILQ_HEAD(, nfsuid) nm_uidlruhead; /* Lists of nfsuid mappings */
	117	LIST_HEAD(, nfsuid) nm_uidhashtbl[NFS_MUIDHASHSIZ];
55e303ae	118	TAILQ_HEAD(, nfsbuf) nm_bufq; /* async io buffer queue */
1c79356b A	119	short nm_bufqlen; /* number of buffers in queue */
	120	short nm_bufqwant; /* process wants to add to the queue */
	121	int nm_bufqiods; /* number of iods processing queue */
55e303ae A	122	int nm_tprintf_initial_delay; /* delay first "server down" */
55e303ae A	123	int nm_tprintf_delay; /* delay between "server down" */
91447636 A	124	struct { /* fsinfo & (homogenous) pathconf info */
	125	u_int64_t maxfilesize; /* max size of a file */
	126	u_long linkmax; /* max # hard links to an object */
	127	u_long namemax; /* max length of filename component */
	128	u_char pcflags; /* boolean pathconf properties */
	129	u_char fsproperties; /* fsinfo properties */
	130	} nm_fsinfo;
1c79356b A	131	};
1c79356b A	132
55e303ae	133
1c79356b A	134	#if defined(KERNEL)
1c79356b A	135	/*
91447636	136	* Convert mount_t to struct nfsmount*
1c79356b	137	*/
91447636	138	#define VFSTONFS(mp) ((mp) ? ((struct nfsmount *)vfs_fsprivate(mp)) : NULL)
55e303ae A	139
	140	#ifndef NFS_TPRINTF_INITIAL_DELAY
	141	#define NFS_TPRINTF_INITIAL_DELAY 12
	142	#endif
	143
	144	#ifndef NFS_TPRINTF_DELAY
	145	#define NFS_TPRINTF_DELAY 30
	146	#endif
1c79356b A	147
	148	#endif /* KERNEL */
	149
9bccf70c A	150	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	151	#endif /* _NFS_NFSMOUNT_H_ */