typerep.h 93 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
#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 {
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
152
153
} ir_linkage;

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

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

/**
164
165
166
167
168
169
 * 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
170
 */
Michael Beck's avatar
Michael Beck committed
171
FIRM_API int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
172
173

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

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

/**
 * 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
199
FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
200
                                 dbg_info *db);
201
202
203
204
205
206
207
208
209

/**
 * 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
210
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
211
212
213
214
215
216
217
218
219

/**
 * 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
220
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
221
222
223
224
225
226
227

/**
 * 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
228
FIRM_API void free_entity(ir_entity *ent);
229
230

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

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
234
FIRM_API ident *get_entity_ident(const ir_entity *ent);
235
236

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
237
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
238
239
240
241
242
243
244

/** 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
245
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
246
247

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

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

/** Returns the owner of the entity. */
Michael Beck's avatar
Michael Beck committed
254
FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
255
256
257

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
269
/** Sets the linkage of an entity. */
Michael Beck's avatar
Michael Beck committed
270
271
272
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);
273

Matthias Braun's avatar
Matthias Braun committed
274
/** Returns 1 if the value of a global symbol never changes in a program */
Michael Beck's avatar
Michael Beck committed
275
FIRM_API int is_entity_constant(const ir_entity *ent);
276

Matthias Braun's avatar
Matthias Braun committed
277
278
279
280
/**
 * This enumeration flags the volatility of entities and Loads/Stores.
 * @deprecated
 */
281
typedef enum {
Michael Beck's avatar
Michael Beck committed
282
283
	volatility_non_volatile,    /**< The entity is not volatile. Default. */
	volatility_is_volatile      /**< The entity is volatile. */
284
285
} ir_volatility;

Matthias Braun's avatar
Matthias Braun committed
286
287
288
289
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
290
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
291

Matthias Braun's avatar
Matthias Braun committed
292
293
294
295
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
296
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
297
298

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

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

Matthias Braun's avatar
Matthias Braun committed
304
/** Allows you to override the type alignment for an entity.
305
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
306
307
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
308
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
309

Matthias Braun's avatar
Matthias Braun committed
310
311
312
313
314

/**
 * This enumeration flags the align of Loads/Stores.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
315
316
317
318
319
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
320
321
322
323
/**
 * Returns indication wether entity is aligned in memory.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
324
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
325

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

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

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

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

/** 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
342
FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
343
344

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

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

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

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

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

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

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

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

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

377
/**
378
 * Bitfield type indicating the way an entity is used.
379
380
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
381
382
383
384
385
386
387
	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 */
388
389
390
391
392
393
	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
394
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
395
396

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

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

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

414
415
416
417
418
419
420
421
/* -- 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
422
FIRM_API int is_irn_const_expression(ir_node *n);
423
424
425
426
427
428
429
430
431
432
433

/**
 * 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.
 */
Michael Beck's avatar
Michael Beck committed
434
FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
435
436

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

440
441
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
442
	/** initializer containing an ir_node from the const-code irg */
443
	IR_INITIALIZER_CONST,
444
	/** initializer containing a tarval */
445
	IR_INITIALIZER_TARVAL,
446
	/** initializes type with default values (usually 0) */
447
	IR_INITIALIZER_NULL,
448
	/** list of initializers used to initializer a compound or array type */
449
450
451
452
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

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

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

458
459
460
/**
 * returns the null initializer (there's only one instance of it in a program )
 */
Michael Beck's avatar
Michael Beck committed
461
FIRM_API ir_initializer_t *get_initializer_null(void);
462
463
464
465
466

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

/** creates an initializer containing a single tarval value */
Michael Beck's avatar
Michael Beck committed
470
FIRM_API ir_initializer_t *create_initializer_tarval(tarval *tv);
471
472

/** return value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
473
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
474
475

/** return value contained in a tarval initializer */
Michael Beck's avatar
Michael Beck committed
476
FIRM_API tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
477
478

/** creates a compound initializer which holds @p n_entries entries */
Michael Beck's avatar
Michael Beck committed
479
FIRM_API ir_initializer_t *create_initializer_compound(unsigned n_entries);
480
481

