type.h 50.3 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_

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

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

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
111
112
# include "type_or_entity.h"

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

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
119
120
121
122
123
124
/** 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
125
126
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
127
void        free_type(ir_type *tp);
128

129
130
131
132
const tp_op*get_type_tpop(const ir_type *tp);
ident*      get_type_tpop_nameid(const ir_type *tp);
const char* get_type_tpop_name(const ir_type *tp);
tp_opcode   get_type_tpop_code(const ir_type *tp);
133

134
135
136
ident*      get_type_ident(const ir_type *tp);
void        set_type_ident(ir_type *tp, ident* id);
const char* get_type_name(const ir_type *tp);
137

138
139
140
141
142
143
144
145
146
147
148
149
150
151
/** 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
152
				      For types:  entities of this type can be accessed externally.  No
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
				      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
182
 * I need to know, which fields of classes are accessed in the RTS,
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 * 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.
 */
200
201
visibility get_type_visibility (const ir_type *tp);
void       set_type_visibility (ir_type *tp, visibility v);
202
203
204



205
/** The state of the type layout. */
206
typedef enum {
Michael Beck's avatar
Michael Beck committed
207
  layout_undefined,    /**< The layout of this type is not defined.
Florian Liekweg's avatar
Florian Liekweg committed
208
209
210
211
              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
212
  layout_fixed         /**< The layout is fixed, all component/member entities
Florian Liekweg's avatar
Florian Liekweg committed
213
214
215
216
              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.  */
217
} type_state;
218

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

222
/** Returns the type layout state of a type. */
223
type_state  get_type_state(const ir_type *tp);
224
225
226
227
228
229

/** 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.
 */
230
void        set_type_state(ir_type *tp, type_state state);
231

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

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

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

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

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

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

265
266
267
268
/** 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(). */
269
int         get_type_alignment_bytes(ir_type *tp);
270

271
272
273
274
/** 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
275
276
277
278
279
 *  -#.) 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
280
 */
