irtypes.h 28.2 KB
Newer Older
1
/*
2
 * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
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
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

/**
 * @file
 * @brief   Definition of the Firm IR base types, concentrated here
 * @author  Michael Beck
 */
#ifndef FIRM_IR_IRDEFS_H
#define FIRM_IR_IRDEFS_H

28
29
#include <stdbool.h>

30
31
32
33
34
35
36
37
38
#include "firm_types.h"
#include "irdom_t.h"
#include "irmode.h"
#include "irnode.h"
#include "irgraph.h"
#include "iredgekinds.h"
#include "irtypeinfo.h"
#include "irmemory.h"
#include "callgraph.h"
39
#include "irprog.h"
40
#include "bitset.h"
41
42
43
44

#include "pset.h"
#include "set.h"
#include "list.h"
45
#include "obst.h"
46
#include "vrp.h"
47

48
49
50
struct ir_nodemap {
	void **data;  /**< maps node indices to void* */
};
51

52
53
/** The type of an ir_op. */
struct ir_op {
Matthias Braun's avatar
Matthias Braun committed
54
55
56
57
58
59
60
61
	unsigned code;            /**< The unique opcode of the op. */
	ident *name;              /**< The name of the op. */
	size_t attr_size;         /**< Space needed in memory for private attributes
	                               */
	op_pin_state pin_state;   /**< How to deal with the node in CSE, PRE. */
	op_arity opar;            /**< The arity of operator. */
	int op_index;             /**< The index of the first data operand, 0 for
	                               most cases, 1 for Div etc. */
62
	int memory_index;         /**< index of memory input for memory nodes */
Matthias Braun's avatar
Matthias Braun committed
63
64
65
66
67
68
69
70
71
72
	int pn_x_regular;         /**< for fragile ops the position of the
	                               X_regular output */
	int pn_x_except;          /**< for fragile ops the position of the
	                               X_except output */
	unsigned flags;           /**< Flags describing the behavior of the ir_op,
	                               a bitmasks of irop_flags. */
	unsigned tag;             /**< Some custom TAG value the op's creator set */
	void *attr;               /**< custom pointer where op's creator can attach
	                               attribute stuff to. */
	ir_op_ops ops;            /**< The operations of the this op. */
73
74
};

75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/** Helper values for ir_mode_sort. */
enum ir_mode_sort_helper {
	irmsh_is_num   = 0x10, /**< mode represents a number */
	irmsh_is_data  = 0x20, /**< mode represents data (can be carried in registers) */
	irmsh_is_datab = 0x40, /**< mode represents data or is internal boolean */
	irmsh_is_dataM = 0x80, /**< mode represents data or is memory */
};

/**
 * These values represent the different mode classes of value representations.
 * Beware: do not change the order of these values without checking
 * the mode_is
 */
typedef enum ir_mode_sort {
	irms_control_flow     = 0, /**< Marks all control flow modes. */
	irms_block            = 1,
	irms_tuple            = 2,
	irms_any              = 3,
	irms_bad              = 4,
	irms_memory           = 5 | irmsh_is_dataM, /**< Marks the memory mode.  Not extensible. (irm_M) */

	/** Internal boolean representation.
	     Storing to memory impossible, convert first. (irm_b) */
	irms_internal_boolean = 6 | irmsh_is_datab,

	/** A mode to represent entities.
	    Restricted int computations can be performed */
	irms_reference        = 7 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM,
	/** A mode to represent int numbers.
	    Integer computations can be performed. */
	irms_int_number       = 8 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
	/** A mode to represent float numbers.
	    Floating point computations can be performed. */
	irms_float_number     = 9 | irmsh_is_data | irmsh_is_datab | irmsh_is_dataM | irmsh_is_num,
} ir_mode_sort;

/**
 * A descriptor for an IEEE754 float value.
 */
typedef struct float_descriptor_t {
	unsigned char exponent_size;    /**< size of exponent in bits */
	unsigned char mantissa_size;    /**< size of mantissa in bits */
	bool          explicit_one;     /**< set if the leading one is explicit */
} float_descriptor_t;

