#include <stdio.h> /* sprintf() */
#include <string.h> /* strdup() */
#include <vlc_plugin.h>
-#include <vlc_cpu.h>
+#include <errno.h>
#include <sys/types.h>
+#include <sys/stat.h>
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif
#include "config/configuration.h"
-#include "vlc_charset.h"
+#include <vlc_fs.h>
#include "modules/modules.h"
/* Sub-version number
* (only used to avoid breakage in dev version when cache structure changes) */
-#define CACHE_SUBVERSION_NUM 9
+#define CACHE_SUBVERSION_NUM 18
-/* Format string for the cache filename */
-#define CACHENAME_FORMAT \
- "plugins-%.2zx%.2zx%.2"PRIx8"-%x.dat"
+/* Cache filename */
+#define CACHE_NAME "plugins.dat"
/* Magic for the cache filename */
-#define CACHENAME_VALUES \
- sizeof(int), sizeof(void *), *(uint8_t *)&(uint16_t){ 0xbe1e }, vlc_CPU()
+#define CACHE_STRING "cache "PACKAGE_NAME" "PACKAGE_VERSION
-/*****************************************************************************
- * LoadPluginsCache: loads the plugins cache file
- *****************************************************************************
+void CacheDelete( vlc_object_t *obj, const char *dir )
+{
+ char *path;
+
+ assert( dir != NULL );
+
+ if( asprintf( &path, "%s"DIR_SEP CACHE_NAME, dir ) == -1 )
+ return;
+ msg_Dbg( obj, "removing plugins cache file %s", path );
+ vlc_unlink( path );
+ free( path );
+}
+
+/**
+ * Loads a plugins cache file.
+ *
* This function will load the plugin cache if present and valid. This cache
* will in turn be queried by AllocateAllPlugins() to see if it needs to
* actually load the dynamically loadable module.
* This allows us to only fully load plugins when they are actually used.
- *****************************************************************************/
-void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, bool b_delete )
+ */
+size_t CacheLoad( vlc_object_t *p_this, const char *dir, module_cache_t **r )
{
- char *psz_filename, *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
+ char *psz_filename;
FILE *file;
- int i, j, i_size, i_read;
- char p_cachestring[sizeof("cache " COPYRIGHT_MESSAGE)];
- int i_cache;
- module_cache_t **pp_cache = 0;
- int32_t i_file_size, i_marker;
-
- if( !psz_cachedir ) /* XXX: this should never happen */
- {
- msg_Err( p_this, "Unable to get cache directory" );
- return;
- }
+ int i_size, i_read;
+ char p_cachestring[sizeof(CACHE_STRING)];
+ size_t i_cache;
+ int32_t i_marker;
- if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT,
- psz_cachedir, CACHENAME_VALUES ) == -1 )
- {
- free( psz_cachedir );
- return;
- }
- free( psz_cachedir );
+ assert( dir != NULL );
- if( b_delete )
- {
- msg_Dbg( p_this, "removing plugins cache file %s", psz_filename );
- utf8_unlink( psz_filename );
- free( psz_filename );
- return;
- }
+ *r = NULL;
+ if( asprintf( &psz_filename, "%s"DIR_SEP CACHE_NAME, dir ) == -1 )
+ return 0;
msg_Dbg( p_this, "loading plugins cache file %s", psz_filename );
- file = utf8_fopen( psz_filename, "rb" );
+ file = vlc_fopen( psz_filename, "rb" );
if( !file )
{
- msg_Warn( p_this, "could not open plugins cache file %s for reading",
+ msg_Warn( p_this, "cannot read %s (%m)",
psz_filename );
free( psz_filename );
- return;
+ return 0;
}
free( psz_filename );
- /* Check the file size */
- i_read = fread( &i_file_size, 1, sizeof(i_file_size), file );
- if( i_read != sizeof(i_file_size) )
- {
- msg_Warn( p_this, "This doesn't look like a valid plugins cache "
- "(too short)" );
- fclose( file );
- return;
- }
-
- fseek( file, 0, SEEK_END );
- if( ftell( file ) != i_file_size )
- {
- msg_Warn( p_this, "This doesn't look like a valid plugins cache "
- "(corrupted size)" );
- fclose( file );
- return;
- }
- fseek( file, sizeof(i_file_size), SEEK_SET );
-
/* Check the file is a plugins cache */
- i_size = sizeof("cache " COPYRIGHT_MESSAGE) - 1;
+ i_size = sizeof(CACHE_STRING) - 1;
i_read = fread( p_cachestring, 1, i_size, file );
if( i_read != i_size ||
- memcmp( p_cachestring, "cache " COPYRIGHT_MESSAGE, i_size ) )
+ memcmp( p_cachestring, CACHE_STRING, i_size ) )
{
msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
fclose( file );
- return;
+ return 0;
}
#ifdef DISTRO_VERSION
{
msg_Warn( p_this, "This doesn't look like a valid plugins cache" );
fclose( file );
- return;
+ return 0;
}
#endif
msg_Warn( p_this, "This doesn't look like a valid plugins cache "
"(corrupted header)" );
fclose( file );
- return;
+ return 0;
}
/* Check header marker */
msg_Warn( p_this, "This doesn't look like a valid plugins cache "
"(corrupted header)" );
fclose( file );
- return;
+ return 0;
}
- p_bank->i_loaded_cache = 0;
if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) )
{
msg_Warn( p_this, "This doesn't look like a valid plugins cache "
"(file too short)" );
fclose( file );
- return;
+ return 0;
}
- if( i_cache )
- pp_cache = p_bank->pp_loaded_cache =
- xmalloc( i_cache * sizeof(void *) );
+ module_cache_t *cache = NULL;
#define LOAD_IMMEDIATE(a) \
if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error
} \
}
- for( i = 0; i < i_cache; i++ )
+ for (size_t count = 0; count < i_cache;)
{
+ module_t *module;
uint16_t i_size;
int i_submodules;
- pp_cache[i] = xmalloc( sizeof(module_cache_t) );
- p_bank->i_loaded_cache++;
-
- /* Load common info */
- LOAD_STRING( pp_cache[i]->psz_file );
- LOAD_IMMEDIATE( pp_cache[i]->i_time );
- LOAD_IMMEDIATE( pp_cache[i]->i_size );
-
- pp_cache[i]->p_module = vlc_module_create( p_this );
+ module = vlc_module_create (NULL);
/* Load additional infos */
- free( pp_cache[i]->p_module->psz_object_name );
- LOAD_STRING( pp_cache[i]->p_module->psz_object_name );
- LOAD_STRING( pp_cache[i]->p_module->psz_shortname );
- LOAD_STRING( pp_cache[i]->p_module->psz_longname );
- LOAD_STRING( pp_cache[i]->p_module->psz_help );
- for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
+ LOAD_STRING(module->psz_shortname);
+ LOAD_STRING(module->psz_longname);
+ LOAD_STRING(module->psz_help);
+
+ LOAD_IMMEDIATE(module->i_shortcuts);
+ if (module->i_shortcuts > MODULE_SHORTCUT_MAX)
+ goto error;
+ else
{
- LOAD_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
+ module->pp_shortcuts =
+ xmalloc (sizeof (char **) * module->i_shortcuts);
+ for (unsigned j = 0; j < module->i_shortcuts; j++)
+ LOAD_STRING(module->pp_shortcuts[j]);
}
- LOAD_STRING( pp_cache[i]->p_module->psz_capability );
- LOAD_IMMEDIATE( pp_cache[i]->p_module->i_score );
- LOAD_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
- LOAD_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
+
+ LOAD_STRING(module->psz_capability);
+ LOAD_IMMEDIATE(module->i_score);
+ LOAD_IMMEDIATE(module->b_unloadable);
/* Config stuff */
- if( CacheLoadConfig( pp_cache[i]->p_module, file ) != VLC_SUCCESS )
+ if (CacheLoadConfig (module, file) != VLC_SUCCESS)
goto error;
- LOAD_STRING( pp_cache[i]->p_module->psz_filename );
+ LOAD_STRING(module->domain);
+ if (module->domain != NULL)
+ vlc_bindtextdomain (module->domain);
LOAD_IMMEDIATE( i_submodules );
while( i_submodules-- )
{
- module_t *p_module = vlc_submodule_create( pp_cache[i]->p_module );
- free( p_module->psz_object_name );
- LOAD_STRING( p_module->psz_object_name );
- LOAD_STRING( p_module->psz_shortname );
- LOAD_STRING( p_module->psz_longname );
- LOAD_STRING( p_module->psz_help );
- for( j = 0; j < MODULE_SHORTCUT_MAX; j++ )
+ module_t *submodule = vlc_module_create (module);
+ free (submodule->pp_shortcuts);
+ LOAD_STRING(submodule->psz_shortname);
+ LOAD_STRING(submodule->psz_longname);
+
+ LOAD_IMMEDIATE(submodule->i_shortcuts);
+ if (submodule->i_shortcuts > MODULE_SHORTCUT_MAX)
+ goto error;
+ else
{
- LOAD_STRING( p_module->pp_shortcuts[j] ); // FIX
+ submodule->pp_shortcuts =
+ xmalloc (sizeof (char **) * submodule->i_shortcuts);
+ for (unsigned j = 0; j < submodule->i_shortcuts; j++)
+ LOAD_STRING(submodule->pp_shortcuts[j]);
}
- LOAD_STRING( p_module->psz_capability );
- LOAD_IMMEDIATE( p_module->i_score );
- LOAD_IMMEDIATE( p_module->b_unloadable );
+
+ LOAD_STRING(submodule->psz_capability);
+ LOAD_IMMEDIATE(submodule->i_score);
}
- }
+ char *path;
+ struct stat st;
+
+ /* Load common info */
+ LOAD_STRING(path);
+ if (path == NULL)
+ goto error;
+ LOAD_IMMEDIATE(st.st_mtime);
+ LOAD_IMMEDIATE(st.st_size);
+
+ CacheAdd (&cache, &count, path, &st, module);
+ free (path);
+ /* TODO: deal with errors */
+ }
fclose( file );
- return;
- error:
+ *r = cache;
+ return i_cache;
+error:
msg_Warn( p_this, "plugins cache not loaded (corrupted)" );
/* TODO: cleanup */
- p_bank->i_loaded_cache = 0;
-
fclose( file );
- return;
-}
-
-
-/* This function should never be called.
- * It is only used as a non-NULL vlc_callback_t value for comparison. */
-static int dummy_callback (vlc_object_t *obj, const char *name,
- vlc_value_t oldval, vlc_value_t newval, void *data)
-{
- (void) obj; (void)name; (void)oldval; (void)newval; (void)data;
- assert (0);
+ return 0;
}
LOAD_STRING( p_module->p_config[i].psz_name );
LOAD_STRING( p_module->p_config[i].psz_text );
LOAD_STRING( p_module->p_config[i].psz_longtext );
- LOAD_STRING( p_module->p_config[i].psz_oldname );
- LOAD_IMMEDIATE( p_module->p_config[i].b_removed );
if (IsConfigStringType (p_module->p_config[i].i_type))
{
p_module->p_config[i].value.psz =
(p_module->p_config[i].orig.psz != NULL)
? strdup (p_module->p_config[i].orig.psz) : NULL;
- p_module->p_config[i].saved.psz = NULL;
}
else
- {
memcpy (&p_module->p_config[i].value, &p_module->p_config[i].orig,
sizeof (p_module->p_config[i].value));
- memcpy (&p_module->p_config[i].saved, &p_module->p_config[i].orig,
- sizeof (p_module->p_config[i].saved));
- }
p_module->p_config[i].b_dirty = false;
LOAD_STRING( p_module->p_config[i].ppsz_action_text[j] );
}
}
-
- bool has_callback;
- LOAD_IMMEDIATE( has_callback );
- if (has_callback)
- p_module->p_config[i].pf_callback = dummy_callback;
}
return VLC_SUCCESS;
return VLC_EGENERIC;
}
-static int CacheSaveBank( FILE *file, module_bank_t *p_bank );
+static int CacheSaveBank( FILE *file, const module_cache_t *, size_t );
-/*****************************************************************************
- * SavePluginsCache: saves the plugins cache to a file
- *****************************************************************************/
-void CacheSave( vlc_object_t *p_this, module_bank_t *p_bank )
+/**
+ * Saves a module cache to disk, and release cache data from memory.
+ */
+void CacheSave (vlc_object_t *p_this, const char *dir,
+ module_cache_t *entries, size_t n)
{
- char *psz_cachedir = config_GetUserDir(VLC_CACHE_DIR);
- if( !psz_cachedir ) /* XXX: this should never happen */
- {
- msg_Err( p_this, "unable to get cache directory" );
- return;
- }
+ char *filename = NULL, *tmpname = NULL;
- char psz_filename[sizeof(DIR_SEP) + 32 + strlen(psz_cachedir)];
- config_CreateDir( p_this, psz_cachedir );
+ if (asprintf (&filename, "%s"DIR_SEP CACHE_NAME, dir ) == -1)
+ goto out;
- snprintf( psz_filename, sizeof( psz_filename ),
- "%s"DIR_SEP CACHENAME_FORMAT, psz_cachedir,
- CACHENAME_VALUES );
- free( psz_cachedir );
+ if (asprintf (&tmpname, "%s.%"PRIu32, filename, (uint32_t)getpid ()) == -1)
+ goto out;
+ msg_Dbg (p_this, "saving plugins cache %s", filename);
- char psz_tmpname[sizeof (psz_filename) + 12];
- snprintf (psz_tmpname, sizeof (psz_tmpname), "%s.%"PRIu32, psz_filename,
- (uint32_t)getpid ());
- FILE *file = utf8_fopen( psz_tmpname, "wb" );
+ FILE *file = vlc_fopen (tmpname, "wb");
if (file == NULL)
- goto error;
+ {
+ if (errno != EACCES && errno != ENOENT)
+ msg_Warn (p_this, "cannot create %s (%m)", tmpname);
+ goto out;
+ }
- msg_Dbg (p_this, "saving plugins cache %s", psz_filename);
- if (CacheSaveBank (file, p_bank))
- goto error;
+ if (CacheSaveBank (file, entries, n))
+ {
+ msg_Warn (p_this, "cannot write %s (%m)", tmpname);
+ clearerr (file);
+ fclose (file);
+ vlc_unlink (tmpname);
+ goto out;
+ }
-#ifndef WIN32
- utf8_rename (psz_tmpname, psz_filename); /* atomically replace old cache */
+#if !defined( WIN32 ) && !defined( __OS2__ )
+ vlc_rename (tmpname, filename); /* atomically replace old cache */
fclose (file);
#else
- utf8_unlink (psz_filename);
+ vlc_unlink (filename);
fclose (file);
- utf8_rename (psz_tmpname, psz_filename);
+ vlc_rename (tmpname, filename);
#endif
- return; /* success! */
+out:
+ free (filename);
+ free (tmpname);
-error:
- msg_Warn (p_this, "could not write plugins cache %s (%m)",
- psz_filename);
- if (file != NULL)
- {
- clearerr (file);
- fclose (file);
- }
+ for (size_t i = 0; i < n; i++)
+ free (entries[i].path);
+ free (entries);
}
-static int CacheSaveConfig (FILE *, module_t *);
-static int CacheSaveSubmodule (FILE *, module_t *);
+static int CacheSaveConfig (FILE *, const module_t *);
+static int CacheSaveSubmodule (FILE *, const module_t *);
-static int CacheSaveBank (FILE *file, module_bank_t *p_bank)
+static int CacheSaveBank (FILE *file, const module_cache_t *cache,
+ size_t i_cache)
{
uint32_t i_file_size = 0;
- /* Empty space for file size */
- if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
- goto error;
-
/* Contains version number */
- if (fputs ("cache "COPYRIGHT_MESSAGE, file) == EOF)
+ if (fputs (CACHE_STRING, file) == EOF)
goto error;
#ifdef DISTRO_VERSION
/* Allow binary maintaner to pass a string to detect new binary version*/
if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1)
goto error;
- module_cache_t **pp_cache = p_bank->pp_cache;
- uint32_t i_cache = p_bank->i_cache;
-
if (fwrite( &i_cache, sizeof (i_cache), 1, file) != 1)
goto error;
for (unsigned i = 0; i < i_cache; i++)
{
+ module_t *module = cache[i].p_module;
uint32_t i_submodule;
- /* Save common info */
- SAVE_STRING( pp_cache[i]->psz_file );
- SAVE_IMMEDIATE( pp_cache[i]->i_time );
- SAVE_IMMEDIATE( pp_cache[i]->i_size );
-
/* Save additional infos */
- SAVE_STRING( pp_cache[i]->p_module->psz_object_name );
- SAVE_STRING( pp_cache[i]->p_module->psz_shortname );
- SAVE_STRING( pp_cache[i]->p_module->psz_longname );
- SAVE_STRING( pp_cache[i]->p_module->psz_help );
- for (unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++)
- {
- SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); // FIX
- }
- SAVE_STRING( pp_cache[i]->p_module->psz_capability );
- SAVE_IMMEDIATE( pp_cache[i]->p_module->i_score );
- SAVE_IMMEDIATE( pp_cache[i]->p_module->b_unloadable );
- SAVE_IMMEDIATE( pp_cache[i]->p_module->b_submodule );
+ SAVE_STRING(module->psz_shortname);
+ SAVE_STRING(module->psz_longname);
+ SAVE_STRING(module->psz_help);
+ SAVE_IMMEDIATE(module->i_shortcuts);
+ for (unsigned j = 0; j < module->i_shortcuts; j++)
+ SAVE_STRING(module->pp_shortcuts[j]);
+
+ SAVE_STRING(module->psz_capability);
+ SAVE_IMMEDIATE(module->i_score);
+ SAVE_IMMEDIATE(module->b_unloadable);
/* Config stuff */
- if (CacheSaveConfig (file, pp_cache[i]->p_module))
+ if (CacheSaveConfig (file, module))
goto error;
- SAVE_STRING( pp_cache[i]->p_module->psz_filename );
+ SAVE_STRING(module->domain);
- i_submodule = pp_cache[i]->p_module->submodule_count;
+ i_submodule = module->submodule_count;
SAVE_IMMEDIATE( i_submodule );
- if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) )
+ if (CacheSaveSubmodule (file, module->submodule))
goto error;
+
+ /* Save common info */
+ SAVE_STRING(cache[i].path);
+ SAVE_IMMEDIATE(cache[i].mtime);
+ SAVE_IMMEDIATE(cache[i].size);
}
- /* Fill-up file size */
- i_file_size = ftell( file );
- fseek( file, 0, SEEK_SET );
- if (fwrite (&i_file_size, sizeof (i_file_size), 1, file) != 1
- || fflush (file)) /* flush libc buffers */
+ if (fflush (file)) /* flush libc buffers */
goto error;
return 0; /* success! */
return -1;
}
-static int CacheSaveSubmodule( FILE *file, module_t *p_module )
+static int CacheSaveSubmodule( FILE *file, const module_t *p_module )
{
if( !p_module )
return 0;
if( CacheSaveSubmodule( file, p_module->next ) )
goto error;
- SAVE_STRING( p_module->psz_object_name );
SAVE_STRING( p_module->psz_shortname );
SAVE_STRING( p_module->psz_longname );
- SAVE_STRING( p_module->psz_help );
- for( unsigned j = 0; j < MODULE_SHORTCUT_MAX; j++ )
- SAVE_STRING( p_module->pp_shortcuts[j] ); // FIXME
+ SAVE_IMMEDIATE( p_module->i_shortcuts );
+ for( unsigned j = 0; j < p_module->i_shortcuts; j++ )
+ SAVE_STRING( p_module->pp_shortcuts[j] );
SAVE_STRING( p_module->psz_capability );
SAVE_IMMEDIATE( p_module->i_score );
- SAVE_IMMEDIATE( p_module->b_unloadable );
return 0;
error:
}
-static int CacheSaveConfig (FILE *file, module_t *p_module)
+static int CacheSaveConfig (FILE *file, const module_t *p_module)
{
uint32_t i_lines = p_module->confsize;
SAVE_STRING( p_module->p_config[i].psz_name );
SAVE_STRING( p_module->p_config[i].psz_text );
SAVE_STRING( p_module->p_config[i].psz_longtext );
- SAVE_STRING( p_module->p_config[i].psz_oldname );
- SAVE_IMMEDIATE( p_module->p_config[i].b_removed );
if (IsConfigStringType (p_module->p_config[i].i_type))
SAVE_STRING( p_module->p_config[i].orig.psz );
for (int j = 0; j < p_module->p_config[i].i_action; j++)
SAVE_STRING( p_module->p_config[i].ppsz_action_text[j] );
-
- bool has_callback = p_module->p_config[i].pf_callback != NULL;
- SAVE_IMMEDIATE( has_callback );
}
return 0;
p_module->b_loaded = false;
}
-/*****************************************************************************
- * CacheFind: finds the cache entry corresponding to a file
- *****************************************************************************/
-module_cache_t *CacheFind( module_bank_t *p_bank, const char *psz_file,
- int64_t i_time, int64_t i_size )
+/**
+ * Looks up a plugin file in a table of cached plugins.
+ */
+module_t *CacheFind (module_cache_t *cache, size_t count,
+ const char *path, const struct stat *st)
{
- module_cache_t **pp_cache;
- int i_cache, i;
-
- pp_cache = p_bank->pp_loaded_cache;
- i_cache = p_bank->i_loaded_cache;
-
- for( i = 0; i < i_cache; i++ )
+ while (count > 0)
{
- if( !strcmp( pp_cache[i]->psz_file, psz_file ) &&
- pp_cache[i]->i_time == i_time &&
- pp_cache[i]->i_size == i_size ) return pp_cache[i];
+ if (cache->path != NULL
+ && !strcmp (cache->path, path)
+ && cache->mtime == st->st_mtime
+ && cache->size == st->st_size)
+ {
+ module_t *module = cache->p_module;
+ cache->p_module = NULL;
+ return module;
+ }
+ cache++;
+ count--;
}
return NULL;
}
+/** Adds entry to the cache */
+int CacheAdd (module_cache_t **cachep, size_t *countp,
+ const char *path, const struct stat *st, module_t *module)
+{
+ module_cache_t *cache = *cachep;
+ const size_t count = *countp;
+
+ cache = realloc (cache, (count + 1) * sizeof (*cache));
+ if (unlikely(cache == NULL))
+ return -1;
+ *cachep = cache;
+
+ cache += count;
+ /* NOTE: strdup() could be avoided, but it would be a bit ugly */
+ cache->path = strdup (path);
+ cache->mtime = st->st_mtime;
+ cache->size = st->st_size;
+ cache->p_module = module;
+ *countp = count + 1;
+ return 0;
+}
+
#endif /* HAVE_DYNAMIC_PLUGINS */
projects / vlc / blobdiff