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

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

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

#include "begin.h"
31
32

/**
Matthias Braun's avatar
Matthias Braun committed
33
 * @defgroup ir_entity Entities
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 *
 * An entity is the representation of program known objects in Firm.
 * The primary concept of entities is to represent members of complex
 * types, i.e., fields and methods of classes.  As not all programming
 * language model all variables and methods as members of some class,
 * the concept of entities is extended to cover also local and global
 * variables, and arbitrary procedures.
 *
 * An entity always specifies the type of the object it represents and
 * the type of the object it is a part of, the owner of the entity.
 * Originally this is the type of the class of which the entity is a
 * member.
 * The owner of local variables is the procedure they are defined in.
 * The owner of global variables and procedures visible in the whole
 * program is a universally defined class type "GlobalType".  The owner
 * of procedures defined in the scope of an other procedure is the
 * enclosing procedure.
 *
 * The type ir_entity is an abstract data type to represent program entities.
 * If contains the following attributes:
 *
 *   - owner:      A compound type this entity is a part of.
 *   - type:       The type of this entity.
Matthias Braun's avatar
Matthias Braun committed
57
58
 *   - name:       The string that represents this entity in the source program
 *   - linkage:    A flag indicating how the linker treats a symbol
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 *   - offset:     The offset of the entity within the compound object in bytes.  Only set
 *                 if the owner in the state "layout_fixed".
 *   - offset_bits_remainder:   The offset bit remainder of a bitfield entity (in a compound)
 *                 in bits.  Only set if the owner in the state "layout_fixed".
 *   - overwrites: A list of entities overwritten by this entity.  This list is only
 *                 existent if the owner of this entity is a class.  The members in
 *                 this list must be entities of super classes.
 *   - overwrittenby: A list of entities that overwrite this entity.  This list is only
 *                 existent if the owner of this entity is a class.  The members in
 *                 this list must be entities of sub classes.
 *   - link:       A void* to associate some additional information with the entity.
 *   - irg:        If the entity is a method this is the ir graph that represents the
 *                 code of the method.
 *   - visited:    visited flag.  Master flag is type_visited.
 *
 * These fields can only be accessed via access functions.
 *
76
77
78
79
80
81
82
83
84
85
 * Overwrites is a field that specifies that an access to the overwritten
 * entity in the supertype must use this entity.  It's a list as with
 * multiple inheritance several entities can be overwritten.  This field
 * is mostly useful for method entities.
 * If a Sel node selects an entity that is overwritten by other entities it
 * must return a pointer to the entity of the dynamic type of the pointer
 * that is passed to it.  Lowering of the Sel node must assure this.
 * Overwrittenby is the inverse of overwrites.  Both add routines add
 * both relations, they only differ in the order of arguments.
 *
Matthias Braun's avatar
Matthias Braun committed
86
 * @{
87
88
 */

89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/**
 * 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.
	 */
109
110
111
112
113
114
115
116
117
	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
118
119
} ir_visibility;

Matthias Braun's avatar
Matthias Braun committed
120
121
/**
 * linkage specifies how the linker treats symbols
122
 */
123
typedef enum ir_linkage {
124
	IR_LINKAGE_DEFAULT         = 0,
Matthias Braun's avatar
Matthias Braun committed
125
126
127
128
129
130
	/**
	 * 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.
	 */
131
	IR_LINKAGE_CONSTANT        = 1 << 0,
Matthias Braun's avatar
Matthias Braun committed
132
133
134
135
136
137
	/**
	 * 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.
	 */
138
	IR_LINKAGE_WEAK            = 1 << 1,
Matthias Braun's avatar
Matthias Braun committed
139
140
141
142
143
	/**
	 * 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).
	 */
144
	IR_LINKAGE_GARBAGE_COLLECT = 1 << 2,
Matthias Braun's avatar
Matthias Braun committed
145
146
147
148
149
150
	/**
	 * 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)
	 */
151
	IR_LINKAGE_MERGE           = 1 << 3,
Matthias Braun's avatar
Matthias Braun committed
152
153
154
155
156
157
158
159
	/**
	 * 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.
	 */
160
	IR_LINKAGE_HIDDEN_USER     = 1 << 4
Matthias Braun's avatar
Matthias Braun committed
161
} ir_linkage;
162
ENUM_BITSET(ir_linkage)
Matthias Braun's avatar
Matthias Braun committed
163
164

/**
165
 * Returns the visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
166
 */
