Added name getting methods for variability and allocation
[libfirm] / ir / tr / entity.c
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 * All rights reserved.
3 *
4 * Authors: Martin Trapp, Christian Schaefer
5 *
6 */
7
8 /* $Id$ */
9
10 #ifdef HAVE_CONFIG_H
11 # include <config.h>
12 #endif
13
14 # include <stdlib.h>
15 # include <stddef.h>
16 # include <string.h>
17
18 # include "entity_t.h"
19 # include "mangle.h"
20 # include "typegmod_t.h"
21 # include "array.h"
22 /* All this is needed to build the constant node for methods: */
23 # include "irprog_t.h"
24 # include "ircons.h"
25 # include "tv_t.h"
26
27 /*******************************************************************/
28 /** general                                                       **/
29 /*******************************************************************/
30
31 void
32 init_entity (void)
33 {
34 }
35
36 /*******************************************************************/
37 /** ENTITY                                                        **/
38 /*******************************************************************/
39
40 /* redeclared to declare INLINE. */
41 INLINE entity *get_entity_overwrites   (entity *ent, int pos);
42 INLINE entity *get_entity_overwrittenby   (entity *ent, int pos);
43 INLINE type   *get_entity_owner (entity *ent);
44
45 INLINE void insert_entity_in_owner (entity *ent) {
46   type *owner = ent->owner;
47   switch (get_type_tpop_code(owner)) {
48   case tpo_class: {
49     add_class_member (owner, ent);
50   } break;
51   case tpo_struct: {
52     add_struct_member (owner, ent);
53   } break;
54   case tpo_union: {
55     add_union_member (owner, ent);
56   } break;
57   case tpo_array: {
58     set_array_element_entity(owner, ent);
59   } break;
60   default: assert(0);
61   }
62 }
63
64 entity *
65 new_entity (type *owner, ident *name, type *type)
66 {
67   entity *res;
68   ir_graph *rem;
69
70   assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
71
72   res = (entity *) xmalloc (sizeof (entity));
73   res->kind = k_entity;
74   assert_legal_owner_of_ent(owner);
75   res->owner = owner;
76   res->name = name;
77   res->type = type;
78   if (get_type_tpop(type) == type_method)
79     res->allocation = static_allocated;
80   else
81     res->allocation = automatic_allocated;
82   res->visibility = local;
83   res->offset = -1;
84   if (is_method_type(type)) {
85     res->variability = constant;
86     rem = current_ir_graph;
87     current_ir_graph = get_const_code_irg();
88     res->value = new_Const(mode_P, new_tarval_from_entity(res, mode_P));
89     current_ir_graph = rem;
90   } else {
91     res->variability = uninitialized;
92     res->value = NULL;
93     res->values = NULL;
94   }
95   res->peculiarity = existent;
96   res->volatility = non_volatile;
97   res->ld_name = NULL;
98   res->overwrites = NEW_ARR_F(entity *, 1);
99   res->overwrittenby = NEW_ARR_F(entity *, 1);
100
101   res->irg = NULL;
102
103 #ifdef DEBUG_libfirm
104   res->nr = get_irp_new_node_nr();
105 #endif
106
107   res->visit = 0;
108
109   /* Remember entity in it's owner. */
110   insert_entity_in_owner (res);
111   return res;
112 }
113 entity *
114 new_d_entity (type *owner, ident *name, type *type, dbg_info *db) {
115   entity *res = new_entity(owner, name, type);
116   set_entity_dbg_info(res, db);
117   return res;
118 }
119 INLINE void free_entity_attrs(entity *ent) {
120   assert(ent);
121   if (get_type_tpop(get_entity_owner(ent)) == type_class) {
122     DEL_ARR_F(ent->overwrites);
123     DEL_ARR_F(ent->overwrittenby);
124   }
125 }
126
127 entity *
128 copy_entity_own (entity *old, type *new_owner) {
129   entity *new;
130
131   assert_legal_owner_of_ent(new_owner);
132   if (old->owner == new_owner) return old;
133   new = (entity *) xmalloc (sizeof (entity));
134   memcpy (new, old, sizeof (entity));
135   new->owner = new_owner;
136   /*
137   if ((get_type_tpop(get_entity_owner(old)) == type_class) &&
138       (get_type_tpop(new_owner) == type_class)) {
139     new->overwrites = DUP_ARR_F(entity *, old->overwrites);
140     new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
141   } else if ((get_type_tpop(get_entity_owner(old)) != type_class) &&
142              (get_type_tpop(new_owner) == type_class)) {
143     new->overwrites = NEW_ARR_F(entity *, 1);
144     new->overwrittenby = NEW_ARR_F(entity *, 1);
145   }
146   */
147   if (is_class_type(new_owner)) {
148     new->overwrites = NEW_ARR_F(entity *, 1);
149     new->overwrittenby = NEW_ARR_F(entity *, 1);
150   }
151 #ifdef DEBUG_libfirm
152   new->nr = get_irp_new_node_nr();
153 #endif
154
155   insert_entity_in_owner (new);
156
157   return new;
158 }
159
160 entity *
161 copy_entity_name (entity *old, ident *new_name) {
162   entity *new;
163
164   if (old->name == new_name) return old;
165   new = (entity *) xmalloc (sizeof (entity));
166   memcpy (new, old, sizeof (entity));
167   new->name = new_name;
168   new->ld_name = NULL;
169   if (is_class_type(new->owner)) {
170     new->overwrites = DUP_ARR_F(entity *, old->overwrites);
171     new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
172   }
173 #ifdef DEBUG_libfirm
174   new->nr = get_irp_new_node_nr();
175 #endif
176
177   insert_entity_in_owner (new);
178
179   return new;
180 }
181
182
183 void
184 free_entity (entity *ent) {
185   free_tarval_entity(ent);
186   free_entity_attrs(ent);
187   free(ent);
188 }
189
190 /* Outputs a unique number for this node */
191 INLINE long
192 get_entity_nr(entity *ent) {
193   assert(ent);
194 #ifdef DEBUG_libfirm
195   return ent->nr;
196 #else
197   return 0;
198 #endif
199 }
200
201 INLINE const char *
202 get_entity_name (entity *ent) {
203   assert (ent);
204   return id_to_str(get_entity_ident(ent));
205 }
206
207 ident *
208 get_entity_ident    (entity *ent) {
209   assert(ent);
210   return ent->name;
211 }
212
213 /*
214 void   set_entitye_ld_name  (entity *, char *ld_name);
215 void   set_entity_ld_ident (entity *, ident *ld_ident);
216 */
217
218 INLINE type *
219 get_entity_owner (entity *ent) {
220   return ent->owner = skip_tid(ent->owner);
221 }
222
223 INLINE void
224 set_entity_owner (entity *ent, type *owner) {
225   assert_legal_owner_of_ent(owner);
226   ent->owner = owner;
227 }
228
229 INLINE void   /* should this go into type.c? */
230 assert_legal_owner_of_ent(type *owner) {
231   assert (get_type_tpop_code(owner) == tpo_class ||
232           get_type_tpop_code(owner) == tpo_union ||
233           get_type_tpop_code(owner) == tpo_struct ||
234           get_type_tpop_code(owner) == tpo_array);   /* Yes, array has an entity
235                                                         -- to select fields! */
236 }
237
238 INLINE ident *
239 get_entity_ld_ident (entity *ent)
240 {
241   if (ent->ld_name == NULL)
242     ent->ld_name = mangle_entity (ent);
243   return ent->ld_name;
244 }
245
246 INLINE void
247 set_entity_ld_ident (entity *ent, ident *ld_ident) {
248   ent->ld_name = ld_ident;
249 }
250
251 INLINE const char *
252 get_entity_ld_name (entity *ent) {
253   return id_to_str(get_entity_ld_ident(ent));
254 }
255
256 /*
257 char  *get_entity_ld_name  (entity *);
258 void   set_entity_ld_name  (entity *, char *ld_name);
259 */
260
261 INLINE type *
262 get_entity_type (entity *ent) {
263   return ent->type = skip_tid(ent->type);
264 }
265
266 INLINE void
267 set_entity_type (entity *ent, type *type) {
268   ent->type = type;
269 }
270
271
272 INLINE ent_allocation
273 get_entity_allocation (entity *ent) {
274   return ent->allocation;
275 }
276
277 INLINE void
278 set_entity_allocation (entity *ent, ent_allocation al) {
279   ent->allocation = al;
280 }
281
282 /* return the name of the visibility */
283 const char *get_allocation_name(ent_allocation all)
284 {
285 #define X(a)    case a: return #a
286   switch (all) {
287     X(automatic_allocated);
288     X(parameter_allocated);
289     X(dynamic_allocated);
290     X(static_allocated);
291     default: return "BAD VALUE";
292   }
293 #undef X
294 }
295
296
297 INLINE ent_visibility
298 get_entity_visibility (entity *ent) {
299   return ent->visibility;
300 }
301
302 INLINE void
303 set_entity_visibility (entity *ent, ent_visibility vis) {
304   if (vis != local)
305     assert((ent->allocation == static_allocated) ||
306            (ent->allocation == automatic_allocated));
307   /* @@@ Test that the owner type is not local, but how??
308          && get_class_visibility(get_entity_owner(ent)) != local));*/
309   ent->visibility = vis;
310 }
311
312 /* return the name of the visibility */
313 const char *get_visibility_name(ent_visibility vis)
314 {
315 #define X(a)    case a: return #a
316   switch (vis) {
317     X(local);
318     X(external_visible);
319     X(external_allocated);
320     default: return "BAD VALUE";
321   }
322 #undef X
323 }
324
325 INLINE ent_variability
326 get_entity_variability (entity *ent) {
327   return ent->variability;
328 }
329
330 INLINE void
331 set_entity_variability (entity *ent, ent_variability var){
332   if (var == part_constant)
333     assert(is_class_type(ent->type) || is_struct_type(ent->type));
334   if ((is_compound_type(ent->type)) &&
335       (ent->variability == uninitialized) && (var != uninitialized)) {
336     /* Allocate datastructures for constant values */
337     ent->values = NEW_ARR_F(ir_node *, 1);
338     ent->val_ents = NEW_ARR_F(entity *, 1);
339   }
340   if ((is_compound_type(ent->type)) &&
341       (var == uninitialized) && (ent->variability != uninitialized)) {
342     /* Free datastructures for constant values */
343     DEL_ARR_F(ent->values);
344     DEL_ARR_F(ent->val_ents);
345   }
346   ent->variability = var;
347 }
348
349 /* return the name of the variablity */
350 const char *get_variability_name(ent_variability var)
351 {
352 #define X(a)    case a: return #a
353   switch (var) {
354     X(uninitialized);
355     X(initialized);
356     X(part_constant);
357     X(constant);
358     default: return "BAD VALUE";
359   }
360 #undef X
361 }
362
363 INLINE ent_volatility
364 get_entity_volatility (entity *ent) {
365   assert (ent);
366   return ent->volatility;
367 }
368
369 INLINE void
370 set_entity_volatility (entity *ent, ent_volatility vol) {
371   assert (ent);
372   ent->volatility = vol;
373 }
374
375 /* return the name of the volatility */
376 const char *get_volatility_name(ent_volatility var)
377 {
378 #define X(a)    case a: return #a
379   switch (var) {
380     X(non_volatile);
381     X(is_volatile);
382     default: return "BAD VALUE";
383   }
384 #undef X
385 }
386
387 INLINE peculiarity
388 get_entity_peculiarity (entity *ent) {
389   assert (ent);
390   return ent->peculiarity;
391 }
392
393 INLINE void
394 set_entity_peculiarity (entity *ent, peculiarity pec) {
395   assert (ent);
396   /* @@@ why peculiarity only for methods? */
397   assert (is_method_type(ent->type));
398   ent->peculiarity = pec;
399 }
400
401 /* return the name of the peculiarity */
402 const char *get_peculiarity_name(peculiarity var)
403 {
404 #define X(a)    case a: return #a
405   switch (var) {
406     X(description);
407     X(inherited);
408     X(existent);
409     default: return "BAD VALUE";
410   }
411 #undef X
412 }
413
414 /* Set has no effect for entities of type method. */
415 INLINE ir_node *
416 get_atomic_ent_value(entity *ent) {
417   assert(ent); assert(is_atomic_entity(ent));
418   assert((ent->variability != uninitialized));
419   return ent->value;
420 }
421
422 INLINE void
423 set_atomic_ent_value(entity *ent, ir_node *val) {
424   assert(ent && is_atomic_entity(ent) && (ent->variability != uninitialized));
425   if (is_method_type(ent->type)) return;
426   ent->value = val;
427 }
428
429
430 ir_node *copy_const_value(ir_node *n) {
431   ir_node *nn;
432   ir_mode *m;
433
434   m = get_irn_mode(n);
435   switch(get_irn_opcode(n)) {
436   case iro_Const:
437     nn = new_Const(m, get_Const_tarval(n)); break;
438   case iro_SymConst:
439     nn = new_SymConst(get_SymConst_type_or_id(n), get_SymConst_kind(n)); break;
440   case iro_Add:
441     nn = new_Add(copy_const_value(get_Add_left(n)), copy_const_value(get_Add_right(n)), m); break;
442   default:
443     assert(0 && "opdope invalid or not implemented");
444     nn=NULL;
445     break;
446   }
447   return nn;
448 }
449
450 /* A value of a compound entity is a pair of value and the corresponding member of
451    the compound. */
452 INLINE void
453 add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
454   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
455   ARR_APP1 (ir_node *, ent->values, val);
456   ARR_APP1 (entity *, ent->val_ents, member);
457 }
458
459 /* Copies the firm subgraph referenced by val to const_code_irg and adds
460    the node as constant initialization to ent.
461    The subgraph may not contain control flow operations.
462 INLINE void
463 copy_and_add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
464   ir_graph *rem = current_ir_graph;
465
466   assert(get_entity_variability(ent) != uninitialized);
467   current_ir_graph = get_const_code_irg();
468
469   val = copy_const_value(val);
470   add_compound_ent_value(ent, val, member);
471   current_ir_graph = rem;
472   }*/
473
474 INLINE int
475 get_compound_ent_n_values(entity *ent) {
476   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
477   return (ARR_LEN (ent->values))-1;
478 }
479
480 INLINE ir_node  *
481 get_compound_ent_value(entity *ent, int pos) {
482   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
483   return ent->values[pos+1];
484 }
485
486 /* Copies the value i of the entity to current_block in current_ir_graph.
487 ir_node *
488 copy_compound_ent_value(entity *ent, int pos) {
489   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
490   return copy_const_value(ent->values[pos+1]);
491   }*/
492
493 INLINE entity   *
494 get_compound_ent_value_member(entity *ent, int pos) {
495   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
496   return ent->val_ents[pos+1];
497 }
498
499 INLINE void
500 set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos) {
501   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
502   ent->values[pos+1] = val;
503   ent->val_ents[pos+1] = member;
504 }
505
506 void
507 remove_compound_ent_value(entity *ent, entity *value_ent) {
508   int i;
509   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
510   for (i = 1; i < (ARR_LEN (ent->val_ents)); i++) {
511     if (ent->val_ents[i] == value_ent) {
512       for(; i < (ARR_LEN (ent->val_ents))-1; i++) {
513         ent->val_ents[i] = ent->val_ents[i+1];
514         ent->values[i]   = ent->values[i+1];
515       }
516       ARR_SETLEN(entity*,  ent->val_ents, ARR_LEN(ent->val_ents) - 1);
517       ARR_SETLEN(ir_node*, ent->values,   ARR_LEN(ent->values) - 1);
518       break;
519     }
520   }
521 }
522
523 void
524 set_array_entity_values(entity *ent, tarval **values, int num_vals) {
525   int i;
526   ir_graph *rem = current_ir_graph;
527   type *arrtp = get_entity_type(ent);
528   ir_node *val;
529
530   assert(is_array_type(arrtp));
531   assert(get_array_n_dimensions(arrtp) == 1);
532   /* One bound is sufficient, the nunmber of constant fields makes the
533      size. */
534   assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
535   assert(get_entity_variability(ent) != uninitialized);
536   current_ir_graph = get_const_code_irg();
537
538   for (i = 0; i < num_vals; i++) {
539     val = new_Const(get_tarval_mode (values[i]), values[i]);
540     add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
541   }
542   current_ir_graph = rem;
543 }
544
545 INLINE int
546 get_entity_offset (entity *ent) {
547   return ent->offset;
548 }
549
550 INLINE void
551 set_entity_offset (entity *ent, int offset) {
552   ent->offset = offset;
553 }
554
555 INLINE void
556 add_entity_overwrites   (entity *ent, entity *overwritten) {
557   assert(ent);
558   assert(is_class_type(get_entity_owner(ent)));
559   ARR_APP1 (entity *, ent->overwrites, overwritten);
560   ARR_APP1 (entity *, overwritten->overwrittenby, ent);
561 }
562
563 INLINE int
564 get_entity_n_overwrites (entity *ent) {
565   assert(ent);
566   assert(is_class_type(get_entity_owner(ent)));
567   return (ARR_LEN (ent->overwrites))-1;
568 }
569
570 int
571 get_entity_overwrites_index(entity *ent, entity *overwritten) {
572   int i;
573   assert(ent && is_class_type(get_entity_owner(ent)));
574   for (i = 0; i < get_entity_n_overwrites(ent); i++)
575     if (get_entity_overwrites(ent, i) == overwritten)
576       return i;
577   return -1;
578 }
579
580 INLINE entity *
581 get_entity_overwrites   (entity *ent, int pos) {
582   assert(ent);
583   assert(is_class_type(get_entity_owner(ent)));
584   assert(pos < get_entity_n_overwrites(ent));
585   return ent->overwrites[pos+1];
586 }
587
588 INLINE void
589 set_entity_overwrites   (entity *ent, int pos, entity *overwritten) {
590   assert(ent);
591   assert(is_class_type(get_entity_owner(ent)));
592   assert(pos < get_entity_n_overwrites(ent));
593   ent->overwrites[pos+1] = overwritten;
594 }
595
596 void
597 remove_entity_overwrites(entity *ent, entity *overwritten) {
598   int i;
599   assert(ent && is_class_type(get_entity_owner(ent)));
600   for (i = 1; i < (ARR_LEN (ent->overwrites)); i++)
601     if (ent->overwrites[i] == overwritten) {
602       for(; i < (ARR_LEN (ent->overwrites))-1; i++)
603         ent->overwrites[i] = ent->overwrites[i+1];
604       ARR_SETLEN(entity*, ent->overwrites, ARR_LEN(ent->overwrites) - 1);
605       break;
606     }
607 }
608
609 INLINE void
610 add_entity_overwrittenby   (entity *ent, entity *overwrites) {
611   assert(ent);
612   assert(is_class_type(get_entity_owner(ent)));
613   add_entity_overwrites(overwrites, ent);
614 }
615
616 INLINE int
617 get_entity_n_overwrittenby (entity *ent) {
618   assert(ent);
619   assert(is_class_type(get_entity_owner(ent)));
620   return (ARR_LEN (ent->overwrittenby))-1;
621 }
622
623 int
624 get_entity_overwrittenby_index(entity *ent, entity *overwrites) {
625   int i;
626   assert(ent && is_class_type(get_entity_owner(ent)));
627   for (i = 0; i < get_entity_n_overwrittenby(ent); i++)
628     if (get_entity_overwrittenby(ent, i) == overwrites)
629       return i;
630   return -1;
631 }
632
633 INLINE entity *
634 get_entity_overwrittenby   (entity *ent, int pos) {
635   assert(ent);
636   assert(is_class_type(get_entity_owner(ent)));
637   assert(pos < get_entity_n_overwrittenby(ent));
638   return ent->overwrittenby[pos+1];
639 }
640
641 INLINE void
642 set_entity_overwrittenby   (entity *ent, int pos, entity *overwrites) {
643   assert(ent);
644   assert(is_class_type(get_entity_owner(ent)));
645   assert(pos < get_entity_n_overwrittenby(ent));
646   ent->overwrittenby[pos+1] = overwrites;
647 }
648
649 void    remove_entity_overwrittenby(entity *ent, entity *overwrites) {
650   int i;
651   assert(ent && is_class_type(get_entity_owner(ent)));
652   for (i = 1; i < (ARR_LEN (ent->overwrittenby)); i++)
653     if (ent->overwrittenby[i] == overwrites) {
654       for(; i < (ARR_LEN (ent->overwrittenby))-1; i++)
655         ent->overwrittenby[i] = ent->overwrittenby[i+1];
656       ARR_SETLEN(entity*, ent->overwrittenby, ARR_LEN(ent->overwrittenby) - 1);
657       break;
658     }
659 }
660
661 /* A link to store intermediate information */
662 void *
663 get_entity_link(entity *ent) {
664   assert(ent);
665   return ent->link;
666 }
667
668 void
669 set_entity_link(entity *ent, void *l) {
670   assert(ent);
671   ent->link = l;
672 }
673
674 INLINE ir_graph *
675 get_entity_irg(entity *ent) {
676   assert (ent);
677   assert (is_method_type(ent->type));
678   return ent->irg;
679 }
680
681 INLINE void
682 set_entity_irg(entity *ent, ir_graph *irg) {
683   assert (ent && ent->type);
684   /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
685    * Methode selbst nicht mehr aufgerufen werden kann, die Entität
686    * aber erhalten bleiben soll. */
687   /* assert (irg); */
688   assert (is_method_type(ent->type));
689   assert (ent->peculiarity == existent);
690   ent->irg = irg;
691 }
692
693 int is_entity (void *thing) {
694   assert(thing);
695   if (get_kind(thing) == k_entity)
696     return 1;
697   else
698     return 0;
699 }
700
701 int is_atomic_entity(entity *ent) {
702   type* t = get_entity_type(ent);
703   return (is_primitive_type(t) || is_pointer_type(t) ||
704           is_enumeration_type(t) || is_method_type(t));
705 }
706
707 int is_compound_entity(entity *ent) {
708   type* t = get_entity_type(ent);
709   return (is_class_type(t) || is_struct_type(t) ||
710           is_array_type(t) || is_union_type(t));
711 }
712
713 /* @@@ not implemnted!!! */
714 bool equal_entity(entity *ent1, entity *ent2) {
715   printf(" calling unimplemented equal entity!!! \n");
716   return true;
717 }
718
719
720 unsigned long get_entity_visited(entity *ent) {
721   assert (ent);
722   return ent->visit;
723 }
724 void        set_entity_visited(entity *ent, unsigned long num) {
725   assert (ent);
726   ent->visit = num;
727 }
728 /* Sets visited field in entity to entity_visited. */
729 void        mark_entity_visited(entity *ent) {
730   assert (ent);
731   ent->visit = type_visited;
732 }
733
734
735 INLINE bool entity_visited(entity *ent) {
736   return get_entity_visited(ent) >= type_visited;
737 }
738 INLINE bool entity_not_visited(entity *ent) {
739   return get_entity_visited(ent) < type_visited;
740 }