typerep.h 85.4 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

/**
Matthias Braun's avatar
Matthias Braun committed
33
 * @defgroup ir_entity Entities
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 *
 * 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
 *   - 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.
 *
76
77
78
79
80
81
82
83
84
85
 * 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.
 *
Matthias Braun's avatar
Matthias Braun committed
86
 * @{
87
88
 */

89
90
91
92
93
/**
 * Visibility classed for entities.
 */
typedef enum {
	/**
Matthias Braun's avatar
Matthias Braun committed
94
95
	 * The entity is visible across compilation units. It might have an
	 * initializer/graph.
96
97
98
	 * Note that entities with visibility_external without initializer are
	 * assumed to be defined in another compilation unit (not like C variables
	 * which are considered 'uninitialized' in this case).
99
	 */
Matthias Braun's avatar
Matthias Braun committed
100
	ir_visibility_external,
101
102
103
104
105
106
107
108
	/**
	 * 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,
	/**
Matthias Braun's avatar
Matthias Braun committed
109
110
	 * This has the same semantic as visibility_local. Additionally the symbol
	 * is completely hidden from the linker (it only appears in the assembly).
111
112
113
114
	 * While visibility_local is probably still visible to debuggers,
	 * visibility_private symbols aren't and probably won't appear in the object
	 * files
	 */
Matthias Braun's avatar
Matthias Braun committed
115
	ir_visibility_private,
116
117
} ir_visibility;

Matthias Braun's avatar
Matthias Braun committed
118
119
/**
 * linkage specifies how the linker treats symbols
120
 */
121
typedef enum ir_linkage {
122
	IR_LINKAGE_DEFAULT         = 0,
Matthias Braun's avatar
Matthias Braun committed
123
124
125
126
127
128
	/**
	 * 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.
	 */
129
	IR_LINKAGE_CONSTANT        = 1 << 0,
Matthias Braun's avatar
Matthias Braun committed
130
131
132
133
134
135
	/**
	 * 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.
	 */
136
	IR_LINKAGE_WEAK            = 1 << 1,
Matthias Braun's avatar
Matthias Braun committed
137
138
139
140
141
	/**
	 * 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).
	 */
142
	IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
143
144
145
146
147
148
	/**
	 * 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)
	 */
149
	IR_LINKAGE_MERGE           = 1 << 3,
Matthias Braun's avatar
Matthias Braun committed
150
151
152
153
154
155
156
157
	/**
	 * 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.
	 */
158
159
160
161
162
163
164
165
166
	IR_LINKAGE_HIDDEN_USER     = 1 << 4,
	/**
	 * Do not generate code even if the entity has a graph attached. The graph
	 * is only used for inlining. Otherwise the entity is regarded as a
	 * declaration of an externally defined entity.
	 * This linkage flag can be used to implement C99 "inline" or GNU89
	 * "extern inline".
	 */
	IR_LINKAGE_NO_CODEGEN      = 1 << 5,
Matthias Braun's avatar
Matthias Braun committed
167
} ir_linkage;
168
ENUM_BITSET(ir_linkage)
Matthias Braun's avatar
Matthias Braun committed
169
170

/**
171
 * Returns the visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
172
 */
Michael Beck's avatar
Michael Beck committed
173
FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
174
175

/**
176
 * Sets visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
177
 */
Michael Beck's avatar
Michael Beck committed
178
FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
Matthias Braun's avatar
Matthias Braun committed
179
180

/**
181
 * Returns 1 if the entity is visible outside the current compilation unit
182
183
184
185
186
 * 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
187
 */
Michael Beck's avatar
Michael Beck committed
188
FIRM_API int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
189
190

/**
191
 * Returns 1 if the entity has a definition (initializer) in the current
192
193
 * compilation unit. Note that this function returns false if
 * IR_LINKAGE_NO_CODEGEN is set even if a graph is present.
Matthias Braun's avatar
Matthias Braun committed
194
 */
Michael Beck's avatar
Michael Beck committed
195
FIRM_API int entity_has_definition(const ir_entity *entity);
196
197
198
199
200
201
202
203
204
205

/**
 * 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
206
FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
207
208
209
210
211
212
213
214
215
216

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

220
221
222
223
224
225
226
227
228
229
230
231
232
/**
 * 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);

Matthias Braun's avatar
Matthias Braun committed
233
234
235
236
/**
 * Check an entity. Currently, we check only if initialized constants
 * are build on the const irg graph.
 *
237
 * @return non-zero if no errors were found
Matthias Braun's avatar
Matthias Braun committed
238
 */
