Error out when Vec is used in a storage block (FuelLabs#3777)

This PR creates an error when `Vec` is used in a `storage` block by checking for instances in `raw_ptr`. Right now there is only one simple test, so I can add more if you feel it necessary. Closes FuelLabs#3305 Co-authored-by: emilyaherbert <[email protected]>
Kewe63 · Jan 14, 2023 · 7c95013 · 7c95013
1 parent 22ffb20
commit 7c95013
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 3 deletions.
diff --git a/sway-ast/src/item/item_storage.rs b/sway-ast/src/item/item_storage.rs
@@ -20,3 +20,15 @@ pub struct StorageField {
     pub eq_token: EqToken,
     pub initializer: Expr,
 }
+
+impl Spanned for StorageField {
+    fn span(&self) -> Span {
+        Span::join_all([
+            self.name.span(),
+            self.colon_token.span(),
+            self.ty.span(),
+            self.eq_token.span(),
+            self.initializer.span(),
+        ])
+    }
+}
diff --git a/sway-core/src/language/parsed/declaration/storage.rs b/sway-core/src/language/parsed/declaration/storage.rs
@@ -20,5 +20,6 @@ pub struct StorageField {
     pub attributes: transform::AttributesMap,
     pub type_info: TypeInfo,
     pub type_info_span: Span,
+    pub span: Span,
     pub initializer: Expression,
 }
diff --git a/sway-core/src/language/ty/program.rs b/sway-core/src/language/ty/program.rs
@@ -155,7 +155,37 @@ impl TyProgram {
 
         // Perform other validation based on the tree type.
         let typed_program_kind = match kind {
-            parsed::TreeType::Contract => TyProgramKind::Contract { abi_entries },
+            parsed::TreeType::Contract => {
+                // Types containing raw_ptr are not allowed in storage (e.g Vec)
+                for decl in declarations.iter() {
+                    if let TyDeclaration::StorageDeclaration(decl_id) = decl {
+                        if let Ok(storage_decl) =
+                            decl_engine.get_storage(decl_id.clone(), &decl_id.span())
+                        {
+                            for field in storage_decl.fields.iter() {
+                                let type_info = ty_engine.get(field.type_id);
+                                let type_info_str = engines.help_out(&type_info).to_string();
+                                let raw_ptr_type = type_info
+                                    .extract_nested_types(ty_engine, &field.span)
+                                    .value
+                                    .and_then(|value| {
+                                        value
+                                            .into_iter()
+                                            .find(|ty| matches!(ty, TypeInfo::RawUntypedPtr))
+                                    });
+                                if raw_ptr_type.is_some() {
+                                    errors.push(CompileError::TypeNotAllowedInContractStorage {
+                                        ty: type_info_str,
+                                        span: field.span.clone(),
+                                    });
+                                }
+                            }
+                        }
+                    }
+                }
+
+                TyProgramKind::Contract { abi_entries }
+            }
             parsed::TreeType::Library { name } => TyProgramKind::Library { name },
             parsed::TreeType::Predicate => {
                 // A predicate must have a main function and that function must return a boolean.

diff --git a/sway-core/src/semantic_analysis/ast_node/declaration/declaration.rs b/sway-core/src/semantic_analysis/ast_node/declaration/declaration.rs
@@ -309,6 +309,7 @@ impl ty::TyDeclaration {
                     initializer,
                     type_info_span,
                     attributes,
+                    span: field_span,
                     ..
                 } in fields
                 {
@@ -336,7 +337,7 @@ impl ty::TyDeclaration {
                         type_id,
                         type_span: type_info_span,
                         initializer,
-                        span: span.clone(),
+                        span: field_span,
                         attributes,
                     });
                 }

diff --git a/sway-core/src/transform/to_parsed_lang/convert_parse_tree.rs b/sway-core/src/transform/to_parsed_lang/convert_parse_tree.rs
@@ -1864,11 +1864,13 @@ fn storage_field_to_storage_field(
     } else {
         storage_field.ty.span()
     };
+    let span = storage_field.span();
     let storage_field = StorageField {
         attributes,
         name: storage_field.name,
         type_info: ty_to_type_info(handler, engines, storage_field.ty)?,
         type_info_span,
+        span,
         initializer: expr_to_expression(handler, engines, storage_field.initializer)?,
     };
     Ok(storage_field)

diff --git a/sway-error/src/error.rs b/sway-error/src/error.rs
@@ -674,6 +674,8 @@ pub enum CompileError {
     ConfigTimeConstantNotAConstDecl { span: Span },
     #[error("Configuration-time constant value is not a literal.")]
     ConfigTimeConstantNotALiteral { span: Span },
+    #[error("The type \"{ty}\" is not allowed in storage.")]
+    TypeNotAllowedInContractStorage { ty: String, span: Span },
     #[error("ref mut parameter not allowed for main()")]
     RefMutableNotAllowedInMain { param_name: Ident },
     #[error("Returning a `raw_ptr` from `main()` is not allowed.")]
@@ -889,6 +891,7 @@ impl Spanned for CompileError {
             ContinueOutsideLoop { span } => span.clone(),
             ConfigTimeConstantNotAConstDecl { span } => span.clone(),
             ConfigTimeConstantNotALiteral { span } => span.clone(),
+            TypeNotAllowedInContractStorage { span, .. } => span.clone(),
             RefMutableNotAllowedInMain { param_name } => param_name.span(),
             PointerReturnNotAllowedInMain { span } => span.clone(),
             NestedSliceReturnNotAllowedInMain { span } => span.clone(),

diff --git a/test/src/e2e_vm_tests/test_programs/should_fail/storage_types/src/main.sw b/test/src/e2e_vm_tests/test_programs/should_fail/storage_types/src/main.sw
@@ -12,6 +12,7 @@ storage {
     v: StorageVec<u64> = StorageVec {},
     u: StorageVec<StorageVec<u64>> = StorageVec {},
     map1: StorageMap<u32, u32> = StorageMap{},
+    bad_type: StorageVec<Vec<bool>> = StorageVec {},
 }
 
 abi MyContract {

diff --git a/test/src/e2e_vm_tests/test_programs/should_fail/storage_types/test.toml b/test/src/e2e_vm_tests/test_programs/should_fail/storage_types/test.toml
@@ -39,4 +39,8 @@ category = "fail"
 
 # check: $()error
 # check: $()fn insert(mapping: StorageMap<u64, u64>) {
-# nextln: $()Type StorageMap<u64, u64> can only be declared directly as a storage field
+# nextln: $()Type StorageMap<u64, u64> can only be declared directly as a storage field
+
+# check: $()error
+# check: $()bad_type: StorageVec<Vec<bool>> = StorageVec {},
+# nextln: $()The type "StorageVec<Vec<bool>>" is not allowed in storage.