typerep.h 90.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-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
/**
 * 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.
	 */
97
98
99
100
101
102
103
104
105
	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
106
107
} ir_visibility;

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

/**
152
 * Return the visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
153
 */
154
ir_visibility get_entity_visibility(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
155
156

/**
157
 * Set visibility class of an entity
Matthias Braun's avatar
Matthias Braun committed
158
 */
159
void set_entity_visibility(ir_entity *entity, ir_visibility visibility);
Matthias Braun's avatar
Matthias Braun committed
160
161

/**
162
163
164
165
166
167
 * 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
168
 */
169
int entity_is_externally_visible(const ir_entity *entity);
Matthias Braun's avatar
Matthias Braun committed
170
171

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

/**
 * 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
186
ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
187
188
189
190
191
192
193
194
195
196

/**
 * 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
197
ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
198
199
200
201
202
203
204
205
206

/**
 * 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
207
ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
208
209
210
211
212
213
214
215
216

/**
 * 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
217
ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
218
219
220
221
222
223
224

/**
 * 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
225
void free_entity(ir_entity *ent);
226
227
228
229
230

/** 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
231
ident *get_entity_ident(const ir_entity *ent);
232
233

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

/** 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
242
ident *get_entity_ld_ident(const ir_entity *ent);
243
244

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

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

/** Returns the owner of the entity. */
Matthias Braun's avatar
Matthias Braun committed
251
ir_type *get_entity_owner(const ir_entity *ent);
252
253
254

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

/** Returns the type of an entity. */
Matthias Braun's avatar
Matthias Braun committed
258
ir_type *get_entity_type(const ir_entity *ent);
259
260

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

Matthias Braun's avatar
Matthias Braun committed
263
264
/** Returns the linkage of an entity. */
ir_linkage get_entity_linkage(const ir_entity *entity);
265

Matthias Braun's avatar
Matthias Braun committed
266
267
268
269
/** 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);
270

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

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

Matthias Braun's avatar
Matthias Braun committed
283
284
285
286
/**
 * Returns the volatility of an entity.
 * @deprecated
 */
287
288
ir_volatility get_entity_volatility(const ir_entity *ent);

Matthias Braun's avatar
Matthias Braun committed
289
290
291
292
/**
 * Sets the volatility of an entity.
 * @deprecated
 */
Michael Beck's avatar
Michael Beck committed
293
void set_entity_volatility(ir_entity *ent, ir_volatility vol);
294
295
296
297

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

Matthias Braun's avatar
Matthias Braun committed
298
299
300
/** Returns alignment of entity in bytes */
unsigned get_entity_alignment(const ir_entity *entity);

Matthias Braun's avatar
Matthias Braun committed
301
/** Allows you to override the type alignment for an entity.
302
 * @param entity      the entity
Matthias Braun's avatar
Matthias Braun committed
303
304
 * @param alignment   alignment in bytes
 */
Matthias Braun's avatar
Matthias Braun committed
305
306
void set_entity_alignment(ir_entity *entity, unsigned alignment);

Matthias Braun's avatar
Matthias Braun committed
307
308
309
310
311

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

Matthias Braun's avatar
Matthias Braun committed
323
324
325
326
/**
 * Sets indication wether entity is aligned in memory
 * @deprecated
 */
Matthias Braun's avatar
Matthias Braun committed
327
void set_entity_aligned(ir_entity *ent, ir_align a);
328

Michael Beck's avatar
Michael Beck committed
329
330
331
/** Return the name of the alignment. */
const char *get_align_name(ir_align a);

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

/** Sets the offset of an entity (in a compound) in bytes. */
Michael Beck's avatar
Michael Beck committed
336
void set_entity_offset(ir_entity *ent, int offset);
337
338
339
340
341

/** 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
342
void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
343
344
345
346
347
348
349
350
351

/** 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
352
   This allows to get from a Call to the called irg. */
353
ir_graph *get_entity_irg(const ir_entity *ent);
Michael Beck's avatar
Michael Beck committed
354
void set_entity_irg(ir_entity *ent, ir_graph *irg);
355
356
357
358
359

/** 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
360
void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
361

362
363
364
365
366
/** 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);

367
368
369
370
371
/** 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
372

373
/**
374
 * Bitfield type indicating the way an entity is used.
375
376
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
377
378
379
380
381
382
383
	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 */
384
385
386
387
388
389
390
	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);
