Add octave scripts for examples into track list.
[Faustine.git] / interpretor / preprocessor / faust-0.9.47mr3 / benchmark / README
1 HOW TO BENCHMARK FAUST GENERATED CODE
2
3 This folder contains what is needed to benchmark the efficiency of programs generated by the Faust compiler on Intel processors. Several options are considered, scalar code, vector code and parallel code (OpenMP and Sch). The C++ compiler used and their options are also considered.
4
5 The elements to produce the benchmarks are the following :
6
7 1) you can either use the .dsp files already in the folder
8 or replace them with your own .dsp files.
9
10 2) 'alsa-gtk-bench.cpp' is the architecture file used for the benchmarks. It corresponds to an alsa gtk application specially equipped to measure the time it takes to process the samples. The application will do 600 measurements before quitting automatically. The mean value of the 10 best measurements will be retained. Instead of being expressed in seconds this value will be converted in throughput in MB/s, that is the number of bytes of samples the application is able to process per seconds.
11
12 Note : 'alsa-gtk-bench.cpp' uses rdtsc as a wall clock. It is therefore specific to X86 processors and must be adapted for other processors. In order to convert clocks to seconds the code measure the number of clocks per seconds unless the the environment variable CLOCKSPERSEC is set with the exact value to use for the conversion.
13
14 3) The file Makefile contains the various combinations of faust options and gcc or icc options you may want to test. If you have gcc and icc installed you can just do a 'make'. If you have only gcc installed do a 'make gcc'. For icc do a 'make icc'. This will produce several variants of audio applications in separate directories : {i,g}alsa{scal,vec,omp,sch,..}dir. Check the Makefile for possible targets.
15
16 4) the script 'bench.sh' will run all the binaries of all the directories and collect their results in a single 'results-yymmdd.hhmmss' file. Run bench.sh several times to be sure of the stability of the results.
17
18
19
20