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;
48 /** Module management function: creates all internal data structures */
51 // Do nothing: just for symmetry of user code
54 /** Module management function: frees all internal data structures */
57 simgrid::kernel::routing::on_cluster_creation.disconnect_slots();
58 simgrid::s4u::Engine::on_platform_created.disconnect_slots();
60 surf_parse_lex_destroy();
63 /** @brief Add a host to the current NetZone */
64 void sg_platf_new_host(const simgrid::kernel::routing::HostCreationArgs* args)
66 simgrid::s4u::Host* host =
67 routing_get_current()->create_host(args->id, args->speed_per_pstate)->set_core_count(args->core_amount);
69 if (args->properties) {
70 host->set_properties(*args->properties);
71 delete args->properties;
74 host->get_impl()->set_disks(args->disks, host);
76 /* Change from the defaults */
77 host->set_state_profile(args->state_trace)->set_speed_profile(args->speed_trace);
79 if (not args->coord.empty())
80 new simgrid::kernel::routing::vivaldi::Coords(host->get_netpoint(), args->coord);
83 simgrid::s4u::Host::on_creation(*host); // notify the signal
85 /* When energy plugin is activated, changing the pstate requires to already have the HostEnergy extension whose
86 * allocation is triggered by the on_creation signal. Then set_pstate must be called after the signal emition */
87 if (args->pstate != 0)
88 host->set_pstate(args->pstate);
91 /** @brief Add a "router" to the network element list */
92 simgrid::kernel::routing::NetPoint* sg_platf_new_router(const std::string& name, const char* coords)
94 xbt_assert(nullptr == simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(name),
95 "Refusing to create a router named '%s': this name already describes a node.", name.c_str());
97 auto* netpoint = new simgrid::kernel::routing::NetPoint(name, simgrid::kernel::routing::NetPoint::Type::Router);
98 netpoint->set_englobing_zone(current_routing);
99 XBT_DEBUG("Router '%s' has the id %u", netpoint->get_cname(), netpoint->id());
101 if (coords && strcmp(coords, ""))
102 new simgrid::kernel::routing::vivaldi::Coords(netpoint, coords);
107 static void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* args, const std::string& link_name)
109 simgrid::s4u::Link* link = routing_get_current()->create_link(link_name, args->bandwidths);
110 if (args->properties)
111 link->set_properties(*args->properties);
113 link->get_impl() // this call to get_impl saves some simcalls but can be removed
114 ->set_sharing_policy(args->policy)
115 ->set_state_profile(args->state_trace)
116 ->set_latency_profile(args->latency_trace)
117 ->set_bandwidth_profile(args->bandwidth_trace)
118 ->set_latency(args->latency)
122 void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* link)
124 if (link->policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
125 sg_platf_new_link(link, link->id + "_UP");
126 sg_platf_new_link(link, link->id + "_DOWN");
128 sg_platf_new_link(link, link->id);
130 delete link->properties;
133 void sg_platf_new_cluster(simgrid::kernel::routing::ClusterCreationArgs* cluster)
135 using simgrid::kernel::routing::ClusterZone;
136 using simgrid::kernel::routing::DragonflyZone;
137 using simgrid::kernel::routing::FatTreeZone;
138 using simgrid::kernel::routing::TorusZone;
142 // What an inventive way of initializing the NetZone that I have as ancestor :-(
143 simgrid::kernel::routing::ZoneCreationArgs zone;
144 zone.id = cluster->id;
145 switch (cluster->topology) {
146 case simgrid::kernel::routing::ClusterTopology::TORUS:
147 zone.routing = "ClusterTorus";
149 case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
150 zone.routing = "ClusterDragonfly";
152 case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
153 zone.routing = "ClusterFatTree";
156 zone.routing = "Cluster";
159 sg_platf_new_Zone_begin(&zone);
160 auto* current_zone = static_cast<ClusterZone*>(routing_get_current());
161 current_zone->parse_specific_arguments(cluster);
162 if (cluster->properties != nullptr)
163 for (auto const& elm : *cluster->properties)
164 current_zone->get_iface()->set_property(elm.first, elm.second);
166 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
167 current_zone->set_loopback();
170 if (cluster->limiter_link > 0) {
171 current_zone->set_limiter();
174 for (int const& i : *cluster->radicals) {
175 std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
176 std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
178 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id.c_str(), cluster->speeds.front());
180 simgrid::kernel::routing::HostCreationArgs host;
182 if ((cluster->properties != nullptr) && (not cluster->properties->empty())) {
183 host.properties = new std::unordered_map<std::string, std::string>();
185 for (auto const& elm : *cluster->properties)
186 host.properties->insert({elm.first, elm.second});
189 host.speed_per_pstate = cluster->speeds;
191 host.core_amount = cluster->core_amount;
193 sg_platf_new_host(&host);
194 XBT_DEBUG("</host>");
196 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
198 // All links are saved in a matrix;
199 // every row describes a single node; every node may have multiple links.
200 // the first column may store a link from x to x if p_has_loopback is set
201 // the second column may store a limiter link if p_has_limiter is set
202 // other columns are to store one or more link for the node
204 // add a loopback link
205 const simgrid::s4u::Link* linkUp = nullptr;
206 const simgrid::s4u::Link* linkDown = nullptr;
207 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
208 std::string tmp_link = link_id + "_loopback";
209 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link.c_str(), cluster->loopback_bw);
211 simgrid::kernel::routing::LinkCreationArgs link;
213 link.bandwidths.push_back(cluster->loopback_bw);
214 link.latency = cluster->loopback_lat;
215 link.policy = simgrid::s4u::Link::SharingPolicy::FATPIPE;
216 sg_platf_new_link(&link);
217 linkUp = simgrid::s4u::Link::by_name_or_null(tmp_link);
218 linkDown = simgrid::s4u::Link::by_name_or_null(tmp_link);
220 current_zone->add_private_link_at(current_zone->node_pos(rankId), {linkUp->get_impl(), linkDown->get_impl()});
223 // add a limiter link (shared link to account for maximal bandwidth of the node)
226 if (cluster->limiter_link > 0) {
227 std::string tmp_link = std::string(link_id) + "_limiter";
228 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link.c_str(), cluster->limiter_link);
230 simgrid::kernel::routing::LinkCreationArgs link;
232 link.bandwidths.push_back(cluster->limiter_link);
234 link.policy = simgrid::s4u::Link::SharingPolicy::SHARED;
235 sg_platf_new_link(&link);
236 linkDown = simgrid::s4u::Link::by_name_or_null(tmp_link);
238 current_zone->add_private_link_at(current_zone->node_pos_with_loopback(rankId),
239 {linkUp->get_impl(), linkDown->get_impl()});
242 // call the cluster function that adds the others links
243 if (cluster->topology == simgrid::kernel::routing::ClusterTopology::FAT_TREE) {
244 static_cast<FatTreeZone*>(current_zone)->add_processing_node(i);
246 current_zone->create_links_for_node(cluster, i, rankId, current_zone->node_pos_with_loopback_limiter(rankId));
250 delete cluster->properties;
254 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
255 if (cluster->router_id.empty())
256 cluster->router_id = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
257 current_zone->set_router(sg_platf_new_router(cluster->router_id, nullptr));
260 if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
261 simgrid::kernel::routing::LinkCreationArgs link;
262 link.id = std::string(cluster->id) + "_backbone";
263 link.bandwidths.push_back(cluster->bb_bw);
264 link.latency = cluster->bb_lat;
265 link.policy = cluster->bb_sharing_policy;
267 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link.id.c_str(), cluster->bb_bw, cluster->bb_lat);
268 sg_platf_new_link(&link);
270 routing_cluster_add_backbone(simgrid::s4u::Link::by_name(link.id)->get_impl());
273 XBT_DEBUG("</zone>");
274 sg_platf_new_Zone_seal();
276 simgrid::kernel::routing::on_cluster_creation(*cluster);
277 delete cluster->radicals;
280 void routing_cluster_add_backbone(simgrid::kernel::resource::LinkImpl* bb)
282 auto* cluster = dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
284 xbt_assert(cluster, "Only hosts from Cluster can get a backbone.");
285 xbt_assert(not cluster->has_backbone(), "Cluster %s already has a backbone link!", cluster->get_cname());
287 cluster->set_backbone(bb);
288 XBT_DEBUG("Add a backbone to zone '%s'", current_routing->get_cname());
291 void sg_platf_new_cabinet(const simgrid::kernel::routing::CabinetCreationArgs* cabinet)
293 for (int const& radical : *cabinet->radicals) {
294 std::string hostname = cabinet->prefix + std::to_string(radical) + cabinet->suffix;
295 simgrid::kernel::routing::HostCreationArgs host;
297 host.core_amount = 1;
299 host.speed_per_pstate.push_back(cabinet->speed);
300 sg_platf_new_host(&host);
302 simgrid::kernel::routing::LinkCreationArgs link;
303 link.policy = simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX;
304 link.latency = cabinet->lat;
305 link.bandwidths.push_back(cabinet->bw);
306 link.id = "link_" + hostname;
307 sg_platf_new_link(&link);
309 simgrid::kernel::routing::HostLinkCreationArgs host_link;
310 host_link.id = hostname;
311 host_link.link_up = std::string("link_") + hostname + "_UP";
312 host_link.link_down = std::string("link_") + hostname + "_DOWN";
313 sg_platf_new_hostlink(&host_link);
315 delete cabinet->radicals;
318 simgrid::kernel::resource::DiskImpl* sg_platf_new_disk(const simgrid::kernel::routing::DiskCreationArgs* disk)
320 simgrid::kernel::resource::DiskImpl* pimpl =
321 routing_get_current()->create_disk(disk->id, disk->read_bw, disk->write_bw)->get_impl();
323 if (disk->properties) {
324 pimpl->set_properties(*disk->properties);
325 delete disk->properties;
329 simgrid::s4u::Disk::on_creation(*pimpl->get_iface());
333 void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route)
335 routing_get_current()->add_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list,
339 void sg_platf_new_bypassRoute(simgrid::kernel::routing::RouteCreationArgs* bypassRoute)
341 routing_get_current()->add_bypass_route(bypassRoute->src, bypassRoute->dst, bypassRoute->gw_src, bypassRoute->gw_dst,
342 bypassRoute->link_list, bypassRoute->symmetrical);
345 void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor)
347 sg_host_t host = sg_host_by_name(actor->host);
349 // The requested host does not exist. Do a nice message to the user
350 std::string msg = std::string("Cannot create actor '") + actor->function + "': host '" + actor->host +
351 "' does not exist\nExisting hosts: '";
353 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
355 for (auto const& some_host : list) {
356 msg += some_host->get_name();
358 if (msg.length() > 1024) {
359 msg.pop_back(); // remove trailing quote
360 msg += "...(list truncated)......";
364 xbt_die("%s", msg.c_str());
366 const simgrid::kernel::actor::ActorCodeFactory& factory =
367 simgrid::kernel::EngineImpl::get_instance()->get_function(actor->function);
368 xbt_assert(factory, "Error while creating an actor from the XML file: Function '%s' not registered", actor->function);
370 double start_time = actor->start_time;
371 double kill_time = actor->kill_time;
372 bool auto_restart = actor->restart_on_failure;
374 std::string actor_name = actor->args[0];
375 simgrid::kernel::actor::ActorCode code = factory(std::move(actor->args));
376 std::shared_ptr<std::unordered_map<std::string, std::string>> properties(actor->properties);
379 new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, properties, auto_restart);
381 host->get_impl()->add_actor_at_boot(arg);
383 if (start_time > SIMIX_get_clock()) {
384 arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, properties, auto_restart);
386 XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->get_cname(), start_time);
387 simgrid::simix::Timer::set(start_time, [arg, auto_restart]() {
388 simgrid::kernel::actor::ActorImplPtr new_actor = simgrid::kernel::actor::ActorImpl::create(
389 arg->name.c_str(), arg->code, arg->data, arg->host, arg->properties.get(), nullptr);
390 if (arg->kill_time >= 0)
391 new_actor->set_kill_time(arg->kill_time);
393 new_actor->set_auto_restart(auto_restart);
396 } else { // start_time <= SIMIX_get_clock()
397 XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->get_cname());
400 simgrid::kernel::actor::ActorImplPtr new_actor = nullptr;
401 new_actor = simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), code, nullptr, host,
402 arg->properties.get(), nullptr);
403 /* The actor creation will fail if the host is currently dead, but that's fine */
404 if (arg->kill_time >= 0)
405 new_actor->set_kill_time(arg->kill_time);
407 new_actor->set_auto_restart(auto_restart);
408 } catch (simgrid::HostFailureException const&) {
409 XBT_WARN("Deployment includes some initially turned off Hosts ... nevermind.");
414 void sg_platf_new_peer(const simgrid::kernel::routing::PeerCreationArgs* peer)
416 auto* zone = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
417 xbt_assert(zone, "<peer> tag can only be used in Vivaldi netzones.");
419 std::vector<double> speed_per_pstate;
420 speed_per_pstate.push_back(peer->speed);
421 simgrid::s4u::Host* host = zone->create_host(peer->id, speed_per_pstate);
423 zone->set_peer_link(host->get_netpoint(), peer->bw_in, peer->bw_out, peer->coord);
425 /* Change from the defaults */
426 if (peer->state_trace)
427 host->set_state_profile(peer->state_trace);
428 if (peer->speed_trace)
429 host->set_speed_profile(peer->speed_trace);
431 simgrid::s4u::Host::on_creation(*host); // notify the signal
435 * @brief Auxiliary function to build the object NetZoneImpl
437 * Builds the objects, setting its father properties and root netzone if needed
438 * @param zone the parameters defining the Zone to build.
439 * @return Pointer to recently created netzone
441 static simgrid::kernel::routing::NetZoneImpl*
442 sg_platf_create_zone(const simgrid::kernel::routing::ZoneCreationArgs* zone)
444 /* search the routing model */
445 simgrid::kernel::routing::NetZoneImpl* new_zone = nullptr;
447 if (strcasecmp(zone->routing.c_str(), "Cluster") == 0) {
448 new_zone = new simgrid::kernel::routing::ClusterZone(zone->id);
449 } else if (strcasecmp(zone->routing.c_str(), "ClusterDragonfly") == 0) {
450 new_zone = new simgrid::kernel::routing::DragonflyZone(zone->id);
451 } else if (strcasecmp(zone->routing.c_str(), "ClusterTorus") == 0) {
452 new_zone = new simgrid::kernel::routing::TorusZone(zone->id);
453 } else if (strcasecmp(zone->routing.c_str(), "ClusterFatTree") == 0) {
454 new_zone = new simgrid::kernel::routing::FatTreeZone(zone->id);
455 } else if (strcasecmp(zone->routing.c_str(), "Dijkstra") == 0) {
456 new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, false);
457 } else if (strcasecmp(zone->routing.c_str(), "DijkstraCache") == 0) {
458 new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, true);
459 } else if (strcasecmp(zone->routing.c_str(), "Floyd") == 0) {
460 new_zone = new simgrid::kernel::routing::FloydZone(zone->id);
461 } else if (strcasecmp(zone->routing.c_str(), "Full") == 0) {
462 new_zone = new simgrid::kernel::routing::FullZone(zone->id);
463 } else if (strcasecmp(zone->routing.c_str(), "None") == 0) {
464 new_zone = new simgrid::kernel::routing::EmptyZone(zone->id);
465 } else if (strcasecmp(zone->routing.c_str(), "Vivaldi") == 0) {
466 new_zone = new simgrid::kernel::routing::VivaldiZone(zone->id);
467 } else if (strcasecmp(zone->routing.c_str(), "Wifi") == 0) {
468 new_zone = new simgrid::kernel::routing::WifiZone(zone->id);
470 xbt_die("Not a valid model!");
472 new_zone->set_parent(current_routing);
478 * @brief Add a Zone to the platform
480 * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
481 * and before the corresponding call to sg_platf_new_Zone_seal() will be added to this Zone.
483 * Once this function was called, the configuration concerning the used models cannot be changed anymore.
485 * @param zone the parameters defining the Zone to build.
487 simgrid::kernel::routing::NetZoneImpl* sg_platf_new_Zone_begin(const simgrid::kernel::routing::ZoneCreationArgs* zone)
489 /* First create the zone.
490 * This order is important to assure that root netzone is set when models are setting
491 * the default mode for each resource (CPU, network, etc)
493 auto* new_zone = sg_platf_create_zone(zone);
495 _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
496 * any further config now that we created some real content */
498 /* set the new current component of the tree */
499 current_routing = new_zone;
500 simgrid::s4u::NetZone::on_creation(*new_zone->get_iface()); // notify the signal
505 void sg_platf_new_Zone_set_properties(const std::unordered_map<std::string, std::string>* props)
507 xbt_assert(current_routing, "Cannot set properties of the current Zone: none under construction");
510 current_routing->set_properties(*props);
514 * @brief Specify that the description of the current Zone is finished
516 * Once you've declared all the content of your Zone, you have to seal
517 * it with this call. Your Zone is not usable until you call this function.
519 void sg_platf_new_Zone_seal()
521 xbt_assert(current_routing, "Cannot seal the current Zone: zone under construction");
522 current_routing->seal();
523 simgrid::s4u::NetZone::on_seal(*current_routing->get_iface());
524 current_routing = current_routing->get_parent();
527 /** @brief Add a link connecting a host to the rest of its Zone (which must be cluster or vivaldi) */
528 void sg_platf_new_hostlink(const simgrid::kernel::routing::HostLinkCreationArgs* hostlink)
530 const simgrid::kernel::routing::NetPoint* netpoint = simgrid::s4u::Host::by_name(hostlink->id)->get_netpoint();
531 xbt_assert(netpoint, "Host '%s' not found!", hostlink->id.c_str());
532 xbt_assert(dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing),
533 "Only hosts from Cluster and Vivaldi Zones can get a host_link.");
535 const simgrid::s4u::Link* linkUp = simgrid::s4u::Link::by_name_or_null(hostlink->link_up);
536 const simgrid::s4u::Link* linkDown = simgrid::s4u::Link::by_name_or_null(hostlink->link_down);
538 xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up.c_str());
539 xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down.c_str());
541 auto* cluster_zone = static_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
543 if (cluster_zone->private_link_exists_at(netpoint->id()))
544 surf_parse_error(std::string("Host_link for '") + hostlink->id.c_str() + "' is already defined!");
546 XBT_DEBUG("Push Host_link for host '%s' to position %u", netpoint->get_cname(), netpoint->id());
547 cluster_zone->add_private_link_at(netpoint->id(), {linkUp->get_impl(), linkDown->get_impl()});
550 void sg_platf_new_trace(simgrid::kernel::routing::ProfileCreationArgs* profile)
552 simgrid::kernel::profile::Profile* mgr_profile;
553 if (not profile->file.empty()) {
554 mgr_profile = simgrid::kernel::profile::Profile::from_file(profile->file);
556 xbt_assert(not profile->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
557 profile->id.c_str());
558 mgr_profile = simgrid::kernel::profile::Profile::from_string(profile->id, profile->pc_data, profile->periodicity);
560 traces_set_list.insert({profile->id, mgr_profile});