Merge branch 'depencencies' of https://framagit.org/simgrid/simgrid into depencencies

[simgrid.git] / include / simgrid / s4u / Host.hpp

diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp
index 16c5ffe..4870a86 100644 (file)
--- a/include/simgrid/s4u/Host.hpp
+++ b/include/simgrid/s4u/Host.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2020. 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. */
@@ -16,9 +16,7 @@
 
 namespace simgrid {
 
-namespace xbt {
-extern template class XBT_PUBLIC Extendable<s4u::Host>;
-} // namespace xbt
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Host>;
 
 namespace s4u {
 /** @ingroup s4u_api
@@ -27,17 +25,20 @@ namespace s4u {
  *
  * Some physical resource with computing and networking capabilities on which Actors execute.
  *
+ * @beginrst
  * All hosts are automatically created during the call of the method
- * @ref simgrid::s4u::Engine::load_platform().
+ * :cpp:func:`simgrid::s4u::Engine::load_platform()`.
  * You cannot create a host yourself.
  *
- * You can retrieve a particular host using @ref simgrid::s4u::Host::by_name()
- * and actors can retrieve the host on which they run using @ref simgrid::s4u::Host::current() or
- * @ref simgrid::s4u::this_actor::get_host().
+ * You can retrieve a particular host using :cpp:func:`simgrid::s4u::Host::by_name()`
+ * and actors can retrieve the host on which they run using :cpp:func:`simgrid::s4u::Host::current()` or
+ * :cpp:func:`simgrid::s4u::this_actor::get_host()`
+ * @endrst
  */
 class XBT_PUBLIC Host : public xbt::Extendable<Host> {
   friend vm::VMModel;            // Use the pimpl_cpu to compute the VM sharing
   friend vm::VirtualMachineImpl; // creates the the pimpl_cpu
+  friend kernel::routing::NetZoneImpl;
 
 public:
   explicit Host(const std::string& name);
@@ -45,18 +46,19 @@ public:
   /** Host destruction logic */
 protected:
   virtual ~Host();
+  void set_netpoint(kernel::routing::NetPoint* netpoint) { pimpl_netpoint_ = netpoint; }
 
 private:
   bool currently_destroying_ = false;
 
 public:
-  /*** Called on each newly created host */
+  /** Called on each newly created host */
   static xbt::signal<void(Host&)> on_creation;
-  /*** Called just before destructing a host */
+  /** 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) */
+  /** 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)
+  /** 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;
 
@@ -77,8 +79,10 @@ public:
   /** Retrieves the name of that host as a C string */
   const char* get_cname() const { return name_.c_str(); }
 
-  int get_actor_count();
-  std::vector<ActorPtr> get_all_actors();
+  kernel::routing::NetPoint* get_netpoint() const { return pimpl_netpoint_; }
+
+  int get_actor_count() const;
+  std::vector<ActorPtr> get_all_actors() const;
 
   /** Turns that host on if it was previously off
    *
@@ -94,8 +98,6 @@ public:
   void turn_off();
   /** Returns if that host is currently up and running */
   bool is_on() const;
-  /** Returns if that host is currently down and offline */
-  XBT_ATTRIB_DEPRECATED_v325("Please use !is_on()") bool is_off() const { return not is_on(); }
 
   const char* get_property(const std::string& key) const;
   void set_property(const std::string& key, const std::string& value);
@@ -116,16 +118,19 @@ public:
   int get_pstate() const;
 
   std::vector<Disk*> get_disks() const;
+  void add_disk(Disk* disk);
+  void remove_disk(const std::string& disk_name);
+
   std::vector<const char*> get_attached_storages() const;
 
   /** Get an associative list [mount point]->[Storage] of all local mount points.
    *
-   *  This is defined in the platform file, and cannot be modified programatically (yet).
+   *  This is defined in the platform file, and cannot be modified programmatically (yet).
    */
   std::unordered_map<std::string, Storage*> const& get_mounted_storages();
 
-  void route_to(Host* dest, std::vector<Link*>& links, double* latency);
-  void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
+  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;
   void send_to(Host* dest, double byte_amount);
 
   NetZone* get_englobing_zone();
@@ -144,6 +149,7 @@ public:
 private:
   xbt::string name_{"noname"};
   std::unordered_map<std::string, Storage*>* mounts_ = nullptr; // caching
+  kernel::routing::NetPoint* pimpl_netpoint_         = nullptr;
 
 public:
 #ifndef DOXYGEN
@@ -151,13 +157,9 @@ public:
   kernel::resource::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;
 #endif
 };
 } // namespace s4u
 } // namespace simgrid
 
-extern int USER_HOST_LEVEL;
-
 #endif /* SIMGRID_S4U_HOST_HPP */