syntactic changes for jni generator / crecoder
[libfirm] / ir / tr / entity.c
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
3 **
4 ** Authors: Martin Trapp, Christian Schaefer
5 **
6 */
7
8 /* $Id$ */
9
10 #ifdef HAVE_CONFIG_H
11 # include <config.h>
12 #endif
13
14 # include <stdlib.h>
15 # include <stddef.h>
16 # include <string.h>
17
18 # include "entity_t.h"
19 # include "mangle.h"
20 # include "typegmod_t.h"
21 # include "array.h"
22 /* All this is needed to build the constant node for methods: */
23 # include "irprog.h"
24 # include "ircons.h"
25
26 /*******************************************************************/
27 /** general                                                       **/
28 /*******************************************************************/
29
30 void
31 init_entity (void)
32 {
33 }
34
35 /*******************************************************************/
36 /** ENTITY                                                        **/
37 /*******************************************************************/
38
39 INLINE type *get_entity_owner (entity *ent);
40
41 INLINE void insert_entity_in_owner (entity *ent) {
42   type *owner = ent->owner;
43   switch (get_type_tpop_code(owner)) {
44   case tpo_class: {
45     add_class_member (owner, ent);
46   } break;
47   case tpo_struct: {
48     add_struct_member (owner, ent);
49   } break;
50   case tpo_union: {
51     add_union_member (owner, ent);
52   } break;
53   case tpo_array: {
54     set_array_element_entity(owner, ent);
55   } break;
56   default: assert(0);
57   }
58 }
59
60 entity *
61 new_entity (type *owner, ident *name, type *type)
62 {
63   entity *res;
64   ir_graph *rem;
65
66   res = (entity *) malloc (sizeof (entity));
67   res->kind = k_entity;
68   assert_legal_owner_of_ent(owner);
69   res->owner = owner;
70   res->name = name;
71   res->type = type;
72   if (get_type_tpop(type) == type_method)
73     res->allocation = static_allocated;
74   else
75     res->allocation = automatic_allocated;
76   res->visibility = local;
77   res->offset = -1;
78   if (is_method_type(type)) {
79     res->variability = constant;
80     rem = current_ir_graph;
81     current_ir_graph = get_const_code_irg();
82     res->value = new_Const(mode_p, tarval_p_from_entity(res));
83     current_ir_graph = rem;
84   } else {
85     res->variability = uninitialized;
86   }
87   res->peculiarity = existent;
88   res->volatility = non_volatile;
89   res->ld_name = NULL;
90   res->overwrites = NEW_ARR_F(entity *, 1);
91   res->overwrittenby = NEW_ARR_F(entity *, 1);
92
93   res->irg = NULL;
94
95   res->visit = 0;
96
97   /* Remember entity in it's owner. */
98   insert_entity_in_owner (res);
99   return res;
100 }
101 entity *
102 new_d_entity (type *owner, ident *name, type *type, dbg_info *db) {
103   entity *res = new_entity(owner, name, type);
104   set_entity_dbg_info(res, db);
105   return res;
106 }
107 INLINE void free_entity_attrs(entity *ent) {
108   assert(ent);
109   if (get_type_tpop(get_entity_owner(ent)) == type_class) {
110     DEL_ARR_F(ent->overwrites);
111     DEL_ARR_F(ent->overwrittenby);
112   }
113 }
114
115 entity *
116 copy_entity_own (entity *old, type *new_owner) {
117   entity *new;
118
119   assert_legal_owner_of_ent(new_owner);
120   if (old->owner == new_owner) return old;
121   new = (entity *) malloc (sizeof (entity));
122   memcpy (new, old, sizeof (entity));
123   new->owner = new_owner;
124   if ((get_type_tpop(get_entity_owner(old)) == type_class) &&
125       (get_type_tpop(new_owner) == type_class)) {
126     new->overwrites = DUP_ARR_F(entity *, old->overwrites);
127     new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
128   } else if ((get_type_tpop(get_entity_owner(old)) != type_class) &&
129              (get_type_tpop(new_owner) == type_class)) {
130     new->overwrites = NEW_ARR_F(entity *, 1);
131     new->overwrittenby = NEW_ARR_F(entity *, 1);
132   }
133
134   insert_entity_in_owner (new);
135
136   return new;
137 }
138
139 entity *
140 copy_entity_name (entity *old, ident *new_name) {
141   entity *new;
142
143   if (old->name == new_name) return old;
144   new = (entity *) malloc (sizeof (entity));
145   memcpy (new, old, sizeof (entity));
146   new->name = new_name;
147   new->ld_name = NULL;
148   new->overwrites = DUP_ARR_F(entity *, old->overwrites);
149   new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
150
151   insert_entity_in_owner (new);
152
153   return new;
154 }
155
156 void
157 free_entity (entity *ent) {
158   free_entity_attrs(ent);
159   free(ent);
160 }
161
162 INLINE const char *
163 get_entity_name (entity *ent) {
164   assert (ent);
165   return id_to_str(get_entity_ident(ent));
166 }
167
168 ident *
169 get_entity_ident    (entity *ent) {
170   assert(ent);
171   return ent->name;
172 }
173
174 /*
175 void   set_entitye_ld_name  (entity *, char *ld_name);
176 void   set_entity_ld_ident (entity *, ident *ld_ident);
177 */
178
179 INLINE type *
180 get_entity_owner (entity *ent) {
181   return ent->owner = skip_tid(ent->owner);
182 }
183
184 INLINE void
185 set_entity_owner (entity *ent, type *owner) {
186   assert_legal_owner_of_ent(owner);
187   ent->owner = owner;
188 }
189
190 INLINE void   /* should this go into type.c? */
191 assert_legal_owner_of_ent(type *owner) {
192   assert (get_type_tpop_code(owner) == tpo_class ||
193           get_type_tpop_code(owner) == tpo_union ||
194           get_type_tpop_code(owner) == tpo_struct ||
195           get_type_tpop_code(owner) == tpo_array);   /* Yes, array has an entity
196                                                         -- to select fields! */
197 }
198
199 INLINE ident *
200 get_entity_ld_ident (entity *ent)
201 {
202   if (ent->ld_name == NULL)
203     ent->ld_name = mangle_entity (ent);
204   return ent->ld_name;
205 }
206
207 INLINE void
208 set_entity_ld_ident (entity *ent, ident *ld_ident) {
209   ent->ld_name = ld_ident;
210 }
211
212 INLINE const char *
213 get_entity_ld_name (entity *ent) {
214   return id_to_str(get_entity_ld_ident(ent));
215 }
216
217 /*
218 char  *get_entity_ld_name  (entity *);
219 void   set_entity_ld_name  (entity *, char *ld_name);
220 */
221
222 INLINE type *
223 get_entity_type (entity *ent) {
224   return ent->type = skip_tid(ent->type);
225 }
226
227 INLINE void
228 set_entity_type (entity *ent, type *type) {
229   ent->type = type;
230 }
231
232
233 INLINE ent_allocation
234 get_entity_allocation (entity *ent) {
235   return ent->allocation;
236 }
237
238 INLINE void
239 set_entity_allocation (entity *ent, ent_allocation al) {
240   ent->allocation = al;
241 }
242
243
244 INLINE ent_visibility
245 get_entity_visibility (entity *ent) {
246   return ent->visibility;
247 }
248
249 INLINE void
250 set_entity_visibility (entity *ent, ent_visibility vis) {
251   if (vis != local) assert(ent->allocation == static_allocated);
252   ent->visibility = vis;
253 }
254
255 INLINE ent_variability
256 get_entity_variability (entity *ent) {
257   return ent->variability;
258 }
259
260 INLINE void
261 set_entity_variability (entity *ent, ent_variability var){
262   if (var == part_constant)
263     assert(is_class_type(ent->type) || is_struct_type(ent->type));
264   if ((is_compound_type(ent->type)) &&
265       (ent->variability == uninitialized) && (var != uninitialized)) {
266     /* Allocate datastructures for constant values */
267     ent->values = NEW_ARR_F(ir_node *, 1);
268     ent->val_ents = NEW_ARR_F(entity *, 1);
269   }
270   if ((is_compound_type(ent->type)) &&
271       (var == uninitialized) && (ent->variability != uninitialized)) {
272     /* Free datastructures for constant values */
273     DEL_ARR_F(ent->values);
274     DEL_ARR_F(ent->val_ents);
275   }
276   ent->variability = var;
277 }
278
279
280 INLINE ent_volatility
281 get_entity_volatility (entity *ent) {
282   assert (ent);
283   return ent->volatility;
284 }
285
286 INLINE void
287 set_entity_volatility (entity *ent, ent_volatility vol) {
288   assert (ent);
289   ent->volatility = vol;
290 }
291
292 INLINE peculiarity
293 get_entity_peculiarity (entity *ent) {
294   assert (ent);
295   return ent->peculiarity;
296 }
297
298 INLINE void
299 set_entity_peculiarity (entity *ent, peculiarity pec) {
300   assert (ent);
301   /* @@@ why peculiarity only for methods? */
302   assert (is_method_type(ent->type));
303   ent->peculiarity = pec;
304 }
305
306 /* Set has no effect for entities of type method. */
307 INLINE ir_node *
308 get_atomic_ent_value(entity *ent) {
309   assert(ent); assert(is_atomic_entity(ent));
310   assert((ent->variability != uninitialized));
311   return ent->value;
312 }
313
314 INLINE void
315 set_atomic_ent_value(entity *ent, ir_node *val) {
316   assert(ent && is_atomic_entity(ent) && (ent->variability != uninitialized));
317   if (is_method_type(ent->type)) return;
318   ent->value = val;
319 }
320
321
322 ir_node *copy_const_value(ir_node *n) {
323   ir_node *nn;
324   ir_mode *m;
325
326   m = get_irn_mode(n);
327   switch(get_irn_opcode(n)) {
328   case iro_Const:
329     nn = new_Const(m, get_Const_tarval(n)); break;
330   case iro_SymConst:
331     nn = new_SymConst(get_SymConst_type_or_id(n), get_SymConst_kind(n)); break;
332   case iro_Add:
333     nn = new_Add(copy_const_value(get_Add_left(n)), copy_const_value(get_Add_right(n)), m); break;
334   default:
335     assert(0 && "opdope invalid or not implemented"); break;
336   }
337   return nn;
338 }
339
340 /* A value of a compound entity is a pair of value and the corresponding member of
341    the compound. */
342 INLINE void
343 add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
344   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
345   ARR_APP1 (ir_node *, ent->values, val);
346   ARR_APP1 (entity *, ent->val_ents, member);
347 }
348
349 /* Copies the firm subgraph referenced by val to const_code_irg and adds
350    the node as constant initialization to ent.
351    The subgraph may not contain control flow operations.
352 INLINE void
353 copy_and_add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
354   ir_graph *rem = current_ir_graph;
355
356   assert(get_entity_variability(ent) != uninitialized);
357   current_ir_graph = get_const_code_irg();
358
359   val = copy_const_value(val);
360   add_compound_ent_value(ent, val, member);
361   current_ir_graph = rem;
362   }*/
363
364 INLINE int
365 get_compound_ent_n_values(entity *ent) {
366   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
367   return (ARR_LEN (ent->values))-1;
368 }
369
370 INLINE ir_node  *
371 get_compound_ent_value(entity *ent, int pos) {
372   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
373   return ent->values[pos+1];
374 }
375
376 /* Copies the value i of the entity to current_block in current_ir_graph.
377 ir_node *
378 copy_compound_ent_value(entity *ent, int pos) {
379   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
380   return copy_const_value(ent->values[pos+1]);
381   }*/
382
383 INLINE entity   *
384 get_compound_ent_value_member(entity *ent, int pos) {
385   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
386   return ent->val_ents[pos+1];
387 }
388
389 INLINE void
390 set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos) {
391   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
392   ent->values[pos+1] = val;
393   ent->val_ents[pos+1] = member;
394 }
395
396 void
397 remove_compound_ent_value(entity *ent, entity *value_ent) {
398   int i;
399   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
400   for (i = 1; i < (ARR_LEN (ent->val_ents)); i++) {
401     if (ent->val_ents[i] == value_ent) {
402       for(; i < (ARR_LEN (ent->val_ents))-1; i++) {
403         ent->val_ents[i] = ent->val_ents[i+1];
404         ent->values[i]   = ent->values[i+1];
405       }
406       ARR_SETLEN(entity*,  ent->val_ents, ARR_LEN(ent->val_ents) - 1);
407       ARR_SETLEN(ir_node*, ent->values,   ARR_LEN(ent->values) - 1);
408       break;
409     }
410   }
411 }
412
413 void
414 set_array_entity_values(entity *ent, tarval **values, int num_vals) {
415   int i;
416   ir_graph *rem = current_ir_graph;
417   type *arrtp = get_entity_type(ent);
418   ir_node *val;
419
420   assert(is_array_type(arrtp));
421   assert(get_array_n_dimensions(arrtp) == 1);
422   /* One bound is sufficient, the nunmber of constant fields makes the
423      size. */
424   assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
425   assert(get_entity_variability(ent) != uninitialized);
426   current_ir_graph = get_const_code_irg();
427
428   for (i = 0; i < num_vals; i++) {
429     val = new_Const(get_tv_mode (values[i]), values[i]);
430     add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
431   }
432   current_ir_graph = rem;
433 }
434
435 INLINE int
436 get_entity_offset (entity *ent) {
437   return ent->offset;
438 }
439
440 INLINE void
441 set_entity_offset (entity *ent, int offset) {
442   ent->offset = offset;
443 }
444
445 INLINE void
446 add_entity_overwrites   (entity *ent, entity *overwritten) {
447   assert(ent);
448   assert(is_class_type(get_entity_owner(ent)));
449   ARR_APP1 (entity *, ent->overwrites, overwritten);
450   ARR_APP1 (entity *, overwritten->overwrittenby, ent);
451 }
452
453 INLINE int
454 get_entity_n_overwrites (entity *ent) {
455   assert(ent);
456   assert(is_class_type(get_entity_owner(ent)));
457   return (ARR_LEN (ent->overwrites))-1;
458 }
459
460 INLINE entity *
461 get_entity_overwrites   (entity *ent, int pos) {
462   assert(ent);
463   assert(is_class_type(get_entity_owner(ent)));
464   assert(pos < get_entity_n_overwrites(ent));
465   return ent->overwrites[pos+1];
466 }
467
468 INLINE void
469 set_entity_overwrites   (entity *ent, int pos, entity *overwritten) {
470   assert(ent);
471   assert(is_class_type(get_entity_owner(ent)));
472   assert(pos < get_entity_n_overwrites(ent));
473   ent->overwrites[pos+1] = overwritten;
474 }
475
476 INLINE void
477 add_entity_overwrittenby   (entity *ent, entity *overwrites) {
478   assert(ent);
479   assert(is_class_type(get_entity_owner(ent)));
480   add_entity_overwrites(overwrites, ent);
481 }
482
483 INLINE int
484 get_entity_n_overwrittenby (entity *ent) {
485   assert(ent);
486   assert(is_class_type(get_entity_owner(ent)));
487   return (ARR_LEN (ent->overwrittenby))-1;
488 }
489
490 INLINE entity *
491 get_entity_overwrittenby   (entity *ent, int pos) {
492   assert(ent);
493   assert(is_class_type(get_entity_owner(ent)));
494   assert(pos < get_entity_n_overwrittenby(ent));
495   return ent->overwrittenby[pos+1];
496 }
497
498 INLINE void
499 set_entity_overwrittenby   (entity *ent, int pos, entity *overwrites) {
500   assert(ent);
501   assert(is_class_type(get_entity_owner(ent)));
502   assert(pos < get_entity_n_overwrittenby(ent));
503   ent->overwrittenby[pos+1] = overwrites;
504 }
505
506 /* A link to store intermediate information */
507 void *
508 get_entity_link(entity *ent) {
509   assert(ent);
510   return ent->link;
511 }
512
513 void
514 set_entity_link(entity *ent, void *l) {
515   assert(ent);
516   ent->link = l;
517 }
518
519 INLINE ir_graph *
520 get_entity_irg(entity *ent) {
521   assert (ent);
522   assert (is_method_type(ent->type));
523   return ent->irg;
524 }
525
526 INLINE void
527 set_entity_irg(entity *ent, ir_graph *irg) {
528   assert (ent && ent->type);
529   /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
530    * Methode selbst nicht mehr aufgerufen werden kann, die Entität
531    * aber erhalten bleiben soll. */
532   /* assert (irg); */
533   assert (is_method_type(ent->type));
534   assert (ent->peculiarity == existent);
535   ent->irg = irg;
536 }
537
538 int is_atomic_entity(entity *ent) {
539   type* t = get_entity_type(ent);
540   return (is_primitive_type(t) || is_pointer_type(t) ||
541           is_enumeration_type(t) || is_method_type(t));
542 }
543
544 int is_compound_entity(entity *ent) {
545   type* t = get_entity_type(ent);
546   return (is_class_type(t) || is_struct_type(t) ||
547           is_array_type(t) || is_union_type(t));
548 }
549
550 bool equal_entity(entity *ent1, entity *ent2) {
551   return true;
552 }
553
554
555 unsigned long get_entity_visited(entity *ent) {
556   assert (ent);
557   return ent->visit;
558 }
559 void        set_entity_visited(entity *ent, unsigned long num) {
560   assert (ent);
561   ent->visit = num;
562 }
563 /* Sets visited field in entity to entity_visited. */
564 void        mark_entity_visited(entity *ent) {
565   assert (ent);
566   ent->visit = type_visited;
567 }