239
FIRM_API int check_entity(const ir_entity *ent);
Matthias Braun's avatar
Matthias Braun committed
240

241
242
243
244
245
246
247
248
/**
 * 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
249
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
250
251
252
253
254
255
256
257
258

/**
 * 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
259
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
260
261
262
263
264
265
266

/**
 * 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
267
FIRM_API void free_entity(ir_entity *ent);
268
269

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

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
273
FIRM_API ident *get_entity_ident(const ir_entity *ent);
274
275

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
276
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
277
278
279
280
281
282
283

/** 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
284
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
285
286

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

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

292
293
294
/** returns 1 if the entity has an ld_ident set explicitely */
FIRM_API int entity_has_ld_ident(const ir_entity *entity);

295
/** Returns the owner of the entity. */
Michael Beck's avatar
Michael Beck committed
296
FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
297

298
299
300
301
302
/**
 * 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
303
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
304
305

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

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

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

314
/** Sets the linkage flags of entity @p entity to @p linkage. */
Michael Beck's avatar
Michael Beck committed
315
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
316
/** Adds linkage flags @p linkage to entity @p entity. */
Michael Beck's avatar
Michael Beck committed
317
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
318
/** Remove linkage flags @p linkage from entity @p entity. */
Michael Beck's avatar
Michael Beck committed
319
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
320

Matthias Braun's avatar
Matthias Braun committed
321
322
323
324
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
325
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
326

Matthias Braun's avatar
Matthias Braun committed
327
328
329
330
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
331
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
332

333
/** Returns the name of the volatility. */
Michael Beck's avatar
Michael Beck committed
334
FIRM_API const char *get_volatility_name(ir_volatility var);
335

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

Matthias Braun's avatar
Matthias Braun committed
339
/** Allows you to override the type alignment for an entity.
340
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
341
342
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
343
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
344

Matthias Braun's avatar
Matthias Braun committed
345
/**
346
 * Returns indication whether entity is aligned in memory.
Matthias Braun's avatar
Matthias Braun committed
347
348
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
349
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
350

Matthias Braun's avatar
Matthias Braun committed
351
/**
352
 * Sets indication whether entity is aligned in memory
Matthias Braun's avatar
Matthias Braun committed
353
354
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
355
FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
356

357
/** Returns the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
358
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
359

360
361
/** Returns the offset of an entity (in a compound) in bytes. Only set if
 * layout = fixed. */
Michael Beck's avatar
Michael Beck committed
362
FIRM_API int get_entity_offset(const ir_entity *ent);
363
364

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

367
368
/** 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
369
FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
370
371

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

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
376
FIRM_API void *get_entity_link(const ir_entity *ent);
377
378

/** Stores new intermediate information. */
Michael Beck's avatar
Michael Beck committed
379
FIRM_API void set_entity_link(ir_entity *ent, void *l);
380

381
382
383
384
/**
 * The entity knows the corresponding irg if the entity is a method.
 * This allows to get from a Call to the called irg.
 */
Michael Beck's avatar
Michael Beck committed
385
FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
386

387
388
389
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

390
/** Returns the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
391
FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
392
393

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

396
/** Sets label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
397
FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
398
/** Returns label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
399
FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
400

401
/** Checks if an entity is compiler generated. */
Michael Beck's avatar
Michael Beck committed
402
FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
403
404

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

407
/**
408
 * Bitfield type indicating the way an entity is used.
409
410
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
411
412
413
414
415
416
417
	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 */
418
419
420
421
422
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

423
/** Returns the entity usage */
Michael Beck's avatar
Michael Beck committed
424
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
425
426

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

429
430
431
432
433
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
Michael Beck's avatar
Michael Beck committed
434
FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
435
436
437
438
439
440
441

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

444
445
446
447
448
449
450
451
/**
 * Sepcial parameter number which can be used for parameter entities to
 * indicate the first non-declared parameter in a procedure with variable
 * arguments.
 * We assumes that all additional parameters for variable parameters are on the
 * stack. Starting from this address you can walk the stack to find all other
 * parameters.
 */
452
453
#define IR_VA_START_PARAMETER_NUMBER  ((size_t)-1)

454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
/**
 * 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);

470
471
472
473
474
475
476
/**
 * 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
477
FIRM_API int is_irn_const_expression(ir_node *n);
478
479
480

/**
 * Copies a Firm subgraph that complies to the restrictions for
481
 * constant expressions to block.
482
 *
Matthias Braun's avatar
Matthias Braun committed
483
484
485
 * @param dbg       debug info for all newly created nodes
 * @param n         the node
 * @param to_block  block to copy to
486
 */
