typerep.h 87.8 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2011 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
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

27
#include <stdlib.h>
28
29
30
#include "firm_types.h"

#include "begin.h"
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

/**
 * @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.
Matthias Braun's avatar
Matthias Braun committed
57
58
 *   - name:       The string that represents this entity in the source program
 *   - linkage:    A flag indicating how the linker treats a symbol
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 *   - 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.
 *   - visited:    visited flag.  Master flag is type_visited.
 *
 * These fields can only be accessed via access functions.
 *
 * @see  ir_type, ir_entity
 */

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/**
 * Visibility classed for entities.
 */
typedef enum {
	/**
	 * The entity is visible outside the compilation unit, but it is defined
	 * here.
	 */
	ir_visibility_default,
	/**
	 * The entity is local to the compilation unit.
	 * A local entity is not visible in other compilation units.
	 * Note that the entity might still be accessed indirectly from other units
	 * through pointers.
	 */
	ir_visibility_local,
	/**
	 * The entity is defined outside the compilation unit but potentially used
	 * here.
	 */
99
100
101
102
103
104
105
106
107
	ir_visibility_external,
	/**
	 * This has the same semantic as visibility_local. Additionally the symbol is
	 * completely hidden from the linker (it only appears in the assembly).
	 * While visibility_local is probably still visible to debuggers,
	 * visibility_private symbols aren't and probably won't appear in the object
	 * files
	 */
	ir_visibility_private
108
109
} ir_visibility;

Matthias Braun's avatar
Matthias Braun committed
110
111
/**
 * linkage specifies how the linker treats symbols
112
 */
113
typedef enum ir_linkage {
114
	IR_LINKAGE_DEFAULT         = 0,
Matthias Braun's avatar
Matthias Braun committed
115
116
117
118
119
120
	/**
	 * A symbol whose definition won't change in a program.
	 * Optimisation might replace loads from this entity with constants.
	 * Also most linkers put such data in a constant segment which is shared
	 * between multiple running instances of the same application.
	 */
121
	IR_LINKAGE_CONSTANT        = 1 << 0,
Matthias Braun's avatar
Matthias Braun committed
122
123
124
125
126
127
	/**
	 * The entity is a weak symbol.
	 * A weak symbol is overridden by a non-weak symbol if one exists.
	 * Most linkers only support the IR_LINKAGE_WEAK in combination with
	 * IR_LINKAGE_MERGE.
	 */
128
	IR_LINKAGE_WEAK            = 1 << 1,
Matthias Braun's avatar
Matthias Braun committed
129
130
131
132
133
	/**
	 * The entity may be removed when it isn't referenced anywhere in the
	 * compilation unit even if it is exported (non-local).
	 * Typically used for C++ instantiated template code (,,COMDAT'' section).
	 */
134
	IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
135
136
137
138
139
140
	/**
	 * The linker will try to merge entities with same name from different
	 * compilation units. This is the usual behaviour for global variables
	 * without explicit initialisation in C (``COMMON'' symbols). It's also
	 * typically used in C++ for instantiated template code (,,COMDAT'' section)
	 */
141
	IR_LINKAGE_MERGE           = 1 << 3,
Matthias Braun's avatar
Matthias Braun committed
142
143
144
145
146
147
148
149
	/**
	 * Some entity uses are potentially hidden from the compiler.
	 * (For example because they happen in an asm("") statement. This flag
	 *  should be set for __attribute__((used)) in C code).
	 * Setting this flag prohibits that the compiler making assumptions about
	 * read/write behaviour to global variables or changing calling conventions
	 * from cdecl to fastcall.
	 */
150
	IR_LINKAGE_HIDDEN_USER     = 1 << 4
Matthias Braun's avatar
Matthias Braun committed
151
} ir_linkage;
152
ENUM_BITSET(ir_linkage)
Matthias Braun's avatar
Matthias Braun committed
153
154

/**
155
 * Return the visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
156
 */
Michael Beck's avatar
Michael Beck committed
157
FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
158
159

/**
160
 * Set visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
161
 */
