type.h 35.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
85
86
87
 *               occupy size bytes in memory.  In several cases this is
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
88
 *  - state:     The state of the type.  The state represents whether the
Götz Lindenmaier's avatar
Götz Lindenmaier committed
89
90
91
92
93
94
95
96
 *               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.
97
98
 *  - visit:     A counter for walks of the type information.
 *  - link:      A void* to associate some additional information with the type.
99
 *
Michael Beck's avatar
Michael Beck committed
100
 *  These fields can only be accessed via access functions.
101
 *
102
 *  Depending on the value of @c type_op, i.e., depending on the kind of the
Michael Beck's avatar
Michael Beck committed
103
 *  type the adt contains further attributes.  These are documented below.
104
105
106
107
108
109
110
111
112
113
 *
 *  @see
 *
 *  @link class_type class @endlink, @link struct_type struct @endlink,
 *  @link method_type method @endlink, @link union_type union @endlink,
 *  @link array_type array @endlink, @link enumeration_type enumeration @endlink,
 *  @link pointer_type pointer @endlink, @link primitive_type primitive @endlink
 *
 *  @todo
 *  	mode maybe not global field??
114
 */
115
116
#ifndef _TYPE_TYPEDEF_
#define _TYPE_TYPEDEF_
117
typedef struct type type;
118
#endif
119

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

122
123
124
125
126
127
/** 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);

Michael Beck's avatar
Michael Beck committed
128
/** Frees the memory used by the type.   Does not free the entities
129
130
131
132
    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 referenced any more. */
133
134
void        free_type(type *tp);

135
136
137
138
139
tp_op*      get_type_tpop(type *tp);
ident*      get_type_tpop_nameid(type *tp);
const char* get_type_tpop_name(type *tp);
tp_opcode   get_type_tpop_code(type *tp);

140
141
ident*      get_type_ident(type *tp);
void        set_type_ident(type *tp, ident* id);
142
143
const char* get_type_name(type *tp);

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

/** Returns the type layout state of a type. */
159
type_state  get_type_state(type *tp);
160
161
162
163
164
165

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

168
169
170
171
/** Returns the mode of a type.
 *
 * Returns NULL for all non atomic types.
 */
172
ir_mode*    get_type_mode(type *tp);
173
174
175

/** Sets the mode of a type.
 *
176
 * Only has an effect on primitive, enumeration and pointer types.
177
 */
178
179
void        set_type_mode(type *tp, ir_mode* m);

180
181
182
/** Returns the size of a type in bytes, retuns -1 if the size is NOT
 *  a byte size, ie not dividable by 8. */
int         get_type_size_bytes(type *tp);
183

184
185
186
187
188
189
190
191
192
193
194
/** Returns the size of a type in bits. */
int         get_type_size_bits(type *tp);

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


202
unsigned long get_type_visited(type *tp);
203
void          set_type_visited(type *tp, unsigned long num);
204
/* Sets visited field in type to type_visited. */
205
void          mark_type_visited(type *tp);
206
207
/* @@@ name clash!! int           type_visited(type *tp); */
int           type_not_visited(type *tp);
208

209
210
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
211

Sebastian Felis's avatar
Sebastian Felis committed
212
/**
213
214
215
216
217
218
219
 * 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.
220
 *
Sebastian Felis's avatar
Sebastian Felis committed
221
 * @see  typewalk
222
 */
Christian Schäfer's avatar
Christian Schäfer committed
223
extern unsigned long type_visited;
224
void          set_master_type_visited(unsigned long val);
225
226
unsigned long get_master_type_visited(void);
void          inc_master_type_visited(void);
Sebastian Felis's avatar
Sebastian Felis committed
227
228

/**
229
 * Checks whether a pointer points to a type.
Sebastian Felis's avatar
Sebastian Felis committed
230
 *
231
 * @param thing     an arbitrary pointer
Sebastian Felis's avatar
Sebastian Felis committed
232
 *
233
234
 * @return
 *     true if the thing is a type, else false
235
236
 */
