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