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