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<simgrid::instr::NetZoneContainer*> 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() +
100 std::to_string(src->type_->getId()) + "-" + dst->type_->getName() +
101 std::to_string(dst->type_->getId());
102 simgrid::instr::LinkType* link = father->type_->getOrCreateLinkType(link_typename, src->type_, dst->type_);
104 //register EDGE types for triva configuration
105 trivaEdgeTypes.insert(link->getName());
108 static long long counter = 0;
110 std::string key = std::to_string(counter);
113 link->startEvent(father, src, "topology", key);
114 link->endEvent(father, dst, "topology", key);
116 XBT_DEBUG(" linkContainers %s <-> %s", src->getCname(), dst->getCname());
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 (simgrid::instr::Container::getRootContainer() == nullptr) {
158 simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
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 root->type_->getOrCreateLinkType("MPI_LINK", mpi, mpi);
167 if (TRACE_needs_platform()){
168 currentContainer.push_back(root);
173 if (TRACE_needs_platform()){
174 simgrid::instr::NetZoneContainer* container =
175 new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
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(), "LINK", father);
195 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
196 simgrid::instr::VariableType* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
197 bandwidth->setCallingContainer(container);
198 bandwidth->setEvent(0, link.bandwidth());
199 simgrid::instr::VariableType* latency = container->type_->getOrCreateVariableType("latency", "");
200 latency->setCallingContainer(container);
201 latency->setEvent(0, link.latency());
203 if (TRACE_uncategorized()) {
204 container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
208 static void sg_instr_new_host(simgrid::s4u::Host& host)
210 container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
211 container_t root = simgrid::instr::Container::getRootContainer();
213 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
214 simgrid::instr::VariableType* power = container->type_->getOrCreateVariableType("power", "");
215 power->setCallingContainer(container);
216 power->setEvent(0, host.getSpeed());
219 if (TRACE_uncategorized())
220 container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
222 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped())
223 container->type_->getOrCreateContainerType("MPI")->getOrCreateStateType("MPI_STATE");
225 if (TRACE_msg_process_is_enabled()) {
226 simgrid::instr::ContainerType* msg_process = container->type_->getOrCreateContainerType("MSG_PROCESS");
227 simgrid::instr::StateType* state = msg_process->getOrCreateStateType("MSG_PROCESS_STATE");
228 state->addEntityValue("suspend", "1 0 1");
229 state->addEntityValue("sleep", "1 1 0");
230 state->addEntityValue("receive", "1 0 0");
231 state->addEntityValue("send", "0 0 1");
232 state->addEntityValue("task_execute", "0 1 1");
233 root->type_->getOrCreateLinkType("MSG_PROCESS_LINK", msg_process, msg_process);
234 root->type_->getOrCreateLinkType("MSG_PROCESS_TASK_LINK", msg_process, msg_process);
237 if (TRACE_msg_vm_is_enabled()) {
238 simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
239 simgrid::instr::StateType* state = msg_vm->getOrCreateStateType("MSG_VM_STATE");
240 state->addEntityValue("suspend", "1 0 1");
241 state->addEntityValue("sleep", "1 1 0");
242 state->addEntityValue("receive", "1 0 0");
243 state->addEntityValue("send", "0 0 1");
244 state->addEntityValue("task_execute", "0 1 1");
245 root->type_->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
246 root->type_->getOrCreateLinkType("MSG_VM_PROCESS_LINK", msg_vm, msg_vm);
250 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
252 if (netpoint->isRouter() && TRACE_is_enabled() && TRACE_needs_platform())
253 new simgrid::instr::RouterContainer(netpoint->getCname(), currentContainer.back());
256 static void instr_routing_parse_end_platform ()
258 currentContainer.clear();
259 std::set<std::string>* filter = new std::set<std::string>;
260 XBT_DEBUG ("Starting graph extraction.");
261 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(),
262 simgrid::instr::Container::getRootContainer(), filter);
263 XBT_DEBUG ("Graph extraction finished.");
265 platform_created = 1;
266 TRACE_paje_dump_buffer(true);
269 void instr_routing_define_callbacks ()
271 // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
272 if (not TRACE_is_enabled())
274 if (TRACE_needs_platform()) {
275 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
276 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
277 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
279 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
280 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
281 simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
284 * user categories support
286 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
288 if (root->getName() == "HOST" || root->getName() == "MSG_VM")
289 root->getOrCreateVariableType(std::string("p") + new_typename, color);
291 if (root->getName() == "LINK")
292 root->getOrCreateVariableType(std::string("b") + new_typename, color);
294 for (auto elm : root->children_) {
295 recursiveNewVariableType(new_typename, color, elm.second);
299 void instr_new_variable_type(std::string new_typename, std::string color)
301 recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRootContainer()->type_);
304 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
305 simgrid::instr::Type* root)
307 if (root->getName() == father_type) {
308 root->getOrCreateVariableType(new_typename, color);
310 for (auto elm : root->children_)
311 recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
314 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
316 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRootContainer()->type_);
319 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
321 if (root->getName() == father_type)
322 root->getOrCreateStateType(new_typename);
324 for (auto elm : root->children_)
325 recursiveNewUserStateType(father_type, new_typename, elm.second);
328 void instr_new_user_state_type(std::string father_type, std::string new_typename)
330 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRootContainer()->type_);
333 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
334 simgrid::instr::Type* root)
336 if (root->getName() == type_name)
337 static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
339 for (auto elm : root->children_)
340 recursiveNewValueForUserStateType(type_name, val, color, elm.second);
343 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
345 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRootContainer()->type_);
348 int instr_platform_traced ()
350 return platform_created;
353 #define GRAPHICATOR_SUPPORT_FUNCTIONS
355 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
356 std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
357 container_t container)
359 if (not netzone->getChildren()->empty()) {
360 //bottom-up recursion
361 for (auto const& netzone_child : *netzone->getChildren()) {
362 container_t child_container = container->children_.at(netzone_child->getCname());
363 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
367 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
370 xbt_graph_t instr_routing_platform_graph ()
372 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
373 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
374 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
375 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
376 simgrid::instr::Container::getRootContainer());
382 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
384 unsigned int cursor = 0;
385 xbt_node_t node = nullptr;
386 xbt_edge_t edge = nullptr;
388 FILE *file = fopen(filename, "w");
389 xbt_assert(file, "Failed to open %s \n", filename);
392 fprintf(file, "digraph test {\n");
394 fprintf(file, "graph test {\n");
396 fprintf(file, " graph [overlap=scale]\n");
398 fprintf(file, " node [shape=box, style=filled]\n");
399 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
401 xbt_dynar_foreach(g->nodes, cursor, node) {
402 fprintf(file, " \"%s\";\n", instr_node_name(node));
404 xbt_dynar_foreach(g->edges, cursor, edge) {
405 const char *src_s = instr_node_name (edge->src);
406 const char *dst_s = instr_node_name (edge->dst);
408 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
410 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
412 fprintf(file, "}\n");