subprojects/gstreamer/gst/gstpluginloader.c

   1 /* GStreamer
   2  * Copyright (C) 2008 Jan Schmidt <jan.schmidt@sun.com>
   3  *
   4  * gstpluginloader.c: GstPluginLoader helper for loading plugin files
   5  * out of process.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include <gst/gst_private.h>
  28
  29 #ifndef G_OS_WIN32
  30 #include <sys/types.h>
  31 #include <sys/wait.h>
  32 #include <sys/stat.h>
  33 #include <fcntl.h>
  34 #include <unistd.h>
  35 #else
  36 #define WIN32_LEAN_AND_MEAN
  37
  38 #define fsync(fd) _commit(fd)
  39 #include <io.h>
  40
  41 #include <windows.h>
  42 extern HMODULE _priv_gst_dll_handle;
  43 #endif
  44
  45 #ifdef HAVE_SYS_UTSNAME_H
  46 #include <sys/utsname.h>
  47 #endif
  48
  49 #include <errno.h>
  50
  51 #include <gst/gstconfig.h>
  52
  53 #include <gst/gstpoll.h>
  54 #include <gst/gstutils.h>
  55
  56 #include <gst/gstpluginloader.h>
  57 #include <gst/gstregistrychunks.h>
  58 #include <gst/gstregistrybinary.h>
  59
  60 /* IMPORTANT: Bump the version number if the plugin loader packet protocol
  61  * changes. Changes in the binary registry format itself are handled by
  62  * bumping the GST_MAGIC_BINARY_VERSION_STR
  63  */
  64 static const guint32 loader_protocol_version = 3;
  65
  66 #define GST_CAT_DEFAULT GST_CAT_PLUGIN_LOADING
  67
  68 static GstPluginLoader *plugin_loader_new (GstRegistry * registry);
  69 static gboolean plugin_loader_free (GstPluginLoader * loader);
  70 static gboolean plugin_loader_load (GstPluginLoader * loader,
  71     const gchar * filename, off_t file_size, time_t file_mtime);
  72
  73 /* functions used in GstRegistry scanning */
  74 const GstPluginLoaderFuncs _priv_gst_plugin_loader_funcs = {
  75   plugin_loader_new, plugin_loader_free, plugin_loader_load
  76 };
  77
  78 typedef struct _PendingPluginEntry
  79 {
  80   /* sequence number */
  81   guint32 tag;
  82   gchar *filename;
  83   off_t file_size;
  84   time_t file_mtime;
  85 } PendingPluginEntry;
  86
  87 struct _GstPluginLoader
  88 {
  89   GstRegistry *registry;
  90   GstPoll *fdset;
  91
  92   gboolean child_running;
  93   GPid child_pid;
  94   GstPollFD fd_w;
  95   GstPollFD fd_r;
  96
  97   gboolean is_child;
  98   gboolean got_plugin_details;
  99
 100   /* Transmit buffer */
 101   guint8 *tx_buf;
 102   guint tx_buf_size;
 103   guint tx_buf_write;
 104   guint tx_buf_read;
 105
 106   /* next sequence number (for PendingPluginEntry) */
 107   guint32 next_tag;
 108
 109   guint8 *rx_buf;
 110   guint rx_buf_size;
 111   gboolean rx_done;
 112   gboolean rx_got_sync;
 113
 114   /* Head and tail of the pending plugins list. List of
 115      PendingPluginEntry structs */
 116   GList *pending_plugins;
 117   GList *pending_plugins_tail;
 118 };
 119
 120 #define PACKET_EXIT 1
 121 #define PACKET_LOAD_PLUGIN 2
 122 #define PACKET_SYNC 3
 123 #define PACKET_PLUGIN_DETAILS 4
 124 #define PACKET_VERSION 5
 125
 126 #define BUF_INIT_SIZE 512
 127 #define BUF_GROW_EXTRA 512
 128 #define BUF_MAX_SIZE (32 * 1024 * 1024)
 129
 130 #define HEADER_SIZE 12
 131 /* 4 magic hex bytes to mark each packet */
 132 #define HEADER_MAGIC 0xbefec0ae
 133 #define ALIGNMENT   (sizeof (void *))
 134
 135 static gboolean gst_plugin_loader_spawn (GstPluginLoader * loader);
 136 static void put_packet (GstPluginLoader * loader, guint type, guint32 tag,
 137     const guint8 * payload, guint32 payload_len);
 138 static gboolean exchange_packets (GstPluginLoader * l);
 139 static gboolean plugin_loader_replay_pending (GstPluginLoader * l);
 140 static gboolean plugin_loader_load_and_sync (GstPluginLoader * l,
 141     PendingPluginEntry * entry);
 142 static void plugin_loader_create_blacklist_plugin (GstPluginLoader * l,
 143     PendingPluginEntry * entry);
 144 static void plugin_loader_cleanup_child (GstPluginLoader * loader);
 145 static gboolean plugin_loader_sync_with_child (GstPluginLoader * l);
 146
 147 static GstPluginLoader *
 148 plugin_loader_new (GstRegistry * registry)
 149 {
 150   GstPluginLoader *l = g_slice_new0 (GstPluginLoader);
 151
 152   if (registry)
 153     l->registry = gst_object_ref (registry);
 154   l->fdset = gst_poll_new (FALSE);
 155   gst_poll_fd_init (&l->fd_w);
 156   gst_poll_fd_init (&l->fd_r);
 157
 158   l->tx_buf_size = BUF_INIT_SIZE;
 159   l->tx_buf = g_malloc (BUF_INIT_SIZE);
 160
 161   l->next_tag = 0;
 162
 163   l->rx_buf_size = BUF_INIT_SIZE;
 164   l->rx_buf = g_malloc (BUF_INIT_SIZE);
 165
 166   return l;
 167 }
 168
 169 static gboolean
 170 plugin_loader_free (GstPluginLoader * loader)
 171 {
 172   GList *cur;
 173   gboolean got_plugin_details;
 174   gint fsync_ret;
 175
 176   do {
 177     fsync_ret = fsync (loader->fd_w.fd);
 178   } while (fsync_ret < 0 && errno == EINTR);
 179
 180   if (loader->child_running) {
 181     put_packet (loader, PACKET_EXIT, 0, NULL, 0);
 182
 183     /* Swap packets with the child until it exits cleanly */
 184     while (!loader->rx_done) {
 185       if (exchange_packets (loader) || loader->rx_done)
 186         continue;
 187
 188       if (!plugin_loader_replay_pending (loader))
 189         break;
 190       put_packet (loader, PACKET_EXIT, 0, NULL, 0);
 191     }
 192
 193     plugin_loader_cleanup_child (loader);
 194   } else {
 195     close (loader->fd_w.fd);
 196     close (loader->fd_r.fd);
 197   }
 198
 199   gst_poll_free (loader->fdset);
 200
 201   g_free (loader->rx_buf);
 202   g_free (loader->tx_buf);
 203
 204   if (loader->registry)
 205     gst_object_unref (loader->registry);
 206
 207   got_plugin_details = loader->got_plugin_details;
 208
 209   /* Free any pending plugin entries */
 210   cur = loader->pending_plugins;
 211   while (cur) {
 212     PendingPluginEntry *entry = (PendingPluginEntry *) (cur->data);
 213     g_free (entry->filename);
 214     g_slice_free (PendingPluginEntry, entry);
 215
 216     cur = g_list_delete_link (cur, cur);
 217   }
 218
 219   g_slice_free (GstPluginLoader, loader);
 220
 221   return got_plugin_details;
 222 }
 223
 224 static gboolean
 225 plugin_loader_load (GstPluginLoader * loader, const gchar * filename,
 226     off_t file_size, time_t file_mtime)
 227 {
 228   gint len;
 229   PendingPluginEntry *entry;
 230
 231   if (!gst_plugin_loader_spawn (loader))
 232     return FALSE;
 233
 234   /* Send a packet to the child requesting that it load the given file */
 235   GST_LOG_OBJECT (loader->registry,
 236       "Sending file %s to child. tag %u", filename, loader->next_tag);
 237
 238   entry = g_slice_new (PendingPluginEntry);
 239   entry->tag = loader->next_tag++;
 240   entry->filename = g_strdup (filename);
 241   entry->file_size = file_size;
 242   entry->file_mtime = file_mtime;
 243   loader->pending_plugins_tail =
 244       g_list_append (loader->pending_plugins_tail, entry);
 245
 246   if (loader->pending_plugins == NULL)
 247     loader->pending_plugins = loader->pending_plugins_tail;
 248   else
 249     loader->pending_plugins_tail = g_list_next (loader->pending_plugins_tail);
 250
 251   len = strlen (filename);
 252   put_packet (loader, PACKET_LOAD_PLUGIN, entry->tag,
 253       (guint8 *) filename, len + 1);
 254
 255   if (!exchange_packets (loader)) {
 256     if (!plugin_loader_replay_pending (loader))
 257       return FALSE;
 258   }
 259
 260   return TRUE;
 261 }
 262
 263 static gboolean
 264 plugin_loader_replay_pending (GstPluginLoader * l)
 265 {
 266   GList *cur, *next;
 267
 268 restart:
 269   if (!gst_plugin_loader_spawn (l))
 270     return FALSE;
 271
 272   /* Load each plugin one by one synchronously until we find the
 273    * crashing one */
 274   while ((cur = l->pending_plugins)) {
 275     PendingPluginEntry *entry = (PendingPluginEntry *) (cur->data);
 276
 277     if (!plugin_loader_load_and_sync (l, entry)) {
 278       /* Create dummy plugin entry to block re-scanning this file */
 279       GST_ERROR ("Plugin file %s failed to load. Blacklisting",
 280           entry->filename);
 281       plugin_loader_create_blacklist_plugin (l, entry);
 282       l->got_plugin_details = TRUE;
 283       /* Now remove this crashy plugin from the head of the list */
 284       l->pending_plugins = g_list_delete_link (cur, cur);
 285       g_free (entry->filename);
 286       g_slice_free (PendingPluginEntry, entry);
 287       if (l->pending_plugins == NULL)
 288         l->pending_plugins_tail = NULL;
 289       if (!gst_plugin_loader_spawn (l))
 290         return FALSE;
 291       break;
 292     }
 293   }
 294
 295   /* We exited after finding the crashing one. If there's any more pending,
 296    * dispatch them post-haste, but don't wait */
 297   for (cur = l->pending_plugins; cur != NULL; cur = next) {
 298     PendingPluginEntry *entry = (PendingPluginEntry *) (cur->data);
 299
 300     next = g_list_next (cur);
 301
 302     put_packet (l, PACKET_LOAD_PLUGIN, entry->tag,
 303         (guint8 *) entry->filename, strlen (entry->filename) + 1);
 304
 305     /* This might invalidate cur, which is why we grabbed 'next' above */
 306     if (!exchange_packets (l))
 307       goto restart;
 308   }
 309
 310   return TRUE;
 311 }
 312
 313 static gboolean
 314 plugin_loader_sync_with_child (GstPluginLoader * l)
 315 {
 316   put_packet (l, PACKET_SYNC, 0, NULL, 0);
 317
 318   l->rx_got_sync = FALSE;
 319   while (!l->rx_got_sync) {
 320     if (!exchange_packets (l))
 321       return FALSE;
 322   }
 323   return TRUE;
 324 }
 325
 326 static gboolean
 327 plugin_loader_load_and_sync (GstPluginLoader * l, PendingPluginEntry * entry)
 328 {
 329   gint len;
 330
 331   GST_DEBUG_OBJECT (l->registry, "Synchronously loading plugin file %s",
 332       entry->filename);
 333
 334   len = strlen (entry->filename);
 335   put_packet (l, PACKET_LOAD_PLUGIN, entry->tag,
 336       (guint8 *) entry->filename, len + 1);
 337
 338   return plugin_loader_sync_with_child (l);
 339 }
 340
 341 static void
 342 plugin_loader_create_blacklist_plugin (GstPluginLoader * l,
 343     PendingPluginEntry * entry)
 344 {
 345   GstPlugin *plugin = g_object_new (GST_TYPE_PLUGIN, NULL);
 346
 347   plugin->filename = g_strdup (entry->filename);
 348   plugin->file_mtime = entry->file_mtime;
 349   plugin->file_size = entry->file_size;
 350   GST_OBJECT_FLAG_SET (plugin, GST_PLUGIN_FLAG_BLACKLISTED);
 351
 352   plugin->basename = g_path_get_basename (plugin->filename);
 353   plugin->desc.name = g_intern_string (plugin->basename);
 354   plugin->desc.description = "Plugin for blacklisted file";
 355   plugin->desc.version = "0.0.0";
 356   plugin->desc.license = "BLACKLIST";
 357   plugin->desc.source = plugin->desc.license;
 358   plugin->desc.package = plugin->desc.license;
 359   plugin->desc.origin = plugin->desc.license;
 360
 361   GST_DEBUG ("Adding blacklist plugin '%s'", plugin->desc.name);
 362   gst_registry_add_plugin (l->registry, plugin);
 363 }
 364
 365 #ifdef __APPLE__
 366 #if defined(__x86_64__)
 367 #define USR_BIN_ARCH_SWITCH "-x86_64"
 368 #elif defined(__i386__)
 369 #define USR_BIN_ARCH_SWITCH "-i386"
 370 #elif defined(__ppc__)
 371 #define USR_BIN_ARCH_SWITCH "-ppc"
 372 #elif defined(__ppc64__)
 373 #define USR_BIN_ARCH_SWITCH "-ppc64"
 374 #endif
 375 #endif
 376
 377 #define YES_MULTIARCH 1
 378 #define NO_MULTIARCH  2
 379
 380 #if defined (__APPLE__) && defined (USR_BIN_ARCH_SWITCH)
 381 static gboolean
 382 gst_plugin_loader_use_usr_bin_arch (void)
 383 {
 384   static gsize multiarch = 0;
 385
 386   if (g_once_init_enter (&multiarch)) {
 387     gsize res = NO_MULTIARCH;
 388
 389 #ifdef HAVE_SYS_UTSNAME_H
 390     {
 391       struct utsname uname_data;
 392
 393       if (uname (&uname_data) == 0) {
 394         /* Check for OS X >= 10.5 (darwin kernel 9.0) */
 395         GST_LOG ("%s %s", uname_data.sysname, uname_data.release);
 396         if (g_ascii_strcasecmp (uname_data.sysname, "Darwin") == 0 &&
 397             g_strtod (uname_data.release, NULL) >= 9.0) {
 398           res = YES_MULTIARCH;
 399         }
 400       }
 401     }
 402 #endif
 403
 404     GST_INFO ("multiarch: %s", (res == YES_MULTIARCH) ? "yes" : "no");
 405     g_once_init_leave (&multiarch, res);
 406   }
 407   return (multiarch == YES_MULTIARCH);
 408 }
 409 #endif /* __APPLE__ && USR_BIN_ARCH_SWITCH */
 410
 411 static gboolean
 412 gst_plugin_loader_try_helper (GstPluginLoader * loader, gchar * location)
 413 {
 414   char *argv[6] = { NULL, };
 415   int c = 0;
 416
 417 #if defined (__APPLE__) && defined (USR_BIN_ARCH_SWITCH)
 418   if (gst_plugin_loader_use_usr_bin_arch ()) {
 419     argv[c++] = (char *) "/usr/bin/arch";
 420     argv[c++] = (char *) USR_BIN_ARCH_SWITCH;
 421   }
 422 #endif
 423   argv[c++] = location;
 424   argv[c++] = (char *) "-l";
 425   argv[c++] = _gst_executable_path;
 426   argv[c++] = NULL;
 427
 428   if (c > 4) {
 429     GST_LOG ("Trying to spawn gst-plugin-scanner helper at %s with arch %s",
 430         location, argv[1]);
 431   } else {
 432     GST_LOG ("Trying to spawn gst-plugin-scanner helper at %s", location);
 433   }
 434
 435   if (!g_spawn_async_with_pipes (NULL, argv, NULL,
 436           G_SPAWN_DO_NOT_REAP_CHILD /* | G_SPAWN_STDERR_TO_DEV_NULL */ ,
 437           NULL, NULL, &loader->child_pid, &loader->fd_w.fd, &loader->fd_r.fd,
 438           NULL, NULL))
 439     return FALSE;
 440
 441   gst_poll_add_fd (loader->fdset, &loader->fd_w);
 442   gst_poll_add_fd (loader->fdset, &loader->fd_r);
 443
 444   gst_poll_fd_ctl_read (loader->fdset, &loader->fd_r, TRUE);
 445
 446   loader->tx_buf_write = loader->tx_buf_read = 0;
 447
 448   put_packet (loader, PACKET_VERSION, 0, NULL, 0);
 449   if (!plugin_loader_sync_with_child (loader))
 450     return FALSE;
 451
 452   loader->child_running = TRUE;
 453
 454   return TRUE;
 455 }
 456
 457 static gboolean
 458 gst_plugin_loader_spawn (GstPluginLoader * loader)
 459 {
 460   const gchar *env;
 461   char *helper_bin;
 462   gboolean res = FALSE;
 463
 464   if (loader->child_running)
 465     return TRUE;
 466
 467   /* Find the gst-plugin-scanner */
 468   env = g_getenv ("GST_PLUGIN_SCANNER_1_0");
 469   if (env == NULL)
 470     env = g_getenv ("GST_PLUGIN_SCANNER");
 471
 472   if (env != NULL && *env != '\0') {
 473     /* use the env-var if it is set */
 474     GST_LOG ("Trying GST_PLUGIN_SCANNER env var: %s", env);
 475     helper_bin = g_strdup (env);
 476     res = gst_plugin_loader_try_helper (loader, helper_bin);
 477     g_free (helper_bin);
 478   } else {
 479     /* use the installed version */
 480     GST_LOG ("Trying installed plugin scanner");
 481
 482 #ifdef G_OS_WIN32
 483     {
 484       gchar *basedir;
 485
 486       basedir =
 487           g_win32_get_package_installation_directory_of_module
 488           (_priv_gst_dll_handle);
 489       helper_bin =
 490           g_build_filename (basedir, GST_PLUGIN_SCANNER_SUBDIR,
 491           "gstreamer-" GST_API_VERSION, "gst-plugin-scanner.exe", NULL);
 492       g_free (basedir);
 493     }
 494 #else
 495     helper_bin = g_strdup (GST_PLUGIN_SCANNER_INSTALLED);
 496 #endif
 497     res = gst_plugin_loader_try_helper (loader, helper_bin);
 498     g_free (helper_bin);
 499   }
 500
 501   if (!res) {
 502     GST_INFO ("No gst-plugin-scanner available, or not working");
 503   }
 504
 505   return loader->child_running;
 506 }
 507
 508 static void
 509 plugin_loader_cleanup_child (GstPluginLoader * l)
 510 {
 511   if (!l->child_running || l->is_child)
 512     return;
 513
 514   gst_poll_remove_fd (l->fdset, &l->fd_w);
 515   gst_poll_remove_fd (l->fdset, &l->fd_r);
 516
 517   close (l->fd_w.fd);
 518   close (l->fd_r.fd);
 519
 520 #ifndef G_OS_WIN32
 521   GST_LOG ("waiting for child process to exit");
 522   waitpid (l->child_pid, NULL, 0);
 523 #else
 524   g_warning ("FIXME: Implement child process shutdown for Win32");
 525 #endif
 526   g_spawn_close_pid (l->child_pid);
 527
 528   l->child_running = FALSE;
 529 }
 530
 531 gboolean
 532 _gst_plugin_loader_client_run (void)
 533 {
 534   gboolean res = TRUE;
 535   GstPluginLoader *l;
 536
 537   l = plugin_loader_new (NULL);
 538   if (l == NULL)
 539     return FALSE;
 540
 541   /* On entry, the inward pipe is STDIN, and outward is STDOUT.
 542    * Dup those somewhere better so that plugins printing things
 543    * won't interfere with anything */
 544 #ifndef G_OS_WIN32
 545   {
 546     int dup_fd;
 547
 548     dup_fd = dup (0);           /* STDIN */
 549     if (dup_fd == -1) {
 550       GST_ERROR ("Failed to start. Could not dup STDIN, errno %d", errno);
 551       res = FALSE;
 552       goto beach;
 553     }
 554     l->fd_r.fd = dup_fd;
 555     close (0);
 556
 557     dup_fd = dup (1);           /* STDOUT */
 558     if (dup_fd == -1) {
 559       GST_ERROR ("Failed to start. Could not dup STDOUT, errno %d", errno);
 560       res = FALSE;
 561       goto beach;
 562     }
 563     l->fd_w.fd = dup_fd;
 564     close (1);
 565
 566     /* Dup stderr down to stdout so things that plugins print are visible,
 567      * but don't care if it fails */
 568     dup2 (2, 1);
 569   }
 570 #else
 571   /* FIXME: Use DuplicateHandle and friends on win32 */
 572   l->fd_w.fd = 1;               /* STDOUT */
 573   l->fd_r.fd = 0;               /* STDIN */
 574 #endif
 575
 576   gst_poll_add_fd (l->fdset, &l->fd_w);
 577   gst_poll_add_fd (l->fdset, &l->fd_r);
 578   gst_poll_fd_ctl_read (l->fdset, &l->fd_r, TRUE);
 579
 580   l->is_child = TRUE;
 581
 582   GST_DEBUG ("Plugin scanner child running. Waiting for instructions");
 583
 584   /* Loop, listening for incoming packets on the fd and writing responses */
 585   while (!l->rx_done && exchange_packets (l));
 586
 587 #ifndef G_OS_WIN32
 588 beach:
 589 #endif
 590
 591   plugin_loader_free (l);
 592
 593   return res;
 594 }
 595
 596 static void
 597 put_packet (GstPluginLoader * l, guint type, guint32 tag,
 598     const guint8 * payload, guint32 payload_len)
 599 {
 600   guint8 *out;
 601   guint len = payload_len + HEADER_SIZE;
 602
 603   if (l->tx_buf_write + len >= l->tx_buf_size) {
 604     GST_LOG ("Expanding tx buf from %d to %d for packet of size %d",
 605         l->tx_buf_size, l->tx_buf_write + len + BUF_GROW_EXTRA, len);
 606     l->tx_buf_size = l->tx_buf_write + len + BUF_GROW_EXTRA;
 607     l->tx_buf = g_realloc (l->tx_buf, l->tx_buf_size);
 608   }
 609
 610   out = l->tx_buf + l->tx_buf_write;
 611
 612   /* one byte packet type */
 613   out[0] = type;
 614   /* 3 byte packet tag number */
 615   GST_WRITE_UINT24_BE (out + 1, tag);
 616   /* 4 bytes packet length */
 617   GST_WRITE_UINT32_BE (out + 4, payload_len);
 618   /* payload */
 619   if (payload && payload_len)
 620     memcpy (out + HEADER_SIZE, payload, payload_len);
 621   /* Write magic into the header */
 622   GST_WRITE_UINT32_BE (out + 8, HEADER_MAGIC);
 623
 624   l->tx_buf_write += len;
 625   gst_poll_fd_ctl_write (l->fdset, &l->fd_w, TRUE);
 626 }
 627
 628 static void
 629 put_chunk (GstPluginLoader * l, GstRegistryChunk * chunk, guint * pos)
 630 {
 631   guint padsize = 0;
 632   guint len;
 633   guint8 *out;
 634
 635   /* Might need to align the chunk */
 636   if (chunk->align && ((*pos) % ALIGNMENT) != 0)
 637     padsize = ALIGNMENT - ((*pos) % ALIGNMENT);
 638
 639   len = padsize + chunk->size;
 640
 641   if (G_UNLIKELY (l->tx_buf_write + len >= l->tx_buf_size)) {
 642     guint new_size = MAX (l->tx_buf_write + len,
 643         l->tx_buf_size + l->tx_buf_size / 4) + BUF_GROW_EXTRA;
 644     GST_LOG ("Expanding tx buf from %d to %d for chunk of size %d",
 645         l->tx_buf_size, new_size, chunk->size);
 646     l->tx_buf_size = new_size;
 647     l->tx_buf = g_realloc (l->tx_buf, l->tx_buf_size);
 648   }
 649
 650   out = l->tx_buf + l->tx_buf_write;
 651   /* Clear the padding */
 652   if (padsize)
 653     memset (out, 0, padsize);
 654   memcpy (out + padsize, chunk->data, chunk->size);
 655
 656   l->tx_buf_write += len;
 657   *pos += len;
 658
 659   gst_poll_fd_ctl_write (l->fdset, &l->fd_w, TRUE);
 660 };
 661
 662 static gboolean
 663 write_one (GstPluginLoader * l)
 664 {
 665   guint8 *out;
 666   guint32 to_write, magic;
 667   int res;
 668
 669   if (l->tx_buf_read + HEADER_SIZE > l->tx_buf_write)
 670     return FALSE;
 671
 672   out = l->tx_buf + l->tx_buf_read;
 673
 674   magic = GST_READ_UINT32_BE (out + 8);
 675   if (magic != HEADER_MAGIC) {
 676     GST_ERROR ("Packet magic number is missing. Memory corruption detected");
 677     goto fail_and_cleanup;
 678   }
 679
 680   to_write = GST_READ_UINT32_BE (out + 4) + HEADER_SIZE;
 681   /* Check that the magic is intact, and the size is sensible */
 682   if (to_write > l->tx_buf_size) {
 683     GST_ERROR ("Indicated packet size is too large. Corruption detected");
 684     goto fail_and_cleanup;
 685   }
 686
 687   l->tx_buf_read += to_write;
 688
 689   GST_LOG ("Writing packet of size %d bytes to fd %d", to_write, l->fd_w.fd);
 690
 691   do {
 692     res = write (l->fd_w.fd, out, to_write);
 693     if (G_UNLIKELY (res < 0)) {
 694       if (errno == EAGAIN || errno == EINTR)
 695         continue;
 696       /* Failed to write -> child died */
 697       goto fail_and_cleanup;
 698     }
 699     to_write -= res;
 700     out += res;
 701   } while (to_write > 0);
 702
 703   if (l->tx_buf_read == l->tx_buf_write) {
 704     gst_poll_fd_ctl_write (l->fdset, &l->fd_w, FALSE);
 705     l->tx_buf_read = l->tx_buf_write = 0;
 706   }
 707
 708   return TRUE;
 709
 710 fail_and_cleanup:
 711   plugin_loader_cleanup_child (l);
 712   return FALSE;
 713 }
 714
 715 static gboolean
 716 do_plugin_load (GstPluginLoader * l, const gchar * filename, guint tag)
 717 {
 718   GstPlugin *newplugin;
 719   GList *chunks = NULL;
 720
 721   GST_DEBUG ("Plugin scanner loading file %s. tag %u", filename, tag);
 722
 723 #if 0                           /* Test code - crash based on filename */
 724   if (strstr (filename, "coreelements") == NULL) {
 725     g_printerr ("Crashing on file %s\n", filename);
 726     g_printerr ("%d", *(gint *) (NULL));
 727   }
 728 #endif
 729
 730   newplugin = gst_plugin_load_file ((gchar *) filename, NULL);
 731   if (newplugin) {
 732     guint hdr_pos;
 733     guint offset;
 734
 735     /* Now serialise the plugin details and send */
 736     if (!_priv_gst_registry_chunks_save_plugin (&chunks,
 737             gst_registry_get (), newplugin))
 738       goto fail;
 739
 740     /* Store where the header is, write an empty one, then write
 741      * all the payload chunks, then fix up the header size */
 742     hdr_pos = l->tx_buf_write;
 743     offset = HEADER_SIZE;
 744     put_packet (l, PACKET_PLUGIN_DETAILS, tag, NULL, 0);
 745
 746     if (chunks) {
 747       GList *walk;
 748       for (walk = chunks; walk; walk = g_list_next (walk)) {
 749         GstRegistryChunk *cur = walk->data;
 750         put_chunk (l, cur, &offset);
 751
 752         _priv_gst_registry_chunk_free (cur);
 753       }
 754
 755       g_list_free (chunks);
 756
 757       /* Store the size of the written payload */
 758       GST_WRITE_UINT32_BE (l->tx_buf + hdr_pos + 4, offset - HEADER_SIZE);
 759     }
 760 #if 0                           /* Test code - corrupt the tx buffer based on filename */
 761     if (strstr (filename, "sink") != NULL) {
 762       int fd, res;
 763       g_printerr ("Corrupting tx buf on file %s\n", filename);
 764       fd = open ("/dev/urandom", O_RDONLY);
 765       res = read (fd, l->tx_buf, l->tx_buf_size);
 766       close (fd);
 767     }
 768 #endif
 769
 770     gst_object_unref (newplugin);
 771   } else {
 772     put_packet (l, PACKET_PLUGIN_DETAILS, tag, NULL, 0);
 773   }
 774
 775   return TRUE;
 776 fail:
 777   put_packet (l, PACKET_PLUGIN_DETAILS, tag, NULL, 0);
 778   if (chunks) {
 779     GList *walk;
 780     for (walk = chunks; walk; walk = g_list_next (walk)) {
 781       GstRegistryChunk *cur = walk->data;
 782
 783       _priv_gst_registry_chunk_free (cur);
 784     }
 785
 786     g_list_free (chunks);
 787   }
 788
 789   return FALSE;
 790 }
 791
 792 static gboolean
 793 check_protocol_version (GstPluginLoader * l, guint8 * payload,
 794     guint payload_len)
 795 {
 796   guint32 got_version;
 797   guint8 *binary_reg_ver;
 798
 799   if (payload_len < sizeof (guint32) + GST_MAGIC_BINARY_VERSION_LEN)
 800     return FALSE;
 801
 802   got_version = GST_READ_UINT32_BE (payload);
 803   GST_LOG ("Got VERSION %u from child. Ours is %u", got_version,
 804       loader_protocol_version);
 805   if (got_version != loader_protocol_version)
 806     return FALSE;
 807
 808   binary_reg_ver = payload + sizeof (guint32);
 809   if (strcmp ((gchar *) binary_reg_ver, GST_MAGIC_BINARY_VERSION_STR)) {
 810     GST_LOG ("Binary chunk format of child is different. Ours: %s, child %s\n",
 811         GST_MAGIC_BINARY_VERSION_STR, binary_reg_ver);
 812     return FALSE;
 813   }
 814
 815   return TRUE;
 816 };
 817
 818 static gboolean
 819 handle_rx_packet (GstPluginLoader * l,
 820     guint pack_type, guint32 tag, guint8 * payload, guint payload_len)
 821 {
 822   gboolean res = TRUE;
 823
 824   switch (pack_type) {
 825     case PACKET_EXIT:
 826       gst_poll_fd_ctl_read (l->fdset, &l->fd_r, FALSE);
 827       if (l->is_child) {
 828         /* Respond */
 829         put_packet (l, PACKET_EXIT, 0, NULL, 0);
 830       }
 831       l->rx_done = TRUE;
 832       return TRUE;
 833     case PACKET_LOAD_PLUGIN:{
 834       if (!l->is_child)
 835         return TRUE;
 836
 837       /* Payload is the filename to load */
 838       res = do_plugin_load (l, (gchar *) payload, tag);
 839
 840       break;
 841     }
 842     case PACKET_PLUGIN_DETAILS:{
 843       gchar *tmp = (gchar *) payload;
 844       PendingPluginEntry *entry = NULL;
 845       GList *cur;
 846
 847       GST_DEBUG_OBJECT (l->registry,
 848           "Received plugin details from child w/ tag %u. %d bytes info",
 849           tag, payload_len);
 850
 851       /* Assume that tagged details come back in the order
 852        * we requested, and delete anything before (but not
 853        * including) this one */
 854       cur = l->pending_plugins;
 855       while (cur) {
 856         PendingPluginEntry *e = (PendingPluginEntry *) (cur->data);
 857
 858         if (e->tag > tag)
 859           break;
 860
 861         if (e->tag == tag) {
 862           entry = e;
 863           break;
 864         } else {
 865           cur = g_list_delete_link (cur, cur);
 866           g_free (e->filename);
 867           g_slice_free (PendingPluginEntry, e);
 868         }
 869       }
 870
 871       l->pending_plugins = cur;
 872       if (cur == NULL)
 873         l->pending_plugins_tail = NULL;
 874
 875       if (payload_len > 0) {
 876         GstPlugin *newplugin = NULL;
 877         if (!_priv_gst_registry_chunks_load_plugin (l->registry, &tmp,
 878                 tmp + payload_len, &newplugin)) {
 879           /* Got garbage from the child, so fail and trigger replay of plugins */
 880           GST_ERROR_OBJECT (l->registry,
 881               "Problems loading plugin details with tag %u from scanner", tag);
 882           return FALSE;
 883         }
 884
 885         GST_OBJECT_FLAG_UNSET (newplugin, GST_PLUGIN_FLAG_CACHED);
 886         GST_LOG_OBJECT (l->registry,
 887             "marking plugin %p as registered as %s", newplugin,
 888             newplugin->filename);
 889         newplugin->registered = TRUE;
 890
 891         /* We got a set of plugin details - remember it for later */
 892         l->got_plugin_details = TRUE;
 893       } else if (entry != NULL) {
 894         /* Create a blacklist entry for this file to prevent scanning every time */
 895         plugin_loader_create_blacklist_plugin (l, entry);
 896         l->got_plugin_details = TRUE;
 897       }
 898
 899       if (entry != NULL) {
 900         g_free (entry->filename);
 901         g_slice_free (PendingPluginEntry, entry);
 902       }
 903
 904       /* Remove the plugin entry we just loaded */
 905       cur = l->pending_plugins;
 906       if (cur != NULL)
 907         cur = g_list_delete_link (cur, cur);
 908       l->pending_plugins = cur;
 909       if (cur == NULL)
 910         l->pending_plugins_tail = NULL;
 911
 912       break;
 913     }
 914     case PACKET_SYNC:
 915       if (l->is_child) {
 916         /* Respond with our reply - also a sync */
 917         put_packet (l, PACKET_SYNC, tag, NULL, 0);
 918         GST_LOG ("Got SYNC in child - replying");
 919       } else
 920         l->rx_got_sync = TRUE;
 921       break;
 922     case PACKET_VERSION:
 923       if (l->is_child) {
 924         /* Respond with our reply - a version packet, with the version */
 925         const gint version_len =
 926             sizeof (guint32) + GST_MAGIC_BINARY_VERSION_LEN;
 927         guint8 version_info[sizeof (guint32) + GST_MAGIC_BINARY_VERSION_LEN];
 928         memset (version_info, 0, version_len);
 929         GST_WRITE_UINT32_BE (version_info, loader_protocol_version);
 930         memcpy (version_info + sizeof (guint32), GST_MAGIC_BINARY_VERSION_STR,
 931             strlen (GST_MAGIC_BINARY_VERSION_STR));
 932         put_packet (l, PACKET_VERSION, tag, version_info, version_len);
 933         GST_LOG ("Got VERSION in child - replying %u", loader_protocol_version);
 934       } else {
 935         res = check_protocol_version (l, payload, payload_len);
 936       }
 937       break;
 938     default:
 939       return FALSE;             /* Invalid packet -> something is wrong */
 940   }
 941
 942   return res;
 943 }
 944
 945 static gboolean
 946 read_one (GstPluginLoader * l)
 947 {
 948   guint64 magic;
 949   guint32 to_read, packet_len, tag;
 950   guint8 *in;
 951   gint res;
 952
 953   to_read = HEADER_SIZE;
 954   in = l->rx_buf;
 955   do {
 956     res = read (l->fd_r.fd, in, to_read);
 957     if (G_UNLIKELY (res < 0)) {
 958       if (errno == EAGAIN || errno == EINTR)
 959         continue;
 960       GST_LOG ("Failed reading packet header");
 961       return FALSE;
 962     }
 963     to_read -= res;
 964     in += res;
 965   } while (to_read > 0);
 966
 967   magic = GST_READ_UINT32_BE (l->rx_buf + 8);
 968   if (magic != HEADER_MAGIC) {
 969     GST_WARNING
 970         ("Invalid packet (bad magic number) received from plugin scanner subprocess");
 971     return FALSE;
 972   }
 973
 974   packet_len = GST_READ_UINT32_BE (l->rx_buf + 4);
 975   if (packet_len + HEADER_SIZE > BUF_MAX_SIZE) {
 976     GST_WARNING
 977         ("Received excessively large packet for plugin scanner subprocess");
 978     return FALSE;
 979   }
 980   tag = GST_READ_UINT24_BE (l->rx_buf + 1);
 981
 982   if (packet_len > 0) {
 983     if (packet_len + HEADER_SIZE >= l->rx_buf_size) {
 984       GST_LOG ("Expanding rx buf from %d to %d",
 985           l->rx_buf_size, packet_len + HEADER_SIZE + BUF_GROW_EXTRA);
 986       l->rx_buf_size = packet_len + HEADER_SIZE + BUF_GROW_EXTRA;
 987       l->rx_buf = g_realloc (l->rx_buf, l->rx_buf_size);
 988     }
 989
 990     in = l->rx_buf + HEADER_SIZE;
 991     to_read = packet_len;
 992     do {
 993       res = read (l->fd_r.fd, in, to_read);
 994       if (G_UNLIKELY (res < 0)) {
 995         if (errno == EAGAIN || errno == EINTR)
 996           continue;
 997         GST_ERROR ("Packet payload read failed");
 998         return FALSE;
 999       }
1000       to_read -= res;
1001       in += res;
1002     } while (to_read > 0);
1003   } else {
1004     GST_LOG ("No payload to read for 0 length packet type %d tag %u",
1005         l->rx_buf[0], tag);
1006   }
1007
1008   return handle_rx_packet (l, l->rx_buf[0], tag,
1009       l->rx_buf + HEADER_SIZE, packet_len);
1010 }
1011
1012 static gboolean
1013 exchange_packets (GstPluginLoader * l)
1014 {
1015   gint res;
1016
1017   /* Wait for activity on our FDs */
1018   do {
1019     do {
1020       res = gst_poll_wait (l->fdset, GST_SECOND);
1021     } while (res == -1 && (errno == EINTR || errno == EAGAIN));
1022
1023     if (res < 0)
1024       return FALSE;
1025
1026     GST_LOG ("Poll res = %d. %d bytes pending for write", res,
1027         l->tx_buf_write - l->tx_buf_read);
1028
1029     if (!l->rx_done) {
1030       if (gst_poll_fd_has_error (l->fdset, &l->fd_r)) {
1031         GST_LOG ("read fd %d errored", l->fd_r.fd);
1032         goto fail_and_cleanup;
1033       }
1034
1035       if (gst_poll_fd_can_read (l->fdset, &l->fd_r)) {
1036         if (!read_one (l))
1037           goto fail_and_cleanup;
1038       } else if (gst_poll_fd_has_closed (l->fdset, &l->fd_r)) {
1039         GST_LOG ("read fd %d closed", l->fd_r.fd);
1040         goto fail_and_cleanup;
1041       }
1042     }
1043
1044     if (l->tx_buf_read < l->tx_buf_write) {
1045       if (gst_poll_fd_has_error (l->fdset, &l->fd_w)) {
1046         GST_ERROR ("write fd %d errored", l->fd_w.fd);
1047         goto fail_and_cleanup;
1048       }
1049       if (gst_poll_fd_can_write (l->fdset, &l->fd_w)) {
1050         if (!write_one (l))
1051           goto fail_and_cleanup;
1052       } else if (gst_poll_fd_has_closed (l->fdset, &l->fd_w)) {
1053         GST_LOG ("write fd %d closed", l->fd_w.fd);
1054         goto fail_and_cleanup;
1055       }
1056     }
1057   } while (l->tx_buf_read < l->tx_buf_write);
1058
1059   return TRUE;
1060 fail_and_cleanup:
1061   plugin_loader_cleanup_child (l);
1062   return FALSE;
1063 }