aboutsummaryrefslogtreecommitdiff
path: root/backend/include/rcc/Tooling/BackendInvocation.h
blob: db1c5d2ee231e4004721e61f28b3b0f145a6970d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
// SPDX-License-Identifier: GPL-3.0-or-later

#ifndef RCC_TOOLING_BACKENDINVOCATION_H
#define RCC_TOOLING_BACKENDINVOCATION_H

#include "rcc/Support/Error.h"

#include <cstdint>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <vector>

namespace rcc {

class TargetDescription;

namespace tooling {

inline constexpr std::uint32_t BackendInvocationSchemaVersion = 1;
inline constexpr std::string_view LLVMReferenceRevision =
    "2b40c303e79f64c5c7642032554eda026594d604";
inline constexpr std::string_view GenericOpcodeReferenceVersion = "rcc-generic-opcode-v1";
inline constexpr std::string_view RV64GCTargetABILoweringVersion = "rcc-rv64gc-lp64d-v1";
inline constexpr std::string_view CompilerBuildFingerprint = "rcc-backend-0.1.0-stage17";

enum class RelocationModel : std::uint8_t {
  Static,
  PositionIndependent,
};

enum class CodeModel : std::uint8_t {
  Small,
  Medium,
  Large,
};

enum class OptimizationLevel : std::uint8_t {
  O0,
  O1,
  O2,
  O3,
  Os,
  Oz,
};

enum class LayoutOwnership : std::uint8_t {
  NativeObject,
  CompilerFinalLayout,
  ExternalRelaxation,
};

struct BackendOption final {
  std::string Name;
  std::string Value;

  friend bool operator==(const BackendOption &, const BackendOption &) = default;
};

struct DeterminismOptions final {
  std::uint64_t RandomSeed = 0;
  std::uint32_t ThreadCount = 1;
  bool StableScheduling = true;

  friend bool operator==(const DeterminismOptions &, const DeterminismOptions &) = default;
};

struct BackendInvocation final {
  std::uint32_t SchemaVersion = BackendInvocationSchemaVersion;
  std::string Triple;
  std::string CPU;
  std::string TuneCPU;
  std::vector<std::string> Features;
  std::string ABI;
  std::string DataLayout;
  RelocationModel Relocation = RelocationModel::PositionIndependent;
  CodeModel Code = CodeModel::Small;
  std::vector<BackendOption> TargetOptions;
  LayoutOwnership Layout = LayoutOwnership::NativeObject;
  std::string AssemblerFlavor;
  std::string AssemblerVersion;
  std::vector<BackendOption> AssemblerOptions;
  OptimizationLevel Optimization = OptimizationLevel::O2;
  std::vector<std::string> PassPipeline{"default"};
  DeterminismOptions Determinism;
  std::optional<std::uint64_t> ActionFuel;
  std::vector<std::string> EnabledActions;
  std::string MIRReferenceRevision{LLVMReferenceRevision};
  std::string GenericOpcodeVersion{GenericOpcodeReferenceVersion};
  std::string TargetABILoweringVersion{RV64GCTargetABILoweringVersion};
  std::string BuildFingerprint{CompilerBuildFingerprint};

  [[nodiscard]] Expected<void> canonicalizeAndVerify();
  [[nodiscard]] std::string canonicalText() const;

  friend bool operator==(const BackendInvocation &, const BackendInvocation &) = default;
};

[[nodiscard]] BackendInvocation defaultRV64GCInvocation();
[[nodiscard]] Expected<std::string>
computeTargetDescriptionFingerprint(const TargetDescription &Target);
[[nodiscard]] Expected<std::string> computeCacheKey(std::string_view CanonicalMIR,
                                                    const BackendInvocation &Invocation,
                                                    std::string_view TargetFingerprint);

[[nodiscard]] std::string_view spelling(RelocationModel Value) noexcept;
[[nodiscard]] std::string_view spelling(CodeModel Value) noexcept;
[[nodiscard]] std::string_view spelling(OptimizationLevel Value) noexcept;
[[nodiscard]] std::string_view spelling(LayoutOwnership Value) noexcept;
[[nodiscard]] Expected<RelocationModel> parseRelocationModel(std::string_view Value);
[[nodiscard]] Expected<CodeModel> parseCodeModel(std::string_view Value);
[[nodiscard]] Expected<OptimizationLevel> parseOptimizationLevel(std::string_view Value);
[[nodiscard]] Expected<LayoutOwnership> parseLayoutOwnership(std::string_view Value);

} // namespace tooling
} // namespace rcc

#endif // RCC_TOOLING_BACKENDINVOCATION_H