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

/*
 * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_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.
 *
 *	@(#)nfsproto.h	8.2 (Berkeley) 3/30/95
 * FreeBSD-Id: nfsproto.h,v 1.3 1997/02/22 09:42:50 peter Exp $
 */

#ifndef _NFS_NFSPROTO_H_
#define _NFS_NFSPROTO_H_

#include <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE
/*
 * nfs definitions as per the Version 2 and 3 specs
 */

/*
 * Constants as defined in the Sun NFS Version 2 and 3 specs.
 * "NFS: Network File System Protocol Specification" RFC1094
 * and in the "NFS: Network File System Version 3 Protocol
 * Specification"
 */

/* Only define these if nfs_prot.h hasn't been included */
#ifndef NFS_PROGRAM

#define NFS_PORT	2049
#define	NFS_PROG	100003
#define NFS_VER2	2
#define	NFS_VER3	3
#define NFS_V2MAXDATA	8192
#define	NFS_MAXDGRAMDATA 16384
#define	NFS_MAXDATA	(60*1024) // XXX not ready for 64K-128K
#define	NFS_MAXPATHLEN	1024
#define	NFS_MAXNAMLEN	255
#define	NFS_MAXPKTHDR	404
#define NFS_MAXPACKET	(NFS_MAXPKTHDR + NFS_MAXDATA)
#define	NFS_MINPACKET	20
#define	NFS_MAXSOCKBUF	(224*1024)
#define	NFS_FABLKSIZE	512	/* Size in bytes of a block wrt fa_blocks */

/* Stat numbers for rpc returns (version 2 and 3) */
#define	NFS_OK			0
#define	NFSERR_PERM		1
#define	NFSERR_NOENT		2
#define	NFSERR_IO		5
#define	NFSERR_NXIO		6
#define	NFSERR_ACCES		13
#define	NFSERR_EXIST		17
#define	NFSERR_XDEV		18	/* Version 3 only */
#define	NFSERR_NODEV		19
#define	NFSERR_NOTDIR		20
#define	NFSERR_ISDIR		21
#define	NFSERR_INVAL		22	/* Version 3 only */
#define	NFSERR_FBIG		27
#define	NFSERR_NOSPC		28
#define	NFSERR_ROFS		30
#define	NFSERR_MLINK		31	/* Version 3 only */
#define	NFSERR_NAMETOL		63
#define	NFSERR_NOTEMPTY		66
#define	NFSERR_DQUOT		69
#define	NFSERR_STALE		70
#define	NFSERR_REMOTE		71	/* Version 3 only */
#define	NFSERR_WFLUSH		99	/* Version 2 only */
#define	NFSERR_BADHANDLE	10001	/* The rest Version 3 only */
#define	NFSERR_NOT_SYNC		10002
#define	NFSERR_BAD_COOKIE	10003
#define	NFSERR_NOTSUPP		10004
#define	NFSERR_TOOSMALL		10005
#define	NFSERR_SERVERFAULT	10006
#define	NFSERR_BADTYPE		10007
#define	NFSERR_JUKEBOX		10008
#define NFSERR_TRYLATER		NFSERR_JUKEBOX
#define	NFSERR_STALEWRITEVERF	30001	/* Fake return for nfs_commit() */

#define NFSERR_RETVOID		0x20000000 /* Return void, not error */
#define NFSERR_AUTHERR		0x40000000 /* Mark an authentication error */
#define NFSERR_RETERR		0x80000000 /* Mark an error return for V3 */

#endif /* !NFS_PROGRAM */

/* Sizes in bytes of various nfs rpc components */
#define	NFSX_UNSIGNED	4

/* specific to NFS Version 2 */
#define	NFSX_V2FH	32
#define	NFSX_V2FATTR	68
#define	NFSX_V2SATTR	32
#define	NFSX_V2COOKIE	4
#define NFSX_V2STATFS	20

/* specific to NFS Version 3 */
#define NFSX_V3FH		(sizeof (fhandle_t)) /* size this server uses */
#define	NFSX_V3FHMAX		64	/* max. allowed by protocol */
#define NFSX_V3FATTR		84
#define NFSX_V3SATTR		60	/* max. all fields filled in */
#define NFSX_V3SRVSATTR		(sizeof (struct nfsv3_sattr))
#define NFSX_V3POSTOPATTR	(NFSX_V3FATTR + NFSX_UNSIGNED)
#define NFSX_V3WCCDATA		(NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
#define NFSX_V3COOKIEVERF 	8
#define NFSX_V3WRITEVERF 	8
#define NFSX_V3CREATEVERF	8
#define NFSX_V3STATFS		52
#define NFSX_V3FSINFO		48
#define NFSX_V3PATHCONF		24

/* variants for both versions */
#define NFSX_FH(v3)		((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \
					NFSX_V2FH)
