summaryrefslogtreecommitdiff
path: root/indra/llcommon/lltrace.h
blob: c6940c12a2b60f79b7965bf2a21a139d9abe155f (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/** 
 * @file lltrace.h
 * @brief Runtime statistics accumulation.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2012, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLTRACE_H
#define LL_LLTRACE_H

#include "stdtypes.h"
#include "llpreprocessor.h"

#include <vector>
#include <boost/type_traits/alignment_of.hpp>

namespace LLTrace
{
	//TODO figure out best way to do this and proper naming convention
	
	static 
	void init()
	{

	}

	template<typename T>
	class Accumulator
	{
	public:
		Accumulator()
		:	mSum(),
			mMin(),
			mMax(),
			mNumSamples(0)
		{}

		void sample(T value)
		{
			mNumSamples++;
			mSum += value;
			if (value < mMin)
			{
				mMin = value;
			}
			else if (value > mMax)
			{
				mMax = value;
			}
		}

	private:
		T	mSum,
			mMin,
			mMax;

		U32	mNumSamples;
	};

	class TraceStorage
	{
	protected:
		TraceStorage(const size_t size, const size_t alignment)
		{
			mRecordOffset = sNextOffset + (alignment - 1);
			mRecordOffset -= mRecordOffset % alignment;
			sNextOffset = mRecordOffset + size;
			sStorage.reserve((size_t)sNextOffset);
		}

		// this needs to be thread local
		static std::vector<U8>	sStorage;
		static ptrdiff_t		sNextOffset;

		ptrdiff_t				mRecordOffset;
	};

	std::vector<U8> TraceStorage::sStorage;
	ptrdiff_t TraceStorage::sNextOffset = 0;

	template<typename T>
	class Trace : public TraceStorage
	{
	public:
		Trace(const std::string& name)
		:	TraceStorage(sizeof(Accumulator<T>), boost::alignment_of<Accumulator<T> >::value),
			mName(name)
		{}

		void record(T value)
		{
			(reinterpret_cast<Accumulator<T>* >(sStorage + mRecordOffset))->sample(value);
		}

	private:
		std::string		mName;
	};

	template<typename T>
	class Stat : public Trace<T>
	{
	public:
		Stat(const char* name)
		:	Trace(name)
		{}
	};

	class BlockTimer : public Trace<U32>
	{
	public:
		BlockTimer(const char* name)
		:	Trace(name)
		{}

		struct Accumulator
		{
			U32 						mTotalTimeCounter,
										mChildTimeCounter,
										mCalls;
			Accumulator*				mParent;		// info for caller timer
			Accumulator*				mLastCaller;	// used to bootstrap tree construction
			const BlockTimer*			mTimer;			// points to block timer associated with this storage
			U8							mActiveCount;	// number of timers with this ID active on stack
			bool						mMoveUpTree;	// needs to be moved up the tree of timers at the end of frame
			std::vector<Accumulator*>	mChildren;		// currently assumed child timers
		};

		struct RecorderStackEntry
		{
			struct Recorder*	mRecorder;
			Accumulator*		mAccumulator;
			U32					mChildTime;
		};

		struct Recorder
		{
			LL_FORCE_INLINE Recorder(BlockTimer& block_timer)
			:	mLastRecorder(sCurRecorder)
			{
				mStartTime = getCPUClockCount32();
				Accumulator* accumulator = ???; // get per-thread accumulator
				accumulator->mActiveCount++;
				accumulator->mCalls++;
				accumulator->mMoveUpTree |= (accumulator->mParent->mActiveCount == 0);

				// push new timer on stack
				sCurRecorder.mRecorder = this;
				sCurRecorder.mAccumulator = accumulator;
				sCurRecorder.mChildTime = 0;
			}

			LL_FORCE_INLINE ~Recorder()
			{
				U32 total_time = getCPUClockCount32() - mStartTime;

				Accumulator* accumulator = sCurRecorder.mAccumulator;
				accumulator->mTotalTimeCounter += total_time;
				accumulator->mChildTimeCounter += sCurRecorder.mChildTime;
				accumulator->mActiveCount--;

				accumulator->mLastCaller = mLastRecorder.mAccumulator;
				mLastRecorder.mChildTime += total_time;

				// pop stack
				sCurRecorder = mLastRecorder;
			}

			RecorderStackEntry mLastRecorder;
			U32 mStartTime;
		};

	private:
		static U32 getCPUClockCount32()
		{
			U32 ret_val;
			__asm
			{
				_emit   0x0f
					_emit   0x31
					shr eax,8
					shl edx,24
					or eax, edx
					mov dword ptr [ret_val], eax
			}
			return ret_val;
		}

		// return full timer value, *not* shifted by 8 bits
		static U64 getCPUClockCount64()
		{
			U64 ret_val;
			__asm
			{
				_emit   0x0f
					_emit   0x31
					mov eax,eax
					mov edx,edx
					mov dword ptr [ret_val+4], edx
					mov dword ptr [ret_val], eax
			}
			return ret_val;
		}

		static RecorderStackEntry sCurRecorder;
	};

	BlockTimer::RecorderStackEntry BlockTimer::sCurRecorder;

	class TimeInterval 
	{
	public:
		void start() {}
		void stop() {}
		void resume() {}
	};

	class SamplingTimeInterval
	{
	public:
		void start() {}
		void stop() {}
		void resume() {}
	};

}

#define TOKEN_PASTE_ACTUAL(x, y) x##y
#define TOKEN_PASTE(x, y) TOKEN_PASTE_ACTUAL(x, y)
#define RECORD_BLOCK_TIME(block_timer) LLTrace::BlockTimer::Recorder TOKEN_PASTE(block_time_recorder, __COUNTER__)(block_timer);

#endif // LL_LLTRACE_H