Logo AND Algorithmique Numérique Distribuée

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