664a31e496
is an application space macro and the applications are supposed to be free to use it as they please (but cannot). This is consistant with the other BSD's who made this change quite some time ago. More commits to come.
234 lines
8.5 KiB
C
234 lines
8.5 KiB
C
/*
|
|
* Copyright (c) 1985, 1989, 1991, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by the University of
|
|
* California, Berkeley and its contributors.
|
|
* 4. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* @(#)namei.h 8.5 (Berkeley) 1/9/95
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _SYS_NAMEI_H_
|
|
#define _SYS_NAMEI_H_
|
|
|
|
#include <sys/queue.h>
|
|
#include <sys/uio.h>
|
|
|
|
/*
|
|
* Encapsulation of namei parameters.
|
|
*/
|
|
struct nameidata {
|
|
/*
|
|
* Arguments to namei/lookup.
|
|
*/
|
|
const char *ni_dirp; /* pathname pointer */
|
|
enum uio_seg ni_segflg; /* location of pathname */
|
|
/* u_long ni_nameiop; namei operation */
|
|
/* u_long ni_flags; flags to namei */
|
|
/* struct proc *ni_proc; process requesting lookup */
|
|
/*
|
|
* Arguments to lookup.
|
|
*/
|
|
/* struct ucred *ni_cred; credentials */
|
|
struct vnode *ni_startdir; /* starting directory */
|
|
struct vnode *ni_rootdir; /* logical root directory */
|
|
struct vnode *ni_topdir; /* logical top directory */
|
|
/*
|
|
* Results: returned from/manipulated by lookup
|
|
*/
|
|
struct vnode *ni_vp; /* vnode of result */
|
|
struct vnode *ni_dvp; /* vnode of intermediate directory */
|
|
/*
|
|
* Shared between namei and lookup/commit routines.
|
|
*/
|
|
size_t ni_pathlen; /* remaining chars in path */
|
|
char *ni_next; /* next location in pathname */
|
|
u_long ni_loopcnt; /* count of symlinks encountered */
|
|
/*
|
|
* Lookup parameters: this structure describes the subset of
|
|
* information from the nameidata structure that is passed
|
|
* through the VOP interface.
|
|
*/
|
|
struct componentname {
|
|
/*
|
|
* Arguments to lookup.
|
|
*/
|
|
u_long cn_nameiop; /* namei operation */
|
|
u_long cn_flags; /* flags to namei */
|
|
struct proc *cn_proc; /* process requesting lookup */
|
|
struct ucred *cn_cred; /* credentials */
|
|
/*
|
|
* Shared between lookup and commit routines.
|
|
*/
|
|
char *cn_pnbuf; /* pathname buffer */
|
|
char *cn_nameptr; /* pointer to looked up name */
|
|
long cn_namelen; /* length of looked up component */
|
|
long cn_consume; /* chars to consume in lookup() */
|
|
} ni_cnd;
|
|
};
|
|
|
|
#ifdef _KERNEL
|
|
/*
|
|
* namei operations
|
|
*/
|
|
#define LOOKUP 0 /* perform name lookup only */
|
|
#define CREATE 1 /* setup for file creation */
|
|
#define DELETE 2 /* setup for file deletion */
|
|
#define RENAME 3 /* setup for file renaming */
|
|
#define OPMASK 3 /* mask for operation */
|
|
/*
|
|
* namei operational modifier flags, stored in ni_cnd.flags
|
|
*/
|
|
#define LOCKLEAF 0x0004 /* lock inode on return */
|
|
#define LOCKPARENT 0x0008 /* want parent vnode returned locked */
|
|
#define WANTPARENT 0x0010 /* want parent vnode returned unlocked */
|
|
#define NOCACHE 0x0020 /* name must not be left in cache */
|
|
#define FOLLOW 0x0040 /* follow symbolic links */
|
|
#define NOOBJ 0x0080 /* don't create object */
|
|
#define NOFOLLOW 0x0000 /* do not follow symbolic links (pseudo) */
|
|
#define MODMASK 0x00fc /* mask of operational modifiers */
|
|
/*
|
|
* Namei parameter descriptors.
|
|
*
|
|
* SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
|
|
* If the caller of namei sets the flag (for example execve wants to
|
|
* know the name of the program that is being executed), then it must
|
|
* free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
|
|
* be freed by either the commit routine or the VOP_ABORT routine.
|
|
* SAVESTART is set only by the callers of namei. It implies SAVENAME
|
|
* plus the addition of saving the parent directory that contains the
|
|
* name in ni_startdir. It allows repeated calls to lookup for the
|
|
* name being sought. The caller is responsible for releasing the
|
|
* buffer and for vrele'ing ni_startdir.
|
|
*/
|
|
#define NOCROSSMOUNT 0x000100 /* do not cross mount points */
|
|
#define RDONLY 0x000200 /* lookup with read-only semantics */
|
|
#define HASBUF 0x000400 /* has allocated pathname buffer */
|
|
#define SAVENAME 0x000800 /* save pathname buffer */
|
|
#define SAVESTART 0x001000 /* save starting directory */
|
|
#define ISDOTDOT 0x002000 /* current component name is .. */
|
|
#define MAKEENTRY 0x004000 /* entry is to be added to name cache */
|
|
#define ISLASTCN 0x008000 /* this is last component of pathname */
|
|
#define ISSYMLINK 0x010000 /* symlink needs interpretation */
|
|
#define ISWHITEOUT 0x020000 /* found whiteout */
|
|
#define DOWHITEOUT 0x040000 /* do whiteouts */
|
|
#define WILLBEDIR 0x080000 /* new files will be dirs; allow trailing / */
|
|
#define ISUNICODE 0x100000 /* current component name is unicode*/
|
|
#define PARAMASK 0x1fff00 /* mask of parameter descriptors */
|
|
/*
|
|
* Initialization of an nameidata structure.
|
|
*/
|
|
static void NDINIT __P((struct nameidata *, u_long, u_long, enum uio_seg,
|
|
const char *, struct proc *));
|
|
static __inline void
|
|
NDINIT(ndp, op, flags, segflg, namep, p)
|
|
struct nameidata *ndp;
|
|
u_long op, flags;
|
|
enum uio_seg segflg;
|
|
const char *namep;
|
|
struct proc *p;
|
|
{
|
|
ndp->ni_cnd.cn_nameiop = op;
|
|
ndp->ni_cnd.cn_flags = flags;
|
|
ndp->ni_segflg = segflg;
|
|
ndp->ni_dirp = namep;
|
|
ndp->ni_cnd.cn_proc = p;
|
|
}
|
|
|
|
#define NDF_NO_DVP_RELE 0x00000001
|
|
#define NDF_NO_DVP_UNLOCK 0x00000002
|
|
#define NDF_NO_DVP_PUT 0x00000003
|
|
#define NDF_NO_VP_RELE 0x00000004
|
|
#define NDF_NO_VP_UNLOCK 0x00000008
|
|
#define NDF_NO_VP_PUT 0x0000000c
|
|
#define NDF_NO_STARTDIR_RELE 0x00000010
|
|
#define NDF_NO_FREE_PNBUF 0x00000020
|
|
#define NDF_ONLY_PNBUF (~NDF_NO_FREE_PNBUF)
|
|
|
|
#define NDFREE(ndp, flags) do { \
|
|
struct nameidata *_ndp = (ndp); \
|
|
unsigned int _flags = (flags); \
|
|
\
|
|
if (!(_flags & NDF_NO_FREE_PNBUF) && \
|
|
(_ndp->ni_cnd.cn_flags & HASBUF)) { \
|
|
zfree(namei_zone, _ndp->ni_cnd.cn_pnbuf); \
|
|
_ndp->ni_cnd.cn_flags &= ~HASBUF; \
|
|
} \
|
|
if (!(_flags & NDF_NO_DVP_UNLOCK) && \
|
|
(_ndp->ni_cnd.cn_flags & LOCKPARENT) && \
|
|
_ndp->ni_dvp != _ndp->ni_vp) \
|
|
VOP_UNLOCK(_ndp->ni_dvp, 0, _ndp->ni_cnd.cn_proc); \
|
|
if (!(_flags & NDF_NO_DVP_RELE) && \
|
|
(_ndp->ni_cnd.cn_flags & (LOCKPARENT|WANTPARENT))) { \
|
|
vrele(_ndp->ni_dvp); \
|
|
_ndp->ni_dvp = NULL; \
|
|
} \
|
|
if (!(_flags & NDF_NO_VP_UNLOCK) && \
|
|
(_ndp->ni_cnd.cn_flags & LOCKLEAF) && _ndp->ni_vp) \
|
|
VOP_UNLOCK(_ndp->ni_vp, 0, _ndp->ni_cnd.cn_proc); \
|
|
if (!(_flags & NDF_NO_VP_RELE) && \
|
|
_ndp->ni_vp) { \
|
|
vrele(_ndp->ni_vp); \
|
|
_ndp->ni_vp = NULL; \
|
|
} \
|
|
if (!(_flags & NDF_NO_STARTDIR_RELE) && \
|
|
(_ndp->ni_cnd.cn_flags & SAVESTART)) { \
|
|
vrele(_ndp->ni_startdir); \
|
|
_ndp->ni_startdir = NULL; \
|
|
} \
|
|
} while (0)
|
|
|
|
#endif
|
|
|
|
#ifdef _KERNEL
|
|
|
|
int namei __P((struct nameidata *ndp));
|
|
int lookup __P((struct nameidata *ndp));
|
|
int relookup __P((struct vnode *dvp, struct vnode **vpp,
|
|
struct componentname *cnp));
|
|
#endif
|
|
|
|
/*
|
|
* Stats on usefulness of namei caches.
|
|
*/
|
|
struct nchstats {
|
|
long ncs_goodhits; /* hits that we can really use */
|
|
long ncs_neghits; /* negative hits that we can use */
|
|
long ncs_badhits; /* hits we must drop */
|
|
long ncs_falsehits; /* hits with id mismatch */
|
|
long ncs_miss; /* misses */
|
|
long ncs_long; /* long names that ignore cache */
|
|
long ncs_pass2; /* names found with passes == 2 */
|
|
long ncs_2passes; /* number of times we attempt it */
|
|
};
|
|
|
|
extern struct nchstats nchstats;
|
|
|
|
#endif /* !_SYS_NAMEI_H_ */
|