08b53f275e6bc851fe30d8cfd44e7fd88728737d
[libfirm] / ir / tr / type.c
1 /****h* libfirm/type.c
2  *
3  * NAME
4  *   file type.c - implementation of the datastructure to hold
5  *   type information.
6  * COPYRIGHT
7  *  (C) 2001 by Universitaet Karlsruhe
8  * AUTHORS
9  *  Martin Trapp, Christian Schaefer, Goetz Lindenmaier
10  *
11  * NOTES
12  *  This module supplies a datastructure to represent all types
13  *  known in the compiled program.  This includes types specified
14  *  in the program as well as types defined by the language.  In the
15  *  view of the intermediate representation there is no difference
16  *  between these types.
17  *
18  *  There exist several kinds of types, arranged by the structure of
19  *  the type.  A type is described by a set of attributes.  Some of
20  *  these attributes are common to all types, others depend on the
21  *  kind of the type.
22  *
23  *  Types are different from the modes defined in irmode:  Types are
24  *  on the level of the programming language, modes at the level of
25  *  the target processor.
26  *
27  * SEE ALSO
28  *   type_t.h type tpop
29  *****
30  */
31 # include <stdlib.h>
32 # include <stddef.h>
33 # include "type_t.h"
34 # include "tpop_t.h"
35 # include "array.h"
36
37 /*******************************************************************/
38 /** TYPE                                                          **/
39 /*******************************************************************/
40
41 unsigned long type_visited;
42
43 inline type *
44 new_type(tp_op *type_op, ir_mode *mode, ident* name) {
45   type *res;
46
47   int node_size = offsetof (type, attr) +  type_op->attr_size;
48   res = (type *) xmalloc (node_size);
49   add_irp_type(res);   /* Remember the new type global. */
50
51   res->kind = k_type;
52   res->type_op = type_op;
53   res->mode = mode;
54   res->name = name;
55   res->state = layout_undefined;
56   res->size = -1;
57   res->visit = 0;
58
59   return res;
60 }
61
62 tp_op*      get_type_tpop(type *tp) {
63   assert(tp);
64   return tp->type_op;
65 }
66
67 ident*      get_type_tpop_nameid(type *tp) {
68   assert(tp);
69   return tp->type_op->name;
70 }
71 const char* get_type_tpop_name(type *tp) {
72   assert(tp);
73   return id_to_str(tp->type_op->name);
74 }
75 tp_opcode    get_type_tpop_code(type *tp) {
76   assert(tp);
77   return tp->type_op->code;
78 }
79 ir_mode*    get_type_mode(type *tp) {
80   assert(tp);
81   return tp->mode;
82 }
83 void        set_type_mode(type *tp, ir_mode* m) {
84   assert(tp);
85   tp->mode = m;
86   /* For pointer and primitive size depends on the mode. */
87   if ((tp->type_op == type_pointer) || (tp->type_op == type_primitive))
88     tp->size == get_mode_size(m);
89 }
90 ident*      get_type_nameid(type *tp) {
91   assert(tp);
92   return tp->name;
93 }
94 void        set_type_nameid(type *tp, ident* id) {
95   assert(tp);
96   tp->name = id;
97 }
98 const char* get_type_name(type *tp) {
99   assert(tp);
100   return id_to_str(tp->name);
101 }
102 int         get_type_size(type *tp) {
103   assert(tp);
104   return tp->size;
105 }
106
107 void
108 set_type_size(type *tp, int size) {
109   assert(tp);
110   /* For pointer and primitive size depends on the mode. */
111   if ((tp->type_op != type_pointer) && (tp->type_op != type_primitive))
112     tp->size = size;
113 }
114
115 type_state
116 get_type_state(type *tp) {
117   assert(tp);
118   return tp->state;
119 }
120
121 void
122 set_type_state(type *tp, type_state state) {
123   assert(tp);
124   /* For pointer and primitive always fixed. */
125   if ((tp->type_op != type_pointer) && (tp->type_op != type_primitive))
126     tp->state = state;
127 }
128
129 unsigned long get_type_visited(type *tp) {
130   assert(tp);
131   return tp->visit;
132 }
133
134 void        set_type_visited(type *tp, unsigned long num) {
135   assert(tp);
136   tp->visit = num;
137 }
138 /* Sets visited field in type to type_visited. */
139 void        mark_type_visited(type *tp) {
140   assert(tp);
141   assert(tp->visit < type_visited);
142   tp->visit = type_visited;
143 }
144
145 int is_type            (void *thing) {
146   assert(thing);
147   if (get_kind(thing) == k_type)
148     return 1;
149   else
150     return 0;
151 }
152
153 /*******************************************************************/
154 /** TYPE_CLASS                                                    **/
155 /*******************************************************************/
156
157 /* create a new class type */
158 type   *new_type_class (ident *name) {
159   type *res;
160
161   res = new_type(type_class, NULL, name);
162
163   res->attr.ca.members    = NEW_ARR_F (entity *, 1);
164   res->attr.ca.subtypes   = NEW_ARR_F (type *, 1);
165   res->attr.ca.supertypes = NEW_ARR_F (type *, 1);
166
167   return res;
168 }
169 /* manipulate private fields of class type  */
170 void    add_class_member   (type *clss, entity *member) {
171   assert(clss && (clss->type_op == type_class));
172   ARR_APP1 (entity *, clss->attr.ca.members, member);
173 }
174 int     get_class_n_member (type *clss) {
175   assert(clss && (clss->type_op == type_class));
176   return (ARR_LEN (clss->attr.ca.members))-1;
177 }
178 entity *get_class_member   (type *clss, int pos) {
179   assert(clss && (clss->type_op == type_class));
180   return clss->attr.ca.members[pos+1];
181 }
182 void    set_class_member   (type *clss, entity *member, int pos) {
183   assert(clss && (clss->type_op == type_class));
184   clss->attr.ca.members[pos+1] = member;
185 }
186
187 void    add_class_subtype   (type *clss, type *subtype) {
188   assert(clss && (clss->type_op == type_class));
189   ARR_APP1 (type *, clss->attr.ca.subtypes, subtype);
190 }
191 int     get_class_n_subtype (type *clss) {
192   assert(clss && (clss->type_op == type_class));
193   return (ARR_LEN (clss->attr.ca.subtypes))-1;
194 }
195 type   *get_class_subtype   (type *clss, int pos) {
196   assert(clss && (clss->type_op == type_class));
197   return clss->attr.ca.subtypes[pos+1];
198 }
199 void    set_class_subtype   (type *clss, type *subtype, int pos) {
200   assert(clss && (clss->type_op == type_class));
201   clss->attr.ca.subtypes[pos+1] = subtype;
202 }
203
204 void    add_class_supertype   (type *clss, type *supertype) {
205   assert(clss && (clss->type_op == type_class));
206   ARR_APP1 (type *, clss->attr.ca.supertypes, supertype);
207 }
208 int     get_class_n_supertype (type *clss) {
209   assert(clss && (clss->type_op == type_class));
210   return (ARR_LEN (clss->attr.ca.supertypes))-1;
211 }
212 type   *get_class_supertype   (type *clss, int pos) {
213   assert(clss && (clss->type_op == type_class));
214   return clss->attr.ca.supertypes[pos+1];
215 }
216 void    set_class_supertype   (type *clss, type *supertype, int pos) {
217   assert(clss && (clss->type_op == type_class));
218   clss->attr.ca.supertypes[pos+1] = supertype;
219 }
220 /* typecheck */
221 bool    is_class_type(type *clss) {
222   assert(clss);
223   if (clss->type_op == type_class) return 1; else return 0;
224 }
225
226 /*******************************************************************/
227 /** TYPE_STRUCT                                                   **/
228 /*******************************************************************/
229
230 /* create a new type struct */
231 type   *new_type_struct (ident *name) {
232   type *res;
233   res = new_type(type_struct, NULL, name);
234   res->attr.sa.members = NEW_ARR_F (entity *, 1);
235   return res;
236 }
237 /* manipulate private fields of struct */
238 void    add_struct_member   (type *strct, entity *member) {
239   assert(strct && (strct->type_op == type_struct));
240   ARR_APP1 (entity *, strct->attr.sa.members, member);
241 }
242 int     get_struct_n_member (type *strct) {
243   assert(strct && (strct->type_op == type_struct));
244   return (ARR_LEN (strct->attr.sa.members))-1;
245 }
246 entity *get_struct_member   (type *strct, int pos) {
247   assert(strct && (strct->type_op == type_struct));
248   return strct->attr.sa.members[pos+1];
249 }
250 void    set_struct_member   (type *strct, int pos, entity *member) {
251   assert(strct && (strct->type_op == type_struct));
252   strct->attr.sa.members[pos+1] = member;
253 }
254 /* typecheck */
255 bool    is_struct_type(type *strct) {
256   assert(strct);
257   if (strct->type_op == type_struct) return 1; else return 0;
258 }
259
260 /*******************************************************************/
261 /** TYPE_METHOD                                                   **/
262 /*******************************************************************/
263
264 /* Create a new method type.
265    N_param is the number of parameters, n_res the number of results.  */
266 type *new_type_method (ident *name, int n_param, int n_res) {
267   type *res;
268   res = new_type(type_method, NULL, name);
269   res->attr.ma.n_params   = n_param;
270   res->attr.ma.param_type = (type **) xmalloc (sizeof (type *) * n_param);
271   res->attr.ma.n_res      = n_res;
272   res->attr.ma.res_type   = (type **) xmalloc (sizeof (type *) * n_res);
273   return res;
274 }
275
276 /* manipulate private fields of method. */
277 int   get_method_n_params  (type *method) {
278   assert(method && (method->type_op == type_method));
279   return method->attr.ma.n_params;
280 }
281 type *get_method_param_type(type *method, int pos) {
282   assert(method && (method->type_op == type_method));
283   return method->attr.ma.param_type[pos];
284 }
285 void  set_method_param_type(type *method, int pos, type* type) {
286   assert(method && (method->type_op == type_method));
287   method->attr.ma.param_type[pos] = type;
288 }
289
290 int   get_method_n_res   (type *method) {
291   assert(method && (method->type_op == type_method));
292   return method->attr.ma.n_res;
293 }
294 type *get_method_res_type(type *method, int pos) {
295   assert(method && (method->type_op == type_method));
296   return method->attr.ma.res_type[pos];
297 }
298 void  set_method_res_type(type *method, int pos, type* type) {
299   assert(method && (method->type_op == type_method));
300   method->attr.ma.res_type[pos] = type;
301 }
302
303 /* typecheck */
304 bool  is_method_type     (type *method) {
305   assert(method);
306   if (method->type_op == type_method) return 1; else return 0;
307 }
308 /*****/
309
310 /*******************************************************************/
311 /** TYPE_UNION                                                    **/
312 /*******************************************************************/
313
314 /* create a new type uni */
315 type  *new_type_uni (ident *name) {
316   type *res;
317   res = new_type(type_union, NULL, name);
318   /*res->attr.ua.unioned_type = (type **)  xmalloc (sizeof (type *)  * n_types);
319     res->attr.ua.delim_names  = (ident **) xmalloc (sizeof (ident *) * n_types); */
320   res->attr.ua.members = NEW_ARR_F (entity *, 1);
321   return res;
322 }
323 /* manipulate private fields of struct */
324 #if 0
325 int    get_union_n_types      (type *uni) {
326   assert(uni && (uni->type_op == type_union));
327   return uni->attr.ua.n_types;
328 }
329 type  *get_union_unioned_type (type *uni, int pos) {
330   assert(uni && (uni->type_op == type_union));
331   return uni->attr.ua.unioned_type[pos];
332 }
333 void   set_union_unioned_type (type *uni, int pos, type *type) {
334   assert(uni && (uni->type_op == type_union));
335   uni->attr.ua.unioned_type[pos] = type;
336 }
337 ident *get_union_delim_nameid (type *uni, int pos) {
338   assert(uni && (uni->type_op == type_union));
339   return uni->attr.ua.delim_names[pos];
340 }
341 const char *get_union_delim_name (type *uni, int pos) {
342   assert(uni && (uni->type_op == type_union));
343   return id_to_str(uni->attr.ua.delim_names[pos]);
344 }
345 void   set_union_delim_nameid (type *uni, int pos, ident *id) {
346   assert(uni && (uni->type_op == type_union));
347   uni->attr.ua.delim_names[pos] = id;
348 }
349 #endif
350 int    get_union_n_members      (type *uni) {
351   assert(uni && (uni->type_op == type_union));
352   return (ARR_LEN (uni->attr.ua.members))-1;
353 }
354 void    add_union_member   (type *uni, entity *member) {
355   assert(uni && (uni->type_op == type_union));
356   ARR_APP1 (entity *, uni->attr.ua.members, member);
357 }
358 entity  *get_union_member (type *uni, int pos) {
359   assert(uni && (uni->type_op == type_union));
360   return uni->attr.ua.members[pos+1];
361 }
362 void   set_union_member (type *uni, int pos, entity *member) {
363   assert(uni && (uni->type_op == type_union));
364   uni->attr.ua.members[pos+1] = member;
365 }
366
367 /* typecheck */
368 bool   is_union_type         (type *uni) {
369   assert(uni);
370   if (uni->type_op == type_union) return 1; else return 0;
371 }
372
373 /*******************************************************************/
374 /** TYPE_ARRAY                                                    **/
375 /*******************************************************************/
376
377
378 /* create a new type array -- set dimension sizes independently */
379 type *new_type_array         (ident *name, int n_dimensions,
380                               type *element_type) {
381   type *res;
382   res = new_type(type_array, NULL, name);
383   res->attr.aa.n_dimensions = n_dimensions;
384   res->attr.aa.lower_bound  = (ir_node **) xmalloc (sizeof (ir_node *) * n_dimensions);
385   res->attr.aa.upper_bound  = (ir_node **) xmalloc (sizeof (ir_node *) * n_dimensions);
386   res->attr.aa.element_type = element_type;
387   new_entity(res, name, element_type);
388   return res;
389 }
390
391 /* manipulate private fields of array type */
392 int   get_array_n_dimensions (type *array) {
393   assert(array && (array->type_op == type_array));
394   return array->attr.aa.n_dimensions;
395 }
396 void  set_array_bounds       (type *array, int dimension, ir_node * lower_bound,
397                                                           ir_node * upper_bound) {
398   assert(array && (array->type_op == type_array));
399   array->attr.aa.lower_bound[dimension] = lower_bound;
400   array->attr.aa.upper_bound[dimension] = upper_bound;
401 }
402 void  set_array_lower_bound  (type *array, int dimension, ir_node * lower_bound) {
403   assert(array && (array->type_op == type_array));
404   array->attr.aa.lower_bound[dimension] = lower_bound;
405 }
406 void  set_array_upper_bound  (type *array, int dimension, ir_node * upper_bound) {
407   assert(array && (array->type_op == type_array));
408   array->attr.aa.upper_bound[dimension] = upper_bound;
409 }
410 ir_node * get_array_lower_bound  (type *array, int dimension) {
411   assert(array && (array->type_op == type_array));
412   return array->attr.aa.lower_bound[dimension];
413 }
414 ir_node * get_array_upper_bound  (type *array, int dimension) {
415   assert(array && (array->type_op == type_array));
416   return array->attr.aa.upper_bound[dimension];
417 }
418 void  set_array_element_type (type *array, type *type) {
419   assert(array && (array->type_op == type_array));
420   array->attr.aa.element_type = type;
421 }
422 type *get_array_element_type (type *array) {
423   assert(array && (array->type_op == type_array));
424   return array->attr.aa.element_type;
425 }
426 void  set_array_element_entity (type *array, entity *ent) {
427   assert(array && (array->type_op == type_array));
428   array->attr.aa.element_ent = ent;
429 }
430 entity *get_array_element_entity (type *array) {
431   assert(array && (array->type_op == type_array));
432   return array->attr.aa.element_ent;
433 }
434
435 /* typecheck */
436 bool   is_array_type         (type *array) {
437   assert(array);
438   if (array->type_op == type_array) return 1; else return 0;
439 }
440
441 /*******************************************************************/
442 /** TYPE_ENUMERATION                                              **/
443 /*******************************************************************/
444
445 /* create a new type enumeration -- set the enumerators independently */
446 type   *new_type_enumeration    (ident *name, int n_enums) {
447   type *res;
448   res = new_type(type_enumeration, NULL, name);
449   res->attr.ea.n_enums     = n_enums;
450   res->attr.ea.enumer      = (tarval **) xmalloc (sizeof (tarval *) * n_enums);
451   res->attr.ea.enum_nameid = (ident  **) xmalloc (sizeof (ident  *) * n_enums);
452   return res;
453 }
454
455 /* manipulate fields of enumeration type. */
456 int     get_enumeration_n_enums (type *enumeration) {
457   assert(enumeration && (enumeration->type_op == type_enumeration));
458   return enumeration->attr.ea.n_enums;
459 }
460 void    set_enumeration_enum    (type *enumeration, int pos, tarval *con) {
461   assert(enumeration && (enumeration->type_op == type_enumeration));
462   enumeration->attr.ea.enumer[pos] = con;
463 }
464 tarval *get_enumeration_enum    (type *enumeration, int pos) {
465   assert(enumeration && (enumeration->type_op == type_enumeration));
466   return enumeration->attr.ea.enumer[pos];
467 }
468 void    set_enumeration_nameid  (type *enumeration, int pos, ident *id) {
469   assert(enumeration && (enumeration->type_op == type_enumeration));
470   enumeration->attr.ea.enum_nameid[pos] = id;
471 }
472 ident  *get_enumeration_nameid  (type *enumeration, int pos) {
473   assert(enumeration && (enumeration->type_op == type_enumeration));
474   return enumeration->attr.ea.enum_nameid[pos];
475 }
476 const char *get_enumeration_name(type *enumeration, int pos) {
477   assert(enumeration && (enumeration->type_op == type_enumeration));
478   return id_to_str(enumeration->attr.ea.enum_nameid[pos]);
479 }
480
481 /* typecheck */
482 bool    is_enumeration_type     (type *enumeration) {
483   assert(enumeration);
484   if (enumeration->type_op == type_enumeration) return 1; else return 0;
485 }
486
487 /*******************************************************************/
488 /** TYPE_POINTER                                                  **/
489 /*******************************************************************/
490
491 /* Create a new type pointer */
492 type *new_type_pointer           (ident *name, type *points_to) {
493   type *res;
494   res = new_type(type_pointer, mode_p, name);
495   res->attr.pa.points_to = points_to;
496   res->size = get_mode_size(res->mode);
497   res->state = layout_fixed;
498   return res;
499 }
500 /* manipulate fields of type_pointer */
501 void  set_pointer_points_to_type (type *pointer, type *type) {
502   assert(pointer && (pointer->type_op == type_pointer));
503   pointer->attr.pa.points_to = type;
504 }
505 type *get_pointer_points_to_type (type *pointer) {
506   assert(pointer && (pointer->type_op == type_pointer));
507   return pointer->attr.pa.points_to;
508 }
509
510 /* typecheck */
511 bool  is_pointer_type            (type *pointer) {
512   assert(pointer);
513   if (pointer->type_op == type_pointer) return 1; else return 0;
514 }
515
516
517 /*******************************************************************/
518 /** TYPE_PRIMITIVE                                                **/
519 /*******************************************************************/
520
521 /* create a new type primitive */
522 type *new_type_primitive (ident *name, ir_mode *mode) {
523   type *res;
524   res = new_type(type_primitive, mode, name);
525   res->size = get_mode_size(mode);
526   res->state = layout_fixed;
527   return res;
528 }
529
530 /* typecheck */
531 bool  is_primitive_type  (type *primitive) {
532   assert(primitive);
533   if (primitive->type_op == type_primitive) return 1; else return 0;
534 }