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