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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
112
113
114
115
/** Frees all entities associated with a type.
 *  Does not free the array entity.
 *  Warning: ensure these entities are not referenced anywhere else.
 */
116
void        free_type_entities(ir_type *tp);
117

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

128
129
130
131
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);
132

133
134
135
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);
136

137
138
139
140
141
142
143
/** 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
Michael Beck's avatar
Michael Beck committed
144
145
146
147
                                      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. */
148
  visibility_external_visible,   /**< The entity is visible to other external program parts, but
Michael Beck's avatar
Michael Beck committed
149
150
151
152
                                      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 externally.  No
                                      instances of this type are allocated externally.  */
153
  visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
Michael Beck's avatar
Michael Beck committed
154
155
156
157
158
                                      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.  */
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
} 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
181
 * I need to know, which fields of classes are accessed in the RTS,
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 * 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.
 */
199
200
visibility get_type_visibility (const ir_type *tp);
void       set_type_visibility (ir_type *tp, visibility v);
201
202
203



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
292
/** Returns the visited count of a type. */
293
unsigned long get_type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
294
/** Sets the visited count of a type to num. */
295
void          set_type_visited(ir_type *tp, unsigned long num);
Michael Beck's avatar
Michael Beck committed
296
/** Sets visited field in type to type_visited. */
297
void          mark_type_visited(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
298
/** Returns non-zero if the type is already visited */
299
int           type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
300
/** Returns non-zero if the type is not yet visited */
301
int           type_not_visited(const ir_type *tp);
302

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

Sebastian Felis's avatar
Sebastian Felis committed
308
/**
309
310
 * Visited flag to traverse the type information.
 *
311
312
 * Increase this flag by one before traversing the type information
 * using inc_master_type_visited().
313
314
315
 * 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).
316
 * Or use the function to walk all types.
317
 *
Sebastian Felis's avatar
Sebastian Felis committed
318
 * @see  typewalk
319
 */
320
void          set_master_type_visited(unsigned long val);
321
322
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
323
324

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

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

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

Sebastian Felis's avatar
Sebastian Felis committed
409
/**
Florian Liekweg's avatar
Florian Liekweg committed
410
 *  @page class_type    Representation of a class type
411
 *
412
413
414
 *  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.
415
 *
416
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
417
 *  - member:     All entities belonging to this class.  This are method entities
418
419
420
 *                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.
421
 *
422
423
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
424
 *
425
 *  - subtypes:    A list of direct subclasses.
426
 *
427
 *  - supertypes:  A list of direct superclasses.
428
 *
429
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
430
 *                 "description" it only is a description of requirements to a class,
431
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
432
 *                 Peculiarity inherited is only possible for entities.  An entity
433
434
435
436
 *                 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.
437
 *
438
439
440
441
442
443
 *  - 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
 *
444
 *  - vtable_size: The size of this class virtual function table.
445
446
 *                 Default:  0
 *
447
448
449
450
451
 *  - 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
452
453
454
455
456
457
458
459
460
461
 *
 *  - interface:   The class represents an interface.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
 *
 *  - abstract :   The class represents an abstract class.  This flag can be set to distinguish
 *                 between interfaces, abstract classes and other classes that all may
 *                 have the peculiarity peculiarity_description.  Depending on this flag
 *                 the lowering might do different actions.  Default:  false
462
 */
463
464

/** Creates a new class type. */
465
ir_type *new_type_class (ident *name);
466
467

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

470
471
472
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
473
void    add_class_member   (ir_type *clss, entity *member);
474
475

/** Returns the number of members of this class. */
476
int     get_class_n_members (const ir_type *clss);
477
478

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

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

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

488
/** Overwrites the member at position pos, 0 <= pos < n_member with
489
 *  the passed entity. */
490
void    set_class_member   (ir_type *clss, entity *member, int pos);
491
492

/** Replaces complete member list in class type by the list passed.
493
494
495
496
 *
 *  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. */
497
void    set_class_members  (ir_type *clss, entity *members[], int arity);
498
499

/** Finds member in the list of members and removes it.
500
501
502
 *
 *  Shrinks the member list, so iterate from the end!!!
 *  Does not deallocate the entity.  */
503
void    remove_class_member(ir_type *clss, entity *member);
504

505

506
/** Adds subtype as subtype to clss.
507
508
509
 *
 *  Checks whether clss is a supertype of subtype.  If not
 *  adds also clss as supertype to subtype.  */
510
void    add_class_subtype   (ir_type *clss, ir_type *subtype);
511
512

/** Returns the number of subtypes */
513
int     get_class_n_subtypes (const ir_type *clss);
514
515

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
518
519
520
521
/** Returns the index to access subclass as subtype of class.
 *
 *  If subclass is no direct subtype of class returns -1.
 */
522
int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
523

Michael Beck's avatar
Michael Beck committed
524
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
525
526
527
 *
 *  Does not set the corresponding supertype relation for subtype: this might
 *  be a different position! */
528
void    set_class_subtype   (ir_type *clss, ir_type *subtype, int pos);
529
530

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

Michael Beck's avatar
Michael Beck committed
533
534
535
536
537
538
539
/* 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)
540

541
/** Adds supertype as supertype to class.
542
543
544
 *
 *  Checks whether clss is a subtype of supertype.  If not
 *  adds also clss as subtype to supertype.  */
545
void    add_class_supertype   (ir_type *clss, ir_type *supertype);
546
547

/** Returns the number of supertypes */
548
int     get_class_n_supertypes (const ir_type *clss);
549

Götz Lindenmaier's avatar
Götz Lindenmaier committed
550
551
552
553
/** Returns the index to access superclass as supertype of class.
 *
 *  If superclass is no direct supertype of class returns -1.
 */
554
int     get_class_supertype_index(ir_type *clss, ir_type *super_clss);
555
556

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

559
560
561
562
/** 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! */
563
void    set_class_supertype   (ir_type *clss, ir_type *supertype, int pos);
564
565

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

568
569
570
571
572
573
574
575
/** 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
576
577
578
579
580
581
582
583
/** 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
584
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
585
typedef enum peculiarity {
586
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
Florian Liekweg's avatar
Florian Liekweg committed
587
588
                            allocated, no code/data exists for this entity/type.
                        @@@ eventually rename to descriptive (adjective as the others!)*/
589
  peculiarity_inherited,       /**< Describes explicitly that other entities are
Florian Liekweg's avatar
Florian Liekweg committed
590
591
592
593
594
595
                            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
596
  peculiarity_existent         /**< The entity/type (can) exist.
Florian Liekweg's avatar
Florian Liekweg committed
597
598
                    @@@ eventually rename to 'real' i.e., 'echt'
                        This serves better as opposition to description _and_ inherited.*/
599
} peculiarity;
600
601

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