Michael Beck's avatar
Michael Beck committed
162
FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
Matthias Braun's avatar
Matthias Braun committed
163
164

/**
165
166
167
168
169
170
 * Return 1 if the entity is visible outside the current compilation unit
 * or to unknown callers (like asm statements).
 * (The entity might still be accessible indirectly through pointers)
 * This is a convenience function and does the same as
 * get_entity_visibility(entity) != ir_visibility_local ||
 * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
Matthias Braun's avatar
Matthias Braun committed
171
 */
Michael Beck's avatar
Michael Beck committed
172
FIRM_API int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
173
174

/**
175
176
 * Return 1 if the entity has a definition (initializer) in the current
 * compilation unit
Matthias Braun's avatar
Matthias Braun committed
177
 */
Michael Beck's avatar
Michael Beck committed
178
FIRM_API int entity_has_definition(const ir_entity *entity);
179
180
181
182
183
184
185
186
187
188

/**
 * 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
189
FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
190
191
192
193
194
195
196
197
198
199

/**
 * 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
200
FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
201
                                 dbg_info *db);
202

203
204
205
206
207
208
209
210
211
212
213
214
215
/**
 * Creates a new entity corresponding to a function parameter.
 * This must be created on an irgs frame_type
 */
FIRM_API ir_entity *new_parameter_entity(ir_type *owner, size_t pos,
                                         ir_type *type);

/**
 * Like new_parameter_entity() but with debug information.
 */
FIRM_API ir_entity *new_d_parameter_entity(ir_type *owner, size_t pos,
                                           ir_type *type, dbg_info *dbgi);

216
217
218
219
220
221
222
223
/**
 * 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.
 */
Michael Beck's avatar
Michael Beck committed
224
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
225
226
227
228
229
230
231
232
233

/**
 * 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
234
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
235
236
237
238
239
240
241

/**
 * 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
242
FIRM_API void free_entity(ir_entity *ent);
243
244

/** Returns the name of an entity. */
Michael Beck's avatar
Michael Beck committed
245
FIRM_API const char *get_entity_name(const ir_entity *ent);
246
247

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
248
FIRM_API ident *get_entity_ident(const ir_entity *ent);
249
250

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
251
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
252
253
254
255
256
257
258

/** 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
259
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
260
261

/** Sets the mangled name of the entity. */
Michael Beck's avatar
Michael Beck committed
262
FIRM_API void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
263
264

/** Returns the mangled name of the entity as a string. */
Michael Beck's avatar
Michael Beck committed
265
FIRM_API const char *get_entity_ld_name(const ir_entity *ent);
266

267
268
269
/** returns 1 if the entity has an ld_ident set explicitely */
FIRM_API int entity_has_ld_ident(const ir_entity *entity);

270
/** Returns the owner of the entity. */
Michael Beck's avatar
Michael Beck committed
271
FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
272

273
274
275
276
277
/**
 * Sets the owner field in entity to owner.
 * Automatically removes entity from old owner type and adds it to the new
 * one.
 */
Michael Beck's avatar
Michael Beck committed
278
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
279
280

/** Returns the type of an entity. */
Michael Beck's avatar
Michael Beck committed
281
FIRM_API ir_type *get_entity_type(const ir_entity *ent);
282
283

/** Sets the type of an entity. */
Michael Beck's avatar
Michael Beck committed
284
FIRM_API void set_entity_type(ir_entity *ent, ir_type *tp);
285

Matthias Braun's avatar
Matthias Braun committed
286
/** Returns the linkage of an entity. */
Michael Beck's avatar
Michael Beck committed
287
FIRM_API ir_linkage get_entity_linkage(const ir_entity *entity);
288

Matthias Braun's avatar
Matthias Braun committed
289
/** Sets the linkage of an entity. */
Michael Beck's avatar
Michael Beck committed
290
291
292
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
293

Matthias Braun's avatar
Matthias Braun committed
294
295
296
297
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
298
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
299

Matthias Braun's avatar
Matthias Braun committed
300
301
302
303
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
304
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
305
306

