1 /* Copyright (c) 2010-2020. 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/Comm.hpp"
12 #include "simgrid/s4u/Engine.hpp"
13 #include "simgrid/s4u/Exec.hpp"
14 #include "simgrid/s4u/Host.hpp"
15 #include "simgrid/s4u/VirtualMachine.hpp"
16 #include "src/surf/cpu_interface.hpp"
17 #include "src/surf/network_interface.hpp"
18 #include "src/surf/surf_interface.hpp"
19 #include "src/surf/xml/platf_private.hpp"
20 #include "surf/surf.hpp"
21 #include "xbt/graph.h"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_routing, instr, "Tracing platform hierarchy");
27 std::string instr_pid(simgrid::s4u::Actor const& proc)
29 return std::string(proc.get_name()) + "-" + std::to_string(proc.get_pid());
32 static simgrid::instr::Container* lowestCommonAncestor(const simgrid::instr::Container* a1,
33 const simgrid::instr::Container* a2)
35 // this is only an optimization (since most of a1 and a2 share the same parent)
36 if (a1->father_ == a2->father_)
39 // create an array with all ancestors of a1
40 std::vector<simgrid::instr::Container*> ancestors_a1;
41 simgrid::instr::Container* p = a1->father_;
43 ancestors_a1.push_back(p);
47 // create an array with all ancestors of a2
48 std::vector<simgrid::instr::Container*> ancestors_a2;
51 ancestors_a2.push_back(p);
55 // find the lowest ancestor
57 int i = static_cast<int>(ancestors_a1.size()) - 1;
58 int j = static_cast<int>(ancestors_a2.size()) - 1;
59 while (i >= 0 && j >= 0) {
60 simgrid::instr::Container* a1p = ancestors_a1.at(i);
61 const simgrid::instr::Container* a2p = ancestors_a2.at(j);
73 static void linkContainers(simgrid::instr::Container* src, simgrid::instr::Container* dst,
74 std::set<std::string>* filter)
77 if (src->get_name() == "__loopback__" || dst->get_name() == "__loopback__") {
78 XBT_DEBUG(" linkContainers: ignoring loopback link");
83 simgrid::instr::Container* father = lowestCommonAncestor(src, dst);
85 xbt_die("common father unknown, this is a tracing problem");
88 // check if we already register this pair (we only need one direction)
89 std::string aux1 = src->get_name() + dst->get_name();
90 std::string aux2 = dst->get_name() + src->get_name();
91 if (filter->find(aux1) != filter->end()) {
92 XBT_DEBUG(" linkContainers: already registered %s <-> %s (1)", src->get_cname(), dst->get_cname());
95 if (filter->find(aux2) != filter->end()) {
96 XBT_DEBUG(" linkContainers: already registered %s <-> %s (2)", dst->get_cname(), src->get_cname());
100 // ok, not found, register it
101 filter->insert(aux1);
102 filter->insert(aux2);
105 std::string link_typename = father->type_->get_name() + "-" + src->type_->get_name() +
106 std::to_string(src->type_->get_id()) + "-" + dst->type_->get_name() +
107 std::to_string(dst->type_->get_id());
108 simgrid::instr::LinkType* link = father->type_->by_name_or_create(link_typename, src->type_, dst->type_);
109 link->set_calling_container(father);
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(const simgrid::s4u::NetZone* netzone, simgrid::instr::Container* 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 simgrid::instr::Container* child_container = container->children_.at(nz_son->get_name());
135 recursiveGraphExtraction(nz_son, child_container, filter);
139 auto* graph = xbt_graph_new_graph(0, nullptr);
140 auto* nodes = new std::map<std::string, xbt_node_t>();
141 auto* edges = new std::map<std::string, xbt_edge_t>();
143 netzone->get_impl()->get_graph(graph, nodes, edges);
144 for (auto elm : *edges) {
145 const xbt_edge* 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);
155 * user categories support
157 static void recursiveNewVariableType(const std::string& new_typename, const std::string& color,
158 simgrid::instr::Type* root)
160 if (root->get_name() == "HOST" || root->get_name() == "VM")
161 root->by_name_or_create(std::string("p") + new_typename, color);
163 if (root->get_name() == "LINK")
164 root->by_name_or_create(std::string("b") + new_typename, color);
166 for (auto const& elm : root->get_children()) {
167 recursiveNewVariableType(new_typename, color, elm.second.get());
171 void instr_new_variable_type(const std::string& new_typename, const std::string& color)
173 recursiveNewVariableType(new_typename, color, simgrid::instr::Container::get_root()->type_);
176 static void recursiveNewUserVariableType(const std::string& father_type, const std::string& new_typename,
177 const std::string& color, simgrid::instr::Type* root)
179 if (root->get_name() == father_type) {
180 root->by_name_or_create(new_typename, color);
182 for (auto const& elm : root->get_children())
183 recursiveNewUserVariableType(father_type, new_typename, color, elm.second.get());
186 void instr_new_user_variable_type(const std::string& father_type, const std::string& new_typename,
187 const std::string& color)
189 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::get_root()->type_);
192 static void recursiveNewUserStateType(const std::string& father_type, const std::string& new_typename,
193 simgrid::instr::Type* root)
195 if (root->get_name() == father_type)
196 root->by_name_or_create<simgrid::instr::StateType>(new_typename);
198 for (auto const& elm : root->get_children())
199 recursiveNewUserStateType(father_type, new_typename, elm.second.get());
202 void instr_new_user_state_type(const std::string& father_type, const std::string& new_typename)
204 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::get_root()->type_);
207 static void recursiveNewValueForUserStateType(const std::string& type_name, const char* val, const std::string& color,
208 simgrid::instr::Type* root)
210 if (root->get_name() == type_name)
211 static_cast<simgrid::instr::StateType*>(root)->add_entity_value(val, color);
213 for (auto const& elm : root->get_children())
214 recursiveNewValueForUserStateType(type_name, val, color, elm.second.get());
217 void instr_new_value_for_user_state_type(const std::string& type_name, const char* value, const std::string& color)
219 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::get_root()->type_);
225 void platform_graph_export_graphviz(const std::string& output_filename)
227 auto* g = xbt_graph_new_graph(0, nullptr);
228 auto* nodes = new std::map<std::string, xbt_node_t>();
229 auto* edges = new std::map<std::string, xbt_edge_t>();
230 s4u::Engine::get_instance()->get_netzone_root()->extract_xbt_graph(g, nodes, edges);
233 fs.open(output_filename, std::ofstream::out);
234 xbt_assert(not fs.fail(), "Failed to open %s", output_filename.c_str());
237 fs << "digraph test {" << std::endl;
239 fs << "graph test {" << std::endl;
241 fs << " graph [overlap=scale]" << std::endl;
243 fs << " node [shape=box, style=filled]" << std::endl;
244 fs << " node [width=.3, height=.3, style=filled, color=skyblue]" << std::endl << std::endl;
246 for (auto const& elm : *nodes)
247 fs << " \"" << elm.first << "\";" << std::endl;
249 for (auto const& elm : *edges) {
250 const char* src_s = static_cast<char*>(elm.second->src->data);
251 const char* dst_s = static_cast<char*>(elm.second->dst->data);
253 fs << " \"" << src_s << "\" -> \"" << dst_s << "\";" << std::endl;
255 fs << " \"" << src_s << "\" -- \"" << dst_s << "\";" << std::endl;
257 fs << "}" << std::endl;
260 xbt_graph_free_graph(g, xbt_free_f, xbt_free_f, nullptr);
266 static std::vector<NetZoneContainer*> currentContainer; /* push and pop, used only in creation */
267 static void on_netzone_creation(s4u::NetZone const& netzone)
269 std::string id = netzone.get_name();
270 if (Container::get_root() == nullptr) {
271 auto* root = new NetZoneContainer(id, 0, nullptr);
272 xbt_assert(Container::get_root() == root);
274 if (TRACE_smpi_is_enabled()) {
275 auto* mpi = root->type_->by_name_or_create<ContainerType>("MPI");
276 if (not TRACE_smpi_is_grouped())
277 mpi->by_name_or_create<StateType>("MPI_STATE");
278 root->type_->by_name_or_create("MPI_LINK", mpi, mpi);
279 // TODO See if we can move this to the LoadBalancer plugin
280 root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
281 mpi->by_name_or_create<StateType>("MIGRATE_STATE");
284 if (TRACE_needs_platform()) {
285 currentContainer.push_back(root);
290 if (TRACE_needs_platform()) {
291 auto level = static_cast<unsigned>(currentContainer.size());
292 auto* container = new NetZoneContainer(id, level, currentContainer.back());
293 currentContainer.push_back(container);
297 static void on_link_creation(s4u::Link const& link)
299 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
302 auto* container = new Container(link.get_name(), "LINK", currentContainer.back());
304 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
305 VariableType* bandwidth = container->type_->by_name_or_create("bandwidth", "");
306 bandwidth->set_calling_container(container);
307 bandwidth->set_event(0, link.get_bandwidth());
308 VariableType* latency = container->type_->by_name_or_create("latency", "");
309 latency->set_calling_container(container);
310 latency->set_event(0, link.get_latency());
313 if (TRACE_uncategorized()) {
314 container->type_->by_name_or_create("bandwidth_used", "0.5 0.5 0.5");
318 static void on_host_creation(s4u::Host const& host)
320 Container* container = new HostContainer(host, currentContainer.back());
321 const Container* root = Container::get_root();
323 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
324 VariableType* speed = container->type_->by_name_or_create("speed", "");
325 speed->set_calling_container(container);
326 speed->set_event(0, host.get_speed());
328 VariableType* cores = container->type_->by_name_or_create("core_count", "");
329 cores->set_calling_container(container);
330 cores->set_event(0, host.get_core_count());
333 if (TRACE_uncategorized())
334 container->type_->by_name_or_create("speed_used", "0.5 0.5 0.5");
336 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped()) {
337 auto* mpi = container->type_->by_name_or_create<ContainerType>("MPI");
338 mpi->by_name_or_create<StateType>("MPI_STATE");
339 // TODO See if we can move this to the LoadBalancer plugin
340 root->type_->by_name_or_create("MIGRATE_LINK", mpi, mpi);
341 mpi->by_name_or_create<StateType>("MIGRATE_STATE");
345 static void on_action_state_change(kernel::resource::Action const& action,
346 kernel::resource::Action::State /* previous */)
348 auto n = static_cast<unsigned>(action.get_variable()->get_number_of_constraint());
350 for (unsigned i = 0; i < n; i++) {
351 double value = action.get_variable()->get_value() * action.get_variable()->get_constraint_weight(i);
352 /* Beware of composite actions: ptasks put links and cpus together. Extra pb: we cannot dynamic_cast from void* */
353 kernel::resource::Resource* resource = action.get_variable()->get_constraint(i)->get_id();
354 const kernel::resource::Cpu* cpu = dynamic_cast<kernel::resource::Cpu*>(resource);
357 resource_set_utilization("HOST", "speed_used", cpu->get_cname(), action.get_category(), value,
358 action.get_last_update(), SIMIX_get_clock() - action.get_last_update());
360 const kernel::resource::LinkImpl* link = dynamic_cast<kernel::resource::LinkImpl*>(resource);
363 resource_set_utilization("LINK", "bandwidth_used", link->get_cname(), action.get_category(), value,
364 action.get_last_update(), SIMIX_get_clock() - action.get_last_update());
368 static void on_platform_created()
370 currentContainer.clear();
371 auto* filter = new std::set<std::string>();
372 XBT_DEBUG("Starting graph extraction.");
373 recursiveGraphExtraction(s4u::Engine::get_instance()->get_netzone_root(), Container::get_root(), filter);
374 XBT_DEBUG("Graph extraction finished.");
379 static void on_actor_creation(s4u::Actor const& actor)
381 const Container* root = Container::get_root();
382 Container* container = Container::by_name(actor.get_host()->get_name());
383 std::string container_name = instr_pid(actor);
385 container->create_child(container_name, "ACTOR");
386 auto* actor_type = container->type_->by_name_or_create<ContainerType>("ACTOR");
387 auto* state = actor_type->by_name_or_create<StateType>("ACTOR_STATE");
388 state->add_entity_value("suspend", "1 0 1");
389 state->add_entity_value("sleep", "1 1 0");
390 state->add_entity_value("receive", "1 0 0");
391 state->add_entity_value("send", "0 0 1");
392 state->add_entity_value("execute", "0 1 1");
393 root->type_->by_name_or_create("ACTOR_LINK", actor_type, actor_type);
395 actor.on_exit([container_name](bool failed) {
397 // kill means that this actor no longer exists, let's destroy it
398 Container::by_name(container_name)->remove_from_parent();
402 static void on_actor_host_change(s4u::Actor const& actor, s4u::Host const& /*previous_location*/)
404 static long long int counter = 0;
405 Container* container = Container::by_name(instr_pid(actor));
406 LinkType* link = Container::get_root()->get_link("ACTOR_LINK");
409 link->start_event(container, "M", std::to_string(counter));
410 // destroy existing container of this process
411 container->remove_from_parent();
412 // create new container on the new_host location
413 Container::by_name(actor.get_host()->get_name())->create_child(instr_pid(actor), "ACTOR");
415 link->end_event(Container::by_name(instr_pid(actor)), "M", std::to_string(counter));
419 static void on_vm_creation(s4u::Host const& host)
421 const Container* container = new HostContainer(host, currentContainer.back());
422 const Container* root = Container::get_root();
423 auto* vm = container->type_->by_name_or_create<ContainerType>("VM");
424 auto* state = vm->by_name_or_create<StateType>("VM_STATE");
425 state->add_entity_value("suspend", "1 0 1");
426 state->add_entity_value("sleep", "1 1 0");
427 state->add_entity_value("receive", "1 0 0");
428 state->add_entity_value("send", "0 0 1");
429 state->add_entity_value("execute", "0 1 1");
430 root->type_->by_name_or_create("VM_LINK", vm, vm);
431 root->type_->by_name_or_create("VM_ACTOR_LINK", vm, vm);
434 void define_callbacks()
436 // always need the callbacks to zones (we need only the root zone), to create the rootContainer and the rootType
438 if (TRACE_needs_platform()) {
439 s4u::Engine::on_platform_created.connect(on_platform_created);
440 s4u::Host::on_creation.connect(on_host_creation);
441 s4u::Host::on_speed_change.connect([](s4u::Host const& host) {
442 Container::by_name(host.get_name())
443 ->get_variable("speed")
444 ->set_event(surf_get_clock(), host.get_core_count() * host.get_available_speed());
446 s4u::Link::on_creation.connect(on_link_creation);
447 s4u::Link::on_bandwidth_change.connect([](s4u::Link const& link) {
448 Container::by_name(link.get_name())
449 ->get_variable("bandwidth")
450 ->set_event(surf_get_clock(), sg_bandwidth_factor * link.get_bandwidth());
452 s4u::NetZone::on_seal.connect([](s4u::NetZone const& /*netzone*/) { currentContainer.pop_back(); });
453 kernel::routing::NetPoint::on_creation.connect([](kernel::routing::NetPoint const& netpoint) {
454 if (netpoint.is_router())
455 new RouterContainer(netpoint.get_name(), currentContainer.back());
459 s4u::NetZone::on_creation.connect(on_netzone_creation);
461 kernel::resource::CpuAction::on_state_change.connect(on_action_state_change);
462 s4u::Link::on_communication_state_change.connect(on_action_state_change);
464 if (TRACE_actor_is_enabled()) {
465 s4u::Actor::on_creation.connect(on_actor_creation);
466 s4u::Actor::on_destruction.connect([](s4u::Actor const& actor) {
467 auto container = Container::by_name_or_null(instr_pid(actor));
468 if (container != nullptr)
469 container->remove_from_parent();
471 s4u::Actor::on_suspend.connect([](s4u::Actor const& actor) {
472 Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->push_event("suspend");
474 s4u::Actor::on_resume.connect(
475 [](s4u::Actor const& actor) { Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->pop_event(); });
476 s4u::Actor::on_sleep.connect([](s4u::Actor const& actor) {
477 Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->push_event("sleep");
479 s4u::Actor::on_wake_up.connect(
480 [](s4u::Actor const& actor) { Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->pop_event(); });
481 s4u::Exec::on_start.connect([](simgrid::s4u::Actor const& actor, s4u::Exec const&) {
482 Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->push_event("execute");
484 s4u::Exec::on_completion.connect([](s4u::Actor const& actor, s4u::Exec const&) {
485 Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->pop_event();
487 s4u::Comm::on_sender_start.connect([](s4u::Actor const& actor) {
488 Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->push_event("send");
490 s4u::Comm::on_receiver_start.connect([](s4u::Actor const& actor) {
491 Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->push_event("receive");
493 s4u::Comm::on_completion.connect(
494 [](s4u::Actor const& actor) { Container::by_name(instr_pid(actor))->get_state("ACTOR_STATE")->pop_event(); });
495 s4u::Actor::on_host_change.connect(on_actor_host_change);
498 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_computing()) {
499 s4u::Exec::on_start.connect([](simgrid::s4u::Actor const& actor, s4u::Exec const& exec) {
500 Container::by_name(std::string("rank-") + std::to_string(actor.get_pid()))
501 ->get_state("MPI_STATE")
502 ->push_event("computing", new CpuTIData("compute", exec.get_cost()));
504 s4u::Exec::on_completion.connect([](s4u::Actor const& actor, s4u::Exec const&) {
505 Container::by_name(std::string("rank-") + std::to_string(actor.get_pid()))->get_state("MPI_STATE")->pop_event();
509 if (TRACE_vm_is_enabled()) {
510 s4u::Host::on_creation.connect(on_vm_creation);
511 s4u::VirtualMachine::on_start.connect([](s4u::VirtualMachine const& vm) {
512 Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("start");
514 s4u::VirtualMachine::on_started.connect(
515 [](s4u::VirtualMachine const& vm) { Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event(); });
516 s4u::VirtualMachine::on_suspend.connect([](s4u::VirtualMachine const& vm) {
517 Container::by_name(vm.get_name())->get_state("VM_STATE")->push_event("suspend");
519 s4u::VirtualMachine::on_resume.connect(
520 [](s4u::VirtualMachine const& vm) { Container::by_name(vm.get_name())->get_state("VM_STATE")->pop_event(); });
521 s4u::Host::on_destruction.connect(
522 [](s4u::Host const& host) { Container::by_name(host.get_name())->remove_from_parent(); });
526 } // namespace simgrid