typerep.h 62.7 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 data structures to represent types
yb9976's avatar
yb9976 committed
9
 */
10
11
12
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

13
14
#include <stddef.h>

15
16
17
#include "firm_types.h"

#include "begin.h"
18
19

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

76
77
78
79
80
/**
 * Visibility classed for entities.
 */
typedef enum {
	/**
Matthias Braun's avatar
Matthias Braun committed
81
82
	 * The entity is visible across compilation units. It might have an
	 * initializer/graph.
83
84
85
	 * 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).
86
	 */
Matthias Braun's avatar
Matthias Braun committed
87
	ir_visibility_external,
88
	/**
89
	 * The entity is visible across compilation units, but not across modules.
90
91
92
	 * This is equivalent to __attribute__((visibility("hidden"))) in gcc.
	 */
	ir_visibility_external_private,
93
94
95
96
97
98
	/**
	 * The entity is visible across compilation units and modules and cannot be
	 * overridden by other modules.
	 * Equivalent to __attribute__((visible("protected"))) in gcc.
	 */
	ir_visibility_external_protected,
99
100
101
102
103
104
105
106
	/**
	 * 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
107
108
	 * This has the same semantic as visibility_local. Additionally the symbol
	 * is completely hidden from the linker (it only appears in the assembly).
109
110
111
112
	 * 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
113
	ir_visibility_private,
114
115
} ir_visibility;

Matthias Braun's avatar
Matthias Braun committed
116
117
/**
 * linkage specifies how the linker treats symbols
118
 */
119
typedef enum ir_linkage {
120
	IR_LINKAGE_DEFAULT         = 0,
Matthias Braun's avatar
Matthias Braun committed
121
122
	/**
	 * A symbol whose definition won't change in a program.
yb9976's avatar
yb9976 committed
123
	 * Optimization might replace loads from this entity with constants.
Matthias Braun's avatar
Matthias Braun committed
124
125
126
	 * Also most linkers put such data in a constant segment which is shared
	 * between multiple running instances of the same application.
	 */
127
	IR_LINKAGE_CONSTANT        = 1 << 0,
Matthias Braun's avatar
Matthias Braun committed
128
129
130
131
132
133
	/**
	 * 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.
	 */
134
	IR_LINKAGE_WEAK            = 1 << 1,
Matthias Braun's avatar
Matthias Braun committed
135
136
137
138
139
	/**
	 * 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).
	 */
140
	IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
141
142
143
144
145
146
	/**
	 * 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)
	 */
147
	IR_LINKAGE_MERGE           = 1 << 3,
Matthias Braun's avatar
Matthias Braun committed
148
149
150
151
152
153
154
155
	/**
	 * 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.
	 */
156
157
158
159
160
161
162
163
164
	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,
165
166
	/**
	 * The entity does not need to have an address that is different from other
167
168
	 * entities. When this property is set the entity may be safely merged with
	 * entities with the same content.
169
170
	 */
	IR_LINKAGE_NO_IDENTITY     = 1 << 6,
Matthias Braun's avatar
Matthias Braun committed
171
} ir_linkage;
172
ENUM_BITSET(ir_linkage)
Matthias Braun's avatar
Matthias Braun committed
173
174

/**
175
 * Returns the visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
176
 */
Michael Beck's avatar
Michael Beck committed
177
FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
178
179

/**
180
 * Sets visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
181
 */
Michael Beck's avatar
Michael Beck committed
182
FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
Matthias Braun's avatar
Matthias Braun committed
183
184

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

/**
195
 * Returns 1 if the entity has a definition (initializer) in the current
196
197
 * 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
198
 */
Michael Beck's avatar
Michael Beck committed
199
FIRM_API int entity_has_definition(const ir_entity *entity);
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
206
 * is type_method, then it is static_allocated and constant.
207
208
 * Visibility is local, offset -1, and it is not volatile.
 */
Michael Beck's avatar
Michael Beck committed
209
FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
210

211
212
213
214
215
216
217
/**
 * Creates a new global entity.
 */
FIRM_API ir_entity *new_global_entity(ir_type *segment, ident *ld_name,
                                      ir_type *type, ir_visibility visibility,
                                      ir_linkage linkage);

218
219
220
221
222
223
224
/**
 * 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);

225
226
227
228
229
230
231
232
233
234
235
236
/**
 * Creates a new entity aliasing another entity.
 * An aliasing entity is a logically separate entity with its own name,
 * but instead of having a definition the linker will merge the name with
 * the definition of the aliased entity.
 * In gcc this feature is known as __attribute__((alias())).
 *
 * @param owner  owning type (must be a global segment)
 * @param name   name of the entity
 * @param alias  entity that is aliased
 * @param type   type of the aliased entity, should but need not be the same
 *               type as the one of the aliased entity
Matthias Braun's avatar
Matthias Braun committed
237
 * @param visibility  visibility of the entity
238
239
240
 * @return       the newly created entity
 */
FIRM_API ir_entity *new_alias_entity(ir_type *owner, ident *name,
241
242
                                     ir_entity *alias, ir_type *type,
                                     ir_visibility visibility);
243
244
245
246
247
248
249
250
251
252
253

/**
 * Sets the entity an alias entity aliases.
 */
FIRM_API void set_entity_alias(ir_entity *alias, ir_entity *aliased);

/**
 * Returns the entity aliased by an alias entity.
 */
FIRM_API ir_entity *get_entity_alias(const ir_entity *alias);

Matthias Braun's avatar
Matthias Braun committed
254
/**
Christoph Mallon's avatar
Christoph Mallon committed
255
 * Check an entity.
Matthias Braun's avatar
Matthias Braun committed
256
 *
257
 * @return non-zero if no errors were found
Matthias Braun's avatar
Matthias Braun committed
258
 */
259
FIRM_API int check_entity(const ir_entity *ent);
Matthias Braun's avatar
Matthias Braun committed
260

261
/**
262
 * Create a new entity with attributes copied from an existing entity.
263
 *
264
265
 * Does not copy the overwrites/overwritte_by, visited an dusage fields, sets
 * a new name and inserts the entity into \p owner.
266
 */
267
268
FIRM_API ir_entity *clone_entity(ir_entity const *old, ident *name,
                                 ir_type *owner);
269
270
271
272
273
274
275

/**
 * 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
276
FIRM_API void free_entity(ir_entity *ent);
277
278

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

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
282
FIRM_API ident *get_entity_ident(const ir_entity *ent);
283
284

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
285
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
286
287
288
289
290
291
292

/** 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
293
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
294
295

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

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

301
302
303
/** returns 1 if the entity has an ld_ident set explicitely */
FIRM_API int entity_has_ld_ident(const ir_entity *entity);

304
/** Returns the owner of the entity. */
Michael Beck's avatar
Michael Beck committed
305
FIRM_API ir_type *get_entity_owner(const ir_entity *ent);
306

307
308
309
310
311
/**
 * 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
312
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
313
314

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

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

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

323
/** Sets the linkage flags of entity @p entity to @p linkage. */
Michael Beck's avatar
Michael Beck committed
324
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
325
/** Adds linkage flags @p linkage to entity @p entity. */
Michael Beck's avatar
Michael Beck committed
326
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
327
/** Remove linkage flags @p linkage from entity @p entity. */
Michael Beck's avatar
Michael Beck committed
328
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
329

Matthias Braun's avatar
Matthias Braun committed
330
331
332
333
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
334
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
335

Matthias Braun's avatar
Matthias Braun committed
336
337
338
339
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
340
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
341

342
/** Returns the name of the volatility. */
Michael Beck's avatar
Michael Beck committed
343
FIRM_API const char *get_volatility_name(ir_volatility var);
344

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

Matthias Braun's avatar
Matthias Braun committed
348
/** Allows you to override the type alignment for an entity.
349
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
350
351
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
352
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
353

Matthias Braun's avatar
Matthias Braun committed
354
/**
355
 * Returns indication whether entity is aligned in memory.
Matthias Braun's avatar
Matthias Braun committed
356
357
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
358
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
359

Matthias Braun's avatar
Matthias Braun committed
360
/**
361
 * Sets indication whether entity is aligned in memory
Matthias Braun's avatar
Matthias Braun committed
362
363
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
364
FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
365

366
/** Returns the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
367
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
368

369
370
/** Returns the offset of an entity (in a compound) in bytes. Only set if
 * layout = fixed. */
371
FIRM_API int get_entity_offset(const ir_entity *entity);
372
373

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

376
377
/** For bitfields, returns the offset in bits to the bitfield base. */
FIRM_API unsigned get_entity_bitfield_offset(const ir_entity *entity);
378

379
380
381
382
383
384
385
386
/** 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);
387
388

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
389
FIRM_API void *get_entity_link(const ir_entity *ent);
390
391

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

394
/**
395
396
397
398
 * Return the method graph of a method entity.
 * @warning If it is a weak symbol, then this is not necessarily the final code
 *          bound to the entity. If you are writing an analysis use
 *          get_entity_linktime_irg()!
399
 */
Michael Beck's avatar
Michael Beck committed
400
FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
401

402
403
404
405
406
407
408
409
/**
 * Return the method graph the method entity points to after linking.
 * This is different to get_entity_irg() in case of weak symbols where this
 * function returns NULL because the code may be replaced by a non-weak symbol
 * after linking.
 */
FIRM_API ir_graph *get_entity_linktime_irg(const ir_entity *ent);

410
411
412
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

413
/** Returns the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
414
FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
415
416

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

419
/** Sets label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
420
FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
421
/** Returns label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
422
FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
423

424
/**
425
 * Bitfield type indicating the way an entity is used.
426
427
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
428
429
430
431
432
433
434
	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 */
435
436
437
438
439
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

440
/** Returns the entity usage */
Michael Beck's avatar
Michael Beck committed
441
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
442
443

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

446
447
448
449
450
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
Michael Beck's avatar
Michael Beck committed
451
FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
452
453
454
455
456
457
458

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

461
462
463
464
465
466
467
468
/**
 * 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.
 */
469
470
#define IR_VA_START_PARAMETER_NUMBER  ((size_t)-1)

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
/**
 * 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);

487
/** Returns initial value of entity with atomic type @p ent. */
488
FIRM_API ir_node *get_atomic_ent_value(const ir_entity *ent);
489
490
/** 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
491
FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
492

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

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

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

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

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

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

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
550
551
/** @} */

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

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

558
/** Adds entity @p ent to the list of entities that overwrite @p overwritten. */
Michael Beck's avatar
Michael Beck committed
559
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
560
561
/** Returns the number of entities in the list of entities that overwrite
 * entity @p ent. */
562
FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
563
564
565
566
567
/** 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. */
568
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
569
570
571
572
/** 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
573
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
574

575
/** Returns number of entities overwritten by @p ent. */
576
FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
577
578
579
580
581
/** 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. */
582
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
583
584
585
586
587
588
/** 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);
589
590

/** Returns true if the type of the entity is a primitive, pointer
591
 * or method type.
592
 *
yb9976's avatar
yb9976 committed
593
 * @note This is a different classification than from is_primitive_type().
594
 */
Michael Beck's avatar
Michael Beck committed
595
FIRM_API int is_atomic_entity(const ir_entity *ent);
596
597
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
Michael Beck's avatar
Michael Beck committed
598
FIRM_API int is_compound_entity(const ir_entity *ent);
599
/** Returns true if the entity is a method entity. */
Michael Beck's avatar
Michael Beck committed
600
FIRM_API int is_method_entity(const ir_entity *ent);
601
602
/** Returns true if the entity is an alias entity. */
FIRM_API int is_alias_entity(const ir_entity *ent);
603
604
605
606
607

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

610
611
/** Returns the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
612
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
613

614
615
/** Sets the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
616
FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
617

618
619
/** Marks entity as visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
620
FIRM_API void mark_entity_visited(ir_entity *ent);
621

622
623
/** Returns true if this entity was visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
624
FIRM_API int entity_visited(const ir_entity *ent);
625

626
627
/** Returns true if this entity was not visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
628
FIRM_API int entity_not_visited(const ir_entity *ent);
629

630
631
632
633
634
635
/** Return true if this entity can be queried for additional properties.
 *
 * This is possible for method and alias entities.
 */
FIRM_API int entity_has_additional_properties(const ir_entity *entity);

636
637
638
639
640
641
642
/**
 * 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().
 */
643
FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
644
645

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

649
650
651
/** Sets additional graph properties. */
FIRM_API void add_entity_additional_properties(ir_entity *ent,
                                               mtp_additional_properties flag);
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673

/**
 * @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
674
 * - value         = Address(unknown_entity)
675
676
677
678
679
680
681
682
683
684
 * - values        = NULL
 * - val_paths     = NULL
 * - volatility    = volatility_non_volatile
 * - stickyness    = stickyness_unsticky
 * - ld_name       = NULL
 * - overwrites    = NULL
 * - overwrittenby = NULL
 * - irg           = NULL
 * - link          = NULL
 */
685

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

689
690
691
692
/** 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
693
694
/** @} */

695
/** Encodes how a pointer parameter is accessed. */
696
typedef enum ptr_access_kind {
Michael Beck's avatar
Michael Beck committed
697
698
699
700
701
702
	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 */
703
} ptr_access_kind;
704
ENUM_BITSET(ptr_access_kind)
705
706

/**
Matthias Braun's avatar
Matthias Braun committed
707
708
709
710
 * @defgroup ir_type Type System
 *
 *  Datastructure to hold type information.
 *
711
 *  This module supplies a data structure to represent all types
Matthias Braun's avatar
Matthias Braun committed
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 *  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.
 *
 * @{
 */

729
730
731
732
/**
 *  An enum for the type kinds.
 *  For each type kind exists a typecode to identify it.
 */
733
typedef enum tp_opcode {
734
735
736
	tpo_uninitialized = 0,   /* not a type opcode */
	tpo_struct,              /**< A struct type. */
	tpo_union,               /**< An union type. */
737
738
739
	tpo_class,               /**< A class type. */
	tpo_segment,             /**< A segment type. */
	tpo_method,              /**< A method type. */
740
741
742
	tpo_array,               /**< An array type. */
	tpo_pointer,             /**< A pointer type. */
	tpo_primitive,           /**< A primitive type. */
743
	tpo_code,                /**< a piece of code (a basic block) */
744
	tpo_unknown,             /**< Special code for the Unknown type. */
745
	tpo_last = tpo_unknown   /* not a type opcode */
746
747
748
} tp_opcode;

/**
749
 * Returns the name of the type opcode @p opcode.
750
 */
751
FIRM_API const char *get_type_opcode_name(tp_opcode opcode);
752
753
754
755
756
757
758

/** 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.  */
759
FIRM_API int is_SubClass_of(const ir_type *low, const ir_type *high);
760
761
762
763
764
765
766

/** 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
767
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787

/** 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
788
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
789
790
791
792
793
794

/** 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
795
FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
796
                                           ir_entity* static_ent);
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812

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

813
814
815
/**
 * The state of the transitive closure.
 */
816
817
818
819
820
821
822
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;

823
824
/** Sets the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
825
FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
826
827
/** Sets the transitive closure of sub/superclass state for the
 * whole program to #inh_transitive_closure_invalid */
Michael Beck's avatar
Michael Beck committed
828
FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
829
830
/** Returns the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
831
FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
832
833
834
835

/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
836
 * This function walks over the ir (O(\#types+\#entities)) to compute the
837
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
838
FIRM_API void compute_inh_transitive_closure(void);
839
840

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

843
/** Start iteration over all transitive subtypes of @p tp */
Michael Beck's avatar
Michael Beck committed
844
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
845
846
847
848
/**
 * Returns next type in a subtype iteration started by
 * get_class_trans_subtype_first()
 */
Michael Beck's avatar
Michael Beck committed
849
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
850
851
852
853
854
/**
 * 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
855
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
856

857
/** Start iteration over all transitive supertypes of @p tp */
Michael Beck's avatar
Michael Beck committed
858
FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
859
860
861
862
/**
 * Returns next type in a supertype iteration started by
 * get_class_trans_supertype_first()
 */
Michael Beck's avatar
Michael Beck committed
863
FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
864

865
/** Start iteration over all entities that transitive overwrite entity @p ent.*/
Michael Beck's avatar
Michael Beck committed
866
FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
867
868
869
870
/**
 * Returns next entity in a overwrittenby iteration started by
 * get_entity_trans_overwrittenby_first()
 */
Michael Beck's avatar
Michael Beck committed
871
FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
872

873
874
/** Start iteration over all transitive overwritten entities, overwritten by
 * entity @p ent */
Michael Beck's avatar
Michael Beck committed
875
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
876
877
878
879
/**
 * Returns next entity in a overwrites iteration started by
 * get_entity_trans_overwrites_first()
 */
Michael Beck's avatar
Michael Beck committed
880
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
881
882
883
884
885


/**
 * Checks a type.
 *
886
 * @return non-zero if no errors were found
887
 */
888
FIRM_API int check_type(const ir_type *tp);
889
890
891
892

/**
 * Walks the type information and performs a set of sanity checks.
 *
893
 * @return 0 in case of an error
894
 */
895
FIRM_API int tr_verify(void);
896

897
898
/**
 * Frees the memory used by the type.
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
899
 *
900
901
 * Removes the type from the type list and frees all entities
 * belonging to the type.
Matthias Braun's avatar
Matthias Braun committed
902
 */
Michael Beck's avatar
Michael Beck committed
903
FIRM_API void free_type(ir_type *tp);
904

905
906
/** Returns opcode of type @p type */
FIRM_API tp_opcode get_type_opcode(const ir_type *type);
907

908
909
910
911
912
913
914
915
916
/**
 * 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
917
FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
918
                            const ir_type *tp);
919

920
/** The state of the type layout. */
921
typedef enum {
Michael Beck's avatar
Michael Beck committed
922
923
924
	layout_undefined,    /**< The layout of this type is not defined.
	                          Address computation to access fields is not
	                          possible, fields must be accessed by Sel
925
	                          nodes.
Michael Beck's avatar
Michael Beck committed
926
927
928
	                          This is the default value except for
	                          pointer, primitive and method types. */
	layout_fixed         /**< The layout is fixed, all component/member entities
929
930
931
932
933
	                          have an offset assigned. Size of the type is
	                          known. Arrays can be accessed by explicit address
	                          computation.
	                          Default for pointer, primitive and method types.
	                          */
934
} ir_type_state;
935

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

939
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
940
FIRM_API ir_type_state get_type_state(const ir_type *tp);
941
942
943
944
945
946

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

949
950
951
952
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
953
FIRM_API ir_mode *get_type_mode(const ir_type *tp);
954

955
/** Returns the size of a type in bytes. */
956
FIRM_API unsigned get_type_size(const ir_type *tp);
957
958
959

/** Sets the size of a type in bytes.
 *
960
961
 * For primitive, pointer and method types the size is always fixed.
 * This call is legal but has no effect.
962
 */
963
FIRM_API void set_type_size(ir_type *tp, unsigned size);
964

Matthias Braun's avatar
Matthias Braun committed
965
/** Returns the alignment of a type in bytes. */
966
FIRM_API unsigned get_type_alignment(const ir_type *tp);
967

968
/** Sets the alignment of a type in bytes. */
969
FIRM_API void set_type_alignment(ir_type *tp, unsigned align);
Michael Beck's avatar
Michael Beck committed
970

971
972
/** Returns the visited counter of a type.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
973
FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
974
975
/** Sets the visited counter of a type to num.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
976
FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
977
978
/** Sets visited field in type to type_visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
979
FIRM_API void mark_type_visited(ir_type *tp);
980
981
/** Returns non-zero if the type is already visited
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
982
FIRM_API int type_visited(const ir_type *tp);
983