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>
41 #include <sys/types.h>
47 #include "config/configuration.h"
51 #include "modules/modules.h"
54 /*****************************************************************************
56 *****************************************************************************/
57 #ifdef HAVE_DYNAMIC_PLUGINS
58 static int CacheLoadConfig ( module_t
*, FILE * );
61 * (only used to avoid breakage in dev version when cache structure changes) */
62 #define CACHE_SUBVERSION_NUM 11
64 /* Format string for the cache filename */
65 #define CACHENAME_FORMAT \
66 "plugins-%.2zx%.2zx%.2"PRIx8"-%x.dat"
67 /* Magic for the cache filename */
68 #define CACHENAME_VALUES \
69 sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
70 #define CACHE_STRING "cache "PACKAGE_NAME" "PACKAGE_VERSION
73 void CacheDelete( vlc_object_t
*obj
, const char *dir
)
77 assert( dir
!= NULL
);
79 if( asprintf( &path
, "%s"DIR_SEP CACHENAME_FORMAT
,
80 dir
, CACHENAME_VALUES
) == -1 )
82 msg_Dbg( obj
, "removing plugins cache file %s", path
);
87 /*****************************************************************************
88 * LoadPluginsCache: loads the plugins cache file
89 *****************************************************************************
90 * This function will load the plugin cache if present and valid. This cache
91 * will in turn be queried by AllocateAllPlugins() to see if it needs to
92 * actually load the dynamically loadable module.
93 * This allows us to only fully load plugins when they are actually used.
94 *****************************************************************************/
95 void CacheLoad( vlc_object_t
*p_this
, module_bank_t
*p_bank
, const char *dir
)
99 int j
, i_size
, i_read
;
100 char p_cachestring
[sizeof(CACHE_STRING
)];
102 module_cache_t
**pp_cache
= NULL
;
103 int32_t i_file_size
, i_marker
;
105 assert( dir
!= NULL
);
107 if( !p_bank
->b_cache
)
110 if( asprintf( &psz_filename
, "%s"DIR_SEP CACHENAME_FORMAT
,
111 dir
, CACHENAME_VALUES
) == -1 )
114 msg_Dbg( p_this
, "loading plugins cache file %s", psz_filename
);
116 file
= vlc_fopen( psz_filename
, "rb" );
119 msg_Warn( p_this
, "cannot read %s (%m)",
121 free( psz_filename
);
124 free( psz_filename
);
126 /* Check the file size */
127 i_read
= fread( &i_file_size
, 1, sizeof(i_file_size
), file
);
128 if( i_read
!= sizeof(i_file_size
) )
130 msg_Warn( p_this
, "This doesn't look like a valid plugins cache "
136 fseek( file
, 0, SEEK_END
);
137 if( ftell( file
) != i_file_size
)
139 msg_Warn( p_this
, "This doesn't look like a valid plugins cache "
140 "(corrupted size)" );
144 fseek( file
, sizeof(i_file_size
), SEEK_SET
);
146 /* Check the file is a plugins cache */
147 i_size
= sizeof(CACHE_STRING
) - 1;
148 i_read
= fread( p_cachestring
, 1, i_size
, file
);
149 if( i_read
!= i_size
||
150 memcmp( p_cachestring
, CACHE_STRING
, i_size
) )
152 msg_Warn( p_this
, "This doesn't look like a valid plugins cache" );
157 #ifdef DISTRO_VERSION
158 /* Check for distribution specific version */
159 char p_distrostring
[sizeof( DISTRO_VERSION
)];
160 i_size
= sizeof( DISTRO_VERSION
) - 1;
161 i_read
= fread( p_distrostring
, 1, i_size
, file
);
162 if( i_read
!= i_size
||
163 memcmp( p_distrostring
, DISTRO_VERSION
, i_size
) )
165 msg_Warn( p_this
, "This doesn't look like a valid plugins cache" );
171 /* Check Sub-version number */
172 i_read
= fread( &i_marker
, 1, sizeof(i_marker
), file
);
173 if( i_read
!= sizeof(i_marker
) || i_marker
!= CACHE_SUBVERSION_NUM
)
175 msg_Warn( p_this
, "This doesn't look like a valid plugins cache "
176 "(corrupted header)" );
181 /* Check header marker */
182 i_read
= fread( &i_marker
, 1, sizeof(i_marker
), file
);
183 if( i_read
!= sizeof(i_marker
) ||
184 i_marker
!= ftell( file
) - (int)sizeof(i_marker
) )
186 msg_Warn( p_this
, "This doesn't look like a valid plugins cache "
187 "(corrupted header)" );
192 if (fread( &i_cache
, 1, sizeof(i_cache
), file
) != sizeof(i_cache
) )
194 msg_Warn( p_this
, "This doesn't look like a valid plugins cache "
195 "(file too short)" );
202 size_t i_already
= p_bank
->i_loaded_cache
;
203 pp_cache
= realloc( p_bank
->pp_loaded_cache
,
204 (i_already
+ i_cache
) * sizeof(*pp_cache
) );
205 if( unlikely(pp_cache
== NULL
) )
206 i_cache
= 0; /* don't load */
209 p_bank
->pp_loaded_cache
= pp_cache
;
210 pp_cache
+= i_already
;
214 #define LOAD_IMMEDIATE(a) \
215 if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
216 #define LOAD_STRING(a) \
219 if( ( fread( &i_size, sizeof(i_size), 1, file ) != 1 ) \
220 || ( i_size > 16384 ) ) \
223 char *psz = xmalloc( i_size ); \
224 if( fread( psz, i_size, 1, file ) != 1 ) { \
228 if( psz[i_size-1] ) { \
236 for( size_t i
= 0; i
< i_cache
; i
++ )
241 pp_cache
[i
] = xmalloc( sizeof(module_cache_t
) );
243 /* Load common info */
244 LOAD_STRING( pp_cache
[i
]->psz_file
);
245 LOAD_IMMEDIATE( pp_cache
[i
]->i_time
);
246 LOAD_IMMEDIATE( pp_cache
[i
]->i_size
);
248 pp_cache
[i
]->p_module
= vlc_module_create( p_this
);
250 /* Load additional infos */
251 free( pp_cache
[i
]->p_module
->psz_object_name
);
252 LOAD_STRING( pp_cache
[i
]->p_module
->psz_object_name
);
253 LOAD_STRING( pp_cache
[i
]->p_module
->psz_shortname
);
254 LOAD_STRING( pp_cache
[i
]->p_module
->psz_longname
);
255 LOAD_STRING( pp_cache
[i
]->p_module
->psz_help
);
256 for( j
= 0; j
< MODULE_SHORTCUT_MAX
; j
++ )
258 LOAD_STRING( pp_cache
[i
]->p_module
->pp_shortcuts
[j
] ); // FIX
260 LOAD_STRING( pp_cache
[i
]->p_module
->psz_capability
);
261 LOAD_IMMEDIATE( pp_cache
[i
]->p_module
->i_score
);
262 LOAD_IMMEDIATE( pp_cache
[i
]->p_module
->b_unloadable
);
263 LOAD_IMMEDIATE( pp_cache
[i
]->p_module
->b_submodule
);
266 if( CacheLoadConfig( pp_cache
[i
]->p_module
, file
) != VLC_SUCCESS
)
269 LOAD_STRING( pp_cache
[i
]->p_module
->psz_filename
);
270 LOAD_STRING( pp_cache
[i
]->p_module
->domain
);
271 if( pp_cache
[i
]->p_module
->domain
!= NULL
)
272 vlc_bindtextdomain( pp_cache
[i
]->p_module
->domain
);
274 LOAD_IMMEDIATE( i_submodules
);
276 while( i_submodules
-- )
278 module_t
*p_module
= vlc_submodule_create( pp_cache
[i
]->p_module
);
279 free( p_module
->psz_object_name
);
280 LOAD_STRING( p_module
->psz_object_name
);
281 LOAD_STRING( p_module
->psz_shortname
);
282 LOAD_STRING( p_module
->psz_longname
);
283 LOAD_STRING( p_module
->psz_help
);
284 for( j
= 0; j
< MODULE_SHORTCUT_MAX
; j
++ )
286 LOAD_STRING( p_module
->pp_shortcuts
[j
] ); // FIX
288 LOAD_STRING( p_module
->psz_capability
);
289 LOAD_IMMEDIATE( p_module
->i_score
);
290 LOAD_IMMEDIATE( p_module
->b_unloadable
);
291 LOAD_STRING( p_module
->domain
);
294 p_bank
->i_loaded_cache
+= i_cache
;
301 msg_Warn( p_this
, "plugins cache not loaded (corrupted)" );
309 /* This function should never be called.
310 * It is only used as a non-NULL vlc_callback_t value for comparison. */
311 static int dummy_callback (vlc_object_t
*obj
, const char *name
,
312 vlc_value_t oldval
, vlc_value_t newval
, void *data
)
314 (void) obj
; (void)name
; (void)oldval
; (void)newval
; (void)data
;
319 static int CacheLoadConfig( module_t
*p_module
, FILE *file
)
324 /* Calculate the structure length */
325 LOAD_IMMEDIATE( p_module
->i_config_items
);
326 LOAD_IMMEDIATE( p_module
->i_bool_items
);
328 LOAD_IMMEDIATE( i_lines
);
330 /* Allocate memory */
334 (module_config_t
*)calloc( i_lines
, sizeof(module_config_t
) );
335 if( p_module
->p_config
== NULL
)
337 p_module
->confsize
= 0;
341 p_module
->confsize
= i_lines
;
343 /* Do the duplication job */
344 for (size_t i
= 0; i
< i_lines
; i
++ )
346 LOAD_IMMEDIATE( p_module
->p_config
[i
] );
348 LOAD_STRING( p_module
->p_config
[i
].psz_type
);
349 LOAD_STRING( p_module
->p_config
[i
].psz_name
);
350 LOAD_STRING( p_module
->p_config
[i
].psz_text
);
351 LOAD_STRING( p_module
->p_config
[i
].psz_longtext
);
352 LOAD_STRING( p_module
->p_config
[i
].psz_oldname
);
353 LOAD_IMMEDIATE( p_module
->p_config
[i
].b_removed
);
355 if (IsConfigStringType (p_module
->p_config
[i
].i_type
))
357 LOAD_STRING (p_module
->p_config
[i
].orig
.psz
);
358 p_module
->p_config
[i
].value
.psz
=
359 (p_module
->p_config
[i
].orig
.psz
!= NULL
)
360 ? strdup (p_module
->p_config
[i
].orig
.psz
) : NULL
;
361 p_module
->p_config
[i
].saved
.psz
= NULL
;
365 memcpy (&p_module
->p_config
[i
].value
, &p_module
->p_config
[i
].orig
,
366 sizeof (p_module
->p_config
[i
].value
));
367 memcpy (&p_module
->p_config
[i
].saved
, &p_module
->p_config
[i
].orig
,
368 sizeof (p_module
->p_config
[i
].saved
));
371 p_module
->p_config
[i
].b_dirty
= false;
373 if( p_module
->p_config
[i
].i_list
)
375 if( p_module
->p_config
[i
].ppsz_list
)
378 p_module
->p_config
[i
].ppsz_list
=
379 xmalloc( (p_module
->p_config
[i
].i_list
+1) * sizeof(char *));
380 if( p_module
->p_config
[i
].ppsz_list
)
382 for( j
= 0; j
< p_module
->p_config
[i
].i_list
; j
++ )
383 LOAD_STRING( p_module
->p_config
[i
].ppsz_list
[j
] );
384 p_module
->p_config
[i
].ppsz_list
[j
] = NULL
;
387 if( p_module
->p_config
[i
].ppsz_list_text
)
390 p_module
->p_config
[i
].ppsz_list_text
=
391 xmalloc( (p_module
->p_config
[i
].i_list
+1) * sizeof(char *));
392 if( p_module
->p_config
[i
].ppsz_list_text
)
394 for( j
= 0; j
< p_module
->p_config
[i
].i_list
; j
++ )
395 LOAD_STRING( p_module
->p_config
[i
].ppsz_list_text
[j
] );
396 p_module
->p_config
[i
].ppsz_list_text
[j
] = NULL
;
399 if( p_module
->p_config
[i
].pi_list
)
401 p_module
->p_config
[i
].pi_list
=
402 xmalloc( (p_module
->p_config
[i
].i_list
+ 1) * sizeof(int) );
403 if( p_module
->p_config
[i
].pi_list
)
405 for (int j
= 0; j
< p_module
->p_config
[i
].i_list
; j
++)
406 LOAD_IMMEDIATE( p_module
->p_config
[i
].pi_list
[j
] );
411 if( p_module
->p_config
[i
].i_action
)
413 p_module
->p_config
[i
].ppf_action
=
414 xmalloc( p_module
->p_config
[i
].i_action
* sizeof(void *) );
415 p_module
->p_config
[i
].ppsz_action_text
=
416 xmalloc( p_module
->p_config
[i
].i_action
* sizeof(char *) );
418 for (int j
= 0; j
< p_module
->p_config
[i
].i_action
; j
++)
420 p_module
->p_config
[i
].ppf_action
[j
] = NULL
;
421 LOAD_STRING( p_module
->p_config
[i
].ppsz_action_text
[j
] );
426 LOAD_IMMEDIATE( has_callback
);
428 p_module
->p_config
[i
].pf_callback
= dummy_callback
;
438 static int CacheSaveBank( FILE *file
, module_cache_t
*const *, size_t );
440 /*****************************************************************************
441 * SavePluginsCache: saves the plugins cache to a file
442 *****************************************************************************/
443 void CacheSave (vlc_object_t
*p_this
, const char *dir
,
444 module_cache_t
*const *pp_cache
, size_t n
)
446 char *filename
, *tmpname
;
448 if (asprintf (&filename
, "%s"DIR_SEP CACHENAME_FORMAT
, dir
,
449 CACHENAME_VALUES
) == -1)
452 if (asprintf (&tmpname
, "%s.%"PRIu32
, filename
, (uint32_t)getpid ()) == -1)
457 msg_Dbg (p_this
, "saving plugins cache %s", filename
);
459 FILE *file
= vlc_fopen (tmpname
, "wb");
462 if (errno
!= EACCES
&& errno
!= ENOENT
)
463 msg_Warn (p_this
, "cannot create %s (%m)", tmpname
);
467 if (CacheSaveBank (file
, pp_cache
, n
))
469 msg_Warn (p_this
, "cannot write %s (%m)", tmpname
);
472 vlc_unlink (tmpname
);
477 vlc_rename (tmpname
, filename
); /* atomically replace old cache */
480 vlc_unlink (filename
);
482 vlc_rename (tmpname
, filename
);
489 static int CacheSaveConfig (FILE *, const module_t
*);
490 static int CacheSaveSubmodule (FILE *, const module_t
*);
492 static int CacheSaveBank (FILE *file
, module_cache_t
*const *pp_cache
,
495 uint32_t i_file_size
= 0;
497 /* Empty space for file size */
498 if (fwrite (&i_file_size
, sizeof (i_file_size
), 1, file
) != 1)
501 /* Contains version number */
502 if (fputs (CACHE_STRING
, file
) == EOF
)
504 #ifdef DISTRO_VERSION
505 /* Allow binary maintaner to pass a string to detect new binary version*/
506 if (fputs( DISTRO_VERSION
, file
) == EOF
)
509 /* Sub-version number (to avoid breakage in the dev version when cache
510 * structure changes) */
511 i_file_size
= CACHE_SUBVERSION_NUM
;
512 if (fwrite (&i_file_size
, sizeof (i_file_size
), 1, file
) != 1 )
516 i_file_size
= ftell( file
);
517 if (fwrite (&i_file_size
, sizeof (i_file_size
), 1, file
) != 1)
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
);
543 /* Save additional infos */
544 SAVE_STRING( pp_cache
[i
]->p_module
->psz_object_name
);
545 SAVE_STRING( pp_cache
[i
]->p_module
->psz_shortname
);
546 SAVE_STRING( pp_cache
[i
]->p_module
->psz_longname
);
547 SAVE_STRING( pp_cache
[i
]->p_module
->psz_help
);
548 for (unsigned j
= 0; j
< MODULE_SHORTCUT_MAX
; j
++)
550 SAVE_STRING( pp_cache
[i
]->p_module
->pp_shortcuts
[j
] ); // FIX
552 SAVE_STRING( pp_cache
[i
]->p_module
->psz_capability
);
553 SAVE_IMMEDIATE( pp_cache
[i
]->p_module
->i_score
);
554 SAVE_IMMEDIATE( pp_cache
[i
]->p_module
->b_unloadable
);
555 SAVE_IMMEDIATE( pp_cache
[i
]->p_module
->b_submodule
);
558 if (CacheSaveConfig (file
, pp_cache
[i
]->p_module
))
561 SAVE_STRING( pp_cache
[i
]->p_module
->psz_filename
);
562 SAVE_STRING( pp_cache
[i
]->p_module
->domain
);
564 i_submodule
= pp_cache
[i
]->p_module
->submodule_count
;
565 SAVE_IMMEDIATE( i_submodule
);
566 if( CacheSaveSubmodule( file
, pp_cache
[i
]->p_module
->submodule
) )
570 /* Fill-up file size */
571 i_file_size
= ftell( file
);
572 fseek( file
, 0, SEEK_SET
);
573 if (fwrite (&i_file_size
, sizeof (i_file_size
), 1, file
) != 1
574 || fflush (file
)) /* flush libc buffers */
576 return 0; /* success! */
582 static int CacheSaveSubmodule( FILE *file
, const module_t
*p_module
)
586 if( CacheSaveSubmodule( file
, p_module
->next
) )
589 SAVE_STRING( p_module
->psz_object_name
);
590 SAVE_STRING( p_module
->psz_shortname
);
591 SAVE_STRING( p_module
->psz_longname
);
592 SAVE_STRING( p_module
->psz_help
);
593 for( unsigned j
= 0; j
< MODULE_SHORTCUT_MAX
; j
++ )
594 SAVE_STRING( p_module
->pp_shortcuts
[j
] ); // FIXME
596 SAVE_STRING( p_module
->psz_capability
);
597 SAVE_IMMEDIATE( p_module
->i_score
);
598 SAVE_IMMEDIATE( p_module
->b_unloadable
);
599 SAVE_STRING( p_module
->domain
);
607 static int CacheSaveConfig (FILE *file
, const module_t
*p_module
)
609 uint32_t i_lines
= p_module
->confsize
;
611 SAVE_IMMEDIATE( p_module
->i_config_items
);
612 SAVE_IMMEDIATE( p_module
->i_bool_items
);
613 SAVE_IMMEDIATE( i_lines
);
615 for (size_t i
= 0; i
< i_lines
; i
++)
617 SAVE_IMMEDIATE( p_module
->p_config
[i
] );
619 SAVE_STRING( p_module
->p_config
[i
].psz_type
);
620 SAVE_STRING( p_module
->p_config
[i
].psz_name
);
621 SAVE_STRING( p_module
->p_config
[i
].psz_text
);
622 SAVE_STRING( p_module
->p_config
[i
].psz_longtext
);
623 SAVE_STRING( p_module
->p_config
[i
].psz_oldname
);
624 SAVE_IMMEDIATE( p_module
->p_config
[i
].b_removed
);
626 if (IsConfigStringType (p_module
->p_config
[i
].i_type
))
627 SAVE_STRING( p_module
->p_config
[i
].orig
.psz
);
629 if( p_module
->p_config
[i
].i_list
)
631 if( p_module
->p_config
[i
].ppsz_list
)
633 for (int j
= 0; j
< p_module
->p_config
[i
].i_list
; j
++)
634 SAVE_STRING( p_module
->p_config
[i
].ppsz_list
[j
] );
637 if( p_module
->p_config
[i
].ppsz_list_text
)
639 for (int j
= 0; j
< p_module
->p_config
[i
].i_list
; j
++)
640 SAVE_STRING( p_module
->p_config
[i
].ppsz_list_text
[j
] );
642 if( p_module
->p_config
[i
].pi_list
)
644 for (int j
= 0; j
< p_module
->p_config
[i
].i_list
; j
++)
645 SAVE_IMMEDIATE( p_module
->p_config
[i
].pi_list
[j
] );
649 for (int j
= 0; j
< p_module
->p_config
[i
].i_action
; j
++)
650 SAVE_STRING( p_module
->p_config
[i
].ppsz_action_text
[j
] );
652 bool has_callback
= p_module
->p_config
[i
].pf_callback
!= NULL
;
653 SAVE_IMMEDIATE( has_callback
);
661 /*****************************************************************************
662 * CacheMerge: Merge a cache module descriptor with a full module descriptor.
663 *****************************************************************************/
664 void CacheMerge( vlc_object_t
*p_this
, module_t
*p_cache
, module_t
*p_module
)
668 p_cache
->pf_activate
= p_module
->pf_activate
;
669 p_cache
->pf_deactivate
= p_module
->pf_deactivate
;
670 p_cache
->handle
= p_module
->handle
;
672 /* FIXME: This looks too simplistic an algorithm to me. What if the module
673 * file was altered such that the number of order of submodules was
674 * altered... after VLC started -- Courmisch, 09/2008 */
675 module_t
*p_child
= p_module
->submodule
,
676 *p_cchild
= p_cache
->submodule
;
677 while( p_child
&& p_cchild
)
679 p_cchild
->pf_activate
= p_child
->pf_activate
;
680 p_cchild
->pf_deactivate
= p_child
->pf_deactivate
;
681 p_child
= p_child
->next
;
682 p_cchild
= p_cchild
->next
;
685 p_cache
->b_loaded
= true;
686 p_module
->b_loaded
= false;
689 /*****************************************************************************
690 * CacheFind: finds the cache entry corresponding to a file
691 *****************************************************************************/
692 module_cache_t
*CacheFind( module_bank_t
*p_bank
, const char *psz_file
,
693 int64_t i_time
, int64_t i_size
)
695 module_cache_t
**pp_cache
;
698 pp_cache
= p_bank
->pp_loaded_cache
;
699 i_cache
= p_bank
->i_loaded_cache
;
701 for( i
= 0; i
< i_cache
; i
++ )
703 if( !strcmp( pp_cache
[i
]->psz_file
, psz_file
) &&
704 pp_cache
[i
]->i_time
== i_time
&&
705 pp_cache
[i
]->i_size
== i_size
) return pp_cache
[i
];
711 #endif /* HAVE_DYNAMIC_PLUGINS */