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