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 9
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 msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
106 utf8_unlink( psz_filename );
107 free( psz_filename );
111 msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
113 file = utf8_fopen( psz_filename, "rb" );
116 msg_Warn( p_this, "could not open plugins cache file %s for reading",
118 free( psz_filename );
121 free( psz_filename );
123 /* Check the file size */
124 i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
125 if( i_read != sizeof(i_file_size) )
127 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
133 fseek( file, 0, SEEK_END );
134 if( ftell( file ) != i_file_size )
136 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
137 "(corrupted size)" );
141 fseek( file, sizeof(i_file_size), SEEK_SET );
143 /* Check the file is a plugins cache */
144 i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
145 i_read = fread( p_cachestring, 1, i_size, file );
146 if( i_read != i_size ||
147 memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
149 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
154 #ifdef DISTRO_VERSION
155 /* Check for distribution specific version */
156 char p_distrostring[sizeof( DISTRO_VERSION )];
157 i_size = sizeof( DISTRO_VERSION ) - 1;
158 i_read = fread( p_distrostring, 1, i_size, file );
159 if( i_read != i_size ||
160 memcmp( p_distrostring, DISTRO_VERSION, i_size ) )
162 msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
168 /* Check Sub-version number */
169 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
170 if( i_read != sizeof(i_marker) || i_marker != CACHE_SUBVERSION_NUM )
172 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
173 "(corrupted header)" );
178 /* Check header marker */
179 i_read = fread( &i_marker, 1, sizeof(i_marker), file );
180 if( i_read != sizeof(i_marker) ||
181 i_marker != ftell( file ) - (int)sizeof(i_marker) )
183 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
184 "(corrupted header)" );
189 p_bank->i_loaded_cache = 0;
190 if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
192 msg_Warn( p_this, "This doesn't look like a valid plugins cache "
193 "(file too short)" );
199 pp_cache = p_bank->pp_loaded_cache =
200 xmalloc( i_cache * sizeof(void *) );
202 #define LOAD_IMMEDIATE(a) \
203 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
204 #define LOAD_STRING(a) \
207 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
208 || ( i_size > 16384 ) ) \
211 char *psz = xmalloc( i_size ); \
212 if( fread( psz, i_size, 1, file ) != 1 ) { \
216 if( psz[i_size-1] ) { \
224 for( i = 0; i < i_cache; i++ )
229 pp_cache[i] = xmalloc( sizeof(module_cache_t) );
230 p_bank->i_loaded_cache++;
232 /* Load common info */
233 LOAD_STRING( pp_cache[i]->psz_file );
234 LOAD_IMMEDIATE( pp_cache[i]->i_time );
235 LOAD_IMMEDIATE( pp_cache[i]->i_size );
237 pp_cache[i]->p_module = vlc_module_create( p_this );
239 /* Load additional infos */
240 free( pp_cache[i]->p_module->psz_object_name );
241 LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
242 LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
243 LOAD_STRING( pp_cache[i]->p_module->psz_longname );
244 LOAD_STRING( pp_cache[i]->p_module->psz_help );
245 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
247 LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
249 LOAD_STRING( pp_cache[i]->p_module->psz_capability );
250 LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
251 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
252 LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
255 if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
258 LOAD_STRING( pp_cache[i]->p_module->psz_filename );
260 LOAD_IMMEDIATE( i_submodules );
262 while( i_submodules-- )
264 module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
265 free( p_module->psz_object_name );
266 LOAD_STRING( p_module->psz_object_name );
267 LOAD_STRING( p_module->psz_shortname );
268 LOAD_STRING( p_module->psz_longname );
269 LOAD_STRING( p_module->psz_help );
270 for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
272 LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
274 LOAD_STRING( p_module->psz_capability );
275 LOAD_IMMEDIATE( p_module->i_score );
276 LOAD_IMMEDIATE( p_module->b_unloadable );
285 msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
288 p_bank->i_loaded_cache = 0;
295 /* This function should never be called.
296 * It is only used as a non-NULL vlc_callback_t value for comparison. */
297 static int dummy_callback (vlc_object_t *obj, const char *name,
298 vlc_value_t oldval, vlc_value_t newval, void *data)
300 (void) obj; (void)name; (void)oldval; (void)newval; (void)data;
305 static int CacheLoadConfig( module_t *p_module, FILE *file )
310 /* Calculate the structure length */
311 LOAD_IMMEDIATE( p_module->i_config_items );
312 LOAD_IMMEDIATE( p_module->i_bool_items );
314 LOAD_IMMEDIATE( i_lines );
316 /* Allocate memory */
320 (module_config_t *)calloc( i_lines, sizeof(module_config_t) );
321 if( p_module->p_config == NULL )
323 p_module->confsize = 0;
327 p_module->confsize = i_lines;
329 /* Do the duplication job */
330 for (size_t i = 0; i < i_lines; i++ )
332 LOAD_IMMEDIATE( p_module->p_config[i] );
334 LOAD_STRING( p_module->p_config[i].psz_type );
335 LOAD_STRING( p_module->p_config[i].psz_name );
336 LOAD_STRING( p_module->p_config[i].psz_text );
337 LOAD_STRING( p_module->p_config[i].psz_longtext );
338 LOAD_STRING( p_module->p_config[i].psz_oldname );
339 LOAD_IMMEDIATE( p_module->p_config[i].b_removed );
341 if (IsConfigStringType (p_module->p_config[i].i_type))
343 LOAD_STRING (p_module->p_config[i].orig.psz);
344 p_module->p_config[i].value.psz =
345 (p_module->p_config[i].orig.psz != NULL)
346 ? strdup (p_module->p_config[i].orig.psz) : NULL;
347 p_module->p_config[i].saved.psz = NULL;
351 memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
352 sizeof (p_module->p_config[i].value));
353 memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
354 sizeof (p_module->p_config[i].saved));
357 p_module->p_config[i].b_dirty = false;
359 if( p_module->p_config[i].i_list )
361 if( p_module->p_config[i].ppsz_list )
364 p_module->p_config[i].ppsz_list =
365 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
366 if( p_module->p_config[i].ppsz_list )
368 for( j = 0; j < p_module->p_config[i].i_list; j++ )
369 LOAD_STRING( p_module->p_config[i].ppsz_list[j] );
370 p_module->p_config[i].ppsz_list[j] = NULL;
373 if( p_module->p_config[i].ppsz_list_text )
376 p_module->p_config[i].ppsz_list_text =
377 xmalloc( (p_module->p_config[i].i_list+1) * sizeof(char *));
378 if( p_module->p_config[i].ppsz_list_text )
380 for( j = 0; j < p_module->p_config[i].i_list; j++ )
381 LOAD_STRING( p_module->p_config[i].ppsz_list_text[j] );
382 p_module->p_config[i].ppsz_list_text[j] = NULL;
385 if( p_module->p_config[i].pi_list )
387 p_module->p_config[i].pi_list =
388 xmalloc( (p_module->p_config[i].i_list + 1) * sizeof(int) );
389 if( p_module->p_config[i].pi_list )
391 for (int j = 0; j < p_module->p_config[i].i_list; j++)
392 LOAD_IMMEDIATE( p_module->p_config[i].pi_list[j] );
397 if( p_module->p_config[i].i_action )
399 p_module->p_config[i].ppf_action =
400 xmalloc( p_module->p_config[i].i_action * sizeof(void *) );
401 p_module->p_config[i].ppsz_action_text =
402 xmalloc( p_module->p_config[i].i_action * sizeof(char *) );
404 for (int j = 0; j < p_module->p_config[i].i_action; j++)
406 p_module->p_config[i].ppf_action[j] = NULL;
407 LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
412 LOAD_IMMEDIATE( has_callback );
414 p_module->p_config[i].pf_callback = dummy_callback;
424 static int CacheSaveBank( FILE *file, module_bank_t *p_bank );
426 /*****************************************************************************
427 * SavePluginsCache: saves the plugins cache to a file
428 *****************************************************************************/
429 void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
431 char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
432 if( !psz_cachedir ) /* XXX: this should never happen */
434 msg_Err( p_this, "unable to get cache directory" );
438 char psz_filename[sizeof(DIR_SEP) + 32 + strlen(psz_cachedir)];
439 config_CreateDir( p_this, psz_cachedir );
441 snprintf( psz_filename, sizeof( psz_filename ),
442 "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
444 free( psz_cachedir );
446 char psz_tmpname[sizeof (psz_filename) + 12];
447 snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
448 (uint32_t)getpid ());
449 FILE *file = utf8_fopen( psz_tmpname, "wb" );
453 msg_Dbg (p_this, "saving plugins cache %s", psz_filename);
454 if (CacheSaveBank (file, p_bank))
458 utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
461 utf8_unlink (psz_filename);
463 utf8_rename (psz_tmpname, psz_filename);
465 return; /* success! */
468 msg_Warn (p_this, "could not write plugins cache %s (%m)",
477 static int CacheSaveConfig (FILE *, module_t *);
478 static int CacheSaveSubmodule (FILE *, module_t *);
480 static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
482 uint32_t i_file_size = 0;
484 /* Empty space for file size */
485 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
488 /* Contains version number */
489 if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
491 #ifdef DISTRO_VERSION
492 /* Allow binary maintaner to pass a string to detect new binary version*/
493 if (fputs( DISTRO_VERSION, file ) == EOF)
496 /* Sub-version number (to avoid breakage in the dev version when cache
497 * structure changes) */
498 i_file_size = CACHE_SUBVERSION_NUM;
499 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1 )
503 i_file_size = ftell( file );
504 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
507 module_cache_t **pp_cache = p_bank->pp_cache;
508 uint32_t i_cache = p_bank->i_cache;
510 if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
513 #define SAVE_IMMEDIATE( a ) \
514 if (fwrite (&a, sizeof(a), 1, file) != 1) \
516 #define SAVE_STRING( a ) \
518 uint16_t i_size = (a != NULL) ? (strlen (a) + 1) : 0; \
519 if ((fwrite (&i_size, sizeof (i_size), 1, file) != 1) \
520 || (a && (fwrite (a, 1, i_size, file) != i_size))) \
524 for (unsigned i = 0; i < i_cache; i++)
526 uint32_t i_submodule;
528 /* Save common info */
529 SAVE_STRING( pp_cache[i]->psz_file );
530 SAVE_IMMEDIATE( pp_cache[i]->i_time );
531 SAVE_IMMEDIATE( pp_cache[i]->i_size );
533 /* Save additional infos */
534 SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
535 SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
536 SAVE_STRING( pp_cache[i]->p_module->psz_longname );
537 SAVE_STRING( pp_cache[i]->p_module->psz_help );
538 for (unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++)
540 SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
542 SAVE_STRING( pp_cache[i]->p_module->psz_capability );
543 SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
544 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
545 SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
548 if (CacheSaveConfig (file, pp_cache[i]->p_module))
551 SAVE_STRING( pp_cache[i]->p_module->psz_filename );
553 i_submodule = pp_cache[i]->p_module->submodule_count;
554 SAVE_IMMEDIATE( i_submodule );
555 if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) )
559 /* Fill-up file size */
560 i_file_size = ftell( file );
561 fseek( file, 0, SEEK_SET );
562 if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1
563 || fflush (file)) /* flush libc buffers */
565 return 0; /* success! */
571 static int CacheSaveSubmodule( FILE *file, module_t *p_module )
575 if( CacheSaveSubmodule( file, p_module->next ) )
578 SAVE_STRING( p_module->psz_object_name );
579 SAVE_STRING( p_module->psz_shortname );
580 SAVE_STRING( p_module->psz_longname );
581 SAVE_STRING( p_module->psz_help );
582 for( unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++ )
583 SAVE_STRING( p_module->pp_shortcuts[j] ); // FIXME
585 SAVE_STRING( p_module->psz_capability );
586 SAVE_IMMEDIATE( p_module->i_score );
587 SAVE_IMMEDIATE( p_module->b_unloadable );
595 static int CacheSaveConfig (FILE *file, module_t *p_module)
597 uint32_t i_lines = p_module->confsize;
599 SAVE_IMMEDIATE( p_module->i_config_items );
600 SAVE_IMMEDIATE( p_module->i_bool_items );
601 SAVE_IMMEDIATE( i_lines );
603 for (size_t i = 0; i < i_lines ; i++)
605 SAVE_IMMEDIATE( p_module->p_config[i] );
607 SAVE_STRING( p_module->p_config[i].psz_type );
608 SAVE_STRING( p_module->p_config[i].psz_name );
609 SAVE_STRING( p_module->p_config[i].psz_text );
610 SAVE_STRING( p_module->p_config[i].psz_longtext );
611 SAVE_STRING( p_module->p_config[i].psz_oldname );
612 SAVE_IMMEDIATE( p_module->p_config[i].b_removed );
614 if (IsConfigStringType (p_module->p_config[i].i_type))
615 SAVE_STRING( p_module->p_config[i].orig.psz );
617 if( p_module->p_config[i].i_list )
619 if( p_module->p_config[i].ppsz_list )
621 for (int j = 0; j < p_module->p_config[i].i_list; j++)
622 SAVE_STRING( p_module->p_config[i].ppsz_list[j] );
625 if( p_module->p_config[i].ppsz_list_text )
627 for (int j = 0; j < p_module->p_config[i].i_list; j++)
628 SAVE_STRING( p_module->p_config[i].ppsz_list_text[j] );
630 if( p_module->p_config[i].pi_list )
632 for (int j = 0; j < p_module->p_config[i].i_list; j++)
633 SAVE_IMMEDIATE( p_module->p_config[i].pi_list[j] );
637 for (int j = 0; j < p_module->p_config[i].i_action; j++)
638 SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
640 bool has_callback = p_module->p_config[i].pf_callback != NULL;
641 SAVE_IMMEDIATE( has_callback );
649 /*****************************************************************************
650 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
651 *****************************************************************************/
652 void CacheMerge( vlc_object_t *p_this, module_t *p_cache, module_t *p_module )
656 p_cache->pf_activate = p_module->pf_activate;
657 p_cache->pf_deactivate = p_module->pf_deactivate;
658 p_cache->handle = p_module->handle;
660 /* FIXME: This looks too simplistic an algorithm to me. What if the module
661 * file was altered such that the number of order of submodules was
662 * altered... after VLC started -- Courmisch, 09/2008 */
663 module_t *p_child = p_module->submodule,
664 *p_cchild = p_cache->submodule;
665 while( p_child && p_cchild )
667 p_cchild->pf_activate = p_child->pf_activate;
668 p_cchild->pf_deactivate = p_child->pf_deactivate;
669 p_child = p_child->next;
670 p_cchild = p_cchild->next;
673 p_cache->b_loaded = true;
674 p_module->b_loaded = false;
677 /*****************************************************************************
678 * CacheFind: finds the cache entry corresponding to a file
679 *****************************************************************************/
680 module_cache_t *CacheFind( module_bank_t *p_bank, const char *psz_file,
681 int64_t i_time, int64_t i_size )
683 module_cache_t **pp_cache;
686 pp_cache = p_bank->pp_loaded_cache;
687 i_cache = p_bank->i_loaded_cache;
689 for( i = 0; i < i_cache; i++ )
691 if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
692 pp_cache[i]->i_time == i_time &&
693 pp_cache[i]->i_size == i_size ) return pp_cache[i];
699 #endif /* HAVE_DYNAMIC_PLUGINS */