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