bsd/nfs/nfsmount.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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.
  14  *
  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
  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.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  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
  72 #include <sys/appleapiopts.h>
  73
  74 #ifdef __APPLE_API_PRIVATE
  75 /*
  76  * Mount structure.
  77  * One allocated on every NFS mount.
  78  * Holds NFS specific information for mount.
  79  */
  80 struct  nfsmount {
  81         int     nm_flag;                /* Flags for soft/hard... */
  82         int     nm_state;               /* Internal state flags */
  83         mount_t nm_mountp;              /* Vfs structure for this filesystem */
  84         int     nm_numgrps;             /* Max. size of groupslist */
  85         struct vnode *nm_dvp;           /* root directory vnode pointer */
  86         socket_t nm_so;                 /* Rpc socket */
  87         int     nm_sotype;              /* Type of socket */
  88         int     nm_soproto;             /* and protocol */
  89         mbuf_t  nm_nam;                 /* Addr of server */
  90         int     nm_timeo;               /* Init timer for NFSMNT_DUMBTIMR */
  91         int     nm_retry;               /* Max retries */
  92         int     nm_srtt[4];             /* Timers for rpcs */
  93         int     nm_sdrtt[4];
  94         int     nm_sent;                /* Request send count */
  95         int     nm_cwnd;                /* Request send window */
  96         int     nm_timeouts;            /* Request timeouts */
  97         int     nm_rsize;               /* Max size of read rpc */
  98         int     nm_wsize;               /* Max size of write rpc */
  99         int     nm_readdirsize;         /* Size of a readdir rpc */
 100         int     nm_readahead;           /* Num. of blocks to readahead */
 101         int     nm_acregmin;            /* reg file min attr cache timeout */
 102         int     nm_acregmax;            /* reg file max attr cache timeout */
 103         int     nm_acdirmin;            /* dir min attr cache timeout */
 104         int     nm_acdirmax;            /* dir max attr cache timeout */
 105         uid_t   nm_authuid;             /* Uid for authenticator */
 106         int     nm_authtype;            /* Authenticator type */
 107         int     nm_authlen;             /* and length */
 108         char    *nm_authstr;            /* Authenticator string */
 109         char    *nm_verfstr;            /* and the verifier */
 110         int     nm_verflen;
 111         uint64_t nm_verf;               /* V3 write verifier */
 112         NFSKERBKEY_T nm_key;            /* and the session key */
 113         int     nm_numuids;             /* Number of nfsuid mappings */
 114         TAILQ_HEAD(, nfsuid) nm_uidlruhead; /* Lists of nfsuid mappings */
 115         LIST_HEAD(, nfsuid) nm_uidhashtbl[NFS_MUIDHASHSIZ];
 116         TAILQ_HEAD(, nfsbuf) nm_bufq;   /* async io buffer queue */
 117         short   nm_bufqlen;             /* number of buffers in queue */
 118         short   nm_bufqwant;            /* process wants to add to the queue */
 119         int     nm_bufqiods;            /* number of iods processing queue */
 120         int     nm_tprintf_initial_delay;       /* delay first "server down" */
 121         int     nm_tprintf_delay;       /* delay between "server down" */
 122         struct {                        /* fsinfo & (homogenous) pathconf info */
 123                 u_int64_t maxfilesize;  /* max size of a file */
 124                 u_long  linkmax;        /* max # hard links to an object */
 125                 u_long  namemax;        /* max length of filename component */
 126                 u_char  pcflags;        /* boolean pathconf properties */
 127                 u_char  fsproperties;   /* fsinfo properties */
 128         } nm_fsinfo;
 129 };
 130
 131
 132 #if defined(KERNEL)
 133 /*
 134  * Convert mount_t to struct nfsmount*
 135  */
 136 #define VFSTONFS(mp)    ((mp) ? ((struct nfsmount *)vfs_fsprivate(mp)) : NULL)
 137
 138 #ifndef NFS_TPRINTF_INITIAL_DELAY
 139 #define NFS_TPRINTF_INITIAL_DELAY       12
 140 #endif
 141
 142 #ifndef NFS_TPRINTF_DELAY
 143 #define NFS_TPRINTF_DELAY               30
 144 #endif
 145
 146 #endif /* KERNEL */
 147
 148 #endif /* __APPLE_API_PRIVATE */
 149 #endif /* _NFS_NFSMOUNT_H_ */