type.h 35.7 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
/** Frees the memory used by the type.
 *
 * Removes the type from the type list. Does not free the entities
 * belonging to the type, except for the array element entity.  Does
 * not free if tp is "none" or "unknown".  Frees entities in value
 * param subtypes of method types!!! Make sure these are not
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
134
135
 * referenced any more.  Further make sure there is no pointer type
 * that refers to this type.                           */
136
137
void        free_type(type *tp);

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

385

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

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

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

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

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

405

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/** 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.
 */
699
type *new_type_array         (ident *name, int n_dimensions,
700
			      type *element_type);
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
 * A legal array type must have at least one dimension set.
709
 */
710
711
type *new_d_type_array         (ident *name, int n_dimensions,
			      type *element_type, dbg_info* db);
712

713
714
715
/* --- manipulate private fields of array type --- */

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

/** Allocates Const nodes of mode_I for the array dimensions */
719
720
void  set_array_bounds_int   (type *array, int dimension, int lower_bound,
                                                          int upper_bound);
721
722
723
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);
724
void  set_array_lower_bound_int (type *array, int dimension, int lower_bound);
725
void  set_array_upper_bound  (type *array, int dimension, ir_node *upper_bound);
726
void  set_array_upper_bound_int (type *array, int dimension, int lower_bound);
727
728
729
730
731
732
733
734
735
736
/** returns true if lower bound != Unknown */
int       has_array_lower_bound     (type *array, int dimension);
ir_node * get_array_lower_bound     (type *array, int dimension);
/** Works only if bound is Const node with tarval that can be converted to long. */
long      get_array_lower_bound_int (type *array, int dimension);
/** returns true if lower bound != Unknown */
int       has_array_upper_bound     (type *array, int dimension);
ir_node * get_array_upper_bound     (type *array, int dimension);
/** Works only if bound is Const node with tarval that can be converted to long. */
long      get_array_upper_bound_int (type *array, int dimension);
737

Götz Lindenmaier's avatar
a    
Götz Lindenmaier committed
738
739
740
void set_array_order (type *array, int dimension, int order);
int  get_array_order (type *array, int dimension);

741
void  set_array_element_type (type *array, type *tp);
742
743
type *get_array_element_type (type *array);

744
745
746
void  set_array_element_entity (type *array, entity *ent);
entity *get_array_element_entity (type *array);

747
/** Returns true if a type is an array type. */
748
int    is_array_type(type *array);
749

Sebastian Felis's avatar
Sebastian Felis committed
750
/**
751
 * @page enumeration_type	Representation of an enumeration type
752
 *
753
754
755
756
757
758
759
760
761
762
 * 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. */
763
type   *new_type_enumeration    (ident *name, int n_enums);
764
765

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

768
769
770
/* --- manipulate fields of enumeration type. --- */

/** Returns the number of enumeration values of this enumeration */
771
772
int     get_enumeration_n_enums (type *enumeration);

773
/** Sets the enumeration value at a given position. */
774
void    set_enumeration_enum    (type *enumeration, int pos, tarval *con);
775
776

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

779
/** Assign an ident to an enumeration value at a given position. */
780
void    set_enumeration_nameid  (type *enumeration, int pos, ident *id);
781
782

/** Returns the assigned ident of an enumeration value at a given position. */
783
ident  *get_enumeration_nameid  (type *enumeration, int pos);
784
785

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

788
/** Returns true if a type is a enumeration type. */
789
int     is_enumeration_type     (type *enumeration);
790

Sebastian Felis's avatar
Sebastian Felis committed
791
/**
792
793
 * @page pointer_type	Representation of a pointer type
 *
794
795
 * The mode of the pointer type must be a mode_reference.
 *
796
797
 * Pointer types:
 * - points_to:      The type of the entity this pointer points to.
798
 */
Christian Schäfer's avatar
Christian Schäfer committed
799

800
/** Creates a new type pointer with mode mode_p. */
801
#define new_type_pointer(N, P) new_type_pointer_mode(N, P, mode_P_mach)
802
803
804
805
806
807

/** 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);
808
809
810
811

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

/** Sets the type to which a pointer points to. */
812
void  set_pointer_points_to_type (type *pointer, type *tp);
813
814

/** Returns the type to which a pointer points to. */
815
816
type *get_pointer_points_to_type (type *pointer);

817
/** Returns true if a type is a pointer type. */
818
int   is_pointer_type            (type *pointer);
819

820
821
822
823
824
/** 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
825
/**
826
827
828
829
830
 * @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
831
*/
832
/** Creates a new primitive type. */
833
type *new_type_primitive (ident *name, ir_mode *mode);
834
835

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

838
/** Returns true if a type is a primitive type. */
839
int  is_primitive_type  (type *primitive);
Christian Schäfer's avatar
Christian Schäfer committed
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
880
881
882
883
884
885
886
/**
 * @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
887
/**
888
889
890
 *  Checks whether a type is atomic.
 *  @param tp - any type
 *  @return true if type is primitive, pointer or enumeration
891
892
893
 */
int is_atomic_type(type *tp);

894
895
/* --- Support for compound types --- */

Sebastian Felis's avatar
Sebastian Felis committed
896
/**
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 * 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.
927
928
929
 */
int is_compound_type(type *tp);

930

931
932
933
934
935
/**
 *  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.
 */
936
long get_type_nr(type *tp);
937

Götz Lindenmaier's avatar
Götz Lindenmaier committed
938
939
940
941
942
943
944
/*******************************************************************/
/** Debug aides                                                   **/
/*******************************************************************/




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