1 /*****************************************************************************
2 * modules.c : Builtin and plugin modules management functions
3 *****************************************************************************
4 * Copyright (C) 2001-2004 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
27 /* Some faulty libcs have a broken struct dirent when _FILE_OFFSET_BITS
28 * is set to 64. Don't try to be cleverer. */
29 #ifdef _FILE_OFFSET_BITS
30 #undef _FILE_OFFSET_BITS
33 #include <stdlib.h> /* free(), strtol() */
34 #include <stdio.h> /* sprintf() */
35 #include <string.h> /* strdup() */
38 #include <vlc/input.h>
42 #elif defined( UNDER_CE )
43 # include <windows.h> /* GetFileAttributes() */
45 # include "../extras/dirent.h"
48 #ifdef HAVE_SYS_TYPES_H
49 # include <sys/types.h>
51 #ifdef HAVE_SYS_STAT_H
52 # include <sys/stat.h>
58 #define HAVE_DYNAMIC_PLUGINS
59 #if defined(HAVE_DL_DYLD)
60 # if defined(HAVE_MACH_O_DYLD_H)
61 # include <mach-o/dyld.h>
63 #elif defined(HAVE_DL_BEOS)
64 # if defined(HAVE_IMAGE_H)
67 #elif defined(HAVE_DL_WINDOWS)
69 #elif defined(HAVE_DL_DLOPEN)
70 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
73 # if defined(HAVE_SYS_DL_H)
76 #elif defined(HAVE_DL_SHL_LOAD)
77 # if defined(HAVE_DL_H)
81 # undef HAVE_DYNAMIC_PLUGINS
84 #include "vlc_error.h"
86 #include "vlc_interface.h"
87 #include "intf_eject.h"
89 #include "vlc_playlist.h"
91 #include "vlc_video.h"
92 #include "video_output.h"
93 #include "vout_synchro.h"
96 #include "audio_output.h"
97 #include "aout_internal.h"
99 #include "stream_output.h"
101 #include "vlc_httpd.h"
103 #include "iso_lang.h"
106 #include "vlc_block.h"
110 #ifdef HAVE_DYNAMIC_PLUGINS
111 # include "modules_plugin.h"
114 #if defined( UNDER_CE )
115 # include "modules_builtin_evc.h"
116 #elif defined( _MSC_VER )
117 # include "modules_builtin_msvc.h"
119 # include "modules_builtin.h"
123 #if defined( WIN32) || defined( UNDER_CE )
124 /* Avoid name collisions */
125 # define LoadModule(a,b,c) _LoadModule(a,b,c)
128 /*****************************************************************************
130 *****************************************************************************/
131 #ifdef HAVE_DYNAMIC_PLUGINS
132 static void AllocateAllPlugins ( vlc_object_t * );
133 static void AllocatePluginDir ( vlc_object_t *, const char *, int );
134 static int AllocatePluginFile ( vlc_object_t *, char *, int64_t, int64_t );
135 static module_t * AllocatePlugin( vlc_object_t *, char * );
137 static int AllocateBuiltinModule( vlc_object_t *, int ( * ) ( module_t * ) );
138 static int DeleteModule ( module_t * );
139 #ifdef HAVE_DYNAMIC_PLUGINS
140 static void DupModule ( module_t * );
141 static void UndupModule ( module_t * );
142 static int CallEntry ( module_t * );
143 static int LoadModule ( vlc_object_t *, char *, module_handle_t * );
144 static void CloseModule ( module_handle_t );
145 static void * GetSymbol ( module_handle_t, const char * );
146 static void CacheLoad ( vlc_object_t * );
147 static int CacheLoadConfig ( module_t *, FILE * );
148 static void CacheSave ( vlc_object_t * );
149 static void CacheSaveConfig ( module_t *, FILE * );
150 static void CacheMerge ( vlc_object_t *, module_t *, module_t * );
151 static module_cache_t * CacheFind( vlc_object_t *, char *, int64_t, int64_t );
153 #if defined(HAVE_DL_WINDOWS)
154 static char * GetWindowsError ( void );
158 /*****************************************************************************
159 * module_InitBank: create the module bank.
160 *****************************************************************************
161 * This function creates a module bank structure which will be filled later
162 * on with all the modules found.
163 *****************************************************************************/
164 void __module_InitBank( vlc_object_t *p_this )
166 module_bank_t *p_bank;
169 var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
170 var_Get( p_this->p_libvlc, "libvlc", &lockval );
171 vlc_mutex_lock( lockval.p_address );
172 if( p_this->p_libvlc->p_module_bank )
174 p_this->p_libvlc->p_module_bank->i_usage++;
175 vlc_mutex_unlock( lockval.p_address );
176 var_Destroy( p_this->p_libvlc, "libvlc" );
179 vlc_mutex_unlock( lockval.p_address );
180 var_Destroy( p_this->p_libvlc, "libvlc" );
182 p_bank = vlc_object_create( p_this, sizeof(module_bank_t) );
183 p_bank->psz_object_name = "module bank";
185 p_bank->i_cache = p_bank->i_loaded_cache = 0;
186 p_bank->pp_cache = p_bank->pp_loaded_cache = 0;
187 p_bank->b_cache = p_bank->b_cache_dirty =
188 p_bank->b_cache_delete = VLC_FALSE;
191 * Store the symbols to be exported
193 #ifdef HAVE_DYNAMIC_PLUGINS
194 STORE_SYMBOLS( &p_bank->symbols );
197 /* Everything worked, attach the object */
198 p_this->p_libvlc->p_module_bank = p_bank;
199 vlc_object_attach( p_bank, p_this->p_libvlc );
201 module_LoadMain( p_this );
206 /*****************************************************************************
207 * module_ResetBank: reset the module bank.
208 *****************************************************************************
209 * This function resets the module bank by unloading all unused plugin
211 *****************************************************************************/
212 void __module_ResetBank( vlc_object_t *p_this )
214 msg_Err( p_this, "FIXME: module_ResetBank unimplemented" );
218 /*****************************************************************************
219 * module_EndBank: empty the module bank.
220 *****************************************************************************
221 * This function unloads all unused plugin modules and empties the module
222 * bank in case of success.
223 *****************************************************************************/
224 void __module_EndBank( vlc_object_t *p_this )
229 var_Create( p_this->p_libvlc, "libvlc", VLC_VAR_MUTEX );
230 var_Get( p_this->p_libvlc, "libvlc", &lockval );
231 vlc_mutex_lock( lockval.p_address );
232 if( !p_this->p_libvlc->p_module_bank )
234 vlc_mutex_unlock( lockval.p_address );
235 var_Destroy( p_this->p_libvlc, "libvlc" );
238 if( --p_this->p_libvlc->p_module_bank->i_usage )
240 vlc_mutex_unlock( lockval.p_address );
241 var_Destroy( p_this->p_libvlc, "libvlc" );
244 vlc_mutex_unlock( lockval.p_address );
245 var_Destroy( p_this->p_libvlc, "libvlc" );
247 #ifdef HAVE_DYNAMIC_PLUGINS
248 if( p_this->p_libvlc->p_module_bank->b_cache ) CacheSave( p_this );
251 vlc_object_detach( p_this->p_libvlc->p_module_bank );
253 while( p_this->p_libvlc->p_module_bank->i_children )
255 p_next = (module_t *)p_this->p_libvlc->p_module_bank->pp_children[0];
257 if( DeleteModule( p_next ) )
259 /* Module deletion failed */
260 msg_Err( p_this, "module \"%s\" can't be removed, trying harder",
261 p_next->psz_object_name );
263 /* We just free the module by hand. Niahahahahaha. */
264 vlc_object_detach( p_next );
265 vlc_object_destroy( p_next );
269 vlc_object_destroy( p_this->p_libvlc->p_module_bank );
274 /*****************************************************************************
275 * module_LoadMain: load the main program info into the module bank.
276 *****************************************************************************
277 * This function fills the module bank structure with the main module infos.
278 * This is very useful as it will allow us to consider the main program just
279 * as another module, and for instance the configuration options of main will
280 * be available in the module bank structure just as for every other module.
281 *****************************************************************************/
282 void __module_LoadMain( vlc_object_t *p_this )
284 AllocateBuiltinModule( p_this, vlc_entry__main );
287 /*****************************************************************************
288 * module_LoadBuiltins: load all modules which we built with.
289 *****************************************************************************
290 * This function fills the module bank structure with the builtin modules.
291 *****************************************************************************/
292 void __module_LoadBuiltins( vlc_object_t * p_this )
294 msg_Dbg( p_this, "checking builtin modules" );
295 ALLOCATE_ALL_BUILTINS();
298 /*****************************************************************************
299 * module_LoadPlugins: load all plugin modules we can find.
300 *****************************************************************************
301 * This function fills the module bank structure with the plugin modules.
302 *****************************************************************************/
303 void __module_LoadPlugins( vlc_object_t * p_this )
305 #ifdef HAVE_DYNAMIC_PLUGINS
306 msg_Dbg( p_this, "checking plugin modules" );
308 if( config_GetInt( p_this, "plugins-cache" ) )
309 p_this->p_libvlc->p_module_bank->b_cache = VLC_TRUE;
311 if( p_this->p_libvlc->p_module_bank->b_cache ||
312 p_this->p_libvlc->p_module_bank->b_cache_delete ) CacheLoad( p_this );
314 AllocateAllPlugins( p_this );
318 /*****************************************************************************
319 * module_Need: return the best module function, given a capability list.
320 *****************************************************************************
321 * This function returns the module that best fits the asked capabilities.
322 *****************************************************************************/
323 module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
324 const char *psz_name, vlc_bool_t b_strict )
326 typedef struct module_list_t module_list_t;
333 module_list_t *p_next;
336 module_list_t *p_list, *p_first, *p_tmp;
339 int i_which_module, i_index = 0;
340 vlc_bool_t b_intf = VLC_FALSE;
345 char *psz_shortcuts = NULL, *psz_var = NULL;
347 msg_Dbg( p_this, "looking for %s module", psz_capability );
349 /* Deal with variables */
350 if( psz_name && psz_name[0] == '$' )
353 var_Create( p_this, psz_name + 1, VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
354 var_Get( p_this, psz_name + 1, &val );
355 psz_var = val.psz_string;
359 /* Count how many different shortcuts were asked for */
360 if( psz_name && *psz_name )
362 char *psz_parser, *psz_last_shortcut;
364 /* If the user wants none, give him none. */
365 if( !strcmp( psz_name, "none" ) )
367 if( psz_var ) free( psz_var );
372 psz_shortcuts = psz_last_shortcut = strdup( psz_name );
374 for( psz_parser = psz_shortcuts; *psz_parser; psz_parser++ )
376 if( *psz_parser == ',' )
380 psz_last_shortcut = psz_parser + 1;
384 /* Check if the user wants to override the "strict" mode */
385 if( psz_last_shortcut )
387 if( !strcmp(psz_last_shortcut, "none") )
392 else if( !strcmp(psz_last_shortcut, "any") )
394 b_strict = VLC_FALSE;
400 /* Sort the modules and test them */
401 p_all = vlc_list_find( p_this, VLC_OBJECT_MODULE, FIND_ANYWHERE );
402 p_list = malloc( p_all->i_count * sizeof( module_list_t ) );
405 /* Parse the module list for capabilities and probe each of them */
406 for( i_which_module = 0; i_which_module < p_all->i_count; i_which_module++ )
408 int i_shortcut_bonus = 0;
410 p_module = (module_t *)p_all->p_values[i_which_module].p_object;
412 /* Test that this module can do what we need */
413 if( strcmp( p_module->psz_capability, psz_capability ) )
415 /* Don't recurse through the sub-modules because vlc_list_find()
416 * will list them anyway. */
420 /* Test if we have the required CPU */
421 if( (p_module->i_cpu & p_this->p_libvlc->i_cpu) != p_module->i_cpu )
426 /* If we required a shortcut, check this plugin provides it. */
427 if( i_shortcuts > 0 )
430 int i_dummy, i_short = i_shortcuts;
431 char *psz_name = psz_shortcuts;
433 /* Let's drop modules with a <= 0 score (unless they are
434 * explicitly requested) */
435 b_trash = p_module->i_score <= 0;
439 for( i_dummy = 0; p_module->pp_shortcuts[i_dummy]; i_dummy++ )
441 if( !strcasecmp( psz_name,
442 p_module->pp_shortcuts[i_dummy] ) )
446 i_shortcut_bonus = i_short * 10000;
451 if( i_shortcut_bonus )
453 /* We found it... remember ? */
457 /* Go to the next shortcut... This is so lame! */
466 /* If we are in "strict" mode and we couldn't
467 * find the module in the list of provided shortcuts,
468 * then kick the bastard out of here!!! */
469 if( i_short == 0 && b_strict )
479 /* If we didn't require a shortcut, trash <= 0 scored plugins */
480 else if( p_module->i_score <= 0 )
485 /* Special case: test if we requested a particular intf plugin */
486 if( !i_shortcuts && p_module->psz_program
487 && !strcmp( p_module->psz_program,
488 p_this->p_vlc->psz_object_name ) )
492 /* Remove previous non-matching plugins */
499 /* This one doesn't match */
503 /* Store this new module */
504 p_list[ i_index ].p_module = p_module;
505 p_list[ i_index ].i_score = p_module->i_score + i_shortcut_bonus;
506 p_list[ i_index ].b_force = !!i_shortcut_bonus;
508 /* Add it to the modules-to-probe list */
511 p_list[ 0 ].p_next = NULL;
516 /* Ok, so at school you learned that quicksort is quick, and
517 * bubble sort sucks raw eggs. But that's when dealing with
518 * thousands of items. Here we have barely 50. */
519 module_list_t *p_newlist = p_first;
521 if( p_first->i_score < p_list[ i_index ].i_score )
523 p_list[ i_index ].p_next = p_first;
524 p_first = &p_list[ i_index ];
528 while( p_newlist->p_next != NULL &&
529 p_newlist->p_next->i_score >= p_list[ i_index ].i_score )
531 p_newlist = p_newlist->p_next;
534 p_list[ i_index ].p_next = p_newlist->p_next;
535 p_newlist->p_next = &p_list[ i_index ];
542 msg_Dbg( p_this, "probing %i candidate%s",
543 i_index, i_index == 1 ? "" : "s" );
545 /* Lock all candidate modules */
547 while( p_tmp != NULL )
549 vlc_object_yield( p_tmp->p_module );
550 p_tmp = p_tmp->p_next;
553 /* We can release the list, interesting modules were yielded */
554 vlc_list_release( p_all );
556 /* Parse the linked list and use the first successful module */
558 while( p_tmp != NULL )
560 #ifdef HAVE_DYNAMIC_PLUGINS
561 /* Make sure the module is loaded in mem */
562 module_t *p_module = p_tmp->p_module->b_submodule ?
563 (module_t *)p_tmp->p_module->p_parent : p_tmp->p_module;
564 if( !p_module->b_builtin && !p_module->b_loaded )
566 module_t *p_new_module =
567 AllocatePlugin( p_this, p_module->psz_filename );
570 CacheMerge( p_this, p_module, p_new_module );
571 vlc_object_attach( p_new_module, p_module );
572 DeleteModule( p_new_module );
577 p_this->b_force = p_tmp->b_force;
578 if( p_tmp->p_module->pf_activate
579 && p_tmp->p_module->pf_activate( p_this ) == VLC_SUCCESS )
584 vlc_object_release( p_tmp->p_module );
585 p_tmp = p_tmp->p_next;
588 /* Store the locked module value */
591 p_module = p_tmp->p_module;
592 p_tmp = p_tmp->p_next;
599 /* Unlock the remaining modules */
600 while( p_tmp != NULL )
602 vlc_object_release( p_tmp->p_module );
603 p_tmp = p_tmp->p_next;
607 p_this->b_force = VLC_FALSE;
609 if( p_module != NULL )
611 msg_Dbg( p_module, "using %s module \"%s\"",
612 psz_capability, p_module->psz_object_name );
614 else if( p_first == NULL )
616 if( !strcmp( psz_capability, "access_demux" ) )
618 msg_Warn( p_this, "no %s module matched \"%s\"",
619 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
623 msg_Err( p_this, "no %s module matched \"%s\"",
624 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
627 else if( psz_name != NULL && *psz_name )
629 msg_Warn( p_this, "no %s module matching \"%s\" could be loaded",
630 psz_capability, (psz_name && *psz_name) ? psz_name : "any" );
635 free( psz_shortcuts );
643 /* Don't forget that the module is still locked */
647 /*****************************************************************************
648 * module_Unneed: decrease the usage count of a module.
649 *****************************************************************************
650 * This function must be called by the thread that called module_Need, to
651 * decrease the reference count and allow for hiding of modules.
652 *****************************************************************************/
653 void __module_Unneed( vlc_object_t * p_this, module_t * p_module )
655 /* Use the close method */
656 if( p_module->pf_deactivate )
658 p_module->pf_deactivate( p_this );
661 msg_Dbg( p_module, "unlocking module \"%s\"", p_module->psz_object_name );
663 vlc_object_release( p_module );
668 /*****************************************************************************
669 * Following functions are local.
670 *****************************************************************************/
672 /*****************************************************************************
673 * AllocateAllPlugins: load all plugin modules we can find.
674 *****************************************************************************/
675 #ifdef HAVE_DYNAMIC_PLUGINS
676 static void AllocateAllPlugins( vlc_object_t *p_this )
678 /* Yes, there are two NULLs because we replace one with "plugin-path". */
680 char * path[] = { "modules", "", "plugins", 0, 0 };
682 char * path[] = { "modules", PLUGIN_PATH, "plugins", 0, 0 };
685 char ** ppsz_path = path;
688 /* If the user provided a plugin path, we add it to the list */
689 path[ sizeof(path)/sizeof(char*) - 2 ] =
690 config_GetPsz( p_this, "plugin-path" );
692 for( ; *ppsz_path != NULL ; ppsz_path++ )
694 if( !(*ppsz_path)[0] ) continue;
696 #if defined( SYS_BEOS ) || defined( SYS_DARWIN ) || defined( WIN32 )
698 /* Handle relative as well as absolute paths */
700 if( (*ppsz_path)[0] != '\\' && (*ppsz_path)[0] != '/' &&
701 (*ppsz_path)[1] != ':' )
703 if( (*ppsz_path)[0] != '/' )
706 int i_dirlen = strlen( *ppsz_path );
707 i_dirlen += strlen( p_this->p_libvlc->psz_vlcpath ) + 2;
709 psz_fullpath = malloc( i_dirlen );
710 if( psz_fullpath == NULL )
715 sprintf( psz_fullpath, "%s\\%s",
716 p_this->p_libvlc->psz_vlcpath, *ppsz_path );
718 sprintf( psz_fullpath, "%s/%s",
719 p_this->p_libvlc->psz_vlcpath, *ppsz_path );
725 psz_fullpath = strdup( *ppsz_path );
728 msg_Dbg( p_this, "recursively browsing `%s'", psz_fullpath );
730 /* Don't go deeper than 5 subdirectories */
731 AllocatePluginDir( p_this, psz_fullpath, 5 );
733 free( psz_fullpath );
736 /* Free plugin-path */
737 if( path[ sizeof(path)/sizeof(char*) - 2 ] )
738 free( path[ sizeof(path)/sizeof(char*) - 2 ] );
739 path[ sizeof(path)/sizeof(char*) - 2 ] = NULL;
742 /*****************************************************************************
743 * AllocatePluginDir: recursively parse a directory to look for plugins
744 *****************************************************************************/
745 static void AllocatePluginDir( vlc_object_t *p_this, const char *psz_dir,
748 #if defined( UNDER_CE ) || defined( _MSC_VER )
750 wchar_t psz_wpath[MAX_PATH + 256];
751 wchar_t psz_wdir[MAX_PATH];
753 char psz_path[MAX_PATH + 256];
754 WIN32_FIND_DATA finddata;
760 struct dirent * file;
764 if( p_this->p_vlc->b_die || i_maxdepth < 0 )
769 #if defined( UNDER_CE ) || defined( _MSC_VER )
771 MultiByteToWideChar( CP_ACP, 0, psz_dir, -1, psz_wdir, MAX_PATH );
773 rc = GetFileAttributes( psz_wdir );
774 if( !(rc & FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
776 /* Parse all files in the directory */
777 swprintf( psz_wpath, L"%ls\\*", psz_wdir );
779 rc = GetFileAttributes( psz_dir );
780 if( !(rc & FILE_ATTRIBUTE_DIRECTORY) ) return; /* Not a directory */
783 /* Parse all files in the directory */
784 sprintf( psz_path, "%s\\*", psz_dir );
787 handle = FindFirstFile( psz_wpath, &finddata );
789 handle = FindFirstFile( psz_path, &finddata );
791 if( handle == INVALID_HANDLE_VALUE )
793 /* Empty directory */
797 /* Parse the directory and try to load all files it contains. */
801 unsigned int i_len = wcslen( finddata.cFileName );
802 swprintf( psz_wpath, L"%ls\\%ls", psz_wdir, finddata.cFileName );
803 sprintf( psz_path, "%s\\%ls", psz_dir, finddata.cFileName );
805 unsigned int i_len = strlen( finddata.cFileName );
806 sprintf( psz_path, "%s\\%s", psz_dir, finddata.cFileName );
809 /* Skip ".", ".." and anything starting with "." */
810 if( !*finddata.cFileName || *finddata.cFileName == '.' )
812 if( !FindNextFile( handle, &finddata ) ) break;
817 if( GetFileAttributes( psz_wpath ) & FILE_ATTRIBUTE_DIRECTORY )
819 if( GetFileAttributes( psz_path ) & FILE_ATTRIBUTE_DIRECTORY )
822 AllocatePluginDir( p_this, psz_path, i_maxdepth - 1 );
824 else if( i_len > strlen( LIBEXT )
825 /* We only load files ending with LIBEXT */
826 && !strncasecmp( psz_path + strlen( psz_path)
828 LIBEXT, strlen( LIBEXT ) ) )
832 AllocatePluginFile( p_this, psz_file, 0, 0 );
835 while( !p_this->p_vlc->b_die && FindNextFile( handle, &finddata ) );
837 /* Close the directory */
841 dir = opendir( psz_dir );
847 i_dirlen = strlen( psz_dir );
849 /* Parse the directory and try to load all files it contains. */
850 while( !p_this->p_vlc->b_die && (file = readdir( dir )) )
856 /* Skip ".", ".." and anything starting with "." */
857 if( !*file->d_name || *file->d_name == '.' )
862 i_len = strlen( file->d_name );
863 psz_file = malloc( i_dirlen + 1 + i_len + 1 );
865 sprintf( psz_file, "%s\\%s", psz_dir, file->d_name );
867 sprintf( psz_file, "%s/%s", psz_dir, file->d_name );
870 i_stat = stat( psz_file, &statbuf );
871 if( !i_stat && statbuf.st_mode & S_IFDIR )
873 AllocatePluginDir( p_this, psz_file, i_maxdepth - 1 );
875 else if( i_len > strlen( LIBEXT )
876 /* We only load files ending with LIBEXT */
877 && !strncasecmp( file->d_name + i_len - strlen( LIBEXT ),
878 LIBEXT, strlen( LIBEXT ) ) )
880 int64_t i_time = 0, i_size = 0;
884 i_time = statbuf.st_mtime;
885 i_size = statbuf.st_size;
888 AllocatePluginFile( p_this, psz_file, i_time, i_size );
894 /* Close the directory */
900 /*****************************************************************************
901 * AllocatePluginFile: load a module into memory and initialize it.
902 *****************************************************************************
903 * This function loads a dynamically loadable module and allocates a structure
904 * for its information data. The module can then be handled by module_Need
905 * and module_Unneed. It can be removed by DeleteModule.
906 *****************************************************************************/
907 static int AllocatePluginFile( vlc_object_t * p_this, char * psz_file,
908 int64_t i_file_time, int64_t i_file_size )
911 module_cache_t *p_cache_entry = NULL;
914 * Check our plugins cache first then load plugin if needed
917 CacheFind( p_this, psz_file, i_file_time, i_file_size );
921 p_module = AllocatePlugin( p_this, psz_file );
925 /* If junk dll, don't try to load it */
926 if( p_cache_entry->b_junk )
932 module_config_t *p_item;
934 p_module = p_cache_entry->p_module;
935 p_module->b_loaded = VLC_FALSE;
937 /* For now we force loading if the module's config contains
938 * callbacks or actions.
939 * Could be optimized by adding an API call.*/
940 for( p_item = p_module->p_config;
941 p_item->i_type != CONFIG_HINT_END; p_item++ )
943 if( p_item->pf_callback || p_item->i_action )
944 p_module = AllocatePlugin( p_this, psz_file );
951 /* Everything worked fine !
952 * The module is ready to be added to the list. */
953 p_module->b_builtin = VLC_FALSE;
955 /* msg_Dbg( p_this, "plugin \"%s\", %s",
956 p_module->psz_object_name, p_module->psz_longname ); */
958 vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
961 if( !p_this->p_libvlc->p_module_bank->b_cache ) return 0;
963 /* Add entry to cache */
964 #define p_bank p_this->p_libvlc->p_module_bank
966 realloc( p_bank->pp_cache, (p_bank->i_cache + 1) * sizeof(void *) );
967 p_bank->pp_cache[p_bank->i_cache] = malloc( sizeof(module_cache_t) );
968 p_bank->pp_cache[p_bank->i_cache]->psz_file = strdup( psz_file );
969 p_bank->pp_cache[p_bank->i_cache]->i_time = i_file_time;
970 p_bank->pp_cache[p_bank->i_cache]->i_size = i_file_size;
971 p_bank->pp_cache[p_bank->i_cache]->b_junk = p_module ? 0 : 1;
972 p_bank->pp_cache[p_bank->i_cache]->p_module = p_module;
975 return p_module ? 0 : -1;
978 /*****************************************************************************
979 * AllocatePlugin: load a module into memory and initialize it.
980 *****************************************************************************
981 * This function loads a dynamically loadable module and allocates a structure
982 * for its information data. The module can then be handled by module_Need
983 * and module_Unneed. It can be removed by DeleteModule.
984 *****************************************************************************/
985 static module_t * AllocatePlugin( vlc_object_t * p_this, char * psz_file )
988 module_handle_t handle;
990 if( LoadModule( p_this, psz_file, &handle ) ) return NULL;
992 /* Now that we have successfully loaded the module, we can
993 * allocate a structure for it */
994 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
995 if( p_module == NULL )
997 msg_Err( p_this, "out of memory" );
998 CloseModule( handle );
1002 /* We need to fill these since they may be needed by CallEntry() */
1003 p_module->psz_filename = psz_file;
1004 p_module->handle = handle;
1005 p_module->p_symbols = &p_this->p_libvlc->p_module_bank->symbols;
1006 p_module->b_loaded = VLC_TRUE;
1008 /* Initialize the module: fill p_module, default config */
1009 if( CallEntry( p_module ) != 0 )
1011 /* We couldn't call module_init() */
1012 vlc_object_destroy( p_module );
1013 CloseModule( handle );
1017 DupModule( p_module );
1018 p_module->psz_filename = strdup( p_module->psz_filename );
1019 p_module->psz_longname = strdup( p_module->psz_longname );
1021 /* Everything worked fine ! The module is ready to be added to the list. */
1022 p_module->b_builtin = VLC_FALSE;
1027 /*****************************************************************************
1028 * DupModule: make a plugin module standalone.
1029 *****************************************************************************
1030 * This function duplicates all strings in the module, so that the dynamic
1031 * object can be unloaded. It acts recursively on submodules.
1032 *****************************************************************************/
1033 static void DupModule( module_t *p_module )
1038 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1040 *pp_shortcut = strdup( *pp_shortcut );
1043 /* We strdup() these entries so that they are still valid when the
1044 * module is unloaded. */
1045 p_module->psz_object_name = strdup( p_module->psz_object_name );
1046 p_module->psz_capability = strdup( p_module->psz_capability );
1048 if( p_module->psz_program != NULL )
1050 p_module->psz_program = strdup( p_module->psz_program );
1053 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1055 DupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1059 /*****************************************************************************
1060 * UndupModule: free a duplicated module.
1061 *****************************************************************************
1062 * This function frees the allocations done in DupModule().
1063 *****************************************************************************/
1064 static void UndupModule( module_t *p_module )
1069 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1071 UndupModule( (module_t*)p_module->pp_children[ i_submodule ] );
1074 for( pp_shortcut = p_module->pp_shortcuts ; *pp_shortcut ; pp_shortcut++ )
1076 free( *pp_shortcut );
1079 free( p_module->psz_object_name );
1080 free( p_module->psz_capability );
1082 if( p_module->psz_program != NULL )
1084 free( p_module->psz_program );
1088 #endif /* HAVE_DYNAMIC_PLUGINS */
1090 /*****************************************************************************
1091 * AllocateBuiltinModule: initialize a builtin module.
1092 *****************************************************************************
1093 * This function registers a builtin module and allocates a structure
1094 * for its information data. The module can then be handled by module_Need
1095 * and module_Unneed. It can be removed by DeleteModule.
1096 *****************************************************************************/
1097 static int AllocateBuiltinModule( vlc_object_t * p_this,
1098 int ( *pf_entry ) ( module_t * ) )
1100 module_t * p_module;
1102 /* Now that we have successfully loaded the module, we can
1103 * allocate a structure for it */
1104 p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1105 if( p_module == NULL )
1107 msg_Err( p_this, "out of memory" );
1111 /* Initialize the module : fill p_module->psz_object_name, etc. */
1112 if( pf_entry( p_module ) != 0 )
1114 /* With a well-written module we shouldn't have to print an
1115 * additional error message here, but just make sure. */
1116 msg_Err( p_this, "failed calling entry point in builtin module" );
1117 vlc_object_destroy( p_module );
1121 /* Everything worked fine ! The module is ready to be added to the list. */
1122 p_module->b_builtin = VLC_TRUE;
1124 /* msg_Dbg( p_this, "builtin \"%s\", %s",
1125 p_module->psz_object_name, p_module->psz_longname ); */
1127 vlc_object_attach( p_module, p_this->p_libvlc->p_module_bank );
1132 /*****************************************************************************
1133 * DeleteModule: delete a module and its structure.
1134 *****************************************************************************
1135 * This function can only be called if the module isn't being used.
1136 *****************************************************************************/
1137 static int DeleteModule( module_t * p_module )
1139 vlc_object_detach( p_module );
1141 /* We free the structures that we strdup()ed in Allocate*Module(). */
1142 #ifdef HAVE_DYNAMIC_PLUGINS
1143 if( !p_module->b_builtin )
1145 if( p_module->b_loaded && p_module->b_unloadable )
1147 CloseModule( p_module->handle );
1149 UndupModule( p_module );
1150 free( p_module->psz_filename );
1151 free( p_module->psz_longname );
1155 /* Free and detach the object's children */
1156 while( p_module->i_children )
1158 vlc_object_t *p_this = p_module->pp_children[0];
1159 vlc_object_detach( p_this );
1160 vlc_object_destroy( p_this );
1163 config_Free( p_module );
1164 vlc_object_destroy( p_module );
1169 #ifdef HAVE_DYNAMIC_PLUGINS
1170 /*****************************************************************************
1171 * CallEntry: call an entry point.
1172 *****************************************************************************
1173 * This function calls a symbol given its name and a module structure. The
1174 * symbol MUST refer to a function returning int and taking a module_t* as
1176 *****************************************************************************/
1177 static int CallEntry( module_t * p_module )
1179 static char *psz_name = "vlc_entry" MODULE_SUFFIX;
1180 int (* pf_symbol) ( module_t * p_module );
1182 /* Try to resolve the symbol */
1183 pf_symbol = (int (*)(module_t *)) GetSymbol( p_module->handle, psz_name );
1185 if( pf_symbol == NULL )
1187 #if defined(HAVE_DL_DYLD) || defined(HAVE_DL_BEOS)
1188 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s'",
1189 psz_name, p_module->psz_filename );
1190 #elif defined(HAVE_DL_WINDOWS)
1191 char *psz_error = GetWindowsError();
1192 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1193 psz_name, p_module->psz_filename, psz_error );
1195 #elif defined(HAVE_DL_DLOPEN)
1196 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1197 psz_name, p_module->psz_filename, dlerror() );
1198 #elif defined(HAVE_DL_SHL_LOAD)
1199 msg_Warn( p_module, "cannot find symbol \"%s\" in file `%s' (%s)",
1200 psz_name, p_module->psz_filename, strerror(errno) );
1202 # error "Something is wrong in modules.c"
1207 /* We can now try to call the symbol */
1208 if( pf_symbol( p_module ) != 0 )
1210 /* With a well-written module we shouldn't have to print an
1211 * additional error message here, but just make sure. */
1212 msg_Err( p_module, "failed calling symbol \"%s\" in file `%s'",
1213 psz_name, p_module->psz_filename );
1217 /* Everything worked fine, we can return */
1221 /*****************************************************************************
1222 * LoadModule: loads a dynamic library
1223 *****************************************************************************
1224 * This function loads a dynamically linked library using a system dependant
1225 * method. Will return 0 on success as well as the module handle.
1226 *****************************************************************************/
1227 static int LoadModule( vlc_object_t *p_this, char *psz_file,
1228 module_handle_t *p_handle )
1230 module_handle_t handle;
1232 #if defined(HAVE_DL_DYLD)
1233 NSObjectFileImage image;
1234 NSObjectFileImageReturnCode ret;
1236 ret = NSCreateObjectFileImageFromFile( psz_file, &image );
1238 if( ret != NSObjectFileImageSuccess )
1240 msg_Warn( p_this, "cannot create image from `%s'", psz_file );
1244 /* Open the dynamic module */
1245 handle = NSLinkModule( image, psz_file,
1246 NSLINKMODULE_OPTION_RETURN_ON_ERROR );
1250 NSLinkEditErrors errors;
1251 const char *psz_file, *psz_err;
1253 NSLinkEditError( &errors, &i_errnum, &psz_file, &psz_err );
1254 msg_Warn( p_this, "cannot link module `%s' (%s)", psz_file, psz_err );
1255 NSDestroyObjectFileImage( image );
1259 /* Destroy our image, we won't need it */
1260 NSDestroyObjectFileImage( image );
1262 #elif defined(HAVE_DL_BEOS)
1263 handle = load_add_on( psz_file );
1266 msg_Warn( p_this, "cannot load module `%s'", psz_file );
1270 #elif defined(HAVE_DL_WINDOWS)
1273 wchar_t psz_wfile[MAX_PATH];
1274 MultiByteToWideChar( CP_ACP, 0, psz_file, -1, psz_wfile, MAX_PATH );
1275 handle = LoadLibrary( psz_wfile );
1278 handle = LoadLibrary( psz_file );
1280 if( handle == NULL )
1282 char *psz_err = GetWindowsError();
1283 msg_Warn( p_this, "cannot load module `%s' (%s)", psz_file, psz_err );
1288 #elif defined(HAVE_DL_DLOPEN) && defined(RTLD_NOW)
1289 /* static is OK, we are called atomically */
1290 static vlc_bool_t b_kde = VLC_FALSE;
1292 # if defined(SYS_LINUX)
1293 /* XXX HACK #1 - we should NOT open modules with RTLD_GLOBAL, or we
1294 * are going to get namespace collisions when two modules have common
1295 * public symbols, but ALSA is being a pest here. */
1296 if( strstr( psz_file, "alsa_plugin" ) )
1298 handle = dlopen( psz_file, RTLD_NOW | RTLD_GLOBAL );
1299 if( handle == NULL )
1301 msg_Warn( p_this, "cannot load module `%s' (%s)",
1302 psz_file, dlerror() );
1307 /* XXX HACK #2 - the ugly KDE workaround. It seems that libkdewhatever
1308 * causes dlopen() to segfault if libstdc++ is not loaded in the caller,
1309 * so we just load libstdc++. Bwahahaha! ph34r! -- Sam. */
1310 /* Update: FYI, this is Debian bug #180505, and seems to be fixed. */
1311 if( !b_kde && !strstr( psz_file, "kde" ) )
1313 dlopen( "libstdc++.so.6", RTLD_NOW )
1314 || dlopen( "libstdc++.so.5", RTLD_NOW )
1315 || dlopen( "libstdc++.so.4", RTLD_NOW )
1316 || dlopen( "libstdc++.so.3", RTLD_NOW );
1320 handle = dlopen( psz_file, RTLD_NOW );
1321 if( handle == NULL )
1323 msg_Warn( p_this, "cannot load module `%s' (%s)",
1324 psz_file, dlerror() );
1328 #elif defined(HAVE_DL_DLOPEN)
1329 # if defined(DL_LAZY)
1330 handle = dlopen( psz_file, DL_LAZY );
1332 handle = dlopen( psz_file, 0 );
1334 if( handle == NULL )
1336 msg_Warn( p_this, "cannot load module `%s' (%s)",
1337 psz_file, dlerror() );
1341 #elif defined(HAVE_DL_SHL_LOAD)
1342 handle = shl_load( psz_file, BIND_IMMEDIATE | BIND_NONFATAL, NULL );
1343 if( handle == NULL )
1345 msg_Warn( p_this, "cannot load module `%s' (%s)",
1346 psz_file, strerror(errno) );
1351 # error "Something is wrong in modules.c"
1359 /*****************************************************************************
1360 * CloseModule: unload a dynamic library
1361 *****************************************************************************
1362 * This function unloads a previously opened dynamically linked library
1363 * using a system dependant method. No return value is taken in consideration,
1364 * since some libraries sometimes refuse to close properly.
1365 *****************************************************************************/
1366 static void CloseModule( module_handle_t handle )
1368 #if defined(HAVE_DL_DYLD)
1369 NSUnLinkModule( handle, FALSE );
1371 #elif defined(HAVE_DL_BEOS)
1372 unload_add_on( handle );
1374 #elif defined(HAVE_DL_WINDOWS)
1375 FreeLibrary( handle );
1377 #elif defined(HAVE_DL_DLOPEN)
1380 #elif defined(HAVE_DL_SHL_LOAD)
1381 shl_unload( handle );
1387 /*****************************************************************************
1388 * GetSymbol: get a symbol from a dynamic library
1389 *****************************************************************************
1390 * This function queries a loaded library for a symbol specified in a
1391 * string, and returns a pointer to it. We don't check for dlerror() or
1392 * similar functions, since we want a non-NULL symbol anyway.
1393 *****************************************************************************/
1394 static void * _module_getsymbol( module_handle_t, const char * );
1396 static void * GetSymbol( module_handle_t handle, const char * psz_function )
1398 void * p_symbol = _module_getsymbol( handle, psz_function );
1400 /* MacOS X dl library expects symbols to begin with "_". So do
1401 * some other operating systems. That's really lame, but hey, what
1403 if( p_symbol == NULL )
1405 char *psz_call = malloc( strlen( psz_function ) + 2 );
1407 strcpy( psz_call + 1, psz_function );
1408 psz_call[ 0 ] = '_';
1409 p_symbol = _module_getsymbol( handle, psz_call );
1416 static void * _module_getsymbol( module_handle_t handle,
1417 const char * psz_function )
1419 #if defined(HAVE_DL_DYLD)
1420 NSSymbol sym = NSLookupSymbolInModule( handle, psz_function );
1421 return NSAddressOfSymbol( sym );
1423 #elif defined(HAVE_DL_BEOS)
1425 if( B_OK == get_image_symbol( handle, psz_function,
1426 B_SYMBOL_TYPE_TEXT, &p_symbol ) )
1435 #elif defined(HAVE_DL_WINDOWS) && defined(UNDER_CE)
1436 wchar_t psz_real[256];
1437 MultiByteToWideChar( CP_ACP, 0, psz_function, -1, psz_real, 256 );
1439 return (void *)GetProcAddress( handle, psz_real );
1441 #elif defined(HAVE_DL_WINDOWS) && defined(WIN32)
1442 return (void *)GetProcAddress( handle, (char *)psz_function );
1444 #elif defined(HAVE_DL_DLOPEN)
1445 return dlsym( handle, psz_function );
1447 #elif defined(HAVE_DL_SHL_LOAD)
1449 shl_findsym( &handle, psz_function, TYPE_UNDEFINED, &p_sym );
1455 #if defined(HAVE_DL_WINDOWS)
1456 static char * GetWindowsError( void )
1458 #if defined(UNDER_CE)
1459 wchar_t psz_tmp[256];
1460 char * psz_buffer = malloc( 256 );
1462 char * psz_tmp = malloc( 256 );
1464 int i = 0, i_error = GetLastError();
1466 FormatMessage( FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1467 NULL, i_error, MAKELANGID (LANG_NEUTRAL, SUBLANG_DEFAULT),
1468 (LPTSTR) psz_tmp, 256, NULL );
1470 /* Go to the end of the string */
1471 #if defined(UNDER_CE)
1472 while( psz_tmp[i] && psz_tmp[i] != L'\r' && psz_tmp[i] != L'\n' )
1474 while( psz_tmp[i] && psz_tmp[i] != '\r' && psz_tmp[i] != '\n' )
1482 #if defined(UNDER_CE)
1483 swprintf( psz_tmp + i, L" (error %i)", i_error );
1484 psz_tmp[ 255 ] = L'\0';
1486 snprintf( psz_tmp + i, 256 - i, " (error %i)", i_error );
1487 psz_tmp[ 255 ] = '\0';
1491 #if defined(UNDER_CE)
1492 WideCharToMultiByte( CP_ACP, WC_DEFAULTCHAR, psz_tmp, -1,
1493 psz_buffer, 256, NULL, NULL );
1499 #endif /* HAVE_DL_WINDOWS */
1501 /*****************************************************************************
1502 * LoadPluginsCache: loads the plugins cache file
1503 *****************************************************************************
1504 * This function will load the plugin cache if present and valid. This cache
1505 * will in turn be queried by AllocateAllPlugins() to see if it needs to
1506 * actually load the dynamically loadable module.
1507 * This allows us to only fully load plugins when they are actually used.
1508 *****************************************************************************/
1509 static void CacheLoad( vlc_object_t *p_this )
1511 char *psz_filename, *psz_homedir;
1513 int i, j, i_size, i_read;
1514 char p_cachestring[sizeof(PLUGINSCACHE_FILE COPYRIGHT_MESSAGE)];
1516 module_cache_t **pp_cache = 0;
1517 int32_t i_file_size;
1519 psz_homedir = p_this->p_vlc->psz_homedir;
1522 msg_Err( p_this, "psz_homedir is null" );
1526 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_FILE) +
1527 strlen(psz_homedir) );
1530 sprintf( psz_filename, "%s/" CONFIG_DIR "/" PLUGINSCACHE_FILE,
1535 msg_Err( p_this, "out of memory" );
1539 if( p_this->p_libvlc->p_module_bank->b_cache_delete )
1541 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
1542 #if !defined( UNDER_CE )
1543 unlink( psz_filename );
1545 msg_Err( p_this, "FIXME, unlink not implemented" );
1550 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
1552 file = fopen( psz_filename, "rb" );
1555 msg_Warn( p_this, "could not open plugins cache file %s for reading",
1557 free( psz_filename );
1560 free( psz_filename );
1562 /* Check the file size */
1563 i_read = fread( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1564 if( i_read != sizeof(i_file_size) )
1566 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1572 fseek( file, 0, SEEK_END );
1573 if( ftell( file ) != i_file_size )
1575 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
1576 "(corrupted size)" );
1580 fseek( file, sizeof(i_file_size), SEEK_SET );
1582 /* Check the file is a plugins cache */
1583 i_size = sizeof(PLUGINSCACHE_FILE COPYRIGHT_MESSAGE) - 1;
1584 i_read = fread( p_cachestring, sizeof(char), i_size, file );
1585 if( i_read != i_size ||
1586 memcmp( p_cachestring, PLUGINSCACHE_FILE COPYRIGHT_MESSAGE, i_size ) )
1588 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
1593 p_this->p_libvlc->p_module_bank->i_loaded_cache = 0;
1594 fread( &i_cache, sizeof(char), sizeof(i_cache), file );
1595 pp_cache = p_this->p_libvlc->p_module_bank->pp_loaded_cache =
1596 malloc( i_cache * sizeof(void *) );
1598 #define LOAD_IMMEDIATE(a) \
1599 if( fread( &a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
1600 #define LOAD_STRING(a) \
1601 { if( fread( &i_size, sizeof(char), sizeof(i_size), file ) \
1602 != sizeof(i_size) ) goto error; \
1604 a = malloc( i_size ); \
1605 if( fread( a, sizeof(char), i_size, file ) != (size_t)i_size ) \
1611 for( i = 0; i < i_cache; i++ )
1616 pp_cache[i] = malloc( sizeof(module_cache_t) );
1617 p_this->p_libvlc->p_module_bank->i_loaded_cache++;
1619 /* Save common info */
1620 LOAD_STRING( pp_cache[i]->psz_file );
1621 LOAD_IMMEDIATE( pp_cache[i]->i_time );
1622 LOAD_IMMEDIATE( pp_cache[i]->i_size );
1623 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
1625 if( pp_cache[i]->b_junk ) continue;
1627 pp_cache[i]->p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE );
1629 /* Save additional infos */
1630 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
1631 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
1632 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
1633 LOAD_STRING( pp_cache[i]->p_module->psz_program );
1634 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1636 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1638 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
1639 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
1640 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1641 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1642 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1643 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1646 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
1649 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
1651 LOAD_IMMEDIATE( i_submodules );
1653 while( i_submodules-- )
1655 module_t *p_module = vlc_object_create( p_this, VLC_OBJECT_MODULE);
1656 vlc_object_attach( p_module, pp_cache[i]->p_module );
1657 p_module->b_submodule = VLC_TRUE;
1659 LOAD_STRING( p_module->psz_object_name );
1660 LOAD_STRING( p_module->psz_shortname );
1661 LOAD_STRING( p_module->psz_longname );
1662 LOAD_STRING( p_module->psz_program );
1663 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1665 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
1667 LOAD_STRING( p_module->psz_capability );
1668 LOAD_IMMEDIATE( p_module->i_score );
1669 LOAD_IMMEDIATE( p_module->i_cpu );
1670 LOAD_IMMEDIATE( p_module->b_unloadable );
1671 LOAD_IMMEDIATE( p_module->b_reentrant );
1680 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
1683 p_this->p_libvlc->p_module_bank->i_loaded_cache = 0;
1689 int CacheLoadConfig( module_t *p_module, FILE *file )
1694 /* Calculate the structure length */
1695 LOAD_IMMEDIATE( p_module->i_config_items );
1696 LOAD_IMMEDIATE( p_module->i_bool_items );
1698 LOAD_IMMEDIATE( i_lines );
1700 /* Allocate memory */
1701 p_module->p_config =
1702 (module_config_t *)malloc( sizeof(module_config_t) * (i_lines + 1));
1703 if( p_module->p_config == NULL )
1705 msg_Err( p_module, "config error: can't duplicate p_config" );
1709 /* Do the duplication job */
1710 for( i = 0; i < i_lines ; i++ )
1712 LOAD_IMMEDIATE( p_module->p_config[i] );
1714 LOAD_STRING( p_module->p_config[i].psz_type );
1715 LOAD_STRING( p_module->p_config[i].psz_name );
1716 LOAD_STRING( p_module->p_config[i].psz_text );
1717 LOAD_STRING( p_module->p_config[i].psz_longtext );
1718 LOAD_STRING( p_module->p_config[i].psz_value_orig );
1720 p_module->p_config[i].psz_value =
1721 p_module->p_config[i].psz_value_orig ?
1722 strdup( p_module->p_config[i].psz_value_orig ) : 0;
1723 p_module->p_config[i].i_value = p_module->p_config[i].i_value_orig;
1724 p_module->p_config[i].f_value = p_module->p_config[i].f_value_orig;
1726 p_module->p_config[i].p_lock = &p_module->object_lock;
1728 if( p_module->p_config[i].i_list )
1730 if( p_module->p_config[i].ppsz_list )
1732 p_module->p_config[i].ppsz_list =
1733 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1734 if( p_module->p_config[i].ppsz_list )
1736 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1737 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
1738 p_module->p_config[i].ppsz_list[j] = NULL;
1741 if( p_module->p_config[i].ppsz_list_text )
1743 p_module->p_config[i].ppsz_list_text =
1744 malloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
1745 if( p_module->p_config[i].ppsz_list_text )
1747 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1748 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
1749 p_module->p_config[i].ppsz_list_text[j] = NULL;
1752 if( p_module->p_config[i].pi_list )
1754 p_module->p_config[i].pi_list =
1755 malloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
1756 if( p_module->p_config[i].pi_list )
1758 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1759 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1764 if( p_module->p_config[i].i_action )
1766 p_module->p_config[i].ppf_action =
1767 malloc( p_module->p_config[i].i_action * sizeof(void *) );
1768 p_module->p_config[i].ppsz_action_text =
1769 malloc( p_module->p_config[i].i_action * sizeof(char *) );
1771 for( j = 0; j < p_module->p_config[i].i_action; j++ )
1773 p_module->p_config[i].ppf_action[j] = 0;
1774 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
1778 LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
1781 p_module->p_config[i].i_type = CONFIG_HINT_END;
1787 return VLC_EGENERIC;
1790 /*****************************************************************************
1791 * SavePluginsCache: saves the plugins cache to a file
1792 *****************************************************************************/
1793 static void CacheSave( vlc_object_t *p_this )
1795 char *psz_filename, *psz_homedir;
1798 module_cache_t **pp_cache;
1799 int32_t i_file_size = 0;
1801 psz_homedir = p_this->p_vlc->psz_homedir;
1804 msg_Err( p_this, "psz_homedir is null" );
1808 (char *)malloc( sizeof("/" CONFIG_DIR "/" PLUGINSCACHE_FILE) +
1809 strlen(psz_homedir) );
1812 sprintf( psz_filename, "%s/" CONFIG_DIR, psz_homedir );
1816 msg_Err( p_this, "out of memory" );
1820 config_CreateDir( p_this, psz_filename );
1822 strcat( psz_filename, "/" PLUGINSCACHE_FILE );
1824 msg_Dbg( p_this, "saving plugins cache file %s", psz_filename );
1826 file = fopen( psz_filename, "wb" );
1829 msg_Warn( p_this, "could not open plugins cache file %s for writing",
1831 free( psz_filename );
1834 free( psz_filename );
1836 /* Empty space for file size */
1837 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1839 /* Contains version number */
1840 fprintf( file, PLUGINSCACHE_FILE COPYRIGHT_MESSAGE );
1842 i_cache = p_this->p_libvlc->p_module_bank->i_cache;
1843 pp_cache = p_this->p_libvlc->p_module_bank->pp_cache;
1845 fwrite( &i_cache, sizeof(char), sizeof(i_cache), file );
1847 #define SAVE_IMMEDIATE(a) \
1848 fwrite( &a, sizeof(char), sizeof(a), file )
1849 #define SAVE_STRING(a) \
1850 { i_size = a ? strlen( a ) + 1 : 0; \
1851 fwrite( &i_size, sizeof(char), sizeof(i_size), file ); \
1852 if( a ) fwrite( a, sizeof(char), i_size, file ); \
1855 for( i = 0; i < i_cache; i++ )
1858 int32_t i_submodule;
1860 /* Save common info */
1861 SAVE_STRING( pp_cache[i]->psz_file );
1862 SAVE_IMMEDIATE( pp_cache[i]->i_time );
1863 SAVE_IMMEDIATE( pp_cache[i]->i_size );
1864 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
1866 if( pp_cache[i]->b_junk ) continue;
1868 /* Save additional infos */
1869 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
1870 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
1871 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
1872 SAVE_STRING( pp_cache[i]->p_module->psz_program );
1873 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1875 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
1877 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
1878 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
1879 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_cpu );
1880 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
1881 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_reentrant );
1882 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
1885 CacheSaveConfig( pp_cache[i]->p_module, file );
1887 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
1889 i_submodule = pp_cache[i]->p_module->i_children;
1890 SAVE_IMMEDIATE( i_submodule );
1891 for( i_submodule = 0; i_submodule < pp_cache[i]->p_module->i_children;
1894 module_t *p_module =
1895 (module_t *)pp_cache[i]->p_module->pp_children[i_submodule];
1897 SAVE_STRING( p_module->psz_object_name );
1898 SAVE_STRING( p_module->psz_shortname );
1899 SAVE_STRING( p_module->psz_longname );
1900 SAVE_STRING( p_module->psz_program );
1901 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
1903 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIX
1905 SAVE_STRING( p_module->psz_capability );
1906 SAVE_IMMEDIATE( p_module->i_score );
1907 SAVE_IMMEDIATE( p_module->i_cpu );
1908 SAVE_IMMEDIATE( p_module->b_unloadable );
1909 SAVE_IMMEDIATE( p_module->b_reentrant );
1913 /* Fill-up file size */
1914 i_file_size = ftell( file );
1915 fseek( file, 0, SEEK_SET );
1916 fwrite( &i_file_size, sizeof(char), sizeof(i_file_size), file );
1923 void CacheSaveConfig( module_t *p_module, FILE *file )
1925 int i, j, i_lines = 0;
1926 module_config_t *p_item;
1929 SAVE_IMMEDIATE( p_module->i_config_items );
1930 SAVE_IMMEDIATE( p_module->i_bool_items );
1932 for( p_item = p_module->p_config; p_item->i_type != CONFIG_HINT_END;
1933 p_item++ ) i_lines++;
1935 SAVE_IMMEDIATE( i_lines );
1937 for( i = 0; i < i_lines ; i++ )
1939 SAVE_IMMEDIATE( p_module->p_config[i] );
1941 SAVE_STRING( p_module->p_config[i].psz_type );
1942 SAVE_STRING( p_module->p_config[i].psz_name );
1943 SAVE_STRING( p_module->p_config[i].psz_text );
1944 SAVE_STRING( p_module->p_config[i].psz_longtext );
1945 SAVE_STRING( p_module->p_config[i].psz_value_orig );
1947 if( p_module->p_config[i].i_list )
1949 if( p_module->p_config[i].ppsz_list )
1951 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1952 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
1955 if( p_module->p_config[i].ppsz_list_text )
1957 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1958 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
1960 if( p_module->p_config[i].pi_list )
1962 for( j = 0; j < p_module->p_config[i].i_list; j++ )
1963 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
1967 for( j = 0; j < p_module->p_config[i].i_action; j++ )
1968 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
1970 SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
1974 /*****************************************************************************
1975 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
1976 *****************************************************************************/
1977 static void CacheMerge( vlc_object_t *p_this, module_t *p_cache,
1978 module_t *p_module )
1982 p_cache->pf_activate = p_module->pf_activate;
1983 p_cache->pf_deactivate = p_module->pf_deactivate;
1984 p_cache->p_symbols = p_module->p_symbols;
1985 p_cache->handle = p_module->handle;
1987 for( i_submodule = 0; i_submodule < p_module->i_children; i_submodule++ )
1989 module_t *p_child = (module_t*)p_module->pp_children[i_submodule];
1990 module_t *p_cchild = (module_t*)p_cache->pp_children[i_submodule];
1991 p_cchild->pf_activate = p_child->pf_activate;
1992 p_cchild->pf_deactivate = p_child->pf_deactivate;
1993 p_cchild->p_symbols = p_child->p_symbols;
1996 p_cache->b_loaded = VLC_TRUE;
1997 p_module->b_loaded = VLC_FALSE;
2000 /*****************************************************************************
2001 * FindPluginCache: finds the cache entry corresponding to a file
2002 *****************************************************************************/
2003 static module_cache_t *CacheFind( vlc_object_t *p_this, char *psz_file,
2004 int64_t i_time, int64_t i_size )
2006 module_cache_t **pp_cache;
2009 pp_cache = p_this->p_libvlc->p_module_bank->pp_loaded_cache;
2010 i_cache = p_this->p_libvlc->p_module_bank->i_loaded_cache;
2012 for( i = 0; i < i_cache; i++ )
2014 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
2015 pp_cache[i]->i_time == i_time &&
2016 pp_cache[i]->i_size == i_size ) return pp_cache[i];
2022 #endif /* HAVE_DYNAMIC_PLUGINS */