typerep.h 93.1 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
Michael Beck's avatar
Michael Beck committed
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */
yb9976's avatar
yb9976 committed
19
20
21

/**
 * @file
22
 * @brief Declarations for functions and datastructures to represent types
yb9976's avatar
yb9976 committed
23
 */
24
25
26
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

27
#include <stdlib.h>
28
29
30
#include "firm_types.h"

#include "begin.h"
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

/**
 * @page entity       Entity representation
 *
 * An entity is the representation of program known objects in Firm.
 * The primary concept of entities is to represent members of complex
 * types, i.e., fields and methods of classes.  As not all programming
 * language model all variables and methods as members of some class,
 * the concept of entities is extended to cover also local and global
 * variables, and arbitrary procedures.
 *
 * An entity always specifies the type of the object it represents and
 * the type of the object it is a part of, the owner of the entity.
 * Originally this is the type of the class of which the entity is a
 * member.
 * The owner of local variables is the procedure they are defined in.
 * The owner of global variables and procedures visible in the whole
 * program is a universally defined class type "GlobalType".  The owner
 * of procedures defined in the scope of an other procedure is the
 * enclosing procedure.
 *
 * The type ir_entity is an abstract data type to represent program entities.
 * If contains the following attributes:
 *
 *   - owner:      A compound type this entity is a part of.
 *   - type:       The type of this entity.
Matthias Braun's avatar
Matthias Braun committed
57
58
 *   - name:       The string that represents this entity in the source program
 *   - linkage:    A flag indicating how the linker treats a symbol
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 *   - offset:     The offset of the entity within the compound object in bytes.  Only set
 *                 if the owner in the state "layout_fixed".
 *   - offset_bits_remainder:   The offset bit remainder of a bitfield entity (in a compound)
 *                 in bits.  Only set if the owner in the state "layout_fixed".
 *   - overwrites: A list of entities overwritten by this entity.  This list is only
 *                 existent if the owner of this entity is a class.  The members in
 *                 this list must be entities of super classes.
 *   - overwrittenby: A list of entities that overwrite this entity.  This list is only
 *                 existent if the owner of this entity is a class.  The members in
 *                 this list must be entities of sub classes.
 *   - link:       A void* to associate some additional information with the entity.
 *   - irg:        If the entity is a method this is the ir graph that represents the
 *                 code of the method.
 *   - visited:    visited flag.  Master flag is type_visited.
 *
 * These fields can only be accessed via access functions.
 *
 * @see  ir_type, ir_entity
 */

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/**
 * Visibility classed for entities.
 */
typedef enum {
	/**
	 * The entity is visible outside the compilation unit, but it is defined
	 * here.
	 */
	ir_visibility_default,
	/**
	 * The entity is local to the compilation unit.
	 * A local entity is not visible in other compilation units.
	 * Note that the entity might still be accessed indirectly from other units
	 * through pointers.
	 */
	ir_visibility_local,
	/**
	 * The entity is defined outside the compilation unit but potentially used
	 * here.
	 */
99
100
101
102
103
104
105
106
107
	ir_visibility_external,
	/**
	 * This has the same semantic as visibility_local. Additionally the symbol is
	 * completely hidden from the linker (it only appears in the assembly).
	 * While visibility_local is probably still visible to debuggers,
	 * visibility_private symbols aren't and probably won't appear in the object
	 * files
	 */
	ir_visibility_private
108
109
} ir_visibility;

Matthias Braun's avatar
Matthias Braun committed
110
111
/**
 * linkage specifies how the linker treats symbols
112
113
 */
typedef enum {
114
	IR_LINKAGE_DEFAULT         = 0,
Matthias Braun's avatar
Matthias Braun committed
115
116
117
118
119
120
	/**
	 * A symbol whose definition won't change in a program.
	 * Optimisation might replace loads from this entity with constants.
	 * Also most linkers put such data in a constant segment which is shared
	 * between multiple running instances of the same application.
	 */
121
	IR_LINKAGE_CONSTANT        = 1 << 0,
Matthias Braun's avatar
Matthias Braun committed
122
123
124
125
126
127
	/**
	 * The entity is a weak symbol.
	 * A weak symbol is overridden by a non-weak symbol if one exists.
	 * Most linkers only support the IR_LINKAGE_WEAK in combination with
	 * IR_LINKAGE_MERGE.
	 */
128
	IR_LINKAGE_WEAK            = 1 << 1,
Matthias Braun's avatar
Matthias Braun committed
129
130
131
132
133
	/**
	 * The entity may be removed when it isn't referenced anywhere in the
	 * compilation unit even if it is exported (non-local).
	 * Typically used for C++ instantiated template code (,,COMDAT'' section).
	 */
134
	IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
135
136
137
138
139
140
	/**
	 * The linker will try to merge entities with same name from different
	 * compilation units. This is the usual behaviour for global variables
	 * without explicit initialisation in C (``COMMON'' symbols). It's also
	 * typically used in C++ for instantiated template code (,,COMDAT'' section)
	 */
141
	IR_LINKAGE_MERGE           = 1 << 3,
Matthias Braun's avatar
Matthias Braun committed
142
143
144
145
146
147
148
149
	/**
	 * Some entity uses are potentially hidden from the compiler.
	 * (For example because they happen in an asm("") statement. This flag
	 *  should be set for __attribute__((used)) in C code).
	 * Setting this flag prohibits that the compiler making assumptions about
	 * read/write behaviour to global variables or changing calling conventions
	 * from cdecl to fastcall.
	 */
150
	IR_LINKAGE_HIDDEN_USER     = 1 << 4
Matthias Braun's avatar
Matthias Braun committed
151
152
153
} ir_linkage;

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

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

/**
164
165
166
167
168
169
 * Return 1 if the entity is visible outside the current compilation unit
 * or to unknown callers (like asm statements).
 * (The entity might still be accessible indirectly through pointers)
 * This is a convenience function and does the same as
 * get_entity_visibility(entity) != ir_visibility_local ||
 * (get_entity_linkage(entity) & IR_LINKAGE_HIDDEN_USER)
Matthias Braun's avatar
Matthias Braun committed
170
 */
Michael Beck's avatar
Michael Beck committed
171
FIRM_API int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
172
173

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

/**
 * Creates a new entity.
 *
 * Automatically inserts the entity as a member of owner.
 * Entity is automatic_allocated and uninitialized except if the type
 * is type_method, then it is static_allocated and constant.  The constant
 * value is a pointer to the method.
 * Visibility is local, offset -1, and it is not volatile.
 */
Michael Beck's avatar
Michael Beck committed
188
FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
189
190
191
192
193
194
195
196
197
198

/**
 * Creates a new entity.
 *
 * Automatically inserts the entity as a member of owner.
 * The entity is automatic allocated and uninitialized except if the type
 * is type_method, then it is static allocated and constant.  The constant
 * value is a pointer to the method.
 * Visibility is local, offset -1, and it is not volatile.
 */
Michael Beck's avatar
Michael Beck committed
199
FIRM_API ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp,
200
                                 dbg_info *db);
201
202
203
204
205
206
207
208
209

/**
 * Copies the entity if the new_owner is different from the
 * owner of the old entity,  else returns the old entity.
 *
 * Automatically inserts the new entity as a member of owner.
 * Resets the overwrites/overwritten_by fields.
 * Keeps the old atomic value.
 */
Michael Beck's avatar
Michael Beck committed
210
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
211
212
213
214
215
216
217
218
219

/**
 * Copies the entity if the new_name is different from the
 * name of the old entity, else returns the old entity.
 *
 * Automatically inserts the new entity as a member of owner.
 * The mangled name ld_name is set to NULL.
 * Overwrites relation is copied from old.
 */
Michael Beck's avatar
Michael Beck committed
220
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
221
222
223
224
225
226
227

/**
 * Frees the entity.
 *
 * The owner will still contain the pointer to this
 * entity, as well as all other references!
 */
