ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: document --limit-coredump command line option

Browse Source 
Also fix the code to match the documentation.
--limit-coredump is the better name for this option.

Also add a very brief description of --tpoint-group-mask.
A lot more documentation is needed on this, and John
Kariuki has some in progress.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I6eef15a713c0dfc950d748b0275b3f1d60d303b3

Reviewed-on: https://review.gerrithub.io/423751
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
This commit is contained in:
Jim Harris 2018-08-28 12:26:23 -07:00
parent 546d8ab2bd
commit 3dfad90358
2 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/applications.md
View File

@ -27,8 +27,8 @@ applications that use it. Specific applications may implement additional flags.
Param | Long Param | Type | Default | Description
-------- | ---------------------- | -------- | ---------------------- | -----------
-c | --config | string | | @ref cmd_arg_config_file
-d | --limit-coredump | flag | | .
-e | --tpoint-group-mask | integer | 0x0 | .
-d | --limit-coredump | flag | false | @ref cmd_arg_limit_coredump
-e | --tpoint-group-mask | integer | 0x0 | @ref cmd_arg_limit_tpoint_group_mask
-g | --single-file-segments | flag | | @ref cmd_arg_single_file_segments
-h | --help | flag | | show all available parameters and exit
-i | --shm-id | integer | | @ref cmd_arg_multi_process
@ -54,6 +54,20 @@ configuration. See @ref jsonrpc for details.
Note that `--config` and `--wait-for-rpc` cannot be used at the same time.
### Limit coredump {#cmd_arg_limit_coredump}
By default, an SPDK application will set resource limits for core file sizes
to RLIM_INFINITY. Specifying `--limit-coredump` will not set the resource limits.
### Tracepoint group mask {#cmd_arg_limit_tpoint_group_mask}
SPDK has an experimental low overhead tracing framework. Tracepoints in this
framework are organized into tracepoint groups. By default, all tracepoint
groups are disabled. `--tpoint-group-mask` can be used to enable a specific
subset of tracepoint groups in the application.
Note: Additional documentation on the tracepoint framework is in progress.
### Deferred initialization {#cmd_arg_deferred_initialization}
SPDK applications progress through a set of states beginning with `STARTUP` and

6
lib/event/app.c
View File

@ -77,8 +77,8 @@ spdk_app_get_shm_id(void)
static struct option g_cmdline_options[SPDK_APP_MAX_CMDLINE_OPTIONS + 1] = {
#define CONFIG_FILE_OPT_IDX 'c'
{"config", required_argument, NULL, CONFIG_FILE_OPT_IDX},
#define DISABLE_COREDUMP_OPT_IDX 'd'
{"disable-coredump", no_argument, NULL, DISABLE_COREDUMP_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'
@ -781,7 +781,7 @@ spdk_app_parse_args(int argc, char **argv, struct spdk_app_opts *opts,
case CONFIG_FILE_OPT_IDX:
opts->config_file = optarg;
break;
case DISABLE_COREDUMP_OPT_IDX:
case LIMIT_COREDUMP_OPT_IDX:
opts->enable_coredump = false;
break;
case TPOINT_GROUP_MASK_OPT_IDX: