Merge pull request #78 from ffontaine/master
[olsrd.git] / lib / p2pd / src / olsrd_plugin.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 /* System includes */
47 #include <assert.h>             /* assert() */
48 #include <stddef.h>             /* NULL */
49
50 /* OLSRD includes */
51 #include "olsrd_plugin.h"
52 #include "plugin_util.h"
53 #include "defs.h"               /* uint8_t, olsr_cnf */
54 #include "scheduler.h"          /* olsr_start_timer() */
55 #include "olsr_cfg.h"           /* olsr_cnf() */
56 #include "olsr_cookie.h"        /* olsr_alloc_cookie() */
57 #include "olsr.h"
58 #include "builddata.h"
59
60 /* P2PD includes */
61 #include "p2pd.h"               /* InitP2pd(), CloseP2pd() */
62 #include "NetworkInterfaces.h"  /* AddNonOlsrIf */
63
64 static void __attribute__ ((constructor)) my_init(void);
65 static void __attribute__ ((destructor)) my_fini(void);
66
67 //static struct olsr_cookie_info *prune_packet_history_timer_cookie;
68
69 void olsr_plugin_exit(void);
70
71 /* -------------------------------------------------------------------------
72  * Function   : olsrd_plugin_interface_version
73  * Description: Plugin interface version
74  * Input      : none
75  * Output     : none
76  * Return     : P2PD plugin interface version number
77  * Data Used  : none
78  * Notes      : Called by main OLSRD (olsr_load_dl) to check plugin interface
79  *              version
80  * ------------------------------------------------------------------------- */
81 int
82 olsrd_plugin_interface_version(void)
83 {
84   return PLUGIN_INTERFACE_VERSION;
85 }
86
87 /* -------------------------------------------------------------------------
88  * Function   : olsrd_plugin_init
89  * Description: Plugin initialisation
90  * Input      : none
91  * Output     : none
92  * Return     : fail (0) or success (1)
93  * Data Used  : olsr_cnf
94  * Notes      : Called by main OLSRD (init_olsr_plugin) to initialize plugin
95  * ------------------------------------------------------------------------- */
96 int
97 olsrd_plugin_init(void)
98 {
99   return InitP2pd(NULL);
100 }
101
102 /* -------------------------------------------------------------------------
103  * Function   : olsr_plugin_exit
104  * Description: Plugin cleanup
105  * Input      : none
106  * Output     : none
107  * Return     : none
108  * Data Used  : none
109  * Notes      : Called by my_fini() at unload of shared object
110  * ------------------------------------------------------------------------- */
111 void
112 olsr_plugin_exit(void)
113 {
114   CloseP2pd();
115 }
116
117 static const struct olsrd_plugin_parameters plugin_parameters[] = {
118   {.name = "NonOlsrIf",.set_plugin_parameter = &AddNonOlsrIf,.data = NULL},
119   {.name = "P2pdTtl", .set_plugin_parameter = &SetP2pdTtl, .data = NULL },
120   {.name = "UdpDestPort",.set_plugin_parameter = &AddUdpDestPort,.data = NULL},
121   {.name = "UseHashFilter",.set_plugin_parameter = &SetP2pdUseHashFilter,.data = NULL},
122   {.name = "UseTTLDecrement",.set_plugin_parameter = &SetP2pdUseTtlDecrement,.data = NULL},
123 };
124
125 /* -------------------------------------------------------------------------
126  * Function   : olsrd_get_plugin_parameters
127  * Description: Return the parameter table and its size
128  * Input      : none
129  * Output     : params - the parameter table
130  *              size - its size in no. of entries
131  * Return     : none
132  * Data Used  : plugin_parameters
133  * Notes      : Called by main OLSR (init_olsr_plugin) for all plugins
134  * ------------------------------------------------------------------------- */
135 void
136 olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
137 {
138   *params = plugin_parameters;
139   *size = ARRAYSIZE(plugin_parameters);
140 }
141
142 /* -------------------------------------------------------------------------
143  * Function   : my_init
144  * Description: Plugin constructor
145  * Input      : none
146  * Output     : none
147  * Return     : none
148  * Data Used  : none
149  * Notes      : Called at load of shared object
150  * ------------------------------------------------------------------------- */
151 static void
152 my_init(void)
153 {
154   /* Print plugin info to stdout */
155   olsr_printf(0, "%s (%s)\n", PLUGIN_NAME, git_descriptor);
156
157   return;
158 }
159
160 /* -------------------------------------------------------------------------
161  * Function   : my_fini
162  * Description: Plugin destructor
163  * Input      : none
164  * Output     : none
165  * Return     : none
166  * Data Used  : none
167  * Notes      : Called at unload of shared object
168  * ------------------------------------------------------------------------- */
169 static void
170 my_fini(void)
171 {
172   olsr_plugin_exit();
173 }
174
175 /*
176  * Local Variables:
177  * c-basic-offset: 2
178  * indent-tabs-mode: nil
179  * End:
180  */