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