1 /* Copyright (c) 2006-2014. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include "xbt/RngStream.h"
12 #include <xbt/functional.hpp>
13 #include <xbt/signal.hpp>
14 #include "src/surf/HostImpl.hpp"
15 #include "surf/surf.h"
17 #include "simgrid/s4u/engine.hpp"
18 #include "src/kernel/EngineImpl.hpp"
19 #include "src/simix/smx_private.h"
21 #include "src/include/simgrid/sg_config.h"
22 #include "src/surf/xml/platf_private.hpp"
24 #include "src/surf/HostImpl.hpp"
25 #include "src/surf/cpu_interface.hpp"
26 #include "src/surf/network_interface.hpp"
28 #include "src/kernel/routing/ClusterZone.hpp"
29 #include "src/kernel/routing/DijkstraZone.hpp"
30 #include "src/kernel/routing/DragonflyZone.hpp"
31 #include "src/kernel/routing/EmptyZone.hpp"
32 #include "src/kernel/routing/FatTreeZone.hpp"
33 #include "src/kernel/routing/FloydZone.hpp"
34 #include "src/kernel/routing/FullZone.hpp"
35 #include "src/kernel/routing/NetCard.hpp"
36 #include "src/kernel/routing/NetZoneImpl.hpp"
37 #include "src/kernel/routing/TorusZone.hpp"
38 #include "src/kernel/routing/VivaldiZone.hpp"
40 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_parse);
42 XBT_PRIVATE xbt_dynar_t mount_list = nullptr;
47 simgrid::xbt::signal<void(sg_platf_link_cbarg_t)> on_link;
48 simgrid::xbt::signal<void(sg_platf_cluster_cbarg_t)> on_cluster;
49 simgrid::xbt::signal<void(void)> on_postparse;
54 static int surf_parse_models_setup_already_called = 0;
56 /** The current AS in the parsing */
57 static simgrid::kernel::routing::NetZoneImpl* current_routing = nullptr;
58 static simgrid::kernel::routing::NetZoneImpl* routing_get_current()
60 return current_routing;
63 /** Module management function: creates all internal data structures */
64 void sg_platf_init() {
67 /** Module management function: frees all internal data structures */
68 void sg_platf_exit() {
69 simgrid::surf::on_link.disconnect_all_slots();
70 simgrid::surf::on_cluster.disconnect_all_slots();
71 simgrid::surf::on_postparse.disconnect_all_slots();
73 /* make sure that we will reinit the models while loading the platf once reinited */
74 surf_parse_models_setup_already_called = 0;
75 surf_parse_lex_destroy();
78 /** @brief Add an host to the current AS */
79 void sg_platf_new_host(sg_platf_host_cbarg_t args)
81 simgrid::s4u::Host* host = routing_get_current()->createHost(args->id, &args->speed_per_pstate, args->core_amount);
83 new simgrid::surf::HostImpl(host, mount_list);
84 xbt_lib_set(storage_lib, args->id, ROUTING_STORAGE_HOST_LEVEL, static_cast<void*>(mount_list));
87 if (args->properties) {
88 xbt_dict_cursor_t cursor=nullptr;
90 xbt_dict_foreach (args->properties, cursor, key, data)
91 host->setProperty(key, data);
92 xbt_dict_free(&args->properties);
95 /* Change from the defaults */
96 if (args->state_trace)
97 host->pimpl_cpu->setStateTrace(args->state_trace);
98 if (args->speed_trace)
99 host->pimpl_cpu->setSpeedTrace(args->speed_trace);
100 if (args->pstate != 0)
101 host->pimpl_cpu->setPState(args->pstate);
102 if (args->coord && strcmp(args->coord, ""))
103 new simgrid::kernel::routing::vivaldi::Coords(host->pimpl_netcard, args->coord);
105 simgrid::s4u::Host::onCreation(*host);
107 if (TRACE_is_enabled() && TRACE_needs_platform())
108 sg_instr_new_host(*host);
111 /** @brief Add a "router" to the network element list */
112 void sg_platf_new_router(sg_platf_router_cbarg_t router)
114 simgrid::kernel::routing::NetZoneImpl* current_routing = routing_get_current();
116 if (current_routing->hierarchy_ == simgrid::kernel::routing::NetZoneImpl::RoutingMode::unset)
117 current_routing->hierarchy_ = simgrid::kernel::routing::NetZoneImpl::RoutingMode::base;
118 xbt_assert(nullptr == xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL),
119 "Refusing to create a router named '%s': this name already describes a node.", router->id);
121 simgrid::kernel::routing::NetCard* netcard =
122 new simgrid::kernel::routing::NetCard(router->id, simgrid::kernel::routing::NetCard::Type::Router, current_routing);
123 xbt_lib_set(as_router_lib, router->id, ROUTING_ASR_LEVEL, netcard);
124 XBT_DEBUG("Router '%s' has the id %d", router->id, netcard->id());
126 if (router->coord && strcmp(router->coord, ""))
127 new simgrid::kernel::routing::vivaldi::Coords(netcard, router->coord);
129 auto cluster = dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
130 if(cluster != nullptr)
131 cluster->router_ = static_cast<simgrid::kernel::routing::NetCard*>(xbt_lib_get_or_null(as_router_lib, router->id, ROUTING_ASR_LEVEL));
133 if (TRACE_is_enabled() && TRACE_needs_platform())
134 sg_instr_new_router(router);
137 void sg_platf_new_link(sg_platf_link_cbarg_t link){
138 std::vector<char*> names;
140 if (link->policy == SURF_LINK_FULLDUPLEX) {
141 names.push_back(bprintf("%s_UP", link->id));
142 names.push_back(bprintf("%s_DOWN", link->id));
144 names.push_back(xbt_strdup(link->id));
146 for (auto link_name : names) {
147 Link* l = surf_network_model->createLink(link_name, link->bandwidth, link->latency, link->policy);
149 if (link->properties) {
150 xbt_dict_cursor_t cursor = nullptr;
152 xbt_dict_foreach (link->properties, cursor, key, data)
153 l->setProperty(key, data);
154 xbt_dict_free(&link->properties);
157 if (link->latency_trace)
158 l->setLatencyTrace(link->latency_trace);
159 if (link->bandwidth_trace)
160 l->setBandwidthTrace(link->bandwidth_trace);
161 if (link->state_trace)
162 l->setStateTrace(link->state_trace);
167 simgrid::surf::on_link(link);
170 void sg_platf_new_cluster(sg_platf_cluster_cbarg_t cluster)
172 using simgrid::kernel::routing::ClusterZone;
173 using simgrid::kernel::routing::DragonflyZone;
174 using simgrid::kernel::routing::FatTreeZone;
175 using simgrid::kernel::routing::TorusZone;
179 s_sg_platf_link_cbarg_t link;
181 // What an inventive way of initializing the AS that I have as ancestor :-(
182 s_sg_platf_AS_cbarg_t AS;
184 switch (cluster->topology) {
185 case SURF_CLUSTER_TORUS:
186 AS.routing = A_surfxml_AS_routing_ClusterTorus;
188 case SURF_CLUSTER_DRAGONFLY:
189 AS.routing = A_surfxml_AS_routing_ClusterDragonfly;
191 case SURF_CLUSTER_FAT_TREE:
192 AS.routing = A_surfxml_AS_routing_ClusterFatTree;
195 AS.routing = A_surfxml_AS_routing_Cluster;
198 sg_platf_new_AS_begin(&AS);
199 simgrid::kernel::routing::ClusterZone* current_as = static_cast<ClusterZone*>(routing_get_current());
200 current_as->parse_specific_arguments(cluster);
202 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
203 current_as->linkCountPerNode_++;
204 current_as->hasLoopback_ = 1;
207 if(cluster->limiter_link!=0){
208 current_as->linkCountPerNode_++;
209 current_as->hasLimiter_ = 1;
212 for (int i : *cluster->radicals) {
213 char * host_id = bprintf("%s%d%s", cluster->prefix, i, cluster->suffix);
214 char * link_id = bprintf("%s_link_%d", cluster->id, i);
216 XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id, cluster->speed);
218 s_sg_platf_host_cbarg_t host;
219 memset(&host, 0, sizeof(host));
221 if ((cluster->properties != nullptr) && (!xbt_dict_is_empty(cluster->properties))) {
222 xbt_dict_cursor_t cursor=nullptr;
224 host.properties = xbt_dict_new_homogeneous(free);
226 xbt_dict_foreach(cluster->properties,cursor,key,data) {
227 xbt_dict_set(host.properties, key, xbt_strdup(data), nullptr);
231 host.speed_per_pstate.push_back(cluster->speed);
233 host.core_amount = cluster->core_amount;
235 sg_platf_new_host(&host);
236 XBT_DEBUG("</host>");
238 XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id, cluster->bw, cluster->lat);
240 // All links are saved in a matrix;
241 // every row describes a single node; every node may have multiple links.
242 // the first column may store a link from x to x if p_has_loopback is set
243 // the second column may store a limiter link if p_has_limiter is set
244 // other columns are to store one or more link for the node
246 //add a loopback link
247 Link* linkUp = nullptr;
248 Link* linkDown = nullptr;
249 if(cluster->loopback_bw!=0 || cluster->loopback_lat!=0){
250 char *tmp_link = bprintf("%s_loopback", link_id);
251 XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link, cluster->loopback_bw);
253 memset(&link, 0, sizeof(link));
255 link.bandwidth = cluster->loopback_bw;
256 link.latency = cluster->loopback_lat;
257 link.policy = SURF_LINK_FATPIPE;
258 sg_platf_new_link(&link);
259 linkUp = Link::byName(tmp_link);
260 linkDown = Link::byName(tmp_link);
263 auto as_cluster = static_cast<ClusterZone*>(current_as);
264 as_cluster->privateLinks_.insert({rankId * as_cluster->linkCountPerNode_, {linkUp, linkDown}});
267 //add a limiter link (shared link to account for maximal bandwidth of the node)
270 if(cluster->limiter_link!=0){
271 char *tmp_link = bprintf("%s_limiter", link_id);
272 XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link, cluster->limiter_link);
274 memset(&link, 0, sizeof(link));
276 link.bandwidth = cluster->limiter_link;
278 link.policy = SURF_LINK_SHARED;
279 sg_platf_new_link(&link);
280 linkUp = linkDown = Link::byName(tmp_link);
282 current_as->privateLinks_.insert(
283 {rankId * current_as->linkCountPerNode_ + current_as->hasLoopback_, {linkUp, linkDown}});
286 //call the cluster function that adds the others links
287 if (cluster->topology == SURF_CLUSTER_FAT_TREE) {
288 static_cast<FatTreeZone*>(current_as)->addProcessingNode(i);
291 current_as->create_links_for_node(cluster, i, rankId,
292 rankId*current_as->linkCountPerNode_ + current_as->hasLoopback_ + current_as->hasLimiter_ );
299 // Add a router. It is magically used thanks to the way in which surf_routing_cluster is written,
300 // and it's very useful to connect clusters together
302 XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
303 char *newid = nullptr;
304 s_sg_platf_router_cbarg_t router;
305 memset(&router, 0, sizeof(router));
306 router.id = cluster->router_id;
307 if (!router.id || !strcmp(router.id, ""))
308 router.id = newid = bprintf("%s%s_router%s", cluster->prefix, cluster->id, cluster->suffix);
309 sg_platf_new_router(&router);
310 current_as->router_ = (simgrid::kernel::routing::NetCard*) xbt_lib_get_or_null(as_router_lib, router.id, ROUTING_ASR_LEVEL);
314 if ((cluster->bb_bw != 0) || (cluster->bb_lat != 0)) {
316 memset(&link, 0, sizeof(link));
317 link.id = bprintf("%s_backbone", cluster->id);
318 link.bandwidth = cluster->bb_bw;
319 link.latency = cluster->bb_lat;
320 link.policy = cluster->bb_sharing_policy;
322 XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link.id, cluster->bb_bw, cluster->bb_lat);
323 sg_platf_new_link(&link);
325 routing_cluster_add_backbone(Link::byName(link.id));
326 free((char*)link.id);
330 sg_platf_new_AS_seal();
332 simgrid::surf::on_cluster(cluster);
333 delete cluster->radicals;
335 void routing_cluster_add_backbone(simgrid::surf::Link* bb) {
336 simgrid::kernel::routing::ClusterZone* cluster =
337 dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
339 xbt_assert(cluster, "Only hosts from Cluster can get a backbone.");
340 xbt_assert(nullptr == cluster->backbone_, "Cluster %s already has a backbone link!", cluster->name());
342 cluster->backbone_ = bb;
343 XBT_DEBUG("Add a backbone to AS '%s'", current_routing->name());
346 void sg_platf_new_cabinet(sg_platf_cabinet_cbarg_t cabinet)
348 for (int radical : *cabinet->radicals) {
349 char *hostname = bprintf("%s%d%s", cabinet->prefix, radical, cabinet->suffix);
350 s_sg_platf_host_cbarg_t host;
351 memset(&host, 0, sizeof(host));
353 host.core_amount = 1;
355 host.speed_per_pstate.push_back(cabinet->speed);
356 sg_platf_new_host(&host);
358 s_sg_platf_link_cbarg_t link;
359 memset(&link, 0, sizeof(link));
360 link.policy = SURF_LINK_FULLDUPLEX;
361 link.latency = cabinet->lat;
362 link.bandwidth = cabinet->bw;
363 link.id = bprintf("link_%s",hostname);
364 sg_platf_new_link(&link);
365 free((char*)link.id);
367 s_sg_platf_host_link_cbarg_t host_link;
368 memset(&host_link, 0, sizeof(host_link));
369 host_link.id = hostname;
370 host_link.link_up = bprintf("link_%s_UP",hostname);
371 host_link.link_down = bprintf("link_%s_DOWN",hostname);
372 sg_platf_new_hostlink(&host_link);
373 free((char*)host_link.link_up);
374 free((char*)host_link.link_down);
378 delete cabinet->radicals;
381 void sg_platf_new_storage(sg_platf_storage_cbarg_t storage)
383 xbt_assert(!xbt_lib_get_or_null(storage_lib, storage->id,ROUTING_STORAGE_LEVEL),
384 "Refusing to add a second storage named \"%s\"", storage->id);
386 void* stype = xbt_lib_get_or_null(storage_type_lib, storage->type_id,ROUTING_STORAGE_TYPE_LEVEL);
387 xbt_assert(stype,"No storage type '%s'", storage->type_id);
389 XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'",
394 xbt_lib_set(storage_lib, storage->id, ROUTING_STORAGE_LEVEL, (void *) xbt_strdup(storage->type_id));
396 // if storage content is not specified use the content of storage_type if any
397 if(!strcmp(storage->content,"") && strcmp(((storage_type_t) stype)->content,"")){
398 storage->content = ((storage_type_t) stype)->content;
399 storage->content_type = ((storage_type_t) stype)->content_type;
400 XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s) from storage type '%s' ",
401 storage->id,((storage_type_t) stype)->content_type,
402 ((storage_type_t) stype)->type_id);
405 XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
406 "\n\t\tmodel '%s' \n\t\tcontent '%s'\n\t\tcontent_type '%s' "
407 "\n\t\tproperties '%p''\n",
409 ((storage_type_t) stype)->model,
410 ((storage_type_t) stype)->type_id,
412 storage->content_type,
413 storage->properties);
415 auto s = surf_storage_model->createStorage(storage->id, ((storage_type_t)stype)->type_id, storage->content,
416 storage->content_type, storage->attach);
418 if (storage->properties) {
419 xbt_dict_cursor_t cursor = nullptr;
421 xbt_dict_foreach (storage->properties, cursor, key, data)
422 s->setProperty(key, data);
423 xbt_dict_free(&storage->properties);
426 void sg_platf_new_storage_type(sg_platf_storage_type_cbarg_t storage_type){
428 xbt_assert(!xbt_lib_get_or_null(storage_type_lib, storage_type->id,ROUTING_STORAGE_TYPE_LEVEL),
429 "Reading a storage type, processing unit \"%s\" already exists", storage_type->id);
431 storage_type_t stype = xbt_new0(s_storage_type_t, 1);
432 stype->model = xbt_strdup(storage_type->model);
433 stype->properties = storage_type->properties;
434 stype->content = xbt_strdup(storage_type->content);
435 stype->content_type = xbt_strdup(storage_type->content_type);
436 stype->type_id = xbt_strdup(storage_type->id);
437 stype->size = storage_type->size;
438 stype->model_properties = storage_type->model_properties;
440 XBT_DEBUG("ROUTING Create a storage type id '%s' with model '%s', "
441 "content '%s', and content_type '%s'",
444 storage_type->content,
445 storage_type->content_type);
447 xbt_lib_set(storage_type_lib,
449 ROUTING_STORAGE_TYPE_LEVEL,
453 static void mount_free(void *p)
455 mount_t mnt = (mount_t) p;
459 void sg_platf_new_mount(sg_platf_mount_cbarg_t mount){
460 xbt_assert(xbt_lib_get_or_null(storage_lib, mount->storageId, ROUTING_STORAGE_LEVEL),
461 "Cannot mount non-existent disk \"%s\"", mount->storageId);
463 XBT_DEBUG("ROUTING Mount '%s' on '%s'",mount->storageId, mount->name);
466 mnt.storage = surf_storage_resource_priv(surf_storage_resource_by_name(mount->storageId));
467 mnt.name = xbt_strdup(mount->name);
470 XBT_DEBUG("Create a Mount list for %s",A_surfxml_host_id);
471 mount_list = xbt_dynar_new(sizeof(s_mount_t), mount_free);
473 xbt_dynar_push(mount_list, &mnt);
476 void sg_platf_new_route(sg_platf_route_cbarg_t route)
478 routing_get_current()->addRoute(route);
481 void sg_platf_new_bypassRoute(sg_platf_route_cbarg_t bypassRoute)
483 routing_get_current()->addBypassRoute(bypassRoute);
486 void sg_platf_new_process(sg_platf_process_cbarg_t process)
488 sg_host_t host = sg_host_by_name(process->host);
490 // The requested host does not exist. Do a nice message to the user
491 char *tmp = bprintf("Cannot create process '%s': host '%s' does not exist\nExisting hosts: '",process->function, process->host);
492 xbt_strbuff_t msg = xbt_strbuff_new_from(tmp);
494 xbt_dynar_t all_hosts = xbt_dynar_sort_strings(sg_hosts_as_dynar());
495 simgrid::s4u::Host* host;
497 xbt_dynar_foreach(all_hosts,cursor, host) {
498 xbt_strbuff_append(msg, host->cname());
499 xbt_strbuff_append(msg,"', '");
500 if (msg->used > 1024) {
501 msg->data[msg->used-3]='\0';
504 xbt_strbuff_append(msg," ...(list truncated)......");// That will be shortened by 3 chars when existing the loop
508 msg->data[msg->used-3]='\0';
509 xbt_die("%s", msg->data);
511 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(process->function);
512 xbt_assert(factory, "Function '%s' unknown", process->function);
514 double start_time = process->start_time;
515 double kill_time = process->kill_time;
516 int auto_restart = process->on_failure == SURF_PROCESS_ON_FAILURE_DIE ? 0 : 1;
518 std::vector<std::string> args(process->argv, process->argv + process->argc);
519 std::function<void()> code = factory(std::move(args));
521 smx_process_arg_t arg = nullptr;
522 smx_actor_t process_created = nullptr;
524 arg = new simgrid::simix::ProcessArg();
525 arg->name = std::string(process->argv[0]);
529 arg->kill_time = kill_time;
530 arg->properties = current_property_set;
532 sg_host_simix(host)->boot_processes.push_back(arg);
534 if (start_time > SIMIX_get_clock()) {
536 arg = new simgrid::simix::ProcessArg();
537 arg->name = std::string(process->argv[0]);
538 arg->code = std::move(code);
541 arg->kill_time = kill_time;
542 arg->properties = current_property_set;
544 XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->cname(), start_time);
545 SIMIX_timer_set(start_time, [=]() {
546 simix_global->create_process_function(
548 std::move(arg->code),
557 } else { // start_time <= SIMIX_get_clock()
558 XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->cname());
560 process_created = simix_global->create_process_function(
561 arg->name.c_str(), std::move(code), nullptr,
563 current_property_set, auto_restart, nullptr);
565 /* verify if process has been created (won't be the case if the host is currently dead, but that's fine) */
566 if (!process_created) {
570 current_property_set = nullptr;
573 void sg_platf_new_peer(sg_platf_peer_cbarg_t peer)
575 simgrid::kernel::routing::VivaldiZone* as = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
576 xbt_assert(as, "<peer> tag can only be used in Vivaldi ASes");
578 std::vector<double> speedPerPstate;
579 speedPerPstate.push_back(peer->speed);
580 simgrid::s4u::Host* host = as->createHost(peer->id, &speedPerPstate, 1);
582 as->setPeerLink(host->pimpl_netcard, peer->bw_in, peer->bw_out, peer->lat, peer->coord);
583 simgrid::s4u::Host::onCreation(*host);
585 /* Change from the defaults */
586 if (peer->state_trace)
587 host->pimpl_cpu->setStateTrace(peer->state_trace);
588 if (peer->speed_trace)
589 host->pimpl_cpu->setSpeedTrace(peer->speed_trace);
592 void sg_platf_begin() { /* Do nothing: just for symmetry of user code */ }
594 void sg_platf_end() {
595 simgrid::surf::on_postparse();
598 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
599 static void surf_config_models_setup()
601 const char* host_model_name = xbt_cfg_get_string("host/model");
602 const char* network_model_name = xbt_cfg_get_string("network/model");
603 const char* cpu_model_name = xbt_cfg_get_string("cpu/model");
604 const char* storage_model_name = xbt_cfg_get_string("storage/model");
606 /* The compound host model is needed when using non-default net/cpu models */
607 if ((!xbt_cfg_is_default_value("network/model") || !xbt_cfg_is_default_value("cpu/model")) &&
608 xbt_cfg_is_default_value("host/model")) {
609 host_model_name = "compound";
610 xbt_cfg_set_string("host/model", host_model_name);
613 XBT_DEBUG("host model: %s", host_model_name);
614 if (!strcmp(host_model_name, "compound")) {
615 xbt_assert(cpu_model_name, "Set a cpu model to use with the 'compound' host model");
616 xbt_assert(network_model_name, "Set a network model to use with the 'compound' host model");
618 int cpu_id = find_model_description(surf_cpu_model_description, cpu_model_name);
619 surf_cpu_model_description[cpu_id].model_init_preparse();
621 int network_id = find_model_description(surf_network_model_description, network_model_name);
622 surf_network_model_description[network_id].model_init_preparse();
625 XBT_DEBUG("Call host_model_init");
626 int host_id = find_model_description(surf_host_model_description, host_model_name);
627 surf_host_model_description[host_id].model_init_preparse();
629 XBT_DEBUG("Call vm_model_init");
630 surf_vm_model_init_HL13();
632 XBT_DEBUG("Call storage_model_init");
633 int storage_id = find_model_description(surf_storage_model_description, storage_model_name);
634 surf_storage_model_description[storage_id].model_init_preparse();
638 * \brief Add an AS to the platform
640 * Add a new autonomous system to the platform. Any elements (such as host,
641 * router or sub-AS) added after this call and before the corresponding call
642 * to sg_platf_new_AS_seal() will be added to this AS.
644 * Once this function was called, the configuration concerning the used
645 * models cannot be changed anymore.
647 * @param AS the parameters defining the AS to build.
649 simgrid::s4u::NetZone* sg_platf_new_AS_begin(sg_platf_AS_cbarg_t AS)
651 if (!surf_parse_models_setup_already_called) {
652 /* Initialize the surf models. That must be done after we got all config, and before we need the models.
653 * That is, after the last <config> tag, if any, and before the first of cluster|peer|AS|trace|trace_connect
655 * I'm not sure for <trace> and <trace_connect>, there may be a bug here
656 * (FIXME: check it out by creating a file beginning with one of these tags)
657 * but cluster and peer create ASes internally, so putting the code in there is ok.
659 surf_parse_models_setup_already_called = 1;
660 surf_config_models_setup();
663 _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
664 * any further config now that we created some real content */
667 /* search the routing model */
668 simgrid::kernel::routing::NetZoneImpl* new_as = nullptr;
670 case A_surfxml_AS_routing_Cluster:
671 new_as = new simgrid::kernel::routing::ClusterZone(current_routing, AS->id);
673 case A_surfxml_AS_routing_ClusterDragonfly:
674 new_as = new simgrid::kernel::routing::DragonflyZone(current_routing, AS->id);
676 case A_surfxml_AS_routing_ClusterTorus:
677 new_as = new simgrid::kernel::routing::TorusZone(current_routing, AS->id);
679 case A_surfxml_AS_routing_ClusterFatTree:
680 new_as = new simgrid::kernel::routing::FatTreeZone(current_routing, AS->id);
682 case A_surfxml_AS_routing_Dijkstra:
683 new_as = new simgrid::kernel::routing::DijkstraZone(current_routing, AS->id, 0);
685 case A_surfxml_AS_routing_DijkstraCache:
686 new_as = new simgrid::kernel::routing::DijkstraZone(current_routing, AS->id, 1);
688 case A_surfxml_AS_routing_Floyd:
689 new_as = new simgrid::kernel::routing::FloydZone(current_routing, AS->id);
691 case A_surfxml_AS_routing_Full:
692 new_as = new simgrid::kernel::routing::FullZone(current_routing, AS->id);
694 case A_surfxml_AS_routing_None:
695 new_as = new simgrid::kernel::routing::EmptyZone(current_routing, AS->id);
697 case A_surfxml_AS_routing_Vivaldi:
698 new_as = new simgrid::kernel::routing::VivaldiZone(current_routing, AS->id);
701 xbt_die("Not a valid model!");
705 if (current_routing == nullptr) { /* it is the first one */
706 xbt_assert(simgrid::s4u::Engine::instance()->pimpl->rootAs_ == nullptr,
707 "All defined components must belong to a AS");
708 simgrid::s4u::Engine::instance()->pimpl->rootAs_ = new_as;
711 /* set the father behavior */
712 if (current_routing->hierarchy_ == simgrid::kernel::routing::NetZoneImpl::RoutingMode::unset)
713 current_routing->hierarchy_ = simgrid::kernel::routing::NetZoneImpl::RoutingMode::recursive;
714 /* add to the sons dictionary */
715 xbt_dict_set(current_routing->children(), AS->id, (void *) new_as, nullptr);
718 /* set the new current component of the tree */
719 current_routing = new_as;
721 if (TRACE_is_enabled())
722 sg_instr_AS_begin(AS);
728 * \brief Specify that the description of the current AS is finished
730 * Once you've declared all the content of your AS, you have to seal
731 * it with this call. Your AS is not usable until you call this function.
733 void sg_platf_new_AS_seal()
735 xbt_assert(current_routing, "Cannot seal the current AS: none under construction");
736 current_routing->seal();
737 current_routing = static_cast<simgrid::kernel::routing::NetZoneImpl*>(current_routing->father());
739 if (TRACE_is_enabled())
743 /** @brief Add a link connecting an host to the rest of its AS (which must be cluster or vivaldi) */
744 void sg_platf_new_hostlink(sg_platf_host_link_cbarg_t hostlink)
746 simgrid::kernel::routing::NetCard *netcard = sg_host_by_name(hostlink->id)->pimpl_netcard;
747 xbt_assert(netcard, "Host '%s' not found!", hostlink->id);
748 xbt_assert(dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing),
749 "Only hosts from Cluster and Vivaldi ASes can get an host_link.");
751 simgrid::surf::Link* linkUp = Link::byName(hostlink->link_up);
752 simgrid::surf::Link* linkDown = Link::byName(hostlink->link_down);
754 xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up);
755 xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down);
757 auto as_cluster = static_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
759 if (as_cluster->privateLinks_.find(netcard->id()) != as_cluster->privateLinks_.end())
760 surf_parse_error("Host_link for '%s' is already defined!",hostlink->id);
762 XBT_DEBUG("Push Host_link for host '%s' to position %d", netcard->cname(), netcard->id());
763 as_cluster->privateLinks_.insert({netcard->id(), {linkUp, linkDown}});
766 void sg_platf_new_trace(sg_platf_trace_cbarg_t trace)
768 tmgr_trace_t tmgr_trace;
769 if (trace->file && strcmp(trace->file, "") != 0) {
770 tmgr_trace = tmgr_trace_new_from_file(trace->file);
772 xbt_assert(strcmp(trace->pc_data, ""),
773 "Trace '%s' must have either a content, or point to a file on disk.",trace->id);
774 tmgr_trace = tmgr_trace_new_from_string(trace->id, trace->pc_data, trace->periodicity);
776 xbt_dict_set(traces_set_list, trace->id, static_cast<void*>(tmgr_trace), nullptr);