forked from spdk/spdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
app.c
1177 lines (1036 loc) · 32.5 KB
/
app.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation. All rights reserved.
* Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "spdk/stdinc.h"
#include "spdk/version.h"
#include "spdk_internal/event.h"
#include "spdk/env.h"
#include "spdk/log.h"
#include "spdk/conf.h"
#include "spdk/thread.h"
#include "spdk/trace.h"
#include "spdk/string.h"
#include "spdk/rpc.h"
#include "spdk/util.h"
#define SPDK_APP_DEFAULT_LOG_LEVEL SPDK_LOG_NOTICE
#define SPDK_APP_DEFAULT_LOG_PRINT_LEVEL SPDK_LOG_INFO
#define SPDK_APP_DEFAULT_NUM_TRACE_ENTRIES SPDK_DEFAULT_NUM_TRACE_ENTRIES
#define SPDK_APP_DPDK_DEFAULT_MEM_SIZE -1
#define SPDK_APP_DPDK_DEFAULT_MASTER_CORE -1
#define SPDK_APP_DPDK_DEFAULT_MEM_CHANNEL -1
#define SPDK_APP_DPDK_DEFAULT_CORE_MASK "0x1"
#define SPDK_APP_DPDK_DEFAULT_BASE_VIRTADDR 0x200000000000
#define SPDK_APP_DEFAULT_CORE_LIMIT 0x140000000 /* 5 GiB */
struct spdk_app {
struct spdk_conf *config;
const char *json_config_file;
bool json_config_ignore_errors;
const char *rpc_addr;
int shm_id;
spdk_app_shutdown_cb shutdown_cb;
int rc;
};
static struct spdk_app g_spdk_app;
static spdk_msg_fn g_start_fn = NULL;
static void *g_start_arg = NULL;
static struct spdk_thread *g_app_thread = NULL;
static bool g_delay_subsystem_init = false;
static bool g_shutdown_sig_received = false;
static char *g_executable_name;
static struct spdk_app_opts g_default_opts;
int
spdk_app_get_shm_id(void)
{
return g_spdk_app.shm_id;
}
/* append one empty option to indicate the end of the array */
static const struct option g_cmdline_options[] = {
#define CONFIG_FILE_OPT_IDX 'c'
{"config", required_argument, NULL, CONFIG_FILE_OPT_IDX},
#define LIMIT_COREDUMP_OPT_IDX 'd'
{"limit-coredump", no_argument, NULL, LIMIT_COREDUMP_OPT_IDX},
#define TPOINT_GROUP_MASK_OPT_IDX 'e'
{"tpoint-group-mask", required_argument, NULL, TPOINT_GROUP_MASK_OPT_IDX},
#define SINGLE_FILE_SEGMENTS_OPT_IDX 'g'
{"single-file-segments", no_argument, NULL, SINGLE_FILE_SEGMENTS_OPT_IDX},
#define HELP_OPT_IDX 'h'
{"help", no_argument, NULL, HELP_OPT_IDX},
#define SHM_ID_OPT_IDX 'i'
{"shm-id", required_argument, NULL, SHM_ID_OPT_IDX},
#define CPUMASK_OPT_IDX 'm'
{"cpumask", required_argument, NULL, CPUMASK_OPT_IDX},
#define MEM_CHANNELS_OPT_IDX 'n'
{"mem-channels", required_argument, NULL, MEM_CHANNELS_OPT_IDX},
#define MASTER_CORE_OPT_IDX 'p'
{"master-core", required_argument, NULL, MASTER_CORE_OPT_IDX},
#define RPC_SOCKET_OPT_IDX 'r'
{"rpc-socket", required_argument, NULL, RPC_SOCKET_OPT_IDX},
#define MEM_SIZE_OPT_IDX 's'
{"mem-size", required_argument, NULL, MEM_SIZE_OPT_IDX},
#define NO_PCI_OPT_IDX 'u'
{"no-pci", no_argument, NULL, NO_PCI_OPT_IDX},
#define VERSION_OPT_IDX 'v'
{"version", no_argument, NULL, VERSION_OPT_IDX},
#define PCI_BLACKLIST_OPT_IDX 'B'
{"pci-blacklist", required_argument, NULL, PCI_BLACKLIST_OPT_IDX},
#define LOGFLAG_OPT_IDX 'L'
{"logflag", required_argument, NULL, LOGFLAG_OPT_IDX},
#define HUGE_UNLINK_OPT_IDX 'R'
{"huge-unlink", no_argument, NULL, HUGE_UNLINK_OPT_IDX},
#define PCI_WHITELIST_OPT_IDX 'W'
{"pci-whitelist", required_argument, NULL, PCI_WHITELIST_OPT_IDX},
#define SILENCE_NOTICELOG_OPT_IDX 257
{"silence-noticelog", no_argument, NULL, SILENCE_NOTICELOG_OPT_IDX},
#define WAIT_FOR_RPC_OPT_IDX 258
{"wait-for-rpc", no_argument, NULL, WAIT_FOR_RPC_OPT_IDX},
#define HUGE_DIR_OPT_IDX 259
{"huge-dir", required_argument, NULL, HUGE_DIR_OPT_IDX},
#define NUM_TRACE_ENTRIES_OPT_IDX 260
{"num-trace-entries", required_argument, NULL, NUM_TRACE_ENTRIES_OPT_IDX},
#define MAX_REACTOR_DELAY_OPT_IDX 261
{"max-delay", required_argument, NULL, MAX_REACTOR_DELAY_OPT_IDX},
#define JSON_CONFIG_OPT_IDX 262
{"json", required_argument, NULL, JSON_CONFIG_OPT_IDX},
#define JSON_CONFIG_IGNORE_INIT_ERRORS_IDX 263
{"json-ignore-init-errors", no_argument, NULL, JSON_CONFIG_IGNORE_INIT_ERRORS_IDX},
#define IOVA_MODE_OPT_IDX 264
{"iova-mode", required_argument, NULL, IOVA_MODE_OPT_IDX},
#define BASE_VIRTADDR_OPT_IDX 265
{"base-virtaddr", required_argument, NULL, BASE_VIRTADDR_OPT_IDX},
};
/* Global section */
#define GLOBAL_CONFIG_TMPL \
"# Configuration file\n" \
"#\n" \
"# Please write all parameters using ASCII.\n" \
"# The parameter must be quoted if it includes whitespace.\n" \
"#\n" \
"# Configuration syntax:\n" \
"# Spaces at head of line are deleted, other spaces are as separator\n" \
"# Lines starting with '#' are comments and not evaluated.\n" \
"# Lines ending with '\\' are concatenated with the next line.\n" \
"# Bracketed keys are section keys grouping the following value keys.\n" \
"# Number of section key is used as a tag number.\n" \
"# Ex. [TargetNode1] = TargetNode section key with tag number 1\n" \
"[Global]\n" \
" Comment \"Global section\"\n" \
"\n" \
" # Users can restrict work items to only run on certain cores by\n" \
" # specifying a ReactorMask. Default is to allow work items to run\n" \
" # on all cores. Core 0 must be set in the mask if one is specified.\n" \
" # Default: 0xFFFF (cores 0-15)\n" \
" ReactorMask \"0x%s\"\n" \
"\n" \
" # Tracepoint group mask for spdk trace buffers\n" \
" # Default: 0x0 (all tracepoint groups disabled)\n" \
" # Set to 0xFFFF to enable all tracepoint groups.\n" \
" TpointGroupMask \"0x%" PRIX64 "\"\n" \
"\n" \
static void
app_config_dump_global_section(FILE *fp)
{
struct spdk_cpuset *coremask;
if (NULL == fp) {
return;
}
coremask = spdk_app_get_core_mask();
fprintf(fp, GLOBAL_CONFIG_TMPL, spdk_cpuset_fmt(coremask),
spdk_trace_get_tpoint_group_mask());
}
int
spdk_app_get_running_config(char **config_str, char *name)
{
FILE *fp = NULL;
int fd = -1;
long length = 0, ret = 0;
char vbuf[BUFSIZ];
char config_template[64];
snprintf(config_template, sizeof(config_template), "/tmp/%s.XXXXXX", name);
/* Create temporary file to hold config */
fd = mkstemp(config_template);
if (fd == -1) {
SPDK_ERRLOG("mkstemp failed\n");
return -1;
}
fp = fdopen(fd, "wb+");
if (NULL == fp) {
SPDK_ERRLOG("error opening tmpfile fd = %d\n", fd);
return -1;
}
/* Buffered IO */
setvbuf(fp, vbuf, _IOFBF, BUFSIZ);
app_config_dump_global_section(fp);
spdk_subsystem_config(fp);
length = ftell(fp);
*config_str = malloc(length + 1);
if (!*config_str) {
SPDK_ERRLOG("out-of-memory for config\n");
fclose(fp);
return -1;
}
fseek(fp, 0, SEEK_SET);
ret = fread(*config_str, sizeof(char), length, fp);
if (ret < length) {
SPDK_ERRLOG("short read\n");
}
fclose(fp);
(*config_str)[length] = '\0';
return 0;
}
static void
app_start_shutdown(void *ctx)
{
if (g_spdk_app.shutdown_cb) {
g_spdk_app.shutdown_cb();
g_spdk_app.shutdown_cb = NULL;
} else {
spdk_app_stop(0);
}
}
void
spdk_app_start_shutdown(void)
{
spdk_thread_send_critical_msg(g_app_thread, app_start_shutdown);
}
static void
__shutdown_signal(int signo)
{
if (!g_shutdown_sig_received) {
g_shutdown_sig_received = true;
spdk_app_start_shutdown();
}
}
static int
app_opts_validate(const char *app_opts)
{
int i = 0, j;
for (i = 0; app_opts[i] != '\0'; i++) {
/* ignore getopt control characters */
if (app_opts[i] == ':' || app_opts[i] == '+' || app_opts[i] == '-') {
continue;
}
for (j = 0; SPDK_APP_GETOPT_STRING[j] != '\0'; j++) {
if (app_opts[i] == SPDK_APP_GETOPT_STRING[j]) {
return app_opts[i];
}
}
}
return 0;
}
void
spdk_app_opts_init(struct spdk_app_opts *opts)
{
if (!opts) {
return;
}
memset(opts, 0, sizeof(*opts));
opts->enable_coredump = true;
opts->shm_id = -1;
opts->mem_size = SPDK_APP_DPDK_DEFAULT_MEM_SIZE;
opts->master_core = SPDK_APP_DPDK_DEFAULT_MASTER_CORE;
opts->mem_channel = SPDK_APP_DPDK_DEFAULT_MEM_CHANNEL;
opts->reactor_mask = NULL;
opts->base_virtaddr = SPDK_APP_DPDK_DEFAULT_BASE_VIRTADDR;
opts->print_level = SPDK_APP_DEFAULT_LOG_PRINT_LEVEL;
opts->rpc_addr = SPDK_DEFAULT_RPC_ADDR;
opts->num_entries = SPDK_APP_DEFAULT_NUM_TRACE_ENTRIES;
opts->delay_subsystem_init = false;
}
static int
app_setup_signal_handlers(struct spdk_app_opts *opts)
{
struct sigaction sigact;
sigset_t sigmask;
int rc;
sigemptyset(&sigmask);
memset(&sigact, 0, sizeof(sigact));
sigemptyset(&sigact.sa_mask);
sigact.sa_handler = SIG_IGN;
rc = sigaction(SIGPIPE, &sigact, NULL);
if (rc < 0) {
SPDK_ERRLOG("sigaction(SIGPIPE) failed\n");
return rc;
}
/* Install the same handler for SIGINT and SIGTERM */
g_shutdown_sig_received = false;
sigact.sa_handler = __shutdown_signal;
rc = sigaction(SIGINT, &sigact, NULL);
if (rc < 0) {
SPDK_ERRLOG("sigaction(SIGINT) failed\n");
return rc;
}
sigaddset(&sigmask, SIGINT);
rc = sigaction(SIGTERM, &sigact, NULL);
if (rc < 0) {
SPDK_ERRLOG("sigaction(SIGTERM) failed\n");
return rc;
}
sigaddset(&sigmask, SIGTERM);
if (opts->usr1_handler != NULL) {
sigact.sa_handler = opts->usr1_handler;
rc = sigaction(SIGUSR1, &sigact, NULL);
if (rc < 0) {
SPDK_ERRLOG("sigaction(SIGUSR1) failed\n");
return rc;
}
sigaddset(&sigmask, SIGUSR1);
}
pthread_sigmask(SIG_UNBLOCK, &sigmask, NULL);
return 0;
}
static void
app_start_application(void)
{
assert(spdk_get_thread() == g_app_thread);
g_start_fn(g_start_arg);
}
static void
app_start_rpc(int rc, void *arg1)
{
if (rc) {
spdk_app_stop(rc);
return;
}
spdk_rpc_initialize(g_spdk_app.rpc_addr);
if (!g_delay_subsystem_init) {
spdk_rpc_set_state(SPDK_RPC_RUNTIME);
app_start_application();
}
}
static struct spdk_conf *
app_setup_conf(const char *config_file)
{
struct spdk_conf *config;
int rc;
config = spdk_conf_allocate();
assert(config != NULL);
if (config_file) {
rc = spdk_conf_read(config, config_file);
if (rc != 0) {
SPDK_ERRLOG("Could not read config file %s\n", config_file);
goto error;
}
if (spdk_conf_first_section(config) == NULL) {
SPDK_ERRLOG("Invalid config file %s\n", config_file);
goto error;
}
}
spdk_conf_set_as_default(config);
return config;
error:
spdk_conf_free(config);
return NULL;
}
static int
app_opts_add_pci_addr(struct spdk_app_opts *opts, struct spdk_pci_addr **list, char *bdf)
{
struct spdk_pci_addr *tmp = *list;
size_t i = opts->num_pci_addr;
tmp = realloc(tmp, sizeof(*tmp) * (i + 1));
if (tmp == NULL) {
SPDK_ERRLOG("realloc error\n");
return -ENOMEM;
}
*list = tmp;
if (spdk_pci_addr_parse(*list + i, bdf) < 0) {
SPDK_ERRLOG("Invalid address %s\n", bdf);
return -EINVAL;
}
opts->num_pci_addr++;
return 0;
}
static int
app_read_config_file_global_params(struct spdk_app_opts *opts)
{
struct spdk_conf_section *sp;
char *bdf;
int i, rc = 0;
sp = spdk_conf_find_section(NULL, "Global");
if (opts->shm_id == -1) {
if (sp != NULL) {
opts->shm_id = spdk_conf_section_get_intval(sp, "SharedMemoryID");
}
}
if (opts->reactor_mask == NULL) {
if (sp && spdk_conf_section_get_val(sp, "ReactorMask")) {
SPDK_ERRLOG("ReactorMask config option is deprecated. Use -m/--cpumask\n"
"command line parameter instead.\n");
opts->reactor_mask = spdk_conf_section_get_val(sp, "ReactorMask");
} else {
opts->reactor_mask = SPDK_APP_DPDK_DEFAULT_CORE_MASK;
}
}
if (!opts->no_pci && sp) {
opts->no_pci = spdk_conf_section_get_boolval(sp, "NoPci", false);
}
if (opts->tpoint_group_mask == NULL) {
if (sp != NULL) {
opts->tpoint_group_mask = spdk_conf_section_get_val(sp, "TpointGroupMask");
}
}
if (sp == NULL) {
return 0;
}
for (i = 0; ; i++) {
bdf = spdk_conf_section_get_nmval(sp, "PciBlacklist", i, 0);
if (!bdf) {
break;
}
rc = app_opts_add_pci_addr(opts, &opts->pci_blacklist, bdf);
if (rc != 0) {
free(opts->pci_blacklist);
return rc;
}
}
for (i = 0; ; i++) {
bdf = spdk_conf_section_get_nmval(sp, "PciWhitelist", i, 0);
if (!bdf) {
break;
}
if (opts->pci_blacklist != NULL) {
SPDK_ERRLOG("PciBlacklist and PciWhitelist cannot be used at the same time\n");
free(opts->pci_blacklist);
return -EINVAL;
}
rc = app_opts_add_pci_addr(opts, &opts->pci_whitelist, bdf);
if (rc != 0) {
free(opts->pci_whitelist);
return rc;
}
}
return 0;
}
static int
app_setup_env(struct spdk_app_opts *opts)
{
struct spdk_env_opts env_opts = {};
int rc;
if (opts == NULL) {
rc = spdk_env_init(NULL);
if (rc != 0) {
SPDK_ERRLOG("Unable to reinitialize SPDK env\n");
}
return rc;
}
spdk_env_opts_init(&env_opts);
env_opts.name = opts->name;
env_opts.core_mask = opts->reactor_mask;
env_opts.shm_id = opts->shm_id;
env_opts.mem_channel = opts->mem_channel;
env_opts.master_core = opts->master_core;
env_opts.mem_size = opts->mem_size;
env_opts.hugepage_single_segments = opts->hugepage_single_segments;
env_opts.unlink_hugepage = opts->unlink_hugepage;
env_opts.hugedir = opts->hugedir;
env_opts.no_pci = opts->no_pci;
env_opts.num_pci_addr = opts->num_pci_addr;
env_opts.pci_blacklist = opts->pci_blacklist;
env_opts.pci_whitelist = opts->pci_whitelist;
env_opts.env_context = opts->env_context;
env_opts.iova_mode = opts->iova_mode;
rc = spdk_env_init(&env_opts);
free(env_opts.pci_blacklist);
free(env_opts.pci_whitelist);
if (rc < 0) {
SPDK_ERRLOG("Unable to initialize SPDK env\n");
}
return rc;
}
static int
app_setup_trace(struct spdk_app_opts *opts)
{
char shm_name[64];
uint64_t tpoint_group_mask;
char *end;
if (opts->shm_id >= 0) {
snprintf(shm_name, sizeof(shm_name), "/%s_trace.%d", opts->name, opts->shm_id);
} else {
snprintf(shm_name, sizeof(shm_name), "/%s_trace.pid%d", opts->name, (int)getpid());
}
if (spdk_trace_init(shm_name, opts->num_entries) != 0) {
return -1;
}
if (opts->tpoint_group_mask != NULL) {
errno = 0;
tpoint_group_mask = strtoull(opts->tpoint_group_mask, &end, 16);
if (*end != '\0' || errno) {
SPDK_ERRLOG("invalid tpoint mask %s\n", opts->tpoint_group_mask);
} else {
SPDK_NOTICELOG("Tracepoint Group Mask %s specified.\n", opts->tpoint_group_mask);
SPDK_NOTICELOG("Use 'spdk_trace -s %s %s %d' to capture a snapshot of events at runtime.\n",
opts->name,
opts->shm_id >= 0 ? "-i" : "-p",
opts->shm_id >= 0 ? opts->shm_id : getpid());
#if defined(__linux__)
SPDK_NOTICELOG("Or copy /dev/shm%s for offline analysis/debug.\n", shm_name);
#endif
spdk_trace_set_tpoint_group_mask(tpoint_group_mask);
}
}
return 0;
}
static void
bootstrap_fn(void *arg1)
{
if (g_spdk_app.json_config_file) {
g_delay_subsystem_init = false;
spdk_app_json_config_load(g_spdk_app.json_config_file, g_spdk_app.rpc_addr, app_start_rpc,
NULL, !g_spdk_app.json_config_ignore_errors);
} else {
if (!g_delay_subsystem_init) {
spdk_subsystem_init(app_start_rpc, NULL);
} else {
spdk_rpc_initialize(g_spdk_app.rpc_addr);
}
}
}
int
spdk_app_start(struct spdk_app_opts *opts, spdk_msg_fn start_fn,
void *arg1)
{
struct spdk_conf *config = NULL;
int rc;
char *tty;
struct spdk_cpuset tmp_cpumask = {};
static bool g_env_was_setup = false;
if (!opts) {
SPDK_ERRLOG("opts should not be NULL\n");
return 1;
}
if (!start_fn) {
SPDK_ERRLOG("start_fn should not be NULL\n");
return 1;
}
tty = ttyname(STDERR_FILENO);
if (opts->print_level > SPDK_LOG_WARN &&
isatty(STDERR_FILENO) &&
tty &&
!strncmp(tty, "/dev/tty", strlen("/dev/tty"))) {
printf("Warning: printing stderr to console terminal without -q option specified.\n");
printf("Suggest using --silence-noticelog to disable logging to stderr and\n");
printf("monitor syslog, or redirect stderr to a file.\n");
printf("(Delaying for 10 seconds...)\n");
sleep(10);
}
spdk_log_set_print_level(opts->print_level);
#ifndef SPDK_NO_RLIMIT
if (opts->enable_coredump) {
struct rlimit core_limits;
core_limits.rlim_cur = core_limits.rlim_max = SPDK_APP_DEFAULT_CORE_LIMIT;
setrlimit(RLIMIT_CORE, &core_limits);
}
#endif
config = app_setup_conf(opts->config_file);
if (config == NULL) {
return 1;
}
if (app_read_config_file_global_params(opts) < 0) {
spdk_conf_free(config);
return 1;
}
memset(&g_spdk_app, 0, sizeof(g_spdk_app));
g_spdk_app.config = config;
g_spdk_app.json_config_file = opts->json_config_file;
g_spdk_app.json_config_ignore_errors = opts->json_config_ignore_errors;
g_spdk_app.rpc_addr = opts->rpc_addr;
g_spdk_app.shm_id = opts->shm_id;
g_spdk_app.shutdown_cb = opts->shutdown_cb;
g_spdk_app.rc = 0;
spdk_log_set_level(SPDK_APP_DEFAULT_LOG_LEVEL);
/* Pass NULL to app_setup_env if SPDK app has been set up, in order to
* indicate that this is a reinitialization.
*/
if (app_setup_env(g_env_was_setup ? NULL : opts) < 0) {
return 1;
}
spdk_log_open(opts->log);
SPDK_NOTICELOG("Total cores available: %d\n", spdk_env_get_core_count());
/*
* If mask not specified on command line or in configuration file,
* reactor_mask will be 0x1 which will enable core 0 to run one
* reactor.
*/
if ((rc = spdk_reactors_init()) != 0) {
SPDK_ERRLOG("Reactor Initilization failed: rc = %d\n", rc);
return 1;
}
spdk_cpuset_set_cpu(&tmp_cpumask, spdk_env_get_current_core(), true);
/* Now that the reactors have been initialized, we can create an
* initialization thread. */
g_app_thread = spdk_thread_create("app_thread", &tmp_cpumask);
if (!g_app_thread) {
SPDK_ERRLOG("Unable to create an spdk_thread for initialization\n");
return 1;
}
/*
* Note the call to app_setup_trace() is located here
* ahead of app_setup_signal_handlers().
* That's because there is not an easy/direct clean
* way of unwinding alloc'd resources that can occur
* in app_setup_signal_handlers().
*/
if (app_setup_trace(opts) != 0) {
return 1;
}
if ((rc = app_setup_signal_handlers(opts)) != 0) {
return 1;
}
g_delay_subsystem_init = opts->delay_subsystem_init;
g_start_fn = start_fn;
g_start_arg = arg1;
spdk_thread_send_msg(g_app_thread, bootstrap_fn, NULL);
/* This blocks until spdk_app_stop is called */
spdk_reactors_start();
g_env_was_setup = true;
return g_spdk_app.rc;
}
void
spdk_app_fini(void)
{
spdk_trace_cleanup();
spdk_reactors_fini();
spdk_env_fini();
spdk_conf_free(g_spdk_app.config);
spdk_log_close();
}
static void
app_stop(void *arg1)
{
spdk_rpc_finish();
spdk_subsystem_fini(spdk_reactors_stop, NULL);
}
void
spdk_app_stop(int rc)
{
if (rc) {
SPDK_WARNLOG("spdk_app_stop'd on non-zero\n");
}
g_spdk_app.rc = rc;
/*
* We want to run spdk_subsystem_fini() from the same thread where spdk_subsystem_init()
* was called.
*/
spdk_thread_send_msg(g_app_thread, app_stop, NULL);
}
static void
usage(void (*app_usage)(void))
{
printf("%s [options]\n", g_executable_name);
printf("options:\n");
printf(" -c, --config <config> config file (default %s)\n",
g_default_opts.config_file != NULL ? g_default_opts.config_file : "none");
printf(" --json <config> JSON config file (default %s)\n",
g_default_opts.json_config_file != NULL ? g_default_opts.json_config_file : "none");
printf(" --json-ignore-init-errors\n");
printf(" don't exit on invalid config entry\n");
printf(" -d, --limit-coredump do not set max coredump size to RLIM_INFINITY\n");
printf(" -g, --single-file-segments\n");
printf(" force creating just one hugetlbfs file\n");
printf(" -h, --help show this usage\n");
printf(" -i, --shm-id <id> shared memory ID (optional)\n");
printf(" -m, --cpumask <mask> core mask for DPDK\n");
printf(" -n, --mem-channels <num> channel number of memory channels used for DPDK\n");
printf(" -p, --master-core <id> master (primary) core for DPDK\n");
printf(" -r, --rpc-socket <path> RPC listen address (default %s)\n", SPDK_DEFAULT_RPC_ADDR);
printf(" -s, --mem-size <size> memory size in MB for DPDK (default: ");
#ifndef __linux__
if (g_default_opts.mem_size <= 0) {
printf("all hugepage memory)\n");
} else
#endif
{
printf("%dMB)\n", g_default_opts.mem_size >= 0 ? g_default_opts.mem_size : 0);
}
printf(" --silence-noticelog disable notice level logging to stderr\n");
printf(" -u, --no-pci disable PCI access\n");
printf(" --wait-for-rpc wait for RPCs to initialize subsystems\n");
printf(" --max-delay <num> maximum reactor delay (in microseconds)\n");
printf(" -B, --pci-blacklist <bdf>\n");
printf(" pci addr to blacklist (can be used more than once)\n");
printf(" -R, --huge-unlink unlink huge files after initialization\n");
printf(" -v, --version print SPDK version\n");
printf(" -W, --pci-whitelist <bdf>\n");
printf(" pci addr to whitelist (-B and -W cannot be used at the same time)\n");
printf(" --huge-dir <path> use a specific hugetlbfs mount to reserve memory from\n");
printf(" --iova-mode <pa/va> set IOVA mode ('pa' for IOVA_PA and 'va' for IOVA_VA)\n");
printf(" --base-virtaddr <addr> the base virtual address for DPDK (default: 0x200000000000)\n");
printf(" --num-trace-entries <num> number of trace entries for each core, must be power of 2. (default %d)\n",
SPDK_APP_DEFAULT_NUM_TRACE_ENTRIES);
spdk_log_usage(stdout, "-L");
spdk_trace_mask_usage(stdout, "-e");
if (app_usage) {
app_usage();
}
}
spdk_app_parse_args_rvals_t
spdk_app_parse_args(int argc, char **argv, struct spdk_app_opts *opts,
const char *app_getopt_str, struct option *app_long_opts,
int (*app_parse)(int ch, char *arg),
void (*app_usage)(void))
{
int ch, rc, opt_idx, global_long_opts_len, app_long_opts_len;
struct option *cmdline_options;
char *cmdline_short_opts = NULL;
enum spdk_app_parse_args_rvals retval = SPDK_APP_PARSE_ARGS_FAIL;
long int tmp;
memcpy(&g_default_opts, opts, sizeof(g_default_opts));
if (opts->config_file && access(opts->config_file, R_OK) != 0) {
SPDK_WARNLOG("Can't read legacy configuration file '%s'\n", opts->config_file);
opts->config_file = NULL;
}
if (opts->json_config_file && access(opts->json_config_file, R_OK) != 0) {
SPDK_WARNLOG("Can't read JSON configuration file '%s'\n", opts->json_config_file);
opts->json_config_file = NULL;
}
if (app_long_opts == NULL) {
app_long_opts_len = 0;
} else {
for (app_long_opts_len = 0;
app_long_opts[app_long_opts_len].name != NULL;
app_long_opts_len++);
}
global_long_opts_len = SPDK_COUNTOF(g_cmdline_options);
cmdline_options = calloc(global_long_opts_len + app_long_opts_len + 1, sizeof(*cmdline_options));
if (!cmdline_options) {
SPDK_ERRLOG("Out of memory\n");
return SPDK_APP_PARSE_ARGS_FAIL;
}
memcpy(&cmdline_options[0], g_cmdline_options, sizeof(g_cmdline_options));
if (app_long_opts) {
memcpy(&cmdline_options[global_long_opts_len], app_long_opts,
app_long_opts_len * sizeof(*app_long_opts));
}
if (app_getopt_str != NULL) {
ch = app_opts_validate(app_getopt_str);
if (ch) {
SPDK_ERRLOG("Duplicated option '%c' between the generic and application specific spdk opts.\n",
ch);
goto out;
}
}
cmdline_short_opts = spdk_sprintf_alloc("%s%s", app_getopt_str, SPDK_APP_GETOPT_STRING);
if (!cmdline_short_opts) {
SPDK_ERRLOG("Out of memory\n");
goto out;
}
g_executable_name = argv[0];
while ((ch = getopt_long(argc, argv, cmdline_short_opts, cmdline_options, &opt_idx)) != -1) {
switch (ch) {
case CONFIG_FILE_OPT_IDX:
opts->config_file = optarg;
break;
case JSON_CONFIG_OPT_IDX:
opts->json_config_file = optarg;
break;
case JSON_CONFIG_IGNORE_INIT_ERRORS_IDX:
opts->json_config_ignore_errors = true;
break;
case LIMIT_COREDUMP_OPT_IDX:
opts->enable_coredump = false;
break;
case TPOINT_GROUP_MASK_OPT_IDX:
opts->tpoint_group_mask = optarg;
break;
case SINGLE_FILE_SEGMENTS_OPT_IDX:
opts->hugepage_single_segments = true;
break;
case HELP_OPT_IDX:
usage(app_usage);
retval = SPDK_APP_PARSE_ARGS_HELP;
goto out;
case SHM_ID_OPT_IDX:
opts->shm_id = spdk_strtol(optarg, 0);
if (opts->shm_id < 0) {
SPDK_ERRLOG("Invalid shared memory ID %s\n", optarg);
goto out;
}
break;
case CPUMASK_OPT_IDX:
opts->reactor_mask = optarg;
break;
case MEM_CHANNELS_OPT_IDX:
opts->mem_channel = spdk_strtol(optarg, 0);
if (opts->mem_channel < 0) {
SPDK_ERRLOG("Invalid memory channel %s\n", optarg);
goto out;
}
break;
case MASTER_CORE_OPT_IDX:
opts->master_core = spdk_strtol(optarg, 0);
if (opts->master_core < 0) {
SPDK_ERRLOG("Invalid master core %s\n", optarg);
goto out;
}
break;
case SILENCE_NOTICELOG_OPT_IDX:
opts->print_level = SPDK_LOG_WARN;
break;
case RPC_SOCKET_OPT_IDX:
opts->rpc_addr = optarg;
break;
case MEM_SIZE_OPT_IDX: {
uint64_t mem_size_mb;
bool mem_size_has_prefix;
rc = spdk_parse_capacity(optarg, &mem_size_mb, &mem_size_has_prefix);
if (rc != 0) {
SPDK_ERRLOG("invalid memory pool size `-s %s`\n", optarg);
usage(app_usage);
goto out;
}
if (mem_size_has_prefix) {
/* the mem size is in MB by default, so if a prefix was
* specified, we need to manually convert to MB.
*/
mem_size_mb /= 1024 * 1024;
}
if (mem_size_mb > INT_MAX) {
SPDK_ERRLOG("invalid memory pool size `-s %s`\n", optarg);
usage(app_usage);
goto out;
}
opts->mem_size = (int) mem_size_mb;
break;
}
case NO_PCI_OPT_IDX:
opts->no_pci = true;
break;
case WAIT_FOR_RPC_OPT_IDX:
opts->delay_subsystem_init = true;
break;
case PCI_BLACKLIST_OPT_IDX:
if (opts->pci_whitelist) {
free(opts->pci_whitelist);
opts->pci_whitelist = NULL;
SPDK_ERRLOG("-B and -W cannot be used at the same time\n");
usage(app_usage);
goto out;
}
rc = app_opts_add_pci_addr(opts, &opts->pci_blacklist, optarg);
if (rc != 0) {
free(opts->pci_blacklist);
opts->pci_blacklist = NULL;
goto out;
}
break;
case LOGFLAG_OPT_IDX:
#ifndef DEBUG
SPDK_ERRLOG("%s must be configured with --enable-debug for -L flag\n",
argv[0]);
usage(app_usage);
goto out;
#else
rc = spdk_log_set_flag(optarg);
if (rc < 0) {
SPDK_ERRLOG("unknown flag\n");
usage(app_usage);
goto out;
}
opts->print_level = SPDK_LOG_DEBUG;
break;
#endif
case HUGE_UNLINK_OPT_IDX:
opts->unlink_hugepage = true;
break;
case PCI_WHITELIST_OPT_IDX:
if (opts->pci_blacklist) {
free(opts->pci_blacklist);
opts->pci_blacklist = NULL;
SPDK_ERRLOG("-B and -W cannot be used at the same time\n");
usage(app_usage);
goto out;
}
rc = app_opts_add_pci_addr(opts, &opts->pci_whitelist, optarg);
if (rc != 0) {
free(opts->pci_whitelist);
opts->pci_whitelist = NULL;
goto out;
}
break;
case BASE_VIRTADDR_OPT_IDX: