typerep.h 104 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.
 */
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
#ifndef FIRM_TYPEREP_H
#define FIRM_TYPEREP_H

#include "firm_types.h"

/**
 * @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.
Christoph Mallon's avatar
Christoph Mallon committed
49
50
51
 *   - name:       The string that represents this entity in the source program.
 *   - allocation: A flag saying whether the entity is dynamically or statically
 *                 allocated (values: dynamic_allocated,  static_allocated,
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 *                 automatic_allocated).
 *   - visibility: A flag indicating the visibility of this entity (values: local,
 *                 external_visible,  external_allocated)
 *   - variability: A flag indicating the variability of this entity (values:
 *                  uninitialized, initialized, part_constant, constant)
 *   - volatility: @@@
 *   - 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.
 *   - peculiarity: The peculiarity of the entity.  If the entity is a method this
 *                 indicates whether the entity represents
 *                 a real method or whether it only exists to describe an interface.
 *                 In that case there nowhere exists code for this entity and this entity
 *                 is never dynamically used in the code.
 *                 Values: description, existent.  Default: existent.
 *   - visited:    visited flag.  Master flag is type_visited.
 *
 * These fields can only be accessed via access functions.
 *
 * @see  ir_type, ir_entity
 */

/** This enumeration flags the visibility of entities and types.
 *
 * This is necessary for partial compilation.
 * We rely on the ordering of the flags.
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
	visibility_local,              /**< The entity is only visible locally.  This is the default for
	                                    entities.
	                                    The type is only visible locally.  All instances are allocated
	                                    locally, and no pointer to entities of this type are passed
	                                    out of this compilation unit. */
	visibility_external_visible,   /**< The entity is visible to other external program parts, but
	                                    it is defined here.  It may not be optimized away.  The entity must
	                                    be static_allocated.
	                                    For types:  entities of this type can be accessed externally.  No
	                                    instances of this type are allocated externally.  */
	visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
	                                    must not allocate memory for this entity. The entity must
	                                    be static_allocated.  This can also be an external defined
	                                    method.
	                                    For types:  entities of this type are allocated and accessed from
	                                    external code.  Default for types.  */
106
107
108
109
} ir_visibility;

/** This enumeration flags the peculiarity of entities and types. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
110
111
112
113
114
115
116
117
118
119
120
121
122
	peculiarity_description,     /**< Represents only a description.  The entity/type is never
	                          allocated, no code/data exists for this entity/type.
	                      @@@ eventually rename to descriptive (adjective as the others!)*/
	peculiarity_inherited,       /**< Describes explicitly that other entities are
	                          inherited to the owner of this entity.
	                          Overwrites must refer to at least one other
	                          entity.  If this is a method entity there exists
	                          no irg for this entity, only for one of the
	                          overwritten ones.
	                      Only for entity. */
	peculiarity_existent         /**< The entity/type (can) exist.
	                  @@@ eventually rename to 'real' i.e., 'echt'
	                      This serves better as opposition to description _and_ inherited.*/
123
124
125
126
127
128
129
130
} ir_peculiarity;

/**
 * Additional method type properties:
 * Tell about special properties of a method type. Some
 * of these may be discovered by analyses.
 */
