io.hotmoka.instrumentation.internal.InstrumentationConstants Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-hotmoka-instrumentation Show documentation

This module implements the instrumentation of Takamaka code before being installed in a Hotmoka node.

There is a newer version: 1.6.0

Show newest version

/*
Copyright 2021 Fausto Spoto

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package io.hotmoka.instrumentation.internal;

import static io.hotmoka.verification.api.VerifiedClass.FORBIDDEN_PREFIX;

/**
 * A collector of constants useful during code instrumentation.
 */
public interface InstrumentationConstants {

	/**
	 * The prefix of the name of the field used in instrumented storage classes
	 * to determine if a lazy field has been assigned.
	 */
	String IF_ALREADY_LOADED_PREFIX = FORBIDDEN_PREFIX + "ifAlreadyLoaded_";

	/**
	 * The prefix of the name of the method used in instrumented storage classes
	 * to ensure that a lazy field has been loaded.
	 */
	String ENSURE_LOADED_PREFIX = FORBIDDEN_PREFIX + "ensureLoaded_";

	/**
	 * The prefix of the name of the method used in instrumented storage classes
	 * to read a lazy field.
	 */
	String GETTER_PREFIX = FORBIDDEN_PREFIX + "get_";

	/**
	 * The prefix of the name of the method used in instrumented storage classes
	 * to set a lazy field.
	 */
	String SETTER_PREFIX = FORBIDDEN_PREFIX + "set_";

	/**
	 * The name of the method of {@code io.takamaka.code.lang.Storage} used to access the caller of entries.
	 */
	String CALLER = "caller";

	/**
	 * The name of the method of {@code io.hotmoka.local.internal.runtime.Runtime}
	 * used to retrieve the last update for a non-final lazy field.
	 */
	String DESERIALIZE_LAST_UPDATE_FOR = "deserializeLastLazyUpdateFor";

	/**
	 * The name of the method of {@code io.hotmoka.local.internal.runtime.Runtime}
	 * used to retrieve the last update for a final lazy field.
	 */
	String DESERIALIZE_LAST_UPDATE_FOR_FINAL = "deserializeLastLazyUpdateForFinal";

	/**
	 * The prefix of the name of extra lambdas added during instrumentation.
	 */
	String EXTRA_LAMBDA = FORBIDDEN_PREFIX + "lambda";

	/**
	 * The prefix of the name of extra methods used to simulate multidimensional
	 * array creations and keep track of the gas consumed for RAM consumption.
	 */
	String EXTRA_ALLOCATOR = FORBIDDEN_PREFIX + "newarray";

	/**
	 * The prefix of the name of extra methods used to check white-listing annotations at run time.
	 */
	String EXTRA_VERIFIER = FORBIDDEN_PREFIX + "verifier";

	/**
	 * The name of the method of {@code io.hotmoka.local.internal.runtime.Runtime}
	 * that sets the caller and transfers money at the beginning of a payable {@code @@FromContract}.
	 */
	String PAYABLE_FROM_CONTRACT = "payableFromContract";

	/**
	 * The name of the method of {@code io.hotmoka.local.internal.runtime.Runtime}
	 * that sets the caller and transfers money at the beginning of a red payable {@code @@FromContract}.
	 */
	String RED_PAYABLE_FROM_CONTRACT = "redPayableFromContract";

	/**
	 * The name of the method of {@code io.hotmoka.local.internal.runtime.Runtime}
	 * that sets the caller at the beginning of a {@code @@FromContract}.
	 */
	String FROM_CONTRACT = "fromContract";

	/**
	 * The number of optimized methods for gas charge in the
	 * {@code io.hotmoka.local.internal.runtime.Runtime} class.
	 */
	long MAX_OPTIMIZED_CHARGE = 20;
}