Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further progress towards deprecation of complex add_route
[simgrid.git] / src / kernel / xml / sg_platf.cpp
1 /* Copyright (c) 2006-2023. 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 /* This file implements the public API to platform parsing                  */
7
8 #include <simgrid/Exception.hpp>
9 #include <simgrid/kernel/routing/DijkstraZone.hpp>
10 #include <simgrid/kernel/routing/DragonflyZone.hpp>
11 #include <simgrid/kernel/routing/EmptyZone.hpp>
12 #include <simgrid/kernel/routing/FatTreeZone.hpp>
13 #include <simgrid/kernel/routing/FloydZone.hpp>
14 #include <simgrid/kernel/routing/FullZone.hpp>
15 #include <simgrid/kernel/routing/NetPoint.hpp>
16 #include <simgrid/kernel/routing/NetZoneImpl.hpp>
17 #include <simgrid/kernel/routing/TorusZone.hpp>
18 #include <simgrid/kernel/routing/VivaldiZone.hpp>
19 #include <simgrid/kernel/routing/WifiZone.hpp>
20 #include <simgrid/s4u/Engine.hpp>
21 #include <simgrid/s4u/NetZone.hpp>
22
23 #include "src/kernel/EngineImpl.hpp"
24 #include "src/kernel/resource/DiskImpl.hpp"
25 #include "src/kernel/resource/HostImpl.hpp"
26 #include "src/kernel/resource/StandardLinkImpl.hpp"
27 #include "src/kernel/resource/profile/Profile.hpp"
28 #include "src/kernel/xml/platf.hpp"
29 #include "src/kernel/xml/platf_private.hpp"
30 #include "src/simgrid/sg_config.hpp"
31
32 #include <algorithm>
33 #include <string>
34
35 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(platf_parse);
36
37 /* This function acts as a main in the parsing area. */
38 void parse_platform_file(const std::string& file)
39 {
40   /* init the flex parser */
41   simgrid_parse_open(file);
42
43   /* Do the actual parsing */
44   simgrid_parse(true);
45
46   simgrid_parse_close();
47 }
48
49 namespace simgrid::kernel::routing {
50 xbt::signal<void(ClusterCreationArgs const&)> on_cluster_creation;
51 } // namespace simgrid::kernel::routing
52
53 static simgrid::kernel::routing::ClusterZoneCreationArgs
54     zone_cluster; /* temporary store data for irregular clusters, created with <zone routing="Cluster"> */
55
56 /** The current NetZone in the parsing */
57 static simgrid::kernel::routing::NetZoneImpl* current_routing = nullptr;
58 static simgrid::s4u::Host* current_host                       = nullptr;
59
60 /** Module management function: frees all internal data structures */
61 void sg_platf_parser_finalize()
62 {
63   simgrid::kernel::routing::on_cluster_creation.disconnect_slots();
64
65   simgrid_parse_lex_destroy();
66 }
67
68 /** @brief Add a host to the current NetZone */
69 void sg_platf_new_host_begin(const simgrid::kernel::routing::HostCreationArgs* args)
70 {
71   current_host = current_routing->create_host(args->id, args->speed_per_pstate)
72                      ->set_coordinates(args->coord)
73                      ->set_core_count(args->core_amount)
74                      ->set_state_profile(args->state_trace)
75                      ->set_speed_profile(args->speed_trace);
76 }
77
78 void sg_platf_new_host_set_properties(const std::unordered_map<std::string, std::string>& props)
79 {
80   xbt_assert(current_host, "Cannot set properties of the current host: none under construction");
81   current_host->set_properties(props);
82 }
83
84 void sg_platf_new_host_seal(int pstate)
85 {
86   xbt_assert(current_host, "Cannot seal the current Host: none under construction");
87   current_host->seal();
88
89   /* When energy plugin is activated, changing the pstate requires to already have the HostEnergy extension whose
90    * allocation is triggered by the on_creation signal. Then set_pstate must be called after the signal emission */
91
92   if (pstate != 0)
93     current_host->set_pstate(pstate);
94
95   current_host = nullptr;
96 }
97
98 void sg_platf_new_peer(const simgrid::kernel::routing::PeerCreationArgs* args)
99 {
100   auto* zone = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
101   xbt_assert(zone, "<peer> tag can only be used in Vivaldi netzones.");
102
103   const auto* peer = zone->create_host(args->id, {args->speed})
104                          ->set_state_profile(args->state_trace)
105                          ->set_speed_profile(args->speed_trace)
106                          ->set_coordinates(args->coord)
107                          ->seal();
108
109   zone->set_peer_link(peer->get_netpoint(), args->bw_in, args->bw_out);
110 }
111
112 /** @brief Add a "router" to the network element list */
113 simgrid::kernel::routing::NetPoint* sg_platf_new_router(const std::string& name, const std::string& coords)
114 {
115   auto* netpoint = current_routing->create_router(name)->set_coordinates(coords);
116   XBT_DEBUG("Router '%s' has the id %lu", netpoint->get_cname(), netpoint->id());
117
118   return netpoint;
119 }
120
121 void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* args)
122 {
123   simgrid::s4u::Link* link;
124   if (args->policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
125     link = current_routing->create_split_duplex_link(args->id, args->bandwidths);
126   } else {
127     link = current_routing->create_link(args->id, args->bandwidths);
128     link->get_impl()->set_sharing_policy(args->policy, {});
129   }
130
131   link->set_properties(args->properties)
132       ->set_state_profile(args->state_trace)
133       ->set_latency_profile(args->latency_trace)
134       ->set_bandwidth_profile(args->bandwidth_trace)
135       ->set_latency(args->latency);
136
137   link->seal();
138 }
139
140 void sg_platf_new_disk(const simgrid::kernel::routing::DiskCreationArgs* disk)
141 {
142   const simgrid::s4u::Disk* new_disk = current_routing->create_disk(disk->id, disk->read_bw, disk->write_bw)
143                                            ->set_host(current_host)
144                                            ->set_properties(disk->properties)
145                                            ->seal();
146
147   current_host->add_disk(new_disk);
148 }
149
150 /*************************************************************************************************/
151 /** @brief Auxiliary function to create hosts */
152 static std::pair<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*>
153 sg_platf_cluster_create_host(const simgrid::kernel::routing::ClusterCreationArgs* cluster, simgrid::s4u::NetZone* zone,
154                              const std::vector<unsigned long>& /*coord*/, unsigned long id)
155 {
156   xbt_assert(static_cast<unsigned long>(id) < cluster->radicals.size(),
157              "Zone(%s): error when creating host number %lu in the zone. Insufficient number of radicals available "
158              "(total = %zu). Check the 'radical' parameter in XML",
159              cluster->id.c_str(), id, cluster->radicals.size());
160
161   std::string host_id = cluster->prefix + std::to_string(cluster->radicals[id]) + cluster->suffix;
162   XBT_DEBUG("Cluster: creating host=%s speed=%f", host_id.c_str(), cluster->speeds.front());
163   const simgrid::s4u::Host* host = zone->create_host(host_id, cluster->speeds)
164                                        ->set_core_count(cluster->core_amount)
165                                        ->set_properties(cluster->properties)
166                                        ->seal();
167   return std::make_pair(host->get_netpoint(), nullptr);
168 }
169
170 /** @brief Auxiliary function to create loopback links */
171 static simgrid::s4u::Link*
172 sg_platf_cluster_create_loopback(const simgrid::kernel::routing::ClusterCreationArgs* cluster,
173                                  simgrid::s4u::NetZone* zone, const std::vector<unsigned long>& /*coord*/,
174                                  unsigned long id)
175 {
176   xbt_assert(static_cast<unsigned long>(id) < cluster->radicals.size(),
177              "Zone(%s): error when creating loopback for host number %lu in the zone. Insufficient number of "
178              "radicals available "
179              "(total = %zu). Check the 'radical' parameter in XML",
180              cluster->id.c_str(), id, cluster->radicals.size());
181
182   std::string link_id = cluster->id + "_link_" + std::to_string(cluster->radicals[id]) + "_loopback";
183   XBT_DEBUG("Cluster: creating loopback link=%s bw=%f", link_id.c_str(), cluster->loopback_bw);
184
185   simgrid::s4u::Link* loopback = zone->create_link(link_id, cluster->loopback_bw)
186                                      ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
187                                      ->set_latency(cluster->loopback_lat)
188                                      ->seal();
189   return loopback;
190 }
191
192 /** @brief Auxiliary function to create limiter links */
193 static simgrid::s4u::Link* sg_platf_cluster_create_limiter(const simgrid::kernel::routing::ClusterCreationArgs* cluster,
194                                                            simgrid::s4u::NetZone* zone,
195                                                            const std::vector<unsigned long>& /*coord*/,
196                                                            unsigned long id)
197 {
198   std::string link_id = cluster->id + "_link_" + std::to_string(id) + "_limiter";
199   XBT_DEBUG("Cluster: creating limiter link=%s bw=%f", link_id.c_str(), cluster->limiter_link);
200
201   simgrid::s4u::Link* limiter = zone->create_link(link_id, cluster->limiter_link)->seal();
202   return limiter;
203 }
204
205 /** @brief Create Torus, Fat-Tree and Dragonfly clusters */
206 static void sg_platf_new_cluster_hierarchical(const simgrid::kernel::routing::ClusterCreationArgs* cluster)
207 {
208   using namespace std::placeholders;
209   using simgrid::kernel::routing::DragonflyZone;
210   using simgrid::kernel::routing::FatTreeZone;
211   using simgrid::kernel::routing::TorusZone;
212
213   auto set_host = std::bind(sg_platf_cluster_create_host, cluster, _1, _2, _3);
214   std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb> set_loopback{};
215   std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb> set_limiter{};
216
217   if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
218     set_loopback = std::bind(sg_platf_cluster_create_loopback, cluster, _1, _2, _3);
219   }
220
221   if (cluster->limiter_link > 0) {
222     set_limiter = std::bind(sg_platf_cluster_create_limiter, cluster, _1, _2, _3);
223   }
224
225   simgrid::s4u::NetZone const* parent = current_routing ? current_routing->get_iface() : nullptr;
226   switch (cluster->topology) {
227     case simgrid::kernel::routing::ClusterTopology::TORUS:
228       simgrid::s4u::create_torus_zone(cluster->id, parent, TorusZone::parse_topo_parameters(cluster->topo_parameters),
229                                       {set_host, set_loopback, set_limiter}, cluster->bw, cluster->lat,
230                                       cluster->sharing_policy);
231       break;
232     case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
233       simgrid::s4u::create_dragonfly_zone(
234           cluster->id, parent, DragonflyZone::parse_topo_parameters(cluster->topo_parameters),
235           {set_host, set_loopback, set_limiter}, cluster->bw, cluster->lat, cluster->sharing_policy);
236       break;
237     case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
238       simgrid::s4u::create_fatTree_zone(
239           cluster->id, parent, FatTreeZone::parse_topo_parameters(cluster->topo_parameters),
240           {set_host, set_loopback, set_limiter}, cluster->bw, cluster->lat, cluster->sharing_policy);
241       break;
242     default:
243       THROW_IMPOSSIBLE;
244   }
245 }
246
247 /*************************************************************************************************/
248 /** @brief Create regular Cluster */
249 static void sg_platf_new_cluster_flat(simgrid::kernel::routing::ClusterCreationArgs* cluster)
250 {
251   auto* zone = simgrid::s4u::create_star_zone(cluster->id);
252   if (const auto* parent = current_routing ? current_routing->get_iface() : nullptr)
253     zone->set_parent(parent);
254
255   /* set properties */
256   for (auto const& [key, value] : cluster->properties)
257     zone->set_property(key, value);
258
259   /* Make the backbone */
260   const simgrid::s4u::Link* backbone = nullptr;
261   if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
262     std::string bb_name = cluster->id + "_backbone";
263     XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/> <!--backbone -->", bb_name.c_str(), cluster->bb_bw,
264               cluster->bb_lat);
265
266     backbone = zone->create_link(bb_name, cluster->bb_bw)
267                    ->set_sharing_policy(cluster->bb_sharing_policy)
268                    ->set_latency(cluster->bb_lat)
269                    ->seal();
270   }
271
272   for (int const& i : cluster->radicals) {
273     std::string host_id = cluster->prefix + std::to_string(i) + cluster->suffix;
274
275     XBT_DEBUG("<host\tid=\"%s\"\tspeed=\"%f\">", host_id.c_str(), cluster->speeds.front());
276     const auto* host = zone->create_host(host_id, cluster->speeds)
277                            ->set_core_count(cluster->core_amount)
278                            ->set_properties(cluster->properties)
279                            ->seal();
280
281     XBT_DEBUG("</host>");
282
283     std::string link_id = cluster->id + "_link_" + std::to_string(i);
284     XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
285
286     // add a loopback link
287     if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
288       std::string loopback_name = link_id + "_loopback";
289       XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", loopback_name.c_str(), cluster->loopback_bw);
290
291       const auto* loopback = zone->create_link(loopback_name, cluster->loopback_bw)
292                                  ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
293                                  ->set_latency(cluster->loopback_lat)
294                                  ->seal();
295
296       zone->add_route(host, host, {simgrid::s4u::LinkInRoute(loopback)});
297     }
298
299     // add a limiter link (shared link to account for maximal bandwidth of the node)
300     const simgrid::s4u::Link* limiter = nullptr;
301     if (cluster->limiter_link > 0) {
302       std::string limiter_name = link_id + "_limiter";
303       XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", limiter_name.c_str(), cluster->limiter_link);
304
305       limiter = zone->create_link(limiter_name, cluster->limiter_link)->seal();
306     }
307
308     // create link
309     const simgrid::s4u::Link* link;
310     if (cluster->sharing_policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
311       link = zone->create_split_duplex_link(link_id, cluster->bw)->set_latency(cluster->lat)->seal();
312     } else {
313       link = zone->create_link(link_id, cluster->bw)->set_latency(cluster->lat)->seal();
314     }
315
316     /* adding routes */
317     std::vector<simgrid::s4u::LinkInRoute> links;
318     if (limiter)
319       links.emplace_back(limiter);
320     links.emplace_back(link, simgrid::s4u::LinkInRoute::Direction::UP);
321     if (backbone)
322       links.emplace_back(backbone);
323
324     zone->add_route(host, nullptr, links, true);
325   }
326
327   // Add a router.
328   XBT_DEBUG(" ");
329   XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
330   if (cluster->router_id.empty())
331     cluster->router_id = cluster->prefix + cluster->id + "_router" + cluster->suffix;
332   zone->create_router(cluster->router_id);
333
334   simgrid::kernel::routing::on_cluster_creation(*cluster);
335 }
336
337 void sg_platf_new_tag_cluster(simgrid::kernel::routing::ClusterCreationArgs* cluster)
338 {
339   switch (cluster->topology) {
340     case simgrid::kernel::routing::ClusterTopology::TORUS:
341     case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
342     case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
343       sg_platf_new_cluster_hierarchical(cluster);
344       break;
345     default:
346       sg_platf_new_cluster_flat(cluster);
347       break;
348   }
349 }
350 /*************************************************************************************************/
351 /** @brief Set the links for internal node inside a Cluster(Star) */
352 static void sg_platf_cluster_set_hostlink(simgrid::kernel::routing::StarZone* zone,
353                                           simgrid::kernel::routing::NetPoint* netpoint,
354                                           const simgrid::s4u::Link* link_up, const simgrid::s4u::Link* link_down,
355                                           const simgrid::s4u::Link* backbone)
356 {
357   XBT_DEBUG("Push Host_link for host '%s' to position %lu", netpoint->get_cname(), netpoint->id());
358   simgrid::s4u::LinkInRoute linkUp{link_up};
359   simgrid::s4u::LinkInRoute linkDown{link_down};
360   if (backbone) {
361     simgrid::s4u::LinkInRoute linkBB{backbone};
362     zone->add_route(netpoint, nullptr, nullptr, nullptr, {linkUp, linkBB}, false);
363     zone->add_route(nullptr, netpoint, nullptr, nullptr, {linkBB, linkDown}, false);
364   } else {
365     zone->add_route(netpoint, nullptr, nullptr, nullptr, {linkUp}, false);
366     zone->add_route(nullptr, netpoint, nullptr, nullptr, {linkDown}, false);
367   }
368 }
369
370 /** @brief Add a link connecting a host to the rest of its StarZone */
371 static void sg_platf_build_hostlink(simgrid::kernel::routing::StarZone* zone,
372                                     const simgrid::kernel::routing::HostLinkCreationArgs* hostlink,
373                                     const simgrid::s4u::Link* backbone)
374 {
375   const auto* engine = simgrid::s4u::Engine::get_instance();
376   auto* netpoint     = engine->host_by_name(hostlink->id)->get_netpoint();
377   xbt_assert(netpoint, "Host '%s' not found!", hostlink->id.c_str());
378
379   const auto* linkUp   = engine->link_by_name_or_null(hostlink->link_up);
380   const auto* linkDown = engine->link_by_name_or_null(hostlink->link_down);
381
382   xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up.c_str());
383   xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down.c_str());
384   sg_platf_cluster_set_hostlink(zone, netpoint, linkUp, linkDown, backbone);
385 }
386
387 /** @brief Create a cabinet (set of hosts) inside a Cluster(StarZone) */
388 static void sg_platf_build_cabinet(simgrid::kernel::routing::StarZone* zone,
389                                    const simgrid::kernel::routing::CabinetCreationArgs* args,
390                                    const simgrid::s4u::Link* backbone)
391 {
392   for (int const& radical : args->radicals) {
393     std::string id   = args->prefix + std::to_string(radical) + args->suffix;
394     auto const* host = zone->create_host(id, {args->speed})->seal();
395
396     const auto* link_up   = zone->create_link("link_" + id + "_UP", {args->bw})->set_latency(args->lat)->seal();
397     const auto* link_down = zone->create_link("link_" + id + "_DOWN", {args->bw})->set_latency(args->lat)->seal();
398
399     sg_platf_cluster_set_hostlink(zone, host->get_netpoint(), link_up, link_down, backbone);
400   }
401 }
402
403 static void sg_platf_zone_cluster_populate(const simgrid::kernel::routing::ClusterZoneCreationArgs* cluster)
404 {
405   auto* zone = dynamic_cast<simgrid::kernel::routing::StarZone*>(current_routing);
406   xbt_assert(zone, "Host_links are only valid for Cluster(Star)");
407
408   const simgrid::s4u::Link* backbone = nullptr;
409   /* create backbone */
410   if (cluster->backbone) {
411     sg_platf_new_link(cluster->backbone.get());
412     backbone = simgrid::s4u::Link::by_name(cluster->backbone->id);
413   }
414
415   /* create host_links for hosts */
416   for (auto const& hostlink : cluster->host_links) {
417     sg_platf_build_hostlink(zone, &hostlink, backbone);
418   }
419
420   /* create cabinets */
421   for (auto const& cabinet : cluster->cabinets) {
422     sg_platf_build_cabinet(zone, &cabinet, backbone);
423   }
424 }
425
426 void routing_cluster_add_backbone(std::unique_ptr<simgrid::kernel::routing::LinkCreationArgs> link)
427 {
428   zone_cluster.backbone = std::move(link);
429 }
430
431 void sg_platf_new_cabinet(const simgrid::kernel::routing::CabinetCreationArgs* args)
432 {
433   xbt_assert(args, "Invalid nullptr argument");
434   zone_cluster.cabinets.emplace_back(*args);
435 }
436
437 /*************************************************************************************************/
438 void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route)
439 {
440   current_routing->add_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list,
441                              route->symmetrical);
442 }
443
444 void sg_platf_new_bypass_route(simgrid::kernel::routing::RouteCreationArgs* route)
445 {
446   current_routing->add_bypass_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list);
447 }
448
449 void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor)
450 {
451   const auto* engine = simgrid::s4u::Engine::get_instance();
452   sg_host_t host     = sg_host_by_name(actor->host);
453   if (not host) {
454     // The requested host does not exist. Do a nice message to the user
455     std::string msg = std::string("Cannot create actor '") + actor->function + "': host '" + actor->host +
456                       "' does not exist\nExisting hosts: '";
457
458     std::vector<simgrid::s4u::Host*> list = engine->get_all_hosts();
459
460     for (auto const& some_host : list) {
461       msg += some_host->get_name();
462       msg += "', '";
463       if (msg.length() > 1024) {
464         msg.pop_back(); // remove trailing quote
465         msg += "...(list truncated)......";
466         break;
467       }
468     }
469     xbt_die("%s", msg.c_str());
470   }
471   const simgrid::kernel::actor::ActorCodeFactory& factory = engine->get_impl()->get_function(actor->function);
472   xbt_assert(factory, "Error while creating an actor from the XML file: Function '%s' not registered", actor->function);
473
474   double start_time = actor->start_time;
475   double kill_time  = actor->kill_time;
476   bool auto_restart = actor->restart_on_failure;
477
478   std::string actor_name                 = actor->args[0];
479   simgrid::kernel::actor::ActorCode code = factory(std::move(actor->args));
480
481   auto* arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
482                                                      auto_restart, /*daemon=*/false, /*restart_count=*/0);
483
484   host->get_impl()->add_actor_at_boot(arg);
485
486   if (start_time > simgrid::s4u::Engine::get_clock()) {
487     arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
488                                                  auto_restart, /*daemon=*/false, /*restart_count=*/0);
489
490     XBT_DEBUG("Actor %s@%s will be started at time %f", arg->name.c_str(), arg->host->get_cname(), start_time);
491     simgrid::kernel::timer::Timer::set(start_time, [arg]() {
492       simgrid::kernel::actor::ActorImplPtr new_actor = simgrid::kernel::actor::ActorImpl::create(arg);
493       delete arg;
494     });
495   } else { // start_time <= simgrid::s4u::Engine::get_clock()
496     XBT_DEBUG("Starting actor %s(%s) right now", arg->name.c_str(), host->get_cname());
497
498     try {
499       simgrid::kernel::actor::ActorImplPtr new_actor = simgrid::kernel::actor::ActorImpl::create(arg);
500     } catch (simgrid::HostFailureException const&) {
501       XBT_WARN("Starting actor %s(%s) failed because its host is turned off.", arg->name.c_str(), host->get_cname());
502     }
503   }
504 }
505
506 /**
507  * @brief Auxiliary function to build the object NetZoneImpl
508  *
509  * Builds the objects, setting its parent properties and root netzone if needed
510  * @param zone the parameters defining the Zone to build.
511  * @return Pointer to recently created netzone
512  */
513 static simgrid::kernel::routing::NetZoneImpl*
514 sg_platf_create_zone(const simgrid::kernel::routing::ZoneCreationArgs* zone)
515 {
516   /* search the routing model */
517   const simgrid::s4u::NetZone* new_zone = nullptr;
518
519   if (strcasecmp(zone->routing.c_str(), "Cluster") == 0) {
520     new_zone = simgrid::s4u::create_star_zone(zone->id);
521   } else if (strcasecmp(zone->routing.c_str(), "Dijkstra") == 0) {
522     new_zone = simgrid::s4u::create_dijkstra_zone(zone->id, false);
523   } else if (strcasecmp(zone->routing.c_str(), "DijkstraCache") == 0) {
524     new_zone = simgrid::s4u::create_dijkstra_zone(zone->id, true);
525   } else if (strcasecmp(zone->routing.c_str(), "Floyd") == 0) {
526     new_zone = simgrid::s4u::create_floyd_zone(zone->id);
527   } else if (strcasecmp(zone->routing.c_str(), "Full") == 0) {
528     new_zone = simgrid::s4u::create_full_zone(zone->id);
529   } else if (strcasecmp(zone->routing.c_str(), "None") == 0) {
530     new_zone = simgrid::s4u::create_empty_zone(zone->id);
531   } else if (strcasecmp(zone->routing.c_str(), "Vivaldi") == 0) {
532     new_zone = simgrid::s4u::create_vivaldi_zone(zone->id);
533   } else if (strcasecmp(zone->routing.c_str(), "Wifi") == 0) {
534     new_zone = simgrid::s4u::create_wifi_zone(zone->id);
535   } else {
536     xbt_die("Not a valid model!");
537   }
538
539   simgrid::kernel::routing::NetZoneImpl* new_zone_impl = new_zone->get_impl();
540   new_zone_impl->set_parent(current_routing);
541
542   return new_zone_impl;
543 }
544
545 /**
546  * @brief Add a Zone to the platform
547  *
548  * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
549  * and before the corresponding call to sg_platf_new_zone_seal() will be added to this Zone.
550  *
551  * Once this function was called, the configuration concerning the used models cannot be changed anymore.
552  *
553  * @param zone the parameters defining the Zone to build.
554  */
555 simgrid::kernel::routing::NetZoneImpl* sg_platf_new_zone_begin(const simgrid::kernel::routing::ZoneCreationArgs* zone)
556 {
557   zone_cluster.routing = zone->routing;
558   current_routing      = sg_platf_create_zone(zone);
559
560   return current_routing;
561 }
562
563 void sg_platf_new_zone_set_properties(const std::unordered_map<std::string, std::string>& props)
564 {
565   xbt_assert(current_routing, "Cannot set properties of the current Zone: none under construction");
566
567   current_routing->set_properties(props);
568 }
569
570 /**
571  * @brief Specify that the description of the current Zone is finished
572  *
573  * Once you've declared all the content of your Zone, you have to seal
574  * it with this call. Your Zone is not usable until you call this function.
575  */
576 void sg_platf_new_zone_seal()
577 {
578   xbt_assert(current_routing, "Cannot seal the current Zone: none under construction");
579   if (strcasecmp(zone_cluster.routing.c_str(), "Cluster") == 0) {
580     sg_platf_zone_cluster_populate(&zone_cluster);
581     zone_cluster.routing = "";
582     zone_cluster.host_links.clear();
583     zone_cluster.cabinets.clear();
584     zone_cluster.backbone.reset();
585   }
586   current_routing = current_routing->get_parent();
587 }
588
589 /** @brief Add a link connecting a host to the rest of its Zone (which must be cluster or vivaldi) */
590 void sg_platf_new_hostlink(const simgrid::kernel::routing::HostLinkCreationArgs* hostlink)
591 {
592   xbt_assert(hostlink, "Invalid nullptr parameter");
593   zone_cluster.host_links.emplace_back(*hostlink);
594 }
595
596 void sg_platf_new_trace(const simgrid::kernel::routing::ProfileCreationArgs* args)
597 {
598   simgrid::kernel::profile::Profile* profile;
599   if (not args->file.empty()) {
600     profile = simgrid::kernel::profile::ProfileBuilder::from_file(args->file);
601   } else {
602     xbt_assert(not args->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
603                args->id.c_str());
604     profile = simgrid::kernel::profile::ProfileBuilder::from_string(args->id, args->pc_data, args->periodicity);
605   }
606   traces_set_list.try_emplace(args->id, profile);
607 }