typerep.h 95.3 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */
yb9976's avatar
yb9976 committed
19
20
21

/**
 * @file
22
 * @brief Declarations for functions and datastructures to represent types
yb9976's avatar
yb9976 committed
23
 */
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

#include "firm_types.h"

/**
 * @page entity       Entity representation
 *
 * An entity is the representation of program known objects in Firm.
 * The primary concept of entities is to represent members of complex
 * types, i.e., fields and methods of classes.  As not all programming
 * language model all variables and methods as members of some class,
 * the concept of entities is extended to cover also local and global
 * variables, and arbitrary procedures.
 *
 * An entity always specifies the type of the object it represents and
 * the type of the object it is a part of, the owner of the entity.
 * Originally this is the type of the class of which the entity is a
 * member.
 * The owner of local variables is the procedure they are defined in.
 * The owner of global variables and procedures visible in the whole
 * program is a universally defined class type "GlobalType".  The owner
 * of procedures defined in the scope of an other procedure is the
 * enclosing procedure.
 *
 * The type ir_entity is an abstract data type to represent program entities.
 * If contains the following attributes:
 *
 *   - owner:      A compound type this entity is a part of.
 *   - type:       The type of this entity.
Christoph Mallon's avatar
Christoph Mallon committed
54
55
56
 *   - name:       The string that represents this entity in the source program.
 *   - allocation: A flag saying whether the entity is dynamically or statically
 *                 allocated (values: dynamic_allocated,  static_allocated,
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 *                 automatic_allocated).
 *   - visibility: A flag indicating the visibility of this entity (values: local,
 *                 external_visible,  external_allocated)
 *   - variability: A flag indicating the variability of this entity (values:
 *                  uninitialized, initialized, part_constant, constant)
 *   - volatility: @@@
 *   - offset:     The offset of the entity within the compound object in bytes.  Only set
 *                 if the owner in the state "layout_fixed".
 *   - offset_bits_remainder:   The offset bit remainder of a bitfield entity (in a compound)
 *                 in bits.  Only set if the owner in the state "layout_fixed".
 *   - overwrites: A list of entities overwritten by this entity.  This list is only
 *                 existent if the owner of this entity is a class.  The members in
 *                 this list must be entities of super classes.
 *   - overwrittenby: A list of entities that overwrite this entity.  This list is only
 *                 existent if the owner of this entity is a class.  The members in
 *                 this list must be entities of sub classes.
 *   - link:       A void* to associate some additional information with the entity.
 *   - irg:        If the entity is a method this is the ir graph that represents the
 *                 code of the method.
 *   - peculiarity: The peculiarity of the entity.  If the entity is a method this
 *                 indicates whether the entity represents
 *                 a real method or whether it only exists to describe an interface.
 *                 In that case there nowhere exists code for this entity and this entity
 *                 is never dynamically used in the code.
 *                 Values: description, existent.  Default: existent.
 *   - visited:    visited flag.  Master flag is type_visited.
 *
 * These fields can only be accessed via access functions.
 *
 * @see  ir_type, ir_entity
 */

/** This enumeration flags the visibility of entities and types.
 *
 * This is necessary for partial compilation.
 * We rely on the ordering of the flags.
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
	visibility_local,              /**< The entity is only visible locally.  This is the default for
	                                    entities.
	                                    The type is only visible locally.  All instances are allocated
	                                    locally, and no pointer to entities of this type are passed
	                                    out of this compilation unit. */
	visibility_external_visible,   /**< The entity is visible to other external program parts, but
	                                    it is defined here.  It may not be optimized away.  The entity must
	                                    be static_allocated.
	                                    For types:  entities of this type can be accessed externally.  No
	                                    instances of this type are allocated externally.  */
	visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
	                                    must not allocate memory for this entity. The entity must
	                                    be static_allocated.  This can also be an external defined
	                                    method.
	                                    For types:  entities of this type are allocated and accessed from
	                                    external code.  Default for types.  */
111
112
113
114
} ir_visibility;

/** This enumeration flags the peculiarity of entities and types. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
115
116
117
118
119
120
121
122
123
124
125
126
127
	peculiarity_description,     /**< Represents only a description.  The entity/type is never
	                          allocated, no code/data exists for this entity/type.
	                      @@@ eventually rename to descriptive (adjective as the others!)*/
	peculiarity_inherited,       /**< Describes explicitly that other entities are
	                          inherited to the owner of this entity.
	                          Overwrites must refer to at least one other
	                          entity.  If this is a method entity there exists
	                          no irg for this entity, only for one of the
	                          overwritten ones.
	                      Only for entity. */
	peculiarity_existent         /**< The entity/type (can) exist.
	                  @@@ eventually rename to 'real' i.e., 'echt'
	                      This serves better as opposition to description _and_ inherited.*/
128
129
130
131
132
133
134
135
136
137
138
} ir_peculiarity;

/**
 * Creates a new entity.
 *
 * Automatically inserts the entity as a member of owner.
 * Entity is automatic_allocated and uninitialized except if the type
 * is type_method, then it is static_allocated and constant.  The constant
 * value is a pointer to the method.
 * Visibility is local, offset -1, and it is not volatile.
 */
Michael Beck's avatar
Michael Beck committed
139
ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
140
141
142
143
144
145
146
147
148
149

/**
 * Creates a new entity.
 *
 * Automatically inserts the entity as a member of owner.
 * The entity is automatic allocated and uninitialized except if the type
 * is type_method, then it is static allocated and constant.  The constant
 * value is a pointer to the method.
 * Visibility is local, offset -1, and it is not volatile.
 */
Michael Beck's avatar
Michael Beck committed
150
ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
151
152
153
154
155
156
157
158
159
160
161
162
163

/**
 * Copies the entity if the new_owner is different from the
 * owner of the old entity,  else returns the old entity.
 *
 * Automatically inserts the new entity as a member of owner.
 * Resets the overwrites/overwritten_by fields.
 * Keeps the old atomic value.
 *   @@@ Maybe we should change this.  If peculiarity of a method
 *       is existent, we should add a new SymConst that points to
 *       itself and not to the origin.  Right now we have to change
 *       the peculiarity and then set a new atomic value by hand.
 */
Michael Beck's avatar
Michael Beck committed
164
ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
165
166
167
168
169
170
171
172
173

/**
 * Copies the entity if the new_name is different from the
 * name of the old entity, else returns the old entity.
 *
 * Automatically inserts the new entity as a member of owner.
 * The mangled name ld_name is set to NULL.
 * Overwrites relation is copied from old.
 */
Michael Beck's avatar
Michael Beck committed
174
ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
175
176
177
178
179
180
181

/**
 * Frees the entity.
 *
 * The owner will still contain the pointer to this
 * entity, as well as all other references!
 */
Michael Beck's avatar
Michael Beck committed
182
void free_entity(ir_entity *ent);
183
184
185
186
187

/** Returns the name of an entity. */
const char *get_entity_name(const ir_entity *ent);

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
188
ident *get_entity_ident(const ir_entity *ent);
189
190

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
191
void set_entity_ident(ir_entity *ent, ident *id);
192
193
194
195
196
197
198

