moved be_retrieve_dbg_info() into middleend and rename it to ir_retrieve_dbg_info()
[libfirm] / ir / debug / firm_ycomp.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief      Connect firm to ycomp
23  * @author     Christian Wuerdig
24  * @date       16.11.2006
25  * @version    $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif /* HAVE_CONFIG_H */
30
31 #include "assert.h"
32 #include "irhooks.h"
33 #include "firmnet.h"
34 #include "irnode.h"
35 #include "irgraph.h"
36 #include "irprintf.h"
37 #include "irprog.h"
38 #include "iredges.h"
39 #include "pset.h"
40 #include "obst.h"
41 #include "firmnet.h"
42
43 #define SEND_BUF_SIZE 256
44 #define HASH_EDGE(edge) \
45         ((get_irn_node_nr((edge)->src) << 17)          | \
46         ((get_irn_node_nr((edge)->tgt) & 0xEFFF) << 2) | \
47         ((edge)->pos & 0x3))
48
49 typedef struct _exchange_node_outs_assoc_t {
50         int     n_out_edges;
51         ir_node *irn;
52         ir_node *nw;
53 } exchange_node_outs_assoc_t;
54
55 typedef struct _ycomp_edge_t {
56         ir_node *src;
57         ir_node *tgt;
58         int     pos;
59 } ycomp_edge_t;
60
61 enum _firm_ycomp_node_realizer_values {
62         NODE_REALIZER_NORMAL,
63         NODE_REALIZER_PROJ,
64         NODE_REALIZER_BLOCK,
65         NODE_REALIZER_MEM,
66         NODE_REALIZER_PHI,
67         NODE_REALIZER_STARTEND,
68         NODE_REALIZER_IRG,
69         NODE_REALIZER_ID,
70         NODE_REALIZER_LAST
71 };
72
73 typedef struct _firm_ycomp_node_realizer_t {
74         unsigned   id;
75         const char *linecolor;
76         const char *fillcolor;
77         const char *textcolor;
78         const char *shape;
79 } firm_ycomp_node_realizer_t;
80
81 static firm_ycomp_node_realizer_t node_realizer[NODE_REALIZER_LAST] = {
82         { NODE_REALIZER_NORMAL,   "black", "white",    "black", "box" },
83         { NODE_REALIZER_PROJ,     "black", "yellow",   "black", "box" },
84         { NODE_REALIZER_BLOCK,    "black", "yellow",   "white", "box" },
85         { NODE_REALIZER_MEM,      "black", "blue",     "black", "box" },
86         { NODE_REALIZER_PHI,      "black", "green",    "black", "box" },
87         { NODE_REALIZER_STARTEND, "black", "blue",     "black", "box" },
88         { NODE_REALIZER_IRG,      "black", "white",    "white", "box" },
89         { NODE_REALIZER_ID,       "black", "darkgrey", "black", "box" },
90 };
91
92 enum _firm_ycomp_edge_realizer_values {
93         EDGE_REALIZER_DATA,
94         EDGE_REALIZER_MEM,
95         EDGE_REALIZER_DEP,
96         EDGE_REALIZER_CFG,
97         EDGE_REALIZER_LAST
98 };
99
100 typedef struct _firm_ycomp_edge_realizer_t {
101         unsigned   id;
102         const char *linecolor;
103         const char *textcolor;
104         unsigned   thickness;
105         const char *style;
106 } firm_ycomp_edge_realizer_t;
107
108 static firm_ycomp_edge_realizer_t edge_realizer[EDGE_REALIZER_LAST] = {
109         { EDGE_REALIZER_DATA, "black", "black", 1, "continuous" },
110         { EDGE_REALIZER_MEM,  "blue",  "black", 1, "continuous" },
111         { EDGE_REALIZER_DEP,  "green", "black", 1, "continuous" },
112         { EDGE_REALIZER_CFG,  "red",   "black", 1, "continuous" },
113 };
114
115 typedef struct _firm_ycomp_dbg_t {
116         int            fd;
117         int            has_data;
118         pset           *exchanged_nodes;
119         pset           *edges;
120         unsigned       in_dead_node_elim : 1;
121         struct obstack obst;
122         hook_entry_t   hook_new_irn;
123         hook_entry_t   hook_new_irg;
124         hook_entry_t   hook_set_edge;
125         hook_entry_t   hook_exchange;
126         hook_entry_t   hook_into_id;
127         hook_entry_t   hook_dead_node;
128 } firm_ycomp_dbg_t;
129
130 static firm_ycomp_dbg_t yy_dbg;
131
132 static int cmp_edges(const void *a, const void *b) {
133         ycomp_edge_t *e1 = (ycomp_edge_t *)a;
134         ycomp_edge_t *e2 = (ycomp_edge_t *)b;
135
136         return (e1->src != e2->src) || (e1->tgt != e2->tgt) || (e1->pos != e2->pos);
137 }
138
139 static int cmp_nodes(const void *a, const void *b) {
140         exchange_node_outs_assoc_t *n1 = (exchange_node_outs_assoc_t *)a;
141         exchange_node_outs_assoc_t *n2 = (exchange_node_outs_assoc_t *)b;
142
143         return n1->irn != n2->irn;
144 }
145
146 static INLINE void send_cmd(firm_ycomp_dbg_t *dbg, const char *buf) {
147         ssize_t res, len;
148
149         len = strlen(buf);
150         res = firmnet_send(dbg->fd, (const void *)buf, len);
151         assert(res == len);
152 }
153
154 static void wait_for_sync(firm_ycomp_dbg_t *dbg) {
155         char buf[6];
156         firmnet_recv(dbg->fd, buf, 6, 5);
157 }
158
159 static void show_and_sync(firm_ycomp_dbg_t *dbg) {
160         send_cmd(dbg, "show\n");
161         send_cmd(dbg, "sync\n");
162         wait_for_sync(dbg);
163 }
164
165 /**
166  * Register the edge and node realizer in yComp.
167  */
168 static void firm_ycomp_debug_init_realizer(firm_ycomp_dbg_t *dbg) {
169         int  i;
170         char buf[SEND_BUF_SIZE];
171
172         for (i = 0; i < NODE_REALIZER_LAST; ++i) {
173                 snprintf(buf, sizeof(buf), "addNodeRealizer \"%u\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
174                         node_realizer[i].id,
175                         node_realizer[i].linecolor,
176                         node_realizer[i].fillcolor,
177                         node_realizer[i].textcolor,
178                         node_realizer[i].shape);
179                 send_cmd(dbg, buf);
180         }
181
182         for (i = 0; i < EDGE_REALIZER_LAST; ++i) {
183                 snprintf(buf, sizeof(buf), "addEdgeRealizer \"%u\" \"%s\" \"%s\" \"%u\" \"%s\"\n",
184                         edge_realizer[i].id,
185                         edge_realizer[i].linecolor,
186                         edge_realizer[i].textcolor,
187                         edge_realizer[i].thickness,
188                         edge_realizer[i].style);
189                 send_cmd(dbg, buf);
190         }
191 }
192
193 /**
194  * Retrieve the appropriate realizer for given node.
195  */
196 static INLINE unsigned get_node_realizer(ir_node *node) {
197         unsigned realizer;
198         ir_opcode opc = get_irn_opcode(node);
199
200         switch (opc) {
201                 case iro_Block:
202                         realizer = NODE_REALIZER_BLOCK;
203                         break;
204                 case iro_Phi:
205                         realizer = NODE_REALIZER_PHI;
206                         break;
207                 case iro_Proj:
208                         if (get_irn_mode(node) == mode_M)
209                                 realizer = NODE_REALIZER_MEM;
210                         else
211                                 realizer = NODE_REALIZER_PROJ;
212                         break;
213                 case iro_Start:
214                 case iro_End:
215                         realizer = NODE_REALIZER_STARTEND;
216                         break;
217                 default:
218                         realizer = NODE_REALIZER_NORMAL;
219         };
220
221         return realizer;
222 }
223
224 /**
225  * Retrieve the appropriate realizer for given edge.
226  */
227 static INLINE unsigned get_edge_realizer(ir_node *src, ir_node *tgt) {
228         unsigned realizer;
229         ir_mode  *tgt_mode, *src_mode;
230
231         if (is_Block(tgt) || is_Block(src))
232                 return EDGE_REALIZER_CFG;
233
234         tgt_mode = get_irn_mode(tgt);
235         src_mode = is_Block(src) ? NULL : get_irn_mode(src);
236
237         if (tgt_mode == mode_M || (src_mode == mode_M && tgt_mode == mode_T))
238                 realizer = EDGE_REALIZER_MEM;
239         else if (tgt_mode == mode_X)
240                 realizer = EDGE_REALIZER_CFG;
241         else
242                 realizer = EDGE_REALIZER_DATA;
243
244         return realizer;
245 }
246
247 /**
248  * Hook: Add new nodes, resp. new blocks in yComp and add input edges.
249  */
250 static void firm_ycomp_debug_new_node(void *context, ir_graph *graph, ir_node *node) {
251         firm_ycomp_dbg_t *dbg = context;
252         char             buf[SEND_BUF_SIZE];
253         int              i;
254         unsigned         src_idx;
255
256         if (get_const_code_irg() == graph || dbg->in_dead_node_elim)
257                 return;
258
259         src_idx       = get_irn_node_nr(node);
260         dbg->has_data = 1;
261
262         if (is_Block(node)) {
263                 /* add block (subgraph) */
264                 ir_snprintf(buf, sizeof(buf), "addSubgraphNode \"%d\" \"%d\" \"%u\" \"%+F\"\n",
265                         0,                     /* parent id */
266                         get_irn_node_nr(node), /* graph id */
267                         NODE_REALIZER_BLOCK,   /* realizer id */
268                         node);                 /* label */
269         }
270         else {
271                 /* add node */
272                 ir_snprintf(buf, sizeof(buf), "addNode \"%d\" \"%u\" \"%u\" \"%+F\"\n",
273                         get_irn_node_nr(get_nodes_block(node)), /* parent id */
274                         src_idx,                                /* node id */
275                         get_node_realizer(node),                /* realizer id */
276                         node);                                  /* label */
277         }
278         send_cmd(dbg, buf);
279
280         /* add edges */
281         for (i = get_irn_arity(node) - 1; i >= 0; --i) {
282                 ir_node      *pred   = get_irn_n(node, i);
283                 unsigned     tgt_idx = get_irn_node_nr(pred);
284                 ycomp_edge_t key, *entry;
285
286                 ir_snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
287                         src_idx, tgt_idx, i,            /* edge id */
288                         src_idx,                        /* source node id */
289                         tgt_idx,                        /* target node id */
290                         get_edge_realizer(node, pred),  /* realizer id */
291                         i);                             /* title */
292                 send_cmd(dbg, buf);
293
294                 /* insert edge */
295                 key.src = node;
296                 key.tgt = pred;
297                 key.pos = i;
298                 entry   = pset_find(dbg->edges, &key, HASH_EDGE(&key));
299                 if (! entry) {
300                         entry = obstack_alloc(&dbg->obst, sizeof(*entry));
301                         entry->src = node;
302                         entry->tgt = pred;
303                         entry->pos = i;
304                         pset_insert(dbg->edges, entry, HASH_EDGE(entry));
305                 }
306         }
307
308         show_and_sync(dbg);
309 }
310
311 /**
312  * Clear the old irg if it has some data and create a new one.
313  */
314 static void firm_ycomp_debug_new_irg(void *context, ir_graph *irg,
315                                      ir_entity *ent)
316 {
317         firm_ycomp_dbg_t *dbg = context;
318         char             buf[SEND_BUF_SIZE];
319         (void) irg;
320
321         if (yy_dbg.has_data) {
322                 send_cmd(dbg, "deleteGraph\n");
323 //              send_cmd(dbg, "show\n");
324         }
325         dbg->has_data = 0;
326
327         ir_snprintf(buf, sizeof(buf), "addSubgraphNode \"-1\" \"0\" \"%u\" \"%s\"\n",
328                 NODE_REALIZER_IRG, get_entity_name(ent));
329         send_cmd(dbg, buf);
330         send_cmd(dbg, "sync\n");
331         wait_for_sync(dbg);
332 }
333
334 /**
335  * Hook: Handle set_irn_n calls.
336  * - set new Block      OR
337  * - remove old edge and add new one
338  */
339 static void firm_ycomp_debug_set_edge(void *context, ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt) {
340         firm_ycomp_dbg_t           *dbg   = context;
341         exchange_node_outs_assoc_t *entry = NULL;
342         exchange_node_outs_assoc_t key;
343         ycomp_edge_t               *old_edge, *new_edge, edge_key;
344         char                       buf[SEND_BUF_SIZE];
345         unsigned                   src_idx, tgt_idx;
346
347         if (dbg->in_dead_node_elim)
348                 return;
349
350         src_idx = get_irn_node_nr(src);
351         tgt_idx = get_irn_node_nr(tgt);
352
353         /* set_irn_n with pos -1 means: node moves to new block  */
354         if (pos < 0) {
355                 if (tgt != old_tgt) {
356                         snprintf(buf, sizeof(buf), "moveNode \"%d\" \"%d\"\n", src_idx, tgt_idx);
357                         send_cmd(dbg, buf);
358                         show_and_sync(dbg);
359                 }
360                 return;
361         }
362
363         /* check if the new edge exists */
364         edge_key.src = src;
365         edge_key.tgt = tgt;
366         edge_key.pos = pos;
367         new_edge     = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
368
369         /* if the new edge already exists and the old target is the new target -> ignore */
370         if (new_edge && tgt == old_tgt)
371                 return;
372
373         /* check if the old edge exists */
374         if (old_tgt) {
375                 int old_tgt_idx = get_irn_node_nr(old_tgt);
376
377                 edge_key.src = src;
378                 edge_key.tgt = old_tgt;
379                 edge_key.pos = pos;
380                 old_edge     = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
381
382                 /* check if old target is marked for exchange */
383                 key.irn = old_tgt;
384                 entry   = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_tgt));
385
386                 if (entry) {
387                         /* we are called from exchange() */
388                         entry->n_out_edges--;
389                 }
390
391                 /* delete the old edge if it exists */
392                 if (old_edge) {
393                         snprintf(buf, sizeof(buf), "deleteEdge \"n%un%up%d\"\n", src_idx, old_tgt_idx, pos);
394                         send_cmd(dbg, buf);
395                         pset_remove(dbg->edges, old_edge, HASH_EDGE(old_edge));
396                 }
397         }
398
399         if (! new_edge) {
400                 /* add the new edge if it doesn't exist */
401                 snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
402                         src_idx, tgt_idx, pos,          /* edge id */
403                         src_idx,                        /* source node id */
404                         tgt_idx,                        /* target node id */
405                         get_edge_realizer(src, tgt),    /* realizer id */
406                         pos);                           /* title */
407                 send_cmd(dbg, buf);
408
409                 /* insert the new edge */
410                 new_edge      = obstack_alloc(&dbg->obst, sizeof(*new_edge));
411                 new_edge->src = src;
412                 new_edge->tgt = tgt;
413                 new_edge->pos = pos;
414                 pset_insert(dbg->edges, new_edge, HASH_EDGE(new_edge));
415         }
416
417         /* show and sync if all edges are rerouted or if it's a normal set_irn_n */
418         if (! entry || entry->n_out_edges == 0) {
419                 show_and_sync(dbg);
420         }
421 }
422
423 /**
424  * Hook: Put nodes, about to be exchanged into a set.
425  */
426 static void firm_ycomp_debug_exchange(void *context, ir_node *old_node, ir_node *new_node) {
427         firm_ycomp_dbg_t           *dbg = context;
428         exchange_node_outs_assoc_t key, *entry;
429
430         /* put nodes, which are about to be exchanged into a set */
431
432         key.irn = old_node;
433         entry   = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_node));
434         if (entry) {
435                 entry->n_out_edges = get_irn_n_edges(old_node);
436                 entry->nw          = new_node;
437         }
438         else {
439                 entry              = obstack_alloc(&dbg->obst, sizeof(*entry));
440                 entry->irn         = old_node;
441                 entry->nw          = new_node;
442                 entry->n_out_edges = get_irn_n_edges(old_node);
443                 pset_insert(dbg->exchanged_nodes, entry, HASH_PTR(old_node));
444         }
445 }
446
447 /**
448  * Hook: Remove all old in edges, turn node into id node, add new input edge.
449  */
450 static void firm_ycomp_debug_turn_into_id(void *context, ir_node *old_node) {
451         firm_ycomp_dbg_t           *dbg = context;
452         exchange_node_outs_assoc_t key, *entry;
453         int                        i;
454         char                       buf[SEND_BUF_SIZE];
455         unsigned                   src_idx, tgt_idx;
456         ycomp_edge_t               edge_key, *new_edge;
457
458         key.irn = old_node;
459         entry   = pset_find(dbg->exchanged_nodes, &key, HASH_PTR(old_node));
460
461         assert(entry != NULL && "Exchange entry missing");
462
463         src_idx = get_irn_node_nr(old_node);
464         tgt_idx = get_irn_node_nr(entry->nw);
465
466         /* remove all old edges */
467         for (i = get_irn_arity(old_node) - 1; i >= 0; --i) {
468                 ycomp_edge_t *old_edge;
469                 unsigned     old_tgt_idx;
470
471                 /* check if the old edge exists */
472                 edge_key.src = old_node;
473                 edge_key.tgt = get_irn_n(old_node, i);
474                 edge_key.pos = i;
475                 old_edge     = pset_find(dbg->edges, &edge_key, HASH_EDGE(&edge_key));
476
477                 old_tgt_idx  = get_irn_node_nr(edge_key.tgt);
478
479                 /* remove the old edge */
480                 if (old_edge) {
481                         snprintf(buf, sizeof(buf), "deleteEdge \"n%un%up%d\"\n", src_idx, old_tgt_idx, i);
482                         send_cmd(dbg, buf);
483                         pset_remove(dbg->edges, old_edge, HASH_EDGE(old_edge));
484                 }
485         }
486
487         /* change the old node into an id node */
488         snprintf(buf, sizeof(buf), "changeNode \"%ld\" \"%u\"\n", get_irn_node_nr(old_node), NODE_REALIZER_ID);
489         send_cmd(dbg, buf);
490
491         /* add new Id input */
492         snprintf(buf, sizeof(buf), "addEdge \"n%un%up%d\" \"%u\" \"%u\" \"%u\" \"%d\"\n",
493                 src_idx, tgt_idx, 0,                       /* edge id */
494                 src_idx,                                   /* source node id */
495                 tgt_idx,                                   /* target node id */
496                 get_edge_realizer(old_node, entry->nw),    /* realizer id */
497                 0);                                        /* title */
498         send_cmd(dbg, buf);
499
500         /* go */
501         show_and_sync(dbg);
502
503         /* add the new edge to our pset */
504         new_edge = obstack_alloc(&dbg->obst, sizeof(*new_edge));
505         new_edge->src = old_node;
506         new_edge->tgt = entry->nw;
507         new_edge->pos = 0;
508         pset_insert(dbg->edges, new_edge, HASH_EDGE(new_edge));
509 }
510
511 /**
512  * Hook: Just mark start/end of dead node elimination.
513  */
514 static void firm_ycomp_debug_dead_node_elim(void *context, ir_graph *irg, int start) {
515         firm_ycomp_dbg_t *dbg  = context;
516         (void) irg;
517         dbg->in_dead_node_elim = start != 0;
518 }
519
520 /**
521  * Establish connection to yComp and register all hooks.
522  */
523 void firm_init_ycomp_debugger(const char *host, unsigned port) {
524         static int init_once = 0;
525
526         if (init_once)
527                 return;
528
529         memset(&yy_dbg, 0, sizeof(yy_dbg));
530         yy_dbg.fd = -1;
531
532         fprintf(stderr, "connecting to %s:%u\n", host, port);
533         yy_dbg.fd = firmnet_connect_tcp(host, port);
534
535         if (yy_dbg.fd > -1) {
536                 /* We could establish a connection to ycomp -> register hooks */
537                 firm_ycomp_debug_init_realizer(&yy_dbg);
538                 yy_dbg.exchanged_nodes = new_pset(cmp_nodes, 20);
539                 yy_dbg.edges           = new_pset(cmp_edges, 20);
540                 obstack_init(&yy_dbg.obst);
541
542 #define REGISTER_HOOK(ycomp_hook, firm_hook, func)     \
543         do {                                               \
544                 yy_dbg.ycomp_hook.context           = &yy_dbg; \
545                 yy_dbg.ycomp_hook.hook._##firm_hook = func;    \
546                 register_hook(firm_hook, &yy_dbg.ycomp_hook);  \
547         } while(0)
548
549                 REGISTER_HOOK(hook_new_irn,   hook_new_node,       firm_ycomp_debug_new_node);
550                 REGISTER_HOOK(hook_new_irg,   hook_new_graph,      firm_ycomp_debug_new_irg);
551                 REGISTER_HOOK(hook_set_edge,  hook_set_irn_n,      firm_ycomp_debug_set_edge);
552                 REGISTER_HOOK(hook_exchange,  hook_replace,        firm_ycomp_debug_exchange);
553                 REGISTER_HOOK(hook_into_id,   hook_turn_into_id,   firm_ycomp_debug_turn_into_id);
554                 REGISTER_HOOK(hook_dead_node, hook_dead_node_elim, firm_ycomp_debug_dead_node_elim);
555
556 #undef REGISTER_HOOK
557         }
558
559         init_once = 1;
560 }
561
562 /**
563  * Close connection to yComp, unregister all hooks and free memory.
564  */
565 void firm_finish_ycomp_debugger(void) {
566         if (yy_dbg.fd > -1) {
567                 /* close connection */
568                 firmnet_close_socket(yy_dbg.fd);
569                 yy_dbg.fd = -1;
570
571                 /* unregister all hooks */
572                 unregister_hook(hook_new_graph,      &yy_dbg.hook_new_irg);
573                 unregister_hook(hook_new_node,       &yy_dbg.hook_new_irn);
574                 unregister_hook(hook_set_irn_n,      &yy_dbg.hook_set_edge);
575                 unregister_hook(hook_replace,        &yy_dbg.hook_exchange);
576                 unregister_hook(hook_dead_node_elim, &yy_dbg.hook_dead_node);
577                 unregister_hook(hook_turn_into_id,   &yy_dbg.hook_into_id);
578
579                 /* clear sets */
580                 del_pset(yy_dbg.exchanged_nodes);
581                 del_pset(yy_dbg.edges);
582
583                 /* free data obstack */
584                 obstack_free(&yy_dbg.obst, NULL);
585         }
586 }