#define NFSX_SRVFH(v3)		((v3) ? NFSX_V3FH : NFSX_V2FH)
#define	NFSX_FATTR(v3)		((v3) ? NFSX_V3FATTR : NFSX_V2FATTR)
#define NFSX_PREOPATTR(v3)	((v3) ? (7 * NFSX_UNSIGNED) : 0)
#define NFSX_POSTOPATTR(v3)	((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0)
#define NFSX_POSTOPORFATTR(v3)	((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \
					NFSX_V2FATTR)
#define NFSX_WCCDATA(v3)	((v3) ? NFSX_V3WCCDATA : 0)
#define NFSX_WCCORFATTR(v3)	((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR)
#define	NFSX_SATTR(v3)		((v3) ? NFSX_V3SATTR : NFSX_V2SATTR)
#define	NFSX_COOKIEVERF(v3)	((v3) ? NFSX_V3COOKIEVERF : 0)
#define	NFSX_WRITEVERF(v3)	((v3) ? NFSX_V3WRITEVERF : 0)
#define NFSX_READDIR(v3)	((v3) ? (5 * NFSX_UNSIGNED) : \
					(2 * NFSX_UNSIGNED))
#define	NFSX_STATFS(v3)		((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)

/* Only define these if nfs_prot.h hasn't been included */
#ifndef NFS_PROGRAM

/* nfs rpc procedure numbers (before version mapping) */
#define	NFSPROC_NULL		0
#define	NFSPROC_GETATTR		1
#define	NFSPROC_SETATTR		2
#define	NFSPROC_LOOKUP		3
#define	NFSPROC_ACCESS		4
#define	NFSPROC_READLINK	5
#define	NFSPROC_READ		6
#define	NFSPROC_WRITE		7
#define	NFSPROC_CREATE		8
#define	NFSPROC_MKDIR		9
#define	NFSPROC_SYMLINK		10
#define	NFSPROC_MKNOD		11
#define	NFSPROC_REMOVE		12
#define	NFSPROC_RMDIR		13
#define	NFSPROC_RENAME		14
#define	NFSPROC_LINK		15
#define	NFSPROC_READDIR		16
#define	NFSPROC_READDIRPLUS	17
#define	NFSPROC_FSSTAT		18
#define	NFSPROC_FSINFO		19
#define	NFSPROC_PATHCONF	20
#define	NFSPROC_COMMIT		21

#endif /* !NFS_PROGRAM */

/* And leasing (nqnfs) procedure numbers (must be last) */
#define	NQNFSPROC_GETLEASE	22
#define	NQNFSPROC_VACATED	23
#define	NQNFSPROC_EVICTED	24

#define NFSPROC_NOOP		25
#define	NFS_NPROCS		26

/* Actual Version 2 procedure numbers */
#define	NFSV2PROC_NULL		0
#define	NFSV2PROC_GETATTR	1
#define	NFSV2PROC_SETATTR	2
#define	NFSV2PROC_NOOP		3
#define	NFSV2PROC_ROOT		NFSV2PROC_NOOP	/* Obsolete */
#define	NFSV2PROC_LOOKUP	4
#define	NFSV2PROC_READLINK	5
#define	NFSV2PROC_READ		6
#define	NFSV2PROC_WRITECACHE	NFSV2PROC_NOOP	/* Obsolete */
#define	NFSV2PROC_WRITE		8
#define	NFSV2PROC_CREATE	9
#define	NFSV2PROC_REMOVE	10
#define	NFSV2PROC_RENAME	11
#define	NFSV2PROC_LINK		12
#define	NFSV2PROC_SYMLINK	13
#define	NFSV2PROC_MKDIR		14
#define	NFSV2PROC_RMDIR		15
#define	NFSV2PROC_READDIR	16
#define	NFSV2PROC_STATFS	17

/*
 * Constants used by the Version 3 protocol for various RPCs
 */
#define NFSV3SATTRTIME_DONTCHANGE	0
#define NFSV3SATTRTIME_TOSERVER		1
#define NFSV3SATTRTIME_TOCLIENT		2

#define NFSV3ACCESS_READ		0x01
#define NFSV3ACCESS_LOOKUP		0x02
#define NFSV3ACCESS_MODIFY		0x04
#define NFSV3ACCESS_EXTEND		0x08
#define NFSV3ACCESS_DELETE		0x10
#define NFSV3ACCESS_EXECUTE		0x20

#define NFSV3WRITE_UNSTABLE		0
#define NFSV3WRITE_DATASYNC		1
#define NFSV3WRITE_FILESYNC		2

#define NFSV3CREATE_UNCHECKED		0
#define NFSV3CREATE_GUARDED		1
#define NFSV3CREATE_EXCLUSIVE		2

#define NFSV3FSINFO_LINK		0x01
#define NFSV3FSINFO_SYMLINK		0x02
#define NFSV3FSINFO_HOMOGENEOUS		0x08
#define NFSV3FSINFO_CANSETTIME		0x10

/* Conversion macros */
#define	vtonfsv2_mode(t,m) \
		txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : \
				MAKEIMODE((t), (m)))