typedef enum {
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
	mtp_no_property            = 0x00000000, /**< no additional properties, default */
	mtp_property_const         = 0x00000001, /**< This method did not access memory and calculates
	                                              its return values solely from its parameters.
	                                              GCC: __attribute__((const)). */
	mtp_property_pure          = 0x00000002, /**< This method did NOT write to memory and calculates
	                                              its return values solely from its parameters and
	                                              the memory they points to (or global vars).
	                                              GCC: __attribute__((pure)). */
	mtp_property_noreturn      = 0x00000004, /**< This method did not return due to an aborting system
	                                              call.
	                                              GCC: __attribute__((noreturn)). */
	mtp_property_nothrow       = 0x00000008, /**< This method cannot throw an exception.
	                                              GCC: __attribute__((nothrow)). */
	mtp_property_naked         = 0x00000010, /**< This method is naked.
	                                              GCC: __attribute__((naked)). */
	mtp_property_malloc        = 0x00000020, /**< This method returns newly allocate memory.
	                                              GCC: __attribute__((malloc)). */
	mtp_property_weak          = 0x00000040, /**< This method is weak. It is expected that
	                                              GCC: __attribute__((weak)). */
	mtp_property_returns_twice = 0x00000080, /**< This method can return more than one (typically setjmp).
                                                  GCC: __attribute__((returns_twice)). */
	mtp_property_intrinsic     = 0x00000100, /**< This method is intrinsic. It is expected that
	                                              a lowering phase will remove all calls to it. */
	mtp_property_runtime       = 0x00000200, /**< This method represents a runtime routine. */
	mtp_property_private       = 0x00000400, /**< All method invocations are known, the backend is free to
	                                              optimize the call in any possible way. */
	mtp_property_has_loop      = 0x00000800, /**< Set, if this method contains one possible endless loop. */
	mtp_property_inherited     = (1<<31)     /**< Internal. Used only in irg's, means property is
	                                              inherited from type. */
160
161
162
163
164
165
166
167
168
169
170
} mtp_additional_property;

/**
 * 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
171
ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
172
173
174
175
176
177
178
179
180
181

/**
 * 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
182
ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
183
184
185
186
187
188
189
190
191
192
193
194
195

/**
 * 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.
 *   @@@ Maybe we should change this.  If peculiarity of a method
 *       is existent, we should add a new SymConst that points to
 *       itself and not to the origin.  Right now we have to change
 *       the peculiarity and then set a new atomic value by hand.
 */
Michael Beck's avatar
Michael Beck committed
196
ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
197
198
199
200
201
202
203
204
205

/**
 * 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
206
ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
207
208
209
210
211
212
213

/**
 * 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
214
void free_entity(ir_entity *ent);
215
216
217
218
219

/** 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
220
ident *get_entity_ident(const ir_entity *ent);
221
222

/** Sets the ident of the entity. */
Michael Beck's avatar
Michael Beck committed
223
void set_entity_ident(ir_entity *ent, ident *id);
224
225
226
227
228
229
230

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

/** Sets the mangled name of the entity. */
Michael Beck's avatar
Michael Beck committed
234
void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
235
236
237
238
239

/** Returns the mangled name of the entity as a string. */
const char *get_entity_ld_name(ir_entity *ent);

/** Returns the owner of the entity. */
Michael Beck's avatar
Michael Beck committed
240
ir_type *get_entity_owner(ir_entity *ent);
241
242
243

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

/** Returns the type of an entity. */
Michael Beck's avatar
Michael Beck committed
247
ir_type *get_entity_type(ir_entity *ent);
248
249

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

/** The allocation type. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
254
255
256
257
258
259
260
261
262
263
	allocation_automatic, /**< The entity is allocated during runtime, implicitly
	                           as component of a compound type.   This is the default. */
	allocation_parameter, /**< The entity is a parameter.  It is also automatic allocated.
	                           We distinguish the allocation of parameters from the allocation
	                           of local variables as their placement depends on the calling
	                           conventions. */
	allocation_dynamic,   /**< The entity is allocated during runtime, explicitly
	                           by an Alloc node. */
	allocation_static     /**< The entity is allocated statically.  We can use a
	                           Const as address of the entity.  This is the default for methods. */
264
265
266
267
268
269
} ir_allocation;

/** Returns the allocation type of an entity. */
ir_allocation get_entity_allocation(const ir_entity *ent);

/** Sets the allocation type of an entity. */
Michael Beck's avatar
Michael Beck committed
270
void set_entity_allocation(ir_entity *ent, ir_allocation al);
271
272
273
274
275
276
277
278

