Documentation::User documentation

Architecture

compbenchmarks package proposes a framework to handle some well-known benchmarks and applications. It provides core functionnalities to :

• download packages and benchmarks
• configure and compile them (with arbitrary C/C++ compilers and optimisation options)
• evaluate them, and store results in a common format. Results can also be imported in official database.

Architecture

compbenchmarks is splited in two functionnal blocks : normal users should start take a look at high-level user interfaces. For more in-depth management, or if you don't have installed more user friendly applications, the compbenchmark-core and compbenchmark-plan program are available. Finaly, the libcompbenchmarks shared library and related API can be used to implement new benchmark/package support or develop your own C++/Perl wrappers (at this time). Each supported benchmark or compiler is handled through a specific, independant, shared library.

High-level user interfaces

No GUI is available at the moment; a Qt 4.x based interface is in active development. There is also a deprecated Perl based interface (using dialog) for 0.4.0 branch.

compbenchmarks-core program

This binary program supports most of configuration related actions allowed by the underlaying library. It may be needed for advanced usages (e.g. for writting a custom wrapper to evaluate benchmarks in a specific maner, not handled by providen user interfaces).

compbenchmarks-plan program

This binary program allows to set up benchmarking plan; that is to say, puting some compilers, options and supported benchmarks together in order to evaluate performances within different contexts automatically.

libcompbenchmarks

This is the underlaying library for the compbenchmarks package. It holds generic methods to download packages, basic framework to install, optionally patch and configure them, etc. If you are interested in how to use it in your own program or if you want to make a new benchmark/package supported, you'll need to use it.

The technical documention presents all concepts, XML knowledge-base, as well as API.