391
392

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

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/**
 * 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);

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

/**
 * 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
434
void set_atomic_ent_value(ir_entity *ent, ir_node *val);
435

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

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

451
452
453
/** Return the name of the initializer kind. */
const char *get_initializer_kind_name(ir_initializer_kind_t ini);

454
455
456
457
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
/**
 * 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);

488
/** Sets the new style initializers of an entity. */
489
490
void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);

491
492
493
/** Returns true, if an entity has new style initializers. */
int has_entity_initializer(const ir_entity *entity);

494
/** Return the new style initializers of an entity. */
495
496
ir_initializer_t *get_entity_initializer(const ir_entity *entity);

497
498
499
500
501
502
503
504
505
506
/* --- 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
507
void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
Matthias Braun's avatar
Matthias Braun committed
508
509
510
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
511
512
void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
513

Michael Beck's avatar
Michael Beck committed
514
void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
Matthias Braun's avatar
Matthias Braun committed
515
516
517
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
518
519
void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
520
521
522
523
524
525
526
527
528

/**
 *   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
529
int is_entity(const void *thing);
530
531
532
533

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

/** 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
550
ir_visited_t get_entity_visited(const ir_entity *ent);
551
552

/** Sets the entities visited count. */
553
void set_entity_visited(ir_entity *ent, ir_visited_t num);
554
555

/** Sets visited field in entity to entity_visited. */
Michael Beck's avatar
Michael Beck committed
556
void mark_entity_visited(ir_entity *ent);
557
558

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

/** Returns true if this entity was not visited. */
Matthias Braun's avatar
Matthias Braun committed
562
int entity_not_visited(const ir_entity *ent);
563
564
565
566
567
568
569
570

/**
 * 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
571
unsigned get_entity_additional_properties(const ir_entity *ent);
572
573
574
575
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

/** 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
 */
615
616

/** A variable that contains the only unknown entity. */
617
618
619
620
621
622
623
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
624
625
626
627
628
629
	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 */
630
631
632
633
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
} 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. */
660
	tpo_code,                /**< a piece of code (a basic block) */
661
662
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
663
	tpo_last = tpo_unknown   /* not a type opcode */
664
665
666
667
668
669
670
671
} 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.
 *
672
 * @see  get_tpop_name(), get_tpop_code()
673
674
675
676
677
678
679
680
 */
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
681
 * @return a string.  (@todo Null terminated?)
682
 */
Michael Beck's avatar
Michael Beck committed
683
const char *get_tpop_name(const tp_op *op);
684
685
686
687
688
689
690

/**
 * 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
691
tp_opcode get_tpop_code(const tp_op *op);
692
693
694
695
696
697
698
699
700
701

/**
 * 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
702
703
extern const tp_op *type_class;
const tp_op *get_tpop_class(void);
704
705
706
707
708
709
710
711
712
713

/**
 * 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
714
715
extern const tp_op *type_struct;
const tp_op *get_tpop_struct(void);
716
717
718
719
720
721
722
723

/**
 * 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
724
725
extern const tp_op *type_method;
const tp_op *get_tpop_method(void);
726
727
728
729
730
731
732
733

/**
 * 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
734
735
extern const tp_op *type_union;
const tp_op *get_tpop_union(void);
736
737
738
739
740
741
742
743
744

/**
 * 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
745
746
extern const tp_op *type_array;
const tp_op *get_tpop_array(void);
747
748
749
750
751
752
753
754
755
756

/**
 * 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
757
758
extern const tp_op *type_enumeration;
const tp_op *get_tpop_enumeration(void);
759
760
761
762
763
764
765
766

/**
 * 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
767
768
extern const tp_op *type_pointer;
const tp_op *get_tpop_pointer(void);
769
770
771
772
773
774
775
776
777

/**
 * 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
778
779
extern const tp_op *type_primitive;
const tp_op *get_tpop_primitive(void);
780

781
782
783
784
785
786
/**
 * 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);

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

/**
 * 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
806
807
extern const tp_op *tpop_unknown;
const tp_op *get_tpop_unknown(void);
808
809
810
811
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

/* ----------------------------------------------------------------------- */
/* 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
865
ident *default_mangle_inherited_name(const ir_entity *ent, const ir_type *clss);
866
867
868
869
870
871
872
873

/** 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
874
typedef ident *mangle_inherited_name_func(const ir_entity *ent, const ir_type *clss);
875
876
877
878
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

/** 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.
 *
929
 * This function walks over the ir (O(\#types+\#entities)) to compute the
930
931
932
933
934
935
936
937
938
939
 * 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
940
941
942
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);
943
944
945
946

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

/** Iterate over all transitive supertypes. */
Michael Beck's avatar
Michael Beck committed
947
948
ir_type *get_class_trans_supertype_first(const ir_type *tp);
ir_type *get_class_trans_supertype_next(const ir_type *tp);
949
950
951
952

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

