Logo AND Algorithmique Numérique Distribuée

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