Simulation.h
1 
11 #ifndef WRENCH_SIMULATION_H
12 #define WRENCH_SIMULATION_H
13 
14 #include <string>
15 #include <vector>
16 #include <nlohmann/json.hpp>
17 #include "Version.h"
18 
19 #include <wrench/simulation/SimulationOutput.h>
20 
21 
22 namespace wrench {
23 
24  class StorageService;
25  class Service;
26  class NetworkProximityService;
27  class FileRegistryService;
28  class EnergyMeterService;
29  class ComputeService;
30  class BatchComputeService;
31  class BareMetalComputeService;
32  class CloudComputeService;
33  class VirtualizedClusterComputeService;
34  class WMS;
35  class WorkflowFile;
36  class SimulationOutput;
37  class S4U_Simulation;
38  class FileLocation;
39 
45  class Simulation {
46 
47  public:
48  Simulation();
49 
50  ~Simulation();
51 
52  void init(int *, char **);
53 
54  void instantiatePlatform(std::string);
55 
56  static std::vector<std::string> getHostnameList();
57  static std::map<std::string, std::vector<std::string>> getHostnameListByCluster();
58  static double getHostMemoryCapacity(std::string hostname);
59  static unsigned long getHostNumCores(std::string hostname);
60  static double getHostFlopRate(std::string hostname);
61 
62  void launch();
63 
70  template <class T>
71  std::shared_ptr<T> add(T *t) {
72  auto s = std::shared_ptr<T>(t);
73  this->addService(s);
74  return s;
75  }
76 
78 
79  //start energy related calls
80  double getEnergyConsumed(const std::string &hostname);
81  std::map<std::string, double> getEnergyConsumed(const std::vector<std::string> &hostnames);
82 // double getEnergyTimestamp(const std::string &hostname, bool can_record = false);
83 
84  // pstate related calls
85  static int getNumberofPstates(const std::string &hostname);
86  static double getMinPowerConsumption(const std::string &hostname);
87  static double getMaxPowerConsumption(const std::string &hostname);
88  static std::vector<int> getListOfPstates(const std::string &hostname);
89 
90  void stageFile(WorkflowFile *file, std::shared_ptr<StorageService> ss);
91  void stageFile(WorkflowFile *file, std::shared_ptr<StorageService> ss, std::string directory_absolute_path);
92 
93  /***********************/
95  /***********************/
96  double getEnergyConsumed(const std::string &hostname, bool record_as_time_stamp);
97  std::map<std::string, double> getEnergyConsumed(const std::vector<std::string> &hostnames, bool record_as_time_stamps);
98 
99  static bool doesHostExist(std::string hostname);
100  static bool isHostOn(std::string hostname);
101  static void turnOnHost(std::string hostname);
102  static void turnOffHost(std::string hostname);
103  static bool isLinkOn(std::string linkname);
104  static void turnOnLink(std::string linkname);
105  static void turnOffLink(std::string linkname);
106 
107  // pstate related calls
108  void setPstate(const std::string &hostname, int pstate);
109  static int getCurrentPstate(const std::string &hostname);
110 
111  std::shared_ptr<ComputeService> startNewService(ComputeService *service);
112  std::shared_ptr<StorageService> startNewService(StorageService *service);
113  std::shared_ptr<NetworkProximityService> startNewService(NetworkProximityService *service);
114  std::shared_ptr<FileRegistryService> startNewService(FileRegistryService *service);
115 
116  static double getCurrentSimulatedDate();
117 
118  static void sleep(double duration);
119  static void compute(double flops);
120  /***********************/
122  /***********************/
123 
124  /***********************/
126  /***********************/
127  void readFromDisk(double num_bytes, std::string hostname, std::string mount_point);
128  void readFromDiskAndWriteToDiskConcurrently(double num_bytes_to_read, double num_bytes_to_write,
129  std::string hostname,
130  std::string read_mount_point,
131  std::string write_mount_point);
132  void writeToDisk(double num_bytes, std::string hostname, std::string mount_point);
133 
134  static double getMemoryCapacity();
135  static unsigned long getNumCores();
136  static double getFlopRate();
137  static std::string getHostName();
138  /***********************/
140  /***********************/
141 
142  private:
143  SimulationOutput output;
144 
145  std::unique_ptr<S4U_Simulation> s4u_simulation;
146 
147  std::set<std::shared_ptr<WMS>> wmses;
148 
149  std::set<std::shared_ptr<FileRegistryService>> file_registry_services;
150 
151  std::set<std::shared_ptr<EnergyMeterService>> energy_meter_services;
152 
153  std::set<std::shared_ptr<NetworkProximityService>> network_proximity_services;
154 
155  std::set<std::shared_ptr<ComputeService>> compute_services;
156 
157  std::set<std::shared_ptr<StorageService>> storage_services;
158 
159  static int unique_disk_sequence_number;
160 
161  void stageFile(WorkflowFile *file, std::shared_ptr<FileLocation> location);
162 
163  void platformSanityCheck();
164  void checkSimulationSetup();
165  bool isRunning();
166 
167  void startAllProcesses();
168  void addService(std::shared_ptr<ComputeService> service);
169  void addService(std::shared_ptr<StorageService> service);
170  void addService(std::shared_ptr<NetworkProximityService> service);
171  void addService(std::shared_ptr<WMS> service);
172  void addService(std::shared_ptr<FileRegistryService> service);
173  void addService(std::shared_ptr<EnergyMeterService> service);
174 
175  std::string getWRENCHVersionString() { return WRENCH_VERSION_STRING; }
176 
177  bool is_running = false;
178 
179  unsigned int on_state_change_callback_id;
180  };
181 
182 };
183 
184 #endif //WRENCH_SIMULATION_H
static std::map< std::string, std::vector< std::string > > getHostnameListByCluster()
Get the list of names of all the hosts in each cluster composing the platform.
Definition: Simulation.cpp:241
static double getMemoryCapacity()
Get the memory capacity of the host on which the calling process is running.
Definition: Simulation.cpp:749
std::shared_ptr< T > add(T *t)
Method to add a service to the simulation.
Definition: Simulation.h:71
static double getMinPowerConsumption(const std::string &hostname)
Get the minimum power consumption for the host (i.e., idling) at its current pstate.
Definition: Simulation.cpp:907
std::shared_ptr< ComputeService > startNewService(ComputeService *service)
Starts a new compute service during WMS execution (i.e., one that was not passed to Simulation::add()...
Definition: Simulation.cpp:929
static std::string getHostName()
Get the name of the host on which the calling process is running.
Definition: Simulation.cpp:773
void instantiatePlatform(std::string)
Instantiate a simulated platform.
Definition: Simulation.cpp:205
void readFromDisk(double num_bytes, std::string hostname, std::string mount_point)
Wrapper enabling timestamps for disk reads.
Definition: Simulation.cpp:576
static int getCurrentPstate(const std::string &hostname)
Get the current power state of a host.
Definition: Simulation.cpp:889
static bool isHostOn(std::string hostname)
Returns whether a host is on or not.
Definition: Simulation.cpp:700
A file registry service (a.k.a. replica catalog) that holds a database of which files are available a...
Definition: FileRegistryService.h:36
static void sleep(double duration)
Make the calling process sleep for a number of (simulated) seconds.
Definition: Simulation.cpp:781
static bool isLinkOn(std::string linkname)
Returns whether a link is on or not.
Definition: Simulation.cpp:725
The storage service base class.
Definition: StorageService.h:36
The compute service base class.
Definition: ComputeService.h:35
void setPstate(const std::string &hostname, int pstate)
Set the power state of the host.
Definition: Simulation.cpp:870
Definition: Alarm.cpp:20
static std::vector< int > getListOfPstates(const std::string &hostname)
Get the list of power states available for a host.
Definition: Simulation.cpp:898
static unsigned long getNumCores()
Get the number of cores of the host on which the calling process is running.
Definition: Simulation.cpp:757
static void compute(double flops)
Make the calling process compute.
Definition: Simulation.cpp:789
void launch()
Launch the simulation.
Definition: Simulation.cpp:250
static void turnOnLink(std::string linkname)
Turns on a link.
Definition: Simulation.cpp:741
void init(int *, char **)
Initialize the simulation, which parses out WRENCH-specific and SimGrid-specific command-line argumen...
Definition: Simulation.cpp:92
static void turnOffHost(std::string hostname)
Turns off a host.
Definition: Simulation.cpp:708
static double getHostMemoryCapacity(std::string hostname)
Get the memory capacity of a host given a hostname.
Definition: Simulation.cpp:673
static std::vector< std::string > getHostnameList()
Get the list of names of all the hosts in the platform.
Definition: Simulation.cpp:231
static unsigned long getHostNumCores(std::string hostname)
Get the number of cores of a host given a hostname.
Definition: Simulation.cpp:682
double getEnergyConsumed(const std::string &hostname)
Obtains the current energy consumption of a host.
Definition: Simulation.cpp:807
static bool doesHostExist(std::string hostname)
Wrapper for S4U_Simulation hostExists()
Definition: Simulation.cpp:656
Simulation()
Constructor.
Definition: Simulation.cpp:58
A class that provides basic simulation methods. Once the simulation object has been explicitly or imp...
Definition: Simulation.h:45
void stageFile(WorkflowFile *file, std::shared_ptr< StorageService > ss)
Stage a copy of a file at a storage service in the root of the (unique) mount point.
Definition: Simulation.cpp:509
~Simulation()
Destructor.
Definition: Simulation.cpp:75
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)
Wrapper enabling timestamps for concurrent disk read/writes.
Definition: Simulation.cpp:601
void writeToDisk(double num_bytes, std::string hostname, std::string mount_point)
Wrapper enabling timestamps for disk writes.
Definition: Simulation.cpp:636
static void turnOnHost(std::string hostname)
Turns on a host.
Definition: Simulation.cpp:716
static double getMaxPowerConsumption(const std::string &hostname)
Get the maximum power consumption for the host (i.e., 100% utilization) at its current pstate.
Definition: Simulation.cpp:916
static void turnOffLink(std::string linkname)
Turns off a link.
Definition: Simulation.cpp:733
static double getHostFlopRate(std::string hostname)
Get the flop rate of one core of a host given a hostname.
Definition: Simulation.cpp:691
static int getNumberofPstates(const std::string &hostname)
Get the total number of power states of a host.
Definition: Simulation.cpp:880
SimulationOutput & getOutput()
Get the simulation output object.
Definition: Simulation.cpp:797
A network proximity service that continuously estimates inter-host latencies and can be queried for s...
Definition: NetworkProximityService.h:26
A class that contains post-mortem simulation-generated data.
Definition: SimulationOutput.h:27
A data file used/produced by a WorkflowTask in a Workflow.
Definition: WorkflowFile.h:26
static double getCurrentSimulatedDate()
Get the current simulated date.
Definition: Simulation.cpp:664
static double getFlopRate()
Get the flop rate of one core of the host on which the calling process is running.
Definition: Simulation.cpp:765