aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Monitoring/MemoryWatchdog.cs
blob: bc5ed973e7431c881b6c5bc1bc68a148a1795e6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * 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 System.Threading;
using log4net;

namespace OpenSim.Framework.Monitoring
{
    /// <summary>
    /// Experimental watchdog for memory usage.
    /// </summary>
    public static class MemoryWatchdog
    {
//        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        /// <summary>
        /// Is this watchdog active?
        /// </summary>
        public static bool Enabled
        {
            get { return m_enabled; }
            set
            {
//                m_log.DebugFormat("[MEMORY WATCHDOG]: Setting MemoryWatchdog.Enabled to {0}", value);

                if (value && !m_enabled)
                    UpdateLastRecord(GC.GetTotalMemory(false), Util.EnvironmentTickCount());

                m_enabled = value;
            }
        }
        private static bool m_enabled;

        /// <summary>
        /// Last memory churn in bytes per millisecond.
        /// </summary>
        public static double AverageMemoryChurn
        {
            get { if (m_samples.Count > 0) return m_samples.Average(); else return 0; }
        }

        /// <summary>
        /// Average memory churn in bytes per millisecond.
        /// </summary>
        public static double LastMemoryChurn
        {
            get { if (m_samples.Count > 0) return m_samples.First(); else return 0; }
        }

        /// <summary>
        /// Maximum number of statistical samples.
        /// </summary>
        /// <remarks>
        /// At the moment this corresponds to 1 minute since the sampling rate is every 2.5 seconds as triggered from
        /// the main Watchdog.
        /// </remarks>
        private static int m_maxSamples = 24;

        /// <summary>
        /// Time when the watchdog was last updated.
        /// </summary>
        private static int m_lastUpdateTick;

        /// <summary>
        /// Memory used at time of last watchdog update.
        /// </summary>
        private static long m_lastUpdateMemory;

        /// <summary>
        /// Memory churn rate per millisecond.
        /// </summary>
//        private static double m_churnRatePerMillisecond;

        /// <summary>
        /// Historical samples for calculating moving average.
        /// </summary>
        private static Queue<double> m_samples = new Queue<double>(m_maxSamples);

        public static void Update()
        {
            int now = Util.EnvironmentTickCount();
            long memoryNow = GC.GetTotalMemory(false);
            long memoryDiff = memoryNow - m_lastUpdateMemory;

            if (memoryDiff >= 0)
            {
                if (m_samples.Count >= m_maxSamples)
                    m_samples.Dequeue();

                double elapsed = Util.EnvironmentTickCountSubtract(now, m_lastUpdateTick);

                // This should never happen since it's not useful for updates to occur with no time elapsed, but
                // protect ourselves from a divide-by-zero just in case.
                if (elapsed == 0)
                    return;

                m_samples.Enqueue(memoryDiff / (double)elapsed);
            }

            UpdateLastRecord(memoryNow, now);
        }

        private static void UpdateLastRecord(long memoryNow, int timeNow)
        {
            m_lastUpdateMemory = memoryNow;
            m_lastUpdateTick = timeNow;
        }
    }
}