src/fs/fs_search.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2014 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., 59 Tem ple Place - Suite 330,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file fs/fs_search.c
  22  * @brief Helper functions for searching.
  23  * @author Christian Grothoff
  24  */
  25 #include "platform.h"
  26 #include "gnunet_constants.h"
  27 #include "gnunet_fs_service.h"
  28 #include "gnunet_protocols.h"
  29 #include "fs_api.h"
  30 #include "fs_publish_ublock.h"
  31
  32
  33 /**
  34  * Number of availability trials we perform per search result.
  35  */
  36 #define AVAILABILITY_TRIALS_MAX 8
  37
  38 /**
  39  * Fill in all of the generic fields for a search event and
  40  * call the callback.
  41  *
  42  * @param pi structure to fill in
  43  * @param h file-sharing handle
  44  * @param sc overall search context
  45  * @return value returned by the callback
  46  */
  47 void *
  48 GNUNET_FS_search_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
  49                                struct GNUNET_FS_Handle *h,
  50                                struct GNUNET_FS_SearchContext *sc)
  51 {
  52   void *ret;
  53
  54   pi->value.search.sc = sc;
  55   pi->value.search.cctx = (NULL != sc) ? sc->client_info : NULL;
  56   pi->value.search.pctx =
  57     ((NULL == sc) || (NULL == sc->psearch_result))
  58     ? NULL
  59     : sc->psearch_result->client_info;
  60   pi->value.search.query = (NULL != sc) ? sc->uri : NULL;
  61   pi->value.search.duration = (NULL != sc)
  62     ? GNUNET_TIME_absolute_get_duration (sc->start_time)
  63     : GNUNET_TIME_UNIT_ZERO;
  64   pi->value.search.anonymity = (NULL != sc) ? sc->anonymity : 0;
  65   pi->fsh = h;
  66   ret = h->upcb (h->upcb_cls, pi);
  67   return ret;
  68 }
  69
  70
  71 /**
  72  * Check if the given result is identical to the given URI.
  73  *
  74  * @param cls points to the URI we check against
  75  * @param key not used
  76  * @param value a `struct GNUNET_FS_SearchResult` who's URI we
  77  *        should compare with
  78  * @return #GNUNET_SYSERR if the result is present,
  79  *         #GNUNET_OK otherwise
  80  */
  81 static int
  82 test_result_present (void *cls,
  83                      const struct GNUNET_HashCode * key,
  84                      void *value)
  85 {
  86   const struct GNUNET_FS_Uri *uri = cls;
  87   struct GNUNET_FS_SearchResult *sr = value;
  88
  89   if (GNUNET_FS_uri_test_equal (uri, sr->uri))
  90     return GNUNET_SYSERR;
  91   return GNUNET_OK;
  92 }
  93
  94
  95 /**
  96  * We've found a new CHK result.  Let the client
  97  * know about it.
  98  *
  99  * @param sc the search context
 100  * @param sr the specific result
 101  */
 102 static void
 103 notify_client_chk_result (struct GNUNET_FS_SearchContext *sc,
 104                           struct GNUNET_FS_SearchResult *sr)
 105 {
 106   struct GNUNET_FS_ProgressInfo pi;
 107
 108   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT;
 109   pi.value.search.specifics.result.meta = sr->meta;
 110   pi.value.search.specifics.result.uri = sr->uri;
 111   pi.value.search.specifics.result.result = sr;
 112   pi.value.search.specifics.result.applicability_rank = sr->optional_support;
 113   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
 114 }
 115
 116
 117 /**
 118  * We've found new information about an existing CHK result.  Let the
 119  * client know about it.
 120  *
 121  * @param sc the search context
 122  * @param sr the specific result
 123  */
 124 static void
 125 notify_client_chk_update (struct GNUNET_FS_SearchContext *sc,
 126                           struct GNUNET_FS_SearchResult *sr)
 127 {
 128   struct GNUNET_FS_ProgressInfo pi;
 129
 130   pi.status = GNUNET_FS_STATUS_SEARCH_UPDATE;
 131   pi.value.search.specifics.update.cctx = sr->client_info;
 132   pi.value.search.specifics.update.meta = sr->meta;
 133   pi.value.search.specifics.update.uri = sr->uri;
 134   pi.value.search.specifics.update.availability_rank =
 135       2 * sr->availability_success - sr->availability_trials;
 136   pi.value.search.specifics.update.availability_certainty =
 137       sr->availability_trials;
 138   pi.value.search.specifics.update.applicability_rank = sr->optional_support;
 139   pi.value.search.specifics.update.current_probe_time
 140     = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
 141   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
 142 }
 143
 144
 145 /**
 146  * Context for "get_result_present".
 147  */
 148 struct GetResultContext
 149 {
 150   /**
 151    * The URI we're looking for.
 152    */
 153   const struct GNUNET_FS_Uri *uri;
 154
 155   /**
 156    * Where to store a pointer to the search
 157    * result struct if we found a match.
 158    */
 159   struct GNUNET_FS_SearchResult *sr;
 160 };
 161
 162
 163 /**
 164  * Check if the given result is identical to the given URI and if so
 165  * return it.
 166  *
 167  * @param cls a `struct GetResultContext`
 168  * @param key not used
 169  * @param value a `struct GNUNET_FS_SearchResult` who's URI we
 170  *        should compare with
 171  * @return #GNUNET_OK
 172  */
 173 static int
 174 get_result_present (void *cls,
 175                     const struct GNUNET_HashCode *key,
 176                     void *value)
 177 {
 178   struct GetResultContext *grc = cls;
 179   struct GNUNET_FS_SearchResult *sr = value;
 180
 181   if (GNUNET_FS_uri_test_equal (grc->uri, sr->uri))
 182     grc->sr = sr;
 183   return GNUNET_OK;
 184 }
 185
 186
 187 /**
 188  * Signal result of last probe to client and then schedule next
 189  * probe.
 190  *
 191  * @param sr search result to signal for
 192  */
 193 static void
 194 signal_probe_result (struct GNUNET_FS_SearchResult *sr)
 195 {
 196   struct GNUNET_FS_ProgressInfo pi;
 197
 198   pi.status = GNUNET_FS_STATUS_SEARCH_UPDATE;
 199   pi.value.search.specifics.update.cctx = sr->client_info;
 200   pi.value.search.specifics.update.meta = sr->meta;
 201   pi.value.search.specifics.update.uri = sr->uri;
 202   pi.value.search.specifics.update.availability_rank
 203     = 2 * sr->availability_success - sr->availability_trials;
 204   pi.value.search.specifics.update.availability_certainty
 205     = sr->availability_trials;
 206   pi.value.search.specifics.update.applicability_rank = sr->optional_support;
 207   pi.value.search.specifics.update.current_probe_time
 208     = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
 209   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sr->h, sr->sc);
 210   GNUNET_FS_search_start_probe_ (sr);
 211 }
 212
 213
 214 /**
 215  * Handle the case where we have failed to receive a response for our probe.
 216  *
 217  * @param cls our `struct GNUNET_FS_SearchResult *`
 218  */
 219 static void
 220 probe_failure_handler (void *cls)
 221 {
 222   struct GNUNET_FS_SearchResult *sr = cls;
 223
 224   sr->probe_cancel_task = NULL;
 225   sr->availability_trials++;
 226   GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
 227   sr->probe_ctx = NULL;
 228   GNUNET_FS_stop_probe_ping_task_ (sr);
 229   GNUNET_FS_search_result_sync_ (sr);
 230   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 231               "Probe #%u for search result %p failed\n",
 232               sr->availability_trials,
 233               sr);
 234   signal_probe_result (sr);
 235 }
 236
 237
 238 /**
 239  * Handle the case where we have gotten a response for our probe.
 240  *
 241  * @param cls our `struct GNUNET_FS_SearchResult *`
 242  */
 243 static void
 244 probe_success_handler (void *cls)
 245 {
 246   struct GNUNET_FS_SearchResult *sr = cls;
 247
 248   sr->probe_cancel_task = NULL;
 249   sr->availability_trials++;
 250   sr->availability_success++;
 251   GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
 252   sr->probe_ctx = NULL;
 253   GNUNET_FS_stop_probe_ping_task_ (sr);
 254   GNUNET_FS_search_result_sync_ (sr);
 255   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 256               "Probe #%u for search result %p succeeded\n",
 257               sr->availability_trials,
 258               sr);
 259   signal_probe_result (sr);
 260 }
 261
 262
 263 /**
 264  * Notification of FS that a search probe has made progress.
 265  * This function is used INSTEAD of the client's event handler
 266  * for downloads where the #GNUNET_FS_DOWNLOAD_IS_PROBE flag is set.
 267  *
 268  * @param cls closure, always NULL (!), actual closure
 269  *        is in the client-context of the info struct
 270  * @param info details about the event, specifying the event type
 271  *        and various bits about the event
 272  * @return client-context (for the next progress call
 273  *         for this operation; should be set to NULL for
 274  *         SUSPEND and STOPPED events).  The value returned
 275  *         will be passed to future callbacks in the respective
 276  *         field in the `struct GNUNET_FS_ProgressInfo`.
 277  */
 278 void *
 279 GNUNET_FS_search_probe_progress_ (void *cls,
 280                                   const struct GNUNET_FS_ProgressInfo *info)
 281 {
 282   struct GNUNET_FS_SearchResult *sr = info->value.download.cctx;
 283   struct GNUNET_TIME_Relative dur;
 284
 285   switch (info->status)
 286   {
 287   case GNUNET_FS_STATUS_DOWNLOAD_START:
 288     /* ignore */
 289     break;
 290   case GNUNET_FS_STATUS_DOWNLOAD_RESUME:
 291     /* probes should never be resumed */
 292     GNUNET_assert (0);
 293     break;
 294   case GNUNET_FS_STATUS_DOWNLOAD_SUSPEND:
 295     /* probes should never be suspended */
 296     GNUNET_break (0);
 297     break;
 298   case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
 299     /* ignore */
 300     break;
 301   case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
 302     if (NULL != sr->probe_cancel_task)
 303     {
 304       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 305       sr->probe_cancel_task = NULL;
 306     }
 307     sr->probe_cancel_task =
 308         GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
 309                                       &probe_failure_handler, sr);
 310     break;
 311   case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
 312     if (NULL != sr->probe_cancel_task)
 313     {
 314       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 315       sr->probe_cancel_task = NULL;
 316     }
 317     sr->probe_cancel_task =
 318         GNUNET_SCHEDULER_add_now (&probe_success_handler, sr);
 319     break;
 320   case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
 321     if (NULL != sr->probe_cancel_task)
 322     {
 323       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 324       sr->probe_cancel_task = NULL;
 325     }
 326     sr = NULL;
 327     break;
 328   case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
 329     if (NULL == sr->probe_cancel_task)
 330     {
 331       sr->probe_active_time = GNUNET_TIME_absolute_get ();
 332       sr->probe_cancel_task =
 333         GNUNET_SCHEDULER_add_delayed (sr->remaining_probe_time,
 334                                       &probe_failure_handler, sr);
 335     }
 336     break;
 337   case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
 338     if (NULL != sr->probe_cancel_task)
 339     {
 340       GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 341       sr->probe_cancel_task = NULL;
 342     }
 343     dur = GNUNET_TIME_absolute_get_duration (sr->probe_active_time);
 344     sr->remaining_probe_time =
 345         GNUNET_TIME_relative_subtract (sr->remaining_probe_time, dur);
 346     if (0 == sr->remaining_probe_time.rel_value_us)
 347       sr->probe_cancel_task =
 348         GNUNET_SCHEDULER_add_now (&probe_failure_handler, sr);
 349     GNUNET_FS_search_result_sync_ (sr);
 350     break;
 351   default:
 352     GNUNET_break (0);
 353     return NULL;
 354   }
 355   return sr;
 356 }
 357
 358
 359 /**
 360  * Task run periodically to remind clients that a probe is active.
 361  *
 362  * @param cls the `struct GNUNET_FS_SearchResult` that we are probing for
 363  */
 364 static void
 365 probe_ping_task_cb (void *cls)
 366 {
 367   struct GNUNET_FS_Handle *h = cls;
 368   struct GNUNET_FS_SearchResult *sr;
 369
 370   for (sr = h->probes_head; NULL != sr; sr = sr->next)
 371     if (NULL != sr->probe_ctx->mq)
 372       signal_probe_result (sr);
 373   h->probe_ping_task
 374     = GNUNET_SCHEDULER_add_delayed (GNUNET_FS_PROBE_UPDATE_FREQUENCY,
 375                                     &probe_ping_task_cb,
 376                                     h);
 377 }
 378
 379
 380 /**
 381  * Start the ping task for this search result.
 382  *
 383  * @param sr result to start pinging for.
 384  */
 385 static void
 386 start_probe_ping_task (struct GNUNET_FS_SearchResult *sr)
 387 {
 388   struct GNUNET_FS_Handle *h = sr->h;
 389
 390   GNUNET_CONTAINER_DLL_insert (h->probes_head,
 391                                h->probes_tail,
 392                                sr);
 393   if (NULL == h->probe_ping_task)
 394     h->probe_ping_task
 395       = GNUNET_SCHEDULER_add_now (&probe_ping_task_cb,
 396                                   h);
 397 }
 398
 399
 400 /**
 401  * Stop the ping task for this search result.
 402  *
 403  * @param sr result to start pinging for.
 404  */
 405 void
 406 GNUNET_FS_stop_probe_ping_task_ (struct GNUNET_FS_SearchResult *sr)
 407 {
 408   struct GNUNET_FS_Handle *h = sr->h;
 409
 410   GNUNET_CONTAINER_DLL_remove (h->probes_head,
 411                                h->probes_tail,
 412                                sr);
 413   if (NULL == h->probes_head)
 414   {
 415     GNUNET_SCHEDULER_cancel (h->probe_ping_task);
 416     h->probe_ping_task = NULL;
 417   }
 418 }
 419
 420
 421 /**
 422  * Start download probes for the given search result.
 423  *
 424  * @param sr the search result
 425  */
 426 void
 427 GNUNET_FS_search_start_probe_ (struct GNUNET_FS_SearchResult *sr)
 428 {
 429   uint64_t off;
 430   uint64_t len;
 431
 432   if (NULL != sr->probe_ctx)
 433     return;
 434   if (NULL != sr->download)
 435     return;
 436   if (0 == (sr->h->flags & GNUNET_FS_FLAGS_DO_PROBES))
 437     return;
 438   if (sr->availability_trials > AVAILABILITY_TRIALS_MAX)
 439     return;
 440   if ( (GNUNET_FS_URI_CHK != sr->uri->type) && (GNUNET_FS_URI_LOC != sr->uri->type))
 441     return;
 442   len = GNUNET_FS_uri_chk_get_file_size (sr->uri);
 443   if (0 == len)
 444     return;
 445   if ((len <= DBLOCK_SIZE) && (sr->availability_success > 0))
 446     return;
 447   off = len / DBLOCK_SIZE;
 448   if (off > 0)
 449     off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, off);
 450   off *= DBLOCK_SIZE;
 451   if (len - off < DBLOCK_SIZE)
 452     len = len - off;
 453   else
 454     len = DBLOCK_SIZE;
 455   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 456               "Starting probe #%u (at offset %llu) for search result %p\n",
 457               sr->availability_trials + 1,
 458               (unsigned long long) off,
 459               sr);
 460   sr->remaining_probe_time =
 461       GNUNET_TIME_relative_saturating_multiply (sr->h->avg_block_latency,
 462                                                 2 * (1 + sr->availability_trials));
 463   sr->probe_ctx =
 464       GNUNET_FS_download_start (sr->h, sr->uri, sr->meta, NULL, NULL, off,
 465                                 len, sr->anonymity,
 466                                 GNUNET_FS_DOWNLOAD_NO_TEMPORARIES |
 467                                 GNUNET_FS_DOWNLOAD_IS_PROBE, sr, NULL);
 468   start_probe_ping_task (sr);
 469 }
 470
 471
 472 /**
 473  * Start download probes for the given search result.
 474  *
 475  * @param h file-sharing handle to use for the operation
 476  * @param uri URI to probe
 477  * @param meta meta data associated with the URI
 478  * @param client_info client info pointer to use for associated events
 479  * @param anonymity anonymity level to use for the probes
 480  * @return the search result handle to access the probe activity
 481  */
 482 struct GNUNET_FS_SearchResult *
 483 GNUNET_FS_probe (struct GNUNET_FS_Handle *h,
 484                  const struct GNUNET_FS_Uri *uri,
 485                  const struct GNUNET_CONTAINER_MetaData *meta,
 486                  void *client_info,
 487                  uint32_t anonymity)
 488 {
 489   struct GNUNET_FS_SearchResult *sr;
 490
 491   GNUNET_assert (NULL != h);
 492   sr = GNUNET_new (struct GNUNET_FS_SearchResult);
 493   sr->h = h;
 494   sr->uri = GNUNET_FS_uri_dup (uri);
 495   sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 496   sr->client_info = client_info;
 497   sr->anonymity = anonymity;
 498   GNUNET_FS_search_start_probe_ (sr);
 499   return sr;
 500 }
 501
 502
 503 /**
 504  * Stop probing activity associated with a search result.
 505  *
 506  * @param sr search result
 507  */
 508 static void
 509 GNUNET_FS_search_stop_probe_ (struct GNUNET_FS_SearchResult *sr)
 510 {
 511   if (NULL != sr->probe_ctx)
 512   {
 513     GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
 514     sr->probe_ctx = NULL;
 515     GNUNET_FS_stop_probe_ping_task_ (sr);
 516   }
 517   if (NULL != sr->probe_cancel_task)
 518   {
 519     GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
 520     sr->probe_cancel_task = NULL;
 521   }
 522 }
 523
 524
 525 /**
 526  * Stop probe activity.  Must ONLY be used on values
 527  * returned from #GNUNET_FS_probe.
 528  *
 529  * @param sr search result to stop probing for (freed)
 530  * @return the value of the 'client_info' pointer
 531  */
 532 void *
 533 GNUNET_FS_probe_stop (struct GNUNET_FS_SearchResult *sr)
 534 {
 535   void *client_info;
 536
 537   GNUNET_assert (NULL == sr->sc);
 538   GNUNET_FS_search_stop_probe_ (sr);
 539   GNUNET_FS_uri_destroy (sr->uri);
 540   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
 541   client_info = sr->client_info;
 542   GNUNET_free (sr);
 543   return client_info;
 544 }
 545
 546
 547 /**
 548  * We have received a KSK result.  Check how it fits in with the
 549  * overall query and notify the client accordingly.
 550  *
 551  * @param sc context for the overall query
 552  * @param ent entry for the specific keyword
 553  * @param uri the URI that was found
 554  * @param meta metadata associated with the URI
 555  *        under the @a ent keyword
 556  */
 557 static void
 558 process_ksk_result (struct GNUNET_FS_SearchContext *sc,
 559                     struct SearchRequestEntry *ent,
 560                     const struct GNUNET_FS_Uri *uri,
 561                     const struct GNUNET_CONTAINER_MetaData *meta)
 562 {
 563   struct GNUNET_HashCode key;
 564   struct GNUNET_FS_SearchResult *sr;
 565   struct GetResultContext grc;
 566   int is_new;
 567   unsigned int koff;
 568
 569   /* check if new */
 570   GNUNET_assert (NULL != sc);
 571   GNUNET_FS_uri_to_key (uri, &key);
 572   if (GNUNET_SYSERR ==
 573       GNUNET_CONTAINER_multihashmap_get_multiple (ent->results,
 574                                                   &key,
 575                                                   &test_result_present,
 576                                                   (void *) uri))
 577     return;                     /* duplicate result */
 578   /* try to find search result in master map */
 579   grc.sr = NULL;
 580   grc.uri = uri;
 581   GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map,
 582                                               &key,
 583                                               &get_result_present, &grc);
 584   sr = grc.sr;
 585   is_new = (NULL == sr) || (sr->mandatory_missing > 0);
 586   if (NULL == sr)
 587   {
 588     sr = GNUNET_new (struct GNUNET_FS_SearchResult);
 589     sr->h = sc->h;
 590     sr->sc = sc;
 591     sr->anonymity = sc->anonymity;
 592     sr->uri = GNUNET_FS_uri_dup (uri);
 593     sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 594     sr->mandatory_missing = sc->mandatory_count;
 595     sr->key = key;
 596     sr->keyword_bitmap = GNUNET_malloc ((sc->uri->data.ksk.keywordCount + 7) / 8); /* round up, count bits */
 597     GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &key, sr,
 598                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 599   }
 600   else
 601   {
 602     GNUNET_CONTAINER_meta_data_merge (sr->meta, meta);
 603   }
 604   GNUNET_break (GNUNET_OK ==
 605                 GNUNET_CONTAINER_multihashmap_put (ent->results,
 606                                                    &sr->key,
 607                                                    sr,
 608                                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
 609
 610   koff = ent - sc->requests;
 611   GNUNET_assert ( (ent >= sc->requests) &&
 612                   (koff < sc->uri->data.ksk.keywordCount));
 613   sr->keyword_bitmap[koff / 8] |= (1 << (koff % 8));
 614   /* check if mandatory satisfied */
 615   if (1 <= GNUNET_CONTAINER_multihashmap_size (ent->results))
 616   {
 617     if (ent->mandatory)
 618     {
 619       GNUNET_break (sr->mandatory_missing > 0);
 620       sr->mandatory_missing--;
 621     }
 622     else
 623     {
 624       sr->optional_support++;
 625     }
 626   }
 627   if (0 != sr->mandatory_missing)
 628   {
 629     GNUNET_break (NULL == sr->client_info);
 630     return;
 631   }
 632   if (is_new)
 633     notify_client_chk_result (sc, sr);
 634   else
 635     notify_client_chk_update (sc, sr);
 636   GNUNET_FS_search_result_sync_ (sr);
 637   GNUNET_FS_search_start_probe_ (sr);
 638 }
 639
 640
 641 /**
 642  * Start search for content, internal API.
 643  *
 644  * @param h handle to the file sharing subsystem
 645  * @param uri specifies the search parameters; can be
 646  *        a KSK URI or an SKS URI.
 647  * @param anonymity desired level of anonymity
 648  * @param options options for the search
 649  * @param cctx client context
 650  * @param psearch parent search result (for namespace update searches)
 651  * @return context that can be used to control the search
 652  */
 653 static struct GNUNET_FS_SearchContext *
 654 search_start (struct GNUNET_FS_Handle *h,
 655               const struct GNUNET_FS_Uri *uri,
 656               uint32_t anonymity,
 657               enum GNUNET_FS_SearchOptions options,
 658               void *cctx,
 659               struct GNUNET_FS_SearchResult *psearch);
 660
 661
 662 /**
 663  * We have received an SKS result.  Start searching for updates and
 664  * notify the client if it is a new result.
 665  *
 666  * @param sc context for the overall query
 667  * @param id_update identifier for updates, NULL for none
 668  * @param uri the URI that was found
 669  * @param meta metadata associated with the URI
 670   */
 671 static void
 672 process_sks_result (struct GNUNET_FS_SearchContext *sc,
 673                     const char *id_update,
 674                     const struct GNUNET_FS_Uri *uri,
 675                     const struct GNUNET_CONTAINER_MetaData *meta)
 676 {
 677   struct GNUNET_FS_Uri uu;
 678   struct GNUNET_HashCode key;
 679   struct GNUNET_FS_SearchResult *sr;
 680
 681   /* check if new */
 682   GNUNET_assert (NULL != sc);
 683   GNUNET_FS_uri_to_key (uri, &key);
 684   GNUNET_CRYPTO_hash_xor (&uri->data.chk.chk.key, &uri->data.chk.chk.query,
 685                           &key);
 686   if (GNUNET_SYSERR ==
 687       GNUNET_CONTAINER_multihashmap_get_multiple (sc->master_result_map, &key,
 688                                                   &test_result_present,
 689                                                   (void *) uri))
 690     return;                     /* duplicate result */
 691   sr = GNUNET_new (struct GNUNET_FS_SearchResult);
 692   sr->h = sc->h;
 693   sr->sc = sc;
 694   sr->anonymity = sc->anonymity;
 695   sr->uri = GNUNET_FS_uri_dup (uri);
 696   sr->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
 697   sr->key = key;
 698   GNUNET_CONTAINER_multihashmap_put (sc->master_result_map, &key, sr,
 699                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 700   GNUNET_FS_search_result_sync_ (sr);
 701   GNUNET_FS_search_start_probe_ (sr);
 702   /* notify client */
 703   if (0 == sr->mandatory_missing)
 704     notify_client_chk_result (sc, sr);
 705   else
 706     GNUNET_break (NULL == sr->client_info);
 707   /* search for updates */
 708   if (0 == strlen (id_update))
 709     return;                     /* no updates */
 710   uu.type = GNUNET_FS_URI_SKS;
 711   uu.data.sks.ns = sc->uri->data.sks.ns;
 712   uu.data.sks.identifier = GNUNET_strdup (id_update);
 713   (void) search_start (sc->h, &uu, sc->anonymity, sc->options, NULL, sr);
 714   GNUNET_free (uu.data.sks.identifier);
 715 }
 716
 717
 718 /**
 719  * Decrypt a ublock using a 'keyword' as the passphrase.  Given the
 720  * KSK public key derived from the keyword, this function looks up
 721  * the original keyword in the search context and decrypts the
 722  * given ciphertext block.
 723  *
 724  * @param sc search context with the keywords
 725  * @param dpub derived public key used for the search
 726  * @param edata encrypted data
 727  * @param edata_size number of bytes in @a edata (and @a data)
 728  * @param data where to store the plaintext
 729  * @return keyword index on success, #GNUNET_SYSERR on error (no such
 730  *         keyword, internal error)
 731  */
 732 static int
 733 decrypt_block_with_keyword (const struct GNUNET_FS_SearchContext *sc,
 734                             const struct GNUNET_CRYPTO_EcdsaPublicKey *dpub,
 735                             const void *edata,
 736                             size_t edata_size,
 737                             char *data)
 738 {
 739   const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
 740   struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
 741   unsigned int i;
 742
 743   /* find key */
 744   for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
 745     if (0 == memcmp (dpub,
 746                      &sc->requests[i].dpub,
 747                      sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey)))
 748       break;
 749   if (i == sc->uri->data.ksk.keywordCount)
 750   {
 751     /* oops, does not match any of our keywords!? */
 752     GNUNET_break (0);
 753     return GNUNET_SYSERR;
 754   }
 755   /* decrypt */
 756   anon = GNUNET_CRYPTO_ecdsa_key_get_anonymous ();
 757   GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
 758   GNUNET_FS_ublock_decrypt_ (edata, edata_size,
 759                              &anon_pub,
 760                              sc->requests[i].keyword,
 761                              data);
 762   return i;
 763 }
 764
 765
 766 /**
 767  * Process a keyword search result.  The actual type of block is
 768  * a UBlock; we know it is a keyword search result because that's
 769  * what we were searching for.
 770  *
 771  * @param sc our search context
 772  * @param ub the ublock with the keyword search result
 773  * @param size size of @a ub
 774  */
 775 static void
 776 process_kblock (struct GNUNET_FS_SearchContext *sc,
 777                 const struct UBlock *ub,
 778                 size_t size)
 779 {
 780   size_t j;
 781   char pt[size - sizeof (struct UBlock)];
 782   const char *eos;
 783   struct GNUNET_CONTAINER_MetaData *meta;
 784   struct GNUNET_FS_Uri *uri;
 785   char *emsg;
 786   int i;
 787
 788   if (-1 == (i = decrypt_block_with_keyword (sc,
 789                                              &ub->verification_key,
 790                                              &ub[1],
 791                                              size - sizeof (struct UBlock),
 792                                              pt)))
 793     return;
 794   /* parse; pt[0] is just '\0', so we skip over that */
 795   eos = memchr (&pt[1], '\0', sizeof (pt) - 1);
 796   if (NULL == eos)
 797   {
 798     GNUNET_break_op (0);
 799     return;
 800   }
 801   if (NULL == (uri = GNUNET_FS_uri_parse (&pt[1], &emsg)))
 802   {
 803     if (GNUNET_FS_VERSION > 0x00090400)
 804     {
 805       /* we broke this in 0x00090300, so don't bitch
 806          too loudly just one version up... */
 807       GNUNET_break_op (0);        /* ublock malformed */
 808       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 809                   _("Failed to parse URI `%s': %s\n"),
 810                   &pt[1],
 811                   emsg);
 812     }
 813     GNUNET_free_non_null (emsg);
 814     return;
 815   }
 816   j = eos - pt + 1;
 817   if (sizeof (pt) == j)
 818     meta = GNUNET_CONTAINER_meta_data_create ();
 819   else
 820     meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[j], sizeof (pt) - j);
 821   if (NULL == meta)
 822   {
 823     GNUNET_break_op (0);        /* ublock malformed */
 824     GNUNET_FS_uri_destroy (uri);
 825     return;
 826   }
 827   process_ksk_result (sc,
 828                       &sc->requests[i],
 829                       uri,
 830                       meta);
 831
 832   /* clean up */
 833   GNUNET_CONTAINER_meta_data_destroy (meta);
 834   GNUNET_FS_uri_destroy (uri);
 835 }
 836
 837
 838 /**
 839  * Process a namespace-search result.  The actual type of block is
 840  * a UBlock; we know it is a namespace search result because that's
 841  * what we were searching for.
 842  *
 843  * @param sc our search context
 844  * @param ub the ublock with a namespace result
 845  * @param size size of @a ub
 846  */
 847 static void
 848 process_sblock (struct GNUNET_FS_SearchContext *sc,
 849                 const struct UBlock *ub,
 850                 size_t size)
 851 {
 852   size_t len = size - sizeof (struct UBlock);
 853   char pt[len];
 854   struct GNUNET_FS_Uri *uri;
 855   struct GNUNET_CONTAINER_MetaData *meta;
 856   const char *id;
 857   const char *uris;
 858   size_t off;
 859   char *emsg;
 860
 861   GNUNET_FS_ublock_decrypt_ (&ub[1], len,
 862                              &sc->uri->data.sks.ns,
 863                              sc->uri->data.sks.identifier,
 864                              pt);
 865   /* parse */
 866   if (0 == (off = GNUNET_STRINGS_buffer_tokenize (pt, len, 2, &id, &uris)))
 867   {
 868     GNUNET_break_op (0);        /* ublock malformed */
 869     return;
 870   }
 871   if (NULL == (meta = GNUNET_CONTAINER_meta_data_deserialize (&pt[off], len - off)))
 872   {
 873     GNUNET_break_op (0);        /* ublock malformed */
 874     return;
 875   }
 876   if (NULL == (uri = GNUNET_FS_uri_parse (uris, &emsg)))
 877   {
 878     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 879                 _("Failed to parse URI `%s': %s\n"),
 880                 uris, emsg);
 881     GNUNET_break_op (0);        /* ublock malformed */
 882     GNUNET_free_non_null (emsg);
 883     GNUNET_CONTAINER_meta_data_destroy (meta);
 884     return;
 885   }
 886   /* process */
 887   process_sks_result (sc, id, uri, meta);
 888   /* clean up */
 889   GNUNET_FS_uri_destroy (uri);
 890   GNUNET_CONTAINER_meta_data_destroy (meta);
 891 }
 892
 893
 894 /**
 895  * Shutdown any existing connection to the FS
 896  * service and try to establish a fresh one
 897  * (and then re-transmit our search request).
 898  *
 899  * @param sc the search to reconnec
 900  */
 901 static void
 902 try_reconnect (struct GNUNET_FS_SearchContext *sc);
 903
 904
 905 /**
 906  * We check a result message from the service.
 907  *
 908  * @param cls closure
 909  * @param msg result message received
 910  */
 911 static int
 912 check_result (void *cls,
 913               const struct ClientPutMessage *cm)
 914 {
 915   /* payload of any variable size is OK */
 916   return GNUNET_OK;
 917 }
 918
 919
 920 /**
 921  * We process a search result from the service.
 922  *
 923  * @param cls closure
 924  * @param msg result message received
 925  */
 926 static void
 927 handle_result (void *cls,
 928                const struct ClientPutMessage *cm)
 929 {
 930   struct GNUNET_FS_SearchContext *sc = cls;
 931   uint16_t msize = ntohs (cm->header.size) - sizeof (*cm);
 932   enum GNUNET_BLOCK_Type type = ntohl (cm->type);
 933
 934   if (GNUNET_TIME_absolute_get_duration (GNUNET_TIME_absolute_ntoh (cm->expiration)).rel_value_us > 0)
 935   {
 936     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 937                 "Result received has already expired.\n");
 938     return;                     /* result expired */
 939   }
 940   switch (type)
 941   {
 942   case GNUNET_BLOCK_TYPE_FS_UBLOCK:
 943     if (GNUNET_FS_URI_SKS == sc->uri->type)
 944       process_sblock (sc,
 945                       (const struct UBlock *) &cm[1],
 946                       msize);
 947     else
 948       process_kblock (sc,
 949                       (const struct UBlock *) &cm[1],
 950                       msize);
 951     break;
 952   case GNUNET_BLOCK_TYPE_ANY:
 953     GNUNET_break (0);
 954     break;
 955   case GNUNET_BLOCK_TYPE_FS_DBLOCK:
 956     GNUNET_break (0);
 957     break;
 958   case GNUNET_BLOCK_TYPE_FS_ONDEMAND:
 959     GNUNET_break (0);
 960     break;
 961   case GNUNET_BLOCK_TYPE_FS_IBLOCK:
 962     GNUNET_break (0);
 963     break;
 964   default:
 965     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 966                 _("Got result with unknown block type `%d', ignoring"),
 967                 type);
 968     break;
 969   }
 970 }
 971
 972
 973 /**
 974  * Schedule the transmission of the (next) search request
 975  * to the service.
 976  *
 977  * @param sc context for the search
 978  */
 979 static void
 980 schedule_transmit_search_request (struct GNUNET_FS_SearchContext *sc);
 981
 982
 983 /**
 984  * Closure for #build_result_set().
 985  */
 986 struct MessageBuilderContext
 987 {
 988   /**
 989    * How many entries can we store to xoff.
 990    */
 991   unsigned int put_cnt;
 992
 993   /**
 994    * How many entries should we skip.
 995    */
 996   unsigned int skip_cnt;
 997
 998   /**
 999    * Where to store the keys.
1000    */
1001   struct GNUNET_HashCode *xoff;
1002
1003   /**
1004    * Search context we are iterating for.
1005    */
1006   struct GNUNET_FS_SearchContext *sc;
1007
1008   /**
1009    * Keyword offset the search result must match (0 for SKS)
1010    */
1011   unsigned int keyword_offset;
1012 };
1013
1014
1015 /**
1016  * Iterating over the known results, pick those matching the given
1017  * result range and store their keys at 'xoff'.
1018  *
1019  * @param cls the `struct MessageBuilderContext`
1020  * @param key key for a result
1021  * @param value the search result
1022  * @return #GNUNET_OK to continue iterating
1023  */
1024 static int
1025 build_result_set (void *cls,
1026                   const struct GNUNET_HashCode *key,
1027                   void *value)
1028 {
1029   struct MessageBuilderContext *mbc = cls;
1030   struct GNUNET_FS_SearchResult *sr = value;
1031
1032   if ( (NULL != sr->keyword_bitmap) &&
1033        (0 == (sr->keyword_bitmap[mbc->keyword_offset / 8] & (1 << (mbc->keyword_offset % 8)))) )
1034     return GNUNET_OK; /* have no match for this keyword yet */
1035   if (mbc->skip_cnt > 0)
1036   {
1037     mbc->skip_cnt--;
1038     return GNUNET_OK;
1039   }
1040   if (0 == mbc->put_cnt)
1041     return GNUNET_SYSERR;
1042   mbc->xoff[--mbc->put_cnt] = *key;
1043
1044   return GNUNET_OK;
1045 }
1046
1047
1048 /**
1049  * Iterating over the known results, count those matching the given
1050  * result range and increment put count for each.
1051  *
1052  * @param cls the `struct MessageBuilderContext`
1053  * @param key key for a result
1054  * @param value the search result
1055  * @return #GNUNET_OK to continue iterating
1056  */
1057 static int
1058 find_result_set (void *cls,
1059                  const struct GNUNET_HashCode *key,
1060                  void *value)
1061 {
1062   struct MessageBuilderContext *mbc = cls;
1063   struct GNUNET_FS_SearchResult *sr = value;
1064
1065   if ( (NULL != sr->keyword_bitmap) &&
1066        (0 == (sr->keyword_bitmap[mbc->keyword_offset / 8] & (1 << (mbc->keyword_offset % 8)))) )
1067     return GNUNET_OK; /* have no match for this keyword yet */
1068   mbc->put_cnt++;
1069   return GNUNET_OK;
1070 }
1071
1072
1073 /**
1074  * Schedule the transmission of the (next) search request
1075  * to the service.
1076  *
1077  * @param sc context for the search
1078  */
1079 static void
1080 schedule_transmit_search_request (struct GNUNET_FS_SearchContext *sc)
1081 {
1082   struct MessageBuilderContext mbc;
1083   struct GNUNET_MQ_Envelope *env;
1084   struct SearchMessage *sm;
1085   struct GNUNET_CRYPTO_EcdsaPublicKey dpub;
1086   unsigned int total_seen_results; /* total number of result hashes to send */
1087   uint32_t options;
1088   unsigned int left;
1089   unsigned int todo;
1090   unsigned int fit;
1091   unsigned int search_request_map_offset;
1092   unsigned int keyword_offset;
1093   int first_call;
1094
1095   memset (&mbc, 0, sizeof (mbc));
1096   mbc.sc = sc;
1097   if (GNUNET_FS_uri_test_ksk (sc->uri))
1098   {
1099     /* This will calculate the result set size ONLY for
1100        "keyword_offset == 0", so we will have to recalculate
1101        it for the other keywords later! */
1102     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1103                                            &find_result_set,
1104                                            &mbc);
1105     total_seen_results = mbc.put_cnt;
1106   }
1107   else
1108   {
1109     total_seen_results
1110       = GNUNET_CONTAINER_multihashmap_size (sc->master_result_map);
1111   }
1112   search_request_map_offset = 0;
1113   keyword_offset = 0;
1114   first_call = GNUNET_YES;
1115   while ( (0 != (left =
1116                  (total_seen_results - search_request_map_offset))) ||
1117           (GNUNET_YES == first_call) )
1118   {
1119     first_call = GNUNET_NO;
1120     options = SEARCH_MESSAGE_OPTION_NONE;
1121     if (0 != (sc->options & GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY))
1122       options |= SEARCH_MESSAGE_OPTION_LOOPBACK_ONLY;
1123
1124     fit = (GNUNET_SERVER_MAX_MESSAGE_SIZE - 1 - sizeof (*sm)) / sizeof (struct GNUNET_HashCode);
1125     todo = GNUNET_MIN (fit,
1126                        left);
1127     env = GNUNET_MQ_msg_extra (sm,
1128                                sizeof (struct GNUNET_HashCode) * todo,
1129                                GNUNET_MESSAGE_TYPE_FS_START_SEARCH);
1130     mbc.skip_cnt = search_request_map_offset;
1131     mbc.xoff = (struct GNUNET_HashCode *) &sm[1];
1132     sm->type = htonl (GNUNET_BLOCK_TYPE_FS_UBLOCK);
1133     sm->anonymity_level = htonl (sc->anonymity);
1134     memset (&sm->target,
1135             0,
1136             sizeof (struct GNUNET_PeerIdentity));
1137
1138     if (GNUNET_FS_uri_test_ksk (sc->uri))
1139     {
1140       mbc.keyword_offset = keyword_offset;
1141       /* calculate how many results we can send in this message */
1142       mbc.put_cnt = todo;
1143       /* now build message */
1144       sm->query = sc->requests[keyword_offset].uquery;
1145       GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1146                                              &build_result_set,
1147                                              &mbc);
1148       search_request_map_offset += todo;
1149       GNUNET_assert (0 == mbc.put_cnt);
1150       GNUNET_assert (total_seen_results >= search_request_map_offset);
1151       if (total_seen_results != search_request_map_offset)
1152       {
1153         /* more requesting to be done... */
1154         sm->options = htonl (options | SEARCH_MESSAGE_OPTION_CONTINUED);
1155       }
1156       else
1157       {
1158         sm->options = htonl (options);
1159         keyword_offset++;
1160         if (sc->uri->data.ksk.keywordCount != keyword_offset)
1161         {
1162           /* more keywords => more requesting to be done... */
1163           first_call = GNUNET_YES;
1164           search_request_map_offset = 0;
1165           mbc.put_cnt = 0;
1166           mbc.keyword_offset = keyword_offset;
1167           GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1168                                                  &find_result_set,
1169                                                  &mbc);
1170           total_seen_results = mbc.put_cnt;
1171         }
1172       }
1173     }
1174     else
1175     {
1176       GNUNET_assert (GNUNET_FS_uri_test_sks (sc->uri));
1177
1178       GNUNET_CRYPTO_ecdsa_public_key_derive (&sc->uri->data.sks.ns,
1179                                              sc->uri->data.sks.identifier,
1180                                              "fs-ublock",
1181                                              &dpub);
1182       GNUNET_CRYPTO_hash (&dpub,
1183                           sizeof (dpub),
1184                           &sm->query);
1185       mbc.put_cnt = todo;
1186       mbc.keyword_offset = 0;
1187       GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1188                                              &build_result_set,
1189                                              &mbc);
1190       GNUNET_assert (total_seen_results >= search_request_map_offset);
1191       if (total_seen_results != search_request_map_offset)
1192       {
1193         /* more requesting to be done... */
1194         sm->options = htonl (options | SEARCH_MESSAGE_OPTION_CONTINUED);
1195       }
1196       else
1197       {
1198         sm->options = htonl (options);
1199       }
1200     }
1201     GNUNET_MQ_send (sc->mq,
1202                     env);
1203   }
1204 }
1205
1206
1207 /**
1208  * Generic error handler, called with the appropriate error code and
1209  * the same closure specified at the creation of the message queue.
1210  * Not every message queue implementation supports an error handler.
1211  *
1212  * @param cls closure with the `struct GNUNET_FS_SearchContext *`
1213  * @param error error code
1214  */
1215 static void
1216 search_mq_error_handler (void *cls,
1217                          enum GNUNET_MQ_Error error)
1218 {
1219   struct GNUNET_FS_SearchContext *sc = cls;
1220
1221   if (NULL != sc->mq)
1222   {
1223     GNUNET_MQ_destroy (sc->mq);
1224     sc->mq = NULL;
1225   }
1226   try_reconnect (sc);
1227 }
1228
1229
1230 /**
1231  * Reconnect to the FS service and transmit
1232  * our queries NOW.
1233  *
1234  * @param cls our search context
1235  */
1236 static void
1237 do_reconnect (void *cls)
1238 {
1239   struct GNUNET_FS_SearchContext *sc = cls;
1240   struct GNUNET_MQ_MessageHandler handlers[] = {
1241     GNUNET_MQ_hd_var_size (result,
1242                            GNUNET_MESSAGE_TYPE_FS_PUT,
1243                            struct ClientPutMessage,
1244                            sc),
1245     GNUNET_MQ_handler_end ()
1246   };
1247
1248   sc->task = NULL;
1249   sc->mq = GNUNET_CLIENT_connect (sc->h->cfg,
1250                                   "fs",
1251                                   handlers,
1252                                   &search_mq_error_handler,
1253                                   sc);
1254   if (NULL == sc->mq)
1255   {
1256     try_reconnect (sc);
1257     return;
1258   }
1259   schedule_transmit_search_request (sc);
1260 }
1261
1262
1263 /**
1264  * Shutdown any existing connection to the FS
1265  * service and try to establish a fresh one
1266  * (and then re-transmit our search request).
1267  *
1268  * @param sc the search to reconnec
1269  */
1270 static void
1271 try_reconnect (struct GNUNET_FS_SearchContext *sc)
1272 {
1273   if (NULL != sc->mq)
1274   {
1275     GNUNET_MQ_destroy (sc->mq);
1276     sc->mq = NULL;
1277   }
1278   sc->reconnect_backoff = GNUNET_TIME_STD_BACKOFF (sc->reconnect_backoff);
1279   sc->task =
1280       GNUNET_SCHEDULER_add_delayed (sc->reconnect_backoff,
1281                                     &do_reconnect,
1282                                     sc);
1283 }
1284
1285
1286 /**
1287  * Start search for content, internal API.
1288  *
1289  * @param h handle to the file sharing subsystem
1290  * @param uri specifies the search parameters; can be
1291  *        a KSK URI or an SKS URI.
1292  * @param anonymity desired level of anonymity
1293  * @param options options for the search
1294  * @param cctx initial value for the client context
1295  * @param psearch parent search result (for namespace update searches)
1296  * @return context that can be used to control the search
1297  */
1298 static struct GNUNET_FS_SearchContext *
1299 search_start (struct GNUNET_FS_Handle *h,
1300               const struct GNUNET_FS_Uri *uri,
1301               uint32_t anonymity,
1302               enum GNUNET_FS_SearchOptions options,
1303               void *cctx,
1304               struct GNUNET_FS_SearchResult *psearch)
1305 {
1306   struct GNUNET_FS_SearchContext *sc;
1307   struct GNUNET_FS_ProgressInfo pi;
1308
1309   sc = GNUNET_new (struct GNUNET_FS_SearchContext);
1310   sc->h = h;
1311   sc->options = options;
1312   sc->uri = GNUNET_FS_uri_dup (uri);
1313   sc->anonymity = anonymity;
1314   sc->start_time = GNUNET_TIME_absolute_get ();
1315   if (NULL != psearch)
1316   {
1317     sc->psearch_result = psearch;
1318     psearch->update_search = sc;
1319   }
1320   sc->master_result_map = GNUNET_CONTAINER_multihashmap_create (16, GNUNET_NO);
1321   sc->client_info = cctx;
1322   if (GNUNET_OK != GNUNET_FS_search_start_searching_ (sc))
1323   {
1324     GNUNET_FS_uri_destroy (sc->uri);
1325     GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1326     GNUNET_free (sc);
1327     return NULL;
1328   }
1329   GNUNET_FS_search_sync_ (sc);
1330   pi.status = GNUNET_FS_STATUS_SEARCH_START;
1331   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1332   return sc;
1333 }
1334
1335
1336 /**
1337  * Update the 'results' map for the individual keywords with the
1338  * results from the 'global' result set.
1339  *
1340  * @param cls closure, the `struct GNUNET_FS_SearchContext *`
1341  * @param key current key code
1342  * @param value value in the hash map, the `struct GNUNET_FS_SearchResult *`
1343  * @return #GNUNET_YES (we should continue to iterate)
1344  */
1345 static int
1346 update_sre_result_maps (void *cls,
1347                         const struct GNUNET_HashCode *key,
1348                         void *value)
1349 {
1350   struct GNUNET_FS_SearchContext *sc = cls;
1351   struct GNUNET_FS_SearchResult *sr = value;
1352   unsigned int i;
1353
1354   for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1355     if (0 != (sr->keyword_bitmap[i / 8] & (1 << (i % 8))))
1356       GNUNET_break (GNUNET_OK ==
1357                     GNUNET_CONTAINER_multihashmap_put (sc->requests[i].results,
1358                                                        &sr->key,
1359                                                        sr,
1360                                                        GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1361
1362   return GNUNET_YES;
1363 }
1364
1365
1366 /**
1367  * Build the request and actually initiate the search using the
1368  * GNUnet FS service.
1369  *
1370  * @param sc search context
1371  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
1372  */
1373 int
1374 GNUNET_FS_search_start_searching_ (struct GNUNET_FS_SearchContext *sc)
1375 {
1376   unsigned int i;
1377   const char *keyword;
1378   const struct GNUNET_CRYPTO_EcdsaPrivateKey *anon;
1379   struct GNUNET_CRYPTO_EcdsaPublicKey anon_pub;
1380   struct SearchRequestEntry *sre;
1381
1382   GNUNET_assert (NULL == sc->mq);
1383   if (GNUNET_FS_uri_test_ksk (sc->uri))
1384   {
1385     GNUNET_assert (0 != sc->uri->data.ksk.keywordCount);
1386     anon = GNUNET_CRYPTO_ecdsa_key_get_anonymous ();
1387     GNUNET_CRYPTO_ecdsa_key_get_public (anon, &anon_pub);
1388     sc->requests
1389       = GNUNET_new_array (sc->uri->data.ksk.keywordCount,
1390                           struct SearchRequestEntry);
1391
1392     for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1393     {
1394       keyword = &sc->uri->data.ksk.keywords[i][1];
1395       sre = &sc->requests[i];
1396       sre->keyword = GNUNET_strdup (keyword);
1397       GNUNET_CRYPTO_ecdsa_public_key_derive (&anon_pub,
1398                                              keyword,
1399                                              "fs-ublock",
1400                                              &sre->dpub);
1401       GNUNET_CRYPTO_hash (&sre->dpub,
1402                           sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey),
1403                           &sre->uquery);
1404       sre->mandatory = (sc->uri->data.ksk.keywords[i][0] == '+');
1405       if (sre->mandatory)
1406         sc->mandatory_count++;
1407       sre->results = GNUNET_CONTAINER_multihashmap_create (4, GNUNET_NO);
1408     }
1409     GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1410                                            &update_sre_result_maps,
1411                                            sc);
1412   }
1413   GNUNET_assert (NULL == sc->task);
1414   do_reconnect (sc);
1415   if (NULL == sc->mq)
1416   {
1417     GNUNET_SCHEDULER_cancel (sc->task);
1418     sc->task = NULL;
1419     return GNUNET_SYSERR;
1420   }
1421   return GNUNET_OK;
1422 }
1423
1424
1425 /**
1426  * Freeze probes for the given search result.
1427  *
1428  * @param cls the global FS handle
1429  * @param key the key for the search result (unused)
1430  * @param value the search result to free
1431  * @return #GNUNET_OK
1432  */
1433 static int
1434 search_result_freeze_probes (void *cls,
1435                              const struct GNUNET_HashCode *key,
1436                              void *value)
1437 {
1438   struct GNUNET_FS_SearchResult *sr = value;
1439
1440   if (NULL != sr->probe_ctx)
1441   {
1442     GNUNET_FS_download_stop (sr->probe_ctx, GNUNET_YES);
1443     sr->probe_ctx = NULL;
1444     GNUNET_FS_stop_probe_ping_task_ (sr);
1445   }
1446   if (NULL != sr->probe_cancel_task)
1447   {
1448     GNUNET_SCHEDULER_cancel (sr->probe_cancel_task);
1449     sr->probe_cancel_task = NULL;
1450   }
1451   if (NULL != sr->update_search)
1452     GNUNET_FS_search_pause (sr->update_search);
1453   return GNUNET_OK;
1454 }
1455
1456
1457 /**
1458  * Resume probes for the given search result.
1459  *
1460  * @param cls the global FS handle
1461  * @param key the key for the search result (unused)
1462  * @param value the search result to free
1463  * @return #GNUNET_OK
1464  */
1465 static int
1466 search_result_resume_probes (void *cls,
1467                              const struct GNUNET_HashCode * key,
1468                              void *value)
1469 {
1470   struct GNUNET_FS_SearchResult *sr = value;
1471
1472   GNUNET_FS_search_start_probe_ (sr);
1473   if (NULL != sr->update_search)
1474     GNUNET_FS_search_continue (sr->update_search);
1475   return GNUNET_OK;
1476 }
1477
1478
1479 /**
1480  * Signal suspend and free the given search result.
1481  *
1482  * @param cls the global FS handle
1483  * @param key the key for the search result (unused)
1484  * @param value the search result to free
1485  * @return #GNUNET_OK
1486  */
1487 static int
1488 search_result_suspend (void *cls,
1489                        const struct GNUNET_HashCode *key,
1490                        void *value)
1491 {
1492   struct GNUNET_FS_SearchContext *sc = cls;
1493   struct GNUNET_FS_SearchResult *sr = value;
1494   struct GNUNET_FS_ProgressInfo pi;
1495
1496   if (NULL != sr->download)
1497   {
1498     GNUNET_FS_download_signal_suspend_ (sr->download);
1499     sr->download = NULL;
1500   }
1501   if (NULL != sr->update_search)
1502   {
1503     GNUNET_FS_search_signal_suspend_ (sr->update_search);
1504     sr->update_search = NULL;
1505   }
1506   GNUNET_FS_search_stop_probe_ (sr);
1507   if (0 == sr->mandatory_missing)
1508   {
1509     /* client is aware of search result, notify about suspension event */
1510     pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_SUSPEND;
1511     pi.value.search.specifics.result_suspend.cctx = sr->client_info;
1512     pi.value.search.specifics.result_suspend.meta = sr->meta;
1513     pi.value.search.specifics.result_suspend.uri = sr->uri;
1514     sr->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1515   }
1516   GNUNET_break (NULL == sr->client_info);
1517   GNUNET_free_non_null (sr->serialization);
1518   GNUNET_FS_uri_destroy (sr->uri);
1519   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1520   GNUNET_free_non_null (sr->keyword_bitmap);
1521   GNUNET_free (sr);
1522   return GNUNET_OK;
1523 }
1524
1525
1526 /**
1527  * Create SUSPEND event for the given search operation
1528  * and then clean up our state (without stop signal).
1529  *
1530  * @param cls the `struct GNUNET_FS_SearchContext` to signal for
1531  */
1532 void
1533 GNUNET_FS_search_signal_suspend_ (void *cls)
1534 {
1535   struct GNUNET_FS_SearchContext *sc = cls;
1536   struct GNUNET_FS_ProgressInfo pi;
1537   unsigned int i;
1538
1539   GNUNET_FS_end_top (sc->h, sc->top);
1540   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1541                                          &search_result_suspend, sc);
1542   pi.status = GNUNET_FS_STATUS_SEARCH_SUSPEND;
1543   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1544   GNUNET_break (NULL == sc->client_info);
1545   if (sc->task != NULL)
1546   {
1547     GNUNET_SCHEDULER_cancel (sc->task);
1548     sc->task = NULL;
1549   }
1550   if (NULL != sc->mq)
1551   {
1552     GNUNET_MQ_destroy (sc->mq);
1553     sc->mq = NULL;
1554   }
1555   GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1556   if (NULL != sc->requests)
1557   {
1558     GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1559     for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1560     {
1561       GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1562       GNUNET_free (sc->requests[i].keyword);
1563     }
1564   }
1565   GNUNET_free_non_null (sc->requests);
1566   GNUNET_free_non_null (sc->emsg);
1567   GNUNET_FS_uri_destroy (sc->uri);
1568   GNUNET_free_non_null (sc->serialization);
1569   GNUNET_free (sc);
1570 }
1571
1572
1573 /**
1574  * Start search for content.
1575  *
1576  * @param h handle to the file sharing subsystem
1577  * @param uri specifies the search parameters; can be
1578  *        a KSK URI or an SKS URI.
1579  * @param anonymity desired level of anonymity
1580  * @param options options for the search
1581  * @param cctx initial value for the client context
1582  * @return context that can be used to control the search
1583  */
1584 struct GNUNET_FS_SearchContext *
1585 GNUNET_FS_search_start (struct GNUNET_FS_Handle *h,
1586                         const struct GNUNET_FS_Uri *uri, uint32_t anonymity,
1587                         enum GNUNET_FS_SearchOptions options, void *cctx)
1588 {
1589   struct GNUNET_FS_SearchContext *ret;
1590
1591   ret = search_start (h, uri, anonymity, options, cctx, NULL);
1592   if (NULL == ret)
1593     return NULL;
1594   ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_search_signal_suspend_, ret);
1595   return ret;
1596 }
1597
1598
1599 /**
1600  * Pause search.
1601  *
1602  * @param sc context for the search that should be paused
1603  */
1604 void
1605 GNUNET_FS_search_pause (struct GNUNET_FS_SearchContext *sc)
1606 {
1607   struct GNUNET_FS_ProgressInfo pi;
1608
1609   if (NULL != sc->task)
1610   {
1611     GNUNET_SCHEDULER_cancel (sc->task);
1612     sc->task = NULL;
1613   }
1614   if (NULL != sc->mq)
1615   {
1616     GNUNET_MQ_destroy (sc->mq);
1617     sc->mq = NULL;
1618   }
1619   GNUNET_FS_search_sync_ (sc);
1620   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1621                                          &search_result_freeze_probes,
1622                                          sc);
1623   pi.status = GNUNET_FS_STATUS_SEARCH_PAUSED;
1624   sc->client_info = GNUNET_FS_search_make_status_ (&pi,
1625                                                    sc->h,
1626                                                    sc);
1627 }
1628
1629
1630 /**
1631  * Continue paused search.
1632  *
1633  * @param sc context for the search that should be resumed
1634  */
1635 void
1636 GNUNET_FS_search_continue (struct GNUNET_FS_SearchContext *sc)
1637 {
1638   struct GNUNET_FS_ProgressInfo pi;
1639
1640   GNUNET_assert (NULL == sc->mq);
1641   GNUNET_assert (NULL == sc->task);
1642   do_reconnect (sc);
1643   GNUNET_FS_search_sync_ (sc);
1644   pi.status = GNUNET_FS_STATUS_SEARCH_CONTINUED;
1645   sc->client_info = GNUNET_FS_search_make_status_ (&pi, sc->h, sc);
1646   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1647                                          &search_result_resume_probes, sc);
1648 }
1649
1650
1651 /**
1652  * Signal stop for the given search result.
1653  *
1654  * @param cls the global FS handle
1655  * @param key the key for the search result (unused)
1656  * @param value the search result to free
1657  * @return #GNUNET_OK
1658  */
1659 static int
1660 search_result_stop (void *cls,
1661                     const struct GNUNET_HashCode *key,
1662                     void *value)
1663 {
1664   struct GNUNET_FS_SearchContext *sc = cls;
1665   struct GNUNET_FS_SearchResult *sr = value;
1666   struct GNUNET_FS_ProgressInfo pi;
1667
1668   GNUNET_FS_search_stop_probe_ (sr);
1669   if (NULL != sr->download)
1670   {
1671     sr->download->search = NULL;
1672     sr->download->top
1673       = GNUNET_FS_make_top (sr->download->h,
1674                             &GNUNET_FS_download_signal_suspend_,
1675                             sr->download);
1676     if (NULL != sr->download->serialization)
1677     {
1678       GNUNET_FS_remove_sync_file_ (sc->h,
1679                                    GNUNET_FS_SYNC_PATH_CHILD_DOWNLOAD,
1680                                    sr->download->serialization);
1681       GNUNET_free (sr->download->serialization);
1682       sr->download->serialization = NULL;
1683     }
1684     pi.status = GNUNET_FS_STATUS_DOWNLOAD_LOST_PARENT;
1685     GNUNET_FS_download_make_status_ (&pi,
1686                                      sr->download);
1687     GNUNET_FS_download_sync_ (sr->download);
1688     sr->download = NULL;
1689   }
1690   if (0 != sr->mandatory_missing)
1691   {
1692     /* client is unaware of search result as
1693        it does not match required keywords */
1694     GNUNET_break (NULL == sr->client_info);
1695     return GNUNET_OK;
1696   }
1697   pi.status = GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED;
1698   pi.value.search.specifics.result_stopped.cctx = sr->client_info;
1699   pi.value.search.specifics.result_stopped.meta = sr->meta;
1700   pi.value.search.specifics.result_stopped.uri = sr->uri;
1701   sr->client_info = GNUNET_FS_search_make_status_ (&pi, sr->h, sc);
1702   return GNUNET_OK;
1703 }
1704
1705
1706 /**
1707  * Free the given search result.
1708  *
1709  * @param cls the global FS handle
1710  * @param key the key for the search result (unused)
1711  * @param value the search result to free
1712  * @return #GNUNET_OK
1713  */
1714 static int
1715 search_result_free (void *cls,
1716                     const struct GNUNET_HashCode *key,
1717                     void *value)
1718 {
1719   struct GNUNET_FS_SearchResult *sr = value;
1720
1721   if (NULL != sr->update_search)
1722   {
1723     GNUNET_FS_search_stop (sr->update_search);
1724     GNUNET_assert (NULL == sr->update_search);
1725   }
1726   GNUNET_break (NULL == sr->probe_ctx);
1727   GNUNET_break (NULL == sr->probe_cancel_task);
1728   GNUNET_break (NULL == sr->client_info);
1729   GNUNET_free_non_null (sr->serialization);
1730   GNUNET_FS_uri_destroy (sr->uri);
1731   GNUNET_CONTAINER_meta_data_destroy (sr->meta);
1732   GNUNET_free_non_null (sr->keyword_bitmap);
1733   GNUNET_free (sr);
1734   return GNUNET_OK;
1735 }
1736
1737
1738 /**
1739  * Stop search for content.
1740  *
1741  * @param sc context for the search that should be stopped
1742  */
1743 void
1744 GNUNET_FS_search_stop (struct GNUNET_FS_SearchContext *sc)
1745 {
1746   struct GNUNET_FS_ProgressInfo pi;
1747   unsigned int i;
1748
1749   if (NULL != sc->top)
1750     GNUNET_FS_end_top (sc->h, sc->top);
1751   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1752                                          &search_result_stop,
1753                                          sc);
1754   if (NULL != sc->psearch_result)
1755     sc->psearch_result->update_search = NULL;
1756   if (NULL != sc->serialization)
1757   {
1758     GNUNET_FS_remove_sync_file_ (sc->h,
1759                                  (NULL != sc->psearch_result)
1760                                  ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH
1761                                  : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1762                                  sc->serialization);
1763     GNUNET_FS_remove_sync_dir_ (sc->h,
1764                                 (NULL != sc->psearch_result)
1765                                 ? GNUNET_FS_SYNC_PATH_CHILD_SEARCH
1766                                 : GNUNET_FS_SYNC_PATH_MASTER_SEARCH,
1767                                 sc->serialization);
1768     GNUNET_free (sc->serialization);
1769   }
1770   pi.status = GNUNET_FS_STATUS_SEARCH_STOPPED;
1771   sc->client_info = GNUNET_FS_search_make_status_ (&pi,
1772                                                    sc->h,
1773                                                    sc);
1774   GNUNET_break (NULL == sc->client_info);
1775   if (NULL != sc->task)
1776   {
1777     GNUNET_SCHEDULER_cancel (sc->task);
1778     sc->task = NULL;
1779   }
1780   if (NULL != sc->mq)
1781   {
1782     GNUNET_MQ_destroy (sc->mq);
1783     sc->mq = NULL;
1784   }
1785   GNUNET_CONTAINER_multihashmap_iterate (sc->master_result_map,
1786                                          &search_result_free, sc);
1787   GNUNET_CONTAINER_multihashmap_destroy (sc->master_result_map);
1788   if (NULL != sc->requests)
1789   {
1790     GNUNET_assert (GNUNET_FS_uri_test_ksk (sc->uri));
1791     for (i = 0; i < sc->uri->data.ksk.keywordCount; i++)
1792       GNUNET_CONTAINER_multihashmap_destroy (sc->requests[i].results);
1793   }
1794   GNUNET_free_non_null (sc->requests);
1795   GNUNET_free_non_null (sc->emsg);
1796   GNUNET_FS_uri_destroy (sc->uri);
1797   GNUNET_free (sc);
1798 }
1799
1800 /* end of fs_search.c */