Logo AND Algorithmique Numérique Distribuée

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