*** empty log message ***
[libfirm] / testprograms / memory_example.c
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
3 **
4 ** Authors: Christian Schaefer, Goetz Lindenmaier
5 **
6 ** testprogram.
7 */
8
9 # include "irdump.h"
10 # include "firm.h"
11
12 /**  This example demonstrates the use of memory edges.
13 ***  This file constructs the ir for the following pseudo-program:
14 ***
15 ***  int VAR_A
16 ***  int VAR_B
17 ***
18 ***  main() {
19 ***
20 ***    VAR_A = 0
21 ***    VAR_B = 1
22 ***
23 ***    repeat {
24 ***      h = VAR_A;
25 ***      VAR_A = VAR_B;
26 ***      VAR_B = h;
27 ***    } until (0 == h)
28 ***
29 ***    return (VAR_A)
30 ***  }
31 ***
32 ***
33 ***  A better example would be the following program:
34 ***  (name e.g.: memory-imp_example.c as it models imperative concepts.)
35 ***
36 ***  In this program a local variable is dereferenced.  It has
37 ***  to be modeled as an entity of the stack so that a pointer to it is available.
38 ***  It is also an example where an analysis could find out that the
39 ***  pointer is never actually used.
40 ***
41 ***  main () {
42 ***    int a;
43 ***    int *p;
44 ***
45 ***    a = 2;
46 ***    p = &a;
47 ***    return (*p);
48 ***  }
49 ***
50 **/
51
52 int
53 main(void)
54 {
55   ir_graph *irg;
56   type_class *owner;
57   type_method *method;    /* the type of this method */
58   entity *ent;
59   ir_node *a, *b, *x, *y, *r;
60
61   printf("creating an IR graph: MEMORY_EXAMPLE...\n");
62
63   init_firm ();
64
65   /* a class to get started with, containing the main procedure */
66   owner = new_type_class (id_from_str ("MEMORY_EXAMPLE", 14));
67   method = new_type_method (id_from_str("main", 4), 0, 2);
68   ent = new_entity ((type *)owner, id_from_str ("main", 4), (type *)method);
69
70   /* Generates start and end blocks and nodes and a first, initial block */
71   irg = new_ir_graph (ent, 4);
72
73   /* generate two constant pointers to string constants */
74   /* this simulates two global variables, a and b point to these variables */
75   a = new_Const (mode_p, tarval_p_from_str ("VAR_A"));
76   b = new_Const (mode_p, tarval_p_from_str ("VAR_B"));
77
78   /* set VAR_A and VAR_B to constant values */
79   set_store (new_Proj (new_Store (get_store (), a,
80                                   new_Const (mode_I, tarval_from_long (mode_i, 0))),
81                        mode_M, 0));
82
83   set_store (new_Proj (new_Store (get_store (), b,
84                                   new_Const (mode_I, tarval_from_long (mode_i, 1))),
85                        mode_M, 0));
86
87   /* finish this first block */
88   x = new_Jmp ();
89   mature_block (irg->current_block);
90
91   /* a loop body */
92   r = new_Block ();
93   add_in_edge (r, x);
94
95   /* exchange the content of the two variables. Exceptions not cached. */
96   /* load the value and make it's effects visible. */
97   x = new_Load (get_store (), a);
98     set_store (new_Proj (x, mode_M, 0));
99     x = new_Proj(x, mode_I, 2);
100   /* the same again: load the value and make it's effects visible. */
101   y = new_Load (get_store (), b);
102     set_store (new_Proj (y, mode_M, 0));
103     y = new_Proj(y, mode_I, 2);
104   /* store the exchanged values. */
105   set_store (new_Proj (new_Store (get_store (), a, y), mode_M, 0));
106   set_store (new_Proj (new_Store (get_store (), b, x), mode_M, 0));
107
108   /* test the condition */
109   x = new_Cond (
110         new_Proj (
111           new_Cmp (
112             new_Const (mode_I, tarval_from_long (mode_i, 0)),
113             x),
114           mode_b, Gt));
115   /* build the cfg of the loop */
116   add_in_edge (r, new_Proj (x, mode_X, 0));
117   x = new_Proj (x, mode_X, 1);
118   mature_block(r);
119
120   /* generate the block the loop exits to */
121   r = new_Block ();
122   add_in_edge (r, x);
123
124   /* generate the return block and return the content of VAR_A */
125   {
126      ir_node *in[1];
127      x = new_Load (get_store (), a);
128      in[0] = new_Proj (x, mode_I, 2);
129
130      x = new_Return (new_Proj(x, mode_M, 0), 1, in);
131   }
132   mature_block (r);
133   add_in_edge (irg->end_block, x);
134   mature_block (irg->end_block);
135
136   /* verify the graph */
137   irg_vrfy(irg);
138
139   printf("\nDone building the graph.  Dumping it.\n");
140   dump_ir_block_graph (irg);
141
142   printf("use xvcg to view this graph:\n");
143   printf("/ben/goetz/bin/xvcg GRAPHNAME\n");
144
145   return (0);
146 }