#define vtonfsv3_mode(m)	txdr_unsigned((m) & 07777)
#define	nfstov_mode(a)		(fxdr_unsigned(u_short, (a))&07777)
#define	vtonfsv2_type(a)	txdr_unsigned(nfsv2_type[((long)(a))])
#define	vtonfsv3_type(a)	txdr_unsigned(nfsv3_type[((long)(a))])
#define	nfsv2tov_type(a)	nv2tov_type[fxdr_unsigned(u_long,(a))&0x7]
#define	nfsv3tov_type(a)	nv3tov_type[fxdr_unsigned(u_long,(a))&0x7]

/* Only define these if nfs_prot.h hasn't been included */
#ifndef NFS_PROGRAM

/* File types */
typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
	NFSOCK=6, NFFIFO=7 } nfstype;
#endif /* !NFS_PROGRAM */

/* Structs for common parts of the rpc's */
/*
 * File Handle (32 bytes for version 2), variable up to 64 for version 3.
 * File Handles of up to NFS_SMALLFH in size are stored directly in the
 * nfs node, whereas larger ones are malloc'd. (This never happens when
 * NFS_SMALLFH is set to 64.)
 * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
 */
#ifndef NFS_SMALLFH
#define NFS_SMALLFH	64
#endif
union nfsfh {
	fhandle_t	fh_generic;
	u_char		fh_bytes[NFS_SMALLFH];
};
typedef union nfsfh nfsfh_t;

struct nfsv2_time {
	u_long	nfsv2_sec;
	u_long	nfsv2_usec;
};
typedef struct nfsv2_time	nfstime2;

struct nfsv3_time {
	u_long	nfsv3_sec;
	u_long	nfsv3_nsec;
};
typedef struct nfsv3_time	nfstime3;

/*
 * Quads are defined as arrays of 2 longs to ensure dense packing for the
 * protocol and to facilitate xdr conversion.
 */
struct nfs_uquad {
	u_long	nfsuquad[2];
};
typedef	struct nfs_uquad	nfsuint64;

/*
 * Used to convert between two u_longs and a u_quad_t.
 */
union nfs_quadconvert {
	u_long		lval[2];
	u_quad_t	qval;
};
typedef union nfs_quadconvert	nfsquad_t;

/*
 * NFS Version 3 special file number.
 */
struct nfsv3_spec {
	u_long	specdata1;
	u_long	specdata2;
};
typedef	struct nfsv3_spec	nfsv3spec;

/*
 * File attributes and setable attributes. These structures cover both
 * NFS version 2 and the version 3 protocol. Note that the union is only
 * used so that one pointer can refer to both variants. These structures
 * go out on the wire and must be densely packed, so no quad data types
 * are used. (all fields are longs or u_longs or structures of same)
 * NB: You can't do sizeof(struct nfs_fattr), you must use the
 *     NFSX_FATTR(v3) macro.
 */
struct nfs_fattr {
	u_long	fa_type;
	u_long	fa_mode;
	u_long	fa_nlink;
	u_long	fa_uid;
	u_long	fa_gid;
	union {
		struct {
			u_long		nfsv2fa_size;
			u_long		nfsv2fa_blocksize;
			u_long		nfsv2fa_rdev;
			u_long		nfsv2fa_blocks;
			u_long		nfsv2fa_fsid;
			u_long		nfsv2fa_fileid;
			nfstime2	nfsv2fa_atime;
			nfstime2	nfsv2fa_mtime;
			nfstime2	nfsv2fa_ctime;
		} fa_nfsv2;
		struct {
			nfsuint64	nfsv3fa_size;
			nfsuint64	nfsv3fa_used;
			nfsv3spec	nfsv3fa_rdev;
			nfsuint64	nfsv3fa_fsid;
			nfsuint64	nfsv3fa_fileid;
			nfstime3	nfsv3fa_atime;
			nfstime3	nfsv3fa_mtime;
			nfstime3	nfsv3fa_ctime;
		} fa_nfsv3;
	} fa_un;
};

/* and some ugly defines for accessing union components */
#define	fa2_size		fa_un.fa_nfsv2.nfsv2fa_size
#define	fa2_blocksize		fa_un.fa_nfsv2.nfsv2fa_blocksize
#define	fa2_rdev		fa_un.fa_nfsv2.nfsv2fa_rdev
#define	fa2_blocks		fa_un.fa_nfsv2.nfsv2fa_blocks
#define	fa2_fsid		fa_un.fa_nfsv2.nfsv2fa_fsid
#define	fa2_fileid		fa_un.fa_nfsv2.nfsv2fa_fileid
#define	fa2_atime		fa_un.fa_nfsv2.nfsv2fa_atime
#define	fa2_mtime		fa_un.fa_nfsv2.nfsv2fa_mtime
#define	fa2_ctime		fa_un.fa_nfsv2.nfsv2fa_ctime
#define	fa3_size		fa_un.fa_nfsv3.nfsv3fa_size
#define	fa3_used		fa_un.fa_nfsv3.nfsv3fa_used
#define	fa3_rdev		fa_un.fa_nfsv3.nfsv3fa_rdev
#define	fa3_fsid		fa_un.fa_nfsv3.nfsv3fa_fsid
#define	fa3_fileid		fa_un.fa_nfsv3.nfsv3fa_fileid
#define	fa3_atime		fa_un.fa_nfsv3.nfsv3fa_atime
#define	fa3_mtime		fa_un.fa_nfsv3.nfsv3fa_mtime
#define	fa3_ctime		fa_un.fa_nfsv3.nfsv3fa_ctime

