Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
665f2c85fea063eda1ab3ba0eafbd68e9029e266
[simgrid.git] / include / simgrid / s4u / Host.hpp
1 /* Copyright (c) 2006-2015. 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_HOST_HPP
7 #define SIMGRID_S4U_HOST_HPP
8
9 #include <string>
10
11 #include <boost/unordered_map.hpp>
12
13 #include "xbt/Extendable.hpp"
14 #include "xbt/dict.h"
15 #include "xbt/signal.hpp"
16 #include "xbt/string.hpp"
17 #include "xbt/swag.h"
18
19 #include "simgrid/forward.h"
20 #include "simgrid/s4u/forward.hpp"
21
22 namespace simgrid {
23
24 namespace xbt {
25 extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
26 }
27 namespace s4u {
28
29 /** @ingroup s4u_api
30  *
31  * @tableofcontents
32  *
33  * An host represents some physical resource with computing and networking capabilities.
34  *
35  * All hosts are automatically created during the call of the method
36  * @ref simgrid::s4u::Engine::loadPlatform().
37  * You cannot create a host yourself.
38  *
39  * You can retrieve a particular host using simgrid::s4u::Host::byName()
40  * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
41  */
42 XBT_PUBLIC_CLASS Host : public simgrid::xbt::Extendable<Host>
43 {
44
45 public:
46   explicit Host(const char* name);
47
48   /** Host destruction logic */
49 protected:
50   virtual ~Host();
51
52 private:
53   bool currentlyDestroying_ = false;
54
55 public:
56   void destroy();
57   // No copy/move
58   Host(Host const&) = delete;
59   Host& operator=(Host const&) = delete;
60
61   /** Retrieves an host from its name, or return nullptr */
62   static Host* by_name_or_null(const char* name);
63   /** Retrieves an host from its name, or return nullptr */
64   static Host* by_name_or_null(std::string name);
65   /** Retrieves an host from its name, or die */
66   static s4u::Host* by_name(std::string name);
67   /** Retrieves the host on which the current actor is running */
68   static s4u::Host* current();
69
70   simgrid::xbt::string const& name() const { return name_; }
71   const char* cname() { return name_.c_str(); }
72
73   void actorList(std::vector<ActorPtr> * whereto);
74
75   /** Turns that host on if it was previously off
76    *
77    * All actors on that host which were marked autorestart will be restarted automatically.
78    * This call does nothing if the host is already on.
79    */
80   void turnOn();
81   /** Turns that host off. All actors are forcefully stopped. */
82   void turnOff();
83   /** Returns if that host is currently up and running */
84   bool isOn();
85   /** Returns if that host is currently down and offline */
86   bool isOff() { return not isOn(); }
87
88   double speed();
89   int coreCount();
90   xbt_dict_t properties();
91   const char* property(const char* key);
92   void setProperty(const char* key, const char* value);
93   void processes(std::vector<ActorPtr> * list);
94   double getPstateSpeed(int pstate_index);
95   int pstatesCount() const;
96   void setPstate(int pstate_index);
97   int pstate();
98   xbt_dict_t mountedStoragesAsDict(); // HACK
99   void attachedStorages(std::vector<const char*> * storages);
100
101   /** Get an associative list [mount point]->[Storage] of all local mount points.
102    *
103    *  This is defined in the platform file, and cannot be modified programatically (yet).
104    */
105   boost::unordered_map<std::string, Storage*> const& mountedStorages();
106
107   void routeTo(Host * dest, std::vector<Link*> * links, double* latency);
108   void routeTo(Host * dest, std::vector<surf::LinkImpl*> * links, double* latency);
109
110 private:
111   simgrid::xbt::string name_ = "noname";
112   boost::unordered_map<std::string, Storage*>* mounts = nullptr; // caching
113
114 public:
115   // TODO, this could be a unique_ptr
116   surf::HostImpl* pimpl_ = nullptr;
117   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
118   surf::Cpu* pimpl_cpu = nullptr;
119   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
120   kernel::routing::NetPoint* pimpl_netpoint = nullptr;
121
122   /*** Called on each newly created object */
123   static simgrid::xbt::signal<void(Host&)> onCreation;
124   /*** Called just before destructing an object */
125   static simgrid::xbt::signal<void(Host&)> onDestruction;
126   /*** Called when the machine is turned on or off */
127   static simgrid::xbt::signal<void(Host&)> onStateChange;
128   /*** Called when the speed of the machine is changed
129    * (either because of a pstate switch or because of an external load event coming from the profile) */
130   static simgrid::xbt::signal<void(Host&)> onSpeedChange;
131 };
132 }
133 } // namespace simgrid::s4u
134
135 extern int USER_HOST_LEVEL;
136
137 #endif /* SIMGRID_S4U_HOST_HPP */
138
139 #if 0
140
141 public class Host {
142
143   /**
144    * This method returns the number of tasks currently running on a host.
145    * The external load (coming from an availability trace) is not taken in account.
146    *
147    * @return      The number of tasks currently running on a host.
148    */ 
149   public native int getLoad();
150
151
152 }
153 #endif