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