/** Returns the mangled name of the entity.
 *
 * If the mangled name is set it returns the existing name.
 * Else it generates a name with mangle_entity()
 * and remembers this new name internally.
 */
Michael Beck's avatar
Michael Beck committed
199
ident *get_entity_ld_ident(ir_entity *ent);
200
201

/** Sets the mangled name of the entity. */
Michael Beck's avatar
Michael Beck committed
202
void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
203
204
205
206
207

/** Returns the mangled name of the entity as a string. */
const char *get_entity_ld_name(ir_entity *ent);

/** Returns the owner of the entity. */
Michael Beck's avatar
Michael Beck committed
208
ir_type *get_entity_owner(ir_entity *ent);
209
210
211

/** Sets the owner field in entity to owner.  Don't forget to add
   ent to owner!! */
Michael Beck's avatar
Michael Beck committed
212
void set_entity_owner(ir_entity *ent, ir_type *owner);
213
214

/** Returns the type of an entity. */
Michael Beck's avatar
Michael Beck committed
215
ir_type *get_entity_type(ir_entity *ent);
216
217

/** Sets the type of an entity. */
Michael Beck's avatar
Michael Beck committed
218
void set_entity_type(ir_entity *ent, ir_type *tp);
219
220
221

/** The allocation type. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
222
223
224
225
226
227
228
229
230
231
	allocation_automatic, /**< The entity is allocated during runtime, implicitly
	                           as component of a compound type.   This is the default. */
	allocation_parameter, /**< The entity is a parameter.  It is also automatic allocated.
	                           We distinguish the allocation of parameters from the allocation
	                           of local variables as their placement depends on the calling
	                           conventions. */
	allocation_dynamic,   /**< The entity is allocated during runtime, explicitly
	                           by an Alloc node. */
	allocation_static     /**< The entity is allocated statically.  We can use a
	                           Const as address of the entity.  This is the default for methods. */
232
233
234
235
236
237
} ir_allocation;

/** Returns the allocation type of an entity. */
ir_allocation get_entity_allocation(const ir_entity *ent);

/** Sets the allocation type of an entity. */
Michael Beck's avatar
Michael Beck committed
238
void set_entity_allocation(ir_entity *ent, ir_allocation al);
239
240

/** Return the name of the allocation type. */
Moritz Kroll's avatar
typo    
Moritz Kroll committed
241
const char *get_allocation_name(ir_allocation al);
242
243
244
245
246

/** Returns the visibility of an entity. */
ir_visibility get_entity_visibility(const ir_entity *ent);

/** Sets the visibility of an entity. */
Michael Beck's avatar
Michael Beck committed
247
void set_entity_visibility(ir_entity *ent, ir_visibility vis);
248
249
250
251
252
253

/** Return the name of the visibility */
const char *get_visibility_name(ir_visibility vis);

/** This enumeration flags the variability of entities. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
254
255
256
257
258
259
260
	variability_uninitialized,    /**< The content of the entity is completely unknown. Default. */
	variability_initialized,      /**< After allocation the entity is initialized with the
	                                   value given somewhere in the entity. */
	variability_part_constant,    /**< For entities of compound types.
	                                   The members of the entity are mixed constant,
	                                   initialized or uninitialized. */
	variability_constant          /**< The entity is constant. */
261
262
263
264
265
266
} ir_variability;

/** Returns the variability of an entity. */
ir_variability get_entity_variability(const ir_entity *ent);

/** Sets the variability of an entity. */
Michael Beck's avatar
Michael Beck committed
267
void set_entity_variability(ir_entity *ent, ir_variability var);
268
269
270
271

/** Return the name of the variability. */
const char *get_variability_name(ir_variability var);

Michael Beck's avatar
Michael Beck committed
272
/** This enumeration flags the volatility of entities and Loads/Stores. */
273
typedef enum {
Michael Beck's avatar
Michael Beck committed
274
275
	volatility_non_volatile,    /**< The entity is not volatile. Default. */
	volatility_is_volatile      /**< The entity is volatile. */
276
277
278
279
280
281
} ir_volatility;

/** Returns the volatility of an entity. */
ir_volatility get_entity_volatility(const ir_entity *ent);

/** Sets the volatility of an entity. */
Michael Beck's avatar
Michael Beck committed
282
void set_entity_volatility(ir_entity *ent, ir_volatility vol);
283
284
285
286

/** Return the name of the volatility. */
const char *get_volatility_name(ir_volatility var);

Matthias Braun's avatar
Matthias Braun committed
287
288
289
290
291
292
/** Returns alignment of entity in bytes */
unsigned get_entity_alignment(const ir_entity *entity);

/** Sets alignment for entity in bytes */
void set_entity_alignment(ir_entity *entity, unsigned alignment);

Michael Beck's avatar
Michael Beck committed
293
294
295
296
297
298
/** This enumeration flags the align of Loads/Stores. */
typedef enum {
	align_non_aligned,    /**< The entity is not aligned. */
	align_is_aligned      /**< The entity is aligned. Default */
} ir_align;

Matthias Braun's avatar
Matthias Braun committed
299
300
/** Returns indication wether entity is aligned in memory. */
ir_align get_entity_aligned(const ir_entity *ent);
301

Matthias Braun's avatar
Matthias Braun committed
302
303
/** Sets indication wether entity is aligned in memory */
void set_entity_aligned(ir_entity *ent, ir_align a);
304

Michael Beck's avatar
Michael Beck committed
305
306
307
/** Return the name of the alignment. */
const char *get_align_name(ir_align a);

308
309
/** This enumeration flags the stickyness of an entity. */
typedef enum {
310
311
312
313
314
315
	stickyness_unsticky,  /**< The entity can be removed from
	                           the program, unless contraindicated
	                           by other attributes. Default. */
	stickyness_sticky     /**< The entity must remain in the
	                           program in any case. There might be external
	                           callers. */
316
317
318
319
320
321
} ir_stickyness;

/** Get the entity's stickyness. */
ir_stickyness get_entity_stickyness(const ir_entity *ent);

/** Set the entity's stickyness. */
Michael Beck's avatar
Michael Beck committed
322
void set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness);
323
324

/** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
Michael Beck's avatar
Michael Beck committed
325
int get_entity_offset(const ir_entity *ent);
326
327

/** Sets the offset of an entity (in a compound) in bytes. */
Michael Beck's avatar
Michael Beck committed
328
void set_entity_offset(ir_entity *ent, int offset);
329
330
331
332
333

/** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);

/** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
Michael Beck's avatar
Michael Beck committed
334
void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
335
336
337
338
339
340
341
342
343
344
345
346
347

/** Returns the stored intermediate information. */
void *get_entity_link(const ir_entity *ent);

/** Stores new intermediate information. */
void set_entity_link(ir_entity *ent, void *l);

/* -- Fields of method entities -- */
/** The entity knows the corresponding irg if the entity is a method.
   This allows to get from a Call to the called irg.
   Only entities of peculiarity "existent" can have a corresponding irg,
   else the field is fixed to NULL.  (Get returns NULL, set asserts.) */
