aboutsummaryrefslogtreecommitdiffstats
path: root/solc/jsonCompiler.cpp
blob: 5cdee2e24d6131ba1ded7234b53e6b8ef8e6160e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/*
    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
 * JSON interface for the solidity compiler to be used from Javascript.
 */

#include <string>
#include <functional>
#include <iostream>
#include <json/json.h>
#include <libdevcore/Common.h>
#include <libdevcore/CommonData.h>
#include <libdevcore/CommonIO.h>
#include <libevmasm/Instruction.h>
#include <libevmasm/GasMeter.h>
#include <libsolidity/parsing/Scanner.h>
#include <libsolidity/parsing/Parser.h>
#include <libsolidity/ast/ASTPrinter.h>
#include <libsolidity/analysis/NameAndTypeResolver.h>
#include <libsolidity/interface/Exceptions.h>
#include <libsolidity/interface/CompilerStack.h>
#include <libsolidity/interface/SourceReferenceFormatter.h>
#include <libsolidity/ast/ASTJsonConverter.h>
#include <libsolidity/interface/Version.h>

using namespace std;
using namespace dev;
using namespace solidity;

extern "C" {
/// Callback used to retrieve additional source files. "Returns" two pointers that should be
/// heap-allocated and are free'd by the caller.
typedef void (*CStyleReadFileCallback)(char const* _path, char** o_contents, char** o_error);
}

string formatError(
    Exception const& _exception,
    string const& _name,
    function<Scanner const&(string const&)> const& _scannerFromSourceName
)
{
    ostringstream errorOutput;
    SourceReferenceFormatter::printExceptionInformation(errorOutput, _exception, _name, _scannerFromSourceName);
    return errorOutput.str();
}

Json::Value functionHashes(ContractDefinition const& _contract)
{
    Json::Value functionHashes(Json::objectValue);
    for (auto const& it: _contract.interfaceFunctions())
        functionHashes[it.second->externalSignature()] = toHex(it.first.ref());
    return functionHashes;
}

Json::Value gasToJson(GasEstimator::GasConsumption const& _gas)
{
    if (_gas.isInfinite || _gas.value > std::numeric_limits<Json::LargestUInt>::max())
        return Json::Value(Json::nullValue);
    else
        return Json::Value(Json::LargestUInt(_gas.value));
}

Json::Value estimateGas(CompilerStack const& _compiler, string const& _contract)
{
    Json::Value gasEstimates(Json::objectValue);
    using Gas = GasEstimator::GasConsumption;
    if (!_compiler.assemblyItems(_contract) && !_compiler.runtimeAssemblyItems(_contract))
        return gasEstimates;
    if (eth::AssemblyItems const* items = _compiler.assemblyItems(_contract))
    {
        Gas gas = GasEstimator::functionalEstimation(*items);
        u256 bytecodeSize(_compiler.runtimeObject(_contract).bytecode.size());
        Json::Value creationGas(Json::arrayValue);
        creationGas[0] = gasToJson(gas);
        creationGas[1] = gasToJson(bytecodeSize * eth::GasCosts::createDataGas);
        gasEstimates["creation"] = creationGas;
    }
    if (eth::AssemblyItems const* items = _compiler.runtimeAssemblyItems(_contract))
    {
        ContractDefinition const& contract = _compiler.contractDefinition(_contract);
        Json::Value externalFunctions(Json::objectValue);
        for (auto it: contract.interfaceFunctions())
        {
            string sig = it.second->externalSignature();
            externalFunctions[sig] = gasToJson(GasEstimator::functionalEstimation(*items, sig));
        }
        if (contract.fallbackFunction())
            externalFunctions[""] = gasToJson(GasEstimator::functionalEstimation(*items, "INVALID"));
        gasEstimates["external"] = externalFunctions;
        Json::Value internalFunctions(Json::objectValue);
        for (auto const& it: contract.definedFunctions())
        {
            if (it->isPartOfExternalInterface() || it->isConstructor())
                continue;
            size_t entry = _compiler.functionEntryPoint(_contract, *it);
            GasEstimator::GasConsumption gas = GasEstimator::GasConsumption::infinite();
            if (entry > 0)
                gas = GasEstimator::functionalEstimation(*items, entry, *it);
            FunctionType type(*it);
            string sig = it->name() + "(";
            auto paramTypes = type.parameterTypes();
            for (auto it = paramTypes.begin(); it != paramTypes.end(); ++it)
                sig += (*it)->toString() + (it + 1 == paramTypes.end() ? "" : ",");
            sig += ")";
            internalFunctions[sig] = gasToJson(gas);
        }
        gasEstimates["internal"] = internalFunctions;
    }
    return gasEstimates;
}

