Merge branch 'PolynomialDivision-feature/add_workflow'
[olsrd.git] / lib / bmf / src / olsrd_plugin.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 /* -------------------------------------------------------------------------
47  * File       : olsrd_plugin.c
48  * Description: Interface to the OLSRD plugin system
49  * Created    : 29 Jun 2006
50  *
51  * ------------------------------------------------------------------------- */
52
53 /* System includes */
54 #include <assert.h> /* assert() */
55 #include <stddef.h> /* NULL */
56
57 /* OLSRD includes */
58 #include "olsrd_plugin.h"
59 #include "plugin_util.h"
60 #include "defs.h" /* olsr_u8_t, olsr_cnf */
61 #include "scheduler.h" /* olsr_start_timer() */
62 #include "olsr.h"
63 #include "builddata.h"
64
65 /* BMF includes */
66 #include "Bmf.h" /* InitBmf(), CloseBmf() */
67 #include "PacketHistory.h" /* InitPacketHistory() */
68 #include "NetworkInterfaces.h" /* AddNonOlsrBmfIf(), SetBmfInterfaceIp(), ... */
69 #include "Address.h" /* DoLocalBroadcast() */
70
71 static void __attribute__ ((constructor)) my_init(void);
72 static void __attribute__ ((destructor)) my_fini(void);
73
74 void olsr_plugin_exit(void);
75
76 /* -------------------------------------------------------------------------
77  * Function   : olsrd_plugin_interface_version
78  * Description: Plugin interface version
79  * Input      : none
80  * Output     : none
81  * Return     : BMF plugin interface version number
82  * Data Used  : none
83  * Notes      : Called by main OLSRD (olsr_load_dl) to check plugin interface
84  *              version
85  * ------------------------------------------------------------------------- */
86 int olsrd_plugin_interface_version(void)
87 {
88   return PLUGIN_INTERFACE_VERSION;
89 }
90
91 /* -------------------------------------------------------------------------
92  * Function   : olsrd_plugin_init
93  * Description: Plugin initialisation
94  * Input      : none
95  * Output     : none
96  * Return     : fail (0) or success (1)
97  * Data Used  : olsr_cnf
98  * Notes      : Called by main OLSRD (init_olsr_plugin) to initialize plugin
99  * ------------------------------------------------------------------------- */
100 int olsrd_plugin_init(void)
101 {
102   /* Check validity */
103   if (olsr_cnf->ip_version != AF_INET)
104   {
105     fprintf(stderr, PLUGIN_NAME ": This plugin only supports IPv4!\n");
106     return 0;
107   }
108
109   /* Clear the packet history */
110   InitPacketHistory();
111
112   /* Register ifchange function */
113   olsr_add_ifchange_handler(&InterfaceChange);
114
115   /* Register the duplicate registration pruning process */
116   olsr_start_timer(3 * MSEC_PER_SEC, 0, OLSR_TIMER_PERIODIC,
117                    &PrunePacketHistory, NULL, 0);
118
119
120   return InitBmf(NULL);
121 }
122
123 /* -------------------------------------------------------------------------
124  * Function   : olsr_plugin_exit
125  * Description: Plugin cleanup
126  * Input      : none
127  * Output     : none
128  * Return     : none
129  * Data Used  : none
130  * Notes      : Called by my_fini() at unload of shared object
131  * ------------------------------------------------------------------------- */
132 void olsr_plugin_exit(void)
133 {
134   CloseBmf();
135 }
136
137 static const struct olsrd_plugin_parameters plugin_parameters[] = {
138     { .name = "NonOlsrIf", .set_plugin_parameter = &AddNonOlsrBmfIf, .data = NULL },
139     { .name = "DoLocalBroadcast", .set_plugin_parameter = &DoLocalBroadcast, .data = NULL },
140     { .name = "BmfInterface", .set_plugin_parameter = &SetBmfInterfaceName, .data = NULL },
141     { .name = "BmfInterfaceIp", .set_plugin_parameter = &SetBmfInterfaceIp, .data = NULL },
142     { .name = "BmfInterfacePersistent", .set_plugin_parameter = &SetBmfInterfacePersistent, .data = NULL },
143     { .name = "CapturePacketsOnOlsrInterfaces", .set_plugin_parameter = &SetCapturePacketsOnOlsrInterfaces, .data = NULL },
144     { .name = "BmfMechanism", .set_plugin_parameter = &SetBmfMechanism, .data = NULL },
145     { .name = "FanOutLimit", .set_plugin_parameter = &SetFanOutLimit, .data = NULL },
146     { .name = "BroadcastRetransmitCount", .set_plugin_parameter = &set_plugin_int, .data = &BroadcastRetransmitCount},
147 };
148
149 /* -------------------------------------------------------------------------
150  * Function   : olsrd_get_plugin_parameters
151  * Description: Return the parameter table and its size
152  * Input      : none
153  * Output     : params - the parameter table
154  *              size - its size in no. of entries
155  * Return     : none
156  * Data Used  : plugin_parameters
157  * Notes      : Called by main OLSR (init_olsr_plugin) for all plugins
158  * ------------------------------------------------------------------------- */
159 void olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
160 {
161     *params = plugin_parameters;
162     *size = sizeof(plugin_parameters)/sizeof(*plugin_parameters);
163 }
164
165 /* -------------------------------------------------------------------------
166  * Function   : my_init
167  * Description: Plugin constructor
168  * Input      : none
169  * Output     : none
170  * Return     : none
171  * Data Used  : none
172  * Notes      : Called at load of shared object
173  * ------------------------------------------------------------------------- */
174 static void my_init(void)
175 {
176   /* Print plugin info to stdout */
177   olsr_printf(0, "%s (%s)\n", PLUGIN_NAME, git_descriptor);
178
179   return;
180 }
181
182 /* -------------------------------------------------------------------------
183  * Function   : my_fini
184  * Description: Plugin destructor
185  * Input      : none
186  * Output     : none
187  * Return     : none
188  * Data Used  : none
189  * Notes      : Called at unload of shared object
190  * ------------------------------------------------------------------------- */
191 static void my_fini(void)
192 {
193   olsr_plugin_exit();
194 }