/** Return the name of the volatility. */
Michael Beck's avatar
Michael Beck committed
307
FIRM_API const char *get_volatility_name(ir_volatility var);
308

Matthias Braun's avatar
Matthias Braun committed
309
/** Returns alignment of entity in bytes */
Michael Beck's avatar
Michael Beck committed
310
FIRM_API unsigned get_entity_alignment(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
311

Matthias Braun's avatar
Matthias Braun committed
312
/** Allows you to override the type alignment for an entity.
313
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
314
315
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
316
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
317

Matthias Braun's avatar
Matthias Braun committed
318
319

/**
320
 * Returns indication whether entity is aligned in memory.
Matthias Braun's avatar
Matthias Braun committed
321
322
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
323
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
324

Matthias Braun's avatar
Matthias Braun committed
325
/**
326
 * Sets indication whether entity is aligned in memory
Matthias Braun's avatar
Matthias Braun committed
327
328
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
329
FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
330

Michael Beck's avatar
Michael Beck committed
331
/** Return the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
332
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
333

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

/** Sets the offset of an entity (in a compound) in bytes. */
Michael Beck's avatar
Michael Beck committed
338
FIRM_API void set_entity_offset(ir_entity *ent, int offset);
339
340

/** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
Michael Beck's avatar
Michael Beck committed
341
FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
342
343

/** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
Michael Beck's avatar
Michael Beck committed
344
FIRM_API void set_entity_offset_bits_remainder(ir_entity *ent,
345
                                               unsigned char offset);
346
347

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
348
FIRM_API void *get_entity_link(const ir_entity *ent);
349
350

/** Stores new intermediate information. */
Michael Beck's avatar
Michael Beck committed
351
FIRM_API void set_entity_link(ir_entity *ent, void *l);
352
353
354

/* -- Fields of method entities -- */
/** The entity knows the corresponding irg if the entity is a method.
Matthias Braun's avatar
Matthias Braun committed
355
   This allows to get from a Call to the called irg. */
Michael Beck's avatar
Michael Beck committed
356
357
FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
FIRM_API void set_entity_irg(ir_entity *ent, ir_graph *irg);
358

359
360
361
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

362
/** Gets the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
363
FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
364
365

/** Sets the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
366
FIRM_API void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
367

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

373
/** Checks if an entity is compiler generated. */
Michael Beck's avatar
Michael Beck committed
374
FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
375
376

/** Sets/resets the compiler generated flag. */
Michael Beck's avatar
Michael Beck committed
377
FIRM_API void set_entity_compiler_generated(ir_entity *ent, int flag);
Michael Beck's avatar
Michael Beck committed
378

379
/**
380
 * Bitfield type indicating the way an entity is used.
381
382
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
383
384
385
386
387
388
389
	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 */
390
391
392
393
394
395
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

/** Return the entity usage */
Michael Beck's avatar
Michael Beck committed
396
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
397
398

/** Sets/resets the state of the address taken flag of an entity. */
Michael Beck's avatar
Michael Beck committed
399
FIRM_API void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
400

401
402
403
404
405
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
Michael Beck's avatar
Michael Beck committed
406
FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
407
408
409
410
411
412
413

/**
 * Sets the debug information of an entity.
 *
 * @param ent The entity.
 * @param db  The debug info.
 */
Michael Beck's avatar
Michael Beck committed
414
FIRM_API void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
415

416
417
#define IR_VA_START_PARAMETER_NUMBER  ((size_t)-1)

418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
/**
 * returns true if a given entity is a parameter_entity representing the
 * address of a function parameter
 */
FIRM_API int is_parameter_entity(const ir_entity *entity);

/**
 * returns number of parameter a parameter entitiy represents
 */
FIRM_API size_t get_entity_parameter_number(const ir_entity *entity);

/**
 * set number of parameter an entity represents
 */
FIRM_API void set_entity_parameter_number(ir_entity *entity, size_t n);

434
435
436
437
438
439
440
441
/* -- 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
442
FIRM_API int is_irn_const_expression(ir_node *n);
443
444
445

/**
 * Copies a Firm subgraph that complies to the restrictions for
446
 * constant expressions to block.
447
 *
Matthias Braun's avatar
Matthias Braun committed
448
449
450
 * @param dbg       debug info for all newly created nodes
 * @param n         the node
 * @param to_block  block to copy to
451
 */
452
FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
453
454

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

458
459
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
460
	/** initializer containing an ir_node from the const-code irg */
461
	IR_INITIALIZER_CONST,
462
	/** initializer containing a tarval */
463
	IR_INITIALIZER_TARVAL,
464
	/** initializes type with default values (usually 0) */
465
	IR_INITIALIZER_NULL,
466
	/** list of initializers used to initializer a compound or array type */
467
468
469
470
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

/** returns kind of an initializer */
Michael Beck's avatar
Michael Beck committed
471
FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
472

473
/** Return the name of the initializer kind. */
Michael Beck's avatar
Michael Beck committed
474
FIRM_API const char *get_initializer_kind_name(ir_initializer_kind_t ini);
475

476
477
478
/**
 * returns the null initializer (there's only one instance of it in a program )
 */
Michael Beck's avatar
Michael Beck committed
479
FIRM_API ir_initializer_t *get_initializer_null(void);
480
481
482
483
484

/**
 * creates an initializer containing a reference to a node on the const-code
 * irg.
 */
Michael Beck's avatar
Michael Beck committed
485
FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
486
487

/** creates an initializer containing a single tarval value */
Matthias Braun's avatar
Matthias Braun committed
488
FIRM_API ir_initializer_t *create_initializer_tarval(ir_tarval *tv);
489
490

/** return value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
491
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
492
493

/** return value contained in a tarval initializer */
Matthias Braun's avatar
Matthias Braun committed
494
FIRM_API ir_tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
495
496

/** creates a compound initializer which holds @p n_entries entries */
497
FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
498
499

/** returns the number of entries in a compound initializer */
500
FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
501
502

/** sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
503
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
504
                                             size_t index,
505
                                             ir_initializer_t *value);
506
507

/** returns the value with index @p index of a compound initializer */
Michael Beck's avatar
Michael Beck committed
508
FIRM_API ir_initializer_t *get_initializer_compound_value(
509
		const ir_initializer_t *initializer, size_t index);
510

511
/** Sets the new style initializers of an entity. */
Michael Beck's avatar
Michael Beck committed
512
FIRM_API void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);
513

