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