info: lazily initialise the cache
[olsrd.git] / lib / info / info_types.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2015
4  *
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 #ifndef _OLSRD_LIB_INFO_INFO_TYPES_H_
43 #define _OLSRD_LIB_INFO_INFO_TYPES_H_
44
45 #include <stdbool.h>
46 #include <assert.h>
47 #include <netinet/in.h>
48
49 #include "common/autobuf.h"
50
51 #define CACHE_TIMEOUT_DEFAULT 1000
52
53 typedef struct {
54     union olsr_ip_addr accept_ip;
55     union olsr_ip_addr listen_ip;
56     int ipc_port;
57     bool http_headers;
58     bool allow_localhost;
59     bool ipv6_only;
60     long cache_timeout;
61 } info_plugin_config_t;
62
63 #define INFO_PLUGIN_CONFIG_PLUGIN_PARAMETERS(config) \
64   { .name = "port", .set_plugin_parameter = &set_plugin_port, .data = &config.ipc_port }, \
65   { .name = "accept", .set_plugin_parameter = &set_plugin_ipaddress, .data = &config.accept_ip }, \
66   { .name = "listen", .set_plugin_parameter = &set_plugin_ipaddress, .data = &config.listen_ip }, \
67   { .name = "httpheaders", .set_plugin_parameter = &set_plugin_boolean, .data = &config.http_headers }, \
68   { .name = "allowlocalhost", .set_plugin_parameter = &set_plugin_boolean, .data = &config.allow_localhost }, \
69   { .name = "ipv6only", .set_plugin_parameter = &set_plugin_boolean, .data = &config.ipv6_only },\
70   { .name = "cachetimeout", .set_plugin_parameter = &set_plugin_long, .data = &config.cache_timeout }
71
72 /* these provide all of the runtime status info */
73 #define SIW_NEIGHBORS                    0x0000000000000001ULL
74 #define SIW_LINKS                        0x0000000000000002ULL
75 #define SIW_ROUTES                       0x0000000000000004ULL
76 #define SIW_HNA                          0x0000000000000008ULL
77 #define SIW_MID                          0x0000000000000010ULL
78 #define SIW_TOPOLOGY                     0x0000000000000020ULL
79 #define SIW_GATEWAYS                     0x0000000000000040ULL
80 #define SIW_INTERFACES                   0x0000000000000080ULL
81 #define SIW_2HOP                         0x0000000000000100ULL
82 #define SIW_SGW                          0x0000000000000200ULL
83 #define SIW_RUNTIME_ALL (SIW_NEIGHBORS | SIW_LINKS | SIW_ROUTES | SIW_HNA | SIW_MID | SIW_TOPOLOGY | SIW_GATEWAYS | SIW_INTERFACES | SIW_2HOP | SIW_SGW)
84 #define SIW_NEIGHBORS_FREIFUNK (SIW_NEIGHBORS | SIW_LINKS) /* special */
85
86 /* these only change at olsrd startup */
87 #define SIW_VERSION                      0x0000000000000400ULL
88 #define SIW_CONFIG                       0x0000000000000800ULL
89 #define SIW_PLUGINS                      0x0000000000001000ULL
90 #define SIW_STARTUP_ALL (SIW_VERSION | SIW_CONFIG | SIW_PLUGINS)
91
92 /* this is everything in normal format */
93 #define SIW_ALL (SIW_RUNTIME_ALL | SIW_STARTUP_ALL)
94
95 /* this data is not normal format but olsrd.conf format */
96 #define SIW_OLSRD_CONF                   0x0000000000002000ULL
97
98 typedef void (*init_plugin)(const char *plugin_name);
99 typedef bool (*command_matcher)(const char *str, unsigned long long siw);
100 typedef long (*cache_timeout_func)(info_plugin_config_t *plugin_config, unsigned long long siw);
101 typedef const char * (*mime_type)(unsigned int send_what);
102 typedef void (*output_start_end)(struct autobuf *abuf);
103 typedef void (*printer_error)(struct autobuf *abuf, unsigned int status, const char * req, bool http_headers);
104 typedef void (*printer_generic)(struct autobuf *abuf);
105
106 typedef struct {
107     bool supportsCompositeCommands;
108     init_plugin init;
109     command_matcher is_command;
110     cache_timeout_func cache_timeout;
111     mime_type determine_mime_type;
112     output_start_end output_start;
113     output_start_end output_end;
114     printer_error output_error;
115     printer_generic neighbors;
116     printer_generic links;
117     printer_generic routes;
118     printer_generic topology;
119     printer_generic hna;
120     printer_generic mid;
121     printer_generic gateways;
122     printer_generic sgw;
123     printer_generic version;
124     printer_generic olsrd_conf;
125     printer_generic interfaces;
126     printer_generic twohop;
127     printer_generic config;
128     printer_generic plugins;
129 } info_plugin_functions_t;
130
131 struct info_cache_entry_t {
132     bool initialised;
133     long long timestamp;
134     struct autobuf buf;
135 };
136
137 struct info_cache_t {
138     struct info_cache_entry_t neighbors;
139     struct info_cache_entry_t links;
140     struct info_cache_entry_t routes;
141     struct info_cache_entry_t hna;
142     struct info_cache_entry_t mid;
143     struct info_cache_entry_t topology;
144     struct info_cache_entry_t gateways;
145     struct info_cache_entry_t interfaces;
146     struct info_cache_entry_t twohop;
147     struct info_cache_entry_t sgw;
148
149     struct info_cache_entry_t version;
150     struct info_cache_entry_t config;
151     struct info_cache_entry_t plugins;
152 };
153
154 static INLINE struct info_cache_entry_t * info_cache_get_entry(struct info_cache_t * cache, unsigned long long siw) {
155   struct info_cache_entry_t * r = NULL;
156
157   if (!cache) {
158     return r;
159   }
160
161   switch (siw) {
162     case SIW_NEIGHBORS:
163       r = &cache->neighbors;
164       break;
165
166     case SIW_LINKS:
167       r = &cache->links;
168       break;
169
170     case SIW_ROUTES:
171       r = &cache->routes;
172       break;
173
174     case SIW_HNA:
175       r = &cache->hna;
176       break;
177
178     case SIW_MID:
179       r = &cache->mid;
180       break;
181
182     case SIW_TOPOLOGY:
183       r = &cache->topology;
184       break;
185
186     case SIW_GATEWAYS:
187       r = &cache->gateways;
188       break;
189
190     case SIW_INTERFACES:
191       r = &cache->interfaces;
192       break;
193
194     case SIW_2HOP:
195       r = &cache->twohop;
196       break;
197
198     case SIW_SGW:
199       r = &cache->sgw;
200       break;
201
202     case SIW_VERSION:
203       r = &cache->version;
204       break;
205
206     case SIW_CONFIG:
207       r = &cache->config;
208       break;
209
210     case SIW_PLUGINS:
211       r = &cache->plugins;
212       break;
213
214     default:
215       /* not cached */
216       break;
217   }
218
219   return r;
220 }
221
222 static INLINE void info_plugin_config_init(info_plugin_config_t *config, unsigned short port) {
223   assert(config);
224
225   if (olsr_cnf->ip_version == AF_INET) {
226     config->accept_ip.v4.s_addr = htonl(INADDR_LOOPBACK);
227     config->listen_ip.v4.s_addr = htonl(INADDR_ANY);
228   } else {
229     config->accept_ip.v6 = in6addr_loopback;
230     config->listen_ip.v6 = in6addr_any;
231   }
232
233   config->ipc_port = port;
234   config->http_headers = true;
235   config->allow_localhost = false;
236   config->ipv6_only = false;
237   config->cache_timeout = CACHE_TIMEOUT_DEFAULT;
238 }
239
240 #endif /* _OLSRD_LIB_INFO_INFO_TYPES_H_ */