From 345e335e2476f56c50b36a74f91bf57325251555 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 23 Feb 2015 10:23:44 +0100 Subject: [PATCH] some more documentation to the energy plugin --- src/surf/plugins/energy.cpp | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/src/surf/plugins/energy.cpp b/src/surf/plugins/energy.cpp index 3badfdff6b..4400121b72 100644 --- a/src/surf/plugins/energy.cpp +++ b/src/surf/plugins/energy.cpp @@ -10,7 +10,39 @@ /** @addtogroup SURF_plugin_energy * * - * This is the energy plugin, enabling to account not only for computation time, but also for the dissipated energy in the simulated platform. + * This is the energy plugin, enabling to account not only for computation time, + * but also for the dissipated energy in the simulated platform. + * + * The energy consumption of a CPU depends directly of its current load. Specify that consumption in your platform file as follows: + * + * \beginverbatim + * + * + * + * + * \endverbatim + * + * The first property means that when your host is up and running, but without anything to do, it will dissipate 100 Watts. + * If it's fully loaded, it will dissipate 200 Watts. If its load is at 50%, then it will dissipate 150 Watts. + * The second property means that when your host is turned off, it will dissipate only 10 Watts (please note that these values are arbitrary). + * + * If your CPU is using pstates, then you can provide one consumption interval per pstate. + * + * \beginverbatim + * + * + * + * + * \endverbatim + * + * That host has 3 levels of performance with the following performance: 100 Mflop/s, 50 Mflop/s or 20 Mflop/s. + * It starts at pstate 0 (ie, at 100 Mflop/s). In this case, you have to specify one interval per pstate in the watt_per_state property. + * In this example, the idle consumption is 95 Watts, 93 Watts and 90 Watts in each pstate while the CPU burn consumption are at 200 Watts, + * 170 Watts and 150 Watts respectively. + * + * To change the pstate of a given CPU, use the following functions: #MSG_host_get_pstate_number, #MSG_host_set_pstate(), #MSG_host_get_power_peak_at(). + * + * To get the amount of dissipated energy, use the following function: #MSG_host_get_consumed_energy(). */ XBT_LOG_EXTERNAL_CATEGORY(surf_kernel); -- 2.20.1