typerep.h 63.1 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
263
264
265
266
267
268
/**
 * 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
269
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
270
271
272
273
274
275
276
277
278

/**
 * 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
279
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
280
281
282
283
284
285
286

/**
 * 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
287
FIRM_API void free_entity(ir_entity *ent);
288
289

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

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
293
FIRM_API ident *get_entity_ident(const ir_entity *ent);
294
295

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
296
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
297
298
299
300
301
302
303

/** 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
304
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
305
306

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

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

312
313
314
/** returns 1 if the entity has an ld_ident set explicitely */
FIRM_API int entity_has_ld_ident(const ir_entity *entity);

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

318
319
320
321
322
/**
 * 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
323
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
324
325

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

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

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

334
/** Sets the linkage flags of entity @p entity to @p linkage. */
Michael Beck's avatar
Michael Beck committed
335
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
336
/** Adds linkage flags @p linkage to entity @p entity. */
Michael Beck's avatar
Michael Beck committed
337
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
338
/** Remove linkage flags @p linkage from entity @p entity. */
Michael Beck's avatar
Michael Beck committed
339
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
340

Matthias Braun's avatar
Matthias Braun committed
341
342
343
344
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
345
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
346

Matthias Braun's avatar
Matthias Braun committed
347
348
349
350
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
351
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
352

353
/** Returns the name of the volatility. */
Michael Beck's avatar
Michael Beck committed
354
FIRM_API const char *get_volatility_name(ir_volatility var);
355

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

Matthias Braun's avatar
Matthias Braun committed
359
/** Allows you to override the type alignment for an entity.
360
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
361
362
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
363
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
364

Matthias Braun's avatar
Matthias Braun committed
365
/**
366
 * Returns indication whether entity is aligned in memory.
Matthias Braun's avatar
Matthias Braun committed
367
368
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
369
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
370

Matthias Braun's avatar
Matthias Braun committed
371
/**
372
 * Sets indication whether entity is aligned in memory
Matthias Braun's avatar
Matthias Braun committed
373
374
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
375
FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
376

377
/** Returns the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
378
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
379

380
381
/** Returns the offset of an entity (in a compound) in bytes. Only set if
 * layout = fixed. */
382
FIRM_API int get_entity_offset(const ir_entity *entity);
383
384

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

387
388
/** For bitfields, returns the offset in bits to the bitfield base. */
FIRM_API unsigned get_entity_bitfield_offset(const ir_entity *entity);
389

390
391
392
393
394
395
396
397
/** 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);
398
399

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
400
FIRM_API void *get_entity_link(const ir_entity *ent);
401
402

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

405
/**
406
407
408
409
 * 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()!
410
 */
Michael Beck's avatar
Michael Beck committed
411
FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
412

413
414
415
416
417
418
419
420
/**
 * 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);

421
422
423
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

424
/** Returns the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
425
FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
426
427

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

430
/** Sets label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
431
FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
432
/** Returns label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
433
FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
434

435
/**
436
 * Bitfield type indicating the way an entity is used.
437
438
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
439
440
441
442
443
444
445
	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 */
446
447
448
449
450
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

451
/** Returns the entity usage */
Michael Beck's avatar
Michael Beck committed
452
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
453
454

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

457
458
459
460
461
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
Michael Beck's avatar
Michael Beck committed
462
FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
463
464
465
466
467
468
469

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

472
473
474
475
476
477
478
479
/**
 * 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.
 */
480
481
#define IR_VA_START_PARAMETER_NUMBER  ((size_t)-1)

482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
/**
 * 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);

498
/** Returns initial value of entity with atomic type @p ent. */
499
FIRM_API ir_node *get_atomic_ent_value(const ir_entity *ent);
500
501
/** 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
502
FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
503

Matthias Braun's avatar
Matthias Braun committed
504
505
506
507
/** @defgroup ir_initializer  Entity Initializers
 * @{
 */

508
509
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
510
	/** initializer containing an ir_node from the const-code irg */
511
	IR_INITIALIZER_CONST,
512
	/** initializer containing a tarval */
513
	IR_INITIALIZER_TARVAL,
514
	/** initializes type with default values (usually 0) */
515
	IR_INITIALIZER_NULL,
516
	/** list of initializers used to initializer a compound or array type */
517
518
519
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

520
/** Returns kind of an initializer */
Michael Beck's avatar
Michael Beck committed
521
FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
522

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

526
/**
527
 * Returns the null initializer (there's only one instance of it in a program )
528
 */
Michael Beck's avatar
Michael Beck committed
529
FIRM_API ir_initializer_t *get_initializer_null(void);
530
531

/**
532
 * Creates an initializer containing a reference to a node on the const-code
533
534
 * irg.
 */