ir_graph *get_entity_irg(const ir_entity *ent);
Michael Beck's avatar
Michael Beck committed
348
void set_entity_irg(ir_entity *ent, ir_graph *irg);
349
350
351
352
353

/** Gets the entity vtable number. */
unsigned get_entity_vtable_number(const ir_entity *ent);

/** Sets the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
354
void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
355
356
357
358
359

/** Return the peculiarity of an entity. */
ir_peculiarity get_entity_peculiarity(const ir_entity *ent);

/** Sets the peculiarity of an entity. */
Michael Beck's avatar
Michael Beck committed
360
void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
361
362
363
364
365
366
367

/** Checks if an entity cannot be overridden anymore. */
int is_entity_final(const ir_entity *ent);

/** Sets/resets the final flag of an entity. */
void set_entity_final(ir_entity *ent, int final);

368
369
370
371
372
/** Set label number of an entity with code type */
void set_entity_label(ir_entity *ent, ir_label_t label);
/** Return label number of an entity with code type */
ir_label_t get_entity_label(const ir_entity *ent);

373
374
375
376
377
378
/** Checks if an entity is compiler generated. */
int is_entity_compiler_generated(const ir_entity *ent);

/** Sets/resets the compiler generated flag. */
void set_entity_compiler_generated(ir_entity *ent, int flag);

Michael Beck's avatar
Michael Beck committed
379
380
381
382
383
384
/** Checks if an entity is marked by the backend. */
int is_entity_backend_marked(const ir_entity *ent);

/** Sets/resets the backend marker flag. */
void set_entity_backend_marked(ir_entity *ent, int flag);

385
/**
386
 * Bitfield type indicating the way an entity is used.
387
388
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
389
390
391
392
393
394
395
	ir_usage_none             = 0,      /**< This entity is unused. */
	ir_usage_address_taken    = 1 << 0, /**< The address of this entity was taken. */
	ir_usage_write            = 1 << 1, /**< The entity was written to. */
	ir_usage_read             = 1 << 2, /**< The entity was read. */
	ir_usage_reinterpret_cast = 1 << 3, /**< The entity was read but with a wrong mode
	                                         (an implicit reinterpret cast) */
	/** Unknown access */
396
397
398
399
400
401
402
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

/** Return the entity usage */
ir_entity_usage get_entity_usage(const ir_entity *ent);
403
404

/** Sets/resets the state of the address taken flag of an entity. */
405
void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
406

407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
dbg_info *get_entity_dbg_info(const ir_entity *ent);

/**
 * Sets the debug information of an entity.
 *
 * @param ent The entity.
 * @param db  The debug info.
 */
void set_entity_dbg_info(ir_entity *ent, dbg_info *db);

422
423
424
425
426
427
428
429
/* -- Representation of constant values of entities -- */
/**
 * Returns true if the the node is representable as code on
 * const_code_irg.
 *
 * @deprecated This function is not used by libFirm and stays here
 *             only as a helper for the old Jack frontend.
 */
Michael Beck's avatar
Michael Beck committed
430
int is_irn_const_expression(ir_node *n);
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445

/**
 * Copies a Firm subgraph that complies to the restrictions for
 * constant expressions to current_block in current_ir_graph.
 *
 * @param dbg  debug info for all newly created nodes
 * @param n    the node
 *
 * Set current_ir_graph to get_const_code_irg() to generate a constant
 * expression.
 */
ir_node *copy_const_value(dbg_info *dbg, ir_node *n);

/* Set has no effect for existent entities of type method. */
ir_node *get_atomic_ent_value(ir_entity *ent);
Michael Beck's avatar
Michael Beck committed
446
void set_atomic_ent_value(ir_entity *ent, ir_node *val);
447

448
449
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
450
	/** initializer containing an ir_node from the const-code irg */
451
	IR_INITIALIZER_CONST,
452
	/** initializer containing a tarval */
453
	IR_INITIALIZER_TARVAL,
454
	/** initializes type with default values (usually 0) */
455
	IR_INITIALIZER_NULL,
456
	/** list of initializers used to initializer a compound or array type */
457
458
459
460
461
462
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

/** returns kind of an initializer */
ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);

463
464
465
/** Return the name of the initializer kind. */
const char *get_initializer_kind_name(ir_initializer_kind_t ini);

466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/**
 * returns the null initializer (there's only one instance of it in a program )
 */
ir_initializer_t *get_initializer_null(void);

/**
 * creates an initializer containing a reference to a node on the const-code
 * irg.
 */
ir_initializer_t *create_initializer_const(ir_node *value);

/** creates an initializer containing a single tarval value */
ir_initializer_t *create_initializer_tarval(tarval *tv);

/** return value contained in a const initializer */
ir_node *get_initializer_const_value(const ir_initializer_t *initializer);

/** return value contained in a tarval initializer */
tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);

/** creates a compound initializer which holds @p n_entries entries */
ir_initializer_t *create_initializer_compound(unsigned n_entries);

/** returns the number of entries in a compound initializer */
unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer);

/** sets entry with index @p index to the initializer @p value */
void set_initializer_compound_value(ir_initializer_t *initializer,
                                    unsigned index, ir_initializer_t *value);

/** returns the value with index @p index of a compound initializer */
ir_initializer_t *get_initializer_compound_value(
		const ir_initializer_t *initializer, unsigned index);

500
/** Sets the new style initializers of an entity. */
501
502
void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);

503
504
505
/** Returns true, if an entity has new style initializers. */
int has_entity_initializer(const ir_entity *entity);

506
/** Return the new style initializers of an entity. */
507
508
ir_initializer_t *get_entity_initializer(const ir_entity *entity);

509
510
511
512
513
514
515
516
517
518
/* --- Fields of entities with a class type as owner --- */
/* Overwrites is a field that specifies that an access to the overwritten
   entity in the supertype must use this entity.  It's a list as with
   multiple inheritance several entities can be overwritten.  This field
   is mostly useful for method entities.
   If a Sel node selects an entity that is overwritten by other entities it
   must return a pointer to the entity of the dynamic type of the pointer
   that is passed to it.  Lowering of the Sel node must assure this.
   Overwrittenby is the inverse of overwrites.  Both add routines add
   both relations, they only differ in the order of arguments. */
Michael Beck's avatar
Michael Beck committed
519
520
521
522
523
524
void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
int get_entity_n_overwrites(ir_entity *ent);
int get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten);
ir_entity *get_entity_overwrites(ir_entity *ent, int pos);
void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
525

Michael Beck's avatar
Michael Beck committed
526
527
528
529
530
531
void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
int get_entity_n_overwrittenby(ir_entity *ent);
int get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites);
ir_entity *get_entity_overwrittenby(ir_entity *ent, int pos);
void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
532
533
534
535
536
537
538
539
540

/**
 *   Checks whether a pointer points to an entity.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is an entity, else false
 */
Michael Beck's avatar
Michael Beck committed
541
int is_entity(const void *thing);
542
543
544
545

