In ObjectTortureTests, run garbage collector on Teardown and run scene loop update when scene objects have been deleted.

At least on mono 2.6.4, running GC.Collect() is not guaranteed to force gc of all objects when run in the same method where those objects had references.
Therefore, GC.Collect() is now being done in the per-script teardown of ObjectTortureTests.
In addition, scene loop update is being run after garbage collection in order to clean out the viewer update list of scene objects in the SceneGraph.
These measures mean that scene objects/parts are now garbage collected after a test run if deleted from the scene, resulting in a much better memory usage report (though probably still not very accurate).
However, deletion takes a very long time - what's really needed is to find out now why the entire scene isn't being GC'd by this measure.
This change hasn't yet been applied to the other stress tests.

5 files changed, 68 insertions, 10 deletions

diff --git a/OpenSim/Region/Framework/Scenes/SceneGraph.cs b/OpenSim/Region/Framework/Scenes/SceneGraph.cs
index 693a79e..e66678a 100644
--- a/OpenSim/Region/Framework/Scenes/SceneGraph.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneGraph.cs
@@ -359,7 +359,7 @@ namespace OpenSim.Region.Framework.Scenes
                 m_log.ErrorFormat(
                     "[SCENEGRAPH]: Tried to add scene object {0} to {1} with illegal UUID of {2}",
                     sceneObject.Name, m_parentScene.RegionInfo.RegionName, UUID.Zero);
-                
+
                 return false;
             }
 
@@ -368,12 +368,12 @@ namespace OpenSim.Region.Framework.Scenes
 //                m_log.DebugFormat(
 //                    "[SCENEGRAPH]: Scene graph for {0} already contains object {1} in AddSceneObject()",
 //                    m_parentScene.RegionInfo.RegionName, sceneObject.UUID);
-                
+
                 return false;
             }
-            
+
 //            m_log.DebugFormat(
-//                "[SCENEGRAPH]: Adding scene object {0} {1}, with {2} parts on {3}", 
+//                "[SCENEGRAPH]: Adding scene object {0} {1}, with {2} parts on {3}",
 //                sceneObject.Name, sceneObject.UUID, sceneObject.Parts.Length, m_parentScene.RegionInfo.RegionName);
 
             SceneObjectPart[] parts = sceneObject.Parts;
@@ -409,7 +409,7 @@ namespace OpenSim.Region.Framework.Scenes
 
             lock (SceneObjectGroupsByFullID)
                 SceneObjectGroupsByFullID[sceneObject.UUID] = sceneObject;
