Merge pull request #6582 from akyrtzi/pr/stable/libclang-cache-keys

[stable][libclang][cas] Expose the module and TU cache keys from the libclang dep-scan API

Author: akyrtzi

clang/include/clang-c/Dependencies.h

@@ -525,6 +525,12 @@ CINDEX_LINKAGE CXCStringArray
 CINDEX_LINKAGE CXCStringArray
     clang_experimental_DepGraphModule_getBuildArguments(CXDepGraphModule);
 
+/**
+ * \returns the \c ActionCache key for this module, if any.
+ */
+CINDEX_LINKAGE
+const char *clang_experimental_DepGraphModule_getCacheKey(CXDepGraphModule);
+
 /**
  * \returns the number \c CXDepGraphTUCommand objects in the graph.
  */
@@ -563,6 +569,12 @@ CINDEX_LINKAGE const char *
 CINDEX_LINKAGE CXCStringArray
     clang_experimental_DepGraphTUCommand_getBuildArguments(CXDepGraphTUCommand);
 
+/**
+ * \returns the \c ActionCache key for this translation unit, if any.
+ */
+CINDEX_LINKAGE const char *
+    clang_experimental_DepGraphTUCommand_getCacheKey(CXDepGraphTUCommand);
+
 /**
  * \returns the list of files which this translation unit directly depends on.
  *

clang/test/Index/Core/scan-deps-cas.m

@@ -33,6 +33,7 @@
 // CHECK-NEXT:     name: ModA
 // CHECK-NEXT:     context-hash: [[HASH_MOD_A:[A-Z0-9]+]]
 // CHECK-NEXT:     module-map-path: [[PREFIX]]/Inputs/module/module.modulemap
+// CHECK-NEXT:     cache-key: [[CASFS_MODA_CACHE_KEY:llvmcas://[[:xdigit:]]+]]
 // CHECK-NEXT:     module-deps:
 // CHECK-NEXT:     file-deps:
 // CHECK-NEXT:       [[PREFIX]]/Inputs/module/ModA.h
@@ -51,6 +52,7 @@
 // CHECK-NEXT: dependencies:
 // CHECK-NEXT:   command 0:
 // CHECK-NEXT:     context-hash: [[HASH_TU:[A-Z0-9]+]]
+// CHECK-NEXT:     cache-key: [[CASFS_TU_CACHE_KEY:llvmcas://[[:xdigit:]]+]]
 // CHECK-NEXT:     module-deps:
 // CHECK-NEXT:       ModA:[[HASH_MOD_A]]
 // CHECK-NEXT:     file-deps:
@@ -66,6 +68,7 @@
 // INCLUDE_TREE:      dependencies:
 // INCLUDE_TREE-NEXT:   command 0:
 // INCLUDE_TREE-NEXT:     context-hash: [[HASH_TU:[A-Z0-9]+]]
+// INCLUDE_TREE-NEXT:     cache-key: [[INC_TU_CACHE_KEY:llvmcas://[[:xdigit:]]+]]
 // INCLUDE_TREE-NEXT:     module-deps:
 // INCLUDE_TREE-NEXT:     file-deps:
 // INCLUDE_TREE-NEXT:       [[PREFIX]]/scan-deps-cas.m

clang/tools/c-index-test/core_main.cpp

@@ -753,10 +753,13 @@ static int scanDeps(ArrayRef<const char *> Args, std::string WorkingDirectory,
 
   unsigned CommandIndex = 0;
   auto HandleCommand = [&](const char *ContextHash, CXCStringArray ModuleDeps,
-                           CXCStringArray FileDeps, CXCStringArray Args) {
+                           CXCStringArray FileDeps, CXCStringArray Args,
+                           const char *CacheKey) {
     llvm::outs() << "  command " << CommandIndex++ << ":\n";
-    llvm::outs() << "    context-hash: " << ContextHash << "\n"
-                 << "    module-deps:\n";
+    llvm::outs() << "    context-hash: " << ContextHash << "\n";
+    if (CacheKey)
+      llvm::outs() << "    cache-key: " << CacheKey << "\n";
+    llvm::outs() << "    module-deps:\n";
     for (const auto &ModuleName :
          llvm::makeArrayRef(ModuleDeps.Strings, ModuleDeps.Count))
       llvm::outs() << "      " << ModuleName << "\n";
@@ -794,6 +797,8 @@ static int scanDeps(ArrayRef<const char *> Args, std::string WorkingDirectory,
           clang_experimental_DepGraphModule_getContextHash(Mod);
       const char *ModuleMapPath =
           clang_experimental_DepGraphModule_getModuleMapPath(Mod);
+      const char *ModuleCacheKey =
+          clang_experimental_DepGraphModule_getCacheKey(Mod);
       CXCStringArray ModuleDeps =
           clang_experimental_DepGraphModule_getModuleDeps(Mod);
       CXCStringArray FileDeps =
@@ -806,8 +811,10 @@ static int scanDeps(ArrayRef<const char *> Args, std::string WorkingDirectory,
                    << "    name: " << Name << "\n"
                    << "    context-hash: " << ContextHash << "\n"
                    << "    module-map-path: "
-                   << (ModuleMapPath ? ModuleMapPath : "<none>") << "\n"
-                   << "    module-deps:\n";
+                   << (ModuleMapPath ? ModuleMapPath : "<none>") << "\n";
+      if (ModuleCacheKey)
+        llvm::outs() << "    cache-key: " << ModuleCacheKey << "\n";
+      llvm::outs() << "    module-deps:\n";
       for (const auto &ModuleName :
            ArrayRef(ModuleDeps.Strings, ModuleDeps.Count))
         llvm::outs() << "      " << ModuleName << "\n";
@@ -834,9 +841,11 @@ static int scanDeps(ArrayRef<const char *> Args, std::string WorkingDirectory,
           clang_experimental_DepGraph_getTUCommand(Graph, I);
       CXCStringArray Args =
           clang_experimental_DepGraphTUCommand_getBuildArguments(Cmd);
+      const char *CacheKey =
+          clang_experimental_DepGraphTUCommand_getCacheKey(Cmd);
       auto Dispose = llvm::make_scope_exit(
           [&]() { clang_experimental_DepGraphTUCommand_dispose(Cmd); });
-      HandleCommand(TUContextHash, TUModuleDeps, TUFileDeps, Args);
+      HandleCommand(TUContextHash, TUModuleDeps, TUFileDeps, Args, CacheKey);
     }
     return 0;
   }

clang/tools/libclang/CDependencies.cpp

@@ -546,6 +546,14 @@ clang_experimental_DepGraphModule_getBuildArguments(CXDepGraphModule CXDepMod) {
   return unwrap(CXDepMod)->StrMgr.createCStringsRef(ModDeps.BuildArguments);
 }
 
+const char *
+clang_experimental_DepGraphModule_getCacheKey(CXDepGraphModule CXDepMod) {
+  ModuleDeps &ModDeps = *unwrap(CXDepMod)->ModDeps;
+  if (ModDeps.ModuleCacheKey)
+    return ModDeps.ModuleCacheKey->c_str();
+  return nullptr;
+}
+
 size_t clang_experimental_DepGraph_getNumTUCommands(CXDepGraph Graph) {
   TranslationUnitDeps &TUDeps = unwrap(Graph)->TUDeps;
   return TUDeps.Commands.size();
@@ -573,6 +581,14 @@ CXCStringArray clang_experimental_DepGraphTUCommand_getBuildArguments(
   return unwrap(CXCmd)->StrMgr.createCStringsRef(TUCmd.Arguments);
 }
 
+const char *
+clang_experimental_DepGraphTUCommand_getCacheKey(CXDepGraphTUCommand CXCmd) {
+  Command &TUCmd = *unwrap(CXCmd)->TUCmd;
+  if (TUCmd.TUCacheKey)
+    return TUCmd.TUCacheKey->c_str();
+  return nullptr;
+}
+
 CXCStringArray clang_experimental_DepGraph_getTUFileDeps(CXDepGraph Graph) {
   TranslationUnitDeps &TUDeps = unwrap(Graph)->TUDeps;
   return unwrap(Graph)->StrMgr.createCStringsRef(TUDeps.FileDeps);

clang/tools/libclang/libclang.map

@@ -503,13 +503,15 @@ LLVM_16 {
     clang_experimental_DepGraph_getTUModuleDeps;
     clang_experimental_DepGraphModule_dispose;
     clang_experimental_DepGraphModule_getBuildArguments;
+    clang_experimental_DepGraphModule_getCacheKey;
     clang_experimental_DepGraphModule_getContextHash;
     clang_experimental_DepGraphModule_getFileDeps;
     clang_experimental_DepGraphModule_getModuleDeps;
     clang_experimental_DepGraphModule_getModuleMapPath;
     clang_experimental_DepGraphModule_getName;
     clang_experimental_DepGraphTUCommand_dispose;
     clang_experimental_DepGraphTUCommand_getBuildArguments;
+    clang_experimental_DepGraphTUCommand_getCacheKey;
     clang_experimental_DepGraphTUCommand_getExecutable;
     clang_getUnqualifiedType;
     clang_getNonReferenceType;