Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
codacy and clang-format
[simgrid.git] / src / surf / sg_platf.cpp
1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "simgrid/s4u/Engine.hpp"
7 #include "simgrid/s4u/Storage.hpp"
8
9 #include "src/kernel/EngineImpl.hpp"
10 #include "src/simix/smx_private.h"
11
12 #include "src/include/simgrid/sg_config.h"
13
14 #include "src/surf/HostImpl.hpp"
15 #include "src/surf/cpu_interface.hpp"
16 #include "src/surf/network_interface.hpp"
17
18 #include "src/kernel/routing/ClusterZone.hpp"
19 #include "src/kernel/routing/DijkstraZone.hpp"
20 #include "src/kernel/routing/DragonflyZone.hpp"
21 #include "src/kernel/routing/EmptyZone.hpp"
22 #include "src/kernel/routing/FatTreeZone.hpp"
23 #include "src/kernel/routing/FloydZone.hpp"
24 #include "src/kernel/routing/FullZone.hpp"
25 #include "src/kernel/routing/NetPoint.hpp"
26 #include "src/kernel/routing/NetZoneImpl.hpp"
27 #include "src/kernel/routing/TorusZone.hpp"
28 #include "src/kernel/routing/VivaldiZone.hpp"
29 #include <string>
30 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(surf_parse);
31
32 XBT_PRIVATE std::map<std::string, simgrid::surf::StorageImpl*> mount_list;
33 XBT_PRIVATE std::vector<std::string> known_storages;
34
35 namespace simgrid {
36 namespace surf {
37
38 simgrid::xbt::signal<void(sg_platf_cluster_cbarg_t)> on_cluster;
39
40 }
41 }
42
43 // FIXME: The following duplicates the content of s4u::Host
44 namespace simgrid {
45 namespace s4u {
46 extern std::map<std::string, simgrid::s4u::Host*> host_list;
47 }
48 }
49
50 static int surf_parse_models_setup_already_called = 0;
51 std::map<std::string, simgrid::surf::StorageType*> storage_types;
52
53 /** The current AS in the parsing */
54 static simgrid::kernel::routing::NetZoneImpl* current_routing = nullptr;
55 static simgrid::kernel::routing::NetZoneImpl* routing_get_current()
56 {
57   return current_routing;
58 }
59
60 /** Module management function: creates all internal data structures */
61 void sg_platf_init()
62 { /* Do nothing: just for symmetry of user code */
63 }
64
65 /** Module management function: frees all internal data structures */
66 void sg_platf_exit() {
67   simgrid::surf::on_cluster.disconnect_all_slots();
68   simgrid::s4u::onPlatformCreated.disconnect_all_slots();
69
70   /* make sure that we will reinit the models while loading the platf once reinited */
71   surf_parse_models_setup_already_called = 0;
72   surf_parse_lex_destroy();
73 }
74
75 /** @brief Add an host to the current AS */
76 void sg_platf_new_host(sg_platf_host_cbarg_t args)
77 {
78   std::map<std::string, std::string> props;
79   if (args->properties) {
80     for (auto elm : *args->properties)
81       props.insert({elm.first, elm.second});
82     delete args->properties;
83   }
84
85   simgrid::s4u::Host* host =
86       routing_get_current()->createHost(args->id, &args->speed_per_pstate, args->core_amount, &props);
87
88   host->pimpl_->storage_ = mount_list;
89   mount_list.clear();
90
91   /* Change from the defaults */
92   if (args->state_trace)
93     host->pimpl_cpu->setStateTrace(args->state_trace);
94   if (args->speed_trace)
95     host->pimpl_cpu->setSpeedTrace(args->speed_trace);
96   if (args->pstate != 0)
97     host->pimpl_cpu->setPState(args->pstate);
98   if (args->coord && strcmp(args->coord, ""))
99     new simgrid::kernel::routing::vivaldi::Coords(host->pimpl_netpoint, args->coord);
100 }
101
102 /** @brief Add a "router" to the network element list */
103 simgrid::kernel::routing::NetPoint* sg_platf_new_router(const char* name, const char* coords)
104 {
105   simgrid::kernel::routing::NetZoneImpl* current_routing = routing_get_current();
106
107   if (current_routing->hierarchy_ == simgrid::kernel::routing::NetZoneImpl::RoutingMode::unset)
108     current_routing->hierarchy_ = simgrid::kernel::routing::NetZoneImpl::RoutingMode::base;
109   xbt_assert(nullptr == simgrid::s4u::Engine::getInstance()->getNetpointByNameOrNull(name),
110              "Refusing to create a router named '%s': this name already describes a node.", name);
111
112   simgrid::kernel::routing::NetPoint* netpoint =
113       new simgrid::kernel::routing::NetPoint(name, simgrid::kernel::routing::NetPoint::Type::Router, current_routing);
114   XBT_DEBUG("Router '%s' has the id %u", name, netpoint->id());
115
116   if (coords && strcmp(coords, ""))
117     new simgrid::kernel::routing::vivaldi::Coords(netpoint, coords);
118
119
120   return netpoint;
121 }
122
123 void sg_platf_new_link(LinkCreationArgs* link)
124 {
125   std::vector<std::string> names;
126
127   if (link->policy == SURF_LINK_FULLDUPLEX) {
128     names.push_back(link->id+ "_UP");
129     names.push_back(link->id+ "_DOWN");
130   } else {
131     names.push_back(link->id);
132   }
133   for (auto link_name : names) {
134     simgrid::surf::LinkImpl* l =
135         surf_network_model->createLink(link_name.c_str(), link->bandwidth, link->latency, link->policy);
136
137     if (link->properties) {
138       for (auto elm : *link->properties)
139         l->setProperty(elm.first, elm.second);
140       delete link->properties;
141     }
142
143     if (link->latency_trace)
144       l->setLatencyTrace(link->latency_trace);
145     if (link->bandwidth_trace)
146       l->setBandwidthTrace(link->bandwidth_trace);
147     if (link->state_trace)
148       l->setStateTrace(link->state_trace);
149   }
150 }
151
152 void sg_platf_new_cluster(sg_platf_cluster_cbarg_t cluster)
153 {
154   using simgrid::kernel::routing::ClusterZone;
155   using simgrid::kernel::routing::DragonflyZone;
156   using simgrid::kernel::routing::FatTreeZone;
157   using simgrid::kernel::routing::TorusZone;
158
159   int rankId=0;
160
161   // What an inventive way of initializing the AS that I have as ancestor :-(
162   ZoneCreationArgs zone;
163   zone.id = cluster->id;
164   switch (cluster->topology) {
165   case SURF_CLUSTER_TORUS:
166     zone.routing = A_surfxml_AS_routing_ClusterTorus;
167     break;
168   case SURF_CLUSTER_DRAGONFLY:
169     zone.routing = A_surfxml_AS_routing_ClusterDragonfly;
170     break;
171   case SURF_CLUSTER_FAT_TREE:
172     zone.routing = A_surfxml_AS_routing_ClusterFatTree;
173     break;
174   default:
175     zone.routing = A_surfxml_AS_routing_Cluster;
176     break;
177   }
178   sg_platf_new_Zone_begin(&zone);
179   simgrid::kernel::routing::ClusterZone* current_as = static_cast<ClusterZone*>(routing_get_current());
180   current_as->parse_specific_arguments(cluster);
181
182   if(cluster->loopback_bw > 0 || cluster->loopback_lat > 0){
183     current_as->linkCountPerNode_++;
184     current_as->hasLoopback_ = 1;
185   }
186
187   if(cluster->limiter_link > 0){
188     current_as->linkCountPerNode_++;
189     current_as->hasLimiter_ = 1;
190   }
191
192   for (int i : *cluster->radicals) {
193     std::string host_id = std::string(cluster->prefix) + std::to_string(i) + cluster->suffix;
194     std::string link_id = std::string(cluster->id) + "_link_" + std::to_string(i);
195
196     XBT_DEBUG("<host\tid=\"%s\"\tpower=\"%f\">", host_id.c_str(), cluster->speeds.front());
197
198     s_sg_platf_host_cbarg_t host;
199     memset(&host, 0, sizeof(host));
200     host.id = host_id.c_str();
201     if ((cluster->properties != nullptr) && (not cluster->properties->empty())) {
202       host.properties = new std::map<std::string, std::string>;
203
204       for (auto elm : *cluster->properties)
205         host.properties->insert({elm.first, elm.second});
206     }
207
208     host.speed_per_pstate = cluster->speeds;
209     host.pstate = 0;
210     host.core_amount = cluster->core_amount;
211     host.coord = "";
212     sg_platf_new_host(&host);
213     XBT_DEBUG("</host>");
214
215     XBT_DEBUG("<link\tid=\"%s\"\tbw=\"%f\"\tlat=\"%f\"/>", link_id.c_str(), cluster->bw, cluster->lat);
216
217     // All links are saved in a matrix;
218     // every row describes a single node; every node may have multiple links.
219     // the first column may store a link from x to x if p_has_loopback is set
220     // the second column may store a limiter link if p_has_limiter is set
221     // other columns are to store one or more link for the node
222
223     //add a loopback link
224     simgrid::surf::LinkImpl* linkUp   = nullptr;
225     simgrid::surf::LinkImpl* linkDown = nullptr;
226     if(cluster->loopback_bw > 0 || cluster->loopback_lat > 0){
227       std::string tmp_link = link_id + "_loopback";
228       XBT_DEBUG("<loopback\tid=\"%s\"\tbw=\"%f\"/>", tmp_link.c_str(), cluster->loopback_bw);
229
230       LinkCreationArgs link;
231       link.id        = tmp_link;
232       link.bandwidth = cluster->loopback_bw;
233       link.latency   = cluster->loopback_lat;
234       link.policy    = SURF_LINK_FATPIPE;
235       sg_platf_new_link(&link);
236       linkUp   = simgrid::surf::LinkImpl::byName(tmp_link);
237       linkDown = simgrid::surf::LinkImpl::byName(tmp_link);
238
239       auto as_cluster = static_cast<ClusterZone*>(current_as);
240       as_cluster->privateLinks_.insert({rankId * as_cluster->linkCountPerNode_, {linkUp, linkDown}});
241     }
242
243     //add a limiter link (shared link to account for maximal bandwidth of the node)
244     linkUp   = nullptr;
245     linkDown = nullptr;
246     if(cluster->limiter_link > 0){
247       std::string tmp_link = std::string(link_id) + "_limiter";
248       XBT_DEBUG("<limiter\tid=\"%s\"\tbw=\"%f\"/>", tmp_link.c_str(), cluster->limiter_link);
249
250       LinkCreationArgs link;
251       link.id        = tmp_link;
252       link.bandwidth = cluster->limiter_link;
253       link.latency = 0;
254       link.policy = SURF_LINK_SHARED;
255       sg_platf_new_link(&link);
256       linkDown = simgrid::surf::LinkImpl::byName(tmp_link);
257       linkUp   = linkDown;
258       current_as->privateLinks_.insert(
259           {rankId * current_as->linkCountPerNode_ + current_as->hasLoopback_, {linkUp, linkDown}});
260     }
261
262     //call the cluster function that adds the others links
263     if (cluster->topology == SURF_CLUSTER_FAT_TREE) {
264       static_cast<FatTreeZone*>(current_as)->addProcessingNode(i);
265     } else {
266       current_as->create_links_for_node(cluster, i, rankId,
267           rankId*current_as->linkCountPerNode_ + current_as->hasLoopback_ + current_as->hasLimiter_ );
268     }
269     rankId++;
270   }
271   delete cluster->properties;
272
273   // Add a router.
274   XBT_DEBUG(" ");
275   XBT_DEBUG("<router id=\"%s\"/>", cluster->router_id);
276   if (not cluster->router_id || not strcmp(cluster->router_id, "")) {
277     std::string newid   = std::string(cluster->prefix) + cluster->id + "_router" + cluster->suffix;
278     current_as->router_ = sg_platf_new_router(newid.c_str(), NULL);
279   } else {
280     current_as->router_ = sg_platf_new_router(cluster->router_id, NULL);
281   }
282
283   //Make the backbone
284   if ((cluster->bb_bw > 0) || (cluster->bb_lat > 0)) {
285
286     LinkCreationArgs link;
287     link.id        = std::string(cluster->id)+ "_backbone";
288     link.bandwidth = cluster->bb_bw;
289     link.latency   = cluster->bb_lat;
290     link.policy    = cluster->bb_sharing_policy;
291
292     XBT_DEBUG("<link\tid=\"%s\" bw=\"%f\" lat=\"%f\"/>", link.id.c_str(), cluster->bb_bw, cluster->bb_lat);
293     sg_platf_new_link(&link);
294
295     routing_cluster_add_backbone(simgrid::surf::LinkImpl::byName(link.id));
296   }
297
298   XBT_DEBUG("</AS>");
299   sg_platf_new_Zone_seal();
300
301   simgrid::surf::on_cluster(cluster);
302   delete cluster->radicals;
303 }
304
305 void routing_cluster_add_backbone(simgrid::surf::LinkImpl* bb)
306 {
307   simgrid::kernel::routing::ClusterZone* cluster =
308       dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
309
310   xbt_assert(cluster, "Only hosts from Cluster can get a backbone.");
311   xbt_assert(nullptr == cluster->backbone_, "Cluster %s already has a backbone link!", cluster->getCname());
312
313   cluster->backbone_ = bb;
314   XBT_DEBUG("Add a backbone to AS '%s'", current_routing->getCname());
315 }
316
317 void sg_platf_new_cabinet(CabinetCreationArgs* cabinet)
318 {
319   for (int radical : *cabinet->radicals) {
320     std::string hostname = cabinet->prefix + std::to_string(radical) + cabinet->suffix;
321     s_sg_platf_host_cbarg_t host;
322     memset(&host, 0, sizeof(host));
323     host.pstate           = 0;
324     host.core_amount      = 1;
325     host.id               = hostname.c_str();
326     host.speed_per_pstate.push_back(cabinet->speed);
327     sg_platf_new_host(&host);
328
329     LinkCreationArgs link;
330     link.policy    = SURF_LINK_FULLDUPLEX;
331     link.latency   = cabinet->lat;
332     link.bandwidth = cabinet->bw;
333     link.id        = "link_" + hostname;
334     sg_platf_new_link(&link);
335
336     s_sg_platf_host_link_cbarg_t host_link;
337     memset(&host_link, 0, sizeof(host_link));
338     std::string tmp_link_up   = std::string("link_") + hostname + "_UP";
339     std::string tmp_link_down = std::string("link_") + hostname + "_DOWN";
340     host_link.id        = hostname.c_str();
341     host_link.link_up         = tmp_link_up.c_str();
342     host_link.link_down       = tmp_link_down.c_str();
343     sg_platf_new_hostlink(&host_link);
344   }
345   delete cabinet->radicals;
346 }
347
348 void sg_platf_new_storage(StorageCreationArgs* storage)
349 {
350   xbt_assert(std::find(known_storages.begin(), known_storages.end(), storage->id) == known_storages.end(),
351              "Refusing to add a second storage named \"%s\"", storage->id.c_str());
352
353   simgrid::surf::StorageType* stype;
354   auto st = storage_types.find(storage->type_id);
355   if (st != storage_types.end()) {
356     stype = st->second;
357   } else {
358     xbt_die("No storage type '%s'", storage->type_id.c_str());
359   }
360
361   XBT_DEBUG("ROUTING Create a storage name '%s' with type_id '%s' and content '%s'", storage->id.c_str(),
362             storage->type_id.c_str(), storage->content.c_str());
363
364   known_storages.push_back(storage->id);
365
366   // if storage content is not specified use the content of storage_type if any
367   if (storage->content.empty() && not stype->content.empty()) {
368     storage->content = stype->content;
369     XBT_DEBUG("For disk '%s' content is empty, inherit the content (of type %s)", storage->id.c_str(),
370               stype->id.c_str());
371   }
372
373   XBT_DEBUG("SURF storage create resource\n\t\tid '%s'\n\t\ttype '%s' "
374             "\n\t\tmodel '%s' \n\t\tcontent '%s' "
375             "\n\t\tproperties '%p''\n",
376             storage->id.c_str(), stype->model.c_str(), stype->id.c_str(), storage->content.c_str(),
377             storage->properties);
378
379   auto s = surf_storage_model->createStorage(storage->id, stype->id, storage->content, storage->attach);
380
381   if (storage->properties) {
382     for (auto elm : *storage->properties)
383       s->setProperty(elm.first, elm.second);
384     delete storage->properties;
385   }
386 }
387
388 void sg_platf_new_storage_type(StorageTypeCreationArgs* storage_type)
389 {
390   xbt_assert(storage_types.find(storage_type->id) == storage_types.end(),
391              "Reading a storage type, processing unit \"%s\" already exists", storage_type->id.c_str());
392
393   simgrid::surf::StorageType* stype =
394       new simgrid::surf::StorageType(storage_type->id, storage_type->model, storage_type->content,
395                                      storage_type->properties, storage_type->model_properties, storage_type->size);
396
397   XBT_DEBUG("Create a storage type id '%s' with model '%s', content '%s'", storage_type->id.c_str(),
398             storage_type->model.c_str(), storage_type->content.c_str());
399
400   storage_types[storage_type->id] = stype;
401 }
402
403 void sg_platf_new_mount(MountCreationArgs* mount)
404 {
405   xbt_assert(std::find(known_storages.begin(), known_storages.end(), mount->storageId) != known_storages.end(),
406              "Cannot mount non-existent disk \"%s\"", mount->storageId.c_str());
407
408   XBT_DEBUG("Mount '%s' on '%s'", mount->storageId.c_str(), mount->name.c_str());
409
410   if (mount_list.empty())
411     XBT_DEBUG("Create a Mount list for %s", A_surfxml_host_id);
412   mount_list.insert({mount->name, simgrid::surf::StorageImpl::byName(mount->storageId.c_str())});
413 }
414
415 void sg_platf_new_route(sg_platf_route_cbarg_t route)
416 {
417   routing_get_current()->addRoute(route);
418 }
419
420 void sg_platf_new_bypassRoute(sg_platf_route_cbarg_t bypassRoute)
421 {
422   routing_get_current()->addBypassRoute(bypassRoute);
423 }
424
425 void sg_platf_new_process(sg_platf_process_cbarg_t process)
426 {
427   sg_host_t host = sg_host_by_name(process->host);
428   if (not host) {
429     // The requested host does not exist. Do a nice message to the user
430     std::string msg = std::string("Cannot create process '") + process->function + "': host '" + process->host +
431                       "' does not exist\nExisting hosts: '";
432     for (auto kv : simgrid::s4u::host_list) {
433       simgrid::s4u::Host* host = kv.second;
434       msg += host->getName();
435       msg += "', '";
436       if (msg.length() > 1024) {
437         msg.pop_back(); // remove trailing quote
438         msg += "...(list truncated)......";
439         break;
440       }
441     }
442     xbt_die("%s", msg.c_str());
443   }
444   simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(process->function);
445   xbt_assert(factory, "Function '%s' unknown", process->function);
446
447   double start_time = process->start_time;
448   double kill_time  = process->kill_time;
449   int auto_restart = process->on_failure == SURF_ACTOR_ON_FAILURE_DIE ? 0 : 1;
450
451   std::vector<std::string> args(process->argv, process->argv + process->argc);
452   std::function<void()> code = factory(std::move(args));
453
454   smx_process_arg_t arg = nullptr;
455
456   arg = new simgrid::simix::ProcessArg();
457   arg->name = std::string(process->argv[0]);
458   arg->code = code;
459   arg->data = nullptr;
460   arg->host = host;
461   arg->kill_time = kill_time;
462   arg->properties = process->properties;
463
464   host->extension<simgrid::simix::Host>()->boot_processes.push_back(arg);
465
466   if (start_time > SIMIX_get_clock()) {
467
468     arg = new simgrid::simix::ProcessArg();
469     arg->name = std::string(process->argv[0]);
470     arg->code = std::move(code);
471     arg->data = nullptr;
472     arg->host = host;
473     arg->kill_time = kill_time;
474     arg->properties = process->properties;
475
476     XBT_DEBUG("Process %s@%s will be started at time %f", arg->name.c_str(), arg->host->getCname(), start_time);
477     SIMIX_timer_set(start_time, [arg, auto_restart]() {
478       smx_actor_t actor = simix_global->create_process_function(arg->name.c_str(), std::move(arg->code), arg->data,
479                                                                 arg->host, arg->properties, nullptr);
480       if (arg->kill_time >= 0)
481         simcall_process_set_kill_time(actor, arg->kill_time);
482       if (auto_restart)
483         SIMIX_process_auto_restart_set(actor, auto_restart);
484       delete arg;
485     });
486   } else {                      // start_time <= SIMIX_get_clock()
487     XBT_DEBUG("Starting Process %s(%s) right now", arg->name.c_str(), host->getCname());
488
489     smx_actor_t actor = simix_global->create_process_function(arg->name.c_str(), std::move(code), nullptr, host,
490                                                               arg->properties, nullptr);
491
492     /* The actor creation will fail if the host is currently dead, but that's fine */
493     if (actor != nullptr) {
494       if (arg->kill_time >= 0)
495         simcall_process_set_kill_time(actor, arg->kill_time);
496       if (auto_restart)
497         SIMIX_process_auto_restart_set(actor, auto_restart);
498     }
499   }
500   current_property_set = nullptr;
501 }
502
503 void sg_platf_new_peer(PeerCreationArgs* peer)
504 {
505   simgrid::kernel::routing::VivaldiZone* as = dynamic_cast<simgrid::kernel::routing::VivaldiZone*>(current_routing);
506   xbt_assert(as, "<peer> tag can only be used in Vivaldi netzones.");
507
508   std::vector<double> speedPerPstate;
509   speedPerPstate.push_back(peer->speed);
510   simgrid::s4u::Host* host = as->createHost(peer->id.c_str(), &speedPerPstate, 1, nullptr);
511
512   as->setPeerLink(host->pimpl_netpoint, peer->bw_in, peer->bw_out, peer->coord);
513
514   /* Change from the defaults */
515   if (peer->state_trace)
516     host->pimpl_cpu->setStateTrace(peer->state_trace);
517   if (peer->speed_trace)
518     host->pimpl_cpu->setSpeedTrace(peer->speed_trace);
519 }
520
521 void sg_platf_begin() { /* Do nothing: just for symmetry of user code */ }
522
523 void sg_platf_end() {
524   simgrid::s4u::onPlatformCreated();
525 }
526
527 /* Pick the right models for CPU, net and host, and call their model_init_preparse */
528 static void surf_config_models_setup()
529 {
530   const char* host_model_name    = xbt_cfg_get_string("host/model");
531   const char* network_model_name = xbt_cfg_get_string("network/model");
532   const char* cpu_model_name     = xbt_cfg_get_string("cpu/model");
533   const char* storage_model_name = xbt_cfg_get_string("storage/model");
534
535   /* The compound host model is needed when using non-default net/cpu models */
536   if ((not xbt_cfg_is_default_value("network/model") || not xbt_cfg_is_default_value("cpu/model")) &&
537       xbt_cfg_is_default_value("host/model")) {
538     host_model_name = "compound";
539     xbt_cfg_set_string("host/model", host_model_name);
540   }
541
542   XBT_DEBUG("host model: %s", host_model_name);
543   if (not strcmp(host_model_name, "compound")) {
544     xbt_assert(cpu_model_name, "Set a cpu model to use with the 'compound' host model");
545     xbt_assert(network_model_name, "Set a network model to use with the 'compound' host model");
546
547     int cpu_id = find_model_description(surf_cpu_model_description, cpu_model_name);
548     surf_cpu_model_description[cpu_id].model_init_preparse();
549
550     int network_id = find_model_description(surf_network_model_description, network_model_name);
551     surf_network_model_description[network_id].model_init_preparse();
552   }
553
554   XBT_DEBUG("Call host_model_init");
555   int host_id = find_model_description(surf_host_model_description, host_model_name);
556   surf_host_model_description[host_id].model_init_preparse();
557
558   XBT_DEBUG("Call vm_model_init");
559   surf_vm_model_init_HL13();
560
561   XBT_DEBUG("Call storage_model_init");
562   int storage_id = find_model_description(surf_storage_model_description, storage_model_name);
563   surf_storage_model_description[storage_id].model_init_preparse();
564 }
565
566 /**
567  * \brief Add a Zone to the platform
568  *
569  * Add a new autonomous system to the platform. Any elements (such as host, router or sub-Zone) added after this call
570  * and before the corresponding call to sg_platf_new_Zone_seal() will be added to this Zone.
571  *
572  * Once this function was called, the configuration concerning the used models cannot be changed anymore.
573  *
574  * @param zone the parameters defining the Zone to build.
575  */
576 simgrid::s4u::NetZone* sg_platf_new_Zone_begin(ZoneCreationArgs* zone)
577 {
578   if (not surf_parse_models_setup_already_called) {
579     /* Initialize the surf models. That must be done after we got all config, and before we need the models.
580      * That is, after the last <config> tag, if any, and before the first of cluster|peer|AS|trace|trace_connect
581      *
582      * I'm not sure for <trace> and <trace_connect>, there may be a bug here
583      * (FIXME: check it out by creating a file beginning with one of these tags)
584      * but cluster and peer create ASes internally, so putting the code in there is ok.
585      */
586     surf_parse_models_setup_already_called = 1;
587     surf_config_models_setup();
588   }
589
590   _sg_cfg_init_status = 2; /* HACK: direct access to the global controlling the level of configuration to prevent
591                             * any further config now that we created some real content */
592
593   /* search the routing model */
594   simgrid::kernel::routing::NetZoneImpl* new_zone = nullptr;
595   switch (zone->routing) {
596     case A_surfxml_AS_routing_Cluster:
597       new_zone = new simgrid::kernel::routing::ClusterZone(current_routing, zone->id);
598       break;
599     case A_surfxml_AS_routing_ClusterDragonfly:
600       new_zone = new simgrid::kernel::routing::DragonflyZone(current_routing, zone->id);
601       break;
602     case A_surfxml_AS_routing_ClusterTorus:
603       new_zone = new simgrid::kernel::routing::TorusZone(current_routing, zone->id);
604       break;
605     case A_surfxml_AS_routing_ClusterFatTree:
606       new_zone = new simgrid::kernel::routing::FatTreeZone(current_routing, zone->id);
607       break;
608     case A_surfxml_AS_routing_Dijkstra:
609       new_zone = new simgrid::kernel::routing::DijkstraZone(current_routing, zone->id, 0);
610       break;
611     case A_surfxml_AS_routing_DijkstraCache:
612       new_zone = new simgrid::kernel::routing::DijkstraZone(current_routing, zone->id, 1);
613       break;
614     case A_surfxml_AS_routing_Floyd:
615       new_zone = new simgrid::kernel::routing::FloydZone(current_routing, zone->id);
616       break;
617     case A_surfxml_AS_routing_Full:
618       new_zone = new simgrid::kernel::routing::FullZone(current_routing, zone->id);
619       break;
620     case A_surfxml_AS_routing_None:
621       new_zone = new simgrid::kernel::routing::EmptyZone(current_routing, zone->id);
622       break;
623     case A_surfxml_AS_routing_Vivaldi:
624       new_zone = new simgrid::kernel::routing::VivaldiZone(current_routing, zone->id);
625       break;
626     default:
627       xbt_die("Not a valid model!");
628       break;
629   }
630
631   if (current_routing == nullptr) { /* it is the first one */
632     xbt_assert(simgrid::s4u::Engine::getInstance()->pimpl->netRoot_ == nullptr,
633                "All defined components must belong to a networking zone.");
634     simgrid::s4u::Engine::getInstance()->pimpl->netRoot_ = new_zone;
635
636   } else {
637     /* set the father behavior */
638     if (current_routing->hierarchy_ == simgrid::kernel::routing::NetZoneImpl::RoutingMode::unset)
639       current_routing->hierarchy_ = simgrid::kernel::routing::NetZoneImpl::RoutingMode::recursive;
640     /* add to the sons dictionary */
641     current_routing->getChildren()->push_back(static_cast<simgrid::s4u::NetZone*>(new_zone));
642   }
643
644   /* set the new current component of the tree */
645   current_routing = new_zone;
646
647   simgrid::s4u::NetZone::onCreation(*new_zone); // notify the signal
648
649   return new_zone;
650 }
651
652 /**
653  * \brief Specify that the description of the current AS is finished
654  *
655  * Once you've declared all the content of your AS, you have to seal
656  * it with this call. Your AS is not usable until you call this function.
657  */
658 void sg_platf_new_Zone_seal()
659 {
660   xbt_assert(current_routing, "Cannot seal the current AS: none under construction");
661   current_routing->seal();
662   simgrid::s4u::NetZone::onSeal(*current_routing);
663   current_routing = static_cast<simgrid::kernel::routing::NetZoneImpl*>(current_routing->getFather());
664 }
665
666 /** @brief Add a link connecting an host to the rest of its AS (which must be cluster or vivaldi) */
667 void sg_platf_new_hostlink(sg_platf_host_link_cbarg_t hostlink)
668 {
669   simgrid::kernel::routing::NetPoint* netpoint = sg_host_by_name(hostlink->id)->pimpl_netpoint;
670   xbt_assert(netpoint, "Host '%s' not found!", hostlink->id);
671   xbt_assert(dynamic_cast<simgrid::kernel::routing::ClusterZone*>(current_routing),
672              "Only hosts from Cluster and Vivaldi ASes can get an host_link.");
673
674   simgrid::surf::LinkImpl* linkUp   = simgrid::surf::LinkImpl::byName(hostlink->link_up);
675   simgrid::surf::LinkImpl* linkDown = simgrid::surf::LinkImpl::byName(hostlink->link_down);
676
677   xbt_assert(linkUp, "Link '%s' not found!", hostlink->link_up);
678   xbt_assert(linkDown, "Link '%s' not found!", hostlink->link_down);
679
680   auto as_cluster = static_cast<simgrid::kernel::routing::ClusterZone*>(current_routing);
681
682   if (as_cluster->privateLinks_.find(netpoint->id()) != as_cluster->privateLinks_.end())
683     surf_parse_error(std::string("Host_link for '") + hostlink->id + "' is already defined!");
684
685   XBT_DEBUG("Push Host_link for host '%s' to position %u", netpoint->cname(), netpoint->id());
686   as_cluster->privateLinks_.insert({netpoint->id(), {linkUp, linkDown}});
687 }
688
689 void sg_platf_new_trace(TraceCreationArgs* trace)
690 {
691   tmgr_trace_t tmgr_trace;
692   if (not trace->file.empty()) {
693     tmgr_trace = tmgr_trace_new_from_file(trace->file);
694   } else {
695     xbt_assert(not trace->pc_data.empty(), "Trace '%s' must have either a content, or point to a file on disk.",
696                trace->id.c_str());
697     tmgr_trace = tmgr_trace_new_from_string(trace->id, trace->pc_data, trace->periodicity);
698   }
699   traces_set_list.insert({trace->id, tmgr_trace});
700 }