type.h 43.2 KB
Newer Older
Sebastian Felis's avatar
Sebastian Felis committed
1
/**
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
2
 * @file type.h
Michael Beck's avatar
Michael Beck committed
3
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
4
5
6
7
8
9
10
11
12
 * Project:     libFIRM                                                   <br>
 * File name:   ir/tr/type.h                                              <br>
 * Purpose:     Representation of types.                                  <br>
 * Author:      Goetz Lindenmaier                                         <br>
 * Modified by:                                                           <br>
 * Created:                                                               <br>
 * Copyright:   (c) 2001-2003 Universität Karlsruhe                       <br>
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE. <br>
 * CVS-ID:      $Id$
Michael Beck's avatar
Michael Beck committed
13
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
14
15
 *
 *  Datastructure to hold type information.
16
17
18
19
20
 *
 *  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
21
 *  between these types.  Finally it specifies some auxiliary types.
22
23
24
25
26
27
28
29
30
31
 *
 *  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.
 *
32
 *  @see  tpop.h
33
 */
Boris Boesler's avatar
Boris Boesler committed
34

Christian Schäfer's avatar
Christian Schäfer committed
35
36
37
# ifndef _TYPE_H_
# define _TYPE_H_

Michael Beck's avatar
Michael Beck committed
38
39
#include <stdbool.h>

40
# include "tpop.h"
41
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
42
43
# include "ident.h"
# include "irmode.h"
44
# include "dbginfo.h"
Christian Schäfer's avatar
Christian Schäfer committed
45

46
/* to resolve recursion between entity.h and type.h */
Christian Schäfer's avatar
Christian Schäfer committed
47
48
49
50
#ifndef _ENTITY_TYPEDEF_
#define _ENTITY_TYPEDEF_
typedef struct entity entity;
#endif
Christian Schäfer's avatar
Christian Schäfer committed
51

52
53
54
55
56
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

57
58
# include "tr_inheritance.h"

Sebastian Felis's avatar
Sebastian Felis committed
59
/**
Michael Beck's avatar
Michael Beck committed
60
 *  An abstract data type to represent types.
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 *
 *  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
76
 *  The common fields are:
77
 *
78
 *  - firm_kind: A firm_kind tag containing k_type.  This is useful
79
 *               for dynamically checking whether a node is a type node.
80
81
82
 *  - 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
83
 *               set by the frontend.
84
 *  - size:      The size of the type, i.e. an entity of this type will
Michael Beck's avatar
Michael Beck committed
85
 *               occupy size bits in memory.  In several cases this is
86
87
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
Michael Beck's avatar
Michael Beck committed
88
89
90
91
 *  - 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)
92
 *  - state:     The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
93
94
95
96
97
98
99
100
 *               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.
101
102
 *  - visit:     A counter for walks of the type information.
 *  - link:      A void* to associate some additional information with the type.
103
 *
Michael Beck's avatar
Michael Beck committed
104
 *  These fields can only be accessed via access functions.
105
 *
106
 *  Depending on the value of @c type_op, i.e., depending on the kind of the
Michael Beck's avatar
Michael Beck committed
107
 *  type the adt contains further attributes.  These are documented below.
108
109
110
111
112
113
114
115
116
 *
 *  @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
117
 *      mode maybe not global field??
118
 */
119
120
#ifndef _TYPE_TYPEDEF_
#define _TYPE_TYPEDEF_
121
typedef struct type type;
122
#endif
123

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
124
125
# include "type_or_entity.h"

126
127
128
129
130
131
/** frees all entities associated with a type.
    Does not free array entity.
    Warning: make sure these entities are not referenced anywhere else.
*/
void        free_type_entities(type *tp);

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
132
133
134
135
136
137
/** 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
138
139
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
140
141
void        free_type(type *tp);

Michael Beck's avatar
Michael Beck committed
142
const tp_op*get_type_tpop(const type *tp);
Michael Beck's avatar
Michael Beck committed
143
144
145
ident*      get_type_tpop_nameid(const type *tp);
const char* get_type_tpop_name(const type *tp);
tp_opcode   get_type_tpop_code(const type *tp);
146

Michael Beck's avatar
Michael Beck committed
147
ident*      get_type_ident(const type *tp);
148
void        set_type_ident(type *tp, ident* id);
Michael Beck's avatar
Michael Beck committed
149
const char* get_type_name(const type *tp);
150

151
152
153
154
155
156
157
158
159
160
161
162
163
164
/** 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
165
				      For types:  entities of this type can be accessed externally.  No
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
				      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
195
 * I need to know, which fields of classes are accessed in the RTS,
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 * 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.
 */
