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