typerep.h 80 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
/*
 * This file is part of libFirm.
3
 * Copyright (C) 2012 University of Karlsruhe.
Christian Würdig's avatar
Christian Würdig committed
4
 */
yb9976's avatar
yb9976 committed
5
6
7

/**
 * @file
8
 * @brief Declarations for functions and datastructures to represent types
yb9976's avatar
yb9976 committed
9
 */
10
11
12
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

13
#include <stdlib.h>
14
15
16
#include "firm_types.h"

#include "begin.h"
17
18

/**
Matthias Braun's avatar
Matthias Braun committed
19
 * @defgroup ir_entity Entities
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 *
 * 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
43
44
 *   - name:       The string that represents this entity in the source program
 *   - linkage:    A flag indicating how the linker treats a symbol
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 *   - 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.
 *
62
63
64
65
66
67
68
69
70
71
 * 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
72
 * @{
73
74
 */

75
76
77
78
79
/**
 * Visibility classed for entities.
 */
typedef enum {
	/**
Matthias Braun's avatar
Matthias Braun committed
80
81
	 * The entity is visible across compilation units. It might have an
	 * initializer/graph.
82
83
84
	 * 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).
85
	 */
Matthias Braun's avatar
Matthias Braun committed
86
	ir_visibility_external,
87
88
89
90
91
92
93
94
	/**
	 * 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
95
96
	 * This has the same semantic as visibility_local. Additionally the symbol
	 * is completely hidden from the linker (it only appears in the assembly).
97
98
99
100
	 * 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
101
	ir_visibility_private,
102
103
} ir_visibility;

Matthias Braun's avatar
Matthias Braun committed
104
105
/**
 * linkage specifies how the linker treats symbols
106
 */
107
typedef enum ir_linkage {
108
	IR_LINKAGE_DEFAULT         = 0,
Matthias Braun's avatar
Matthias Braun committed
109
110
111
112
113
114
	/**
	 * 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.
	 */
115
	IR_LINKAGE_CONSTANT        = 1 << 0,
Matthias Braun's avatar
Matthias Braun committed
116
117
118
119
120
121
	/**
	 * 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.
	 */
122
	IR_LINKAGE_WEAK            = 1 << 1,
Matthias Braun's avatar
Matthias Braun committed
123
124
125
126
127
	/**
	 * 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).
	 */
128
	IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
129
130
131
132
133
134
	/**
	 * 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)
	 */
135
	IR_LINKAGE_MERGE           = 1 << 3,
Matthias Braun's avatar
Matthias Braun committed
136
137
138
139
140
141
142
143
	/**
	 * 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.
	 */
144
145
146
147
148
149
150
151
152
	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
153
} ir_linkage;
154
ENUM_BITSET(ir_linkage)
Matthias Braun's avatar
Matthias Braun committed
155
156

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

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

/**
167
 * Returns 1 if the entity is visible outside the current compilation unit
168
169
170
171
172
 * 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
173
 */
Michael Beck's avatar
Michael Beck committed
174
FIRM_API int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
175
176

/**
177
 * Returns 1 if the entity has a definition (initializer) in the current
178
179
 * 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
180
 */
Michael Beck's avatar
Michael Beck committed
181
FIRM_API int entity_has_definition(const ir_entity *entity);
182
183
184
185
186
187
188
189
190
191

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

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

206
207
208
209
210
211
212
213
214
215
216
217
218
/**
 * 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
219
220
221
222
/**
 * Check an entity. Currently, we check only if initialized constants
 * are build on the const irg graph.
 *
223
 * @return non-zero if no errors were found
Matthias Braun's avatar
Matthias Braun committed
224
 */
225
FIRM_API int check_entity(const ir_entity *ent);
Matthias Braun's avatar
Matthias Braun committed
226

227
228
229
230
231
232
233
234
/**
 * 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
235
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
236
237
238
239
240
241
242
243
244

/**
 * 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
245
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
246
247
248
249
250
251
252

/**
 * 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
253
FIRM_API void free_entity(ir_entity *ent);
254
255

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

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
259
FIRM_API ident *get_entity_ident(const ir_entity *ent);
260
261

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
262
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
263
264
265
266
267
268
269

/** 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
270
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
271
272

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

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

278
279
280
/** returns 1 if the entity has an ld_ident set explicitely */
FIRM_API int entity_has_ld_ident(const ir_entity *entity);

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

284
285
286
287
288
/**
 * 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
289
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
290
291

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

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

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

300
/** Sets the linkage flags of entity @p entity to @p linkage. */
Michael Beck's avatar
Michael Beck committed
301
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
302
/** Adds linkage flags @p linkage to entity @p entity. */
Michael Beck's avatar
Michael Beck committed
303
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
304
/** Remove linkage flags @p linkage from entity @p entity. */
Michael Beck's avatar
Michael Beck committed
305
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
306

Matthias Braun's avatar
Matthias Braun committed
307
308
309
310
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
311
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
312

Matthias Braun's avatar
Matthias Braun committed
313
314
315
316
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
317
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
318

319
/** Returns the name of the volatility. */
Michael Beck's avatar
Michael Beck committed
320
FIRM_API const char *get_volatility_name(ir_volatility var);
321

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

Matthias Braun's avatar
Matthias Braun committed
325
/** Allows you to override the type alignment for an entity.
326
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
327
328
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
329
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
330

Matthias Braun's avatar
Matthias Braun committed
331
/**
332
 * Returns indication whether entity is aligned in memory.
Matthias Braun's avatar
Matthias Braun committed
333
334
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
335
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
336

Matthias Braun's avatar
Matthias Braun committed
337
/**
338
 * Sets indication whether entity is aligned in memory
Matthias Braun's avatar
Matthias Braun committed
339
340
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
341
FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
342

343
/** Returns the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
344
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
345

346
347
/** Returns the offset of an entity (in a compound) in bytes. Only set if
 * layout = fixed. */
348
FIRM_API int get_entity_offset(const ir_entity *entity);
349
350

/** Sets the offset of an entity (in a compound) in bytes. */
351
FIRM_API void set_entity_offset(ir_entity *entity, int offset);
352

353
354
/** For bitfields, returns the offset in bits to the bitfield base. */
FIRM_API unsigned get_entity_bitfield_offset(const ir_entity *entity);
355

356
357
358
359
360
361
362
363
/** Sets the offset in bits to the base for a bitfield. */
FIRM_API void set_entity_bitfield_offset(ir_entity *entity, unsigned offset);

/** Sets the size in bits for a bitfield. 0 means not a bitfield. */
FIRM_API void set_entity_bitfield_size(ir_entity *entity, unsigned size);

/** Returns the size in bits for a bitfield, 0 if entity is not a bitfield. */
FIRM_API unsigned get_entity_bitfield_size(const ir_entity *entity);
364
365

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
366
FIRM_API void *get_entity_link(const ir_entity *ent);
367
368

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

371
372
373
374
/**
 * 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
375
FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
376

377
378
379
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

380
/** Returns the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
381
FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
382
383

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

386
/** Sets label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
387
FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
388
/** Returns label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
389
FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
390

391
/** Checks if an entity is compiler generated. */
Michael Beck's avatar
Michael Beck committed
392
FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
393
394

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

397
/**
398
 * Bitfield type indicating the way an entity is used.
399
400
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
401
402
403
404
405
406
407
	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 */
408
409
410
411
412
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

413
/** Returns the entity usage */
Michael Beck's avatar
Michael Beck committed
414
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
415
416

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

419
420
421
422
423
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
Michael Beck's avatar
Michael Beck committed
424
FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
425
426
427
428
429
430
431

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

434
435
436
437
438
439
440
441
/**
 * 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.
 */
442
443
#define IR_VA_START_PARAMETER_NUMBER  ((size_t)-1)

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/**
 * 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);

460
/** Returns initial value of entity with atomic type @p ent. */
461
FIRM_API ir_node *get_atomic_ent_value(const ir_entity *ent);
462
463
/** 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
464
FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
465

Matthias Braun's avatar
Matthias Braun committed
466
467
468
469
/** @defgroup ir_initializer  Entity Initializers
 * @{
 */

470
471
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
472
	/** initializer containing an ir_node from the const-code irg */
473
	IR_INITIALIZER_CONST,
474
	/** initializer containing a tarval */
475
	IR_INITIALIZER_TARVAL,
476
	/** initializes type with default values (usually 0) */
477
	IR_INITIALIZER_NULL,
478
	/** list of initializers used to initializer a compound or array type */
479
480
481
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

482
/** Returns kind of an initializer */
Michael Beck's avatar
Michael Beck committed
483
FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
484

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

488
/**
489
 * Returns the null initializer (there's only one instance of it in a program )
490
 */
Michael Beck's avatar
Michael Beck committed
491
FIRM_API ir_initializer_t *get_initializer_null(void);
492
493

/**
494
 * Creates an initializer containing a reference to a node on the const-code
495
496
 * irg.
 */
Michael Beck's avatar
Michael Beck committed
497
FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
498

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

502
/** Returns value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
503
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
504

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

508
/** Creates a compound initializer which holds @p n_entries entries */
509
FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
510

511
/** Returns the number of entries in a compound initializer */
512
FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
513

514
/** Sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
515
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
516
                                             size_t index,
517
                                             ir_initializer_t *value);
518

519
/** Returns the value with index @p index of a compound initializer */
Michael Beck's avatar
Michael Beck committed
520
FIRM_API ir_initializer_t *get_initializer_compound_value(
521
		const ir_initializer_t *initializer, size_t index);
522

Matthias Braun's avatar
Matthias Braun committed
523
524
/** @} */

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

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

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

534
/** Adds entity @p ent to the list of entities that overwrite @p overwritten. */
Michael Beck's avatar
Michael Beck committed
535
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
536
537
/** Returns the number of entities in the list of entities that overwrite
 * entity @p ent. */
538
FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
539
540
541
542
543
/** 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. */
544
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
545
546
547
548
/** 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
549
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
550

551
/** Returns number of entities overwritten by @p ent. */
552
FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
553
554
555
556
557
/** 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. */
558
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
559
560
561
562
563
564
/** 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);
565
566
567
568
569
570
571
572
573

/**
 *   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
574
FIRM_API int is_entity(const void *thing);
575
576
577
578

/** Returns true if the type of the entity is a primitive, pointer
 * enumeration or method type.
 *
yb9976's avatar
yb9976 committed
579
 * @note This is a different classification than from is_primitive_type().
580
 */
Michael Beck's avatar
Michael Beck committed
581
FIRM_API int is_atomic_entity(const ir_entity *ent);
582
583
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
Michael Beck's avatar
Michael Beck committed
584
FIRM_API int is_compound_entity(const ir_entity *ent);
585
/** Returns true if the type of the entity is a Method type. */
Michael Beck's avatar
Michael Beck committed
586
FIRM_API int is_method_entity(const ir_entity *ent);
587
588
589
590
591

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

594
595
/** Returns the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
596
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
597

598
599
/** Sets the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
600
FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
601

602
603
/** Marks entity as visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
604
FIRM_API void mark_entity_visited(ir_entity *ent);
605

606
607
/** Returns true if this entity was visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
608
FIRM_API int entity_visited(const ir_entity *ent);
609

610
611
/** Returns true if this entity was not visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
612
FIRM_API int entity_not_visited(const ir_entity *ent);
613
614
615
616
617
618
619
620

/**
 * 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().
 */
621
FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
622
623

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

627
628
629
/** Sets additional graph properties. */
FIRM_API void add_entity_additional_properties(ir_entity *ent,
                                               mtp_additional_properties flag);
630
631
632
633
634
635
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

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

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

667
668
669
670
/** 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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
/** @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);

/** @} */

706
/** Encodes how a pointer parameter is accessed. */
707
typedef enum ptr_access_kind {
Michael Beck's avatar
Michael Beck committed
708
709
710
711
712
713
	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 */
714
} ptr_access_kind;
715
ENUM_BITSET(ptr_access_kind)
716
717

/**
Matthias Braun's avatar
Matthias Braun committed
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 * @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
742
743
744
745
746
747
 *  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
748
749
 *
 * @{
750
751
752
753
754
755
 */

/**
 *  An enum for the type kinds.
 *  For each type kind exists a typecode to identify it.
 */
756
typedef enum tp_opcode {
757
758
759
760
761
762
763
764
765
	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. */
766
	tpo_code,                /**< a piece of code (a basic block) */
767
	tpo_unknown,             /**< Special code for the Unknown type. */
768
	tpo_last = tpo_unknown   /* not a type opcode */
769
770
771
772
773
774
775
776
} 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.
 *
777
 * @see  get_tpop_name(), get_tpop_code()
778
779
780
781
782
783
784
785
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
786
 * @return    a string.
787
 */
Michael Beck's avatar
Michael Beck committed
788
FIRM_API const char *get_tpop_name(const tp_op *op);
789
790
791
792
793
794
795

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

Matthias Braun's avatar
Matthias Braun committed
798
/** @} */
799
800
801
802
803
804
805

/** 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
806
FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
807
808
809
810
811
812
813

/** 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
814
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834

/** 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
835
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
836
837
838
839
840
841

/** 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
842
FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
843
                                           ir_entity* static_ent);
844
845
846
847
848

/** 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
849
FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
850
                                              const ir_type *clss);
851
852
853
854
855
856
857
858

/** 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.
 */
859
860
typedef ident *mangle_inherited_name_func(const ir_entity *ent,
                                          const ir_type *clss);
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875

/** 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
876
FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893


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

894
895
896
/**
 * The state of the transitive closure.
 */
897
898
899
900
901
902
903
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;

904
905
/** Sets the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
906
FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
907
908
/** Sets the transitive closure of sub/superclass state for the
 * whole program to #inh_transitive_closure_invalid */
Michael Beck's avatar
Michael Beck committed
909
FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
910
911
/** Returns the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
912
FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
913
914
915
916

/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
917
 * This function walks over the ir (O(\#types+\#entities)) to compute the
918
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
919
FIRM_API void compute_inh_transitive_closure(void);
920
921

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

924
/** Start iteration over all transitive subtypes of @p tp */
Michael Beck's avatar
Michael Beck committed
925
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
926
927
928
929
/**
 * Returns next type in a subtype iteration started by
 * get_class_trans_subtype_first()
 */
Michael Beck's avatar
Michael Beck committed
930
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
931
932
933
934
935
/**
 * 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
936
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
937

938
/** Start iteration over all transitive supertypes of @p tp */
Michael Beck's avatar
Michael Beck committed
939
FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
940
941
942
943
/**
 * Returns next type in a supertype iteration started by
 * get_class_trans_supertype_first()
 */
Michael Beck's avatar
Michael Beck committed
944
FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
945

946
/** Start iteration over all entities that transitive overwrite entity @p ent.*/
Michael Beck's avatar
Michael Beck committed
947
FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
948
949
950
951
/**
 * Returns next entity in a overwrittenby iteration started by
 * get_entity_trans_overwrittenby_first()
 */
Michael Beck's avatar
Michael Beck committed
952
FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
953

954
955
/** Start iteration over all transitive overwritten entities, overwritten by
 * entity @p ent */
Michael Beck's avatar
Michael Beck committed
956
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
957
958
959
960
/**
 * Returns next entity in a overwrites iteration started by
 * get_entity_trans_overwrites_first()
 */
Michael Beck's avatar
Michael Beck committed
961
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
962
963
964
965
966


/**
 * Checks a type.
 *
967
 * @return non-zero if no errors were found
968
 */
969
FIRM_API int check_type(const ir_type *tp);
970
971
972
973
974
975
976
977
978

/**
 * 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
 *
979
 * @return 0 if no error encountered
980
 */
981
FIRM_API int tr_verify(void);
982

983
984
/**
 * Frees the memory used by the type.
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
985
 *
986
987
 * Removes the type from the type list and frees all entities
 * belonging to the type.
Matthias Braun's avatar
Matthias Braun committed
988
 */
Michael Beck's avatar
Michael Beck committed
989
FIRM_API void free_type(ir_type *tp);
990

991
/** Returns type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
992
FIRM_API const tp_op *get_type_tpop(const ir_type *tp);
993
/** Returns name identifier of type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
994
FIRM_API ident *get_type_tpop_nameid(const ir_type *tp);
995
/** Returns name of type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
996
FIRM_API const char *get_type_tpop_name(const ir_type *tp);
997
/** Returns opcode of type opcode of type @p tp */
Michael Beck's avatar
Michael Beck committed
998
FIRM_API tp_opcode get_type_tpop_code(const ir_type *tp);
999

1000
1001
1002
1003
1004
1005
1006
1007
1008
/**
 * 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
1009
FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
1010
                            const ir_type *tp);
1011

1012
/** The state of the type layout. */
1013
typedef enum {
Michael Beck's avatar
Michael Beck committed
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
	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. */
1025
} ir_type_state;
1026

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

1030
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
1031
FIRM_API ir_type_state get_type_state(const ir_type *tp);
1032
1033
1034
1035
1036
1037

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

1040
1041
1042
1043
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
1044
FIRM_API ir_mode *get_type_mode(const ir_type *tp);
1045
1046
1047

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

1052
/** Returns the size of a type in bytes. */
Michael Beck's avatar
Michael Beck committed
1053
FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
1054
1055
1056
1057
1058
1059

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

Matthias Braun's avatar
Matthias Braun committed
1062
/** Returns the alignment of a type in bytes. */