487
FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
488

489
/** Returns initial value of entity with atomic type @p ent. */
490
FIRM_API ir_node *get_atomic_ent_value(const ir_entity *ent);
491
492
/** Sets initial value of entity with atomic type @p ent to node @p val.
 * @note @p val must be a node in the const_code graph */
Michael Beck's avatar
Michael Beck committed
493
FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
494

Matthias Braun's avatar
Matthias Braun committed
495
496
497
498
/** @defgroup ir_initializer  Entity Initializers
 * @{
 */

499
500
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
501
	/** initializer containing an ir_node from the const-code irg */
502
	IR_INITIALIZER_CONST,
503
	/** initializer containing a tarval */
504
	IR_INITIALIZER_TARVAL,
505
	/** initializes type with default values (usually 0) */
506
	IR_INITIALIZER_NULL,
507
	/** list of initializers used to initializer a compound or array type */
508
509
510
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

511
/** Returns kind of an initializer */
Michael Beck's avatar
Michael Beck committed
512
FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
513

514
/** Returns the name of the initializer kind. */
Michael Beck's avatar
Michael Beck committed
515
FIRM_API const char *get_initializer_kind_name(ir_initializer_kind_t ini);
516

517
/**
518
 * Returns the null initializer (there's only one instance of it in a program )
519
 */
Michael Beck's avatar
Michael Beck committed
520
FIRM_API ir_initializer_t *get_initializer_null(void);
521
522

/**
523
 * Creates an initializer containing a reference to a node on the const-code
524
525
 * irg.
 */
Michael Beck's avatar
Michael Beck committed
526
FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
527

528
/** Creates an initializer containing a single tarval value */
Matthias Braun's avatar
Matthias Braun committed
529
FIRM_API ir_initializer_t *create_initializer_tarval(ir_tarval *tv);
530

531
/** Returns value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
532
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
533

534
/** Returns value contained in a tarval initializer */
Matthias Braun's avatar
Matthias Braun committed
535
FIRM_API ir_tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
536

537
/** Creates a compound initializer which holds @p n_entries entries */
538
FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
539

540
/** Returns the number of entries in a compound initializer */
541
FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
542

543
/** Sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
544
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
545
                                             size_t index,
546
                                             ir_initializer_t *value);
547

548
/** Returns the value with index @p index of a compound initializer */
Michael Beck's avatar
Michael Beck committed
549
FIRM_API ir_initializer_t *get_initializer_compound_value(
550
		const ir_initializer_t *initializer, size_t index);
551

Matthias Braun's avatar
Matthias Braun committed
552
553
/** @} */

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

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

560
/** Returns the new style initializers of an entity. */
Michael Beck's avatar
Michael Beck committed
561
FIRM_API ir_initializer_t *get_entity_initializer(const ir_entity *entity);
562

563
/** Adds entity @p ent to the list of entities that overwrite @p overwritten. */
Michael Beck's avatar
Michael Beck committed
564
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
565
566
/** Returns the number of entities in the list of entities that overwrite
 * entity @p ent. */
567
FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
568
569
570
571
572
/** Returns index of @p overwritten in list of entities overwriting entity
 * @p ent. */
FIRM_API size_t get_entity_overwrites_index(const ir_entity *ent,
                                            ir_entity *overwritten);
/** Returns entry @p pos in list of entities overwriting entity @p ent. */
573
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
574
575
576
577
/** Sets entry @p pos in list of entities overwriting entity @p ent. */
FIRM_API void set_entity_overwrites(ir_entity *ent, size_t pos,
                                    ir_entity *overwritten);
/** Remove @p overwritten from list of entities overwriting entity @p ent. */
Michael Beck's avatar
Michael Beck committed
578
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
579

580
/** Returns number of entities overwritten by @p ent. */
581
FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
582
583
584
585
586
/** Returns index of @p overwrites in list of entities overwritten by entity
 * @p ent. */
FIRM_API size_t get_entity_overwrittenby_index(const ir_entity *ent,
                                               ir_entity *overwrites);
/** Return entry @p pos in list of entities overwritten by entity @p ent. */
587
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
588
589
590
591
592
593
/** Sets entry @p pos in list of entities overwritten by entity @p ent. */
FIRM_API void set_entity_overwrittenby(ir_entity *ent, size_t pos,
                                       ir_entity *overwrites);
/** Removes entry @p overwrites in list of entities overwritten by @p ent. */
FIRM_API void remove_entity_overwrittenby(ir_entity *ent,
                                          ir_entity *overwrites);
594
595
596
597
598
599
600
601
602

