xnu-1699.22.81.tar.gz

[apple/xnu.git] / bsd / sys / namei.h

diff --git a/bsd/sys/namei.h b/bsd/sys/namei.h
index 775a41030b4cf3dfb48235fcc9f1097b3c49cfd4..56d3ecf139bf99138bf7980368196cdcae076890 100644 (file)
--- a/bsd/sys/namei.h
+++ b/bsd/sys/namei.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000-2003 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2010 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*
  */
 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
 /*


@@ -69,6 +75,10 @@
 
 #ifdef BSD_KERNEL_PRIVATE
 
 
 #ifdef BSD_KERNEL_PRIVATE
 

+/* VFS Supports "/..namedfork/rsrc" access. */
+#define NAMEDRSRCFORK          NAMEDSTREAMS
+
+

 #include <sys/queue.h>
 #include <sys/uio.h>
 #include <sys/vnode.h>
 #include <sys/queue.h>
 #include <sys/uio.h>
 #include <sys/vnode.h>


@@ -80,12 +90,15 @@
 /*
  * Encapsulation of namei parameters.
  */
 /*
  * Encapsulation of namei parameters.
  */

-struct nameidata {
+struct nameidata {                         

        /*
         * Arguments to namei/lookup.
         */
        user_addr_t ni_dirp;            /* pathname pointer */
        enum    uio_seg ni_segflg;      /* location of pathname */
        /*
         * Arguments to namei/lookup.
         */
        user_addr_t ni_dirp;            /* pathname pointer */
        enum    uio_seg ni_segflg;      /* location of pathname */

+#if CONFIG_TRIGGERS
+       enum    path_operation ni_op;   /* intended operation, see enum path_operation in vnode.h */
+#endif /* CONFIG_TRIGGERS */

        /*
         * Arguments to lookup.
         */
        /*
         * Arguments to lookup.
         */


@@ -106,16 +119,36 @@ struct nameidata {
        u_long  ni_loopcnt;             /* count of symlinks encountered */
 
        struct componentname ni_cnd;
        u_long  ni_loopcnt;             /* count of symlinks encountered */
 
        struct componentname ni_cnd;

+       int32_t ni_flag;
+       int ni_ncgeneration;            /* For a batched vnop, grab generation beforehand */

 };
 
 };
 

+#define NAMEI_CONTLOOKUP       0x002    /* Continue processing a lookup which was partially processed in a compound VNOP */
+#define NAMEI_TRAILINGSLASH    0x004    /* There was at least one trailing slash after last component */
+#define NAMEI_UNFINISHED       0x008    /* We broke off a lookup to do a compound op */
+/* 
+ * XXX Hack: we need to encode the intended VNOP in order to 
+ * be able to include information about which operations a filesystem
+ * supports in the decision to break off a lookup early.
+ */
+#define NAMEI_COMPOUNDOPEN     0x010   
+#define NAMEI_COMPOUNDREMOVE   0x020   
+#define NAMEI_COMPOUNDMKDIR    0x040   
+#define NAMEI_COMPOUNDRMDIR    0x080   
+#define NAMEI_COMPOUNDRENAME   0x100   
+#define NAMEI_COMPOUND_OP_MASK (NAMEI_COMPOUNDOPEN | NAMEI_COMPOUNDREMOVE | NAMEI_COMPOUNDMKDIR | NAMEI_COMPOUNDRMDIR | NAMEI_COMPOUNDRENAME)
+

 #ifdef KERNEL
 /*
  * namei operational modifier flags, stored in ni_cnd.flags
 #ifdef KERNEL
 /*
  * namei operational modifier flags, stored in ni_cnd.flags

+ * Also includes LOCKLEAF, LOCKPARENT, and WANTPARENT flags, defined above.

  */
  */

-#define        NOCACHE         0x0020  /* name must not be left in cache */
-#define        NOFOLLOW        0x0000  /* do not follow symbolic links (pseudo) */
-#define        SHAREDLEAF      0x0080  /* OK to have shared leaf lock */
-#define        MODMASK         0x00fc  /* mask of operational modifiers */
+#define        NOCACHE         0x00000020 /* name must not be left in cache */
+#define        NOFOLLOW        0x00000000 /* do not follow symbolic links (pseudo) */
+/* public FOLLOW       0x00000040    see vnode.h */
+#define        SHAREDLEAF      0x00000080 /* OK to have shared leaf lock */
+/* public NOTRIGGER    0x10000000    see vnode.h */
+#define        MODMASK         0x100000fc /* mask of operational modifiers */

 /*
  * Namei parameter descriptors.
  *
 /*
  * Namei parameter descriptors.
  *


@@ -125,38 +158,73 @@ struct nameidata {
  * name being sought. The caller is responsible for releasing the
  * buffer and for vrele'ing ni_startdir.
  */
  * name being sought. The caller is responsible for releasing the
  * buffer and for vrele'ing ni_startdir.
  */

+#define        SAVENAME        0          /* save pathanme buffer ***obsolete */

 #define        NOCROSSMOUNT    0x00000100 /* do not cross mount points */
 #define        RDONLY          0x00000200 /* lookup with read-only semantics */
 #define        HASBUF          0x00000400 /* has allocated pathname buffer */
 #define        NOCROSSMOUNT    0x00000100 /* do not cross mount points */
 #define        RDONLY          0x00000200 /* lookup with read-only semantics */
 #define        HASBUF          0x00000400 /* has allocated pathname buffer */

-#define        SAVENAME        0x00000800 /* save pathanme buffer */
+#define DONOTAUTH      0x00000800 /* do not authorize during lookup */

 #define        SAVESTART       0x00001000 /* save starting directory */
 #define        SAVESTART       0x00001000 /* save starting directory */

+/* public ISDOTDOT     0x00002000    see vnode.h */
+/* public MAKEENTRY    0x00004000    see vnode.h */
+/* public ISLASTCN     0x00008000    see vnode.h */

 #define        ISSYMLINK       0x00010000 /* symlink needs interpretation */
 #define        ISSYMLINK       0x00010000 /* symlink needs interpretation */

-#define DONOTAUTH      0x00020000 /* do not authorize during lookup */
+/* public ISWHITEOUT   0x00020000    see vnode.h */
+/* public DOWHITEOUT   0x00040000    see vnode.h */

 #define        WILLBEDIR       0x00080000 /* new files will be dirs; allow trailing / */
 #define        AUDITVNPATH1    0x00100000 /* audit the path/vnode info */
 #define        AUDITVNPATH2    0x00200000 /* audit the path/vnode info */
 #define        USEDVP          0x00400000 /* start the lookup at ndp.ni_dvp */
 #define        WILLBEDIR       0x00080000 /* new files will be dirs; allow trailing / */
 #define        AUDITVNPATH1    0x00100000 /* audit the path/vnode info */
 #define        AUDITVNPATH2    0x00200000 /* audit the path/vnode info */
 #define        USEDVP          0x00400000 /* start the lookup at ndp.ni_dvp */

-#define        PARAMASK        0x003fff00 /* mask of parameter descriptors */
+#define        CN_VOLFSPATH    0x00800000 /* user path was a volfs style path */
+#ifndef __LP64__

 #define FSNODELOCKHELD 0x01000000
 #define FSNODELOCKHELD 0x01000000

+#endif /* __LP64__ */
+#define UNIONCREATED   0x02000000 /* union fs creation of vnode */
+#if NAMEDRSRCFORK
+#define CN_WANTSRSRCFORK 0x04000000
+#define CN_ALLOWRSRCFORK 0x08000000
+#endif
+/* public NOTRIGGER            0x10000000    see vnode.h */
+#define CN_NBMOUNTLOOK 0x20000000 /* do not block for cross mount lookups */

 
 /*
  * Initialization of an nameidata structure.
  */
 
 /*
  * Initialization of an nameidata structure.
  */

-#define NDINIT(ndp, op, flags, segflg, namep, ctx) { \
+
+#if CONFIG_TRIGGERS
+/* Note: vnode triggers require more precise path operation (ni_op) */ 
+
+#define NDINIT(ndp, op, pop, flags, segflg, namep, ctx) { \

        (ndp)->ni_cnd.cn_nameiop = op; \
        (ndp)->ni_cnd.cn_nameiop = op; \

+       (ndp)->ni_op = pop; \

        (ndp)->ni_cnd.cn_flags = flags; \
        if ((segflg) == UIO_USERSPACE) { \
                (ndp)->ni_segflg = ((IS_64BIT_PROCESS(vfs_context_proc(ctx))) ? UIO_USERSPACE64 : UIO_USERSPACE32); \
        } \
        (ndp)->ni_cnd.cn_flags = flags; \
        if ((segflg) == UIO_USERSPACE) { \
                (ndp)->ni_segflg = ((IS_64BIT_PROCESS(vfs_context_proc(ctx))) ? UIO_USERSPACE64 : UIO_USERSPACE32); \
        } \

-       else if ((segflg) == UIO_SYSSPACE) { \
-               (ndp)->ni_segflg = UIO_SYSSPACE32; \
+       else { \
+               (ndp)->ni_segflg = segflg; \
+       } \
+       (ndp)->ni_dirp = namep; \
+       (ndp)->ni_cnd.cn_context = ctx; \
+       (ndp)->ni_flag = 0; \
+       (ndp)->ni_cnd.cn_ndp = (ndp); \
+}
+#else
+#define NDINIT(ndp, op, _unused_, flags, segflg, namep, ctx) { \
+       (ndp)->ni_cnd.cn_nameiop = op; \
+       (ndp)->ni_cnd.cn_flags = flags; \
+       if ((segflg) == UIO_USERSPACE) { \
+               (ndp)->ni_segflg = ((IS_64BIT_PROCESS(vfs_context_proc(ctx))) ? UIO_USERSPACE64 : UIO_USERSPACE32); \

        } \
        else { \
                (ndp)->ni_segflg = segflg; \
        } \
        (ndp)->ni_dirp = namep; \
        (ndp)->ni_cnd.cn_context = ctx; \
        } \
        else { \
                (ndp)->ni_segflg = segflg; \
        } \
        (ndp)->ni_dirp = namep; \
        (ndp)->ni_cnd.cn_context = ctx; \