/** Return the name of the allocation type. */
const char *get_allocation_name(ir_allocation vis);

/** Returns the visibility of an entity. */
ir_visibility get_entity_visibility(const ir_entity *ent);

/** Sets the visibility of an entity. */
Michael Beck's avatar
Michael Beck committed
279
void set_entity_visibility(ir_entity *ent, ir_visibility vis);
280
281
282
283
284
285

/** Return the name of the visibility */
const char *get_visibility_name(ir_visibility vis);

/** This enumeration flags the variability of entities. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
286
287
288
289
290
291
292
	variability_uninitialized,    /**< The content of the entity is completely unknown. Default. */
	variability_initialized,      /**< After allocation the entity is initialized with the
	                                   value given somewhere in the entity. */
	variability_part_constant,    /**< For entities of compound types.
	                                   The members of the entity are mixed constant,
	                                   initialized or uninitialized. */
	variability_constant          /**< The entity is constant. */
293
294
295
296
297
298
} ir_variability;

/** Returns the variability of an entity. */
ir_variability get_entity_variability(const ir_entity *ent);

/** Sets the variability of an entity. */
Michael Beck's avatar
Michael Beck committed
299
void set_entity_variability(ir_entity *ent, ir_variability var);
300
301
302
303

/** Return the name of the variability. */
const char *get_variability_name(ir_variability var);

Michael Beck's avatar
Michael Beck committed
304
/** This enumeration flags the volatility of entities and Loads/Stores. */
305
typedef enum {
Michael Beck's avatar
Michael Beck committed
306
307
	volatility_non_volatile,    /**< The entity is not volatile. Default. */
	volatility_is_volatile      /**< The entity is volatile. */
308
309
310
311
312
313
} ir_volatility;

/** Returns the volatility of an entity. */
ir_volatility get_entity_volatility(const ir_entity *ent);

/** Sets the volatility of an entity. */
Michael Beck's avatar
Michael Beck committed
314
void set_entity_volatility(ir_entity *ent, ir_volatility vol);
315
316
317
318

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

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

325
326
327
328
/** Returns the alignment of an entity. */
ir_align get_entity_align(const ir_entity *ent);

/** Sets the alignment of an entity. */
Michael Beck's avatar
Michael Beck committed
329
void  set_entity_align(ir_entity *ent, ir_align a);
330

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

334
335
/** This enumeration flags the stickyness of an entity. */
typedef enum {
336
337
338
339
340
341
	stickyness_unsticky,  /**< The entity can be removed from
	                           the program, unless contraindicated
	                           by other attributes. Default. */
	stickyness_sticky     /**< The entity must remain in the
	                           program in any case. There might be external
	                           callers. */
342
343
344
345
346
347
} ir_stickyness;

/** Get the entity's stickyness. */
ir_stickyness get_entity_stickyness(const ir_entity *ent);

/** Set the entity's stickyness. */
Michael Beck's avatar
Michael Beck committed
348
void set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness);
349
350

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

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

/** 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
360
void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
361
362
363
364
365
366
367
368
369
370
371
372
373

/** 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.
   This allows to get from a Call to the called irg.
   Only entities of peculiarity "existent" can have a corresponding irg,
   else the field is fixed to NULL.  (Get returns NULL, set asserts.) */
ir_graph *get_entity_irg(const ir_entity *ent);
Michael Beck's avatar
Michael Beck committed
374
void set_entity_irg(ir_entity *ent, ir_graph *irg);
375
376
377
378
379

/** 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
380
void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
381
382
383
384
385

/** Return the peculiarity of an entity. */
ir_peculiarity get_entity_peculiarity(const ir_entity *ent);

/** Sets the peculiarity of an entity. */
Michael Beck's avatar
Michael Beck committed
386
void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
387
388
389
390
391
392
393
394
395
396
397
398
399

