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