Skip to content

Commit 0b63a1d

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

12 files changed

Lines changed: 258 additions & 96 deletions

File tree

solx-core/src/build/contract/object.rs renamed to solx-core/src/build/contract/object/mod.rs

Lines changed: 65 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22
//! Bytecode object.
33
//!
44
5+
pub mod stage;
6+
57
use std::collections::BTreeMap;
68
use std::collections::BTreeSet;
79

810
use solx_standard_json::OutputError;
911

12+
use self::stage::Stage;
13+
1014
///
1115
/// Bytecode object.
1216
///
@@ -44,8 +48,11 @@ pub struct Object {
4448
/// Linker symbols that were not provided at compile time.
4549
/// Such symbols must be resolved by tooling before deployment.
4650
pub unlinked_symbols: BTreeMap<String, Vec<u64>>,
47-
/// Whether the object is already assembled.
48-
pub is_assembled: bool,
51+
/// The stage the object has reached, which the worker advances for the objects it links itself.
52+
pub stage: Stage,
53+
/// The assembled object before linking, which the objects embedding this one read.
54+
#[serde(with = "serde_bytes")]
55+
pub assembled_bytecode: Option<Vec<u8>>,
4956
/// Whether the size fallback was activated during the compilation.
5057
pub is_size_fallback: bool,
5158
/// Compilation warnings.
@@ -92,7 +99,8 @@ impl Object {
9299
metadata_bytes,
93100
dependencies,
94101
unlinked_symbols: BTreeMap::new(),
95-
is_assembled: false,
102+
stage: Stage::Compiled,
103+
assembled_bytecode: None,
96104
is_size_fallback,
97105
warnings,
98106
benchmarks,
@@ -125,35 +133,50 @@ impl Object {
125133
}
126134

127135
///
128-
/// Assembles the object.
136+
/// The objects this one embeds, when a worker holds them all: nothing for a runtime object,
137+
/// the assembled runtime object `runtime` for a deploy object. `None` for an object that
138+
/// embeds another contract's object, which only the parent holds.
139+
///
140+
pub fn embedded_objects(&self, runtime: Option<Vec<u8>>) -> Option<BTreeMap<String, Vec<u8>>> {
141+
if !self.dependencies.objects.is_empty() {
142+
return None;
143+
}
144+
match (self.dependencies.runtime.as_ref(), runtime) {
145+
(None, _) => Some(BTreeMap::new()),
146+
(Some(identifier), Some(runtime)) => {
147+
Some(BTreeMap::from([(identifier.to_owned(), runtime)]))
148+
}
149+
(Some(_), None) => None,
150+
}
151+
}
152+
153+
///
154+
/// Assembles the object with the objects it embeds, taken from `assembled_by_id`, and records
155+
/// the library references `linker_symbols` leaves unresolved.
129156
///
130157
/// # Panics
131158
/// If bytecode is `None`.
132159
///
133160
pub fn assemble(
134-
&self,
135-
objects_by_id: &BTreeMap<&str, &Self>,
136-
) -> anyhow::Result<inkwell::memory_buffer::MemoryBuffer> {
137-
let memory_buffer = self.to_memory_buffer()?;
138-
161+
&mut self,
162+
assembled_by_id: &BTreeMap<String, Vec<u8>>,
163+
linker_symbols: &BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
164+
) -> anyhow::Result<()> {
139165
let mut memory_buffers = Vec::with_capacity(
140166
1 + usize::from(self.dependencies.runtime.is_some()) + self.dependencies.objects.len(),
141167
);
142-
memory_buffers.push((self.identifier.to_owned(), memory_buffer));
143-
144-
memory_buffers.extend(self.dependencies.into_iter().map(|dependency| {
145-
let original_dependency_identifier = dependency.to_owned();
146-
let dependency = objects_by_id
147-
.get(dependency.as_str())
148-
.expect("Dependency not found");
149-
let dependency_bytecode = dependency.bytecode.as_deref().expect("Bytecode is not set");
168+
memory_buffers.push((self.identifier.to_owned(), self.to_memory_buffer()?));
169+
for dependency in self.dependencies.into_iter() {
170+
let bytecode = assembled_by_id
171+
.get(dependency)
172+
.expect("Every dependency is assembled before the objects embedding it");
150173
let memory_buffer = inkwell::memory_buffer::MemoryBuffer::create_from_memory_range(
151-
dependency_bytecode,
152-
dependency.identifier.as_str(),
174+
bytecode.as_slice(),
175+
dependency.as_str(),
153176
false,
154177
);
155-
(original_dependency_identifier, memory_buffer)
156-
}));
178+
memory_buffers.push((dependency.to_owned(), memory_buffer));
179+
}
157180

158181
let bytecode_buffers = memory_buffers
159182
.iter()
@@ -163,25 +186,41 @@ impl Object {
163186
.iter()
164187
.map(|(identifier, _memory_buffer)| identifier.as_str())
165188
.collect::<Vec<&str>>();
166-
solx_codegen_evm::assemble(
189+
let assembled = solx_codegen_evm::assemble(
167190
bytecode_buffers.as_slice(),
168191
bytecode_ids.as_slice(),
169192
self.code_segment,
170-
)
193+
)?;
194+
195+
for undefined_reference in assembled
196+
.get_undefined_references_evm()
197+
.into_iter()
198+
.filter(|reference| !linker_symbols.contains_key(reference))
199+
{
200+
let symbol_offsets = assembled.get_symbol_offsets_evm(undefined_reference.as_str());
201+
self.unlinked_symbols
202+
.insert(undefined_reference, symbol_offsets);
203+
}
204+
self.assembled_bytecode = Some(assembled.as_slice().to_owned());
205+
self.stage = Stage::Assembled;
206+
207+
Ok(())
171208
}
172209

173210
///
174211
/// Links the object with its linker symbols.
175212
///
176213
/// # Panics
177-
/// If bytecode is `None`.
214+
/// If the object is not assembled.
178215
///
179216
pub fn link(
180217
&mut self,
181218
linker_symbols: &BTreeMap<String, [u8; solx_utils::BYTE_LENGTH_ETH_ADDRESS]>,
182219
) -> anyhow::Result<()> {
183220
let memory_buffer = inkwell::memory_buffer::MemoryBuffer::create_from_memory_range(
184-
self.bytecode.as_deref().expect("Bytecode is not set"),
221+
self.assembled_bytecode
222+
.as_deref()
223+
.expect("Every object is assembled before it is linked"),
185224
self.identifier.as_str(),
186225
false,
187226
);
@@ -221,6 +260,7 @@ impl Object {
221260
}
222261
self.bytecode = Some(linked_object_with_placeholders.as_slice().to_owned());
223262
self.bytecode_hex = Some(bytecode_hex);
263+
self.stage = Stage::Linked;
224264

225265
Ok(())
226266
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
//!
2+
//! How far an object is on its way to bytecode.
3+
//!
4+
5+
///
6+
/// How far an object is on its way to bytecode.
7+
///
8+
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
9+
pub enum Stage {
10+
/// Compiled to an ELF object that still names the objects it embeds.
11+
Compiled,
12+
/// Assembled with the objects it embeds; library addresses are still unresolved.
13+
Assembled,
14+
/// Linked to bytecode.
15+
Linked,
16+
}

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

Lines changed: 47 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use solx_utils::SyncLock;
1818
use solx_standard_json::CollectableError;
1919

2020
use self::contract::Contract;
21-
use self::contract::object::Object as ContractObject;
21+
use self::contract::object::stage::Stage as ObjectStage;
2222

2323
///
2424
/// The Solidity project build.
@@ -62,84 +62,63 @@ impl Build {
6262
let ast_jsons = self.ast_jsons.take();
6363

6464
loop {
65-
let assembled_objects_data = {
66-
let all_objects = self
67-
.contracts
68-
.values()
69-
.flat_map(|contract| contract.objects_ref())
70-
.collect::<Vec<&ContractObject>>();
71-
let objects_by_id: BTreeMap<&str, &ContractObject> = all_objects
72-
.iter()
73-
.map(|object| (object.identifier.as_str(), *object))
74-
.collect();
75-
76-
let assembleable_objects = all_objects
77-
.iter()
78-
.filter(|object| {
79-
!object.is_assembled
80-
&& object.dependencies.into_iter().all(|dependency| {
81-
objects_by_id
82-
.get(dependency.as_str())
83-
.expect("Every bytecode dependency has a compiled object")
84-
.is_assembled
85-
})
86-
})
87-
.copied()
88-
.collect::<Vec<_>>();
89-
if assembleable_objects.is_empty() {
90-
break;
91-
}
92-
93-
let mut assembled_objects_data = Vec::with_capacity(assembleable_objects.len());
94-
for object in assembleable_objects.into_iter() {
95-
let assembled_object = match object.assemble(&objects_by_id) {
96-
Ok(assembled_object) => assembled_object,
97-
Err(error) => {
98-
self.messages.lock_sync().push(
99-
solx_standard_json::OutputError::new_error_contract(
100-
Some(object.contract_name.path.as_str()),
101-
&error,
102-
),
103-
);
104-
return Self::new(BTreeMap::new(), ast_jsons, self.messages);
105-
}
106-
};
107-
assembled_objects_data.push((
65+
let assembled_by_id: BTreeMap<String, Vec<u8>> = self
66+
.contracts
67+
.values()
68+
.flat_map(|contract| contract.objects_ref())
69+
.filter_map(|object| {
70+
object
71+
.assembled_bytecode
72+
.clone()
73+
.map(|bytecode| (object.identifier.clone(), bytecode))
74+
})
75+
.collect();
76+
let assembleable_objects = self
77+
.contracts
78+
.values()
79+
.flat_map(|contract| contract.objects_ref())
80+
.filter(|object| {
81+
object.stage == ObjectStage::Compiled
82+
&& object
83+
.dependencies
84+
.into_iter()
85+
.all(|dependency| assembled_by_id.contains_key(dependency))
86+
})
87+
.map(|object| {
88+
(
10889
object.contract_name.full_path.to_owned(),
10990
object.code_segment,
110-
assembled_object,
111-
));
112-
}
113-
assembled_objects_data
114-
};
91+
)
92+
})
93+
.collect::<Vec<_>>();
94+
if assembleable_objects.is_empty() {
95+
break;
96+
}
11597

116-
for (full_path, code_segment, assembled_object) in assembled_objects_data.into_iter() {
117-
let contract = self
98+
for (full_path, code_segment) in assembleable_objects.into_iter() {
99+
let object = self
118100
.contracts
119101
.get_mut(full_path.as_str())
120-
.expect("An assembled object's contract exists in this build");
121-
let object = contract
102+
.expect("An assembleable object's contract exists in this build")
122103
.object_mut_by_code_segment(code_segment)
123-
.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);
104+
.expect("An assembleable object exists in its contract");
105+
if let Err(error) = object.assemble(&assembled_by_id, &linker_symbols) {
106+
self.messages.lock_sync().push(
107+
solx_standard_json::OutputError::new_error_contract(
108+
Some(object.contract_name.path.as_str()),
109+
&error,
110+
),
111+
);
112+
return Self::new(BTreeMap::new(), ast_jsons, self.messages);
135113
}
136-
object.is_assembled = true;
137114
}
138115
}
139116

140117
for contract in self.contracts.values_mut() {
141118
for object in contract.objects_mut().into_iter() {
142-
if let Err(error) = object.link(&linker_symbols) {
119+
if object.stage != ObjectStage::Linked
120+
&& let Err(error) = object.link(&linker_symbols)
121+
{
143122
self.messages.lock_sync().push(
144123
solx_standard_json::OutputError::new_error_contract(
145124
Some(object.contract_name.path.as_str()),
@@ -148,6 +127,7 @@ impl Build {
148127
);
149128
return Self::new(BTreeMap::new(), ast_jsons, self.messages);
150129
}
130+
object.assembled_bytecode = None;
151131
}
152132
}
153133

‎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_assembled_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 object, sent to a deploy job that embeds nothing else.
30+
#[serde(with = "serde_bytes")]
31+
pub runtime_assembled_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_assembled_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_assembled_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
}

0 commit comments

Comments
 (0)