LCOV - code coverage report
Current view: top level - lib/event - app.c (source / functions) Hit Total Coverage
Test: ut_cov_unit.info Lines: 158 873 18.1 %
Date: 2024-07-12 13:55:03 Functions: 9 42 21.4 %

          Line data    Source code
       1             : /*   SPDX-License-Identifier: BSD-3-Clause
       2             :  *   Copyright (C) 2016 Intel Corporation. All rights reserved.
       3             :  *   Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.
       4             :  *   Copyright (c) 2021, 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
       5             :  */
       6             : 
       7             : #include "spdk/stdinc.h"
       8             : #include "spdk/version.h"
       9             : 
      10             : #include "spdk_internal/event.h"
      11             : 
      12             : #include "spdk/assert.h"
      13             : #include "spdk/env.h"
      14             : #include "spdk/init.h"
      15             : #include "spdk/log.h"
      16             : #include "spdk/thread.h"
      17             : #include "spdk/trace.h"
      18             : #include "spdk/string.h"
      19             : #include "spdk/scheduler.h"
      20             : #include "spdk/rpc.h"
      21             : #include "spdk/util.h"
      22             : #include "spdk/file.h"
      23             : #include "spdk/config.h"
      24             : #include "event_internal.h"
      25             : 
      26             : #define SPDK_APP_DEFAULT_LOG_LEVEL              SPDK_LOG_NOTICE
      27             : #define SPDK_APP_DEFAULT_LOG_PRINT_LEVEL        SPDK_LOG_INFO
      28             : #define SPDK_APP_DEFAULT_NUM_TRACE_ENTRIES      SPDK_DEFAULT_NUM_TRACE_ENTRIES
      29             : 
      30             : #define SPDK_APP_DPDK_DEFAULT_MEM_SIZE          -1
      31             : #define SPDK_APP_DPDK_DEFAULT_MAIN_CORE         -1
      32             : #define SPDK_APP_DPDK_DEFAULT_MEM_CHANNEL       -1
      33             : #define SPDK_APP_DPDK_DEFAULT_CORE_MASK         "0x1"
      34             : #define SPDK_APP_DPDK_DEFAULT_BASE_VIRTADDR     0x200000000000
      35             : #define SPDK_APP_DEFAULT_CORE_LIMIT             0x140000000 /* 5 GiB */
      36             : 
      37             : /* For core counts <= 63, the message memory pool size is set to
      38             :  * SPDK_DEFAULT_MSG_MEMPOOL_SIZE.
      39             :  * For core counts > 63, the message memory pool size is dependend on
      40             :  * number of cores. Per core, it is calculated as SPDK_MSG_MEMPOOL_CACHE_SIZE
      41             :  * multiplied by factor of 4 to have space for multiple spdk threads running
      42             :  * on single core (e.g  iscsi + nvmf + vhost ). */
      43             : #define SPDK_APP_PER_CORE_MSG_MEMPOOL_SIZE      (4 * SPDK_MSG_MEMPOOL_CACHE_SIZE)
      44             : 
      45             : struct spdk_app {
      46             :         void                            *json_data;
      47             :         size_t                          json_data_size;
      48             :         bool                            json_config_ignore_errors;
      49             :         bool                            stopped;
      50             :         const char                      *rpc_addr;
      51             :         const char                      **rpc_allowlist;
      52             :         FILE                            *rpc_log_file;
      53             :         enum spdk_log_level             rpc_log_level;
      54             :         int                             shm_id;
      55             :         spdk_app_shutdown_cb            shutdown_cb;
      56             :         int                             rc;
      57             : };
      58             : 
      59             : static struct spdk_app g_spdk_app;
      60             : static spdk_msg_fn g_start_fn = NULL;
      61             : static void *g_start_arg = NULL;
      62             : static bool g_delay_subsystem_init = false;
      63             : static bool g_shutdown_sig_received = false;
      64             : static char *g_executable_name;
      65             : static struct spdk_app_opts g_default_opts;
      66             : static bool g_disable_cpumask_locks = false;
      67             : 
      68             : static int g_core_locks[SPDK_CONFIG_MAX_LCORES];
      69             : 
      70             : static struct {
      71             :         uint64_t irq;
      72             :         uint64_t usr;
      73             :         uint64_t sys;
      74             : } g_initial_stat[SPDK_CONFIG_MAX_LCORES];
      75             : 
      76             : int
      77           0 : spdk_app_get_shm_id(void)
      78             : {
      79           0 :         return g_spdk_app.shm_id;
      80             : }
      81             : 
      82             : /* append one empty option to indicate the end of the array */
      83             : static const struct option g_cmdline_options[] = {
      84             : #define CONFIG_FILE_OPT_IDX     'c'
      85             :         {"config",                    required_argument,      NULL, CONFIG_FILE_OPT_IDX},
      86             : #define LIMIT_COREDUMP_OPT_IDX 'd'
      87             :         {"limit-coredump",            no_argument,            NULL, LIMIT_COREDUMP_OPT_IDX},
      88             : #define TPOINT_GROUP_OPT_IDX 'e'
      89             :         {"tpoint-group",              required_argument,      NULL, TPOINT_GROUP_OPT_IDX},
      90             : #define SINGLE_FILE_SEGMENTS_OPT_IDX 'g'
      91             :         {"single-file-segments",      no_argument,            NULL, SINGLE_FILE_SEGMENTS_OPT_IDX},
      92             : #define HELP_OPT_IDX            'h'
      93             :         {"help",                      no_argument,            NULL, HELP_OPT_IDX},
      94             : #define SHM_ID_OPT_IDX          'i'
      95             :         {"shm-id",                    required_argument,      NULL, SHM_ID_OPT_IDX},
      96             : #define CPUMASK_OPT_IDX         'm'
      97             :         {"cpumask",                   required_argument,      NULL, CPUMASK_OPT_IDX},
      98             : #define MEM_CHANNELS_OPT_IDX    'n'
      99             :         {"mem-channels",              required_argument,      NULL, MEM_CHANNELS_OPT_IDX},
     100             : #define MAIN_CORE_OPT_IDX       'p'
     101             :         {"main-core",                 required_argument,      NULL, MAIN_CORE_OPT_IDX},
     102             : #define RPC_SOCKET_OPT_IDX      'r'
     103             :         {"rpc-socket",                        required_argument,      NULL, RPC_SOCKET_OPT_IDX},
     104             : #define MEM_SIZE_OPT_IDX        's'
     105             :         {"mem-size",                  required_argument,      NULL, MEM_SIZE_OPT_IDX},
     106             : #define NO_PCI_OPT_IDX          'u'
     107             :         {"no-pci",                    no_argument,            NULL, NO_PCI_OPT_IDX},
     108             : #define VERSION_OPT_IDX         'v'
     109             :         {"version",                   no_argument,            NULL, VERSION_OPT_IDX},
     110             : #define PCI_BLOCKED_OPT_IDX     'B'
     111             :         {"pci-blocked",                       required_argument,      NULL, PCI_BLOCKED_OPT_IDX},
     112             : #define LOGFLAG_OPT_IDX         'L'
     113             :         {"logflag",                   required_argument,      NULL, LOGFLAG_OPT_IDX},
     114             : #define HUGE_UNLINK_OPT_IDX     'R'
     115             :         {"huge-unlink",                       no_argument,            NULL, HUGE_UNLINK_OPT_IDX},
     116             : #define PCI_ALLOWED_OPT_IDX     'A'
     117             :         {"pci-allowed",                       required_argument,      NULL, PCI_ALLOWED_OPT_IDX},
     118             : #define INTERRUPT_MODE_OPT_IDX 256
     119             :         {"interrupt-mode",            no_argument,            NULL, INTERRUPT_MODE_OPT_IDX},
     120             : #define SILENCE_NOTICELOG_OPT_IDX 257
     121             :         {"silence-noticelog",         no_argument,            NULL, SILENCE_NOTICELOG_OPT_IDX},
     122             : #define WAIT_FOR_RPC_OPT_IDX    258
     123             :         {"wait-for-rpc",              no_argument,            NULL, WAIT_FOR_RPC_OPT_IDX},
     124             : #define HUGE_DIR_OPT_IDX        259
     125             :         {"huge-dir",                  required_argument,      NULL, HUGE_DIR_OPT_IDX},
     126             : #define NUM_TRACE_ENTRIES_OPT_IDX       260
     127             :         {"num-trace-entries",         required_argument,      NULL, NUM_TRACE_ENTRIES_OPT_IDX},
     128             : #define JSON_CONFIG_OPT_IDX             262
     129             :         {"json",                      required_argument,      NULL, JSON_CONFIG_OPT_IDX},
     130             : #define JSON_CONFIG_IGNORE_INIT_ERRORS_IDX      263
     131             :         {"json-ignore-init-errors",   no_argument,            NULL, JSON_CONFIG_IGNORE_INIT_ERRORS_IDX},
     132             : #define IOVA_MODE_OPT_IDX       264
     133             :         {"iova-mode",                 required_argument,      NULL, IOVA_MODE_OPT_IDX},
     134             : #define BASE_VIRTADDR_OPT_IDX   265
     135             :         {"base-virtaddr",             required_argument,      NULL, BASE_VIRTADDR_OPT_IDX},
     136             : #define ENV_CONTEXT_OPT_IDX     266
     137             :         {"env-context",                       required_argument,      NULL, ENV_CONTEXT_OPT_IDX},
     138             : #define DISABLE_CPUMASK_LOCKS_OPT_IDX   267
     139             :         {"disable-cpumask-locks",     no_argument,            NULL, DISABLE_CPUMASK_LOCKS_OPT_IDX},
     140             : #define RPCS_ALLOWED_OPT_IDX    268
     141             :         {"rpcs-allowed",              required_argument,      NULL, RPCS_ALLOWED_OPT_IDX},
     142             : #define ENV_VF_TOKEN_OPT_IDX 269
     143             :         {"vfio-vf-token",             required_argument,      NULL, ENV_VF_TOKEN_OPT_IDX},
     144             : #define MSG_MEMPOOL_SIZE_OPT_IDX 270
     145             :         {"msg-mempool-size",          required_argument,      NULL, MSG_MEMPOOL_SIZE_OPT_IDX},
     146             : #define LCORES_OPT_IDX  271
     147             :         {"lcores",                    required_argument,      NULL, LCORES_OPT_IDX},
     148             : #define NO_HUGE_OPT_IDX 272
     149             :         {"no-huge",                   no_argument,            NULL, NO_HUGE_OPT_IDX},
     150             : #define NO_RPC_SERVER_OPT_IDX   273
     151             :         {"no-rpc-server",             no_argument,            NULL, NO_RPC_SERVER_OPT_IDX},
     152             : #define ENFORCE_NUMA_OPT_IDX 274
     153             :         {"enforce-numa",              no_argument,            NULL, ENFORCE_NUMA_OPT_IDX},
     154             : };
     155             : 
     156             : static int
     157           0 : parse_proc_stat(unsigned int core, uint64_t *user, uint64_t *sys, uint64_t *irq)
     158             : {
     159             :         FILE *f;
     160           0 :         uint64_t i, soft_irq, cpu = 0;
     161           0 :         int rc, found = 0;
     162             : 
     163           0 :         f = fopen("/proc/stat", "r");
     164           0 :         if (!f) {
     165           0 :                 return -1;
     166             :         }
     167             : 
     168           0 :         for (i = 0; i <= core + 1; i++) {
     169             :                 /* scanf discards input with '*' in format,
     170             :                  * cpu;user;nice;system;idle;iowait;irq;softirq;steal;guest;guest_nice */
     171           0 :                 rc = fscanf(f, "cpu%li %li %*i %li %*i %*i %li %li %*i %*i %*i\n",
     172             :                             &cpu, user, sys, irq, &soft_irq);
     173           0 :                 if (rc != 5) {
     174           0 :                         continue;
     175             :                 }
     176             : 
     177             :                 /* some cores can be disabled, list may not be in order */
     178           0 :                 if (cpu == core) {
     179           0 :                         found = 1;
     180           0 :                         break;
     181             :                 }
     182             :         }
     183             : 
     184           0 :         *irq += soft_irq;
     185             : 
     186           0 :         fclose(f);
     187           0 :         return found ? 0 : -1;
     188             : }
     189             : 
     190             : static int
     191           0 : init_proc_stat(unsigned int core)
     192             : {
     193           0 :         uint64_t usr, sys, irq;
     194             : 
     195           0 :         if (core >= SPDK_CONFIG_MAX_LCORES) {
     196           0 :                 return -1;
     197             :         }
     198             : 
     199           0 :         if (parse_proc_stat(core, &usr, &sys, &irq) < 0) {
     200           0 :                 return -1;
     201             :         }
     202             : 
     203           0 :         g_initial_stat[core].irq = irq;
     204           0 :         g_initial_stat[core].usr = usr;
     205           0 :         g_initial_stat[core].sys = sys;
     206             : 
     207           0 :         return 0;
     208             : }
     209             : 
     210             : int
     211           0 : app_get_proc_stat(unsigned int core, uint64_t *usr, uint64_t *sys, uint64_t *irq)
     212             : {
     213           0 :         uint64_t _usr, _sys, _irq;
     214             : 
     215           0 :         if (core >= SPDK_CONFIG_MAX_LCORES) {
     216           0 :                 return -1;
     217             :         }
     218             : 
     219           0 :         if (parse_proc_stat(core, &_usr, &_sys, &_irq) < 0) {
     220           0 :                 return -1;
     221             :         }
     222             : 
     223           0 :         *irq = _irq - g_initial_stat[core].irq;
     224           0 :         *usr = _usr - g_initial_stat[core].usr;
     225           0 :         *sys = _sys - g_initial_stat[core].sys;
     226             : 
     227           0 :         return 0;
     228             : }
     229             : 
     230             : static void
     231           0 : app_start_shutdown(void *ctx)
     232             : {
     233           0 :         if (g_spdk_app.shutdown_cb) {
     234           0 :                 g_spdk_app.shutdown_cb();
     235           0 :                 g_spdk_app.shutdown_cb = NULL;
     236             :         } else {
     237           0 :                 spdk_app_stop(0);
     238             :         }
     239           0 : }
     240             : 
     241             : void
     242           0 : spdk_app_start_shutdown(void)
     243             : {
     244           0 :         spdk_thread_send_critical_msg(spdk_thread_get_app_thread(), app_start_shutdown);
     245           0 : }
     246             : 
     247             : static void
     248           0 : __shutdown_signal(int signo)
     249             : {
     250           0 :         if (!g_shutdown_sig_received) {
     251           0 :                 g_shutdown_sig_received = true;
     252           0 :                 spdk_app_start_shutdown();
     253             :         }
     254           0 : }
     255             : 
     256             : static int
     257           8 : app_opts_validate(const char *app_opts)
     258             : {
     259           8 :         int i = 0, j;
     260             : 
     261           9 :         for (i = 0; app_opts[i] != '\0'; i++) {
     262             :                 /* ignore getopt control characters */
     263           2 :                 if (app_opts[i] == ':' || app_opts[i] == '+' || app_opts[i] == '-') {
     264           0 :                         continue;
     265             :                 }
     266             : 
     267          32 :                 for (j = 0; SPDK_APP_GETOPT_STRING[j] != '\0'; j++) {
     268          31 :                         if (app_opts[i] == SPDK_APP_GETOPT_STRING[j]) {
     269           1 :                                 return app_opts[i];
     270             :                         }
     271             :                 }
     272             :         }
     273           7 :         return 0;
     274             : }
     275             : 
     276             : static void
     277           0 : calculate_mempool_size(struct spdk_app_opts *opts,
     278             :                        struct spdk_app_opts *opts_user)
     279             : {
     280           0 :         uint32_t core_count = spdk_env_get_core_count();
     281             : 
     282           0 :         if (!opts_user->msg_mempool_size) {
     283             :                 /* The user didn't specify msg_mempool_size, so let's calculate it.
     284             :                    Set the default (SPDK_DEFAULT_MSG_MEMPOOL_SIZE) if less than
     285             :                    64 cores, and use 4k per core otherwise */
     286           0 :                 opts->msg_mempool_size = spdk_max(SPDK_DEFAULT_MSG_MEMPOOL_SIZE,
     287             :                                                   core_count * SPDK_APP_PER_CORE_MSG_MEMPOOL_SIZE);
     288             :         } else {
     289           0 :                 opts->msg_mempool_size = opts_user->msg_mempool_size;
     290             :         }
     291           0 : }
     292             : 
     293             : void
     294           0 : spdk_app_opts_init(struct spdk_app_opts *opts, size_t opts_size)
     295             : {
     296           0 :         if (!opts) {
     297           0 :                 SPDK_ERRLOG("opts should not be NULL\n");
     298           0 :                 return;
     299             :         }
     300             : 
     301           0 :         if (!opts_size) {
     302           0 :                 SPDK_ERRLOG("opts_size should not be zero value\n");
     303           0 :                 return;
     304             :         }
     305             : 
     306           0 :         memset(opts, 0, opts_size);
     307           0 :         opts->opts_size = opts_size;
     308             : 
     309             : #define SET_FIELD(field, value) \
     310             :         if (offsetof(struct spdk_app_opts, field) + sizeof(opts->field) <= opts_size) { \
     311             :                 opts->field = value; \
     312             :         } \
     313             : 
     314           0 :         SET_FIELD(enable_coredump, true);
     315           0 :         SET_FIELD(shm_id, -1);
     316           0 :         SET_FIELD(mem_size, SPDK_APP_DPDK_DEFAULT_MEM_SIZE);
     317           0 :         SET_FIELD(main_core, SPDK_APP_DPDK_DEFAULT_MAIN_CORE);
     318           0 :         SET_FIELD(mem_channel, SPDK_APP_DPDK_DEFAULT_MEM_CHANNEL);
     319           0 :         SET_FIELD(base_virtaddr, SPDK_APP_DPDK_DEFAULT_BASE_VIRTADDR);
     320           0 :         SET_FIELD(print_level, SPDK_APP_DEFAULT_LOG_PRINT_LEVEL);
     321           0 :         SET_FIELD(rpc_addr, SPDK_DEFAULT_RPC_ADDR);
     322           0 :         SET_FIELD(num_entries, SPDK_APP_DEFAULT_NUM_TRACE_ENTRIES);
     323           0 :         SET_FIELD(delay_subsystem_init, false);
     324           0 :         SET_FIELD(disable_signal_handlers, false);
     325           0 :         SET_FIELD(interrupt_mode, false);
     326           0 :         SET_FIELD(enforce_numa, false);
     327             :         /* Don't set msg_mempool_size here, it is set or calculated later */
     328           0 :         SET_FIELD(rpc_allowlist, NULL);
     329           0 :         SET_FIELD(rpc_log_file, NULL);
     330           0 :         SET_FIELD(rpc_log_level, SPDK_LOG_DISABLED);
     331             : #undef SET_FIELD
     332             : }
     333             : 
     334             : static int
     335           0 : app_setup_signal_handlers(struct spdk_app_opts *opts)
     336             : {
     337           0 :         struct sigaction        sigact;
     338           0 :         sigset_t                sigmask;
     339             :         int                     rc;
     340             : 
     341           0 :         sigemptyset(&sigmask);
     342           0 :         memset(&sigact, 0, sizeof(sigact));
     343           0 :         sigemptyset(&sigact.sa_mask);
     344             : 
     345           0 :         sigact.sa_handler = SIG_IGN;
     346           0 :         rc = sigaction(SIGPIPE, &sigact, NULL);
     347           0 :         if (rc < 0) {
     348           0 :                 SPDK_ERRLOG("sigaction(SIGPIPE) failed\n");
     349           0 :                 return rc;
     350             :         }
     351             : 
     352             :         /* Install the same handler for SIGINT and SIGTERM */
     353           0 :         g_shutdown_sig_received = false;
     354           0 :         sigact.sa_handler = __shutdown_signal;
     355           0 :         rc = sigaction(SIGINT, &sigact, NULL);
     356           0 :         if (rc < 0) {
     357           0 :                 SPDK_ERRLOG("sigaction(SIGINT) failed\n");
     358           0 :                 return rc;
     359             :         }
     360           0 :         sigaddset(&sigmask, SIGINT);
     361             : 
     362           0 :         rc = sigaction(SIGTERM, &sigact, NULL);
     363           0 :         if (rc < 0) {
     364           0 :                 SPDK_ERRLOG("sigaction(SIGTERM) failed\n");
     365           0 :                 return rc;
     366             :         }
     367           0 :         sigaddset(&sigmask, SIGTERM);
     368             : 
     369           0 :         pthread_sigmask(SIG_UNBLOCK, &sigmask, NULL);
     370             : 
     371           0 :         return 0;
     372             : }
     373             : 
     374             : static void
     375           0 : app_start_application(int rc, void *arg1)
     376             : {
     377           0 :         assert(spdk_thread_is_app_thread(NULL));
     378             : 
     379           0 :         if (rc) {
     380           0 :                 SPDK_ERRLOG("Failed to load subsystems for RUNTIME state with code: %d\n", rc);
     381           0 :                 spdk_app_stop(rc);
     382           0 :                 return;
     383             :         }
     384             : 
     385           0 :         if (g_spdk_app.rpc_addr) {
     386           0 :                 spdk_rpc_server_resume(g_spdk_app.rpc_addr);
     387             :         }
     388             : 
     389           0 :         g_start_fn(g_start_arg);
     390             : }
     391             : 
     392             : static void
     393           0 : app_subsystem_init_done(int rc, void *arg1)
     394             : {
     395           0 :         if (rc) {
     396           0 :                 SPDK_ERRLOG("Subsystem initialization failed with code: %d\n", rc);
     397           0 :                 spdk_app_stop(rc);
     398           0 :                 return;
     399             :         }
     400             : 
     401           0 :         spdk_rpc_set_allowlist(g_spdk_app.rpc_allowlist);
     402           0 :         spdk_rpc_set_state(SPDK_RPC_RUNTIME);
     403             : 
     404           0 :         if (g_spdk_app.json_data) {
     405             :                 /* Load SPDK_RPC_RUNTIME RPCs from config file */
     406           0 :                 assert(spdk_rpc_get_state() == SPDK_RPC_RUNTIME);
     407           0 :                 spdk_subsystem_load_config(g_spdk_app.json_data, g_spdk_app.json_data_size,
     408             :                                            app_start_application, NULL,
     409           0 :                                            !g_spdk_app.json_config_ignore_errors);
     410             :         } else {
     411           0 :                 app_start_application(0, NULL);
     412             :         }
     413             : }
     414             : 
     415             : static void
     416           0 : app_do_spdk_subsystem_init(int rc, void *arg1)
     417             : {
     418           0 :         struct spdk_rpc_opts opts;
     419             : 
     420           0 :         if (rc) {
     421           0 :                 spdk_app_stop(rc);
     422           0 :                 return;
     423             :         }
     424             : 
     425           0 :         if (g_spdk_app.rpc_addr) {
     426           0 :                 opts.size = SPDK_SIZEOF(&opts, log_level);
     427           0 :                 opts.log_file = g_spdk_app.rpc_log_file;
     428           0 :                 opts.log_level = g_spdk_app.rpc_log_level;
     429             : 
     430           0 :                 rc = spdk_rpc_initialize(g_spdk_app.rpc_addr, &opts);
     431           0 :                 if (rc) {
     432           0 :                         spdk_app_stop(rc);
     433           0 :                         return;
     434             :                 }
     435           0 :                 if (g_delay_subsystem_init) {
     436           0 :                         return;
     437             :                 }
     438           0 :                 spdk_rpc_server_pause(g_spdk_app.rpc_addr);
     439             :         } else {
     440           0 :                 SPDK_DEBUGLOG(app_rpc, "RPC server not started\n");
     441             :         }
     442           0 :         spdk_subsystem_init(app_subsystem_init_done, NULL);
     443             : }
     444             : 
     445             : static int
     446           2 : app_opts_add_pci_addr(struct spdk_app_opts *opts, struct spdk_pci_addr **list, char *bdf)
     447             : {
     448           2 :         struct spdk_pci_addr *tmp = *list;
     449           2 :         size_t i = opts->num_pci_addr;
     450             : 
     451           2 :         tmp = realloc(tmp, sizeof(*tmp) * (i + 1));
     452           2 :         if (tmp == NULL) {
     453           0 :                 SPDK_ERRLOG("realloc error\n");
     454           0 :                 return -ENOMEM;
     455             :         }
     456             : 
     457           2 :         *list = tmp;
     458           2 :         if (spdk_pci_addr_parse(*list + i, bdf) < 0) {
     459           0 :                 SPDK_ERRLOG("Invalid address %s\n", bdf);
     460           0 :                 return -EINVAL;
     461             :         }
     462             : 
     463           2 :         opts->num_pci_addr++;
     464           2 :         return 0;
     465             : }
     466             : 
     467             : static int
     468           0 : app_setup_env(struct spdk_app_opts *opts)
     469             : {
     470           0 :         struct spdk_env_opts env_opts = {};
     471             :         int rc;
     472             : 
     473           0 :         if (opts == NULL) {
     474           0 :                 rc = spdk_env_init_ext(NULL);
     475           0 :                 if (rc != 0) {
     476           0 :                         SPDK_ERRLOG("Unable to reinitialize SPDK env\n");
     477             :                 }
     478             : 
     479           0 :                 return rc;
     480             :         }
     481             : 
     482           0 :         spdk_env_opts_init_ext(&env_opts, sizeof(env_opts));
     483             : 
     484           0 :         env_opts.name = opts->name;
     485           0 :         env_opts.core_mask = opts->reactor_mask;
     486           0 :         env_opts.lcore_map = opts->lcore_map;
     487           0 :         env_opts.shm_id = opts->shm_id;
     488           0 :         env_opts.mem_channel = opts->mem_channel;
     489           0 :         env_opts.main_core = opts->main_core;
     490           0 :         env_opts.mem_size = opts->mem_size;
     491           0 :         env_opts.hugepage_single_segments = opts->hugepage_single_segments;
     492           0 :         env_opts.unlink_hugepage = opts->unlink_hugepage;
     493           0 :         env_opts.hugedir = opts->hugedir;
     494           0 :         env_opts.no_pci = opts->no_pci;
     495           0 :         env_opts.num_pci_addr = opts->num_pci_addr;
     496           0 :         env_opts.pci_blocked = opts->pci_blocked;
     497           0 :         env_opts.pci_allowed = opts->pci_allowed;
     498           0 :         env_opts.base_virtaddr = opts->base_virtaddr;
     499           0 :         env_opts.env_context = opts->env_context;
     500           0 :         env_opts.iova_mode = opts->iova_mode;
     501           0 :         env_opts.vf_token = opts->vf_token;
     502           0 :         env_opts.no_huge = opts->no_huge;
     503           0 :         env_opts.enforce_numa = opts->enforce_numa;
     504             : 
     505           0 :         rc = spdk_env_init_ext(&env_opts);
     506           0 :         free(env_opts.pci_blocked);
     507           0 :         free(env_opts.pci_allowed);
     508             : 
     509           0 :         if (rc < 0) {
     510           0 :                 SPDK_ERRLOG("Unable to initialize SPDK env\n");
     511             :         }
     512             : 
     513           0 :         return rc;
     514             : }
     515             : 
     516             : static int
     517           0 : app_setup_trace(struct spdk_app_opts *opts)
     518             : {
     519           0 :         char            shm_name[64];
     520           0 :         uint64_t        tpoint_group_mask, tpoint_mask = -1ULL;
     521           0 :         char            *end = NULL, *tpoint_group_mask_str, *tpoint_group_str = NULL;
     522             :         char            *tp_g_str, *tpoint_group, *tpoints;
     523           0 :         bool            error_found = false;
     524             :         uint64_t        group_id;
     525             : 
     526           0 :         if (opts->shm_id >= 0) {
     527           0 :                 snprintf(shm_name, sizeof(shm_name), "/%s%s%d", opts->name,
     528             :                          SPDK_TRACE_SHM_NAME_BASE, opts->shm_id);
     529             :         } else {
     530           0 :                 snprintf(shm_name, sizeof(shm_name), "/%s%spid%d", opts->name,
     531           0 :                          SPDK_TRACE_SHM_NAME_BASE, (int)getpid());
     532             :         }
     533             : 
     534           0 :         if (spdk_trace_init(shm_name, opts->num_entries, 0) != 0) {
     535           0 :                 return -1;
     536             :         }
     537             : 
     538           0 :         if (opts->tpoint_group_mask == NULL) {
     539           0 :                 return 0;
     540             :         }
     541             : 
     542           0 :         tpoint_group_mask_str = strdup(opts->tpoint_group_mask);
     543           0 :         if (tpoint_group_mask_str == NULL) {
     544           0 :                 SPDK_ERRLOG("Unable to get string of tpoint group mask from opts.\n");
     545           0 :                 return -1;
     546             :         }
     547             :         /* Save a pointer to the original value of the tpoint group mask string
     548             :          * to free later, because spdk_strsepq() modifies given char*. */
     549           0 :         tp_g_str = tpoint_group_mask_str;
     550           0 :         while ((tpoint_group_str = spdk_strsepq(&tpoint_group_mask_str, ",")) != NULL) {
     551           0 :                 if (strchr(tpoint_group_str, ':')) {
     552             :                         /* Get the tpoint group mask */
     553           0 :                         tpoint_group = spdk_strsepq(&tpoint_group_str, ":");
     554             :                         /* Get the tpoint mask inside that group */
     555           0 :                         tpoints = spdk_strsepq(&tpoint_group_str, ":");
     556             : 
     557           0 :                         errno = 0;
     558           0 :                         tpoint_group_mask = strtoull(tpoint_group, &end, 16);
     559           0 :                         if (*end != '\0' || errno) {
     560           0 :                                 tpoint_group_mask = spdk_trace_create_tpoint_group_mask(tpoint_group);
     561           0 :                                 if (tpoint_group_mask == 0) {
     562           0 :                                         error_found = true;
     563           0 :                                         break;
     564             :                                 }
     565             :                         }
     566             :                         /* Check if tpoint group mask has only one bit set.
     567             :                          * This is to avoid enabling individual tpoints in
     568             :                          * more than one tracepoint group at once. */
     569           0 :                         if (!spdk_u64_is_pow2(tpoint_group_mask)) {
     570           0 :                                 SPDK_ERRLOG("Tpoint group mask: %s contains multiple tpoint groups.\n", tpoint_group);
     571           0 :                                 SPDK_ERRLOG("This is not supported, to prevent from activating tpoints by mistake.\n");
     572           0 :                                 error_found = true;
     573           0 :                                 break;
     574             :                         }
     575             : 
     576           0 :                         errno = 0;
     577           0 :                         tpoint_mask = strtoull(tpoints, &end, 16);
     578           0 :                         if (*end != '\0' || errno) {
     579           0 :                                 error_found = true;
     580           0 :                                 break;
     581             :                         }
     582             :                 } else {
     583           0 :                         errno = 0;
     584           0 :                         tpoint_group_mask = strtoull(tpoint_group_str, &end, 16);
     585           0 :                         if (*end != '\0' || errno) {
     586           0 :                                 tpoint_group_mask = spdk_trace_create_tpoint_group_mask(tpoint_group_str);
     587           0 :                                 if (tpoint_group_mask == 0) {
     588           0 :                                         error_found = true;
     589           0 :                                         break;
     590             :                                 }
     591             :                         }
     592           0 :                         tpoint_mask = -1ULL;
     593             :                 }
     594             : 
     595           0 :                 for (group_id = 0; group_id < SPDK_TRACE_MAX_GROUP_ID; ++group_id) {
     596           0 :                         if (tpoint_group_mask & (1 << group_id)) {
     597           0 :                                 spdk_trace_set_tpoints(group_id, tpoint_mask);
     598             :                         }
     599             :                 }
     600             :         }
     601             : 
     602           0 :         if (error_found) {
     603           0 :                 SPDK_ERRLOG("invalid tpoint mask %s\n", opts->tpoint_group_mask);
     604           0 :                 free(tp_g_str);
     605           0 :                 return -1;
     606             :         } else {
     607           0 :                 SPDK_NOTICELOG("Tracepoint Group Mask %s specified.\n", opts->tpoint_group_mask);
     608           0 :                 SPDK_NOTICELOG("Use 'spdk_trace -s %s %s %d' to capture a snapshot of events at runtime.\n",
     609             :                                opts->name,
     610             :                                opts->shm_id >= 0 ? "-i" : "-p",
     611             :                                opts->shm_id >= 0 ? opts->shm_id : getpid());
     612             : #if defined(__linux__)
     613           0 :                 SPDK_NOTICELOG("'spdk_trace' without parameters will also work if this is the only\n");
     614           0 :                 SPDK_NOTICELOG("SPDK application currently running.\n");
     615           0 :                 SPDK_NOTICELOG("Or copy /dev/shm%s for offline analysis/debug.\n", shm_name);
     616             : #endif
     617             :         }
     618           0 :         free(tp_g_str);
     619             : 
     620           0 :         return 0;
     621             : }
     622             : 
     623             : static void
     624           0 : bootstrap_fn(void *arg1)
     625             : {
     626           0 :         spdk_rpc_set_allowlist(g_spdk_app.rpc_allowlist);
     627             : 
     628           0 :         if (g_spdk_app.json_data) {
     629             :                 /* Load SPDK_RPC_STARTUP RPCs from config file */
     630           0 :                 assert(spdk_rpc_get_state() == SPDK_RPC_STARTUP);
     631           0 :                 spdk_subsystem_load_config(g_spdk_app.json_data, g_spdk_app.json_data_size,
     632             :                                            app_do_spdk_subsystem_init, NULL,
     633           0 :                                            !g_spdk_app.json_config_ignore_errors);
     634             :         } else {
     635           0 :                 app_do_spdk_subsystem_init(0, NULL);
     636             :         }
     637           0 : }
     638             : 
     639             : static void
     640           0 : app_copy_opts(struct spdk_app_opts *opts, struct spdk_app_opts *opts_user, size_t opts_size)
     641             : {
     642           0 :         spdk_app_opts_init(opts, sizeof(*opts));
     643           0 :         opts->opts_size = opts_size;
     644             : 
     645             : #define SET_FIELD(field) \
     646             :         if (offsetof(struct spdk_app_opts, field) + sizeof(opts->field) <= (opts->opts_size)) { \
     647             :                 opts->field = opts_user->field; \
     648             :         } \
     649             : 
     650           0 :         SET_FIELD(name);
     651           0 :         SET_FIELD(json_config_file);
     652           0 :         SET_FIELD(json_config_ignore_errors);
     653           0 :         SET_FIELD(rpc_addr);
     654           0 :         SET_FIELD(reactor_mask);
     655           0 :         SET_FIELD(lcore_map);
     656           0 :         SET_FIELD(tpoint_group_mask);
     657           0 :         SET_FIELD(shm_id);
     658           0 :         SET_FIELD(shutdown_cb);
     659           0 :         SET_FIELD(enable_coredump);
     660           0 :         SET_FIELD(mem_channel);
     661           0 :         SET_FIELD(main_core);
     662           0 :         SET_FIELD(mem_size);
     663           0 :         SET_FIELD(no_pci);
     664           0 :         SET_FIELD(hugepage_single_segments);
     665           0 :         SET_FIELD(unlink_hugepage);
     666           0 :         SET_FIELD(no_huge);
     667           0 :         SET_FIELD(hugedir);
     668           0 :         SET_FIELD(print_level);
     669           0 :         SET_FIELD(num_pci_addr);
     670           0 :         SET_FIELD(pci_blocked);
     671           0 :         SET_FIELD(pci_allowed);
     672           0 :         SET_FIELD(iova_mode);
     673           0 :         SET_FIELD(delay_subsystem_init);
     674           0 :         SET_FIELD(num_entries);
     675           0 :         SET_FIELD(env_context);
     676           0 :         SET_FIELD(log);
     677           0 :         SET_FIELD(base_virtaddr);
     678           0 :         SET_FIELD(disable_signal_handlers);
     679           0 :         SET_FIELD(interrupt_mode);
     680           0 :         SET_FIELD(enforce_numa);
     681           0 :         SET_FIELD(msg_mempool_size);
     682           0 :         SET_FIELD(rpc_allowlist);
     683           0 :         SET_FIELD(vf_token);
     684           0 :         SET_FIELD(rpc_log_file);
     685           0 :         SET_FIELD(rpc_log_level);
     686           0 :         SET_FIELD(json_data);
     687           0 :         SET_FIELD(json_data_size);
     688             : 
     689             :         /* You should not remove this statement, but need to update the assert statement
     690             :          * if you add a new field, and also add a corresponding SET_FIELD statement */
     691             :         SPDK_STATIC_ASSERT(sizeof(struct spdk_app_opts) == 252, "Incorrect size");
     692             : 
     693             : #undef SET_FIELD
     694           0 : }
     695             : 
     696             : static int
     697           0 : unclaim_cpu_cores(uint32_t *failed_core)
     698             : {
     699           0 :         char core_name[40];
     700             :         uint32_t i;
     701             :         int rc;
     702             : 
     703           0 :         for (i = 0; i < SPDK_CONFIG_MAX_LCORES; i++) {
     704           0 :                 if (g_core_locks[i] != -1) {
     705           0 :                         snprintf(core_name, sizeof(core_name), "/var/tmp/spdk_cpu_lock_%03d", i);
     706           0 :                         rc = close(g_core_locks[i]);
     707           0 :                         if (rc) {
     708           0 :                                 SPDK_ERRLOG("Failed to close lock fd for core %d, errno: %d\n", i, errno);
     709           0 :                                 goto error;
     710             :                         }
     711             : 
     712           0 :                         g_core_locks[i] = -1;
     713           0 :                         rc = unlink(core_name);
     714           0 :                         if (rc) {
     715           0 :                                 SPDK_ERRLOG("Failed to unlink lock fd for core %d, errno: %d\n", i, errno);
     716           0 :                                 goto error;
     717             :                         }
     718             :                 }
     719             :         }
     720             : 
     721           0 :         return 0;
     722             : 
     723           0 : error:
     724           0 :         if (failed_core != NULL) {
     725             :                 /* Set number of core we failed to claim. */
     726           0 :                 *failed_core = i;
     727             :         }
     728           0 :         return -1;
     729             : }
     730             : 
     731             : static int
     732           0 : claim_cpu_cores(uint32_t *failed_core)
     733             : {
     734           0 :         char core_name[40];
     735             :         int core_fd, pid;
     736             :         int *core_map;
     737             :         uint32_t core;
     738             : 
     739           0 :         struct flock core_lock = {
     740             :                 .l_type = F_WRLCK,
     741             :                 .l_whence = SEEK_SET,
     742             :                 .l_start = 0,
     743             :                 .l_len = 0,
     744             :         };
     745             : 
     746           0 :         SPDK_ENV_FOREACH_CORE(core) {
     747           0 :                 if (g_core_locks[core] != -1) {
     748             :                         /* If this core is locked already, do not try lock it again. */
     749           0 :                         continue;
     750             :                 }
     751             : 
     752           0 :                 snprintf(core_name, sizeof(core_name), "/var/tmp/spdk_cpu_lock_%03d", core);
     753           0 :                 core_fd = open(core_name, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
     754           0 :                 if (core_fd == -1) {
     755           0 :                         SPDK_ERRLOG("Could not open %s (%s).\n", core_name, spdk_strerror(errno));
     756             :                         /* Return number of core we failed to claim. */
     757           0 :                         goto error;
     758             :                 }
     759             : 
     760           0 :                 if (ftruncate(core_fd, sizeof(int)) != 0) {
     761           0 :                         SPDK_ERRLOG("Could not truncate %s (%s).\n", core_name, spdk_strerror(errno));
     762           0 :                         close(core_fd);
     763           0 :                         goto error;
     764             :                 }
     765             : 
     766           0 :                 core_map = mmap(NULL, sizeof(int), PROT_READ | PROT_WRITE, MAP_SHARED, core_fd, 0);
     767           0 :                 if (core_map == MAP_FAILED) {
     768           0 :                         SPDK_ERRLOG("Could not mmap core %s (%s).\n", core_name, spdk_strerror(errno));
     769           0 :                         close(core_fd);
     770           0 :                         goto error;
     771             :                 }
     772             : 
     773           0 :                 if (fcntl(core_fd, F_SETLK, &core_lock) != 0) {
     774           0 :                         pid = *core_map;
     775           0 :                         SPDK_ERRLOG("Cannot create lock on core %" PRIu32 ", probably process %d has claimed it.\n",
     776             :                                     core, pid);
     777           0 :                         munmap(core_map, sizeof(int));
     778           0 :                         close(core_fd);
     779           0 :                         goto error;
     780             :                 }
     781             : 
     782             :                 /* We write the PID to the core lock file so that other processes trying
     783             :                 * to claim the same core will know what process is holding the lock. */
     784           0 :                 *core_map = (int)getpid();
     785           0 :                 munmap(core_map, sizeof(int));
     786           0 :                 g_core_locks[core] = core_fd;
     787             :                 /* Keep core_fd open to maintain the lock. */
     788             :         }
     789             : 
     790           0 :         return 0;
     791             : 
     792           0 : error:
     793           0 :         if (failed_core != NULL) {
     794             :                 /* Set number of core we failed to claim. */
     795           0 :                 *failed_core = core;
     796             :         }
     797           0 :         unclaim_cpu_cores(NULL);
     798           0 :         return -1;
     799             : }
     800             : 
     801             : int
     802           0 : spdk_app_start(struct spdk_app_opts *opts_user, spdk_msg_fn start_fn,
     803             :                void *arg1)
     804             : {
     805             :         int                     rc;
     806             :         char                    *tty;
     807           0 :         struct spdk_cpuset      tmp_cpumask = {};
     808             :         static bool             g_env_was_setup = false;
     809           0 :         struct spdk_app_opts opts_local = {};
     810           0 :         struct spdk_app_opts *opts = &opts_local;
     811             :         uint32_t i, core;
     812             : 
     813           0 :         if (!opts_user) {
     814           0 :                 SPDK_ERRLOG("opts_user should not be NULL\n");
     815           0 :                 return 1;
     816             :         }
     817             : 
     818           0 :         if (!opts_user->opts_size) {
     819           0 :                 SPDK_ERRLOG("The opts_size in opts_user structure should not be zero value\n");
     820           0 :                 return 1;
     821             :         }
     822             : 
     823           0 :         if (opts_user->name == NULL) {
     824           0 :                 SPDK_ERRLOG("spdk_app_opts::name not specified\n");
     825           0 :                 return 1;
     826             :         }
     827             : 
     828           0 :         app_copy_opts(opts, opts_user, opts_user->opts_size);
     829             : 
     830           0 :         if (!start_fn) {
     831           0 :                 SPDK_ERRLOG("start_fn should not be NULL\n");
     832           0 :                 return 1;
     833             :         }
     834             : 
     835           0 :         if (!opts->rpc_addr && opts->delay_subsystem_init) {
     836           0 :                 SPDK_ERRLOG("Cannot use '--wait-for-rpc' if no RPC server is going to be started.\n");
     837           0 :                 return 1;
     838             :         }
     839             : 
     840           0 :         if (!(opts->lcore_map || opts->reactor_mask)) {
     841             :                 /* Set default CPU mask */
     842           0 :                 opts->reactor_mask = SPDK_APP_DPDK_DEFAULT_CORE_MASK;
     843             :         }
     844             : 
     845           0 :         tty = ttyname(STDERR_FILENO);
     846           0 :         if (opts->print_level > SPDK_LOG_WARN &&
     847           0 :             isatty(STDERR_FILENO) &&
     848           0 :             tty &&
     849           0 :             !strncmp(tty, "/dev/tty", strlen("/dev/tty"))) {
     850           0 :                 printf("Warning: printing stderr to console terminal without -q option specified.\n");
     851           0 :                 printf("Suggest using --silence-noticelog to disable logging to stderr and\n");
     852           0 :                 printf("monitor syslog, or redirect stderr to a file.\n");
     853           0 :                 printf("(Delaying for 10 seconds...)\n");
     854           0 :                 sleep(10);
     855             :         }
     856             : 
     857           0 :         spdk_log_set_print_level(opts->print_level);
     858             : 
     859             : #ifndef SPDK_NO_RLIMIT
     860           0 :         if (opts->enable_coredump) {
     861           0 :                 struct rlimit core_limits;
     862             : 
     863           0 :                 core_limits.rlim_cur = core_limits.rlim_max = SPDK_APP_DEFAULT_CORE_LIMIT;
     864           0 :                 setrlimit(RLIMIT_CORE, &core_limits);
     865             :         }
     866             : #endif
     867             : 
     868           0 :         if (opts->interrupt_mode) {
     869           0 :                 spdk_interrupt_mode_enable();
     870             :         }
     871             : 
     872           0 :         memset(&g_spdk_app, 0, sizeof(g_spdk_app));
     873             : 
     874           0 :         g_spdk_app.json_config_ignore_errors = opts->json_config_ignore_errors;
     875           0 :         g_spdk_app.rpc_addr = opts->rpc_addr;
     876           0 :         g_spdk_app.rpc_allowlist = opts->rpc_allowlist;
     877           0 :         g_spdk_app.rpc_log_file = opts->rpc_log_file;
     878           0 :         g_spdk_app.rpc_log_level = opts->rpc_log_level;
     879           0 :         g_spdk_app.shm_id = opts->shm_id;
     880           0 :         g_spdk_app.shutdown_cb = opts->shutdown_cb;
     881           0 :         g_spdk_app.rc = 0;
     882           0 :         g_spdk_app.stopped = false;
     883             : 
     884           0 :         spdk_log_set_level(SPDK_APP_DEFAULT_LOG_LEVEL);
     885             : 
     886             :         /* Pass NULL to app_setup_env if SPDK app has been set up, in order to
     887             :          * indicate that this is a reinitialization.
     888             :          */
     889           0 :         if (app_setup_env(g_env_was_setup ? NULL : opts) < 0) {
     890           0 :                 return 1;
     891             :         }
     892             : 
     893             :         /* Calculate mempool size now that the env layer has configured the core count
     894             :          * for the application */
     895           0 :         calculate_mempool_size(opts, opts_user);
     896             : 
     897           0 :         spdk_log_open(opts->log);
     898             : 
     899             :         /* Initialize each lock to -1 to indicate "empty" status */
     900           0 :         for (i = 0; i < SPDK_CONFIG_MAX_LCORES; i++) {
     901           0 :                 g_core_locks[i] = -1;
     902             :         }
     903             : 
     904           0 :         if (!g_disable_cpumask_locks) {
     905           0 :                 if (claim_cpu_cores(NULL)) {
     906           0 :                         SPDK_ERRLOG("Unable to acquire lock on assigned core mask - exiting.\n");
     907           0 :                         return 1;
     908             :                 }
     909             :         } else {
     910           0 :                 SPDK_NOTICELOG("CPU core locks deactivated.\n");
     911             :         }
     912             : 
     913           0 :         SPDK_NOTICELOG("Total cores available: %d\n", spdk_env_get_core_count());
     914             : 
     915           0 :         if ((rc = spdk_reactors_init(opts->msg_mempool_size)) != 0) {
     916           0 :                 SPDK_ERRLOG("Reactor Initialization failed: rc = %d\n", rc);
     917           0 :                 return 1;
     918             :         }
     919             : 
     920           0 :         spdk_cpuset_set_cpu(&tmp_cpumask, spdk_env_get_current_core(), true);
     921             : 
     922             :         /* Now that the reactors have been initialized, we can create the app thread. */
     923           0 :         spdk_thread_create("app_thread", &tmp_cpumask);
     924           0 :         if (!spdk_thread_get_app_thread()) {
     925           0 :                 SPDK_ERRLOG("Unable to create an spdk_thread for initialization\n");
     926           0 :                 return 1;
     927             :         }
     928             : 
     929           0 :         SPDK_ENV_FOREACH_CORE(core) {
     930           0 :                 rc = init_proc_stat(core);
     931           0 :                 if (rc) {
     932           0 :                         SPDK_NOTICELOG("Unable to parse /proc/stat [core: %d].\n", core);
     933             :                 }
     934             :         }
     935             :         /*
     936             :          * Disable and ignore trace setup if setting num_entries
     937             :          * to be 0.
     938             :          *
     939             :          * Note the call to app_setup_trace() is located here
     940             :          * ahead of app_setup_signal_handlers().
     941             :          * That's because there is not an easy/direct clean
     942             :          * way of unwinding alloc'd resources that can occur
     943             :          * in app_setup_signal_handlers().
     944             :          */
     945           0 :         if (opts->num_entries != 0 && app_setup_trace(opts) != 0) {
     946           0 :                 return 1;
     947             :         }
     948             : 
     949           0 :         if (!opts->disable_signal_handlers && app_setup_signal_handlers(opts) != 0) {
     950           0 :                 return 1;
     951             :         }
     952             : 
     953           0 :         g_delay_subsystem_init = opts->delay_subsystem_init;
     954           0 :         g_start_fn = start_fn;
     955           0 :         g_start_arg = arg1;
     956             : 
     957           0 :         if (opts->json_config_file != NULL) {
     958           0 :                 if (opts->json_data) {
     959           0 :                         SPDK_ERRLOG("App opts json_config_file and json_data are mutually exclusive\n");
     960           0 :                         return 1;
     961             :                 }
     962             : 
     963           0 :                 g_spdk_app.json_data = spdk_posix_file_load_from_name(opts->json_config_file,
     964             :                                        &g_spdk_app.json_data_size);
     965           0 :                 if (!g_spdk_app.json_data) {
     966           0 :                         SPDK_ERRLOG("Read JSON configuration file %s failed: %s\n",
     967             :                                     opts->json_config_file, spdk_strerror(errno));
     968           0 :                         return 1;
     969             :                 }
     970           0 :         } else if (opts->json_data) {
     971           0 :                 g_spdk_app.json_data = calloc(1, opts->json_data_size);
     972           0 :                 if (!g_spdk_app.json_data) {
     973           0 :                         SPDK_ERRLOG("Failed to allocate JSON data buffer\n");
     974           0 :                         return 1;
     975             :                 }
     976             : 
     977           0 :                 memcpy(g_spdk_app.json_data, opts->json_data, opts->json_data_size);
     978           0 :                 g_spdk_app.json_data_size = opts->json_data_size;
     979             :         }
     980             : 
     981           0 :         spdk_thread_send_msg(spdk_thread_get_app_thread(), bootstrap_fn, NULL);
     982             : 
     983             :         /* This blocks until spdk_app_stop is called */
     984           0 :         spdk_reactors_start();
     985             : 
     986           0 :         g_env_was_setup = true;
     987             : 
     988           0 :         return g_spdk_app.rc;
     989             : }
     990             : 
     991             : void
     992           0 : spdk_app_fini(void)
     993             : {
     994           0 :         spdk_trace_cleanup();
     995           0 :         spdk_reactors_fini();
     996           0 :         spdk_env_fini();
     997           0 :         spdk_log_close();
     998           0 :         unclaim_cpu_cores(NULL);
     999           0 : }
    1000             : 
    1001             : static void
    1002           0 : subsystem_fini_done(void *arg1)
    1003             : {
    1004           0 :         spdk_rpc_finish();
    1005           0 :         spdk_reactors_stop(NULL);
    1006           0 : }
    1007             : 
    1008             : static void
    1009           0 : _start_subsystem_fini(void *arg1)
    1010             : {
    1011           0 :         if (g_scheduling_in_progress) {
    1012           0 :                 spdk_thread_send_msg(spdk_thread_get_app_thread(), _start_subsystem_fini, NULL);
    1013           0 :                 return;
    1014             :         }
    1015             : 
    1016           0 :         spdk_subsystem_fini(subsystem_fini_done, NULL);
    1017             : }
    1018             : 
    1019             : static int
    1020           0 : log_deprecation_hits(void *ctx, struct spdk_deprecation *dep)
    1021             : {
    1022           0 :         uint64_t hits = spdk_deprecation_get_hits(dep);
    1023             : 
    1024           0 :         if (hits == 0) {
    1025           0 :                 return 0;
    1026             :         }
    1027             : 
    1028           0 :         SPDK_WARNLOG("%s: deprecation '%s' scheduled for removal in %s hit %" PRIu64 " times\n",
    1029             :                      spdk_deprecation_get_tag(dep), spdk_deprecation_get_description(dep),
    1030             :                      spdk_deprecation_get_remove_release(dep), hits);
    1031           0 :         return 0;
    1032             : }
    1033             : 
    1034             : static void
    1035           0 : app_stop(void *arg1)
    1036             : {
    1037           0 :         free(g_spdk_app.json_data);
    1038             : 
    1039           0 :         if (g_spdk_app.rc == 0) {
    1040           0 :                 g_spdk_app.rc = (int)(intptr_t)arg1;
    1041             :         }
    1042             : 
    1043           0 :         if (g_spdk_app.stopped) {
    1044           0 :                 SPDK_NOTICELOG("spdk_app_stop called twice\n");
    1045           0 :                 return;
    1046             :         }
    1047             : 
    1048           0 :         g_spdk_app.stopped = true;
    1049           0 :         spdk_log_for_each_deprecation(NULL, log_deprecation_hits);
    1050           0 :         _start_subsystem_fini(NULL);
    1051             : }
    1052             : 
    1053             : void
    1054           0 : spdk_app_stop(int rc)
    1055             : {
    1056           0 :         if (rc) {
    1057           0 :                 SPDK_WARNLOG("spdk_app_stop'd on non-zero\n");
    1058             :         }
    1059             : 
    1060             :         /*
    1061             :          * We want to run spdk_subsystem_fini() from the same thread where spdk_subsystem_init()
    1062             :          * was called.
    1063             :          */
    1064           0 :         spdk_thread_send_msg(spdk_thread_get_app_thread(), app_stop, (void *)(intptr_t)rc);
    1065           0 : }
    1066             : 
    1067             : static void
    1068           3 : usage_memory_size(void)
    1069             : {
    1070             : #ifndef __linux__
    1071             :         if (g_default_opts.mem_size <= 0) {
    1072             :                 printf("all hugepage memory)\n");
    1073             :         } else
    1074             : #endif
    1075             :         {
    1076           3 :                 printf("%dMB)\n", g_default_opts.mem_size >= 0 ? g_default_opts.mem_size : 0);
    1077             :         }
    1078           3 : }
    1079             : 
    1080             : static void
    1081           3 : usage(void (*app_usage)(void))
    1082             : {
    1083           3 :         printf("%s [options]\n", g_executable_name);
    1084             :         /* Keep entries inside categories roughly sorted by frequency of use. */
    1085           3 :         printf("\nCPU options:\n");
    1086           3 :         printf(" -m, --cpumask <mask or list>    core mask (like 0xF) or core list of '[]' embraced for DPDK\n");
    1087           3 :         printf("                                 (like [0,1,10])\n");
    1088           3 :         printf("     --lcores <list>       lcore to CPU mapping list. The list is in the format:\n");
    1089           3 :         printf("                           <lcores[@CPUs]>[<,lcores[@CPUs]>...]\n");
    1090           3 :         printf("                           lcores and cpus list are grouped by '(' and ')', e.g '--lcores \"(5-7)@(10-12)\"'\n");
    1091           3 :         printf("                           Within the group, '-' is used for range separator,\n");
    1092           3 :         printf("                           ',' is used for single number separator.\n");
    1093           3 :         printf("                           '( )' can be omitted for single element group,\n");
    1094           3 :         printf("                           '@' can be omitted if cpus and lcores have the same value\n");
    1095           3 :         printf("     --disable-cpumask-locks    Disable CPU core lock files.\n");
    1096           3 :         printf("     --interrupt-mode      set app to interrupt mode (Warning: CPU usage will be reduced only if all\n");
    1097           3 :         printf("                           pollers in the app support interrupt mode)\n");
    1098           3 :         printf(" -p, --main-core <id>      main (primary) core for DPDK\n");
    1099             : 
    1100           3 :         printf("\nConfiguration options:\n");
    1101           3 :         printf(" -c, --config, --json  <config>     JSON config file\n");
    1102           3 :         printf(" -r, --rpc-socket <path>   RPC listen address (default %s)\n", SPDK_DEFAULT_RPC_ADDR);
    1103           3 :         printf("     --no-rpc-server       skip RPC server initialization. This option ignores '--rpc-socket' value.\n");
    1104           3 :         printf("     --wait-for-rpc        wait for RPCs to initialize subsystems\n");
    1105           3 :         printf("     --rpcs-allowed           comma-separated list of permitted RPCS\n");
    1106           3 :         printf("     --json-ignore-init-errors    don't exit on invalid config entry\n");
    1107             : 
    1108           3 :         printf("\nMemory options:\n");
    1109           3 :         printf("     --iova-mode <pa/va>   set IOVA mode ('pa' for IOVA_PA and 'va' for IOVA_VA)\n");
    1110           3 :         printf("     --base-virtaddr <addr>      the base virtual address for DPDK (default: 0x200000000000)\n");
    1111           3 :         printf("     --huge-dir <path>     use a specific hugetlbfs mount to reserve memory from\n");
    1112           3 :         printf(" -R, --huge-unlink         unlink huge files after initialization\n");
    1113           3 :         printf(" -n, --mem-channels <num>  number of memory channels used for DPDK\n");
    1114           3 :         printf(" -s, --mem-size <size>     memory size in MB for DPDK (default: ");
    1115           3 :         usage_memory_size();
    1116           3 :         printf("     --msg-mempool-size <size>  global message memory pool size in count (default: %d)\n",
    1117             :                SPDK_DEFAULT_MSG_MEMPOOL_SIZE);
    1118           3 :         printf("     --no-huge             run without using hugepages\n");
    1119           3 :         printf("     --enforce-numa        enforce NUMA allocations from the correct socket\n");
    1120           3 :         printf(" -i, --shm-id <id>         shared memory ID (optional)\n");
    1121           3 :         printf(" -g, --single-file-segments   force creating just one hugetlbfs file\n");
    1122             : 
    1123           3 :         printf("\nPCI options:\n");
    1124           3 :         printf(" -A, --pci-allowed <bdf>   pci addr to allow (-B and -A cannot be used at the same time)\n");
    1125           3 :         printf(" -B, --pci-blocked <bdf>   pci addr to block (can be used more than once)\n");
    1126           3 :         printf(" -u, --no-pci              disable PCI access\n");
    1127           3 :         printf("     --vfio-vf-token       VF token (UUID) shared between SR-IOV PF and VFs for vfio_pci driver\n");
    1128             : 
    1129           3 :         printf("\nLog options:\n");
    1130           3 :         spdk_log_usage(stdout, "-L");
    1131           3 :         printf("     --silence-noticelog   disable notice level logging to stderr\n");
    1132             : 
    1133           3 :         printf("\nTrace options:\n");
    1134           3 :         printf("     --num-trace-entries <num>   number of trace entries for each core, must be power of 2,\n");
    1135           3 :         printf("                                 setting 0 to disable trace (default %d)\n",
    1136             :                SPDK_APP_DEFAULT_NUM_TRACE_ENTRIES);
    1137           3 :         printf("                                 Tracepoints vary in size and can use more than one trace entry.\n");
    1138           3 :         spdk_trace_mask_usage(stdout, "-e");
    1139             : 
    1140           3 :         printf("\nOther options:\n");
    1141           3 :         printf(" -h, --help                show this usage\n");
    1142           3 :         printf(" -v, --version             print SPDK version\n");
    1143           3 :         printf(" -d, --limit-coredump      do not set max coredump size to RLIM_INFINITY\n");
    1144           3 :         printf("     --env-context         Opaque context for use of the env implementation\n");
    1145             : 
    1146           3 :         if (app_usage) {
    1147           0 :                 printf("\nApplication specific:\n");
    1148           0 :                 app_usage();
    1149             :         }
    1150           3 : }
    1151             : 
    1152             : spdk_app_parse_args_rvals_t
    1153           8 : spdk_app_parse_args(int argc, char **argv, struct spdk_app_opts *opts,
    1154             :                     const char *app_getopt_str, const struct option *app_long_opts,
    1155             :                     int (*app_parse)(int ch, char *arg),
    1156             :                     void (*app_usage)(void))
    1157             : {
    1158           8 :         int ch, rc, opt_idx, global_long_opts_len, app_long_opts_len;
    1159             :         struct option *cmdline_options;
    1160           8 :         char *cmdline_short_opts = NULL;
    1161           8 :         char *shm_id_str = NULL;
    1162           8 :         enum spdk_app_parse_args_rvals retval = SPDK_APP_PARSE_ARGS_FAIL;
    1163             :         long int tmp;
    1164             : 
    1165           8 :         memcpy(&g_default_opts, opts, sizeof(g_default_opts));
    1166             : 
    1167           8 :         if (opts->json_config_file && access(opts->json_config_file, R_OK) != 0) {
    1168           0 :                 SPDK_WARNLOG("Can't read JSON configuration file '%s'\n", opts->json_config_file);
    1169           0 :                 opts->json_config_file = NULL;
    1170             :         }
    1171             : 
    1172           8 :         if (app_long_opts == NULL) {
    1173           7 :                 app_long_opts_len = 0;
    1174             :         } else {
    1175           1 :                 for (app_long_opts_len = 0;
    1176           2 :                      app_long_opts[app_long_opts_len].name != NULL;
    1177           1 :                      app_long_opts_len++);
    1178             :         }
    1179             : 
    1180           8 :         global_long_opts_len = SPDK_COUNTOF(g_cmdline_options);
    1181             : 
    1182           8 :         cmdline_options = calloc(global_long_opts_len + app_long_opts_len + 1, sizeof(*cmdline_options));
    1183           8 :         if (!cmdline_options) {
    1184           0 :                 SPDK_ERRLOG("Out of memory\n");
    1185           0 :                 return SPDK_APP_PARSE_ARGS_FAIL;
    1186             :         }
    1187             : 
    1188           8 :         memcpy(&cmdline_options[0], g_cmdline_options, sizeof(g_cmdline_options));
    1189           8 :         if (app_long_opts) {
    1190           1 :                 memcpy(&cmdline_options[global_long_opts_len], app_long_opts,
    1191             :                        app_long_opts_len * sizeof(*app_long_opts));
    1192             :         }
    1193             : 
    1194           8 :         if (app_getopt_str != NULL) {
    1195           8 :                 ch = app_opts_validate(app_getopt_str);
    1196           8 :                 if (ch) {
    1197           1 :                         SPDK_ERRLOG("Duplicated option '%c' between app-specific command line parameter and generic spdk opts.\n",
    1198             :                                     ch);
    1199           1 :                         goto out;
    1200             :                 }
    1201             : 
    1202           7 :                 if (!app_parse) {
    1203           0 :                         SPDK_ERRLOG("Parse function is required when app-specific command line parameters are provided.\n");
    1204           0 :                         goto out;
    1205             :                 }
    1206             :         }
    1207             : 
    1208           7 :         cmdline_short_opts = spdk_sprintf_alloc("%s%s", app_getopt_str, SPDK_APP_GETOPT_STRING);
    1209           7 :         if (!cmdline_short_opts) {
    1210           0 :                 SPDK_ERRLOG("Out of memory\n");
    1211           0 :                 goto out;
    1212             :         }
    1213             : 
    1214           7 :         g_executable_name = argv[0];
    1215             : 
    1216          26 :         while ((ch = getopt_long(argc, argv, cmdline_short_opts, cmdline_options, &opt_idx)) != -1) {
    1217          23 :                 switch (ch) {
    1218           3 :                 case CONFIG_FILE_OPT_IDX:
    1219             :                 case JSON_CONFIG_OPT_IDX:
    1220           3 :                         opts->json_config_file = optarg;
    1221           3 :                         break;
    1222           0 :                 case JSON_CONFIG_IGNORE_INIT_ERRORS_IDX:
    1223           0 :                         opts->json_config_ignore_errors = true;
    1224           0 :                         break;
    1225           5 :                 case LIMIT_COREDUMP_OPT_IDX:
    1226           5 :                         opts->enable_coredump = false;
    1227           5 :                         break;
    1228           0 :                 case TPOINT_GROUP_OPT_IDX:
    1229           0 :                         opts->tpoint_group_mask = optarg;
    1230           0 :                         break;
    1231           3 :                 case SINGLE_FILE_SEGMENTS_OPT_IDX:
    1232           3 :                         opts->hugepage_single_segments = true;
    1233           3 :                         break;
    1234           0 :                 case HELP_OPT_IDX:
    1235           0 :                         usage(app_usage);
    1236           0 :                         retval = SPDK_APP_PARSE_ARGS_HELP;
    1237           0 :                         goto out;
    1238           0 :                 case SHM_ID_OPT_IDX:
    1239           0 :                         shm_id_str = optarg;
    1240             :                         /* a negative shm-id disables shared configuration file */
    1241           0 :                         if (optarg[0] == '-') {
    1242           0 :                                 shm_id_str++;
    1243             :                         }
    1244             :                         /* check if the positive value of provided shm_id can be parsed as
    1245             :                          * an integer
    1246             :                          */
    1247           0 :                         opts->shm_id = spdk_strtol(shm_id_str, 0);
    1248           0 :                         if (opts->shm_id < 0) {
    1249           0 :                                 SPDK_ERRLOG("Invalid shared memory ID %s\n", optarg);
    1250           0 :                                 goto out;
    1251             :                         }
    1252           0 :                         if (optarg[0] == '-') {
    1253           0 :                                 opts->shm_id = -opts->shm_id;
    1254             :                         }
    1255           0 :                         break;
    1256           0 :                 case CPUMASK_OPT_IDX:
    1257           0 :                         if (opts->lcore_map) {
    1258           0 :                                 SPDK_ERRLOG("lcore map and core mask can't be set simultaneously\n");
    1259           0 :                                 goto out;
    1260             :                         }
    1261           0 :                         opts->reactor_mask = optarg;
    1262           0 :                         break;
    1263           0 :                 case LCORES_OPT_IDX:
    1264           0 :                         if (opts->reactor_mask) {
    1265           0 :                                 SPDK_ERRLOG("lcore map and core mask can't be set simultaneously\n");
    1266           0 :                                 goto out;
    1267             :                         }
    1268           0 :                         opts->lcore_map = optarg;
    1269           0 :                         break;
    1270           0 :                 case DISABLE_CPUMASK_LOCKS_OPT_IDX:
    1271           0 :                         g_disable_cpumask_locks = true;
    1272           0 :                         break;
    1273           0 :                 case MEM_CHANNELS_OPT_IDX:
    1274           0 :                         opts->mem_channel = spdk_strtol(optarg, 0);
    1275           0 :                         if (opts->mem_channel < 0) {
    1276           0 :                                 SPDK_ERRLOG("Invalid memory channel %s\n", optarg);
    1277           0 :                                 goto out;
    1278             :                         }
    1279           0 :                         break;
    1280           3 :                 case MAIN_CORE_OPT_IDX:
    1281           3 :                         opts->main_core = spdk_strtol(optarg, 0);
    1282           3 :                         if (opts->main_core < 0) {
    1283           1 :                                 SPDK_ERRLOG("Invalid main core %s\n", optarg);
    1284           1 :                                 goto out;
    1285             :                         }
    1286           2 :                         break;
    1287           0 :                 case SILENCE_NOTICELOG_OPT_IDX:
    1288           0 :                         opts->print_level = SPDK_LOG_WARN;
    1289           0 :                         break;
    1290           2 :                 case RPC_SOCKET_OPT_IDX:
    1291           2 :                         opts->rpc_addr = optarg;
    1292           2 :                         break;
    1293           0 :                 case NO_RPC_SERVER_OPT_IDX:
    1294           0 :                         opts->rpc_addr = NULL;
    1295           0 :                         break;
    1296           0 :                 case ENFORCE_NUMA_OPT_IDX:
    1297           0 :                         opts->enforce_numa = true;
    1298           0 :                         break;
    1299           0 :                 case MEM_SIZE_OPT_IDX: {
    1300           0 :                         uint64_t mem_size_mb;
    1301           0 :                         bool mem_size_has_prefix;
    1302             : 
    1303           0 :                         rc = spdk_parse_capacity(optarg, &mem_size_mb, &mem_size_has_prefix);
    1304           0 :                         if (rc != 0) {
    1305           0 :                                 SPDK_ERRLOG("invalid memory pool size `-s %s`\n", optarg);
    1306           0 :                                 usage(app_usage);
    1307           0 :                                 goto out;
    1308             :                         }
    1309             : 
    1310           0 :                         if (mem_size_has_prefix) {
    1311             :                                 /* the mem size is in MB by default, so if a prefix was
    1312             :                                  * specified, we need to manually convert to MB.
    1313             :                                  */
    1314           0 :                                 mem_size_mb /= 1024 * 1024;
    1315             :                         }
    1316             : 
    1317           0 :                         if (mem_size_mb > INT_MAX) {
    1318           0 :                                 SPDK_ERRLOG("invalid memory pool size `-s %s`\n", optarg);
    1319           0 :                                 usage(app_usage);
    1320           0 :                                 goto out;
    1321             :                         }
    1322             : 
    1323           0 :                         opts->mem_size = (int) mem_size_mb;
    1324           0 :                         break;
    1325             :                 }
    1326           0 :                 case MSG_MEMPOOL_SIZE_OPT_IDX:
    1327           0 :                         tmp = spdk_strtol(optarg, 10);
    1328           0 :                         if (tmp <= 0) {
    1329           0 :                                 SPDK_ERRLOG("Invalid message memory pool size %s\n", optarg);
    1330           0 :                                 goto out;
    1331             :                         }
    1332             : 
    1333           0 :                         opts->msg_mempool_size = (size_t)tmp;
    1334           0 :                         break;
    1335             : 
    1336           0 :                 case NO_PCI_OPT_IDX:
    1337           0 :                         opts->no_pci = true;
    1338           0 :                         break;
    1339           0 :                 case WAIT_FOR_RPC_OPT_IDX:
    1340           0 :                         opts->delay_subsystem_init = true;
    1341           0 :                         break;
    1342           2 :                 case PCI_BLOCKED_OPT_IDX:
    1343           2 :                         if (opts->pci_allowed) {
    1344           0 :                                 free(opts->pci_allowed);
    1345           0 :                                 opts->pci_allowed = NULL;
    1346           0 :                                 SPDK_ERRLOG("-B and -A cannot be used at the same time\n");
    1347           0 :                                 usage(app_usage);
    1348           0 :                                 goto out;
    1349             :                         }
    1350             : 
    1351           2 :                         rc = app_opts_add_pci_addr(opts, &opts->pci_blocked, optarg);
    1352           2 :                         if (rc != 0) {
    1353           0 :                                 free(opts->pci_blocked);
    1354           0 :                                 opts->pci_blocked = NULL;
    1355           0 :                                 goto out;
    1356             :                         }
    1357           2 :                         break;
    1358             : 
    1359           0 :                 case NO_HUGE_OPT_IDX:
    1360           0 :                         opts->no_huge = true;
    1361           0 :                         break;
    1362             : 
    1363           0 :                 case LOGFLAG_OPT_IDX:
    1364           0 :                         rc = spdk_log_set_flag(optarg);
    1365           0 :                         if (rc < 0) {
    1366           0 :                                 SPDK_ERRLOG("unknown flag: %s\n", optarg);
    1367           0 :                                 usage(app_usage);
    1368           0 :                                 goto out;
    1369             :                         }
    1370             : #ifdef DEBUG
    1371           0 :                         opts->print_level = SPDK_LOG_DEBUG;
    1372             : #endif
    1373           0 :                         break;
    1374           0 :                 case HUGE_UNLINK_OPT_IDX:
    1375           0 :                         opts->unlink_hugepage = true;
    1376           0 :                         break;
    1377           1 :                 case PCI_ALLOWED_OPT_IDX:
    1378           1 :                         if (opts->pci_blocked) {
    1379           1 :                                 free(opts->pci_blocked);
    1380           1 :                                 opts->pci_blocked = NULL;
    1381           1 :                                 SPDK_ERRLOG("-B and -W cannot be used at the same time\n");
    1382           1 :                                 usage(app_usage);
    1383           1 :                                 goto out;
    1384             :                         }
    1385             : 
    1386           0 :                         rc = app_opts_add_pci_addr(opts, &opts->pci_allowed, optarg);
    1387           0 :                         if (rc != 0) {
    1388           0 :                                 free(opts->pci_allowed);
    1389           0 :                                 opts->pci_allowed = NULL;
    1390           0 :                                 goto out;
    1391             :                         }
    1392           0 :                         break;
    1393           0 :                 case BASE_VIRTADDR_OPT_IDX:
    1394           0 :                         tmp = spdk_strtoll(optarg, 0);
    1395           0 :                         if (tmp <= 0) {
    1396           0 :                                 SPDK_ERRLOG("Invalid base-virtaddr %s\n", optarg);
    1397           0 :                                 usage(app_usage);
    1398           0 :                                 goto out;
    1399             :                         }
    1400           0 :                         opts->base_virtaddr = (uint64_t)tmp;
    1401           0 :                         break;
    1402           0 :                 case HUGE_DIR_OPT_IDX:
    1403           0 :                         opts->hugedir = optarg;
    1404           0 :                         break;
    1405           0 :                 case IOVA_MODE_OPT_IDX:
    1406           0 :                         opts->iova_mode = optarg;
    1407           0 :                         break;
    1408           0 :                 case NUM_TRACE_ENTRIES_OPT_IDX:
    1409           0 :                         tmp = spdk_strtoll(optarg, 0);
    1410           0 :                         if (tmp < 0) {
    1411           0 :                                 SPDK_ERRLOG("Invalid num-trace-entries %s\n", optarg);
    1412           0 :                                 usage(app_usage);
    1413           0 :                                 goto out;
    1414             :                         }
    1415           0 :                         opts->num_entries = (uint64_t)tmp;
    1416           0 :                         if (opts->num_entries > 0 && opts->num_entries & (opts->num_entries - 1)) {
    1417           0 :                                 SPDK_ERRLOG("num-trace-entries must be power of 2\n");
    1418           0 :                                 usage(app_usage);
    1419           0 :                                 goto out;
    1420             :                         }
    1421           0 :                         break;
    1422           0 :                 case ENV_CONTEXT_OPT_IDX:
    1423           0 :                         opts->env_context = optarg;
    1424           0 :                         break;
    1425           0 :                 case RPCS_ALLOWED_OPT_IDX:
    1426           0 :                         opts->rpc_allowlist = (const char **)spdk_strarray_from_string(optarg, ",");
    1427           0 :                         if (opts->rpc_allowlist == NULL) {
    1428           0 :                                 SPDK_ERRLOG("Invalid --rpcs-allowed argument\n");
    1429           0 :                                 usage(app_usage);
    1430           0 :                                 goto out;
    1431             :                         }
    1432           0 :                         break;
    1433           0 :                 case ENV_VF_TOKEN_OPT_IDX:
    1434           0 :                         opts->vf_token = optarg;
    1435           0 :                         break;
    1436           0 :                 case INTERRUPT_MODE_OPT_IDX:
    1437           0 :                         opts->interrupt_mode = true;
    1438           0 :                         break;
    1439           0 :                 case VERSION_OPT_IDX:
    1440           0 :                         printf(SPDK_VERSION_STRING"\n");
    1441           0 :                         retval = SPDK_APP_PARSE_ARGS_HELP;
    1442           0 :                         goto out;
    1443           2 :                 case '?':
    1444             :                         /*
    1445             :                          * In the event getopt() above detects an option
    1446             :                          * in argv that is NOT in the getopt_str,
    1447             :                          * getopt() will return a '?' indicating failure.
    1448             :                          */
    1449           2 :                         usage(app_usage);
    1450           2 :                         goto out;
    1451           2 :                 default:
    1452           2 :                         if (!app_parse) {
    1453           0 :                                 SPDK_ERRLOG("Unsupported app-specific command line parameter '%c'.\n", ch);
    1454           0 :                                 goto out;
    1455             :                         }
    1456             : 
    1457           2 :                         rc = app_parse(ch, optarg);
    1458           2 :                         if (rc) {
    1459           0 :                                 SPDK_ERRLOG("Parsing app-specific command line parameter '%c' failed: %d\n", ch, rc);
    1460           0 :                                 goto out;
    1461             :                         }
    1462             :                 }
    1463             :         }
    1464             : 
    1465           3 :         retval = SPDK_APP_PARSE_ARGS_SUCCESS;
    1466           8 : out:
    1467           8 :         if (retval != SPDK_APP_PARSE_ARGS_SUCCESS) {
    1468           5 :                 free(opts->pci_blocked);
    1469           5 :                 opts->pci_blocked = NULL;
    1470           5 :                 free(opts->pci_allowed);
    1471           5 :                 opts->pci_allowed = NULL;
    1472           5 :                 spdk_strarray_free((char **)opts->rpc_allowlist);
    1473           5 :                 opts->rpc_allowlist = NULL;
    1474             :         }
    1475           8 :         free(cmdline_short_opts);
    1476           8 :         free(cmdline_options);
    1477           8 :         return retval;
    1478             : }
    1479             : 
    1480             : void
    1481           0 : spdk_app_usage(void)
    1482             : {
    1483           0 :         if (g_executable_name == NULL) {
    1484           0 :                 SPDK_ERRLOG("%s not valid before calling spdk_app_parse_args()\n", __func__);
    1485           0 :                 return;
    1486             :         }
    1487             : 
    1488           0 :         usage(NULL);
    1489             : }
    1490             : 
    1491             : static void
    1492           0 : rpc_framework_start_init_cpl(int rc, void *arg1)
    1493             : {
    1494           0 :         struct spdk_jsonrpc_request *request = arg1;
    1495             : 
    1496           0 :         assert(spdk_thread_is_app_thread(NULL));
    1497             : 
    1498           0 :         if (rc) {
    1499           0 :                 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
    1500             :                                                  "framework_initialization failed");
    1501           0 :                 return;
    1502             :         }
    1503             : 
    1504           0 :         app_subsystem_init_done(0, NULL);
    1505             : 
    1506           0 :         spdk_jsonrpc_send_bool_response(request, true);
    1507             : }
    1508             : 
    1509             : static void
    1510           0 : rpc_framework_start_init(struct spdk_jsonrpc_request *request,
    1511             :                          const struct spdk_json_val *params)
    1512             : {
    1513           0 :         if (params != NULL) {
    1514           0 :                 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
    1515             :                                                  "framework_start_init requires no parameters");
    1516           0 :                 return;
    1517             :         }
    1518             : 
    1519           0 :         spdk_rpc_server_pause(g_spdk_app.rpc_addr);
    1520           0 :         spdk_subsystem_init(rpc_framework_start_init_cpl, request);
    1521             : }
    1522           1 : SPDK_RPC_REGISTER("framework_start_init", rpc_framework_start_init, SPDK_RPC_STARTUP)
    1523             : 
    1524             : struct subsystem_init_poller_ctx {
    1525             :         struct spdk_poller *init_poller;
    1526             :         struct spdk_jsonrpc_request *request;
    1527             : };
    1528             : 
    1529             : static int
    1530           0 : rpc_subsystem_init_poller_ctx(void *ctx)
    1531             : {
    1532           0 :         struct subsystem_init_poller_ctx *poller_ctx = ctx;
    1533             : 
    1534           0 :         if (spdk_rpc_get_state() == SPDK_RPC_RUNTIME) {
    1535           0 :                 spdk_jsonrpc_send_bool_response(poller_ctx->request, true);
    1536           0 :                 spdk_poller_unregister(&poller_ctx->init_poller);
    1537           0 :                 free(poller_ctx);
    1538             :         }
    1539             : 
    1540           0 :         return SPDK_POLLER_BUSY;
    1541             : }
    1542             : 
    1543             : static void
    1544           0 : rpc_framework_wait_init(struct spdk_jsonrpc_request *request,
    1545             :                         const struct spdk_json_val *params)
    1546             : {
    1547             :         struct subsystem_init_poller_ctx *ctx;
    1548             : 
    1549           0 :         if (spdk_rpc_get_state() == SPDK_RPC_RUNTIME) {
    1550           0 :                 spdk_jsonrpc_send_bool_response(request, true);
    1551             :         } else {
    1552           0 :                 ctx = malloc(sizeof(struct subsystem_init_poller_ctx));
    1553           0 :                 if (ctx == NULL) {
    1554           0 :                         spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
    1555             :                                                          "Unable to allocate memory for the request context\n");
    1556           0 :                         return;
    1557             :                 }
    1558           0 :                 ctx->request = request;
    1559           0 :                 ctx->init_poller = SPDK_POLLER_REGISTER(rpc_subsystem_init_poller_ctx, ctx, 0);
    1560             :         }
    1561             : }
    1562           1 : SPDK_RPC_REGISTER("framework_wait_init", rpc_framework_wait_init,
    1563             :                   SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
    1564             : 
    1565             : static void
    1566           0 : rpc_framework_disable_cpumask_locks(struct spdk_jsonrpc_request *request,
    1567             :                                     const struct spdk_json_val *params)
    1568             : {
    1569           0 :         char msg[128];
    1570             :         int rc;
    1571           0 :         uint32_t failed_core;
    1572             : 
    1573           0 :         if (params != NULL) {
    1574           0 :                 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
    1575             :                                                  "framework_disable_cpumask_locks"
    1576             :                                                  "requires no arguments");
    1577           0 :                 return;
    1578             :         }
    1579             : 
    1580           0 :         rc = unclaim_cpu_cores(&failed_core);
    1581           0 :         if (rc) {
    1582           0 :                 snprintf(msg, sizeof(msg), "Failed to unclaim CPU core: %" PRIu32, failed_core);
    1583           0 :                 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, msg);
    1584           0 :                 return;
    1585             :         }
    1586             : 
    1587           0 :         spdk_jsonrpc_send_bool_response(request, true);
    1588             : }
    1589           1 : SPDK_RPC_REGISTER("framework_disable_cpumask_locks", rpc_framework_disable_cpumask_locks,
    1590             :                   SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)
    1591             : 
    1592             : static void
    1593           0 : rpc_framework_enable_cpumask_locks(struct spdk_jsonrpc_request *request,
    1594             :                                    const struct spdk_json_val *params)
    1595             : {
    1596           0 :         char msg[128];
    1597             :         int rc;
    1598           0 :         uint32_t failed_core;
    1599             : 
    1600           0 :         if (params != NULL) {
    1601           0 :                 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
    1602             :                                                  "framework_enable_cpumask_locks"
    1603             :                                                  "requires no arguments");
    1604           0 :                 return;
    1605             :         }
    1606             : 
    1607           0 :         rc = claim_cpu_cores(&failed_core);
    1608           0 :         if (rc) {
    1609           0 :                 snprintf(msg, sizeof(msg), "Failed to claim CPU core: %" PRIu32, failed_core);
    1610           0 :                 spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, msg);
    1611           0 :                 return;
    1612             :         }
    1613             : 
    1614           0 :         spdk_jsonrpc_send_bool_response(request, true);
    1615             : }
    1616           1 : SPDK_RPC_REGISTER("framework_enable_cpumask_locks", rpc_framework_enable_cpumask_locks,
    1617             :                   SPDK_RPC_STARTUP | SPDK_RPC_RUNTIME)

Generated by: LCOV version 1.15