2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 #ifndef FIRM_TYPEREP_H
20 #define FIRM_TYPEREP_H
22 #include "firm_types.h"
25 * @page entity Entity representation
27 * An entity is the representation of program known objects in Firm.
28 * The primary concept of entities is to represent members of complex
29 * types, i.e., fields and methods of classes. As not all programming
30 * language model all variables and methods as members of some class,
31 * the concept of entities is extended to cover also local and global
32 * variables, and arbitrary procedures.
34 * An entity always specifies the type of the object it represents and
35 * the type of the object it is a part of, the owner of the entity.
36 * Originally this is the type of the class of which the entity is a
38 * The owner of local variables is the procedure they are defined in.
39 * The owner of global variables and procedures visible in the whole
40 * program is a universally defined class type "GlobalType". The owner
41 * of procedures defined in the scope of an other procedure is the
42 * enclosing procedure.
44 * The type ir_entity is an abstract data type to represent program entities.
45 * If contains the following attributes:
47 * - owner: A compound type this entity is a part of.
48 * - type: The type of this entity.
49 * - 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,
50 * automatic_allocated).
51 * - visibility: A flag indicating the visibility of this entity (values: local,
52 * external_visible, external_allocated)
53 * - variability: A flag indicating the variability of this entity (values:
54 * uninitialized, initialized, part_constant, constant)
56 * - offset: The offset of the entity within the compound object in bytes. Only set
57 * if the owner in the state "layout_fixed".
58 * - offset_bits_remainder: The offset bit remainder of a bitfield entity (in a compound)
59 * in bits. Only set if the owner in the state "layout_fixed".
60 * - overwrites: A list of entities overwritten by this entity. This list is only
61 * existent if the owner of this entity is a class. The members in
62 * this list must be entities of super classes.
63 * - overwrittenby: A list of entities that overwrite this entity. This list is only
64 * existent if the owner of this entity is a class. The members in
65 * this list must be entities of sub classes.
66 * - link: A void* to associate some additional information with the entity.
67 * - irg: If the entity is a method this is the ir graph that represents the
69 * - peculiarity: The peculiarity of the entity. If the entity is a method this
70 * indicates whether the entity represents
71 * a real method or whether it only exists to describe an interface.
72 * In that case there nowhere exists code for this entity and this entity
73 * is never dynamically used in the code.
74 * Values: description, existent. Default: existent.
75 * - visited: visited flag. Master flag is type_visited.
77 * These fields can only be accessed via access functions.
79 * @see ir_type, ir_entity
82 /** This enumeration flags the visibility of entities and types.
84 * This is necessary for partial compilation.
85 * We rely on the ordering of the flags.
88 visibility_local, /**< The entity is only visible locally. This is the default for
90 The type is only visible locally. All instances are allocated
91 locally, and no pointer to entities of this type are passed
92 out of this compilation unit. */
93 visibility_external_visible, /**< The entity is visible to other external program parts, but
94 it is defined here. It may not be optimized away. The entity must
96 For types: entities of this type can be accessed externally. No
97 instances of this type are allocated externally. */
98 visibility_external_allocated /**< The entity is defined and allocated externally. This compilation
99 must not allocate memory for this entity. The entity must
100 be static_allocated. This can also be an external defined
102 For types: entities of this type are allocated and accessed from
103 external code. Default for types. */
106 /** This enumeration flags the peculiarity of entities and types. */
108 peculiarity_description, /**< Represents only a description. The entity/type is never
109 allocated, no code/data exists for this entity/type.
110 @@@ eventually rename to descriptive (adjective as the others!)*/
111 peculiarity_inherited, /**< Describes explicitly that other entities are
112 inherited to the owner of this entity.
113 Overwrites must refer to at least one other
114 entity. If this is a method entity there exists
115 no irg for this entity, only for one of the
118 peculiarity_existent /**< The entity/type (can) exist.
119 @@@ eventually rename to 'real' i.e., 'echt'
120 This serves better as opposition to description _and_ inherited.*/
124 * Additional method type properties:
125 * Tell about special properties of a method type. Some
126 * of these may be discovered by analyses.
129 mtp_no_property = 0x00000000, /**< no additional properties, default */
130 mtp_property_const = 0x00000001, /**< This method did not access memory and calculates
131 its return values solely from its parameters.
132 GCC: __attribute__((const)). */
133 mtp_property_pure = 0x00000002, /**< This method did NOT write to memory and calculates
134 its return values solely from its parameters and
135 the memory they points to (or global vars).
136 GCC: __attribute__((pure)). */
137 mtp_property_noreturn = 0x00000004, /**< This method did not return due to an aborting system
139 GCC: __attribute__((noreturn)). */
140 mtp_property_nothrow = 0x00000008, /**< This method cannot throw an exception.
141 GCC: __attribute__((nothrow)). */
142 mtp_property_naked = 0x00000010, /**< This method is naked.
143 GCC: __attribute__((naked)). */
144 mtp_property_malloc = 0x00000020, /**< This method returns newly allocate memory.
145 GCC: __attribute__((malloc)). */
146 mtp_property_intrinsic = 0x00000040, /**< This method is intrinsic. It is expected that
147 a lowering phase will remove all calls to it. */
148 mtp_property_runtime = 0x00000080, /**< This method represents a runtime routine. */
149 mtp_property_private = 0x00000100, /**< All method invocations are known, the backend is free to
150 optimize the call in any possible way. */
151 mtp_property_inherited = (1<<31) /**< Internal. Used only in irg's, means property is
152 inherited from type. */
153 } mtp_additional_property;
156 * Creates a new entity.
158 * Automatically inserts the entity as a member of owner.
159 * Entity is automatic_allocated and uninitialized except if the type
160 * is type_method, then it is static_allocated and constant. The constant
161 * value is a pointer to the method.
162 * Visibility is local, offset -1, and it is not volatile.
164 ir_entity *new_entity(ir_type *owner, ident *name, ir_type *tp);
167 * Creates a new entity.
169 * Automatically inserts the entity as a member of owner.
170 * The entity is automatic allocated and uninitialized except if the type
171 * is type_method, then it is static allocated and constant. The constant
172 * value is a pointer to the method.
173 * Visibility is local, offset -1, and it is not volatile.
175 ir_entity *new_d_entity(ir_type *owner, ident *name, ir_type *tp, dbg_info *db);
178 * Copies the entity if the new_owner is different from the
179 * owner of the old entity, else returns the old entity.
181 * Automatically inserts the new entity as a member of owner.
182 * Resets the overwrites/overwritten_by fields.
183 * Keeps the old atomic value.
184 * @@@ Maybe we should change this. If peculiarity of a method
185 * is existent, we should add a new SymConst that points to
186 * itself and not to the origin. Right now we have to change
187 * the peculiarity and then set a new atomic value by hand.
189 ir_entity *copy_entity_own(ir_entity *old, ir_type *new_owner);
192 * Copies the entity if the new_name is different from the
193 * name of the old entity, else returns the old entity.
195 * Automatically inserts the new entity as a member of owner.
196 * The mangled name ld_name is set to NULL.
197 * Overwrites relation is copied from old.
199 ir_entity *copy_entity_name(ir_entity *old, ident *new_name);
204 * The owner will still contain the pointer to this
205 * entity, as well as all other references!
207 void free_entity(ir_entity *ent);
209 /** Returns the name of an entity. */
210 const char *get_entity_name(const ir_entity *ent);
212 /** Returns the ident of an entity. */
213 ident *get_entity_ident(const ir_entity *ent);
215 /** Sets the ident of the entity. */
216 void set_entity_ident(ir_entity *ent, ident *id);
218 /** Returns the mangled name of the entity.
220 * If the mangled name is set it returns the existing name.
221 * Else it generates a name with mangle_entity()
222 * and remembers this new name internally.
224 ident *get_entity_ld_ident(ir_entity *ent);
226 /** Sets the mangled name of the entity. */
227 void set_entity_ld_ident(ir_entity *ent, ident *ld_ident);
229 /** Returns the mangled name of the entity as a string. */
230 const char *get_entity_ld_name(ir_entity *ent);
232 /** Returns the owner of the entity. */
233 ir_type *get_entity_owner(ir_entity *ent);
235 /** Sets the owner field in entity to owner. Don't forget to add
237 void set_entity_owner(ir_entity *ent, ir_type *owner);
239 /** Returns the type of an entity. */
240 ir_type *get_entity_type(ir_entity *ent);
242 /** Sets the type of an entity. */
243 void set_entity_type(ir_entity *ent, ir_type *tp);
245 /** The allocation type. */
247 allocation_automatic, /**< The entity is allocated during runtime, implicitly
248 as component of a compound type. This is the default. */
249 allocation_parameter, /**< The entity is a parameter. It is also automatic allocated.
250 We distinguish the allocation of parameters from the allocation
251 of local variables as their placement depends on the calling
253 allocation_dynamic, /**< The entity is allocated during runtime, explicitly
255 allocation_static /**< The entity is allocated statically. We can use a
256 Const as address of the entity. This is the default for methods. */
259 /** Returns the allocation type of an entity. */
260 ir_allocation get_entity_allocation(const ir_entity *ent);
262 /** Sets the allocation type of an entity. */
263 void set_entity_allocation(ir_entity *ent, ir_allocation al);
265 /** Return the name of the allocation type. */
266 const char *get_allocation_name(ir_allocation vis);
268 /** Returns the visibility of an entity. */
269 ir_visibility get_entity_visibility(const ir_entity *ent);
271 /** Sets the visibility of an entity. */
272 void set_entity_visibility(ir_entity *ent, ir_visibility vis);
274 /** Return the name of the visibility */
275 const char *get_visibility_name(ir_visibility vis);
277 /** This enumeration flags the variability of entities. */
279 variability_uninitialized, /**< The content of the entity is completely unknown. Default. */
280 variability_initialized, /**< After allocation the entity is initialized with the
281 value given somewhere in the entity. */
282 variability_part_constant, /**< For entities of compound types.
283 The members of the entity are mixed constant,
284 initialized or uninitialized. */
285 variability_constant /**< The entity is constant. */
288 /** Returns the variability of an entity. */
289 ir_variability get_entity_variability(const ir_entity *ent);
291 /** Sets the variability of an entity. */
292 void set_entity_variability(ir_entity *ent, ir_variability var);
294 /** Return the name of the variability. */
295 const char *get_variability_name(ir_variability var);
297 /** This enumeration flags the volatility of entities and Loads/Stores. */
299 volatility_non_volatile, /**< The entity is not volatile. Default. */
300 volatility_is_volatile /**< The entity is volatile. */
303 /** Returns the volatility of an entity. */
304 ir_volatility get_entity_volatility(const ir_entity *ent);
306 /** Sets the volatility of an entity. */
307 void set_entity_volatility(ir_entity *ent, ir_volatility vol);
309 /** Return the name of the volatility. */
310 const char *get_volatility_name(ir_volatility var);
312 /** This enumeration flags the align of Loads/Stores. */
314 align_non_aligned, /**< The entity is not aligned. */
315 align_is_aligned /**< The entity is aligned. Default */
318 /** Returns the alignment of an entity. */
319 ir_align get_entity_align(const ir_entity *ent);
321 /** Sets the alignment of an entity. */
322 void set_entity_align(ir_entity *ent, ir_align a);
324 /** Return the name of the alignment. */
325 const char *get_align_name(ir_align a);
327 /** This enumeration flags the stickyness of an entity. */
329 stickyness_unsticky, /**< The entity can be removed from
330 the program, unless contraindicated
331 by other attributes. Default. */
332 stickyness_sticky /**< The entity must remain in the
333 program in any case. */
336 /** Get the entity's stickyness. */
337 ir_stickyness get_entity_stickyness(const ir_entity *ent);
339 /** Set the entity's stickyness. */
340 void set_entity_stickyness(ir_entity *ent, ir_stickyness stickyness);
342 /** Returns the offset of an entity (in a compound) in bytes. Only set if layout = fixed. */
343 int get_entity_offset(const ir_entity *ent);
345 /** Sets the offset of an entity (in a compound) in bytes. */
346 void set_entity_offset(ir_entity *ent, int offset);
348 /** Returns the offset bit remainder of a bitfield entity (in a compound) in bits. Only set if layout = fixed. */
349 unsigned char get_entity_offset_bits_remainder(const ir_entity *ent);
351 /** Sets the offset bit remainder of a bitfield entity (in a compound) in bits. */
352 void set_entity_offset_bits_remainder(ir_entity *ent, unsigned char offset);
354 /** Returns the stored intermediate information. */
355 void *get_entity_link(const ir_entity *ent);
357 /** Stores new intermediate information. */
358 void set_entity_link(ir_entity *ent, void *l);
360 /* -- Fields of method entities -- */
361 /** The entity knows the corresponding irg if the entity is a method.
362 This allows to get from a Call to the called irg.
363 Only entities of peculiarity "existent" can have a corresponding irg,
364 else the field is fixed to NULL. (Get returns NULL, set asserts.) */
365 ir_graph *get_entity_irg(const ir_entity *ent);
366 void set_entity_irg(ir_entity *ent, ir_graph *irg);
368 /** Gets the entity vtable number. */
369 unsigned get_entity_vtable_number(const ir_entity *ent);
371 /** Sets the entity vtable number. */
372 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number);
374 /** Return the peculiarity of an entity. */
375 ir_peculiarity get_entity_peculiarity(const ir_entity *ent);
377 /** Sets the peculiarity of an entity. */
378 void set_entity_peculiarity(ir_entity *ent, ir_peculiarity pec);
380 /** Checks if an entity cannot be overridden anymore. */
381 int is_entity_final(const ir_entity *ent);
383 /** Sets/resets the final flag of an entity. */
384 void set_entity_final(ir_entity *ent, int final);
386 /** Checks if an entity is compiler generated. */
387 int is_entity_compiler_generated(const ir_entity *ent);
389 /** Sets/resets the compiler generated flag. */
390 void set_entity_compiler_generated(ir_entity *ent, int flag);
392 /** Checks if an entity is marked by the backend. */
393 int is_entity_backend_marked(const ir_entity *ent);
395 /** Sets/resets the backend marker flag. */
396 void set_entity_backend_marked(ir_entity *ent, int flag);
399 * The state of the address_taken flag.
402 ir_address_not_taken = 0, /**< The address is NOT taken. */
403 ir_address_taken_unknown = 1, /**< The state of the address taken flag is unknown. */
404 ir_address_taken = 2 /**< The address IS taken. */
405 } ir_address_taken_state;
407 /** Return the state of the address taken flag of an entity. */
408 ir_address_taken_state get_entity_address_taken(const ir_entity *ent);
410 /** Sets/resets the state of the address taken flag of an entity. */
411 void set_entity_address_taken(ir_entity *ent, ir_address_taken_state flag);
413 /** Return the name of the address_taken state. */
414 const char *get_address_taken_state_name(ir_address_taken_state state);
417 * Returns the debug information of an entity.
419 * @param ent The entity.
421 dbg_info *get_entity_dbg_info(const ir_entity *ent);
424 * Sets the debug information of an entity.
426 * @param ent The entity.
427 * @param db The debug info.
429 void set_entity_dbg_info(ir_entity *ent, dbg_info *db);
431 /* -- Representation of constant values of entities -- */
433 * Returns true if the the node is representable as code on
436 * @deprecated This function is not used by libFirm and stays here
437 * only as a helper for the old Jack frontend.
439 int is_irn_const_expression(ir_node *n);
442 * Copies a Firm subgraph that complies to the restrictions for
443 * constant expressions to current_block in current_ir_graph.
445 * @param dbg debug info for all newly created nodes
448 * Set current_ir_graph to get_const_code_irg() to generate a constant
451 ir_node *copy_const_value(dbg_info *dbg, ir_node *n);
453 /* Set has no effect for existent entities of type method. */
454 ir_node *get_atomic_ent_value(ir_entity *ent);
455 void set_atomic_ent_value(ir_entity *ent, ir_node *val);
457 /** Creates a new compound graph path of given length. */
458 compound_graph_path *new_compound_graph_path(ir_type *tp, int length);
460 /** Returns non-zero if an object is a compound graph path */
461 int is_compound_graph_path(const void *thing);
463 /** Frees a graph path object */
464 void free_compound_graph_path(compound_graph_path *gr);
466 /** Returns the length of a graph path */
467 int get_compound_graph_path_length(const compound_graph_path *gr);
469 ir_entity *get_compound_graph_path_node(const compound_graph_path *gr, int pos);
470 void set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node);
471 int get_compound_graph_path_array_index(const compound_graph_path *gr, int pos);
472 void set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index);
474 /** Checks whether the path up to pos is correct. If the path contains a NULL,
475 * assumes the path is not complete and returns non-zero. */
476 int is_proper_compound_graph_path(compound_graph_path *gr, int pos);
478 /* A value of a compound entity is a pair of a value and the description of the
479 corresponding access path to the member of the compound. */
480 void add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path);
481 void set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos);
483 /** Returns the number of constant values needed to initialize the entity.
485 * Asserts if the entity has variability_uninitialized.
487 int get_compound_ent_n_values(ir_entity *ent);
488 /** Returns a constant value given the position. */
489 ir_node *get_compound_ent_value(ir_entity *ent, int pos);
490 /** Returns the access path for value at position pos. */
491 compound_graph_path *get_compound_ent_value_path(ir_entity *ent, int pos);
492 /** Returns a constant value given the access path.
493 * The path must contain array indices for all array element entities. */
494 ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path);
496 /** Removes all constant entries where the path ends at value_ent. Does not
497 free the memory of the paths. (The same path might be used for several
498 constant entities. */
499 void remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent);
501 /* Some languages support only trivial access paths, i.e., the member is a
502 direct, atomic member of the constant entities type. In this case the
503 corresponding entity can be accessed directly. The following functions
504 allow direct access. */
506 /** Generates a Path with length 1.
507 Beware: Has a bad runtime for array elements (O(|array|) and should be
508 avoided there. Use add_compound_ent_value_w_path() instead and create
509 the path manually. */
510 void add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member);
512 /** Returns the last member in the path */
513 ir_entity *get_compound_ent_value_member(ir_entity *ent, int pos);
515 /** Sets the path at pos 0 */
516 void set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos);
518 /** Initializes the entity ent which must be of a one dimensional
519 array type with the values given in the values array.
520 The array must have a lower and an upper bound. Keeps the
521 order of values. Does not test whether the number of values
522 fits into the given array size. Does not test whether the
523 values have the proper mode for the array. */
524 void set_array_entity_values(ir_entity *ent, tarval **values, int num_vals);
527 * Return the offset in bits from the last byte address.
529 * This requires that the layout of all concerned types is fixed.
531 * @param ent Any entity of compound type with at least pos initialization values.
532 * @param pos The position of the value for which the offset is requested.
534 int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos);
536 /** Return the overall offset of value at position pos in bytes.
538 * This requires that the layout of all concerned types is fixed.
539 * Asserts if bit offset is not byte aligned.
541 * @param ent Any entity of compound type with at least pos initialization values.
542 * @param pos The position of the value for which the offset is requested.
544 int get_compound_ent_value_offset_bytes(ir_entity *ent, int pos);
546 /* --- Fields of entities with a class type as owner --- */
547 /* Overwrites is a field that specifies that an access to the overwritten
548 entity in the supertype must use this entity. It's a list as with
549 multiple inheritance several entities can be overwritten. This field
550 is mostly useful for method entities.
551 If a Sel node selects an entity that is overwritten by other entities it
552 must return a pointer to the entity of the dynamic type of the pointer
553 that is passed to it. Lowering of the Sel node must assure this.
554 Overwrittenby is the inverse of overwrites. Both add routines add
555 both relations, they only differ in the order of arguments. */
556 void add_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
557 int get_entity_n_overwrites(ir_entity *ent);
558 int get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten);
559 ir_entity *get_entity_overwrites(ir_entity *ent, int pos);
560 void set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten);
561 void remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten);
563 void add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
564 int get_entity_n_overwrittenby(ir_entity *ent);
565 int get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites);
566 ir_entity *get_entity_overwrittenby(ir_entity *ent, int pos);
567 void set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites);
568 void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites);
571 * Checks whether a pointer points to an entity.
573 * @param thing an arbitrary pointer
576 * true if the thing is an entity, else false
578 int is_entity(const void *thing);
580 /** Returns true if the type of the entity is a primitive, pointer
581 * enumeration or method type.
583 * @Note This is a different classification than from is_primitive_type().
585 int is_atomic_entity(ir_entity *ent);
586 /** Returns true if the type of the entity is a class, structure,
587 array or union type. */
588 int is_compound_entity(ir_entity *ent);
589 /** Returns true if the type of the entity is a Method type. */
590 int is_method_entity(ir_entity *ent);
592 /** Returns non-zero if ent1 and ent2 have are equal except for their owner.
593 Two entities are equal if
594 - they have the same type (the same C-struct)
597 int equal_entity(ir_entity *ent1, ir_entity *ent2);
599 /** Outputs a unique number for this entity if libfirm is compiled for
600 * debugging, (configure with --enable-debug) else returns the address
601 * of the type cast to long.
603 long get_entity_nr(const ir_entity *ent);
605 /** Returns the entities visited count. */
606 unsigned long get_entity_visited(ir_entity *ent);
608 /** Sets the entities visited count. */
609 void set_entity_visited(ir_entity *ent, unsigned long num);
611 /** Sets visited field in entity to entity_visited. */
612 void mark_entity_visited(ir_entity *ent);
614 /** Returns true if this entity was visited. */
615 int entity_visited(ir_entity *ent);
617 /** Returns true if this entity was not visited. */
618 int entity_not_visited(ir_entity *ent);
621 * Returns the mask of the additional entity properties.
622 * The properties are automatically inherited from the irg if available
623 * or from the method type if they were not set using
624 * set_entity_additional_properties() or
625 * set_entity_additional_property().
627 unsigned get_entity_additional_properties(ir_entity *ent);
629 /** Sets the mask of the additional graph properties. */
630 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask);
632 /** Sets one additional graph property. */
633 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag);
635 /** Returns the class type that this type info entity represents or NULL
636 if ent is no type info entity. */
637 ir_type *get_entity_repr_class(const ir_entity *ent);
640 * @page unknown_entity The Unknown entity
642 * This entity is an auxiliary entity dedicated to support analyses.
644 * The unknown entity represents that there could be an entity, but it is not
645 * known. This entity can be used to initialize fields before an analysis (not known
646 * yet) or to represent the top of a lattice (could not be determined). There exists
647 * exactly one entity unknown. This entity has as owner and as type the unknown type. It is
648 * allocated when initializing the entity module.
650 * The entity can take the role of any entity, also methods. It returns default
651 * values in these cases.
653 * The following values are set:
655 * - name = "unknown_entity"
656 * - ld_name = "unknown_entity"
657 * - owner = unknown_type
658 * - type = unknown_type
659 * - allocation = allocation_automatic
660 * - visibility = visibility_external_allocated
662 * - variability = variability_uninitialized
663 * - value = SymConst(unknown_entity)
666 * - peculiarity = peculiarity_existent
667 * - volatility = volatility_non_volatile
668 * - stickyness = stickyness_unsticky
670 * - overwrites = NULL
671 * - overwrittenby = NULL
675 /* A variable that contains the only unknown entity. */
676 extern ir_entity *unknown_entity;
678 /** Returns the @link unknown_entity unknown entity @endlink. */
679 ir_entity *get_unknown_entity(void);
681 /** Encodes how a pointer parameter is accessed. */
682 typedef enum acc_bits {
683 ptr_access_none = 0, /**< no access */
684 ptr_access_read = 1, /**< read access */
685 ptr_access_write = 2, /**< write access */
686 ptr_access_rw = ptr_access_read|ptr_access_write, /**< read AND write access */
687 ptr_access_store = 4, /**< the pointer is stored */
688 ptr_access_all = ptr_access_rw|ptr_access_store /**< all possible access */
691 #define IS_READ(a) ((a) & ptr_access_read)
692 #define IS_WRITTEN(a) ((a) & ptr_access_write)
693 #define IS_STORED(a) ((a) & ptr_access_store)
696 * Supported image sections.
697 * Currently only methods can be placed in different sections.
700 section_text, /**< The code segment. This is the default for methods. */
701 section_constructors /**< The constructor section. */
704 /** Returns the section of a method. */
705 ir_img_section get_method_img_section(const ir_entity *method);
707 /** Sets the section of a method. */
708 void set_method_img_section(ir_entity *method, ir_img_section section);
712 * @page tyop type operations
713 * This module specifies the kinds of types available in firm.
715 * They are called type opcodes. These include classes, structs, methods, unions,
716 * arrays, enumerations, pointers and primitive types.
717 * Special types with own opcodes are the id type, a type representing an unknown
718 * type and a type used to specify that something has no type.
724 * An enum for the type kinds.
725 * For each type kind exists a typecode to identify it.
728 tpo_uninitialized = 0, /* not a type opcode */
729 tpo_class, /**< A class type. */
730 tpo_struct, /**< A struct type. */
731 tpo_method, /**< A method type. */
732 tpo_union, /**< An union type. */
733 tpo_array, /**< An array type. */
734 tpo_enumeration, /**< An enumeration type. */
735 tpo_pointer, /**< A pointer type. */
736 tpo_primitive, /**< A primitive type. */
737 tpo_id, /**< Special Id tag used for type replacement. */
738 tpo_none, /**< Special type for the None type. */
739 tpo_unknown, /**< Special code for the Unknown type. */
740 tpo_max /* not a type opcode */
744 * A structure containing information about a kind of type.
745 * A structure containing information about a kind of type. So far
746 * this is only the kind name, an enum for case-switching and some
749 * @see get_tpop_name(), get_tpop_code(), get_tpop_ident()
751 typedef struct tp_op tp_op;
755 * Returns the string for the type opcode.
757 * @param op The type opcode to get the string from.
758 * @return a string. (@todo Null terminated?)
760 const char *get_tpop_name(const tp_op *op);
763 * Returns an enum for the type opcode.
765 * @param op The type opcode to get the enum from.
768 tp_opcode get_tpop_code(const tp_op *op);
771 * Returns the ident for the type opcode.
773 * @param op The type opcode to get the ident from.
776 ident *get_tpop_ident(const tp_op *op);
779 * This type opcode marks that the corresponding type is a class type.
781 * Consequently the type refers to supertypes, subtypes and entities.
782 * Entities can be any fields, but also methods.
783 * @@@ value class or not???
784 * This struct is dynamically allocated but constant for the lifetime
787 extern tp_op *type_class;
788 tp_op *get_tpop_class(void);
791 * This type opcode marks that the corresponding type is a compound type
794 * Consequently the type refers to a list of entities
795 * which may not be methods (but pointers to methods).
796 * This struct is dynamically allocated but constant for the lifetime
799 extern tp_op *type_struct;
800 tp_op *get_tpop_struct(void);
803 * This type opcode marks that the corresponding type is a method type.
805 * Consequently it refers to a list of arguments and results.
806 * This struct is dynamically allocated but constant for the lifetime
809 extern tp_op *type_method;
810 tp_op *get_tpop_method(void);
813 * This type opcode marks that the corresponding type is a union type.
815 * Consequently it refers to a list of unioned types.
816 * This struct is dynamically allocated but constant for the lifetime
819 extern tp_op *type_union;
820 tp_op *get_tpop_union(void);
823 * This type opcode marks that the corresponding type is an array type.
825 * Consequently it contains a list of dimensions (lower and upper bounds)
826 * and an element type.
827 * This struct is dynamically allocated but constant for the lifetime
830 extern tp_op *type_array;
831 tp_op *get_tpop_array(void);
834 * This type opcode marks that the corresponding type is an enumeration type.
836 * Consequently it contains a list of idents for the enumeration identifiers
837 * and a list of target values that are the constants used to implement
839 * This struct is dynamically allocated but constant for the lifetime
842 extern tp_op *type_enumeration;
843 tp_op *get_tpop_enumeration(void);
846 * This type opcode marks that the corresponding type is a pointer type.
848 * It contains a reference to the type the pointer points to.
849 * This struct is dynamically allocated but constant for the lifetime
852 extern tp_op *type_pointer;
853 tp_op *get_tpop_pointer(void);
856 * This type opcode marks that the corresponding type is a primitive type.
858 * Primitive types are types that are directly mapped to target machine
860 * This struct is dynamically allocated but constant for the lifetime
863 extern tp_op *type_primitive;
864 tp_op *get_tpop_primitive(void);
867 * This type opcode is an auxiliary opcode dedicated to support transformations
868 * of the type structure.
870 * If a type is changed to another type with another
871 * opcode the new type will be allocated with new memory. All nodes refering
872 * to the old type need to be changed to refer to the new one. This is simplified
873 * by turning the old type into an id type that merely forwards to the new type
874 * that now replaces the old one.
875 * type_ids should never be visible out of the type module. All access routines
876 * should automatically check for type_id and eventually follow the forward in
877 * type_id. Two types are exchanged by a call to exchange_types.
878 * If a type_id is visible externally report this as bug. If it is assured that
879 * this never happens this extern variable can be moved to tpop_t.h.
880 * This struct is dynamically allocated but constant for the lifetime
883 extern tp_op *type_id;
884 tp_op *get_tpop_id(void);
887 * This type opcode is an auxiliary opcode dedicated to support type analyses.
889 * Types with this opcode represents that there is no type.
890 * The type can be used to initialize fields of the type* that actually can not
891 * contain a type or that are initialized for an analysis. There exists exactly
892 * one type with this opcode.
894 extern tp_op *tpop_none;
895 tp_op *get_tpop_none(void);
898 * This type opcode is an auxiliary opcode dedicated to support type analyses.
900 * Types with this opcode represents that there could be a type, but it is not
901 * known. This type can be used to initialize fields before an analysis (not known
902 * yet) or to represent the top of a lattice (could not be determined). There exists
903 * exactly one type with this opcode.
905 extern tp_op *tpop_unknown;
906 tp_op *get_tpop_unknown(void);
908 /* ----------------------------------------------------------------------- */
909 /* Classify pairs of types/entities in the inheritance relations. */
910 /* ----------------------------------------------------------------------- */
912 /** Returns true if low is subclass of high.
914 * Low is a subclass of high if low == high or if low is a subclass of
915 * a subclass of high. I.e, we search in all subtypes of high for low.
916 * @@@ this can be implemented more efficient if we know the set of all
917 * subclasses of high. */
918 int is_SubClass_of(ir_type *low, ir_type *high);
920 /** Subclass check for pointers to classes.
922 * Dereferences at both types the same amount of pointer types (as
923 * many as possible). If the remaining types are both class types
924 * and subclasses, returns true, else false. Can also be called with
925 * two class types. */
926 int is_SubClass_ptr_of(ir_type *low, ir_type *high);
928 /** Returns true if high is superclass of low.
930 * Low is a subclass of high if low == high or if low is a subclass of
931 * a subclass of high. I.e, we search in all subtypes of high for low.
932 * @@@ this can be implemented more efficient if we know the set of all
933 * subclasses of high. */
934 #define is_SuperClass_of(high, low) is_SubClass_of(low, high)
936 /** Superclass check for pointers to classes.
938 * Dereferences at both types the same amount of pointer types (as
939 * many as possible). If the remaining types are both class types
940 * and superclasses, returns true, else false. Can also be called with
941 * two class types. */
942 #define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)
944 /** Returns true if high is (transitive) overwritten by low.
946 * Returns false if high == low. */
947 int is_overwritten_by(ir_entity *high, ir_entity *low);
949 /** Resolve polymorphism in the inheritance relation.
951 * Returns the dynamically referenced entity if the static entity and the
952 * dynamic type are given.
953 * Searches downwards in overwritten tree. */
954 ir_entity *resolve_ent_polymorphy(ir_type *dynamic_class, ir_entity* static_ent);
956 /* ----------------------------------------------------------------------- */
957 /* Resolve implicit inheritance. */
958 /* ----------------------------------------------------------------------- */
960 /** Default name mangling for inherited entities.
962 * Returns an ident that consists of the name of type followed by an
963 * underscore and the name (not ld_name) of the entity. */
964 ident *default_mangle_inherited_name(ir_entity *ent, ir_type *clss);
966 /** Type of argument functions for inheritance resolver.
968 * @param ent The entity in the super type that will be overwritten
969 * by the newly generated entity, for which this name is
971 * @param clss The class type in which the new entity will be placed.
973 typedef ident *mangle_inherited_name_func(ir_entity *ent, ir_type *clss);
975 /** Resolve implicit inheritance.
977 * Resolves the implicit inheritance supplied by firm. Firm defines,
978 * that each entity that is not overwritten in a subclass is
979 * inherited to this subclass without change implicitly. This
980 * function generates entities that explicitly represent this
981 * inheritance. It generates for each entity overwriting entities in
982 * all subclasses of the owner of the entity, if the entity is not
983 * overwritten in that subclass.
985 * The name of the new entity is generated with the function passed.
986 * If the function is NULL, the default_mangle_inherited_name() is
989 * This function was moved here from firmlower 3/2005.
991 void resolve_inheritance(mangle_inherited_name_func *mfunc);
994 /* ----------------------------------------------------------------------- */
995 /* The transitive closure of the subclass/superclass and */
996 /* overwrites/overwrittenby relation. */
998 /* A walk over the ir (O(#types+#entities)) computes the transitive */
999 /* closure. Adding a new type/entity or changing the basic relations in */
1000 /* some other way invalidates the transitive closure, i.e., it is not */
1001 /* updated by the basic functions. */
1003 /* The transitive edges are held in a set, not in an array as the */
1004 /* underlying relation. */
1006 /* Do the sets contain the node itself? I assume NOT! */
1007 /* ----------------------------------------------------------------------- */
1009 /** The state of the transitive closure.
1011 * @todo: we could manage the state for each relation separately. Invalidating
1012 * the entity relations does not mean invalidating the class relation. */
1014 inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
1015 inh_transitive_closure_valid, /**< Closure computed and valid. */
1016 inh_transitive_closure_invalid, /**< Closure invalid, but can be accessed. */
1017 inh_transitive_closure_max /**< Invalid value. */
1018 } inh_transitive_closure_state;
1020 void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
1021 void invalidate_irp_inh_transitive_closure_state(void);
1022 inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
1025 /** Compute transitive closure of the subclass/superclass and
1026 * overwrites/overwrittenby relation.
1028 * This function walks over the ir (O(#types+#entities)) to compute the
1029 * transitive closure. */
1030 void compute_inh_transitive_closure(void);
1032 /** Free memory occupied by the transitive closure information. */
1033 void free_inh_transitive_closure(void);
1036 /* - subtype ------------------------------------------------------------- */
1038 /** Iterate over all transitive subtypes. */
1039 ir_type *get_class_trans_subtype_first(const ir_type *tp);
1040 ir_type *get_class_trans_subtype_next(const ir_type *tp);
1041 int is_class_trans_subtype(const ir_type *tp, const ir_type *subtp);
1043 /* - supertype ----------------------------------------------------------- */
1045 /** Iterate over all transitive supertypes. */
1046 ir_type *get_class_trans_supertype_first(const ir_type *tp);
1047 ir_type *get_class_trans_supertype_next(const ir_type *tp);
1049 /* - overwrittenby ------------------------------------------------------- */
1051 /** Iterate over all entities that transitive overwrite this entities. */
1052 ir_entity *get_entity_trans_overwrittenby_first(const ir_entity *ent);
1053 ir_entity *get_entity_trans_overwrittenby_next(const ir_entity *ent);
1055 /* - overwrites ---------------------------------------------------------- */
1057 /** Iterate over all transitive overwritten entities. */
1058 ir_entity *get_entity_trans_overwrites_first(const ir_entity *ent);
1059 ir_entity *get_entity_trans_overwrites_next(const ir_entity *ent);
1062 /* ----------------------------------------------------------------------- */
1063 /** The state of Cast operations that cast class types or pointers to class
1066 * The state expresses, how far Cast operations conform with the class
1070 * class B1 extends A {}
1071 * class B2 extends A {}
1072 * class C extends B1 {}
1073 * normalized: Cast operations conform with the inheritance relation.
1074 * I.e., the type of the operand of a Cast is either a super= or a sub-
1075 * type of the type casted to. Example: (A)((B2) (new C())).
1076 * transitive: Cast operations conform with the transitive inheritance
1077 * relation. Example: (A)(new C()).
1078 * any: Cast operations do not conform with the transitive inheritance
1079 * relation. Example: (B2)(new B1())
1083 /* ----------------------------------------------------------------------- */
1085 /** Flags for class cast state.
1087 * The state in irp is always smaller or equal to the state of any
1090 * We rely on the ordering of the enum. */
1092 ir_class_casts_any = 0, /**< There are class casts that do not cast in conformance with
1093 the class hierarchy. @@@ So far this does not happen in Firm. */
1094 ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
1095 ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
1096 ir_class_casts_state_max
1097 } ir_class_cast_state;
1098 char *get_class_cast_state_string(ir_class_cast_state s);
1100 void set_irg_class_cast_state(ir_graph *irg, ir_class_cast_state s);
1101 ir_class_cast_state get_irg_class_cast_state(ir_graph *irg);
1102 void set_irp_class_cast_state(ir_class_cast_state s);
1103 ir_class_cast_state get_irp_class_cast_state(void);
1105 /** Verify the class cast state of an irg.
1107 * Asserts if state is to high, outputs warning if state is to low
1108 * and firm verbosity is set.
1110 void verify_irg_class_cast_state(ir_graph *irg);
1113 * possible trvrfy() error codes
1115 enum trvrfy_error_codes {
1116 no_error = 0, /**< no error */
1117 error_ent_not_cont, /**< overwritten entity not in superclass */
1118 error_null_mem, /**< compound contains NULL member */
1119 error_const_on_wrong_irg, /**< constant placed on wrong IRG */
1120 error_existent_entity_without_irg, /**< Method entities with pecularity_exist must have an irg */
1121 error_wrong_ent_overwrites, /**< number of entity overwrites exceeds number of class overwrites */
1122 error_inherited_ent_without_const, /**< inherited method entity not pointing to existent entity */
1123 error_glob_ent_allocation, /**< wrong allocation of a global entity */
1124 error_ent_const_mode, /**< Mode of constant in entity did not match entities type. */
1125 error_ent_wrong_owner /**< Mode of constant in entity did not match entities type. */
1132 * 0 if no error encountered
1134 int check_type(ir_type *tp);
1137 * Check an entity. Currently, we check only if initialized constants
1138 * are build on the const irg graph.
1141 * 0 if no error encountered
1142 * != 0 a trvrfy_error_codes code
1144 int check_entity(ir_entity *ent);
1147 * Walks the type information and performs a set of sanity checks.
1149 * Currently, the following checks are executed:
1150 * - values of initialized entities must be allocated on the constant IRG
1151 * - class types: doesn't have NULL members
1152 * - class types: all overwrites are existent in the super type
1155 * 0 if graph is correct
1161 * If NDEBUG is defined performs nothing, else calls the tr_vrfy() function.
1166 #define TR_VRFY() tr_vrfy()
1172 * This module supplies routines that support changing the type graph.
1175 /** Replaces one type by the other.
1177 * Old type is replaced by new_type. All references to old_type
1178 * now point to new_type. The memory for the old type is destroyed,
1179 * but still used. Therefore it is not freed.
1180 * All referenced to this memory will be lost after a certain while.
1181 * An exception is the list of types in irp (irprog.h).
1182 * In the future there might be a routine to recover the memory, but
1183 * this will be at considerable runtime cost.
1185 * @param old_type - The old type that shall be replaced by the new type.
1186 * @param new_type - The new type that will replace old_type.
1189 void exchange_types(ir_type *old_type, ir_type *new_type);
1191 /** Skip id types until a useful type is reached.
1193 * @param tp - A type of arbitrary kind.
1196 * tp if it is not an id type.
1197 * If tp is an id type returns the real type it stands for.
1199 ir_type *skip_tid(ir_type *tp);
1202 * @page type representation of types
1204 * Datastructure to hold type information.
1206 * This module supplies a datastructure to represent all types
1207 * known in the compiled program. This includes types specified
1208 * in the program as well as types defined by the language. In the
1209 * view of the intermediate representation there is no difference
1210 * between these types. Finally it specifies some auxiliary types.
1212 * There exist several kinds of types, arranged by the structure of
1213 * the type. A type is described by a set of attributes. Some of
1214 * these attributes are common to all types, others depend on the
1217 * Types are different from the modes defined in irmode: Types are
1218 * on the level of the programming language, modes at the level of
1219 * the target processor.
1224 #include "typerep.h"
1226 /** Frees all entities associated with a type.
1227 * Does not free the array entity.
1228 * Warning: ensure these entities are not referenced anywhere else.
1230 void free_type_entities(ir_type *tp);
1232 /** Frees the memory used by the type.
1234 * Removes the type from the type list. Does not free the entities
1235 * belonging to the type, except for the array element entity. Does
1236 * not free if tp is "none" or "unknown". Frees entities in value
1237 * param subtypes of method types!!! Make sure these are not
1238 * referenced any more. Further make sure there is no pointer type
1239 * that refers to this type. */
1240 void free_type(ir_type *tp);
1242 const tp_op *get_type_tpop(const ir_type *tp);
1243 ident *get_type_tpop_nameid(const ir_type *tp);
1244 const char *get_type_tpop_name(const ir_type *tp);
1245 tp_opcode get_type_tpop_code(const ir_type *tp);
1247 ident *get_type_ident(const ir_type *tp);
1248 void set_type_ident(ir_type *tp, ident* id);
1249 const char *get_type_name(const ir_type *tp);
1251 /** The visibility of a type.
1253 * The visibility of a type indicates, whether entities of this type
1254 * are accessed or allocated in external code.
1256 * An entity of a type is allocated in external code, if the external
1257 * code declares a variable of this type, or dynamically allocates
1258 * an entity of this type. If the external code declares a (compound)
1259 * type, that contains entities of this type, the visibility also
1260 * must be external_allocated.
1262 * The visibility must be higher than that of all entities, if the
1263 * type is a compound. Here it is questionable, what happens with
1264 * static entities. If these are accessed external by direct reference,
1265 * (a static call to a method, that is also in the dispatch table)
1266 * it should not affect the visibility of the type.
1269 * @@@ Do we need a visibility for types?
1270 * I change the layout of types radically when doing type splitting.
1271 * I need to know, which fields of classes are accessed in the RTS,
1272 * e.g., [_length. I may not move [_length to the split part.
1273 * The layout though, is a property of the type.
1275 * One could also think of changing the mode of a type ...
1277 * But, we could also output macros to access the fields, e.g.,
1278 * ACCESS_[_length (X) X->length // conventional
1279 * ACCESS_[_length (X) X->_split_ref->length // with type splitting
1281 * For now I implement this function, that returns the visibility
1282 * based on the visibility of the entities of a compound ...
1284 * This function returns visibility_external_visible if one or more
1285 * entities of a compound type have visibility_external_visible.
1286 * Entities of types are never visibility_external_allocated (right?).
1287 * Else returns visibility_local.
1289 ir_visibility get_type_visibility(const ir_type *tp);
1290 void set_type_visibility(ir_type *tp, ir_visibility v);
1294 /** The state of the type layout. */
1296 layout_undefined, /**< The layout of this type is not defined.
1297 Address computation to access fields is not
1298 possible, fields must be accessed by Sel
1299 nodes. Enumeration constants might be undefined.
1300 This is the default value except for
1301 pointer, primitive and method types. */
1302 layout_fixed /**< The layout is fixed, all component/member entities
1303 have an offset assigned. Size of the type is known.
1304 Arrays can be accessed by explicit address
1305 computation. Enumeration constants must be defined.
1306 Default for pointer, primitive and method types. */
1309 /** Returns a human readable string for the enum entry. */
1310 const char *get_type_state_name(ir_type_state s);
1312 /** Returns the type layout state of a type. */
1313 ir_type_state get_type_state(const ir_type *tp);
1315 /** Sets the type layout state of a type.
1317 * For primitives, pointer and method types the layout is always fixed.
1318 * This call is legal but has no effect.
1320 void set_type_state(ir_type *tp, ir_type_state state);
1322 /** Returns the mode of a type.
1324 * Returns NULL for all non atomic types.
1326 ir_mode *get_type_mode(const ir_type *tp);
1328 /** Sets the mode of a type.
1330 * Only has an effect on primitive, enumeration and pointer types.
1332 void set_type_mode(ir_type *tp, ir_mode* m);
1334 /** Returns the size of a type in bytes, returns -1 if the size is NOT
1335 * a byte size, i.e. not dividable by 8. */
1336 int get_type_size_bytes(const ir_type *tp);
1338 /** Returns the size of a type in bits. */
1339 int get_type_size_bits(const ir_type *tp);
1341 /** Sets the size of a type in bytes.
1343 * For primitive, enumeration, pointer and method types the size
1344 * is always fixed. This call is legal but has no effect.
1346 void set_type_size_bytes(ir_type *tp, int size);
1348 /** Sets the size of a type in bits.
1350 * For primitive, enumeration, pointer and method types the size
1351 * is always fixed. This call is legal but has no effect.
1353 void set_type_size_bits(ir_type *tp, int size);
1355 /** Returns the alignment of a type in bytes.
1357 * Returns -1 if the alignment is NOT
1358 * a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
1359 int get_type_alignment_bytes(ir_type *tp);
1361 /** Returns the alignment of a type in bits.
1363 * If the alignment of a type is
1364 * not set, it is calculated here according to the following rules:
1365 * -#.) if a type has a mode, the alignment is the mode size.
1366 * -#.) compound types have the alignment of there biggest member.
1367 * -#.) array types have the alignment of there element type.
1368 * -#.) method types return 0 here.
1369 * -#.) all other types return 8 here (i.e. aligned at byte).
1371 int get_type_alignment_bits(ir_type *tp);
1373 /** Sets the alignment of a type in bytes. */
1374 void set_type_alignment_bytes(ir_type *tp, int size);
1376 /** Sets the alignment of a type in bits.
1378 * For method types the alignment is always fixed.
1379 * This call is legal but has no effect.
1381 void set_type_alignment_bits(ir_type *tp, int size);
1383 /** Returns the visited count of a type. */
1384 unsigned long get_type_visited(const ir_type *tp);
1385 /** Sets the visited count of a type to num. */
1386 void set_type_visited(ir_type *tp, unsigned long num);
1387 /** Sets visited field in type to type_visited. */
1388 void mark_type_visited(ir_type *tp);
1389 /** Returns non-zero if the type is already visited */
1390 int type_visited(const ir_type *tp);
1391 /** Returns non-zero if the type is not yet visited */
1392 int type_not_visited(const ir_type *tp);
1394 /** Returns the associated link field of a type. */
1395 void *get_type_link(const ir_type *tp);
1396 /** Sets the associated link field of a type. */
1397 void set_type_link(ir_type *tp, void *l);
1400 * Visited flag to traverse the type information.
1402 * Increase this flag by one before traversing the type information
1403 * using inc_master_type_visited().
1404 * Mark type nodes as visited by mark_type_visited(ir_type).
1405 * Check whether node was already visited by type_visited(ir_type)
1406 * and type_not_visited(ir_type).
1407 * Or use the function to walk all types.
1411 void set_master_type_visited(unsigned long val);
1412 unsigned long get_master_type_visited(void);
1413 void inc_master_type_visited(void);
1416 * Sets the debug information of a type.
1418 * @param tp The type.
1419 * @param db The debug info.
1421 void set_type_dbg_info(ir_type *tp, dbg_info *db);
1424 * Returns the debug information of a type.
1426 * @param tp The type.
1428 dbg_info *get_type_dbg_info(const ir_type *tp);
1431 * Checks whether a pointer points to a type.
1433 * @param thing an arbitrary pointer
1436 * true if the thing is a type, else false
1438 int is_type(const void *thing);
1441 * Checks whether two types are structurally equal.
1443 * @param typ1 the first type
1444 * @param typ2 the second type
1447 * true if the types are equal, else false.
1449 * Types are equal if :
1450 * - they are the same type kind
1451 * - they have the same name
1452 * - they have the same mode (if applicable)
1453 * - they have the same type_state and, ev., the same size
1454 * - they are class types and have:
1455 * - the same members (see same_entity in entity.h)
1456 * - the same supertypes -- the C-pointers are compared --> no recursive call.
1457 * - the same number of subtypes. Subtypes are not compared,
1458 * as this could cause a cyclic test.
1459 * - the same peculiarity
1460 * - they are structure types and have the same members
1461 * - they are method types and have
1462 * - the same parameter types
1463 * - the same result types
1464 * - they are union types and have the same members
1465 * - they are array types and have
1466 * - the same number of dimensions
1467 * - the same dimension bounds
1468 * - the same dimension order
1469 * - the same element type
1470 * - they are enumeration types and have the same enumerator names
1471 * - they are pointer types and have the identical points_to type
1472 * (i.e., the same C-struct to represent the type, type_id is skipped.
1473 * This is to avoid endless recursions; with pointer types cyclic
1474 * type graphs are possible.)
1476 int equal_type(ir_type *typ1, ir_type *typ2);
1479 * Checks whether two types are structural comparable.
1481 * @param st pointer type
1482 * @param lt pointer type
1485 * true if type st is smaller than type lt, i.e. whenever
1486 * lt is expected a st can be used.
1488 * - they are the same type kind
1489 * - mode(st) < mode (lt) (if applicable)
1490 * - they are class types and st is (transitive) subtype of lt,
1491 * - they are structure types and
1492 * - the members of st have exactly one counterpart in lt with the same name,
1493 * - the counterpart has a bigger type.
1494 * - they are method types and have
1495 * - the same number of parameter and result types,
1496 * - the parameter types of st are smaller than those of lt,
1497 * - the result types of st are smaller than those of lt
1498 * - they are union types and have the members of st have exactly one
1499 * @return counterpart in lt and the type is smaller
1500 * - they are array types and have
1501 * - the same number of dimensions
1502 * - all bounds of lt are bound of st
1503 * - the same dimension order
1504 * - the same element type
1506 * - the element type of st is smaller than that of lt
1507 * - the element types have the same size and fixed layout.
1508 * - they are enumeration types and have the same enumerator names
1509 * - they are pointer types and have the points_to type of st is
1510 * @return smaller than the points_to type of lt.
1513 int smaller_type(ir_type *st, ir_type *lt);
1516 * @page class_type Representation of a class type
1518 * If the type opcode is set to type_class the type represents class
1519 * types. A list of fields and methods is associated with a class.
1520 * Further a class can inherit from and bequest to other classes.
1522 * The following attributes are private to this type kind:
1523 * - member: All entities belonging to this class. This are method entities
1524 * which have type_method or fields that can have any of the
1525 * following type kinds: type_class, type_struct, type_union,
1526 * type_array, type_enumeration, type_pointer, type_primitive.
1528 * The following two are dynamic lists that can be grown with an "add_" function,
1531 * - subtypes: A list of direct subclasses.
1533 * - supertypes: A list of direct superclasses.
1535 * - peculiarity: The peculiarity of this class. If the class is of peculiarity
1536 * "description" it only is a description of requirements to a class,
1537 * as, e.g., a Java interface. The class will never be allocated.
1538 * Peculiarity inherited is only possible for entities. An entity
1539 * is of peculiarity inherited if the compiler generated the entity
1540 * to explicitly resolve inheritance. An inherited method entity has
1542 * Values: description, existent, inherited. Default: existent.
1544 * - type_info: An entity representing the type information of this class.
1545 * This entity can be of arbitrari type, Firm did not use it yet.
1546 * It allows to express the coupling of a type with an entity
1547 * representing this type. This information is useful for lowering
1548 * of InstOf and TypeChk nodes. Default: NULL
1550 * - vtable_size: The size of this class virtual function table.
1553 * - final: A final class is always a leaf in the class hierarchy. Final
1554 * classes cannot be super classes of other ones. As this information
1555 * can only be computed in whole world compilations, we allow to
1556 * set this flag. It is used in optimizations if get_opt_closed_world()
1557 * is false. Default: false
1559 * - interface: The class represents an interface. This flag can be set to distinguish
1560 * between interfaces, abstract classes and other classes that all may
1561 * have the peculiarity peculiarity_description. Depending on this flag
1562 * the lowering might do different actions. Default: false
1564 * - abstract : The class represents an abstract class. This flag can be set to distinguish
1565 * between interfaces, abstract classes and other classes that all may
1566 * have the peculiarity peculiarity_description. Depending on this flag
1567 * the lowering might do different actions. Default: false
1570 /** Creates a new class type. */
1571 ir_type *new_type_class(ident *name);
1573 /** Creates a new class type with debug information. */
1574 ir_type *new_d_type_class(ident *name, dbg_info *db);
1576 /* --- manipulate private fields of class type --- */
1578 /** Adds the entity as member of the class. */
1579 void add_class_member(ir_type *clss, ir_entity *member);
1581 /** Returns the number of members of this class. */
1582 int get_class_n_members(const ir_type *clss);
1584 /** Returns the member at position pos, 0 <= pos < n_member */
1585 ir_entity *get_class_member(const ir_type *clss, int pos);
1587 /** Returns index of mem in clss, -1 if not contained. */
1588 int get_class_member_index(const ir_type *clss, ir_entity *mem);
1590 /** Finds the member with name 'name'. If several members with the same
1591 * name returns one of them. Returns NULL if no member found. */
1592 ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
1594 /** Overwrites the member at position pos, 0 <= pos < n_member with
1595 * the passed entity. */
1596 void set_class_member(ir_type *clss, ir_entity *member, int pos);
1598 /** Replaces complete member list in class type by the list passed.
1600 * Copies the list passed. This function is necessary to reduce the number of members.
1601 * members is an array of entities, num the size of this array. Sets all
1602 * owners of the members passed to clss. */
1603 void set_class_members(ir_type *clss, ir_entity *members[], int arity);
1605 /** Finds member in the list of members and removes it.
1607 * Shrinks the member list, so iterate from the end!!!
1608 * Does not deallocate the entity. */
1609 void remove_class_member(ir_type *clss, ir_entity *member);
1612 /** Adds subtype as subtype to clss.
1614 * Checks whether clss is a supertype of subtype. If not
1615 * adds also clss as supertype to subtype. */
1616 void add_class_subtype(ir_type *clss, ir_type *subtype);
1618 /** Returns the number of subtypes */
1619 int get_class_n_subtypes(const ir_type *clss);
1621 /** Gets the subtype at position pos, 0 <= pos < n_subtype. */
1622 ir_type *get_class_subtype(ir_type *clss, int pos);
1624 /** Returns the index to access subclass as subtype of class.
1626 * If subclass is no direct subtype of class returns -1.
1628 int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
1630 /** Sets the subtype at position pos, 0 <= pos < n_subtype.
1632 * Does not set the corresponding supertype relation for subtype: this might
1633 * be a different position! */
1634 void set_class_subtype(ir_type *clss, ir_type *subtype, int pos);
1636 /** Finds subtype in the list of subtypes and removes it */
1637 void remove_class_subtype(ir_type *clss, ir_type *subtype);
1639 /* Convenience macros */
1640 #define add_class_derived_type(clss, drvtype) add_class_subtype(clss, drvtype)
1641 #define get_class_n_derived_types(clss) get_class_n_subtypes(clss)
1642 #define get_class_derived_type(clss, pos) get_class_subtype(clss, pos)
1643 #define get_class_derived_type_index(clss, drvtype) get_class_subtype_index(clss, drvtype)
1644 #define set_class_derived_type(clss, drvtype, pos) set_class_subtype(clss, drvtype, pos)
1645 #define remove_class_derived_type(clss, drvtype) remove_class_subtype(clss, drvtype)
1647 /** Adds supertype as supertype to class.
1649 * Checks whether clss is a subtype of supertype. If not
1650 * adds also clss as subtype to supertype. */
1651 void add_class_supertype(ir_type *clss, ir_type *supertype);
1653 /** Returns the number of supertypes */
1654 int get_class_n_supertypes(const ir_type *clss);
1656 /** Returns the index to access superclass as supertype of class.
1658 * If superclass is no direct supertype of class returns -1.
1660 int get_class_supertype_index(ir_type *clss, ir_type *super_clss);
1662 /** Gets the supertype at position pos, 0 <= pos < n_supertype. */
1663 ir_type *get_class_supertype(ir_type *clss, int pos);
1665 /** Sets the supertype at position pos, 0 <= pos < n_supertype.
1667 * Does not set the corresponding subtype relation for supertype: this might
1668 * be at a different position! */
1669 void set_class_supertype(ir_type *clss, ir_type *supertype, int pos);
1671 /** Finds supertype in the list of supertypes and removes it */
1672 void remove_class_supertype(ir_type *clss, ir_type *supertype);
1674 /** Convenience macro */
1675 #define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
1676 #define get_class_n_base_types(clss) get_class_n_supertypes(clss)
1677 #define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
1678 #define get_class_base_type(clss, pos) get_class_supertype(clss, pos)
1679 #define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
1680 #define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
1682 /** Convenience macro */
1683 #define add_class_base_type(clss, basetype) add_class_supertype(clss, basetype)
1684 #define get_class_n_base_types(clss) get_class_n_supertypes(clss)
1685 #define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
1686 #define get_class_base_type(clss, pos) get_class_supertype(clss, pos)
1687 #define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
1688 #define remove_class_base_type(clss, basetype) remove_class_supertype(clss, basetype)
1690 /** Returns a human readable string for a peculiarity. */
1691 const char *get_peculiarity_name(ir_peculiarity p);
1693 /** Returns the peculiarity of the class. */
1694 ir_peculiarity get_class_peculiarity(const ir_type *clss);
1695 /** Sets the peculiarity of the class. */
1696 void set_class_peculiarity(ir_type *clss, ir_peculiarity pec);
1698 /** Returns the type info entity of a class. */
1699 ir_entity *get_class_type_info(const ir_type *clss);
1701 /** Set a type info entity for the class. */
1702 void set_class_type_info(ir_type *clss, ir_entity *ent);
1704 /** Returns the size of the virtual function table. */
1705 unsigned get_class_vtable_size(const ir_type *clss);
1707 /** Sets a new size of the virtual function table. */
1708 void set_class_vtable_size(ir_type *clss, unsigned size);
1710 /** Returns non-zero if a class is final. */
1711 int is_class_final(const ir_type *clss);
1713 /** Sets the class final flag. */
1714 void set_class_final(ir_type *clss, int flag);
1716 /** Return non-zero if a class is an interface */
1717 int is_class_interface(const ir_type *clss);
1719 /** Sets the class interface flag. */
1720 void set_class_interface(ir_type *clss, int flag);
1722 /** Return non-zero if a class is an abstract class. */
1723 int is_class_abstract(const ir_type *clss);
1725 /** Sets the class abstract flag. */
1726 void set_class_abstract(ir_type *clss, int flag);
1728 /** Set and get a class' dfn --
1729 @todo This is an undocumented field, subject to change! */
1730 void set_class_dfn(ir_type *clss, int dfn);
1731 int get_class_dfn(const ir_type *clss);
1733 /** Returns true if a type is a class type. */
1734 int is_Class_type(const ir_type *clss);
1737 * @page struct_type Representation of a struct type
1739 * A struct type represents aggregate types that consist of a list
1742 * The following attributes are private to this type kind:
1743 * - member: All entities belonging to this class. This are the fields
1744 * that can have any of the following types: type_class,
1745 * type_struct, type_union, type_array, type_enumeration,
1746 * type_pointer, type_primitive.
1747 * This is a dynamic list that can be grown with an "add_" function,
1749 * This is a dynamic list that can be grown with an "add_" function,
1752 /** Creates a new type struct */
1753 ir_type *new_type_struct(ident *name);
1754 /** Creates a new type struct with debug information. */
1755 ir_type *new_d_type_struct(ident *name, dbg_info* db);
1757 /* --- manipulate private fields of struct --- */
1759 /** Adds the entity as member of the struct. */
1760 void add_struct_member(ir_type *strct, ir_entity *member);
1762 /** Returns the number of members of this struct. */
1763 int get_struct_n_members(const ir_type *strct);
1765 /** Returns the member at position pos, 0 <= pos < n_member */
1766 ir_entity *get_struct_member(const ir_type *strct, int pos);
1768 /** Returns index of member in strct, -1 if not contained. */
1769 int get_struct_member_index(const ir_type *strct, ir_entity *member);
1771 /** Overwrites the member at position pos, 0 <= pos < n_member with
1772 the passed entity. */
1773 void set_struct_member(ir_type *strct, int pos, ir_entity *member);
1775 /** Finds member in the list of members and removes it. */
1776 void remove_struct_member(ir_type *strct, ir_entity *member);
1778 /** Returns true if a type is a struct type. */
1779 int is_Struct_type(const ir_type *strct);
1782 * @page method_type Representation of a method type
1784 * A method type represents a method, function or procedure type.
1785 * It contains a list of the parameter and result types, as these
1786 * are part of the type description. These lists should not
1787 * be changed by a optimization, as a change creates a new method
1788 * type. Therefore optimizations should allocated new method types.
1789 * The set_ routines are only for construction by a frontend.
1791 * - n_params: Number of parameters to the procedure.
1792 * A procedure in FIRM has only call by value parameters.
1794 * - param_type: A list with the types of parameters. This list is ordered.
1795 * The nth type in this list corresponds to the nth element
1796 * in the parameter tuple that is a result of the start node.
1797 * (See ircons.h for more information.)
1799 * - value_param_ents
1800 * A list of entities (whose owner is a struct private to the
1801 * method type) that represent parameters passed by value.
1803 * - n_res: The number of results of the method. In general, procedures
1804 * have zero results, functions one.
1806 * - res_type: A list with the types of parameters. This list is ordered.
1807 * The nth type in this list corresponds to the nth input to
1808 * Return nodes. (See ircons.h for more information.)
1811 * A list of entities (whose owner is a struct private to the
1812 * method type) that represent results passed by value.
1815 /* These macros define the suffixes for the types and entities used
1816 to represent value parameters / results. */
1817 #define VALUE_PARAMS_SUFFIX "val_param"
1818 #define VALUE_RESS_SUFFIX "val_res"
1820 /** Create a new method type.
1822 * @param name the name (ident) of this type
1823 * @param n_param the number of parameters
1824 * @param n_res the number of results
1826 * The arrays for the parameter and result types are not initialized by
1829 ir_type *new_type_method(ident *name, int n_param, int n_res);
1831 /** Create a new method type with debug information.
1833 * @param name the name (ident) of this type
1834 * @param n_param the number of parameters
1835 * @param n_res the number of results
1836 * @param db user defined debug information
1838 * The arrays for the parameter and result types are not initialized by
1841 ir_type *new_d_type_method(ident *name, int n_param, int n_res, dbg_info* db);
1843 /* -- manipulate private fields of method. -- */
1845 /** Returns the number of parameters of this method. */
1846 int get_method_n_params(const ir_type *method);
1848 /** Returns the type of the parameter at position pos of a method. */
1849 ir_type *get_method_param_type(ir_type *method, int pos);
1850 /** Sets the type of the parameter at position pos of a method.
1851 Also changes the type in the pass-by-value representation by just
1852 changing the type of the corresponding entity if the representation is constructed. */
1853 void set_method_param_type(ir_type *method, int pos, ir_type *tp);
1854 /** Returns an entity that represents the copied value argument. Only necessary
1855 for compounds passed by value. This information is constructed only on demand. */
1856 ir_entity *get_method_value_param_ent(ir_type *method, int pos);
1858 * Returns a type that represents the copied value arguments if one
1859 * was allocated, else NULL.
1861 ir_type *get_method_value_param_type(const ir_type *method);
1862 /** Returns an ident representing the parameters name. Returns NULL if not set.
1863 For debug support only. */
1864 ident *get_method_param_ident(ir_type *method, int pos);
1865 /** Returns a string representing the parameters name. Returns NULL if not set.
1866 For debug support only. */
1867 const char *get_method_param_name(ir_type *method, int pos);
1868 /** Sets an ident representing the parameters name. For debug support only. */
1869 void set_method_param_ident(ir_type *method, int pos, ident *id);
1871 /** Returns the number of results of a method type. */
1872 int get_method_n_ress(const ir_type *method);
1873 /** Returns the return type of a method type at position pos. */
1874 ir_type *get_method_res_type(ir_type *method, int pos);
1875 /** Sets the type of the result at position pos of a method.
1876 Also changes the type in the pass-by-value representation by just
1877 changing the type of the corresponding entity if the representation is constructed. */
1878 void set_method_res_type(ir_type *method, int pos, ir_type *tp);
1879 /** Returns an entity that represents the copied value result. Only necessary
1880 for compounds passed by value. This information is constructed only on demand. */
1881 ir_entity *get_method_value_res_ent(ir_type *method, int pos);
1884 * Returns a type that represents the copied value results.
1886 ir_type *get_method_value_res_type(const ir_type *method);
1889 * This enum flags the variadicity of methods (methods with a
1890 * variable amount of arguments (e.g. C's printf). Default is
1893 typedef enum variadicity {
1894 variadicity_non_variadic, /**< non variadic */
1895 variadicity_variadic /**< variadic */
1898 /** Returns the null-terminated name of this variadicity. */
1899 const char *get_variadicity_name(variadicity vari);
1901 /** Returns the variadicity of a method. */
1902 variadicity get_method_variadicity(const ir_type *method);
1904 /** Sets the variadicity of a method. */
1905 void set_method_variadicity(ir_type *method, variadicity vari);
1908 * Returns the first variadic parameter index of a type.
1909 * If this index was NOT set, the index of the last parameter
1910 * of the method type plus one is returned for variadic functions.
1911 * Non-variadic function types always return -1 here.
1913 int get_method_first_variadic_param_index(const ir_type *method);
1916 * Sets the first variadic parameter index. This allows to specify
1917 * a complete call type (containing the type of all parameters)
1918 * but still have the knowledge, which parameter must be passed as
1921 void set_method_first_variadic_param_index(ir_type *method, int index);
1923 /** Returns the mask of the additional graph properties. */
1924 unsigned get_method_additional_properties(const ir_type *method);
1926 /** Sets the mask of the additional graph properties. */
1927 void set_method_additional_properties(ir_type *method, unsigned property_mask);
1929 /** Sets one additional graph property. */
1930 void set_method_additional_property(ir_type *method, mtp_additional_property flag);
1933 * Calling conventions: lower 24 bits are the number of register parameters,
1934 * upper 8 encode the calling conventions.
1937 cc_reg_param = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
1938 This flag may be set as default on some architectures. */
1939 cc_last_on_top = 0x02000000, /**< The last non-register parameter is transmitted on top of
1940 the stack. This is equivalent to the pascal
1941 calling convention. If this flag is not set, the first
1942 non-register parameter is used (stdcall or cdecl
1943 calling convention) */
1944 cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
1945 function calls (stdcall). */
1946 cc_this_call = 0x08000000, /**< The first parameter is a this pointer and is transmitted
1947 in a special way. */
1948 cc_compound_ret = 0x10000000, /**< the method returns a compound
1951 cc_bits = (0xFF << 24) /**< the calling convention bits */
1952 } calling_convention;
1954 /* some often used cases: made as defines because firmjni cannot handle two
1955 equal enum values. */
1957 /** cdecl calling convention */
1958 #define cc_cdecl_set (0)
1959 /** stdcall calling convention */
1960 #define cc_stdcall_set cc_callee_clear_stk
1961 /** fastcall calling convention */
1962 #define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)
1964 /** Returns the default calling convention for method types. */
1965 unsigned get_default_cc_mask(void);
1968 * check for the CDECL calling convention
1970 #define IS_CDECL(cc_mask) (((cc_mask) & cc_bits) == cc_cdecl_set)
1973 * check for the STDCALL calling convention
1975 #define IS_STDCALL(cc_mask) (((cc_mask) & cc_bits) == cc_stdcall_set)
1978 * check for the FASTCALL calling convention
1980 #define IS_FASTCALL(cc_mask) (((cc_mask) & cc_bits) == cc_fastcall_set)
1983 * Sets the CDECL convention bits.
1985 #define SET_CDECL(cc_mask) (((cc_mask) & ~cc_bits) | cc_cdecl_set)
1988 * Set. the STDCALL convention bits.
1990 #define SET_STDCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_stdcall_set)
1993 * Sets the FASTCALL convention bits.
1995 #define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
1997 /** Returns the calling convention of an entities graph. */
1998 unsigned get_method_calling_convention(const ir_type *method);
2000 /** Sets the calling convention of an entities graph. */
2001 void set_method_calling_convention(ir_type *method, unsigned cc_mask);
2003 /** Returns the number of registers parameters, 0 means default. */
2004 unsigned get_method_n_regparams(ir_type *method);
2006 /** Sets the number of registers parameters, 0 means default. */
2007 void set_method_n_regparams(ir_type *method, unsigned n_regs);
2009 /** Returns true if a type is a method type. */
2010 int is_Method_type(const ir_type *method);
2013 * @page union_type Representation of a union (variant) type.
2015 * The union type represents union types. Note that this representation
2016 * resembles the C union type. For tagged variant types like in Pascal or Modula
2017 * a combination of a struct and a union type must be used.
2019 * - n_types: Number of unioned types.
2020 * - members: Entities for unioned types. Fixed length array.
2021 * This is a dynamic list that can be grown with an "add_" function,
2024 /** Creates a new type union. */
2025 ir_type *new_type_union(ident *name);
2027 /** Creates a new type union with debug information. */
2028 ir_type *new_d_type_union(ident *name, dbg_info* db);
2030 /* --- manipulate private fields of struct --- */
2032 /** Returns the number of unioned types of this union */
2033 int get_union_n_members(const ir_type *uni);
2035 /** Adds a new entity to a union type */
2036 void add_union_member(ir_type *uni, ir_entity *member);
2038 /** Returns the entity at position pos of a union */
2039 ir_entity *get_union_member(const ir_type *uni, int pos);
2041 /** Returns index of member in uni, -1 if not contained. */
2042 int get_union_member_index(const ir_type *uni, ir_entity *member);
2044 /** Overwrites a entity at position pos in a union type. */
2045 void set_union_member(ir_type *uni, int pos, ir_entity *member);
2047 /** Finds member in the list of members and removes it. */
2048 void remove_union_member(ir_type *uni, ir_entity *member);
2050 /** Returns true if a type is a union type. */
2051 int is_Union_type(const ir_type *uni);
2054 * @page array_type Representation of an array type
2056 * The array type represents rectangular multi dimensional arrays.
2057 * The constants representing the bounds must be allocated to
2058 * get_const_code_irg() by setting current_ir_graph accordingly.
2060 * - n_dimensions: Number of array dimensions.
2061 * - *lower_bound: Lower bounds of dimensions. Usually all 0.
2062 * - *upper_bound: Upper bounds or dimensions.
2063 * - *element_type: The type of the array elements.
2064 * - *element_ent: An entity for the array elements to be used for
2065 * element selection with Sel.
2067 * Do we need several entities? One might want
2068 * to select a dimension and not a single element in case of multi
2069 * dimensional arrays.
2072 /** Create a new type array.
2074 * Sets n_dimension to dimension and all dimension entries to NULL.
2075 * Initializes order to the order of the dimensions.
2076 * The entity for array elements is built automatically.
2077 * Set dimension sizes after call to constructor with set_* routines.
2079 ir_type *new_type_array(ident *name, int n_dims, ir_type *element_type);
2081 /** Create a new type array with debug information.
2083 * Sets n_dimension to dimension and all dimension entries to NULL.
2084 * Initializes order to the order of the dimensions.
2085 * The entity for array elements is built automatically.
2086 * Set dimension sizes after call to constructor with set_* routines.
2087 * A legal array type must have at least one dimension set.
2089 ir_type *new_d_type_array(ident *name, int n_dims, ir_type *element_type, dbg_info* db);
2091 /* --- manipulate private fields of array type --- */
2093 /** Returns the number of array dimensions of this type. */
2094 int get_array_n_dimensions(const ir_type *array);
2097 * Allocates Const nodes of mode_Is for one array dimension.
2098 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
2100 void set_array_bounds_int(ir_type *array, int dimension, int lower_bound,
2103 * Sets the bounds for one array dimension.
2104 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
2106 void set_array_bounds(ir_type *array, int dimension, ir_node *lower_bound,
2107 ir_node *upper_bound);
2108 /** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
2109 void set_array_lower_bound(ir_type *array, int dimension, ir_node *lower_bound);
2111 /** Allocates Const nodes of mode_Is for the lower bound of an array
2112 dimension, i.e. [lower,upper[ */
2113 void set_array_lower_bound_int(ir_type *array, int dimension, int lower_bound);
2115 /** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
2116 void set_array_upper_bound(ir_type *array, int dimension, ir_node *upper_bound);
2118 /** Allocates Const nodes of mode_Is for the upper bound of an array
2119 dimension, i.e. [lower,upper[. */
2120 void set_array_upper_bound_int(ir_type *array, int dimension, int upper_bound);
2122 /** Returns true if lower bound != Unknown. */
2123 int has_array_lower_bound(const ir_type *array, int dimension);
2124 /** Returns the lower bound of an array. */
2125 ir_node *get_array_lower_bound(const ir_type *array, int dimension);
2126 /** Works only if bound is Const node with tarval that can be converted to long. */
2127 long get_array_lower_bound_int(const ir_type *array, int dimension);
2128 /** returns true if lower bound != Unknown */
2129 int has_array_upper_bound(const ir_type *array, int dimension);
2130 /** Returns the upper bound of an array. */
2131 ir_node *get_array_upper_bound(const ir_type *array, int dimension);
2132 /** Works only if bound is Const node with tarval that can be converted to long. */
2133 long get_array_upper_bound_int(const ir_type *array, int dimension);
2135 /** Sets an array dimension to a specific order. */
2136 void set_array_order(ir_type *array, int dimension, int order);
2138 /** Returns the order of an array dimension. */
2139 int get_array_order(const ir_type *array, int dimension);
2141 /** Find the array dimension that is placed at order order. */
2142 int find_array_dimension(const ir_type *array, int order);
2144 /** Sets the array element type. */
2145 void set_array_element_type(ir_type *array, ir_type* tp);
2147 /** Gets the array element type. */
2148 ir_type *get_array_element_type(ir_type *array);
2150 /** Sets the array element entity. */
2151 void set_array_element_entity(ir_type *array, ir_entity *ent);
2153 /** Get the array element entity. */
2154 ir_entity *get_array_element_entity(const ir_type *array);
2156 /** Returns true if a type is an array type. */
2157 int is_Array_type(const ir_type *array);
2160 * @page enumeration_type Representation of an enumeration type
2162 * Enumeration types need not necessarily be represented explicitly
2163 * by Firm types, as the frontend can lower them to integer constants as
2164 * well. For debugging purposes or similar tasks this information is useful.
2165 * The type state layout_fixed is set, if all enumeration constant have
2166 * there tarvals assigned. Until then
2168 * - *const: The target values representing the constants used to
2169 * represent individual enumerations.
2172 /** Create a new type enumeration -- set the enumerators independently. */
2173 ir_type *new_type_enumeration(ident *name, int n_enums);
2175 /** Create a new type enumeration with debug information -- set the enumerators independently. */
2176 ir_type *new_d_type_enumeration(ident *name, int n_enums, dbg_info *db);
2178 /* --- manipulate fields of enumeration type. --- */
2180 /** Set an enumeration constant to a enumeration type at a given position. */
2181 void set_enumeration_const(ir_type *enumeration, int pos, ident *nameid, tarval *con);
2183 /** Returns the number of enumeration values of this enumeration */
2184 int get_enumeration_n_enums(const ir_type *enumeration);
2186 /** Returns the enumeration constant at a given position. */
2187 ir_enum_const *get_enumeration_const(const ir_type *enumeration, int pos);
2189 /** Returns the enumeration type owner of an enumeration constant. */
2190 ir_type *get_enumeration_owner(const ir_enum_const *enum_cnst);
2192 /** Sets the enumeration constant value. */
2193 void set_enumeration_value(ir_enum_const *enum_cnst, tarval *con);
2195 /** Returns the enumeration constant value. */
2196 tarval *get_enumeration_value(const ir_enum_const *enum_cnst);
2198 /** Assign an ident to an enumeration constant. */
2199 void set_enumeration_nameid(ir_enum_const *enum_cnst, ident *id);
2201 /** Returns the assigned ident of an enumeration constant. */
2202 ident *get_enumeration_nameid(const ir_enum_const *enum_cnst);
2204 /** Returns the assigned name of an enumeration constant. */
2205 const char *get_enumeration_name(const ir_enum_const *enum_cnst);
2207 /** Returns true if a type is a enumeration type. */
2208 int is_Enumeration_type(const ir_type *enumeration);
2211 * @page pointer_type Representation of a pointer type
2213 * The mode of the pointer type must be a reference mode.
2216 * - points_to: The type of the entity this pointer points to.
2219 /** Creates a new type pointer. */
2220 ir_type *new_type_pointer(ident *name, ir_type *points_to, ir_mode *ptr_mode);
2222 /** Creates a new type pointer with debug information. */
2223 ir_type *new_d_type_pointer(ident *name, ir_type *points_to, ir_mode *ptr_mode, dbg_info* db);
2225 /* --- manipulate fields of type_pointer --- */
2227 /** Sets the type to which a pointer points to. */
2228 void set_pointer_points_to_type(ir_type *pointer, ir_type *tp);
2230 /** Returns the type to which a pointer points to. */
2231 ir_type *get_pointer_points_to_type(ir_type *pointer);
2233 /** Returns true if a type is a pointer type. */
2234 int is_Pointer_type(const ir_type *pointer);
2236 /** Returns the first pointer type that has as points_to tp.
2237 * Not efficient: O(#types).
2238 * If not found returns firm_unknown_type. */
2239 ir_type *find_pointer_type_to_type(ir_type *tp);
2242 * @page primitive_type Representation of a primitive type
2244 * Primitive types are types that represent atomic data values that
2245 * map directly to modes. They don't have private attributes. The
2246 * important information they carry is held in the common mode field.
2248 /** Creates a new primitive type. */
2249 ir_type *new_type_primitive(ident *name, ir_mode *mode);
2251 /** Creates a new primitive type with debug information. */
2252 ir_type *new_d_type_primitive(ident *name, ir_mode *mode, dbg_info* db);
2254 /** Returns true if a type is a primitive type. */
2255 int is_Primitive_type(const ir_type *primitive);
2257 /** Return the base type of a primitive (bitfield) type or NULL if none. */
2258 ir_type *get_primitive_base_type(ir_type *tp);
2260 /** Sets the base type of a primitive (bitfield) type. */
2261 void set_primitive_base_type(ir_type *tp, ir_type *base_tp);
2264 * @page none_type The None type
2266 * This type is an auxiliary type dedicated to support type analyses.
2268 * The none type represents that there is no type. The type can be used to
2269 * initialize fields of type* that actually can not contain a type or that
2270 * are initialized for an analysis. There exists exactly one type none.
2271 * This type is not on the type list in ir_prog. It is
2272 * allocated when initializing the type module.
2274 * The following values are set:
2276 * - name: "type_none"
2277 * - state: layout_fixed
2280 /** A variable that contains the only none type. */
2281 extern ir_type *firm_none_type;
2283 /** Returns the none type. */
2284 ir_type *get_none_type(void);
2287 * @page unknown_type The Unknown type
2289 * This type is an auxiliary type dedicated to support type analyses.
2291 * The unknown type represents that there could be a type, but it is not
2292 * known. This type can be used to initialize fields before an analysis (not known
2293 * yet) or to represent the top of a lattice (could not be determined). There exists
2294 * exactly one type unknown. This type is not on the type list in ir_prog. It is
2295 * allocated when initializing the type module.
2297 * The following values are set:
2299 * - name: "type_unknown"
2300 * - state: layout_fixed
2303 /** A variable that contains the only unknown type. */
2304 extern ir_type *firm_unknown_type;
2306 /** Returns the unknown type. */
2307 ir_type *get_unknown_type(void);
2311 * Checks whether a type is atomic.
2312 * @param tp any type
2313 * @return true if type is primitive, pointer or enumeration
2315 int is_atomic_type(const ir_type *tp);
2317 /* --- Support for compound types --- */
2320 * Gets the number of elements in a Firm compound type.
2322 * This is just a comfortability function, because structs and
2323 * classes can often be treated be the same code, but they have
2324 * different access functions to their members.
2326 * @param tp The type (must be struct, union or class).
2328 * @return Number of members in the compound type.
2330 int get_compound_n_members(const ir_type *tp);
2333 * Gets the member of a Firm compound type at position pos.
2335 * @param tp The type (must be struct, union or class).
2336 * @param pos The number of the member.
2338 * @return The member entity at position pos.
2340 * @see get_compound_n_members() for justification of existence.
2342 ir_entity *get_compound_member(const ir_type *tp, int pos);
2344 /** Returns index of member in tp, -1 if not contained. */
2345 int get_compound_member_index(const ir_type *tp, ir_entity *member);
2348 * Checks whether a type is a compound type.
2350 * @param tp - any type
2352 * @return true if the type is class, structure, union or array type.
2354 int is_compound_type(const ir_type *tp);
2357 * Checks, whether a type is a frame type.
2359 int is_frame_type(const ir_type *tp);
2362 * Checks, whether a type is a value parameter type.
2364 int is_value_param_type(const ir_type *tp);
2367 * Checks, whether a type is a lowered type.
2369 int is_lowered_type(const ir_type *tp);
2372 * Makes a new frame type. Frame types are class types,
2373 * so all class access functions work.
2374 * Frame types are not in the global list of types.
2376 ir_type *new_type_frame(ident *name);
2379 * Sets a lowered type for a type. This sets both associations
2380 * and marks lowered_type as a "lowered" one.
2382 void set_lowered_type(ir_type *tp, ir_type *lowered_type);
2385 * Gets the lowered/unlowered type of a type or NULL if this type
2386 * has no lowered/unlowered one.
2388 ir_type *get_associated_type(const ir_type *tp);
2391 * Allocate an area of size bytes aligned at alignment
2392 * at the start or the end of a frame type.
2393 * The frame type must already have a fixed layout.
2395 * @param frame_type a frame type
2396 * @param size the size of the entity
2397 * @param alignment the alignment of the entity
2398 * @param at_start if true, put the area at the frame type's start, else at end
2400 * @return the entity representing the area
2402 ir_entity *frame_alloc_area(ir_type *frame_type, int size, int alignment, int at_start);
2404 /*-----------------------------------------------------------------*/
2406 /*-----------------------------------------------------------------*/
2409 * Outputs a unique number for this type if libfirm is compiled for
2410 * debugging, (configure with --enable-debug) else returns the address
2411 * of the type cast to long.
2413 long get_type_nr(const ir_type *tp);
2415 /* ------------------------------------------------------------------------ */
2417 /** Type for a function that compares two types.
2419 * @param tp1 The first type to compare.
2420 * @param tp2 The second type to compare.
2422 typedef int (compare_types_func_t)(const void *tp1, const void *tp2);
2424 /** Compares two types by their name.
2426 * Compares the opcode and the name of the types. If these are
2427 * equal returns 0, else non-zero.
2429 int compare_names(const void *tp1, const void *tp2);
2431 /** Compares two types strict.
2433 * returns 0 if tp1 == tp2, else non-zero
2435 int compare_strict(const void *tp1, const void *tp2);
2437 /* ------------------------------------------------------------------------ */
2439 /** Type for a function that computes a hash value for a type.
2441 * @param tp The type to compute a hash for.
2443 typedef int (hash_types_func_t)(ir_type *tp);
2445 /** Computes a hash value by the type name.
2447 * Uses the name of the type and the type opcode to compute the hash.
2449 int firm_hash_name(ir_type *tp);
2451 /* ------------------------------------------------------------------------ */
2453 /** Finalize type construction.
2455 * Indicate that a type is so far completed that it can be
2456 * distinguished from other types. Mature_type hashes the type into a
2457 * table. It uses the function in compare_types_func to compare the
2460 * If it finds a type identical to tp it returns this type. It turns
2461 * tp into the Id type. All places formerly pointing to tp will now
2462 * point to the found type. All entities of tp now refer to the found
2463 * type as their owner, but they are not a member of this type. This
2464 * is invalid firm -- the entities must be replaced by entities of the
2465 * found type. The Id type will be removed from the representation
2466 * automatically, but within an unknown time span. It occupies memory
2469 * @param tp The type to mature.
2471 ir_type *mature_type(ir_type *tp);
2473 /** Finalize type construction.
2475 * Indicate that a type is so far completed that it can be
2476 * distinguished from other types. mature_type() hashes the type into a
2477 * table. It uses the function in compare_types_func to compare the
2480 * If it finds a type identical to tp it returns this type. It frees
2481 * type tp and all its entities.
2483 * @param tp The type to mature.
2485 ir_type *mature_type_free(ir_type *tp);
2487 /** Finalize type construction.
2489 * Indicate that a type is so far completed that it can be
2490 * distinguished from other types. Mature_type hashes the type into a
2491 * table. It uses the function in compare_types_func to compare the
2494 * If it find a type identical to tp it returns this type. It frees
2495 * the entities and turns the type into an Id type. All places
2496 * formerly pointing to tp will now point to the found type. The Id
2497 * type will be removed from the representation automatically, but
2498 * within an unknown time span. It occupies memory for this time.
2500 * @param tp The type to mature.
2502 ir_type *mature_type_free_entities(ir_type *tp);
2505 * The interface type for the type identify module;
2507 typedef struct _type_identify_if_t {
2508 compare_types_func_t *cmp; /**< The function that should be used to compare two types.
2509 If NULL, compare_strict() will be used. */
2510 hash_types_func_t *hash; /**< The function that should be used to calculate a hash
2511 value of a type. If NULL, hash_name() will be used. */
2512 } type_identify_if_t;
2515 * Initialise the type identifier module.
2517 * @param ti_if The interface functions for this module.
2519 * If the parameter ti_if is NULL, the default functions compare_strict() and
2520 * firm_hash_name() will be used.
2522 void init_type_identify(type_identify_if_t *ti_if);
2524 /** A data type to treat types and entities as the same. */
2526 ir_type *typ; /**< points to a type */
2527 ir_entity *ent; /**< points to an entity */
2530 /** Type of argument functions for type walkers.
2532 * @param tore points to the visited type or entity
2533 * @param env free environment pointer
2535 typedef void type_walk_func(type_or_ent *tore, void *env);
2537 /** The class walk function
2539 * @param clss points to the visited class
2540 * @param env free environment pointer
2542 typedef void class_walk_func(ir_type *clss, void *env);
2544 /** Touches every type and entity in unspecified order. If new
2545 * types/entities are created during the traversal these will
2547 * Does not touch frame types or types for value params ... */
2548 void type_walk(type_walk_func *pre, type_walk_func *post, void *env);
2550 /** Walks over all type information reachable from an ir graph.
2552 * Walks over all type information reachable from irg, i.e., starts a
2553 * type walk at the irgs entity, the irgs frame type and all types and
2554 * entities that are attributes to firm nodes. */
2555 void type_walk_irg(ir_graph *irg, type_walk_func *pre, type_walk_func *post,
2559 Touches every class in specified order:
2560 - first the super class
2561 - second the class itself
2562 - third the sub classes. If new classes are created
2563 during the traversal these will be visited, too.
2565 @todo should be named class-walk
2567 @deprecated will be removed?
2569 void type_walk_super2sub(type_walk_func *pre, type_walk_func *post, void *env);
2571 /** Walker for class types in inheritance order.
2573 * Touches every class in specified order:
2574 * - first the super class
2575 * - second the class itself
2576 * If new classes are created during the traversal these
2577 * will be visited, too.
2578 * Starts the walk at arbitrary classes.
2579 * Executes pre when first visiting a class. Executes post after
2580 * visiting all superclasses.
2582 * The arguments pre, post, env may be NULL. */
2583 void type_walk_super(type_walk_func *pre, type_walk_func *post, void *env);
2585 /** Same as type_walk_super2sub, but visits only class types.
2586 Executes pre for a class if all superclasses have been visited.
2587 Then iterates to subclasses. Executes post after return from
2589 Does not visit global type, frame types.
2591 @bug ?? something is wrong with this.
2593 void class_walk_super2sub(class_walk_func *pre, class_walk_func *post,
2597 * the entity walk function. A function type for entity walkers.
2599 * @param ent points to the visited entity
2600 * @param env free environment pointer
2602 typedef void entity_walk_func(ir_entity *ent, void *env);
2605 * Walks over all entities in the type.
2607 * @param tp the type
2608 * @param doit the entity walker function
2609 * @param env environment, will be passed to the walker function
2611 void walk_types_entities(ir_type *tp, entity_walk_func *doit, void *env);
2614 * If we have the closed world assumption, we can calculate the
2615 * finalization of classes and entities by inspecting the class hierarchy.
2616 * After this is done, all classes and entities that are not overridden
2617 * anymore have the final property set.
2619 void types_calc_finalization(void);