/**
 *   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
603
FIRM_API int is_entity(const void *thing);
604
605
606
607

/** Returns true if the type of the entity is a primitive, pointer
 * enumeration or method type.
 *
yb9976's avatar
yb9976 committed
608
 * @note This is a different classification than from is_primitive_type().
609
 */
Michael Beck's avatar
Michael Beck committed
610
FIRM_API int is_atomic_entity(const ir_entity *ent);
611
612
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
Michael Beck's avatar
Michael Beck committed
613
FIRM_API int is_compound_entity(const ir_entity *ent);
614
/** Returns true if the type of the entity is a Method type. */
Michael Beck's avatar
Michael Beck committed
615
FIRM_API int is_method_entity(const ir_entity *ent);
616
617
618
619
620

/** 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
621
FIRM_API long get_entity_nr(const ir_entity *ent);
622

623
624
/** Returns the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
625
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
626

627
628
/** Sets the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
629
FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
630

631
632
/** Marks entity as visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
633
FIRM_API void mark_entity_visited(ir_entity *ent);
634

635
636
/** Returns true if this entity was visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
637
FIRM_API int entity_visited(const ir_entity *ent);
638

639
640
/** Returns true if this entity was not visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
641
FIRM_API int entity_not_visited(const ir_entity *ent);
642
643
644
645
646
647
648
649

/**
 * 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().
 */
650
FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
651
652

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

656
657
658
/** Sets additional graph properties. */
FIRM_API void add_entity_additional_properties(ir_entity *ent,
                                               mtp_additional_properties flag);
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
685
686
687
688
689
690
691

/**
 * @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
 */
692

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

696
697
698
699
/** Tests whether entity @p entity is (the) unknown entity.
 * @returns 1 if it is the unknown entity, 0 otherwise */
FIRM_API int is_unknown_entity(const ir_entity *entity);

Matthias Braun's avatar
Matthias Braun committed
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
/** @deprecated */
typedef enum {
	allocation_automatic,
	allocation_parameter,
	allocation_dynamic,
	allocation_static
} ir_allocation;
/** @deprecated */
FIRM_API ir_allocation get_entity_allocation(const ir_entity *ent);
/** @deprecated */
FIRM_API void set_entity_allocation(ir_entity *ent, ir_allocation al);

/** @deprecated */
typedef enum {
	peculiarity_existent,
	peculiarity_description,
	peculiarity_inherited
} ir_peculiarity;
/** @deprecated */
FIRM_API ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
/** @deprecated */
FIRM_API void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);

/** @deprecated */
FIRM_API int is_entity_final(const ir_entity *ent);
/** @deprecated */
FIRM_API void set_entity_final(ir_entity *ent, int final);

/** @deprecated */
FIRM_API ir_peculiarity get_class_peculiarity(const ir_type *clss);
/** @deprecated */
FIRM_API void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);

/** @} */

735
/** Encodes how a pointer parameter is accessed. */
736
typedef enum ptr_access_kind {
Michael Beck's avatar
Michael Beck committed
737
738
739
740
741
742
	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 */
743
} ptr_access_kind;
744
ENUM_BITSET(ptr_access_kind)
745
746

/**
Matthias Braun's avatar
Matthias Braun committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 * @defgroup ir_type Type System
 *
 *  Datastructure to hold type information.
 *
 *  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
 *  between these types.  Finally it specifies some auxiliary types.
 *
 *  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.
 *
 * @{
 */

/**
 * @defgroup tp_op  Type Opcodes
771
772
773
774
775
776
 *  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.
Matthias Braun's avatar
Matthias Braun committed
777
778
 *
 * @{
779
780
781
782
783
784
 */

/**
 *  An enum for the type kinds.
 *  For each type kind exists a typecode to identify it.
 */
785
typedef enum tp_opcode {
786
787
788
789
790
791
792
793
794
	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. */
795
	tpo_code,                /**< a piece of code (a basic block) */
796
797
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
798
	tpo_last = tpo_unknown   /* not a type opcode */
799
800
801
802
803
804
805
806
} 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.
 *
807
 * @see  get_tpop_name(), get_tpop_code()
808
809
810
811
812
813
814
815
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
816
 * @return    a string.
817
 */
Michael Beck's avatar
Michael Beck committed
818
FIRM_API const char *get_tpop_name(const tp_op *op);
819
820
821
822
823
824
825

/**
 * 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
826
FIRM_API tp_opcode get_tpop_code(const tp_op *op);
827

Matthias Braun's avatar
Matthias Braun committed
828
/** @} */
829
830
831
832
833
834
835

