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_slice_new0 (BinaryRegistryCache);
 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_slice_free (BinaryRegistryCache, 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_slice_new0 (BinaryRegistryCache);
 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     int ret;
 181     GStatBuf statbuf;
 182     gchar *dir;
 183
 184     /* oops, I bet the directory doesn't exist */
 185     dir = g_path_get_dirname (location);
 186     g_mkdir_with_parents (dir, 0777);
 187
 188     ret = g_stat (dir, &statbuf);
 189     if (ret != -1 && (statbuf.st_mode & 0700) != 0700) {
 190       g_chmod (dir, 0700);
 191     }
 192
 193     g_free (dir);
 194
 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);
 199
 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);
 204       return NULL;
 205     }
 206
 207     ret = g_stat (cache->tmp_location, &statbuf);
 208     if (ret != -1 && (statbuf.st_mode & 0600) != 0600) {
 209       g_chmod (cache->tmp_location, 0600);
 210     }
 211   }
 212
 213   return cache;
 214 }
 215
 216 static int
 217 gst_registry_binary_cache_write (BinaryRegistryCache * cache,
 218     unsigned long offset, const void *data, int length)
 219 {
 220   long written;
 221   if (offset != cache->currentoffset) {
 222     if (lseek (cache->cache_fd, offset, SEEK_SET) != 0) {
 223       GST_ERROR ("Seeking to new offset failed");
 224       return FALSE;
 225     }
 226     cache->currentoffset = offset;
 227   }
 228
 229   written = write (cache->cache_fd, data, length);
 230   if (written != length) {
 231     GST_ERROR ("Failed to write to cache file");
 232   }
 233   cache->currentoffset += written;
 234
 235   return written;
 236 }
 237
 238 static gboolean
 239 gst_registry_binary_cache_finish (BinaryRegistryCache * cache, gboolean success)
 240 {
 241   /* only fsync if we're actually going to use and rename the file below */
 242   if (success && fsync (cache->cache_fd) < 0)
 243     goto fsync_failed;
 244
 245   if (close (cache->cache_fd) < 0)
 246     goto close_failed;
 247
 248   if (success) {
 249     /* Only do the rename if we wrote the entire file successfully */
 250     if (g_rename (cache->tmp_location, cache->location) < 0) {
 251       GST_ERROR ("g_rename() failed: %s", g_strerror (errno));
 252       goto rename_failed;
 253     }
 254   }
 255
 256   g_free (cache->tmp_location);
 257   g_slice_free (BinaryRegistryCache, cache);
 258   GST_INFO ("Wrote binary registry cache");
 259   return TRUE;
 260
 261 /* ERRORS */
 262 fail_after_close:
 263   {
 264     g_unlink (cache->tmp_location);
 265     g_free (cache->tmp_location);
 266     g_slice_free (BinaryRegistryCache, cache);
 267     return FALSE;
 268   }
 269 fsync_failed:
 270   {
 271     GST_ERROR ("fsync() failed: %s", g_strerror (errno));
 272     goto fail_after_close;
 273   }
 274 close_failed:
 275   {
 276     GST_ERROR ("close() failed: %s", g_strerror (errno));
 277     goto fail_after_close;
 278   }
 279 rename_failed:
 280   {
 281     GST_ERROR ("g_rename() failed: %s", g_strerror (errno));
 282     goto fail_after_close;
 283   }
 284 }
 285 #endif
 286
 287 /*
 288  * gst_registry_binary_write_chunk:
 289  *
 290  * Write from a memory location to the registry cache file
 291  *
 292  * Returns: %TRUE for success
 293  */
 294 inline static gboolean
 295 gst_registry_binary_write_chunk (BinaryRegistryCache * cache,
 296     GstRegistryChunk * chunk, unsigned long *file_position)
 297 {
 298   gchar padder[ALIGNMENT] = { 0, };
 299   int padsize = 0;
 300
 301   /* Padding to insert the struct that requiere word alignment */
 302   if ((chunk->align) && (alignment (*file_position) != 0)) {
 303     padsize = ALIGNMENT - alignment (*file_position);
 304     if (gst_registry_binary_cache_write (cache, *file_position,
 305             padder, padsize) != padsize) {
 306       GST_ERROR ("Failed to write binary registry padder");
 307       return FALSE;
 308     }
 309     *file_position += padsize;
 310   }
 311
 312   if (gst_registry_binary_cache_write (cache, *file_position,
 313           chunk->data, chunk->size) != chunk->size) {
 314     GST_ERROR ("Failed to write binary registry element");
 315     return FALSE;
 316   }
 317
 318   *file_position += chunk->size;
 319
 320   return TRUE;
 321 }
 322
 323
 324 /*
 325  * gst_registry_binary_initialize_magic:
 326  *
 327  * Initialize the GstBinaryRegistryMagic, setting both our magic number and
 328  * gstreamer major/minor version
 329  */
 330 inline static gboolean
 331 gst_registry_binary_initialize_magic (GstBinaryRegistryMagic * m)
 332 {
 333   memset (m, 0, sizeof (GstBinaryRegistryMagic));
 334
 335   if (!strncpy (m->magic, GST_MAGIC_BINARY_REGISTRY_STR,
 336           GST_MAGIC_BINARY_REGISTRY_LEN)
 337       || !strncpy (m->version, GST_MAGIC_BINARY_VERSION_STR,
 338           GST_MAGIC_BINARY_VERSION_LEN)) {
 339     GST_ERROR ("Failed to write magic to the registry magic structure");
 340     return FALSE;
 341   }
 342
 343   return TRUE;
 344 }
 345
 346 /**
 347  * gst_registry_binary_write_cache:
 348  * @registry: a #GstRegistry
 349  * @location: a filename
 350  *
 351  * Write the @registry to a cache to file at given @location.
 352  *
 353  * Returns: %TRUE on success.
 354  */
 355 gboolean
 356 priv_gst_registry_binary_write_cache (GstRegistry * registry,
 357     const char *location)
 358 {
 359   GList *walk;
 360   GstBinaryRegistryMagic magic;
 361   GList *to_write = NULL;
 362   unsigned long file_position = 0;
 363   BinaryRegistryCache *cache;
 364
 365   GST_INFO ("Building binary registry cache image");
 366
 367   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
 368
 369   if (!gst_registry_binary_initialize_magic (&magic))
 370     goto fail;
 371
 372   /* iterate trough the list of plugins and fit them into binary structures */
 373   for (walk = registry->plugins; walk; walk = g_list_next (walk)) {
 374     GstPlugin *plugin = GST_PLUGIN (walk->data);
 375
 376     if (!plugin->filename)
 377       continue;
 378
 379     if (plugin->flags & GST_PLUGIN_FLAG_CACHED) {
 380       GStatBuf statbuf;
 381
 382       if (g_stat (plugin->filename, &statbuf) < 0 ||
 383           plugin->file_mtime != statbuf.st_mtime ||
 384           plugin->file_size != statbuf.st_size)
 385         continue;
 386     }
 387
 388     if (!_priv_gst_registry_chunks_save_plugin (&to_write, registry, plugin)) {
 389       GST_ERROR ("Can't write binary plugin information for \"%s\"",
 390           plugin->filename);
 391     }
 392   }
 393
 394   _priv_gst_registry_chunks_save_global_header (&to_write, registry,
 395       priv_gst_plugin_loading_get_whitelist_hash ());
 396
 397   GST_INFO ("Writing binary registry cache");
 398
 399   cache = gst_registry_binary_cache_init (registry, location);
 400   if (!cache)
 401     goto fail_free_list;
 402
 403   /* write magic */
 404   if (gst_registry_binary_cache_write (cache, file_position,
 405           &magic, sizeof (GstBinaryRegistryMagic)) !=
 406       sizeof (GstBinaryRegistryMagic)) {
 407     GST_ERROR ("Failed to write binary registry magic");
 408     goto fail_free_list;
 409   }
 410   file_position += sizeof (GstBinaryRegistryMagic);
 411
 412   /* write out data chunks */
 413   for (walk = to_write; walk; walk = g_list_next (walk)) {
 414     GstRegistryChunk *cur = walk->data;
 415     gboolean res;
 416
 417     res = gst_registry_binary_write_chunk (cache, cur, &file_position);
 418
 419     _priv_gst_registry_chunk_free (cur);
 420     walk->data = NULL;
 421     if (!res)
 422       goto fail_free_list;
 423   }
 424   g_list_free (to_write);
 425
 426   if (!gst_registry_binary_cache_finish (cache, TRUE))
 427     return FALSE;
 428
 429   return TRUE;
 430
 431   /* Errors */
 432 fail_free_list:
 433   {
 434     for (walk = to_write; walk; walk = g_list_next (walk)) {
 435       GstRegistryChunk *cur = walk->data;
 436
 437       if (cur)
 438         _priv_gst_registry_chunk_free (cur);
 439     }
 440     g_list_free (to_write);
 441
 442     if (cache)
 443       (void) gst_registry_binary_cache_finish (cache, FALSE);
 444     /* fall through */
 445   }
 446 fail:
 447   {
 448     return FALSE;
 449   }
 450 }
 451
 452
 453 /* Registry loading */
 454
 455 /*
 456  * gst_registry_binary_check_magic:
 457  *
 458  * Check GstBinaryRegistryMagic validity.
 459  * Return < 0 if something is wrong, -2 means
 460  * that just the version of the registry is out of
 461  * date, -1 is a general failure.
 462  */
 463 static gint
 464 gst_registry_binary_check_magic (gchar ** in, gsize size)
 465 {
 466   GstBinaryRegistryMagic *m;
 467
 468   align (*in);
 469   GST_DEBUG ("Reading/casting for GstBinaryRegistryMagic at address %p", *in);
 470   unpack_element (*in, m, GstBinaryRegistryMagic, (*in + size), fail);
 471
 472   if (strncmp (m->magic, GST_MAGIC_BINARY_REGISTRY_STR,
 473           GST_MAGIC_BINARY_REGISTRY_LEN) != 0) {
 474     GST_WARNING
 475         ("Binary registry magic is different : %02x%02x%02x%02x != %02x%02x%02x%02x",
 476         GST_MAGIC_BINARY_REGISTRY_STR[0] & 0xff,
 477         GST_MAGIC_BINARY_REGISTRY_STR[1] & 0xff,
 478         GST_MAGIC_BINARY_REGISTRY_STR[2] & 0xff,
 479         GST_MAGIC_BINARY_REGISTRY_STR[3] & 0xff, m->magic[0] & 0xff,
 480         m->magic[1] & 0xff, m->magic[2] & 0xff, m->magic[3] & 0xff);
 481     return -1;
 482   }
 483   if (strncmp (m->version, GST_MAGIC_BINARY_VERSION_STR,
 484           GST_MAGIC_BINARY_VERSION_LEN)) {
 485     GST_WARNING ("Binary registry magic version is different : %s != %s",
 486         GST_MAGIC_BINARY_VERSION_STR, m->version);
 487     return -2;
 488   }
 489
 490   return 0;
 491
 492 fail:
 493   GST_WARNING ("Not enough data for binary registry magic structure");
 494   return -1;
 495 }
 496
 497 /**
 498  * gst_registry_binary_read_cache:
 499  * @registry: a #GstRegistry
 500  * @location: a filename
 501  *
 502  * Read the contents of the binary cache file at @location into @registry.
 503  *
 504  * Returns: %TRUE on success.
 505  */
 506 gboolean
 507 priv_gst_registry_binary_read_cache (GstRegistry * registry,
 508     const char *location)
 509 {
 510   GMappedFile *mapped = NULL;
 511   gchar *contents = NULL;
 512   gchar *in = NULL;
 513   gsize size;
 514   GError *err = 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;
 520   gdouble seconds;
 521 #endif
 522
 523   /* make sure these types exist */
 524   GST_TYPE_ELEMENT_FACTORY;
 525   GST_TYPE_TYPE_FIND_FACTORY;
 526   GST_TYPE_INDEX_FACTORY;
 527
 528 #ifndef GST_DISABLE_GST_DEBUG
 529   timer = g_timer_new ();
 530 #endif
 531
 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);
 535     g_error_free (err);
 536     err = NULL;
 537   }
 538
 539   if (mapped == NULL) {
 540     /* Error mmap-ing the cache, try a plain memory read */
 541
 542     g_file_get_contents (location, &contents, &size, &err);
 543     if (err != NULL) {
 544       GST_INFO ("Unable to read file %s : %s", location, err->message);
 545 #ifndef GST_DISABLE_GST_DEBUG
 546       g_timer_destroy (timer);
 547 #endif
 548       g_error_free (err);
 549       return FALSE;
 550     }
 551   } else {
 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);
 555   }
 556
 557   /* in is a cursor pointer, we initialize it with the begin of registry and is updated on each read */
 558   in = contents;
 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);
 562     goto Error;
 563   }
 564
 565   /* check if header is valid */
 566   if (G_UNLIKELY ((check_magic_result =
 567               gst_registry_binary_check_magic (&in, size)) < 0)) {
 568
 569     if (check_magic_result == -1)
 570       GST_ERROR
 571           ("Binary registry type not recognized (invalid magic) for file at %s",
 572           location);
 573     goto Error;
 574   }
 575
 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");
 579     goto Error;
 580   }
 581
 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");
 585     goto done;
 586   }
 587
 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 */
 593   } else {
 594     gchar *end = contents + size;
 595     /* read as long as we still have space for a GstRegistryChunkPluginElement */
 596     for (;
 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);
 604         goto Error;
 605       }
 606     }
 607   }
 608
 609 done:
 610
 611 #ifndef GST_DISABLE_GST_DEBUG
 612   g_timer_stop (timer);
 613   seconds = g_timer_elapsed (timer, NULL);
 614 #endif
 615
 616   GST_INFO ("loaded %s in %lf seconds", location, seconds);
 617
 618   res = TRUE;
 619   /* TODO: once we re-use the pointers to registry contents, return here */
 620
 621 Error:
 622 #ifndef GST_DISABLE_GST_DEBUG
 623   g_timer_destroy (timer);
 624 #endif
 625   if (mapped) {
 626     g_mapped_file_unref (mapped);
 627   } else {
 628     g_free (contents);
 629   }
 630   return res;
 631 }