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