/** returns the number of entries in a compound initializer */
Michael Beck's avatar
Michael Beck committed
482
FIRM_API unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer);
483
484

/** sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
485
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
486
487
                                             unsigned index,
                                             ir_initializer_t *value);
488
489

/** returns the value with index @p index of a compound initializer */
Michael Beck's avatar
Michael Beck committed
490
FIRM_API ir_initializer_t *get_initializer_compound_value(
491
492
		const ir_initializer_t *initializer, unsigned index);

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

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

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

502
503
504
505
506
507
508
509
510
511
/* --- 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
512
513
514
515
516
517
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
FIRM_API int get_entity_n_overwrites(const ir_entity *ent);
FIRM_API int get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, int pos);
FIRM_API void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
518

Michael Beck's avatar
Michael Beck committed
519
520
521
522
523
FIRM_API int get_entity_n_overwrittenby(const ir_entity *ent);
FIRM_API int get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, int pos);
FIRM_API void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
FIRM_API void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
524
525
526
527
528
529
530
531
532

/**
 *   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
533
FIRM_API int is_entity(const void *thing);
534
535
536
537

/** Returns true if the type of the entity is a primitive, pointer
 * enumeration or method type.
 *
yb9976's avatar
yb9976 committed
538
 * @note This is a different classification than from is_primitive_type().
539
 */
Michael Beck's avatar
Michael Beck committed
540
FIRM_API int is_atomic_entity(const ir_entity *ent);
541
542
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
Michael Beck's avatar
Michael Beck committed
543
FIRM_API int is_compound_entity(const ir_entity *ent);
544
/** Returns true if the type of the entity is a Method type. */
Michael Beck's avatar
Michael Beck committed
545
FIRM_API int is_method_entity(const ir_entity *ent);
546
547
548
549
550

/** 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
551
FIRM_API long get_entity_nr(const ir_entity *ent);
552
553

/** Returns the entities visited count. */
Michael Beck's avatar
Michael Beck committed
554
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
555
556

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

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

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

/** Returns true if this entity was not visited. */
Michael Beck's avatar
Michael Beck committed
566
FIRM_API int entity_not_visited(const ir_entity *ent);
567
568
569
570
571
572
573
574

/**
 * 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().
 */
Michael Beck's avatar
Michael Beck committed
575
FIRM_API unsigned get_entity_additional_properties(const ir_entity *ent);
576
577

/** Sets the mask of the additional graph properties. */
Michael Beck's avatar
Michael Beck committed
578
FIRM_API void set_entity_additional_properties(ir_entity *ent,
579
                                               unsigned property_mask);
580
581

/** Sets one additional graph property. */
Michael Beck's avatar
Michael Beck committed
582
FIRM_API void set_entity_additional_property(ir_entity *ent,
583
                                             mtp_additional_property flag);
584
585
586

/** 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
587
FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
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

/**
 * @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
 */
621
622

/** A variable that contains the only unknown entity. */
Michael Beck's avatar
Michael Beck committed
623
FIRM_API ir_entity *unknown_entity;
624
625

/** Returns the @link unknown_entity unknown entity @endlink. */
Michael Beck's avatar
Michael Beck committed
626
FIRM_API ir_entity *get_unknown_entity(void);
627
628
629

/** Encodes how a pointer parameter is accessed. */
typedef enum acc_bits {
Michael Beck's avatar
Michael Beck committed
630
631
632
633
634
635
	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 */
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
} 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. */
666
	tpo_code,                /**< a piece of code (a basic block) */
667
668
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
669
	tpo_last = tpo_unknown   /* not a type opcode */
670
671
672
673
674
675
676
677
} 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.
 *
678
 * @see  get_tpop_name(), get_tpop_code()
679
680
681
682
683
684
685
686
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
687
 * @return    a string.
688
 */
Michael Beck's avatar
Michael Beck committed
689
FIRM_API const char *get_tpop_name(const tp_op *op);
690
691
692
693
694
695
696

