fix(compiler): keep provenance information of IR blocks inside the IROptimiser

Author: SuperFola

src/arkreactor/Compiler/IntermediateRepresentation/IROptimizer.cpp

@@ -249,6 +249,7 @@ namespace Ark::internal
             for (const auto& two : math_ops)
             {
                 for (const auto& three : math_ops)
+                    // cppcheck-suppress useStlAlgorithm
                     m_ruleset.emplace_back(Rule { { one, two, three }, fuseMathOps3 });
                 m_ruleset.emplace_back(Rule { { one, two }, fuseMathOps2 });
             }
@@ -265,7 +266,15 @@ namespace Ark::internal
 
         for (const auto& block : pages)
         {
-            m_ir.emplace_back();
+            m_ir.emplace_back(IR::Block {
+                .metadata = {
+                    .name = block.metadata.name,
+                    .argument_count = block.metadata.argument_count,
+                    .addr = block.metadata.addr,
+                    .is_closure = block.metadata.is_closure,
+                    .is_recursive = block.metadata.is_recursive,
+                    .is_simple = block.metadata.is_simple },
+                .data = {} });
             std::vector<IR::Entity>& current_block = m_ir.back().data;
 
             std::size_t i = 0;

tests/unittests/Suites/CompilerSuite.cpp

@@ -102,20 +102,20 @@ ut::suite<"Compiler"> compiler_suite = [] {
             });
     };
 
-    "IR generation and optimization"_test = [] {
+    "IR generation and optimisation"_test = [] {
         constexpr uint16_t features = featuresNoOpti | Ark::FeatureIROptimiser;
 
         iterTestFiles(
-            "CompilerSuite/optimized_ir",
+            "CompilerSuite/optimised_ir",
             [](TestData&& data) {
                 Ark::Welder welder(0, { lib_path }, features);
 
-                should("compile without error optimized_ir/" + data.stem) = [&] {
+                should("compile without error optimised_ir/" + data.stem) = [&] {
                     expect(mut(welder).computeASTFromFile(data.path));
                     expect(mut(welder).generateBytecode());
                 };
 
-                should("output expected optimized IR for " + data.stem) = [&] {
+                should("output expected optimised IR for " + data.stem) = [&] {
                     std::string ir = welder.textualIR();
 
                     Ark::Utils::ltrim(Ark::Utils::rtrim(ir));
@@ -148,7 +148,29 @@ ut::suite<"Compiler"> compiler_suite = [] {
                         updateExpectedFile(data, ir);
                 };
             });
+    };
+
+    "IR generation, inlining and optimisation"_test = [] {
+        constexpr uint16_t features = featuresNoOpti | Ark::FeatureIRInliner | Ark::FeatureASTOptimiser;
+
+        iterTestFiles(
+            "CompilerSuite/inlined_optimised_ir",
+            [](TestData&& data) {
+                Ark::Welder welder(0, { lib_path }, features);
+
+                should("compile without error inlined_optimised_ir/" + data.stem) = [&] {
+                    expect(mut(welder).computeASTFromFile(data.path));
+                    expect(mut(welder).generateBytecode());
+                };
 
-        // todo: ir inliner
+                should("output expected inlined IR for " + data.stem) = [&] {
+                    std::string ir = welder.textualIR();
+
+                    Ark::Utils::ltrim(Ark::Utils::rtrim(ir));
+                    expectOrDiff(data.expected, ir);
+                    if (shouldWriteNewDiffsTofile() && data.expected != ir)
+                        updateExpectedFile(data, ir);
+                };
+            });
     };
 };

tests/unittests/resources/CompilerSuite/inlined_optimised_ir/shadow_2_no_inline.ark

@@ -0,0 +1,5 @@
+(let h (fun () 1))
+((fun () {
+  (let h (fun () 2))
+  ((fun () (print (h))))
+  ((fun (h) (print (h))) h) }))

tests/unittests/resources/CompilerSuite/inlined_optimised_ir/shadow_2_no_inline.expected

@@ -0,0 +1,56 @@
+global
+	LOAD_CONST 0
+	STORE 0
+	PUSH_RETURN_ADDRESS L0
+	LOAD_CONST 2
+	CALL 0
+.L0:
+	POP 0
+	HALT 0
+
+page_1 (h (0 arguments) simple function, 3 instructions)
+	LOAD_CONST 1
+	RET 0
+	HALT 0
+
+page_2 (#anonymous (0 arguments) function, 14 instructions)
+	LOAD_CONST 3
+	STORE 0
+	PUSH_RETURN_ADDRESS L1
+	LOAD_CONST 5
+	CALL 0
+.L1:
+	POP 0
+	PUSH_RETURN_ADDRESS L4
+	LOAD_CONST 6
+	LOAD_FAST_BY_INDEX 0
+	CALL 1
+.L4:
+	RET 0
+	HALT 0
+
+page_3 (h (0 arguments) simple function, 3 instructions)
+	LOAD_CONST 4
+	RET 0
+	HALT 0
+
+page_4 (#anonymous (0 arguments) function, 8 instructions)
+	PUSH_RETURN_ADDRESS L2
+	PUSH_RETURN_ADDRESS L3
+	CALL_SYMBOL 0, 0
+.L3:
+	CALL_BUILTIN 9, 1
+.L2:
+	RET 0
+	HALT 0
+
+page_5 (#anonymous (1 argument) function, 9 instructions)
+	STORE 0
+	PUSH_RETURN_ADDRESS L5
+	PUSH_RETURN_ADDRESS L6
+	CALL_SYMBOL_BY_INDEX 0, 0
+.L6:
+	CALL_BUILTIN 9, 1
+.L5:
+	RET 0
+	HALT 0

…CompilerSuite/optimized_ir/99bottles.ark …CompilerSuite/optimised_ir/99bottles.arktests/unittests/resources/CompilerSuite/optimized_ir/99bottles.ark renamed to tests/unittests/resources/CompilerSuite/optimised_ir/99bottles.ark tests/unittests/resources/CompilerSuite/optimized_ir/99bottles.ark renamed to tests/unittests/resources/CompilerSuite/optimised_ir/99bottles.ark

@@ -11,7 +11,7 @@ global
 	POP 0
 	HALT 0
 
-page_1 (#anonymous (0 arguments) function, 25 instructions)
+page_1 (ackermann (2 arguments) recursive simple function, 25 instructions)
 	STORE 1
 	STORE 2
 	LOAD_FAST_BY_INDEX 0