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 it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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    * Array of all the peers on the path.  If @e hn is non-NULL, the
  42    * last one is our owner.
  43    */
  44   struct CadetPeerPathEntry **entries;
  45
  46   /**
  47    * Node of this path in the owner's heap.  Used to update our position
  48    * in the heap whenever our @e desirability changes.
  49    */
  50   struct GNUNET_CONTAINER_HeapNode *hn;
  51
  52   /**
  53    * Desirability of the path. How unique is it for the various peers
  54    * on it?
  55    */
  56   GNUNET_CONTAINER_HeapCostType desirability;
  57
  58   /**
  59    * Length of the @e entries array.
  60    */
  61   unsigned int entries_length;
  62 };
  63
  64
  65 /**
  66  * Calculate the path's desirability score.
  67  *
  68  * @param path path to calculate the score for
  69  */
  70 static void
  71 recalculate_path_desirability(struct CadetPeerPath *path)
  72 {
  73   double result = 0.0;
  74
  75   for (unsigned int i = 0; i < path->entries_length; i++)
  76     {
  77       struct CadetPeer *cp = path->entries[i]->peer;
  78
  79       result += GCP_get_desirability_of_path(cp,
  80                                              i);
  81     }
  82   path->desirability = (GNUNET_CONTAINER_HeapCostType)result;
  83 }
  84
  85
  86 /**
  87  * Return how much we like keeping the path.  This is an aggregate
  88  * score based on various factors, including the age of the path
  89  * (older == better), and the value of this path to all of its ajacent
  90  * peers.  For example, long paths that end at a peer that we have no
  91  * shorter way to reach are very desirable, while long paths that end
  92  * at a peer for which we have a shorter way as well are much less
  93  * desirable.  Higher values indicate more valuable paths.  The
  94  * returned value should be used to decide which paths to remember.
  95  *
  96  * @param path path to return the length for
  97  * @return desirability of the path, larger is more desirable
  98  */
  99 GNUNET_CONTAINER_HeapCostType
 100 GCPP_get_desirability(const struct CadetPeerPath *path)
 101 {
 102   return path->desirability;
 103 }
 104
 105
 106 /**
 107  * Return connection to @a destination using @a path, or return
 108  * NULL if no such connection exists.
 109  *
 110  * @param path path to traverse
 111  * @param destination destination node to get to, must be on path
 112  * @param off offset of @a destination on @a path
 113  * @return NULL if we have no existing connection
 114  *         otherwise connection from us to @a destination via @a path
 115  */
 116 struct CadetConnection *
 117 GCPP_get_connection(struct CadetPeerPath *path,
 118                     struct CadetPeer *destination,
 119                     unsigned int off)
 120 {
 121   struct CadetPeerPathEntry *entry;
 122
 123   GNUNET_assert(off < path->entries_length);
 124   entry = path->entries[off];
 125   GNUNET_assert(entry->peer == destination);
 126   return entry->cc;
 127 }
 128
 129
 130 /**
 131  * Notify @a path that it is used for connection @a cc
 132  * which ends at the path's offset @a off.
 133  *
 134  * @param path the path to remember the @a cc
 135  * @param off the offset where the @a cc ends
 136  * @param cc the connection to remember
 137  */
 138 void
 139 GCPP_add_connection(struct CadetPeerPath *path,
 140                     unsigned int off,
 141                     struct CadetConnection *cc)
 142 {
 143   struct CadetPeerPathEntry *entry;
 144
 145   LOG(GNUNET_ERROR_TYPE_DEBUG,
 146       "Adding %s to path %s at offset %u\n",
 147       GCC_2s(cc),
 148       GCPP_2s(path),
 149       off);
 150   GNUNET_assert(off < path->entries_length);
 151   entry = path->entries[off];
 152   GNUNET_assert(NULL == entry->cc);
 153   GNUNET_assert(NULL != cc);
 154   entry->cc = cc;
 155 }
 156
 157
 158
 159 /**
 160  * Notify @a path that it is no longer used for connection @a cc which
 161  * ended at the path's offset @a off.
 162  *
 163  * @param path the path to forget the @a cc
 164  * @param off the offset where the @a cc ended
 165  * @param cc the connection to forget
 166  */
 167 void
 168 GCPP_del_connection(struct CadetPeerPath *path,
 169                     unsigned int off,
 170                     struct CadetConnection *cc)
 171 {
 172   struct CadetPeerPathEntry *entry;
 173
 174   LOG(GNUNET_ERROR_TYPE_DEBUG,
 175       "Removing connection %s to path %s at offset %u\n",
 176       GCC_2s(cc),
 177       GCPP_2s(path),
 178       off);
 179   GNUNET_assert(off < path->entries_length);
 180   entry = path->entries[off];
 181   GNUNET_assert(cc == entry->cc);
 182   entry->cc = NULL;
 183 }
 184
 185
 186 /**
 187  * Tries to attach @a path to a peer, working backwards from the end
 188  * and stopping at @a stop_at. If path->hn is NULL on return then the
 189  * path was not attached and you can assume that path->entries_length
 190  * is equal to @a stop_at.
 191  *
 192  * @param path the path to attach
 193  * @param stop_at the path length at which to stop trying
 194  */
 195 static void
 196 attach_path(struct CadetPeerPath *path, unsigned int stop_at)
 197 {
 198   GNUNET_assert(NULL == path->hn);
 199
 200   /* Try to attach this path to a peer, working backwards from the end. */
 201   while (path->entries_length > stop_at)
 202     {
 203       unsigned int end = path->entries_length - 1;
 204       struct CadetPeerPathEntry *entry = path->entries[end];
 205       int force = GNUNET_NO;
 206
 207       recalculate_path_desirability(path);
 208       /* If the entry already has a connection using it, force attach. */
 209       if (NULL != entry->cc)
 210         force = GNUNET_YES;
 211       path->hn = GCP_attach_path(entry->peer,
 212                                  path,
 213                                  end,
 214                                  force);
 215       if (NULL != path->hn)
 216         break;
 217
 218       /* Attach failed, trim this entry from the path. */
 219       GNUNET_assert(NULL == entry->cc);
 220       GCP_path_entry_remove(entry->peer,
 221                             entry,
 222                             end);
 223       GNUNET_free(entry);
 224       path->entries[end] = NULL;
 225       path->entries_length--;
 226     }
 227
 228   /* Shrink array to actual path length. */
 229   GNUNET_array_grow(path->entries,
 230                     path->entries_length,
 231                     path->entries_length);
 232 }
 233
 234
 235 /**
 236  * The owning peer of this path is no longer interested in maintaining
 237  * it, so the path should be discarded or shortened (in case a
 238  * previous peer on the path finds the path desirable).
 239  *
 240  * @param path the path that is being released
 241  */
 242 void
 243 GCPP_release(struct CadetPeerPath *path)
 244 {
 245   struct CadetPeerPathEntry *entry;
 246
 247   LOG(GNUNET_ERROR_TYPE_DEBUG,
 248       "Owner releases path %s\n",
 249       GCPP_2s(path));
 250   path->hn = NULL;
 251   entry = path->entries[path->entries_length - 1];
 252   GNUNET_assert(path == entry->path);
 253   GNUNET_assert(NULL == entry->cc);
 254   /* cut 'off' end of path */
 255   GCP_path_entry_remove(entry->peer,
 256                         entry,
 257                         path->entries_length - 1);
 258   GNUNET_free(entry);
 259   path->entries[path->entries_length - 1] = NULL;
 260   path->entries_length--;
 261   /* see if new peer at the end likes this path any better */
 262   attach_path(path, 0);
 263   if (NULL == path->hn)
 264     {
 265       /* nobody wants us, discard the path */
 266       GNUNET_assert(0 == path->entries_length);
 267       GNUNET_assert(NULL == path->entries);
 268       GNUNET_free(path);
 269     }
 270 }
 271
 272
 273 /**
 274  * Updates the score for an entry on the path based
 275  * on our experiences with using @a path.
 276  *
 277  * @param path the path to update
 278  * @param off offset of the entry to update
 279  * @param delta change in the score to apply
 280  */
 281 void
 282 GCPP_update_score(struct CadetPeerPath *path,
 283                   unsigned int off,
 284                   int delta)
 285 {
 286   struct CadetPeerPathEntry *entry;
 287
 288   GNUNET_assert(off < path->entries_length);
 289   entry = path->entries[off];
 290
 291   /* Add delta, with checks for overflows */
 292   if (delta >= 0)
 293     {
 294       if (delta + entry->score < entry->score)
 295         entry->score = INT_MAX;
 296       else
 297         entry->score += delta;
 298     }
 299   else
 300     {
 301       if (delta + entry->score > entry->score)
 302         entry->score = INT_MIN;
 303       else
 304         entry->score += delta;
 305     }
 306   recalculate_path_desirability(path);
 307 }
 308
 309
 310 /**
 311  * Closure for #find_peer_at() and #check_match().
 312  */
 313 struct CheckMatchContext {
 314   /**
 315    * Set to a matching path, if any.
 316    */
 317   struct CadetPeerPath *match;
 318
 319   /**
 320    * Array the combined paths.
 321    */
 322   struct CadetPeer **cpath;
 323
 324   /**
 325    * How long is the @e cpath array?
 326    */
 327   unsigned int cpath_length;
 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 mismatch 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 mismatches at offset %u\n",
 367             GCPP_2s(path),
 368             i);
 369         return GNUNET_YES; /* mismatch, 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   path->entries_length = old_len + num_peers;
 426   if (GNUNET_YES == force)
 427     {
 428       int end = path->entries_length - 1;
 429
 430       path->hn = GCP_attach_path(path->entries[end]->peer,
 431                                  path,
 432                                  end,
 433                                  GNUNET_YES);
 434     }
 435   else
 436     {
 437       attach_path(path, old_len);
 438     }
 439   if (NULL == path->hn)
 440     {
 441       /* none of the peers is interested in this path;
 442          re-attach. */
 443       GNUNET_assert(old_len == path->entries_length);
 444       path->hn = GCP_attach_path(path->entries[old_len - 1]->peer,
 445                                  path,
 446                                  old_len - 1,
 447                                  GNUNET_YES);
 448       GNUNET_assert(NULL != path->hn);
 449       return;
 450     }
 451   LOG(GNUNET_ERROR_TYPE_DEBUG,
 452       "Extended path %s\n",
 453       GCPP_2s(path));
 454 }
 455
 456
 457 /**
 458  * Create a peer path based on the result of a DHT lookup.  If we
 459  * already know this path, or one that is longer, simply return NULL.
 460  * Otherwise, we try to extend an existing path, or create a new one
 461  * if applicable.
 462  *
 463  * @param get_path path of the get request
 464  * @param get_path_length lenght of @a get_path
 465  * @param put_path path of the put request
 466  * @param put_path_length length of the @a put_path
 467  * @return a path through the network
 468  */
 469 void
 470 GCPP_try_path_from_dht(const struct GNUNET_PeerIdentity *get_path,
 471                        unsigned int get_path_length,
 472                        const struct GNUNET_PeerIdentity *put_path,
 473                        unsigned int put_path_length)
 474 {
 475   struct CadetPeer *cpath[get_path_length + put_path_length];
 476   struct CheckMatchContext cm_ctx;
 477   struct CadetPeerPath *path;
 478   unsigned int skip;
 479   unsigned int total_len;
 480
 481   /* precompute 'cpath' so we can avoid doing the lookups lots of times */
 482   skip = 0;
 483   memset(cpath,
 484          0,
 485          sizeof(cpath));   /* Just to trigger harder errors later. */
 486   total_len = get_path_length + put_path_length;
 487   for (unsigned int off = 0; off < total_len; off++)
 488     {
 489       const struct GNUNET_PeerIdentity *pid;
 490
 491       pid = (off < get_path_length)
 492             ? &get_path[get_path_length - off - 1]
 493             : &put_path[get_path_length + put_path_length - off - 1];
 494       /* Check that I am not in the path */
 495       if (0 == GNUNET_memcmp(&my_full_id,
 496                              pid))
 497         {
 498           skip = off + 1;
 499           continue;
 500         }
 501       cpath[off - skip] = GCP_get(pid,
 502                                   GNUNET_YES);
 503       /* Check that no peer is twice on the path */
 504       for (unsigned int i = 0; i < off - skip; i++)
 505         {
 506           if (cpath[i] == cpath[off - skip])
 507             {
 508               skip = off - i;
 509               break;
 510             }
 511         }
 512     }
 513   if (skip >= total_len)
 514     {
 515       LOG(GNUNET_ERROR_TYPE_DEBUG,
 516           "Path discovered from DHT is one big cycle?\n");
 517       return;
 518     }
 519   total_len -= skip;
 520
 521   /* First figure out if this path is a subset of an existing path, an
 522      extension of an existing path, or a new path. */
 523   cm_ctx.cpath_length = total_len;
 524   cm_ctx.cpath = cpath;
 525   cm_ctx.match = NULL;
 526   for (int i = total_len - 1; i >= 0; i--)
 527     {
 528       GCP_iterate_paths_at(cpath[i],
 529                            (unsigned int)i,
 530                            &check_match,
 531                            &cm_ctx);
 532       if (NULL != cm_ctx.match)
 533         {
 534           if (i == total_len - 1)
 535             {
 536               /* Existing path includes this one, nothing to do! */
 537               LOG(GNUNET_ERROR_TYPE_DEBUG,
 538                   "Path discovered from DHT is already known\n");
 539               return;
 540             }
 541           if (cm_ctx.match->entries_length == i + 1)
 542             {
 543               /* Existing path ends in the middle of new path, extend it! */
 544               LOG(GNUNET_ERROR_TYPE_DEBUG,
 545                   "Trying to extend existing path %s by additional links discovered from DHT\n",
 546                   GCPP_2s(cm_ctx.match));
 547               extend_path(cm_ctx.match,
 548                           &cpath[i + 1],
 549                           total_len - i - 1,
 550                           GNUNET_NO);
 551               return;
 552             }
 553         }
 554     }
 555
 556   /* No match at all, create completely new path */
 557   path = GNUNET_new(struct CadetPeerPath);
 558   path->entries_length = total_len;
 559   path->entries = GNUNET_new_array(path->entries_length,
 560                                    struct CadetPeerPathEntry *);
 561   for (int i = path->entries_length - 1; i >= 0; i--)
 562     {
 563       struct CadetPeerPathEntry *entry = GNUNET_new(struct CadetPeerPathEntry);
 564
 565       path->entries[i] = entry;
 566       entry->peer = cpath[i];
 567       entry->path = path;
 568     }
 569   for (int i = path->entries_length - 1; i >= 0; i--)
 570     {
 571       struct CadetPeerPathEntry *entry = path->entries[i];
 572
 573       GCP_path_entry_add(entry->peer,
 574                          entry,
 575                          i);
 576     }
 577
 578   /* Finally, try to attach it */
 579   attach_path(path, 0);
 580   if (NULL == path->hn)
 581     {
 582       /* None of the peers on the path care about it. */
 583       LOG(GNUNET_ERROR_TYPE_DEBUG,
 584           "Path discovered from DHT is not interesting to us\n");
 585       GNUNET_assert(0 == path->entries_length);
 586       GNUNET_assert(NULL == path->entries);
 587       GNUNET_free(path);
 588       return;
 589     }
 590   LOG(GNUNET_ERROR_TYPE_DEBUG,
 591       "Created new path %s based on information from DHT\n",
 592       GCPP_2s(path));
 593 }
 594
 595
 596 /**
 597  * We got an incoming connection, obtain the corresponding path.
 598  *
 599  * @param path_length number of segments on the @a path
 600  * @param pids path through the network, in reverse order (we are at the end at index @a path_length)
 601  * @return corresponding path object
 602  */
 603 struct CadetPeerPath *
 604 GCPP_get_path_from_route(unsigned int path_length,
 605                          const struct GNUNET_PeerIdentity *pids)
 606 {
 607   struct CheckMatchContext cm_ctx;
 608   struct CadetPeer *cpath[path_length];
 609   struct CadetPeerPath *path;
 610
 611   /* precompute inverted 'cpath' so we can avoid doing the lookups and
 612      have the correct order */
 613   for (unsigned int off = 0; off < path_length; off++)
 614     cpath[off] = GCP_get(&pids[path_length - 1 - off],
 615                          GNUNET_YES);
 616
 617   /* First figure out if this path is a subset of an existing path, an
 618      extension of an existing path, or a new path. */
 619   cm_ctx.cpath = cpath;
 620   cm_ctx.cpath_length = path_length;
 621   cm_ctx.match = NULL;
 622   for (int i = path_length - 1; i >= 0; i--)
 623     {
 624       GCP_iterate_paths_at(cpath[i],
 625                            (unsigned int)i,
 626                            &check_match,
 627                            &cm_ctx);
 628       if (NULL != cm_ctx.match)
 629         {
 630           if (i == path_length - 1)
 631             {
 632               /* Existing path includes this one, return the match! */
 633               LOG(GNUNET_ERROR_TYPE_DEBUG,
 634                   "Returning existing path %s as inverse for incoming connection\n",
 635                   GCPP_2s(cm_ctx.match));
 636               return cm_ctx.match;
 637             }
 638           if (cm_ctx.match->entries_length == i + 1)
 639             {
 640               /* Existing path ends in the middle of new path, extend it! */
 641               LOG(GNUNET_ERROR_TYPE_DEBUG,
 642                   "Extending existing path %s to create inverse for incoming connection\n",
 643                   GCPP_2s(cm_ctx.match));
 644               extend_path(cm_ctx.match,
 645                           &cpath[i + 1],
 646                           path_length - i - 1,
 647                           GNUNET_YES);
 648               /* Check that extension was successful */
 649               GNUNET_assert(cm_ctx.match->entries_length == path_length);
 650               return cm_ctx.match;
 651             }
 652           /* Eh, we found a match but couldn't use it? Something is wrong. */
 653           GNUNET_break(0);
 654         }
 655     }
 656
 657   /* No match at all, create completely new path */
 658   path = GNUNET_new(struct CadetPeerPath);
 659   path->entries_length = path_length;
 660   path->entries = GNUNET_new_array(path->entries_length,
 661                                    struct CadetPeerPathEntry *);
 662   for (int i = path_length - 1; i >= 0; i--)
 663     {
 664       struct CadetPeerPathEntry *entry = GNUNET_new(struct CadetPeerPathEntry);
 665
 666       path->entries[i] = entry;
 667       entry->peer = cpath[i];
 668       entry->path = path;
 669     }
 670   for (int i = path_length - 1; i >= 0; i--)
 671     {
 672       struct CadetPeerPathEntry *entry = path->entries[i];
 673
 674       GCP_path_entry_add(entry->peer,
 675                          entry,
 676                          i);
 677     }
 678   recalculate_path_desirability(path);
 679   LOG(GNUNET_ERROR_TYPE_DEBUG,
 680       "Created new path %s to create inverse for incoming connection\n",
 681       GCPP_2s(path));
 682   path->hn = GCP_attach_path(cpath[path_length - 1],
 683                              path,
 684                              path_length - 1,
 685                              GNUNET_YES);
 686   return path;
 687 }
 688
 689
 690 /**
 691  * Return the length of the path.  Excludes one end of the
 692  * path, so the loopback path has length 0.
 693  *
 694  * @param path path to return the length for
 695  * @return number of peers on the path
 696  */
 697 unsigned int
 698 GCPP_get_length(struct CadetPeerPath *path)
 699 {
 700   return path->entries_length;
 701 }
 702
 703
 704 /**
 705  * Find peer's offset on path.
 706  *
 707  * @param path path to search
 708  * @param cp peer to look for
 709  * @return offset of @a cp on @a path, or UINT_MAX if not found
 710  */
 711 unsigned int
 712 GCPP_find_peer(struct CadetPeerPath *path,
 713                struct CadetPeer *cp)
 714 {
 715   for (unsigned int off = 0;
 716        off < path->entries_length;
 717        off++)
 718     if (cp == GCPP_get_peer_at_offset(path,
 719                                       off))
 720       return off;
 721   return UINT_MAX;
 722 }
 723
 724
 725 /**
 726  * Obtain the peer at offset @a off in @a path.
 727  *
 728  * @param path peer path to inspect
 729  * @param off offset to return, must be smaller than path length
 730  * @return the peer at offset @a off
 731  */
 732 struct CadetPeer *
 733 GCPP_get_peer_at_offset(struct CadetPeerPath *path,
 734                         unsigned int off)
 735 {
 736   GNUNET_assert(off < path->entries_length);
 737   return path->entries[off]->peer;
 738 }
 739
 740
 741 /**
 742  * Convert a path to a human-readable string.
 743  *
 744  * @param path path to convert
 745  * @return string, to be freed by caller (unlike other *_2s APIs!)
 746  */
 747 const char *
 748 GCPP_2s(struct CadetPeerPath *path)
 749 {
 750   static char buf[2048];
 751   size_t off;
 752   const unsigned int max_plen = (sizeof(buf) - 16) / 5 - 2; /* 5 characters per entry */
 753
 754   off = 0;
 755   for (unsigned int i = 0;
 756        i < path->entries_length;
 757        i++)
 758     {
 759       if ((path->entries_length > max_plen) &&
 760           (i == max_plen / 2))
 761         off += GNUNET_snprintf(&buf[off],
 762                                sizeof(buf) - off,
 763                                "...-");
 764       if ((path->entries_length > max_plen) &&
 765           (i > max_plen / 2) &&
 766           (i < path->entries_length - max_plen / 2))
 767         continue;
 768       off += GNUNET_snprintf(&buf[off],
 769                              sizeof(buf) - off,
 770                              "%s%s",
 771                              GNUNET_i2s(GCP_get_id(GCPP_get_peer_at_offset(path,
 772                                                                            i))),
 773                              (i == path->entries_length - 1) ? "" : "-");
 774     }
 775   GNUNET_snprintf(&buf[off],
 776                   sizeof(buf) - off,
 777                   "(%p)",
 778                   path);
 779   return buf;
 780 }
 781
 782
 783 /* end of gnunet-service-cadet-new_paths.c */