Profiling - Revision history

Stgatilov: Added reference to timeline profiler, added Windows sampling profiler instructions, deleted non-universal TIMING_BUILD and M_TIMINGS (use Tracy instead).

2024-01-29T19:47:36Z

Added reference to timeline profiler, added Windows sampling profiler instructions, deleted non-universal TIMING_BUILD and M_TIMINGS (use Tracy instead).

@@ Line 1: / Line 1: @@
 == Profiling ==
-To find code parts that are too slow, The Dark Mod can be run under a profiler. This article details how to do this under '''Linux''':
+To find code parts that are too slow, The Dark Mod can be run under a profiler.
 === Windows ===
-No information on this yet.
+Sampling profiler is integrated into Visual C++ today:
 === Linux ===
 ==== gprof ====
@@ Line 154: / Line 170: @@
   ack gamex86.so tdm_profile_report.txt
 == g_frametime ==

Tels: typo

2012-03-10T16:42:35Z

typo

← Older revision		Revision as of 16:42, 10 March 2012
Line 22:		Line 22:
	./thedarkmod.x86		./thedarkmod.x86

	This will produce a file named "gmon.out", which can then after TDM exits, be ~~anylyzed~~ with gprof:		This will produce a file named "gmon.out", which can then after TDM exits, be analyzed with gprof:

	gprof		gprof

Tels: update

2012-03-10T16:28:59Z

update

← Older revision		Revision as of 16:28, 10 March 2012
Line 17:		Line 17:
	./linuxBuild BUILD=profile		./linuxBuild BUILD=profile

	Then run:		Then run TDM normally:

	~~gprof~~ thedarkmod.x86		cd .doom3/
			./thedarkmod.x86

	~~{{Note~~: ~~Further~~ information ~~is missing here~~.}}		This will produce a file named "gmon.out", which can then after TDM exits, be anylyzed with gprof:

			gprof

			For further information see the man page of <tt>gprof</tt>.

	==== oprofile ====		==== oprofile ====

	oprofile is a system-wide profiler, that can also profile the Linux kernel. It will by default profile everything that is running, so to avoid noise it is better to close as many applications (chat, Firefox etc) and shut down as many system services (f.i. Mysql, Postgres, Apache) as possible.		Another method of profiling is by using '''oprofile'''. '''oprofile''' is a system-wide profiler, that can also profile the Linux kernel. It will by default profile everything that is running, so to avoid noise it is better to close as many applications (chat, Firefox etc) and shut down as many system services (f.i. Mysql, Postgres, Apache) as possible.

	===== Preparing oprofile =====		===== Preparing oprofile =====

Tels: update

2012-03-10T14:17:24Z

update

