]> git.meshlink.io Git - meshlink/blob - src/devtools.c
Debugging for getifaddrs().
[meshlink] / src / devtools.c
1 /*
2     devtools.c -- Debugging and quality control functions.
3     Copyright (C) 2014, 2017 Guus Sliepen <guus@meshlink.io>
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License along
16     with this program; if not, write to the Free Software Foundation, Inc.,
17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #include "system.h"
21 #include <assert.h>
22
23 #include "logger.h"
24 #include "meshlink_internal.h"
25 #include "node.h"
26 #include "submesh.h"
27 #include "splay_tree.h"
28 #include "netutl.h"
29 #include "xalloc.h"
30
31 #include "devtools.h"
32
33 static void nop_probe(void) {
34         return;
35 }
36
37 static void keyrotate_nop_probe(int stage) {
38         (void)stage;
39         return;
40 }
41
42 static void inviter_commits_first_nop_probe(bool stage) {
43         (void)stage;
44         return;
45 }
46
47 static void sptps_renewal_nop_probe(meshlink_node_t *node) {
48         (void)node;
49         return;
50 }
51
52 void (*devtool_trybind_probe)(void) = nop_probe;
53 void (*devtool_keyrotate_probe)(int stage) = keyrotate_nop_probe;
54 void (*devtool_set_inviter_commits_first)(bool inviter_commited_first) = inviter_commits_first_nop_probe;
55 void (*devtool_adns_resolve_probe)(void) = nop_probe;
56 void (*devtool_sptps_renewal_probe)(meshlink_node_t *node) = sptps_renewal_nop_probe;
57
58 /* Return an array of edges in the current network graph.
59  * Data captures the current state and will not be updated.
60  * Caller must deallocate data when done.
61  */
62 devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_edge_t *edges, size_t *nmemb) {
63         if(!mesh || !nmemb || (*nmemb && !edges)) {
64                 meshlink_errno = MESHLINK_EINVAL;
65                 return NULL;
66         }
67
68         if(pthread_mutex_lock(&mesh->mutex) != 0) {
69                 abort();
70         }
71
72         devtool_edge_t *result = NULL;
73         unsigned int result_size = 0;
74
75         result_size = mesh->edges->count / 2;
76
77         // if result is smaller than edges, we have to dealloc all the excess devtool_edge_t
78         if((size_t)result_size > *nmemb) {
79                 result = xrealloc(edges, result_size * sizeof(*result));
80         } else {
81                 result = edges;
82         }
83
84         if(result) {
85                 devtool_edge_t *p = result;
86                 unsigned int n = 0;
87
88                 for splay_each(edge_t, e, mesh->edges) {
89                         // skip edges that do not represent a two-directional connection
90                         if(!e->reverse || e->reverse->to != e->from) {
91                                 continue;
92                         }
93
94                         // don't count edges twice
95                         if(e->to < e->from) {
96                                 continue;
97                         }
98
99                         assert(n < result_size);
100
101                         p->from = (meshlink_node_t *)e->from;
102                         p->to = (meshlink_node_t *)e->to;
103                         p->address = e->address.storage;
104                         p->weight = e->weight;
105
106                         n++;
107                         p++;
108                 }
109
110                 // shrink result to the actual amount of memory used
111                 result = xrealloc(result, n * sizeof(*result));
112                 *nmemb = n;
113         } else {
114                 *nmemb = 0;
115                 meshlink_errno = MESHLINK_ENOMEM;
116         }
117
118         pthread_mutex_unlock(&mesh->mutex);
119
120         return result;
121 }
122
123 static bool fstrwrite(const char *str, FILE *stream) {
124         assert(stream);
125
126         size_t len = strlen(str);
127
128         if(fwrite((void *)str, 1, len, stream) != len) {
129                 return false;
130         }
131
132         return true;
133 }
134
135 bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream) {
136         assert(stream);
137
138         bool result = true;
139
140         if(pthread_mutex_lock(&mesh->mutex) != 0) {
141                 abort();
142         }
143
144         // export edges and nodes
145         size_t node_count = 0;
146         size_t edge_count = 0;
147
148         meshlink_node_t **nodes = meshlink_get_all_nodes(mesh, NULL, &node_count);
149         devtool_edge_t *edges = devtool_get_all_edges(mesh, NULL, &edge_count);
150
151         if((!nodes && node_count != 0) || (!edges && edge_count != 0)) {
152                 goto fail;
153         }
154
155         // export begin
156         if(!fstrwrite("{\n", stream)) {
157                 goto fail;
158         }
159
160         // export nodes
161         if(!fstrwrite("\t\"nodes\": {\n", stream)) {
162                 goto fail;
163         }
164
165         char buf[16];
166
167         for(size_t i = 0; i < node_count; ++i) {
168                 if(!fstrwrite("\t\t\"", stream) || !fstrwrite(((node_t *)nodes[i])->name, stream) || !fstrwrite("\": {\n", stream)) {
169                         goto fail;
170                 }
171
172                 if(!fstrwrite("\t\t\t\"name\": \"", stream) || !fstrwrite(((node_t *)nodes[i])->name, stream) || !fstrwrite("\",\n", stream)) {
173                         goto fail;
174                 }
175
176                 snprintf(buf, sizeof(buf), "%d", ((node_t *)nodes[i])->devclass);
177
178                 if(!fstrwrite("\t\t\t\"devclass\": ", stream) || !fstrwrite(buf, stream) || !fstrwrite("\n", stream)) {
179                         goto fail;
180                 }
181
182                 if(!fstrwrite((i + 1) != node_count ? "\t\t},\n" : "\t\t}\n", stream)) {
183                         goto fail;
184                 }
185         }
186
187         if(!fstrwrite("\t},\n", stream)) {
188                 goto fail;
189         }
190
191         // export edges
192
193         if(!fstrwrite("\t\"edges\": {\n", stream)) {
194                 goto fail;
195         }
196
197         for(size_t i = 0; i < edge_count; ++i) {
198                 if(!fstrwrite("\t\t\"", stream) || !fstrwrite(edges[i].from->name, stream) || !fstrwrite("_to_", stream) || !fstrwrite(edges[i].to->name, stream) || !fstrwrite("\": {\n", stream)) {
199                         goto fail;
200                 }
201
202                 if(!fstrwrite("\t\t\t\"from\": \"", stream) || !fstrwrite(edges[i].from->name, stream) || !fstrwrite("\",\n", stream)) {
203                         goto fail;
204                 }
205
206                 if(!fstrwrite("\t\t\t\"to\": \"", stream) || !fstrwrite(edges[i].to->name, stream) || !fstrwrite("\",\n", stream)) {
207                         goto fail;
208                 }
209
210                 char *host = NULL, *port = NULL, *address = NULL;
211                 sockaddr2str((const sockaddr_t *)&edges[i].address, &host, &port);
212
213                 if(host && port) {
214                         xasprintf(&address, "{ \"host\": \"%s\", \"port\": %s }", host, port);
215                 }
216
217                 free(host);
218                 free(port);
219
220                 if(!fstrwrite("\t\t\t\"address\": ", stream) || !fstrwrite(address ? address : "null", stream) || !fstrwrite(",\n", stream)) {
221                         free(address);
222                         goto fail;
223                 }
224
225                 free(address);
226
227                 snprintf(buf, sizeof(buf), "%d", edges[i].weight);
228
229                 if(!fstrwrite("\t\t\t\"weight\": ", stream) || !fstrwrite(buf, stream) || !fstrwrite("\n", stream)) {
230                         goto fail;
231                 }
232
233                 if(!fstrwrite((i + 1) != edge_count ? "\t\t},\n" : "\t\t}\n", stream)) {
234                         goto fail;
235                 }
236         }
237
238         if(!fstrwrite("\t}\n", stream)) {
239                 goto fail;
240         }
241
242         // DONE!
243
244         if(!fstrwrite("}", stream)) {
245                 goto fail;
246         }
247
248         goto done;
249
250 fail:
251         result = false;
252
253 done:
254         free(nodes);
255         free(edges);
256
257         pthread_mutex_unlock(&mesh->mutex);
258
259         return result;
260 }
261
262 void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status) {
263         if(!mesh || !node || !status) {
264                 meshlink_errno = MESHLINK_EINVAL;
265                 return;
266         }
267
268         node_t *internal = (node_t *)node;
269
270         if(pthread_mutex_lock(&mesh->mutex) != 0) {
271                 abort();
272         }
273
274         memcpy(&status->status, &internal->status, sizeof status->status);
275         memcpy(&status->address, &internal->address, sizeof status->address);
276         status->mtu = internal->mtu;
277         status->minmtu = internal->minmtu;
278         status->maxmtu = internal->maxmtu;
279         status->mtuprobes = internal->mtuprobes;
280         status->in_packets = internal->in_packets;
281         status->in_bytes = internal->in_bytes;
282         status->out_packets = internal->out_packets;
283         status->out_bytes = internal->out_bytes;
284
285         // Derive UDP connection status
286         if(internal == mesh->self) {
287                 status->udp_status = DEVTOOL_UDP_WORKING;
288         } else if(!internal->status.reachable) {
289                 status->udp_status = DEVTOOL_UDP_IMPOSSIBLE;
290         } else if(!internal->status.validkey) {
291                 status->udp_status = DEVTOOL_UDP_UNKNOWN;
292         } else if(internal->status.udp_confirmed) {
293                 status->udp_status = DEVTOOL_UDP_WORKING;
294         } else if(internal->mtuprobes > 30) {
295                 status->udp_status = DEVTOOL_UDP_FAILED;
296         } else if(internal->mtuprobes > 0) {
297                 status->udp_status = DEVTOOL_UDP_TRYING;
298         } else {
299                 status->udp_status = DEVTOOL_UDP_UNKNOWN;
300         }
301
302         pthread_mutex_unlock(&mesh->mutex);
303 }
304
305 meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb) {
306         if(!mesh || !nmemb || (*nmemb && !submeshes)) {
307                 meshlink_errno = MESHLINK_EINVAL;
308                 return NULL;
309         }
310
311         meshlink_submesh_t **result;
312
313         //lock mesh->nodes
314         if(pthread_mutex_lock(&mesh->mutex) != 0) {
315                 abort();
316         }
317
318         *nmemb = mesh->submeshes->count;
319         result = realloc(submeshes, *nmemb * sizeof(*submeshes));
320
321         if(result) {
322                 meshlink_submesh_t **p = result;
323
324                 for list_each(submesh_t, s, mesh->submeshes) {
325                         *p++ = (meshlink_submesh_t *)s;
326                 }
327         } else {
328                 *nmemb = 0;
329                 free(submeshes);
330                 meshlink_errno = MESHLINK_ENOMEM;
331         }
332
333         pthread_mutex_unlock(&mesh->mutex);
334
335         return result;
336 }
337
338 meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns) {
339         meshlink_open_params_t *params = meshlink_open_params_init(confbase, name, appname, devclass);
340         params->netns = dup(netns);
341         meshlink_handle_t *handle;
342
343         if(params->netns == -1) {
344                 handle = NULL;
345                 meshlink_errno = MESHLINK_EINVAL;
346         } else {
347                 handle = meshlink_open_ex(params);
348         }
349
350         meshlink_open_params_free(params);
351
352         return handle;
353 }
354
355 void devtool_force_sptps_renewal(meshlink_handle_t *mesh, meshlink_node_t *node) {
356         if(!mesh || !node) {
357                 meshlink_errno = MESHLINK_EINVAL;
358                 return;
359         }
360
361         node_t *n = (node_t *)node;
362         connection_t *c = n->connection;
363
364         n->last_req_key = -3600;
365
366         if(c) {
367                 c->last_key_renewal = -3600;
368         }
369 }
370
371 void devtool_set_meta_status_cb(meshlink_handle_t *mesh, meshlink_node_status_cb_t cb) {
372         if(!mesh) {
373                 meshlink_errno = MESHLINK_EINVAL;
374                 return;
375         }
376
377         if(pthread_mutex_lock(&mesh->mutex) != 0) {
378                 abort();
379         }
380
381         mesh->meta_status_cb = cb;
382         pthread_mutex_unlock(&mesh->mutex);
383 }