Michael Beck's avatar
Michael Beck committed
228
FIRM_API void free_entity(ir_entity *ent);
229
230

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

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

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

/** Returns the mangled name of the entity.
 *
 * If the mangled name is set it returns the existing name.
 * Else it generates a name with mangle_entity()
 * and remembers this new name internally.
 */
Michael Beck's avatar
Michael Beck committed
245
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
246
247

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

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

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

256
257
258
259
260
/**
 * 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
261
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
262
263

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

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

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

Matthias Braun's avatar
Matthias Braun committed
272
/** Sets the linkage of an entity. */
Michael Beck's avatar
Michael Beck committed
273
274
275
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
276

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
313
314
315
316
317

/**
 * This enumeration flags the align of Loads/Stores.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
318
319
320
321
322
typedef enum {
	align_non_aligned,    /**< The entity is not aligned. */
	align_is_aligned      /**< The entity is aligned. Default */
} ir_align;

Matthias Braun's avatar
Matthias Braun committed
323
324
325
326
/**
 * Returns indication wether entity is aligned in memory.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
327
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
328

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

Michael Beck's avatar
Michael Beck committed
335
/** Return the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
336
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
337

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

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

/** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
Michael Beck's avatar
Michael Beck committed
345
FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
346
347

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

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
352
FIRM_API void *get_entity_link(const ir_entity *ent);
353
354

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

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

363
364
365
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

366
/** Gets the entity vtable number. */
Michael Beck's avatar
Michael Beck committed
367
FIRM_API unsigned get_entity_vtable_number(const ir_entity *ent);
368
369

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

372
/** Set label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
373
FIRM_API void set_entity_label(ir_entity *ent, ir_label_t label);
374
/** Return label number of an entity with code type */
Michael Beck's avatar
Michael Beck committed
375
FIRM_API ir_label_t get_entity_label(const ir_entity *ent);
376

377
/** Checks if an entity is compiler generated. */
Michael Beck's avatar
Michael Beck committed
378
FIRM_API int is_entity_compiler_generated(const ir_entity *ent);
379
380

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

383
/**
384
 * Bitfield type indicating the way an entity is used.
385
386
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
387
388
389
390
391
392
393
	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 */
394
395
396
397
398
399
	ir_usage_unknown
		= ir_usage_address_taken | ir_usage_write | ir_usage_read
		| ir_usage_reinterpret_cast
} ir_entity_usage;

/** Return the entity usage */
Michael Beck's avatar
Michael Beck committed
400
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
401
402

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

405
406
407
408
409
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
Michael Beck's avatar
Michael Beck committed
410
FIRM_API dbg_info *get_entity_dbg_info(const ir_entity *ent);
411
412
413
414
415
416
417

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

420
421
422
423
424
425
426
427
/* -- Representation of constant values of entities -- */
/**
 * Returns true if the the node is representable as code on
 * const_code_irg.
 *
 * @deprecated This function is not used by libFirm and stays here
 *             only as a helper for the old Jack frontend.
 */
Michael Beck's avatar
Michael Beck committed
428
FIRM_API int is_irn_const_expression(ir_node *n);
429
430
431

/**
 * Copies a Firm subgraph that complies to the restrictions for
432
 * constant expressions to block.
433
434
435
436
437
438
439
 *
 * @param dbg  debug info for all newly created nodes
 * @param n    the node
 *
 * Set current_ir_graph to get_const_code_irg() to generate a constant
 * expression.
 */
440
FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
441
442

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

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

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

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

464
465
466
/**
 * returns the null initializer (there's only one instance of it in a program )
 */
Michael Beck's avatar
Michael Beck committed
467
FIRM_API ir_initializer_t *get_initializer_null(void);
468
469
470
471
472

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

/** creates an initializer containing a single tarval value */
Michael Beck's avatar
Michael Beck committed
476
FIRM_API ir_initializer_t *create_initializer_tarval(tarval *tv);
477
478

/** return value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
479
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
480
481

/** return value contained in a tarval initializer */
Michael Beck's avatar
Michael Beck committed
482
FIRM_API tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);
483
484

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

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

/** sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
491
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
492
493
                                             unsigned index,
                                             ir_initializer_t *value);
494
495

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

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

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

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

508
509
510
511
512
513
514
515
516
517
/* --- Fields of entities with a class type as owner --- */
/* Overwrites is a field that specifies that an access to the overwritten
   entity in the supertype must use this entity.  It's a list as with
   multiple inheritance several entities can be overwritten.  This field
   is mostly useful for method entities.
   If a Sel node selects an entity that is overwritten by other entities it
   must return a pointer to the entity of the dynamic type of the pointer
   that is passed to it.  Lowering of the Sel node must assure this.
   Overwrittenby is the inverse of overwrites.  Both add routines add
   both relations, they only differ in the order of arguments. */
Michael Beck's avatar
Michael Beck committed
518
519
520
521
522
523
FIRM_API void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
FIRM_API int get_entity_n_overwrites(const ir_entity *ent);
FIRM_API int get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
FIRM_API ir_entity *get_entity_overwrites(const ir_entity *ent, int pos);
FIRM_API void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
FIRM_API void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
524

Michael Beck's avatar
Michael Beck committed
525
526
527
528
529
FIRM_API int get_entity_n_overwrittenby(const ir_entity *ent);
FIRM_API int get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
FIRM_API ir_entity *get_entity_overwrittenby(const ir_entity *ent, int pos);
FIRM_API void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
FIRM_API void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
530
531
532
533
534
535
536
537
538

/**
 *   Checks whether a pointer points to an entity.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is an entity, else false
 */
Michael Beck's avatar
Michael Beck committed
539
FIRM_API int is_entity(const void *thing);
540
541
542
543

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

/** 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
557
FIRM_API long get_entity_nr(const ir_entity *ent);
558
559

/** Returns the entities visited count. */
Michael Beck's avatar
Michael Beck committed
560
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
561
562

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

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

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

/** Returns true if this entity was not visited. */
Michael Beck's avatar
Michael Beck committed
572
FIRM_API int entity_not_visited(const ir_entity *ent);
573
574
575
576
577
578
579
580

/**
 * Returns the mask of the additional entity properties.
 * The properties are automatically inherited from the irg if available
 * or from the method type if they were not set using
 * set_entity_additional_properties() or
 * set_entity_additional_property().
 */
Michael Beck's avatar
Michael Beck committed
581
FIRM_API unsigned get_entity_additional_properties(const ir_entity *ent);
582
583

/** Sets the mask of the additional graph properties. */
Michael Beck's avatar
Michael Beck committed
584
FIRM_API void set_entity_additional_properties(ir_entity *ent,
585
                                               unsigned property_mask);
586
587

/** Sets one additional graph property. */
Michael Beck's avatar
Michael Beck committed
588
FIRM_API void set_entity_additional_property(ir_entity *ent,
589
                                             mtp_additional_property flag);
590
591
592

/** Returns the class type that this type info entity represents or NULL
    if ent is no type info entity. */
Michael Beck's avatar
Michael Beck committed
593
FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626

/**
 * @page unknown_entity  The Unknown entity
 *
 *  This entity is an auxiliary entity dedicated to support analyses.
 *
 *  The unknown entity represents that there could be an entity, but it is not
 *  known.  This entity can be used to initialize fields before an analysis (not known
 *  yet) or to represent the top of a lattice (could not be determined).  There exists
 *  exactly one entity unknown. This entity has as owner and as type the unknown type. It is
 *  allocated when initializing the entity module.
 *
 *  The entity can take the role of any entity, also methods.  It returns default
 *  values in these cases.
 *
 *  The following values are set:
 *
 * - name          = "unknown_entity"
 * - ld_name       = "unknown_entity"
 * - owner         = unknown_type
 * - type          = unknown_type
 * - offset        = -1
 * - value         = SymConst(unknown_entity)
 * - values        = NULL
 * - val_paths     = NULL
 * - volatility    = volatility_non_volatile
 * - stickyness    = stickyness_unsticky
 * - ld_name       = NULL
 * - overwrites    = NULL
 * - overwrittenby = NULL
 * - irg           = NULL
 * - link          = NULL
 */