120
121
122
123
124
125
126
127
128
/**
 * Contains relevant information about a mode.
 *
 * Necessary information about a mode is stored in this struct
 * which is used by the tarval module to perform calculations
 * and comparisons of values of a such described mode.
 *
 * ATTRIBUTES:
 *  -  ident *name:             Name of this mode. Two modes are different if the name is different.
129
 *  -  ir_mode_sort sort:       sort of mode specifying possible usage categories
130
131
132
133
134
135
136
137
138
139
140
141
142
 *  -  int    size:             size of the mode in Bits.
 *  -  unsigned sign:1:         signedness of this mode
 *  -  ... more to come
 *  -  modulo_shift             specifies for modes of kind irms_int_number
 *                              whether shift applies modulo to value of bits to shift
 *
 * SEE ALSO:
 *    The tech report 1999-44 describing FIRM and predefined modes
 *    tarval.h
 */
struct ir_mode {
	firm_kind         kind;       /**< distinguishes this node from others */
	ident             *name;      /**< Name ident of this mode */
143
	ir_type           *type;      /**< corresponding primitive type */
144

145
	/* ---------------------------------------------------------------------- */
146
	/* On changing this struct you have to evaluate the mode_are_equal function!*/
147
148
149
150
151
152
153
154
	ir_mode_sort       sort;          /**< coarse classification of this mode:
                                           int, float, reference ...
                                           (see irmode.h) */
	ir_mode_arithmetic arithmetic;    /**< different arithmetic operations possible with a mode */
	unsigned           size;          /**< size of the mode in Bits. */
	unsigned           sign:1;        /**< signedness of this mode */
	unsigned int       modulo_shift;  /**< number of bits a values of this mode will be shifted */
	float_descriptor_t float_desc;
155

156
	/* ---------------------------------------------------------------------- */
Matthias Braun's avatar
Matthias Braun committed
157
158
159
160
161
162
	ir_tarval         *min;         /**< the minimum value that can be expressed */
	ir_tarval         *max;         /**< the maximum value that can be expressed */
	ir_tarval         *null;        /**< the value 0 */
	ir_tarval         *one;         /**< the value 1 */
	ir_tarval         *minus_one;   /**< the value -1 */
	ir_tarval         *all_one;     /**< the value ~0 */
163
164
165
166
167
168
	ir_mode           *eq_signed;   /**< For pointer modes, the equivalent signed integer one. */
	ir_mode           *eq_unsigned; /**< For pointer modes, the equivalent unsigned integer one. */
	void              *link;        /**< To store some intermediate information */
	const void        *tv_priv;     /**< tarval module will save private data here */
};

Matthias Braun's avatar
Matthias Braun committed
169
170
171
172
173
174
175
176
177
178
179
180
/* note: we use "long" here because that is the type used for Proj-Numbers */
typedef struct ir_switch_table_entry {
	ir_tarval *min;
	ir_tarval *max;
	long       pn;
} ir_switch_table_entry;

struct ir_switch_table {
	size_t                n_entries;
	ir_switch_table_entry entries[];
};

181
182
/* ir node attributes */

183
/** first attribute of Bad, Block, Anchor nodes */
184
typedef struct irg_attr {
185
186
	ir_graph *irg;              /**< The graph this block like node belongs to. */
} irg_attr;
187

188
typedef struct bad_attr {
189
190
191
	irg_attr    irg;
} bad_attr;

192
193
194
195
typedef struct anchor_attr {
	irg_attr  irg;
} anchor_attr;

196
/** Block attributes */
197
typedef struct block_attr {
198
	/* General attributes */
199
	irg_attr     irg;           /**< The graph this block belongs to. */
200
	ir_visited_t block_visited; /**< For the walker that walks over all blocks. */
201
202
	/* Attributes private to construction: */
	unsigned is_matured:1;      /**< If set, all in-nodes of the block are fixed. */
203
	unsigned dynamic_ins:1;     /**< if set in-array is an ARR_F on the heap. */
204
	unsigned marked:1;          /**< Can be set/unset to temporary mark a block. */
205
206
	ir_node **graph_arr;        /**< An array to store all parameters. */
	/* Attributes holding analyses information */
Matthias Braun's avatar
Matthias Braun committed
207
	ir_dom_info dom;            /**< Datastructure that holds information about dominators. */
208
	ir_dom_info pdom;           /**< Datastructure that holds information about post-dominators. */
209
	bitset_t *backedge;         /**< Bitfield n set to true if pred n is backedge.*/
210
	ir_entity *entity;          /**< entitiy representing this block */
211
	ir_node  *phis;             /**< The list of Phi nodes in this block. */
212
	double    execfreq;         /**< block execution frequency */
213
214
215
} block_attr;