281
int         get_type_alignment_bits(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
282
283

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

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

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

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

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

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

Sebastian Felis's avatar
Sebastian Felis committed
331
/**
Florian Liekweg's avatar
Florian Liekweg committed
332
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
333
 *
334
335
 *   @param typ1  the first type
 *   @param typ2  the second type
Michael Beck's avatar
Michael Beck committed
336
337
338
 *
 *   @return
 *    true if the types are equal, else false.
339
340
 *
 *   Types are equal if :
341
342
343
344
 *    - 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
345
 *    - they are class types and have:
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 *      - 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
364
 *       This is to avoid endless recursions; with pointer types cyclic
365
366
 *       type graphs are possible.)
 */
367
int equal_type(ir_type *typ1, ir_type *typ2);
368

Sebastian Felis's avatar
Sebastian Felis committed
369
370
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
371
372
373
374
375
376
377
378
 *
 *   @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
379
380
381
382
383
384
385
386
387
388
389
 *    - 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
390
 *      @return counterpart in lt and the type is smaller
391
392
393
394
395
 *    - 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
396
 *      @return or
397
398
399
400
 *      - 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
401
402
 *      @return smaller than the points_to type of lt.
 *
403
 */
404
int smaller_type (ir_type *st, ir_type *lt);
405

Sebastian Felis's avatar
Sebastian Felis committed
406
/**
Florian Liekweg's avatar
Florian Liekweg committed
407
 *  @page class_type    Representation of a class type
408
 *
409
410
411
412
 *  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???
413
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
414
 *  - member:     All entities belonging to this class.  This are method entities
415
416
417
 *                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.
418
 *
419
420
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
421
 *
422
 *  - subtypes:    A list of direct subclasses.
423
 *
424
 *  - supertypes:  A list of direct superclasses.
425
 *
426
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
427
 *                 "description" it only is a description of requirements to a class,
428
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
429
 *                 Peculiarity inherited is only possible for entities.  An entity
430
431
432
433
 *                 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.
434
 *
435
436
437
438
439
440
441
442
443
444
445
 *  - type_info:   An entity representing the type information of this class.
 *                 This entity can be of arbitrari type, Firm did not use it yet.
 *                 It allows to express the coupling of a type with an entity
 *                 representing this type.  This information is useful for lowering
 *                 of InstOf and TypeChk nodes.  Default: NULL
 *
 *  - final:       A final class is always a leaf in the class hierarchy.  Final
 *                 classes cannot be super classes of other ones.  As this information
 *                 can only be computed in whole world compilations, we allow to
 *                 set this flag.  It is used in optimizations if get_opt_closed_world()
 *                 is false.  Default:  false
446
 */
447
448

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

/** Creates a new class type with debug information. */
452
ir_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   (ir_type *clss, entity *member);
458
459

/** Returns the number of members of this class. */
460
int     get_class_n_members (const ir_type *clss);
461
462

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
465
/** Returns index of mem in clss, -1 if not contained. */
466
int     get_class_member_index(const ir_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. */
470
entity *get_class_member_by_name(ir_type *clss, ident *name);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
471

472
/** Overwrites the member at position pos, 0 <= pos < n_member with
473
 *  the passed entity. */
474
void    set_class_member   (ir_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  (ir_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(ir_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   (ir_type *clss, ir_type *subtype);
495
496

/** Returns the number of subtypes */
497
int     get_class_n_subtypes (const ir_type *clss);
498
499

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

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

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   (ir_type *clss, ir_type *subtype, int pos);
513
514

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

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

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

/** Returns the number of supertypes */
532
int     get_class_n_supertypes (const ir_type *clss);
533

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
586
/** Returns the peculiarity of the class. */
587
peculiarity get_class_peculiarity (const ir_type *clss);
Michael Beck's avatar
Michael Beck committed
588
/** Sets the peculiarity of the class. */
589
void        set_class_peculiarity (ir_type *clss, peculiarity pec);
590

591
592
593
594
595
596
597
598
599
600
601
602
/** Returns the type info entity of a class. */
entity *get_class_type_info(const ir_type *clss);

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

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

/** Sets if a class is final. */
void set_class_final(ir_type *clss, int final);

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

608
/** Returns true if a type is a class type. */
609
int is_Class_type(const ir_type *clss);
610

Sebastian Felis's avatar
Sebastian Felis committed
611
/**
Florian Liekweg's avatar
Florian Liekweg committed
612
 *  @page struct_type   Representation of a struct type
613
 *
614
615
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
616
617
618
619
 *  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
620
 *             type_pointer, type_primitive.
621
622
623
624
 *             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.
625
 */
626
/** Creates a new type struct */
627
ir_type *new_type_struct (ident *name);
628
/** Creates a new type struct with debug information. */
629
ir_type *new_d_type_struct (ident *name, dbg_info* db);
630

631
632
633
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
634
void    add_struct_member   (ir_type *strct, entity *member);
635
636

/** Returns the number of members of this struct. */
637
int     get_struct_n_members (const ir_type *strct);
638
639

/** Returns the member at position pos, 0 <= pos < n_member */
640
entity *get_struct_member   (const ir_type *strct, int pos);
641
642

/** Returns index of member in strct, -1 if not contained. */
643
int     get_struct_member_index(const ir_type *strct, entity *member);
644
645
646

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

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

652
/** Returns true if a type is a struct type. */
653
int     is_Struct_type(const ir_type *strct);
654

Sebastian Felis's avatar
Sebastian Felis committed
655
/**
Florian Liekweg's avatar
Florian Liekweg committed
656
 * @page method_type    Representation of a method type
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
 *
 * 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.)
 *
673
674
675
676
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
677
678
679
680
681
682
 * - 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.)
683
684
685
686
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
687
688
 */

Michael Beck's avatar
Michael Beck committed
689
/* These macros define the suffixes for the types and entities used
690
691
692
693
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
694
695
/** Create a new method type.
 *
696
697
698
699
700
701
702
 * @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.
 */
703
ir_type *new_type_method (ident *name, int n_param, int n_res);
704
705
706
707
708
709
710
711
712
713
714

/** 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.
 */
715
ir_type *new_d_type_method (ident *name, int n_param, int n_res, dbg_info* db);
716

717
718
719
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
720
int   get_method_n_params  (const ir_type *method);
721
722

/** Returns the type of the parameter at position pos of a method. */
723
ir_type *get_method_param_type(ir_type *method, int pos);
724
725
726
/** 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. */
727
void  set_method_param_type(ir_type *method, int pos, ir_type *tp);
728
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
729
   for compounds passed by value. This information is constructed only on demand. */
730
entity *get_method_value_param_ent(ir_type *method, int pos);
731
732
733
/**
 * Returns a type that represents the copied value arguments.
 */
734
ir_type *get_method_value_param_type(const ir_type *method);
735

Michael Beck's avatar
Michael Beck committed
736
/** Returns the number of results of a method type. */
737
int   get_method_n_ress   (const ir_type *method);
Michael Beck's avatar
Michael Beck committed
738
/** Returns the return type of a method type at position pos. */
739
ir_type *get_method_res_type(ir_type *method, int pos);
740
741
742
/** 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. */
743
void  set_method_res_type(ir_type *method, int pos, ir_type *tp);
744
/** Returns an entity that represents the copied value result.  Only necessary
745
   for compounds passed by value. This information is constructed only on demand. */
746
entity *get_method_value_res_ent(ir_type *method, int pos);
Michael Beck's avatar
Michael Beck committed
747

748
749
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
750
 */
751
ir_type *get_method_value_res_type(const ir_type *method);
752

Michael Beck's avatar
Michael Beck committed
753
/**
Michael Beck's avatar
Michael Beck committed
754
 * This enum flags the variadicity of methods (methods with a
755
756
757
758
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
759
760
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
761
762
} variadicity;

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

766
/** Returns the variadicity of a method. */
767
variadicity get_method_variadicity(const ir_type *method);
768
769

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

772
773
774
775
776
777
/**
 * 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.
 */
778
int get_method_first_variadic_param_index(const ir_type *method);
779
780
781
782
783
784
785

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

788
789
790
791
792
793
794
/**
 * additional method type properties:
 *  Tell about special properties of a method type. Some
 *  of these may be discovered by analyses.
 */
typedef enum {
  mtp_no_property        = 0x00000000, /**< no additional properties, default */
Michael Beck's avatar
Michael Beck committed
795
  mtp_property_const     = 0x00000001, /**< This method did not access memory and calculates
796
797
                                         its return values solely from its parameters.
                                         GCC: __attribute__((const)). */
Michael Beck's avatar
Michael Beck committed
798
  mtp_property_pure      = 0x00000002, /**< This method did NOT write to memory and calculates
799
800
801
                                         its return values solely form its parameters and
                                         the memory they points to (or global vars).
                                         GCC: __attribute__((pure)). */
Michael Beck's avatar
Michael Beck committed
802
  mtp_property_noreturn  = 0x00000004, /**< This method did not return due to an aborting system
803
804
                                         call.
                                         GCC: __attribute__((noreturn)). */
Michael Beck's avatar
Michael Beck committed
805
  mtp_property_nothrow   = 0x00000008, /**< This method cannot throw an exception.
806
                                         GCC: __attribute__((nothrow)). */
Michael Beck's avatar
Michael Beck committed
807
  mtp_property_naked     = 0x00000010, /**< This method is naked.
808
                                         GCC: __attribute__((naked)). */
Michael Beck's avatar
Michael Beck committed
809
  mtp_property_malloc    = 0x00000020, /**< This method returns newly allocate memory.
810
                                         GCC: __attribute__((malloc)). */
811
812
  mtp_property_intrinsic = 0x00000040, /**< This method is intrinsic. It is expected that
                                         a lowering phase will remove all calls to it. */
Michael Beck's avatar
Michael Beck committed
813
  mtp_property_inherited = 0x40000000  /**< used only in irg's, means property is inherited
814
815
816
817
                                         from type. */
} mtp_additional_property;

/** Returns the mask of the additional graph properties. */
818
unsigned get_method_additional_properties(const ir_type *method);
819
820

/** Sets the mask of the additional graph properties. */
821
void set_method_additional_properties(ir_type *method, unsigned property_mask);
822
823

/** Sets one additional graph property. */
824
void set_method_additional_property(ir_type *method, mtp_additional_property flag);
825
826

/**
827
828
 * calling conventions: lower 24 bits are the number of register parameters,
 * upper 8 encode the calling conventions
829
830
 */
typedef enum {
831
  cc_reg_param        = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
832
                                         This flag may be set as default on some architectures. */
833
834
835
836
837
  cc_last_on_top      = 0x02000000, /**< The last non-register parameter is transmitted on top of
                                             the stack. This is equivalent to the stdcall or pascal
                                             calling convention. If this flag is not set, the first
                                             non-register parameter is used (cdecl calling convention) */
  cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
838
                                         function calls (stdcall). */
839
  cc_this_call        = 0x08000000, /**< The first parameter is a this pointer and is transmitted
840
841
                                         in a special way. */

842

843
  cc_bits             = (0xFF << 24)  /**< the calling convention bits */
844
845
} calling_convention;

846
847
848
849
850
851
852
853
/* some often used cases: made as defines for firmjni */
/** cdecl calling convention */
#define cc_cdecl_set    (0)
/** stdcall calling convention */
#define cc_stdcall_set  cc_callee_clear_stk
/** fastcall calling convention */
#define cc_fastcall_set (cc_reg_param|cc_callee_clear_stk)

Michael Beck's avatar
Michael Beck committed
854
855
856
/** return the default calling convention for method types */
unsigned get_default_cc_mask(void);

857
858
859
/**
 * check for the CDECL calling convention
 */
860
#define IS_CDECL(cc_mask)     (((cc_mask) & cc_bits) == cc_cdecl_set)
861
862
863
864

/**
 * check for the STDCALL calling convention
 */
865
#define IS_STDCALL(cc_mask)   (((cc_mask) & cc_bits) == cc_stdcall_set)
866
867
868
869

/**
 * check for the FASTCALL calling convention
 */
870
#define IS_FASTCALL(cc_mask)  (((cc_mask) & cc_bits) == cc_fastcall_set)
871
872

/**
873
 * set the CDECL convention bits
874
 */
875
#define SET_CDECL(cc_mask)    (((cc_mask) & ~cc_bits) | cc_cdecl_set)
876
877

/**
878
 * set the STDCALL convention bits
879
 */
880
#define SET_STDCALL(cc_mask)  (((cc_mask) & ~cc_bits) | cc_stdcall_set)
881
882

/**
883
 * set the FASTCALL convention bits
884
 */
885
#define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
886
887

/** Returns the calling convention of an entities graph. */
888
unsigned get_method_calling_convention(const ir_type *method);
889
890

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

893
/** Returns the number of registers parameters, 0 means default. */
894
unsigned get_method_n_regparams(ir_type *method);
895

896
/** Sets the number of registers parameters, 0 means default. */
897
void set_method_n_regparams(ir_type *method, unsigned n_regs);
898

899
/** Returns true if a type is a method type. */
900
int   is_Method_type     (const ir_type *method);
901

Sebastian Felis's avatar
Sebastian Felis committed
902
/**
903
 *   @page union_type   Representation of a union (variant) type.
904
 *
905
 *   The union type represents union types.
906
907
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
908
909
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
910
 */
911
/** Creates a new type union. */
912
ir_type   *new_type_union (ident *name);
913
914

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

917
918
919
/* --- manipulate private fields of struct --- */

/** Returns the number of unioned types of this union */
920
int     get_union_n_members      (const ir_type *uni);
921
922

/** Adds a new entity to a union type */
923
void    add_union_member (ir_type *uni, entity *member);
924
925

/** Returns the entity at position pos of a union */
926
entity *get_union_member (const ir_type *uni, int pos);
927

928
929
930
/** Returns index of member in uni, -1 if not contained. */
int     get_union_member_index(const ir_type *uni, entity *member);

931
/** Overwrites a entity at position pos in a union type. */
932
void    set_union_member (ir_type *uni, int pos, entity *member);
933
934

/** Finds member in the list of members and removes it. */
935
void    remove_union_member (ir_type *uni, entity *member);
936

937
/** Returns true if a type is a union type. */
938
int     is_Union_type          (const ir_type *uni);
939

Sebastian Felis's avatar
Sebastian Felis committed
940
/**
Florian Liekweg's avatar
Florian Liekweg committed
941
 * @page array_type Representation of an array type
942
943
944
945
946
947
948
949
950
951
952
953
 *
 * 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
954
 *   Do we need several entities?  One might want