/** Iterate over all entities that transitive overwrite this entities. */
Michael Beck's avatar
Michael Beck committed
953
954
ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
955
956
957
958

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

/** Iterate over all transitive overwritten entities. */
Michael Beck's avatar
Michael Beck committed
959
960
ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
961
962
963
964
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


/* ----------------------------------------------------------------------- */
/** 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;
Michael Beck's avatar
Michael Beck committed
997
const char *get_class_cast_state_string(ir_class_cast_state s);
998
999

void                set_irg_class_cast_state(ir_graph *irg, ir_class_cast_state s);
Michael Beck's avatar
Michael Beck committed
1000
ir_class_cast_state get_irg_class_cast_state(const ir_graph *irg);
1001
1002
1003
1004
1005
void                set_irp_class_cast_state(ir_class_cast_state s);
ir_class_cast_state get_irp_class_cast_state(void);

/** Verify the class cast state of an irg.
 *
Michael Beck's avatar
Michael Beck committed
1006
 *  Asserts if state is to high, outputs debug warning if state is to low
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 *  and firm verbosity is set.
 */
void verify_irg_class_cast_state(ir_graph *irg);

/**
 * possible trvrfy() error codes
 */
enum trvrfy_error_codes {
	no_error = 0,                      /**< no error */
	error_ent_not_cont,                /**< overwritten entity not in superclass */
	error_null_mem,                    /**< compound contains NULL member */
	error_const_on_wrong_irg,          /**< constant placed on wrong IRG */
	error_existent_entity_without_irg, /**< Method entities with pecularity_exist must have an irg */
	error_wrong_ent_overwrites,        /**< number of entity overwrites exceeds number of class overwrites */
	error_inherited_ent_without_const, /**< inherited method entity not pointing to existent entity */
	error_glob_ent_allocation,         /**< wrong allocation of a global entity */
	error_ent_const_mode,              /**< Mode of constant in entity did not match entities type. */
	error_ent_wrong_owner              /**< Mode of constant in entity did not match entities type. */
};

/**
 * Checks a type.
 *
 * @return
 *  0   if no error encountered
 */
int check_type(ir_type *tp);

/**
 * Check an entity. Currently, we check only if initialized constants
 * are build on the const irg graph.
 *
 * @return
 *  0   if no error encountered
 *  != 0    a trvrfy_error_codes code
 */
int check_entity(ir_entity *ent);

/**
 * Walks the type information and performs a set of sanity checks.
 *
 * Currently, the following checks are executed:
 * - values of initialized entities must be allocated on the constant IRG
 * - class types: doesn't have NULL members
 * - class types: all overwrites are existent in the super type
 *
 * @return
 *    0 if graph is correct
 *    else error code.
 */
int tr_vrfy(void);

Sebastian Felis's avatar
Sebastian Felis committed
1059
/**
1060
 * @page type   representation of types
Michael Beck's avatar
Michael Beck committed
1061
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
1062
 *  Datastructure to hold type information.
1063
1064
1065
1066
1067
 *
 *  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
1068
 *  between these types.  Finally it specifies some auxiliary types.
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 *
 *  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.
 */

