[llvm] 58cd17d - [ORC] Add comments to ResourceManager to clarify locking rules.

[Lang Hames via llvm-commits]

Author: Lang Hames
Date: 2024-12-16T14:28:29+11:00
New Revision: 58cd17d960462c63c3a964efe539ae15774a6c66

URL: https://github.com/llvm/llvm-project/commit/58cd17d960462c63c3a964efe539ae15774a6c66
DIFF: https://github.com/llvm/llvm-project/commit/58cd17d960462c63c3a964efe539ae15774a6c66.diff

LOG: [ORC] Add comments to ResourceManager to clarify locking rules.

Added: 
    

Modified: 
    llvm/include/llvm/ExecutionEngine/Orc/Core.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/ExecutionEngine/Orc/Core.h b/llvm/include/llvm/ExecutionEngine/Orc/Core.h
index 9e3e46285c4085..7f75d799cab6a1 100644
--- a/llvm/include/llvm/ExecutionEngine/Orc/Core.h
+++ b/llvm/include/llvm/ExecutionEngine/Orc/Core.h
@@ -125,7 +125,14 @@ class ResourceTracker : public ThreadSafeRefCountedBase<ResourceTracker> {
 class ResourceManager {
 public:
   virtual ~ResourceManager();
+
+  /// This function will be called *outside* the session lock. ResourceManagers
+  /// should perform book-keeping under the session lock, and any expensive
+  /// cleanup outside the session lock.
   virtual Error handleRemoveResources(JITDylib &JD, ResourceKey K) = 0;
+
+  /// This function will be called *inside* the session lock. ResourceManagers
+  /// DO NOT need to re-lock the session.
   virtual void handleTransferResources(JITDylib &JD, ResourceKey DstK,
                                        ResourceKey SrcK) = 0;
 };