sys/sys/namei.h

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