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 #ifdef HAVE_SYS_TYPES_H
41 # include <sys/types.h>
47 #if !defined(HAVE_DYNAMIC_PLUGINS)
48 /* no support for plugins */
49 #elif defined(HAVE_DL_DYLD)
50 # if defined(HAVE_MACH_O_DYLD_H)
51 # include <mach-o/dyld.h>
53 #elif defined(HAVE_DL_BEOS)
54 # if defined(HAVE_IMAGE_H)
57 #elif defined(HAVE_DL_WINDOWS)
59 #elif defined(HAVE_DL_DLOPEN)
60 # if defined(HAVE_DLFCN_H) /* Linux, BSD, Hurd */
63 # if defined(HAVE_SYS_DL_H)
66 #elif defined(HAVE_DL_SHL_LOAD)
67 # if defined(HAVE_DL_H)
72 #include "config/configuration.h"
74 #include "vlc_charset.h"
76 #include "modules/modules.h"
79 /*****************************************************************************
81 *****************************************************************************/
82 #ifdef HAVE_DYNAMIC_PLUGINS
83 static int CacheLoadConfig ( module_t *, FILE * );
84 static int CacheSaveConfig ( module_t *, FILE * );
87 * (only used to avoid breakage in dev version when cache structure changes) */
88 #define CACHE_SUBVERSION_NUM 7
90 /* Format string for the cache filename */
91 #define CACHENAME_FORMAT \
92 "plugins-%.2zx%.2zx%.2"PRIx8"-%x.dat"
93 /* Magic for the cache filename */
94 #define CACHENAME_VALUES \
95 sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
98 /*****************************************************************************
99 * LoadPluginsCache: loads the plugins cache file
100 *****************************************************************************
101 * This function will load the plugin cache if present and valid. This cache
102 * will in turn be queried by AllocateAllPlugins() to see if it needs to
103 * actually load the dynamically loadable module.
104 * This allows us to only fully load plugins when they are actually used.
105 *****************************************************************************/
106 void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
108 char *psz_filename, *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
110 int i, j, i_size, i_read;
111 char p_cachestring[sizeof("cache " COPYRIGHT_MESSAGE)];
113 module_cache_t **pp_cache = 0;
114 int32_t i_file_size, i_marker;
116 if( !psz_cachedir ) /* XXX: this should never happen */
118 msg_Err( p_this, "Unable to get cache directory" );
122 if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
123 psz_cachedir, CACHENAME_VALUES ) == -1 )
125 free( psz_cachedir );
128 free( psz_cachedir );
132 #if !defined( UNDER_CE )
133 unlink( psz_filename );
135 wchar_t psz_wf[MAX_PATH];
136 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
137 DeleteFile( psz_wf );
139 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
140 free( psz_filename );
144 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
146 file = utf8_fopen( psz_filename, "rb" );
149 msg_Warn( p_this, "could not open plugins cache file %s for reading",
151 free( psz_filename );
154 free( psz_filename );
156 /* Check the file size */
157 i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
158 if( i_read != sizeof(i_file_size) )
160 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
166 fseek( file, 0, SEEK_END );
167 if( ftell( file ) != i_file_size )
169 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
170 "(corrupted size)" );
174 fseek( file, sizeof(i_file_size), SEEK_SET );
176 /* Check the file is a plugins cache */
177 i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
178 i_read = fread( p_cachestring, 1, i_size, file );
179 if( i_read != i_size ||
180 memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
182 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
187 #ifdef DISTRO_VERSION
188 /* Check for distribution specific version */
189 char p_distrostring[sizeof( DISTRO_VERSION )];
190 i_size = sizeof( DISTRO_VERSION ) - 1;
191 i_read = fread( p_distrostring, 1, i_size, file );
192 if( i_read != i_size ||
193 memcmp( p_distrostring, DISTRO_VERSION, i_size ) )
195 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
201 /* Check Sub-version number */
202 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
203 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
205 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
206 "(corrupted header)" );
211 /* Check header marker */
212 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
213 if( i_read != sizeof(i_marker) ||
214 i_marker != ftell( file ) - (int)sizeof(i_marker) )
216 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
217 "(corrupted header)" );
222 p_bank->i_loaded_cache = 0;
223 if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
225 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
226 "(file too short)" );
232 pp_cache = p_bank->pp_loaded_cache =
233 xmalloc( i_cache * sizeof(void *) );
235 #define LOAD_IMMEDIATE(a) \
236 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
237 #define LOAD_STRING(a) \
240 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
241 || ( i_size > 16384 ) ) \
244 char *psz = xmalloc( i_size ); \
245 if( fread( psz, i_size, 1, file ) != 1 ) { \
249 if( psz[i_size-1] ) { \
257 for( i = 0; i < i_cache; i++ )
262 pp_cache[i] = xmalloc( sizeof(module_cache_t) );
263 p_bank->i_loaded_cache++;
265 /* Load common info */
266 LOAD_STRING( pp_cache[i]->psz_file );
267 LOAD_IMMEDIATE( pp_cache[i]->i_time );
268 LOAD_IMMEDIATE( pp_cache[i]->i_size );
269 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
270 pp_cache[i]->b_used = false;
272 if( pp_cache[i]->b_junk ) continue;
274 pp_cache[i]->p_module = vlc_module_create( p_this );
276 /* Load additional infos */
277 free( pp_cache[i]->p_module->psz_object_name );
278 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
279 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
280 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
281 LOAD_STRING( pp_cache[i]->p_module->psz_help );
282 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
284 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
286 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
287 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
288 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
289 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
292 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
295 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
297 LOAD_IMMEDIATE( i_submodules );
299 while( i_submodules-- )
301 module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
302 free( p_module->psz_object_name );
303 LOAD_STRING( p_module->psz_object_name );
304 LOAD_STRING( p_module->psz_shortname );
305 LOAD_STRING( p_module->psz_longname );
306 LOAD_STRING( p_module->psz_help );
307 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
309 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
311 LOAD_STRING( p_module->psz_capability );
312 LOAD_IMMEDIATE( p_module->i_score );
313 LOAD_IMMEDIATE( p_module->b_unloadable );
322 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
325 p_bank->i_loaded_cache = 0;
332 static int CacheLoadConfig( module_t *p_module, FILE *file )
337 /* Calculate the structure length */
338 LOAD_IMMEDIATE( p_module->i_config_items );
339 LOAD_IMMEDIATE( p_module->i_bool_items );
341 LOAD_IMMEDIATE( i_lines );
343 /* Allocate memory */
347 (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
348 if( p_module->p_config == NULL )
350 p_module->confsize = 0;
354 p_module->confsize = i_lines;
356 /* Do the duplication job */
357 for (size_t i = 0; i < i_lines; i++ )
359 LOAD_IMMEDIATE( p_module->p_config[i] );
361 LOAD_STRING( p_module->p_config[i].psz_type );
362 LOAD_STRING( p_module->p_config[i].psz_name );
363 LOAD_STRING( p_module->p_config[i].psz_text );
364 LOAD_STRING( p_module->p_config[i].psz_longtext );
365 LOAD_STRING( p_module->p_config[i].psz_oldname );
366 LOAD_IMMEDIATE( p_module->p_config[i].b_removed );
368 if (IsConfigStringType (p_module->p_config[i].i_type))
370 LOAD_STRING (p_module->p_config[i].orig.psz);
371 p_module->p_config[i].value.psz =
372 (p_module->p_config[i].orig.psz != NULL)
373 ? strdup (p_module->p_config[i].orig.psz) : NULL;
374 p_module->p_config[i].saved.psz = NULL;
378 memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
379 sizeof (p_module->p_config[i].value));
380 memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
381 sizeof (p_module->p_config[i].saved));
384 p_module->p_config[i].b_dirty = false;
386 p_module->p_config[i].p_lock = &p_module->lock;
388 if( p_module->p_config[i].i_list )
390 if( p_module->p_config[i].ppsz_list )
393 p_module->p_config[i].ppsz_list =
394 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
395 if( p_module->p_config[i].ppsz_list )
397 for( j = 0; j < p_module->p_config[i].i_list; j++ )
398 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
399 p_module->p_config[i].ppsz_list[j] = NULL;
402 if( p_module->p_config[i].ppsz_list_text )
405 p_module->p_config[i].ppsz_list_text =
406 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
407 if( p_module->p_config[i].ppsz_list_text )
409 for( j = 0; j < p_module->p_config[i].i_list; j++ )
410 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
411 p_module->p_config[i].ppsz_list_text[j] = NULL;
414 if( p_module->p_config[i].pi_list )
416 p_module->p_config[i].pi_list =
417 xmalloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
418 if( p_module->p_config[i].pi_list )
420 for (int j = 0; j < p_module->p_config[i].i_list; j++)
421 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
426 if( p_module->p_config[i].i_action )
428 p_module->p_config[i].ppf_action =
429 xmalloc( p_module->p_config[i].i_action * sizeof(void *) );
430 p_module->p_config[i].ppsz_action_text =
431 xmalloc( p_module->p_config[i].i_action * sizeof(char *) );
433 for (int j = 0; j < p_module->p_config[i].i_action; j++)
435 p_module->p_config[i].ppf_action[j] = 0;
436 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
440 LOAD_IMMEDIATE( p_module->p_config[i].pf_callback );
450 static int CacheSaveSubmodule( FILE *file, module_t *p_module );
452 /*****************************************************************************
453 * SavePluginsCache: saves the plugins cache to a file
454 *****************************************************************************/
455 void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
457 static char const psz_tag[] =
458 "Signature: 8a477f597d28d172789f06886806bc55\r\n"
459 "# This file is a cache directory tag created by VLC.\r\n"
460 "# For information about cache directory tags, see:\r\n"
461 "# http://www.brynosaurus.com/cachedir/\r\n";
463 char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
466 module_cache_t **pp_cache;
467 uint32_t i_file_size = 0;
469 if( !psz_cachedir ) /* XXX: this should never happen */
471 msg_Err( p_this, "unable to get cache directory" );
475 char psz_filename[sizeof(DIR_SEP) + 32 + strlen(psz_cachedir)];
476 config_CreateDir( p_this, psz_cachedir );
478 snprintf( psz_filename, sizeof( psz_filename ),
479 "%s"DIR_SEP"CACHEDIR.TAG", psz_cachedir );
480 file = utf8_fopen( psz_filename, "wb" );
483 if (fwrite (psz_tag, 1, sizeof (psz_tag) - 1, file) != 1)
484 clearerr (file); /* what else can we do? */
488 snprintf( psz_filename, sizeof( psz_filename ),
489 "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
491 free( psz_cachedir );
492 msg_Dbg( p_this, "writing plugins cache %s", psz_filename );
494 char psz_tmpname[sizeof (psz_filename) + 12];
495 snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
496 (uint32_t)getpid ());
497 file = utf8_fopen( psz_tmpname, "wb" );
501 /* Empty space for file size */
502 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
505 /* Contains version number */
506 if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
508 #ifdef DISTRO_VERSION
509 /* Allow binary maintaner to pass a string to detect new binary version*/
510 if (fputs( DISTRO_VERSION, file ) == EOF)
513 /* Sub-version number (to avoid breakage in the dev version when cache
514 * structure changes) */
515 i_file_size = CACHE_SUBVERSION_NUM;
516 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1 )
520 i_file_size = ftell( file );
521 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
524 i_cache = p_bank->i_cache;
525 pp_cache = p_bank->pp_cache;
527 if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
530 #define SAVE_IMMEDIATE( a ) \
531 if (fwrite (&a, sizeof(a), 1, file) != 1) \
533 #define SAVE_STRING( a ) \
535 uint16_t i_size = (a != NULL) ? (strlen (a) + 1) : 0; \
536 if ((fwrite (&i_size, sizeof (i_size), 1, file) != 1) \
537 || (a && (fwrite (a, 1, i_size, file) != i_size))) \
541 for( i = 0; i < i_cache; i++ )
543 uint32_t i_submodule;
545 /* Save common info */
546 SAVE_STRING( pp_cache[i]->psz_file );
547 SAVE_IMMEDIATE( pp_cache[i]->i_time );
548 SAVE_IMMEDIATE( pp_cache[i]->i_size );
549 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
551 if( pp_cache[i]->b_junk ) continue;
553 /* Save additional infos */
554 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
555 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
556 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
557 SAVE_STRING( pp_cache[i]->p_module->psz_help );
558 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
560 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
562 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
563 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
564 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
565 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
568 if (CacheSaveConfig (pp_cache[i]->p_module, file))
571 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
573 i_submodule = pp_cache[i]->p_module->submodule_count;
574 SAVE_IMMEDIATE( i_submodule );
575 if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) )
579 /* Fill-up file size */
580 i_file_size = ftell( file );
581 fseek( file, 0, SEEK_SET );
582 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1
583 || fflush (file)) /* flush libc buffers */
587 utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
590 utf8_unlink (psz_filename);
592 utf8_rename (psz_tmpname, psz_filename);
594 return; /* success! */
597 msg_Warn (p_this, "could not write plugins cache %s (%m)",
606 static int CacheSaveSubmodule( FILE *file, module_t *p_module )
610 if( CacheSaveSubmodule( file, p_module->next ) )
613 SAVE_STRING( p_module->psz_object_name );
614 SAVE_STRING( p_module->psz_shortname );
615 SAVE_STRING( p_module->psz_longname );
616 SAVE_STRING( p_module->psz_help );
617 for( unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++ )
618 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIXME
620 SAVE_STRING( p_module->psz_capability );
621 SAVE_IMMEDIATE( p_module->i_score );
622 SAVE_IMMEDIATE( p_module->b_unloadable );
630 static int CacheSaveConfig( module_t *p_module, FILE *file )
632 uint32_t i_lines = p_module->confsize;
634 SAVE_IMMEDIATE( p_module->i_config_items );
635 SAVE_IMMEDIATE( p_module->i_bool_items );
636 SAVE_IMMEDIATE( i_lines );
638 for (size_t i = 0; i < i_lines ; i++)
640 SAVE_IMMEDIATE( p_module->p_config[i] );
642 SAVE_STRING( p_module->p_config[i].psz_type );
643 SAVE_STRING( p_module->p_config[i].psz_name );
644 SAVE_STRING( p_module->p_config[i].psz_text );
645 SAVE_STRING( p_module->p_config[i].psz_longtext );
646 SAVE_STRING( p_module->p_config[i].psz_oldname );
647 SAVE_IMMEDIATE( p_module->p_config[i].b_removed );
649 if (IsConfigStringType (p_module->p_config[i].i_type))
650 SAVE_STRING( p_module->p_config[i].orig.psz );
652 if( p_module->p_config[i].i_list )
654 if( p_module->p_config[i].ppsz_list )
656 for (int j = 0; j < p_module->p_config[i].i_list; j++)
657 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
660 if( p_module->p_config[i].ppsz_list_text )
662 for (int j = 0; j < p_module->p_config[i].i_list; j++)
663 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
665 if( p_module->p_config[i].pi_list )
667 for (int j = 0; j < p_module->p_config[i].i_list; j++)
668 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
672 for (int j = 0; j < p_module->p_config[i].i_action; j++)
673 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
675 SAVE_IMMEDIATE( p_module->p_config[i].pf_callback );
683 /*****************************************************************************
684 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
685 *****************************************************************************/
686 void CacheMerge( vlc_object_t *p_this, module_t *p_cache, module_t *p_module )
690 p_cache->pf_activate = p_module->pf_activate;
691 p_cache->pf_deactivate = p_module->pf_deactivate;
692 p_cache->handle = p_module->handle;
694 /* FIXME: This looks too simplistic an algorithm to me. What if the module
695 * file was altered such that the number of order of submodules was
696 * altered... after VLC started -- Courmisch, 09/2008 */
697 module_t *p_child = p_module->submodule,
698 *p_cchild = p_cache->submodule;
699 while( p_child && p_cchild )
701 p_cchild->pf_activate = p_child->pf_activate;
702 p_cchild->pf_deactivate = p_child->pf_deactivate;
703 p_child = p_child->next;
704 p_cchild = p_cchild->next;
707 p_cache->b_loaded = true;
708 p_module->b_loaded = false;
711 /*****************************************************************************
712 * CacheFind: finds the cache entry corresponding to a file
713 *****************************************************************************/
714 module_cache_t *CacheFind( module_bank_t *p_bank, const char *psz_file,
715 int64_t i_time, int64_t i_size )
717 module_cache_t **pp_cache;
720 pp_cache = p_bank->pp_loaded_cache;
721 i_cache = p_bank->i_loaded_cache;
723 for( i = 0; i < i_cache; i++ )
725 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
726 pp_cache[i]->i_time == i_time &&
727 pp_cache[i]->i_size == i_size ) return pp_cache[i];
733 #endif /* HAVE_DYNAMIC_PLUGINS */