Michael Beck's avatar
Michael Beck committed
535
FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
536

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

540
/** Returns value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
541
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
542

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

546
/** Creates a compound initializer which holds @p n_entries entries */
547
FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
548

549
/** Returns the number of entries in a compound initializer */
550
FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
551

552
/** Sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
553
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
554
                                             size_t index,
555
                                             ir_initializer_t *value);
556

557
/** Returns the value with index @p index of a compound initializer */
Michael Beck's avatar
Michael Beck committed
558
FIRM_API ir_initializer_t *get_initializer_compound_value(
559
		const ir_initializer_t *initializer, size_t index);
560

Matthias Braun's avatar
Matthias Braun committed
561
562
/** @} */

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

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

569
/** Adds entity @p ent to the list of entities that overwrite @p overwritten. */
Michael Beck's avatar
Michael Beck committed
570
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
571
572
/** Returns the number of entities in the list of entities that overwrite
 * entity @p ent. */
573
FIRM_API size_t get_entity_n_overwrites(const ir_entity *ent);
574
575
576
577
578
/** 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. */
579
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, size_t pos);
580
581
582
583
/** 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
584
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
585

586
/** Returns number of entities overwritten by @p ent. */
587
FIRM_API size_t get_entity_n_overwrittenby(const ir_entity *ent);
588
589
590
591
592
/** 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. */
593
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, size_t pos);
594
595
596
597
598
599
/** 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);
600
601

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

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

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

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

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

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

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

641
642
643
644
645
646
/** 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);

647
648
649
650
651
652
653
/**
 * 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().
 */
654
FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
655
656

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

660
661
662
/** Sets additional graph properties. */
FIRM_API void add_entity_additional_properties(ir_entity *ent,
                                               mtp_additional_properties flag);
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684

/**
 * @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
685
 * - value         = Address(unknown_entity)
686
687
688
689
690
691
692
693
694
695
 * - values        = NULL
 * - val_paths     = NULL
 * - volatility    = volatility_non_volatile
 * - stickyness    = stickyness_unsticky
 * - ld_name       = NULL
 * - overwrites    = NULL
 * - overwrittenby = NULL
 * - irg           = NULL
 * - link          = NULL
 */
696

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

700
701
702
703
/** 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
704
705
/** @} */

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
 * @defgroup ir_type Type System
 *
 *  Datastructure to hold type information.
 *
722
 *  This module supplies a data structure to represent all types
