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_

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

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

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

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

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

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

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

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

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

149
/** The state of the type layout. */
150
typedef enum {
Michael Beck's avatar
Michael Beck committed
151
  layout_undefined,    /**< The layout of this type is not defined.
152
			  Address computation to access fields is not
153
154
155
			  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
156
  layout_fixed         /**< The layout is fixed, all component/member entities
157
158
			  have an offset assigned.  Size of the type is known.
			  Arrays can be accessed by explicit address
159
			  computation. Default for pointer, primitive and method
160
			  types.  */
161
} type_state;
162
163

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/** Creates a new class type. */
372
type   *new_type_class (ident *name);
373
374

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

377
378
379
/* --- manipulate private fields of class type  --- */

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

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

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

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

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

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

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

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

410

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

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

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

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

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

430

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

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

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

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

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

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

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

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

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

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

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

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

507
508
509
/* --- manipulate private fields of struct --- */

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

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

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

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

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

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

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

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

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

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

593
594
595
/* -- manipulate private fields of method. -- */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

740
741
742
/* --- manipulate private fields of array type --- */

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

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

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

768
void  set_array_element_type (type *array, type *tp);
769
770
type *get_array_element_type (type *array);

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

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

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

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

795
796
797
/* --- manipulate fields of enumeration type. --- */

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

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

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

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

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

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

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

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

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

/** 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);
835
836
837
838

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

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

/** Returns the type to which a pointer points to. */
842
843
type *get_pointer_points_to_type (type *pointer);

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

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

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

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

868

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
/**
 * @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;
910
/* Returns the unknown type */
911
912
913
type *get_unknown_type(void);


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

921
922
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
923
/**
924
925
926
927
928
929
930
931
932
933
 * 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
934
int get_compound_n_members(const type *tp);
935
936
937
938
939
940
941
942
943
944
945

/**
 * 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
946
entity *get_compound_member(const type *tp, int pos);
947
948
949
950
951
952
953

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

957

958
959
960
961
962
/**
 *  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.
 */