-/* There are two implementations of the Phi node construction. The first
- is faster, but does not work for blocks with more than 2 predecessors.
- The second works always but is slower and causes more unnecessary Phi
- nodes.
- Select the implementations by the following preprocessor flag set in
- common/common.h: */
-#if USE_FAST_PHI_CONSTRUCTION
-
-/* This is a stack used for allocating and deallocating nodes in
- new_rd_Phi_in. The original implementation used the obstack
- to model this stack, now it is explicit. This reduces side effects.
-*/
-#if USE_EXPLICIT_PHI_IN_STACK
-Phi_in_stack *
-new_Phi_in_stack(void) {
- Phi_in_stack *res;
-
- res = (Phi_in_stack *) malloc ( sizeof (Phi_in_stack));
-
- res->stack = NEW_ARR_F (ir_node *, 0);
- res->pos = 0;
-
- return res;
-} /* new_Phi_in_stack */
-
-void
-free_Phi_in_stack(Phi_in_stack *s) {
- DEL_ARR_F(s->stack);
- free(s);
-} /* free_Phi_in_stack */
-
-static INLINE void
-free_to_Phi_in_stack(ir_node *phi) {
- if (ARR_LEN(current_ir_graph->Phi_in_stack->stack) ==
- current_ir_graph->Phi_in_stack->pos)
- ARR_APP1 (ir_node *, current_ir_graph->Phi_in_stack->stack, phi);
- else
- current_ir_graph->Phi_in_stack->stack[current_ir_graph->Phi_in_stack->pos] = phi;
-
- (current_ir_graph->Phi_in_stack->pos)++;
-} /* free_to_Phi_in_stack */
-
-static INLINE ir_node *
-alloc_or_pop_from_Phi_in_stack(ir_graph *irg, ir_node *block, ir_mode *mode,
- int arity, ir_node **in) {
- ir_node *res;
- ir_node **stack = current_ir_graph->Phi_in_stack->stack;
- int pos = current_ir_graph->Phi_in_stack->pos;
-
-
- if (pos == 0) {
- /* We need to allocate a new node */
- res = new_ir_node (db, irg, block, op_Phi, mode, arity, in);
- res->attr.phi_backedge = new_backedge_arr(irg->obst, arity);
- } else {
- /* reuse the old node and initialize it again. */
- res = stack[pos-1];
-
- assert(res->kind == k_ir_node);
- assert(res->op == op_Phi);
- res->mode = mode;
- res->visited = 0;
- res->link = NULL;
- assert(arity >= 0);
- /* ???!!! How to free the old in array?? Not at all: on obstack ?!! */
- res->in = NEW_ARR_D(ir_node *, irg->obst, (arity+1));
- res->in[0] = block;
- memcpy (&res->in[1], in, sizeof (ir_node *) * arity);
-
- (current_ir_graph->Phi_in_stack->pos)--;
- }
- return res;
-} /* alloc_or_pop_from_Phi_in_stack */
-#endif /* USE_EXPLICIT_PHI_IN_STACK */
-
-/**
- * Creates a Phi node with a given, fixed array **in of predecessors.
- * If the Phi node is unnecessary, as the same value reaches the block
- * through all control flow paths, it is eliminated and the value
- * returned directly. This constructor is only intended for use in
- * the automatic Phi node generation triggered by get_value or mature.
- * The implementation is quite tricky and depends on the fact, that
- * the nodes are allocated on a stack:
- * The in array contains predecessors and NULLs. The NULLs appear,
- * if get_r_value_internal, that computed the predecessors, reached
- * the same block on two paths. In this case the same value reaches
- * this block on both paths, there is no definition in between. We need
- * not allocate a Phi where these path's merge, but we have to communicate
- * this fact to the caller. This happens by returning a pointer to the
- * node the caller _will_ allocate. (Yes, we predict the address. We can
- * do so because the nodes are allocated on the obstack.) The caller then
- * finds a pointer to itself and, when this routine is called again,
- * eliminates itself.
- */
-static INLINE ir_node *
-new_rd_Phi_in(ir_graph *irg, ir_node *block, ir_mode *mode, ir_node **in, int ins) {
- int i;
- ir_node *res, *known;
-
- /* Allocate a new node on the obstack. This can return a node to
- which some of the pointers in the in-array already point.
- Attention: the constructor copies the in array, i.e., the later
- changes to the array in this routine do not affect the
- constructed node! If the in array contains NULLs, there will be
- missing predecessors in the returned node. Is this a possible
- internal state of the Phi node generation? */
-#if USE_EXPLICIT_PHI_IN_STACK
- res = known = alloc_or_pop_from_Phi_in_stack(irg, block, mode, ins, in);
-#else
- res = known = new_ir_node (NULL, irg, block, op_Phi, mode, ins, in);
- res->attr.phi_backedge = new_backedge_arr(irg->obst, ins);
-#endif
-
- /* The in-array can contain NULLs. These were returned by
- get_r_value_internal if it reached the same block/definition on a
- second path. The NULLs are replaced by the node itself to
- simplify the test in the next loop. */
- for (i = 0; i < ins; ++i) {
- if (in[i] == NULL)
- in[i] = res;
- }
-
- /* This loop checks whether the Phi has more than one predecessor.
- If so, it is a real Phi node and we break the loop. Else the Phi
- node merges the same definition on several paths and therefore is
- not needed. */
- for (i = 0; i < ins; ++i) {
- if (in[i] == res || in[i] == known)
- continue;
-
- if (known == res)
- known = in[i];
- else
- break;
- }
-
- /* i==ins: there is at most one predecessor, we don't need a phi node. */
- if (i==ins) {
-#if USE_EXPLICIT_PHI_IN_STACK
- free_to_Phi_in_stack(res);
-#else
- edges_node_deleted(res, current_ir_graph);
- obstack_free(current_ir_graph->obst, res);
-#endif
- res = known;
- } else {
- res = optimize_node (res);
- IRN_VRFY_IRG(res, irg);
- }
-
- /* return the pointer to the Phi node. This node might be deallocated! */
- return res;
-} /* new_rd_Phi_in */
-
-static ir_node *
-get_r_value_internal(ir_node *block, int pos, ir_mode *mode);
-
-/**
- * Allocates and returns this node. The routine called to allocate the
- * node might optimize it away and return a real value, or even a pointer
- * to a deallocated Phi node on top of the obstack!
- * This function is called with an in-array of proper size.
- */
-static ir_node *
-phi_merge(ir_node *block, int pos, ir_mode *mode, ir_node **nin, int ins) {
- ir_node *prevBlock, *res;
- int i;
-
- /* This loop goes to all predecessor blocks of the block the Phi node is in
- and there finds the operands of the Phi node by calling
- get_r_value_internal. */
- for (i = 1; i <= ins; ++i) {
- assert (block->in[i]);
- prevBlock = block->in[i]->in[0]; /* go past control flow op to prev block */
- assert (prevBlock);
- nin[i-1] = get_r_value_internal (prevBlock, pos, mode);
- }
-
- /* After collecting all predecessors into the array nin a new Phi node
- with these predecessors is created. This constructor contains an
- optimization: If all predecessors of the Phi node are identical it
- returns the only operand instead of a new Phi node. If the value
- passes two different control flow edges without being defined, and
- this is the second path treated, a pointer to the node that will be
- allocated for the first path (recursion) is returned. We already
- know the address of this node, as it is the next node to be allocated
- and will be placed on top of the obstack. (The obstack is a _stack_!) */
- res = new_rd_Phi_in (current_ir_graph, block, mode, nin, ins);
-
- /* Now we now the value for "pos" and can enter it in the array with
- all known local variables. Attention: this might be a pointer to
- a node, that later will be allocated!!! See new_rd_Phi_in().
- If this is called in mature, after some set_value() in the same block,
- the proper value must not be overwritten:
- The call order
- get_value (makes Phi0, put's it into graph_arr)
- set_value (overwrites Phi0 in graph_arr)
- mature_immBlock (upgrades Phi0, puts it again into graph_arr, overwriting
- the proper value.)
- fails. */
- if (!block->attr.block.graph_arr[pos]) {
- block->attr.block.graph_arr[pos] = res;
- } else {
- /* printf(" value already computed by %s\n",
- get_id_str(block->attr.block.graph_arr[pos]->op->name)); */
- }
-
- return res;
-}
-
-/**
- * This function returns the last definition of a variable. In case
- * this variable was last defined in a previous block, Phi nodes are
- * inserted. If the part of the firm graph containing the definition
- * is not yet constructed, a dummy Phi node is returned.
- */
-static ir_node *
-get_r_value_internal(ir_node *block, int pos, ir_mode *mode)
-{
- ir_node *res;
- /* There are 4 cases to treat.
-
- 1. The block is not mature and we visit it the first time. We can not
- create a proper Phi node, therefore a Phi0, i.e., a Phi without
- predecessors is returned. This node is added to the linked list (field
- "link") of the containing block to be completed when this block is
- matured. (Completion will add a new Phi and turn the Phi0 into an Id
- node.)
-
- 2. The value is already known in this block, graph_arr[pos] is set and we
- visit the block the first time. We can return the value without
- creating any new nodes.
-
- 3. The block is mature and we visit it the first time. A Phi node needs
- to be created (phi_merge). If the Phi is not needed, as all it's
- operands are the same value reaching the block through different
- paths, it's optimized away and the value itself is returned.
-
- 4. The block is mature, and we visit it the second time. Now two
- subcases are possible:
- * The value was computed completely the last time we were here. This
- is the case if there is no loop. We can return the proper value.
- * The recursion that visited this node and set the flag did not
- return yet. We are computing a value in a loop and need to
- break the recursion without knowing the result yet.
- @@@ strange case. Straight forward we would create a Phi before
- starting the computation of it's predecessors. In this case we will
- find a Phi here in any case. The problem is that this implementation
- only creates a Phi after computing the predecessors, so that it is
- hard to compute self references of this Phi. @@@
- There is no simple check for the second subcase. Therefore we check
- for a second visit and treat all such cases as the second subcase.
- Anyways, the basic situation is the same: we reached a block
- on two paths without finding a definition of the value: No Phi
- nodes are needed on both paths.
- We return this information "Two paths, no Phi needed" by a very tricky
- implementation that relies on the fact that an obstack is a stack and
- will return a node with the same address on different allocations.
- Look also at phi_merge and new_rd_phi_in to understand this.
- @@@ Unfortunately this does not work, see testprogram
- three_cfpred_example.
-
- */
-
- /* case 4 -- already visited. */
- if (get_irn_visited(block) == get_irg_visited(current_ir_graph)) return NULL;
-
- /* visited the first time */
- set_irn_visited(block, get_irg_visited(current_ir_graph));
-
- /* Get the local valid value */
- res = block->attr.block.graph_arr[pos];
-
- /* case 2 -- If the value is actually computed, return it. */
- if (res) return res;
-
- if (block->attr.block.matured) { /* case 3 */
-
- /* The Phi has the same amount of ins as the corresponding block. */
- int ins = get_irn_arity(block);
- ir_node **nin;
- NEW_ARR_A(ir_node *, nin, ins);
-
- /* Phi merge collects the predecessors and then creates a node. */
- res = phi_merge(block, pos, mode, nin, ins);
-
- } else { /* case 1 */
- /* The block is not mature, we don't know how many in's are needed. A Phi
- with zero predecessors is created. Such a Phi node is called Phi0
- node. (There is also an obsolete Phi0 opcode.) The Phi0 is then added
- to the list of Phi0 nodes in this block to be matured by mature_immBlock
- later.
- The Phi0 has to remember the pos of it's internal value. If the real
- Phi is computed, pos is used to update the array with the local
- values. */
-
- res = new_rd_Phi0(current_ir_graph, block, mode);
- res->attr.phi0_pos = pos;
- res->link = block->link;
- block->link = res;
- }
-
- /* If we get here, the frontend missed a use-before-definition error */
- if (!res) {
- /* Error Message */
- printf("Error: no value set. Use of undefined variable. Initializing to zero.\n");
- assert(mode->code >= irm_F && mode->code <= irm_P);
- res = new_rd_Const(NULL, current_ir_graph, block, mode,
- tarval_mode_null[mode->code]);
- }
-
- /* The local valid value is available now. */
- block->attr.block.graph_arr[pos] = res;
-
- return res;
-} /* get_r_value_internal */
-
-#else /* if 0 */
-
-/**
- it starts the recursion. This causes an Id at the entry of
- every block that has no definition of the value! **/
-
-#if USE_EXPLICIT_PHI_IN_STACK
-/* Just dummies */
-Phi_in_stack * new_Phi_in_stack() { return NULL; }
-void free_Phi_in_stack(Phi_in_stack *s) {}
-#endif