/** Checks if an entity cannot be overridden anymore. */
int is_entity_final(const ir_entity *ent);

/** Sets/resets the final flag of an entity. */
void set_entity_final(ir_entity *ent, int final);

/** 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
400
401
402
403
404
405
/** Checks if an entity is marked by the backend. */
int is_entity_backend_marked(const ir_entity *ent);

/** Sets/resets the backend marker flag. */
void set_entity_backend_marked(ir_entity *ent, int flag);

406
/**
407
 * Bitfield type indicating the way an entity is used.
408
409
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
410
411
412
413
414
415
416
	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 */
417
418
419
420
421
422
423
	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);
424
425

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

428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
/**
 * 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);

443
444
445
446
447
448
449
450
/* -- 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
451
int is_irn_const_expression(ir_node *n);
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466

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

469
470
/** the kind (type) of an initializer */
typedef enum ir_initializer_kind_t {
471
	/** initializer containing an ir_node from the const-code irg */
472
	IR_INITIALIZER_CONST,
473
	/** initializer containing a tarval */
474
	IR_INITIALIZER_TARVAL,
475
	/** initializes type with default values (usually 0) */
476
	IR_INITIALIZER_NULL,
477
	/** list of initializers used to initializer a compound or array type */
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
	IR_INITIALIZER_COMPOUND
} ir_initializer_kind_t;

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

/**
 * 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);

Michael Beck's avatar
Michael Beck committed
518
/** Creates a new compound graph path of given length. */
519
520
521
compound_graph_path *new_compound_graph_path(ir_type *tp, int length);

/** Returns non-zero if an object is a compound graph path */
Michael Beck's avatar
Michael Beck committed
522
int is_compound_graph_path(const void *thing);
523
524

/** Frees a graph path object */
Michael Beck's avatar
Michael Beck committed
525
void free_compound_graph_path(compound_graph_path *gr);
526
527

/** Returns the length of a graph path */
Michael Beck's avatar
Michael Beck committed
528
int get_compound_graph_path_length(const compound_graph_path *gr);
529

530
/** Get the entity node of an compound graph path at position pos. */
531
ir_entity *get_compound_graph_path_node(const compound_graph_path *gr, int pos);
532
533
534
535
536
537
538
539
/** Set the entity node of an compound graph path at position pos. */
void      set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node);
/** Get the index of an compound graph path at position pos. */
int       get_compound_graph_path_array_index(const compound_graph_path *gr, int pos);
/** Set the index of an compound graph path at position pos. */
void      set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
/** Get the type of an compound graph path. */
ir_type   *get_compound_graph_path_type(const compound_graph_path *gr);
540
541
542
543
544
545
546

/** Checks whether the path up to pos is correct. If the path contains a NULL,
 *  assumes the path is not complete and returns non-zero. */
int is_proper_compound_graph_path(compound_graph_path *gr, int pos);

/* A value of a compound entity is a pair of a value and the description of the
   corresponding access path to the member of the compound.  */
Michael Beck's avatar
Michael Beck committed
547
548
549
void add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path);
void set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos);

550
551
552
553
/** Returns the number of constant values needed to initialize the entity.
 *
 *  Asserts if the entity has variability_uninitialized.
 * */
Michael Beck's avatar
Michael Beck committed
554
int get_compound_ent_n_values(ir_entity *ent);
555
556
557
558
559
560
561
562
563
564
565
/** Returns a constant value given the position. */
ir_node *get_compound_ent_value(ir_entity *ent, int pos);
/** Returns the access path for value at position pos. */
compound_graph_path *get_compound_ent_value_path(ir_entity *ent, int pos);
/** Returns a constant value given the access path.
 *  The path must contain array indices for all array element entities. */
ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path);

/** Removes all constant entries where the path ends at value_ent. Does not
   free the memory of the paths.  (The same path might be used for several
   constant entities. */
Michael Beck's avatar
Michael Beck committed
566
void remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent);
567
568
569
570
571
572
573
574
575
576

