[6.2🍒] add a new prefix mapping option to fix problems with paths including an equal sign

Author: sina-mahdavi

clang/include/clang/Driver/Options.td

@@ -8414,11 +8414,15 @@ def fdepscan_include_tree : Flag<["-"], "fdepscan-include-tree">,
 //
 // FIXME: Add DepscanOption flag.
 def fdepscan_prefix_map_EQ : Joined<["-"], "fdepscan-prefix-map=">,
-    Group<f_Group>, Visibility<[ClangOption, CC1Option]>,
+    Group<f_Group>, Visibility<[ClangOption]>,
     MetaVarName<"<old>=<new>">,
     HelpText<"With -fdepscan, seamlessly filter the CAS filesystem to"
-             " apply the given prefix, updating the command-line to match.">,
-    MarshallingInfoStringVector<FrontendOpts<"PathPrefixMappings">>;
+             " apply the given prefix, updating the command-line to match.">;
+def fdepscan_prefix_map : MultiArg<["-"], "fdepscan-prefix-map", 2>,
+    Group<f_Group>, Visibility<[ClangOption, CC1Option]>,
+    MetaVarName<"<old> <new>">,
+    HelpText<"With -fdepscan, seamlessly filter the CAS filesystem to"
+             " apply the given prefix, updating the command-line to match.">;
 def fdepscan_prefix_map_sdk_EQ :
     Joined<["-"], "fdepscan-prefix-map-sdk=">,
     Group<f_Group>, MetaVarName<"<new>">,

clang/include/clang/Frontend/CompileJobCacheKey.h

@@ -40,7 +40,7 @@ struct CompileJobCachingOptions {
   /// See \c FrontendOptions::WriteOutputAsCASID.
   bool WriteOutputAsCASID;
   /// See \c FrontendOptions::PathPrefixMappings.
-  std::vector<std::string> PathPrefixMappings;
+  std::vector<std::pair<std::string, std::string>> PathPrefixMappings;
 };
 
 /// Create a cache key for the given \c CompilerInvocation as a \c CASID. If \p

clang/include/clang/Frontend/FrontendOptions.h

