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 #include "config/configuration.h"
48 #include "vlc_charset.h"
50 #include "modules/modules.h"
53 /*****************************************************************************
55 *****************************************************************************/
56 #ifdef HAVE_DYNAMIC_PLUGINS
57 static int CacheLoadConfig ( module_t *, FILE * );
60 * (only used to avoid breakage in dev version when cache structure changes) */
61 #define CACHE_SUBVERSION_NUM 8
63 /* Format string for the cache filename */
64 #define CACHENAME_FORMAT \
65 "plugins-%.2zx%.2zx%.2"PRIx8"-%x.dat"
66 /* Magic for the cache filename */
67 #define CACHENAME_VALUES \
68 sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
71 /*****************************************************************************
72 * LoadPluginsCache: loads the plugins cache file
73 *****************************************************************************
74 * This function will load the plugin cache if present and valid. This cache
75 * will in turn be queried by AllocateAllPlugins() to see if it needs to
76 * actually load the dynamically loadable module.
77 * This allows us to only fully load plugins when they are actually used.
78 *****************************************************************************/
79 void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
81 char *psz_filename, *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
83 int i, j, i_size, i_read;
84 char p_cachestring[sizeof("cache " COPYRIGHT_MESSAGE)];
86 module_cache_t **pp_cache = 0;
87 int32_t i_file_size, i_marker;
89 if( !psz_cachedir ) /* XXX: this should never happen */
91 msg_Err( p_this, "Unable to get cache directory" );
95 if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
96 psz_cachedir, CACHENAME_VALUES ) == -1 )
101 free( psz_cachedir );
105 #if !defined( UNDER_CE )
106 unlink( psz_filename );
108 wchar_t psz_wf[MAX_PATH];
109 MultiByteToWideChar( CP_ACP, 0, psz_filename, -1, psz_wf, MAX_PATH );
110 DeleteFile( psz_wf );
112 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
113 free( psz_filename );
117 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
119 file = utf8_fopen( psz_filename, "rb" );
122 msg_Warn( p_this, "could not open plugins cache file %s for reading",
124 free( psz_filename );
127 free( psz_filename );
129 /* Check the file size */
130 i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
131 if( i_read != sizeof(i_file_size) )
133 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
139 fseek( file, 0, SEEK_END );
140 if( ftell( file ) != i_file_size )
142 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
143 "(corrupted size)" );
147 fseek( file, sizeof(i_file_size), SEEK_SET );
149 /* Check the file is a plugins cache */
150 i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
151 i_read = fread( p_cachestring, 1, i_size, file );
152 if( i_read != i_size ||
153 memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
155 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
160 #ifdef DISTRO_VERSION
161 /* Check for distribution specific version */
162 char p_distrostring[sizeof( DISTRO_VERSION )];
163 i_size = sizeof( DISTRO_VERSION ) - 1;
164 i_read = fread( p_distrostring, 1, i_size, file );
165 if( i_read != i_size ||
166 memcmp( p_distrostring, DISTRO_VERSION, i_size ) )
168 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
174 /* Check Sub-version number */
175 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
176 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
178 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
179 "(corrupted header)" );
184 /* Check header marker */
185 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
186 if( i_read != sizeof(i_marker) ||
187 i_marker != ftell( file ) - (int)sizeof(i_marker) )
189 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
190 "(corrupted header)" );
195 p_bank->i_loaded_cache = 0;
196 if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
198 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
199 "(file too short)" );
205 pp_cache = p_bank->pp_loaded_cache =
206 xmalloc( i_cache * sizeof(void *) );
208 #define LOAD_IMMEDIATE(a) \
209 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
210 #define LOAD_STRING(a) \
213 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
214 || ( i_size > 16384 ) ) \
217 char *psz = xmalloc( i_size ); \
218 if( fread( psz, i_size, 1, file ) != 1 ) { \
222 if( psz[i_size-1] ) { \
230 for( i = 0; i < i_cache; i++ )
235 pp_cache[i] = xmalloc( sizeof(module_cache_t) );
236 p_bank->i_loaded_cache++;
238 /* Load common info */
239 LOAD_STRING( pp_cache[i]->psz_file );
240 LOAD_IMMEDIATE( pp_cache[i]->i_time );
241 LOAD_IMMEDIATE( pp_cache[i]->i_size );
242 LOAD_IMMEDIATE( pp_cache[i]->b_junk );
243 pp_cache[i]->b_used = false;
245 if( pp_cache[i]->b_junk ) continue;
247 pp_cache[i]->p_module = vlc_module_create( p_this );
249 /* Load additional infos */
250 free( pp_cache[i]->p_module->psz_object_name );
251 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
252 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
253 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
254 LOAD_STRING( pp_cache[i]->p_module->psz_help );
255 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
257 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
259 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
260 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
261 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
262 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
265 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
268 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
270 LOAD_IMMEDIATE( i_submodules );
272 while( i_submodules-- )
274 module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
275 free( p_module->psz_object_name );
276 LOAD_STRING( p_module->psz_object_name );
277 LOAD_STRING( p_module->psz_shortname );
278 LOAD_STRING( p_module->psz_longname );
279 LOAD_STRING( p_module->psz_help );
280 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
282 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
284 LOAD_STRING( p_module->psz_capability );
285 LOAD_IMMEDIATE( p_module->i_score );
286 LOAD_IMMEDIATE( p_module->b_unloadable );
295 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
298 p_bank->i_loaded_cache = 0;
305 /* This function should never be called.
306 * It is only used as a non-NULL vlc_callback_t value for comparison. */
307 static int dummy_callback (vlc_object_t *obj, const char *name,
308 vlc_value_t oldval, vlc_value_t newval, void *data)
310 (void) obj; (void)name; (void)oldval; (void)newval; (void)data;
315 static int CacheLoadConfig( module_t *p_module, FILE *file )
320 /* Calculate the structure length */
321 LOAD_IMMEDIATE( p_module->i_config_items );
322 LOAD_IMMEDIATE( p_module->i_bool_items );
324 LOAD_IMMEDIATE( i_lines );
326 /* Allocate memory */
330 (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
331 if( p_module->p_config == NULL )
333 p_module->confsize = 0;
337 p_module->confsize = i_lines;
339 /* Do the duplication job */
340 for (size_t i = 0; i < i_lines; i++ )
342 LOAD_IMMEDIATE( p_module->p_config[i] );
344 LOAD_STRING( p_module->p_config[i].psz_type );
345 LOAD_STRING( p_module->p_config[i].psz_name );
346 LOAD_STRING( p_module->p_config[i].psz_text );
347 LOAD_STRING( p_module->p_config[i].psz_longtext );
348 LOAD_STRING( p_module->p_config[i].psz_oldname );
349 LOAD_IMMEDIATE( p_module->p_config[i].b_removed );
351 if (IsConfigStringType (p_module->p_config[i].i_type))
353 LOAD_STRING (p_module->p_config[i].orig.psz);
354 p_module->p_config[i].value.psz =
355 (p_module->p_config[i].orig.psz != NULL)
356 ? strdup (p_module->p_config[i].orig.psz) : NULL;
357 p_module->p_config[i].saved.psz = NULL;
361 memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
362 sizeof (p_module->p_config[i].value));
363 memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
364 sizeof (p_module->p_config[i].saved));
367 p_module->p_config[i].b_dirty = false;
369 if( p_module->p_config[i].i_list )
371 if( p_module->p_config[i].ppsz_list )
374 p_module->p_config[i].ppsz_list =
375 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
376 if( p_module->p_config[i].ppsz_list )
378 for( j = 0; j < p_module->p_config[i].i_list; j++ )
379 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
380 p_module->p_config[i].ppsz_list[j] = NULL;
383 if( p_module->p_config[i].ppsz_list_text )
386 p_module->p_config[i].ppsz_list_text =
387 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
388 if( p_module->p_config[i].ppsz_list_text )
390 for( j = 0; j < p_module->p_config[i].i_list; j++ )
391 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
392 p_module->p_config[i].ppsz_list_text[j] = NULL;
395 if( p_module->p_config[i].pi_list )
397 p_module->p_config[i].pi_list =
398 xmalloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
399 if( p_module->p_config[i].pi_list )
401 for (int j = 0; j < p_module->p_config[i].i_list; j++)
402 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
407 if( p_module->p_config[i].i_action )
409 p_module->p_config[i].ppf_action =
410 xmalloc( p_module->p_config[i].i_action * sizeof(void *) );
411 p_module->p_config[i].ppsz_action_text =
412 xmalloc( p_module->p_config[i].i_action * sizeof(char *) );
414 for (int j = 0; j < p_module->p_config[i].i_action; j++)
416 p_module->p_config[i].ppf_action[j] = NULL;
417 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
422 LOAD_IMMEDIATE( has_callback );
424 p_module->p_config[i].pf_callback = dummy_callback;
434 static int CacheSaveBank( FILE *file, module_bank_t *p_bank );
436 /*****************************************************************************
437 * SavePluginsCache: saves the plugins cache to a file
438 *****************************************************************************/
439 void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
441 char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
442 if( !psz_cachedir ) /* XXX: this should never happen */
444 msg_Err( p_this, "unable to get cache directory" );
448 char psz_filename[sizeof(DIR_SEP) + 32 + strlen(psz_cachedir)];
449 config_CreateDir( p_this, psz_cachedir );
451 snprintf( psz_filename, sizeof( psz_filename ),
452 "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
454 free( psz_cachedir );
456 char psz_tmpname[sizeof (psz_filename) + 12];
457 snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
458 (uint32_t)getpid ());
459 FILE *file = utf8_fopen( psz_tmpname, "wb" );
463 msg_Dbg (p_this, "writing plugins cache %s", psz_filename);
464 if (CacheSaveBank (file, p_bank))
468 utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
471 utf8_unlink (psz_filename);
473 utf8_rename (psz_tmpname, psz_filename);
475 return; /* success! */
478 msg_Warn (p_this, "could not write plugins cache %s (%m)",
487 static int CacheSaveConfig (FILE *, module_t *);
488 static int CacheSaveSubmodule (FILE *, module_t *);
490 static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
492 uint32_t i_file_size = 0;
494 /* Empty space for file size */
495 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
498 /* Contains version number */
499 if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
501 #ifdef DISTRO_VERSION
502 /* Allow binary maintaner to pass a string to detect new binary version*/
503 if (fputs( DISTRO_VERSION, file ) == EOF)
506 /* Sub-version number (to avoid breakage in the dev version when cache
507 * structure changes) */
508 i_file_size = CACHE_SUBVERSION_NUM;
509 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1 )
513 i_file_size = ftell( file );
514 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
517 module_cache_t **pp_cache = p_bank->pp_cache;
518 uint32_t i_cache = p_bank->i_cache;
520 if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
523 #define SAVE_IMMEDIATE( a ) \
524 if (fwrite (&a, sizeof(a), 1, file) != 1) \
526 #define SAVE_STRING( a ) \
528 uint16_t i_size = (a != NULL) ? (strlen (a) + 1) : 0; \
529 if ((fwrite (&i_size, sizeof (i_size), 1, file) != 1) \
530 || (a && (fwrite (a, 1, i_size, file) != i_size))) \
534 for (unsigned i = 0; i < i_cache; i++)
536 uint32_t i_submodule;
538 /* Save common info */
539 SAVE_STRING( pp_cache[i]->psz_file );
540 SAVE_IMMEDIATE( pp_cache[i]->i_time );
541 SAVE_IMMEDIATE( pp_cache[i]->i_size );
542 SAVE_IMMEDIATE( pp_cache[i]->b_junk );
544 if( pp_cache[i]->b_junk ) continue;
546 /* Save additional infos */
547 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
548 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
549 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
550 SAVE_STRING( pp_cache[i]->p_module->psz_help );
551 for (unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++)
553 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
555 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
556 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
557 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
558 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
561 if (CacheSaveConfig (file, pp_cache[i]->p_module))
564 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
566 i_submodule = pp_cache[i]->p_module->submodule_count;
567 SAVE_IMMEDIATE( i_submodule );
568 if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) )
572 /* Fill-up file size */
573 i_file_size = ftell( file );
574 fseek( file, 0, SEEK_SET );
575 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1
576 || fflush (file)) /* flush libc buffers */
578 return 0; /* success! */
584 static int CacheSaveSubmodule( FILE *file, module_t *p_module )
588 if( CacheSaveSubmodule( file, p_module->next ) )
591 SAVE_STRING( p_module->psz_object_name );
592 SAVE_STRING( p_module->psz_shortname );
593 SAVE_STRING( p_module->psz_longname );
594 SAVE_STRING( p_module->psz_help );
595 for( unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++ )
596 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIXME
598 SAVE_STRING( p_module->psz_capability );
599 SAVE_IMMEDIATE( p_module->i_score );
600 SAVE_IMMEDIATE( p_module->b_unloadable );
608 static int CacheSaveConfig (FILE *file, module_t *p_module)
610 uint32_t i_lines = p_module->confsize;
612 SAVE_IMMEDIATE( p_module->i_config_items );
613 SAVE_IMMEDIATE( p_module->i_bool_items );
614 SAVE_IMMEDIATE( i_lines );
616 for (size_t i = 0; i < i_lines ; i++)
618 SAVE_IMMEDIATE( p_module->p_config[i] );
620 SAVE_STRING( p_module->p_config[i].psz_type );
621 SAVE_STRING( p_module->p_config[i].psz_name );
622 SAVE_STRING( p_module->p_config[i].psz_text );
623 SAVE_STRING( p_module->p_config[i].psz_longtext );
624 SAVE_STRING( p_module->p_config[i].psz_oldname );
625 SAVE_IMMEDIATE( p_module->p_config[i].b_removed );
627 if (IsConfigStringType (p_module->p_config[i].i_type))
628 SAVE_STRING( p_module->p_config[i].orig.psz );
630 if( p_module->p_config[i].i_list )
632 if( p_module->p_config[i].ppsz_list )
634 for (int j = 0; j < p_module->p_config[i].i_list; j++)
635 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
638 if( p_module->p_config[i].ppsz_list_text )
640 for (int j = 0; j < p_module->p_config[i].i_list; j++)
641 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
643 if( p_module->p_config[i].pi_list )
645 for (int j = 0; j < p_module->p_config[i].i_list; j++)
646 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
650 for (int j = 0; j < p_module->p_config[i].i_action; j++)
651 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
653 bool has_callback = p_module->p_config[i].pf_callback != NULL;
654 SAVE_IMMEDIATE( has_callback );
662 /*****************************************************************************
663 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
664 *****************************************************************************/
665 void CacheMerge( vlc_object_t *p_this, module_t *p_cache, module_t *p_module )
669 p_cache->pf_activate = p_module->pf_activate;
670 p_cache->pf_deactivate = p_module->pf_deactivate;
671 p_cache->handle = p_module->handle;
673 /* FIXME: This looks too simplistic an algorithm to me. What if the module
674 * file was altered such that the number of order of submodules was
675 * altered... after VLC started -- Courmisch, 09/2008 */
676 module_t *p_child = p_module->submodule,
677 *p_cchild = p_cache->submodule;
678 while( p_child && p_cchild )
680 p_cchild->pf_activate = p_child->pf_activate;
681 p_cchild->pf_deactivate = p_child->pf_deactivate;
682 p_child = p_child->next;
683 p_cchild = p_cchild->next;
686 p_cache->b_loaded = true;
687 p_module->b_loaded = false;
690 /*****************************************************************************
691 * CacheFind: finds the cache entry corresponding to a file
692 *****************************************************************************/
693 module_cache_t *CacheFind( module_bank_t *p_bank, const char *psz_file,
694 int64_t i_time, int64_t i_size )
696 module_cache_t **pp_cache;
699 pp_cache = p_bank->pp_loaded_cache;
700 i_cache = p_bank->i_loaded_cache;
702 for( i = 0; i < i_cache; i++ )
704 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
705 pp_cache[i]->i_time == i_time &&
706 pp_cache[i]->i_size == i_size ) return pp_cache[i];
712 #endif /* HAVE_DYNAMIC_PLUGINS */