remove $Id$, it doesn't work with git anyway
[libfirm] / ir / be / bechordal_draw.c
1 /*
2  * Copyright (C) 1995-2008 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       Paint chordal graphs.
23  * @author      Sebastian Hack
24  * @date        12.05.2005
25  */
26 #include "config.h"
27
28 #include <limits.h>
29
30 #include "pmap.h"
31 #include "pset.h"
32
33 #include "irgwalk.h"
34 #include "irprintf.h"
35 #include "iredges_t.h"
36 #include "util.h"
37
38 #include "belive_t.h"
39 #include "bechordal_t.h"
40 #include "besched.h"
41 #include "bechordal_draw.h"
42 #include "beirg.h"
43
44 typedef struct {
45         be_chordal_env_t *env;
46         plotter_t inh;
47         const color_t *color;
48         int width;
49 } base_plotter_t;
50
51 #define decl_self(type, from) \
52   type *self = (type *) from
53
54 static void set_color(plotter_t *_self, const color_t *color)
55 {
56         decl_self(base_plotter_t, _self);
57         self->color = color;
58 }
59
60 static const color_t *get_color(const plotter_t *_self)
61 {
62         decl_self(const base_plotter_t, _self);
63         return self->color;
64 }
65
66 static void set_width(plotter_t *_self, int width)
67 {
68         decl_self(base_plotter_t, _self);
69         self->width = width;
70 }
71
72 static int get_width(const plotter_t *_self)
73 {
74         decl_self(const base_plotter_t, _self);
75         return self->width;
76 }
77
78 static void plotter_default_free(plotter_t *self)
79 {
80         (void) self;
81 }
82
83 typedef struct {
84         base_plotter_t inh;
85         const char     *filename;
86         FILE           *f;
87 } ps_plotter_t;
88
89
90 /*
91   ____  ____    ____  _       _   _
92  |  _ \/ ___|  |  _ \| | ___ | |_| |_ ___ _ __
93  | |_) \___ \  | |_) | |/ _ \| __| __/ _ \ '__|
94  |  __/ ___) | |  __/| | (_) | |_| ||  __/ |
95  |_|   |____/  |_|   |_|\___/ \__|\__\___|_|
96
97 */
98
99 static void ps_begin(plotter_t *_self, const rect_t *vis)
100 {
101         FILE *f;
102         decl_self(ps_plotter_t, _self);
103
104         f = self->f = fopen(self->filename, "wt");
105         fprintf(f, "%%!PS-Adobe-2.0\n");
106         fprintf(f, "%%%%BoundingBox: %d %d %d %d\n", vis->x, vis->y, vis->w, vis->h);
107 #if 0
108         fprintf(f, "/mainfont /Courier findfont %f scalefont def\n", 10.0);
109         fprintf(f, "mainfont setfont\n");
110 #endif /* if 0 */
111 }
112
113 static void ps_setcolor(plotter_t *_self, const color_t *color)
114 {
115         decl_self(ps_plotter_t, _self);
116         set_color(_self, color);
117
118         fprintf(self->f, "%.2f %.2f %.2f setrgbcolor\n",
119                 color->r, color->g, color->b);
120 }
121
122 static void ps_line(plotter_t *_self, int x1, int y1, int x2, int y2)
123 {
124         decl_self(ps_plotter_t, _self);
125
126         fprintf(self->f, "%d %d moveto\n", x1, y1);
127         fprintf(self->f, "%d %d lineto\n", x2, y2);
128         fprintf(self->f, "stroke\n");
129 }
130
131 static void ps_box(plotter_t *_self, const rect_t *rect)
132 {
133         decl_self(ps_plotter_t, _self);
134
135         fprintf(self->f, "%d %d %d %d rectstroke\n",
136                 rect->x, rect->y, rect->w, rect->h);
137 }
138
139 static void ps_text(plotter_t *_self, int x, int y, const char *str)
140 {
141         decl_self(ps_plotter_t, _self);
142
143         fprintf(self->f, "%d %d moveto\n", x, y);
144         fprintf(self->f, "(%s) show\n", str);
145 }
146
147 static void ps_finish(plotter_t *_self)
148 {
149         decl_self(ps_plotter_t, _self);
150         fclose(self->f);
151 }
152
153 static const plotter_if_t ps_plotter_vtab = {
154         ps_begin,
155         ps_setcolor,
156         get_color,
157         set_width,
158         get_width,
159         ps_line,
160         ps_box,
161         ps_text,
162         ps_finish,
163         plotter_default_free
164 };
165
166 plotter_t *new_plotter_ps(const char *filename)
167 {
168         ps_plotter_t *ps_plotter = XMALLOC(ps_plotter_t);
169         plotter_t *p = (plotter_t *) ps_plotter;
170
171         ps_plotter->filename = filename;
172         p->vtab = &ps_plotter_vtab;
173         return p;
174 }
175
176 /*
177    _____ _ _     _____  ____  _       _   _
178   |_   _(_) | __|__  / |  _ \| | ___ | |_| |_ ___ _ __
179     | | | | |/ /  / /  | |_) | |/ _ \| __| __/ _ \ '__|
180     | | | |   <  / /_  |  __/| | (_) | |_| ||  __/ |
181     |_| |_|_|\_\/____| |_|   |_|\___/ \__|\__\___|_|
182
183 */
184
185 /* chriswue: the following seems to be unused and can be deleted? */
186 #if 0
187 typedef struct {
188         base_plotter_t inh;
189         const char *filename;
190         FILE *f;
191 } tikz_plotter_t;
192
193 static void tikz_begin(plotter_t *_self, const rect_t *vis)
194 {
195         FILE *f;
196         decl_self(tikz_plotter_t, _self);
197
198         f = self->f = fopen(self->filename, "wt");
199         fprintf(f, "\\begin{tikzpicture}\n");
200 }
201
202 static void tikz_setcolor(plotter_t *_self, const color_t *color)
203 {
204         set_color(_self, color);
205 }
206
207 static void tikz_line(plotter_t *_self, int x1, int y1, int x2, int y2)
208 {
209         decl_self(tikz_plotter_t, _self);
210         fprintf(self->f, "\t\\draw (%d,%d) -- (%d,%d);\n", x1, y1, x2, y2);
211 }
212
213 static void tikz_box(plotter_t *_self, const rect_t *rect)
214 {
215         decl_self(tikz_plotter_t, _self);
216
217         fprintf(self->f, "\t\\draw (%d,%d) rectangle (%d, %d)\n",
218                 rect->x, rect->y, rect->x + rect->w, rect->y + rect->h);
219 }
220
221 void tikz_text(plotter_t *_self, int x, int y, const char *str)
222 {
223         decl_self(tikz_plotter_t, _self);
224         fprintf(self->f, "\t\\draw (%d,%d) node {%s};\n", x, y, str);
225 }
226
227 static void tikz_finish(plotter_t *_self)
228 {
229         decl_self(tikz_plotter_t, _self);
230         fclose(self->f);
231 }
232 #endif /* if 0 */
233
234
235 extern void plotter_free(plotter_t *self)
236 {
237         self->vtab->free(self);
238         free(self);
239 }
240
241 const draw_chordal_opts_t draw_chordal_def_opts = {
242         10, 10, 30, 8, 10, 10
243 };
244
245 typedef struct draw_chordal_env_t {
246         const be_chordal_env_t      *chordal_env;
247         const arch_register_class_t *cls;
248         pmap                        *block_dims;
249         plotter_t                   *plotter;
250         const draw_chordal_opts_t   *opts;
251         struct obstack              obst;
252         int                         max_color;
253 } draw_chordal_env_t;
254
255 struct block_dims {
256         unsigned max_step;
257         int      min_step;
258         int      max_color;
259         rect_t   box;
260         rect_t   subtree_box;
261 };
262
263 #define doz(a, b) MAX((a) - (b), 0)
264
265 static void block_dims_walker(ir_node *block, void *data)
266 {
267         draw_chordal_env_t        *env  = (draw_chordal_env_t*)data;
268         struct list_head          *head = get_block_border_head(env->chordal_env, block);
269         const draw_chordal_opts_t *opts = env->opts;
270         struct block_dims         *dims = OALLOCZ(&env->obst, struct block_dims);
271         border_t                  *b;
272
273         dims->min_step = INT_MAX;
274
275         list_for_each_entry_reverse(border_t, b, head, list) {
276                 ir_node               *irn = b->irn;
277                 const arch_register_t *reg = arch_get_irn_register(irn);
278                 int                   col  = arch_register_get_index(reg);
279
280                 dims->max_step  = MAX(dims->max_step, b->step);
281                 dims->max_color = MAX(dims->max_color, col);
282                 env->max_color  = MAX(env->max_color, col);
283         }
284
285         dims->min_step = 1;
286
287 #if 1
288         dims->box.w = (dims->max_color + 2) * opts->h_inter_gap;
289         dims->box.h = dims->max_step * opts->v_inter_gap;
290 #else /* ! if 1 */
291         dims->box.w = dims->box.h = 10;
292 #endif /* if 1 */
293
294         pmap_insert(env->block_dims, block, dims);
295 }
296
297 static void layout(const draw_chordal_env_t *env, ir_node *bl, int x)
298 {
299         const draw_chordal_opts_t *opts   = env->opts;
300         struct block_dims         *dims   = (struct block_dims*)pmap_get(env->block_dims, bl);
301         rect_t                    *rect   = &dims->subtree_box;
302         int                       h_space = 0;
303         int                       v_space = 0;
304         ir_node                   *sub;
305
306         memset(rect, 0, sizeof(*rect));
307         rect->x = x;
308
309         dominates_for_each(bl, sub) {
310                 struct block_dims *bl_dim = (struct block_dims*)pmap_get(env->block_dims, sub);
311
312                 layout(env, sub, rect->x + rect->w);
313
314                 rect->w += h_space + bl_dim->subtree_box.w;
315                 rect->h  = MAX(rect->h, bl_dim->subtree_box.h);
316
317                 h_space = opts->h_gap;
318                 v_space = opts->v_gap;
319         }
320
321         rect->w = MAX(rect->w, dims->box.w + opts->h_gap);
322
323         dims->box.x = x + doz(rect->w, dims->box.w) / 2;
324         dims->box.y = rect->h + v_space;
325
326         rect->h = dims->box.y + dims->box.h;
327 }
328
329 static void set_y(const draw_chordal_env_t *env, ir_node *bl, int up)
330 {
331         const draw_chordal_opts_t *opts      = env->opts;
332         struct block_dims         *dims      = (struct block_dims*)pmap_get(env->block_dims, bl);
333         int                       max_height = dims->subtree_box.h - dims->box.h - opts->v_gap;
334         ir_node                   *sub;
335
336         dominates_for_each(bl, sub) {
337                 struct block_dims *bl_dim = (struct block_dims*)pmap_get(env->block_dims, sub);
338                 int height_diff = max_height - bl_dim->subtree_box.h;
339
340                 set_y(env, sub, up + height_diff);
341         }
342
343         dims->subtree_box.y += up;
344         dims->box.y         += up;
345 }
346
347 static color_t *reg_to_color(const draw_chordal_env_t *env,
348                                                          ir_node *rel_bl, ir_node *irn, color_t *color)
349 {
350         int             phi_arg = 0;
351         const ir_edge_t *edge;
352         (void) env;
353         (void) rel_bl;
354
355         foreach_out_edge(irn, edge)
356                 phi_arg |= is_Phi(edge->src);
357
358 #if 1
359         color->r = is_Phi(irn) ? 0.5 : 0.0;
360         color->g = phi_arg ? 0.5 : 0.0;
361         color->b = 0.0;
362 #else /* ! if 1 */
363         {
364                 int live_in  = is_live_in(rel_bl, irn);
365                 int live_out = is_live_out(rel_bl, irn);
366
367                 color->r = live_in;
368                 color->g = live_out;
369                 color->b = 0.0;
370         }
371 #endif /* if 1 */
372
373         return color;
374 }
375
376 static void draw_block(ir_node *bl, void *data)
377 {
378         static const color_t      black    = { 0, 0, 0 };
379         const draw_chordal_env_t  *env     = (const draw_chordal_env_t*)data;
380         const be_lv_t             *lv      = be_get_irg_liveness(env->chordal_env->irg);
381         struct list_head          *head    = get_block_border_head(env->chordal_env, bl);
382         ir_node                   *dom     = get_Block_idom(bl);
383         const draw_chordal_opts_t *opts    = env->opts;
384         struct block_dims         *dims    = (struct block_dims*)pmap_get(env->block_dims, bl);
385         char                      buf[64];
386         border_t                  *b;
387         int                       idx;
388
389         ir_snprintf(buf, sizeof(buf), "%F", bl);
390
391         env->plotter->vtab->set_color(env->plotter, &black);
392         env->plotter->vtab->box(env->plotter, &dims->box);
393
394 #if 1
395         env->plotter->vtab->text(env->plotter, dims->box.x, dims->box.y, buf);
396 #endif
397
398         list_for_each_entry(border_t, b, head, list) {
399                 if (b->is_def) {
400                         const arch_register_t *reg = arch_get_irn_register(b->irn);
401                         int col      = arch_register_get_index(reg);
402                         int live_out = be_is_live_out(lv, bl, b->irn);
403                         int x        = (col + 1) * opts->h_inter_gap;
404                         int ystart   = (b->step) * opts->v_inter_gap;
405                         int ystop    = (b->other_end->step) * opts->v_inter_gap + (live_out ? 0 : opts->v_inter_gap / 2);
406
407                         color_t color;
408                         reg_to_color(env, bl, b->irn, &color);
409
410                         x      += dims->box.x;
411                         ystart += dims->box.y;
412                         ystop  += dims->box.y;
413
414                         env->plotter->vtab->set_color(env->plotter, &color);
415                         env->plotter->vtab->line(env->plotter, x, ystart, x, ystop);
416
417                         env->plotter->vtab->line(env->plotter, x - 2, ystart, x + 2, ystart);
418                         env->plotter->vtab->line(env->plotter, x - 2, ystop, x + 2, ystop);
419                 }
420         }
421
422         if (dom) {
423                 struct block_dims *dom_dims = (struct block_dims*)pmap_get(env->block_dims, dom);
424
425                 be_lv_foreach(lv, bl, be_lv_state_in, idx) {
426                         ir_node *irn = be_lv_get_irn(lv, bl, idx);
427                         if (arch_irn_consider_in_reg_alloc(env->cls, irn)) {
428                                 const arch_register_t *reg = arch_get_irn_register(irn);
429                                 int     col = arch_register_get_index(reg);
430                                 int     x   = (col + 1) * opts->h_inter_gap;
431                                 color_t color;
432
433                                 reg_to_color(env, bl, irn, &color);
434
435                                 env->plotter->vtab->set_color(env->plotter, &color);
436                                 env->plotter->vtab->line(env->plotter,
437                                         dims->box.x + x,
438                                         dims->box.y + dims->box.h,
439                                         dom_dims->box.x + x,
440                                         dom_dims->box.y);
441                         }
442                 }
443         }
444 }
445
446 static void draw(draw_chordal_env_t *env, const rect_t *start_box)
447 {
448         plotter_t *p = env->plotter;
449         be_lv_t *lv;
450         rect_t bbox;
451
452         bbox.x = bbox.y = 0;
453         bbox.w = start_box->w + 2 * env->opts->x_margin;
454         bbox.h = start_box->h + 2 * env->opts->y_margin;
455
456         lv = be_assure_liveness(env->chordal_env->irg);
457         be_liveness_assure_sets(lv);
458         be_liveness_assure_chk(lv);
459
460         p->vtab->begin(p, &bbox);
461         irg_block_walk_graph(env->chordal_env->irg, draw_block, NULL, env);
462         p->vtab->finish(p);
463 }
464
465 void draw_interval_tree(const draw_chordal_opts_t *opts,
466                         const be_chordal_env_t *chordal_env, plotter_t *plotter)
467 {
468         draw_chordal_env_t env;
469         struct block_dims  *start_dims;
470         ir_node            *start_block = get_irg_start_block(chordal_env->irg);
471
472         env.opts        = opts;
473         env.block_dims  = pmap_create();
474         env.plotter     = plotter;
475         env.cls         = chordal_env->cls;
476         env.max_color   = 0;
477         env.chordal_env = chordal_env;
478         obstack_init(&env.obst);
479
480         irg_block_walk_graph(chordal_env->irg, block_dims_walker, NULL, &env);
481         layout(&env, start_block, opts->x_margin);
482         set_y(&env, start_block, opts->y_margin);
483         start_dims = (struct block_dims*)pmap_get(env.block_dims, start_block);
484         draw(&env, &start_dims->subtree_box);
485
486         pmap_destroy(env.block_dims);
487         obstack_free(&env.obst, NULL);
488 }