Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Fix compilation
[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
20 namespace simgrid {
21 namespace s4u {
22
23 class Actor;
24 class Storage;
25 class File;
26
27 /** @brief Simulated machine that can host some actors
28  *
29  * It represents some physical resource with computing and networking capabilities.
30  *
31  * All hosts are automatically created during the call of the method
32  * @link{simgrid::s4u::Engine::loadPlatform()}.
33  * You cannot create a host yourself.
34  *
35  * You can retrieve a particular host using @link{simgrid::s4u::Host.byName()},
36  * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}.
37  */
38 XBT_PUBLIC_CLASS Host :
39   public simgrid::xbt::Extendable<Host> {
40
41         // friend Actor;
42         // friend File;
43 private:
44         Host(const char *name);
45 public: // TODO, make me private
46         ~Host();
47 public:
48         /** Retrieves an host from its name. */
49         static s4u::Host *byName(std::string name);
50         /** Retrieves the host on which the current actor is running */
51         static s4u::Host *current();
52
53   static Host* by_name_or_null(const char* name);
54   static Host* by_name_or_create(const char* name);
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 getSpeed();
71         int getCoreAmount();
72   xbt_dict_t getProperties();
73   xbt_swag_t getProcessList();
74   double getCurrentPowerPeak();
75   double getPowerPeakAt(int pstate_index);
76   void setPState(int pstate_index);
77         int getNbPStates() const;
78   int getPState();
79   void getParams(vm_params_t params);
80   void setParams(vm_params_t params);
81   xbt_dict_t getMountedStorageList();
82   xbt_dynar_t getAttachedStorageList();
83
84         /** Allows to store user data on that host */
85         // TODO, use the extension stuff instead
86         void set_userdata(void *data) {p_userdata = data;}
87         /** Retrieves the previously stored data */
88         void* userdata() {return p_userdata;}
89
90         /** Get an associative list [mount point]->[Storage] off all local mount points.
91          *
92          *      This is defined in the platform file, and cannot be modified programatically (yet).
93          *
94          *      Do not change the returned value in any way.
95          */
96         // TODO, do not use Storage&, this looks dangerous!
97         boost::unordered_map<std::string, Storage&> &mountedStorages();
98
99 private:
100         simgrid::xbt::string name_ = "noname";
101         boost::unordered_map<std::string, Storage&> *mounts = NULL; // caching
102         void* p_userdata = NULL;
103
104 public:
105         // FIXME: these should be protected, but it leads to many errors
106         // Use the extensions stuff for this? Go through simgrid::surf::Host?
107         surf::Cpu     *pimpl_cpu = nullptr;
108         surf::NetCard *pimpl_netcard = nullptr;
109
110 public:
111         /*** Called on each newly created object */
112         static simgrid::xbt::signal<void(Host&)> onCreation;
113         /*** Called just before destructing an object */
114         static simgrid::xbt::signal<void(Host&)> onDestruction;
115         /*** Called when the machine is turned on or off */
116         static simgrid::xbt::signal<void(Host&)> onStateChange;
117 };
118
119 }} // namespace simgrid::s4u
120
121 extern int MSG_HOST_LEVEL;
122 extern int SD_HOST_LEVEL;
123 extern int SIMIX_HOST_LEVEL;
124 extern int ROUTING_HOST_LEVEL;
125 extern int USER_HOST_LEVEL;
126
127 #endif /* SIMGRID_S4U_HOST_HPP */
128
129 #if 0
130 /* Bindings to the MSG hosts */
131
132 /* Copyright (c) 2006-2014. The SimGrid Team.
133  * All rights reserved.                                                     */
134
135 /* This program is free software; you can redistribute it and/or modify it
136  * under the terms of the license (GNU LGPL) which comes with this package. */
137
138 package org.simgrid.msg;
139
140 import org.simgrid.msg.Storage;
141
142 /*
143 Host jacquelin;
144
145 try { 
146         jacquelin = Host.getByName("Jacquelin");
147 } catch(HostNotFoundException e) {
148         System.err.println(e.toString());
149 }
150 ...
151 \endverbatim
152  *
153  */ 
154 public class Host {
155         /**
156          * This static method returns all of the hosts of the installed platform.
157          *
158          * @return                      An array containing all the hosts installed.
159          *
160          */ 
161         public native static Host[] all();
162
163         /** 
164          * This static method sets a mailbox to receive in asynchronous mode.
165          * 
166          * All messages sent to this mailbox will be transferred to 
167          * the receiver without waiting for the receive call. 
168          * The receive call will still be necessary to use the received data.
169          * If there is a need to receive some messages asynchronously, and some not, 
170          * two different mailboxes should be used.
171          *
172          * @param mailboxName The name of the mailbox
173          */
174         public static native void setAsyncMailbox(String mailboxName);
175
176         /**
177          * This method returns the number of tasks currently running on a host.
178          * The external load (comming from an availability trace) is not taken in account.
179          *
180          * @return                      The number of tasks currently running on a host.
181          */ 
182         public native int getLoad();
183
184         /**
185          * This method returns the speed of the processor of a host,
186          * regardless of the current load of the machine.
187          *
188          * @return                      The speed of the processor of the host in flops.
189          *
190          */ 
191         public native double getSpeed();
192
193         /**
194          * This method returns the number of core of a host.
195          *
196          * @return                      The speed of the processor of the host in flops.
197          *
198          */ 
199         public native double getCoreNumber();
200
201         /**
202          * Returns the value of a given host property (set from the platform file).
203          */
204         public native String getProperty(String name);
205
206         /**
207          * Change the value of a given host property. 
208          */
209         public native void setProperty(String name, String value);
210
211         /** This methods returns the list of storages attached to an host
212          * @return An array containing all storages (name) attached to the host
213          */
214         public native String[] getAttachedStorage();
215
216
217
218 #endif