Line data Source code
1 : #include "fd_shredder.h"
2 : #include "../../ballet/shred/fd_shred.h"
3 :
4 : void *
5 : fd_shredder_new( void * mem,
6 : fd_shredder_sign_fn * signer,
7 57 : void * signer_ctx ) {
8 57 : fd_shredder_t * shredder = (fd_shredder_t *)mem;
9 :
10 57 : if( FD_UNLIKELY( !mem ) ) {
11 0 : FD_LOG_WARNING(( "NULL shredder memory" ));
12 0 : return NULL;
13 0 : }
14 :
15 57 : if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)mem, fd_shredder_align() ) ) ) {
16 0 : FD_LOG_WARNING(( "misaligned shredder memory" ));
17 0 : return NULL;
18 0 : }
19 :
20 57 : shredder->shred_version = 0;
21 57 : shredder->entry_batch = NULL;
22 57 : shredder->sz = 0UL;
23 57 : shredder->offset = 0UL;
24 :
25 57 : fd_memset( &(shredder->meta), 0, sizeof(fd_entry_batch_meta_t) );
26 57 : shredder->slot = ULONG_MAX;
27 57 : shredder->data_idx_offset = 0UL;
28 57 : shredder->parity_idx_offset = 0UL;
29 :
30 57 : shredder->signer = signer;
31 57 : shredder->signer_ctx = signer_ctx;
32 :
33 57 : FD_COMPILER_MFENCE();
34 57 : FD_VOLATILE( shredder->magic ) = FD_SHREDDER_MAGIC;
35 57 : FD_COMPILER_MFENCE();
36 :
37 57 : return (void *)shredder;
38 57 : }
39 :
40 : fd_shredder_t *
41 57 : fd_shredder_join( void * mem ) {
42 57 : if( FD_UNLIKELY( !mem ) ) {
43 0 : FD_LOG_WARNING(( "NULL shredder memory" ));
44 0 : return NULL;
45 0 : }
46 :
47 57 : if( FD_UNLIKELY( !fd_ulong_is_aligned( (ulong)mem, fd_shredder_align() ) ) ) {
48 0 : FD_LOG_WARNING(( "misaligned shredder memory" ));
49 0 : return NULL;
50 0 : }
51 :
52 57 : fd_shredder_t * shredder = (fd_shredder_t *)mem;
53 :
54 57 : if( FD_UNLIKELY( shredder->magic!=FD_SHREDDER_MAGIC ) ) {
55 0 : FD_LOG_WARNING(( "bad magic" ));
56 0 : return NULL;
57 0 : }
58 :
59 57 : return shredder;
60 57 : }
61 :
62 : void *
63 0 : fd_shredder_leave( fd_shredder_t * shredder ) {
64 0 : return (void *)shredder;
65 0 : }
66 :
67 : void *
68 0 : fd_shredder_delete( void * mem ) {
69 0 : fd_shredder_t * shredder = (fd_shredder_t *)mem;
70 :
71 0 : if( FD_UNLIKELY( shredder->magic!=FD_SHREDDER_MAGIC ) ) {
72 0 : FD_LOG_WARNING(( "bad magic" ));
73 0 : return NULL;
74 0 : }
75 :
76 0 : FD_COMPILER_MFENCE();
77 0 : FD_VOLATILE( shredder->magic ) = 0UL;
78 0 : FD_COMPILER_MFENCE();
79 :
80 0 : return (void *)shredder;
81 0 : }
82 :
83 :
84 : fd_shredder_t *
85 : fd_shredder_skip_batch( fd_shredder_t * shredder,
86 : ulong entry_batch_sz,
87 : ulong slot,
88 180 : ulong shred_type ) {
89 :
90 180 : if( FD_UNLIKELY( entry_batch_sz==0UL ) ) return NULL;
91 :
92 180 : if( FD_UNLIKELY( slot != shredder->slot ) ) {
93 45 : shredder->data_idx_offset = 0UL;
94 45 : shredder->parity_idx_offset = 0UL;
95 45 : }
96 :
97 : /* type of data & parity shreds is consistent (chained or not, resigned or not),
98 : so we just need one type. */
99 180 : ulong data_shred_cnt = fd_shredder_count_data_shreds( entry_batch_sz, shred_type );
100 180 : ulong parity_shred_cnt = fd_shredder_count_parity_shreds( entry_batch_sz, shred_type );
101 :
102 180 : shredder->data_idx_offset += data_shred_cnt;
103 180 : shredder->parity_idx_offset += parity_shred_cnt;
104 180 : shredder->slot = slot;
105 :
106 180 : return shredder;
107 180 : }
108 :
109 :
110 : fd_shredder_t *
111 : fd_shredder_init_batch( fd_shredder_t * shredder,
112 : void const * entry_batch,
113 : ulong entry_batch_sz,
114 : ulong slot,
115 900663 : fd_entry_batch_meta_t const * metadata ) {
116 :
117 900663 : if( FD_UNLIKELY( entry_batch_sz==0UL ) ) return NULL; /* FIXME: should this warn? Silently expand it to 1 byte? */
118 :
119 900663 : shredder->entry_batch = entry_batch;
120 900663 : shredder->sz = entry_batch_sz;
121 900663 : shredder->offset = 0UL;
122 :
123 900663 : if( FD_UNLIKELY( slot != shredder->slot ) ) {
124 900072 : shredder->data_idx_offset = 0UL;
125 900072 : shredder->parity_idx_offset = 0UL;
126 900072 : }
127 :
128 900663 : shredder->slot = slot;
129 900663 : shredder->meta = *metadata;
130 :
131 900663 : return shredder;
132 900663 : }
133 :
134 :
135 : fd_fec_set_t *
136 : fd_shredder_next_fec_set( fd_shredder_t * shredder,
137 : fd_fec_set_t * result,
138 : uchar * chained_merkle_root,
139 2330565 : uchar * out_merkle_root ) {
140 2330565 : uchar const * entry_batch = shredder->entry_batch;
141 2330565 : ulong offset = shredder->offset;
142 2330565 : ulong entry_sz = shredder->sz;
143 :
144 2330565 : uchar * * data_shreds = result->data_shreds;
145 2330565 : uchar * * parity_shreds = result->parity_shreds;
146 :
147 2330565 : fd_ed25519_sig_t __attribute__((aligned(32UL))) root_signature;
148 :
149 2330565 : if( FD_UNLIKELY( (offset==entry_sz) ) ) return NULL;
150 :
151 : /* Set the shred type */
152 :
153 1430574 : int block_complete = shredder->meta.block_complete;
154 1430574 : int is_chained = chained_merkle_root!=NULL;
155 1430574 : int is_resigned = is_chained && block_complete; /* only chained are resigned */
156 :
157 1430574 : uchar data_type = fd_uchar_if( is_chained, fd_uchar_if(
158 1430574 : is_resigned,
159 1430574 : FD_SHRED_TYPE_MERKLE_DATA_CHAINED_RESIGNED,
160 1430574 : FD_SHRED_TYPE_MERKLE_DATA_CHAINED
161 1430574 : ), FD_SHRED_TYPE_MERKLE_DATA );
162 :
163 1430574 : uchar code_type = fd_uchar_if( is_chained, fd_uchar_if(
164 1430574 : is_resigned,
165 1430574 : FD_SHRED_TYPE_MERKLE_CODE_CHAINED_RESIGNED,
166 1430574 : FD_SHRED_TYPE_MERKLE_CODE_CHAINED
167 1430574 : ), FD_SHRED_TYPE_MERKLE_CODE );
168 :
169 : /* Compute how many data and parity shreds to generate */
170 :
171 1430574 : ulong entry_bytes_remaining = entry_sz - offset;
172 : /* how many total payload bytes in this FEC set? */
173 1430574 : ulong fec_set_payload_sz = fd_ulong_if( is_chained, fd_ulong_if(
174 1430574 : is_resigned,
175 1430574 : FD_SHREDDER_RESIGNED_FEC_SET_PAYLOAD_SZ,
176 1430574 : FD_SHREDDER_CHAINED_FEC_SET_PAYLOAD_SZ
177 1430574 : ), FD_SHREDDER_NORMAL_FEC_SET_PAYLOAD_SZ );
178 1430574 : ulong chunk_size = fd_ulong_if( entry_bytes_remaining>=2UL*fec_set_payload_sz,
179 1430574 : fec_set_payload_sz,
180 1430574 : entry_bytes_remaining );
181 1430574 : ulong last_in_batch = (chunk_size+offset==entry_sz);
182 :
183 1430574 : ulong data_shred_cnt = fd_shredder_count_data_shreds( chunk_size, data_type );
184 1430574 : ulong parity_shred_cnt = fd_shredder_count_parity_shreds( chunk_size, code_type );
185 : /* Our notion of tree depth counts the root, while the shred version
186 : doesn't. */
187 1430574 : ulong tree_depth = fd_bmtree_depth( data_shred_cnt+parity_shred_cnt )-1UL;
188 1430574 : ulong data_shred_payload_sz = 1115UL - 20UL*tree_depth - 32UL*(uint)is_chained - 64UL*(uint)is_resigned;
189 1430574 : ulong parity_shred_payload_sz = data_shred_payload_sz + FD_SHRED_DATA_HEADER_SZ - FD_SHRED_SIGNATURE_SZ;
190 1430574 : ulong data_merkle_sz = parity_shred_payload_sz + 32UL*(uint)is_chained;
191 1430574 : ulong parity_merkle_sz = data_merkle_sz + FD_SHRED_CODE_HEADER_SZ - FD_SHRED_SIGNATURE_SZ;
192 :
193 1430574 : fd_reedsol_t * reedsol = fd_reedsol_encode_init( shredder->reedsol, parity_shred_payload_sz );
194 :
195 : /* Write headers and copy the data shred payload */
196 1430574 : ulong flags_for_last = ((last_in_batch & (ulong)block_complete)<<7) | (last_in_batch<<6);
197 53136564 : for( ulong i=0UL; i<data_shred_cnt; i++ ) {
198 51705990 : fd_shred_t * shred = (fd_shred_t *)data_shreds[ i ];
199 :
200 : /* Size in bytes of the payload section of this data shred,
201 : excluding any zero-padding */
202 51705990 : ulong shred_payload_sz = fd_ulong_min( entry_sz-offset, data_shred_payload_sz );
203 :
204 51705990 : shred->variant = fd_shred_variant( data_type, (uchar)tree_depth );
205 51705990 : shred->slot = shredder->slot;
206 51705990 : shred->idx = (uint )(shredder->data_idx_offset + i);
207 51705990 : shred->version = (ushort)(shredder->shred_version);
208 51705990 : shred->fec_set_idx = (uint )(shredder->data_idx_offset);
209 51705990 : shred->data.parent_off = (ushort)(shredder->meta.parent_offset);
210 51705990 : shred->data.flags = (uchar )(fd_ulong_if( i==data_shred_cnt-1UL, flags_for_last, 0UL ) | (shredder->meta.reference_tick & 0x3FUL));
211 51705990 : shred->data.size = (ushort)(FD_SHRED_DATA_HEADER_SZ + shred_payload_sz);
212 :
213 51705990 : uchar * payload = fd_memcpy( data_shreds[ i ] + FD_SHRED_DATA_HEADER_SZ , entry_batch+offset, shred_payload_sz );
214 51705990 : offset += shred_payload_sz;
215 :
216 : /* Write zero-padding, likely to be a no-op */
217 51705990 : fd_memset( payload+shred_payload_sz, 0, data_shred_payload_sz-shred_payload_sz );
218 :
219 : /* Set the last bytes of the signature field to the Merkle tree
220 : prefix so we can use the faster batch sha256 API to compute the
221 : Merkle tree */
222 51705990 : fd_memcpy( shred->signature + 64UL - 26UL, "\x00SOLANA_MERKLE_SHREDS_LEAF", 26UL );
223 :
224 : /* Prepare to generate parity data: data shred starts right after
225 : signature and goes until start of Merkle proof. */
226 51705990 : fd_reedsol_encode_add_data_shred( reedsol, ((uchar*)shred) + sizeof(fd_ed25519_sig_t) );
227 :
228 : /* Optionally, set chained merkle root */
229 51705990 : if( FD_LIKELY( chained_merkle_root ) ) {
230 33012744 : uchar * merkle = ((uchar*)shred) + fd_shred_chain_off( shred->variant );
231 33012744 : memcpy( merkle, chained_merkle_root, FD_SHRED_MERKLE_ROOT_SZ );
232 33012744 : }
233 51705990 : }
234 :
235 55685436 : for( ulong j=0UL; j<parity_shred_cnt; j++ ) {
236 54254862 : fd_shred_t * shred = (fd_shred_t *)parity_shreds[ j ];
237 54254862 : shred->variant = fd_shred_variant( code_type, (uchar)tree_depth );
238 54254862 : shred->slot = shredder->slot;
239 54254862 : shred->idx = (uint )(shredder->parity_idx_offset + j);
240 54254862 : shred->version = (ushort)(shredder->shred_version);
241 54254862 : shred->fec_set_idx = (uint )(shredder->data_idx_offset);
242 54254862 : shred->code.data_cnt = (ushort)(data_shred_cnt);
243 54254862 : shred->code.code_cnt = (ushort)(parity_shred_cnt);
244 54254862 : shred->code.idx = (ushort)(j);
245 :
246 54254862 : fd_memcpy( shred->signature + 64UL - 26UL, "\x00SOLANA_MERKLE_SHREDS_LEAF", 26UL );
247 :
248 : /* Prepare to generate parity data: parity info starts right after
249 : signature and goes until start of Merkle proof. */
250 54254862 : fd_reedsol_encode_add_parity_shred( reedsol, parity_shreds[ j ] + FD_SHRED_CODE_HEADER_SZ );
251 :
252 : /* Optionally, set chained merkle root */
253 54254862 : if( FD_LIKELY( chained_merkle_root ) ) {
254 34673946 : uchar * merkle = ((uchar*)shred) + fd_shred_chain_off( shred->variant );
255 34673946 : memcpy( merkle, chained_merkle_root, FD_SHRED_MERKLE_ROOT_SZ );
256 34673946 : }
257 54254862 : }
258 :
259 : /* Generate parity data */
260 1430574 : fd_reedsol_encode_fini( reedsol );
261 :
262 : /* Generate Merkle leaves */
263 1430574 : fd_sha256_batch_t * sha256 = fd_sha256_batch_init( shredder->sha256 );
264 1430574 : fd_bmtree_node_t * leaves = shredder->bmtree_leaves;
265 :
266 53136564 : for( ulong i=0UL; i<data_shred_cnt; i++ )
267 51705990 : fd_sha256_batch_add( sha256, data_shreds[i]+sizeof(fd_ed25519_sig_t)-26UL, data_merkle_sz+26UL, leaves[i].hash );
268 55685436 : for( ulong j=0UL; j<parity_shred_cnt; j++ )
269 54254862 : fd_sha256_batch_add( sha256, parity_shreds[j]+sizeof(fd_ed25519_sig_t)-26UL, parity_merkle_sz+26UL, leaves[j+data_shred_cnt].hash );
270 1430574 : fd_sha256_batch_fini( sha256 );
271 :
272 : /* Generate Merkle Proofs */
273 1430574 : fd_bmtree_commit_t * bmtree = fd_bmtree_commit_init( shredder->_bmtree_footprint, FD_SHRED_MERKLE_NODE_SZ, FD_BMTREE_LONG_PREFIX_SZ, tree_depth+1UL );
274 1430574 : fd_bmtree_commit_append( bmtree, leaves, data_shred_cnt+parity_shred_cnt );
275 1430574 : uchar * root = fd_bmtree_commit_fini( bmtree );
276 1430574 : if( FD_LIKELY( out_merkle_root ) ) memcpy( out_merkle_root, root, FD_SHRED_MERKLE_ROOT_SZ );
277 :
278 : /* Sign Merkle Root */
279 1430574 : shredder->signer( shredder->signer_ctx, root_signature, root );
280 :
281 : /* Write signature and Merkle proof */
282 53136564 : for( ulong i=0UL; i<data_shred_cnt; i++ ) {
283 51705990 : fd_shred_t * shred = (fd_shred_t *)data_shreds[ i ];
284 51705990 : fd_memcpy( shred->signature, root_signature, FD_ED25519_SIG_SZ );
285 :
286 51705990 : uchar * merkle = data_shreds[ i ] + fd_shred_merkle_off( shred );
287 51705990 : fd_bmtree_get_proof( bmtree, merkle, i );
288 :
289 : /* Agave doesn't seem to set the rentransmitter signature when the shred is first created,
290 : i.e. the leader sends shreds with rentransmitter signature set to 0.
291 : https://github.com/anza-xyz/agave/blob/v2.2.10/ledger/src/shred/merkle.rs#L1417-L1418 */
292 51705990 : if( FD_UNLIKELY( is_resigned ) ) {
293 17068809 : memset( ((uchar*)shred) + fd_shred_retransmitter_sig_off( shred ), 0, 64UL );
294 17068809 : }
295 51705990 : }
296 :
297 55685436 : for( ulong j=0UL; j<parity_shred_cnt; j++ ) {
298 54254862 : fd_shred_t * shred = (fd_shred_t *)parity_shreds[ j ];
299 54254862 : fd_memcpy( shred->signature, root_signature, FD_ED25519_SIG_SZ );
300 :
301 54254862 : uchar * merkle = parity_shreds[ j ] + fd_shred_merkle_off( shred );
302 54254862 : fd_bmtree_get_proof( bmtree, merkle, data_shred_cnt+j );
303 :
304 54254862 : if( FD_UNLIKELY( is_resigned ) ) {
305 17870898 : memset( ((uchar*)shred) + fd_shred_retransmitter_sig_off( shred ), 0, 64UL );
306 17870898 : }
307 54254862 : }
308 :
309 1430574 : shredder->offset = offset;
310 1430574 : shredder->data_idx_offset += data_shred_cnt;
311 1430574 : shredder->parity_idx_offset += parity_shred_cnt;
312 1430574 : if( FD_LIKELY( chained_merkle_root ) ) {
313 906414 : memcpy( chained_merkle_root, root, FD_SHRED_MERKLE_ROOT_SZ );
314 906414 : }
315 :
316 1430574 : result->data_shred_cnt = data_shred_cnt;
317 1430574 : result->parity_shred_cnt = parity_shred_cnt;
318 :
319 1430574 : return result;
320 2330565 : }
321 :
322 900654 : fd_shredder_t * fd_shredder_fini_batch( fd_shredder_t * shredder ) {
323 900654 : shredder->entry_batch = NULL;
324 900654 : shredder->sz = 0UL;
325 900654 : shredder->offset = 0UL;
326 :
327 900654 : return shredder;
328 900654 : }
|
