xref: /spdk/include/spdk_internal/init.h (revision cc6920a4763d4b9a43aa40583c8397d8f14fa100)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.  All rights reserved.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above copyright
13  *       notice, this list of conditions and the following disclaimer in
14  *       the documentation and/or other materials provided with the
15  *       distribution.
16  *     * Neither the name of Intel Corporation nor the names of its
17  *       contributors may be used to endorse or promote products derived
18  *       from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef SPDK_INIT_INTERNAL_H
34 #define SPDK_INIT_INTERNAL_H
35 
36 #include "spdk/stdinc.h"
37 #include "spdk/queue.h"
38 
39 struct spdk_json_write_ctx;
40 
41 struct spdk_subsystem {
42 	const char *name;
43 	/* User must call spdk_subsystem_init_next() when they are done with their initialization. */
44 	void (*init)(void);
45 	void (*fini)(void);
46 
47 	/**
48 	 * Write JSON configuration handler.
49 	 *
50 	 * \param w JSON write context
51 	 */
52 	void (*write_config_json)(struct spdk_json_write_ctx *w);
53 	TAILQ_ENTRY(spdk_subsystem) tailq;
54 };
55 
56 struct spdk_subsystem_depend {
57 	const char *name;
58 	const char *depends_on;
59 	TAILQ_ENTRY(spdk_subsystem_depend) tailq;
60 };
61 
62 void spdk_add_subsystem(struct spdk_subsystem *subsystem);
63 void spdk_add_subsystem_depend(struct spdk_subsystem_depend *depend);
64 
65 void spdk_subsystem_init_next(int rc);
66 void spdk_subsystem_fini_next(void);
67 
68 /**
69  * \brief Register a new subsystem
70  */
71 #define SPDK_SUBSYSTEM_REGISTER(_name) \
72 	__attribute__((constructor)) static void _name ## _register(void)	\
73 	{									\
74 		spdk_add_subsystem(&_name);					\
75 	}
76 
77 /**
78  * \brief Declare that a subsystem depends on another subsystem.
79  */
80 #define SPDK_SUBSYSTEM_DEPEND(_name, _depends_on)						\
81 	static struct spdk_subsystem_depend __subsystem_ ## _name ## _depend_on ## _depends_on = { \
82 	.name = #_name,										\
83 	.depends_on = #_depends_on,								\
84 	};											\
85 	__attribute__((constructor)) static void _name ## _depend_on ## _depends_on(void)	\
86 	{											\
87 		spdk_add_subsystem_depend(&__subsystem_ ## _name ## _depend_on ## _depends_on); \
88 	}
89 
90 #endif
91