visibility get_type_visibility (const type *tp);
void       set_type_visibility (type *tp, visibility v);



218
/** The state of the type layout. */
219
typedef enum {
Michael Beck's avatar
Michael Beck committed
220
  layout_undefined,    /**< The layout of this type is not defined.
Florian Liekweg's avatar
Florian Liekweg committed
221
222
223
224
              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
225
  layout_fixed         /**< The layout is fixed, all component/member entities
Florian Liekweg's avatar
Florian Liekweg committed
226
227
228
229
              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.  */
230
} type_state;
231

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

235
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
236
type_state  get_type_state(const type *tp);
237
238
239
240
241
242

/** 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.
 */
243
244
void        set_type_state(type *tp, type_state state);

245
246
247
248
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
249
ir_mode*    get_type_mode(const type *tp);
250
251
252

/** Sets the mode of a type.
 *
253
 * Only has an effect on primitive, enumeration and pointer types.
254
 */
255
256
void        set_type_mode(type *tp, ir_mode* m);

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

261
/** Returns the size of a type in bits. */
Michael Beck's avatar
Michael Beck committed
262
int         get_type_size_bits(const type *tp);
263
264
265
266
267
268
269
270
271

/** 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.
 */
void        set_type_size_bytes(type *tp, int size);

/** Sets the size of a type in bits.
272
273
274
275
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
276
void        set_type_size_bits(type *tp, int size);
277

278
279
280
281
/** 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(). */
Michael Beck's avatar
Michael Beck committed
282
int         get_type_alignment_bytes(type *tp);
283

284
285
286
287
/** 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
288
289
290
291
292
 *  -#.) 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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 */
int         get_type_alignment_bits(type *tp);

/** Sets the alignment of a type in bytes. */
void        set_type_alignment_bytes(type *tp, int size);

/** Sets the alignment of a type in bits.
 *
 * For method types the alignment is always fixed.
 * This call is legal but has no effect.
 */
void        set_type_alignment_bits(type *tp, int size);

unsigned long get_type_visited(const type *tp);
307
void          set_type_visited(type *tp, unsigned long num);
308
/* Sets visited field in type to type_visited. */
309
void          mark_type_visited(type *tp);
Michael Beck's avatar
Michael Beck committed
310
311
/* @@@ name clash!! int           type_visited(const type *tp); */
int           type_not_visited(const type *tp);
312

Michael Beck's avatar
Michael Beck committed
313
/** Returns the associated link field of a type. */
Michael Beck's avatar
Michael Beck committed
314
void*         get_type_link(const type *tp);
Michael Beck's avatar
Michael Beck committed
315
/** Sets the associated link field of a type. */
316
void          set_type_link(type *tp, void *l);
317

Sebastian Felis's avatar
Sebastian Felis committed
318
/**
319
320
321
322
323
324
325
 * Visited flag to traverse the type information.
 *
 * Increase this flag by one before traversing the type information.
 * Mark type nodes as visited by set_type_visited(type, type_visited).
 * Check whether node was already visited by comparing get_type_visited(type)
 * and type_visited.
 * Or use the function to walk all types.
326
 *
Sebastian Felis's avatar
Sebastian Felis committed
327
 * @see  typewalk
328
 */
Christian Schäfer's avatar
Christian Schäfer committed
329
extern unsigned long type_visited;
330
void          set_master_type_visited(unsigned long val);
331
332
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
333
334

/**
335
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
336
 *
337
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
338
 *
339
340
 * @return
 *     true if the thing is a type, else false
341
 */
