12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337 |
- /*
- * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * * Neither the name of the OpenSimulator Project nor the
- * names of its contributors may be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
- using System;
- using System.IO;
- using System.Collections.Generic;
- using System.Linq;
- using System.Reflection;
- using System.Runtime.Serialization;
- using System.Runtime.Serialization.Formatters.Binary;
- using System.Text;
- using System.Threading;
- using System.Timers;
- using log4net;
- using Nini.Config;
- using Mono.Addins;
- using OpenMetaverse;
- using OpenSim.Framework;
- using OpenSim.Framework.Console;
- using OpenSim.Framework.Monitoring;
- using OpenSim.Region.Framework.Interfaces;
- using OpenSim.Region.Framework.Scenes;
- using OpenSim.Server.Base;
- using OpenSim.Services.Interfaces;
- namespace OpenSim.Region.CoreModules.Asset
- {
- [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "FlotsamAssetCache")]
- public class FlotsamAssetCache : ISharedRegionModule, IAssetCache, IAssetService
- {
- private static readonly ILog m_log = LogManager.GetLogger( MethodBase.GetCurrentMethod().DeclaringType);
- private bool m_Enabled;
- private bool m_timerRunning;
- private bool m_cleanupRunning;
- private const string m_ModuleName = "FlotsamAssetCache";
- private const string m_DefaultCacheDirectory = "./assetcache";
- private string m_CacheDirectory = m_DefaultCacheDirectory;
- private string m_assetLoader;
- private string m_assetLoaderArgs;
- private readonly char[] m_InvalidChars;
- private int m_LogLevel = 0;
- private ulong m_HitRateDisplay = 100; // How often to display hit statistics, given in requests
- private ulong m_Requests;
- private ulong m_RequestsForInprogress;
- private ulong m_DiskHits;
- private ulong m_MemoryHits;
- private ulong m_weakRefHits;
- private HashSet<string> m_CurrentlyWriting = new HashSet<string>();
- private bool m_FileCacheEnabled = true;
- private ExpiringCache<string, AssetBase> m_MemoryCache;
- private bool m_MemoryCacheEnabled = false;
- private ExpiringCache<string, object> m_negativeCache;
- private bool m_negativeCacheEnabled = true;
- private bool m_negativeCacheSliding = false;
- // Expiration is expressed in hours.
- private double m_MemoryExpiration = 0.016;
- private const double m_DefaultFileExpiration = 48;
- // Negative cache is in seconds
- private int m_negativeExpiration = 120;
- private TimeSpan m_FileExpiration = TimeSpan.FromHours(m_DefaultFileExpiration);
- private TimeSpan m_FileExpirationCleanupTimer = TimeSpan.FromHours(1.0);
- private static int m_CacheDirectoryTiers = 1;
- private static int m_CacheDirectoryTierLen = 3;
- private static int m_CacheWarnAt = 30000;
- private System.Timers.Timer m_CacheCleanTimer;
- private IAssetService m_AssetService;
- private List<Scene> m_Scenes = new List<Scene>();
- private object timerLock = new object();
- private Dictionary<string,WeakReference> weakAssetReferences = new Dictionary<string, WeakReference>();
- private object weakAssetReferencesLock = new object();
- private bool m_updateFileTimeOnCacheHit = false;
- public FlotsamAssetCache()
- {
- List<char> invalidChars = new List<char>();
- invalidChars.AddRange(Path.GetInvalidPathChars());
- invalidChars.AddRange(Path.GetInvalidFileNameChars());
- m_InvalidChars = invalidChars.ToArray();
- }
- private static JobEngine m_DiskWriterEngine = null;
- public Type ReplaceableInterface
- {
- get { return null; }
- }
- public string Name
- {
- get { return m_ModuleName; }
- }
- public void Initialise(IConfigSource source)
- {
- IConfig moduleConfig = source.Configs["Modules"];
- if (moduleConfig != null)
- {
- string name = moduleConfig.GetString("AssetCaching", String.Empty);
- if (name == Name)
- {
- m_MemoryCache = new ExpiringCache<string, AssetBase>();
- m_negativeCache = new ExpiringCache<string, object>();
- m_Enabled = true;
- m_log.InfoFormat("[FLOTSAM ASSET CACHE]: {0} enabled", this.Name);
- IConfig assetConfig = source.Configs["AssetCache"];
- if (assetConfig == null)
- {
- m_log.Debug(
- "[FLOTSAM ASSET CACHE]: AssetCache section missing from config (not copied config-include/FlotsamCache.ini.example? Using defaults.");
- }
- else
- {
- m_FileCacheEnabled = assetConfig.GetBoolean("FileCacheEnabled", m_FileCacheEnabled);
- m_CacheDirectory = assetConfig.GetString("CacheDirectory", m_DefaultCacheDirectory);
- m_MemoryCacheEnabled = assetConfig.GetBoolean("MemoryCacheEnabled", m_MemoryCacheEnabled);
- m_MemoryExpiration = assetConfig.GetDouble("MemoryCacheTimeout", m_MemoryExpiration);
- m_MemoryExpiration *= 3600.0; // config in hours to seconds
- m_negativeCacheEnabled = assetConfig.GetBoolean("NegativeCacheEnabled", m_negativeCacheEnabled);
- m_negativeExpiration = assetConfig.GetInt("NegativeCacheTimeout", m_negativeExpiration);
- m_negativeCacheSliding = assetConfig.GetBoolean("NegativeCacheSliding", m_negativeCacheSliding);
- m_updateFileTimeOnCacheHit = assetConfig.GetBoolean("UpdateFileTimeOnCacheHit", m_updateFileTimeOnCacheHit);
- m_updateFileTimeOnCacheHit &= m_FileCacheEnabled;
- m_LogLevel = assetConfig.GetInt("LogLevel", m_LogLevel);
- m_HitRateDisplay = (ulong)assetConfig.GetLong("HitRateDisplay", (long)m_HitRateDisplay);
- m_FileExpiration = TimeSpan.FromHours(assetConfig.GetDouble("FileCacheTimeout", m_DefaultFileExpiration));
- m_FileExpirationCleanupTimer
- = TimeSpan.FromHours(
- assetConfig.GetDouble("FileCleanupTimer", m_FileExpirationCleanupTimer.TotalHours));
- m_CacheDirectoryTiers = assetConfig.GetInt("CacheDirectoryTiers", m_CacheDirectoryTiers);
- m_CacheDirectoryTierLen = assetConfig.GetInt("CacheDirectoryTierLength", m_CacheDirectoryTierLen);
- m_CacheWarnAt = assetConfig.GetInt("CacheWarnAt", m_CacheWarnAt);
- }
- m_log.InfoFormat("[FLOTSAM ASSET CACHE]: Cache Directory {0}", m_CacheDirectory);
- if (m_CacheDirectoryTiers < 1)
- m_CacheDirectoryTiers = 1;
- else if (m_CacheDirectoryTiers > 3)
- m_CacheDirectoryTiers = 3;
- if (m_CacheDirectoryTierLen < 1)
- m_CacheDirectoryTierLen = 1;
- else if (m_CacheDirectoryTierLen > 4)
- m_CacheDirectoryTierLen = 4;
- assetConfig = source.Configs["AssetService"];
- if(assetConfig != null)
- {
- m_assetLoader = assetConfig.GetString("DefaultAssetLoader", String.Empty);
- m_assetLoaderArgs = assetConfig.GetString("AssetLoaderArgs", string.Empty);
- if (string.IsNullOrWhiteSpace(m_assetLoaderArgs))
- m_assetLoader = string.Empty;
- }
- MainConsole.Instance.Commands.AddCommand("Assets", true, "fcache status", "fcache status", "Display cache status", HandleConsoleCommand);
- MainConsole.Instance.Commands.AddCommand("Assets", true, "fcache clear", "fcache clear [file] [memory]", "Remove all assets in the cache. If file or memory is specified then only this cache is cleared.", HandleConsoleCommand);
- MainConsole.Instance.Commands.AddCommand("Assets", true, "fcache assets", "fcache assets", "Attempt a deep scan and cache of all assets in all scenes", HandleConsoleCommand);
- MainConsole.Instance.Commands.AddCommand("Assets", true, "fcache expire", "fcache expire <datetime>", "Purge cached assets older then the specified date/time", HandleConsoleCommand);
- if (!string.IsNullOrWhiteSpace(m_assetLoader))
- {
- MainConsole.Instance.Commands.AddCommand("Assets", true, "fcache cachedefaultassets", "fcache cachedefaultassets", "loads local default assets to cache. This may override grid ones. use with care", HandleConsoleCommand);
- MainConsole.Instance.Commands.AddCommand("Assets", true, "fcache deletedefaultassets", "fcache deletedefaultassets", "deletes default local assets from cache so they can be refreshed from grid. use with care", HandleConsoleCommand);
- }
- }
- }
- }
- public void PostInitialise()
- {
- }
- public void Close()
- {
- }
- public void AddRegion(Scene scene)
- {
- if (m_Enabled)
- {
- scene.RegisterModuleInterface<IAssetCache>(this);
- m_Scenes.Add(scene);
- }
- }
- public void RemoveRegion(Scene scene)
- {
- if (m_Enabled)
- {
- scene.UnregisterModuleInterface<IAssetCache>(this);
- m_Scenes.Remove(scene);
- lock(timerLock)
- {
- if(m_timerRunning && m_Scenes.Count <= 0)
- {
- m_timerRunning = false;
- m_CacheCleanTimer.Stop();
- m_CacheCleanTimer.Close();
- if (m_FileCacheEnabled && m_DiskWriterEngine != null && m_DiskWriterEngine.IsRunning)
- m_DiskWriterEngine.Stop();
- }
- }
- }
- }
- public void RegionLoaded(Scene scene)
- {
- if (m_Enabled)
- {
- if(m_AssetService == null)
- m_AssetService = scene.RequestModuleInterface<IAssetService>();
- lock(timerLock)
- {
- if(!m_timerRunning)
- {
- if (m_FileCacheEnabled && (m_FileExpiration > TimeSpan.Zero) && (m_FileExpirationCleanupTimer > TimeSpan.Zero))
- {
- m_CacheCleanTimer = new System.Timers.Timer(m_FileExpirationCleanupTimer.TotalMilliseconds);
- m_CacheCleanTimer.AutoReset = false;
- m_CacheCleanTimer.Elapsed += CleanupExpiredFiles;
- m_CacheCleanTimer.Start();
- m_timerRunning = true;
- }
- }
- if(m_DiskWriterEngine == null)
- {
- m_DiskWriterEngine = new JobEngine("FlotsamWriter", "FlotsamWriter");
- m_DiskWriterEngine.Start();
- }
- }
- }
- }
- ////////////////////////////////////////////////////////////
- // IAssetCache
- //
- private void UpdateWeakReference(string key, AssetBase asset)
- {
- WeakReference aref;
- lock(weakAssetReferencesLock)
- {
- if(weakAssetReferences.TryGetValue(key , out aref))
- aref.Target = asset;
- else
- weakAssetReferences[key] = new WeakReference(asset);
- }
- }
- private void UpdateMemoryCache(string key, AssetBase asset)
- {
- // NOTE DO NOT USE SLIDEEXPIRE option on current libomv
- m_MemoryCache.AddOrUpdate(key, asset, m_MemoryExpiration);
- }
- private void UpdateFileCache(string key, AssetBase asset, bool replace = false)
- {
- string filename = GetFileName(key);
- try
- {
- // If the file is already cached, don't cache it, just touch it so access time is updated
- if (!replace && File.Exists(filename))
- {
- UpdateFileLastAccessTime(filename);
- return;
- }
- // Once we start writing, make sure we flag that we're writing
- // that object to the cache so that we don't try to write the
- // same file multiple times.
- lock (m_CurrentlyWriting)
- {
- if (m_CurrentlyWriting.Contains(filename))
- return;
- else
- m_CurrentlyWriting.Add(filename);
- }
- // weakreferences should hold and return the asset while async write happens
- m_DiskWriterEngine?.QueueJob("", delegate { WriteFileCache(filename, asset, replace); });
- }
- catch (Exception e)
- {
- m_log.ErrorFormat(
- "[FLOTSAM ASSET CACHE]: Failed to update cache for asset {0}. Exception {1} {2}",
- asset.ID, e.Message, e.StackTrace);
- }
- }
- public void Cache(AssetBase asset, bool replace = false)
- {
- // TODO: Spawn this off to some seperate thread to do the actual writing
- if (asset != null)
- {
- //m_log.DebugFormat("[FLOTSAM ASSET CACHE]: Caching asset with id {0}", asset.ID);
- UpdateWeakReference(asset.ID, asset);
- if (m_MemoryCacheEnabled)
- UpdateMemoryCache(asset.ID, asset);
- if (m_FileCacheEnabled)
- UpdateFileCache(asset.ID, asset, replace);
- }
- }
- public void CacheNegative(string id)
- {
- if (m_negativeCacheEnabled)
- {
- if (m_negativeCacheSliding)
- m_negativeCache.AddOrUpdate(id, null, TimeSpan.FromSeconds(m_negativeExpiration));
- else
- m_negativeCache.AddOrUpdate(id, null, m_negativeExpiration);
- }
- }
- /// <summary>
- /// Updates the cached file with the current time.
- /// </summary>
- /// <param name="filename">Filename.</param>
- /// <returns><c>true</c>, if the update was successful, false otherwise.</returns>
- private bool UpdateFileLastAccessTime(string filename)
- {
- try
- {
- File.SetLastAccessTime(filename, DateTime.Now);
- return true;
- }
- catch
- {
- return false;
- }
- }
- private AssetBase GetFromWeakReference(string id)
- {
- AssetBase asset = null;
- lock(weakAssetReferencesLock)
- {
- if (weakAssetReferences.TryGetValue(id, out WeakReference aref))
- {
- asset = aref.Target as AssetBase;
- if(asset == null)
- weakAssetReferences.Remove(id);
- else
- m_weakRefHits++;
- }
- }
- return asset;
- }
- /// <summary>
- /// Try to get an asset from the in-memory cache.
- /// </summary>
- /// <param name="id"></param>
- /// <returns></returns>
- private AssetBase GetFromMemoryCache(string id)
- {
- AssetBase asset = null;
- if (m_MemoryCache.TryGetValue(id, out asset))
- m_MemoryHits++;
- return asset;
- }
- private bool CheckFromMemoryCache(string id)
- {
- return m_MemoryCache.Contains(id);
- }
- /// <summary>
- /// Try to get an asset from the file cache.
- /// </summary>
- /// <param name="id"></param>
- /// <returns>An asset retrieved from the file cache. null if there was a problem retrieving an asset.</returns>
- private AssetBase GetFromFileCache(string id)
- {
- string filename = GetFileName(id);
- // Track how often we have the problem that an asset is requested while
- // it is still being downloaded by a previous request.
- if (m_CurrentlyWriting.Contains(filename))
- {
- m_RequestsForInprogress++;
- return null;
- }
- AssetBase asset = null;
- if (File.Exists(filename))
- {
- try
- {
- using (FileStream stream = File.Open(filename, FileMode.Open, FileAccess.Read, FileShare.Read))
- {
- if (stream.Length == 0) // Empty file will trigger exception below
- return null;
- BinaryFormatter bformatter = new BinaryFormatter();
- asset = (AssetBase)bformatter.Deserialize(stream);
- m_DiskHits++;
- }
- }
- catch (System.Runtime.Serialization.SerializationException e)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Failed to get file {0} for asset {1}. Exception {2} {3}",
- filename, id, e.Message, e.StackTrace);
- // If there was a problem deserializing the asset, the asset may
- // either be corrupted OR was serialized under an old format
- // {different version of AssetBase} -- we should attempt to
- // delete it and re-cache
- File.Delete(filename);
- }
- catch (Exception e)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Failed to get file {0} for asset {1}. Exception {2} {3}",
- filename, id, e.Message, e.StackTrace);
- }
- }
- return asset;
- }
- private bool CheckFromFileCache(string id)
- {
- bool found = false;
- string filename = GetFileName(id);
- if (File.Exists(filename))
- {
- try
- {
- using (FileStream stream = File.Open(filename, FileMode.Open, FileAccess.Read, FileShare.Read))
- {
- if (stream != null)
- found = true;
- }
- }
- catch (Exception e)
- {
- m_log.ErrorFormat(
- "[FLOTSAM ASSET CACHE]: Failed to check file {0} for asset {1}. Exception {2} {3}",
- filename, id, e.Message, e.StackTrace);
- }
- }
- return found;
- }
- // For IAssetService
- public AssetBase Get(string id)
- {
- AssetBase asset;
- Get(id, out asset);
- return asset;
- }
- public bool Get(string id, out AssetBase asset)
- {
- asset = null;
- m_Requests++;
- object dummy;
- if (m_negativeCache.TryGetValue(id, out dummy))
- {
- return false;
- }
- asset = GetFromWeakReference(id);
- if (asset != null && m_updateFileTimeOnCacheHit)
- {
- string filename = GetFileName(id);
- UpdateFileLastAccessTime(filename);
- }
- if (m_MemoryCacheEnabled && asset == null)
- {
- asset = GetFromMemoryCache(id);
- if(asset != null)
- {
- UpdateWeakReference(id,asset);
- if (m_updateFileTimeOnCacheHit)
- {
- string filename = GetFileName(id);
- UpdateFileLastAccessTime(filename);
- }
- }
- }
- if (asset == null && m_FileCacheEnabled)
- {
- asset = GetFromFileCache(id);
- if(asset != null)
- UpdateWeakReference(id,asset);
- }
- if (m_MemoryCacheEnabled && asset != null)
- UpdateMemoryCache(id, asset);
- if (((m_LogLevel >= 1)) && (m_HitRateDisplay != 0) && (m_Requests % m_HitRateDisplay == 0))
- {
- m_log.InfoFormat("[FLOTSAM ASSET CACHE]: Cache Get :: {0} :: {1}", id, asset == null ? "Miss" : "Hit");
- GenerateCacheHitReport().ForEach(l => m_log.InfoFormat("[FLOTSAM ASSET CACHE]: {0}", l));
- }
- return true;
- }
- public bool Check(string id)
- {
- if (m_MemoryCacheEnabled && CheckFromMemoryCache(id))
- return true;
- if (m_FileCacheEnabled && CheckFromFileCache(id))
- return true;
- return false;
- }
- public AssetBase GetCached(string id)
- {
- AssetBase asset;
- Get(id, out asset);
- return asset;
- }
- public void Expire(string id)
- {
- if (m_LogLevel >= 2)
- m_log.DebugFormat("[FLOTSAM ASSET CACHE]: Expiring Asset {0}", id);
- try
- {
- lock (weakAssetReferencesLock)
- weakAssetReferences.Remove(id);
- if (m_FileCacheEnabled)
- {
- string filename = GetFileName(id);
- File.Delete(filename);
- }
- if (m_MemoryCacheEnabled)
- m_MemoryCache.Remove(id);
- }
- catch (Exception e)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Failed to expire cached file {0}. Exception {1} {2}",
- id, e.Message, e.StackTrace);
- }
- }
- public void Clear()
- {
- if (m_LogLevel >= 2)
- m_log.Debug("[FLOTSAM ASSET CACHE]: Clearing caches.");
- if (m_FileCacheEnabled && Directory.Exists(m_CacheDirectory))
- {
- foreach (string dir in Directory.GetDirectories(m_CacheDirectory))
- {
- Directory.Delete(dir);
- }
- }
- if (m_MemoryCacheEnabled)
- m_MemoryCache = new ExpiringCache<string, AssetBase>();
- if (m_negativeCacheEnabled)
- m_negativeCache = new ExpiringCache<string, object>();
- lock(weakAssetReferencesLock)
- weakAssetReferences = new Dictionary<string, WeakReference>();
- }
- private void CleanupExpiredFiles(object source, ElapsedEventArgs e)
- {
- if (m_LogLevel >= 2)
- m_log.DebugFormat("[FLOTSAM ASSET CACHE]: Checking for expired files older then {0}.", m_FileExpiration);
- lock(timerLock)
- {
- if(!m_timerRunning || m_cleanupRunning)
- return;
- m_cleanupRunning = true;
- }
- // Purge all files last accessed prior to this point
- DateTime purgeLine = DateTime.Now - m_FileExpiration;
- // An asset cache may contain local non-temporary assets that are not in the asset service. Therefore,
- // before cleaning up expired files we must scan the objects in the scene to make sure that we retain
- // such local assets if they have not been recently accessed.
- TouchAllSceneAssets(false);
- if(Directory.Exists(m_CacheDirectory))
- {
- foreach (string dir in Directory.GetDirectories(m_CacheDirectory))
- CleanExpiredFiles(dir, purgeLine);
- }
- lock(timerLock)
- {
- if(m_timerRunning)
- m_CacheCleanTimer.Start();
- m_cleanupRunning = false;
- }
- }
- /// <summary>
- /// Recurses through specified directory checking for asset files last
- /// accessed prior to the specified purge line and deletes them. Also
- /// removes empty tier directories.
- /// </summary>
- /// <param name="dir"></param>
- /// <param name="purgeLine"></param>
- private void CleanExpiredFiles(string dir, DateTime purgeLine)
- {
- try
- {
- if(!Directory.Exists(dir))
- return;
- foreach (string file in Directory.GetFiles(dir))
- {
- if (File.GetLastAccessTime(file) < purgeLine)
- {
- File.Delete(file);
- }
- }
- // Recurse into lower tiers
- foreach (string subdir in Directory.GetDirectories(dir))
- {
- CleanExpiredFiles(subdir, purgeLine);
- }
- // Check if a tier directory is empty, if so, delete it
- int dirSize = Directory.GetFiles(dir).Length + Directory.GetDirectories(dir).Length;
- if (dirSize == 0)
- {
- Directory.Delete(dir);
- }
- else if (dirSize >= m_CacheWarnAt)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Cache folder exceeded CacheWarnAt limit {0} {1}. Suggest increasing tiers, tier length, or reducing cache expiration",
- dir, dirSize);
- }
- }
- catch (DirectoryNotFoundException)
- {
- // If we get here, another node on the same box has
- // already removed the directory. Continue with next.
- }
- catch (Exception e)
- {
- m_log.Warn(
- string.Format("[FLOTSAM ASSET CACHE]: Could not complete clean of expired files in {0}, exception ", dir), e);
- }
- }
- /// <summary>
- /// Determines the filename for an AssetID stored in the file cache
- /// </summary>
- /// <param name="id"></param>
- /// <returns></returns>
- private string GetFileName(string id)
- {
- int indx = id.IndexOfAny(m_InvalidChars);
- if (indx >= 0)
- {
- int sublen = id.Length - indx;
- StringBuilder sb = new StringBuilder(id);
- for(int i = 0; i < m_InvalidChars.Length; ++i)
- {
- sb.Replace(m_InvalidChars[i], '_', indx, sublen);
- }
- id = sb.ToString();
- }
- string path = m_CacheDirectory;
- for (int p = 1; p <= m_CacheDirectoryTiers; p++)
- {
- string pathPart = id.Substring((p - 1) * m_CacheDirectoryTierLen, m_CacheDirectoryTierLen);
- path = Path.Combine(path, pathPart);
- }
- return Path.Combine(path, id);
- }
- /// <summary>
- /// Writes a file to the file cache, creating any nessesary
- /// tier directories along the way
- /// </summary>
- /// <param name="filename"></param>
- /// <param name="asset"></param>
- private void WriteFileCache(string filename, AssetBase asset, bool replace)
- {
- // Make sure the target cache directory exists
- string directory = Path.GetDirectoryName(filename);
- // Write file first to a temp name, so that it doesn't look
- // like it's already cached while it's still writing.
- string tempname = Path.Combine(directory, Path.GetRandomFileName());
- try
- {
- try
- {
- if (!Directory.Exists(directory))
- {
- Directory.CreateDirectory(directory);
- }
- using(Stream stream = File.Open(tempname, FileMode.Create))
- {
- BinaryFormatter bformatter = new BinaryFormatter();
- bformatter.Serialize(stream, asset);
- stream.Flush();
- }
- }
- catch (IOException e)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Failed to write asset {0} to temporary location {1} (final {2}) on cache in {3}. Exception {4} {5}.",
- asset.ID, tempname, filename, directory, e.Message, e.StackTrace);
- return;
- }
- catch (UnauthorizedAccessException)
- {
- }
- try
- {
- if(replace)
- File.Delete(filename);
- File.Move(tempname, filename);
- if (m_LogLevel >= 2)
- m_log.DebugFormat("[FLOTSAM ASSET CACHE]: Cache Stored :: {0}", asset.ID);
- }
- catch (IOException)
- {
- // If we see an IOException here it's likely that some other competing thread has written the
- // cache file first, so ignore. Other IOException errors (e.g. filesystem full) should be
- // signally by the earlier temporary file writing code.
- }
- }
- finally
- {
- // Even if the write fails with an exception, we need to make sure
- // that we release the lock on that file, otherwise it'll never get
- // cached
- lock (m_CurrentlyWriting)
- {
- m_CurrentlyWriting.Remove(filename);
- }
- }
- }
- /// <summary>
- /// Scan through the file cache, and return number of assets currently cached.
- /// </summary>
- /// <param name="dir"></param>
- /// <returns></returns>
- private int GetFileCacheCount(string dir)
- {
- if(!Directory.Exists(dir))
- return 0;
- int count = Directory.GetFiles(dir).Length;
- foreach (string subdir in Directory.GetDirectories(dir))
- {
- count += GetFileCacheCount(subdir);
- }
- return count;
- }
- /// <summary>
- /// This notes the last time the Region had a deep asset scan performed on it.
- /// </summary>
- /// <param name="regionID"></param>
- private void StampRegionStatusFile(UUID regionID)
- {
- string RegionCacheStatusFile = Path.Combine(m_CacheDirectory, "RegionStatus_" + regionID.ToString() + ".fac");
- try
- {
- if (File.Exists(RegionCacheStatusFile))
- {
- File.SetLastWriteTime(RegionCacheStatusFile, DateTime.Now);
- }
- else
- {
- File.WriteAllText(
- RegionCacheStatusFile,
- "Please do not delete this file unless you are manually clearing your Flotsam Asset Cache.");
- }
- }
- catch (Exception e)
- {
- m_log.Warn(
- string.Format(
- "[FLOTSAM ASSET CACHE]: Could not stamp region status file for region {0}. Exception ",
- regionID),
- e);
- }
- }
- /// <summary>
- /// Iterates through all Scenes, doing a deep scan through assets
- /// to update the access time of all assets present in the scene or referenced by assets
- /// in the scene.
- /// </summary>
- /// <param name="storeUncached">
- /// If true, then assets scanned which are not found in cache are added to the cache.
- /// </param>
- /// <returns>Number of distinct asset references found in the scene.</returns>
- private int TouchAllSceneAssets(bool storeUncached)
- {
- UuidGatherer gatherer = new UuidGatherer(m_AssetService);
- Dictionary<UUID, bool> assetsFound = new Dictionary<UUID, bool>();
- foreach (Scene s in m_Scenes)
- {
- StampRegionStatusFile(s.RegionInfo.RegionID);
- s.ForEachSOG(delegate(SceneObjectGroup e)
- {
- if(!m_timerRunning && !storeUncached)
- return;
- gatherer.AddForInspection(e);
- gatherer.GatherAll();
- if(!m_timerRunning && !storeUncached)
- return;
- foreach (UUID assetID in gatherer.GatheredUuids.Keys)
- {
- if (!assetsFound.ContainsKey(assetID))
- {
- string filename = GetFileName(assetID.ToString());
- if (File.Exists(filename))
- {
- UpdateFileLastAccessTime(filename);
- assetsFound[assetID] = true;
- }
- else if (storeUncached)
- {
- AssetBase cachedAsset = m_AssetService.Get(assetID.ToString());
- if (cachedAsset == null && gatherer.GatheredUuids[assetID] != (sbyte)AssetType.Unknown)
- assetsFound[assetID] = false;
- else
- assetsFound[assetID] = true;
- }
- }
- else if (!assetsFound[assetID])
- {
- m_log.DebugFormat(
- "[FLOTSAM ASSET CACHE]: Could not find asset {0}, type {1} referenced by object {2} at {3} in scene {4} when pre-caching all scene assets",
- assetID, gatherer.GatheredUuids[assetID], e.Name, e.AbsolutePosition, s.Name);
- }
- }
- gatherer.GatheredUuids.Clear();
- if(!m_timerRunning && !storeUncached)
- return;
- if(!storeUncached)
- Thread.Sleep(50);
- });
- if(!m_timerRunning && !storeUncached)
- break;
- }
- return assetsFound.Count;
- }
- /// <summary>
- /// Deletes all cache contents
- /// </summary>
- private void ClearFileCache()
- {
- if(!Directory.Exists(m_CacheDirectory))
- return;
- foreach (string dir in Directory.GetDirectories(m_CacheDirectory))
- {
- try
- {
- Directory.Delete(dir, true);
- }
- catch (Exception e)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Couldn't clear asset cache directory {0} from {1}. Exception {2} {3}",
- dir, m_CacheDirectory, e.Message, e.StackTrace);
- }
- }
- foreach (string file in Directory.GetFiles(m_CacheDirectory))
- {
- try
- {
- File.Delete(file);
- }
- catch (Exception e)
- {
- m_log.WarnFormat(
- "[FLOTSAM ASSET CACHE]: Couldn't clear asset cache file {0} from {1}. Exception {1} {2}",
- file, m_CacheDirectory, e.Message, e.StackTrace);
- }
- }
- }
- private List<string> GenerateCacheHitReport()
- {
- List<string> outputLines = new List<string>();
- double invReq = 100.0 / m_Requests;
- double weakHitRate = m_weakRefHits * invReq;
- int weakEntriesAlive = 0;
- lock(weakAssetReferencesLock)
- {
- foreach(WeakReference aref in weakAssetReferences.Values)
- {
- if (aref.IsAlive)
- ++weakEntriesAlive;
- }
- }
- int weakEntries = weakAssetReferences.Count;
- double fileHitRate = m_DiskHits * invReq;
- double TotalHitRate = weakHitRate + fileHitRate;
- outputLines.Add(
- string.Format("Total requests: {0}", m_Requests));
- outputLines.Add(
- string.Format("unCollected Hit Rate: {0}% ({1} entries {2} alive)", weakHitRate.ToString("0.00"),weakEntries, weakEntriesAlive));
- outputLines.Add(
- string.Format("File Hit Rate: {0}%", fileHitRate.ToString("0.00")));
- if (m_MemoryCacheEnabled)
- {
- double HitRate = m_MemoryHits * invReq;
- outputLines.Add(
- string.Format("Memory Hit Rate: {0}%", HitRate.ToString("0.00")));
- TotalHitRate += HitRate;
- }
- outputLines.Add(
- string.Format("Total Hit Rate: {0}%", TotalHitRate.ToString("0.00")));
- outputLines.Add(
- string.Format(
- "Requests overlap during file writing: {0}", m_RequestsForInprogress));
- return outputLines;
- }
- #region Console Commands
- private void HandleConsoleCommand(string module, string[] cmdparams)
- {
- ICommandConsole con = MainConsole.Instance;
- if (cmdparams.Length >= 2)
- {
- string cmd = cmdparams[1];
- switch (cmd)
- {
- case "status":
- if (m_MemoryCacheEnabled)
- con.Output("Memory Cache: {0} assets", m_MemoryCache.Count);
- else
- con.Output("Memory cache disabled");
- if (m_FileCacheEnabled)
- {
- int fileCount = GetFileCacheCount(m_CacheDirectory);
- con.Output("File Cache: {0} assets", fileCount);
- }
- else
- {
- con.Output("File cache disabled");
- }
- GenerateCacheHitReport().ForEach(l => con.Output(l));
- if (m_FileCacheEnabled)
- {
- con.Output("Deep scans have previously been performed on the following regions:");
- foreach (string s in Directory.GetFiles(m_CacheDirectory, "*.fac"))
- {
- string RegionID = s.Remove(0,s.IndexOf("_")).Replace(".fac","");
- DateTime RegionDeepScanTMStamp = File.GetLastWriteTime(s);
- con.Output("Region: {0}, {1}", RegionID, RegionDeepScanTMStamp.ToString("MM/dd/yyyy hh:mm:ss"));
- }
- }
- break;
- case "clear":
- if (cmdparams.Length < 2)
- {
- con.Output("Usage is fcache clear [file] [memory]");
- break;
- }
- bool clearMemory = false, clearFile = false;
- if (cmdparams.Length == 2)
- {
- clearMemory = true;
- clearFile = true;
- }
- foreach (string s in cmdparams)
- {
- if (s.ToLower() == "memory")
- clearMemory = true;
- else if (s.ToLower() == "file")
- clearFile = true;
- }
- if (clearMemory)
- {
- if (m_MemoryCacheEnabled)
- {
- m_MemoryCache.Clear();
- con.Output("Memory cache cleared.");
- }
- else
- {
- con.Output("Memory cache not enabled.");
- }
- }
- if (clearFile)
- {
- if (m_FileCacheEnabled)
- {
- ClearFileCache();
- con.Output("File cache cleared.");
- }
- else
- {
- con.Output("File cache not enabled.");
- }
- }
- break;
- case "assets":
- lock(timerLock)
- {
- if(m_cleanupRunning)
- {
- con.Output("Flotsam assets check already running");
- return;
- }
- m_cleanupRunning = true;
- }
- con.Output("Flotsam Ensuring assets are cached for all scenes.");
- WorkManager.RunInThreadPool(delegate
- {
- bool wasRunning= false;
- lock(timerLock)
- {
- if(m_timerRunning)
- {
- m_CacheCleanTimer.Stop();
- m_timerRunning = false;
- wasRunning = true;
- Thread.Sleep(100);
- }
- }
- int assetReferenceTotal = TouchAllSceneAssets(true);
- GC.Collect();
- lock(timerLock)
- {
- if(wasRunning)
- {
- m_CacheCleanTimer.Start();
- m_timerRunning = true;
- }
- m_cleanupRunning = false;
- }
- con.Output("Completed check with {0} assets.", assetReferenceTotal);
- }, null, "TouchAllSceneAssets", false);
- break;
- case "expire":
- if (cmdparams.Length < 3)
- {
- con.Output("Invalid parameters for Expire, please specify a valid date & time");
- break;
- }
- string s_expirationDate = "";
- DateTime expirationDate;
- if (cmdparams.Length > 3)
- {
- s_expirationDate = string.Join(" ", cmdparams, 2, cmdparams.Length - 2);
- }
- else
- {
- s_expirationDate = cmdparams[2];
- }
- if (!DateTime.TryParse(s_expirationDate, out expirationDate))
- {
- con.Output("{0} is not a valid date & time", cmd);
- break;
- }
- if (m_FileCacheEnabled)
- CleanExpiredFiles(m_CacheDirectory, expirationDate);
- else
- con.Output("File cache not active, not clearing.");
- break;
- case "cachedefaultassets":
- HandleLoadDefaultAssets();
- break;
- case "deletedefaultassets":
- HandleDeleteDefaultAssets();
- break;
- default:
- con.Output("Unknown command {0}", cmd);
- break;
- }
- }
- else if (cmdparams.Length == 1)
- {
- con.Output("fcache assets - Attempt a deep cache of all assets in all scenes");
- con.Output("fcache expire <datetime> - Purge assets older then the specified date & time");
- con.Output("fcache clear [file] [memory] - Remove cached assets");
- con.Output("fcache status - Display cache status");
- con.Output("fcache cachedefaultassets - loads default assets to cache replacing existent ones, this may override grid assets. Use with care");
- con.Output("fcache deletedefaultassets - deletes default local assets from cache so they can be refreshed from grid");
- }
- }
- #endregion
- #region IAssetService Members
- public AssetMetadata GetMetadata(string id)
- {
- AssetBase asset;
- Get(id, out asset);
- if (asset == null)
- return null;
- return asset.Metadata;
- }
- public byte[] GetData(string id)
- {
- AssetBase asset;
- Get(id, out asset);
- if (asset == null)
- return null;
- return asset.Data;
- }
- public bool Get(string id, object sender, AssetRetrieved handler)
- {
- AssetBase asset;
- if (!Get(id, out asset))
- return false;
- handler(id, sender, asset);
- return true;
- }
- public bool[] AssetsExist(string[] ids)
- {
- bool[] exist = new bool[ids.Length];
- for (int i = 0; i < ids.Length; i++)
- {
- exist[i] = Check(ids[i]);
- }
- return exist;
- }
- public string Store(AssetBase asset)
- {
- if (asset.FullID == UUID.Zero)
- {
- asset.FullID = UUID.Random();
- }
- Cache(asset);
- return asset.ID;
- }
- public bool UpdateContent(string id, byte[] data)
- {
- AssetBase asset;
- if (!Get(id, out asset))
- return false;
- asset.Data = data;
- Cache(asset, true);
- return true;
- }
- public bool Delete(string id)
- {
- Expire(id);
- return true;
- }
- private void HandleLoadDefaultAssets()
- {
- if (string.IsNullOrWhiteSpace(m_assetLoader))
- {
- m_log.Info("[FLOTSAM ASSET CACHE] default assets loader not defined");
- return;
- }
- IAssetLoader assetLoader = ServerUtils.LoadPlugin<IAssetLoader>(m_assetLoader, new object[] { });
- if (assetLoader == null)
- {
- m_log.Info("[FLOTSAM ASSET CACHE] default assets loader not found");
- return;
- }
- m_log.Info("[FLOTSAM ASSET CACHE] start loading local default assets");
- int count = 0;
- assetLoader.ForEachDefaultXmlAsset(
- m_assetLoaderArgs,
- delegate (AssetBase a)
- {
- Cache(a, true);
- ++count;
- });
- m_log.InfoFormat("[FLOTSAM ASSET CACHE] loaded {0} local default assets", count);
- }
- private void HandleDeleteDefaultAssets()
- {
- if (string.IsNullOrWhiteSpace(m_assetLoader))
- {
- m_log.Info("[FLOTSAM ASSET CACHE] default assets loader not defined");
- return;
- }
- IAssetLoader assetLoader = ServerUtils.LoadPlugin<IAssetLoader>(m_assetLoader, new object[] { });
- if (assetLoader == null)
- {
- m_log.Info("[FLOTSAM ASSET CACHE] default assets loader not found");
- return;
- }
- m_log.Info("[FLOTSAM ASSET CACHE] started deleting local default assets");
- int count = 0;
- assetLoader.ForEachDefaultXmlAsset(
- m_assetLoaderArgs,
- delegate (AssetBase a)
- {
- Expire(a.ID);
- ++count;
- });
- m_log.InfoFormat("[FLOTSAM ASSET CACHE] deleted {0} local default assets", count);
- }
- #endregion
- }
- }
|