1 /* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
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. */
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"
31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_parse);
36 xbt::signal<void(ClusterCreationArgs const&)> on_cluster_creation;
37 } // namespace routing
39 } // namespace simgrid
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()
45 return current_routing;
47 static simgrid::s4u::Host* current_host = nullptr;
49 /** Module management function: creates all internal data structures */
52 // Do nothing: just for symmetry of user code
55 /** Module management function: frees all internal data structures */
58 simgrid::kernel::routing::on_cluster_creation.disconnect_slots();
59 simgrid::s4u::Engine::on_platform_created.disconnect_slots();
61 surf_parse_lex_destroy();
64 /** @brief Add a host to the current NetZone */
65 void sg_platf_new_host_begin(const simgrid::kernel::routing::HostCreationArgs* args)
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);
75 void sg_platf_new_host_set_properties(const std::unordered_map<std::string, std::string>& props)
77 xbt_assert(current_host, "Cannot set properties of the current host: none under construction");
78 current_host->set_properties(props);
81 void sg_platf_new_host_seal(int pstate)
83 xbt_assert(current_host, "Cannot seal the current Host: none under construction");
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 */
90 current_host->set_pstate(pstate);
92 current_host = nullptr;
95 void sg_platf_new_peer(const simgrid::kernel::routing::PeerCreationArgs* args)
97 auto* zone = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
98 xbt_assert(zone, "<peer> tag can only be used in Vivaldi netzones.");
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)
106 zone->set_peer_link(peer->get_netpoint(), args->bw_in, args->bw_out);
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)
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());
118 static void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* args, const std::string& link_name)
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)
132 void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* link)
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");
138 sg_platf_new_link(link, link->id);
142 void sg_platf_new_disk(const simgrid::kernel::routing::DiskCreationArgs* disk)
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)
150 current_host->add_disk(new_disk);
153 /*************************************************************************************************/
154 /** @brief Auxiliary function to create hosts */
155 static std::pair<simgrid::kernel::routing::NetPoint*, simgrid::kernel::routing::NetPoint*>
156 sg_platf_cluster_create_host(const simgrid::kernel::routing::ClusterCreationArgs* cluster, simgrid::s4u::NetZone* zone,
157 const std::vector<unsigned int>& /*coord*/, int id)
159 xbt_assert(static_cast<unsigned long>(id) < cluster->radicals.size(),
160 "Zone(%s): error when creating host number %d in the zone. Insufficient number of radicals available "
161 "(total = %zu). Check the 'radical' parameter in XML",
162 cluster->id.c_str(), id, cluster->radicals.size());
164 std::string host_id = std::string(cluster->prefix) + std::to_string(cluster->radicals[id]) + cluster->suffix;
165 XBT_DEBUG("Cluster: creating host=%s speed=%f", host_id.c_str(), cluster->speeds.front());
166 const simgrid::s4u::Host* host = zone->create_host(host_id, cluster->speeds)
167 ->set_core_count(cluster->core_amount)
168 ->set_properties(cluster->properties)
170 return std::make_pair(host->get_netpoint(), nullptr);
173 /** @brief Auxiliary function to create loopback links */
174 static simgrid::s4u::Link*
175 sg_platf_cluster_create_loopback(const simgrid::kernel::routing::ClusterCreationArgs* cluster,
176 simgrid::s4u::NetZone* zone, const std::vector<unsigned int>& /*coord*/, int id)
178 xbt_assert(static_cast<unsigned long>(id) < cluster->radicals.size(),
179 "Zone(%s): error when creating loopback for host number %d in the zone. Insufficient number of radicals "
181 "(total = %zu). Check the 'radical' parameter in XML",
182 cluster->id.c_str(), id, cluster->radicals.size());
184 std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(cluster->radicals[id]) + "_loopback";
185 XBT_DEBUG("Cluster: creating loopback link=%s bw=%f", link_id.c_str(), cluster->loopback_bw);
187 simgrid::s4u::Link* loopback = zone->create_link(link_id, cluster->loopback_bw)
188 ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
189 ->set_latency(cluster->loopback_lat)
194 /** @brief Auxiliary function to create limiter links */
195 static simgrid::s4u::Link* sg_platf_cluster_create_limiter(const simgrid::kernel::routing::ClusterCreationArgs* cluster,
196 simgrid::s4u::NetZone* zone,
197 const std::vector<unsigned int>& /*coord*/, int id)
199 std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(id) + "_limiter";
200 XBT_DEBUG("Cluster: creating limiter link=%s bw=%f", link_id.c_str(), cluster->limiter_link);
202 simgrid::s4u::Link* limiter = zone->create_link(link_id, cluster->limiter_link)->seal();
206 /** @brief Create Torus, Fat-Tree and Dragonfly clusters */
207 static void sg_platf_new_cluster_hierarchical(const simgrid::kernel::routing::ClusterCreationArgs* cluster)
209 using namespace std::placeholders;
210 using simgrid::kernel::routing::DragonflyZone;
211 using simgrid::kernel::routing::FatTreeZone;
212 using simgrid::kernel::routing::TorusZone;
214 auto set_host = std::bind(sg_platf_cluster_create_host, cluster, _1, _2, _3);
215 std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb> set_loopback{};
216 std::function<simgrid::s4u::ClusterCallbacks::ClusterLinkCb> set_limiter{};
218 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
219 set_loopback = std::bind(sg_platf_cluster_create_loopback, cluster, _1, _2, _3);
222 if (cluster->limiter_link > 0) {
223 set_limiter = std::bind(sg_platf_cluster_create_limiter, cluster, _1, _2, _3);
226 simgrid::s4u::NetZone const* parent = routing_get_current() ? routing_get_current()->get_iface() : nullptr;
227 simgrid::s4u::NetZone* zone;
228 switch (cluster->topology) {
229 case simgrid::kernel::routing::ClusterTopology::TORUS:
230 zone = simgrid::s4u::create_torus_zone(
231 cluster->id, parent, TorusZone::parse_topo_parameters(cluster->topo_parameters),
232 {set_host, set_loopback, set_limiter}, cluster->bw, cluster->lat, cluster->sharing_policy);
234 case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
235 zone = simgrid::s4u::create_dragonfly_zone(
236 cluster->id, parent, DragonflyZone::parse_topo_parameters(cluster->topo_parameters),
237 {set_host, set_loopback, set_limiter}, cluster->bw, cluster->lat, cluster->sharing_policy);
239 case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
240 zone = simgrid::s4u::create_fatTree_zone(
241 cluster->id, parent, FatTreeZone::parse_topo_parameters(cluster->topo_parameters),
242 {set_host, set_loopback, set_limiter}, cluster->bw, cluster->lat, cluster->sharing_policy);
250 /*************************************************************************************************/
251 /** @brief Create regular Cluster */
252 static void sg_platf_new_cluster_flat2(simgrid::kernel::routing::ClusterCreationArgs* cluster)
254 auto* zone = simgrid::s4u::create_star_zone(cluster->id);
255 simgrid::s4u::NetZone const* parent = routing_get_current() ? routing_get_current()->get_iface() : nullptr;
257 zone->set_parent(parent);
260 for (auto const& elm : cluster->properties)
261 zone->set_property(elm.first, elm.second);
263 /* Make the backbone */
264 simgrid::s4u::Link* backbone = nullptr;
265 if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
266 std::string bb_name = std::string(cluster->id) + "_backbone";
267 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/> <!--backbone -->", bb_name.c_str(), cluster->bb_bw,
270 backbone = zone->create_link(bb_name, std::vector<double>{cluster->bb_bw})
271 ->set_sharing_policy(cluster->bb_sharing_policy)
272 ->set_latency(cluster->bb_lat)
276 for (int const& i : cluster->radicals) {
277 std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
279 XBT_DEBUG("<host\tid=\"%s\"\tspeed=\"%f\">", host_id.c_str(), cluster->speeds.front());
280 const auto* host = zone->create_host(host_id, cluster->speeds)
281 ->set_core_count(cluster->core_amount)
282 ->set_properties(cluster->properties)
285 XBT_DEBUG("</host>");
287 std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
288 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
290 // add a loopback link
291 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
292 std::string loopback_name = link_id + "_loopback";
293 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", loopback_name.c_str(), cluster->loopback_bw);
295 auto* loopback = zone->create_link(loopback_name, std::vector<double>{cluster->loopback_bw})
296 ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
297 ->set_latency(cluster->loopback_lat)
300 zone->add_route(host->get_netpoint(), host->get_netpoint(), nullptr, nullptr,
301 std::vector<simgrid::s4u::Link*>{loopback});
304 // add a limiter link (shared link to account for maximal bandwidth of the node)
305 simgrid::s4u::Link* limiter = nullptr;
306 if (cluster->limiter_link > 0) {
307 std::string limiter_name = std::string(link_id) + "_limiter";
308 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", limiter_name.c_str(), cluster->limiter_link);
310 limiter = zone->create_link(limiter_name, std::vector<double>{cluster->limiter_link})->seal();
314 simgrid::s4u::Link* link_up;
315 simgrid::s4u::Link* link_down;
316 if (cluster->sharing_policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
317 link_up = zone->create_link(link_id + "_UP", std::vector<double>{cluster->bw})->set_latency(cluster->lat)->seal();
319 zone->create_link(link_id + "_DOWN", std::vector<double>{cluster->bw})->set_latency(cluster->lat)->seal();
321 link_up = zone->create_link(link_id, std::vector<double>{cluster->bw})->set_latency(cluster->lat)->seal();
326 std::vector<simgrid::s4u::Link*> links_up{limiter, link_up, backbone};
327 links_up.erase(std::remove(links_up.begin(), links_up.end(), nullptr), links_up.end());
328 std::vector<simgrid::s4u::Link*> links_down{backbone, link_down, limiter};
329 links_down.erase(std::remove(links_down.begin(), links_down.end(), nullptr), links_down.end());
331 zone->add_route(host->get_netpoint(), nullptr, nullptr, nullptr, links_up, false);
332 zone->add_route(nullptr, host->get_netpoint(), nullptr, nullptr, links_down, false);
337 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
338 if (cluster->router_id.empty())
339 cluster->router_id = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
340 auto* router = zone->create_router(cluster->router_id);
341 zone->add_route(router, nullptr, nullptr, nullptr, {});
343 simgrid::kernel::routing::on_cluster_creation(*cluster);
346 /*************************************************************************************************/
347 /** @brief Set the links for internal node inside a Cluster(Star) */
348 static void sg_platf_cluster_set_hostlink(simgrid::kernel::routing::StarZone* zone,
349 simgrid::kernel::routing::NetPoint* netpoint, simgrid::s4u::Link* link_up,
350 simgrid::s4u::Link* link_down, simgrid::kernel::resource::LinkImpl* backbone)
352 XBT_DEBUG("Push Host_link for host '%s' to position %u", netpoint->get_cname(), netpoint->id());
354 zone->add_route(netpoint, nullptr, nullptr, nullptr, {link_up->get_impl(), backbone}, false);
355 zone->add_route(nullptr, netpoint, nullptr, nullptr, {backbone, link_down->get_impl()}, false);
357 zone->add_route(netpoint, nullptr, nullptr, nullptr, {link_up->get_impl()}, false);
358 zone->add_route(nullptr, netpoint, nullptr, nullptr, {link_down->get_impl()}, false);
362 /** @brief Add a link connecting a host to the rest of its StarZone */
363 static void sg_platf_new_hostlink(simgrid::kernel::routing::StarZone* zone,
364 const simgrid::kernel::routing::HostLinkCreationArgs* hostlink,
365 simgrid::kernel::resource::LinkImpl* backbone)
367 simgrid::kernel::routing::NetPoint* netpoint = simgrid::s4u::Host::by_name(hostlink->id)->get_netpoint();
368 xbt_assert(netpoint, "Host '%s' not found!", hostlink->id.c_str());
370 simgrid::s4u::Link* linkUp = simgrid::s4u::Link::by_name_or_null(hostlink->link_up);
371 simgrid::s4u::Link* linkDown = simgrid::s4u::Link::by_name_or_null(hostlink->link_down);
373 xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up.c_str());
374 xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down.c_str());
375 sg_platf_cluster_set_hostlink(zone, netpoint, linkUp, linkDown, backbone);
378 /** @brief Create a cabinet (set of hosts) inside a Cluster(StarZone) */
379 static void sg_platf_new_cabinet(simgrid::kernel::routing::StarZone* zone,
380 const simgrid::kernel::routing::CabinetCreationArgs* args,
381 simgrid::kernel::resource::LinkImpl* backbone)
383 for (int const& radical : args->radicals) {
384 std::string id = args->prefix + std::to_string(radical) + args->suffix;
385 auto const* host = zone->create_host(id, std::vector<double>{args->speed})->seal();
388 zone->create_link("link_" + id + "_UP", std::vector<double>{args->bw})->set_latency(args->lat)->seal();
390 zone->create_link("link_" + id + "_DOWN", std::vector<double>{args->bw})->set_latency(args->lat)->seal();
392 sg_platf_cluster_set_hostlink(zone, host->get_netpoint(), link_up, link_down, backbone);
396 void sg_platf_zone_cluster_populate(simgrid::kernel::routing::ClusterZoneCreationArgs* cluster)
398 auto* zone = dynamic_cast<simgrid::kernel::routing::StarZone*>(current_routing);
399 xbt_assert(zone, "Host_links are only valid for Cluster(Star)");
401 simgrid::kernel::resource::LinkImpl* 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)->get_impl();
408 /* create host_links for hosts */
409 for (auto const& hostlink : cluster->host_links) {
410 sg_platf_new_hostlink(zone, &hostlink, backbone);
413 /* create cabinets */
414 for (auto const& cabinet : cluster->cabinets) {
415 sg_platf_new_cabinet(zone, &cabinet, backbone);
418 /*************************************************************************************************/
420 static void sg_platf_new_cluster_flat(simgrid::kernel::routing::ClusterCreationArgs* cluster)
422 using simgrid::kernel::routing::ClusterZone;
426 // What an inventive way of initializing the NetZone that I have as ancestor :-(
427 simgrid::kernel::routing::ZoneCreationArgs zone;
428 zone.id = cluster->id;
429 zone.routing = "Cluster";
430 sg_platf_new_Zone_begin(&zone);
431 auto* current_zone = static_cast<ClusterZone*>(routing_get_current());
432 for (auto const& elm : cluster->properties)
433 current_zone->get_iface()->set_property(elm.first, elm.second);
435 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
436 current_zone->set_loopback();
439 if (cluster->limiter_link > 0) {
440 current_zone->set_limiter();
443 for (int const& i : cluster->radicals) {
444 std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
446 XBT_DEBUG("<host\tid=\"%s\"\tspeed=\"%f\">", host_id.c_str(), cluster->speeds.front());
447 current_zone->create_host(host_id, cluster->speeds)
448 ->set_core_count(cluster->core_amount)
449 ->set_properties(cluster->properties)
452 XBT_DEBUG("</host>");
454 std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
455 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
457 // All links are saved in a matrix;
458 // every row describes a single node; every node may have multiple links.
459 // the first column may store a link from x to x if p_has_loopback is set
460 // the second column may store a limiter link if p_has_limiter is set
461 // other columns are to store one or more link for the node
463 // add a loopback link
464 simgrid::kernel::resource::LinkImpl* loopback = nullptr;
465 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
466 std::string loopback_name = link_id + "_loopback";
467 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", loopback_name.c_str(), cluster->loopback_bw);
469 loopback = current_zone->create_link(loopback_name, std::vector<double>{cluster->loopback_bw})
470 ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
471 ->set_latency(cluster->loopback_lat)
475 current_zone->add_private_link_at(current_zone->node_pos(rankId), {loopback, loopback});
478 // add a limiter link (shared link to account for maximal bandwidth of the node)
479 simgrid::kernel::resource::LinkImpl* limiter = nullptr;
480 if (cluster->limiter_link > 0) {
481 std::string limiter_name = std::string(link_id) + "_limiter";
482 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", limiter_name.c_str(), cluster->limiter_link);
484 limiter = current_zone->create_link(limiter_name, std::vector<double>{cluster->limiter_link})->seal()->get_impl();
486 current_zone->add_private_link_at(current_zone->node_pos_with_loopback(rankId), {limiter, limiter});
489 current_zone->set_link_characteristics(cluster->bw, cluster->lat, cluster->sharing_policy);
490 // call the cluster function that adds the others links
491 current_zone->create_links(i, rankId);
497 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
498 if (cluster->router_id.empty())
499 cluster->router_id = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
500 current_zone->set_router(current_zone->create_router(cluster->router_id));
503 if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
504 std::string bb_name = std::string(cluster->id) + "_backbone";
505 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/> <!--backbone -->", bb_name.c_str(), cluster->bb_bw,
508 auto* backbone = current_zone->create_link(bb_name, std::vector<double>{cluster->bb_bw})
509 ->set_sharing_policy(cluster->bb_sharing_policy)
510 ->set_latency(cluster->bb_lat)
513 current_zone->set_backbone(backbone);
516 XBT_DEBUG("</zone>");
517 sg_platf_new_Zone_seal();
518 simgrid::kernel::routing::on_cluster_creation(*cluster);
521 void sg_platf_new_tag_cluster(simgrid::kernel::routing::ClusterCreationArgs* cluster)
523 switch (cluster->topology) {
524 case simgrid::kernel::routing::ClusterTopology::TORUS:
525 case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
526 case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
527 sg_platf_new_cluster_hierarchical(cluster);
530 sg_platf_new_cluster_flat2(cluster);
534 /*************************************************************************************************/
536 void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route)
538 routing_get_current()->add_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list,
542 void sg_platf_new_bypassRoute(simgrid::kernel::routing::RouteCreationArgs* bypassRoute)
544 routing_get_current()->add_bypass_route(bypassRoute->src, bypassRoute->dst, bypassRoute->gw_src, bypassRoute->gw_dst,
545 bypassRoute->link_list, bypassRoute->symmetrical);
548 void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor)
550 sg_host_t host = sg_host_by_name(actor->host);
552 // The requested host does not exist. Do a nice message to the user
553 std::string msg = std::string("Cannot create actor '") + actor->function + "': host '" + actor->host +
554 "' does not exist\nExisting hosts: '";
556 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
558 for (auto const& some_host : list) {
559 msg += some_host->get_name();
561 if (msg.length() > 1024) {
562 msg.pop_back(); // remove trailing quote
563 msg += "...(list truncated)......";
567 xbt_die("%s", msg.c_str());
569 const simgrid::kernel::actor::ActorCodeFactory& factory =
570 simgrid::kernel::EngineImpl::get_instance()->get_function(actor->function);
571 xbt_assert(factory, "Error while creating an actor from the XML file: Function '%s' not registered", actor->function);
573 double start_time = actor->start_time;
574 double kill_time = actor->kill_time;
575 bool auto_restart = actor->restart_on_failure;
577 std::string actor_name = actor->args[0];
578 simgrid::kernel::actor::ActorCode code = factory(std::move(actor->args));
580 auto* arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
583 host->get_impl()->add_actor_at_boot(arg);
585 if (start_time > SIMIX_get_clock()) {
586 arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, actor->properties,
589 XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->get_cname(), start_time);
590 simgrid::simix::Timer::set(start_time, [arg, auto_restart]() {
591 simgrid::kernel::actor::ActorImplPtr new_actor =
592 simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), arg->code, arg->data, arg->host, nullptr);
593 new_actor->set_properties(arg->properties);
594 if (arg->kill_time >= 0)
595 new_actor->set_kill_time(arg->kill_time);
597 new_actor->set_auto_restart(auto_restart);
600 } else { // start_time <= SIMIX_get_clock()
601 XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->get_cname());
604 simgrid::kernel::actor::ActorImplPtr new_actor = nullptr;
605 new_actor = simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), code, nullptr, host, nullptr);
606 new_actor->set_properties(arg->properties);
607 /* The actor creation will fail if the host is currently dead, but that's fine */
608 if (arg->kill_time >= 0)
609 new_actor->set_kill_time(arg->kill_time);
611 new_actor->set_auto_restart(auto_restart);
612 } catch (simgrid::HostFailureException const&) {
613 XBT_WARN("Deployment includes some initially turned off Hosts ... nevermind.");
619 * @brief Auxiliary function to build the object NetZoneImpl
621 * Builds the objects, setting its father properties and root netzone if needed
622 * @param zone the parameters defining the Zone to build.
623 * @return Pointer to recently created netzone
625 static simgrid::kernel::routing::NetZoneImpl*
626 sg_platf_create_zone(const simgrid::kernel::routing::ZoneCreationArgs* zone)
628 /* search the routing model */
629 simgrid::kernel::routing::NetZoneImpl* new_zone = nullptr;
631 if (strcasecmp(zone->routing.c_str(), "Cluster") == 0) {
632 new_zone = new simgrid::kernel::routing::StarZone(zone->id);
633 } else if (strcasecmp(zone->routing.c_str(), "Dijkstra") == 0) {
634 new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, false);
635 } else if (strcasecmp(zone->routing.c_str(), "DijkstraCache") == 0) {
636 new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, true);
637 } else if (strcasecmp(zone->routing.c_str(), "Floyd") == 0) {
638 new_zone = new simgrid::kernel::routing::FloydZone(zone->id);
639 } else if (strcasecmp(zone->routing.c_str(), "Full") == 0) {
640 new_zone = new simgrid::kernel::routing::FullZone(zone->id);
641 } else if (strcasecmp(zone->routing.c_str(), "None") == 0) {
642 new_zone = new simgrid::kernel::routing::EmptyZone(zone->id);
643 } else if (strcasecmp(zone->routing.c_str(), "Vivaldi") == 0) {
644 new_zone = new simgrid::kernel::routing::VivaldiZone(zone->id);
645 } else if (strcasecmp(zone->routing.c_str(), "Wifi") == 0) {
646 new_zone = new simgrid::kernel::routing::WifiZone(zone->id);
648 xbt_die("Not a valid model!");
650 new_zone->set_parent(current_routing);
656 * @brief Add a Zone to the platform
658 * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
659 * and before the corresponding call to sg_platf_new_Zone_seal() will be added to this Zone.
661 * Once this function was called, the configuration concerning the used models cannot be changed anymore.
663 * @param zone the parameters defining the Zone to build.
665 simgrid::kernel::routing::NetZoneImpl* sg_platf_new_Zone_begin(const simgrid::kernel::routing::ZoneCreationArgs* zone)
667 current_routing = sg_platf_create_zone(zone);
669 return current_routing;
672 void sg_platf_new_Zone_set_properties(const std::unordered_map<std::string, std::string>& props)
674 xbt_assert(current_routing, "Cannot set properties of the current Zone: none under construction");
676 current_routing->set_properties(props);
680 * @brief Specify that the description of the current Zone is finished
682 * Once you've declared all the content of your Zone, you have to seal
683 * it with this call. Your Zone is not usable until you call this function.
685 void sg_platf_new_Zone_seal()
687 xbt_assert(current_routing, "Cannot seal the current Zone: none under construction");
688 current_routing->seal();
689 current_routing = current_routing->get_parent();
692 void sg_platf_new_trace(simgrid::kernel::routing::ProfileCreationArgs* args)
694 simgrid::kernel::profile::Profile* profile;
695 if (not args->file.empty()) {
696 profile = simgrid::kernel::profile::Profile::from_file(args->file);
698 xbt_assert(not args->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
700 profile = simgrid::kernel::profile::Profile::from_string(args->id, args->pc_data, args->periodicity);
702 traces_set_list.insert({args->id, profile});