Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[Energy] Mark sg_host_get_idle_consumption as deprecated
[simgrid.git] / include / simgrid / plugins / energy.h
1 /* Copyright (c) 2016-2019. 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 <xbt/base.h>
10 #include <simgrid/forward.h>
11
12 SG_BEGIN_DECL()
13
14 XBT_PUBLIC void sg_host_energy_plugin_init();
15 XBT_PUBLIC void sg_host_energy_update_all();
16 XBT_PUBLIC double sg_host_get_consumed_energy(sg_host_t host);
17 XBT_ATTRIB_DEPRECATED_v327("Please use !sg_host_get_idle_consumption_at()") \
18   XBT_PUBLIC double sg_host_get_idle_consumption(sg_host_t host); /* deprecated */
19 XBT_PUBLIC double sg_host_get_idle_consumption_at(sg_host_t host, int pstate);
20 XBT_PUBLIC double sg_host_get_wattmin_at(sg_host_t host, int pstate);
21 XBT_PUBLIC double sg_host_get_wattmax_at(sg_host_t host, int pstate);
22 XBT_PUBLIC double sg_host_get_power_range_slope_at(sg_host_t host, int pstate);
23 XBT_PUBLIC double sg_host_get_current_consumption(sg_host_t host);
24
25 XBT_PUBLIC void sg_link_energy_plugin_init();
26 XBT_PUBLIC double sg_link_get_consumed_energy(sg_link_t link);
27
28 XBT_PUBLIC int sg_link_energy_is_inited();
29
30 #define MSG_host_energy_plugin_init() sg_host_energy_plugin_init()
31 #define MSG_host_get_consumed_energy(host) sg_host_get_consumed_energy(host)
32 #define MSG_host_get_idle_consumption_at(host,pstate) sg_host_get_idle_consumption_at((host), (pstate))
33 #define MSG_host_get_wattmin_at(host,pstate) sg_host_get_wattmin_at((host), (pstate))
34 #define MSG_host_get_wattmax_at(host,pstate) sg_host_get_wattmax_at((host), (pstate))
35 #define MSG_host_get_power_range_slope_at(host,pstate) sg_host_get_power_range_slope_at((host), (pstate))
36 #define MSG_host_get_current_consumption(host) sg_host_get_current_consumption(host)
37
38 SG_END_DECL()
39
40 #endif