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