Added missing BSD licenses as well as more exceptions
[olsrd.git] / lib / lq_etx_fpm / src / olsrd_plugin.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
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 olsr.org, olsrd 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
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include "olsrd_plugin.h"
43 #include "lq_plugin_etx_fpm.h"
44 #include "olsr.h"
45 #include "defs.h"
46 #include "plugin.h"
47
48 #include <stdio.h>
49 #include <string.h>
50
51 #define PLUGIN_NAME    "OLSRD lq_etx_fpm plugin"
52 #define PLUGIN_VERSION "0.1"
53 #define PLUGIN_AUTHOR   "Henning Rogge and others"
54 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
55 #define PLUGIN_INTERFACE_VERSION 5
56
57 /****************************************************************************
58  *                Functions that the plugin MUST provide                    *
59  ****************************************************************************/
60
61 /**
62  * Plugin interface version
63  * Used by main olsrd to check plugin interface version
64  */
65 int
66 olsrd_plugin_interface_version(void)
67 {
68   return PLUGIN_INTERFACE_VERSION;
69 }
70
71 static int
72 set_plugin_float(const char *value, void *data, set_plugin_parameter_addon addon __attribute__ ((unused)))
73 {
74   if (data != NULL) {
75     sscanf(value, "%f", (float *)data);
76     OLSR_PRINTF(1, "%s float %f\n", "Got", *(float *)data);
77   } else {
78     OLSR_PRINTF(0, "%s float %s\n", "Ignored", value);
79   }
80   return 0;
81 }
82
83 float lq_aging = DEF_LQ_AGING;
84
85 /**
86  * Register parameters from config file
87  * Called for all plugin parameters
88  */
89 static const struct olsrd_plugin_parameters plugin_parameters[] = {
90   {.name = "LinkQualityAging",.set_plugin_parameter = &set_plugin_float,.data = &lq_aging},
91 };
92
93 void
94 olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
95 {
96   *params = plugin_parameters;
97   *size = ARRAYSIZE(plugin_parameters);
98 }
99
100 /**
101  * Initialize plugin
102  * Called after all parameters are passed
103  */
104 int
105 olsrd_plugin_init(void)
106 {
107   /* Verify parameters */
108   if (lq_aging < MIN_LQ_AGING || lq_aging > MAX_LQ_AGING) {
109     fprintf(stderr, "LQ aging factor %f is not allowed\n", lq_aging);
110     return 0;
111   }
112
113   active_lq_handler = &lq_etxfpm_handler;
114   return 1;
115 }
116
117 /****************************************************************************
118  *       Optional private constructor and destructor functions              *
119  ****************************************************************************/
120
121 /* attention: make static to avoid name clashes */
122
123 static void my_init(void) __attribute__ ((constructor));
124 static void my_fini(void) __attribute__ ((destructor));
125
126 /**
127  * Optional Private Constructor
128  */
129 static void
130 my_init(void)
131 {
132   /* Print plugin info to stdout */
133   printf("%s\n", MOD_DESC);
134 }
135
136 /**
137  * Optional Private Destructor
138  */
139 static void
140 my_fini(void)
141 {
142 }
143
144 /*
145  * Local Variables:
146  * c-basic-offset: 2
147  * indent-tabs-mode: nil
148  * End:
149  */