1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2007 the VideoLAN team
7 * Authors: Sam Hocevar <sam@zoy.org>
8 * Ethan C. Baldridge <BaldridgeE@cadmus.com>
9 * Hans-Peter Jansen <hpj@urpla.net>
10 * Gildas Bazin <gbazin@videolan.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_memory.h>
36 #include <stdlib.h> /* free(), strtol() */
37 #include <stdio.h> /* sprintf() */
38 #include <string.h> /* strdup() */
45 #include <sys/types.h>
46 #ifdef HAVE_SYS_STAT_H
47 # include <sys/stat.h>
53 #if !defined(HAVE_DYNAMIC_PLUGINS)
54 /* no support for plugins */
55 #elif defined(HAVE_DL_DYLD)
56 # if defined(HAVE_MACH_O_DYLD_H)
57 # include <mach-o/dyld.h>
59 #elif defined(HAVE_DL_BEOS)
60 # if defined(HAVE_IMAGE_H)
63 #elif defined(HAVE_DL_WINDOWS)
65 #elif defined(HAVE_DL_DLOPEN)
66 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
69 # if defined(HAVE_SYS_DL_H)
72 #elif defined(HAVE_DL_SHL_LOAD)
73 # if defined(HAVE_DL_H)
78 #include "config/configuration.h"
80 #include "vlc_charset.h"
81 #include "vlc_arrays.h"
83 #include "modules/modules.h"
85 static module_bank_t *p_module_bank = NULL;
86 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
88 int vlc_entry__main( module_t * );
90 /*****************************************************************************
92 *****************************************************************************/
93 #ifdef HAVE_DYNAMIC_PLUGINS
94 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
95 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
97 static int AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
99 static module_t * AllocatePlugin( vlc_object_t *, const char * );
101 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
102 static void DeleteModule ( module_bank_t *, module_t * );
103 #ifdef HAVE_DYNAMIC_PLUGINS
104 static void DupModule ( module_t * );
105 static void UndupModule ( module_t * );
111 * Creates a module bank structure which will be filled later
112 * on with all the modules found.
113 * \param p_this vlc object structure
116 void __module_InitBank( vlc_object_t *p_this )
118 module_bank_t *p_bank = NULL;
120 vlc_mutex_lock( &module_lock );
122 if( p_module_bank == NULL )
124 p_bank = calloc (1, sizeof(*p_bank));
126 p_bank->i_cache = p_bank->i_loaded_cache = 0;
127 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
128 p_bank->b_cache = p_bank->b_cache_dirty = false;
131 /* Everything worked, attach the object */
132 p_module_bank = p_bank;
134 /* Fills the module bank structure with the main module infos.
135 * This is very useful as it will allow us to consider the main
136 * library just as another module, and for instance the configuration
137 * options of main will be available in the module bank structure just
138 * as for every other module. */
139 AllocateBuiltinModule( p_this, vlc_entry__main );
140 vlc_rwlock_init (&config_lock);
143 p_module_bank->i_usage++;
145 /* We do retain the module bank lock until the plugins are loaded as well.
146 * This is ugly, this staged loading approach is needed: LibVLC gets
147 * some configuration parameters relevant to loading the plugins from
148 * the main (builtin) module. The module bank becomes shared read-only data
149 * once it is ready, so we need to fully serialize initialization.
150 * DO NOT UNCOMMENT the following line unless you managed to squeeze
151 * module_LoadPlugins() before you unlock the mutex. */
152 /*vlc_mutex_unlock( &module_lock );*/
155 #undef module_EndBank
157 * Unloads all unused plugin modules and empties the module
158 * bank in case of success.
159 * \param p_this vlc object structure
162 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
164 module_bank_t *p_bank = p_module_bank;
166 assert (p_bank != NULL);
168 /* Save the configuration */
169 if( !var_InheritBool( p_this, "ignore-config" ) )
170 config_AutoSaveConfigFile( p_this );
172 /* If plugins were _not_ loaded, then the caller still has the bank lock
173 * from module_InitBank(). */
175 vlc_mutex_lock( &module_lock );
177 vlc_assert_locked( &module_lock ); not for static mutexes :( */
179 if( --p_bank->i_usage > 0 )
181 vlc_mutex_unlock( &module_lock );
184 vlc_rwlock_destroy (&config_lock);
185 p_module_bank = NULL;
186 vlc_mutex_unlock( &module_lock );
188 #ifdef HAVE_DYNAMIC_PLUGINS
189 if( p_bank->b_cache )
190 CacheSave( p_this, p_bank );
191 while( p_bank->i_loaded_cache-- )
193 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
195 DeleteModule( p_bank,
196 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
197 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
198 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
201 free( p_bank->pp_loaded_cache );
202 while( p_bank->i_cache-- )
204 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
205 free( p_bank->pp_cache[p_bank->i_cache] );
207 free( p_bank->pp_cache );
210 while( p_bank->head != NULL )
211 DeleteModule( p_bank, p_bank->head );
216 #undef module_LoadPlugins
218 * Loads module descriptions for all available plugins.
219 * Fills the module bank structure with the plugin modules.
221 * \param p_this vlc object structure
224 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
226 module_bank_t *p_bank = p_module_bank;
229 /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
231 #ifdef HAVE_DYNAMIC_PLUGINS
232 if( p_bank->i_usage == 1 )
234 msg_Dbg( p_this, "checking plugin modules" );
235 p_module_bank->b_cache = var_InheritBool( p_this, "plugins-cache" );
237 if( p_module_bank->b_cache || b_cache_delete )
238 CacheLoad( p_this, p_module_bank, b_cache_delete );
239 AllocateAllPlugins( p_this, p_module_bank );
242 vlc_mutex_unlock( &module_lock );
246 * Checks whether a module implements a capability.
248 * \param m the module
249 * \param cap the capability to check
250 * \return TRUE if the module have the capability
252 bool module_provides( const module_t *m, const char *cap )
254 return !strcmp( m->psz_capability, cap );
258 * Get the internal name of a module
260 * \param m the module
261 * \return the module name
263 const char *module_get_object( const module_t *m )
265 return m->psz_object_name;
269 * Get the human-friendly name of a module.
271 * \param m the module
272 * \param long_name TRUE to have the long name of the module
273 * \return the short or long name of the module
275 const char *module_get_name( const module_t *m, bool long_name )
277 if( long_name && ( m->psz_longname != NULL) )
278 return m->psz_longname;
280 return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
284 * Get the help for a module
286 * \param m the module
289 const char *module_get_help( const module_t *m )
295 * Get the capability for a module
297 * \param m the module
298 * return the capability
300 const char *module_get_capability( const module_t *m )
302 return m->psz_capability;
306 * Get the score for a module
308 * \param m the module
309 * return the score for the capability
311 int module_get_score( const module_t *m )
316 module_t *module_hold (module_t *m)
318 vlc_hold (&m->vlc_gc_data);
322 void module_release (module_t *m)
324 vlc_release (&m->vlc_gc_data);
328 * Frees the flat list of VLC modules.
329 * @param list list obtained by module_list_get()
330 * @param length number of items on the list
333 void module_list_free (module_t **list)
338 for (size_t i = 0; list[i] != NULL; i++)
339 module_release (list[i]);
344 * Gets the flat list of VLC modules.
345 * @param n [OUT] pointer to the number of modules or NULL
346 * @return NULL-terminated table of module pointers
347 * (release with module_list_free()), or NULL in case of error.
349 module_t **module_list_get (size_t *n)
351 /* TODO: this whole module lookup is quite inefficient */
352 /* Remove this and improve module_need */
353 module_t **tab = NULL;
356 assert (p_module_bank);
357 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
360 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
363 module_list_free (tab);
368 tab[i++] = module_hold (mod);
369 for (module_t *subm = mod->submodule; subm; subm = subm->next)
370 tab[i++] = module_hold (subm);
378 typedef struct module_list_t
385 static int modulecmp (const void *a, const void *b)
387 const module_list_t *la = a, *lb = b;
388 /* Note that qsort() uses _ascending_ order,
389 * so the smallest module is the one with the biggest score. */
390 return lb->i_score - la->i_score;
396 * Return the best module function, given a capability list.
398 * \param p_this the vlc object
399 * \param psz_capability list of capabilities needed
400 * \param psz_name name of the module asked
401 * \param b_strict if true, do not fallback to plugin with a different name
402 * but the same capability
403 * \return the module or NULL in case of a failure
405 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
406 const char *psz_name, bool b_strict )
408 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
410 module_list_t *p_list;
413 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
414 bool b_force_backup = p_this->b_force;
416 /* Deal with variables */
417 if( psz_name && psz_name[0] == '$' )
419 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
422 /* Count how many different shortcuts were asked for */
423 if( psz_name && *psz_name )
425 char *psz_parser, *psz_last_shortcut;
427 /* If the user wants none, give him none. */
428 if( !strcmp( psz_name, "none" ) )
431 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
432 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
433 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
438 psz_parser = psz_shortcuts = psz_last_shortcut = strdup( psz_name );
440 while( ( psz_parser = strchr( psz_parser, ',' ) ) )
444 psz_last_shortcut = ++psz_parser;
447 /* Check if the user wants to override the "strict" mode */
448 if( psz_last_shortcut )
450 if( !strcmp(psz_last_shortcut, "none") )
455 else if( !strcmp(psz_last_shortcut, "any") )
463 /* Sort the modules and test them */
465 module_t **p_all = module_list_get (&count);
466 p_list = malloc( count * sizeof( module_list_t ) );
468 /* Parse the module list for capabilities and probe each of them */
470 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
472 int i_shortcut_bonus = 0;
474 /* Test that this module can do what we need */
475 if( !module_provides( p_module, psz_capability ) )
478 /* If we required a shortcut, check this plugin provides it. */
479 if( i_shortcuts > 0 )
481 const char *name = psz_shortcuts;
483 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
485 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
488 if( ( c = strchr( name, '@' ) )
489 ? !strncasecmp( name, p_module->pp_shortcuts[i],
491 : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
496 i_shortcut_bonus = i_short * 10000;
501 /* Go to the next shortcut... This is so lame! */
502 name += strlen( name ) + 1;
505 /* If we are in "strict" mode and we couldn't
506 * find the module in the list of provided shortcuts,
507 * then kick the bastard out of here!!! */
512 /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
513 if( p_module->i_score <= 0 )
517 /* Store this new module */
518 p_list[count].p_module = module_hold (p_module);
519 p_list[count].i_score = p_module->i_score + i_shortcut_bonus;
520 p_list[count].b_force = i_shortcut_bonus && b_strict;
524 /* We can release the list, interesting modules are held */
525 module_list_free (p_all);
527 /* Sort candidates by descending score */
528 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
529 msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
530 count, count == 1 ? "" : "s" );
532 /* Parse the linked list and use the first successful module */
534 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
536 module_t *p_cand = p_list[i].p_module;
537 #ifdef HAVE_DYNAMIC_PLUGINS
538 /* Make sure the module is loaded in mem */
539 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
541 if( !p_real->b_builtin && !p_real->b_loaded )
543 module_t *p_new_module =
544 AllocatePlugin( p_this, p_real->psz_filename );
545 if( p_new_module == NULL )
546 { /* Corrupted module */
547 msg_Err( p_this, "possibly corrupt module cache" );
548 module_release( p_cand );
551 CacheMerge( p_this, p_real, p_new_module );
552 DeleteModule( p_module_bank, p_new_module );
556 p_this->b_force = p_list[i].b_force;
558 int ret = VLC_SUCCESS;
559 if( p_cand->pf_activate )
560 ret = p_cand->pf_activate( p_this );
569 /* good module, but aborted */
570 module_release( p_cand );
573 default: /* bad module */
574 module_release( p_cand );
578 /* Release the remaining modules */
580 module_release (p_list[i].p_module);
584 p_this->b_force = b_force_backup;
586 if( p_module != NULL )
588 msg_Dbg( p_this, "using %s module \"%s\"",
589 psz_capability, p_module->psz_object_name );
590 vlc_object_set_name( p_this, psz_alias ? psz_alias
591 : p_module->psz_object_name );
593 else if( count == 0 )
595 if( !strcmp( psz_capability, "access_demux" )
596 || !strcmp( psz_capability, "stream_filter" )
597 || !strcmp( psz_capability, "vout_window" ) )
599 msg_Dbg( p_this, "no %s module matched \"%s\"",
600 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
604 msg_Err( p_this, "no %s module matched \"%s\"",
605 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
607 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
608 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
611 else if( psz_name != NULL && *psz_name )
613 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
614 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
617 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
619 free( psz_shortcuts );
622 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
623 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
624 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
626 /* Don't forget that the module is still locked */
633 * This function must be called by the thread that called module_need, to
634 * decrease the reference count and allow for hiding of modules.
635 * \param p_this vlc object structure
636 * \param p_module the module structure
639 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
641 /* Use the close method */
642 if( p_module->pf_deactivate )
644 p_module->pf_deactivate( p_this );
647 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
649 module_release( p_module );
653 * Get a pointer to a module_t given it's name.
655 * \param psz_name the name of the module
656 * \return a pointer to the module or NULL in case of a failure
658 module_t *module_find( const char * psz_name )
660 module_t **list, *module;
662 list = module_list_get (NULL);
666 for (size_t i = 0; (module = list[i]) != NULL; i++)
668 const char *psz_module_name = module->psz_object_name;
670 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
672 module_hold (module);
676 module_list_free (list);
681 * Tell if a module exists and release it in thic case
683 * \param psz_name th name of the module
684 * \return TRUE if the module exists
686 bool module_exists (const char * psz_name)
688 module_t *p_module = module_find (psz_name);
690 module_release (p_module);
691 return p_module != NULL;
695 * Get a pointer to a module_t that matches a shortcut.
696 * This is a temporary hack for SD. Do not re-use (generally multiple modules
697 * can have the same shortcut, so this is *broken* - use module_need()!).
699 * \param psz_shortcut shortcut of the module
700 * \param psz_cap capability of the module
701 * \return a pointer to the module or NULL in case of a failure
703 module_t *module_find_by_shortcut (const char *psz_shortcut)
705 module_t **list, *module;
707 list = module_list_get (NULL);
711 for (size_t i = 0; (module = list[i]) != NULL; i++)
714 (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
717 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
719 module_hold (module);
725 module_list_free (list);
730 * Get the configuration of a module
732 * \param module the module
733 * \param psize the size of the configuration returned
734 * \return the configuration as an array
736 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
739 unsigned size = module->confsize;
740 module_config_t *config = malloc( size * sizeof( *config ) );
742 assert( psize != NULL );
748 for( i = 0, j = 0; i < size; i++ )
750 const module_config_t *item = module->p_config + i;
751 if( item->b_internal /* internal option */
752 || item->b_unsaveable /* non-modifiable option */
753 || item->b_removed /* removed option */ )
756 memcpy( config + j, item, sizeof( *config ) );
765 * Release the configuration
767 * \param the configuration
770 void module_config_free( module_config_t *config )
775 /*****************************************************************************
776 * Following functions are local.
777 *****************************************************************************/
779 /*****************************************************************************
780 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
782 *****************************************************************************/
783 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
787 bool escaped = false;
791 /* Alloc a buffer to store the path */
792 path = malloc( strlen( paths ) + 1 );
793 if( !path ) return NULL;
795 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
796 for( i = 0, done = 0 ; paths[i]; i++ )
798 /* Take care of \\ and \: or \; escapement */
802 path[done++] = paths[i];
805 else if( paths[i] == '/' )
808 else if( paths[i] == '\\' )
811 else if( paths[i] == PATH_SEP_CHAR )
814 path[done++] = paths[i];
818 /* Return the remaining paths */
819 if( remaining_paths ) {
820 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
826 char *psz_vlcpath = NULL;
828 /*****************************************************************************
829 * AllocateAllPlugins: load all plugin modules we can find.
830 *****************************************************************************/
831 #ifdef HAVE_DYNAMIC_PLUGINS
832 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
834 const char *vlcpath = psz_vlcpath;
837 vlc_array_t *arraypaths = vlc_array_new();
839 /* Contruct the special search path for system that have a relocatable
840 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
842 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
843 vlc_array_append( arraypaths, path );
844 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
845 vlc_array_append( arraypaths, path );
847 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
850 /* If the user provided a plugin path, we add it to the list */
851 char *userpaths = var_InheritString( p_this, "plugin-path" );
854 for( paths_iter = userpaths; paths_iter; )
856 path = copy_next_paths_token( paths_iter, &paths_iter );
858 vlc_array_append( arraypaths, path );
861 count = vlc_array_count( arraypaths );
862 for( i = 0 ; i < count ; i++ )
864 path = vlc_array_item_at_index( arraypaths, i );
868 msg_Dbg( p_this, "recursively browsing `%s'", path );
870 /* Don't go deeper than 5 subdirectories */
871 AllocatePluginDir( p_this, p_bank, path, 5 );
876 vlc_array_destroy( arraypaths );
880 /*****************************************************************************
881 * AllocatePluginDir: recursively parse a directory to look for plugins
882 *****************************************************************************/
883 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
884 const char *psz_dir, unsigned i_maxdepth )
886 if( i_maxdepth == 0 )
889 DIR *dh = utf8_opendir (psz_dir);
893 /* Parse the directory and try to load all files it contains. */
896 char *file = utf8_readdir (dh), *path;
903 if (!strcmp (file, ".") || !strcmp (file, "..")
904 /* Skip directories for unsupported optimizations */
905 || !vlc_CPU_CheckPluginDir (file))
911 const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
913 if (pathlen == -1 || utf8_stat (path, &st))
916 if (S_ISDIR (st.st_mode))
917 /* Recurse into another directory */
918 AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
920 if (S_ISREG (st.st_mode)
921 && ((size_t)pathlen >= strlen (LIBEXT))
922 && !strncasecmp (path + pathlen - strlen (LIBEXT), LIBEXT,
924 /* ^^ We only load files ending with LIBEXT */
925 AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
932 /*****************************************************************************
933 * AllocatePluginFile: load a module into memory and initialize it.
934 *****************************************************************************
935 * This function loads a dynamically loadable module and allocates a structure
936 * for its information data. The module can then be handled by module_need
937 * and module_unneed. It can be removed by DeleteModule.
938 *****************************************************************************/
939 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
940 const char *psz_file,
941 int64_t i_file_time, int64_t i_file_size )
943 module_t * p_module = NULL;
944 module_cache_t *p_cache_entry = NULL;
947 * Check our plugins cache first then load plugin if needed
949 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
952 p_module = AllocatePlugin( p_this, psz_file );
955 /* If junk dll, don't try to load it */
956 if( p_cache_entry->b_junk )
960 module_config_t *p_item = NULL, *p_end = NULL;
962 p_module = p_cache_entry->p_module;
963 p_module->b_loaded = false;
965 /* For now we force loading if the module's config contains
966 * callbacks or actions.
967 * Could be optimized by adding an API call.*/
968 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
969 p_item < p_end; p_item++ )
971 if( p_item->pf_callback || p_item->i_action )
973 p_module = AllocatePlugin( p_this, psz_file );
977 if( p_module == p_cache_entry->p_module )
978 p_cache_entry->b_used = true;
981 if( p_module == NULL )
984 /* Everything worked fine !
985 * The module is ready to be added to the list. */
986 p_module->b_builtin = false;
988 /* msg_Dbg( p_this, "plugin \"%s\", %s",
989 p_module->psz_object_name, p_module->psz_longname ); */
990 p_module->next = p_bank->head;
991 p_bank->head = p_module;
993 if( !p_module_bank->b_cache )
996 /* Add entry to cache */
997 module_cache_t **pp_cache = p_bank->pp_cache;
999 pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1000 if( pp_cache == NULL )
1002 pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1003 if( pp_cache[p_bank->i_cache] == NULL )
1005 pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1006 pp_cache[p_bank->i_cache]->i_time = i_file_time;
1007 pp_cache[p_bank->i_cache]->i_size = i_file_size;
1008 pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1009 pp_cache[p_bank->i_cache]->b_used = true;
1010 pp_cache[p_bank->i_cache]->p_module = p_module;
1011 p_bank->pp_cache = pp_cache;
1016 /*****************************************************************************
1017 * AllocatePlugin: load a module into memory and initialize it.
1018 *****************************************************************************
1019 * This function loads a dynamically loadable module and allocates a structure
1020 * for its information data. The module can then be handled by module_need
1021 * and module_unneed. It can be removed by DeleteModule.
1022 *****************************************************************************/
1023 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1025 module_t * p_module = NULL;
1026 module_handle_t handle;
1028 if( module_Load( p_this, psz_file, &handle ) )
1031 /* Now that we have successfully loaded the module, we can
1032 * allocate a structure for it */
1033 p_module = vlc_module_create( p_this );
1034 if( p_module == NULL )
1036 module_Unload( handle );
1040 p_module->psz_filename = strdup( psz_file );
1041 p_module->handle = handle;
1042 p_module->b_loaded = true;
1044 /* Initialize the module: fill p_module, default config */
1045 if( module_Call( p_this, p_module ) != 0 )
1047 /* We couldn't call module_init() */
1048 free( p_module->psz_filename );
1049 module_release( p_module );
1050 module_Unload( handle );
1054 DupModule( p_module );
1056 /* Everything worked fine ! The module is ready to be added to the list. */
1057 p_module->b_builtin = false;
1062 /*****************************************************************************
1063 * DupModule: make a plugin module standalone.
1064 *****************************************************************************
1065 * This function duplicates all strings in the module, so that the dynamic
1066 * object can be unloaded. It acts recursively on submodules.
1067 *****************************************************************************/
1068 static void DupModule( module_t *p_module )
1072 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1074 *pp_shortcut = strdup( *pp_shortcut );
1077 /* We strdup() these entries so that they are still valid when the
1078 * module is unloaded. */
1079 p_module->psz_capability = strdup( p_module->psz_capability );
1080 p_module->psz_shortname = p_module->psz_shortname ?
1081 strdup( p_module->psz_shortname ) : NULL;
1082 p_module->psz_longname = strdup( p_module->psz_longname );
1083 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1086 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1090 /*****************************************************************************
1091 * UndupModule: free a duplicated module.
1092 *****************************************************************************
1093 * This function frees the allocations done in DupModule().
1094 *****************************************************************************/
1095 static void UndupModule( module_t *p_module )
1099 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1102 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1104 free( *pp_shortcut );
1107 free( p_module->psz_capability );
1108 FREENULL( p_module->psz_shortname );
1109 free( p_module->psz_longname );
1110 FREENULL( p_module->psz_help );
1113 #endif /* HAVE_DYNAMIC_PLUGINS */
1115 /*****************************************************************************
1116 * AllocateBuiltinModule: initialize a builtin module.
1117 *****************************************************************************
1118 * This function registers a builtin module and allocates a structure
1119 * for its information data. The module can then be handled by module_need
1120 * and module_unneed. It can be removed by DeleteModule.
1121 *****************************************************************************/
1122 static int AllocateBuiltinModule( vlc_object_t * p_this,
1123 int ( *pf_entry ) ( module_t * ) )
1125 module_t * p_module;
1127 /* Now that we have successfully loaded the module, we can
1128 * allocate a structure for it */
1129 p_module = vlc_module_create( p_this );
1130 if( p_module == NULL )
1133 /* Initialize the module : fill p_module->psz_object_name, etc. */
1134 if( pf_entry( p_module ) != 0 )
1136 /* With a well-written module we shouldn't have to print an
1137 * additional error message here, but just make sure. */
1138 msg_Err( p_this, "failed calling entry point in builtin module" );
1139 module_release( p_module );
1143 /* Everything worked fine ! The module is ready to be added to the list. */
1144 p_module->b_builtin = true;
1146 p_module->next = p_module_bank->head;
1147 p_module_bank->head = p_module;
1150 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1151 p_module->psz_object_name, p_module->psz_longname ); */
1156 /*****************************************************************************
1157 * DeleteModule: delete a module and its structure.
1158 *****************************************************************************
1159 * This function can only be called if the module isn't being used.
1160 *****************************************************************************/
1161 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1165 /* Unlist the module (if it is in the list) */
1166 module_t **pp_self = &p_bank->head;
1167 while (*pp_self != NULL && *pp_self != p_module)
1168 pp_self = &((*pp_self)->next);
1170 *pp_self = p_module->next;
1172 /* We free the structures that we strdup()ed in Allocate*Module(). */
1173 #ifdef HAVE_DYNAMIC_PLUGINS
1174 if( !p_module->b_builtin )
1176 if( p_module->b_loaded && p_module->b_unloadable )
1178 module_Unload( p_module->handle );
1180 UndupModule( p_module );
1181 free( p_module->psz_filename );
1185 /* Free and detach the object's children */
1186 while (p_module->submodule)
1188 module_t *submodule = p_module->submodule;
1189 p_module->submodule = submodule->next;
1190 module_release (submodule);
1193 config_Free( p_module );
1194 module_release( p_module );