Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix callback (& not *)
[simgrid.git] / src / instr / instr_platform.cpp
1 /* Copyright (c) 2010-2018. 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 "src/instr/instr_private.hpp"
7
8 #include "simgrid/kernel/routing/NetPoint.hpp"
9 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
10 #include "simgrid/s4u/Actor.hpp"
11 #include "simgrid/s4u/Engine.hpp"
12 #include "simgrid/s4u/Host.hpp"
13 #include "simgrid/s4u/VirtualMachine.hpp"
14 #include "src/surf/cpu_interface.hpp"
15 #include "src/surf/network_interface.hpp"
16 #include "src/surf/surf_interface.hpp"
17 #include "src/surf/xml/platf_private.hpp"
18 #include "surf/surf.hpp"
19 #include "xbt/graph.h"
20
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_routing, instr, "Tracing platform hierarchy");
22
23 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
24
25 static const char* instr_node_name(xbt_node_t node)
26 {
27   return static_cast<char*>(xbt_graph_node_get_data(node));
28 }
29
30 static container_t lowestCommonAncestor(container_t a1, container_t a2)
31 {
32   // this is only an optimization (since most of a1 and a2 share the same parent)
33   if (a1->father_ == a2->father_)
34     return a1->father_;
35
36   // create an array with all ancestors of a1
37   std::vector<container_t> ancestors_a1;
38   container_t p = a1->father_;
39   while (p) {
40     ancestors_a1.push_back(p);
41     p = p->father_;
42   }
43
44   // create an array with all ancestors of a2
45   std::vector<container_t> ancestors_a2;
46   p = a2->father_;
47   while (p) {
48     ancestors_a2.push_back(p);
49     p = p->father_;
50   }
51
52   // find the lowest ancestor
53   p     = nullptr;
54   int i = ancestors_a1.size() - 1;
55   int j = ancestors_a2.size() - 1;
56   while (i >= 0 && j >= 0) {
57     container_t a1p = ancestors_a1.at(i);
58     container_t a2p = ancestors_a2.at(j);
59     if (a1p == a2p) {
60       p = a1p;
61     } else {
62       break;
63     }
64     i--;
65     j--;
66   }
67   return p;
68 }
69
70 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
71 {
72   // ignore loopback
73   if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
74     XBT_DEBUG("  linkContainers: ignoring loopback link");
75     return;
76   }
77
78   // find common father
79   container_t father = lowestCommonAncestor(src, dst);
80   if (not father) {
81     xbt_die("common father unknown, this is a tracing problem");
82   }
83
84   // check if we already register this pair (we only need one direction)
85   std::string aux1 = src->get_name() + dst->get_name();
86   std::string aux2 = dst->get_name() + src->get_name();
87   if (filter->find(aux1) != filter->end()) {
88     XBT_DEBUG("  linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
89     return;
90   }
91   if (filter->find(aux2) != filter->end()) {
92     XBT_DEBUG("  linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
93     return;
94   }
95
96   // ok, not found, register it
97   filter->insert(aux1);
98   filter->insert(aux2);
99
100   // declare type
101   std::string link_typename = father->type_->get_name() + "-" + src->type_->get_name() +
102                               std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
103                               std::to_string(dst->type_->get_id());
104   simgrid::instr::LinkType* link = father->type_->by_name_or_create(link_typename, src->type_, dst->type_);
105   link->set_calling_container(father);
106
107   // register EDGE types for triva configuration
108   trivaEdgeTypes.insert(link->get_name());
109
110   // create the link
111   static long long counter = 0;
112
113   std::string key = std::to_string(counter);
114   counter++;
115
116   link->start_event(src, "topology", key);
117   link->end_event(dst, "topology", key);
118
119   XBT_DEBUG("  linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
120 }
121
122 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
123                                      std::set<std::string>* filter)
124 {
125   if (not TRACE_platform_topology()) {
126     XBT_DEBUG("Graph extraction disabled by user.");
127     return;
128   }
129   XBT_DEBUG("Graph extraction for NetZone = %s", netzone->get_cname());
130   if (not netzone->getChildren()->empty()) {
131     // bottom-up recursion
132     for (auto const& nz_son : *netzone->getChildren()) {
133       container_t child_container = container->children_.at(nz_son->get_cname());
134       recursiveGraphExtraction(nz_son, child_container, filter);
135     }
136   }
137
138   xbt_graph_t graph                        = xbt_graph_new_graph(0, nullptr);
139   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
140   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
141
142   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
143   for (auto elm : *edges) {
144     xbt_edge_t edge = elm.second;
145     linkContainers(simgrid::instr::Container::by_name(static_cast<const char*>(edge->src->data)),
146                    simgrid::instr::Container::by_name(static_cast<const char*>(edge->dst->data)), filter);
147   }
148   delete nodes;
149   delete edges;
150   xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
151 }
152
153 /*
154  * Callbacks
155  */
156 static void instr_netzone_on_creation(simgrid::s4u::NetZone& netzone)
157 {
158   std::string id = netzone.get_name();
159   if (simgrid::instr::Container::get_root() == nullptr) {
160     simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
161
162     if (TRACE_smpi_is_enabled()) {
163       simgrid::instr::ContainerType* mpi = root->type_->by_name_or_create<simgrid::instr::ContainerType>("MPI");
164       if (not TRACE_smpi_is_grouped())
165         mpi->by_name_or_create<simgrid::instr::StateType>("MPI_STATE");
166       root->type_->by_name_or_create("MPI_LINK", mpi, mpi);
167       // TODO See if we can move this to the LoadBalancer plugin
168       root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
169       mpi->by_name_or_create<simgrid::instr::StateType>("MIGRATE_STATE");
170     }
171
172     if (TRACE_needs_platform()) {
173       currentContainer.push_back(root);
174     }
175     return;
176   }
177
178   if (TRACE_needs_platform()) {
179     simgrid::instr::NetZoneContainer* container =
180         new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
181     currentContainer.push_back(container);
182   }
183 }
184
185 static void instr_netzone_on_seal(simgrid::s4u::NetZone& /*netzone*/)
186 {
187   if (TRACE_needs_platform()) {
188     currentContainer.pop_back();
189   }
190 }
191
192 static void instr_link_on_creation(simgrid::s4u::Link& link)
193 {
194   if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
195     return;
196
197   container_t container = new simgrid::instr::Container(link.get_name(), "LINK", currentContainer.back());
198
199   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
200     simgrid::instr::VariableType* bandwidth = container->type_->by_name_or_create("bandwidth", "");
201     bandwidth->set_calling_container(container);
202     bandwidth->set_event(0, link.bandwidth());
203     simgrid::instr::VariableType* latency = container->type_->by_name_or_create("latency", "");
204     latency->set_calling_container(container);
205     latency->set_event(0, link.latency());
206   }
207   if (TRACE_uncategorized()) {
208     container->type_->by_name_or_create("bandwidth_used", "0.5 0.5 0.5");
209   }
210 }
211
212 static void instr_host_on_creation(simgrid::s4u::Host& host)
213 {
214   container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
215   container_t root      = simgrid::instr::Container::get_root();
216
217   if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
218     simgrid::instr::VariableType* power = container->type_->by_name_or_create("power", "");
219     power->set_calling_container(container);
220     power->set_event(0, host.getSpeed());
221   }
222
223   if (TRACE_uncategorized())
224     container->type_->by_name_or_create("power_used", "0.5 0.5 0.5");
225
226   if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()) {
227     simgrid::instr::ContainerType* mpi = container->type_->by_name_or_create<simgrid::instr::ContainerType>("MPI");
228     mpi->by_name_or_create<simgrid::instr::StateType>("MPI_STATE");
229     // TODO See if we can move this to the LoadBalancer plugin
230     root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
231     mpi->by_name_or_create<simgrid::instr::StateType>("MIGRATE_STATE");
232   }
233 }
234
235 static void instr_host_on_speed_change(simgrid::s4u::Host& host)
236 {
237   simgrid::instr::Container::by_name(host.get_cname())
238       ->get_variable("power")
239       ->set_event(surf_get_clock(), host.getCoreCount() * host.get_available_speed());
240 }
241
242 static void instr_cpu_action_on_state_change(simgrid::surf::CpuAction* action,
243                                              simgrid::kernel::resource::Action::State /* previous */)
244 {
245   simgrid::surf::Cpu* cpu = static_cast<simgrid::surf::Cpu*>(action->get_variable()->get_constraint(0)->get_id());
246   TRACE_surf_resource_set_utilization("HOST", "power_used", cpu->get_cname(), action->get_category(),
247                                       action->get_variable()->get_value(), action->get_last_update(),
248                                       SIMIX_get_clock() - action->get_last_update());
249 }
250
251 static void instr_link_on_communication_state_change(simgrid::kernel::resource::NetworkAction* action)
252 {
253   int n = action->get_variable()->get_number_of_constraint();
254
255   for (int i = 0; i < n; i++) {
256     simgrid::kernel::lmm::Constraint* constraint = action->get_variable()->get_constraint(i);
257     simgrid::kernel::resource::LinkImpl* link = static_cast<simgrid::kernel::resource::LinkImpl*>(constraint->get_id());
258     double value = action->get_variable()->get_value() * action->get_variable()->get_constraint_weight(i);
259     TRACE_surf_resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action->get_category(), value,
260                                         action->get_last_update(), SIMIX_get_clock() - action->get_last_update());
261   }
262 }
263 static void instr_link_on_bandwidth_change(simgrid::s4u::Link& link)
264 {
265   simgrid::instr::Container::by_name(link.get_cname())
266       ->get_variable("bandwidth")
267       ->set_event(surf_get_clock(), sg_bandwidth_factor * link.bandwidth());
268 }
269
270 static void instr_netpoint_on_creation(simgrid::kernel::routing::NetPoint* netpoint)
271 {
272   if (netpoint->is_router() && TRACE_needs_platform() && TRACE_is_enabled())
273     new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
274 }
275
276 static void instr_on_platform_created()
277 {
278   currentContainer.clear();
279   std::set<std::string>* filter = new std::set<std::string>;
280   XBT_DEBUG("Starting graph extraction.");
281   recursiveGraphExtraction(simgrid::s4u::Engine::get_instance()->get_netzone_root(),
282                            simgrid::instr::Container::get_root(), filter);
283   XBT_DEBUG("Graph extraction finished.");
284   delete filter;
285   TRACE_paje_dump_buffer(true);
286 }
287
288 static void instr_actor_on_creation(simgrid::s4u::ActorPtr actor)
289 {
290   container_t root      = simgrid::instr::Container::get_root();
291   container_t container = simgrid::instr::Container::by_name(actor->get_host()->get_name());
292
293   container->create_child(instr_pid(actor.get()), "ACTOR");
294   simgrid::instr::ContainerType* actor_type =
295       container->type_->by_name_or_create<simgrid::instr::ContainerType>("ACTOR");
296   simgrid::instr::StateType* state = actor_type->by_name_or_create<simgrid::instr::StateType>("ACTOR_STATE");
297   state->add_entity_value("suspend", "1 0 1");
298   state->add_entity_value("sleep", "1 1 0");
299   state->add_entity_value("receive", "1 0 0");
300   state->add_entity_value("send", "0 0 1");
301   state->add_entity_value("task_execute", "0 1 1");
302   root->type_->by_name_or_create("ACTOR_LINK", actor_type, actor_type);
303   root->type_->by_name_or_create("ACTOR_TASK_LINK", actor_type, actor_type);
304 }
305
306 static void instr_actor_on_suspend(simgrid::s4u::ActorPtr actor)
307 {
308   simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->push_event("suspend");
309 }
310
311 static void instr_actor_on_resume(simgrid::s4u::ActorPtr actor)
312 {
313   simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->pop_event();
314 }
315
316 static long long int counter = 0;
317
318 static void instr_actor_on_migration_start(simgrid::s4u::ActorPtr actor)
319 {
320   // start link
321   container_t container = simgrid::instr::Container::by_name(instr_pid(actor.get()));
322   simgrid::instr::Container::get_root()->get_link("ACTOR_LINK")->start_event(container, "M", std::to_string(counter));
323
324   // destroy existing container of this process
325   container->remove_from_parent();
326 }
327
328 static void instr_actor_on_migration_end(simgrid::s4u::ActorPtr actor)
329 {
330   // create new container on the new_host location
331   simgrid::instr::Container::by_name(actor->get_host()->get_name())->create_child(instr_pid(actor.get()), "ACTOR");
332   // end link
333   simgrid::instr::Container::get_root()
334       ->get_link("ACTOR_LINK")
335       ->end_event(simgrid::instr::Container::by_name(instr_pid(actor.get())), "M", std::to_string(counter));
336   counter++;
337 }
338
339 static void instr_vm_on_creation(simgrid::s4u::Host& host)
340 {
341   container_t container             = new simgrid::instr::HostContainer(host, currentContainer.back());
342   container_t root                  = simgrid::instr::Container::get_root();
343   simgrid::instr::ContainerType* vm = container->type_->by_name_or_create<simgrid::instr::ContainerType>("VM");
344   simgrid::instr::StateType* state  = vm->by_name_or_create<simgrid::instr::StateType>("VM_STATE");
345   state->add_entity_value("suspend", "1 0 1");
346   state->add_entity_value("sleep", "1 1 0");
347   state->add_entity_value("receive", "1 0 0");
348   state->add_entity_value("send", "0 0 1");
349   state->add_entity_value("task_execute", "0 1 1");
350   root->type_->by_name_or_create("VM_LINK", vm, vm);
351   root->type_->by_name_or_create("VM_ACTOR_LINK", vm, vm);
352 }
353
354 static void instr_vm_on_start(simgrid::s4u::VirtualMachine& vm)
355 {
356   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("start");
357 }
358
359 static void instr_vm_on_started(simgrid::s4u::VirtualMachine& vm)
360 {
361   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event();
362 }
363
364 static void instr_vm_on_suspend(simgrid::s4u::VirtualMachine& vm)
365 {
366   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("suspend");
367 }
368
369 static void instr_vm_on_resume(simgrid::s4u::VirtualMachine& vm)
370 {
371   simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event();
372 }
373
374 static void instr_vm_on_destruction(simgrid::s4u::Host& host)
375 {
376   simgrid::instr::Container::by_name(host.get_name())->remove_from_parent();
377 }
378
379 void instr_define_callbacks()
380 {
381   // always need the callbacks to zones (we need only the root zone), to create the rootContainer and the rootType
382   // properly
383   if (TRACE_needs_platform()) {
384     simgrid::s4u::on_platform_created.connect(instr_on_platform_created);
385     simgrid::s4u::Host::onCreation.connect(instr_host_on_creation);
386     simgrid::s4u::Host::onSpeedChange.connect(instr_host_on_speed_change);
387     simgrid::s4u::Link::on_creation.connect(instr_link_on_creation);
388     simgrid::s4u::Link::on_bandwidth_change.connect(instr_link_on_bandwidth_change);
389   }
390   simgrid::s4u::NetZone::onCreation.connect(instr_netzone_on_creation);
391   simgrid::s4u::NetZone::onSeal.connect(instr_netzone_on_seal);
392   simgrid::kernel::routing::NetPoint::onCreation.connect(instr_netpoint_on_creation);
393
394   simgrid::surf::CpuAction::onStateChange.connect(instr_cpu_action_on_state_change);
395   simgrid::s4u::Link::on_communication_state_change.connect(instr_link_on_communication_state_change);
396
397   if (TRACE_actor_is_enabled()) {
398     simgrid::s4u::Actor::on_creation.connect(instr_actor_on_creation);
399     simgrid::s4u::Actor::on_suspend.connect(instr_actor_on_suspend);
400     simgrid::s4u::Actor::on_resume.connect(instr_actor_on_resume);
401     simgrid::s4u::Actor::on_migration_start.connect(instr_actor_on_migration_start);
402     simgrid::s4u::Actor::on_migration_end.connect(instr_actor_on_migration_end);
403   }
404
405   if (TRACE_vm_is_enabled()) {
406     simgrid::s4u::Host::onCreation.connect(instr_vm_on_creation);
407     simgrid::s4u::VirtualMachine::on_start.connect(instr_vm_on_start);
408     simgrid::s4u::VirtualMachine::on_started.connect(instr_vm_on_started);
409     simgrid::s4u::VirtualMachine::on_suspend.connect(instr_vm_on_suspend);
410     simgrid::s4u::VirtualMachine::on_resume.connect(instr_vm_on_resume);
411     simgrid::s4u::Host::onDestruction.connect(instr_vm_on_destruction);
412   }
413 }
414 /*
415  * user categories support
416  */
417 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
418 {
419   if (root->get_name() == "HOST" || root->get_name() == "VM")
420     root->by_name_or_create(std::string("p") + new_typename, color);
421
422   if (root->get_name() == "LINK")
423     root->by_name_or_create(std::string("b") + new_typename, color);
424
425   for (auto elm : root->children_) {
426     recursiveNewVariableType(new_typename, color, elm.second);
427   }
428 }
429
430 void instr_new_variable_type(std::string new_typename, std::string color)
431 {
432   recursiveNewVariableType(new_typename, color, simgrid::instr::Container::get_root()->type_);
433 }
434
435 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
436                                          simgrid::instr::Type* root)
437 {
438   if (root->get_name() == father_type) {
439     root->by_name_or_create(new_typename, color);
440   }
441   for (auto elm : root->children_)
442     recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
443 }
444
445 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
446 {
447   recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::get_root()->type_);
448 }
449
450 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
451 {
452   if (root->get_name() == father_type)
453     root->by_name_or_create<simgrid::instr::StateType>(new_typename);
454
455   for (auto elm : root->children_)
456     recursiveNewUserStateType(father_type, new_typename, elm.second);
457 }
458
459 void instr_new_user_state_type(std::string father_type, std::string new_typename)
460 {
461   recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::get_root()->type_);
462 }
463
464 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
465                                               simgrid::instr::Type* root)
466 {
467   if (root->get_name() == type_name)
468     static_cast<simgrid::instr::StateType*>(root)->add_entity_value(val, color);
469
470   for (auto elm : root->children_)
471     recursiveNewValueForUserStateType(type_name, val, color, elm.second);
472 }
473
474 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
475 {
476   recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::get_root()->type_);
477 }
478
479 #define GRAPHICATOR_SUPPORT_FUNCTIONS
480
481 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
482                                         std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
483                                         container_t container)
484 {
485   if (not netzone->getChildren()->empty()) {
486     // bottom-up recursion
487     for (auto const& netzone_child : *netzone->getChildren()) {
488       container_t child_container = container->children_.at(netzone_child->get_cname());
489       recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
490     }
491   }
492
493   static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->get_graph(graph, nodes, edges);
494 }
495
496 xbt_graph_t instr_routing_platform_graph()
497 {
498   xbt_graph_t ret                          = xbt_graph_new_graph(0, nullptr);
499   std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
500   std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
501   recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::get_instance()->get_netzone_root(),
502                               simgrid::instr::Container::get_root());
503   delete nodes;
504   delete edges;
505   return ret;
506 }
507
508 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename)
509 {
510   unsigned int cursor = 0;
511   xbt_node_t node     = nullptr;
512   xbt_edge_t edge     = nullptr;
513
514   FILE* file = fopen(filename, "w");
515   xbt_assert(file, "Failed to open %s \n", filename);
516
517   if (g->directed)
518     fprintf(file, "digraph test {\n");
519   else
520     fprintf(file, "graph test {\n");
521
522   fprintf(file, "  graph [overlap=scale]\n");
523
524   fprintf(file, "  node [shape=box, style=filled]\n");
525   fprintf(file, "  node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
526
527   xbt_dynar_foreach (g->nodes, cursor, node) {
528     fprintf(file, "  \"%s\";\n", instr_node_name(node));
529   }
530   xbt_dynar_foreach (g->edges, cursor, edge) {
531     const char* src_s = instr_node_name(edge->src);
532     const char* dst_s = instr_node_name(edge->dst);
533     if (g->directed)
534       fprintf(file, "  \"%s\" -> \"%s\";\n", src_s, dst_s);
535     else
536       fprintf(file, "  \"%s\" -- \"%s\";\n", src_s, dst_s);
537   }
538   fprintf(file, "}\n");
539   fclose(file);
540 }