Michael Beck's avatar
Michael Beck committed
342
int is_type            (const void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
343

Sebastian Felis's avatar
Sebastian Felis committed
344
/**
Florian Liekweg's avatar
Florian Liekweg committed
345
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
346
347
348
349
350
351
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
352
 *    Types are equal if :
353
354
355
356
 *    - 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
357
 *    - they are class types and have:
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 *      - 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
376
 *       This is to avoid endless recursions; with pointer types cyclic
377
378
 *       type graphs are possible.)
 */
Michael Beck's avatar
Michael Beck committed
379
int equal_type(type *tpy1, type *typ2);
380

Sebastian Felis's avatar
Sebastian Felis committed
381
382
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
383
384
385
386
387
388
389
390
 *
 *   @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
391
392
393
394
395
396
397
398
399
400
401
 *    - 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
402
 *      @return counterpart in lt and the type is smaller
403
404
405
406
407
 *    - 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
408
 *      @return or
409
410
411
412
 *      - 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
413
414
 *      @return smaller than the points_to type of lt.
 *
415
 */
Michael Beck's avatar
Michael Beck committed
416
int smaller_type (type *st, type *lt);
417

Sebastian Felis's avatar
Sebastian Felis committed
418
/**
Florian Liekweg's avatar
Florian Liekweg committed
419
 *  @page class_type    Representation of a class type
420
 *
421
422
423
424
 *  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.
 *  @@@ value class???
425
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
426
 *  - member:     All entities belonging to this class.  This are method entities
427
428
429
 *                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.
430
 *
431
432
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
433
 *
434
 *  - subtypes:   A list of direct subclasses.
435
 *
436
 *  - supertypes: A list of direct superclasses.
437
 *
438
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
439
 *                 "description" it only is a description of requirements to a class,
440
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
441
 *                 Peculiarity inherited is only possible for entities.  An entity
442
443
444
445
 *                 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.
446
 *
447
 */
448
449

/** Creates a new class type. */
450
type   *new_type_class (ident *name);
451
452

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

455
456
457
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
458
void    add_class_member   (type *clss, entity *member);
459
460

/** Returns the number of members of this class. */
Michael Beck's avatar
Michael Beck committed
461
int     get_class_n_members (const type *clss);
462
463

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar
Michael Beck committed
464
entity *get_class_member   (const type *clss, int pos);
465

Götz Lindenmaier's avatar
Götz Lindenmaier committed
466
467
/** Returns index of mem in clss, -1 if not contained. */
int     get_class_member_index(type *clss, entity *mem);
468

Götz Lindenmaier's avatar
Götz Lindenmaier committed
469
/** Finds the member with name 'name'. If several members with the same
470
 *  name returns one of them.  Returns NULL if no member found. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
471
472
entity *get_class_member_by_name(type *clss, ident *name);

473
/** Overwrites the member at position pos, 0 <= pos < n_member with
474
 *  the passed entity. */
475
void    set_class_member   (type *clss, entity *member, int pos);
476
477

/** Replaces complete member list in class type by the list passed.
478
479
480
481
 *
 *  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. */
482
void    set_class_members  (type *clss, entity *members[], int arity);
483
484

/** Finds member in the list of members and removes it.
485
486
487
 *
 *  Shrinks the member list, so iterate from the end!!!
 *  Does not deallocate the entity.  */
488
void    remove_class_member(type *clss, entity *member);
489

490

491
/** Adds subtype as subtype to clss.
492
493
494
 *
 *  Checks whether clss is a supertype of subtype.  If not
 *  adds also clss as supertype to subtype.  */
495
void    add_class_subtype   (type *clss, type *subtype);
496
497

/** Returns the number of subtypes */
Michael Beck's avatar
Michael Beck committed
498
int     get_class_n_subtypes (const type *clss);
499
500

/** Gets the subtype at position pos, 0 <= pos < n_subtype. */
501
type   *get_class_subtype   (type *clss, int pos);
502

Götz Lindenmaier's avatar
Götz Lindenmaier committed
503
504
505
506
507
508
/** Returns the index to access subclass as subtype of class.
 *
 *  If subclass is no direct subtype of class returns -1.
 */
int get_class_subtype_index(type *clss, const type *subclass);

Michael Beck's avatar
Michael Beck committed
509
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
510
511
512
 *
 *  Does not set the corresponding supertype relation for subtype: this might
 *  be a different position! */
513
void    set_class_subtype   (type *clss, type *subtype, int pos);
514
515

/** Finds subtype in the list of subtypes and removes it  */
516
517
void    remove_class_subtype(type *clss, type *subtype);

Michael Beck's avatar
Michael Beck committed
518
519
520
521
522
523
524
/* 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)
525

526
/** Adds supertype as supertype to class.
527
528
529
 *
 *  Checks whether clss is a subtype of supertype.  If not
 *  adds also clss as subtype to supertype.  */
530
void    add_class_supertype   (type *clss, type *supertype);
531
532

/** Returns the number of supertypes */
Michael Beck's avatar
Michael Beck committed
533
int     get_class_n_supertypes (const type *clss);
534

Götz Lindenmaier's avatar
Götz Lindenmaier committed
535
536
537
538
/** Returns the index to access superclass as supertype of class.
 *
 *  If superclass is no direct supertype of class returns -1.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
539
int     get_class_supertype_index(type *clss, type *super_clss);
540
541

/** Gets the supertype at position pos,  0 <= pos < n_supertype. */
542
type   *get_class_supertype   (type *clss, int pos);
543

544
545
546
547
/** 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! */
548
void    set_class_supertype   (type *clss, type *supertype, int pos);
549
550

/** Finds supertype in the list of supertypes and removes it */
551
void    remove_class_supertype(type *clss, type *supertype);
552

Michael Beck's avatar
Michael Beck committed
553
554
555
556
557
558
559
560
/** 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
561
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
562
typedef enum peculiarity {
563
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
Florian Liekweg's avatar
Florian Liekweg committed
564
565
                            allocated, no code/data exists for this entity/type.
                        @@@ eventually rename to descriptive (adjective as the others!)*/
566
  peculiarity_inherited,       /**< Describes explicitly that other entities are
Florian Liekweg's avatar
Florian Liekweg committed
567
568
569
570
571
572
                            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
573
  peculiarity_existent         /**< The entity/type (can) exist.
Florian Liekweg's avatar
Florian Liekweg committed
574
575
                    @@@ eventually rename to 'real' i.e., 'echt'
                        This serves better as opposition to description _and_ inherited.*/
576
} peculiarity;
Michael Beck's avatar
Michael Beck committed
577
const char *get_peculiarity_string(peculiarity p);
578