/* Some languages support only trivial access paths, i.e., the member is a
   direct, atomic member of the constant entities type. In this case the
   corresponding entity can be accessed directly.  The following functions
   allow direct access. */

/** Generates a Path with length 1.
    Beware: Has a bad runtime for array elements (O(|array|) and should be
    avoided there. Use add_compound_ent_value_w_path() instead and create
    the path manually. */
Michael Beck's avatar
Michael Beck committed
577
void add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member);
578
579

/** Returns the last member in the path */
Michael Beck's avatar
Michael Beck committed
580
ir_entity *get_compound_ent_value_member(ir_entity *ent, int pos);
581
582

/** Sets the path at pos 0 */
Michael Beck's avatar
Michael Beck committed
583
void set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos);
584

585
/** Sets the new style initializers of an entity. */
586
587
void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer);

588
/** Return the new style initializers of an entity. */
589
590
ir_initializer_t *get_entity_initializer(const ir_entity *entity);

591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
/** Initializes the entity ent which must be of a one dimensional
   array type with the values given in the values array.
   The array must have a lower and an upper bound.  Keeps the
   order of values. Does not test whether the number of values
   fits into the given array size.  Does not test whether the
   values have the proper mode for the array. */
void set_array_entity_values(ir_entity *ent, tarval **values, int num_vals);

/**
 * Return the offset in bits from the last byte address.
 *
 * This requires that the layout of all concerned types is fixed.
 *
 * @param ent Any entity of compound type with at least pos initialization values.
 * @param pos The position of the value for which the offset is requested.
 */
607
unsigned get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
608
609
610
611
612
613
614
615
616

/** Return the overall offset of value at position pos in bytes.
 *
 * This requires that the layout of all concerned types is fixed.
 * Asserts if bit offset is not byte aligned.
 *
 * @param ent Any entity of compound type with at least pos initialization values.
 * @param pos The position of the value for which the offset is requested.
 */
617
unsigned get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
618
619
620
621
622
623
624
625
626
627
628

/* --- 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
629
630
631
632
633
634
void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
int get_entity_n_overwrites(ir_entity *ent);
int get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten);
ir_entity *get_entity_overwrites(ir_entity *ent, int pos);
void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
635

Michael Beck's avatar
Michael Beck committed
636
637
638
639
640
641
void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
int get_entity_n_overwrittenby(ir_entity *ent);
int get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites);
ir_entity *get_entity_overwrittenby(ir_entity *ent, int pos);
void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
642
643
644
645
646
647
648
649
650

/**
 *   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
651
int is_entity(const void *thing);
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678

/** Returns true if the type of the entity is a primitive, pointer
 * enumeration or method type.
 *
 * @Note This is a different classification than from is_primitive_type().
 */
int is_atomic_entity(ir_entity *ent);
/** Returns true if the type of the entity is a class, structure,
   array or union type. */
int is_compound_entity(ir_entity *ent);
/** Returns true if the type of the entity is a Method type. */
int is_method_entity(ir_entity *ent);

/** Returns non-zero if ent1 and ent2 have are equal except for their owner.
   Two entities are equal if
    - they have the same type (the same C-struct)
    - ...?
*/
int equal_entity(ir_entity *ent1, ir_entity *ent2);

/** 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. */
679
ir_visited_t get_entity_visited(ir_entity *ent);
680
681

/** Sets the entities visited count. */
682
void set_entity_visited(ir_entity *ent, ir_visited_t num);
683
684

/** Sets visited field in entity to entity_visited. */
Michael Beck's avatar
Michael Beck committed
685
void mark_entity_visited(ir_entity *ent);
686
687

/** Returns true if this entity was visited. */
Michael Beck's avatar
Michael Beck committed
688
int entity_visited(ir_entity *ent);
689
690

