Logo AND Algorithmique Numérique Distribuée

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