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