627
628

/** A variable that contains the only unknown entity. */
Michael Beck's avatar
Michael Beck committed
629
FIRM_API ir_entity *unknown_entity;
630
631

/** Returns the @link unknown_entity unknown entity @endlink. */
Michael Beck's avatar
Michael Beck committed
632
FIRM_API ir_entity *get_unknown_entity(void);
633
634
635

/** Encodes how a pointer parameter is accessed. */
typedef enum acc_bits {
Michael Beck's avatar
Michael Beck committed
636
637
638
639
640
641
	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 */
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
} ptr_access_kind;

#define IS_READ(a)     ((a) & ptr_access_read)
#define IS_WRITTEN(a)  ((a) & ptr_access_write)
#define IS_STORED(a)   ((a) & ptr_access_store)

/**
 * @page tyop  type operations
 *  This module specifies the kinds of types available in firm.
 *
 *  They are called type opcodes. These include classes, structs, methods, unions,
 *  arrays, enumerations, pointers and primitive types.
 *  Special types with own opcodes are the id type, a type representing an unknown
 *  type and a type used to specify that something has no type.
 */

/**
 *  An enum for the type kinds.
 *  For each type kind exists a typecode to identify it.
 */
typedef enum {
	tpo_uninitialized = 0,   /* not a type opcode */
	tpo_class,               /**< A class type. */
	tpo_struct,              /**< A struct type. */
	tpo_method,              /**< A method type. */
	tpo_union,               /**< An union type. */
	tpo_array,               /**< An array type. */
	tpo_enumeration,         /**< An enumeration type. */
	tpo_pointer,             /**< A pointer type. */
	tpo_primitive,           /**< A primitive type. */
672
	tpo_code,                /**< a piece of code (a basic block) */
673
674
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
675
	tpo_last = tpo_unknown   /* not a type opcode */
676
677
678
679
680
681
682
683
} tp_opcode;

/**
 * A structure containing information about a kind of type.
 * A structure containing information about a kind of type.  So far
 * this is only the kind name, an enum for case-switching and some
 * internal values.
 *
684
 * @see  get_tpop_name(), get_tpop_code()
685
686
687
688
689
690
691
692
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
693
 * @return    a string.
694
 */
Michael Beck's avatar
Michael Beck committed
695
FIRM_API const char *get_tpop_name(const tp_op *op);
696
697
698
699
700
701
702

/**
 * Returns an enum for the type opcode.
 *
 * @param op   The type opcode to get the enum from.
 * @return the enum.
 */
Michael Beck's avatar
Michael Beck committed
703
FIRM_API tp_opcode get_tpop_code(const tp_op *op);
704
705
706
707
708
709
710
711
712
713

