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