1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/instr/instr_private.hpp"
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/Exec.hpp"
13 #include "simgrid/s4u/Host.hpp"
14 #include "simgrid/s4u/VirtualMachine.hpp"
15 #include "src/surf/cpu_interface.hpp"
16 #include "src/surf/network_interface.hpp"
17 #include "src/surf/surf_interface.hpp"
18 #include "src/surf/xml/platf_private.hpp"
19 #include "surf/surf.hpp"
20 #include "xbt/graph.h"
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_routing, instr, "Tracing platform hierarchy");
24 static std::vector<simgrid::instr::NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
26 static const char* instr_node_name(xbt_node_t node)
28 return static_cast<char*>(xbt_graph_node_get_data(node));
31 static container_t lowestCommonAncestor(container_t a1, container_t a2)
33 // this is only an optimization (since most of a1 and a2 share the same parent)
34 if (a1->father_ == a2->father_)
37 // create an array with all ancestors of a1
38 std::vector<container_t> ancestors_a1;
39 container_t p = a1->father_;
41 ancestors_a1.push_back(p);
45 // create an array with all ancestors of a2
46 std::vector<container_t> ancestors_a2;
49 ancestors_a2.push_back(p);
53 // find the lowest ancestor
55 int i = ancestors_a1.size() - 1;
56 int j = ancestors_a2.size() - 1;
57 while (i >= 0 && j >= 0) {
58 container_t a1p = ancestors_a1.at(i);
59 container_t a2p = ancestors_a2.at(j);
71 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
74 if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
75 XBT_DEBUG(" linkContainers: ignoring loopback link");
80 container_t father = lowestCommonAncestor(src, dst);
82 xbt_die("common father unknown, this is a tracing problem");
85 // check if we already register this pair (we only need one direction)
86 std::string aux1 = src->get_name() + dst->get_name();
87 std::string aux2 = dst->get_name() + src->get_name();
88 if (filter->find(aux1) != filter->end()) {
89 XBT_DEBUG(" linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
92 if (filter->find(aux2) != filter->end()) {
93 XBT_DEBUG(" linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
97 // ok, not found, register it
102 std::string link_typename = father->type_->get_name() + "-" + src->type_->get_name() +
103 std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
104 std::to_string(dst->type_->get_id());
105 simgrid::instr::LinkType* link = father->type_->by_name_or_create(link_typename, src->type_, dst->type_);
106 link->set_calling_container(father);
108 // register EDGE types for triva configuration
109 trivaEdgeTypes.insert(link->get_name());
112 static long long counter = 0;
114 std::string key = std::to_string(counter);
117 link->start_event(src, "topology", key);
118 link->end_event(dst, "topology", key);
120 XBT_DEBUG(" linkContainers %s <-> %s", src->get_cname(), dst->get_cname());
123 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
124 std::set<std::string>* filter)
126 if (not TRACE_platform_topology()) {
127 XBT_DEBUG("Graph extraction disabled by user.");
130 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->get_cname());
131 if (not netzone->get_children().empty()) {
132 // bottom-up recursion
133 for (auto const& nz_son : netzone->get_children()) {
134 container_t child_container = container->children_.at(nz_son->get_cname());
135 recursiveGraphExtraction(nz_son, child_container, filter);
139 xbt_graph_t graph = xbt_graph_new_graph(0, nullptr);
140 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
141 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
143 netzone->get_impl()->get_graph(graph, nodes, edges);
144 for (auto elm : *edges) {
145 xbt_edge_t edge = elm.second;
146 linkContainers(simgrid::instr::Container::by_name(static_cast<const char*>(edge->src->data)),
147 simgrid::instr::Container::by_name(static_cast<const char*>(edge->dst->data)), filter);
151 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
157 static void instr_netzone_on_creation(simgrid::s4u::NetZone& netzone)
159 std::string id = netzone.get_name();
160 if (simgrid::instr::Container::get_root() == nullptr) {
161 simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
163 if (TRACE_smpi_is_enabled()) {
164 simgrid::instr::ContainerType* mpi = root->type_->by_name_or_create<simgrid::instr::ContainerType>("MPI");
165 if (not TRACE_smpi_is_grouped())
166 mpi->by_name_or_create<simgrid::instr::StateType>("MPI_STATE");
167 root->type_->by_name_or_create("MPI_LINK", mpi, mpi);
168 // TODO See if we can move this to the LoadBalancer plugin
169 root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
170 mpi->by_name_or_create<simgrid::instr::StateType>("MIGRATE_STATE");
173 if (TRACE_needs_platform()) {
174 currentContainer.push_back(root);
179 if (TRACE_needs_platform()) {
180 simgrid::instr::NetZoneContainer* container =
181 new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
182 currentContainer.push_back(container);
186 static void instr_link_on_creation(simgrid::s4u::Link& link)
188 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
191 container_t container = new simgrid::instr::Container(link.get_name(), "LINK", currentContainer.back());
193 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
194 simgrid::instr::VariableType* bandwidth = container->type_->by_name_or_create("bandwidth", "");
195 bandwidth->set_calling_container(container);
196 bandwidth->set_event(0, link.get_bandwidth());
197 simgrid::instr::VariableType* latency = container->type_->by_name_or_create("latency", "");
198 latency->set_calling_container(container);
199 latency->set_event(0, link.get_latency());
201 if (TRACE_uncategorized()) {
202 container->type_->by_name_or_create("bandwidth_used", "0.5 0.5 0.5");
206 static void instr_host_on_creation(simgrid::s4u::Host& host)
208 container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
209 container_t root = simgrid::instr::Container::get_root();
211 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
212 simgrid::instr::VariableType* speed = container->type_->by_name_or_create("speed", "");
213 speed->set_calling_container(container);
214 speed->set_event(0, host.get_speed());
216 simgrid::instr::VariableType* cores = container->type_->by_name_or_create("core_count", "");
217 cores->set_calling_container(container);
218 cores->set_event(0, host.get_core_count());
221 if (TRACE_uncategorized())
222 container->type_->by_name_or_create("speed_used", "0.5 0.5 0.5");
224 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()) {
225 simgrid::instr::ContainerType* mpi = container->type_->by_name_or_create<simgrid::instr::ContainerType>("MPI");
226 mpi->by_name_or_create<simgrid::instr::StateType>("MPI_STATE");
227 // TODO See if we can move this to the LoadBalancer plugin
228 root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
229 mpi->by_name_or_create<simgrid::instr::StateType>("MIGRATE_STATE");
233 static void instr_host_on_speed_change(simgrid::s4u::Host& host)
235 simgrid::instr::Container::by_name(host.get_cname())
236 ->get_variable("speed")
237 ->set_event(surf_get_clock(), host.get_core_count() * host.get_available_speed());
240 static void instr_action_on_state_change(simgrid::kernel::resource::Action* action,
241 simgrid::kernel::resource::Action::State /* previous */)
243 int n = action->get_variable()->get_number_of_constraint();
245 for (int i = 0; i < n; i++) {
246 double value = action->get_variable()->get_value() * action->get_variable()->get_constraint_weight(i);
247 /* Beware of composite actions: ptasks put links and cpus together. Extra pb: we cannot dynamic_cast from void* */
248 simgrid::kernel::resource::Resource* resource =
249 static_cast<simgrid::kernel::resource::Resource*>(action->get_variable()->get_constraint(i)->get_id());
250 simgrid::surf::Cpu* cpu = dynamic_cast<simgrid::surf::Cpu*>(resource);
253 TRACE_surf_resource_set_utilization("HOST", "speed_used", cpu->get_cname(), action->get_category(), value,
254 action->get_last_update(), SIMIX_get_clock() - action->get_last_update());
256 simgrid::kernel::resource::LinkImpl* link = dynamic_cast<simgrid::kernel::resource::LinkImpl*>(resource);
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());
264 static void instr_link_on_bandwidth_change(simgrid::s4u::Link& link)
266 simgrid::instr::Container::by_name(link.get_cname())
267 ->get_variable("bandwidth")
268 ->set_event(surf_get_clock(), sg_bandwidth_factor * link.get_bandwidth());
271 static void instr_netpoint_on_creation(simgrid::kernel::routing::NetPoint* netpoint)
273 if (netpoint->is_router())
274 new simgrid::instr::RouterContainer(netpoint->get_cname(), currentContainer.back());
277 static void instr_on_platform_created()
279 currentContainer.clear();
280 std::set<std::string>* filter = new std::set<std::string>;
281 XBT_DEBUG("Starting graph extraction.");
282 recursiveGraphExtraction(simgrid::s4u::Engine::get_instance()->get_netzone_root(),
283 simgrid::instr::Container::get_root(), filter);
284 XBT_DEBUG("Graph extraction finished.");
286 TRACE_paje_dump_buffer(true);
289 static void instr_actor_on_creation(simgrid::s4u::ActorPtr actor)
291 container_t root = simgrid::instr::Container::get_root();
292 container_t container = simgrid::instr::Container::by_name(actor->get_host()->get_name());
294 container->create_child(instr_pid(actor.get()), "ACTOR");
295 simgrid::instr::ContainerType* actor_type =
296 container->type_->by_name_or_create<simgrid::instr::ContainerType>("ACTOR");
297 simgrid::instr::StateType* state = actor_type->by_name_or_create<simgrid::instr::StateType>("ACTOR_STATE");
298 state->add_entity_value("suspend", "1 0 1");
299 state->add_entity_value("sleep", "1 1 0");
300 state->add_entity_value("receive", "1 0 0");
301 state->add_entity_value("send", "0 0 1");
302 state->add_entity_value("execute", "0 1 1");
303 root->type_->by_name_or_create("ACTOR_LINK", actor_type, actor_type);
304 root->type_->by_name_or_create("ACTOR_TASK_LINK", actor_type, actor_type);
306 std::string container_name = instr_pid(actor.get());
308 [container_name](int status, void* actor) {
309 if (status == SMX_EXIT_FAILURE)
310 // kill means that this actor no longer exists, let's destroy it
311 simgrid::instr::Container::by_name(container_name)->remove_from_parent();
316 static long long int counter = 0;
318 static void instr_actor_on_migration_start(simgrid::s4u::ActorPtr actor)
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));
324 // destroy existing container of this process
325 container->remove_from_parent();
328 static void instr_actor_on_migration_end(simgrid::s4u::ActorPtr actor)
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");
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));
339 static void instr_vm_on_creation(simgrid::s4u::Host& host)
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("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);
354 void instr_define_callbacks()
356 // always need the callbacks to zones (we need only the root zone), to create the rootContainer and the rootType
358 if (TRACE_needs_platform()) {
359 simgrid::s4u::on_platform_created.connect(instr_on_platform_created);
360 simgrid::s4u::Host::on_creation.connect(instr_host_on_creation);
361 simgrid::s4u::Host::on_speed_change.connect(instr_host_on_speed_change);
362 simgrid::s4u::Link::on_creation.connect(instr_link_on_creation);
363 simgrid::s4u::Link::on_bandwidth_change.connect(instr_link_on_bandwidth_change);
364 simgrid::s4u::NetZone::on_seal.connect([](simgrid::s4u::NetZone& /*netzone*/) { currentContainer.pop_back(); });
365 simgrid::kernel::routing::NetPoint::on_creation.connect(instr_netpoint_on_creation);
367 simgrid::s4u::NetZone::on_creation.connect(instr_netzone_on_creation);
369 simgrid::surf::CpuAction::on_state_change.connect(instr_action_on_state_change);
370 simgrid::s4u::Link::on_communication_state_change.connect(instr_action_on_state_change);
372 if (TRACE_actor_is_enabled()) {
373 simgrid::s4u::Actor::on_creation.connect(instr_actor_on_creation);
374 simgrid::s4u::Actor::on_suspend.connect([](simgrid::s4u::ActorPtr actor) {
375 simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->push_event("suspend");
377 simgrid::s4u::Actor::on_resume.connect([](simgrid::s4u::ActorPtr actor) {
378 simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->pop_event();
380 simgrid::s4u::Actor::on_sleep.connect([](simgrid::s4u::ActorPtr actor) {
381 simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->push_event("sleep");
383 simgrid::s4u::Actor::on_wake_up.connect([](simgrid::s4u::ActorPtr actor) {
384 simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->pop_event();
386 simgrid::s4u::Exec::on_start.connect([](simgrid::s4u::ActorPtr actor) {
387 simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->push_event("execute");
389 simgrid::s4u::Exec::on_completion.connect([](simgrid::s4u::ActorPtr actor) {
390 simgrid::instr::Container::by_name(instr_pid(actor.get()))->get_state("ACTOR_STATE")->pop_event();
392 simgrid::s4u::Actor::on_migration_start.connect(instr_actor_on_migration_start);
393 simgrid::s4u::Actor::on_migration_end.connect(instr_actor_on_migration_end);
396 if (TRACE_vm_is_enabled()) {
397 simgrid::s4u::Host::on_creation.connect(instr_vm_on_creation);
398 simgrid::s4u::VirtualMachine::on_start.connect([](simgrid::s4u::VirtualMachine& vm) {
399 simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("start");
401 simgrid::s4u::VirtualMachine::on_started.connect([](simgrid::s4u::VirtualMachine& vm) {
402 simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event();
404 simgrid::s4u::VirtualMachine::on_suspend.connect([](simgrid::s4u::VirtualMachine& vm) {
405 simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("suspend");
407 simgrid::s4u::VirtualMachine::on_resume.connect([](simgrid::s4u::VirtualMachine& vm) {
408 simgrid::instr::Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event();
410 simgrid::s4u::Host::on_destruction.connect(
411 [](simgrid::s4u::Host& host) { simgrid::instr::Container::by_name(host.get_name())->remove_from_parent(); });
415 * user categories support
417 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
419 if (root->get_name() == "HOST" || root->get_name() == "VM")
420 root->by_name_or_create(std::string("p") + new_typename, color);
422 if (root->get_name() == "LINK")
423 root->by_name_or_create(std::string("b") + new_typename, color);
425 for (auto elm : root->children_) {
426 recursiveNewVariableType(new_typename, color, elm.second);
430 void instr_new_variable_type(std::string new_typename, std::string color)
432 recursiveNewVariableType(new_typename, color, simgrid::instr::Container::get_root()->type_);
435 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
436 simgrid::instr::Type* root)
438 if (root->get_name() == father_type) {
439 root->by_name_or_create(new_typename, color);
441 for (auto elm : root->children_)
442 recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
445 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
447 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::get_root()->type_);
450 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
452 if (root->get_name() == father_type)
453 root->by_name_or_create<simgrid::instr::StateType>(new_typename);
455 for (auto elm : root->children_)
456 recursiveNewUserStateType(father_type, new_typename, elm.second);
459 void instr_new_user_state_type(std::string father_type, std::string new_typename)
461 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::get_root()->type_);
464 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
465 simgrid::instr::Type* root)
467 if (root->get_name() == type_name)
468 static_cast<simgrid::instr::StateType*>(root)->add_entity_value(val, color);
470 for (auto elm : root->children_)
471 recursiveNewValueForUserStateType(type_name, val, color, elm.second);
474 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
476 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::get_root()->type_);
479 #define GRAPHICATOR_SUPPORT_FUNCTIONS
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)
485 if (not netzone->get_children().empty()) {
486 // bottom-up recursion
487 for (auto const& netzone_child : netzone->get_children()) {
488 container_t child_container = container->children_.at(netzone_child->get_cname());
489 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
493 netzone->get_impl()->get_graph(graph, nodes, edges);
496 xbt_graph_t instr_routing_platform_graph()
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());
508 void instr_routing_platform_graph_export_graphviz(xbt_graph_t g, const char* filename)
510 unsigned int cursor = 0;
511 xbt_node_t node = nullptr;
512 xbt_edge_t edge = nullptr;
514 FILE* file = fopen(filename, "w");
515 xbt_assert(file, "Failed to open %s \n", filename);
518 fprintf(file, "digraph test {\n");
520 fprintf(file, "graph test {\n");
522 fprintf(file, " graph [overlap=scale]\n");
524 fprintf(file, " node [shape=box, style=filled]\n");
525 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
527 xbt_dynar_foreach (g->nodes, cursor, node) {
528 fprintf(file, " \"%s\";\n", instr_node_name(node));
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);
534 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
536 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
538 fprintf(file, "}\n");