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

Götz Lindenmaier's avatar
header    
Götz Lindenmaier 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
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
 *  	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
143
144
145
tp_op*      get_type_tpop(const type *tp);
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.
154
			  Address computation to access fields is not
155
156
157
			  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
159
160
			  have an offset assigned.  Size of the type is known.
			  Arrays can be accessed by explicit address
161
			  computation. Default for pointer, primitive and method
162
			  types.  */
163
} type_state;
164
165

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

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

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
208
209
210
/** 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);
211

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

Michael Beck's avatar
Michael Beck committed
239
void*         get_type_link(const type *tp);
240
void          set_type_link(type *tp, void *l);
241

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

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

Sebastian Felis's avatar
Sebastian Felis committed
268
269
/**
 *   Checks whether two types are structural equal.
Michael Beck's avatar
Michael Beck committed
270
271
272
273
274
275
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
276
 *    Types are equal if :
277
278
279
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
 *    - 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.)
 */
bool equal_type(type *tpy1, type *typ2);

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

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

/** Creates a new class type. */
374
type   *new_type_class (ident *name);
375
376

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

379
380
381
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
382
void    add_class_member   (type *clss, entity *member);
383
384

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

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

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
393
394
395
396
/** 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);

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

/** 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
403
404
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
405
void    set_class_members  (type *clss, entity *members[], int arity);
406
407

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

412

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

/** Returns the number of subtypes */
Michael Beck's avatar
Michael Beck committed
419
int     get_class_n_subtypes (const type *clss);
420
421

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

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

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

432

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

/** Returns the number of supertypes */
Michael Beck's avatar
Michael Beck committed
439
int     get_class_n_supertypes (const type *clss);
440
441

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

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

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

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

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

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

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

483
/** Returns true if a type is a class type. */
Michael Beck's avatar
Michael Beck committed
484
int is_class_type(const type *clss);
485
486

/** Returns true if low is subclass of high. */
487
bool is_subclass_of(type *low, type *high);
488

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

509
510
511
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
512
void    add_struct_member   (type *strct, entity *member);
513
514

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

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

/** 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. */
525
void    set_struct_member   (type *strct, int pos, entity *member);
526
527

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

530
/** Returns true if a type is a struct type. */
Michael Beck's avatar
Michael Beck committed
531
int     is_struct_type(const type *strct);
532

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

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

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

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

595
596
597
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
Michael Beck's avatar
Michael Beck committed
598
int   get_method_n_params  (const type *method);
599
600

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

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

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

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

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

642
/** Returns the variadicity of a method. */
Michael Beck's avatar
Michael Beck committed
643
variadicity get_method_variadicity(const type *method);
644
645

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

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

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

664
/** Returns true if a type is a method type. */
Michael Beck's avatar
Michael Beck committed
665
int   is_method_type     (const type *method);
666

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

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

682
683
684
/* --- manipulate private fields of struct --- */

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

/** Adds a new entity to a union type */
688
void    add_union_member (type *uni, entity *member);
689
690

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

/** Overwrites a entity at position pos in a union type. */
694
void    set_union_member (type *uni, int pos, entity *member);
695
696

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

699
/** Returns true if a type is a union type. */
Michael Beck's avatar
Michael Beck committed
700
int     is_union_type          (const type *uni);
701

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

/** 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.
 */
728
type *new_type_array         (ident *name, int n_dimensions,
729
			      type *element_type);
730
731
732
733
734
735
736

/** 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.
737
 * A legal array type must have at least one dimension set.
738
 */
739
740
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
741

742
743
744
/* --- manipulate private fields of array type --- */

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

/** Allocates Const nodes of mode_I for the array dimensions */
748
749
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
750
751
752
void  set_array_bounds       (type *array, int dimension, ir_node *lower_bound,
                                                          ir_node *upper_bound);
void  set_array_lower_bound  (type *array, int dimension, ir_node *lower_bound);
753
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
754
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
755
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
756
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
757
758
int       has_array_lower_bound     (const type *array, int dimension);
ir_node * get_array_lower_bound     (const type *array, int dimension);
759
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
760
long      get_array_lower_bound_int (const type *array, int dimension);
761
/** returns true if lower bound != Unknown */
Michael Beck's avatar
Michael Beck committed
762
763
int       has_array_upper_bound     (const type *array, int dimension);
ir_node * get_array_upper_bound     (const type *array, int dimension);
764
/** Works only if bound is Const node with tarval that can be converted to long. */
Michael Beck's avatar
Michael Beck committed
765
long      get_array_upper_bound_int (const type *array, int dimension);
766

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

