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/sys/namei.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 /*      $NetBSD: namei.h,v 1.45.8.2 2007/02/17 23:27:51 tron Exp $      */
    2 
    3 /*
    4  * Copyright (c) 1985, 1989, 1991, 1993
    5  *      The Regents of the University of California.  All rights reserved.
    6  *
    7  * Redistribution and use in source and binary forms, with or without
    8  * modification, are permitted provided that the following conditions
    9  * are met:
   10  * 1. Redistributions of source code must retain the above copyright
   11  *    notice, this list of conditions and the following disclaimer.
   12  * 2. Redistributions in binary form must reproduce the above copyright
   13  *    notice, this list of conditions and the following disclaimer in the
   14  *    documentation and/or other materials provided with the distribution.
   15  * 3. Neither the name of the University nor the names of its contributors
   16  *    may be used to endorse or promote products derived from this software
   17  *    without specific prior written permission.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   29  * SUCH DAMAGE.
   30  *
   31  *      @(#)namei.h     8.5 (Berkeley) 8/20/94
   32  */
   33 
   34 #ifndef _SYS_NAMEI_H_
   35 #define _SYS_NAMEI_H_
   36 
   37 #include <sys/queue.h>
   38 
   39 #ifdef _KERNEL
   40 /*
   41  * Encapsulation of namei parameters.
   42  */
   43 struct nameidata {
   44         /*
   45          * Arguments to namei/lookup.
   46          */
   47         const char *ni_dirp;            /* pathname pointer */
   48         enum    uio_seg ni_segflg;      /* location of pathname */
   49      /* u_long  ni_nameiop;                namei operation */
   50      /* u_long  ni_flags;                  flags to namei */
   51      /* struct  proc *ni_proc;             process requesting lookup */
   52         /*
   53          * Arguments to lookup.
   54          */
   55      /* kauth_cred_t ni_cred;              credentials */
   56         struct  vnode *ni_startdir;     /* starting directory */
   57         struct  vnode *ni_rootdir;      /* logical root directory */
   58         /*
   59          * Results: returned from/manipulated by lookup
   60          */
   61         struct  vnode *ni_vp;           /* vnode of result */
   62         struct  vnode *ni_dvp;          /* vnode of intermediate directory */
   63         /*
   64          * Shared between namei and lookup/commit routines.
   65          */
   66         size_t  ni_pathlen;             /* remaining chars in path */
   67         const char *ni_next;            /* next location in pathname */
   68         u_long  ni_loopcnt;             /* count of symlinks encountered */
   69         /*
   70          * Lookup parameters: this structure describes the subset of
   71          * information from the nameidata structure that is passed
   72          * through the VOP interface.
   73          */
   74         struct componentname {
   75                 /*
   76                  * Arguments to lookup.
   77                  */
   78                 u_long  cn_nameiop;     /* namei operation */
   79                 u_long  cn_flags;       /* flags to namei */
   80                 struct  lwp *cn_lwp;    /* lwp requesting lookup */
   81                 kauth_cred_t cn_cred;   /* credentials */
   82                 /*
   83                  * Shared between lookup and commit routines.
   84                  */
   85                 char    *cn_pnbuf;      /* pathname buffer */
   86                 const char *cn_nameptr; /* pointer to looked up name */
   87                 long    cn_namelen;     /* length of looked up component */
   88                 u_long  cn_hash;        /* hash value of looked up name */
   89                 long    cn_consume;     /* chars to consume in lookup() */
   90         } ni_cnd;
   91 };
   92 
   93 /*
   94  * namei operations
   95  */
   96 #define LOOKUP          0       /* perform name lookup only */
   97 #define CREATE          1       /* setup for file creation */
   98 #define DELETE          2       /* setup for file deletion */
   99 #define RENAME          3       /* setup for file renaming */
  100 #define OPMASK          3       /* mask for operation */
  101 /*
  102  * namei operational modifier flags, stored in ni_cnd.cn_flags
  103  */
  104 #define LOCKLEAF        0x0004  /* lock inode on return */
  105 #define LOCKPARENT      0x0008  /* want parent vnode returned locked */
  106 #define NOCACHE         0x0020  /* name must not be left in cache */
  107 #define FOLLOW          0x0040  /* follow symbolic links */
  108 #define NOFOLLOW        0x0000  /* do not follow symbolic links (pseudo) */
  109 #define MODMASK         0x00fc  /* mask of operational modifiers */
  110 /*
  111  * Namei parameter descriptors.
  112  *
  113  * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
  114  * If the caller of namei sets the flag (for example execve wants to
  115  * know the name of the program that is being executed), then it must
  116  * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
  117  * be freed by either the commit routine or the VOP_ABORT routine.
  118  * SAVESTART is set only by the callers of namei. It implies SAVENAME
  119  * plus the addition of saving the parent directory that contains the
  120  * name in ni_startdir. It allows repeated calls to lookup for the
  121  * name being sought. The caller is responsible for releasing the
  122  * buffer and for vrele'ing ni_startdir.
  123  */
  124 #define NOCROSSMOUNT    0x0000100       /* do not cross mount points */
  125 #define RDONLY          0x0000200       /* lookup with read-only semantics */
  126 #define HASBUF          0x0000400       /* has allocated pathname buffer */
  127 #define SAVENAME        0x0000800       /* save pathname buffer */
  128 #define SAVESTART       0x0001000       /* save starting directory */
  129 #define ISDOTDOT        0x0002000       /* current component name is .. */
  130 #define MAKEENTRY       0x0004000       /* entry is to be added to name cache */
  131 #define ISLASTCN        0x0008000       /* this is last component of pathname */
  132 #define ISSYMLINK       0x0010000       /* symlink needs interpretation */
  133 #define ISWHITEOUT      0x0020000       /* found whiteout */
  134 #define DOWHITEOUT      0x0040000       /* do whiteouts */
  135 #define REQUIREDIR      0x0080000       /* must be a directory */
  136 #define CREATEDIR       0x0200000       /* trailing slashes are ok */
  137 #define PARAMASK        0x03fff00       /* mask of parameter descriptors */
  138 /*
  139  * Initialization of an nameidata structure.
  140  */
  141 #define NDINIT(ndp, op, flags, segflg, namep, l) { \
  142         (ndp)->ni_cnd.cn_nameiop = op; \
  143         (ndp)->ni_cnd.cn_flags = flags; \
  144         (ndp)->ni_segflg = segflg; \
  145         (ndp)->ni_dirp = namep; \
  146         (ndp)->ni_cnd.cn_lwp = l; \
  147         (ndp)->ni_cnd.cn_cred = l->l_cred; \
  148 }
  149 #endif
  150 
  151 /*
  152  * This structure describes the elements in the cache of recent
  153  * names looked up by namei. NCHNAMLEN is sized to make structure
  154  * size a power of two to optimize malloc's. Minimum reasonable
  155  * size is 15.
  156  */
  157 
  158 #define NCHNAMLEN       31      /* maximum name segment length we bother with */
  159 
  160 struct  namecache {
  161         LIST_ENTRY(namecache) nc_hash;  /* hash chain */
  162         TAILQ_ENTRY(namecache) nc_lru;  /* LRU chain */
  163         LIST_ENTRY(namecache) nc_vhash; /* directory hash chain */
  164         LIST_ENTRY(namecache) nc_dvlist;
  165         struct  vnode *nc_dvp;          /* vnode of parent of name */
  166         LIST_ENTRY(namecache) nc_vlist;
  167         struct  vnode *nc_vp;           /* vnode the name refers to */
  168         int     nc_flags;               /* copy of componentname's ISWHITEOUT */
  169         char    nc_nlen;                /* length of name */
  170         char    nc_name[NCHNAMLEN];     /* segment name */
  171 };
  172 
  173 #ifdef _KERNEL
  174 #include <sys/mallocvar.h>
  175 #include <sys/pool.h>
  176 
  177 struct mount;
  178 
  179 extern struct pool pnbuf_pool;          /* pathname buffer pool */
  180 extern struct pool_cache pnbuf_cache;   /* pathname buffer cache */
  181 
  182 #define PNBUF_GET()     pool_cache_get(&pnbuf_cache, PR_WAITOK)
  183 #define PNBUF_PUT(pnb)  pool_cache_put(&pnbuf_cache, (pnb))
  184 
  185 typedef struct pathname_internal *pathname_t;
  186 
  187 int     namei(struct nameidata *);
  188 uint32_t namei_hash(const char *, const char **);
  189 int     lookup(struct nameidata *);
  190 int     relookup(struct vnode *, struct vnode **, struct componentname *);
  191 void    cache_purge1(struct vnode *, const struct componentname *, int);
  192 #define PURGE_PARENTS   1
  193 #define PURGE_CHILDREN  2
  194 #define cache_purge(vp) cache_purge1((vp), NULL, PURGE_PARENTS|PURGE_CHILDREN)
  195 int     cache_lookup(struct vnode *, struct vnode **, struct componentname *);
  196 int     cache_lookup_raw(struct vnode *, struct vnode **,
  197                          struct componentname *);
  198 int     cache_revlookup(struct vnode *, struct vnode **, char **, char *);
  199 void    cache_enter(struct vnode *, struct vnode *, struct componentname *);
  200 void    nchinit(void);
  201 void    nchreinit(void);
  202 void    cache_purgevfs(struct mount *);
  203 void    namecache_print(struct vnode *, void (*)(const char *, ...));
  204 
  205 int pathname_get(const char *, enum uio_seg, pathname_t *);
  206 const char *pathname_path(pathname_t);
  207 void pathname_put(pathname_t);
  208 #endif
  209 
  210 /*
  211  * Stats on usefulness of namei caches.
  212  * XXX: should be 64-bit counters.
  213  */
  214 struct  nchstats {
  215         long    ncs_goodhits;           /* hits that we can really use */
  216         long    ncs_neghits;            /* negative hits that we can use */
  217         long    ncs_badhits;            /* hits we must drop */
  218         long    ncs_falsehits;          /* hits with id mismatch */
  219         long    ncs_miss;               /* misses */
  220         long    ncs_long;               /* long names that ignore cache */
  221         long    ncs_pass2;              /* names found with passes == 2 */
  222         long    ncs_2passes;            /* number of times we attempt it */
  223         long    ncs_revhits;            /* reverse-cache hits */
  224         long    ncs_revmiss;            /* reverse-cache misses */
  225 };
  226 
  227 #ifdef _KERNEL
  228 extern struct nchstats nchstats;
  229 #endif
  230 #endif /* !_SYS_NAMEI_H_ */

Cache object: a004ad54d236e0ffc1313efb9f154345


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