xref: /dragonfly/sys/sys/namei.h (revision d4ef6694)
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)namei.h	8.5 (Berkeley) 1/9/95
34  * $FreeBSD: src/sys/sys/namei.h,v 1.29.2.2 2001/09/30 21:12:54 luigi Exp $
35  * $DragonFly: src/sys/sys/namei.h,v 1.15 2004/11/12 00:09:27 dillon Exp $
36  */
37 
38 #ifndef _SYS_NAMEI_H_
39 #define	_SYS_NAMEI_H_
40 
41 #include <sys/queue.h>
42 #include <sys/uio.h>
43 
44 #ifdef _KERNEL
45 #ifndef _SYS_THREAD_H_
46 #include <sys/thread.h>
47 #endif
48 #ifndef _SYS_PROC_H_
49 #include <sys/proc.h>
50 #endif
51 #endif
52 
53 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
54 #ifndef _SYS_NCHSTATS_H_
55 #include <sys/nchstats.h>
56 #endif
57 #endif
58 
59 struct componentname {
60 	/*
61 	 * Arguments to lookup.
62 	 */
63 	u_long	cn_nameiop;	/* namei operation */
64 	u_long	cn_flags;	/* flags to namei */
65 	struct	thread *cn_td;	/* process requesting lookup */
66 	struct	ucred *cn_cred;	/* credentials */
67 	/*
68 	 * Shared between lookup and commit routines.
69 	 */
70 	char	*cn_nameptr;	/* pointer to looked up name */
71 	long	cn_namelen;	/* length of looked up component */
72 	long	cn_consume;	/* chars to consume in lookup() */
73 	int	cn_timeout;	/* if CNP_CACHETIMEOUT is set, in ticks */
74 	struct vnode *cn_notvp;	/* used by NFS to check for collision */
75 };
76 
77 #ifdef _KERNEL
78 /*
79  * namei operations
80  */
81 #define	NAMEI_LOOKUP	0	/* perform name lookup only */
82 #define	NAMEI_CREATE	1	/* setup for file creation */
83 #define	NAMEI_DELETE	2	/* setup for file deletion */
84 #define	NAMEI_RENAME	3	/* setup for file renaming */
85 #define	NAMEI_OPMASK	3	/* mask for operation */
86 /*
87  * namei operational modifier flags, stored in ni_cnd.flags
88  */
89 	/* (LOCKLEAF)	    0x00000004	*/
90 #define	CNP_LOCKPARENT	    0x00000008	/* return parent vnode locked */
91 #define	CNP_WANTPARENT	    0x00000010	/* return parent vnode unlocked */
92 	/* (NOCACHE)	    0x00000020	*/
93 #define	CNP_FOLLOW	    0x00000040	/* follow symbolic links */
94 	/* (NOOBJ)	    0x00000080	*/
95 #define	CNP_MODMASK	    0x00c000fc	/* mask of operational modifiers */
96 /*
97  * Namei parameter descriptors.
98  */
99 	/* (NOCROSSMOUNT)   0x00000100 */
100 #define	CNP_RDONLY	    0x00000200 /* lookup with read-only semantics */
101 #define CNP_NOTVP	    0x00000400 /* test cn_notvp, fail if matches */
102 	/* (SAVENAME)	    0x00000800 */
103 	/* (CNP_SAVESTART)  0x00001000 */
104 #define CNP_ISDOTDOT	    0x00002000 /* current component name is .. */
105 	/* (MAKEENTRY)	    0x00004000 */
106 	/* (ISLASTCN)	    0x00008000 */
107 	/* (ISSYMLINK)	    0x00010000 */
108 #define	CNP_ISWHITEOUT	    0x00020000 /* found whiteout */
109 #define	CNP_DOWHITEOUT	    0x00040000 /* do whiteouts */
110 	/* (WILLBEDIR)	    0x00080000 */
111 	/* (ISUNICODE)	    0x00100000 */
112 #define	CNP_PDIRUNLOCK	    0x00200000 /* fs lookup() unlocked parent dir */
113 	/* (WANTDNCP)	    0x00400000 */
114 	/* (WANTNCP)	    0x00800000 */
115 	/* (CACHETIMEOUT)   0x01000000 */
116 #define CNP_PARAMASK	    0x011fff00 /* mask of parameter descriptors */
117 
118 extern int varsym_enable;
119 
120 int	relookup (struct vnode *dvp, struct vnode **vpp,
121 	    struct componentname *cnp);
122 #endif
123 
124 #endif /* !_SYS_NAMEI_H_ */
125