Michael Beck's avatar
Michael Beck committed
167
FIRM_API ir_visibility get_entity_visibility(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
168
169

/**
170
 * Sets visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
171
 */
Michael Beck's avatar
Michael Beck committed
172
FIRM_API void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
Matthias Braun's avatar
Matthias Braun committed
173
174

/**
175
 * Returns 1 if the entity is visible outside the current compilation unit
176
177
178
179
180
 * 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
181
 */
Michael Beck's avatar
Michael Beck committed
182
FIRM_API int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
183
184

/**
185
 * Returns 1 if the entity has a definition (initializer) in the current
186
 * compilation unit
Matthias Braun's avatar
Matthias Braun committed
187
 */
Michael Beck's avatar
Michael Beck committed
188
FIRM_API int entity_has_definition(const ir_entity *entity);
189
190
191
192
193
194
195
196
197
198

/**
 * 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
199
FIRM_API ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
200
201
202
203
204
205
206
207
208
209

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

213
214
215
216
217
218
219
220
221
222
223
224
225
/**
 * Creates a new entity corresponding to a function parameter.
 * This must be created on an irgs frame_type
 */
FIRM_API ir_entity *new_parameter_entity(ir_type *owner, size_t pos,
                                         ir_type *type);

/**
 * Like new_parameter_entity() but with debug information.
 */
FIRM_API ir_entity *new_d_parameter_entity(ir_type *owner, size_t pos,
                                           ir_type *type, dbg_info *dbgi);

Matthias Braun's avatar
Matthias Braun committed
226
227
228
229
/**
 * Check an entity. Currently, we check only if initialized constants
 * are build on the const irg graph.
 *
230
 * @return non-zero if no errors were found
Matthias Braun's avatar
Matthias Braun committed
231
 */
232
FIRM_API int check_entity(const ir_entity *ent);
Matthias Braun's avatar
Matthias Braun committed
233

234
235
236
237
238
239
240
241
/**
 * 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
242
FIRM_API ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
243
244
245
246
247
248
249
250
251

/**
 * 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
252
FIRM_API ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
253
254
255
256
257
258
259

/**
 * 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
260
FIRM_API void free_entity(ir_entity *ent);
261
262

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

/** Returns the ident of an entity. */
Michael Beck's avatar
Michael Beck committed
266
FIRM_API ident *get_entity_ident(const ir_entity *ent);
267
268

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
269
FIRM_API void set_entity_ident(ir_entity *ent, ident *id);
270
271
272
273
274
275
276

/** 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
277
FIRM_API ident *get_entity_ld_ident(const ir_entity *ent);
278
279

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

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

285
286
287
/** returns 1 if the entity has an ld_ident set explicitely */
FIRM_API int entity_has_ld_ident(const ir_entity *entity);

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

291
292
293
294
295
/**
 * 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
296
FIRM_API void set_entity_owner(ir_entity *ent, ir_type *owner);
297
298

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

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

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

307
/** Sets the linkage flags of entity @p entity to @p linkage. */
Michael Beck's avatar
Michael Beck committed
308
FIRM_API void set_entity_linkage(ir_entity *entity, ir_linkage linkage);
309
/** Adds linkage flags @p linkage to entity @p entity. */
Michael Beck's avatar
Michael Beck committed
310
FIRM_API void add_entity_linkage(ir_entity *entity, ir_linkage linkage);
311
/** Remove linkage flags @p linkage from entity @p entity. */
Michael Beck's avatar
Michael Beck committed
312
FIRM_API void remove_entity_linkage(ir_entity *entity, ir_linkage linkage);
313

Matthias Braun's avatar
Matthias Braun committed
314
315
316
317
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
318
FIRM_API ir_volatility get_entity_volatility(const ir_entity *ent);
319

Matthias Braun's avatar
Matthias Braun committed
320
321
322
323
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
324
FIRM_API void set_entity_volatility(ir_entity *ent, ir_volatility vol);
325

326
/** Returns the name of the volatility. */
Michael Beck's avatar
Michael Beck committed
327
FIRM_API const char *get_volatility_name(ir_volatility var);
328

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

Matthias Braun's avatar
Matthias Braun committed
332
/** Allows you to override the type alignment for an entity.
333
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
334
335
 * @param alignment   alignment in bytes
 */
Michael Beck's avatar
Michael Beck committed
336
FIRM_API void set_entity_alignment(ir_entity *entity, unsigned alignment);
Matthias Braun's avatar
Matthias Braun committed
337

Matthias Braun's avatar
Matthias Braun committed
338
/**
339
 * Returns indication whether entity is aligned in memory.
Matthias Braun's avatar
Matthias Braun committed
340
341
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
342
FIRM_API ir_align get_entity_aligned(const ir_entity *ent);
343

Matthias Braun's avatar
Matthias Braun committed
344
/**
345
 * Sets indication whether entity is aligned in memory
Matthias Braun's avatar
Matthias Braun committed
346
347
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
348
FIRM_API void set_entity_aligned(ir_entity *ent, ir_align a);
349

350
/** Returns the name of the alignment. */
Michael Beck's avatar
Michael Beck committed
351
FIRM_API const char *get_align_name(ir_align a);
Michael Beck's avatar
Michael Beck committed
352

353
354
/** Returns the offset of an entity (in a compound) in bytes. Only set if
 * layout = fixed. */
Michael Beck's avatar
Michael Beck committed
355
FIRM_API int get_entity_offset(const ir_entity *ent);
356
357

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

360
361
/** 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
362
FIRM_API unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
363
364

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

/** Returns the stored intermediate information. */
Michael Beck's avatar
Michael Beck committed
369
FIRM_API void *get_entity_link(const ir_entity *ent);
370
371

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

374
375
376
377
/**
 * The entity knows the corresponding irg if the entity is a method.
 * This allows to get from a Call to the called irg.
 */
Michael Beck's avatar
Michael Beck committed
378
FIRM_API ir_graph *get_entity_irg(const ir_entity *ent);
379

380
381
382
/** A reserved value for "not yet set". */
#define IR_VTABLE_NUM_NOT_SET ((unsigned)(-1))

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

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

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

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

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

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

416
/** Returns the entity usage */
Michael Beck's avatar
Michael Beck committed
417
FIRM_API ir_entity_usage get_entity_usage(const ir_entity *ent);
418
419

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

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

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

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

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

463
464
465
466
467
468
469
/**
 * 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
470
FIRM_API int is_irn_const_expression(ir_node *n);
471
472
473

/**
 * Copies a Firm subgraph that complies to the restrictions for
474
 * constant expressions to block.
475
 *
Matthias Braun's avatar
Matthias Braun committed
476
477
478
 * @param dbg       debug info for all newly created nodes
 * @param n         the node
 * @param to_block  block to copy to
479
 */
480
FIRM_API ir_node *copy_const_value(dbg_info *dbg, ir_node *n, ir_node *to_block);
481

482
/** Returns initial value of entity with atomic type @p ent. */
483
FIRM_API ir_node *get_atomic_ent_value(const ir_entity *ent);
484
485
/** 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
486
FIRM_API void set_atomic_ent_value(ir_entity *ent, ir_node *val);
487

Matthias Braun's avatar
Matthias Braun committed
488
489
490
491
/** @defgroup ir_initializer  Entity Initializers
 * @{
 */

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

504
/** Returns kind of an initializer */
Michael Beck's avatar
Michael Beck committed
505
FIRM_API ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);
506

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

