solidity/libsolidity/interface/CompilerStack.h

299 lines
12 KiB
C
Raw Normal View History

/*
This file is part of solidity.
solidity 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.
solidity 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 solidity. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @author Christian <c@ethdev.com>
2015-01-09 06:39:30 +00:00
* @author Gav Wood <g@ethdev.com>
* @date 2014
* Full-stack compiler that converts a source code string to bytecode.
*/
#pragma once
#include <ostream>
#include <string>
#include <memory>
2015-03-02 00:13:10 +00:00
#include <vector>
2016-01-12 00:04:39 +00:00
#include <functional>
#include <boost/noncopyable.hpp>
#include <boost/filesystem.hpp>
2015-01-28 07:50:53 +00:00
#include <json/json.h>
#include <libdevcore/Common.h>
#include <libdevcore/FixedHash.h>
#include <libevmasm/SourceLocation.h>
#include <libevmasm/LinkerObject.h>
2015-10-20 22:21:52 +00:00
#include <libsolidity/interface/Exceptions.h>
2017-04-10 11:48:41 +00:00
#include <libsolidity/interface/ReadFile.h>
2015-03-02 16:34:43 +00:00
namespace dev
{
2015-03-02 00:13:10 +00:00
2015-03-02 16:34:43 +00:00
namespace eth
{
2015-10-07 13:57:17 +00:00
class Assembly;
2015-03-02 16:34:43 +00:00
class AssemblyItem;
using AssemblyItems = std::vector<AssemblyItem>;
2015-03-02 00:13:10 +00:00
}
2015-03-02 16:34:43 +00:00
namespace solidity
{
// forward declarations
class Scanner;
2017-01-31 21:59:56 +00:00
class ASTNode;
class ContractDefinition;
2015-05-26 09:27:59 +00:00
class FunctionDefinition;
2014-12-03 06:46:55 +00:00
class SourceUnit;
class Compiler;
class GlobalContext;
class InterfaceHandler;
2015-10-16 11:48:38 +00:00
class Error;
2017-01-31 21:59:56 +00:00
class DeclarationContainer;
enum class DocumentationType: uint8_t
{
2015-02-09 13:12:36 +00:00
NatspecUser = 1,
NatspecDev,
2016-08-17 09:39:10 +00:00
ABIInterface
};
/**
* Easy to use and self-contained Solidity compiler with as few header dependencies as possible.
* It holds state and can be used to either step through the compilation stages (and abort e.g.
* before compilation to bytecode) or run the whole compilation in one call.
*/
class CompilerStack: boost::noncopyable
{
public:
2016-01-12 00:04:39 +00:00
/// Creates a new compiler stack.
/// @param _readFile callback to used to read files for import statements. Must return
/// and must not emit exceptions.
2017-04-10 11:48:41 +00:00
explicit CompilerStack(ReadFile::Callback const& _readFile = ReadFile::Callback());
/// Sets path remappings in the format "context:prefix=target"
void setRemappings(std::vector<std::string> const& _remappings);
/// Resets the compiler to a state where the sources are not parsed or even removed.
2016-08-15 14:58:01 +00:00
void reset(bool _keepSources = false);
/// Adds a source object (e.g. file) to the parser. After this, parse has to be called again.
/// @returns true if a source object by the name already existed and was replaced.
2015-09-22 10:07:34 +00:00
void addSources(StringMap const& _nameContents, bool _isLibrary = false)
{
for (auto const& i: _nameContents) addSource(i.first, i.second, _isLibrary);
}
2015-02-20 17:15:34 +00:00
bool addSource(std::string const& _name, std::string const& _content, bool _isLibrary = false);
void setSource(std::string const& _sourceCode);
/// Parses all source units that were added
2015-09-21 17:43:56 +00:00
/// @returns false on error.
bool parse();
/// Sets the given source code as the only source unit apart from standard sources and parses it.
2015-09-21 17:43:56 +00:00
/// @returns false on error.
bool parse(std::string const& _sourceCode);
/// performs the analyisis steps (imports, scopesetting, syntaxCheck, referenceResolving,
2017-04-27 10:56:56 +00:00
/// typechecking, staticAnalysis) on previously set sources
/// @returns false on error.
bool analyze();
/// Parses and analyzes all source units that were added
/// @returns false on error.
bool parseAndAnalyze();
/// Sets the given source code as the only source unit apart from standard sources and parses and analyzes it.
/// @returns false on error.
bool parseAndAnalyze(std::string const& _sourceCode);
/// @returns a list of the contract names in the sources.
2015-08-31 16:44:29 +00:00
std::vector<std::string> contractNames() const;
std::string defaultContractName() const;
/// Compiles the source units that were previously added and parsed.
2015-09-21 17:43:56 +00:00
/// @returns false on error.
2016-11-14 10:46:43 +00:00
bool compile(
bool _optimize = false,
unsigned _runs = 200,
std::map<std::string, h160> const& _libraries = std::map<std::string, h160>{}
);
/// Parses and compiles the given source code.
2015-09-21 17:43:56 +00:00
/// @returns false on error.
2016-12-01 10:44:13 +00:00
bool compile(std::string const& _sourceCode, bool _optimize = false, unsigned _runs = 200);
2015-10-21 14:43:31 +00:00
/// Tries to translate all source files into a language suitable for formal analysis.
2016-07-18 16:16:22 +00:00
/// @param _errors list to store errors - defaults to the internal error list.
2015-10-21 14:43:31 +00:00
/// @returns false on error.
2016-07-18 16:16:22 +00:00
bool prepareFormalAnalysis(ErrorList* _errors = nullptr);
2015-10-21 14:43:31 +00:00
std::string const& formalTranslation() const { return m_formalTranslation; }
2015-09-11 17:35:01 +00:00
/// @returns the assembled object for a contract.
eth::LinkerObject const& object(std::string const& _contractName = "") const;
2015-09-11 17:35:01 +00:00
/// @returns the runtime object for the contract.
eth::LinkerObject const& runtimeObject(std::string const& _contractName = "") const;
/// @returns the bytecode of a contract that uses an already deployed contract via DELEGATECALL.
2015-07-31 17:23:31 +00:00
/// The returned bytes will contain a sequence of 20 bytes of the format "XXX...XXX" which have to
/// substituted by the actual address. Note that this sequence starts end ends in three X
/// characters but can contain anything in between.
eth::LinkerObject const& cloneObject(std::string const& _contractName = "") const;
2015-03-02 00:13:10 +00:00
/// @returns normal contract assembly items
2015-08-31 16:44:29 +00:00
eth::AssemblyItems const* assemblyItems(std::string const& _contractName = "") const;
2015-03-02 00:13:10 +00:00
/// @returns runtime contract assembly items
2015-08-31 16:44:29 +00:00
eth::AssemblyItems const* runtimeAssemblyItems(std::string const& _contractName = "") const;
2016-07-01 08:14:50 +00:00
/// @returns the string that provides a mapping between bytecode and sourcecode or a nullptr
/// if the contract does not (yet) have bytecode.
std::string const* sourceMapping(std::string const& _contractName = "") const;
/// @returns the string that provides a mapping between runtime bytecode and sourcecode.
/// if the contract does not (yet) have bytecode.
std::string const* runtimeSourceMapping(std::string const& _contractName = "") const;
/// @returns either the contract's name or a mixture of its name and source file, sanitized for filesystem use
std::string const filesystemFriendlyName(std::string const& _contractName) const;
/// @returns hash of the runtime bytecode for the contract, i.e. the code that is
/// returned by the constructor or the zero-h256 if the contract still needs to be linked or
/// does not have runtime code.
2015-08-31 16:44:29 +00:00
dev::h256 contractCodeHash(std::string const& _contractName = "") const;
/// Streams a verbose version of the assembly to @a _outStream.
/// @arg _sourceCodes is the map of input files to source code strings
2015-04-14 09:38:36 +00:00
/// @arg _inJsonFromat shows whether the out should be in Json format
/// Prerequisite: Successful compilation.
2015-01-28 07:50:53 +00:00
Json::Value streamAssembly(std::ostream& _outStream, std::string const& _contractName = "", StringMap _sourceCodes = StringMap(), bool _inJsonFormat = false) const;
2016-07-01 08:14:50 +00:00
/// @returns the list of sources (paths) used
std::vector<std::string> sourceNames() const;
/// @returns a mapping assigning each source name its index inside the vector returned
/// by sourceNames().
std::map<std::string, unsigned> sourceIndices() const;
/// @returns a JSON representing the contract interface.
/// Prerequisite: Successful call to parse or compile.
Json::Value const& interface(std::string const& _contractName = "") const;
/// @returns a JSON representing the contract's documentation.
/// Prerequisite: Successful call to parse or compile.
/// @param type The type of the documentation to get.
2015-01-09 06:39:30 +00:00
/// Can be one of 4 types defined at @c DocumentationType
Json::Value const& metadata(std::string const& _contractName, DocumentationType _type) const;
2016-11-14 10:46:43 +00:00
std::string const& onChainMetadata(std::string const& _contractName) const;
void useMetadataLiteralSources(bool _metadataLiteralSources) { m_metadataLiteralSources = _metadataLiteralSources; }
2017-04-10 13:00:24 +00:00
/// @returns a JSON representing the estimated gas usage for contract creation, internal and external functions
Json::Value gasEstimates(std::string const& _contractName) const;
/// @returns the previously used scanner, useful for counting lines during error reporting.
2015-08-31 16:44:29 +00:00
Scanner const& scanner(std::string const& _sourceName = "") const;
/// @returns the parsed source unit with the supplied name.
SourceUnit const& ast(std::string const& _sourceName = "") const;
/// @returns the parsed contract with the supplied name. Throws an exception if the contract
/// does not exist.
2015-08-31 16:44:29 +00:00
ContractDefinition const& contractDefinition(std::string const& _contractName) const;
2015-05-26 09:27:59 +00:00
/// @returns the offset of the entry point of the given function into the list of assembly items
/// or zero if it is not found or does not exist.
2015-08-31 16:44:29 +00:00
size_t functionEntryPoint(
2015-05-26 09:27:59 +00:00
std::string const& _contractName,
FunctionDefinition const& _function
) const;
/// Helper function for logs printing. Do only use in error cases, it's quite expensive.
/// line and columns are numbered starting from 1 with following order:
/// start line, start column, end line, end column
std::tuple<int, int, int, int> positionFromSourceLocation(SourceLocation const& _sourceLocation) const;
2015-09-21 17:43:56 +00:00
/// @returns the list of errors that occured during parsing and type checking.
ErrorList const& errors() const { return m_errors; }
2015-09-21 17:43:56 +00:00
private:
/**
* Information pertaining to one source unit, filled gradually during parsing and compilation.
*/
struct Source
{
std::shared_ptr<Scanner> scanner;
std::shared_ptr<SourceUnit> ast;
2015-02-21 17:55:55 +00:00
bool isLibrary = false;
2016-07-01 08:14:50 +00:00
void reset() { scanner.reset(); ast.reset(); }
};
struct Contract
{
ContractDefinition const* contract = nullptr;
std::shared_ptr<Compiler> compiler;
eth::LinkerObject object;
eth::LinkerObject runtimeObject;
eth::LinkerObject cloneObject;
2016-11-14 10:46:43 +00:00
std::string onChainMetadata; ///< The metadata json that will be hashed into the chain.
mutable std::unique_ptr<Json::Value const> interface;
mutable std::unique_ptr<Json::Value const> userDocumentation;
mutable std::unique_ptr<Json::Value const> devDocumentation;
2016-07-01 08:14:50 +00:00
mutable std::unique_ptr<std::string const> sourceMapping;
mutable std::unique_ptr<std::string const> runtimeSourceMapping;
};
2017-04-28 13:24:59 +00:00
enum State {
Empty,
SourcesSet,
ParsingSuccessful,
AnalysisSuccessful,
CompilationSuccessful
};
2016-01-12 00:04:39 +00:00
/// Loads the missing sources from @a _ast (named @a _path) using the callback
/// @a m_readFile and stores the absolute paths of all imports in the AST annotations.
/// @returns the newly loaded sources.
StringMap loadMissingSources(SourceUnit const& _ast, std::string const& _path);
std::string applyRemapping(std::string const& _path, std::string const& _context);
void resolveImports();
2015-12-09 16:35:20 +00:00
/// @returns the absolute path corresponding to @a _path relative to @a _reference.
std::string absolutePath(std::string const& _path, std::string const& _reference) const;
/// Helper function to return path converted strings.
std::string sanitizePath(std::string const& _path) const { return boost::filesystem::path(_path).generic_string(); }
2015-10-07 13:57:17 +00:00
/// Compile a single contract and put the result in @a _compiledContracts.
void compileContract(
ContractDefinition const& _contract,
std::map<ContractDefinition const*, eth::Assembly const*>& _compiledContracts
);
2016-11-14 10:46:43 +00:00
void link();
2015-08-31 16:44:29 +00:00
Contract const& contract(std::string const& _contractName = "") const;
Source const& source(std::string const& _sourceName = "") const;
2016-11-14 10:46:43 +00:00
std::string createOnChainMetadata(Contract const& _contract) const;
2016-07-01 08:14:50 +00:00
std::string computeSourceMapping(eth::AssemblyItems const& _items) const;
2016-11-14 10:46:43 +00:00
Json::Value const& metadata(Contract const&, DocumentationType _type) const;
2016-07-01 08:14:50 +00:00
struct Remapping
{
std::string context;
std::string prefix;
std::string target;
};
2017-04-10 11:48:41 +00:00
ReadFile::Callback m_readFile;
2016-11-14 10:46:43 +00:00
bool m_optimize = false;
2016-11-30 13:00:51 +00:00
unsigned m_optimizeRuns = 200;
2016-11-14 10:46:43 +00:00
std::map<std::string, h160> m_libraries;
/// list of path prefix remappings, e.g. mylibrary: github.com/ethereum = /usr/local/ethereum
/// "context:prefix=target"
std::vector<Remapping> m_remappings;
2014-12-06 01:39:58 +00:00
std::map<std::string const, Source> m_sources;
std::shared_ptr<GlobalContext> m_globalContext;
2017-01-31 21:59:56 +00:00
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>> m_scopes;
std::vector<Source const*> m_sourceOrder;
2014-12-06 01:39:58 +00:00
std::map<std::string const, Contract> m_contracts;
2015-10-21 14:43:31 +00:00
std::string m_formalTranslation;
ErrorList m_errors;
bool m_metadataLiteralSources = false;
2017-04-28 13:24:59 +00:00
State m_stackState = Empty;
};
}
}