2 * Copyright (C) 2006 Josep Torra <josep@fluendo.com>
3 * 2006 Mathieu Garcia <matthieu@fluendo.com>
4 * 2006,2007 Stefan Kost <ensonic@users.sf.net>
5 * 2008 Sebastian Dröge <slomo@circular-chaos.org>
7 * gstregistrybinary.c: GstRegistryBinary object, support routines
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
26 * - keep registry binary blob and reference strings
27 * - don't free/unmmap contents when leaving gst_registry_binary_read_cache()
28 * - free at gst_deinit() / _priv_gst_registry_cleanup() ?
30 * - GST_PLUGIN_FLAG_CONST
31 * - GstPluginFeature, GstIndexFactory, GstElementFactory
32 * - needs Flags (GST_PLUGIN_FEATURE_FLAG_CONST)
33 * - can we turn loaded into flag?
34 * - why do we collect a list of binary chunks and not write immediately
35 * - because we need to process subchunks, before we can set e.g. nr_of_items
50 #if defined (_MSC_VER) && _MSC_VER >= 1400
54 #include <gst/gst_private.h>
55 #include <gst/gstconfig.h>
56 #include <gst/gstelement.h>
57 #include <gst/gsttypefind.h>
58 #include <gst/gsttypefindfactory.h>
59 #include <gst/gsturi.h>
60 #include <gst/gstinfo.h>
61 #include <gst/gstenumtypes.h>
62 #include <gst/gstpadtemplate.h>
64 #include <gst/gstregistrychunks.h>
65 #include <gst/gstregistrybinary.h>
67 #include <glib/gstdio.h> /* for g_stat(), g_mapped_file(), ... */
69 #include "glib-compat-private.h"
72 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
75 #define unpack_element(inptr, outptr, element, endptr, error_label) G_STMT_START{ \
76 if (inptr + sizeof(element) >= endptr) \
78 outptr = (element *) inptr; \
79 inptr += sizeof (element); \
82 #define ALIGNMENT (sizeof (void *))
83 #define alignment(_address) (gsize)_address%ALIGNMENT
84 #define align(_ptr) _ptr += (( alignment(_ptr) == 0) ? 0 : ALIGNMENT-alignment(_ptr))
89 /* On win32, we can't use g_mkstmp(), because of cross-DLL file I/O problems.
90 * So, we just create the entire binary registry in memory, then write it out
91 * with g_file_set_contents(), which creates a temporary file internally
94 typedef struct BinaryRegistryCache
99 } BinaryRegistryCache;
101 static BinaryRegistryCache *
102 gst_registry_binary_cache_init (GstRegistry * registry, const char *location)
104 BinaryRegistryCache *cache = g_slice_new0 (BinaryRegistryCache);
105 cache->location = location;
110 gst_registry_binary_cache_write (BinaryRegistryCache * cache,
111 unsigned long offset, const void *data, int length)
113 cache->len = MAX (offset + length, cache->len);
114 cache->mem = g_realloc (cache->mem, cache->len);
116 memcpy (cache->mem + offset, data, length);
122 gst_registry_binary_cache_finish (BinaryRegistryCache * cache, gboolean success)
125 GError *error = NULL;
126 if (!g_file_set_contents (cache->location, (const gchar *) cache->mem,
127 cache->len, &error)) {
128 /* Probably the directory didn't exist; create it */
130 dir = g_path_get_dirname (cache->location);
131 g_mkdir_with_parents (dir, 0777);
134 g_error_free (error);
137 if (!g_file_set_contents (cache->location, (const gchar *) cache->mem,
138 cache->len, &error)) {
139 /* Probably the directory didn't exist; create it */
141 dir = g_path_get_dirname (cache->location);
142 g_mkdir_with_parents (dir, 0777);
145 g_error_free (error);
148 if (!g_file_set_contents (cache->location, (const gchar *) cache->mem,
149 cache->len, &error)) {
150 GST_ERROR ("Failed to write to cache file: %s", error->message);
151 g_error_free (error);
158 g_slice_free (BinaryRegistryCache, cache);
163 typedef struct BinaryRegistryCache
165 const char *location;
167 unsigned long currentoffset;
169 } BinaryRegistryCache;
171 static BinaryRegistryCache *
172 gst_registry_binary_cache_init (GstRegistry * registry, const char *location)
174 BinaryRegistryCache *cache = g_slice_new0 (BinaryRegistryCache);
176 cache->location = location;
177 cache->tmp_location = g_strconcat (location, ".tmpXXXXXX", NULL);
178 cache->cache_fd = g_mkstemp (cache->tmp_location);
179 if (cache->cache_fd == -1) {
184 /* oops, I bet the directory doesn't exist */
185 dir = g_path_get_dirname (location);
186 g_mkdir_with_parents (dir, 0777);
188 ret = g_stat (dir, &statbuf);
189 if (ret != -1 && (statbuf.st_mode & 0700) != 0700) {
195 /* the previous g_mkstemp call overwrote the XXXXXX placeholder ... */
196 g_free (cache->tmp_location);
197 cache->tmp_location = g_strconcat (location, ".tmpXXXXXX", NULL);
198 cache->cache_fd = g_mkstemp (cache->tmp_location);
200 if (cache->cache_fd == -1) {
201 GST_DEBUG ("g_mkstemp() failed: %s", g_strerror (errno));
202 g_free (cache->tmp_location);
203 g_slice_free (BinaryRegistryCache, cache);
207 ret = g_stat (cache->tmp_location, &statbuf);
208 if (ret != -1 && (statbuf.st_mode & 0600) != 0600) {
209 g_chmod (cache->tmp_location, 0600);
217 gst_registry_binary_cache_write (BinaryRegistryCache * cache,
218 unsigned long offset, const void *data, int length)
221 if (offset != cache->currentoffset) {
222 if (lseek (cache->cache_fd, offset, SEEK_SET) < 0) {
223 GST_ERROR ("Seeking to new offset failed: %s", g_strerror (errno));
226 GST_LOG ("Seeked from offset %lu to %lu", offset, cache->currentoffset);
227 cache->currentoffset = offset;
230 written = write (cache->cache_fd, data, length);
231 if (written != length) {
232 GST_ERROR ("Failed to write to cache file");
234 cache->currentoffset += written;
240 gst_registry_binary_cache_finish (BinaryRegistryCache * cache, gboolean success)
242 /* only fsync if we're actually going to use and rename the file below */
243 if (success && fsync (cache->cache_fd) < 0)
246 if (close (cache->cache_fd) < 0)
250 goto fail_after_close;
252 /* Only do the rename if we wrote the entire file successfully */
253 if (g_rename (cache->tmp_location, cache->location) < 0) {
254 GST_ERROR ("g_rename() failed: %s", g_strerror (errno));
258 g_free (cache->tmp_location);
259 g_slice_free (BinaryRegistryCache, cache);
260 GST_INFO ("Wrote binary registry cache");
266 g_unlink (cache->tmp_location);
267 g_free (cache->tmp_location);
268 g_slice_free (BinaryRegistryCache, cache);
273 GST_ERROR ("fsync() failed: %s", g_strerror (errno));
274 goto fail_after_close;
278 GST_ERROR ("close() failed: %s", g_strerror (errno));
279 goto fail_after_close;
283 GST_ERROR ("g_rename() failed: %s", g_strerror (errno));
284 goto fail_after_close;
290 * gst_registry_binary_write_chunk:
292 * Write from a memory location to the registry cache file
294 * Returns: %TRUE for success
296 inline static gboolean
297 gst_registry_binary_write_chunk (BinaryRegistryCache * cache,
298 GstRegistryChunk * chunk, unsigned long *file_position)
300 gchar padder[ALIGNMENT] = { 0, };
303 /* Padding to insert the struct that requiere word alignment */
304 if ((chunk->align) && (alignment (*file_position) != 0)) {
305 padsize = ALIGNMENT - alignment (*file_position);
306 if (gst_registry_binary_cache_write (cache, *file_position,
307 padder, padsize) != padsize) {
308 GST_ERROR ("Failed to write binary registry padder");
311 *file_position += padsize;
314 if (gst_registry_binary_cache_write (cache, *file_position,
315 chunk->data, chunk->size) != chunk->size) {
316 GST_ERROR ("Failed to write binary registry element");
320 *file_position += chunk->size;
327 * gst_registry_binary_initialize_magic:
329 * Initialize the GstBinaryRegistryMagic, setting both our magic number and
330 * gstreamer major/minor version
332 inline static gboolean
333 gst_registry_binary_initialize_magic (GstBinaryRegistryMagic * m)
335 memset (m, 0, sizeof (GstBinaryRegistryMagic));
337 if (!strncpy (m->magic, GST_MAGIC_BINARY_REGISTRY_STR,
338 GST_MAGIC_BINARY_REGISTRY_LEN)
339 || !strncpy (m->version, GST_MAGIC_BINARY_VERSION_STR,
340 GST_MAGIC_BINARY_VERSION_LEN)) {
341 GST_ERROR ("Failed to write magic to the registry magic structure");
349 * gst_registry_binary_write_cache:
350 * @registry: a #GstRegistry
351 * @location: a filename
353 * Write the @registry to a cache to file at given @location.
355 * Returns: %TRUE on success.
358 gst_registry_binary_write_cache (GstRegistry * registry, const char *location)
361 GstBinaryRegistryMagic magic;
362 GList *to_write = NULL;
363 unsigned long file_position = 0;
364 BinaryRegistryCache *cache;
366 GST_INFO ("Building binary registry cache image");
368 g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
370 if (!gst_registry_binary_initialize_magic (&magic))
373 /* iterate trough the list of plugins and fit them into binary structures */
374 for (walk = registry->plugins; walk; walk = g_list_next (walk)) {
375 GstPlugin *plugin = GST_PLUGIN (walk->data);
377 if (!plugin->filename)
380 if (plugin->flags & GST_PLUGIN_FLAG_CACHED) {
383 if (g_stat (plugin->filename, &statbuf) < 0 ||
384 plugin->file_mtime != statbuf.st_mtime ||
385 plugin->file_size != statbuf.st_size)
389 if (!_priv_gst_registry_chunks_save_plugin (&to_write, registry, plugin)) {
390 GST_ERROR ("Can't write binary plugin information for \"%s\"",
395 _priv_gst_registry_chunks_save_global_header (&to_write, registry,
396 priv_gst_plugin_loading_get_whitelist_hash ());
398 GST_INFO ("Writing binary registry cache");
400 cache = gst_registry_binary_cache_init (registry, location);
405 if (gst_registry_binary_cache_write (cache, file_position,
406 &magic, sizeof (GstBinaryRegistryMagic)) !=
407 sizeof (GstBinaryRegistryMagic)) {
408 GST_ERROR ("Failed to write binary registry magic");
411 file_position += sizeof (GstBinaryRegistryMagic);
413 /* write out data chunks */
414 for (walk = to_write; walk; walk = g_list_next (walk)) {
415 GstRegistryChunk *cur = walk->data;
418 res = gst_registry_binary_write_chunk (cache, cur, &file_position);
420 _priv_gst_registry_chunk_free (cur);
425 g_list_free (to_write);
427 if (!gst_registry_binary_cache_finish (cache, TRUE))
435 for (walk = to_write; walk; walk = g_list_next (walk)) {
436 GstRegistryChunk *cur = walk->data;
439 _priv_gst_registry_chunk_free (cur);
441 g_list_free (to_write);
444 (void) gst_registry_binary_cache_finish (cache, FALSE);
454 /* Registry loading */
457 * gst_registry_binary_check_magic:
459 * Check GstBinaryRegistryMagic validity.
460 * Return < 0 if something is wrong, -2 means
461 * that just the version of the registry is out of
462 * date, -1 is a general failure.
465 gst_registry_binary_check_magic (gchar ** in, gsize size)
467 GstBinaryRegistryMagic *m;
470 GST_DEBUG ("Reading/casting for GstBinaryRegistryMagic at address %p", *in);
471 unpack_element (*in, m, GstBinaryRegistryMagic, (*in + size), fail);
473 if (strncmp (m->magic, GST_MAGIC_BINARY_REGISTRY_STR,
474 GST_MAGIC_BINARY_REGISTRY_LEN) != 0) {
476 ("Binary registry magic is different : %02x%02x%02x%02x != %02x%02x%02x%02x",
477 GST_MAGIC_BINARY_REGISTRY_STR[0] & 0xff,
478 GST_MAGIC_BINARY_REGISTRY_STR[1] & 0xff,
479 GST_MAGIC_BINARY_REGISTRY_STR[2] & 0xff,
480 GST_MAGIC_BINARY_REGISTRY_STR[3] & 0xff, m->magic[0] & 0xff,
481 m->magic[1] & 0xff, m->magic[2] & 0xff, m->magic[3] & 0xff);
484 if (strncmp (m->version, GST_MAGIC_BINARY_VERSION_STR,
485 GST_MAGIC_BINARY_VERSION_LEN)) {
486 GST_WARNING ("Binary registry magic version is different : %s != %s",
487 GST_MAGIC_BINARY_VERSION_STR, m->version);
494 GST_WARNING ("Not enough data for binary registry magic structure");
499 * gst_registry_binary_read_cache:
500 * @registry: a #GstRegistry
501 * @location: a filename
503 * Read the contents of the binary cache file at @location into @registry.
505 * Returns: %TRUE on success.
508 gst_registry_binary_read_cache (GstRegistry * registry, const char *location)
510 GMappedFile *mapped = NULL;
511 gchar *contents = NULL;
515 gboolean res = FALSE;
516 guint32 filter_env_hash = 0;
517 gint check_magic_result;
518 #ifndef GST_DISABLE_GST_DEBUG
519 GTimer *timer = NULL;
523 /* make sure these types exist */
524 GST_TYPE_ELEMENT_FACTORY;
525 GST_TYPE_TYPE_FIND_FACTORY;
526 GST_TYPE_INDEX_FACTORY;
528 #ifndef GST_DISABLE_GST_DEBUG
529 timer = g_timer_new ();
532 mapped = g_mapped_file_new (location, FALSE, &err);
533 if (G_UNLIKELY (err != NULL)) {
534 GST_INFO ("Unable to mmap file %s : %s", location, err->message);
539 if (mapped == NULL) {
540 /* Error mmap-ing the cache, try a plain memory read */
542 g_file_get_contents (location, &contents, &size, &err);
544 GST_INFO ("Unable to read file %s : %s", location, err->message);
545 #ifndef GST_DISABLE_GST_DEBUG
546 g_timer_destroy (timer);
552 /* This can't fail if g_mapped_file_new() succeeded */
553 contents = g_mapped_file_get_contents (mapped);
554 size = g_mapped_file_get_length (mapped);
557 /* in is a cursor pointer, we initialize it with the begin of registry and is updated on each read */
559 GST_DEBUG ("File data at address %p", in);
560 if (G_UNLIKELY (size < sizeof (GstBinaryRegistryMagic))) {
561 GST_ERROR ("No or broken registry header for file at %s", location);
565 /* check if header is valid */
566 if (G_UNLIKELY ((check_magic_result =
567 gst_registry_binary_check_magic (&in, size)) < 0)) {
569 if (check_magic_result == -1)
571 ("Binary registry type not recognized (invalid magic) for file at %s",
576 if (!_priv_gst_registry_chunks_load_global_header (registry, &in,
577 contents + size, &filter_env_hash)) {
578 GST_ERROR ("Couldn't read global header chunk");
582 if (filter_env_hash != priv_gst_plugin_loading_get_whitelist_hash ()) {
583 GST_INFO_OBJECT (registry, "Plugin loading filter environment changed, "
584 "ignoring plugin cache to force update with new filter environment");
588 /* check if there are plugins in the file */
589 if (G_UNLIKELY (!(((gsize) in + sizeof (GstRegistryChunkPluginElement)) <
590 (gsize) contents + size))) {
591 GST_INFO ("No binary plugins structure to read");
592 /* empty file, this is not an error */
594 gchar *end = contents + size;
595 /* read as long as we still have space for a GstRegistryChunkPluginElement */
597 ((gsize) in + sizeof (GstRegistryChunkPluginElement)) <
598 (gsize) contents + size;) {
599 GST_DEBUG ("reading binary registry %" G_GSIZE_FORMAT "(%x)/%"
600 G_GSIZE_FORMAT, (gsize) in - (gsize) contents,
601 (guint) ((gsize) in - (gsize) contents), size);
602 if (!_priv_gst_registry_chunks_load_plugin (registry, &in, end, NULL)) {
603 GST_ERROR ("Problem while reading binary registry %s", location);
611 #ifndef GST_DISABLE_GST_DEBUG
612 g_timer_stop (timer);
613 seconds = g_timer_elapsed (timer, NULL);
616 GST_INFO ("loaded %s in %lf seconds", location, seconds);
619 /* TODO: once we re-use the pointers to registry contents, return here */
622 #ifndef GST_DISABLE_GST_DEBUG
623 g_timer_destroy (timer);
626 g_mapped_file_unref (mapped);
633 #ifndef GST_REMOVE_DEPRECATED
634 #ifdef GST_DISABLE_DEPRECATED
636 gst_registry_xml_read_cache (GstRegistry * registry, const char *location);
638 /* FIXME 0.11: these symbols are here for backwards compatibility and should
639 * be removed or made private */
641 gst_registry_xml_read_cache (GstRegistry * registry, const char *location)
646 #ifdef GST_DISABLE_DEPRECATED
648 gst_registry_xml_write_cache (GstRegistry * registry, const char *location);
651 gst_registry_xml_write_cache (GstRegistry * registry, const char *location)
655 #endif /* GST_REMOVE_DEPRECATED */