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