/** Returns true if this entity was not visited. */
Michael Beck's avatar
Michael Beck committed
691
int entity_not_visited(ir_entity *ent);
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755

/**
 * 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().
 */
unsigned get_entity_additional_properties(ir_entity *ent);

/** 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
 * - allocation    = allocation_automatic
 * - visibility    = visibility_external_allocated
 * - offset        = -1
 * - variability   = variability_uninitialized
 * - value         = SymConst(unknown_entity)
 * - values        = NULL
 * - val_paths     = NULL
 * - peculiarity   = peculiarity_existent
 * - volatility    = volatility_non_volatile
 * - stickyness    = stickyness_unsticky
 * - ld_name       = NULL
 * - overwrites    = NULL
 * - overwrittenby = NULL
 * - irg           = NULL
 * - link          = NULL
 */
/* A variable that contains the only unknown entity. */
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
756
757
758
759
760
761
	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 */
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
} 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.
 *
 *  @see type.h
 */

/**
 *  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. */
	tpo_id,                  /**< Special Id tag used for type replacement. */
	tpo_none,                /**< Special type for the None type. */
	tpo_unknown,             /**< Special code for the Unknown type. */
	tpo_max                  /* not a type opcode */
} 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.
 *
 * @see  get_tpop_name(), get_tpop_code(), get_tpop_ident()
 */
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
815
 * @return a string.  (@todo Null terminated?)
816
 */
Michael Beck's avatar
Michael Beck committed
817
const char *get_tpop_name(const tp_op *op);
818
819
820
821
822
823
824

/**
 * 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
825
tp_opcode get_tpop_code(const tp_op *op);
826
827
828
829
830
831
832

/**
 * Returns the ident for the type opcode.
 *
 * @param op   The type opcode to get the ident from.
 * @return The ident.
 */
Michael Beck's avatar
Michael Beck committed
833
ident *get_tpop_ident(const tp_op *op);
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
869
870
871
872
873
874
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
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
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
997
998
999
1000

/**
 * 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.
 */
extern tp_op *type_class;
tp_op *get_tpop_class(void);

/**
 * 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.
 */
extern tp_op *type_struct;
tp_op *get_tpop_struct(void);

/**
 * 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.
 */
extern tp_op *type_method;
tp_op *get_tpop_method(void);

/**
 * 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.
 */
extern tp_op *type_union;
tp_op *get_tpop_union(void);

/**
 * 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.
 */
extern tp_op *type_array;
tp_op *get_tpop_array(void);

/**
 * 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.
 */
extern tp_op *type_enumeration;
tp_op *get_tpop_enumeration(void);

/**
 * 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.
 */
extern tp_op *type_pointer;
tp_op *get_tpop_pointer(void);

/**
 * 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.
 */
extern tp_op *type_primitive;
tp_op *get_tpop_primitive(void);

/**
 * This type opcode is an auxiliary opcode dedicated to support transformations
 * of the type structure.
 *
 * If a type is changed to another type with another
 * opcode the new type will be allocated with new memory.  All nodes refering
 * to the old type need to be changed to refer to the new one.  This is simplified
 * by turning the old type into an id type that merely forwards to the new type
 * that now replaces the old one.
 * type_ids should never be visible out of the type module.  All access routines
 * should automatically check for type_id and eventually follow the forward in
 * type_id.  Two types are exchanged by a call to exchange_types.
 * If a type_id is visible externally report this as bug.  If it is assured that
 * this never happens this extern variable can be moved to tpop_t.h.
 * This struct is dynamically allocated but constant for the lifetime
 * of the library.
 */
extern tp_op *type_id;
tp_op *get_tpop_id(void);

/**
 * 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.
 */
extern tp_op *tpop_none;
tp_op *get_tpop_none(void);

/**
 * 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.
 */
extern tp_op *tpop_unknown;
tp_op *get_tpop_unknown(void);

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

For faster browsing, not all history is shown. View entire blame