@@ -587,7 +587,7 @@ class FrontendOptions {
   /// When caching is enabled, represents remappings for all the file paths that
   /// the compilation may access. This is useful for canonicalizing the
   /// compilation for caching purposes.
-  std::vector<std::string> PathPrefixMappings;
+  std::vector<std::pair<std::string, std::string>> PathPrefixMappings;
 
   // Currently this is only used as part of the `-extract-api` action.
   // A comma separated list of files providing a list of APIs to

clang/include/clang/Tooling/DependencyScanning/ScanAndUpdateArgs.h

@@ -46,7 +46,7 @@ struct DepscanPrefixMapping {
                                     llvm::PrefixMapper &Mapper);
 
   /// Add path mappings to the \p Mapper.
-  static void configurePrefixMapper(ArrayRef<std::string> PathPrefixMappings,
+  static void configurePrefixMapper(ArrayRef<std::pair<std::string, std::string>> PathPrefixMappings,
                                     llvm::PrefixMapper &Mapper);
 
   /// Apply the mappings from \p Mapper to \p Invocation.

clang/lib/Driver/ToolChains/Clang.cpp

@@ -4910,8 +4910,9 @@ void Clang::AddPrefixMappingOptions(const ArgList &Args, ArgStringList &CmdArgs,
 
   if (Arg *A = Args.getLastArg(options::OPT_fdepscan_prefix_map_sdk_EQ)) {
     if (IsPathApplicableAsPrefix(Sysroot)) {
-      CmdArgs.push_back(Args.MakeArgString(Twine("-fdepscan-prefix-map=") +
-                                           *Sysroot + "=" + A->getValue()));
+      CmdArgs.push_back("-fdepscan-prefix-map");
+      CmdArgs.push_back(Args.MakeArgString(*Sysroot));
+      CmdArgs.push_back(Args.MakeArgString(A->getValue()));
     } else {
       // FIXME: warning if we cannot infer sdk
     }
@@ -4926,22 +4927,31 @@ void Clang::AddPrefixMappingOptions(const ArgList &Args, ArgStringList &CmdArgs,
       Guess = llvm::sys::path::parent_path(Guess);
     }
     if (IsPathApplicableAsPrefix(Guess)) {
-      CmdArgs.push_back(Args.MakeArgString(Twine("-fdepscan-prefix-map=") +
-                                           Guess + "=" + A->getValue()));
+      CmdArgs.push_back("-fdepscan-prefix-map");
+      CmdArgs.push_back(Args.MakeArgString(Guess));
+      CmdArgs.push_back(Args.MakeArgString(A->getValue()));
     } else {
       // FIXME: warning if we cannot infer toolchain
     }
   }
 
-  for (const Arg *A : Args.filtered(options::OPT_fdepscan_prefix_map_EQ)) {
+  for (const Arg *A : Args.filtered(options::OPT_fdepscan_prefix_map, options::OPT_fdepscan_prefix_map_EQ)) {
     A->claim();
-    StringRef Map = A->getValue();
-    StringRef Prefix = Map.split('=').first;
-    if (Prefix.size() == Map.size() || !IsPathApplicableAsPrefix(Prefix)) {
+    StringRef Prefix, MapTarget;
+    if (A->getOption().matches(options::OPT_fdepscan_prefix_map_EQ)) {
+      StringRef Map = A->getValue();
+      std::tie(Prefix, MapTarget) = Map.split('=');
+    } else {
+      Prefix = A->getValue(0);
+      MapTarget = A->getValue(1);
+    }
+    if (MapTarget.size() == 0 || !IsPathApplicableAsPrefix(Prefix)) {
       D.Diag(diag::err_drv_invalid_argument_to_option)
           << A->getValue() << A->getOption().getName();
     } else {
-      A->render(Args, CmdArgs);
+      CmdArgs.push_back("-fdepscan-prefix-map");
+      CmdArgs.push_back(Args.MakeArgString(Prefix));
+      CmdArgs.push_back(Args.MakeArgString(MapTarget));
     }
   }
 }

clang/lib/Frontend/CompileJobCache.cpp

@@ -319,8 +319,7 @@ std::optional<int> CompileJobCache::initialize(CompilerInstance &Clang) {
 
   llvm::PrefixMapper PrefixMapper;
   llvm::SmallVector<llvm::MappedPrefix> Split;
-  llvm::MappedPrefix::transformJoinedIfValid(CacheOpts.PathPrefixMappings,
-                                             Split);
+  llvm::MappedPrefix::transformPairs(CacheOpts.PathPrefixMappings, Split);
   for (const auto &MappedPrefix : Split) {
     // We use the inverse mapping because the \p PrefixMapper will be used for
     // de-canonicalization of paths.
@@ -607,7 +606,7 @@ Expected<std::optional<int>> CompileJobCache::replayCachedResult(
 
   llvm::PrefixMapper PrefixMapper;
   llvm::SmallVector<llvm::MappedPrefix> Split;
-  llvm::MappedPrefix::transformJoinedIfValid(
+  llvm::MappedPrefix::transformPairs(
       Clang.getFrontendOpts().PathPrefixMappings, Split);
   for (const auto &MappedPrefix : Split) {
     // We use the inverse mapping because the \p PrefixMapper will be used for

clang/lib/Frontend/CompilerInvocation.cpp

@@ -84,6 +84,7 @@
 #include "llvm/Support/MathExtras.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
+#include "llvm/Support/PrefixMapper.h"
 #include "llvm/Support/Process.h"
 #include "llvm/Support/Regex.h"
 #include "llvm/Support/VersionTuple.h"
@@ -3022,6 +3023,9 @@ static void GenerateFrontendArgs(const FrontendOptions &Opts,
   for (const auto &A : Opts.ModuleCacheKeys)
     GenerateMultiArg(Consumer, OPT_fmodule_file_cache_key, {A.first, A.second});
 
+  for (const auto &A : Opts.PathPrefixMappings)
+    GenerateMultiArg(Consumer, OPT_fdepscan_prefix_map, {A.first, A.second});
+
   if (Opts.AuxTargetCPU)
     GenerateArg(Consumer, OPT_aux_target_cpu, *Opts.AuxTargetCPU);
 
@@ -3249,6 +3253,13 @@ static bool ParseFrontendArgs(FrontendOptions &Opts, ArgList &Args,
     Opts.ModuleCacheKeys.emplace_back(Values[0], Values[1]);
   }
 
+  // Handle path prefix mappings
+  for (const Arg *A : Args.filtered(OPT_fdepscan_prefix_map)) {
+    ArrayRef<const char *> Values = A->getValues();
+    assert(Values.size() == 2);
+    Opts.PathPrefixMappings.emplace_back(Values[0], Values[1]);
+  }
+
   if (Opts.ProgramAction != frontend::GenerateModule && Opts.IsSystemModule)
     Diags.Report(diag::err_drv_argument_only_allowed_with) << "-fsystem-module"
                                                            << "-emit-module";

clang/lib/Tooling/DependencyScanning/ScanAndUpdateArgs.cpp

@@ -128,7 +128,7 @@ void DepscanPrefixMapping::remapInvocationPaths(CompilerInvocation &Invocation,
   // Pass the remappings so that we can map cached diagnostics to the local
   // paths during diagnostic rendering.
   for (const llvm::MappedPrefix &Map : Mapper.getMappings()) {
-    FrontendOpts.PathPrefixMappings.push_back(Map.Old + "=" + Map.New);
+    FrontendOpts.PathPrefixMappings.emplace_back(Map.Old, Map.New);
   }
 
   auto mapInPlaceAll = [&](std::vector<std::string> &Vector) {
@@ -229,12 +229,12 @@ void DepscanPrefixMapping::configurePrefixMapper(const CompilerInvocation &CI,
 }
 
 void DepscanPrefixMapping::configurePrefixMapper(
-    ArrayRef<std::string> PathPrefixMappings, llvm::PrefixMapper &Mapper) {
+    ArrayRef<std::pair<std::string, std::string>> PathPrefixMappings, llvm::PrefixMapper &Mapper) {
   if (PathPrefixMappings.empty())
     return;
 
   llvm::SmallVector<llvm::MappedPrefix> Split;
-  llvm::MappedPrefix::transformJoinedIfValid(PathPrefixMappings, Split);
+  llvm::MappedPrefix::transformPairs(PathPrefixMappings, Split);
   for (auto &MappedPrefix : Split)
     Mapper.add(MappedPrefix);
 

clang/test/CAS/cached-diagnostics.c

@@ -5,7 +5,7 @@
 // RUN: %clang_cc1 -triple x86_64-apple-macos12 -fsyntax-only %t/src/main.c -I %t/src/inc -Wunknown-pragmas 2> %t/regular-diags1.txt
 
 // RUN: %clang -cc1depscan -fdepscan=inline -fdepscan-include-tree -o %t/t1.rsp -cc1-args \
-// RUN:   -cc1 -triple x86_64-apple-macos12 -fcas-path %t/cas -fdepscan-prefix-map=%t/src=/^src \
+// RUN:   -cc1 -triple x86_64-apple-macos12 -fcas-path %t/cas -fdepscan-prefix-map %t/src /^src \
 // RUN:     -emit-obj %t/src/main.c -o %t/out/output.o -I %t/src/inc -Wunknown-pragmas
 
 // Compare diagnostics after a miss.
@@ -42,7 +42,7 @@
 // RUN: %clang_cc1 -triple x86_64-apple-macos12 -fsyntax-only %t/src2/main.c -I %t/src2/inc -Wunknown-pragmas 2> %t/regular-diags2.txt
 
 // RUN: %clang -cc1depscan -fdepscan=inline -fdepscan-include-tree -o %t/t2.rsp -cc1-args \
-// RUN:   -cc1 -triple x86_64-apple-macos12 -fcas-path %t/cas -fdepscan-prefix-map=%t/src2=/^src \
+// RUN:   -cc1 -triple x86_64-apple-macos12 -fcas-path %t/cas -fdepscan-prefix-map %t/src2 /^src \
 // RUN:     -emit-obj %t/src2/main.c -o %t/out2/output.o -I %t/src2/inc -Wunknown-pragmas
 // RUN: %clang @%t/t2.rsp -Rcompile-job-cache 2> %t/diags-hit2.txt
 
@@ -55,7 +55,7 @@
 // RUN: diff -u %t/regular-diags2.txt %t/cached-diags2.txt
 
 // RUN: %clang -cc1depscan -fdepscan=inline -fdepscan-include-tree -o %t/terr.rsp -cc1-args \
-// RUN:   -cc1 -triple x86_64-apple-macos12 -fcas-path %t/cas -fdepscan-prefix-map=%t/src=/^src \
+// RUN:   -cc1 -triple x86_64-apple-macos12 -fcas-path %t/cas -fdepscan-prefix-map %t/src /^src \
 // RUN:     -emit-obj %t/src/main.c -o %t/out/output.o -I %t/src/inc -Rcompile-job-cache -DERROR
 
 // RUN: not %clang @%t/terr.rsp -ferror-limit 1 2> %t/diags_error1.txt

clang/test/CAS/depscan-prefix-map.c

@@ -12,11 +12,11 @@
 // RUN:              -internal-iframework %S/Inputs/SDK/Library/Frameworks \
 // RUN:              -working-directory %t.d                              \
 // RUN:              -fcas-path %t.d/cas                                  \
-// RUN:              -fdepscan-prefix-map=%S=/^source                     \
-// RUN:              -fdepscan-prefix-map=%t.d=/^testdir                  \
-// RUN:              -fdepscan-prefix-map=%{objroot}=/^objroot            \
-// RUN:              -fdepscan-prefix-map=%S/Inputs/toolchain_dir=/^toolchain \
-// RUN:              -fdepscan-prefix-map=%S/Inputs/SDK=/^sdk             \
+// RUN:              -fdepscan-prefix-map %S /^source                     \
+// RUN:              -fdepscan-prefix-map %t.d /^testdir                  \
+// RUN:              -fdepscan-prefix-map %{objroot} /^objroot            \
+// RUN:              -fdepscan-prefix-map %S/Inputs/toolchain_dir /^toolchain \
+// RUN:              -fdepscan-prefix-map %S/Inputs/SDK /^sdk             \
 // RUN:              -fdepfile-entry=%t.d/extra                           \
 // RUN: | FileCheck %s -DPREFIX=%t.d
 // RUN: %clang -cc1depscan -dump-depscan-tree=%t.root -fdepscan=inline    \
@@ -27,11 +27,11 @@
 // RUN:              -internal-iframework %S/Inputs/SDK/Library/Frameworks \
 // RUN:              -working-directory %t.d                              \
 // RUN:              -fcas-path %t.d/cas                                  \
-// RUN:              -fdepscan-prefix-map=%S=/^source                     \
-// RUN:              -fdepscan-prefix-map=%t.d=/^testdir                  \
-// RUN:              -fdepscan-prefix-map=%{objroot}=/^objroot            \
-// RUN:              -fdepscan-prefix-map=%S/Inputs/toolchain_dir=/^toolchain \
-// RUN:              -fdepscan-prefix-map=%S/Inputs/SDK=/^sdk             \
+// RUN:              -fdepscan-prefix-map %S /^source                     \
+// RUN:              -fdepscan-prefix-map %t.d /^testdir                  \
+// RUN:              -fdepscan-prefix-map %{objroot} /^objroot            \
+// RUN:              -fdepscan-prefix-map %S/Inputs/toolchain_dir /^toolchain \
+// RUN:              -fdepscan-prefix-map %S/Inputs/SDK /^sdk             \
 // RUN:              -fdepfile-entry=%t.d/extra                           \
 // RUN: | FileCheck %s -DPREFIX=%t.d
 // RUN: %clang -cc1depscand -execute %{clang-daemon-dir}/%basename_t      \
@@ -45,11 +45,11 @@
 // RUN:              -internal-iframework %S/Inputs/SDK/Library/Frameworks \
 // RUN:              -working-directory %t.d                              \
 // RUN:              -fcas-path %t.d/cas                                  \
-// RUN:              -fdepscan-prefix-map=%S=/^source                     \
-// RUN:              -fdepscan-prefix-map=%t.d=/^testdir                  \
-// RUN:              -fdepscan-prefix-map=%{objroot}=/^objroot            \
-// RUN:              -fdepscan-prefix-map=%S/Inputs/toolchain_dir=/^toolchain \
-// RUN:              -fdepscan-prefix-map=%S/Inputs/SDK=/^sdk             \
+// RUN:              -fdepscan-prefix-map %S /^source                     \
+// RUN:              -fdepscan-prefix-map %t.d /^testdir                  \
+// RUN:              -fdepscan-prefix-map %{objroot} /^objroot            \
+// RUN:              -fdepscan-prefix-map %S/Inputs/toolchain_dir /^toolchain \
+// RUN:              -fdepscan-prefix-map %S/Inputs/SDK /^sdk             \
 // RUN:              -fdepfile-entry=%t.d/extra                           \
 // RUN: | FileCheck %s -DPREFIX=%t.d
 //