include/simgrid/s4u/Engine.hpp

   1 /* Copyright (c) 2006-2019. 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 class is an interface to the simulation engine.
  26  */
  27 class XBT_PUBLIC Engine {
  28 public:
  29   /** Constructor, taking the command line parameters of your main function */
  30   explicit Engine(int* argc, char** argv);
  31   /** Currently, only one instance is allowed to exist. This is why you can't copy or move it */
  32   Engine(const Engine&) = delete;
  33   Engine(Engine&&)      = delete;
  34
  35   ~Engine();
  36   /** Finalize the default engine and all its dependencies */
  37   static void shutdown();
  38
  39   /** @brief Run the simulation */
  40   void run();
  41
  42   /** @brief Retrieve the simulation time (in seconds) */
  43   static double get_clock();
  44   /** @brief Retrieve the engine singleton */
  45   static s4u::Engine* get_instance();
  46
  47   /** @brief Load a platform file describing the environment
  48    *
  49    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
  50    * Some examples can be found in the directory examples/platforms.
  51    */
  52   void load_platform(const std::string& platf);
  53
  54   /** Registers the main function of an actor that will be launched from the deployment file */
  55   void register_function(const std::string& name, int (*code)(int, char**));
  56   /** Registers the main function of an actor that will be launched from the deployment file */
  57   void register_function(const std::string& name, void (*code)(std::vector<std::string>));
  58
  59   /** Registers a function as the default main function of actors
  60    *
  61    * It will be used as fallback when the function requested from the deployment file was not registered.
  62    * It is used for trace-based simulations (see examples/s4u/replay-comms and similar).
  63    */
  64   void register_default(int (*code)(int, char**));
  65
  66   template <class F> void register_actor(const std::string& name)
  67   {
  68     simix::register_function(name, [](std::vector<std::string> args) {
  69       return simix::ActorCode([args] {
  70         F code(std::move(args));
  71         code();
  72       });
  73     });
  74   }
  75
  76   template <class F> void register_actor(const std::string& name, F code)
  77   {
  78     simix::register_function(name, [code](std::vector<std::string> args) {
  79       return simix::ActorCode([code, args] { code(std::move(args)); });
  80     });
  81   }
  82
  83   /** @brief Load a deployment file and launch the actors that it contains */
  84   void load_deployment(const std::string& deploy);
  85
  86 protected:
  87 #ifndef DOXYGEN
  88   friend Host;
  89   friend Link;
  90   friend Disk;
  91   friend Storage;
  92   friend kernel::routing::NetPoint;
  93   friend kernel::routing::NetZoneImpl;
  94   friend kernel::resource::LinkImpl;
  95   void host_register(const std::string& name, Host* host);
  96   void host_unregister(const std::string& name);
  97   void link_register(const std::string& name, Link* link);
  98   void link_unregister(const std::string& name);
  99   void storage_register(const std::string& name, Storage* storage);
 100   void storage_unregister(const std::string& name);
 101   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
 102   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 103 #endif /*DOXYGEN*/
 104
 105 public:
 106   size_t get_host_count();
 107   /** @brief Returns the list of all hosts found in the platform */
 108   std::vector<Host*> get_all_hosts();
 109   std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter);
 110   Host* host_by_name(const std::string& name);
 111   Host* host_by_name_or_null(const std::string& name);
 112
 113   size_t get_link_count();
 114   std::vector<Link*> get_all_links();
 115   std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter);
 116   Link* link_by_name(const std::string& name);
 117   Link* link_by_name_or_null(const std::string& name);
 118
 119   size_t get_actor_count();
 120   std::vector<ActorPtr> get_all_actors();
 121   std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter);
 122
 123   size_t get_storage_count();
 124   std::vector<Storage*> get_all_storages();
 125   Storage* storage_by_name(const std::string& name);
 126   Storage* storage_by_name_or_null(const std::string& name);
 127
 128   std::vector<kernel::routing::NetPoint*> get_all_netpoints();
 129   kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name);
 130
 131   NetZone* get_netzone_root();
 132   void set_netzone_root(NetZone* netzone);
 133
 134   NetZone* netzone_by_name_or_null(const std::string& name);
 135
 136   /** @brief Retrieves all netzones of the type indicated by the template argument */
 137   template <class T> std::vector<T*> get_filtered_netzones()
 138   {
 139     static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 140                   "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 141     std::vector<T*> res;
 142     get_filtered_netzones_recursive(get_netzone_root(), &res);
 143     return res;
 144   }
 145
 146   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
 147   static bool is_initialized();
 148   /** @brief set a configuration variable
 149    *
 150    * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
 151    * options).
 152    *
 153    * Example:
 154    * e->set_config("host/model:ptask_L07");
 155    */
 156   void set_config(const std::string& str);
 157
 158 private:
 159   kernel::EngineImpl* const pimpl;
 160   static Engine* instance_;
 161 };
 162
 163 /** Callback fired when the platform is created (ie, the xml file parsed),
 164  * right before the actual simulation starts. */
 165 extern XBT_PUBLIC xbt::signal<void()> on_platform_created;
 166
 167 /** Callback fired when the platform is about to be created
 168  * (ie, after any configuration change and just before the resource creation) */
 169 extern XBT_PUBLIC xbt::signal<void()> on_platform_creation;
 170
 171 /** Callback fired when the main simulation loop ends, just before the end of Engine::run() */
 172 extern XBT_PUBLIC xbt::signal<void()> on_simulation_end;
 173
 174 /** Callback fired when the time jumps into the future */
 175 extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
 176
 177 /** Callback fired when the time cannot advance because of inter-actors deadlock */
 178 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
 179
 180 #ifndef DOXYGEN /* Internal use only, no need to expose it */
 181 template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
 182 {
 183   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
 184                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
 185   for (auto const& elem : current->get_children()) {
 186     get_filtered_netzones_recursive(elem, whereto);
 187     T* elem_impl = dynamic_cast<T*>(elem->get_impl());
 188     if (elem_impl != nullptr)
 189       whereto->push_back(elem_impl);
 190   }
 191 }
 192 #endif
 193 } // namespace s4u
 194 } // namespace simgrid
 195
 196 #endif /* SIMGRID_S4U_ENGINE_HPP */