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