summaryrefslogtreecommitdiff
path: root/indra/llcommon/lltrace.h
blob: 8b67dd8f445f50ee3f755921f7ddce5bd73db1a2 (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
/** 
 * @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 "llmemory.h"
#include "llrefcount.h"
#include "lltraceaccumulators.h"
#include "llthreadlocalstorage.h"
#include "lltimer.h"
#include "llpointer.h"
#include "llunits.h"

namespace LLTrace
{
class Recording;

template<typename T>
T storage_value(T val) { return val; }

template<typename UNIT_TYPE, typename STORAGE_TYPE> 
STORAGE_TYPE storage_value(LLUnit<STORAGE_TYPE, UNIT_TYPE> val) { return val.value(); }

template<typename UNIT_TYPE, typename STORAGE_TYPE> 
STORAGE_TYPE storage_value(LLUnitImplicit<STORAGE_TYPE, UNIT_TYPE> val) { return val.value(); }

class StatBase
{
public:
	StatBase(const char* name, const char* description);
	virtual ~StatBase() {};
	virtual const char* getUnitLabel() const;

	const std::string& getName() const { return mName; }
	const std::string& getDescription() const { return mDescription; }

protected:
	std::string	mName;
	std::string	mDescription;
};

template<typename ACCUMULATOR>
class StatType 
:	public StatBase,
	public LLInstanceTracker<StatType<ACCUMULATOR>, std::string, LLInstanceTrackerAllowKeyCollisions>
{
public:
	typedef LLInstanceTracker<StatType<ACCUMULATOR>, std::string, LLInstanceTrackerAllowKeyCollisions> instance_tracker_t;
	StatType(const char* name, const char* description)
	:	instance_tracker_t(name),
		StatBase(name, description),
		mAccumulatorIndex(AccumulatorBuffer<ACCUMULATOR>::getDefaultBuffer()->reserveSlot())
	{}

	LL_FORCE_INLINE ACCUMULATOR& getCurrentAccumulator() const
	{
		ACCUMULATOR* accumulator_storage = LLThreadLocalSingletonPointer<ACCUMULATOR>::getInstance();
		return accumulator_storage ? accumulator_storage[mAccumulatorIndex] : (*AccumulatorBuffer<ACCUMULATOR>::getDefaultBuffer())[mAccumulatorIndex];
	}

	size_t getIndex() const { return mAccumulatorIndex; }
	static size_t getNumIndices() { return AccumulatorBuffer<ACCUMULATOR>::getNumIndices(); }

protected:
	const size_t		mAccumulatorIndex;
};


template<>
class StatType<TimeBlockAccumulator::CallCountFacet>
:	public StatType<TimeBlockAccumulator>
{
public:

	StatType(const char* name, const char* description = "")
	:	StatType<TimeBlockAccumulator>(name, description)
	{}
};

template<>
class StatType<TimeBlockAccumulator::SelfTimeFacet>
	:	public StatType<TimeBlockAccumulator>
{
public:

	StatType(const char* name, const char* description = "")
		:	StatType<TimeBlockAccumulator>(name, description)
	{}
};

template <typename T = F64>
class EventStatHandle
:	public StatType<EventAccumulator>
{
public:
	typedef F64 storage_t;
	typedef StatType<EventAccumulator> stat_t;
	typedef EventStatHandle<T> self_t;

	EventStatHandle(const char* name, const char* description = NULL)
	:	stat_t(name, description)
	{}

	/*virtual*/ const char* getUnitLabel() const { return LLGetUnitLabel<T>::getUnitLabel(); }

};

template<typename T, typename VALUE_T>
void record(EventStatHandle<T>& measurement, VALUE_T value)
{
	T converted_value(value);
	measurement.getCurrentAccumulator().record(storage_value(converted_value));
}

template <typename T = F64>
class SampleStatHandle
:	public StatType<SampleAccumulator>
{
public:
	typedef F64 storage_t;
	typedef StatType<SampleAccumulator> stat_t;
	typedef SampleStatHandle<T> self_t;

	SampleStatHandle(const char* name, const char* description = NULL)
	:	stat_t(name, description)
	{}

	/*virtual*/ const char* getUnitLabel() const { return LLGetUnitLabel<T>::getUnitLabel(); }
};

template<typename T, typename VALUE_T>
void sample(SampleStatHandle<T>& measurement, VALUE_T value)
{
	T converted_value(value);
	measurement.getCurrentAccumulator().sample(storage_value(converted_value));
}

