another comment after #include
[libfirm] / testprograms / dead_block_example.c
1 /*
2  * Project:     libFIRM
3  * File name:   testprograms/dead_block_example.c
4  * Purpose:     Test unreachable code elimination.
5  * Author:      Christian Schaefer, Goetz Lindenmaier
6  * Modified by:
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1999-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 #include <stdio.h>
14 #include <string.h>
15
16
17
18 #include <libfirm/firm.h>
19
20 /*
21  *   a dead block / unreachable code.
22  */
23
24 /**
25 *  This file constructs a control flow of following shape:
26 *
27 *
28 *         firstBlock
29 *          /   \
30 *         /     \
31 *       |/_     _\|
32 *     Block1    Block2   deadBlock
33 *        \       |       /
34 *       \      |      /
35 *       _\|   \ /   |/_
36 *            nextBlock
37 *
38 *
39 *   This is a program as, e.g.,
40 *
41 *   if () then
42 *     { Jmp label1; } //  happens anyways
43 *   else
44 *     { Jmp label1; } //  happens anyways
45 * label1:
46 *   return();
47 *   Jmp label1;
48 *
49 **/
50
51 int main(void)
52 {
53   char *dump_file_suffix = "";
54   ir_graph *irg;          /* this variable contains the irgraph */
55   ir_type *owner;      /* the class in which this method is defined */
56   ir_type *proc_main; /* ir_type information for the method main */
57   ir_type     *prim_t_int;
58   ir_entity *ent;            /* represents this method as ir_entity of owner */
59   ir_node *c1, *c2, *cond, *f, *t, *endBlock, *Block1, *jmp, *Block2,
60           *deadBlock, *x;
61
62   /* init library */
63   init_firm (NULL);
64
65   /*** Make basic ir_type information for primitive ir_type int. ***/
66   prim_t_int = new_type_primitive(new_id_from_chars ("int", 3), mode_Is);
67
68   /* FIRM was designed for oo languages where all methods belong to a class.
69    * For imperative languages like C we view a file as a large class containing
70    * all functions as methods in this file.
71    * Therefore we define a class "empty" according to the file name
72    * with a method main as an ir_entity.
73    */
74 #define CLASSNAME "DEAD_BLOCK"
75 #define METHODNAME "main"
76 #define NRARGS 0
77 #define NRES 1
78   printf("\nCreating an IR graph: %s...\n", CLASSNAME);
79
80   owner = new_type_class (new_id_from_chars (CLASSNAME, strlen(CLASSNAME)));
81   proc_main = new_type_method(new_id_from_chars(METHODNAME, strlen(METHODNAME)),
82                               NRARGS, NRES);
83   set_method_res_type(proc_main, 0, prim_t_int);
84   ent = new_entity (owner,
85                     new_id_from_chars (METHODNAME, strlen(METHODNAME)),
86                     proc_main);
87   get_entity_ld_name(ent); /* To enforce name mangling for vcg graph name */
88 #define NUM_OF_LOCAL_VARS 1
89
90   irg = new_ir_graph (ent, NUM_OF_LOCAL_VARS);
91
92   /* to make a condition  */
93   c1 = new_Const (mode_Is, new_tarval_from_long (1, mode_Is));
94   c2 = new_Const (mode_Is, new_tarval_from_long (2, mode_Is));
95   set_value(0, c2);
96
97   cond = new_Cond(new_Proj(new_Cmp(c1, c2), mode_b, pn_Cmp_Eq));
98   f = new_Proj(cond, mode_X, 0);
99   t = new_Proj(cond, mode_X, 1);
100   mature_immBlock(get_irg_current_block(irg));
101
102   /* end block to add jmps */
103   endBlock = new_immBlock();
104
105   /* Block 1 */
106   Block1 = new_immBlock();
107   add_immBlock_pred(Block1, t);
108   mature_immBlock(Block1);
109   jmp = new_Jmp();
110   add_immBlock_pred(endBlock, jmp);
111
112   /* Block 2 */
113   Block2 = new_immBlock();
114   add_immBlock_pred(Block2, f);
115   mature_immBlock(Block2);
116   jmp = new_Jmp();
117   add_immBlock_pred(endBlock, jmp);
118
119   /* dead Block */
120   deadBlock = new_immBlock();
121   mature_immBlock(deadBlock);
122   jmp = new_Jmp();
123   add_immBlock_pred(endBlock, jmp);
124
125   /* finish end block */
126   set_cur_block(endBlock);
127   {
128     ir_node *in[1];
129     in[0] = get_value(0, mode_Is);
130     get_store();
131     x = new_Return (get_store(), 1, in);
132   }
133   mature_immBlock (get_irg_current_block(irg));
134
135   add_immBlock_pred (get_irg_end_block(irg), x);
136   mature_immBlock (get_irg_end_block(irg));
137
138   irg_finalize_cons (irg);
139
140   printf("Optimizing ...\n");
141   local_optimize_graph (irg);
142   dead_node_elimination (irg);
143
144   /* verify the graph */
145   irg_vrfy(irg);
146
147   printf("Dumping the graph and a control flow graph.\n");
148   dump_ir_block_graph (irg, dump_file_suffix);
149   dump_cfg (irg, dump_file_suffix);
150   printf("Use ycomp to view these graphs:\n");
151   printf("ycomp GRAPHNAME\n\n");
152
153   return (0);
154 }