GlynnTuckerAssetCache.cs 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using log4net;
  28. using System;
  29. using System.IO;
  30. using System.Collections.Generic;
  31. using System.Reflection;
  32. using GlynnTucker.Cache;
  33. using Nini.Config;
  34. using OpenSim.Framework;
  35. using OpenSim.Region.Framework.Interfaces;
  36. using OpenSim.Region.Framework.Scenes;
  37. using OpenSim.Services.Interfaces;
  38. namespace OpenSim.Region.CoreModules.Asset
  39. {
  40. public class GlynnTuckerAssetCache : ISharedRegionModule, IImprovedAssetCache
  41. {
  42. private static readonly ILog m_log =
  43. LogManager.GetLogger(
  44. MethodBase.GetCurrentMethod().DeclaringType);
  45. private bool m_Enabled = false;
  46. private ICache m_Cache = new GlynnTucker.Cache.SimpleMemoryCache();
  47. // Instrumentation
  48. private uint m_DebugRate = 0;
  49. public Type ReplaceableInterface
  50. {
  51. get { return null; }
  52. }
  53. public string Name
  54. {
  55. get { return "GlynnTuckerAssetCache"; }
  56. }
  57. public void Initialise(IConfigSource source)
  58. {
  59. IConfig moduleConfig = source.Configs["Modules"];
  60. if (moduleConfig != null)
  61. {
  62. string name = moduleConfig.GetString("AssetCaching");
  63. m_log.DebugFormat("[ASSET CACHE] name = {0} (this module's name: {1}). Sync? ", name, Name, m_Cache.IsSynchronized);
  64. if (name == Name)
  65. {
  66. m_Enabled = true;
  67. m_log.Info("[ASSET CACHE]: GlynnTucker asset cache enabled");
  68. // Instrumentation
  69. IConfig cacheConfig = source.Configs["AssetCache"];
  70. if (cacheConfig != null)
  71. m_DebugRate = (uint)cacheConfig.GetInt("DebugRate", 0);
  72. }
  73. }
  74. }
  75. public void PostInitialise()
  76. {
  77. }
  78. public void Close()
  79. {
  80. }
  81. public void AddRegion(Scene scene)
  82. {
  83. if (m_Enabled)
  84. scene.RegisterModuleInterface<IImprovedAssetCache>(this);
  85. }
  86. public void RemoveRegion(Scene scene)
  87. {
  88. }
  89. public void RegionLoaded(Scene scene)
  90. {
  91. }
  92. ////////////////////////////////////////////////////////////
  93. // IImprovedAssetCache
  94. //
  95. public void Cache(AssetBase asset)
  96. {
  97. if (asset != null)
  98. m_Cache.AddOrUpdate(asset.ID, asset);
  99. }
  100. private ulong m_Hits = 0;
  101. private ulong m_Requests = 0;
  102. private void Debug(Object asset)
  103. {
  104. // Temporary instrumentation to measure the hit/miss rate
  105. if (m_DebugRate > 0)
  106. {
  107. m_Requests++;
  108. if (asset != null)
  109. m_Hits++;
  110. if ((m_Requests % m_DebugRate) == 0)
  111. m_log.DebugFormat("[ASSET CACHE]: Hit Rate {0} / {1} == {2}%", m_Hits, m_Requests, ((float)m_Hits / m_Requests) * 100);
  112. }
  113. // End instrumentation
  114. }
  115. public AssetBase Get(string id)
  116. {
  117. Object asset = null;
  118. m_Cache.TryGet(id, out asset);
  119. Debug(asset);
  120. return (AssetBase)asset;
  121. }
  122. public void Expire(string id)
  123. {
  124. Object asset = null;
  125. if (m_Cache.TryGet(id, out asset))
  126. m_Cache.Remove(id);
  127. }
  128. public void Clear()
  129. {
  130. m_Cache.Clear();
  131. }
  132. }
  133. }