type.h 35.4 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);

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
128
129
130
131
132
133
134
/** 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
 * referenced any more. */
135
136
void        free_type(type *tp);

137
138
139
140
141
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);

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

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

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

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

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

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

182
183
184
/** 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);
185

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


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

211
212
void*         get_type_link(type *tp);
void          set_type_link(type *tp, void *l);
213

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

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

Sebastian Felis's avatar
Sebastian Felis committed
240
241
/**
 *   Checks whether two types are structural equal.
Michael Beck's avatar
Michael Beck committed
242
243
244
245
246
247
 *
 *   @param st pointer type
 *   @param lt pointer type
 *
 *   @return
 *    true if the types are equal, else false.
248
 *    Types are equal if :
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
275
276
 *    - 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
277
278
/**
 *   Checks whether two types are structural comparable.
Michael Beck's avatar
Michael Beck committed
279
280
281
282
283
284
285
286
 *
 *   @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
287
288
289
290
291
292
293
294
295
296
297
 *    - 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
298
 *      @return counterpart in lt and the type is smaller
299
300
301
302
303
 *    - 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
304
 *      @return or
305
306
307
308
 *      - 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
309
310
 *      @return smaller than the points_to type of lt.
 *
311
312
313
 */
bool smaller_type (type *st, type *lt);

Sebastian Felis's avatar
Sebastian Felis committed
314
/**
315
316
 *  @page class_type	Representation of a class type
 *
317
318
319
320
 *  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???
321
322
323
324
325
 *  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.
326
 *
327
328
 *  The following two are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked:
329
 *
330
 *  - subtypes:   A list of direct subclasses.
331
 *
332
 *  - supertypes: A list of direct superclasses.
333
 *
334
335
336
337
338
339
340
341
 *  - 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.
342
 *
343
 */
344
345

/** Creates a new class type. */
346
type   *new_type_class (ident *name);
347
348

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

351
352
353
/* --- manipulate private fields of class type  --- */

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

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

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

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

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

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

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

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

384

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

/** Returns the number of subtypes */
391
int     get_class_n_subtypes (type *clss);
392
393

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

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

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

404

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

/** Returns the number of supertypes */
411
int     get_class_n_supertypes (type *clss);
412
413

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

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

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

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

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

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

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

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

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

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

481
482
483
/* --- manipulate private fields of struct --- */

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

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

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

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

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

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

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

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

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

567
568
569
/* -- manipulate private fields of method. -- */

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

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

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

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

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

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

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

619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
/**
 * 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);

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

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

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

653
654
655
/* --- manipulate private fields of struct --- */

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

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

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

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

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

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

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

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

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

711
712
713
/* --- manipulate private fields of array type --- */

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

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

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

734
void  set_array_element_type (type *array, type *tp);
735
736
type *get_array_element_type (type *array);

737
738
739
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

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

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

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

761
762
763
/* --- manipulate fields of enumeration type. --- */

/** Returns the number of enumeration values of this enumeration */
764
765
int     get_enumeration_n_enums (type *enumeration);

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

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

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

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

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

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

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

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

/** 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);
801
802
803
804

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

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

/** Returns the type to which a pointer points to. */
808
809
type *get_pointer_points_to_type (type *pointer);

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

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

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

831
/** Returns true if a type is a primitive type. */
832
int  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
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
878
879
/**
 * @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
880
/**
881
882
883
 *  Checks whether a type is atomic.
 *  @param tp - any type
 *  @return true if type is primitive, pointer or enumeration
884
885
886
 */
int is_atomic_type(type *tp);

887
888
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
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
918
919
 * 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.
920
921
922
 */
int is_compound_type(type *tp);

923

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
931
932
933
934
935
936
937
938
939
940
941
942
/*******************************************************************/
/** 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
943
# endif /* _TYPE_H_ */