514
/** Returns true, if an entity has new style initializers. */
Michael Beck's avatar
Michael Beck committed
515
FIRM_API int has_entity_initializer(const ir_entity *entity);
516

517
/** Return the new style initializers of an entity. */
Michael Beck's avatar
Michael Beck committed
518
FIRM_API ir_initializer_t *get_entity_initializer(const ir_entity *entity);
519

520
521
522
523
524
525
526
527
528
529
/* --- 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
530
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
531
532
533
534
FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
FIRM_API size_t get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
FIRM_API void set_entity_overwrites(ir_entity *ent, size_t pos, ir_entity *overwritten);
Michael Beck's avatar
Michael Beck committed
535
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
536

537
538
539
540
FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
FIRM_API size_t get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
FIRM_API void set_entity_overwrittenby(ir_entity *ent, size_t pos, ir_entity *overwrites);
Michael Beck's avatar
Michael Beck committed
541
FIRM_API void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
542
543
544
545
546
547
548
549
550

/**
 *   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
551
FIRM_API int is_entity(const void *thing);
552
553
554
555

/** Returns true if the type of the entity is a primitive, pointer
 * enumeration or method type.
 *
yb9976's avatar
yb9976 committed
556
 * @note This is a different classification than from is_primitive_type().
557
 */
Michael Beck's avatar
Michael Beck committed
558
FIRM_API int is_atomic_entity(const ir_entity *ent);
559
560
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
Michael Beck's avatar
Michael Beck committed
561
FIRM_API int is_compound_entity(const ir_entity *ent);
562
/** Returns true if the type of the entity is a Method type. */
Michael Beck's avatar
Michael Beck committed
563
FIRM_API int is_method_entity(const ir_entity *ent);
564
565
566
567
568