template <typename T = F64>
class CountStatHandle
:	public StatType<CountAccumulator>
{
public:
	typedef F64 storage_t;
	typedef StatType<CountAccumulator> stat_t;
	typedef CountStatHandle<T> self_t;

	CountStatHandle(const char* name, const char* description = NULL) 
	:	stat_t(name, description)
	{}

	/*virtual*/ const char* getUnitLabel() const { return LLGetUnitLabel<T>::getUnitLabel(); }
};

template<typename T, typename VALUE_T>
void add(CountStatHandle<T>& count, VALUE_T value)
{
	T converted_value(value);
	count.getCurrentAccumulator().add(storage_value(converted_value));
}

template<>
class StatType<MemAccumulator::AllocationFacet>
:	public StatType<MemAccumulator>
{
public:

	StatType(const char* name, const char* description = "")
	:	StatType<MemAccumulator>(name, description)
	{}
};

template<>
class StatType<MemAccumulator::DeallocationFacet>
:	public StatType<MemAccumulator>
{
public:

	StatType(const char* name, const char* description = "")
	:	StatType<MemAccumulator>(name, description)
	{}
};

class MemStatHandle : public StatType<MemAccumulator>
{
public:
	typedef StatType<MemAccumulator> stat_t;
	MemStatHandle(const char* name, const char* description = "")
	:	stat_t(name, description)
	{
		mName = name;
	}

	void setName(const char* name)
	{
		mName = name;
		setKey(name);
	}

	/*virtual*/ const char* getUnitLabel() const { return "KB"; }

	StatType<MemAccumulator::AllocationFacet>& allocations() 
	{ 
		return static_cast<StatType<MemAccumulator::AllocationFacet>&>(*(StatType<MemAccumulator>*)this);
	}

	StatType<MemAccumulator::DeallocationFacet>& deallocations() 
	{ 
		return static_cast<StatType<MemAccumulator::DeallocationFacet>&>(*(StatType<MemAccumulator>*)this);
	}
};


// measures effective memory footprint of specified type
// specialize to cover different types
template<typename T, typename IS_MEM_TRACKABLE = void, typename IS_UNITS = void>
struct MeasureMem
{
	static size_t measureFootprint(const T& value)
	{
		return sizeof(T);
	}
};

template<typename T, typename IS_BYTES>
struct MeasureMem<T, typename T::mem_trackable_tag_t, IS_BYTES>
{
	static size_t measureFootprint(const T& value)
	{
		return sizeof(T) + value.getMemFootprint();
	}
};

template<typename T, typename IS_MEM_TRACKABLE>
struct MeasureMem<T, IS_MEM_TRACKABLE, typename T::is_unit_t>
{
	static size_t measureFootprint(const T& value)
	{
		return U32Bytes(value).value();
	}
};

template<typename T, typename IS_MEM_TRACKABLE, typename IS_BYTES>
struct MeasureMem<T*, IS_MEM_TRACKABLE, IS_BYTES>
{
	static size_t measureFootprint(const T* value)
	{
		if (!value)
		{
			return 0;
		}
		return MeasureMem<T>::measureFootprint(*value);
	}
};

template<typename T, typename IS_MEM_TRACKABLE, typename IS_BYTES>
struct MeasureMem<LLPointer<T>, IS_MEM_TRACKABLE, IS_BYTES>
{
	static size_t measureFootprint(const LLPointer<T> value)
	{
		if (value.isNull())
		{
			return 0;
		}
		return MeasureMem<T>::measureFootprint(*value);
	}
};

template<typename IS_MEM_TRACKABLE, typename IS_BYTES>
struct MeasureMem<S32, IS_MEM_TRACKABLE, IS_BYTES>
{
	static size_t measureFootprint(S32 value)
	{
		return value;
	}
};

template<typename IS_MEM_TRACKABLE, typename IS_BYTES>
struct MeasureMem<U32, IS_MEM_TRACKABLE, IS_BYTES>
{
	static size_t measureFootprint(U32 value)
	{
		return value;
	}
};

template<typename T, typename IS_MEM_TRACKABLE, typename IS_BYTES>
struct MeasureMem<std::basic_string<T>, IS_MEM_TRACKABLE, IS_BYTES>
{
	static size_t measureFootprint(const std::basic_string<T>& value)
	{
		return value.capacity() * sizeof(T);
	}
};


