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  * SPDX-License-Identifier: BSD-3-Clause
    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) 1/9/95
   32  * $FreeBSD: head/sys/sys/namei.h 343891 2019-02-08 04:18:17Z kib $
   33  */
   34 
   35 #ifndef _SYS_NAMEI_H_
   36 #define _SYS_NAMEI_H_
   37 
   38 #include <sys/caprights.h>
   39 #include <sys/filedesc.h>
   40 #include <sys/queue.h>
   41 #include <sys/_uio.h>
   42 
   43 struct componentname {
   44         /*
   45          * Arguments to lookup.
   46          */
   47         u_long  cn_nameiop;     /* namei operation */
   48         u_int64_t cn_flags;     /* flags to namei */
   49         struct  thread *cn_thread;/* thread requesting lookup */
   50         struct  ucred *cn_cred; /* credentials */
   51         int     cn_lkflags;     /* Lock flags LK_EXCLUSIVE or LK_SHARED */
   52         /*
   53          * Shared between lookup and commit routines.
   54          */
   55         char    *cn_pnbuf;      /* pathname buffer */
   56         char    *cn_nameptr;    /* pointer to looked up name */
   57         long    cn_namelen;     /* length of looked up component */
   58 };
   59 
   60 struct nameicap_tracker;
   61 TAILQ_HEAD(nameicap_tracker_head, nameicap_tracker);
   62 
   63 /*
   64  * Encapsulation of namei parameters.
   65  */
   66 struct nameidata {
   67         /*
   68          * Arguments to namei/lookup.
   69          */
   70         const   char *ni_dirp;          /* pathname pointer */
   71         enum    uio_seg ni_segflg;      /* location of pathname */
   72         cap_rights_t ni_rightsneeded;   /* rights required to look up vnode */
   73         /*
   74          * Arguments to lookup.
   75          */
   76         struct  vnode *ni_startdir;     /* starting directory */
   77         struct  vnode *ni_rootdir;      /* logical root directory */
   78         struct  vnode *ni_topdir;       /* logical top directory */
   79         int     ni_dirfd;               /* starting directory for *at functions */
   80         int     ni_lcf;                 /* local call flags */
   81         /*
   82          * Results: returned from namei
   83          */
   84         struct filecaps ni_filecaps;    /* rights the *at base has */
   85         /*
   86          * Results: returned from/manipulated by lookup
   87          */
   88         struct  vnode *ni_vp;           /* vnode of result */
   89         struct  vnode *ni_dvp;          /* vnode of intermediate directory */
   90         /*
   91          * Results: flags returned from namei
   92          */
   93         u_int   ni_resflags;
   94         /*
   95          * Shared between namei and lookup/commit routines.
   96          */
   97         size_t  ni_pathlen;             /* remaining chars in path */
   98         char    *ni_next;               /* next location in pathname */
   99         u_int   ni_loopcnt;             /* count of symlinks encountered */
  100         /*
  101          * Lookup parameters: this structure describes the subset of
  102          * information from the nameidata structure that is passed
  103          * through the VOP interface.
  104          */
  105         struct componentname ni_cnd;
  106         struct nameicap_tracker_head ni_cap_tracker;
  107         struct vnode *ni_beneath_latch;
  108 };
  109 
  110 #ifdef _KERNEL
  111 /*
  112  * namei operations
  113  */
  114 #define LOOKUP          0       /* perform name lookup only */
  115 #define CREATE          1       /* setup for file creation */
  116 #define DELETE          2       /* setup for file deletion */
  117 #define RENAME          3       /* setup for file renaming */
  118 #define OPMASK          3       /* mask for operation */
  119 /*
  120  * namei operational modifier flags, stored in ni_cnd.flags
  121  */
  122 #define LOCKLEAF        0x0004  /* lock vnode on return */
  123 #define LOCKPARENT      0x0008  /* want parent vnode returned locked */
  124 #define WANTPARENT      0x0010  /* want parent vnode returned unlocked */
  125 #define NOCACHE         0x0020  /* name must not be left in cache */
  126 #define FOLLOW          0x0040  /* follow symbolic links */
  127 #define BENEATH         0x0080  /* No escape from the start dir */
  128 #define LOCKSHARED      0x0100  /* Shared lock leaf */
  129 #define NOFOLLOW        0x0000  /* do not follow symbolic links (pseudo) */
  130 #define MODMASK         0x01fc  /* mask of operational modifiers */
  131 /*
  132  * Namei parameter descriptors.
  133  *
  134  * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
  135  * If the caller of namei sets the flag (for example execve wants to
  136  * know the name of the program that is being executed), then it must
  137  * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
  138  * be freed by either the commit routine or the VOP_ABORT routine.
  139  * SAVESTART is set only by the callers of namei. It implies SAVENAME
  140  * plus the addition of saving the parent directory that contains the
  141  * name in ni_startdir. It allows repeated calls to lookup for the
  142  * name being sought. The caller is responsible for releasing the
  143  * buffer and for vrele'ing ni_startdir.
  144  */
  145 #define RDONLY          0x00000200 /* lookup with read-only semantics */
  146 #define HASBUF          0x00000400 /* has allocated pathname buffer */
  147 #define SAVENAME        0x00000800 /* save pathname buffer */
  148 #define SAVESTART       0x00001000 /* save starting directory */
  149 #define ISDOTDOT        0x00002000 /* current component name is .. */
  150 #define MAKEENTRY       0x00004000 /* entry is to be added to name cache */
  151 #define ISLASTCN        0x00008000 /* this is last component of pathname */
  152 #define ISSYMLINK       0x00010000 /* symlink needs interpretation */
  153 #define ISWHITEOUT      0x00020000 /* found whiteout */
  154 #define DOWHITEOUT      0x00040000 /* do whiteouts */
  155 #define WILLBEDIR       0x00080000 /* new files will be dirs; allow trailing / */
  156 #define ISUNICODE       0x00100000 /* current component name is unicode*/
  157 #define ISOPEN          0x00200000 /* caller is opening; return a real vnode. */
  158 #define NOCROSSMOUNT    0x00400000 /* do not cross mount points */
  159 #define NOMACCHECK      0x00800000 /* do not perform MAC checks */
  160 #define AUDITVNODE1     0x04000000 /* audit the looked up vnode information */
  161 #define AUDITVNODE2     0x08000000 /* audit the looked up vnode information */
  162 #define TRAILINGSLASH   0x10000000 /* path ended in a slash */
  163 #define NOCAPCHECK      0x20000000 /* do not perform capability checks */
  164 #define PARAMASK        0x3ffffe00 /* mask of parameter descriptors */
  165 
  166 /*
  167  * Namei results flags
  168  */
  169 #define NIRES_ABS       0x00000001 /* Path was absolute */
  170 
  171 /*
  172  * Flags in ni_lcf, valid for the duration of the namei call.
  173  */
  174 #define NI_LCF_STRICTRELATIVE   0x0001  /* relative lookup only */
  175 #define NI_LCF_CAP_DOTDOT       0x0002  /* ".." in strictrelative case */
  176 #define NI_LCF_BENEATH_ABS      0x0004  /* BENEATH with absolute path */
  177 #define NI_LCF_BENEATH_LATCHED  0x0008  /* BENEATH_ABS traversed starting dir */
  178 #define NI_LCF_LATCH            0x0010  /* ni_beneath_latch valid */
  179 
  180 /*
  181  * Initialization of a nameidata structure.
  182  */
  183 #define NDINIT(ndp, op, flags, segflg, namep, td)                       \
  184         NDINIT_ALL(ndp, op, flags, segflg, namep, AT_FDCWD, NULL, 0, td)
  185 #define NDINIT_AT(ndp, op, flags, segflg, namep, dirfd, td)             \
  186         NDINIT_ALL(ndp, op, flags, segflg, namep, dirfd, NULL, 0, td)
  187 #define NDINIT_ATRIGHTS(ndp, op, flags, segflg, namep, dirfd, rightsp, td) \
  188         NDINIT_ALL(ndp, op, flags, segflg, namep, dirfd, NULL, rightsp, td)
  189 #define NDINIT_ATVP(ndp, op, flags, segflg, namep, vp, td)              \
  190         NDINIT_ALL(ndp, op, flags, segflg, namep, AT_FDCWD, vp, 0, td)
  191 
  192 void NDINIT_ALL(struct nameidata *ndp, u_long op, u_long flags,
  193     enum uio_seg segflg, const char *namep, int dirfd, struct vnode *startdir,
  194     cap_rights_t *rightsp, struct thread *td);
  195 
  196 #define NDF_NO_DVP_RELE         0x00000001
  197 #define NDF_NO_DVP_UNLOCK       0x00000002
  198 #define NDF_NO_DVP_PUT          0x00000003
  199 #define NDF_NO_VP_RELE          0x00000004
  200 #define NDF_NO_VP_UNLOCK        0x00000008
  201 #define NDF_NO_VP_PUT           0x0000000c
  202 #define NDF_NO_STARTDIR_RELE    0x00000010
  203 #define NDF_NO_FREE_PNBUF       0x00000020
  204 #define NDF_ONLY_PNBUF          (~NDF_NO_FREE_PNBUF)
  205 
  206 void NDFREE(struct nameidata *, const u_int);
  207 
  208 int     namei(struct nameidata *ndp);
  209 int     lookup(struct nameidata *ndp);
  210 int     relookup(struct vnode *dvp, struct vnode **vpp,
  211             struct componentname *cnp);
  212 #endif
  213 
  214 /*
  215  * Stats on usefulness of namei caches.
  216  */
  217 struct nchstats {
  218         long    ncs_goodhits;           /* hits that we can really use */
  219         long    ncs_neghits;            /* negative hits that we can use */
  220         long    ncs_badhits;            /* hits we must drop */
  221         long    ncs_falsehits;          /* hits with id mismatch */
  222         long    ncs_miss;               /* misses */
  223         long    ncs_long;               /* long names that ignore cache */
  224         long    ncs_pass2;              /* names found with passes == 2 */
  225         long    ncs_2passes;            /* number of times we attempt it */
  226 };
  227 
  228 extern struct nchstats nchstats;
  229 
  230 #endif /* !_SYS_NAMEI_H_ */

Cache object: 28d1b7a0b2e2aced337265e3369625e7


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