type.h 52.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
/*
 * Project:     libFIRM
 * File name:   ir/tr/type.h
 * Purpose:     Representation of types.
 * Author:      Goetz Lindenmaier
 * Modified by: Michael Beck
 * Created:
 * Copyright:   (c) 2001-2003 Universität Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
 * CVS-ID:      $Id$
 */

Sebastian Felis's avatar
Sebastian Felis committed
13
/**
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
14
 * @file type.h
Michael Beck's avatar
Michael Beck committed
15
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
16
 *  Datastructure to hold type information.
17
18
19
20
21
 *
 *  This module supplies a datastructure to represent all types
 *  known in the compiled program.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
22
 *  between these types.  Finally it specifies some auxiliary types.
23
24
25
26
27
28
29
30
31
32
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  A type is described by a set of attributes.  Some of
 *  these attributes are common to all types, others depend on the
 *  kind of the type.
 *
 *  Types are different from the modes defined in irmode:  Types are
 *  on the level of the programming language, modes at the level of
 *  the target processor.
 *
33
 *  @see  tpop.h
34
 */
Michael Beck's avatar
Michael Beck committed
35
36
#ifndef _FIRM_TR_TYPE_H_
#define _FIRM_TR_TYPE_H_
Christian Schäfer's avatar
Christian Schäfer committed
37

Michael Beck's avatar
Michael Beck committed
38
39
40
41
#include "firm_types.h"
#include "tpop.h"
#include "firm_common.h"
#include "dbginfo.h"
42

Sebastian Felis's avatar
Sebastian Felis committed
43
/**
Michael Beck's avatar
Michael Beck committed
44
 *  An abstract data type to represent types.
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 *
 *  This is the abstract data type with which any type known in the
 *  compiled program can be represented.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
 *  between these types.
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  These are distinguished by a type opcode.
 *  A type is described by a set of attributes.  Some of these attributes
 *  are common to all types, others depend on the kind of the type.
 *
 *  The following describes the common attributes.  They can only be
 *  accessed by the functions given below.
 *
Michael Beck's avatar
Michael Beck committed
60
 *  The common fields are:
61
 *
62
 *  - firm_kind: A firm_kind tag containing k_type.  This is useful
63
 *               for dynamically checking whether a node is a type node.
64
65
66
 *  - type_op:   A tp_op specifying the kind of the type.
 *  - mode:      The mode to be used to represent the type on a machine.
 *  - name:      An identifier specifying the name of the type.  To be
67
 *               set by the frontend.
68
 *  - size:      The size of the type, i.e. an entity of this type will
Michael Beck's avatar
Michael Beck committed
69
 *               occupy size bits in memory.  In several cases this is
70
71
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
Michael Beck's avatar
Michael Beck committed
72
73
74
75
 *  - alignment  The alignment of the type, i.e. an entity of this type will
 *               be allocated an an address in memory with this alignment.
 *               In several cases this is determined when fixing the layout
 *               of this type (class, struct, union, array)
76
 *  - state:     The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
77
78
79
80
81
82
83
84
 *               layout of the type is undefined or fixed (values: layout_undefined
 *               or layout_fixed).  Compound types can have an undefined
 *               layout.  The layout of the basic types primitive and pointer
 *               is always layout_fixed.  If the layout of
 *               compound types is fixed all entities must have an offset
 *               and the size of the type must be set.
 *               A fixed layout for enumeration types means that each enumeration
 *               is associated with an implementation value.
85
86
 *  - visit:     A counter for walks of the type information.
 *  - link:      A void* to associate some additional information with the type.
87
 *
Michael Beck's avatar
Michael Beck committed
88
 *  These fields can only be accessed via access functions.
89
 *
90
 *  Depending on the value of @c type_op, i.e., depending on the kind of the
Michael Beck's avatar
Michael Beck committed
91
 *  type the adt contains further attributes.  These are documented below.
92
93
94
95
96
97
98
99
100
 *
 *  @see
 *
 *  @link class_type class @endlink, @link struct_type struct @endlink,
 *  @link method_type method @endlink, @link union_type union @endlink,
 *  @link array_type array @endlink, @link enumeration_type enumeration @endlink,
 *  @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
 *
 *  @todo
Florian Liekweg's avatar
Florian Liekweg committed
101
 *      mode maybe not global field??
102
 */
103
104
105
#ifndef _IR_TYPE_TYPEDEF_
#define _IR_TYPE_TYPEDEF_
typedef struct ir_type ir_type;
106
#endif
107

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
108
109
# include "type_or_entity.h"

