2 This file is part of GNUnet.
3 (C) 2003, 2004, 2006, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file fs/fs_directory.c
23 * @brief Helper functions for building directories.
24 * @author Christian Grothoff
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
36 #include "gnunet_fs_service.h"
40 * String that is used to indicate that a file
41 * is a GNUnet directory.
43 #define GNUNET_DIRECTORY_MAGIC "\211GND\r\n\032\n"
47 * Does the meta-data claim that this is a directory?
48 * Checks if the mime-type is that of a GNUnet directory.
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')
54 GNUNET_FS_meta_data_test_for_directory (const struct GNUNET_CONTAINER_MetaData *md)
61 mime = GNUNET_CONTAINER_meta_data_get_by_type (md, EXTRACTOR_METATYPE_MIMETYPE);
64 ret = (0 == strcmp (mime, GNUNET_FS_DIRECTORY_MIME)) ? GNUNET_YES : GNUNET_NO;
71 * Set the MIMETYPE information for the given
72 * metadata to "application/gnunet-directory".
74 * @param md metadata to add mimetype to
77 GNUNET_FS_meta_data_make_directory (struct GNUNET_CONTAINER_MetaData *md)
81 mime = GNUNET_CONTAINER_meta_data_get_by_type (md, EXTRACTOR_METATYPE_MIMETYPE);
84 GNUNET_break (0 == strcmp (mime,
85 GNUNET_FS_DIRECTORY_MIME));
89 GNUNET_CONTAINER_meta_data_insert (md,
91 EXTRACTOR_METATYPE_MIMETYPE,
92 EXTRACTOR_METAFORMAT_UTF8,
94 GNUNET_FS_DIRECTORY_MIME,
95 strlen (GNUNET_FS_DIRECTORY_MIME)+1);
100 * Closure for 'find_full_data'.
102 struct GetFullDataClosure
106 * Extracted binary meta data.
111 * Number of bytes stored in data.
118 * Type of a function that libextractor calls for each
119 * meta data item found.
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
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
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,
143 struct GetFullDataClosure *gfdc = cls;
145 if (type == EXTRACTOR_METATYPE_GNUNET_FULL_DATA)
147 gfdc->size = data_len;
150 gfdc->data = GNUNET_malloc (data_len);
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.
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.
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 * @return GNUNET_OK if this could be a block in a directory,
183 * GNUNET_NO if this could be part of a directory (but not 100% OK)
184 * GNUNET_SYSERR if 'data' does not represent a directory
187 GNUNET_FS_directory_list_contents (size_t size,
190 GNUNET_FS_DirectoryEntryProcessor dep,
193 struct GetFullDataClosure full_data;
194 const char *cdata = data;
200 struct GNUNET_FS_Uri *uri;
201 struct GNUNET_CONTAINER_MetaData *md;
204 if ( (offset == 0) &&
205 ( (size < 8 + sizeof (uint32_t)) ||
206 (0 != memcmp (cdata, GNUNET_FS_DIRECTORY_MAGIC, 8)) ) )
208 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
209 _("MAGIC mismatch. This is not a GNUnet directory.\n"));
210 return GNUNET_SYSERR;
215 memcpy (&mdSize, &cdata[8], sizeof (uint32_t));
216 mdSize = ntohl (mdSize);
217 if (mdSize > size - 8 - sizeof (uint32_t))
220 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
221 _("MAGIC mismatch. This is not a GNUnet directory.\n"));
222 return GNUNET_SYSERR;
224 md = GNUNET_CONTAINER_meta_data_deserialize (&cdata[8 +
230 return GNUNET_SYSERR; /* malformed ! */
238 GNUNET_CONTAINER_meta_data_destroy (md);
239 pos = 8 + sizeof (uint32_t) + mdSize;
243 /* find end of URI */
244 if (cdata[pos] == '\0')
246 /* URI is never empty, must be end of block,
247 skip to next alignment */
249 ((pos / DBLOCK_SIZE) + 1) * DBLOCK_SIZE;
252 /* if we were already aligned, still skip a block! */
253 align += DBLOCK_SIZE;
258 /* malformed - or partial download... */
263 while ((epos < size) && (cdata[epos] != '\0'))
266 return GNUNET_NO; /* malformed - or partial download */
268 uri = GNUNET_FS_uri_parse (&cdata[pos], &emsg);
273 pos--; /* go back to '\0' to force going to next alignment */
276 if (GNUNET_FS_uri_test_ksk (uri))
278 GNUNET_FS_uri_destroy (uri);
280 return GNUNET_NO; /* illegal in directory! */
283 memcpy (&mdSize, &cdata[pos], sizeof (uint32_t));
284 mdSize = ntohl (mdSize);
285 pos += sizeof (uint32_t);
286 if (pos + mdSize > size)
288 GNUNET_FS_uri_destroy (uri);
289 return GNUNET_NO; /* malformed - or partial download */
292 md = GNUNET_CONTAINER_meta_data_deserialize (&cdata[pos], mdSize);
295 GNUNET_FS_uri_destroy (uri);
297 return GNUNET_NO; /* malformed ! */
300 filename = GNUNET_CONTAINER_meta_data_get_by_type (md,
301 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
303 full_data.data = NULL;
304 GNUNET_CONTAINER_meta_data_iterate (md,
316 GNUNET_free_non_null (full_data.data);
317 GNUNET_free_non_null (filename);
318 GNUNET_CONTAINER_meta_data_destroy (md);
319 GNUNET_FS_uri_destroy (uri);
325 * Entries in the directory (builder).
330 * This is a linked list.
332 struct BuilderEntry *next;
335 * Length of this entry.
341 * Internal state of a directory builder.
343 struct GNUNET_FS_DirectoryBuilder
346 * Meta-data for the directory itself.
348 struct GNUNET_CONTAINER_MetaData *meta;
351 * Head of linked list of entries.
353 struct BuilderEntry *head;
356 * Number of entires in the directory.
363 * Create a directory builder.
365 * @param mdir metadata for the directory
367 struct GNUNET_FS_DirectoryBuilder *
368 GNUNET_FS_directory_builder_create (const struct GNUNET_CONTAINER_MetaData *mdir)
370 struct GNUNET_FS_DirectoryBuilder *ret;
372 ret = GNUNET_malloc(sizeof(struct GNUNET_FS_DirectoryBuilder));
374 ret->meta = GNUNET_CONTAINER_meta_data_duplicate (mdir);
376 ret->meta = GNUNET_CONTAINER_meta_data_create ();
377 GNUNET_FS_meta_data_make_directory (ret->meta);
383 * Add an entry to a directory.
385 * @param bld directory to extend
386 * @param uri uri of the entry (must not be a KSK)
387 * @param md metadata of the entry
388 * @param data raw data of the entry, can be NULL, otherwise
389 * data must point to exactly the number of bytes specified
390 * by the uri which must be of type LOC or CHK
393 GNUNET_FS_directory_builder_add (struct GNUNET_FS_DirectoryBuilder *bld,
394 const struct GNUNET_FS_Uri *uri,
395 const struct GNUNET_CONTAINER_MetaData *md,
398 struct GNUNET_FS_Uri *curi;
399 struct BuilderEntry *e;
409 struct GNUNET_CONTAINER_MetaData *meta;
410 const struct GNUNET_CONTAINER_MetaData *meta_use;
412 GNUNET_assert (! GNUNET_FS_uri_test_ksk (uri));
415 GNUNET_assert (! GNUNET_FS_uri_test_sks (uri));
416 if (GNUNET_FS_uri_test_chk (uri))
418 fsize = GNUNET_FS_uri_chk_get_file_size (uri);
422 curi = GNUNET_FS_uri_loc_get_uri (uri);
423 GNUNET_assert (NULL != curi);
424 fsize = GNUNET_FS_uri_chk_get_file_size (curi);
425 GNUNET_FS_uri_destroy (curi);
430 fsize = 0; /* not given */
432 if (fsize > MAX_INLINE_SIZE)
433 fsize = 0; /* too large */
434 uris = GNUNET_FS_uri_to_string (uri);
435 slen = strlen (uris) + 1;
437 GNUNET_CONTAINER_meta_data_get_serialized_size (md);
442 meta = GNUNET_CONTAINER_meta_data_duplicate (md);
443 GNUNET_CONTAINER_meta_data_insert (meta,
445 EXTRACTOR_METATYPE_GNUNET_FULL_DATA,
446 EXTRACTOR_METAFORMAT_BINARY,
451 GNUNET_CONTAINER_meta_data_get_serialized_size (meta);
452 if ( (slen + sizeof (uint32_t) + mdxs - 1) / DBLOCK_SIZE ==
453 (slen + sizeof (uint32_t) + mds - 1) / DBLOCK_SIZE)
455 /* adding full data would not cause us to cross
456 additional blocks, so add it! */
462 if (mds > GNUNET_MAX_MALLOC_CHECKED / 2)
463 mds = GNUNET_MAX_MALLOC_CHECKED / 2;
464 e = GNUNET_malloc (sizeof(struct BuilderEntry) +
465 slen + mds + sizeof (uint32_t));
467 memcpy (ser, uris, slen);
469 sptr = &ser[slen + sizeof(uint32_t)];
470 ret = GNUNET_CONTAINER_meta_data_serialize (meta_use,
473 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
475 GNUNET_CONTAINER_meta_data_destroy (meta);
481 memcpy (&ser[slen], &big, sizeof (uint32_t));
482 e->len = slen + sizeof (uint32_t) + mds;
490 * Given the start and end position of a block of
491 * data, return the end position of that data
492 * after alignment to the DBLOCK_SIZE.
495 do_align (size_t start_position,
500 align = (end_position / DBLOCK_SIZE) * DBLOCK_SIZE;
501 if ((start_position < align) && (end_position > align))
502 return align + end_position - start_position;
508 * Compute a permuation of the blocks to
509 * minimize the cost of alignment. Greedy packer.
511 * @param start starting position for the first block
512 * @param count size of the two arrays
513 * @param sizes the sizes of the individual blocks
514 * @param perm the permutation of the blocks (updated)
517 block_align (size_t start,
533 for (i = 0; i < count; i++)
536 badness = 0x7FFFFFFF;
538 for (j = i; j < count; j++)
541 cend = cpos + sizes[cval];
542 if (cpos % DBLOCK_SIZE == 0)
544 /* prefer placing the largest blocks first */
545 cbad = -(cend % DBLOCK_SIZE);
549 if (cpos / DBLOCK_SIZE ==
552 /* Data fits into the same block! Prefer small left-overs! */
554 DBLOCK_SIZE - cend % DBLOCK_SIZE;
558 /* Would have to waste space to re-align, add big factor, this
559 case is a real loss (proportional to space wasted)! */
561 DBLOCK_SIZE * (DBLOCK_SIZE -
572 GNUNET_assert (best != -1);
574 perm[i] = perm[best];
576 cpos += sizes[perm[i]];
577 cpos = do_align (start, cpos);
583 * Finish building the directory. Frees the
584 * builder context and returns the directory
587 * @param bld directory to finish
588 * @param rsize set to the number of bytes needed
589 * @param rdata set to the encoded directory
590 * @return GNUNET_OK on success
593 GNUNET_FS_directory_builder_finish (struct GNUNET_FS_DirectoryBuilder *bld,
603 struct BuilderEntry *pos;
604 struct BuilderEntry **bes;
611 size = strlen (GNUNET_DIRECTORY_MAGIC) + sizeof (uint32_t);
612 size += GNUNET_CONTAINER_meta_data_get_serialized_size (bld->meta);
618 sizes = GNUNET_malloc (bld->count * sizeof (size_t));
619 perm = GNUNET_malloc (bld->count * sizeof (unsigned int));
620 bes = GNUNET_malloc (bld->count * sizeof (struct BuilderEntry *));
622 for (i = 0; i < bld->count; i++)
633 /* compute final size with alignment */
634 for (i = 0; i < bld->count; i++)
637 size += sizes[perm[i]];
638 size = do_align (psize, size);
642 data = GNUNET_malloc_large (size);
645 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
649 GNUNET_free_non_null (sizes);
650 GNUNET_free_non_null (perm);
651 GNUNET_free_non_null (bes);
652 return GNUNET_SYSERR;
655 memcpy (data, GNUNET_DIRECTORY_MAGIC, strlen (GNUNET_DIRECTORY_MAGIC));
656 off = strlen (GNUNET_DIRECTORY_MAGIC);
658 sptr = &data[off + sizeof (uint32_t)];
659 ret = GNUNET_CONTAINER_meta_data_serialize (bld->meta,
661 size - off - sizeof (uint32_t),
662 GNUNET_CONTAINER_META_DATA_SERIALIZE_FULL);
663 GNUNET_assert (ret != -1);
665 memcpy (&data[off], &big, sizeof (uint32_t));
666 off += sizeof (uint32_t) + ret;
667 for (j = 0; j < bld->count; j++)
672 off = do_align (psize, off);
673 memcpy (&data[off - sizes[i]],
676 GNUNET_free (bes[i]);
678 GNUNET_free_non_null (sizes);
679 GNUNET_free_non_null (perm);
680 GNUNET_free_non_null (bes);
681 GNUNET_assert (off == size);
682 GNUNET_CONTAINER_meta_data_destroy (bld->meta);
688 /* end of fs_directory.c */