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