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_coordinates(args->coord);
69 if (args->properties) {
70 host->set_properties(*args->properties);
71 delete args->properties;
73 host->get_impl()->set_disks(args->disks);
75 host->pimpl_cpu->set_core_count(args->core_amount)
76 ->set_state_profile(args->state_trace)
77 ->set_speed_profile(args->speed_trace);
81 /* When energy plugin is activated, changing the pstate requires to already have the HostEnergy extension whose
82 * allocation is triggered by the on_creation signal. Then set_pstate must be called after the signal emition */
83 if (args->pstate != 0)
84 host->set_pstate(args->pstate);
87 /** @brief Add a "router" to the network element list */
88 simgrid::kernel::routing::NetPoint* sg_platf_new_router(const std::string& name, const std::string& coords)
90 xbt_assert(nullptr == simgrid::s4u::Engine::get_instance()->netpoint_by_name_or_null(name),
91 "Refusing to create a router named '%s': this name already describes a node.", name.c_str());
93 auto* netpoint = new simgrid::kernel::routing::NetPoint(name, simgrid::kernel::routing::NetPoint::Type::Router);
94 netpoint->set_englobing_zone(current_routing);
95 XBT_DEBUG("Router '%s' has the id %u", netpoint->get_cname(), netpoint->id());
97 if (not coords.empty())
98 netpoint->set_coordinates(coords);
103 static void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* args, const std::string& link_name)
105 simgrid::s4u::Link* link = routing_get_current()->create_link(link_name, args->bandwidths);
106 if (args->properties)
107 link->set_properties(*args->properties);
109 link->get_impl() // this call to get_impl saves some simcalls but can be removed
110 ->set_sharing_policy(args->policy)
111 ->set_state_profile(args->state_trace)
112 ->set_latency_profile(args->latency_trace)
113 ->set_bandwidth_profile(args->bandwidth_trace)
114 ->set_latency(args->latency)
118 void sg_platf_new_link(const simgrid::kernel::routing::LinkCreationArgs* link)
120 if (link->policy == simgrid::s4u::Link::SharingPolicy::SPLITDUPLEX) {
121 sg_platf_new_link(link, link->id + "_UP");
122 sg_platf_new_link(link, link->id + "_DOWN");
124 sg_platf_new_link(link, link->id);
126 delete link->properties;
129 void sg_platf_new_cluster(simgrid::kernel::routing::ClusterCreationArgs* cluster)
131 using simgrid::kernel::routing::ClusterZone;
132 using simgrid::kernel::routing::DragonflyZone;
133 using simgrid::kernel::routing::FatTreeZone;
134 using simgrid::kernel::routing::TorusZone;
138 // What an inventive way of initializing the NetZone that I have as ancestor :-(
139 simgrid::kernel::routing::ZoneCreationArgs zone;
140 zone.id = cluster->id;
141 switch (cluster->topology) {
142 case simgrid::kernel::routing::ClusterTopology::TORUS:
143 zone.routing = "ClusterTorus";
145 case simgrid::kernel::routing::ClusterTopology::DRAGONFLY:
146 zone.routing = "ClusterDragonfly";
148 case simgrid::kernel::routing::ClusterTopology::FAT_TREE:
149 zone.routing = "ClusterFatTree";
152 zone.routing = "Cluster";
155 sg_platf_new_Zone_begin(&zone);
156 auto* current_zone = static_cast<ClusterZone*>(routing_get_current());
157 current_zone->parse_specific_arguments(cluster);
158 if (cluster->properties != nullptr)
159 for (auto const& elm : *cluster->properties)
160 current_zone->get_iface()->set_property(elm.first, elm.second);
162 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
163 current_zone->set_loopback();
166 if (cluster->limiter_link > 0) {
167 current_zone->set_limiter();
170 for (int const& i : cluster->radicals) {
171 std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
173 XBT_DEBUG("<host\tid=\"%s\"\tspeed=\"%f\">", host_id.c_str(), cluster->speeds.front());
174 simgrid::s4u::Host* host =
175 current_zone->create_host(host_id, cluster->speeds)->set_core_count(cluster->core_amount);
177 if ((cluster->properties != nullptr) && (not cluster->properties->empty()))
178 host->set_properties(*cluster->properties);
181 XBT_DEBUG("</host>");
183 std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
184 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
186 // All links are saved in a matrix;
187 // every row describes a single node; every node may have multiple links.
188 // the first column may store a link from x to x if p_has_loopback is set
189 // the second column may store a limiter link if p_has_limiter is set
190 // other columns are to store one or more link for the node
192 // add a loopback link
193 if (cluster->loopback_bw > 0 || cluster->loopback_lat > 0) {
194 std::string loopback_name = link_id + "_loopback";
195 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", loopback_name.c_str(), cluster->loopback_bw);
197 auto* loopback = current_zone->create_link(loopback_name, std::vector<double>{cluster->loopback_bw})
198 ->set_sharing_policy(simgrid::s4u::Link::SharingPolicy::FATPIPE)
199 ->set_latency(cluster->loopback_lat)
203 current_zone->add_private_link_at(current_zone->node_pos(rankId), {loopback, loopback});
206 // add a limiter link (shared link to account for maximal bandwidth of the node)
207 if (cluster->limiter_link > 0) {
208 std::string limiter_name = std::string(link_id) + "_limiter";
209 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", limiter_name.c_str(), cluster->limiter_link);
212 current_zone->create_link(limiter_name, std::vector<double>{cluster->limiter_link})->seal()->get_impl();
214 current_zone->add_private_link_at(current_zone->node_pos_with_loopback(rankId), {limiter, limiter});
217 // call the cluster function that adds the others links
218 if (cluster->topology == simgrid::kernel::routing::ClusterTopology::FAT_TREE) {
219 static_cast<FatTreeZone*>(current_zone)->add_processing_node(i);
221 current_zone->create_links_for_node(cluster, i, rankId, current_zone->node_pos_with_loopback_limiter(rankId));
225 delete cluster->properties;
229 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id.c_str());
230 if (cluster->router_id.empty())
231 cluster->router_id = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
232 current_zone->set_router(sg_platf_new_router(cluster->router_id, ""));
235 if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
236 std::string bb_name = std::string(cluster->id) + "_backbone";
237 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/> <!--backbone -->", bb_name.c_str(), cluster->bb_bw,
240 auto* backbone = current_zone->create_link(bb_name, std::vector<double>{cluster->bb_bw})
241 ->set_sharing_policy(cluster->bb_sharing_policy)
242 ->set_latency(cluster->bb_lat)
244 current_zone->set_backbone(backbone->get_impl());
247 XBT_DEBUG("</zone>");
248 sg_platf_new_Zone_seal();
250 simgrid::kernel::routing::on_cluster_creation(*cluster);
253 void routing_cluster_add_backbone(simgrid::kernel::resource::LinkImpl* bb)
255 auto* cluster = dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
257 xbt_assert(cluster, "Only hosts from Cluster can get a backbone.");
258 xbt_assert(not cluster->has_backbone(), "Cluster %s already has a backbone link!", cluster->get_cname());
260 cluster->set_backbone(bb);
261 XBT_DEBUG("Add a backbone to zone '%s'", current_routing->get_cname());
264 void sg_platf_new_cabinet(const simgrid::kernel::routing::CabinetCreationArgs* cabinet)
266 auto* zone = static_cast<simgrid::kernel::routing::ClusterZone*>(routing_get_current());
267 for (int const& radical : cabinet->radicals) {
268 std::string id = cabinet->prefix + std::to_string(radical) + cabinet->suffix;
269 simgrid::s4u::Host* host = zone->create_host(id, std::vector<double>{cabinet->speed})->seal();
271 simgrid::s4u::Link* link_up =
272 zone->create_link("link_" + id + "_UP", std::vector<double>{cabinet->bw})->set_latency(cabinet->lat)->seal();
273 simgrid::s4u::Link* link_down =
274 zone->create_link("link_" + id + "_DOWN", std::vector<double>{cabinet->bw})->set_latency(cabinet->lat)->seal();
276 zone->add_private_link_at(host->get_netpoint()->id(), {link_up->get_impl(), link_down->get_impl()});
280 simgrid::kernel::resource::DiskImpl* sg_platf_new_disk(const simgrid::kernel::routing::DiskCreationArgs* disk)
282 simgrid::kernel::resource::DiskImpl* pimpl =
283 routing_get_current()->create_disk(disk->id, disk->read_bw, disk->write_bw)->get_impl();
285 if (disk->properties) {
286 pimpl->set_properties(*disk->properties);
287 delete disk->properties;
291 simgrid::s4u::Disk::on_creation(*pimpl->get_iface());
295 void sg_platf_new_route(simgrid::kernel::routing::RouteCreationArgs* route)
297 routing_get_current()->add_route(route->src, route->dst, route->gw_src, route->gw_dst, route->link_list,
301 void sg_platf_new_bypassRoute(simgrid::kernel::routing::RouteCreationArgs* bypassRoute)
303 routing_get_current()->add_bypass_route(bypassRoute->src, bypassRoute->dst, bypassRoute->gw_src, bypassRoute->gw_dst,
304 bypassRoute->link_list, bypassRoute->symmetrical);
307 void sg_platf_new_actor(simgrid::kernel::routing::ActorCreationArgs* actor)
309 sg_host_t host = sg_host_by_name(actor->host);
311 // The requested host does not exist. Do a nice message to the user
312 std::string msg = std::string("Cannot create actor '") + actor->function + "': host '" + actor->host +
313 "' does not exist\nExisting hosts: '";
315 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
317 for (auto const& some_host : list) {
318 msg += some_host->get_name();
320 if (msg.length() > 1024) {
321 msg.pop_back(); // remove trailing quote
322 msg += "...(list truncated)......";
326 xbt_die("%s", msg.c_str());
328 const simgrid::kernel::actor::ActorCodeFactory& factory =
329 simgrid::kernel::EngineImpl::get_instance()->get_function(actor->function);
330 xbt_assert(factory, "Error while creating an actor from the XML file: Function '%s' not registered", actor->function);
332 double start_time = actor->start_time;
333 double kill_time = actor->kill_time;
334 bool auto_restart = actor->restart_on_failure;
336 std::string actor_name = actor->args[0];
337 simgrid::kernel::actor::ActorCode code = factory(std::move(actor->args));
338 std::shared_ptr<std::unordered_map<std::string, std::string>> properties(actor->properties);
341 new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, properties, auto_restart);
343 host->get_impl()->add_actor_at_boot(arg);
345 if (start_time > SIMIX_get_clock()) {
346 arg = new simgrid::kernel::actor::ProcessArg(actor_name, code, nullptr, host, kill_time, properties, auto_restart);
348 XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->get_cname(), start_time);
349 simgrid::simix::Timer::set(start_time, [arg, auto_restart]() {
350 simgrid::kernel::actor::ActorImplPtr new_actor = simgrid::kernel::actor::ActorImpl::create(
351 arg->name.c_str(), arg->code, arg->data, arg->host, arg->properties.get(), nullptr);
352 if (arg->kill_time >= 0)
353 new_actor->set_kill_time(arg->kill_time);
355 new_actor->set_auto_restart(auto_restart);
358 } else { // start_time <= SIMIX_get_clock()
359 XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->get_cname());
362 simgrid::kernel::actor::ActorImplPtr new_actor = nullptr;
363 new_actor = simgrid::kernel::actor::ActorImpl::create(arg->name.c_str(), code, nullptr, host,
364 arg->properties.get(), nullptr);
365 /* The actor creation will fail if the host is currently dead, but that's fine */
366 if (arg->kill_time >= 0)
367 new_actor->set_kill_time(arg->kill_time);
369 new_actor->set_auto_restart(auto_restart);
370 } catch (simgrid::HostFailureException const&) {
371 XBT_WARN("Deployment includes some initially turned off Hosts ... nevermind.");
376 void sg_platf_new_peer(const simgrid::kernel::routing::PeerCreationArgs* peer)
378 auto* zone = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
379 xbt_assert(zone, "<peer> tag can only be used in Vivaldi netzones.");
381 simgrid::s4u::Host* host = zone->create_host(peer->id, std::vector<double>{peer->speed})
382 ->set_state_profile(peer->state_trace)
383 ->set_speed_profile(peer->speed_trace)
384 ->set_coordinates(peer->coord)
387 zone->set_peer_link(host->get_netpoint(), peer->bw_in, peer->bw_out);
390 * @brief Auxiliary function to build the object NetZoneImpl
392 * Builds the objects, setting its father properties and root netzone if needed
393 * @param zone the parameters defining the Zone to build.
394 * @return Pointer to recently created netzone
396 static simgrid::kernel::routing::NetZoneImpl*
397 sg_platf_create_zone(const simgrid::kernel::routing::ZoneCreationArgs* zone)
399 /* search the routing model */
400 simgrid::kernel::routing::NetZoneImpl* new_zone = nullptr;
402 if (strcasecmp(zone->routing.c_str(), "Cluster") == 0) {
403 new_zone = new simgrid::kernel::routing::ClusterZone(zone->id);
404 } else if (strcasecmp(zone->routing.c_str(), "ClusterDragonfly") == 0) {
405 new_zone = new simgrid::kernel::routing::DragonflyZone(zone->id);
406 } else if (strcasecmp(zone->routing.c_str(), "ClusterTorus") == 0) {
407 new_zone = new simgrid::kernel::routing::TorusZone(zone->id);
408 } else if (strcasecmp(zone->routing.c_str(), "ClusterFatTree") == 0) {
409 new_zone = new simgrid::kernel::routing::FatTreeZone(zone->id);
410 } else if (strcasecmp(zone->routing.c_str(), "Dijkstra") == 0) {
411 new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, false);
412 } else if (strcasecmp(zone->routing.c_str(), "DijkstraCache") == 0) {
413 new_zone = new simgrid::kernel::routing::DijkstraZone(zone->id, true);
414 } else if (strcasecmp(zone->routing.c_str(), "Floyd") == 0) {
415 new_zone = new simgrid::kernel::routing::FloydZone(zone->id);
416 } else if (strcasecmp(zone->routing.c_str(), "Full") == 0) {
417 new_zone = new simgrid::kernel::routing::FullZone(zone->id);
418 } else if (strcasecmp(zone->routing.c_str(), "None") == 0) {
419 new_zone = new simgrid::kernel::routing::EmptyZone(zone->id);
420 } else if (strcasecmp(zone->routing.c_str(), "Vivaldi") == 0) {
421 new_zone = new simgrid::kernel::routing::VivaldiZone(zone->id);
422 } else if (strcasecmp(zone->routing.c_str(), "Wifi") == 0) {
423 new_zone = new simgrid::kernel::routing::WifiZone(zone->id);
425 xbt_die("Not a valid model!");
427 new_zone->set_parent(current_routing);
433 * @brief Add a Zone to the platform
435 * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
436 * and before the corresponding call to sg_platf_new_Zone_seal() will be added to this Zone.
438 * Once this function was called, the configuration concerning the used models cannot be changed anymore.
440 * @param zone the parameters defining the Zone to build.
442 simgrid::kernel::routing::NetZoneImpl* sg_platf_new_Zone_begin(const simgrid::kernel::routing::ZoneCreationArgs* zone)
444 /* First create the zone.
445 * This order is important to assure that root netzone is set when models are setting
446 * the default mode for each resource (CPU, network, etc)
448 auto* new_zone = sg_platf_create_zone(zone);
450 _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
451 * any further config now that we created some real content */
453 /* set the new current component of the tree */
454 current_routing = new_zone;
455 simgrid::s4u::NetZone::on_creation(*new_zone->get_iface()); // notify the signal
460 void sg_platf_new_Zone_set_properties(const std::unordered_map<std::string, std::string>* props)
462 xbt_assert(current_routing, "Cannot set properties of the current Zone: none under construction");
465 current_routing->set_properties(*props);
469 * @brief Specify that the description of the current Zone is finished
471 * Once you've declared all the content of your Zone, you have to seal
472 * it with this call. Your Zone is not usable until you call this function.
474 void sg_platf_new_Zone_seal()
476 xbt_assert(current_routing, "Cannot seal the current Zone: zone under construction");
477 current_routing->seal();
478 simgrid::s4u::NetZone::on_seal(*current_routing->get_iface());
479 current_routing = current_routing->get_parent();
482 /** @brief Add a link connecting a host to the rest of its Zone (which must be cluster or vivaldi) */
483 void sg_platf_new_hostlink(const simgrid::kernel::routing::HostLinkCreationArgs* hostlink)
485 const simgrid::kernel::routing::NetPoint* netpoint = simgrid::s4u::Host::by_name(hostlink->id)->get_netpoint();
486 xbt_assert(netpoint, "Host '%s' not found!", hostlink->id.c_str());
487 xbt_assert(dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing),
488 "Only hosts from Cluster and Vivaldi Zones can get a host_link.");
490 const simgrid::s4u::Link* linkUp = simgrid::s4u::Link::by_name_or_null(hostlink->link_up);
491 const simgrid::s4u::Link* linkDown = simgrid::s4u::Link::by_name_or_null(hostlink->link_down);
493 xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up.c_str());
494 xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down.c_str());
496 auto* cluster_zone = static_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
498 if (cluster_zone->private_link_exists_at(netpoint->id()))
499 surf_parse_error(std::string("Host_link for '") + hostlink->id.c_str() + "' is already defined!");
501 XBT_DEBUG("Push Host_link for host '%s' to position %u", netpoint->get_cname(), netpoint->id());
502 cluster_zone->add_private_link_at(netpoint->id(), {linkUp->get_impl(), linkDown->get_impl()});
505 void sg_platf_new_trace(simgrid::kernel::routing::ProfileCreationArgs* profile)
507 simgrid::kernel::profile::Profile* mgr_profile;
508 if (not profile->file.empty()) {
509 mgr_profile = simgrid::kernel::profile::Profile::from_file(profile->file);
511 xbt_assert(not profile->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
512 profile->id.c_str());
513 mgr_profile = simgrid::kernel::profile::Profile::from_string(profile->id, profile->pc_data, profile->periodicity);
515 traces_set_list.insert({profile->id, mgr_profile});