Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
do not throw signal from sg_platf
[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 void sg_platf_new_peer(const simgrid::kernel::routing::PeerCreationArgs* args)
96 {
97   auto* zone = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
98   xbt_assert(zone, "<peer> tag can only be used in Vivaldi netzones.");
99
100   const auto* peer = zone->create_host(args->id, std::vector<double>{args->speed})
101                          ->set_state_profile(args->state_trace)
102                          ->set_speed_profile(args->speed_trace)
103                          ->set_coordinates(args->coord)
104                          ->seal();
105
106   zone->set_peer_link(peer->get_netpoint(), args->bw_in, args->bw_out);
107 }
108
109 /** @brief Add a "router" to the network element list */
110 simgrid::kernel::routing::NetPoint* sg_platf_new_router(const std::string& name, const std::string& coords)
111 {
112   auto* netpoint = current_routing->create_router(name)->set_coordinates(coords);
113   XBT_DEBUG("Router '%s' has the id %u", netpoint->get_cname(), netpoint->id());
114
115   return netpoint;
116 }
117
118 static void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* args, const std::string& link_name)
119 {
120   routing_get_current()
121       ->create_link(link_name, args->bandwidths)
122       ->set_properties(args->properties)
123       ->get_impl() // this call to get_impl saves some simcalls but can be removed
124       ->set_sharing_policy(args->policy)
125       ->set_state_profile(args->state_trace)
126       ->set_latency_profile(args->latency_trace)
127       ->set_bandwidth_profile(args->bandwidth_trace)
128       ->set_latency(args->latency)
129       ->seal();
130 }
131
132 void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* link)
133 {
134   if (link->policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
135     sg_platf_new_link(link, link->id + "_UP");
136     sg_platf_new_link(link, link->id + "_DOWN");
137   } else {
138     sg_platf_new_link(link, link->id);
139   }
140 }
141
142 void sg_platf_new_disk(const simgrid::kernel::routing::DiskCreationArgs* disk)
143 {
144   const simgrid::s4u::Disk* new_disk = routing_get_current()
145                                            ->create_disk(disk->id, disk->read_bw, disk->write_bw)
146                                            ->set_host(current_host)
147                                            ->set_properties(disk->properties)
148                                            ->seal();
149
150   current_host->add_disk(new_disk);
151 }
152
153 /** @brief Auxiliary function to create hosts */
154 static std::pair<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*>
155 sg_platf_cluster_create_host(const simgrid::kernel::routing::ClusterCreationArgs* cluster, simgrid::s4u::NetZone* zone,
156                              const std::vector<unsigned int>& /*coord*/, int id)
157 {
158   std::string host_id = std::string(cluster->prefix) + std::to_string(id) + cluster->suffix;
159   XBT_DEBUG("Cluster: creating host=%s speed=%f", host_id.c_str(), cluster->speeds.front());
160   const simgrid::s4u::Host* host = zone->create_host(host_id, cluster->speeds)
161                                        ->set_core_count(cluster->core_amount)
162                                        ->set_properties(cluster->properties)
163                                        ->seal();
164   return std::make_pair(host->get_netpoint(), nullptr);
165 }
166
167 /** @brief Auxiliary function to create loopback links */
168 static simgrid::s4u::Link*
169 sg_platf_cluster_create_loopback(const simgrid::kernel::routing::ClusterCreationArgs* cluster,
170                                  simgrid::s4u::NetZone* zone, const std::vector<unsigned int>& /*coord*/, int id)
171 {
172   std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(id) + "_loopback";
173   XBT_DEBUG("Cluster: creating loopback link=%s bw=%f", link_id.c_str(), cluster->loopback_bw);
174
175   simgrid::s4u::Link* loopback = zone->create_link(link_id, cluster->loopback_bw)
176                                      ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
177                                      ->set_latency(cluster->loopback_lat)
178                                      ->seal();
179   return loopback;
180 }
181
182 /** @brief Auxiliary function to create limiter links */
183 static simgrid::s4u::Link* sg_platf_cluster_create_limiter(const simgrid::kernel::routing::ClusterCreationArgs* cluster,
184                                                            simgrid::s4u::NetZone* zone,
185                                                            const std::vector<unsigned int>& /*coord*/, int id)
186 {
187   std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(id) + "_limiter";
188   XBT_DEBUG("Cluster: creating limiter link=%s bw=%f", link_id.c_str(), cluster->limiter_link);
189
190   simgrid::s4u::Link* limiter = zone->create_link(link_id, cluster->limiter_link)->seal();
191   return limiter;
192 }
193
194 /** @brief Create Torus, Fat-Tree and Dragonfly clusters */
195 static void sg_platf_new_cluster_hierarchical(const simgrid::kernel::routing::ClusterCreationArgs* cluster)
196 {
197   using namespace std::placeholders;
198   using simgrid::kernel::routing::DragonflyZone;
199   using simgrid::kernel::routing::FatTreeZone;
200   using simgrid::kernel::routing::TorusZone;
201
202   auto set_host = std::bind(sg_platf_cluster_create_host, cluster, _1, _2, _3);
203   std::function<simgrid::s4u::ClusterLinkCb> set_loopback{};
204   std::function<simgrid::s4u::ClusterLinkCb> set_limiter{};
205
206   if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
207     set_loopback = std::bind(sg_platf_cluster_create_loopback, cluster, _1, _2, _3);
208   }
209
210   if (cluster->limiter_link > 0) {
211     set_loopback = std::bind(sg_platf_cluster_create_limiter, cluster, _1, _2, _3);
212   }
213
214   simgrid::s4u::NetZone* parent = routing_get_current() ? routing_get_current()->get_iface() : nullptr;
215   simgrid::s4u::NetZone* zone;
216   switch (cluster->topology) {
217     case simgrid::kernel::routing::ClusterTopology::TORUS:
218       zone = simgrid::s4u::create_torus_zone(
219           cluster->id, parent, TorusZone::parse_topo_parameters(cluster->topo_parameters), cluster->bw, cluster->lat,
220           cluster->sharing_policy, set_host, set_loopback, set_limiter);
221       break;
222     case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
223       zone = simgrid::s4u::create_dragonfly_zone(
224           cluster->id, parent, DragonflyZone::parse_topo_parameters(cluster->topo_parameters), cluster->bw,
225           cluster->lat, cluster->sharing_policy, set_host, set_loopback, set_limiter);
226       break;
227     case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
228       zone = simgrid::s4u::create_fatTree_zone(
229           cluster->id, parent, FatTreeZone::parse_topo_parameters(cluster->topo_parameters), cluster->bw, cluster->lat,
230           cluster->sharing_policy, set_host, set_loopback, set_limiter);
231       break;
232     default:
233       THROW_IMPOSSIBLE;
234       break;
235   }
236   zone->seal();
237 }
238
239 /** @brief Create regular Cluster */
240 static void sg_platf_new_cluster_flat(simgrid::kernel::routing::ClusterCreationArgs* cluster)
241 {
242   using simgrid::kernel::routing::ClusterZone;
243
244   int rankId = 0;
245
246   // What an inventive way of initializing the NetZone that I have as ancestor :-(
247   simgrid::kernel::routing::ZoneCreationArgs zone;
248   zone.id      = cluster->id;
249   zone.routing = "Cluster";
250   sg_platf_new_Zone_begin(&zone);
251   auto* current_zone = static_cast<ClusterZone*>(routing_get_current());
252   for (auto const& elm : cluster->properties)
253     current_zone->get_iface()->set_property(elm.first, elm.second);
254
255   if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
256     current_zone->set_loopback();
257   }
258
259   if (cluster->limiter_link > 0) {
260     current_zone->set_limiter();
261   }
262
263   for (int const& i : cluster->radicals) {
264     std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
265
266     XBT_DEBUG("<host\tid=\"%s\"\tspeed=\"%f\">", host_id.c_str(), cluster->speeds.front());
267     current_zone->create_host(host_id, cluster->speeds)
268         ->set_core_count(cluster->core_amount)
269         ->set_properties(cluster->properties)
270         ->seal();
271
272     XBT_DEBUG("</host>");
273
274     std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
275     XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
276
277     // All links are saved in a matrix;
278     // every row describes a single node; every node may have multiple links.
279     // the first column may store a link from x to x if p_has_loopback is set
280     // the second column may store a limiter link if p_has_limiter is set
281     // other columns are to store one or more link for the node
282
283     // add a loopback link
284     simgrid::kernel::resource::LinkImpl* loopback = nullptr;
285     if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
286       std::string loopback_name = link_id + "_loopback";
287       XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", loopback_name.c_str(), cluster->loopback_bw);
288
289       loopback = current_zone->create_link(loopback_name, std::vector<double>{cluster->loopback_bw})
290                      ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
291                      ->set_latency(cluster->loopback_lat)
292                      ->seal()
293                      ->get_impl();
294
295       current_zone->add_private_link_at(current_zone->node_pos(rankId), {loopback, loopback});
296     }
297
298     // add a limiter link (shared link to account for maximal bandwidth of the node)
299     simgrid::kernel::resource::LinkImpl* limiter = nullptr;
300     if (cluster->limiter_link > 0) {
301       std::string limiter_name = std::string(link_id) + "_limiter";
302       XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", limiter_name.c_str(), cluster->limiter_link);
303
304       limiter = current_zone->create_link(limiter_name, std::vector<double>{cluster->limiter_link})->seal()->get_impl();
305
306       current_zone->add_private_link_at(current_zone->node_pos_with_loopback(rankId), {limiter, limiter});
307     }
308
309     // call the cluster function that adds the others links
310     current_zone->create_links_for_node(cluster, i, rankId, current_zone->node_pos_with_loopback_limiter(rankId));
311     rankId++;
312   }
313
314   // Add a router.
315   XBT_DEBUG(" ");
316   XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
317   if (cluster->router_id.empty())
318     cluster->router_id = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
319   current_zone->set_router(current_zone->create_router(cluster->router_id));
320
321   // Make the backbone
322   if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
323     std::string bb_name = std::string(cluster->id) + "_backbone";
324     XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/> <!--backbone -->", bb_name.c_str(), cluster->bb_bw,
325               cluster->bb_lat);
326
327     auto* backbone = current_zone->create_link(bb_name, std::vector<double>{cluster->bb_bw})
328                          ->set_sharing_policy(cluster->bb_sharing_policy)
329                          ->set_latency(cluster->bb_lat)
330                          ->seal()
331                          ->get_impl();
332     current_zone->set_backbone(backbone);
333   }
334
335   XBT_DEBUG("</zone>");
336   sg_platf_new_Zone_seal();
337 }
338
339 void sg_platf_new_cluster(simgrid::kernel::routing::ClusterCreationArgs* cluster)
340 {
341   switch (cluster->topology) {
342     case simgrid::kernel::routing::ClusterTopology::TORUS:
343     case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
344     case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
345       sg_platf_new_cluster_hierarchical(cluster);
346       break;
347     default:
348       sg_platf_new_cluster_flat(cluster);
349       break;
350   }
351
352   simgrid::kernel::routing::on_cluster_creation(*cluster);
353 }
354
355 void routing_cluster_add_backbone(simgrid::kernel::resource::LinkImpl* bb)
356 {
357   auto* cluster = dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
358
359   xbt_assert(cluster, "Only hosts from Cluster can get a backbone.");
360   xbt_assert(not cluster->has_backbone(), "Cluster %s already has a backbone link!", cluster->get_cname());
361
362   cluster->set_backbone(bb);
363   XBT_DEBUG("Add a backbone to zone '%s'", current_routing->get_cname());
364 }
365
366 void sg_platf_new_cabinet(const simgrid::kernel::routing::CabinetCreationArgs* args)
367 {
368   auto* zone = static_cast<simgrid::kernel::routing::ClusterZone*>(routing_get_current());
369   for (int const& radical : args->radicals) {
370     std::string id   = args->prefix + std::to_string(radical) + args->suffix;
371     auto const* host = zone->create_host(id, std::vector<double>{args->speed})->seal();
372
373     const auto* link_up =
374         zone->create_link("link_" + id + "_UP", std::vector<double>{args->bw})->set_latency(args->lat)->seal();
375
376     const auto* link_down =
377         zone->create_link("link_" + id + "_DOWN", std::vector<double>{args->bw})->set_latency(args->lat)->seal();
378
379     zone->add_private_link_at(host->get_netpoint()->id(), {link_up->get_impl(), link_down->get_impl()});
380   }
381 }
382
383 void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route)
384 {
385   routing_get_current()->add_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list,
386                                    route->symmetrical);
387 }
388
389 void sg_platf_new_bypassRoute(simgrid::kernel::routing::RouteCreationArgs* bypassRoute)
390 {
391   routing_get_current()->add_bypass_route(bypassRoute->src, bypassRoute->dst, bypassRoute->gw_src, bypassRoute->gw_dst,
392                                           bypassRoute->link_list, bypassRoute->symmetrical);
393 }
394
395 void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor)
396 {
397   sg_host_t host = sg_host_by_name(actor->host);
398   if (not host) {
399     // The requested host does not exist. Do a nice message to the user
400     std::string msg = std::string("Cannot create actor '") + actor->function + "': host '" + actor->host +
401                       "' does not exist\nExisting hosts: '";
402
403     std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
404
405     for (auto const& some_host : list) {
406       msg += some_host->get_name();
407       msg += "', '";
408       if (msg.length() > 1024) {
409         msg.pop_back(); // remove trailing quote
410         msg += "...(list truncated)......";
411         break;
412       }
413     }
414     xbt_die("%s", msg.c_str());
415   }
416   const simgrid::kernel::actor::ActorCodeFactory& factory =
417       simgrid::kernel::EngineImpl::get_instance()->get_function(actor->function);
418   xbt_assert(factory, "Error while creating an actor from the XML file: Function '%s' not registered", actor->function);
419
420   double start_time = actor->start_time;
421   double kill_time  = actor->kill_time;
422   bool auto_restart = actor->restart_on_failure;
423
424   std::string actor_name                 = actor->args[0];
425   simgrid::kernel::actor::ActorCode code = factory(std::move(actor->args));
426
427   auto* arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
428                                                      auto_restart);
429
430   host->get_impl()->add_actor_at_boot(arg);
431
432   if (start_time > SIMIX_get_clock()) {
433     arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
434                                                  auto_restart);
435
436     XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->get_cname(), start_time);
437     simgrid::simix::Timer::set(start_time, [arg, auto_restart]() {
438       simgrid::kernel::actor::ActorImplPtr new_actor =
439           simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), arg->code, arg->data, arg->host, nullptr);
440       new_actor->set_properties(arg->properties);
441       if (arg->kill_time >= 0)
442         new_actor->set_kill_time(arg->kill_time);
443       if (auto_restart)
444         new_actor->set_auto_restart(auto_restart);
445       delete arg;
446     });
447   } else { // start_time <= SIMIX_get_clock()
448     XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->get_cname());
449
450     try {
451       simgrid::kernel::actor::ActorImplPtr new_actor = nullptr;
452       new_actor = simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), code, nullptr, host, nullptr);
453       new_actor->set_properties(arg->properties);
454       /* The actor creation will fail if the host is currently dead, but that's fine */
455       if (arg->kill_time >= 0)
456         new_actor->set_kill_time(arg->kill_time);
457       if (auto_restart)
458         new_actor->set_auto_restart(auto_restart);
459     } catch (simgrid::HostFailureException const&) {
460       XBT_WARN("Deployment includes some initially turned off Hosts ... nevermind.");
461     }
462   }
463 }
464
465 /**
466  * @brief Auxiliary function to build the object NetZoneImpl
467  *
468  * Builds the objects, setting its father properties and root netzone if needed
469  * @param zone the parameters defining the Zone to build.
470  * @return Pointer to recently created netzone
471  */
472 static simgrid::kernel::routing::NetZoneImpl*
473 sg_platf_create_zone(const simgrid::kernel::routing::ZoneCreationArgs* zone)
474 {
475   /* search the routing model */
476   simgrid::kernel::routing::NetZoneImpl* new_zone = nullptr;
477
478   if (strcasecmp(zone->routing.c_str(), "Cluster") == 0) {
479     new_zone = new simgrid::kernel::routing::ClusterZone(zone->id);
480   } else if (strcasecmp(zone->routing.c_str(), "ClusterDragonfly") == 0) {
481     new_zone = new simgrid::kernel::routing::DragonflyZone(zone->id);
482   } else if (strcasecmp(zone->routing.c_str(), "ClusterTorus") == 0) {
483     new_zone = new simgrid::kernel::routing::TorusZone(zone->id);
484   } else if (strcasecmp(zone->routing.c_str(), "ClusterFatTree") == 0) {
485     new_zone = new simgrid::kernel::routing::FatTreeZone(zone->id);
486   } else if (strcasecmp(zone->routing.c_str(), "Dijkstra") == 0) {
487     new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, false);
488   } else if (strcasecmp(zone->routing.c_str(), "DijkstraCache") == 0) {
489     new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, true);
490   } else if (strcasecmp(zone->routing.c_str(), "Floyd") == 0) {
491     new_zone = new simgrid::kernel::routing::FloydZone(zone->id);
492   } else if (strcasecmp(zone->routing.c_str(), "Full") == 0) {
493     new_zone = new simgrid::kernel::routing::FullZone(zone->id);
494   } else if (strcasecmp(zone->routing.c_str(), "None") == 0) {
495     new_zone = new simgrid::kernel::routing::EmptyZone(zone->id);
496   } else if (strcasecmp(zone->routing.c_str(), "Vivaldi") == 0) {
497     new_zone = new simgrid::kernel::routing::VivaldiZone(zone->id);
498   } else if (strcasecmp(zone->routing.c_str(), "Wifi") == 0) {
499     new_zone = new simgrid::kernel::routing::WifiZone(zone->id);
500   } else {
501     xbt_die("Not a valid model!");
502   }
503   new_zone->set_parent(current_routing);
504
505   return new_zone;
506 }
507
508 /**
509  * @brief Add a Zone to the platform
510  *
511  * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
512  * and before the corresponding call to sg_platf_new_Zone_seal() will be added to this Zone.
513  *
514  * Once this function was called, the configuration concerning the used models cannot be changed anymore.
515  *
516  * @param zone the parameters defining the Zone to build.
517  */
518 simgrid::kernel::routing::NetZoneImpl* sg_platf_new_Zone_begin(const simgrid::kernel::routing::ZoneCreationArgs* zone)
519 {
520   current_routing = sg_platf_create_zone(zone);
521
522   return current_routing;
523 }
524
525 void sg_platf_new_Zone_set_properties(const std::unordered_map<std::string, std::string>& props)
526 {
527   xbt_assert(current_routing, "Cannot set properties of the current Zone: none under construction");
528
529   current_routing->set_properties(props);
530 }
531
532 /**
533  * @brief Specify that the description of the current Zone is finished
534  *
535  * Once you've declared all the content of your Zone, you have to seal
536  * it with this call. Your Zone is not usable until you call this function.
537  */
538 void sg_platf_new_Zone_seal()
539 {
540   xbt_assert(current_routing, "Cannot seal the current Zone: none under construction");
541   current_routing->seal();
542   current_routing = current_routing->get_parent();
543 }
544
545 /** @brief Add a link connecting a host to the rest of its Zone (which must be cluster or vivaldi) */
546 void sg_platf_new_hostlink(const simgrid::kernel::routing::HostLinkCreationArgs* hostlink)
547 {
548   const simgrid::kernel::routing::NetPoint* netpoint = simgrid::s4u::Host::by_name(hostlink->id)->get_netpoint();
549   xbt_assert(netpoint, "Host '%s' not found!", hostlink->id.c_str());
550   xbt_assert(dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing),
551              "Only hosts from Cluster and Vivaldi Zones can get a host_link.");
552
553   const simgrid::s4u::Link* linkUp   = simgrid::s4u::Link::by_name_or_null(hostlink->link_up);
554   const simgrid::s4u::Link* linkDown = simgrid::s4u::Link::by_name_or_null(hostlink->link_down);
555
556   xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up.c_str());
557   xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down.c_str());
558
559   auto* cluster_zone = static_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
560
561   if (cluster_zone->private_link_exists_at(netpoint->id()))
562     surf_parse_error(std::string("Host_link for '") + hostlink->id.c_str() + "' is already defined!");
563
564   XBT_DEBUG("Push Host_link for host '%s' to position %u", netpoint->get_cname(), netpoint->id());
565   cluster_zone->add_private_link_at(netpoint->id(), {linkUp->get_impl(), linkDown->get_impl()});
566 }
567
568 void sg_platf_new_trace(simgrid::kernel::routing::ProfileCreationArgs* args)
569 {
570   simgrid::kernel::profile::Profile* profile;
571   if (not args->file.empty()) {
572     profile = simgrid::kernel::profile::Profile::from_file(args->file);
573   } else {
574     xbt_assert(not args->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
575                args->id.c_str());
576     profile = simgrid::kernel::profile::Profile::from_string(args->id, args->pc_data, args->periodicity);
577   }
578   traces_set_list.insert({args->id, profile});
579 }