bmf: allow marking the BMF network interface as non-persistent
[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
50 /* BMF includes */
51 #include "Bmf.h" /* InitBmf(), CloseBmf() */
52 #include "PacketHistory.h" /* InitPacketHistory() */
53 #include "NetworkInterfaces.h" /* AddNonOlsrBmfIf(), SetBmfInterfaceIp(), ... */
54 #include "Address.h" /* DoLocalBroadcast() */
55
56 static void __attribute__ ((constructor)) my_init(void);
57 static void __attribute__ ((destructor)) my_fini(void);
58
59 void olsr_plugin_exit(void);
60
61 /* -------------------------------------------------------------------------
62  * Function   : olsrd_plugin_interface_version
63  * Description: Plugin interface version
64  * Input      : none
65  * Output     : none
66  * Return     : BMF plugin interface version number
67  * Data Used  : none
68  * Notes      : Called by main OLSRD (olsr_load_dl) to check plugin interface
69  *              version
70  * ------------------------------------------------------------------------- */
71 int olsrd_plugin_interface_version(void)
72 {
73   return PLUGIN_INTERFACE_VERSION;
74 }
75
76 /* -------------------------------------------------------------------------
77  * Function   : olsrd_plugin_init
78  * Description: Plugin initialisation
79  * Input      : none
80  * Output     : none
81  * Return     : fail (0) or success (1)
82  * Data Used  : olsr_cnf
83  * Notes      : Called by main OLSRD (init_olsr_plugin) to initialize plugin
84  * ------------------------------------------------------------------------- */
85 int olsrd_plugin_init(void)
86 {
87   /* Check validity */
88   if (olsr_cnf->ip_version != AF_INET)
89   {
90     fprintf(stderr, PLUGIN_NAME ": This plugin only supports IPv4!\n");
91     return 0;
92   }
93
94   /* Clear the packet history */
95   InitPacketHistory();
96
97   /* Register ifchange function */
98   olsr_add_ifchange_handler(&InterfaceChange);
99
100   /* Register the duplicate registration pruning process */
101   olsr_start_timer(3 * MSEC_PER_SEC, 0, OLSR_TIMER_PERIODIC,
102                    &PrunePacketHistory, NULL, 0);
103
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 olsr_plugin_exit(void)
118 {
119   CloseBmf();
120 }
121
122 static const struct olsrd_plugin_parameters plugin_parameters[] = {
123     { .name = "NonOlsrIf", .set_plugin_parameter = &AddNonOlsrBmfIf, .data = NULL },
124     { .name = "DoLocalBroadcast", .set_plugin_parameter = &DoLocalBroadcast, .data = NULL },
125     { .name = "BmfInterface", .set_plugin_parameter = &SetBmfInterfaceName, .data = NULL },
126     { .name = "BmfInterfaceIp", .set_plugin_parameter = &SetBmfInterfaceIp, .data = NULL },
127     { .name = "BmfInterfacePersistent", .set_plugin_parameter = &SetBmfInterfacePersistent, .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 olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
145 {
146     *params = plugin_parameters;
147     *size = sizeof(plugin_parameters)/sizeof(*plugin_parameters);
148 }
149
150 /* -------------------------------------------------------------------------
151  * Function   : my_init
152  * Description: Plugin constructor
153  * Input      : none
154  * Output     : none
155  * Return     : none
156  * Data Used  : none
157  * Notes      : Called at load of shared object
158  * ------------------------------------------------------------------------- */
159 static void my_init(void)
160 {
161   /* Print plugin info to stdout */
162   printf("%s\n", MOD_DESC);
163
164   return;
165 }
166
167 /* -------------------------------------------------------------------------
168  * Function   : my_fini
169  * Description: Plugin destructor
170  * Input      : none
171  * Output     : none
172  * Return     : none
173  * Data Used  : none
174  * Notes      : Called at unload of shared object
175  * ------------------------------------------------------------------------- */
176 static void my_fini(void)
177 {
178   olsr_plugin_exit();
179 }