Integrate vinyl tile into fdctl

riptl · ripatel-fd · commit 078147f87587 · 2025-11-08T15:12:24.000-05:00
Also adds a proper command-line to firedancer-dev snapshot-load
diff --git a/src/app/firedancer-dev/commands/backtest.c b/src/app/firedancer-dev/commands/backtest.c
@@ -90,7 +90,7 @@ backtest_topo( config_t * config ) {
   fd_topob_tile_uses( topo, replay_tile, progcache_obj, FD_SHMEM_JOIN_MODE_READ_WRITE );
 
   if( snap_vinyl ) {
-    setup_topo_vinyl( topo, &config->firedancer );
+    setup_topo_vinyl_meta( topo, &config->firedancer );
   }
 
   /**********************************************************************/
diff --git a/src/app/firedancer-dev/commands/snapshot_load.c b/src/app/firedancer-dev/commands/snapshot_load.c
diff --git a/src/app/firedancer-dev/main.c b/src/app/firedancer-dev/main.c
@@ -12,6 +12,7 @@ extern fd_topo_obj_callbacks_t fd_obj_cb_mcache;
 extern fd_topo_obj_callbacks_t fd_obj_cb_dcache;
 extern fd_topo_obj_callbacks_t fd_obj_cb_fseq;
 extern fd_topo_obj_callbacks_t fd_obj_cb_metrics;
+extern fd_topo_obj_callbacks_t fd_obj_cb_cnc;
 extern fd_topo_obj_callbacks_t fd_obj_cb_opaque;
 extern fd_topo_obj_callbacks_t fd_obj_cb_dbl_buf;
 extern fd_topo_obj_callbacks_t fd_obj_cb_neigh4_hmap;
@@ -27,12 +28,14 @@ extern fd_topo_obj_callbacks_t fd_obj_cb_bank_hash_cmp;
 
 extern fd_topo_obj_callbacks_t fd_obj_cb_vinyl_meta;
 extern fd_topo_obj_callbacks_t fd_obj_cb_vinyl_meta_ele;
+extern fd_topo_obj_callbacks_t fd_obj_cb_vinyl_data;
 
 fd_topo_obj_callbacks_t * CALLBACKS[] = {
   &fd_obj_cb_mcache,
   &fd_obj_cb_dcache,
   &fd_obj_cb_fseq,
   &fd_obj_cb_metrics,
+  &fd_obj_cb_cnc,
   &fd_obj_cb_opaque,
   &fd_obj_cb_dbl_buf,
   &fd_obj_cb_neigh4_hmap,
@@ -47,6 +50,7 @@ fd_topo_obj_callbacks_t * CALLBACKS[] = {
   &fd_obj_cb_bank_hash_cmp,
   &fd_obj_cb_vinyl_meta,
   &fd_obj_cb_vinyl_meta_ele,
+  &fd_obj_cb_vinyl_data,
   NULL,
 };
 
@@ -106,6 +110,7 @@ extern fd_topo_run_tile_t fd_tile_archiver_feeder;
 extern fd_topo_run_tile_t fd_tile_archiver_writer;
 extern fd_topo_run_tile_t fd_tile_archiver_playback;
 extern fd_topo_run_tile_t fd_tile_shredcap;
+extern fd_topo_run_tile_t fd_tile_vinyl;
 
 extern fd_topo_run_tile_t fd_tile_snapct;
 extern fd_topo_run_tile_t fd_tile_snapld;
@@ -161,6 +166,7 @@ fd_topo_run_tile_t * TILES[] = {
   &fd_tile_snapwr,
   &fd_tile_genesi,
   &fd_tile_ipecho,
+  &fd_tile_vinyl,
   NULL,
 };
 
diff --git a/src/app/firedancer/callbacks.c b/src/app/firedancer/callbacks.c
@@ -83,7 +83,6 @@ funk_footprint( fd_topo_t const *     topo,
 static ulong
 funk_loose( fd_topo_t const *     topo,
             fd_topo_obj_t const * obj ) {
-  (void)topo;
   return VAL("heap_max");
 }
 
diff --git a/src/app/firedancer/callbacks_vinyl.c b/src/app/firedancer/callbacks_vinyl.c
@@ -82,3 +82,32 @@ fd_topo_obj_callbacks_t fd_obj_cb_vinyl_meta_ele = {
   .align     = vinyl_meta_ele_align,
   .new       = vinyl_meta_ele_new,
 };
+
+/* vinyl_data: memory arena for data cache entries */
+
+static ulong
+vinyl_data_align( fd_topo_t const *     topo,
+                  fd_topo_obj_t const * obj ) {
+  (void)topo; (void)obj;
+  return alignof(fd_vinyl_data_obj_t);
+}
+
+static ulong
+vinyl_data_footprint( fd_topo_t const *     topo,
+                      fd_topo_obj_t const * obj ) {
+  return fd_ulong_align_dn( VAL("data_sz"), alignof(fd_vinyl_data_obj_t) );
+}
+
+static void
+vinyl_data_new( fd_topo_t const *     topo,
+                fd_topo_obj_t const * obj ) {
+  (void)topo; (void)obj;
+  /* initialized by user */
+}
+
+fd_topo_obj_callbacks_t fd_obj_cb_vinyl_data = {
+  .name      = "vinyl_data",
+  .footprint = vinyl_data_footprint,
+  .align     = vinyl_data_align,
+  .new       = vinyl_data_new,
+};
diff --git a/src/app/firedancer/config/default.toml b/src/app/firedancer/config/default.toml
@@ -502,6 +502,8 @@ user = ""
     enabled = false
     max_account_records = 30_000_000
     file_size_gib = 16
+    max_cache_entries = 1_000_000
+    cache_size_gib = 2
 
 [runtime]
     # TODO: This is not respected, the max vote accounts seems to be
diff --git a/src/app/firedancer/topology.c b/src/app/firedancer/topology.c
@@ -158,12 +158,11 @@ setup_topo_txncache( fd_topo_t *  topo,
 }
 
 void
-setup_topo_vinyl( fd_topo_t *    topo,
-                  fd_configf_t * config ) {
-  (void)config;
-  fd_topob_wksp( topo, "vinyl" );
+setup_topo_vinyl_meta( fd_topo_t *    topo,
+                       fd_configf_t * config ) {
+  fd_topob_wksp( topo, "vinyl_meta" );
 
-  fd_topo_obj_t * map_obj = fd_topob_obj( topo, "vinyl_meta", "vinyl" );
+  fd_topo_obj_t * map_obj = fd_topob_obj( topo, "vinyl_meta", "vinyl_meta" );
   ulong const meta_max  = fd_ulong_pow2_up( config->vinyl.max_account_records );
   ulong const lock_cnt  = fd_vinyl_meta_lock_cnt_est ( meta_max );
   ulong const probe_max = fd_vinyl_meta_probe_max_est( meta_max );
@@ -172,13 +171,24 @@ setup_topo_vinyl( fd_topo_t *    topo,
   fd_pod_insertf_ulong( topo->props, probe_max, "obj.%lu.probe_max", map_obj->id );
   fd_pod_insertf_ulong( topo->props, (ulong)fd_tickcount(), "obj.%lu.seed", map_obj->id );
 
-  fd_topo_obj_t * meta_pool_obj = fd_topob_obj( topo, "vinyl_meta_e", "vinyl" );
+  fd_topo_obj_t * meta_pool_obj = fd_topob_obj( topo, "vinyl_meta_e", "vinyl_meta" );
   fd_pod_insertf_ulong( topo->props, meta_max, "obj.%lu.cnt", meta_pool_obj->id );
 
   fd_pod_insert_ulong( topo->props, "vinyl.meta_map",  map_obj->id );
   fd_pod_insert_ulong( topo->props, "vinyl.meta_pool", meta_pool_obj->id );
 }
 
+fd_topo_obj_t *
+setup_topo_vinyl_cache( fd_topo_t *    topo,
+                        fd_configf_t * config ) {
+  fd_topob_wksp( topo, "vinyl_data" );
+  fd_topo_obj_t * line_obj = fd_topob_obj( topo, "vinyl_data", "vinyl_data" );
+  ulong const heap_max = config->vinyl.cache_size_gib<<30;
+  fd_pod_insertf_ulong( topo->props, heap_max, "obj.%lu.data_sz", line_obj->id );
+  fd_pod_insert_ulong( topo->props, "vinyl.data", line_obj->id );
+  return line_obj;
+}
+
 static int
 resolve_address( char const * address,
                  uint       * ip_addr ) {
@@ -363,17 +373,13 @@ fd_topo_initialize( config_t * config ) {
     fd_topob_wksp( topo, "snapld"      );
     fd_topob_wksp( topo, "snapdc"      );
     fd_topob_wksp( topo, "snapin"      );
-    if( vinyl_enabled ) {
-      fd_topob_wksp( topo, "snapwr" );
-    }
+    if( vinyl_enabled ) fd_topob_wksp( topo, "snapwr" );
 
     fd_topob_wksp( topo, "snapct_ld"   );
     fd_topob_wksp( topo, "snapld_dc"   );
     fd_topob_wksp( topo, "snapdc_in"   );
     fd_topob_wksp( topo, "snapin_ct"   );
-    if( vinyl_enabled ) {
-      fd_topob_wksp( topo, "snapin_wr" );
-    }
+    if( vinyl_enabled ) fd_topob_wksp( topo, "snapin_wr" );
 
     if( FD_LIKELY( config->tiles.gui.enabled ) ) fd_topob_wksp( topo, "snapct_gui"  );
     if( FD_LIKELY( config->tiles.gui.enabled ) ) fd_topob_wksp( topo, "snapin_gui"  );
diff --git a/src/app/firedancer/topology.h b/src/app/firedancer/topology.h
@@ -48,9 +48,14 @@ setup_topo_txncache( fd_topo_t *  topo,
                      char const * wksp_name,
                      ulong        max_live_slots,
                      ulong        max_txn_per_slot );
+
 void
-setup_topo_vinyl( fd_topo_t *    topo,
-                  fd_configf_t * config );
+setup_topo_vinyl_meta( fd_topo_t *    topo,
+                       fd_configf_t * config );
+
+fd_topo_obj_t *
+setup_topo_vinyl_cache( fd_topo_t *    topo,
+                        fd_configf_t * config );
 
 void
 fd_topo_configure_tile( fd_topo_tile_t * tile,
diff --git a/src/app/shared/fd_action.h b/src/app/shared/fd_action.h
@@ -117,9 +117,22 @@ union fdctl_args {
   } metrics;
 
   struct {
-    uint fsck;
-    uint accounts_hist;
-    char snapshot_path[ PATH_MAX ];
+    uint fsck : 1;
+    uint accounts_hist : 1;
+    uint offline : 1;
+    uint no_incremental : 1;
+    uint no_watch : 1;
+    uint is_vinyl : 1;
+    uint vinyl_server : 1;
+
+    char snapshot_dir[ PATH_MAX ];
+    char vinyl_path   [ PATH_MAX ];
+    char vinyl_io     [ 3 ];
+
+    ulong db_sz;
+    ulong db_rec_max;
+    ulong cache_sz;
+    ulong cache_rec_max;
   } snapshot_load;
 
 };
diff --git a/src/app/shared/fd_config.h b/src/app/shared/fd_config.h
@@ -107,6 +107,8 @@ struct fd_configf {
     int   enabled;
     ulong max_account_records;
     ulong file_size_gib;
+    ulong max_cache_entries;
+    ulong cache_size_gib;
   } vinyl;
 
   struct {
diff --git a/src/app/shared/fd_config_parse.c b/src/app/shared/fd_config_parse.c
@@ -91,6 +91,8 @@ fd_config_extract_podf( uchar *        pod,
   CFG_POP      ( bool,   vinyl.enabled                                       );
   CFG_POP      ( ulong,  vinyl.max_account_records                           );
   CFG_POP      ( ulong,  vinyl.file_size_gib                                 );
+  CFG_POP      ( ulong,  vinyl.max_cache_entries                             );
+  CFG_POP      ( ulong,  vinyl.cache_size_gib                                );
 
   CFG_POP      ( ulong,  runtime.max_live_slots                              );
   CFG_POP      ( ulong,  runtime.max_vote_accounts                           );
diff --git a/src/disco/topo/fd_topo.h b/src/disco/topo/fd_topo.h
@@ -597,6 +597,15 @@ struct fd_topo_tile {
       uint target_gid;
       uint target_uid;
     } genesi;
+
+    struct {
+      ulong vinyl_meta_map_obj_id;
+      ulong vinyl_meta_pool_obj_id;
+      ulong vinyl_line_max;
+      ulong vinyl_cnc_obj_id; /* optional */
+      ulong vinyl_data_obj_id;
+      char  vinyl_bstream_path[ PATH_MAX ];
+    } vinyl;
   };
 };
 
diff --git a/src/disco/topo/fd_topob.c b/src/disco/topo/fd_topob.c
@@ -387,6 +387,7 @@ fd_topob_auto_layout( fd_topo_t * topo,
     "snapin", /* FIREDANCER only */
     "arch_f", /* FIREDANCER only */
     "arch_w", /* FIREDANCER only */
+    "vinyl",  /* FIREDANCER only */
   };
 
   char const * CRITICAL_TILES[] = {
diff --git a/src/discof/restore/fd_snapwr_tile.c b/src/discof/restore/fd_snapwr_tile.c
@@ -246,7 +246,7 @@ during_frag( fd_snapwr_t *       ctx,
   /* Because snapwr pacing is so loose and this tile sleeps, fd_stem
      will not return flow control credits fast enough.
      So, always update fseq (consumer progress) here. */
-  ctx->seq_sync[ 0 ] = fd_seq_inc( meta_seq, 1UL );
+  fd_fseq_update( ctx->seq_sync, fd_seq_inc( meta_seq, 1UL ) );
 
   return 0;
 }
diff --git a/src/discof/vinyl/Local.mk b/src/discof/vinyl/Local.mk
@@ -0,0 +1,7 @@
+ifdef FD_HAS_ALLOCA
+ifdef FD_HAS_ATOMIC
+ifdef FD_HAS_INT128
+$(call add-objs,fd_vinyl_tile,fd_discof)
+endif
+endif
+endif
diff --git a/src/discof/vinyl/fd_vinyl_tile.c b/src/discof/vinyl/fd_vinyl_tile.c

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ backtest_topo( config_t * config ) {`
`90`	`90`	`fd_topob_tile_uses( topo, replay_tile, progcache_obj, FD_SHMEM_JOIN_MODE_READ_WRITE );`
`91`	`91`
`92`	`92`	`if( snap_vinyl ) {`
`93`		`- setup_topo_vinyl( topo, &config->firedancer );`
	`93`	`+ setup_topo_vinyl_meta( topo, &config->firedancer );`
`94`	`94`	`}`
`95`	`95`
`96`	`96`	`/**********************************************************************/`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,6 @@ funk_footprint( fd_topo_t const * topo,`
`83`	`83`	`static ulong`
`84`	`84`	`funk_loose( fd_topo_t const * topo,`
`85`	`85`	`fd_topo_obj_t const * obj ) {`
`86`		`- (void)topo;`
`87`	`86`	`return VAL("heap_max");`
`88`	`87`	`}`
`89`	`88`