3 * File name: ir/debug/firm_ycomp.c
4 * Purpose: Connect firm to ycomp
5 * Author: Christian Wuerdig
9 * Copyright: (c) 2001-2006 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
14 #endif /* HAVE_CONFIG_H */
28 #define SEND_BUF_SIZE 256
29 #define HASH_EDGE(edge) \
30 ((get_irn_node_nr((edge)->src) << 17) | \
31 ((get_irn_node_nr((edge)->tgt) & 0xEFFF) << 2) | \
34 typedef struct _exchange_node_outs_assoc_t {
38 } exchange_node_outs_assoc_t;
40 typedef struct _ycomp_edge_t {
46 enum _firm_ycomp_node_realizer_values {
52 NODE_REALIZER_STARTEND,
58 typedef struct _firm_ycomp_node_realizer_t {
60 const char *linecolor;
61 const char *fillcolor;
63 } firm_ycomp_node_realizer_t;
65 static firm_ycomp_node_realizer_t node_realizer[NODE_REALIZER_LAST] = {
66 { NODE_REALIZER_NORMAL, "black", "white", "box" },
67 { NODE_REALIZER_PROJ, "black", "yellow", "box" },
68 { NODE_REALIZER_BLOCK, "black", "yellow", "box" },
69 { NODE_REALIZER_MEM, "black", "blue", "box" },
70 { NODE_REALIZER_PHI, "black", "green", "box" },
71 { NODE_REALIZER_STARTEND, "black", "blue", "box" },
72 { NODE_REALIZER_IRG, "black", "white", "box" },
73 { NODE_REALIZER_ID, "black", "darkgrey", "box" },
76 enum _firm_ycomp_edge_realizer_values {
84 typedef struct _firm_ycomp_edge_realizer_t {
86 const char *linecolor;
89 } firm_ycomp_edge_realizer_t;
91 static firm_ycomp_edge_realizer_t edge_realizer[EDGE_REALIZER_LAST] = {
92 { EDGE_REALIZER_DATA, "black", 1, "continuous" },
93 { EDGE_REALIZER_MEM, "blue", 1, "continuous" },
94 { EDGE_REALIZER_DEP, "green", 1, "continuous" },
95 { EDGE_REALIZER_CFG, "red", 1, "continuous" },
98 typedef struct _firm_ycomp_dbg_t {
101 pset *exchanged_nodes;
103 unsigned in_dead_node_elim : 1;
105 hook_entry_t hook_new_irn;
106 hook_entry_t hook_new_irg;
107 hook_entry_t hook_set_edge;
108 hook_entry_t hook_exchange;
109 hook_entry_t hook_into_id;
110 hook_entry_t hook_dead_node;
113 static firm_ycomp_dbg_t yy_dbg;
115 static int cmp_edges(const void *a, const void *b) {
116 ycomp_edge_t *e1 = (ycomp_edge_t *)a;
117 ycomp_edge_t *e2 = (ycomp_edge_t *)b;
119 return (e1->src != e2->src) || (e1->tgt != e2->tgt) || (e1->pos != e2->pos);
122 static int cmp_nodes(const void *a, const void *b) {
123 exchange_node_outs_assoc_t *n1 = (exchange_node_outs_assoc_t *)a;
124 exchange_node_outs_assoc_t *n2 = (exchange_node_outs_assoc_t *)b;
126 return n1->irn != n2->irn;
129 static INLINE void send_cmd(firm_ycomp_dbg_t *dbg, const char *buf) {
133 res = firmnet_send(dbg->fd, (const void *)buf, len);
137 static void wait_for_sync(firm_ycomp_dbg_t *dbg) {
139 firmnet_recv(dbg->fd, buf, 6, 5);
142 static void show_and_sync(firm_ycomp_dbg_t *dbg) {
143 send_cmd(dbg, "show\n");
144 send_cmd(dbg, "sync\n");
149 * Register the edge and node realizer in yComp.
151 static void firm_ycomp_debug_init_realizer(firm_ycomp_dbg_t *dbg) {
153 char buf[SEND_BUF_SIZE];
155 for (i = 0; i < NODE_REALIZER_LAST; ++i) {
156 snprintf(buf, sizeof(buf), "addNodeRealizer \"%u\" \"%s\" \"%s\" \"%s\"\n",
158 node_realizer[i].linecolor,
159 node_realizer[i].fillcolor,
160 node_realizer[i].shape);
164 for (i = 0; i < EDGE_REALIZER_LAST; ++i) {
165 snprintf(buf, sizeof(buf), "addEdgeRealizer \"%u\" \"%s\" \"%u\" \"%s\"\n",
167 edge_realizer[i].linecolor,
168 edge_realizer[i].thickness,
169 edge_realizer[i].style);
175 * Retrieve the appropriate realizer for given node.
177 static INLINE unsigned get_node_realizer(ir_node *node) {
179 ir_opcode opc = get_irn_opcode(node);
183 realizer = NODE_REALIZER_BLOCK;
186 realizer = NODE_REALIZER_PHI;
189 if (get_irn_mode(node) == mode_M)
190 realizer = NODE_REALIZER_MEM;
192 realizer = NODE_REALIZER_PROJ;
196 realizer = NODE_REALIZER_STARTEND;
199 realizer = NODE_REALIZER_NORMAL;
206 * Retrieve the appropriate realizer for given edge.
208 static INLINE unsigned get_edge_realizer(ir_node *src, ir_node *tgt) {
210 ir_mode *tgt_mode, *src_mode;
212 assert(! is_Block(tgt));
214 tgt_mode = get_irn_mode(tgt);
215 src_mode = is_Block(src) ? NULL : get_irn_mode(src);
217 if (tgt_mode == mode_M || src_mode)
218 realizer = EDGE_REALIZER_MEM;
219 else if (tgt_mode == mode_X)
220 realizer = EDGE_REALIZER_CFG;
222 realizer = EDGE_REALIZER_DATA;
228 * Hook: Add new nodes, resp. new blocks in yComp and add input edges.
230 static void firm_ycomp_debug_new_node(void *context, ir_graph *graph, ir_node *node) {
231 firm_ycomp_dbg_t *dbg = context;
232 char buf[SEND_BUF_SIZE];
236 if (get_const_code_irg() == graph || dbg->in_dead_node_elim)
239 src_idx = get_irn_node_nr(node);
242 if (is_Block(node)) {
243 /* add block (subgraph) */
244 ir_snprintf(buf, sizeof(buf), "addSubgraphNode \"%d\" \"%d\" \"%u\" \"%+F\"\n",
246 get_irn_node_nr(node), /* graph id */
247 NODE_REALIZER_BLOCK, /* realizer id */
252 ir_snprintf(buf, sizeof(buf), "addNode \"%d\" \"%u\" \"%u\" \"%+F\"\n",
253 get_irn_node_nr(get_nodes_block(node)), /* parent id */
254 src_idx, /* node id */
255 get_node_realizer(node), /* realizer id */
261 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
262 ir_node *pred = get_irn_n(node, i);
263 unsigned tgt_idx = get_irn_node_nr(pred);
264 ycomp_edge_t key, *entry;
266 ir_snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
267 src_idx, tgt_idx, i, /* edge id */
268 src_idx, /* source node id */
269 tgt_idx, /* target node id */
270 get_edge_realizer(node, pred), /* realizer id */
278 entry = pset_find(dbg->edges, &key, HASH_EDGE(&key));
280 entry = obstack_alloc(&dbg->obst, sizeof(*entry));
284 pset_insert(dbg->edges, entry, HASH_EDGE(entry));
292 * Clear the old irg if it has some data and create a new one.
294 static void firm_ycomp_debug_new_irg(void *context, ir_graph *irg, ir_entity *ent) {
295 firm_ycomp_dbg_t *dbg = context;
296 char buf[SEND_BUF_SIZE];
298 if (yy_dbg.has_data) {
299 send_cmd(dbg, "deleteGraph\n");
300 send_cmd(dbg, "show\n");
304 ir_snprintf(buf, sizeof(buf), "addSubgraphNode \"-1\" \"0\" \"%u\" \"%s\"\n",
305 NODE_REALIZER_IRG, get_entity_name(ent));
307 send_cmd(dbg, "sync\n");
312 * Hook: Handle set_irn_n calls.
314 * - remove old edge and add new one
316 static void firm_ycomp_debug_set_edge(void *context, ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt) {
317 firm_ycomp_dbg_t *dbg = context;
318 exchange_node_outs_assoc_t *entry, key;
319 ycomp_edge_t *old_edge, *new_edge, edge_key;
320 char buf[SEND_BUF_SIZE];
321 unsigned src_idx, tgt_idx, old_tgt_idx;
323 if (dbg->in_dead_node_elim)
326 src_idx = get_irn_node_nr(src);
327 tgt_idx = get_irn_node_nr(tgt);
328 old_tgt_idx = get_irn_node_nr(old_tgt);
330 /* set_irn_n with pos -1 means: node moves to new block */
332 if (tgt != old_tgt) {
333 snprintf(buf, sizeof(buf), "moveNode \"%d\" \"%d\"\n", src_idx, tgt_idx);
340 /* check if the new edge exists */
344 new_edge = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
346 /* if the new edge already exists and the old target is the new target -> ignore */
347 if (new_edge && tgt == old_tgt)
350 /* check if the old edge exists */
352 edge_key.tgt = old_tgt;
354 old_edge = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
356 /* check if old target is marked for exchange */
358 entry = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_tgt));
361 /* we are called from exchange() */
362 entry->n_out_edges--;
365 /* delete the old edge if it exists */
367 snprintf(buf, sizeof(buf), "deleteEdge \"n%un%up%d\"\n", src_idx, old_tgt_idx, pos);
369 pset_remove(dbg->edges, old_edge, HASH_EDGE(old_edge));
373 /* add the new edge if it doesn't exist */
374 snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
375 src_idx, tgt_idx, pos, /* edge id */
376 src_idx, /* source node id */
377 tgt_idx, /* target node id */
378 get_edge_realizer(src, tgt), /* realizer id */
382 /* insert the new edge */
383 new_edge = obstack_alloc(&dbg->obst, sizeof(*new_edge));
387 pset_insert(dbg->edges, new_edge, HASH_EDGE(new_edge));
390 /* show and sync if all edges are rerouted or if it's a normal set_irn_n */
391 if (! entry || entry->n_out_edges == 0) {
397 * Hook: Put nodes, about to be exchanged into a set.
399 static void firm_ycomp_debug_exchange(void *context, ir_node *old_node, ir_node *new_node) {
400 firm_ycomp_dbg_t *dbg = context;
401 exchange_node_outs_assoc_t key, *entry;
403 /* put nodes, which are about to be exchanged into a set */
406 entry = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_node));
408 entry->n_out_edges = get_irn_n_edges(old_node);
409 entry->nw = new_node;
412 entry = obstack_alloc(&dbg->obst, sizeof(*entry));
413 entry->irn = old_node;
414 entry->nw = new_node;
415 entry->n_out_edges = get_irn_n_edges(old_node);
416 pset_insert(dbg->exchanged_nodes, entry, HASH_PTR(old_node));
421 * Hook: Remove all old in edges, turn node into id node, add new input edge.
423 static void firm_ycomp_debug_turn_into_id(void *context, ir_node *old_node) {
424 firm_ycomp_dbg_t *dbg = context;
425 exchange_node_outs_assoc_t key, *entry;
427 char buf[SEND_BUF_SIZE];
428 unsigned src_idx, tgt_idx;
429 ycomp_edge_t edge_key, *new_edge;
432 entry = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_node));
434 assert(entry != NULL && "Exchange entry missing");
436 src_idx = get_irn_node_nr(old_node);
437 tgt_idx = get_irn_node_nr(entry->nw);
439 /* remove all old edges */
440 for (i = get_irn_arity(old_node) - 1; i >= 0; --i) {
441 ycomp_edge_t *old_edge;
442 unsigned old_tgt_idx;
444 /* check if the old edge exists */
445 edge_key.src = old_node;
446 edge_key.tgt = get_irn_n(old_node, i);
448 old_edge = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
450 old_tgt_idx = get_irn_node_nr(edge_key.tgt);
452 /* remove the old edge */
454 snprintf(buf, sizeof(buf), "deleteEdge \"n%un%up%d\"\n", src_idx, old_tgt_idx, i);
456 pset_remove(dbg->edges, old_edge, HASH_EDGE(old_edge));
460 /* change the old node into an id node */
461 snprintf(buf, sizeof(buf), "changeNode \"%ld\" \"%u\"\n", get_irn_node_nr(old_node), NODE_REALIZER_ID);
464 /* add new Id input */
465 snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
466 src_idx, tgt_idx, 0, /* edge id */
467 src_idx, /* source node id */
468 tgt_idx, /* target node id */
469 get_edge_realizer(old_node, entry->nw), /* realizer id */
476 /* add the new edge to our pset */
477 new_edge = obstack_alloc(&dbg->obst, sizeof(*new_edge));
478 new_edge->src = old_node;
479 new_edge->tgt = entry->nw;
481 pset_insert(dbg->edges, new_edge, HASH_EDGE(new_edge));
485 * Hook: Just mark start/end of dead node elimination.
487 static void firm_ycomp_debug_dead_node_elim(void *context, ir_graph *irg, int start) {
488 firm_ycomp_dbg_t *dbg = context;
489 dbg->in_dead_node_elim = start != 0;
493 * Establish connection to yComp and register all hooks.
495 void firm_init_ycomp_debugger(const char *host, unsigned port) {
496 static int init_once = 0;
501 memset(&yy_dbg, 0, sizeof(yy_dbg));
504 fprintf(stderr, "connecting to %s:%u\n", host, port);
505 yy_dbg.fd = firmnet_connect_tcp(host, port);
507 if (yy_dbg.fd > -1) {
508 /* We could establish a connection to ycomp -> register hooks */
509 firm_ycomp_debug_init_realizer(&yy_dbg);
510 yy_dbg.exchanged_nodes = new_pset(cmp_nodes, 20);
511 yy_dbg.edges = new_pset(cmp_edges, 20);
512 obstack_init(&yy_dbg.obst);
514 #define REGISTER_HOOK(ycomp_hook, firm_hook, func) \
516 yy_dbg.ycomp_hook.context = &yy_dbg; \
517 yy_dbg.ycomp_hook.hook._##firm_hook = func; \
518 register_hook(firm_hook, &yy_dbg.ycomp_hook); \
521 REGISTER_HOOK(hook_new_irn, hook_new_node, firm_ycomp_debug_new_node);
522 REGISTER_HOOK(hook_new_irg, hook_new_graph, firm_ycomp_debug_new_irg);
523 REGISTER_HOOK(hook_set_edge, hook_set_irn_n, firm_ycomp_debug_set_edge);
524 REGISTER_HOOK(hook_exchange, hook_replace, firm_ycomp_debug_exchange);
525 REGISTER_HOOK(hook_into_id, hook_turn_into_id, firm_ycomp_debug_turn_into_id);
526 REGISTER_HOOK(hook_dead_node, hook_dead_node_elim, firm_ycomp_debug_dead_node_elim);
535 * Close connection to yComp, unregister all hooks and free memory.
537 void firm_finish_ycomp_debugger(void) {
538 if (yy_dbg.fd > -1) {
539 /* close connection */
540 firmnet_close_socket(yy_dbg.fd);
543 /* unregister all hooks */
544 unregister_hook(hook_new_graph, &yy_dbg.hook_new_irg);
545 unregister_hook(hook_new_node, &yy_dbg.hook_new_irn);
546 unregister_hook(hook_set_irn_n, &yy_dbg.hook_set_edge);
547 unregister_hook(hook_replace, &yy_dbg.hook_exchange);
548 unregister_hook(hook_dead_node_elim, &yy_dbg.hook_dead_node);
549 unregister_hook(hook_turn_into_id, &yy_dbg.hook_into_id);
552 del_pset(yy_dbg.exchanged_nodes);
553 del_pset(yy_dbg.edges);
555 /* free data obstack */
556 obstack_free(&yy_dbg.obst, NULL);