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