type.h 16.9 KB
Newer Older
1
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
/****h* libfirm/type
 *
 * 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
 *****
 */
Christian Schäfer's avatar
Christian Schäfer committed
30
31
32
# ifndef _TYPE_H_
# define _TYPE_H_

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

#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
44

45
46
47
48
49
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
typedef struct ir_node ir_node;
#endif

50
51
52
53
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
87
88
89
90
91
92
93
94
/****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).
 *  visit        A counter for walks of the type information.
 *
 *  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;

95
96
void*       get_type_link(type *tp);
void        set_type_link(type *tp, void *l);
97
98
99
100
101
102
103
104
105
106
107
108
109
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);

ir_mode*    get_type_mode(type *tp);
void        set_type_mode(type *tp, ir_mode* m);

ident*      get_type_nameid(type *tp);
void        set_type_nameid(type *tp, ident* id);
const char* get_type_name(type *tp);

int         get_type_size(type *tp);
110
111
/* For primitives and pointer types the size is always fixed.
   This call is legal but has no effect. */
112
113
void        set_type_size(type *tp, int size);

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
typedef enum {
  layout_undefined,    /* The layout of this type is not defined.
			  Address computation to access fields is not
			  possible, fields must be accessed by Sel nodes.
			  This is the default value except for pointer and
			  primitive types. */
  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
			  computation. Default for pointer and primitive types.
		       */
} type_state;

type_state  get_type_state(type *tp);
/* For primitives and pointer types the layout is always fixed.
   This call is legal but has no effect. */
void        set_type_state(type *tp, type_state state);

132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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);
/*****/

/****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
152
extern unsigned long type_visited;
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/*****/

/****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
168

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/****** 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.
 * SOURCE
 */
/* create a new class type */
type   *new_type_class (ident *name);

195
196
/** manipulate private fields of class type  **/
/* Adds the entity as member of the class.  */
197
void    add_class_member   (type *clss, entity *member);
198
/* Returns the number of members of this class. */
199
int     get_class_n_member (type *clss);
200
/* Returns the member at position pos, 0 <= pos < n_member */
201
entity *get_class_member   (type *clss, int pos);
202
203
/* Overwrites the member at position pos, 0 <= pos < n_member with
   the passed entity. */
204
void    set_class_member   (type *clss, entity *member, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
205
206
/* Finds member in the list of members and overwrites it with NULL
 @@@ Doesn't work properly. */
207
void    remove_class_member(type *clss, entity *member);
208

209

Götz Lindenmaier's avatar
Götz Lindenmaier committed
210
211
212
/* Adds subtype as subtype to clss.
   Checks whether clss is a supertype of subtype.  If not
   adds also clss as supertype to subtype.  */
213
void    add_class_subtype   (type *clss, type *subtype);
214
/* Returns the number of subtypes */
215
int     get_class_n_subtype (type *clss);
216
/* Gets the subtype at position pos, 0 <= pos < n_subtype. */
217
type   *get_class_subtype   (type *clss, int pos);
218
219
220
/* 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! */
221
void    set_class_subtype   (type *clss, type *subtype, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
222
223
/* Finds subtype in the list of subtypes and overwrites it with NULL
 @@@ Doesn't work properly. */
224
225
void    remove_class_subtype(type *clss, type *subtype);

226

Götz Lindenmaier's avatar
Götz Lindenmaier committed
227
228
229
/* Adds supertype as supertype to class.
   Checks whether clss is a subtype of supertype.  If not
   adds also clss as subtype to supertype.  */
230
void    add_class_supertype   (type *clss, type *supertype);
231
/* Returns the number of supertypes */
232
int     get_class_n_supertype (type *clss);
233
/* Gets the supertype at position pos,  0 <= pos < n_supertype. */
234
type   *get_class_supertype   (type *clss, int pos);
235
236
237
/* 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! */
238
void    set_class_supertype   (type *clss, type *supertype, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
239
240
/* Finds supertype in the list of supertypes and overwrites it with NULL
 @@@ Doesn't work properly. */
241
void    remove_class_supertype(type *clss, type *supertype);
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259

/* 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.
260
261
 *           This is a dynamic list that can be grown with an "add_" function,
 *           but not shrinked.
262
263
264
265
266
267
268
269
270
271
 * 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);
int     get_struct_n_member (type *strct);
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
272
273
/* Finds member in the list of memberss and overwrites it with NULL
 @@@ Doesn't work properly. */
274
void    remove_struct_member (type *strct, entity *member);
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333

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

int   get_method_n_res   (type *method);
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.
334
 *   members        Entities for unioned types.  Fixed length array.
335
336
 *                  This is a dynamic list that can be grown with an "add_" function,
 *                  but not shrinked.
337
338
 * SOURCE
 */
339
/* create a new type union  */
340
type   *new_type_union (ident *name);
341
342

/* manipulate private fields of struct */
343
344
345
346
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
347
348
/* Finds member in the list of members and overwrites it with NULL
   @@@ Doesn't work properly. */
349
void    remove_union_member (type *uni, entity *member);
350

351
352
353
354
355
356
357
/* 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. */
358
359
360
361
362
363
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);
364
#endif
365
366
367
368
369
370
371
372
373
374
375

/****** type/array
 * NAME
 *   Representation of an array type.
 * NOTE
 *   The array type represents rectangular multi dimensional arrays.
 * 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.
376
377
 *   *element_ent     An entity for the array elements to be used for
 *                    element selection with Sel.
378
379
380
 *                    @@@ Do we need several entities?  One might want
 *                    to select a dimension and not a single element in
 *                    case of multidim arrays.
381
382
 * SOURCE
 */
383
384
385
386
387
/* create a new type array --
   Set dimension sizes after call to constructor with set_* routines.
   Entity for array elements is built automatically. */
type *new_type_array         (ident *name, int n_dimensions,
			      type *element_type);
388
389
390

/* manipulate private fields of array type */
int   get_array_n_dimensions (type *array);
391
392
393
394
395
396
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);
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
ir_node * get_array_lower_bound  (type *array, int dimension);
ir_node * get_array_upper_bound  (type *array, int dimension);
397
398
399
400

void  set_array_element_type (type *array, type *type);
type *get_array_element_type (type *array);

401
402
403
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
/* 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
422
423
*/
/* create a new type enumeration -- set the enumerators independently */
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
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
451
452

/* manipulate fields of type_pointer */
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
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
468
469
*/
/* create a new type primitive */
470
type *new_type_primitive (ident *name, ir_mode *mode);
Christian Schäfer's avatar
Christian Schäfer committed
471

472
473
474
/* typecheck */
bool  is_primitive_type  (type *primitive);
/*****/
Christian Schäfer's avatar
Christian Schäfer committed
475
476

# endif /* _TYPE_H_ */