type.h 41.7 KB
Newer Older
Sebastian Felis's avatar
Sebastian Felis committed
1
/**
2
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
3
 * @file type.h
Michael Beck's avatar
Michael Beck committed
4
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
5
6
7
8
9
10
11
12
13
 * 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
14
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
15
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
 */
Boris Boesler's avatar
Boris Boesler committed
35

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

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

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

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

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

58
59
# include "tr_inheritance.h"

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

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

127
128
129
130
131
132
/** 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
133
134
135
136
137
138
/** 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
139
140
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
141
142
void        free_type(type *tp);

Michael Beck's avatar
Michael Beck committed
143
const tp_op*get_type_tpop(const type *tp);
Michael Beck's avatar
Michael Beck committed
144
145
146
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);
147

Michael Beck's avatar
Michael Beck committed
148
ident*      get_type_ident(const type *tp);
149
void        set_type_ident(type *tp, ident* id);
Michael Beck's avatar
Michael Beck committed
150
const char* get_type_name(const type *tp);
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/** 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.
				      For types:  entities of this type can be accessed externaly.  No
				      instances of this type are allocated externally.  */
  visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
  				      must not allocate memory for this entity. The entity must
				      be static_allocated.  This can also be an external defined
				      method.
				      For types:  entities of this type are allocated and accessed from
				      external code.  Default for types.  */
} 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.
 * I need to know, which fields of classes are accessed in the rts,
 * 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);



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

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

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

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

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

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

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

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

/** 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.
273
274
275
276
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
277
void        set_type_size_bits(type *tp, int size);
278

279
280
281
282
/** 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
283
int         get_type_alignment_bytes(type *tp);
284

285
286
287
288
289
290
291
292
293
/** 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:
 *  1.) if a type has a mode, the alignment is the mode size.
 *  2.) compound types have the alignment of it's biggest member.
 *  3.) array types have the alignment of its element type.
 *  4.) method types return 0 here.
 *  5.) all other types return 8 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 */
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);
308
void          set_type_visited(type *tp, unsigned long num);
309
/* Sets visited field in type to type_visited. */
310
void          mark_type_visited(type *tp);
Michael Beck's avatar
Michael Beck committed
311
312
/* @@@ name clash!! int           type_visited(const type *tp); */
int           type_not_visited(const type *tp);
313

Michael Beck's avatar
Michael Beck committed
314
void*         get_type_link(const type *tp);
315
void          set_type_link(type *tp, void *l);
316

Sebastian Felis's avatar
Sebastian Felis committed
317
/**
318
319
320
321
322
323
324
 * 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.
325
 *
Sebastian Felis's avatar
Sebastian Felis committed
326
 * @see  typewalk
327
 */
Christian Schäfer's avatar
Christian Schäfer committed
328
extern unsigned long type_visited;
329
void          set_master_type_visited(unsigned long val);
330
331
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
332
333

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

489

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

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

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
502
503
504
505
506
507
/** 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
508
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
509
510
511
 *
 *  Does not set the corresponding supertype relation for subtype: this might
 *  be a different position! */
512
void    set_class_subtype   (type *clss, type *subtype, int pos);
513
514

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

517

518
/** Adds supertype as supertype to class.
519
520
521
 *
 *  Checks whether clss is a subtype of supertype.  If not
 *  adds also clss as subtype to supertype.  */
522
void    add_class_supertype   (type *clss, type *supertype);
523
524

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
527
528
529
530
/** 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
531
int     get_class_supertype_index(type *clss, type *super_clss);
532
533

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

536
537
538
539
/** 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! */
540
void    set_class_supertype   (type *clss, type *supertype, int pos);
541
542

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

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

/* The peculiarity of the class.  The enumeration peculiarity is defined
   in entity.h */
Michael Beck's avatar
Michael Beck committed
565
peculiarity get_class_peculiarity (const type *clss);
566
void        set_class_peculiarity (type *clss, peculiarity pec);
567

568
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
569
   @todo This is an undocumented field, subject to change! */
570
void set_class_dfn (type *clss, int dfn);
Michael Beck's avatar
Michael Beck committed
571
int  get_class_dfn (const type *clss);
572

573
/** Returns true if a type is a class type. */
574
int is_Class_type(const type *clss);
575

Sebastian Felis's avatar
Sebastian Felis committed
576
/**
Florian Liekweg's avatar
Florian Liekweg committed
577
 *  @page struct_type   Representation of a struct type
578
 *
579
580
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
581
582
583
584
 *  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
585
 *             type_pointer, type_primitive.
586
587
588
589
 *             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.
590
 */
591
/** Creates a new type struct */
592
type   *new_type_struct (ident *name);
593
/** Creates a new type struct with debug information. */
594
type   *new_d_type_struct (ident *name, dbg_info* db);
595

