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>
56 #include "config/configuration.h"
59 #include "vlc_arrays.h"
61 #include "modules/modules.h"
63 static module_bank_t
*p_module_bank
= NULL
;
64 static vlc_mutex_t module_lock
= VLC_STATIC_MUTEX
;
66 int vlc_entry__main( module_t
* );
68 /*****************************************************************************
70 *****************************************************************************/
71 #ifdef HAVE_DYNAMIC_PLUGINS
72 static void AllocateAllPlugins( vlc_object_t
*, module_bank_t
* );
73 static void AllocatePluginDir( vlc_object_t
*, module_bank_t
*, const char *,
75 static int AllocatePluginFile( vlc_object_t
*, module_bank_t
*, const char *,
77 static module_t
* AllocatePlugin( vlc_object_t
*, const char * );
79 static int AllocateBuiltinModule( vlc_object_t
*, int ( * ) ( module_t
* ) );
80 static void DeleteModule ( module_bank_t
*, module_t
* );
81 #ifdef HAVE_DYNAMIC_PLUGINS
82 static void DupModule ( module_t
* );
83 static void UndupModule ( module_t
* );
86 #undef module_InitBank
90 * Creates a module bank structure which will be filled later
91 * on with all the modules found.
92 * \param p_this vlc object structure
95 void module_InitBank( vlc_object_t
*p_this
)
97 module_bank_t
*p_bank
= NULL
;
99 vlc_mutex_lock( &module_lock
);
101 if( p_module_bank
== NULL
)
103 p_bank
= calloc (1, sizeof(*p_bank
));
105 p_bank
->i_cache
= p_bank
->i_loaded_cache
= 0;
106 p_bank
->pp_cache
= p_bank
->pp_loaded_cache
= NULL
;
107 p_bank
->b_cache
= p_bank
->b_cache_dirty
= false;
110 /* Everything worked, attach the object */
111 p_module_bank
= p_bank
;
113 /* Fills the module bank structure with the main module infos.
114 * This is very useful as it will allow us to consider the main
115 * library just as another module, and for instance the configuration
116 * options of main will be available in the module bank structure just
117 * as for every other module. */
118 AllocateBuiltinModule( p_this
, vlc_entry__main
);
119 vlc_rwlock_init (&config_lock
);
120 config_SortConfig ();
123 p_module_bank
->i_usage
++;
125 /* We do retain the module bank lock until the plugins are loaded as well.
126 * This is ugly, this staged loading approach is needed: LibVLC gets
127 * some configuration parameters relevant to loading the plugins from
128 * the main (builtin) module. The module bank becomes shared read-only data
129 * once it is ready, so we need to fully serialize initialization.
130 * DO NOT UNCOMMENT the following line unless you managed to squeeze
131 * module_LoadPlugins() before you unlock the mutex. */
132 /*vlc_mutex_unlock( &module_lock );*/
135 #undef module_EndBank
137 * Unloads all unused plugin modules and empties the module
138 * bank in case of success.
139 * \param p_this vlc object structure
142 void module_EndBank( vlc_object_t
*p_this
, bool b_plugins
)
144 module_bank_t
*p_bank
= p_module_bank
;
146 assert (p_bank
!= NULL
);
148 /* Save the configuration */
149 if( !var_InheritBool( p_this
, "ignore-config" ) )
150 config_AutoSaveConfigFile( p_this
);
152 /* If plugins were _not_ loaded, then the caller still has the bank lock
153 * from module_InitBank(). */
155 vlc_mutex_lock( &module_lock
);
157 vlc_assert_locked( &module_lock ); not for static mutexes :( */
159 if( --p_bank
->i_usage
> 0 )
161 vlc_mutex_unlock( &module_lock
);
165 config_UnsortConfig ();
166 vlc_rwlock_destroy (&config_lock
);
167 p_module_bank
= NULL
;
168 vlc_mutex_unlock( &module_lock
);
170 #ifdef HAVE_DYNAMIC_PLUGINS
171 while( p_bank
->i_loaded_cache
-- )
173 if( p_bank
->pp_loaded_cache
[p_bank
->i_loaded_cache
] )
175 DeleteModule( p_bank
,
176 p_bank
->pp_loaded_cache
[p_bank
->i_loaded_cache
]->p_module
);
177 free( p_bank
->pp_loaded_cache
[p_bank
->i_loaded_cache
]->psz_file
);
178 free( p_bank
->pp_loaded_cache
[p_bank
->i_loaded_cache
] );
181 free( p_bank
->pp_loaded_cache
);
182 while( p_bank
->i_cache
-- )
184 free( p_bank
->pp_cache
[p_bank
->i_cache
]->psz_file
);
185 free( p_bank
->pp_cache
[p_bank
->i_cache
] );
187 free( p_bank
->pp_cache
);
190 while( p_bank
->head
!= NULL
)
191 DeleteModule( p_bank
, p_bank
->head
);
196 #undef module_LoadPlugins
198 * Loads module descriptions for all available plugins.
199 * Fills the module bank structure with the plugin modules.
201 * \param p_this vlc object structure
204 void module_LoadPlugins( vlc_object_t
* p_this
)
206 module_bank_t
*p_bank
= p_module_bank
;
209 /*vlc_assert_locked( &module_lock ); not for static mutexes :( */
211 #ifdef HAVE_DYNAMIC_PLUGINS
212 if( p_bank
->i_usage
== 1 )
214 msg_Dbg( p_this
, "checking plugin modules" );
215 p_module_bank
->b_cache
= var_InheritBool( p_this
, "plugins-cache" );
217 AllocateAllPlugins( p_this
, p_module_bank
);
218 config_UnsortConfig ();
219 config_SortConfig ();
222 vlc_mutex_unlock( &module_lock
);
226 * Checks whether a module implements a capability.
228 * \param m the module
229 * \param cap the capability to check
230 * \return TRUE if the module have the capability
232 bool module_provides( const module_t
*m
, const char *cap
)
234 return !strcmp( m
->psz_capability
, cap
);
238 * Get the internal name of a module
240 * \param m the module
241 * \return the module name
243 const char *module_get_object( const module_t
*m
)
245 return m
->psz_object_name
;
249 * Get the human-friendly name of a module.
251 * \param m the module
252 * \param long_name TRUE to have the long name of the module
253 * \return the short or long name of the module
255 const char *module_get_name( const module_t
*m
, bool long_name
)
257 if( long_name
&& ( m
->psz_longname
!= NULL
) )
258 return m
->psz_longname
;
260 return m
->psz_shortname
? m
->psz_shortname
: m
->psz_object_name
;
264 * Get the help for a module
266 * \param m the module
269 const char *module_get_help( const module_t
*m
)
275 * Get the capability for a module
277 * \param m the module
278 * return the capability
280 const char *module_get_capability( const module_t
*m
)
282 return m
->psz_capability
;
286 * Get the score for a module
288 * \param m the module
289 * return the score for the capability
291 int module_get_score( const module_t
*m
)
297 * Translate a string using the module's text domain
299 * \param m the module
300 * \param str the American English ASCII string to localize
301 * \return the gettext-translated string
303 const char *module_gettext (const module_t
*m
, const char *str
)
306 const char *domain
= m
->domain
? m
->domain
: PACKAGE_NAME
;
307 return dgettext (domain
, str
);
314 module_t
*module_hold (module_t
*m
)
316 vlc_hold (&m
->vlc_gc_data
);
320 void module_release (module_t
*m
)
322 vlc_release (&m
->vlc_gc_data
);
326 * Frees the flat list of VLC modules.
327 * @param list list obtained by module_list_get()
328 * @param length number of items on the list
331 void module_list_free (module_t
**list
)
336 for (size_t i
= 0; list
[i
] != NULL
; i
++)
337 module_release (list
[i
]);
342 * Gets the flat list of VLC modules.
343 * @param n [OUT] pointer to the number of modules or NULL
344 * @return NULL-terminated table of module pointers
345 * (release with module_list_free()), or NULL in case of error.
347 module_t
**module_list_get (size_t *n
)
349 /* TODO: this whole module lookup is quite inefficient */
350 /* Remove this and improve module_need */
351 module_t
**tab
= NULL
;
354 assert (p_module_bank
);
355 for (module_t
*mod
= p_module_bank
->head
; mod
; mod
= mod
->next
)
358 nt
= realloc (tab
, (i
+ 2 + mod
->submodule_count
) * sizeof (*tab
));
361 module_list_free (tab
);
366 tab
[i
++] = module_hold (mod
);
367 for (module_t
*subm
= mod
->submodule
; subm
; subm
= subm
->next
)
368 tab
[i
++] = module_hold (subm
);
376 typedef struct module_list_t
383 static int modulecmp (const void *a
, const void *b
)
385 const module_list_t
*la
= a
, *lb
= b
;
386 /* Note that qsort() uses _ascending_ order,
387 * so the smallest module is the one with the biggest score. */
388 return lb
->i_score
- la
->i_score
;
395 * Return the best module function, given a capability list.
397 * \param p_this the vlc object
398 * \param psz_capability list of capabilities needed
399 * \param psz_name name of the module asked
400 * \param b_strict if true, do not fallback to plugin with a different name
401 * but the same capability
402 * \return the module or NULL in case of a failure
404 module_t
* module_need( vlc_object_t
*p_this
, const char *psz_capability
,
405 const char *psz_name
, bool b_strict
)
407 stats_TimerStart( p_this
, "module_need()", STATS_TIMER_MODULE_NEED
);
409 module_list_t
*p_list
;
412 char *psz_shortcuts
= NULL
, *psz_var
= NULL
, *psz_alias
= NULL
;
413 bool b_force_backup
= p_this
->b_force
;
415 /* Deal with variables */
416 if( psz_name
&& psz_name
[0] == '$' )
418 psz_name
= psz_var
= var_CreateGetString( p_this
, psz_name
+ 1 );
421 /* Count how many different shortcuts were asked for */
422 if( psz_name
&& *psz_name
)
424 char *psz_parser
, *psz_last_shortcut
;
426 /* If the user wants none, give him none. */
427 if( !strcmp( psz_name
, "none" ) )
430 stats_TimerStop( p_this
, STATS_TIMER_MODULE_NEED
);
431 stats_TimerDump( p_this
, STATS_TIMER_MODULE_NEED
);
432 stats_TimerClean( p_this
, STATS_TIMER_MODULE_NEED
);
437 psz_parser
= psz_shortcuts
= psz_last_shortcut
= strdup( psz_name
);
439 while( ( psz_parser
= strchr( psz_parser
, ',' ) ) )
443 psz_last_shortcut
= ++psz_parser
;
446 /* Check if the user wants to override the "strict" mode */
447 if( psz_last_shortcut
)
449 if( !strcmp(psz_last_shortcut
, "none") )
454 else if( !strcmp(psz_last_shortcut
, "any") )
462 /* Sort the modules and test them */
464 module_t
**p_all
= module_list_get (&count
);
465 p_list
= malloc( count
* sizeof( module_list_t
) );
467 /* Parse the module list for capabilities and probe each of them */
469 for (size_t i
= 0; (p_module
= p_all
[i
]) != NULL
; i
++)
471 int i_shortcut_bonus
= 0;
473 /* Test that this module can do what we need */
474 if( !module_provides( p_module
, psz_capability
) )
477 /* If we required a shortcut, check this plugin provides it. */
478 if( i_shortcuts
> 0 )
480 const char *name
= psz_shortcuts
;
482 for( unsigned i_short
= i_shortcuts
; i_short
> 0; i_short
-- )
484 for( unsigned i
= 0; p_module
->pp_shortcuts
[i
]; i
++ )
487 if( ( c
= strchr( name
, '@' ) )
488 ? !strncasecmp( name
, p_module
->pp_shortcuts
[i
],
490 : !strcasecmp( name
, p_module
->pp_shortcuts
[i
] ) )
495 i_shortcut_bonus
= i_short
* 10000;
500 /* Go to the next shortcut... This is so lame! */
501 name
+= strlen( name
) + 1;
504 /* If we are in "strict" mode and we couldn't
505 * find the module in the list of provided shortcuts,
506 * then kick the bastard out of here!!! */
511 /* Trash <= 0 scored plugins (they can only be selected by shortcut) */
512 if( p_module
->i_score
<= 0 )
516 /* Store this new module */
517 p_list
[count
].p_module
= module_hold (p_module
);
518 p_list
[count
].i_score
= p_module
->i_score
+ i_shortcut_bonus
;
519 p_list
[count
].b_force
= i_shortcut_bonus
&& b_strict
;
523 /* We can release the list, interesting modules are held */
524 module_list_free (p_all
);
526 /* Sort candidates by descending score */
527 qsort (p_list
, count
, sizeof (p_list
[0]), modulecmp
);
528 msg_Dbg( p_this
, "looking for %s module: %zu candidate%s", psz_capability
,
529 count
, count
== 1 ? "" : "s" );
531 /* Parse the linked list and use the first successful module */
533 for (size_t i
= 0; (i
< count
) && (p_module
== NULL
); i
++)
535 module_t
*p_cand
= p_list
[i
].p_module
;
536 #ifdef HAVE_DYNAMIC_PLUGINS
537 /* Make sure the module is loaded in mem */
538 module_t
*p_real
= p_cand
->b_submodule
? p_cand
->parent
: p_cand
;
540 if( !p_real
->b_builtin
&& !p_real
->b_loaded
)
542 module_t
*p_new_module
=
543 AllocatePlugin( p_this
, p_real
->psz_filename
);
544 if( p_new_module
== NULL
)
545 { /* Corrupted module */
546 msg_Err( p_this
, "possibly corrupt module cache" );
547 module_release( p_cand
);
550 CacheMerge( p_this
, p_real
, p_new_module
);
551 DeleteModule( p_module_bank
, p_new_module
);
555 p_this
->b_force
= p_list
[i
].b_force
;
557 int ret
= VLC_SUCCESS
;
558 if( p_cand
->pf_activate
)
559 ret
= p_cand
->pf_activate( p_this
);
568 /* good module, but aborted */
569 module_release( p_cand
);
572 default: /* bad module */
573 module_release( p_cand
);
577 /* Release the remaining modules */
579 module_release (p_list
[i
].p_module
);
583 p_this
->b_force
= b_force_backup
;
585 if( p_module
!= NULL
)
587 msg_Dbg( p_this
, "using %s module \"%s\"",
588 psz_capability
, p_module
->psz_object_name
);
589 vlc_object_set_name( p_this
, psz_alias
? psz_alias
590 : p_module
->psz_object_name
);
592 else if( count
== 0 )
593 msg_Dbg( p_this
, "no %s module matched \"%s\"",
594 psz_capability
, (psz_name
&& *psz_name
) ? psz_name
: "any" );
596 msg_Dbg( p_this
, "no %s module matching \"%s\" could be loaded",
597 psz_capability
, (psz_name
&& *psz_name
) ? psz_name
: "any" );
599 free( psz_shortcuts
);
602 stats_TimerStop( p_this
, STATS_TIMER_MODULE_NEED
);
603 stats_TimerDump( p_this
, STATS_TIMER_MODULE_NEED
);
604 stats_TimerClean( p_this
, STATS_TIMER_MODULE_NEED
);
606 /* Don't forget that the module is still locked */
614 * This function must be called by the thread that called module_need, to
615 * decrease the reference count and allow for hiding of modules.
616 * \param p_this vlc object structure
617 * \param p_module the module structure
620 void module_unneed( vlc_object_t
* p_this
, module_t
* p_module
)
622 /* Use the close method */
623 if( p_module
->pf_deactivate
)
625 p_module
->pf_deactivate( p_this
);
628 msg_Dbg( p_this
, "removing module \"%s\"", p_module
->psz_object_name
);
630 module_release( p_module
);
634 * Get a pointer to a module_t given it's name.
636 * \param psz_name the name of the module
637 * \return a pointer to the module or NULL in case of a failure
639 module_t
*module_find( const char * psz_name
)
641 module_t
**list
, *module
;
643 list
= module_list_get (NULL
);
647 for (size_t i
= 0; (module
= list
[i
]) != NULL
; i
++)
649 const char *psz_module_name
= module
->psz_object_name
;
651 if( psz_module_name
&& !strcmp( psz_module_name
, psz_name
) )
653 module_hold (module
);
657 module_list_free (list
);
662 * Tell if a module exists and release it in thic case
664 * \param psz_name th name of the module
665 * \return TRUE if the module exists
667 bool module_exists (const char * psz_name
)
669 module_t
*p_module
= module_find (psz_name
);
671 module_release (p_module
);
672 return p_module
!= NULL
;
676 * Get a pointer to a module_t that matches a shortcut.
677 * This is a temporary hack for SD. Do not re-use (generally multiple modules
678 * can have the same shortcut, so this is *broken* - use module_need()!).
680 * \param psz_shortcut shortcut of the module
681 * \param psz_cap capability of the module
682 * \return a pointer to the module or NULL in case of a failure
684 module_t
*module_find_by_shortcut (const char *psz_shortcut
)
686 module_t
**list
, *module
;
688 list
= module_list_get (NULL
);
692 for (size_t i
= 0; (module
= list
[i
]) != NULL
; i
++)
695 (module
->pp_shortcuts
[j
] != NULL
) && (j
< MODULE_SHORTCUT_MAX
);
698 if (!strcmp (module
->pp_shortcuts
[j
], psz_shortcut
))
700 module_hold (module
);
706 module_list_free (list
);
711 * Get the configuration of a module
713 * \param module the module
714 * \param psize the size of the configuration returned
715 * \return the configuration as an array
717 module_config_t
*module_config_get( const module_t
*module
, unsigned *restrict psize
)
720 unsigned size
= module
->confsize
;
721 module_config_t
*config
= malloc( size
* sizeof( *config
) );
723 assert( psize
!= NULL
);
729 for( i
= 0, j
= 0; i
< size
; i
++ )
731 const module_config_t
*item
= module
->p_config
+ i
;
732 if( item
->b_internal
/* internal option */
733 || item
->b_unsaveable
/* non-modifiable option */
734 || item
->b_removed
/* removed option */ )
737 memcpy( config
+ j
, item
, sizeof( *config
) );
746 * Release the configuration
748 * \param the configuration
751 void module_config_free( module_config_t
*config
)
756 /*****************************************************************************
757 * Following functions are local.
758 *****************************************************************************/
760 /*****************************************************************************
761 * copy_next_paths_token: from a PATH_SEP_CHAR (a ':' or a ';') separated paths
763 *****************************************************************************/
764 static char * copy_next_paths_token( char * paths
, char ** remaining_paths
)
768 bool escaped
= false;
772 /* Alloc a buffer to store the path */
773 path
= malloc( strlen( paths
) + 1 );
774 if( !path
) return NULL
;
776 /* Look for PATH_SEP_CHAR (a ':' or a ';') */
777 for( i
= 0, done
= 0 ; paths
[i
]; i
++ )
779 /* Take care of \\ and \: or \; escapement */
783 path
[done
++] = paths
[i
];
786 else if( paths
[i
] == '/' )
789 else if( paths
[i
] == '\\' )
792 else if( paths
[i
] == PATH_SEP_CHAR
)
795 path
[done
++] = paths
[i
];
799 /* Return the remaining paths */
800 if( remaining_paths
) {
801 *remaining_paths
= paths
[i
] ? &paths
[i
]+1 : NULL
;
807 char *psz_vlcpath
= NULL
;
809 /*****************************************************************************
810 * AllocateAllPlugins: load all plugin modules we can find.
811 *****************************************************************************/
812 #ifdef HAVE_DYNAMIC_PLUGINS
813 static void AllocateAllPlugins( vlc_object_t
*p_this
, module_bank_t
*p_bank
)
815 const char *vlcpath
= psz_vlcpath
;
818 vlc_array_t
*arraypaths
= vlc_array_new();
819 const bool b_reset
= var_InheritBool( p_this
, "reset-plugins-cache" );
821 /* Contruct the special search path for system that have a relocatable
822 * executable. Set it to <vlc path>/plugins. */
825 if( asprintf( &path
, "%s" DIR_SEP
"plugins", vlcpath
) != -1 )
826 vlc_array_append( arraypaths
, path
);
828 /* If the user provided a plugin path, we add it to the list */
829 char *userpaths
= var_InheritString( p_this
, "plugin-path" );
832 for( paths_iter
= userpaths
; paths_iter
; )
834 path
= copy_next_paths_token( paths_iter
, &paths_iter
);
836 vlc_array_append( arraypaths
, path
);
839 count
= vlc_array_count( arraypaths
);
840 for( i
= 0 ; i
< count
; i
++ )
842 path
= vlc_array_item_at_index( arraypaths
, i
);
846 size_t offset
= p_module_bank
->i_cache
;
848 CacheDelete( p_this
, path
);
850 CacheLoad( p_this
, p_module_bank
, path
);
852 msg_Dbg( p_this
, "recursively browsing `%s'", path
);
854 /* Don't go deeper than 5 subdirectories */
855 AllocatePluginDir( p_this
, p_bank
, path
, 5 );
858 CacheSave( p_this
, path
, p_module_bank
->pp_cache
+ offset
,
859 p_module_bank
->i_cache
- offset
);
863 vlc_array_destroy( arraypaths
);
867 /*****************************************************************************
868 * AllocatePluginDir: recursively parse a directory to look for plugins
869 *****************************************************************************/
870 static void AllocatePluginDir( vlc_object_t
*p_this
, module_bank_t
*p_bank
,
871 const char *psz_dir
, unsigned i_maxdepth
)
873 if( i_maxdepth
== 0 )
876 DIR *dh
= vlc_opendir (psz_dir
);
880 /* Parse the directory and try to load all files it contains. */
883 char *file
= vlc_readdir (dh
), *path
;
890 if (!strcmp (file
, ".") || !strcmp (file
, "..")
891 /* Skip directories for unsupported optimizations */
892 || !vlc_CPU_CheckPluginDir (file
))
898 const int pathlen
= asprintf (&path
, "%s"DIR_SEP
"%s", psz_dir
, file
);
900 if (pathlen
== -1 || vlc_stat (path
, &st
))
903 if (S_ISDIR (st
.st_mode
))
904 /* Recurse into another directory */
905 AllocatePluginDir (p_this
, p_bank
, path
, i_maxdepth
- 1);
907 if (S_ISREG (st
.st_mode
)
908 && strncmp (path
, "lib", 3)
909 && ((size_t)pathlen
>= sizeof ("_plugin"LIBEXT
))
910 && !strncasecmp (path
+ pathlen
- strlen ("_plugin"LIBEXT
),
911 "_plugin"LIBEXT
, strlen ("_plugni"LIBEXT
)))
912 /* ^^ We only load files matching "lib*_plugin"LIBEXT */
913 AllocatePluginFile (p_this
, p_bank
, path
, st
.st_mtime
, st
.st_size
);
920 /*****************************************************************************
921 * AllocatePluginFile: load a module into memory and initialize it.
922 *****************************************************************************
923 * This function loads a dynamically loadable module and allocates a structure
924 * for its information data. The module can then be handled by module_need
925 * and module_unneed. It can be removed by DeleteModule.
926 *****************************************************************************/
927 static int AllocatePluginFile( vlc_object_t
* p_this
, module_bank_t
*p_bank
,
928 const char *psz_file
,
929 int64_t i_file_time
, int64_t i_file_size
)
931 module_t
* p_module
= NULL
;
932 module_cache_t
*p_cache_entry
= NULL
;
935 * Check our plugins cache first then load plugin if needed
937 p_cache_entry
= CacheFind( p_bank
, psz_file
, i_file_time
, i_file_size
);
940 p_module
= AllocatePlugin( p_this
, psz_file
);
944 module_config_t
*p_item
= NULL
, *p_end
= NULL
;
946 p_module
= p_cache_entry
->p_module
;
947 p_module
->b_loaded
= false;
949 /* If plugin-path contains duplicate entries... */
950 if( p_module
->next
!= NULL
)
951 return 0; /* already taken care of that one */
953 /* For now we force loading if the module's config contains
954 * callbacks or actions.
955 * Could be optimized by adding an API call.*/
956 for( p_item
= p_module
->p_config
, p_end
= p_item
+ p_module
->confsize
;
957 p_item
< p_end
; p_item
++ )
959 if( p_item
->pf_callback
|| p_item
->i_action
)
961 p_module
= AllocatePlugin( p_this
, psz_file
);
967 if( p_module
== NULL
)
970 /* We have not already scanned and inserted this module */
971 assert( p_module
->next
== NULL
);
973 /* Everything worked fine !
974 * The module is ready to be added to the list. */
975 p_module
->b_builtin
= false;
977 /* msg_Dbg( p_this, "plugin \"%s\", %s",
978 p_module->psz_object_name, p_module->psz_longname ); */
979 p_module
->next
= p_bank
->head
;
980 p_bank
->head
= p_module
;
981 assert( p_module
->next
!= NULL
); /* Insertion done */
983 if( !p_module_bank
->b_cache
)
986 /* Add entry to cache */
987 module_cache_t
**pp_cache
= p_bank
->pp_cache
;
989 pp_cache
= realloc_or_free( pp_cache
, (p_bank
->i_cache
+ 1) * sizeof(void *) );
990 if( pp_cache
== NULL
)
992 pp_cache
[p_bank
->i_cache
] = malloc( sizeof(module_cache_t
) );
993 if( pp_cache
[p_bank
->i_cache
] == NULL
)
995 pp_cache
[p_bank
->i_cache
]->psz_file
= strdup( psz_file
);
996 pp_cache
[p_bank
->i_cache
]->i_time
= i_file_time
;
997 pp_cache
[p_bank
->i_cache
]->i_size
= i_file_size
;
998 pp_cache
[p_bank
->i_cache
]->p_module
= p_module
;
999 p_bank
->pp_cache
= pp_cache
;
1004 /*****************************************************************************
1005 * AllocatePlugin: load a module into memory and initialize it.
1006 *****************************************************************************
1007 * This function loads a dynamically loadable module and allocates a structure
1008 * for its information data. The module can then be handled by module_need
1009 * and module_unneed. It can be removed by DeleteModule.
1010 *****************************************************************************/
1011 static module_t
* AllocatePlugin( vlc_object_t
* p_this
, const char *psz_file
)
1013 module_t
* p_module
= NULL
;
1014 module_handle_t handle
;
1016 if( module_Load( p_this
, psz_file
, &handle
) )
1019 /* Now that we have successfully loaded the module, we can
1020 * allocate a structure for it */
1021 p_module
= vlc_module_create( p_this
);
1022 if( p_module
== NULL
)
1024 module_Unload( handle
);
1028 p_module
->psz_filename
= strdup( psz_file
);
1029 p_module
->handle
= handle
;
1030 p_module
->b_loaded
= true;
1032 /* Initialize the module: fill p_module, default config */
1033 if( module_Call( p_this
, p_module
) != 0 )
1035 /* We couldn't call module_init() */
1036 free( p_module
->psz_filename
);
1037 module_release( p_module
);
1038 module_Unload( handle
);
1042 DupModule( p_module
);
1044 /* Everything worked fine ! The module is ready to be added to the list. */
1045 p_module
->b_builtin
= false;
1050 /*****************************************************************************
1051 * DupModule: make a plugin module standalone.
1052 *****************************************************************************
1053 * This function duplicates all strings in the module, so that the dynamic
1054 * object can be unloaded. It acts recursively on submodules.
1055 *****************************************************************************/
1056 static void DupModule( module_t
*p_module
)
1060 for( pp_shortcut
= p_module
->pp_shortcuts
; *pp_shortcut
; pp_shortcut
++ )
1062 *pp_shortcut
= strdup( *pp_shortcut
);
1065 /* We strdup() these entries so that they are still valid when the
1066 * module is unloaded. */
1067 p_module
->psz_capability
= strdup( p_module
->psz_capability
);
1068 p_module
->psz_shortname
= p_module
->psz_shortname
?
1069 strdup( p_module
->psz_shortname
) : NULL
;
1070 p_module
->psz_longname
= strdup( p_module
->psz_longname
);
1071 p_module
->psz_help
= p_module
->psz_help
? strdup( p_module
->psz_help
)
1073 p_module
->domain
= p_module
->domain
? strdup( p_module
->domain
) : NULL
;
1075 for (module_t
*subm
= p_module
->submodule
; subm
; subm
= subm
->next
)
1079 /*****************************************************************************
1080 * UndupModule: free a duplicated module.
1081 *****************************************************************************
1082 * This function frees the allocations done in DupModule().
1083 *****************************************************************************/
1084 static void UndupModule( module_t
*p_module
)
1088 for (module_t
*subm
= p_module
->submodule
; subm
; subm
= subm
->next
)
1091 for( pp_shortcut
= p_module
->pp_shortcuts
; *pp_shortcut
; pp_shortcut
++ )
1093 free( *pp_shortcut
);
1096 free( p_module
->psz_capability
);
1097 FREENULL( p_module
->psz_shortname
);
1098 free( p_module
->psz_longname
);
1099 FREENULL( p_module
->psz_help
);
1100 free( p_module
->domain
);
1103 #endif /* HAVE_DYNAMIC_PLUGINS */
1105 /*****************************************************************************
1106 * AllocateBuiltinModule: initialize a builtin module.
1107 *****************************************************************************
1108 * This function registers a builtin module and allocates a structure
1109 * for its information data. The module can then be handled by module_need
1110 * and module_unneed. It can be removed by DeleteModule.
1111 *****************************************************************************/
1112 static int AllocateBuiltinModule( vlc_object_t
* p_this
,
1113 int ( *pf_entry
) ( module_t
* ) )
1115 module_t
* p_module
;
1117 /* Now that we have successfully loaded the module, we can
1118 * allocate a structure for it */
1119 p_module
= vlc_module_create( p_this
);
1120 if( p_module
== NULL
)
1123 /* Initialize the module : fill p_module->psz_object_name, etc. */
1124 if( pf_entry( p_module
) != 0 )
1126 /* With a well-written module we shouldn't have to print an
1127 * additional error message here, but just make sure. */
1128 msg_Err( p_this
, "failed calling entry point in builtin module" );
1129 module_release( p_module
);
1133 /* Everything worked fine ! The module is ready to be added to the list. */
1134 p_module
->b_builtin
= true;
1136 p_module
->next
= p_module_bank
->head
;
1137 p_module_bank
->head
= p_module
;
1140 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1141 p_module->psz_object_name, p_module->psz_longname ); */
1146 /*****************************************************************************
1147 * DeleteModule: delete a module and its structure.
1148 *****************************************************************************
1149 * This function can only be called if the module isn't being used.
1150 *****************************************************************************/
1151 static void DeleteModule( module_bank_t
*p_bank
, module_t
* p_module
)
1155 /* Unlist the module (if it is in the list) */
1156 module_t
**pp_self
= &p_bank
->head
;
1157 while (*pp_self
!= NULL
&& *pp_self
!= p_module
)
1158 pp_self
= &((*pp_self
)->next
);
1160 *pp_self
= p_module
->next
;
1162 /* We free the structures that we strdup()ed in Allocate*Module(). */
1163 #ifdef HAVE_DYNAMIC_PLUGINS
1164 if( !p_module
->b_builtin
)
1166 if( p_module
->b_loaded
&& p_module
->b_unloadable
)
1168 module_Unload( p_module
->handle
);
1170 UndupModule( p_module
);
1171 free( p_module
->psz_filename
);
1175 /* Free and detach the object's children */
1176 while (p_module
->submodule
)
1178 module_t
*submodule
= p_module
->submodule
;
1179 p_module
->submodule
= submodule
->next
;
1180 module_release (submodule
);
1183 config_Free( p_module
);
1184 module_release( p_module
);