type.h 38.5 KB
Newer Older
Sebastian Felis's avatar
Sebastian Felis committed
1
/**
2
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
3
 * @file type.h
Michael Beck's avatar
Michael Beck committed
4
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
5
6
7
8
9
10
11
12
13
 * Project:     libFIRM                                                   <br>
 * File name:   ir/tr/type.h                                              <br>
 * Purpose:     Representation of types.                                  <br>
 * Author:      Goetz Lindenmaier                                         <br>
 * Modified by:                                                           <br>
 * Created:                                                               <br>
 * Copyright:   (c) 2001-2003 Universität Karlsruhe                       <br>
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE. <br>
 * CVS-ID:      $Id$
Michael Beck's avatar
Michael Beck committed
14
 *
Götz Lindenmaier's avatar
header    
Götz Lindenmaier committed
15
16
 *
 *  Datastructure to hold type information.
17
18
19
20
21
 *
 *  This module supplies a datastructure to represent all types
 *  known in the compiled program.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
22
 *  between these types.  Finally it specifies some auxiliary types.
23
24
25
26
27
28
29
30
31
32
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  A type is described by a set of attributes.  Some of
 *  these attributes are common to all types, others depend on the
 *  kind of the type.
 *
 *  Types are different from the modes defined in irmode:  Types are
 *  on the level of the programming language, modes at the level of
 *  the target processor.
 *
33
 *  @see  tpop.h
34
 */
Boris Boesler's avatar
Boris Boesler committed
35

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

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

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

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

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

58
59
# include "tr_inheritance.h"

Sebastian Felis's avatar
Sebastian Felis committed
60
/**
Michael Beck's avatar
Michael Beck committed
61
 *  An abstract data type to represent types.
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 *
 *  This is the abstract data type with which any type known in the
 *  compiled program can be represented.  This includes types specified
 *  in the program as well as types defined by the language.  In the
 *  view of the intermediate representation there is no difference
 *  between these types.
 *
 *  There exist several kinds of types, arranged by the structure of
 *  the type.  These are distinguished by a type opcode.
 *  A type is described by a set of attributes.  Some of these attributes
 *  are common to all types, others depend on the kind of the type.
 *
 *  The following describes the common attributes.  They can only be
 *  accessed by the functions given below.
 *
Michael Beck's avatar
Michael Beck committed
77
 *  The common fields are:
78
 *
79
 *  - firm_kind: A firm_kind tag containing k_type.  This is useful
80
 *               for dynamically checking whether a node is a type node.
81
82
83
 *  - type_op:   A tp_op specifying the kind of the type.
 *  - mode:      The mode to be used to represent the type on a machine.
 *  - name:      An identifier specifying the name of the type.  To be
84
 *               set by the frontend.
85
 *  - size:      The size of the type, i.e. an entity of this type will
Michael Beck's avatar
Michael Beck committed
86
 *               occupy size bits in memory.  In several cases this is
87
88
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
Michael Beck's avatar
Michael Beck committed
89
90
91
92
 *  - alignment  The alignment of the type, i.e. an entity of this type will
 *               be allocated an an address in memory with this alignment.
 *               In several cases this is determined when fixing the layout
 *               of this type (class, struct, union, array)
93
 *  - state:     The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
94
95
96
97
98
99
100
101
 *               layout of the type is undefined or fixed (values: layout_undefined
 *               or layout_fixed).  Compound types can have an undefined
 *               layout.  The layout of the basic types primitive and pointer
 *               is always layout_fixed.  If the layout of
 *               compound types is fixed all entities must have an offset
 *               and the size of the type must be set.
 *               A fixed layout for enumeration types means that each enumeration
 *               is associated with an implementation value.
102
103
 *  - visit:     A counter for walks of the type information.
 *  - link:      A void* to associate some additional information with the type.
104
 *
Michael Beck's avatar
Michael Beck committed
105
 *  These fields can only be accessed via access functions.
106
 *
107
 *  Depending on the value of @c type_op, i.e., depending on the kind of the
Michael Beck's avatar
Michael Beck committed
108
 *  type the adt contains further attributes.  These are documented below.
109
110
111
112
113
114
115
116
117
 *
 *  @see
 *
 *  @link class_type class @endlink, @link struct_type struct @endlink,
 *  @link method_type method @endlink, @link union_type union @endlink,
 *  @link array_type array @endlink, @link enumeration_type enumeration @endlink,
 *  @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
 *
 *  @todo
Florian Liekweg's avatar
Florian Liekweg committed
118
 *      mode maybe not global field??
119
 */