/**
 * This type opcode marks that the corresponding type is a class type.
 *
 * Consequently the type refers to supertypes, subtypes and entities.
 * Entities can be any fields, but also methods.
 * @@@ value class or not???
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
714
715
FIRM_API const tp_op *type_class;
FIRM_API const tp_op *get_tpop_class(void);
716
717
718
719
720
721
722
723
724
725

/**
 * This type opcode marks that the corresponding type is a compound type
 * as a struct in C.
 *
 * Consequently the type refers to a list of entities
 * which may not be methods (but pointers to methods).
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
726
727
FIRM_API const tp_op *type_struct;
FIRM_API const tp_op *get_tpop_struct(void);
728
729
730
731
732
733
734
735

/**
 * This type opcode marks that the corresponding type is a method type.
 *
 * Consequently it refers to a list of arguments and results.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
736
737
FIRM_API const tp_op *type_method;
FIRM_API const tp_op *get_tpop_method(void);
738
739
740
741
742
743
744
745

/**
 * This type opcode marks that the corresponding type is a union type.
 *
 * Consequently it refers to a list of unioned types.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
746
747
FIRM_API const tp_op *type_union;
FIRM_API const tp_op *get_tpop_union(void);
748
749
750
751
752
753
754
755
756

/**
 * This type opcode marks that the corresponding type is an array type.
 *
 * Consequently it contains a list of dimensions (lower and upper bounds)
 * and an element type.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
757
758
FIRM_API const tp_op *type_array;
FIRM_API const tp_op *get_tpop_array(void);
759
760
761
762
763
764
765
766
767
768

/**
 * This type opcode marks that the corresponding type is an enumeration type.
 *
 * Consequently it contains a list of idents for the enumeration identifiers
 * and a list of target values that are the constants used to implement
 * the enumerators.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
769
770
FIRM_API const tp_op *type_enumeration;
FIRM_API const tp_op *get_tpop_enumeration(void);
771
772
773
774
775
776
777
778

/**
 * This type opcode marks that the corresponding type is a pointer type.
 *
 * It contains a reference to the type the pointer points to.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
779
780
FIRM_API const tp_op *type_pointer;
FIRM_API const tp_op *get_tpop_pointer(void);
781
782
783
784
785
786
787
788
789

/**
 * This type opcode marks that the corresponding type is a primitive type.
 *
 * Primitive types are types that are directly mapped to target machine
 * modes.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
Michael Beck's avatar
Michael Beck committed
790
791
FIRM_API const tp_op *type_primitive;
FIRM_API const tp_op *get_tpop_primitive(void);
792

793
794
795
/**
 * The code type is used to mark pieces of code (basic blocks)
 */
Michael Beck's avatar
Michael Beck committed
796
797
FIRM_API const tp_op *tpop_code;
FIRM_API const tp_op *get_tpop_code_type(void);
798

799
800
801
802
803
804
805
806
/**
 * This type opcode is an auxiliary opcode dedicated to support type analyses.
 *
 * Types with this opcode represents that there is no type.
 * The type can be used to initialize fields of the type* that actually can not
 * contain a type or that are initialized for an analysis. There exists exactly
 * one type with this opcode.
 */
Michael Beck's avatar
Michael Beck committed
807
808
FIRM_API const tp_op *tpop_none;
FIRM_API const tp_op *get_tpop_none(void);
809
810
811
812
813
814
815
816
817

/**
 * This type opcode is an auxiliary opcode dedicated to support type analyses.
 *
 * Types with this opcode represents that there could be a type, but it is not
 * known.  This type can be used to initialize fields before an analysis (not known
 * yet) or to represent the top of a lattice (could not be determined).  There exists
 * exactly one type with this opcode.
 */
Michael Beck's avatar
Michael Beck committed
818
819
FIRM_API const tp_op *tpop_unknown;
FIRM_API const tp_op *get_tpop_unknown(void);
820
821
822
823
824
825
826
827
828
829
830

/* ----------------------------------------------------------------------- */
/* Classify pairs of types/entities in the inheritance relations.          */
/* ----------------------------------------------------------------------- */

/** Returns true if low is subclass of high.
 *
 *  Low is a subclass of high if low == high or if low is a subclass of
 *  a subclass of high.  I.e, we search in all subtypes of high for low.
 *  @@@ this can be implemented more efficient if we know the set of all
 *  subclasses of high.  */
Michael Beck's avatar
Michael Beck committed
831
FIRM_API int is_SubClass_of(ir_type *low, ir_type *high);
832
833
834
835
836
837
838

/** 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
839
FIRM_API int is_SubClass_ptr_of(ir_type *low, ir_type *high);
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859

/** 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
860
FIRM_API int is_overwritten_by(ir_entity *high, ir_entity *low);
861
862
863
864
865
866

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

/* ----------------------------------------------------------------------- */
/* Resolve implicit inheritance.                                           */
/* ----------------------------------------------------------------------- */

/** Default name mangling for inherited entities.
 *
 *  Returns an ident that consists of the name of type followed by an
 *  underscore and the name (not ld_name) of the entity. */
Michael Beck's avatar
Michael Beck committed
878
FIRM_API ident *default_mangle_inherited_name(const ir_entity *ent,
879
                                              const ir_type *clss);
