2 * Copyright (c) 2015-16 David Lamparter, for NetDEF, Inc.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 struct frrmod_runtime
;
33 /* single-line few-word title */
35 /* human-readable version number, should not contain spaces */
37 /* one-paragraph description */
38 const char *description
;
43 /* primary entry point structure to be present in loadable module under
44 * "_frrmod_this_module" dlsym() name
46 * note space for future extensions is reserved below, so other modules
47 * (e.g. memory management, hooks) can add fields
49 * const members/info are in frrmod_info.
51 struct frrmod_runtime
{
52 struct frrmod_runtime
*next
;
54 const struct frrmod_info
*info
;
56 bool finished_loading
;
62 /* space-reserving foo */
63 struct _frrmod_runtime_size
{
64 struct frrmod_runtime r
;
65 /* this will barf if frrmod_runtime exceeds 1024 bytes ... */
66 uint8_t space
[1024 - sizeof(struct frrmod_runtime
)];
68 union _frrmod_runtime_u
{
69 struct frrmod_runtime r
;
70 struct _frrmod_runtime_size s
;
73 extern union _frrmod_runtime_u _frrmod_this_module
;
74 #define THIS_MODULE (&_frrmod_this_module.r)
76 #define FRR_COREMOD_SETUP(...) \
77 static const struct frrmod_info _frrmod_info = {__VA_ARGS__}; \
78 DSO_LOCAL union _frrmod_runtime_u _frrmod_this_module = {{ \
83 MACRO_REQUIRE_SEMICOLON() /* end */
85 #define FRR_MODULE_SETUP(...) \
86 FRR_COREMOD_SETUP(__VA_ARGS__); \
87 DSO_SELF struct frrmod_runtime *frr_module = &_frrmod_this_module.r; \
88 MACRO_REQUIRE_SEMICOLON() /* end */
90 extern struct frrmod_runtime
*frrmod_list
;
92 extern void frrmod_init(struct frrmod_runtime
*modinfo
);
93 extern struct frrmod_runtime
*frrmod_load(const char *spec
, const char *dir
,
94 void (*pFerrlog
)(const void *,
96 const void *pErrlogCookie
);
98 /* not implemented yet */
99 extern void frrmod_unload(struct frrmod_runtime
*module
);
106 #endif /* _FRR_MODULE_H */