120
121
#ifndef _TYPE_TYPEDEF_
#define _TYPE_TYPEDEF_
122
typedef struct type type;
123
#endif
124

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

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

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
133
134
135
136
137
138
/** Frees the memory used by the type.
 *
 * Removes the type from the type list. Does not free the entities
 * belonging to the type, except for the array element entity.  Does
 * not free if tp is "none" or "unknown".  Frees entities in value
 * param subtypes of method types!!! Make sure these are not
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
139
140
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
141
142
void        free_type(type *tp);

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

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

152
/** The state of the type layout. */
153
typedef enum {
Michael Beck's avatar
Michael Beck committed
154
  layout_undefined,    /**< The layout of this type is not defined.
Florian Liekweg's avatar
Florian Liekweg committed
155
156
157
158
              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
159
  layout_fixed         /**< The layout is fixed, all component/member entities
Florian Liekweg's avatar
Florian Liekweg committed
160
161
162
163
              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.  */
164
} type_state;
165

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

169
/** Returns the type layout state of a type. */
Michael Beck's avatar
Michael Beck committed
170
type_state  get_type_state(const type *tp);
171
172
173
174
175
176

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

179
180
181
182
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
Michael Beck's avatar
Michael Beck committed
183
ir_mode*    get_type_mode(const type *tp);
184
185
186

/** Sets the mode of a type.
 *
187
 * Only has an effect on primitive, enumeration and pointer types.
188
 */
189
190
void        set_type_mode(type *tp, ir_mode* m);

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

195
/** Returns the size of a type in bits. */
Michael Beck's avatar
Michael Beck committed
196
int         get_type_size_bits(const type *tp);
197
198
199
200
201
202
203
204
205

/** Sets the size of a type in bytes.
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
void        set_type_size_bytes(type *tp, int size);

/** Sets the size of a type in bits.
206
207
208
209
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
210
void        set_type_size_bits(type *tp, int size);
211

212
213
214
215
/** Returns the alignment of a type in bytes.
 *
 *  Returns -1 if the alignment is NOT
 *  a byte size, i.e. not dividable by 8. Calls get_type_alignment_bits(). */
Michael Beck's avatar
Michael Beck committed
216
int         get_type_alignment_bytes(type *tp);
217

218
219
220
221
222
223
224
225
226
/** Returns the alignment of a type in bits.
 *
 *  If the alignment of a type is
 *  not set, it is calculated here according to the following rules:
 *  1.) if a type has a mode, the alignment is the mode size.
 *  2.) compound types have the alignment of it's biggest member.
 *  3.) array types have the alignment of its element type.
 *  4.) method types return 0 here.
 *  5.) all other types return 8 here (i.e. aligned at byte).
Michael Beck's avatar
Michael Beck committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 */
int         get_type_alignment_bits(type *tp);

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

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

unsigned long get_type_visited(const type *tp);
241
void          set_type_visited(type *tp, unsigned long num);
242
/* Sets visited field in type to type_visited. */
243
void          mark_type_visited(type *tp);
Michael Beck's avatar
Michael Beck committed
244
245
/* @@@ name clash!! int           type_visited(const type *tp); */
int           type_not_visited(const type *tp);
246

Michael Beck's avatar
Michael Beck committed
247
void*         get_type_link(const type *tp);
248
void          set_type_link(type *tp, void *l);
249