string compile(StringMap const& _sources, bool _optimize, CStyleReadFileCallback _readCallback)
{
    Json::Value output(Json::objectValue);
    Json::Value errors(Json::arrayValue);
    CompilerStack::ReadFileCallback readCallback;
    if (_readCallback)
    {
        readCallback = [=](string const& _path)
        {
            char* contents_c = nullptr;
            char* error_c = nullptr;
            _readCallback(_path.c_str(), &contents_c, &error_c);
            CompilerStack::ReadFileResult result;
            result.success = true;
            if (!contents_c && !error_c)
            {
                result.success = false;
                result.contentsOrErrorMesage = "File not found.";
            }
            if (contents_c)
            {
                result.success = true;
                result.contentsOrErrorMesage = string(contents_c);
                free(contents_c);
            }
            if (error_c)
            {
                result.success = false;
                result.contentsOrErrorMesage = string(error_c);
                free(error_c);
            }
            return result;
        };
    }
    CompilerStack compiler(readCallback);
    auto scannerFromSourceName = [&](string const& _sourceName) -> solidity::Scanner const& { return compiler.scanner(_sourceName); };
    bool success = false;
    try
    {
        compiler.addSources(_sources);
        bool succ = compiler.compile(_optimize);
        for (auto const& error: compiler.errors())
        {
            auto err = dynamic_pointer_cast<Error const>(error);
            errors.append(formatError(
                *error,
                (err->type() == Error::Type::Warning) ? "Warning" : "Error",
                scannerFromSourceName
            ));
        }
        success = succ; // keep success false on exception
    }
    catch (Error const& error)
    {
        errors.append(formatError(error, error.typeName(), scannerFromSourceName));
    }
    catch (CompilerError const& exception)
    {
        errors.append(formatError(exception, "Compiler error", scannerFromSourceName));
    }
    catch (InternalCompilerError const& exception)
    {
        errors.append(formatError(exception, "Internal compiler error", scannerFromSourceName));
    }
    catch (Exception const& exception)
    {
        errors.append("Exception during compilation: " + boost::diagnostic_information(exception));
    }
    catch (...)
    {
        errors.append("Unknown exception during compilation.");
    }

    if (errors.size() > 0)
        output["errors"] = errors;

    if (success)
    {
        output["contracts"] = Json::Value(Json::objectValue);
        for (string const& contractName: compiler.contractNames())
        {
            Json::Value contractData(Json::objectValue);
            contractData["interface"] = compiler.interface(contractName);
            contractData["bytecode"] = compiler.object(contractName).toHex();
            contractData["runtimeBytecode"] = compiler.runtimeObject(contractName).toHex();
            contractData["opcodes"] = solidity::disassemble(compiler.object(contractName).bytecode);
            contractData["functionHashes"] = functionHashes(compiler.contractDefinition(contractName));
            contractData["gasEstimates"] = estimateGas(compiler, contractName);
            auto sourceMap = compiler.sourceMapping(contractName);
            contractData["srcmap"] = sourceMap ? *sourceMap : "";
            auto runtimeSourceMap = compiler.runtimeSourceMapping(contractName);
            contractData["srcmapRuntime"] = runtimeSourceMap ? *runtimeSourceMap : "";
            ostringstream unused;
            contractData["assembly"] = compiler.streamAssembly(unused, contractName, _sources, true);
            output["contracts"][contractName] = contractData;
        }

        // Do not taint the internal error list
        ErrorList formalErrors;
        if (compiler.prepareFormalAnalysis(&formalErrors))
            output["formal"]["why3"] = compiler.formalTranslation();
        if (!formalErrors.empty())
        {
            Json::Value errors(Json::arrayValue);
            for (auto const& error: formalErrors)
                errors.append(formatError(
                    *error,
                    (error->type() == Error::Type::Warning) ? "Warning" : "Error",
                    scannerFromSourceName
                ));
            output["formal"]["errors"] = errors;
        }

        // Indices into this array are used to abbreviate source names in source locations.
        output["sourceList"] = Json::Value(Json::arrayValue);
        for (auto const& source: compiler.sourceNames())
            output["sourceList"].append(source);
        output["sources"] = Json::Value(Json::objectValue);
        for (auto const& source: compiler.sourceNames())
            output["sources"][source]["AST"] = ASTJsonConverter(compiler.ast(source), compiler.sourceIndices()).json();
    }

    return Json::FastWriter().write(output);
}

string compileMulti(string const& _input, bool _optimize, CStyleReadFileCallback _readCallback = nullptr)
{
    Json::Reader reader;
    Json::Value input;
    if (!reader.parse(_input, input, false))
    {
        Json::Value errors(Json::arrayValue);
        errors.append("Error parsing input JSON: " + reader.getFormattedErrorMessages());
        Json::Value output(Json::objectValue);
        output["errors"] = errors;
        return Json::FastWriter().write(output);
    }
    else
    {
        StringMap sources;
        Json::Value jsonSources = input["sources"];
        if (jsonSources.isObject())
            for (auto const& sourceName: jsonSources.getMemberNames())
                sources[sourceName] = jsonSources[sourceName].asString();
        return compile(sources, _optimize, _readCallback);
    }
}

string compileSingle(string const& _input, bool _optimize)
{
    StringMap sources;
    sources[""] = _input;
    return compile(sources, _optimize, nullptr);
}

static string s_outputBuffer;

extern "C"
{
extern char const* version()
{
    return VersionString.c_str();
}
extern char const* compileJSON(char const* _input, bool _optimize)
{
    s_outputBuffer = compileSingle(_input, _optimize);
    return s_outputBuffer.c_str();
}
extern char const* compileJSONMulti(char const* _input, bool _optimize)
{
    s_outputBuffer = compileMulti(_input, _optimize);
    return s_outputBuffer.c_str();
}
extern char const* compileJSONCallback(char const* _input, bool _optimize, CStyleReadFileCallback _readCallback)
{
    s_outputBuffer = compileMulti(_input, _optimize, _readCallback);
    return s_outputBuffer.c_str();
}
}