Michael Beck's avatar
Michael Beck committed
1080
1081
1082
1083
/** Frees all entities associated with a type.
 *  Does not free the array entity.
 *  Warning: ensure these entities are not referenced anywhere else.
 */
Michael Beck's avatar
Michael Beck committed
1084
void free_type_entities(ir_type *tp);
1085

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1086
1087
1088
1089
1090
1091
/** Frees the memory used by the type.
 *
 * Removes the type from the type list. Does not free the entities
 * belonging to the type, except for the array element entity.  Does
 * not free if tp is "none" or "unknown".  Frees entities in value
 * param subtypes of method types!!! Make sure these are not
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
1092
1093
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
Michael Beck's avatar
Michael Beck committed
1094
void free_type(ir_type *tp);
1095

Michael Beck's avatar
Michael Beck committed
1096
1097
1098
1099
const tp_op *get_type_tpop(const ir_type *tp);
ident *get_type_tpop_nameid(const ir_type *tp);
const char *get_type_tpop_name(const ir_type *tp);
tp_opcode get_type_tpop_code(const ir_type *tp);
1100

1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
/**
 * construct a string representing the type.
 * This uses the info retrieved by the type_dbg_info if available.
 * Otherwise it tries to create an approximate textual representation of the
 * type.
 * Keep in mind that this representation is not unique for each type,
 * might abstract away some details. The main intention of this is creating
 * human redable strings giving an idea of the type.
 */
void ir_print_type(char *buffer, size_t buffer_size, const ir_type *tp);
1111

1112
/** The state of the type layout. */
1113
typedef enum {
Michael Beck's avatar
Michael Beck committed
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
	layout_undefined,    /**< The layout of this type is not defined.
	                          Address computation to access fields is not
	                          possible, fields must be accessed by Sel
	                          nodes.  Enumeration constants might be undefined.
	                          This is the default value except for
	                          pointer, primitive and method types. */
	layout_fixed         /**< The layout is fixed, all component/member entities
	                          have an offset assigned.  Size of the type is known.
	                          Arrays can be accessed by explicit address
	                          computation.  Enumeration constants must be defined.
	                          Default for pointer, primitive and method types. */
1125
} ir_type_state;
1126

Götz Lindenmaier's avatar
Götz Lindenmaier committed
1127
/** Returns a human readable string for the enum entry. */
1128
const char *get_type_state_name(ir_type_state s);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1129

1130
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
1131
ir_type_state get_type_state(const ir_type *tp);
1132
1133
1134
1135
1136
1137

/** Sets the type layout state of a type.
 *
 * For primitives, pointer and method types the layout is always fixed.
 * This call is legal but has no effect.
 */
Michael Beck's avatar
Michael Beck committed
1138
void set_type_state(ir_type *tp, ir_type_state state);
1139

1140
1141
1142
1143
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
1144
ir_mode *get_type_mode(const ir_type *tp);
1145
1146
1147

/** Sets the mode of a type.
 *
1148
 * Only has an effect on primitive, enumeration and pointer types.
1149
 */
Michael Beck's avatar
Michael Beck committed
1150
void set_type_mode(ir_type *tp, ir_mode* m);
1151

1152
1153
/** Returns the size of a type in bytes. */
unsigned get_type_size_bytes(const ir_type *tp);
1154
1155
1156
1157
1158
1159

/** Sets the size of a type in bytes.
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
1160
void set_type_size_bytes(ir_type *tp, unsigned size);
1161

Matthias Braun's avatar
Matthias Braun committed
1162
/** Returns the alignment of a type in bytes. */
1163
unsigned get_type_alignment_bytes(ir_type *tp);
1164

1165
1166
1167
1168
/** Returns the alignment of a type in bits.
 *
 *  If the alignment of a type is
 *  not set, it is calculated here according to the following rules:
Michael Beck's avatar
Michael Beck committed
1169
1170
1171
1172
 *  -#.) if a type has a mode, the alignment is the mode size.
 *  -#.) compound types have the alignment of there biggest member.
 *  -#.) array types have the alignment of there element type.
 *  -#.) method types return 0 here.
1173
 *  -#.) all other types return 1 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed
1174
 */
