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