include/simgrid/s4u/Engine.hpp

   1 /* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_ENGINE_HPP
   7 #define SIMGRID_S4U_ENGINE_HPP
   8
   9 #include <xbt/base.h>
  10 #include <xbt/functional.hpp>
  11
  12 #include <simgrid/forward.h>
  13 #include <simgrid/simix.hpp>
  14
  15 #include <simgrid/s4u/NetZone.hpp>
  16
  17 #include <string>
  18 #include <utility>
  19 #include <vector>
  20
  21 namespace simgrid {
  22 namespace s4u {
  23 /** @brief Simulation engine
  24  *
  25  * This is a singleton containing all the main functions of the simulation.
  26  */
  27 class XBT_PUBLIC Engine {
  28   friend simgrid::kernel::EngineImpl;
  29
  30 public:
  31   /** Constructor, taking the command line parameters of your main function */
  32   explicit Engine(int* argc, char** argv);
  33   /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
  34 #ifndef DOXYGEN
  35   Engine(const Engine&) = delete;
  36   Engine(Engine&&)      = delete;
  37   ~Engine();
  38 #endif
  39
  40   /** Finalize the default engine and all its dependencies */
  41   static void shutdown();
  42
  43   /** Run the simulation after initialization */
  44   void run();
  45
  46   /** @brief Retrieve the simulation time (in seconds) */
  47   static double get_clock();
  48   /** @brief Retrieve the engine singleton */
  49   static s4u::Engine* get_instance();
  50
  51   void load_platform(const std::string& platf);
  52
  53   XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_function(
  54       const std::string& name, int (*code)(int, char**));
  55
  56   void register_function(const std::string& name, void (*code)(int, char**));
  57   void register_function(const std::string& name, void (*code)(std::vector<std::string>));
  58
  59   XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default(
  60       int (*code)(int, char**));
  61   void register_default(void (*code)(int, char**));
  62   void register_default(const kernel::actor::ActorCodeFactory& factory);
  63
  64   void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
  65   template <class F> void register_actor(const std::string& name)
  66   {
  67     register_function(name, [](std::vector<std::string> args) {
  68       return kernel::actor::ActorCode([args] {
  69         F code(std::move(args));
  70         code();
  71       });
  72     });
  73   }
  74   template <class F> void register_actor(const std::string& name, F code)
  75   {
  76     register_function(name, [code](std::vector<std::string> args) {
  77       return kernel::actor::ActorCode([code, args] { code(std::move(args)); });
  78     });
  79   }
  80
  81   void load_deployment(const std::string& deploy);
  82
  83 protected:
  84 #ifndef DOXYGEN
  85   friend Host;
  86   friend Link;
  87   friend Disk;
  88   friend Storage;
  89   friend kernel::routing::NetPoint;
  90   friend kernel::routing::NetZoneImpl;
  91   friend kernel::resource::LinkImpl;
  92   void host_register(const std::string& name, Host* host);
  93   void host_unregister(const std::string& name);
  94   void link_register(const std::string& name, const Link* link);
  95   void link_unregister(const std::string& name);
  96   void storage_register(const std::string& name, const Storage* storage);
  97   void storage_unregister(const std::string& name);
  98   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
  99   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 100 #endif /*DOXYGEN*/
 101
 102 public:
 103   /** Returns the amount of hosts existing in the platform. */
 104   size_t get_host_count();
 105   /** Returns a vector of all hosts found in the platform.
 106    *
 107    * The order is generally different from the creation/declaration order in the XML platform because we use a hash
 108    * table internally.
 109    */
 110   std::vector<Host*> get_all_hosts();
 111   std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter);
 112   Host* host_by_name(const std::string& name);
 113   Host* host_by_name_or_null(const std::string& name);
 114
 115   size_t get_link_count();
 116   std::vector<Link*> get_all_links();
 117   std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter);
 118   Link* link_by_name(const std::string& name);
 119   Link* link_by_name_or_null(const std::string& name);
 120
 121   size_t get_actor_count();
 122   std::vector<ActorPtr> get_all_actors();
 123   std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter);
 124
 125 #ifndef DOXYGEN
 126   size_t get_storage_count();
 127   std::vector<Storage*> get_all_storages();
 128   Storage* storage_by_name(const std::string& name);
 129   Storage* storage_by_name_or_null(const std::string& name);
 130 #endif
 131
 132   std::vector<kernel::routing::NetPoint*> get_all_netpoints();
 133   kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name);
 134
 135   NetZone* get_netzone_root();
 136   void set_netzone_root(const NetZone* netzone);
 137
 138   NetZone* netzone_by_name_or_null(const std::string& name);
 139
 140   /** @brief Retrieves all netzones of the type indicated by the template argument */
 141   template <class T> std::vector<T*> get_filtered_netzones()
 142   {
 143     static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 144                   "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 145     std::vector<T*> res;
 146     get_filtered_netzones_recursive(get_netzone_root(), &res);
 147     return res;
 148   }
 149
 150   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 151   static bool is_initialized();
 152   /** @brief set a configuration variable
 153    *
 154    * @beginrst
 155    * Do --help on any simgrid binary to see the list of currently existing configuration variables
 156    * (see also :ref:`options`).
 157    * @endrst
 158    *
 159    * Example:
 160    * e->set_config("host/model:ptask_L07");
 161    */
 162   void set_config(const std::string& str);
 163   void set_config(const std::string& name, int value);
 164   void set_config(const std::string& name, bool value);
 165   void set_config(const std::string& name, double value);
 166   void set_config(const std::string& name, std::string value);
 167
 168   /** Callback fired when the platform is created (ie, the xml file parsed),
 169    * right before the actual simulation starts. */
 170   static xbt::signal<void()> on_platform_created;
 171
 172   /** Callback fired when the platform is about to be created
 173    * (ie, after any configuration change and just before the resource creation) */
 174   static xbt::signal<void()> on_platform_creation;
 175
 176   /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 177   static xbt::signal<void()> on_simulation_end;
 178
 179   /** Callback fired when the time jumps into the future */
 180   static xbt::signal<void(double)> on_time_advance;
 181
 182   /** Callback fired when the time cannot advance because of inter-actors deadlock */
 183   static xbt::signal<void(void)> on_deadlock;
 184
 185 private:
 186   kernel::EngineImpl* const pimpl;
 187   static Engine* instance_;
 188 };
 189
 190 #ifndef DOXYGEN /* Internal use only, no need to expose it */
 191 template <class T>
 192 XBT_PRIVATE void get_filtered_netzones_recursive(const s4u::NetZone* current, std::vector<T*>* whereto)
 193 {
 194   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 195                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 196   for (auto const& elem : current->get_children()) {
 197     get_filtered_netzones_recursive(elem, whereto);
 198     T* elem_impl = dynamic_cast<T*>(elem->get_impl());
 199     if (elem_impl != nullptr)
 200       whereto->push_back(elem_impl);
 201   }
 202 }
 203 #endif
 204 } // namespace s4u
 205 } // namespace simgrid
 206
 207 #endif /* SIMGRID_S4U_ENGINE_HPP */