Michael Beck's avatar
Michael Beck committed
579
/** Returns the peculiarity of the class. */
Michael Beck's avatar
Michael Beck committed
580
peculiarity get_class_peculiarity (const type *clss);
Michael Beck's avatar
Michael Beck committed
581
/** Sets the peculiarity of the class. */
582
void        set_class_peculiarity (type *clss, peculiarity pec);
583

584
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
585
   @todo This is an undocumented field, subject to change! */
586
void set_class_dfn (type *clss, int dfn);
Michael Beck's avatar
Michael Beck committed
587
int  get_class_dfn (const type *clss);
588

589
/** Returns true if a type is a class type. */
590
int is_Class_type(const type *clss);
591

Sebastian Felis's avatar
Sebastian Felis committed
592
/**
Florian Liekweg's avatar
Florian Liekweg committed
593
 *  @page struct_type   Representation of a struct type
594
 *
595
596
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
597
598
599
600
 *  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
601
 *             type_pointer, type_primitive.
602
603
604
605
 *             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.
606
 */
607
/** Creates a new type struct */
608
type   *new_type_struct (ident *name);
609
/** Creates a new type struct with debug information. */
610
type   *new_d_type_struct (ident *name, dbg_info* db);
611

612
613
614
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
615
void    add_struct_member   (type *strct, entity *member);
616
617

/** Returns the number of members of this struct. */
Michael Beck's avatar
Michael Beck committed
618
int     get_struct_n_members (const type *strct);
619
620

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar
Michael Beck committed
621
entity *get_struct_member   (const type *strct, int pos);
622
623
624
625
626
627

/** Returns index of member in strct, -1 if not contained. */
int     get_struct_member_index(type *strct, entity *member);

/** Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
628
void    set_struct_member   (type *strct, int pos, entity *member);
629
630

/** Finds member in the list of members and removes it. */
631
void    remove_struct_member (type *strct, entity *member);
632

633
/** Returns true if a type is a struct type. */
634
int     is_Struct_type(const type *strct);
635

Sebastian Felis's avatar
Sebastian Felis committed
636
/**
Florian Liekweg's avatar
Florian Liekweg committed
637
 * @page method_type    Representation of a method type
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 *
 * 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.)
 *
654
655
656
657
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
658
659
660
661
662
663
 * - 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.)
664
665
666
667
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
668
669
 */

Michael Beck's avatar
Michael Beck committed
670
/* These macros define the suffixes for the types and entities used
671
672
673
674
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
675
676
/** Create a new method type.
 *
677
678
679
680
681
682
683
 * @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.
 */
684
type *new_type_method (ident *name, int n_param, int n_res);
685
686
687
688
689
690
691
692
693
694
695

/** 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.
 */
696
type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
697

698
699
700
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
Michael Beck's avatar
Michael Beck committed
701
int   get_method_n_params  (const type *method);
702
703

/** Returns the type of the parameter at position pos of a method. */
704
type *get_method_param_type(type *method, int pos);
705
706
707
/** 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. */
708
void  set_method_param_type(type *method, int pos, type* tp);
709
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
710
   for compounds passed by value. This information is constructed only on demand. */
711
entity *get_method_value_param_ent(type *method, int pos);
712
713
714
/**
 * Returns a type that represents the copied value arguments.
 */
Michael Beck's avatar
Michael Beck committed
715
type *get_method_value_param_type(const type *method);
716

Michael Beck's avatar
Michael Beck committed
717
/** Returns the number of results of a method type. */
Michael Beck's avatar
Michael Beck committed
718
int   get_method_n_ress   (const type *method);
Michael Beck's avatar
Michael Beck committed
719
/** Returns the return type of a method type at position pos. */
720
type *get_method_res_type(type *method, int pos);
721
722
723
/** 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. */
724
void  set_method_res_type(type *method, int pos, type* tp);
725
/** Returns an entity that represents the copied value result.  Only necessary
726
727
   for compounds passed by value. This information is constructed only on demand. */
entity *get_method_value_res_ent(type *method, int pos);
Michael Beck's avatar
Michael Beck committed
728

729
730
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
731
 */
Michael Beck's avatar
Michael Beck committed
732
type *get_method_value_res_type(const type *method);
733

Michael Beck's avatar
Michael Beck committed
734
/**
Michael Beck's avatar
Michael Beck committed
735
 * This enum flags the variadicity of methods (methods with a
736
737
738
739
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
740
741
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
742
743
} variadicity;

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

747
/** Returns the variadicity of a method. */
Michael Beck's avatar
Michael Beck committed
748
variadicity get_method_variadicity(const type *method);
749
750

/** Sets the variadicity of a method. */
751
752
void set_method_variadicity(type *method, variadicity vari);

753
754
755
756
757
758
/**
 * 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.
 */
Michael Beck's avatar
Michael Beck committed
759
int get_method_first_variadic_param_index(const type *method);
760
761
762
763
764
765
766
767
768

/**
 * 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.
 */
void set_method_first_variadic_param_index(type *method, int index);

769
/** Returns true if a type is a method type. */
770
int   is_Method_type     (const type *method);
771

Sebastian Felis's avatar
Sebastian Felis committed
772
/**
Florian Liekweg's avatar
Florian Liekweg committed
773
 *   @page union_type   Representation of a union type.
774
 *
775
 *   The union type represents union types.
776
777
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
778
779
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
780
 */
781
/** Creates a new type union. */
782
type   *new_type_union (ident *name);
783
784

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

787
788
789
/* --- manipulate private fields of struct --- */

/** Returns the number of unioned types of this union */
Michael Beck's avatar
Michael Beck committed
790
int     get_union_n_members      (const type *uni);
791
792

/** Adds a new entity to a union type */
793
void    add_union_member (type *uni, entity *member);
794
795

/** Returns the entity at position pos of a union */
Michael Beck's avatar
Michael Beck committed
796
entity *get_union_member (const type *uni, int pos);
797
798