struct nfsv2_sattr {
	u_long		sa_mode;
	u_long		sa_uid;
	u_long		sa_gid;
	u_long		sa_size;
	nfstime2	sa_atime;
	nfstime2	sa_mtime;
};

/*
 * NFS Version 3 sattr structure for the new node creation case.
 */
struct nfsv3_sattr {
	u_long		sa_modetrue;
	u_long		sa_mode;
	u_long		sa_uidtrue;
	u_long		sa_uid;
	u_long		sa_gidtrue;
	u_long		sa_gid;
	u_long		sa_sizefalse;
	u_long		sa_atimetype;
	u_long		sa_mtimetype;
};

struct nfs_statfs {
	union {
		struct {
			u_long		nfsv2sf_tsize;
			u_long		nfsv2sf_bsize;
			u_long		nfsv2sf_blocks;
			u_long		nfsv2sf_bfree;
			u_long		nfsv2sf_bavail;
		} sf_nfsv2;
		struct {
			nfsuint64	nfsv3sf_tbytes;
			nfsuint64	nfsv3sf_fbytes;
			nfsuint64	nfsv3sf_abytes;
			nfsuint64	nfsv3sf_tfiles;
			nfsuint64	nfsv3sf_ffiles;
			nfsuint64	nfsv3sf_afiles;
			u_long		nfsv3sf_invarsec;
		} sf_nfsv3;
	} sf_un;
};

#define sf_tsize	sf_un.sf_nfsv2.nfsv2sf_tsize
#define sf_bsize	sf_un.sf_nfsv2.nfsv2sf_bsize
#define sf_blocks	sf_un.sf_nfsv2.nfsv2sf_blocks
#define sf_bfree	sf_un.sf_nfsv2.nfsv2sf_bfree
#define sf_bavail	sf_un.sf_nfsv2.nfsv2sf_bavail
#define sf_tbytes	sf_un.sf_nfsv3.nfsv3sf_tbytes
#define sf_fbytes	sf_un.sf_nfsv3.nfsv3sf_fbytes
#define sf_abytes	sf_un.sf_nfsv3.nfsv3sf_abytes
#define sf_tfiles	sf_un.sf_nfsv3.nfsv3sf_tfiles
#define sf_ffiles	sf_un.sf_nfsv3.nfsv3sf_ffiles
#define sf_afiles	sf_un.sf_nfsv3.nfsv3sf_afiles
#define sf_invarsec	sf_un.sf_nfsv3.nfsv3sf_invarsec

struct nfsv3_fsinfo {
	u_long		fs_rtmax;
	u_long		fs_rtpref;
	u_long		fs_rtmult;
	u_long		fs_wtmax;
	u_long		fs_wtpref;
	u_long		fs_wtmult;
	u_long		fs_dtpref;
	nfsuint64	fs_maxfilesize;
	nfstime3	fs_timedelta;
	u_long		fs_properties;
};

struct nfsv3_pathconf {
	u_long		pc_linkmax;
	u_long		pc_namemax;
	u_long		pc_notrunc;
	u_long		pc_chownrestricted;
	u_long		pc_caseinsensitive;
	u_long		pc_casepreserving;
};

#endif /* __APPLE_API_PRIVATE */
#endif /* _NFS_NFSPROTO_H_ */
Commit	Line	Data
1c79356b	1	/*
55e303ae	2	* Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	26	/*
	27	* Copyright (c) 1989, 1993
	28	* The Regents of the University of California. All rights reserved.
	29	*
	30	* This code is derived from software contributed to Berkeley by
	31	* Rick Macklem at The University of Guelph.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)nfsproto.h 8.2 (Berkeley) 3/30/95
	62	* FreeBSD-Id: nfsproto.h,v 1.3 1997/02/22 09:42:50 peter Exp $
	63	*/
	64
	65	#ifndef _NFS_NFSPROTO_H_
	66	#define _NFS_NFSPROTO_H_
	67
9bccf70c A	68	#include <sys/appleapiopts.h>
	69
	70	#ifdef __APPLE_API_PRIVATE
