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