510
/**
511
 * Returns the null initializer (there's only one instance of it in a program )
512
 */
Michael Beck's avatar
Michael Beck committed
513
FIRM_API ir_initializer_t *get_initializer_null(void);
514
515

/**
516
 * Creates an initializer containing a reference to a node on the const-code
517
518
 * irg.
 */
Michael Beck's avatar
Michael Beck committed
519
FIRM_API ir_initializer_t *create_initializer_const(ir_node *value);
520

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

524
/** Returns value contained in a const initializer */
Michael Beck's avatar
Michael Beck committed
525
FIRM_API ir_node *get_initializer_const_value(const ir_initializer_t *initializer);
526

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

530
/** Creates a compound initializer which holds @p n_entries entries */
531
FIRM_API ir_initializer_t *create_initializer_compound(size_t n_entries);
532

533
/** Returns the number of entries in a compound initializer */
534
FIRM_API size_t get_initializer_compound_n_entries(const ir_initializer_t *initializer);
535

536
/** Sets entry with index @p index to the initializer @p value */
Michael Beck's avatar
Michael Beck committed
537
FIRM_API void set_initializer_compound_value(ir_initializer_t *initializer,
538
                                             size_t index,
539
                                             ir_initializer_t *value);
540

541
/** Returns the value with index @p index of a compound initializer */
Michael Beck's avatar
Michael Beck committed
542
FIRM_API ir_initializer_t *get_initializer_compound_value(
543
		const ir_initializer_t *initializer, size_t index);
