bsd/nfs/nfsnode.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  *      @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
  67  * FreeBSD-Id: nfsnode.h,v 1.24 1997/10/28 14:06:25 bde Exp $
  68  */
  69
  70
  71 #ifndef _NFS_NFSNODE_H_
  72 #define _NFS_NFSNODE_H_
  73
  74 #include <sys/appleapiopts.h>
  75
  76 #ifdef __APPLE_API_PRIVATE
  77 #ifndef _NFS_NFS_H_
  78 #include <nfs/nfs.h>
  79 #endif
  80
  81 /*
  82  * Silly rename structure that hangs off the nfsnode until the name
  83  * can be removed by nfs_inactive()
  84  */
  85 struct sillyrename {
  86         struct  ucred *s_cred;
  87         vnode_t s_dvp;
  88         long    s_namlen;
  89         char    s_name[20];
  90 };
  91
  92 /*
  93  * This structure is used to save the logical directory offset to
  94  * NFS cookie mappings.
  95  * The mappings are stored in a list headed
  96  * by n_cookies, as required.
  97  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
  98  * stored in increasing logical offset byte order.
  99  */
 100 #define NFSNUMCOOKIES           31
 101
 102 struct nfsdmap {
 103         LIST_ENTRY(nfsdmap)     ndm_list;
 104         int                     ndm_eocookie;
 105         nfsuint64               ndm_cookies[NFSNUMCOOKIES];
 106 };
 107
 108 /*
 109  * The nfsbuf is the nfs equivalent to a struct buf.
 110  */
 111 struct nfsbuf {
 112         LIST_ENTRY(nfsbuf)      nb_hash;        /* hash chain */
 113         LIST_ENTRY(nfsbuf)      nb_vnbufs;      /* vnode's nfsbuf chain */
 114         TAILQ_ENTRY(nfsbuf)     nb_free;        /* free list position if not active. */
 115         volatile long           nb_flags;       /* NB_* flags. */
 116         volatile long           nb_lflags;      /* NBL_* flags. */
 117         volatile long           nb_refs;        /* outstanding references. */
 118         long                    nb_bufsize;     /* buffer size */
 119         daddr64_t               nb_lblkno;      /* logical block number. */
 120         time_t                  nb_timestamp;   /* buffer timestamp */
 121         int                     nb_error;       /* errno value. */
 122         u_int32_t               nb_valid;       /* valid pages in buf */
 123         u_int32_t               nb_dirty;       /* dirty pages in buf */
 124         int                     nb_validoff;    /* offset in buffer of valid region. */
 125         int                     nb_validend;    /* offset of end of valid region. */
 126         int                     nb_dirtyoff;    /* offset in buffer of dirty region. */
 127         int                     nb_dirtyend;    /* offset of end of dirty region. */
 128         caddr_t                 nb_data;        /* mapped buffer */
 129         vnode_t                 nb_vp;          /* device vnode */
 130         proc_t                  nb_proc;        /* associated proc; NULL if kernel. */
 131         struct ucred *          nb_rcred;       /* read credentials reference */
 132         struct ucred *          nb_wcred;       /* write credentials reference */
 133         void *                  nb_pagelist;    /* upl */
 134 };
 135
 136 /*
 137  * These flags are kept in b_lflags...
 138  * nfs_buf_mutex must be held before examining/updating
 139  */
 140 #define NBL_BUSY        0x00000001      /* I/O in progress. */
 141 #define NBL_WANTED      0x00000002      /* Process wants this buffer. */
 142
 143 /*
 144  * These flags are kept in nb_flags and they're (purposefully)
 145  * very similar to the B_* flags for struct buf.
 146  * nfs_buf_mutex is not needed to examine/update these.
 147  */
 148 #define NB_NEEDCOMMIT   0x00000002      /* Append-write in progress. */
 149 #define NB_ASYNC        0x00000004      /* Start I/O, do not wait. */
 150 #define NB_CACHE        0x00000020      /* Bread found us in the cache. */
 151 #define NB_STABLE       0x00000040      /* write FILESYNC not UNSTABLE. */
 152 #define NB_DELWRI       0x00000080      /* Delay I/O until buffer reused. */
 153 #define NB_DONE         0x00000200      /* I/O completed. */
 154 #define NB_EINTR        0x00000400      /* I/O was interrupted */
 155 #define NB_ERROR        0x00000800      /* I/O error occurred. */
 156 #define NB_WASDIRTY     0x00001000      /* page was found dirty in the VM cache */
 157 #define NB_INVAL        0x00002000      /* Does not contain valid info. */
 158 #define NB_NOCACHE      0x00008000      /* Do not cache block after use. */
 159 #define NB_READ         0x00100000      /* Read buffer. */
 160 #define NB_PAGELIST     0x00400000      /* Buffer describes pagelist I/O. */
 161 #define NB_WRITE        0x00000000      /* Write buffer (pseudo flag). */
 162 #define NB_WRITEINPROG  0x01000000      /* Write in progress. */
 163 #define NB_META         0x40000000      /* buffer contains meta-data. */
 164 #define NB_IOD          0x80000000      /* buffer being handled by nfsiod. */
 165
 166 /* Flags for operation type in nfs_buf_get() */
 167 #define NBLK_READ       0x00000001      /* buffer for read */
 168 #define NBLK_WRITE      0x00000002      /* buffer for write */
 169 #define NBLK_META       0x00000004      /* buffer for metadata */
 170 #define NBLK_OPMASK     0x00000007      /* operation mask */
 171 /* modifiers for above flags... */
 172 #define NBLK_NOWAIT     0x40000000      /* don't wait on busy buffer */
 173 #define NBLK_ONLYVALID  0x80000000      /* only return cached buffer */
 174
 175 /* These flags are used for nfsbuf iterating */
 176 #define NBI_ITER                0x01    /* iteration in progress */
 177 #define NBI_ITERWANT            0x02    /* waiting to iterate */
 178 #define NBI_CLEAN               0x04    /* requesting clean buffers */
 179 #define NBI_DIRTY               0x08    /* requesting dirty buffers */
 180 #define NBI_NOWAIT              0x10    /* don't block on NBI_ITER */
 181
 182 /* Flags for nfs_buf_acquire */
 183 #define NBAC_NOWAIT             0x01    /* Don't wait if buffer is busy */
 184 #define NBAC_REMOVE             0x02    /* Remove from free list once buffer is acquired */
 185
 186 /* some convenience macros...  */
 187 #define NBOFF(BP)                       ((off_t)(BP)->nb_lblkno * (off_t)(BP)->nb_bufsize)
 188 #define NBPGVALID(BP,P)                 (((BP)->nb_valid >> (P)) & 0x1)
 189 #define NBPGDIRTY(BP,P)                 (((BP)->nb_dirty >> (P)) & 0x1)
 190 #define NBPGVALID_SET(BP,P)             ((BP)->nb_valid |= (1 << (P)))
 191 #define NBPGDIRTY_SET(BP,P)             ((BP)->nb_dirty |= (1 << (P)))
 192
 193 #define NBUFSTAMPVALID(BP)              ((BP)->nb_timestamp != ~0)
 194 #define NBUFSTAMPINVALIDATE(BP)         ((BP)->nb_timestamp = ~0)
 195
 196 #define NFS_BUF_MAP(BP) \
 197         do { \
 198                 if (!(BP)->nb_data && nfs_buf_map(BP)) \
 199                         panic("nfs_buf_map failed"); \
 200         } while (0)
 201
 202 LIST_HEAD(nfsbuflists, nfsbuf);
 203 TAILQ_HEAD(nfsbuffreehead, nfsbuf);
 204
 205 #define NFSNOLIST ((struct nfsbuf *)0xdeadbeef)
 206
 207 extern lck_mtx_t *nfs_buf_mutex;
 208 extern int nfsbufcnt, nfsbufmin, nfsbufmax, nfsbufmetacnt, nfsbufmetamax;
 209 extern int nfsbuffreecnt, nfsbuffreemetacnt, nfsbufdelwricnt, nfsneedbuffer;
 210 extern int nfs_nbdwrite;
 211 extern struct nfsbuffreehead nfsbuffree, nfsbufdelwri;
 212 extern time_t nfsbuffreeuptimestamp;
 213
 214 #define NFSBUFCNTCHK(locked) \
 215         do { \
 216         if (!locked) lck_mtx_lock(nfs_buf_mutex); \
 217         if (    (nfsbufcnt < 0) || \
 218                 (nfsbufcnt > nfsbufmax) || \
 219                 (nfsbufmetacnt < 0) || \
 220                 (nfsbufmetacnt > nfsbufmetamax) || \
 221                 (nfsbufmetacnt > nfsbufcnt) || \
 222                 (nfsbuffreecnt < 0) || \
 223                 (nfsbuffreecnt > nfsbufmax) || \
 224                 (nfsbuffreecnt > nfsbufcnt) || \
 225                 (nfsbuffreemetacnt < 0) || \
 226                 (nfsbuffreemetacnt > nfsbufmax) || \
 227                 (nfsbuffreemetacnt > nfsbufcnt) || \
 228                 (nfsbuffreemetacnt > nfsbufmetamax) || \
 229                 (nfsbuffreemetacnt > nfsbufmetacnt) || \
 230                 (nfsbufdelwricnt < 0) || \
 231                 (nfsbufdelwricnt > nfsbufmax) || \
 232                 (nfsbufdelwricnt > nfsbufcnt) || \
 233                 (nfs_nbdwrite < 0) || \
 234                 (nfs_nbdwrite > nfsbufcnt) || \
 235                 0) \
 236                 panic("nfsbuf count error: max %d meta %d cnt %d meta %d free %d meta %d delwr %d bdw %d\n", \
 237                         nfsbufmax, nfsbufmetamax, nfsbufcnt, nfsbufmetacnt, nfsbuffreecnt, nfsbuffreemetacnt, \
 238                         nfsbufdelwricnt, nfs_nbdwrite); \
 239         if (!locked) lck_mtx_unlock(nfs_buf_mutex); \
 240         } while (0)
 241
 242 struct nfs_vattr {
 243         enum vtype      nva_type;       /* vnode type (for create) */
 244         u_short         nva_mode;       /* files access mode and type */
 245         dev_t           nva_rdev;       /* device the special file represents */
 246         uid_t           nva_uid;        /* owner user id */
 247         gid_t           nva_gid;        /* owner group id */
 248         uint32_t        nva_fsid;       /* file system id (dev for now) */
 249         uint64_t        nva_nlink;      /* number of references to file */
 250         uint64_t        nva_fileid;     /* file id */
 251         uint64_t        nva_size;       /* file size in bytes */
 252         uint64_t        nva_bytes;      /* bytes of disk space held by file */
 253         uint32_t        nva_blocksize;  /* blocksize preferred for i/o */
 254         struct timespec nva_atime;      /* time of last access */
 255         struct timespec nva_mtime;      /* time of last modification */
 256         struct timespec nva_ctime;      /* time file changed */
 257 };
 258
 259 /*
 260  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
 261  * is purely coincidental.
 262  * There is a unique nfsnode allocated for each active file,
 263  * each current directory, each mounted-on file, text file, and the root.
 264  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
 265  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
 266  * type definitions), file handles of > 32 bytes should probably be split out
 267  * into a separate MALLOC()'d data structure. (Reduce the size of nfsnode.n_fh
 268  * by changing the definition in nfsproto.h of NFS_SMALLFH.)
 269  * NB: Hopefully the current order of the fields is such that everything will
 270  *     be well aligned and, therefore, tightly packed.
 271  */
 272 struct nfsnode {
 273         LIST_ENTRY(nfsnode)     n_hash;         /* Hash chain */
 274         u_quad_t                n_size;         /* Current size of file */
 275         struct nfs_vattr        n_vattr;        /* Vnode attribute cache */
 276         time_t                  n_attrstamp;    /* Attr. cache timestamp */
 277         u_int32_t               n_mode;         /* ACCESS mode cache */
 278         uid_t                   n_modeuid;      /* credentials having mode */
 279         time_t                  n_modestamp;    /* mode cache timestamp */
 280         struct timespec         n_mtime;        /* Prev modify time. */
 281         struct timespec         n_ncmtime;      /* namecache modify time. */
 282         u_char                  *n_fhp;         /* NFS File Handle */
 283         union {
 284                 vnode_t         n_vp;           /* associated vnode */
 285                 mount_t         n_mp;           /* associated mount (NINIT) */
 286         } n_un0;
 287         struct lockf            *n_lockf;       /* Locking record of file */
 288         int                     n_error;        /* Save write error value */
 289         union {
 290                 struct timespec nf_atim;        /* Special file times */
 291                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
 292         } n_un1;
 293         union {
 294                 struct timespec nf_mtim;
 295                 off_t           nd_direof;      /* Dir. EOF offset cache */
 296         } n_un2;
 297         union {
 298                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
 299                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
 300         } n_un3;
 301         short                   n_fhsize;       /* size in bytes, of fh */
 302         short                   n_flag;         /* Flag for locking.. */
 303         u_char                  n_fh[NFS_SMALLFH];/* Small File Handle */
 304         u_int64_t               n_xid;          /* last xid to loadattr */
 305         struct nfsbuflists      n_cleanblkhd;   /* clean blocklist head */
 306         struct nfsbuflists      n_dirtyblkhd;   /* dirty blocklist head */
 307         int                     n_needcommitcnt;/* # bufs that need committing */
 308         int                     n_bufiterflags; /* buf iterator flags */
 309 };
 310
 311 #define nfstimespeccmp(tvp, uvp, cmp)           \
 312         (((tvp)->tv_sec == (uvp)->tv_sec) ?     \
 313          ((tvp)->tv_nsec cmp (uvp)->tv_nsec) :  \
 314          ((tvp)->tv_sec cmp (uvp)->tv_sec))
 315
 316 #define CHECK_NEEDCOMMITCNT(np) \
 317         do { \
 318                 if ((np)->n_needcommitcnt < 0) { \
 319                         printf("nfs: n_needcommitcnt negative\n"); \
 320                         (np)->n_needcommitcnt = 0; \
 321                 } \
 322         } while (0)
 323
 324 #define n_vnode         n_un0.n_vp
 325 #define n_mount         n_un0.n_mp
 326 #define n_atim          n_un1.nf_atim
 327 #define n_mtim          n_un2.nf_mtim
 328 #define n_sillyrename   n_un3.nf_silly
 329 #define n_cookieverf    n_un1.nd_cookieverf
 330 #define n_direofoffset  n_un2.nd_direof
 331 #define n_cookies       n_un3.nd_cook
 332
 333 /*
 334  * Flags for n_flag
 335  */
 336 #define NFLUSHWANT      0x0001  /* Want wakeup from a flush in prog. */
 337 #define NFLUSHINPROG    0x0002  /* Avoid multiple calls to vinvalbuf() */
 338 #define NMODIFIED       0x0004  /* Might have a modified buffer in bio */
 339 #define NWRITEERR       0x0008  /* Flag write errors so close will know */
 340 #define NNEEDINVALIDATE 0x0010  /* need to call vinvalbuf() */
 341 #define NNOCACHE        0x0020  /* all bufs are uncached */
 342 #define NWRBUSY         0x0040  /* node in write/fsync */
 343 #define NACC            0x0100  /* Special file accessed */
 344 #define NUPD            0x0200  /* Special file updated */
 345 #define NCHG            0x0400  /* Special file times changed */
 346 #define NHASHED         0x1000  /* someone wants to lock */
 347 #define NINIT           0x2000  /* node is being initialized */
 348 #define NWINIT          0x4000  /* someone waiting for init to complete */
 349
 350 #define NATTRVALID(np)          ((np)->n_attrstamp != ~0)
 351 #define NATTRINVALIDATE(np)     ((np)->n_attrstamp = ~0)
 352 #define NMODEVALID(np)          ((np)->n_modestamp != ~0)
 353 #define NMODEINVALIDATE(np)     ((np)->n_modestamp = ~0)
 354
 355 #define NVALIDBUFS(np)  (!LIST_EMPTY(&(np)->n_dirtyblkhd) || \
 356                          !LIST_EMPTY(&(np)->n_cleanblkhd))
 357
 358 /*
 359  * NFS-specific flags for nfs_vinvalbuf/nfs_flush
 360  */
 361 #define V_IGNORE_WRITEERR       0x8000
 362
 363 /*
 364  * Flags for nfs_nget()
 365  */
 366 #define NG_MARKROOT     0x0001  /* mark vnode as root of FS */
 367 #define NG_MAKEENTRY    0x0002  /* add name cache entry for vnode */
 368
 369 /*
 370  * Convert between nfsnode pointers and vnode pointers
 371  */
 372 #define VTONFS(vp)      ((struct nfsnode *)vnode_fsnode(vp))
 373 #define NFSTOV(np)      ((np)->n_vnode)
 374
 375 /* nfsnode hash table mutex */
 376 extern lck_mtx_t *nfs_node_hash_mutex;
 377
 378 /*
 379  * nfsiod structures
 380  */
 381 extern proc_t nfs_iodwant[NFS_MAXASYNCDAEMON];
 382 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
 383 extern lck_grp_t *nfs_iod_lck_grp;
 384 extern lck_grp_attr_t *nfs_iod_lck_grp_attr;
 385 extern lck_attr_t *nfs_iod_lck_attr;
 386 extern lck_mtx_t *nfs_iod_mutex;
 387
 388 #if defined(KERNEL)
 389
 390 typedef int     vnop_t(void *);
 391 extern  vnop_t  **fifo_nfsv2nodeop_p;
 392 extern  vnop_t  **nfsv2_vnodeop_p;
 393 extern  vnop_t  **spec_nfsv2nodeop_p;
 394
 395 /*
 396  * Prototypes for NFS vnode operations
 397  */
 398 int     nfs_write(struct vnop_write_args *);
 399 #define nfs_revoke nop_revoke
 400 #define nfs_seek ((int (*)(struct  vnop_seek_args *))nullop) //XXXdead?
 401 int     nfs_inactive(struct vnop_inactive_args *);
 402 int     nfs_reclaim(struct vnop_reclaim_args *);
 403
 404
 405 /* other stuff */
 406 int     nfs_removeit(struct sillyrename *);
 407 int     nfs_nget(mount_t,vnode_t,struct componentname *,u_char *,int,struct nfs_vattr *,u_int64_t *,int,struct nfsnode **);
 408 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
 409 void nfs_invaldir(vnode_t);
 410
 411 /* nfsbuf functions */
 412 void nfs_nbinit(void);
 413 void nfs_buf_remfree(struct nfsbuf *);
 414 boolean_t nfs_buf_is_incore(vnode_t, daddr64_t);
 415 struct nfsbuf * nfs_buf_incore(vnode_t, daddr64_t);
 416 int nfs_buf_get(vnode_t, daddr64_t, int, proc_t, int, struct nfsbuf **);
 417 int nfs_buf_upl_setup(struct nfsbuf *bp);
 418 void nfs_buf_upl_check(struct nfsbuf *bp);
 419 void nfs_buf_release(struct nfsbuf *, int);
 420 int nfs_buf_iowait(struct nfsbuf *);
 421 void nfs_buf_iodone(struct nfsbuf *);
 422 void nfs_buf_write_delayed(struct nfsbuf *, proc_t);
 423 void nfs_buf_freeup(int);
 424 void nfs_buf_refget(struct nfsbuf *bp);
 425 void nfs_buf_refrele(struct nfsbuf *bp);
 426 void nfs_buf_drop(struct nfsbuf *);
 427 errno_t nfs_buf_acquire(struct nfsbuf *, int, int, int);
 428 int nfs_buf_iterprepare(struct nfsnode *, struct nfsbuflists *, int);
 429 void nfs_buf_itercomplete(struct nfsnode *, struct nfsbuflists *, int);
 430
 431 #endif /* KERNEL */
 432
 433 #endif /* __APPLE_API_PRIVATE */
 434 #endif /* _NFS_NFSNODE_H_ */