/** Cond attributes. */
216
typedef struct cond_attr {
217
	cond_jmp_predicate jmp_pred; /**< only for binary Conds: The jump predication. */
218
219
220
} cond_attr;

/** Const attributes. */
Matthias Braun's avatar
Matthias Braun committed
221
222
typedef struct const_attr {
	ir_tarval *tarval;  /**< the target value */
223
224
225
} const_attr;

/** SymConst attributes. */
226
typedef struct symconst_attr {
227
	symconst_symbol sym;  // old tori
228
	symconst_kind   kind;
229
230
231
} symconst_attr;

/** Sel attributes. */
232
typedef struct sel_attr {
233
	ir_entity *entity;    /**< entity to select */
234
235
236
} sel_attr;

/** Exception attributes. */
237
typedef struct except_attr {
238
239
240
241
242
243
	unsigned  pin_state : 2;         /**< the pin state for operations with
	                                      variable pinned state. Contains a
	                                      op_pin_state */
	unsigned  throws_exception : 1; /**< if true a fragile op throws and
	                                     must produce X_except and X_regular
	                                     values */
244
245
246
} except_attr;

/** Call attributes. */
247
typedef struct call_attr {
248
249
250
	except_attr exc;               /**< the exception attribute. MUST be the first one. */
	ir_type     *type;             /**< type of called procedure */
	ir_entity   **callee_arr;      /**< result of callee analysis */
251
252
} call_attr;

253
/** Builtin attributes. */
254
typedef struct builtin_attr {
255
256
	except_attr     exc;           /**< the exception attribute. MUST be the first one. */
	ir_builtin_kind kind;          /**< kind of the called builtin procedure */
257
	ir_type         *type;         /**< type of called builtin procedure */
258
259
} builtin_attr;

260
/** Alloc attributes. */
261
typedef struct alloc_attr {
262
	except_attr    exc;           /**< the exception attribute. MUST be the first one. */
263
264
    ir_where_alloc where;         /**< stack, heap or other managed part of memory */
	ir_type        *type;         /**< Type of the allocated object.  */
265
266
267
} alloc_attr;

/** Free attributes. */
268
typedef struct free_attr {
269
	ir_type *type;                /**< Type of the allocated object.  */
270
	ir_where_alloc where;         /**< stack, heap or other managed part of memory */
271
272
273
} free_attr;

/** InstOf attributes. */
274
typedef struct io_attr {
275
276
277
278
279
	except_attr    exc;           /**< the exception attribute. MUST be the first one. */
	ir_type *type;                /**< the type of which the object pointer must be */
} io_attr;

/** Cast attributes. */
280
typedef struct cast_attr {
281
	ir_type *type;                /**< Type of the casted node. */
282
283
284
} cast_attr;

/** Load attributes. */
285
typedef struct load_attr {
286
	except_attr   exc;            /**< The exception attribute. MUST be the first one. */
287
288
    ir_volatility volatility:1;   /**< The volatility of this Load operation. */
    ir_align      unaligned:1;    /**< The align attribute of this Load operation. */
289
	ir_mode       *mode;          /**< The mode of this Load operation. */
290
291
292
} load_attr;

/** Store attributes. */
293
typedef struct store_attr {
294
	except_attr   exc;            /**< the exception attribute. MUST be the first one. */
295
296
	ir_volatility volatility:1;   /**< The volatility of this Store operation. */
	ir_align      unaligned:1;    /**< The align attribute of this Store operation. */
297
298
} store_attr;

299
typedef struct phi_attr {
300
301
	ir_node        *next;         /**< Points to the next Phi in the Phi list of a block. */
	union {
302
		bitset_t      *backedge;     /**< Raw Bitfield: bit n is set to true if pred n is backedge. */
303
304
305
306
307
308
309
310
311
		int            pos;           /**< For Phi0. Used to remember the value defined by
		                               this Phi node.  Needed when the Phi is completed
		                               to call get_r_internal_value() to find the
		                               predecessors. If this attribute is set, the Phi
		                               node takes the role of the obsolete Phi0 node,
		                               therefore the name. */
	} u;
} phi_attr;

