[clang-offload-bundler][NFC] Library-ize ClangOffloadBundler (4/4)

[lamb-j]

Summary

Lifting the core functionalities of the clang-offload-bundler into a
user-facing library/API.

This NFC patch (4/4) moves the API files from
clang/tools/clang-offload-bundler into clang/lib/Driver and
clang/include/clang/Driver.

[lamb-j]

Abandoned in favor of combined patch: https://reviews.llvm.org/D129873

clang/include/clang/Driver/OffloadBundler.h

-//===-- clang-offload-bundler/OffloadBundler.h ----------------------------===//
+//=== -OffloadBundler.h - File Bundling and Unbundling ----------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file defines a clang-offload-bundler library that bundles different
-/// files that relate with the same source code but different targets into a
-/// single one. Also the implements the opposite functionality, i.e. unbundle
-/// files previous created by this tool.
+/// This file defines an offload bundling API that bundles different files
+/// that relate with the same source code but different targets into a single
+/// one. Also the implements the opposite functionality, i.e. unbundle files
+/// previous created by this API.
 ///
 //===----------------------------------------------------------------------===//
 
-using namespace llvm;
-using namespace llvm::object;
+#ifndef LLVM_CLANG_DRIVER_OFFLOADBUNDLER_H
+#define LLVM_CLANG_DRIVER_OFFLOADBUNDLER_H
+
+#include "llvm/ADT/Triple.h"
+#include "llvm/Support/Error.h"
+#include <string>
+#include <vector>
 
 class Config {
 public:
   bool AllowNoHost = false;
   bool AllowMissingBundles = false;
   bool CheckInputArchive = false;
   bool PrintExternalCommands = false;
   bool HipOpenmpCompatible = false;

 
 class OffloadBundler {
 public:
   Config *BundlerConfig;
 
   // TODO: Add error checking from ClangOffloadBundler.cpp
   OffloadBundler(Config *BC) : BundlerConfig(BC) {}
 
-  Error BundleFiles();
-  Error UnbundleFiles();
-  Error UnbundleArchive();
+  llvm::Error BundleFiles();
+  llvm::Error UnbundleFiles();
+  llvm::Error UnbundleArchive();
 };
 
 /// Obtain the offload kind, real machine triple, and an optional GPUArch
 /// out of the target information specified by the user.
 /// Bundle Entry ID (or, Offload Target String) has following components:
 ///  * Offload Kind - Host, OpenMP, or HIP
 ///  * Triple - Standard LLVM Triple
 ///  * GPUArch (Optional) - Processor name, followed by set of ON/OFF features
 struct OffloadTargetInfo {
-  StringRef OffloadKind;
+  llvm::StringRef OffloadKind;
   llvm::Triple Triple;
-  StringRef GPUArch;
+  llvm::StringRef GPUArch;
   Config *BundlerConfig;
 
-  OffloadTargetInfo(const StringRef Target, Config *BC);
+  OffloadTargetInfo(const llvm::StringRef Target, Config *BC);
   bool hasHostKind() const;
   bool isOffloadKindValid() const;
-  bool isOffloadKindCompatible(const StringRef TargetOffloadKind) const;
+  bool isOffloadKindCompatible(const llvm::StringRef TargetOffloadKind) const;
   bool isTripleValid() const;
   bool operator==(const OffloadTargetInfo &Target) const;
   std::string str();
 };
 
 // List bundle IDs. Return true if an error was found.
-Error ListBundleIDsInFile(StringRef InputFileName, Config *BundlerConfig);
+llvm::Error ListBundleIDsInFile(llvm::StringRef InputFileName,
+                                Config *BundlerConfig);
+
+#endif // LLVM_CLANG_DRIVER_OFFLOADBUNDLER_H

clang/lib/Driver/CMakeLists.txt

 add_clang_library(clangDriver
   Action.cpp
   Compilation.cpp
   Distro.cpp
   Driver.cpp
   DriverOptions.cpp
   Job.cpp
   Multilib.cpp
+  OffloadBundler.cpp
   OptionUtils.cpp
   Phases.cpp
   SanitizerArgs.cpp
   Tool.cpp
   ToolChain.cpp
   ToolChains/Arch/AArch64.cpp
   ToolChains/Arch/ARM.cpp
   ToolChains/Arch/CSKY.cpp

clang/lib/Driver/OffloadBundler.cpp

-//===-- clang-offload-bundler/ClangOffloadBundler.cpp ---------------------===//
+//===- OffloadBundler.cpp - File Bundling and Unbundling ------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file implements a clang-offload-bundler that bundles different
-/// files that relate with the same source code but different targets into a
-/// single one. Also the implements the opposite functionality, i.e. unbundle
-/// files previous created by this tool.
+/// This file implements an offload bundling API that bundles different files
+/// that relate with the same source code but different targets into a single
+/// one. Also the implements the opposite functionality, i.e. unbundle files
+/// previous created by this API.
 ///
 //===----------------------------------------------------------------------===//
 
 #include "clang/Basic/Cuda.h"
 #include "clang/Basic/Version.h"
+#include "clang/Driver/OffloadBundler.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringMap.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/StringSwitch.h"
 #include "llvm/ADT/Triple.h"
 #include "llvm/Object/Archive.h"

 #include <cstdint>
 #include <forward_list>
 #include <memory>
 #include <set>
 #include <string>
 #include <system_error>
 #include <utility>
 
-#include "OffloadBundler.h"
-
 using namespace llvm;
 using namespace llvm::object;
 
 /// Magic string that marks the existence of offloading data.
 #define OFFLOAD_BUNDLER_MAGIC_STR "__CLANG_OFFLOAD_BUNDLE__"
 
 OffloadTargetInfo::OffloadTargetInfo(const StringRef Target, Config *BC) {
   // TODO: Add error checking from ClangOffloadBundler.cpp

clang/tools/clang-offload-bundler/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS Object Support)
 
 add_clang_tool(clang-offload-bundler
   ClangOffloadBundler.cpp
-  OffloadBundler.cpp
 
   DEPENDS
   intrinsics_gen
   )
 
 set(CLANG_OFFLOAD_BUNDLER_LIB_DEPS
   clangBasic
+  clangDriver
   )
 
 add_dependencies(clang clang-offload-bundler)
 
 clang_target_link_libraries(clang-offload-bundler
   PRIVATE
   ${CLANG_OFFLOAD_BUNDLER_LIB_DEPS}
   )

clang/tools/clang-offload-bundler/ClangOffloadBundler.cpp

 //===-- clang-offload-bundler/ClangOffloadBundler.cpp ---------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 ///
 /// \file
-/// This file implements a clang-offload-bundler that bundles different
-/// files that relate with the same source code but different targets into a
-/// single one. Also the implements the opposite functionality, i.e. unbundle
-/// files previous created by this tool.
+/// This file implements a stand-alone clang-offload-bundler tool using the
+/// OffloadBundler API.
 ///
 //===----------------------------------------------------------------------===//
 
 #include "clang/Basic/Cuda.h"
 #include "clang/Basic/Version.h"
+#include "clang/Driver/OffloadBundler.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/ADT/StringMap.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/StringSwitch.h"
 #include "llvm/ADT/Triple.h"
 #include "llvm/Object/Archive.h"

 #include <cstddef>
 #include <cstdint>
 #include <forward_list>
 #include <memory>
 #include <set>
 #include <string>
 #include <system_error>
 #include <utility>
-#include "OffloadBundler.h"
 
 using namespace llvm;
 using namespace llvm::object;
 
 static void PrintVersion(raw_ostream &OS) {
   OS << clang::getClangToolFullVersion("clang-offload-bundler") << '\n';
 }