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