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 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 void (*devtool_trybind_probe)(void) = nop_probe;
  48 void (*devtool_keyrotate_probe)(int stage) = keyrotate_nop_probe;
  49 void (*devtool_set_inviter_commits_first)(bool inviter_commited_first) = inviter_commits_first_nop_probe;
  50 void (*devtool_adns_resolve_probe)(void) = nop_probe;
  51
  52 /* Return an array of edges in the current network graph.
  53  * Data captures the current state and will not be updated.
  54  * Caller must deallocate data when done.
  55  */
  56 devtool_edge_t *devtool_get_all_edges(meshlink_handle_t *mesh, devtool_edge_t *edges, size_t *nmemb) {
  57         if(!mesh || !nmemb || (*nmemb && !edges)) {
  58                 meshlink_errno = MESHLINK_EINVAL;
  59                 return NULL;
  60         }
  61
  62         pthread_mutex_lock(&mesh->mutex);
  63
  64         devtool_edge_t *result = NULL;
  65         unsigned int result_size = 0;
  66
  67         result_size = mesh->edges->count / 2;
  68
  69         // if result is smaller than edges, we have to dealloc all the excess devtool_edge_t
  70         if((size_t)result_size > *nmemb) {
  71                 result = xrealloc(edges, result_size * sizeof(*result));
  72         } else {
  73                 result = edges;
  74         }
  75
  76         if(result) {
  77                 devtool_edge_t *p = result;
  78                 unsigned int n = 0;
  79
  80                 for splay_each(edge_t, e, mesh->edges) {
  81                         // skip edges that do not represent a two-directional connection
  82                         if(!e->reverse || e->reverse->to != e->from) {
  83                                 continue;
  84                         }
  85
  86                         // don't count edges twice
  87                         if(e->to < e->from) {
  88                                 continue;
  89                         }
  90
  91                         assert(n < result_size);
  92
  93                         p->from = (meshlink_node_t *)e->from;
  94                         p->to = (meshlink_node_t *)e->to;
  95                         p->address = e->address.storage;
  96                         p->weight = e->weight;
  97
  98                         n++;
  99                         p++;
 100                 }
 101
 102                 // shrink result to the actual amount of memory used
 103                 result = xrealloc(result, n * sizeof(*result));
 104                 *nmemb = n;
 105         } else {
 106                 *nmemb = 0;
 107                 meshlink_errno = MESHLINK_ENOMEM;
 108         }
 109
 110         pthread_mutex_unlock(&mesh->mutex);
 111
 112         return result;
 113 }
 114
 115 static bool fstrwrite(const char *str, FILE *stream) {
 116         assert(stream);
 117
 118         size_t len = strlen(str);
 119
 120         if(fwrite((void *)str, 1, len, stream) != len) {
 121                 return false;
 122         }
 123
 124         return true;
 125 }
 126
 127 bool devtool_export_json_all_edges_state(meshlink_handle_t *mesh, FILE *stream) {
 128         assert(stream);
 129
 130         bool result = true;
 131
 132         pthread_mutex_lock(&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         char buf[16];
 156
 157         for(size_t i = 0; i < node_count; ++i) {
 158                 if(!fstrwrite("\t\t\"", stream) || !fstrwrite(((node_t *)nodes[i])->name, stream) || !fstrwrite("\": {\n", stream)) {
 159                         goto fail;
 160                 }
 161
 162                 if(!fstrwrite("\t\t\t\"name\": \"", stream) || !fstrwrite(((node_t *)nodes[i])->name, stream) || !fstrwrite("\",\n", stream)) {
 163                         goto fail;
 164                 }
 165
 166                 snprintf(buf, sizeof(buf), "%d", ((node_t *)nodes[i])->devclass);
 167
 168                 if(!fstrwrite("\t\t\t\"devclass\": ", stream) || !fstrwrite(buf, 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                 snprintf(buf, sizeof(buf), "%d", edges[i].weight);
 218
 219                 if(!fstrwrite("\t\t\t\"weight\": ", stream) || !fstrwrite(buf, stream) || !fstrwrite("\n", stream)) {
 220                         goto fail;
 221                 }
 222
 223                 if(!fstrwrite((i + 1) != edge_count ? "\t\t},\n" : "\t\t}\n", stream)) {
 224                         goto fail;
 225                 }
 226         }
 227
 228         if(!fstrwrite("\t}\n", stream)) {
 229                 goto fail;
 230         }
 231
 232         // DONE!
 233
 234         if(!fstrwrite("}", stream)) {
 235                 goto fail;
 236         }
 237
 238         goto done;
 239
 240 fail:
 241         result = false;
 242
 243 done:
 244         free(nodes);
 245         free(edges);
 246
 247         pthread_mutex_unlock(&mesh->mutex);
 248
 249         return result;
 250 }
 251
 252 void devtool_get_node_status(meshlink_handle_t *mesh, meshlink_node_t *node, devtool_node_status_t *status) {
 253         if(!mesh || !node || !status) {
 254                 meshlink_errno = MESHLINK_EINVAL;
 255                 return;
 256         }
 257
 258         node_t *internal = (node_t *)node;
 259
 260         pthread_mutex_lock(&mesh->mutex);
 261
 262         memcpy(&status->status, &internal->status, sizeof status->status);
 263         memcpy(&status->address, &internal->address, sizeof status->address);
 264         status->mtu = internal->mtu;
 265         status->minmtu = internal->minmtu;
 266         status->maxmtu = internal->maxmtu;
 267         status->mtuprobes = internal->mtuprobes;
 268         status->in_packets = internal->in_packets;
 269         status->in_bytes = internal->in_bytes;
 270         status->out_packets = internal->out_packets;
 271         status->out_bytes = internal->out_bytes;
 272
 273         // Derive UDP connection status
 274         if(internal == mesh->self) {
 275                 status->udp_status = DEVTOOL_UDP_WORKING;
 276         } else if(!internal->status.reachable) {
 277                 status->udp_status = DEVTOOL_UDP_IMPOSSIBLE;
 278         } else if(!internal->status.validkey) {
 279                 status->udp_status = DEVTOOL_UDP_UNKNOWN;
 280         } else if(internal->status.udp_confirmed) {
 281                 status->udp_status = DEVTOOL_UDP_WORKING;
 282         } else if(internal->mtuprobes > 30) {
 283                 status->udp_status = DEVTOOL_UDP_FAILED;
 284         } else if(internal->mtuprobes > 0) {
 285                 status->udp_status = DEVTOOL_UDP_TRYING;
 286         } else {
 287                 status->udp_status = DEVTOOL_UDP_UNKNOWN;
 288         }
 289
 290         pthread_mutex_unlock(&mesh->mutex);
 291 }
 292
 293 meshlink_submesh_t **devtool_get_all_submeshes(meshlink_handle_t *mesh, meshlink_submesh_t **submeshes, size_t *nmemb) {
 294         if(!mesh || !nmemb || (*nmemb && !submeshes)) {
 295                 meshlink_errno = MESHLINK_EINVAL;
 296                 return NULL;
 297         }
 298
 299         meshlink_submesh_t **result;
 300
 301         //lock mesh->nodes
 302         pthread_mutex_lock(&mesh->mutex);
 303
 304         *nmemb = mesh->submeshes->count;
 305         result = realloc(submeshes, *nmemb * sizeof(*submeshes));
 306
 307         if(result) {
 308                 meshlink_submesh_t **p = result;
 309
 310                 for list_each(submesh_t, s, mesh->submeshes) {
 311                         *p++ = (meshlink_submesh_t *)s;
 312                 }
 313         } else {
 314                 *nmemb = 0;
 315                 free(submeshes);
 316                 meshlink_errno = MESHLINK_ENOMEM;
 317         }
 318
 319         pthread_mutex_unlock(&mesh->mutex);
 320
 321         return result;
 322 }
 323
 324 meshlink_handle_t *devtool_open_in_netns(const char *confbase, const char *name, const char *appname, dev_class_t devclass, int netns) {
 325         meshlink_open_params_t *params = meshlink_open_params_init(confbase, name, appname, devclass);
 326         params->netns = dup(netns);
 327         meshlink_handle_t *handle;
 328
 329         if(params->netns == -1) {
 330                 handle = NULL;
 331                 meshlink_errno = MESHLINK_EINVAL;
 332         } else {
 333                 handle = meshlink_open_ex(params);
 334         }
 335
 336         meshlink_open_params_free(params);
 337
 338         return handle;
 339 }