Fix setting of max scene throttle so that setting it restricts the child client throttles properly.

In "show throttles", also renames 'total' column to 'actual' to reflect that it is not necessarily the throttles requested for/by the client.
Also fills out 'target' in non-adapative mode to the actual throttle requested for/by the client.

4 files changed, 78 insertions, 51 deletions

diff --git a/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServer.cs b/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServer.cs
index 415a22e..aa10301 100644
--- a/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServer.cs
+++ b/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServer.cs
@@ -447,7 +447,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 //                = new TokenBucket(
 //                    string.Format("server throttle bucket for {0}", Scene.Name), null, sceneThrottleBps);
 
-            Throttle = new TokenBucket("server throttle bucket", null, sceneThrottleBps, sceneThrottleBps);
+            Throttle = new TokenBucket("server throttle bucket", null, 0, sceneThrottleBps);
 
             ThrottleRates = new ThrottleRates(configSource);
 
diff --git a/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServerCommands.cs b/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServerCommands.cs
index 60b93ac..e0398d5 100644
--- a/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServerCommands.cs
+++ b/OpenSim/Region/ClientStack/Linden/UDP/LLUDPServerCommands.cs
@@ -512,7 +512,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 if (!ConsoleUtil.TryParseConsoleInt(MainConsole.Instance, rawValue, out newValue))
                     return;
 
