Logo AND Algorithmique Numérique Distribuée

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