Merge pull request #16521 from argotorg/remove_cli_assemble

Deactivate --assemble in CLI

Author: clonker

Changelog.md

@@ -4,6 +4,7 @@ Language Features:
 * General: Add a builtin that computes the base slot of a storage namespace using the `erc7201` formula from ERC-7201.
 
 Compiler Features:
+* Commandline Interface: Disallow selecting the deprecated assembly input mode that was only accessible via `--assemble` instead of treating it as equivalent to `--strict-assembly`.
 * Commandline Interface: Introduce `--experimental` flag required for enabling the experimental mode.
 * General: Introduce the SSA CFG codegen (experimental).
 * General: Restrict the existing experimental features (`generic-solidity`, `lsp`, `ethdebug`, `eof`, `evm`, `ast-import`, `evmasm-import`, `ir-ast`, `ssa-cfg`) to experimental mode.

libsolidity/interface/CompilerStack.cpp

@@ -850,7 +850,6 @@ YulStack CompilerStack::loadGeneratedIR(std::string const& _ir) const
 	YulStack stack(
 		m_evmVersion,
 		m_eofVersion,
-		YulStack::Language::StrictAssembly,
 		m_optimiserSettings,
 		m_debugInfoSelection,
 		this, // _soliditySourceProvider

libsolidity/interface/StandardCompiler.cpp

@@ -1755,7 +1755,6 @@ Json StandardCompiler::compileYul(InputsAndSettings _inputsAndSettings)
 	YulStack stack(
 		_inputsAndSettings.evmVersion,
 		_inputsAndSettings.eofVersion,
-		YulStack::Language::StrictAssembly,
 		_inputsAndSettings.optimiserSettings,
 		_inputsAndSettings.debugInfoSelection.has_value() ?
 			_inputsAndSettings.debugInfoSelection.value() :

libyul/ObjectOptimizer.cpp

@@ -43,17 +43,6 @@ using namespace solidity::util;
 using namespace solidity::yul;
 
 
-Dialect const& yul::languageToDialect(Language _language, EVMVersion _version, std::optional<uint8_t> _eofVersion)
-{
-	switch (_language)
-	{
-	case Language::Assembly:
-	case Language::StrictAssembly:
-		return EVMDialect::strictAssemblyForEVMObjects(_version, _eofVersion);
-	}
-	util::unreachable();
-}
-
 void ObjectOptimizer::optimize(Object& _object, Settings const& _settings)
 {
 	yulAssert(_object.subId.empty(), "Not a top-level object.");
@@ -77,10 +66,8 @@ void ObjectOptimizer::optimize(Object& _object, Settings const& _settings, bool
 			);
 		}
 
-	Dialect const& dialect = languageToDialect(_settings.language, _settings.evmVersion, _settings.eofVersion);
-	std::unique_ptr<GasMeter> meter;
-	if (EVMDialect const* evmDialect = dynamic_cast<EVMDialect const*>(&dialect))
-		meter = std::make_unique<GasMeter>(*evmDialect, _isCreation, _settings.expectedExecutionsPerDeployment);
+	EVMDialect const& dialect = EVMDialect::strictAssemblyForEVMObjects(_settings.evmVersion, _settings.eofVersion);
+	GasMeter const meter(dialect, _isCreation, _settings.expectedExecutionsPerDeployment);
 
 	std::optional<h256> cacheKey = calculateCacheKey(_object.code()->root(), *_object.debugData, _settings, _isCreation);
 	if (cacheKey.has_value() && m_cachedObjects.count(*cacheKey) != 0)
@@ -90,7 +77,7 @@ void ObjectOptimizer::optimize(Object& _object, Settings const& _settings, bool
 	}
 
 	OptimiserSuite::run(
-		meter.get(),
+		&meter,
 		_object,
 		_settings.optimizeStackAllocation,
 		_settings.yulOptimiserSteps,
@@ -141,7 +128,7 @@ std::optional<h256> ObjectOptimizer::calculateCacheKey(
 )
 {
 	AsmPrinter asmPrinter(
-		languageToDialect(_settings.language, _settings.evmVersion, _settings.eofVersion),
+		EVMDialect::strictAssemblyForEVMObjects(_settings.evmVersion, _settings.eofVersion),
 		_debugData.sourceNames,
 		DebugInfoSelection::All()
 	);
@@ -153,7 +140,6 @@ std::optional<h256> ObjectOptimizer::calculateCacheKey(
 	// we just regenerate them by reparsing the object.
 	rawKey += keccak256(asmPrinter(_ast)).asBytes();
 	rawKey += keccak256(_debugData.formatUseSrcComment()).asBytes();
-	rawKey += h256(u256(_settings.language)).asBytes();
 	static_assert(static_cast<uint8_t>(static_cast<bool>(2)) == 1);
 	rawKey += FixedHash<1>(static_cast<uint8_t>(_settings.optimizeStackAllocation)).asBytes();
 	rawKey += h256(u256(_settings.expectedExecutionsPerDeployment)).asBytes();

libyul/ObjectOptimizer.h

@@ -32,14 +32,6 @@
 namespace solidity::yul
 {
 
-enum class Language
-{
-	Assembly,
-	StrictAssembly,
-};
-
-Dialect const& languageToDialect(Language _language, langutil::EVMVersion _version, std::optional<uint8_t> _eofVersion);
-
 /// Encapsulates logic for applying @a yul::OptimiserSuite to a whole hierarchy of Yul objects.
 /// Also, acts as a transparent cache for optimized objects.
 ///
@@ -56,7 +48,6 @@ class ObjectOptimizer
 	/// must uniquely determine the result of optimization.
 	struct Settings
 	{
-		Language language;
 		langutil::EVMVersion evmVersion;
 		std::optional<uint8_t> eofVersion;
 		bool optimizeStackAllocation;

libyul/YulStack.cpp

@@ -58,7 +58,7 @@ bool YulStack::parse(std::string const& _sourceName, std::string const& _source)
 	{
 		m_charStream = std::make_unique<CharStream>(_source, _sourceName);
 		std::shared_ptr<Scanner> scanner = std::make_shared<Scanner>(*m_charStream);
-		m_parserResult = ObjectParser(m_errorReporter, languageToDialect(m_language, m_evmVersion, m_eofVersion)).parse(scanner, false);
+		m_parserResult = ObjectParser(m_errorReporter, EVMDialect::strictAssemblyForEVMObjects(m_evmVersion, m_eofVersion)).parse(scanner, false);
 	}
 	catch (UnimplementedFeatureError const& _error)
 	{
@@ -130,7 +130,6 @@ void YulStack::optimize()
 		m_objectOptimizer->optimize(
 			*m_parserResult,
 			ObjectOptimizer::Settings{
-				m_language,
 				m_evmVersion,
 				m_eofVersion,
 				optimizeStackAllocation,
@@ -166,7 +165,7 @@ bool YulStack::analyzeParsed(Object& _object)
 	AsmAnalyzer analyzer(
 		*_object.analysisInfo,
 		m_errorReporter,
-		languageToDialect(m_language, m_evmVersion, m_eofVersion),
+		EVMDialect::strictAssemblyForEVMObjects(m_evmVersion, m_eofVersion),
 		{},
 		_object.summarizeStructure()
 	);
@@ -210,7 +209,6 @@ void YulStack::reparse()
 	YulStack cleanStack(
 		m_evmVersion,
 		m_eofVersion,
-		m_language,
 		m_optimiserSettings,
 		m_debugInfoSelection,
 		m_soliditySourceProvider,
@@ -400,7 +398,7 @@ Json YulStack::cfgJson() const
 		// NOTE: The block Ids are reset for each object
 		std::unique_ptr<ssa::ControlFlow> controlFlow = ssa::SSACFGBuilder::build(
 			*_object.analysisInfo,
-			languageToDialect(m_language, m_evmVersion, m_eofVersion),
+			EVMDialect::strictAssemblyForEVMObjects(m_evmVersion, m_eofVersion),
 			_object.code()->root(),
 			keepLiteralAssignments
 		);

libyul/YulStack.h

@@ -69,7 +69,6 @@ struct MachineAssemblyObject
 class YulStack: public langutil::CharStreamProvider
 {
 public:
-	using Language = yul::Language;
 	enum class Machine { EVM };
 	enum State {
 		Empty,
@@ -81,7 +80,6 @@ class YulStack: public langutil::CharStreamProvider
 		YulStack(
 			langutil::EVMVersion{},
 			std::nullopt,
-			Language::Assembly,
 			solidity::frontend::OptimiserSettings::none(),
 			langutil::DebugInfoSelection::Default()
 		)
@@ -90,13 +88,11 @@ class YulStack: public langutil::CharStreamProvider
 	YulStack(
 		langutil::EVMVersion _evmVersion,
 		std::optional<uint8_t> _eofVersion,
-		Language _language,
 		solidity::frontend::OptimiserSettings _optimiserSettings,
 		langutil::DebugInfoSelection const& _debugInfoSelection,
 		langutil::CharStreamProvider const* _soliditySourceProvider = nullptr,
 		std::shared_ptr<ObjectOptimizer> _objectOptimizer = nullptr
 	):
-		m_language(_language),
 		m_evmVersion(_evmVersion),
 		m_eofVersion(_eofVersion),
 		m_optimiserSettings(std::move(_optimiserSettings)),
@@ -174,7 +170,6 @@ class YulStack: public langutil::CharStreamProvider
 
 	void reportUnimplementedFeatureError(langutil::UnimplementedFeatureError const& _error);
 
-	Language m_language = Language::Assembly;
 	langutil::EVMVersion m_evmVersion;
 	std::optional<uint8_t> m_eofVersion;
 	solidity::frontend::OptimiserSettings m_optimiserSettings;

solc/CommandLineInterface.cpp

@@ -848,7 +848,7 @@ void CommandLineInterface::processInput()
 		serveLSP();
 		break;
 	case InputMode::Assembler:
-		assembleYul(m_options.assembly.inputLanguage, m_options.assembly.targetMachine);
+		assembleYul(m_options.assembly.targetMachine);
 		break;
 	case InputMode::Linker:
 		link();
@@ -1286,7 +1286,7 @@ std::string CommandLineInterface::objectWithLinkRefsHex(evmasm::LinkerObject con
 	return out;
 }
 
-void CommandLineInterface::assembleYul(yul::YulStack::Language _language, yul::YulStack::Machine _targetMachine)
+void CommandLineInterface::assembleYul(yul::YulStack::Machine _targetMachine)
 {
 	solAssert(m_options.input.mode == InputMode::Assembler);
 
@@ -1298,7 +1298,6 @@ void CommandLineInterface::assembleYul(yul::YulStack::Language _language, yul::Y
 		auto& stack = yulStacks[sourceUnitName] = yul::YulStack(
 			m_options.output.evmVersion,
 			m_options.output.eofVersion,
-			_language,
 			m_options.optimiserSettings(),
 			m_options.output.debugInfoSelection.has_value() ?
 				m_options.output.debugInfoSelection.value() :

solc/CommandLineInterface.h

@@ -95,7 +95,7 @@ class CommandLineInterface
 	/// @returns the full object with library placeholder hints in hex.
 	static std::string objectWithLinkRefsHex(evmasm::LinkerObject const& _obj);
 
-	void assembleYul(yul::YulStack::Language _language, yul::YulStack::Machine _targetMachine);
+	void assembleYul(yul::YulStack::Machine _targetMachine);
 
 	void outputCompilationResults();
 

solc/CommandLineParser.cpp

@@ -630,11 +630,6 @@ General Information)").c_str(),
 			"(experimental) Select desired EOF version. Currently the only valid value is 1. "
 			"If not specified, non-EOF bytecode will be generated."
 		)
-		(
-			g_strYul.c_str(),
-			"(disabled) Switch to typed Yul mode. The typed Yul dialect is no longer supported. "
-			"For regular Yul compilation use --strict-assembly instead."
-		)
 		(
 			g_strExperimentalViaIR.c_str(),
 			"Deprecated synonym of --via-ir."
@@ -681,10 +676,6 @@ General Information)").c_str(),
 			("Switch to linker mode, ignoring all options apart from --" + g_strLibraries + " "
 			"and modify binaries in place.").c_str()
 		)
-		(
-			g_strAssemble.c_str(),
-			"Switch to assembly mode and assume input is assembly."
-		)
 		(
 			g_strStrictAssembly.c_str(),
 			"Switch to strict assembly mode and assume input is strict assembly."
@@ -967,6 +958,12 @@ po::positional_options_description CommandLineParser::positionalOptionsDescripti
 void CommandLineParser::parseArgs(int _argc, char const* const* _argv)
 {
 	po::options_description allOptions = optionsDescription();
+	// Disabled options: still accepted for parsing so that we can produce a proper error message,
+	// but hidden from --help output.
+	allOptions.add_options()
+		(g_strAssemble.c_str(), "")
+		(g_strYul.c_str(), "")
+	;
 	po::positional_options_description filesPositions = positionalOptionsDescription();
 
 	m_options = {};
@@ -1004,7 +1001,6 @@ void CommandLineParser::processArgs()
 		g_strVersion,
 		g_strStandardJSON,
 		g_strLink,
-		g_strAssemble,
 		g_strStrictAssembly,
 		g_strImportAst,
 		g_strLSP,
@@ -1023,7 +1019,7 @@ void CommandLineParser::processArgs()
 		m_options.input.mode = InputMode::StandardJson;
 	else if (m_args.count(g_strLSP))
 		m_options.input.mode = InputMode::LanguageServer;
-	else if (m_args.count(g_strAssemble) > 0 || m_args.count(g_strStrictAssembly) > 0)
+	else if (m_args.contains(g_strStrictAssembly))
 		m_options.input.mode = InputMode::Assembler;
 	else if (m_args.count(g_strLink) > 0)
 		m_options.input.mode = InputMode::Linker;
@@ -1056,6 +1052,13 @@ void CommandLineParser::processArgs()
 			"please use --strict-assembly instead."
 		);
 
+	if (m_args.contains(g_strAssemble))
+		solThrow(
+			CommandLineValidationError,
+			"The assembly input mode formerly accessible via --assemble is no longer supported, "
+			"please use --strict-assembly instead."
+		);
+
 	std::map<std::string, std::set<InputMode>> validOptionInputModeCombinations = {
 		// TODO: This should eventually contain all options.
 		{g_strExperimentalViaIR, {InputMode::Compiler, InputMode::CompilerWithASTImport}},
@@ -1356,9 +1359,7 @@ void CommandLineParser::processArgs()
 		}
 
 		// switch to assembly mode
-		using Input = yul::YulStack::Language;
 		using Machine = yul::YulStack::Machine;
-		m_options.assembly.inputLanguage = m_args.count(g_strStrictAssembly) ? Input::StrictAssembly : Input::Assembly;
 
 		if (m_args.count(g_strMachine))
 		{
@@ -1368,30 +1369,15 @@ void CommandLineParser::processArgs()
 			else
 				solThrow(CommandLineValidationError, "Invalid option for --" + g_strMachine + ": " + machine);
 		}
-		if (m_args.count(g_strYulDialect))
+		if (m_args.contains(g_strYulDialect))
 		{
-			std::string dialect = m_args[g_strYulDialect].as<std::string>();
-			if (dialect == g_strEVM)
-				m_options.assembly.inputLanguage = Input::StrictAssembly;
-			else
+			auto const& dialect = m_args[g_strYulDialect].as<std::string>();
+			if (dialect != g_strEVM)
 				solThrow(CommandLineValidationError, "Invalid option for --" + g_strYulDialect + ": " + dialect);
 		}
-		if (
-				(m_options.optimizer.optimizeEvmasm || m_options.optimizer.optimizeYul) &&
-				m_options.assembly.inputLanguage != Input::StrictAssembly
-			)
-			solThrow(
-				CommandLineValidationError,
-				"Optimizer can only be used for strict assembly. Use --"  + g_strStrictAssembly + "."
-			);
 
 		m_options.output.viaSSACFG = m_args.contains(g_strViaSSACFG);
-		if (m_options.output.viaSSACFG)
-			if (m_options.assembly.inputLanguage != Input::StrictAssembly)
-				solThrow(
-					CommandLineValidationError,
-					"--" + g_strViaSSACFG + " can only be used with strict assembly. Use --" + g_strStrictAssembly + "."
-				);
+
 		if (m_options.compiler.outputs.ethdebug || m_options.compiler.outputs.ethdebugRuntime)
 		{
 			if (m_options.output.viaSSACFG)