← Older revision		Revision as of 14:17, 10 March 2012
Line 11:		Line 11:
	==== gprof ====		==== gprof ====

	~~{{infobox\|It is not yet possible to use gprof with TDM, so use oprofile!\|bg=#d04040\|fg=yellow}}~~		gprof is part of the GNU tools just like gcc is, and is an application-level profiler.

	gprof is part of the GNU tools just like gcc is~~. It~~ is an application-level profiler.

	To compile the TDM source for profiling, you can use		To compile the TDM source for profiling, you can use
Line 19:		Line 17:
	./linuxBuild BUILD=profile		./linuxBuild BUILD=profile

	~~However, it is currently '''not''' possible to~~ run ~~TDM under~~ gprof~~, as this requires to recompile the entire application with "gcc -pg"~~. ~~As D3 itself is not yet open source, this~~ is ~~'''not''' possible~~.		Then run:

			gprof thedarkmod.x86

			{{Note: Further information is missing here.}}

	==== oprofile ====		==== oprofile ====

Tels: add timing build "how to compile"

2011-02-19T17:17:03Z

add timing build "how to compile"

← Older revision		Revision as of 17:17, 19 February 2011
Line 175:		Line 175:
	== Timing Builds ==		== Timing Builds ==

	There is also a class for managing timers, that is only available if you create a timing build. All code that uses this class should also wrapped in #ifdefs that are only active under a timing build.		There is also a class for managing timers, that is only available if you create a timing build. All code that uses this class should also wrapped in #ifdefs that are only active under a timing build. Example from actor.h:

	Example from actor.h:

	<pre>		<pre>
Line 211:		Line 209:
	After you recompiled the source for at timing build, f.i. with:		After you recompiled the source for at timing build, f.i. with:

	~~<pre>~~		./linuxBuild.sh BASEFLAGS="-DTIMING_BUILD"
	~~'''fill in'''~~
	</~~pre>~~

	You can use the command '''listTimers''' on the console to get the timing information. More commands: '''writeTimerCSV''', '''resetTimers'''		You can use the command '''listTimers''' on the console to get the timing information. More commands: '''writeTimerCSV''', '''resetTimers'''

Tels: add g_frametime and g_timeentities

2011-02-19T16:30:48Z

add g_frametime and g_timeentities

← Older revision		Revision as of 16:30, 19 February 2011
Line 216:		Line 216:

	You can use the command '''listTimers''' on the console to get the timing information. More commands: '''writeTimerCSV''', '''resetTimers'''		You can use the command '''listTimers''' on the console to get the timing information. More commands: '''writeTimerCSV''', '''resetTimers'''

			== g_frametime ==

			Set this [[CVAR]] to 1, and the code will emit how many milliseconds it took to do all the calculations for one frame, minus the render time. The output on the console will be something like this:

			game 28080: all:0.2 th:0.2 ev:0.0 28 ents

			The numbers are:

			* game: The current frame time (always increasing from map start)
			* all: The complete time to think + event handling
			* th: The thinking time (without event handling)
			* ev: The event handling time
			* ents: The number of entities that did thinking

			== g_timeentities ==

			When set to > 0, shows entities whose <tt>Think()</tt> functions exceeded the number of milliseconds specified. Set it for instance to 2, and all entities that think longer than 2ms will be shown on the console.

	== See also ==		== See also ==

Tels: add idTimer

2010-10-15T10:44:31Z

add idTimer

@@ Line 146: / Line 146: @@
   ack gamex86.so tdm_profile_report.txt
 == Timing Builds ==
@@ Line 186: / Line 212: @@
 <pre>
-./linuxBuild TIMING_BUILD=1
+'''fill in'''
 </pre>

Greebo: /* Timing Builds */

2010-10-05T18:16:32Z

Timing Builds

← Older revision		Revision as of 18:16, 5 October 2010
Line 175:		Line 175:
	</pre>		</pre>

	and then ~~from~~		and then in the function to be profiled:

	<pre>		<pre>
	~~#ifdef TIMING_BUILD~~		START_SCOPED_TIMING(actor->actorRouteToGoalTimer, scopedRouteToGoalTimer);
	~~if (actor != NULL)~~
	{
	START_SCOPED_TIMING(actor->actorRouteToGoalTimer, scopedRouteToGoalTimer);
	}
	~~#endif~~
	~~...~~

	</pre>		</pre>

Line 196:		Line 189:
	</pre>		</pre>

	You can use the command '''~~af_showTimings~~''' on the console to get the timing information:		You can use the command '''listTimers''' on the console to get the timing information. More commands: '''writeTimerCSV''', '''resetTimers'''

	~~<pre>~~
	~~idCVar af_showTimings( "af_showTimings"~~, ~~"0", CVAR_GAME \| CVAR_BOOL, "show articulated figure cpu usage" );~~
	~~</pre>~~

	~~Various other CVARS exist, like~~ '''~~rb_showTiming~~'''.

	== See also ==		== See also ==

Tels: add timings

2010-10-05T18:00:00Z

add timings

← Older revision		Revision as of 18:00, 5 October 2010
Line 3:		Line 3:
	To find code parts that are too slow, The Dark Mod can be run under a profiler. This article details how to do this under '''Linux''':		To find code parts that are too slow, The Dark Mod can be run under a profiler. This article details how to do this under '''Linux''':

	== Windows ==		=== Windows ===

	No information on this yet.		No information on this yet.

	== Linux ==		=== Linux ===

	=== gprof ===		==== gprof ====

	{{infobox\|It is not yet possible to use gprof with TDM, so use oprofile!\|bg=#d04040\|fg=yellow}}		{{infobox\|It is not yet possible to use gprof with TDM, so use oprofile!\|bg=#d04040\|fg=yellow}}
Line 21:		Line 21:
	However, it is currently '''not''' possible to run TDM under gprof, as this requires to recompile the entire application with "gcc -pg". As D3 itself is not yet open source, this is '''not''' possible.		However, it is currently '''not''' possible to run TDM under gprof, as this requires to recompile the entire application with "gcc -pg". As D3 itself is not yet open source, this is '''not''' possible.

	=== oprofile ===		==== oprofile ====

	oprofile is a system-wide profiler, that can also profile the Linux kernel. It will by default profile everything that is running, so to avoid noise it is better to close as many applications (chat, Firefox etc) and shut down as many system services (f.i. Mysql, Postgres, Apache) as possible.		oprofile is a system-wide profiler, that can also profile the Linux kernel. It will by default profile everything that is running, so to avoid noise it is better to close as many applications (chat, Firefox etc) and shut down as many system services (f.i. Mysql, Postgres, Apache) as possible.

	==== Preparing oprofile ====		===== Preparing oprofile =====

	* First, install the nec. packages:		* First, install the nec. packages:
Line 41:		Line 41:
	There are two ways to use oprofile:		There are two ways to use oprofile:

	==== Using tdm_profile.sh ====		===== Using tdm_profile.sh =====

	Instead of using tdm_launcher.linux, open a shell, change to the darkmod directory and run:		Instead of using tdm_launcher.linux, open a shell, change to the darkmod directory and run:
Line 91:		Line 91:
	</pre>		</pre>

	==== Using opcontrol manually ====		===== Using opcontrol manually =====

	The '''opcontrol''' utility can be used to toggle the profiling on and off during runtime. Just start it, start TDM normally and after loading a mission, toggle back to a text-mode console with {{CTRL}}+{{ALT}}+{{F2}}, use:		The '''opcontrol''' utility can be used to toggle the profiling on and off during runtime. Just start it, start TDM normally and after loading a mission, toggle back to a text-mode console with {{CTRL}}+{{ALT}}+{{F2}}, use:
Line 141:		Line 141:
	</pre>		</pre>

	=== Tips ===		==== Tips ====

	Use [http://search.cpan.org/~petdance/ack/ ack] (or grep) on the tdm_profile_report.txt to filter out anything not mentioning gamex86.so, this reduces the clutter:		Use [http://search.cpan.org/~petdance/ack/ ack] (or grep) on the tdm_profile_report.txt to filter out anything not mentioning gamex86.so, this reduces the clutter:

	ack gamex86.so tdm_profile_report.txt		ack gamex86.so tdm_profile_report.txt

			== Timing Builds ==

			There is also a class for managing timers, that is only available if you create a timing build. All code that uses this class should also wrapped in #ifdefs that are only active under a timing build.

			Example from actor.h:

			<pre>
			#ifdef TIMING_BUILD
			public:
			int actorGetObstaclesTimer;
			int actorGetPointOutsideObstaclesTimer;
			int actorGetWallEdgesTimer;
			int actorSortWallEdgesTimer;
			int actorBuildPathTreeTimer;
			int actorPrunePathTreeTimer;
			int actorFindOptimalPathTimer;
			int actorRouteToGoalTimer;
			int actorSubSampleWalkPathTimer;
			int actorWalkPathValidTimer;
			#endif
			</pre>

			And from from actor.cpp:

			<pre>
			INIT_TIMER_HANDLE(actorGetObstaclesTimer);
			</pre>

			and then from

			<pre>
			#ifdef TIMING_BUILD
			if (actor != NULL)
			{
			START_SCOPED_TIMING(actor->actorRouteToGoalTimer, scopedRouteToGoalTimer);
			}
			#endif
			...

			</pre>

			The timer will end at the scope automatically.

			After you recompiled the source for at timing build, f.i. with:

			<pre>
			./linuxBuild TIMING_BUILD=1
			</pre>

			You can use the command '''af_showTimings''' on the console to get the timing information:

			<pre>
			idCVar af_showTimings( "af_showTimings", "0", CVAR_GAME \| CVAR_BOOL, "show articulated figure cpu usage" );
			</pre>

			Various other CVARS exist, like '''rb_showTiming'''.

	== See also ==		== See also ==

Tels: fix link

2010-09-07T18:20:18Z

fix link

← Older revision		Revision as of 18:20, 7 September 2010
Line 149:		Line 149:
	== See also ==		== See also ==

	* [[~~http://modetwo.net/darkmod/wiki/index.php?title=Coding_in_the_SDK~~]]		* [[Coding in the SDK]]

	{{coding}}		{{coding}}