-                m_udpServer.Throttle.RequestedDripRate = newValue * 1000 / 8;
+                m_udpServer.Throttle.MaxDripRate = newValue * 1000 / 8;
             }
             else if (param == "max-new-client-throttle")
             {
diff --git a/OpenSim/Region/ClientStack/Linden/UDP/Tests/ThrottleTests.cs b/OpenSim/Region/ClientStack/Linden/UDP/Tests/ThrottleTests.cs
index 0d39c1d..912c994 100644
--- a/OpenSim/Region/ClientStack/Linden/UDP/Tests/ThrottleTests.cs
+++ b/OpenSim/Region/ClientStack/Linden/UDP/Tests/ThrottleTests.cs
@@ -57,51 +57,71 @@ namespace OpenSim.Region.ClientStack.LindenUDP.Tests
         [Test]
         public void TestSetRequestDripRate()
         {
+            TestHelpers.InMethod();
+
             TokenBucket tb = new TokenBucket("tb", null, 5000, 0);
-            AssertRates(tb, 5000, 5000, 5000, 0);
+            AssertRates(tb, 5000, 0, 5000, 0);
 
             tb.RequestedDripRate = 4000;
-            AssertRates(tb, 4000, 4000, 4000, 0);
+            AssertRates(tb, 4000, 0, 4000, 0);
 
             tb.RequestedDripRate = 6000;
-            AssertRates(tb, 6000, 6000, 6000, 0);
+            AssertRates(tb, 6000, 0, 6000, 0);
         }
 
         [Test]
         public void TestSetRequestDripRateWithMax()
         {
+            TestHelpers.InMethod();
+
             TokenBucket tb = new TokenBucket("tb", null, 5000, 10000);
-            AssertRates(tb, 5000, 5000, 5000, 10000);
+            AssertRates(tb, 5000, 0, 5000, 10000);
 
             tb.RequestedDripRate = 4000;
-            AssertRates(tb, 4000, 4000, 4000, 10000);
+            AssertRates(tb, 4000, 0, 4000, 10000);
 
             tb.RequestedDripRate = 6000;
-            AssertRates(tb, 6000, 6000, 6000, 10000);
+            AssertRates(tb, 6000, 0, 6000, 10000);
 
             tb.RequestedDripRate = 12000;
-            AssertRates(tb, 10000, 10000, 10000, 10000);
+            AssertRates(tb, 10000, 0, 10000, 10000);
         }
 
         [Test]
         public void TestSetRequestDripRateWithChildren()
         {
+            TestHelpers.InMethod();
+
             TokenBucket tbParent = new TokenBucket("tbParent", null, 0, 0);
             TokenBucket tbChild1 = new TokenBucket("tbChild1", tbParent, 3000, 0);
             TokenBucket tbChild2 = new TokenBucket("tbChild2", tbParent, 5000, 0);
 
             AssertRates(tbParent, 8000, 8000, 8000, 0);
-            AssertRates(tbChild1, 3000, 3000, 3000, 0);
-            AssertRates(tbChild2, 5000, 5000, 5000, 0);
+            AssertRates(tbChild1, 3000, 0, 3000, 0);
+            AssertRates(tbChild2, 5000, 0, 5000, 0);
+
+            // Test: Setting a parent request greater than total children requests.
+            tbParent.RequestedDripRate = 10000;
+
+            AssertRates(tbParent, 10000, 8000, 8000, 0);
+            AssertRates(tbChild1, 3000, 0, 3000, 0);
+            AssertRates(tbChild2, 5000, 0, 5000, 0);
+
+            // Test: Setting a parent request lower than total children requests.
+            tbParent.RequestedDripRate = 6000;
+
+            AssertRates(tbParent, 6000, 8000, 6000, 0);
+            AssertRates(tbChild1, 3000, 0, 6000 / 8 * 3, 0);
+            AssertRates(tbChild2, 5000, 0, 6000 / 8 * 5, 0);
         }
 
         private void AssertRates(
             TokenBucket tb, double requestedDripRate, double totalDripRequest, double dripRate, double maxDripRate)
         {
-            Assert.AreEqual((int)requestedDripRate, tb.RequestedDripRate);
-            Assert.AreEqual((int)totalDripRequest, tb.TotalDripRequest);
-            Assert.AreEqual((int)dripRate, tb.DripRate);
-            Assert.AreEqual((int)maxDripRate, tb.MaxDripRate);
+            Assert.AreEqual((int)requestedDripRate, tb.RequestedDripRate, "Requested drip rate");
+            Assert.AreEqual((int)totalDripRequest, tb.TotalDripRequest, "Total drip request");
+            Assert.AreEqual((int)dripRate, tb.DripRate, "Drip rate");
+            Assert.AreEqual((int)maxDripRate, tb.MaxDripRate, "Max drip rate");
         }
 
         [Test]
@@ -360,16 +380,16 @@ namespace OpenSim.Region.ClientStack.LindenUDP.Tests
             //                    "Resend={0}, Land={1}, Wind={2}, Cloud={3}, Task={4}, Texture={5}, Asset={6}, TOTAL = {7}", 
             //                    ci.resendThrottle, ci.landThrottle, ci.windThrottle, ci.cloudThrottle, ci.taskThrottle, ci.textureThrottle, ci.assetThrottle, ci.totalThrottle);
 
-            Assert.AreEqual((int)resendBytes, ci.resendThrottle);
-            Assert.AreEqual((int)landBytes, ci.landThrottle);
-            Assert.AreEqual((int)windBytes, ci.windThrottle);
-            Assert.AreEqual((int)cloudBytes, ci.cloudThrottle);
-            Assert.AreEqual((int)taskBytes, ci.taskThrottle);
-            Assert.AreEqual((int)textureBytes, ci.textureThrottle);
-            Assert.AreEqual((int)assetBytes, ci.assetThrottle);
-            Assert.AreEqual((int)totalBytes, ci.totalThrottle);
-            Assert.AreEqual((int)targetBytes, ci.targetThrottle);
-            Assert.AreEqual((int)maxBytes, ci.maxThrottle);
+            Assert.AreEqual((int)resendBytes, ci.resendThrottle, "Resend");
+            Assert.AreEqual((int)landBytes, ci.landThrottle, "Land");
+            Assert.AreEqual((int)windBytes, ci.windThrottle, "Wind");
+            Assert.AreEqual((int)cloudBytes, ci.cloudThrottle, "Cloud");
+            Assert.AreEqual((int)taskBytes, ci.taskThrottle, "Task");
+            Assert.AreEqual((int)textureBytes, ci.textureThrottle, "Texture");
+            Assert.AreEqual((int)assetBytes, ci.assetThrottle, "Asset");
+            Assert.AreEqual((int)totalBytes, ci.totalThrottle, "Total");
+            Assert.AreEqual((int)targetBytes, ci.targetThrottle, "Target");
+            Assert.AreEqual((int)maxBytes, ci.maxThrottle, "Max");
         }
 
         private void SetThrottles(
diff --git a/OpenSim/Region/ClientStack/Linden/UDP/TokenBucket.cs b/OpenSim/Region/ClientStack/Linden/UDP/TokenBucket.cs
index e0633d3..ab8d268 100644
--- a/OpenSim/Region/ClientStack/Linden/UDP/TokenBucket.cs
+++ b/OpenSim/Region/ClientStack/Linden/UDP/TokenBucket.cs
@@ -110,14 +110,19 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         }
                
         /// <summary>
-        /// The speed limit of this bucket in bytes per second. This is the
-        /// number of tokens that are added to the bucket per quantum
+        /// The requested drip rate for this particular bucket.
         /// </summary>
         /// <remarks>
-        /// RequestedDripRate can never be above MaxDripRate.
-        /// Tokens are added to the bucket any time 
+        /// 0 then TotalDripRequest is used instead.
+        /// Can never be above MaxDripRate.
+        /// Tokens are added to the bucket at any time 
         /// <seealso cref="RemoveTokens"/> is called, at the granularity of
