* Stop the sim stats reporter reusing the same SimStatsPacket for all clients

* I believe this was the cause of the remaining packet_out_of_order messages in the Linden client logs
* There were race conditions where multiple clientstacks would overwrite each other's sequence numbers

3 files changed, 119 insertions, 25 deletions

diff --git a/OpenSim/Framework/IClientAPI.cs b/OpenSim/Framework/IClientAPI.cs
index 1a6a5a4..4071e47 100644
--- a/OpenSim/Framework/IClientAPI.cs
+++ b/OpenSim/Framework/IClientAPI.cs
@@ -722,7 +722,13 @@ namespace OpenSim.Framework
         void SendImagePart(ushort numParts, UUID ImageUUID, uint ImageSize, byte[] ImageData, byte imageCodec);
 
         void SendShutdownConnectionNotice();
-        void SendSimStats(Packet pack);
+        
+        /// <summary>
+        /// Send statistical information about the sim to the client.
+        /// </summary>
+        /// <param name="stats"></param>
+        void SendSimStats(SimStats stats);
+        
         void SendObjectPropertiesFamilyData(uint RequestFlags, UUID ObjectUUID, UUID OwnerID, UUID GroupID,
                                                     uint BaseMask, uint OwnerMask, uint GroupMask, uint EveryoneMask,
                                                     uint NextOwnerMask, int OwnershipCost, byte SaleType, int SalePrice, uint Category,
diff --git a/OpenSim/Framework/SimStats.cs b/OpenSim/Framework/SimStats.cs
new file mode 100644
index 0000000..c77d0d4
--- /dev/null
+++ b/OpenSim/Framework/SimStats.cs
@@ -0,0 +1,88 @@
+/*
+ * 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 OpenSim 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 OpenMetaverse.Packets;
+
+namespace OpenSim.Framework
+{
+    /// <summary>
+    /// Enapsulate statistics for a simulator/scene.
+    /// 
+    /// TODO: This looks very much like the OpenMetaverse SimStatsPacket.  It should be much more generic stats
+    /// storage.
+    /// </summary>        
+    public class SimStats
+    {                 
+        public uint RegionX
+        {
+            get { return m_regionX; }
+        }
+        private uint m_regionX;
+
+        public uint RegionY
+        {
+            get { return m_regionY; }
+        }        
+        private uint m_regionY;
+        
+        public SimStatsPacket.RegionBlock RegionBlock
+        {
+            get { return m_regionBlock; }
+        }                
+        private SimStatsPacket.RegionBlock m_regionBlock;
+        
+        public SimStatsPacket.StatBlock[] StatsBlock
+        {
+            get { return m_statsBlock; }
+        }        
+        private SimStatsPacket.StatBlock[] m_statsBlock;
+        
+        public uint RegionFlags
+        {
+            get { return m_regionFlags; }
+        }        
+        private uint m_regionFlags;
+            
+        public uint ObjectCapacity
+        {
+            get { return m_objectCapacity; }
+        }
+        private uint m_objectCapacity;
+                
+        public SimStats(
+            uint regionX, uint regionY, uint regionFlags, uint objectCapacity, 
+            SimStatsPacket.RegionBlock regionBlock, SimStatsPacket.StatBlock[] statsBlock)
+        {
+            m_regionX = regionX;
+            m_regionY = regionY;
+            m_regionFlags = regionFlags;
+            m_objectCapacity = objectCapacity;
+            m_regionBlock = regionBlock;
+            m_statsBlock = statsBlock;
+        }
+    }
+}
diff --git a/OpenSim/Framework/Statistics/SimExtraStatsCollector.cs b/OpenSim/Framework/Statistics/SimExtraStatsCollector.cs
index 2f6bb7e..48bed81 100644
--- a/OpenSim/Framework/Statistics/SimExtraStatsCollector.cs
+++ b/OpenSim/Framework/Statistics/SimExtraStatsCollector.cs
@@ -216,31 +216,31 @@ namespace OpenSim.Framework.Statistics
         /// client purposes) sends information to listeners.
         /// </summary>
         /// <param name="pack"></param>
-        public void ReceiveClassicSimStatsPacket(SimStatsPacket statsPacket)
+        public void ReceiveClassicSimStatsPacket(SimStats stats)
         {
-            // FIXME: Really shouldn't rely on the probably arbitrary order in which
-            // stats are packed into the packet
-            timeDilation            = statsPacket.Stat[0].StatValue;
-            simFps                  = statsPacket.Stat[1].StatValue;
-            physicsFps              = statsPacket.Stat[2].StatValue;
-            agentUpdates            = statsPacket.Stat[3].StatValue;
-            rootAgents              = statsPacket.Stat[4].StatValue;
-            childAgents             = statsPacket.Stat[5].StatValue;
-            totalPrims              = statsPacket.Stat[6].StatValue;
-            activePrims             = statsPacket.Stat[7].StatValue;
-            totalFrameTime          = statsPacket.Stat[8].StatValue;
-            netFrameTime            = statsPacket.Stat[9].StatValue;
-            physicsFrameTime        = statsPacket.Stat[10].StatValue;
-            otherFrameTime          = statsPacket.Stat[11].StatValue;
-            imageFrameTime          = statsPacket.Stat[12].StatValue;
-            inPacketsPerSecond      = statsPacket.Stat[13].StatValue;
-            outPacketsPerSecond     = statsPacket.Stat[14].StatValue;
-            unackedBytes            = statsPacket.Stat[15].StatValue;
-            agentFrameTime          = statsPacket.Stat[16].StatValue;
-            pendingDownloads        = statsPacket.Stat[17].StatValue;
-            pendingUploads          = statsPacket.Stat[18].StatValue;
-            activeScripts           = statsPacket.Stat[19].StatValue;
-            scriptLinesPerSecond    = statsPacket.Stat[20].StatValue;
+            // FIXME: SimStats shouldn't allow an arbitrary stat packing order (which is inherited from the original
+            // SimStatsPacket that was being used).
+            timeDilation            = stats.StatsBlock[0].StatValue;
+            simFps                  = stats.StatsBlock[1].StatValue;
+            physicsFps              = stats.StatsBlock[2].StatValue;
+            agentUpdates            = stats.StatsBlock[3].StatValue;
+            rootAgents              = stats.StatsBlock[4].StatValue;
+            childAgents             = stats.StatsBlock[5].StatValue;
+            totalPrims              = stats.StatsBlock[6].StatValue;
+            activePrims             = stats.StatsBlock[7].StatValue;
+            totalFrameTime          = stats.StatsBlock[8].StatValue;
+            netFrameTime            = stats.StatsBlock[9].StatValue;
+            physicsFrameTime        = stats.StatsBlock[10].StatValue;
+            otherFrameTime          = stats.StatsBlock[11].StatValue;
+            imageFrameTime          = stats.StatsBlock[12].StatValue;
+            inPacketsPerSecond      = stats.StatsBlock[13].StatValue;
+            outPacketsPerSecond     = stats.StatsBlock[14].StatValue;
+            unackedBytes            = stats.StatsBlock[15].StatValue;
+            agentFrameTime          = stats.StatsBlock[16].StatValue;
+            pendingDownloads        = stats.StatsBlock[17].StatValue;
+            pendingUploads          = stats.StatsBlock[18].StatValue;
+            activeScripts           = stats.StatsBlock[19].StatValue;
+            scriptLinesPerSecond    = stats.StatsBlock[20].StatValue;
         }
 
         /// <summary>