sys/fs/nfsclient/nfsmount.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Rick Macklem at The University of Guelph.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _NFSCLIENT_NFSMOUNT_H_
  38 #define _NFSCLIENT_NFSMOUNT_H_
  39
  40 #include <nfs/nfs_mountcommon.h>
  41
  42 /* Maximum value for nm_nconnect. */
  43 #define NFS_MAXNCONN    16
  44
  45 /*
  46  * Mount structure.
  47  * One allocated on every NFS mount.
  48  * Holds NFS specific information for mount.
  49  */
  50 struct  nfsmount {
  51         struct  nfsmount_common nm_com; /* Common fields for nlm */
  52         uint32_t nm_privflag;           /* Private flags */
  53         uint32_t nm_newflag;            /* New mount flags */
  54         int     nm_numgrps;             /* Max. size of groupslist */
  55         u_char  nm_fh[NFSX_FHMAX];      /* File handle of root dir */
  56         int     nm_fhsize;              /* Size of root file handle */
  57         struct  nfssockreq nm_sockreq;  /* Socket Info */
  58         int     nm_timeouts;            /* Request timeouts */
  59         int     nm_rsize;               /* Max size of read rpc */
  60         int     nm_wsize;               /* Max size of write rpc */
  61         int     nm_readdirsize;         /* Size of a readdir rpc */
  62         int     nm_readahead;           /* Num. of blocks to readahead */
  63         int     nm_wcommitsize;         /* Max size of commit for write */
  64         int     nm_acdirmin;            /* Directory attr cache min lifetime */
  65         int     nm_acdirmax;            /* Directory attr cache max lifetime */
  66         int     nm_acregmin;            /* Reg file attr cache min lifetime */
  67         int     nm_acregmax;            /* Reg file attr cache max lifetime */
  68         u_char  nm_verf[NFSX_VERF];     /* write verifier */
  69         TAILQ_HEAD(, buf) nm_bufq;      /* async io buffer queue */
  70         short   nm_bufqlen;             /* number of buffers in queue */
  71         short   nm_bufqwant;            /* process wants to add to the queue */
  72         int     nm_bufqiods;            /* number of iods processing queue */
  73         u_int64_t nm_maxfilesize;       /* maximum file size */
  74         int     nm_tprintf_initial_delay; /* initial delay */
  75         int     nm_tprintf_delay;       /* interval for messages */
  76         int     nm_nametimeo;           /* timeout for +ve entries (sec) */
  77         int     nm_negnametimeo;        /* timeout for -ve entries (sec) */
  78
  79         /* Newnfs additions */
  80         TAILQ_HEAD(, nfsclds) nm_sess;  /* Session(s) for NFSv4.1. */
  81         struct  nfsclclient *nm_clp;
  82         char    *nm_tlscertname;        /* TLS certificate file name */
  83         uid_t   nm_uid;                 /* Uid for SetClientID etc. */
  84         u_int64_t nm_clval;             /* identifies which clientid */
  85         u_int64_t nm_fsid[2];           /* NFSv4 fsid */
  86         int     nm_minorvers;           /* Minor version # for NFSv4 */
  87         u_int   nm_aconnect;            /* additional TCP connections */
  88         u_int   nm_nextaconn;           /* Next nm_aconn[] to use */
  89                                         /* unclipped, wraps to 0 */
  90         struct __rpc_client *nm_aconn[NFS_MAXNCONN - 1]; /* Additional nconn */
  91                                         /* Locked via nm_sockreq.nr_mtx */
  92         u_int16_t nm_krbnamelen;        /* Krb5 host principal, if any */
  93         u_int16_t nm_dirpathlen;        /* and mount dirpath, for V4 */
  94         u_int16_t nm_srvkrbnamelen;     /* and the server's target name */
  95         u_char  nm_name[1];     /* malloc'd actual len of krbname + dirpath */
  96 };
  97
  98 #define nm_nam          nm_sockreq.nr_nam
  99 #define nm_sotype       nm_sockreq.nr_sotype
 100 #define nm_so           nm_sockreq.nr_so
 101 #define nm_soflags      nm_sockreq.nr_soflags
 102 #define nm_soproto      nm_sockreq.nr_soproto
 103 #define nm_client       nm_sockreq.nr_client
 104 #define nm_krbname      nm_name
 105 #define nm_mtx          nm_com.nmcom_mtx
 106 #define nm_flag         nm_com.nmcom_flag
 107 #define nm_state        nm_com.nmcom_state
 108 #define nm_mountp       nm_com.nmcom_mountp
 109 #define nm_timeo        nm_com.nmcom_timeo
 110 #define nm_retry        nm_com.nmcom_retry
 111 #define nm_hostname     nm_com.nmcom_hostname
 112 #define nm_getinfo      nm_com.nmcom_getinfo
 113 #define nm_vinvalbuf    nm_com.nmcom_vinvalbuf
 114
 115 /* Private flags. */
 116 #define NFSMNTP_FORCEDISM       0x00000001
 117 #define NFSMNTP_CANCELRPCS      0x00000002
 118 #define NFSMNTP_IOADVISETHRUMDS 0x00000004
 119 #define NFSMNTP_NOCOPY          0x00000008
 120 #define NFSMNTP_NOCONSECUTIVE   0x00000010
 121 #define NFSMNTP_SEEK            0x00000020
 122 #define NFSMNTP_SEEKTESTED      0x00000040
 123 #define NFSMNTP_NOXATTR         0x00000080
 124 #define NFSMNTP_NOADVISE        0x00000100
 125 #define NFSMNTP_NOALLOCATE      0x00000200
 126 #define NFSMNTP_DELEGISSUED     0x00000400
 127 #define NFSMNTP_NODEALLOCATE    0x00000800
 128
 129 /* New mount flags only used by the kernel via nmount(2). */
 130 #define NFSMNT_TLS              0x00000001
 131
 132 #define NFSMNT_DIRPATH(m)       (&((m)->nm_name[(m)->nm_krbnamelen + 1]))
 133 #define NFSMNT_SRVKRBNAME(m)                                            \
 134         (&((m)->nm_name[(m)->nm_krbnamelen + (m)->nm_dirpathlen + 2]))
 135
 136 #if defined(_KERNEL)
 137 /*
 138  * Convert mount ptr to nfsmount ptr.
 139  */
 140 #define VFSTONFS(mp)    ((struct nfsmount *)((mp)->mnt_data))
 141
 142 #ifndef NFS_DEFAULT_NAMETIMEO
 143 #define NFS_DEFAULT_NAMETIMEO           60
 144 #endif
 145
 146 #ifndef NFS_DEFAULT_NEGNAMETIMEO
 147 #define NFS_DEFAULT_NEGNAMETIMEO        60
 148 #endif
 149
 150 #endif  /* _KERNEL */
 151
 152 #endif  /* _NFSCLIENT_NFSMOUNT_H_ */