int is_type            (void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
237

Sebastian Felis's avatar
Sebastian Felis committed
238
239
/**
 *   Checks whether two types are structural equal.
Michael Beck's avatar
Michael Beck committed
240
241
242
243
244
245
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
246
 *    Types are equal if :
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 *    - 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
275
276
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
277
278
279
280
281
282
283
284
 *
 *   @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
285
286
287
288
289
290
291
292
293
294
295
 *    - 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
296
 *      @return counterpart in lt and the type is smaller
297
298
299
300
301
 *    - 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
302
 *      @return or
303
304
305
306
 *      - 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
307
308
 *      @return smaller than the points_to type of lt.
 *
309
310
311
 */
bool smaller_type (type *st, type *lt);

Sebastian Felis's avatar
Sebastian Felis committed
312
/**
313
314
 *  @page class_type	Representation of a class type
 *
315
316
317
318
 *  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???
319
320
321
322
323
 *  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.
324
 *
325
326
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
327
 *
328
 *  - subtypes:   A list of direct subclasses.
329
 *
330
 *  - supertypes: A list of direct superclasses.
331
 *
332
333
334
335
336
337
338
339
 *  - peculiarity: The peculiarity of this class.  If the class is of peculiarity
 *                 "description" it only is a description of requirememts to a class,
 *                 as, e.g., a Java interface.  The class will never be allocated.
 *                 Peculiatity inherited is only possible for entities.  An entity
 *                 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.
340
 *
341
 */
342
343

/** Creates a new class type. */
344
type   *new_type_class (ident *name);
345
346

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

349
350
351
/* --- manipulate private fields of class type  --- */

/** Adds the entity as member of the class.  */
352
void    add_class_member   (type *clss, entity *member);
353
354

/** Returns the number of members of this class. */
355
int     get_class_n_members (type *clss);
356
357

/** Returns the member at position pos, 0 <= pos < n_member */
358
entity *get_class_member   (type *clss, int pos);
359

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
363
364
365
366
/** 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);

367
/** Overwrites the member at position pos, 0 <= pos < n_member with
368
   the passed entity. */
369
void    set_class_member   (type *clss, entity *member, int pos);
370
371
372

/** 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
373
374
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
375
void    set_class_members  (type *clss, entity *members[], int arity);
376
377

/** Finds member in the list of members and removes it.
378
379
   Shrinks the member list, so iterate from the end!!!
   Does not deallocate the entity.  */
380
void    remove_class_member(type *clss, entity *member);
381

382

383
/** Adds subtype as subtype to clss.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
384
385
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
386
void    add_class_subtype   (type *clss, type *subtype);
387
388

/** Returns the number of subtypes */
389
int     get_class_n_subtypes (type *clss);
390
391

/** Gets the subtype at position pos, 0 <= pos < n_subtype. */
392
type   *get_class_subtype   (type *clss, int pos);
393
394
395

/** Sets the subtype at positioin pos, 0 <= pos < n_subtype.
   Does not set the corresponding supertype relation for subtype: this might
396
   be a different position! */
397
void    set_class_subtype   (type *clss, type *subtype, int pos);
398
399

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

402

403
/** Adds supertype as supertype to class.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
404
405
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
406
void    add_class_supertype   (type *clss, type *supertype);
407
408

/** Returns the number of supertypes */
409
int     get_class_n_supertypes (type *clss);
410
411

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

/** Gets the supertype at position pos,  0 <= pos < n_supertype. */
415
type   *get_class_supertype   (type *clss, int pos);
416
417
418

/** Sets the supertype at postition pos, 0 <= pos < n_subtype.
   Does not set the corresponding subtype relation for supertype: this might
419
   be a different position! */
420
void    set_class_supertype   (type *clss, type *supertype, int pos);
421
422

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

Michael Beck's avatar
Michael Beck committed
425
/** This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
426
typedef enum peculiarity {
427
  peculiarity_description,     /**< Represents only a description.  The entity/type is never
Götz Lindenmaier's avatar
Götz Lindenmaier committed
428
429
	  	                    allocated, no code/data exists for this entity/type.
			            @@@ eventually rename to descriptive (adjectiv as the others!)*/
430
431
432
433
434
  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
435
436
 		                    overwritten ones.
			            Only for entity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
437
438
439
  peculiarity_existent         /**< The entity/type (can) exist.
				    @@@ eventually rename to 'real' i.e., 'echt'
			            This serves better as opposition to description _and_ inherited.*/
440
} peculiarity;
Götz Lindenmaier's avatar
Götz Lindenmaier committed
441
char *get_peculiarity_string(peculiarity p);
442
443
444

/* The peculiarity of the class.  The enumeration peculiarity is defined
   in entity.h */
445
446
peculiarity get_class_peculiarity (type *clss);
void        set_class_peculiarity (type *clss, peculiarity pec);
447

448
/* Set and get a class' dfn --
Michael Beck's avatar
Michael Beck committed
449
   @todo This is an undocumented field, subject to change! */
450
451
void set_class_dfn (type *clss, int dfn);
int  get_class_dfn (type *clss);
452

453
/** Returns true if a type is a class type. */
454
int is_class_type(type *clss);
455
456

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

Sebastian Felis's avatar
Sebastian Felis committed
459
/**
460
461
 *  @page struct_type	Representation of a struct type
 *
462
463
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
464
465
466
467
468
469
470
471
472
 *  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.
473
 */
