Profiler plugin

Profiler provides detailed information about how long each function takes to execute and how many times it is called. Additionally it can build a call graph based on the collected information.

Installation

1. Download a binary package n form the Releases page on Github or build it yourself from source code (see below).
2. Extract/copy profiler.so or profiler.dll to <sever>/plugins/.
3. Add profiler (Windows) or profiler.so (Linux) to the plugins line of your server.cfg.
4. Enable profiling of your gamemode or filterscripts via server.cfg (see Configuration).

Binary archives come with an include file (profiler.inc) that contains some helper functions that you may find useful. But you don't need to include it to be able to use the plugin, it's not required.

Configuration

Profiler reads settings from server.cfg, the server configuration file. Below is the list of available settings:

• profiler_gamemodes <gm_name1> <gm_name2> ...

  Specify which gamemodes should be profiled.

  Names are either gamemodes' file names or paths relative to the gamemodes/ directory in case if the AMX file is not a direct child of gamemodes/.

• profile_filterscripts <fs_name1> <fs_name2> ...

  Specify which filterscripts should be profiled.

• profiler_outputformat <format>

  Set statistics output format. This can be one of: html (default), xml, txt.

• profiler_callgraph <0|1>

  Enable or disable call graph generation. Default is 0.

• profiler_callgraphformat <format>

  Set call graph format. Currently only the dot format is supported, you can view such files in in Graphviz or WebGraphviz.

Old (deprecated) config variables

• profile_gamemode <0|1>

  Toggle gamemode profiling. Default is 0.

  Same as setting profiler_gamemodes to the name of the current gamemode.

• profile_filterscripts <fs_name1> <fs_name2> ...

  Same as profiler_filterscripts.

• profile_format <format>

  Same as profiler_outputformat.

• call_graph <0|1>

  Same as profiler_callgraph.

• call_graph_format <format>

  Same as profiler_callgraphformat.

Building from source code

If you want to build the plugin from source code, e.g. to fix a bug and submit a pull request, simply follow the steps below. You will need a C++ compiler and CMake.

Linux

Install gcc and g++, make and cmake. On Ubuntu you would do that like so:

sudo apt-get install gcc g++ make cmake

If you're on a 64-bit system you'll need additional packages for compiling for 32-bit:

sudo apt-get install gcc-multilib g++-multilib

For CentOS:

yum install gcc gcc-c++ cmake28 make

Now you're ready to build the plugin:

cd profiler
mkdir build && cd build
cmake ../ -DCMAKE_BUILD_TYPE=Release
make

Windows

You'll need to install CMake and Visual Studio (Express edition will suffice). After that, either run cmake from the command line:

cd profiler
mkdir build && cd build
path/to/cmake.exe ../

or do the same from cmake-gui. This will generate a Visual Studio project in the build folder.

To build the project:

path/to/cmake.exe --build . --config Release

You can also build it from within Visual Studio: open build/profiler.sln and go to menu -> Build -> Build Solution (or just press F7).

License

Licensed under the 2-clause BSD license. See LICENSE.txt.