Logo AND Algorithmique Numérique Distribuée

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