gst/gstregistry.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 David A. Schleef <ds@schleef.org>
   5  *
   6  * gstregistry.c: handle registry
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21  * Boston, MA 02110-1301, USA.
  22  */
  23
  24 /**
  25  * SECTION:gstregistry
  26  * @short_description: Abstract base class for management of #GstPlugin objects
  27  * @see_also: #GstPlugin, #GstPluginFeature
  28  *
  29  * One registry holds the metadata of a set of plugins.
  30  *
  31  * <emphasis role="bold">Design:</emphasis>
  32  *
  33  * The #GstRegistry object is a list of plugins and some functions for dealing
  34  * with them. Each #GstPlugin is matched 1-1 with a file on disk, and may or may
  35  * not be loaded at a given time.
  36  *
  37  * The primary source, at all times, of plugin information is each plugin file
  38  * itself. Thus, if an application wants information about a particular plugin,
  39  * or wants to search for a feature that satisfies given criteria, the primary
  40  * means of doing so is to load every plugin and look at the resulting
  41  * information that is gathered in the default registry. Clearly, this is a time
  42  * consuming process, so we cache information in the registry file. The format
  43  * and location of the cache file is internal to gstreamer.
  44  *
  45  * On startup, plugins are searched for in the plugin search path. The following
  46  * locations are checked in this order:
  47  * <itemizedlist>
  48  *   <listitem>
  49  *     <para>location from --gst-plugin-path commandline option.</para>
  50  *   </listitem>
  51  *   <listitem>
  52  *     <para>the GST_PLUGIN_PATH environment variable.</para>
  53  *   </listitem>
  54  *   <listitem>
  55  *     <para>the GST_PLUGIN_SYSTEM_PATH environment variable.</para>
  56  *   </listitem>
  57  *   <listitem>
  58  *     <para>default locations (if GST_PLUGIN_SYSTEM_PATH is not set). Those
  59  *       default locations are:
  60  *       <filename>$XDG_DATA_HOME/gstreamer-$GST_API_VERSION/plugins/</filename>
  61  *       and <filename>$prefix/libs/gstreamer-$GST_API_VERSION/</filename>.
  62  *       <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">
  63  *       <filename>$XDG_DATA_HOME</filename></ulink> defaults to
  64  *       <filename>$HOME/.local/share</filename>.
  65  *     </para>
  66  *   </listitem>
  67  * </itemizedlist>
  68  * The registry cache file is loaded from
  69  * <filename>$XDG_CACHE_HOME/gstreamer-$GST_API_VERSION/registry-$ARCH.bin</filename>
  70  * (where
  71  * <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">
  72  * <filename>$XDG_CACHE_HOME</filename></ulink> defaults to
  73  * <filename>$HOME/.cache</filename>) or the file listed in the GST_REGISTRY
  74  * env var. One reason to change the registry location is for testing.
  75  *
  76  * For each plugin that is found in the plugin search path, there could be 3
  77  * possibilities for cached information:
  78  * <itemizedlist>
  79  *   <listitem>
  80  *     <para>the cache may not contain information about a given file.</para>
  81  *   </listitem>
  82  *   <listitem>
  83  *     <para>the cache may have stale information.</para>
  84  *   </listitem>
  85  *   <listitem>
  86  *     <para>the cache may have current information.</para>
  87  *   </listitem>
  88  * </itemizedlist>
  89  *
  90  * In the first two cases, the plugin is loaded and the cache updated. In
  91  * addition to these cases, the cache may have entries for plugins that are not
  92  * relevant to the current process. These are marked as not available to the
  93  * current process. If the cache is updated for whatever reason, it is marked
  94  * dirty.
  95  *
  96  * A dirty cache is written out at the end of initialization. Each entry is
  97  * checked to make sure the information is minimally valid. If not, the entry is
  98  * simply dropped.
  99  *
 100  * <emphasis role="bold">Implementation notes:</emphasis>
 101  *
 102  * The "cache" and "registry" are different concepts and can represent
 103  * different sets of plugins. For various reasons, at init time, the cache is
 104  * stored in the default registry, and plugins not relevant to the current
 105  * process are marked with the %GST_PLUGIN_FLAG_CACHED bit. These plugins are
 106  * removed at the end of initialization.
 107  */
 108
 109 #ifdef HAVE_CONFIG_H
 110 #include "config.h"
 111 #endif
 112 #include "gstconfig.h"
 113 #include "gst_private.h"
 114 #include <glib.h>
 115 #include <sys/types.h>
 116 #include <sys/stat.h>
 117 #ifdef HAVE_UNISTD_H
 118 #include <unistd.h>
 119 #endif
 120 #include <errno.h>
 121 #include <stdio.h>
 122 #include <string.h>
 123
 124 /* For g_stat () */
 125 #include <glib/gstdio.h>
 126
 127 #include "gstinfo.h"
 128 #include "gsterror.h"
 129 #include "gstregistry.h"
 130 #include "gstdeviceproviderfactory.h"
 131
 132 #include "gstpluginloader.h"
 133
 134 #include "gst-i18n-lib.h"
 135
 136 #include "gst.h"
 137 #include "glib-compat-private.h"
 138
 139 #ifdef G_OS_WIN32
 140 #include <windows.h>
 141 extern HMODULE _priv_gst_dll_handle;
 142 #endif
 143
 144 #define GST_CAT_DEFAULT GST_CAT_REGISTRY
 145
 146 struct _GstRegistryPrivate
 147 {
 148   GList *plugins;
 149   GList *features;
 150
 151 #if 0
 152   GList *paths;
 153 #endif
 154
 155   int cache_file;
 156
 157   /* hash to speedup _lookup_feature_locked() */
 158   GHashTable *feature_hash;
 159   /* hash to speedup _lookup */
 160   GHashTable *basename_hash;
 161
 162   /* updated whenever the feature list changes */
 163   guint32 cookie;
 164   /* speedup for searching features */
 165   GList *element_factory_list;
 166   guint32 efl_cookie;
 167   GList *typefind_factory_list;
 168   guint32 tfl_cookie;
 169   GList *device_provider_factory_list;
 170   guint32 dmfl_cookie;
 171 };
 172
 173 /* the one instance of the default registry and the mutex protecting the
 174  * variable. */
 175 static GMutex _gst_registry_mutex;
 176 static GstRegistry *_gst_registry_default = NULL;
 177
 178 /* defaults */
 179 #define DEFAULT_FORK TRUE
 180
 181 /* control the behaviour of registry rebuild */
 182 static gboolean _gst_enable_registry_fork = DEFAULT_FORK;
 183 /* List of plugins that need preloading/reloading after scanning registry */
 184 extern GSList *_priv_gst_preload_plugins;
 185
 186 #ifndef GST_DISABLE_REGISTRY
 187 /*set to TRUE when registry needn't to be updated */
 188 gboolean _priv_gst_disable_registry_update = FALSE;
 189 extern GList *_priv_gst_plugin_paths;
 190
 191 /* Set to TRUE when the registry cache should be disabled */
 192 gboolean _gst_disable_registry_cache = FALSE;
 193
 194 static gboolean __registry_reuse_plugin_scanner = TRUE;
 195 #endif
 196
 197 /* Element signals and args */
 198 enum
 199 {
 200   PLUGIN_ADDED,
 201   FEATURE_ADDED,
 202   LAST_SIGNAL
 203 };
 204
 205 static void gst_registry_finalize (GObject * object);
 206
 207 static guint gst_registry_signals[LAST_SIGNAL] = { 0 };
 208
 209 static GstPluginFeature *gst_registry_lookup_feature_locked (GstRegistry *
 210     registry, const char *name);
 211 static GstPlugin *gst_registry_lookup_bn_locked (GstRegistry * registry,
 212     const char *basename);
 213
 214 #define gst_registry_parent_class parent_class
 215 G_DEFINE_TYPE (GstRegistry, gst_registry, GST_TYPE_OBJECT);
 216
 217 static void
 218 gst_registry_class_init (GstRegistryClass * klass)
 219 {
 220   GObjectClass *gobject_class;
 221
 222   gobject_class = (GObjectClass *) klass;
 223
 224   g_type_class_add_private (klass, sizeof (GstRegistryPrivate));
 225
 226   /**
 227    * GstRegistry::plugin-added:
 228    * @registry: the registry that emitted the signal
 229    * @plugin: the plugin that has been added
 230    *
 231    * Signals that a plugin has been added to the registry (possibly
 232    * replacing a previously-added one by the same name)
 233    */
 234   gst_registry_signals[PLUGIN_ADDED] =
 235       g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass),
 236       G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
 237       G_TYPE_NONE, 1, GST_TYPE_PLUGIN);
 238
 239   /**
 240    * GstRegistry::feature-added:
 241    * @registry: the registry that emitted the signal
 242    * @feature: the feature that has been added
 243    *
 244    * Signals that a feature has been added to the registry (possibly
 245    * replacing a previously-added one by the same name)
 246    */
 247   gst_registry_signals[FEATURE_ADDED] =
 248       g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass),
 249       G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_generic,
 250       G_TYPE_NONE, 1, GST_TYPE_PLUGIN_FEATURE);
 251
 252   gobject_class->finalize = gst_registry_finalize;
 253 }
 254
 255 static void
 256 gst_registry_init (GstRegistry * registry)
 257 {
 258   registry->priv =
 259       G_TYPE_INSTANCE_GET_PRIVATE (registry, GST_TYPE_REGISTRY,
 260       GstRegistryPrivate);
 261   registry->priv->feature_hash = g_hash_table_new (g_str_hash, g_str_equal);
 262   registry->priv->basename_hash = g_hash_table_new (g_str_hash, g_str_equal);
 263 }
 264
 265 static void
 266 gst_registry_finalize (GObject * object)
 267 {
 268   GstRegistry *registry = GST_REGISTRY (object);
 269   GList *plugins, *p;
 270   GList *features, *f;
 271
 272   plugins = registry->priv->plugins;
 273   registry->priv->plugins = NULL;
 274
 275   GST_DEBUG_OBJECT (registry, "registry finalize");
 276   p = plugins;
 277   while (p) {
 278     GstPlugin *plugin = p->data;
 279
 280     if (plugin) {
 281       GST_LOG_OBJECT (registry, "removing plugin %s",
 282           gst_plugin_get_name (plugin));
 283       gst_object_unref (plugin);
 284     }
 285     p = g_list_next (p);
 286   }
 287   g_list_free (plugins);
 288
 289   features = registry->priv->features;
 290   registry->priv->features = NULL;
 291
 292   f = features;
 293   while (f) {
 294     GstPluginFeature *feature = f->data;
 295
 296     if (feature) {
 297       GST_LOG_OBJECT (registry, "removing feature %p (%s)", feature,
 298           GST_OBJECT_NAME (feature));
 299       gst_object_unparent (GST_OBJECT_CAST (feature));
 300     }
 301     f = g_list_next (f);
 302   }
 303   g_list_free (features);
 304
 305   g_hash_table_destroy (registry->priv->feature_hash);
 306   registry->priv->feature_hash = NULL;
 307   g_hash_table_destroy (registry->priv->basename_hash);
 308   registry->priv->basename_hash = NULL;
 309
 310   if (registry->priv->element_factory_list) {
 311     GST_DEBUG_OBJECT (registry, "Cleaning up cached element factory list");
 312     gst_plugin_feature_list_free (registry->priv->element_factory_list);
 313   }
 314
 315   if (registry->priv->typefind_factory_list) {
 316     GST_DEBUG_OBJECT (registry, "Cleaning up cached typefind factory list");
 317     gst_plugin_feature_list_free (registry->priv->typefind_factory_list);
 318   }
 319
 320   if (registry->priv->device_provider_factory_list) {
 321     GST_DEBUG_OBJECT (registry,
 322         "Cleaning up cached device provider factory list");
 323     gst_plugin_feature_list_free (registry->priv->device_provider_factory_list);
 324   }
 325
 326   G_OBJECT_CLASS (parent_class)->finalize (object);
 327 }
 328
 329 /**
 330  * gst_registry_get:
 331  *
 332  * Retrieves the singleton plugin registry. The caller does not own a
 333  * reference on the registry, as it is alive as long as GStreamer is
 334  * initialized.
 335  *
 336  * Returns: (transfer none): the #GstRegistry.
 337  */
 338 GstRegistry *
 339 gst_registry_get (void)
 340 {
 341   GstRegistry *registry;
 342
 343   g_mutex_lock (&_gst_registry_mutex);
 344   if (G_UNLIKELY (!_gst_registry_default)) {
 345     _gst_registry_default = g_object_newv (GST_TYPE_REGISTRY, 0, NULL);
 346     gst_object_ref_sink (GST_OBJECT_CAST (_gst_registry_default));
 347   }
 348   registry = _gst_registry_default;
 349   g_mutex_unlock (&_gst_registry_mutex);
 350
 351   return registry;
 352 }
 353
 354 #if 0
 355 /**
 356  * gst_registry_add_path:
 357  * @registry: the registry to add the path to
 358  * @path: the path to add to the registry
 359  *
 360  * Add the given path to the registry. The syntax of the
 361  * path is specific to the registry. If the path has already been
 362  * added, do nothing.
 363  */
 364 void
 365 gst_registry_add_path (GstRegistry * registry, const gchar * path)
 366 {
 367   g_return_if_fail (GST_IS_REGISTRY (registry));
 368   g_return_if_fail (path != NULL);
 369
 370   if (strlen (path) == 0)
 371     goto empty_path;
 372
 373   GST_OBJECT_LOCK (registry);
 374   if (g_list_find_custom (registry->priv->paths, path, (GCompareFunc) strcmp))
 375     goto was_added;
 376
 377   GST_INFO ("Adding plugin path: \"%s\"", path);
 378   registry->priv->paths =
 379       g_list_append (registry->priv->paths, g_strdup (path));
 380   GST_OBJECT_UNLOCK (registry);
 381
 382   return;
 383
 384 empty_path:
 385   {
 386     GST_INFO ("Ignoring empty plugin path");
 387     return;
 388   }
 389 was_added:
 390   {
 391     g_warning ("path %s already added to registry", path);
 392     GST_OBJECT_UNLOCK (registry);
 393     return;
 394   }
 395 }
 396
 397 /**
 398  * gst_registry_get_path_list:
 399  * @registry: the registry to get the pathlist of
 400  *
 401  * Get the list of paths for the given registry.
 402  *
 403  * Returns: (transfer container) (element-type char*): A #GList of paths as
 404  *     strings. g_list_free after use.
 405  *
 406  * MT safe.
 407  */
 408 GList *
 409 gst_registry_get_path_list (GstRegistry * registry)
 410 {
 411   GList *list;
 412
 413   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 414
 415   GST_OBJECT_LOCK (registry);
 416   /* We don't need to copy the strings, because they won't be deleted
 417    * as long as the GstRegistry is around */
 418   list = g_list_copy (registry->priv->paths);
 419   GST_OBJECT_UNLOCK (registry);
 420
 421   return list;
 422 }
 423 #endif
 424
 425 /**
 426  * gst_registry_add_plugin:
 427  * @registry: the registry to add the plugin to
 428  * @plugin: (transfer full): the plugin to add
 429  *
 430  * Add the plugin to the registry. The plugin-added signal will be emitted.
 431  * This function will sink @plugin.
 432  *
 433  * Returns: %TRUE on success.
 434  *
 435  * MT safe.
 436  */
 437 gboolean
 438 gst_registry_add_plugin (GstRegistry * registry, GstPlugin * plugin)
 439 {
 440   GstPlugin *existing_plugin;
 441
 442   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
 443   g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
 444
 445   GST_OBJECT_LOCK (registry);
 446   if (G_LIKELY (plugin->basename)) {
 447     /* we have a basename, see if we find the plugin */
 448     existing_plugin =
 449         gst_registry_lookup_bn_locked (registry, plugin->basename);
 450     if (existing_plugin) {
 451       GST_DEBUG_OBJECT (registry,
 452           "Replacing existing plugin \"%s\" %p with new plugin %p for filename \"%s\"",
 453           GST_STR_NULL (existing_plugin->filename), existing_plugin, plugin,
 454           GST_STR_NULL (plugin->filename));
 455       /* If the new plugin is blacklisted and the existing one isn't cached, do not
 456        * accept if it's from a different location than the existing one */
 457       if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED) &&
 458           strcmp (plugin->filename, existing_plugin->filename)) {
 459         GST_WARNING_OBJECT (registry,
 460             "Not replacing plugin because new one (%s) is blacklisted but for a different location than existing one (%s)",
 461             plugin->filename, existing_plugin->filename);
 462         gst_object_unref (plugin);
 463         GST_OBJECT_UNLOCK (registry);
 464         return FALSE;
 465       }
 466       registry->priv->plugins =
 467           g_list_remove (registry->priv->plugins, existing_plugin);
 468       if (G_LIKELY (existing_plugin->basename))
 469         g_hash_table_remove (registry->priv->basename_hash,
 470             existing_plugin->basename);
 471       gst_object_unref (existing_plugin);
 472     }
 473   }
 474
 475   GST_DEBUG_OBJECT (registry, "adding plugin %p for filename \"%s\"",
 476       plugin, GST_STR_NULL (plugin->filename));
 477
 478   registry->priv->plugins = g_list_prepend (registry->priv->plugins, plugin);
 479   if (G_LIKELY (plugin->basename))
 480     g_hash_table_replace (registry->priv->basename_hash, plugin->basename,
 481         plugin);
 482
 483   gst_object_ref_sink (plugin);
 484   GST_OBJECT_UNLOCK (registry);
 485
 486   GST_LOG_OBJECT (registry, "emitting plugin-added for filename \"%s\"",
 487       GST_STR_NULL (plugin->filename));
 488   g_signal_emit (registry, gst_registry_signals[PLUGIN_ADDED], 0, plugin);
 489
 490   return TRUE;
 491 }
 492
 493 static void
 494 gst_registry_remove_features_for_plugin_unlocked (GstRegistry * registry,
 495     GstPlugin * plugin)
 496 {
 497   GList *f;
 498
 499   g_return_if_fail (GST_IS_REGISTRY (registry));
 500   g_return_if_fail (GST_IS_PLUGIN (plugin));
 501
 502   /* Remove all features for this plugin */
 503   f = registry->priv->features;
 504   while (f != NULL) {
 505     GList *next = g_list_next (f);
 506     GstPluginFeature *feature = f->data;
 507
 508     if (G_UNLIKELY (feature && feature->plugin == plugin)) {
 509       GST_DEBUG_OBJECT (registry, "removing feature %p (%s) for plugin %p (%s)",
 510           feature, gst_plugin_feature_get_name (feature), plugin,
 511           plugin->desc.name);
 512
 513       registry->priv->features =
 514           g_list_delete_link (registry->priv->features, f);
 515       g_hash_table_remove (registry->priv->feature_hash,
 516           GST_OBJECT_NAME (feature));
 517       gst_object_unparent (GST_OBJECT_CAST (feature));
 518     }
 519     f = next;
 520   }
 521   registry->priv->cookie++;
 522 }
 523
 524 /**
 525  * gst_registry_remove_plugin:
 526  * @registry: the registry to remove the plugin from
 527  * @plugin: (transfer none): the plugin to remove
 528  *
 529  * Remove the plugin from the registry.
 530  *
 531  * MT safe.
 532  */
 533 void
 534 gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin)
 535 {
 536   g_return_if_fail (GST_IS_REGISTRY (registry));
 537   g_return_if_fail (GST_IS_PLUGIN (plugin));
 538
 539   GST_DEBUG_OBJECT (registry, "removing plugin %p (%s)",
 540       plugin, gst_plugin_get_name (plugin));
 541
 542   GST_OBJECT_LOCK (registry);
 543   registry->priv->plugins = g_list_remove (registry->priv->plugins, plugin);
 544   if (G_LIKELY (plugin->basename))
 545     g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
 546   gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
 547   GST_OBJECT_UNLOCK (registry);
 548   gst_object_unref (plugin);
 549 }
 550
 551 /**
 552  * gst_registry_add_feature:
 553  * @registry: the registry to add the plugin to
 554  * @feature: (transfer full): the feature to add
 555  *
 556  * Add the feature to the registry. The feature-added signal will be emitted.
 557  * This function sinks @feature.
 558  *
 559  * Returns: %TRUE on success.
 560  *
 561  * MT safe.
 562  */
 563 gboolean
 564 gst_registry_add_feature (GstRegistry * registry, GstPluginFeature * feature)
 565 {
 566   GstPluginFeature *existing_feature;
 567
 568   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
 569   g_return_val_if_fail (GST_IS_PLUGIN_FEATURE (feature), FALSE);
 570   g_return_val_if_fail (GST_OBJECT_NAME (feature) != NULL, FALSE);
 571   g_return_val_if_fail (feature->plugin_name != NULL, FALSE);
 572
 573   GST_OBJECT_LOCK (registry);
 574   existing_feature = gst_registry_lookup_feature_locked (registry,
 575       GST_OBJECT_NAME (feature));
 576   if (G_UNLIKELY (existing_feature)) {
 577     GST_DEBUG_OBJECT (registry, "replacing existing feature %p (%s)",
 578         existing_feature, GST_OBJECT_NAME (feature));
 579     /* Remove the existing feature from the list now, before we insert the new
 580      * one, but don't unref yet because the hash is still storing a reference to
 581      * it. */
 582     registry->priv->features =
 583         g_list_remove (registry->priv->features, existing_feature);
 584   }
 585
 586   GST_DEBUG_OBJECT (registry, "adding feature %p (%s)", feature,
 587       GST_OBJECT_NAME (feature));
 588
 589   registry->priv->features = g_list_prepend (registry->priv->features, feature);
 590   g_hash_table_replace (registry->priv->feature_hash, GST_OBJECT_NAME (feature),
 591       feature);
 592
 593   if (G_UNLIKELY (existing_feature)) {
 594     /* We unref now. No need to remove the feature name from the hash table, it
 595      * got replaced by the new feature */
 596     gst_object_unparent (GST_OBJECT_CAST (existing_feature));
 597   }
 598
 599   gst_object_set_parent (GST_OBJECT_CAST (feature), GST_OBJECT_CAST (registry));
 600
 601   registry->priv->cookie++;
 602   GST_OBJECT_UNLOCK (registry);
 603
 604   GST_LOG_OBJECT (registry, "emitting feature-added for %s",
 605       GST_OBJECT_NAME (feature));
 606   g_signal_emit (registry, gst_registry_signals[FEATURE_ADDED], 0, feature);
 607
 608   return TRUE;
 609 }
 610
 611 /**
 612  * gst_registry_remove_feature:
 613  * @registry: the registry to remove the feature from
 614  * @feature: (transfer none): the feature to remove
 615  *
 616  * Remove the feature from the registry.
 617  *
 618  * MT safe.
 619  */
 620 void
 621 gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
 622 {
 623   g_return_if_fail (GST_IS_REGISTRY (registry));
 624   g_return_if_fail (GST_IS_PLUGIN_FEATURE (feature));
 625
 626   GST_DEBUG_OBJECT (registry, "removing feature %p (%s)",
 627       feature, gst_plugin_feature_get_name (feature));
 628
 629   GST_OBJECT_LOCK (registry);
 630   registry->priv->features = g_list_remove (registry->priv->features, feature);
 631   g_hash_table_remove (registry->priv->feature_hash, GST_OBJECT_NAME (feature));
 632   registry->priv->cookie++;
 633   GST_OBJECT_UNLOCK (registry);
 634
 635   gst_object_unparent ((GstObject *) feature);
 636 }
 637
 638 /**
 639  * gst_registry_plugin_filter:
 640  * @registry: registry to query
 641  * @filter: (scope call): the filter to use
 642  * @first: only return first match
 643  * @user_data: (closure): user data passed to the filter function
 644  *
 645  * Runs a filter against all plugins in the registry and returns a #GList with
 646  * the results. If the first flag is set, only the first match is
 647  * returned (as a list with a single object).
 648  * Every plugin is reffed; use gst_plugin_list_free() after use, which
 649  * will unref again.
 650  *
 651  * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
 652  *     Use gst_plugin_list_free() after usage.
 653  *
 654  * MT safe.
 655  */
 656 GList *
 657 gst_registry_plugin_filter (GstRegistry * registry,
 658     GstPluginFilter filter, gboolean first, gpointer user_data)
 659 {
 660   GList *list = NULL;
 661
 662   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 663
 664   GST_OBJECT_LOCK (registry);
 665   {
 666     const GList *walk;
 667
 668     for (walk = registry->priv->plugins; walk != NULL; walk = walk->next) {
 669       GstPlugin *plugin = walk->data;
 670
 671       if (filter == NULL || filter (plugin, user_data)) {
 672         list = g_list_prepend (list, gst_object_ref (plugin));
 673
 674         if (first)
 675           break;
 676       }
 677     }
 678   }
 679   GST_OBJECT_UNLOCK (registry);
 680
 681   return list;
 682 }
 683
 684 typedef struct
 685 {
 686   const gchar *name;
 687   GType type;
 688 } GstTypeNameData;
 689
 690 static gboolean
 691 gst_plugin_feature_type_name_filter (GstPluginFeature * feature,
 692     GstTypeNameData * data)
 693 {
 694   g_assert (GST_IS_PLUGIN_FEATURE (feature));
 695
 696   return ((data->type == 0 || data->type == G_OBJECT_TYPE (feature)) &&
 697       (data->name == NULL || !strcmp (data->name, GST_OBJECT_NAME (feature))));
 698 }
 699
 700 /* returns TRUE if the list was changed
 701  *
 702  * Must be called with the object lock taken */
 703 static gboolean
 704 gst_registry_get_feature_list_or_create (GstRegistry * registry,
 705     GList ** previous, guint32 * cookie, GType type)
 706 {
 707   gboolean res = FALSE;
 708   GstRegistryPrivate *priv = registry->priv;
 709
 710   if (G_UNLIKELY (!*previous || priv->cookie != *cookie)) {
 711     GstTypeNameData data;
 712     const GList *walk;
 713
 714     if (*previous) {
 715       gst_plugin_feature_list_free (*previous);
 716       *previous = NULL;
 717     }
 718
 719     data.type = type;
 720     data.name = NULL;
 721
 722     for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
 723       GstPluginFeature *feature = walk->data;
 724
 725       if (gst_plugin_feature_type_name_filter (feature, &data)) {
 726         *previous = g_list_prepend (*previous, gst_object_ref (feature));
 727       }
 728     }
 729
 730     *cookie = priv->cookie;
 731     res = TRUE;
 732   }
 733
 734   return res;
 735 }
 736
 737 static gint
 738 type_find_factory_rank_cmp (const GstPluginFeature * fac1,
 739     const GstPluginFeature * fac2)
 740 {
 741   if (G_LIKELY (fac1->rank != fac2->rank))
 742     return fac2->rank - fac1->rank;
 743
 744   /* to make the order in which things happen more deterministic,
 745    * sort by name when the ranks are the same. */
 746   return strcmp (GST_OBJECT_NAME (fac1), GST_OBJECT_NAME (fac2));
 747 }
 748
 749 static GList *
 750 gst_registry_get_element_factory_list (GstRegistry * registry)
 751 {
 752   GList *list;
 753
 754   GST_OBJECT_LOCK (registry);
 755
 756   gst_registry_get_feature_list_or_create (registry,
 757       &registry->priv->element_factory_list, &registry->priv->efl_cookie,
 758       GST_TYPE_ELEMENT_FACTORY);
 759
 760   /* Return reffed copy */
 761   list = gst_plugin_feature_list_copy (registry->priv->element_factory_list);
 762
 763   GST_OBJECT_UNLOCK (registry);
 764
 765   return list;
 766 }
 767
 768 static GList *
 769 gst_registry_get_typefind_factory_list (GstRegistry * registry)
 770 {
 771   GList *list;
 772
 773   GST_OBJECT_LOCK (registry);
 774
 775   if (G_UNLIKELY (gst_registry_get_feature_list_or_create (registry,
 776               &registry->priv->typefind_factory_list,
 777               &registry->priv->tfl_cookie, GST_TYPE_TYPE_FIND_FACTORY)))
 778     registry->priv->typefind_factory_list =
 779         g_list_sort (registry->priv->typefind_factory_list,
 780         (GCompareFunc) type_find_factory_rank_cmp);
 781
 782   /* Return reffed copy */
 783   list = gst_plugin_feature_list_copy (registry->priv->typefind_factory_list);
 784
 785   GST_OBJECT_UNLOCK (registry);
 786
 787   return list;
 788 }
 789
 790
 791 static GList *
 792 gst_registry_get_device_provider_factory_list (GstRegistry * registry)
 793 {
 794   GList *list;
 795
 796   GST_OBJECT_LOCK (registry);
 797
 798   gst_registry_get_feature_list_or_create (registry,
 799       &registry->priv->device_provider_factory_list,
 800       &registry->priv->dmfl_cookie, GST_TYPE_DEVICE_PROVIDER_FACTORY);
 801
 802   /* Return reffed copy */
 803   list =
 804       gst_plugin_feature_list_copy (registry->
 805       priv->device_provider_factory_list);
 806
 807   GST_OBJECT_UNLOCK (registry);
 808
 809   return list;
 810 }
 811
 812 /**
 813  * gst_registry_feature_filter:
 814  * @registry: registry to query
 815  * @filter: (scope call): the filter to use
 816  * @first: only return first match
 817  * @user_data: (closure): user data passed to the filter function
 818  *
 819  * Runs a filter against all features of the plugins in the registry
 820  * and returns a GList with the results.
 821  * If the first flag is set, only the first match is
 822  * returned (as a list with a single object).
 823  *
 824  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
 825  *     #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
 826  *
 827  * MT safe.
 828  */
 829 GList *
 830 gst_registry_feature_filter (GstRegistry * registry,
 831     GstPluginFeatureFilter filter, gboolean first, gpointer user_data)
 832 {
 833   GList *list = NULL;
 834
 835   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 836
 837   GST_OBJECT_LOCK (registry);
 838   {
 839     const GList *walk;
 840
 841     for (walk = registry->priv->features; walk != NULL; walk = walk->next) {
 842       GstPluginFeature *feature = walk->data;
 843
 844       if (filter == NULL || filter (feature, user_data)) {
 845         list = g_list_prepend (list, gst_object_ref (feature));
 846
 847         if (first)
 848           break;
 849       }
 850     }
 851   }
 852   GST_OBJECT_UNLOCK (registry);
 853
 854   return list;
 855 }
 856
 857 static gboolean
 858 gst_registry_plugin_name_filter (GstPlugin * plugin, const gchar * name)
 859 {
 860   return (plugin->desc.name && !strcmp (plugin->desc.name, name));
 861 }
 862
 863 /**
 864  * gst_registry_find_plugin:
 865  * @registry: the registry to search
 866  * @name: the plugin name to find
 867  *
 868  * Find the plugin with the given name in the registry.
 869  * The plugin will be reffed; caller is responsible for unreffing.
 870  *
 871  * Returns: (transfer full) (nullable): the plugin with the given name
 872  *     or %NULL if the plugin was not found. gst_object_unref() after
 873  *     usage.
 874  *
 875  * MT safe.
 876  */
 877 GstPlugin *
 878 gst_registry_find_plugin (GstRegistry * registry, const gchar * name)
 879 {
 880   GList *walk;
 881   GstPlugin *result = NULL;
 882
 883   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 884   g_return_val_if_fail (name != NULL, NULL);
 885
 886   walk = gst_registry_plugin_filter (registry,
 887       (GstPluginFilter) gst_registry_plugin_name_filter, TRUE, (gpointer) name);
 888   if (walk) {
 889     result = GST_PLUGIN_CAST (walk->data);
 890
 891     gst_object_ref (result);
 892     gst_plugin_list_free (walk);
 893   }
 894
 895   return result;
 896 }
 897
 898 /**
 899  * gst_registry_find_feature:
 900  * @registry: the registry to search
 901  * @name: the pluginfeature name to find
 902  * @type: the pluginfeature type to find
 903  *
 904  * Find the pluginfeature with the given name and type in the registry.
 905  *
 906  * Returns: (transfer full) (nullable): the pluginfeature with the
 907  *     given name and type or %NULL if the plugin was not
 908  *     found. gst_object_unref() after usage.
 909  *
 910  * MT safe.
 911  */
 912 GstPluginFeature *
 913 gst_registry_find_feature (GstRegistry * registry, const gchar * name,
 914     GType type)
 915 {
 916   GstPluginFeature *feature = NULL;
 917
 918   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 919   g_return_val_if_fail (name != NULL, NULL);
 920   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
 921
 922   feature = gst_registry_lookup_feature (registry, name);
 923   if (feature && !g_type_is_a (G_TYPE_FROM_INSTANCE (feature), type)) {
 924     gst_object_unref (feature);
 925     feature = NULL;
 926   }
 927
 928   return feature;
 929 }
 930
 931 /**
 932  * gst_registry_get_feature_list:
 933  * @registry: a #GstRegistry
 934  * @type: a #GType.
 935  *
 936  * Retrieves a #GList of #GstPluginFeature of @type.
 937  *
 938  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
 939  *     #GstPluginFeature of @type. Use gst_plugin_feature_list_free() after use
 940  *
 941  * MT safe.
 942  */
 943 GList *
 944 gst_registry_get_feature_list (GstRegistry * registry, GType type)
 945 {
 946   GstTypeNameData data;
 947
 948   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 949   g_return_val_if_fail (g_type_is_a (type, GST_TYPE_PLUGIN_FEATURE), NULL);
 950
 951   /* Speed up */
 952   if (type == GST_TYPE_ELEMENT_FACTORY)
 953     return gst_registry_get_element_factory_list (registry);
 954   else if (type == GST_TYPE_TYPE_FIND_FACTORY)
 955     return gst_registry_get_typefind_factory_list (registry);
 956   else if (type == GST_TYPE_DEVICE_PROVIDER_FACTORY)
 957     return gst_registry_get_device_provider_factory_list (registry);
 958
 959   data.type = type;
 960   data.name = NULL;
 961
 962   return gst_registry_feature_filter (registry,
 963       (GstPluginFeatureFilter) gst_plugin_feature_type_name_filter,
 964       FALSE, &data);
 965 }
 966
 967 /**
 968  * gst_registry_get_plugin_list:
 969  * @registry: the registry to search
 970  *
 971  * Get a copy of all plugins registered in the given registry. The refcount
 972  * of each element in the list in incremented.
 973  *
 974  * Returns: (transfer full) (element-type Gst.Plugin): a #GList of #GstPlugin.
 975  *     Use gst_plugin_list_free() after usage.
 976  *
 977  * MT safe.
 978  */
 979 GList *
 980 gst_registry_get_plugin_list (GstRegistry * registry)
 981 {
 982   GList *list;
 983   GList *g;
 984
 985   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
 986
 987   GST_OBJECT_LOCK (registry);
 988   list = g_list_copy (registry->priv->plugins);
 989   for (g = list; g; g = g->next) {
 990     gst_object_ref (GST_PLUGIN_CAST (g->data));
 991   }
 992   GST_OBJECT_UNLOCK (registry);
 993
 994   return list;
 995 }
 996
 997 static GstPluginFeature *
 998 gst_registry_lookup_feature_locked (GstRegistry * registry, const char *name)
 999 {
1000   return g_hash_table_lookup (registry->priv->feature_hash, name);
1001 }
1002
1003 /**
1004  * gst_registry_lookup_feature:
1005  * @registry: a #GstRegistry
1006  * @name: a #GstPluginFeature name
1007  *
1008  * Find a #GstPluginFeature with @name in @registry.
1009  *
1010  * Returns: (transfer full): a #GstPluginFeature with its refcount incremented,
1011  *     use gst_object_unref() after usage.
1012  *
1013  * MT safe.
1014  */
1015 GstPluginFeature *
1016 gst_registry_lookup_feature (GstRegistry * registry, const char *name)
1017 {
1018   GstPluginFeature *feature;
1019
1020   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1021   g_return_val_if_fail (name != NULL, NULL);
1022
1023   GST_OBJECT_LOCK (registry);
1024   feature = gst_registry_lookup_feature_locked (registry, name);
1025   if (feature)
1026     gst_object_ref (feature);
1027   GST_OBJECT_UNLOCK (registry);
1028
1029   return feature;
1030 }
1031
1032 static GstPlugin *
1033 gst_registry_lookup_bn_locked (GstRegistry * registry, const char *basename)
1034 {
1035   return g_hash_table_lookup (registry->priv->basename_hash, basename);
1036 }
1037
1038 static GstPlugin *
1039 gst_registry_lookup_bn (GstRegistry * registry, const char *basename)
1040 {
1041   GstPlugin *plugin;
1042
1043   GST_OBJECT_LOCK (registry);
1044   plugin = gst_registry_lookup_bn_locked (registry, basename);
1045   if (plugin)
1046     gst_object_ref (plugin);
1047   GST_OBJECT_UNLOCK (registry);
1048
1049   return plugin;
1050 }
1051
1052 /**
1053  * gst_registry_lookup:
1054  * @registry: the registry to look up in
1055  * @filename: the name of the file to look up
1056  *
1057  * Look up a plugin in the given registry with the given filename.
1058  * If found, plugin is reffed.
1059  *
1060  * Returns: (transfer full) (nullable): the #GstPlugin if found, or
1061  *     %NULL if not.  gst_object_unref() after usage.
1062  */
1063 GstPlugin *
1064 gst_registry_lookup (GstRegistry * registry, const char *filename)
1065 {
1066   GstPlugin *plugin;
1067   gchar *basename;
1068
1069   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1070   g_return_val_if_fail (filename != NULL, NULL);
1071
1072   basename = g_path_get_basename (filename);
1073   if (G_UNLIKELY (basename == NULL))
1074     return NULL;
1075
1076   plugin = gst_registry_lookup_bn (registry, basename);
1077
1078   g_free (basename);
1079
1080   return plugin;
1081 }
1082
1083 typedef enum
1084 {
1085   REGISTRY_SCAN_HELPER_NOT_STARTED = 0,
1086   REGISTRY_SCAN_HELPER_DISABLED,
1087   REGISTRY_SCAN_HELPER_RUNNING
1088 } GstRegistryScanHelperState;
1089
1090 typedef struct
1091 {
1092   GstRegistry *registry;
1093   GstRegistryScanHelperState helper_state;
1094   GstPluginLoader *helper;
1095   gboolean changed;
1096 } GstRegistryScanContext;
1097
1098 static void
1099 init_scan_context (GstRegistryScanContext * context, GstRegistry * registry)
1100 {
1101   gboolean do_fork;
1102
1103   context->registry = registry;
1104
1105   /* see if forking is enabled and set up the scan helper state accordingly */
1106   do_fork = _gst_enable_registry_fork;
1107   if (do_fork) {
1108     const gchar *fork_env;
1109
1110     /* forking enabled, see if it is disabled with an env var */
1111     if ((fork_env = g_getenv ("GST_REGISTRY_FORK"))) {
1112       /* fork enabled for any value different from "no" */
1113       do_fork = strcmp (fork_env, "no") != 0;
1114     }
1115   }
1116
1117   if (do_fork)
1118     context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1119   else
1120     context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1121
1122   context->helper = NULL;
1123   context->changed = FALSE;
1124 }
1125
1126 static void
1127 clear_scan_context (GstRegistryScanContext * context)
1128 {
1129   if (context->helper) {
1130     context->changed |= _priv_gst_plugin_loader_funcs.destroy (context->helper);
1131     context->helper = NULL;
1132   }
1133 }
1134
1135 static gboolean
1136 gst_registry_scan_plugin_file (GstRegistryScanContext * context,
1137     const gchar * filename, off_t file_size, time_t file_mtime)
1138 {
1139   gboolean changed = FALSE;
1140   GstPlugin *newplugin = NULL;
1141
1142 #ifdef G_OS_WIN32
1143   /* Disable external plugin loader on Windows until it is ported properly. */
1144   context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1145 #endif
1146
1147
1148   /* Have a plugin to load - see if the scan-helper needs starting */
1149   if (context->helper_state == REGISTRY_SCAN_HELPER_NOT_STARTED) {
1150     GST_DEBUG ("Starting plugin scanner for file %s", filename);
1151     context->helper = _priv_gst_plugin_loader_funcs.create (context->registry);
1152     if (context->helper != NULL)
1153       context->helper_state = REGISTRY_SCAN_HELPER_RUNNING;
1154     else {
1155       GST_WARNING ("Failed starting plugin scanner. Scanning in-process");
1156       context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1157     }
1158   }
1159
1160   if (context->helper_state == REGISTRY_SCAN_HELPER_RUNNING) {
1161     GST_DEBUG ("Using scan-helper to load plugin %s", filename);
1162     if (!_priv_gst_plugin_loader_funcs.load (context->helper,
1163             filename, file_size, file_mtime)) {
1164       g_warning ("External plugin loader failed. This most likely means that "
1165           "the plugin loader helper binary was not found or could not be run. "
1166           "You might need to set the GST_PLUGIN_SCANNER environment variable "
1167           "if your setup is unusual. This should normally not be required "
1168           "though.");
1169       context->helper_state = REGISTRY_SCAN_HELPER_DISABLED;
1170     }
1171   }
1172
1173   /* Check if the helper is disabled (or just got disabled above) */
1174   if (context->helper_state == REGISTRY_SCAN_HELPER_DISABLED) {
1175     /* Load plugin the old fashioned way... */
1176
1177     /* We don't use a GError here because a failure to load some shared
1178      * objects as plugins is normal (particularly in the uninstalled case)
1179      */
1180     newplugin = gst_plugin_load_file (filename, NULL);
1181   }
1182
1183   if (newplugin) {
1184     GST_DEBUG_OBJECT (context->registry, "marking new plugin %p as registered",
1185         newplugin);
1186     newplugin->registered = TRUE;
1187     gst_object_unref (newplugin);
1188     changed = TRUE;
1189   }
1190 #ifndef GST_DISABLE_REGISTRY
1191   if (!__registry_reuse_plugin_scanner) {
1192     clear_scan_context (context);
1193     context->helper_state = REGISTRY_SCAN_HELPER_NOT_STARTED;
1194   }
1195 #endif
1196
1197   return changed;
1198 }
1199
1200 static gboolean
1201 is_blacklisted_hidden_directory (const gchar * dirent)
1202 {
1203   if (G_LIKELY (dirent[0] != '.'))
1204     return FALSE;
1205
1206   /* skip the .debug directory, these contain elf files that are not
1207    * useful or worse, can crash dlopen () */
1208   if (strcmp (dirent, ".debug") == 0)
1209     return TRUE;
1210
1211   /* can also skip .git and .deps dirs, those won't contain useful files.
1212    * This speeds up scanning a bit in uninstalled setups. */
1213   if (strcmp (dirent, ".git") == 0 || strcmp (dirent, ".deps") == 0)
1214     return TRUE;
1215
1216   return FALSE;
1217 }
1218
1219 static gboolean
1220 gst_registry_scan_path_level (GstRegistryScanContext * context,
1221     const gchar * path, int level)
1222 {
1223   GDir *dir;
1224   const gchar *dirent;
1225   gchar *filename;
1226   GstPlugin *plugin;
1227   gboolean changed = FALSE;
1228
1229   dir = g_dir_open (path, 0, NULL);
1230   if (!dir)
1231     return FALSE;
1232
1233   while ((dirent = g_dir_read_name (dir))) {
1234     GStatBuf file_status;
1235
1236     filename = g_build_filename (path, dirent, NULL);
1237     if (g_stat (filename, &file_status) < 0) {
1238       /* Plugin will be removed from cache after the scan completes if it
1239        * is still marked 'cached' */
1240       g_free (filename);
1241       continue;
1242     }
1243
1244     if (file_status.st_mode & S_IFDIR) {
1245       if (G_UNLIKELY (is_blacklisted_hidden_directory (dirent))) {
1246         GST_TRACE_OBJECT (context->registry, "ignoring %s directory", dirent);
1247         g_free (filename);
1248         continue;
1249       }
1250       /* FIXME 2.0: Don't recurse into directories, this behaviour
1251        * is inconsistent with other PATH environment variables
1252        */
1253       if (level > 0) {
1254         GST_LOG_OBJECT (context->registry, "recursing into directory %s",
1255             filename);
1256         changed |= gst_registry_scan_path_level (context, filename, level - 1);
1257       } else {
1258         GST_LOG_OBJECT (context->registry, "not recursing into directory %s, "
1259             "recursion level too deep", filename);
1260       }
1261       g_free (filename);
1262       continue;
1263     }
1264     if (!(file_status.st_mode & S_IFREG)) {
1265       GST_TRACE_OBJECT (context->registry, "%s is not a regular file, ignoring",
1266           filename);
1267       g_free (filename);
1268       continue;
1269     }
1270     if (!g_str_has_suffix (dirent, G_MODULE_SUFFIX)
1271 #ifdef GST_EXTRA_MODULE_SUFFIX
1272         && !g_str_has_suffix (dirent, GST_EXTRA_MODULE_SUFFIX)
1273 #endif
1274         ) {
1275       GST_TRACE_OBJECT (context->registry,
1276           "extension is not recognized as module file, ignoring file %s",
1277           filename);
1278       g_free (filename);
1279       continue;
1280     }
1281
1282     GST_LOG_OBJECT (context->registry, "file %s looks like a possible module",
1283         filename);
1284
1285     /* try to avoid unnecessary plugin-move pain */
1286     if (g_str_has_prefix (dirent, "libgstvalve") ||
1287         g_str_has_prefix (dirent, "libgstselector")) {
1288       GST_WARNING_OBJECT (context->registry, "ignoring old plugin %s which "
1289           "has been merged into the corelements plugin", filename);
1290       /* Plugin will be removed from cache after the scan completes if it
1291        * is still marked 'cached' */
1292       g_free (filename);
1293       continue;
1294     }
1295
1296     /* plug-ins are considered unique by basename; if the given name
1297      * was already seen by the registry, we ignore it */
1298     plugin = gst_registry_lookup_bn (context->registry, dirent);
1299     if (plugin) {
1300       gboolean env_vars_changed, deps_changed = FALSE;
1301
1302       if (plugin->registered) {
1303         GST_DEBUG_OBJECT (context->registry,
1304             "plugin already registered from path \"%s\"",
1305             GST_STR_NULL (plugin->filename));
1306         g_free (filename);
1307         gst_object_unref (plugin);
1308         continue;
1309       }
1310
1311       env_vars_changed = _priv_plugin_deps_env_vars_changed (plugin);
1312
1313       /* If a file with a certain basename is seen on a different path,
1314        * update the plugin to ensure the registry cache will reflect up
1315        * to date information */
1316
1317       if (plugin->file_mtime == file_status.st_mtime &&
1318           plugin->file_size == file_status.st_size && !env_vars_changed &&
1319           !(deps_changed = _priv_plugin_deps_files_changed (plugin)) &&
1320           !strcmp (plugin->filename, filename)) {
1321         GST_LOG_OBJECT (context->registry, "file %s cached", filename);
1322         GST_OBJECT_FLAG_UNSET (plugin, GST_PLUGIN_FLAG_CACHED);
1323         GST_LOG_OBJECT (context->registry,
1324             "marking plugin %p as registered as %s", plugin, filename);
1325         plugin->registered = TRUE;
1326       } else {
1327         GST_INFO_OBJECT (context->registry, "cached info for %s is stale",
1328             filename);
1329         GST_DEBUG_OBJECT (context->registry, "mtime %" G_GINT64_FORMAT " != %"
1330             G_GINT64_FORMAT " or size %" G_GINT64_FORMAT " != %"
1331             G_GINT64_FORMAT " or external dependency env_vars changed: %d or"
1332             " external dependencies changed: %d or old path %s != new path %s",
1333             (gint64) plugin->file_mtime, (gint64) file_status.st_mtime,
1334             (gint64) plugin->file_size, (gint64) file_status.st_size,
1335             env_vars_changed, deps_changed, plugin->filename, filename);
1336         gst_registry_remove_plugin (context->registry, plugin);
1337         changed |= gst_registry_scan_plugin_file (context, filename,
1338             file_status.st_size, file_status.st_mtime);
1339       }
1340       gst_object_unref (plugin);
1341
1342     } else {
1343       GST_DEBUG_OBJECT (context->registry, "file %s not yet in registry",
1344           filename);
1345       changed |= gst_registry_scan_plugin_file (context, filename,
1346           file_status.st_size, file_status.st_mtime);
1347     }
1348
1349     g_free (filename);
1350   }
1351
1352   g_dir_close (dir);
1353
1354   return changed;
1355 }
1356
1357 static gboolean
1358 gst_registry_scan_path_internal (GstRegistryScanContext * context,
1359     const gchar * path)
1360 {
1361   gboolean changed;
1362
1363   GST_DEBUG_OBJECT (context->registry, "scanning path %s", path);
1364   changed = gst_registry_scan_path_level (context, path, 10);
1365
1366   GST_DEBUG_OBJECT (context->registry, "registry changed in path %s: %d", path,
1367       changed);
1368   return changed;
1369 }
1370
1371 /**
1372  * gst_registry_scan_path:
1373  * @registry: the registry to add found plugins to
1374  * @path: the path to scan
1375  *
1376  * Scan the given path for plugins to add to the registry. The syntax of the
1377  * path is specific to the registry.
1378  *
1379  * Returns: %TRUE if registry changed
1380  */
1381 gboolean
1382 gst_registry_scan_path (GstRegistry * registry, const gchar * path)
1383 {
1384   GstRegistryScanContext context;
1385   gboolean result;
1386
1387   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1388   g_return_val_if_fail (path != NULL, FALSE);
1389
1390   init_scan_context (&context, registry);
1391
1392   result = gst_registry_scan_path_internal (&context, path);
1393
1394   clear_scan_context (&context);
1395   result |= context.changed;
1396
1397   return result;
1398 }
1399
1400 static gboolean
1401 _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
1402     gpointer user_data)
1403 {
1404   return (strcmp (feature->plugin_name, (gchar *) user_data) == 0);
1405 }
1406
1407 /**
1408  * gst_registry_get_feature_list_by_plugin:
1409  * @registry: a #GstRegistry.
1410  * @name: a plugin name.
1411  *
1412  * Retrieves a #GList of features of the plugin with name @name.
1413  *
1414  * Returns: (transfer full) (element-type Gst.PluginFeature): a #GList of
1415  *     #GstPluginFeature. Use gst_plugin_feature_list_free() after usage.
1416  */
1417 GList *
1418 gst_registry_get_feature_list_by_plugin (GstRegistry * registry,
1419     const gchar * name)
1420 {
1421   g_return_val_if_fail (GST_IS_REGISTRY (registry), NULL);
1422   g_return_val_if_fail (name != NULL, NULL);
1423
1424   return gst_registry_feature_filter (registry,
1425       _gst_plugin_feature_filter_plugin_name, FALSE, (gpointer) name);
1426 }
1427
1428 /* Unref and delete the default registry */
1429 void
1430 _priv_gst_registry_cleanup (void)
1431 {
1432   GstRegistry *registry;
1433
1434   g_mutex_lock (&_gst_registry_mutex);
1435   if ((registry = _gst_registry_default) != NULL) {
1436     _gst_registry_default = NULL;
1437   }
1438   g_mutex_unlock (&_gst_registry_mutex);
1439
1440   /* unref outside of the lock because we can. */
1441   if (registry)
1442     gst_object_unref (registry);
1443 }
1444
1445 /**
1446  * gst_registry_check_feature_version:
1447  * @registry: a #GstRegistry
1448  * @feature_name: the name of the feature (e.g. "oggdemux")
1449  * @min_major: the minimum major version number
1450  * @min_minor: the minimum minor version number
1451  * @min_micro: the minimum micro version number
1452  *
1453  * Checks whether a plugin feature by the given name exists in
1454  * @registry and whether its version is at least the
1455  * version required.
1456  *
1457  * Returns: %TRUE if the feature could be found and the version is
1458  * the same as the required version or newer, and %FALSE otherwise.
1459  */
1460 gboolean
1461 gst_registry_check_feature_version (GstRegistry * registry,
1462     const gchar * feature_name, guint min_major, guint min_minor,
1463     guint min_micro)
1464 {
1465   GstPluginFeature *feature;
1466   gboolean ret = FALSE;
1467
1468   g_return_val_if_fail (feature_name != NULL, FALSE);
1469
1470   GST_DEBUG ("Looking up plugin feature '%s'", feature_name);
1471
1472   feature = gst_registry_lookup_feature (registry, feature_name);
1473   if (feature) {
1474     ret = gst_plugin_feature_check_version (feature, min_major, min_minor,
1475         min_micro);
1476     gst_object_unref (feature);
1477   } else {
1478     GST_DEBUG ("Could not find plugin feature '%s'", feature_name);
1479   }
1480
1481   return ret;
1482 }
1483
1484 static void
1485 load_plugin_func (gpointer data, gpointer user_data)
1486 {
1487   GstPlugin *plugin;
1488   const gchar *filename;
1489   GError *err = NULL;
1490
1491   filename = (const gchar *) data;
1492   GST_DEBUG ("Pre-loading plugin %s", filename);
1493
1494   plugin = gst_plugin_load_file (filename, &err);
1495
1496   if (plugin) {
1497     GST_INFO ("Loaded plugin: \"%s\"", filename);
1498
1499     gst_registry_add_plugin (gst_registry_get (), plugin);
1500   } else {
1501     if (err) {
1502       /* Report error to user, and free error */
1503       GST_ERROR ("Failed to load plugin: %s", err->message);
1504       g_error_free (err);
1505     } else {
1506       GST_WARNING ("Failed to load plugin: \"%s\"", filename);
1507     }
1508   }
1509 }
1510
1511 #ifndef GST_DISABLE_REGISTRY
1512 /* Unref all plugins marked 'cached', to clear old plugins that no
1513  * longer exist. Returns %TRUE if any plugins were removed */
1514 static gboolean
1515 gst_registry_remove_cache_plugins (GstRegistry * registry)
1516 {
1517   GList *g;
1518   GList *g_next;
1519   GstPlugin *plugin;
1520   gboolean changed = FALSE;
1521
1522   g_return_val_if_fail (GST_IS_REGISTRY (registry), FALSE);
1523
1524   GST_OBJECT_LOCK (registry);
1525
1526   GST_DEBUG_OBJECT (registry, "removing cached plugins");
1527   g = registry->priv->plugins;
1528   while (g) {
1529     g_next = g->next;
1530     plugin = g->data;
1531     if (GST_OBJECT_FLAG_IS_SET (plugin, GST_PLUGIN_FLAG_CACHED)) {
1532       GST_DEBUG_OBJECT (registry, "removing cached plugin \"%s\"",
1533           GST_STR_NULL (plugin->filename));
1534       registry->priv->plugins = g_list_delete_link (registry->priv->plugins, g);
1535       if (G_LIKELY (plugin->basename))
1536         g_hash_table_remove (registry->priv->basename_hash, plugin->basename);
1537       gst_registry_remove_features_for_plugin_unlocked (registry, plugin);
1538       gst_object_unref (plugin);
1539       changed = TRUE;
1540     }
1541     g = g_next;
1542   }
1543
1544   GST_OBJECT_UNLOCK (registry);
1545
1546   return changed;
1547 }
1548
1549 typedef enum
1550 {
1551   REGISTRY_SCAN_AND_UPDATE_FAILURE = 0,
1552   REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED,
1553   REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED
1554 } GstRegistryScanAndUpdateResult;
1555
1556 /*
1557  * scan_and_update_registry:
1558  * @default_registry: the #GstRegistry
1559  * @registry_file: registry filename
1560  * @write_changes: write registry if it has changed?
1561  *
1562  * Scans for registry changes and eventually updates the registry cache.
1563  *
1564  * Return: %REGISTRY_SCAN_AND_UPDATE_FAILURE if the registry could not scanned
1565  *         or updated, %REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED if the
1566  *         registry is clean and %REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED if
1567  *         it has been updated and the cache needs to be re-read.
1568  */
1569 static GstRegistryScanAndUpdateResult
1570 scan_and_update_registry (GstRegistry * default_registry,
1571     const gchar * registry_file, gboolean write_changes, GError ** error)
1572 {
1573   const gchar *plugin_path;
1574   gboolean changed = FALSE;
1575   GList *l;
1576   GstRegistryScanContext context;
1577
1578   GST_INFO ("Validating plugins from registry cache: %s", registry_file);
1579
1580   init_scan_context (&context, default_registry);
1581
1582   /* It sounds tempting to just compare the mtime of directories with the mtime
1583    * of the registry cache, but it does not work. It would not catch updated
1584    * plugins, which might bring more or less features.
1585    */
1586
1587   /* scan paths specified via --gst-plugin-path */
1588   GST_DEBUG ("scanning paths added via --gst-plugin-path");
1589   for (l = _priv_gst_plugin_paths; l != NULL; l = l->next) {
1590     GST_INFO ("Scanning plugin path: \"%s\"", (gchar *) l->data);
1591     changed |= gst_registry_scan_path_internal (&context, (gchar *) l->data);
1592   }
1593   /* keep plugin_paths around in case a re-scan is forced later on */
1594
1595   /* GST_PLUGIN_PATH specifies a list of directories to scan for
1596    * additional plugins.  These take precedence over the system plugins */
1597   plugin_path = g_getenv ("GST_PLUGIN_PATH_1_0");
1598   if (plugin_path == NULL)
1599     plugin_path = g_getenv ("GST_PLUGIN_PATH");
1600   if (plugin_path) {
1601     char **list;
1602     int i;
1603
1604     GST_DEBUG ("GST_PLUGIN_PATH set to %s", plugin_path);
1605     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1606     for (i = 0; list[i]; i++) {
1607       changed |= gst_registry_scan_path_internal (&context, list[i]);
1608     }
1609     g_strfreev (list);
1610   } else {
1611     GST_DEBUG ("GST_PLUGIN_PATH not set");
1612   }
1613
1614   /* GST_PLUGIN_SYSTEM_PATH specifies a list of plugins that are always
1615    * loaded by default.  If not set, this defaults to the system-installed
1616    * path, and the plugins installed in the user's home directory */
1617   plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH_1_0");
1618   if (plugin_path == NULL)
1619     plugin_path = g_getenv ("GST_PLUGIN_SYSTEM_PATH");
1620   if (plugin_path == NULL) {
1621     char *home_plugins;
1622
1623     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH not set");
1624
1625     /* plugins in the user's home directory take precedence over
1626      * system-installed ones */
1627     home_plugins = g_build_filename (g_get_user_data_dir (),
1628         "gstreamer-" GST_API_VERSION, "plugins", NULL);
1629
1630     GST_DEBUG ("scanning home plugins %s", home_plugins);
1631     changed |= gst_registry_scan_path_internal (&context, home_plugins);
1632     g_free (home_plugins);
1633
1634     /* add the main (installed) library path */
1635
1636 #ifdef G_OS_WIN32
1637     {
1638       char *base_dir;
1639       char *dir;
1640
1641       base_dir =
1642           g_win32_get_package_installation_directory_of_module
1643           (_priv_gst_dll_handle);
1644
1645       dir = g_build_filename (base_dir,
1646 #ifdef _DEBUG
1647           "debug"
1648 #endif
1649           "lib", "gstreamer-" GST_API_VERSION, NULL);
1650       GST_DEBUG ("scanning DLL dir %s", dir);
1651
1652       changed |= gst_registry_scan_path_internal (&context, dir);
1653
1654       g_free (dir);
1655       g_free (base_dir);
1656     }
1657 #else
1658     GST_DEBUG ("scanning main plugins %s", PLUGINDIR);
1659     changed |= gst_registry_scan_path_internal (&context, PLUGINDIR);
1660 #endif
1661   } else {
1662     gchar **list;
1663     gint i;
1664
1665     GST_DEBUG ("GST_PLUGIN_SYSTEM_PATH set to %s", plugin_path);
1666     list = g_strsplit (plugin_path, G_SEARCHPATH_SEPARATOR_S, 0);
1667     for (i = 0; list[i]; i++) {
1668       changed |= gst_registry_scan_path_internal (&context, list[i]);
1669     }
1670     g_strfreev (list);
1671   }
1672
1673   clear_scan_context (&context);
1674   changed |= context.changed;
1675
1676   /* Remove cached plugins so stale info is cleared. */
1677   changed |= gst_registry_remove_cache_plugins (default_registry);
1678
1679   if (!changed) {
1680     GST_INFO ("Registry cache has not changed");
1681     return REGISTRY_SCAN_AND_UPDATE_SUCCESS_NOT_CHANGED;
1682   }
1683
1684   if (!write_changes) {
1685     GST_INFO ("Registry cache changed, but writing is disabled. Not writing.");
1686     return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1687   }
1688
1689   GST_INFO ("Registry cache changed. Writing new registry cache");
1690   if (!priv_gst_registry_binary_write_cache (default_registry,
1691           default_registry->priv->plugins, registry_file)) {
1692     g_set_error (error, GST_CORE_ERROR, GST_CORE_ERROR_FAILED,
1693         _("Error writing registry cache to %s: %s"),
1694         registry_file, g_strerror (errno));
1695     return REGISTRY_SCAN_AND_UPDATE_FAILURE;
1696   }
1697
1698   GST_INFO ("Registry cache written successfully");
1699   return REGISTRY_SCAN_AND_UPDATE_SUCCESS_UPDATED;
1700 }
1701
1702 static gboolean
1703 ensure_current_registry (GError ** error)
1704 {
1705   gchar *registry_file;
1706   GstRegistry *default_registry;
1707   gboolean ret = TRUE;
1708   gboolean do_update = TRUE;
1709   gboolean have_cache = TRUE;
1710
1711   default_registry = gst_registry_get ();
1712
1713   registry_file = g_strdup (g_getenv ("GST_REGISTRY_1_0"));
1714   if (registry_file == NULL)
1715     registry_file = g_strdup (g_getenv ("GST_REGISTRY"));
1716   if (registry_file == NULL) {
1717     registry_file = g_build_filename (g_get_user_cache_dir (),
1718         "gstreamer-" GST_API_VERSION, "registry." TARGET_CPU ".bin", NULL);
1719   }
1720
1721   if (!_gst_disable_registry_cache) {
1722     GST_INFO ("reading registry cache: %s", registry_file);
1723     have_cache = priv_gst_registry_binary_read_cache (default_registry,
1724         registry_file);
1725     /* Only ever read the registry cache once, then disable it for
1726      * subsequent updates during the program lifetime */
1727     _gst_disable_registry_cache = TRUE;
1728   }
1729
1730   if (have_cache) {
1731     do_update = !_priv_gst_disable_registry_update;
1732     if (do_update) {
1733       const gchar *update_env;
1734
1735       if ((update_env = g_getenv ("GST_REGISTRY_UPDATE"))) {
1736         /* do update for any value different from "no" */
1737         do_update = (strcmp (update_env, "no") != 0);
1738       }
1739     }
1740   }
1741
1742   if (do_update) {
1743     const gchar *reuse_env;
1744
1745     if ((reuse_env = g_getenv ("GST_REGISTRY_REUSE_PLUGIN_SCANNER"))) {
1746       /* do reuse for any value different from "no" */
1747       __registry_reuse_plugin_scanner = (strcmp (reuse_env, "no") != 0);
1748     }
1749     /* now check registry */
1750     GST_DEBUG ("Updating registry cache");
1751     scan_and_update_registry (default_registry, registry_file, TRUE, error);
1752   } else {
1753     GST_DEBUG ("Not updating registry cache (disabled)");
1754   }
1755
1756   g_free (registry_file);
1757   GST_INFO ("registry reading and updating done, result = %d", ret);
1758
1759   return ret;
1760 }
1761 #endif /* GST_DISABLE_REGISTRY */
1762
1763 /**
1764  * gst_registry_fork_is_enabled:
1765  *
1766  * By default GStreamer will perform scanning and rebuilding of the
1767  * registry file using a helper child process.
1768  *
1769  * Applications might want to disable this behaviour with the
1770  * gst_registry_fork_set_enabled() function, in which case new plugins
1771  * are scanned (and loaded) into the application process.
1772  *
1773  * Returns: %TRUE if GStreamer will use the child helper process when
1774  * rebuilding the registry.
1775  */
1776 gboolean
1777 gst_registry_fork_is_enabled (void)
1778 {
1779   return _gst_enable_registry_fork;
1780 }
1781
1782 /**
1783  * gst_registry_fork_set_enabled:
1784  * @enabled: whether rebuilding the registry can use a temporary child helper process.
1785  *
1786  * Applications might want to disable/enable spawning of a child helper process
1787  * when rebuilding the registry. See gst_registry_fork_is_enabled() for more
1788  * information.
1789  */
1790 void
1791 gst_registry_fork_set_enabled (gboolean enabled)
1792 {
1793   _gst_enable_registry_fork = enabled;
1794 }
1795
1796 /**
1797  * gst_update_registry:
1798  *
1799  * Forces GStreamer to re-scan its plugin paths and update the default
1800  * plugin registry.
1801  *
1802  * Applications will almost never need to call this function, it is only
1803  * useful if the application knows new plugins have been installed (or old
1804  * ones removed) since the start of the application (or, to be precise, the
1805  * first call to gst_init()) and the application wants to make use of any
1806  * newly-installed plugins without restarting the application.
1807  *
1808  * Applications should assume that the registry update is neither atomic nor
1809  * thread-safe and should therefore not have any dynamic pipelines running
1810  * (including the playbin and decodebin elements) and should also not create
1811  * any elements or access the GStreamer registry while the update is in
1812  * progress.
1813  *
1814  * Note that this function may block for a significant amount of time.
1815  *
1816  * Returns: %TRUE if the registry has been updated successfully (does not
1817  *          imply that there were changes), otherwise %FALSE.
1818  */
1819 gboolean
1820 gst_update_registry (void)
1821 {
1822   gboolean res;
1823
1824 #ifndef GST_DISABLE_REGISTRY
1825   GError *err = NULL;
1826
1827   res = ensure_current_registry (&err);
1828   if (err) {
1829     GST_WARNING ("registry update failed: %s", err->message);
1830     g_error_free (err);
1831   } else {
1832     GST_LOG ("registry update succeeded");
1833   }
1834
1835 #else
1836   GST_WARNING ("registry update failed: %s", "registry disabled");
1837   res = TRUE;
1838 #endif /* GST_DISABLE_REGISTRY */
1839
1840   if (_priv_gst_preload_plugins) {
1841     GST_DEBUG ("Preloading indicated plugins...");
1842     g_slist_foreach (_priv_gst_preload_plugins, load_plugin_func, NULL);
1843   }
1844
1845   return res;
1846 }
1847
1848 /**
1849  * gst_registry_get_feature_list_cookie:
1850  * @registry: the registry
1851  *
1852  * Returns the registry's feature list cookie. This changes
1853  * every time a feature is added or removed from the registry.
1854  *
1855  * Returns: the feature list cookie.
1856  */
1857 guint32
1858 gst_registry_get_feature_list_cookie (GstRegistry * registry)
1859 {
1860   g_return_val_if_fail (GST_IS_REGISTRY (registry), 0);
1861
1862   return registry->priv->cookie;
1863 }