bsd/nfs/nfsnode.h

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