type.h 55.1 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Sebastian Felis's avatar
Sebastian Felis committed
20
/**
Michael Beck's avatar
Michael Beck committed
21
22
23
24
25
 * @file    type.h
 * @brief   Representation of types.
 * @author  Goetz Lindenmaier, Michael Beck
 * @version $Id$
 * @summary
Michael Beck's avatar
Michael Beck committed
26
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
27
 *  Datastructure to hold type information.
28
29
30
31
32
 *
 *  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
33
 *  between these types.  Finally it specifies some auxiliary types.
34
35
36
37
38
39
40
41
42
43
 *
 *  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.
 *
44
 *  @see  tpop.h
45
 */
Michael Beck's avatar
Michael Beck committed
46
47
#ifndef FIRM_TR_TYPE_H
#define FIRM_TR_TYPE_H
Christian Schäfer's avatar
Christian Schäfer committed
48

Michael Beck's avatar
Michael Beck committed
49
50
51
52
#include "firm_types.h"
#include "tpop.h"
#include "firm_common.h"
#include "dbginfo.h"
53

Sebastian Felis's avatar
Sebastian Felis committed
54
/**
Michael Beck's avatar
Michael Beck committed
55
 *  An abstract data type to represent types.
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 *
 *  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
71
 *  The common fields are:
72
 *
Michael Beck's avatar
Michael Beck committed
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 *  - 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.
100
 *
Michael Beck's avatar
Michael Beck committed
101
 *  These fields can only be accessed via access functions.
102
 *
103
 *  Depending on the value of @c type_op, i.e., depending on the kind of the
Michael Beck's avatar
Michael Beck committed
104
 *  type the adt contains further attributes.  These are documented below.
105
106
107
108
109
110
111
112
113
 *
 *  @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
114
 *      mode maybe not global field??
115
 */
116
117
118
#ifndef _IR_TYPE_TYPEDEF_
#define _IR_TYPE_TYPEDEF_
typedef struct ir_type ir_type;
119
#endif
120

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
121
122
# include "type_or_entity.h"

Michael Beck's avatar
Michael Beck committed
123
124
125
126
/** Frees all entities associated with a type.
 *  Does not free the array entity.
 *  Warning: ensure these entities are not referenced anywhere else.
 */
127
void        free_type_entities(ir_type *tp);
128

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

139
140
141
142
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);
143

144
145
146
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);
147

148
149
150
151
152
153
154
/** 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
155
156
157
158
                                      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. */
159
  visibility_external_visible,   /**< The entity is visible to other external program parts, but
Michael Beck's avatar
Michael Beck committed
160
161
162
163
                                      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.  */
164
  visibility_external_allocated  /**< The entity is defined and allocated externally.  This compilation
Michael Beck's avatar
Michael Beck committed
165
166
167
168
169
                                      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.  */
170
} ir_visibility;
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

/** 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
192
 * I need to know, which fields of classes are accessed in the RTS,
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 * 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.
 */
210
211
ir_visibility get_type_visibility(const ir_type *tp);
void          set_type_visibility(ir_type *tp, ir_visibility v);
212
213
214



215
/** The state of the type layout. */
216
typedef enum {
Michael Beck's avatar
Michael Beck committed
217
  layout_undefined,    /**< The layout of this type is not defined.
Michael Beck's avatar
Michael Beck committed
218
219
                            Address computation to access fields is not
                            possible, fields must be accessed by Sel
220
221
                            nodes.  Enumeration constants might be undefined.
                            This is the default value except for
Michael Beck's avatar
Michael Beck committed
222
                            pointer, primitive and method types. */
Michael Beck's avatar
Michael Beck committed
223
  layout_fixed         /**< The layout is fixed, all component/member entities
Michael Beck's avatar
Michael Beck committed
224
225
                            have an offset assigned.  Size of the type is known.
                            Arrays can be accessed by explicit address
226
227
                            computation.  Enumeration constants must be defined.
                            Default for pointer, primitive and method types. */
228
} type_state;
229

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

233
/** Returns the type layout state of a type. */
234
type_state  get_type_state(const ir_type *tp);
235
236
237
238
239
240

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

243
244
245
246
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
247
ir_mode*    get_type_mode(const ir_type *tp);
248
249
250

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

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

259
/** Returns the size of a type in bits. */
260
int         get_type_size_bits(const ir_type *tp);
261
262
263
264
265
266

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

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

276
277
278
279
/** 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(). */
280
int         get_type_alignment_bytes(ir_type *tp);
281