474
/** Creates a new type struct */
475
type   *new_type_struct (ident *name);
476
/** Creates a new type struct with debug information. */
477
type   *new_d_type_struct (ident *name, dbg_info* db);
478

479
480
481
/* --- manipulate private fields of struct --- */

/** Adds the entity as member of the struct.  */
482
void    add_struct_member   (type *strct, entity *member);
483
484

/** Returns the number of members of this struct. */
485
int     get_struct_n_members (type *strct);
486
487

/** Returns the member at position pos, 0 <= pos < n_member */
488
entity *get_struct_member   (type *strct, int pos);
489
490
491
492
493
494

/** 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. */
495
void    set_struct_member   (type *strct, int pos, entity *member);
496
497

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

500
/** Returns true if a type is a struct type. */
501
int     is_struct_type(type *strct);
502

Sebastian Felis's avatar
Sebastian Felis committed
503
/**
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 * @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.)
 *
521
522
523
524
 * - value_param_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent parameters passed by value.
 *
525
526
527
528
529
530
 * - 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.)
531
532
533
534
 *
 * - value_res_ents
 *               A list of entities (whose owner is a struct private to the
 *               method type) that represent results passed by value.
535
536
 */

537
538
539
540
541
/* These makros define the suffixes for the types and entities used
   to represent value parameters / results. */
#define VALUE_PARAMS_SUFFIX  "val_param"
#define VALUE_RESS_SUFFIX    "val_res"

Michael Beck's avatar
Michael Beck committed
542
543
/** Create a new method type.
 *
544
545
546
547
548
549
550
 * @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.
 */
551
type *new_type_method (ident *name, int n_param, int n_res);
552
553
554
555
556
557
558
559
560
561
562

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

565
566
567
/* -- manipulate private fields of method. -- */

/** Returns the number of parameters of this method. */
568
int   get_method_n_params  (type *method);
569
570

/** Returns the type of the parameter at position pos of a method. */
571
type *get_method_param_type(type *method, int pos);
572
573
574
/** 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. */
575
void  set_method_param_type(type *method, int pos, type* tp);
576
/** Returns an entity that represents the copied value argument.  Only necessary
577
578
   for compounds passed by value. This information is constructed only on demand. */
entity *get_method_value_param_ent(type *method, int pos);
579
580
581
582
/**
 * Returns a type that represents the copied value arguments.
 */
type *get_method_value_param_type(type *method);
583

584
int   get_method_n_ress   (type *method);
585
type *get_method_res_type(type *method, int pos);
586
587
588
/** 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. */
589
void  set_method_res_type(type *method, int pos, type* tp);
590
/** Returns an entity that represents the copied value result.  Only necessary
591
592
   for compounds passed by value. This information is constructed only on demand. */
entity *get_method_value_res_ent(type *method, int pos);
593
594
/**
 * Returns a type that represents the copied value results.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
595
596
 */
type *get_method_value_res_type(type *method);
597

Michael Beck's avatar
Michael Beck committed
598
/**
599
600
601
602
603
 * 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
604
605
  variadicity_non_variadic,	/**< non variadic */
  variadicity_variadic		/**< variadic */
606
607
} variadicity;

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

611
/** Returns the variadicity of a method. */
612
variadicity get_method_variadicity(type *method);
613
614

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

617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
/**
 * 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.
 */
int get_method_first_variadic_param_index(type *method);

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

633
/** Returns true if a type is a method type. */
634
int   is_method_type     (type *method);
635

Sebastian Felis's avatar
Sebastian Felis committed
636
/**
637
638
 *   @page union_type	Representation of a union type.
 *
639
 *   The union type represents union types.
640
641
 *   - n_types:     Number of unioned types.
 *   - members:     Entities for unioned types.  Fixed length array.
642
643
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
644
 */
645
/** Creates a new type union. */
646
type   *new_type_union (ident *name);
647
648

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

651
652
653
/* --- manipulate private fields of struct --- */

/** Returns the number of unioned types of this union */
654
int     get_union_n_members      (type *uni);
655
656

/** Adds a new entity to a union type */
657
void    add_union_member (type *uni, entity *member);
658
659

/** Returns the entity at position pos of a union */
660
entity *get_union_member (type *uni, int pos);
661
662

/** Overwrites a entity at position pos in a union type. */
663
void    set_union_member (type *uni, int pos, entity *member);
664
665

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

668
/** Returns true if a type is a union type. */
669
int     is_union_type          (type *uni);
670

Sebastian Felis's avatar
Sebastian Felis committed
671
/**
672
673
674
675
676
677
678
679
680
681
682
683
684
 * @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
685
686
 *   Do we need several entities?  One might want
 *   to select a dimension and not a single element in case of multidim arrays.
687
 */
688
689
690
691
692
693
694
695

