xref: /dragonfly/sys/sys/namei.h (revision 13dd34d80aa1e622804053e295c7590882a7df3e)
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  * 3. 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: src/sys/sys/namei.h,v 1.29.2.2 2001/09/30 21:12:54 luigi Exp $
31  */
32 
33 #ifndef _SYS_NAMEI_H_
34 #define   _SYS_NAMEI_H_
35 
36 #include <sys/queue.h>
37 
38 #ifdef _KERNEL
39 #ifndef _SYS_THREAD_H_
40 #include <sys/thread.h>
41 #endif
42 #ifndef _SYS_PROC_H_
43 #include <sys/proc.h>
44 #endif
45 #endif
46 
47 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
48 #ifndef _SYS_NCHSTATS_H_
49 #include <sys/nchstats.h>
50 #endif
51 #endif
52 
53 struct componentname {
54           /*
55            * Arguments to lookup.
56            */
57           u_long    cn_nameiop;         /* namei operation */
58           u_long    cn_flags; /* flags to namei */
59           struct    thread *cn_td;      /* process requesting lookup */
60           struct    ucred *cn_cred;     /* credentials */
61           /*
62            * Shared between lookup and commit routines.
63            */
64           char      *cn_nameptr;        /* pointer to looked up name */
65           long      cn_namelen;         /* length of looked up component */
66           long      cn_consume;         /* chars to consume in lookup() */
67           int       cn_timeout;         /* if CNP_CACHETIMEOUT is set, in ticks */
68           struct vnode *cn_notvp;       /* used by NFS to check for collision */
69 };
70 
71 #ifdef _KERNEL
72 /*
73  * namei operations
74  */
75 #define   NAMEI_LOOKUP        0         /* perform name lookup only */
76 #define   NAMEI_CREATE        1         /* setup for file creation */
77 #define   NAMEI_DELETE        2         /* setup for file deletion */
78 #define   NAMEI_RENAME        3         /* setup for file renaming */
79 #define   NAMEI_OPMASK        3         /* mask for operation */
80 /*
81  * namei operational modifier flags, stored in ni_cnd.flags
82  */
83           /* (LOCKLEAF)           0x00000004      */
84 #define   CNP_LOCKPARENT          0x00000008      /* return parent vnode locked */
85 #define   CNP_WANTPARENT          0x00000010      /* return parent vnode unlocked */
86           /* (NOCACHE)            0x00000020      */
87 #define   CNP_FOLLOW              0x00000040      /* follow symbolic links */
88           /* (NOOBJ)              0x00000080      */
89 #define   CNP_MODMASK             0x00c000fc      /* mask of operational modifiers */
90 /*
91  * Namei parameter descriptors.
92  */
93           /* (NOCROSSMOUNT)   0x00000100 */
94 #define   CNP_RDONLY              0x00000200 /* lookup with read-only semantics */
95 #define CNP_NOTVP       0x00000400 /* test cn_notvp, fail if matches */
96           /* (SAVENAME)           0x00000800 */
97           /* (CNP_SAVESTART)  0x00001000 */
98 #define CNP_ISDOTDOT              0x00002000 /* current component name is .. */
99           /* (MAKEENTRY)          0x00004000 */
100           /* (ISLASTCN)           0x00008000 */
101           /* (ISSYMLINK)          0x00010000 */
102 #define   CNP_ISWHITEOUT          0x00020000 /* found whiteout */
103 #define   CNP_DOWHITEOUT          0x00040000 /* do whiteouts */
104           /* (WILLBEDIR)          0x00080000 */
105           /* (ISUNICODE)          0x00100000 */
106 #define   CNP_PDIRUNLOCK          0x00200000 /* fs lookup() unlocked parent dir */
107           /* (WANTDNCP)           0x00400000 */
108           /* (WANTNCP)            0x00800000 */
109           /* (CACHETIMEOUT)   0x01000000 */
110 #define CNP_PARAMASK              0x011fff00 /* mask of parameter descriptors */
111 
112 extern int varsym_enable;
113 
114 int       relookup (struct vnode *dvp, struct vnode **vpp,
115               struct componentname *cnp);
116 #endif
117 
118 #endif /* !_SYS_NAMEI_H_ */
119