Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use a typed extension for simix::Host
[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/base.h>
14 #include <xbt/string.hpp>
15 #include <xbt/signal.hpp>
16 #include <xbt/Extendable.hpp>
17
18 #include <simgrid/simix.h>
19 #include <simgrid/datatypes.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  * @link{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 :
43   public simgrid::xbt::Extendable<Host> {
44
45 private:
46   explicit Host(const char *name);
47 public: // TODO, make me private
48   ~Host();
49   /** Do not use this function, it should be private */
50   static Host* by_name_or_create(const char* name);
51
52   /** Retrieves an host from its name, or return nullptr */
53   static Host* by_name_or_null(const char* name);
54   /** Retrieves an host from its name, or die */
55   static s4u::Host *by_name(std::string name);
56   /** Retrieves the host on which the current actor is running */
57   static s4u::Host *current();
58
59   simgrid::xbt::string const& name() const { return name_; }
60
61   /** Turns that host on if it was previously off
62    *
63    * All actors on that host which were marked autorestart will be restarted automatically.
64    * This call does nothing if the host is already on.
65    */
66   void turnOn();
67   /** Turns that host off. All actors are forcefully stopped. */
68   void turnOff();
69   /** Returns if that host is currently up and running */
70   bool isOn();
71   bool isOff() { return !isOn(); }
72
73   double speed();
74   int coresCount();
75   xbt_dict_t properties();
76   const char*property(const char*key);
77   void setProperty(const char*key, const char *value);
78   xbt_swag_t processes();
79   double getPstateSpeedCurrent();
80   double getPstateSpeed(int pstate_index);
81   int pstatesCount() const;
82   void setPstate(int pstate_index);
83   int pstate();
84   void parameters(vm_params_t params);
85   void setParameters(vm_params_t params);
86   xbt_dict_t mountedStoragesAsDict(); // HACK
87   xbt_dynar_t attachedStorages();
88
89   /** Get an associative list [mount point]->[Storage] of all local mount points.
90    *
91    *  This is defined in the platform file, and cannot be modified programatically (yet).
92    */
93   boost::unordered_map<std::string, Storage*> const &mountedStorages();
94
95 private:
96   simgrid::xbt::string name_ = "noname";
97   boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
98
99 public:
100   // TODO, this could be a unique_ptr
101   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
102   surf::Cpu     *pimpl_cpu = nullptr;
103   /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
104   kernel::routing::NetCard *pimpl_netcard = nullptr;
105
106 public:
107   /*** Called on each newly created object */
108   static simgrid::xbt::signal<void(Host&)> onCreation;
109   /*** Called just before destructing an object */
110   static simgrid::xbt::signal<void(Host&)> onDestruction;
111   /*** Called when the machine is turned on or off */
112   static simgrid::xbt::signal<void(Host&)> onStateChange;
113 };
114
115 }} // namespace simgrid::s4u
116
117 extern int MSG_HOST_LEVEL;
118 extern int USER_HOST_LEVEL;
119
120 #endif /* SIMGRID_S4U_HOST_HPP */
121
122 #if 0
123 /* Bindings to the MSG hosts */
124
125 /* Copyright (c) 2006-2014. The SimGrid Team.
126  * All rights reserved.                                                     */
127
128 /* This program is free software; you can redistribute it and/or modify it
129  * under the terms of the license (GNU LGPL) which comes with this package. */
130
131 package org.simgrid.msg;
132
133 public class Host {
134   /**
135    * This static method returns all of the hosts of the installed platform.
136    *
137    * @return      An array containing all the hosts installed.
138    *
139    */ 
140   public native static Host[] all();
141
142   /** 
143    * This static method sets a mailbox to receive in asynchronous mode.
144    * 
145    * All messages sent to this mailbox will be transferred to 
146    * the receiver without waiting for the receive call. 
147    * The receive call will still be necessary to use the received data.
148    * If there is a need to receive some messages asynchronously, and some not, 
149    * two different mailboxes should be used.
150    *
151    * @param mailboxName The name of the mailbox
152    */
153   public static native void setAsyncMailbox(String mailboxName);
154
155   /**
156    * This method returns the number of tasks currently running on a host.
157    * The external load (coming from an availability trace) is not taken in account.
158    *
159    * @return      The number of tasks currently running on a host.
160    */ 
161   public native int getLoad();
162
163
164   /** This methods returns the list of storages attached to an host
165    * @return An array containing all storages (name) attached to the host
166    */
167   public native String[] getAttachedStorage();
168
169
170
171 #endif