Merge pull request #621 from czgdp1807/structs_c

Enabling `C` backend for structs

Author: certik

.gitignore

@@ -177,3 +177,9 @@ integration_tests/bindc_01
 integration_tests/bindc_01.c
 integration_tests/bindc_02
 integration_tests/bindc_02.c
+integration_tests/structs_01
+integration_tests/structs_01.c
+integration_tests/structs_02
+integration_tests/structs_02.c
+integration_tests/structs_03
+integration_tests/structs_03.c

integration_tests/CMakeLists.txt

@@ -169,9 +169,9 @@ RUN(NAME test_unary_minus    LABELS cpython llvm)
 RUN(NAME test_unary_plus     LABELS cpython llvm)
 RUN(NAME test_bool_binop     LABELS cpython llvm)
 RUN(NAME test_issue_518      LABELS cpython llvm)
-RUN(NAME structs_01          LABELS cpython llvm)
-RUN(NAME structs_02          LABELS llvm)
-RUN(NAME structs_03          LABELS llvm)
+RUN(NAME structs_01          LABELS cpython llvm c)
+RUN(NAME structs_02          LABELS llvm c)
+RUN(NAME structs_03          LABELS llvm c)
 
 # Just CPython
 RUN(NAME test_builtin_bin    LABELS cpython)

integration_tests/structs_01.py

@@ -9,6 +9,10 @@ def f(a: A):
     print(a.x)
     print(a.y)
 
+def change_struct(a: A):
+    a.x = a.x + 1
+    a.y = a.y + 1
+
 def g():
     x: A
     x = A(3.25, 3)
@@ -21,5 +25,8 @@ def g():
     f(x)
     assert x.x == 5
     assert x.y == 5.5
+    change_struct(x)
+    assert x.x == 6
+    assert x.y == 6.5
 
 g()

src/libasr/codegen/asr_to_c.cpp

@@ -9,6 +9,7 @@
 #include <libasr/asr_utils.h>
 #include <libasr/string_utils.h>
 #include <libasr/pass/unused_functions.h>
+#include <libasr/pass/class_constructor.h>
 
 
 namespace LFortran {
@@ -76,6 +77,12 @@ class ASRToCVisitor : public BaseCCPPVisitor<ASRToCVisitor>
                     type_name.append(" *");
                 }
                 sub = format_type_c(dims, type_name, v.m_name, use_ref, dummy);
+            } else if(ASR::is_a<ASR::Derived_t>(*t2)) {
+                ASR::Derived_t *t = ASR::down_cast<ASR::Derived_t>(t2);
+                std::string der_type_name = ASRUtils::symbol_name(t->m_derived_type);
+                std::string dims = convert_dims_c(t->n_dims, t->m_dims);
+                sub = format_type_c(dims, "struct " + der_type_name + "*",
+                                    v.m_name, use_ref, dummy);
             } else {
                 diag.codegen_error_label("Type number '"
                     + std::to_string(v.m_type->type)
@@ -109,9 +116,27 @@ class ASRToCVisitor : public BaseCCPPVisitor<ASRToCVisitor>
             } else if (ASRUtils::is_character(*v.m_type)) {
                 // TODO
             } else if (ASR::is_a<ASR::Derived_t>(*v.m_type)) {
+                std::string indent(indentation_level*indentation_spaces, ' ');
                 ASR::Derived_t *t = ASR::down_cast<ASR::Derived_t>(v.m_type);
+                std::string der_type_name = ASRUtils::symbol_name(t->m_derived_type);
                 std::string dims = convert_dims_c(t->n_dims, t->m_dims);
-                sub = format_type_c(dims, "struct", v.m_name, use_ref, dummy);
+                if( v.m_intent == ASRUtils::intent_local ) {
+                    std::string value_var_name = v.m_parent_symtab->get_unique_name(std::string(v.m_name) + "_value");
+                    sub = format_type_c(dims, "struct " + der_type_name,
+                                        value_var_name, use_ref, dummy);
+                    if (v.m_symbolic_value) {
+                        this->visit_expr(*v.m_symbolic_value);
+                        std::string init = src;
+                        sub += "=" + init;
+                    }
+                    sub += ";\n";
+                    sub += indent + format_type_c("", "struct " + der_type_name + "*", v.m_name, use_ref, dummy);
+                    sub += "= &" + value_var_name;
+                    return sub;
+                } else {
+                    sub = format_type_c(dims, "struct " + der_type_name + "*",
+                                        v.m_name, use_ref, dummy);
+                }
             } else if (ASR::is_a<ASR::CPtr_t>(*v.m_type)) {
                 sub = format_type_c("", "void*", v.m_name, false, false);
             } else {
@@ -120,7 +145,7 @@ class ASRToCVisitor : public BaseCCPPVisitor<ASRToCVisitor>
                     + "' not supported", {v.base.base.loc}, "");
                 throw Abort();
             }
