Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reduce the foreign usages of s4u::Host::pimpl_cpu, which should be private
[simgrid.git] / include / simgrid / s4u / Host.hpp
index c5d4e09..4ce6a6a 100644 (file)
@@ -7,13 +7,11 @@
 #define SIMGRID_S4U_HOST_HPP
 
 #include <simgrid/forward.h>
-#include <simgrid/s4u/forward.hpp>
 #include <xbt/Extendable.hpp>
 #include <xbt/signal.hpp>
 #include <xbt/string.hpp>
 
 #include <map>
-#include <string>
 #include <unordered_map>
 
 namespace simgrid {
@@ -37,6 +35,8 @@ namespace s4u {
  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  */
 class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
+  friend simgrid::vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
+  friend simgrid::vm::VirtualMachineImpl; // creates the the pimpl_cpu
 
 public:
   explicit Host(const char* name);
@@ -49,6 +49,16 @@ private:
   bool currentlyDestroying_ = false;
 
 public:
+  /*** Called on each newly created host */
+  static simgrid::xbt::signal<void(Host&)> on_creation;
+  /*** Called just before destructing an host */
+  static simgrid::xbt::signal<void(Host&)> on_destruction;
+  /*** Called when the machine is turned on or off (called AFTER the change) */
+  static simgrid::xbt::signal<void(Host&)> on_state_change;
+  /*** Called when the speed of the machine is changed (called AFTER the change)
+   * (either because of a pstate switch or because of an external load event coming from the profile) */
+  static simgrid::xbt::signal<void(Host&)> on_speed_change;
+
   virtual void destroy();
   // No copy/move
   Host(Host const&) = delete;
@@ -66,9 +76,9 @@ public:
   static s4u::Host* current();
 
   /** Retrieves the name of that host as a C++ string */
-  simgrid::xbt::string const& getName() const { return name_; }
+  simgrid::xbt::string const& get_name() const { return name_; }
   /** Retrieves the name of that host as a C string */
-  const char* getCname() const { return name_.c_str(); }
+  const char* get_cname() const { return name_.c_str(); }
 
   void actorList(std::vector<ActorPtr> * whereto);
 
@@ -86,16 +96,20 @@ public:
   bool isOff() { return not isOn(); }
 
   double getSpeed();
+  double get_available_speed();
   int getCoreCount();
   std::map<std::string, std::string>* getProperties();
   const char* getProperty(const char* key);
   void setProperty(std::string key, std::string value);
   void getProcesses(std::vector<ActorPtr> * list);
+  int get_actor_count();
   double getPstateSpeed(int pstate_index);
   int getPstatesCount() const;
   void setPstate(int pstate_index);
   int getPstate();
-  void getAttachedStorages(std::vector<const char*> * storages);
+  std::vector<const char*> get_attached_storages();
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
+      std::vector<const char*>* storages);
 
   /** Get an associative list [mount point]->[Storage] of all local mount points.
    *
@@ -104,7 +118,7 @@ public:
   std::unordered_map<std::string, Storage*> const& getMountedStorages();
 
   void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
-  void routeTo(Host* dest, std::vector<surf::LinkImpl*>& links, double* latency);
+  void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
 
   /** Block the calling actor on an execution located on the called host
    *
@@ -112,31 +126,34 @@ public:
    * The actor will not be migrated in this case. Such remote execution are easy in simulation.
    */
   void execute(double flops);
+  /** Block the calling actor on an execution located on the called host (with explicit priority) */
+  void execute(double flops, double priority);
 
-  /** @brief Returns the current computation load (in flops per second) */
+  /** @brief Returns the current computation load (in flops per second)
+   * The external load (coming from an availability trace) is not taken in account.
+   *
+   * @return      The number of activities currently running on a host (an activity at priority 2 is counted twice).
+   */
   double getLoad();
 
+  // Deprecated functions
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
+  {
+    return name_;
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
+
 private:
   simgrid::xbt::string name_{"noname"};
-  std::unordered_map<std::string, Storage*>* mounts = nullptr; // caching
+  std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
 
 public:
-  // TODO, this could be a unique_ptr
-  surf::HostImpl* pimpl_ = nullptr;
   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
   surf::Cpu* pimpl_cpu = nullptr;
+  // TODO, this could be a unique_ptr
+  surf::HostImpl* pimpl_ = nullptr;
   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
-
-  /*** Called on each newly created host */
-  static simgrid::xbt::signal<void(Host&)> onCreation;
-  /*** Called just before destructing an host */
-  static simgrid::xbt::signal<void(Host&)> onDestruction;
-  /*** Called when the machine is turned on or off (called AFTER the change) */
-  static simgrid::xbt::signal<void(Host&)> onStateChange;
-  /*** Called when the speed of the machine is changed (called AFTER the change)
-   * (either because of a pstate switch or because of an external load event coming from the profile) */
-  static simgrid::xbt::signal<void(Host&)> onSpeedChange;
 };
 }
 } // namespace simgrid::s4u
@@ -144,18 +161,3 @@ public:
 extern int USER_HOST_LEVEL;
 
 #endif /* SIMGRID_S4U_HOST_HPP */
-
-#if 0
-
-public class Host {
-
-  /**
-   * This method returns the number of tasks currently running on a host.
-   * The external load (coming from an availability trace) is not taken in account.
-   *
-   * @return      The number of tasks currently running on a host.
-   */
-  public native int getLoad();
-
-}
-#endif