Line data Source code
1 : #include "fd_builtin_programs.h"
2 : #include "fd_precompiles.h"
3 : #include "../fd_system_ids.h"
4 : #include "../fd_system_ids_pp.h"
5 : #include "../../accdb/fd_accdb_sync.h"
6 :
7 : #define BUILTIN_PROGRAM(program_id, name, feature_offset, migration_config) \
8 : { \
9 : program_id, \
10 : name, \
11 : feature_offset, \
12 : migration_config \
13 : }
14 :
15 : #define STATELESS_BUILTIN(program_id, migration_config) \
16 : { \
17 : program_id, \
18 : migration_config \
19 : }
20 :
21 : #define CORE_BPF_MIGRATION_CONFIG(source_buffer_address, upgrade_authority_address, enable_feature_offset, builtin_program_id) \
22 : { \
23 : source_buffer_address, \
24 : upgrade_authority_address, \
25 : enable_feature_offset, \
26 : builtin_program_id \
27 : }
28 :
29 : #define PRECOMPILE(program_id, feature_offset, verify_fn) \
30 : { \
31 : program_id, \
32 : feature_offset, \
33 : verify_fn \
34 : }
35 :
36 : /* Core BPF migration configs */
37 : static const fd_core_bpf_migration_config_t BUILTIN_TO_CORE_BPF_STAKE_PROGRAM_CONFIG = {
38 : &fd_solana_stake_program_buffer_address,
39 : NULL,
40 : offsetof(fd_features_t, migrate_stake_program_to_core_bpf),
41 : FD_CORE_BPF_MIGRATION_TARGET_BUILTIN,
42 : &fd_solana_stake_program_id,
43 : NULL
44 : };
45 : static const fd_core_bpf_migration_config_t * const MIGRATE_BUILTIN_TO_CORE_BPF_STAKE_PROGRAM_CONFIG = &BUILTIN_TO_CORE_BPF_STAKE_PROGRAM_CONFIG;
46 :
47 : static const fd_core_bpf_migration_config_t BUILTIN_TO_CORE_BPF_CONFIG_PROGRAM_CONFIG = {
48 : &fd_solana_config_program_buffer_address,
49 : NULL,
50 : offsetof(fd_features_t, migrate_config_program_to_core_bpf),
51 : FD_CORE_BPF_MIGRATION_TARGET_BUILTIN,
52 : &fd_solana_config_program_id,
53 : NULL
54 : };
55 : static const fd_core_bpf_migration_config_t * const MIGRATE_BUILTIN_TO_CORE_BPF_CONFIG_PROGRAM_CONFIG = &BUILTIN_TO_CORE_BPF_CONFIG_PROGRAM_CONFIG;
56 :
57 : static const fd_core_bpf_migration_config_t BUILTIN_TO_CORE_BPF_ADDRESS_LOOKUP_TABLE_PROGRAM_CONFIG = {
58 : &fd_solana_address_lookup_table_program_buffer_address,
59 : NULL,
60 : offsetof(fd_features_t, migrate_address_lookup_table_program_to_core_bpf),
61 : FD_CORE_BPF_MIGRATION_TARGET_BUILTIN,
62 : &fd_solana_address_lookup_table_program_id,
63 : NULL
64 : };
65 : static const fd_core_bpf_migration_config_t * const MIGRATE_BUILTIN_TO_CORE_BPF_ADDRESS_LOOKUP_TABLE_PROGRAM_CONFIG = &BUILTIN_TO_CORE_BPF_ADDRESS_LOOKUP_TABLE_PROGRAM_CONFIG;
66 :
67 : static const fd_core_bpf_migration_config_t STATELESS_TO_CORE_BPF_FEATURE_GATE_PROGRAM_CONFIG = {
68 : &fd_solana_feature_program_buffer_address,
69 : NULL,
70 : offsetof(fd_features_t, migrate_feature_gate_program_to_core_bpf),
71 : FD_CORE_BPF_MIGRATION_TARGET_STATELESS,
72 : &fd_solana_feature_program_id,
73 : NULL
74 : };
75 : static const fd_core_bpf_migration_config_t * const MIGRATE_STATELESS_TO_CORE_BPF_FEATURE_GATE_PROGRAM_CONFIG = &STATELESS_TO_CORE_BPF_FEATURE_GATE_PROGRAM_CONFIG;
76 :
77 : /* 192ed727334abe822d5accba8b886e25f88b03c76973c2e7290cfb55b9e1115f */
78 : #define SLASHING_PROG_HASH_SIMD_204 0x19U,0x2eU,0xd7U,0x27U,0x33U,0x4aU,0xbeU,0x82U,0x2dU,0x5aU,0xccU,0xbaU,0x8bU,0x88U,0x6eU,0x25U, \
79 : 0xf8U,0x8bU,0x03U,0xc7U,0x69U,0x73U,0xc2U,0xe7U,0x29U,0x0cU,0xfbU,0x55U,0xb9U,0xe1U,0x11U,0x5fU
80 : const fd_hash_t fd_solana_slashing_program_verified_build_hash_simd_204 = { .uc = { SLASHING_PROG_HASH_SIMD_204 } };
81 : static const fd_core_bpf_migration_config_t STATELESS_TO_CORE_BPF_SLASHING_PROGRAM_CONFIG = {
82 : &fd_solana_slashing_program_buffer_address,
83 : NULL,
84 : offsetof(fd_features_t, enshrine_slashing_program),
85 : FD_CORE_BPF_MIGRATION_TARGET_STATELESS,
86 : &fd_solana_slashing_program_id,
87 : &fd_solana_slashing_program_verified_build_hash_simd_204
88 : };
89 : static const fd_core_bpf_migration_config_t * const MIGRATE_STATELESS_TO_CORE_BPF_SLASHING_PROGRAM_CONFIG = &STATELESS_TO_CORE_BPF_SLASHING_PROGRAM_CONFIG;
90 :
91 : #define SYSTEM_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_system_program_id, "system_program", NO_ENABLE_FEATURE_ID, NULL)
92 : #define VOTE_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_vote_program_id, "vote_program", NO_ENABLE_FEATURE_ID, NULL)
93 : #define STAKE_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_stake_program_id, "stake_program", NO_ENABLE_FEATURE_ID, MIGRATE_BUILTIN_TO_CORE_BPF_STAKE_PROGRAM_CONFIG)
94 : #define CONFIG_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_config_program_id, "config_program", NO_ENABLE_FEATURE_ID, MIGRATE_BUILTIN_TO_CORE_BPF_CONFIG_PROGRAM_CONFIG)
95 : #define LOADER_V4_BUILTIN BUILTIN_PROGRAM(&fd_solana_bpf_loader_v4_program_id, "loader_v4", offsetof(fd_features_t, enable_loader_v4), NULL)
96 : #define ADDRESS_LOOKUP_TABLE_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_address_lookup_table_program_id, "address_lookup_table_program", NO_ENABLE_FEATURE_ID, MIGRATE_BUILTIN_TO_CORE_BPF_ADDRESS_LOOKUP_TABLE_PROGRAM_CONFIG)
97 : #define BPF_LOADER_DEPRECATED_BUILTIN BUILTIN_PROGRAM(&fd_solana_bpf_loader_deprecated_program_id, "solana_bpf_loader_deprecated_program", NO_ENABLE_FEATURE_ID, NULL)
98 : #define BPF_LOADER_BUILTIN BUILTIN_PROGRAM(&fd_solana_bpf_loader_program_id, "solana_bpf_loader_program", NO_ENABLE_FEATURE_ID, NULL)
99 : #define BPF_LOADER_UPGRADEABLE_BUILTIN BUILTIN_PROGRAM(&fd_solana_bpf_loader_upgradeable_program_id, "solana_bpf_loader_upgradeable_program", NO_ENABLE_FEATURE_ID, NULL)
100 : #define COMPUTE_BUDGET_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_compute_budget_program_id, "compute_budget_program", NO_ENABLE_FEATURE_ID, NULL)
101 : #define ZK_TOKEN_PROOF_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_zk_token_proof_program_id, "zk_token_proof_program", offsetof(fd_features_t, zk_token_sdk_enabled), NULL)
102 : #define ZK_ELGAMAL_PROOF_PROGRAM_BUILTIN BUILTIN_PROGRAM(&fd_solana_zk_elgamal_proof_program_id, "zk_elgamal_proof_program", offsetof(fd_features_t, zk_elgamal_proof_program_enabled), NULL)
103 :
104 : #define FEATURE_PROGRAM_BUILTIN STATELESS_BUILTIN(&fd_solana_feature_program_id, MIGRATE_STATELESS_TO_CORE_BPF_FEATURE_GATE_PROGRAM_CONFIG)
105 : #define SLASHING_PROGRAM_BUILTIN STATELESS_BUILTIN(&fd_solana_slashing_program_id, MIGRATE_STATELESS_TO_CORE_BPF_SLASHING_PROGRAM_CONFIG)
106 :
107 : #define SECP256R1_PROGRAM_PRECOMPILE PRECOMPILE(&fd_solana_secp256r1_program_id, offsetof(fd_features_t, enable_secp256r1_precompile), fd_precompile_secp256r1_verify)
108 : #define KECCAK_SECP_PROGRAM_PRECOMPILE PRECOMPILE(&fd_solana_keccak_secp_256k_program_id, NO_ENABLE_FEATURE_ID, fd_precompile_secp256k1_verify)
109 : #define ED25519_SV_PROGRAM_PRECOMPILE PRECOMPILE(&fd_solana_ed25519_sig_verify_program_id, NO_ENABLE_FEATURE_ID, fd_precompile_ed25519_verify)
110 :
111 : /* https://github.com/anza-xyz/agave/blob/v2.1.0/runtime/src/bank/builtins/mod.rs#L133-L143 */
112 : static const fd_stateless_builtin_program_t stateless_programs_builtins[] = {
113 : FEATURE_PROGRAM_BUILTIN,
114 : SLASHING_PROGRAM_BUILTIN
115 : };
116 36 : #define STATELESS_BUILTINS_COUNT (sizeof(stateless_programs_builtins) / sizeof(fd_stateless_builtin_program_t))
117 :
118 : static const fd_precompile_program_t precompiles[] = {
119 : SECP256R1_PROGRAM_PRECOMPILE,
120 : KECCAK_SECP_PROGRAM_PRECOMPILE,
121 : ED25519_SV_PROGRAM_PRECOMPILE
122 : };
123 48 : #define PRECOMPILE_PROGRAMS_COUNT (sizeof(precompiles) / sizeof(fd_precompile_program_t))
124 :
125 : /* https://github.com/anza-xyz/agave/blob/v2.1.0/runtime/src/bank/builtins/mod.rs#L34-L131 */
126 : static fd_builtin_program_t const builtin_programs[] = {
127 : SYSTEM_PROGRAM_BUILTIN,
128 : VOTE_PROGRAM_BUILTIN,
129 : STAKE_PROGRAM_BUILTIN,
130 : CONFIG_PROGRAM_BUILTIN,
131 : LOADER_V4_BUILTIN,
132 : ADDRESS_LOOKUP_TABLE_PROGRAM_BUILTIN,
133 : BPF_LOADER_DEPRECATED_BUILTIN,
134 : BPF_LOADER_BUILTIN,
135 : BPF_LOADER_UPGRADEABLE_BUILTIN,
136 : COMPUTE_BUDGET_PROGRAM_BUILTIN,
137 : ZK_TOKEN_PROOF_PROGRAM_BUILTIN,
138 : ZK_ELGAMAL_PROOF_PROGRAM_BUILTIN
139 : };
140 234 : #define BUILTIN_PROGRAMS_COUNT (sizeof(builtin_programs) / sizeof(fd_builtin_program_t))
141 :
142 : /* Used by the compute budget program to determine how many CUs to deduct by default
143 : https://github.com/anza-xyz/agave/blob/v2.1.13/builtins-default-costs/src/lib.rs#L113-L139 */
144 : static fd_core_bpf_migration_config_t const * migrating_builtins[] = {
145 : MIGRATE_BUILTIN_TO_CORE_BPF_STAKE_PROGRAM_CONFIG,
146 : MIGRATE_BUILTIN_TO_CORE_BPF_CONFIG_PROGRAM_CONFIG,
147 : MIGRATE_BUILTIN_TO_CORE_BPF_ADDRESS_LOOKUP_TABLE_PROGRAM_CONFIG,
148 : };
149 120 : #define MIGRATING_BUILTINS_COUNT (sizeof(migrating_builtins) / sizeof(fd_core_bpf_migration_config_t const *))
150 :
151 : /* https://github.com/anza-xyz/agave/blob/v2.1.13/builtins-default-costs/src/lib.rs#L141-L193 */
152 : #define MAP_PERFECT_NAME fd_non_migrating_builtins_tbl
153 : #define MAP_PERFECT_LG_TBL_SZ 4
154 : #define MAP_PERFECT_T fd_pubkey_t
155 396 : #define MAP_PERFECT_HASH_C 146U
156 : #define MAP_PERFECT_KEY uc
157 : #define MAP_PERFECT_KEY_T fd_pubkey_t const *
158 : #define MAP_PERFECT_ZERO_KEY (0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0)
159 : #define MAP_PERFECT_COMPLEX_KEY 1
160 396 : #define MAP_PERFECT_KEYS_EQUAL(k1,k2) (!memcmp( (k1), (k2), 32UL ))
161 :
162 396 : #define PERFECT_HASH( u ) (((MAP_PERFECT_HASH_C*(u))>>28)&0x0FU)
163 :
164 : #define MAP_PERFECT_HASH_PP( a00,a01,a02,a03,a04,a05,a06,a07,a08,a09,a10,a11,a12,a13,a14,a15, \
165 : a16,a17,a18,a19,a20,a21,a22,a23,a24,a25,a26,a27,a28,a29,a30,a31) \
166 : PERFECT_HASH( (a08 | (a09<<8) | (a10<<16) | (a11<<24)) )
167 396 : #define MAP_PERFECT_HASH_R( ptr ) PERFECT_HASH( fd_uint_load_4( (uchar const *)ptr->uc + 8UL ) )
168 :
169 : #define MAP_PERFECT_0 ( VOTE_PROG_ID ),
170 : #define MAP_PERFECT_1 ( SYS_PROG_ID ),
171 : #define MAP_PERFECT_2 ( COMPUTE_BUDGET_PROG_ID ),
172 : #define MAP_PERFECT_3 ( BPF_UPGRADEABLE_PROG_ID ),
173 : #define MAP_PERFECT_4 ( BPF_LOADER_1_PROG_ID ),
174 : #define MAP_PERFECT_5 ( BPF_LOADER_2_PROG_ID ),
175 : #define MAP_PERFECT_6 ( LOADER_V4_PROG_ID ),
176 : #define MAP_PERFECT_7 ( KECCAK_SECP_PROG_ID ),
177 : #define MAP_PERFECT_8 ( ED25519_SV_PROG_ID ),
178 :
179 : #include "../../../util/tmpl/fd_map_perfect.c"
180 : #undef PERFECT_HASH
181 :
182 : // https://github.com/anza-xyz/agave/blob/v2.3.7/runtime/src/bank.rs#L4944
183 : static int
184 : fd_builtin_is_bpf( fd_accdb_user_t * accdb,
185 : fd_funk_txn_xid_t const * xid,
186 0 : fd_pubkey_t const * pubkey ) {
187 0 : fd_accdb_ro_t ro[1];
188 0 : if( !fd_accdb_open_ro( accdb, ro, xid, pubkey ) ) {
189 0 : return 0;
190 0 : }
191 0 : int is_bpf = memcmp( fd_accdb_ref_owner( ro ), &fd_solana_bpf_loader_upgradeable_program_id, sizeof(fd_solana_bpf_loader_upgradeable_program_id) )==0;
192 0 : fd_accdb_close_ro( accdb, ro );
193 0 : return is_bpf;
194 0 : }
195 :
196 :
197 : /* BuiltIn programs need "bogus" executable accounts to exist.
198 : These are loaded and ignored during execution.
199 :
200 : Bogus accounts are marked as "executable", but their data is a
201 : hardcoded ASCII string. */
202 :
203 : /* https://github.com/solana-labs/solana/blob/8f2c8b8388a495d2728909e30460aa40dcc5d733/sdk/src/native_loader.rs#L19 */
204 : void
205 : fd_write_builtin_account( fd_bank_t * bank,
206 : fd_accdb_user_t * accdb,
207 : fd_funk_txn_xid_t const * xid,
208 : fd_capture_ctx_t * capture_ctx,
209 : fd_pubkey_t const pubkey,
210 : char const * data,
211 72 : ulong sz ) {
212 :
213 72 : fd_accdb_rw_t rw[1];
214 72 : fd_accdb_open_rw( accdb, rw, xid, &pubkey, sz, FD_ACCDB_FLAG_CREATE );
215 :
216 72 : fd_lthash_value_t prev_hash[1];
217 72 : fd_hashes_account_lthash(
218 72 : &pubkey,
219 72 : rw->meta,
220 72 : fd_accdb_ref_data_const( rw->ro ),
221 72 : prev_hash );
222 :
223 72 : fd_accdb_ref_data_set( accdb, rw, data, sz );
224 72 : fd_accdb_ref_lamports_set( rw, 1UL );
225 72 : fd_accdb_ref_exec_bit_set( rw, 1 );
226 72 : fd_accdb_ref_owner_set( rw, &fd_solana_native_loader_id );
227 :
228 72 : fd_hashes_update_lthash( &pubkey, rw->meta, prev_hash, bank, capture_ctx );
229 72 : fd_bank_capitalization_set( bank, fd_bank_capitalization_get( bank ) + 1UL );
230 72 : fd_accdb_close_rw( accdb, rw );
231 72 : }
232 :
233 : void
234 : fd_builtin_programs_init( fd_bank_t * bank,
235 : fd_accdb_user_t * accdb,
236 : fd_funk_txn_xid_t const * xid,
237 6 : fd_capture_ctx_t * capture_ctx ) {
238 : /* https://github.com/anza-xyz/agave/blob/v2.3.7/builtins/src/lib.rs#L52 */
239 6 : fd_builtin_program_t const * builtins = fd_builtins();
240 :
241 78 : for( ulong i=0UL; i<fd_num_builtins(); i++ ) {
242 : /** https://github.com/anza-xyz/agave/blob/v2.3.7/runtime/src/bank.rs#L4949 */
243 72 : if( fd_bank_slot_get( bank )==0UL && builtins[i].enable_feature_offset==NO_ENABLE_FEATURE_ID && !fd_builtin_is_bpf( accdb, xid, builtins[i].pubkey ) ) {
244 0 : fd_write_builtin_account( bank, accdb, xid, capture_ctx, *builtins[i].pubkey, builtins[i].data, strlen( builtins[i].data ) );
245 72 : } else if( builtins[i].core_bpf_migration_config && FD_FEATURE_ACTIVE_OFFSET( fd_bank_slot_get( bank ), fd_bank_features_query( bank ), builtins[i].core_bpf_migration_config->enable_feature_offset ) ) {
246 18 : continue;
247 54 : } else if( builtins[i].enable_feature_offset!=NO_ENABLE_FEATURE_ID && !FD_FEATURE_ACTIVE_OFFSET( fd_bank_slot_get( bank ), fd_bank_features_query( bank ), builtins[i].enable_feature_offset ) ) {
248 0 : continue;
249 54 : } else {
250 54 : fd_write_builtin_account( bank, accdb, xid, capture_ctx, *builtins[i].pubkey, builtins[i].data, strlen(builtins[i].data) );
251 54 : }
252 72 : }
253 :
254 : /* Precompiles have empty account data */
255 6 : fd_write_builtin_account( bank, accdb, xid, capture_ctx, fd_solana_keccak_secp_256k_program_id, "", 0 );
256 6 : fd_write_builtin_account( bank, accdb, xid, capture_ctx, fd_solana_ed25519_sig_verify_program_id, "", 0 );
257 6 : if( FD_FEATURE_ACTIVE_BANK( bank, enable_secp256r1_precompile ) ) {
258 6 : fd_write_builtin_account( bank, accdb, xid, capture_ctx, fd_solana_secp256r1_program_id, "", 0 );
259 6 : }
260 6 : }
261 :
262 : fd_builtin_program_t const *
263 18 : fd_builtins( void ) {
264 18 : return builtin_programs;
265 18 : }
266 :
267 : ulong
268 234 : fd_num_builtins( void ) {
269 234 : return BUILTIN_PROGRAMS_COUNT;
270 234 : }
271 :
272 : fd_stateless_builtin_program_t const *
273 12 : fd_stateless_builtins( void ) {
274 12 : return stateless_programs_builtins;
275 12 : }
276 :
277 : ulong
278 36 : fd_num_stateless_builtins( void ) {
279 36 : return STATELESS_BUILTINS_COUNT;
280 36 : }
281 :
282 : fd_precompile_program_t const *
283 12 : fd_precompiles( void ) {
284 12 : return precompiles;
285 12 : }
286 :
287 : ulong
288 48 : fd_num_precompiles( void ) {
289 48 : return PRECOMPILE_PROGRAMS_COUNT;
290 48 : }
291 :
292 : uchar
293 : fd_is_migrating_builtin_program( fd_bank_t const * bank,
294 : fd_pubkey_t const * pubkey,
295 30 : uchar * migrated_yet ) {
296 30 : *migrated_yet = 0;
297 :
298 120 : for( ulong i=0; i<MIGRATING_BUILTINS_COUNT; i++ ) {
299 90 : fd_core_bpf_migration_config_t const * config = migrating_builtins[i];
300 90 : if( !memcmp( pubkey->uc, config->builtin_program_id->key, sizeof(fd_pubkey_t) ) ) {
301 0 : if( config->enable_feature_offset!=NO_ENABLE_FEATURE_ID &&
302 0 : FD_FEATURE_ACTIVE_OFFSET( fd_bank_slot_get( bank ), fd_bank_features_query( bank ), config->enable_feature_offset ) ) {
303 : /* The program has been migrated to BPF. */
304 0 : *migrated_yet = 1;
305 0 : }
306 :
307 0 : return 1;
308 0 : }
309 90 : }
310 :
311 : /* No migration config exists for this program */
312 30 : return 0;
313 30 : }
314 :
315 : FD_FN_PURE uchar
316 396 : fd_is_non_migrating_builtin_program( fd_pubkey_t const * pubkey ) {
317 396 : return !!( fd_non_migrating_builtins_tbl_contains( pubkey ) );
318 396 : }
|
