/*
- * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2014 Apple Inc. All rights reserved.
*
- * @APPLE_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 Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * 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.
+ *
+ * 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,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- *
- * @APPLE_LICENSE_HEADER_END@
+ * 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_OSREFERENCE_LICENSE_HEADER_END@
*/
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
*/
#ifndef _SYS_NAMEI_H_
-#define _SYS_NAMEI_H_
+#define _SYS_NAMEI_H_
#include <sys/appleapiopts.h>
-#ifdef __APPLE_API_UNSTABLE
+#ifdef KERNEL
+#define LOCKLEAF 0x0004 /* lock inode on return */
+#define LOCKPARENT 0x0008 /* want parent vnode returned */
+#define WANTPARENT 0x0010 /* want parent vnode returned */
+
+#ifdef KERNEL_PRIVATE
+#define CN_SECLUDE_RENAME 0x10000000 /*rename iff ￢(hard-linked ∨ opened ∨ mmaped)*/
+#define CN_RAW_ENCRYPTED 0x80000000 /* Look-up is for RO raw encrypted access. */
+#endif
+
+#endif // KERNEL
+
+#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/mount.h>
+#include <sys/filedesc.h>
-/*
- * Lookup parameters: this structure describes the subset of
- * information from the nameidata structure that is passed
- * through the VOP interface.
- */
-struct componentname {
- /*
- * Arguments to lookup.
- */
- u_long cn_nameiop; /* namei operation */
- u_long cn_flags; /* flags to namei */
- struct proc *cn_proc; /* process requesting lookup */
- struct ucred *cn_cred; /* credentials */
- /*
- * Shared between lookup and commit routines.
- */
- char *cn_pnbuf; /* pathname buffer */
- long cn_pnlen; /* length of allocated buffer */
- char *cn_nameptr; /* pointer to looked up name */
- long cn_namelen; /* length of looked up component */
- u_long cn_hash; /* hash value of looked up name */
- long cn_consume; /* chars to consume in lookup() */
-};
+#define PATHBUFLEN 256
/*
* Encapsulation of namei parameters.
/*
* Arguments to namei/lookup.
*/
- caddr_t ni_dirp; /* pathname pointer */
- enum uio_seg ni_segflg; /* location of pathname */
- /* u_long ni_nameiop; namei operation */
- /* u_long ni_flags; flags to namei */
- /* struct proc *ni_proc; process requesting 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.
*/
- /* struct ucred *ni_cred; credentials */
- struct vnode *ni_startdir; /* starting directory */
- struct vnode *ni_rootdir; /* logical root directory */
+ struct vnode *ni_startdir; /* starting directory */
+ struct vnode *ni_rootdir; /* logical root directory */
+ struct vnode *ni_usedvp; /* directory passed in via USEDVP */
/*
* Results: returned from/manipulated by lookup
*/
- struct vnode *ni_vp; /* vnode of result */
- struct vnode *ni_dvp; /* vnode of intermediate directory */
+ struct vnode *ni_vp; /* vnode of result */
+ struct vnode *ni_dvp; /* vnode of intermediate directory */
/*
* Shared between namei and lookup/commit routines.
*/
- u_int ni_pathlen; /* remaining chars in path */
- char *ni_next; /* next location in pathname */
- u_long ni_loopcnt; /* count of symlinks encountered */
+ u_int ni_pathlen; /* remaining chars in path */
+ char *ni_next; /* next location in pathname */
+ char ni_pathbuf[PATHBUFLEN];
+ 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 */
};
-#ifdef KERNEL
+#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 */
/*
- * namei operations
+ * 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 LOOKUP 0 /* perform name lookup only */
-#define CREATE 1 /* setup for file creation */
-#define DELETE 2 /* setup for file deletion */
-#define RENAME 3 /* setup for file renaming */
-#define OPMASK 3 /* mask for operation */
+#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
+ * Also includes LOCKLEAF, LOCKPARENT, and WANTPARENT flags, defined above.
*/
-#define LOCKLEAF 0x0004 /* lock inode on return */
-#define LOCKPARENT 0x0008 /* want parent vnode returned locked */
-#define WANTPARENT 0x0010 /* want parent vnode returned unlocked */
-#define NOCACHE 0x0020 /* name must not be left in cache */
-#define FOLLOW 0x0040 /* follow symbolic links */
-#define NOFOLLOW 0x0000 /* do not follow symbolic links (pseudo) */
-#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 */
+#define MODMASK 0x100000fc /* mask of operational modifiers */
/*
* Namei parameter descriptors.
*
- * SAVENAME may be set by either the callers of namei or by VOP_LOOKUP.
- * If the caller of namei sets the flag (for example execve wants to
- * know the name of the program that is being executed), then it must
- * free the buffer. If VOP_LOOKUP sets the flag, then the buffer must
- * be freed by either the commit routine or the VOP_ABORT routine.
* SAVESTART is set only by the callers of namei. It implies SAVENAME
* plus the addition of saving the parent directory that contains the
* name in ni_startdir. It allows repeated calls to lookup for the
* name being sought. The caller is responsible for releasing the
* buffer and for vrele'ing ni_startdir.
*/
-#define NOCROSSMOUNT 0x000100 /* do not cross mount points */
-#define RDONLY 0x000200 /* lookup with read-only semantics */
-#define HASBUF 0x000400 /* has allocated pathname buffer */
-#define SAVENAME 0x000800 /* save pathanme buffer */
-#define SAVESTART 0x001000 /* save starting directory */
-#define ISDOTDOT 0x002000 /* current component name is .. */
-#define MAKEENTRY 0x004000 /* entry is to be added to name cache */
-#define ISLASTCN 0x008000 /* this is last component of pathname */
-#define ISSYMLINK 0x010000 /* symlink needs interpretation */
-#define ISWHITEOUT 0x020000 /* found whiteout */
-#define DOWHITEOUT 0x040000 /* do whiteouts */
-#define WILLBEDIR 0x080000 /* new files will be dirs; allow trailing / */
-#define NODELETEBUSY 0x800000 /* donot delete busy files (Carbon semantic) */
-#define PARAMASK 0x0fff00 /* mask of parameter descriptors */
+#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 DONOTAUTH 0x00000800 /* do not authorize during lookup */
+#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 */
+/* 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 CN_VOLFSPATH 0x00800000 /* user path was a volfs style path */
+#define CN_FIRMLINK_NOFOLLOW 0x01000000 /* Do not follow firm links */
+#define UNIONCREATED 0x02000000 /* union fs creation of vnode */
+#if NAMEDRSRCFORK
+#define CN_WANTSRSRCFORK 0x04000000
+#define CN_ALLOWRSRCFORK 0x08000000
+#endif // NAMEDRSRCFORK
+// CN_SECLUDE_RENAME is defined above as 0x10000000 (SPI)
+#define CN_NBMOUNTLOOK 0x20000000 /* do not block for cross mount lookups */
+#ifdef BSD_KERNEL_PRIVATE
+#define CN_SKIPNAMECACHE 0x40000000 /* skip cache during lookup(), allow FS to handle all components */
+#endif
+// CN_RAW_ENCRYPTED is defined above as 0x80000000 (SPI)
+
/*
* Initialization of an nameidata structure.
*/
-#define NDINIT(ndp, op, flags, segflg, namep, p) { \
+
+#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_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); \
+ } \
+ 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; \
- (ndp)->ni_segflg = segflg; \
+ 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_proc = p; \
+ (ndp)->ni_cnd.cn_context = ctx; \
+ (ndp)->ni_flag = 0; \
+ (ndp)->ni_cnd.cn_ndp = (ndp); \
}
+#endif /* CONFIG_TRIGGERS */
+
#endif /* KERNEL */
/*
* This structure describes the elements in the cache of recent
- * names looked up by namei. NCHNAMLEN is sized to make structure
- * size a power of two to optimize malloc's. Minimum reasonable
- * size is 15.
+ * names looked up by namei.
*/
-
-#define NCHNAMLEN 31 /* maximum name segment length we bother with */
-
-struct namecache {
- LIST_ENTRY(namecache) nc_hash; /* hash chain */
- TAILQ_ENTRY(namecache) nc_lru; /* LRU chain */
- struct vnode *nc_dvp; /* vnode of parent of name */
- u_long nc_dvpid; /* capability number of nc_dvp */
- struct vnode *nc_vp; /* vnode the name refers to */
- u_long nc_vpid; /* capability number of nc_vp */
- char nc_nlen; /* length of name */
- char nc_name[NCHNAMLEN]; /* segment name */
+struct namecache {
+ TAILQ_ENTRY(namecache) nc_entry; /* chain of all entries */
+ TAILQ_ENTRY(namecache) nc_child; /* chain of ncp's that are children of a vp */
+ union {
+ LIST_ENTRY(namecache) nc_link; /* chain of ncp's that 'name' a vp */
+ TAILQ_ENTRY(namecache) nc_negentry; /* chain of ncp's that 'name' a vp */
+ } nc_un;
+ LIST_ENTRY(namecache) nc_hash; /* hash chain */
+ vnode_t nc_dvp; /* vnode of parent of name */
+ vnode_t nc_vp; /* vnode the name refers to */
+ unsigned int nc_hashval; /* hashval of stringname */
+ const char *nc_name; /* pointer to segment name in string cache */
};
+
#ifdef KERNEL
-struct mount;
-extern u_long nextvnodeid;
-int namei __P((struct nameidata *ndp));
-int lookup __P((struct nameidata *ndp));
-int relookup __P((struct vnode *dvp, struct vnode **vpp,
- struct componentname *cnp));
-
-/* namecache function prototypes */
-int cache_lookup __P((struct vnode *dvp, struct vnode **vpp,
- struct componentname *cnp));
-void cache_enter __P((struct vnode *dvp, struct vnode *vpp,
- struct componentname *cnp));
-void cache_purge __P((struct vnode *vp));
-void cache_purgevfs __P((struct mount *mp));
+
+int namei(struct nameidata *ndp);
+void nameidone(struct nameidata *);
+int lookup(struct nameidata *ndp);
+int relookup(struct vnode *dvp, struct vnode **vpp,
+ struct componentname *cnp);
+int lookup_traverse_union(vnode_t dvp, vnode_t *new_dvp, vfs_context_t ctx);
+void lookup_compound_vnop_post_hook(int error, vnode_t dvp, vnode_t vp, struct nameidata *ndp, int did_create);
+void kdebug_lookup(struct vnode *dp, struct componentname *cnp);
+
+/*
+ * 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 *dp_authorized, vnode_t last_dp);
+
+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 */
/*
* Stats on usefulness of namei caches.
*/
-struct nchstats {
- 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_falsehits; /* hits with id mismatch */
- long ncs_miss; /* misses */
- long ncs_long; /* long names that ignore cache */
- long ncs_pass2; /* names found with passes == 2 */
- long ncs_2passes; /* number of times we attempt it */
+struct nchstats {
+ 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_miss; /* misses */
+ long ncs_pass2; /* names found with passes == 2 */
+ long ncs_2passes; /* number of times we attempt it */
+ long ncs_stolen;
+ long ncs_enters;
+ long ncs_deletes;
+ long ncs_badvid;
};
-#endif /* __APPLE_API_UNSTABLE */
+#endif /* BSD_KERNEL_PRIVATE */
#endif /* !_SYS_NAMEI_H_ */
projects / apple / xnu.git / blobdiff