include/simgrid/s4u/Engine.hpp

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