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/NetPoint.hpp"
11 #include "src/kernel/routing/NetZoneImpl.hpp"
12 #include "src/surf/network_interface.hpp"
13 #include "src/surf/xml/platf_private.hpp"
14 #include "surf/surf.hpp"
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_);
103 link->setCallingContainer(father);
105 //register EDGE types for triva configuration
106 trivaEdgeTypes.insert(link->getName());
109 static long long counter = 0;
111 std::string key = std::to_string(counter);
114 link->startEvent(src, "topology", key);
115 link->endEvent(dst, "topology", key);
117 XBT_DEBUG(" linkContainers %s <-> %s", src->getCname(), dst->getCname());
120 static void recursiveGraphExtraction(simgrid::s4u::NetZone* netzone, container_t container,
121 std::set<std::string>* filter)
123 if (not TRACE_platform_topology()) {
124 XBT_DEBUG("Graph extraction disabled by user.");
127 XBT_DEBUG("Graph extraction for NetZone = %s", netzone->getCname());
128 if (not netzone->getChildren()->empty()) {
129 //bottom-up recursion
130 for (auto const& nz_son : *netzone->getChildren()) {
131 container_t child_container = container->children_.at(nz_son->getCname());
132 recursiveGraphExtraction(nz_son, child_container, filter);
136 xbt_graph_t graph = xbt_graph_new_graph (0, nullptr);
137 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
138 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
140 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
141 for (auto elm : *edges) {
142 xbt_edge_t edge = elm.second;
143 linkContainers(simgrid::instr::Container::byName(static_cast<const char*>(edge->src->data)),
144 simgrid::instr::Container::byName(static_cast<const char*>(edge->dst->data)), filter);
148 xbt_graph_free_graph(graph, xbt_free_f, xbt_free_f, nullptr);
154 static void sg_instr_AS_begin(simgrid::s4u::NetZone& netzone)
156 std::string id = netzone.getName();
158 if (simgrid::instr::Container::getRoot() == nullptr) {
159 simgrid::instr::NetZoneContainer* root = new simgrid::instr::NetZoneContainer(id, 0, nullptr);
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 root->type_->getOrCreateLinkType("MPI_LINK", mpi, mpi);
168 if (TRACE_needs_platform()){
169 currentContainer.push_back(root);
174 if (TRACE_needs_platform()){
175 simgrid::instr::NetZoneContainer* container =
176 new simgrid::instr::NetZoneContainer(id, currentContainer.size(), currentContainer.back());
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?
193 container_t father = currentContainer.back();
194 container_t container = new simgrid::instr::Container(link.getName(), "LINK", father);
196 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_link())) {
197 simgrid::instr::VariableType* bandwidth = container->type_->getOrCreateVariableType("bandwidth", "");
198 bandwidth->setCallingContainer(container);
199 bandwidth->setEvent(0, link.bandwidth());
200 simgrid::instr::VariableType* latency = container->type_->getOrCreateVariableType("latency", "");
201 latency->setCallingContainer(container);
202 latency->setEvent(0, link.latency());
204 if (TRACE_uncategorized()) {
205 container->type_->getOrCreateVariableType("bandwidth_used", "0.5 0.5 0.5");
209 static void sg_instr_new_host(simgrid::s4u::Host& host)
211 container_t container = new simgrid::instr::HostContainer(host, currentContainer.back());
212 container_t root = simgrid::instr::Container::getRoot();
214 if ((TRACE_categorized() || TRACE_uncategorized() || TRACE_platform()) && (not TRACE_disable_speed())) {
215 simgrid::instr::VariableType* power = container->type_->getOrCreateVariableType("power", "");
216 power->setCallingContainer(container);
217 power->setEvent(0, host.getSpeed());
220 if (TRACE_uncategorized())
221 container->type_->getOrCreateVariableType("power_used", "0.5 0.5 0.5");
223 if (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped())
224 container->type_->getOrCreateContainerType("MPI")->getOrCreateStateType("MPI_STATE");
226 if (TRACE_msg_process_is_enabled()) {
227 simgrid::instr::ContainerType* msg_process = container->type_->getOrCreateContainerType("MSG_PROCESS");
228 simgrid::instr::StateType* state = msg_process->getOrCreateStateType("MSG_PROCESS_STATE");
229 state->addEntityValue("suspend", "1 0 1");
230 state->addEntityValue("sleep", "1 1 0");
231 state->addEntityValue("receive", "1 0 0");
232 state->addEntityValue("send", "0 0 1");
233 state->addEntityValue("task_execute", "0 1 1");
234 root->type_->getOrCreateLinkType("MSG_PROCESS_LINK", msg_process, msg_process);
235 root->type_->getOrCreateLinkType("MSG_PROCESS_TASK_LINK", msg_process, msg_process);
238 if (TRACE_msg_vm_is_enabled()) {
239 simgrid::instr::ContainerType* msg_vm = container->type_->getOrCreateContainerType("MSG_VM");
240 simgrid::instr::StateType* state = msg_vm->getOrCreateStateType("MSG_VM_STATE");
241 state->addEntityValue("suspend", "1 0 1");
242 state->addEntityValue("sleep", "1 1 0");
243 state->addEntityValue("receive", "1 0 0");
244 state->addEntityValue("send", "0 0 1");
245 state->addEntityValue("task_execute", "0 1 1");
246 root->type_->getOrCreateLinkType("MSG_VM_LINK", msg_vm, msg_vm);
247 root->type_->getOrCreateLinkType("MSG_VM_PROCESS_LINK", msg_vm, msg_vm);
251 static void sg_instr_new_router(simgrid::kernel::routing::NetPoint * netpoint)
253 if (netpoint->isRouter() && TRACE_is_enabled() && TRACE_needs_platform())
254 new simgrid::instr::RouterContainer(netpoint->getCname(), currentContainer.back());
257 static void instr_routing_parse_end_platform ()
259 currentContainer.clear();
260 std::set<std::string>* filter = new std::set<std::string>;
261 XBT_DEBUG ("Starting graph extraction.");
262 recursiveGraphExtraction(simgrid::s4u::Engine::getInstance()->getNetRoot(), simgrid::instr::Container::getRoot(),
264 XBT_DEBUG ("Graph extraction finished.");
266 platform_created = 1;
267 TRACE_paje_dump_buffer(true);
270 void instr_routing_define_callbacks ()
272 // always need the callbacks to ASes (we need only the root AS), to create the rootContainer and the rootType properly
273 if (not TRACE_is_enabled())
275 if (TRACE_needs_platform()) {
276 simgrid::s4u::Link::onCreation.connect(instr_routing_parse_start_link);
277 simgrid::s4u::onPlatformCreated.connect(instr_routing_parse_end_platform);
278 simgrid::s4u::Host::onCreation.connect(sg_instr_new_host);
280 simgrid::s4u::NetZone::onCreation.connect(sg_instr_AS_begin);
281 simgrid::s4u::NetZone::onSeal.connect(sg_instr_AS_end);
282 simgrid::kernel::routing::NetPoint::onCreation.connect(sg_instr_new_router);
285 * user categories support
287 static void recursiveNewVariableType(std::string new_typename, std::string color, simgrid::instr::Type* root)
289 if (root->getName() == "HOST" || root->getName() == "MSG_VM")
290 root->getOrCreateVariableType(std::string("p") + new_typename, color);
292 if (root->getName() == "LINK")
293 root->getOrCreateVariableType(std::string("b") + new_typename, color);
295 for (auto elm : root->children_) {
296 recursiveNewVariableType(new_typename, color, elm.second);
300 void instr_new_variable_type(std::string new_typename, std::string color)
302 recursiveNewVariableType(new_typename, color, simgrid::instr::Container::getRoot()->type_);
305 static void recursiveNewUserVariableType(std::string father_type, std::string new_typename, std::string color,
306 simgrid::instr::Type* root)
308 if (root->getName() == father_type) {
309 root->getOrCreateVariableType(new_typename, color);
311 for (auto elm : root->children_)
312 recursiveNewUserVariableType(father_type, new_typename, color, elm.second);
315 void instr_new_user_variable_type(std::string father_type, std::string new_typename, std::string color)
317 recursiveNewUserVariableType(father_type, new_typename, color, simgrid::instr::Container::getRoot()->type_);
320 static void recursiveNewUserStateType(std::string father_type, std::string new_typename, simgrid::instr::Type* root)
322 if (root->getName() == father_type)
323 root->getOrCreateStateType(new_typename);
325 for (auto elm : root->children_)
326 recursiveNewUserStateType(father_type, new_typename, elm.second);
329 void instr_new_user_state_type(std::string father_type, std::string new_typename)
331 recursiveNewUserStateType(father_type, new_typename, simgrid::instr::Container::getRoot()->type_);
334 static void recursiveNewValueForUserStateType(std::string type_name, const char* val, std::string color,
335 simgrid::instr::Type* root)
337 if (root->getName() == type_name)
338 static_cast<simgrid::instr::StateType*>(root)->addEntityValue(val, color);
340 for (auto elm : root->children_)
341 recursiveNewValueForUserStateType(type_name, val, color, elm.second);
344 void instr_new_value_for_user_state_type(std::string type_name, const char* value, std::string color)
346 recursiveNewValueForUserStateType(type_name, value, color, simgrid::instr::Container::getRoot()->type_);
349 int instr_platform_traced ()
351 return platform_created;
354 #define GRAPHICATOR_SUPPORT_FUNCTIONS
356 static void recursiveXBTGraphExtraction(xbt_graph_t graph, std::map<std::string, xbt_node_t>* nodes,
357 std::map<std::string, xbt_edge_t>* edges, sg_netzone_t netzone,
358 container_t container)
360 if (not netzone->getChildren()->empty()) {
361 //bottom-up recursion
362 for (auto const& netzone_child : *netzone->getChildren()) {
363 container_t child_container = container->children_.at(netzone_child->getCname());
364 recursiveXBTGraphExtraction(graph, nodes, edges, netzone_child, child_container);
368 static_cast<simgrid::kernel::routing::NetZoneImpl*>(netzone)->getGraph(graph, nodes, edges);
371 xbt_graph_t instr_routing_platform_graph ()
373 xbt_graph_t ret = xbt_graph_new_graph (0, nullptr);
374 std::map<std::string, xbt_node_t>* nodes = new std::map<std::string, xbt_node_t>;
375 std::map<std::string, xbt_edge_t>* edges = new std::map<std::string, xbt_edge_t>;
376 recursiveXBTGraphExtraction(ret, nodes, edges, simgrid::s4u::Engine::getInstance()->getNetRoot(),
377 simgrid::instr::Container::getRoot());
383 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
385 unsigned int cursor = 0;
386 xbt_node_t node = nullptr;
387 xbt_edge_t edge = nullptr;
389 FILE *file = fopen(filename, "w");
390 xbt_assert(file, "Failed to open %s \n", filename);
393 fprintf(file, "digraph test {\n");
395 fprintf(file, "graph test {\n");
397 fprintf(file, " graph [overlap=scale]\n");
399 fprintf(file, " node [shape=box, style=filled]\n");
400 fprintf(file, " node [width=.3, height=.3, style=filled, color=skyblue]\n\n");
402 xbt_dynar_foreach(g->nodes, cursor, node) {
403 fprintf(file, " \"%s\";\n", instr_node_name(node));
405 xbt_dynar_foreach(g->edges, cursor, edge) {
406 const char *src_s = instr_node_name (edge->src);
407 const char *dst_s = instr_node_name (edge->dst);
409 fprintf(file, " \"%s\" -> \"%s\";\n", src_s, dst_s);
411 fprintf(file, " \"%s\" -- \"%s\";\n", src_s, dst_s);
413 fprintf(file, "}\n");