bsd/nfs/nfsmount.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  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@
  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
  74 #include <sys/appleapiopts.h>
  75
  76 #ifdef __APPLE_API_PRIVATE
  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... */
  84         int     nm_state;               /* Internal state flags */
  85         mount_t nm_mountp;              /* Vfs structure for this filesystem */
  86         int     nm_numgrps;             /* Max. size of groupslist */
  87         struct vnode *nm_dvp;           /* root directory vnode pointer */
  88         socket_t nm_so;                 /* Rpc socket */
  89         int     nm_sotype;              /* Type of socket */
  90         int     nm_soproto;             /* and protocol */
  91         mbuf_t  nm_nam;                 /* Addr of server */
  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 */
  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 */
 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 */
 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];
 118         TAILQ_HEAD(, nfsbuf) nm_bufq;   /* async io buffer queue */
 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 */
 122         int     nm_tprintf_initial_delay;       /* delay first "server down" */
 123         int     nm_tprintf_delay;       /* delay between "server down" */
 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;
 131 };
 132
 133
 134 #if defined(KERNEL)
 135 /*
 136  * Convert mount_t to struct nfsmount*
 137  */
 138 #define VFSTONFS(mp)    ((mp) ? ((struct nfsmount *)vfs_fsprivate(mp)) : NULL)
 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
 147
 148 #endif /* KERNEL */
 149
 150 #endif /* __APPLE_API_PRIVATE */
 151 #endif /* _NFS_NFSMOUNT_H_ */