/** 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.
 */
Michael Beck's avatar
Michael Beck committed
569
FIRM_API long get_entity_nr(const ir_entity *ent);
570
571

/** Returns the entities visited count. */
Michael Beck's avatar
Michael Beck committed
572
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
573
574

/** Sets the entities visited count. */
Michael Beck's avatar
Michael Beck committed
575
FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
576
577

/** Sets visited field in entity to entity_visited. */
Michael Beck's avatar
Michael Beck committed
578
FIRM_API void mark_entity_visited(ir_entity *ent);
579
580

/** Returns true if this entity was visited. */
Michael Beck's avatar
Michael Beck committed
581
FIRM_API int entity_visited(const ir_entity *ent);
582
583

/** Returns true if this entity was not visited. */
Michael Beck's avatar
Michael Beck committed
584
FIRM_API int entity_not_visited(const ir_entity *ent);
585
586
587
588
589
590
591
592

/**
 * 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().
 */
593
FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
594
595

/** Sets the mask of the additional graph properties. */
Michael Beck's avatar
Michael Beck committed
596
FIRM_API void set_entity_additional_properties(ir_entity *ent,
597
                                               mtp_additional_properties prop);
598

599
600
601
/** Sets additional graph properties. */
FIRM_API void add_entity_additional_properties(ir_entity *ent,
                                               mtp_additional_properties flag);
602
603
604

/** Returns the class type that this type info entity represents or NULL
    if ent is no type info entity. */
Michael Beck's avatar
Michael Beck committed
605
FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
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
631
632
633
634
635
636
637
638

/**
 * @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
 * - offset        = -1
 * - value         = SymConst(unknown_entity)
 * - values        = NULL
 * - val_paths     = NULL
 * - volatility    = volatility_non_volatile
 * - stickyness    = stickyness_unsticky
 * - ld_name       = NULL
 * - overwrites    = NULL
 * - overwrittenby = NULL
 * - irg           = NULL
 * - link          = NULL
 */
639
640

/** A variable that contains the only unknown entity. */
Michael Beck's avatar
Michael Beck committed
641
FIRM_API ir_entity *unknown_entity;
642
643

/** Returns the @link unknown_entity unknown entity @endlink. */
Michael Beck's avatar
Michael Beck committed
644
FIRM_API ir_entity *get_unknown_entity(void);
645
646

/** Encodes how a pointer parameter is accessed. */
647
typedef enum ptr_access_kind {
Michael Beck's avatar
Michael Beck committed
648
649
650
651
652
653
	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 */
654
} ptr_access_kind;
655
ENUM_BITSET(ptr_access_kind)
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684

#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. */
685
	tpo_code,                /**< a piece of code (a basic block) */
686
687
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
688
	tpo_last = tpo_unknown   /* not a type opcode */
689
690
691
692
693
694
695
696
} 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.
 *
697
 * @see  get_tpop_name(), get_tpop_code()
698
699
700
701
702
703
704
705
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
706
 * @return    a string.
707
 */
Michael Beck's avatar
Michael Beck committed
708
FIRM_API const char *get_tpop_name(const tp_op *op);
709
710
711
712
713
714
715

/**
 * 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
716
FIRM_API tp_opcode get_tpop_code(const tp_op *op);
717
718
719
720
721
722
723
724
725
726

/**
 * 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
727
728
FIRM_API const tp_op *type_class;
FIRM_API const tp_op *get_tpop_class(void);
729
730
731
732
733
734
735
736
737
738

/**
 * 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
739
740
FIRM_API const tp_op *type_struct;
FIRM_API const tp_op *get_tpop_struct(void);
741
742
743
744
745
746
747
748

/**
 * 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
749
750
FIRM_API const tp_op *type_method;
FIRM_API const tp_op *get_tpop_method(void);
751
752
753
754
755
756
757
758

/**
 * 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
759
760
FIRM_API const tp_op *type_union;
FIRM_API const tp_op *get_tpop_union(void);
761
762
763
764
765
766
767
768
769

/**
 * 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
770
771
FIRM_API const tp_op *type_array;
FIRM_API const tp_op *get_tpop_array(void);
772
773
774
775
776
777
778
779
780
781

/**
 * 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
782
783
FIRM_API const tp_op *type_enumeration;
FIRM_API const tp_op *get_tpop_enumeration(void);
784
785
786
787
788
789
790
791

/**
 * 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
792
793
FIRM_API const tp_op *type_pointer;
FIRM_API const tp_op *get_tpop_pointer(void);
794
795
796
797
798
799
800
801
802

/**
 * 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
803
804
FIRM_API const tp_op *type_primitive;
FIRM_API const tp_op *get_tpop_primitive(void);
805

806
807
808
/**
 * The code type is used to mark pieces of code (basic blocks)
 */
