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.
27 #if !defined(__GNUC__)
28 #error module code needs GCC visibility extensions
30 #error module code needs GCC visibility extensions
32 # define DSO_PUBLIC __attribute__ ((visibility ("default")))
33 # define DSO_SELF __attribute__ ((visibility ("protected")))
34 # define DSO_LOCAL __attribute__ ((visibility ("hidden")))
37 struct frrmod_runtime
;
40 /* single-line few-word title */
42 /* human-readable version number, should not contain spaces */
44 /* one-paragraph description */
45 const char *description
;
50 /* primary entry point structure to be present in loadable module under
51 * "_frrmod_this_module" dlsym() name
53 * note space for future extensions is reserved below, so other modules
54 * (e.g. memory management, hooks) can add fields
56 * const members/info are in frrmod_info.
58 struct frrmod_runtime
{
59 struct frrmod_runtime
*next
;
61 const struct frrmod_info
*info
;
63 bool finished_loading
;
69 /* space-reserving foo */
70 struct _frrmod_runtime_size
{
71 struct frrmod_runtime r
;
72 /* this will barf if frrmod_runtime exceeds 1024 bytes ... */
73 uint8_t space
[1024 - sizeof(struct frrmod_runtime
)];
75 union _frrmod_runtime_u
{
76 struct frrmod_runtime r
;
77 struct _frrmod_runtime_size s
;
80 extern union _frrmod_runtime_u _frrmod_this_module
;
81 #define THIS_MODULE (&_frrmod_this_module.r)
83 #define FRR_COREMOD_SETUP(...) \
84 static const struct frrmod_info _frrmod_info = {__VA_ARGS__}; \
85 DSO_LOCAL union _frrmod_runtime_u _frrmod_this_module = { \
86 .r.info = &_frrmod_info, \
88 #define FRR_MODULE_SETUP(...) \
89 FRR_COREMOD_SETUP(__VA_ARGS__) \
90 DSO_SELF struct frrmod_runtime *frr_module = &_frrmod_this_module.r;
92 extern struct frrmod_runtime
*frrmod_list
;
94 extern void frrmod_init(struct frrmod_runtime
*modinfo
);
95 extern struct frrmod_runtime
*frrmod_load(const char *spec
, const char *dir
,
96 char *err
, size_t err_len
);
98 /* not implemented yet */
99 extern void frrmod_unload(struct frrmod_runtime
*module
);
106 #endif /* _FRR_MODULE_H */