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