Update programming guide and sample application l3fwd-power document for PMD power management
Signed-off-by: Liang Ma <liang.j...@intel.com> --- doc/guides/prog_guide/power_man.rst | 40 +++++++++++++++++++ .../sample_app_ug/l3_forward_power_man.rst | 15 ++++++- 2 files changed, 54 insertions(+), 1 deletion(-) diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst index 0a3755a901..c95b948874 100644 --- a/doc/guides/prog_guide/power_man.rst +++ b/doc/guides/prog_guide/power_man.rst @@ -188,6 +188,43 @@ API Overview for Empty Poll Power Management * **Detect empty poll state change**: empty poll state change detection algorithm then take action. +PMD Power Management API +------------------------ + +Abstract +~~~~~~~~ +Given existing power management mechanism, developer need change application design or code to use it. +In order to solve the problem, it's very helpful to make the design transparent to application. +The proposed solution is to leverage RX_CALLBACK mechanism which allow three different power management +methodology co exist. The trigger condition is empty poll number beyond defined threshold. + + * umwait/umonitor + + The new umwait/umonitor instruction monitoring the wake address then transfer processor to sub-state. + Once the content of address is changed, the processor will be wake up from the sub-state. Timeout is + setup as well, in case, there is no wake event happen, processor still will wake up after timeout + timer expired. + + * Pause instruction + + Instead of move the core into deeper C state, this lightweight method use Pause instruction + to relief the processor from busy polling. + + * Frequency Scaling + + Reuse exist rte power library to scale up/down core frequency + depend on traffic volume. + +The proposed solution support multiple port and each port can map to multiple core. But 1 core only can map +1 queue(regardless which port). In theory, each queue belongs to same port can apply different power scheme. +It's strongly recommend to use same power scheme for all queues belong to same port. + +API Overview for PMD Power Management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* **Queue Enable**: Enable specific power scheme for certain queue/port/core + +* **Queue Disable**: Disable power scheme for certain queue/port/core + User Cases ---------- The mechanism can applied to any device which is based on polling. e.g. NIC, FPGA. @@ -200,3 +237,6 @@ References * The :doc:`../sample_app_ug/vm_power_management` chapter in the :doc:`../sample_app_ug/index` section. + +* The :doc:`../sample_app_ug/rxtx_callbacks` + chapter in the :doc:`../sample_app_ug/index` section. diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst index 0cc6f2e62e..82f9ac849c 100644 --- a/doc/guides/sample_app_ug/l3_forward_power_man.rst +++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst @@ -107,7 +107,9 @@ where, * --empty-poll: Traffic Aware power management. See below for details -* --telemetry: Telemetry mode. +* --telemetry: Telemetry mode. + +* --pmd-mgmt: PMD power management mode. See :doc:`l3_forward` for details. The L3fwd-power example reuses the L3fwd command line options. @@ -459,3 +461,14 @@ reference cycles and accordingly busy rate is set to either 0% or The new stats ``empty_poll`` , ``full_poll`` and ``busy_percent`` can be viewed by running the script ``/usertools/dpdk-telemetry-client.py`` and selecting the menu option ``Send for global Metrics``. + +PMD power management Mode +------------------------- + +The PMD power management mode support for ``l3fwd-power`` is a standalone mode, in this mode +``l3fwd-power`` does simple l3fwding along with enable the power saving scheme on specific +port/queue/lcore. Main purpose for this mode is to demonstrate how to use the PMD power management API. + +.. code-block:: console + + ./examples/l3fwd-power/build/l3fwd-power --pmd-mgmt -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" -- 2.17.1