The functions to initialize the SPDK subsystems or tear them down was previously an internal-only API. Make it public for use by applications that aren't leverage SPDK's application framework. Signed-off-by: Ben Walker <benjamin.walker@intel.com> Change-Id: I2ebfd020e6fa4c1947fa1c1a2ac509ce9b0242f8 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6643 Reviewed-by: Tom Nabarro <tom.nabarro@outlook.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Community-CI: Mellanox Build Bot
91 lines
3.1 KiB
C
91 lines
3.1 KiB
C
/*-
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright (c) Intel Corporation. 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.
|
|
*/
|
|
|
|
#ifndef SPDK_INIT_INTERNAL_H
|
|
#define SPDK_INIT_INTERNAL_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
#include "spdk/queue.h"
|
|
|
|
struct spdk_json_write_ctx;
|
|
|
|
struct spdk_subsystem {
|
|
const char *name;
|
|
/* User must call spdk_subsystem_init_next() when they are done with their initialization. */
|
|
void (*init)(void);
|
|
void (*fini)(void);
|
|
|
|
/**
|
|
* Write JSON configuration handler.
|
|
*
|
|
* \param w JSON write context
|
|
*/
|
|
void (*write_config_json)(struct spdk_json_write_ctx *w);
|
|
TAILQ_ENTRY(spdk_subsystem) tailq;
|
|
};
|
|
|
|
struct spdk_subsystem_depend {
|
|
const char *name;
|
|
const char *depends_on;
|
|
TAILQ_ENTRY(spdk_subsystem_depend) tailq;
|
|
};
|
|
|
|
void spdk_add_subsystem(struct spdk_subsystem *subsystem);
|
|
void spdk_add_subsystem_depend(struct spdk_subsystem_depend *depend);
|
|
|
|
void spdk_subsystem_init_next(int rc);
|
|
void spdk_subsystem_fini_next(void);
|
|
|
|
/**
|
|
* \brief Register a new subsystem
|
|
*/
|
|
#define SPDK_SUBSYSTEM_REGISTER(_name) \
|
|
__attribute__((constructor)) static void _name ## _register(void) \
|
|
{ \
|
|
spdk_add_subsystem(&_name); \
|
|
}
|
|
|
|
/**
|
|
* \brief Declare that a subsystem depends on another subsystem.
|
|
*/
|
|
#define SPDK_SUBSYSTEM_DEPEND(_name, _depends_on) \
|
|
static struct spdk_subsystem_depend __subsystem_ ## _name ## _depend_on ## _depends_on = { \
|
|
.name = #_name, \
|
|
.depends_on = #_depends_on, \
|
|
}; \
|
|
__attribute__((constructor)) static void _name ## _depend_on ## _depends_on(void) \
|
|
{ \
|
|
spdk_add_subsystem_depend(&__subsystem_ ## _name ## _depend_on ## _depends_on); \
|
|
}
|
|
|
|
#endif
|