Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
37bcf815c24ba0e25156f8519ddd7a0869381940
[simgrid.git] / src / surf / sg_platf.cpp
1 /* Copyright (c) 2006-2021. 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 #include "simgrid/Exception.hpp"
7 #include "simgrid/kernel/routing/ClusterZone.hpp"
8 #include "simgrid/kernel/routing/DijkstraZone.hpp"
9 #include "simgrid/kernel/routing/DragonflyZone.hpp"
10 #include "simgrid/kernel/routing/EmptyZone.hpp"
11 #include "simgrid/kernel/routing/FatTreeZone.hpp"
12 #include "simgrid/kernel/routing/FloydZone.hpp"
13 #include "simgrid/kernel/routing/FullZone.hpp"
14 #include "simgrid/kernel/routing/NetPoint.hpp"
15 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
16 #include "simgrid/kernel/routing/TorusZone.hpp"
17 #include "simgrid/kernel/routing/VivaldiZone.hpp"
18 #include "simgrid/kernel/routing/WifiZone.hpp"
19 #include "simgrid/s4u/Engine.hpp"
20 #include "src/include/simgrid/sg_config.hpp"
21 #include "src/include/surf/surf.hpp"
22 #include "src/kernel/EngineImpl.hpp"
23 #include "src/kernel/resource/DiskImpl.hpp"
24 #include "src/kernel/resource/profile/Profile.hpp"
25 #include "src/simix/smx_private.hpp"
26 #include "src/surf/HostImpl.hpp"
27 #include "src/surf/xml/platf_private.hpp"
28
29 #include <string>
30
31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_parse);
32
33 namespace simgrid {
34 namespace kernel {
35 namespace routing {
36 xbt::signal<void(ClusterCreationArgs const&)> on_cluster_creation;
37 } // namespace routing
38 } // namespace kernel
39 } // namespace simgrid
40
41 /** The current NetZone in the parsing */
42 static simgrid::kernel::routing::NetZoneImpl* current_routing = nullptr;
43 static simgrid::kernel::routing::NetZoneImpl* routing_get_current()
44 {
45   return current_routing;
46 }
47 static simgrid::s4u::Host* current_host = nullptr;
48
49 /** Module management function: creates all internal data structures */
50 void sg_platf_init()
51 {
52   // Do nothing: just for symmetry of user code
53 }
54
55 /** Module management function: frees all internal data structures */
56 void sg_platf_exit()
57 {
58   simgrid::kernel::routing::on_cluster_creation.disconnect_slots();
59   simgrid::s4u::Engine::on_platform_created.disconnect_slots();
60
61   surf_parse_lex_destroy();
62 }
63
64 /** @brief Add a host to the current NetZone */
65 void sg_platf_new_host_begin(const simgrid::kernel::routing::HostCreationArgs* args)
66 {
67   current_host = routing_get_current()
68                      ->create_host(args->id, args->speed_per_pstate)
69                      ->set_coordinates(args->coord)
70                      ->set_core_count(args->core_amount)
71                      ->set_state_profile(args->state_trace)
72                      ->set_speed_profile(args->speed_trace);
73 }
74
75 void sg_platf_new_host_set_properties(const std::unordered_map<std::string, std::string>& props)
76 {
77   xbt_assert(current_host, "Cannot set properties of the current host: none under construction");
78   current_host->set_properties(props);
79 }
80
81 void sg_platf_new_host_seal(int pstate)
82 {
83   xbt_assert(current_host, "Cannot seal the current Host: none under construction");
84   current_host->seal();
85
86   /* When energy plugin is activated, changing the pstate requires to already have the HostEnergy extension whose
87    * allocation is triggered by the on_creation signal. Then set_pstate must be called after the signal emission */
88
89   if (pstate != 0)
90     current_host->set_pstate(pstate);
91
92   current_host = nullptr;
93 }
94
95 /** @brief Add a "router" to the network element list */
96 simgrid::kernel::routing::NetPoint* sg_platf_new_router(const std::string& name, const std::string& coords)
97 {
98   auto* netpoint = current_routing->create_router(name)->set_coordinates(coords);
99   XBT_DEBUG("Router '%s' has the id %u", netpoint->get_cname(), netpoint->id());
100
101   return netpoint;
102 }
103
104 static void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* args, const std::string& link_name)
105 {
106   routing_get_current()
107       ->create_link(link_name, args->bandwidths)
108       ->set_properties(args->properties)
109       ->get_impl() // this call to get_impl saves some simcalls but can be removed
110       ->set_sharing_policy(args->policy)
111       ->set_state_profile(args->state_trace)
112       ->set_latency_profile(args->latency_trace)
113       ->set_bandwidth_profile(args->bandwidth_trace)
114       ->set_latency(args->latency)
115       ->seal();
116 }
117
118 void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* link)
119 {
120   if (link->policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
121     sg_platf_new_link(link, link->id + "_UP");
122     sg_platf_new_link(link, link->id + "_DOWN");
123   } else {
124     sg_platf_new_link(link, link->id);
125   }
126 }
127
128 void sg_platf_new_disk(const simgrid::kernel::routing::DiskCreationArgs* disk)
129 {
130   simgrid::s4u::Disk* new_disk = routing_get_current()
131                                      ->create_disk(disk->id, disk->read_bw, disk->write_bw)
132                                      ->set_host(current_host)
133                                      ->set_properties(disk->properties)
134                                      ->seal();
135
136   current_host->add_disk(new_disk);
137 }
138
139 void sg_platf_new_cluster(simgrid::kernel::routing::ClusterCreationArgs* cluster)
140 {
141   using simgrid::kernel::routing::ClusterZone;
142   using simgrid::kernel::routing::DragonflyZone;
143   using simgrid::kernel::routing::FatTreeZone;
144   using simgrid::kernel::routing::TorusZone;
145
146   int rankId = 0;
147
148   // What an inventive way of initializing the NetZone that I have as ancestor :-(
149   simgrid::kernel::routing::ZoneCreationArgs zone;
150   zone.id = cluster->id;
151   switch (cluster->topology) {
152     case simgrid::kernel::routing::ClusterTopology::TORUS:
153       zone.routing = "ClusterTorus";
154       break;
155     case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
156       zone.routing = "ClusterDragonfly";
157       break;
158     case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
159       zone.routing = "ClusterFatTree";
160       break;
161     default:
162       zone.routing = "Cluster";
163       break;
164   }
165   sg_platf_new_Zone_begin(&zone);
166   auto* current_zone = static_cast<ClusterZone*>(routing_get_current());
167   current_zone->parse_specific_arguments(cluster);
168   for (auto const& elm : cluster->properties)
169     current_zone->get_iface()->set_property(elm.first, elm.second);
170
171   if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
172     current_zone->set_loopback();
173   }
174
175   if (cluster->limiter_link > 0) {
176     current_zone->set_limiter();
177   }
178
179   for (int const& i : cluster->radicals) {
180     std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
181
182     XBT_DEBUG("<host\tid=\"%s\"\tspeed=\"%f\">", host_id.c_str(), cluster->speeds.front());
183     current_zone->create_host(host_id, cluster->speeds)
184         ->set_core_count(cluster->core_amount)
185         ->set_properties(cluster->properties)
186         ->seal();
187
188     XBT_DEBUG("</host>");
189
190     std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
191     XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
192
193     // All links are saved in a matrix;
194     // every row describes a single node; every node may have multiple links.
195     // the first column may store a link from x to x if p_has_loopback is set
196     // the second column may store a limiter link if p_has_limiter is set
197     // other columns are to store one or more link for the node
198
199     // add a loopback link
200     simgrid::kernel::resource::LinkImpl* loopback = nullptr;
201     if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
202       std::string loopback_name = link_id + "_loopback";
203       XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", loopback_name.c_str(), cluster->loopback_bw);
204
205       loopback = current_zone->create_link(loopback_name, std::vector<double>{cluster->loopback_bw})
206                      ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
207                      ->set_latency(cluster->loopback_lat)
208                      ->seal()
209                      ->get_impl();
210
211       current_zone->add_private_link_at(current_zone->node_pos(rankId), {loopback, loopback});
212     }
213
214     // add a limiter link (shared link to account for maximal bandwidth of the node)
215     simgrid::kernel::resource::LinkImpl* limiter = nullptr;
216     if (cluster->limiter_link > 0) {
217       std::string limiter_name = std::string(link_id) + "_limiter";
218       XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", limiter_name.c_str(), cluster->limiter_link);
219
220       limiter = current_zone->create_link(limiter_name, std::vector<double>{cluster->limiter_link})->seal()->get_impl();
221
222       current_zone->add_private_link_at(current_zone->node_pos_with_loopback(rankId), {limiter, limiter});
223     }
224
225     // call the cluster function that adds the others links
226     if (cluster->topology == simgrid::kernel::routing::ClusterTopology::FAT_TREE) {
227       static_cast<FatTreeZone*>(current_zone)->add_processing_node(i, limiter, loopback);
228     } else {
229       current_zone->create_links_for_node(cluster, i, rankId, current_zone->node_pos_with_loopback_limiter(rankId));
230     }
231     rankId++;
232   }
233
234   // Add a router.
235   XBT_DEBUG(" ");
236   XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
237   if (cluster->router_id.empty())
238     cluster->router_id = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
239   current_zone->set_router(current_zone->create_router(cluster->router_id));
240
241   // Make the backbone
242   if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
243     std::string bb_name = std::string(cluster->id) + "_backbone";
244     XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/> <!--backbone -->", bb_name.c_str(), cluster->bb_bw,
245               cluster->bb_lat);
246
247     auto* backbone = current_zone->create_link(bb_name, std::vector<double>{cluster->bb_bw})
248                          ->set_sharing_policy(cluster->bb_sharing_policy)
249                          ->set_latency(cluster->bb_lat)
250                          ->seal();
251     current_zone->set_backbone(backbone->get_impl());
252   }
253
254   XBT_DEBUG("</zone>");
255   sg_platf_new_Zone_seal();
256
257   simgrid::kernel::routing::on_cluster_creation(*cluster);
258 }
259
260 void routing_cluster_add_backbone(simgrid::kernel::resource::LinkImpl* bb)
261 {
262   auto* cluster = dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
263
264   xbt_assert(cluster, "Only hosts from Cluster can get a backbone.");
265   xbt_assert(not cluster->has_backbone(), "Cluster %s already has a backbone link!", cluster->get_cname());
266
267   cluster->set_backbone(bb);
268   XBT_DEBUG("Add a backbone to zone '%s'", current_routing->get_cname());
269 }
270
271 void sg_platf_new_cabinet(const simgrid::kernel::routing::CabinetCreationArgs* cabinet)
272 {
273   auto* zone = static_cast<simgrid::kernel::routing::ClusterZone*>(routing_get_current());
274   for (int const& radical : cabinet->radicals) {
275     std::string id           = cabinet->prefix + std::to_string(radical) + cabinet->suffix;
276     simgrid::s4u::Host* host = zone->create_host(id, std::vector<double>{cabinet->speed})->seal();
277
278     simgrid::s4u::Link* link_up =
279         zone->create_link("link_" + id + "_UP", std::vector<double>{cabinet->bw})->set_latency(cabinet->lat)->seal();
280     simgrid::s4u::Link* link_down =
281         zone->create_link("link_" + id + "_DOWN", std::vector<double>{cabinet->bw})->set_latency(cabinet->lat)->seal();
282
283     zone->add_private_link_at(host->get_netpoint()->id(), {link_up->get_impl(), link_down->get_impl()});
284   }
285 }
286
287 void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route)
288 {
289   routing_get_current()->add_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list,
290                                    route->symmetrical);
291 }
292
293 void sg_platf_new_bypassRoute(simgrid::kernel::routing::RouteCreationArgs* bypassRoute)
294 {
295   routing_get_current()->add_bypass_route(bypassRoute->src, bypassRoute->dst, bypassRoute->gw_src, bypassRoute->gw_dst,
296                                           bypassRoute->link_list, bypassRoute->symmetrical);
297 }
298
299 void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor)
300 {
301   sg_host_t host = sg_host_by_name(actor->host);
302   if (not host) {
303     // The requested host does not exist. Do a nice message to the user
304     std::string msg = std::string("Cannot create actor '") + actor->function + "': host '" + actor->host +
305                       "' does not exist\nExisting hosts: '";
306
307     std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
308
309     for (auto const& some_host : list) {
310       msg += some_host->get_name();
311       msg += "', '";
312       if (msg.length() > 1024) {
313         msg.pop_back(); // remove trailing quote
314         msg += "...(list truncated)......";
315         break;
316       }
317     }
318     xbt_die("%s", msg.c_str());
319   }
320   const simgrid::kernel::actor::ActorCodeFactory& factory =
321       simgrid::kernel::EngineImpl::get_instance()->get_function(actor->function);
322   xbt_assert(factory, "Error while creating an actor from the XML file: Function '%s' not registered", actor->function);
323
324   double start_time = actor->start_time;
325   double kill_time  = actor->kill_time;
326   bool auto_restart = actor->restart_on_failure;
327
328   std::string actor_name                 = actor->args[0];
329   simgrid::kernel::actor::ActorCode code = factory(std::move(actor->args));
330
331   auto* arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
332                                                      auto_restart);
333
334   host->get_impl()->add_actor_at_boot(arg);
335
336   if (start_time > SIMIX_get_clock()) {
337     arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
338                                                  auto_restart);
339
340     XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->get_cname(), start_time);
341     simgrid::simix::Timer::set(start_time, [arg, auto_restart]() {
342       simgrid::kernel::actor::ActorImplPtr new_actor =
343           simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), arg->code, arg->data, arg->host, nullptr);
344       new_actor->set_properties(arg->properties);
345       if (arg->kill_time >= 0)
346         new_actor->set_kill_time(arg->kill_time);
347       if (auto_restart)
348         new_actor->set_auto_restart(auto_restart);
349       delete arg;
350     });
351   } else { // start_time <= SIMIX_get_clock()
352     XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->get_cname());
353
354     try {
355       simgrid::kernel::actor::ActorImplPtr new_actor = nullptr;
356       new_actor = simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), code, nullptr, host, nullptr);
357       new_actor->set_properties(arg->properties);
358       /* The actor creation will fail if the host is currently dead, but that's fine */
359       if (arg->kill_time >= 0)
360         new_actor->set_kill_time(arg->kill_time);
361       if (auto_restart)
362         new_actor->set_auto_restart(auto_restart);
363     } catch (simgrid::HostFailureException const&) {
364       XBT_WARN("Deployment includes some initially turned off Hosts ... nevermind.");
365     }
366   }
367 }
368
369 void sg_platf_new_peer(const simgrid::kernel::routing::PeerCreationArgs* peer)
370 {
371   auto* zone = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
372   xbt_assert(zone, "<peer> tag can only be used in Vivaldi netzones.");
373
374   simgrid::s4u::Host* host = zone->create_host(peer->id, std::vector<double>{peer->speed})
375                                  ->set_state_profile(peer->state_trace)
376                                  ->set_speed_profile(peer->speed_trace)
377                                  ->set_coordinates(peer->coord)
378                                  ->seal();
379
380   zone->set_peer_link(host->get_netpoint(), peer->bw_in, peer->bw_out);
381 }
382 /**
383  * @brief Auxiliary function to build the object NetZoneImpl
384  *
385  * Builds the objects, setting its father properties and root netzone if needed
386  * @param zone the parameters defining the Zone to build.
387  * @return Pointer to recently created netzone
388  */
389 static simgrid::kernel::routing::NetZoneImpl*
390 sg_platf_create_zone(const simgrid::kernel::routing::ZoneCreationArgs* zone)
391 {
392   /* search the routing model */
393   simgrid::kernel::routing::NetZoneImpl* new_zone = nullptr;
394
395   if (strcasecmp(zone->routing.c_str(), "Cluster") == 0) {
396     new_zone = new simgrid::kernel::routing::ClusterZone(zone->id);
397   } else if (strcasecmp(zone->routing.c_str(), "ClusterDragonfly") == 0) {
398     new_zone = new simgrid::kernel::routing::DragonflyZone(zone->id);
399   } else if (strcasecmp(zone->routing.c_str(), "ClusterTorus") == 0) {
400     new_zone = new simgrid::kernel::routing::TorusZone(zone->id);
401   } else if (strcasecmp(zone->routing.c_str(), "ClusterFatTree") == 0) {
402     new_zone = new simgrid::kernel::routing::FatTreeZone(zone->id);
403   } else if (strcasecmp(zone->routing.c_str(), "Dijkstra") == 0) {
404     new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, false);
405   } else if (strcasecmp(zone->routing.c_str(), "DijkstraCache") == 0) {
406     new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, true);
407   } else if (strcasecmp(zone->routing.c_str(), "Floyd") == 0) {
408     new_zone = new simgrid::kernel::routing::FloydZone(zone->id);
409   } else if (strcasecmp(zone->routing.c_str(), "Full") == 0) {
410     new_zone = new simgrid::kernel::routing::FullZone(zone->id);
411   } else if (strcasecmp(zone->routing.c_str(), "None") == 0) {
412     new_zone = new simgrid::kernel::routing::EmptyZone(zone->id);
413   } else if (strcasecmp(zone->routing.c_str(), "Vivaldi") == 0) {
414     new_zone = new simgrid::kernel::routing::VivaldiZone(zone->id);
415   } else if (strcasecmp(zone->routing.c_str(), "Wifi") == 0) {
416     new_zone = new simgrid::kernel::routing::WifiZone(zone->id);
417   } else {
418     xbt_die("Not a valid model!");
419   }
420   new_zone->set_parent(current_routing);
421
422   return new_zone;
423 }
424
425 /**
426  * @brief Add a Zone to the platform
427  *
428  * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
429  * and before the corresponding call to sg_platf_new_Zone_seal() will be added to this Zone.
430  *
431  * Once this function was called, the configuration concerning the used models cannot be changed anymore.
432  *
433  * @param zone the parameters defining the Zone to build.
434  */
435 simgrid::kernel::routing::NetZoneImpl* sg_platf_new_Zone_begin(const simgrid::kernel::routing::ZoneCreationArgs* zone)
436 {
437   /* First create the zone.
438    * This order is important to assure that root netzone is set when models are setting
439    * the default mode for each resource (CPU, network, etc)
440    */
441   auto* new_zone = sg_platf_create_zone(zone);
442
443   _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
444                             * any further config now that we created some real content */
445
446   /* set the new current component of the tree */
447   current_routing = new_zone;
448   simgrid::s4u::NetZone::on_creation(*new_zone->get_iface()); // notify the signal
449
450   return new_zone;
451 }
452
453 void sg_platf_new_Zone_set_properties(const std::unordered_map<std::string, std::string>& props)
454 {
455   xbt_assert(current_routing, "Cannot set properties of the current Zone: none under construction");
456
457   current_routing->set_properties(props);
458 }
459
460 /**
461  * @brief Specify that the description of the current Zone is finished
462  *
463  * Once you've declared all the content of your Zone, you have to seal
464  * it with this call. Your Zone is not usable until you call this function.
465  */
466 void sg_platf_new_Zone_seal()
467 {
468   xbt_assert(current_routing, "Cannot seal the current Zone: none under construction");
469   current_routing->seal();
470   simgrid::s4u::NetZone::on_seal(*current_routing->get_iface());
471   current_routing = current_routing->get_parent();
472 }
473
474 /** @brief Add a link connecting a host to the rest of its Zone (which must be cluster or vivaldi) */
475 void sg_platf_new_hostlink(const simgrid::kernel::routing::HostLinkCreationArgs* hostlink)
476 {
477   const simgrid::kernel::routing::NetPoint* netpoint = simgrid::s4u::Host::by_name(hostlink->id)->get_netpoint();
478   xbt_assert(netpoint, "Host '%s' not found!", hostlink->id.c_str());
479   xbt_assert(dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing),
480              "Only hosts from Cluster and Vivaldi Zones can get a host_link.");
481
482   const simgrid::s4u::Link* linkUp   = simgrid::s4u::Link::by_name_or_null(hostlink->link_up);
483   const simgrid::s4u::Link* linkDown = simgrid::s4u::Link::by_name_or_null(hostlink->link_down);
484
485   xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up.c_str());
486   xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down.c_str());
487
488   auto* cluster_zone = static_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
489
490   if (cluster_zone->private_link_exists_at(netpoint->id()))
491     surf_parse_error(std::string("Host_link for '") + hostlink->id.c_str() + "' is already defined!");
492
493   XBT_DEBUG("Push Host_link for host '%s' to position %u", netpoint->get_cname(), netpoint->id());
494   cluster_zone->add_private_link_at(netpoint->id(), {linkUp->get_impl(), linkDown->get_impl()});
495 }
496
497 void sg_platf_new_trace(simgrid::kernel::routing::ProfileCreationArgs* profile)
498 {
499   simgrid::kernel::profile::Profile* mgr_profile;
500   if (not profile->file.empty()) {
501     mgr_profile = simgrid::kernel::profile::Profile::from_file(profile->file);
502   } else {
503     xbt_assert(not profile->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
504                profile->id.c_str());
505     mgr_profile = simgrid::kernel::profile::Profile::from_string(profile->id, profile->pc_data, profile->periodicity);
506   }
507   traces_set_list.insert({profile->id, mgr_profile});
508 }