include/simgrid/plugins/energy.h

   1 /* Copyright (c) 2016-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_PLUGINS_ENERGY_H_
   7 #define SIMGRID_PLUGINS_ENERGY_H_
   8
   9 #include <simgrid/config.h>
  10 #include <simgrid/forward.h>
  11 #include <xbt/base.h>
  12
  13 SG_BEGIN_DECL
  14
  15 XBT_PUBLIC void sg_host_energy_plugin_init();
  16 XBT_PUBLIC void sg_host_energy_update_all();
  17 XBT_PUBLIC double sg_host_get_consumed_energy(const_sg_host_t host);
  18 XBT_PUBLIC double sg_host_get_idle_consumption(const_sg_host_t host);
  19 XBT_PUBLIC double sg_host_get_idle_consumption_at(const_sg_host_t host, int pstate);
  20 XBT_PUBLIC double sg_host_get_wattmin_at(const_sg_host_t host, int pstate);
  21 XBT_PUBLIC double sg_host_get_wattmax_at(const_sg_host_t host, int pstate);
  22 XBT_PUBLIC double sg_host_get_power_range_slope_at(const_sg_host_t host, int pstate);
  23 XBT_PUBLIC double sg_host_get_current_consumption(const_sg_host_t host);
  24
  25 XBT_PUBLIC void sg_link_energy_plugin_init();
  26 XBT_PUBLIC double sg_link_get_consumed_energy(const_sg_link_t link);
  27
  28 XBT_PUBLIC int sg_link_energy_is_inited();
  29
  30 /** @ingroup plugin_link_energy_wifi
  31  *  @brief Initialize the wifi energy plugin */
  32 XBT_PUBLIC void sg_wifi_energy_plugin_init();
  33
  34 #if SIMGRID_HAVE_MSG
  35
  36 #define MSG_host_energy_plugin_init() sg_host_energy_plugin_init()
  37 #define MSG_host_get_consumed_energy(host) sg_host_get_consumed_energy(host)
  38 #define MSG_host_get_idle_consumption_at(host,pstate) sg_host_get_idle_consumption_at((host), (pstate))
  39 #define MSG_host_get_wattmin_at(host,pstate) sg_host_get_wattmin_at((host), (pstate))
  40 #define MSG_host_get_wattmax_at(host,pstate) sg_host_get_wattmax_at((host), (pstate))
  41 #define MSG_host_get_power_range_slope_at(host,pstate) sg_host_get_power_range_slope_at((host), (pstate))
  42 #define MSG_host_get_current_consumption(host) sg_host_get_current_consumption(host)
  43
  44 #endif // SIMGRID_HAVE_MSG
  45
  46 SG_END_DECL
  47
  48 #endif