Convert some plugins to new logger
[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 "plugin.h"
46 #include "plugin_util.h"
47 #include "defs.h" /* uint8_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 #include "olsr_logging.h"
52
53 /* BMF includes */
54 #include "Bmf.h" /* InitBmf(), CloseBmf() */
55 #include "PacketHistory.h" /* InitPacketHistory() */
56 #include "NetworkInterfaces.h" /* AddNonOlsrBmfIf(), SetBmfInterfaceIp(), ... */
57 #include "Address.h" /* DoLocalBroadcast() */
58
59 static void __attribute__ ((constructor)) my_init(void);
60 static void __attribute__ ((destructor)) my_fini(void);
61
62 static struct olsr_cookie_info *prune_packet_history_timer_cookie;
63
64 void olsr_plugin_exit(void);
65
66 /* -------------------------------------------------------------------------
67  * Function   : olsrd_plugin_interface_version
68  * Description: Plugin interface version
69  * Input      : none
70  * Output     : none
71  * Return     : BMF plugin interface version number
72  * Data Used  : none
73  * Notes      : Called by main OLSRD (olsr_load_dl) to check plugin interface
74  *              version
75  * ------------------------------------------------------------------------- */
76 int olsrd_plugin_interface_version(void)
77 {
78   return PLUGIN_INTERFACE_VERSION;
79 }
80
81 /* -------------------------------------------------------------------------
82  * Function   : olsrd_plugin_init
83  * Description: Plugin initialisation
84  * Input      : none
85  * Output     : none
86  * Return     : fail (0) or success (1)
87  * Data Used  : olsr_cnf
88  * Notes      : Called by main OLSRD (init_olsr_plugin) to initialize plugin
89  * ------------------------------------------------------------------------- */
90 int olsrd_plugin_init(void)
91 {
92   /* Check validity */
93   if (olsr_cnf->ip_version != AF_INET)
94   {
95     OLSR_WARN(LOG_PLUGINS, PLUGIN_NAME ": This plugin only supports IPv4!\n");
96     return 0;
97   }
98
99   /* Clear the packet history */
100   InitPacketHistory();
101
102   /* Register ifchange function */
103   add_ifchgf(&InterfaceChange);
104
105   /* create the cookie */
106   prune_packet_history_timer_cookie = olsr_alloc_cookie("BMF: Prune Packet History", OLSR_COOKIE_TYPE_TIMER);
107
108   /* Register the duplicate registration pruning process */
109   olsr_start_timer(3 * MSEC_PER_SEC, 0, OLSR_TIMER_PERIODIC,
110                    &PrunePacketHistory, NULL, prune_packet_history_timer_cookie->ci_id);
111
112
113   return InitBmf(NULL);
114 }
115
116 /* -------------------------------------------------------------------------
117  * Function   : olsr_plugin_exit
118  * Description: Plugin cleanup
119  * Input      : none
120  * Output     : none
121  * Return     : none
122  * Data Used  : none
123  * Notes      : Called by my_fini() at unload of shared object
124  * ------------------------------------------------------------------------- */
125 void olsr_plugin_exit(void)
126 {
127   CloseBmf();
128 }
129
130 static const struct olsrd_plugin_parameters plugin_parameters[] = {
131     { .name = "NonOlsrIf", .set_plugin_parameter = &AddNonOlsrBmfIf, .data = NULL },
132     { .name = "DoLocalBroadcast", .set_plugin_parameter = &DoLocalBroadcast, .data = NULL },
133     { .name = "BmfInterface", .set_plugin_parameter = &SetBmfInterfaceName, .data = NULL },
134     { .name = "BmfInterfaceIp", .set_plugin_parameter = &SetBmfInterfaceIp, .data = NULL },
135     { .name = "CapturePacketsOnOlsrInterfaces", .set_plugin_parameter = &SetCapturePacketsOnOlsrInterfaces, .data = NULL },
136     { .name = "BmfMechanism", .set_plugin_parameter = &SetBmfMechanism, .data = NULL },
137     { .name = "FanOutLimit", .set_plugin_parameter = &SetFanOutLimit, .data = NULL },
138     { .name = "BroadcastRetransmitCount", .set_plugin_parameter = &set_plugin_int, .data = &BroadcastRetransmitCount},
139 };
140
141 /* -------------------------------------------------------------------------
142  * Function   : olsrd_get_plugin_parameters
143  * Description: Return the parameter table and its size
144  * Input      : none
145  * Output     : params - the parameter table
146  *              size - its size in no. of entries
147  * Return     : none
148  * Data Used  : plugin_parameters
149  * Notes      : Called by main OLSR (init_olsr_plugin) for all plugins
150  * ------------------------------------------------------------------------- */
151 void olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
152 {
153     *params = plugin_parameters;
154     *size = ARRAYSIZE(plugin_parameters);
155 }
156
157 /* -------------------------------------------------------------------------
158  * Function   : my_init
159  * Description: Plugin constructor
160  * Input      : none
161  * Output     : none
162  * Return     : none
163  * Data Used  : none
164  * Notes      : Called at load of shared object
165  * ------------------------------------------------------------------------- */
166 static void my_init(void)
167 {
168   /* Print plugin info to stdout */
169   OLSR_INFO(LOG_PLUGINS, "%s\n", MOD_DESC);
170
171   return;
172 }
173
174 /* -------------------------------------------------------------------------
175  * Function   : my_fini
176  * Description: Plugin destructor
177  * Input      : none
178  * Output     : none
179  * Return     : none
180  * Data Used  : none
181  * Notes      : Called at unload of shared object
182  * ------------------------------------------------------------------------- */
183 static void my_fini(void)
184 {
185   olsr_plugin_exit();
186 }
187
188 /*
189  * Local Variables:
190  * c-basic-offset: 2
191  * indent-tabs-mode: nil
192  * End:
193  */