/** Returns true if the type of the entity is a primitive, pointer
 * enumeration or method type.
 *
yb9976's avatar
yb9976 committed
546
 * @note This is a different classification than from is_primitive_type().
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 */
int is_atomic_entity(ir_entity *ent);
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
int is_compound_entity(ir_entity *ent);
/** Returns true if the type of the entity is a Method type. */
int is_method_entity(ir_entity *ent);

/** Outputs a unique number for this entity if libfirm is compiled for
 *  debugging, (configure with --enable-debug) else returns the address
 *  of the type cast to long.
 */
long get_entity_nr(const ir_entity *ent);

/** Returns the entities visited count. */
562
ir_visited_t get_entity_visited(ir_entity *ent);
563
564

/** Sets the entities visited count. */
565
void set_entity_visited(ir_entity *ent, ir_visited_t num);
566
567

/** Sets visited field in entity to entity_visited. */
Michael Beck's avatar
Michael Beck committed
568
void mark_entity_visited(ir_entity *ent);
569
570

/** Returns true if this entity was visited. */
Michael Beck's avatar
Michael Beck committed
571
int entity_visited(ir_entity *ent);
572
573

/** Returns true if this entity was not visited. */
Michael Beck's avatar
Michael Beck committed
574
int entity_not_visited(ir_entity *ent);
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630

/**
 * Returns the mask of the additional entity properties.
 * The properties are automatically inherited from the irg if available
 * or from the method type if they were not set using
 * set_entity_additional_properties() or
 * set_entity_additional_property().
 */
unsigned get_entity_additional_properties(ir_entity *ent);

/** Sets the mask of the additional graph properties. */
void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);

/** Sets one additional graph property. */
void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);

/** Returns the class type that this type info entity represents or NULL
    if ent is no type info entity. */
ir_type *get_entity_repr_class(const ir_entity *ent);

/**
 * @page unknown_entity  The Unknown entity
 *
 *  This entity is an auxiliary entity dedicated to support analyses.
 *
 *  The unknown entity represents that there could be an entity, but it is not
 *  known.  This entity can be used to initialize fields before an analysis (not known
 *  yet) or to represent the top of a lattice (could not be determined).  There exists
 *  exactly one entity unknown. This entity has as owner and as type the unknown type. It is
 *  allocated when initializing the entity module.
 *
 *  The entity can take the role of any entity, also methods.  It returns default
 *  values in these cases.
 *
 *  The following values are set:
 *
 * - name          = "unknown_entity"
 * - ld_name       = "unknown_entity"
 * - owner         = unknown_type
 * - type          = unknown_type
 * - allocation    = allocation_automatic
 * - visibility    = visibility_external_allocated
 * - offset        = -1
 * - variability   = variability_uninitialized
 * - value         = SymConst(unknown_entity)
 * - values        = NULL
 * - val_paths     = NULL
 * - peculiarity   = peculiarity_existent
 * - volatility    = volatility_non_volatile
 * - stickyness    = stickyness_unsticky
 * - ld_name       = NULL
 * - overwrites    = NULL
 * - overwrittenby = NULL
 * - irg           = NULL
 * - link          = NULL
 */
631
632

/** A variable that contains the only unknown entity. */
633
634
635
636
637
638
639
extern ir_entity *unknown_entity;

/** Returns the @link unknown_entity unknown entity @endlink. */
ir_entity *get_unknown_entity(void);

/** Encodes how a pointer parameter is accessed. */
typedef enum acc_bits {
Michael Beck's avatar
Michael Beck committed
640
641
642
643
644
645
	ptr_access_none  = 0,                                 /**< no access */
	ptr_access_read  = 1,                                 /**< read access */
	ptr_access_write = 2,                                 /**< write access */
	ptr_access_rw    = ptr_access_read|ptr_access_write,  /**< read AND write access */
	ptr_access_store = 4,                                 /**< the pointer is stored */
	ptr_access_all   = ptr_access_rw|ptr_access_store     /**< all possible access */
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
} ptr_access_kind;

#define IS_READ(a)     ((a) & ptr_access_read)
#define IS_WRITTEN(a)  ((a) & ptr_access_write)
#define IS_STORED(a)   ((a) & ptr_access_store)

/**
 * @page tyop  type operations
 *  This module specifies the kinds of types available in firm.
 *
 *  They are called type opcodes. These include classes, structs, methods, unions,
 *  arrays, enumerations, pointers and primitive types.
 *  Special types with own opcodes are the id type, a type representing an unknown
 *  type and a type used to specify that something has no type.
 */

/**
 *  An enum for the type kinds.
 *  For each type kind exists a typecode to identify it.
 */
typedef enum {
	tpo_uninitialized = 0,   /* not a type opcode */
	tpo_class,               /**< A class type. */
	tpo_struct,              /**< A struct type. */
	tpo_method,              /**< A method type. */
	tpo_union,               /**< An union type. */
	tpo_array,               /**< An array type. */
	tpo_enumeration,         /**< An enumeration type. */
	tpo_pointer,             /**< A pointer type. */
	tpo_primitive,           /**< A primitive type. */
676
	tpo_code,                /**< a piece of code (a basic block) */
677
678
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
679
	tpo_last = tpo_unknown   /* not a type opcode */
680
681
682
683
684
685
686
687
} tp_opcode;

/**
 * A structure containing information about a kind of type.
 * A structure containing information about a kind of type.  So far
 * this is only the kind name, an enum for case-switching and some
 * internal values.
 *
688
 * @see  get_tpop_name(), get_tpop_code()
689
690
691
692
693
694
695
696
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
Matthias Braun's avatar
Matthias Braun committed
697
 * @return a string.  (@todo Null terminated?)
698
 */
Michael Beck's avatar
Michael Beck committed
699
const char *get_tpop_name(const tp_op *op);
700
701
702
703
704
705
706

/**
 * Returns an enum for the type opcode.
 *
 * @param op   The type opcode to get the enum from.
 * @return the enum.
 */
Michael Beck's avatar
Michael Beck committed
707
tp_opcode get_tpop_code(const tp_op *op);
708
709
710
711
712
713
714
715
716
717

