summaryrefslogtreecommitdiff
path: root/indra/llcommon/lltraceaccumulators.h
blob: 9ea787188c4f55c7d91a16d3076f4bb7896c1dbf (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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
/** 
 * @file lltraceaccumulators.h
 * @brief Storage for accumulating statistics
 *
 * $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_LLTRACEACCUMULATORS_H
#define LL_LLTRACEACCUMULATORS_H


#include "stdtypes.h"
#include "llpreprocessor.h"
#include "llunit.h"
#include "lltimer.h"
#include "llrefcount.h"
#include "llthreadlocalstorage.h"
#include <limits>

namespace LLTrace
{
	template<typename ACCUMULATOR>
	class AccumulatorBuffer : public LLRefCount
	{
		typedef AccumulatorBuffer<ACCUMULATOR> self_t;
		static const U32 DEFAULT_ACCUMULATOR_BUFFER_SIZE = 64;
	private:
		struct StaticAllocationMarker { };

		AccumulatorBuffer(StaticAllocationMarker m)
		:	mStorageSize(0),
			mStorage(NULL)
		{}

	public:

		AccumulatorBuffer(const AccumulatorBuffer& other = *getDefaultBuffer())
		:	mStorageSize(0),
			mStorage(NULL)
		{
			resize(other.mStorageSize);
			for (S32 i = 0; i < sNextStorageSlot; i++)
			{
				mStorage[i] = other.mStorage[i];
			}
		}

		~AccumulatorBuffer()
		{
			if (isPrimary())
			{
				LLThreadLocalSingletonPointer<ACCUMULATOR>::setInstance(NULL);
			}
			delete[] mStorage;
		}

		LL_FORCE_INLINE ACCUMULATOR& operator[](size_t index) 
		{ 
			return mStorage[index]; 
		}

		LL_FORCE_INLINE const ACCUMULATOR& operator[](size_t index) const
		{ 
			return mStorage[index]; 
		}

		void addSamples(const AccumulatorBuffer<ACCUMULATOR>& other, bool append = true)
		{
			llassert(mStorageSize >= sNextStorageSlot && other.mStorageSize > sNextStorageSlot);
			for (size_t i = 0; i < sNextStorageSlot; i++)
			{
				mStorage[i].addSamples(other.mStorage[i], append);
			}
		}

		void copyFrom(const AccumulatorBuffer<ACCUMULATOR>& other)
		{
			llassert(mStorageSize >= sNextStorageSlot && other.mStorageSize > sNextStorageSlot);
			for (size_t i = 0; i < sNextStorageSlot; i++)
			{
				mStorage[i] = other.mStorage[i];
			}
		}

		void reset(const AccumulatorBuffer<ACCUMULATOR>* other = NULL)
		{
			llassert(mStorageSize >= sNextStorageSlot);
			for (size_t i = 0; i < sNextStorageSlot; i++)
			{
				mStorage[i].reset(other ? &other->mStorage[i] : NULL);
			}
		}

		void sync(LLUnitImplicit<F64, LLUnits::Seconds> time_stamp)
		{
			llassert(mStorageSize >= sNextStorageSlot);
			for (size_t i = 0; i < sNextStorageSlot; i++)
			{
				mStorage[i].sync(time_stamp);
			}
		}

		void makePrimary()
		{
			LLThreadLocalSingletonPointer<ACCUMULATOR>::setInstance(mStorage);
		}

		bool isPrimary() const
		{
			return LLThreadLocalSingletonPointer<ACCUMULATOR>::getInstance() == mStorage;
		}

		static void clearPrimary()
		{
			LLThreadLocalSingletonPointer<ACCUMULATOR>::setInstance(NULL);
		}

		LL_FORCE_INLINE static ACCUMULATOR* getPrimaryStorage() 
		{ 
			ACCUMULATOR* accumulator = LLThreadLocalSingletonPointer<ACCUMULATOR>::getInstance();
			return accumulator ? accumulator : getDefaultBuffer()->mStorage;
		}

		// NOTE: this is not thread-safe.  We assume that slots are reserved in the main thread before any child threads are spawned
		size_t reserveSlot()
		{
			size_t next_slot = sNextStorageSlot++;
			if (next_slot >= mStorageSize)
			{
				resize(mStorageSize + (mStorageSize >> 2));
			}
			llassert(mStorage && next_slot < mStorageSize);
			return next_slot;
		}

		void resize(size_t new_size)
		{
			if (new_size <= mStorageSize) return;

			ACCUMULATOR* old_storage = mStorage;
			mStorage = new ACCUMULATOR[new_size];
			if (old_storage)
			{
				for (S32 i = 0; i < mStorageSize; i++)
				{
					mStorage[i] = old_storage[i];
				}
			}
			mStorageSize = new_size;
			delete[] old_storage;

			self_t* default_buffer = getDefaultBuffer();
			if (this != default_buffer
				&& new_size > default_buffer->size())
			{
				//NB: this is not thread safe, but we assume that all resizing occurs during static initialization
				default_buffer->resize(new_size);
			}
		}

		size_t size() const
		{
			return getNumIndices();
		}

		static size_t getNumIndices() 
		{
			return sNextStorageSlot;
		}

		static self_t* getDefaultBuffer()
		{
			static bool sInitialized = false;
			if (!sInitialized)
			{
				// this buffer is allowed to leak so that trace calls from global destructors have somewhere to put their data
				// so as not to trigger an access violation
				sDefaultBuffer = new AccumulatorBuffer(StaticAllocationMarker());
				sInitialized = true;
				sDefaultBuffer->resize(DEFAULT_ACCUMULATOR_BUFFER_SIZE);
			}
			return sDefaultBuffer;
		}

	private:
		ACCUMULATOR*	mStorage;
		size_t			mStorageSize;
		static size_t	sNextStorageSlot;
		static self_t*	sDefaultBuffer;
	};

	template<typename ACCUMULATOR> size_t AccumulatorBuffer<ACCUMULATOR>::sNextStorageSlot = 0;
	template<typename ACCUMULATOR> AccumulatorBuffer<ACCUMULATOR>* AccumulatorBuffer<ACCUMULATOR>::sDefaultBuffer = NULL;


	class EventAccumulator
	{
	public:
		typedef F64 value_t;
		typedef F64 mean_t;

		EventAccumulator()
		:	mSum(0),
			mMin((std::numeric_limits<F64>::max)()),
			mMax((std::numeric_limits<F64>::min)()),
			mMean(0),
			mSumOfSquares(0),
			mNumSamples(0),
			mLastValue(0)
		{}

		void record(F64 value)
		{
			mNumSamples++;
			mSum += value;
			// NOTE: both conditions will hold on first pass through
			if (value < mMin)
			{
				mMin = value;
			}
			if (value > mMax)
			{
				mMax = value;
			}
			F64 old_mean = mMean;
			mMean += (value - old_mean) / (F64)mNumSamples;
			mSumOfSquares += (value - old_mean) * (value - mMean);
			mLastValue = value;
		}

		void addSamples(const EventAccumulator& other, bool append)
		{
			if (other.mNumSamples)
			{
				mSum += other.mSum;

				// NOTE: both conditions will hold first time through
				if (other.mMin < mMin) { mMin = other.mMin; }
				if (other.mMax > mMax) { mMax = other.mMax; }

				// combine variance (and hence standard deviation) of 2 different sized sample groups using
				// the following formula: http://www.mrc-bsu.cam.ac.uk/cochrane/handbook/chapter_7/7_7_3_8_combining_groups.htm
				F64 n_1 = (F64)mNumSamples,
					n_2 = (F64)other.mNumSamples;
				F64 m_1 = mMean,
					m_2 = other.mMean;
				F64 v_1 = mSumOfSquares / mNumSamples,
					v_2 = other.mSumOfSquares / other.mNumSamples;
				if (n_1 == 0)
				{
					mSumOfSquares = other.mSumOfSquares;
				}
				else if (n_2 == 0)
				{
					// don't touch variance
					// mSumOfSquares = mSumOfSquares;
				}
				else
				{
					mSumOfSquares = (F64)mNumSamples
						* ((((n_1 - 1.f) * v_1)
						+ ((n_2 - 1.f) * v_2)
						+ (((n_1 * n_2) / (n_1 + n_2))
						* ((m_1 * m_1) + (m_2 * m_2) - (2.f * m_1 * m_2))))
						/ (n_1 + n_2 - 1.f));
				}

				F64 weight = (F64)mNumSamples / (F64)(mNumSamples + other.mNumSamples);
				mNumSamples += other.mNumSamples;
				mMean = mMean * weight + other.mMean * (1.f - weight);
				if (append) mLastValue = other.mLastValue;
			}
		}

		void reset(const EventAccumulator* other)
		{
			mNumSamples = 0;
			mSum = 0;
			mMin = std::numeric_limits<F64>::max();
			mMax = std::numeric_limits<F64>::min();
			mMean = 0;
			mSumOfSquares = 0;
			mLastValue = other ? other->mLastValue : 0;
		}

		void sync(LLUnitImplicit<F64, LLUnits::Seconds>) {}

		F64	getSum() const { return mSum; }
		F64	getMin() const { return mMin; }
		F64	getMax() const { return mMax; }
		F64	getLastValue() const { return mLastValue; }
		F64	getMean() const { return mMean; }
		F64 getStandardDeviation() const { return sqrtf(mSumOfSquares / mNumSamples); }
		U32 getSampleCount() const { return mNumSamples; }

	private:
		F64	mSum,
			mMin,
			mMax,
			mLastValue;

		F64	mMean,
			mSumOfSquares;

		U32	mNumSamples;
	};


	class SampleAccumulator
	{
	public:
		typedef F64 value_t;
		typedef F64 mean_t;

		SampleAccumulator()
		:	mSum(0),
			mMin((std::numeric_limits<F64>::max)()),
			mMax((std::numeric_limits<F64>::min)()),
			mMean(0),
			mSumOfSquares(0),
			mLastSampleTimeStamp(LLTimer::getTotalSeconds()),
			mTotalSamplingTime(0),
			mNumSamples(0),
			mLastValue(0),
			mHasValue(false)
		{}

		void sample(F64 value)
		{
			LLUnitImplicit<F64, LLUnits::Seconds> time_stamp = LLTimer::getTotalSeconds();
			LLUnitImplicit<F64, LLUnits::Seconds> delta_time = time_stamp - mLastSampleTimeStamp;
			mLastSampleTimeStamp = time_stamp;

			if (mHasValue)
			{
				mTotalSamplingTime += delta_time;
				mSum += mLastValue * delta_time;

				// NOTE: both conditions will hold first time through
				if (value < mMin) { mMin = value; }
				if (value > mMax) { mMax = value; }

				F64 old_mean = mMean;
				mMean += (delta_time / mTotalSamplingTime) * (mLastValue - old_mean);
				mSumOfSquares += delta_time * (mLastValue - old_mean) * (mLastValue - mMean);
			}

			mLastValue = value;
			mNumSamples++;
			mHasValue = true;
		}

		void addSamples(const SampleAccumulator& other, bool append)
		{
			if (other.mTotalSamplingTime)
			{
				mSum += other.mSum;

				// NOTE: both conditions will hold first time through
				if (other.mMin < mMin) { mMin = other.mMin; }
				if (other.mMax > mMax) { mMax = other.mMax; }

				// combine variance (and hence standard deviation) of 2 different sized sample groups using
				// the following formula: http://www.mrc-bsu.cam.ac.uk/cochrane/handbook/chapter_7/7_7_3_8_combining_groups.htm
				F64 n_1 = mTotalSamplingTime,
					n_2 = other.mTotalSamplingTime;
				F64 m_1 = mMean,
					m_2 = other.mMean;
				F64 v_1 = mSumOfSquares / mTotalSamplingTime,
					v_2 = other.mSumOfSquares / other.mTotalSamplingTime;
				if (n_1 == 0)
				{
					mSumOfSquares = other.mSumOfSquares;
				}
				else if (n_2 == 0)
				{
					// variance is unchanged
					// mSumOfSquares = mSumOfSquares;
				}
				else
				{
					mSumOfSquares =	mTotalSamplingTime
						* ((((n_1 - 1.f) * v_1)
						+ ((n_2 - 1.f) * v_2)
						+ (((n_1 * n_2) / (n_1 + n_2))
						* ((m_1 * m_1) + (m_2 * m_2) - (2.f * m_1 * m_2))))
						/ (n_1 + n_2 - 1.f));
				}

				llassert(other.mTotalSamplingTime > 0);
				F64 weight = mTotalSamplingTime / (mTotalSamplingTime + other.mTotalSamplingTime);
				mNumSamples += other.mNumSamples;
				mTotalSamplingTime += other.mTotalSamplingTime;
				mMean = (mMean * weight) + (other.mMean * (1.0 - weight));
				if (append)
				{
					mLastValue = other.mLastValue;
					mLastSampleTimeStamp = other.mLastSampleTimeStamp;
					mHasValue |= other.mHasValue;
				}
			}
		}

		void reset(const SampleAccumulator* other)
		{
			mNumSamples = 0;
			mSum = 0;
			mMin = std::numeric_limits<F64>::max();
			mMax = std::numeric_limits<F64>::min();
			mMean = other ? other->mLastValue : 0;
			mSumOfSquares = 0;
			mLastSampleTimeStamp = LLTimer::getTotalSeconds();
			mTotalSamplingTime = 0;
			mLastValue = other ? other->mLastValue : 0;
			mHasValue = other ? other->mHasValue : false;
		}

		void sync(LLUnitImplicit<F64, LLUnits::Seconds> time_stamp)
		{
			LLUnitImplicit<F64, LLUnits::Seconds> delta_time = time_stamp - mLastSampleTimeStamp;

			if (mHasValue)
			{
				mSum += mLastValue * delta_time;
				mTotalSamplingTime += delta_time;
			}
			mLastSampleTimeStamp = time_stamp;
		}

		F64	getSum() const { return mSum; }
		F64	getMin() const { return mMin; }
		F64	getMax() const { return mMax; }
		F64	getLastValue() const { return mLastValue; }
		F64	getMean() const { return mMean; }
		F64 getStandardDeviation() const { return sqrtf(mSumOfSquares / mTotalSamplingTime); }
		U32 getSampleCount() const { return mNumSamples; }
		bool hasValue() const { return mHasValue; }

	private:
		F64	mSum,
			mMin,
			mMax,
			mLastValue;

		bool mHasValue;

		F64	mMean,
			mSumOfSquares;

		LLUnitImplicit<F64, LLUnits::Seconds>	mLastSampleTimeStamp,
			mTotalSamplingTime;

		U32	mNumSamples;
	};

	class CountAccumulator
	{
	public:
		typedef F64 value_t;
		typedef F64 mean_t;

		CountAccumulator()
		:	mSum(0),
			mNumSamples(0)
		{}

		void add(F64 value)
		{
			mNumSamples++;
			mSum += value;
		}

		void addSamples(const CountAccumulator& other, bool /*append*/)
		{
			mSum += other.mSum;
			mNumSamples += other.mNumSamples;
		}

		void reset(const CountAccumulator* other)
		{
			mNumSamples = 0;
			mSum = 0;
		}

		void sync(LLUnitImplicit<F64, LLUnits::Seconds>) {}

		F64	getSum() const { return mSum; }

		U32 getSampleCount() const { return mNumSamples; }

	private:
		F64	mSum;

		U32	mNumSamples;
	};

	class TimeBlockAccumulator
	{
	public:
		typedef LLUnit<F64, LLUnits::Seconds> value_t;
		typedef LLUnit<F64, LLUnits::Seconds> mean_t;
		typedef TimeBlockAccumulator self_t;

		// fake classes that allows us to view different facets of underlying statistic
		struct CallCountFacet 
		{
			typedef U32 value_t;
			typedef F32 mean_t;
		};

		struct SelfTimeFacet
		{
			typedef LLUnit<F64, LLUnits::Seconds> value_t;
			typedef LLUnit<F64, LLUnits::Seconds> mean_t;
		};

		TimeBlockAccumulator();
		void addSamples(const self_t& other, bool /*append*/);
		void reset(const self_t* other);
		void sync(LLUnitImplicit<F64, LLUnits::Seconds>) {}

		//
		// members
		//
		U64							mStartTotalTimeCounter,
			mTotalTimeCounter,
			mSelfTimeCounter;
		U32							mCalls;
		class TimeBlock*			mParent;		// last acknowledged parent of this time block
		class TimeBlock*			mLastCaller;	// used to bootstrap tree construction
		U16							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

	};

	class TimeBlock;
	class TimeBlockTreeNode
	{
	public:
		TimeBlockTreeNode();

		void setParent(TimeBlock* parent);
		TimeBlock* getParent() { return mParent; }

		TimeBlock*					mBlock;
		TimeBlock*					mParent;	
		std::vector<TimeBlock*>		mChildren;
		bool						mCollapsed;
		bool						mNeedsSorting;
	};
	
	struct BlockTimerStackRecord
	{
		class BlockTimer*	mActiveTimer;
		class TimeBlock*	mTimeBlock;
		U64					mChildTime;
	};

	struct MemStatAccumulator
	{
		typedef MemStatAccumulator self_t;

		// fake classes that allows us to view different facets of underlying statistic
		struct AllocationCountFacet 
		{
			typedef U32 value_t;
			typedef F32 mean_t;
		};

		struct DeallocationCountFacet 
		{
			typedef U32 value_t;
			typedef F32 mean_t;
		};

		struct ChildMemFacet
		{
			typedef LLUnit<F64, LLUnits::Bytes> value_t;
			typedef LLUnit<F64, LLUnits::Bytes> mean_t;
		};

		MemStatAccumulator()
		:	mAllocatedCount(0),
			mDeallocatedCount(0)
		{}

		void addSamples(const MemStatAccumulator& other, bool append)
		{
			mSize.addSamples(other.mSize, append);
			mChildSize.addSamples(other.mChildSize, append);
			mAllocatedCount += other.mAllocatedCount;
			mDeallocatedCount += other.mDeallocatedCount;
		}

		void reset(const MemStatAccumulator* other)
		{
			mSize.reset(other ? &other->mSize : NULL);
			mChildSize.reset(other ? &other->mChildSize : NULL);
			mAllocatedCount = 0;
			mDeallocatedCount = 0;
		}

		void sync(LLUnitImplicit<F64, LLUnits::Seconds> time_stamp) 
		{
			mSize.sync(time_stamp);
			mChildSize.sync(time_stamp);
		}

		SampleAccumulator	mSize,
							mChildSize;
		int					mAllocatedCount,
							mDeallocatedCount;
	};

	struct AccumulatorBufferGroup : public LLRefCount
	{
		AccumulatorBufferGroup();

		void handOffTo(AccumulatorBufferGroup& other);
		void makePrimary();
		bool isPrimary() const;
		static void clearPrimary();

		void append(const AccumulatorBufferGroup& other);
		void merge(const AccumulatorBufferGroup& other);
		void reset(AccumulatorBufferGroup* other = NULL);
		void sync();

		AccumulatorBuffer<CountAccumulator>	 			mCounts;
		AccumulatorBuffer<SampleAccumulator>			mSamples;
		AccumulatorBuffer<EventAccumulator>				mEvents;
		AccumulatorBuffer<TimeBlockAccumulator> 		mStackTimers;
		AccumulatorBuffer<MemStatAccumulator> 			mMemStats;
	};
}

#endif // LL_LLTRACEACCUMULATORS_H