Sebastian Felis's avatar
Sebastian Felis committed
250
/**
251
252
253
254
255
256
257
 * Visited flag to traverse the type information.
 *
 * Increase this flag by one before traversing the type information.
 * Mark type nodes as visited by set_type_visited(type, type_visited).
 * Check whether node was already visited by comparing get_type_visited(type)
 * and type_visited.
 * Or use the function to walk all types.
258
 *
Sebastian Felis's avatar
Sebastian Felis committed
259
 * @see  typewalk
260
 */
Christian Schäfer's avatar
Christian Schäfer committed
261
extern unsigned long type_visited;
262
void          set_master_type_visited(unsigned long val);
263
264
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
265
266

/**
267
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
268
 *
269
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
270
 *
271
272
 * @return
 *     true if the thing is a type, else false
273
 */
Michael Beck's avatar
Michael Beck committed
274
int is_type            (const void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
275

Sebastian Felis's avatar
Sebastian Felis committed
276
/**
Florian Liekweg's avatar
Florian Liekweg committed
277
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
278
279
280
281
282
283
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
284
 *    Types are equal if :
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 *    - they are the same type kind
 *    - they have the same name
 *    - they have the same mode (if applicable)
 *    - they have the same type_state and, ev., the same size
 *    - they are class types and have
 *      - the same members (see same_entity in entity.h)
 *      - the same supertypes -- the C-pointers are compared --> no recursive call.
 *      - the same number of subtypes.  Subtypes are not compared,
 *        as this could cause a cyclic test.
 *      - the same peculiarity
 *    - they are structure types and have the same members
 *    - they are method types and have
 *      - the same parameter types
 *      - the same result types
 *    - they are union types and have the same members
 *    - they are array types and have
 *      - the same number of dimensions
 *      - the same dimension bounds
 *      - the same dimension order
 *      - the same element type
 *    - they are enumeration types and have the same enumerator names
 *    - they are pointer types and have the identical points_to type
 *      (i.e., the same C-struct to represent the type, type_id is skipped.
 *       This is to avoid endless recursions; with pointer types circlic
 *       type graphs are possible.)
 */
Michael Beck's avatar
Michael Beck committed
311
int equal_type(type *tpy1, type *typ2);
312

Sebastian Felis's avatar
Sebastian Felis committed
313
314
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
315
316
317
318
319
320
321
322
 *
 *   @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
323
324
325
326
327
328
329
330
331
332
333
 *    - 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
334
 *      @return counterpart in lt and the type is smaller
335
336
337
338
339
 *    - 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
340
 *      @return or
341
342
343
344
 *      - 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
345
346
 *      @return smaller than the points_to type of lt.
 *
347
 */
Michael Beck's avatar
Michael Beck committed
348
int smaller_type (type *st, type *lt);
349

Sebastian Felis's avatar
Sebastian Felis committed
350
/**
Florian Liekweg's avatar
Florian Liekweg committed
351
 *  @page class_type    Representation of a class type
352
 *
353
354
355
356
 *  If the type opcode is set to type_class the type represents class
 *  types.  A list of fields and methods is associated with a class.
 *  Further a class can inherit from and bequest to other classes.
 *  @@@ value class???
357
358
359
360
361
 *  The following attributes are private to this type kind:
 *  - member:     All entities belonging to this class.  This are methode entities
 *                which have type_method or fields that can have any of the
 *                following type kinds: type_class, type_struct, type_union,
 *                type_array, type_enumeration, type_pointer, type_primitive.
362
 *
363
364
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
365
 *
366
 *  - subtypes:   A list of direct subclasses.
367
 *
368
 *  - supertypes: A list of direct superclasses.
369
 *
370
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
371
 *                 "description" it only is a description of requirements to a class,
372
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
373
 *                 Peculiarity inherited is only possible for entities.  An entity
374
375
376
377
 *                 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.
378
 *
379
 */
380
381

/** Creates a new class type. */
382
type   *new_type_class (ident *name);
383
384

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

387
388
389
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
390
void    add_class_member   (type *clss, entity *member);
391
392

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

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

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

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

405
/** Overwrites the member at position pos, 0 <= pos < n_member with
406
 *  the passed entity. */
407
void    set_class_member   (type *clss, entity *member, int pos);
408
409

/** Replaces complete member list in class type by the list passed.
410
411
412
413
 *
 *  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. */
414
void    set_class_members  (type *clss, entity *members[], int arity);
415
416

/** Finds member in the list of members and removes it.
417
418
419
 *
 *  Shrinks the member list, so iterate from the end!!!
 *  Does not deallocate the entity.  */
420
void    remove_class_member(type *clss, entity *member);
421

422

423
/** Adds subtype as subtype to clss.
424
425
426
 *
 *  Checks whether clss is a supertype of subtype.  If not
 *  adds also clss as supertype to subtype.  */
427
void    add_class_subtype   (type *clss, type *subtype);
428
429

/** Returns the number of subtypes */
Michael Beck's avatar
Michael Beck committed
430
int     get_class_n_subtypes (const type *clss);
431
432

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

Michael Beck's avatar
Michael Beck committed
435
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
436
437
438
 *
 *  Does not set the corresponding supertype relation for subtype: this might
 *  be a different position! */
439
void    set_class_subtype   (type *clss, type *subtype, int pos);
440
441

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

444

445
/** Adds supertype as supertype to class.
446
447
448
 *
 *  Checks whether clss is a subtype of supertype.  If not
 *  adds also clss as subtype to supertype.  */
449
void    add_class_supertype   (type *clss, type *supertype);
450
451

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

/** Returns the index of an supertype in a type. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
455
int     get_class_supertype_index(type *clss, type *super_clss);
456
457

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

460
461
462
463
/** 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! */
464
void    set_class_supertype   (type *clss, type *supertype, int pos);
465
466

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

Michael Beck's avatar
Michael Beck committed
469
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
470
typedef enum peculiarity {
471
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
Florian Liekweg's avatar
Florian Liekweg committed
472
473
                            allocated, no code/data exists for this entity/type.
                        @@@ eventually rename to descriptive (adjective as the others!)*/
474
  peculiarity_inherited,       /**< Describes explicitly that other entities are
Florian Liekweg's avatar
Florian Liekweg committed
475
476
477
478
479
480
                            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
481
  peculiarity_existent         /**< The entity/type (can) exist.
Florian Liekweg's avatar
Florian Liekweg committed
482
483
                    @@@ eventually rename to 'real' i.e., 'echt'
                        This serves better as opposition to description _and_ inherited.*/
484
} peculiarity;
Michael Beck's avatar
Michael Beck committed
485
const char *get_peculiarity_string(peculiarity p);
486
487
488

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

492
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
493
   @todo This is an undocumented field, subject to change! */
494
void set_class_dfn (type *clss, int dfn);
Michael Beck's avatar
Michael Beck committed
495
int  get_class_dfn (const type *clss);
496

497
/** Returns true if a type is a class type. */
498
int is_Class_type(const type *clss);
499

Sebastian Felis's avatar
Sebastian Felis committed
500
/**
Florian Liekweg's avatar
Florian Liekweg committed
501
 *  @page struct_type   Representation of a struct type
502
 *
503
504
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
505
506
507
508
 *  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
509
 *             type_pointer, type_primitive.
510
511
512
513
 *             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.
514
 */
515
/** Creates a new type struct */
516
type   *new_type_struct (ident *name);
517
/** Creates a new type struct with debug information. */
518
type   *new_d_type_struct (ident *name, dbg_info* db);
519

520
521
522
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
523
void    add_struct_member   (type *strct, entity *member);
524
525

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

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar
Michael Beck committed
529
entity *get_struct_member   (const type *strct, int pos);
530
531
532
533
534
535

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

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

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

541
/** Returns true if a type is a struct type. */
542
int     is_Struct_type(const type *strct);
543

Sebastian Felis's avatar
Sebastian Felis committed
544
/**
Florian Liekweg's avatar
Florian Liekweg committed
545
 * @page method_type    Representation of a method type
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 *
 * 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.)
 *
562
563
564
565
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
566
567
568
569
570
571
 * - 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.)
572
573
574
575
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
576
577
 */

Michael Beck's avatar
Michael Beck committed
578
/* These macros define the suffixes for the types and entities used
579
580
581
582
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
583
584
/** Create a new method type.
 *
585
586
587
588
589
590
591
 * @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.
 */
592
type *new_type_method (ident *name, int n_param, int n_res);
593
594
595
596
597
598
599
600
601
602
603

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

606
607
608
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
Michael Beck's avatar
Michael Beck committed
609
int   get_method_n_params  (const type *method);
610
611

/** Returns the type of the parameter at position pos of a method. */
612
type *get_method_param_type(type *method, int pos);
613
614
615
/** 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. */
616
void  set_method_param_type(type *method, int pos, type* tp);
617
/** Returns an entity that represents the copied value argument.  Only necessary
Michael Beck's avatar
Michael Beck committed
618
   for compounds passed by value. This information is constructed only on demand. */
619
entity *get_method_value_param_ent(type *method, int pos);
620
621
622
/**
 * Returns a type that represents the copied value arguments.
 */
Michael Beck's avatar
Michael Beck committed
623
type *get_method_value_param_type(const type *method);
624

Michael Beck's avatar
Michael Beck committed
625
int   get_method_n_ress   (const type *method);
626
type *get_method_res_type(type *method, int pos);
627
628
629
/** 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. */
630
void  set_method_res_type(type *method, int pos, type* tp);
631
/** Returns an entity that represents the copied value result.  Only necessary
632
633
   for compounds passed by value. This information is constructed only on demand. */
entity *get_method_value_res_ent(type *method, int pos);
Michael Beck's avatar
Michael Beck committed
634

635
636
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
637
 */
Michael Beck's avatar
Michael Beck committed
638
type *get_method_value_res_type(const type *method);
639

Michael Beck's avatar
Michael Beck committed
640
/**
641
642
643
644
645
 * this enum flags the variadicity of methods (methods with a
 * variable amount of arguments (e.g. C's printf). Default is
 * non_variadic.
 */
typedef enum variadicity {
Florian Liekweg's avatar
Florian Liekweg committed
646
647
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
648
649
} variadicity;

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

653
/** Returns the variadicity of a method. */
Michael Beck's avatar
Michael Beck committed
654
variadicity get_method_variadicity(const type *method);
655
656

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

659
660
661
662
663
664
/**
 * Returns the first variadic parameter index of a type.
 * If this index was NOT set, the index of the last parameter
 * of the method type plus one is returned for variadic functions.
 * Non-variadic function types always return -1 here.
 */
Michael Beck's avatar
Michael Beck committed
665
int get_method_first_variadic_param_index(const type *method);
666
667
668
669
670
671
672
673
674

/**
 * Sets the first variadic parameter index. This allows to specify
 * a complete call type (containing the type of all parameters)
 * but still have the knowledge, which parameter must be passed as
 * variadic one.
 */
void set_method_first_variadic_param_index(type *method, int index);

675
/** Returns true if a type is a method type. */
676
int   is_Method_type     (const type *method);
677

Sebastian Felis's avatar
Sebastian Felis committed
678
/**
Florian Liekweg's avatar
Florian Liekweg committed
679
 *   @page union_type   Representation of a union type.
680
 *
681
 *   The union type represents union types.
682
683
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
684
685
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
686
 */
687
/** Creates a new type union. */
688
type   *new_type_union (ident *name);
689
690

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

693
694
695
/* --- manipulate private fields of struct --- */

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

/** Adds a new entity to a union type */
699
void    add_union_member (type *uni, entity *member);
700
701

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

/** Overwrites a entity at position pos in a union type. */
705
void    set_union_member (type *uni, int pos, entity *member);
706
707

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

710
/** Returns true if a type is a union type. */
711
int     is_Union_type          (const type *uni);
712

Sebastian Felis's avatar
Sebastian Felis committed
713
/**
Florian Liekweg's avatar
Florian Liekweg committed
714
 * @page array_type Representation of an array type
715
716
717
718
719
720
721
722
723
724
725
726
 *
 * The array type represents rectangular multi dimensional arrays.
 * The constants representing the bounds must be allocated to
 * get_const_code_irg() by setting current_ir_graph accordingly.
 *
 * - n_dimensions:    Number of array dimensions.
 * - *lower_bound:    Lower bounds of dimensions.  Usually all 0.
 * - *upper_bound:    Upper bounds or dimensions.
 * - *element_type:   The type of the array elements.
 * - *element_ent:    An entity for the array elements to be used for
 *                      element selection with Sel.
 * @todo
Michael Beck's avatar
Michael Beck committed
727
 *   Do we need several entities?  One might want
Michael Beck's avatar
Michael Beck committed
728
729
 *   to select a dimension and not a single element in case of multi
 *   dimensional arrays.
730
 */
731
732
733
734
735
736
737
738

/** Create a new type array.
 *
 * Sets n_dimension to dimension and all dimension entries to NULL.
 * Initializes order to the order of the dimensions.
 * The entity for array elements is built automatically.
 * Set dimension sizes after call to constructor with set_* routines.
 */
739
type *new_type_array         (ident *name, int n_dimensions,
Florian Liekweg's avatar
Florian Liekweg committed
740
                  type *element_type);
741
742
743
744
745
746
747

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

753
754
755
/* --- manipulate private fields of array type --- */

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

Michael Beck's avatar
Michael Beck committed
758
759
760
761
/**
 * Allocates Const nodes of mode_I for one array dimension.
 * Upper bound in Firm is the element next to the last, ie [lower,upper[
 */
762
763
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
Michael Beck's avatar
Michael Beck committed
764
765
766
767
/**
 * Sets the bounds for one array dimension.
 * Upper bound in Firm is the element next to the last, ie [lower,upper[
 */
768
769
void  set_array_bounds       (type *array, int dimension, ir_node *lower_bound,
                                                          ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
770
/** Sets the lower bound for one array dimension, ie [lower,upper[ */
771
void  set_array_lower_bound  (type *array, int dimension, ir_node *lower_bound);
Michael Beck's avatar
Michael Beck committed
772
773
774

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

/** Sets the upper bound for one array dimension, ie [lower,upper[ */
778
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
779
780
781
782
783

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

784
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
785
786
int       has_array_lower_bound     (const type *array, int dimension);
ir_node * get_array_lower_bound     (const type *array, int dimension);
787
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
788
long      get_array_lower_bound_int (const type *array, int dimension);
789
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
790
791
int       has_array_upper_bound     (const type *array, int dimension);
ir_node * get_array_upper_bound     (const type *array, int dimension);
792
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
793
long      get_array_upper_bound_int (const type *array, int dimension);
794

Michael Beck's avatar
Michael Beck committed
795
/** Sets an array dimension to a specific order. */
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
796
void set_array_order (type *array, int dimension, int order);
Michael Beck's avatar
Michael Beck committed
797
798

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

Michael Beck's avatar
Michael Beck committed
801
802
803
804
/** Find the array dimension that is placed at order ord. */
int find_array_dimension(const type *array, int order);

/** Sets the array element type. */
805
void  set_array_element_type (type *array, type *tp);
Michael Beck's avatar
Michael Beck committed
806
807

/** Gets the array element type. */
808
809
type *get_array_element_type (type *array);

Michael Beck's avatar
Michael Beck committed
810
/** Sets the array element entity. */
811
void  set_array_element_entity (type *array, entity *ent);
Michael Beck's avatar
Michael Beck committed
812
813

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

816
/** Returns true if a type is an array type. */
817
int    is_Array_type(const type *array);
818

Sebastian Felis's avatar
Sebastian Felis committed
819
/**
Florian Liekweg's avatar
Florian Liekweg committed
820
 * @page enumeration_type   Representation of an enumeration type
821
 *
822
823
824
825
826
827
828
 * Enumeration types need not necessarily be represented explicitly
 * by Firm types, as the frontend can lower them to integer constants as
 * well.  For debugging purposes or similar tasks this information is useful.
 *
 * - *enum:         The target values representing the constants used to
 *                  represent individual enumerations.
 * - *enum_nameid:  Idents containing the source program name of the enumeration
Florian Liekweg's avatar
Florian Liekweg committed
829
 *                  constants
830
831
 */
/** Create a new type enumeration -- set the enumerators independently. */
832
type   *new_type_enumeration    (ident *name, int n_enums);
833
834

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

837
838
839
/* --- manipulate fields of enumeration type. --- */

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

842
/** Sets the enumeration value at a given position. */
843
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
844
845

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

848
/** Assign an ident to an enumeration value at a given position. */
849
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
850
851

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

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

857
/** Returns true if a type is a enumeration type. */
858
int     is_Enumeration_type     (const type *enumeration);
859

Sebastian Felis's avatar
Sebastian Felis committed
860
/**
Florian Liekweg's avatar
Florian Liekweg committed
861
 * @page pointer_type   Representation of a pointer type
862
 *
863
864
 * The mode of the pointer type must be a mode_reference.
 *
865
866
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
867
 */
Christian Schäfer's avatar
Christian Schäfer committed
868

869
/** Creates a new type pointer with mode mode_p. */
870
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
871
872
873
874
875
876

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

/** Creates a new type pointer given pointer mode and with debug information. */
type *new_d_type_pointer         (ident *name, type *points_to, ir_mode *ptr_mode, dbg_info* db);
877
878
879
880

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

/** Sets the type to which a pointer points to. */
881
void  set_pointer_points_to_type (type *pointer, type *tp);
882
883

/** Returns the type to which a pointer points to. */
884
885
type *get_pointer_points_to_type (type *pointer);

886
/** Returns true if a type is a pointer type. */
887
int   is_Pointer_type            (const type *pointer);
888

889
890
891
892
893
/** Returns the first pointer type that has as points_to tp.
 *  Not efficient: O(#types).
 *  If not found returns unknown_type. */
type *find_pointer_type_to_type (type *tp);

Sebastian Felis's avatar
Sebastian Felis committed
894
/**
895
896
897
898
899
 * @page primitive_type Representation of a primitive type
 *
 * Primitive types are types that represent indivisible data values that
 * map directly to modes.  They don't have a private attribute.  The
 * important information they carry is held in the common mode field.
Christian Schäfer's avatar
Christian Schäfer committed
900
*/
901
/** Creates a new primitive type. */
902
type *new_type_primitive (ident *name, ir_mode *mode);
903
904

/** Creates a new primitive type with debug information. */
905
type *new_d_type_primitive (ident *name, ir_mode *mode, dbg_info* db);
Christian Schäfer's avatar
Christian Schäfer committed
906

907
/** Returns true if a type is a primitive type. */
908
int  is_Primitive_type  (const type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
909

910

911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
/**
 * @page none_type
 *
 *  This type is an auxiliary type dedicated to support type analyses.
 *
 *  The none type represents that there is no type.  The type can be used to
 *  initialize fields of type* that actually can not contain a type or that
 *  are initialized for an analysis. There exists exactly one type none.
 *  This type is not on the type list in ir_prog. It is
 *  allocated when initializing the type module.
 *
 *  The following values are set:
 *    mode:  mode_BAD
 *    name:  "type_none"
 *    state: layout_fixed
 *    size:  0
 */
/* A variable that contains the only none type. */
929
extern type *firm_none_type;
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
/* Returns the none type */
type *get_none_type(void);

/**
 * @page unknown_type
 *
 *  This type is an auxiliary type dedicated to support type analyses.