/** Overwrites a entity at position pos in a union type. */
799
void    set_union_member (type *uni, int pos, entity *member);
800
801

/** Finds member in the list of members and removes it. */
802
void    remove_union_member (type *uni, entity *member);
803

804
/** Returns true if a type is a union type. */
805
int     is_Union_type          (const type *uni);
806

Sebastian Felis's avatar
Sebastian Felis committed
807
/**
Florian Liekweg's avatar
Florian Liekweg committed
808
 * @page array_type Representation of an array type
809
810
811
812
813
814
815
816
817
818
819
820
 *
 * The array type represents rectangular multi dimensional arrays.
 * The constants representing the bounds must be allocated to
 * get_const_code_irg() by setting current_ir_graph accordingly.
 *
 * - n_dimensions:    Number of array dimensions.
 * - *lower_bound:    Lower bounds of dimensions.  Usually all 0.
 * - *upper_bound:    Upper bounds or dimensions.
 * - *element_type:   The type of the array elements.
 * - *element_ent:    An entity for the array elements to be used for
 *                      element selection with Sel.
 * @todo
Michael Beck's avatar
Michael Beck committed
821
 *   Do we need several entities?  One might want
Michael Beck's avatar
Michael Beck committed
822
823
 *   to select a dimension and not a single element in case of multi
 *   dimensional arrays.
824
 */
825
826
827
828
829
830
831
832

/** Create a new type array.
 *
 * Sets n_dimension to dimension and all dimension entries to NULL.
 * Initializes order to the order of the dimensions.
 * The entity for array elements is built automatically.
 * Set dimension sizes after call to constructor with set_* routines.
 */
833
type *new_type_array         (ident *name, int n_dimensions,
Florian Liekweg's avatar
Florian Liekweg committed
834
                  type *element_type);
835
836
837
838
839
840
841

/** Create a new type array with debug information.
 *
 * Sets n_dimension to dimension and all dimension entries to NULL.
 * Initializes order to the order of the dimensions.
 * The entity for array elements is built automatically.
 * Set dimension sizes after call to constructor with set_* routines.
842
 * A legal array type must have at least one dimension set.
843
 */
844
type *new_d_type_array         (ident *name, int n_dimensions,
Florian Liekweg's avatar
Florian Liekweg committed
845
                  type *element_type, dbg_info* db);
846

847
848
849
/* --- manipulate private fields of array type --- */

/** Returns the number of array dimensions of this type. */
Michael Beck's avatar
Michael Beck committed
850
int   get_array_n_dimensions (const type *array);
851

Michael Beck's avatar
Michael Beck committed
852
853
/**
 * Allocates Const nodes of mode_I for one array dimension.
Michael Beck's avatar
Michael Beck committed
854
 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
Michael Beck's avatar
Michael Beck committed
855
 */
856
857
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
Michael Beck's avatar
Michael Beck committed
858
859
/**
 * Sets the bounds for one array dimension.
Michael Beck's avatar
Michael Beck committed
860
 * Upper bound in Firm is the element next to the last, i.e. [lower,upper[
Michael Beck's avatar
Michael Beck committed
861
 */
