Initial update to OpenSim 0.8.2.1 source code.

1 files changed, 232 insertions, 27 deletions

diff --git a/OpenSim/Region/Framework/Scenes/SimStatsReporter.cs b/OpenSim/Region/Framework/Scenes/SimStatsReporter.cs
index b9d615e..3effee7 100644..100755
--- a/OpenSim/Region/Framework/Scenes/SimStatsReporter.cs
+++ b/OpenSim/Region/Framework/Scenes/SimStatsReporter.cs
@@ -61,6 +61,10 @@ namespace OpenSim.Region.Framework.Scenes
 
         private YourStatsAreWrong handlerStatsIncorrect;
 
+        // Determines the size of the array that is used to collect StatBlocks
+        // for sending to the SimStats and SimExtraStatsCollector
+        private const int m_statisticArraySize = 28;
+
         /// <summary>
         /// These are the IDs of stats sent in the StatsPacket to the viewer.
         /// </summary>
@@ -104,7 +108,12 @@ namespace OpenSim.Region.Framework.Scenes
             ScriptEps = 31,
             SimSpareMs = 32,
             SimSleepMs = 33,
-            SimIoPumpTime = 34
+            SimIoPumpTime = 34,
+            FrameDilation = 35,
+            UsersLoggingIn = 36,
+            TotalGeoPrim = 37,
+            TotalMesh = 38,
+            ThreadCount = 39
         }
 
         /// <summary>
@@ -167,15 +176,20 @@ namespace OpenSim.Region.Framework.Scenes
         /// Parameter to adjust reported scene fps
         /// </summary>
         /// <remarks>
-        /// Our scene loop runs slower than other server implementations, apparantly because we work somewhat differently.
-        /// However, we will still report an FPS that's closer to what people are used to seeing.  A lower FPS might
-        /// affect clients and monitoring scripts/software.
+        /// The close we have to a frame rate as expected by viewers, users and scripts
+        /// is heartbeat rate.
+        /// heartbeat rate default value is very diferent from the expected one
+        /// and can be changed from region to region acording to its specific simulation needs
+        /// since this creates incompatibility with expected values,
+        /// this scale factor can be used to normalize values to a Virtual FPS.
+        /// original decision was to use a value of 55fps for all opensim
+        /// corresponding, with default heartbeat rate, to a value of 5.
         /// </remarks>
-        private float m_reportedFpsCorrectionFactor = 5;
+        private float m_statisticsFPSfactor = 5.0f;
 
         // saved last reported value so there is something available for llGetRegionFPS 
         private float lastReportedSimFPS;
-        private float[] lastReportedSimStats = new float[22];
+        private float[] lastReportedSimStats = new float[m_statisticArraySize];
         private float m_pfps;
 
         /// <summary>
@@ -195,13 +209,13 @@ namespace OpenSim.Region.Framework.Scenes
         private int m_physicsMS;
         private int m_imageMS;
         private int m_otherMS;
-
-//Ckrinke: (3-21-08) Comment out to remove a compiler warning. Bring back into play when needed.
-//Ckrinke        private int m_scriptMS = 0;
+        private int m_scriptMS;
 
         private int m_rootAgents;
         private int m_childAgents;
         private int m_numPrim;
+        private int m_numGeoPrim;
+        private int m_numMesh;
         private int m_inPacketsPerSecond;
         private int m_outPacketsPerSecond;
         private int m_activePrim;
@@ -213,6 +227,34 @@ namespace OpenSim.Region.Framework.Scenes
 
         private int m_objectCapacity = 45000;
 
+        // This is the number of frames that will be stored and then averaged for
+        // the Total, Simulation, Physics, and Network Frame Time; It is set to
+        // 10 by default but can be changed by the OpenSim.ini configuration file
+        // NumberOfFrames parameter
+        private int m_numberFramesStored;
+
+        // The arrays that will hold the time it took to run the past N frames,
+        // where N is the num_frames_to_average given by the configuration file
+        private double[] m_totalFrameTimeMilliseconds;
+        private double[] m_simulationFrameTimeMilliseconds;
+        private double[] m_physicsFrameTimeMilliseconds;
+        private double[] m_networkFrameTimeMilliseconds;
+
+        // The location of the next time in milliseconds that will be
+        // (over)written when the next frame completes
+        private int m_nextLocation = 0;
+
+        // The correct number of frames that have completed since the last stats
+        // update for physics
+        private int m_numberPhysicsFrames;
+
+        // The current number of users attempting to login to the region
+        private int m_usersLoggingIn;
+
+        // The last reported value of threads from the SmartThreadPool inside of
+        // XEngine
+        private int m_inUseThreads;
+
         private Scene m_scene;
 
         private RegionInfo ReportingRegion;
