Merge pull request #1546 from onflow/container-length-metering

Improve metering of containers
onflow · Apr 11, 2022 · d1c8541 · d1c8541
2 parents 903b8c5 + 5d96c72
commit d1c8541
Show file tree

Hide file tree

Showing 7 changed files with 256 additions and 128 deletions.
diff --git a/runtime/common/memorykind.go b/runtime/common/memorykind.go
@@ -35,9 +35,12 @@ const (
 	MemoryKindCharacter
 	MemoryKindMetaType
 	MemoryKindNumber
-	MemoryKindArray
-	MemoryKindDictionary
-	MemoryKindComposite
+	MemoryKindArrayBase
+	MemoryKindArrayLength
+	MemoryKindDictionaryBase
+	MemoryKindDictionarySize
+	MemoryKindCompositeBase
+	MemoryKindCompositeSize
 	MemoryKindOptional
 	MemoryKindNil
 	MemoryKindVoid

diff --git a/runtime/common/memorykind_string.go b/runtime/common/memorykind_string.go
diff --git a/runtime/common/metering.go b/runtime/common/metering.go
@@ -115,6 +115,50 @@ func NewConstantMemoryUsage(kind MemoryKind) MemoryUsage {
 	}
 }
 
+func NewArrayMemoryUsages(length int) (MemoryUsage, MemoryUsage) {
+	return MemoryUsage{
+			Kind:   MemoryKindArrayBase,
+			Amount: 1,
+		}, MemoryUsage{
+			Kind:   MemoryKindArrayLength,
+			Amount: uint64(length),
+		}
+}
+
+func NewArrayLengthUsage(length int) MemoryUsage {
+	return MemoryUsage{
+		Kind:   MemoryKindArrayLength,
+		Amount: uint64(length),
+	}
+}
+
+func NewDictionaryMemoryUsages(length int) (MemoryUsage, MemoryUsage) {
+	return MemoryUsage{
+			Kind:   MemoryKindDictionaryBase,
+			Amount: 1,
+		}, MemoryUsage{
+			Kind:   MemoryKindDictionarySize,
+			Amount: uint64(length),
+		}
+}
+
+func NewDictionarySizeUsage(length int) MemoryUsage {
+	return MemoryUsage{
+		Kind:   MemoryKindDictionarySize,
+		Amount: uint64(length),
+	}
+}
+
+func NewCompositeMemoryUsages(length int) (MemoryUsage, MemoryUsage) {
+	return MemoryUsage{
+			Kind:   MemoryKindCompositeBase,
+			Amount: 1,
+		}, MemoryUsage{
+			Kind:   MemoryKindCompositeSize,
+			Amount: uint64(length),
+		}
+}
+
 func NewStringMemoryUsage(length int) MemoryUsage {
 	return MemoryUsage{
 		Kind:   MemoryKindString,

diff --git a/runtime/imported_values_memory_metering_test.go b/runtime/imported_values_memory_metering_test.go
@@ -372,7 +372,7 @@ func TestMemoryMeteringErrors(t *testing.T) {
 		intf := &testRuntimeInterface{
 			meterMemory: func(usage common.MemoryUsage) error {
 				if usage.Kind == common.MemoryKindString ||
-					usage.Kind == common.MemoryKindArray {
+					usage.Kind == common.MemoryKindArrayBase {
 					return testMemoryError{}
 				}
 				return nil

diff --git a/runtime/interpreter/simplecompositevalue.go b/runtime/interpreter/simplecompositevalue.go
@@ -57,7 +57,10 @@ func NewSimpleCompositeValue(
 	fieldFormatters map[string]func(Value, SeenReferences) string,
 	stringer func(SeenReferences) string,
 ) *SimpleCompositeValue {
-	common.UseConstantMemory(inter, common.MemoryKindComposite)
+
+	baseUsage, lengthUsage := common.NewCompositeMemoryUsages(len(fields))
+	common.UseMemory(inter, baseUsage)
+	common.UseMemory(inter, lengthUsage)
 
 	return &SimpleCompositeValue{
 		TypeID:          typeID,

diff --git a/runtime/interpreter/value.go b/runtime/interpreter/value.go
@@ -1356,7 +1356,9 @@ func newArrayValueFromAtreeValue(
 	staticType ArrayStaticType,
 ) *ArrayValue {
 
-	common.UseMemory(memoryGauge, common.NewConstantMemoryUsage(common.MemoryKindArray))
+	baseUse, lengthUse := common.NewArrayMemoryUsages(int(array.Count()))
+	common.UseMemory(memoryGauge, baseUse)
+	common.UseMemory(memoryGauge, lengthUse)
 
 	return &ArrayValue{
 		Type:  staticType,
@@ -1648,6 +1650,9 @@ func (v *ArrayValue) RecursiveString(seenReferences SeenReferences) string {
 
 func (v *ArrayValue) Append(interpreter *Interpreter, getLocationRange func() LocationRange, element Value) {
 
+	// length increases by 1
+	common.UseMemory(interpreter, common.NewArrayLengthUsage(1))
+
 	interpreter.checkContainerMutation(v.Type.ElementType(), element, getLocationRange)
 
 	element = element.Transfer(
@@ -1694,6 +1699,9 @@ func (v *ArrayValue) Insert(interpreter *Interpreter, getLocationRange func() Lo
 		})
 	}
 
+	// length increases by 1
+	common.UseMemory(interpreter, common.NewArrayLengthUsage(1))
+
 	interpreter.checkContainerMutation(v.Type.ElementType(), element, getLocationRange)
 
 	element = element.Transfer(
@@ -13973,7 +13981,9 @@ func newCompositeValueFromOrderedMap(
 	typeInfo compositeTypeInfo,
 ) *CompositeValue {
 
-	common.UseMemory(memoryGauge, common.NewConstantMemoryUsage(common.MemoryKindComposite))
+	baseUse, lengthUse := common.NewCompositeMemoryUsages(int(dict.Count()))
+	common.UseMemory(memoryGauge, baseUse)
+	common.UseMemory(memoryGauge, lengthUse)
 
 	return &CompositeValue{
 		dictionary:          dict,
@@ -15067,7 +15077,9 @@ func newDictionaryValueFromOrderedMap(
 	staticType DictionaryStaticType,
 ) *DictionaryValue {
 
-	common.UseMemory(memoryGauge, common.NewConstantMemoryUsage(common.MemoryKindDictionary))
+	baseUse, lengthUse := common.NewDictionaryMemoryUsages(int(dict.Count()))
+	common.UseMemory(memoryGauge, baseUse)
+	common.UseMemory(memoryGauge, lengthUse)
 
 	return &DictionaryValue{
 		Type:       staticType,
@@ -15562,6 +15574,9 @@ func (v *DictionaryValue) Insert(
 	keyValue, value Value,
 ) OptionalValue {
 
+	// length increases by 1
+	common.UseMemory(interpreter, common.NewDictionarySizeUsage(1))
+
 	interpreter.checkContainerMutation(v.Type.KeyType, keyValue, getLocationRange)
 	interpreter.checkContainerMutation(v.Type.ValueType, value, getLocationRange)