22//! Bytecode object.
33//!
44
5+ pub mod stage;
6+
57use std:: collections:: BTreeMap ;
68use std:: collections:: BTreeSet ;
79
810use 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 }
0 commit comments