770
void  set_array_element_type (type *array, type *tp);
771
772
type *get_array_element_type (type *array);

773
void  set_array_element_entity (type *array, entity *ent);
Michael Beck's avatar
Michael Beck committed
774
entity *get_array_element_entity (const type *array);
775

776
/** Returns true if a type is an array type. */
Michael Beck's avatar
Michael Beck committed
777
int    is_array_type(const type *array);
778

Sebastian Felis's avatar
Sebastian Felis committed
779
/**
780
 * @page enumeration_type	Representation of an enumeration type
781
 *
782
783
784
785
786
787
788
 * 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
Michael Beck's avatar
Michael Beck committed
789
 *  	            constants
790
791
 */
/** Create a new type enumeration -- set the enumerators independently. */
792
type   *new_type_enumeration    (ident *name, int n_enums);
793
794

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

797
798
799
/* --- manipulate fields of enumeration type. --- */

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

802
/** Sets the enumeration value at a given position. */
803
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
804
805

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

808
/** Assign an ident to an enumeration value at a given position. */
809
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
810
811

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

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

817
/** Returns true if a type is a enumeration type. */
Michael Beck's avatar
Michael Beck committed
818
int     is_enumeration_type     (const type *enumeration);
819

Sebastian Felis's avatar
Sebastian Felis committed
820
/**
821
822
 * @page pointer_type	Representation of a pointer type
 *
823
824
 * The mode of the pointer type must be a mode_reference.
 *
825
826
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
827
 */
Christian Schäfer's avatar
Christian Schäfer committed
828

829
/** Creates a new type pointer with mode mode_p. */
830
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
831
832
833
834
835
836

/** 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);
837
838
839
840

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

/** Sets the type to which a pointer points to. */
841
void  set_pointer_points_to_type (type *pointer, type *tp);
842
843

/** Returns the type to which a pointer points to. */
844
845
type *get_pointer_points_to_type (type *pointer);

846
/** Returns true if a type is a pointer type. */
Michael Beck's avatar
Michael Beck committed
847
int   is_pointer_type            (const type *pointer);
848

849
850
851
852
853
/** 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
854
/**
855
856
857
858
859
 * @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
860
*/
861
/** Creates a new primitive type. */
862
type *new_type_primitive (ident *name, ir_mode *mode);
863
864

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

867
/** Returns true if a type is a primitive type. */
Michael Beck's avatar
Michael Beck committed
868
int  is_primitive_type  (const type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
869

870

871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
/**
 * @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. */
extern type *none_type;
/* 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. */
extern type *unknown_type;
912
/* Returns the unknown type */
913
914
915
type *get_unknown_type(void);


Sebastian Felis's avatar
Sebastian Felis committed
916
/**
917
918
919
 *  Checks whether a type is atomic.
 *  @param tp - any type
 *  @return true if type is primitive, pointer or enumeration
920
 */
Michael Beck's avatar
Michael Beck committed
921
int is_atomic_type(const type *tp);
922

923
924
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
925
/**
926
927
928
929
930
931
932
933
934
935
 * Gets the number of elements in a firm compound type.
 *
 * This is just a comforability function, because structs and
 * classes can often be treated be the same code, but they have
 * different access functions to their members.
 *
 * @param tp  The type (must be struct, union or class).
 *
 * @return Number of members in the compound type.
 */
Michael Beck's avatar
Michael Beck committed
936
int get_compound_n_members(const type *tp);
937
938
939
940
941
942
943
944
945
946
947

/**
 * Gets the member of a firm compound type at position pos.
 *
 * @param tp  The type (must be struct, union or class).
 * @param pos The number of the member.
 *
 * @return The member entity at position pos.
 *
 * @see get_compound_n_members() for justifaction of existence.
 */
Michael Beck's avatar
Michael Beck committed
948
entity *get_compound_member(const type *tp, int pos);
949
950
951
952
953
954
955

/**
 *  Checks whether a type is compound.
 *
 *  @param tp - any type
 *
 *  @return true if the type is class, structure, union or array type.
956
 */
Michael Beck's avatar
Michael Beck committed
957
int is_compound_type(const type *tp);
958

959

960
961
962
963
964
/**
 *  Outputs a unique number for this type if libfirm is compiled for
 *  debugging, (configure with --enable-debug) else returns the address
 *  of the type cast to long.
 */
Michael Beck's avatar
Michael Beck committed
965
long get_type_nr(const type *tp);
966

Götz Lindenmaier's avatar
Götz Lindenmaier committed
967
968
969
970
971
972