880
881
882
883
884
885
886
887

/** Type of argument functions for inheritance resolver.
 *
 * @param ent     The entity in the super type that will be overwritten
 *                by the newly generated entity, for which this name is
 *                used.
 * @param clss    The class type in which the new entity will be placed.
 */
888
889
typedef ident *mangle_inherited_name_func(const ir_entity *ent,
                                          const ir_type *clss);
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904

/** Resolve implicit inheritance.
 *
 *  Resolves the implicit inheritance supplied by firm.  Firm defines,
 *  that each entity that is not overwritten in a subclass is
 *  inherited to this subclass without change implicitly.  This
 *  function generates entities that explicitly represent this
 *  inheritance.  It generates for each entity overwriting entities in
 *  all subclasses of the owner of the entity, if the entity is not
 *  overwritten in that subclass.
 *
 *  The name of the new entity is generated with the function passed.
 *  If the function is NULL, the default_mangle_inherited_name() is
 *  used.
 */
Michael Beck's avatar
Michael Beck committed
905
FIRM_API void resolve_inheritance(mangle_inherited_name_func *mfunc);
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922


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

923
924
925
/**
 * The state of the transitive closure.
 */
926
927
928
929
930
931
932
typedef enum {
	inh_transitive_closure_none,       /**<  Closure is not computed, can not be accessed. */
	inh_transitive_closure_valid,      /**<  Closure computed and valid. */
	inh_transitive_closure_invalid,    /**<  Closure invalid, but can be accessed. */
	inh_transitive_closure_max         /**<  Invalid value. */
} inh_transitive_closure_state;

Michael Beck's avatar
Michael Beck committed
933
934
935
FIRM_API void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
FIRM_API void invalidate_irp_inh_transitive_closure_state(void);
FIRM_API inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
936
937
938
939
940


/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
941
 * This function walks over the ir (O(\#types+\#entities)) to compute the
942
 * transitive closure.    */
Michael Beck's avatar
Michael Beck committed
943
FIRM_API void compute_inh_transitive_closure(void);
944
945

/** Free memory occupied by the transitive closure information. */
Michael Beck's avatar
Michael Beck committed
946
FIRM_API void free_inh_transitive_closure(void);
947
948
949
950
951


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

/** Iterate over all transitive subtypes. */
Michael Beck's avatar
Michael Beck committed
952
953
954
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
955
956
957
958

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

/** Iterate over all transitive supertypes. */
Michael Beck's avatar
Michael Beck committed
959
960
FIRM_API ir_type *get_class_trans_supertype_first(const ir_type *tp);
FIRM_API ir_type *get_class_trans_supertype_next(const ir_type *tp);
961
962
963
964

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

/** Iterate over all entities that transitive overwrite this entities. */
Michael Beck's avatar
Michael Beck committed
965
966
FIRM_API ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
FIRM_API ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
967
968
969
970

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

/** Iterate over all transitive overwritten entities. */
Michael Beck's avatar
Michael Beck committed
971
972
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000


/* ----------------------------------------------------------------------- */
/** The state of Cast operations that cast class types or pointers to class
 *  types.
 *
 * The state expresses, how far Cast operations conform with the class
 * hierarchy.
 *
 *   class A {}
 *   class B1 extends A {}
 *   class B2 extends A {}
 *   class C  extends B1 {}
 * normalized:  Cast operations conform with the inheritance relation.
 *   I.e., the type of the operand of a Cast is either a super= or a sub-
 *   type of the type casted to. Example: (A)((B2) (new C())).
 * transitive:  Cast operations conform with the transitive inheritance
 *   relation. Example: (A)(new C()).
 * any:  Cast operations do not conform with the transitive inheritance
 *   relation.  Example: (B2)(new B1())
 */
/* ----------------------------------------------------------------------- */

/** Flags for class cast state.
 *
 * The state in irp is always smaller or equal to the state of any
 * irg.
 *
For faster browsing, not all history is shown. View entire blame