typerep.h 90.8 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
27
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

#include "firm_types.h"
28
#include <stdlib.h>
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

/**
 * @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
55
56
 *   - name:       The string that represents this entity in the source program
 *   - linkage:    A flag indicating how the linker treats a symbol
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 *   - 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
 */

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/**
 * 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.
	 */
	ir_visibility_external
} ir_visibility;

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

/**
 * The following are some common combinations of linkage types seen in the
 * C/C++ languages
 */
enum ir_common_linkages {
	/** C "common" symbol */
	IR_LINKAGE_COMMON  = IR_LINKAGE_MERGE,
	/** C "weak" symbol */
	IR_LINKAGE_WEAKSYM = IR_LINKAGE_WEAK | IR_LINKAGE_MERGE,
	/** C++ comdat code */
	IR_LINKAGE_COMDAT = IR_LINKAGE_GARBAGE_COLLECT | IR_LINKAGE_GARBAGE_COLLECT
};
155

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

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

/**
167
168
169
170
171
172
 * 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
173
 */
174
int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
175
176

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

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

/**
 * 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
202
ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
203
204
205
206
207
208
209
210
211

/**
 * 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
212
ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
213
214
215
216
217
218
219
220
221

/**
 * 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
222
ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
223
224
225
226
227
228
229

/**
 * 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
230
void free_entity(ir_entity *ent);
231
232
233
234
235

/** Returns the name of an entity. */
const char *get_entity_name(const ir_entity *ent);

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

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

/** 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.
 */
Matthias Braun's avatar
Matthias Braun committed
247
ident *get_entity_ld_ident(const ir_entity *ent);
248
249

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

/** Returns the mangled name of the entity as a string. */
Matthias Braun's avatar
Matthias Braun committed
253
const char *get_entity_ld_name(const ir_entity *ent);
254
255

/** Returns the owner of the entity. */
Matthias Braun's avatar
Matthias Braun committed
256
ir_type *get_entity_owner(const ir_entity *ent);
257
258
259

/** Sets the owner field in entity to owner.  Don't forget to add
   ent to owner!! */
Michael Beck's avatar
Michael Beck committed
260
void set_entity_owner(ir_entity *ent, ir_type *owner);
261
262

/** Returns the type of an entity. */
Matthias Braun's avatar
Matthias Braun committed
263
ir_type *get_entity_type(const ir_entity *ent);
264
265

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

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

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

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

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

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

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

/** Return the name of the volatility. */
const char *get_volatility_name(ir_volatility var);

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

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

Matthias Braun's avatar
Matthias Braun committed
311
312
313
314
315

/**
 * This enumeration flags the align of Loads/Stores.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
316
317
318
319
320
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
321
322
323
324
/**
 * Returns indication wether entity is aligned in memory.
 * @deprecated
 */
Matthias Braun's avatar
Matthias Braun committed
325
ir_align get_entity_aligned(const ir_entity *ent);
326

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

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

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

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

/** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);

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

/** Returns the stored intermediate information. */
void *get_entity_link(const ir_entity *ent);

/** Stores new intermediate information. */
void set_entity_link(ir_entity *ent, void *l);

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

/** Gets the entity vtable number. */
unsigned get_entity_vtable_number(const ir_entity *ent);

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

366
367
368
369
370
/** Set label number of an entity with code type */
void set_entity_label(ir_entity *ent, ir_label_t label);
/** Return label number of an entity with code type */
ir_label_t get_entity_label(const ir_entity *ent);

371
372
373
374
375
/** Checks if an entity is compiler generated. */
int is_entity_compiler_generated(const ir_entity *ent);

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

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

/** Return the entity usage */
ir_entity_usage get_entity_usage(const ir_entity *ent);
395
396

/** Sets/resets the state of the address taken flag of an entity. */
397
void set_entity_usage(ir_entity *ent, ir_entity_usage flag);
398

399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
/**
 * Returns the debug information of an entity.
 *
 * @param ent The entity.
 */
dbg_info *get_entity_dbg_info(const ir_entity *ent);

/**
 * Sets the debug information of an entity.
 *
 * @param ent The entity.
 * @param db  The debug info.
 */
void set_entity_dbg_info(ir_entity *ent, dbg_info *db);

414
415
416
417
418
419
420
421
/* -- 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
422
int is_irn_const_expression(ir_node *n);
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

/**
 * Copies a Firm subgraph that complies to the restrictions for
 * constant expressions to current_block in current_ir_graph.
 *
 * @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.
 */
ir_node *copy_const_value(dbg_info *dbg, ir_node *n);

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

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

/** returns kind of an initializer */
ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer);

455
456
457
/** Return the name of the initializer kind. */
const char *get_initializer_kind_name(ir_initializer_kind_t ini);

