* replaced the bmf plugin with the most recent 1.3 from sf.net with the
[olsrd.git] / lib / bmf / src / olsrd_plugin.c
1 /*
2  * OLSR Basic Multicast Forwarding (BMF) plugin.
3  * Copyright (c) 2005, 2006, 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  * $Id: olsrd_plugin.c,v 1.2 2007/02/10 17:05:56 bernd67 Exp $ 
39  * ------------------------------------------------------------------------- */
40
41 /* System includes */
42 #include <assert.h> /* assert() */
43 #include <stdio.h>
44
45 /* OLSRD includes */
46 #include "olsrd_plugin.h"
47 #include "defs.h" /* olsr_u8_t, olsr_cnf */
48 #include "scheduler.h" /* olsr_register_scheduler_event */
49
50 /* BMF includes */
51 #include "Bmf.h" /* InitBmf(), CloseBmf(), RegisterBmfParameter() */
52 #include "PacketHistory.h" /* InitPacketHistory() */
53
54 static void __attribute__ ((constructor)) my_init(void);
55 static void __attribute__ ((destructor)) my_fini(void);
56
57 void olsr_plugin_exit(void);
58
59 /* -------------------------------------------------------------------------
60  * Function   : olsrd_plugin_interface_version
61  * Description: Plugin interface version
62  * Input      : none
63  * Output     : none
64  * Return     : BMF plugin interface version number
65  * Data Used  : none
66  * Notes      : Called by main OLSRD (olsr_load_dl) to check plugin interface
67  *              version
68  * ------------------------------------------------------------------------- */
69 int olsrd_plugin_interface_version()
70 {
71   return OLSRD_PLUGIN_INTERFACE_VERSION;
72 }
73
74 /* -------------------------------------------------------------------------
75  * Function   : olsrd_plugin_init
76  * Description: Plugin initialisation
77  * Input      : none
78  * Output     : none
79  * Return     : fail (0) or success (1)
80  * Data Used  : olsr_cnf
81  * Notes      : Called by main OLSRD (init_olsr_plugin) to initialize plugin
82  * ------------------------------------------------------------------------- */
83 int olsrd_plugin_init()
84 {
85   /* Check validity */
86   if (olsr_cnf->ip_version != AF_INET)
87   {
88     fprintf(stderr, PLUGIN_NAME ": This plugin only supports IPv4!\n");
89     return 0;
90   }
91
92   /* Clear the packet history */
93   InitPacketHistory();
94
95   /* Register ifchange function */
96   add_ifchgf(&InterfaceChange);
97
98   /* Register the duplicate registration pruning process */
99   olsr_register_scheduler_event(&PrunePacketHistory, NULL, 3.0, 2.0, NULL);
100
101   return InitBmf(NULL);
102 }
103
104 /* -------------------------------------------------------------------------
105  * Function   : olsr_plugin_exit
106  * Description: Plugin cleanup
107  * Input      : none
108  * Output     : none
109  * Return     : none
110  * Data Used  : none
111  * Notes      : Called by my_fini() at unload of shared object
112  * ------------------------------------------------------------------------- */
113 void olsr_plugin_exit()
114 {
115   CloseBmf();
116 }
117
118 /* -------------------------------------------------------------------------
119  * Function   : olsrd_plugin_register_param
120  * Description: Register parameters from config file
121  * Input      : key - the parameter name
122  *              value - the parameter value
123  * Output     : none
124  * Return     : fatal error (<0), minor error (0) or success (>0)
125  * Data Used  : none
126  * Notes      : Called by main OLSR (init_olsr_plugin) for all plugin parameters
127  * ------------------------------------------------------------------------- */
128 int olsrd_plugin_register_param(char* key, char* value)
129 {
130   assert(key != NULL && value != NULL);
131
132   return RegisterBmfParameter(key, value);
133 }
134  
135 /* -------------------------------------------------------------------------
136  * Function   : my_init
137  * Description: Plugin constructor
138  * Input      : none
139  * Output     : none
140  * Return     : none
141  * Data Used  : none
142  * Notes      : Called at load of shared object
143  * ------------------------------------------------------------------------- */
144 static void my_init()
145 {
146   /* Print plugin info to stdout */
147   printf("%s\n", MOD_DESC);
148
149   return;
150 }
151
152 /* -------------------------------------------------------------------------
153  * Function   : my_fini
154  * Description: Plugin destructor
155  * Input      : none
156  * Output     : none
157  * Return     : none
158  * Data Used  : none
159  * Notes      : Called at unload of shared object
160  * ------------------------------------------------------------------------- */
161 static void my_fini()
162 {
163   olsr_plugin_exit();
164 }