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 /*-
    2  * Copyright (c) 1985, 1989, 1991, 1993
    3  *      The Regents of the University of California.  All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    8  * 1. Redistributions of source code must retain the above copyright
    9  *    notice, this list of conditions and the following disclaimer.
   10  * 2. Redistributions in binary form must reproduce the above copyright
   11  *    notice, this list of conditions and the following disclaimer in the
   12  *    documentation and/or other materials provided with the distribution.
   13  * 4. Neither the name of the University nor the names of its contributors
   14  *    may be used to endorse or promote products derived from this software
   15  *    without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  *      @(#)namei.h     8.5 (Berkeley) 1/9/95
   30  * $FreeBSD: releng/11.0/sys/sys/namei.h 296716 2016-03-12 08:50:38Z trasz $
   31  */
   32 
   33 #ifndef _SYS_NAMEI_H_
   34 #define _SYS_NAMEI_H_
   35 
   36 #include <sys/caprights.h>
   37 #include <sys/filedesc.h>
   38 #include <sys/queue.h>
   39 #include <sys/uio.h>
   40 
   41 struct componentname {
   42         /*
   43          * Arguments to lookup.
   44          */
   45         u_long  cn_nameiop;     /* namei operation */
   46         u_int64_t cn_flags;     /* flags to namei */
   47         struct  thread *cn_thread;/* thread requesting lookup */
   48         struct  ucred *cn_cred; /* credentials */
   49         int     cn_lkflags;     /* Lock flags LK_EXCLUSIVE or LK_SHARED */
   50         /*
   51          * Shared between lookup and commit routines.
   52          */
   53         char    *cn_pnbuf;      /* pathname buffer */
   54         char    *cn_nameptr;    /* pointer to looked up name */
   55         long    cn_namelen;     /* length of looked up component */
   56 };
   57 
   58 /*
   59  * Encapsulation of namei parameters.
   60  */
   61 struct nameidata {
   62         /*
   63          * Arguments to namei/lookup.
   64          */
   65         const   char *ni_dirp;          /* pathname pointer */
   66         enum    uio_seg ni_segflg;      /* location of pathname */
   67         cap_rights_t ni_rightsneeded;   /* rights required to look up vnode */
   68         /*
   69          * Arguments to lookup.
   70          */
   71         struct  vnode *ni_startdir;     /* starting directory */
   72         struct  vnode *ni_rootdir;      /* logical root directory */
   73         struct  vnode *ni_topdir;       /* logical top directory */
   74         int     ni_dirfd;               /* starting directory for *at functions */
   75         int     ni_strictrelative;      /* relative lookup only; no '..' */
   76         /*
   77          * Results: returned from namei
   78          */
   79         struct filecaps ni_filecaps;    /* rights the *at base has */
   80         /*
   81          * Results: returned from/manipulated by lookup
   82          */
   83         struct  vnode *ni_vp;           /* vnode of result */
   84         struct  vnode *ni_dvp;          /* vnode of intermediate directory */
   85         /*
   86          * Shared between namei and lookup/commit routines.
   87          */
   88         size_t  ni_pathlen;             /* remaining chars in path */
   89         char    *ni_next;               /* next location in pathname */
   90         u_int   ni_loopcnt;             /* count of symlinks encountered */
   91         /*
   92          * Lookup parameters: this structure describes the subset of
   93          * information from the nameidata structure that is passed
   94          * through the VOP interface.
   95          */
   96         struct componentname ni_cnd;
   97 };
   98 
   99 #ifdef _KERNEL
  100 /*
  101  * namei operations
  102  */
  103 #define LOOKUP          0       /* perform name lookup only */
  104 #define CREATE          1       /* setup for file creation */
  105 #define DELETE          2       /* setup for file deletion */
  106 #define RENAME          3       /* setup for file renaming */
  107 #define OPMASK          3       /* mask for operation */
  108 /*
  109  * namei operational modifier flags, stored in ni_cnd.flags
  110  */
  111 #define LOCKLEAF        0x0004  /* lock vnode on return */
  112 #define LOCKPARENT      0x0008  /* want parent vnode returned locked */
  113 #define WANTPARENT      0x0010  /* want parent vnode returned unlocked */
  114 #define NOCACHE         0x0020  /* name must not be left in cache */
  115 #define FOLLOW          0x0040  /* follow symbolic links */
  116 #define LOCKSHARED      0x0100  /* Shared lock leaf */
  117 #define NOFOLLOW        0x0000  /* do not follow symbolic links (pseudo) */
  118 #define MODMASK         0x01fc  /* mask of operational modifiers */
  119 /*
  120  * Namei parameter descriptors.
  121  *
  122  * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
  123  * If the caller of namei sets the flag (for example execve wants to
  124  * know the name of the program that is being executed), then it must
  125  * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
  126  * be freed by either the commit routine or the VOP_ABORT routine.
  127  * SAVESTART is set only by the callers of namei. It implies SAVENAME
  128  * plus the addition of saving the parent directory that contains the
  129  * name in ni_startdir. It allows repeated calls to lookup for the
  130  * name being sought. The caller is responsible for releasing the
  131  * buffer and for vrele'ing ni_startdir.
  132  */
  133 #define RDONLY          0x00000200 /* lookup with read-only semantics */
  134 #define HASBUF          0x00000400 /* has allocated pathname buffer */
  135 #define SAVENAME        0x00000800 /* save pathname buffer */
  136 #define SAVESTART       0x00001000 /* save starting directory */
  137 #define ISDOTDOT        0x00002000 /* current component name is .. */
  138 #define MAKEENTRY       0x00004000 /* entry is to be added to name cache */
  139 #define ISLASTCN        0x00008000 /* this is last component of pathname */
  140 #define ISSYMLINK       0x00010000 /* symlink needs interpretation */
  141 #define ISWHITEOUT      0x00020000 /* found whiteout */
  142 #define DOWHITEOUT      0x00040000 /* do whiteouts */
  143 #define WILLBEDIR       0x00080000 /* new files will be dirs; allow trailing / */
  144 #define ISUNICODE       0x00100000 /* current component name is unicode*/
  145 #define ISOPEN          0x00200000 /* caller is opening; return a real vnode. */
  146 #define NOCROSSMOUNT    0x00400000 /* do not cross mount points */
  147 #define NOMACCHECK      0x00800000 /* do not perform MAC checks */
  148 #define AUDITVNODE1     0x04000000 /* audit the looked up vnode information */
  149 #define AUDITVNODE2     0x08000000 /* audit the looked up vnode information */
  150 #define TRAILINGSLASH   0x10000000 /* path ended in a slash */
  151 #define NOCAPCHECK      0x20000000 /* do not perform capability checks */
  152 #define PARAMASK        0x3ffffe00 /* mask of parameter descriptors */
  153 
  154 /*
  155  * Initialization of a nameidata structure.
  156  */
  157 #define NDINIT(ndp, op, flags, segflg, namep, td)                       \
  158         NDINIT_ALL(ndp, op, flags, segflg, namep, AT_FDCWD, NULL, 0, td)
  159 #define NDINIT_AT(ndp, op, flags, segflg, namep, dirfd, td)             \
  160         NDINIT_ALL(ndp, op, flags, segflg, namep, dirfd, NULL, 0, td)
  161 #define NDINIT_ATRIGHTS(ndp, op, flags, segflg, namep, dirfd, rightsp, td) \
  162         NDINIT_ALL(ndp, op, flags, segflg, namep, dirfd, NULL, rightsp, td)
  163 #define NDINIT_ATVP(ndp, op, flags, segflg, namep, vp, td)              \
  164         NDINIT_ALL(ndp, op, flags, segflg, namep, AT_FDCWD, vp, 0, td)
  165 
  166 void NDINIT_ALL(struct nameidata *ndp, u_long op, u_long flags,
  167     enum uio_seg segflg, const char *namep, int dirfd, struct vnode *startdir,
  168     cap_rights_t *rightsp, struct thread *td);
  169 
  170 #define NDF_NO_DVP_RELE         0x00000001
  171 #define NDF_NO_DVP_UNLOCK       0x00000002
  172 #define NDF_NO_DVP_PUT          0x00000003
  173 #define NDF_NO_VP_RELE          0x00000004
  174 #define NDF_NO_VP_UNLOCK        0x00000008
  175 #define NDF_NO_VP_PUT           0x0000000c
  176 #define NDF_NO_STARTDIR_RELE    0x00000010
  177 #define NDF_NO_FREE_PNBUF       0x00000020
  178 #define NDF_ONLY_PNBUF          (~NDF_NO_FREE_PNBUF)
  179 
  180 void NDFREE(struct nameidata *, const u_int);
  181 
  182 int     namei(struct nameidata *ndp);
  183 int     lookup(struct nameidata *ndp);
  184 int     relookup(struct vnode *dvp, struct vnode **vpp,
  185             struct componentname *cnp);
  186 #endif
  187 
  188 /*
  189  * Stats on usefulness of namei caches.
  190  */
  191 struct nchstats {
  192         long    ncs_goodhits;           /* hits that we can really use */
  193         long    ncs_neghits;            /* negative hits that we can use */
  194         long    ncs_badhits;            /* hits we must drop */
  195         long    ncs_falsehits;          /* hits with id mismatch */
  196         long    ncs_miss;               /* misses */
  197         long    ncs_long;               /* long names that ignore cache */
  198         long    ncs_pass2;              /* names found with passes == 2 */
  199         long    ncs_2passes;            /* number of times we attempt it */
  200 };
  201 
  202 extern struct nchstats nchstats;
  203 
  204 #endif /* !_SYS_NAMEI_H_ */

Cache object: be08079d86d320411bfacbf785fc89e2


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