Michael Beck's avatar
Michael Beck committed
604
/** Returns the peculiarity of the class. */
605
peculiarity get_class_peculiarity (const ir_type *clss);
Michael Beck's avatar
Michael Beck committed
606
/** Sets the peculiarity of the class. */
607
void        set_class_peculiarity (ir_type *clss, peculiarity pec);
608

609
610
611
612
613
614
/** 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);

615
616
617
618
619
620
/** Returns the size of the virtual function table. */
unsigned get_class_vtable_size(const ir_type *clss);

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

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

624
/** Sets the class final flag. */
625
void set_class_final(ir_type *clss, int flag);
626

627
628
629
630
631
632
633
634
635
636
637
638
639
/** Return non-zero if a class is an interface */
int is_class_interface(const ir_type *clss);

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

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

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

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

644
/** Returns true if a type is a class type. */
645
int is_Class_type(const ir_type *clss);
646

Sebastian Felis's avatar
Sebastian Felis committed
647
/**
Florian Liekweg's avatar
Florian Liekweg committed
648
 *  @page struct_type   Representation of a struct type
649
 *
650
 *  A struct type represents aggregate types that consist of a list
651
 *  of fields.
652
 *
653
654
655
656
 *  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
657
 *             type_pointer, type_primitive.
658
659
660
661
 *             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.
662
 */
663
/** Creates a new type struct */
664
ir_type *new_type_struct (ident *name);
665
/** Creates a new type struct with debug information. */
666
ir_type *new_d_type_struct (ident *name, dbg_info* db);
667

668
669
670
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
671
void    add_struct_member   (ir_type *strct, entity *member);
672
673

/** Returns the number of members of this struct. */
674
int     get_struct_n_members (const ir_type *strct);
675
676

/** Returns the member at position pos, 0 <= pos < n_member */
677
entity *get_struct_member   (const ir_type *strct, int pos);
678
679

/** Returns index of member in strct, -1 if not contained. */
680
int     get_struct_member_index(const ir_type *strct, entity *member);
681
682
683

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

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

689
/** Returns true if a type is a struct type. */
690
int     is_Struct_type(const ir_type *strct);
691

Sebastian Felis's avatar
Sebastian Felis committed
692
/**
Florian Liekweg's avatar
Florian Liekweg committed
693
 * @page method_type    Representation of a method type
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 *
 * 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.)
 *
710
711
712
713
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
714
715
716
717
718
719
 * - 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.)
720
721
722
723
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
724
725
 */

Michael Beck's avatar
Michael Beck committed
726
/* These macros define the suffixes for the types and entities used
727
728
729
730
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
731
732
/** Create a new method type.
 *
733
734
735
736
737
738
739
 * @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.
 */