458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
/**
 * returns the null initializer (there's only one instance of it in a program )
 */
ir_initializer_t *get_initializer_null(void);

/**
 * creates an initializer containing a reference to a node on the const-code
 * irg.
 */
ir_initializer_t *create_initializer_const(ir_node *value);

/** creates an initializer containing a single tarval value */
ir_initializer_t *create_initializer_tarval(tarval *tv);

/** return value contained in a const initializer */
ir_node *get_initializer_const_value(const ir_initializer_t *initializer);

/** return value contained in a tarval initializer */
tarval *get_initializer_tarval_value(const ir_initializer_t *initialzier);

/** creates a compound initializer which holds @p n_entries entries */
ir_initializer_t *create_initializer_compound(unsigned n_entries);

/** returns the number of entries in a compound initializer */
unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer);

/** sets entry with index @p index to the initializer @p value */
void set_initializer_compound_value(ir_initializer_t *initializer,
                                    unsigned index, ir_initializer_t *value);

/** returns the value with index @p index of a compound initializer */
ir_initializer_t *get_initializer_compound_value(
		const ir_initializer_t *initializer, unsigned index);

492
/** Sets the new style initializers of an entity. */
493
494
void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);

495
496
497
/** Returns true, if an entity has new style initializers. */
int has_entity_initializer(const ir_entity *entity);

498
/** Return the new style initializers of an entity. */
499
500
ir_initializer_t *get_entity_initializer(const ir_entity *entity);

501
502
503
504
505
506
507
508
509
510
/* --- 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
511
void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
Matthias Braun's avatar
Matthias Braun committed
512
513
514
int get_entity_n_overwrites(const ir_entity *ent);
int get_entity_overwrites_index(const ir_entity *ent, ir_entity *overwritten);
ir_entity *get_entity_overwrites(const ir_entity *ent, int pos);
Michael Beck's avatar
Michael Beck committed
515
516
void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
517

Michael Beck's avatar
Michael Beck committed
518
void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
Matthias Braun's avatar
Matthias Braun committed
519
520
521
int get_entity_n_overwrittenby(const ir_entity *ent);
int get_entity_overwrittenby_index(const ir_entity *ent, ir_entity *overwrites);
ir_entity *get_entity_overwrittenby(const ir_entity *ent, int pos);
Michael Beck's avatar
Michael Beck committed
522
523
void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
524
525
526
527
528
529
530
531
532

/**
 *   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
533
int is_entity(const void *thing);
534
535
536
537

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

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

/** Returns the entities visited count. */
Matthias Braun's avatar
Matthias Braun committed
554
ir_visited_t get_entity_visited(const ir_entity *ent);
555
556

/** Sets the entities visited count. */
557
void set_entity_visited(ir_entity *ent, ir_visited_t num);
558
559

/** Sets visited field in entity to entity_visited. */
Michael Beck's avatar
Michael Beck committed
560
void mark_entity_visited(ir_entity *ent);
561
562

/** Returns true if this entity was visited. */
Matthias Braun's avatar
Matthias Braun committed
563
int entity_visited(const ir_entity *ent);
564
565

/** Returns true if this entity was not visited. */
Matthias Braun's avatar
Matthias Braun committed
566
int entity_not_visited(const ir_entity *ent);
567
568
569
570
571
572
573
574

/**
 * 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().
 */
Matthias Braun's avatar
Matthias Braun committed
575
unsigned get_entity_additional_properties(const ir_entity *ent);
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
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

/** Sets the mask of the additional graph properties. */
void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);

/** Sets one additional graph property. */
void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);

/** Returns the class type that this type info entity represents or NULL
    if ent is no type info entity. */
ir_type *get_entity_repr_class(const ir_entity *ent);

/**
 * @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
 */
619
620

/** A variable that contains the only unknown entity. */
621
622
623
624
625
626
627
extern ir_entity *unknown_entity;

/** Returns the @link unknown_entity unknown entity @endlink. */
ir_entity *get_unknown_entity(void);

/** Encodes how a pointer parameter is accessed. */
typedef enum acc_bits {
Michael Beck's avatar
Michael Beck committed
628
629
630
631
632
633
	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 */
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
} 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. */
664
	tpo_code,                /**< a piece of code (a basic block) */
665
666
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
667
	tpo_last = tpo_unknown   /* not a type opcode */
668
669
670
671
672
673
674
675
} 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.
 *
676
 * @see  get_tpop_name(), get_tpop_code()
677
678
679
680
681
682
683
684
 */
typedef struct tp_op tp_op;


/**
 * Returns the string for the type opcode.
 *
 * @param op  The type opcode to get the string from.
Matthias Braun's avatar
Matthias Braun committed
685
 * @return a string.  (@todo Null terminated?)
686
 */