Michael Beck's avatar
Michael Beck committed
809
810
FIRM_API const tp_op *tpop_code;
FIRM_API const tp_op *get_tpop_code_type(void);
811

812
813
814
815
816
817
818
819
/**
 * 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
820
821
FIRM_API const tp_op *tpop_none;
FIRM_API const tp_op *get_tpop_none(void);
822
823
824
825
826
827
828
829
830

/**
 * 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
831
832
FIRM_API const tp_op *tpop_unknown;
FIRM_API const tp_op *get_tpop_unknown(void);
833
834
835
836
837
838
839
840
841
842
843

/* ----------------------------------------------------------------------- */
/* 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.  */
Michael Beck's avatar
Michael Beck committed
844
FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
845
846
847
848
849
850
851

/** 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.  */
Michael Beck's avatar
Michael Beck committed
852
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872

/** 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. */
Michael Beck's avatar
Michael Beck committed
873
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
874
875
876
877
878
879

/** 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. */
Michael Beck's avatar
Michael Beck committed
880
FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
881
                                           ir_entity* static_ent);
882
883
884
885
886
887
888
889
890

/* ----------------------------------------------------------------------- */
/* 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
891
FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
892
                                              const ir_type *clss);
893
894
895
896
897
898
899
900

/** 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.
 */
901
902
typedef ident *mangle_inherited_name_func(const ir_entity *ent,
                                          const ir_type *clss);
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917

/** 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.
 */
Michael Beck's avatar
Michael Beck committed
918
FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935


/* ----------------------------------------------------------------------- */
/* 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!                     */
/* ----------------------------------------------------------------------- */

936
937
938
/**
 * The state of the transitive closure.
 */
939
940
941
942
943
944
945
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;

Michael Beck's avatar
Michael Beck committed
946
947
948
FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
949
950
951
952
953


