Support labeled block value breaks in HIR lowering

This change implements backend lowering support for Rust labeled blocks.

Previously, labeled blocks were rejected in "CompileExpr::visit(BlockExpr)"
as unsupported. With this patch, labeled blocks are lowered by introducing
the following :-

1. A backend "LABEL_DECL" used as the jump target for "break 'label".
2. A temporary "Bvariable" used to hold the block’s resulting value.

gcc/rust/ChangeLog:

        * backend/rust-compile-context.h: Insert/Lookup block temp variables.
        * backend/rust-compile-expr.cc (CompileExpr::visit): Lower labeled block.
	(CompileExpr::construct_block_label): Utility function to construct block label.
	(CompileExpr::lookup_label): Utility function to lookup label.
	(CompileExpr::lookup_temp_var): Utility function to lookup block temp variables.
	(CompileExpr::resolve_util): Utility to resolve NodeId to HirId.
        * backend/rust-compile-expr.h: Header functions.
        * resolve/rust-late-name-resolver-2.0.cc (Late::visit): Fix label resolution.

gcc/testsuite/ChangeLog:

        * rust/execute/cf-labeled-block.rs: New test.

Signed-off-by: Islam-Imad <islamimad404@gmail.com>

Author: Islam-Imad

gcc/rust/backend/rust-compile-context.h

@@ -266,6 +266,21 @@ class Context
     return true;
   }
 
