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