55
66#include " public/PrjFSCommon.h"
77#include " public/PrjFSPerfCounter.h"
8+ #include " public/PrjFSXattrs.h"
89#include " VirtualizationRoots.hpp"
910#include " VnodeUtilities.hpp"
1011#include " KauthHandler.hpp"
1617#include " kernel-header-wrappers/stdatomic.h"
1718#include " KextLog.hpp"
1819#include " ProviderMessaging.hpp"
19- #include " public/PrjFSXattrs.h "
20+ #include " VnodeCache.hpp "
2021
2122#ifdef KEXT_UNIT_TESTING
2223#include " KauthHandlerTestable.hpp"
@@ -88,12 +89,13 @@ static bool TryGetVirtualizationRoot(
8889 int * kauthResult,
8990 int * kauthError);
9091
91- static bool ShouldHandleFileOpEvent (
92+ KEXT_STATIC bool ShouldHandleFileOpEvent (
9293 // In params:
9394 PerfTracer* perfTracer,
9495 vfs_context_t _Nonnull context,
9596 const vnode_t vnode,
9697 kauth_action_t action,
98+ bool isDirectory,
9799
98100 // Out params:
99101 VirtualizationRootHandle* root,
@@ -124,6 +126,11 @@ kern_return_t KauthHandler_Init()
124126 goto CleanupAndFail;
125127 }
126128
129+ if (VnodeCache_Init ())
130+ {
131+ goto CleanupAndFail;
132+ }
133+
127134 s_vnodeListener = kauth_listen_scope (KAUTH_SCOPE_VNODE, HandleVnodeOperation, nullptr );
128135 if (nullptr == s_vnodeListener)
129136 {
@@ -172,6 +179,11 @@ kern_return_t KauthHandler_Cleanup()
172179
173180 WaitForListenerCompletion ();
174181
182+ if (VnodeCache_Cleanup ())
183+ {
184+ result = KERN_FAILURE;
185+ }
186+
175187 if (VirtualizationRoots_Cleanup ())
176188 {
177189 result = KERN_FAILURE;
@@ -468,6 +480,8 @@ KEXT_STATIC int HandleFileOpOperation(
468480
469481 putCurrentVnode = true ;
470482
483+ bool isDirectory = (0 != vnode_isdir (currentVnode));
484+
471485 VirtualizationRootHandle root = RootHandle_None;
472486 FsidInode vnodeFsidInode = {};
473487 int pid;
@@ -476,6 +490,7 @@ KEXT_STATIC int HandleFileOpOperation(
476490 context,
477491 currentVnode,
478492 action,
493+ isDirectory,
479494 &root,
480495 &vnodeFsidInode,
481496 &pid))
@@ -491,7 +506,7 @@ KEXT_STATIC int HandleFileOpOperation(
491506 PerfSample renameSample (&perfTracer, PrjFSPerfCounter_FileOp_Renamed);
492507
493508 MessageType messageType =
494- vnode_isdir (currentVnode)
509+ isDirectory
495510 ? MessageType_KtoU_NotifyDirectoryRenamed
496511 : MessageType_KtoU_NotifyFileRenamed;
497512
@@ -566,6 +581,7 @@ KEXT_STATIC int HandleFileOpOperation(
566581 context,
567582 currentVnode,
568583 action,
584+ false /* isDirectory */
569585 &root,
570586 &vnodeFsidInode,
571587 &pid))
@@ -619,6 +635,7 @@ KEXT_STATIC int HandleFileOpOperation(
619635 context,
620636 currentVnode,
621637 action,
638+ false /* isDirectory */
622639 &root,
623640 &vnodeFsidInode,
624641 &pid))
@@ -780,10 +797,11 @@ static bool TryGetVirtualizationRoot(
780797 int * kauthError)
781798{
782799 PerfSample findRootSample (perfTracer, PrjFSPerfCounter_VnodeOp_GetVirtualizationRoot);
783-
784- *vnodeFsidInode = Vnode_GetFsidAndInode (vnode, context, true /* the inode is used for getting the path in the provider, so use linkid */
785- *root = VirtualizationRoot_FindForVnode (
800+
801+ *root = VnodeCache_FindRootForVnode (
786802 perfTracer,
803+ PrjFSPerfCounter_VnodeOp_Vnode_Cache_Hit,
804+ PrjFSPerfCounter_VnodeOp_Vnode_Cache_Miss,
787805 PrjFSPerfCounter_VnodeOp_FindRoot,
788806 PrjFSPerfCounter_VnodeOp_FindRoot_Iteration,
789807 vnode,
@@ -836,6 +854,8 @@ static bool TryGetVirtualizationRoot(
836854 return false ;
837855 }
838856
857+ *vnodeFsidInode = Vnode_GetFsidAndInode (vnode, context, true /* the inode is used for getting the path in the provider, so use linkid */
858+
839859 return true ;
840860}
841861
@@ -884,12 +904,13 @@ static bool CurrentProcessWasSpawnedByRegularUser()
884904}
885905
886906
887- static bool ShouldHandleFileOpEvent (
907+ KEXT_STATIC bool ShouldHandleFileOpEvent (
888908 // In params:
889909 PerfTracer* perfTracer,
890- vfs_context_t context,
910+ vfs_context_t _Nonnull context,
891911 const vnode_t vnode,
892912 kauth_action_t action,
913+ bool isDirectory,
893914
894915 // Out params:
895916 VirtualizationRootHandle* root,
@@ -914,12 +935,72 @@ static bool ShouldHandleFileOpEvent(
914935 {
915936 PerfSample findRootSample (perfTracer, PrjFSPerfCounter_FileOp_ShouldHandle_FindVirtualizationRoot);
916937
917- *root = VirtualizationRoot_FindForVnode (
918- perfTracer,
919- PrjFSPerfCounter_FileOp_FindRoot,
920- PrjFSPerfCounter_FileOp_FindRoot_Iteration,
921- vnode,
922- context);
938+ if (isDirectory)
939+ {
940+ if (KAUTH_FILEOP_RENAME == action)
941+ {
942+ // Directory renames into (or out) of virtualization roots require invalidating all of the entries
943+ // within the directory being renamed (because all of those entires now have a new virtualzation root).
944+ // Rather than trying to find all vnodes in the cache that are children of the directory being renamed
945+ // we simply invalidate the entire cache.
946+ //
947+ // Potential future optimizations include:
948+ // - Only invalidate the cache if the rename moves a directory in or out of a directory
949+ // - Keeping a per-root generation ID in the cache to allow invalidating a subset of the cache
950+ VnodeCache_InvalidateCache (perfTracer);
951+ }
952+
953+ *root = VnodeCache_FindRootForVnode (
954+ perfTracer,
955+ PrjFSPerfCounter_FileOp_Vnode_Cache_Hit,
956+ PrjFSPerfCounter_FileOp_Vnode_Cache_Miss,
957+ PrjFSPerfCounter_FileOp_FindRoot,
958+ PrjFSPerfCounter_FileOp_FindRoot_Iteration,
959+ vnode,
960+ context);
961+ }
962+ else
963+ {
964+ // TODO(Mac): Once all hardlink paths are delivered to the appropriate root(s)
965+ // check if the KAUTH_FILEOP_LINK case can be removed. For now the check is required to make
966+ // sure we're looking up the most up-to-date parent information for the vnode on the next
967+ // access to the vnode cache
968+ switch (action)
969+ {
970+ case KAUTH_FILEOP_LINK:
971+ *root = VnodeCache_InvalidateVnodeRootAndGetLatestRoot (
972+ perfTracer,
973+ PrjFSPerfCounter_FileOp_Vnode_Cache_Hit,
974+ PrjFSPerfCounter_FileOp_Vnode_Cache_Miss,
975+ PrjFSPerfCounter_FileOp_FindRoot,
976+ PrjFSPerfCounter_FileOp_FindRoot_Iteration,
977+ vnode,
978+ context);
979+ break ;
980+
981+ case KAUTH_FILEOP_RENAME:
982+ *root = VnodeCache_RefreshRootForVnode (
983+ perfTracer,
984+ PrjFSPerfCounter_FileOp_Vnode_Cache_Hit,
985+ PrjFSPerfCounter_FileOp_Vnode_Cache_Miss,
986+ PrjFSPerfCounter_FileOp_FindRoot,
987+ PrjFSPerfCounter_FileOp_FindRoot_Iteration,
988+ vnode,
989+ context);
990+ break ;
991+
992+ default :
993+ *root = VnodeCache_FindRootForVnode (
994+ perfTracer,
995+ PrjFSPerfCounter_FileOp_Vnode_Cache_Hit,
996+ PrjFSPerfCounter_FileOp_Vnode_Cache_Miss,
997+ PrjFSPerfCounter_FileOp_FindRoot,
998+ PrjFSPerfCounter_FileOp_FindRoot_Iteration,
999+ vnode,
1000+ context);
1001+ break ;
1002+ }
1003+ }
9231004
9241005 if (!VirtualizationRoot_IsValidRootHandle (*root))
9251006 {
0 commit comments