2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Connect firm to ycomp
23 * @author Christian Wuerdig
41 #define SEND_BUF_SIZE 256
42 #define HASH_EDGE(edge) \
43 ((get_irn_node_nr((edge)->src) << 17) | \
44 ((get_irn_node_nr((edge)->tgt) & 0xEFFF) << 2) | \
47 typedef struct _exchange_node_outs_assoc_t {
51 } exchange_node_outs_assoc_t;
53 typedef struct _ycomp_edge_t {
59 enum _firm_ycomp_node_realizer_values {
65 NODE_REALIZER_STARTEND,
71 typedef struct _firm_ycomp_node_realizer_t {
73 const char *linecolor;
74 const char *fillcolor;
75 const char *textcolor;
77 } firm_ycomp_node_realizer_t;
79 static firm_ycomp_node_realizer_t node_realizer[NODE_REALIZER_LAST] = {
80 { NODE_REALIZER_NORMAL, "black", "white", "black", "box" },
81 { NODE_REALIZER_PROJ, "black", "yellow", "black", "box" },
82 { NODE_REALIZER_BLOCK, "black", "yellow", "white", "box" },
83 { NODE_REALIZER_MEM, "black", "blue", "black", "box" },
84 { NODE_REALIZER_PHI, "black", "green", "black", "box" },
85 { NODE_REALIZER_STARTEND, "black", "blue", "black", "box" },
86 { NODE_REALIZER_IRG, "black", "white", "white", "box" },
87 { NODE_REALIZER_ID, "black", "darkgrey", "black", "box" },
90 enum _firm_ycomp_edge_realizer_values {
98 typedef struct _firm_ycomp_edge_realizer_t {
100 const char *linecolor;
101 const char *textcolor;
104 } firm_ycomp_edge_realizer_t;
106 static firm_ycomp_edge_realizer_t edge_realizer[EDGE_REALIZER_LAST] = {
107 { EDGE_REALIZER_DATA, "black", "black", 1, "continuous" },
108 { EDGE_REALIZER_MEM, "blue", "black", 1, "continuous" },
109 { EDGE_REALIZER_DEP, "green", "black", 1, "continuous" },
110 { EDGE_REALIZER_CFG, "red", "black", 1, "continuous" },
113 typedef struct _firm_ycomp_dbg_t {
116 pset *exchanged_nodes;
118 unsigned in_dead_node_elim : 1;
120 hook_entry_t hook_new_irn;
121 hook_entry_t hook_new_irg;
122 hook_entry_t hook_set_edge;
123 hook_entry_t hook_exchange;
124 hook_entry_t hook_into_id;
125 hook_entry_t hook_dead_node;
128 static firm_ycomp_dbg_t yy_dbg;
130 static int cmp_edges(const void *a, const void *b) {
131 ycomp_edge_t *e1 = (ycomp_edge_t *)a;
132 ycomp_edge_t *e2 = (ycomp_edge_t *)b;
134 return (e1->src != e2->src) || (e1->tgt != e2->tgt) || (e1->pos != e2->pos);
137 static int cmp_nodes(const void *a, const void *b) {
138 exchange_node_outs_assoc_t *n1 = (exchange_node_outs_assoc_t *)a;
139 exchange_node_outs_assoc_t *n2 = (exchange_node_outs_assoc_t *)b;
141 return n1->irn != n2->irn;
144 static inline void send_cmd(firm_ycomp_dbg_t *dbg, const char *buf) {
148 res = firmnet_send(dbg->fd, (const void *)buf, len);
152 static void wait_for_sync(firm_ycomp_dbg_t *dbg) {
154 firmnet_recv(dbg->fd, buf, 6, 5);
157 static void show_and_sync(firm_ycomp_dbg_t *dbg) {
158 send_cmd(dbg, "show\n");
159 send_cmd(dbg, "sync\n");
164 * Register the edge and node realizer in yComp.
166 static void firm_ycomp_debug_init_realizer(firm_ycomp_dbg_t *dbg) {
168 char buf[SEND_BUF_SIZE];
170 for (i = 0; i < NODE_REALIZER_LAST; ++i) {
171 snprintf(buf, sizeof(buf), "addNodeRealizer \"%u\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
173 node_realizer[i].linecolor,
174 node_realizer[i].fillcolor,
175 node_realizer[i].textcolor,
176 node_realizer[i].shape);
180 for (i = 0; i < EDGE_REALIZER_LAST; ++i) {
181 snprintf(buf, sizeof(buf), "addEdgeRealizer \"%u\" \"%s\" \"%s\" \"%u\" \"%s\"\n",
183 edge_realizer[i].linecolor,
184 edge_realizer[i].textcolor,
185 edge_realizer[i].thickness,
186 edge_realizer[i].style);
192 * Retrieve the appropriate realizer for given node.
194 static inline unsigned get_node_realizer(ir_node *node) {
196 ir_opcode opc = get_irn_opcode(node);
200 realizer = NODE_REALIZER_BLOCK;
203 realizer = NODE_REALIZER_PHI;
206 if (get_irn_mode(node) == mode_M)
207 realizer = NODE_REALIZER_MEM;
209 realizer = NODE_REALIZER_PROJ;
213 realizer = NODE_REALIZER_STARTEND;
216 realizer = NODE_REALIZER_NORMAL;
223 * Retrieve the appropriate realizer for given edge.
225 static inline unsigned get_edge_realizer(ir_node *src, ir_node *tgt) {
227 ir_mode *tgt_mode, *src_mode;
229 if (is_Block(tgt) || is_Block(src))
230 return EDGE_REALIZER_CFG;
232 tgt_mode = get_irn_mode(tgt);
233 src_mode = is_Block(src) ? NULL : get_irn_mode(src);
235 if (tgt_mode == mode_M || (src_mode == mode_M && tgt_mode == mode_T))
236 realizer = EDGE_REALIZER_MEM;
237 else if (tgt_mode == mode_X)
238 realizer = EDGE_REALIZER_CFG;
240 realizer = EDGE_REALIZER_DATA;
246 * Hook: Add new nodes, resp. new blocks in yComp and add input edges.
248 static void firm_ycomp_debug_new_node(void *context, ir_graph *graph, ir_node *node) {
249 firm_ycomp_dbg_t *dbg = context;
250 char buf[SEND_BUF_SIZE];
254 if (get_const_code_irg() == graph || dbg->in_dead_node_elim)
257 src_idx = get_irn_node_nr(node);
260 if (is_Block(node)) {
261 /* add block (subgraph) */
262 ir_snprintf(buf, sizeof(buf), "addSubgraphNode \"%d\" \"%d\" \"%u\" \"%+F\"\n",
264 get_irn_node_nr(node), /* graph id */
265 NODE_REALIZER_BLOCK, /* realizer id */
270 ir_snprintf(buf, sizeof(buf), "addNode \"%d\" \"%u\" \"%u\" \"%+F\"\n",
271 get_irn_node_nr(get_nodes_block(node)), /* parent id */
272 src_idx, /* node id */
273 get_node_realizer(node), /* realizer id */
279 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
280 ir_node *pred = get_irn_n(node, i);
281 unsigned tgt_idx = get_irn_node_nr(pred);
282 ycomp_edge_t key, *entry;
284 ir_snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
285 src_idx, tgt_idx, i, /* edge id */
286 src_idx, /* source node id */
287 tgt_idx, /* target node id */
288 get_edge_realizer(node, pred), /* realizer id */
296 entry = pset_find(dbg->edges, &key, HASH_EDGE(&key));
298 entry = obstack_alloc(&dbg->obst, sizeof(*entry));
302 pset_insert(dbg->edges, entry, HASH_EDGE(entry));
310 * Clear the old irg if it has some data and create a new one.
312 static void firm_ycomp_debug_new_irg(void *context, ir_graph *irg,
315 firm_ycomp_dbg_t *dbg = context;
316 char buf[SEND_BUF_SIZE];
319 if (yy_dbg.has_data) {
320 send_cmd(dbg, "deleteGraph\n");
321 // send_cmd(dbg, "show\n");
325 ir_snprintf(buf, sizeof(buf), "addSubgraphNode \"-1\" \"0\" \"%u\" \"%s\"\n",
326 NODE_REALIZER_IRG, get_entity_name(ent));
328 send_cmd(dbg, "sync\n");
333 * Hook: Handle set_irn_n calls.
335 * - remove old edge and add new one
337 static void firm_ycomp_debug_set_edge(void *context, ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt) {
338 firm_ycomp_dbg_t *dbg = context;
339 exchange_node_outs_assoc_t *entry = NULL;
340 exchange_node_outs_assoc_t key;
341 ycomp_edge_t *old_edge, *new_edge, edge_key;
342 char buf[SEND_BUF_SIZE];
343 unsigned src_idx, tgt_idx;
345 if (dbg->in_dead_node_elim)
348 src_idx = get_irn_node_nr(src);
349 tgt_idx = get_irn_node_nr(tgt);
351 /* set_irn_n with pos -1 means: node moves to new block */
353 if (tgt != old_tgt) {
354 snprintf(buf, sizeof(buf), "moveNode \"%d\" \"%d\"\n", src_idx, tgt_idx);
361 /* check if the new edge exists */
365 new_edge = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
367 /* if the new edge already exists and the old target is the new target -> ignore */
368 if (new_edge && tgt == old_tgt)
371 /* check if the old edge exists */
373 int old_tgt_idx = get_irn_node_nr(old_tgt);
376 edge_key.tgt = old_tgt;
378 old_edge = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
380 /* check if old target is marked for exchange */
382 entry = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_tgt));
385 /* we are called from exchange() */
386 entry->n_out_edges--;
389 /* delete the old edge if it exists */
391 snprintf(buf, sizeof(buf), "deleteEdge \"n%un%up%d\"\n", src_idx, old_tgt_idx, pos);
393 pset_remove(dbg->edges, old_edge, HASH_EDGE(old_edge));
398 /* add the new edge if it doesn't exist */
399 snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
400 src_idx, tgt_idx, pos, /* edge id */
401 src_idx, /* source node id */
402 tgt_idx, /* target node id */
403 get_edge_realizer(src, tgt), /* realizer id */
407 /* insert the new edge */
408 new_edge = obstack_alloc(&dbg->obst, sizeof(*new_edge));
412 pset_insert(dbg->edges, new_edge, HASH_EDGE(new_edge));
415 /* show and sync if all edges are rerouted or if it's a normal set_irn_n */
416 if (! entry || entry->n_out_edges == 0) {
422 * Hook: Put nodes, about to be exchanged into a set.
424 static void firm_ycomp_debug_exchange(void *context, ir_node *old_node, ir_node *new_node) {
425 firm_ycomp_dbg_t *dbg = context;
426 exchange_node_outs_assoc_t key, *entry;
428 /* put nodes, which are about to be exchanged into a set */
431 entry = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_node));
433 entry->n_out_edges = get_irn_n_edges(old_node);
434 entry->nw = new_node;
437 entry = obstack_alloc(&dbg->obst, sizeof(*entry));
438 entry->irn = old_node;
439 entry->nw = new_node;
440 entry->n_out_edges = get_irn_n_edges(old_node);
441 pset_insert(dbg->exchanged_nodes, entry, HASH_PTR(old_node));
446 * Hook: Remove all old in edges, turn node into id node, add new input edge.
448 static void firm_ycomp_debug_turn_into_id(void *context, ir_node *old_node) {
449 firm_ycomp_dbg_t *dbg = context;
450 exchange_node_outs_assoc_t key, *entry;
452 char buf[SEND_BUF_SIZE];
453 unsigned src_idx, tgt_idx;
454 ycomp_edge_t edge_key, *new_edge;
457 entry = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_node));
459 assert(entry != NULL && "Exchange entry missing");
461 src_idx = get_irn_node_nr(old_node);
462 tgt_idx = get_irn_node_nr(entry->nw);
464 /* remove all old edges */
465 for (i = get_irn_arity(old_node) - 1; i >= 0; --i) {
466 ycomp_edge_t *old_edge;
467 unsigned old_tgt_idx;
469 /* check if the old edge exists */
470 edge_key.src = old_node;
471 edge_key.tgt = get_irn_n(old_node, i);
473 old_edge = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
475 old_tgt_idx = get_irn_node_nr(edge_key.tgt);
477 /* remove the old edge */
479 snprintf(buf, sizeof(buf), "deleteEdge \"n%un%up%d\"\n", src_idx, old_tgt_idx, i);
481 pset_remove(dbg->edges, old_edge, HASH_EDGE(old_edge));
485 /* change the old node into an id node */
486 snprintf(buf, sizeof(buf), "changeNode \"%ld\" \"%u\"\n", get_irn_node_nr(old_node), NODE_REALIZER_ID);
489 /* add new Id input */
490 snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
491 src_idx, tgt_idx, 0, /* edge id */
492 src_idx, /* source node id */
493 tgt_idx, /* target node id */
494 get_edge_realizer(old_node, entry->nw), /* realizer id */
501 /* add the new edge to our pset */
502 new_edge = obstack_alloc(&dbg->obst, sizeof(*new_edge));
503 new_edge->src = old_node;
504 new_edge->tgt = entry->nw;
506 pset_insert(dbg->edges, new_edge, HASH_EDGE(new_edge));
510 * Hook: Just mark start/end of dead node elimination.
512 static void firm_ycomp_debug_dead_node_elim(void *context, ir_graph *irg, int start) {
513 firm_ycomp_dbg_t *dbg = context;
515 dbg->in_dead_node_elim = start != 0;
519 * Establish connection to yComp and register all hooks.
521 void firm_init_ycomp_debugger(const char *host, unsigned port) {
522 static int init_once = 0;
527 memset(&yy_dbg, 0, sizeof(yy_dbg));
530 fprintf(stderr, "connecting to %s:%u\n", host, port);
531 yy_dbg.fd = firmnet_connect_tcp(host, port);
533 if (yy_dbg.fd > -1) {
534 /* We could establish a connection to ycomp -> register hooks */
535 firm_ycomp_debug_init_realizer(&yy_dbg);
536 yy_dbg.exchanged_nodes = new_pset(cmp_nodes, 20);
537 yy_dbg.edges = new_pset(cmp_edges, 20);
538 obstack_init(&yy_dbg.obst);
540 #define REGISTER_HOOK(ycomp_hook, firm_hook, func) \
542 yy_dbg.ycomp_hook.context = &yy_dbg; \
543 yy_dbg.ycomp_hook.hook._##firm_hook = func; \
544 register_hook(firm_hook, &yy_dbg.ycomp_hook); \
547 REGISTER_HOOK(hook_new_irn, hook_new_node, firm_ycomp_debug_new_node);
548 REGISTER_HOOK(hook_new_irg, hook_new_graph, firm_ycomp_debug_new_irg);
549 REGISTER_HOOK(hook_set_edge, hook_set_irn_n, firm_ycomp_debug_set_edge);
550 REGISTER_HOOK(hook_exchange, hook_replace, firm_ycomp_debug_exchange);
551 REGISTER_HOOK(hook_into_id, hook_turn_into_id, firm_ycomp_debug_turn_into_id);
552 REGISTER_HOOK(hook_dead_node, hook_dead_node_elim, firm_ycomp_debug_dead_node_elim);
561 * Close connection to yComp, unregister all hooks and free memory.
563 void firm_finish_ycomp_debugger(void) {
564 if (yy_dbg.fd > -1) {
565 /* close connection */
566 firmnet_close_socket(yy_dbg.fd);
569 /* unregister all hooks */
570 unregister_hook(hook_new_graph, &yy_dbg.hook_new_irg);
571 unregister_hook(hook_new_node, &yy_dbg.hook_new_irn);
572 unregister_hook(hook_set_irn_n, &yy_dbg.hook_set_edge);
573 unregister_hook(hook_replace, &yy_dbg.hook_exchange);
574 unregister_hook(hook_dead_node_elim, &yy_dbg.hook_dead_node);
575 unregister_hook(hook_turn_into_id, &yy_dbg.hook_into_id);
578 del_pset(yy_dbg.exchanged_nodes);
579 del_pset(yy_dbg.edges);
581 /* free data obstack */
582 obstack_free(&yy_dbg.obst, NULL);