Skip to content

Commit 63ce7d1

Browse files
committed
perf(core): assemble and link objects without inner dependencies in the worker
1 parent dae295e commit 63ce7d1

8 files changed

Lines changed: 150 additions & 32 deletions

File tree

‎solx-core/src/build/contract/object.rs‎

Lines changed: 88 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,12 @@ pub struct Object {
4444
/// Linker symbols that were not provided at compile time.
4545
/// Such symbols must be resolved by tooling before deployment.
4646
pub unlinked_symbols: BTreeMap<String, Vec<u64>>,
47-
/// Whether the object is already assembled.
48-
pub is_assembled: bool,
47+
/// How far the object is on its way to bytecode.
48+
pub stage: Stage,
49+
/// The assembled, unlinked object, which the objects embedding this one read; kept by a worker
50+
/// that linked the object itself, since linking replaces `bytecode`.
51+
#[serde(with = "serde_bytes")]
52+
pub assembled_bytecode: Option<Vec<u8>>,
4953
/// Whether the size fallback was activated during the compilation.
5054
pub is_size_fallback: bool,
5155
/// Compilation warnings.
@@ -54,6 +58,19 @@ pub struct Object {
5458
pub benchmarks: Vec<(String, u64)>,
5559
}
5660

61+
///
62+
/// How far an object is on its way to bytecode.
63+
///
64+
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
65+
pub enum Stage {
66+
/// Compiled to an ELF object that still names the objects it embeds.
67+
Compiled,
68+
/// Assembled with the objects it embeds; library addresses are still unresolved.
69+
Assembled,
70+
/// Linked to bytecode.
71+
Linked,
72+
}
73+
5774
impl Object {
5875
/// Length of the library placeholder.
5976
pub const LIBRARY_PLACEHOLDER_LENGTH: usize = 17;
@@ -92,7 +109,8 @@ impl Object {
92109
metadata_bytes,
93110
dependencies,
94111
unlinked_symbols: BTreeMap::new(),
95-
is_assembled: false,
112+
stage: Stage::Compiled,
113+
assembled_bytecode: None,
96114
is_size_fallback,
97115
warnings,
98116
benchmarks,
@@ -125,14 +143,27 @@ impl Object {
125143
}
126144

127145
///
128-
/// Assembles the object.
146+
/// The assembled object, which the objects embedding this one read, once it is assembled.
147+
///
148+
pub fn assembled_bytecode(&self) -> Option<&[u8]> {
149+
match self.stage {
150+
Stage::Compiled => None,
151+
Stage::Assembled | Stage::Linked => self
152+
.assembled_bytecode
153+
.as_deref()
154+
.or(self.bytecode.as_deref()),
155+
}
156+
}
157+
158+
///
159+
/// Assembles the object with `dependencies`, the assembled objects it embeds by identifier.
129160
///
130161
/// # Panics
131162
/// If bytecode is `None`.
132163
///
133164
pub fn assemble(
134165
&self,
135-
objects_by_id: &BTreeMap<&str, &Self>,
166+
dependencies: &BTreeMap<&str, &[u8]>,
136167
) -> anyhow::Result<inkwell::memory_buffer::MemoryBuffer> {
137168
let memory_buffer = self.to_memory_buffer()?;
138169

@@ -142,17 +173,15 @@ impl Object {
142173
memory_buffers.push((self.identifier.to_owned(), memory_buffer));
143174

144175
memory_buffers.extend(self.dependencies.into_iter().map(|dependency| {
145-
let original_dependency_identifier = dependency.to_owned();
146-
let dependency = objects_by_id
176+
let bytecode = dependencies
147177
.get(dependency.as_str())
148-
.expect("Dependency not found");
149-
let dependency_bytecode = dependency.bytecode.as_deref().expect("Bytecode is not set");
178+
.expect("Every dependency is assembled before the objects embedding it");
150179
let memory_buffer = inkwell::memory_buffer::MemoryBuffer::create_from_memory_range(
151-
dependency_bytecode,
152-
dependency.identifier.as_str(),
180+
bytecode,
181+
dependency.as_str(),
153182
false,
154183
);
155-
(original_dependency_identifier, memory_buffer)
184+
(dependency.to_owned(), memory_buffer)
156185
}));
157186

158187
let bytecode_buffers = memory_buffers
@@ -170,6 +199,52 @@ impl Object {
170199
)
171200
}
172201

202+
///
203+
/// Records the assembled object: its code with the dependencies embedded, and the references
204+
/// to libraries whose addresses `linker_symbols` does not hold.
205+
///
206+
pub fn finish_assembly(
207+
&mut self,
208+
assembled: inkwell::memory_buffer::MemoryBuffer,
209+
linker_symbols: &BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
210+
) {
211+
for undefined_reference in assembled
212+
.get_undefined_references_evm()
213+
.into_iter()
214+
.filter(|reference| !linker_symbols.contains_key(reference))
215+
{
216+
let symbol_offsets = assembled.get_symbol_offsets_evm(undefined_reference.as_str());
217+
self.unlinked_symbols
218+
.insert(undefined_reference, symbol_offsets);
219+
}
220+
self.bytecode = Some(assembled.as_slice().to_owned());
221+
self.stage = Stage::Assembled;
222+
}
223+
224+
///
225+
/// Assembles and links the object in the worker that compiled it, which is possible when it
226+
/// embeds no other contract's object: a runtime object embeds nothing, a deploy object embeds
227+
/// `runtime_bytecode`, its assembled runtime object. The assembled form is kept for the
228+
/// objects that embed this one.
229+
///
230+
pub fn assemble_and_link_in_worker(
231+
&mut self,
232+
runtime_bytecode: Option<&[u8]>,
233+
linker_symbols: &BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
234+
) -> anyhow::Result<()> {
235+
let dependencies = self
236+
.dependencies
237+
.runtime
238+
.as_deref()
239+
.zip(runtime_bytecode)
240+
.into_iter()
241+
.collect();
242+
let assembled = self.assemble(&dependencies)?;
243+
self.assembled_bytecode = Some(assembled.as_slice().to_owned());
244+
self.finish_assembly(assembled, linker_symbols);
245+
self.link(linker_symbols)
246+
}
247+
173248
///
174249
/// Links the object with its linker symbols.
175250
///
@@ -221,6 +296,7 @@ impl Object {
221296
}
222297
self.bytecode = Some(linked_object_with_placeholders.as_slice().to_owned());
223298
self.bytecode_hex = Some(bytecode_hex);
299+
self.stage = Stage::Linked;
224300

225301
Ok(())
226302
}

‎solx-core/src/build/mod.rs‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ use solx_standard_json::CollectableError;
1919

2020
use self::contract::Contract;
2121
use self::contract::object::Object as ContractObject;
22+
use self::contract::object::Stage as ObjectStage;
2223

2324
///
2425
/// The Solidity project build.
@@ -72,16 +73,25 @@ impl Build {
7273
.iter()
7374
.map(|object| (object.identifier.as_str(), *object))
7475
.collect();
76+
let assembled: BTreeMap<&str, &[u8]> = all_objects
77+
.iter()
78+
.filter_map(|object| {
79+
object
80+
.assembled_bytecode()
81+
.map(|bytecode| (object.identifier.as_str(), bytecode))
82+
})
83+
.collect();
7584

7685
let assembleable_objects = all_objects
7786
.iter()
7887
.filter(|object| {
79-
!object.is_assembled
88+
object.stage == ObjectStage::Compiled
8089
&& object.dependencies.into_iter().all(|dependency| {
8190
objects_by_id
8291
.get(dependency.as_str())
8392
.expect("Every bytecode dependency has a compiled object")
84-
.is_assembled
93+
.stage
94+
!= ObjectStage::Compiled
8595
})
8696
})
8797
.copied()
@@ -92,7 +102,7 @@ impl Build {
92102

93103
let mut assembled_objects_data = Vec::with_capacity(assembleable_objects.len());
94104
for object in assembleable_objects.into_iter() {
95-
let assembled_object = match object.assemble(&objects_by_id) {
105+
let assembled_object = match object.assemble(&assembled) {
96106
Ok(assembled_object) => assembled_object,
97107
Err(error) => {
98108
self.messages.lock_sync().push(
@@ -121,24 +131,16 @@ impl Build {
121131
let object = contract
122132
.object_mut_by_code_segment(code_segment)
123133
.expect("An assembled object exists in its contract");
124-
object.bytecode = Some(assembled_object.as_slice().to_owned());
125-
for undefined_reference in assembled_object
126-
.get_undefined_references_evm()
127-
.into_iter()
128-
.filter(|reference| !linker_symbols.contains_key(reference))
129-
{
130-
let symbol_offsets =
131-
assembled_object.get_symbol_offsets_evm(undefined_reference.as_str());
132-
object
133-
.unlinked_symbols
134-
.insert(undefined_reference, symbol_offsets);
135-
}
136-
object.is_assembled = true;
134+
object.finish_assembly(assembled_object, &linker_symbols);
137135
}
138136
}
139137

140138
for contract in self.contracts.values_mut() {
141139
for object in contract.objects_mut().into_iter() {
140+
object.assembled_bytecode = None;
141+
if object.stage == ObjectStage::Linked {
142+
continue;
143+
}
142144
if let Err(error) = object.link(&linker_symbols) {
143145
self.messages.lock_sync().push(
144146
solx_standard_json::OutputError::new_error_contract(

‎solx-core/src/process/child.rs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ pub fn run() -> anyhow::Result<()> {
4343
job.optimizer_settings,
4444
session.llvm_options.clone(),
4545
session.output_config.clone(),
46+
job.runtime_bytecode,
47+
&session.linker_symbols,
4648
)
4749
.map(EVMOutput::new)
4850
.map_err(|error| match error {

‎solx-core/src/process/job.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ pub struct Job {
2626
pub metadata_bytes: Option<Vec<u8>>,
2727
/// The optimizer settings.
2828
pub optimizer_settings: solx_codegen_evm::OptimizerSettings,
29+
/// The assembled runtime bytecode a deploy job without inner dependencies embeds itself.
30+
#[serde(with = "serde_bytes")]
31+
pub runtime_bytecode: Option<Vec<u8>>,
2932
}
3033

3134
impl Job {
@@ -39,6 +42,7 @@ impl Job {
3942
immutables: Option<BTreeMap<String, BTreeSet<u64>>>,
4043
metadata_bytes: Option<Vec<u8>>,
4144
optimizer_settings: solx_codegen_evm::OptimizerSettings,
45+
runtime_bytecode: Option<Vec<u8>>,
4246
) -> Self {
4347
Self {
4448
contract_name,
@@ -47,6 +51,7 @@ impl Job {
4751
immutables,
4852
metadata_bytes,
4953
optimizer_settings,
54+
runtime_bytecode,
5055
}
5156
}
5257
}

‎solx-core/src/process/session.rs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
//! The project-wide data shared by all translation units.
33
//!
44
5+
use std::collections::BTreeMap;
6+
57
///
68
/// The project-wide data shared by all translation units.
79
///
@@ -17,6 +19,8 @@ pub struct Session {
1719
pub llvm_options: Vec<String>,
1820
/// The output config for IR artifacts.
1921
pub output_config: Option<solx_codegen_evm::OutputConfig>,
22+
/// The library addresses the objects are linked with.
23+
pub linker_symbols: BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
2024
}
2125

2226
impl Session {
@@ -28,12 +32,14 @@ impl Session {
2832
output_selection: solx_standard_json::InputSelection,
2933
llvm_options: Vec<String>,
3034
output_config: Option<solx_codegen_evm::OutputConfig>,
35+
linker_symbols: BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
3136
) -> Self {
3237
Self {
3338
evm_version,
3439
output_selection,
3540
llvm_options,
3641
output_config,
42+
linker_symbols,
3743
}
3844
}
3945
}

‎solx-core/src/project/contract/mod.rs‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ impl Contract {
103103
mut optimizer_settings: solx_codegen_evm::OptimizerSettings,
104104
llvm_options: Vec<String>,
105105
output_config: Option<solx_codegen_evm::OutputConfig>,
106+
runtime_bytecode: Option<Vec<u8>>,
107+
linker_symbols: &BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
106108
) -> Result<EVMContractObject, Error> {
107109
let mut profiler = solx_utils::Profiler::default();
108110

@@ -297,7 +299,12 @@ impl Contract {
297299
(Some(build.immutables.unwrap_or_default()), metadata_bytes)
298300
}
299301
};
300-
let object = EVMContractObject::new(
302+
let is_self_contained = output_bytecode
303+
&& build.bytecode.is_some()
304+
&& mlir.dependencies.objects.is_empty()
305+
&& (code_segment == solx_utils::CodeSegment::Runtime
306+
|| runtime_bytecode.is_some());
307+
let mut object = EVMContractObject::new(
301308
code_identifier,
302309
contract_name.clone(),
303310
build.assembly,
@@ -311,8 +318,21 @@ impl Contract {
311318
mlir.dependencies,
312319
build.is_size_fallback,
313320
build.warnings,
314-
profiler.to_vec(),
321+
Vec::new(),
315322
);
323+
if is_self_contained {
324+
let run_assemble_link = profiler.start_evm_translation_unit(
325+
contract_name.full_path.as_str(),
326+
code_segment,
327+
"AssembleLink",
328+
optimizer_mode.as_str(),
329+
spill_area_size,
330+
);
331+
object
332+
.assemble_and_link_in_worker(runtime_bytecode.as_deref(), linker_symbols)?;
333+
run_assemble_link.borrow_mut().finish();
334+
}
335+
object.benchmarks = profiler.to_vec();
316336
Ok(object)
317337
}
318338
}

‎solx-core/src/project/mod.rs‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,13 +281,14 @@ impl Project {
281281
solc_version,
282282
contracts,
283283
ast_jsons,
284-
libraries: _,
284+
libraries,
285285
} = self;
286286
let pool = EVMProcessPool::new(EVMProcessSession::new(
287287
evm_version,
288288
output_selection.clone(),
289289
llvm_options.clone(),
290290
output_config,
291+
libraries.as_linker_symbols()?,
291292
))?;
292293

293294
let mut contracts: Vec<(String, Contract)> = contracts.into_iter().collect();
@@ -375,6 +376,7 @@ impl Project {
375376
None,
376377
metadata_bytes,
377378
optimizer_settings.clone(),
379+
None,
378380
);
379381

380382
let result = Self::run_multi_pass_pipeline(&pool, &mut job);
@@ -385,6 +387,10 @@ impl Project {
385387
.as_ref()
386388
.ok()
387389
.and_then(|output| output.object.immutables.to_owned());
390+
let runtime_bytecode = runtime_object_result
391+
.as_ref()
392+
.ok()
393+
.and_then(|output| output.object.assembled_bytecode.clone());
388394
let deploy_object_result: crate::Result<EVMProcessOutput> = {
389395
let mut job = EVMProcessJob::new(
390396
contract_name.clone(),
@@ -393,6 +399,7 @@ impl Project {
393399
immutables,
394400
None,
395401
optimizer_settings.clone(),
402+
runtime_bytecode,
396403
);
397404

398405
Self::run_multi_pass_pipeline(&pool, &mut job)

0 commit comments

Comments
 (0)