110
111
112
113
/** frees all entities associated with a type.
    Does not free array entity.
    Warning: make sure these entities are not referenced anywhere else.
*/
114
void        free_type_entities(ir_type *tp);
115

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
116
117
118
119
120
121
/** Frees the memory used by the type.
 *
 * Removes the type from the type list. Does not free the entities
 * belonging to the type, except for the array element entity.  Does
 * not free if tp is "none" or "unknown".  Frees entities in value
 * param subtypes of method types!!! Make sure these are not
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
122
123
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
124
void        free_type(ir_type *tp);
125

126
127
128
129
const tp_op*get_type_tpop(const ir_type *tp);
ident*      get_type_tpop_nameid(const ir_type *tp);
const char* get_type_tpop_name(const ir_type *tp);
tp_opcode   get_type_tpop_code(const ir_type *tp);
130

131
132
133
ident*      get_type_ident(const ir_type *tp);
void        set_type_ident(ir_type *tp, ident* id);
const char* get_type_name(const ir_type *tp);
134

135
136
137
138
139
140
141
142
143
144
145
146
147
148
/** This enumeration flags the visibility of entities and types.
 *
 * This is necessary for partial compilation.
 * We rely on the ordering of the flags.
 */
typedef enum {
  visibility_local,              /**< The entity is only visible locally.  This is the default for
				      entities.
				      The type is only visible locally.  All instances are allocated
				      locally, and no pointer to entities of this type are passed
				      out of this compilation unit. */
  visibility_external_visible,   /**< The entity is visible to other external program parts, but
				      it is defined here.  It may not be optimized away.  The entity must
				      be static_allocated.
Michael Beck's avatar
Michael Beck committed
149
				      For types:  entities of this type can be accessed externally.  No
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
				      instances of this type are allocated externally.  */
  visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
  				      must not allocate memory for this entity. The entity must
				      be static_allocated.  This can also be an external defined
				      method.
				      For types:  entities of this type are allocated and accessed from
				      external code.  Default for types.  */
} visibility;

/** The visibility of a type.
 *
 *  The visibility of a type indicates, whether entities of this type
 *  are accessed or allocated in external code.
 *
 *  An entity of a type is allocated in external code, if the external
 *  code declares a variable of this type, or dynamically allocates
 *  an entity of this type.  If the external code declares a (compound)
 *  type, that contains entities of this type, the visibility also
 *  must be external_allocated.
 *
 *  The visibility must be higher than that of all entities, if the
 *  type is a compound.  Here it is questionable, what happens with
 *  static entities.  If these are accessed external by direct reference,
 *  (a static call to a method, that is also in the dispatch table)
 *  it should not affect the visibility of the type.
 *
 *
 * @@@ Do we need a visibility for types?
 * I change the layout of types radically when doing type splitting.
Michael Beck's avatar
Michael Beck committed
179
 * I need to know, which fields of classes are accessed in the RTS,
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 * e.g., [_length.  I may not move [_length to the split part.
 * The layout though, is a property of the type.
 *
 * One could also think of changing the mode of a type ...
 *
 * But, we could also output macros to access the fields, e.g.,
 *  ACCESS_[_length (X)   X->length              // conventional
 *  ACCESS_[_length (X)   X->_split_ref->length  // with type splitting
 *
 * For now I implement this function, that returns the visibility
 * based on the visibility of the entities of a compound ...
 *
 * This function returns visibility_external_visible if one or more
 * entities of a compound type have visibility_external_visible.
 * Entities of types are never visibility_external_allocated (right?).
 * Else returns visibility_local.
 */
197
198
visibility get_type_visibility (const ir_type *tp);
void       set_type_visibility (ir_type *tp, visibility v);
199
200
201



202
/** The state of the type layout. */
203
typedef enum {
Michael Beck's avatar
Michael Beck committed
204
  layout_undefined,    /**< The layout of this type is not defined.
Florian Liekweg's avatar
Florian Liekweg committed
205
206
207
208
              Address computation to access fields is not
              possible, fields must be accessed by Sel
              nodes.  This is the default value except for
              pointer, primitive and method types. */
Michael Beck's avatar
Michael Beck committed
209
  layout_fixed         /**< The layout is fixed, all component/member entities
Florian Liekweg's avatar
Florian Liekweg committed
210
211
212
213
              have an offset assigned.  Size of the type is known.
              Arrays can be accessed by explicit address
              computation. Default for pointer, primitive and method
              types.  */
214
} type_state;
215

Götz Lindenmaier's avatar
Götz Lindenmaier committed
216
217
218
/** Returns a human readable string for the enum entry. */
const char *get_type_state_name(type_state s);

219
/** Returns the type layout state of a type. */
220
type_state  get_type_state(const ir_type *tp);
221
222
223
224
225
226

/** Sets the type layout state of a type.
 *
 * For primitives, pointer and method types the layout is always fixed.
 * This call is legal but has no effect.
 */
227
void        set_type_state(ir_type *tp, type_state state);
228

229
230
231
232
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
233
ir_mode*    get_type_mode(const ir_type *tp);
234
235
236

/** Sets the mode of a type.
 *
237
 * Only has an effect on primitive, enumeration and pointer types.
238
 */
239
void        set_type_mode(ir_type *tp, ir_mode* m);
240

Michael Beck's avatar
Michael Beck committed
241
/** Returns the size of a type in bytes, returns -1 if the size is NOT
Michael Beck's avatar
Michael Beck committed
242
 *  a byte size, i.e. not dividable by 8. */
