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 #ifdef HAVE_SYS_TYPES_H
46 # include <sys/types.h>
48 #ifdef HAVE_SYS_STAT_H
49 # include <sys/stat.h>
55 #if !defined(HAVE_DYNAMIC_PLUGINS)
56 /* no support for plugins */
57 #elif defined(HAVE_DL_DYLD)
58 # if defined(HAVE_MACH_O_DYLD_H)
59 # include <mach-o/dyld.h>
61 #elif defined(HAVE_DL_BEOS)
62 # if defined(HAVE_IMAGE_H)
65 #elif defined(HAVE_DL_WINDOWS)
67 #elif defined(HAVE_DL_DLOPEN)
68 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
71 # if defined(HAVE_SYS_DL_H)
74 #elif defined(HAVE_DL_SHL_LOAD)
75 # if defined(HAVE_DL_H)
80 #include "config/configuration.h"
82 #include "vlc_charset.h"
83 #include "vlc_arrays.h"
86 #include "modules/modules.h"
88 static module_bank_t *p_module_bank = NULL;
89 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
91 int vlc_entry__main( module_t * );
93 /*****************************************************************************
95 *****************************************************************************/
96 #ifdef HAVE_DYNAMIC_PLUGINS
97 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
98 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
100 static int AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
102 static module_t * AllocatePlugin( vlc_object_t *, const char * );
104 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
105 static void DeleteModule ( module_bank_t *, module_t * );
106 #ifdef HAVE_DYNAMIC_PLUGINS
107 static void DupModule ( module_t * );
108 static void UndupModule ( module_t * );
114 * Creates a module bank structure which will be filled later
115 * on with all the modules found.
116 * \param p_this vlc object structure
119 void __module_InitBank( vlc_object_t *p_this )
121 module_bank_t *p_bank = NULL;
123 vlc_mutex_lock( &module_lock );
125 if( p_module_bank == NULL )
127 p_bank = calloc (1, sizeof(*p_bank));
129 p_bank->i_cache = p_bank->i_loaded_cache = 0;
130 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
131 p_bank->b_cache = p_bank->b_cache_dirty = false;
134 /* Everything worked, attach the object */
135 p_module_bank = p_bank;
137 /* Fills the module bank structure with the main module infos.
138 * This is very useful as it will allow us to consider the main
139 * library just as another module, and for instance the configuration
140 * options of main will be available in the module bank structure just
141 * as for every other module. */
142 AllocateBuiltinModule( p_this, vlc_entry__main );
145 p_module_bank->i_usage++;
147 /* We do retain the module bank lock until the plugins are loaded as well.
148 * This is ugly, this staged loading approach is needed: LibVLC gets
149 * some configuration parameters relevant to loading the plugins from
150 * the main (builtin) module. The module bank becomes shared read-only data
151 * once it is ready, so we need to fully serialize initialization.
152 * DO NOT UNCOMMENT the following line unless you managed to squeeze
153 * module_LoadPlugins() before you unlock the mutex. */
154 /*vlc_mutex_unlock( &module_lock );*/
157 #undef module_EndBank
159 * Unloads all unused plugin modules and empties the module
160 * bank in case of success.
161 * \param p_this vlc object structure
164 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
166 module_bank_t *p_bank = p_module_bank;
168 assert (p_bank != NULL);
170 /* Save the configuration */
171 if( !config_GetInt( p_this, "ignore-config" ) )
172 config_AutoSaveConfigFile( p_this );
174 /* If plugins were _not_ loaded, then the caller still has the bank lock
175 * from module_InitBank(). */
177 vlc_mutex_lock( &module_lock );
179 vlc_assert_locked( &module_lock ); not for static mutexes :( */
181 if( --p_bank->i_usage > 0 )
183 vlc_mutex_unlock( &module_lock );
186 p_module_bank = NULL;
187 vlc_mutex_unlock( &module_lock );
189 #ifdef HAVE_DYNAMIC_PLUGINS
190 if( p_bank->b_cache )
191 CacheSave( p_this, p_bank );
192 while( p_bank->i_loaded_cache-- )
194 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
196 DeleteModule( p_bank,
197 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
198 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
199 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
202 free( p_bank->pp_loaded_cache );
203 while( p_bank->i_cache-- )
205 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
206 free( p_bank->pp_cache[p_bank->i_cache] );
208 free( p_bank->pp_cache );
211 while( p_bank->head != NULL )
212 DeleteModule( p_bank, p_bank->head );
217 #undef module_LoadPlugins
219 * Loads module descriptions for all available plugins.
220 * Fills the module bank structure with the plugin modules.
222 * \param p_this vlc object structure
225 void module_LoadPlugins( vlc_object_t * p_this, bool b_cache_delete )
227 module_bank_t *p_bank = p_module_bank;
230 /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
232 #ifdef HAVE_DYNAMIC_PLUGINS
233 if( p_bank->i_usage == 1 )
235 msg_Dbg( p_this, "checking plugin modules" );
236 p_module_bank->b_cache = config_GetInt( p_this, "plugins-cache" ) > 0;
238 if( p_module_bank->b_cache || b_cache_delete )
239 CacheLoad( p_this, p_module_bank, b_cache_delete );
240 AllocateAllPlugins( p_this, p_module_bank );
243 p_module_bank->b_plugins = true;
244 vlc_mutex_unlock( &module_lock );
248 * Checks whether a module implements a capability.
250 * \param m the module
251 * \param cap the capability to check
252 * \return TRUE if the module have the capability
254 bool module_provides( const module_t *m, const char *cap )
256 return !strcmp( m->psz_capability, cap );
260 * Get the internal name of a module
262 * \param m the module
263 * \return the module name
265 const char *module_get_object( const module_t *m )
267 return m->psz_object_name;
271 * Get the human-friendly name of a module.
273 * \param m the module
274 * \param long_name TRUE to have the long name of the module
275 * \return the short or long name of the module
277 const char *module_get_name( const module_t *m, bool long_name )
279 if( long_name && ( m->psz_longname != NULL) )
280 return m->psz_longname;
282 return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
286 * Get the help for a module
288 * \param m the module
291 const char *module_get_help( const module_t *m )
297 * Get the capability for a module
299 * \param m the module
300 * return the capability
302 const char *module_get_capability( const module_t *m )
304 return m->psz_capability;
308 * Get the score for a module
310 * \param m the module
311 * return the score for the capability
313 int module_get_score( const module_t *m )
318 module_t *module_hold (module_t *m)
320 vlc_hold (&m->vlc_gc_data);
324 void module_release (module_t *m)
326 vlc_release (&m->vlc_gc_data);
330 * Frees the flat list of VLC modules.
331 * @param list list obtained by module_list_get()
332 * @param length number of items on the list
335 void module_list_free (module_t **list)
340 for (size_t i = 0; list[i] != NULL; i++)
341 module_release (list[i]);
346 * Gets the flat list of VLC modules.
347 * @param n [OUT] pointer to the number of modules or NULL
348 * @return NULL-terminated table of module pointers
349 * (release with module_list_free()), or NULL in case of error.
351 module_t **module_list_get (size_t *n)
353 /* TODO: this whole module lookup is quite inefficient */
354 /* Remove this and improve module_need */
355 module_t **tab = NULL;
358 assert (p_module_bank);
359 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
362 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
365 module_list_free (tab);
370 tab[i++] = module_hold (mod);
371 for (module_t *subm = mod->submodule; subm; subm = subm->next)
372 tab[i++] = module_hold (subm);
380 typedef struct module_list_t
387 static int modulecmp (const void *a, const void *b)
389 const module_list_t *la = a, *lb = b;
390 /* Note that qsort() uses _ascending_ order,
391 * so the smallest module is the one with the biggest score. */
392 return lb->i_score - la->i_score;
398 * Return the best module function, given a capability list.
400 * \param p_this the vlc object
401 * \param psz_capability list of capabilities needed
402 * \param psz_name name of the module asked
403 * \param b_strict if true, do not fallback to plugin with a different name
404 * but the same capability
405 * \return the module or NULL in case of a failure
407 module_t * __module_need( vlc_object_t *p_this, const char *psz_capability,
408 const char *psz_name, bool b_strict )
410 stats_TimerStart( p_this, "module_need()", STATS_TIMER_MODULE_NEED );
412 module_list_t *p_list;
415 char *psz_shortcuts = NULL, *psz_var = NULL, *psz_alias = NULL;
416 bool b_force_backup = p_this->b_force;
418 /* Deal with variables */
419 if( psz_name && psz_name[0] == '$' )
421 psz_name = psz_var = var_CreateGetString( p_this, psz_name + 1 );
424 /* Count how many different shortcuts were asked for */
425 if( psz_name && *psz_name )
427 char *psz_parser, *psz_last_shortcut;
429 /* If the user wants none, give him none. */
430 if( !strcmp( psz_name, "none" ) )
433 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
434 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
435 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
440 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
442 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
444 if( *psz_parser == ',' )
448 psz_last_shortcut = psz_parser + 1;
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 ) );
472 unsigned i_cpu = vlc_CPU();
474 /* Parse the module list for capabilities and probe each of them */
476 for (size_t i = 0; (p_module = p_all[i]) != NULL; i++)
478 bool b_shortcut_bonus = false;
480 /* Test that this module can do what we need */
481 if( !module_provides( p_module, psz_capability ) )
483 /* Test if we have the required CPU */
484 if( (p_module->i_cpu & i_cpu) != p_module->i_cpu )
487 /* If we required a shortcut, check this plugin provides it. */
488 if( i_shortcuts > 0 )
490 const char *name = psz_shortcuts;
492 for( unsigned i_short = i_shortcuts; i_short > 0; i_short-- )
494 for( unsigned i = 0; p_module->pp_shortcuts[i]; i++ )
497 if( ( c = strchr( name, '@' ) )
498 ? !strncasecmp( name, p_module->pp_shortcuts[i],
500 : !strcasecmp( name, p_module->pp_shortcuts[i] ) )
505 b_shortcut_bonus = true;
510 /* Go to the next shortcut... This is so lame! */
511 name += strlen( name ) + 1;
514 /* If we are in "strict" mode and we couldn't
515 * find the module in the list of provided shortcuts,
516 * then kick the bastard out of here!!! */
521 /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
522 if( p_module->i_score <= 0 )
526 /* Store this new module */
527 p_list[count].p_module = module_hold (p_module);
528 p_list[count].i_score = p_module->i_score;
529 if( b_shortcut_bonus )
530 p_list[count].i_score += 10000;
531 p_list[count].b_force = b_shortcut_bonus && b_strict;
535 /* We can release the list, interesting modules are held */
536 module_list_free (p_all);
538 /* Sort candidates by descending score */
539 qsort (p_list, count, sizeof (p_list[0]), modulecmp);
540 msg_Dbg( p_this, "looking for %s module: %zu candidate%s", psz_capability,
541 count, count == 1 ? "" : "s" );
543 /* Parse the linked list and use the first successful module */
545 for (size_t i = 0; (i < count) && (p_module == NULL); i++)
547 module_t *p_cand = p_list[i].p_module;
548 #ifdef HAVE_DYNAMIC_PLUGINS
549 /* Make sure the module is loaded in mem */
550 module_t *p_real = p_cand->b_submodule ? p_cand->parent : p_cand;
552 if( !p_real->b_builtin && !p_real->b_loaded )
554 module_t *p_new_module =
555 AllocatePlugin( p_this, p_real->psz_filename );
556 if( p_new_module == NULL )
557 { /* Corrupted module */
558 msg_Err( p_this, "possibly corrupt module cache" );
559 module_release( p_cand );
562 CacheMerge( p_this, p_real, p_new_module );
563 DeleteModule( p_module_bank, p_new_module );
567 p_this->b_force = p_list[i].b_force;
569 int ret = VLC_SUCCESS;
570 if( p_cand->pf_activate )
571 ret = p_cand->pf_activate( p_this );
580 /* good module, but aborted */
581 module_release( p_cand );
584 default: /* bad module */
585 module_release( p_cand );
589 /* Release the remaining modules */
591 module_release (p_list[i].p_module);
595 p_this->b_force = b_force_backup;
597 if( p_module != NULL )
599 msg_Dbg( p_this, "using %s module \"%s\"",
600 psz_capability, p_module->psz_object_name );
601 vlc_object_set_name( p_this, psz_alias ? psz_alias
602 : p_module->psz_object_name );
604 else if( count == 0 )
606 if( !strcmp( psz_capability, "access_demux" )
607 || !strcmp( psz_capability, "stream_filter" )
608 || !strcmp( psz_capability, "vout_window" ) )
610 msg_Dbg( p_this, "no %s module matched \"%s\"",
611 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
615 msg_Err( p_this, "no %s module matched \"%s\"",
616 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
618 msg_StackSet( VLC_EGENERIC, "no %s module matched \"%s\"",
619 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
622 else if( psz_name != NULL && *psz_name )
624 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
625 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
628 msg_StackSet( VLC_EGENERIC, "no suitable %s module", psz_capability );
630 free( psz_shortcuts );
633 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
634 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
635 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
637 /* Don't forget that the module is still locked */
644 * This function must be called by the thread that called module_need, to
645 * decrease the reference count and allow for hiding of modules.
646 * \param p_this vlc object structure
647 * \param p_module the module structure
650 void __module_unneed( vlc_object_t * p_this, module_t * p_module )
652 /* Use the close method */
653 if( p_module->pf_deactivate )
655 p_module->pf_deactivate( p_this );
658 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
660 module_release( p_module );
664 * Get a pointer to a module_t given it's name.
666 * \param psz_name the name of the module
667 * \return a pointer to the module or NULL in case of a failure
669 module_t *module_find( const char * psz_name )
671 module_t **list, *module;
673 list = module_list_get (NULL);
677 for (size_t i = 0; (module = list[i]) != NULL; i++)
679 const char *psz_module_name = module->psz_object_name;
681 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
683 module_hold (module);
687 module_list_free (list);
692 * Tell if a module exists and release it in thic case
694 * \param psz_name th name of the module
695 * \return TRUE if the module exists
697 bool module_exists (const char * psz_name)
699 module_t *p_module = module_find (psz_name);
701 module_release (p_module);
702 return p_module != NULL;
706 * Get a pointer to a module_t that matches a shortcut.
707 * This is a temporary hack for SD. Do not re-use (generally multiple modules
708 * can have the same shortcut, so this is *broken* - use module_need()!).
710 * \param psz_shortcut shortcut of the module
711 * \param psz_cap capability of the module
712 * \return a pointer to the module or NULL in case of a failure
714 module_t *module_find_by_shortcut (const char *psz_shortcut)
716 module_t **list, *module;
718 list = module_list_get (NULL);
722 for (size_t i = 0; (module = list[i]) != NULL; i++)
725 (module->pp_shortcuts[j] != NULL) && (j < MODULE_SHORTCUT_MAX);
728 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
730 module_hold (module);
736 module_list_free (list);
741 * Get the configuration of a module
743 * \param module the module
744 * \param psize the size of the configuration returned
745 * \return the configuration as an array
747 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
750 unsigned size = module->confsize;
751 module_config_t *config = malloc( size * sizeof( *config ) );
753 assert( psize != NULL );
759 for( i = 0, j = 0; i < size; i++ )
761 const module_config_t *item = module->p_config + i;
762 if( item->b_internal /* internal option */
763 || item->b_unsaveable /* non-modifiable option */
764 || item->b_removed /* removed option */ )
767 memcpy( config + j, item, sizeof( *config ) );
776 * Release the configuration
778 * \param the configuration
781 void module_config_free( module_config_t *config )
786 /*****************************************************************************
787 * Following functions are local.
788 *****************************************************************************/
790 /*****************************************************************************
791 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
793 *****************************************************************************/
794 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
798 bool escaped = false;
802 /* Alloc a buffer to store the path */
803 path = malloc( strlen( paths ) + 1 );
804 if( !path ) return NULL;
806 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
807 for( i = 0, done = 0 ; paths[i]; i++ )
809 /* Take care of \\ and \: or \; escapement */
813 path[done++] = paths[i];
816 else if( paths[i] == '/' )
819 else if( paths[i] == '\\' )
822 else if( paths[i] == PATH_SEP_CHAR )
825 path[done++] = paths[i];
829 /* Return the remaining paths */
830 if( remaining_paths ) {
831 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
837 char *psz_vlcpath = NULL;
839 /*****************************************************************************
840 * AllocateAllPlugins: load all plugin modules we can find.
841 *****************************************************************************/
842 #ifdef HAVE_DYNAMIC_PLUGINS
843 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
845 const char *vlcpath = psz_vlcpath;
848 vlc_array_t *arraypaths = vlc_array_new();
850 /* Contruct the special search path for system that have a relocatable
851 * executable. Set it to <vlc path>/modules and <vlc path>/plugins. */
853 if( vlcpath && asprintf( &path, "%s" DIR_SEP "modules", vlcpath ) != -1 )
854 vlc_array_append( arraypaths, path );
855 if( vlcpath && asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
856 vlc_array_append( arraypaths, path );
858 vlc_array_append( arraypaths, strdup( PLUGIN_PATH ) );
861 /* If the user provided a plugin path, we add it to the list */
862 char *userpaths = config_GetPsz( p_this, "plugin-path" );
865 for( paths_iter = userpaths; paths_iter; )
867 path = copy_next_paths_token( paths_iter, &paths_iter );
869 vlc_array_append( arraypaths, path );
872 count = vlc_array_count( arraypaths );
873 for( i = 0 ; i < count ; i++ )
875 path = vlc_array_item_at_index( arraypaths, i );
879 msg_Dbg( p_this, "recursively browsing `%s'", path );
881 /* Don't go deeper than 5 subdirectories */
882 AllocatePluginDir( p_this, p_bank, path, 5 );
887 vlc_array_destroy( arraypaths );
891 /*****************************************************************************
892 * AllocatePluginDir: recursively parse a directory to look for plugins
893 *****************************************************************************/
894 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
895 const char *psz_dir, unsigned i_maxdepth )
897 if( i_maxdepth == 0 )
900 DIR *dh = utf8_opendir (psz_dir);
904 /* Parse the directory and try to load all files it contains. */
907 char *file = utf8_readdir (dh), *path;
914 if (!strcmp (file, ".") || !strcmp (file, ".."))
920 const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
922 if (pathlen == -1 || utf8_stat (path, &st))
925 if (S_ISDIR (st.st_mode))
926 /* Recurse into another directory */
927 AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
929 if (S_ISREG (st.st_mode)
930 && ((size_t)pathlen >= strlen (LIBEXT))
931 && !strncasecmp (path + pathlen - strlen (LIBEXT), LIBEXT,
933 /* ^^ We only load files ending with LIBEXT */
934 AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
941 /*****************************************************************************
942 * AllocatePluginFile: load a module into memory and initialize it.
943 *****************************************************************************
944 * This function loads a dynamically loadable module and allocates a structure
945 * for its information data. The module can then be handled by module_need
946 * and module_unneed. It can be removed by DeleteModule.
947 *****************************************************************************/
948 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
949 const char *psz_file,
950 int64_t i_file_time, int64_t i_file_size )
952 module_t * p_module = NULL;
953 module_cache_t *p_cache_entry = NULL;
956 * Check our plugins cache first then load plugin if needed
958 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
961 p_module = AllocatePlugin( p_this, psz_file );
964 /* If junk dll, don't try to load it */
965 if( p_cache_entry->b_junk )
969 module_config_t *p_item = NULL, *p_end = NULL;
971 p_module = p_cache_entry->p_module;
972 p_module->b_loaded = false;
974 /* For now we force loading if the module's config contains
975 * callbacks or actions.
976 * Could be optimized by adding an API call.*/
977 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
978 p_item < p_end; p_item++ )
980 if( p_item->pf_callback || p_item->i_action )
982 p_module = AllocatePlugin( p_this, psz_file );
986 if( p_module == p_cache_entry->p_module )
987 p_cache_entry->b_used = true;
990 if( p_module == NULL )
993 /* Everything worked fine !
994 * The module is ready to be added to the list. */
995 p_module->b_builtin = false;
997 /* msg_Dbg( p_this, "plugin \"%s\", %s",
998 p_module->psz_object_name, p_module->psz_longname ); */
999 p_module->next = p_bank->head;
1000 p_bank->head = p_module;
1002 if( !p_module_bank->b_cache )
1005 /* Add entry to cache */
1006 module_cache_t **pp_cache = p_bank->pp_cache;
1008 pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
1009 if( pp_cache == NULL )
1011 pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
1012 if( pp_cache[p_bank->i_cache] == NULL )
1014 pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
1015 pp_cache[p_bank->i_cache]->i_time = i_file_time;
1016 pp_cache[p_bank->i_cache]->i_size = i_file_size;
1017 pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
1018 pp_cache[p_bank->i_cache]->b_used = true;
1019 pp_cache[p_bank->i_cache]->p_module = p_module;
1020 p_bank->pp_cache = pp_cache;
1025 /*****************************************************************************
1026 * AllocatePlugin: load a module into memory and initialize it.
1027 *****************************************************************************
1028 * This function loads a dynamically loadable module and allocates a structure
1029 * for its information data. The module can then be handled by module_need
1030 * and module_unneed. It can be removed by DeleteModule.
1031 *****************************************************************************/
1032 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1034 module_t * p_module = NULL;
1035 module_handle_t handle;
1037 if( module_Load( p_this, psz_file, &handle ) )
1040 /* Now that we have successfully loaded the module, we can
1041 * allocate a structure for it */
1042 p_module = vlc_module_create( p_this );
1043 if( p_module == NULL )
1045 module_Unload( handle );
1049 p_module->psz_filename = strdup( psz_file );
1050 p_module->handle = handle;
1051 p_module->b_loaded = true;
1053 /* Initialize the module: fill p_module, default config */
1054 if( module_Call( p_this, p_module ) != 0 )
1056 /* We couldn't call module_init() */
1057 free( p_module->psz_filename );
1058 module_release( p_module );
1059 module_Unload( handle );
1063 DupModule( p_module );
1065 /* Everything worked fine ! The module is ready to be added to the list. */
1066 p_module->b_builtin = false;
1071 /*****************************************************************************
1072 * DupModule: make a plugin module standalone.
1073 *****************************************************************************
1074 * This function duplicates all strings in the module, so that the dynamic
1075 * object can be unloaded. It acts recursively on submodules.
1076 *****************************************************************************/
1077 static void DupModule( module_t *p_module )
1081 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1083 *pp_shortcut = strdup( *pp_shortcut );
1086 /* We strdup() these entries so that they are still valid when the
1087 * module is unloaded. */
1088 p_module->psz_capability = strdup( p_module->psz_capability );
1089 p_module->psz_shortname = p_module->psz_shortname ?
1090 strdup( p_module->psz_shortname ) : NULL;
1091 p_module->psz_longname = strdup( p_module->psz_longname );
1092 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1095 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1099 /*****************************************************************************
1100 * UndupModule: free a duplicated module.
1101 *****************************************************************************
1102 * This function frees the allocations done in DupModule().
1103 *****************************************************************************/
1104 static void UndupModule( module_t *p_module )
1108 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1111 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1113 free( *pp_shortcut );
1116 free( p_module->psz_capability );
1117 FREENULL( p_module->psz_shortname );
1118 free( p_module->psz_longname );
1119 FREENULL( p_module->psz_help );
1122 #endif /* HAVE_DYNAMIC_PLUGINS */
1124 /*****************************************************************************
1125 * AllocateBuiltinModule: initialize a builtin module.
1126 *****************************************************************************
1127 * This function registers a builtin module and allocates a structure
1128 * for its information data. The module can then be handled by module_need
1129 * and module_unneed. It can be removed by DeleteModule.
1130 *****************************************************************************/
1131 static int AllocateBuiltinModule( vlc_object_t * p_this,
1132 int ( *pf_entry ) ( module_t * ) )
1134 module_t * p_module;
1136 /* Now that we have successfully loaded the module, we can
1137 * allocate a structure for it */
1138 p_module = vlc_module_create( p_this );
1139 if( p_module == NULL )
1142 /* Initialize the module : fill p_module->psz_object_name, etc. */
1143 if( pf_entry( p_module ) != 0 )
1145 /* With a well-written module we shouldn't have to print an
1146 * additional error message here, but just make sure. */
1147 msg_Err( p_this, "failed calling entry point in builtin module" );
1148 module_release( p_module );
1152 /* Everything worked fine ! The module is ready to be added to the list. */
1153 p_module->b_builtin = true;
1155 p_module->next = p_module_bank->head;
1156 p_module_bank->head = p_module;
1159 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1160 p_module->psz_object_name, p_module->psz_longname ); */
1165 /*****************************************************************************
1166 * DeleteModule: delete a module and its structure.
1167 *****************************************************************************
1168 * This function can only be called if the module isn't being used.
1169 *****************************************************************************/
1170 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1174 /* Unlist the module (if it is in the list) */
1175 module_t **pp_self = &p_bank->head;
1176 while (*pp_self != NULL && *pp_self != p_module)
1177 pp_self = &((*pp_self)->next);
1179 *pp_self = p_module->next;
1181 /* We free the structures that we strdup()ed in Allocate*Module(). */
1182 #ifdef HAVE_DYNAMIC_PLUGINS
1183 if( !p_module->b_builtin )
1185 if( p_module->b_loaded && p_module->b_unloadable )
1187 module_Unload( p_module->handle );
1189 UndupModule( p_module );
1190 free( p_module->psz_filename );
1194 /* Free and detach the object's children */
1195 while (p_module->submodule)
1197 module_t *submodule = p_module->submodule;
1198 p_module->submodule = submodule->next;
1199 module_release (submodule);
1202 config_Free( p_module );
1203 module_release( p_module );