Repurpose DriverArgs to MacroDefines

vhscampos · vhscampos · commit aa46b7b15d63 · 2025-01-14T11:29:31.000Z
diff --git a/clang/include/clang/Driver/Multilib.h b/clang/include/clang/Driver/Multilib.h
@@ -169,10 +169,10 @@ class MultilibSet {
   const_iterator end() const { return Multilibs.end(); }
 
   /// Process custom flags from \p Flags and returns an expanded flags list and
-  /// a list of extra compilation arguments.
+  /// a list of macro defines.
   /// Returns a pair where:
   ///  - first: the new flags list including custom flags after processing.
-  ///  - second: the extra compilation arguments to be fed to the driver.
+  ///  - second: the extra macro defines to be fed to the driver.
   std::pair<Multilib::flags_list, SmallVector<StringRef>>
   processCustomFlags(const Driver &D, const Multilib::flags_list &Flags) const;
 
diff --git a/clang/include/clang/Driver/ToolChain.h b/clang/include/clang/Driver/ToolChain.h
@@ -686,10 +686,10 @@ class ToolChain {
   /// Add warning options that need to be passed to cc1 for this target.
   virtual void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const;
 
-  // Get the list of extra driver arguments strings requested by the multilib
+  // Get the list of extra macro defines requested by the multilib
   // configuration.
   virtual SmallVector<std::string>
-  getMultilibDriverArgsStr(llvm::opt::ArgList &Args) const {
+  getMultilibMacroDefinesStr(llvm::opt::ArgList &Args) const {
     return {};
   };
 
diff --git a/clang/lib/Driver/Driver.cpp b/clang/lib/Driver/Driver.cpp
@@ -1398,9 +1398,7 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
   bool HasConfigFileTail = !ContainsError && CfgOptionsTail;
 
   // All arguments, from both config file and command line.
-  auto UArgs = std::make_unique<InputArgList>(
-      HasConfigFileHead ? std::move(*CfgOptionsHead) : std::move(*CLOptions));
-  InputArgList &Args = *UArgs;
+  InputArgList Args = HasConfigFileHead ? std::move(*CfgOptionsHead) : std::move(*CLOptions);
 
   if (HasConfigFileHead)
     for (auto *Opt : *CLOptions)
@@ -1428,6 +1426,52 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
     }
   }
 
+  // Check for working directory option before accessing any files
+  if (Arg *WD = Args.getLastArg(options::OPT_working_directory))
+    if (VFS->setCurrentWorkingDirectory(WD->getValue()))
+      Diag(diag::err_drv_unable_to_set_working_directory) << WD->getValue();
+
+  // Check for missing include directories.
+  if (!Diags.isIgnored(diag::warn_missing_include_dirs, SourceLocation())) {
+    for (auto IncludeDir : Args.getAllArgValues(options::OPT_I_Group)) {
+      if (!VFS->exists(IncludeDir))
+        Diag(diag::warn_missing_include_dirs) << IncludeDir;
+    }
+  }
+
+  // FIXME: This stuff needs to go into the Compilation, not the driver.
+  bool CCCPrintPhases;
+
+  // -canonical-prefixes, -no-canonical-prefixes are used very early in main.
+  Args.ClaimAllArgs(options::OPT_canonical_prefixes);
+  Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
+
+  // f(no-)integated-cc1 is also used very early in main.
+  Args.ClaimAllArgs(options::OPT_fintegrated_cc1);
+  Args.ClaimAllArgs(options::OPT_fno_integrated_cc1);
+
+  // Ignore -pipe.
+  Args.ClaimAllArgs(options::OPT_pipe);
+
+  // Extract -ccc args.
+  //
+  // FIXME: We need to figure out where this behavior should live. Most of it
+  // should be outside in the client; the parts that aren't should have proper
+  // options, either by introducing new ones or by overloading gcc ones like -V
+  // or -b.
+  CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
+  CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
+  if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
+    CCCGenericGCCName = A->getValue();
+
+  // Process -fproc-stat-report options.
+  if (const Arg *A = Args.getLastArg(options::OPT_fproc_stat_report_EQ)) {
+    CCPrintProcessStats = true;
+    CCPrintStatReportFilename = A->getValue();
+  }
+  if (Args.hasArg(options::OPT_fproc_stat_report))
+    CCPrintProcessStats = true;
+
   // FIXME: TargetTriple is used by the target-prefixed calls to as/ld
   // and getToolChain is const.
   if (IsCLMode()) {
@@ -1485,79 +1529,6 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
     TargetTriple = A->getValue();
   if (const Arg *A = Args.getLastArg(options::OPT_ccc_install_dir))
     Dir = Dir = A->getValue();
-  if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
-    SysRoot = A->getValue();
-  if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
-    ResourceDir = A->getValue();
-  if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
-    DyldPrefix = A->getValue();
-
-  setLTOMode(Args);
-
-  // Owned by the host.
-  const ToolChain &TC =
-      getToolChain(Args, computeTargetTriple(*this, TargetTriple, Args));
-
-  SmallVector<std::string> MultilibDriverArgsStr =
-      TC.getMultilibDriverArgsStr(Args);
-  SmallVector<const char *> MLArgsChar(
-      llvm::map_range(MultilibDriverArgsStr, [&Args](const auto &S) {
-        return Args.MakeArgString(S);
-      }));
-  bool MLContainsError;
-  auto MultilibDriverArgList = std::make_unique<InputArgList>(
-      ParseArgStrings(MLArgsChar, /*UseDriverMode=*/false, MLContainsError));
-  if (!MLContainsError)
-    for (auto *Opt : *MultilibDriverArgList) {
-      appendOneArg(Args, Opt, nullptr);
-    }
-
-  // Check for working directory option before accessing any files
-  if (Arg *WD = Args.getLastArg(options::OPT_working_directory))
-    if (VFS->setCurrentWorkingDirectory(WD->getValue()))
-      Diag(diag::err_drv_unable_to_set_working_directory) << WD->getValue();
-
-  // Check for missing include directories.
-  if (!Diags.isIgnored(diag::warn_missing_include_dirs, SourceLocation())) {
-    for (auto IncludeDir : Args.getAllArgValues(options::OPT_I_Group)) {
-      if (!VFS->exists(IncludeDir))
-        Diag(diag::warn_missing_include_dirs) << IncludeDir;
-    }
-  }
-
-  // FIXME: This stuff needs to go into the Compilation, not the driver.
-  bool CCCPrintPhases;
-
-  // -canonical-prefixes, -no-canonical-prefixes are used very early in main.
-  Args.ClaimAllArgs(options::OPT_canonical_prefixes);
-  Args.ClaimAllArgs(options::OPT_no_canonical_prefixes);
-
-  // f(no-)integated-cc1 is also used very early in main.
-  Args.ClaimAllArgs(options::OPT_fintegrated_cc1);
-  Args.ClaimAllArgs(options::OPT_fno_integrated_cc1);
-
-  // Ignore -pipe.
-  Args.ClaimAllArgs(options::OPT_pipe);
-
-  // Extract -ccc args.
-  //
-  // FIXME: We need to figure out where this behavior should live. Most of it
-  // should be outside in the client; the parts that aren't should have proper
-  // options, either by introducing new ones or by overloading gcc ones like -V
-  // or -b.
-  CCCPrintPhases = Args.hasArg(options::OPT_ccc_print_phases);
-  CCCPrintBindings = Args.hasArg(options::OPT_ccc_print_bindings);
-  if (const Arg *A = Args.getLastArg(options::OPT_ccc_gcc_name))
-    CCCGenericGCCName = A->getValue();
-
-  // Process -fproc-stat-report options.
-  if (const Arg *A = Args.getLastArg(options::OPT_fproc_stat_report_EQ)) {
-    CCPrintProcessStats = true;
-    CCPrintStatReportFilename = A->getValue();
-  }
-  if (Args.hasArg(options::OPT_fproc_stat_report))
-    CCPrintProcessStats = true;
-
   for (const Arg *A : Args.filtered(options::OPT_B)) {
     A->claim();
     PrefixDirs.push_back(A->getValue(0));
@@ -1572,6 +1543,13 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
       CompilerPath = Split.second;
     }
   }
+  if (const Arg *A = Args.getLastArg(options::OPT__sysroot_EQ))
+    SysRoot = A->getValue();
+  if (const Arg *A = Args.getLastArg(options::OPT__dyld_prefix_EQ))
+    DyldPrefix = A->getValue();
+
+  if (const Arg *A = Args.getLastArg(options::OPT_resource_dir))
+    ResourceDir = A->getValue();
 
   if (const Arg *A = Args.getLastArg(options::OPT_save_temps_EQ)) {
     SaveTemps = llvm::StringSwitch<SaveTempsMode>(A->getValue())
@@ -1591,6 +1569,8 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
       Offload = OffloadHostDevice;
   }
 
+  setLTOMode(Args);
+
   // Process -fembed-bitcode= flags.
   if (Arg *A = Args.getLastArg(options::OPT_fembed_bitcode_EQ)) {
     StringRef Name = A->getValue();
@@ -1644,6 +1624,31 @@ Compilation *Driver::BuildCompilation(ArrayRef<const char *> ArgList) {
     }
   }
 
+  std::unique_ptr<llvm::opt::InputArgList> UArgs =
+      std::make_unique<InputArgList>(std::move(Args));
+
+  // Owned by the host.
+  const ToolChain &TC =
+      getToolChain(*UArgs, computeTargetTriple(*this, TargetTriple, *UArgs));
+
+  {
+    SmallVector<std::string> MultilibMacroDefinesStr =
+        TC.getMultilibMacroDefinesStr(*UArgs);
+    SmallVector<const char *> MLMacroDefinesChar(
+        llvm::map_range(MultilibMacroDefinesStr, [&UArgs](const auto &S) {
+          return UArgs->MakeArgString(Twine("-D") + Twine(S));
+        }));
+    bool MLContainsError;
+    auto MultilibMacroDefineList =
+        std::make_unique<InputArgList>(ParseArgStrings(
+            MLMacroDefinesChar, /*UseDriverMode=*/false, MLContainsError));
+    if (!MLContainsError) {
+      for (auto *Opt : *MultilibMacroDefineList) {
+        appendOneArg(*UArgs, Opt);
+      }
+    }
+  }
+
   // Perform the default argument translations.
   DerivedArgList *TranslatedArgs = TranslateInputArgs(*UArgs);
 
diff --git a/clang/lib/Driver/Multilib.cpp b/clang/lib/Driver/Multilib.cpp
@@ -154,7 +154,7 @@ std::pair<Multilib::flags_list, SmallVector<StringRef>>
 MultilibSet::processCustomFlags(const Driver &D,
                                 const Multilib::flags_list &Flags) const {
   Multilib::flags_list Result;
-  SmallVector<StringRef> CompilationArgs;
+  SmallVector<StringRef> MacroDefines;
 
   // Custom flag values detected in the flags list
   SmallVector<const custom_flag::ValueDetail *> ClaimedCustomFlagValues;
@@ -193,9 +193,9 @@ MultilibSet::processCustomFlags(const Driver &D,
     if (!TriggeredCustomFlagDecls.insert(CustomFlagValue->Decl).second)
       continue;
     Result.push_back(std::string(custom_flag::Prefix) + CustomFlagValue->Name);
-    if (CustomFlagValue->DriverArgs)
-      CompilationArgs.append(CustomFlagValue->DriverArgs->begin(),
-                             CustomFlagValue->DriverArgs->end());
+    if (CustomFlagValue->MacroDefines)
+      MacroDefines.append(CustomFlagValue->MacroDefines->begin(),
+                          CustomFlagValue->MacroDefines->end());
   }
 
   // Detect flag declarations with no value passed in. Select default value.
@@ -205,28 +205,28 @@ MultilibSet::processCustomFlags(const Driver &D,
     custom_flag::ValueDetail &CustomFlagValue =
         Decl->ValueList[*Decl->DefaultValueIdx];
     Result.push_back(std::string(custom_flag::Prefix) + CustomFlagValue.Name);
-    if (CustomFlagValue.DriverArgs)
-      CompilationArgs.append(CustomFlagValue.DriverArgs->begin(),
-                             CustomFlagValue.DriverArgs->end());
+    if (CustomFlagValue.MacroDefines)
+      MacroDefines.append(CustomFlagValue.MacroDefines->begin(),
+                          CustomFlagValue.MacroDefines->end());
   }
 
   DiagnoseUnclaimedMultilibCustomFlags(D, UnclaimedCustomFlagValueStrs,
                                        CustomFlagDecls);
 
-  return {Result, CompilationArgs};
+  return {Result, MacroDefines};
 }
 
 bool MultilibSet::select(
     const Driver &D, const Multilib::flags_list &Flags,
     llvm::SmallVectorImpl<Multilib> &Selected,
-    llvm::SmallVector<StringRef> *CustomFlagCompilationArgs) const {
-  auto [FlagsWithCustom, CFCompilationArgs] = processCustomFlags(D, Flags);
+    llvm::SmallVector<StringRef> *CustomFlagMacroDefines) const {
+  auto [FlagsWithCustom, CFMacroDefines] = processCustomFlags(D, Flags);
   llvm::StringSet<> FlagSet(expandFlags(FlagsWithCustom));
   Selected.clear();
   bool AnyErrors = false;
 
-  if (CustomFlagCompilationArgs)
-    *CustomFlagCompilationArgs = std::move(CFCompilationArgs);
+  if (CustomFlagMacroDefines)
+    *CustomFlagMacroDefines = std::move(CFMacroDefines);
 
   // Decide which multilibs we're going to select at all.
   llvm::DenseSet<StringRef> ExclusiveGroupsSelected;
diff --git a/clang/lib/Driver/ToolChains/BareMetal.cpp b/clang/lib/Driver/ToolChains/BareMetal.cpp
@@ -166,7 +166,7 @@ static void
 findMultilibsFromYAML(const ToolChain &TC, const Driver &D,
                       StringRef MultilibPath, const ArgList &Args,
                       DetectedMultilibs &Result,
-                      SmallVector<StringRef> &CustomFlagsCompilationArgs) {
+                      SmallVector<StringRef> &CustomFlagsMacroDefines) {
   llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MB =
       D.getVFS().getBufferForFile(MultilibPath);
   if (!MB)
@@ -178,7 +178,7 @@ findMultilibsFromYAML(const ToolChain &TC, const Driver &D,
     return;
   Result.Multilibs = ErrorOrMultilibSet.get();
   if (Result.Multilibs.select(D, Flags, Result.SelectedMultilibs,
-                              &CustomFlagsCompilationArgs))
+                              &CustomFlagsMacroDefines))
     return;
   D.Diag(clang::diag::warn_drv_missing_multilib) << llvm::join(Flags, " ");
   std::stringstream ss;
@@ -237,13 +237,13 @@ void BareMetal::findMultilibs(const Driver &D, const llvm::Triple &Triple,
     // If multilib.yaml is found, update sysroot so it doesn't use a target
     // specific suffix
     SysRoot = computeBaseSysRoot(D, /*IncludeTriple=*/false);
-    SmallVector<StringRef> CustomFlagDriverArgs;
+    SmallVector<StringRef> CustomFlagMacroDefines;
     findMultilibsFromYAML(*this, D, *MultilibPath, Args, Result,
-                          CustomFlagDriverArgs);
+                          CustomFlagMacroDefines);
     SelectedMultilibs = Result.SelectedMultilibs;
     Multilibs = Result.Multilibs;
-    MultilibDriverArgs.append(CustomFlagDriverArgs.begin(),
-                              CustomFlagDriverArgs.end());
+    MultilibMacroDefines.append(CustomFlagMacroDefines.begin(),
+                                CustomFlagMacroDefines.end());
   } else if (isRISCVBareMetal(Triple)) {
     if (findRISCVMultilibs(D, Triple, Args, Result)) {
       SelectedMultilibs = Result.SelectedMultilibs;
@@ -560,6 +560,6 @@ SanitizerMask BareMetal::getSupportedSanitizers() const {
 }
 
 SmallVector<std::string>
-BareMetal::getMultilibDriverArgsStr(llvm::opt::ArgList &Args) const {
-  return MultilibDriverArgs;
-}
+BareMetal::getMultilibMacroDefinesStr(llvm::opt::ArgList &Args) const {
+  return MultilibMacroDefines;
+}
diff --git a/clang/lib/Driver/ToolChains/BareMetal.h b/clang/lib/Driver/ToolChains/BareMetal.h
@@ -71,7 +71,7 @@ class LLVM_LIBRARY_VISIBILITY BareMetal : public ToolChain {
   SanitizerMask getSupportedSanitizers() const override;
 
   SmallVector<std::string>
-  getMultilibDriverArgsStr(llvm::opt::ArgList &Args) const override;
+  getMultilibMacroDefinesStr(llvm::opt::ArgList &Args) const override;
 
 private:
   using OrderedMultilibs =
@@ -80,7 +80,7 @@ class LLVM_LIBRARY_VISIBILITY BareMetal : public ToolChain {
 
   std::string SysRoot;
 
-  SmallVector<std::string> MultilibDriverArgs;
+  SmallVector<std::string> MultilibMacroDefines;
 };
 
 } // namespace toolchains
diff --git a/clang/test/Driver/baremetal-multilib-custom-flags.yaml b/clang/test/Driver/baremetal-multilib-custom-flags.yaml
@@ -37,17 +37,17 @@
 # CHECK-PRINT-MULTI-LIB: arm-none-eabi/multithreaded/thumb/v8-m.main/nofp;@-target=thumbv8m.main-unknown-none-eabi@mfpu=none@fmultilib-flag=multithreaded
 
 # RUN: %clang --target=arm-none-eabi --multi-lib-config=%s -x c %s -fmultilib-flag=no-multithreaded -### -o /dev/null 2>&1 \
-# RUN: | FileCheck --check-prefix=CHECK-DRIVERARGS-NOMULTI %s
-# CHECK-DRIVERARGS-NOMULTI:        "-D" "__SINGLE_THREAD__"
+# RUN: | FileCheck --check-prefix=CHECK-MACRODEFINES-NOMULTI %s
+# CHECK-MACRODEFINES-NOMULTI:        "-D" "__SINGLE_THREAD__"
 
 # RUN: %clang --target=arm-none-eabi --multi-lib-config=%s -x c %s -fmultilib-flag=io-semihosting -### -o /dev/null 2>&1 \
-# RUN: | FileCheck --check-prefix=CHECK-DRIVERARGS-IO-SEMIHOSTING %s
-# CHECK-DRIVERARGS-IO-SEMIHOSTING: "-D" "SEMIHOSTING"
+# RUN: | FileCheck --check-prefix=CHECK-MACRODEFINES-IO-SEMIHOSTING %s
+# CHECK-MACRODEFINES-IO-SEMIHOSTING: "-D" "SEMIHOSTING"
 
 # RUN: %clang --target=arm-none-eabi --multi-lib-config=%s -x c %s -fmultilib-flag=io-linux-syscalls -### -o /dev/null 2>&1 \
-# RUN: | FileCheck --check-prefix=CHECK-DRIVERARGS-IO-LINUX %s
-# CHECK-DRIVERARGS-IO-LINUX:       "-U" "SEMIHOSTING"
-# CHECK-DRIVERARGS-IO-LINUX-SAME:  "-D" "LINUX_SYSCALLS"
+# RUN: | FileCheck --check-prefix=CHECK-MACRODEFINES-IO-LINUX %s
+# CHECK-MACRODEFINES-IO-LINUX:  "-D" "LINUX_SYSCALLS"
+# CHECK-MACRODEFINES-IO-LINUX-SAME:  "-D" "HOSTED"
 
 ---
 MultilibVersion: 1.0
@@ -68,14 +68,14 @@ Flags:
   - Name: multithreading
     Values:
     - Name: no-multithreaded
-      DriverArgs: [-D__SINGLE_THREAD__]
+      MacroDefines: [__SINGLE_THREAD__]
     - Name: multithreaded
     Default: no-multithreaded
   - Name: io
     Values:
     - Name: io-none
     - Name: io-semihosting
-      DriverArgs: [-DSEMIHOSTING]
+      MacroDefines: [SEMIHOSTING]
     - Name: io-linux-syscalls
-      DriverArgs: [-USEMIHOSTING, -DLINUX_SYSCALLS]
+      MacroDefines: [LINUX_SYSCALLS, HOSTED]
     Default: io-none
