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_function(std::string name, void (*code)(std::vector<std::string>))
  84 {
  85   SIMIX_function_register(name, code);
  86 }
  87 void Engine::register_default(int (*code)(int, char**))
  88 {
  89   SIMIX_function_register_default(code);
  90 }
  91 void Engine::load_deployment(std::string deploy)
  92 {
  93   SIMIX_launch_application(deploy);
  94 }
  95 /** @brief Returns the amount of hosts in the platform */
  96 size_t Engine::get_host_count()
  97 {
  98   return pimpl->hosts_.size();
  99 }
 100
 101 std::vector<Host*> Engine::get_all_hosts()
 102 {
 103   std::vector<Host*> res;
 104   for (auto const& kv : pimpl->hosts_)
 105     res.push_back(kv.second);
 106   return res;
 107 }
 108
 109 std::vector<Host*> Engine::get_filtered_hosts(std::function<bool(Host*)> filter)
 110 {
 111   std::vector<Host*> hosts;
 112   for (auto const& kv : pimpl->hosts_) {
 113     if (filter(kv.second))
 114       hosts.push_back(kv.second);
 115   }
 116
 117   return hosts;
 118 }
 119
 120 void Engine::host_register(std::string name, simgrid::s4u::Host* host)
 121 {
 122   pimpl->hosts_[name] = host;
 123 }
 124
 125 void Engine::host_unregister(std::string name)
 126 {
 127   pimpl->hosts_.erase(name);
 128 }
 129
 130 /** @brief Find an host from its name.
 131  *
 132  *  @throw std::invalid_argument if the searched host does not exist.
 133  */
 134 simgrid::s4u::Host* Engine::host_by_name(std::string name)
 135 {
 136   if (pimpl->hosts_.find(name) == pimpl->hosts_.end())
 137     throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
 138   return pimpl->hosts_.at(name);
 139 }
 140
 141 /** @brief Find an host from its name (or nullptr if that host does not exist) */
 142 simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
 143 {
 144   auto host = pimpl->hosts_.find(name);
 145   return host == pimpl->hosts_.end() ? nullptr : host->second;
 146 }
 147
 148 /** @brief Find a link from its name.
 149  *
 150  *  @throw std::invalid_argument if the searched link does not exist.
 151  */
 152 simgrid::s4u::Link* Engine::link_by_name(std::string name)
 153 {
 154   if (pimpl->links_.find(name) == pimpl->links_.end())
 155     throw std::invalid_argument(std::string("Link not found: ") + name);
 156
 157   return pimpl->links_.at(name);
 158 }
 159
 160 /** @brief Find an link from its name (or nullptr if that link does not exist) */
 161 simgrid::s4u::Link* Engine::link_by_name_or_null(std::string name)
 162 {
 163   auto link = pimpl->links_.find(name);
 164   return link == pimpl->links_.end() ? nullptr : link->second;
 165 }
 166
 167 void Engine::link_register(std::string name, simgrid::s4u::Link* link)
 168 {
 169   pimpl->links_[name] = link;
 170 }
 171
 172 void Engine::link_unregister(std::string name)
 173 {
 174   pimpl->links_.erase(name);
 175 }
 176
 177 /** @brief Returns the amount of storages in the platform */
 178 size_t Engine::get_storage_count()
 179 {
 180   return pimpl->storages_.size();
 181 }
 182
 183 /** @brief Returns the list of all storages found in the platform */
 184 std::vector<Storage*> Engine::get_all_storages()
 185 {
 186   std::vector<Storage*> res;
 187   for (auto const& kv : pimpl->storages_)
 188     res.push_back(kv.second);
 189   return res;
 190 }
 191
 192 /** @brief Find a storage from its name.
 193  *
 194  *  @throw std::invalid_argument if the searched storage does not exist.
 195  */
 196 simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
 197 {
 198   if (pimpl->storages_.find(name) == pimpl->storages_.end())
 199     throw std::invalid_argument(std::string("Storage not found: ") + name);
 200
 201   return pimpl->storages_.at(name);
 202 }
 203
 204 /** @brief Find a storage from its name (or nullptr if that storage does not exist) */
 205 simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
 206 {
 207   auto storage = pimpl->storages_.find(name);
 208   return storage == pimpl->storages_.end() ? nullptr : storage->second;
 209 }
 210
 211 void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
 212 {
 213   pimpl->storages_[name] = storage;
 214 }
 215
 216 void Engine::storage_unregister(std::string name)
 217 {
 218   pimpl->storages_.erase(name);
 219 }
 220
 221 /** @brief Returns the amount of links in the platform */
 222 size_t Engine::get_link_count()
 223 {
 224   return pimpl->links_.size();
 225 }
 226
 227 /** @brief Returns the list of all links found in the platform */
 228 std::vector<Link*> Engine::get_all_links()
 229 {
 230   std::vector<Link*> res;
 231   for (auto const& kv : pimpl->links_)
 232     res.push_back(kv.second);
 233   return res;
 234 }
 235
 236 std::vector<Link*> Engine::get_filtered_links(std::function<bool(Link*)> filter)
 237 {
 238   std::vector<Link*> filtered_list;
 239   for (auto const& kv : pimpl->links_)
 240     if (filter(kv.second))
 241       filtered_list.push_back(kv.second);
 242   return filtered_list;
 243 }
 244
 245 size_t Engine::get_actor_count()
 246 {
 247   return simix_global->process_list.size();
 248 }
 249
 250 std::vector<ActorPtr> Engine::get_all_actors()
 251 {
 252   std::vector<ActorPtr> actor_list;
 253   actor_list.push_back(simgrid::s4u::Actor::self());
 254   for (auto& kv : simix_global->process_list) {
 255     actor_list.push_back(kv.second->iface());
 256   }
 257   return actor_list;
 258 }
 259
 260 std::vector<ActorPtr> Engine::get_filtered_actors(std::function<bool(ActorPtr)> filter)
 261 {
 262   std::vector<ActorPtr> actor_list;
 263   for (auto& kv : simix_global->process_list) {
 264     if (filter(kv.second->iface()))
 265       actor_list.push_back(kv.second->iface());
 266   }
 267   return actor_list;
 268 }
 269
 270 void Engine::run()
 271 {
 272   /* Clean IO before the run */
 273   fflush(stdout);
 274   fflush(stderr);
 275
 276   if (MC_is_active()) {
 277     MC_run();
 278   } else {
 279     SIMIX_run();
 280   }
 281 }
 282
 283 /** @brief Retrieve the root netzone, containing all others */
 284 s4u::NetZone* Engine::get_netzone_root()
 285 {
 286   return pimpl->netzone_root_->get_iface();
 287 }
 288 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
 289 void Engine::set_netzone_root(s4u::NetZone* netzone)
 290 {
 291   xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
 292   pimpl->netzone_root_ = netzone->get_impl();
 293 }
 294
 295 static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, std::string name)
 296 {
 297   if (current->get_name() == name)
 298     return current;
 299
 300   for (auto const& elem : current->get_children()) {
 301     simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
 302     if (tmp != nullptr) {
 303       return tmp;
 304     }
 305   }
 306   return nullptr;
 307 }
 308
 309 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
 310 NetZone* Engine::netzone_by_name_or_null(std::string name)
 311 {
 312   return netzone_by_name_recursive(get_netzone_root(), name);
 313 }
 314
 315 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
 316 simgrid::kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(std::string name)
 317 {
 318   auto netp = pimpl->netpoints_.find(name);
 319   return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
 320 }
 321
 322 /** @brief Fill the provided vector with all existing netpoints */
 323 void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* list)
 324 {
 325   for (auto const& kv : pimpl->netpoints_)
 326     list->push_back(kv.second);
 327 }
 328 std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
 329 {
 330   std::vector<simgrid::kernel::routing::NetPoint*> res;
 331   for (auto const& kv : pimpl->netpoints_)
 332     res.push_back(kv.second);
 333   return res;
 334 }
 335
 336 /** @brief Register a new netpoint to the system */
 337 void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point)
 338 {
 339   // simgrid::simix::simcall([&]{ FIXME: this segfaults in set_thread
 340   pimpl->netpoints_[point->get_name()] = point;
 341   // });
 342 }
 343 /** @brief Unregister a given netpoint */
 344 void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point)
 345 {
 346   simgrid::simix::simcall([this, point] {
 347     pimpl->netpoints_.erase(point->get_name());
 348     delete point;
 349   });
 350 }
 351
 352 bool Engine::is_initialized()
 353 {
 354   return Engine::instance_ != nullptr;
 355 }
 356 void Engine::set_config(std::string str)
 357 {
 358   simgrid::config::set_parse(std::move(str));
 359 }
 360 } // namespace s4u
 361 } // namespace simgrid
 362
 363 /* **************************** Public C interface *************************** */
 364 void simgrid_init(int* argc, char** argv)
 365 {
 366   simgrid::s4u::Engine e(argc, argv);
 367 }
 368 void simgrid_load_platform(const char* file)
 369 {
 370   simgrid::s4u::Engine::get_instance()->load_platform(file);
 371 }
 372
 373 void simgrid_load_deployment(const char* file)
 374 {
 375   simgrid::s4u::Engine::get_instance()->load_deployment(file);
 376 }
 377 void simgrid_run()
 378 {
 379   simgrid::s4u::Engine::get_instance()->run();
 380 }
 381 void simgrid_register_function(const char* name, int (*code)(int, char**))
 382 {
 383   simgrid::s4u::Engine::get_instance()->register_function(name, code);
 384 }
 385 void simgrid_register_default(int (*code)(int, char**))
 386 {
 387   simgrid::s4u::Engine::get_instance()->register_default(code);
 388 }
 389 double simgrid_get_clock()
 390 {
 391   return simgrid::s4u::Engine::get_clock();
 392 }