312
313
314
315
/**< Cmp attribute. */
typedef struct cmp_attr {
	ir_relation relation;         /**< comparison condition. */
} cmp_attr;
316
317

/**< Confirm attribute. */
318
typedef struct confirm_attr {
319
	ir_relation relation;         /**< relation between value and bound */
320
321
322
} confirm_attr;

/** CopyB attribute. */
323
typedef struct copyb_attr {
324
	except_attr    exc;           /**< The exception attribute. MUST be the first one. */
325
	ir_type        *type;         /**< Type of the copied entity. */
326
327
328
} copyb_attr;

/** Bound attribute. */
329
typedef struct bound_attr {
330
331
332
	except_attr exc;              /**< The exception attribute. MUST be the first one. */
} bound_attr;

333
334
/** Div attribute. */
typedef struct div_attr {
335
	except_attr    exc;           /**< The exception attribute. MUST be the first one. */
336
	ir_mode        *resmode;      /**< Result mode for the division. */
337
	char           no_remainder;  /**< Set, if known that a division can be done without a remainder. */
338
339
340
341
342
343
344
} div_attr;

/** Mod attribute. */
typedef struct mod_attr {
	except_attr    exc;           /**< The exception attribute. MUST be the first one. */
	ir_mode        *resmode;      /**< Result mode for the division. */
} mod_attr;
345
346

/** Inline Assembler support attribute. */
347
typedef struct asm_attr {
348
	/* BEWARE: pin state MUST be the first attribute */
349
350
351
352
353
	op_pin_state      pin_state;            /**< the pin state for operations that might generate a exception */
	ident             *text;                /**< The inline assembler text. */
	ir_asm_constraint *input_constraints;   /**< Input constraints. */
	ir_asm_constraint *output_constraints;  /**< Output constraints. */
	ident             **clobbers;           /**< List of clobbered registers. */
354
355
} asm_attr;

356
357
358
359
typedef struct proj_attr {
	long  proj;           /**< position of tuple sub-value which is projected */
} proj_attr;

Matthias Braun's avatar
Matthias Braun committed
360
361
362
363
364
typedef struct switch_attr {
	unsigned         n_outs;
	ir_switch_table *table;
} switch_attr;

365
366
/** Some IR-nodes just have one attribute, these are stored here,
   some have more. Their name is 'irnodename_attr' */
367
typedef union ir_attr {
368
	irg_attr       irg;           /**< For Blocks and Bad: its belonging irg */
369
	bad_attr       bad;           /**< for Bads: irg reference */
370
	anchor_attr    anchor;        /**< for Anchor: irg reference */
371
	block_attr     block;         /**< For Block: Fields needed to construct it */
372
	cmp_attr       cmp;           /**< For Cmp. */
373
374
375
376
	cond_attr      cond;          /**< For Cond. */
	const_attr     con;           /**< For Const: contains the value of the constant and a type */
	symconst_attr  symc;          /**< For SymConst. */
	sel_attr       sel;           /**< For Sel. */
377
378
	call_attr      call;          /**< For Call. */
	builtin_attr   builtin;       /**< For Builtin. */
379
380
381
382
383
384
	alloc_attr     alloc;         /**< For Alloc. */
	free_attr      free;          /**< For Free. */
	io_attr        instof;        /**< For InstOf */
	cast_attr      cast;          /**< For Cast. */
	load_attr      load;          /**< For Load. */
	store_attr     store;         /**< For Store. */
385
	phi_attr       phi;           /**< For Phi. */
386
	proj_attr      proj;          /**< For Proj. */
387
388
389
390
	confirm_attr   confirm;       /**< For Confirm: compare operation and region. */
	except_attr    except;        /**< For Phi node construction in case of exceptions */
	copyb_attr     copyb;         /**< For CopyB operation */
	bound_attr     bound;         /**< For Bound operation */
391
392
	div_attr       div;           /**< For Div operation */
	mod_attr       mod;           /**< For Mod operation */
393
	asm_attr       assem;         /**< For ASM operation. */
Matthias Braun's avatar
Matthias Braun committed
394
	switch_attr    switcha;       /**< For Switch operation. */
395
} ir_attr;
396
397
398
399

/**
 * Edge info to put into an irn.
 */