/**
 * This type opcode marks that the corresponding type is a class type.
 *
 * Consequently the type refers to supertypes, subtypes and entities.
 * Entities can be any fields, but also methods.
 * @@@ value class or not???
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
718
719
extern const tp_op *type_class;
const tp_op *get_tpop_class(void);
720
721
722
723
724
725
726
727
728
729

/**
 * This type opcode marks that the corresponding type is a compound type
 * as a struct in C.
 *
 * Consequently the type refers to a list of entities
 * which may not be methods (but pointers to methods).
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
730
731
extern const tp_op *type_struct;
const tp_op *get_tpop_struct(void);
732
733
734
735
736
737
738
739

/**
 * This type opcode marks that the corresponding type is a method type.
 *
 * Consequently it refers to a list of arguments and results.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
740
741
extern const tp_op *type_method;
const tp_op *get_tpop_method(void);
742
743
744
745
746
747
748
749

/**
 * This type opcode marks that the corresponding type is a union type.
 *
 * Consequently it refers to a list of unioned types.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
750
751
extern const tp_op *type_union;
const tp_op *get_tpop_union(void);
752
753
754
755
756
757
758
759
760

/**
 * This type opcode marks that the corresponding type is an array type.
 *
 * Consequently it contains a list of dimensions (lower and upper bounds)
 * and an element type.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
761
762
extern const tp_op *type_array;
const tp_op *get_tpop_array(void);
763
764
765
766
767
768
769
770
771
772

/**
 * This type opcode marks that the corresponding type is an enumeration type.
 *
 * Consequently it contains a list of idents for the enumeration identifiers
 * and a list of target values that are the constants used to implement
 * the enumerators.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
773
774
extern const tp_op *type_enumeration;
const tp_op *get_tpop_enumeration(void);
775
776
777
778
779
780
781
782

/**
 * This type opcode marks that the corresponding type is a pointer type.
 *
 * It contains a reference to the type the pointer points to.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
783
784
extern const tp_op *type_pointer;
const tp_op *get_tpop_pointer(void);
785
786
787
788
789
790
791
792
793

/**
 * This type opcode marks that the corresponding type is a primitive type.
 *
 * Primitive types are types that are directly mapped to target machine
 * modes.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
794
795
extern const tp_op *type_primitive;
const tp_op *get_tpop_primitive(void);
796

797
798
799
800
801
802
/**
 * The code type is used to mark pieces of code (basic blocks)
 */
extern const tp_op *tpop_code;
const tp_op *get_tpop_code_type(void);

803
804
805
806
807
808
809
810
/**
 * This type opcode is an auxiliary opcode dedicated to support type analyses.
 *
 * Types with this opcode represents that there is no type.
 * The type can be used to initialize fields of the type* that actually can not
 * contain a type or that are initialized for an analysis. There exists exactly
 * one type with this opcode.
 */
Michael Beck's avatar
Michael Beck committed
811
812
extern const tp_op *tpop_none;
const tp_op *get_tpop_none(void);
813
814
815
816
817
818
819
820
821

/**
 * This type opcode is an auxiliary opcode dedicated to support type analyses.
 *
 * Types with this opcode represents that there could be a type, but it is not
 * known.  This type can be used to initialize fields before an analysis (not known
 * yet) or to represent the top of a lattice (could not be determined).  There exists
 * exactly one type with this opcode.
 */
Michael Beck's avatar
Michael Beck committed
822
823
extern const tp_op *tpop_unknown;
const tp_op *get_tpop_unknown(void);
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880

/* ----------------------------------------------------------------------- */
/* Classify pairs of types/entities in the inheritance relations.          */
/* ----------------------------------------------------------------------- */

/** Returns true if low is subclass of high.
 *
 *  Low is a subclass of high if low == high or if low is a subclass of
 *  a subclass of high.  I.e, we search in all subtypes of high for low.
 *  @@@ this can be implemented more efficient if we know the set of all
 *  subclasses of high.  */
int is_SubClass_of(ir_type *low, ir_type *high);

/** Subclass check for pointers to classes.
 *
 *  Dereferences at both types the same amount of pointer types (as
 *  many as possible).  If the remaining types are both class types
 *  and subclasses, returns true, else false.  Can also be called with
 *  two class types.  */
int is_SubClass_ptr_of(ir_type *low, ir_type *high);

/** Returns true if high is superclass of low.
 *
 *  Low is a subclass of high if low == high or if low is a subclass of
 *  a subclass of high.  I.e, we search in all subtypes of high for low.
 *  @@@ this can be implemented more efficient if we know the set of all
 *  subclasses of high.  */
#define is_SuperClass_of(high, low) is_SubClass_of(low, high)

/** Superclass check for pointers to classes.
 *
 *  Dereferences at both types the same amount of pointer types (as
 *  many as possible).  If the remaining types are both class types
 *  and superclasses, returns true, else false.  Can also be called with
 *  two class types.  */
#define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)

/** Returns true if high is (transitive) overwritten by low.
 *
 *  Returns false if high == low. */
int is_overwritten_by(ir_entity *high, ir_entity *low);

/** Resolve polymorphism in the inheritance relation.
 *
 *  Returns the dynamically referenced entity if the static entity and the
 *  dynamic type are given.
 *  Searches downwards in overwritten tree. */
ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class, ir_entity* static_ent);

/* ----------------------------------------------------------------------- */
/* Resolve implicit inheritance.                                           */
/* ----------------------------------------------------------------------- */

/** Default name mangling for inherited entities.
 *
 *  Returns an ident that consists of the name of type followed by an
 *  underscore and the name (not ld_name) of the entity. */
Michael Beck's avatar
Michael Beck committed
881
ident *default_mangle_inherited_name(const ir_entity *ent, const ir_type *clss);
882
883
884
885
886
887
888
889

/** Type of argument functions for inheritance resolver.
 *
 * @param ent     The entity in the super type that will be overwritten
 *                by the newly generated entity, for which this name is
 *                used.
 * @param clss    The class type in which the new entity will be placed.
 */
Michael Beck's avatar
Michael Beck committed
890
typedef ident *mangle_inherited_name_func(const ir_entity *ent, const ir_type *clss);
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944

/** Resolve implicit inheritance.
 *
 *  Resolves the implicit inheritance supplied by firm.  Firm defines,
 *  that each entity that is not overwritten in a subclass is
 *  inherited to this subclass without change implicitly.  This
 *  function generates entities that explicitly represent this
 *  inheritance.  It generates for each entity overwriting entities in
 *  all subclasses of the owner of the entity, if the entity is not
 *  overwritten in that subclass.
 *
 *  The name of the new entity is generated with the function passed.
 *  If the function is NULL, the default_mangle_inherited_name() is
 *  used.
 *
 *  This function was moved here from firmlower 3/2005.
 */
void resolve_inheritance(mangle_inherited_name_func *mfunc);


/* ----------------------------------------------------------------------- */
/* The transitive closure of the subclass/superclass and                   */
/* overwrites/overwrittenby relation.                                      */
/*                                                                         */
/* A walk over the ir (O(#types+#entities)) computes the transitive        */
/* closure.  Adding a new type/entity or changing the basic relations in   */
/* some other way invalidates the transitive closure, i.e., it is not      */
/* updated by the basic functions.                                         */
/*                                                                         */
/* The transitive edges are held in a set, not in an array as the          */
/* underlying relation.                                                    */
/*                                                                         */
/* Do the sets contain the node itself?  I assume NOT!                     */
/* ----------------------------------------------------------------------- */

/** The state of the transitive closure.
 *
 *  @todo: we could manage the state for each relation separately.  Invalidating
 *  the entity relations does not mean invalidating the class relation. */
typedef enum {
	inh_transitive_closure_none,       /**<  Closure is not computed, can not be accessed. */
	inh_transitive_closure_valid,      /**<  Closure computed and valid. */
	inh_transitive_closure_invalid,    /**<  Closure invalid, but can be accessed. */
	inh_transitive_closure_max         /**<  Invalid value. */
} inh_transitive_closure_state;

