From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <lma25@ecsmtp.ir.intel.com>
Received: from mga18.intel.com (mga18.intel.com [134.134.136.126])
 by dpdk.org (Postfix) with ESMTP id 8D1398E7F
 for <dev@dpdk.org>; Mon, 17 Sep 2018 15:30:30 +0200 (CEST)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga001.fm.intel.com ([10.253.24.23])
 by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 17 Sep 2018 06:30:29 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.53,385,1531810800"; d="scan'208";a="90778061"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
 by fmsmga001.fm.intel.com with ESMTP; 17 Sep 2018 06:30:24 -0700
Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com
 [10.237.217.45])
 by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id
 w8HDUNd6030936; Mon, 17 Sep 2018 14:30:23 +0100
Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1])
 by sivswdev01.ir.intel.com with ESMTP id w8HDUNJW026458;
 Mon, 17 Sep 2018 14:30:23 +0100
Received: (from lma25@localhost)
 by sivswdev01.ir.intel.com with LOCAL id w8HDUNE3026454;
 Mon, 17 Sep 2018 14:30:23 +0100
From: Liang Ma <liang.j.ma@intel.com>
To: david.hunt@intel.com
Cc: dev@dpdk.org, lei.a.yao@intel.com, ktraynor@redhat.com,
 john.geary@intel.com, Liang Ma <liang.j.ma@intel.com>
Date: Mon, 17 Sep 2018 14:30:15 +0100
Message-Id: <1537191016-26330-3-git-send-email-liang.j.ma@intel.com>
X-Mailer: git-send-email 1.7.7.4
In-Reply-To: <1537191016-26330-1-git-send-email-liang.j.ma@intel.com>
References: <1536070228-6545-1-git-send-email-liang.j.ma@intel.com>
 <1537191016-26330-1-git-send-email-liang.j.ma@intel.com>
Subject: [dpdk-dev] [PATCH v8 3/4] doc/guides/proguide/power-man: update the
	power API
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 17 Sep 2018 13:30:31 -0000

Update the document for empty poll API.

Signed-off-by: Liang Ma <liang.j.ma@intel.com>
---
 doc/guides/prog_guide/power_man.rst | 90 +++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index eba1cc6..056cb12 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -106,6 +106,96 @@ User Cases
 
 The power management mechanism is used to save power when performing L3 forwarding.
 
+
+Empty Poll API
+--------------
+
+Abstract
+~~~~~~~~
+
+For packet processing workloads such as DPDK polling is continuous.
+This means CPU cores always show 100% busy independent of how much work
+those cores are doing. It is critical to accurately determine how busy
+a core is hugely important for the following reasons:
+
+        * No indication of overload conditions
+        * User do not know how much real load is on a system meaning
+          resulted in wasted energy as no power management is utilized
+
+Compared to the original l3fwd-power design, instead of going to sleep
+after detecting an empty poll, the new mechanism just lowers the core frequency.
+As a result, the application does not stop polling the device, which leads
+to improved handling of bursts of traffic.
+
+When the system become busy, the empty poll mechanism can also increase the core
+frequency (including turbo) to do best effort for intensive traffic. This gives
+us more flexible and balanced traffic awareness over the standard l3fwd-power
+application.
+
+
+Proposed Solution
+~~~~~~~~~~~~~~~~~
+The proposed solution focuses on how many times empty polls are executed.
+The less the number of empty polls, means current core is busy with processing
+workload, therefore, the higher frequency is needed. The high empty poll number
+indicates the current core not doing any real work therefore, we can lower the
+frequency to safe power.
+
+In the current implementation, each core has 1 empty-poll counter which assume
+1 core is dedicated to 1 queue. This will need to be expanded in the future to
+support multiple queues per core.
+
+Power state definition:
+^^^^^^^^^^^^^^^^^^^^^^^
+
+* LOW:  Not currently used, reserved for future use.
+
+* MED:  the frequency is used to process modest traffic workload.
+
+* HIGH: the frequency is used to process busy traffic workload.
+
+There are two phases to establish the power management system:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* Initialization/Training phase. The training phase is necessary
+  in order to figure out the system polling baseline numbers from
+  idle to busy. The highest poll count will be during idle, where all
+  polls are empty. These poll counts will be different between
+  systems due to the many possible processor micro-arch, cache
+  and device configurations, hence the training phase.
+  In the training phase, traffic is blocked so the training algorithm
+  can average the empty-poll numbers for the LOW, MED and
+  HIGH  power states in order to create a baseline.
+  The core's counter are collected every 10ms, and the Training
+  phase will take 2 seconds.
+  Training is disabled as default configuration.
+  The default parameter is applied. Simple App still can trigger
+  training if that's needed
+
+* Normal phase. When the training phase is complete, traffic is
+  started. The run-time poll counts are compared with the
+  baseline and the decision will be taken to move to MED power
+  state or HIGH power state. The counters are calculated every
+  10ms.
+
+
+API Overview for Empty Poll Power Management
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* **State Init**: initialize the power management system.
+
+* **State Free**: free the resource hold by power management system.
+
+* **Update Empty Poll Counter**: update the empty poll counter.
+
+* **Update Valid Poll Counter**: update the valid poll counter.
+
+* **Set the Fequence Index**: update the power state/frequency mapping.
+
+* **Detect empty poll state change**: empty poll state change detection algorithm then take action.
+
+User Cases
+----------
+The mechanism can applied to any device which is based on polling. e.g. NIC, FPGA.
+
 References
 ----------
 
-- 
2.7.5