-            
+
             lock (SceneObjectGroupsByFullPartID)
             {
                 foreach (SceneObjectPart part in parts)
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
index 4c339d9..b130bf7 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
@@ -303,6 +303,9 @@ namespace OpenSim.Region.Framework.Scenes
 
 //        ~SceneObjectPart()
 //        {
+//            Console.WriteLine(
+//                "[SCENE OBJECT PART]: Destructor called for {0}, local id {1}, parent {2} {3}",
+//                Name, LocalId, ParentGroup.Name, ParentGroup.LocalId);
 //            m_log.DebugFormat(
 //                "[SCENE OBJECT PART]: Destructor called for {0}, local id {1}, parent {2} {3}",
 //                Name, LocalId, ParentGroup.Name, ParentGroup.LocalId);
diff --git a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectBasicTests.cs b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectBasicTests.cs
index 80f198d..7737d8e 100644
--- a/OpenSim/Region/Framework/Scenes/Tests/SceneObjectBasicTests.cs
+++ b/OpenSim/Region/Framework/Scenes/Tests/SceneObjectBasicTests.cs
@@ -27,6 +27,7 @@
 
 using System;
 using System.Reflection;
+using System.Threading;
 using NUnit.Framework;
 using OpenMetaverse;
 using OpenSim.Framework;
@@ -43,6 +44,42 @@ namespace OpenSim.Region.Framework.Scenes.Tests
     [TestFixture]
     public class SceneObjectBasicTests
     {
+//        [TearDown]
+//        public void TearDown()
+//        {
+//            Console.WriteLine("TearDown");
+//            GC.Collect();
+//            Thread.Sleep(3000);
+//        }
+
+//        public class GcNotify
+//        {
+//            public static AutoResetEvent gcEvent = new AutoResetEvent(false);
+//            private static bool _initialized = false;
+//
+//            public static void Initialize()
+//            {
+//                if (!_initialized)
+//                {
+//                    _initialized = true;
+//                    new GcNotify();
+//                }
+//            }
+//
+//            private GcNotify(){}
+//
+//            ~GcNotify()
+//            {
+//                if (!Environment.HasShutdownStarted &&
+//                    !AppDomain.CurrentDomain.IsFinalizingForUnload())
+//                {
+//                    Console.WriteLine("GcNotify called");
+//                    gcEvent.Set();
+//                    new GcNotify();
+//                }
+//            }
+//        }
+
         /// <summary>
         /// Test adding an object to a scene.
         /// </summary>
@@ -147,11 +184,11 @@ namespace OpenSim.Region.Framework.Scenes.Tests
         public void TestDeleteSceneObject()
         {
             TestHelpers.InMethod();
-            
+
             TestScene scene = SceneHelpers.SetupScene();
             SceneObjectPart part = SceneHelpers.AddSceneObject(scene);
             scene.DeleteSceneObject(part.ParentGroup, false);
-            
+
             SceneObjectPart retrievedPart = scene.GetSceneObjectPart(part.LocalId);
             Assert.That(retrievedPart, Is.Null);
         }
diff --git a/OpenSim/Tests/Common/Mock/TestScene.cs b/OpenSim/Tests/Common/Mock/TestScene.cs
index 328cd2b..eea68c3 100644
--- a/OpenSim/Tests/Common/Mock/TestScene.cs
+++ b/OpenSim/Tests/Common/Mock/TestScene.cs
@@ -50,7 +50,8 @@ namespace OpenSim.Tests.Common.Mock
 
         ~TestScene()
         {
-            Console.WriteLine("TestScene destructor called for {0}", RegionInfo.RegionName);
+            //Console.WriteLine("TestScene destructor called for {0}", RegionInfo.RegionName);
+            Console.WriteLine("TestScene destructor called");
         }
         
         /// <summary>
diff --git a/OpenSim/Tests/Torture/ObjectTortureTests.cs b/OpenSim/Tests/Torture/ObjectTortureTests.cs
index 74b336e..e83186a 100644
--- a/OpenSim/Tests/Torture/ObjectTortureTests.cs
+++ b/OpenSim/Tests/Torture/ObjectTortureTests.cs
@@ -49,6 +49,13 @@ namespace OpenSim.Tests.Torture
     [TestFixture]
     public class ObjectTortureTests
     {
+        [TearDown]
+        public void TearDown()
+        {
+            GC.Collect();
+            GC.WaitForPendingFinalizers();
+        }
+
 //        [Test]
 //        public void Test0000Clean()
 //        {
@@ -141,8 +148,18 @@ namespace OpenSim.Tests.Torture
                     string.Format("Object {0} could not be retrieved", i));
             }
 
-            // This does not work to fire the SceneObjectGroup destructors - something else is hanging on to them.
-//            scene.DeleteAllSceneObjects();
+            // When a scene object is added to a scene, it is placed in the update list for sending to viewers
+            // (though in this case we have none).  When it is deleted, it is not removed from the update which is
+            // fine since it will later be ignored.
+            //
+            // However, that means that we need to manually run an update here to clear out that list so that deleted
+            // objects will be clean up by the garbage collector before the next stress test is run.
+            scene.Update();
+
+            // Currently, we need to do this in order to garbage collect the scene objects ready for the next test run.
+            // However, what we really need to do is find out why the entire scene is not garbage collected in
+            // teardown.
+            scene.DeleteAllSceneObjects();
 
             Console.WriteLine(
                 "Took {0}ms, {1}MB ({2} - {3}) to create {4} objects each containing {5} prim(s)",