type.h 38.1 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

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
47

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/** 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.
205
206
207
208
 *
 * For primitive, enumeration, pointer and method types the size
 * is always fixed. This call is legal but has no effect.
 */
209
void        set_type_size_bits(type *tp, int size);
210

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

Michael Beck's avatar
Michael Beck committed
215
216
/** 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
217
 * 1.) if a type has a mode, the alignment is the mode size.
Michael Beck's avatar
Michael Beck committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 * 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).
 */
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);
236
void          set_type_visited(type *tp, unsigned long num);
237
/* Sets visited field in type to type_visited. */
238
void          mark_type_visited(type *tp);
Michael Beck's avatar
Michael Beck committed
239
240
/* @@@ name clash!! int           type_visited(const type *tp); */
int           type_not_visited(const type *tp);
241

Michael Beck's avatar
Michael Beck committed
242
void*         get_type_link(const type *tp);
243
void          set_type_link(type *tp, void *l);
244

Sebastian Felis's avatar
Sebastian Felis committed
245
/**
246
247
248
249
250
251
252
 * 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.
253
 *
Sebastian Felis's avatar
Sebastian Felis committed
254
 * @see  typewalk
255
 */
Christian Schäfer's avatar
Christian Schäfer committed
256
extern unsigned long type_visited;
257
void          set_master_type_visited(unsigned long val);
258
259
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
260
261

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

Sebastian Felis's avatar
Sebastian Felis committed
271
/**
Florian Liekweg's avatar
Florian Liekweg committed
272
 *   Checks whether two types are structurally equal.
Michael Beck's avatar
Michael Beck committed
273
274
275
276
277
278
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
279
 *    Types are equal if :
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 *    - 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
306
int equal_type(type *tpy1, type *typ2);
307

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

Sebastian Felis's avatar
Sebastian Felis committed
345
/**
Florian Liekweg's avatar
Florian Liekweg committed
346
 *  @page class_type    Representation of a class type
347
 *
348
349
350
351
 *  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???
352
353
354
355
356
 *  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.
357
 *
358
359
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
360
 *
361
 *  - subtypes:   A list of direct subclasses.
362
 *
363
 *  - supertypes: A list of direct superclasses.
364
 *
365
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
Michael Beck's avatar
Michael Beck committed
366
 *                 "description" it only is a description of requirements to a class,
367
 *                 as, e.g., a Java interface.  The class will never be allocated.
Michael Beck's avatar
Michael Beck committed
368
 *                 Peculiarity inherited is only possible for entities.  An entity
369
370
371
372
 *                 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.
373
 *
374
 */
375
376

/** Creates a new class type. */
377
type   *new_type_class (ident *name);
378
379

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

382
383
384
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
385
void    add_class_member   (type *clss, entity *member);
386
387

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

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

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

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

400
/** Overwrites the member at position pos, 0 <= pos < n_member with
401
   the passed entity. */
402
void    set_class_member   (type *clss, entity *member, int pos);
403
404
405

/** Replaces complete member list in class type by the list passed.
   Copies the list passed. This function is necessary to reduce the number of members.
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
406
407
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
408
void    set_class_members  (type *clss, entity *members[], int arity);
409
410

/** Finds member in the list of members and removes it.
411
412
   Shrinks the member list, so iterate from the end!!!
   Does not deallocate the entity.  */
413
void    remove_class_member(type *clss, entity *member);
414

415

416
/** Adds subtype as subtype to clss.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
417
418
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
419
void    add_class_subtype   (type *clss, type *subtype);
420
421

/** Returns the number of subtypes */
Michael Beck's avatar
Michael Beck committed
422
int     get_class_n_subtypes (const type *clss);
423
424

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

Michael Beck's avatar
Michael Beck committed
427
/** Sets the subtype at position pos, 0 <= pos < n_subtype.
428
   Does not set the corresponding supertype relation for subtype: this might
429
   be a different position! */
430
void    set_class_subtype   (type *clss, type *subtype, int pos);
431
432

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

435

436
/** Adds supertype as supertype to class.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
437
438
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
439
void    add_class_supertype   (type *clss, type *supertype);
440
441

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

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

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

Michael Beck's avatar
Michael Beck committed
450
/** Sets the supertype at position pos, 0 <= pos < n_subtype.
451
   Does not set the corresponding subtype relation for supertype: this might
452
   be a different position! */