/** 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.
 */
696
type *new_type_array         (ident *name, int n_dimensions,
697
			      type *element_type);
698
699
700
701
702
703
704
705

/** 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.
 */
706
707
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
708

709
710
711
/* --- manipulate private fields of array type --- */

/** Returns the number of array dimensions of this type. */
712
int   get_array_n_dimensions (type *array);
713
714

/** Allocates Const nodes of mode_I for the array dimensions */
715
716
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
717
718
719
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);
720
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
721
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
722
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
723
/* returns true if lower bound != Unknown */
724
int       has_array_lower_bound  (type *array, int dimension);
725
ir_node * get_array_lower_bound  (type *array, int dimension);
726
int       has_array_upper_bound  (type *array, int dimension);
727
ir_node * get_array_upper_bound  (type *array, int dimension);
728

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
729
730
731
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

732
void  set_array_element_type (type *array, type *tp);
733
734
type *get_array_element_type (type *array);

735
736
737
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

738
/** Returns true if a type is an array type. */
739
int    is_array_type(type *array);
740

Sebastian Felis's avatar
Sebastian Felis committed
741
/**
742
 * @page enumeration_type	Representation of an enumeration type
743
 *
744
745
746
747
748
749
750
751
752
753
 * 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
 *  	     constants
 */
/** Create a new type enumeration -- set the enumerators independently. */
754
type   *new_type_enumeration    (ident *name, int n_enums);
755
756

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

759
760
761
/* --- manipulate fields of enumeration type. --- */

/** Returns the number of enumeration values of this enumeration */
762
763
int     get_enumeration_n_enums (type *enumeration);

764
/** Sets the enumeration value at a given position. */
765
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
766
767

/** Returns the enumeration value at a given position. */
768
769
tarval *get_enumeration_enum    (type *enumeration, int pos);

770
/** Assign an ident to an enumeration value at a given position. */
771
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
772
773

/** Returns the assigned ident of an enumeration value at a given position. */
774
ident  *get_enumeration_nameid  (type *enumeration, int pos);
775
776

/** Returns the assigned name of an enumeration value at a given position. */
777
778
const char *get_enumeration_name(type *enumeration, int pos);

779
/** Returns true if a type is a enumeration type. */
780
int     is_enumeration_type     (type *enumeration);
781

Sebastian Felis's avatar
Sebastian Felis committed
782
/**
783
784
 * @page pointer_type	Representation of a pointer type
 *
785
786
 * The mode of the pointer type must be a mode_reference.
 *
787
788
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
789
 */
Christian Schäfer's avatar
Christian Schäfer committed
790

791
/** Creates a new type pointer with mode mode_p. */
792
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
793
794
795
796
797
798

/** 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);
799
800
801
802

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

/** Sets the type to which a pointer points to. */
803
void  set_pointer_points_to_type (type *pointer, type *tp);
804
805

/** Returns the type to which a pointer points to. */
806
807
type *get_pointer_points_to_type (type *pointer);

808
/** Returns true if a type is a pointer type. */
809
int   is_pointer_type            (type *pointer);
810

811
812
813
814
815
/** 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
816
/**
817
818
819
820
821
 * @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
822
*/
823
/** Creates a new primitive type. */
824
type *new_type_primitive (ident *name, ir_mode *mode);
825
826

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

829
/** Returns true if a type is a primitive type. */
830
int  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
831

832

833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
/**
 * @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;
/* Returns the none type */
type *get_unknown_type(void);


Sebastian Felis's avatar
Sebastian Felis committed
878
/**
879
880
881
 *  Checks whether a type is atomic.
 *  @param tp - any type
 *  @return true if type is primitive, pointer or enumeration
882
883
884
 */
int is_atomic_type(type *tp);

885
886
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
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
912
913
914
915
916
917
 * 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.
 */
int get_compound_n_members(type *tp);

/**
 * 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.
 */
entity *get_compound_member(type *tp, int pos);

/**
 *  Checks whether a type is compound.
 *
 *  @param tp - any type
 *
 *  @return true if the type is class, structure, union or array type.
918
919
920
 */
int is_compound_type(type *tp);

921

922
923
924
925
926
/**
 *  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.
 */
927
long get_type_nr(type *tp);
928

Götz Lindenmaier's avatar
Götz Lindenmaier committed
929
930
931
932
933
934
935
936
937
938
939
940
/*******************************************************************/
/** Debug aides                                                   **/
/*******************************************************************/


/** Write the type and all its attributes to stdout.
 *
 *  Writes the type and all its attributes to stdout if DEBUG_libfirm
 *  is set.  Else does nothing. */
void    dump_type (type *tp);


Christian Schäfer's avatar
Christian Schäfer committed
941
# endif /* _TYPE_H_ */