@@ -222,12 +264,34 @@ namespace OpenSim.Region.Framework.Scenes
         private IEstateModule estateModule;
 
         public SimStatsReporter(Scene scene)
+            : this(scene, Scene.m_defaultNumberFramesStored)
+        {
+        }
+
+        public SimStatsReporter(Scene scene, int numberOfFrames)
         {
+            // Store the number of frames from the OpenSim.ini configuration file
+            m_numberFramesStored = numberOfFrames;
+
+            // Initialize the different frame time arrays to the correct sizes
+            m_totalFrameTimeMilliseconds = new double[m_numberFramesStored];
+            m_simulationFrameTimeMilliseconds = new double[m_numberFramesStored];
+            m_physicsFrameTimeMilliseconds = new double[m_numberFramesStored];
+            m_networkFrameTimeMilliseconds = new double[m_numberFramesStored];
+
+            // Initialize the current number of users logging into the region
+            m_usersLoggingIn = 0;
+
             m_scene = scene;
-            m_reportedFpsCorrectionFactor = scene.MinFrameTime * m_nominalReportedFps;
+   
             m_statsUpdateFactor = (float)(m_statsUpdatesEveryMS / 1000);
             ReportingRegion = scene.RegionInfo;
 
+            if(scene.Normalized55FPS)
+                m_statisticsFPSfactor = 55.0f * m_scene.MinFrameTicks / 1000.0f;
+            else
+                m_statisticsFPSfactor = 1.0f;
+                                
             m_objectCapacity = scene.RegionInfo.ObjectCapacity;
             m_report.AutoReset = true;
             m_report.Interval = m_statsUpdatesEveryMS;
@@ -239,7 +303,7 @@ namespace OpenSim.Region.Framework.Scenes
 
             /// At the moment, we'll only report if a frame is over 120% of target, since commonly frames are a bit
             /// longer than ideal (which in itself is a concern).
-            SlowFramesStatReportThreshold = (int)Math.Ceiling(m_scene.MinFrameTime * 1000 * 1.2);
+            SlowFramesStatReportThreshold = (int)Math.Ceiling(scene.MinFrameTicks * 1.2);
 
             SlowFramesStat
                 = new Stat(
@@ -254,8 +318,10 @@ namespace OpenSim.Region.Framework.Scenes
                     StatVerbosity.Info);
 
             StatsManager.RegisterStat(SlowFramesStat);
+
         }
 
