Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
know whether an activity has solved all its dependencies
[simgrid.git] / include / simgrid / s4u / Host.hpp
index 07d7cc5..e745232 100644 (file)
@@ -37,16 +37,19 @@ namespace s4u {
  */
 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
 #ifndef DOXYGEN
-  friend vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
-  friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
+  friend kernel::resource::VMModel;            // Use the pimpl_cpu to compute the VM sharing
+  friend kernel::resource::VirtualMachineImpl; // creates the the pimpl_cpu
   friend kernel::routing::NetZoneImpl;
-  friend surf::HostImpl; // call destructor from private implementation
+  friend kernel::resource::HostImpl; // call destructor from private implementation
 
   // The private implementation, that never changes
-  surf::HostImpl* const pimpl_;
+  kernel::resource::HostImpl* const pimpl_;
+
+  kernel::resource::CpuImpl* pimpl_cpu_      = nullptr;
+  kernel::routing::NetPoint* pimpl_netpoint_ = nullptr;
 
 public:
-  explicit Host(surf::HostImpl* pimpl) : pimpl_(pimpl) {}
+  explicit Host(kernel::resource::HostImpl* pimpl) : pimpl_(pimpl) {}
 
 protected:
   virtual ~Host(); // Call destroy() instead of manually deleting it.
@@ -56,13 +59,13 @@ protected:
 public:
   /** Called on each newly created host */
   static xbt::signal<void(Host&)> on_creation;
-  /** Called just before destructing a host */
-  static xbt::signal<void(Host const&)> on_destruction;
   /** Called when the machine is turned on or off (called AFTER the change) */
   static xbt::signal<void(Host const&)> 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 xbt::signal<void(Host const&)> on_speed_change;
+  /** Called just before destructing a host */
+  static xbt::signal<void(Host const&)> on_destruction;
 
   virtual void destroy();
 #ifndef DOXYGEN
@@ -83,9 +86,24 @@ public:
   /** Retrieves the name of that host as a C string */
   const char* get_cname() const;
 
+  Host* set_cpu(kernel::resource::CpuImpl* cpu);
+  kernel::resource::CpuImpl* get_cpu() const { return pimpl_cpu_; }
   kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
+  /**
+   * @brief Callback to set CPU factor
+   *
+   * This callback offers a flexible way to create variability in CPU executions
+   *
+   * @param flops Execution size in flops
+   * @return Multiply factor
+   */
+  using CpuFactorCb = double(double flops);
+  /**
+   * @brief Configure the factor callback to the CPU associated to this host
+   */
+  Host* set_factor_cb(const std::function<CpuFactorCb>& cb);
 
-  int get_actor_count() const;
+  size_t get_actor_count() const;
   std::vector<ActorPtr> get_all_actors() const;
 
   /** Turns that host on if it was previously off
@@ -131,7 +149,7 @@ public:
    *  The amount of flops per second available for computing depends on several things:
    *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
    *      computing speed you would get at another pstate)
-   *    - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
+   *    - If you declared an external load (with @ref set_speed_profile()), you must multiply the
    * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
    *
    *  The remaining speed is then shared between the executions located on this host.
@@ -144,7 +162,7 @@ public:
   double get_speed() const;
   /** @brief Get the available speed ratio, between 0 and 1.
    *
-   * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
+   * This accounts for external load (see @ref set_speed_profile()).
    */
   double get_available_speed() const;
 
@@ -152,6 +170,18 @@ public:
   int get_core_count() const;
   Host* set_core_count(int core_count);
 
+  enum class SharingPolicy { NONLINEAR = 1, LINEAR = 0 };
+  /**
+   * @brief Describes how the CPU is shared between concurrent tasks
+   *
+   * Note that the NONLINEAR callback is in the critical path of the solver, so it should be fast.
+   *
+   * @param policy Sharing policy
+   * @param cb Callback for NONLINEAR policies
+   */
+  Host* set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {});
+  SharingPolicy get_sharing_policy() const;
+
   /** Returns the current computation load (in flops per second)
    *
    * The external load (coming from an availability trace) is not taken in account.
@@ -159,10 +189,10 @@ public:
    */
   double get_load() const;
 
-  int get_pstate_count() const;
-  int get_pstate() const;
-  double get_pstate_speed(int pstate_index) const;
-  Host* set_pstate(int pstate_index);
+  unsigned long get_pstate_count() const;
+  unsigned long get_pstate() const;
+  double get_pstate_speed(unsigned long pstate_index) const;
+  Host* set_pstate(unsigned long pstate_index);
   Host* set_coordinates(const std::string& coords);
 
   std::vector<Disk*> get_disks() const;
@@ -183,6 +213,9 @@ public:
   void add_disk(const Disk* disk);
   void remove_disk(const std::string& disk_name);
 
+  VirtualMachine* create_vm(const std::string& name, int core_amount);
+  VirtualMachine* create_vm(const std::string& name, int core_amount, size_t ramsize);
+
   void route_to(const Host* dest, std::vector<Link*>& links, double* latency) const;
   void route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const;
 
@@ -194,13 +227,10 @@ public:
 
 #ifndef DOXYGEN
   XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount);
-
   XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto_async()") CommPtr sendto_async(Host* dest, double byte_amount);
-
-  XBT_ATTRIB_DEPRECATED_v330("Please use Host::sendto()") void send_to(Host* dest, double byte_amount);
 #endif
 
-  NetZone* get_englobing_zone();
+  NetZone* get_englobing_zone() const;
   /** Block the calling actor on an execution located on the called host
    *
    * It is not a problem if the actor is not located on the called host.
@@ -213,16 +243,7 @@ public:
 
   /** Block the calling actor on an execution located on the called host (with explicit priority) */
   void execute(double flops, double priority) const;
-  surf::HostImpl* get_impl() const { return pimpl_; }
-
-private:
-  kernel::routing::NetPoint* pimpl_netpoint_ = nullptr;
-
-public:
-#ifndef DOXYGEN
-  /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
-  kernel::resource::Cpu* pimpl_cpu = nullptr;
-#endif
+  kernel::resource::HostImpl* get_impl() const { return pimpl_; }
 };
 } // namespace s4u
 } // namespace simgrid