From 76d89700953ddd81cf31ab8f260eddf67e93aa85 Mon Sep 17 00:00:00 2001
From: Richard-Qin-X <richard.qin.001@gmail.com>
Date: Fri, 7 Aug 2026 01:27:41 +0800
Subject: [MIR] Complete document parsing and printing

Implement the single LLVM-compatible MIR document path with structured\nembedded-IR references, YAML mappings, constants, and deterministic printing.\n\nKeep pointer LLT widths DataLayout-derived, reject layout-dependent output\nwhen embedded IR is omitted, and record the fixed-baseline compatibility\ncontract and regression coverage.
---
 backend/include/rcc/MIR/MIRDocument.h | 143 ++++++++++++++++++++++++++++++++++
 1 file changed, 143 insertions(+)
 create mode 100644 backend/include/rcc/MIR/MIRDocument.h

(limited to 'backend/include/rcc/MIR/MIRDocument.h')

diff --git a/backend/include/rcc/MIR/MIRDocument.h b/backend/include/rcc/MIR/MIRDocument.h
new file mode 100644
index 0000000..7980ca1
--- /dev/null
+++ b/backend/include/rcc/MIR/MIRDocument.h
@@ -0,0 +1,143 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#ifndef RCC_MIR_MIRDOCUMENT_H
+#define RCC_MIR_MIRDOCUMENT_H
+
+#include "rcc/CodeGen/CompilationUnit.h"
+#include "rcc/CodeGen/StableID.h"
+#include "rcc/MIR/EmbeddedIR.h"
+#include "rcc/MIR/MIParser.h"
+#include "rcc/MIR/MIPrinter.h"
+#include "rcc/Support/TextDiagnostic.h"
+#include "rcc/Support/YAML.h"
+
+#include <cstdint>
+#include <optional>
+#include <span>
+#include <string>
+#include <utility>
+#include <vector>
+
+namespace rcc {
+
+class TargetDescription;
+
+namespace mir {
+
+struct MIRFunctionDocumentInfo final {
+  MachineFunctionStableID Function;
+  std::optional<bool> NoPHIs;
+  std::optional<bool> IsSSA;
+  std::optional<bool> NoVRegs;
+  std::optional<bool> HasFakeUses;
+
+  friend bool operator==(const MIRFunctionDocumentInfo &Left,
+                         const MIRFunctionDocumentInfo &Right) = default;
+};
+
+class MIRDocument final {
+public:
+  MIRDocument();
+  explicit MIRDocument(CompilationUnit Unit);
+  MIRDocument(const MIRDocument &) = delete;
+  MIRDocument &operator=(const MIRDocument &) = delete;
+  MIRDocument(MIRDocument &&) noexcept;
+  MIRDocument &operator=(MIRDocument &&) noexcept;
+  ~MIRDocument();
+
+  [[nodiscard]] CompilationUnit &unit() noexcept {
+    return Unit;
+  }
+
+  [[nodiscard]] const CompilationUnit &unit() const noexcept {
+    return Unit;
+  }
+
+  [[nodiscard]] const EmbeddedIRReferenceIndex *embeddedIR() const noexcept {
+    return EmbeddedIR ? &*EmbeddedIR : nullptr;
+  }
+
+  [[nodiscard]] std::span<const MIRFunctionDocumentInfo> functionDocumentInfo() const noexcept {
+    return FunctionInfo;
+  }
+
+  [[nodiscard]] std::span<const MISyncScopeSlot> syncScopes() const noexcept {
+    return SyncScopes;
+  }
+
+private:
+  CompilationUnit Unit;
+  std::optional<EmbeddedIRReferenceIndex> EmbeddedIR;
+  std::vector<MIRFunctionDocumentInfo> FunctionInfo;
+  std::vector<MISyncScopeSlot> SyncScopes;
+
+  friend class MIRDocumentParser;
+};
+
+struct MIRDocumentParserOptions final {
+  yaml::ParseOptions YAML;
+  MIParserOptions MachineInstructions;
+  std::string DataLayout;
+  std::uint32_t DefaultPointerSizeInBits = 0;
+  bool VerifyMachineFunctions = true;
+};
+
+class MIRDocumentParseResult final {
+public:
+  MIRDocumentParseResult(const MIRDocumentParseResult &) = delete;
+  MIRDocumentParseResult &operator=(const MIRDocumentParseResult &) = delete;
+  MIRDocumentParseResult(MIRDocumentParseResult &&) noexcept;
+  MIRDocumentParseResult &operator=(MIRDocumentParseResult &&) noexcept;
+  ~MIRDocumentParseResult();
+
+  [[nodiscard]] bool succeeded() const noexcept {
+    return Document.has_value() && Diagnostics.empty();
+  }
+
+  [[nodiscard]] MIRDocument *document() noexcept {
+    return Document ? &*Document : nullptr;
+  }
+
+  [[nodiscard]] const MIRDocument *document() const noexcept {
+    return Document ? &*Document : nullptr;
+  }
+
+  [[nodiscard]] const TextSource &source() const noexcept {
+    return Source;
+  }
+
+  [[nodiscard]] std::span<const TextDiagnostic> diagnostics() const noexcept {
+    return Diagnostics;
+  }
+
+private:
+  MIRDocumentParseResult(std::string SourceName, std::string SourceText)
+      : Source(std::move(SourceName), std::move(SourceText)) {}
+
+  TextSource Source;
+  std::optional<MIRDocument> Document;
+  std::vector<TextDiagnostic> Diagnostics;
+
+  friend class MIRDocumentParser;
+};
+
+[[nodiscard]] MIRDocumentParseResult parseMIRDocument(const TargetDescription &Target,
+                                                      std::string SourceName,
+                                                      std::string SourceText,
+                                                      MIRDocumentParserOptions Options = {});
+
+struct MIRDocumentPrinterOptions final {
+  MIPrintMode Mode = MIPrintMode::Complete;
+  bool EmitEmbeddedIR = true;
+  std::string DataLayout;
+  std::uint32_t DefaultPointerSizeInBits = 0;
+};
+
+[[nodiscard]] Expected<std::string> printMIRDocument(const MIRDocument &Document,
+                                                     const TargetDescription &Target,
+                                                     MIRDocumentPrinterOptions Options = {});
+
+} // namespace mir
+} // namespace rcc
+
+#endif // RCC_MIR_MIRDOCUMENT_H
-- 
cgit v1.2.3