-
Notifications
You must be signed in to change notification settings - Fork 6k
/
Copy pathCompilerStack.h
639 lines (506 loc) · 25.9 KB
/
CompilerStack.h
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
/*
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/>.
*/
// SPDX-License-Identifier: GPL-3.0
/**
* @author Christian <[email protected]>
* @author Gav Wood <[email protected]>
* @date 2014
* Full-stack compiler that converts a source code string to bytecode.
*/
#pragma once
#include <libsolidity/analysis/FunctionCallGraph.h>
#include <libsolidity/interface/ReadFile.h>
#include <libsolidity/interface/ImportRemapper.h>
#include <libsolidity/interface/OptimiserSettings.h>
#include <libsolidity/interface/Version.h>
#include <libsolidity/interface/DebugSettings.h>
#include <libsolidity/formal/ModelCheckerSettings.h>
#include <libsmtutil/SolverInterface.h>
#include <liblangutil/CharStreamProvider.h>
#include <liblangutil/DebugInfoSelection.h>
#include <liblangutil/ErrorReporter.h>
#include <liblangutil/EVMVersion.h>
#include <liblangutil/SourceLocation.h>
#include <libevmasm/AbstractAssemblyStack.h>
#include <libevmasm/LinkerObject.h>
#include <libsolutil/Common.h>
#include <libsolutil/FixedHash.h>
#include <libsolutil/LazyInit.h>
#include <libsolutil/JSON.h>
#include <libyul/ObjectOptimizer.h>
#include <functional>
#include <memory>
#include <ostream>
#include <set>
#include <string>
#include <vector>
namespace solidity::langutil
{
class CharStream;
}
namespace solidity::evmasm
{
class Assembly;
class AssemblyItem;
using AssemblyItems = std::vector<AssemblyItem>;
}
namespace solidity::yul
{
class YulStack;
}
namespace solidity::frontend
{
// forward declarations
class ASTNode;
class ContractDefinition;
class FunctionDefinition;
class SourceUnit;
class Compiler;
class GlobalContext;
class Natspec;
class DeclarationContainer;
namespace experimental
{
class Analysis;
}
/**
* 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: public langutil::CharStreamProvider, public evmasm::AbstractAssemblyStack
{
public:
/// Noncopyable.
CompilerStack(CompilerStack const&) = delete;
CompilerStack& operator=(CompilerStack const&) = delete;
enum State {
Empty,
SourcesSet,
Parsed,
ParsedAndImported,
AnalysisSuccessful,
CompilationSuccessful
};
enum class MetadataFormat {
WithReleaseVersionTag,
WithPrereleaseVersionTag,
NoMetadata
};
enum class MetadataHash {
IPFS,
Bzzr1,
None
};
enum class CompilationSourceType {
/// Regular compilation from Solidity source files.
Solidity,
/// Compilation from an imported Solidity AST.
SolidityAST,
};
/// Indicates which stages of the compilation pipeline were explicitly requested and provides
/// logic to determine which ones are effectively needed to accomplish that.
/// Note that parsing and analysis are not selectable, since they cannot be skipped.
struct PipelineConfig
{
bool irCodegen = false; ///< Want IR output straight from code generator.
bool irOptimization = false; ///< Want reparsed IR that went through YulStack. May be optimized or not, depending on settings.
bool bytecode = false; ///< Want EVM-level outputs, especially EVM assembly and bytecode. May be optimized or not, depending on settings.
bool needIR(bool _viaIR) const
{
return
irCodegen ||
irOptimization ||
(bytecode && _viaIR);
}
bool needIRCodegenOnly(bool _viaIR) const
{
return !(bytecode && _viaIR) && !irOptimization;
}
bool needBytecode() const
{
return bytecode;
}
PipelineConfig operator|(PipelineConfig const& _other) const
{
return {
irCodegen || _other.irCodegen,
irOptimization || _other.irOptimization,
bytecode || _other.bytecode,
};
}
bool operator!=(PipelineConfig const& _other) const { return !(*this == _other); }
bool operator==(PipelineConfig const& _other) const
{
return
irCodegen == _other.irCodegen &&
irOptimization == _other.irOptimization &&
bytecode == _other.bytecode;
}
};
using ContractSelection = std::map<std::string, std::map<std::string, CompilerStack::PipelineConfig>>;
/// Creates a new compiler stack.
/// @param _readFile callback used to read files for import statements. Must return
/// and must not emit exceptions.
explicit CompilerStack(ReadCallback::Callback _readFile = ReadCallback::Callback());
~CompilerStack() override;
/// @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; }
virtual bool compilationSuccessful() const override { return m_stackState >= CompilationSuccessful; }
/// 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);
/// Sets path remappings.
/// Must be set before parsing.
void setRemappings(std::vector<ImportRemapper::Remapping> _remappings);
/// Sets library addresses. Addresses are cleared iff @a _libraries is missing.
/// Must be set before parsing.
void setLibraries(std::map<std::string, util::h160> const& _libraries = {});
/// Changes the optimiser settings.
/// Must be set before parsing.
void setOptimiserSettings(bool _optimize, size_t _runs = OptimiserSettings{}.expectedExecutionsPerDeployment);
/// Changes the optimiser settings.
/// Must be set before parsing.
void setOptimiserSettings(OptimiserSettings _settings);
/// Sets whether to strip revert strings, add additional strings or do nothing at all.
void setRevertStringBehaviour(RevertStrings _revertStrings);
/// Sets the pipeline to go through the Yul IR or not.
/// Must be set before parsing.
void setViaIR(bool _viaIR);
/// 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{});
/// Set the EOF version used before running compile.
/// If set to std::nullopt (the default), legacy non-EOF bytecode is generated.
void setEOFVersion(std::optional<uint8_t> version);
/// Set model checker settings.
void setModelCheckerSettings(ModelCheckerSettings _settings);
/// Sets names of the contracts from each source that should be compiled.
/// If empty, no filtering is performed and every contract found in the supplied sources goes
/// through the default pipeline stages (bytecode-only, no IR).
/// Source/contract names are not validated - ones that do not exist are ignored.
/// The empty source/contract name can be used as a wildcard that matches all sources/contracts.
/// If a contract matches more than one entry, the pipeline selection from all matches is combined.
void selectContracts(ContractSelection const& _selectedContracts);
/// @arg _metadataLiteralSources When true, store sources as literals in the contract metadata.
/// Must be set before parsing.
void useMetadataLiteralSources(bool _metadataLiteralSources);
/// Sets whether and which hash should be used
/// to store the metadata in the bytecode.
/// @param _metadataHash can be IPFS, Bzzr1, None
void setMetadataHash(MetadataHash _metadataHash);
/// Select components of debug info that should be included in comments in generated assembly.
void selectDebugInfo(langutil::DebugInfoSelection _debugInfoSelection);
/// Sets the sources. Must be set before parsing.
void setSources(StringMap _sources);
/// Adds a response to an SMTLib2 query (identified by the hash of the query input).
/// Must be set before parsing.
void addSMTLib2Response(util::h256 const& _hash, std::string const& _response);
/// Parses all source units that were added
/// @returns false on error.
bool parse();
/// Imports given SourceUnits so they can be analyzed. Leads to the same internal state as parse().
/// Will throw errors if the import fails
void importASTs(std::map<std::string, Json> const& _sources);
/// 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(State _stopAfter = State::CompilationSuccessful);
/// Compiles the source units that were previously added and parsed.
/// @returns false on error.
bool compile(State _stopAfter = State::CompilationSuccessful);
/// Checks whether experimental analysis is on; used in SyntaxTests to skip compilation in case it's ``true``.
/// @returns true if experimental analysis is set
bool isExperimentalAnalysis() const
{
return !!m_experimentalAnalysis;
}
/// @returns the list of sources (paths) used
virtual std::vector<std::string> sourceNames() const override;
/// @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 character stream, useful for counting lines during error reporting.
langutil::CharStream const& charStream(std::string const& _sourceName) const override;
/// @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.
ContractDefinition const& contractDefinition(std::string const& _contractName) const;
/// @returns a list of parsed contracts per source unit with the supplied name.
std::vector<ContractDefinition const*> contractDefinitions(std::string const& _sourceName) 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.
virtual std::vector<std::string> contractNames() const override;
/// @returns the name of the last contract. If _sourceName is defined the last contract of that source will be returned.
std::string const lastContractName(std::optional<std::string> const& _sourceName = std::nullopt) const;
/// @returns either the contract's name or a mixture of its name and source file, sanitized for filesystem use
virtual std::string const filesystemFriendlyName(std::string const& _contractName) const override;
/// @returns the IR representation of a contract.
std::optional<std::string> const& yulIR(std::string const& _contractName) const;
/// @returns the IR representation of a contract AST in format.
std::optional<Json> yulIRAst(std::string const& _contractName) const;
/// @returns the optimized IR representation of a contract.
std::optional<std::string> const& yulIROptimized(std::string const& _contractName) const;
/// @returns the optimized IR representation of a contract AST in JSON format.
std::optional<Json> yulIROptimizedAst(std::string const& _contractName) const;
std::optional<Json> yulCFGJson(std::string const& _contractName) const;
/// @returns the assembled object for a contract.
virtual evmasm::LinkerObject const& object(std::string const& _contractName) const override;
/// @returns the runtime object for the contract.
virtual evmasm::LinkerObject const& runtimeObject(std::string const& _contractName) const override;
/// @returns normal contract assembly items
evmasm::AssemblyItems const* assemblyItems(std::string const& _contractName) const;
/// @returns runtime contract assembly items
evmasm::AssemblyItems const* runtimeAssemblyItems(std::string const& _contractName) const;
/// @returns an array containing all utility sources generated during compilation.
/// Format: [ { name: string, id: number, language: "Yul", contents: string }, ... ]
Json generatedSources(std::string const& _contractName, bool _runtime = false) const;
/// @returns the string that provides a mapping between bytecode and sourcecode or a nullptr
/// if the contract does not (yet) have bytecode.
virtual std::string const* sourceMapping(std::string const& _contractName) const override;
/// @returns the string that provides a mapping between runtime bytecode and sourcecode.
/// if the contract does not (yet) have bytecode.
virtual std::string const* runtimeSourceMapping(std::string const& _contractName) const override;
/// @return a verbose text representation of the assembly.
/// @arg _sourceCodes is the map of input files to source code strings
/// Prerequisite: Successful compilation.
virtual std::string assemblyString(std::string const& _contractName, StringMap const& _sourceCodes = StringMap()) const override;
/// @returns a JSON representation of the assembly.
/// @arg _sourceCodes is the map of input files to source code strings
/// Prerequisite: Successful compilation.
virtual Json assemblyJSON(std::string const& _contractName) const override;
/// @returns a JSON representing the contract ABI.
/// Prerequisite: Successful call to parse or compile.
Json const& contractABI(std::string const& _contractName) const;
/// @returns a JSON representing the storage layout of the contract.
/// Prerequisite: Successful call to parse or compile.
Json const& storageLayout(std::string const& _contractName) const;
/// @returns a JSON representing the transient storage layout of the contract.
/// Prerequisite: Successful call to parse or compile.
Json const& transientStorageLayout(std::string const& _contractName) const;
/// @returns a JSON representing the contract's user documentation.
/// Prerequisite: Successful call to parse or compile.
Json const& natspecUser(std::string const& _contractName) const;
/// @returns a JSON representing the contract's developer documentation.
/// Prerequisite: Successful call to parse or compile.
Json const& natspecDev(std::string const& _contractName) const;
/// @returns a JSON object with the three members ``methods``, ``events``, ``errors``. Each is a map, mapping identifiers (hashes) to function names.
Json interfaceSymbols(std::string const& _contractName) const;
/// @returns a JSON representing the ethdebug data of the specified contract.
/// Prerequisite: Successful call to parse or compile.
Json ethdebug(std::string const& _contractName) const override;
/// @returns a JSON representing the ethdebug data of the specified contract.
/// Prerequisite: Successful call to parse or compile.
Json ethdebugRuntime(std::string const& _contractName) const override;
/// @returns a JSON representing the top-level ethdebug data (types, etc.).
/// Prerequisite: Successful call to parse or compile.
Json ethdebug() const override;
/// @returns the Contract Metadata matching the pipeline selected using the viaIR setting.
std::string const& metadata(std::string const& _contractName) const { return metadata(contract(_contractName)); }
/// @returns the CBOR-encoded metadata matching the pipeline selected using the viaIR setting.
bytes cborMetadata(std::string const& _contractName) const { return cborMetadata(_contractName, m_viaIR); }
/// @returns the CBOR-encoded metadata.
/// @param _forIR If true, the metadata for the IR codegen is used. Otherwise it's the metadata
/// for the EVM codegen
bytes cborMetadata(std::string const& _contractName, bool _forIR) const;
/// @returns a JSON representing the estimated gas usage for contract creation, internal and external functions
Json gasEstimates(std::string const& _contractName) const;
/// Changes the format of the metadata appended at the end of the bytecode.
void setMetadataFormat(MetadataFormat _metadataFormat) { m_metadataFormat = _metadataFormat; }
bool isExperimentalSolidity() const;
experimental::Analysis const& experimentalAnalysis() const;
static MetadataFormat defaultMetadataFormat()
{
return VersionIsRelease ? MetadataFormat::WithReleaseVersionTag : MetadataFormat::WithPrereleaseVersionTag;
}
yul::ObjectOptimizer const& objectOptimizer() const { return *m_objectOptimizer; }
private:
/// The state per source unit. Filled gradually during parsing.
struct Source
{
std::shared_ptr<langutil::CharStream> charStream;
std::shared_ptr<SourceUnit> ast;
util::h256 mutable keccak256HashCached;
util::h256 mutable swarmHashCached;
std::string mutable ipfsUrlCached;
void reset() { *this = Source(); }
util::h256 const& keccak256() const;
util::h256 const& swarmHash() const;
std::string const& ipfsUrl() const;
};
/// The state per contract. Filled gradually during compilation.
struct Contract
{
ContractDefinition const* contract = nullptr;
std::shared_ptr<evmasm::Assembly> evmAssembly;
std::shared_ptr<evmasm::Assembly> evmRuntimeAssembly;
std::optional<std::string> generatedYulUtilityCode; ///< Extra Yul utility code that was used when compiling the creation assembly
std::optional<std::string> runtimeGeneratedYulUtilityCode; ///< Extra Yul utility code that was used when compiling the deployed assembly
evmasm::LinkerObject object; ///< Deployment object (includes the runtime sub-object).
evmasm::LinkerObject runtimeObject; ///< Runtime object.
std::optional<std::string> yulIR; ///< Yul IR code straight from the code generator.
std::optional<std::string> yulIROptimized; ///< Reparsed and possibly optimized Yul IR code.
util::LazyInit<std::string const> metadata; ///< The metadata json that will be hashed into the chain.
util::LazyInit<Json const> abi;
util::LazyInit<Json const> storageLayout;
util::LazyInit<Json const> transientStorageLayout;
util::LazyInit<Json const> userDocumentation;
util::LazyInit<Json const> devDocumentation;
mutable std::optional<std::string const> sourceMapping;
mutable std::optional<std::string const> runtimeSourceMapping;
};
void createAndAssignCallGraphs();
void findAndReportCyclicContractDependencies();
/// Loads the missing sources from @a _ast (named @a _path) using the callback
/// @a m_readFile
/// @returns the newly loaded sources.
StringMap loadMissingSources(SourceUnit const& _ast);
std::string applyRemapping(std::string const& _path, std::string const& _context);
bool resolveImports();
/// Store the contract definitions in m_contracts.
void storeContractDefinitions();
/// Annotate internal dispatch function Ids
void annotateInternalFunctionIDs();
/// @returns true if the source is requested to be compiled.
bool isRequestedSource(std::string const& _sourceName) const;
/// @returns true if the contract is requested to be compiled.
bool isRequestedContract(ContractDefinition const& _contract) const;
/// @returns The effective pipeline configuration for a given contract.
/// Applies defaults for contracts that were not explicitly selected and combines
/// multiple entries if the contact is matched by wildcards.
PipelineConfig requestedPipelineConfig(ContractDefinition const& _contract) const;
/// Perform the analysis steps of legacy language mode.
/// @returns false on error.
bool analyzeLegacy(bool _noErrorsSoFar);
/// Perform the analysis steps of experimental language mode.
/// @returns false on error.
bool analyzeExperimental();
/// Assembles the contract.
/// This function should only be internally called by compileContract and generateEVMFromIR.
void assembleYul(
ContractDefinition const& _contract,
std::shared_ptr<evmasm::Assembly> _assembly,
std::shared_ptr<evmasm::Assembly> _runtimeAssembly
);
/// 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.
void compileContract(
ContractDefinition const& _contract,
std::map<ContractDefinition const*, std::shared_ptr<Compiler const>>& _otherCompilers
);
/// Generate Yul IR for a single contract.
/// Unoptimized IR is stored but otherwise unused, while optimized IR may be used for code
/// generation if compilation via IR is enabled. Note that whether "optimized IR" is actually
/// optimized depends on the optimizer settings.
/// @param _contract Contract to generate IR for.
/// @param _unoptimizedOnly If true, only the IR coming directly from the codegen is stored.
/// Optimizer is not invoked and optimized IR output is not available, which means that
/// optimized IR, its AST or compilation via IR must not be requested.
void generateIR(ContractDefinition const& _contract, bool _unoptimizedOnly);
/// Generate EVM representation for a single contract.
/// Depends on output generated by generateIR.
void generateEVMFromIR(ContractDefinition const& _contract);
/// Links all the known library addresses in the available objects. Any unknown
/// library will still be kept as an unlinked placeholder in the objects.
void link();
/// Parses and analyzes specified Yul source and returns the YulStack that can be used to manipulate it.
/// Assumes that the IR was generated from sources loaded currently into CompilerStack, which
/// means that it is error-free and uses the same settings.
yul::YulStack loadGeneratedIR(std::string const& _ir) const;
/// @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;
/// @param _forIR If true, include a flag that indicates that the bytecode comes from IR codegen.
/// @returns the metadata JSON as a compact string for the given contract.
std::string createMetadata(Contract const& _contract, bool _forIR) const;
/// @returns the metadata CBOR for the given serialised metadata JSON.
/// @param _forIR If true, use the metadata for the IR codegen. Otherwise the one for EVM codegen.
bytes createCBORMetadata(Contract const& _contract, bool _forIR) 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.
Json const& contractABI(Contract const&) const;
/// @returns the storage layout of the contract as a JSON object.
/// This will generate the JSON object and store it in the Contract object if it is not present yet.
Json const& storageLayout(Contract const&) const;
/// @returns the transient storage layout of the contract as a JSON object.
/// This will generate the JSON object and store it in the Contract object if it is not present yet.
Json const& transientStorageLayout(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.
Json 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.
Json const& natspecDev(Contract const&) const;
/// @returns the Contract Metadata matching the pipeline selected using the viaIR setting.
/// This will generate the metadata and store it in the Contract object if it is not present yet.
std::string const& metadata(Contract const& _contract) const;
/// @returns the Contract ethdebug data.
/// This will generate the JSON object and store it in the Contract object if it is not present yet.
/// Prerequisite: Successful call to parse or compile.
Json ethdebug(Contract const& _contract, bool _runtime) const;
/// @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;
void reportUnimplementedFeatureError(
langutil::UnimplementedFeatureError const& _error,
ContractDefinition const* _contractDefinition = nullptr
);
void reportCodeGenerationError(langutil::Error const& _error, ContractDefinition const* _contractDefinition);
void reportIRPostAnalysisError(langutil::Error const* _error, ContractDefinition const* _contractDefinition);
ReadCallback::Callback m_readFile;
OptimiserSettings m_optimiserSettings;
RevertStrings m_revertStrings = RevertStrings::Default;
State m_stopAfter = State::CompilationSuccessful;
bool m_viaIR = false;
langutil::EVMVersion m_evmVersion;
std::optional<uint8_t> m_eofVersion;
ModelCheckerSettings m_modelCheckerSettings;
ContractSelection m_selectedContracts;
std::map<std::string, util::h160> m_libraries;
ImportRemapper m_importRemapper;
std::map<std::string const, Source> m_sources;
std::optional<int64_t> m_maxAstId;
std::vector<std::string> m_unhandledSMTLib2Queries;
std::map<util::h256, std::string> m_smtlib2Responses;
std::shared_ptr<GlobalContext> m_globalContext;
std::vector<Source const*> m_sourceOrder;
std::map<std::string const, Contract> m_contracts;
std::shared_ptr<yul::ObjectOptimizer> m_objectOptimizer;
langutil::ErrorList m_errorList;
langutil::ErrorReporter m_errorReporter;
std::unique_ptr<experimental::Analysis> m_experimentalAnalysis;
bool m_metadataLiteralSources = false;
MetadataHash m_metadataHash = MetadataHash::IPFS;
langutil::DebugInfoSelection m_debugInfoSelection = langutil::DebugInfoSelection::Default();
State m_stackState = Empty;
CompilationSourceType m_compilationSourceType = CompilationSourceType::Solidity;
MetadataFormat m_metadataFormat = defaultMetadataFormat();
};
}