Implement storage access via storage keyword

sway-core/src/asm_generation/from_ir.rs

@@ -1514,7 +1514,7 @@ impl<'ir> AsmBuilder<'ir> {
                 self.bytecode.push(Op {
                     opcode: Either::Left(match access_type {
                         StateAccessType::Read => VirtualOp::SRWQ(val_reg, key_reg),
-                        StateAccessType::Write => VirtualOp::SWWQ(val_reg, key_reg),
+                        StateAccessType::Write => VirtualOp::SWWQ(key_reg, val_reg),
                     }),
                     comment: "quad word state access".into(),
                     owning_span: instr_val.get_span(self.context),
@@ -1604,7 +1604,7 @@ impl<'ir> AsmBuilder<'ir> {
                 );
 
                 self.bytecode.push(Op {
-                    opcode: Either::Left(VirtualOp::SWW(store_reg, key_reg)),
+                    opcode: Either::Left(VirtualOp::SWW(key_reg, store_reg)),
                     comment: "single word state access".into(),
                     owning_span: instr_val.get_span(self.context),
                 });

sway-core/src/constants.rs

@@ -7,6 +7,9 @@ pub const LANGUAGE_NAME: &str = "Sway";
 /// The size, in bytes, of a single word in the FuelVM.
 pub const VM_WORD_SIZE: u64 = 8;
 
+// Keywords
+pub const INVALID_NAMES: &[&str] = &["storage"];
+
 pub const CONTRACT_CALL_GAS_PARAMETER_NAME: &str = "gas";
 
 pub const CONTRACT_CALL_COINS_PARAMETER_NAME: &str = "coins";

sway-core/src/control_flow_analysis/analyze_return_paths.rs

@@ -186,6 +186,7 @@ fn connect_declaration(
         | AbiDeclaration(_)
         | StructDeclaration(_)
         | EnumDeclaration(_)
+        | StorageDeclaration(_)
         | GenericTypeForFunctionScope { .. } => leaves.to_vec(),
         VariableDeclaration(_) | ConstantDeclaration(_) => {
             let entry_node = graph.add_node(node.into());

sway-core/src/control_flow_analysis/dead_code_analysis.rs

@@ -17,6 +17,8 @@ use crate::{
 };
 use sway_types::span::Span;
 
+use crate::semantic_analysis::TypedStorageDeclaration;
+
 use petgraph::algo::has_path_connecting;
 use petgraph::prelude::NodeIndex;
 
@@ -78,6 +80,10 @@ impl ControlFlowGraph {
                     span: span.clone(),
                     warning_content: Warning::StructFieldNeverRead,
                 }),
+                ControlFlowGraphNode::StorageField { field_name, .. } => Some(CompileWarning {
+                    span: field_name.span().clone(),
+                    warning_content: Warning::DeadStorageDeclaration,
+                }),
                 ControlFlowGraphNode::OrganizationalDominator(..) => None,
             })
             .collect::<Vec<_>>();
@@ -393,6 +399,10 @@ fn connect_declaration(
             connect_impl_trait(trait_name, graph, methods, entry_node, tree_type)?;
             Ok(leaves.to_vec())
         }
+        StorageDeclaration(storage) => {
+            connect_storage_declaration(storage, graph, entry_node, tree_type);
+            Ok(leaves.to_vec())
+        }
         ErrorRecovery | GenericTypeForFunctionScope { .. } => Ok(leaves.to_vec()),
     }
 }
@@ -983,17 +993,19 @@ fn connect_expression(
             )?;
             Ok(prefix_idx)
         }
-        StorageAccess(_fields) => {
-            // Enable the code below once the storage declaration is added to the namespace
-            /*let storage_node = graph.namespace.storage.get(&fields.field_name()).cloned();
-            let this_ix =
-                graph.add_node(format!("storage field access: {}", fields.field_name()).into());
+        StorageAccess(fields) => {
+            let storage_node = graph
+                .namespace
+                .storage
+                .get(&fields.storage_field_name())
+                .cloned();
+            let this_ix = graph
+                .add_node(format!("storage field access: {}", fields.storage_field_name()).into());
             for leaf in leaves {
                 storage_node.map(|x| graph.add_edge(*leaf, x, "".into()));
                 graph.add_edge(*leaf, this_ix, "".into());
             }
-            Ok(vec![this_ix])*/
-            Ok(vec![])
+            Ok(vec![this_ix])
         }
         SizeOf { variant } => match variant {
             SizeOfVariant::Type(_) => Ok(vec![]),
@@ -1159,3 +1171,19 @@ fn construct_dead_code_warning_from_node(node: &TypedAstNode) -> Option<CompileW
         },
     })
 }
+
+fn connect_storage_declaration(
+    decl: &TypedStorageDeclaration,
+    graph: &mut ControlFlowGraph,
+    _entry_node: NodeIndex,
+    _tree_type: &TreeType,
+) {
+    let TypedStorageDeclaration { fields, .. } = decl;
+
+    let field_nodes = fields
+        .iter()
+        .map(|field| (field.clone(), graph.add_node(field.into())))
+        .collect::<Vec<_>>();
+
+    graph.namespace.insert_storage(field_nodes);
+}

sway-core/src/control_flow_analysis/flow_graph/mod.rs

@@ -11,6 +11,7 @@ use sway_types::span::Span;
 use petgraph::{graph::EdgeIndex, prelude::NodeIndex};
 
 mod namespace;
+use crate::semantic_analysis::declaration::TypedStorageField;
 use namespace::ControlFlowNamespace;
 pub(crate) use namespace::FunctionNamespaceEntry;
 