+
         public void Close()
         {
             m_report.Elapsed -= TriggerStatsHeartbeat;
@@ -289,7 +355,21 @@ namespace OpenSim.Region.Framework.Scenes
 
         private void statsHeartBeat(object sender, EventArgs e)
         {
-            SimStatsPacket.StatBlock[] sb = new SimStatsPacket.StatBlock[22];
+            double totalSumFrameTime;
+            double simulationSumFrameTime;
+            double physicsSumFrameTime;
+            double networkSumFrameTime;
+            float frameDilation;
+            int currentFrame;
+
+            if (!m_scene.Active)
+                return;
+
+            // Create arrays to hold the statistics for this current scene,
+            // these will be passed to the SimExtraStatsCollector, they are also
+            // sent to the SimStats class
+            SimStatsPacket.StatBlock[] sb = new
+                SimStatsPacket.StatBlock[m_statisticArraySize];
             SimStatsPacket.RegionBlock rb = new SimStatsPacket.RegionBlock();
             
             // Know what's not thread safe in Mono... modifying timers.
@@ -311,14 +391,15 @@ namespace OpenSim.Region.Framework.Scenes
 
 #region various statistic googly moogly
 
-                // We're going to lie about the FPS because we've been lying since 2008.  The actual FPS is currently
-                // locked at a maximum of 11.  Maybe at some point this can change so that we're not lying.
-                int reportedFPS = (int)(m_fps * m_reportedFpsCorrectionFactor);
+               int reportedFPS = (int)(m_fps * m_statisticsFPSfactor);
 
                 // save the reported value so there is something available for llGetRegionFPS 
                 lastReportedSimFPS = reportedFPS / m_statsUpdateFactor;
 
-                float physfps = ((m_pfps / 1000));
+               // ORIGINAL code commented out until we have time to add our own
+               // statistics to the statistics window
+                //float physfps = ((m_pfps / 1000));
+               float physfps = m_numberPhysicsFrames * m_statisticsFPSfactor;
 
                 //if (physfps > 600)
                 //physfps = physfps - (physfps - 600);
@@ -331,6 +412,8 @@ namespace OpenSim.Region.Framework.Scenes
                 m_rootAgents = m_scene.SceneGraph.GetRootAgentCount();
                 m_childAgents = m_scene.SceneGraph.GetChildAgentCount();
                 m_numPrim = m_scene.SceneGraph.GetTotalObjectsCount();
+                m_numGeoPrim = m_scene.SceneGraph.GetTotalPrimObjectsCount();
+                m_numMesh = m_scene.SceneGraph.GetTotalMeshObjectsCount();
                 m_activePrim = m_scene.SceneGraph.GetActiveObjectsCount();
                 m_activeScripts = m_scene.SceneGraph.GetActiveScriptsCount();
 
@@ -349,18 +432,52 @@ namespace OpenSim.Region.Framework.Scenes
                 // values to X-per-second values.
 
                 uint thisFrame = m_scene.Frame;
-                float framesUpdated = (float)(thisFrame - m_lastUpdateFrame) * m_reportedFpsCorrectionFactor;
+                uint numFrames = thisFrame - m_lastUpdateFrame;
+                float framesUpdated = (float)numFrames * m_statisticsFPSfactor;
                 m_lastUpdateFrame = thisFrame;
 
                 // Avoid div-by-zero if somehow we've not updated any frames.
                 if (framesUpdated == 0)
                     framesUpdated = 1;
 
-                for (int i = 0; i < 22; i++)
+                for (int i = 0; i < m_statisticArraySize; i++)
                 {
                     sb[i] = new SimStatsPacket.StatBlock();
                 }
-                
+
+                // Resetting the sums of the frame times to prevent any errors
+                // in calculating the moving average for frame time
+                totalSumFrameTime = 0;
+                simulationSumFrameTime = 0;
+                physicsSumFrameTime = 0;
+                networkSumFrameTime = 0;
+
+                // Loop through all the frames that were stored for the current
+                // heartbeat to process the moving average of frame times
+                for (int i = 0; i < m_numberFramesStored; i++)
+                {
+                    // Sum up each frame time in order to calculate the moving
+                    // average of frame time
+                    totalSumFrameTime += m_totalFrameTimeMilliseconds[i];
+                    simulationSumFrameTime +=
+                        m_simulationFrameTimeMilliseconds[i];
+                    physicsSumFrameTime += m_physicsFrameTimeMilliseconds[i];
+                    networkSumFrameTime += m_networkFrameTimeMilliseconds[i];
+                }
+
+                // Get the index that represents the current frame based on the next one known; go back
+                // to the last index if next one is stated to restart at 0
+                if (m_nextLocation == 0)
+                    currentFrame = m_numberFramesStored - 1;
+                else
+                    currentFrame = m_nextLocation - 1;
+
+                // Calculate the frame dilation; which is currently based on the ratio between the sum of the
+                // physics and simulation rate, and the set minimum time to run a scene's frame
+                frameDilation = (float)(m_simulationFrameTimeMilliseconds[currentFrame] +
+                   m_physicsFrameTimeMilliseconds[currentFrame]) / m_scene.MinFrameTicks;
+
+                // ORIGINAL code commented out until we have time to add our own
                 sb[0].StatID = (uint) Stats.TimeDilation;
                 sb[0].StatValue = (Single.IsNaN(m_timeDilation)) ? 0.1f : m_timeDilation ; //((((m_timeDilation + (0.10f * statsUpdateFactor)) /10)  / statsUpdateFactor));
 
@@ -385,20 +502,26 @@ namespace OpenSim.Region.Framework.Scenes
                 sb[7].StatID = (uint) Stats.ActivePrim;
                 sb[7].StatValue = m_activePrim;
 
+               // ORIGINAL code commented out until we have time to add our own
+               // statistics to the statistics window
                 sb[8].StatID = (uint)Stats.FrameMS;
-                sb[8].StatValue = m_frameMS / framesUpdated;
+                //sb[8].StatValue = m_frameMS / framesUpdated;
+                sb[8].StatValue = (float) totalSumFrameTime / m_numberFramesStored / m_statisticsFPSfactor;
 
                 sb[9].StatID = (uint)Stats.NetMS;
-                sb[9].StatValue = m_netMS / framesUpdated;
+                //sb[9].StatValue = m_netMS / framesUpdated;
+                sb[9].StatValue = (float) networkSumFrameTime / m_numberFramesStored / m_statisticsFPSfactor;
 
                 sb[10].StatID = (uint)Stats.PhysicsMS;
-                sb[10].StatValue = m_physicsMS / framesUpdated;
+                //sb[10].StatValue = m_physicsMS / framesUpdated;
+                sb[10].StatValue = (float) physicsSumFrameTime / m_numberFramesStored / m_statisticsFPSfactor;
 
                 sb[11].StatID = (uint)Stats.ImageMS ;
                 sb[11].StatValue = m_imageMS / framesUpdated;
 
                 sb[12].StatID = (uint)Stats.OtherMS;
-                sb[12].StatValue = m_otherMS / framesUpdated;
+                //sb[12].StatValue = m_otherMS / framesUpdated;
+                sb[12].StatValue = (float) simulationSumFrameTime / m_numberFramesStored / m_statisticsFPSfactor;
 
                 sb[13].StatID = (uint)Stats.InPacketsPerSecond;
                 sb[13].StatValue = (m_inPacketsPerSecond / m_statsUpdateFactor);
@@ -427,7 +550,31 @@ namespace OpenSim.Region.Framework.Scenes
                 sb[21].StatID = (uint)Stats.SimSpareMs;
                 sb[21].StatValue = m_spareMS / framesUpdated;
 
-                for (int i = 0; i < 22; i++)
+                // Current ratio between the sum of physics and sim rate, and the
+                // minimum time to run a scene's frame
+                sb[22].StatID = (uint)Stats.FrameDilation;
+                sb[22].StatValue = frameDilation;
+
+                // Current number of users currently attemptint to login to region
+                sb[23].StatID = (uint)Stats.UsersLoggingIn;
+                sb[23].StatValue = m_usersLoggingIn;
+
+                // Total number of geometric primitives in the scene
+                sb[24].StatID = (uint)Stats.TotalGeoPrim;
+                sb[24].StatValue = m_numGeoPrim;
+
+                // Total number of mesh objects in the scene
+                sb[25].StatID = (uint)Stats.TotalMesh;
+                sb[25].StatValue = m_numMesh;
+
+                // Current number of threads that XEngine is using
+                sb[26].StatID = (uint)Stats.ThreadCount;
+                sb[26].StatValue = m_inUseThreads;
+
+                sb[27].StatID = (uint)Stats.ScriptMS;
+                sb[27].StatValue = (numFrames <= 0) ? 0 : ((float)m_scriptMS / numFrames);
+
+                for (int i = 0; i < m_statisticArraySize; i++)
                 {
                     lastReportedSimStats[i] = sb[i].StatValue;
                 }
@@ -472,6 +619,10 @@ namespace OpenSim.Region.Framework.Scenes
 
         private void ResetValues()
         {
+            // Reset the number of frames that the physics library has
+            // processed since the last stats report
+            m_numberPhysicsFrames = 0;
+
             m_timeDilation = 0;
             m_fps = 0;
             m_pfps = 0;
@@ -488,10 +639,8 @@ namespace OpenSim.Region.Framework.Scenes
             m_physicsMS = 0;
             m_imageMS = 0;
             m_otherMS = 0;
+            m_scriptMS = 0;
             m_spareMS = 0;
-
-//Ckrinke This variable is not used, so comment to remove compiler warning until it is used.
-//Ckrinke            m_scriptMS = 0;
         }
 
         # region methods called from Scene
@@ -602,6 +751,37 @@ namespace OpenSim.Region.Framework.Scenes
             m_otherMS += ms;
         }
 
+        public void AddScriptMS(int ms)
+        {
+            m_scriptMS += ms;
+        }
+
+        public void addPhysicsFrame(int frames)
+        {
+            // Add the number of physics frames to the correct total physics
+            // frames
+            m_numberPhysicsFrames += frames;
+        }
+
+        public void addFrameTimeMilliseconds(double total, double simulation,
+            double physics, double network)
+        {
+            // Save the frame times from the current frame into the appropriate
+            // arrays
+            m_totalFrameTimeMilliseconds[m_nextLocation] = total;
+            m_simulationFrameTimeMilliseconds[m_nextLocation] = simulation;
+            m_physicsFrameTimeMilliseconds[m_nextLocation] = physics;
+            m_networkFrameTimeMilliseconds[m_nextLocation] = network;
+
+            // Update to the next location in the list
+            m_nextLocation++;
+
+            // Since the list will begin to overwrite the oldest frame values
+            // first, the next location needs to loop back to the beginning of the
+            // list whenever it reaches the end
+            m_nextLocation = m_nextLocation % m_numberFramesStored;
+        }
+
         public void AddPendingDownloads(int count)
         {
             m_pendingDownloads += count;
@@ -624,6 +804,31 @@ namespace OpenSim.Region.Framework.Scenes
             AddunAckedBytes(unAckedBytes);
         }
 
+        public void UpdateUsersLoggingIn(bool isLoggingIn)
+        {
+            // Determine whether the user has started logging in or has completed
+            // logging into the region
+            if (isLoggingIn)
+            {
+                // The user is starting to login to the region so increment the
+                // number of users attempting to login to the region
+                m_usersLoggingIn++;
+            }
+            else
+            {
+                // The user has finished logging into the region so decrement the
+                // number of users logging into the region
+                m_usersLoggingIn--;
+            }
+        }
+
+        public void SetThreadCount(int inUseThreads)
+        {
+            // Save the new number of threads to our member variable to send to
+            // the extra stats collector
+            m_inUseThreads = inUseThreads;
+        }
+
         #endregion
 
         public Dictionary<string, float> GetExtraSimStats()