jobstats: new library
authorPawel Wodkowski <pawelx.wodkowski@intel.com>
Tue, 24 Feb 2015 16:33:23 +0000 (17:33 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 24 Feb 2015 21:12:35 +0000 (22:12 +0100)
commit597b0f74e209b4cebb0602df69385b0c33b0dfa3
treea7ac4987357fbbe9f2952d3ab3d287d18963995c
parentd6fe2f5ee041b650a9f0829e3004c72f0c5a4634
jobstats: new library

This library provide API to measure time spend in particular parts of
code and to calculate optimal polling time.

To calculate a those statistics application code need to be divided into
parts (called jobs) that do something. It is up to application to decide
what is considered a job.

Series of jobs must be surrounded with the rte_jobstats_context_start()
and rte_jobstats_context_finish() calls. After that, jobs might be
started.  Each job must be surrounded with rte_jobstats_start() and
rte_jobstats_finish() calls.

After job finishes its execution, period in which it should be called
again is adjusted. It might be used to minimize time wasted on
unnecessary polls/calls. Adjustment is based on data provided by job
itself (ex: number of packets it processed).

After all jobs in serie are executed fallowing statistics are updated
and might be used by application. Statistics can be reset. Some of
provided statistic data:
 - total/min/max execution - time spent in executing jobs.
 - total/min/max management - time spent outside execution area. This
value might be used to measure overhead of scheduling jobs. This time
also contains overhead of rte_jobstats library itself.
 - number of loops that executed at least one job
 - executed jobs
 - time when statistics were reset.

Each job provide total/min/max execution time and execution count
statistics.

Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
config/common_bsdapp
config/common_linuxapp
doc/api/doxy-api.conf
lib/Makefile
lib/librte_jobstats/Makefile [new file with mode: 0644]
lib/librte_jobstats/rte_jobstats.c [new file with mode: 0644]
lib/librte_jobstats/rte_jobstats.h [new file with mode: 0644]
lib/librte_jobstats/rte_jobstats_version.map [new file with mode: 0644]