Merge remote-tracking branch 'origin/vm' into develop-evmcc

solidityEndToEndTest.cpp

@@ -24,137 +24,18 @@
 #include <string>
 #include <tuple>
 #include <boost/test/unit_test.hpp>
-#include <libethereum/State.h>
-#include <libethereum/Executive.h>
-#include <libsolidity/CompilerStack.h>
 #include <libdevcrypto/SHA3.h>
+#include <test/solidityExecutionFramework.h>
 
 using namespace std;
 
 namespace dev
 {
-/// Provides additional overloads for toBigEndian to encode arguments and return values.
-inline bytes toBigEndian(byte _value) { return bytes({_value}); }
-inline bytes toBigEndian(bool _value) { return bytes({byte(_value)}); }
-
 namespace solidity
 {
 namespace test
 {
 
-class ExecutionFramework
-{
-public:
-	ExecutionFramework() { g_logVerbosity = 0; }
-
-	bytes const& compileAndRun(string const& _sourceCode, u256 const& _value = 0, string const& _contractName = "")
-	{
-		dev::solidity::CompilerStack compiler;
-		compiler.compile(_sourceCode);
-		bytes code = compiler.getBytecode(_contractName);
-		sendMessage(code, true, _value);
-		BOOST_REQUIRE(!m_output.empty());
-		return m_output;
-	}
-
-	bytes const& callContractFunction(byte _index, bytes const& _data = bytes(), u256 const& _value = 0)
-	{
-		sendMessage(bytes(1, _index) + _data, false, _value);
-		return m_output;
-	}
-
-	template <class... Args>
-	bytes const& callContractFunction(byte _index, Args const&... _arguments)
-	{
-		return callContractFunction(_index, argsToBigEndian(_arguments...));
-	}
-
-	template <class CppFunction, class... Args>
-	void testSolidityAgainstCpp(byte _index, CppFunction const& _cppFunction, Args const&... _arguments)
-	{
-		bytes solidityResult = callContractFunction(_index, _arguments...);
-		bytes cppResult = callCppAndEncodeResult(_cppFunction, _arguments...);
-		BOOST_CHECK_MESSAGE(solidityResult == cppResult, "Computed values do not match."
-							"\nSolidity: " + toHex(solidityResult) + "\nC++:      " + toHex(cppResult));
-	}
-
-	template <class CppFunction, class... Args>
-	void testSolidityAgainstCppOnRange(byte _index, CppFunction const& _cppFunction,
-									   u256 const& _rangeStart, u256 const& _rangeEnd)
-	{
-		for (u256 argument = _rangeStart; argument < _rangeEnd; ++argument)
-		{
-			bytes solidityResult = callContractFunction(_index, argument);
-			bytes cppResult = callCppAndEncodeResult(_cppFunction, argument);
-			BOOST_CHECK_MESSAGE(solidityResult == cppResult, "Computed values do not match."
-								"\nSolidity: " + toHex(solidityResult) + "\nC++:      " + toHex(cppResult) +
-								"\nArgument: " + toHex(toBigEndian(argument)));
-		}
-	}
-
-private:
-	template <class FirstArg, class... Args>
-	bytes argsToBigEndian(FirstArg const& _firstArg, Args const&... _followingArgs) const
-	{
-		return toBigEndian(_firstArg) + argsToBigEndian(_followingArgs...);
-	}
-
-	bytes argsToBigEndian() const { return bytes(); }
-
-	template <class CppFunction, class... Args>
-	auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
-	-> typename enable_if<is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
-	{
-		_cppFunction(_arguments...);
-		return bytes();
-	}
-	template <class CppFunction, class... Args>
-	auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
-	-> typename enable_if<!is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
-	{
-		return toBigEndian(_cppFunction(_arguments...));
-	}
-
-	void sendMessage(bytes const& _data, bool _isCreation, u256 const& _value = 0)
-	{
-		m_state.addBalance(m_sender, _value); // just in case
-		eth::Executive executive(m_state);
-		eth::Transaction t = _isCreation ? eth::Transaction(_value, m_gasPrice, m_gas, _data, 0, KeyPair::create().sec())
-										 : eth::Transaction(_value, m_gasPrice, m_gas, m_contractAddress, _data, 0, KeyPair::create().sec());
-		bytes transactionRLP = t.rlp();
-		try
-		{
-			// this will throw since the transaction is invalid, but it should nevertheless store the transaction
-			executive.setup(&transactionRLP);
-		}
-		catch (...) {}
-		if (_isCreation)
-		{
-			BOOST_REQUIRE(!executive.create(m_sender, _value, m_gasPrice, m_gas, &_data, m_sender));
-			m_contractAddress = executive.newAddress();
-			BOOST_REQUIRE(m_contractAddress);
-			BOOST_REQUIRE(m_state.addressHasCode(m_contractAddress));
-		}
-		else
-		{
-			BOOST_REQUIRE(m_state.addressHasCode(m_contractAddress));
-			BOOST_REQUIRE(!executive.call(m_contractAddress, m_sender, _value, m_gasPrice, &_data, m_gas, m_sender));
-		}
-		BOOST_REQUIRE(executive.go());
-		m_state.noteSending(m_sender);
-		executive.finalize();
-		m_output = executive.out().toVector();
-	}
-
-protected:
-	Address m_sender;
-	Address m_contractAddress;
-	eth::State m_state;
-	u256 const m_gasPrice = 100 * eth::szabo;
-	u256 const m_gas = 1000000;
-	bytes m_output;
-};
-
 BOOST_FIXTURE_TEST_SUITE(SolidityCompilerEndToEndTest, ExecutionFramework)
 
 BOOST_AUTO_TEST_CASE(smoke_test)

solidityExecutionFramework.h

@@ -0,0 +1,161 @@
+
+/*
+	This file is part of cpp-ethereum.
+
+	cpp-ethereum is free software: you can redistribute it and/or modify
+	it under the terms of the GNU General Public License as published by
+	the Free Software Foundation, either version 3 of the License, or
+	(at your option) any later version.
+
+	cpp-ethereum is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU General Public License for more details.
+
+	You should have received a copy of the GNU General Public License
+	along with cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @author Christian <c@ethdev.com>
+ * @date 2014
+ * Framework for executing Solidity contracts and testing them against C++ implementation.
+ */
+
+#pragma once
+
+#include <string>
+#include <tuple>
+#include <boost/test/unit_test.hpp>
+#include <libethereum/State.h>
+#include <libethereum/Executive.h>
+#include <libsolidity/CompilerStack.h>
+
+namespace dev
+{
+/// Provides additional overloads for toBigEndian to encode arguments and return values.
+inline bytes toBigEndian(byte _value) { return bytes({_value}); }
+inline bytes toBigEndian(bool _value) { return bytes({byte(_value)}); }
+
+namespace solidity
+{
+namespace test
+{
+
+class ExecutionFramework
+{
+public:
+	ExecutionFramework() { g_logVerbosity = 0; }
+
+	bytes const& compileAndRun(std::string const& _sourceCode, u256 const& _value = 0, std::string const& _contractName = "")
+	{
+		dev::solidity::CompilerStack compiler;
+		compiler.compile(_sourceCode, m_optimize);
+		bytes code = compiler.getBytecode(_contractName);
+		sendMessage(code, true, _value);
+		BOOST_REQUIRE(!m_output.empty());
+		return m_output;
+	}
+
+	bytes const& callContractFunction(byte _index, bytes const& _data = bytes(), u256 const& _value = 0)
+	{
+		sendMessage(bytes(1, _index) + _data, false, _value);
+		return m_output;
+	}
+
+	template <class... Args>
+	bytes const& callContractFunction(byte _index, Args const&... _arguments)
+	{
+		return callContractFunction(_index, argsToBigEndian(_arguments...));
+	}
+
+	template <class CppFunction, class... Args>
+	void testSolidityAgainstCpp(byte _index, CppFunction const& _cppFunction, Args const&... _arguments)
+	{
+		bytes solidityResult = callContractFunction(_index, _arguments...);
+		bytes cppResult = callCppAndEncodeResult(_cppFunction, _arguments...);
+		BOOST_CHECK_MESSAGE(solidityResult == cppResult, "Computed values do not match."
+							"\nSolidity: " + toHex(solidityResult) + "\nC++:      " + toHex(cppResult));
+	}
+
+	template <class CppFunction, class... Args>
+	void testSolidityAgainstCppOnRange(byte _index, CppFunction const& _cppFunction,
+									   u256 const& _rangeStart, u256 const& _rangeEnd)
+	{
+		for (u256 argument = _rangeStart; argument < _rangeEnd; ++argument)
+		{
+			bytes solidityResult = callContractFunction(_index, argument);
+			bytes cppResult = callCppAndEncodeResult(_cppFunction, argument);
+			BOOST_CHECK_MESSAGE(solidityResult == cppResult, "Computed values do not match."
+								"\nSolidity: " + toHex(solidityResult) + "\nC++:      " + toHex(cppResult) +
+								"\nArgument: " + toHex(toBigEndian(argument)));
+		}
+	}
+
+private:
+	template <class FirstArg, class... Args>
+	bytes argsToBigEndian(FirstArg const& _firstArg, Args const&... _followingArgs) const
+	{
+		return toBigEndian(_firstArg) + argsToBigEndian(_followingArgs...);
+	}
+
+	bytes argsToBigEndian() const { return bytes(); }
+
+	template <class CppFunction, class... Args>
+	auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
+	-> typename std::enable_if<std::is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
+	{
+		_cppFunction(_arguments...);
+		return bytes();
+	}
+	template <class CppFunction, class... Args>
+	auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
+	-> typename std::enable_if<!std::is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
+	{
+		return toBigEndian(_cppFunction(_arguments...));
+	}
+
+	void sendMessage(bytes const& _data, bool _isCreation, u256 const& _value = 0)
+	{
+		m_state.addBalance(m_sender, _value); // just in case
+		eth::Executive executive(m_state);
+		eth::Transaction t = _isCreation ? eth::Transaction(_value, m_gasPrice, m_gas, _data, 0, KeyPair::create().sec())
+										 : eth::Transaction(_value, m_gasPrice, m_gas, m_contractAddress, _data, 0, KeyPair::create().sec());
+		bytes transactionRLP = t.rlp();
+		try
+		{
+			// this will throw since the transaction is invalid, but it should nevertheless store the transaction
+			executive.setup(&transactionRLP);
+		}
+		catch (...) {}
+		if (_isCreation)
+		{
+			BOOST_REQUIRE(!executive.create(m_sender, _value, m_gasPrice, m_gas, &_data, m_sender));
+			m_contractAddress = executive.newAddress();
+			BOOST_REQUIRE(m_contractAddress);
+			BOOST_REQUIRE(m_state.addressHasCode(m_contractAddress));
+		}
+		else
+		{
+			BOOST_REQUIRE(m_state.addressHasCode(m_contractAddress));
+			BOOST_REQUIRE(!executive.call(m_contractAddress, m_sender, _value, m_gasPrice, &_data, m_gas, m_sender));
+		}
+		BOOST_REQUIRE(executive.go());
+		m_state.noteSending(m_sender);
+		executive.finalize();
+		m_output = executive.out().toVector();
+	}
+
+protected:
+	bool m_optimize = false;
+	Address m_sender;
+	Address m_contractAddress;
+	eth::State m_state;
+	u256 const m_gasPrice = 100 * eth::szabo;
+	u256 const m_gas = 1000000;
+	bytes m_output;
+};
+
+}
+}
+} // end namespaces
+

solidityNatspecJSON.cpp

@@ -22,6 +22,7 @@
 
 #include <boost/test/unit_test.hpp>
 #include <libsolidity/CompilerStack.h>
+#include <libsolidity/Exceptions.h>
 #include <jsonrpc/json/json.h>
 #include <libdevcore/Exceptions.h>
 
@@ -393,6 +394,93 @@ BOOST_AUTO_TEST_CASE(dev_multiline_return)
 	checkNatspec(sourceCode, natspec, false);
 }
 
+BOOST_AUTO_TEST_CASE(dev_contract_no_doc)
+{
+	char const* sourceCode = "contract test {\n"
+	"  /// @dev Mul function\n"
+	"  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
+	"}\n";
+
+	char const* natspec = "{"
+	"    \"methods\":{"
+	"        \"mul\":{ \n"
+	"            \"details\": \"Mul function\"\n"
+	"        }\n"
+	"    }\n"
+	"}";
+
+	checkNatspec(sourceCode, natspec, false);
+}
+
+BOOST_AUTO_TEST_CASE(dev_contract_doc)
+{
+	char const* sourceCode = " /// @author Lefteris\n"
+	" /// @title Just a test contract\n"
+	"contract test {\n"
+	"  /// @dev Mul function\n"
+	"  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
+	"}\n";
+
+	char const* natspec = "{"
+	"    \"author\": \"Lefteris\","
+	"    \"title\": \"Just a test contract\","
+	"    \"methods\":{"
+	"        \"mul\":{ \n"
+	"            \"details\": \"Mul function\"\n"
+	"        }\n"
+	"    }\n"
+	"}";
+
+	checkNatspec(sourceCode, natspec, false);
+}
+
+BOOST_AUTO_TEST_CASE(dev_author_at_function)
+{
+	char const* sourceCode = " /// @author Lefteris\n"
+	" /// @title Just a test contract\n"
+	"contract test {\n"
+	"  /// @dev Mul function\n"
+	"  /// @author John Doe\n"
+	"  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
+	"}\n";
+
+	char const* natspec = "{"
+	"    \"author\": \"Lefteris\","
+	"    \"title\": \"Just a test contract\","
+	"    \"methods\":{"
+	"        \"mul\":{ \n"
+	"            \"details\": \"Mul function\",\n"
+	"            \"author\": \"John Doe\",\n"
+	"        }\n"
+	"    }\n"
+	"}";
+
+	checkNatspec(sourceCode, natspec, false);
+}
+
+BOOST_AUTO_TEST_CASE(dev_title_at_function_error)
+{
+	char const* sourceCode = " /// @author Lefteris\n"
+	" /// @title Just a test contract\n"
+	"contract test {\n"
+	"  /// @dev Mul function\n"
+	"  /// @title I really should not be here\n"
+	"  function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n"
+	"}\n";
+
+	char const* natspec = "{"
+	"    \"author\": \"Lefteris\","
+	"    \"title\": \"Just a test contract\","
+	"    \"methods\":{"
+	"        \"mul\":{ \n"
+	"            \"details\": \"Mul function\"\n"
+	"        }\n"
+	"    }\n"
+	"}";
+
+	BOOST_CHECK_THROW(checkNatspec(sourceCode, natspec, false), DocstringParsingError);
+}
+
 BOOST_AUTO_TEST_SUITE_END()
 
 }

solidityOptimizerTest.cpp

@@ -0,0 +1,131 @@
+
+/*
+	This file is part of cpp-ethereum.
+
+	cpp-ethereum is free software: you can redistribute it and/or modify
+	it under the terms of the GNU General Public License as published by
+	the Free Software Foundation, either version 3 of the License, or
+	(at your option) any later version.
+
+	cpp-ethereum is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY; without even the implied warranty of
+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+	GNU General Public License for more details.
+
+	You should have received a copy of the GNU General Public License
+	along with cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @author Christian <c@ethdev.com>
+ * @date 2014
+ * Tests for the Solidity optimizer.
+ */
+
+#include <string>
+#include <tuple>
+#include <boost/test/unit_test.hpp>
+#include <boost/lexical_cast.hpp>
+#include <test/solidityExecutionFramework.h>
+
+using namespace std;
+
+namespace dev
+{
+namespace solidity
+{
+namespace test
+{
+
+class OptimizerTestFramework: public ExecutionFramework
+{
+public:
+	OptimizerTestFramework() { }
+	/// Compiles the source code with and without optimizing.
+	void compileBothVersions(unsigned _expectedSizeDecrease, std::string const& _sourceCode, u256 const& _value = 0, std::string const& _contractName = "") {
+		m_optimize = false;
+		bytes nonOptimizedBytecode = compileAndRun(_sourceCode, _value, _contractName);
+		m_nonOptimizedContract = m_contractAddress;
+		m_optimize = true;
+		bytes optimizedBytecode = compileAndRun(_sourceCode, _value, _contractName);
+		int sizeDiff = nonOptimizedBytecode.size() - optimizedBytecode.size();
+		BOOST_CHECK_MESSAGE(sizeDiff >= _expectedSizeDecrease, "Bytecode did only shrink by "
+							+ boost::lexical_cast<string>(sizeDiff) + " bytes, expected: "
+							+ boost::lexical_cast<string>(_expectedSizeDecrease));
+		m_optimizedContract = m_contractAddress;
+	}
+
+	template <class... Args>
+	void compareVersions(byte _index, Args const&... _arguments)
+	{
+		m_contractAddress = m_nonOptimizedContract;
+		bytes nonOptimizedOutput = callContractFunction(_index, _arguments...);
+		m_contractAddress = m_optimizedContract;
+		bytes optimizedOutput = callContractFunction(_index, _arguments...);
+		BOOST_CHECK_MESSAGE(nonOptimizedOutput == optimizedOutput, "Computed values do not match."
+							"\nNon-Optimized: " + toHex(nonOptimizedOutput) +
+							"\nOptimized:     " + toHex(optimizedOutput));
+	}
+
+protected:
+	Address m_optimizedContract;
+	Address m_nonOptimizedContract;
+};
+
+BOOST_FIXTURE_TEST_SUITE(SolidityOptimizerTest, OptimizerTestFramework)
+
+BOOST_AUTO_TEST_CASE(smoke_test)
+{
+	char const* sourceCode = R"(
+		contract test {
+			function f(uint a) returns (uint b) {
+				return a;
+			}
+		})";
+	compileBothVersions(4, sourceCode);
+	compareVersions(0, u256(7));
+}
+
+BOOST_AUTO_TEST_CASE(large_integers)
+{
+	char const* sourceCode = R"(
+		contract test {
+			function f() returns (uint a, uint b) {
+				a = 0x234234872642837426347000000;
+				b = 0x110000000000000000000000002;
+			}
+		})";
+	compileBothVersions(28, sourceCode);
+	compareVersions(0);
+}
+
+BOOST_AUTO_TEST_CASE(invariants)
+{
+	char const* sourceCode = R"(
+		contract test {
+			function f(uint a) returns (uint b) {
+				return (((a + (1 - 1)) ^ 0) | 0) & (uint(0) - 1);
+			}
+		})";
+	compileBothVersions(19, sourceCode);
+	compareVersions(0, u256(0x12334664));
+}
+
+BOOST_AUTO_TEST_CASE(unused_expressions)
+{
+	char const* sourceCode = R"(
+		contract test {
+			uint data;
+			function f() returns (uint a, uint b) {
+				10 + 20;
+				data;
+			}
+		})";
+	compileBothVersions(11, sourceCode);
+	compareVersions(0);
+}
+
+BOOST_AUTO_TEST_SUITE_END()
+
+}
+}
+} // end namespaces

vm.cpp

@@ -244,10 +244,11 @@ void FakeExtVM::importCallCreates(mArray& _callcreates)
 
 eth::OnOpFunc FakeExtVM::simpleTrace()
 {
-	return [](uint64_t steps, eth::Instruction inst, bigint newMemSize, bigint gasCost, void* voidVM, void const* voidExt)
+
+	return [](uint64_t steps, eth::Instruction inst, bigint newMemSize, bigint gasCost, dev::eth::VM* voidVM, dev::eth::ExtVMFace const* voidExt)
 	{
-		FakeExtVM const& ext = *(FakeExtVM const*)voidExt;
+		FakeExtVM const& ext = *static_cast<FakeExtVM const*>(voidExt);
-		eth::VM& vm = *(eth::VM*)voidVM;
+		eth::VM& vm = *voidVM;
 
 		std::ostringstream o;
 		o << std::endl << "    STACK" << std::endl;

vm.h

@@ -80,9 +80,6 @@ public:
 	bytes thisTxData;
 	bytes thisTxCode;
 	u256 gas;
-
-private:
-	eth::Manifest m_ms;
 };