S4U_Simulation.h
1 
11 #ifndef WRENCH_S4U_SIMULATION_H
12 #define WRENCH_S4U_SIMULATION_H
13 
14 #include <set>
15 #include <simgrid/s4u.hpp>
16 #include <simgrid/kernel/routing/ClusterZone.hpp>
17 
18 namespace wrench {
19 
20 
21  /***********************/
23  /***********************/
24 
29 
30  public:
32  static constexpr double DEFAULT_RAM = (1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0); // 1 PiB
33 
34  public:
35  void initialize(int *argc, char **argv);
36  void setupPlatform(std::string&);
37  void runSimulation();
38  static double getClock();
39  static std::string getHostName();
40  static bool hostExists(std::string hostname);
41  static bool linkExists(std::string linkname);
42  static std::vector<std::string> getRoute(std::string &src_host, std::string &dst_host);
43  static unsigned int getHostNumCores(std::string hostname);
44  static unsigned int getNumCores();
45  static double getHostFlopRate(std::string hostname);
46  static bool isHostOn(std::string hostname);
47  static void turnOffHost(std::string hostname);
48  static void turnOnHost(std::string hostname);
49  static bool isLinkOn(std::string linkname);
50  static void turnOffLink(std::string linkname);
51  static void turnOnLink(std::string linkname);
52  static double getFlopRate();
53  static double getHostMemoryCapacity(std::string hostname);
54  static double getMemoryCapacity();
55  static void compute(double);
56  static void sleep(double);
57  static void computeZeroFlop();
58  static void writeToDisk(double num_bytes, std::string hostname, std::string mount_point);
59  static void readFromDisk(double num_bytes, std::string hostname, std::string mount_point);
60  static void readFromDiskAndWriteToDiskConcurrently(double num_bytes_to_read, double num_bytes_to_write,
61  std::string hostname,
62  std::string read_mount_point,
63  std::string write_mount_point);
64 
65  static double getDiskCapacity(std::string hostname, std::string mount_point);
66  static std::vector<std::string> getDisks(std::string hostname);
67  static bool hostHasMountPoint(std::string hostname, std::string mount_point);
68 
69  void checkLinkBandwidths();
70 
71  static void yield();
72  static std::string getHostProperty(std::string hostname, std::string property_name);
73 
74  //start energy related calls
75  static double getEnergyConsumedByHost(const std::string &hostname);
76 // static double getTotalEnergyConsumed(const std::vector<std::string> &hostnames);
77  static void setPstate(const std::string &hostname, int pstate);
78  static int getNumberofPstates(const std::string &hostname);
79  static int getCurrentPstate(const std::string &hostname);
80  static double getMinPowerConsumption(const std::string &hostname);
81  static double getMaxPowerConsumption(const std::string &hostname);
82  static std::vector<int> getListOfPstates(const std::string &hostname);
83  //end energy related calls
84 
85  bool isInitialized();
86  bool isPlatformSetup();
87  static std::vector<std::string> getAllHostnames();
88  static std::vector<std::string> getAllLinknames();
89  static double getLinkBandwidth(std::string name);
90  static double getLinkUsage(std::string name);
91  static std::map<std::string, std::vector<std::string>> getAllHostnamesByCluster();
92  void shutdown();
93 
94  private:
95  static double getHostMemoryCapacity(simgrid::s4u::Host *host);
96  simgrid::s4u::Engine *engine;
97  bool initialized = false;
98  bool platform_setup = false;
99 
100  };
101 
102  /***********************/
104  /***********************/
105 };
106 
107 #endif //WRENCH_S4U_SIMULATION_H
static double getLinkBandwidth(std::string name)
Get a link's bandwidth.
Definition: S4U_Simulation.cpp:162
static double getDiskCapacity(std::string hostname, std::string mount_point)
Gets the capacity of a disk attached to some host for a given mount point.
Definition: S4U_Simulation.cpp:886
static void readFromDiskAndWriteToDiskConcurrently(double num_bytes_to_read, double num_bytes_to_write, std::string hostname, std::string read_mount_point, std::string write_mount_point)
Read from a local disk and write to a local disk concurrently.
Definition: S4U_Simulation.cpp:431
static int getCurrentPstate(const std::string &hostname)
Get the current power state of a host.
Definition: S4U_Simulation.cpp:687
static std::vector< std::string > getAllLinknames()
Get the list of link names.
Definition: S4U_Simulation.cpp:146
static void turnOffHost(std::string hostname)
Turn off a host.
Definition: S4U_Simulation.cpp:295
void initialize(int *argc, char **argv)
Initialize the Simgrid simulation.
Definition: S4U_Simulation.cpp:34
static bool linkExists(std::string linkname)
Determines whether a link exists for a given linkname.
Definition: S4U_Simulation.cpp:228
static double getHostFlopRate(std::string hostname)
Get the flop rate of a host.
Definition: S4U_Simulation.cpp:264
static std::map< std::string, std::vector< std::string > > getAllHostnamesByCluster()
Get the by-cluster structure of the platform.
Definition: S4U_Simulation.cpp:194
static void setPstate(const std::string &hostname, int pstate)
Set the power state of the host.
Definition: S4U_Simulation.cpp:639
static std::vector< std::string > getRoute(std::string &src_host, std::string &dst_host)
Get the list of link names on the route between two hosts.
Definition: S4U_Simulation.cpp:856
static int getNumberofPstates(const std::string &hostname)
Get the total number of power states of a host.
Definition: S4U_Simulation.cpp:666
static double getFlopRate()
Get the flop rate of the current host.
Definition: S4U_Simulation.cpp:371
static void turnOffLink(std::string linkname)
Turn off a link.
Definition: S4U_Simulation.cpp:341
static std::vector< int > getListOfPstates(const std::string &hostname)
Get the list of power states available for a host.
Definition: S4U_Simulation.cpp:755
static double getEnergyConsumedByHost(const std::string &hostname)
Get the energy consumed by the host up to now.
Definition: S4U_Simulation.cpp:591
static double getMemoryCapacity()
Get the memory_manager_service capacity of the current host.
Definition: S4U_Simulation.cpp:533
static unsigned int getNumCores()
Get the number of cores of the current host.
Definition: S4U_Simulation.cpp:252
void setupPlatform(std::string &)
Initialize the simulated platform. Must only be called once.
Definition: S4U_Simulation.cpp:100
Definition: Alarm.cpp:20
static void compute(double)
Simulates a computation on host on which the calling actor is running.
Definition: S4U_Simulation.cpp:388
static void computeZeroFlop()
Compute zero flop, which take zero time but will block if the host's pstate has a zero flop/sec speed...
Definition: S4U_Simulation.cpp:782
static bool hostHasMountPoint(std::string hostname, std::string mount_point)
Determines whether a mount point is defined at a host.
Definition: S4U_Simulation.cpp:825
void shutdown()
Shutdown the simulation.
Definition: S4U_Simulation.cpp:74
bool isPlatformSetup()
Returns true if S4U_Simulation::setupPlatform() has been called successfully previously.
Definition: S4U_Simulation.cpp:54
static void turnOnLink(std::string linkname)
Turn on a link.
Definition: S4U_Simulation.cpp:356
bool isInitialized()
Returns true if S4U_Simulation::initialize() has been called successfully previously.
Definition: S4U_Simulation.cpp:46
static double getMinPowerConsumption(const std::string &hostname)
Get the minimum power consumption (i.e., idling) for a host at its current pstate.
Definition: S4U_Simulation.cpp:709
static std::string getHostName()
Get the hostname on which the calling actor is running.
Definition: S4U_Simulation.cpp:118
static unsigned int getHostNumCores(std::string hostname)
Get the number of cores of a host.
Definition: S4U_Simulation.cpp:240
static std::vector< std::string > getDisks(std::string hostname)
Gets set of disks, i.e., mount points, available at a host.
Definition: S4U_Simulation.cpp:796
static void yield()
Simulates a yield.
Definition: S4U_Simulation.cpp:512
static void writeToDisk(double num_bytes, std::string hostname, std::string mount_point)
Simulates a disk write.
Definition: S4U_Simulation.cpp:399
static void sleep(double)
Simulates a sleep.
Definition: S4U_Simulation.cpp:505
static std::vector< std::string > getAllHostnames()
Get the list of physical hostnames.
Definition: S4U_Simulation.cpp:128
static void readFromDisk(double num_bytes, std::string hostname, std::string mount_point)
Simulates a disk read.
Definition: S4U_Simulation.cpp:475
static std::string getHostProperty(std::string hostname, std::string property_name)
Get the property associated to the host specified in the platform file.
Definition: S4U_Simulation.cpp:573
static void turnOnHost(std::string hostname)
Turn on a host.
Definition: S4U_Simulation.cpp:310
static bool isLinkOn(std::string linkname)
Returns whether a link is on or not.
Definition: S4U_Simulation.cpp:326
static double getMaxPowerConsumption(const std::string &hostname)
Get the maximum power consumption (i.e., 100% load) for a host at its current pstate.
Definition: S4U_Simulation.cpp:731
static double getLinkUsage(std::string name)
Get a link's bandwidth usage.
Definition: S4U_Simulation.cpp:178
void checkLinkBandwidths()
Method to check that all link bandwidths are >0.
Definition: S4U_Simulation.cpp:83
static double getClock()
Get the current simulation date.
Definition: S4U_Simulation.cpp:380
static bool isHostOn(std::string hostname)
Returns whether a host is on or not.
Definition: S4U_Simulation.cpp:280
Wrappers around S4U's basic simulation methods.
Definition: S4U_Simulation.h:28
void runSimulation()
Start the simulation.
Definition: S4U_Simulation.cpp:63
static constexpr double DEFAULT_RAM
The ram capacity of a physical host whenever not specified in the platform description file.
Definition: S4U_Simulation.h:32
static double getHostMemoryCapacity(std::string hostname)
Get the memory_manager_service capacity of a host given a hostname.
Definition: S4U_Simulation.cpp:521
static bool hostExists(std::string hostname)
Determines whether a host exists for a given hostname.
Definition: S4U_Simulation.cpp:219