type.h 21.2 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
/****h* libfirm/type6 2002/03/19 13:08:33
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 *
 * NAME
 *   file type.h - datastructure to hold type information.
 * COPYRIGHT
 *  (C) 2001 by Universitaet Karlsruhe
 * AUTHORS
 *  Goetz Lindenmaier
 *
 * NOTES
 *  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
 *  between these types.
 *
 *  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.
 *
 * SEE ALSO
 *   tpop.h
 *****
 */
Boris Boesler's avatar
Boris Boesler committed
30
31
32

/* $Id$ */

Christian Schäfer's avatar
Christian Schäfer committed
33
34
35
# ifndef _TYPE_H_
# define _TYPE_H_

36
# include "tpop.h"
Christian Schäfer's avatar
Christian Schäfer committed
37
38
39
# include "common.h"
# include "ident.h"
# include "irmode.h"
40
# include "bool.h"
Christian Schäfer's avatar
Christian Schäfer committed
41

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

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

49
50
51
52
53
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/****s* type/type
 *
 * NAME
 *   type - An abstract data type to represent types.
 * NOTE
 *  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.
 *
 * ATTRIBUTES
 *  The common fields are:
 *
 *  firm_kind    A firm_kind tag containing k_type.  This is useful
 *               for dynamically checking whether a node is a type node.
 *  type_op      A tp_op specifying the kind of the type.
 *  mode         The mode to be used to represent the type on a machine.
 *               @@@ maybe not global field??
 *  name         An identifier specifying the name of the type.  To be
 *               set by the frontend.
 *  size         The size of the type, i.e. an entity of this type will
 *               occupy size bytes in memory.  In several cases this is
 *               determined when fixing the layout of this type (class,
 *               struct, union, array, enumeration).
Götz Lindenmaier's avatar
Götz Lindenmaier committed
87
88
89
90
91
92
93
94
95
 *  state        The state of the type.  The state represents whether the
 *               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.
96
 *  visit        A counter for walks of the type information.
97
 *  link         A void* to associate some additional information with the type.
98
99
100
101
102
103
104
105
106
107
108
 *
 *  These fields can only be accessed via access functions.
 *
 *  Depending on the value of type_op, i.e., depending on the kind of the
 *  type the adt contains further attributes.  These are documented below.
 * SEE ALSO
 *   class, struct, method, union, array, enumeration, pointer, primitive
 * SOURCE
 */
typedef struct type type;

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
109
110
# include "type_or_entity.h"

111
112
113
114
/* Frees the memory used by the type.   Does not free the entities
   belonging to the type, except for the array element entity.  */
void        free_type(type *tp);

115
116
117
118
119
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);

120
121
ident*      get_type_ident(type *tp);
void        set_type_ident(type *tp, ident* id);
122
123
const char* get_type_name(type *tp);

124
125
126
typedef enum {
  layout_undefined,    /* The layout of this type is not defined.
			  Address computation to access fields is not
127
128
129
			  possible, fields must be accessed by Sel
			  nodes.  This is the default value except for
			  pointer, primitive and method types. */
130
131
132
  layout_fixed         /* The layout is fixed, all component/member entities
			  have an offset assigned.  Size of the type is known.
			  Arrays can be accessed by explicit address
133
134
			  computation. Default for pointer, primitive ane method
			  types.  */
135
136
} type_state;
type_state  get_type_state(type *tp);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
137
/* For primitives, pointer and method types the layout is always fixed.
138
139
140
   This call is legal but has no effect. */
void        set_type_state(type *tp, type_state state);

141
142
143
144
145
146
147
148
149
150
151
/* Returns NULL for all non atomic types. */
ir_mode*    get_type_mode(type *tp);
/* Only has an effect on primitive and enumeration types */
void        set_type_mode(type *tp, ir_mode* m);

int         get_type_size(type *tp);
/* For primitive, enumeration, pointer and method types the size
   is always fixed. This call is legal but has no effect. */
void        set_type_size(type *tp, int size);


152
153
154
155
unsigned long get_type_visited(type *tp);
void        set_type_visited(type *tp, unsigned long num);
/* Sets visited field in type to type_visited. */
void        mark_type_visited(type *tp);
156
157
158