453
void    set_class_supertype   (type *clss, type *supertype, int pos);
454
455

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

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

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

481
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
482
   @todo This is an undocumented field, subject to change! */
483
void set_class_dfn (type *clss, int dfn);
Michael Beck's avatar
Michael Beck committed
484
int  get_class_dfn (const type *clss);
485

486
/** Returns true if a type is a class type. */
487
int is_Class_type(const type *clss);
488
489

/** Returns true if low is subclass of high. */
Michael Beck's avatar
Michael Beck committed
490
int is_subclass_of(type *low, type *high);
491

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

512
513
514
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
515
void    add_struct_member   (type *strct, entity *member);
516
517

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

/** Returns the member at position pos, 0 <= pos < n_member */
Michael Beck's avatar
Michael Beck committed
521
entity *get_struct_member   (const type *strct, int pos);
522
523
524
525
526
527

/** 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. */
528
void    set_struct_member   (type *strct, int pos, entity *member);
529
530

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

533
/** Returns true if a type is a struct type. */
534
int     is_Struct_type(const type *strct);
535

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

Michael Beck's avatar
Michael Beck committed
570
/* These macros define the suffixes for the types and entities used
571
572
573
574
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
575
576
/** Create a new method type.
 *
577
578
579
580
581
582
583
 * @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.
 */
584
type *new_type_method (ident *name, int n_param, int n_res);
585
586
587
588
589
590
591
592
593
594
595

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

598
599
600
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
Michael Beck's avatar
Michael Beck committed
601
int   get_method_n_params  (const type *method);
602
603

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

Michael Beck's avatar
Michael Beck committed
617
int   get_method_n_ress   (const type *method);
618
type *get_method_res_type(type *method, int pos);
619
620
621
/** 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. */
622
void  set_method_res_type(type *method, int pos, type* tp);
623
/** Returns an entity that represents the copied value result.  Only necessary
624
625
   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
626

627
628
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
629
 */
Michael Beck's avatar
Michael Beck committed
630
type *get_method_value_res_type(const type *method);
631

Michael Beck's avatar
Michael Beck committed
632
/**
633
634
635
636
637
 * 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
638
639
  variadicity_non_variadic, /**< non variadic */
  variadicity_variadic      /**< variadic */
640
641
} variadicity;

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

645
/** Returns the variadicity of a method. */
Michael Beck's avatar
Michael Beck committed
646
variadicity get_method_variadicity(const type *method);
647
648

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

651
652
653
654
655
656
/**
 * 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
657
int get_method_first_variadic_param_index(const type *method);
658
659
660
661
662
663
664
665
666

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

667
/** Returns true if a type is a method type. */
668
int   is_Method_type     (const type *method);
669

Sebastian Felis's avatar
Sebastian Felis committed
670
/**
Florian Liekweg's avatar
Florian Liekweg committed
671
 *   @page union_type   Representation of a union type.
672
 *
673
 *   The union type represents union types.
674
675
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
676
677
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
678
 */
679
/** Creates a new type union. */
680
type   *new_type_union (ident *name);
681
682

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

685
686
687
/* --- manipulate private fields of struct --- */

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

/** Adds a new entity to a union type */
691
void    add_union_member (type *uni, entity *member);
692
693

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

/** Overwrites a entity at position pos in a union type. */
697
void    set_union_member (type *uni, int pos, entity *member);
698
699

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

702
/** Returns true if a type is a union type. */
703
int     is_Union_type          (const type *uni);
704

Sebastian Felis's avatar
Sebastian Felis committed
705
/**
Florian Liekweg's avatar
Florian Liekweg committed
706
 * @page array_type Representation of an array type
707
708
709
710
711
712
713
714
715
716
717
718
 *
 * 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
719
 *   Do we need several entities?  One might want
Michael Beck's avatar
Michael Beck committed
720
721
 *   to select a dimension and not a single element in case of multi
 *   dimensional arrays.
722
 */
723
724
725
726
727
728
729
730

/** 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.
 */
731
type *new_type_array         (ident *name, int n_dimensions,
Florian Liekweg's avatar
Florian Liekweg committed
732
                  type *element_type);
733
734
735
736
737
738
739

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

745
746
747
/* --- manipulate private fields of array type --- */

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

Michael Beck's avatar
Michael Beck committed
750
751
752
753
/**
 * Allocates Const nodes of mode_I for one array dimension.
 * Upper bound in Firm is the element next to the last, ie [lower,upper[
 */