/** 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
836
FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
837
838
839
840
841
842
843

/** 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
844
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864

/** 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
865
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
866
867
868
869
870
871

/** 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
872
FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
873
                                           ir_entity* static_ent);
874
875
876
877
878

/** 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
879
FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
880
                                              const ir_type *clss);
881
882
883
884
885
886
887
888

/** 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.
 */
889
890
typedef ident *mangle_inherited_name_func(const ir_entity *ent,
                                          const ir_type *clss);
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905

/** 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
906
FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923


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

924
925
926
/**
 * The state of the transitive closure.
 */
927
928
929
930
931
932
933
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;

934
935
/** Sets the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
936
FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
937
938
/** Sets the transitive closure of sub/superclass state for the
 * whole program to #inh_transitive_closure_invalid */
Michael Beck's avatar
Michael Beck committed
939
FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
940
941
/** Returns the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
942
FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
943
944
945
946

/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
947
 * This function walks over the ir (O(\#types+\#entities)) to compute the
948
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
949
FIRM_API void compute_inh_transitive_closure(void);
950
951

/** Free memory occupied by the transitive closure information. */
Michael Beck's avatar
Michael Beck committed
952
FIRM_API void free_inh_transitive_closure(void);
953

954
/** Start iteration over all transitive subtypes of @p tp */
Michael Beck's avatar
Michael Beck committed
955
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
956
957
958
959
/**
 * Returns next type in a subtype iteration started by
 * get_class_trans_subtype_first()
 */
Michael Beck's avatar
Michael Beck committed
960
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
961
962
963
964
965
/**
 * Check if @p subtp is a subtype of @p tp. This function checks the full
 * transitive closure of the subtype relation and not just direct subtyping.
 * @return 1 if it is a subtype, 0 otherwise
 */
Michael Beck's avatar
Michael Beck committed
966
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
967

968
/** Start iteration over all transitive supertypes of @p tp */
Michael Beck's avatar
Michael Beck committed
969
FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
970
971
972
973
/**
 * Returns next type in a supertype iteration started by
 * get_class_trans_supertype_first()
 */
Michael Beck's avatar
Michael Beck committed
974
FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
975

976
/** Start iteration over all entities that transitive overwrite entity @p ent.*/
Michael Beck's avatar
Michael Beck committed
977
FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
978
979
980
981
/**
 * Returns next entity in a overwrittenby iteration started by
 * get_entity_trans_overwrittenby_first()
 */
Michael Beck's avatar
Michael Beck committed
982
FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
983

984
985
/** Start iteration over all transitive overwritten entities, overwritten by
 * entity @p ent */
Michael Beck's avatar
Michael Beck committed
986
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
987
988
989
990
/**
 * Returns next entity in a overwrites iteration started by
 * get_entity_trans_overwrites_first()
 */
Michael Beck's avatar
Michael Beck committed
991
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
992
993
994
995
996


/**
 * Checks a type.
 *
997
 * @return non-zero if no errors were found
998
 */
999
FIRM_API int check_type(const ir_type *tp);
1000
1001
1002
1003
1004
1005
1006
1007
1008

/**
 * 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
 *
1009
 * @return 0 if no error encountered
1010
 */
1011
FIRM_API int tr_verify(void);
1012

1013
1014
/**
 * Frees the memory used by the type.
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1015
 *
1016
1017
 * Removes the type from the type list and frees all entities
 * belonging to the type.
Matthias Braun's avatar
Matthias Braun committed
1018
 */
Michael Beck's avatar
Michael Beck committed
1019
FIRM_API void free_type(ir_type *tp);
1020

1021
/** Returns type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
1022
FIRM_API const tp_op *get_type_tpop(const ir_type *tp);
1023
/** Returns name identifier of type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
1024
FIRM_API ident *get_type_tpop_nameid(const ir_type *tp);
1025
/** Returns name of type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
1026
FIRM_API const char *get_type_tpop_name(const ir_type *tp);
1027
/** Returns opcode of type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
1028
FIRM_API tp_opcode get_type_tpop_code(const ir_type *tp);
1029

1030
1031
1032
1033
1034
1035
1036
1037
1038
/**
 * 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
1039
FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1040
                            const ir_type *tp);
1041

1042
/** The state of the type layout. */
1043
typedef enum {
Michael Beck's avatar
Michael Beck committed
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
	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. */
1055
} ir_type_state;
1056

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

1060
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
1061
FIRM_API ir_type_state get_type_state(const ir_type *tp);
1062
1063
1064
1065
1066
1067

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

1070
1071
1072
1073
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */