Introduce experimental flag/option

Author: nikola-matic

libsolidity/interface/CompilerStack.cpp

@@ -229,6 +229,12 @@ void CompilerStack::setViaIR(bool _viaIR)
 	m_viaIR = _viaIR;
 }
 
+void CompilerStack::setExperimental(bool _experimental)
+{
+	solAssert(m_stackState < ParsedAndImported, "Must set experimental before parsing.");
+	m_experimental = _experimental;
+}
+
 void CompilerStack::setEVMVersion(langutil::EVMVersion _version)
 {
 	solAssert(m_stackState < ParsedAndImported, "Must set EVM version before parsing.");

libsolidity/interface/CompilerStack.h

@@ -223,6 +223,9 @@ class CompilerStack: public langutil::CharStreamProvider, public evmasm::Abstrac
 	/// Must be set before parsing.
 	void setViaIR(bool _viaIR);
 
+	/// Sets the experimental toggle to allow usage of experimental features.
+	void setExperimental(bool _experimental);
+
 	/// Set the EVM version used before running compile.
 	/// When called without an argument it will revert to the default version.
 	/// Must be set before parsing.
@@ -607,6 +610,7 @@ class CompilerStack: public langutil::CharStreamProvider, public evmasm::Abstrac
 	RevertStrings m_revertStrings = RevertStrings::Default;
 	State m_stopAfter = State::CompilationSuccessful;
 	bool m_viaIR = false;
+	bool m_experimental = false;
 	langutil::EVMVersion m_evmVersion;
 	std::optional<uint8_t> m_eofVersion;
 	ModelCheckerSettings m_modelCheckerSettings;

scripts/ASTImportTest.sh

@@ -117,7 +117,7 @@ function test_ast_import_export_equivalence
     local input_files=( "${@:2}" )
 
     local export_command=("$SOLC" --combined-json ast --pretty-json --json-indent 4 "${input_files[@]}")
-    local import_command=("$SOLC" --import-ast --combined-json ast --pretty-json --json-indent 4 expected.json)
+    local import_command=("$SOLC" --experimental --import-ast --combined-json ast --pretty-json --json-indent 4 expected.json)
     local import_via_standard_json_command=("$SOLC" --combined-json ast --pretty-json --json-indent 4 --standard-json standard_json_input.json)
 
     # export ast - save ast json as expected result (silently)
@@ -228,7 +228,7 @@ function test_evmjson_import_export_equivalence
         local bin_file_from_asm_import
         bin_file_from_asm_import="import/$(basename "${asm_json_file}" .json).bin"
 
-        local import_options=(--bin --import-asm-json "${asm_json_file}")
+        local import_options=(--experimental --bin --import-asm-json "${asm_json_file}")
         run_solc_store_stdout "${bin_file_from_asm_import}" "${import_options[@]}"
 
         stripCLIDecorations < "$bin_file_from_asm_import" > tmpfile

solc/CommandLineInterface.cpp

@@ -927,6 +927,7 @@ void CommandLineInterface::compile()
 
 	try
 	{
+		m_compiler->setExperimental(m_options.experimental);
 		if (m_options.metadata.literalSources)
 			m_compiler->useMetadataLiteralSources(true);
 		m_compiler->setMetadataFormat(m_options.metadata.format);

solc/CommandLineParser.cpp

@@ -50,6 +50,7 @@ static std::string const g_strEVMVersion = "evm-version";
 static std::string const g_strEOFVersion = "experimental-eof-version";
 static std::string const g_strViaIR = "via-ir";
 static std::string const g_strExperimentalViaIR = "experimental-via-ir";
+static std::string const g_strExperimental = "experimental";
 static std::string const g_strGas = "gas";
 static std::string const g_strHelp = "help";
 static std::string const g_strImportAst = "import-ast";
@@ -157,6 +158,18 @@ void CommandLineParser::checkMutuallyExclusive(std::vector<std::string> const& _
 	}
 }
 
+void CommandLineParser::checkExperimental(std::vector<std::string> const& _optionNames)
+{
+	if (!m_args.contains(g_strExperimental) && countEnabledOptions(_optionNames) > 0)
+	{
+		solThrow(
+			CommandLineValidationError,
+			"The following options are only available in experimental mode: " + joinOptionNames(_optionNames) + ". " +
+			"To toggle experimental mode, use the --experimental flag."
+		);
+	}
+}
+
 bool CompilerOutputs::operator==(CompilerOutputs const& _other) const noexcept
 {
 	for (bool CompilerOutputs::* member: componentMap() | ranges::views::values)
@@ -936,6 +949,17 @@ General Information)").c_str(),
 	;
 	desc.add(smtCheckerOptions);
 
+	po::options_description experimentalOptions("Experimental options");
+	experimentalOptions.add_options()
+		(
+			g_strExperimental.c_str(),
+			"Toggle experimental mode. Note that toggling experimental mode by itself will not "
+			"enable any experimental features, but will simply allow for such features to be enabled in the "
+			"usual manner, whether by using specific flags or pragmas."
+		)
+	;
+	desc.add(experimentalOptions);
+
 	desc.add_options()(g_strInputFile.c_str(), po::value<std::vector<std::string>>(), "input file");
 	return desc;
 }
