p2pd: show Git SHA and no version in plugin constructor
[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 #include "olsr.h"
53 #include "builddata.h"
54
55 /* P2PD includes */
56 #include "p2pd.h"               /* InitP2pd(), CloseP2pd() */
57 #include "NetworkInterfaces.h"  /* AddNonOlsrIf */
58
59 static void __attribute__ ((constructor)) my_init(void);
60 static void __attribute__ ((destructor)) my_fini(void);
61
62 //static struct olsr_cookie_info *prune_packet_history_timer_cookie;
63
64 void olsr_plugin_exit(void);
65
66 /* -------------------------------------------------------------------------
67  * Function   : olsrd_plugin_interface_version
68  * Description: Plugin interface version
69  * Input      : none
70  * Output     : none
71  * Return     : P2PD plugin interface version number
72  * Data Used  : none
73  * Notes      : Called by main OLSRD (olsr_load_dl) to check plugin interface
74  *              version
75  * ------------------------------------------------------------------------- */
76 int
77 olsrd_plugin_interface_version(void)
78 {
79   return PLUGIN_INTERFACE_VERSION;
80 }
81
82 /* -------------------------------------------------------------------------
83  * Function   : olsrd_plugin_init
84  * Description: Plugin initialisation
85  * Input      : none
86  * Output     : none
87  * Return     : fail (0) or success (1)
88  * Data Used  : olsr_cnf
89  * Notes      : Called by main OLSRD (init_olsr_plugin) to initialize plugin
90  * ------------------------------------------------------------------------- */
91 int
92 olsrd_plugin_init(void)
93 {
94   return InitP2pd(NULL);
95 }
96
97 /* -------------------------------------------------------------------------
98  * Function   : olsr_plugin_exit
99  * Description: Plugin cleanup
100  * Input      : none
101  * Output     : none
102  * Return     : none
103  * Data Used  : none
104  * Notes      : Called by my_fini() at unload of shared object
105  * ------------------------------------------------------------------------- */
106 void
107 olsr_plugin_exit(void)
108 {
109   CloseP2pd();
110 }
111
112 static const struct olsrd_plugin_parameters plugin_parameters[] = {
113   {.name = "NonOlsrIf",.set_plugin_parameter = &AddNonOlsrIf,.data = NULL},
114   {.name = "P2pdTtl", .set_plugin_parameter = &SetP2pdTtl, .data = NULL },
115   {.name = "UdpDestPort",.set_plugin_parameter = &AddUdpDestPort,.data = NULL},
116   {.name = "UseHashFilter",.set_plugin_parameter = &SetP2pdUseHashFilter,.data = NULL},
117   {.name = "UseTTLDecrement",.set_plugin_parameter = &SetP2pdUseTtlDecrement,.data = NULL},
118 };
119
120 /* -------------------------------------------------------------------------
121  * Function   : olsrd_get_plugin_parameters
122  * Description: Return the parameter table and its size
123  * Input      : none
124  * Output     : params - the parameter table
125  *              size - its size in no. of entries
126  * Return     : none
127  * Data Used  : plugin_parameters
128  * Notes      : Called by main OLSR (init_olsr_plugin) for all plugins
129  * ------------------------------------------------------------------------- */
130 void
131 olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
132 {
133   *params = plugin_parameters;
134   *size = ARRAYSIZE(plugin_parameters);
135 }
136
137 /* -------------------------------------------------------------------------
138  * Function   : my_init
139  * Description: Plugin constructor
140  * Input      : none
141  * Output     : none
142  * Return     : none
143  * Data Used  : none
144  * Notes      : Called at load of shared object
145  * ------------------------------------------------------------------------- */
146 static void
147 my_init(void)
148 {
149   /* Print plugin info to stdout */
150   olsr_printf(0, "%s (%s)\n", PLUGIN_NAME, git_descriptor);
151
152   return;
153 }
154
155 /* -------------------------------------------------------------------------
156  * Function   : my_fini
157  * Description: Plugin destructor
158  * Input      : none
159  * Output     : none
160  * Return     : none
161  * Data Used  : none
162  * Notes      : Called at unload of shared object
163  * ------------------------------------------------------------------------- */
164 static void
165 my_fini(void)
166 {
167   olsr_plugin_exit();
168 }
169
170 /*
171  * Local Variables:
172  * c-basic-offset: 2
173  * indent-tabs-mode: nil
174  * End:
175  */