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