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>
34 #include <vlc_modules.h>
37 #include <stdlib.h> /* free(), strtol() */
38 #include <stdio.h> /* sprintf() */
39 #include <string.h> /* strdup() */
46 #include <sys/types.h>
47 #ifdef HAVE_SYS_STAT_H
48 # include <sys/stat.h>
57 #include "config/configuration.h"
60 #include "vlc_arrays.h"
62 #include "modules/modules.h"
64 static module_bank_t *p_module_bank = NULL;
65 static vlc_mutex_t module_lock = VLC_STATIC_MUTEX;
67 int vlc_entry__main( module_t * );
69 /*****************************************************************************
71 *****************************************************************************/
72 #ifdef HAVE_DYNAMIC_PLUGINS
73 static void AllocateAllPlugins( vlc_object_t *, module_bank_t * );
74 static void AllocatePluginDir( vlc_object_t *, module_bank_t *, const char *,
76 static int AllocatePluginFile( vlc_object_t *, module_bank_t *, const char *,
78 static module_t * AllocatePlugin( vlc_object_t *, const char * );
80 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
81 static void DeleteModule ( module_bank_t *, module_t * );
82 #ifdef HAVE_DYNAMIC_PLUGINS
83 static void DupModule ( module_t * );
84 static void UndupModule ( module_t * );
87 #undef module_InitBank
91 * Creates a module bank structure which will be filled later
92 * on with all the modules found.
93 * \param p_this vlc object structure
96 void module_InitBank( vlc_object_t *p_this )
98 module_bank_t *p_bank = NULL;
100 vlc_mutex_lock( &module_lock );
102 if( p_module_bank == NULL )
104 p_bank = calloc (1, sizeof(*p_bank));
106 p_bank->i_cache = p_bank->i_loaded_cache = 0;
107 p_bank->pp_cache = p_bank->pp_loaded_cache = NULL;
108 p_bank->b_cache = p_bank->b_cache_dirty = false;
111 /* Everything worked, attach the object */
112 p_module_bank = p_bank;
114 /* Fills the module bank structure with the main module infos.
115 * This is very useful as it will allow us to consider the main
116 * library just as another module, and for instance the configuration
117 * options of main will be available in the module bank structure just
118 * as for every other module. */
119 AllocateBuiltinModule( p_this, vlc_entry__main );
120 vlc_rwlock_init (&config_lock);
121 config_SortConfig ();
124 p_module_bank->i_usage++;
126 /* We do retain the module bank lock until the plugins are loaded as well.
127 * This is ugly, this staged loading approach is needed: LibVLC gets
128 * some configuration parameters relevant to loading the plugins from
129 * the main (builtin) module. The module bank becomes shared read-only data
130 * once it is ready, so we need to fully serialize initialization.
131 * DO NOT UNCOMMENT the following line unless you managed to squeeze
132 * module_LoadPlugins() before you unlock the mutex. */
133 /*vlc_mutex_unlock( &module_lock );*/
136 #undef module_EndBank
138 * Unloads all unused plugin modules and empties the module
139 * bank in case of success.
140 * \param p_this vlc object structure
143 void module_EndBank( vlc_object_t *p_this, bool b_plugins )
145 module_bank_t *p_bank = p_module_bank;
147 assert (p_bank != NULL);
149 /* Save the configuration */
150 if( !var_InheritBool( p_this, "ignore-config" ) )
151 config_AutoSaveConfigFile( p_this );
153 /* If plugins were _not_ loaded, then the caller still has the bank lock
154 * from module_InitBank(). */
156 vlc_mutex_lock( &module_lock );
158 vlc_assert_locked( &module_lock ); not for static mutexes :( */
160 if( --p_bank->i_usage > 0 )
162 vlc_mutex_unlock( &module_lock );
166 config_UnsortConfig ();
167 vlc_rwlock_destroy (&config_lock);
168 p_module_bank = NULL;
169 vlc_mutex_unlock( &module_lock );
171 #ifdef HAVE_DYNAMIC_PLUGINS
172 while( p_bank->i_loaded_cache-- )
174 if( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] )
176 DeleteModule( p_bank,
177 p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->p_module );
178 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache]->psz_file );
179 free( p_bank->pp_loaded_cache[p_bank->i_loaded_cache] );
182 free( p_bank->pp_loaded_cache );
183 while( p_bank->i_cache-- )
185 free( p_bank->pp_cache[p_bank->i_cache]->psz_file );
186 free( p_bank->pp_cache[p_bank->i_cache] );
188 free( p_bank->pp_cache );
191 while( p_bank->head != NULL )
192 DeleteModule( p_bank, p_bank->head );
197 #undef module_LoadPlugins
199 * Loads module descriptions for all available plugins.
200 * Fills the module bank structure with the plugin modules.
202 * \param p_this vlc object structure
205 void module_LoadPlugins( vlc_object_t * p_this )
207 module_bank_t *p_bank = p_module_bank;
210 /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
212 #ifdef HAVE_DYNAMIC_PLUGINS
213 if( p_bank->i_usage == 1 )
215 msg_Dbg( p_this, "checking plugin modules" );
216 p_module_bank->b_cache = var_InheritBool( p_this, "plugins-cache" );
218 AllocateAllPlugins( p_this, p_module_bank );
219 config_UnsortConfig ();
220 config_SortConfig ();
223 vlc_mutex_unlock( &module_lock );
227 * Checks whether a module implements a capability.
229 * \param m the module
230 * \param cap the capability to check
231 * \return TRUE if the module have the capability
233 bool module_provides( const module_t *m, const char *cap )
235 return !strcmp( m->psz_capability, cap );
239 * Get the internal name of a module
241 * \param m the module
242 * \return the module name
244 const char *module_get_object( const module_t *m )
246 return m->psz_object_name;
250 * Get the human-friendly name of a module.
252 * \param m the module
253 * \param long_name TRUE to have the long name of the module
254 * \return the short or long name of the module
256 const char *module_get_name( const module_t *m, bool long_name )
258 if( long_name && ( m->psz_longname != NULL) )
259 return m->psz_longname;
261 return m->psz_shortname ? m->psz_shortname : m->psz_object_name;
265 * Get the help for a module
267 * \param m the module
270 const char *module_get_help( const module_t *m )
276 * Get the capability for a module
278 * \param m the module
279 * return the capability
281 const char *module_get_capability( const module_t *m )
283 return m->psz_capability;
287 * Get the score for a module
289 * \param m the module
290 * return the score for the capability
292 int module_get_score( const module_t *m )
298 * Translate a string using the module's text domain
300 * \param m the module
301 * \param str the American English ASCII string to localize
302 * \return the gettext-translated string
304 const char *module_gettext (const module_t *m, const char *str)
307 const char *domain = m->domain ? m->domain : PACKAGE_NAME;
308 return dgettext (domain, str);
315 module_t *module_hold (module_t *m)
317 vlc_hold (&m->vlc_gc_data);
321 void module_release (module_t *m)
323 vlc_release (&m->vlc_gc_data);
327 * Frees the flat list of VLC modules.
328 * @param list list obtained by module_list_get()
329 * @param length number of items on the list
332 void module_list_free (module_t **list)
337 for (size_t i = 0; list[i] != NULL; i++)
338 module_release (list[i]);
343 * Gets the flat list of VLC modules.
344 * @param n [OUT] pointer to the number of modules or NULL
345 * @return NULL-terminated table of module pointers
346 * (release with module_list_free()), or NULL in case of error.
348 module_t **module_list_get (size_t *n)
350 /* TODO: this whole module lookup is quite inefficient */
351 /* Remove this and improve module_need */
352 module_t **tab = NULL;
355 assert (p_module_bank);
356 for (module_t *mod = p_module_bank->head; mod; mod = mod->next)
359 nt = realloc (tab, (i + 2 + mod->submodule_count) * sizeof (*tab));
362 module_list_free (tab);
367 tab[i++] = module_hold (mod);
368 for (module_t *subm = mod->submodule; subm; subm = subm->next)
369 tab[i++] = module_hold (subm);
377 typedef struct module_list_t
384 static int modulecmp (const void *a, const void *b)
386 const module_list_t *la = a, *lb = b;
387 /* Note that qsort() uses _ascending_ order,
388 * so the smallest module is the one with the biggest score. */
389 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; i < p_module->i_shortcuts; 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 )
594 msg_Dbg( p_this, "no %s module matched \"%s\"",
595 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
597 msg_Dbg( p_this, "no %s module matching \"%s\" could be loaded",
598 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
600 free( psz_shortcuts );
603 stats_TimerStop( p_this, STATS_TIMER_MODULE_NEED );
604 stats_TimerDump( p_this, STATS_TIMER_MODULE_NEED );
605 stats_TimerClean( p_this, STATS_TIMER_MODULE_NEED );
607 /* Don't forget that the module is still locked */
615 * This function must be called by the thread that called module_need, to
616 * decrease the reference count and allow for hiding of modules.
617 * \param p_this vlc object structure
618 * \param p_module the module structure
621 void module_unneed( vlc_object_t * p_this, module_t * p_module )
623 /* Use the close method */
624 if( p_module->pf_deactivate )
626 p_module->pf_deactivate( p_this );
629 msg_Dbg( p_this, "removing module \"%s\"", p_module->psz_object_name );
631 module_release( p_module );
635 * Get a pointer to a module_t given it's name.
637 * \param psz_name the name of the module
638 * \return a pointer to the module or NULL in case of a failure
640 module_t *module_find( const char * psz_name )
642 module_t **list, *module;
644 list = module_list_get (NULL);
648 for (size_t i = 0; (module = list[i]) != NULL; i++)
650 const char *psz_module_name = module->psz_object_name;
652 if( psz_module_name && !strcmp( psz_module_name, psz_name ) )
654 module_hold (module);
658 module_list_free (list);
663 * Tell if a module exists and release it in thic case
665 * \param psz_name th name of the module
666 * \return TRUE if the module exists
668 bool module_exists (const char * psz_name)
670 module_t *p_module = module_find (psz_name);
672 module_release (p_module);
673 return p_module != NULL;
677 * Get a pointer to a module_t that matches a shortcut.
678 * This is a temporary hack for SD. Do not re-use (generally multiple modules
679 * can have the same shortcut, so this is *broken* - use module_need()!).
681 * \param psz_shortcut shortcut of the module
682 * \param psz_cap capability of the module
683 * \return a pointer to the module or NULL in case of a failure
685 module_t *module_find_by_shortcut (const char *psz_shortcut)
687 module_t **list, *module;
689 list = module_list_get (NULL);
693 for (size_t i = 0; (module = list[i]) != NULL; i++)
695 for (size_t j = 0; j < module->i_shortcuts; j++)
697 if (!strcmp (module->pp_shortcuts[j], psz_shortcut))
699 module_hold (module);
705 module_list_free (list);
710 * Get the configuration of a module
712 * \param module the module
713 * \param psize the size of the configuration returned
714 * \return the configuration as an array
716 module_config_t *module_config_get( const module_t *module, unsigned *restrict psize )
719 unsigned size = module->confsize;
720 module_config_t *config = malloc( size * sizeof( *config ) );
722 assert( psize != NULL );
728 for( i = 0, j = 0; i < size; i++ )
730 const module_config_t *item = module->p_config + i;
731 if( item->b_internal /* internal option */
732 || item->b_removed /* removed option */ )
735 memcpy( config + j, item, sizeof( *config ) );
744 * Release the configuration
746 * \param the configuration
749 void module_config_free( module_config_t *config )
754 /*****************************************************************************
755 * Following functions are local.
756 *****************************************************************************/
758 /*****************************************************************************
759 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
761 *****************************************************************************/
762 static char * copy_next_paths_token( char * paths, char ** remaining_paths )
766 bool escaped = false;
770 /* Alloc a buffer to store the path */
771 path = malloc( strlen( paths ) + 1 );
772 if( !path ) return NULL;
774 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
775 for( i = 0, done = 0 ; paths[i]; i++ )
777 /* Take care of \\ and \: or \; escapement */
781 path[done++] = paths[i];
784 else if( paths[i] == '/' )
787 else if( paths[i] == '\\' )
790 else if( paths[i] == PATH_SEP_CHAR )
793 path[done++] = paths[i];
797 /* Return the remaining paths */
798 if( remaining_paths ) {
799 *remaining_paths = paths[i] ? &paths[i]+1 : NULL;
805 char *psz_vlcpath = NULL;
807 /*****************************************************************************
808 * AllocateAllPlugins: load all plugin modules we can find.
809 *****************************************************************************/
810 #ifdef HAVE_DYNAMIC_PLUGINS
811 static void AllocateAllPlugins( vlc_object_t *p_this, module_bank_t *p_bank )
813 const char *vlcpath = psz_vlcpath;
816 vlc_array_t *arraypaths = vlc_array_new();
817 const bool b_reset = var_InheritBool( p_this, "reset-plugins-cache" );
819 /* Contruct the special search path for system that have a relocatable
820 * executable. Set it to <vlc path>/plugins. */
823 if( asprintf( &path, "%s" DIR_SEP "plugins", vlcpath ) != -1 )
824 vlc_array_append( arraypaths, path );
826 /* If the user provided a plugin path, we add it to the list */
827 char *userpaths = var_InheritString( p_this, "plugin-path" );
830 for( paths_iter = userpaths; paths_iter; )
832 path = copy_next_paths_token( paths_iter, &paths_iter );
834 vlc_array_append( arraypaths, path );
837 count = vlc_array_count( arraypaths );
838 for( i = 0 ; i < count ; i++ )
840 path = vlc_array_item_at_index( arraypaths, i );
844 size_t offset = p_module_bank->i_cache;
846 CacheDelete( p_this, path );
848 CacheLoad( p_this, p_module_bank, path );
850 msg_Dbg( p_this, "recursively browsing `%s'", path );
852 /* Don't go deeper than 5 subdirectories */
853 AllocatePluginDir( p_this, p_bank, path, 5 );
856 CacheSave( p_this, path, p_module_bank->pp_cache + offset,
857 p_module_bank->i_cache - offset );
861 vlc_array_destroy( arraypaths );
865 /*****************************************************************************
866 * AllocatePluginDir: recursively parse a directory to look for plugins
867 *****************************************************************************/
868 static void AllocatePluginDir( vlc_object_t *p_this, module_bank_t *p_bank,
869 const char *psz_dir, unsigned i_maxdepth )
871 if( i_maxdepth == 0 )
874 DIR *dh = vlc_opendir (psz_dir);
878 /* Parse the directory and try to load all files it contains. */
881 char *file = vlc_readdir (dh), *path;
888 if (!strcmp (file, ".") || !strcmp (file, "..")
889 /* Skip directories for unsupported optimizations */
890 || !vlc_CPU_CheckPluginDir (file))
896 const int pathlen = asprintf (&path, "%s"DIR_SEP"%s", psz_dir, file);
898 if (pathlen == -1 || vlc_stat (path, &st))
901 if (S_ISDIR (st.st_mode))
902 /* Recurse into another directory */
903 AllocatePluginDir (p_this, p_bank, path, i_maxdepth - 1);
905 if (S_ISREG (st.st_mode)
906 && strncmp (path, "lib", 3)
907 && ((size_t)pathlen >= sizeof ("_plugin"LIBEXT))
908 && !strncasecmp (path + pathlen - strlen ("_plugin"LIBEXT),
909 "_plugin"LIBEXT, strlen ("_plugni"LIBEXT)))
910 /* ^^ We only load files matching "lib*_plugin"LIBEXT */
911 AllocatePluginFile (p_this, p_bank, path, st.st_mtime, st.st_size);
918 /*****************************************************************************
919 * AllocatePluginFile: load a module into memory and initialize it.
920 *****************************************************************************
921 * This function loads a dynamically loadable module and allocates a structure
922 * for its information data. The module can then be handled by module_need
923 * and module_unneed. It can be removed by DeleteModule.
924 *****************************************************************************/
925 static int AllocatePluginFile( vlc_object_t * p_this, module_bank_t *p_bank,
926 const char *psz_file,
927 int64_t i_file_time, int64_t i_file_size )
929 module_t * p_module = NULL;
930 module_cache_t *p_cache_entry = NULL;
933 * Check our plugins cache first then load plugin if needed
935 p_cache_entry = CacheFind( p_bank, psz_file, i_file_time, i_file_size );
938 p_module = AllocatePlugin( p_this, psz_file );
942 module_config_t *p_item = NULL, *p_end = NULL;
944 p_module = p_cache_entry->p_module;
945 p_module->b_loaded = false;
947 /* If plugin-path contains duplicate entries... */
948 if( p_module->next != NULL )
949 return 0; /* already taken care of that one */
951 /* For now we force loading if the module's config contains
952 * callbacks or actions.
953 * Could be optimized by adding an API call.*/
954 for( p_item = p_module->p_config, p_end = p_item + p_module->confsize;
955 p_item < p_end; p_item++ )
957 if( p_item->pf_callback || p_item->i_action )
959 p_module = AllocatePlugin( p_this, psz_file );
965 if( p_module == NULL )
968 /* We have not already scanned and inserted this module */
969 assert( p_module->next == NULL );
971 /* Everything worked fine !
972 * The module is ready to be added to the list. */
973 p_module->b_builtin = false;
975 /* msg_Dbg( p_this, "plugin \"%s\", %s",
976 p_module->psz_object_name, p_module->psz_longname ); */
977 p_module->next = p_bank->head;
978 p_bank->head = p_module;
979 assert( p_module->next != NULL ); /* Insertion done */
981 if( !p_module_bank->b_cache )
984 /* Add entry to cache */
985 module_cache_t **pp_cache = p_bank->pp_cache;
987 pp_cache = realloc_or_free( pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
988 if( pp_cache == NULL )
990 pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
991 if( pp_cache[p_bank->i_cache] == NULL )
993 pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
994 pp_cache[p_bank->i_cache]->i_time = i_file_time;
995 pp_cache[p_bank->i_cache]->i_size = i_file_size;
996 pp_cache[p_bank->i_cache]->p_module = p_module;
997 p_bank->pp_cache = pp_cache;
1002 /*****************************************************************************
1003 * AllocatePlugin: load a module into memory and initialize it.
1004 *****************************************************************************
1005 * This function loads a dynamically loadable module and allocates a structure
1006 * for its information data. The module can then be handled by module_need
1007 * and module_unneed. It can be removed by DeleteModule.
1008 *****************************************************************************/
1009 static module_t * AllocatePlugin( vlc_object_t * p_this, const char *psz_file )
1011 module_t * p_module = NULL;
1012 module_handle_t handle;
1014 if( module_Load( p_this, psz_file, &handle ) )
1017 /* Now that we have successfully loaded the module, we can
1018 * allocate a structure for it */
1019 p_module = vlc_module_create( p_this );
1020 if( p_module == NULL )
1022 module_Unload( handle );
1026 p_module->psz_filename = strdup( psz_file );
1027 p_module->handle = handle;
1028 p_module->b_loaded = true;
1030 /* Initialize the module: fill p_module, default config */
1031 if( module_Call( p_this, p_module ) != 0 )
1033 /* We couldn't call module_init() */
1034 free( p_module->psz_filename );
1035 module_release( p_module );
1036 module_Unload( handle );
1040 DupModule( p_module );
1042 /* Everything worked fine ! The module is ready to be added to the list. */
1043 p_module->b_builtin = false;
1048 /*****************************************************************************
1049 * DupModule: make a plugin module standalone.
1050 *****************************************************************************
1051 * This function duplicates all strings in the module, so that the dynamic
1052 * object can be unloaded. It acts recursively on submodules.
1053 *****************************************************************************/
1054 static void DupModule( module_t *p_module )
1056 char **pp_shortcuts = p_module->pp_shortcuts;
1057 for( unsigned i = 0; i < p_module->i_shortcuts; i++ )
1058 pp_shortcuts[i] = strdup( p_module->pp_shortcuts[i] );
1060 /* We strdup() these entries so that they are still valid when the
1061 * module is unloaded. */
1062 p_module->psz_capability = strdup( p_module->psz_capability );
1063 p_module->psz_shortname = p_module->psz_shortname ?
1064 strdup( p_module->psz_shortname ) : NULL;
1065 p_module->psz_longname = strdup( p_module->psz_longname );
1066 p_module->psz_help = p_module->psz_help ? strdup( p_module->psz_help )
1068 p_module->domain = p_module->domain ? strdup( p_module->domain ) : NULL;
1070 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1074 /*****************************************************************************
1075 * UndupModule: free a duplicated module.
1076 *****************************************************************************
1077 * This function frees the allocations done in DupModule().
1078 *****************************************************************************/
1079 static void UndupModule( module_t *p_module )
1081 char **pp_shortcuts = p_module->pp_shortcuts;
1083 for (module_t *subm = p_module->submodule; subm; subm = subm->next)
1086 for( unsigned i = 0; i < p_module->i_shortcuts; i++ )
1087 free( pp_shortcuts[i] );
1089 free( p_module->psz_capability );
1090 FREENULL( p_module->psz_shortname );
1091 free( p_module->psz_longname );
1092 FREENULL( p_module->psz_help );
1093 free( p_module->domain );
1096 #endif /* HAVE_DYNAMIC_PLUGINS */
1098 /*****************************************************************************
1099 * AllocateBuiltinModule: initialize a builtin module.
1100 *****************************************************************************
1101 * This function registers a builtin module and allocates a structure
1102 * for its information data. The module can then be handled by module_need
1103 * and module_unneed. It can be removed by DeleteModule.
1104 *****************************************************************************/
1105 static int AllocateBuiltinModule( vlc_object_t * p_this,
1106 int ( *pf_entry ) ( module_t * ) )
1108 module_t * p_module;
1110 /* Now that we have successfully loaded the module, we can
1111 * allocate a structure for it */
1112 p_module = vlc_module_create( p_this );
1113 if( p_module == NULL )
1116 /* Initialize the module : fill p_module->psz_object_name, etc. */
1117 if( pf_entry( p_module ) != 0 )
1119 /* With a well-written module we shouldn't have to print an
1120 * additional error message here, but just make sure. */
1121 msg_Err( p_this, "failed calling entry point in builtin module" );
1122 module_release( p_module );
1126 /* Everything worked fine ! The module is ready to be added to the list. */
1127 p_module->b_builtin = true;
1129 p_module->next = p_module_bank->head;
1130 p_module_bank->head = p_module;
1133 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1134 p_module->psz_object_name, p_module->psz_longname ); */
1139 /*****************************************************************************
1140 * DeleteModule: delete a module and its structure.
1141 *****************************************************************************
1142 * This function can only be called if the module isn't being used.
1143 *****************************************************************************/
1144 static void DeleteModule( module_bank_t *p_bank, module_t * p_module )
1148 /* Unlist the module (if it is in the list) */
1149 module_t **pp_self = &p_bank->head;
1150 while (*pp_self != NULL && *pp_self != p_module)
1151 pp_self = &((*pp_self)->next);
1153 *pp_self = p_module->next;
1155 /* We free the structures that we strdup()ed in Allocate*Module(). */
1156 #ifdef HAVE_DYNAMIC_PLUGINS
1157 if( !p_module->b_builtin )
1159 if( p_module->b_loaded && p_module->b_unloadable )
1161 module_Unload( p_module->handle );
1163 UndupModule( p_module );
1164 free( p_module->psz_filename );
1168 /* Free and detach the object's children */
1169 while (p_module->submodule)
1171 module_t *submodule = p_module->submodule;
1172 p_module->submodule = submodule->next;
1173 module_release (submodule);
1176 config_Free( p_module );
1177 module_release( p_module );