proc->thread stage 4: rework the VFS and DEVICE subsystems to take thread
[dragonfly.git] / sys / sys / namei.h
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.3 2003/06/25 03:56:10 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 struct componentname {
45         /*
46          * Arguments to lookup.
47          */
48         u_long  cn_nameiop;     /* namei operation */
49         u_long  cn_flags;       /* flags to namei */
50         struct  thread *cn_td;  /* process requesting lookup */
51         struct  ucred *cn_cred; /* credentials */
52         /*
53          * Shared between lookup and commit routines.
54          */
55         char    *cn_pnbuf;      /* pathname buffer */
56         char    *cn_nameptr;    /* pointer to looked up name */
57         long    cn_namelen;     /* length of looked up component */
58         long    cn_consume;     /* chars to consume in lookup() */
59 };
60
61 /*
62  * Encapsulation of namei parameters.
63  */
64 struct nameidata {
65         /*
66          * Arguments to namei/lookup.
67          */
68         const   char *ni_dirp;          /* pathname pointer */
69         enum    uio_seg ni_segflg;      /* location of pathname */
70      /* u_long  ni_nameiop;                namei operation */
71      /* u_long  ni_flags;                  flags to namei */
72      /* struct  proc *ni_proc;             process requesting lookup */
73         /*
74          * Arguments to lookup.
75          */
76      /* struct  ucred *ni_cred;            credentials */
77         struct  vnode *ni_startdir;     /* starting directory */
78         struct  vnode *ni_rootdir;      /* logical root directory */
79         struct  vnode *ni_topdir;       /* logical top directory */
80         /*
81          * Results: returned from/manipulated by lookup
82          */
83         struct  vnode *ni_vp;           /* vnode of result */
84         struct  vnode *ni_dvp;          /* vnode of intermediate directory */
85         /*
86          * Shared between namei and lookup/commit routines.
87          */
88         size_t  ni_pathlen;             /* remaining chars in path */
89         char    *ni_next;               /* next location in pathname */
90         u_long  ni_loopcnt;             /* count of symlinks encountered */
91         /*
92          * Lookup parameters: this structure describes the subset of
93          * information from the nameidata structure that is passed
94          * through the VOP interface.
95          */
96         struct componentname ni_cnd;
97 };
98
99 #ifdef _KERNEL
100 /*
101  * namei operations
102  */
103 #define LOOKUP          0       /* perform name lookup only */
104 #define CREATE          1       /* setup for file creation */
105 #define DELETE          2       /* setup for file deletion */
106 #define RENAME          3       /* setup for file renaming */
107 #define OPMASK          3       /* mask for operation */
108 /*
109  * namei operational modifier flags, stored in ni_cnd.flags
110  */
111 #define LOCKLEAF        0x0004  /* lock inode on return */
112 #define LOCKPARENT      0x0008  /* want parent vnode returned locked */
113 #define WANTPARENT      0x0010  /* want parent vnode returned unlocked */
114 #define NOCACHE         0x0020  /* name must not be left in cache */
115 #define FOLLOW          0x0040  /* follow symbolic links */
116 #define NOOBJ           0x0080  /* don't create object */
117 #define NOFOLLOW        0x0000  /* do not follow symbolic links (pseudo) */
118 #define MODMASK         0x00fc  /* mask of operational modifiers */
119 /*
120  * Namei parameter descriptors.
121  *
122  * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
123  * If the caller of namei sets the flag (for example execve wants to
124  * know the name of the program that is being executed), then it must
125  * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
126  * be freed by either the commit routine or the VOP_ABORT routine.
127  * SAVESTART is set only by the callers of namei. It implies SAVENAME
128  * plus the addition of saving the parent directory that contains the
129  * name in ni_startdir. It allows repeated calls to lookup for the
130  * name being sought. The caller is responsible for releasing the
131  * buffer and for vrele'ing ni_startdir.
132  */
133 #define NOCROSSMOUNT    0x000100 /* do not cross mount points */
134 #define RDONLY          0x000200 /* lookup with read-only semantics */
135 #define HASBUF          0x000400 /* has allocated pathname buffer */
136 #define SAVENAME        0x000800 /* save pathname buffer */
137 #define SAVESTART       0x001000 /* save starting directory */
138 #define ISDOTDOT        0x002000 /* current component name is .. */
139 #define MAKEENTRY       0x004000 /* entry is to be added to name cache */
140 #define ISLASTCN        0x008000 /* this is last component of pathname */
141 #define ISSYMLINK       0x010000 /* symlink needs interpretation */
142 #define ISWHITEOUT      0x020000 /* found whiteout */
143 #define DOWHITEOUT      0x040000 /* do whiteouts */
144 #define WILLBEDIR       0x080000 /* new files will be dirs; allow trailing / */
145 #define ISUNICODE       0x100000 /* current component name is unicode*/
146 #define PDIRUNLOCK      0x200000 /* file system lookup() unlocked parent dir */
147 #define PARAMASK        0x1fff00 /* mask of parameter descriptors */
148 /*
149  * Initialization of an nameidata structure.
150  */
151 static void NDINIT __P((struct nameidata *, u_long, u_long, enum uio_seg,
152             const char *, struct thread *));
153 static __inline void
154 NDINIT(struct nameidata *ndp,
155         u_long op, u_long flags,
156         enum uio_seg segflg,
157         const char *namep,
158         struct thread *td
159 ) {
160         struct proc *p = td->td_proc;
161
162         KKASSERT(p != NULL);
163         ndp->ni_cnd.cn_nameiop = op;
164         ndp->ni_cnd.cn_flags = flags;
165         ndp->ni_segflg = segflg;
166         ndp->ni_dirp = namep;
167         ndp->ni_cnd.cn_td = td;
168         ndp->ni_cnd.cn_cred = p->p_ucred;
169 }
170
171 #define NDF_NO_DVP_RELE         0x00000001
172 #define NDF_NO_DVP_UNLOCK       0x00000002
173 #define NDF_NO_DVP_PUT          0x00000003
174 #define NDF_NO_VP_RELE          0x00000004
175 #define NDF_NO_VP_UNLOCK        0x00000008
176 #define NDF_NO_VP_PUT           0x0000000c
177 #define NDF_NO_STARTDIR_RELE    0x00000010
178 #define NDF_NO_FREE_PNBUF       0x00000020
179 #define NDF_ONLY_PNBUF          (~NDF_NO_FREE_PNBUF)
180
181 void NDFREE __P((struct nameidata *, const uint));
182
183 int     namei __P((struct nameidata *ndp));
184 int     lookup __P((struct nameidata *ndp));
185 int     relookup __P((struct vnode *dvp, struct vnode **vpp,
186             struct componentname *cnp));
187 #endif
188
189 /*
190  * Stats on usefulness of namei caches.
191  */
192 struct  nchstats {
193         long    ncs_goodhits;           /* hits that we can really use */
194         long    ncs_neghits;            /* negative hits that we can use */
195         long    ncs_badhits;            /* hits we must drop */
196         long    ncs_falsehits;          /* hits with id mismatch */
197         long    ncs_miss;               /* misses */
198         long    ncs_long;               /* long names that ignore cache */
199         long    ncs_pass2;              /* names found with passes == 2 */
200         long    ncs_2passes;            /* number of times we attempt it */
201 };
202
203 extern struct nchstats nchstats;
204
205 #endif /* !_SYS_NAMEI_H_ */