/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
954
 * This function walks over the ir (O(\#types+\#entities)) to compute the
955
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
956
FIRM_API void compute_inh_transitive_closure(void);
957
958

/** Free memory occupied by the transitive closure information. */
Michael Beck's avatar
Michael Beck committed
959
FIRM_API void free_inh_transitive_closure(void);
960
961
962
963
964


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

/** Iterate over all transitive subtypes. */
Michael Beck's avatar
Michael Beck committed
965
966
967
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
968
969
970
971

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

/** Iterate over all transitive supertypes. */
Michael Beck's avatar
Michael Beck committed
972
973
FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
974
975
976
977

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

/** Iterate over all entities that transitive overwrite this entities. */
Michael Beck's avatar
Michael Beck committed
978
979
FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
980
981
982
983

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

/** Iterate over all transitive overwritten entities. */
Michael Beck's avatar
Michael Beck committed
984
985
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
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
1013
1014
1015
1016
1017
1018
1019
1020
1021


/* ----------------------------------------------------------------------- */
/** 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
1022
FIRM_API const char *get_class_cast_state_string(ir_class_cast_state s);
1023

Michael Beck's avatar
Michael Beck committed
1024
FIRM_API void                set_irg_class_cast_state(ir_graph *irg,
1025
                                                      ir_class_cast_state s);
Michael Beck's avatar
Michael Beck committed
1026
1027
1028
FIRM_API ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
FIRM_API void                set_irp_class_cast_state(ir_class_cast_state s);
FIRM_API ir_class_cast_state get_irp_class_cast_state(void);
1029
1030
1031

/** Verify the class cast state of an irg.
 *
Michael Beck's avatar
Michael Beck committed
1032
 *  Asserts if state is to high, outputs debug warning if state is to low
1033
1034
 *  and firm verbosity is set.
 */
Michael Beck's avatar
Michael Beck committed
1035
FIRM_API void verify_irg_class_cast_state(ir_graph *irg);
1036
1037

/**
1038
 * possible trverify() error codes
1039
 */
1040
enum trverify_error_codes {
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
	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
 */
Michael Beck's avatar
Michael Beck committed
1059
FIRM_API int check_type(ir_type *tp);
1060
1061
1062
1063
1064
1065
1066

/**
 * Check an entity. Currently, we check only if initialized constants
 * are build on the const irg graph.
 *
 * @return
 *  0   if no error encountered
1067
 *  != 0    a trverify_error_codes code
1068
 */
Michael Beck's avatar
Michael Beck committed
1069
FIRM_API int check_entity(ir_entity *ent);
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082

/**
 * 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.
 */
1083
FIRM_API int tr_verify(void);
1084

Sebastian Felis's avatar
Sebastian Felis committed
1085
/**
1086
 * @page type   representation of types
Michael Beck's avatar
Michael Beck committed
1087
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
1088
 *  Datastructure to hold type information.
1089
1090
1091
1092
1093
 *
 *  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
1094
 *  between these types.  Finally it specifies some auxiliary types.
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 *
 *  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
1106
1107
1108
1109
/** 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
1110
FIRM_API void free_type_entities(ir_type *tp);
1111

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1112
1113
1114
1115
1116
1117
/** 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
1118
1119
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
Michael Beck's avatar
Michael Beck committed
1120
FIRM_API void free_type(ir_type *tp);
1121

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

1127
1128
1129
1130
1131
1132
1133
1134
1135
/**
 * construct a string representing the type.
 * This uses the info retrieved by the type_dbg_info if available.
 * Otherwise it tries to create an approximate textual representation of the
 * type.
 * Keep in mind that this representation is not unique for each type,
 * might abstract away some details. The main intention of this is creating
 * human redable strings giving an idea of the type.
 */
Michael Beck's avatar
Michael Beck committed
1136
FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1137
                            const ir_type *tp);
1138

1139
/** The state of the type layout. */
1140
typedef enum {
Michael Beck's avatar
Michael Beck committed
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
	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. */
1152
} ir_type_state;
1153

Götz Lindenmaier's avatar
Götz Lindenmaier committed
1154
/** Returns a human readable string for the enum entry. */
Michael Beck's avatar
Michael Beck committed
1155
FIRM_API const char *get_type_state_name(ir_type_state s);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1156

1157
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
1158
FIRM_API ir_type_state get_type_state(const ir_type *tp);
1159
1160
1161
1162
1163
1164

/** 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
1165
FIRM_API void set_type_state(ir_type *tp, ir_type_state state);
1166

1167
1168
1169
1170
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
1171
FIRM_API ir_mode *get_type_mode(const ir_type *tp);
1172
1173
1174

/** Sets the mode of a type.
 *
1175
 * Only has an effect on primitive, enumeration and pointer types.
1176
 */
Michael Beck's avatar
Michael Beck committed
1177
FIRM_API void set_type_mode(ir_type *tp, ir_mode* m);
1178

1179
/** Returns the size of a type in bytes. */
Michael Beck's avatar
Michael Beck committed
1180
FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
1181
1182
1183
1184
1185
1186

/** 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.
 */
Michael Beck's avatar
Michael Beck committed
1187
FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
1188

Matthias Braun's avatar
Matthias Braun committed
1189
/** Returns the alignment of a type in bytes. */
Michael Beck's avatar
Michael Beck committed
1190
FIRM_API unsigned get_type_alignment_bytes(ir_type *tp);
1191

1192
1193
1194
1195
/** 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
1196
1197
1198
1199
 *  -#.) 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.
1200
 *  -#.) all other types return 1 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed