allow several odd weak combinations
[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 #include "config.h"
27
28 #include <string.h>
29 #include <stdlib.h>
30 #include <stddef.h>
31
32 #include "xmalloc.h"
33 #include "entity_t.h"
34 #include "array.h"
35 #include "irtools.h"
36 #include "irhooks.h"
37 #include "irprintf.h"
38
39 #include "irprog_t.h"
40 #include "ircons.h"
41 #include "tv_t.h"
42 #include "irdump.h"
43 #include "irgraph_t.h"
44 #include "callgraph.h"
45 #include "error.h"
46 #include "compound_path.h"
47
48 /*-----------------------------------------------------------------*/
49 /** general                                                       **/
50 /*-----------------------------------------------------------------*/
51
52 ir_entity *unknown_entity = NULL;
53
54 ir_entity *get_unknown_entity(void) { return unknown_entity; }
55
56 /** The name of the unknown entity. */
57 #define UNKNOWN_ENTITY_NAME "unknown_entity"
58
59 /*-----------------------------------------------------------------*/
60 /* ENTITY                                                          */
61 /*-----------------------------------------------------------------*/
62
63 /**
64  * Add an entity to it's already set owner type.
65  */
66 static inline void insert_entity_in_owner(ir_entity *ent) {
67         ir_type *owner = ent->owner;
68         switch (get_type_tpop_code(owner)) {
69         case tpo_class:
70                 add_class_member(owner, ent);
71                 break;
72         case tpo_struct:
73                 add_struct_member(owner, ent);
74                 break;
75         case tpo_union:
76                 add_union_member(owner, ent);
77                 break;
78         case tpo_array:
79                 set_array_element_entity(owner, ent);
80                 break;
81         default:
82                 panic("Unsupported type kind");
83         }
84 }  /* insert_entity_in_owner */
85
86 /**
87  * Creates a new entity. This entity is NOT inserted in the owner type.
88  *
89  * @param db     debug info for this entity
90  * @param owner  the owner type of the new entity
91  * @param name   the name of the new entity
92  * @param type   the type of the new entity
93  *
94  * @return the new created entity
95  */
96 static inline ir_entity *
97 new_rd_entity(dbg_info *db, ir_type *owner, ident *name, ir_type *type)
98 {
99         ir_entity *res;
100         ir_graph *rem;
101
102         assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
103
104         res = XMALLOCZ(ir_entity);
105
106         res->kind    = k_entity;
107         res->name    = name;
108         res->ld_name = NULL;
109         res->type    = type;
110         res->owner   = owner;
111
112         res->volatility           = volatility_non_volatile;
113         res->aligned              = align_is_aligned;
114         res->usage                = ir_usage_unknown;
115         res->compiler_gen         = 0;
116         res->visibility           = ir_visibility_default;
117         res->offset               = -1;
118         res->offset_bit_remainder = 0;
119         res->alignment            = 0;
120         res->link                 = NULL;
121         res->repr_class           = NULL;
122
123         if (is_Method_type(type)) {
124                 symconst_symbol sym;
125                 ir_mode *mode = is_Method_type(type) ? mode_P_code : mode_P_data;
126                 sym.entity_p            = res;
127                 rem                     = current_ir_graph;
128                 current_ir_graph        = get_const_code_irg();
129                 set_atomic_ent_value(res, new_SymConst(mode, sym, symconst_addr_ent));
130                 current_ir_graph        = rem;
131                 res->linkage            = IR_LINKAGE_CONSTANT;
132                 res->attr.mtd_attr.irg_add_properties = mtp_property_inherited;
133                 res->attr.mtd_attr.vtable_number      = VTABLE_NUM_NOT_SET;
134                 res->attr.mtd_attr.param_access       = NULL;
135                 res->attr.mtd_attr.param_weight       = NULL;
136                 res->attr.mtd_attr.irg                = NULL;
137         } else if (is_compound_type(type)) {
138                 res->attr.cmpd_attr.values    = NULL;
139                 res->attr.cmpd_attr.val_paths = NULL;
140         } else if (is_code_type(type)) {
141                 res->attr.code_attr.label = (ir_label_t) -1;
142         }
143
144         if (is_Class_type(owner)) {
145                 res->overwrites    = NEW_ARR_F(ir_entity *, 0);
146                 res->overwrittenby = NEW_ARR_F(ir_entity *, 0);
147         } else {
148                 res->overwrites    = NULL;
149                 res->overwrittenby = NULL;
150         }
151
152 #ifdef DEBUG_libfirm
153         res->nr = get_irp_new_node_nr();
154 #endif /* DEBUG_libfirm */
155
156         res->visit = 0;
157         set_entity_dbg_info(res, db);
158
159         return res;
160 }  /* new_rd_entity */
161
162 ir_entity *
163 new_d_entity(ir_type *owner, ident *name, ir_type *type, dbg_info *db) {
164         ir_entity *res;
165
166         assert(is_compound_type(owner));
167         res = new_rd_entity(db, owner, name, type);
168         /* Remember entity in it's owner. */
169         insert_entity_in_owner(res);
170
171         hook_new_entity(res);
172         return res;
173 }  /* new_d_entity */
174
175 ir_entity *
176 new_entity(ir_type *owner, ident *name, ir_type *type) {
177         return new_d_entity(owner, name, type, NULL);
178 }  /* new_entity */
179
180 /**
181  * Free entity attributes.
182  *
183  * @param ent  the entity
184  */
185 static void free_entity_attrs(ir_entity *ent)
186 {
187         int i;
188         if (get_type_tpop(get_entity_owner(ent)) == type_class) {
189                 DEL_ARR_F(ent->overwrites);    ent->overwrites = NULL;
190                 DEL_ARR_F(ent->overwrittenby); ent->overwrittenby = NULL;
191         } else {
192                 assert(ent->overwrites == NULL);
193                 assert(ent->overwrittenby == NULL);
194         }
195         if (ent->initializer != NULL) {
196                 /* TODO: free initializers */
197         } else if (entity_has_compound_ent_values(ent)) {
198                 if (ent->attr.cmpd_attr.val_paths) {
199                         for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i)
200                                 if (ent->attr.cmpd_attr.val_paths[i]) {
201                                         /* free_compound_graph_path(ent->attr.cmpd_attr.val_paths[i]) ;  * @@@ warum nich? */
202                                         /* Geht nich: wird mehrfach verwendet!!! ==> mehrfach frei gegeben. */
203                                         /* DEL_ARR_F(ent->attr.cmpd_attr.val_paths); */
204                                 }
205                                 ent->attr.cmpd_attr.val_paths = NULL;
206                 }
207         }
208         if (is_compound_entity(ent)) {
209                 if (ent->attr.cmpd_attr.values) {
210                         /*DEL_ARR_F(ent->attr.cmpd_attr.values)*/;
211                 }
212                 ent->attr.cmpd_attr.values = NULL;
213         } else if (is_method_entity(ent)) {
214                 if (ent->attr.mtd_attr.param_access) {
215                         DEL_ARR_F(ent->attr.mtd_attr.param_access);
216                         ent->attr.mtd_attr.param_access = NULL;
217                 }
218                 if (ent->attr.mtd_attr.param_weight) {
219                         DEL_ARR_F(ent->attr.mtd_attr.param_weight);
220                         ent->attr.mtd_attr.param_weight = NULL;
221                 }
222         }
223 }  /* free_entity_attrs */
224
225 /**
226  * Creates a deep copy of an entity.
227  */
228 static ir_entity *deep_entity_copy(ir_entity *old)
229 {
230         ir_entity *newe = XMALLOC(ir_entity);
231
232         *newe = *old;
233         if (old->initializer != NULL) {
234                 /* FIXME: the initializers are NOT copied */
235         } else if (entity_has_compound_ent_values(old)) {
236                 newe->attr.cmpd_attr.values    = NULL;
237                 newe->attr.cmpd_attr.val_paths = NULL;
238                 if (old->attr.cmpd_attr.values)
239                         newe->attr.cmpd_attr.values = DUP_ARR_F(ir_node *, old->attr.cmpd_attr.values);
240
241                 /* FIXME: the compound graph paths are NOT copied */
242                 if (old->attr.cmpd_attr.val_paths)
243                         newe->attr.cmpd_attr.val_paths = DUP_ARR_F(compound_graph_path *, old->attr.cmpd_attr.val_paths);
244         } else if (is_method_entity(old)) {
245                 /* do NOT copy them, reanalyze. This might be the best solution */
246                 newe->attr.mtd_attr.param_access = NULL;
247                 newe->attr.mtd_attr.param_weight = NULL;
248         }
249
250 #ifdef DEBUG_libfirm
251         newe->nr = get_irp_new_node_nr();
252 #endif
253         return newe;
254 }
255 /*
256  * Copies the entity if the new_owner is different from the
257  * owner of the old entity,  else returns the old entity.
258  */
259 ir_entity *
260 copy_entity_own(ir_entity *old, ir_type *new_owner) {
261         ir_entity *newe;
262         assert(is_entity(old));
263         assert(is_compound_type(new_owner));
264         assert(get_type_state(new_owner) != layout_fixed);
265
266         if (old->owner == new_owner)
267                 return old;
268
269         /* create a deep copy so we are safe of aliasing and double-freeing. */
270         newe = deep_entity_copy(old);
271         newe->owner = new_owner;
272
273         if (is_Class_type(new_owner)) {
274                 newe->overwrites    = NEW_ARR_F(ir_entity *, 0);
275                 newe->overwrittenby = NEW_ARR_F(ir_entity *, 0);
276         }
277
278         insert_entity_in_owner(newe);
279         return newe;
280 }  /* copy_entity_own */
281
282 ir_entity *
283 copy_entity_name(ir_entity *old, ident *new_name) {
284         ir_entity *newe;
285         assert(old && old->kind == k_entity);
286
287         if (old->name == new_name) return old;
288         newe = deep_entity_copy(old);
289         newe->name = new_name;
290         newe->ld_name = NULL;
291
292         if (is_Class_type(newe->owner)) {
293                 newe->overwrites    = DUP_ARR_F(ir_entity *, old->overwrites);
294                 newe->overwrittenby = DUP_ARR_F(ir_entity *, old->overwrittenby);
295         }
296         insert_entity_in_owner(newe);
297
298         return newe;
299 }  /* copy_entity_name */
300
301 void
302 free_entity(ir_entity *ent) {
303         assert(ent && ent->kind == k_entity);
304         free_entity_attrs(ent);
305         ent->kind = k_BAD;
306         free(ent);
307 }  /* free_entity */
308
309 /* Outputs a unique number for this node */
310 long
311 get_entity_nr(const ir_entity *ent) {
312         assert(ent && ent->kind == k_entity);
313 #ifdef DEBUG_libfirm
314         return ent->nr;
315 #else
316         return (long)PTR_TO_INT(ent);
317 #endif
318 }  /* get_entity_nr */
319
320 const char *
321 (get_entity_name)(const ir_entity *ent) {
322         return _get_entity_name(ent);
323 }
324
325 ident *
326 (get_entity_ident)(const ir_entity *ent) {
327         return _get_entity_ident(ent);
328 }
329
330 void
331 (set_entity_ident)(ir_entity *ent, ident *id) {
332         _set_entity_ident(ent, id);
333 }
334
335 ir_type *
336 (get_entity_owner)(const ir_entity *ent) {
337         return _get_entity_owner(ent);
338 }
339
340 void
341 set_entity_owner(ir_entity *ent, ir_type *owner) {
342         assert(is_entity(ent));
343         assert(is_compound_type(owner));
344         ent->owner = owner;
345 }
346
347 ident *(get_entity_ld_ident)(const ir_entity *ent)
348 {
349         return _get_entity_ld_ident(ent);
350 }
351
352 void
353 (set_entity_ld_ident)(ir_entity *ent, ident *ld_ident) {
354         _set_entity_ld_ident(ent, ld_ident);
355 }
356
357 const char *(get_entity_ld_name)(const ir_entity *ent)
358 {
359         return _get_entity_ld_name(ent);
360 }
361
362 ir_type *
363 (get_entity_type)(const ir_entity *ent) {
364         return _get_entity_type(ent);
365 }
366
367 void
368 (set_entity_type)(ir_entity *ent, ir_type *type) {
369         _set_entity_type(ent, type);
370 }
371
372 ir_volatility
373 (get_entity_volatility)(const ir_entity *ent) {
374         return _get_entity_volatility(ent);
375 }
376
377 void
378 (set_entity_volatility)(ir_entity *ent, ir_volatility vol) {
379         _set_entity_volatility(ent, vol);
380 }
381
382 /* Return the name of the volatility. */
383 const char *get_volatility_name(ir_volatility var)
384 {
385 #define X(a)    case a: return #a
386         switch (var) {
387         X(volatility_non_volatile);
388         X(volatility_is_volatile);
389     default: return "BAD VALUE";
390         }
391 #undef X
392 }  /* get_volatility_name */
393
394 ir_align
395 (get_entity_aligned)(const ir_entity *ent) {
396         return _get_entity_aligned(ent);
397 }
398
399 void
400 (set_entity_aligned)(ir_entity *ent, ir_align a) {
401         _set_entity_aligned(ent, a);
402 }
403
404 unsigned
405 (get_entity_alignment)(const ir_entity *ent) {
406         return _get_entity_alignment(ent);
407 }
408
409 void
410 (set_entity_alignment)(ir_entity *ent, unsigned alignment) {
411         _set_entity_alignment(ent, alignment);
412 }
413
414 /* Return the name of the alignment. */
415 const char *get_align_name(ir_align a)
416 {
417 #define X(a)    case a: return #a
418         switch (a) {
419         X(align_non_aligned);
420         X(align_is_aligned);
421         default: return "BAD VALUE";
422         }
423 #undef X
424 }  /* get_align_name */
425
426 void
427 set_entity_label(ir_entity *ent, ir_label_t label)
428 {
429         ent->attr.code_attr.label = label;
430 }
431
432 ir_label_t get_entity_label(const ir_entity *ent)
433 {
434         return ent->attr.code_attr.label;
435 }
436
437 static void verify_visibility(const ir_entity *entity)
438 {
439         if (get_entity_visibility(entity) == ir_visibility_external
440                         && !is_method_entity(entity)) {
441                 assert(!entity_has_definition(entity));
442         }
443 }
444
445 void set_entity_visibility(ir_entity *entity, ir_visibility visibility)
446 {
447         entity->visibility = visibility;
448         verify_visibility(entity);
449 }
450
451 ir_visibility get_entity_visibility(const ir_entity *entity)
452 {
453         return entity->visibility;
454 }
455
456 void set_entity_linkage(ir_entity *entity, ir_linkage linkage)
457 {
458         entity->linkage = linkage;
459 }
460
461 ir_linkage (get_entity_linkage)(const ir_entity *entity)
462 {
463         return get_entity_linkage(entity);
464 }
465
466 void add_entity_linkage(ir_entity *entity, ir_linkage linkage)
467 {
468         entity->linkage |= linkage;
469 }
470
471 void remove_entity_linkage(ir_entity *entity, ir_linkage linkage)
472 {
473         entity->linkage &= ~linkage;
474 }
475
476 /* Checks if an entity is compiler generated */
477 int (is_entity_compiler_generated)(const ir_entity *ent) {
478         return _is_entity_compiler_generated(ent);
479 }  /* is_entity_compiler_generated */
480
481 /* Sets/resets the compiler generated flag */
482 void (set_entity_compiler_generated)(ir_entity *ent, int flag) {
483         _set_entity_compiler_generated(ent, flag);
484 }  /* set_entity_compiler_generated */
485
486 ir_entity_usage (get_entity_usage)(const ir_entity *ent) {
487         return _get_entity_usage(ent);
488 }
489
490 void (set_entity_usage)(ir_entity *ent, ir_entity_usage flags) {
491         _set_entity_usage(ent, flags);
492 }
493
494 /* Set has no effect for existent entities of type method. */
495 ir_node *get_atomic_ent_value(ir_entity *entity)
496 {
497         ir_initializer_t *initializer = get_entity_initializer(entity);
498
499         assert(entity && is_atomic_entity(entity));
500         if (initializer == NULL) {
501                 ir_type *type = get_entity_type(entity);
502                 return new_r_Unknown(get_const_code_irg(), get_type_mode(type));
503         }
504
505         switch (get_initializer_kind(initializer)) {
506         case IR_INITIALIZER_NULL: {
507                 ir_type *type = get_entity_type(entity);
508                 ir_mode *mode = get_type_mode(type);
509                 return new_r_Const(get_const_code_irg(), get_mode_null(mode));
510         }
511         case IR_INITIALIZER_TARVAL: {
512                 tarval *tv = get_initializer_tarval_value(initializer);
513                 return new_r_Const(get_const_code_irg(), tv);
514         }
515         case IR_INITIALIZER_CONST:
516                 return get_initializer_const_value(initializer);
517         case IR_INITIALIZER_COMPOUND:
518                 panic("compound initializer in atomic entity not allowed (%+F)", entity);
519         }
520
521         panic("invalid initializer kind in get_atomic_ent_value(%+F)", entity);
522 }
523
524 void set_atomic_ent_value(ir_entity *entity, ir_node *val)
525 {
526         ir_initializer_t *initializer;
527
528         assert(is_atomic_entity(entity));
529         assert(get_entity_peculiarity(entity) != peculiarity_description);
530
531         assert(is_Dummy(val) || get_irn_mode(val) == get_type_mode(entity->type));
532         initializer = create_initializer_const(val);
533         entity->initializer = initializer;
534 }
535
536 /* Returns true if the the node is representable as code on
537  *  const_code_irg. */
538 int is_irn_const_expression(ir_node *n) {
539         ir_mode *m;
540
541         /* we are in danger iff an exception will arise. TODO: be more precisely,
542          * for instance Div. will NOT rise if divisor != 0
543          */
544         if (is_binop(n) && !is_fragile_op(n))
545                 return is_irn_const_expression(get_binop_left(n)) && is_irn_const_expression(get_binop_right(n));
546
547         m = get_irn_mode(n);
548         switch (get_irn_opcode(n)) {
549         case iro_Const:
550         case iro_SymConst:
551         case iro_Unknown:
552                 return 1;
553         case iro_Conv:
554         case iro_Cast:
555                 return is_irn_const_expression(get_irn_n(n, 0));
556         default:
557                 break;
558         }
559         return 0;
560 }  /* is_irn_const_expression */
561
562 /*
563  * Copies a firm subgraph that complies to the restrictions for
564  * constant expressions to current_block in current_ir_graph.
565  */
566 ir_node *copy_const_value(dbg_info *dbg, ir_node *n) {
567         ir_node *nn;
568         ir_mode *m;
569
570         /* @@@ GL I think  we should implement this using the routines from irgopt for
571                dead node elimination/inlineing. */
572
573         m = get_irn_mode(n);
574         switch (get_irn_opcode(n)) {
575         case iro_Const:
576                 nn = new_d_Const_type(dbg, get_Const_tarval(n), get_Const_type(n));
577                 break;
578         case iro_SymConst:
579                 nn = new_d_SymConst_type(dbg, get_irn_mode(n), get_SymConst_symbol(n), get_SymConst_kind(n),
580                         get_SymConst_value_type(n));
581                 break;
582         case iro_Add:
583                 nn = new_d_Add(dbg, copy_const_value(dbg, get_Add_left(n)),
584                         copy_const_value(dbg, get_Add_right(n)), m); break;
585         case iro_Sub:
586                 nn = new_d_Sub(dbg, copy_const_value(dbg, get_Sub_left(n)),
587                         copy_const_value(dbg, get_Sub_right(n)), m); break;
588         case iro_Mul:
589                 nn = new_d_Mul(dbg, copy_const_value(dbg, get_Mul_left(n)),
590                         copy_const_value(dbg, get_Mul_right(n)), m); break;
591         case iro_And:
592                 nn = new_d_And(dbg, copy_const_value(dbg, get_And_left(n)),
593                         copy_const_value(dbg, get_And_right(n)), m); break;
594         case iro_Or:
595                 nn = new_d_Or(dbg, copy_const_value(dbg, get_Or_left(n)),
596                         copy_const_value(dbg, get_Or_right(n)), m); break;
597         case iro_Eor:
598                 nn = new_d_Eor(dbg, copy_const_value(dbg, get_Eor_left(n)),
599                         copy_const_value(dbg, get_Eor_right(n)), m); break;
600         case iro_Cast:
601                 nn = new_d_Cast(dbg, copy_const_value(dbg, get_Cast_op(n)), get_Cast_type(n)); break;
602         case iro_Conv:
603                 nn = new_d_Conv(dbg, copy_const_value(dbg, get_Conv_op(n)), m); break;
604         case iro_Unknown:
605                 nn = new_Unknown(m); break;
606         default:
607                 assert(0 && "opcode invalid or not implemented");
608                 nn = NULL;
609                 break;
610         }
611         return nn;
612 }  /* copy_const_value */
613
614 /** Return the name of the initializer kind. */
615 const char *get_initializer_kind_name(ir_initializer_kind_t ini)
616 {
617 #define X(a)    case a: return #a
618         switch (ini) {
619         X(IR_INITIALIZER_CONST);
620         X(IR_INITIALIZER_TARVAL);
621         X(IR_INITIALIZER_NULL);
622         X(IR_INITIALIZER_COMPOUND);
623     default: return "BAD VALUE";
624         }
625 #undef X
626 }
627
628 static ir_initializer_t null_initializer = { IR_INITIALIZER_NULL };
629
630 ir_initializer_t *get_initializer_null(void)
631 {
632         return &null_initializer;
633 }
634
635 ir_initializer_t *create_initializer_const(ir_node *value)
636 {
637         struct obstack *obst = get_irg_obstack(get_const_code_irg());
638
639         ir_initializer_t *initializer
640                 = obstack_alloc(obst, sizeof(ir_initializer_const_t));
641         initializer->kind         = IR_INITIALIZER_CONST;
642         initializer->consti.value = value;
643
644         return initializer;
645 }
646
647 ir_initializer_t *create_initializer_tarval(tarval *tv)
648 {
649         struct obstack *obst = get_irg_obstack(get_const_code_irg());
650
651         ir_initializer_t *initializer
652                 = obstack_alloc(obst, sizeof(ir_initializer_tarval_t));
653         initializer->kind         = IR_INITIALIZER_TARVAL;
654         initializer->tarval.value = tv;
655
656         return initializer;
657 }
658
659 ir_initializer_t *create_initializer_compound(unsigned n_entries)
660 {
661         struct obstack *obst = get_irg_obstack(get_const_code_irg());
662
663         size_t i;
664         size_t size  = sizeof(ir_initializer_compound_t)
665                      + (n_entries-1) * sizeof(ir_initializer_t*);
666
667         ir_initializer_t *initializer = obstack_alloc(obst, size);
668         initializer->kind                    = IR_INITIALIZER_COMPOUND;
669         initializer->compound.n_initializers = n_entries;
670
671         for(i = 0; i < n_entries; ++i) {
672                 initializer->compound.initializers[i] = get_initializer_null();
673         }
674
675         return initializer;
676 }
677
678 ir_node *get_initializer_const_value(const ir_initializer_t *initializer)
679 {
680         assert(initializer->kind == IR_INITIALIZER_CONST);
681         return skip_Id(initializer->consti.value);
682 }
683
684 tarval *get_initializer_tarval_value(const ir_initializer_t *initializer)
685 {
686         assert(initializer->kind == IR_INITIALIZER_TARVAL);
687         return initializer->tarval.value;
688 }
689
690 unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer)
691 {
692         assert(initializer->kind == IR_INITIALIZER_COMPOUND);
693         return initializer->compound.n_initializers;
694 }
695
696 void set_initializer_compound_value(ir_initializer_t *initializer,
697                                     unsigned index, ir_initializer_t *value)
698 {
699         assert(initializer->kind == IR_INITIALIZER_COMPOUND);
700         assert(index < initializer->compound.n_initializers);
701
702         initializer->compound.initializers[index] = value;
703 }
704
705 ir_initializer_t *get_initializer_compound_value(
706                 const ir_initializer_t *initializer, unsigned index)
707 {
708         assert(initializer->kind == IR_INITIALIZER_COMPOUND);
709         assert(index < initializer->compound.n_initializers);
710
711         return initializer->compound.initializers[index];
712 }
713
714 ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer)
715 {
716         return initializer->kind;
717 }
718
719 static void check_entity_initializer(ir_entity *entity)
720 {
721 #ifndef NDEBUG
722         ir_initializer_t *initializer = entity->initializer;
723         switch (initializer->kind) {
724         case IR_INITIALIZER_COMPOUND:
725                 assert(is_compound_entity(entity));
726                 break;
727         case IR_INITIALIZER_CONST:
728         case IR_INITIALIZER_TARVAL:
729                 assert(is_atomic_entity(entity));
730                 break;
731         case IR_INITIALIZER_NULL:
732                 break;
733         }
734 #endif
735 }
736
737 void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer)
738 {
739         entity->initializer = initializer;
740         check_entity_initializer(entity);
741 }
742
743 int has_entity_initializer(const ir_entity *entity)
744 {
745         return entity->initializer != NULL;
746 }
747
748 ir_initializer_t *get_entity_initializer(const ir_entity *entity)
749 {
750         return entity->initializer;
751 }
752
753 int (get_entity_offset)(const ir_entity *ent)
754 {
755         return _get_entity_offset(ent);
756 }
757
758 void (set_entity_offset)(ir_entity *ent, int offset)
759 {
760         _set_entity_offset(ent, offset);
761 }
762
763 unsigned char (get_entity_offset_bits_remainder)(const ir_entity *ent)
764 {
765         return _get_entity_offset_bits_remainder(ent);
766 }
767
768 void (set_entity_offset_bits_remainder)(ir_entity *ent, unsigned char offset)
769 {
770         _set_entity_offset_bits_remainder(ent, offset);
771 }
772
773 void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten)
774 {
775 #ifndef NDEBUG
776         ir_type *owner     = get_entity_owner(ent);
777         ir_type *ovw_ovner = get_entity_owner(overwritten);
778         assert(is_Class_type(owner));
779         assert(is_Class_type(ovw_ovner));
780         assert(! is_class_final(ovw_ovner));
781 #endif /* NDEBUG */
782         ARR_APP1(ir_entity *, ent->overwrites, overwritten);
783         ARR_APP1(ir_entity *, overwritten->overwrittenby, ent);
784 }
785
786 int get_entity_n_overwrites(const ir_entity *ent)
787 {
788         assert(is_Class_type(get_entity_owner(ent)));
789         return (ARR_LEN(ent->overwrites));
790 }
791
792 int get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten)
793 {
794         int i, n;
795         assert(is_Class_type(get_entity_owner(ent)));
796         n = get_entity_n_overwrites(ent);
797         for (i = 0; i < n; ++i) {
798                 if (get_entity_overwrites(ent, i) == overwritten)
799                         return i;
800         }
801         return -1;
802 }
803
804 ir_entity *get_entity_overwrites(const ir_entity *ent, int pos)
805 {
806         assert(is_Class_type(get_entity_owner(ent)));
807         assert(pos < get_entity_n_overwrites(ent));
808         return ent->overwrites[pos];
809 }
810
811 void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten)
812 {
813         assert(is_Class_type(get_entity_owner(ent)));
814         assert(pos < get_entity_n_overwrites(ent));
815         ent->overwrites[pos] = overwritten;
816 }
817
818 void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten)
819 {
820         int i, n;
821         assert(is_Class_type(get_entity_owner(ent)));
822         n = ARR_LEN(ent->overwrites);
823         for (i = 0; i < n; ++i) {
824                 if (ent->overwrites[i] == overwritten) {
825                         for (; i < n - 1; i++)
826                                 ent->overwrites[i] = ent->overwrites[i+1];
827                         ARR_SETLEN(ir_entity*, ent->overwrites, n - 1);
828                         break;
829                 }
830         }
831 }
832
833 void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites)
834 {
835         add_entity_overwrites(overwrites, ent);
836 }
837
838 int get_entity_n_overwrittenby(const ir_entity *ent)
839 {
840         assert(is_Class_type(get_entity_owner(ent)));
841         return ARR_LEN(ent->overwrittenby);
842 }
843
844 int get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites)
845 {
846         int i, n;
847         assert(is_Class_type(get_entity_owner(ent)));
848         n = get_entity_n_overwrittenby(ent);
849         for (i = 0; i < n; ++i) {
850                 if (get_entity_overwrittenby(ent, i) == overwrites)
851                         return i;
852         }
853         return -1;
854 }
855
856 ir_entity *get_entity_overwrittenby(const ir_entity *ent, int pos)
857 {
858         assert(is_Class_type(get_entity_owner(ent)));
859         assert(pos < get_entity_n_overwrittenby(ent));
860         return ent->overwrittenby[pos];
861 }
862
863 void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites)
864 {
865         assert(is_Class_type(get_entity_owner(ent)));
866         assert(pos < get_entity_n_overwrittenby(ent));
867         ent->overwrittenby[pos] = overwrites;
868 }
869
870 void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites)
871 {
872         int i, n;
873         assert(is_Class_type(get_entity_owner(ent)));
874
875         n = ARR_LEN(ent->overwrittenby);
876         for (i = 0; i < n; ++i) {
877                 if (ent->overwrittenby[i] == overwrites) {
878                         for(; i < n - 1; ++i)
879                                 ent->overwrittenby[i] = ent->overwrittenby[i+1];
880                         ARR_SETLEN(ir_entity*, ent->overwrittenby, n - 1);
881                         break;
882                 }
883         }
884 }
885
886 void *(get_entity_link)(const ir_entity *ent)
887 {
888         return _get_entity_link(ent);
889 }
890
891 void (set_entity_link)(ir_entity *ent, void *l)
892 {
893         _set_entity_link(ent, l);
894 }
895
896 ir_graph *(get_entity_irg)(const ir_entity *ent)
897 {
898         return _get_entity_irg(ent);
899 }
900
901 void set_entity_irg(ir_entity *ent, ir_graph *irg)
902 {
903         assert(is_method_entity(ent));
904         assert(get_entity_peculiarity(ent) == peculiarity_existent);
905         ent->attr.mtd_attr.irg = irg;
906 }
907
908 unsigned get_entity_vtable_number(const ir_entity *ent)
909 {
910         assert(is_method_entity((ir_entity *)ent));
911         return ent->attr.mtd_attr.vtable_number;
912 }
913
914 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number)
915 {
916         assert(is_method_entity(ent));
917         ent->attr.mtd_attr.vtable_number = vtable_number;
918 }
919
920 int (is_entity)(const void *thing)
921 {
922         return _is_entity(thing);
923 }
924
925 int is_atomic_entity(const ir_entity *ent)
926 {
927         ir_type *t      = get_entity_type(ent);
928         const tp_op *op = get_type_tpop(t);
929         return (op == type_primitive || op == type_pointer ||
930                 op == type_enumeration || op == type_method);
931 }
932
933 int is_compound_entity(const ir_entity *ent)
934 {
935         ir_type     *t  = get_entity_type(ent);
936         const tp_op *op = get_type_tpop(t);
937         return (op == type_class || op == type_struct ||
938                 op == type_array || op == type_union);
939 }
940
941 int is_method_entity(const ir_entity *ent)
942 {
943         ir_type *t = get_entity_type(ent);
944         return is_Method_type(t);
945 }
946
947 ir_visited_t (get_entity_visited)(const ir_entity *ent)
948 {
949         return _get_entity_visited(ent);
950 }
951
952 void (set_entity_visited)(ir_entity *ent, ir_visited_t num)
953 {
954         _set_entity_visited(ent, num);
955 }
956
957 void (mark_entity_visited)(ir_entity *ent)
958 {
959         _mark_entity_visited(ent);
960 }
961
962 int (entity_visited)(const ir_entity *ent)
963 {
964         return _entity_visited(ent);
965 }
966
967 int (entity_not_visited)(const ir_entity *ent)
968 {
969         return _entity_not_visited(ent);
970 }
971
972 unsigned get_entity_additional_properties(const ir_entity *ent)
973 {
974         ir_graph *irg;
975
976         assert(is_method_entity(ent));
977
978         /* first check, if the graph has additional properties */
979         irg = get_entity_irg(ent);
980
981         if (irg)
982                 return get_irg_additional_properties(irg);
983
984         if (ent->attr.mtd_attr.irg_add_properties & mtp_property_inherited)
985                 return get_method_additional_properties(get_entity_type(ent));
986
987         return ent->attr.mtd_attr.irg_add_properties;
988 }
989
990 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask)
991 {
992         ir_graph *irg;
993
994         assert(is_method_entity(ent));
995
996         /* first check, if the graph exists */
997         irg = get_entity_irg(ent);
998         if (irg)
999                 set_irg_additional_properties(irg, property_mask);
1000         else {
1001     /* do not allow to set the mtp_property_inherited flag or
1002                 * the automatic inheritance of flags will not work */
1003                 ent->attr.mtd_attr.irg_add_properties = property_mask & ~mtp_property_inherited;
1004         }
1005 }
1006
1007 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag)
1008 {
1009         ir_graph *irg;
1010
1011         assert(is_method_entity(ent));
1012
1013         /* first check, if the graph exists */
1014         irg = get_entity_irg(ent);
1015         if (irg)
1016                 set_irg_additional_property(irg, flag);
1017         else {
1018                 unsigned mask = ent->attr.mtd_attr.irg_add_properties;
1019
1020                 if (mask & mtp_property_inherited)
1021                         mask = get_method_additional_properties(get_entity_type(ent));
1022
1023                         /* do not allow to set the mtp_property_inherited flag or
1024                 * the automatic inheritance of flags will not work */
1025                 ent->attr.mtd_attr.irg_add_properties = mask | (flag & ~mtp_property_inherited);
1026         }
1027 }
1028
1029 /* Returns the class type that this type info entity represents or NULL
1030    if ent is no type info entity. */
1031 ir_type *(get_entity_repr_class)(const ir_entity *ent)
1032 {
1033         return _get_entity_repr_class(ent);
1034 }
1035
1036 dbg_info *(get_entity_dbg_info)(const ir_entity *ent)
1037 {
1038         return _get_entity_dbg_info(ent);
1039 }
1040
1041 void (set_entity_dbg_info)(ir_entity *ent, dbg_info *db)
1042 {
1043         _set_entity_dbg_info(ent, db);
1044 }
1045
1046 int entity_is_externally_visible(const ir_entity *entity)
1047 {
1048         return get_entity_visibility(entity) != ir_visibility_local
1049                 || (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER);
1050 }
1051
1052 int entity_has_definition(const ir_entity *entity)
1053 {
1054         return entity->initializer != NULL
1055                 || get_entity_irg(entity) != NULL
1056                 || entity_has_compound_ent_values(entity);
1057 }
1058
1059 void firm_init_entity(void)
1060 {
1061         symconst_symbol sym;
1062
1063         assert(firm_unknown_type && "Call init_type() before firm_init_entity()!");
1064         assert(!unknown_entity && "Call firm_init_entity() only once!");
1065
1066         unknown_entity = new_rd_entity(NULL, firm_unknown_type, new_id_from_str(UNKNOWN_ENTITY_NAME), firm_unknown_type);
1067         set_entity_visibility(unknown_entity, ir_visibility_external);
1068
1069         set_entity_ld_ident(unknown_entity, get_entity_ident(unknown_entity));
1070
1071         current_ir_graph = get_const_code_irg();
1072         sym.entity_p     = unknown_entity;
1073 }
1074
1075 ir_allocation get_entity_allocation(const ir_entity *entity)
1076 {
1077         return entity->allocation;
1078 }
1079
1080 void set_entity_allocation(ir_entity *entity, ir_allocation allocation)
1081 {
1082         entity->allocation = allocation;
1083 }
1084
1085 ir_peculiarity get_entity_peculiarity(const ir_entity *entity)
1086 {
1087         return entity->peculiarity;
1088 }
1089
1090 void set_entity_peculiarity(ir_entity *entity, ir_peculiarity peculiarity)
1091 {
1092         entity->peculiarity = peculiarity;
1093 }
1094
1095 void set_entity_final(ir_entity *entity, int final)
1096 {
1097         entity->final = final;
1098 }
1099
1100 int is_entity_final(const ir_entity *entity)
1101 {
1102         return entity->final;
1103 }