243
int         get_type_size_bytes(const ir_type *tp);
244

245
/** Returns the size of a type in bits. */
246
int         get_type_size_bits(const ir_type *tp);
247
248
249
250
251
252

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

/** Sets the size of a type in bits.
256
257
258
259
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
260
void        set_type_size_bits(ir_type *tp, int size);
261

262
263
264
265
/** Returns the alignment of a type in bytes.
 *
 *  Returns -1 if the alignment is NOT
 *  a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
266
int         get_type_alignment_bytes(ir_type *tp);
267

268
269
270
271
/** Returns the alignment of a type in bits.
 *
 *  If the alignment of a type is
 *  not set, it is calculated here according to the following rules:
Michael Beck's avatar
Michael Beck committed
272
273
274
275
276
 *  -#.) if a type has a mode, the alignment is the mode size.
 *  -#.) compound types have the alignment of there biggest member.
 *  -#.) array types have the alignment of there element type.
 *  -#.) method types return 0 here.
 *  -#.) all other types return 8 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed
277
 */
278
int         get_type_alignment_bits(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
279
280

/** Sets the alignment of a type in bytes. */
281
void        set_type_alignment_bytes(ir_type *tp, int size);
Michael Beck's avatar
Michael Beck committed
282
283
284
285
286
287

/** Sets the alignment of a type in bits.
 *
 * For method types the alignment is always fixed.
 * This call is legal but has no effect.
 */
288
void        set_type_alignment_bits(ir_type *tp, int size);
Michael Beck's avatar
Michael Beck committed
289

290
291
unsigned long get_type_visited(const ir_type *tp);
void          set_type_visited(ir_type *tp, unsigned long num);
292
/* Sets visited field in type to type_visited. */
293
294
295
void          mark_type_visited(ir_type *tp);
int           type_visited(const ir_type *tp);
int           type_not_visited(const ir_type *tp);
296

Michael Beck's avatar
Michael Beck committed
297
/** Returns the associated link field of a type. */
298
void*         get_type_link(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
299
/** Sets the associated link field of a type. */
300
void          set_type_link(ir_type *tp, void *l);
301

Sebastian Felis's avatar
Sebastian Felis committed
302
/**
303
304
 * Visited flag to traverse the type information.
 *
305
306
 * Increase this flag by one before traversing the type information
 * using inc_master_type_visited().
307
308
309
 * Mark type nodes as visited by mark_type_visited(ir_type).
 * Check whether node was already visited by type_visited(ir_type)
 * and type_not_visited(ir_type).
310
 * Or use the function to walk all types.
311
 *
Sebastian Felis's avatar
Sebastian Felis committed
312
 * @see  typewalk
313
 */
314
void          set_master_type_visited(unsigned long val);
315
316
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
317
318

/**
319
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
320
 *
321
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
322
 *
323
324
 * @return
 *     true if the thing is a type, else false
325
 */
326
int is_type  (const void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
327

Sebastian Felis's avatar
Sebastian Felis committed
328
/**
Florian Liekweg's avatar
Florian Liekweg committed
329
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
330
 *
331
332
 *   @param typ1  the first type
 *   @param typ2  the second type
Michael Beck's avatar
Michael Beck committed
333
334
335
 *
 *   @return
 *    true if the types are equal, else false.
336
337
 *
 *   Types are equal if :
338
339
340
341
 *    - they are the same type kind
 *    - they have the same name
 *    - they have the same mode (if applicable)
 *    - they have the same type_state and, ev., the same size
Michael Beck's avatar
Michael Beck committed
342
 *    - they are class types and have:
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 *      - the same members (see same_entity in entity.h)
 *      - the same supertypes -- the C-pointers are compared --> no recursive call.
 *      - the same number of subtypes.  Subtypes are not compared,
 *        as this could cause a cyclic test.
 *      - the same peculiarity
 *    - they are structure types and have the same members
 *    - they are method types and have
 *      - the same parameter types
 *      - the same result types
 *    - they are union types and have the same members
 *    - they are array types and have
 *      - the same number of dimensions
 *      - the same dimension bounds
 *      - the same dimension order
 *      - the same element type
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the identical points_to type
 *      (i.e., the same C-struct to represent the type, type_id is skipped.
Michael Beck's avatar
Michael Beck committed
361
 *       This is to avoid endless recursions; with pointer types cyclic
362
363
 *       type graphs are possible.)
 */
364
int equal_type(ir_type *typ1, ir_type *typ2);
365

Sebastian Felis's avatar
Sebastian Felis committed
366
367
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
368
369
370
371
372
373
374
375
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if type st is smaller than type lt, i.e. whenever
 *    lt is expected a st can be used.
 *    This is true if
376
377
378
379
380
381
382
383
384
385
386
 *    - they are the same type kind
 *    - mode(st) < mode (lt)  (if applicable)
 *    - they are class types and st is (transitive) subtype of lt,
 *    - they are structure types and
 *       - the members of st have exactly one counterpart in lt with the same name,
 *       - the counterpart has a bigger type.
 *    - they are method types and have
 *      - the same number of parameter and result types,
 *      - the parameter types of st are smaller than those of lt,
 *      - the result types of st are smaller than those of lt
 *    - they are union types and have the members of st have exactly one
Sebastian Felis's avatar
Sebastian Felis committed
387
 *      @return counterpart in lt and the type is smaller
388
389
390
391
392
 *    - they are array types and have
 *      - the same number of dimensions
 *      - all bounds of lt are bound of st
 *      - the same dimension order
 *      - the same element type
Sebastian Felis's avatar
Sebastian Felis committed
393
 *      @return or
394
395
396
397
 *      - the element type of st is smaller than that of lt
 *      - the element types have the same size and fixed layout.
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the points_to type of st is
Sebastian Felis's avatar
Sebastian Felis committed
398
399
 *      @return smaller than the points_to type of lt.
 *
400
 */
401
int smaller_type (ir_type *st, ir_type *lt);
402

Sebastian Felis's avatar
Sebastian Felis committed
403
/**
Florian Liekweg's avatar
Florian Liekweg committed
404
 *  @page class_type    Representation of a class type
405
 *
406
407
408
 *  If the type opcode is set to type_class the type represents class
 *  types.  A list of fields and methods is associated with a class.
 *  Further a class can inherit from and bequest to other classes.
409
 *
410
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
411
 *  - member:     All entities belonging to this class.  This are method entities
412
413
414
 *                which have type_method or fields that can have any of the
 *                following type kinds: type_class, type_struct, type_union,
 *                type_array, type_enumeration, type_pointer, type_primitive.
415
 *
416
417
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
418
 *
419
 *  - subtypes:    A list of direct subclasses.
420
 *
421
 *  - supertypes:  A list of direct superclasses.
422
 *
423
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
424
 *                 "description" it only is a description of requirements to a class,
425
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
426
 *                 Peculiarity inherited is only possible for entities.  An entity
427
428
429
430
 *                 is of peculiarity inherited if the compiler generated the entity
 *                 to explicitly resolve inheritance.  An inherited method entity has
 *                 no value for irg.
 *                 Values: description, existent, inherited.  Default: existent.
431
 *
432
433
434
435
436
437
 *  - type_info:   An entity representing the type information of this class.
 *                 This entity can be of arbitrari type, Firm did not use it yet.
 *                 It allows to express the coupling of a type with an entity
 *                 representing this type.  This information is useful for lowering
 *                 of InstOf and TypeChk nodes.  Default: NULL
 *
438
 *  - vtable_size: The size of this class virtual function table.
439
440
 *                 Default:  0
 *
441
442
443
444
445
 *  - final:       A final class is always a leaf in the class hierarchy.  Final
 *                 classes cannot be super classes of other ones.  As this information
 *                 can only be computed in whole world compilations, we allow to
 *                 set this flag.  It is used in optimizations if get_opt_closed_world()
 *                 is false.  Default:  false
446
447
448
449
450
451
452
453
454
455
 *
 *  - interface:   The class represents an interface.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
 *
 *  - abstract :   The class represents an abstract class.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
456
 */
457
458

/** Creates a new class type. */
459
ir_type *new_type_class (ident *name);
460
461

/** Creates a new class type with debug information. */
462
ir_type *new_d_type_class (ident *name, dbg_info *db);
463

464
465
466
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
467
void    add_class_member   (ir_type *clss, entity *member);
468
469

/** Returns the number of members of this class. */
470
int     get_class_n_members (const ir_type *clss);
471
472

/** Returns the member at position pos, 0 <= pos < n_member */
473
entity *get_class_member   (const ir_type *clss, int pos);
474

Götz Lindenmaier's avatar
Götz Lindenmaier committed
475
/** Returns index of mem in clss, -1 if not contained. */
476
int     get_class_member_index(const ir_type *clss, entity *mem);
477

Götz Lindenmaier's avatar
Götz Lindenmaier committed
478
/** Finds the member with name 'name'. If several members with the same
479
 *  name returns one of them.  Returns NULL if no member found. */
480
entity *get_class_member_by_name(ir_type *clss, ident *name);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
481

482
/** Overwrites the member at position pos, 0 <= pos < n_member with
483
 *  the passed entity. */
484
void    set_class_member   (ir_type *clss, entity *member, int pos);
485
486

/** Replaces complete member list in class type by the list passed.
487
488
489
490
 *
 *  Copies the list passed. This function is necessary to reduce the number of members.
 *  members is an array of entities, num the size of this array.  Sets all
 *  owners of the members passed to clss. */
491
void    set_class_members  (ir_type *clss, entity *members[], int arity);
492
493

/** Finds member in the list of members and removes it.
494
495
496
 *
 *  Shrinks the member list, so iterate from the end!!!
 *  Does not deallocate the entity.  */
497
void    remove_class_member(ir_type *clss, entity *member);
498

499

500
/** Adds subtype as subtype to clss.
501
502
503
 *
 *  Checks whether clss is a supertype of subtype.  If not
 *  adds also clss as supertype to subtype.  */
504
void    add_class_subtype   (ir_type *clss, ir_type *subtype);
505
506

/** Returns the number of subtypes */
507
int     get_class_n_subtypes (const ir_type *clss);
508
509

/** Gets the subtype at position pos, 0 <= pos < n_subtype. */
510
ir_type *get_class_subtype   (ir_type *clss, int pos);
511

Götz Lindenmaier's avatar
Götz Lindenmaier committed
512
513
514
515
/** Returns the index to access subclass as subtype of class.
 *
 *  If subclass is no direct subtype of class returns -1.
 */
516
int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
517

Michael Beck's avatar
Michael Beck committed
518
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
519
520
521
 *
 *  Does not set the corresponding supertype relation for subtype: this might
 *  be a different position! */
522
void    set_class_subtype   (ir_type *clss, ir_type *subtype, int pos);
523
524

/** Finds subtype in the list of subtypes and removes it  */
525
void    remove_class_subtype(ir_type *clss, ir_type *subtype);
526

Michael Beck's avatar
Michael Beck committed
527
528
529
530
531
532
533
/* Convenience macros */
#define add_class_derived_type(clss, drvtype)       add_class_subtype(clss, drvtype)
#define get_class_n_derived_types(clss)             get_class_n_subtypes(clss)
#define get_class_derived_type(clss, pos)           get_class_subtype(clss, pos)
#define get_class_derived_type_index(clss, drvtype) get_class_subtype_index(clss, drvtype)
#define set_class_derived_type(clss, drvtype, pos)  set_class_subtype(clss, drvtype, pos)
#define remove_class_derived_type(clss, drvtype)    remove_class_subtype(clss, drvtype)
534

535
/** Adds supertype as supertype to class.
536
537
538
 *
 *  Checks whether clss is a subtype of supertype.  If not
 *  adds also clss as subtype to supertype.  */
539
void    add_class_supertype   (ir_type *clss, ir_type *supertype);
540
541

/** Returns the number of supertypes */
542
int     get_class_n_supertypes (const ir_type *clss);
543

Götz Lindenmaier's avatar
Götz Lindenmaier committed
544
545
546
547
/** Returns the index to access superclass as supertype of class.
 *
 *  If superclass is no direct supertype of class returns -1.
 */
548
int     get_class_supertype_index(ir_type *clss, ir_type *super_clss);
549
550

/** Gets the supertype at position pos,  0 <= pos < n_supertype. */
551
ir_type *get_class_supertype   (ir_type *clss, int pos);
552

553
554
555
556
/** Sets the supertype at position pos, 0 <= pos < n_supertype.
 *
 *  Does not set the corresponding subtype relation for supertype: this might
 *  be at a different position! */
557
void    set_class_supertype   (ir_type *clss, ir_type *supertype, int pos);
558
559

/** Finds supertype in the list of supertypes and removes it */
560
void    remove_class_supertype(ir_type *clss, ir_type *supertype);
561

562
563
564
565
566
567
568
569
/** Convenience macro */
#define add_class_base_type(clss, basetype)  add_class_supertype(clss, basetype)
#define get_class_n_base_types(clss)  get_class_n_supertypes(clss)
#define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
#define get_class_base_type(clss, pos)  get_class_supertype(clss, pos)
#define set_class_base_type(clss, basetype, pos) set_class_supertype(clss, basetype, pos)
#define remove_class_base_type(clss, basetype)  remove_class_supertype(clss, basetype)

Michael Beck's avatar
Michael Beck committed
570
571
572
573
574
575
576
577
/** Convenience macro */
#define add_class_base_type(clss, basetype)        add_class_supertype(clss, basetype)
#define get_class_n_base_types(clss)               get_class_n_supertypes(clss)
#define get_class_base_type_index(clss, base_clss) get_class_supertype_index(clss, base_clss)
#define get_class_base_type(clss, pos)             get_class_supertype(clss, pos)
#define set_class_base_type(clss, basetype, pos)   set_class_supertype(clss, basetype, pos)
#define remove_class_base_type(clss, basetype)     remove_class_supertype(clss, basetype)

Michael Beck's avatar
Michael Beck committed
578
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
579
typedef enum peculiarity {
580
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
Florian Liekweg's avatar
Florian Liekweg committed
581
582
                            allocated, no code/data exists for this entity/type.
                        @@@ eventually rename to descriptive (adjective as the others!)*/
583
  peculiarity_inherited,       /**< Describes explicitly that other entities are
Florian Liekweg's avatar
Florian Liekweg committed
584
585
586
587
588
589
                            inherited to the owner of this entity.
                            Overwrites must refer to at least one other
                            entity.  If this is a method entity there exists
                            no irg for this entity, only for one of the
                            overwritten ones.
                        Only for entity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
590
  peculiarity_existent         /**< The entity/type (can) exist.
Florian Liekweg's avatar
Florian Liekweg committed
591
592
                    @@@ eventually rename to 'real' i.e., 'echt'
                        This serves better as opposition to description _and_ inherited.*/
593
} peculiarity;
594
595

/** Returns a human readable string for a peculiarity. */
596
const char *get_peculiarity_name(peculiarity p);
597

Michael Beck's avatar
Michael Beck committed
598
/** Returns the peculiarity of the class. */
599
peculiarity get_class_peculiarity (const ir_type *clss);
Michael Beck's avatar
Michael Beck committed
600
/** Sets the peculiarity of the class. */
601
void        set_class_peculiarity (ir_type *clss, peculiarity pec);
602

603
604
605
606
607
608
/** Returns the type info entity of a class. */
entity *get_class_type_info(const ir_type *clss);

/** Set a type info entity for the class. */
void set_class_type_info(ir_type *clss, entity *ent);

609
610
611
612
613
614
/** Returns the size of the virtual function table. */
unsigned get_class_vtable_size(const ir_type *clss);

/** Sets a new size of the virtual function table. */
void set_class_vtable_size(ir_type *clss, unsigned size);

615
616
617
/** Returns non-zero if a class is final. */
int is_class_final(const ir_type *clss);

618
/** Sets the class final flag. */
619
void set_class_final(ir_type *clss, int flag);
620

621
622
623
624
625
626
627
628
629
630
631
632
633
/** Return non-zero if a class is an interface */
int is_class_interface(const ir_type *clss);

/** Sets the class interface flag. */
void set_class_interface(ir_type *clss, int flag);

/** Return non-zero if a class is an abstract class. */
int is_class_abstract(const ir_type *clss);

/** Sets the class abstract flag. */
void set_class_abstract(ir_type *clss, int flag);

/** Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
634
   @todo This is an undocumented field, subject to change! */
635
636
void set_class_dfn (ir_type *clss, int dfn);
int  get_class_dfn (const ir_type *clss);
637

638
/** Returns true if a type is a class type. */
639
int is_Class_type(const ir_type *clss);
640

Sebastian Felis's avatar
Sebastian Felis committed
641
/**
Florian Liekweg's avatar
Florian Liekweg committed
642
 *  @page struct_type   Representation of a struct type
643
 *
644
 *  A struct type represents aggregate types that consist of a list
645
 *  of fields.
646
 *
647
648
649
650
 *  The following attributes are private to this type kind:
 *  - member:  All entities belonging to this class.  This are the fields
 *             that can have any of the following types:  type_class,
 *             type_struct, type_union, type_array, type_enumeration,
Florian Liekweg's avatar
Florian Liekweg committed
651
 *             type_pointer, type_primitive.
652
653
654
655
 *             This is a dynamic list that can be grown with an "add_" function,
 *             but not shrinked.
 *             This is a dynamic list that can be grown with an "add_" function,
 *             but not shrinked.
656
 */
657
/** Creates a new type struct */
658
ir_type *new_type_struct (ident *name);
659
/** Creates a new type struct with debug information. */
660
ir_type *new_d_type_struct (ident *name, dbg_info* db);
661

662
663
664
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
665
void    add_struct_member   (ir_type *strct, entity *member);
666
667

/** Returns the number of members of this struct. */
668
int     get_struct_n_members (const ir_type *strct);
669
670

/** Returns the member at position pos, 0 <= pos < n_member */
671
entity *get_struct_member   (const ir_type *strct, int pos);
672
673

/** Returns index of member in strct, -1 if not contained. */
674
int     get_struct_member_index(const ir_type *strct, entity *member);
675
676
677

/** Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
678
void    set_struct_member   (ir_type *strct, int pos, entity *member);
679
680

/** Finds member in the list of members and removes it. */
681
void    remove_struct_member (ir_type *strct, entity *member);
682

683
/** Returns true if a type is a struct type. */
684
int     is_Struct_type(const ir_type *strct);
685

Sebastian Felis's avatar
Sebastian Felis committed
686
/**
Florian Liekweg's avatar
Florian Liekweg committed
687
 * @page method_type    Representation of a method type
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 *
 * A method type represents a method, function or procedure type.
 * It contains a list of the parameter and result types, as these
 * are part of the type description.  These lists should not
 * be changed by a optimization, as a change creates a new method
 * type.  Therefore optimizations should allocated new method types.
 * The set_ routines are only for construction by a frontend.
 *
 * - n_params:   Number of parameters to the procedure.
 *               A procedure in FIRM has only call by value parameters.
 *
 * - param_type: A list with the types of parameters.  This list is ordered.
 *               The nth type in this list corresponds to the nth element
 *               in the parameter tuple that is a result of the start node.
 *               (See ircons.h for more information.)
 *
704
705
706
707
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
708
709
710
711
712
713
 * - n_res:      The number of results of the method.  In general, procedures
 *               have zero results, functions one.
 *
 * - res_type:   A list with the types of parameters.  This list is ordered.
 *               The nth type in this list corresponds to the nth input to
 *               Return nodes.  (See ircons.h for more information.)
714
715
716
717
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
718
719
 */

Michael Beck's avatar
Michael Beck committed
720
/* These macros define the suffixes for the types and entities used
721
722
723
724
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
725
726
/** Create a new method type.
 *
727
728
729
730
731
732
733
 * @param name      the name (ident) of this type
 * @param n_param   the number of parameters
 * @param n_res     the number of results
 *
 * The arrays for the parameter and result types are not initialized by
 * the constructor.
 */
734
ir_type *new_type_method (ident *name, int n_param, int n_res);
735
736
737
738
739
740
741
742
743
744
745

/** Create a new method type with debug information.
 *
 * @param name      the name (ident) of this type
 * @param n_param   the number of parameters
 * @param n_res     the number of results
 * @param db        user defined debug information
 *
 * The arrays for the parameter and result types are not initialized by
 * the constructor.
 */
746
ir_type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
747

748
749
750
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
751
int   get_method_n_params  (const ir_type *method);
752
753

/** Returns the type of the parameter at position pos of a method. */
754
ir_type *get_method_param_type(ir_type *method, int pos);
755
756
757
/** Sets the type of the parameter at position pos of a method.
    Also changes the type in the pass-by-value representation by just
    changing the type of the corresponding entity if the representation is constructed. */
758
void  set_method_param_type(ir_type *method, int pos, ir_type *tp);
759
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
760
   for compounds passed by value. This information is constructed only on demand. */
761
entity *get_method_value_param_ent(ir_type *method, int pos);
762
763
764
/**
 * Returns a type that represents the copied value arguments.
 */
765
ir_type *get_method_value_param_type(const ir_type *method);
766

Michael Beck's avatar
Michael Beck committed
767
/** Returns the number of results of a method type. */
768
int   get_method_n_ress   (const ir_type *method);
Michael Beck's avatar
Michael Beck committed
769
/** Returns the return type of a method type at position pos. */
770
ir_type *get_method_res_type(ir_type *method, int pos);
771
772
773
/** Sets the type of the result at position pos of a method.
    Also changes the type in the pass-by-value representation by just
    changing the type of the corresponding entity if the representation is constructed. */
774
void  set_method_res_type(ir_type *method, int pos, ir_type *tp);
775
/** Returns an entity that represents the copied value result.  Only necessary
776
   for compounds passed by value. This information is constructed only on demand. */
777
entity *get_method_value_res_ent(ir_type *method, int pos);
Michael Beck's avatar
Michael Beck committed
778

779
780
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
781
 */
782
ir_type *get_method_value_res_type(const ir_type *method);
783

Michael Beck's avatar
Michael Beck committed
784
/**
Michael Beck's avatar
Michael Beck committed
785
 * This enum flags the variadicity of methods (methods with a
786
787
788
789
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
790
791
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
792
793
} variadicity;

Michael Beck's avatar
Michael Beck committed
794
795
796
/** Returns the null-terminated name of this variadicity. */
const char *get_variadicity_name(variadicity vari);

797
/** Returns the variadicity of a method. */
798
variadicity get_method_variadicity(const ir_type *method);
799
800

/** Sets the variadicity of a method. */
801
void set_method_variadicity(ir_type *method, variadicity vari);
802

803
804
805
806
807
808
/**
 * Returns the first variadic parameter index of a type.
 * If this index was NOT set, the index of the last parameter
 * of the method type plus one is returned for variadic functions.
 * Non-variadic function types always return -1 here.
 */
809
int get_method_first_variadic_param_index(const ir_type *method);
810
811
812
813
814
815
816

/**
 * Sets the first variadic parameter index. This allows to specify
 * a complete call type (containing the type of all parameters)
 * but still have the knowledge, which parameter must be passed as
 * variadic one.
 */
817
void set_method_first_variadic_param_index(ir_type *method, int index);
818

819
/**
820
821
822
 * Additional method type properties:
 * Tell about special properties of a method type. Some
 * of these may be discovered by analyses.
823
824
825
 */
typedef enum {
  mtp_no_property        = 0x00000000, /**< no additional properties, default */
Michael Beck's avatar
Michael Beck committed
826
  mtp_property_const     = 0x00000001, /**< This method did not access memory and calculates
827
828
                                         its return values solely from its parameters.
                                         GCC: __attribute__((const)). */
Michael Beck's avatar
Michael Beck committed
829
  mtp_property_pure      = 0x00000002, /**< This method did NOT write to memory and calculates
Michael Beck's avatar
Michael Beck committed
830
                                         its return values solely from its parameters and
831
832
                                         the memory they points to (or global vars).
                                         GCC: __attribute__((pure)). */
Michael Beck's avatar
Michael Beck committed
833
  mtp_property_noreturn  = 0x00000004, /**< This method did not return due to an aborting system
834
835
                                         call.
                                         GCC: __attribute__((noreturn)). */
Michael Beck's avatar
Michael Beck committed
836
  mtp_property_nothrow   = 0x00000008, /**< This method cannot throw an exception.
837
                                         GCC: __attribute__((nothrow)). */
Michael Beck's avatar
Michael Beck committed
838
  mtp_property_naked     = 0x00000010, /**< This method is naked.
839
                                         GCC: __attribute__((naked)). */
Michael Beck's avatar
Michael Beck committed
840
  mtp_property_malloc    = 0x00000020, /**< This method returns newly allocate memory.
841
                                         GCC: __attribute__((malloc)). */
842
843
  mtp_property_intrinsic = 0x00000040, /**< This method is intrinsic. It is expected that
                                         a lowering phase will remove all calls to it. */
844
845
  mtp_property_inherited = (1<<31)     /**< Internal. Used only in irg's, means property is
                                         inherited from type. */
846
847
848
} mtp_additional_property;

/** Returns the mask of the additional graph properties. */
849
unsigned get_method_additional_properties(const ir_type *method);
850
851

/** Sets the mask of the additional graph properties. */
852
void set_method_additional_properties(ir_type *method, unsigned property_mask);
853
854

/** Sets one additional graph property. */
855
void set_method_additional_property(ir_type *method, mtp_additional_property flag);
856
857

/**
858
859
 * Calling conventions: lower 24 bits are the number of register parameters,
 * upper 8 encode the calling conventions.
860
861
 */
typedef enum {
862
  cc_reg_param        = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
863
                                         This flag may be set as default on some architectures. */
864
  cc_last_on_top      = 0x02000000, /**< The last non-register parameter is transmitted on top of
865
866
867
868
                                         the stack. This is equivalent to the pascal
                                         calling convention. If this flag is not set, the first
                                         non-register parameter is used (stdcall or cdecl
                                         calling convention) */
869
  cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
870
                                         function calls (stdcall). */
871
  cc_this_call        = 0x08000000, /**< The first parameter is a this pointer and is transmitted
872
873
                                         in a special way. */

874
  cc_bits             = (0xFF << 24)  /**< the calling convention bits */
875
876
} calling_convention;

877
878
879
/* some often used cases: made as defines because firmjni cannot handle two
   equal enum values. */

880
881
882
883
884
885
886
/** cdecl calling convention */
#define cc_cdecl_set    (0)
/** stdcall calling convention */
#define cc_stdcall_set  cc_callee_clear_stk
/** fastcall calling convention */
#define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)

887
/** Returns the default calling convention for method types. */
Michael Beck's avatar
Michael Beck committed
888
889
unsigned get_default_cc_mask(void);

890
891
892
/**
 * check for the CDECL calling convention
 */
893
#define IS_CDECL(cc_mask)     (((cc_mask) & cc_bits) == cc_cdecl_set)
894
895
896
897

/**
 * check for the STDCALL calling convention
 */
898
#define IS_STDCALL(cc_mask)   (((cc_mask) & cc_bits) == cc_stdcall_set)
899
900
901
902

/**
 * check for the FASTCALL calling convention
 */
903
#define IS_FASTCALL(cc_mask)  (((cc_mask) & cc_bits) == cc_fastcall_set)
904
905

/**
906
 * Sets the CDECL convention bits.
907
 */
908
#define SET_CDECL(cc_mask)    (((cc_mask) & ~cc_bits) | cc_cdecl_set)
909
910

/**
911
 * Set. the STDCALL convention bits.
912
 */
913
#define SET_STDCALL(cc_mask)  (((cc_mask) & ~cc_bits) | cc_stdcall_set)
914
915

/**
916
 * Sets the FASTCALL convention bits.
917
 */
918
#define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
919
920

/** Returns the calling convention of an entities graph. */
921
unsigned get_method_calling_convention(const ir_type *method);
922
923

/** Sets the calling convention of an entities graph. */
924
void set_method_calling_convention(ir_type *method, unsigned cc_mask);
925

926
/** Returns the number of registers parameters, 0 means default. */
927
unsigned get_method_n_regparams(ir_type *method);
928

929
/** Sets the number of registers parameters, 0 means default. */
930
void set_method_n_regparams(ir_type *method, unsigned n_regs);
931

932
/** Returns true if a type is a method type. */
933
int   is_Method_type     (const ir_type *method);
934

Sebastian Felis's avatar
Sebastian Felis committed
935
/**
936
 *   @page union_type   Representation of a union (variant) type.
937
 *
938
939
940
941
 *   The union type represents union types.  Note that this representation
 *   resembles the C union type.  For tagged variant types like in Pascal or Modula
 *   a combination of a struct and a union type must be used.
 *
942
943
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
944
945
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
946
 */
947
/** Creates a new type union. */
948
ir_type   *new_type_union (ident *name);
949
950

/** Creates a new type union with debug information. */
951
ir_type   *new_d_type_union (ident *name, dbg_info* db);
952

953
954
955
/* --- manipulate private fields of struct --- */

/** Returns the number of unioned types of this union */
956
int     get_union_n_members      (const ir_type *uni);
957
958

/** Adds a new entity to a union type */
959
void    add_union_member (ir_type *uni, entity *member);
960
961

/** Returns the entity at position pos of a union */