Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s4u::Host: move signals to the top and deprecated functions to the end
[simgrid.git] / include / simgrid / s4u / Host.hpp
index 30c932e..c0f9ffb 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2015. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,22 +6,18 @@
 #ifndef SIMGRID_S4U_HOST_HPP
 #define SIMGRID_S4U_HOST_HPP
 
+#include <simgrid/forward.h>
+#include <xbt/Extendable.hpp>
+#include <xbt/signal.hpp>
+#include <xbt/string.hpp>
+
 #include <map>
-#include <string>
 #include <unordered_map>
 
-#include "xbt/Extendable.hpp"
-#include "xbt/signal.hpp"
-#include "xbt/string.hpp"
-#include "xbt/swag.h"
-
-#include "simgrid/forward.h"
-#include "simgrid/s4u/forward.hpp"
-
 namespace simgrid {
 
 namespace xbt {
-extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
+extern template class XBT_PUBLIC Extendable<simgrid::s4u::Host>;
 }
 namespace s4u {
 
@@ -38,8 +34,7 @@ namespace s4u {
  * You can retrieve a particular host using simgrid::s4u::Host::byName()
  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  */
-XBT_PUBLIC_CLASS Host : public simgrid::xbt::Extendable<Host>
-{
+class XBT_PUBLIC Host : public simgrid::xbt::Extendable<Host> {
 
 public:
   explicit Host(const char* name);
@@ -52,7 +47,17 @@ private:
   bool currentlyDestroying_ = false;
 
 public:
-  void destroy();
+  /*** 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;
   Host& operator=(Host const&) = delete;
@@ -62,12 +67,16 @@ public:
   /** Retrieves an host from its name, or return nullptr */
   static Host* by_name_or_null(std::string name);
   /** Retrieves an host from its name, or die */
+  static s4u::Host* by_name(const char* name);
+  /** Retrieves an host from its name, or die */
   static s4u::Host* by_name(std::string name);
   /** Retrieves the host on which the current actor is running */
   static s4u::Host* current();
 
-  simgrid::xbt::string const& getName() const { return name_; }
-  const char* getCname() { return name_.c_str(); }
+  /** Retrieves the name of that host as a C++ string */
+  simgrid::xbt::string const& get_name() const { return name_; }
+  /** Retrieves the name of that host as a C string */
+  const char* get_cname() const { return name_.c_str(); }
 
   void actorList(std::vector<ActorPtr> * whereto);
 
@@ -85,16 +94,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.
    *
@@ -102,12 +115,35 @@ 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<Link*>& 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
+   *
+   * It is not a problem if the actor is not located on the called host.
+   * 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)
+   * 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
+  simgrid::xbt::string name_{"noname"};
+  std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
 
 public:
   // TODO, this could be a unique_ptr
@@ -116,16 +152,6 @@ public:
   surf::Cpu* pimpl_cpu = 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
@@ -133,18 +159,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