2 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $DragonFly: src/sys/sys/nlookup.h,v 1.4 2005/03/09 06:11:22 hmp Exp $
37 #ifndef _SYS_NLOOKUP_H_
38 #define _SYS_NLOOKUP_H_
60 * Encapsulation of nlookup parameters.
62 * Note on nl_flags and nl_op: nl_flags supports a simplified subset of
63 * namei's original CNP flags. nl_op (e.g. NAMEI_*) does no in any way
64 * effect the state of the returned namecache and is only used to enforce
69 * These fields are setup by nlookup_init() with nl_ncp set to
70 * the current directory if a process or the root directory if
71 * a pure thread. The result from nlookup() will be returned in
74 struct namecache *nl_ncp; /* start-point and result */
75 struct namecache *nl_rootncp; /* root directory */
76 struct namecache *nl_jailncp; /* jail directory */
78 char *nl_path; /* path buffer */
79 struct thread *nl_td; /* thread requesting the nlookup */
80 struct ucred *nl_cred; /* credentials for nlookup */
82 int nl_flags; /* operations flags */
83 int nl_loopcnt; /* symlinks encountered */
86 * These fields are populated by vn_open(). nlookup_done() will
87 * vn_close() a non-NULL vp so if you extract it be sure to NULL out
90 struct vnode *nl_open_vp;
94 #define NLC_FOLLOW 0x00000001 /* follow leaf symlink */
95 #define NLC_NOCROSSMOUNT 0x00000002 /* do not cross mount points */
96 #define NLC_HASBUF 0x00000004 /* nl_path is allocated */
97 #define NLC_ISWHITEOUT 0x00000008
98 #define NLC_WILLBEDIR 0x00000010
99 #define NLC_NCPISLOCKED 0x00000020
100 #define NLC_LOCKVP 0x00000040 /* nl_open_vp from vn_open */
101 #define NLC_CREATE 0x00000080
102 #define NLC_DELETE 0x00000100
103 #define NLC_NFS_RDONLY 0x00010000 /* set by nfs_namei() only */
104 #define NLC_NFS_NOSOFTLINKTRAV 0x00020000 /* do not traverse softlnks */
108 int nlookup_init(struct nlookupdata *, const char *, enum uio_seg, int);
109 int nlookup_init_raw(struct nlookupdata *, const char *, enum uio_seg, int, struct ucred *, struct namecache *);
110 void nlookup_set_cred(struct nlookupdata *nd, struct ucred *cred);
111 void nlookup_zero(struct nlookupdata *);
112 void nlookup_done(struct nlookupdata *);
113 struct namecache *nlookup_simple(const char *str, enum uio_seg seg,
114 int niflags, int *error);
115 int nlookup_mp(struct mount *mp, struct namecache **ncpp);
116 int nlookup(struct nlookupdata *);
117 int nreadsymlink(struct nlookupdata *nd, struct namecache *ncp,
118 struct nlcomponent *nlc);
119 int naccess(struct namecache *ncp, int vmode, struct ucred *cred);
120 int naccess_va(struct vattr *va, int vmode, struct ucred *cred);
124 #endif /* !_SYS_NAMEI_H_ */