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->name_ == "__loopback__" || dst->name_ == "__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->name_ + dst->name_;
84 std::string aux2 = dst->name_ + src->name_;
85 if (filter->find(aux1) != filter->end()) {
86 XBT_DEBUG(" linkContainers: already registered %s <-> %s (1)", src->name_.c_str(), dst->name_.c_str());
89 if (filter->find(aux2) != filter->end()) {
90 XBT_DEBUG(" linkContainers: already registered %s <-> %s (2)", dst->name_.c_str(), src->name_.c_str());
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 char key[INSTR_DEFAULT_STR_SIZE];
110 snprintf (key, INSTR_DEFAULT_STR_SIZE, "%lld", counter);
113 new simgrid::instr::StartLinkEvent(SIMIX_get_clock(), father, link_type, src, "topology", key);
114 new simgrid::instr::EndLinkEvent(SIMIX_get_clock(), father, link_type, dst, "topology", key);
116 XBT_DEBUG(" linkContainers %s <-> %s", src->name_.c_str(), dst->name_.c_str());
119 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
120 std::set<std::string>* filter)
122 if (not TRACE_platform_topology()) {
123 XBT_DEBUG("Graph extraction disabled by user.");
126 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
127 if (not netzone->getChildren()->empty()) {
128 //bottom-up recursion
129 for (auto const& nz_son : *netzone->getChildren()) {
130 container_t child_container = container->children_.at(nz_son->getCname());
131 recursiveGraphExtraction(nz_son, child_container, filter);
135 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
136 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
137 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
139 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
140 for (auto elm : *edges) {
141 xbt_edge_t edge = elm.second;
142 linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
143 simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
147 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
153 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
155 std::string id = netzone.getName();
157 if (PJ_container_get_root() == nullptr){
158 container_t root = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, nullptr);
159 PJ_container_set_root (root);
161 if (TRACE_smpi_is_enabled()) {
162 simgrid::instr::Type* mpi = root->type_->getOrCreateContainerType("MPI");
163 if (not TRACE_smpi_is_grouped())
164 mpi->getOrCreateStateType("MPI_STATE");
165 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MPI_LINK", mpi, mpi);
168 if (TRACE_needs_platform()){
169 currentContainer.push_back(root);
174 if (TRACE_needs_platform()){
175 container_t father = currentContainer.back();
176 container_t container = new simgrid::instr::Container(id, simgrid::instr::INSTR_AS, father);
177 currentContainer.push_back(container);
181 static void sg_instr_AS_end(simgrid::s4u::NetZone& /*netzone*/)
183 if (TRACE_needs_platform()){
184 currentContainer.pop_back();
188 static void instr_routing_parse_start_link(simgrid::s4u::Link& link)
190 if (currentContainer.empty()) // No ongoing parsing. Are you creating the loopback?
192 container_t father = currentContainer.back();
194 double bandwidth_value = link.bandwidth();
195 double latency_value = link.latency();
197 container_t container = new simgrid::instr::Container(link.getCname(), simgrid::instr::INSTR_LINK, father);
199 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
200 simgrid::instr::Type* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
201 simgrid::instr::Type* latency = container->type_->getOrCreateVariableType("latency", "");
202 new simgrid::instr::SetVariableEvent(0, container, bandwidth, bandwidth_value);
203 new simgrid::instr::SetVariableEvent(0, container, latency, latency_value);
205 if (TRACE_uncategorized()) {
206 container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
210 static void sg_instr_new_host(simgrid::s4u::Host& host)
212 container_t father = currentContainer.back();
213 container_t container = new simgrid::instr::Container(host.getCname(), simgrid::instr::INSTR_HOST, father);
215 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
216 simgrid::instr::Type* speed = container->type_->getOrCreateVariableType("power", "");
218 double current_speed_state = host.getSpeed();
219 new simgrid::instr::SetVariableEvent(0, container, speed, current_speed_state);
221 if (TRACE_uncategorized())
222 container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
224 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped())
225 container->type_->getOrCreateContainerType("MPI")->getOrCreateStateType("MPI_STATE");
227 if (TRACE_msg_process_is_enabled()) {
228 simgrid::instr::Type* msg_process = container->type_->getOrCreateContainerType("MSG_PROCESS");
229 simgrid::instr::Type* state = msg_process->getOrCreateStateType("MSG_PROCESS_STATE");
230 simgrid::instr::Value::byNameOrCreate("suspend", "1 0 1", state);
231 simgrid::instr::Value::byNameOrCreate("sleep", "1 1 0", state);
232 simgrid::instr::Value::byNameOrCreate("receive", "1 0 0", state);
233 simgrid::instr::Value::byNameOrCreate("send", "0 0 1", state);
234 simgrid::instr::Value::byNameOrCreate("task_execute", "0 1 1", state);
235 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_PROCESS_LINK", msg_process, msg_process);
236 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_PROCESS_TASK_LINK", msg_process, msg_process);
239 if (TRACE_msg_vm_is_enabled()) {
240 simgrid::instr::Type* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
241 simgrid::instr::Type* state = msg_vm->getOrCreateStateType("MSG_VM_STATE");
242 simgrid::instr::Value::byNameOrCreate("suspend", "1 0 1", state);
243 simgrid::instr::Value::byNameOrCreate("sleep", "1 1 0", state);
244 simgrid::instr::Value::byNameOrCreate("receive", "1 0 0", state);
245 simgrid::instr::Value::byNameOrCreate("send", "0 0 1", state);
246 simgrid::instr::Value::byNameOrCreate("task_execute", "0 1 1", state);
247 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
248 simgrid::instr::Type::getRootType()->getOrCreateLinkType("MSG_VM_PROCESS_LINK", msg_vm, msg_vm);
252 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
254 if (not netpoint->isRouter())
256 if (TRACE_is_enabled() && TRACE_needs_platform()) {
257 container_t father = currentContainer.back();
258 new simgrid::instr::Container(netpoint->getCname(), simgrid::instr::INSTR_ROUTER, father);
262 static void instr_routing_parse_end_platform ()
264 currentContainer.clear();
265 std::set<std::string>* filter = new std::set<std::string>;
266 XBT_DEBUG ("Starting graph extraction.");
267 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), PJ_container_get_root(), filter);
268 XBT_DEBUG ("Graph extraction finished.");
270 platform_created = 1;
271 TRACE_paje_dump_buffer(true);
274 void instr_routing_define_callbacks ()
276 // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
277 if (not TRACE_is_enabled())
279 if (TRACE_needs_platform()) {
280 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
281 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
282 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
284 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
285 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
286 simgrid::kernel::routing::NetPoint::onCreation.connect(&sg_instr_new_router);
289 * user categories support
291 static void recursiveNewVariableType(const char* new_typename, const char* color, simgrid::instr::Type* root)
293 if (root->getName() == "HOST" || root->getName() == "MSG_VM")
294 root->getOrCreateVariableType(std::string("p") + new_typename, color == nullptr ? "" : color);
296 if (root->getName() == "LINK")
297 root->getOrCreateVariableType(std::string("b") + new_typename, color == nullptr ? "" : color);
299 for (auto elm : root->children_) {
300 recursiveNewVariableType(new_typename, color == nullptr ? "" : color, elm.second);
304 void instr_new_variable_type (const char *new_typename, const char *color)
306 recursiveNewVariableType(new_typename, color, simgrid::instr::Type::getRootType());
309 static void recursiveNewUserVariableType(const char* father_type, const char* new_typename, const char* color,
310 simgrid::instr::Type* root)
312 if (root->getName() == father_type) {
313 root->getOrCreateVariableType(new_typename, color == nullptr ? "" : color);
315 for (auto elm : root->children_)
316 recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
319 void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color)
321 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Type::getRootType());
324 static void recursiveNewUserStateType(const char* father_type, const char* new_typename, simgrid::instr::Type* root)
326 if (root->getName() == father_type) {
327 root->getOrCreateStateType(new_typename);
329 for (auto elm : root->children_)
330 recursiveNewUserStateType(father_type, new_typename, elm.second);
333 void instr_new_user_state_type (const char *father_type, const char *new_typename)
335 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Type::getRootType());
338 static void recursiveNewValueForUserStateType(const char* type_name, const char* val, const char* color,
339 simgrid::instr::Type* root)
341 if (root->getName() == type_name)
342 simgrid::instr::Value::byNameOrCreate(val, color, root);
344 for (auto elm : root->children_)
345 recursiveNewValueForUserStateType(type_name, val, color, elm.second);
348 void instr_new_value_for_user_state_type (const char *type_name, const char *value, const char *color)
350 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Type::getRootType());
353 int instr_platform_traced ()
355 return platform_created;
358 #define GRAPHICATOR_SUPPORT_FUNCTIONS
360 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
361 std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
362 container_t container)
364 if (not netzone->getChildren()->empty()) {
365 //bottom-up recursion
366 for (auto const& netzone_child : *netzone->getChildren()) {
367 container_t child_container = container->children_.at(netzone_child->getCname());
368 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
372 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
375 xbt_graph_t instr_routing_platform_graph ()
377 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
378 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
379 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
380 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
381 PJ_container_get_root());
387 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
389 unsigned int cursor = 0;
390 xbt_node_t node = nullptr;
391 xbt_edge_t edge = nullptr;
393 FILE *file = fopen(filename, "w");
394 xbt_assert(file, "Failed to open %s \n", filename);
397 fprintf(file, "digraph test {\n");
399 fprintf(file, "graph test {\n");
401 fprintf(file, " graph [overlap=scale]\n");
403 fprintf(file, " node [shape=box, style=filled]\n");
404 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
406 xbt_dynar_foreach(g->nodes, cursor, node) {
407 fprintf(file, " \"%s\";\n", instr_node_name(node));
409 xbt_dynar_foreach(g->edges, cursor, edge) {
410 const char *src_s = instr_node_name (edge->src);
411 const char *dst_s = instr_node_name (edge->dst);
413 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
415 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
417 fprintf(file, "}\n");