596
597
598
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
599
void    add_struct_member   (type *strct, entity *member);
600
601

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

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar
Michael Beck committed
605
entity *get_struct_member   (const type *strct, int pos);
606
607
608
609
610
611

/** 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. */
612
void    set_struct_member   (type *strct, int pos, entity *member);
613
614

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

617
/** Returns true if a type is a struct type. */
618
int     is_Struct_type(const type *strct);
619

Sebastian Felis's avatar
Sebastian Felis committed
620
/**
Florian Liekweg's avatar
Florian Liekweg committed
621
 * @page method_type    Representation of a method type
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 *
 * 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.)
 *
638
639
640
641
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
642
643
644
645
646
647
 * - 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.)
648
649
650
651
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
652
653
 */

Michael Beck's avatar
Michael Beck committed
654
/* These macros define the suffixes for the types and entities used
655
656
657
658
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
659
660
/** Create a new method type.
 *
661
662
663
664
665
666
667
 * @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.
 */
668
type *new_type_method (ident *name, int n_param, int n_res);
669
670
671
672
673
674
675
676
677
678
679

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

682
683
684
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
Michael Beck's avatar
Michael Beck committed
685
int   get_method_n_params  (const type *method);
686
687

/** Returns the type of the parameter at position pos of a method. */
688
type *get_method_param_type(type *method, int pos);
689
690
691
/** 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. */
692
void  set_method_param_type(type *method, int pos, type* tp);
693
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
694
   for compounds passed by value. This information is constructed only on demand. */
695
entity *get_method_value_param_ent(type *method, int pos);
696
697
698
/**
 * Returns a type that represents the copied value arguments.
 */
Michael Beck's avatar
Michael Beck committed
699
type *get_method_value_param_type(const type *method);
700

Michael Beck's avatar
Michael Beck committed
701
int   get_method_n_ress   (const type *method);
702
type *get_method_res_type(type *method, int pos);
703
704
705
/** 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. */
706
void  set_method_res_type(type *method, int pos, type* tp);
707
/** Returns an entity that represents the copied value result.  Only necessary
708
709
   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
710

711
712
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
713
 */
Michael Beck's avatar
Michael Beck committed
714
type *get_method_value_res_type(const type *method);
715

Michael Beck's avatar
Michael Beck committed
716
/**
717
718
719
720
721
 * this enum flags the variadicity of methods (methods with a
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
722
723
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
724
725
} variadicity;

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

729
/** Returns the variadicity of a method. */
Michael Beck's avatar
Michael Beck committed
730
variadicity get_method_variadicity(const type *method);
731
732

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

735
736
737
738
739
740
/**
 * 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
741
int get_method_first_variadic_param_index(const type *method);
742
743
744
745
746
747
748
749
750

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

751
/** Returns true if a type is a method type. */
752
int   is_Method_type     (const type *method);
753

Sebastian Felis's avatar
Sebastian Felis committed
754
/**
Florian Liekweg's avatar
Florian Liekweg committed
755
 *   @page union_type   Representation of a union type.
756
 *
757
 *   The union type represents union types.
758
759
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
760
761
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
762
 */
763
/** Creates a new type union. */
764
type   *new_type_union (ident *name);
765
766

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

769
770
771
/* --- manipulate private fields of struct --- */

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

/** Adds a new entity to a union type */
775
void    add_union_member (type *uni, entity *member);
776
777

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

/** Overwrites a entity at position pos in a union type. */
781
void    set_union_member (type *uni, int pos, entity *member);
782
783

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

786
/** Returns true if a type is a union type. */
787
int     is_Union_type          (const type *uni);
788

Sebastian Felis's avatar
Sebastian Felis committed
789
/**
Florian Liekweg's avatar
Florian Liekweg committed
790
 * @page array_type Representation of an array type
791
792
793
794
795
796
797
798
799
800
801
802
 *
 * 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
803
 *   Do we need several entities?  One might want
Michael Beck's avatar
Michael Beck committed
804
805
 *   to select a dimension and not a single element in case of multi
 *   dimensional arrays.
806
 */
807
808
809
810
811
812
813
814

/** 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.
 */
815
type *new_type_array         (ident *name, int n_dimensions,
Florian Liekweg's avatar
Florian Liekweg committed
816
                  type *element_type);
817
818
819
820
821
822
823

/** 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.
824
 * A legal array type must have at least one dimension set.
825
 */
826
type *new_d_type_array         (ident *name, int n_dimensions,
Florian Liekweg's avatar
Florian Liekweg committed
827
                  type *element_type, dbg_info* db);
828

829
830
831
/* --- manipulate private fields of array type --- */

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

Michael Beck's avatar
Michael Beck committed
834
835
836
837
/**
 * Allocates Const nodes of mode_I for one array dimension.
 * Upper bound in Firm is the element next to the last, ie [lower,upper[
 */
838
839
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
Michael Beck's avatar
Michael Beck committed
840
841
842
843
/**
 * Sets the bounds for one array dimension.
 * Upper bound in Firm is the element next to the last, ie [lower,upper[
 */
