Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
spellchecking instead of sleeping
[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 <boost/unordered_map.hpp>
10 #include <vector>
11
12 #include <xbt/base.h>
13 #include <xbt/string.hpp>
14 #include <xbt/signal.hpp>
15 #include <xbt/Extendable.hpp>
16
17 #include <simgrid/simix.h>
18 #include <simgrid/datatypes.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
27 namespace s4u {
28
29 /** @brief Simulated machine that can host some actors
30  *
31  * It represents some physical resource with computing and networking capabilities.
32  *
33  * All hosts are automatically created during the call of the method
34  * @link{simgrid::s4u::Engine::loadPlatform()}.
35  * You cannot create a host yourself.
36  *
37  * You can retrieve a particular host using @link{simgrid::s4u::Host.byName()},
38  * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}.
39  */
40 XBT_PUBLIC_CLASS Host :
41   public simgrid::xbt::Extendable<Host> {
42
43 private:
44   Host(const char *name);
45 public: // TODO, make me private
46   ~Host();
47 public:
48
49   static Host* by_name_or_null(const char* name);
50   static Host* by_name_or_create(const char* name);
51   /** Retrieves an host from its name. */
52   static s4u::Host *by_name(std::string name);
53   /** Retrieves the host on which the current actor is running */
54   static s4u::Host *current();
55
56   simgrid::xbt::string const& name() const { return name_; }
57
58   /** Turns that host on if it was previously off
59    *
60    * All actors on that host which were marked autorestart will be restarted automatically.
61    * This call does nothing if the host is already on.
62    */
63   void turnOn();
64   /** Turns that host off. All actors are forcefully stopped. */
65   void turnOff();
66   /** Returns if that host is currently up and running */
67   bool isOn();
68   bool isOff() { return !isOn(); }
69
70   double speed();
71   int core_count();
72   xbt_dict_t properties();
73   const char*property(const char*key);
74   void setProperty(const char*key, const char *value);
75   xbt_swag_t processes();
76   double currentPowerPeak();
77   double powerPeakAt(int pstate_index);
78   int pstatesCount() const;
79   void setPstate(int pstate_index);
80   int pstate();
81   void parameters(vm_params_t params);
82   void setParameters(vm_params_t params);
83   xbt_dict_t mountedStoragesAsDict(); // HACK
84   xbt_dynar_t attachedStorages();
85
86   /** Get an associative list [mount point]->[Storage] of all local mount points.
87    *
88    *  This is defined in the platform file, and cannot be modified programatically (yet).
89    */
90   boost::unordered_map<std::string, Storage*> const &mountedStorages();
91
92 private:
93   simgrid::xbt::string name_ = "noname";
94   boost::unordered_map<std::string, Storage*> *mounts = NULL; // caching
95
96 public:
97   // FIXME: these should be protected, but it leads to many errors
98   // Use the extensions stuff for this? Go through simgrid::surf::Host?
99   // TODO, this could be a unique_ptr
100   surf::Cpu     *pimpl_cpu = nullptr;
101   surf::NetCard *pimpl_netcard = nullptr;
102
103 public:
104   /*** Called on each newly created object */
105   static simgrid::xbt::signal<void(Host&)> onCreation;
106   /*** Called just before destructing an object */
107   static simgrid::xbt::signal<void(Host&)> onDestruction;
108   /*** Called when the machine is turned on or off */
109   static simgrid::xbt::signal<void(Host&)> onStateChange;
110 };
111
112 }} // namespace simgrid::s4u
113
114 extern int MSG_HOST_LEVEL;
115 extern int SIMIX_HOST_LEVEL;
116 extern int USER_HOST_LEVEL;
117
118 #endif /* SIMGRID_S4U_HOST_HPP */
119
120 #if 0
121 /* Bindings to the MSG hosts */
122
123 /* Copyright (c) 2006-2014. The SimGrid Team.
124  * All rights reserved.                                                     */
125
126 /* This program is free software; you can redistribute it and/or modify it
127  * under the terms of the license (GNU LGPL) which comes with this package. */
128
129 package org.simgrid.msg;
130
131 import org.simgrid.msg.Storage;
132
133 /*
134 Host jacquelin;
135
136 try { 
137   jacquelin = Host.getByName("Jacquelin");
138 } catch(HostNotFoundException e) {
139   System.err.println(e.toString());
140 }
141 ...
142 \endverbatim
143  *
144  */ 
145 public class Host {
146   /**
147    * This static method returns all of the hosts of the installed platform.
148    *
149    * @return      An array containing all the hosts installed.
150    *
151    */ 
152   public native static Host[] all();
153
154   /** 
155    * This static method sets a mailbox to receive in asynchronous mode.
156    * 
157    * All messages sent to this mailbox will be transferred to 
158    * the receiver without waiting for the receive call. 
159    * The receive call will still be necessary to use the received data.
160    * If there is a need to receive some messages asynchronously, and some not, 
161    * two different mailboxes should be used.
162    *
163    * @param mailboxName The name of the mailbox
164    */
165   public static native void setAsyncMailbox(String mailboxName);
166
167   /**
168    * This method returns the number of tasks currently running on a host.
169    * The external load (coming from an availability trace) is not taken in account.
170    *
171    * @return      The number of tasks currently running on a host.
172    */ 
173   public native int getLoad();
174
175   /**
176    * This method returns the speed of the processor of a host,
177    * regardless of the current load of the machine.
178    *
179    * @return      The speed of the processor of the host in flops.
180    *
181    */ 
182   public native double getSpeed();
183
184   /**
185    * This method returns the number of core of a host.
186    *
187    * @return      The speed of the processor of the host in flops.
188    *
189    */ 
190   public native double getCoreNumber();
191
192   /**
193    * Returns the value of a given host property (set from the platform file).
194    */
195   public native String getProperty(String name);
196
197   /**
198    * Change the value of a given host property. 
199    */
200   public native void setProperty(String name, String value);
201
202   /** This methods returns the list of storages attached to an host
203    * @return An array containing all storages (name) attached to the host
204    */
205   public native String[] getAttachedStorage();
206
207
208
209 #endif