+       (ndp)->ni_flag = 0; \
+       (ndp)->ni_cnd.cn_ndp = (ndp); \

 }
 }

+#endif /* CONFIG_TRIGGERS */
+

 #endif /* KERNEL */
 
 /*
 #endif /* KERNEL */
 
 /*


@@ -164,7 +232,6 @@ struct nameidata {
  * names looked up by namei.
  */
 
  * names looked up by namei.
  */
 

-#define        NCHNAMLEN       31      /* maximum name segment length we bother with */

 #define NCHASHMASK     0x7fffffff
 
 struct namecache {
 #define NCHASHMASK     0x7fffffff
 
 struct namecache {


@@ -179,7 +246,7 @@ struct      namecache {
        vnode_t                 nc_vp;          /* vnode the name refers to */
         unsigned int           nc_whiteout:1,  /* name has whiteout applied */
                                nc_hashval:31;  /* hashval of stringname */
        vnode_t                 nc_vp;          /* vnode the name refers to */
         unsigned int           nc_whiteout:1,  /* name has whiteout applied */
                                nc_hashval:31;  /* hashval of stringname */

-       char            *       nc_name;        /* pointer to segment name in string cache */
+       const char              *nc_name;       /* pointer to segment name in string cache */

 };
 
 
 };
 
 


@@ -187,21 +254,25 @@ struct    namecache {
 
 int    namei(struct nameidata *ndp);
 void   nameidone(struct nameidata *);
 
 int    namei(struct nameidata *ndp);
 void   nameidone(struct nameidata *);

+void   namei_unlock_fsnode(struct nameidata *ndp);

 int    lookup(struct nameidata *ndp);
 int    relookup(struct vnode *dvp, struct vnode **vpp,
                struct componentname *cnp);
 int    lookup(struct nameidata *ndp);
 int    relookup(struct vnode *dvp, struct vnode **vpp,
                struct componentname *cnp);

+void   lookup_compound_vnop_post_hook(int error, vnode_t dvp, vnode_t vp, struct nameidata *ndp, int did_create);

 
 /*
  * namecache function prototypes
  */
 void    cache_purgevfs(mount_t mp);
 int            cache_lookup_path(struct nameidata *ndp, struct componentname *cnp, vnode_t dp,
 
 /*
  * namecache function prototypes
  */
 void    cache_purgevfs(mount_t mp);
 int            cache_lookup_path(struct nameidata *ndp, struct componentname *cnp, vnode_t dp,

-                         vfs_context_t context, int *trailing_slash, int *dp_authorized);
+                         vfs_context_t context, int *dp_authorized, vnode_t last_dp);

 
 

-void   vnode_cache_credentials(vnode_t vp, vfs_context_t context);
-void   vnode_uncache_credentials(vnode_t vp);
-int            reverse_lookup(vnode_t start_vp, vnode_t *lookup_vpp, 
-                               struct filedesc *fdp, vfs_context_t context, int *dp_authorized);
+void           vnode_cache_authorized_action(vnode_t vp, vfs_context_t context, kauth_action_t action);
+void           vnode_uncache_authorized_action(vnode_t vp, kauth_action_t action);
+boolean_t      vnode_cache_is_stale(vnode_t vp);
+boolean_t      vnode_cache_is_authorized(vnode_t vp, vfs_context_t context, kauth_action_t action);
+int            lookup_validate_creation_path(struct nameidata *ndp);
+int            namei_compound_available(vnode_t dp, struct nameidata *ndp);

 
 #endif /* KERNEL */
 
 
 #endif /* KERNEL */
 


@@ -209,7 +280,6 @@ int         reverse_lookup(vnode_t start_vp, vnode_t *lookup_vpp,
  * Stats on usefulness of namei caches.
  */
 struct nchstats {
  * Stats on usefulness of namei caches.
  */
 struct nchstats {

-        long   ncs_negtotal;

        long    ncs_goodhits;           /* hits that we can really use */
        long    ncs_neghits;            /* negative hits that we can use */
        long    ncs_badhits;            /* hits we must drop */
        long    ncs_goodhits;           /* hits that we can really use */
        long    ncs_neghits;            /* negative hits that we can use */
        long    ncs_badhits;            /* hits we must drop */