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 p_module_bank->b_plugins = true;
243 vlc_mutex_unlock( &module_lock );
247 * Checks whether a module implements a capability.
249 * \param m the module
250 * \param cap the capability to check
251 * \return TRUE if the module have the capability
253 bool module_provides( const module_t *m, const char *cap )
255 return !strcmp( m->psz_capability, cap );
259 * Get the internal name of a module
261 * \param m the module
262 * \return the module name
264 const char *module_get_object( const module_t *m )
266 return m->psz_object_name;
270 * Get the human-friendly name of a module.
272 * \param m the module
273 * \param long_name TRUE to have the long name of the module
274 * \return the short or long name of the module
276 const char *module_get_name( const module_t *m, bool long_name )
278 if( long_name && ( m->psz_longname != NULL) )
279 return m->psz_longname;
281 return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
285 * Get the help for a module
287 * \param m the module
290 const char *module_get_help( const module_t *m )
296 * Get the capability for a module
298 * \param m the module
299 * return the capability
301 const char *module_get_capability( const module_t *m )
303 return m->psz_capability;
307 * Get the score for a module
309 * \param m the module
310 * return the score for the capability
312 int module_get_score( const module_t *m )
317 module_t *module_hold (module_t *m)
319 vlc_hold (&m->vlc_gc_data);
323 void module_release (module_t *m)
325 vlc_release (&m->vlc_gc_data);
329 * Frees the flat list of VLC modules.
330 * @param list list obtained by module_list_get()
331 * @param length number of items on the list
334 void module_list_free (module_t **list)
339 for (size_t i = 0; list[i] != NULL; i++)
340 module_release (list[i]);
345 * Gets the flat list of VLC modules.
346 * @param n [OUT] pointer to the number of modules or NULL
347 * @return NULL-terminated table of module pointers
348 * (release with module_list_free()), or NULL in case of error.
350 module_t **module_list_get (size_t *n)
352 /* TODO: this whole module lookup is quite inefficient */
353 /* Remove this and improve module_need */
354 module_t **tab = NULL;
357 assert (p_module_bank);
358 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
361 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
364 module_list_free (tab);
369 tab[i++] = module_hold (mod);
370 for (module_t *subm = mod->submodule; subm; subm = subm->next)
371 tab[i++] = module_hold (subm);
379 typedef struct module_list_t
386 static int modulecmp (const void *a, const void *b)
388 const module_list_t *la = a, *lb = b;
389 /* Note that qsort() uses _ascending_ order,
390 * so the smallest module is the one with the biggest score. */
391 return lb->i_score - la->i_score;
397 * Return the best module function, given a capability list.
399 * \param p_this the vlc object
400 * \param psz_capability list of capabilities needed
401 * \param psz_name name of the module asked
402 * \param b_strict if true, do not fallback to plugin with a different name
403 * but the same capability
404 * \return the module or NULL in case of a failure
406 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
407 const char *psz_name, bool b_strict )
409 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
411 module_list_t *p_list;
414 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
415 bool b_force_backup = p_this->b_force;
417 /* Deal with variables */
418 if( psz_name && psz_name[0] == '$' )
420 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
423 /* Count how many different shortcuts were asked for */
424 if( psz_name && *psz_name )
426 char *psz_parser, *psz_last_shortcut;
428 /* If the user wants none, give him none. */
429 if( !strcmp( psz_name, "none" ) )
432 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
433 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
434 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
439 psz_parser = psz_shortcuts = psz_last_shortcut = strdup( psz_name );
441 while( ( psz_parser = strchr( psz_parser, ',' ) ) )
445 psz_last_shortcut = ++psz_parser;
448 /* Check if the user wants to override the "strict" mode */
449 if( psz_last_shortcut )
451 if( !strcmp(psz_last_shortcut, "none") )
456 else if( !strcmp(psz_last_shortcut, "any") )
464 /* Sort the modules and test them */
466 module_t **p_all = module_list_get (&count);
467 p_list = malloc( count * sizeof( module_list_t ) );
469 /* Parse the module list for capabilities and probe each of them */
471 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
473 int i_shortcut_bonus = 0;
475 /* Test that this module can do what we need */
476 if( !module_provides( p_module, psz_capability ) )
479 /* If we required a shortcut, check this plugin provides it. */
480 if( i_shortcuts > 0 )
482 const char *name = psz_shortcuts;
484 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
486 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
489 if( ( c = strchr( name, '@' ) )
490 ? !strncasecmp( name, p_module->pp_shortcuts[i],
492 : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
497 i_shortcut_bonus = i_short * 10000;
502 /* Go to the next shortcut... This is so lame! */
503 name += strlen( name ) + 1;
506 /* If we are in "strict" mode and we couldn't
507 * find the module in the list of provided shortcuts,
508 * then kick the bastard out of here!!! */
513 /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
514 if( p_module->i_score <= 0 )
518 /* Store this new module */
519 p_list[count].p_module = module_hold (p_module);
520 p_list[count].i_score = p_module->i_score + i_shortcut_bonus;
521 p_list[count].b_force = i_shortcut_bonus && b_strict;
525 /* We can release the list, interesting modules are held */
526 module_list_free (p_all);
528 /* Sort candidates by descending score */
529 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
530 msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
531 count, count == 1 ? "" : "s" );
533 /* Parse the linked list and use the first successful module */
535 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
537 module_t *p_cand = p_list[i].p_module;
538 #ifdef HAVE_DYNAMIC_PLUGINS
539 /* Make sure the module is loaded in mem */
540 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
542 if( !p_real->b_builtin && !p_real->b_loaded )
544 module_t *p_new_module =
545 AllocatePlugin( p_this, p_real->psz_filename );
546 if( p_new_module == NULL )
547 { /* Corrupted module */
548 msg_Err( p_this, "possibly corrupt module cache" );
549 module_release( p_cand );
552 CacheMerge( p_this, p_real, p_new_module );
553 DeleteModule( p_module_bank, p_new_module );
557 p_this->b_force = p_list[i].b_force;
559 int ret = VLC_SUCCESS;
560 if( p_cand->pf_activate )
561 ret = p_cand->pf_activate( p_this );
570 /* good module, but aborted */
571 module_release( p_cand );
574 default: /* bad module */
575 module_release( p_cand );
579 /* Release the remaining modules */
581 module_release (p_list[i].p_module);
585 p_this->b_force = b_force_backup;
587 if( p_module != NULL )
589 msg_Dbg( p_this, "using %s module \"%s\"",
590 psz_capability, p_module->psz_object_name );
591 vlc_object_set_name( p_this, psz_alias ? psz_alias
592 : p_module->psz_object_name );
594 else if( count == 0 )
596 if( !strcmp( psz_capability, "access_demux" )
597 || !strcmp( psz_capability, "stream_filter" )
598 || !strcmp( psz_capability, "vout_window" ) )
600 msg_Dbg( p_this, "no %s module matched \"%s\"",
601 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
605 msg_Err( p_this, "no %s module matched \"%s\"",
606 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
608 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
609 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
612 else if( psz_name != NULL && *psz_name )
614 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
615 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
618 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
620 free( psz_shortcuts );
623 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
624 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
625 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
627 /* Don't forget that the module is still locked */
634 * This function must be called by the thread that called module_need, to
635 * decrease the reference count and allow for hiding of modules.
636 * \param p_this vlc object structure
637 * \param p_module the module structure
640 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
642 /* Use the close method */
643 if( p_module->pf_deactivate )
645 p_module->pf_deactivate( p_this );
648 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
650 module_release( p_module );
654 * Get a pointer to a module_t given it's name.
656 * \param psz_name the name of the module
657 * \return a pointer to the module or NULL in case of a failure
659 module_t *module_find( const char * psz_name )
661 module_t **list, *module;
663 list = module_list_get (NULL);
667 for (size_t i = 0; (module = list[i]) != NULL; i++)
669 const char *psz_module_name = module->psz_object_name;
671 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
673 module_hold (module);
677 module_list_free (list);
682 * Tell if a module exists and release it in thic case
684 * \param psz_name th name of the module
685 * \return TRUE if the module exists
687 bool module_exists (const char * psz_name)
689 module_t *p_module = module_find (psz_name);
691 module_release (p_module);
692 return p_module != NULL;
696 * Get a pointer to a module_t that matches a shortcut.
697 * This is a temporary hack for SD. Do not re-use (generally multiple modules
698 * can have the same shortcut, so this is *broken* - use module_need()!).
700 * \param psz_shortcut shortcut of the module
701 * \param psz_cap capability of the module
702 * \return a pointer to the module or NULL in case of a failure
704 module_t *module_find_by_shortcut (const char *psz_shortcut)
706 module_t **list, *module;
708 list = module_list_get (NULL);
712 for (size_t i = 0; (module = list[i]) != NULL; i++)
715 (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
718 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
720 module_hold (module);
726 module_list_free (list);
731 * Get the configuration of a module
733 * \param module the module
734 * \param psize the size of the configuration returned
735 * \return the configuration as an array
737 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
740 unsigned size = module->confsize;
741 module_config_t *config = malloc( size * sizeof( *config ) );
743 assert( psize != NULL );
749 for( i = 0, j = 0; i < size; i++ )
751 const module_config_t *item = module->p_config + i;
752 if( item->b_internal /* internal option */
753 || item->b_unsaveable /* non-modifiable option */
754 || item->b_removed /* removed option */ )
757 memcpy( config + j, item, sizeof( *config ) );
766 * Release the configuration
768 * \param the configuration
771 void module_config_free( module_config_t *config )
776 /*****************************************************************************
777 * Following functions are local.
778 *****************************************************************************/
780 /*****************************************************************************
781 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
783 *****************************************************************************/
784 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
788 bool escaped = false;
792 /* Alloc a buffer to store the path */
793 path = malloc( strlen( paths ) + 1 );
794 if( !path ) return NULL;
796 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
797 for( i = 0, done = 0 ; paths[i]; i++ )
799 /* Take care of \\ and \: or \; escapement */
803 path[done++] = paths[i];
806 else if( paths[i] == '/' )
809 else if( paths[i] == '\\' )
812 else if( paths[i] == PATH_SEP_CHAR )
815 path[done++] = paths[i];
819 /* Return the remaining paths */
820 if( remaining_paths ) {
821 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
827 char *psz_vlcpath = NULL;
829 /*****************************************************************************
830 * AllocateAllPlugins: load all plugin modules we can find.
831 *****************************************************************************/
832 #ifdef HAVE_DYNAMIC_PLUGINS
833 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
835 const char *vlcpath = psz_vlcpath;
838 vlc_array_t *arraypaths = vlc_array_new();
840 /* Contruct the special search path for system that have a relocatable
841 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
843 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
844 vlc_array_append( arraypaths, path );
845 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
846 vlc_array_append( arraypaths, path );
848 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
851 /* If the user provided a plugin path, we add it to the list */
852 char *userpaths = var_InheritString( p_this, "plugin-path" );
855 for( paths_iter = userpaths; paths_iter; )
857 path = copy_next_paths_token( paths_iter, &paths_iter );
859 vlc_array_append( arraypaths, path );
862 count = vlc_array_count( arraypaths );
863 for( i = 0 ; i < count ; i++ )
865 path = vlc_array_item_at_index( arraypaths, i );
869 msg_Dbg( p_this, "recursively browsing `%s'", path );
871 /* Don't go deeper than 5 subdirectories */
872 AllocatePluginDir( p_this, p_bank, path, 5 );
877 vlc_array_destroy( arraypaths );
881 /*****************************************************************************
882 * AllocatePluginDir: recursively parse a directory to look for plugins
883 *****************************************************************************/
884 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
885 const char *psz_dir, unsigned i_maxdepth )
887 if( i_maxdepth == 0 )
890 DIR *dh = utf8_opendir (psz_dir);
894 /* Parse the directory and try to load all files it contains. */
897 char *file = utf8_readdir (dh), *path;
904 if (!strcmp (file, ".") || !strcmp (file, "..")
905 /* Skip directories for unsupported optimizations */
906 || !vlc_CPU_CheckPluginDir (file))
912 const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
914 if (pathlen == -1 || utf8_stat (path, &st))
917 if (S_ISDIR (st.st_mode))
918 /* Recurse into another directory */
919 AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
921 if (S_ISREG (st.st_mode)
922 && ((size_t)pathlen >= strlen (LIBEXT))
923 && !strncasecmp (path + pathlen - strlen (LIBEXT), LIBEXT,
925 /* ^^ We only load files ending with LIBEXT */
926 AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
933 /*****************************************************************************
934 * AllocatePluginFile: load a module into memory and initialize it.
935 *****************************************************************************
936 * This function loads a dynamically loadable module and allocates a structure
937 * for its information data. The module can then be handled by module_need
938 * and module_unneed. It can be removed by DeleteModule.
939 *****************************************************************************/
940 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
941 const char *psz_file,
942 int64_t i_file_time, int64_t i_file_size )
944 module_t * p_module = NULL;
945 module_cache_t *p_cache_entry = NULL;
948 * Check our plugins cache first then load plugin if needed
950 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
953 p_module = AllocatePlugin( p_this, psz_file );
956 /* If junk dll, don't try to load it */
957 if( p_cache_entry->b_junk )
961 module_config_t *p_item = NULL, *p_end = NULL;
963 p_module = p_cache_entry->p_module;
964 p_module->b_loaded = false;
966 /* For now we force loading if the module's config contains
967 * callbacks or actions.
968 * Could be optimized by adding an API call.*/
969 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
970 p_item < p_end; p_item++ )
972 if( p_item->pf_callback || p_item->i_action )
974 p_module = AllocatePlugin( p_this, psz_file );
978 if( p_module == p_cache_entry->p_module )
979 p_cache_entry->b_used = true;
982 if( p_module == NULL )
985 /* Everything worked fine !
986 * The module is ready to be added to the list. */
987 p_module->b_builtin = false;
989 /* msg_Dbg( p_this, "plugin \"%s\", %s",
990 p_module->psz_object_name, p_module->psz_longname ); */
991 p_module->next = p_bank->head;
992 p_bank->head = p_module;
994 if( !p_module_bank->b_cache )
997 /* Add entry to cache */
998 module_cache_t **pp_cache = p_bank->pp_cache;
1000 pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1001 if( pp_cache == NULL )
1003 pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1004 if( pp_cache[p_bank->i_cache] == NULL )
1006 pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1007 pp_cache[p_bank->i_cache]->i_time = i_file_time;
1008 pp_cache[p_bank->i_cache]->i_size = i_file_size;
1009 pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1010 pp_cache[p_bank->i_cache]->b_used = true;
1011 pp_cache[p_bank->i_cache]->p_module = p_module;
1012 p_bank->pp_cache = pp_cache;
1017 /*****************************************************************************
1018 * AllocatePlugin: load a module into memory and initialize it.
1019 *****************************************************************************
1020 * This function loads a dynamically loadable module and allocates a structure
1021 * for its information data. The module can then be handled by module_need
1022 * and module_unneed. It can be removed by DeleteModule.
1023 *****************************************************************************/
1024 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1026 module_t * p_module = NULL;
1027 module_handle_t handle;
1029 if( module_Load( p_this, psz_file, &handle ) )
1032 /* Now that we have successfully loaded the module, we can
1033 * allocate a structure for it */
1034 p_module = vlc_module_create( p_this );
1035 if( p_module == NULL )
1037 module_Unload( handle );
1041 p_module->psz_filename = strdup( psz_file );
1042 p_module->handle = handle;
1043 p_module->b_loaded = true;
1045 /* Initialize the module: fill p_module, default config */
1046 if( module_Call( p_this, p_module ) != 0 )
1048 /* We couldn't call module_init() */
1049 free( p_module->psz_filename );
1050 module_release( p_module );
1051 module_Unload( handle );
1055 DupModule( p_module );
1057 /* Everything worked fine ! The module is ready to be added to the list. */
1058 p_module->b_builtin = false;
1063 /*****************************************************************************
1064 * DupModule: make a plugin module standalone.
1065 *****************************************************************************
1066 * This function duplicates all strings in the module, so that the dynamic
1067 * object can be unloaded. It acts recursively on submodules.
1068 *****************************************************************************/
1069 static void DupModule( module_t *p_module )
1073 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1075 *pp_shortcut = strdup( *pp_shortcut );
1078 /* We strdup() these entries so that they are still valid when the
1079 * module is unloaded. */
1080 p_module->psz_capability = strdup( p_module->psz_capability );
1081 p_module->psz_shortname = p_module->psz_shortname ?
1082 strdup( p_module->psz_shortname ) : NULL;
1083 p_module->psz_longname = strdup( p_module->psz_longname );
1084 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1087 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1091 /*****************************************************************************
1092 * UndupModule: free a duplicated module.
1093 *****************************************************************************
1094 * This function frees the allocations done in DupModule().
1095 *****************************************************************************/
1096 static void UndupModule( module_t *p_module )
1100 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1103 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1105 free( *pp_shortcut );
1108 free( p_module->psz_capability );
1109 FREENULL( p_module->psz_shortname );
1110 free( p_module->psz_longname );
1111 FREENULL( p_module->psz_help );
1114 #endif /* HAVE_DYNAMIC_PLUGINS */
1116 /*****************************************************************************
1117 * AllocateBuiltinModule: initialize a builtin module.
1118 *****************************************************************************
1119 * This function registers a builtin module and allocates a structure
1120 * for its information data. The module can then be handled by module_need
1121 * and module_unneed. It can be removed by DeleteModule.
1122 *****************************************************************************/
1123 static int AllocateBuiltinModule( vlc_object_t * p_this,
1124 int ( *pf_entry ) ( module_t * ) )
1126 module_t * p_module;
1128 /* Now that we have successfully loaded the module, we can
1129 * allocate a structure for it */
1130 p_module = vlc_module_create( p_this );
1131 if( p_module == NULL )
1134 /* Initialize the module : fill p_module->psz_object_name, etc. */
1135 if( pf_entry( p_module ) != 0 )
1137 /* With a well-written module we shouldn't have to print an
1138 * additional error message here, but just make sure. */
1139 msg_Err( p_this, "failed calling entry point in builtin module" );
1140 module_release( p_module );
1144 /* Everything worked fine ! The module is ready to be added to the list. */
1145 p_module->b_builtin = true;
1147 p_module->next = p_module_bank->head;
1148 p_module_bank->head = p_module;
1151 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1152 p_module->psz_object_name, p_module->psz_longname ); */
1157 /*****************************************************************************
1158 * DeleteModule: delete a module and its structure.
1159 *****************************************************************************
1160 * This function can only be called if the module isn't being used.
1161 *****************************************************************************/
1162 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1166 /* Unlist the module (if it is in the list) */
1167 module_t **pp_self = &p_bank->head;
1168 while (*pp_self != NULL && *pp_self != p_module)
1169 pp_self = &((*pp_self)->next);
1171 *pp_self = p_module->next;
1173 /* We free the structures that we strdup()ed in Allocate*Module(). */
1174 #ifdef HAVE_DYNAMIC_PLUGINS
1175 if( !p_module->b_builtin )
1177 if( p_module->b_loaded && p_module->b_unloadable )
1179 module_Unload( p_module->handle );
1181 UndupModule( p_module );
1182 free( p_module->psz_filename );
1186 /* Free and detach the object's children */
1187 while (p_module->submodule)
1189 module_t *submodule = p_module->submodule;
1190 p_module->submodule = submodule->next;
1191 module_release (submodule);
1194 config_Free( p_module );
1195 module_release( p_module );