sys/nfs/nqnfs.h

   1 /*
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Rick Macklem at The University of Guelph.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)nqnfs.h     8.3 (Berkeley) 3/30/95
  37  * $FreeBSD$
  38  */
  39
  40
  41 #ifndef _NFS_NQNFS_H_
  42 #define _NFS_NQNFS_H_
  43
  44 /*
  45  * Definitions for NQNFS (Not Quite NFS) cache consistency protocol.
  46  */
  47
  48 /* Tunable constants */
  49 #define NQ_CLOCKSKEW    3       /* Clock skew factor (sec) */
  50 #define NQ_WRITESLACK   5       /* Delay for write cache flushing */
  51 #define NQ_MAXLEASE     60      /* Max lease duration (sec) */
  52 #define NQ_MINLEASE     5       /* Min lease duration (sec) */
  53 #define NQ_DEFLEASE     30      /* Default lease duration (sec) */
  54 #define NQ_RENEWAL      3       /* Time before expiry (sec) to renew */
  55 #define NQ_TRYLATERDEL  15      /* Initial try later delay (sec) */
  56 #define NQ_MAXNUMLEASE  2048    /* Upper bound on number of server leases */
  57 #define NQ_DEADTHRESH   NQ_NEVERDEAD    /* Default nm_deadthresh */
  58 #define NQ_NEVERDEAD    9       /* Greater than max. nm_timeouts */
  59 #define NQLCHSZ         256     /* Server hash table size */
  60
  61 #define NQNFS_PROG      300105  /* As assigned by Sun */
  62 #define NQNFS_VER3      3
  63 #define NQNFS_EVICTSIZ  156     /* Size of eviction request in bytes */
  64
  65 #if defined(KERNEL) || defined(_KERNEL)
  66 /*
  67  * Definitions used for saving the "last lease expires" time in Non-volatile
  68  * RAM on the server. The default definitions below assume that NOVRAM is not
  69  * available.
  70  */
  71 #ifdef HASNVRAM
  72 #  undef HASNVRAM
  73 #endif
  74 #define NQSTORENOVRAM(t)
  75 #define NQLOADNOVRAM(t)
  76
  77 /*
  78  * Defn and structs used on the server to maintain state for current leases.
  79  * The list of host(s) that hold the lease are kept as nqhost structures.
  80  * The first one lives in nqlease and any others are held in a linked
  81  * list of nqm structures hanging off of nqlease.
  82  *
  83  * Each nqlease structure is chained into two lists. The first is a list
  84  * ordered by increasing expiry time for nqsrv_timer() and the second is a chain
  85  * hashed on lc_fh.
  86  */
  87 #define LC_MOREHOSTSIZ  10
  88
  89 struct nqhost {
  90         union {
  91                 struct {
  92                         u_int16_t udp_flag;
  93                         u_int16_t udp_port;
  94                         union nethostaddr udp_haddr;
  95                 } un_udp;
  96                 struct {
  97                         u_int16_t connless_flag;
  98                         u_int16_t connless_spare;
  99                         union nethostaddr connless_haddr;
 100                 } un_connless;
 101                 struct {
 102                         u_int16_t conn_flag;
 103                         u_int16_t conn_spare;
 104                         struct nfssvc_sock *conn_slp;
 105                 } un_conn;
 106         } lph_un;
 107 };
 108 #define lph_flag        lph_un.un_udp.udp_flag
 109 #define lph_port        lph_un.un_udp.udp_port
 110 #define lph_haddr       lph_un.un_udp.udp_haddr
 111 #define lph_inetaddr    lph_un.un_udp.udp_haddr.had_inetaddr
 112 #define lph_claddr      lph_un.un_connless.connless_haddr
 113 #define lph_nam         lph_un.un_connless.connless_haddr.had_nam
 114 #define lph_slp         lph_un.un_conn.conn_slp
 115
 116 struct nqlease {
 117         LIST_ENTRY(nqlease) lc_hash;    /* Fhandle hash list */
 118         CIRCLEQ_ENTRY(nqlease) lc_timer; /* Timer queue list */
 119         time_t          lc_expiry;      /* Expiry time (sec) */
 120         struct nqhost   lc_host;        /* Host that got lease */
 121         struct nqm      *lc_morehosts;  /* Other hosts that share read lease */
 122         fsid_t          lc_fsid;        /* Fhandle */
 123         char            lc_fiddata[MAXFIDSZ];
 124         struct vnode    *lc_vp;         /* Soft reference to associated vnode */
 125 };
 126 #define lc_flag         lc_host.lph_un.un_udp.udp_flag
 127
 128 /* lc_flag bits */
 129 #define LC_VALID        0x0001  /* Host address valid */
 130 #define LC_WRITE        0x0002  /* Write cache */
 131 #define LC_NONCACHABLE  0x0004  /* Non-cachable lease */
 132 #define LC_LOCKED       0x0008  /* Locked */
 133 #define LC_WANTED       0x0010  /* Lock wanted */
 134 #define LC_EXPIREDWANTED 0x0020 /* Want lease when expired */
 135 #define LC_UDP          0x0040  /* Host address for udp socket */
 136 #define LC_CLTP         0x0080  /* Host address for other connectionless */
 137 #define LC_LOCAL        0x0100  /* Host is server */
 138 #define LC_VACATED      0x0200  /* Host has vacated lease */
 139 #define LC_WRITTEN      0x0400  /* Recently wrote to the leased file */
 140 #define LC_SREF         0x0800  /* Holds a nfssvc_sock reference */
 141
 142 struct nqm {
 143         struct nqm      *lpm_next;
 144         struct nqhost   lpm_hosts[LC_MOREHOSTSIZ];
 145 };
 146
 147 /*
 148  * Special value for slp for local server calls.
 149  */
 150 #define NQLOCALSLP      ((struct nfssvc_sock *) -1)
 151
 152 /*
 153  * Server side macros.
 154  */
 155 #define nqsrv_getl(v, l) \
 156                 (void) nqsrv_getlease((v), &nfsd->nd_duration, \
 157                  ((nfsd->nd_flag & ND_LEASE) ? (nfsd->nd_flag & ND_LEASE) : \
 158                  ((l) | ND_CHECK)), \
 159                  slp, procp, nfsd->nd_nam, &cache, &frev, cred)
 160
 161 /*
 162  * Client side macros that check for a valid lease.
 163  */
 164 #define NQNFS_CKINVALID(v, n, f) \
 165  ((time_second > (n)->n_expiry && \
 166  VFSTONFS((v)->v_mount)->nm_timeouts < VFSTONFS((v)->v_mount)->nm_deadthresh) \
 167   || ((f) == ND_WRITE && ((n)->n_flag & NQNFSWRITE) == 0))
 168
 169 #define NQNFS_CKCACHABLE(v, f) \
 170  ((time_second <= VTONFS(v)->n_expiry || \
 171   VFSTONFS((v)->v_mount)->nm_timeouts >= VFSTONFS((v)->v_mount)->nm_deadthresh) \
 172    && (VTONFS(v)->n_flag & NQNFSNONCACHE) == 0 && \
 173    ((f) == ND_READ || (VTONFS(v)->n_flag & NQNFSWRITE)))
 174
 175 #define NQNFS_NEEDLEASE(v, p) \
 176                 (time_second > VTONFS(v)->n_expiry ? \
 177                  ((VTONFS(v)->n_flag & NQNFSEVICTED) ? 0 : nqnfs_piggy[p]) : \
 178                  (((time_second + NQ_RENEWAL) > VTONFS(v)->n_expiry && \
 179                    nqnfs_piggy[p]) ? \
 180                    ((VTONFS(v)->n_flag & NQNFSWRITE) ? \
 181                     ND_WRITE : nqnfs_piggy[p]) : 0))
 182
 183 /*
 184  * List head for timer queue.
 185  */
 186 extern CIRCLEQ_HEAD(nqtimerhead, nqlease) nqtimerhead;
 187
 188 /*
 189  * List head for the file handle hash table.
 190  */
 191 #define NQFHHASH(f) \
 192         (&nqfhhashtbl[(*((u_int32_t *)(f))) & nqfhhash])
 193 extern LIST_HEAD(nqfhhashhead, nqlease) *nqfhhashtbl;
 194 extern u_long nqfhhash;
 195
 196 /*
 197  * Nqnfs return status numbers.
 198  */
 199 #define NQNFS_EXPIRED   500
 200 #define NQNFS_TRYLATER  501
 201
 202 void    nqnfs_lease_check __P((struct vnode *, struct proc *, struct ucred *, int));
 203 void    nqnfs_lease_updatetime __P((int));
 204 int     nqsrv_getlease __P((struct vnode *, u_int32_t *, int,
 205                             struct nfssvc_sock *, struct proc *,
 206                             struct sockaddr *, int *, u_quad_t *,
 207                             struct ucred *));
 208 int     nqnfs_getlease __P((struct vnode *,int,struct ucred *,struct proc *));
 209 int     nqnfs_callback __P((struct nfsmount *,struct mbuf *,struct mbuf *,caddr_t));
 210 int     nqnfs_clientd __P((struct nfsmount *,struct ucred *,struct nfsd_cargs *,int,caddr_t,struct proc *));
 211 struct nfsnode;
 212 void    nqnfs_clientlease __P((struct nfsmount *, struct nfsnode *, int, int, time_t, u_quad_t));
 213 void    nqnfs_serverd __P((void));
 214 int     nqnfsrv_getlease __P((struct nfsrv_descript *, struct nfssvc_sock *, struct proc *, struct mbuf **));
 215 int     nqnfsrv_vacated __P((struct nfsrv_descript *, struct nfssvc_sock *, struct proc *, struct mbuf **));
 216 #endif
 217
 218 #endif