Files
carbon-lang/toolchain/base/llvm_tools.h
T
Chandler CarruthandGeoff Romer 1459332031 Add subcommands and busybox entry points for LLVM tools (#5049)
This adds support for most of the remaining LLVM command line tools
using a generic, generated wrapper. The subcommand interface for these
is (much) less interesting than our other subcommands, but it gives us
a uniform and consistent layer.

Note that I structured these as nested sub-sub-commands below an `llvm`
subcommand because of an expectation that we will want to add more, and
ones that don't use this generic layer. Some concrete future work:

- Add the `opt` and `llc` tools as subcommands for easier debugging and
  experimentation with LLVM IR output from Carbon's toolchain.
- Potentially sink `lld` below the `llvm` layer given that it has
  significantly less user visibility than commands like `clang`.

Unfortunately, the current driver subcommand APIs make nested
subcommands awkward. I've added a somewhat rough hack here to let the
LLVM tools go in, but there are some TODOs that I want to address in
a follow-up that works to adjust the structure of this code to be more
conducive to nesting like this.

Depends on #5048 -- only the last commit should be reviewed here.

---------

Co-authored-by: Geoff Romer <gromer@google.com>
2025-03-04 18:00:06 +00:00

76 lines
2.3 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef CARBON_TOOLCHAIN_BASE_LLVM_TOOLS_H_
#define CARBON_TOOLCHAIN_BASE_LLVM_TOOLS_H_
#include <cstdint>
#include "common/command_line.h"
#include "common/enum_base.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/LLVMDriver.h"
namespace Carbon {
CARBON_DEFINE_RAW_ENUM_CLASS(LLVMTool, uint8_t) {
#define CARBON_LLVM_TOOL(Identifier, Name, BinName, MainFn) \
CARBON_RAW_ENUM_ENUMERATOR(Identifier)
#include "toolchain/base/llvm_tools.def"
};
// An enum-like class for each of the LLVM tools.
//
// This can be used like an enum to track a specific one of the LLVM tools. It
// also has a collection of methods to access various aspects of the tools
// themselves, including the symbol used to invoke the given tool.
//
// The instances of this class are generated from `llvm_tools.bzl`, see that
// file for more details.
class LLVMTool : public CARBON_ENUM_BASE(LLVMTool) {
public:
#define CARBON_LLVM_TOOL(Identifier, Name, BinName, MainFn) \
CARBON_ENUM_CONSTANT_DECL(Identifier)
#include "toolchain/base/llvm_tools.def"
static const llvm::ArrayRef<LLVMTool> Tools;
using MainFnT = auto(int argc, char** argv, const llvm::ToolContext& context)
-> int;
using EnumBase::EnumBase;
auto bin_name() const -> llvm::StringLiteral { return BinNames[AsInt()]; }
auto main_fn() const -> MainFnT* { return MainFns[AsInt()]; }
auto subcommand_info() const -> const CommandLine::CommandInfo& {
return SubcommandInfos[AsInt()];
}
private:
static const LLVMTool ToolsStorage[];
static const llvm::StringLiteral BinNames[];
static MainFnT* const MainFns[];
static const CommandLine::CommandInfo SubcommandInfos[];
};
#define CARBON_LLVM_TOOL(Identifier, Name, BinName, MainFn) \
CARBON_ENUM_CONSTANT_DEFINITION(LLVMTool, Identifier)
#include "toolchain/base/llvm_tools.def"
constexpr LLVMTool LLVMTool::ToolsStorage[] = {
#define CARBON_LLVM_TOOL(Identifier, Name, BinName, MainFn) \
LLVMTool::Identifier,
#include "toolchain/base/llvm_tools.def"
};
constexpr llvm::ArrayRef<LLVMTool> LLVMTool::Tools = ToolsStorage;
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_BASE_LLVM_TOOLS_H_