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