git.meshlink.io Git - meshlink/blob - 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 trybind_nop_probe(void) {
  34         return;
  35 }
  36
  37 static void keyrotate_nop_probe(int stage) {
  38         (void)stage;
  39         return;
  40 }
  41
  42 void (*devtool_trybind_probe)(void) = trybind_nop_probe;
  43 void (*devtool_keyrotate_probe)(int stage) = keyrotate_nop_probe;
  44
  45 /* Return an array of edges in the current network graph.
  46  * Data captures the current state and will not be updated.
  47  * Caller must deallocate data when done.
  48  */
  49 devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_edge_t *edges, size_t *nmemb) {
  50         if(!mesh || !nmemb || (*nmemb && !edges)) {
  51                 meshlink_errno = MESHLINK_EINVAL;
  52                 return NULL;
  53         }
  54
  55         pthread_mutex_lock(&(mesh->mesh_mutex));
  56
  57         devtool_edge_t *result = NULL;
  58         unsigned int result_size = 0;
  59
  60         result_size = mesh->edges->count / 2;
  61
  62         // if result is smaller than edges, we have to dealloc all the excess devtool_edge_t
  63         if((size_t)result_size > *nmemb) {
  64                 result = realloc(edges, result_size * sizeof(*result));
  65         } else {
  66                 result = edges;
  67         }
  68
  69         if(result) {
  70                 devtool_edge_t *p = result;
  71                 unsigned int n = 0;
  72
  73                 for splay_each(edge_t, e, mesh->edges) {
  74                         // skip edges that do not represent a two-directional connection
  75                         if((!e->reverse) || (e->reverse->to != e->from)) {
  76                                 continue;
  77                         }
  78
  79                         // don't count edges twice
  80                         if(e->to < e->from) {
  81                                 continue;
  82                         }
  83
  84                         assert(n < result_size);
  85
  86                         p->from = (meshlink_node_t *)e->from;
  87                         p->to = (meshlink_node_t *)e->to;
  88                         p->address = e->address.storage;
  89                         p->options = e->options;
  90                         p->weight = e->weight;
  91
  92                         n++;
  93                         p++;
  94                 }
  95
  96                 // shrink result to the actual amount of memory used
  97                 result = realloc(result, n * sizeof(*result));
  98                 *nmemb = n;
  99         } else {
 100                 *nmemb = 0;
 101                 meshlink_errno = MESHLINK_ENOMEM;
 102         }
 103
 104         pthread_mutex_unlock(&(mesh->mesh_mutex));
 105
 106         return result;
 107 }
 108
 109 static bool fstrwrite(const char *str, FILE *stream) {
 110         size_t len = strlen(str);
 111
 112         if(fwrite((void *)str, 1, len, stream) != len) {
 113                 return false;
 114         }
 115
 116         return true;
 117 }
 118
 119 static const char *__itoa(int value) {
 120         static char buffer[sizeof(int) * 8 + 1];        // not thread safe
 121
 122         if(snprintf(buffer, sizeof(buffer), "%d", value) == -1) {
 123                 return "";
 124         }
 125
 126         return buffer;
 127 }
 128
 129 bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream) {
 130         bool result = true;
 131
 132         pthread_mutex_lock(&(mesh->mesh_mutex));
 133
 134         // export edges and nodes
 135         size_t node_count = 0;
 136         size_t edge_count = 0;
 137
 138         meshlink_node_t **nodes = meshlink_get_all_nodes(mesh, NULL, &node_count);
 139         devtool_edge_t *edges = devtool_get_all_edges(mesh, NULL, &edge_count);
 140
 141         if((!nodes && node_count != 0) || (!edges && edge_count != 0)) {
 142                 goto fail;
 143         }
 144
 145         // export begin
 146         if(!fstrwrite("{\n", stream)) {
 147                 goto fail;
 148         }
 149
 150         // export nodes
 151         if(!fstrwrite("\t\"nodes\": {\n", stream)) {
 152                 goto fail;
 153         }
 154
 155         for(size_t i = 0; i < node_count; ++i) {
 156                 if(!fstrwrite("\t\t\"", stream) || !fstrwrite(((node_t *)nodes[i])->name, stream) || !fstrwrite("\": {\n", stream)) {
 157                         goto fail;
 158                 }
 159
 160                 if(!fstrwrite("\t\t\t\"name\": \"", stream) || !fstrwrite(((node_t *)nodes[i])->name, stream) || !fstrwrite("\",\n", stream)) {
 161                         goto fail;
 162                 }
 163
 164                 if(!fstrwrite("\t\t\t\"options\": ", stream) || !fstrwrite(__itoa(((node_t *)nodes[i])->options), stream) || !fstrwrite(",\n", stream)) {
 165                         goto fail;
 166                 }
 167
 168                 if(!fstrwrite("\t\t\t\"devclass\": ", stream) || !fstrwrite(__itoa(((node_t *)nodes[i])->devclass), stream) || !fstrwrite("\n", stream)) {
 169                         goto fail;
 170                 }
 171
 172                 if(!fstrwrite((i + 1) != node_count ? "\t\t},\n" : "\t\t}\n", stream)) {
 173                         goto fail;
 174                 }
 175         }
 176
 177         if(!fstrwrite("\t},\n", stream)) {
 178                 goto fail;
 179         }
 180
 181         // export edges
 182
 183         if(!fstrwrite("\t\"edges\": {\n", stream)) {
 184                 goto fail;
 185         }
 186
 187         for(size_t i = 0; i < edge_count; ++i) {
 188                 if(!fstrwrite("\t\t\"", stream) || !fstrwrite(edges[i].from->name, stream) || !fstrwrite("_to_", stream) || !fstrwrite(edges[i].to->name, stream) || !fstrwrite("\": {\n", stream)) {
 189                         goto fail;
 190                 }
 191
 192                 if(!fstrwrite("\t\t\t\"from\": \"", stream) || !fstrwrite(edges[i].from->name, stream) || !fstrwrite("\",\n", stream)) {
 193                         goto fail;
 194                 }
 195
 196                 if(!fstrwrite("\t\t\t\"to\": \"", stream) || !fstrwrite(edges[i].to->name, stream) || !fstrwrite("\",\n", stream)) {
 197                         goto fail;
 198                 }
 199
 200                 char *host = NULL, *port = NULL, *address = NULL;
 201                 sockaddr2str((const sockaddr_t *)&edges[i].address, &host, &port);
 202
 203                 if(host && port) {
 204                         xasprintf(&address, "{ \"host\": \"%s\", \"port\": %s }", host, port);
 205                 }
 206
 207                 free(host);
 208                 free(port);
 209
 210                 if(!fstrwrite("\t\t\t\"address\": ", stream) || !fstrwrite(address ? address : "null", stream) || !fstrwrite(",\n", stream)) {
 211                         free(address);
 212                         goto fail;
 213                 }
 214
 215                 free(address);
 216
 217                 if(!fstrwrite("\t\t\t\"options\": ", stream) || !fstrwrite(__itoa(edges[i].options), stream) || !fstrwrite(",\n", stream)) {
 218                         goto fail;
 219                 }
 220
 221                 if(!fstrwrite("\t\t\t\"weight\": ", stream) || !fstrwrite(__itoa(edges[i].weight), stream) || !fstrwrite("\n", stream)) {
 222                         goto fail;
 223                 }
 224
 225                 if(!fstrwrite((i + 1) != edge_count ? "\t\t},\n" : "\t\t}\n", stream)) {
 226                         goto fail;
 227                 }
 228         }
 229
 230         if(!fstrwrite("\t}\n", stream)) {
 231                 goto fail;
 232         }
 233
 234         // DONE!
 235
 236         if(!fstrwrite("}", stream)) {
 237                 goto fail;
 238         }
 239
 240         goto done;
 241
 242 fail:
 243         result = false;
 244
 245 done:
 246         free(nodes);
 247         free(edges);
 248
 249         pthread_mutex_unlock(&(mesh->mesh_mutex));
 250
 251         return result;
 252 }
 253
 254 void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status) {
 255         if(!mesh || !node || !status) {
 256                 meshlink_errno = MESHLINK_EINVAL;
 257                 return;
 258         }
 259
 260         node_t *internal = (node_t *)node;
 261
 262         pthread_mutex_lock(&mesh->mesh_mutex);
 263
 264         status->options = internal->options;
 265         memcpy(&status->status, &internal->status, sizeof status->status);
 266         memcpy(&status->address, &internal->address, sizeof status->address);
 267         status->mtu = internal->mtu;
 268         status->minmtu = internal->minmtu;
 269         status->maxmtu = internal->maxmtu;
 270         status->mtuprobes = internal->mtuprobes;
 271         status->in_packets = internal->in_packets;
 272         status->in_bytes = internal->in_bytes;
 273         status->out_packets = internal->out_packets;
 274         status->out_bytes = internal->out_bytes;
 275
 276         // Derive UDP connection status
 277         if(internal == mesh->self) {
 278                 status->udp_status = DEVTOOL_UDP_WORKING;
 279         } else if(!internal->status.reachable) {
 280                 status->udp_status = DEVTOOL_UDP_IMPOSSIBLE;
 281         } else if(!internal->status.validkey) {
 282                 status->udp_status = DEVTOOL_UDP_UNKNOWN;
 283         } else if(internal->status.udp_confirmed) {
 284                 status->udp_status = DEVTOOL_UDP_WORKING;
 285         } else if(internal->mtuprobes > 30) {
 286                 status->udp_status = DEVTOOL_UDP_FAILED;
 287         } else if(internal->mtuprobes > 0) {
 288                 status->udp_status = DEVTOOL_UDP_TRYING;
 289         } else {
 290                 status->udp_status = DEVTOOL_UDP_UNKNOWN;
 291         }
 292
 293         pthread_mutex_unlock(&mesh->mesh_mutex);
 294 }
 295
 296 meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb) {
 297         if(!mesh || !nmemb || (*nmemb && !submeshes)) {
 298                 meshlink_errno = MESHLINK_EINVAL;
 299                 return NULL;
 300         }
 301
 302         meshlink_submesh_t **result;
 303
 304         //lock mesh->nodes
 305         pthread_mutex_lock(&(mesh->mesh_mutex));
 306
 307         *nmemb = mesh->submeshes->count;
 308         result = realloc(submeshes, *nmemb * sizeof(*submeshes));
 309
 310         if(result) {
 311                 meshlink_submesh_t **p = result;
 312
 313                 for list_each(submesh_t, s, mesh->submeshes) {
 314                         *p++ = (meshlink_submesh_t *)s;
 315                 }
 316         } else {
 317                 *nmemb = 0;
 318                 free(submeshes);
 319                 meshlink_errno = MESHLINK_ENOMEM;
 320         }
 321
 322         pthread_mutex_unlock(&(mesh->mesh_mutex));
 323
 324         return result;
 325 }
 326 meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns) {
 327         meshlink_open_params_t *params = meshlink_open_params_init(confbase, name, appname, devclass);
 328         params->netns = dup(netns);
 329         meshlink_handle_t *handle;
 330
 331         if(params->netns == -1) {
 332                 handle = NULL;
 333                 meshlink_errno = MESHLINK_EINVAL;
 334         } else {
 335                 handle = meshlink_open_ex(params);
 336         }
 337
 338         meshlink_open_params_free(params);
 339
 340         return handle;
 341 }