862
863
void  set_array_bounds       (type *array, int dimension, ir_node *lower_bound,
                                                          ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
864
/** Sets the lower bound for one array dimension, i.e. [lower,upper[ */
865
void  set_array_lower_bound  (type *array, int dimension, ir_node *lower_bound);
Michael Beck's avatar
Michael Beck committed
866
867

/** Allocates Const nodes of mode_I for the lower bound of an array
Michael Beck's avatar
Michael Beck committed
868
    dimension, i.e. [lower,upper[ */
869
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
Michael Beck's avatar
Michael Beck committed
870

Michael Beck's avatar
Michael Beck committed
871
/** Sets the upper bound for one array dimension, i.e. [lower,upper[ */
872
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
873
874

/** Allocates Const nodes of mode_I for the upper bound of an array
Michael Beck's avatar
Michael Beck committed
875
    dimension, i.e. [lower,upper[. */
Michael Beck's avatar
Michael Beck committed
876
877
void  set_array_upper_bound_int (type *array, int dimension, int upper_bound);

Michael Beck's avatar
Michael Beck committed
878
/** Returns true if lower bound != Unknown. */
Michael Beck's avatar
Michael Beck committed
879
int       has_array_lower_bound     (const type *array, int dimension);
Michael Beck's avatar
Michael Beck committed
880
/** Returns the lower bound of an array. */
Michael Beck's avatar
Michael Beck committed
881
ir_node * get_array_lower_bound     (const type *array, int dimension);
882
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
883
long      get_array_lower_bound_int (const type *array, int dimension);
884
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
885
int       has_array_upper_bound     (const type *array, int dimension);
Michael Beck's avatar
Michael Beck committed
886
/** Returns the upper bound of an array. */
Michael Beck's avatar
Michael Beck committed
887
ir_node * get_array_upper_bound     (const type *array, int dimension);
888
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
889
long      get_array_upper_bound_int (const type *array, int dimension);
890

Michael Beck's avatar
Michael Beck committed
891
/** Sets an array dimension to a specific order. */
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
892
void set_array_order (type *array, int dimension, int order);
Michael Beck's avatar
Michael Beck committed
893
894

/** Returns the order of an array dimension. */
Michael Beck's avatar
Michael Beck committed
895
int  get_array_order (const type *array, int dimension);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
896

Michael Beck's avatar
Michael Beck committed
897
898
899
900
/** Find the array dimension that is placed at order ord. */
int find_array_dimension(const type *array, int order);

/** Sets the array element type. */
901
void  set_array_element_type (type *array, type *tp);
Michael Beck's avatar
Michael Beck committed
902
903

/** Gets the array element type. */
904
905
type *get_array_element_type (type *array);

Michael Beck's avatar
Michael Beck committed
906
/** Sets the array element entity. */
907
void  set_array_element_entity (type *array, entity *ent);
Michael Beck's avatar
Michael Beck committed
908
909

/** Get the array element entity. */
Michael Beck's avatar
Michael Beck committed
910
entity *get_array_element_entity (const type *array);
911

912
/** Returns true if a type is an array type. */
913
int    is_Array_type(const type *array);
914

Sebastian Felis's avatar
Sebastian Felis committed
915
/**
Florian Liekweg's avatar
Florian Liekweg committed
916
 * @page enumeration_type   Representation of an enumeration type
917
 *
918
919
920
921
922
923
924
 * Enumeration types need not necessarily be represented explicitly
 * by Firm types, as the frontend can lower them to integer constants as
 * well.  For debugging purposes or similar tasks this information is useful.
 *
 * - *enum:         The target values representing the constants used to
 *                  represent individual enumerations.
 * - *enum_nameid:  Idents containing the source program name of the enumeration
Florian Liekweg's avatar
Florian Liekweg committed
925
 *                  constants
926
927
 */
/** Create a new type enumeration -- set the enumerators independently. */
928
type   *new_type_enumeration    (ident *name, int n_enums);
929
930

/** Create a new type enumeration with debug information -- set the enumerators independently. */
931
type   *new_d_type_enumeration    (ident *name, int n_enums, dbg_info* db);
932

933
934
935
/* --- manipulate fields of enumeration type. --- */

/** Returns the number of enumeration values of this enumeration */
Michael Beck's avatar
Michael Beck committed
936
int     get_enumeration_n_enums (const type *enumeration);
937

938
/** Sets the enumeration value at a given position. */
939
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
940
941

/** Returns the enumeration value at a given position. */
Michael Beck's avatar
Michael Beck committed
942
tarval *get_enumeration_enum    (const type *enumeration, int pos);
943

944
/** Assign an ident to an enumeration value at a given position. */
945
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
946
947

/** Returns the assigned ident of an enumeration value at a given position. */
Michael Beck's avatar
Michael Beck committed
948
ident  *get_enumeration_nameid  (const type *enumeration, int pos);
949
950

/** Returns the assigned name of an enumeration value at a given position. */
Michael Beck's avatar
Michael Beck committed
951
const char *get_enumeration_name(const type *enumeration, int pos);
952

953
/** Returns true if a type is a enumeration type. */