-        /// the system tick interval (typically around 15-22ms)</remarks>
+        /// the system tick interval (typically around 15-22ms)
+        /// FIXME: It is extremely confusing to be able to set a RequestedDripRate of 0 and then receive a positive
+        /// number on get if TotalDripRequest is sent.  This also stops us being able to retrieve the fact that
+        /// RequestedDripRate is set to 0.  Really, this should always return m_dripRate and then we can get
+        /// (m_dripRate == 0 ? TotalDripRequest : m_dripRate) on some other properties.
+        /// </remarks>
         protected Int64 m_dripRate;
         public virtual Int64 RequestedDripRate
         {
@@ -131,7 +136,6 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 else
                     m_dripRate = value;
 
-                TotalDripRequest = m_dripRate;
                 m_burstRate = (Int64)((double)m_dripRate * m_quantumsPerBurst);
 
                 if (Parent != null)
@@ -142,15 +146,31 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         /// <summary>
         /// Gets the drip rate.
         /// </summary>
-        /// <value>DripRate can never be above max.</value>
+        /// <value>
+        /// DripRate can never be above max drip rate or below min drip rate.
+        /// If we are a child bucket then the drip rate return is modifed by the total load on the capacity of the
+        /// parent bucket.
+        /// </value>
         public virtual Int64 DripRate
         {
             get 
             {
+                double rate;
+
+                // FIXME: This doesn't properly work if we have a parent and children and a requested drip rate set
+                // on ourselves which is not equal to the child drip rates.
                 if (Parent == null)
-                    return Math.Min(RequestedDripRate, TotalDripRequest);
-                
-                double rate = (double)RequestedDripRate * Parent.DripRateModifier();
+                {
+                    if (TotalDripRequest > 0)
+                        rate = Math.Min(RequestedDripRate, TotalDripRequest);
+                    else
+                        rate = RequestedDripRate;
+                }   
+                else
+                {
+                    rate = (double)RequestedDripRate * Parent.DripRateModifier();
+                }
+
                 if (rate < m_minimumDripRate)
                     rate = m_minimumDripRate;
                 else if (MaxDripRate > 0 && rate > MaxDripRate)
@@ -163,18 +183,10 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         // <summary>
         // The maximum rate for flow control. Drip rate can never be greater than this.
         // </summary>
-//        protected Int64 m_maxDripRate;
-//        public Int64 MaxDripRate
-//        {
-//            get { return m_maxDripRate; }
-//            //get { return (m_maxDripRate == 0 ? TotalDripRequest : m_maxDripRate); }
-//            set { m_maxDripRate = (value == 0 ? 0 : Math.Max(value, m_minimumFlow)); }
-//        }
         public Int64 MaxDripRate { get; set; }
 
         /// <summary>
-        /// The current total of the requested maximum burst rates of 
-        /// this bucket's children buckets.
+        /// The current total of the requested maximum burst rates of children buckets.
         /// </summary>
         public Int64 TotalDripRequest { get; protected set; }
         
@@ -197,8 +209,6 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             Parent = parent;
             RequestedDripRate = dripRate;
             MaxDripRate = maxDripRate;
-            // TotalDripRequest = dripRate; // this will be overwritten when a child node registers
-            // MaxBurst = (Int64)((double)dripRate * m_quantumsPerBurst);
             m_lastDrip = Util.EnvironmentTickCount();
         }
 
@@ -243,7 +253,6 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             lock (m_children)
             {
                 m_children[child] = request;
-                // TotalDripRequest = m_children.Values.Sum();
 
                 TotalDripRequest = 0;
                 foreach (KeyValuePair<TokenBucket, Int64> cref in m_children)
@@ -255,12 +264,11 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             {
                 Int64 effectiveDripRate;
 
-                if (MaxDripRate > 0)
-                    effectiveDripRate = Math.Min(MaxDripRate, TotalDripRequest);
+                if (RequestedDripRate > 0)
+                    effectiveDripRate = Math.Min(RequestedDripRate, TotalDripRequest);
                 else
                     effectiveDripRate = TotalDripRequest;
 
-                //Parent.RegisterRequest(this, Math.Min(RequestedDripRate, TotalDripRequest));
                 Parent.RegisterRequest(this, effectiveDripRate);
             }
         }
@@ -274,7 +282,6 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             lock (m_children)
             {
                 m_children.Remove(child);
-                // m_totalDripRequest = m_children.Values.Sum();
 
                 TotalDripRequest = 0;
                 foreach (KeyValuePair<TokenBucket, Int64> cref in m_children)