6 files changed, 288 insertions, 253 deletions

diff --git a/OpenSim/Framework/Console/ConsoleUtil.cs b/OpenSim/Framework/Console/ConsoleUtil.cs
new file mode 100644
index 0000000..2612a50
--- /dev/null
+++ b/OpenSim/Framework/Console/ConsoleUtil.cs
@@ -0,0 +1,114 @@
+/*
+ * 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.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using log4net;
+using OpenMetaverse;
+
+public class ConsoleUtil
+{
+    private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+    public const string MinRawConsoleVectorValue = "-~";
+    public const string MaxRawConsoleVectorValue = "~";
+
+    public const string VectorSeparator = ",";
+    public static char[] VectorSeparatorChars = VectorSeparator.ToCharArray();
+
+    /// <summary>
+    /// Convert a minimum vector input from the console to an OpenMetaverse.Vector3
+    /// </summary>
+    /// <param name='rawConsoleVector'>/param>
+    /// <param name='vector'></param>
+    /// <returns></returns>
+    public static bool TryParseConsoleMinVector(string rawConsoleVector, out Vector3 vector)
+    {
+        return TryParseConsoleVector(rawConsoleVector, c => float.MinValue.ToString(), out vector);
+    }
+
+    /// <summary>
+    /// Convert a maximum vector input from the console to an OpenMetaverse.Vector3
+    /// </summary>
+    /// <param name='rawConsoleVector'>/param>
+    /// <param name='vector'></param>
+    /// <returns></returns>
+    public static bool TryParseConsoleMaxVector(string rawConsoleVector, out Vector3 vector)
+    {
+        return TryParseConsoleVector(rawConsoleVector, c => float.MaxValue.ToString(), out vector);
+    }
+
+    /// <summary>
+    /// Convert a vector input from the console to an OpenMetaverse.Vector3
+    /// </summary>
+    /// <param name='rawConsoleVector'>
+    /// A string in the form <x>,<y>,<z> where there is no space between values.
+    /// Any component can be missing (e.g. ,,40).  blankComponentFunc is invoked to replace the blank with a suitable value
+    /// Also, if the blank component is at the end, then the comma can be missed off entirely (e.g. 40,30 or 40)
+    /// The strings "~" and "-~" are valid in components.  The first substitutes float.MaxValue whilst the second is float.MinValue
+    /// Other than that, component values must be numeric.
+    /// </param>
+    /// <param name='blankComponentFunc'></param>
+    /// <param name='vector'></param>
+    /// <returns></returns>
+    public static bool TryParseConsoleVector(
+        string rawConsoleVector, Func<string, string> blankComponentFunc, out Vector3 vector)
+    {
+        List<string> components = rawConsoleVector.Split(VectorSeparatorChars).ToList();
+
+        if (components.Count < 1 || components.Count > 3)
+        {
+            vector = Vector3.Zero;
+            return false;
+        }
+
+        for (int i = components.Count; i < 3; i++)
+            components.Add("");
+
+        List<string> semiDigestedComponents
+            = components.ConvertAll<string>(
+                c =>
+                {
+                    if (c == "")
+                        return blankComponentFunc.Invoke(c);
+                    else if (c == MaxRawConsoleVectorValue)
+                        return float.MaxValue.ToString();
+                    else if (c == MinRawConsoleVectorValue)
+                        return float.MinValue.ToString();
+                    else
+                        return c;
+                });
+
+        string semiDigestedConsoleVector = string.Join(VectorSeparator, semiDigestedComponents.ToArray());
+
+        m_log.DebugFormat("[CONSOLE UTIL]: Parsing {0} into OpenMetaverse.Vector3", semiDigestedConsoleVector);
+
+        return Vector3.TryParse(semiDigestedConsoleVector, out vector);
+    }
+}
\ No newline at end of file
diff --git a/OpenSim/Framework/GridInstantMessage.cs b/OpenSim/Framework/GridInstantMessage.cs
index a6bf6e3..6ae0488 100644
--- a/OpenSim/Framework/GridInstantMessage.cs
+++ b/OpenSim/Framework/GridInstantMessage.cs
@@ -44,7 +44,6 @@ namespace OpenSim.Framework
         public Vector3 Position;
         public byte[] binaryBucket;
 
-
         public uint ParentEstateID;
         public Guid RegionID;
         public uint timestamp;
@@ -58,7 +57,7 @@ namespace OpenSim.Framework
                 string _fromAgentName, UUID _toAgentID,
                 byte _dialog, bool _fromGroup, string _message,
                 UUID _imSessionID, bool _offline, Vector3 _position,
-                byte[] _binaryBucket)
+                byte[] _binaryBucket, bool addTimestamp)
         {
             fromAgentID = _fromAgentID.Guid;
             fromAgentName = _fromAgentName;
@@ -79,7 +78,9 @@ namespace OpenSim.Framework
                 ParentEstateID = scene.RegionInfo.EstateSettings.ParentEstateID;
                 RegionID = scene.RegionInfo.RegionSettings.RegionUUID.Guid;
             }
-            timestamp = (uint)Util.UnixTimeSinceEpoch();
+
+            if (addTimestamp)
+                timestamp = (uint)Util.UnixTimeSinceEpoch();
         }
 
         public GridInstantMessage(IScene scene, UUID _fromAgentID,
@@ -87,7 +88,7 @@ namespace OpenSim.Framework
                 string _message, bool _offline,
                 Vector3 _position) : this(scene, _fromAgentID, _fromAgentName,
                 _toAgentID, _dialog, false, _message,
-                _fromAgentID ^ _toAgentID, _offline, _position, new byte[0])
+                _fromAgentID ^ _toAgentID, _offline, _position, new byte[0], true)
         {
         }
     }
diff --git a/OpenSim/Framework/Monitoring/SimExtraStatsCollector.cs b/OpenSim/Framework/Monitoring/SimExtraStatsCollector.cs
index cdd7cc7..8ac9090 100644
--- a/OpenSim/Framework/Monitoring/SimExtraStatsCollector.cs
+++ b/OpenSim/Framework/Monitoring/SimExtraStatsCollector.cs
@@ -355,10 +355,19 @@ Asset service request failures: {3}" + Environment.NewLine,
             sb.Append(Environment.NewLine);
             sb.Append(
                 string.Format(
-                    "{0,6:0}  {1,6:0}  {2,6:0}  {3,6:0}  {4,6:0}  {5,6:0.0}  {6,6:0.0}  {7,6:0.0}  {8,6:0.0}  {9,6:0.0}  {10,6:0.0}",
+                    "{0,6:0}  {1,6:0}  {2,6:0}  {3,6:0}  {4,6:0}  {5,6:0.0}  {6,6:0.0}  {7,6:0.0}  {8,6:0.0}  {9,6:0.0}  {10,6:0.0}\n\n",
                     inPacketsPerSecond, outPacketsPerSecond, pendingDownloads, pendingUploads, unackedBytes, totalFrameTime,
                     netFrameTime, physicsFrameTime, otherFrameTime, agentFrameTime, imageFrameTime));
-            sb.Append(Environment.NewLine);
+
+            foreach (KeyValuePair<string, Stat> kvp in StatsManager.RegisteredStats)
+            {
+                Stat stat = kvp.Value;
+
+                if (stat.Category == "scene" && stat.Verbosity == StatVerbosity.Info)
+                {
+                    sb.AppendFormat("Slow frames ({0}): {1}\n", stat.Container, stat.Value);
+                }
+            }
 
             /*
             sb.Append(Environment.NewLine);
diff --git a/OpenSim/Framework/Monitoring/StatsManager.cs b/OpenSim/Framework/Monitoring/StatsManager.cs
index d78fa6a..b5dc24f 100644
--- a/OpenSim/Framework/Monitoring/StatsManager.cs
+++ b/OpenSim/Framework/Monitoring/StatsManager.cs
@@ -25,6 +25,9 @@
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+using System;
+using System.Collections.Generic;
+
 namespace OpenSim.Framework.Monitoring
 {
     /// <summary>
@@ -32,6 +35,14 @@ namespace OpenSim.Framework.Monitoring
     /// </summary>
     public class StatsManager
     {
+        /// <summary>
+        /// Registered stats.
+        /// </summary>
+        /// <remarks>
+        /// Do not add or remove from this dictionary.
+        /// </remarks>
+        public static Dictionary<string, Stat> RegisteredStats = new Dictionary<string, Stat>();
+
         private static AssetStatsCollector assetStats;
         private static UserStatsCollector userStats;
         private static SimExtraStatsCollector simExtraStats = new SimExtraStatsCollector();
@@ -61,5 +72,139 @@ namespace OpenSim.Framework.Monitoring
 
             return userStats;
         }
+
+        public static bool RegisterStat(Stat stat)
+        {
+            lock (RegisteredStats)
+            {
+                if (RegisteredStats.ContainsKey(stat.UniqueName))
+                {
+                    // XXX: For now just return false.  This is to avoid problems in regression tests where all tests
+                    // in a class are run in the same instance of the VM.
+                    return false;
+
+//                    throw new Exception(
+//                        "StatsManager already contains stat with ShortName {0} in Category {1}", stat.ShortName, stat.Category);
+                }
+
+                // We take a replace-on-write approach here so that we don't need to generate a new Dictionary
+                Dictionary<string, Stat> newRegisteredStats = new Dictionary<string, Stat>(RegisteredStats);
+                newRegisteredStats[stat.UniqueName] = stat;
+                RegisteredStats = newRegisteredStats;
+            }
+
+            return true;
+        }
+
+        public static bool DeregisterStat(Stat stat)
+        {
+            lock (RegisteredStats)
+            {
+                if (!RegisteredStats.ContainsKey(stat.UniqueName))
+                    return false;
+
+                Dictionary<string, Stat> newRegisteredStats = new Dictionary<string, Stat>(RegisteredStats);
+                newRegisteredStats.Remove(stat.UniqueName);
+                RegisteredStats = newRegisteredStats;
+
+                return true;
+            }
+        }
+    }
+
+    /// <summary>
+    /// Verbosity of stat.
+    /// </summary>
+    /// <remarks>
+    /// Info will always be displayed.
+    /// </remarks>
+    public enum StatVerbosity
+    {
+        Debug,
+        Info
+    }
+
+    /// <summary>
+    /// Holds individual static details
+    /// </summary>
+    public class Stat
+    {
+        /// <summary>
+        /// Unique stat name used for indexing.  Each ShortName in a Category must be unique.
+        /// </summary>
+        public string UniqueName { get; private set; }
+
+        /// <summary>
+        /// Category of this stat (e.g. cache, scene, etc).
+        /// </summary>
+        public string Category { get; private set; }
+
+        /// <summary>
+        /// Containing name for this stat.
+        /// FIXME: In the case of a scene, this is currently the scene name (though this leaves
+        /// us with a to-be-resolved problem of non-unique region names).
+        /// </summary>
+        /// <value>
+        /// The container.
+        /// </value>
+        public string Container { get; private set; }
+
+        public StatVerbosity Verbosity { get; private set; }
+        public string ShortName { get; private set; }
+        public string Name { get; private set; }
+        public string Description { get; private set; }
+        public virtual string UnitName { get; private set; }
+
+        public virtual double Value { get; set; }
+
+        public Stat(
+            string shortName, string name, string unitName, string category, string container, StatVerbosity verbosity, string description)
+        {
+            ShortName = shortName;
+            Name = name;
+            UnitName = unitName;
+            Category = category;
+            Container = container;
+            Verbosity = verbosity;
+            Description = description;
+
+            UniqueName = GenUniqueName(Container, Category, ShortName);
+        }
+
+        public static string GenUniqueName(string container, string category, string shortName)
+        {
+            return string.Format("{0}+{1}+{2}", container, category, shortName);
+        }
+    }
+
+    public class PercentageStat : Stat
+    {
+        public int Antecedent { get; set; }
+        public int Consequent { get; set; }
+
+        public override double Value
+        {
+            get
+            {
+                int c = Consequent;
+
+                // Avoid any chance of a multi-threaded divide-by-zero
+                if (c == 0)
+                    return 0;
+
+                return (double)Antecedent / c;
+            }
+
+            set
+            {
+                throw new Exception("Cannot set value on a PercentageStat");
+            }
+        }
+
+        public PercentageStat(
+            string shortName, string name, string category, string container, StatVerbosity verbosity, string description)
+            : base(shortName, name, " %", category, container, verbosity, description)
+        {
+        }
     }
 }
\ No newline at end of file
diff --git a/OpenSim/Framework/PacketPool.cs b/OpenSim/Framework/PacketPool.cs
deleted file mode 100644
index 41d17c5..0000000
--- a/OpenSim/Framework/PacketPool.cs
+++ /dev/null
@@ -1,247 +0,0 @@
-/*
- * 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.Collections.Generic;
-using System.Reflection;
-using OpenMetaverse;
-using OpenMetaverse.Packets;
-using log4net;
-
-namespace OpenSim.Framework
-{
-
-    public sealed class PacketPool
-    {
-        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
-
-        private static readonly PacketPool instance = new PacketPool();
-
-        private bool packetPoolEnabled = true;
-        private bool dataBlockPoolEnabled = true;
-
-        private readonly Dictionary<PacketType, Stack<Packet>> pool = new Dictionary<PacketType, Stack<Packet>>();
-
-        private static Dictionary<Type, Stack<Object>> DataBlocks =
-                new Dictionary<Type, Stack<Object>>();
-
-        static PacketPool()
-        {
-        }
-
-        public static PacketPool Instance
-        {
-            get { return instance; }
-        }
-
-        public bool RecyclePackets
-        {
-            set { packetPoolEnabled = value; }
-            get { return packetPoolEnabled; }
-        }
-
-        public bool RecycleDataBlocks
-        {
-            set { dataBlockPoolEnabled = value; }
-            get { return dataBlockPoolEnabled; }
-        }
-
-        public Packet GetPacket(PacketType type)
-        {
-            Packet packet;
-
-            if (!packetPoolEnabled)
-                return Packet.BuildPacket(type);
-
-            lock (pool)
-            {
-                if (!pool.ContainsKey(type) || pool[type] == null || (pool[type]).Count == 0)
-                {
-                    // Creating a new packet if we cannot reuse an old package
-                    packet = Packet.BuildPacket(type);
-                }
-                else
-                {
-                    // Recycle old packages
-                    packet = (pool[type]).Pop();
-                }
-            }
-
-            return packet;
-        }
-
-        // private byte[] decoded_header = new byte[10];
-        private static PacketType GetType(byte[] bytes)
-        {
-            byte[] decoded_header = new byte[10 + 8];
-            ushort id;
-            PacketFrequency freq;
-
-            if ((bytes[0] & Helpers.MSG_ZEROCODED) != 0)
-            {
-                Helpers.ZeroDecode(bytes, 16, decoded_header);
-            }
-            else
-            {
-                Buffer.BlockCopy(bytes, 0, decoded_header, 0, 10);
-            }
-
-            if (decoded_header[6] == 0xFF)
-            {
-                if (decoded_header[7] == 0xFF)
-                {
-                    id = (ushort) ((decoded_header[8] << 8) + decoded_header[9]);
-                    freq = PacketFrequency.Low;
-                }
-                else
-                {
-                    id = decoded_header[7];
-                    freq = PacketFrequency.Medium;
-                }
-            }
-            else
-            {
-                id = decoded_header[6];
-                freq = PacketFrequency.High;
-            }
-
-            return Packet.GetType(id, freq);
-        }
-
-        public Packet GetPacket(byte[] bytes, ref int packetEnd, byte[] zeroBuffer)
-        {
-            PacketType type = GetType(bytes);
-
-            Array.Clear(zeroBuffer, 0, zeroBuffer.Length);
-
-            int i = 0;
-            Packet packet = GetPacket(type);
-            if (packet == null)
-                m_log.WarnFormat("[PACKETPOOL]: Failed to get packet of type {0}", type);
-            else
-                packet.FromBytes(bytes, ref i, ref packetEnd, zeroBuffer);
-
-            return packet;
-        }
-
-        /// <summary>
-        /// Return a packet to the packet pool
-        /// </summary>
-        /// <param name="packet"></param>
-        public void ReturnPacket(Packet packet)
-        {
-            if (dataBlockPoolEnabled)
-            {
-                switch (packet.Type)
-                {
-                    case PacketType.ObjectUpdate:
-                        ObjectUpdatePacket oup = (ObjectUpdatePacket)packet;
-
-                        foreach (ObjectUpdatePacket.ObjectDataBlock oupod in oup.ObjectData)
-                            ReturnDataBlock<ObjectUpdatePacket.ObjectDataBlock>(oupod);
-
-                        oup.ObjectData = null;
-                        break;
-
-                    case PacketType.ImprovedTerseObjectUpdate:
-                        ImprovedTerseObjectUpdatePacket itoup = (ImprovedTerseObjectUpdatePacket)packet;
-
-                        foreach (ImprovedTerseObjectUpdatePacket.ObjectDataBlock itoupod in itoup.ObjectData)
-                            ReturnDataBlock<ImprovedTerseObjectUpdatePacket.ObjectDataBlock>(itoupod);
-
-                        itoup.ObjectData = null;
-                        break;
-                }
-            }
-
-            if (packetPoolEnabled)
-            {
-                switch (packet.Type)
-                {
-                    // List pooling packets here
-                    case PacketType.PacketAck:
-                    case PacketType.ObjectUpdate:
-                    case PacketType.ImprovedTerseObjectUpdate:
-                        lock (pool)
-                        {
-                            PacketType type = packet.Type;
-
-                            if (!pool.ContainsKey(type))
-                            {
-                                pool[type] = new Stack<Packet>();
-                            }
-
-                            if ((pool[type]).Count < 50)
-                            {
-                                (pool[type]).Push(packet);
-                            }
-                        }
-                        break;
-                    
-                    // Other packets wont pool
-                    default:
-                        return;
-                }
-            }
-        }
-
-        public static T GetDataBlock<T>() where T: new()
-        {
-            lock (DataBlocks)
-            {
-                Stack<Object> s;
-
-                if (DataBlocks.TryGetValue(typeof(T), out s))
-                {
-                    if (s.Count > 0)
-                        return (T)s.Pop();
-                }
-                else
-                {
-                    DataBlocks[typeof(T)] = new Stack<Object>();
-                }
-                
-                return new T();
-            }
-        }
-
-        public static void ReturnDataBlock<T>(T block) where T: new()
-        {
-            if (block == null)
-                return;
-
-            lock (DataBlocks)
-            {
-                if (!DataBlocks.ContainsKey(typeof(T)))
-                    DataBlocks[typeof(T)] = new Stack<Object>();
-
-                if (DataBlocks[typeof(T)].Count < 50)
-                    DataBlocks[typeof(T)].Push(block);
-            }
-        }
-    }
-}
diff --git a/OpenSim/Framework/Util.cs b/OpenSim/Framework/Util.cs
index 1b9777f..5c7797a 100644
--- a/OpenSim/Framework/Util.cs
+++ b/OpenSim/Framework/Util.cs
@@ -534,6 +534,19 @@ namespace OpenSim.Framework
         }
 
         /// <summary>
+        /// Determines whether a point is inside a bounding box.
+        /// </summary>
+        /// <param name='v'>/param>
+        /// <param name='min'></param>
+        /// <param name='max'></param>
+        /// <returns></returns>
+        public static bool IsInsideBox(Vector3 v, Vector3 min, Vector3 max)
+        {
+            return v.X >= min.X & v.Y >= min.Y && v.Z >= min.Z
+                && v.X <= max.X && v.Y <= max.Y && v.Z <= max.Z;
+        }
+
+        /// <summary>
         /// Are the co-ordinates of the new region visible from the old region?
         /// </summary>
         /// <param name="oldx">Old region x-coord</param>