+  void insert_temp_var (HirId id, Bvariable *var)
+  {
+    compiled_temp_vars[id] = var;
+  }
+
+  bool lookup_temp_var (HirId id, Bvariable **var)
+  {
+    auto it = compiled_temp_vars.find (id);
+    if (it == compiled_temp_vars.end ())
+      return false;
+
+    *var = it->second;
+    return true;
+  }
+
   void insert_pattern_binding (HirId id, tree binding)
   {
     implicit_pattern_bindings[id] = binding;
@@ -417,6 +432,7 @@ class Context
   std::map<HirId, tree> compiled_fn_map;
   std::map<HirId, tree> compiled_consts;
   std::map<HirId, tree> compiled_labels;
+  std::map<HirId, Bvariable *> compiled_temp_vars;
   std::vector<::std::vector<tree>> statements;
   std::vector<tree> scope_stack;
   std::vector<::Bvariable *> loop_value_stack;

gcc/rust/backend/rust-compile-expr.cc

@@ -18,6 +18,7 @@
 
 #include "rust-compile-expr.h"
 #include "rust-backend.h"
+#include "rust-compile-context.h"
 #include "rust-compile-type.h"
 #include "rust-compile-struct-field-expr.h"
 #include "rust-compile-pattern.h"
@@ -32,11 +33,14 @@
 #include "realmpfr.h"
 #include "convert.h"
 #include "print-tree.h"
+#include "rust-hir-bound.h"
 #include "rust-hir-expr.h"
 #include "rust-system.h"
 #include "rust-tree.h"
 #include "rust-tyty.h"
 #include "tree-core.h"
+#include "tree.h"
+#include <cassert>
 
 namespace Rust {
 namespace Compile {
@@ -437,10 +441,13 @@ CompileExpr::visit (HIR::IfExprConseqElse &expr)
 void
 CompileExpr::visit (HIR::BlockExpr &expr)
 {
+  tree block_label = NULL_TREE;
   if (expr.has_label ())
     {
-      rust_error_at (expr.get_locus (), "labeled blocks are not supported");
-      return;
+      // rust_error_at (expr.get_locus (), "labeled blocks are not supported");
+      // return;
+      block_label = construct_block_label (expr);
+      // construct_temp_var (expr);
     }
 
   TyTy::BaseType *block_tyty = nullptr;
@@ -461,12 +468,22 @@ CompileExpr::visit (HIR::BlockExpr &expr)
   tmp = Backend::temporary_variable (fnctx.fndecl, enclosing_scope, block_type,
 				     NULL, is_address_taken, expr.get_locus (),
 				     &ret_var_stmt);
+
+  if (expr.has_label ())
+    {
+      ctx->insert_temp_var (
+	expr.get_label ().get_lifetime ().get_mappings ().get_hirid (), tmp);
+    }
+
   ctx->add_statement (ret_var_stmt);
 
   auto block_stmt = CompileBlock::compile (expr, ctx, tmp);
   rust_assert (TREE_CODE (block_stmt) == BIND_EXPR);
   ctx->add_statement (block_stmt);
-
+  if (block_label)
+    {
+      ctx->add_statement (block_label);
+    }
   translated = Backend::var_expression (tmp, expr.get_locus ());
 }
 
@@ -854,11 +871,25 @@ CompileExpr::visit (HIR::WhileLoopExpr &expr)
 void
 CompileExpr::visit (HIR::BreakExpr &expr)
 {
+  if (expr.has_break_expr () && expr.has_label ())
+    {
+      HIR::Lifetime label = expr.get_label ();
+      auto tvar = lookup_temp_var (label.get_mappings ().get_nodeid ());
+      tree value = CompileExpr::Compile (expr.get_expr (), ctx);
+      tree assign
+	= Backend::assignment_statement (tvar->get_tree (label.get_locus ()),
+					 value, label.get_locus ());
+      tree block_label = lookup_label (label.get_mappings ().get_nodeid ());
+      tree go_to = Backend::goto_statement (block_label, label.get_locus ());
+      ctx->add_statement (assign);
+      ctx->add_statement (go_to);
+      return;
+    }
   if (expr.has_break_expr ())
     {
       tree compiled_expr = CompileExpr::Compile (expr.get_expr (), ctx);
-
       translated = error_mark_node;
+
       if (!ctx->have_loop_context ())
 	return;
 
@@ -892,7 +923,6 @@ CompileExpr::visit (HIR::BreakExpr &expr)
 	    expr.get_label ().get_mappings ().as_string ().c_str ());
 	  return;
 	}
-
       tl::optional<HirId> hid
 	= ctx->get_mappings ().lookup_node_to_hir (resolved_node_id);
       if (!hid.has_value ())
@@ -2759,5 +2789,58 @@ CompileExpr::generate_possible_fn_trait_call (HIR::CallExpr &expr,
   return true;
 }
 
+tree
+CompileExpr::construct_block_label (HIR::BlockExpr &expr)
+{
+  if (expr.has_label ())
+    {
+      fncontext fnctx = ctx->peek_fn ();
+      HIR::LoopLabel label = expr.get_label ();
+      std::string label_name = label.get_lifetime ().get_name ();
+      HirId label_id = label.get_lifetime ().get_mappings ().get_hirid ();
+      tree label_decl
+	= Backend::label (fnctx.fndecl, label_name, label.get_locus ());
+      tree label_expr = Backend::label_definition_statement (label_decl);
+      ctx->insert_label_decl (label_id, label_decl);
+      return label_expr;
+    }
+  return NULL_TREE;
+}
+
+tree
+CompileExpr::lookup_label (NodeId to_be_resolved)
+{
+  HirId ref = resolve_util (to_be_resolved);
+  tree label = NULL_TREE;
+  assert (ctx->lookup_label_decl (ref, &label) && "failed to lookup a label");
+  return label;
+}
+
+Bvariable *
+CompileExpr::lookup_temp_var (NodeId to_be_resolved)
+{
+  HirId ref = resolve_util (to_be_resolved);
+  Bvariable *ltemp = nullptr;
+  if (!ctx->lookup_temp_var (ref, &ltemp))
+    {
+      assert (false && "hey we failed to lookup temp var here bro");
+    }
+  return ltemp;
+}
+
+HirId
+CompileExpr::resolve_util (NodeId to_be_resolved)
+{
+  auto &nr_ctx
+    = Resolver2_0::ImmutableNameResolutionContext::get ().resolver ();
+
+  NodeId resolved_node_id;
+  resolved_node_id = nr_ctx.lookup (to_be_resolved).value ();
+
+  HirId ref
+    = ctx->get_mappings ().lookup_node_to_hir (resolved_node_id).value ();
+  return ref;
+}
+
 } // namespace Compile
 } // namespace Rust

gcc/rust/backend/rust-compile-expr.h

@@ -20,6 +20,8 @@
 #define RUST_COMPILE_EXPR
 
 #include "rust-compile-base.h"
+#include "rust-gcc.h"
+#include "rust-hir-expr.h"
 #include "rust-hir-visitor.h"
 
 namespace Rust {
@@ -151,6 +153,11 @@ class CompileExpr : private HIRCompileBase, protected HIR::HIRExpressionVisitor
   bool generate_possible_fn_trait_call (HIR::CallExpr &expr, tree receiver,
 					tree *result);
 
+  tree construct_block_label (HIR::BlockExpr &expr);
+  tree lookup_label (NodeId to_be_resolved);
+  Bvariable *lookup_temp_var (NodeId to_be_resolved);
+  HirId resolve_util (NodeId to_be_resolved);
+
 private:
   CompileExpr (Context *ctx);
 

gcc/rust/resolve/rust-late-name-resolver-2.0.cc

@@ -299,6 +299,9 @@ Late::visit (AST::BreakExpr &expr)
 void
 Late::visit (AST::LoopLabel &label)
 {
+  auto resolved = ctx.lookup (label.get_lifetime ().get_node_id ());
+  if (resolved.has_value ())
+    return;
   auto &lifetime = label.get_lifetime ();
   ctx.labels.insert (Identifier (lifetime.as_string (), lifetime.get_locus ()),
 		     lifetime.get_node_id ());

gcc/testsuite/rust/execute/cf-labeled-block.rs

@@ -0,0 +1,36 @@
+// { dg-output "222\r*\n333\r*\n" }
+#![feature(no_core)]
+#![no_core]
+extern "C" {
+    fn printf(s: *const i8, ...);
+}
+fn dump_number(num: i32) {
+    unsafe {
+        let a = "%i\n\0";
+        let c = a as *const str as *const i8;
+        printf(c, num);
+    }
+}
+
+fn main() -> i32 {
+    let a = 'block_a: {
+        if false {
+            break 'block_a 111;
+        }
+        222
+    };
+    dump_number(a);
+    let b = 'block_b: {
+        if true {
+            break 'block_b 333;
+        }
+        444
+    };
+    dump_number(b);
+    // ISSUE HERE :)
+    // let c = 'block_c: {
+    //     break 'block_c 555;
+    // };
+    // dump_number(c);
+    0
+}