/**
 * 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
697
FIRM_API tp_opcode get_tpop_code(const tp_op *op);
698
699
700
701
702
703
704
705
706
707

/**
 * 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
708
709
FIRM_API const tp_op *type_class;
FIRM_API const tp_op *get_tpop_class(void);
710
711
712
713
714
715
716
717
718
719

/**
 * 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
720
721
FIRM_API const tp_op *type_struct;
FIRM_API const tp_op *get_tpop_struct(void);
722
723
724
725
726
727
728
729

/**
 * 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
730
731
FIRM_API const tp_op *type_method;
FIRM_API const tp_op *get_tpop_method(void);
732
733
734
735
736
737
738
739

/**
 * 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
740
741
FIRM_API const tp_op *type_union;
FIRM_API const tp_op *get_tpop_union(void);
742
743
744
745
746
747
748
749
750

/**
 * 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
751
752
FIRM_API const tp_op *type_array;
FIRM_API const tp_op *get_tpop_array(void);
753
754
755
756
757
758
759
760
761
762

/**
 * 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
763
764
FIRM_API const tp_op *type_enumeration;
FIRM_API const tp_op *get_tpop_enumeration(void);
765
766
767
768
769
770
771
772

/**
 * 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
773
774
FIRM_API const tp_op *type_pointer;
FIRM_API const tp_op *get_tpop_pointer(void);
775
776
777
778
779
780
781
782
783

/**
 * 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
784
785
FIRM_API const tp_op *type_primitive;
FIRM_API const tp_op *get_tpop_primitive(void);
786

787
788
789
/**
 * The code type is used to mark pieces of code (basic blocks)
 */
Michael Beck's avatar
Michael Beck committed
790
791
FIRM_API const tp_op *tpop_code;
FIRM_API const tp_op *get_tpop_code_type(void);
792

793
794
795
796
797
798
799
800
/**
 * 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
801
802
FIRM_API const tp_op *tpop_none;
FIRM_API const tp_op *get_tpop_none(void);
803
804
805
806
807
808
809
810
811

/**
 * 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
812
813
FIRM_API const tp_op *tpop_unknown;
FIRM_API const tp_op *get_tpop_unknown(void);
814
815
816
817
818
819
820
821
822
823
824

/* ----------------------------------------------------------------------- */
/* 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
825
FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
826
827
828
829
830
831
832

/** 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
833
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853

/** 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
854
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
855
856
857
858
859
860

/** 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
861
FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
862
                                           ir_entity* static_ent);
863
864
865
866
867
868
869
870
871

/* ----------------------------------------------------------------------- */
/* 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
872
FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
873
                                              const ir_type *clss);
874
875
876
877
878
879
880
881

/** 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.
 */
882
883
typedef ident *mangle_inherited_name_func(const ir_entity *ent,
                                          const ir_type *clss);
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898

/** 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
899
FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916


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

917
918
919
/**
 * The state of the transitive closure.
 */
920
921
922
923
924
925
926
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
927
928
929
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);
930
931
932
933
934


/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
935
 * This function walks over the ir (O(\#types+\#entities)) to compute the
936
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
937
FIRM_API void compute_inh_transitive_closure(void);
938
939

/** Free memory occupied by the transitive closure information. */
Michael Beck's avatar
Michael Beck committed
940
FIRM_API void free_inh_transitive_closure(void);
941
942
943
944
945


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

/** Iterate over all transitive subtypes. */
Michael Beck's avatar
Michael Beck committed
946
947
948
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);
949
950
951
952

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

/** Iterate over all transitive supertypes. */
Michael Beck's avatar
Michael Beck committed
953
954
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);
955
956
957
958

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

/** Iterate over all entities that transitive overwrite this entities. */
Michael Beck's avatar
Michael Beck committed
959
960
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);
961
962
963
964

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

/** Iterate over all transitive overwritten entities. */
Michael Beck's avatar
Michael Beck committed
965
966
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);
967
968
969
970
971
972
973
974
975
976
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


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

Michael Beck's avatar
Michael Beck committed
1005
FIRM_API void                set_irg_class_cast_state(ir_graph *irg,
1006
                                                      ir_class_cast_state s);
Michael Beck's avatar
Michael Beck committed
1007
1008
1009
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);
1010
1011
1012

