1 /* 2 * Copyright (c) 2004 The DragonFly Project. All rights reserved. 3 * 4 * This code is derived from software contributed to The DragonFly Project 5 * by Matthew Dillon <dillon@backplane.com> 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 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 16 * distribution. 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. 20 * 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 32 * SUCH DAMAGE. 33 * 34 * $DragonFly: src/sys/sys/nlookup.h,v 1.6 2008/05/09 17:52:18 dillon Exp $ 35 */ 36 37 #ifndef _SYS_NLOOKUP_H_ 38 #define _SYS_NLOOKUP_H_ 39 40 #ifndef _SYS_UIO_H_ 41 #include <sys/uio.h> 42 #endif 43 #ifndef _SYS_NAMECACHE_H_ 44 #include <sys/namecache.h> 45 #endif 46 47 struct vnode; 48 struct vattr; 49 struct mount; 50 struct thread; 51 struct ucred; 52 53 /* 54 * nlookup component 55 */ 56 struct nlcomponent { 57 char *nlc_nameptr; 58 int nlc_namelen; 59 }; 60 61 /* 62 * Encapsulation of nlookup parameters. 63 * 64 * Note on nl_flags and nl_op: nl_flags supports a simplified subset of 65 * namei's original CNP flags. nl_op (e.g. NAMEI_*) does no in any way 66 * effect the state of the returned namecache and is only used to enforce 67 * access checks. 68 */ 69 struct nlookupdata { 70 /* 71 * These fields are setup by nlookup_init() with nl_nch set to 72 * the current directory if a process or the root directory if 73 * a pure thread. The result from nlookup() will be returned in 74 * nl_nch. 75 */ 76 struct nchandle nl_nch; /* start-point and result */ 77 struct nchandle nl_rootnch; /* root directory */ 78 struct nchandle nl_jailnch; /* jail directory */ 79 80 char *nl_path; /* path buffer */ 81 struct thread *nl_td; /* thread requesting the nlookup */ 82 struct ucred *nl_cred; /* credentials for nlookup */ 83 struct vnode *nl_dvp; /* NLC_REFDVP */ 84 85 int nl_flags; /* operations flags */ 86 int nl_loopcnt; /* symlinks encountered */ 87 88 /* 89 * These fields are populated by vn_open(). nlookup_done() will 90 * vn_close() a non-NULL vp so if you extract it be sure to NULL out 91 * nl_open_vp. 92 */ 93 struct vnode *nl_open_vp; 94 int nl_vp_fmode; 95 }; 96 97 #define NLC_FOLLOW 0x00000001 /* follow leaf symlink */ 98 #define NLC_NOCROSSMOUNT 0x00000002 /* do not cross mount points */ 99 #define NLC_HASBUF 0x00000004 /* nl_path is allocated */ 100 #define NLC_ISWHITEOUT 0x00000008 101 #define NLC_WILLBEDIR 0x00000010 102 #define NLC_NCPISLOCKED 0x00000020 103 #define NLC_LOCKVP 0x00000040 /* nl_open_vp from vn_open */ 104 #define NLC_CREATE 0x00000080 105 #define NLC_DELETE 0x00000100 106 #define NLC_NFS_RDONLY 0x00010000 /* set by nfs_namei() only */ 107 #define NLC_NFS_NOSOFTLINKTRAV 0x00020000 /* do not traverse softlnks */ 108 #define NLC_REFDVP 0x00040000 /* set ref'd/unlocked nl_dvp */ 109 110 #ifdef _KERNEL 111 112 int nlookup_init(struct nlookupdata *, const char *, enum uio_seg, int); 113 int nlookup_init_raw(struct nlookupdata *, const char *, enum uio_seg, int, struct ucred *, struct nchandle *); 114 void nlookup_set_cred(struct nlookupdata *nd, struct ucred *cred); 115 void nlookup_zero(struct nlookupdata *); 116 void nlookup_done(struct nlookupdata *); 117 struct nchandle nlookup_simple(const char *str, enum uio_seg seg, 118 int niflags, int *error); 119 int nlookup_mp(struct mount *mp, struct nchandle *nch); 120 int nlookup(struct nlookupdata *); 121 int nreadsymlink(struct nlookupdata *nd, struct nchandle *nch, 122 struct nlcomponent *nlc); 123 int naccess(struct nchandle *nch, int vmode, struct ucred *cred); 124 int naccess_va(struct vattr *va, int vmode, struct ucred *cred); 125 126 #endif 127 128 #endif /* !_SYS_NAMEI_H_ */ 129