void                         set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
void                         invalidate_irp_inh_transitive_closure_state(void);
inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);


/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
945
 * This function walks over the ir (O(\#types+\#entities)) to compute the
946
947
948
949
950
951
952
953
954
955
 * transitive closure.    */
void compute_inh_transitive_closure(void);

/** Free memory occupied by the transitive closure information. */
void free_inh_transitive_closure(void);


/* - subtype ------------------------------------------------------------- */

/** Iterate over all transitive subtypes. */
Michael Beck's avatar
Michael Beck committed
956
957
958
ir_type *get_class_trans_subtype_first(const ir_type *tp);
ir_type *get_class_trans_subtype_next(const ir_type *tp);
int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
959
960
961
962

/* - supertype ----------------------------------------------------------- */

/** Iterate over all transitive supertypes. */
Michael Beck's avatar
Michael Beck committed
963
964
ir_type *get_class_trans_supertype_first(const ir_type *tp);
ir_type *get_class_trans_supertype_next(const ir_type *tp);
965
966
967
968

/* - overwrittenby ------------------------------------------------------- */

/** Iterate over all entities that transitive overwrite this entities. */
Michael Beck's avatar
Michael Beck committed
969
970
ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
971
972
973
974

/* - overwrites ---------------------------------------------------------- */

/** Iterate over all transitive overwritten entities. */
Michael Beck's avatar
Michael Beck committed
975
976
ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012


/* ----------------------------------------------------------------------- */
/** The state of Cast operations that cast class types or pointers to class
 *  types.
 *
 * The state expresses, how far Cast operations conform with the class
 * hierarchy.
 *
 *   class A {}
 *   class B1 extends A {}
 *   class B2 extends A {}
 *   class C  extends B1 {}
 * normalized:  Cast operations conform with the inheritance relation.
 *   I.e., the type of the operand of a Cast is either a super= or a sub-
 *   type of the type casted to. Example: (A)((B2) (new C())).
 * transitive:  Cast operations conform with the transitive inheritance
 *   relation. Example: (A)(new C()).
 * any:  Cast operations do not conform with the transitive inheritance
 *   relation.  Example: (B2)(new B1())
 */
/* ----------------------------------------------------------------------- */

/** Flags for class cast state.
 *
 * The state in irp is always smaller or equal to the state of any
 * irg.
 *
 * We rely on the ordering of the enum. */
typedef enum {
	ir_class_casts_any        = 0, /**< There are class casts that do not cast in conformance with
	                                    the class hierarchy.  @@@ So far this does not happen in Firm. */
	ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
	ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
	ir_class_casts_state_max
} ir_class_cast_state;
Michael Beck's avatar
Michael Beck committed
1013
const char *get_class_cast_state_string(ir_class_cast_state s);
1014
1015

void                set_irg_class_cast_state(ir_graph *irg, ir_class_cast_state s);
Michael Beck's avatar
Michael Beck committed
1016
ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
1017
1018
1019
1020
1021
void                set_irp_class_cast_state(ir_class_cast_state s);
ir_class_cast_state get_irp_class_cast_state(void);

/** Verify the class cast state of an irg.
 *
Michael Beck's avatar
Michael Beck committed
1022
 *  Asserts if state is to high, outputs debug warning if state is to low
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
 *  and firm verbosity is set.
 */
void verify_irg_class_cast_state(ir_graph *irg);

/**
 * possible trvrfy() error codes
 */
enum trvrfy_error_codes {
	no_error = 0,                      /**< no error */
	error_ent_not_cont,                /**< overwritten entity not in superclass */
	error_null_mem,                    /**< compound contains NULL member */
	error_const_on_wrong_irg,          /**< constant placed on wrong IRG */
	error_existent_entity_without_irg, /**< Method entities with pecularity_exist must have an irg */
	error_wrong_ent_overwrites,        /**< number of entity overwrites exceeds number of class overwrites */
	error_inherited_ent_without_const, /**< inherited method entity not pointing to existent entity */
	error_glob_ent_allocation,         /**< wrong allocation of a global entity */
	error_ent_const_mode,              /**< Mode of constant in entity did not match entities type. */
	error_ent_wrong_owner              /**< Mode of constant in entity did not match entities type. */
};

/**
 * Checks a type.
 *
 * @return
 *  0   if no error encountered
 */
int check_type(ir_type *tp);

/**
 * Check an entity. Currently, we check only if initialized constants
 * are build on the const irg graph.
 *
 * @return
 *  0   if no error encountered
 *  != 0    a trvrfy_error_codes code
 */
int check_entity(ir_entity *ent);

/**
 * Walks the type information and performs a set of sanity checks.
 *
 * Currently, the following checks are executed:
 * - values of initialized entities must be allocated on the constant IRG
 * - class types: doesn't have NULL members
 * - class types: all overwrites are existent in the super type
 *
 * @return
 *    0 if graph is correct
 *    else error code.
 */
int tr_vrfy(void);

/**
 * If NDEBUG is defined performs nothing, else calls the tr_vrfy() function.
 */
#ifdef NDEBUG
#define TR_VRFY()	0
#else
#define TR_VRFY()	tr_vrfy()
#endif

Sebastian Felis's avatar
Sebastian Felis committed
1084
/**
1085
 * @page type   representation of types
Michael Beck's avatar
Michael Beck committed
1086
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
1087
 *  Datastructure to hold type information.
1088
1089
1090
1091
1092
 *
 *  This module supplies a datastructure to represent all types
 *  known in the compiled program.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
1093
 *  between these types.  Finally it specifies some auxiliary types.
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  A type is described by a set of attributes.  Some of
 *  these attributes are common to all types, others depend on the
 *  kind of the type.
 *
 *  Types are different from the modes defined in irmode:  Types are
 *  on the level of the programming language, modes at the level of
 *  the target processor.
 */

Michael Beck's avatar
Michael Beck committed
1105
1106
1107
1108
/** Frees all entities associated with a type.
 *  Does not free the array entity.
 *  Warning: ensure these entities are not referenced anywhere else.
 */
Michael Beck's avatar
Michael Beck committed
1109
void free_type_entities(ir_type *tp);
1110

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1111
1112
1113
1114
1115
1116
/** Frees the memory used by the type.
 *
 * Removes the type from the type list. Does not free the entities
 * belonging to the type, except for the array element entity.  Does
 * not free if tp is "none" or "unknown".  Frees entities in value
 * param subtypes of method types!!! Make sure these are not
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1117
1118
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
Michael Beck's avatar
Michael Beck committed
1119
void free_type(ir_type *tp);
1120

Michael Beck's avatar
Michael Beck committed
1121
1122
1123
1124
const tp_op *get_type_tpop(const ir_type *tp);
ident *get_type_tpop_nameid(const ir_type *tp);
const char *get_type_tpop_name(const ir_type *tp);
tp_opcode get_type_tpop_code(const ir_type *tp);
1125

Michael Beck's avatar
Michael Beck committed
1126
1127
1128
ident *get_type_ident(const ir_type *tp);
void set_type_ident(ir_type *tp, ident* id);
const char *get_type_name(const ir_type *tp);
1129

1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
/** The visibility of a type.
 *
 *  The visibility of a type indicates, whether entities of this type
 *  are accessed or allocated in external code.
 *
 *  An entity of a type is allocated in external code, if the external
 *  code declares a variable of this type, or dynamically allocates
 *  an entity of this type.  If the external code declares a (compound)
 *  type, that contains entities of this type, the visibility also
 *  must be external_allocated.
 *
 *  The visibility must be higher than that of all entities, if the
 *  type is a compound.  Here it is questionable, what happens with
 *  static entities.  If these are accessed external by direct reference,
 *  (a static call to a method, that is also in the dispatch table)
 *  it should not affect the visibility of the type.
 *
 *
 * @@@ Do we need a visibility for types?
 * I change the layout of types radically when doing type splitting.
Michael Beck's avatar
Michael Beck committed
1150
 * I need to know, which fields of classes are accessed in the RTS,
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 * e.g., [_length.  I may not move [_length to the split part.
 * The layout though, is a property of the type.
 *
 * One could also think of changing the mode of a type ...
 *
 * But, we could also output macros to access the fields, e.g.,
 *  ACCESS_[_length (X)   X->length              // conventional
 *  ACCESS_[_length (X)   X->_split_ref->length  // with type splitting
 *
 * For now I implement this function, that returns the visibility
 * based on the visibility of the entities of a compound ...
 *
 * This function returns visibility_external_visible if one or more
 * entities of a compound type have visibility_external_visible.
 * Entities of types are never visibility_external_allocated (right?).
 * Else returns visibility_local.
 */
1168
1169
ir_visibility get_type_visibility(const ir_type *tp);
void          set_type_visibility(ir_type *tp, ir_visibility v);
1170
1171
1172



1173
/** The state of the type layout. */
1174
typedef enum {
Michael Beck's avatar
Michael Beck committed
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
	layout_undefined,    /**< The layout of this type is not defined.
	                          Address computation to access fields is not
	                          possible, fields must be accessed by Sel
	                          nodes.  Enumeration constants might be undefined.
	                          This is the default value except for
	                          pointer, primitive and method types. */
	layout_fixed         /**< The layout is fixed, all component/member entities
	                          have an offset assigned.  Size of the type is known.
	                          Arrays can be accessed by explicit address
	                          computation.  Enumeration constants must be defined.
	                          Default for pointer, primitive and method types. */
1186
} ir_type_state;
1187

Götz Lindenmaier's avatar
Götz Lindenmaier committed
1188
/** Returns a human readable string for the enum entry. */
1189
const char *get_type_state_name(ir_type_state s);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1190

1191
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
1192
ir_type_state get_type_state(const ir_type *tp);
1193
1194
1195
1196
1197
1198

/** Sets the type layout state of a type.
 *
 * For primitives, pointer and method types the layout is always fixed.
 * This call is legal but has no effect.
 */
Michael Beck's avatar
Michael Beck committed
1199
void set_type_state(ir_type *tp, ir_type_state state);
1200

1201
1202
1203
1204
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
1205
ir_mode *get_type_mode(const ir_type *tp);
1206
1207
1208

/** Sets the mode of a type.
 *
1209
 * Only has an effect on primitive, enumeration and pointer types.
1210
 */
Michael Beck's avatar
Michael Beck committed
1211
void set_type_mode(ir_type *tp, ir_mode* m);
1212

1213
1214
/** Returns the size of a type in bytes. */
unsigned get_type_size_bytes(const ir_type *tp);
1215
1216
1217
1218
1219
1220

/** Sets the size of a type in bytes.
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
1221
void set_type_size_bytes(ir_type *tp, unsigned size);
1222

Matthias Braun's avatar
Matthias Braun committed
1223
/** Returns the alignment of a type in bytes. */
1224
unsigned get_type_alignment_bytes(ir_type *tp);
1225

1226
1227
1228
1229
/** Returns the alignment of a type in bits.
 *
 *  If the alignment of a type is
 *  not set, it is calculated here according to the following rules:
Michael Beck's avatar
Michael Beck committed
1230
1231
1232
1233
 *  -#.) if a type has a mode, the alignment is the mode size.
 *  -#.) compound types have the alignment of there biggest member.
 *  -#.) array types have the alignment of there element type.
 *  -#.) method types return 0 here.
1234
 *  -#.) all other types return 1 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed
1235
 */
1236
void set_type_alignment_bytes(ir_type *tp, unsigned align);
Michael Beck's avatar
Michael Beck committed
1237

Michael Beck's avatar
Michael Beck committed
1238
/** Returns the visited count of a type. */
1239
ir_visited_t get_type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1240
/** Sets the visited count of a type to num. */
1241
void set_type_visited(ir_type *tp, ir_visited_t num);
Michael Beck's avatar
Michael Beck committed
1242
/** Sets visited field in type to type_visited. */
Michael Beck's avatar
Michael Beck committed
1243
void mark_type_visited(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1244
/** Returns non-zero if the type is already visited */
Michael Beck's avatar
Michael Beck committed
1245
int type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1246
/** Returns non-zero if the type is not yet visited */
Michael Beck's avatar
Michael Beck committed
1247
int type_not_visited(const ir_type *tp);
1248

Michael Beck's avatar
Michael Beck committed
1249
/** Returns the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
1250
void *get_type_link(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1251
/** Sets the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
1252
void set_type_link(ir_type *tp, void *l);
1253

Sebastian Felis's avatar
Sebastian Felis committed
1254
/**
1255
1256
 * Visited flag to traverse the type information.
 *
1257
1258
 * Increase this flag by one before traversing the type information
 * using inc_master_type_visited().
1259
1260
1261
 * Mark type nodes as visited by mark_type_visited(ir_type).
 * Check whether node was already visited by type_visited(ir_type)
 * and type_not_visited(ir_type).
1262
 * Or use the function to walk all types.
1263
 *
Sebastian Felis's avatar
Sebastian Felis committed
1264
 * @see  typewalk
1265
 */
1266
1267
1268
void         set_master_type_visited(ir_visited_t val);
ir_visited_t get_master_type_visited(void);
void         inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
1269

1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
/**
 * Sets the debug information of a type.
 *
 * @param tp  The type.
 * @param db  The debug info.
 */
void set_type_dbg_info(ir_type *tp, dbg_info *db);

/**
 * Returns the debug information of a type.
 *
 * @param tp  The type.
 */
dbg_info *get_type_dbg_info(const ir_type *tp);

Sebastian Felis's avatar
Sebastian Felis committed
1285
/**
1286
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
1287
 *
1288
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
1289
 *
1290
1291
 * @return
 *     true if the thing is a type, else false
1292
 */
1293
int is_type(const void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
1294

Sebastian Felis's avatar
Sebastian Felis committed
1295
/**
Florian Liekweg's avatar
Florian Liekweg committed
1296
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
1297
 *
1298
1299
 *   @param typ1  the first type
 *   @param typ2  the second type
Michael Beck's avatar
Michael Beck committed
1300
1301
1302
 *
 *   @return
 *    true if the types are equal, else false.
1303
1304
 *
 *   Types are equal if :
1305
1306
1307
1308
 *    - they are the same type kind
 *    - they have the same name
 *    - they have the same mode (if applicable)
 *    - they have the same type_state and, ev., the same size
Michael Beck's avatar
Michael Beck committed
1309
 *    - they are class types and have:
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 *      - the same members (see same_entity in entity.h)
 *      - the same supertypes -- the C-pointers are compared --> no recursive call.
 *      - the same number of subtypes.  Subtypes are not compared,
 *        as this could cause a cyclic test.
 *      - the same peculiarity
 *    - they are structure types and have the same members
 *    - they are method types and have
 *      - the same parameter types
 *      - the same result types
 *    - they are union types and have the same members
 *    - they are array types and have
 *      - the same number of dimensions
 *      - the same dimension bounds
 *      - the same dimension order
 *      - the same element type
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the identical points_to type
Matthias Braun's avatar
Matthias Braun committed
1327
 *      (i.e., the same C-struct to represent the type.
Michael Beck's avatar
Michael Beck committed
1328
 *       This is to avoid endless recursions; with pointer types cyclic
1329
1330
 *       type graphs are possible.)
 */
1331
int equal_type(ir_type *typ1, ir_type *typ2);
1332

Sebastian Felis's avatar
Sebastian Felis committed
1333
1334
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
1335
1336
1337
1338
1339
1340
1341
1342
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if type st is smaller than type lt, i.e. whenever
 *    lt is expected a st can be used.
 *    This is true if
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 *    - they are the same type kind
 *    - mode(st) < mode (lt)  (if applicable)
 *    - they are class types and st is (transitive) subtype of lt,
 *    - they are structure types and
 *       - the members of st have exactly one counterpart in lt with the same name,
 *       - the counterpart has a bigger type.
 *    - they are method types and have
 *      - the same number of parameter and result types,
 *      - the parameter types of st are smaller than those of lt,
 *      - the result types of st are smaller than those of lt
 *    - they are union types and have the members of st have exactly one
Sebastian Felis's avatar
Sebastian Felis committed
1354
 *      @return counterpart in lt and the type is smaller
1355
1356
1357
1358
1359
 *    - they are array types and have
 *      - the same number of dimensions
 *      - all bounds of lt are bound of st
 *      - the same dimension order
 *      - the same element type
Sebastian Felis's avatar
Sebastian Felis committed
1360
 *      @return or
1361
1362
1363
1364
 *      - the element type of st is smaller than that of lt
 *      - the element types have the same size and fixed layout.
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the points_to type of st is
Sebastian Felis's avatar
Sebastian Felis committed
1365
1366
 *      @return smaller than the points_to type of lt.
 *
1367
 */
1368
int smaller_type(ir_type *st, ir_type *lt);
1369

Sebastian Felis's avatar
Sebastian Felis committed
1370
/**
Florian Liekweg's avatar
Florian Liekweg committed
1371
 *  @page class_type    Representation of a class type
1372
 *
1373
1374
1375
 *  If the type opcode is set to type_class the type represents class
 *  types.  A list of fields and methods is associated with a class.
 *  Further a class can inherit from and bequest to other classes.
1376
 *
1377
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
1378
 *  - member:     All entities belonging to this class.  This are method entities
1379
1380
1381
 *                which have type_method or fields that can have any of the
 *                following type kinds: type_class, type_struct, type_union,
 *                type_array, type_enumeration, type_pointer, type_primitive.
1382
 *
1383
1384
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
1385
 *
1386
 *  - subtypes:    A list of direct subclasses.
1387
 *
1388
 *  - supertypes:  A list of direct superclasses.
1389
 *
1390
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
1391
 *                 "description" it only is a description of requirements to a class,
1392
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
1393
 *                 Peculiarity inherited is only possible for entities.  An entity
1394
1395
1396
1397
 *                 is of peculiarity inherited if the compiler generated the entity
 *                 to explicitly resolve inheritance.  An inherited method entity has
 *                 no value for irg.
 *                 Values: description, existent, inherited.  Default: existent.
1398
 *
1399
1400
1401
1402
1403
1404
 *  - type_info:   An entity representing the type information of this class.
 *                 This entity can be of arbitrari type, Firm did not use it yet.
 *                 It allows to express the coupling of a type with an entity
 *                 representing this type.  This information is useful for lowering
 *                 of InstOf and TypeChk nodes.  Default: NULL
 *
1405
 *  - vtable_size: The size of this class virtual function table.
1406
1407
 *                 Default:  0
 *
1408
1409
1410
1411
1412
 *  - final:       A final class is always a leaf in the class hierarchy.  Final
 *                 classes cannot be super classes of other ones.  As this information
 *                 can only be computed in whole world compilations, we allow to
 *                 set this flag.  It is used in optimizations if get_opt_closed_world()
 *                 is false.  Default:  false
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 *
 *  - interface:   The class represents an interface.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
 *
 *  - abstract :   The class represents an abstract class.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
1423
 */
1424
1425

/** Creates a new class type. */
Michael Beck's avatar
Michael Beck committed
1426
ir_type *new_type_class(ident *name);
1427
1428

/** Creates a new class type with debug information. */
Michael Beck's avatar
Michael Beck committed
1429
ir_type *new_d_type_class(ident *name, dbg_info *db);
1430

1431
1432
1433
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
Michael Beck's avatar
Michael Beck committed
1434
void add_class_member(ir_type *clss, ir_entity *member);
1435
1436

/** Returns the number of members of this class. */
Michael Beck's avatar
Michael Beck committed
1437
int get_class_n_members(const ir_type *clss);
1438
1439

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar
Michael Beck committed
1440
ir_entity *get_class_member(const ir_type *clss, int pos);
1441

Götz Lindenmaier's avatar
Götz Lindenmaier committed
1442
/** Returns index of mem in clss, -1 if not contained. */
1443
int get_class_member_index(const ir_type *clss, ir_entity *mem);
1444

Götz Lindenmaier's avatar
Götz Lindenmaier committed
1445
/** Finds the member with name 'name'. If several members with the same
1446
 *  name returns one of them.  Returns NULL if no member found. */
1447
ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1448

1449
/** Overwrites the member at position pos, 0 <= pos < n_member with
1450
 *  the passed entity. */
Michael Beck's avatar
Michael Beck committed
1451
void set_class_member(ir_type *clss, ir_entity *member, int pos);
1452
1453

/** Replaces complete member list in class type by the list passed.
1454
1455
1456
1457
 *
 *  Copies the list passed. This function is necessary to reduce the number of members.
 *  members is an array of entities, num the size of this array.  Sets all
 *  owners of the members passed to clss. */
Michael Beck's avatar
Michael Beck committed
1458
void set_class_members(ir_type *clss, ir_entity *members[], int arity);
1459
1460

/** Finds member in the list of members and removes it.
1461
1462
1463
 *
 *  Shrinks the member list, so iterate from the end!!!
 *  Does not deallocate the entity.  */
1464
void remove_class_member(ir_type *clss, ir_entity *member);
1465