src/s4u/s4u_Engine.cpp

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