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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-3-Clause
    3  *
    4  * Copyright (c) 1989, 1993
    5  *      The Regents of the University of California.  All rights reserved.
    6  *
    7  * This code is derived from software contributed to Berkeley by
    8  * Rick Macklem at The University of Guelph.
    9  *
   10  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  * 3. Neither the name of the University nor the names of its contributors
   19  *    may be used to endorse or promote products derived from this software
   20  *    without specific prior written permission.
   21  *
   22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   32  * SUCH DAMAGE.
   33  *
   34  * $FreeBSD: stable/12/sys/fs/nfsclient/nfsnode.h 371028 2021-11-18 00:22:09Z git2svn $
   35  */
   36 
   37 #ifndef _NFSCLIENT_NFSNODE_H_
   38 #define _NFSCLIENT_NFSNODE_H_
   39 
   40 #include <sys/_task.h>
   41 
   42 /*
   43  * Silly rename structure that hangs off the nfsnode until the name
   44  * can be removed by nfs_inactive()
   45  */
   46 struct sillyrename {
   47         struct  task s_task;
   48         struct  ucred *s_cred;
   49         struct  vnode *s_dvp;
   50         long    s_namlen;
   51         char    s_name[32];
   52 };
   53 
   54 /*
   55  * This structure is used to save the logical directory offset to
   56  * NFS cookie mappings.
   57  * The mappings are stored in a list headed
   58  * by n_cookies, as required.
   59  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
   60  * stored in increasing logical offset byte order.
   61  */
   62 #define NFSNUMCOOKIES           31
   63 
   64 struct nfsdmap {
   65         LIST_ENTRY(nfsdmap)     ndm_list;
   66         int                     ndm_eocookie;
   67         union {
   68                 nfsuint64       ndmu3_cookies[NFSNUMCOOKIES];
   69                 uint64_t        ndmu4_cookies[NFSNUMCOOKIES];
   70         } ndm_un1;
   71 };
   72 
   73 #define ndm_cookies     ndm_un1.ndmu3_cookies
   74 #define ndm4_cookies    ndm_un1.ndmu4_cookies
   75 
   76 struct nfs_accesscache {
   77         u_int32_t               mode;   /* ACCESS mode cache */
   78         uid_t                   uid;    /* credentials having mode */
   79         time_t                  stamp;  /* mode cache timestamp */
   80 };
   81 
   82 /*
   83  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
   84  * is purely coincidental.
   85  * There is a unique nfsnode allocated for each active file,
   86  * each current directory, each mounted-on file, text file, and the root.
   87  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
   88  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
   89  * type definitions), file handles of > 32 bytes should probably be split out
   90  * into a separate malloc()'d data structure. (Reduce the size of nfsfh_t by
   91  * changing the definition in nfsproto.h of NFS_SMALLFH.)
   92  * NB: Hopefully the current order of the fields is such that everything will
   93  *     be well aligned and, therefore, tightly packed.
   94  */
   95 struct nfsnode {
   96         struct mtx              n_mtx;          /* Protects all of these members */
   97         struct lock             n_excl;         /* Exclusive helper for shared
   98                                                    vnode lock */
   99         u_quad_t                n_size;         /* Current size of file */
  100         u_quad_t                n_brev;         /* Modify rev when cached */
  101         u_quad_t                n_lrev;         /* Modify rev for lease */
  102         struct nfsvattr         n_vattr;        /* Vnode attribute cache */
  103         time_t                  n_attrstamp;    /* Attr. cache timestamp */
  104         struct nfs_accesscache  n_accesscache[NFS_ACCESSCACHESIZE];
  105         struct timespec         n_mtime;        /* Prev modify time. */
  106         struct nfsfh            *n_fhp;         /* NFS File Handle */
  107         struct vnode            *n_vnode;       /* associated vnode */
  108         struct vnode            *n_dvp;         /* parent vnode */
  109         struct lockf            *n_lockf;       /* Locking record of file */
  110         int                     n_error;        /* Save write error value */
  111         union {
  112                 struct timespec nf_atim;        /* Special file times */
  113                 nfsuint64       nd_cookieverf;  /* Cookie verifier (dir only) */
  114                 u_char          nd4_cookieverf[NFSX_VERF];
  115         } n_un1;
  116         union {
  117                 struct timespec nf_mtim;
  118                 off_t           nd_direof;      /* Dir. EOF offset cache */
  119         } n_un2;
  120         union {
  121                 struct sillyrename *nf_silly;   /* Ptr to silly rename struct */
  122                 LIST_HEAD(, nfsdmap) nd_cook;   /* cookies */
  123         } n_un3;
  124         short                   n_fhsize;       /* size in bytes, of fh */
  125         u_int32_t               n_flag;         /* Flag for locking.. */
  126         int                     n_directio_opens;
  127         int                     n_directio_asyncwr;
  128         u_int64_t                n_change;      /* old Change attribute */
  129         struct nfsv4node        *n_v4;          /* extra V4 stuff */
  130         struct ucred            *n_writecred;   /* Cred. for putpages */
  131         struct timespec         n_localmodtime; /* Last local modify */
  132 };
  133 
  134 #define n_atim          n_un1.nf_atim
  135 #define n_mtim          n_un2.nf_mtim
  136 #define n_sillyrename   n_un3.nf_silly
  137 #define n_cookieverf    n_un1.nd_cookieverf
  138 #define n4_cookieverf   n_un1.nd4_cookieverf
  139 #define n_direofoffset  n_un2.nd_direof
  140 #define n_cookies       n_un3.nd_cook
  141 
  142 /*
  143  * Flags for n_flag
  144  */
  145 #define NDIRCOOKIELK    0x00000001  /* Lock to serialize access to directory cookies */
  146 #define NFSYNCWAIT      0x00000002  /* fsync waiting for all directio async
  147                                   writes to drain */
  148 #define NMODIFIED       0x00000004  /* Might have a modified buffer in bio */
  149 #define NWRITEERR       0x00000008  /* Flag write errors so close will know */
  150 #define NCREATED        0x00000010  /* Opened by nfs_create() */
  151 #define NTRUNCATE       0x00000020  /* Opened by nfs_setattr() */
  152 #define NSIZECHANGED    0x00000040  /* File size has changed: need cache inval */
  153 #define NNONCACHE       0x00000080  /* Node marked as noncacheable */
  154 #define NACC            0x00000100  /* Special file accessed */
  155 #define NUPD            0x00000200  /* Special file updated */
  156 #define NCHG            0x00000400  /* Special file times changed */
  157 #define NDELEGMOD       0x00000800  /* Modified delegation */
  158 #define NDELEGRECALL    0x00001000  /* Recall in progress */
  159 #define NREMOVEINPROG   0x00002000  /* Remove in progress */
  160 #define NREMOVEWANT     0x00004000  /* Want notification that remove is done */
  161 #define NLOCK           0x00008000  /* Sleep lock the node */
  162 #define NLOCKWANT       0x00010000  /* Want the sleep lock */
  163 #define NNOLAYOUT       0x00020000  /* Can't get a layout for this file */
  164 #define NWRITEOPENED    0x00040000  /* Has been opened for writing */
  165 #define NHASBEENLOCKED  0x00080000  /* Has been file locked. */
  166 #define NDSCOMMIT       0x00100000  /* Commit is done via the DS. */
  167 #define NVNSETSZSKIP    0x00200000  /* Skipped vnode_pager_setsize() */
  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 **, int);
  191 nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
  192 void    ncl_invaldir(struct vnode *);
  193 bool    ncl_excl_start(struct vnode *);
  194 void    ncl_excl_finish(struct vnode *, bool old_lock);
  195 void    ncl_dircookie_lock(struct nfsnode *);
  196 void    ncl_dircookie_unlock(struct nfsnode *);
  197 
  198 #endif /* _KERNEL */
  199 
  200 #endif  /* _NFSCLIENT_NFSNODE_H_ */

Cache object: 1b5d6298e514bcbfc79f576f07135f12


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