void*       get_type_link(type *tp);
void        set_type_link(type *tp, void *l);
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*****/

/****v* type/visited
 *
 * NAME
 *   type_visited -  visited flag to traverse the type information
 * PURPOSE
 *   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.
 * SEE ALSO
 *   typewalk
 * SOURCE
 */
Christian Schäfer's avatar
Christian Schäfer committed
175
extern unsigned long type_visited;
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*****/

/****f* type/is_type
 *
 * NAME
 *   is_type - Checks whether a pointer points to a type.
 * SYNOPSIS
 *   bool is_type            (void *thing);
 * INPUTS
 *   thing - a pointer
 * RESULT
 *   true if the thing is a type, else false
 ***
 */
int is_type            (void *thing);
Christian Schäfer's avatar
Christian Schäfer committed
191

192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/****** type/class
 * NAME
 *  Representation of a class type.
 * NOTE
 *  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???
 * ATTRIBUTES
 *  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.
 *
 *  subtypes   A list of direct subclasses.
 *
 *  supertypes A list of direct superclasses.
 *
 *  These are dynamic lists that can be grown with an "add_" function,
 *  but not shrinked.
213
214
215
216
 *
 *  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.
217
218
219
220
221
 *             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.
222
 *
223
224
225
226
227
 * SOURCE
 */
/* create a new class type */
type   *new_type_class (ident *name);

228
229
/** manipulate private fields of class type  **/
/* Adds the entity as member of the class.  */
230
void    add_class_member   (type *clss, entity *member);
231
/* Returns the number of members of this class. */
232
int     get_class_n_members (type *clss);
233
/* Returns the member at position pos, 0 <= pos < n_member */
234
entity *get_class_member   (type *clss, int pos);
235
236
/* Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
237
void    set_class_member   (type *clss, entity *member, int pos);
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
238
239
240
241
242
/* 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.
   members is an array of entities, num the size of this array.  Sets all
   owners of the members passed to clss. */
void    set_class_members  (type *clss, entity **members, int arity);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
243
244
/* Finds member in the list of members and overwrites it with NULL
 @@@ Doesn't work properly. */
245
void    remove_class_member(type *clss, entity *member);
246

247

Götz Lindenmaier's avatar
Götz Lindenmaier committed
248
249
250
/* Adds subtype as subtype to clss.
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
251
void    add_class_subtype   (type *clss, type *subtype);
252
/* Returns the number of subtypes */
253
int     get_class_n_subtypes (type *clss);
254
/* Gets the subtype at position pos, 0 <= pos < n_subtype. */
255
type   *get_class_subtype   (type *clss, int pos);
256
257
258
/* Sets the subtype at positioin pos, 0 <= pos < n_subtype.  Does not
   set the corresponding supertype relation for subtype: this might
   be a different position! */
