[Driver][NFC][FPGA] Remove FPGA archive support (#17788)

Remove the specific FPGA support in the driver and tools that are
associated with FPGA archives. These archives provided an intermediate
representation of binaries used for FPGA targets.

Creation of these archives were accomplished by using the
-fsycl-link=early and -fsycl-link=image options along with the
-fintelfpga enabling option.

This is simply a step towards full removal of FPGA support in the
compiler driver and clang-offload-bundler.

Author: mdtoguchi

clang/include/clang/Driver/Types.def

@@ -125,12 +125,7 @@ TYPE("tempfiletable",            Tempfiletable,INVALID,         "table",  phases
 TYPE("tempAOCOfilelist",         TempAOCOfilelist, INVALID,     "txt",    phases::Compile, phases::Backend, phases::Assemble, phases::Link)
 TYPE("archive",                  Archive,      INVALID,         "a",      phases::Compile, phases::Backend, phases::Assemble, phases::Link)
 TYPE("wholearchive",             WholeArchive, INVALID,         "a",      phases::Compile, phases::Backend, phases::Assemble, phases::Link)
-TYPE("fpga_aocx",                FPGA_AOCX,    INVALID,         "aocx",   phases::Compile, phases::Backend, phases::Assemble, phases::Link)
-TYPE("fpga_aocr",                FPGA_AOCR,    INVALID,         "aocr",   phases::Compile, phases::Backend, phases::Assemble, phases::Link)
-TYPE("fpga_aocr_emu",            FPGA_AOCR_EMU, INVALID,        "aocr",   phases::Compile, phases::Backend, phases::Assemble, phases::Link)
-TYPE("fpga_aoco",                FPGA_AOCO,    INVALID,         "aoco",   phases::Compile, phases::Backend, phases::Assemble, phases::Link)
 TYPE("fpga_dep",                 FPGA_Dependencies, INVALID,    "d",      phases::Compile, phases::Backend, phases::Assemble, phases::Link)
-TYPE("fpga_dep_list",            FPGA_Dependencies_List, INVALID, "txt",  phases::Compile, phases::Backend, phases::Assemble, phases::Link)
 TYPE("host_dep_image",           Host_Dependencies_Image, INVALID, "out", phases::Compile, phases::Backend, phases::Assemble, phases::Link)
 TYPE("api-information",          API_INFO,     INVALID,         "json",   phases::Precompile)
 TYPE("dx-container",             DX_CONTAINER, INVALID,         "dxo",    phases::Compile, phases::Backend)

clang/include/clang/Driver/Types.h

@@ -89,9 +89,6 @@ namespace types {
   /// isHIP - Is this a HIP input.
   bool isHIP(ID Id);
 
-  /// isFPGA - Is this FPGA input.
-  bool isFPGA(ID Id);
-
   /// isArchive - Is this an archive input.
   bool isArchive(ID Id);
 

clang/lib/Driver/Compilation.cpp

@@ -225,8 +225,7 @@ bool Compilation::CleanupFileList(const TempFileList &Files,
     // Temporary file lists contain files that need to be cleaned. The
     // file containing the information is also removed
     if (File.second == types::TY_Tempfilelist ||
-        File.second == types::TY_Tempfiletable ||
-        File.second == types::TY_FPGA_Dependencies_List) {
+        File.second == types::TY_Tempfiletable) {
       // These are temporary files and need to be removed.
       bool IsTable = File.second == types::TY_Tempfiletable;
 

clang/lib/Driver/Driver.cpp

@@ -1146,12 +1146,11 @@ class ArchiveFileHandler final : public FileHandler {
     Object,   // Output is a single object file
     Archive   // Output is an archive with extracted objects
   };
-  const OutputType Mode =
-      StringSwitch<OutputType>(BundlerConfig.FilesType)
-          .Cases("aoo", "aocx", "aocr", OutputType::FileList)
-          .Case("ao", OutputType::Object)
-          .Case("a", OutputType::Archive)
-          .Default(OutputType::Unknown);
+  const OutputType Mode = StringSwitch<OutputType>(BundlerConfig.FilesType)
+                              .Case("aoo", OutputType::FileList)
+                              .Case("ao", OutputType::Object)
+                              .Case("a", OutputType::Archive)
+                              .Default(OutputType::Unknown);
 
   // Set contains indexes of Children that should be skipped during
   // unbundling.
@@ -1274,9 +1273,6 @@ class ArchiveFileHandler final : public FileHandler {
       std::unique_ptr<FileHandler> FH{nullptr};
       std::unique_ptr<MemoryBuffer> Buf{nullptr};
       StringRef Ext("o");
-      if (BundlerConfig.FilesType == "aocr" ||
-          BundlerConfig.FilesType == "aocx")
-        Ext = BundlerConfig.FilesType;
 
       auto BinOrErr = C.getAsBinary();
       if (!BinOrErr) {
@@ -1475,8 +1471,7 @@ CreateObjectFileHandler(MemoryBuffer &FirstInput,
 }
 
 static bool FilesTypeIsArchiveToList(const std::string& FilesType) {
-  return FilesType == "ao" || FilesType == "aoo" || FilesType == "aocr" ||
-         FilesType == "aocx";
+  return FilesType == "ao" || FilesType == "aoo";
 }
 
 static bool FilesTypeIsArchive(const std::string& FilesType) {

clang/lib/Driver/OffloadBundler.cpp

@@ -9905,26 +9905,6 @@ void OffloadBundler::ConstructJob(Compilation &C, const JobAction &JA,
     const ToolChain *CurTC = &getToolChain();
     const Action *CurDep = JA.getInputs()[I];
 
-    // Special handling for FPGA AOC[RX] binaries that are bundled prior to
-    // being added to the generated archive.
-    llvm::Triple Triple = CurTC->getTriple();
-    bool IsFPGA = Triple.isSPIR() &&
-                  Triple.getSubArch() == llvm::Triple::SPIRSubArch_fpga;
-    Arg *A = TCArgs.getLastArg(options::OPT_fsycl_link_EQ);
-    if (A && IsFPGA) {
-      bool IsFPGAImage = false;
-      IsFPGAImage = A->getValue() == StringRef("image");
-      if (Inputs.size() == 1) {
-        Triples += Action::GetOffloadKindName(CurKind);
-        Triples += "-fpga_";
-        Triples += IsFPGAImage ? "aocx" : "aocr";
-        if (!IsFPGAImage && !C.getDriver().IsFPGAHWMode())
-          Triples += "_emu";
-        Triples += "-intel-unknown";
-        continue;
-      }
-    }
-
     if (const auto *OA = dyn_cast<OffloadAction>(CurDep)) {
       CurTC = nullptr;
       OA->doOnEachDependence([&](Action *A, const ToolChain *TC, const char *) {
@@ -10073,112 +10053,43 @@ void OffloadBundler::ConstructJobMultipleOutputs(
   const char *InputFileName = Input.getFilename();
   types::ID InputType(Input.getType());
   bool IsFPGADepUnbundle = JA.getType() == types::TY_FPGA_Dependencies;
-  bool IsFPGADepLibUnbundle = JA.getType() == types::TY_FPGA_Dependencies_List;
   InputInfoList ForeachInputs;
   if (InputType == types::TY_Tempfilelist)
     ForeachInputs.push_back(Input);
-
-  if (InputType == types::TY_FPGA_AOCX || InputType == types::TY_FPGA_AOCR ||
-      InputType == types::TY_FPGA_AOCR_EMU) {
-    // Override type with AOCX/AOCR which will unbundle to a list containing
-    // binaries with the appropriate extension (.aocx/.aocr)
-    // TODO - representation of the output file from the unbundle for these
-    // types (aocx/aocr) are always list files.  We should represent this
-    // better in the output extension and type for improved understanding
-    // of file contents and debuggability.
-    TypeArg = (InputType == types::TY_FPGA_AOCX) ? "aocx" : "aocr";
-    // When the output is a Tempfilelist, we know we are unbundling
-    // the .bc files from the archive.
-    if (!getToolChain().getTriple().isSPIROrSPIRV() ||
-        JA.getType() == types::TY_Tempfilelist)
-      TypeArg = "aoo";
-  }
-  if (InputType == types::TY_FPGA_AOCO || IsFPGADepLibUnbundle)
-    TypeArg = "aoo";
   if (IsFPGADepUnbundle)
     TypeArg = "o";
 
   bool HasSPIRTarget = false;
-  bool HasFPGATarget = false;
   auto SYCLTCRange = C.getOffloadToolChains<Action::OFK_SYCL>();
   for (auto TI = SYCLTCRange.first, TE = SYCLTCRange.second; TI != TE; ++TI) {
     llvm::Triple TT(TI->second->getTriple());
-    if (TT.isSPIROrSPIRV()) {
+    if (TT.isSPIROrSPIRV())
       HasSPIRTarget = true;
-      if (TT.getSubArch() == llvm::Triple::SPIRSubArch_fpga)
-        HasFPGATarget = true;
-    }
   }
   if (InputType == types::TY_Archive && HasSPIRTarget)
     TypeArg = "aoo";
 
   // Get the type.
   CmdArgs.push_back(TCArgs.MakeArgString(Twine("-type=") + TypeArg));
 
-  // For FPGA Archives that contain AOCO in them, we only want to unbundle
-  // the objects from the archive that do not have AOCO associated in that
-  // specific object.  Only do this when in hardware mode.
-  if (InputType == types::TY_Archive && HasFPGATarget && !IsFPGADepUnbundle &&
-      !IsFPGADepLibUnbundle && C.getDriver().IsFPGAHWMode()) {
-    llvm::Triple TT;
-    TT.setArchName(types::getTypeName(types::TY_FPGA_AOCO));
-    TT.setVendorName("intel");
-    TT.setOS(getToolChain().getTriple().getOS());
-    SmallString<128> ExcludedTargets("-excluded-targets=");
-    ExcludedTargets += "sycl-";
-    ExcludedTargets += TT.normalize();
-    CmdArgs.push_back(TCArgs.MakeArgString(ExcludedTargets));
-  }
-
   // Get the targets.
   SmallString<128> Triples;
   Triples += "-targets=";
   auto DepInfo = UA.getDependentActionsInfo();
   for (unsigned I = 0, J = 0; I < DepInfo.size(); ++I) {
     auto &Dep = DepInfo[I];
-    // FPGA device triples are 'transformed' for the bundler when creating
-    // aocx or aocr type bundles.  Also, we only do a specific target
-    // unbundling, skipping the host side or device side.
-    if (types::isFPGA(InputType) || InputType == types::TY_Tempfilelist) {
+    // We only do a specific target unbundling, skipping the host side or
+    // device side.
+    if (InputType == types::TY_Tempfilelist) {
       if (getToolChain().getTriple().isSPIROrSPIRV()) {
-        if (Dep.DependentToolChain->getTriple().getSubArch() ==
-            llvm::Triple::SPIRSubArch_fpga) {
-          StringRef TypeName(types::getTypeName(InputType));
-          types::ID Type = UA.getDependentType();
-          if (InputType == types::TY_Tempfilelist && Type != types::TY_Nothing)
-            TypeName = types::getTypeName(Type);
-          if (J++)
-            Triples += ',';
-          llvm::Triple TT;
-          TT.setArchName(TypeName);
-          TT.setVendorName("intel");
-          TT.setOS(getToolChain().getTriple().getOS());
-          if ((InputType == types::TY_FPGA_AOCX ||
-               InputType == types::TY_FPGA_AOCR ||
-               InputType == types::TY_FPGA_AOCR_EMU) &&
-              JA.getType() == types::TY_Tempfilelist)
-            // AOCX device and AOCR bc info is bundled in the host kind
-            Triples += "host-";
-          else
-            // AOCR device is bundled in the sycl kind
-            Triples += "sycl-";
-          Triples += TT.normalize();
-          continue;
-        } else if (Dep.DependentOffloadKind == Action::OFK_Host) {
-          // No host unbundle for FPGA binaries.
+        if (Dep.DependentOffloadKind == Action::OFK_Host)
           continue;
-        }
       } else if (Dep.DependentOffloadKind == Action::OFK_SYCL)
         continue;
-    } else if (InputType == types::TY_Archive ||
-               (getToolChain().getTriple().getSubArch() ==
-                    llvm::Triple::SPIRSubArch_fpga &&
-                TCArgs.hasArg(options::OPT_fsycl_link_EQ))) {
+    } else if (InputType == types::TY_Archive) {
       // Do not extract host part if we are unbundling archive on Windows
       // because it is not needed. Static offload libraries are added to the
-      // host link command just as normal libraries.  Do not extract the host
-      // part from FPGA -fsycl-link unbundles either, as the full obj
-      // is used in the final link
+      // host link command just as normal libraries.
       if (Dep.DependentOffloadKind == Action::OFK_Host)
         continue;
     }
@@ -10231,7 +10142,7 @@ void OffloadBundler::ConstructJobMultipleOutputs(
       Triples += GPUArchName.str();
     }
   }
-  if (IsFPGADepUnbundle || IsFPGADepLibUnbundle) {
+  if (IsFPGADepUnbundle) {
     // TODO - We are currently using the target triple inputs to slot a location
     // of the dependency information into the bundle.  It would be good to
     // separate this out to an explicit option in the bundler for the dependency
@@ -10259,7 +10170,7 @@ void OffloadBundler::ConstructJobMultipleOutputs(
   // When dealing with -fintelfpga, there is an additional unbundle step
   // that occurs for the dependency file.  In that case, do not use the
   // dependent information, but just the output file.
-  if (IsFPGADepUnbundle || IsFPGADepLibUnbundle) {
+  if (IsFPGADepUnbundle) {
     SmallString<128> UB;
     UB += "-output=";
     UB += Outputs[0].getFilename();
@@ -10382,8 +10293,6 @@ void OffloadWrapper::ConstructJob(Compilation &C, const JobAction &JA,
 
     llvm::Triple TT = getToolChain().getTriple();
     SmallString<128> TargetTripleOpt = TT.getArchName();
-    bool WrapFPGADevice = false;
-    bool FPGAEarly = false;
 
     // Validate and propogate CLI options related to device image compression.
     // -offload-compress
@@ -10397,32 +10306,9 @@ void OffloadWrapper::ConstructJob(Compilation &C, const JobAction &JA,
             Twine("-offload-compression-level=") + A->getValue()));
     }
 
-    if (Arg *A = C.getInputArgs().getLastArg(options::OPT_fsycl_link_EQ)) {
-      WrapFPGADevice = true;
-      FPGAEarly = (A->getValue() == StringRef("early"));
-      // When wrapping an FPGA aocx binary to archive, do not emit registration
-      // functions
-      if (A->getValue() == StringRef("image"))
-        WrapperArgs.push_back(C.getArgs().MakeArgString("--emit-reg-funcs=0"));
-    }
     addRunTimeWrapperOpts(C, OffloadingKind, TCArgs, WrapperArgs,
                           getToolChain(), JA);
 
-    // When wrapping an FPGA device binary, we need to be sure to apply the
-    // appropriate triple that corresponds (fpga_aocr-intel-<os>)
-    // to the target triple setting.
-    if (TT.getSubArch() == llvm::Triple::SPIRSubArch_fpga && WrapFPGADevice) {
-      SmallString<16> FPGAArch("fpga_");
-      if (FPGAEarly) {
-        FPGAArch += "aocr";
-        if (C.getDriver().IsFPGAEmulationMode())
-          FPGAArch += "_emu";
-      } else
-        FPGAArch += "aocx";
-      TT.setArchName(FPGAArch);
-      TT.setVendorName("intel");
-      TargetTripleOpt = TT.str();
-    }
     const toolchains::SYCLToolChain &TC =
               static_cast<const toolchains::SYCLToolChain &>(getToolChain());
     bool IsEmbeddedIR = cast<OffloadWrapperJobAction>(JA).isEmbeddedIR();
@@ -10449,18 +10335,6 @@ void OffloadWrapper::ConstructJob(Compilation &C, const JobAction &JA,
     WrapperArgs.push_back(
         C.getArgs().MakeArgString(Twine("-kind=") + Twine(Kind)));
 
-    // For FPGA toolchains, we can provide previously wrapped bc input files to
-    // the wrapper step.  This is done for AOCR based files that will need the
-    // Symbols and Properties from a previous compilation step.
-    if (TC.getTriple().isSPIR() && Inputs.size() == 2 &&
-        TC.getTriple().getSubArch() == llvm::Triple::SPIRSubArch_fpga) {
-      // If there is an additional input argument passed in, that is considered
-      // the .bc file to include in this wrapping job.
-      const InputInfo &I = Inputs[1];
-      WrapperArgs.push_back(C.getArgs().MakeArgString(
-          Twine("--sym-prop-bc-files=") + I.getFilename()));
-    }
-
     assert((Inputs.size() > 0) && "no inputs for clang-offload-wrapper");
     assert(((Inputs[0].getType() != types::TY_Tempfiletable) ||
             (Inputs.size() == 1)) &&

clang/lib/Driver/ToolChains/Clang.cpp

@@ -1167,9 +1167,7 @@ void SYCL::fpga::BackendCompiler::constructOpenCLAOTCommand(
   ArgStringList CmdArgs{"-device=fpga_fast_emu"};
 
   for (const auto &II : Inputs) {
-    if (II.getType() == types::TY_TempAOCOfilelist ||
-        II.getType() == types::TY_FPGA_Dependencies ||
-        II.getType() == types::TY_FPGA_Dependencies_List)
+    if (II.getType() == types::TY_FPGA_Dependencies)
       continue;
     if (II.getType() == types::TY_Tempfilelist)
       ForeachInputs.push_back(II);
@@ -1235,31 +1233,13 @@ void SYCL::fpga::BackendCompiler::ConstructJob(
     std::string Filename(II.getFilename());
     if (II.getType() == types::TY_Tempfilelist)
       ForeachInputs.push_back(II);
-    if (II.getType() == types::TY_TempAOCOfilelist)
-      // Add any FPGA library lists.  These come in as special tempfile lists.
-      CmdArgs.push_back(Args.MakeArgString(Twine("-library-list=") + Filename));
-    else if (II.getType() == types::TY_FPGA_Dependencies ||
-             II.getType() == types::TY_FPGA_Dependencies_List)
+    else if (II.getType() == types::TY_FPGA_Dependencies)
       FPGADepFiles.push_back(II);
     else
       CmdArgs.push_back(C.getArgs().MakeArgString(Filename));
-    // Check for any AOCR input, if found use that as the project report name
     StringRef Ext(llvm::sys::path::extension(Filename));
     if (Ext.empty())
       continue;
-    if (getToolChain().LookupTypeForExtension(Ext.drop_front()) ==
-        types::TY_FPGA_AOCR) {
-      // Keep the base of the .aocr file name.  Input file is a temporary,
-      // so we are stripping off the additional naming information for a
-      // cleaner name.  The suffix being stripped from the name is the
-      // added temporary string and the extension.
-      StringRef SuffixFormat("-XXXXXX.aocr");
-      SmallString<128> NameBase(
-          Filename.substr(0, Filename.length() - SuffixFormat.size()));
-      NameBase.append(".prj");
-      CreatedReportName =
-          Args.MakeArgString(llvm::sys::path::filename(NameBase));
-    }
   }
   CmdArgs.push_back("-sycl");
 
@@ -1309,8 +1289,6 @@ void SYCL::fpga::BackendCompiler::ConstructJob(
     for (unsigned I = 0; I < FPGADepFiles.size(); ++I) {
       if (I)
         DepOpt += ',';
-      if (FPGADepFiles[I].getType() == types::TY_FPGA_Dependencies_List)
-        DepOpt += "@";
       DepOpt += FPGADepFiles[I].getFilename();
     }
     CmdArgs.push_back(C.getArgs().MakeArgString(DepOpt));

clang/lib/Driver/ToolChains/SYCL.cpp

@@ -301,19 +301,6 @@ bool types::isHIP(ID Id) {
   }
 }
 
-bool types::isFPGA(ID Id) {
-  switch (Id) {
-  default:
-    return false;
-
-  case TY_FPGA_AOCR:
-  case TY_FPGA_AOCX:
-  case TY_FPGA_AOCO:
-  case TY_FPGA_AOCR_EMU:
-    return true;
-  }
-}
-
 bool types::isArchive(ID Id) {
   switch (Id) {
   default:
@@ -399,8 +386,6 @@ types::ID types::lookupTypeForExtension(llvm::StringRef Ext) {
       .Case("cppm", TY_CXXModule)
       .Case("cxxm", TY_CXXModule)
       .Case("hlsl", TY_HLSL)
-      .Case("aocr", TY_FPGA_AOCR)
-      .Case("aocx", TY_FPGA_AOCX)
       .Default(TY_INVALID);
 }
 

clang/lib/Driver/Types.cpp

@@ -120,13 +120,13 @@
 
 // Device section checking only occur when offloading is enabled
 // RUN:  %clangxx -### -target x86_64-unknown-linux-gnu -fsycl --no-offload-new-driver %S/Inputs/SYCL/liblin64.a %s 2>&1 \
-// RUN:    | FileCheck -check-prefix CHECK_SECTION %s
+// RUN:    | FileCheck -check-prefix CHECK_LIST %s
 // RUN:  %clangxx -### -target x86_64-unknown-linux-gnu -fsycl --no-offload-new-driver -L%S/Inputs/SYCL -l:liblin64.a %s 2>&1 \
-// RUN:    | FileCheck -check-prefix CHECK_SECTION %s
+// RUN:    | FileCheck -check-prefix CHECK_LIST %s
 // RUN:  %clangxx -### -target x86_64-unknown-linux-gnu %S/Inputs/SYCL/liblin64.a %s 2>&1 \
-// RUN:    | FileCheck -check-prefix NO_CHECK_SECTION %s
-// CHECK_SECTION: {{(/|\\)}}clang-offload-bundler{{.*}} "-type=ao"{{.*}} "-check-section"
-// NO_CHECK_SECTION-NOT: clang-offload-bundler{{.*}} "-type=ao"{{.*}} "-check-section"
+// RUN:    | FileCheck -check-prefix NO_CHECK_LIST %s
+// CHECK_LIST: {{(/|\\)}}clang-offload-bundler{{.*}} "-type=ao"{{.*}} "-list"
+// NO_CHECK_LIST-NOT: clang-offload-bundler{{.*}} "-type=ao"{{.*}} "-list"
 
 /// Check -fsycl-targets=spir64 enables addition of -ffine-grained-bitfield-accesses option
 // RUN:   %clangxx -### -fsycl-device-only %s 2>&1 | FileCheck -check-prefixes=CHECK_BITFIELD_OPTION %s