gst/gstregistrybinary.c

   1 /* GStreamer
   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>
   6  *
   7  * gstregistrybinary.c: GstRegistryBinary object, support routines
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  */
  24
  25 /* FIXME:
  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() ?
  29  *   - GstPlugin:
  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
  36  *     in parent chunk
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #  include "config.h"
  41 #endif
  42
  43 #ifdef HAVE_UNISTD_H
  44 #include <unistd.h>
  45 #endif
  46
  47 #include <errno.h>
  48 #include <stdio.h>
  49
  50 #if defined (_MSC_VER) && _MSC_VER >= 1400
  51 #include <io.h>
  52 #endif
  53
  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>
  63
  64 #include <gst/gstregistrychunks.h>
  65 #include <gst/gstregistrybinary.h>
  66
  67 #include <glib/gstdio.h>        /* for g_stat(), g_mapped_file(), ... */
  68
  69 #include "glib-compat-private.h"
  70
  71
  72 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
  73
  74 /* reading macros */
  75 #define unpack_element(inptr, outptr, element, endptr, error_label) G_STMT_START{ \
  76   if (inptr + sizeof(element) >= endptr) \
  77     goto error_label; \
  78   outptr = (element *) inptr; \
  79   inptr += sizeof (element); \
  80 }G_STMT_END
  81
  82 #define ALIGNMENT            (sizeof (void *))
  83 #define alignment(_address)  (gsize)_address%ALIGNMENT
  84 #define align(_ptr)          _ptr += (( alignment(_ptr) == 0) ? 0 : ALIGNMENT-alignment(_ptr))
  85
  86 /* Registry saving */
  87
  88 #ifdef G_OS_WIN32
  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
  92  */
  93
  94 typedef struct BinaryRegistryCache
  95 {
  96   const char *location;
  97   guint8 *mem;
  98   gssize len;
  99 } BinaryRegistryCache;
 100
 101 static BinaryRegistryCache *
 102 gst_registry_binary_cache_init (GstRegistry * registry, const char *location)
 103 {
 104   BinaryRegistryCache *cache = g_new0 (BinaryRegistryCache, 1);
 105   cache->location = location;
 106   return cache;
 107 }
 108
 109 static int
 110 gst_registry_binary_cache_write (BinaryRegistryCache * cache,
 111     unsigned long offset, const void *data, int length)
 112 {
 113   cache->len = MAX (offset + length, cache->len);
 114   cache->mem = g_realloc (cache->mem, cache->len);
 115
 116   memcpy (cache->mem + offset, data, length);
 117
 118   return length;
 119 }
 120
 121 static gboolean
 122 gst_registry_binary_cache_finish (BinaryRegistryCache * cache, gboolean success)
 123 {
 124   gboolean ret = TRUE;
 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 */
 129     gchar *dir;
 130     dir = g_path_get_dirname (cache->location);
 131     g_mkdir_with_parents (dir, 0777);
 132     g_free (dir);
 133
 134     g_error_free (error);
 135     error = NULL;
 136
 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 */
 140       gchar *dir;
 141       dir = g_path_get_dirname (cache->location);
 142       g_mkdir_with_parents (dir, 0777);
 143       g_free (dir);
 144
 145       g_error_free (error);
 146       error = NULL;
 147
 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);
 152         ret = FALSE;
 153       }
 154     }
 155   }
 156
 157   g_free (cache->mem);
 158   g_free (cache);
 159   return ret;
 160 }
 161
 162 #else
 163 typedef struct BinaryRegistryCache
 164 {
 165   const char *location;
 166   char *tmp_location;
 167   unsigned long currentoffset;
 168   int cache_fd;
 169 } BinaryRegistryCache;
 170
 171 static BinaryRegistryCache *
 172 gst_registry_binary_cache_init (GstRegistry * registry, const char *location)
 173 {
 174   BinaryRegistryCache *cache = g_new0 (BinaryRegistryCache, 1);
 175
 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) {
 180     gchar *dir;
 181
 182     /* oops, I bet the directory doesn't exist */
 183     dir = g_path_get_dirname (location);
 184     g_mkdir_with_parents (dir, 0777);
 185     g_free (dir);
 186
 187     /* the previous g_mkstemp call overwrote the XXXXXX placeholder ... */
 188     g_free (cache->tmp_location);
 189     cache->tmp_location = g_strconcat (location, ".tmpXXXXXX", NULL);
 190     cache->cache_fd = g_mkstemp (cache->tmp_location);
 191
 192     if (cache->cache_fd == -1) {
 193       GST_DEBUG ("g_mkstemp() failed: %s", g_strerror (errno));
 194       g_free (cache->tmp_location);
 195       g_free (cache);
 196       return NULL;
 197     }
 198   }
 199
 200   return cache;
 201 }
 202
 203 static int
 204 gst_registry_binary_cache_write (BinaryRegistryCache * cache,
 205     unsigned long offset, const void *data, int length)
 206 {
 207   long written;
 208   if (offset != cache->currentoffset) {
 209     if (lseek (cache->cache_fd, offset, SEEK_SET) != 0) {
 210       GST_ERROR ("Seeking to new offset failed");
 211       return FALSE;
 212     }
 213     cache->currentoffset = offset;
 214   }
 215
 216   written = write (cache->cache_fd, data, length);
 217   if (written != length) {
 218     GST_ERROR ("Failed to write to cache file");
 219   }
 220   cache->currentoffset += written;
 221
 222   return written;
 223 }
 224
 225 static gboolean
 226 gst_registry_binary_cache_finish (BinaryRegistryCache * cache, gboolean success)
 227 {
 228   /* only fsync if we're actually going to use and rename the file below */
 229   if (success && fsync (cache->cache_fd) < 0)
 230     goto fsync_failed;
 231
 232   if (close (cache->cache_fd) < 0)
 233     goto close_failed;
 234
 235   if (success) {
 236     /* Only do the rename if we wrote the entire file successfully */
 237     if (g_rename (cache->tmp_location, cache->location) < 0) {
 238       GST_ERROR ("g_rename() failed: %s", g_strerror (errno));
 239       goto rename_failed;
 240     }
 241   }
 242
 243   g_free (cache->tmp_location);
 244   g_free (cache);
 245   GST_INFO ("Wrote binary registry cache");
 246   return TRUE;
 247
 248 /* ERRORS */
 249 fail_after_close:
 250   {
 251     g_unlink (cache->tmp_location);
 252     g_free (cache->tmp_location);
 253     g_free (cache);
 254     return FALSE;
 255   }
 256 fsync_failed:
 257   {
 258     GST_ERROR ("fsync() failed: %s", g_strerror (errno));
 259     goto fail_after_close;
 260   }
 261 close_failed:
 262   {
 263     GST_ERROR ("close() failed: %s", g_strerror (errno));
 264     goto fail_after_close;
 265   }
 266 rename_failed:
 267   {
 268     GST_ERROR ("g_rename() failed: %s", g_strerror (errno));
 269     goto fail_after_close;
 270   }
 271 }
 272 #endif
 273
 274 /*
 275  * gst_registry_binary_write_chunk:
 276  *
 277  * Write from a memory location to the registry cache file
 278  *
 279  * Returns: %TRUE for success
 280  */
 281 inline static gboolean
 282 gst_registry_binary_write_chunk (BinaryRegistryCache * cache,
 283     GstRegistryChunk * chunk, unsigned long *file_position)
 284 {
 285   gchar padder[ALIGNMENT] = { 0, };
 286   int padsize = 0;
 287
 288   /* Padding to insert the struct that requiere word alignment */
 289   if ((chunk->align) && (alignment (*file_position) != 0)) {
 290     padsize = ALIGNMENT - alignment (*file_position);
 291     if (gst_registry_binary_cache_write (cache, *file_position,
 292             padder, padsize) != padsize) {
 293       GST_ERROR ("Failed to write binary registry padder");
 294       return FALSE;
 295     }
 296     *file_position += padsize;
 297   }
 298
 299   if (gst_registry_binary_cache_write (cache, *file_position,
 300           chunk->data, chunk->size) != chunk->size) {
 301     GST_ERROR ("Failed to write binary registry element");
 302     return FALSE;
 303   }
 304
 305   *file_position += chunk->size;
 306
 307   return TRUE;
 308 }
 309
 310
 311 /*
 312  * gst_registry_binary_initialize_magic:
 313  *
 314  * Initialize the GstBinaryRegistryMagic, setting both our magic number and
 315  * gstreamer major/minor version
 316  */
 317 inline static gboolean
 318 gst_registry_binary_initialize_magic (GstBinaryRegistryMagic * m)
 319 {
 320   memset (m, 0, sizeof (GstBinaryRegistryMagic));
 321
 322   if (!strncpy (m->magic, GST_MAGIC_BINARY_REGISTRY_STR,
 323           GST_MAGIC_BINARY_REGISTRY_LEN)
 324       || !strncpy (m->version, GST_MAGIC_BINARY_VERSION_STR,
 325           GST_MAGIC_BINARY_VERSION_LEN)) {
 326     GST_ERROR ("Failed to write magic to the registry magic structure");
 327     return FALSE;
 328   }
 329
 330   return TRUE;
 331 }
 332
 333 /**
 334  * gst_registry_binary_write_cache:
 335  * @registry: a #GstRegistry
 336  * @location: a filename
 337  *
 338  * Write the @registry to a cache to file at given @location.
 339  *
 340  * Returns: %TRUE on success.
 341  */
 342 gboolean
 343 gst_registry_binary_write_cache (GstRegistry * registry, const char *location)
 344 {
 345   GList *walk;
 346   GstBinaryRegistryMagic magic;
 347   GList *to_write = NULL;
 348   unsigned long file_position = 0;
 349   BinaryRegistryCache *cache;
 350
 351   GST_INFO ("Building binary registry cache image");
 352
 353   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
 354
 355   if (!gst_registry_binary_initialize_magic (&magic))
 356     goto fail;
 357
 358   /* iterate trough the list of plugins and fit them into binary structures */
 359   for (walk = registry->plugins; walk; walk = g_list_next (walk)) {
 360     GstPlugin *plugin = GST_PLUGIN (walk->data);
 361
 362     if (!plugin->filename)
 363       continue;
 364
 365     if (plugin->flags & GST_PLUGIN_FLAG_CACHED) {
 366       struct stat statbuf;
 367
 368       if (g_stat (plugin->filename, &statbuf) < 0 ||
 369           plugin->file_mtime != statbuf.st_mtime ||
 370           plugin->file_size != statbuf.st_size)
 371         continue;
 372     }
 373
 374     if (!_priv_gst_registry_chunks_save_plugin (&to_write, registry, plugin)) {
 375       GST_ERROR ("Can't write binary plugin information for \"%s\"",
 376           plugin->filename);
 377     }
 378   }
 379
 380   GST_INFO ("Writing binary registry cache");
 381
 382   cache = gst_registry_binary_cache_init (registry, location);
 383   if (!cache)
 384     goto fail_free_list;
 385
 386   /* write magic */
 387   if (gst_registry_binary_cache_write (cache, file_position,
 388           &magic, sizeof (GstBinaryRegistryMagic)) !=
 389       sizeof (GstBinaryRegistryMagic)) {
 390     GST_ERROR ("Failed to write binary registry magic");
 391     goto fail_free_list;
 392   }
 393   file_position += sizeof (GstBinaryRegistryMagic);
 394
 395   /* write out data chunks */
 396   for (walk = to_write; walk; walk = g_list_next (walk)) {
 397     GstRegistryChunk *cur = walk->data;
 398     gboolean res;
 399
 400     res = gst_registry_binary_write_chunk (cache, cur, &file_position);
 401     if (!(cur->flags & GST_REGISTRY_CHUNK_FLAG_CONST))
 402       g_free (cur->data);
 403     g_free (cur);
 404     walk->data = NULL;
 405     if (!res)
 406       goto fail_free_list;
 407   }
 408   g_list_free (to_write);
 409
 410   if (!gst_registry_binary_cache_finish (cache, TRUE))
 411     return FALSE;
 412
 413   return TRUE;
 414
 415   /* Errors */
 416 fail_free_list:
 417   {
 418     for (walk = to_write; walk; walk = g_list_next (walk)) {
 419       GstRegistryChunk *cur = walk->data;
 420
 421       if (cur) {
 422         if (!(cur->flags & GST_REGISTRY_CHUNK_FLAG_CONST))
 423           g_free (cur->data);
 424         g_free (cur);
 425       }
 426     }
 427     g_list_free (to_write);
 428
 429     if (cache)
 430       (void) gst_registry_binary_cache_finish (cache, FALSE);
 431     /* fall through */
 432   }
 433 fail:
 434   {
 435     return FALSE;
 436   }
 437 }
 438
 439
 440 /* Registry loading */
 441
 442 /*
 443  * gst_registry_binary_check_magic:
 444  *
 445  * Check GstBinaryRegistryMagic validity.
 446  * Return < 0 if something is wrong, -2 means
 447  * that just the version of the registry is out of
 448  * date, -1 is a general failure.
 449  */
 450 static gint
 451 gst_registry_binary_check_magic (gchar ** in, gsize size)
 452 {
 453   GstBinaryRegistryMagic *m;
 454
 455   align (*in);
 456   GST_DEBUG ("Reading/casting for GstBinaryRegistryMagic at address %p", *in);
 457   unpack_element (*in, m, GstBinaryRegistryMagic, (*in + size), fail);
 458
 459   if (strncmp (m->magic, GST_MAGIC_BINARY_REGISTRY_STR,
 460           GST_MAGIC_BINARY_REGISTRY_LEN) != 0) {
 461     GST_WARNING
 462         ("Binary registry magic is different : %02x%02x%02x%02x != %02x%02x%02x%02x",
 463         GST_MAGIC_BINARY_REGISTRY_STR[0] & 0xff,
 464         GST_MAGIC_BINARY_REGISTRY_STR[1] & 0xff,
 465         GST_MAGIC_BINARY_REGISTRY_STR[2] & 0xff,
 466         GST_MAGIC_BINARY_REGISTRY_STR[3] & 0xff, m->magic[0] & 0xff,
 467         m->magic[1] & 0xff, m->magic[2] & 0xff, m->magic[3] & 0xff);
 468     return -1;
 469   }
 470   if (strncmp (m->version, GST_MAGIC_BINARY_VERSION_STR,
 471           GST_MAGIC_BINARY_VERSION_LEN)) {
 472     GST_WARNING ("Binary registry magic version is different : %s != %s",
 473         GST_MAGIC_BINARY_VERSION_STR, m->version);
 474     return -2;
 475   }
 476
 477   return 0;
 478
 479 fail:
 480   GST_WARNING ("Not enough data for binary registry magic structure");
 481   return -1;
 482 }
 483
 484 /**
 485  * gst_registry_binary_read_cache:
 486  * @registry: a #GstRegistry
 487  * @location: a filename
 488  *
 489  * Read the contents of the binary cache file at @location into @registry.
 490  *
 491  * Returns: %TRUE on success.
 492  */
 493 gboolean
 494 gst_registry_binary_read_cache (GstRegistry * registry, const char *location)
 495 {
 496   GMappedFile *mapped = NULL;
 497   gchar *contents = NULL;
 498   gchar *in = NULL;
 499   gsize size;
 500   GError *err = NULL;
 501   gboolean res = FALSE;
 502   gint check_magic_result;
 503 #ifndef GST_DISABLE_GST_DEBUG
 504   GTimer *timer = NULL;
 505   gdouble seconds;
 506 #endif
 507
 508   /* make sure these types exist */
 509   GST_TYPE_ELEMENT_FACTORY;
 510   GST_TYPE_TYPE_FIND_FACTORY;
 511   GST_TYPE_INDEX_FACTORY;
 512
 513 #ifndef GST_DISABLE_GST_DEBUG
 514   timer = g_timer_new ();
 515 #endif
 516
 517   mapped = g_mapped_file_new (location, FALSE, &err);
 518   if (G_UNLIKELY (err != NULL)) {
 519     GST_INFO ("Unable to mmap file %s : %s", location, err->message);
 520     g_error_free (err);
 521     err = NULL;
 522   }
 523
 524   if (mapped == NULL) {
 525     /* Error mmap-ing the cache, try a plain memory read */
 526
 527     g_file_get_contents (location, &contents, &size, &err);
 528     if (err != NULL) {
 529       GST_INFO ("Unable to read file %s : %s", location, err->message);
 530 #ifndef GST_DISABLE_GST_DEBUG
 531       g_timer_destroy (timer);
 532 #endif
 533       g_error_free (err);
 534       return FALSE;
 535     }
 536   } else {
 537     /* This can't fail if g_mapped_file_new() succeeded */
 538     contents = g_mapped_file_get_contents (mapped);
 539     size = g_mapped_file_get_length (mapped);
 540   }
 541
 542   /* in is a cursor pointer, we initialize it with the begin of registry and is updated on each read */
 543   in = contents;
 544   GST_DEBUG ("File data at address %p", in);
 545   if (G_UNLIKELY (size < sizeof (GstBinaryRegistryMagic))) {
 546     GST_ERROR ("No or broken registry header for file at %s", location);
 547     goto Error;
 548   }
 549
 550   /* check if header is valid */
 551   if (G_UNLIKELY ((check_magic_result =
 552               gst_registry_binary_check_magic (&in, size)) < 0)) {
 553
 554     if (check_magic_result == -1)
 555       GST_ERROR
 556           ("Binary registry type not recognized (invalid magic) for file at %s",
 557           location);
 558     goto Error;
 559   }
 560
 561   /* check if there are plugins in the file */
 562   if (G_UNLIKELY (!(((gsize) in + sizeof (GstRegistryChunkPluginElement)) <
 563               (gsize) contents + size))) {
 564     GST_INFO ("No binary plugins structure to read");
 565     /* empty file, this is not an error */
 566   } else {
 567     gchar *end = contents + size;
 568     /* read as long as we still have space for a GstRegistryChunkPluginElement */
 569     for (;
 570         ((gsize) in + sizeof (GstRegistryChunkPluginElement)) <
 571         (gsize) contents + size;) {
 572       GST_DEBUG ("reading binary registry %" G_GSIZE_FORMAT "(%x)/%"
 573           G_GSIZE_FORMAT, (gsize) in - (gsize) contents,
 574           (guint) ((gsize) in - (gsize) contents), size);
 575       if (!_priv_gst_registry_chunks_load_plugin (registry, &in, end, NULL)) {
 576         GST_ERROR ("Problem while reading binary registry %s", location);
 577         goto Error;
 578       }
 579     }
 580   }
 581
 582 #ifndef GST_DISABLE_GST_DEBUG
 583   g_timer_stop (timer);
 584   seconds = g_timer_elapsed (timer, NULL);
 585 #endif
 586
 587   GST_INFO ("loaded %s in %lf seconds", location, seconds);
 588
 589   res = TRUE;
 590   /* TODO: once we re-use the pointers to registry contents, return here */
 591
 592 Error:
 593   if (err)
 594     g_error_free (err);
 595
 596 #ifndef GST_DISABLE_GST_DEBUG
 597   g_timer_destroy (timer);
 598 #endif
 599   if (mapped) {
 600 #if GLIB_CHECK_VERSION(2,22,0)
 601     g_mapped_file_unref (mapped);
 602 #else
 603     g_mapped_file_free (mapped);
 604 #endif
 605   } else {
 606     g_free (contents);
 607   }
 608   return res;
 609 }
 610
 611 #ifndef GST_REMOVE_DEPRECATED
 612 /* FIXME 0.11: these symbols are here for backwards compatibility and should
 613  * be removed or made private */
 614 gboolean
 615 gst_registry_xml_read_cache (GstRegistry * registry, const char *location)
 616 {
 617   return FALSE;
 618 }
 619
 620 gboolean
 621 gst_registry_xml_write_cache (GstRegistry * registry, const char *location)
 622 {
 623   return FALSE;
 624 }
 625 #endif /* GST_REMOVE_DEPRECATED */