app: only certain subcommands require config

Author: ptaffet-jump

src/app/shared/boot/fd_boot.c

@@ -193,17 +193,20 @@ fd_main( int          argc,
      example, they want to show the version or validate the produced
      binary without yet setting up the full TOML. */
 
-  if( FD_UNLIKELY( !argc ) ) {
-    for( ulong i=0UL; ACTIONS[ i ]; i++ ) {
-      action_t * action = ACTIONS[ i ];
-      if( FD_UNLIKELY( action->is_help ) ) {
-        action->fn( NULL, NULL );
-        FD_LOG_WARNING(( "no subcommand specified, exiting" ));
-        return 1;
-      }
+  action_t * help_action = NULL;
+  for( ulong i=0UL; ACTIONS[ i ]; i++ ) {
+    if( FD_UNLIKELY( ACTIONS[ i ]->is_help ) ) {
+      help_action = ACTIONS[ i ];
+      break;
     }
   }
 
+  if( FD_UNLIKELY( !argc ) ) {
+    help_action->fn( NULL, NULL );
+    FD_LOG_WARNING(( "no subcommand specified, exiting" ));
+    return 1;
+  }
+
   /* We need to strip away (potentially leading) cmdline flags first,
      since the parser assumes the action is the leading argument */
   const char * opt_user_config_path = fd_env_strip_cmdline_cstr(
@@ -230,19 +233,14 @@ fd_main( int          argc,
 
   int is_local_cluster = action ? action->is_local_cluster : 0;
   fd_main_init( &argc, &argv, &config, opt_user_config_path, is_firedancer, is_local_cluster, NULL, default_config, default_config_sz, topo_init );
-  if( FD_UNLIKELY( !opt_user_config_path ) ) FD_LOG_ERR(( "missing required `--config` argument" ));
 
   if( FD_UNLIKELY( !action ) ) {
-    for( ulong i=0UL; ACTIONS[ i ]; i++ ) {
-      action_t * action = ACTIONS[ i ];
-      if( FD_UNLIKELY( action->is_help ) ) {
-        action->fn( NULL, NULL );
-        break;
-      }
-    }
+    help_action->fn( NULL, NULL );
     FD_LOG_ERR(( "unknown subcommand `%s`", argv[ 0 ] ));
   }
 
+  if( FD_UNLIKELY( action->require_config && !opt_user_config_path ) ) FD_LOG_ERR(( "missing required `--config` argument" ));
+
   argc--; argv++;
 
   args_t args = {0};

src/app/shared/commands/mem.c

@@ -8,9 +8,10 @@ mem_cmd_fn( args_t *   args FD_PARAM_UNUSED,
 }
 
 action_t fd_action_mem = {
-  .name        = "mem",
-  .args        = NULL,
-  .fn          = mem_cmd_fn,
-  .perm        = NULL,
-  .description = "Print workspace memory and tile topology information",
+  .name           = "mem",
+  .args           = NULL,
+  .fn             = mem_cmd_fn,
+  .require_config = 1,
+  .perm           = NULL,
+  .description    = "Print workspace memory and tile topology information",
 };

src/app/shared/commands/monitor/monitor.c

@@ -622,9 +622,10 @@ monitor_cmd_fn( args_t *   args,
 }
 
 action_t fd_action_monitor = {
-  .name        = "monitor",
-  .args        = monitor_cmd_args,
-  .fn          = monitor_cmd_fn,
-  .perm        = monitor_cmd_perm,
-  .description = "Monitor a locally running Firedancer instance with a terminal GUI",
+  .name           = "monitor",
+  .args           = monitor_cmd_args,
+  .fn             = monitor_cmd_fn,
+  .require_config = 1,
+  .perm           = monitor_cmd_perm,
+  .description    = "Monitor a locally running Firedancer instance with a terminal GUI",
 };

src/app/shared/commands/netconf.c

@@ -64,9 +64,10 @@ netconf_cmd_fn( args_t *   args,
 }
 
 action_t fd_action_netconf = {
-  .name        = "netconf",
-  .args        = NULL,
-  .fn          = netconf_cmd_fn,
-  .perm        = NULL,
-  .description = "Print network configuration",
+  .name           = "netconf",
+  .args           = NULL,
+  .fn             = netconf_cmd_fn,
+  .require_config = 1,
+  .perm           = NULL,
+  .description    = "Print network configuration",
 };

src/app/shared/commands/ready.c

@@ -40,9 +40,10 @@ ready_cmd_fn( args_t *   args FD_PARAM_UNUSED,
 }
 
 action_t fd_action_ready = {
-  .name        = "ready",
-  .args        = NULL,
-  .fn          = ready_cmd_fn,
-  .perm        = NULL,
-  .description = "Wait for all tiles to be running",
+  .name           = "ready",
+  .args           = NULL,
+  .fn             = ready_cmd_fn,
+  .require_config = 1,
+  .perm           = NULL,
+  .description    = "Wait for all tiles to be running",
 };

src/app/shared/commands/run/run.c

@@ -899,6 +899,7 @@ action_t fd_action_run = {
   .name           = "run",
   .args           = NULL,
   .fn             = run_cmd_fn,
+  .require_config = 1,
   .perm           = run_cmd_perm,
   .description    = "Start up a Firedancer validator",
   .permission_err = "insufficient permissions to execute command `%s`. It is recommended "

src/app/shared/commands/set_identity.c

@@ -385,9 +385,10 @@ set_identity_cmd_fn( args_t *   args,
 }
 
 action_t fd_action_set_identity = {
-  .name        = "set-identity",
-  .args        = set_identity_cmd_args,
-  .fn          = set_identity_cmd_fn,
-  .perm        = NULL,
-  .description = "Change the identity of a running validator",
+  .name           = "set-identity",
+  .args           = set_identity_cmd_args,
+  .fn             = set_identity_cmd_fn,
+  .require_config = 1,
+  .perm           = NULL,
+  .description    = "Change the identity of a running validator",
 };

src/app/shared/commands/version.c

@@ -17,5 +17,6 @@ action_t fd_action_version = {
   .args        = NULL,
   .fn          = version_cmd_fn,
   .perm        = NULL,
+  .is_immediate= 1,
   .description = "Show the current software version",
 };

src/app/shared/fd_action.h

@@ -100,6 +100,7 @@ struct fd_action {
 
   int          is_help;
   int          is_immediate;
+  int          require_config;   /* halt if the user tries to use the default config */
   int          is_local_cluster; /* If a command is one which runs a local cluster, certain information in
                                     the configuration file will be changed. */
   uchar        is_diagnostic;  /* 1 implies action should be allowed for prod debugging */