X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fmodules%2Fcache.c;h=76b1b9b8a910d5d2a92a18a032a8067435ee5828;hb=d14f6b7668a99f80803e834bc487964abfe9ab7c;hp=c6e314ff9ea22913f9a85a9181f2127d1c35217b;hpb=42bc82f425cdd53d39fe28832b30303e2d6b62ed;p=vlc diff --git a/src/modules/cache.c b/src/modules/cache.c index c6e314ff9e..76b1b9b8a9 100644 --- a/src/modules/cache.c +++ b/src/modules/cache.c @@ -35,10 +35,10 @@ #include /* sprintf() */ #include /* strdup() */ #include -#include #include #include +#include #ifdef HAVE_UNISTD_H # include #endif @@ -59,14 +59,11 @@ static int CacheLoadConfig ( module_t *, FILE * ); /* Sub-version number * (only used to avoid breakage in dev version when cache structure changes) */ -#define CACHE_SUBVERSION_NUM 11 +#define CACHE_SUBVERSION_NUM 15 -/* 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 @@ -76,40 +73,35 @@ void CacheDelete( vlc_object_t *obj, const char *dir ) assert( dir != NULL ); - if( asprintf( &path, "%s"DIR_SEP CACHENAME_FORMAT, - dir, CACHENAME_VALUES ) == -1 ) + 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 ); } -/***************************************************************************** - * LoadPluginsCache: loads the plugins cache file - ***************************************************************************** +/** + * 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, const char *dir ) + */ +size_t CacheLoad( vlc_object_t *p_this, const char *dir, module_cache_t ***r ) { char *psz_filename; FILE *file; - int j, i_size, i_read; + int i_size, i_read; char p_cachestring[sizeof(CACHE_STRING)]; size_t i_cache; - module_cache_t **pp_cache = NULL; - int32_t i_file_size, i_marker; + int32_t i_marker; assert( dir != NULL ); - if( !p_bank->b_cache ) - return; - - if( asprintf( &psz_filename, "%s"DIR_SEP CACHENAME_FORMAT, - dir, CACHENAME_VALUES ) == -1 ) - 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 ); @@ -119,30 +111,10 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) 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_STRING) - 1; i_read = fread( p_cachestring, 1, i_size, file ); @@ -151,7 +123,7 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) { msg_Warn( p_this, "This doesn't look like a valid plugins cache" ); fclose( file ); - return; + return 0; } #ifdef DISTRO_VERSION @@ -164,7 +136,7 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) { msg_Warn( p_this, "This doesn't look like a valid plugins cache" ); fclose( file ); - return; + return 0; } #endif @@ -175,7 +147,7 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) msg_Warn( p_this, "This doesn't look like a valid plugins cache " "(corrupted header)" ); fclose( file ); - return; + return 0; } /* Check header marker */ @@ -186,7 +158,7 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) msg_Warn( p_this, "This doesn't look like a valid plugins cache " "(corrupted header)" ); fclose( file ); - return; + return 0; } if (fread( &i_cache, 1, sizeof(i_cache), file ) != sizeof(i_cache) ) @@ -194,22 +166,10 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) msg_Warn( p_this, "This doesn't look like a valid plugins cache " "(file too short)" ); fclose( file ); - return; + return 0; } - if( i_cache ) - { - size_t i_already = p_bank->i_loaded_cache; - pp_cache = realloc( p_bank->pp_loaded_cache, - (i_already + i_cache) * sizeof(*pp_cache) ); - if( unlikely(pp_cache == NULL) ) - i_cache = 0; /* don't load */ - else - { - p_bank->pp_loaded_cache = pp_cache; - pp_cache += i_already; - } - } + module_cache_t **pp_cache = NULL; #define LOAD_IMMEDIATE(a) \ if( fread( (void *)&a, sizeof(char), sizeof(a), file ) != sizeof(a) ) goto error @@ -233,86 +193,101 @@ void CacheLoad( vlc_object_t *p_this, module_bank_t *p_bank, const char *dir ) } \ } - for( size_t 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) ); - - /* 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(); /* 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++ ) + free (module->psz_object_name); + LOAD_STRING(module->psz_object_name); + 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 if (module->i_shortcuts == 0) + module->pp_shortcuts = NULL; + 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( pp_cache[i]->p_module->domain ); - if( pp_cache[i]->p_module->domain != NULL ) - vlc_bindtextdomain( pp_cache[i]->p_module->domain ); + LOAD_STRING(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_submodule_create (module); + free (submodule->psz_object_name); + free (submodule->pp_shortcuts); + LOAD_STRING(submodule->psz_object_name); + LOAD_STRING(submodule->psz_shortname); + LOAD_STRING(submodule->psz_longname); + LOAD_STRING(submodule->psz_help); + + LOAD_IMMEDIATE(submodule->i_shortcuts); + if (submodule->i_shortcuts > MODULE_SHORTCUT_MAX) + goto error; + else if (submodule->i_shortcuts == 0) + submodule->pp_shortcuts = NULL; + 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( p_module->domain ); + + LOAD_STRING(submodule->psz_capability); + LOAD_IMMEDIATE(submodule->i_score); + LOAD_IMMEDIATE(submodule->b_unloadable); + LOAD_STRING(submodule->domain); } - } - p_bank->i_loaded_cache += i_cache; + char *path; + struct stat st; + + /* Load common info */ + LOAD_STRING(path); + LOAD_IMMEDIATE(st.st_mtime); + LOAD_IMMEDIATE(st.st_size); + + CacheAdd (&pp_cache, &count, path, &st, module); + free (path); + /* TODO: deal with errors */ + } fclose( file ); - return; - error: + *r = pp_cache; + return i_cache; +error: msg_Warn( p_this, "plugins cache not loaded (corrupted)" ); /* TODO: cleanup */ 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; } @@ -350,7 +325,6 @@ static int CacheLoadConfig( module_t *p_module, FILE *file ) 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)) { @@ -358,15 +332,10 @@ static int CacheLoadConfig( module_t *p_module, FILE *file ) 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; @@ -421,11 +390,6 @@ static int CacheLoadConfig( module_t *p_module, FILE *file ) 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; @@ -437,23 +401,19 @@ static int CacheLoadConfig( module_t *p_module, FILE *file ) static int CacheSaveBank( FILE *file, module_cache_t *const *, size_t ); -/***************************************************************************** - * SavePluginsCache: saves the plugins cache to a file - *****************************************************************************/ +/** + * 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 *const *pp_cache, size_t n) + module_cache_t **entries, size_t n) { - char *filename, *tmpname; + char *filename = NULL, *tmpname = NULL; - if (asprintf (&filename, "%s"DIR_SEP CACHENAME_FORMAT, dir, - CACHENAME_VALUES ) == -1) - return; + if (asprintf (&filename, "%s"DIR_SEP CACHE_NAME, dir ) == -1) + goto out; if (asprintf (&tmpname, "%s.%"PRIu32, filename, (uint32_t)getpid ()) == -1) - { - free (filename); - return; - } + goto out; msg_Dbg (p_this, "saving plugins cache %s", filename); FILE *file = vlc_fopen (tmpname, "wb"); @@ -464,7 +424,7 @@ void CacheSave (vlc_object_t *p_this, const char *dir, goto out; } - if (CacheSaveBank (file, pp_cache, n)) + if (CacheSaveBank (file, entries, n)) { msg_Warn (p_this, "cannot write %s (%m)", tmpname); clearerr (file); @@ -473,7 +433,7 @@ void CacheSave (vlc_object_t *p_this, const char *dir, goto out; } -#ifndef WIN32 +#if !defined( WIN32 ) && !defined( __OS2__ ) vlc_rename (tmpname, filename); /* atomically replace old cache */ fclose (file); #else @@ -484,6 +444,13 @@ void CacheSave (vlc_object_t *p_this, const char *dir, out: free (filename); free (tmpname); + + for (size_t i = 0; i < n; i++) + { + free (entries[i]->path); + free (entries[i]); + } + free (entries); } static int CacheSaveConfig (FILE *, const module_t *); @@ -494,10 +461,6 @@ static int CacheSaveBank (FILE *file, module_cache_t *const *pp_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_STRING, file) == EOF) goto error; @@ -535,24 +498,18 @@ static int CacheSaveBank (FILE *file, module_cache_t *const *pp_cache, { 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_IMMEDIATE( pp_cache[i]->p_module->i_shortcuts ); + for (unsigned j = 0; j < pp_cache[i]->p_module->i_shortcuts; j++) + SAVE_STRING( pp_cache[i]->p_module->pp_shortcuts[j] ); + 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 ); /* Config stuff */ if (CacheSaveConfig (file, pp_cache[i]->p_module)) @@ -565,13 +522,14 @@ static int CacheSaveBank (FILE *file, module_cache_t *const *pp_cache, SAVE_IMMEDIATE( i_submodule ); if( CacheSaveSubmodule( file, pp_cache[i]->p_module->submodule ) ) goto error; + + /* Save common info */ + SAVE_STRING(pp_cache[i]->path); + SAVE_IMMEDIATE(pp_cache[i]->mtime); + SAVE_IMMEDIATE(pp_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! */ @@ -590,8 +548,9 @@ static int CacheSaveSubmodule( FILE *file, const module_t *p_module ) 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 ); @@ -621,7 +580,6 @@ static int CacheSaveConfig (FILE *file, const module_t *p_module) 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 ); @@ -648,9 +606,6 @@ static int CacheSaveConfig (FILE *file, const module_t *p_module) 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; @@ -686,26 +641,51 @@ void CacheMerge( vlc_object_t *p_this, module_t *p_cache, module_t *p_module ) 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 *const *entries, 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]; + module_cache_t *entry = *(entries++); + + if (!strcmp (entry->path, path) + && entry->mtime == st->st_mtime + && entry->size == st->st_size) + { + module_t *module = entry->p_module; + entry->p_module = NULL; /* Return NULL next time */ + return module; + } + count--; } return NULL; } +/** Adds entry to the cache */ +int CacheAdd (module_cache_t ***cache, size_t *count, + const char *path, const struct stat *st, module_t *module) +{ + module_cache_t **entries; + + entries = realloc (*cache, (*count + 1) * sizeof (*entries)); + if (unlikely(entries == NULL)) + return -1; + *cache = entries; + + entries[*count] = malloc (sizeof (**entries)); + if (unlikely(entries[*count] == NULL)) + return -1; + /* NOTE: strdup() could be avoided, but it would be a bit ugly */ + entries[*count]->path = strdup (path); + entries[*count]->mtime = st->st_mtime; + entries[*count]->size = st->st_size; + entries[*count]->p_module = module; + (*count)++; + return 0; +} + #endif /* HAVE_DYNAMIC_PLUGINS */