400
typedef struct irn_edge_kind_info_t {
401
	struct list_head outs_head;  /**< The list of all outs. */
Michael Beck's avatar
Michael Beck committed
402
403
	unsigned edges_built : 1;    /**< Set edges where built for this node. */
	unsigned out_count : 31;     /**< Number of outs in the list. */
404
405
406
407
} irn_edge_info_t;

typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];

408
409
410
/**
 * A Def-Use edge.
 */
411
typedef struct ir_def_use_edge {
412
413
414
415
	ir_node *use;            /** The use node of that edge. */
	int     pos;             /** The position of this edge in use's input array. */
} ir_def_use_edge;

416
417
418
419
420
421
422
/**
 * The common structure of an irnode.
 * If the node has some attributes, they are stored in the attr field.
 */
struct ir_node {
	/* ------- Basics of the representation  ------- */
	firm_kind kind;          /**< Distinguishes this node from others. */
Michael Beck's avatar
Michael Beck committed
423
	unsigned node_idx;       /**< The node index of this node in its graph. */
424
425
426
	ir_op *op;               /**< The Opcode of this node. */
	ir_mode *mode;           /**< The Mode of this node. */
	struct ir_node **in;     /**< The array of predecessors / operands. */
427
	ir_visited_t visited;    /**< The visited counter for walks of the graph. */
428
	void *link;              /**< To attach additional information to the node, e.g.
Michael Beck's avatar
Michael Beck committed
429
	                              used during optimization to link to nodes that
430
	                              shall replace a node. */
431
	long node_nr;            /**< A globally unique node number for each node. */
432
	/* ------- Fields for optimizations / analysis information ------- */
433
	ir_def_use_edge *out;    /**< array of def-use edges. */
434
435
436
	struct dbg_info *dbi;    /**< A pointer to information for debug support. */
	/* ------- For debugging ------- */
#ifdef DEBUG_libfirm
437
438
	unsigned out_valid : 1;
	unsigned flags     : 31;
439
440
441
442
#endif
	/* ------- For analyses -------- */
	ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
	struct ir_node **deps;   /**< Additional dependencies induced by state. */
443
	void            *backend_info;
444
	irn_edges_info_t edge_info;  /**< Everlasting out edges. */
445

446
	/* ------- Opcode depending fields -------- */
447
	ir_attr attr;            /**< The set of attributes of this node. Depends on opcode.
448
449
450
	                              Must be last field of struct ir_node. */
};

451
452
#include "iredgeset.h"

453
454
455
/**
 * Edge info to put into an irg.
 */
456
typedef struct irg_edge_info_t {
457
458
459
460
461
	ir_edgeset_t     edges;          /**< A set containing all edges of the current graph. */
	struct list_head free_edges;     /**< list of all free edges. */
	struct obstack   edges_obst;     /**< Obstack, where edges are allocated on. */
	unsigned         allocated : 1;  /**< Set if edges are allocated on the obstack. */
	unsigned         activated : 1;  /**< Set if edges are activated for the graph. */
462
463
464
465
466
} irg_edge_info_t;

typedef irg_edge_info_t irg_edges_info_t[EDGE_KIND_LAST];

/**
467
 * Index constants for nodes that can be accessed through the graph anchor node.
468
 */
469
470
471
472
typedef enum irg_anchors {
	anchor_first,
	anchor_end_block = anchor_first, /**< block the end node will belong to,
	                                      same as Anchors block */
473
	anchor_start_block,      /**< block the start node will belong to */
474
	anchor_end,              /**< end node of this ir_graph */
475
	anchor_start,            /**< start node of this ir_graph */
476
477
	anchor_initial_exec,     /**< methods initial control flow */
	anchor_frame,            /**< methods frame */
478
479
480
	anchor_initial_mem,      /**< initial memory of this graph */
	anchor_args,             /**< methods arguments */
	anchor_no_mem,           /**< NoMem node of this ir_graph, the one and only in this graph */
481
482
483
	anchor_last = anchor_no_mem
} irg_anchors;
ENUM_COUNTABLE(irg_anchors)
484
485
486
487
488

/** A callgraph entry for callees. */
typedef struct cg_callee_entry {
	ir_graph  *irg;        /**< The called irg. */
	ir_node  **call_list;  /**< The list of all calls to the irg. */
489
	size_t     max_depth;  /**< Maximum depth of all Call nodes to irg. */
490
491
} cg_callee_entry;

