1 /* Copyright (c) 2010-2017. 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/s4u/Engine.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/kernel/routing/NetZoneImpl.hpp"
11 #include "src/kernel/routing/NetPoint.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "surf/surf.h"
15 #include "xbt/graph.h"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_routing, instr, "Tracing platform hierarchy");
19 static int platform_created = 0; /* indicate whether the platform file has been traced */
20 static std::vector<container_t> currentContainer; /* push and pop, used only in creation */
22 static const char *instr_node_name (xbt_node_t node)
24 void *data = xbt_graph_node_get_data(node);
25 return static_cast<char*>(data);
28 static container_t lowestCommonAncestor (container_t a1, container_t a2)
30 //this is only an optimization (since most of a1 and a2 share the same parent)
31 if (a1->father_ == a2->father_)
34 //create an array with all ancestors of a1
35 std::vector<container_t> ancestors_a1;
36 container_t p = a1->father_;
38 ancestors_a1.push_back(p);
42 //create an array with all ancestors of a2
43 std::vector<container_t> ancestors_a2;
46 ancestors_a2.push_back(p);
50 //find the lowest ancestor
52 int i = ancestors_a1.size() - 1;
53 int j = ancestors_a2.size() - 1;
54 while (i >= 0 && j >= 0){
55 container_t a1p = ancestors_a1.at(i);
56 container_t a2p = ancestors_a2.at(j);
68 static void linkContainers(container_t src, container_t dst, std::set<std::string>* filter)
71 if (src->getName() == "__loopback__" || dst->getName() == "__loopback__") {
72 XBT_DEBUG (" linkContainers: ignoring loopback link");
77 container_t father = lowestCommonAncestor (src, dst);
79 xbt_die ("common father unknown, this is a tracing problem");
82 // check if we already register this pair (we only need one direction)
83 std::string aux1 = src->getName() + dst->getName();
84 std::string aux2 = dst->getName() + src->getName();
85 if (filter->find(aux1) != filter->end()) {
86 XBT_DEBUG(" linkContainers: already registered %s <-> %s (1)", src->getCname(), dst->getCname());
89 if (filter->find(aux2) != filter->end()) {
90 XBT_DEBUG(" linkContainers: already registered %s <-> %s (2)", dst->getCname(), src->getCname());
94 // ok, not found, register it
99 std::string link_typename = father->type_->getName() + "-" + src->type_->getName() + src->type_->getId() + "-" +
100 dst->type_->getName() + dst->type_->getId();
101 simgrid::instr::Type* link_type = father->type_->getOrCreateLinkType(link_typename, src->type_, dst->type_);
103 //register EDGE types for triva configuration
104 trivaEdgeTypes.insert(link_type->getName());
107 static long long counter = 0;
109 std::string key = std::to_string(counter);
112 new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
113 new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
115 XBT_DEBUG(" linkContainers %s <-> %s", src->getCname(), dst->getCname());
118 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
119 std::set<std::string>* filter)
121 if (not TRACE_platform_topology()) {
122 XBT_DEBUG("Graph extraction disabled by user.");
125 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
126 if (not netzone->getChildren()->empty()) {
127 //bottom-up recursion
128 for (auto const& nz_son : *netzone->getChildren()) {
129 container_t child_container = container->children_.at(nz_son->getCname());
130 recursiveGraphExtraction(nz_son, child_container, filter);
134 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
135 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
136 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
138 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
139 for (auto elm : *edges) {
140 xbt_edge_t edge = elm.second;
141 linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
142 simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
146 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
152 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
154 std::string id = netzone.getName();
156 if (PJ_container_get_root() == nullptr){
157 container_t root = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, nullptr);
158 PJ_container_set_root (root);
160 if (TRACE_smpi_is_enabled()) {
161 simgrid::instr::Type* mpi = root->type_->getOrCreateContainerType("MPI");
162 if (not TRACE_smpi_is_grouped())
163 mpi->getOrCreateStateType("MPI_STATE");
164 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MPI_LINK", mpi, mpi);
167 if (TRACE_needs_platform()){
168 currentContainer.push_back(root);
173 if (TRACE_needs_platform()){
174 container_t father = currentContainer.back();
175 container_t container = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, father);
176 currentContainer.push_back(container);
180 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
182 if (TRACE_needs_platform()){
183 currentContainer.pop_back();
187 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
189 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
192 container_t father = currentContainer.back();
193 container_t container = new simgrid::instr::Container(link.getName(), simgrid::instr::INSTR_LINK, father);
195 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
196 simgrid::instr::Type* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
197 simgrid::instr::Type* latency = container->type_->getOrCreateVariableType("latency", "");
198 new simgrid::instr::SetVariableEvent(0, container, bandwidth, link.bandwidth());
199 new simgrid::instr::SetVariableEvent(0, container, latency, link.latency());
201 if (TRACE_uncategorized()) {
202 container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
206 static void sg_instr_new_host(simgrid::s4u::Host& host)
208 container_t father = currentContainer.back();
209 container_t container = new simgrid::instr::Container(host.getName(), simgrid::instr::INSTR_HOST, father);
211 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
212 simgrid::instr::Type* speed = container->type_->getOrCreateVariableType("power", "");
213 new simgrid::instr::SetVariableEvent(0, container, speed, host.getSpeed());
216 if (TRACE_uncategorized())
217 container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
219 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped())
220 container->type_->getOrCreateContainerType("MPI")->getOrCreateStateType("MPI_STATE");
222 if (TRACE_msg_process_is_enabled()) {
223 simgrid::instr::Type* msg_process = container->type_->getOrCreateContainerType("MSG_PROCESS");
224 simgrid::instr::Type* state = msg_process->getOrCreateStateType("MSG_PROCESS_STATE");
225 state->addEntityValue("suspend", "1 0 1");
226 state->addEntityValue("sleep", "1 1 0");
227 state->addEntityValue("receive", "1 0 0");
228 state->addEntityValue("send", "0 0 1");
229 state->addEntityValue("task_execute", "0 1 1");
230 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_PROCESS_LINK", msg_process, msg_process);
231 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_PROCESS_TASK_LINK", msg_process, msg_process);
234 if (TRACE_msg_vm_is_enabled()) {
235 simgrid::instr::Type* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
236 simgrid::instr::Type* state = msg_vm->getOrCreateStateType("MSG_VM_STATE");
237 state->addEntityValue("suspend", "1 0 1");
238 state->addEntityValue("sleep", "1 1 0");
239 state->addEntityValue("receive", "1 0 0");
240 state->addEntityValue("send", "0 0 1");
241 state->addEntityValue("task_execute", "0 1 1");
242 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
243 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_VM_PROCESS_LINK", msg_vm, msg_vm);
247 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
249 if (not netpoint->isRouter())
251 if (TRACE_is_enabled() && TRACE_needs_platform())
252 new simgrid::instr::Container(netpoint->getCname(), simgrid::instr::INSTR_ROUTER, currentContainer.back());
255 static void instr_routing_parse_end_platform ()
257 currentContainer.clear();
258 std::set<std::string>* filter = new std::set<std::string>;
259 XBT_DEBUG ("Starting graph extraction.");
260 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
261 XBT_DEBUG ("Graph extraction finished.");
263 platform_created = 1;
264 TRACE_paje_dump_buffer(true);
267 void instr_routing_define_callbacks ()
269 // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
270 if (not TRACE_is_enabled())
272 if (TRACE_needs_platform()) {
273 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
274 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
275 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
277 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
278 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
279 simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
282 * user categories support
284 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
286 if (root->getName() == "HOST" || root->getName() == "MSG_VM")
287 root->getOrCreateVariableType(std::string("p") + new_typename, color);
289 if (root->getName() == "LINK")
290 root->getOrCreateVariableType(std::string("b") + new_typename, color);
292 for (auto elm : root->children_) {
293 recursiveNewVariableType(new_typename, color, elm.second);
297 void instr_new_variable_type(std::string new_typename, std::string color)
299 recursiveNewVariableType(new_typename, color, simgrid::instr::Type::getRootType());
302 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
303 simgrid::instr::Type* root)
305 if (root->getName() == father_type) {
306 root->getOrCreateVariableType(new_typename, color);
308 for (auto elm : root->children_)
309 recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
312 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
314 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Type::getRootType());
317 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
319 if (root->getName() == father_type) {
320 root->getOrCreateStateType(new_typename);
322 for (auto elm : root->children_)
323 recursiveNewUserStateType(father_type, new_typename, elm.second);
326 void instr_new_user_state_type(std::string father_type, std::string new_typename)
328 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Type::getRootType());
331 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
332 simgrid::instr::Type* root)
334 if (root->getName() == type_name)
335 root->addEntityValue(val, color);
337 for (auto elm : root->children_)
338 recursiveNewValueForUserStateType(type_name, val, color, elm.second);
341 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
343 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Type::getRootType());
346 int instr_platform_traced ()
348 return platform_created;
351 #define GRAPHICATOR_SUPPORT_FUNCTIONS
353 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
354 std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
355 container_t container)
357 if (not netzone->getChildren()->empty()) {
358 //bottom-up recursion
359 for (auto const& netzone_child : *netzone->getChildren()) {
360 container_t child_container = container->children_.at(netzone_child->getCname());
361 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
365 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
368 xbt_graph_t instr_routing_platform_graph ()
370 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
371 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
372 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
373 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
374 PJ_container_get_root());
380 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
382 unsigned int cursor = 0;
383 xbt_node_t node = nullptr;
384 xbt_edge_t edge = nullptr;
386 FILE *file = fopen(filename, "w");
387 xbt_assert(file, "Failed to open %s \n", filename);
390 fprintf(file, "digraph test {\n");
392 fprintf(file, "graph test {\n");
394 fprintf(file, " graph [overlap=scale]\n");
396 fprintf(file, " node [shape=box, style=filled]\n");
397 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
399 xbt_dynar_foreach(g->nodes, cursor, node) {
400 fprintf(file, " \"%s\";\n", instr_node_name(node));
402 xbt_dynar_foreach(g->edges, cursor, edge) {
403 const char *src_s = instr_node_name (edge->src);
404 const char *dst_s = instr_node_name (edge->dst);
406 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
408 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
410 fprintf(file, "}\n");