Lazarus

Free Pascal => Windows => Topic started by: Bad Sector on March 04, 2021, 09:03:12 pm

Title: Free Pascal Windows Profiler
Post by: Bad Sector on March 04, 2021, 09:03:12 pm
I was looking for a statistical (ie. non-instrumenting) profiler that works with Free Pascal and couldn't find any since pretty much everything assumes you are using PDB (Visual C++) symbols. Very Sleepy claims some MinGW support but it still didn't work with Free Pascal (it has two parsers for DWARF data, one that seemed to enter an endless loop with random garbage spewed out and another that simply didn't load anything regardless of settings).

So i decided to write mine. I wanted one that works in retro systems anyway since i wanted to profile my retro game (https://bad-sector.itch.io/post-apocalyptic-petra) there (though the API i used to grab thread state requires at least Win2K).

You can find it here: http://runtimeterror.com/tools/fpwprof/

This can use either STABS or DWARFv2 debug info. Initially i wrote STABS support because it seemed simpler (it took me around 30 minutes to write the code for loading the data i needed)... but then i realized that it only works with 32bit applications, so i had to bite the bullet and write a DWARF parser too. That took me the next 1.5 days :-P. But at least it now works with 64bit applications too and as a bonus it also works with MinGW programs (as long as they're compiled with -gdwarf-2 so that only DWARFv2 debug data is generated - i haven't implemented any later version). STABS is still much faster to parse though. Also some older versions of Free Pascal (e.g. 2.2.4 which i used to compile my game's Windows version because it works in Windows 95 that i wanted to use for running in retro PCs with 3dfx Voodoo 1 GPUs) may generate invalid DWARF data for some programs (e.g. my game) but proper STABS data (initially i thought it was my parser that had the problem but i also tried it with LLVM's llvm-dwarfdump.exe and it also couldn't parse the data). Recent versions of FPC work fine though.

Beyond that the profiler can be configured to start automatically when a specified executable is launched, collect up to some maximum number of samples and be started/stopped when a key is pressed. These can be useful for when you cannot interact with the program directly, like e.g. when a game is being profiled that runs in fullscreen (i guess you can spot a pattern by now :-P).

Note that at the moment this only samples EIP/RIP, it doesn't capture callstack or anything else. That should be enough to get a quick and clear idea of where the time is spent though perhaps not enough to see why :-P. I'll see about adding that (and better filtering) in the future. Similarly i threw together the UI quickly, so no advanced stuff (the entire tool was made in a couple of days, most of which was spent reading about DWARF, cursing the modern industry that decided a debug format which includes stuff like an entire VM for decoding line numbers and locations is preferable to the much simpler format that simply gives you address ranges - and of course writing the parser for it). You can at least copy the profile results to the clipboard and paste it in an editor for comparing multiple runs.
Title: Re: Free Pascal Windows Profiler
Post by: AlexTP on March 04, 2021, 09:21:01 pm
Can we have this on Github? you don't need the Git, just register on GH, create the repo (using www site), and post several files there (using www site again, "add file" button).
Title: Re: Free Pascal Windows Profiler
Post by: Bad Sector on March 04, 2021, 09:38:28 pm
I do not like GitHub (nor Git really) so i avoid using it. Besides as i wrote here (http://runtimeterror.com/abitopen.txt) this isn't a collaborative project so it doesn't make any difference. For bug reports you can send me an email - or post here (i'll hopefully eventually receive a mail from the forum server).
Title: Re: Free Pascal Windows Profiler
Post by: Bad Sector on June 09, 2021, 06:07:55 pm
Uploaded a new version, 1.1 (http://runtimeterror.com/tools/fpwprof/). The main new feature is support for capturing call stacks, which allows the profiler to show the call traces that refer to each function - sorted by how often a trace is found in the samples. Essentially if you have a function that is called very often but it is also quite generic (e.g. something like "DistanceBetween") so it is called by several places, what you may be interested about isn't that this function is called often but how the function ends up being called at all - ie. the entire "path" that ends up with that function.

Other features include showing the callers and callees of a function, searching the profile results and some simple clipboard operations.
Title: Re: Free Pascal Windows Profiler
Post by: Bad Sector on July 04, 2021, 11:10:45 pm
Uploaded a new version, 1.2 (http://runtimeterror.com/tools/fpwprof/). This adds a timeline that can be used to see the CPU usage over time and focus only on part of the timeline for the profile. Functions/procedures can be highlighted in the timeline to see where they end up over time. In addition the profiled/sampled program can now send commands to the profiler which allows starting, stopping, pausing and resuming the profiling as well as creating "markers" with custom names (up to 8 chars) on the timeline (see this screenshot (https://i.imgur.com/K5aqp0b.gif) for an example).
TinyPortal © 2005-2018