Merge pull request #15828 from ethereum/move-eof-osaka

Moves EOF tests from Prague to Osaka

.circleci/soltest_all.sh

@@ -32,7 +32,7 @@ REPODIR="$(realpath "$(dirname "$0")"/..)"
 source "${REPODIR}/scripts/common.sh"
 
 DEFAULT_EVM_VALUES=(constantinople petersburg istanbul berlin london paris shanghai cancun prague osaka)
-EVMS_WITH_EOF=(prague)
+EVMS_WITH_EOF=(osaka)
 
 # Deserialize the EVM_VALUES array if it was provided as argument or
 # set EVM_VALUES to the default values.

liblangutil/EVMVersion.cpp

@@ -28,8 +28,8 @@ using namespace solidity::langutil;
 
 bool EVMVersion::hasOpcode(Instruction _opcode, std::optional<uint8_t> _eofVersion) const
 {
-	// EOF version can be only defined since prague
-	assert(!_eofVersion.has_value() || *this >= prague());
+	// EOF version can be only defined since osaka
+	assert(!_eofVersion.has_value() || *this >= EVMVersion::firstWithEOF());
 
 	switch (_opcode)
 	{

liblangutil/EVMVersion.h

@@ -93,6 +93,8 @@ class EVMVersion:
 		return std::nullopt;
 	}
 
+	static EVMVersion firstWithEOF() { return {Version::Osaka}; }
+
 	bool isExperimental() const {
 		return *this > EVMVersion{};
 	}
@@ -137,6 +139,7 @@ class EVMVersion:
 	bool hasBlobHash() const { return *this >= cancun(); }
 	bool hasMcopy() const { return *this >= cancun(); }
 	bool supportsTransientStorage() const { return *this >= cancun(); }
+	bool supportsEOF() const { return *this >= firstWithEOF(); }
 
 	bool hasOpcode(evmasm::Instruction _opcode, std::optional<uint8_t> _eofVersion) const;
 

libyul/AsmAnalysis.cpp

@@ -695,9 +695,8 @@ bool AsmAnalyzer::validateInstructions(std::string_view _instructionIdentifier,
 	if (builtinHandle && defaultEVMDialect.builtin(*builtinHandle).instruction.has_value())
 		return validateInstructions(*defaultEVMDialect.builtin(*builtinHandle).instruction, _location);
 
-	solAssert(!m_eofVersion.has_value() || (*m_eofVersion == 1 && m_evmVersion == langutil::EVMVersion::prague()));
-	// TODO: Change `prague()` to `EVMVersion{}` once EOF gets deployed
-	auto const& eofDialect = EVMDialect::strictAssemblyForEVMObjects(EVMVersion::prague(), 1);
+	solAssert(!m_eofVersion.has_value() || *m_eofVersion == 1);
+	auto const& eofDialect = EVMDialect::strictAssemblyForEVMObjects(EVMVersion::firstWithEOF(), 1);
 	auto const eofBuiltinHandle = eofDialect.findBuiltin(_instructionIdentifier);
 	if (eofBuiltinHandle)
 	{

libyul/backends/evm/EVMDialect.cpp

@@ -155,13 +155,12 @@ std::set<std::string, std::less<>> createReservedIdentifiers(langutil::EVMVersio
 
 	auto eofIdentifiersException = [&](evmasm::Instruction _instr) -> bool
 	{
-		solAssert(!_eofVersion.has_value() || (*_eofVersion == 1 && _evmVersion == langutil::EVMVersion::prague()));
+		solAssert(!_eofVersion.has_value() || (*_eofVersion == 1 && _evmVersion.supportsEOF()));
 		if (_eofVersion.has_value())
 			// For EOF every instruction is reserved identifier.
 			return false;
-		else
-			return langutil::EVMVersion::prague().hasOpcode(_instr, 1) &&
-				!langutil::EVMVersion::prague().hasOpcode(_instr, std::nullopt);
+		return langutil::EVMVersion::firstWithEOF().hasOpcode(_instr, 1) &&
+			!langutil::EVMVersion::firstWithEOF().hasOpcode(_instr, std::nullopt);
 	};
 
 	std::set<std::string, std::less<>> reserved;

libyul/backends/evm/EVMObjectCompiler.cpp

@@ -76,10 +76,10 @@ void EVMObjectCompiler::run(Object const& _object, bool _optimize)
 	yulAssert(_object.analysisInfo, "No analysis info.");
 	yulAssert(_object.hasCode(), "No code.");
 	if (evmDialect->eofVersion().has_value())
-		yulAssert(
-			_optimize && (evmDialect->evmVersion() >= langutil::EVMVersion::prague()),
-			"Experimental EOF support is only available for optimized via-IR compilation and the most recent EVM version."
-		);
+	{
+		solUnimplementedAssert(_optimize, "EOF supported only for optimized compilation via IR.");
+		yulAssert(evmDialect->evmVersion().supportsEOF());
+	}
 	if (_optimize && evmDialect->evmVersion().canOverchargeGasForCall())
 	{
 		auto stackErrors = OptimizedEVMCodeTransform::run(

test/Common.cpp

@@ -162,7 +162,7 @@ void CommonOptions::validate() const
 		std::cout << std::endl << "DO NOT COMMIT THE UPDATED EXPECTATIONS." << std::endl << std::endl;
 	}
 
-	assertThrow(!eofVersion().has_value() || evmVersion() >= langutil::EVMVersion::prague(), ConfigException, "EOF is unavailable before Prague fork.");
+	assertThrow(!eofVersion().has_value() || evmVersion().supportsEOF(), ConfigException, "EOF is unavailable before Osaka fork.");
 }
 
 bool CommonOptions::parse(int argc, char const* const* argv)

test/TestCase.cpp

@@ -146,9 +146,8 @@ void EVMVersionRestrictedTestCase::processEVMVersionSetting()
 void EVMVersionRestrictedTestCase::processBytecodeFormatSetting()
 {
 	std::optional<uint8_t> eofVersion = solidity::test::CommonOptions::get().eofVersion();
-	// TODO: Update if EOF moved to Osaka
-	// EOF only available since Prague
-	solAssert(!eofVersion.has_value() ||solidity::test::CommonOptions::get().evmVersion() >= langutil::EVMVersion::prague());
+	// EOF only available since Osaka
+	solAssert(!eofVersion.has_value() || solidity::test::CommonOptions::get().evmVersion().supportsEOF());
 
 	std::string bytecodeFormatString = m_reader.stringSetting("bytecodeFormat", "legacy,>=EOFv1");
 	if (bytecodeFormatString == "legacy,>=EOFv1" || bytecodeFormatString == ">=EOFv1,legacy")

test/cmdlineTests/strict_asm_eof_container_osaka/args

@@ -0,0 +1 @@
+ --strict-assembly --experimental-eof-version 1 --evm-version osaka --asm --ir-optimized --bin --debug-info none

test/cmdlineTests/strict_asm_eof_container_prague/output → test/cmdlineTests/strict_asm_eof_container_osaka/output

@@ -1,5 +1,5 @@
 
-======= strict_asm_eof_container_prague/input.yul (EVM) =======
+======= strict_asm_eof_container_osaka/input.yul (EVM) =======
 
 Pretty printed source:
 object "object" {

test/cmdlineTests/strict_asm_eof_dataloadn_osaka/args

@@ -0,0 +1 @@
+ --strict-assembly --experimental-eof-version 1 --evm-version osaka --asm --ir-optimized --bin --debug-info none

test/cmdlineTests/strict_asm_eof_dataloadn_prague/output → test/cmdlineTests/strict_asm_eof_dataloadn_osaka/output

@@ -1,5 +1,5 @@
 
-======= strict_asm_eof_dataloadn_prague/input.yul (EVM) =======
+======= strict_asm_eof_dataloadn_osaka/input.yul (EVM) =======
 
 Pretty printed source:
 object "a" {

test/libsolidity/syntaxTests/functionCalls/eof/calloptions_on_staticcall.sol

@@ -4,7 +4,6 @@ contract C {
     }
 }
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: >=EOFv1
 // ----
 // TypeError 2842: (56-96): Cannot set option "value" for staticcall.

test/libyul/objectCompiler/eof/creation_with_immutables.yul

@@ -27,7 +27,6 @@ object "a" {
 }
 
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: >=EOFv1
 // ----
 // Assembly:

test/libyul/objectCompiler/eof/dataloadn.yul

@@ -9,7 +9,6 @@ object "a" {
 }
 
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: >=EOFv1
 // ----
 // Assembly:

test/libyul/objectCompiler/eof/prune_unreferenced_container.yul

@@ -20,7 +20,6 @@ object "a" {
 }
 
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: >=EOFv1
 // ----
 // Assembly:

test/libyul/objectCompiler/eof/rjumps.yul

@@ -9,7 +9,6 @@ object "a" {
 }
 
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: >=EOFv1
 // ----
 // Assembly:

test/libyul/yulSyntaxTests/eof/auxdataloadn_in_eof_invalid_literal_type.yul

@@ -8,7 +8,6 @@ object "a" {
     }
 
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: >=EOFv1
 // ----
 // TypeError 5859: (55-58): Function expects number literal.

test/libyul/yulSyntaxTests/eof/auxdataloadn_in_legacy.yul

@@ -8,7 +8,6 @@ object "a" {
 }
 
 // ====
-// EVMVersion: >=prague
 // bytecodeFormat: legacy
 // ----
 // DeclarationError 7223: (42-54): Builtin function "auxdataloadn" is only available in EOF.