Merge branch 'feature/memory-metering' of github.com:onflow/cadence i…

…nto memory-kind-last
onflow · Apr 6, 2022 · 2145b20 · 2145b20
2 parents 84d30e0 + b8efa6a
commit 2145b20
Show file tree

Hide file tree

Showing 33 changed files with 625 additions and 254 deletions.
diff --git a/runtime/ast/block.go b/runtime/ast/block.go
@@ -110,6 +110,20 @@ type FunctionBlock struct {
 	PostConditions *Conditions `json:",omitempty"`
 }
 
+func NewFunctionBlock(
+	memoryGauge common.MemoryGauge,
+	block *Block,
+	preConditions *Conditions,
+	postConditions *Conditions,
+) *FunctionBlock {
+	common.UseMemory(memoryGauge, common.FunctionBlockMemoryUsage)
+	return &FunctionBlock{
+		Block:          block,
+		PreConditions:  preConditions,
+		PostConditions: postConditions,
+	}
+}
+
 func (b *FunctionBlock) IsEmpty() bool {
 	return b == nil ||
 		(b.Block.IsEmpty() &&

diff --git a/runtime/ast/composite_test.go b/runtime/ast/composite_test.go
@@ -113,7 +113,7 @@ func TestCompositeDeclaration_MarshalJSON(t *testing.T) {
 				},
 			},
 		},
-		Members:   NewMembers([]Declaration{}),
+		Members:   NewUnmeteredMembers([]Declaration{}),
 		DocString: "test",
 		Range: Range{
 			StartPos: Position{Offset: 7, Line: 8, Column: 9},

diff --git a/runtime/ast/interface_test.go b/runtime/ast/interface_test.go
@@ -39,7 +39,7 @@ func TestInterfaceDeclaration_MarshalJSON(t *testing.T) {
 			Identifier: "AB",
 			Pos:        Position{Offset: 1, Line: 2, Column: 3},
 		},
-		Members:   NewMembers([]Declaration{}),
+		Members:   NewUnmeteredMembers([]Declaration{}),
 		DocString: "test",
 		Range: Range{
 			StartPos: Position{Offset: 7, Line: 8, Column: 9},

diff --git a/runtime/ast/memberindices_test.go b/runtime/ast/memberindices_test.go
@@ -87,7 +87,7 @@ func TestMemberIndices(t *testing.T) {
 		Identifier: Identifier{Identifier: "C"},
 	}
 
-	members := NewMembers(
+	members := NewUnmeteredMembers(
 		[]Declaration{
 			specialFunctionB,
 			enumCaseA,

diff --git a/runtime/ast/members.go b/runtime/ast/members.go
@@ -31,7 +31,12 @@ type Members struct {
 	indices      memberIndices
 }
 
-func NewMembers(declarations []Declaration) *Members {
+func NewMembers(memoryGauge common.MemoryGauge, declarations []Declaration) *Members {
+	common.UseMemory(memoryGauge, common.NewMembersMemoryUsage(len(declarations)))
+	return NewUnmeteredMembers(declarations)
+}
+
+func NewUnmeteredMembers(declarations []Declaration) *Members {
 	return &Members{
 		declarations: declarations,
 	}

diff --git a/runtime/ast/members_test.go b/runtime/ast/members_test.go
@@ -30,7 +30,7 @@ func TestMembers_MarshalJSON(t *testing.T) {
 
 	t.Parallel()
 
-	members := NewMembers([]Declaration{})
+	members := NewUnmeteredMembers([]Declaration{})
 
 	actual, err := json.Marshal(members)
 	require.NoError(t, err)

diff --git a/runtime/ast/parameter.go b/runtime/ast/parameter.go
@@ -18,13 +18,31 @@
 
 package ast
 
+import "github.com/onflow/cadence/runtime/common"
+
 type Parameter struct {
 	Label          string
 	Identifier     Identifier
 	TypeAnnotation *TypeAnnotation
 	Range
 }
 
+func NewParameter(
+	gauge common.MemoryGauge,
+	label string,
+	identifier Identifier,
+	typeAnnotation *TypeAnnotation,
+	astRange Range,
+) *Parameter {
+	common.UseMemory(gauge, common.ParameterMemoryUsage)
+	return &Parameter{
+		Label:          label,
+		Identifier:     identifier,
+		TypeAnnotation: typeAnnotation,
+		Range:          astRange,
+	}
+}
+
 // EffectiveArgumentLabel returns the effective argument label that
 // an argument in a call must use:
 // If no argument label is declared for parameter,

diff --git a/runtime/ast/parameterlist.go b/runtime/ast/parameterlist.go
@@ -18,7 +18,11 @@
 
 package ast
 
-import "sync"
+import (
+	"sync"
+
+	"github.com/onflow/cadence/runtime/common"
+)
 
 type ParameterList struct {
 	once                    sync.Once
@@ -27,6 +31,18 @@ type ParameterList struct {
 	Range
 }
 
+func NewParameterList(
+	gauge common.MemoryGauge,
+	parameters []*Parameter,
+	astRange Range,
+) *ParameterList {
+	common.UseMemory(gauge, common.ParameterListMemoryUsage)
+	return &ParameterList{
+		Parameters: parameters,
+		Range:      astRange,
+	}
+}
+
 // EffectiveArgumentLabels returns the effective argument labels that
 // the arguments of a call must use:
 // If no argument label is declared for parameter,

diff --git a/runtime/ast/position.go b/runtime/ast/position.go
@@ -81,6 +81,8 @@ type Range struct {
 	EndPos   Position
 }
 
+var EmptyRange = Range{}
+
 func (e Range) StartPosition() Position {
 	return e.StartPos
 }

diff --git a/runtime/ast/program.go b/runtime/ast/program.go
@@ -30,7 +30,8 @@ type Program struct {
 	indices      programIndices
 }
 
-func NewProgram(declarations []Declaration) *Program {
+func NewProgram(memoryGauge common.MemoryGauge, declarations []Declaration) *Program {
+	common.UseMemory(memoryGauge, common.ProgramMemoryUsage)
 	return &Program{
 		declarations: declarations,
 	}

diff --git a/runtime/ast/program_test.go b/runtime/ast/program_test.go
@@ -30,7 +30,7 @@ func TestProgram_MarshalJSON(t *testing.T) {
 
 	t.Parallel()
 
-	program := NewProgram([]Declaration{})
+	program := NewProgram(nil, []Declaration{})
 
 	actual, err := json.Marshal(program)
 	require.NoError(t, err)

diff --git a/runtime/ast/programindices_test.go b/runtime/ast/programindices_test.go
@@ -114,6 +114,7 @@ func TestProgramIndices(t *testing.T) {
 	}
 
 	program := NewProgram(
+		nil,
 		[]Declaration{
 			importB,
 			pragmaA,

diff --git a/runtime/ast/transfer.go b/runtime/ast/transfer.go
@@ -22,6 +22,8 @@ import (
 	"encoding/json"
 
 	"github.com/turbolent/prettier"
+
+	"github.com/onflow/cadence/runtime/common"
 )
 
 // Transfer represents the operation in variable declarations
@@ -32,6 +34,14 @@ type Transfer struct {
 	Pos       Position `json:"-"`
 }
 
+func NewTransfer(memoryGauge common.MemoryGauge, operation TransferOperation, position Position) *Transfer {
+	common.UseMemory(memoryGauge, common.TransferMemoryUsage)
+	return &Transfer{
+		Operation: operation,
+		Pos:       position,
+	}
+}
+
 func (f Transfer) StartPosition() Position {
 	return f.Pos
 }