src/s4u/s4u_Engine.cpp

   1 /* s4u::Engine Simulation Engine and global functions. */
   2
   3 /* Copyright (c) 2006-2020. 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/Disk.hpp"
  12 #include "simgrid/s4u/Engine.hpp"
  13 #include "simgrid/s4u/Host.hpp"
  14 #include "simgrid/s4u/Mailbox.hpp"
  15 #include "simgrid/s4u/NetZone.hpp"
  16 #include "simgrid/s4u/Storage.hpp"
  17 #include "simgrid/simix.h"
  18 #include "src/instr/instr_private.hpp"
  19 #include "src/kernel/EngineImpl.hpp"
  20 #include "src/simix/smx_private.hpp" // For access to simix_global->process_list
  21 #include "src/surf/StorageImpl.hpp"
  22 #include "src/surf/network_interface.hpp"
  23 #include "surf/surf.hpp" // routing_platf. FIXME:KILLME. SOON
  24 #include <simgrid/Exception.hpp>
  25
  26 #include <string>
  27
  28 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
  29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_engine, s4u, "Logging specific to S4U (engine)");
  30
  31 namespace simgrid {
  32 namespace s4u {
  33 xbt::signal<void()> Engine::on_platform_creation;
  34 xbt::signal<void()> Engine::on_platform_created;
  35 xbt::signal<void()> Engine::on_simulation_end;
  36 xbt::signal<void(double)> Engine::on_time_advance;
  37 xbt::signal<void(void)> Engine::on_deadlock;
  38
  39 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
  40
  41 Engine::Engine(int* argc, char** argv) : pimpl(new kernel::EngineImpl())
  42 {
  43   xbt_assert(Engine::instance_ == nullptr, "It is currently forbidden to create more than one instance of s4u::Engine");
  44   TRACE_global_init();
  45   SIMIX_global_init(argc, argv);
  46
  47   Engine::instance_ = this;
  48 }
  49
  50 Engine::~Engine()
  51 {
  52   delete pimpl;
  53   Engine::instance_ = nullptr;
  54 }
  55
  56 /** @brief Retrieve the engine singleton */
  57 Engine* Engine::get_instance()
  58 {
  59   if (Engine::instance_ == nullptr) {
  60     auto e = new Engine(0, nullptr);
  61     xbt_assert(Engine::instance_ == e);
  62   }
  63   return Engine::instance_;
  64 }
  65
  66 void Engine::shutdown()
  67 {
  68   delete Engine::instance_;
  69   Engine::instance_ = nullptr;
  70 }
  71
  72 double Engine::get_clock()
  73 {
  74   return SIMIX_get_clock();
  75 }
  76
  77 /**
  78  * Creates a new platform, including hosts, links, and the routing table.
  79  *
  80  * \rst
  81  * See also: :ref:`platform`.
  82  * \endrst
  83  */
  84 void Engine::load_platform(const std::string& platf)
  85 {
  86   double start = xbt_os_time();
  87   parse_platform_file(platf);
  88
  89   double end = xbt_os_time();
  90   XBT_DEBUG("PARSE TIME: %g", (end - start));
  91 }
  92
  93 void Engine::register_function(const std::string& name, int (*code)(int, char**)) // deprecated
  94 {
  95   register_function(name, [code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
  96 }
  97 void Engine::register_default(int (*code)(int, char**)) // deprecated
  98 {
  99   register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
 100 }
 101
 102 /** Registers the main function of an actor that will be launched from the deployment file */
 103 void Engine::register_function(const std::string& name, void (*code)(int, char**))
 104 {
 105   register_function(name, [code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
 106 }
 107
 108 /** Registers the main function of an actor that will be launched from the deployment file */
 109 void Engine::register_function(const std::string& name, void (*code)(std::vector<std::string>))
 110 {
 111   register_function(name,
 112                     [code](std::vector<std::string> args) { return std::bind(std::move(code), std::move(args)); });
 113 }
 114 /** Registers a function as the default main function of actors
 115  *
 116  * It will be used as fallback when the function requested from the deployment file was not registered.
 117  * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
 118  */
 119 void Engine::register_default(void (*code)(int, char**))
 120 {
 121   register_default([code](std::vector<std::string> args) { return xbt::wrap_main(code, std::move(args)); });
 122 }
 123 void Engine::register_default(kernel::actor::ActorCodeFactory code)
 124 {
 125   simgrid::kernel::actor::simcall([this, code]() { pimpl->register_default(code); });
 126 }
 127
 128 void Engine::register_function(const std::string& name, kernel::actor::ActorCodeFactory code)
 129 {
 130   simgrid::kernel::actor::simcall([this, name, code]() { pimpl->register_function(name, code); });
 131 }
 132
 133 /** Load a deployment file and launch the actors that it contains
 134  *
 135  * \rst
 136  * See also: :ref:`deploy`.
 137  * \endrst
 138  */
 139 void Engine::load_deployment(const std::string& deploy)
 140 {
 141   pimpl->load_deployment(deploy);
 142 }
 143
 144 /** Returns the amount of hosts in the platform */
 145 size_t Engine::get_host_count()
 146 {
 147   return pimpl->hosts_.size();
 148 }
 149
 150 std::vector<Host*> Engine::get_all_hosts()
 151 {
 152   std::vector<Host*> res;
 153   for (auto const& kv : pimpl->hosts_)
 154     res.push_back(kv.second);
 155   return res;
 156 }
 157
 158 std::vector<Host*> Engine::get_filtered_hosts(const std::function<bool(Host*)>& filter)
 159 {
 160   std::vector<Host*> hosts;
 161   for (auto const& kv : pimpl->hosts_) {
 162     if (filter(kv.second))
 163       hosts.push_back(kv.second);
 164   }
 165
 166   return hosts;
 167 }
 168
 169 void Engine::host_register(const std::string& name, Host* host)
 170 {
 171   pimpl->hosts_[name] = host;
 172 }
 173
 174 void Engine::host_unregister(const std::string& name)
 175 {
 176   pimpl->hosts_.erase(name);
 177 }
 178
 179 /** @brief Find a host from its name.
 180  *
 181  *  @throw std::invalid_argument if the searched host does not exist.
 182  */
 183 Host* Engine::host_by_name(const std::string& name)
 184 {
 185   if (pimpl->hosts_.find(name) == pimpl->hosts_.end())
 186     throw std::invalid_argument(std::string("Host not found: '") + name + std::string("'"));
 187   return pimpl->hosts_.at(name);
 188 }
 189
 190 /** @brief Find a host from its name (or nullptr if that host does not exist) */
 191 Host* Engine::host_by_name_or_null(const std::string& name)
 192 {
 193   auto host = pimpl->hosts_.find(name);
 194   return host == pimpl->hosts_.end() ? nullptr : host->second;
 195 }
 196
 197 /** @brief Find a link from its name.
 198  *
 199  *  @throw std::invalid_argument if the searched link does not exist.
 200  */
 201 Link* Engine::link_by_name(const std::string& name)
 202 {
 203   if (pimpl->links_.find(name) == pimpl->links_.end())
 204     throw std::invalid_argument(std::string("Link not found: ") + name);
 205
 206   return pimpl->links_.at(name)->get_iface();
 207 }
 208
 209 /** @brief Find an link from its name (or nullptr if that link does not exist) */
 210 Link* Engine::link_by_name_or_null(const std::string& name)
 211 {
 212   auto link = pimpl->links_.find(name);
 213   return link == pimpl->links_.end() ? nullptr : link->second->get_iface();
 214 }
 215
 216 void Engine::link_register(const std::string& name, const Link* link)
 217 {
 218   pimpl->links_[name] = link->get_impl();
 219 }
 220
 221 void Engine::link_unregister(const std::string& name)
 222 {
 223   pimpl->links_.erase(name);
 224 }
 225
 226 /** @brief Returns the amount of storages in the platform */
 227 size_t Engine::get_storage_count()
 228 {
 229   return pimpl->storages_.size();
 230 }
 231
 232 /** @brief Returns the list of all storages found in the platform */
 233 std::vector<Storage*> Engine::get_all_storages()
 234 {
 235   std::vector<Storage*> res;
 236   for (auto const& kv : pimpl->storages_)
 237     res.push_back(kv.second->get_iface());
 238   return res;
 239 }
 240
 241 /** @brief Find a storage from its name.
 242  *
 243  *  @throw std::invalid_argument if the searched storage does not exist.
 244  */
 245 Storage* Engine::storage_by_name(const std::string& name)
 246 {
 247   if (pimpl->storages_.find(name) == pimpl->storages_.end())
 248     throw std::invalid_argument(std::string("Storage not found: ") + name);
 249
 250   return pimpl->storages_.at(name)->get_iface();
 251 }
 252
 253 /** @brief Find a storage from its name (or nullptr if that storage does not exist) */
 254 Storage* Engine::storage_by_name_or_null(const std::string& name)
 255 {
 256   auto storage = pimpl->storages_.find(name);
 257   return storage == pimpl->storages_.end() ? nullptr : storage->second->get_iface();
 258 }
 259
 260 void Engine::storage_register(const std::string& name, const Storage* storage)
 261 {
 262   pimpl->storages_[name] = storage->get_impl();
 263 }
 264
 265 void Engine::storage_unregister(const std::string& name)
 266 {
 267   pimpl->storages_.erase(name);
 268 }
 269
 270 /** @brief Returns the amount of links in the platform */
 271 size_t Engine::get_link_count()
 272 {
 273   return pimpl->links_.size();
 274 }
 275
 276 /** @brief Returns the list of all links found in the platform */
 277 std::vector<Link*> Engine::get_all_links()
 278 {
 279   std::vector<Link*> res;
 280   for (auto const& kv : pimpl->links_)
 281     res.push_back(kv.second->get_iface());
 282   return res;
 283 }
 284
 285 std::vector<Link*> Engine::get_filtered_links(const std::function<bool(Link*)>& filter)
 286 {
 287   std::vector<Link*> filtered_list;
 288   for (auto const& kv : pimpl->links_) {
 289     Link* l = kv.second->get_iface();
 290     if (filter(l))
 291       filtered_list.push_back(l);
 292   }
 293   return filtered_list;
 294 }
 295
 296 size_t Engine::get_actor_count()
 297 {
 298   return simix_global->process_list.size();
 299 }
 300
 301 std::vector<ActorPtr> Engine::get_all_actors()
 302 {
 303   std::vector<ActorPtr> actor_list;
 304   actor_list.push_back(simgrid::s4u::Actor::self());
 305   for (auto const& kv : simix_global->process_list) {
 306     actor_list.push_back(kv.second->iface());
 307   }
 308   return actor_list;
 309 }
 310
 311 std::vector<ActorPtr> Engine::get_filtered_actors(const std::function<bool(ActorPtr)>& filter)
 312 {
 313   std::vector<ActorPtr> actor_list;
 314   for (auto const& kv : simix_global->process_list) {
 315     if (filter(kv.second->iface()))
 316       actor_list.push_back(kv.second->iface());
 317   }
 318   return actor_list;
 319 }
 320
 321 void Engine::run()
 322 {
 323   /* Clean IO before the run */
 324   fflush(stdout);
 325   fflush(stderr);
 326
 327   if (MC_is_active()) {
 328     MC_run();
 329   } else {
 330     SIMIX_run();
 331   }
 332 }
 333
 334 /** @brief Retrieve the root netzone, containing all others */
 335 s4u::NetZone* Engine::get_netzone_root()
 336 {
 337   return pimpl->netzone_root_->get_iface();
 338 }
 339 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
 340 void Engine::set_netzone_root(const s4u::NetZone* netzone)
 341 {
 342   xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
 343   pimpl->netzone_root_ = netzone->get_impl();
 344 }
 345
 346 static NetZone* netzone_by_name_recursive(NetZone* current, const std::string& name)
 347 {
 348   if (current->get_name() == name)
 349     return current;
 350
 351   for (auto const& elem : current->get_children()) {
 352     NetZone* tmp = netzone_by_name_recursive(elem, name);
 353     if (tmp != nullptr) {
 354       return tmp;
 355     }
 356   }
 357   return nullptr;
 358 }
 359
 360 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
 361 NetZone* Engine::netzone_by_name_or_null(const std::string& name)
 362 {
 363   return netzone_by_name_recursive(get_netzone_root(), name);
 364 }
 365
 366 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
 367 kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(const std::string& name)
 368 {
 369   auto netp = pimpl->netpoints_.find(name);
 370   return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
 371 }
 372
 373 std::vector<kernel::routing::NetPoint*> Engine::get_all_netpoints()
 374 {
 375   std::vector<kernel::routing::NetPoint*> res;
 376   for (auto const& kv : pimpl->netpoints_)
 377     res.push_back(kv.second);
 378   return res;
 379 }
 380
 381 /** @brief Register a new netpoint to the system */
 382 void Engine::netpoint_register(kernel::routing::NetPoint* point)
 383 {
 384   simgrid::kernel::actor::simcall([this, point] { pimpl->netpoints_[point->get_name()] = point; });
 385 }
 386
 387 /** @brief Unregister a given netpoint */
 388 void Engine::netpoint_unregister(kernel::routing::NetPoint* point)
 389 {
 390   kernel::actor::simcall([this, point] {
 391     pimpl->netpoints_.erase(point->get_name());
 392     delete point;
 393   });
 394 }
 395
 396 bool Engine::is_initialized()
 397 {
 398   return Engine::instance_ != nullptr;
 399 }
 400 void Engine::set_config(const std::string& str)
 401 {
 402   config::set_parse(str);
 403 }
 404 } // namespace s4u
 405 } // namespace simgrid
 406
 407 /* **************************** Public C interface *************************** */
 408 void simgrid_init(int* argc, char** argv)
 409 {
 410   simgrid::s4u::Engine e(argc, argv);
 411 }
 412 void simgrid_load_platform(const char* file)
 413 {
 414   simgrid::s4u::Engine::get_instance()->load_platform(file);
 415 }
 416
 417 void simgrid_load_deployment(const char* file)
 418 {
 419   simgrid::s4u::Engine::get_instance()->load_deployment(file);
 420 }
 421 void simgrid_run()
 422 {
 423   simgrid::s4u::Engine::get_instance()->run();
 424 }
 425 void simgrid_register_function(const char* name, void (*code)(int, char**))
 426 {
 427   simgrid::s4u::Engine::get_instance()->register_function(name, code);
 428 }
 429 void simgrid_register_default(void (*code)(int, char**))
 430 {
 431   simgrid::s4u::Engine::get_instance()->register_default(code);
 432 }
 433 double simgrid_get_clock()
 434 {
 435   return simgrid::s4u::Engine::get_clock();
 436 }
 437 int simgrid_get_actor_count()
 438 {
 439   return simgrid::s4u::Engine::get_instance()->get_actor_count();
 440 }