@@ -63,6 +64,9 @@ pub enum ControlFlowGraphNode {
         struct_field_name: Ident,
         span: Span,
     },
+    StorageField {
+        field_name: Ident,
+    },
 }
 
 impl std::fmt::Debug for ControlFlowGraphNode {
@@ -81,10 +85,20 @@ impl std::fmt::Debug for ControlFlowGraphNode {
             } => {
                 format!("Struct field {}", struct_field_name.as_str())
             }
+            ControlFlowGraphNode::StorageField { field_name } => {
+                format!("Storage field {}", field_name.as_str())
+            }
         };
         f.write_str(&text)
     }
 }
+impl std::convert::From<&TypedStorageField> for ControlFlowGraphNode {
+    fn from(other: &TypedStorageField) -> Self {
+        ControlFlowGraphNode::StorageField {
+            field_name: other.name.clone(),
+        }
+    }
+}
 
 impl std::convert::From<&TypedAstNode> for ControlFlowGraphNode {
     fn from(other: &TypedAstNode) -> Self {

sway-core/src/control_flow_analysis/flow_graph/namespace.rs

@@ -1,5 +1,6 @@
 use super::{EntryPoint, ExitPoint};
 use crate::parse_tree::CallPath;
+use crate::semantic_analysis::declaration::TypedStorageField;
 use crate::type_engine::TypeInfo;
 use crate::Ident;
 use petgraph::prelude::NodeIndex;
@@ -38,6 +39,7 @@ pub struct ControlFlowNamespace {
     /// TODO this should be an Ident and not a String, switch when static spans are implemented
     pub(crate) struct_namespace: HashMap<String, StructNamespaceEntry>,
     pub(crate) const_namespace: HashMap<Ident, NodeIndex>,
+    pub(crate) storage: HashMap<Ident, NodeIndex>,
 }
 
 impl ControlFlowNamespace {
@@ -113,6 +115,12 @@ impl ControlFlowNamespace {
         }
     }
 
+    pub(crate) fn insert_storage(&mut self, field_nodes: Vec<(TypedStorageField, NodeIndex)>) {
+        for (field, node) in field_nodes {
+            self.storage.insert(field.name, node);
+        }
+    }
+
     pub(crate) fn insert_struct(
         &mut self,
         struct_name: String,

sway-core/src/error.rs

@@ -274,6 +274,7 @@ pub enum Warning {
     ShadowingReservedRegister {
         reg_name: Ident,
     },
+    DeadStorageDeclaration,
     MatchExpressionUnreachableArm,
 }
 
@@ -380,6 +381,8 @@ impl fmt::Display for Warning {
                 "This register declaration shadows the reserved register, \"{}\".",
                 reg_name
             ),
+            DeadStorageDeclaration => write!(f, "This storage declaration is never accessed and can be removed."
+            ),
             MatchExpressionUnreachableArm => write!(f, "This match arm is unreachable."),
         }
     }
@@ -891,6 +894,14 @@ pub enum CompileError {
     UnrecognizedContractParam { param_name: String, span: Span },
     #[error("Attempting to specify a contract method parameter for a non-contract function call")]
     CallParamForNonContractCallMethod { span: Span },
+    #[error("Storage field {name} does not exist")]
+    StorageFieldDoesNotExist { name: String, span: Span },
+    #[error("No storage has been declared")]
+    NoDeclaredStorage { span: Span },
+    #[error("Multiple storage declarations were found")]
+    MultipleStorageDeclarations { span: Span },
+    #[error("Expected identifier, found keyword \"{name}\" ")]
+    InvalidVariableName { name: String, span: Span },
 }
 
 impl std::convert::From<TypeError> for CompileError {
@@ -1099,6 +1110,10 @@ impl CompileError {
             ContractCallParamRepeated { span, .. } => span,
             UnrecognizedContractParam { span, .. } => span,
             CallParamForNonContractCallMethod { span, .. } => span,
+            StorageFieldDoesNotExist { span, .. } => span,
+            NoDeclaredStorage { span, .. } => span,
+            MultipleStorageDeclarations { span, .. } => span,
+            InvalidVariableName { span, .. } => span,
         }
     }
 

sway-core/src/optimize.rs

@@ -207,6 +207,7 @@ fn compile_declarations(
             | TypedDeclaration::StorageReassignment(_)
             | TypedDeclaration::AbiDeclaration(_)
             | TypedDeclaration::GenericTypeForFunctionScope { .. }
+            | TypedDeclaration::StorageDeclaration(_)
             | TypedDeclaration::ErrorRecovery => (),
         }
     }
@@ -576,6 +577,9 @@ impl FnCompiler {
                             Err("gen ty for fn scope".into())
                         }
                         TypedDeclaration::ErrorRecovery { .. } => Err("error recovery".into()),
+                        TypedDeclaration::StorageDeclaration(_) => {
+                            Err("storage declaration".into())
+                        }
                     },
                     TypedAstNodeContent::Expression(te) => {
                         // An expression with an ignored return value... I assume.
@@ -2230,6 +2234,7 @@ fn convert_resolved_type(
         TypeInfo::UnknownGeneric { .. } => return Err("unknowngeneric type found in AST..?".into()),
         TypeInfo::Ref(_) => return Err("ref type found in AST..?".into()),
         TypeInfo::ErrorRecovery => return Err("error recovery type found in AST..?".into()),
+        TypeInfo::Storage { .. } => return Err("storage type found in AST..?".into()),
     })
 }