solidity/libsolidity/interface/CompilerStack.h

374 lines
14 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 <libsolidity/interface/ReadFile.h>
2017-07-17 11:12:00 +00:00
#include <libsolidity/interface/OptimiserSettings.h>
#include <liblangutil/ErrorReporter.h>
#include <liblangutil/EVMVersion.h>
#include <liblangutil/SourceLocation.h>
#include <libevmasm/LinkerObject.h>
#include <libdevcore/Common.h>
#include <libdevcore/FixedHash.h>
#include <boost/noncopyable.hpp>
2018-12-17 18:24:42 +00:00
#include <json/json.h>
2018-12-17 18:24:42 +00:00
#include <functional>
#include <memory>
#include <ostream>
#include <string>
2015-03-02 00:13:10 +00:00
#include <vector>
namespace langutil
{
class Scanner;
}
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
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;
2017-05-10 09:56:21 +00:00
class Natspec;
2017-01-31 21:59:56 +00:00
class DeclarationContainer;
/**
* 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:
2017-07-03 10:58:24 +00:00
enum State {
Empty,
SourcesSet,
ParsingSuccessful,
AnalysisSuccessful,
CompilationSuccessful
};
2018-08-09 18:37:49 +00:00
struct Remapping
{
std::string context;
std::string prefix;
std::string target;
};
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-07-13 19:06:04 +00:00
explicit CompilerStack(ReadCallback::Callback const& _readFile = ReadCallback::Callback()):
m_readFile(_readFile),
m_errorList(),
m_errorReporter(m_errorList) {}
/// @returns the list of errors that occurred during parsing and type checking.
langutil::ErrorList const& errors() const { return m_errorReporter.errors(); }
/// @returns the current state.
State state() const { return m_stackState; }
/// Resets the compiler to an empty state. Unless @a _keepSettings is set to true,
/// all settings are reset as well.
void reset(bool _keepSettings = false);
2018-08-09 18:37:49 +00:00
// Parses a remapping of the format "context:prefix=target".
static boost::optional<Remapping> parseRemapping(std::string const& _remapping);
/// Sets path remappings.
/// Must be set before parsing.
2018-08-09 18:37:49 +00:00
void setRemappings(std::vector<Remapping> const& _remappings);
2017-07-17 10:49:45 +00:00
/// Sets library addresses. Addresses are cleared iff @a _libraries is missing.
/// Must be set before parsing.
void setLibraries(std::map<std::string, h160> const& _libraries = std::map<std::string, h160>{});
2017-07-17 10:49:45 +00:00
/// Changes the optimiser settings.
/// Must be set before parsing.
void setOptimiserSettings(bool _optimize, unsigned _runs = 200);
2017-07-17 11:12:00 +00:00
/// Changes the optimiser settings.
/// Must be set before parsing.
void setOptimiserSettings(OptimiserSettings _settings);
/// 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.
void setEVMVersion(langutil::EVMVersion _version = langutil::EVMVersion{});
/// Sets the list of requested contract names. If empty, no filtering is performed and every contract
/// found in the supplied sources is compiled. Names are cleared iff @a _contractNames is missing.
void setRequestedContractNames(std::set<std::string> const& _contractNames = std::set<std::string>{}) {
m_requestedContractNames = _contractNames;
}
/// @arg _metadataLiteralSources When true, store sources as literals in the contract metadata.
/// Must be set before parsing.
void useMetadataLiteralSources(bool _metadataLiteralSources);
2019-03-20 17:57:40 +00:00
/// Sets the sources. Must be set before parsing.
void setSources(StringMap const& _sources);
/// Adds a response to an SMTLib2 query (identified by the hash of the query input).
/// Must be set before parsing.
void addSMTLib2Response(h256 const& _hash, std::string const& _response);
/// Parses all source units that were added
2015-09-21 17:43:56 +00:00
/// @returns false on error.
bool parse();
/// Performs the analysis steps (imports, scopesetting, syntaxCheck, referenceResolving,
/// typechecking, staticAnalysis) on previously parsed sources.
/// @returns false on error.
bool analyze();
/// Parses and analyzes all source units that were added
/// @returns false on error.
bool parseAndAnalyze();
/// Compiles the source units that were previously added and parsed.
2015-09-21 17:43:56 +00:00
/// @returns false on error.
bool compile();
/// @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 the previously used scanner, useful for counting lines during error reporting.
langutil::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;
/// 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(langutil::SourceLocation const& _sourceLocation) const;
/// @returns a list of unhandled queries to the SMT solver (has to be supplied in a second run
/// by calling @a addSMTLib2Response).
std::vector<std::string> const& unhandledSMTLib2Queries() const { return m_unhandledSMTLib2Queries; }
/// @returns a list of the contract names in the sources.
std::vector<std::string> contractNames() const;
/// @returns the name of the last contract.
std::string const lastContractName() 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;
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;
2015-03-02 00:13:10 +00:00
/// @returns normal contract assembly items
eth::AssemblyItems const* assemblyItems(std::string const& _contractName) const;
2015-03-02 00:13:10 +00:00
/// @returns runtime contract assembly items
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;
2016-07-01 08:14:50 +00:00
/// @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;
2017-08-30 01:17:15 +00:00
/// @return a verbose text representation of the assembly.
/// @arg _sourceCodes is the map of input files to source code strings
/// Prerequisite: Successful compilation.
std::string assemblyString(std::string const& _contractName, StringMap _sourceCodes = StringMap()) const;
/// @returns a JSON representation of the assembly.
/// @arg _sourceCodes is the map of input files to source code strings
/// Prerequisite: Successful compilation.
Json::Value assemblyJSON(std::string const& _contractName, StringMap _sourceCodes = StringMap()) const;
/// @returns a JSON representing the contract ABI.
/// Prerequisite: Successful call to parse or compile.
Json::Value const& contractABI(std::string const& _contractName) const;
2017-07-27 10:28:04 +00:00
/// @returns a JSON representing the contract's user documentation.
/// Prerequisite: Successful call to parse or compile.
Json::Value const& natspecUser(std::string const& _contractName) const;
/// @returns a JSON representing the contract's developer documentation.
/// Prerequisite: Successful call to parse or compile.
2017-07-27 10:28:04 +00:00
Json::Value const& natspecDev(std::string const& _contractName) const;
/// @returns a JSON representing a map of method identifiers (hashes) to function names.
Json::Value methodIdentifiers(std::string const& _contractName) const;
/// @returns the Contract Metadata
2017-05-19 15:10:32 +00:00
std::string const& metadata(std::string const& _contractName) const;
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;
private:
/// The state per source unit. Filled gradually during parsing.
struct Source
{
std::shared_ptr<langutil::Scanner> scanner;
std::shared_ptr<SourceUnit> ast;
2018-12-18 15:38:25 +00:00
h256 mutable keccak256HashCached;
h256 mutable swarmHashCached;
void reset() { *this = Source(); }
h256 const& keccak256() const;
h256 const& swarmHash() const;
};
/// The state per contract. Filled gradually during compilation.
struct Contract
{
ContractDefinition const* contract = nullptr;
std::shared_ptr<Compiler> compiler;
eth::LinkerObject object; ///< Deployment object (includes the runtime sub-object).
eth::LinkerObject runtimeObject; ///< Runtime object.
mutable std::unique_ptr<std::string const> metadata; ///< The metadata json that will be hashed into the chain.
2017-05-10 09:54:23 +00:00
mutable std::unique_ptr<Json::Value const> abi;
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;
};
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();
/// @returns true if the contract is requested to be compiled.
bool isRequestedContract(ContractDefinition const& _contract) const;
/// Compile a single contract.
/// @param _otherCompilers provides access to compilers of other contracts, to get
/// their bytecode if needed. Only filled after they have been compiled.
2015-10-07 13:57:17 +00:00
void compileContract(
ContractDefinition const& _contract,
std::map<ContractDefinition const*, std::shared_ptr<Compiler const>>& _otherCompilers
2015-10-07 13:57:17 +00:00
);
/// Links all the known library addresses in the available objects. Any unknown
/// library will still be kept as an unlinked placeholder in the objects.
2016-11-14 10:46:43 +00:00
void link();
/// @returns the contract object for the given @a _contractName.
/// Can only be called after state is CompilationSuccessful.
Contract const& contract(std::string const& _contractName) const;
/// @returns the source object for the given @a _sourceName.
/// Can only be called after state is SourcesSet.
Source const& source(std::string const& _sourceName) const;
/// @returns the parsed contract with the supplied name. Throws an exception if the contract
/// does not exist.
ContractDefinition const& contractDefinition(std::string const& _contractName) const;
/// @returns the metadata JSON as a compact string for the given contract.
2017-05-19 15:10:32 +00:00
std::string createMetadata(Contract const& _contract) const;
2018-06-22 10:02:50 +00:00
/// @returns the metadata CBOR for the given serialised metadata JSON.
2018-12-18 15:38:25 +00:00
static bytes createCBORMetadata(std::string const& _metadata, bool _experimentalMode);
/// @returns the computer source mapping string.
2016-07-01 08:14:50 +00:00
std::string computeSourceMapping(eth::AssemblyItems const& _items) const;
/// @returns the contract ABI as a JSON object.
/// This will generate the JSON object and store it in the Contract object if it is not present yet.
2017-05-10 09:54:23 +00:00
Json::Value const& contractABI(Contract const&) const;
/// @returns the Natspec User documentation as a JSON object.
/// This will generate the JSON object and store it in the Contract object if it is not present yet.
2017-07-27 10:28:04 +00:00
Json::Value const& natspecUser(Contract const&) const;
/// @returns the Natspec Developer documentation as a JSON object.
/// This will generate the JSON object and store it in the Contract object if it is not present yet.
2017-07-27 10:28:04 +00:00
Json::Value const& natspecDev(Contract const&) const;
2016-07-01 08:14:50 +00:00
/// @returns the Contract Metadata
/// This will generate the metadata and store it in the Contract object if it is not present yet.
std::string const& metadata(Contract const&) const;
2017-06-01 12:28:32 +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.
size_t functionEntryPoint(
std::string const& _contractName,
FunctionDefinition const& _function
) const;
2017-07-13 19:06:04 +00:00
ReadCallback::Callback m_readFile;
2017-07-17 11:12:00 +00:00
OptimiserSettings m_optimiserSettings;
langutil::EVMVersion m_evmVersion;
std::set<std::string> m_requestedContractNames;
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::vector<std::string> m_unhandledSMTLib2Queries;
std::map<h256, std::string> m_smtlib2Responses;
std::shared_ptr<GlobalContext> m_globalContext;
std::vector<Source const*> m_sourceOrder;
/// This is updated during compilation.
std::map<ASTNode const*, std::shared_ptr<DeclarationContainer>> m_scopes;
2014-12-06 01:39:58 +00:00
std::map<std::string const, Contract> m_contracts;
langutil::ErrorList m_errorList;
langutil::ErrorReporter m_errorReporter;
bool m_metadataLiteralSources = false;
2017-04-28 13:24:59 +00:00
State m_stackState = Empty;
};
}
}