[clang][DependencyScanning] Add API to register callback for cmd transform

Add a callback to allow client to transform build command of the module
through CompilerInvocation interface. This allows API user to modified
the build command to its need with very little cost.

Author: cachemeifyoucan

clang/include/clang/Tooling/DependencyScanning/DependencyScanningService.h

@@ -17,6 +17,8 @@
 #include "llvm/CAS/ActionCache.h"
 
 namespace clang {
+class CowCompilerInvocation;
+
 namespace tooling {
 namespace dependencies {
 
@@ -98,13 +100,16 @@ enum class ScanningOptimizations {
 /// is used by the individual dependency scanning workers.
 class DependencyScanningService {
 public:
+  using InvocationCallbackTy = std::function<void(CowCompilerInvocation &)>;
+
   DependencyScanningService(
       ScanningMode Mode, ScanningOutputFormat Format, CASOptions CASOpts,
       std::shared_ptr<llvm::cas::ObjectStore> CAS,
       std::shared_ptr<llvm::cas::ActionCache> Cache,
       IntrusiveRefCntPtr<llvm::cas::CachingOnDiskFileSystem> SharedFS,
       ScanningOptimizations OptimizeArgs = ScanningOptimizations::Default,
-      bool EagerLoadModules = false, bool TraceVFS = false);
+      bool EagerLoadModules = false, bool TraceVFS = false,
+      InvocationCallbackTy TransForm = nullptr);
 
   ScanningMode getMode() const { return Mode; }
 
@@ -133,6 +138,10 @@ class DependencyScanningService {
 
   ModuleCacheMutexes &getModuleCacheMutexes() { return ModCacheMutexes; }
 
+  InvocationCallbackTy getCompilerInvocationTransformation() const {
+    return Transform;
+  }
+
 private:
   const ScanningMode Mode;
   const ScanningOutputFormat Format;
@@ -152,6 +161,8 @@ class DependencyScanningService {
   std::optional<DependencyScanningFilesystemSharedCache> SharedCache;
   /// The global module cache mutexes.
   ModuleCacheMutexes ModCacheMutexes;
+  /// Callback to transform compiler invocation.
+  const InvocationCallbackTy Transform;
 };
 
 } // end namespace dependencies

clang/include/clang/Tooling/DependencyScanning/ModuleDepCollector.h

@@ -266,12 +266,13 @@ class ModuleDepCollectorPP final : public PPCallbacks {
 /// \c ModuleDepCollectorPP to the preprocessor.
 class ModuleDepCollector final : public DependencyCollector {
 public:
-  ModuleDepCollector(DependencyScanningService &Service,
-                     std::unique_ptr<DependencyOutputOptions> Opts,
-                     CompilerInstance &ScanInstance, DependencyConsumer &C,
-                     DependencyActionController &Controller,
-                     CompilerInvocation OriginalCI,
-                     PrebuiltModuleVFSMapT PrebuiltModuleVFSMap);
+  ModuleDepCollector(
+      DependencyScanningService &Service,
+      std::unique_ptr<DependencyOutputOptions> Opts,
+      CompilerInstance &ScanInstance, DependencyConsumer &C,
+      DependencyActionController &Controller, CompilerInvocation OriginalCI,
+      PrebuiltModuleVFSMapT PrebuiltModuleVFSMap,
+      std::function<void(CowCompilerInvocation &)> TransformInvocation);
 
   void attachToPreprocessor(Preprocessor &PP) override;
   void attachToASTReader(ASTReader &R) override;
@@ -320,6 +321,8 @@ class ModuleDepCollector final : public DependencyCollector {
   std::optional<P1689ModuleInfo> ProvidedStdCXXModule;
   std::vector<P1689ModuleInfo> RequiredStdCXXModules;
 
+  std::function<void(CowCompilerInvocation &)> TransformInvocation;
+
   /// Checks whether the module is known as being prebuilt.
   bool isPrebuiltModule(const Module *M);
 

clang/lib/Tooling/DependencyScanning/DependencyScanningService.cpp

@@ -21,10 +21,12 @@ DependencyScanningService::DependencyScanningService(
     std::shared_ptr<llvm::cas::ObjectStore> CAS,
     std::shared_ptr<llvm::cas::ActionCache> Cache,
     IntrusiveRefCntPtr<llvm::cas::CachingOnDiskFileSystem> SharedFS,
-    ScanningOptimizations OptimizeArgs, bool EagerLoadModules, bool TraceVFS)
-    : Mode(Mode), Format(Format), CASOpts(std::move(CASOpts)), CAS(std::move(CAS)), Cache(std::move(Cache)),
-      OptimizeArgs(OptimizeArgs), EagerLoadModules(EagerLoadModules), TraceVFS(TraceVFS),
-      SharedFS(std::move(SharedFS)) {
+    ScanningOptimizations OptimizeArgs, bool EagerLoadModules, bool TraceVFS,
+    InvocationCallbackTy Transform)
+    : Mode(Mode), Format(Format), CASOpts(std::move(CASOpts)),
+      CAS(std::move(CAS)), Cache(std::move(Cache)), OptimizeArgs(OptimizeArgs),
+      EagerLoadModules(EagerLoadModules), TraceVFS(TraceVFS),
+      SharedFS(std::move(SharedFS)), Transform(Transform) {
   if (!this->SharedFS)
     SharedCache.emplace();
 

clang/lib/Tooling/DependencyScanning/DependencyScanningWorker.cpp

@@ -404,11 +404,11 @@ class DependencyScanningAction : public tooling::ToolAction {
       bool DiagGenerationAsCompilation, const CASOptions &CASOpts,
       std::optional<StringRef> ModuleName = std::nullopt,
       raw_ostream *VerboseOS = nullptr)
-      : Service(Service), WorkingDirectory(WorkingDirectory), Consumer(Consumer),
-        Controller(Controller), DepFS(std::move(DepFS)),
+      : Service(Service), WorkingDirectory(WorkingDirectory),
+        Consumer(Consumer), Controller(Controller), DepFS(std::move(DepFS)),
         DepCASFS(std::move(DepCASFS)), CacheFS(std::move(CacheFS)),
-        DisableFree(DisableFree),
-        CASOpts(CASOpts), EmitDependencyFile(EmitDependencyFile),
+        DisableFree(DisableFree), CASOpts(CASOpts),
+        EmitDependencyFile(EmitDependencyFile),
         DiagGenerationAsCompilation(DiagGenerationAsCompilation),
         ModuleName(ModuleName), VerboseOS(VerboseOS) {}
 
@@ -569,7 +569,8 @@ class DependencyScanningAction : public tooling::ToolAction {
 
       MDC = std::make_shared<ModuleDepCollector>(
           Service, std::move(Opts), ScanInstance, Consumer, Controller,
-          OriginalInvocation, std::move(PrebuiltModuleVFSMap));
+          OriginalInvocation, std::move(PrebuiltModuleVFSMap),
+          Service.getCompilerInvocationTransformation());
       ScanInstance.addDependencyCollector(MDC);
       ScanInstance.setGenModuleActionWrapper(
           [&Controller = Controller](const FrontendOptions &Opts,

clang/lib/Tooling/DependencyScanning/ModuleDepCollector.cpp

@@ -956,9 +956,12 @@ ModuleDepCollectorPP::handleTopLevelModule(const Module *M) {
   // Finish the compiler invocation. Requires dependencies and the context hash.
   MDC.addOutputPaths(CI, MD);
 
+  if (MDC.TransformInvocation)
+    MDC.TransformInvocation(CI);
+
 #ifndef NDEBUG
   // Verify the key has not changed with final arguments.
-  if (MD.ModuleCacheKey) {
+  if (MD.ModuleCacheKey && !MDC.TransformInvocation) {
     auto &CAS = MDC.ScanInstance.getOrCreateObjectStore();
     auto Key = createCompileJobCacheKey(CAS, Diags, CI);
     assert(Key);
@@ -1078,13 +1081,15 @@ ModuleDepCollector::ModuleDepCollector(
     std::unique_ptr<DependencyOutputOptions> Opts,
     CompilerInstance &ScanInstance, DependencyConsumer &C,
     DependencyActionController &Controller, CompilerInvocation OriginalCI,
-    PrebuiltModuleVFSMapT PrebuiltModuleVFSMap)
+    PrebuiltModuleVFSMapT PrebuiltModuleVFSMap,
+    std::function<void(CowCompilerInvocation &)> TransformInvocation)
     : Service(Service), ScanInstance(ScanInstance), Consumer(C),
       Controller(Controller),
       PrebuiltModuleVFSMap(std::move(PrebuiltModuleVFSMap)),
       Opts(std::move(Opts)),
       CommonInvocation(
-          makeCommonInvocationForModuleBuild(std::move(OriginalCI))) {}
+          makeCommonInvocationForModuleBuild(std::move(OriginalCI))),
+      TransformInvocation(TransformInvocation) {}
 
 void ModuleDepCollector::attachToPreprocessor(Preprocessor &PP) {
   PP.addPPCallbacks(std::make_unique<ModuleDepCollectorPP>(*this));