add missing DBG_OPT calls
[libfirm] / ir / tr / entity.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Representation of all program known entities.
23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
24  * @version $Id$
25  */
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <string.h>
31 #include <stdlib.h>
32 #include <stddef.h>
33
34 #include "firm_common_t.h"
35
36 #include "xmalloc.h"
37 #include "entity_t.h"
38 #include "array.h"
39 #include "irtools.h"
40 #include "irhooks.h"
41 #include "irprintf.h"
42
43 #include "irprog_t.h"
44 #include "ircons.h"
45 #include "tv_t.h"
46 #include "irdump.h"
47 #include "irgraph_t.h"
48
49 #include "callgraph.h"
50
51 /**
52  * An interval initializer.
53  */
54 typedef struct interval_initializer interval_initializer;
55
56 /**
57  * A value initializer.
58  */
59 typedef struct value_initializer value_initializer;
60
61 struct interval_initializer {
62         int                  first_index; /**< The first index of the initialized interval. */
63         int                  last_index;  /**< The last index of the initialized interval. */
64         interval_initializer *next;       /**< Points to the next interval initializer. */
65 };
66
67 struct value_initializer {
68         ir_entity *ent;           /**< The initialized entity. */
69         value_initializer *next;  /**< Points to the next value initializer. */
70 };
71
72 typedef union initializer {
73         ir_node              *value;     /**< The value of the initializer. */
74         ir_node              **values;   /**< The values of an interval. */
75         value_initializer    *val_init;  /**< Points the the head of the next value initializers. */
76         interval_initializer *int_init;  /**< Points to the head of the next value initializers. */
77 } initializer;
78
79 /*-----------------------------------------------------------------*/
80 /** general                                                       **/
81 /*-----------------------------------------------------------------*/
82
83 ir_entity *unknown_entity = NULL;
84
85 ir_entity *get_unknown_entity(void) { return unknown_entity; }
86
87 /** The name of the unknown entity. */
88 #define UNKNOWN_ENTITY_NAME "unknown_entity"
89
90 /*-----------------------------------------------------------------*/
91 /* ENTITY                                                          */
92 /*-----------------------------------------------------------------*/
93
94 /**
95  * Add an entity to it's already set owner type.
96  */
97 static INLINE void insert_entity_in_owner(ir_entity *ent) {
98         ir_type *owner = ent->owner;
99         switch (get_type_tpop_code(owner)) {
100         case tpo_class:
101                 add_class_member(owner, ent);
102                 break;
103         case tpo_struct:
104                 add_struct_member(owner, ent);
105                 break;
106         case tpo_union:
107                 add_union_member(owner, ent);
108                 break;
109         case tpo_array:
110                 set_array_element_entity(owner, ent);
111                 break;
112         default: assert(0);
113         }
114 }  /* insert_entity_in_owner */
115
116 /**
117  * Creates a new entity. This entity is NOT inserted in the owner type.
118  *
119  * @param db     debug info for this entity
120  * @param owner  the owner type of the new entity
121  * @param name   the name of the new entity
122  * @param type   the type of the new entity
123  *
124  * @return the new created entity
125  */
126 static INLINE ir_entity *
127 new_rd_entity(dbg_info *db, ir_type *owner, ident *name, ir_type *type)
128 {
129         ir_entity *res;
130         ir_graph *rem;
131
132         assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
133
134         res = xmalloc(sizeof(*res));
135         memset(res, 0, sizeof(*res));
136
137         res->kind    = k_entity;
138         res->name    = name;
139         res->ld_name = NULL;
140         res->type    = type;
141         res->owner   = owner;
142
143         res->allocation           = allocation_automatic;
144         res->visibility           = visibility_local;
145         res->volatility           = volatility_non_volatile;
146         res->align                = align_is_aligned;
147         res->stickyness           = stickyness_unsticky;
148         res->peculiarity          = peculiarity_existent;
149         res->address_taken        = ir_address_taken_unknown;
150         res->final                = 0;
151         res->compiler_gen         = 0;
152         res->backend_marked       = 0;
153         res->offset               = -1;
154         res->offset_bit_remainder = 0;
155         res->link                 = NULL;
156         res->repr_class           = NULL;
157
158         if (is_Method_type(type)) {
159                 symconst_symbol sym;
160                 ir_mode *mode = is_Method_type(type) ? mode_P_code : mode_P_data;
161                 sym.entity_p            = res;
162                 rem                     = current_ir_graph;
163                 current_ir_graph        = get_const_code_irg();
164                 res->value              = new_SymConst(mode, sym, symconst_addr_ent);
165                 current_ir_graph        = rem;
166                 res->allocation         = allocation_static;
167                 res->variability        = variability_constant;
168                 res->attr.mtd_attr.irg_add_properties = mtp_property_inherited;
169                 res->attr.mtd_attr.vtable_number      = VTABLE_NUM_NOT_SET;
170                 res->attr.mtd_attr.param_access       = NULL;
171                 res->attr.mtd_attr.param_weight       = NULL;
172                 res->attr.mtd_attr.irg                = NULL;
173         } else if (is_compound_type(type)) {
174                 res->variability = variability_uninitialized;
175                 res->value       = NULL;
176                 res->attr.cmpd_attr.values    = NULL;
177                 res->attr.cmpd_attr.val_paths = NULL;
178         } else {
179                 res->variability = variability_uninitialized;
180                 res->value       = NULL;
181         }
182
183         if (is_Class_type(owner)) {
184                 res->overwrites    = NEW_ARR_F(ir_entity *, 0);
185                 res->overwrittenby = NEW_ARR_F(ir_entity *, 0);
186         } else {
187                 res->overwrites    = NULL;
188                 res->overwrittenby = NULL;
189         }
190
191 #ifdef DEBUG_libfirm
192         res->nr = get_irp_new_node_nr();
193 #endif /* DEBUG_libfirm */
194
195         res->visit = 0;
196         set_entity_dbg_info(res, db);
197
198         return res;
199 }  /* new_rd_entity */
200
201 ir_entity *
202 new_d_entity(ir_type *owner, ident *name, ir_type *type, dbg_info *db) {
203         ir_entity *res;
204
205         assert(is_compound_type(owner));
206         res = new_rd_entity(db, owner, name, type);
207         /* Remember entity in it's owner. */
208         insert_entity_in_owner(res);
209
210         hook_new_entity(res);
211         return res;
212 }  /* new_d_entity */
213
214 ir_entity *
215 new_entity(ir_type *owner, ident *name, ir_type *type) {
216         return new_d_entity(owner, name, type, NULL);
217 }  /* new_entity */
218
219 /**
220  * Free entity attributes.
221  *
222  * @param ent  the entity
223  */
224 static void free_entity_attrs(ir_entity *ent) {
225         int i;
226         if (get_type_tpop(get_entity_owner(ent)) == type_class) {
227                 DEL_ARR_F(ent->overwrites);    ent->overwrites = NULL;
228                 DEL_ARR_F(ent->overwrittenby); ent->overwrittenby = NULL;
229         } else {
230                 assert(ent->overwrites == NULL);
231                 assert(ent->overwrittenby == NULL);
232         }
233         if (is_compound_entity(ent)) {
234                 if (ent->attr.cmpd_attr.val_paths) {
235                         for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i)
236                                 if (ent->attr.cmpd_attr.val_paths[i]) {
237                                         /* free_compound_graph_path(ent->attr.cmpd_attr.val_paths[i]) ;  * @@@ warum nich? */
238                                         /* Geht nich: wird mehrfach verwendet!!! ==> mehrfach frei gegeben. */
239                                         /* DEL_ARR_F(ent->attr.cmpd_attr.val_paths); */
240                                 }
241                                 ent->attr.cmpd_attr.val_paths = NULL;
242                 }
243                 /* if (ent->attr.cmpd_attr.values) DEL_ARR_F(ent->attr.cmpd_attr.values); *//* @@@ warum nich? */
244                 ent->attr.cmpd_attr.values = NULL;
245         } else if (is_method_entity(ent)) {
246                 if (ent->attr.mtd_attr.param_access) {
247                         DEL_ARR_F(ent->attr.mtd_attr.param_access);
248                         ent->attr.mtd_attr.param_access = NULL;
249                 }
250                 if (ent->attr.mtd_attr.param_weight) {
251                         DEL_ARR_F(ent->attr.mtd_attr.param_weight);
252                         ent->attr.mtd_attr.param_weight = NULL;
253                 }
254         }
255 }  /* free_entity_attrs */
256
257 /*
258  * Copies the entity if the new_owner is different from the
259  * owner of the old entity,  else returns the old entity.
260  */
261 ir_entity *
262 copy_entity_own(ir_entity *old, ir_type *new_owner) {
263         ir_entity *newe;
264         assert(is_entity(old));
265         assert(is_compound_type(new_owner));
266         assert(get_type_state(new_owner) != layout_fixed);
267
268         if (old->owner == new_owner) return old;
269         newe = xmalloc(sizeof(*newe));
270         memcpy(newe, old, sizeof(*newe));
271         newe->owner = new_owner;
272         if (is_Class_type(new_owner)) {
273                 newe->overwrites    = NEW_ARR_F(ir_entity *, 0);
274                 newe->overwrittenby = NEW_ARR_F(ir_entity *, 0);
275         }
276 #ifdef DEBUG_libfirm
277         newe->nr = get_irp_new_node_nr();
278 #endif
279
280         insert_entity_in_owner(newe);
281
282         return newe;
283 }  /* copy_entity_own */
284
285 ir_entity *
286 copy_entity_name(ir_entity *old, ident *new_name) {
287         ir_entity *newe;
288         assert(old && old->kind == k_entity);
289
290         if (old->name == new_name) return old;
291         newe = xmalloc(sizeof(*newe));
292         memcpy(newe, old, sizeof(*newe));
293         newe->name = new_name;
294         newe->ld_name = NULL;
295         if (is_Class_type(newe->owner)) {
296                 newe->overwrites    = DUP_ARR_F(ir_entity *, old->overwrites);
297                 newe->overwrittenby = DUP_ARR_F(ir_entity *, old->overwrittenby);
298         }
299 #ifdef DEBUG_libfirm
300         newe->nr = get_irp_new_node_nr();
301 #endif
302
303         insert_entity_in_owner(newe);
304
305         return newe;
306 }  /* copy_entity_name */
307
308
309 void
310 free_entity(ir_entity *ent) {
311         assert(ent && ent->kind == k_entity);
312         free_entity_attrs(ent);
313         ent->kind = k_BAD;
314         free(ent);
315 }  /* free_entity */
316
317 /* Outputs a unique number for this node */
318 long
319 get_entity_nr(const ir_entity *ent) {
320         assert(ent && ent->kind == k_entity);
321 #ifdef DEBUG_libfirm
322         return ent->nr;
323 #else
324         return (long)PTR_TO_INT(ent);
325 #endif
326 }  /* get_entity_nr */
327
328 const char *
329 (get_entity_name)(const ir_entity *ent) {
330         return _get_entity_name(ent);
331 }  /* get_entity_name */
332
333 ident *
334 (get_entity_ident)(const ir_entity *ent) {
335         return _get_entity_ident(ent);
336 }  /* get_entity_ident */
337
338 void
339 (set_entity_ident)(ir_entity *ent, ident *id) {
340         _set_entity_ident(ent, id);
341 }  /* set_entity_ident */
342
343 ir_type *
344 (get_entity_owner)(ir_entity *ent) {
345         return _get_entity_owner(ent);
346 }  /* get_entity_owner */
347
348 void
349 set_entity_owner(ir_entity *ent, ir_type *owner) {
350         assert(is_entity(ent));
351         assert(is_compound_type(owner));
352         ent->owner = owner;
353 }  /* set_entity_owner */
354
355 ident *
356 (get_entity_ld_ident)(ir_entity *ent) {
357         return _get_entity_ld_ident(ent);
358 }  /* get_entity_ld_ident */
359
360 void
361 (set_entity_ld_ident)(ir_entity *ent, ident *ld_ident) {
362         _set_entity_ld_ident(ent, ld_ident);
363 }  /* set_entity_ld_ident */
364
365 const char *
366 (get_entity_ld_name)(ir_entity *ent) {
367         return _get_entity_ld_name(ent);
368 }  /* get_entity_ld_name */
369
370 ir_type *
371 (get_entity_type)(ir_entity *ent) {
372         return _get_entity_type(ent);
373 }  /* get_entity_type */
374
375 void
376 (set_entity_type)(ir_entity *ent, ir_type *type) {
377         _set_entity_type(ent, type);
378 }  /* set_entity_type */
379
380 ir_allocation
381 (get_entity_allocation)(const ir_entity *ent) {
382         return _get_entity_allocation(ent);
383 }  /* get_entity_allocation */
384
385 void
386 (set_entity_allocation)(ir_entity *ent, ir_allocation al) {
387         _set_entity_allocation(ent, al);
388 }  /* set_entity_allocation */
389
390 /* return the name of the visibility */
391 const char *get_allocation_name(ir_allocation all)
392 {
393 #define X(a)    case a: return #a
394         switch (all) {
395         X(allocation_automatic);
396         X(allocation_parameter);
397         X(allocation_dynamic);
398         X(allocation_static);
399     default: return "BAD VALUE";
400         }
401 #undef X
402 }  /* get_allocation_name */
403
404 ir_visibility
405 (get_entity_visibility)(const ir_entity *ent) {
406         return _get_entity_visibility(ent);
407 }  /* get_entity_visibility */
408
409 void
410 set_entity_visibility(ir_entity *ent, ir_visibility vis) {
411         assert(ent && ent->kind == k_entity);
412         if (vis != visibility_local)
413                 assert((ent->allocation == allocation_static) ||
414                 (ent->allocation == allocation_automatic));
415                 /* @@@ Test that the owner type is not local, but how??
416         && get_class_visibility(get_entity_owner(ent)) != local));*/
417         ent->visibility = vis;
418 }  /* set_entity_visibility */
419
420 /* return the name of the visibility */
421 const char *get_visibility_name(ir_visibility vis)
422 {
423 #define X(a)    case a: return #a
424         switch (vis) {
425         X(visibility_local);
426         X(visibility_external_visible);
427         X(visibility_external_allocated);
428     default: return "BAD VALUE";
429         }
430 #undef X
431 }  /* get_visibility_name */
432
433 ir_variability
434 (get_entity_variability)(const ir_entity *ent) {
435         return _get_entity_variability(ent);
436 }  /* get_entity_variability */
437
438 void
439 set_entity_variability(ir_entity *ent, ir_variability var)
440 {
441         assert(ent && ent->kind == k_entity);
442         if (var == variability_part_constant)
443                 assert(is_Class_type(ent->type) || is_Struct_type(ent->type));
444
445         if ((is_compound_type(ent->type)) &&
446                 (ent->variability == variability_uninitialized) && (var != variability_uninitialized)) {
447                 /* Allocate data structures for constant values */
448                 ent->attr.cmpd_attr.values    = NEW_ARR_F(ir_node *, 0);
449                 ent->attr.cmpd_attr.val_paths = NEW_ARR_F(compound_graph_path *, 0);
450         }
451         if ((is_atomic_type(ent->type)) &&
452                 (ent->variability == variability_uninitialized) && (var != variability_uninitialized)) {
453                 /* Set default constant value. */
454                 ent->value = new_rd_Unknown(get_const_code_irg(), get_type_mode(ent->type));
455         }
456
457         if ((is_compound_type(ent->type)) &&
458                 (var == variability_uninitialized) && (ent->variability != variability_uninitialized)) {
459                 /* Free data structures for constant values */
460                 DEL_ARR_F(ent->attr.cmpd_attr.values);    ent->attr.cmpd_attr.values    = NULL;
461                 DEL_ARR_F(ent->attr.cmpd_attr.val_paths); ent->attr.cmpd_attr.val_paths = NULL;
462         }
463         ent->variability = var;
464 }  /* set_entity_variability */
465
466 /* return the name of the variability */
467 const char *get_variability_name(ir_variability var)
468 {
469 #define X(a)    case a: return #a
470         switch (var) {
471         X(variability_uninitialized);
472         X(variability_initialized);
473         X(variability_part_constant);
474         X(variability_constant);
475     default: return "BAD VALUE";
476         }
477 #undef X
478 }  /* get_variability_name */
479
480 ir_volatility
481 (get_entity_volatility)(const ir_entity *ent) {
482         return _get_entity_volatility(ent);
483 }  /* get_entity_volatility */
484
485 void
486 (set_entity_volatility)(ir_entity *ent, ir_volatility vol) {
487         _set_entity_volatility(ent, vol);
488 }  /* set_entity_volatility */
489
490 /* Return the name of the volatility. */
491 const char *get_volatility_name(ir_volatility var)
492 {
493 #define X(a)    case a: return #a
494         switch (var) {
495         X(volatility_non_volatile);
496         X(volatility_is_volatile);
497     default: return "BAD VALUE";
498         }
499 #undef X
500 }  /* get_volatility_name */
501
502 ir_align
503 (get_entity_align)(const ir_entity *ent) {
504         return _get_entity_align(ent);
505 }  /* get_entity_align */
506
507 void
508 (set_entity_align)(ir_entity *ent, ir_align a) {
509         _set_entity_align(ent, a);
510 }  /* set_entity_align */
511
512 /* Return the name of the alignment. */
513 const char *get_align_name(ir_align a)
514 {
515 #define X(a)    case a: return #a
516         switch (a) {
517         X(align_non_aligned);
518         X(align_is_aligned);
519         default: return "BAD VALUE";
520         }
521 #undef X
522 }  /* get_align_name */
523
524 ir_peculiarity
525 (get_entity_peculiarity)(const ir_entity *ent) {
526         return _get_entity_peculiarity(ent);
527 }  /* get_entity_peculiarity */
528
529 void
530 (set_entity_peculiarity)(ir_entity *ent, ir_peculiarity pec) {
531         _set_entity_peculiarity(ent, pec);
532 }  /* set_entity_peculiarity */
533
534 /* Checks if an entity cannot be overridden anymore. */
535 int (is_entity_final)(const ir_entity *ent) {
536         return _is_entity_final(ent);
537 }  /* is_entity_final */
538
539 /* Sets/resets the final flag of an entity. */
540 void (set_entity_final)(ir_entity *ent, int final) {
541         _set_entity_final(ent, final);
542 }  /* set_entity_final */
543
544 /* Checks if an entity is compiler generated */
545 int (is_entity_compiler_generated)(const ir_entity *ent) {
546         return _is_entity_compiler_generated(ent);
547 }  /* is_entity_compiler_generated */
548
549 /* Sets/resets the compiler generated flag */
550 void (set_entity_compiler_generated)(ir_entity *ent, int flag) {
551         _set_entity_compiler_generated(ent, flag);
552 }  /* set_entity_compiler_generated */
553
554 /* Checks if an entity is marked by the backend */
555 int (is_entity_backend_marked)(const ir_entity *ent) {
556         return _is_entity_backend_marked(ent);
557 }  /* is_entity_backend_marked */
558
559 /* Sets/resets the compiler generated flag */
560 void (set_entity_backend_marked)(ir_entity *ent, int flag) {
561         _set_entity_backend_marked(ent, flag);
562 }  /* set_entity_backend_marked */
563
564 /* Checks if the address of an entity was taken. */
565 ir_address_taken_state (get_entity_address_taken)(const ir_entity *ent) {
566         return _get_entity_address_taken(ent);
567 }  /* is_entity_address_taken */
568
569 /* Sets/resets the address taken flag. */
570 void (set_entity_address_taken)(ir_entity *ent, ir_address_taken_state flag) {
571         _set_entity_address_taken(ent, flag);
572 }  /* set_entity_address_taken */
573
574 /* Return the name of the address_taken state. */
575 const char *get_address_taken_state_name(ir_address_taken_state state) {
576 #define X(a)    case a: return #a
577         switch (state) {
578         X(ir_address_not_taken);
579         X(ir_address_taken_unknown);
580         X(ir_address_taken);
581     default: return "BAD VALUE";
582         }
583 #undef X
584 }  /* get_address_taken_state_name */
585
586 /* Get the entity's stickyness */
587 ir_stickyness
588 (get_entity_stickyness)(const ir_entity *ent) {
589         return _get_entity_stickyness(ent);
590 }  /* get_entity_stickyness */
591
592 /* Set the entity's stickyness */
593 void
594 (set_entity_stickyness)(ir_entity *ent, ir_stickyness stickyness) {
595         _set_entity_stickyness(ent, stickyness);
596 }  /* set_entity_stickyness */
597
598 /* Set has no effect for existent entities of type method. */
599 ir_node *
600 get_atomic_ent_value(ir_entity *ent)
601 {
602         assert(ent && is_atomic_entity(ent));
603         assert(ent->variability != variability_uninitialized);
604         return skip_Id(ent->value);
605 }  /* get_atomic_ent_value */
606
607 void
608 set_atomic_ent_value(ir_entity *ent, ir_node *val) {
609         assert(is_atomic_entity(ent) && (ent->variability != variability_uninitialized));
610         if (is_Method_type(ent->type) && (ent->peculiarity == peculiarity_existent))
611                 return;
612         assert(get_irn_mode(val) == get_type_mode(ent->type));
613         ent->value = val;
614 }  /* set_atomic_ent_value */
615
616 /* Returns true if the the node is representable as code on
617  *  const_code_irg. */
618 int is_irn_const_expression(ir_node *n) {
619         ir_mode *m;
620
621         /* we are in danger iff an exception will arise. TODO: be more precisely,
622          * for instance Div. will NOT rise if divisor != 0
623          */
624         if (is_binop(n) && !is_fragile_op(n))
625                 return is_irn_const_expression(get_binop_left(n)) && is_irn_const_expression(get_binop_right(n));
626
627         m = get_irn_mode(n);
628         switch (get_irn_opcode(n)) {
629         case iro_Const:
630         case iro_SymConst:
631         case iro_Unknown:
632                 return 1;
633         case iro_Conv:
634         case iro_Cast:
635                 return is_irn_const_expression(get_irn_n(n, 0));
636         default:
637                 break;
638         }
639         return 0;
640 }  /* is_irn_const_expression */
641
642 /*
643  * Copies a firm subgraph that complies to the restrictions for
644  * constant expressions to current_block in current_ir_graph.
645  */
646 ir_node *copy_const_value(dbg_info *dbg, ir_node *n) {
647         ir_node *nn;
648         ir_mode *m;
649
650         /* @@@ GL I think  we should implement this using the routines from irgopt for
651                dead node elimination/inlineing. */
652
653         m = get_irn_mode(n);
654         switch (get_irn_opcode(n)) {
655         case iro_Const:
656                 nn = new_d_Const_type(dbg, m, get_Const_tarval(n), get_Const_type(n));
657                 break;
658         case iro_SymConst:
659                 nn = new_d_SymConst_type(dbg, get_irn_mode(n), get_SymConst_symbol(n), get_SymConst_kind(n),
660                         get_SymConst_value_type(n));
661                 break;
662         case iro_Add:
663                 nn = new_d_Add(dbg, copy_const_value(dbg, get_Add_left(n)),
664                         copy_const_value(dbg, get_Add_right(n)), m); break;
665         case iro_Sub:
666                 nn = new_d_Sub(dbg, copy_const_value(dbg, get_Sub_left(n)),
667                         copy_const_value(dbg, get_Sub_right(n)), m); break;
668         case iro_Mul:
669                 nn = new_d_Mul(dbg, copy_const_value(dbg, get_Mul_left(n)),
670                         copy_const_value(dbg, get_Mul_right(n)), m); break;
671         case iro_And:
672                 nn = new_d_And(dbg, copy_const_value(dbg, get_And_left(n)),
673                         copy_const_value(dbg, get_And_right(n)), m); break;
674         case iro_Or:
675                 nn = new_d_Or(dbg, copy_const_value(dbg, get_Or_left(n)),
676                         copy_const_value(dbg, get_Or_right(n)), m); break;
677         case iro_Eor:
678                 nn = new_d_Eor(dbg, copy_const_value(dbg, get_Eor_left(n)),
679                         copy_const_value(dbg, get_Eor_right(n)), m); break;
680         case iro_Cast:
681                 nn = new_d_Cast(dbg, copy_const_value(dbg, get_Cast_op(n)), get_Cast_type(n)); break;
682         case iro_Conv:
683                 nn = new_d_Conv(dbg, copy_const_value(dbg, get_Conv_op(n)), m); break;
684         case iro_Unknown:
685                 nn = new_d_Unknown(m); break;
686         default:
687                 assert(0 && "opcode invalid or not implemented");
688                 nn = NULL;
689                 break;
690         }
691         return nn;
692 }  /* copy_const_value */
693
694 static ir_initializer_t null_initializer = { IR_INITIALIZER_NULL };
695
696 ir_initializer_t *get_initializer_null(void)
697 {
698         return &null_initializer;
699 }
700
701 ir_initializer_t *create_initializer_const(ir_node *value)
702 {
703         struct obstack *obst = get_irg_obstack(get_const_code_irg());
704
705         ir_initializer_t *initializer
706                 = obstack_alloc(obst, sizeof(ir_initializer_const_t));
707         initializer->kind         = IR_INITIALIZER_CONST;
708         initializer->consti.value = value;
709
710         return initializer;
711 }
712
713 ir_initializer_t *create_initializer_tarval(tarval *tv)
714 {
715         struct obstack *obst = get_irg_obstack(get_const_code_irg());
716
717         ir_initializer_t *initializer
718                 = obstack_alloc(obst, sizeof(ir_initializer_tarval_t));
719         initializer->kind         = IR_INITIALIZER_TARVAL;
720         initializer->tarval.value = tv;
721
722         return initializer;
723 }
724
725 ir_initializer_t *create_initializer_compound(unsigned n_entries)
726 {
727         struct obstack *obst = get_irg_obstack(get_const_code_irg());
728
729         size_t i;
730         size_t size  = sizeof(ir_initializer_compound_t)
731                      + (n_entries-1) * sizeof(ir_initializer_t*);
732
733         ir_initializer_t *initializer = obstack_alloc(obst, size);
734         initializer->kind                    = IR_INITIALIZER_COMPOUND;
735         initializer->compound.n_initializers = n_entries;
736
737         for(i = 0; i < n_entries; ++i) {
738                 initializer->compound.initializers[i] = get_initializer_null();
739         }
740
741         return initializer;
742 }
743
744 ir_node *get_initializer_const_value(const ir_initializer_t *initializer)
745 {
746         assert(initializer->kind == IR_INITIALIZER_CONST);
747         return initializer->consti.value;
748 }
749
750 tarval *get_initializer_tarval_value(const ir_initializer_t *initializer)
751 {
752         assert(initializer->kind == IR_INITIALIZER_TARVAL);
753         return initializer->tarval.value;
754 }
755
756 unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer)
757 {
758         assert(initializer->kind == IR_INITIALIZER_COMPOUND);
759         return initializer->compound.n_initializers;
760 }
761
762 void set_initializer_compound_value(ir_initializer_t *initializer,
763                                     unsigned index, ir_initializer_t *value)
764 {
765         assert(initializer->kind == IR_INITIALIZER_COMPOUND);
766         assert(index < initializer->compound.n_initializers);
767
768         initializer->compound.initializers[index] = value;
769 }
770
771 ir_initializer_t *get_initializer_compound_value(
772                 const ir_initializer_t *initializer, unsigned index)
773 {
774         assert(initializer->kind == IR_INITIALIZER_COMPOUND);
775         assert(index < initializer->compound.n_initializers);
776
777         return initializer->compound.initializers[index];
778 }
779
780 ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer)
781 {
782         return initializer->kind;
783 }
784
785 static void check_entity_initializer(ir_entity *entity)
786 {
787         /* TODO */
788         (void) entity;
789 }
790
791 void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer)
792 {
793         entity->attr.initializer = initializer;
794         entity->has_initializer  = 1;
795         check_entity_initializer(entity);
796 }
797
798 ir_initializer_t *get_entity_initializer(const ir_entity *entity)
799 {
800         assert(entity->has_initializer);
801         return entity->attr.initializer;
802 }
803
804 /* Creates a new compound graph path. */
805 compound_graph_path *
806 new_compound_graph_path(ir_type *tp, int length) {
807         compound_graph_path *res;
808
809         assert(is_compound_type(tp));
810         assert(length > 0);
811
812         res = xmalloc(sizeof(*res) + (length-1) * sizeof(res->list[0]));
813         memset(res, 0, sizeof(*res) + (length-1) * sizeof(res->list[0]));
814         res->kind         = k_ir_compound_graph_path;
815         res->tp           = tp;
816         res->len          = length;
817
818         return res;
819 }  /* new_compound_graph_path */
820
821 /* Frees an graph path object */
822 void free_compound_graph_path (compound_graph_path *gr) {
823         assert(gr && is_compound_graph_path(gr));
824         gr->kind = k_BAD;
825         free(gr);
826 }  /* free_compound_graph_path */
827
828 /* Returns non-zero if an object is a compound graph path */
829 int is_compound_graph_path(const void *thing) {
830         return (get_kind(thing) == k_ir_compound_graph_path);
831 }  /* is_compound_graph_path */
832
833 /* Checks whether the path up to pos is correct. If the path contains a NULL,
834  *  assumes the path is not complete and returns 'true'. */
835 int is_proper_compound_graph_path(compound_graph_path *gr, int pos) {
836         int i;
837         ir_entity *node;
838         ir_type *owner = gr->tp;
839
840         for (i = 0; i <= pos; i++) {
841                 node = get_compound_graph_path_node(gr, i);
842                 if (node == NULL)
843                         /* Path not yet complete. */
844                         return 1;
845                 if (get_entity_owner(node) != owner)
846                         return 0;
847                 owner = get_entity_type(node);
848         }
849         if (pos == get_compound_graph_path_length(gr))
850                 if (!is_atomic_type(owner))
851                         return 0;
852                 return 1;
853 }  /* is_proper_compound_graph_path */
854
855 /* Returns the length of a graph path */
856 int get_compound_graph_path_length(const compound_graph_path *gr) {
857         assert(gr && is_compound_graph_path(gr));
858         return gr->len;
859 }  /* get_compound_graph_path_length */
860
861 ir_entity *
862 get_compound_graph_path_node(const compound_graph_path *gr, int pos) {
863         assert(gr && is_compound_graph_path(gr));
864         assert(pos >= 0 && pos < gr->len);
865         return gr->list[pos].node;
866 }  /* get_compound_graph_path_node */
867
868 void
869 set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node) {
870         assert(gr && is_compound_graph_path(gr));
871         assert(pos >= 0 && pos < gr->len);
872         assert(is_entity(node));
873         gr->list[pos].node = node;
874         assert(is_proper_compound_graph_path(gr, pos));
875 }  /* set_compound_graph_path_node */
876
877 int
878 get_compound_graph_path_array_index(const compound_graph_path *gr, int pos) {
879         assert(gr && is_compound_graph_path(gr));
880         assert(pos >= 0 && pos < gr->len);
881         return gr->list[pos].index;
882 }  /* get_compound_graph_path_array_index */
883
884 void
885 set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index) {
886         assert(gr && is_compound_graph_path(gr));
887         assert(pos >= 0 && pos < gr->len);
888         gr->list[pos].index = index;
889 }  /* set_compound_graph_path_array_index */
890
891 /* A value of a compound entity is a pair of value and the corresponding path to a member of
892    the compound. */
893 void
894 add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path) {
895         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
896         assert(is_compound_graph_path(path));
897         ARR_APP1(ir_node *, ent->attr.cmpd_attr.values, val);
898         ARR_APP1(compound_graph_path *, ent->attr.cmpd_attr.val_paths, path);
899 }  /* add_compound_ent_value_w_path */
900
901 void
902 set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos) {
903         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
904         assert(is_compound_graph_path(path));
905         assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.values));
906         ent->attr.cmpd_attr.values[pos]    = val;
907         ent->attr.cmpd_attr.val_paths[pos] = path;
908 }  /* set_compound_ent_value_w_path */
909
910 int
911 get_compound_ent_n_values(ir_entity *ent) {
912         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
913         return ARR_LEN(ent->attr.cmpd_attr.values);
914 }  /* get_compound_ent_n_values */
915
916 ir_node *
917 get_compound_ent_value(ir_entity *ent, int pos) {
918         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
919         assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.values));
920         return ent->attr.cmpd_attr.values[pos];
921 }  /* get_compound_ent_value */
922
923 compound_graph_path *
924 get_compound_ent_value_path(ir_entity *ent, int pos) {
925         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
926         assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.val_paths));
927         return ent->attr.cmpd_attr.val_paths[pos];
928 }  /* get_compound_ent_value_path */
929
930 /**
931  * Returns non-zero, if two compound_graph_pathes are equal
932  *
933  * @param path1            the first path
934  * @param visited_indices
935  * @param path2            the second path
936  */
937 static int equal_paths(compound_graph_path *path1, int *visited_indices, compound_graph_path *path2) {
938         int i;
939         int len1 = get_compound_graph_path_length(path1);
940         int len2 = get_compound_graph_path_length(path2);
941
942         if (len2 != len1) return 0;
943
944         for (i = 0; i < len1; i++) {
945                 ir_type *tp;
946                 ir_entity *node1 = get_compound_graph_path_node(path1, i);
947                 ir_entity *node2 = get_compound_graph_path_node(path2, i);
948
949                 if (node1 != node2) return 0;
950
951                 /* FIXME: Strange code. What is it good for? */
952                 tp = get_entity_owner(node1);
953                 if (is_Array_type(tp)) {
954                         long low;
955
956                         /* Compute the index of this node. */
957                         assert(get_array_n_dimensions(tp) == 1 && "multidim not implemented");
958
959                         low = get_array_lower_bound_int(tp, 0);
960                         if (low + visited_indices[i] < get_compound_graph_path_array_index(path2, i)) {
961                                 visited_indices[i]++;
962                                 return 0;
963                         } else
964                                 assert(low + visited_indices[i] == get_compound_graph_path_array_index(path2, i));
965                 }
966         }
967         return 1;
968 }  /* equal_paths */
969
970 /**
971  * Returns the position of a value with the given path.
972  * The path must contain array indices for all array element entities.
973  *
974  * @todo  This implementation is very slow (O(number of initializers^2) and should
975  *        be replaced when the new tree oriented
976  *        value representation is finally implemented.
977  */
978 static int get_compound_ent_pos_by_path(ir_entity *ent, compound_graph_path *path) {
979         int i, n_paths = get_compound_ent_n_values(ent);
980         int *visited_indices;
981         int path_len = get_compound_graph_path_length(path);
982
983         NEW_ARR_A(int *, visited_indices, path_len);
984         memset(visited_indices, 0, sizeof(*visited_indices) * path_len);
985         for (i = 0; i < n_paths; i ++) {
986                 if (equal_paths(get_compound_ent_value_path(ent, i), visited_indices, path))
987                         return i;
988         }
989
990 #if 0
991         {
992                 int j;
993                 printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
994                 printf("Entity %s : ", get_entity_name(ent));
995                 for (j = 0; j < get_compound_graph_path_length(path); ++j) {
996                         ir_entity *node = get_compound_graph_path_node(path, j);
997                         printf("%s", get_entity_name(node));
998                         if (is_Array_type(get_entity_owner(node)))
999                                 printf("[%d]", get_compound_graph_path_array_index(path, j));
1000                 }
1001                 printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
1002         }
1003 #endif
1004
1005         assert(0 && "path not found");
1006         return -1;
1007 }  /* get_compound_ent_pos_by_path */
1008
1009 /* Returns a constant value given the access path.
1010  *  The path must contain array indices for all array element entities. */
1011 ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path) {
1012         return get_compound_ent_value(ent, get_compound_ent_pos_by_path(ent, path));
1013 }  /* get_compound_ent_value_by_path */
1014
1015
1016 void
1017 remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent) {
1018         int i, n;
1019         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1020
1021         n = ARR_LEN(ent->attr.cmpd_attr.val_paths);
1022         for (i = 0; i < n; ++i) {
1023                 compound_graph_path *path = ent->attr.cmpd_attr.val_paths[i];
1024                 if (path->list[path->len-1].node == value_ent) {
1025                         for (; i < n - 1; ++i) {
1026                                 ent->attr.cmpd_attr.val_paths[i] = ent->attr.cmpd_attr.val_paths[i+1];
1027                                 ent->attr.cmpd_attr.values[i]    = ent->attr.cmpd_attr.values[i+1];
1028                         }
1029                         ARR_SETLEN(ir_entity*, ent->attr.cmpd_attr.val_paths, n - 1);
1030                         ARR_SETLEN(ir_node*,   ent->attr.cmpd_attr.values,    n - 1);
1031                         break;
1032                 }
1033         }
1034 }  /* remove_compound_ent_value */
1035
1036 void
1037 add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member) {
1038         compound_graph_path *path;
1039         ir_type *owner_tp = get_entity_owner(member);
1040         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1041         path = new_compound_graph_path(get_entity_type(ent), 1);
1042         path->list[0].node = member;
1043         if (is_Array_type(owner_tp)) {
1044                 int max;
1045                 int i, n;
1046
1047                 assert(get_array_n_dimensions(owner_tp) == 1 && has_array_lower_bound(owner_tp, 0));
1048                 max = get_array_lower_bound_int(owner_tp, 0) -1;
1049                 for (i = 0, n = get_compound_ent_n_values(ent); i < n; ++i) {
1050                         int index = get_compound_graph_path_array_index(get_compound_ent_value_path(ent, i), 0);
1051                         if (index > max) {
1052                                 max = index;
1053                         }
1054                 }
1055                 path->list[0].index = max + 1;
1056         }
1057         add_compound_ent_value_w_path(ent, val, path);
1058 }  /* add_compound_ent_value */
1059
1060
1061 ir_entity *
1062 get_compound_ent_value_member(ir_entity *ent, int pos) {
1063         compound_graph_path *path;
1064         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1065         path = get_compound_ent_value_path(ent, pos);
1066
1067         return get_compound_graph_path_node(path, get_compound_graph_path_length(path)-1);
1068 }  /* get_compound_ent_value_member */
1069
1070 void
1071 set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos) {
1072         compound_graph_path *path;
1073         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1074         path = get_compound_ent_value_path(ent, pos);
1075         set_compound_graph_path_node(path, 0, member);
1076         set_compound_ent_value_w_path(ent, val, path, pos);
1077 }  /* set_compound_ent_value */
1078
1079 void
1080 set_array_entity_values(ir_entity *ent, tarval **values, int num_vals) {
1081         int i;
1082         ir_graph *rem = current_ir_graph;
1083         ir_type *arrtp = get_entity_type(ent);
1084         ir_node *val;
1085         ir_type *elttp = get_array_element_type(arrtp);
1086
1087         assert(is_Array_type(arrtp));
1088         assert(get_array_n_dimensions(arrtp) == 1);
1089         /* One bound is sufficient, the number of constant fields makes the
1090            size. */
1091         assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
1092         assert(get_entity_variability(ent) != variability_uninitialized);
1093         current_ir_graph = get_const_code_irg();
1094
1095         for (i = 0; i < num_vals; i++) {
1096                 val = new_Const_type(values[i], elttp);
1097                 add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
1098                 set_compound_graph_path_array_index(get_compound_ent_value_path(ent, i), 0, i);
1099         }
1100         current_ir_graph = rem;
1101 }  /* set_array_entity_values */
1102
1103 /* Return the overall offset of value at position pos in bytes. */
1104 unsigned get_compound_ent_value_offset_bytes(ir_entity *ent, int pos) {
1105         compound_graph_path *path;
1106         int path_len, i;
1107         unsigned offset = 0;
1108         ir_type *curr_tp;
1109
1110         assert(get_type_state(get_entity_type(ent)) == layout_fixed);
1111
1112         path     = get_compound_ent_value_path(ent, pos);
1113         path_len = get_compound_graph_path_length(path);
1114         curr_tp  = path->tp;
1115
1116         for (i = 0; i < path_len; ++i) {
1117                 if (is_Array_type(curr_tp)) {
1118                         ir_type *elem_type = get_array_element_type(curr_tp);
1119                         unsigned size      = get_type_size_bytes(elem_type);
1120                         unsigned align     = get_type_alignment_bytes(elem_type);
1121                         int      idx;
1122
1123                         assert(size > 0);
1124                         if(size % align > 0) {
1125                                 size += align - (size % align);
1126                         }
1127                         idx = get_compound_graph_path_array_index(path, i);
1128                         assert(idx >= 0);
1129                         offset += size * idx;
1130                         curr_tp = elem_type;
1131                 } else {
1132                         ir_entity *node = get_compound_graph_path_node(path, i);
1133                         offset += get_entity_offset(node);
1134                         curr_tp = get_entity_type(node);
1135                 }
1136         }
1137
1138         return offset;
1139 }  /* get_compound_ent_value_offset_bytes */
1140
1141 /* Return the offset in bits from the last byte address. */
1142 unsigned get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos) {
1143         compound_graph_path *path;
1144         int path_len;
1145         ir_entity *last_node;
1146
1147         assert(get_type_state(get_entity_type(ent)) == layout_fixed);
1148
1149         path      = get_compound_ent_value_path(ent, pos);
1150         path_len  = get_compound_graph_path_length(path);
1151         last_node = get_compound_graph_path_node(path, path_len - 1);
1152
1153         if(last_node == NULL)
1154                 return 0;
1155
1156         return get_entity_offset_bits_remainder(last_node);
1157 }  /* get_compound_ent_value_offset_bit_remainder */
1158
1159 int
1160 (get_entity_offset)(const ir_entity *ent) {
1161         return _get_entity_offset(ent);
1162 }  /* get_entity_offset */
1163
1164 void
1165 (set_entity_offset)(ir_entity *ent, int offset) {
1166         _set_entity_offset(ent, offset);
1167 }  /* set_entity_offset */
1168
1169 unsigned char
1170 (get_entity_offset_bits_remainder)(const ir_entity *ent) {
1171         return _get_entity_offset_bits_remainder(ent);
1172 }  /* get_entity_offset_bits_remainder */
1173
1174 void
1175 (set_entity_offset_bits_remainder)(ir_entity *ent, unsigned char offset) {
1176         _set_entity_offset_bits_remainder(ent, offset);
1177 }  /* set_entity_offset_bits_remainder */
1178
1179 void
1180 add_entity_overwrites(ir_entity *ent, ir_entity *overwritten) {
1181 #ifndef NDEBUG
1182         ir_type *owner     = get_entity_owner(ent);
1183         ir_type *ovw_ovner = get_entity_owner(overwritten);
1184         assert(is_Class_type(owner));
1185         assert(is_Class_type(ovw_ovner));
1186         assert(! is_class_final(ovw_ovner));
1187 #endif /* NDEBUG */
1188         ARR_APP1(ir_entity *, ent->overwrites, overwritten);
1189         ARR_APP1(ir_entity *, overwritten->overwrittenby, ent);
1190 }  /* add_entity_overwrites */
1191
1192 int
1193 get_entity_n_overwrites(ir_entity *ent) {
1194         assert(is_Class_type(get_entity_owner(ent)));
1195         return (ARR_LEN(ent->overwrites));
1196 }  /* get_entity_n_overwrites */
1197
1198 int
1199 get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten) {
1200         int i, n;
1201         assert(is_Class_type(get_entity_owner(ent)));
1202         n = get_entity_n_overwrites(ent);
1203         for (i = 0; i < n; ++i) {
1204                 if (get_entity_overwrites(ent, i) == overwritten)
1205                         return i;
1206         }
1207         return -1;
1208 }  /* get_entity_overwrites_index */
1209
1210 ir_entity *
1211 get_entity_overwrites(ir_entity *ent, int pos) {
1212         assert(is_Class_type(get_entity_owner(ent)));
1213         assert(pos < get_entity_n_overwrites(ent));
1214         return ent->overwrites[pos];
1215 }  /* get_entity_overwrites */
1216
1217 void
1218 set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten) {
1219         assert(is_Class_type(get_entity_owner(ent)));
1220         assert(pos < get_entity_n_overwrites(ent));
1221         ent->overwrites[pos] = overwritten;
1222 }  /* set_entity_overwrites */
1223
1224 void
1225 remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten) {
1226         int i, n;
1227         assert(is_Class_type(get_entity_owner(ent)));
1228         n = ARR_LEN(ent->overwrites);
1229         for (i = 0; i < n; ++i) {
1230                 if (ent->overwrites[i] == overwritten) {
1231                         for (; i < n - 1; i++)
1232                                 ent->overwrites[i] = ent->overwrites[i+1];
1233                         ARR_SETLEN(ir_entity*, ent->overwrites, n - 1);
1234                         break;
1235                 }
1236         }
1237 }  /* remove_entity_overwrites */
1238
1239 void
1240 add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites) {
1241         add_entity_overwrites(overwrites, ent);
1242 }  /* add_entity_overwrittenby */
1243
1244 int
1245 get_entity_n_overwrittenby(ir_entity *ent) {
1246         assert(is_Class_type(get_entity_owner(ent)));
1247         return ARR_LEN(ent->overwrittenby);
1248 }  /* get_entity_n_overwrittenby */
1249
1250 int
1251 get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites) {
1252         int i, n;
1253         assert(is_Class_type(get_entity_owner(ent)));
1254         n = get_entity_n_overwrittenby(ent);
1255         for (i = 0; i < n; ++i) {
1256                 if (get_entity_overwrittenby(ent, i) == overwrites)
1257                         return i;
1258         }
1259         return -1;
1260 }  /* get_entity_overwrittenby_index */
1261
1262 ir_entity *
1263 get_entity_overwrittenby(ir_entity *ent, int pos) {
1264         assert(is_Class_type(get_entity_owner(ent)));
1265         assert(pos < get_entity_n_overwrittenby(ent));
1266         return ent->overwrittenby[pos];
1267 }  /* get_entity_overwrittenby */
1268
1269 void
1270 set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites) {
1271         assert(is_Class_type(get_entity_owner(ent)));
1272         assert(pos < get_entity_n_overwrittenby(ent));
1273         ent->overwrittenby[pos] = overwrites;
1274 }  /* set_entity_overwrittenby */
1275
1276 void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites) {
1277         int i, n;
1278         assert(is_Class_type(get_entity_owner(ent)));
1279
1280         n = ARR_LEN(ent->overwrittenby);
1281         for (i = 0; i < n; ++i) {
1282                 if (ent->overwrittenby[i] == overwrites) {
1283                         for(; i < n - 1; ++i)
1284                                 ent->overwrittenby[i] = ent->overwrittenby[i+1];
1285                         ARR_SETLEN(ir_entity*, ent->overwrittenby, n - 1);
1286                         break;
1287                 }
1288         }
1289 }  /* remove_entity_overwrittenby */
1290
1291 /* A link to store intermediate information */
1292 void *
1293 (get_entity_link)(const ir_entity *ent) {
1294         return _get_entity_link(ent);
1295 }  /* get_entity_link */
1296
1297 void
1298 (set_entity_link)(ir_entity *ent, void *l) {
1299         _set_entity_link(ent, l);
1300 }  /* set_entity_link */
1301
1302 ir_graph *
1303 (get_entity_irg)(const ir_entity *ent) {
1304         return _get_entity_irg(ent);
1305 }  /* get_entity_irg */
1306
1307 void
1308 set_entity_irg(ir_entity *ent, ir_graph *irg) {
1309         assert(is_method_entity(ent));
1310         /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
1311          * Methode selbst nicht mehr aufgerufen werden kann, die Entität
1312          * aber erhalten bleiben soll?  Wandle die Entitaet in description oder
1313          * inherited um! */
1314         /* assert(irg); */
1315         assert((irg  && ent->peculiarity == peculiarity_existent) ||
1316                 (!irg && (ent->peculiarity == peculiarity_existent)
1317                 && (ent -> visibility == visibility_external_allocated)) ||
1318                 (!irg && ent->peculiarity == peculiarity_description) ||
1319                 (!irg && ent->peculiarity == peculiarity_inherited));
1320         ent->attr.mtd_attr.irg = irg;
1321 }  /* set_entity_irg */
1322
1323 unsigned get_entity_vtable_number(const ir_entity *ent) {
1324         assert(is_method_entity((ir_entity *)ent));
1325         return ent->attr.mtd_attr.vtable_number;
1326 }  /* get_entity_vtable_number */
1327
1328 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number) {
1329         assert(is_method_entity(ent));
1330         ent->attr.mtd_attr.vtable_number = vtable_number;
1331 }  /* set_entity_vtable_number */
1332
1333 int
1334 (is_entity)(const void *thing) {
1335         return _is_entity(thing);
1336 }  /* is_entity */
1337
1338 int is_atomic_entity(ir_entity *ent) {
1339         ir_type *t      = get_entity_type(ent);
1340         const tp_op *op = get_type_tpop(t);
1341         return (op == type_primitive || op == type_pointer ||
1342                 op == type_enumeration || op == type_method);
1343 }  /* is_atomic_entity */
1344
1345 int is_compound_entity(ir_entity *ent) {
1346         ir_type     *t  = get_entity_type(ent);
1347         const tp_op *op = get_type_tpop(t);
1348         return (op == type_class || op == type_struct ||
1349                 op == type_array || op == type_union);
1350 }  /* is_compound_entity */
1351
1352 int is_method_entity(ir_entity *ent) {
1353         ir_type *t = get_entity_type(ent);
1354         return is_Method_type(t);
1355 }  /* is_method_entity */
1356
1357 /**
1358  * @todo not implemented!!! */
1359 int equal_entity(ir_entity *ent1, ir_entity *ent2) {
1360         (void) ent1;
1361         (void) ent2;
1362         fprintf(stderr, " calling unimplemented equal entity!!! \n");
1363         return 1;
1364 }  /* equal_entity */
1365
1366
1367 unsigned long (get_entity_visited)(ir_entity *ent) {
1368         return _get_entity_visited(ent);
1369 }  /* get_entity_visited */
1370
1371 void (set_entity_visited)(ir_entity *ent, unsigned long num) {
1372         _set_entity_visited(ent, num);
1373 }  /* set_entity_visited */
1374
1375 /* Sets visited field in ir_entity to entity_visited. */
1376 void (mark_entity_visited)(ir_entity *ent) {
1377         _mark_entity_visited(ent);
1378 }  /* mark_entity_visited */
1379
1380 int (entity_visited)(ir_entity *ent) {
1381         return _entity_visited(ent);
1382 }  /* entity_visited */
1383
1384 int (entity_not_visited)(ir_entity *ent) {
1385         return _entity_not_visited(ent);
1386 }  /* entity_not_visited */
1387
1388 /* Returns the mask of the additional entity properties. */
1389 unsigned get_entity_additional_properties(ir_entity *ent) {
1390         ir_graph *irg;
1391
1392         assert(is_method_entity(ent));
1393
1394         /* first check, if the graph has additional properties */
1395         irg = get_entity_irg(ent);
1396
1397         if (irg)
1398                 return get_irg_additional_properties(irg);
1399
1400         if (ent->attr.mtd_attr.irg_add_properties & mtp_property_inherited)
1401                 return get_method_additional_properties(get_entity_type(ent));
1402
1403         return ent->attr.mtd_attr.irg_add_properties;
1404 }  /* get_entity_additional_properties */
1405
1406 /* Sets the mask of the additional graph properties. */
1407 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask)
1408 {
1409         ir_graph *irg;
1410
1411         assert(is_method_entity(ent));
1412
1413         /* first check, if the graph exists */
1414         irg = get_entity_irg(ent);
1415         if (irg)
1416                 set_irg_additional_properties(irg, property_mask);
1417         else {
1418     /* do not allow to set the mtp_property_inherited flag or
1419                 * the automatic inheritance of flags will not work */
1420                 ent->attr.mtd_attr.irg_add_properties = property_mask & ~mtp_property_inherited;
1421         }
1422 }  /* set_entity_additional_properties */
1423
1424 /* Sets one additional graph property. */
1425 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag)
1426 {
1427         ir_graph *irg;
1428
1429         assert(is_method_entity(ent));
1430
1431         /* first check, if the graph exists */
1432         irg = get_entity_irg(ent);
1433         if (irg)
1434                 set_irg_additional_property(irg, flag);
1435         else {
1436                 unsigned mask = ent->attr.mtd_attr.irg_add_properties;
1437
1438                 if (mask & mtp_property_inherited)
1439                         mask = get_method_additional_properties(get_entity_type(ent));
1440
1441                         /* do not allow to set the mtp_property_inherited flag or
1442                 * the automatic inheritance of flags will not work */
1443                 ent->attr.mtd_attr.irg_add_properties = mask | (flag & ~mtp_property_inherited);
1444         }
1445 }  /* set_entity_additional_property */
1446
1447 /* Returns the class type that this type info entity represents or NULL
1448    if ent is no type info entity. */
1449 ir_type *(get_entity_repr_class)(const ir_entity *ent) {
1450         return _get_entity_repr_class(ent);
1451 }  /* get_entity_repr_class */
1452
1453 dbg_info *(get_entity_dbg_info)(const ir_entity *ent) {
1454         return _get_entity_dbg_info(ent);
1455 }  /* get_entity_dbg_info */
1456
1457 void (set_entity_dbg_info)(ir_entity *ent, dbg_info *db) {
1458         _set_entity_dbg_info(ent, db);
1459 }  /* set_entity_dbg_info */
1460
1461 /* Initialize entity module. */
1462 void firm_init_entity(void)
1463 {
1464         symconst_symbol sym;
1465
1466         assert(firm_unknown_type && "Call init_type() before firm_init_entity()!");
1467         assert(!unknown_entity && "Call firm_init_entity() only once!");
1468
1469         unknown_entity = new_rd_entity(NULL, firm_unknown_type, new_id_from_str(UNKNOWN_ENTITY_NAME), firm_unknown_type);
1470         set_entity_visibility(unknown_entity, visibility_external_allocated);
1471         set_entity_ld_ident(unknown_entity, get_entity_ident(unknown_entity));
1472
1473         current_ir_graph      = get_const_code_irg();
1474         sym.entity_p          = unknown_entity;
1475         /* TODO: we need two unknown_entities here, one for code and one for data */
1476         unknown_entity->value = new_SymConst(mode_P_data, sym, symconst_addr_ent);
1477 }  /* firm_init_entity */