1 /*****************************************************************************
2 * cache.c: Plugins cache
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>
34 #include <stdlib.h> /* free(), strtol() */
35 #include <stdio.h> /* sprintf() */
36 #include <string.h> /* strdup() */
37 #include <vlc_plugin.h>
40 #include <sys/types.h>
46 #if !defined(HAVE_DYNAMIC_PLUGINS)
47 /* no support for plugins */
48 #elif defined(HAVE_DL_DYLD)
49 # if defined(HAVE_MACH_O_DYLD_H)
50 # include <mach-o/dyld.h>
52 #elif defined(HAVE_DL_BEOS)
53 # if defined(HAVE_IMAGE_H)
56 #elif defined(HAVE_DL_WINDOWS)
58 #elif defined(HAVE_DL_DLOPEN)
59 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
62 # if defined(HAVE_SYS_DL_H)
65 #elif defined(HAVE_DL_SHL_LOAD)
66 # if defined(HAVE_DL_H)
71 #include "config/configuration.h"
73 #include "vlc_charset.h"
75 #include "modules/modules.h"
78 /*****************************************************************************
80 *****************************************************************************/
81 #ifdef HAVE_DYNAMIC_PLUGINS
82 static int CacheLoadConfig ( module_t *, FILE * );
83 static int CacheSaveConfig ( module_t *, FILE * );
86 * (only used to avoid breakage in dev version when cache structure changes) */
87 #define CACHE_SUBVERSION_NUM 8
89 /* Format string for the cache filename */
90 #define CACHENAME_FORMAT \
91 "plugins-%.2zx%.2zx%.2"PRIx8"-%x.dat"
92 /* Magic for the cache filename */
93 #define CACHENAME_VALUES \
94 sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
97 /*****************************************************************************
98 * LoadPluginsCache: loads the plugins cache file
99 *****************************************************************************
100 * This function will load the plugin cache if present and valid. This cache
101 * will in turn be queried by AllocateAllPlugins() to see if it needs to
102 * actually load the dynamically loadable module.
103 * This allows us to only fully load plugins when they are actually used.
104 *****************************************************************************/
105 void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
107 char *psz_filename, *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
109 int i, j, i_size, i_read;
110 char p_cachestring[sizeof("cache " COPYRIGHT_MESSAGE)];
112 module_cache_t **pp_cache = 0;
113 int32_t i_file_size, i_marker;
115 if( !psz_cachedir ) /* XXX: this should never happen */
117 msg_Err( p_this, "Unable to get cache directory" );
121 if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
122 psz_cachedir, CACHENAME_VALUES ) == -1 )
124 free( psz_cachedir );
127 free( psz_cachedir );
131 #if !defined( UNDER_CE )
132 unlink( psz_filename );
134 wchar_t psz_wf[MAX_PATH];
135 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
136 DeleteFile( psz_wf );
138 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
139 free( psz_filename );
143 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
145 file = utf8_fopen( psz_filename, "rb" );
148 msg_Warn( p_this, "could not open plugins cache file %s for reading",
150 free( psz_filename );
153 free( psz_filename );
155 /* Check the file size */
156 i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
157 if( i_read != sizeof(i_file_size) )
159 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
165 fseek( file, 0, SEEK_END );
166 if( ftell( file ) != i_file_size )
168 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
169 "(corrupted size)" );
173 fseek( file, sizeof(i_file_size), SEEK_SET );
175 /* Check the file is a plugins cache */
176 i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
177 i_read = fread( p_cachestring, 1, i_size, file );
178 if( i_read != i_size ||
179 memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
181 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
186 #ifdef DISTRO_VERSION
187 /* Check for distribution specific version */
188 char p_distrostring[sizeof( DISTRO_VERSION )];
189 i_size = sizeof( DISTRO_VERSION ) - 1;
190 i_read = fread( p_distrostring, 1, i_size, file );
191 if( i_read != i_size ||
192 memcmp( p_distrostring, DISTRO_VERSION, i_size ) )
194 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
200 /* Check Sub-version number */
201 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
202 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
204 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
205 "(corrupted header)" );
210 /* Check header marker */
211 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
212 if( i_read != sizeof(i_marker) ||
213 i_marker != ftell( file ) - (int)sizeof(i_marker) )
215 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
216 "(corrupted header)" );
221 p_bank->i_loaded_cache = 0;
222 if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
224 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
225 "(file too short)" );
231 pp_cache = p_bank->pp_loaded_cache =
232 xmalloc( i_cache * sizeof(void *) );
234 #define LOAD_IMMEDIATE(a) \
235 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
236 #define LOAD_STRING(a) \
239 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
240 || ( i_size > 16384 ) ) \
243 char *psz = xmalloc( i_size ); \
244 if( fread( psz, i_size, 1, file ) != 1 ) { \
248 if( psz[i_size-1] ) { \
256 for( i = 0; i < i_cache; i++ )
261 pp_cache[i] = xmalloc( sizeof(module_cache_t) );
262 p_bank->i_loaded_cache++;
264 /* Load common info */
265 LOAD_STRING( pp_cache[i]->psz_file );
266 LOAD_IMMEDIATE( pp_cache[i]->i_time );
267 LOAD_IMMEDIATE( pp_cache[i]->i_size );
268 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
269 pp_cache[i]->b_used = false;
271 if( pp_cache[i]->b_junk ) continue;
273 pp_cache[i]->p_module = vlc_module_create( p_this );
275 /* Load additional infos */
276 free( pp_cache[i]->p_module->psz_object_name );
277 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
278 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
279 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
280 LOAD_STRING( pp_cache[i]->p_module->psz_help );
281 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
283 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
285 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
286 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
287 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
288 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
291 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
294 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
296 LOAD_IMMEDIATE( i_submodules );
298 while( i_submodules-- )
300 module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
301 free( p_module->psz_object_name );
302 LOAD_STRING( p_module->psz_object_name );
303 LOAD_STRING( p_module->psz_shortname );
304 LOAD_STRING( p_module->psz_longname );
305 LOAD_STRING( p_module->psz_help );
306 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
308 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
310 LOAD_STRING( p_module->psz_capability );
311 LOAD_IMMEDIATE( p_module->i_score );
312 LOAD_IMMEDIATE( p_module->b_unloadable );
321 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
324 p_bank->i_loaded_cache = 0;
331 /* This function should never be called.
332 * It is only used as a non-NULL vlc_callback_t value for comparison. */
333 static int dummy_callback (vlc_object_t *obj, const char *name,
334 vlc_value_t oldval, vlc_value_t newval, void *data)
336 (void) obj; (void)name; (void)oldval; (void)newval; (void)data;
341 static int CacheLoadConfig( module_t *p_module, FILE *file )
346 /* Calculate the structure length */
347 LOAD_IMMEDIATE( p_module->i_config_items );
348 LOAD_IMMEDIATE( p_module->i_bool_items );
350 LOAD_IMMEDIATE( i_lines );
352 /* Allocate memory */
356 (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
357 if( p_module->p_config == NULL )
359 p_module->confsize = 0;
363 p_module->confsize = i_lines;
365 /* Do the duplication job */
366 for (size_t i = 0; i < i_lines; i++ )
368 LOAD_IMMEDIATE( p_module->p_config[i] );
370 LOAD_STRING( p_module->p_config[i].psz_type );
371 LOAD_STRING( p_module->p_config[i].psz_name );
372 LOAD_STRING( p_module->p_config[i].psz_text );
373 LOAD_STRING( p_module->p_config[i].psz_longtext );
374 LOAD_STRING( p_module->p_config[i].psz_oldname );
375 LOAD_IMMEDIATE( p_module->p_config[i].b_removed );
377 if (IsConfigStringType (p_module->p_config[i].i_type))
379 LOAD_STRING (p_module->p_config[i].orig.psz);
380 p_module->p_config[i].value.psz =
381 (p_module->p_config[i].orig.psz != NULL)
382 ? strdup (p_module->p_config[i].orig.psz) : NULL;
383 p_module->p_config[i].saved.psz = NULL;
387 memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
388 sizeof (p_module->p_config[i].value));
389 memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
390 sizeof (p_module->p_config[i].saved));
393 p_module->p_config[i].b_dirty = false;
395 if( p_module->p_config[i].i_list )
397 if( p_module->p_config[i].ppsz_list )
400 p_module->p_config[i].ppsz_list =
401 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
402 if( p_module->p_config[i].ppsz_list )
404 for( j = 0; j < p_module->p_config[i].i_list; j++ )
405 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
406 p_module->p_config[i].ppsz_list[j] = NULL;
409 if( p_module->p_config[i].ppsz_list_text )
412 p_module->p_config[i].ppsz_list_text =
413 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
414 if( p_module->p_config[i].ppsz_list_text )
416 for( j = 0; j < p_module->p_config[i].i_list; j++ )
417 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
418 p_module->p_config[i].ppsz_list_text[j] = NULL;
421 if( p_module->p_config[i].pi_list )
423 p_module->p_config[i].pi_list =
424 xmalloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
425 if( p_module->p_config[i].pi_list )
427 for (int j = 0; j < p_module->p_config[i].i_list; j++)
428 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
433 if( p_module->p_config[i].i_action )
435 p_module->p_config[i].ppf_action =
436 xmalloc( p_module->p_config[i].i_action * sizeof(void *) );
437 p_module->p_config[i].ppsz_action_text =
438 xmalloc( p_module->p_config[i].i_action * sizeof(char *) );
440 for (int j = 0; j < p_module->p_config[i].i_action; j++)
442 p_module->p_config[i].ppf_action[j] = NULL;
443 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
448 LOAD_IMMEDIATE( has_callback );
450 p_module->p_config[i].pf_callback = dummy_callback;
460 static int CacheSaveSubmodule( FILE *file, module_t *p_module );
462 /*****************************************************************************
463 * SavePluginsCache: saves the plugins cache to a file
464 *****************************************************************************/
465 void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
467 char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
470 module_cache_t **pp_cache;
471 uint32_t i_file_size = 0;
473 if( !psz_cachedir ) /* XXX: this should never happen */
475 msg_Err( p_this, "unable to get cache directory" );
479 char psz_filename[sizeof(DIR_SEP) + 32 + strlen(psz_cachedir)];
480 config_CreateDir( p_this, psz_cachedir );
482 snprintf( psz_filename, sizeof( psz_filename ),
483 "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
485 free( psz_cachedir );
486 msg_Dbg( p_this, "writing plugins cache %s", psz_filename );
488 char psz_tmpname[sizeof (psz_filename) + 12];
489 snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
490 (uint32_t)getpid ());
491 file = utf8_fopen( psz_tmpname, "wb" );
495 /* Empty space for file size */
496 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
499 /* Contains version number */
500 if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
502 #ifdef DISTRO_VERSION
503 /* Allow binary maintaner to pass a string to detect new binary version*/
504 if (fputs( DISTRO_VERSION, file ) == EOF)
507 /* Sub-version number (to avoid breakage in the dev version when cache
508 * structure changes) */
509 i_file_size = CACHE_SUBVERSION_NUM;
510 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1 )
514 i_file_size = ftell( file );
515 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
518 i_cache = p_bank->i_cache;
519 pp_cache = p_bank->pp_cache;
521 if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
524 #define SAVE_IMMEDIATE( a ) \
525 if (fwrite (&a, sizeof(a), 1, file) != 1) \
527 #define SAVE_STRING( a ) \
529 uint16_t i_size = (a != NULL) ? (strlen (a) + 1) : 0; \
530 if ((fwrite (&i_size, sizeof (i_size), 1, file) != 1) \
531 || (a && (fwrite (a, 1, i_size, file) != i_size))) \
535 for( i = 0; i < i_cache; i++ )
537 uint32_t i_submodule;
539 /* Save common info */
540 SAVE_STRING( pp_cache[i]->psz_file );
541 SAVE_IMMEDIATE( pp_cache[i]->i_time );
542 SAVE_IMMEDIATE( pp_cache[i]->i_size );
543 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
545 if( pp_cache[i]->b_junk ) continue;
547 /* Save additional infos */
548 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
549 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
550 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
551 SAVE_STRING( pp_cache[i]->p_module->psz_help );
552 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
554 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
556 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
557 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
558 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
559 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
562 if (CacheSaveConfig (pp_cache[i]->p_module, file))
565 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
567 i_submodule = pp_cache[i]->p_module->submodule_count;
568 SAVE_IMMEDIATE( i_submodule );
569 if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) )
573 /* Fill-up file size */
574 i_file_size = ftell( file );
575 fseek( file, 0, SEEK_SET );
576 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1
577 || fflush (file)) /* flush libc buffers */
581 utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
584 utf8_unlink (psz_filename);
586 utf8_rename (psz_tmpname, psz_filename);
588 return; /* success! */
591 msg_Warn (p_this, "could not write plugins cache %s (%m)",
600 static int CacheSaveSubmodule( FILE *file, module_t *p_module )
604 if( CacheSaveSubmodule( file, p_module->next ) )
607 SAVE_STRING( p_module->psz_object_name );
608 SAVE_STRING( p_module->psz_shortname );
609 SAVE_STRING( p_module->psz_longname );
610 SAVE_STRING( p_module->psz_help );
611 for( unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++ )
612 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIXME
614 SAVE_STRING( p_module->psz_capability );
615 SAVE_IMMEDIATE( p_module->i_score );
616 SAVE_IMMEDIATE( p_module->b_unloadable );
624 static int CacheSaveConfig( module_t *p_module, FILE *file )
626 uint32_t i_lines = p_module->confsize;
628 SAVE_IMMEDIATE( p_module->i_config_items );
629 SAVE_IMMEDIATE( p_module->i_bool_items );
630 SAVE_IMMEDIATE( i_lines );
632 for (size_t i = 0; i < i_lines ; i++)
634 SAVE_IMMEDIATE( p_module->p_config[i] );
636 SAVE_STRING( p_module->p_config[i].psz_type );
637 SAVE_STRING( p_module->p_config[i].psz_name );
638 SAVE_STRING( p_module->p_config[i].psz_text );
639 SAVE_STRING( p_module->p_config[i].psz_longtext );
640 SAVE_STRING( p_module->p_config[i].psz_oldname );
641 SAVE_IMMEDIATE( p_module->p_config[i].b_removed );
643 if (IsConfigStringType (p_module->p_config[i].i_type))
644 SAVE_STRING( p_module->p_config[i].orig.psz );
646 if( p_module->p_config[i].i_list )
648 if( p_module->p_config[i].ppsz_list )
650 for (int j = 0; j < p_module->p_config[i].i_list; j++)
651 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
654 if( p_module->p_config[i].ppsz_list_text )
656 for (int j = 0; j < p_module->p_config[i].i_list; j++)
657 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
659 if( p_module->p_config[i].pi_list )
661 for (int j = 0; j < p_module->p_config[i].i_list; j++)
662 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
666 for (int j = 0; j < p_module->p_config[i].i_action; j++)
667 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
669 bool has_callback = p_module->p_config[i].pf_callback != NULL;
670 SAVE_IMMEDIATE( has_callback );
678 /*****************************************************************************
679 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
680 *****************************************************************************/
681 void CacheMerge( vlc_object_t *p_this, module_t *p_cache, module_t *p_module )
685 p_cache->pf_activate = p_module->pf_activate;
686 p_cache->pf_deactivate = p_module->pf_deactivate;
687 p_cache->handle = p_module->handle;
689 /* FIXME: This looks too simplistic an algorithm to me. What if the module
690 * file was altered such that the number of order of submodules was
691 * altered... after VLC started -- Courmisch, 09/2008 */
692 module_t *p_child = p_module->submodule,
693 *p_cchild = p_cache->submodule;
694 while( p_child && p_cchild )
696 p_cchild->pf_activate = p_child->pf_activate;
697 p_cchild->pf_deactivate = p_child->pf_deactivate;
698 p_child = p_child->next;
699 p_cchild = p_cchild->next;
702 p_cache->b_loaded = true;
703 p_module->b_loaded = false;
706 /*****************************************************************************
707 * CacheFind: finds the cache entry corresponding to a file
708 *****************************************************************************/
709 module_cache_t *CacheFind( module_bank_t *p_bank, const char *psz_file,
710 int64_t i_time, int64_t i_size )
712 module_cache_t **pp_cache;
715 pp_cache = p_bank->pp_loaded_cache;
716 i_cache = p_bank->i_loaded_cache;
718 for( i = 0; i < i_cache; i++ )
720 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
721 pp_cache[i]->i_time == i_time &&
722 pp_cache[i]->i_size == i_size ) return pp_cache[i];
728 #endif /* HAVE_DYNAMIC_PLUGINS */