740
ir_type *new_type_method (ident *name, int n_param, int n_res);
741
742
743
744
745
746
747
748
749
750
751

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

754
755
756
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
757
int   get_method_n_params  (const ir_type *method);
758
759

/** Returns the type of the parameter at position pos of a method. */
760
ir_type *get_method_param_type(ir_type *method, int pos);
761
762
763
/** 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. */
764
void  set_method_param_type(ir_type *method, int pos, ir_type *tp);
765
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
766
   for compounds passed by value. This information is constructed only on demand. */
767
entity *get_method_value_param_ent(ir_type *method, int pos);
768
/**
Michael Beck's avatar
Michael Beck committed
769
770
 * Returns a type that represents the copied value arguments if one
 * was allocated, else NULL.
771
 */
772
ir_type *get_method_value_param_type(const ir_type *method);
773

Michael Beck's avatar
Michael Beck committed
774
/** Returns the number of results of a method type. */
775
int   get_method_n_ress   (const ir_type *method);
Michael Beck's avatar
Michael Beck committed
776
/** Returns the return type of a method type at position pos. */
777
ir_type *get_method_res_type(ir_type *method, int pos);
778
779
780
/** 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. */
781
void  set_method_res_type(ir_type *method, int pos, ir_type *tp);
782
/** Returns an entity that represents the copied value result.  Only necessary
783
   for compounds passed by value. This information is constructed only on demand. */
784
entity *get_method_value_res_ent(ir_type *method, int pos);
Michael Beck's avatar
Michael Beck committed
785

786
787
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
788
 */
789
ir_type *get_method_value_res_type(const ir_type *method);
790

Michael Beck's avatar
Michael Beck committed
791
/**
Michael Beck's avatar
Michael Beck committed
792
 * This enum flags the variadicity of methods (methods with a
793
794
795
796
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
797
798
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
799
800
} variadicity;

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

804
/** Returns the variadicity of a method. */
805
variadicity get_method_variadicity(const ir_type *method);
806
807

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

810
811
812
813
814
815
/**
 * 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.
 */
816
int get_method_first_variadic_param_index(const ir_type *method);
817
818
819
820
821
822
823

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

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

/** Returns the mask of the additional graph properties. */
856
unsigned get_method_additional_properties(const ir_type *method);
857
858

/** Sets the mask of the additional graph properties. */
859
void set_method_additional_properties(ir_type *method, unsigned property_mask);
860
861

/** Sets one additional graph property. */
862
void set_method_additional_property(ir_type *method, mtp_additional_property flag);
863
864

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

881
  cc_bits             = (0xFF << 24)  /**< the calling convention bits */
882
883
} calling_convention;

884
885
886
/* some often used cases: made as defines because firmjni cannot handle two
   equal enum values. */

887
888
889
890
891
892
893
/** 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)

894
/** Returns the default calling convention for method types. */
Michael Beck's avatar
Michael Beck committed
895
896
unsigned get_default_cc_mask(void);

897
898
899
/**
 * check for the CDECL calling convention
 */
900
#define IS_CDECL(cc_mask)     (((cc_mask) & cc_bits) == cc_cdecl_set)
901
902
903
904

/**
 * check for the STDCALL calling convention
 */
905
#define IS_STDCALL(cc_mask)   (((cc_mask) & cc_bits) == cc_stdcall_set)
906
907
908
909

/**
 * check for the FASTCALL calling convention
 */
910
#define IS_FASTCALL(cc_mask)  (((cc_mask) & cc_bits) == cc_fastcall_set)
911
912

/**
913
 * Sets the CDECL convention bits.
914
 */
915
#define SET_CDECL(cc_mask)    (((cc_mask) & ~cc_bits) | cc_cdecl_set)
916
917

/**
918
 * Set. the STDCALL convention bits.
919
 */
920
#define SET_STDCALL(cc_mask)  (((cc_mask) & ~cc_bits) | cc_stdcall_set)
921
922

/**
923
 * Sets the FASTCALL convention bits.
924
 */
925
#define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
926
927

/** Returns the calling convention of an entities graph. */
928
unsigned get_method_calling_convention(const ir_type *method);
929
930

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

933
/** Returns the number of registers parameters, 0 means default. */
934
unsigned get_method_n_regparams(ir_type *method);
935

936
/** Sets the number of registers parameters, 0 means default. */
937
void set_method_n_regparams(ir_type *method, unsigned n_regs);
938

939
/** Returns true if a type is a method type. */
940
int   is_Method_type     (const ir_type *method);
941

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

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

960
961
962
/* --- manipulate private fields of struct --- */

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