@@ -202,6 +202,88 @@ Prerequisites for building the OpenDataPlane (ODP) API
1024MB of memory:
$ sudo ODP_PKTIO_DPDK_PARAMS="-m 1024" ./test/performance/odp_l2fwd -i 0 -c 1
+3.5 Code instrumentation with PAPI library (optional)
+
+ PAPI library is used to instrument ODP API.
+
+3.5.1 Building PAPI library
+
+ ODP example library 'instrum' is using PAPI library to retrieve performance
+ counters associated with execution of ODP API. PAPI library is currently at 5.6.0.
+ However, if possible one should try to use the latest PAPI master branch commit for
+ the best performance and the latest bug fixes.
+
+ # Checkout PAPI code
+ $ git clone https://bitbucket.org/icl/papi.git
+ $ cd papi
+ $ git checkout papi-5-6-0-t (optional)
+
+ # Build PAPI
+ $ cd ./src/
+ $ ./configure --prefix=<papi_install_dir>
+ $ make clean
+ $ make
+ $ make install
+
+ Alternatively, one may install PAPI from packages, if available.
+ # apt-get install libpapi-dev
+
+3.5.2 Building ODP with PAPI support
+
+ $ cd <odp_dir>
+ $ ./bootstrap
+ $ ./configure --enable-code-instrum --with-papi-path=<papi_install_dir>
+ $ make clean
+ $ make
+
+ Note 1: Specifying PAPI install path (with '--with-papi-path' option) is not required if
+ PAPI was installed from packages.
+ Note 2: Building ODP with PAPI support forces dynamic linkage of ODP example applications with
+ ODP library.
+
+3.5.3 Configuration of instrumented API set
+
+ Instrumentation profile option can be applied at configure time to select API set to
+ be instrumented. By default, all ODP APIs stated in 'instrum' example are instrumented.
+
+ $ ./configure --with-papi-path=<papi_install_dir> --with-code-instrum-profile=<all|scheduler|pktio_direct>
+
+3.5.4 Running ODP application with code instrumentation
+
+ ODP example library 'instrum' is preloaded before execution of ODP application. ODP application
+ must link dynamically with ODP library.
+
+ # LD_PRELOAD=libinstrum.so.0.0.0 ./odp_application
+
+ Note: ODP and PAPI shared libraries must be accessible at runtime. Use LD_LIBRARY_PATH for
+ non-standard locations.
+
+ # export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<odp_install_dir>/lib:<papi_install_dir>/lib
+
+3.5.5 Retrieving performance counters
+
+ Performance counters are acquired per ODP worker and dumped in fix size sample chunks to CSV files.
+
+ CSV file name is composed as follows: profile_<ODP thread ID>_<sample chunk count>.csv
+
+ Default CSV files storage folder is '/tmp'. Use ODP_INSTRUM_STORE_DIR environment variable to
+ select a different folder.
+
+ # export ODP_INSTRUM_STORE_DIR=<store_dir>
+
+ CSV row contains the counters for execution of one API call: timestamp (ns) for the start of API call,
+ duration (cycles), API name and the differences between end and start for the list of PAPI counters.
+
+3.5.6 Selecting performance counters
+
+ By default, PAPI_BR_CN and PAPI_L2_DCM are acquired. Use ODP_INSTRUM_PAPI_EVENTS environment variable
+ to configure the list of PAPI counters (events).
+
+ # export ODP_INSTRUM_PAPI_EVENTS=PAPI_BR_CN,PAPI_L2_DCM,PAPI_BR_UCN
+
+ Note: Some PAPI counters may not be available for some architectures. Use papi tools 'papi_avail' and
+ 'papi_native_avail' to retrieve the list of available counters.
+
4.0 Packages needed to build API tests
CUnit test framework version 2.1-3 is required