compile string constants to global rather than local memory (#7359)

In situations such as in the newly added test (taken from the fuels-rs
repo), without this change, we end up returning a pointer to local
memory.

Author: vaivaswatha

forc-plugins/forc-client/tests/deploy.rs

@@ -377,7 +377,7 @@ async fn test_simple_deploy() {
     node.kill().unwrap();
     let expected = vec![DeployedPackage::Contract(DeployedContract {
         id: ContractId::from_str(
-            "440b559604961bdbeaa31421823f34e45d246b5d139aa4886e5e1cf2901fc925",
+            "cd3c03c273d48ff262ee7caae1b8e3f98d4b0fd61eeb4ba65ad5c761c13e7197",
         )
         .unwrap(),
         proxy: None,
@@ -421,7 +421,7 @@ async fn test_deploy_submit_only() {
     node.kill().unwrap();
     let expected = vec![DeployedPackage::Contract(DeployedContract {
         id: ContractId::from_str(
-            "440b559604961bdbeaa31421823f34e45d246b5d139aa4886e5e1cf2901fc925",
+            "cd3c03c273d48ff262ee7caae1b8e3f98d4b0fd61eeb4ba65ad5c761c13e7197",
         )
         .unwrap(),
         proxy: None,
@@ -468,12 +468,12 @@ async fn test_deploy_fresh_proxy() {
     node.kill().unwrap();
     let impl_contract = DeployedPackage::Contract(DeployedContract {
         id: ContractId::from_str(
-            "440b559604961bdbeaa31421823f34e45d246b5d139aa4886e5e1cf2901fc925",
+            "cd3c03c273d48ff262ee7caae1b8e3f98d4b0fd61eeb4ba65ad5c761c13e7197",
         )
         .unwrap(),
         proxy: Some(
             ContractId::from_str(
-                "19d465200575ebd085300242002efcda38db99e22449a5c1346588efe9ced7f7",
+                "76cda1ee36cd11066bc858b4ef2bb32024ef16c338a612ca0fe102c0c31d5b5c",
             )
             .unwrap(),
         ),

forc/tests/cli_integration.rs

@@ -51,10 +51,10 @@ fn test_forc_test_raw_logs() -> Result<(), rexpect::error::Error> {
     // Assert that the output is correct
     process.exp_string("      test test_log_4")?;
     process.exp_string("raw logs:")?;
-    process.exp_string(r#"[{"LogData":{"data":"0000000000000004","digest":"8005f02d43fa06e7d0585fb64c961d57e318b27a145c857bcd3a6bdb413ff7fc","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12456,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
+    process.exp_string(r#"[{"LogData":{"data":"0000000000000004","digest":"8005f02d43fa06e7d0585fb64c961d57e318b27a145c857bcd3a6bdb413ff7fc","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12448,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
     process.exp_string("      test test_log_2")?;
     process.exp_string("raw logs:")?;
-    process.exp_string(r#"[{"LogData":{"data":"0000000000000002","digest":"cd04a4754498e06db5a13c5f371f1f04ff6d2470f24aa9bd886540e5dce77f70","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12456,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
+    process.exp_string(r#"[{"LogData":{"data":"0000000000000002","digest":"cd04a4754498e06db5a13c5f371f1f04ff6d2470f24aa9bd886540e5dce77f70","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12448,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
 
     process.process.exit()?;
     Ok(())
@@ -77,12 +77,12 @@ fn test_forc_test_both_logs() -> Result<(), rexpect::error::Error> {
     process.exp_string("decoded log values:")?;
     process.exp_string("4, log rb: 1515152261580153489")?;
     process.exp_string("raw logs:")?;
-    process.exp_string(r#"[{"LogData":{"data":"0000000000000004","digest":"8005f02d43fa06e7d0585fb64c961d57e318b27a145c857bcd3a6bdb413ff7fc","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12456,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
+    process.exp_string(r#"[{"LogData":{"data":"0000000000000004","digest":"8005f02d43fa06e7d0585fb64c961d57e318b27a145c857bcd3a6bdb413ff7fc","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12448,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
     process.exp_string("      test test_log_2")?;
     process.exp_string("decoded log values:")?;
     process.exp_string("2, log rb: 1515152261580153489")?;
     process.exp_string("raw logs:")?;
-    process.exp_string(r#"[{"LogData":{"data":"0000000000000002","digest":"cd04a4754498e06db5a13c5f371f1f04ff6d2470f24aa9bd886540e5dce77f70","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12456,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
+    process.exp_string(r#"[{"LogData":{"data":"0000000000000002","digest":"cd04a4754498e06db5a13c5f371f1f04ff6d2470f24aa9bd886540e5dce77f70","id":"0000000000000000000000000000000000000000000000000000000000000000","is":10368,"len":8,"pc":12448,"ptr":67107840,"ra":0,"rb":1515152261580153489}}]"#)?;
     process.process.exit()?;
     Ok(())
 }

sway-core/src/ir_generation/function.rs

@@ -541,12 +541,22 @@ impl<'a> FnCompiler<'a> {
         match &ast_expr.expression {
             ty::TyExpressionVariant::Literal(Literal::String(s)) => {
                 let string_data =
-                    ConstantContent::get_string(context, s.as_str().as_bytes().to_vec());
-                let string_data_ptr =
-                    store_to_memory(self, context, CompiledValue::InRegister(string_data))?
-                        .expect_memory();
+                    ConstantContent::get_string(context, s.as_str().as_bytes().to_vec())
+                        .get_constant(context)
+                        .unwrap();
+                let string_data_ptr = self.module.new_unique_global_var(
+                    context,
+                    "__const_global".into(),
+                    string_data.get_content(context).ty,
+                    Some(*string_data),
+                    false,
+                );
+                let string_ptr = self
+                    .current_block
+                    .append(context)
+                    .get_global(string_data_ptr);
                 let string_len = s.as_str().len() as u64;
-                self.compile_string_slice(context, span_md_idx, string_data_ptr, string_len)
+                self.compile_string_slice(context, span_md_idx, string_ptr, string_len)
             }
             ty::TyExpressionVariant::Literal(Literal::Numeric(n)) => {
                 let implied_lit = match &*self.engines.te().get(ast_expr.return_type) {

sway-ir/src/module.rs

@@ -85,6 +85,42 @@ impl Module {
             .insert(call_path, const_val);
     }
 
+    /// Add a value to the module global storage, by forcing the name to be unique if needed.
+    ///
+    /// Will use the provided name as a hint and eventually rename it to guarantee insertion.
+    pub fn new_unique_global_var(
+        &self,
+        context: &mut Context,
+        name: String,
+        local_type: Type,
+        initializer: Option<Constant>,
+        mutable: bool,
+    ) -> GlobalVar {
+        let module = &context.modules[self.0];
+        let new_name = if module.global_variables.contains_key(&vec![name.clone()]) {
+            // Assuming that we'll eventually find a unique name by appending numbers to the old
+            // one...
+            (0..)
+                .find_map(|n| {
+                    let candidate = format!("{name}{n}");
+                    if module
+                        .global_variables
+                        .contains_key(&vec![candidate.clone()])
+                    {
+                        None
+                    } else {
+                        Some(candidate)
+                    }
+                })
+                .unwrap()
+        } else {
+            name
+        };
+        let gv = GlobalVar::new(context, local_type, initializer, mutable);
+        self.add_global_variable(context, vec![new_name], gv);
+        gv
+    }
+
     /// Get a named global variable from this module, if found.
     pub fn get_global_variable(
         &self,

test/src/e2e_vm_tests/test_programs/should_pass/language/attributes_deprecated/stdout.snap

@@ -1,5 +1,6 @@
 ---
 source: test/src/snapshot/mod.rs
+assertion_line: 162
 ---
 > forc build --path test/src/e2e_vm_tests/test_programs/should_pass/language/attributes_deprecated --release
 exit status: 0
@@ -182,4 +183,4 @@ warning: Function is deprecated
 ____
 
   Compiled contract "attributes_deprecated" with 19 warnings.
-    Finished release [optimized + fuel] target(s) [920 B] in ???
+    Finished release [optimized + fuel] target(s) [880 B] in ???

test/src/e2e_vm_tests/test_programs/should_pass/language/configurable_consts/json_abi_oracle_new_encoding.json

@@ -63,97 +63,97 @@
       "concreteTypeId": "b760f44fa5965c2474a3b471467a22c43185152129295af588b022ae50b50903",
       "indirect": false,
       "name": "BOOL",
-      "offset": 4928
+      "offset": 4912
     },
     {
       "concreteTypeId": "c89951a24c6ca28c13fd1cfdc646b2b656d69e61a92b91023be7eb58eb914b6b",
       "indirect": false,
       "name": "U8",
-      "offset": 5120
+      "offset": 5104
     },
     {
       "concreteTypeId": "c89951a24c6ca28c13fd1cfdc646b2b656d69e61a92b91023be7eb58eb914b6b",
       "indirect": false,
       "name": "ANOTHER_U8",
-      "offset": 4856
+      "offset": 4840
     },
     {
       "concreteTypeId": "29881aad8730c5ab11d275376323d8e4ff4179aae8ccb6c13fe4902137e162ef",
       "indirect": false,
       "name": "U16",
-      "offset": 5064
+      "offset": 5048
     },
     {
       "concreteTypeId": "d7649d428b9ff33d188ecbf38a7e4d8fd167fa01b2e10fe9a8f9308e52f1d7cc",
       "indirect": false,
       "name": "U32",
-      "offset": 5104
+      "offset": 5088
     },
     {
       "concreteTypeId": "d7649d428b9ff33d188ecbf38a7e4d8fd167fa01b2e10fe9a8f9308e52f1d7cc",
       "indirect": false,
       "name": "U64",
-      "offset": 5112
+      "offset": 5096
     },
     {
       "concreteTypeId": "1b5759d94094368cfd443019e7ca5ec4074300e544e5ea993a979f5da627261e",
       "indirect": false,
       "name": "U256",
-      "offset": 5072
+      "offset": 5056
     },
     {
       "concreteTypeId": "7c5ee1cecf5f8eacd1284feb5f0bf2bdea533a51e2f0c9aabe9236d335989f3b",
       "indirect": false,
       "name": "B256",
-      "offset": 4896
+      "offset": 4880
     },
     {
       "concreteTypeId": "81fc10c4681a3271cf2d66b2ec6fbc8ed007a442652930844fcf11818c295bff",
       "indirect": false,
       "name": "CONFIGURABLE_STRUCT",
-      "offset": 5016
+      "offset": 5000
     },
     {
       "concreteTypeId": "a2922861f03be8a650595dd76455b95383a61b46dd418f02607fa2e00dc39d5c",
       "indirect": false,
       "name": "CONFIGURABLE_ENUM_A",
-      "offset": 4936
+      "offset": 4920
     },
     {
       "concreteTypeId": "a2922861f03be8a650595dd76455b95383a61b46dd418f02607fa2e00dc39d5c",
       "indirect": false,
       "name": "CONFIGURABLE_ENUM_B",
-      "offset": 4976
+      "offset": 4960
     },
     {
       "concreteTypeId": "4926d35d1a5157936b0a29bc126b8aace6d911209a5c130e9b716b0c73643ea6",
       "indirect": false,
       "name": "ARRAY_BOOL",
-      "offset": 4864
+      "offset": 4848
     },
     {
       "concreteTypeId": "776fb5a3824169d6736138565fdc20aad684d9111266a5ff6d5c675280b7e199",
       "indirect": false,
       "name": "ARRAY_U64",
-      "offset": 4872
+      "offset": 4856
     },
     {
       "concreteTypeId": "c998ca9a5f221fe7b5c66ae70c8a9562b86d964408b00d17f883c906bc1fe4be",
       "indirect": false,
       "name": "TUPLE_BOOL_U64",
-      "offset": 5048
+      "offset": 5032
     },
     {
       "concreteTypeId": "94f0fa95c830be5e4f711963e83259fe7e8bc723278ab6ec34449e791a99b53a",
       "indirect": false,
       "name": "STR_4",
-      "offset": 5040
+      "offset": 5024
     },
     {
       "concreteTypeId": "c89951a24c6ca28c13fd1cfdc646b2b656d69e61a92b91023be7eb58eb914b6b",
       "indirect": false,
       "name": "NOT_USED",
-      "offset": 5032
+      "offset": 5016
     }
   ],
   "encodingVersion": "1",

test/src/e2e_vm_tests/test_programs/should_pass/language/const_generics/stdout.snap

@@ -444,12 +444,12 @@ warning
 ____
 
   Compiled script "const_generics" with 2 warnings.
-    Finished debug [unoptimized + fuel] target(s) [9.536 KB] in ???
+    Finished debug [unoptimized + fuel] target(s) [8.8 KB] in ???
      Running 1 test, filtered 0 tests
 
 tested -- const_generics
 
-      test run_main ... ok (???, 17350 gas)
+      test run_main ... ok (???, 17159 gas)
            debug output:
 [src/main.sw:105:13] a = [1, 2]
 [src/main.sw:109:13] [C {}].len() = 1

test/src/e2e_vm_tests/test_programs/should_pass/language/intrinsics/dbg/stdout.snap

@@ -72,12 +72,12 @@ output:
     Building test/src/e2e_vm_tests/test_programs/should_pass/language/intrinsics/dbg
    Compiling library std (sway-lib-std)
    Compiling script dbg (test/src/e2e_vm_tests/test_programs/should_pass/language/intrinsics/dbg)
-    Finished debug [unoptimized + fuel] target(s) [42.456 KB] in ???
+    Finished debug [unoptimized + fuel] target(s) [38.584 KB] in ???
      Running 1 test, filtered 0 tests
 
 tested -- dbg
 
-      test call_main ... ok (???, 122721 gas)
+      test call_main ... ok (???, 121555 gas)
            debug output:
 [src/main.sw:13:13] () = ()
 [src/main.sw:15:13] true = true

test/src/e2e_vm_tests/test_programs/should_pass/language/intrinsics/dbg_release/stdout.snap

@@ -19,12 +19,12 @@ ecal $r1 $r0 $zero $zero      ; ecal id fd zero zero
 ecal $r4 $r0 $r1 $r3          ; ecal id fd buf count
 
 > forc build --path test/src/e2e_vm_tests/test_programs/should_pass/language/intrinsics/dbg_release --release --asm final | sub ecal
-ecal $r4 $r5 $r0 $r3          ; ecal id fd buf count
+ecal $r2 $r3 $r0 $r1          ; ecal id fd buf count
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero
-ecal $r3 $r4 $r0 $r2          ; ecal id fd buf count
+ecal $r2 $r3 $r0 $r1          ; ecal id fd buf count
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero
 ecal $r0 $r1 $zero $zero      ; ecal id fd zero zero