492
493
494
495
496
typedef struct ir_vrp_info {
	struct ir_nodemap infos;
	struct obstack    obst;
} ir_vrp_info;

497
498
499
500
501
502
/**
 * An ir_graph holds all information for a procedure.
 */
struct ir_graph {
	firm_kind         kind;        /**< Always set to k_ir_graph. */
	/* --  Basics of the representation -- */
yb9976's avatar
yb9976 committed
503
	unsigned last_node_idx;        /**< The last IR node index for this graph. */
504
505
506
507
508
	ir_entity  *ent;               /**< The entity of this procedure, i.e.,
	                                    the type of the procedure and the
	                                    class it belongs to. */
	ir_type *frame_type;           /**< A class type representing the stack frame.
	                                    Can include "inner" methods. */
509
	ir_node *anchor;               /**< Pointer to the anchor node of this graph. */
510
511
512
513
	struct obstack *obst;          /**< The obstack where all of the ir_nodes live. */
	ir_node *current_block;        /**< Current block for newly gen_*()-erated ir_nodes. */

	/* -- Fields for graph properties -- */
514
515
	irg_inline_property        inline_property;       /**< How to handle inlineing. */
	mtp_additional_properties  additional_properties; /**< Additional graph properties. */
516
517

	/* -- Fields indicating different states of irgraph -- */
518
519
520
521
522
523
524
	ir_graph_properties_t  properties;
	ir_graph_constraints_t constraints;
	irg_phase_state        phase_state;       /**< Compiler phase. */
	op_pin_state           irg_pinned_state;  /**< Flag for status of nodes. */
	ir_typeinfo_state      typeinfo_state;    /**< Validity of type information. */
	irg_callee_info_state  callee_info_state; /**< Validity of callee information. */
	ir_class_cast_state    class_cast_state;  /**< Kind of cast operations in code. */
525
526
527
528
529
530
531
532
533
534
535
	unsigned mem_disambig_opt;               /**< Options for the memory disambiguator. */
	unsigned fp_model;                       /**< floating point model of the graph. */

	/* -- Fields for construction -- */
	int n_loc;                         /**< Number of local variables in this
	                                        procedure including procedure parameters. */
	void **loc_descriptions;           /**< Storage for local variable descriptions. */

	/* -- Fields for optimizations / analysis information -- */
	pset *value_table;                 /**< Hash table for global value numbering (cse)
	                                        for optimizing use in iropt.c */
536
	ir_def_use_edge *outs;             /**< Space for the Def-Use arrays. */
537
	ir_vrp_info      vrp;              /**< vrp info */
538
539

	ir_loop *loop;                     /**< The outermost loop for this graph. */
Matthias Braun's avatar
Matthias Braun committed
540
	ir_dom_front_info_t domfront;      /**< dominance frontier analysis data */
541
542
543
544
	void *link;                        /**< A void* field to link any information to
	                                        the node. */

	ir_graph **callers;                /**< For callgraph analysis: list of caller graphs. */
Michael Beck's avatar
Michael Beck committed
545
	unsigned *caller_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
546
	cg_callee_entry **callees;         /**< For callgraph analysis: list of callee calls */
Michael Beck's avatar
Michael Beck committed
547
	unsigned *callee_isbe;             /**< For callgraph analysis: raw bitset if backedge info calculated. */
548
	ir_loop   *l;                            /**< For callgraph analysis. */
549
550
	size_t     callgraph_loop_depth;         /**< For callgraph analysis */
	size_t     callgraph_recursion_depth;    /**< For callgraph analysis */
551
552
553
554
	double     method_execution_frequency;   /**< For callgraph analysis */


	/* -- Fields for Walking the graph -- */
555
	ir_visited_t visited;             /**< this flag is an identifier for
556
557
558
	                  ir walk. it will be incremented
	                  every time someone walks through
	                  the graph */
559
	ir_visited_t block_visited;        /**< same as visited, for a complete block */
560

561
	ir_visited_t self_visited;         /**< visited flag of the irg */
562

563
564
565
566
567
	unsigned estimated_node_count;     /**< estimated number of nodes in this graph,
	                                        updated after every walk */
	irg_edges_info_t edge_info;        /**< edge info for automatic outs */
	ir_node **idx_irn_map;             /**< Array mapping node indexes to nodes. */

568
	size_t index;                      /**< a unique number for each graph */
569
	/** extra info which should survive accross multiple passes */
570
	void     *be_data;                 /**< backend can put in private data here */
571
572

