src/s4u/s4u_Engine.cpp

   1 /* s4u::Engine Simulation Engine and global functions. */
   2
   3 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "mc/mc.h"
   9 #include "simgrid/kernel/routing/NetPoint.hpp"
  10 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
  11 #include "simgrid/s4u/Engine.hpp"
  12 #include "simgrid/s4u/Host.hpp"
  13 #include "simgrid/s4u/Mailbox.hpp"
  14 #include "simgrid/s4u/NetZone.hpp"
  15 #include "simgrid/s4u/Storage.hpp"
  16 #include "simgrid/simix.h"
  17 #include "src/simix/smx_private.hpp" // For access to simix_global->process_list
  18 #include "src/instr/instr_private.hpp"
  19 #include "src/kernel/EngineImpl.hpp"
  20 #include "src/surf/network_interface.hpp"
  21 #include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
  22
  23 #include <string>
  24
  25 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
  26
  27 namespace simgrid {
  28 namespace s4u {
  29 xbt::signal<void()> on_platform_creation;
  30 xbt::signal<void()> on_platform_created;
  31 xbt::signal<void()> on_simulation_end;
  32 xbt::signal<void(double)> on_time_advance;
  33 xbt::signal<void(void)> on_deadlock;
  34
  35 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
  36
  37 Engine::Engine(int* argc, char** argv)
  38 {
  39   xbt_assert(s4u::Engine::instance_ == nullptr,
  40              "It is currently forbidden to create more than one instance of s4u::Engine");
  41   TRACE_global_init();
  42   SIMIX_global_init(argc, argv);
  43
  44   pimpl                  = new kernel::EngineImpl();
  45   s4u::Engine::instance_ = this;
  46 }
  47
  48 Engine::~Engine()
  49 {
  50   delete pimpl;
  51   s4u::Engine::instance_ = nullptr;
  52 }
  53
  54 /** @brief Retrieve the engine singleton */
  55 Engine* Engine::get_instance()
  56 {
  57   if (s4u::Engine::instance_ == nullptr)
  58     return new Engine(0, nullptr);
  59   else
  60     return s4u::Engine::instance_;
  61 }
  62
  63 void Engine::shutdown()
  64 {
  65   delete s4u::Engine::instance_;
  66   s4u::Engine::instance_ = nullptr;
  67 }
  68
  69 double Engine::get_clock()
  70 {
  71   return SIMIX_get_clock();
  72 }
  73
  74 void Engine::load_platform(std::string platf)
  75 {
  76   SIMIX_create_environment(platf);
  77 }
  78
  79 void Engine::register_function(std::string name, int (*code)(int, char**))
  80 {
  81   SIMIX_function_register(name, code);
  82 }
  83 void Engine::register_default(int (*code)(int, char**))
  84 {
  85   SIMIX_function_register_default(code);
  86 }
  87 void Engine::load_deployment(std::string deploy)
  88 {
  89   SIMIX_launch_application(deploy);
  90 }
  91 /** @brief Returns the amount of hosts in the platform */
  92 size_t Engine::get_host_count()
  93 {
  94   return pimpl->hosts_.size();
  95 }
  96 /** @brief Fills the passed list with all hosts found in the platform
  97  *  @deprecated Please prefer Engine::getAllHosts()
  98  */
  99 void Engine::getHostList(std::vector<Host*>* list)
 100 {
 101   for (auto const& kv : pimpl->hosts_)
 102     list->push_back(kv.second);
 103 }
 104
 105 /** @brief Returns the list of all hosts found in the platform */
 106 std::vector<Host*> Engine::get_all_hosts()
 107 {
 108   std::vector<Host*> res;
 109   for (auto const& kv : pimpl->hosts_)
 110     res.push_back(kv.second);
 111   return res;
 112 }
 113
 114 std::vector<Host*> Engine::get_filtered_hosts(std::function<bool(Host*)> filter)
 115 {
 116   std::vector<Host*> hosts;
 117   for (auto const& kv : pimpl->hosts_) {
 118     if (filter(kv.second))
 119       hosts.push_back(kv.second);
 120   }
 121
 122   return hosts;
 123 }
 124
 125 void Engine::host_register(std::string name, simgrid::s4u::Host* host)
 126 {
 127   pimpl->hosts_[name] = host;
 128 }
 129
 130 void Engine::host_unregister(std::string name)
 131 {
 132   pimpl->hosts_.erase(name);
 133 }
 134
 135 /** @brief Find an host from its name.
 136  *
 137  *  @throw std::invalid_argument if the searched host does not exist.
 138  */
 139 simgrid::s4u::Host* Engine::host_by_name(std::string name)
 140 {
 141   if (pimpl->hosts_.find(name) == pimpl->hosts_.end())
 142     throw std::invalid_argument(std::string("Host not found: ") + name);
 143   return pimpl->hosts_.at(name);
 144 }
 145
 146 /** @brief Find an host from its name (or nullptr if that host does not exist) */
 147 simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
 148 {
 149   auto host = pimpl->hosts_.find(name);
 150   return host == pimpl->hosts_.end() ? nullptr : host->second;
 151 }
 152
 153 /** @brief Find a link from its name.
 154  *
 155  *  @throw std::invalid_argument if the searched link does not exist.
 156  */
 157 simgrid::s4u::Link* Engine::link_by_name(std::string name)
 158 {
 159   if (pimpl->links_.find(name) == pimpl->links_.end())
 160     throw std::invalid_argument(std::string("Link not found: ") + name);
 161
 162   return pimpl->links_.at(name);
 163 }
 164
 165 /** @brief Find an link from its name (or nullptr if that link does not exist) */
 166 simgrid::s4u::Link* Engine::link_by_name_or_null(std::string name)
 167 {
 168   auto link = pimpl->links_.find(name);
 169   return link == pimpl->links_.end() ? nullptr : link->second;
 170 }
 171
 172 void Engine::link_register(std::string name, simgrid::s4u::Link* link)
 173 {
 174   pimpl->links_[name] = link;
 175 }
 176
 177 void Engine::link_unregister(std::string name)
 178 {
 179   pimpl->links_.erase(name);
 180 }
 181
 182 /** @brief Returns the amount of storages in the platform */
 183 size_t Engine::get_storage_count()
 184 {
 185   return pimpl->storages_.size();
 186 }
 187
 188 /** @brief Returns the list of all storages found in the platform */
 189 std::vector<Storage*> Engine::get_all_storages()
 190 {
 191   std::vector<Storage*> res;
 192   for (auto const& kv : pimpl->storages_)
 193     res.push_back(kv.second);
 194   return res;
 195 }
 196
 197 /** @brief Find a storage from its name.
 198  *
 199  *  @throw std::invalid_argument if the searched storage does not exist.
 200  */
 201 simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
 202 {
 203   if (pimpl->links_.find(name) == pimpl->links_.end())
 204     throw std::invalid_argument(std::string("Storage not found: ") + name);
 205
 206   return pimpl->storages_.at(name);
 207 }
 208
 209 /** @brief Find a storage from its name (or nullptr if that storage does not exist) */
 210 simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
 211 {
 212   auto storage = pimpl->storages_.find(name);
 213   return storage == pimpl->storages_.end() ? nullptr : storage->second;
 214 }
 215
 216 void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
 217 {
 218   pimpl->storages_[name] = storage;
 219 }
 220
 221 void Engine::storage_unregister(std::string name)
 222 {
 223   pimpl->storages_.erase(name);
 224 }
 225
 226 /** @brief Returns the amount of links in the platform */
 227 size_t Engine::get_link_count()
 228 {
 229   return pimpl->links_.size();
 230 }
 231
 232 /** @brief Returns the list of all links found in the platform */
 233 std::vector<Link*> Engine::get_all_links()
 234 {
 235   std::vector<Link*> res;
 236   for (auto const& kv : pimpl->links_)
 237     res.push_back(kv.second);
 238   return res;
 239 }
 240
 241 std::vector<Link*> Engine::get_filtered_links(std::function<bool(Link*)> filter)
 242 {
 243   std::vector<Link*> filtered_list;
 244   for (auto const& kv : pimpl->links_)
 245     if (filter(kv.second))
 246       filtered_list.push_back(kv.second);
 247   return filtered_list;
 248 }
 249
 250 size_t Engine::get_actor_count()
 251 {
 252   return simix_global->process_list.size();
 253 }
 254
 255 std::vector<ActorPtr> Engine::get_all_actors()
 256 {
 257   std::vector<ActorPtr> actor_list;
 258   actor_list.push_back(simgrid::s4u::Actor::self());
 259   for (auto& kv : simix_global->process_list) {
 260     actor_list.push_back(kv.second->iface());
 261   }
 262   return actor_list;
 263 }
 264
 265 std::vector<ActorPtr> Engine::get_filtered_actors(std::function<bool(ActorPtr)> filter)
 266 {
 267   std::vector<ActorPtr> actor_list;
 268   for (auto& kv : simix_global->process_list) {
 269     if (filter(kv.second->iface()))
 270       actor_list.push_back(kv.second->iface());
 271   }
 272   return actor_list;
 273 }
 274
 275 void Engine::run()
 276 {
 277   /* Clean IO before the run */
 278   fflush(stdout);
 279   fflush(stderr);
 280
 281   if (MC_is_active()) {
 282     MC_run();
 283   } else {
 284     SIMIX_run();
 285   }
 286 }
 287
 288 /** @brief Retrieve the root netzone, containing all others */
 289 s4u::NetZone* Engine::get_netzone_root()
 290 {
 291   return pimpl->netzone_root_->get_iface();
 292 }
 293 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
 294 void Engine::set_netzone_root(s4u::NetZone* netzone)
 295 {
 296   xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
 297   pimpl->netzone_root_ = netzone->get_impl();
 298 }
 299
 300 static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::string name)
 301 {
 302   if (current->get_name() == name)
 303     return current;
 304
 305   for (auto const& elem : current->get_children()) {
 306     simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
 307     if (tmp != nullptr) {
 308       return tmp;
 309     }
 310   }
 311   return nullptr;
 312 }
 313
 314 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
 315 NetZone* Engine::netzone_by_name_or_null(std::string name)
 316 {
 317   return netzone_by_name_recursive(get_netzone_root(), name);
 318 }
 319
 320 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
 321 simgrid::kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(std::string name)
 322 {
 323   auto netp = pimpl->netpoints_.find(name);
 324   return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
 325 }
 326
 327 /** @brief Fill the provided vector with all existing netpoints */
 328 void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* list)
 329 {
 330   for (auto const& kv : pimpl->netpoints_)
 331     list->push_back(kv.second);
 332 }
 333 std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
 334 {
 335   std::vector<simgrid::kernel::routing::NetPoint*> res;
 336   for (auto const& kv : pimpl->netpoints_)
 337     res.push_back(kv.second);
 338   return res;
 339 }
 340
 341 /** @brief Register a new netpoint to the system */
 342 void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point)
 343 {
 344   // simgrid::simix::simcall([&]{ FIXME: this segfaults in set_thread
 345   pimpl->netpoints_[point->get_name()] = point;
 346   // });
 347 }
 348 /** @brief Unregister a given netpoint */
 349 void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point)
 350 {
 351   simgrid::simix::simcall([this, point] {
 352     pimpl->netpoints_.erase(point->get_name());
 353     delete point;
 354   });
 355 }
 356
 357 bool Engine::is_initialized()
 358 {
 359   return Engine::instance_ != nullptr;
 360 }
 361 void Engine::set_config(std::string str)
 362 {
 363   simgrid::config::set_parse(std::move(str));
 364 }
 365 } // namespace s4u
 366 } // namespace simgrid
 367
 368 /* **************************** Public C interface *************************** */
 369 void sg_engine_load_platform(const char* file)
 370 {
 371   simgrid::s4u::Engine::get_instance()->load_platform(file);
 372 }
 373
 374 void sg_engine_load_deployment(const char* file)
 375 {
 376   simgrid::s4u::Engine::get_instance()->load_deployment(file);
 377 }
 378 void sg_engine_run()
 379 {
 380   simgrid::s4u::Engine::get_instance()->run();
 381 }
 382 void sg_engine_register_function(const char* name, int (*code)(int, char**))
 383 {
 384   simgrid::s4u::Engine::get_instance()->register_function(name, code);
 385 }
 386 void sg_engine_register_default(int (*code)(int, char**))
 387 {
 388   simgrid::s4u::Engine::get_instance()->register_default(code);
 389 }
 390 double sg_engine_get_clock()
 391 {
 392   return simgrid::s4u::Engine::get_clock();
 393 }