1c79356b A	71	/*
	72	* nfs definitions as per the Version 2 and 3 specs
	73	*/
	74
	75	/*
	76	* Constants as defined in the Sun NFS Version 2 and 3 specs.
	77	* "NFS: Network File System Protocol Specification" RFC1094
	78	* and in the "NFS: Network File System Version 3 Protocol
	79	* Specification"
	80	*/
	81
	82	/* Only define these if nfs_prot.h hasn't been included */
	83	#ifndef NFS_PROGRAM
	84
	85	#define NFS_PORT 2049
	86	#define NFS_PROG 100003
	87	#define NFS_VER2 2
	88	#define NFS_VER3 3
	89	#define NFS_V2MAXDATA 8192
	90	#define NFS_MAXDGRAMDATA 16384
55e303ae	91	#define NFS_MAXDATA (60*1024) // XXX not ready for 64K-128K
1c79356b A	92	#define NFS_MAXPATHLEN 1024
	93	#define NFS_MAXNAMLEN 255
	94	#define NFS_MAXPKTHDR 404
	95	#define NFS_MAXPACKET (NFS_MAXPKTHDR + NFS_MAXDATA)
	96	#define NFS_MINPACKET 20
55e303ae	97	#define NFS_MAXSOCKBUF (224*1024)
1c79356b A	98	#define NFS_FABLKSIZE 512 /* Size in bytes of a block wrt fa_blocks */
	99
	100	/* Stat numbers for rpc returns (version 2 and 3) */
	101	#define NFS_OK 0
	102	#define NFSERR_PERM 1
	103	#define NFSERR_NOENT 2
	104	#define NFSERR_IO 5
	105	#define NFSERR_NXIO 6
	106	#define NFSERR_ACCES 13
	107	#define NFSERR_EXIST 17
	108	#define NFSERR_XDEV 18 /* Version 3 only */
	109	#define NFSERR_NODEV 19
	110	#define NFSERR_NOTDIR 20
	111	#define NFSERR_ISDIR 21
	112	#define NFSERR_INVAL 22 /* Version 3 only */
	113	#define NFSERR_FBIG 27
	114	#define NFSERR_NOSPC 28
	115	#define NFSERR_ROFS 30
	116	#define NFSERR_MLINK 31 /* Version 3 only */
	117	#define NFSERR_NAMETOL 63
	118	#define NFSERR_NOTEMPTY 66
	119	#define NFSERR_DQUOT 69
	120	#define NFSERR_STALE 70
	121	#define NFSERR_REMOTE 71 /* Version 3 only */
	122	#define NFSERR_WFLUSH 99 /* Version 2 only */
	123	#define NFSERR_BADHANDLE 10001 /* The rest Version 3 only */
	124	#define NFSERR_NOT_SYNC 10002
	125	#define NFSERR_BAD_COOKIE 10003
	126	#define NFSERR_NOTSUPP 10004
	127	#define NFSERR_TOOSMALL 10005
	128	#define NFSERR_SERVERFAULT 10006
	129	#define NFSERR_BADTYPE 10007
	130	#define NFSERR_JUKEBOX 10008
	131	#define NFSERR_TRYLATER NFSERR_JUKEBOX
	132	#define NFSERR_STALEWRITEVERF 30001 /* Fake return for nfs_commit() */
	133
	134	#define NFSERR_RETVOID 0x20000000 /* Return void, not error */
	135	#define NFSERR_AUTHERR 0x40000000 /* Mark an authentication error */
	136	#define NFSERR_RETERR 0x80000000 /* Mark an error return for V3 */
	137
	138	#endif /* !NFS_PROGRAM */
	139
	140	/* Sizes in bytes of various nfs rpc components */
	141	#define NFSX_UNSIGNED 4
	142
	143	/* specific to NFS Version 2 */
	144	#define NFSX_V2FH 32
	145	#define NFSX_V2FATTR 68
	146	#define NFSX_V2SATTR 32
	147	#define NFSX_V2COOKIE 4
	148	#define NFSX_V2STATFS 20
	149
	150	/* specific to NFS Version 3 */
	151	#define NFSX_V3FH (sizeof (fhandle_t)) /* size this server uses */
	152	#define NFSX_V3FHMAX 64 /* max. allowed by protocol */
	153	#define NFSX_V3FATTR 84
	154	#define NFSX_V3SATTR 60 /* max. all fields filled in */
	155	#define NFSX_V3SRVSATTR (sizeof (struct nfsv3_sattr))
	156	#define NFSX_V3POSTOPATTR (NFSX_V3FATTR + NFSX_UNSIGNED)
	157	#define NFSX_V3WCCDATA (NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
	158	#define NFSX_V3COOKIEVERF 8
	159	#define NFSX_V3WRITEVERF 8
	160	#define NFSX_V3CREATEVERF 8
	161	#define NFSX_V3STATFS 52
