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

event: mention --wait-for-rpc in spdk_app_start()

Browse Source 
spdk_app_start() can have a completely different behavior
if called with opts->delay_subsystem_init (set via
--wait-for-rpc) - document it.

Change-Id: Id28e1e0cad4681fc9ee29359a7f0e02eae58b434
Signed-off-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/483385
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
Darek Stojaczyk 2020-01-30 14:21:50 +01:00 committed by Tomasz Zawadzki
parent cf8b06ef66
commit 70597c0a14
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
include/spdk/event.h
View File

@ -153,10 +153,20 @@ void spdk_app_opts_init(struct spdk_app_opts *opts);
* Before calling this function, opts must be initialized by
* spdk_app_opts_init(). Once started, the framework will call start_fn on
* an spdk_thread running on the current system thread with the
* argument provided. This call will block until spdk_app_stop()
* is called. If an error condition occurs during the intialization
* code within spdk_app_start(), this function will immediately return
* before invoking start_fn.
* argument provided.
*
* If opts->delay_subsystem_init is set
* (e.g. through --wait-for-rpc flag in spdk_app_parse_args())
* this function will only start a limited RPC server accepting
* only a few RPC commands - mostly related to pre-initialization.
* With this option, the framework won't be started and start_fn
* won't be called until the user sends an `rpc_framework_start_init`
* RPC command, which marks the pre-initialization complete and
* allows start_fn to be finally called.
*
* This call will block until spdk_app_stop() is called. If an error
* condition occurs during the intialization code within spdk_app_start(),
* this function will immediately return before invoking start_fn.
*
* \param opts Initialization options used for this application.
* \param start_fn Entry point that will execute on an internally created thread