754
755
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
Michael Beck's avatar
Michael Beck committed
756
757
758
759
/**
 * Sets the bounds for one array dimension.
 * Upper bound in Firm is the element next to the last, ie [lower,upper[
 */
760
761
void  set_array_bounds       (type *array, int dimension, ir_node *lower_bound,
                                                          ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
762
/** Sets the lower bound for one array dimension, ie [lower,upper[ */
763
void  set_array_lower_bound  (type *array, int dimension, ir_node *lower_bound);
Michael Beck's avatar
Michael Beck committed
764
765
766

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

/** Sets the upper bound for one array dimension, ie [lower,upper[ */
770
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
Michael Beck's avatar
Michael Beck committed
771
772
773
774
775

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

776
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
777
778
int       has_array_lower_bound     (const type *array, int dimension);
ir_node * get_array_lower_bound     (const type *array, int dimension);
779
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
780
long      get_array_lower_bound_int (const type *array, int dimension);
781
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
782
783
int       has_array_upper_bound     (const type *array, int dimension);
ir_node * get_array_upper_bound     (const type *array, int dimension);
784
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
785
long      get_array_upper_bound_int (const type *array, int dimension);
786

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
787
void set_array_order (type *array, int dimension, int order);
Michael Beck's avatar
Michael Beck committed
788
int  get_array_order (const type *array, int dimension);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
789

790
void  set_array_element_type (type *array, type *tp);
791
792
type *get_array_element_type (type *array);

793
void  set_array_element_entity (type *array, entity *ent);
Michael Beck's avatar
Michael Beck committed
794
entity *get_array_element_entity (const type *array);
795

796
/** Returns true if a type is an array type. */
797
int    is_Array_type(const type *array);
798

Sebastian Felis's avatar
Sebastian Felis committed
799
/**
Florian Liekweg's avatar
Florian Liekweg committed
800
 * @page enumeration_type   Representation of an enumeration type
801
 *
802
803
804
805
806
807
808
 * 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
809
 *                  constants
810
811
 */
/** Create a new type enumeration -- set the enumerators independently. */
812
type   *new_type_enumeration    (ident *name, int n_enums);
813
814

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

817
818
819
/* --- manipulate fields of enumeration type. --- */

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

822
/** Sets the enumeration value at a given position. */
823
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
824
825

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

828
/** Assign an ident to an enumeration value at a given position. */
829
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
830
831

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

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

837
/** Returns true if a type is a enumeration type. */
838
int     is_Enumeration_type     (const type *enumeration);
839

Sebastian Felis's avatar
Sebastian Felis committed
840
/**
Florian Liekweg's avatar
Florian Liekweg committed
841
 * @page pointer_type   Representation of a pointer type
842
 *
843
844
 * The mode of the pointer type must be a mode_reference.
 *
845
846
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
847
 */
Christian Schäfer's avatar
Christian Schäfer committed
848

849
/** Creates a new type pointer with mode mode_p. */
850
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
851
852
853
854
855
856

/** 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);
857
858
859
860

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

/** Sets the type to which a pointer points to. */
861
void  set_pointer_points_to_type (type *pointer, type *tp);
862
863

/** Returns the type to which a pointer points to. */
864
865
type *get_pointer_points_to_type (type *pointer);

866
/** Returns true if a type is a pointer type. */
867
int   is_Pointer_type            (const type *pointer);
868

869
870
871
872
873
/** 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
874
/**
875
876
877
878
879
 * @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
880
*/
881
/** Creates a new primitive type. */
882
type *new_type_primitive (ident *name, ir_mode *mode);
883
884

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

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

890

891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
/**
 * @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. */
909
extern type *firm_none_type;
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
/* Returns the none type */
type *get_none_type(void);

/**
 * @page unknown_type
 *
 *  This type is an auxiliary type dedicated to support type analyses.
 *
 *  The unknown type represents that there could be a type, but it is not
 *  known.  This type can be used to initialize fields before an analysis (not known
 *  yet) or to represent the top of a lattice (could not be determined).  There exists
 *  exactly one type unknown. 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_ANY
 *    name:  "type_unknown"
 *    state: layout_fixed
 *    size:  0
 */
/* A variable that contains the only unknown type. */
931
extern type *firm_unknown_type;
932
/* Returns the unknown type */
933
934
935
type *get_unknown_type(void);


Sebastian Felis's avatar
Sebastian Felis committed
936
/**