bsd/nfs/nfsnode.h

   1 /*
   2  * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   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
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  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  *      @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
  62  * FreeBSD-Id: nfsnode.h,v 1.24 1997/10/28 14:06:25 bde Exp $
  63  */
  64
  65
  66 #ifndef _NFS_NFSNODE_H_
  67 #define _NFS_NFSNODE_H_
  68
  69 #include <sys/appleapiopts.h>
  70
  71 #ifdef __APPLE_API_PRIVATE
  72 #ifndef _NFS_NFS_H_
  73 #include <nfs/nfs.h>
  74 #endif
  75 #include <sys/lock.h>
  76
  77
  78 /*
  79  * Silly rename structure that hangs off the nfsnode until the name
  80  * can be removed by nfs_inactive()
  81  */
  82 struct sillyrename {
  83         struct  ucred *s_cred;
  84         struct  vnode *s_dvp;
  85         long    s_namlen;
  86         char    s_name[20];
  87 };
  88
  89 /*
  90  * This structure is used to save the logical directory offset to
  91  * NFS cookie mappings.
  92  * The mappings are stored in a list headed
  93  * by n_cookies, as required.
  94  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
  95  * stored in increasing logical offset byte order.
  96  */
  97 #define NFSNUMCOOKIES           31
  98
  99 struct nfsdmap {
 100         LIST_ENTRY(nfsdmap)     ndm_list;
 101         int                     ndm_eocookie;
 102         nfsuint64               ndm_cookies[NFSNUMCOOKIES];
 103 };
 104
 105 /*
 106  * The nfsbuf is the nfs equivalent to a struct buf.
 107  */
 108 struct nfsbuf {
 109         LIST_ENTRY(nfsbuf)      nb_hash;        /* hash chain */
 110         LIST_ENTRY(nfsbuf)      nb_vnbufs;      /* vnode's nfsbuf chain */
 111         TAILQ_ENTRY(nfsbuf)     nb_free;        /* free list position if not active. */
 112         volatile long           nb_flags;       /* NB_* flags. */
 113         long                    nb_bufsize;     /* buffer size */
 114         daddr_t                 nb_lblkno;      /* logical block number. */
 115         int                     nb_error;       /* errno value. */
 116         u_int32_t               nb_valid;       /* valid pages in buf */
 117         u_int32_t               nb_dirty;       /* dirty pages in buf */
 118         int                     nb_validoff;    /* offset in buffer of valid region. */
 119         int                     nb_validend;    /* offset of end of valid region. */
 120         int                     nb_dirtyoff;    /* offset in buffer of dirty region. */
 121         int                     nb_dirtyend;    /* offset of end of dirty region. */
 122         caddr_t                 nb_data;        /* mapped buffer */
 123         struct vnode *          nb_vp;          /* device vnode */
 124         struct proc *           nb_proc;        /* associated proc; NULL if kernel. */
 125         struct ucred *          nb_rcred;       /* read credentials reference */
 126         struct ucred *          nb_wcred;       /* write credentials reference */
 127         void *                  nb_pagelist;    /* upl */
 128 };
 129
 130 /*
 131  * These flags are kept in nb_flags and they're (purposefully)
 132  * very similar to the B_* flags for struct buf.
 133  */
 134 #define NB_NEEDCOMMIT   0x00000002      /* Append-write in progress. */
 135 #define NB_ASYNC        0x00000004      /* Start I/O, do not wait. */
 136 #define NB_BUSY         0x00000010      /* I/O in progress. */
 137 #define NB_CACHE        0x00000020      /* Bread found us in the cache. */
 138 #define NB_STABLE       0x00000040      /* write FILESYNC not UNSTABLE. */
 139 #define NB_DELWRI       0x00000080      /* Delay I/O until buffer reused. */
 140 #define NB_DONE         0x00000200      /* I/O completed. */
 141 #define NB_EINTR        0x00000400      /* I/O was interrupted */
 142 #define NB_ERROR        0x00000800      /* I/O error occurred. */
 143 #define NB_WASDIRTY     0x00001000      /* page was found dirty in the VM cache */
 144 #define NB_INVAL        0x00002000      /* Does not contain valid info. */
 145 #define NB_NOCACHE      0x00008000      /* Do not cache block after use. */
 146 #define NB_READ         0x00100000      /* Read buffer. */
 147 #define NB_PAGELIST     0x00400000      /* Buffer describes pagelist I/O. */
 148 #define NB_WANTED       0x00800000      /* Process wants this buffer. */
 149 #define NB_WRITE        0x00000000      /* Write buffer (pseudo flag). */
 150 #define NB_WRITEINPROG  0x01000000      /* Write in progress. */
 151 #define NB_META         0x40000000      /* buffer contains meta-data. */
 152 #define NB_IOD          0x80000000      /* buffer being handled by nfsiod. */
 153
 154
 155 #define NBOFF(BP)                       ((off_t)(BP)->nb_lblkno * (off_t)(BP)->nb_bufsize)
 156 #define NBPGVALID(BP,P)                 (((BP)->nb_valid >> (P)) & 0x1)
 157 #define NBPGDIRTY(BP,P)                 (((BP)->nb_dirty >> (P)) & 0x1)
 158 #define NBPGVALID_SET(BP,P)             ((BP)->nb_valid |= (1 << (P)))
 159 #define NBPGDIRTY_SET(BP,P)             ((BP)->nb_dirty |= (1 << (P)))
 160
 161 #define NFS_BUF_MAP(BP) \
 162         do { \
 163                 if (!(BP)->nb_data && nfs_buf_map(BP)) \
 164                         panic("nfs_buf_map failed"); \
 165         } while (0)
 166
 167 LIST_HEAD(nfsbuflists, nfsbuf);
 168 TAILQ_HEAD(nfsbuffreehead, nfsbuf);
 169
 170 #define NFSNOLIST ((struct nfsbuf *)0xdeadbeef)
 171
 172 extern int nfsbufhashlock, nfsbufcnt, nfsbufmin, nfsbufmax;
 173 extern int nfsbuffreecnt, nfsbufdelwricnt, nfsneedbuffer;
 174 extern int nfs_nbdwrite;
 175 extern struct nfsbuffreehead nfsbuffree, nfsbufdelwri;
 176
 177 #define NFSBUFCNTCHK() \
 178         do { \
 179         if (    (nfsbufcnt < 0) || \
 180                 (nfsbufcnt > nfsbufmax) || \
 181                 (nfsbuffreecnt < 0) || \
 182                 (nfsbuffreecnt > nfsbufmax) || \
 183                 (nfsbuffreecnt > nfsbufcnt) || \
 184                 (nfsbufdelwricnt < 0) || \
 185                 (nfsbufdelwricnt > nfsbufmax) || \
 186                 (nfsbufdelwricnt > nfsbufcnt) || \
 187                 (nfs_nbdwrite < 0) || \
 188                 (nfs_nbdwrite > nfsbufcnt) || \
 189                 0) \
 190                 panic("nfsbuf count error: max %d cnt %d free %d delwr %d bdw %d\n", \
 191                         nfsbufmax, nfsbufcnt, nfsbuffreecnt, \
 192                         nfsbufdelwricnt, nfs_nbdwrite); \
 193         } while (0)
 194
 195 /*
 196  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
 197  * is purely coincidental.
 198  * There is a unique nfsnode allocated for each active file,
 199  * each current directory, each mounted-on file, text file, and the root.
 200  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
 201  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
 202  * type definitions), file handles of > 32 bytes should probably be split out
 203  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
 204  * changing the definition in sys/mount.h of NFS_SMALLFH.)
 205  * NB: Hopefully the current order of the fields is such that everything will
 206  *     be well aligned and, therefore, tightly packed.
 207  */
 208 struct nfsnode {
 209         struct lock__bsd__      n_lock; /* the vnode lock */
 210         LIST_ENTRY(nfsnode)     n_hash;         /* Hash chain */
 211         CIRCLEQ_ENTRY(nfsnode)  n_timer;        /* Nqnfs timer chain */
 212         u_quad_t                n_size;         /* Current size of file */
 213         u_quad_t                n_brev;         /* Modify rev when cached */
 214         u_quad_t                n_lrev;         /* Modify rev for lease */
 215         struct vattr            n_vattr;        /* Vnode attribute cache */
 216         time_t                  n_attrstamp;    /* Attr. cache timestamp */
 217         u_int32_t               n_mode;         /* ACCESS mode cache */
 218         uid_t                   n_modeuid;      /* credentials having mode */
 219         time_t                  n_modestamp;    /* mode cache timestamp */
 220         time_t                  n_mtime;        /* Prev modify time. */
 221         time_t                  n_ctime;        /* Prev create time. */
 222         time_t                  n_expiry;       /* Lease expiry time */
 223         nfsfh_t                 *n_fhp;         /* NFS File Handle */
 224         union {
 225                 struct vnode    *n_vp;          /* associated vnode */
 226                 struct mount    *n_mp;          /* associated mount (NINIT) */
 227         } n_un0;
 228         struct lockf            *n_lockf;       /* Locking record of file */
 229         int                     n_error;        /* Save write error value */
 230         union {
 231                 struct timespec nf_atim;        /* Special file times */
 232                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
 233         } n_un1;
 234         union {
 235                 struct timespec nf_mtim;
 236                 off_t           nd_direof;      /* Dir. EOF offset cache */
 237         } n_un2;
 238         union {
 239                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
 240                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
 241         } n_un3;
 242         short                   n_fhsize;       /* size in bytes, of fh */
 243         short                   n_flag;         /* Flag for locking.. */
 244         nfsfh_t                 n_fh;           /* Small File Handle */
 245         u_int64_t               n_xid;          /* last xid to loadattr */
 246         struct nfsbuflists      n_cleanblkhd;   /* clean blocklist head */
 247         struct nfsbuflists      n_dirtyblkhd;   /* dirty blocklist head */
 248         int                     n_needcommitcnt;/* # bufs that need committing */
 249 };
 250
 251 #define CHECK_NEEDCOMMITCNT(np) \
 252         do { \
 253                 if ((np)->n_needcommitcnt < 0) { \
 254                         printf("nfs: n_needcommitcnt negative\n"); \
 255                         (np)->n_needcommitcnt = 0; \
 256                 } \
 257         } while (0)
 258
 259 #define n_vnode         n_un0.n_vp
 260 #define n_mount         n_un0.n_mp
 261 #define n_atim          n_un1.nf_atim
 262 #define n_mtim          n_un2.nf_mtim
 263 #define n_sillyrename   n_un3.nf_silly
 264 #define n_cookieverf    n_un1.nd_cookieverf
 265 #define n_direofoffset  n_un2.nd_direof
 266 #define n_cookies       n_un3.nd_cook
 267
 268 /*
 269  * Flags for n_flag
 270  */
 271 #define NFLUSHWANT      0x0001  /* Want wakeup from a flush in prog. */
 272 #define NFLUSHINPROG    0x0002  /* Avoid multiple calls to vinvalbuf() */
 273 #define NMODIFIED       0x0004  /* Might have a modified buffer in bio */
 274 #define NWRITEERR       0x0008  /* Flag write errors so close will know */
 275 #define NQNFSNONCACHE   0x0020  /* Non-cachable lease */
 276 #define NQNFSWRITE      0x0040  /* Write lease */
 277 #define NQNFSEVICTED    0x0080  /* Has been evicted */
 278 #define NACC            0x0100  /* Special file accessed */
 279 #define NUPD            0x0200  /* Special file updated */
 280 #define NCHG            0x0400  /* Special file times changed */
 281 #define NHASHED         0x1000  /* someone wants to lock */
 282 #define NINIT           0x2000  /* node is being initialized */
 283 #define NWINIT          0x4000  /* someone waiting for init to complete */
 284
 285 /*
 286  * Convert between nfsnode pointers and vnode pointers
 287  */
 288 #define VTONFS(vp)      ((struct nfsnode *)(vp)->v_data)
 289 #define NFSTOV(np)      ((struct vnode *)(np)->n_vnode)
 290
 291 /*
 292  * Queue head for nfsiod's
 293  */
 294 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
 295 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
 296 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
 297
 298 #if defined(KERNEL)
 299
 300 typedef int     vop_t __P((void *));
 301 extern  vop_t   **fifo_nfsv2nodeop_p;
 302 extern  vop_t   **nfsv2_vnodeop_p;
 303 extern  vop_t   **spec_nfsv2nodeop_p;
 304
 305 /*
 306  * Prototypes for NFS vnode operations
 307  */
 308 int     nfs_write __P((struct vop_write_args *));
 309 #define nfs_lease_check ((int (*) __P((struct  vop_lease_args *)))nullop)
 310 #define nqnfs_vop_lease_check   lease_check
 311 int     nqnfs_vop_lease_check __P((struct vop_lease_args *));
 312 #define nfs_revoke vop_revoke
 313 #define nfs_seek ((int (*) __P((struct  vop_seek_args *)))nullop)
 314 int     nfs_inactive __P((struct vop_inactive_args *));
 315 int     nfs_reclaim __P((struct vop_reclaim_args *));
 316 int nfs_lock __P((struct vop_lock_args *));
 317 int nfs_unlock __P((struct vop_unlock_args *));
 318 int nfs_islocked __P((struct vop_islocked_args *));
 319
 320 #define nfs_reallocblks \
 321         ((int (*) __P((struct  vop_reallocblks_args *)))eopnotsupp)
 322
 323 /* other stuff */
 324 int     nfs_removeit __P((struct sillyrename *));
 325 int     nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
 326 nfsuint64 *nfs_getcookie __P((struct nfsnode *, off_t, int));
 327 void nfs_invaldir __P((struct vnode *));
 328
 329 #define nqnfs_lease_updatetime  lease_updatetime
 330
 331 /* nfsbuf functions */
 332 void nfs_nbinit(void);
 333 void nfs_buf_remfree(struct nfsbuf *);
 334 struct nfsbuf * nfs_buf_incore(struct vnode *, daddr_t);
 335 struct nfsbuf * nfs_buf_get(struct vnode *, daddr_t, int, struct proc *, int);
 336 int nfs_buf_upl_setup(struct nfsbuf *bp);
 337 void nfs_buf_upl_check(struct nfsbuf *bp);
 338 void nfs_buf_release(struct nfsbuf *);
 339 int nfs_buf_iowait(struct nfsbuf *);
 340 void nfs_buf_iodone(struct nfsbuf *);
 341 void nfs_buf_write_delayed(struct nfsbuf *);
 342
 343 #endif /* KERNEL */
 344
 345 #endif /* __APPLE_API_PRIVATE */
 346 #endif /* _NFS_NFSNODE_H_ */