@@ -979,6 +1003,9 @@ void CommandLineParser::processArgs()
 	else if (m_args.count(g_strColor) > 0)
 		m_options.formatting.coloredOutput = true;
 
+	if (m_args.contains(g_strExperimental))
+		m_options.experimental = true;
+
 	checkMutuallyExclusive({
 		g_strHelp,
 		g_strLicense,
@@ -992,6 +1019,18 @@ void CommandLineParser::processArgs()
 		g_strImportEvmAssemblerJson,
 	});
 
+	checkExperimental({
+		g_strLSP,
+		g_strImportAst,
+		g_strImportEvmAssemblerJson,
+		"ir-ast-json",
+		"ir-optimized-ast-json",
+		"yul-cfg-json",
+		"ethdebug",
+		"ethdebug-runtime",
+		g_strEOFVersion,
+	});
+
 	if (m_args.count(g_strHelp) > 0)
 		m_options.input.mode = InputMode::Help;
 	else if (m_args.count(g_strLicense) > 0)
@@ -1092,6 +1131,7 @@ void CommandLineParser::processArgs()
 			g_strPrettyJson,
 			"srcmap",
 			"srcmap-runtime",
+			g_strExperimental,
 		};
 
 		for (auto const& [optionName, optionValue]: m_args)
@@ -1159,6 +1199,12 @@ void CommandLineParser::processArgs()
 		if (!m_options.output.debugInfoSelection.has_value())
 			solThrow(CommandLineValidationError, "Invalid value for --" + g_strDebugInfo + " option: " + optionValue);
 
+		if (!m_options.experimental && m_options.output.debugInfoSelection->ethdebug)
+			solThrow(
+				CommandLineValidationError,
+				"--" + g_strDebugInfo + " ethdebug can only be used by toggling the --" + g_strExperimental + " flag."
+			);
+
 		if (m_options.output.debugInfoSelection->snippet && !m_options.output.debugInfoSelection->location)
 			solThrow(CommandLineValidationError, "To use 'snippet' with --" + g_strDebugInfo + " you must select also 'location'.");
 	}

solc/CommandLineParser.h

@@ -245,6 +245,8 @@ struct CommandLineOptions
 		bool initialize = false;
 		ModelCheckerSettings settings;
 	} modelChecker;
+
+	bool experimental = false;
 };
 
 /// Parses the command-line arguments and produces a filled-out CommandLineOptions structure.
@@ -296,6 +298,7 @@ class CommandLineParser
 	void parseOutputSelection();
 
 	void checkMutuallyExclusive(std::vector<std::string> const& _optionNames);
+	void checkExperimental(std::vector<std::string> const& _optionNames);
 	size_t countEnabledOptions(std::vector<std::string> const& _optionNames) const;
 	static std::string joinOptionNames(std::vector<std::string> const& _optionNames, std::string _separator = ", ");
 

test/cmdlineTests/asm_json_import_sourcelist_with_null_elements/args

@@ -1 +1 @@
---pretty-json --json-indent 4 --import-asm-json -
+--pretty-json --json-indent 4 --experimental --import-asm-json -

test/cmdlineTests/asm_json_yul_export_evm_asm_import/args

@@ -1 +1 @@
---import-asm-json - --opcodes --asm --bin --asm-json --pretty-json --json-indent 4
+--experimental --import-asm-json - --opcodes --asm --bin --asm-json --pretty-json --json-indent 4

test/cmdlineTests/ast_ir/args

@@ -1 +1 @@
---ir-ast-json --ir-optimized-ast-json --optimize --pretty-json --json-indent 4
+--experimental --ir-ast-json --ir-optimized-ast-json --optimize --pretty-json --json-indent 4

test/cmdlineTests/ast_json_import_wrong_evmVersion/args

@@ -1 +1 @@
---evm-version=homestead --import-ast --combined-json ast --pretty-json
+--experimental --evm-version=homestead --import-ast --combined-json ast --pretty-json