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