Added support for SymConst(ofs_ent)
[libfirm] / ir / be / TEMPLATE / TEMPLATE_gen_decls.c
1 /**
2  * Dumps global variables and constants as TEMPLATE assembler.
3  * @date 14.02.2006
4  * @version $Id$
5  */
6
7 #include <stdlib.h>
8 #include <string.h>
9 #include <ctype.h>
10 #include <assert.h>
11
12 #include "xmalloc.h"
13 #include <obstack.h>
14
15 #ifdef obstack_chunk_alloc
16 # undef obstack_chunk_alloc
17 # define obstack_chunk_alloc xmalloc
18 #else
19 # define obstack_chunk_alloc xmalloc
20 # define obstack_chunk_free free
21 #endif
22
23 #include "tv.h"
24 #include "irnode.h"
25 #include "entity.h"
26 #include "irprog.h"
27
28 #include "TEMPLATE_gen_decls.h"
29
30 /************************************************************************/
31
32 /*
33  * returns the highest bit value
34  */
35 static unsigned highest_bit(unsigned v)
36 {
37   int res = -1;
38
39   if (v >= (1U << 16U)) {
40     res += 16;
41     v >>= 16;
42   }
43   if (v >= (1U << 8U)) {
44     res += 8;
45     v >>= 8;
46   }
47   if (v >= (1U << 4U)) {
48     res += 4;
49     v >>= 4;
50   }
51   if (v >= (1U << 2U)) {
52     res += 2;
53     v >>= 2;
54   }
55   if (v >= (1U << 1U)) {
56     res += 1;
57     v >>= 1;
58   }
59   if (v >= 1)
60     res += 1;
61
62   return res;
63 }
64
65 /*
66  * output the alignment
67  */
68 static void TEMPLATE_dump_align(struct obstack *obst, int align)
69 {
70   int h = highest_bit(align);
71
72   if ((1 << h) < align)
73     ++h;
74   align = (1 << h);
75
76   if (align > 1)
77     obstack_printf(obst, "\t.align %d\n", align);
78 }
79
80 static void dump_arith_tarval(struct obstack *obst, tarval *tv, int bytes)
81 {
82   switch (bytes) {
83
84   case 1:
85     obstack_printf(obst, "0x%02x", get_tarval_sub_bits(tv, 0));
86     break;
87
88   case 2:
89     obstack_printf(obst, "0x%02x%02x", get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
90     break;
91
92   case 4:
93     obstack_printf(obst, "0x%02x%02x%02x%02x",
94         get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
95     break;
96
97   case 8:
98     obstack_printf(obst, "0x%02x%02x%02x%02x%02x%02x%02x%02x",
99         get_tarval_sub_bits(tv, 7), get_tarval_sub_bits(tv, 6), get_tarval_sub_bits(tv, 5), get_tarval_sub_bits(tv, 4),
100         get_tarval_sub_bits(tv, 3), get_tarval_sub_bits(tv, 2), get_tarval_sub_bits(tv, 1), get_tarval_sub_bits(tv, 0));
101     break;
102
103   case 10:
104   case 12:
105     break;
106
107   default:
108     fprintf(stderr, "Try to dump an tarval with %d bytes\n", bytes);
109     assert(0);
110   }
111 }
112
113 /*
114  * dump an arithmetic tarval
115  */
116 static void TEMPLATE_dump_arith_tarval(struct obstack *obst, tarval *tv, int bytes)
117 {
118   switch (bytes) {
119
120   case 1:
121     obstack_printf(obst, "\t.byte\t");
122     break;
123
124   case 2:
125     obstack_printf(obst, "\t.value\t");
126     break;
127
128   case 4:
129     obstack_printf(obst, "\t.long\t");
130     break;
131
132   case 8:
133     obstack_printf(obst, "\t.quad\t");
134     break;
135
136   case 10:
137   case 12:
138     break;
139
140   default:
141     fprintf(stderr, "Try to dump an tarval with %d bytes\n", bytes);
142     assert(0);
143   }
144   dump_arith_tarval(obst, tv, bytes);
145 }
146
147
148 /*
149  * dump an atomic value
150  */
151 static void do_dump_atomic_init(struct obstack *obst, ir_node *init)
152 {
153   ir_mode *mode = get_irn_mode(init);
154   int bytes     = get_mode_size_bytes(mode);
155   tarval *tv;
156
157   switch (get_irn_opcode(init)) {
158
159   case iro_Cast:
160     do_dump_atomic_init(obst, get_Cast_op(init));
161     return;
162
163   case iro_Conv:
164     do_dump_atomic_init(obst, get_Conv_op(init));
165     return;
166
167   case iro_Const:
168     tv = get_Const_tarval(init);
169
170     /* beware of old stuff */
171     assert(! mode_is_reference(mode));
172
173     /* it's a arithmetic value */
174     dump_arith_tarval(obst, tv, bytes);
175     return;
176
177   case iro_SymConst:
178     switch (get_SymConst_kind(init)) {
179     case symconst_addr_name:
180       obstack_printf(obst, "%s", get_id_str(get_SymConst_name(init)));
181       break;
182
183     case symconst_addr_ent:
184       obstack_printf(obst, "%s", get_entity_ld_name(get_SymConst_entity(init)));
185       break;
186
187     case symconst_ofs_ent:
188       obstack_printf(obst, "%d", get_entity_offset_bytes(get_SymConst_entity(init)));
189       break;
190
191     case symconst_type_size:
192       obstack_printf(obst, "%d", get_type_size_bytes(get_SymConst_type(init)));
193       break;
194
195     case symconst_type_align:
196       obstack_printf(obst, "%d", get_type_alignment_bytes(get_SymConst_type(init)));
197       break;
198
199     default:
200       assert(0 && "dump_atomic_init(): don't know how to init from this SymConst");
201     }
202     return;
203
204   case iro_Add:
205     do_dump_atomic_init(obst, get_Add_left(init));
206     obstack_printf(obst, " + ");
207     do_dump_atomic_init(obst, get_Add_right(init));
208     return;
209
210   case iro_Sub:
211     do_dump_atomic_init(obst, get_Sub_left(init));
212     obstack_printf(obst, " - ");
213     do_dump_atomic_init(obst, get_Sub_right(init));
214     return;
215
216   case iro_Mul:
217     do_dump_atomic_init(obst, get_Mul_left(init));
218     obstack_printf(obst, " * ");
219     do_dump_atomic_init(obst, get_Mul_right(init));
220     return;
221
222   default:
223     assert(0 && "dump_atomic_init(): unknown IR-node");
224   }
225 }
226
227 /*
228  * dump an atomic value
229  */
230 static void dump_atomic_init(struct obstack *obst, ir_node *init)
231 {
232   ir_mode *mode = get_irn_mode(init);
233   int bytes     = get_mode_size_bytes(mode);
234
235   switch (bytes) {
236
237   case 1:
238     obstack_printf(obst, "\t.byte\t");
239     break;
240
241   case 2:
242     obstack_printf(obst, "\t.value\t");
243     break;
244
245   case 4:
246     obstack_printf(obst, "\t.long\t");
247     break;
248
249   case 8:
250     obstack_printf(obst, "\t.quad\t");
251     break;
252
253   case 10:
254   case 12:
255     /* handled in arith */
256     break;
257
258   default:
259     fprintf(stderr, "Try to dump an tarval with %d bytes\n", bytes);
260     assert(0);
261   }
262
263   do_dump_atomic_init(obst, init);
264   obstack_printf(obst, "\n");
265 }
266
267 /************************************************************************/
268 /* Routines to dump global variables                                    */
269 /************************************************************************/
270
271 /**
272  * Determine if an entity is a string constant
273  * @param ent The entity
274  * @return 1 if it is a string constant, 0 otherwise
275  */
276 static int ent_is_string_const(entity *ent)
277 {
278   int res = 0;
279   ir_type *ty;
280
281   ty = get_entity_type(ent);
282
283   /* if it's an array */
284   if (is_Array_type(ty)) {
285     ir_type *elm_ty = get_array_element_type(ty);
286
287     /* and the array's element type is primitive */
288     if (is_Primitive_type(elm_ty)) {
289       ir_mode *mode = get_type_mode(elm_ty);
290
291       /*
292        * and the mode of the element type is an int of
293        * the same size as the byte mode
294        */
295       if (mode_is_int(mode)
296          && get_mode_size_bits(mode) == get_mode_size_bits(mode_Bs))
297       {
298         int i, c, n;
299
300         n = get_compound_ent_n_values(ent);
301         for (i = 0; i < n; ++i) {
302           ir_node *irn = get_compound_ent_value(ent, i);
303           if(get_irn_opcode(irn) != iro_Const)
304             return 0;
305
306           c = (int) get_tarval_long(get_Const_tarval(irn));
307
308           if((i < n - 1 && !(isgraph(c) || isspace(c)))
309              || (i == n - 1 && c != '\0'))
310             return 0;
311         }
312
313         res = 1;
314       }
315     }
316   }
317
318   return res;
319 }
320
321 /**
322  * Dump a atring constant.
323  * No checks are made!!
324  * @param obst The obst to dump on.
325  * @param ent The entity to dump.
326  */
327 static void dump_string_cst(struct obstack *obst, entity *ent)
328 {
329   int i, n;
330
331   obstack_printf(obst, "\t.string \"");
332   n = get_compound_ent_n_values(ent);
333
334   for (i = 0; i < n-1; ++i) {
335     ir_node *irn;
336     int c;
337
338     irn = get_compound_ent_value(ent, i);
339     c = (int) get_tarval_long(get_Const_tarval(irn));
340
341     switch (c) {
342     case '"' : obstack_printf(obst, "\\\""); break;
343     case '\n': obstack_printf(obst, "\\n"); break;
344     case '\r': obstack_printf(obst, "\\r"); break;
345     case '\t': obstack_printf(obst, "\\t"); break;
346     default  :
347       if (isprint(c))
348         obstack_printf(obst, "%c", c);
349       else
350         obstack_printf(obst, "%O", c);
351       break;
352     }
353   }
354   obstack_printf(obst, "\"\n");
355 }
356
357 struct arr_info {
358   int n_elems;
359   int visit_cnt;
360   int size;
361 };
362
363 /*
364  * Dumps the initialization of global variables that are not
365  * "uninitialized".
366  */
367 static void dump_global(struct obstack *rdata_obstack, struct obstack *data_obstack, struct obstack *comm_obstack, entity *ent)
368 {
369   ir_type *ty         = get_entity_type(ent);
370   const char *ld_name = get_entity_ld_name(ent);
371   int align, h;
372   struct obstack *obst = data_obstack;
373
374   /*
375    * FIXME: did NOT work for partly constant values
376    */
377   if (! is_Method_type(ty)) {
378     ir_variability variability = get_entity_variability(ent);
379     ir_visibility visibility = get_entity_visibility(ent);
380
381     if (variability == variability_constant) {
382       /* a constant entity, put it on the rdata */
383       obst = rdata_obstack;
384     }
385
386     /* check, wether it is initialized, if yes create data */
387     if (variability != variability_uninitialized) {
388       if (visibility == visibility_external_visible) {
389         obstack_printf(obst, ".globl\t%s\n", ld_name);
390       }
391       obstack_printf(obst, "\t.type\t%s,@object\n", ld_name);
392       obstack_printf(obst, "\t.size\t%s,%d\n", ld_name, (get_type_size_bits(ty) + 7) >> 3);
393
394       align = get_type_alignment_bytes(ty);
395       TEMPLATE_dump_align(obst, align);
396
397       obstack_printf(obst, "%s:\n", ld_name);
398
399       if (is_atomic_type(ty)) {
400         if (get_entity_visibility(ent) != visibility_external_allocated)
401           dump_atomic_init(obst, get_atomic_ent_value(ent));
402       }
403       else {
404         int i, size = 0;
405
406         if (ent_is_string_const(ent)) {
407           dump_string_cst(obst, ent);
408         }
409         else if (is_Array_type(ty)) {
410           int filler;
411
412           /* potential spare values should be already included! */
413           for (i = 0; i < get_compound_ent_n_values(ent); ++i) {
414             entity *step = get_compound_ent_value_member(ent, i);
415             ir_type *stype = get_entity_type(step);
416
417             if (get_type_mode(stype)) {
418               int align = (get_type_alignment_bits(stype) + 7) >> 3;
419               int n     = size % align;
420
421               if (n > 0) {
422                 obstack_printf(obst, "\t.zero\t%d\n", align - n);
423                 size += align - n;
424               }
425             }
426             dump_atomic_init(obst, get_compound_ent_value(ent, i));
427             size += get_type_size_bytes(stype);
428           }
429           filler = get_type_size_bytes(ty) - size;
430
431           if (filler > 0)
432             obstack_printf(obst, "\t.zero\t%d\n", filler);
433         }
434         else if (is_compound_type(ty)) {
435           ir_node **vals;
436           int type_size, j;
437
438           /* Compound entities are NOT sorted.
439            * The sorting strategy used doesn't work for `value' compound fields nor
440            * for partially_constant entities.
441            */
442
443           /*
444            * in the worst case, every entity allocates one byte, so the type
445            * size should be equal or bigger the number of fields
446            */
447           type_size = get_type_size_bytes(ty);
448           vals      = xcalloc(type_size, sizeof(*vals));
449
450           /* collect the values and store them at the offsets */
451           for(i = 0; i < get_compound_ent_n_values(ent); ++i) {
452             int                 graph_length, aipos, offset;
453             struct arr_info     *ai;
454             int                 all_n = 1;
455             compound_graph_path *path = get_compound_ent_value_path(ent, i);
456
457             /* get the access path to the costant value */
458             graph_length = get_compound_graph_path_length(path);
459             ai = xcalloc(graph_length, sizeof(struct arr_info));
460
461             /* We wanna know how many arrays are on the path to the entity. We also have to know how
462              * many elements each array holds to calculate the offset for the entity. */
463             for (j = 0; j < graph_length; j++) {
464               entity  *step      = get_compound_graph_path_node(path, j);
465               ir_type *step_type = get_entity_type(step);
466               int     ty_size    = (get_type_size_bits(step_type) + 7) >> 3;
467               int     k, n       = 0;
468
469               if (is_Array_type(step_type))
470                 for (k = 0; k < get_array_n_dimensions(step_type); k++)
471                   n += get_tarval_long(get_Const_tarval(get_array_upper_bound(step_type, k)));
472               if (n) all_n *= n;
473               ai[j].n_elems = n ? all_n + 1 : 0;
474               ai[j].visit_cnt = 0;
475               ai[j].size = ty_size;
476             }
477
478             aipos = graph_length - 1;
479             if (aipos) aipos--;
480
481             for (offset = j = 0; j < graph_length; j++) {
482               entity *step       = get_compound_graph_path_node(path, j);
483               ir_type *step_type = get_entity_type(step);
484               int ent_ofs        = get_entity_offset_bytes(step);
485               int stepsize       = 0;
486
487               /* add all positive offsets (= offsets in structs) */
488               if (ent_ofs >= 0) offset += ent_ofs;
489
490               if (j == graph_length - 1) {
491                 stepsize = (get_type_size_bits(step_type) + 7) >> 3;
492
493                 /* Search the next free position in vals depending on the information from above (ai). */
494                 while (vals[offset]) {
495                   if (ai[aipos].visit_cnt < ai[aipos].n_elems) {
496                     offset += stepsize;
497                     ai[aipos].visit_cnt++;
498                   }
499                   else
500                     while (aipos >= 0 && ai[aipos].visit_cnt == ai[aipos].n_elems) {
501                       stepsize = ai[aipos--].size;
502                       offset  += stepsize;
503                   }
504                 }
505
506                 assert(aipos >= 0 && "couldn't store entity");
507                 vals[offset] = get_compound_ent_value(ent, i);
508               }
509             }
510
511             free(ai);
512           }
513
514           /* now write them sorted */
515           for(i = 0; i < type_size; ) {
516             if (vals[i]) {
517               dump_atomic_init(obst, vals[i]);
518               i += (get_mode_size_bytes(get_irn_mode(vals[i])));
519             }
520             else {
521               /* a gap */
522               obstack_printf(obst, "\t.byte\t0\n");
523               ++i;
524             }
525           }
526           free(vals);
527         }
528         else {
529           assert(0 && "unsupported type");
530         }
531       }
532       obstack_printf(obst, "\n");
533     }
534     else if (visibility != visibility_external_allocated) {
535       if (visibility == visibility_local) {
536         obstack_printf(comm_obstack, "\t.local\t%s\n", ld_name);
537       }
538
539       /* calculate the alignment */
540       align = get_type_alignment_bytes(ty);
541       h = highest_bit(align);
542
543       if ((1 << h) < align)
544         ++h;
545       align = (1 << h);
546
547       if (align < 1)
548         align = 1;
549
550       obstack_printf(comm_obstack, "\t.comm\t%s,%d,%d\n", ld_name, (get_type_size_bits(ty) + 7) >> 3, align);
551     }
552   }
553 }
554
555 /*
556  * Dumps declarations of global variables and the initialization code.
557  */
558 void TEMPLATE_dump_globals(struct obstack *rdata_obstack, struct obstack *data_obstack, struct obstack *comm_obstack)
559 {
560   ir_type *gt = get_glob_type();
561   int i, n = get_class_n_members(gt);
562
563   for (i = 0; i < n; i++)
564     dump_global(rdata_obstack, data_obstack, comm_obstack, get_class_member(gt, i));
565 }
566
567 /************************************************************************/
568
569 void TEMPLATE_gen_decls(FILE *out) {
570   struct obstack rodata, data, comm;
571   int    size;
572   char   *cp;
573
574   obstack_init(&rodata);
575   obstack_init(&data);
576   obstack_init(&comm);
577
578   TEMPLATE_dump_globals(&rodata, &data, &comm);
579
580   size = obstack_object_size(&data);
581   cp   = obstack_finish(&data);
582   if (size > 0) {
583     fprintf(out, "\t.data\n");
584     fwrite(cp, 1, size, out);
585   }
586
587   size = obstack_object_size(&rodata);
588   cp   = obstack_finish(&rodata);
589   if (size > 0) {
590     fprintf(out, "\t.section\t.rodata\n");
591     fwrite(cp, 1, size, out);
592   }
593
594   size = obstack_object_size(&comm);
595   cp   = obstack_finish(&comm);
596   if (size > 0) {
597     fprintf(out, "\t.common\n");
598     fwrite(cp, 1, size, out);
599   }
600
601   obstack_free(&rodata, NULL);
602   obstack_free(&data, NULL);
603   obstack_free(&comm, NULL);
604 }