Matthias Braun's avatar
Matthias Braun committed
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 *  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.
 *
 * @{
 */

740
741
742
743
/**
 *  An enum for the type kinds.
 *  For each type kind exists a typecode to identify it.
 */
744
typedef enum tp_opcode {
745
746
747
	tpo_uninitialized = 0,   /* not a type opcode */
	tpo_struct,              /**< A struct type. */
	tpo_union,               /**< An union type. */
748
749
750
	tpo_class,               /**< A class type. */
	tpo_segment,             /**< A segment type. */
	tpo_method,              /**< A method type. */
751
752
753
	tpo_array,               /**< An array type. */
	tpo_pointer,             /**< A pointer type. */
	tpo_primitive,           /**< A primitive type. */
754
	tpo_code,                /**< a piece of code (a basic block) */
755
	tpo_unknown,             /**< Special code for the Unknown type. */
756
	tpo_last = tpo_unknown   /* not a type opcode */
757
758
759
} tp_opcode;

/**
760
 * Returns the name of the type opcode @p opcode.
761
 */
762
FIRM_API const char *get_type_opcode_name(tp_opcode opcode);
763
764
765
766
767
768
769

/** 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.  */
770
FIRM_API int is_SubClass_of(const ir_type *low, const ir_type *high);
771
772
773
774
775
776
777

/** 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
778
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798

/** 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
799
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
800
801
802
803
804
805

/** 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
806
FIRM_API ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class,
807
                                           ir_entity* static_ent);
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823

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

824
825
826
/**
 * The state of the transitive closure.
 */
827
828
829
830
831
832
833
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;

834
835
/** Sets the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
836
FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
837
838
/** Sets the transitive closure of sub/superclass state for the
 * whole program to #inh_transitive_closure_invalid */
Michael Beck's avatar
Michael Beck committed
839
FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
840
841
/** Returns the transitive closure of sub/superclass state for the
 * whole program. */
Michael Beck's avatar
Michael Beck committed
842
FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
843
844
845
846

/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
847
 * This function walks over the ir (O(\#types+\#entities)) to compute the
848
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
849
FIRM_API void compute_inh_transitive_closure(void);
850
851

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

854
/** Start iteration over all transitive subtypes of @p tp */
Michael Beck's avatar
Michael Beck committed
855
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
856
857
858
859
/**
 * Returns next type in a subtype iteration started by
 * get_class_trans_subtype_first()
 */
Michael Beck's avatar
Michael Beck committed
860
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
861
862
863
864
865
/**
 * 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
866
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
867

868
/** Start iteration over all transitive supertypes of @p tp */
Michael Beck's avatar
Michael Beck committed
869
FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
870
871
872
873
/**
 * Returns next type in a supertype iteration started by
 * get_class_trans_supertype_first()
 */
Michael Beck's avatar
Michael Beck committed
874
FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
875

876
/** Start iteration over all entities that transitive overwrite entity @p ent.*/
Michael Beck's avatar
Michael Beck committed
877
FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
878
879
880
881
/**
 * Returns next entity in a overwrittenby iteration started by
 * get_entity_trans_overwrittenby_first()
 */
Michael Beck's avatar
Michael Beck committed
882
FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
883

884
885
/** Start iteration over all transitive overwritten entities, overwritten by
 * entity @p ent */
Michael Beck's avatar
Michael Beck committed
886
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
887
888
889
890
/**
 * Returns next entity in a overwrites iteration started by
 * get_entity_trans_overwrites_first()
 */
Michael Beck's avatar
Michael Beck committed
891
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
892
893
894
895
896


/**
 * Checks a type.
 *
897
 * @return non-zero if no errors were found
898
 */
899
FIRM_API int check_type(const ir_type *tp);
900
901
902
903

/**
 * Walks the type information and performs a set of sanity checks.
 *
904
 * @return 0 in case of an error
905
 */
906
FIRM_API int tr_verify(void);
907

908
909
/**
 * Frees the memory used by the type.
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
910
 *
911
912
 * Removes the type from the type list and frees all entities
 * belonging to the type.
Matthias Braun's avatar
Matthias Braun committed
913
 */
Michael Beck's avatar
Michael Beck committed
914
FIRM_API void free_type(ir_type *tp);
915

916
917
/** Returns opcode of type @p type */
FIRM_API tp_opcode get_type_opcode(const ir_type *type);
918

919
920
921
922
923
924
925
926
927
/**
 * 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
928
FIRM_API void ir_print_type(char *buffer, size_t buffer_size,
929
                            const ir_type *tp);
930

931
/** The state of the type layout. */
932
typedef enum {
Michael Beck's avatar
Michael Beck committed
933
934
935
	layout_undefined,    /**< The layout of this type is not defined.
	                          Address computation to access fields is not
	                          possible, fields must be accessed by Sel
936
	                          nodes.
Michael Beck's avatar
Michael Beck committed
937
938
939
	                          This is the default value except for
	                          pointer, primitive and method types. */
	layout_fixed         /**< The layout is fixed, all component/member entities
940
941
942
943
944
	                          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.
	                          */
945
} ir_type_state;
946

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

950
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
951
FIRM_API ir_type_state get_type_state(const ir_type *tp);
952
953
954
955
956
957

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

960
961
962
963
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
964
FIRM_API ir_mode *get_type_mode(const ir_type *tp);
965

966
/** Returns the size of a type in bytes. */
Michael Beck's avatar
Michael Beck committed
967
FIRM_API unsigned get_type_size_bytes(const ir_type *tp);
968
969
970

/** Sets the size of a type in bytes.
 *
971
972
 * For primitive, pointer and method types the size is always fixed.
 * This call is legal but has no effect.
973
 */
Michael Beck's avatar
Michael Beck committed
974
FIRM_API void set_type_size_bytes(ir_type *tp, unsigned size);
975

Matthias Braun's avatar
Matthias Braun committed
976
/** Returns the alignment of a type in bytes. */
977
FIRM_API unsigned get_type_alignment_bytes(const ir_type *tp);
978

979
/** Sets the alignment of a type in bytes. */
Michael Beck's avatar
Michael Beck committed
980
FIRM_API void set_type_alignment_bytes(ir_type *tp, unsigned align);
Michael Beck's avatar
Michael Beck committed
981

982
983
/** Returns the visited counter of a type.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
984
FIRM_API ir_visited_t get_type_visited(const ir_type *tp);
985
986
/** Sets the visited counter of a type to num.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
987
FIRM_API void set_type_visited(ir_type *tp, ir_visited_t num);
988
989
/** Sets visited field in type to type_visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
990
FIRM_API void mark_type_visited(ir_type *tp);
991
992
/** Returns non-zero if the type is already visited
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
993
FIRM_API int type_visited(const ir_type *tp);
994

Michael Beck's avatar
Michael Beck committed
995
/** Returns the associated link field of a type. */