1175
void set_type_alignment_bytes(ir_type *tp, unsigned align);
Michael Beck's avatar
Michael Beck committed
1176

Michael Beck's avatar
Michael Beck committed
1177
/** Returns the visited count of a type. */
1178
ir_visited_t get_type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1179
/** Sets the visited count of a type to num. */
1180
void set_type_visited(ir_type *tp, ir_visited_t num);
Michael Beck's avatar
Michael Beck committed
1181
/** Sets visited field in type to type_visited. */
Michael Beck's avatar
Michael Beck committed
1182
void mark_type_visited(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1183
/** Returns non-zero if the type is already visited */
Michael Beck's avatar
Michael Beck committed
1184
int type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1185
/** Returns non-zero if the type is not yet visited */
Michael Beck's avatar
Michael Beck committed
1186
int type_not_visited(const ir_type *tp);
1187

Michael Beck's avatar
Michael Beck committed
1188
/** Returns the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
1189
void *get_type_link(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
1190
/** Sets the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
1191
void set_type_link(ir_type *tp, void *l);
1192

Sebastian Felis's avatar
Sebastian Felis committed
1193
/**
1194
1195
 * Visited flag to traverse the type information.
 *
1196
1197
 * Increase this flag by one before traversing the type information
 * using inc_master_type_visited().
1198
1199
1200
 * Mark type nodes as visited by mark_type_visited(ir_type).
 * Check whether node was already visited by type_visited(ir_type)
 * and type_not_visited(ir_type).
1201
 * Or use the function to walk all types.
1202
 *
Sebastian Felis's avatar
Sebastian Felis committed
1203
 * @see  typewalk
1204
 */
1205
1206
1207
void         set_master_type_visited(ir_visited_t val);
ir_visited_t get_master_type_visited(void);
void         inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
1208

1209
1210
1211
1212
1213
1214
/**
 * Sets the debug information of a type.
 *
 * @param tp  The type.
 * @param db  The debug info.
 */
1215
void set_type_dbg_info(ir_type *tp, type_dbg_info *db);
1216
1217
1218
1219
1220
1221

/**
 * Returns the debug information of a type.
 *
 * @param tp  The type.
 */
1222
type_dbg_info *get_type_dbg_info(const ir_type *tp);
1223

Sebastian Felis's avatar
Sebastian Felis committed
1224
/**
1225
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
1226
 *
1227
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
1228
 *
1229
1230
 * @return
 *     true if the thing is a type, else false
1231
 */
1232
int is_type(const void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
1233

Sebastian Felis's avatar
Sebastian Felis committed
1234
/**
Florian Liekweg's avatar
Florian Liekweg committed
1235
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
1236
 *
1237
1238
 *   @param typ1  the first type
 *   @param typ2  the second type
Michael Beck's avatar
Michael Beck committed
1239
1240
1241
 *
 *   @return
 *    true if the types are equal, else false.
1242
1243
 *
 *   Types are equal if :
1244
1245
1246
1247
 *    - they are the same type kind
 *    - they have the same name
 *    - they have the same mode (if applicable)
 *    - they have the same type_state and, ev., the same size
Michael Beck's avatar
Michael Beck committed
1248
 *    - they are class types and have:
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
 *      - the same members (see same_entity in entity.h)
 *      - the same supertypes -- the C-pointers are compared --> no recursive call.
 *      - the same number of subtypes.  Subtypes are not compared,
 *        as this could cause a cyclic test.
 *    - they are structure types and have the same members
 *    - they are method types and have
 *      - the same parameter types
 *      - the same result types
 *    - they are union types and have the same members
 *    - they are array types and have
 *      - the same number of dimensions
 *      - the same dimension bounds
 *      - the same dimension order
 *      - the same element type
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the identical points_to type
Matthias Braun's avatar
Matthias Braun committed
1265
 *      (i.e., the same C-struct to represent the type.
Michael Beck's avatar
Michael Beck committed
1266
 *       This is to avoid endless recursions; with pointer types cyclic
1267
1268
 *       type graphs are possible.)
 */
1269
int equal_type(ir_type *typ1, ir_type *typ2);
1270

Sebastian Felis's avatar
Sebastian Felis committed
1271
1272
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
1273
1274
1275
1276
1277
1278
1279
1280
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if type st is smaller than type lt, i.e. whenever
 *    lt is expected a st can be used.
 *    This is true if
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
 *    - they are the same type kind
 *    - mode(st) < mode (lt)  (if applicable)
 *    - they are class types and st is (transitive) subtype of lt,
 *    - they are structure types and
 *       - the members of st have exactly one counterpart in lt with the same name,
 *       - the counterpart has a bigger type.
 *    - they are method types and have
 *      - the same number of parameter and result types,
 *      - the parameter types of st are smaller than those of lt,
 *      - the result types of st are smaller than those of lt
 *    - they are union types and have the members of st have exactly one
Sebastian Felis's avatar
Sebastian Felis committed
1292
 *      @return counterpart in lt and the type is smaller
1293
1294
1295
1296
1297
 *    - they are array types and have
 *      - the same number of dimensions
 *      - all bounds of lt are bound of st
 *      - the same dimension order
 *      - the same element type
Sebastian Felis's avatar
Sebastian Felis committed
1298
 *      @return or
1299
1300
1301
1302
 *      - the element type of st is smaller than that of lt
 *      - the element types have the same size and fixed layout.
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the points_to type of st is
Sebastian Felis's avatar
Sebastian Felis committed
1303
1304
 *      @return smaller than the points_to type of lt.
 *
1305
 */
1306
int smaller_type(ir_type *st, ir_type *lt);
1307

Sebastian Felis's avatar
Sebastian Felis committed
1308
/**
Florian Liekweg's avatar
Florian Liekweg committed
1309
 *  @page class_type    Representation of a class type
1310
 *
1311
1312
1313
 *  If the type opcode is set to type_class the type represents class
 *  types.  A list of fields and methods is associated with a class.
 *  Further a class can inherit from and bequest to other classes.
1314
 *
1315
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
1316
 *  - member:     All entities belonging to this class.  This are method entities
1317
1318
1319
 *                which have type_method or fields that can have any of the
 *                following type kinds: type_class, type_struct, type_union,
 *                type_array, type_enumeration, type_pointer, type_primitive.
1320
 *
1321
1322
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
1323
 *
1324
 *  - subtypes:    A list of direct subclasses.
1325
 *
1326
 *  - supertypes:  A list of direct superclasses.
1327
 *
1328
1329
1330
1331
1332
1333
 *  - type_info:   An entity representing the type information of this class.
 *                 This entity can be of arbitrari type, Firm did not use it yet.
 *                 It allows to express the coupling of a type with an entity
 *                 representing this type.  This information is useful for lowering
 *                 of InstOf and TypeChk nodes.  Default: NULL
 *
1334
 *  - vtable_size: The size of this class virtual function table.
1335
1336
 *                 Default:  0
 *
1337
1338
1339
1340
1341
 *  - final:       A final class is always a leaf in the class hierarchy.  Final
 *                 classes cannot be super classes of other ones.  As this information
 *                 can only be computed in whole world compilations, we allow to
 *                 set this flag.  It is used in optimizations if get_opt_closed_world()
 *                 is false.  Default:  false
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
 *
 *  - interface:   The class represents an interface.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
 *
 *  - abstract :   The class represents an abstract class.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
1352
 */
1353
1354

/** Creates a new class type. */
Michael Beck's avatar
Michael Beck committed
1355
ir_type *new_type_class(ident *name);
1356
1357

/** Creates a new class type with debug information. */
1358
ir_type *new_d_type_class(ident *name, type_dbg_info *db);
1359

1360
1361
/* --- manipulate private fields of class type  --- */

1362
1363
1364
1365
1366
1367
/** return identifier of the class type */
ident *get_class_ident(const ir_type *clss);

/** return identifier of the class type */
const char *get_class_name(const ir_type *clss);

1368
/** Adds the entity as member of the class.  */
Michael Beck's avatar
Michael Beck committed
1369
void add_class_member(ir_type *clss, ir_entity *member);
1370
1371

/** Returns the number of members of this class. */
Michael Beck's avatar
Michael Beck committed
1372
int get_class_n_members(const ir_type *clss);
1373
1374

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar