a6dbe3721e
per Intel policy to include file commit date using git cmd below. The policy does not apply to non-Intel (C) notices. git log --follow -C90% --format=%ad --date default <file> | tail -1 and then pull just the 4 digit year from the result. Intel copyrights were not added to files where Intel either had no contribution ot the contribution lacked substance (ie license header updates, formatting changes, etc). Contribution date used "--follow -C95%" to get the most accurate date. Note that several files in this patch didn't end the license/(c) block with a blank comment line so these were added as the vast majority of files do have this last blank line. Simply there for consistency. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Id5b7ce4f658fe87132f14139ead58d6e285c04d4 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15192 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Community-CI: Mellanox Build Bot
80 lines
2.4 KiB
C
80 lines
2.4 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (C) 2021 Intel Corporation. All rights reserved.
|
|
*/
|
|
|
|
/**
|
|
* \file
|
|
* SPDK Initialization Helper
|
|
*/
|
|
|
|
#ifndef SPDK_INIT_H
|
|
#define SPDK_INIT_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
#include "spdk/queue.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define SPDK_DEFAULT_RPC_ADDR "/var/tmp/spdk.sock"
|
|
|
|
/**
|
|
* Create the SPDK JSON-RPC server and listen at the provided address. The RPC server is optional and is
|
|
* independent of subsystem initialization. The RPC server can be started and stopped at any time.
|
|
*
|
|
* \param listen_addr Path to a unix domain socket to listen on
|
|
*
|
|
* \return Negated errno on failure. 0 on success.
|
|
*/
|
|
int spdk_rpc_initialize(const char *listen_addr);
|
|
|
|
/**
|
|
* Shut down the SPDK JSON-RPC target
|
|
*/
|
|
void spdk_rpc_finish(void);
|
|
|
|
typedef void (*spdk_subsystem_init_fn)(int rc, void *ctx);
|
|
|
|
/**
|
|
* Begin the initialization process for all SPDK subsystems. SPDK is divided into subsystems at a macro-level
|
|
* and each subsystem automatically registers itself with this library at start up using a C
|
|
* constructor. Further, each subsystem can declare other subsystems that it depends on.
|
|
* Calling this function will correctly initialize all subsystems that are present, in the
|
|
* required order.
|
|
*
|
|
* \param cb_fn Function called when the process is complete.
|
|
* \param cb_arg User context passed to cb_fn.
|
|
*/
|
|
void spdk_subsystem_init(spdk_subsystem_init_fn cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Like spdk_subsystem_init, but additionally configure each subsystem using the provided JSON config
|
|
* file. This will automatically start a JSON RPC server and then stop it.
|
|
*
|
|
* \param json_config_file Path to a JSON config file.
|
|
* \param rpc_addr Path to a unix domain socket to send configuration RPCs to.
|
|
* \param cb_fn Function called when the process is complete.
|
|
* \param cb_arg User context passed to cb_fn.
|
|
* \param stop_on_error Whether to stop initialization if one of the JSON RPCs fails.
|
|
*/
|
|
void spdk_subsystem_init_from_json_config(const char *json_config_file, const char *rpc_addr,
|
|
spdk_subsystem_init_fn cb_fn, void *cb_arg,
|
|
bool stop_on_error);
|
|
|
|
typedef void (*spdk_subsystem_fini_fn)(void *ctx);
|
|
|
|
/**
|
|
* Tear down all of the subsystems in the correct order.
|
|
*
|
|
* \param cb_fn Function called when the process is complete.
|
|
* \param cb_arg User context passed to cb_fn
|
|
*/
|
|
void spdk_subsystem_fini(spdk_subsystem_fini_fn cb_fn, void *cb_arg);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|