irgmod: Pass the new inputs to turn_into_tuple() instead of initialising them with...
[libfirm] / include / libfirm / irnode.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Representation of an intermediate operation.
23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
24  */
25 #ifndef FIRM_IR_IRNODE_H
26 #define FIRM_IR_IRNODE_H
27
28 #include <stddef.h>
29
30 #include "firm_common.h"
31 #include "typerep.h"
32 #include "irop.h"
33 #include "irmode.h"
34 #include "begin.h"
35 #include "nodeops.h"
36
37 /**
38  * @ingroup ir_graph
39  * @defgroup ir_node Nodes
40  *
41  * ir_node - a datatype representing a Firm node
42  *
43  *  The common fields are:
44  *
45  *  - arity     - The number of predecessors in the Firm graph.
46  *  - in        - A list with the predecessors in the Firm graph.  There are
47  *                routines to access individual elements and to obtain the
48  *                array.  The method returning the array should not be used.
49  *  - mode      - The mode of the node.  There are routines to get the mode
50  *                but also to access the mode's fields directly.
51  *  - opcode    - The opcode of the node. There are routines to get the opcode
52  *                but also to access the opcode's fields directly.
53  *  - node_nr   - A unique number for the node.  Available only if debugging
54  *                is turned on.
55  * @{
56  */
57
58 /**
59  * Checks whether a pointer points to a ir node. This is guessed by looking
60  * at the few bytes of the thing. Most things used in firm have a firm_kind
61  * attribute there. This function might falsely return true though for things
62  * without a firm_kind at the beginning.
63  *
64  * @param thing   an arbitrary pointer
65  * @return        non-zero if the thing is a ir mode, else zero
66  */
67 FIRM_API int is_ir_node(const void *thing);
68
69 /**
70  * Returns the number of predecessors without the block predecessor.
71  *
72  * @param node   the IR-node
73  */
74 FIRM_API int get_irn_arity(const ir_node *node);
75
76 /**
77  * Returns the n-th predecessor of a node.
78  * This function removes Id predecessors.
79  */
80 FIRM_API ir_node *get_irn_n(const ir_node *node, int n);
81
82 /**
83  * Replaces the old in array by a new one that will contain the ins given in
84  * the parameters. Conserves the block predecessor. It copies the array passed.
85  * This function is necessary to adjust in arrays of blocks, calls and phis.
86  * "in" must contain all predecessors except the block that are required for
87  * the nodes opcode. */
88 FIRM_API void set_irn_in(ir_node *node, int arity, ir_node *const in[]);
89
90 /**
91  * Add an artificial dependency to the node.
92  *
93  * @param node The node.
94  * @param dep  The dependency target.
95  */
96 FIRM_API void add_irn_dep(ir_node *node, ir_node *dep);
97
98 /**
99  * Copy all dependencies from a node to another.
100  * This is only allowed in phase_backend!
101  *
102  * @param tgt The node which should be enriched.
103  * @param src The node whose dependencies shall be copied.
104  */
105 FIRM_API void add_irn_deps(ir_node *tgt, ir_node *src);
106
107 /**
108  * Returns the length of the dependency array.
109  * @param node The node.
110  * @return The length of the dependency array or 0 if it has not yet been allocated.
111  */
112 FIRM_API int get_irn_deps(const ir_node *node);
113
114 /**
115  * Returns an entry of the dependency array.
116  * @param node The node.
117  * @param pos  The position.
118  * @return The node at that position.
119  */
120 FIRM_API ir_node *get_irn_dep(const ir_node *node, int pos);
121
122 /**
123  * Sets an entry of the dependency array.
124  * @param node The node.
125  * @param pos  The position.
126  * @param dep  The dependency target.
127  */
128 FIRM_API void set_irn_dep(ir_node *node, int pos, ir_node *dep);
129
130 /**
131  * Deletes the entry of the dependency array, that points to dep. Does nothing
132  * if no dependency exists.
133  *
134  * @param node the node to delete the dependency at
135  * @param dep the target of the dependency to delete
136  */
137 FIRM_API void delete_irn_dep(ir_node *node, ir_node *dep);
138
139 /** Replaces the n-th predecessor of a node with a new one. */
140 FIRM_API void set_irn_n(ir_node *node, int n, ir_node *in);
141 /**
142  * Appends a new predecessor to a node. This only works for nodes with
143  * variable arity!
144  * @returns   the number of the new input
145  */
146 FIRM_API int add_irn_n(ir_node *node, ir_node *in);
147 /** Sets the mode struct of node.  */
148 FIRM_API void set_irn_mode(ir_node *node, ir_mode *mode);
149 /** Returns the mode struct of a node.  */
150 FIRM_API ir_mode *get_irn_mode(const ir_node *node);
151 /** Returns the opcode struct of the node. */
152 FIRM_API ir_op *get_irn_op(const ir_node *node);
153 /** Sets the opcode struct of the node. */
154 FIRM_API void set_irn_op(ir_node *node, ir_op *op);
155 /** Returns the opcode-enum of the node. */
156 FIRM_API unsigned get_irn_opcode(const ir_node *node);
157 /** Returns the string representation of the opcode. */
158 FIRM_API const char *get_irn_opname(const ir_node *node);
159 /** Returns the ident for a string representation of the opcode. */
160 FIRM_API ident *get_irn_opident(const ir_node *node);
161 /** Returns the visited counter of a node. */
162 FIRM_API ir_visited_t get_irn_visited(const ir_node *node);
163 /** Sets the visited counter of a node. */
164 FIRM_API void set_irn_visited(ir_node *node, ir_visited_t visited);
165 /** Sets visited to get_irg_visited(get_irn_irg(node)). */
166 FIRM_API void mark_irn_visited(ir_node *node);
167 /** Returns 1 if visited >= get_irg_visited(get_irn_irg(node)). */
168 FIRM_API int irn_visited(const ir_node *node);
169 /** Returns 1 if visited >= get_irg_visited(get_irn_irg(node)). Marks the node
170  * visited, if it was not. */
171 FIRM_API int irn_visited_else_mark(ir_node *node);
172
173 /**
174  * Sets the link of a node.
175  * Only allowed if the graph is NOT in phase_building.
176  */
177 FIRM_API void set_irn_link(ir_node *node, void *link);
178
179 /** Returns the link of a node.  */
180 FIRM_API void *get_irn_link(const ir_node *node);
181
182 /** Returns the ir_graph this node belongs to. */
183 FIRM_API ir_graph *get_irn_irg(const ir_node *node);
184
185 /** Outputs a unique number for this node if libFIRM is compiled for
186    debugging, (configure with --enable-debug) else returns address
187    of node cast to long. */
188 FIRM_API long get_irn_node_nr(const ir_node *node);
189
190 /** Returns the pinned state of a node.
191  *
192  *  Returns whether the node _always_ must be pinned.
193  *  I.e., the node is not floating after global cse.
194  *
195  * @returns Either state op_pin_state_pinned or op_pin_state_floats.
196  */
197 FIRM_API op_pin_state get_irn_pinned(const ir_node *node);
198
199 /** Sets pin state for nodes with op pin state op_pin_state_exc_pinned */
200 FIRM_API void set_irn_pinned(ir_node *node, op_pin_state state);
201
202 /** Returns whether the node is currently pinned.
203  *
204  * If get_irn_pinned returns op_pin_state_floats and the graph the
205  * node belongs to is in state op_poin_state_floats then this function
206  * returns 'floats', else 'pinned'.
207  */
208 FIRM_API op_pin_state is_irn_pinned_in_irg(const ir_node *node);
209
210 /**
211  * IR node constructor.
212  * Create a new IR node in irg, with an op, mode, arity and
213  * some incoming IR nodes.
214  * Normally you should not use this constructor directly unless you registered
215  * custom opcodes. For the default opcodes firm provides specific constructors.
216  *
217  * @param db    Debug info.
218  * @param irg   IR-graph on with this new node should be constructed.
219  * @param block The block the new node belongs to
220  * @param op    The opcode of the new node.
221  * @param mode  The mode of the new node.
222  * @param arity The arity of the new node, <0 if can be changed dynamically.
223  * @param in    An array of arity predecessor nodes.
224  */
225 FIRM_API ir_node *new_ir_node(dbg_info *db, ir_graph *irg, ir_node *block,
226                               ir_op *op, ir_mode *mode,
227                               int arity, ir_node *const *in);
228
229 /**
230  * Returns the block the node belongs to.  This is only
231  * possible for pinned nodes or if the graph is in pinned state.
232  * Otherwise the block may be incorrect.  This condition is
233  * now checked by an assertion.
234  *
235  * This works for all except Block.  It can return Blocks or the Bad node.
236  *
237  * To express the difference to access routines that work for all
238  * nodes we use infix "nodes" and do not name this function
239  * get_irn_block(). */
240 FIRM_API ir_node *get_nodes_block(const ir_node *node);
241
242 /** Sets the Block of a node. */
243 FIRM_API void set_nodes_block(ir_node *node, ir_node *block);
244
245 /**
246  * @addtogroup Block
247  * @{
248  */
249
250 /**
251  * Returns the position of the predecessor block pred in the inputs
252  * of the block block.
253  *
254  * @param block  the block
255  * @param pred   a predecessor block of block
256  *
257  * @return the position of pred in block or -1
258  */
259 FIRM_API int get_Block_cfgpred_pos(const ir_node *block, const ir_node *pred);
260
261 /**
262  * Returns the predecessor block.
263  *
264  * Returns the block corresponding to the predecessor pos of block.
265  *
266  * If we encounter the Bad node, this function does not return Start block, but
267  * the Bad node.
268  */
269 FIRM_API ir_node *get_Block_cfgpred_block(const ir_node *node, int pos);
270
271 /** Returns the matured flag of a block */
272 FIRM_API int get_Block_matured(const ir_node *block);
273 /** set the matured flag of a block. */
274 FIRM_API void set_Block_matured(ir_node *block, int matured);
275
276 /** A visited flag only for block nodes.
277  *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
278 FIRM_API ir_visited_t get_Block_block_visited(const ir_node *block);
279 /** set block visited flag */
280 FIRM_API void set_Block_block_visited(ir_node *block, ir_visited_t visit);
281
282 /** Marks a block as visited by setting its visited counter */
283 FIRM_API void mark_Block_block_visited(ir_node *node);
284 /** Returns 1 if a block is marked as visited */
285 FIRM_API int Block_block_visited(const ir_node *node);
286
287 /** Returns the ir_graph this Block belongs to. */
288 FIRM_API ir_graph *get_Block_irg(const ir_node *block);
289 /** Returns the entity for a Block (creating it if necessary) */
290 FIRM_API ir_entity *create_Block_entity(ir_node *block);
291 /** Returns the head of the Phi list for this block. */
292 FIRM_API ir_node *get_Block_phis(const ir_node *block);
293 /** Sets the head of the Phi list for this block. */
294 FIRM_API void set_Block_phis(ir_node *block, ir_node *phi);
295 /** Add a Phi node to the list of Block Phi's. */
296 FIRM_API void add_Block_phi(ir_node *block, ir_node *phi);
297 /** Returns the Block mark (single bit). */
298 FIRM_API unsigned get_Block_mark(const ir_node *block);
299 /** Sets the Block mark (single bit). */
300 FIRM_API void set_Block_mark(ir_node *block, unsigned mark);
301
302 /** @} */
303
304 /** Tests whether arbitrary node is frame pointer.
305  *
306  * Tests whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
307  * from Start.  If so returns frame type, else Null. */
308 FIRM_API ir_type *is_frame_pointer(const ir_node *n);
309
310 /** @addtogroup End
311  * @{
312  */
313
314 /** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
315 FIRM_API void add_End_keepalive(ir_node *end, ir_node *ka);
316
317 /**
318  * Sets new keep-alives.
319  * Beware: This might be an expensive operation if dynamic edges are enabled,
320  * so avoid it in the backend.
321  */
322 FIRM_API void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
323
324 /** Removes irn from the keep-alive set. */
325 FIRM_API void remove_End_keepalive(ir_node *end, ir_node *irn);
326
327 /** Removes Bads, NoMem and doublets from the keep-alive set. */
328 FIRM_API void remove_End_Bads_and_doublets(ir_node *end);
329
330 /** Some parts of the End node are allocated separately -- their memory
331  * is not recovered by dead_node_elimination if a End node is dead.
332  * free_End() frees these data structures.
333  */
334 FIRM_API void free_End(ir_node *end);
335
336 /** @} */
337
338 /** @addtogroup Const
339  * @{
340  */
341
342 /** Returns non-zero if the given Const node represents the 0 constant. */
343 FIRM_API int is_Const_null(const ir_node *node);
344
345 /** Returns non-zero if the given Const node represents the 1 constant. */
346 FIRM_API int is_Const_one(const ir_node *node);
347
348 /** Returns non-zero if the given Const node represents the constant with all bits set. */
349 FIRM_API int is_Const_all_one(const ir_node *node);
350
351 /** @} */
352
353 /**
354  * @addtogroup SymConst
355  * @{
356  */
357
358 /**
359  * Returns true if node is a SymConst node with kind symconst_addr_ent.
360  */
361 FIRM_API int is_SymConst_addr_ent(const ir_node *node);
362
363 /** Returns non-zero if s symconst kind has a type attribute */
364 #define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)
365
366 /** Returns non-zero if s symconst kind has an entity attribute */
367 #define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
368
369 /** Returns non-zero if s symconst kind has an enum_const attribute */
370 #define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)
371
372 /** Returns the kind of the SymConst. */
373 FIRM_API symconst_kind get_SymConst_kind(const ir_node *node);
374 /** Sets the kind of the SymConst. */
375 FIRM_API void set_SymConst_kind(ir_node *node, symconst_kind num);
376
377 /** Returns the type attribute of SymConst node @p node.
378  * @note Only to access SymConst of kind type_siz, else assertion.
379  */
380 FIRM_API ir_type *get_SymConst_type(const ir_node *node);
381 /** Sets the type attribute of SymConst node @p node. */
382 FIRM_API void set_SymConst_type(ir_node *node, ir_type *tp);
383
384 /** Returns the entity attribute of SymConst node @p node.
385  * @note Only to access SymConst of kind addr_ent, else assertion.
386  */
387 FIRM_API ir_entity *get_SymConst_entity(const ir_node *node);
388 /** Sets the entity attribute of Symconst node @p node. */
389 FIRM_API void set_SymConst_entity(ir_node *node, ir_entity *ent);
390
391 /** Returns the enum attribute of SymConst node @p node.
392  * Only to access SymConst of kind symconst_enum_const, else assertion
393  */
394 FIRM_API ir_enum_const *get_SymConst_enum(const ir_node *node);
395 /** Sets the enum attribute of SymConst node @p node. */
396 FIRM_API void set_SymConst_enum(ir_node *node, ir_enum_const *ec);
397
398 /** Returns the symbol attribute of SymConst node @p node. */
399 FIRM_API union symconst_symbol get_SymConst_symbol(const ir_node *node);
400 /** Sets the symbol attribute of SymConst node @p node. */
401 FIRM_API void set_SymConst_symbol(ir_node *node, union symconst_symbol sym);
402
403 /** @} */
404
405 /** @addtogroup Call
406  * @{
407  */
408
409 /** Sets, get and remove the callee information for a Call node.
410  *
411  *  The callee information lists all method entities that can be called
412  *  from this node.  If the address expression can not be analyzed fully,
413  *  e.g., as entities can be called that are not in the compilation unit,
414  *  the array contains the unknown_entity.  The array contains only entities
415  *  with peculiarity_existent, but with all kinds of visibility.  The entities
416  *  not necessarily contain an irg.
417  *
418  *  The array is only accessible if callee information is valid.  See flag
419  *  in graph.
420  *
421  *  The memory allocated for the array is managed automatically, i.e., it must
422  *  not be freed if the Call node is removed from the graph.
423  *
424  *  @param node A Call node.
425  */
426 FIRM_API int Call_has_callees(const ir_node *node);
427 /** Returns the number of callees of Call node @p node. */
428 FIRM_API size_t get_Call_n_callees(const ir_node *node);
429 /** Returns callee number @p pos of Call node @p node. */
430 FIRM_API ir_entity *get_Call_callee(const ir_node *node, size_t pos);
431
432 /** Sets the full callee array.
433  *
434  *  The passed array is copied. */
435 FIRM_API void set_Call_callee_arr(ir_node *node, size_t n, ir_entity **arr);
436 /** Frees callee array of call node @p node */
437 FIRM_API void remove_Call_callee_arr(ir_node *node);
438
439 /** @} */
440
441 /** Returns a human readable string for the ir_builtin_kind. */
442 FIRM_API const char *get_builtin_kind_name(ir_builtin_kind kind);
443
444 /** Tests whether node is an unary operation (opcode arity is #oparity_unary)
445  * @returns 1 if @p node is an unary operation, 0 otherwise
446  */
447 FIRM_API int is_unop(const ir_node *node);
448 /** Returns (arithmetic) operand of unary operation @p node. */
449 FIRM_API ir_node *get_unop_op(const ir_node *node);
450 /** Sets (arithmetic) operand of unary operation @p node. */
451 FIRM_API void set_unop_op(ir_node *node, ir_node *op);
452
453 /** Tests whether node is a binary operation (opcode arity is #oparity_binary)
454  * @returns 1 if @p node is an binary operation, 0 otherwise
455  */
456 FIRM_API int is_binop(const ir_node *node);
457 /** Returns left operand of binary operation @p node. */
458 FIRM_API ir_node *get_binop_left(const ir_node *node);
459 /** Sets left operand of binary operation @p node. */
460 FIRM_API void set_binop_left(ir_node *node, ir_node *left);
461 /** Returns rights operand of binary operation @p node. */
462 FIRM_API ir_node *get_binop_right(const ir_node *node);
463 /** Sets right operand of binary operation @p node. */
464 FIRM_API void set_binop_right(ir_node *node, ir_node *right);
465
466 /**
467  * Tests whether a node is the X_except Proj of a fragile operation
468  */
469 FIRM_API int is_x_except_Proj(const ir_node *node);
470
471 /**
472  * Tests whether a node is the X_regular Proj of a fragile operation
473  */
474 FIRM_API int is_x_regular_Proj(const ir_node *node);
475
476 /**
477  * Sets throws exception attribute of a fragile node
478  * @p throws_exception must be 0 or 1
479  */
480 FIRM_API void ir_set_throws_exception(ir_node *node, int throws_exception);
481
482 /** Returns throws_exception attribute of a fragile node */
483 FIRM_API int ir_throws_exception(const ir_node *node);
484
485 /** Returns the name of an ir_relation */
486 FIRM_API const char *get_relation_string(ir_relation relation);
487
488 /** Calculates the negated (Complement(R)) relation, i.e. "<" --> ">=" */
489 FIRM_API ir_relation get_negated_relation(ir_relation relation);
490
491 /** Calculates the inversed (R^-1) relation, i.e., "<" --> ">" */
492 FIRM_API ir_relation get_inversed_relation(ir_relation relation);
493
494 /**
495  * @addtogroup Phi
496  * @{
497  */
498
499 /**
500  * Returns the next element of a block phi list.
501  */
502 FIRM_API ir_node *get_Phi_next(const ir_node *phi);
503 /**
504  * Sets the next link of a block Phi list.
505  */
506 FIRM_API void set_Phi_next(ir_node *phi, ir_node *next);
507
508 /** @} */
509
510 /** Returns true if @p node is a memory operation.
511  *
512  * A memory operation is a node with an opcode that has irop_flag_uses_memory
513  * set. It is guaranteed to have (exactly) one memory input.
514  */
515 FIRM_API int is_memop(const ir_node *node);
516 /**
517  * Returns the memory input of a memory operation.
518  */
519 FIRM_API ir_node *get_memop_mem(const ir_node *node);
520 /**
521  * Sets the memory input of a memory operation.
522  */
523 FIRM_API void set_memop_mem(ir_node *node, ir_node *mem);
524
525 /** @addtogroup Sync
526  * @{
527  */
528
529 /** Adds @p pred to predecessor list of Sync node @p node. */
530 FIRM_API void add_Sync_pred(ir_node *node, ir_node *pred);
531 /** Removes predecessor i from Sync n */
532 FIRM_API void del_Sync_n(ir_node *n, int i);
533
534 /** @} */
535
536 /**
537  * Returns non-zero if a node is a routine parameter.
538  *
539  * @param node  the Proj node to test
540  */
541 FIRM_API int is_arg_Proj(const ir_node *node);
542
543 /** @addtogroup ASM
544  * @{
545  */
546
547 /** Returns the number of output constraints for an ASM node.  */
548 FIRM_API size_t get_ASM_n_output_constraints(const ir_node *node);
549 /** Returns the number of clobbered registers for an ASM node.  */
550 FIRM_API size_t get_ASM_n_clobbers(const ir_node *node);
551
552 /** @} */
553
554 /** Returns operand of node if node is a Proj. */
555 FIRM_API ir_node *skip_Proj(ir_node *node);
556 /** Returns operand of node if node is a Proj. */
557 FIRM_API const ir_node *skip_Proj_const(const ir_node *node);
558 /** Returns operand of node if node is a Id. */
559 FIRM_API ir_node *skip_Id(ir_node *node);
560 /** Returns corresponding operand of Tuple if node is a Proj from a Tuple. */
561 FIRM_API ir_node *skip_Tuple(ir_node *node);
562 /** Returns operand of node if node is a Pin. */
563 FIRM_API ir_node *skip_Pin(ir_node *node);
564 /** Returns operand of node if node is a Confirm */
565 FIRM_API ir_node *skip_Confirm(ir_node *node);
566 /** Skip all high-level Operations (including Confirm). */
567 FIRM_API ir_node *skip_HighLevel_ops(ir_node *node);
568 /** Returns true if the operation manipulates control flow */
569 FIRM_API int is_cfop(const ir_node *node);
570 /** Returns true if the operation jumps to an unknown destination.
571  * See irop_flag_unknown_jump for a detailed explanation */
572 FIRM_API int is_unknown_jump(const ir_node *node);
573
574 /**
575  * Returns true if the operation can change the control flow because
576  * of an exception: Call, Div, Mod, Load, Store, Alloc,
577  * Bad. Raise is not fragile, but a unconditional jump.
578  */
579 FIRM_API int is_fragile_op(const ir_node *node);
580
581 /** Returns true if the operation is a forking control flow
582  *  operation: Cond. */
583 FIRM_API int is_irn_forking(const ir_node *node);
584
585 /**
586  * Copies attributes stored in the old node to a new node.
587  * Assumes both have the same opcode and sufficient size.
588  *
589  * @param irg       The irg of the new_node (get_irn_irg on it might not work
590  *                  yet)
591  * @param old_node  the node where the attributes are copied from
592  * @param new_node  node the attributes get copies to.
593  *
594  * This copies all essential information to the new node. It does not copy
595  * temporal or calculated information like visited flags or results of dominance
596  * or loop calculations
597  */
598 FIRM_API void copy_node_attr(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
599
600 /** Returns the type attribute of a node n (SymConst, Call, Alloc, Free)
601  *  or NULL.*/
602 FIRM_API ir_type *get_irn_type_attr(ir_node *n);
603
604 /** Returns the entity attribute of a node n (SymConst, Sel) or NULL. */
605 FIRM_API ir_entity *get_irn_entity_attr(ir_node *n);
606
607 /** Returns non-zero for constant-like nodes. */
608 FIRM_API int is_irn_constlike(const ir_node *node);
609
610 /**
611  * Returns non-zero for nodes that are allowed to have keep-alives and
612  * are neither Block nor PhiM.
613  */
614 FIRM_API int is_irn_keep(const ir_node *node);
615
616 /**
617  * Returns non-zero for nodes that are always placed in the start block.
618  */
619 FIRM_API int is_irn_start_block_placed(const ir_node *node);
620
621 /**
622  * Returns non-zero for nodes that are CSE neutral to its users.
623  */
624 FIRM_API int is_irn_cse_neutral(const ir_node *node);
625
626 /** Returns the string representation of the jump prediction. */
627 FIRM_API const char *get_cond_jmp_predicate_name(cond_jmp_predicate pred);
628
629 /**
630  * Returns a pointer to the node attributes.
631  * Used for accessing attributes of user-defined nodes.
632  */
633 FIRM_API void *get_irn_generic_attr(ir_node *node);
634 /**
635  * Returns a pointer to the node attributes.
636  * Used for accessing attributes of user-defined nodes.
637  */
638 FIRM_API const void *get_irn_generic_attr_const(const ir_node *node);
639
640 /**
641  * Returns the unique node index for the node in its graph.
642  * This index is used to access phase information for this node.
643  * @see get_idx_irn()
644  */
645 FIRM_API unsigned get_irn_idx(const ir_node *node);
646
647 /**
648  * Sets the debug information of a node.
649  *
650  * @param n   The node.
651  * @param db  The debug info.
652  */
653 FIRM_API void set_irn_dbg_info(ir_node *n, dbg_info *db);
654
655 /**
656  * Returns the debug information of an node.
657  *
658  * @param n   The node.
659  */
660 FIRM_API dbg_info *get_irn_dbg_info(const ir_node *n);
661
662 /**
663  * Returns a descriptive name of a node (containing type+number)
664  */
665 FIRM_API const char *gdb_node_helper(void *firm_object);
666
667 /**
668  * @addtogroup Switch
669  * @{
670  */
671
672 /**
673  * Creates a new switch_table datastructure with @p n_entries entries.
674  * The datastructure is allocated on the obstack of @p irg.
675  */
676 FIRM_API ir_switch_table *ir_new_switch_table(ir_graph *irg, size_t n_entries);
677
678 /**
679  * Returns number of entries available in switch table @p table.
680  */
681 FIRM_API size_t ir_switch_table_get_n_entries(const ir_switch_table *table);
682
683 /**
684  * Sets entry number @p entry in the switch table @p table.
685  * @param table  the switch table
686  * @param entry  entry number to set
687  * @param min    The minimum tarval that matches this entry
688  * @param max    The maximum tarval that matches this entry
689  * @param pn     Proj number taken on match
690  */
691 FIRM_API void ir_switch_table_set(ir_switch_table *table, size_t entry,
692                                   ir_tarval *min, ir_tarval *max, long pn);
693
694 /** Returns maximum tarval value of switch table entry @p entry */
695 FIRM_API ir_tarval *ir_switch_table_get_max(const ir_switch_table *table,
696                                             size_t entry);
697
698 /** Returns minimum tarval value of switch table entry @p entry */
699 FIRM_API ir_tarval *ir_switch_table_get_min(const ir_switch_table *table,
700                                             size_t entry);
701
702 /** Returns proj number taken if switch table entry @p entry matches */
703 FIRM_API long ir_switch_table_get_pn(const ir_switch_table *table, size_t entry);
704
705 /** Duplicates switch table @p table on obstack of @p irg */
706 FIRM_API ir_switch_table *ir_switch_table_duplicate(ir_graph *irg, const ir_switch_table *table);
707 /** @} */
708
709 /** @} */
710
711 #include "end.h"
712
713 #endif