Line data Source code
1 : #ifndef HEADER_fd_src_disco_pack_fd_pack_h
2 : #define HEADER_fd_src_disco_pack_fd_pack_h
3 :
4 : /* fd_pack defines methods that prioritizes Solana transactions,
5 : selecting a subset (potentially all) and ordering them to attempt to
6 : maximize the overall profitability of the validator. */
7 :
8 : #include "../../ballet/fd_ballet_base.h"
9 : #include "../../ballet/txn/fd_txn.h"
10 : #include "../shred/fd_shred_batch.h"
11 : #include "fd_est_tbl.h"
12 : #include "fd_microblock.h"
13 : #include "fd_pack_rebate_sum.h"
14 : #include "fd_pack_acct_blocklist.h"
15 : #include "../metrics/generated/fd_metrics_enums.h"
16 :
17 0 : #define FD_PACK_ALIGN (128UL)
18 :
19 0 : #define FD_PACK_MAX_EXECLE_TILES 62UL
20 :
21 0 : #define FD_PACK_FEE_PER_SIGNATURE (5000UL) /* In lamports */
22 :
23 : /* Each block is limited to 32k parity shreds. We don't want pack to
24 : produce a block with so many transactions we can't shred it, but the
25 : correspondence between transactions and parity shreds is somewhat
26 : complicated, so we need to use conservative limits. */
27 0 : #define FD_PACK_MAX_DATA_PER_BLOCK (FD_SHRED_BATCH_BLOCK_DATA_SZ_MAX)
28 :
29 : /* ---- End consensus-critical constants */
30 :
31 0 : #define FD_TXN_P_FLAGS_IS_SIMPLE_VOTE ( 1U)
32 0 : #define FD_TXN_P_FLAGS_BUNDLE ( 2U)
33 0 : #define FD_TXN_P_FLAGS_INITIALIZER_BUNDLE ( 4U)
34 0 : #define FD_TXN_P_FLAGS_SANITIZE_SUCCESS ( 8U)
35 0 : #define FD_TXN_P_FLAGS_EXECUTE_SUCCESS (16U)
36 0 : #define FD_TXN_P_FLAGS_FEES_ONLY (32U)
37 0 : #define FD_TXN_P_FLAGS_DURABLE_NONCE (64U)
38 :
39 0 : #define FD_TXN_P_FLAGS_RESULT_MASK (0xFF000000U)
40 :
41 : /* The percentage of the transaction fees that are burned */
42 0 : #define FD_PACK_TXN_FEE_BURN_PCT 50UL
43 :
44 : /* Durable nonce transactions don't have a fixed lifetime (see
45 : expire_before, etc.) but we arbitrarily give them one to prevent them
46 : from remaining perpetually e.g. between leader rotations. The unit
47 : here is arbitrary, but 500 makes the most sense for slots. TODO:
48 : make this configurable. */
49 0 : #define FD_PACK_NONCE_SYNTHETIC_LIFETIME 500UL
50 :
51 :
52 : /* The Solana network and Firedancer implementation details impose
53 : several limits on what pack can produce. These limits are grouped in
54 : this one struct fd_pack_limits_t, which is just a convenient way to
55 : pass them around. The limits listed below are arithmetic limits.
56 : The limits imposed by practical constraints are almost certainly
57 : much, much tighter. */
58 : struct fd_pack_limits {
59 : /* max_{cost, vote_cost}_per_block, max_write_cost_per_acct are
60 : consensus-critical limits and must be agreed on cluster-wide. A
61 : block that consumes more than max_cost_per_block cost units
62 : (closely related to, but not identical to CUs) in total is invalid.
63 : Similarly, a block where the sum of the cost of all vote
64 : transactions exceeds max_vote_cost_per_block cost units is invalid.
65 : Similarly, a block in where the sum of the cost of all transactions
66 : that write to a given account exceeds max_write_cost_per_acct is
67 : invalid. */
68 : ulong max_cost_per_block; /* in [0, UINT_MAX) */
69 : ulong max_vote_cost_per_block; /* in [0, max_cost_per_block] */
70 : ulong max_write_cost_per_acct; /* in [0, max_cost_per_block] */
71 :
72 : /* max_data_bytes_per_block is derived from consensus-critical limits
73 : on the number of shreds in a block, but is not directly enforced.
74 : Separation of concerns means that it's not a good idea for pack to
75 : know exactly how the block will be shredded, but at the same time,
76 : we don't want to end up in a situation where we produced a block
77 : that had too many shreds, because the shred tile's only recourse
78 : would be to kill the block. To address this, pack limits the size
79 : of the data it puts into the block to a limit that we can prove
80 : will never cause the shred tile to produce too many shreds.
81 : At runtime this is how many entry bytes fit in max_shred_idx
82 : after FEC padding (we close a shred batch when the next
83 : microblock would not fit in two FEC sets). Empty ticks are
84 : subtracted. Large microblocks pad more, so the cap
85 : tightens.
86 :
87 : This limit includes transaction and microblock headers for
88 : non-empty microblocks that pack produces. */
89 : ulong max_data_bytes_per_block; /* in [0, ULONG_MAX - 183] */
90 :
91 : /* max_txn_per_microblock and max_microblocks_per_block are
92 : Firedancer-imposed implementation limits to bound the amount of
93 : memory consumption that pack uses. Pack will produce microblocks
94 : with no more than max_txn_per_microblock transactions.
95 : Additionally, once pack produces max_microblocks_per_block
96 : non-empty microblocks in a block, all subsequent attempts to
97 : schedule a microblock will return an empty microblock until
98 : fd_pack_end_block is called. */
99 : ulong max_txn_per_microblock; /* in [0, 16777216] */
100 : ulong max_microblocks_per_block; /* in [0, 1e12) */
101 :
102 : /* max_allocated_data_per_block is a consensus-critical constant that
103 : limits the total amount of data that can be allocated by
104 : transactions in a block. This includes new accounts and extending
105 : existing accounts. This limit is not especially well specified,
106 : and rarely comes close to being hit in production, so we use a
107 : conservative estimate when packing to ensure we never hit it. It
108 : is currently limited to 100 MB, without any features to change it,
109 : but we include it here with other limits in case it is change-able
110 : in the future. */
111 : ulong max_allocated_data_per_block; /* in [1, 100,000,000 ] */
112 : };
113 : typedef struct fd_pack_limits fd_pack_limits_t;
114 :
115 : /* fd_pack_addr_use_t: Used for three distinct purposes:
116 : - to record that an address is in use and can't be used again until
117 : certain microblocks finish execution
118 : - to keep track of the cost of all transactions that write to the
119 : specified account.
120 : - to keep track of the write cost for accounts referenced by
121 : transactions in a bundle and which transactions use which
122 : accounts.
123 : Making these separate structs might make it more clear, but then
124 : they'd have identical shape and result in several fd_map_dynamic sets
125 : of functions with identical code. It doesn't seem like the compiler
126 : is very good at merging code like that, so in order to reduce code
127 : bloat, we'll just combine them. */
128 : struct fd_pack_private_addr_use_record {
129 : fd_acct_addr_t key; /* account address */
130 : union {
131 : ulong _;
132 : ulong in_use_by; /* Bitmask indicating which banks */
133 : ulong total_cost; /* In cost units/CUs */
134 : struct { uint carried_cost; /* In cost units */
135 : ushort ref_cnt; /* In transactions */
136 : ushort last_use_in; }; /* In transactions */
137 : };
138 : };
139 : typedef struct fd_pack_private_addr_use_record fd_pack_addr_use_t;
140 :
141 : /* The point of this array it to keep a simple heap of the top 5
142 : writable accounts by cus in a given slot. The top writers heap is
143 : constructed and available at the end of a leader slot, after all CUs
144 : have been rebated. */
145 0 : #define FD_PACK_TOP_WRITERS_CNT (5UL)
146 0 : #define FD_PACK_TOP_WRITERS_SORT_BEFORE(writer1,writer2) ( (memcmp( (writer1).key.b, &(uchar[32]){ 0 }, FD_TXN_ACCT_ADDR_SZ ) && (writer1).total_cost>(writer2).total_cost) || !memcmp( (writer2).key.b, &(uchar[32]){ 0 }, FD_TXN_ACCT_ADDR_SZ ))
147 :
148 : /* fd_pack_limit_usage_t is used to store the actual per-slot resource
149 : utilization. Each utilization field has a corresponding limit field
150 : in fd_pack_limits_t which is greater than or equal to the utilization
151 : field. */
152 : struct fd_pack_limits_usage {
153 : ulong block_cost;
154 : ulong vote_cost;
155 :
156 : /* Contains the top 5 writers in the block. If there are less than 5
157 : writeable accounts, unused slots will have their pubkey zeroed out. */
158 : fd_pack_addr_use_t top_writers[ FD_PACK_TOP_WRITERS_CNT ];
159 : ulong block_data_bytes;
160 : ulong microblocks;
161 : ulong alloc;
162 : };
163 :
164 : typedef struct fd_pack_limits_usage fd_pack_limits_usage_t;
165 :
166 : /* fd_pack_smallest: We want to keep track of the smallest transaction
167 : in each treap. That way, if we know the amount of space left in the
168 : block is less than the smallest transaction in the heap, we can just
169 : skip the heap. Since transactions can be deleted, etc. maintaining
170 : this precisely is hard, but we can maintain a conservative value
171 : fairly cheaply. Since the CU limit or the byte limit can be the one
172 : that matters, we keep track of the smallest by both. */
173 : struct fd_pack_smallest {
174 : ulong cus;
175 : ulong bytes;
176 : };
177 : typedef struct fd_pack_smallest fd_pack_smallest_t;
178 :
179 : /* Forward declare opaque handle */
180 : struct fd_pack_private;
181 : typedef struct fd_pack_private fd_pack_t;
182 :
183 : /* fd_pack_{align,footprint} return the required alignment and
184 : footprint in bytes for a region of memory to be used as a pack
185 : object.
186 :
187 : pack_depth sets the maximum number of pending transactions that pack
188 : stores and may eventually schedule. pack_depth must be at least 4.
189 :
190 : If bundle_meta_sz is non-zero, then the bundle-related functions on
191 : this pack object can be used, and it can schedule bundles.
192 : Additionally, if bundle_meta_sz is non-zero, then a region of size
193 : bundle_meta_sz bytes (with no additional alignment) will be reserved
194 : for each bundle.
195 :
196 : Note: if you'd like to use bundles, but don't require metadata for
197 : the bundles, simply use a small positive value (e.g. 1), always pass
198 : NULL in insert_bundle_fini, and never call fd_pack_peek_bundle_meta.
199 :
200 : bank_tile_cnt sets the number of bank tiles to which this pack object
201 : can schedule transactions. bank_tile_cnt must be in [1,
202 : FD_PACK_MAX_BANK_TILES].
203 :
204 : limits sets various limits for the blocks and microblocks that pack
205 : can produce. */
206 :
207 0 : FD_FN_CONST static inline ulong fd_pack_align ( void ) { return FD_PACK_ALIGN; }
208 :
209 : FD_FN_PURE ulong
210 : fd_pack_footprint( ulong pack_depth,
211 : ulong bundle_meta_sz,
212 : ulong bank_tile_cnt,
213 : fd_pack_limits_t const * limits );
214 :
215 :
216 : /* fd_pack_new formats a region of memory to be suitable for use as a
217 : pack object. mem is a non-NULL pointer to a region of memory in the
218 : local address space with the required alignment and footprint.
219 : pack_depth, bundle_meta_sz, bank_tile_cnt, and limits are as above.
220 : The limits provided in this function are the maximum possible limits
221 : this pack object can handle without being completely reformatted.
222 : rng is a local join to a random number generator used to perturb
223 : estimates. acct_blocklist is a list of accounts that cannot be read
224 : or written to. acct_blocklist is accessed acct_blocklist[i] for i in
225 : [0, acct_blocklist_cnt). acct_blocklist==NULL is okay if
226 : acct_blocklist_cnt==0. acct_blocklist_cnt must be no more than
227 : FD_PACK_ACCT_BLOCKLIST_MAX. acct_blocklist must not contain
228 : duplicates or the zero address.
229 :
230 : Returns `mem` (which will be properly formatted as a pack object) on
231 : success and NULL on failure. Logs details on failure. The caller
232 : will not be joined to the pack object when this function returns. */
233 : void *
234 : fd_pack_new( void * mem,
235 : ulong pack_depth,
236 : ulong bundle_meta_sz,
237 : ulong bank_tile_cnt,
238 : fd_pack_limits_t const * limits,
239 : fd_acct_addr_t const * acct_blocklist,
240 : ulong acct_blocklist_cnt,
241 : fd_rng_t * rng );
242 :
243 : /* fd_pack_join joins the caller to the pack object. Every successful
244 : join should have a matching leave. Returns mem. */
245 : fd_pack_t * fd_pack_join( void * mem );
246 :
247 :
248 : /* fd_pack_avail_txn_cnt returns the number of transactions that this
249 : pack object has available to schedule but that have not been
250 : scheduled yet. pack must be a valid local join. The return value
251 : will be in [0, pack_depth). */
252 :
253 : /* For performance reasons, implement this here. The offset is STATIC_ASSERTed
254 : in fd_pack.c. */
255 0 : #define FD_PACK_PENDING_TXN_CNT_OFF 80
256 : FD_FN_PURE static inline ulong
257 0 : fd_pack_avail_txn_cnt( fd_pack_t const * pack ) {
258 0 : return *((ulong const *)((uchar const *)pack + FD_PACK_PENDING_TXN_CNT_OFF));
259 0 : }
260 :
261 : /* fd_pack_current_block_cost returns the number of CUs that have been
262 : scheduled in the current block, net of any rebates. It should be
263 : between 0 and the specified value of max_cost_per_block, but it can
264 : be slightly higher due to temporary cost model nonsense. Due to
265 : rebates, this number may decrease as the block progresses. pack must
266 : be a valid local join. */
267 : FD_FN_PURE ulong fd_pack_current_block_cost( fd_pack_t const * pack );
268 :
269 : /* fd_pack_bank_tile_cnt: returns the value of bank_tile_cnt provided in
270 : pack when the pack object was initialized with fd_pack_new. pack
271 : must be a valid local join. The result will be in [1,
272 : FD_PACK_MAX_BANK_TILES]. */
273 : FD_FN_PURE ulong fd_pack_bank_tile_cnt( fd_pack_t const * pack );
274 :
275 : /* fd_pack_set_block_limits: Updates the limits provided fd_pack_new to
276 : these new values. Any future microblocks produced by this pack
277 : object will not cause a block to have more than
278 : limits->max_microblocks_per_block non-empty microblocks or more than
279 : limits->max_data_bytes_per_block data bytes (counting microblock
280 : headers as before). future microblocks will also exclude those that
281 : cause the total block cost to exceed limits->max_cost_per_block.
282 : Similarly those that cause the total vote-only cost to exceed
283 : limits->max_vote_cost_per_block. Also, those that cause the total
284 : per-account, per block write cost to exceed
285 : limits->max_write_cost_per_acct. Note that
286 : limits->max_txn_per_microblock is ignored. Limits are inclusive, as
287 : per usual (i.e. a block may have exactly max_microblocks_per_block
288 : microblocks, but not more). pack must be a valid local join.
289 :
290 : These limits must be no larger than the limits provided in
291 : fd_pack_new.
292 :
293 : The typical place to call this is immediately after
294 : fd_pack_end_block; if this is called after some microblocks have been
295 : produced for the current block, and the current block already exceeds
296 : the limits, all the remaining microblocks in the block will be empty,
297 : but the call is valid. */
298 : void fd_pack_set_block_limits( fd_pack_t * pack, fd_pack_limits_t const * limits );
299 :
300 : /* fd_pack_get_block_limits: Copies the currently active pack limits
301 : into opt_limits, if opt_limits is not NULL. Copies the current limit
302 : utilization in opt_limits_usage, if opt_limits_usage is not NULL.
303 :
304 : Limit utilization is updated both when each transactions is scheduled
305 : and when any used resources are rebated.
306 :
307 : The opt_limits_usage->top_writers field is ignored. */
308 : void fd_pack_get_block_limits( fd_pack_t * pack, fd_pack_limits_usage_t * opt_limits_usage, fd_pack_limits_t * opt_limits );
309 :
310 : /* fd_pack_get_top_writers copies the top FD_PACK_TOP_WRITERS_CNT by
311 : writer cost writers into top_writers. The copied elements will be
312 : sorted by writer cost in descending order.
313 :
314 : This should be called at the end of the relevant leader slot right
315 : after fd_pack_end_block, otherwise the copied data will be stale. */
316 : void fd_pack_get_top_writers( fd_pack_t const * pack, fd_pack_addr_use_t top_writers[static FD_PACK_TOP_WRITERS_CNT] );
317 :
318 : /* Copies the currently smallest pending,
319 : non-conflicting, non-vote transaction into opt_pending_smallest iff
320 : it is not NULL and the smallest pending vote into opt_vote_smallest
321 : iff it is not NULL. These values are updates any time a new
322 : transaction is inserted into the pending treap, or moved from another
323 : treap into the pending treap. */
324 : void fd_pack_get_pending_smallest( fd_pack_t * pack, fd_pack_smallest_t * opt_pending_smallest, fd_pack_smallest_t * opt_votes_smallest );
325 :
326 : /* Return values for fd_pack_insert_txn_fini: Non-negative values
327 : indicate the transaction was accepted and may be returned in a future
328 : microblock. Negative values indicate that the transaction was
329 : rejected and will never be returned in a future microblock.
330 : Transactions can be rejected through no fault of their own, so it
331 : doesn't necessarily imply bad behavior.
332 :
333 : The non-negative (success) codes are essentially a bitflag of three
334 : bits:
335 : * (1) whether the transaction met the criteria for a simple vote or
336 : not,
337 : * (2) whether this transaction replaced a previously accepted, low
338 : priority transaction, rather than being accepted in addition to
339 : all the previously accepted transactions.
340 : * (4) whether this transaction is a durable nonce transaction
341 :
342 : Since pack maintains a heap with a fixed max size of pack_depth,
343 : replacing transaction is necessary whenever the heap is full.
344 : Additionally, only one transaction with a given (nonce account, nonce
345 : authority, recent blockhash) value is allowed in pack's heap at a
346 : time, which means if there's already a lower priority transaction
347 : with the same nonce info, then this transaction will replace it.
348 : When the heap is full, and a nonce transaction is inserted, these
349 : return values don't allow you to disambiguate whether the replaced
350 : transaction had the same nonce info or not.
351 :
352 : Vote and durable nonce transactions are mutually exclusive.
353 :
354 : The negative (failure) codes are a normal enumeration (not a
355 : bitflag).
356 : * PRIORITY: pack's heap was full and the transaction's priority was
357 : lower than the worst currently accepted transaction.
358 : * NONCE_PRIORITY: pack's heap had a transaction with the same
359 : durable nonce info that was higher priority.
360 : * DUPLICATE: the transaction is a duplicate of a currently accepted
361 : transaction.
362 : * UNAFFORDABLE: the fee payer could not afford the transaction fee
363 : (not yet implemented).
364 : * ADDR_LUT: the transaction tried to load an account from an address
365 : lookup table, which is not yet supported.
366 : * EXPIRED: the transaction was already expired upon insertion based
367 : on the provided value of expires_at compared to the last call to
368 : fd_pack_expire_before.
369 : * TOO_LARGE: the transaction requested too many CUs and would never
370 : be scheduled if it had been accepted.
371 : * ACCOUNT_CNT: the transaction tried to load more than 64 account
372 : addresses.
373 : * DUPLICATE_ACCT: the transaction included an account address twice
374 : in its list of account addresses to load.
375 : * ESTIMATION_FAIL: estimation of the transaction's compute cost and
376 : fee failed, typically because the transaction contained a
377 : malformed ComputeBudgetProgram instruction.
378 : * WRITES_SYSVAR: the transaction attempts to write-lock a sysvar.
379 : Write-locking a sysvar can cause heavy contention. Agave
380 : solves this by downgrading these to read locks, but we instead
381 : solve it by refusing to pack such transactions.
382 : * INVALID_NONCE: the transaction looks like a durable nonce
383 : transaction, but the nonce authority did not sign the transaction.
384 : * BUNDLE_BLACKLIST: bundles are enabled and the transaction uses an
385 : account in the bundle blacklist, or the bundle contains a vote.
386 : * ACCT_BLOCKLIST: the transaction included an account address in the
387 : account blocklist.
388 : * NONCE_CONFLICT: bundle with two transactions that attempt to lock
389 : the exact same durable nonce (nonce account, authority, and block
390 : hash).
391 : * INSTR_ACCT_CNT: the transaction includes an instruction that
392 : references too many accounts.
393 :
394 : NOTE: The corresponding enum in metrics.xml must be kept in sync
395 : with any changes to these return values. */
396 : #define FD_PACK_INSERT_ACCEPT_NONCE_NONVOTE_REPLACE ( 6)
397 : #define FD_PACK_INSERT_ACCEPT_NONCE_NONVOTE_ADD ( 4)
398 : #define FD_PACK_INSERT_ACCEPT_VOTE_REPLACE ( 3)
399 : #define FD_PACK_INSERT_ACCEPT_NONVOTE_REPLACE ( 2)
400 : #define FD_PACK_INSERT_ACCEPT_VOTE_ADD ( 1)
401 : #define FD_PACK_INSERT_ACCEPT_NONVOTE_ADD ( 0)
402 0 : #define FD_PACK_INSERT_REJECT_PRIORITY ( -1)
403 0 : #define FD_PACK_INSERT_REJECT_NONCE_PRIORITY ( -2)
404 : #define FD_PACK_INSERT_REJECT_DUPLICATE ( -3)
405 0 : #define FD_PACK_INSERT_REJECT_UNAFFORDABLE ( -4)
406 : #define FD_PACK_INSERT_REJECT_ADDR_LUT ( -5)
407 0 : #define FD_PACK_INSERT_REJECT_EXPIRED ( -6)
408 0 : #define FD_PACK_INSERT_REJECT_TOO_LARGE ( -7)
409 0 : #define FD_PACK_INSERT_REJECT_ACCOUNT_CNT ( -8)
410 0 : #define FD_PACK_INSERT_REJECT_DUPLICATE_ACCT ( -9)
411 0 : #define FD_PACK_INSERT_REJECT_ESTIMATION_FAIL (-10)
412 0 : #define FD_PACK_INSERT_REJECT_WRITES_SYSVAR (-11)
413 0 : #define FD_PACK_INSERT_REJECT_INVALID_NONCE (-12)
414 0 : #define FD_PACK_INSERT_REJECT_BUNDLE_BLACKLIST (-13)
415 0 : #define FD_PACK_INSERT_REJECT_ACCT_BLOCKLIST (-14)
416 0 : #define FD_PACK_INSERT_REJECT_NONCE_CONFLICT (-15)
417 : #define FD_PACK_INSERT_REJECT_INSTR_ACCT_CNT (-16)
418 :
419 : /* The FD_PACK_INSERT_{ACCEPT, REJECT}_* values defined above are in the
420 : range [-FD_PACK_INSERT_RETVAL_OFF,
421 : -FD_PACK_INSERT_RETVAL_OFF+FD_PACK_INSERT_RETVAL_CNT ) */
422 0 : #define FD_PACK_INSERT_RETVAL_OFF 16
423 0 : #define FD_PACK_INSERT_RETVAL_CNT 23
424 :
425 : FD_STATIC_ASSERT( FD_PACK_INSERT_REJECT_INSTR_ACCT_CNT>=-FD_PACK_INSERT_RETVAL_OFF, pack_retval );
426 : FD_STATIC_ASSERT( FD_PACK_INSERT_ACCEPT_NONCE_NONVOTE_REPLACE<FD_PACK_INSERT_RETVAL_CNT-FD_PACK_INSERT_RETVAL_OFF, pack_retval );
427 :
428 : /* fd_pack_insert_txn_{init,fini,cancel} execute the process of
429 : inserting a new transaction into the pool of available transactions
430 : that may be scheduled by the pack object.
431 :
432 : fd_pack_insert_txn_init returns a piece of memory from the txnmem
433 : region where the transaction should be stored. The lifetime of this
434 : memory is managed by fd_pack as explained below.
435 :
436 : Every call to fd_pack_insert_init must be paired with a call to
437 : exactly one of _fini or _cancel. Calling fd_pack_insert_txn_fini
438 : finalizes the transaction insert process and makes the newly-inserted
439 : transaction available for scheduling. Calling
440 : fd_pack_insert_txn_cancel aborts the transaction insertion process.
441 : The txn pointer passed to _fini or _cancel must come from the most
442 : recent call to _init.
443 :
444 : The caller of these methods should not retain any read or write
445 : interest in the transaction after _fini or _cancel have been called.
446 :
447 : expires_at (for _fini only) bounds the lifetime of the inserted
448 : transaction. No particular unit is prescribed, and it need not be
449 : higher than the previous call to txn_fini. For durable nonce
450 : transactions and non-durable nonce transactions, it is interpreted
451 : somewhat differently. For normal (non-durable nonce) transactions,
452 : if fd_pack_expire_before has been previously called with a value
453 : larger (strictly) than the provided expires_at, the transaction will
454 : be rejected with EXPIRED. See fd_pack_expire_before for more
455 : details. The Solana protocol doesn't subject durable nonce
456 : transactions to the same expiration process, however pack gives them
457 : a synthetic expires_at of FD_PACK_NONCE_SYNTHETIC_LIFETIME larger
458 : than largest value with which fd_pack_expire_before has been
459 : previously called. Instead, the expires_at value for durable nonce
460 : transactions is primarily used as an ordering key: pack only keeps
461 : the transaction with the highest expires_at value for a given (nonce,
462 : nonce authority) tuple.
463 :
464 : pack must be a local join of a pack object. From the caller's
465 : perspective, these functions cannot fail, though pack may reject a
466 : transaction for a variety of reasons. fd_pack_insert_txn_fini
467 : returns one of the FD_PACK_INSERT_ACCEPT_* or FD_PACK_INSERT_REJECT_*
468 : codes explained above.
469 : */
470 : fd_txn_e_t * fd_pack_insert_txn_init ( fd_pack_t * pack );
471 : int fd_pack_insert_txn_fini ( fd_pack_t * pack, fd_txn_e_t * txn, ulong expires_at, ulong * delete_cnt );
472 : void fd_pack_insert_txn_cancel( fd_pack_t * pack, fd_txn_e_t * txn );
473 :
474 : /* fd_pack_insert_bundle_{init,fini,cancel} are parallel to the
475 : similarly named fd_pack_insert_txn functions but can be used to
476 : insert a bundle instead of a transaction.
477 :
478 : fd_pack_insert_bundle_init populates and returns bundle.
479 : Specifically, it populates bundle[0], ... bundle[txn_cnt-1] with
480 : pointers to fd_txn_p_t structs that should receive a new transaction.
481 : The pointers themselves should not be changed which is what the const
482 : indicates, but the contents of the fd_txn_p_t structs must be changed
483 : in order for this to be useful. bundle must be a pointer to the
484 : first element of an array of at least txn_cnt pointers.
485 :
486 : The bundle consists of the transactions in the order they are
487 : provided. I.e. bundle[0] will execute first in the bundle.
488 :
489 : Like with insert_txn, every call to fd_pack_insert_bundle_init must
490 : be paired with a call to exactly one of _fini or _cancel. Calling
491 : fd_pack_insert_bundle_fini finalizes the bundle insertion process and
492 : makes the newly-inserted bundle available for scheduling. Calling
493 : fd_pack_insert_bundle_cancel aborts the transaction insertion
494 : process. There can be at most two outstanding bundles, of which one
495 : should be an initializer bundle. The bundle argument passed to _fini
496 : or _cancel must be the return value of a call to _init with the same
497 : value of txn_cnt. Additionally, it is okay to interleave calls to
498 : the insert_txn family of functions with calls to the insert_bundle
499 : family of functions.
500 :
501 : The caller of these methods should not retain any read or write
502 : interest in the fd_txn_p_t structs that the entries of bundle
503 : point to after _fini or _cancel have been called.
504 :
505 : expires_at has the same meaning as above. Although transactions in
506 : the bundle may have different recent blockhashes, all transactions in
507 : the bundle have the same expires_at value, which should be that of
508 : the oldest, since if one expires, the whole bundle becomes invalid.
509 : The alternative interpretation of expires_at for durable nonce
510 : transactions means that they should be excluded in the calculation of
511 : the oldest.
512 :
513 : Bundles containing durable nonce transactions are always treated as
514 : having a newer nonce than any non-bundle transaction with the same
515 : (nonce account, authority) pair. Within bundles, the older bundle is
516 : always treated as having a newer nonce (slightly counter-intuitively,
517 : but keeping in line with the bundle FIFO policy).
518 :
519 : If initializer_bundle is non-zero, this bundle will be inserted at
520 : the front of the bundle queue so that it is the next bundle
521 : scheduled. Otherwise, the bundle will be inserted at the back of the
522 : bundle queue, and will be scheduled in FIFO order with the rest of
523 : the bundles. If an initializer bundle is already present in pack's
524 : pending transactions, that bundle will be deleted. Additionally, if
525 : initializer_bundle is non-zero, the transactions in the bundle will
526 : not be checked against the bundle blacklist; otherwise, the check
527 : will be performed as normal. See the section below on initializer
528 : bundles for more details.
529 :
530 : Other than the blacklist check, transactions in a bundle are subject
531 : to the same checks as other transactions. If any transaction in the
532 : bundle fails validation, the whole bundle will be rejected.
533 :
534 : _fini also accepts bundle_meta, an optional opaque pointer to a
535 : region of memory of size bundle_meta_sz (as provided in pack_new).
536 : If bundle_meta is non-NULL, the contents of the memory will be copied
537 : to a metadata region associated with this bundle and can be retrieved
538 : later with fd_pack_peek_bundle_meta. The contents of bundle_meta is
539 : not retrievable if initializer_bundle is non-zero, so you may wish to
540 : just pass NULL in that case. This function does not retain any
541 : interest in the contents of bundle_meta after it returns.
542 :
543 : txn_cnt must be in [1, MAX_TXN_PER_BUNDLE]. A txn_cnt of 1 inserts a
544 : single-transaction bundle which is transaction with extremely high
545 : priority. That said, inserting transactions as bundles instead of
546 : transactions can hurt performance and throughput by introducing
547 : unnecessary stalls.
548 :
549 : fd_pack_insert_bundle_fini returns one of the FD_PACK_INSERT_ACCEPT_*
550 : or FD_PACK_INSERT_REJECT_* codes explained above. If there are
551 : multiple reasons for rejecting a bundle, the which of the reasons it
552 : returns is unspecified. delete_cnt is the number of existing
553 : transactions that were deleted as a side effect of insertion.
554 :
555 : These functions must not be called if the pack object was initialized
556 : with bundle_meta_sz==0. */
557 :
558 : fd_txn_e_t * const * fd_pack_insert_bundle_init ( fd_pack_t * pack, fd_txn_e_t * * bundle, ulong txn_cnt );
559 : int fd_pack_insert_bundle_fini ( fd_pack_t * pack, fd_txn_e_t * const * bundle, ulong txn_cnt,
560 : ulong expires_at, int initializer_bundle, void const * bundle_meta, ulong * delete_cnt );
561 : void fd_pack_insert_bundle_cancel( fd_pack_t * pack, fd_txn_e_t * const * bundle, ulong txn_cnt );
562 :
563 :
564 : /* =========== More details about initializer bundles ===============
565 : Initializer bundles are a special type of bundle with special support
566 : from the pack object to facilitate preparing on-chain state for the
567 : execution of bundles by this validator. This design is a bit
568 : complicated, but it eliminates excessive coupling between pack and
569 : block engine details.
570 :
571 : The pack object maintains a small state machine (initializer bundle
572 : abbreviated IB):
573 :
574 : [Not Initialized] ------------------------->|
575 : ^ | Schedule an
576 : | End Rebate shows | IB
577 : | block IB failed |
578 : |<----------[Failed]--------------| v
579 : | --===[Pending]
580 : |<------------------------------/ ^ |
581 : | End block /---| |
582 : | | | Rebate shows
583 : | Schedule | | IB succeeded
584 : | another IB | |
585 : | End block | V
586 : -----------------------------------===[Ready]
587 :
588 :
589 : When attempting to schedule a bundle the pack object checks the
590 : state, and employs the following rules:
591 : * [Not Initialized]: If the top bundle is an IB, schedule it,
592 : removing it like normal, then transition to [Pending]. Otherwise,
593 : do not schedule a bundle.
594 : * [Pending]: Do not schedule a bundle.
595 : * [Failed]: Do not schedule a bundle
596 : * [Ready]: Attempt to schedule the next bundle. If scheduling an IB,
597 : transition to [Pending].
598 :
599 : As described in the state machine, ending the block (via
600 : fd_pack_end_block) transitions to [Not Initialized], and calls to
601 : fd_pack_rebate_cus control the transition out of [Pending].
602 :
603 : This design supports a typical block engine system where some state
604 : may need to be initialized at the start of the slot and some state
605 : may need to change between runs of transactions (e.g. 5 transactions
606 : from block builder A followed by 5 transactions from block builder
607 : B). This can be done by inserting an initializer bundle whenever the
608 : top non-initializer bundle's metadata state (retrievable with
609 : fd_pack_peek_bundle_meta) doesn't match the current on-chain state.
610 : Since the initializer bundle will execute before the bundle that was
611 : previously the top one, by the time the non-initializer bundle
612 : executes, the on-chain state will be correctly configured. In this
613 : scheme, in the rare case that an initializer bundle was inserted but
614 : never executed, it should be deleted at the end of the slot.
615 :
616 : If at the start of the slot, it is determined that the on-chain state
617 : is in good shape, the state machine can transition directly to
618 : [Ready] by calling fd_pack_set_initializer_bundles_ready.
619 :
620 : Initializer bundles are not exempt from expiration, but it should not
621 : be a problem if they are always inserted with the most recent
622 : blockhash and deleted at the end of the slot.
623 :
624 : Additionally, a bundle marked as an IB is exempted from the bundle
625 : account blacklist checks. For this reason, it's important that IB be
626 : generated by trusted code with minimal or sanitized
627 : attacker-controlled input. */
628 :
629 :
630 : /* fd_pack_peek_bundle_meta returns a constant pointer to the bundle
631 : metadata associated with the bundle currently in line to be scheduled
632 : next, or NULL in any of the following cases:
633 : * There are no bundles
634 : * The bundle currently in line to be scheduled next is an IB
635 : * The bundle state is currently [Pending] or [Failed].
636 :
637 : The lifetime of the returned pointer is until the next pack insert,
638 : schedule, delete, or expire call. The size of the region pointed to
639 : by the returned pointer is bundle_meta_sz. If this bundle was
640 : inserted with bundle_meta==NULL, then the contents of the region
641 : pointed to by the returned pointer are arbitrary, but it will be safe
642 : to read.
643 :
644 : Pack doesn't do anything special to ensure the returned pointer
645 : points to memory with any particular alignment. It will naturally
646 : have an alignment of at least GCD( 64, bundle_meta_sz ). */
647 : void const * fd_pack_peek_bundle_meta( fd_pack_t const * pack );
648 :
649 : /* fd_pack_set_initializer_bundles_ready sets the IB state machine state
650 : (see long initializer bundle comment above) to the [Ready] state.
651 : This function makes it easy to use bundles without initializer
652 : bundles. pack must be a valid local join. */
653 : void fd_pack_set_initializer_bundles_ready( fd_pack_t * pack );
654 :
655 :
656 : /* FD_PACK_SCHEDULE_{VOTE,BUNDLE,TXN} form a set of bitflags used in
657 : fd_pack_schedule_next_microblock below. They control what types of
658 : scheduling are allowed. The names should be self-explanatory. */
659 0 : #define FD_PACK_SCHEDULE_VOTE 1
660 0 : #define FD_PACK_SCHEDULE_BUNDLE 2
661 0 : #define FD_PACK_SCHEDULE_TXN 4
662 :
663 : /* fd_pack_schedule_next_microblock schedules pending transactions.
664 : These transaction either form a microblock, which is a set of
665 : non-conflicting transactions, or a bundle. The semantics of this
666 : function are a bit different depending on which one it picks, but
667 : there are some reasons why they both use this function.
668 :
669 : For both codepaths, pack must be a local join of a pack object.
670 : schedule_flags must be a bitwise combination of the
671 : FD_PACK_SCHEDULE_* values defined above. When the bit is set
672 : corresponding to a transaction type, this function will consider
673 : scheduling transactions of that type. Passing 0 for schedule_flags
674 : is a no-op. The full policy is as follows:
675 : 1. If the VOTE bit is set, attempt to schedule votes. This is the
676 : microblock case.
677 : 2. If the BUNDLE bit is set, and step 1 did not schedule any votes,
678 : attempt to schedule bundles. This is the bundle case.
679 : 3. If the TXN bit is set, and step 2 did not schedule any bundles
680 : for a reason other than account conflicts, attempt to schedule
681 : normal transactions. This is the microblock case.
682 : Note that it is possible to schedule a microblock containing both
683 : votes and normal transactions, but bundles cannot be combined with
684 : either other type. Additionally, if the BUNDLE bit is not set, step
685 : 2 will not schedule any bundles for that reason, which is a reason
686 : other than account conflicts, so that clause will always be
687 : satisfied.
688 :
689 : Microblock case:
690 : Transactions part of the scheduled microblock are copied to out in no
691 : particular order. The cumulative cost of these transactions will not
692 : exceed total_cus, and the number of transactions will not exceed the
693 : value of max_txn_per_microblock given in fd_pack_new.
694 :
695 : The block will not contain more than
696 : vote_fraction*max_txn_per_microblock votes, and votes in total will
697 : not consume more than vote_fraction*total_cus of the microblock.
698 :
699 : Bundle case:
700 : Transactions part of the scheduled bundled are copied in execution
701 : order (i.e. out[0] must be executed first). The number of
702 : transactions will not exceed FD_PACK_MAX_TXN_PER_BUNDLE.
703 : max_txn_per_microblock, total_cus, and vote_fraction are ignored,
704 : though the block-level limits are respected.
705 :
706 : Both cases:
707 : The non_execution_cus and requested_exec_plus_acct_data_cus fields of
708 : each transaction will be populated with the non execution CUs and
709 : requested execution CUs (including cus derived from the requested
710 : loaded accounts data size), respectively. The sum of these two
711 : values is the total cost of the transaction, i.e. what is used for
712 : all limits, including the total_cus value. The lower 3 bits of the
713 : flags field will be populated (simple vote, bundle, initializer
714 : bundle). Inspecting these flags is the proper way to tell which
715 : codepath executed.
716 :
717 : Returns the number of transactions in the scheduled microblock or
718 : bundle. The return value may be 0 if there are no eligible
719 : transactions at the moment. */
720 :
721 : ulong
722 : fd_pack_schedule_next_microblock( fd_pack_t * pack,
723 : ulong total_cus,
724 : float vote_fraction,
725 : ulong bank_tile,
726 : int schedule_flags,
727 : fd_txn_e_t * out );
728 :
729 :
730 : /* fd_pack_rebate_cus adjusts the compute unit accounting for the
731 : specified transactions to take into account the actual consumed CUs
732 : after execution. When a transaction is scheduled by
733 : schedule_next_microblock, pack assumes that it uses all the CUs it
734 : requests for the purposes of several CU limits. If it doesn't use
735 : all the requested CUs, this function "rebates" them to pack so that
736 : they can be consumed by a different transaction in the block.
737 :
738 : pack must be a valid local join of a pack object. rebate must point
739 : to a valid rebate report produced by fd_pack_rebate_sum_t.
740 :
741 : IMPORTANT: CU limits are reset at the end of each block, so this
742 : should not be called for transactions from a prior block.
743 : Specifically, there must not be a call to fd_pack_end_block between
744 : the call to schedule_next_microblock this is paired with and the call
745 : to rebate_cus.
746 :
747 : This function operates independently of microblock_complete. In
748 : general, you probably need to call both. microblock_complete must be
749 : called before scheduling another microblock to that bank tile, while
750 : rebate_cus is optional and has much more relaxed ordering
751 : constraints. The restriction about intervening calls to end_block
752 : and that this must come after schedule_next_microblock are the only
753 : ordering constraints. */
754 : void fd_pack_rebate_cus( fd_pack_t * pack, fd_pack_rebate_t const * rebate );
755 :
756 : /* fd_pack_microblock_complete signals that the bank_tile with index
757 : bank_tile has completed its previously scheduled microblock. This
758 : permits the scheduling of transactions that conflict with the
759 : previously scheduled microblock. It is safe to call this multiple
760 : times after a microblock or even if bank_tile does not have a
761 : previously scheduled; in this case, the function will return 0 and
762 : act as a no-op. Returns 1 if the bank_tile had an outstanding,
763 : previously scheduled microblock to mark as completed. */
764 : int fd_pack_microblock_complete( fd_pack_t * pack, ulong bank_tile );
765 :
766 : /* fd_pack_expire_before deletes all available transactions with
767 : expires_at values strictly less than expire_before. For durable
768 : nonce transactions, this considers the synthetic expiration value as
769 : explained in insert_txn_fini. pack must be a local join of a pack
770 : object. Returns the number of transactions deleted. Subsequent
771 : calls to fd_pack_expire_before with the same or a smaller value are
772 : no-ops. */
773 : ulong fd_pack_expire_before( fd_pack_t * pack, ulong expire_before );
774 :
775 : /* fd_pack_delete_txn removes a transaction (identified by its first
776 : signature) from the pool of available transactions. Returns a
777 : nonzero count of the number of transactions deleted, if the
778 : transaction was found (and then removed) and 0 if not. The count
779 : might be >1 if a bundle was caused to be deleted. */
780 : ulong fd_pack_delete_transaction( fd_pack_t * pack, fd_ed25519_sig_t const * sig0 );
781 :
782 : /* fd_pack_end_block resets some state to prepare for the next block.
783 : Specifically, the per-block limits are cleared and transactions in
784 : the microblocks scheduled after the call to this function are allowed
785 : to conflict with transactions in microblocks scheduled before the
786 : call to this function, even within gap microblocks. */
787 : void fd_pack_end_block( fd_pack_t * pack );
788 :
789 :
790 : /* fd_pack_clear_all resets the state associated with this pack object.
791 : All pending transactions are removed from the pool of available
792 : transactions and all limits are reset. */
793 : void fd_pack_clear_all( fd_pack_t * pack );
794 :
795 :
796 : /* fd_pack_metrics_write writes period metric values to the metrics
797 : system. pack must be a valid local join. */
798 : void
799 : fd_pack_metrics_write( fd_pack_t const * pack );
800 :
801 : /* fd_pack_get_sched_metrics: copies the current
802 : FD_METRICS_ENUM_PACK_TXN_SCHEDULE_RESULT_CNT counters to metrics */
803 : void
804 : fd_pack_get_sched_metrics( fd_pack_t const * pack, ulong * metrics );
805 :
806 : /* fd_pack_leave leaves a local join of a pack object. Returns pack. */
807 : void * fd_pack_leave( fd_pack_t * pack );
808 : /* fd_pack_delete unformats a memory region used to store a pack object
809 : and returns ownership of the memory to the caller. Returns mem. */
810 : void * fd_pack_delete( void * mem );
811 :
812 : /* fd_pack_verify (for debugging use primarily) checks to ensure several
813 : invariants are satisfied. scratch must point to the first byte of a
814 : piece of memory meeting the same alignment and footprint constraints
815 : as pack. Returns 0 on success and a negative value on failure
816 : (logging a warning with details). */
817 : int fd_pack_verify( fd_pack_t * pack, void * scratch );
818 :
819 : FD_PROTOTYPES_END
820 :
821 : #endif /* HEADER_fd_src_disco_pack_fd_pack_h */
|
