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);
141 config_SortConfig ();
144 p_module_bank->i_usage++;
146 /* We do retain the module bank lock until the plugins are loaded as well.
147 * This is ugly, this staged loading approach is needed: LibVLC gets
148 * some configuration parameters relevant to loading the plugins from
149 * the main (builtin) module. The module bank becomes shared read-only data
150 * once it is ready, so we need to fully serialize initialization.
151 * DO NOT UNCOMMENT the following line unless you managed to squeeze
152 * module_LoadPlugins() before you unlock the mutex. */
153 /*vlc_mutex_unlock( &module_lock );*/
156 #undef module_EndBank
158 * Unloads all unused plugin modules and empties the module
159 * bank in case of success.
160 * \param p_this vlc object structure
163 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
165 module_bank_t *p_bank = p_module_bank;
167 assert (p_bank != NULL);
169 /* Save the configuration */
170 if( !var_InheritBool( p_this, "ignore-config" ) )
171 config_AutoSaveConfigFile( p_this );
173 /* If plugins were _not_ loaded, then the caller still has the bank lock
174 * from module_InitBank(). */
176 vlc_mutex_lock( &module_lock );
178 vlc_assert_locked( &module_lock ); not for static mutexes :( */
180 if( --p_bank->i_usage > 0 )
182 vlc_mutex_unlock( &module_lock );
186 config_UnsortConfig ();
187 vlc_rwlock_destroy (&config_lock);
188 p_module_bank = NULL;
189 vlc_mutex_unlock( &module_lock );
191 #ifdef HAVE_DYNAMIC_PLUGINS
192 if( p_bank->b_cache )
193 CacheSave( p_this, p_bank );
194 while( p_bank->i_loaded_cache-- )
196 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
198 DeleteModule( p_bank,
199 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
200 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
201 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
204 free( p_bank->pp_loaded_cache );
205 while( p_bank->i_cache-- )
207 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
208 free( p_bank->pp_cache[p_bank->i_cache] );
210 free( p_bank->pp_cache );
213 while( p_bank->head != NULL )
214 DeleteModule( p_bank, p_bank->head );
219 #undef module_LoadPlugins
221 * Loads module descriptions for all available plugins.
222 * Fills the module bank structure with the plugin modules.
224 * \param p_this vlc object structure
227 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
229 module_bank_t *p_bank = p_module_bank;
232 /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
234 #ifdef HAVE_DYNAMIC_PLUGINS
235 if( p_bank->i_usage == 1 )
237 msg_Dbg( p_this, "checking plugin modules" );
238 p_module_bank->b_cache = var_InheritBool( p_this, "plugins-cache" );
240 if( p_module_bank->b_cache || b_cache_delete )
241 CacheLoad( p_this, p_module_bank, b_cache_delete );
242 AllocateAllPlugins( p_this, p_module_bank );
243 config_UnsortConfig ();
244 config_SortConfig ();
247 vlc_mutex_unlock( &module_lock );
251 * Checks whether a module implements a capability.
253 * \param m the module
254 * \param cap the capability to check
255 * \return TRUE if the module have the capability
257 bool module_provides( const module_t *m, const char *cap )
259 return !strcmp( m->psz_capability, cap );
263 * Get the internal name of a module
265 * \param m the module
266 * \return the module name
268 const char *module_get_object( const module_t *m )
270 return m->psz_object_name;
274 * Get the human-friendly name of a module.
276 * \param m the module
277 * \param long_name TRUE to have the long name of the module
278 * \return the short or long name of the module
280 const char *module_get_name( const module_t *m, bool long_name )
282 if( long_name && ( m->psz_longname != NULL) )
283 return m->psz_longname;
285 return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
289 * Get the help for a module
291 * \param m the module
294 const char *module_get_help( const module_t *m )
300 * Get the capability for a module
302 * \param m the module
303 * return the capability
305 const char *module_get_capability( const module_t *m )
307 return m->psz_capability;
311 * Get the score for a module
313 * \param m the module
314 * return the score for the capability
316 int module_get_score( const module_t *m )
321 module_t *module_hold (module_t *m)
323 vlc_hold (&m->vlc_gc_data);
327 void module_release (module_t *m)
329 vlc_release (&m->vlc_gc_data);
333 * Frees the flat list of VLC modules.
334 * @param list list obtained by module_list_get()
335 * @param length number of items on the list
338 void module_list_free (module_t **list)
343 for (size_t i = 0; list[i] != NULL; i++)
344 module_release (list[i]);
349 * Gets the flat list of VLC modules.
350 * @param n [OUT] pointer to the number of modules or NULL
351 * @return NULL-terminated table of module pointers
352 * (release with module_list_free()), or NULL in case of error.
354 module_t **module_list_get (size_t *n)
356 /* TODO: this whole module lookup is quite inefficient */
357 /* Remove this and improve module_need */
358 module_t **tab = NULL;
361 assert (p_module_bank);
362 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
365 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
368 module_list_free (tab);
373 tab[i++] = module_hold (mod);
374 for (module_t *subm = mod->submodule; subm; subm = subm->next)
375 tab[i++] = module_hold (subm);
383 typedef struct module_list_t
390 static int modulecmp (const void *a, const void *b)
392 const module_list_t *la = a, *lb = b;
393 /* Note that qsort() uses _ascending_ order,
394 * so the smallest module is the one with the biggest score. */
395 return lb->i_score - la->i_score;
401 * Return the best module function, given a capability list.
403 * \param p_this the vlc object
404 * \param psz_capability list of capabilities needed
405 * \param psz_name name of the module asked
406 * \param b_strict if true, do not fallback to plugin with a different name
407 * but the same capability
408 * \return the module or NULL in case of a failure
410 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
411 const char *psz_name, bool b_strict )
413 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
415 module_list_t *p_list;
418 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
419 bool b_force_backup = p_this->b_force;
421 /* Deal with variables */
422 if( psz_name && psz_name[0] == '$' )
424 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
427 /* Count how many different shortcuts were asked for */
428 if( psz_name && *psz_name )
430 char *psz_parser, *psz_last_shortcut;
432 /* If the user wants none, give him none. */
433 if( !strcmp( psz_name, "none" ) )
436 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
437 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
438 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
443 psz_parser = psz_shortcuts = psz_last_shortcut = strdup( psz_name );
445 while( ( psz_parser = strchr( psz_parser, ',' ) ) )
449 psz_last_shortcut = ++psz_parser;
452 /* Check if the user wants to override the "strict" mode */
453 if( psz_last_shortcut )
455 if( !strcmp(psz_last_shortcut, "none") )
460 else if( !strcmp(psz_last_shortcut, "any") )
468 /* Sort the modules and test them */
470 module_t **p_all = module_list_get (&count);
471 p_list = malloc( count * sizeof( module_list_t ) );
473 /* Parse the module list for capabilities and probe each of them */
475 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
477 int i_shortcut_bonus = 0;
479 /* Test that this module can do what we need */
480 if( !module_provides( p_module, psz_capability ) )
483 /* If we required a shortcut, check this plugin provides it. */
484 if( i_shortcuts > 0 )
486 const char *name = psz_shortcuts;
488 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
490 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
493 if( ( c = strchr( name, '@' ) )
494 ? !strncasecmp( name, p_module->pp_shortcuts[i],
496 : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
501 i_shortcut_bonus = i_short * 10000;
506 /* Go to the next shortcut... This is so lame! */
507 name += strlen( name ) + 1;
510 /* If we are in "strict" mode and we couldn't
511 * find the module in the list of provided shortcuts,
512 * then kick the bastard out of here!!! */
517 /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
518 if( p_module->i_score <= 0 )
522 /* Store this new module */
523 p_list[count].p_module = module_hold (p_module);
524 p_list[count].i_score = p_module->i_score + i_shortcut_bonus;
525 p_list[count].b_force = i_shortcut_bonus && b_strict;
529 /* We can release the list, interesting modules are held */
530 module_list_free (p_all);
532 /* Sort candidates by descending score */
533 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
534 msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
535 count, count == 1 ? "" : "s" );
537 /* Parse the linked list and use the first successful module */
539 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
541 module_t *p_cand = p_list[i].p_module;
542 #ifdef HAVE_DYNAMIC_PLUGINS
543 /* Make sure the module is loaded in mem */
544 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
546 if( !p_real->b_builtin && !p_real->b_loaded )
548 module_t *p_new_module =
549 AllocatePlugin( p_this, p_real->psz_filename );
550 if( p_new_module == NULL )
551 { /* Corrupted module */
552 msg_Err( p_this, "possibly corrupt module cache" );
553 module_release( p_cand );
556 CacheMerge( p_this, p_real, p_new_module );
557 DeleteModule( p_module_bank, p_new_module );
561 p_this->b_force = p_list[i].b_force;
563 int ret = VLC_SUCCESS;
564 if( p_cand->pf_activate )
565 ret = p_cand->pf_activate( p_this );
574 /* good module, but aborted */
575 module_release( p_cand );
578 default: /* bad module */
579 module_release( p_cand );
583 /* Release the remaining modules */
585 module_release (p_list[i].p_module);
589 p_this->b_force = b_force_backup;
591 if( p_module != NULL )
593 msg_Dbg( p_this, "using %s module \"%s\"",
594 psz_capability, p_module->psz_object_name );
595 vlc_object_set_name( p_this, psz_alias ? psz_alias
596 : p_module->psz_object_name );
598 else if( count == 0 )
600 if( !strcmp( psz_capability, "access_demux" )
601 || !strcmp( psz_capability, "stream_filter" )
602 || !strcmp( psz_capability, "vout_window" ) )
604 msg_Dbg( p_this, "no %s module matched \"%s\"",
605 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
609 msg_Err( p_this, "no %s module matched \"%s\"",
610 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
612 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
613 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
616 else if( psz_name != NULL && *psz_name )
618 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
619 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
622 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
624 free( psz_shortcuts );
627 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
628 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
629 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
631 /* Don't forget that the module is still locked */
638 * This function must be called by the thread that called module_need, to
639 * decrease the reference count and allow for hiding of modules.
640 * \param p_this vlc object structure
641 * \param p_module the module structure
644 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
646 /* Use the close method */
647 if( p_module->pf_deactivate )
649 p_module->pf_deactivate( p_this );
652 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
654 module_release( p_module );
658 * Get a pointer to a module_t given it's name.
660 * \param psz_name the name of the module
661 * \return a pointer to the module or NULL in case of a failure
663 module_t *module_find( const char * psz_name )
665 module_t **list, *module;
667 list = module_list_get (NULL);
671 for (size_t i = 0; (module = list[i]) != NULL; i++)
673 const char *psz_module_name = module->psz_object_name;
675 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
677 module_hold (module);
681 module_list_free (list);
686 * Tell if a module exists and release it in thic case
688 * \param psz_name th name of the module
689 * \return TRUE if the module exists
691 bool module_exists (const char * psz_name)
693 module_t *p_module = module_find (psz_name);
695 module_release (p_module);
696 return p_module != NULL;
700 * Get a pointer to a module_t that matches a shortcut.
701 * This is a temporary hack for SD. Do not re-use (generally multiple modules
702 * can have the same shortcut, so this is *broken* - use module_need()!).
704 * \param psz_shortcut shortcut of the module
705 * \param psz_cap capability of the module
706 * \return a pointer to the module or NULL in case of a failure
708 module_t *module_find_by_shortcut (const char *psz_shortcut)
710 module_t **list, *module;
712 list = module_list_get (NULL);
716 for (size_t i = 0; (module = list[i]) != NULL; i++)
719 (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
722 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
724 module_hold (module);
730 module_list_free (list);
735 * Get the configuration of a module
737 * \param module the module
738 * \param psize the size of the configuration returned
739 * \return the configuration as an array
741 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
744 unsigned size = module->confsize;
745 module_config_t *config = malloc( size * sizeof( *config ) );
747 assert( psize != NULL );
753 for( i = 0, j = 0; i < size; i++ )
755 const module_config_t *item = module->p_config + i;
756 if( item->b_internal /* internal option */
757 || item->b_unsaveable /* non-modifiable option */
758 || item->b_removed /* removed option */ )
761 memcpy( config + j, item, sizeof( *config ) );
770 * Release the configuration
772 * \param the configuration
775 void module_config_free( module_config_t *config )
780 /*****************************************************************************
781 * Following functions are local.
782 *****************************************************************************/
784 /*****************************************************************************
785 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
787 *****************************************************************************/
788 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
792 bool escaped = false;
796 /* Alloc a buffer to store the path */
797 path = malloc( strlen( paths ) + 1 );
798 if( !path ) return NULL;
800 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
801 for( i = 0, done = 0 ; paths[i]; i++ )
803 /* Take care of \\ and \: or \; escapement */
807 path[done++] = paths[i];
810 else if( paths[i] == '/' )
813 else if( paths[i] == '\\' )
816 else if( paths[i] == PATH_SEP_CHAR )
819 path[done++] = paths[i];
823 /* Return the remaining paths */
824 if( remaining_paths ) {
825 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
831 char *psz_vlcpath = NULL;
833 /*****************************************************************************
834 * AllocateAllPlugins: load all plugin modules we can find.
835 *****************************************************************************/
836 #ifdef HAVE_DYNAMIC_PLUGINS
837 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
839 const char *vlcpath = psz_vlcpath;
842 vlc_array_t *arraypaths = vlc_array_new();
844 /* Contruct the special search path for system that have a relocatable
845 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
847 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
848 vlc_array_append( arraypaths, path );
849 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
850 vlc_array_append( arraypaths, path );
852 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
855 /* If the user provided a plugin path, we add it to the list */
856 char *userpaths = var_InheritString( p_this, "plugin-path" );
859 for( paths_iter = userpaths; paths_iter; )
861 path = copy_next_paths_token( paths_iter, &paths_iter );
863 vlc_array_append( arraypaths, path );
866 count = vlc_array_count( arraypaths );
867 for( i = 0 ; i < count ; i++ )
869 path = vlc_array_item_at_index( arraypaths, i );
873 msg_Dbg( p_this, "recursively browsing `%s'", path );
875 /* Don't go deeper than 5 subdirectories */
876 AllocatePluginDir( p_this, p_bank, path, 5 );
881 vlc_array_destroy( arraypaths );
885 /*****************************************************************************
886 * AllocatePluginDir: recursively parse a directory to look for plugins
887 *****************************************************************************/
888 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
889 const char *psz_dir, unsigned i_maxdepth )
891 if( i_maxdepth == 0 )
894 DIR *dh = utf8_opendir (psz_dir);
898 /* Parse the directory and try to load all files it contains. */
901 char *file = utf8_readdir (dh), *path;
908 if (!strcmp (file, ".") || !strcmp (file, "..")
909 /* Skip directories for unsupported optimizations */
910 || !vlc_CPU_CheckPluginDir (file))
916 const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
918 if (pathlen == -1 || utf8_stat (path, &st))
921 if (S_ISDIR (st.st_mode))
922 /* Recurse into another directory */
923 AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
925 if (S_ISREG (st.st_mode)
926 && ((size_t)pathlen >= strlen (LIBEXT))
927 && !strncasecmp (path + pathlen - strlen (LIBEXT), LIBEXT,
929 /* ^^ We only load files ending with LIBEXT */
930 AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
937 /*****************************************************************************
938 * AllocatePluginFile: load a module into memory and initialize it.
939 *****************************************************************************
940 * This function loads a dynamically loadable module and allocates a structure
941 * for its information data. The module can then be handled by module_need
942 * and module_unneed. It can be removed by DeleteModule.
943 *****************************************************************************/
944 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
945 const char *psz_file,
946 int64_t i_file_time, int64_t i_file_size )
948 module_t * p_module = NULL;
949 module_cache_t *p_cache_entry = NULL;
952 * Check our plugins cache first then load plugin if needed
954 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
957 p_module = AllocatePlugin( p_this, psz_file );
960 /* If junk dll, don't try to load it */
961 if( p_cache_entry->b_junk )
965 module_config_t *p_item = NULL, *p_end = NULL;
967 p_module = p_cache_entry->p_module;
968 p_module->b_loaded = false;
970 /* For now we force loading if the module's config contains
971 * callbacks or actions.
972 * Could be optimized by adding an API call.*/
973 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
974 p_item < p_end; p_item++ )
976 if( p_item->pf_callback || p_item->i_action )
978 p_module = AllocatePlugin( p_this, psz_file );
982 if( p_module == p_cache_entry->p_module )
983 p_cache_entry->b_used = true;
986 if( p_module == NULL )
989 /* Everything worked fine !
990 * The module is ready to be added to the list. */
991 p_module->b_builtin = false;
993 /* msg_Dbg( p_this, "plugin \"%s\", %s",
994 p_module->psz_object_name, p_module->psz_longname ); */
995 p_module->next = p_bank->head;
996 p_bank->head = p_module;
998 if( !p_module_bank->b_cache )
1001 /* Add entry to cache */
1002 module_cache_t **pp_cache = p_bank->pp_cache;
1004 pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1005 if( pp_cache == NULL )
1007 pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1008 if( pp_cache[p_bank->i_cache] == NULL )
1010 pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1011 pp_cache[p_bank->i_cache]->i_time = i_file_time;
1012 pp_cache[p_bank->i_cache]->i_size = i_file_size;
1013 pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1014 pp_cache[p_bank->i_cache]->b_used = true;
1015 pp_cache[p_bank->i_cache]->p_module = p_module;
1016 p_bank->pp_cache = pp_cache;
1021 /*****************************************************************************
1022 * AllocatePlugin: load a module into memory and initialize it.
1023 *****************************************************************************
1024 * This function loads a dynamically loadable module and allocates a structure
1025 * for its information data. The module can then be handled by module_need
1026 * and module_unneed. It can be removed by DeleteModule.
1027 *****************************************************************************/
1028 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1030 module_t * p_module = NULL;
1031 module_handle_t handle;
1033 if( module_Load( p_this, psz_file, &handle ) )
1036 /* Now that we have successfully loaded the module, we can
1037 * allocate a structure for it */
1038 p_module = vlc_module_create( p_this );
1039 if( p_module == NULL )
1041 module_Unload( handle );
1045 p_module->psz_filename = strdup( psz_file );
1046 p_module->handle = handle;
1047 p_module->b_loaded = true;
1049 /* Initialize the module: fill p_module, default config */
1050 if( module_Call( p_this, p_module ) != 0 )
1052 /* We couldn't call module_init() */
1053 free( p_module->psz_filename );
1054 module_release( p_module );
1055 module_Unload( handle );
1059 DupModule( p_module );
1061 /* Everything worked fine ! The module is ready to be added to the list. */
1062 p_module->b_builtin = false;
1067 /*****************************************************************************
1068 * DupModule: make a plugin module standalone.
1069 *****************************************************************************
1070 * This function duplicates all strings in the module, so that the dynamic
1071 * object can be unloaded. It acts recursively on submodules.
1072 *****************************************************************************/
1073 static void DupModule( module_t *p_module )
1077 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1079 *pp_shortcut = strdup( *pp_shortcut );
1082 /* We strdup() these entries so that they are still valid when the
1083 * module is unloaded. */
1084 p_module->psz_capability = strdup( p_module->psz_capability );
1085 p_module->psz_shortname = p_module->psz_shortname ?
1086 strdup( p_module->psz_shortname ) : NULL;
1087 p_module->psz_longname = strdup( p_module->psz_longname );
1088 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1091 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1095 /*****************************************************************************
1096 * UndupModule: free a duplicated module.
1097 *****************************************************************************
1098 * This function frees the allocations done in DupModule().
1099 *****************************************************************************/
1100 static void UndupModule( module_t *p_module )
1104 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1107 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1109 free( *pp_shortcut );
1112 free( p_module->psz_capability );
1113 FREENULL( p_module->psz_shortname );
1114 free( p_module->psz_longname );
1115 FREENULL( p_module->psz_help );
1118 #endif /* HAVE_DYNAMIC_PLUGINS */
1120 /*****************************************************************************
1121 * AllocateBuiltinModule: initialize a builtin module.
1122 *****************************************************************************
1123 * This function registers a builtin module and allocates a structure
1124 * for its information data. The module can then be handled by module_need
1125 * and module_unneed. It can be removed by DeleteModule.
1126 *****************************************************************************/
1127 static int AllocateBuiltinModule( vlc_object_t * p_this,
1128 int ( *pf_entry ) ( module_t * ) )
1130 module_t * p_module;
1132 /* Now that we have successfully loaded the module, we can
1133 * allocate a structure for it */
1134 p_module = vlc_module_create( p_this );
1135 if( p_module == NULL )
1138 /* Initialize the module : fill p_module->psz_object_name, etc. */
1139 if( pf_entry( p_module ) != 0 )
1141 /* With a well-written module we shouldn't have to print an
1142 * additional error message here, but just make sure. */
1143 msg_Err( p_this, "failed calling entry point in builtin module" );
1144 module_release( p_module );
1148 /* Everything worked fine ! The module is ready to be added to the list. */
1149 p_module->b_builtin = true;
1151 p_module->next = p_module_bank->head;
1152 p_module_bank->head = p_module;
1155 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1156 p_module->psz_object_name, p_module->psz_longname ); */
1161 /*****************************************************************************
1162 * DeleteModule: delete a module and its structure.
1163 *****************************************************************************
1164 * This function can only be called if the module isn't being used.
1165 *****************************************************************************/
1166 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1170 /* Unlist the module (if it is in the list) */
1171 module_t **pp_self = &p_bank->head;
1172 while (*pp_self != NULL && *pp_self != p_module)
1173 pp_self = &((*pp_self)->next);
1175 *pp_self = p_module->next;
1177 /* We free the structures that we strdup()ed in Allocate*Module(). */
1178 #ifdef HAVE_DYNAMIC_PLUGINS
1179 if( !p_module->b_builtin )
1181 if( p_module->b_loaded && p_module->b_unloadable )
1183 module_Unload( p_module->handle );
1185 UndupModule( p_module );
1186 free( p_module->psz_filename );
1190 /* Free and detach the object's children */
1191 while (p_module->submodule)
1193 module_t *submodule = p_module->submodule;
1194 p_module->submodule = submodule->next;
1195 module_release (submodule);
1198 config_Free( p_module );
1199 module_release( p_module );