/** Verify the class cast state of an irg.
 *
Michael Beck's avatar
Michael Beck committed
1013
 *  Asserts if state is to high, outputs debug warning if state is to low
1014
1015
 *  and firm verbosity is set.
 */
Michael Beck's avatar
Michael Beck committed
1016
FIRM_API void verify_irg_class_cast_state(ir_graph *irg);
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039

/**
 * 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
 */
Michael Beck's avatar
Michael Beck committed
1040
FIRM_API int check_type(ir_type *tp);
1041
1042
1043
1044
1045
1046
1047
1048
1049

/**
 * 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
 */
Michael Beck's avatar
Michael Beck committed
1050
FIRM_API int check_entity(ir_entity *ent);
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063

/**
 * 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.
 */
Michael Beck's avatar
Michael Beck committed
1064
FIRM_API int tr_vrfy(void);
1065

Sebastian Felis's avatar
Sebastian Felis committed
1066
/**
1067
 * @page type   representation of types
Michael Beck's avatar
Michael Beck committed
1068
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
1069
 *  Datastructure to hold type information.
1070
1071
1072
1073
1074
 *
 *  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
1075
 *  between these types.  Finally it specifies some auxiliary types.
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 *
 *  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
1087
1088
1089
1090
/** 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
1091
FIRM_API void free_type_entities(ir_type *tp);
1092

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1093
1094
1095
1096
1097
1098
/** 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
1099
1100
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
Michael Beck's avatar
Michael Beck committed
1101
FIRM_API void free_type(ir_type *tp);
1102

Michael Beck's avatar
Michael Beck committed
1103
1104
1105
1106
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);
1107

1108
1109
1110
1111
1112
1113
1114
1115
1116
/**
 * 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
1117
FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1118
                            const ir_type *tp);
1119

1120
/** The state of the type layout. */
1121
typedef enum {
Michael Beck's avatar
Michael Beck committed
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
	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. */
1133
} ir_type_state;
1134

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

1138
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
1139
FIRM_API ir_type_state get_type_state(const ir_type *tp);
1140
1141
1142
1143
1144
1145

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

1148
1149
1150
1151
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
1152
FIRM_API ir_mode *get_type_mode(const ir_type *tp);
1153
1154
1155

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

1160
/** Returns the size of a type in bytes. */
Michael Beck's avatar
Michael Beck committed
1161
FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
1162
1163
1164
1165
1166
1167

/** 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
1168
FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
1169

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

1173
1174
1175
1176
/** 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
1177
1178
1179
1180
 *  -#.) 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.
1181
 *  -#.) all other types return 1 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed
1182
 */
Michael Beck's avatar
Michael Beck committed
1183
FIRM_API void set_type_alignment_bytes(ir_type *tp, unsigned align);
Michael Beck's avatar
Michael Beck committed
1184

Michael Beck's avatar
Michael Beck committed
1185
/** Returns the visited count of a type. */
Michael Beck's avatar
Michael Beck committed
1186
FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1187
/** Sets the visited count of a type to num. */
Michael Beck's avatar
Michael Beck committed
1188
FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
Michael Beck's avatar
Michael Beck committed
1189
/** Sets visited field in type to type_visited. */
Michael Beck's avatar
Michael Beck committed
1190
FIRM_API void mark_type_visited(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1191
/** Returns non-zero if the type is already visited */
Michael Beck's avatar
Michael Beck committed
1192
FIRM_API int type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1193
/** Returns non-zero if the type is not yet visited */
Michael Beck's avatar
Michael Beck committed
1194
FIRM_API int type_not_visited(const ir_type *tp);
1195

Michael Beck's avatar
Michael Beck committed
1196
/** Returns the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
1197
FIRM_API void *get_type_link(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1198
/** Sets the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
1199
FIRM_API void set_type_link(ir_type *tp, void *l);
1200

Sebastian Felis's avatar
Sebastian Felis committed
1201
/**
1202
1203
 * Visited flag to traverse the type information.
 *
1204
1205
 * Increase this flag by one before traversing the type information
 * using inc_master_type_visited().
1206
1207
1208
 * 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).