src/cadet/gnunet-service-cadet_paths.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2017 GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file cadet/gnunet-service-cadet_paths.c
  22  * @brief Information we track per path.
  23  * @author Bartlomiej Polot
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet-service-cadet_connection.h"
  28 #include "gnunet-service-cadet_tunnels.h"
  29 #include "gnunet-service-cadet_peer.h"
  30 #include "gnunet-service-cadet_paths.h"
  31
  32
  33 #define LOG(level, ...) GNUNET_log_from(level,"cadet-pat",__VA_ARGS__)
  34
  35
  36 /**
  37  * Information regarding a possible path to reach a peer.
  38  */
  39 struct CadetPeerPath
  40 {
  41
  42   /**
  43    * Array of all the peers on the path.  If @e hn is non-NULL, the
  44    * last one is our owner.
  45    */
  46   struct CadetPeerPathEntry **entries;
  47
  48   /**
  49    * Node of this path in the owner's heap.  Used to update our position
  50    * in the heap whenever our @e desirability changes.
  51    */
  52   struct GNUNET_CONTAINER_HeapNode *hn;
  53
  54   /**
  55    * Desirability of the path. How unique is it for the various peers
  56    * on it?
  57    */
  58   GNUNET_CONTAINER_HeapCostType desirability;
  59
  60   /**
  61    * Length of the @e entries array.
  62    */
  63   unsigned int entries_length;
  64
  65 };
  66
  67
  68 /**
  69  * Calculate the path's desirability score.
  70  *
  71  * @param path path to calculate the score for
  72  */
  73 static void
  74 recalculate_path_desirability (struct CadetPeerPath *path)
  75 {
  76   double result = 0.0;
  77
  78   for (unsigned int i=0;i<path->entries_length;i++)
  79   {
  80     struct CadetPeer *cp = path->entries[i]->peer;
  81
  82     result += GCP_get_desirability_of_path (cp,
  83                                             i);
  84   }
  85   path->desirability = (GNUNET_CONTAINER_HeapCostType) result;
  86 }
  87
  88
  89 /**
  90  * Return how much we like keeping the path.  This is an aggregate
  91  * score based on various factors, including the age of the path
  92  * (older == better), and the value of this path to all of its ajacent
  93  * peers.  For example, long paths that end at a peer that we have no
  94  * shorter way to reach are very desirable, while long paths that end
  95  * at a peer for which we have a shorter way as well are much less
  96  * desirable.  Higher values indicate more valuable paths.  The
  97  * returned value should be used to decide which paths to remember.
  98  *
  99  * @param path path to return the length for
 100  * @return desirability of the path, larger is more desirable
 101  */
 102 GNUNET_CONTAINER_HeapCostType
 103 GCPP_get_desirability (const struct CadetPeerPath *path)
 104 {
 105   return path->desirability;
 106 }
 107
 108
 109 /**
 110  * Return connection to @a destination using @a path, or return
 111  * NULL if no such connection exists.
 112  *
 113  * @param path path to traverse
 114  * @param destination destination node to get to, must be on path
 115  * @param off offset of @a destination on @a path
 116  * @return NULL if we have no existing connection
 117  *         otherwise connection from us to @a destination via @a path
 118  */
 119 struct CadetConnection *
 120 GCPP_get_connection (struct CadetPeerPath *path,
 121                      struct CadetPeer *destination,
 122                      unsigned int off)
 123 {
 124   struct CadetPeerPathEntry *entry;
 125
 126   GNUNET_assert (off < path->entries_length);
 127   entry = path->entries[off];
 128   GNUNET_assert (entry->peer == destination);
 129   return entry->cc;
 130 }
 131
 132
 133 /**
 134  * Notify @a path that it is used for connection @a cc
 135  * which ends at the path's offset @a off.
 136  *
 137  * @param path the path to remember the @a cc
 138  * @param off the offset where the @a cc ends
 139  * @param cc the connection to remember
 140  */
 141 void
 142 GCPP_add_connection (struct CadetPeerPath *path,
 143                      unsigned int off,
 144                      struct CadetConnection *cc)
 145 {
 146   struct CadetPeerPathEntry *entry;
 147
 148   LOG (GNUNET_ERROR_TYPE_DEBUG,
 149        "Adding connection %s to path %s at offset %u\n",
 150        GCC_2s (cc),
 151        GCPP_2s (path),
 152        off);
 153   GNUNET_assert (off < path->entries_length);
 154   entry = path->entries[off];
 155   GNUNET_assert (NULL == entry->cc);
 156   GNUNET_assert (NULL != cc);
 157   entry->cc = cc;
 158 }
 159
 160
 161
 162 /**
 163  * Notify @a path that it is no longer used for connection @a cc which
 164  * ended at the path's offset @a off.
 165  *
 166  * @param path the path to forget the @a cc
 167  * @param off the offset where the @a cc ended
 168  * @param cc the connection to forget
 169  */
 170 void
 171 GCPP_del_connection (struct CadetPeerPath *path,
 172                      unsigned int off,
 173                      struct CadetConnection *cc)
 174 {
 175   struct CadetPeerPathEntry *entry;
 176
 177   LOG (GNUNET_ERROR_TYPE_DEBUG,
 178        "Removing connection %s to path %s at offset %u\n",
 179        GCC_2s (cc),
 180        GCPP_2s (path),
 181        off);
 182   GNUNET_assert (off < path->entries_length); /* FIXME: #4909: This assertion fails sometimes! */
 183   entry = path->entries[off];
 184   GNUNET_assert (cc == entry->cc);
 185   entry->cc = NULL;
 186 }
 187
 188
 189 /**
 190  * This path is no longer needed, free resources.
 191  *
 192  * @param path path resources to free
 193  */
 194 static void
 195 path_destroy (struct CadetPeerPath *path)
 196 {
 197   LOG (GNUNET_ERROR_TYPE_DEBUG,
 198        "Destroying path %s\n",
 199        GCPP_2s (path));
 200   for (unsigned int i=0;i<path->entries_length;i++)
 201   {
 202     struct CadetPeerPathEntry *entry = path->entries[i];
 203
 204     if (NULL != entry->cc)
 205     {
 206       struct CadetTConnection *ct;
 207
 208       ct = GCC_get_ct (entry->cc);
 209       if (NULL != ct)
 210         GCT_connection_lost (ct);
 211       GCC_destroy_without_tunnel (entry->cc);
 212     }
 213     GNUNET_free (entry);
 214   }
 215   GNUNET_free (path->entries);
 216   GNUNET_free (path);
 217 }
 218
 219
 220 /**
 221  * The owning peer of this path is no longer interested in maintaining
 222  * it, so the path should be discarded or shortened (in case a
 223  * previous peer on the path finds the path desirable).
 224  *
 225  * @param path the path that is being released
 226  */
 227 void
 228 GCPP_release (struct CadetPeerPath *path)
 229 {
 230   struct CadetPeerPathEntry *entry;
 231   int force;
 232
 233   LOG (GNUNET_ERROR_TYPE_DEBUG,
 234        "Owner releases path %s\n",
 235        GCPP_2s (path));
 236   path->hn = NULL;
 237   entry = path->entries[path->entries_length - 1];
 238   GNUNET_assert (path == entry->path);
 239   while (1)
 240   {
 241     /* cut 'off' end of path */
 242     GNUNET_assert (NULL == entry->cc);
 243     GCP_path_entry_remove (entry->peer,
 244                            entry,
 245                            path->entries_length - 1);
 246     path->entries_length--; /* We don't bother shrinking the 'entries' array,
 247                                as it's probably not worth it. */
 248     GNUNET_free (entry);
 249     if (0 == path->entries_length)
 250       break; /* the end */
 251
 252     /* see if new peer at the end likes this path any better */
 253     entry = path->entries[path->entries_length - 1];
 254     GNUNET_assert (path == entry->path);
 255     force = (NULL == entry->cc) ? GNUNET_NO : GNUNET_YES;
 256     path->hn = GCP_attach_path (entry->peer,
 257                                 path,
 258                                 path->entries_length - 1,
 259                                 force);
 260     if (NULL != path->hn)
 261       return; /* yep, got attached, we are done. */
 262     GNUNET_assert (GNUNET_NO == force);
 263   }
 264
 265   /* nobody wants us, discard the path */
 266   path_destroy (path);
 267 }
 268
 269
 270 /**
 271  * Updates the score for an entry on the path based
 272  * on our experiences with using @a path.
 273  *
 274  * @param path the path to update
 275  * @param off offset of the entry to update
 276  * @param delta change in the score to apply
 277  */
 278 void
 279 GCPP_update_score (struct CadetPeerPath *path,
 280                    unsigned int off,
 281                    int delta)
 282 {
 283   struct CadetPeerPathEntry *entry;
 284
 285   GNUNET_assert (off < path->entries_length);
 286   entry = path->entries[off];
 287
 288   /* Add delta, with checks for overflows */
 289   if (delta >= 0)
 290   {
 291     if (delta + entry->score < entry->score)
 292       entry->score = INT_MAX;
 293     else
 294       entry->score += delta;
 295   }
 296   else
 297   {
 298     if (delta + entry->score > entry->score)
 299       entry->score = INT_MIN;
 300     else
 301       entry->score += delta;
 302   }
 303   recalculate_path_desirability (path);
 304 }
 305
 306
 307 /**
 308  * Closure for #find_peer_at() and #check_match().
 309  */
 310 struct CheckMatchContext
 311 {
 312
 313   /**
 314    * Set to a matching path, if any.
 315    */
 316   struct CadetPeerPath *match;
 317
 318   /**
 319    * Array the combined paths.
 320    */
 321   struct CadetPeer **cpath;
 322
 323   /**
 324    * How long is the @e cpath array?
 325    */
 326   unsigned int cpath_length;
 327
 328 };
 329
 330
 331 /**
 332  * Check if the given path is identical on all of the
 333  * hops until @a off, and not longer than @a off.  If the
 334  * @a path matches, store it in `match`.
 335  *
 336  * @param cls the `struct CheckMatchContext` to check against
 337  * @param path the path to check
 338  * @param off offset to check at
 339  * @return #GNUNET_YES (continue to iterate), or if found #GNUNET_NO
 340  */
 341 static int
 342 check_match (void *cls,
 343              struct CadetPeerPath *path,
 344              unsigned int off)
 345 {
 346   struct CheckMatchContext *cm_ctx = cls;
 347
 348   GNUNET_assert (path->entries_length > off);
 349   if ( (path->entries_length != off + 1) &&
 350        (off + 1 != cm_ctx->cpath_length) )
 351   {
 352     LOG (GNUNET_ERROR_TYPE_DEBUG,
 353          "check_match missmatch because path %s is too long (%u vs. %u vs. %u)\n",
 354          GCPP_2s (path),
 355          path->entries_length,
 356          off + 1,
 357          cm_ctx->cpath_length);
 358     return GNUNET_YES; /* too long, goes somewhere else already, thus cannot be useful */
 359   }
 360   for (unsigned int i=0;i<off;i++)
 361     if (cm_ctx->cpath[i] !=
 362         GCPP_get_peer_at_offset (path,
 363                                  i))
 364     {
 365       LOG (GNUNET_ERROR_TYPE_DEBUG,
 366            "check_match path %s missmatches at offset %u\n",
 367            GCPP_2s (path),
 368            i);
 369       return GNUNET_YES; /* missmatch, ignore */
 370     }
 371   LOG (GNUNET_ERROR_TYPE_DEBUG,
 372        "check_match found match with path %s\n",
 373        GCPP_2s (path));
 374   cm_ctx->match = path;
 375   return GNUNET_NO; /* match, we are done! */
 376 }
 377
 378
 379 /**
 380  * Extend path @a path by the @a num_peers from the @a peers
 381  * array, assuming the owners past the current owner want it.
 382  *
 383  * @param path path to extend
 384  * @param peers list of peers beyond the end of @a path
 385  * @param num_peers length of the @a peers array
 386  * @param force force attachment, even if we have other
 387  *        paths already
 388  */
 389 static void
 390 extend_path (struct CadetPeerPath *path,
 391              struct CadetPeer **peers,
 392              unsigned int num_peers,
 393              int force)
 394 {
 395   unsigned int old_len = path->entries_length;
 396   int i;
 397
 398   /* Expand path */
 399   GNUNET_array_grow (path->entries,
 400                      path->entries_length,
 401                      old_len + num_peers);
 402   for (i=num_peers-1;i >= 0;i--)
 403   {
 404     struct CadetPeerPathEntry *entry = GNUNET_new (struct CadetPeerPathEntry);
 405
 406     path->entries[old_len + i] = entry;
 407     entry->peer = peers[i];
 408     entry->path = path;
 409   }
 410   for (i=num_peers-1;i >= 0;i--)
 411   {
 412     struct CadetPeerPathEntry *entry = path->entries[old_len + i];
 413
 414     GCP_path_entry_add (entry->peer,
 415                         entry,
 416                         old_len + i);
 417   }
 418
 419   /* If we extend an existing path, detach it from the
 420      old owner and re-attach to the new one */
 421   GCP_detach_path (path->entries[old_len-1]->peer,
 422                    path,
 423                    path->hn);
 424   path->hn = NULL;
 425   for (i=num_peers-1;i>=0;i--)
 426   {
 427     struct CadetPeerPathEntry *entry = path->entries[old_len + i];
 428
 429     path->entries_length = old_len + i + 1;
 430     recalculate_path_desirability (path);
 431     if (NULL != entry->cc)
 432       force = GNUNET_YES;
 433     path->hn = GCP_attach_path (peers[i],
 434                                 path,
 435                                 old_len + (unsigned int) i,
 436                                 force);
 437     if (NULL != path->hn)
 438       break;
 439     GCP_path_entry_remove (entry->peer,
 440                            entry,
 441                            old_len + i);
 442     GNUNET_free (entry);
 443     path->entries[old_len + i] = NULL;
 444   }
 445   if (NULL == path->hn)
 446   {
 447     /* none of the peers is interested in this path;
 448        shrink path back and re-attach. */
 449     GNUNET_array_grow (path->entries,
 450                        path->entries_length,
 451                        old_len);
 452     path->hn = GCP_attach_path (path->entries[old_len - 1]->peer,
 453                                 path,
 454                                 old_len - 1,
 455                                 GNUNET_YES);
 456     GNUNET_assert (NULL != path->hn);
 457     return;
 458   }
 459   LOG (GNUNET_ERROR_TYPE_DEBUG,
 460        "Extended path %s\n",
 461        GCPP_2s (path));
 462 }
 463
 464
 465 /**
 466  * Create a peer path based on the result of a DHT lookup.  If we
 467  * already know this path, or one that is longer, simply return NULL.
 468  * Otherwise, we try to extend an existing path, or create a new one
 469  * if applicable.
 470  *
 471  * @param get_path path of the get request
 472  * @param get_path_length lenght of @a get_path
 473  * @param put_path path of the put request
 474  * @param put_path_length length of the @a put_path
 475  * @return a path through the network
 476  */
 477 void
 478 GCPP_try_path_from_dht (const struct GNUNET_PeerIdentity *get_path,
 479                         unsigned int get_path_length,
 480                         const struct GNUNET_PeerIdentity *put_path,
 481                         unsigned int put_path_length)
 482 {
 483   struct CadetPeer *cpath[get_path_length + put_path_length];
 484   struct CheckMatchContext cm_ctx;
 485   struct CadetPeerPath *path;
 486   struct GNUNET_CONTAINER_HeapNode *hn;
 487   int i;
 488   unsigned int skip;
 489   unsigned int total_len;
 490
 491   /* precompute 'cpath' so we can avoid doing the lookups lots of times */
 492   skip = 0;
 493   memset (cpath,
 494           0,
 495           sizeof (cpath)); /* Just to trigger harder errors later. */
 496   total_len = get_path_length + put_path_length;
 497   for (unsigned int off=0;off<total_len;off++)
 498   {
 499     const struct GNUNET_PeerIdentity *pid;
 500
 501     pid = (off < get_path_length)
 502       ? &get_path[get_path_length - off - 1]
 503       : &put_path[get_path_length + put_path_length - off - 1];
 504     cpath[off - skip] = GCP_get (pid,
 505                                  GNUNET_YES);
 506     /* Check that no peer is twice on the path */
 507     for (unsigned int i=0;i<off - skip;i++)
 508     {
 509      if (cpath[i] == cpath[off - skip])
 510       {
 511         skip = off - i;
 512         break;
 513       }
 514     }
 515   }
 516   total_len -= skip;
 517
 518   /* First figure out if this path is a subset of an existing path, an
 519      extension of an existing path, or a new path. */
 520   cm_ctx.cpath_length = total_len;
 521   cm_ctx.cpath = cpath;
 522   cm_ctx.match = NULL;
 523   for (i=total_len-1;i>=0;i--)
 524   {
 525     GCP_iterate_paths_at (cpath[i],
 526                           (unsigned int) i,
 527                           &check_match,
 528                           &cm_ctx);
 529     if (NULL != cm_ctx.match)
 530     {
 531       if (i == total_len - 1)
 532       {
 533         /* Existing path includes this one, nothing to do! */
 534         LOG (GNUNET_ERROR_TYPE_DEBUG,
 535              "Path discovered from DHT is already known\n");
 536         return;
 537       }
 538       if (cm_ctx.match->entries_length == i + 1)
 539       {
 540         /* Existing path ends in the middle of new path, extend it! */
 541         LOG (GNUNET_ERROR_TYPE_DEBUG,
 542              "Trying to extend existing path %s by additional links discovered from DHT\n",
 543              GCPP_2s (cm_ctx.match));
 544         extend_path (cm_ctx.match,
 545                      &cpath[i + 1],
 546                      total_len - i - 1,
 547                      GNUNET_NO);
 548         return;
 549       }
 550     }
 551   }
 552
 553   /* No match at all, create completely new path */
 554   path = GNUNET_new (struct CadetPeerPath);
 555   path->entries_length = total_len;
 556   path->entries = GNUNET_new_array (path->entries_length,
 557                                     struct CadetPeerPathEntry *);
 558   for (i=path->entries_length-1;i>=0;i--)
 559   {
 560     struct CadetPeerPathEntry *entry = GNUNET_new (struct CadetPeerPathEntry);
 561
 562     path->entries[i] = entry;
 563     entry->peer = cpath[i];
 564     entry->path = path;
 565   }
 566   for (i=path->entries_length-1;i>=0;i--)
 567   {
 568     struct CadetPeerPathEntry *entry = path->entries[i];
 569
 570     GCP_path_entry_add (entry->peer,
 571                         entry,
 572                         i);
 573   }
 574
 575   /* Finally, try to attach it */
 576   hn = NULL;
 577   for (i=total_len-1;i>=0;i--)
 578   {
 579     struct CadetPeerPathEntry *entry = path->entries[i];
 580
 581     path->entries_length = i + 1;
 582     recalculate_path_desirability (path);
 583     hn = GCP_attach_path (cpath[i],
 584                           path,
 585                           (unsigned int) i,
 586                           GNUNET_NO);
 587     if (NULL != hn)
 588       break;
 589     GCP_path_entry_remove (entry->peer,
 590                            entry,
 591                            i);
 592     GNUNET_free (entry);
 593     path->entries[i] = NULL;
 594   }
 595   if (NULL == hn)
 596   {
 597     /* None of the peers on the path care about it. */
 598     LOG (GNUNET_ERROR_TYPE_DEBUG,
 599          "Path discovered from DHT is not interesting to us\n");
 600     GNUNET_free (path->entries);
 601     GNUNET_free (path);
 602     return;
 603   }
 604   path->hn = hn;
 605   /* Shrink path to actual useful length */
 606   GNUNET_array_grow (path->entries,
 607                      path->entries_length,
 608                      i + 1);
 609   LOG (GNUNET_ERROR_TYPE_DEBUG,
 610        "Created new path %s based on information from DHT\n",
 611        GCPP_2s (path));
 612 }
 613
 614
 615 /**
 616  * We got an incoming connection, obtain the corresponding path.
 617  *
 618  * @param path_length number of segments on the @a path
 619  * @param pids path through the network, in reverse order (we are at the end at index @a path_length)
 620  * @return corresponding path object
 621  */
 622 struct CadetPeerPath *
 623 GCPP_get_path_from_route (unsigned int path_length,
 624                           const struct GNUNET_PeerIdentity *pids)
 625 {
 626   struct CheckMatchContext cm_ctx;
 627   struct CadetPeer *cpath[path_length];
 628   struct CadetPeerPath *path;
 629
 630   /* precompute inverted 'cpath' so we can avoid doing the lookups and
 631      have the correct order */
 632   for (unsigned int off=0;off<path_length;off++)
 633     cpath[off] = GCP_get (&pids[path_length - 1 - off],
 634                           GNUNET_YES);
 635
 636   /* First figure out if this path is a subset of an existing path, an
 637      extension of an existing path, or a new path. */
 638   cm_ctx.cpath = cpath;
 639   cm_ctx.cpath_length = path_length;
 640   cm_ctx.match = NULL;
 641   for (int i=path_length-1;i>=0;i--)
 642   {
 643     GCP_iterate_paths_at (cpath[i],
 644                           (unsigned int) i,
 645                           &check_match,
 646                           &cm_ctx);
 647     if (NULL != cm_ctx.match)
 648     {
 649       if (i == path_length - 1)
 650       {
 651         /* Existing path includes this one, return the match! */
 652         LOG (GNUNET_ERROR_TYPE_DEBUG,
 653              "Returning existing path %s as inverse for incoming connection\n",
 654              GCPP_2s (cm_ctx.match));
 655         return cm_ctx.match;
 656       }
 657       if (cm_ctx.match->entries_length == i + 1)
 658       {
 659         /* Existing path ends in the middle of new path, extend it! */
 660         LOG (GNUNET_ERROR_TYPE_DEBUG,
 661              "Extending existing path %s to create inverse for incoming connection\n",
 662              GCPP_2s (cm_ctx.match));
 663         extend_path (cm_ctx.match,
 664                      &cpath[i + 1],
 665                      path_length - i - 1,
 666                      GNUNET_YES);
 667         /* Check that extension was successful */
 668         GNUNET_assert (cm_ctx.match->entries_length == path_length);
 669         return cm_ctx.match;
 670       }
 671       /* Eh, we found a match but couldn't use it? Something is wrong. */
 672       GNUNET_break (0);
 673     }
 674   }
 675
 676   /* No match at all, create completely new path */
 677   path = GNUNET_new (struct CadetPeerPath);
 678   path->entries_length = path_length;
 679   path->entries = GNUNET_new_array (path->entries_length,
 680                                     struct CadetPeerPathEntry *);
 681   for (int i=path_length-1;i>=0;i--)
 682   {
 683     struct CadetPeerPathEntry *entry = GNUNET_new (struct CadetPeerPathEntry);
 684
 685     path->entries[i] = entry;
 686     entry->peer = cpath[i];
 687     entry->path = path;
 688   }
 689   for (int i=path_length-1;i>=0;i--)
 690   {
 691     struct CadetPeerPathEntry *entry = path->entries[i];
 692
 693     GCP_path_entry_add (entry->peer,
 694                         entry,
 695                         i);
 696   }
 697   recalculate_path_desirability (path);
 698   LOG (GNUNET_ERROR_TYPE_DEBUG,
 699        "Created new path %s to create inverse for incoming connection\n",
 700        GCPP_2s (path));
 701   path->hn = GCP_attach_path (cpath[path_length - 1],
 702                               path,
 703                               path_length - 1,
 704                               GNUNET_YES);
 705   return path;
 706 }
 707
 708
 709 /**
 710  * Return the length of the path.  Excludes one end of the
 711  * path, so the loopback path has length 0.
 712  *
 713  * @param path path to return the length for
 714  * @return number of peers on the path
 715  */
 716 unsigned int
 717 GCPP_get_length (struct CadetPeerPath *path)
 718 {
 719   return path->entries_length;
 720 }
 721
 722
 723 /**
 724  * Find peer's offset on path.
 725  *
 726  * @param path path to search
 727  * @param cp peer to look for
 728  * @return offset of @a cp on @a path, or UINT_MAX if not found
 729  */
 730 unsigned int
 731 GCPP_find_peer (struct CadetPeerPath *path,
 732                 struct CadetPeer *cp)
 733 {
 734   for (unsigned int off = 0;
 735        off < path->entries_length;
 736        off++)
 737     if (cp == GCPP_get_peer_at_offset (path,
 738                                        off))
 739       return off;
 740   return UINT_MAX;
 741 }
 742
 743
 744 /**
 745  * Obtain the peer at offset @a off in @a path.
 746  *
 747  * @param path peer path to inspect
 748  * @param off offset to return, must be smaller than path length
 749  * @return the peer at offset @a off
 750  */
 751 struct CadetPeer *
 752 GCPP_get_peer_at_offset (struct CadetPeerPath *path,
 753                          unsigned int off)
 754 {
 755   GNUNET_assert (off < path->entries_length);
 756   return path->entries[off]->peer;
 757 }
 758
 759
 760 /**
 761  * Convert a path to a human-readable string.
 762  *
 763  * @param path path to convert
 764  * @return string, to be freed by caller (unlike other *_2s APIs!)
 765  */
 766 const char *
 767 GCPP_2s (struct CadetPeerPath *path)
 768 {
 769   static char buf[2048];
 770   size_t off;
 771   const unsigned int max_plen = (sizeof(buf) - 16) / 5 - 2; /* 5 characters per entry */
 772
 773   off = 0;
 774   for (unsigned int i = 0;
 775        i < path->entries_length;
 776        i++)
 777   {
 778     if ( (path->entries_length > max_plen) &&
 779          (i == max_plen / 2) )
 780       off += GNUNET_snprintf (&buf[off],
 781                               sizeof (buf) - off,
 782                               "...-");
 783     if ( (path->entries_length > max_plen) &&
 784          (i > max_plen / 2) &&
 785          (i < path->entries_length - max_plen / 2) )
 786       continue;
 787     off += GNUNET_snprintf (&buf[off],
 788                             sizeof (buf) - off,
 789                             "%s%s",
 790                             GNUNET_i2s (GCP_get_id (GCPP_get_peer_at_offset (path,
 791                                                                              i))),
 792                             (i == path->entries_length -1) ? "" : "-");
 793   }
 794   GNUNET_snprintf (&buf[off],
 795                    sizeof (buf) - off,
 796                    "(%p)",
 797                    path);
 798   return buf;
 799 }
 800
 801
 802 /* end of gnunet-service-cadet-new_paths.c */