-/* Copyright (C) 2002 by Universitaet Karlsruhe
-* All rights reserved.
-*
-*/
+/*
+ * Project: libFIRM
+ * File name: ir/ana/irdom.h
+ * Purpose: Construct and access dominator tree.
+ * Author: Goetz Lindenmaier
+ * Modified by:
+ * Created: 2.2002
+ * CVS-ID: $Id$
+ * Copyright: (c) 2002-2003 Universität Karlsruhe
+ * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ */
/**
* @file irdom.h
* @author Goetz Lindenmaier
*/
-/* $Id$ */
# ifndef _IRDOM_H_
# define _IRDOM_H_
# include "irnode.h"
-/* Accessing the dominator datastructure.
+/** Accessing the dominator datastructure.
*
* These routines only work properly if the ir_graph is in state
* dom_consistent or dom_inconsistent.
+ *
+ * If the block is not reachable from Start, returns a Bad node.
*/
ir_node *get_Block_idom(ir_node *bl);
void set_Block_idom(ir_node *bl, ir_node *n);
* idom = NULL;
* dom_depth = -1;
* pre_num = -1;
+ * Also constructs outs information. As this information is correct after
+ * the run does not free the outs information.
*/
void compute_doms(ir_graph *irg);
-/** Frees the dominator datastructures. Sets the flag in irg to "no_dom". */
+/** Frees the dominator datastructures. Sets the flag in irg to "dom_none". */
void free_dom_and_peace(ir_graph *irg);
#endif /* _IRDOM_H_ */