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 XBT_LOG_NEW_CATEGORY(s4u, "Log channels of the S4U (Simgrid for you) interface");
  24
  25 namespace simgrid {
  26 namespace s4u {
  27 xbt::signal<void()> on_platform_creation;
  28 xbt::signal<void()> on_platform_created;
  29 xbt::signal<void()> on_simulation_end;
  30 xbt::signal<void(double)> on_time_advance;
  31 xbt::signal<void(void)> on_deadlock;
  32
  33 Engine* Engine::instance_ = nullptr; /* That singleton is awful, but I don't see no other solution right now. */
  34
  35 Engine::Engine(int* argc, char** argv)
  36 {
  37   xbt_assert(s4u::Engine::instance_ == nullptr,
  38              "It is currently forbidden to create more than one instance of s4u::Engine");
  39   TRACE_global_init();
  40   SIMIX_global_init(argc, argv);
  41
  42   pimpl                  = new kernel::EngineImpl();
  43   s4u::Engine::instance_ = this;
  44 }
  45
  46 Engine::~Engine()
  47 {
  48   delete pimpl;
  49   s4u::Engine::instance_ = nullptr;
  50 }
  51
  52 /** @brief Retrieve the engine singleton */
  53 Engine* Engine::get_instance()
  54 {
  55   if (s4u::Engine::instance_ == nullptr)
  56     return new Engine(0, nullptr);
  57   else
  58     return s4u::Engine::instance_;
  59 }
  60
  61 void Engine::shutdown()
  62 {
  63   delete s4u::Engine::instance_;
  64   s4u::Engine::instance_ = nullptr;
  65 }
  66
  67 double Engine::get_clock()
  68 {
  69   return SIMIX_get_clock();
  70 }
  71
  72 void Engine::load_platform(const char* platf)
  73 {
  74   SIMIX_create_environment(platf);
  75 }
  76
  77 void Engine::register_function(const char* name, int (*code)(int, char**))
  78 {
  79   SIMIX_function_register(name, code);
  80 }
  81 void Engine::register_default(int (*code)(int, char**))
  82 {
  83   SIMIX_function_register_default(code);
  84 }
  85 void Engine::load_deployment(const char* deploy)
  86 {
  87   SIMIX_launch_application(deploy);
  88 }
  89 /** @brief Returns the amount of hosts in the platform */
  90 size_t Engine::get_host_count()
  91 {
  92   return pimpl->hosts_.size();
  93 }
  94 /** @brief Fills the passed list with all hosts found in the platform
  95  *  @deprecated Please prefer Engine::getAllHosts()
  96  */
  97 void Engine::getHostList(std::vector<Host*>* list)
  98 {
  99   for (auto const& kv : pimpl->hosts_)
 100     list->push_back(kv.second);
 101 }
 102
 103 /** @brief Returns the list of all hosts found in the platform */
 104 std::vector<Host*> Engine::get_all_hosts()
 105 {
 106   std::vector<Host*> res;
 107   for (auto const& kv : pimpl->hosts_)
 108     res.push_back(kv.second);
 109   return res;
 110 }
 111
 112 std::vector<Host*> Engine::get_filtered_hosts(std::function<bool(Host*)> filter)
 113 {
 114   std::vector<Host*> hosts;
 115   for (auto const& kv : pimpl->hosts_) {
 116     if (filter(kv.second))
 117       hosts.push_back(kv.second);
 118   }
 119
 120   return hosts;
 121 }
 122
 123 void Engine::host_register(std::string name, simgrid::s4u::Host* host)
 124 {
 125   pimpl->hosts_[name] = host;
 126 }
 127
 128 void Engine::host_unregister(std::string name)
 129 {
 130   pimpl->hosts_.erase(name);
 131 }
 132
 133 simgrid::s4u::Host* Engine::host_by_name(std::string name)
 134 {
 135   return pimpl->hosts_.at(name); // Will raise a std::out_of_range if the host does not exist
 136 }
 137
 138 simgrid::s4u::Host* Engine::host_by_name_or_null(std::string name)
 139 {
 140   auto host = pimpl->hosts_.find(name);
 141   return host == pimpl->hosts_.end() ? nullptr : host->second;
 142 }
 143
 144 /** @brief Returns the amount of storages in the platform */
 145 size_t Engine::get_storage_count()
 146 {
 147   return pimpl->storages_.size();
 148 }
 149
 150 /** @brief Returns the list of all storages found in the platform */
 151 std::vector<Storage*> Engine::get_all_storages()
 152 {
 153   std::vector<Storage*> res;
 154   for (auto const& kv : pimpl->storages_)
 155     res.push_back(kv.second);
 156   return res;
 157 }
 158
 159 simgrid::s4u::Storage* Engine::storage_by_name(std::string name)
 160 {
 161   return pimpl->storages_.at(name); // Will raise a std::out_of_range if the host does not exist
 162 }
 163
 164 simgrid::s4u::Storage* Engine::storage_by_name_or_null(std::string name)
 165 {
 166   auto storage = pimpl->storages_.find(name);
 167   return storage == pimpl->storages_.end() ? nullptr : storage->second;
 168 }
 169
 170 void Engine::storage_register(std::string name, simgrid::s4u::Storage* storage)
 171 {
 172   pimpl->storages_[name] = storage;
 173 }
 174
 175 void Engine::storage_unregister(std::string name)
 176 {
 177   pimpl->storages_.erase(name);
 178 }
 179
 180 /** @brief Returns the amount of links in the platform */
 181 size_t Engine::get_link_count()
 182 {
 183   return kernel::resource::LinkImpl::linksCount();
 184 }
 185
 186 /** @brief Returns the list of all links found in the platform */
 187 std::vector<Link*> Engine::get_all_links()
 188 {
 189   std::vector<Link*> res;
 190   kernel::resource::LinkImpl::linksList(&res);
 191   return res;
 192 }
 193
 194 std::vector<Link*> Engine::get_filtered_links(std::function<bool(Link*)> filter)
 195 {
 196   // FIXME: This is a terrible implementation and should be done
 197   // without getting all links first.
 198   std::vector<Link*> res;
 199   kernel::resource::LinkImpl::linksList(&res);
 200   std::vector<Link*> filtered_list;
 201   for (auto& link : res) {
 202     if (filter(link))
 203       filtered_list.push_back(link);
 204   }
 205   return filtered_list;
 206 }
 207
 208 size_t Engine::get_actor_count()
 209 {
 210   return simix_global->process_list.size();
 211 }
 212
 213 std::vector<ActorPtr> Engine::get_all_actors()
 214 {
 215   std::vector<ActorPtr> actor_list;
 216   actor_list.push_back(simgrid::s4u::Actor::self());
 217   for (auto& kv : simix_global->process_list) {
 218     actor_list.push_back(kv.second->iface());
 219   }
 220   return actor_list;
 221 }
 222
 223 std::vector<ActorPtr> Engine::get_filtered_actors(std::function<bool(ActorPtr)> filter)
 224 {
 225   std::vector<ActorPtr> actor_list;
 226   for (auto& kv : simix_global->process_list) {
 227     if (filter(kv.second->iface()))
 228       actor_list.push_back(kv.second->iface());
 229   }
 230   return actor_list;
 231 }
 232
 233 void Engine::run()
 234 {
 235   if (MC_is_active()) {
 236     MC_run();
 237   } else {
 238     SIMIX_run();
 239   }
 240 }
 241
 242 /** @brief Retrieve the root netzone, containing all others */
 243 s4u::NetZone* Engine::get_netzone_root()
 244 {
 245   return pimpl->netzone_root_;
 246 }
 247 /** @brief Set the root netzone, containing all others. Once set, it cannot be changed. */
 248 void Engine::set_netzone_root(s4u::NetZone* netzone)
 249 {
 250   xbt_assert(pimpl->netzone_root_ == nullptr, "The root NetZone cannot be changed once set");
 251   pimpl->netzone_root_ = static_cast<kernel::routing::NetZoneImpl*>(netzone);
 252 }
 253
 254 static s4u::NetZone* netzone_by_name_recursive(s4u::NetZone* current, const char* name)
 255 {
 256   if (not strcmp(current->get_cname(), name))
 257     return current;
 258
 259   for (auto const& elem : *(current->getChildren())) {
 260     simgrid::s4u::NetZone* tmp = netzone_by_name_recursive(elem, name);
 261     if (tmp != nullptr) {
 262       return tmp;
 263     }
 264   }
 265   return nullptr;
 266 }
 267
 268 /** @brief Retrieve the NetZone of the given name (or nullptr if not found) */
 269 NetZone* Engine::netzone_by_name_or_null(const char* name)
 270 {
 271   return netzone_by_name_recursive(get_netzone_root(), name);
 272 }
 273
 274 /** @brief Retrieve the netpoint of the given name (or nullptr if not found) */
 275 simgrid::kernel::routing::NetPoint* Engine::netpoint_by_name_or_null(std::string name)
 276 {
 277   auto netp = pimpl->netpoints_.find(name);
 278   return netp == pimpl->netpoints_.end() ? nullptr : netp->second;
 279 }
 280
 281 /** @brief Fill the provided vector with all existing netpoints */
 282 void Engine::getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*>* list)
 283 {
 284   for (auto const& kv : pimpl->netpoints_)
 285     list->push_back(kv.second);
 286 }
 287 std::vector<simgrid::kernel::routing::NetPoint*> Engine::get_all_netpoints()
 288 {
 289   std::vector<simgrid::kernel::routing::NetPoint*> res;
 290   for (auto const& kv : pimpl->netpoints_)
 291     res.push_back(kv.second);
 292   return res;
 293 }
 294
 295 /** @brief Register a new netpoint to the system */
 296 void Engine::netpoint_register(simgrid::kernel::routing::NetPoint* point)
 297 {
 298   // simgrid::simix::simcall([&]{ FIXME: this segfaults in set_thread
 299   pimpl->netpoints_[point->get_name()] = point;
 300   // });
 301 }
 302 /** @brief Unregister a given netpoint */
 303 void Engine::netpoint_unregister(simgrid::kernel::routing::NetPoint* point)
 304 {
 305   simgrid::simix::simcall([this, point] {
 306     pimpl->netpoints_.erase(point->get_name());
 307     delete point;
 308   });
 309 }
 310
 311 bool Engine::is_initialized()
 312 {
 313   return Engine::instance_ != nullptr;
 314 }
 315 void Engine::set_config(std::string str)
 316 {
 317   simgrid::config::set_parse(std::move(str));
 318 }
 319 } // namespace s4u
 320 } // namespace simgrid
 321
 322 /* **************************** Public C interface *************************** */
 323 void sg_engine_load_platform(const char* file)
 324 {
 325   simgrid::s4u::Engine::get_instance()->load_platform(file);
 326 }
 327
 328 void sg_engine_load_deployment(const char* file)
 329 {
 330   simgrid::s4u::Engine::get_instance()->load_deployment(file);
 331 }
 332
 333 void sg_engine_register_function(const char* name, int (*code)(int, char**))
 334 {
 335   simgrid::s4u::Engine::get_instance()->register_function(name, code);
 336 }
 337 void sg_engine_register_default(int (*code)(int, char**))
 338 {
 339   simgrid::s4u::Engine::get_instance()->register_default(code);
 340 }
 341 double sg_engine_get_clock()
 342 {
 343   return simgrid::s4u::Engine::get_clock();
 344 }