844
845
void  set_array_bounds       (type *array, int dimension, ir_node *lower_bound,
                                                          ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
846
/** Sets the lower bound for one array dimension, ie [lower,upper[ */
847
void  set_array_lower_bound  (type *array, int dimension, ir_node *lower_bound);
Michael Beck's avatar
Michael Beck committed
848
849
850

/** Allocates Const nodes of mode_I for the lower bound of an array
    dimension, ie [lower,upper[ */
851
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
Michael Beck's avatar
Michael Beck committed
852
853

/** Sets the upper bound for one array dimension, ie [lower,upper[ */
854
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
855
856
857
858
859

/** Allocates Const nodes of mode_I for the upper bound of an array
    dimension, ie [lower,upper[ */
void  set_array_upper_bound_int (type *array, int dimension, int upper_bound);

860
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
861
862
int       has_array_lower_bound     (const type *array, int dimension);
ir_node * get_array_lower_bound     (const type *array, int dimension);
863
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
864
long      get_array_lower_bound_int (const type *array, int dimension);
865
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
866
867
int       has_array_upper_bound     (const type *array, int dimension);
ir_node * get_array_upper_bound     (const type *array, int dimension);
868
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
869
long      get_array_upper_bound_int (const type *array, int dimension);
870

Michael Beck's avatar
Michael Beck committed
871
/** Sets an array dimension to a specific order. */
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
872
void set_array_order (type *array, int dimension, int order);
Michael Beck's avatar
Michael Beck committed
873
874

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

Michael Beck's avatar
Michael Beck committed
877
878
879
880
/** Find the array dimension that is placed at order ord. */
int find_array_dimension(const type *array, int order);

/** Sets the array element type. */
881
void  set_array_element_type (type *array, type *tp);
Michael Beck's avatar
Michael Beck committed
882
883

/** Gets the array element type. */
884
885
type *get_array_element_type (type *array);

Michael Beck's avatar
Michael Beck committed
886
/** Sets the array element entity. */
887
void  set_array_element_entity (type *array, entity *ent);
Michael Beck's avatar
Michael Beck committed
888
889

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

892
/** Returns true if a type is an array type. */
893
int    is_Array_type(const type *array);
894

Sebastian Felis's avatar
Sebastian Felis committed
895
/**
Florian Liekweg's avatar
Florian Liekweg committed
896
 * @page enumeration_type   Representation of an enumeration type
897
 *
898
899
900
901
902
903
904
 * 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
905
 *                  constants
906
907
 */
/** Create a new type enumeration -- set the enumerators independently. */
908
type   *new_type_enumeration    (ident *name, int n_enums);
909
910

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

913
914
915
/* --- manipulate fields of enumeration type. --- */

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

918
/** Sets the enumeration value at a given position. */
919
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
920
921

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

924
/** Assign an ident to an enumeration value at a given position. */
925
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
926
927

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

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

933
/** Returns true if a type is a enumeration type. */
934
int     is_Enumeration_type     (const type *enumeration);
935

Sebastian Felis's avatar
Sebastian Felis committed
936
/**
Florian Liekweg's avatar
Florian Liekweg committed
937
 * @page pointer_type   Representation of a pointer type
938
 *
939
940
 * The mode of the pointer type must be a mode_reference.
 *
941
942
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
943
 */
Christian Schäfer's avatar
Christian Schäfer committed
944

945
/** Creates a new type pointer with mode mode_p. */
946
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
947
948
949
950
951
952

/** Creates a new type pointer with given pointer mode. */
type *new_type_pointer_mode      (ident *name, type *points_to, ir_mode *ptr_mode);

/** Creates a new type pointer given pointer mode and with debug information. */
type *new_d_type_pointer         (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
953
954
955
956

/* --- manipulate fields of type_pointer --- */

/** Sets the type to which a pointer points to. */
957
void  set_pointer_points_to_type (type *pointer, type *tp);
958
959

/** Returns the type to which a pointer points to. */
960
961
type *get_pointer_points_to_type (type *pointer);

962
/** Returns true if a type is a pointer type. */
963
int   is_Pointer_type            (const type *pointer);
964

965
966
967
968
969
/** Returns the first pointer type that has as points_to tp.
 *  Not efficient: O(#types).
 *  If not found returns unknown_type. */
type *find_pointer_type_to_type (type *tp);

Sebastian Felis's avatar
Sebastian Felis committed
970
/**
971
972
973
974
975
 * @page primitive_type Representation of a primitive type
 *
 * Primitive types are types that represent indivisible data values that
 * map directly to modes.  They don't have a private attribute.  The
 * important information they carry is held in the common mode field.
Christian Schäfer's avatar
Christian Schäfer committed
976
*/
977
/** Creates a new primitive type. */
978
type *new_type_primitive (ident *name, ir_mode *mode);
Michael Beck's avatar