-             if (v.m_symbolic_value) {
+            if (v.m_symbolic_value) {
                 this->visit_expr(*v.m_symbolic_value);
                 std::string init = src;
                 sub += "=" + init;
@@ -172,6 +197,18 @@ R"(
 )";
         unit_src += head;
 
+        for (auto &item : x.m_global_scope->get_scope()) {
+            if (ASR::is_a<ASR::DerivedType_t>(*item.second)) {
+                unit_src += "struct " + item.first + ";\n\n";
+            }
+        }
+
+        for (auto &item : x.m_global_scope->get_scope()) {
+            if (ASR::is_a<ASR::DerivedType_t>(*item.second)) {
+                visit_symbol(*item.second);
+                unit_src += src;
+            }
+        }
 
         // Pre-declare all functions first, then generate code
         // Otherwise some function might not be found.
@@ -282,6 +319,22 @@ R"(
         indentation_level -= 2;
     }
 
+    void visit_DerivedType(const ASR::DerivedType_t& x) {
+        std::string indent(indentation_level*indentation_spaces, ' ');
+        indentation_level += 1;
+        std::string open_struct = indent + "struct " + std::string(x.m_name) + " {\n";
+        std::string body = "";
+        indent.push_back(' ');
+        for( size_t i = 0; i < x.n_members; i++ ) {
+            ASR::symbol_t* member = x.m_symtab->get_symbol(x.m_members[i]);
+            LFORTRAN_ASSERT(ASR::is_a<ASR::Variable_t>(*member));
+            body += indent + convert_variable_decl(*ASR::down_cast<ASR::Variable_t>(member)) + ";\n";
+        }
+        indentation_level -= 1;
+        std::string end_struct = "};\n\n";
+        src = open_struct + body + end_struct;
+    }
+
     void visit_LogicalConstant(const ASR::LogicalConstant_t &x) {
         if (x.m_value == true) {
             src = "true";
@@ -378,6 +431,7 @@ Result<std::string> asr_to_c(Allocator &al, ASR::TranslationUnit_t &asr,
     diag::Diagnostics &diagnostics)
 {
     pass_unused_functions(al, asr);
+    pass_replace_class_constructor(al, asr);
     ASRToCVisitor v(diagnostics);
     try {
         v.visit_asr((ASR::asr_t &)asr);

src/libasr/codegen/asr_to_c_cpp.h

@@ -533,6 +533,9 @@ R"(#include <stdio.h>
         } else if (ASR::is_a<ASR::ArrayRef_t>(*x.m_target)) {
             visit_ArrayRef(*ASR::down_cast<ASR::ArrayRef_t>(x.m_target));
             target = src;
+        } else if (ASR::is_a<ASR::DerivedRef_t>(*x.m_target)) {
+            visit_DerivedRef(*ASR::down_cast<ASR::DerivedRef_t>(x.m_target));
+            target = src;
         } else {
             LFORTRAN_ASSERT(false)
         }
@@ -573,6 +576,14 @@ R"(#include <stdio.h>
         last_expr_precedence = 2;
     }
 
+    void visit_DerivedRef(const ASR::DerivedRef_t& x) {
+        std::string der_expr, member;
+        this->visit_expr(*x.m_v);
+        der_expr = std::move(src);
+        member = ASRUtils::symbol_name(x.m_m);
+        src = der_expr + "->" + member;
+    }
+
     void visit_ArrayRef(const ASR::ArrayRef_t &x) {
         const ASR::symbol_t *s = ASRUtils::symbol_get_past_external(x.m_v);
         ASR::Variable_t* sv = ASR::down_cast<ASR::Variable_t>(s);
@@ -731,6 +742,11 @@ R"(#include <stdio.h>
                 type_src = "void*";
                 break;
             }
+            case ASR::ttypeType::Derived: {
+                ASR::Derived_t* der_type = ASR::down_cast<ASR::Derived_t>(t);
+                type_src = std::string("struct ") + ASRUtils::symbol_name(der_type->m_derived_type);
+                break;
+            }
             default: {
                 throw CodeGenError("Type " + ASRUtils::type_to_str_python(t) + " not supported yet.");
             }
@@ -742,7 +758,8 @@ R"(#include <stdio.h>
         self().visit_expr(*x.m_arg);
         std::string arg_src = std::move(src);
         std::string addr_prefix = "&";
-        if( ASRUtils::is_array(ASRUtils::expr_type(x.m_arg)) ) {
+        if( ASRUtils::is_array(ASRUtils::expr_type(x.m_arg)) ||
+            ASR::is_a<ASR::Derived_t>(*ASRUtils::expr_type(x.m_arg)) ) {
             addr_prefix.clear();
         }
         src = addr_prefix + arg_src;

tests/reference/asr-structs_01-be14d49.json

@@ -2,11 +2,11 @@
     "basename": "asr-structs_01-be14d49",
     "cmd": "lpython --show-asr --no-color {infile} -o {outfile}",
     "infile": "tests/../integration_tests/structs_01.py",
-    "infile_hash": "b3fd3a07d6aab6b40e16f209a74c4d64448b8a0e509e539f96ebd167",
+    "infile_hash": "6586261b9b6e998bad980042375ce6206037a9bb5e1efb586edf691c",
     "outfile": null,
     "outfile_hash": null,
     "stdout": "asr-structs_01-be14d49.stdout",
-    "stdout_hash": "13f16c8ce74e0249f7800d65538d55bbdb84d06ff6ee7a7887466ed3",
+    "stdout_hash": "1be7dd10a2f5f2a23e9567c9da3e050c017ff61573bf72c6d34ce14e",
     "stderr": null,
     "stderr_hash": null,
     "returncode": 0

tests/reference/asr-structs_01-be14d49.stdout

@@ -1 +1 @@
-(TranslationUnit (SymbolTable 1 {A: (DerivedType (SymbolTable 2 {x: (Variable 2 x Local () () Default (Integer 4 []) Source Public Required .false.), y: (Variable 2 y Local () () Default (Real 4 []) Source Public Required .false.)}) A [y x] Source Public ()), _lpython_main_program: (Subroutine (SymbolTable 6 {}) _lpython_main_program [] [(SubroutineCall 1 g () [] ())] Source Public Implementation () .false. .false.), f: (Subroutine (SymbolTable 3 {a: (Variable 3 a In () () Default (Derived 1 A []) Source Public Required .false.)}) f [(Var 3 a)] [(Print () [(DerivedRef (Var 3 a) 2 x (Integer 4 []) ())]) (Print () [(DerivedRef (Var 3 a) 2 y (Real 4 []) ())])] Source Public Implementation () .false. .false.), g: (Subroutine (SymbolTable 4 {x: (Variable 4 x Local () () Default (Derived 1 A []) Source Public Required .false.)}) g [] [(= (Var 4 x) (DerivedTypeConstructor 1 A [(Cast (RealConstant   3.25000000000000000e+00 (Real 8 [])) RealToReal (Real 4 []) (RealConstant   3.25000000000000000e+00 (Real 4 []))) (IntegerConstant 3 (Integer 4 []))] (Derived 1 A []) ()) ()) (SubroutineCall 1 f () [((Var 4 x))] ()) (Assert (Compare (DerivedRef (Var 4 x) 2 x (Integer 4 []) ()) Eq (IntegerConstant 3 (Integer 4 [])) (Logical 4 []) () ()) ()) (Assert (Compare (Cast (DerivedRef (Var 4 x) 2 y (Real 4 []) ()) RealToReal (Real 8 []) ()) Eq (RealConstant   3.25000000000000000e+00 (Real 8 [])) (Logical 4 []) () ()) ()) (= (DerivedRef (Var 4 x) 2 x (Integer 4 []) ()) (IntegerConstant 5 (Integer 4 [])) ()) (= (DerivedRef (Var 4 x) 2 y (Real 4 []) ()) (Cast (RealConstant   5.50000000000000000e+00 (Real 8 [])) RealToReal (Real 4 []) (RealConstant   5.50000000000000000e+00 (Real 4 []))) ()) (SubroutineCall 1 f () [((Var 4 x))] ()) (Assert (Compare (DerivedRef (Var 4 x) 2 x (Integer 4 []) ()) Eq (IntegerConstant 5 (Integer 4 [])) (Logical 4 []) () ()) ()) (Assert (Compare (Cast (DerivedRef (Var 4 x) 2 y (Real 4 []) ()) RealToReal (Real 8 []) ()) Eq (RealConstant   5.50000000000000000e+00 (Real 8 [])) (Logical 4 []) () ()) ())] Source Public Implementation () .false. .false.), main_program: (Program (SymbolTable 5 {}) main_program [] [(SubroutineCall 1 _lpython_main_program () [] ())])}) [])
+(TranslationUnit (SymbolTable 1 {A: (DerivedType (SymbolTable 2 {x: (Variable 2 x Local () () Default (Integer 4 []) Source Public Required .false.), y: (Variable 2 y Local () () Default (Real 4 []) Source Public Required .false.)}) A [y x] Source Public ()), _lpython_main_program: (Subroutine (SymbolTable 7 {}) _lpython_main_program [] [(SubroutineCall 1 g () [] ())] Source Public Implementation () .false. .false.), change_struct: (Subroutine (SymbolTable 4 {a: (Variable 4 a In () () Default (Derived 1 A []) Source Public Required .false.)}) change_struct [(Var 4 a)] [(= (DerivedRef (Var 4 a) 2 x (Integer 4 []) ()) (IntegerBinOp (DerivedRef (Var 4 a) 2 x (Integer 4 []) ()) Add (IntegerConstant 1 (Integer 4 [])) (Integer 4 []) ()) ()) (= (DerivedRef (Var 4 a) 2 y (Real 4 []) ()) (RealBinOp (DerivedRef (Var 4 a) 2 y (Real 4 []) ()) Add (Cast (IntegerConstant 1 (Integer 4 [])) IntegerToReal (Real 4 []) ()) (Real 4 []) ()) ())] Source Public Implementation () .false. .false.), f: (Subroutine (SymbolTable 3 {a: (Variable 3 a In () () Default (Derived 1 A []) Source Public Required .false.)}) f [(Var 3 a)] [(Print () [(DerivedRef (Var 3 a) 2 x (Integer 4 []) ())]) (Print () [(DerivedRef (Var 3 a) 2 y (Real 4 []) ())])] Source Public Implementation () .false. .false.), g: (Subroutine (SymbolTable 5 {x: (Variable 5 x Local () () Default (Derived 1 A []) Source Public Required .false.)}) g [] [(= (Var 5 x) (DerivedTypeConstructor 1 A [(Cast (RealConstant   3.25000000000000000e+00 (Real 8 [])) RealToReal (Real 4 []) (RealConstant   3.25000000000000000e+00 (Real 4 []))) (IntegerConstant 3 (Integer 4 []))] (Derived 1 A []) ()) ()) (SubroutineCall 1 f () [((Var 5 x))] ()) (Assert (Compare (DerivedRef (Var 5 x) 2 x (Integer 4 []) ()) Eq (IntegerConstant 3 (Integer 4 [])) (Logical 4 []) () ()) ()) (Assert (Compare (Cast (DerivedRef (Var 5 x) 2 y (Real 4 []) ()) RealToReal (Real 8 []) ()) Eq (RealConstant   3.25000000000000000e+00 (Real 8 [])) (Logical 4 []) () ()) ()) (= (DerivedRef (Var 5 x) 2 x (Integer 4 []) ()) (IntegerConstant 5 (Integer 4 [])) ()) (= (DerivedRef (Var 5 x) 2 y (Real 4 []) ()) (Cast (RealConstant   5.50000000000000000e+00 (Real 8 [])) RealToReal (Real 4 []) (RealConstant   5.50000000000000000e+00 (Real 4 []))) ()) (SubroutineCall 1 f () [((Var 5 x))] ()) (Assert (Compare (DerivedRef (Var 5 x) 2 x (Integer 4 []) ()) Eq (IntegerConstant 5 (Integer 4 [])) (Logical 4 []) () ()) ()) (Assert (Compare (Cast (DerivedRef (Var 5 x) 2 y (Real 4 []) ()) RealToReal (Real 8 []) ()) Eq (RealConstant   5.50000000000000000e+00 (Real 8 [])) (Logical 4 []) () ()) ()) (SubroutineCall 1 change_struct () [((Var 5 x))] ()) (Assert (Compare (DerivedRef (Var 5 x) 2 x (Integer 4 []) ()) Eq (IntegerConstant 6 (Integer 4 [])) (Logical 4 []) () ()) ()) (Assert (Compare (Cast (DerivedRef (Var 5 x) 2 y (Real 4 []) ()) RealToReal (Real 8 []) ()) Eq (RealConstant   6.50000000000000000e+00 (Real 8 [])) (Logical 4 []) () ()) ())] Source Public Implementation () .false. .false.), main_program: (Program (SymbolTable 6 {}) main_program [] [(SubroutineCall 1 _lpython_main_program () [] ())])}) [])