From patchwork Wed Jan 31 14:00:25 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Github ODP bot X-Patchwork-Id: 126355 Delivered-To: patch@linaro.org Received: by 10.46.124.24 with SMTP id x24csp780967ljc; Wed, 31 Jan 2018 06:28:13 -0800 (PST) X-Google-Smtp-Source: AH8x2248V8D9Du6vi6bjVXvGt6Ct4cowi8hwUuuZk3c0cqVNlHB6oXdpwbA4flOjpXeJzy8pA6UB X-Received: by 10.13.237.69 with SMTP id w66mr22886765ywe.313.1517408892873; Wed, 31 Jan 2018 06:28:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1517408892; cv=none; d=google.com; s=arc-20160816; b=1Ka5tOiPkahn/s394GMV2ps1tW1BNJWAJ5WF/I6MYO9t/JCy7YHDtOCf0QzWKh80qX 1Vlm73NnJMgxbASrEOX9wX+UNHlWDvweq0+wybM39KSVMZpa3lBj9uYkiSAAnhQW1pjd RajiWrJ3e0nLC7znZKp6TfvLapFpEGF71u1lPKSR3HG+p/u7FWc4bVwfF/V6q7zvDcrN wd87Gv25/qR6ZoCl5amOAVK09ZyAzztagKVGMqO2mWFxHY3evJra/f/Ic60axYaFsfoT PJREgl/FFSZdVlOqtByqUb00j9mAsnu6C/mM4ESGDb6j3snJrwCqDbxAIHznjd1hY8K6 7N1w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:github-pr-num :references:in-reply-to:message-id:date:to:from:delivered-to :arc-authentication-results; bh=tqCcLQYt2Z0MgBxZ8u4gj0aO6md4efnE5Ug/L3ofKlI=; b=ZR5KsASvf/DhAKCFDdgvltHBd5QVF6YDSMS7NTo0/1YwNuymSkDUXKMMOPE1pdHZFI Sodlqv6U3IgCb2q9gT8mpZ1zZMZkX5KuzdpWODUCkJREEp5aHQN5p6dz9WXN81JL0+HU RVmRWKdVNrKBFBJEescZaEK/NJ30lcZPp67LSrDVWfMbJO9vTMoLdi+FZXF519vl6lRk BrJ9HGcqWxG7G955moFJcgu2vA0XNCHC7jYodSGMUdmLd5S30Yxj39fh6zwGiInKpBwm rtlPvDQtaM1VAty26aCoCbmaMRpWtlL0l6TrVpJb9RcK1bYxjBUC19gi7kItC9gxgYuo +z0g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.197.127.237 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Return-Path: Received: from lists.linaro.org (ec2-54-197-127-237.compute-1.amazonaws.com. [54.197.127.237]) by mx.google.com with ESMTP id n24si2912999qtf.477.2018.01.31.06.28.12; Wed, 31 Jan 2018 06:28:12 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.197.127.237 as permitted sender) client-ip=54.197.127.237; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.197.127.237 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=yandex.ru Received: by lists.linaro.org (Postfix, from userid 109) id 86D37617A1; Wed, 31 Jan 2018 14:28:12 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2 autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id DFD8961818; Wed, 31 Jan 2018 14:07:55 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id EDFDE61817; Wed, 31 Jan 2018 14:07:45 +0000 (UTC) Received: from forward105o.mail.yandex.net (forward105o.mail.yandex.net [37.140.190.183]) by lists.linaro.org (Postfix) with ESMTPS id 95EFB609D9 for ; Wed, 31 Jan 2018 14:02:07 +0000 (UTC) Received: from mxback9j.mail.yandex.net (mxback9j.mail.yandex.net [IPv6:2a02:6b8:0:1619::112]) by forward105o.mail.yandex.net (Yandex) with ESMTP id 602D44445074 for ; Wed, 31 Jan 2018 17:00:31 +0300 (MSK) Received: from smtp3o.mail.yandex.net (smtp3o.mail.yandex.net [2a02:6b8:0:1a2d::27]) by mxback9j.mail.yandex.net (nwsmtp/Yandex) with ESMTP id hD0YfZw8iV-0VI82Vog; Wed, 31 Jan 2018 17:00:31 +0300 Received: by smtp3o.mail.yandex.net (nwsmtp/Yandex) with ESMTPSA id LdNp02bKEL-0UEWuuCt; Wed, 31 Jan 2018 17:00:30 +0300 (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (Client certificate not present) From: Github ODP bot To: lng-odp@lists.linaro.org Date: Wed, 31 Jan 2018 17:00:25 +0300 Message-Id: <1517407226-19192-7-git-send-email-odpbot@yandex.ru> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1517407226-19192-1-git-send-email-odpbot@yandex.ru> References: <1517407226-19192-1-git-send-email-odpbot@yandex.ru> Github-pr-num: 406 Subject: [lng-odp] [PATCH CATERPILLAR v4 6/7] example: instrum: update DEPENDENCIES X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" From: Bogdan Pricope Describe configuration and requirements of code instrumentation library. Signed-off-by: Bogdan Pricope --- /** Email created from pull request 406 (bogdanPricope:cat_benchmark_pr) ** https://github.com/Linaro/odp/pull/406 ** Patch: https://github.com/Linaro/odp/pull/406.patch ** Base sha: 079b524277414f57411d3223563353bbdbc1a536 ** Merge commit sha: c25517810ea3389a28c0adb2fdde601eae684851 **/ DEPENDENCIES | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/DEPENDENCIES b/DEPENDENCIES index 008c4df4d..898132cdc 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -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= + $ 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 + $ ./bootstrap + $ ./configure --enable-code-instrum --with-papi-path= + $ 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= --with-code-instrum-profile= + +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:/lib:/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__.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= + + 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