282
283
284
285
/** 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
286
287
288
289
290
 *  -#.) 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
291
 */
292
int         get_type_alignment_bits(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
293
294

/** Sets the alignment of a type in bytes. */
295
void        set_type_alignment_bytes(ir_type *tp, int size);
Michael Beck's avatar
Michael Beck committed
296
297
298
299
300
301

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

Michael Beck's avatar
Michael Beck committed
304
/** Returns the visited count of a type. */
305
unsigned long get_type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
306
/** Sets the visited count of a type to num. */
307
void          set_type_visited(ir_type *tp, unsigned long num);
Michael Beck's avatar
Michael Beck committed
308
/** Sets visited field in type to type_visited. */
309
void          mark_type_visited(ir_type *tp);
Michael Beck's avatar
Michael Beck committed
310
/** Returns non-zero if the type is already visited */
311
int           type_visited(const ir_type *tp);
Michael Beck's avatar
Michael Beck committed
312
/** Returns non-zero if the type is not yet visited */
313
int           type_not_visited(const ir_type *tp);
314

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

Sebastian Felis's avatar
Sebastian Felis committed
320
/**
321
322
 * Visited flag to traverse the type information.
 *
323
324
 * Increase this flag by one before traversing the type information
 * using inc_master_type_visited().
325
326
327
 * 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).
328
 * Or use the function to walk all types.
329
 *
Sebastian Felis's avatar
Sebastian Felis committed
330
 * @see  typewalk
331
 */
332
void          set_master_type_visited(unsigned long val);
333
334
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
335
336

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

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

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

Sebastian Felis's avatar
Sebastian Felis committed
421
/**
Florian Liekweg's avatar
Florian Liekweg committed
422
 *  @page class_type    Representation of a class type
423
 *
424
425
426
 *  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.
427
 *
428
 *  The following attributes are private to this type kind:
Michael Beck's avatar
Michael Beck committed
429
 *  - member:     All entities belonging to this class.  This are method entities
430
431
432
 *                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.
433
 *
434
435
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
436
 *
437
 *  - subtypes:    A list of direct subclasses.
438
 *
439
 *  - supertypes:  A list of direct superclasses.
440
 *
441
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
442
 *                 "description" it only is a description of requirements to a class,
443
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
444
 *                 Peculiarity inherited is only possible for entities.  An entity
445
446
447
448
 *                 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.
449
 *
450
451
452
453
454
455
 *  - 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
 *
456
 *  - vtable_size: The size of this class virtual function table.
457
458
 *                 Default:  0
 *
459
460
461
462
463
 *  - 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
464
465
466
467
468
469
470
471
472
473
 *
 *  - 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
474
 */
475
476

/** Creates a new class type. */
477
ir_type *new_type_class (ident *name);
478
479

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

482
483
484
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
485
void add_class_member   (ir_type *clss, ir_entity *member);
486
487

/** Returns the number of members of this class. */
488
int get_class_n_members (const ir_type *clss);
489
490

/** Returns the member at position pos, 0 <= pos < n_member */
491
ir_entity *get_class_member   (const ir_type *clss, int pos);
492

Götz Lindenmaier's avatar
Götz Lindenmaier committed
493
/** Returns index of mem in clss, -1 if not contained. */
494
int get_class_member_index(const ir_type *clss, ir_entity *mem);
495

Götz Lindenmaier's avatar
Götz Lindenmaier committed
496
/** Finds the member with name 'name'. If several members with the same
497
 *  name returns one of them.  Returns NULL if no member found. */
498
ir_entity *get_class_member_by_name(ir_type *clss, ident *name);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
499

500
/** Overwrites the member at position pos, 0 <= pos < n_member with
501
 *  the passed entity. */
502
void set_class_member   (ir_type *clss, ir_entity *member, int pos);
503
504

/** Replaces complete member list in class type by the list passed.
505
506
507
508
 *
 *  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. */
509
void set_class_members  (ir_type *clss, ir_entity *members[], int arity);
510
511

/** Finds member in the list of members and removes it.
512
513
514
 *
 *  Shrinks the member list, so iterate from the end!!!
 *  Does not deallocate the entity.  */
515
void remove_class_member(ir_type *clss, ir_entity *member);
516

517

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

/** Returns the number of subtypes */
525
int     get_class_n_subtypes (const ir_type *clss);
526
527

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
530
531
532
533
/** Returns the index to access subclass as subtype of class.
 *
 *  If subclass is no direct subtype of class returns -1.
 */
534
int get_class_subtype_index(ir_type *clss, const ir_type *subclass);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
535

Michael Beck's avatar
Michael Beck committed
536
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
537
538
539
 *
 *  Does not set the corresponding supertype relation for subtype: this might
 *  be a different position! */
540
void    set_class_subtype   (ir_type *clss, ir_type *subtype, int pos);
541
542

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

Michael Beck's avatar
Michael Beck committed
545
546
547
548
549
550
551
/* 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)
552

553
/** Adds supertype as supertype to class.
554
555
556
 *
 *  Checks whether clss is a subtype of supertype.  If not
 *  adds also clss as subtype to supertype.  */
557
void    add_class_supertype   (ir_type *clss, ir_type *supertype);
558
559

/** Returns the number of supertypes */
560
int     get_class_n_supertypes (const ir_type *clss);
561

Götz Lindenmaier's avatar
Götz Lindenmaier committed
562
563
564
565
/** Returns the index to access superclass as supertype of class.
 *
 *  If superclass is no direct supertype of class returns -1.
 */
566
int     get_class_supertype_index(ir_type *clss, ir_type *super_clss);
567
568

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

571
572
573
574
/** 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! */
575
void    set_class_supertype   (ir_type *clss, ir_type *supertype, int pos);
576
577

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

580
581
582
583
584
585
586
587
/** 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
588
589
590
591
592
593
594
595
/** 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
596
/** This enumeration flags the peculiarity of entities and types. */
597
typedef enum {
598
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
Florian Liekweg's avatar
Florian Liekweg committed
599
600
                            allocated, no code/data exists for this entity/type.
                        @@@ eventually rename to descriptive (adjective as the others!)*/
601
  peculiarity_inherited,       /**< Describes explicitly that other entities are
Florian Liekweg's avatar
Florian Liekweg committed
602
603
604
605
606
607
                            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
608
  peculiarity_existent         /**< The entity/type (can) exist.
Florian Liekweg's avatar
Florian Liekweg committed
609
610
                    @@@ eventually rename to 'real' i.e., 'echt'
                        This serves better as opposition to description _and_ inherited.*/
611
} ir_peculiarity;
612
613

/** Returns a human readable string for a peculiarity. */
614
const char *get_peculiarity_name(ir_peculiarity p);
615

Michael Beck's avatar
Michael Beck committed
616
/** Returns the peculiarity of the class. */
617
ir_peculiarity get_class_peculiarity (const ir_type *clss);
Michael Beck's avatar
Michael Beck committed
618
/** Sets the peculiarity of the class. */
619
void           set_class_peculiarity (ir_type *clss, ir_peculiarity pec);
620

621
/** Returns the type info entity of a class. */
622
ir_entity *get_class_type_info(const ir_type *clss);
623
624

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

627
628
629
630
631
632
/** 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);

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

636
/** Sets the class final flag. */
637
void set_class_final(ir_type *clss, int flag);
638

639
640
641
642
643
644
645
646
647
648
649
650
651
/** 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
652
   @todo This is an undocumented field, subject to change! */
653
654
void set_class_dfn (ir_type *clss, int dfn);
int  get_class_dfn (const ir_type *clss);
655

656
/** Returns true if a type is a class type. */
657
int is_Class_type(const ir_type *clss);
658

Sebastian Felis's avatar
Sebastian Felis committed
659
/**
Florian Liekweg's avatar
Florian Liekweg committed
660
 *  @page struct_type   Representation of a struct type
661
 *
662
 *  A struct type represents aggregate types that consist of a list
663
 *  of fields.
664
 *
665
666
667
668
 *  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
669
 *             type_pointer, type_primitive.
670
671
672
673
 *             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.
674
 */
675
/** Creates a new type struct */
676
ir_type *new_type_struct (ident *name);
677
/** Creates a new type struct with debug information. */
678
ir_type *new_d_type_struct (ident *name, dbg_info* db);
679

680
681
682
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
683
void add_struct_member   (ir_type *strct, ir_entity *member);
684
685

/** Returns the number of members of this struct. */
686
int get_struct_n_members (const ir_type *strct);
687
688

/** Returns the member at position pos, 0 <= pos < n_member */
689
ir_entity *get_struct_member   (const ir_type *strct, int pos);
690
691

/** Returns index of member in strct, -1 if not contained. */
692
int get_struct_member_index(const ir_type *strct, ir_entity *member);
693
694
695

/** Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
696
void set_struct_member   (ir_type *strct, int pos, ir_entity *member);
697
698

/** Finds member in the list of members and removes it. */
699
void remove_struct_member (ir_type *strct, ir_entity *member);
700

701
/** Returns true if a type is a struct type. */
702
int is_Struct_type(const ir_type *strct);
703

Sebastian Felis's avatar
Sebastian Felis committed
704
/**
Florian Liekweg's avatar
Florian Liekweg committed
705
 * @page method_type    Representation of a method type
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 *
 * 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.)
 *
722
723
724
725
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
726
727
728
729
730
731
 * - 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.)
732
733
734
735
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
736
737
 */

Michael Beck's avatar
Michael Beck committed
738
/* These macros define the suffixes for the types and entities used
739
740
741
742
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
743
744
/** Create a new method type.
 *
745
746
747
748
749
750
751
 * @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.
 */
752
ir_type *new_type_method (ident *name, int n_param, int n_res);
753
754
755
756
757
758
759
760
761
762
763

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

766
767
768
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
769
int   get_method_n_params  (const ir_type *method);
770
771

/** Returns the type of the parameter at position pos of a method. */
772
ir_type *get_method_param_type(ir_type *method, int pos);
773
774
775
/** 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. */
776
void  set_method_param_type(ir_type *method, int pos, ir_type *tp);
777
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
778
   for compounds passed by value. This information is constructed only on demand. */
779
ir_entity *get_method_value_param_ent(ir_type *method, int pos);
780
/**
Michael Beck's avatar
Michael Beck committed
781
782
 * Returns a type that represents the copied value arguments if one
 * was allocated, else NULL.
783
 */
784
ir_type *get_method_value_param_type(const ir_type *method);
785
786
787
788
789
790
791
792
/** Returns an ident representing the parameters name. Returns NULL if not set.
    For debug support only. */
ident *get_method_param_ident(ir_type *method, int pos);
/** Returns a string representing the parameters name. Returns NULL if not set.
    For debug support only. */
const char *get_method_param_name(ir_type *method, int pos);
/** Sets an ident representing the parameters name. For debug support only. */
void set_method_param_ident(ir_type *method, int pos, ident *id);
793

Michael Beck's avatar
Michael Beck committed
794
/** Returns the number of results of a method type. */
795
int   get_method_n_ress   (const ir_type *method);
Michael Beck's avatar
Michael Beck committed
796
/** Returns the return type of a method type at position pos. */
797
ir_type *get_method_res_type(ir_type *method, int pos);
798
799
800
/** 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. */
801
void  set_method_res_type(ir_type *method, int pos, ir_type *tp);
802
/** Returns an entity that represents the copied value result.  Only necessary
803
   for compounds passed by value. This information is constructed only on demand. */
804
ir_entity *get_method_value_res_ent(ir_type *method, int pos);
Michael Beck's avatar
Michael Beck committed
805

806
807
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
808
 */
809
ir_type *get_method_value_res_type(const ir_type *method);
810

Michael Beck's avatar
Michael Beck committed
811
/**
Michael Beck's avatar
Michael Beck committed
812
 * This enum flags the variadicity of methods (methods with a
813
814
815
816
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
817
818
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
819
820
} variadicity;

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

824
/** Returns the variadicity of a method. */
825
variadicity get_method_variadicity(const ir_type *method);
826
827

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

830
831
832
833
834
835
/**
 * 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.
 */
836
int get_method_first_variadic_param_index(const ir_type *method);
837
838
839
840
841
842
843

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

846
/**
847
848
849
 * Additional method type properties:
 * Tell about special properties of a method type. Some
 * of these may be discovered by analyses.
850
851
852
 */
typedef enum {
  mtp_no_property        = 0x00000000, /**< no additional properties, default */
Michael Beck's avatar
Michael Beck committed
853
  mtp_property_const     = 0x00000001, /**< This method did not access memory and calculates
854
855
                                         its return values solely from its parameters.
                                         GCC: __attribute__((const)). */
Michael Beck's avatar
Michael Beck committed
856
  mtp_property_pure      = 0x00000002, /**< This method did NOT write to memory and calculates
Michael Beck's avatar
Michael Beck committed
857
                                         its return values solely from its parameters and
858
859
                                         the memory they points to (or global vars).
                                         GCC: __attribute__((pure)). */
Michael Beck's avatar
Michael Beck committed
860
  mtp_property_noreturn  = 0x00000004, /**< This method did not return due to an aborting system
861
862
                                         call.
                                         GCC: __attribute__((noreturn)). */
Michael Beck's avatar
Michael Beck committed
863
  mtp_property_nothrow   = 0x00000008, /**< This method cannot throw an exception.
864
                                         GCC: __attribute__((nothrow)). */
Michael Beck's avatar
Michael Beck committed
865
  mtp_property_naked     = 0x00000010, /**< This method is naked.
866
                                         GCC: __attribute__((naked)). */
Michael Beck's avatar
Michael Beck committed
867
  mtp_property_malloc    = 0x00000020, /**< This method returns newly allocate memory.
868
                                         GCC: __attribute__((malloc)). */
869
870
  mtp_property_intrinsic = 0x00000040, /**< This method is intrinsic. It is expected that
                                         a lowering phase will remove all calls to it. */
871
  mtp_property_runtime   = 0x00000080, /**< This method represents a runtime routine. */
872
873
  mtp_property_inherited = (1<<31)     /**< Internal. Used only in irg's, means property is
                                         inherited from type. */
874
875
876
} mtp_additional_property;

/** Returns the mask of the additional graph properties. */
877
unsigned get_method_additional_properties(const ir_type *method);
878
879

/** Sets the mask of the additional graph properties. */
880
void set_method_additional_properties(ir_type *method, unsigned property_mask);
881
882

/** Sets one additional graph property. */
883
void set_method_additional_property(ir_type *method, mtp_additional_property flag);
884
885

/**
886
887
 * Calling conventions: lower 24 bits are the number of register parameters,
 * upper 8 encode the calling conventions.
888
889
 */
typedef enum {
890
  cc_reg_param        = 0x01000000, /**< Transmit parameters in registers, else the stack is used.
891
                                         This flag may be set as default on some architectures. */
892
  cc_last_on_top      = 0x02000000, /**< The last non-register parameter is transmitted on top of
893
894
895
896
                                         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) */
897
  cc_callee_clear_stk = 0x04000000, /**< The callee clears the stack. This forbids variadic
898
                                         function calls (stdcall). */
899
  cc_this_call        = 0x08000000, /**< The first parameter is a this pointer and is transmitted
900
901
                                         in a special way. */

902
  cc_bits             = (0xFF << 24)  /**< the calling convention bits */
903
904
} calling_convention;

905
906
907
/* some often used cases: made as defines because firmjni cannot handle two
   equal enum values. */

908
909
910
911
912
913
914
/** 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)

915
/** Returns the default calling convention for method types. */
Michael Beck's avatar
Michael Beck committed
916
917
unsigned get_default_cc_mask(void);

918
919
920
/**
 * check for the CDECL calling convention
 */
921
#define IS_CDECL(cc_mask)     (((cc_mask) & cc_bits) == cc_cdecl_set)
922
923
924
925

/**
 * check for the STDCALL calling convention
 */
926
#define IS_STDCALL(cc_mask)   (((cc_mask) & cc_bits) == cc_stdcall_set)
927
928
929
930

/**
 * check for the FASTCALL calling convention
 */
931
#define IS_FASTCALL(cc_mask)  (((cc_mask) & cc_bits) == cc_fastcall_set)
932
933

/**
934
 * Sets the CDECL convention bits.
935
 */
936
#define SET_CDECL(cc_mask)    (((cc_mask) & ~cc_bits) | cc_cdecl_set)
937
938

/**
939
 * Set. the STDCALL convention bits.
940
 */
941
#define SET_STDCALL(cc_mask)  (((cc_mask) & ~cc_bits) | cc_stdcall_set)
942
943

/**
944
 * Sets the FASTCALL convention bits.
945
 */
946
#define SET_FASTCALL(cc_mask) (((cc_mask) & ~cc_bits) | cc_fastcall_set)
947
948

/** Returns the calling convention of an entities graph. */
949
unsigned get_method_calling_convention(const ir_type *method);
950
951

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

954
/** Returns the number of registers parameters, 0 means default. */
955
unsigned get_method_n_regparams(ir_type *method);
956

957
/** Sets the number of registers parameters, 0 means default. */
958
void set_method_n_regparams(ir_type *method, unsigned n_regs);
959

960
/** Returns true if a type is a method type. */
961
int   is_Method_type     (const ir_type *method);
962

Sebastian Felis's avatar
Sebastian Felis committed
963
/**
964
 *   @page union_type   Representation of a union (variant) type.
965
 *