Merge pull request onflow#6215 from onflow/bastian/computation-remaining

Add meter method which returns remaining computation for given computation kind

fvm/environment/meter.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/onflow/cadence/common"
+	"github.com/onflow/cadence/runtime"
 
 	"github.com/onflow/flow-go/fvm/errors"
 	"github.com/onflow/flow-go/fvm/meter"
@@ -70,18 +71,13 @@ var MainnetExecutionEffortWeights = meter.ExecutionEffortWeights{
 }
 
 type Meter interface {
-	MeterComputation(common.ComputationKind, uint) error
-	ComputationUsed() (uint64, error)
+	runtime.MeterInterface
+
 	ComputationIntensities() meter.MeteredComputationIntensities
 	ComputationAvailable(common.ComputationKind, uint) bool
 
-	MeterMemory(usage common.MemoryUsage) error
-	MemoryUsed() (uint64, error)
-
 	MeterEmittedEvent(byteSize uint64) error
 	TotalEmittedEventBytes() uint64
-
-	InteractionUsed() (uint64, error)
 }
 
 type meterImpl struct {
@@ -112,6 +108,10 @@ func (meter *meterImpl) ComputationAvailable(
 	return meter.txnState.ComputationAvailable(kind, intensity)
 }
 
+func (meter *meterImpl) ComputationRemaining(kind common.ComputationKind) uint {
+	return meter.txnState.ComputationRemaining(kind)
+}
+
 func (meter *meterImpl) ComputationUsed() (uint64, error) {
 	return meter.txnState.TotalComputationUsed(), nil
 }

fvm/meter/computation_meter.go

@@ -116,10 +116,28 @@ func (m *ComputationMeter) ComputationAvailable(
 	if !ok {
 		return true
 	}
+
 	potentialComputationUsage := m.computationUsed + w*uint64(intensity)
 	return potentialComputationUsage <= m.params.computationLimit
 }
 
+// ComputationRemaining returns the remaining computation (intensity) left in the transaction for the given type
+func (m *ComputationMeter) ComputationRemaining(kind common.ComputationKind) uint {
+	w, ok := m.params.computationWeights[kind]
+	// if not found return has capacity
+	// given the behaviour of MeterComputation is ignoring intensities without a set weight
+	if !ok {
+		return math.MaxUint
+	}
+
+	remainingComputationUsage := m.params.computationLimit - m.computationUsed
+	if remainingComputationUsage <= 0 {
+		return 0
+	}
+
+	return uint(remainingComputationUsage / w)
+}
+
 // ComputationIntensities returns all the measured computational intensities
 func (m *ComputationMeter) ComputationIntensities() MeteredComputationIntensities {
 	return m.computationIntensities

fvm/meter/meter_test.go

@@ -139,6 +139,27 @@ func TestWeightedComputationMetering(t *testing.T) {
 		require.True(t, m.ComputationAvailable(1, 10))
 	})
 
+	t.Run("check computation remaining", func(t *testing.T) {
+		m := meter.NewMeter(
+			meter.DefaultParameters().
+				WithComputationLimit(10).
+				WithComputationWeights(
+					map[common.ComputationKind]uint64{0: 1 << meter.MeterExecutionInternalPrecisionBytes}),
+		)
+
+		remaining := m.ComputationRemaining(0)
+		require.Equal(t, uint(10), remaining)
+
+		err := m.MeterComputation(0, 1)
+		require.NoError(t, err)
+		require.Equal(t, uint64(1), m.TotalComputationUsed())
+
+		require.Equal(t, uint(9), m.ComputationRemaining(0))
+
+		// test a type without a weight (default zero)
+		require.Equal(t, uint(math.MaxUint), m.ComputationRemaining(1))
+	})
+
 	t.Run("merge meters", func(t *testing.T) {
 		compKind := common.ComputationKind(0)
 		m := meter.NewMeter(

fvm/storage/state/execution_state.go

@@ -2,6 +2,7 @@ package state
 
 import (
 	"fmt"
+	"math"
 
 	"github.com/onflow/cadence/common"
 	"github.com/onflow/crypto/hash"
@@ -235,6 +236,20 @@ func (state *ExecutionState) ComputationAvailable(kind common.ComputationKind, i
 	return true
 }
 
+// ComputationRemaining returns the available computation capacity without metering
+func (state *ExecutionState) ComputationRemaining(kind common.ComputationKind) uint {
+	if state.finalized {
+		// if state is finalized return 0
+		return 0
+	}
+
+	if state.enforceLimits {
+		return state.meter.ComputationRemaining(kind)
+	}
+
+	return math.MaxUint
+}
+
 // TotalComputationUsed returns total computation used
 func (state *ExecutionState) TotalComputationUsed() uint64 {
 	return state.meter.TotalComputationUsed()

fvm/storage/state/transaction_state.go

@@ -22,6 +22,7 @@ func (id NestedTransactionId) StateForTestingOnly() *ExecutionState {
 type Meter interface {
 	MeterComputation(kind common.ComputationKind, intensity uint) error
 	ComputationAvailable(kind common.ComputationKind, intensity uint) bool
+	ComputationRemaining(kind common.ComputationKind) uint
 	ComputationIntensities() meter.MeteredComputationIntensities
 	TotalComputationLimit() uint
 	TotalComputationUsed() uint64
@@ -451,6 +452,10 @@ func (txnState *transactionState) ComputationAvailable(
 	return txnState.current().ComputationAvailable(kind, intensity)
 }
 
+func (txnState *transactionState) ComputationRemaining(kind common.ComputationKind) uint {
+	return txnState.current().ComputationRemaining(kind)
+}
+
 func (txnState *transactionState) MeterMemory(
 	kind common.MemoryKind,
 	intensity uint,