259
void    set_class_subtype   (type *clss, type *subtype, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
260
261
/* Finds subtype in the list of subtypes and overwrites it with NULL
 @@@ Doesn't work properly. */
262
263
void    remove_class_subtype(type *clss, type *subtype);

264

Götz Lindenmaier's avatar
Götz Lindenmaier committed
265
266
267
/* Adds supertype as supertype to class.
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
268
void    add_class_supertype   (type *clss, type *supertype);
269
/* Returns the number of supertypes */
270
int     get_class_n_supertypes (type *clss);
271
/* Gets the supertype at position pos,  0 <= pos < n_supertype. */
272
type   *get_class_supertype   (type *clss, int pos);
273
274
275
/* Sets the supertype at postition pos, 0 <= pos < n_subtype.  Does not
   set the corresponding subtype relation for supertype: this might
   be a different position! */
276
void    set_class_supertype   (type *clss, type *supertype, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
277
278
/* Finds supertype in the list of supertypes and overwrites it with NULL
 @@@ Doesn't work properly. */
279
void    remove_class_supertype(type *clss, type *supertype);
280

281
/* This enumeration flags the peculiarity of entities and types. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
282
typedef enum peculiarity {
283
284
  description,     /* Represents only a description.  The entity/type is never
	  	      allocated, no code/data exists for this entity/type. */
285
286
287
288
289
  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 overwritten ones. */
290
291
292
293
294
  existent         /* The entity/type (can) exist. */
} peculiarity;

/* The peculiarity of the class.  The enumeration peculiarity is defined
   in entity.h */
295
296
INLINE peculiarity get_class_peculiarity (type *clss);
INLINE void        set_class_peculiarity (type *clss, peculiarity pec);
297

298
299
/* Set and get a class' dfn --
   @@@ This is an undocumented field, subject to change! */
300
301
302
void set_class_dfn (type*, int);
int  get_class_dfn (type*);

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
/* typecheck */
bool    is_class_type(type *clss);
/*****/

/****** type/struct
 * NAME
 *  Representation of a struct type.
 * NOTE
 *  Type_strct represents aggregate types that consist of a list
 *  of fields.
 * ATTRIBUTES
 *  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.
320
321
 *           This is a dynamic list that can be grown with an "add_" function,
 *           but not shrinked.
322
323
324
325
326
327
328
 * SOURCE
 */
/* create a new type struct */
type   *new_type_struct (ident *name);

/* manipulate private fields of struct */
void    add_struct_member   (type *strct, entity *member);
329
int     get_struct_n_members (type *strct);
330
331
entity *get_struct_member   (type *strct, int pos);
void    set_struct_member   (type *strct, int pos, entity *member);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
332
333
/* Finds member in the list of memberss and overwrites it with NULL
 @@@ Doesn't work properly. */
334
void    remove_struct_member (type *strct, entity *member);
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378

/* typecheck */
bool    is_struct_type(type *strct);
/*****/

/****** type/method
 * NAME
 *  Representation of a method type.
 * NOTE
 *  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.
 * ATTRIBUTES
 *  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.)
 *
 *  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.)
 * SOURCE
 */

/* Create a new method type.
   N_param is the number of parameters, n_res the number of results.
   The arrays for the parameter and result types are not initialized by
   the constructor. */
type *new_type_method (ident *name, int n_param, int n_res);

/* manipulate private fields of method. */
int   get_method_n_params  (type *method);
type *get_method_param_type(type *method, int pos);
void  set_method_param_type(type *method, int pos, type* type);

379
int   get_method_n_ress   (type *method);
380
381
382
383
384
385
386
387
388
389
390
391
392
393
type *get_method_res_type(type *method, int pos);
void  set_method_res_type(type *method, int pos, type* type);

/* typecheck */
bool  is_method_type     (type *method);
/*****/

/****** type/union
 * NAME
 *   Representation of a union type.
 * NOTE
 *   The union type represents union types.
 * ATTRIBUTES
 *   n_types        Number of unioned types.
394
 *   members        Entities for unioned types.  Fixed length array.
395
396
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
397
398
 * SOURCE
 */
399
/* create a new type union  */
400
type   *new_type_union (ident *name);
401
402

/* manipulate private fields of struct */
403
404
405
406
int     get_union_n_members      (type *uni);
void    add_union_member (type *uni, entity *member);
entity *get_union_member (type *uni, int pos);
void    set_union_member (type *uni, int pos, entity *member);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
407
408
/* Finds member in the list of members and overwrites it with NULL
   @@@ Doesn't work properly. */
409
void    remove_union_member (type *uni, entity *member);
410

411
412
413
414
415
416
417
/* typecheck */
bool    is_union_type          (type *uni);
/*****/

#if 0
/* We don't need these if the union has entities, which it now
   does. The entities are necessary for the analysis algorithms. */
418
419
420
421
422
423
type  *get_union_unioned_type (type *uni, int pos);
void   set_union_unioned_type (type *uni, int pos, type *type);

ident *get_union_delim_nameid (type *uni, int pos);
const char *get_union_delim_name (type *uni, int pos);
void   set_union_delim_nameid (type *uni, int pos, ident *id);
424
#endif
425
426
427
428
429
430

/****** type/array
 * NAME
 *   Representation of an array type.
 * NOTE
 *   The array type represents rectangular multi dimensional arrays.
431
432
 *   The constants representing the bounds must be allocated to
 *   get_const_code_irg() by setting current_ir_graph accordingly.
433
434
435
436
437
 * ATTRIBUTES
 *   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.
438
439
 *   *element_ent     An entity for the array elements to be used for
 *                    element selection with Sel.
440
441
442
 *                    @@@ Do we need several entities?  One might want
 *                    to select a dimension and not a single element in
 *                    case of multidim arrays.
443
444
 * SOURCE
 */
445
/* create a new type array --
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
446
447
   Sets n_dimension to dimension and all dimension entries to NULL.
   Initializes order to the order of the dimensions.
448
   The entity for array elements is built automatically.
Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
449
   Set dimension sizes after call to constructor with set_* routines. */
450
type *new_type_array         (ident *name, int n_dimensions,
451
			      type *element_type);
452
453
454

/* manipulate private fields of array type */
int   get_array_n_dimensions (type *array);
455
456
457
/* Allocates Const nodes of mode_I for the array dimensions */
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
458
459
460
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);
461
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
462
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
463
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
464
465
ir_node * get_array_lower_bound  (type *array, int dimension);
ir_node * get_array_upper_bound  (type *array, int dimension);
466

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
467
468
469
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

