c8dfae7b8f
Expose spdk_app_json_config_load() in internal to SPDK header. In future patches it will be possible to use this function without depending on rest of event framework (such as app.c). Applications that do not use SPDK reactors (have their own threading model) or no need to initialize using spdk_app_start(), will be able to utilize subsystems and their json configuration loading. Change-Id: I093181977d121e39ddbf212f8dff3182a4102fd6 Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/464178 Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
132 lines
4.4 KiB
C
132 lines
4.4 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_INTERNAL_EVENT_H
|
|
#define SPDK_INTERNAL_EVENT_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#include "spdk/event.h"
|
|
#include "spdk/json.h"
|
|
#include "spdk/thread.h"
|
|
|
|
struct spdk_event {
|
|
uint32_t lcore;
|
|
spdk_event_fn fn;
|
|
void *arg1;
|
|
void *arg2;
|
|
};
|
|
|
|
int spdk_reactors_init(void);
|
|
void spdk_reactors_fini(void);
|
|
|
|
void spdk_reactors_start(void);
|
|
void spdk_reactors_stop(void *arg1);
|
|
|
|
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);
|
|
void (*config)(FILE *fp);
|
|
|
|
/**
|
|
* Write JSON configuration handler.
|
|
*
|
|
* \param w JSON write context
|
|
*/
|
|
void (*write_config_json)(struct spdk_json_write_ctx *w);
|
|
TAILQ_ENTRY(spdk_subsystem) tailq;
|
|
};
|
|
|
|
TAILQ_HEAD(spdk_subsystem_list, spdk_subsystem);
|
|
extern struct spdk_subsystem_list g_subsystems;
|
|
|
|
struct spdk_subsystem *spdk_subsystem_find(struct spdk_subsystem_list *list, const char *name);
|
|
|
|
struct spdk_subsystem_depend {
|
|
const char *name;
|
|
const char *depends_on;
|
|
TAILQ_ENTRY(spdk_subsystem_depend) tailq;
|
|
};
|
|
|
|
TAILQ_HEAD(spdk_subsystem_depend_list, spdk_subsystem_depend);
|
|
extern struct spdk_subsystem_depend_list g_subsystems_deps;
|
|
|
|
void spdk_add_subsystem(struct spdk_subsystem *subsystem);
|
|
void spdk_add_subsystem_depend(struct spdk_subsystem_depend *depend);
|
|
|
|
void spdk_subsystem_init(spdk_msg_fn cb_fn, void *cb_arg);
|
|
void spdk_subsystem_fini(spdk_msg_fn cb_fn, void *cb_arg);
|
|
void spdk_subsystem_init_next(int rc);
|
|
void spdk_subsystem_fini_next(void);
|
|
void spdk_subsystem_config(FILE *fp);
|
|
void spdk_app_json_config_load(const char *json_config_file, const char *rpc_addr,
|
|
spdk_msg_fn cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Save pointed \c subsystem configuration to the JSON write context \c w. In case of
|
|
* error \c null is written to the JSON context.
|
|
*
|
|
* \param w JSON write context
|
|
* \param subsystem the subsystem to query
|
|
*/
|
|
void spdk_subsystem_config_json(struct spdk_json_write_ctx *w, struct spdk_subsystem *subsystem);
|
|
|
|
void spdk_rpc_initialize(const char *listen_addr);
|
|
void spdk_rpc_finish(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 /* SPDK_INTERNAL_EVENT_H */
|