	unsigned  dump_nr;                 /**< number of graph dumps */
573
#ifdef DEBUG_libfirm
Matthias Braun's avatar
Matthias Braun committed
574
575
576
	int   n_outs;                      /**< Size wasted for outs */
	long graph_nr;                     /**< a unique graph number for each
	                                        graph to make output readable. */
577
578
579
#endif

#ifndef NDEBUG
580
	ir_resources_t reserved_resources; /**< Bitset for tracking used local resources. */
581
582
583
#endif
};

584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
/**
 * Data structure that holds central information about a program
 * or a module.
 * One irp is created by libFirm on construction, so irp should never be NULL.
 *
 * - main_irg:  The ir graph that is the entry point to the program.
 *              (Anything not reachable from here may be optimized away
 *              if this irp represents a whole program.
 * - irg:       List of all ir graphs in the program or module.
 * - type:      A list containing all types known to the translated program.
 *              Some types can have several entries in this list (as a result of
 *              using exchange_types()).
 * - glob_type: The unique global type that is owner of all global entities
 *              of this module.
 */
599
600
601
602
603
604
605
606
607
608
struct ir_prog {
	firm_kind kind;                 /**< must be k_ir_prog */
	ident     *name;                /**< A file name or the like. */
	ir_graph  *main_irg;            /**< The entry point to the compiled program
	                                     or NULL if no point exists. */
	ir_graph **graphs;              /**< A list of all graphs in the ir. */
	ir_graph  *const_code_irg;      /**< This ir graph gives the proper environment
	                                     to allocate nodes the represent values
	                                     of constant entities. It is not meant as
	                                     a procedure.  */
609
	ir_entity *unknown_entity;      /**< unique 'unknown'-entity */
610
	ir_type   *segment_types[IR_SEGMENT_LAST+1];
611
	ir_type  **types;               /**< A list of all types in the ir. */
612
613
614
	ir_type   *none_type;           /**< unique 'none'-type */
	ir_type   *code_type;           /**< unique 'code'-type */
	ir_type   *unknown_type;        /**< unique 'unknown'-type */
615
	ir_type   *byte_type;           /**< type for a 'byte' */
616
	ident    **global_asms;         /**< An array of global ASM insertions. */
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632

	/* -- states of and access to generated information -- */
	irg_phase_state phase_state;    /**< The state of construction. */

	ir_node **ip_outedges;          /**< A huge Array that contains all out edges
	                                     in interprocedural view. */

	irg_callee_info_state callee_info_state; /**< Validity of callee information.
	                                              Contains the lowest value or all irgs.  */
	ir_typeinfo_state typeinfo_state;    /**< Validity of type information. */
	inh_transitive_closure_state inh_trans_closure_state;  /**< State of transitive closure
	                                                            of inheritance relations. */

	irp_callgraph_state callgraph_state; /**< The state of the callgraph. */
	ir_loop *outermost_cg_loop;          /**< For callgraph analysis: entry point
	                                              to looptree over callgraph. */
633
634
	size_t max_callgraph_loop_depth;        /**< needed in callgraph. */
	size_t max_callgraph_recursion_depth;   /**< needed in callgraph. */
635
636
637
	double max_method_execution_frequency;  /**< needed in callgraph. */
	loop_nesting_depth_state lnd_state;  /**< The state of loop nesting depth information. */
	ir_class_cast_state class_cast_state;    /**< The state of cast operations in code. */
638
	ir_entity_usage_computed_state globals_entity_usage_state;
639

640
	ir_label_t last_label_nr;            /**< The highest label number for generating unique labels. */
641
	size_t max_irg_idx;                  /**< highest unused irg index */
642
	long max_node_nr;                    /**< to generate unique numbers for nodes. */
643
	unsigned dump_nr;                    /**< number of program info dumps */
644
#ifndef NDEBUG
yb9976's avatar
yb9976 committed
645
	irp_resources_t reserved_resources;  /**< Bitset for tracking used global resources. */
646
#endif
647
648
649
};

#endif