Michael Beck's avatar
Michael Beck committed
687
const char *get_tpop_name(const tp_op *op);
688
689
690
691
692
693
694

/**
 * 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
695
tp_opcode get_tpop_code(const tp_op *op);
696
697
698
699
700
701
702
703
704
705

/**
 * 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
706
707
extern const tp_op *type_class;
const tp_op *get_tpop_class(void);
708
709
710
711
712
713
714
715
716
717

/**
 * 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
718
719
extern const tp_op *type_struct;
const tp_op *get_tpop_struct(void);
720
721
722
723
724
725
726
727

/**
 * 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
728
729
extern const tp_op *type_method;
const tp_op *get_tpop_method(void);
730
731
732
733
734
735
736
737

/**
 * 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
738
739
extern const tp_op *type_union;
const tp_op *get_tpop_union(void);
740
741
742
743
744
745
746
747
748

/**
 * 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
749
750
extern const tp_op *type_array;
const tp_op *get_tpop_array(void);
751
752
753
754
755
756
757
758
759
760

/**
 * 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
761
762
extern const tp_op *type_enumeration;
const tp_op *get_tpop_enumeration(void);
763
764
765
766
767
768
769
770

/**
 * 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
771
772
extern const tp_op *type_pointer;
const tp_op *get_tpop_pointer(void);
773
774
775
776
777
778
779
780
781

/**
 * 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
782
783
extern const tp_op *type_primitive;
const tp_op *get_tpop_primitive(void);
784

785
786
787
788
789
790
/**
 * The code type is used to mark pieces of code (basic blocks)
 */
extern const tp_op *tpop_code;
const tp_op *get_tpop_code_type(void);

791
792
793
794
795
796
797
798
/**
 * 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
799
800
extern const tp_op *tpop_none;
const tp_op *get_tpop_none(void);
801
802
803
804
805
806
807
808
809

/**
 * 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
810
811
extern const tp_op *tpop_unknown;
const tp_op *get_tpop_unknown(void);
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868

/* ----------------------------------------------------------------------- */
/* 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.  */
int is_SubClass_of(ir_type *low, ir_type *high);

/** 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.  */
int is_SubClass_ptr_of(ir_type *low, ir_type *high);

/** 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. */
int is_overwritten_by(ir_entity *high, ir_entity *low);

/** 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. */
ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class, ir_entity* static_ent);

/* ----------------------------------------------------------------------- */
/* 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
869
ident *default_mangle_inherited_name(const ir_entity *ent, const ir_type *clss);
870
871
872
873
874
875
876
877

/** 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.
 */
Michael Beck's avatar
Michael Beck committed
878
typedef ident *mangle_inherited_name_func(const ir_entity *ent, const ir_type *clss);
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932

/** 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.
 *
 *  This function was moved here from firmlower 3/2005.
 */
void resolve_inheritance(mangle_inherited_name_func *mfunc);


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

/** The state of the transitive closure.
 *
 *  @todo: we could manage the state for each relation separately.  Invalidating
 *  the entity relations does not mean invalidating the class relation. */
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;

void                         set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
void                         invalidate_irp_inh_transitive_closure_state(void);
inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);


/** Compute transitive closure of the subclass/superclass and
 * overwrites/overwrittenby relation.
 *
933
 * This function walks over the ir (O(\#types+\#entities)) to compute the
934
935
936
937
938
939
940
941
942
943
 * transitive closure.    */
void compute_inh_transitive_closure(void);

/** Free memory occupied by the transitive closure information. */
void free_inh_transitive_closure(void);


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

/** Iterate over all transitive subtypes. */
Michael Beck's avatar
Michael Beck committed
944
945
946
ir_type *get_class_trans_subtype_first(const ir_type *tp);
ir_type *get_class_trans_subtype_next(const ir_type *tp);
int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
947
948
949
950

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

/** Iterate over all transitive supertypes. */
Michael Beck's avatar
Michael Beck committed
951
952
ir_type *get_class_trans_supertype_first(const ir_type *tp);
ir_type *get_class_trans_supertype_next(const ir_type *tp);
953
954
955
956

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

/** Iterate over all entities that transitive overwrite this entities. */
Michael Beck's avatar
Michael Beck committed
957
958
ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
959
960
961
962

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

/** Iterate over all transitive overwritten entities. */
Michael Beck's avatar
Michael Beck committed
963
964
ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
965
966
967
968
969
970
971
972
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.
 *
 * We rely on the ordering of the enum. */
typedef enum {
	ir_class_casts_any        = 0, /**< There are class casts that do not cast in conformance with
	                                    the class hierarchy.  @@@ So far this does not happen in Firm. */
	ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
	ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
	ir_class_casts_state_max
} ir_class_cast_state;