Merge pull request #851 from multiversx/is-builtin-function-vmhook

IsReservedFunctionName vmhook impl

config/config.toml

@@ -57,6 +57,7 @@
     DeleteFromReturnData = 10
     GetCodeMetadata = 10
     IsBuiltinFunction = 10
+    IsReservedFunctionName = 10
 
 [EthAPICost]
     UseGas = 10

config/gasCost.go

@@ -82,6 +82,7 @@ type BaseOpsAPICost struct {
 	DeleteFromReturnData    uint64
 	GetCodeMetadata         uint64
 	IsBuiltinFunction       uint64
+	IsReservedFunctionName 	uint64
 }
 
 // DynamicStorageLoadCostCoefficients holds the signed coefficients of the func that will compute the gas cost

config/gasSchedule.go

@@ -313,6 +313,7 @@ func FillGasMapBaseOpsAPICosts(value, asyncCallbackGasLock uint64) map[string]ui
 	gasMap["DeleteFromReturnData"] = value
 	gasMap["GetCodeMetadata"] = value
 	gasMap["IsBuiltinFunction"] = value
+	gasMap["IsReservedFunctionName"] = value
 
 	return gasMap
 }

mock/context/runtimeContextMock.go

@@ -356,6 +356,11 @@ func (r *RuntimeContextMock) ValidateCallbackName(_ string) error {
 	return nil
 }
 
+// IsReservedFunctionName moked method
+func (r *RuntimeContextMock) IsReservedFunctionName(_ string) bool {
+	return false
+}
+
 // HasFunction mocked method
 func (r *RuntimeContextMock) HasFunction(_ string) bool {
 	return r.HasFunctionResult

mock/context/runtimeContextWrapper.go

@@ -582,6 +582,11 @@ func (contextWrapper *RuntimeContextWrapper) ValidateCallbackName(callbackName s
 	return contextWrapper.runtimeContext.ValidateCallbackName(callbackName)
 }
 
+// IsReservedFunctionName calls corresponding xxxFunc function, that by default in turn calls the original method of the wrapped RuntimeContext
+func (contextWrapper *RuntimeContextWrapper) IsReservedFunctionName(functionName string) bool {
+	return contextWrapper.runtimeContext.IsReservedFunctionName(functionName)
+}
+
 // HasFunction calls corresponding xxxFunc function, that by default in turn calls the original method of the wrapped RuntimeContext
 func (contextWrapper *RuntimeContextWrapper) HasFunction(functionName string) bool {
 	return contextWrapper.runtimeContext.HasFunction(functionName)

scenario/gasSchedules/gasScheduleV3.toml

@@ -109,6 +109,7 @@
     DeleteFromReturnData = 100
     GetCodeMetadata = 100
     IsBuiltinFunction = 100
+    IsReservedFunctionName = 100
 
 [EthAPICost]
     UseGas = 100

scenario/gasSchedules/gasScheduleV4.toml

@@ -111,6 +111,7 @@
     DeleteFromReturnData = 100
     GetCodeMetadata = 100
     IsBuiltinFunction = 100
+    IsReservedFunctionName = 100
 
 [EthAPICost]
     UseGas = 100

vmhost/contexts/runtime.go

@@ -909,6 +909,11 @@ func (context *runtimeContext) ValidateCallbackName(callbackName string) error {
 	return nil
 }
 
+// IsReservedFunctionName checks if the function name is reserved
+func (context *runtimeContext) IsReservedFunctionName(functionName string) bool {
+	return context.validator.reserved.IsReserved(functionName)
+}
+
 // HasFunction checks if loaded contract has a function (endpoint) with given name.
 func (context *runtimeContext) HasFunction(functionName string) bool {
 	return context.iTracker.Instance().HasFunction(functionName)

vmhost/interface.go

@@ -161,6 +161,9 @@ type RuntimeContext interface {
 	GetAllErrors() error
 
 	ValidateCallbackName(callbackName string) error
+
+	IsReservedFunctionName(functionName string) bool
+
 	HasFunction(functionName string) bool
 	GetPrevTxHash() []byte
 	EndExecution()

vmhost/vmhooks/baseOps.go

@@ -2324,6 +2324,29 @@ func (context *VMHooksImpl) GetCallValueTokenNameByIndex(
 	return int32(len(tokenName))
 }
 
+// IsReservedFunctionName VMHooks implementation.
+// @autogenerate(VMHooks)
+func (context *VMHooksImpl) IsReservedFunctionName(nameHandle int32) int32 {
+	host := context.host
+	managedTypes := context.GetManagedTypesContext()
+	runtime := host.Runtime()
+	metering := host.Metering()
+
+	gasToUse := metering.GasSchedule().BaseOpsAPICost.IsReservedFunctionName
+	metering.UseAndTraceGas(gasToUse)
+
+	name, err := managedTypes.GetBytes(nameHandle)
+	if context.WithFault(err, runtime.BaseOpsErrorShouldFailExecution()) {
+		return -1
+	}
+
+	if runtime.IsReservedFunctionName(string(name)) {
+		return 1
+	}
+
+	return 0
+}
+
 // WriteLog VMHooks implementation.
 // @autogenerate(VMHooks)
 func (context *VMHooksImpl) WriteLog(

wasmer2/libvmexeccapi.h

@@ -91,6 +91,7 @@ typedef struct {
   int32_t (*get_num_esdt_transfers_func_ptr)(void *context);
   int32_t (*get_call_value_token_name_func_ptr)(void *context, int32_t call_value_offset, int32_t token_name_offset);
   int32_t (*get_call_value_token_name_by_index_func_ptr)(void *context, int32_t call_value_offset, int32_t token_name_offset, int32_t index);
+  int32_t (*is_reserved_function_name_func_ptr)(void *context, int32_t name_handle);
   void (*write_log_func_ptr)(void *context, int32_t data_pointer, int32_t data_length, int32_t topic_ptr, int32_t num_topics);
   void (*write_event_log_func_ptr)(void *context, int32_t num_topics, int32_t topic_lengths_offset, int32_t topic_offset, int32_t data_offset, int32_t data_length);
   int64_t (*get_block_timestamp_func_ptr)(void *context);