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/fs/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  * $FreeBSD: releng/8.0/sys/fs/nfsclient/nfsnode.h 191783 2009-05-04 15:23:58Z rmacklem $
   33  */
   34 
   35 #ifndef _NFSCLIENT_NFSNODE_H_
   36 #define _NFSCLIENT_NFSNODE_H_
   37 
   38 /*
   39  * Silly rename structure that hangs off the nfsnode until the name
   40  * can be removed by nfs_inactive()
   41  */
   42 struct sillyrename {
   43         struct  ucred *s_cred;
   44         struct  vnode *s_dvp;
   45         long    s_namlen;
   46         char    s_name[32];
   47 };
   48 
   49 /*
   50  * This structure is used to save the logical directory offset to
   51  * NFS cookie mappings.
   52  * The mappings are stored in a list headed
   53  * by n_cookies, as required.
   54  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
   55  * stored in increasing logical offset byte order.
   56  */
   57 #define NFSNUMCOOKIES           31
   58 
   59 struct nfsdmap {
   60         LIST_ENTRY(nfsdmap)     ndm_list;
   61         int                     ndm_eocookie;
   62         union {
   63                 nfsuint64       ndmu3_cookies[NFSNUMCOOKIES];
   64                 uint64_t        ndmu4_cookies[NFSNUMCOOKIES];
   65         } ndm_un1;
   66 };
   67 
   68 #define ndm_cookies     ndm_un1.ndmu3_cookies
   69 #define ndm4_cookies    ndm_un1.ndmu4_cookies
   70 
   71 #define n_ac_ts_tid             n_ac_ts.nfs_ac_ts_tid
   72 #define n_ac_ts_pid             n_ac_ts.nfs_ac_ts_pid
   73 #define n_ac_ts_syscalls        n_ac_ts.nfs_ac_ts_syscalls
   74 
   75 struct nfs_attrcache_timestamp {
   76         lwpid_t         nfs_ac_ts_tid;
   77         pid_t           nfs_ac_ts_pid;
   78         unsigned long   nfs_ac_ts_syscalls;     
   79 };
   80 
   81 struct nfs_accesscache {
   82         u_int32_t               mode;   /* ACCESS mode cache */
   83         uid_t                   uid;    /* credentials having mode */
   84         time_t                  stamp;  /* mode cache timestamp */
   85 };
   86 
   87 /*
   88  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
   89  * is purely coincidental.
   90  * There is a unique nfsnode allocated for each active file,
   91  * each current directory, each mounted-on file, text file, and the root.
   92  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
   93  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
   94  * type definitions), file handles of > 32 bytes should probably be split out
   95  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
   96  * changing the definition in nfsproto.h of NFS_SMALLFH.)
   97  * NB: Hopefully the current order of the fields is such that everything will
   98  *     be well aligned and, therefore, tightly packed.
   99  */
  100 struct nfsnode {
  101         struct mtx              n_mtx;          /* Protects all of these members */
  102         u_quad_t                n_size;         /* Current size of file */
  103         u_quad_t                n_brev;         /* Modify rev when cached */
  104         u_quad_t                n_lrev;         /* Modify rev for lease */
  105         struct nfsvattr         n_vattr;        /* Vnode attribute cache */
  106         time_t                  n_attrstamp;    /* Attr. cache timestamp */
  107         struct nfs_accesscache  n_accesscache[NFS_ACCESSCACHESIZE];
  108         struct timespec         n_mtime;        /* Prev modify time. */
  109         time_t                  n_ctime;        /* Prev create time. */
  110         time_t                  n_dmtime;       /* Prev dir modify time. */
  111         time_t                  n_expiry;       /* Lease expiry time */
  112         struct nfsfh            *n_fhp;         /* NFS File Handle */
  113         struct vnode            *n_vnode;       /* associated vnode */
  114         struct vnode            *n_dvp;         /* parent vnode */
  115         struct lockf            *n_lockf;       /* Locking record of file */
  116         int                     n_error;        /* Save write error value */
  117         union {
  118                 struct timespec nf_atim;        /* Special file times */
  119                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
  120                 u_char          nd4_cookieverf[NFSX_VERF];
  121         } n_un1;
  122         union {
  123                 struct timespec nf_mtim;
  124                 off_t           nd_direof;      /* Dir. EOF offset cache */
  125         } n_un2;
  126         union {
  127                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
  128                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
  129         } n_un3;
  130         short                   n_fhsize;       /* size in bytes, of fh */
  131         u_int32_t               n_flag;         /* Flag for locking.. */
  132         int                     n_directio_opens;
  133         int                     n_directio_asyncwr;
  134         struct nfs_attrcache_timestamp n_ac_ts;
  135         u_int64_t                n_change;      /* old Change attribute */
  136         struct nfsv4node        *n_v4;          /* extra V4 stuff */
  137 };
  138 
  139 #define n_atim          n_un1.nf_atim
  140 #define n_mtim          n_un2.nf_mtim
  141 #define n_sillyrename   n_un3.nf_silly
  142 #define n_cookieverf    n_un1.nd_cookieverf
  143 #define n4_cookieverf   n_un1.nd4_cookieverf
  144 #define n_direofoffset  n_un2.nd_direof
  145 #define n_cookies       n_un3.nd_cook
  146 
  147 /*
  148  * Flags for n_flag
  149  */
  150 #define NDIRCOOKIELK    0x00000001  /* Lock to serialize access to directory cookies */
  151 #define NFSYNCWAIT      0x00000002  /* fsync waiting for all directio async
  152                                   writes to drain */
  153 #define NMODIFIED       0x00000004  /* Might have a modified buffer in bio */
  154 #define NWRITEERR       0x00000008  /* Flag write errors so close will know */
  155 #define NCREATED        0x00000010  /* Opened by nfs_create() */
  156 #define NTRUNCATE       0x00000020  /* Opened by nfs_setattr() */
  157 #define NSIZECHANGED    0x00000040  /* File size has changed: need cache inval */
  158 #define NNONCACHE       0x00000080  /* Node marked as noncacheable */
  159 #define NACC            0x00000100  /* Special file accessed */
  160 #define NUPD            0x00000200  /* Special file updated */
  161 #define NCHG            0x00000400  /* Special file times changed */
  162 #define NDELEGMOD       0x00000800  /* Modified delegation */
  163 #define NDELEGRECALL    0x00001000  /* Recall in progress */
  164 #define NREMOVEINPROG   0x00002000  /* Remove in progress */
  165 #define NREMOVEWANT     0x00004000  /* Want notification that remove is done */
  166 #define NLOCK           0x00008000  /* Sleep lock the node */
  167 #define NLOCKWANT       0x00010000  /* Want the sleep lock */
  168 
  169 /*
  170  * Convert between nfsnode pointers and vnode pointers
  171  */
  172 #define VTONFS(vp)      ((struct nfsnode *)(vp)->v_data)
  173 #define NFSTOV(np)      ((struct vnode *)(np)->n_vnode)
  174 
  175 #define NFS_TIMESPEC_COMPARE(T1, T2)    (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
  176 
  177 #if defined(_KERNEL)
  178 
  179 /*
  180  * Prototypes for NFS vnode operations
  181  */
  182 int     ncl_getpages(struct vop_getpages_args *);
  183 int     ncl_putpages(struct vop_putpages_args *);
  184 int     ncl_write(struct vop_write_args *);
  185 int     ncl_inactive(struct vop_inactive_args *);
  186 int     ncl_reclaim(struct vop_reclaim_args *);
  187 
  188 /* other stuff */
  189 int     ncl_removeit(struct sillyrename *, struct vnode *);
  190 int     ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **);
  191 nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
  192 void    ncl_invaldir(struct vnode *);
  193 int     ncl_upgrade_vnlock(struct vnode *);
  194 void    ncl_downgrade_vnlock(struct vnode *, int);
  195 void    ncl_printf(const char *, ...);
  196 void    ncl_dircookie_lock(struct nfsnode *);
  197 void    ncl_dircookie_unlock(struct nfsnode *);
  198 
  199 #endif /* _KERNEL */
  200 
  201 #endif  /* _NFSCLIENT_NFSNODE_H_ */

Cache object: 8139cc3b419e64e1b1a62c40d0bd3d8a


[ 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.