template<typename T>
inline void claim_alloc(MemStatHandle& measurement, const T& value)
{
	S32 size = MeasureMem<T>::measureFootprint(value);
	if(size == 0) return;
	MemAccumulator& accumulator = measurement.getCurrentAccumulator();
	accumulator.mSize.sample(accumulator.mSize.hasValue() ? accumulator.mSize.getLastValue() + (F64)size : (F64)size);
	accumulator.mAllocations.record(size);
}

template<typename T>
inline void disclaim_alloc(MemStatHandle& measurement, const T& value)
{
	S32 size = MeasureMem<T>::measureFootprint(value);
	if(size == 0) return;
	MemAccumulator& accumulator = measurement.getCurrentAccumulator();
	accumulator.mSize.sample(accumulator.mSize.hasValue() ? accumulator.mSize.getLastValue() - (F64)size : -(F64)size);
	accumulator.mDeallocations.add(size);
}

template<typename DERIVED, size_t ALIGNMENT = LL_DEFAULT_HEAP_ALIGN>
class MemTrackableNonVirtual
{
public:
	typedef void mem_trackable_tag_t;

	MemTrackableNonVirtual(const char* name)
	:	mMemFootprint(0)
	{
		static bool name_initialized = false;
		if (!name_initialized)
		{
			name_initialized = true;
			sMemStat.setName(name);
		}
	}

	~MemTrackableNonVirtual()
	{
		disclaimMem(mMemFootprint);
	}

	static MemStatHandle& getMemStatHandle()
	{
		return sMemStat;
	}

	S32 getMemFootprint() const	{ return mMemFootprint; }

	void* operator new(size_t size) 
	{
		claim_alloc(sMemStat, size);
		return ll_aligned_malloc<ALIGNMENT>(size);
	}

	template<int CUSTOM_ALIGNMENT>
	static void* aligned_new(size_t size)
	{
		claim_alloc(sMemStat, size);
		return ll_aligned_malloc<CUSTOM_ALIGNMENT>(size);
	}

	void operator delete(void* ptr, size_t size)
	{
		disclaim_alloc(sMemStat, size);
		ll_aligned_free<ALIGNMENT>(ptr);
	}

	template<int CUSTOM_ALIGNMENT>
	static void aligned_delete(void* ptr, size_t size)
	{
		disclaim_alloc(sMemStat, size);
		ll_aligned_free<CUSTOM_ALIGNMENT>(ptr);
	}


	void* operator new [](size_t size)
	{
		claim_alloc(sMemStat, size);
		return ll_aligned_malloc<ALIGNMENT>(size);
	}

	void operator delete[](void* ptr, size_t size)
	{
		disclaim_alloc(sMemStat, size);
		ll_aligned_free<ALIGNMENT>(ptr);
	}

	// claim memory associated with other objects/data as our own, adding to our calculated footprint
	template<typename CLAIM_T>
	void claimMem(const CLAIM_T& value) const
	{
		S32 size = MeasureMem<CLAIM_T>::measureFootprint(value);
		claim_alloc(sMemStat, size);
		mMemFootprint += size;
	}

	// remove memory we had claimed from our calculated footprint
	template<typename CLAIM_T>
	void disclaimMem(const CLAIM_T& value) const
	{
		S32 size = MeasureMem<CLAIM_T>::measureFootprint(value);
		disclaim_alloc(sMemStat, size);
		mMemFootprint -= size;
	}

private:
	// use signed values so that we can temporarily go negative
	// and reconcile in destructor
	// NB: this assumes that no single class is responsible for > 2GB of allocations
	mutable S32 mMemFootprint;
	
	static	MemStatHandle	sMemStat;
};

template<typename DERIVED, size_t ALIGNMENT>
MemStatHandle MemTrackableNonVirtual<DERIVED, ALIGNMENT>::sMemStat(typeid(MemTrackableNonVirtual<DERIVED, ALIGNMENT>).name());

template<typename DERIVED, size_t ALIGNMENT = LL_DEFAULT_HEAP_ALIGN>
class MemTrackable : public MemTrackableNonVirtual<DERIVED, ALIGNMENT>
{
public:
	MemTrackable(const char* name)
	:	MemTrackableNonVirtual<DERIVED, ALIGNMENT>(name)
	{}

	virtual ~MemTrackable()
	{}
};
}

#endif // LL_LLTRACE_H