sys/sys/nlookup.h

   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.2 2004/09/30 18:59:50 dillon Exp $
  35  */
  36
  37 #ifndef _SYS_NLOOKUP_H_
  38 #define _SYS_NLOOKUP_H_
  39
  40 struct vattr;
  41 struct mount;
  42 struct namecache;
  43 struct thread;
  44 struct ucred;
  45
  46 /*
  47  * nlookup component
  48  */
  49 struct nlcomponent {
  50         char            *nlc_nameptr;
  51         int             nlc_namelen;
  52 };
  53
  54 /*
  55  * Encapsulation of nlookup parameters.
  56  *
  57  * Note on nl_flags and nl_op: nl_flags supports a simplified subset of
  58  * namei's original CNP flags.  nl_op (e.g. NAMEI_*) does no in any way
  59  * effect the state of the returned namecache and is only used to enforce
  60  * access checks.
  61  */
  62 struct nlookupdata {
  63         struct namecache *nl_ncp;       /* start-point and result */
  64         struct namecache *nl_rootncp;   /* root directory */
  65         struct namecache *nl_jailncp;   /* jail directory */
  66
  67         char            *nl_path;       /* path buffer */
  68         struct thread   *nl_td;         /* thread requesting the nlookup */
  69         struct ucred    *nl_cred;       /* credentials for nlookup */
  70
  71         int             nl_flags;       /* operations flags */
  72         int             nl_loopcnt;     /* symlinks encountered */
  73 };
  74
  75 #define NLC_FOLLOW              0x00000001      /* follow leaf symlink */
  76 #define NLC_NOCROSSMOUNT        0x00000002      /* do not cross mount points */
  77 #define NLC_HASBUF              0x00000004      /* nl_path is allocated */
  78 #define NLC_ISWHITEOUT          0x00000008
  79 #define NLC_WILLBEDIR           0x00000010
  80 #define NLC_NCPISLOCKED         0x00000020
  81
  82 #ifdef _KERNEL
  83
  84 int nlookup_init(struct nlookupdata *, const char *, enum uio_seg, int);
  85 void nlookup_done(struct nlookupdata *);
  86 struct namecache *nlookup_simple(const char *str, enum uio_seg seg,
  87                                 int niflags, int *error);
  88 int nlookup_mp(struct mount *mp, struct namecache **ncpp);
  89 int nlookup(struct nlookupdata *);
  90 int nreadsymlink(struct nlookupdata *nd, struct namecache *ncp,
  91                                 struct nlcomponent *nlc);
  92 int naccess(struct namecache *ncp, int vmode, struct ucred *cred);
  93 int naccess_va(struct vattr *va, int vmode, struct ucred *cred);
  94
  95 #endif
  96
  97 #endif /* !_SYS_NAMEI_H_ */