1 files changed, 83 insertions, 0 deletions
diff --git a/backend/include/rcc/Tooling/PipelineDriver.h b/backend/include/rcc/Tooling/PipelineDriver.h
new file mode 100644
index 0000000..2de341c
--- /dev/null
+++ b/backend/include/rcc/Tooling/PipelineDriver.h
@@ -0,0 +1,83 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#ifndef RCC_TOOLING_PIPELINEDRIVER_H
+#define RCC_TOOLING_PIPELINEDRIVER_H
+
+#include "rcc/CodeGen/MachinePass.h"
+#include "rcc/MIR/MIRDocument.h"
+#include "rcc/Tooling/BackendInvocation.h"
+
+#include <cstdint>
+#include <optional>
+#include <string>
+#include <string_view>
+#include <vector>
+
+namespace rcc {
+
+class TargetDescription;
+
+namespace tooling {
+
+enum class BackendStage : std::uint8_t {
+  PreLegalizerMIR,
+  LegalizedMIR,
+  RegisterBankMIR,
+  SelectedMIR,
+  PostSSAMIR,
+  PostRegisterAllocationMIR,
+  FinalMIR,
+};
+
+enum class SnapshotPhase : std::uint8_t {
+  Stage,
+  BeforePass,
+  AfterPass,
+};
+
+struct PipelineControls final {
+  std::optional<std::string> StopBefore;
+  std::optional<std::string> StopAfter;
+  std::vector<std::string> PrintBefore;
+  std::vector<std::string> PrintAfter;
+  std::optional<BackendStage> StopAtStage;
+  bool CaptureStageSnapshots = false;
+  bool VerifyEach = true;
+  bool DetectUnreportedChanges = true;
+};
+
+struct PipelineSnapshot final {
+  SnapshotPhase Phase = SnapshotPhase::Stage;
+  BackendStage Stage = BackendStage::PreLegalizerMIR;
+  std::string Function;
+  std::string Pass;
+  std::uint32_t Occurrence = 0;
+  std::string MIR;
+};
+
+struct ExecutedPass final {
+  std::string Function;
+  std::string Pass;
+  std::uint32_t Occurrence = 0;
+
+  friend bool operator==(const ExecutedPass &, const ExecutedPass &) = default;
+};
+
+struct PipelineRunResult final {
+  std::vector<ExecutedPass> ExecutedPasses;
+  std::vector<PipelineSnapshot> Snapshots;
+};
+
+[[nodiscard]] Expected<void> verifyRV64GCInvocation(const BackendInvocation &Invocation);
+[[nodiscard]] Expected<PipelineRunResult>
+runRV64GCPipeline(mir::MIRDocument &Document, const TargetDescription &Target,
+                  const BackendInvocation &Invocation, PipelineControls Controls = {},
+                  MachinePassInstrumentation *Instrumentation = nullptr);
+[[nodiscard]] BackendStage stageForFunction(const MachineFunction &Function) noexcept;
+[[nodiscard]] std::string_view spelling(BackendStage Stage) noexcept;
+[[nodiscard]] Expected<BackendStage> parseBackendStage(std::string_view Value);
+
+} // namespace tooling
+} // namespace rcc
+
+#endif // RCC_TOOLING_PIPELINEDRIVER_H