544

Matthias Braun's avatar
Matthias Braun committed
545
546
/** @} */

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

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

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

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

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

/**
 *   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
596
FIRM_API int is_entity(const void *thing);
597
598
599
600

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

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

616
617
/** Returns the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
618
FIRM_API ir_visited_t get_entity_visited(const ir_entity *ent);
619

620
621
/** Sets the entities visited counter.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
622
FIRM_API void set_entity_visited(ir_entity *ent, ir_visited_t num);
623

624
625
/** Marks entity as visited.
 * @see @ref visited_counters */
Michael Beck's avatar
Michael Beck committed
626
FIRM_API void mark_entity_visited(ir_entity *ent);
627

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

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

/**
 * Returns the mask of the additional entity properties.
 * The properties are automatically inherited from the irg if available
 * or from the method type if they were not set using
 * set_entity_additional_properties() or
 * set_entity_additional_property().
 */
643
FIRM_API mtp_additional_properties get_entity_additional_properties(const ir_entity *ent);
644
645

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

649
650
651
/** Sets additional graph properties. */
FIRM_API void add_entity_additional_properties(ir_entity *ent,
                                               mtp_additional_properties flag);
652
653
654

/** 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
655
FIRM_API ir_type *get_entity_repr_class(const ir_entity *ent);
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688

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

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

693
694
695
696
/** 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
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
/** @deprecated */
typedef enum {
	allocation_automatic,
	allocation_parameter,
	allocation_dynamic,
	allocation_static
} ir_allocation;
/** @deprecated */
FIRM_API ir_allocation get_entity_allocation(const ir_entity *ent);
/** @deprecated */
FIRM_API void set_entity_allocation(ir_entity *ent, ir_allocation al);

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

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

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

/** @} */

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

/**
Matthias Braun's avatar
Matthias Braun committed
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 * @defgroup ir_type Type System
 *
 *  Datastructure to hold type information.
 *
 *  This module supplies a datastructure to represent all types
 *  known in the compiled program.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
 *  between these types.  Finally it specifies some auxiliary types.
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  A type is described by a set of attributes.  Some of
 *  these attributes are common to all types, others depend on the
 *  kind of the type.
 *
 *  Types are different from the modes defined in irmode:  Types are
 *  on the level of the programming language, modes at the level of
 *  the target processor.
 *
 * @{
 */

/**
 * @defgroup tp_op  Type Opcodes
768
769
770
771
772
773
 *  This module specifies the kinds of types available in firm.
 *
 *  They are called type opcodes. These include classes, structs, methods, unions,
 *  arrays, enumerations, pointers and primitive types.
 *  Special types with own opcodes are the id type, a type representing an unknown
 *  type and a type used to specify that something has no type.
Matthias Braun's avatar
Matthias Braun committed
774
775
 *
 * @{
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
 */

/**
 *  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. */
792
	tpo_code,                /**< a piece of code (a basic block) */
793
794
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
795
	tpo_last = tpo_unknown   /* not a type opcode */
796
797
798
799
800
801
802
803
} 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.
 *
804
 * @see  get_tpop_name(), get_tpop_code()
805
806
807
808
809
810
811
812
 */
typedef struct tp_op tp_op;


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

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

Matthias Braun's avatar
Matthias Braun committed
825
/** @} */
826
827
828
829
830
831
832

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

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

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

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

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

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

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


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

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

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

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

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

951
/** Start iteration over all transitive subtypes of @p tp */
Michael Beck's avatar
Michael Beck committed
952
FIRM_API ir_type *get_class_trans_subtype_first(const ir_type *tp);
953
954
955
956
/**
 * Returns next type in a subtype iteration started by
 * get_class_trans_subtype_first()
 */
Michael Beck's avatar
Michael Beck committed
957
FIRM_API ir_type *get_class_trans_subtype_next(const ir_type *tp);
958
959
960
961
962
/**
 * 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
963
FIRM_API int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
964

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

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

981
982
/** Start iteration over all transitive overwritten entities, overwritten by
 * entity @p ent */
Michael Beck's avatar
Michael Beck committed
983
FIRM_API ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
984
985
986
987
/**
 * Returns next entity in a overwrites iteration started by
 * get_entity_trans_overwrites_first()
 */
Michael Beck's avatar
Michael Beck committed
988
FIRM_API ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
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 {}