470
471
472
void  set_array_element_type (type *array, type *type);
type *get_array_element_type (type *array);

473
474
475
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
/* typecheck */
bool   is_array_type         (type *array);
/*****/

/****** type/enumeration
 * NAME
 *  Representation of an enumeration type.
 * NOTE
 *  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.
 * ATTRIBUTES
 *   *enum           The target values representing the constants used to
 *                   represent individual enumerations.
 *   *enum_nameid    Idents containing the source program name of the enumeration
 *  		     constants
 *
*****
Christian Schäfer's avatar
Christian Schäfer committed
494
495
*/
/* create a new type enumeration -- set the enumerators independently */
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
type   *new_type_enumeration    (ident *name, int n_enums);

/* manipulate fields of enumeration type. */
int     get_enumeration_n_enums (type *enumeration);

void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
tarval *get_enumeration_enum    (type *enumeration, int pos);

void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
ident  *get_enumeration_nameid  (type *enumeration, int pos);
const char *get_enumeration_name(type *enumeration, int pos);

/* typecheck */
bool    is_enumeration_type     (type *enumeration);
/*****/

/****** type/pointer
 * NAME
 *   Representation of a pointer type.
 * NOTE
 *   Pointer types.
 * ATTRIBUTES
 *   points_to       The type of the entity this pointer points to.
 * SOURCE
 */
/* Create a new type pointer */
type *new_type_pointer           (ident *name, type *points_to);
Christian Schäfer's avatar
Christian Schäfer committed
523
524

/* manipulate fields of type_pointer */
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
void  set_pointer_points_to_type (type *pointer, type *type);
type *get_pointer_points_to_type (type *pointer);

/* typecheck */
bool  is_pointer_type            (type *pointer);
/*****/

/****** type/primitive
 * NAME
 *   Representation of a primitive type.
 * NOTE
 *   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.
 * SOURCE
Christian Schäfer's avatar
Christian Schäfer committed
540
541
*/
/* create a new type primitive */
542
type *new_type_primitive (ident *name, ir_mode *mode);
Christian Schäfer's avatar
Christian Schäfer committed
543

544
545
546
/* typecheck */
bool  is_primitive_type  (type *primitive);
/*****/
Christian Schäfer's avatar
Christian Schäfer committed
547

548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577


/****f* type/is_atomic_type
 *
 * NAME
 *   is_atomic_type - Checks whether a type is atomic.
 * SYNOPSIS
 *   int is_atomic_type(type *tp);
 * INPUTS
 *   tp - any type
 * RESULT
 *   true if type is primitive, pointer or enumeration
 ***
 */
int is_atomic_type(type *tp);

/****f* type/is_compound_type
 *
 * NAME
 *   is_compound_type - Checks whether a type is compound.
 * SYNOPSIS
 *   int is_compound_type(type *tp)
 * INPUTS
 *   tp - any type
 * RESULT
 *   true if the type is class, structure, union or array type.
 ***
 */
int is_compound_type(type *tp);

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