src/fs/fs_directory.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2003, 2004, 2006, 2009 Christian Grothoff (and other contributing authors)
   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 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file fs/fs_directory.c
  23  * @brief Helper functions for building directories.
  24  * @author Christian Grothoff
  25  *
  26  * TODO:
  27  * - modify directory builder API to support incremental
  28  *   generation of directories (to allow directories that
  29  *   would not fit into memory to be created)
  30  * - modify directory processor API to support incremental
  31  *   iteration over FULL directories (without missing entries)
  32  *   to allow access to directories that do not fit entirely
  33  *   into memory
  34  */
  35 #include "platform.h"
  36 #include "gnunet_fs_service.h"
  37 #include "fs_api.h"
  38
  39 /**
  40  * String that is used to indicate that a file
  41  * is a GNUnet directory.
  42  */
  43 #define GNUNET_DIRECTORY_MAGIC "\211GND\r\n\032\n"
  44
  45
  46 /**
  47  * Does the meta-data claim that this is a directory?
  48  * Checks if the mime-type is that of a GNUnet directory.
  49  *
  50  * @return GNUNET_YES if it is, GNUNET_NO if it is not, GNUNET_SYSERR if
  51  *  we have no mime-type information (treat as 'GNUNET_NO')
  52  */
  53 int
  54 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData
  55                                         *md)
  56 {
  57   char *mime;
  58   int ret;
  59
  60   if (NULL == md)
  61     return GNUNET_SYSERR;
  62   mime =
  63       GNUNET_CONTAINER_meta_data_get_by_type (md, EXTRACTOR_METATYPE_MIMETYPE);
  64   if (mime == NULL)
  65     return GNUNET_SYSERR;
  66   ret = (0 == strcmp (mime, GNUNET_FS_DIRECTORY_MIME)) ? GNUNET_YES : GNUNET_NO;
  67   GNUNET_free (mime);
  68   return ret;
  69 }
  70
  71
  72 /**
  73  * Set the MIMETYPE information for the given
  74  * metadata to "application/gnunet-directory".
  75  *
  76  * @param md metadata to add mimetype to
  77  */
  78 void
  79 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md)
  80 {
  81   char *mime;
  82
  83   mime =
  84       GNUNET_CONTAINER_meta_data_get_by_type (md, EXTRACTOR_METATYPE_MIMETYPE);
  85   if (mime != NULL)
  86   {
  87     GNUNET_break (0 == strcmp (mime, GNUNET_FS_DIRECTORY_MIME));
  88     GNUNET_free (mime);
  89     return;
  90   }
  91   GNUNET_CONTAINER_meta_data_insert (md, "<gnunet>",
  92                                      EXTRACTOR_METATYPE_MIMETYPE,
  93                                      EXTRACTOR_METAFORMAT_UTF8, "text/plain",
  94                                      GNUNET_FS_DIRECTORY_MIME,
  95                                      strlen (GNUNET_FS_DIRECTORY_MIME) + 1);
  96 }
  97
  98
  99 /**
 100  * Closure for 'find_full_data'.
 101  */
 102 struct GetFullDataClosure
 103 {
 104
 105   /**
 106    * Extracted binary meta data.
 107    */
 108   void *data;
 109
 110   /**
 111    * Number of bytes stored in data.
 112    */
 113   size_t size;
 114 };
 115
 116
 117 /**
 118  * Type of a function that libextractor calls for each
 119  * meta data item found.
 120  *
 121  * @param cls closure (user-defined)
 122  * @param plugin_name name of the plugin that produced this value;
 123  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
 124  *        used in the main libextractor library and yielding
 125  *        meta data).
 126  * @param type libextractor-type describing the meta data
 127  * @param format basic format information about data
 128  * @param data_mime_type mime-type of data (not of the original file);
 129  *        can be NULL (if mime-type is not known)
 130  * @param data actual meta-data found
 131  * @param data_len number of bytes in data
 132  * @return 0 to continue extracting, 1 to abort
 133  */
 134 static int
 135 find_full_data (void *cls, const char *plugin_name,
 136                 enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
 137                 const char *data_mime_type, const char *data, size_t data_len)
 138 {
 139   struct GetFullDataClosure *gfdc = cls;
 140
 141   if (type == EXTRACTOR_METATYPE_GNUNET_FULL_DATA)
 142   {
 143     gfdc->size = data_len;
 144     if (data_len > 0)
 145     {
 146       gfdc->data = GNUNET_malloc (data_len);
 147       memcpy (gfdc->data, data, data_len);
 148     }
 149     return 1;
 150   }
 151   return 0;
 152 }
 153
 154
 155 /**
 156  * Iterate over all entries in a directory.  Note that directories
 157  * are structured such that it is possible to iterate over the
 158  * individual blocks as well as over the entire directory.  Thus
 159  * a client can call this function on the buffer in the
 160  * GNUNET_FS_ProgressCallback.  Also, directories can optionally
 161  * include the contents of (small) files embedded in the directory
 162  * itself; for those files, the processor may be given the
 163  * contents of the file directly by this function.
 164  * <p>
 165  *
 166  * Note that this function maybe called on parts of directories.  Thus
 167  * parser errors should not be reported _at all_ (with GNUNET_break).
 168  * Still, if some entries can be recovered despite these parsing
 169  * errors, the function should try to do this.
 170  *
 171  * @param size number of bytes in data
 172  * @param data pointer to the beginning of the directory
 173  * @param offset offset of data in the directory
 174  * @param dep function to call on each entry
 175  * @param dep_cls closure for dep
 176  * @return GNUNET_OK if this could be a block in a directory,
 177  *         GNUNET_NO if this could be part of a directory (but not 100% OK)
 178  *         GNUNET_SYSERR if 'data' does not represent a directory
 179  */
 180 int
 181 GNUNET_FS_directory_list_contents (size_t size, const void *data,
 182                                    uint64_t offset,
 183                                    GNUNET_FS_DirectoryEntryProcessor dep,
 184                                    void *dep_cls)
 185 {
 186   struct GetFullDataClosure full_data;
 187   const char *cdata = data;
 188   char *emsg;
 189   uint64_t pos;
 190   uint64_t align;
 191   uint32_t mdSize;
 192   uint64_t epos;
 193   struct GNUNET_FS_Uri *uri;
 194   struct GNUNET_CONTAINER_MetaData *md;
 195   char *filename;
 196
 197   if ((offset == 0) &&
 198       ((size < 8 + sizeof (uint32_t)) ||
 199        (0 != memcmp (cdata, GNUNET_FS_DIRECTORY_MAGIC, 8))))
 200     return GNUNET_SYSERR;
 201   pos = offset;
 202   if (offset == 0)
 203   {
 204     memcpy (&mdSize, &cdata[8], sizeof (uint32_t));
 205     mdSize = ntohl (mdSize);
 206     if (mdSize > size - 8 - sizeof (uint32_t))
 207     {
 208       /* invalid size */
 209       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 210                   _("MAGIC mismatch.  This is not a GNUnet directory.\n"));
 211       return GNUNET_SYSERR;
 212     }
 213     md = GNUNET_CONTAINER_meta_data_deserialize (&cdata[8 + sizeof (uint32_t)],
 214                                                  mdSize);
 215     if (md == NULL)
 216     {
 217       GNUNET_break (0);
 218       return GNUNET_SYSERR;     /* malformed ! */
 219     }
 220     dep (dep_cls, NULL, NULL, md, 0, NULL);
 221     GNUNET_CONTAINER_meta_data_destroy (md);
 222     pos = 8 + sizeof (uint32_t) + mdSize;
 223   }
 224   while (pos < size)
 225   {
 226     /* find end of URI */
 227     if (cdata[pos] == '\0')
 228     {
 229       /* URI is never empty, must be end of block,
 230        * skip to next alignment */
 231       align = ((pos / DBLOCK_SIZE) + 1) * DBLOCK_SIZE;
 232       if (align == pos)
 233       {
 234         /* if we were already aligned, still skip a block! */
 235         align += DBLOCK_SIZE;
 236       }
 237       pos = align;
 238       if (pos >= size)
 239       {
 240         /* malformed - or partial download... */
 241         break;
 242       }
 243     }
 244     epos = pos;
 245     while ((epos < size) && (cdata[epos] != '\0'))
 246       epos++;
 247     if (epos >= size)
 248       return GNUNET_NO;         /* malformed - or partial download */
 249
 250     uri = GNUNET_FS_uri_parse (&cdata[pos], &emsg);
 251     pos = epos + 1;
 252     if (uri == NULL)
 253     {
 254       GNUNET_free (emsg);
 255       pos--;                    /* go back to '\0' to force going to next alignment */
 256       continue;
 257     }
 258     if (GNUNET_FS_uri_test_ksk (uri))
 259     {
 260       GNUNET_FS_uri_destroy (uri);
 261       GNUNET_break (0);
 262       return GNUNET_NO;         /* illegal in directory! */
 263     }
 264
 265     memcpy (&mdSize, &cdata[pos], sizeof (uint32_t));
 266     mdSize = ntohl (mdSize);
 267     pos += sizeof (uint32_t);
 268     if (pos + mdSize > size)
 269     {
 270       GNUNET_FS_uri_destroy (uri);
 271       return GNUNET_NO;         /* malformed - or partial download */
 272     }
 273
 274     md = GNUNET_CONTAINER_meta_data_deserialize (&cdata[pos], mdSize);
 275     if (md == NULL)
 276     {
 277       GNUNET_FS_uri_destroy (uri);
 278       GNUNET_break (0);
 279       return GNUNET_NO;         /* malformed ! */
 280     }
 281     pos += mdSize;
 282     filename =
 283         GNUNET_CONTAINER_meta_data_get_by_type (md,
 284                                                 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
 285     full_data.size = 0;
 286     full_data.data = NULL;
 287     GNUNET_CONTAINER_meta_data_iterate (md, &find_full_data, &full_data);
 288     if (dep != NULL)
 289     {
 290       dep (dep_cls, filename, uri, md, full_data.size, full_data.data);
 291     }
 292     GNUNET_free_non_null (full_data.data);
 293     GNUNET_free_non_null (filename);
 294     GNUNET_CONTAINER_meta_data_destroy (md);
 295     GNUNET_FS_uri_destroy (uri);
 296   }
 297   return GNUNET_OK;
 298 }
 299
 300 /**
 301  * Entries in the directory (builder).
 302  */
 303 struct BuilderEntry
 304 {
 305   /**
 306    * This is a linked list.
 307    */
 308   struct BuilderEntry *next;
 309
 310   /**
 311    * Length of this entry.
 312    */
 313   size_t len;
 314 };
 315
 316 /**
 317  * Internal state of a directory builder.
 318  */
 319 struct GNUNET_FS_DirectoryBuilder
 320 {
 321   /**
 322    * Meta-data for the directory itself.
 323    */
 324   struct GNUNET_CONTAINER_MetaData *meta;
 325
 326   /**
 327    * Head of linked list of entries.
 328    */
 329   struct BuilderEntry *head;
 330
 331   /**
 332    * Number of entires in the directory.
 333    */
 334   unsigned int count;
 335 };
 336
 337
 338 /**
 339  * Create a directory builder.
 340  *
 341  * @param mdir metadata for the directory
 342  */
 343 struct GNUNET_FS_DirectoryBuilder *
 344 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData
 345                                     *mdir)
 346 {
 347   struct GNUNET_FS_DirectoryBuilder *ret;
 348
 349   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_DirectoryBuilder));
 350   if (mdir != NULL)
 351     ret->meta = GNUNET_CONTAINER_meta_data_duplicate (mdir);
 352   else
 353     ret->meta = GNUNET_CONTAINER_meta_data_create ();
 354   GNUNET_FS_meta_data_make_directory (ret->meta);
 355   return ret;
 356 }
 357
 358
 359 /**
 360  * Add an entry to a directory.
 361  *
 362  * @param bld directory to extend
 363  * @param uri uri of the entry (must not be a KSK)
 364  * @param md metadata of the entry
 365  * @param data raw data of the entry, can be NULL, otherwise
 366  *        data must point to exactly the number of bytes specified
 367  *        by the uri which must be of type LOC or CHK
 368  */
 369 void
 370 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
 371                                  const struct GNUNET_FS_Uri *uri,
 372                                  const struct GNUNET_CONTAINER_MetaData *md,
 373                                  const void *data)
 374 {
 375   struct GNUNET_FS_Uri *curi;
 376   struct BuilderEntry *e;
 377   uint64_t fsize;
 378   uint32_t big;
 379   ssize_t ret;
 380   size_t mds;
 381   size_t mdxs;
 382   char *uris;
 383   char *ser;
 384   char *sptr;
 385   size_t slen;
 386   struct GNUNET_CONTAINER_MetaData *meta;
 387   const struct GNUNET_CONTAINER_MetaData *meta_use;
 388
 389   GNUNET_assert (!GNUNET_FS_uri_test_ksk (uri));
 390   if (NULL != data)
 391   {
 392     GNUNET_assert (!GNUNET_FS_uri_test_sks (uri));
 393     if (GNUNET_FS_uri_test_chk (uri))
 394     {
 395       fsize = GNUNET_FS_uri_chk_get_file_size (uri);
 396     }
 397     else
 398     {
 399       curi = GNUNET_FS_uri_loc_get_uri (uri);
 400       GNUNET_assert (NULL != curi);
 401       fsize = GNUNET_FS_uri_chk_get_file_size (curi);
 402       GNUNET_FS_uri_destroy (curi);
 403     }
 404   }
 405   else
 406   {
 407     fsize = 0;                  /* not given */
 408   }
 409   if (fsize > MAX_INLINE_SIZE)
 410     fsize = 0;                  /* too large */
 411   uris = GNUNET_FS_uri_to_string (uri);
 412   slen = strlen (uris) + 1;
 413   mds = GNUNET_CONTAINER_meta_data_get_serialized_size (md);
 414   meta_use = md;
 415   meta = NULL;
 416   if (fsize > 0)
 417   {
 418     meta = GNUNET_CONTAINER_meta_data_duplicate (md);
 419     GNUNET_CONTAINER_meta_data_insert (meta, "<gnunet>",
 420                                        EXTRACTOR_METATYPE_GNUNET_FULL_DATA,
 421                                        EXTRACTOR_METAFORMAT_BINARY, NULL, data,
 422                                        fsize);
 423     mdxs = GNUNET_CONTAINER_meta_data_get_serialized_size (meta);
 424     if ((slen + sizeof (uint32_t) + mdxs - 1) / DBLOCK_SIZE ==
 425         (slen + sizeof (uint32_t) + mds - 1) / DBLOCK_SIZE)
 426     {
 427       /* adding full data would not cause us to cross
 428        * additional blocks, so add it! */
 429       meta_use = meta;
 430       mds = mdxs;
 431     }
 432   }
 433
 434   if (mds > GNUNET_MAX_MALLOC_CHECKED / 2)
 435     mds = GNUNET_MAX_MALLOC_CHECKED / 2;
 436   e = GNUNET_malloc (sizeof (struct BuilderEntry) + slen + mds +
 437                      sizeof (uint32_t));
 438   ser = (char *) &e[1];
 439   memcpy (ser, uris, slen);
 440   GNUNET_free (uris);
 441   sptr = &ser[slen + sizeof (uint32_t)];
 442   ret =
 443       GNUNET_CONTAINER_meta_data_serialize (meta_use, &sptr, mds,
 444                                             GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
 445   if (NULL != meta)
 446     GNUNET_CONTAINER_meta_data_destroy (meta);
 447   if (ret == -1)
 448     mds = 0;
 449   else
 450     mds = ret;
 451   big = htonl (mds);
 452   memcpy (&ser[slen], &big, sizeof (uint32_t));
 453   e->len = slen + sizeof (uint32_t) + mds;
 454   e->next = bld->head;
 455   bld->head = e;
 456   bld->count++;
 457 }
 458
 459
 460 /**
 461  * Given the start and end position of a block of
 462  * data, return the end position of that data
 463  * after alignment to the DBLOCK_SIZE.
 464  */
 465 static size_t
 466 do_align (size_t start_position, size_t end_position)
 467 {
 468   size_t align;
 469
 470   align = (end_position / DBLOCK_SIZE) * DBLOCK_SIZE;
 471   if ((start_position < align) && (end_position > align))
 472     return align + end_position - start_position;
 473   return end_position;
 474 }
 475
 476
 477 /**
 478  * Compute a permuation of the blocks to
 479  * minimize the cost of alignment.  Greedy packer.
 480  *
 481  * @param start starting position for the first block
 482  * @param count size of the two arrays
 483  * @param sizes the sizes of the individual blocks
 484  * @param perm the permutation of the blocks (updated)
 485  */
 486 static void
 487 block_align (size_t start, unsigned int count, const size_t * sizes,
 488              unsigned int *perm)
 489 {
 490   unsigned int i;
 491   unsigned int j;
 492   unsigned int tmp;
 493   unsigned int best;
 494   ssize_t badness;
 495   size_t cpos;
 496   size_t cend;
 497   ssize_t cbad;
 498   unsigned int cval;
 499
 500   cpos = start;
 501   for (i = 0; i < count; i++)
 502   {
 503     start = cpos;
 504     badness = 0x7FFFFFFF;
 505     best = -1;
 506     for (j = i; j < count; j++)
 507     {
 508       cval = perm[j];
 509       cend = cpos + sizes[cval];
 510       if (cpos % DBLOCK_SIZE == 0)
 511       {
 512         /* prefer placing the largest blocks first */
 513         cbad = -(cend % DBLOCK_SIZE);
 514       }
 515       else
 516       {
 517         if (cpos / DBLOCK_SIZE == cend / DBLOCK_SIZE)
 518         {
 519           /* Data fits into the same block! Prefer small left-overs! */
 520           cbad = DBLOCK_SIZE - cend % DBLOCK_SIZE;
 521         }
 522         else
 523         {
 524           /* Would have to waste space to re-align, add big factor, this
 525            * case is a real loss (proportional to space wasted)! */
 526           cbad = DBLOCK_SIZE * (DBLOCK_SIZE - cpos % DBLOCK_SIZE);
 527         }
 528       }
 529       if (cbad < badness)
 530       {
 531         best = j;
 532         badness = cbad;
 533       }
 534     }
 535     GNUNET_assert (best != -1);
 536     tmp = perm[i];
 537     perm[i] = perm[best];
 538     perm[best] = tmp;
 539     cpos += sizes[perm[i]];
 540     cpos = do_align (start, cpos);
 541   }
 542 }
 543
 544
 545 /**
 546  * Finish building the directory.  Frees the
 547  * builder context and returns the directory
 548  * in-memory.
 549  *
 550  * @param bld directory to finish
 551  * @param rsize set to the number of bytes needed
 552  * @param rdata set to the encoded directory
 553  * @return GNUNET_OK on success
 554  */
 555 int
 556 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
 557                                     size_t * rsize, void **rdata)
 558 {
 559   char *data;
 560   char *sptr;
 561   size_t *sizes;
 562   unsigned int *perm;
 563   unsigned int i;
 564   unsigned int j;
 565   struct BuilderEntry *pos;
 566   struct BuilderEntry **bes;
 567   size_t size;
 568   size_t psize;
 569   size_t off;
 570   ssize_t ret;
 571   uint32_t big;
 572
 573   size = strlen (GNUNET_DIRECTORY_MAGIC) + sizeof (uint32_t);
 574   size += GNUNET_CONTAINER_meta_data_get_serialized_size (bld->meta);
 575   sizes = NULL;
 576   perm = NULL;
 577   bes = NULL;
 578   if (0 < bld->count)
 579   {
 580     sizes = GNUNET_malloc (bld->count * sizeof (size_t));
 581     perm = GNUNET_malloc (bld->count * sizeof (unsigned int));
 582     bes = GNUNET_malloc (bld->count * sizeof (struct BuilderEntry *));
 583     pos = bld->head;
 584     for (i = 0; i < bld->count; i++)
 585     {
 586       perm[i] = i;
 587       bes[i] = pos;
 588       sizes[i] = pos->len;
 589       pos = pos->next;
 590     }
 591     block_align (size, bld->count, sizes, perm);
 592     /* compute final size with alignment */
 593     for (i = 0; i < bld->count; i++)
 594     {
 595       psize = size;
 596       size += sizes[perm[i]];
 597       size = do_align (psize, size);
 598     }
 599   }
 600   *rsize = size;
 601   data = GNUNET_malloc_large (size);
 602   if (data == NULL)
 603   {
 604     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
 605     *rsize = 0;
 606     *rdata = NULL;
 607     GNUNET_free_non_null (sizes);
 608     GNUNET_free_non_null (perm);
 609     GNUNET_free_non_null (bes);
 610     return GNUNET_SYSERR;
 611   }
 612   *rdata = data;
 613   memcpy (data, GNUNET_DIRECTORY_MAGIC, strlen (GNUNET_DIRECTORY_MAGIC));
 614   off = strlen (GNUNET_DIRECTORY_MAGIC);
 615
 616   sptr = &data[off + sizeof (uint32_t)];
 617   ret =
 618       GNUNET_CONTAINER_meta_data_serialize (bld->meta, &sptr,
 619                                             size - off - sizeof (uint32_t),
 620                                             GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL);
 621   GNUNET_assert (ret != -1);
 622   big = htonl (ret);
 623   memcpy (&data[off], &big, sizeof (uint32_t));
 624   off += sizeof (uint32_t) + ret;
 625   for (j = 0; j < bld->count; j++)
 626   {
 627     i = perm[j];
 628     psize = off;
 629     off += sizes[i];
 630     off = do_align (psize, off);
 631     memcpy (&data[off - sizes[i]], &(bes[i])[1], sizes[i]);
 632     GNUNET_free (bes[i]);
 633   }
 634   GNUNET_free_non_null (sizes);
 635   GNUNET_free_non_null (perm);
 636   GNUNET_free_non_null (bes);
 637   GNUNET_assert (off == size);
 638   GNUNET_CONTAINER_meta_data_destroy (bld->meta);
 639   GNUNET_free (bld);
 640   return GNUNET_OK;
 641 }
 642
 643
 644 /* end of fs_directory.c */