The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/nfsclient/nfsnode.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 1989, 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  * 4. Neither the name of the University nor the names of its contributors
   17  *    may be used to endorse or promote products derived from this software
   18  *    without specific prior written permission.
   19  *
   20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   30  * SUCH DAMAGE.
   31  *
   32  *      @(#)nfsnode.h   8.9 (Berkeley) 5/14/95
   33  * $FreeBSD$
   34  */
   35 
   36 #ifndef _NFSCLIENT_NFSNODE_H_
   37 #define _NFSCLIENT_NFSNODE_H_
   38 
   39 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
   40 #include <nfs/nfs.h>
   41 #endif
   42 
   43 /*
   44  * Silly rename structure that hangs off the nfsnode until the name
   45  * can be removed by nfs_inactive()
   46  */
   47 struct sillyrename {
   48         struct  ucred *s_cred;
   49         struct  vnode *s_dvp;
   50         int     (*s_removeit)(struct sillyrename *sp);
   51         long    s_namlen;
   52         char    s_name[32];
   53 };
   54 
   55 /*
   56  * This structure is used to save the logical directory offset to
   57  * NFS cookie mappings.
   58  * The mappings are stored in a list headed
   59  * by n_cookies, as required.
   60  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
   61  * stored in increasing logical offset byte order.
   62  */
   63 #define NFSNUMCOOKIES           31
   64 
   65 struct nfsdmap {
   66         LIST_ENTRY(nfsdmap)     ndm_list;
   67         int                     ndm_eocookie;
   68         union {
   69                 nfsuint64       ndmu3_cookies[NFSNUMCOOKIES];
   70                 uint64_t        ndmu4_cookies[NFSNUMCOOKIES];
   71         } ndm_un1;
   72 };
   73 
   74 #define ndm_cookies     ndm_un1.ndmu3_cookies
   75 #define ndm4_cookies    ndm_un1.ndmu4_cookies
   76 
   77 /*
   78  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
   79  * is purely coincidental.
   80  * There is a unique nfsnode allocated for each active file,
   81  * each current directory, each mounted-on file, text file, and the root.
   82  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
   83  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
   84  * type definitions), file handles of > 32 bytes should probably be split out
   85  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
   86  * changing the definition in nfsproto.h of NFS_SMALLFH.)
   87  * NB: Hopefully the current order of the fields is such that everything will
   88  *     be well aligned and, therefore, tightly packed.
   89  */
   90 struct nfsnode {
   91         u_quad_t                n_size;         /* Current size of file */
   92         u_quad_t                n_brev;         /* Modify rev when cached */
   93         u_quad_t                n_lrev;         /* Modify rev for lease */
   94         struct vattr            n_vattr;        /* Vnode attribute cache */
   95         time_t                  n_attrstamp;    /* Attr. cache timestamp */
   96         u_int32_t               n_mode;         /* ACCESS mode cache */
   97         uid_t                   n_modeuid;      /* credentials having mode */
   98         time_t                  n_modestamp;    /* mode cache timestamp */
   99         struct timespec         n_mtime;        /* Prev modify time. */
  100         time_t                  n_ctime;        /* Prev create time. */
  101         time_t                  n_expiry;       /* Lease expiry time */
  102         nfsfh_t                 *n_fhp;         /* NFS File Handle */
  103         struct vnode            *n_vnode;       /* associated vnode */
  104         struct vnode            *n_dvp;         /* parent vnode */
  105         struct lockf            *n_lockf;       /* Locking record of file */
  106         int                     n_error;        /* Save write error value */
  107         union {
  108                 struct timespec nf_atim;        /* Special file times */
  109                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
  110                 u_char          nd4_cookieverf[NFSX_V4VERF];
  111         } n_un1;
  112         union {
  113                 struct timespec nf_mtim;
  114                 off_t           nd_direof;      /* Dir. EOF offset cache */
  115         } n_un2;
  116         union {
  117                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
  118                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
  119         } n_un3;
  120         short                   n_fhsize;       /* size in bytes, of fh */
  121         short                   n_flag;         /* Flag for locking.. */
  122         nfsfh_t                 n_fh;           /* Small File Handle */
  123         struct lock             n_rslock;
  124         struct nfs4_fctx        n_rfc;
  125         struct nfs4_fctx        n_wfc;
  126         u_char                  *n_name;        /* leaf name, for v4 OPEN op */
  127         uint32_t                n_namelen;
  128         daddr_t                 ra_expect_lbn;
  129         int                     n_directio_opens;
  130         int                     n_directio_asyncwr;
  131 };
  132 
  133 #define n_atim          n_un1.nf_atim
  134 #define n_mtim          n_un2.nf_mtim
  135 #define n_sillyrename   n_un3.nf_silly
  136 #define n_cookieverf    n_un1.nd_cookieverf
  137 #define n4_cookieverf   n_un1.nd4_cookieverf
  138 #define n_direofoffset  n_un2.nd_direof
  139 #define n_cookies       n_un3.nd_cook
  140 
  141 /*
  142  * Flags for n_flag
  143  */
  144 #define NMODIFIED       0x0004  /* Might have a modified buffer in bio */
  145 #define NWRITEERR       0x0008  /* Flag write errors so close will know */
  146 /* 0x20, 0x40, 0x80 free */
  147 #define NACC            0x0100  /* Special file accessed */
  148 #define NUPD            0x0200  /* Special file updated */
  149 #define NCHG            0x0400  /* Special file times changed */
  150 #define NCREATED        0x0800  /* Opened by nfs_create() */
  151 #define NTRUNCATE       0x1000  /* Opened by nfs_setattr() */
  152 #define NSIZECHANGED    0x2000  /* File size has changed: need cache inval */
  153 #define NNONCACHE       0x4000  /* Node marked as noncacheable */
  154 #define NFSYNCWAIT      0x8000  /* fsync waiting for all directio async writes 
  155                                    to drain */
  156 
  157 /*
  158  * Convert between nfsnode pointers and vnode pointers
  159  */
  160 #define VTONFS(vp)      ((struct nfsnode *)(vp)->v_data)
  161 #define NFSTOV(np)      ((struct vnode *)(np)->n_vnode)
  162 
  163 #define NFS_TIMESPEC_COMPARE(T1, T2)    (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
  164 
  165 /*
  166  * Queue head for nfsiod's
  167  */
  168 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
  169 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
  170 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
  171 
  172 #if defined(_KERNEL)
  173 
  174 /*
  175  *      nfs_rslock -    Attempt to obtain lock on nfsnode
  176  *
  177  *      Attempt to obtain a lock on the passed nfsnode, returning ENOLCK
  178  *      if the lock could not be obtained due to our having to sleep.  This
  179  *      function is generally used to lock around code that modifies an
  180  *      NFS file's size.  In order to avoid deadlocks the lock
  181  *      should not be obtained while other locks are being held.
  182  */
  183 
  184 static __inline int
  185 nfs_rslock(struct nfsnode *np, struct thread *td)
  186 {
  187 
  188         return(lockmgr(&np->n_rslock,
  189             LK_EXCLUSIVE | LK_CANRECURSE | LK_SLEEPFAIL, NULL, td));
  190 }
  191 
  192 static __inline void
  193 nfs_rsunlock(struct nfsnode *np, struct thread *td)
  194 {
  195 
  196         (void)lockmgr(&np->n_rslock, LK_RELEASE, NULL, td);
  197 }
  198 
  199 extern  struct vop_vector       nfs_fifoops;
  200 extern  struct vop_vector       nfs_vnodeops;
  201 extern  struct vop_vector       nfs4_vnodeops;
  202 extern struct buf_ops buf_ops_nfs;
  203 extern struct buf_ops buf_ops_nfs4;
  204 
  205 /*
  206  * Prototypes for NFS vnode operations
  207  */
  208 int     nfs_getpages(struct vop_getpages_args *);
  209 int     nfs_putpages(struct vop_putpages_args *);
  210 int     nfs_write(struct vop_write_args *);
  211 int     nfs_inactive(struct vop_inactive_args *);
  212 int     nfs_reclaim(struct vop_reclaim_args *);
  213 
  214 /* other stuff */
  215 int     nfs_removeit(struct sillyrename *);
  216 int     nfs4_removeit(struct sillyrename *);
  217 int     nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
  218 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
  219 uint64_t *nfs4_getcookie(struct nfsnode *, off_t, int);
  220 void    nfs_invaldir(struct vnode *);
  221 void    nfs4_invaldir(struct vnode *);
  222 
  223 #endif /* _KERNEL */
  224 
  225 #endif

Cache object: b7cba35320f4e25cce9fce33482749d5


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.