162	#define NFSX_V3FSINFO 48
163	#define NFSX_V3PATHCONF 24
164
165	/* variants for both versions */
166	#define NFSX_FH(v3) ((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \
167	NFSX_V2FH)
168	#define NFSX_SRVFH(v3) ((v3) ? NFSX_V3FH : NFSX_V2FH)
169	#define NFSX_FATTR(v3) ((v3) ? NFSX_V3FATTR : NFSX_V2FATTR)
170	#define NFSX_PREOPATTR(v3) ((v3) ? (7 * NFSX_UNSIGNED) : 0)
171	#define NFSX_POSTOPATTR(v3) ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0)
172	#define NFSX_POSTOPORFATTR(v3) ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \
173	NFSX_V2FATTR)
174	#define NFSX_WCCDATA(v3) ((v3) ? NFSX_V3WCCDATA : 0)
175	#define NFSX_WCCORFATTR(v3) ((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR)
176	#define NFSX_SATTR(v3) ((v3) ? NFSX_V3SATTR : NFSX_V2SATTR)
177	#define NFSX_COOKIEVERF(v3) ((v3) ? NFSX_V3COOKIEVERF : 0)
178	#define NFSX_WRITEVERF(v3) ((v3) ? NFSX_V3WRITEVERF : 0)
179	#define NFSX_READDIR(v3) ((v3) ? (5 * NFSX_UNSIGNED) : \
180	(2 * NFSX_UNSIGNED))
181	#define NFSX_STATFS(v3) ((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
182
183	/* Only define these if nfs_prot.h hasn't been included */
184	#ifndef NFS_PROGRAM
185
186	/* nfs rpc procedure numbers (before version mapping) */
187	#define NFSPROC_NULL 0
188	#define NFSPROC_GETATTR 1
189	#define NFSPROC_SETATTR 2
190	#define NFSPROC_LOOKUP 3
191	#define NFSPROC_ACCESS 4
192	#define NFSPROC_READLINK 5
193	#define NFSPROC_READ 6
194	#define NFSPROC_WRITE 7
195	#define NFSPROC_CREATE 8
196	#define NFSPROC_MKDIR 9
197	#define NFSPROC_SYMLINK 10
198	#define NFSPROC_MKNOD 11
199	#define NFSPROC_REMOVE 12
200	#define NFSPROC_RMDIR 13
201	#define NFSPROC_RENAME 14
202	#define NFSPROC_LINK 15
203	#define NFSPROC_READDIR 16
204	#define NFSPROC_READDIRPLUS 17
205	#define NFSPROC_FSSTAT 18
206	#define NFSPROC_FSINFO 19
207	#define NFSPROC_PATHCONF 20
208	#define NFSPROC_COMMIT 21
209
210	#endif /* !NFS_PROGRAM */
211
212	/* And leasing (nqnfs) procedure numbers (must be last) */
213	#define NQNFSPROC_GETLEASE 22
214	#define NQNFSPROC_VACATED 23
215	#define NQNFSPROC_EVICTED 24
216
217	#define NFSPROC_NOOP 25
218	#define NFS_NPROCS 26
219
220	/* Actual Version 2 procedure numbers */
221	#define NFSV2PROC_NULL 0
222	#define NFSV2PROC_GETATTR 1
223	#define NFSV2PROC_SETATTR 2
224	#define NFSV2PROC_NOOP 3
225	#define NFSV2PROC_ROOT NFSV2PROC_NOOP /* Obsolete */
226	#define NFSV2PROC_LOOKUP 4
227	#define NFSV2PROC_READLINK 5
228	#define NFSV2PROC_READ 6
229	#define NFSV2PROC_WRITECACHE NFSV2PROC_NOOP /* Obsolete */
230	#define NFSV2PROC_WRITE 8
231	#define NFSV2PROC_CREATE 9
232	#define NFSV2PROC_REMOVE 10
233	#define NFSV2PROC_RENAME 11
234	#define NFSV2PROC_LINK 12
235	#define NFSV2PROC_SYMLINK 13
236	#define NFSV2PROC_MKDIR 14
237	#define NFSV2PROC_RMDIR 15
238	#define NFSV2PROC_READDIR 16
239	#define NFSV2PROC_STATFS 17
240
241	/*
242	* Constants used by the Version 3 protocol for various RPCs
243	*/
244	#define NFSV3SATTRTIME_DONTCHANGE 0
245	#define NFSV3SATTRTIME_TOSERVER 1
246	#define NFSV3SATTRTIME_TOCLIENT 2
247
248	#define NFSV3ACCESS_READ 0x01
249	#define NFSV3ACCESS_LOOKUP 0x02
250	#define NFSV3ACCESS_MODIFY 0x04
251	#define NFSV3ACCESS_EXTEND 0x08
252	#define NFSV3ACCESS_DELETE 0x10
253	#define NFSV3ACCESS_EXECUTE 0x20
254
255	#define NFSV3WRITE_UNSTABLE 0
256	#define NFSV3WRITE_DATASYNC 1
257	#define NFSV3WRITE_FILESYNC 2
258
259	#define NFSV3CREATE_UNCHECKED 0
260	#define NFSV3CREATE_GUARDED 1
261	#define NFSV3CREATE_EXCLUSIVE 2
262
263	#define NFSV3FSINFO_LINK 0x01
264	#define NFSV3FSINFO_SYMLINK 0x02
265	#define NFSV3FSINFO_HOMOGENEOUS 0x08
266	#define NFSV3FSINFO_CANSETTIME 0x10
267
268	/* Conversion macros */
269	#define vtonfsv2_mode(t,m) \
270	txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : \
271	MAKEIMODE((t), (m)))
272	#define vtonfsv3_mode(m) txdr_unsigned((m) & 07777)
273	#define nfstov_mode(a) (fxdr_unsigned(u_short, (a))&07777)
274	#define vtonfsv2_type(a) txdr_unsigned(nfsv2_type[((long)(a))])
275	#define vtonfsv3_type(a) txdr_unsigned(nfsv3_type[((long)(a))])
276	#define nfsv2tov_type(a) nv2tov_type[fxdr_unsigned(u_long,(a))&0x7]
277	#define nfsv3tov_type(a) nv3tov_type[fxdr_unsigned(u_long,(a))&0x7]
278
279	/* Only define these if nfs_prot.h hasn't been included */
280	#ifndef NFS_PROGRAM
281
282	/* File types */
283	typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
284	NFSOCK=6, NFFIFO=7 } nfstype;
285	#endif /* !NFS_PROGRAM */
286
287	/* Structs for common parts of the rpc's */
288	/*
289	* File Handle (32 bytes for version 2), variable up to 64 for version 3.
290	* File Handles of up to NFS_SMALLFH in size are stored directly in the
291	* nfs node, whereas larger ones are malloc'd. (This never happens when
292	* NFS_SMALLFH is set to 64.)
293	* NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
294	*/
295	#ifndef NFS_SMALLFH
296	#define NFS_SMALLFH 64
297	#endif
298	union nfsfh {
299	fhandle_t fh_generic;
300	u_char fh_bytes[NFS_SMALLFH];
301	};
302	typedef union nfsfh nfsfh_t;
303
304	struct nfsv2_time {
305	u_long nfsv2_sec;
306	u_long nfsv2_usec;
307	};
308	typedef struct nfsv2_time nfstime2;
309
310	struct nfsv3_time {
311	u_long nfsv3_sec;
312	u_long nfsv3_nsec;
313	};
314	typedef struct nfsv3_time nfstime3;
315
316	/*
317	* Quads are defined as arrays of 2 longs to ensure dense packing for the
318	* protocol and to facilitate xdr conversion.
319	*/
320	struct nfs_uquad {
321	u_long nfsuquad[2];
322	};
323	typedef struct nfs_uquad nfsuint64;
324
325	/*
326	* Used to convert between two u_longs and a u_quad_t.
327	*/
328	union nfs_quadconvert {
329	u_long lval[2];
330	u_quad_t qval;
331	};
332	typedef union nfs_quadconvert nfsquad_t;
333
334	/*
335	* NFS Version 3 special file number.
336	*/
337	struct nfsv3_spec {
338	u_long specdata1;
339	u_long specdata2;
340	};
341	typedef struct nfsv3_spec nfsv3spec;
342
343	/*
344	* File attributes and setable attributes. These structures cover both
345	* NFS version 2 and the version 3 protocol. Note that the union is only
346	* used so that one pointer can refer to both variants. These structures
347	* go out on the wire and must be densely packed, so no quad data types
348	* are used. (all fields are longs or u_longs or structures of same)
349	* NB: You can't do sizeof(struct nfs_fattr), you must use the
350	* NFSX_FATTR(v3) macro.
351	*/
352	struct nfs_fattr {
353	u_long fa_type;
354	u_long fa_mode;
355	u_long fa_nlink;
356	u_long fa_uid;
357	u_long fa_gid;
358	union {
359	struct {
360	u_long nfsv2fa_size;
361	u_long nfsv2fa_blocksize;
362	u_long nfsv2fa_rdev;
363	u_long nfsv2fa_blocks;
364	u_long nfsv2fa_fsid;
365	u_long nfsv2fa_fileid;
366	nfstime2 nfsv2fa_atime;
367	nfstime2 nfsv2fa_mtime;
368	nfstime2 nfsv2fa_ctime;
369	} fa_nfsv2;
370	struct {
371	nfsuint64 nfsv3fa_size;
372	nfsuint64 nfsv3fa_used;
373	nfsv3spec nfsv3fa_rdev;
374	nfsuint64 nfsv3fa_fsid;
375	nfsuint64 nfsv3fa_fileid;
376	nfstime3 nfsv3fa_atime;
377	nfstime3 nfsv3fa_mtime;
378	nfstime3 nfsv3fa_ctime;
379	} fa_nfsv3;
380	} fa_un;
381	};
382
383	/* and some ugly defines for accessing union components */
384	#define fa2_size fa_un.fa_nfsv2.nfsv2fa_size
385	#define fa2_blocksize fa_un.fa_nfsv2.nfsv2fa_blocksize
386	#define fa2_rdev fa_un.fa_nfsv2.nfsv2fa_rdev
387	#define fa2_blocks fa_un.fa_nfsv2.nfsv2fa_blocks
388	#define fa2_fsid fa_un.fa_nfsv2.nfsv2fa_fsid
389	#define fa2_fileid fa_un.fa_nfsv2.nfsv2fa_fileid
390	#define fa2_atime fa_un.fa_nfsv2.nfsv2fa_atime
391	#define fa2_mtime fa_un.fa_nfsv2.nfsv2fa_mtime
392	#define fa2_ctime fa_un.fa_nfsv2.nfsv2fa_ctime
393	#define fa3_size fa_un.fa_nfsv3.nfsv3fa_size
394	#define fa3_used fa_un.fa_nfsv3.nfsv3fa_used
395	#define fa3_rdev fa_un.fa_nfsv3.nfsv3fa_rdev
396	#define fa3_fsid fa_un.fa_nfsv3.nfsv3fa_fsid
397	#define fa3_fileid fa_un.fa_nfsv3.nfsv3fa_fileid
398	#define fa3_atime fa_un.fa_nfsv3.nfsv3fa_atime
399	#define fa3_mtime fa_un.fa_nfsv3.nfsv3fa_mtime
400	#define fa3_ctime fa_un.fa_nfsv3.nfsv3fa_ctime
401
402	struct nfsv2_sattr {
403	u_long sa_mode;
404	u_long sa_uid;
405	u_long sa_gid;
406	u_long sa_size;
407	nfstime2 sa_atime;
408	nfstime2 sa_mtime;
409	};
410
411	/*
412	* NFS Version 3 sattr structure for the new node creation case.
413	*/
414	struct nfsv3_sattr {
415	u_long sa_modetrue;
416	u_long sa_mode;
417	u_long sa_uidtrue;
418	u_long sa_uid;
419	u_long sa_gidtrue;
420	u_long sa_gid;
421	u_long sa_sizefalse;
422	u_long sa_atimetype;
423	u_long sa_mtimetype;
424	};
425
426	struct nfs_statfs {
427	union {
428	struct {
429	u_long nfsv2sf_tsize;
430	u_long nfsv2sf_bsize;
431	u_long nfsv2sf_blocks;
432	u_long nfsv2sf_bfree;
433	u_long nfsv2sf_bavail;
434	} sf_nfsv2;
435	struct {
436	nfsuint64 nfsv3sf_tbytes;
437	nfsuint64 nfsv3sf_fbytes;
438	nfsuint64 nfsv3sf_abytes;
439	nfsuint64 nfsv3sf_tfiles;
440	nfsuint64 nfsv3sf_ffiles;
441	nfsuint64 nfsv3sf_afiles;
442	u_long nfsv3sf_invarsec;
443	} sf_nfsv3;
444	} sf_un;
445	};
446
447	#define sf_tsize sf_un.sf_nfsv2.nfsv2sf_tsize
448	#define sf_bsize sf_un.sf_nfsv2.nfsv2sf_bsize
449	#define sf_blocks sf_un.sf_nfsv2.nfsv2sf_blocks
450	#define sf_bfree sf_un.sf_nfsv2.nfsv2sf_bfree
451	#define sf_bavail sf_un.sf_nfsv2.nfsv2sf_bavail
452	#define sf_tbytes sf_un.sf_nfsv3.nfsv3sf_tbytes
453	#define sf_fbytes sf_un.sf_nfsv3.nfsv3sf_fbytes
454	#define sf_abytes sf_un.sf_nfsv3.nfsv3sf_abytes
455	#define sf_tfiles sf_un.sf_nfsv3.nfsv3sf_tfiles
456	#define sf_ffiles sf_un.sf_nfsv3.nfsv3sf_ffiles
457	#define sf_afiles sf_un.sf_nfsv3.nfsv3sf_afiles
458	#define sf_invarsec sf_un.sf_nfsv3.nfsv3sf_invarsec
459
460	struct nfsv3_fsinfo {
461	u_long fs_rtmax;
462	u_long fs_rtpref;
463	u_long fs_rtmult;
464	u_long fs_wtmax;
465	u_long fs_wtpref;
466	u_long fs_wtmult;
467	u_long fs_dtpref;
468	nfsuint64 fs_maxfilesize;
469	nfstime3 fs_timedelta;
470	u_long fs_properties;
471	};
472
473	struct nfsv3_pathconf {
474	u_long pc_linkmax;
475	u_long pc_namemax;
476	u_long pc_notrunc;
477	u_long pc_chownrestricted;
478	u_long pc_caseinsensitive;
479	u_long pc_casepreserving;
480	};
481
9bccf70c A	482	#endif /* __APPLE_API_PRIVATE */
9bccf70c A	483	#endif /* _NFS_NFSPROTO_H_ */