added doxygen comments
[libfirm] / ir / be / besched.h
1 /*
2  * Copyright (C) 1995-2007 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       Scheduling utilities for nodes in Blocks and Blocks.
23  * @author      Sebastian Hack
24  * @version     $Id$
25  */
26 #ifndef FIRM_BE_BESCHED_H
27 #define FIRM_BE_BESCHED_H
28
29 #include <stdio.h>
30
31 #include "irgraph.h"
32 #include "irnode.h"
33
34 void be_sched_dump(FILE *f, ir_graph *irg);
35
36 int     sched_get_time_step(const ir_node *irn);
37 int     sched_has_next(const ir_node *irn);
38 int     sched_has_prev(const ir_node *irn);
39 int     sched_is_scheduled(const ir_node *irn);
40 ir_node *sched_next(const ir_node *irn);
41 ir_node *sched_prev(const ir_node *irn);
42 ir_node *sched_first(const ir_node *block);
43 ir_node *sched_last(const ir_node *block);
44 ir_node *sched_add_before(ir_node *before, ir_node *irn);
45 ir_node *sched_add_after(ir_node *before, ir_node *irn);
46 void    sched_init_block(ir_node *block);
47 void    sched_reset(ir_node *node);
48 void    sched_remove(ir_node *irn);
49
50 #define sched_is_end(irn) is_Block(irn)
51 #define sched_is_begin(irn) is_Block(irn)
52
53 #define sched_foreach_from(from, irn) \
54   for(irn = from; !sched_is_end(irn); irn = sched_next(irn))
55
56 #define sched_foreach_reverse_from(from, irn) \
57   for(irn = from; !sched_is_begin(irn); irn = sched_prev(irn))
58
59 /**
60  * A shorthand macro for iterating over a schedule.
61  * @param block The block.
62  * @param irn A ir node pointer used as an iterator.
63  */
64 #define sched_foreach(block,irn) \
65         sched_foreach_from(sched_first(block), irn)
66
67 /**
68  * A shorthand macro for reversely iterating over a schedule.
69  * @param block The block.
70  * @param irn A ir node pointer used as an iterator.
71  */
72 #define sched_foreach_reverse(block,irn) \
73   sched_foreach_reverse_from(sched_last(block), irn)
74
75 /**
76  * Removes dead nodes from schedule
77  * @param irg  the graph
78  */
79 void be_remove_dead_nodes_from_schedule(ir_graph *irg);
80
81 #endif /* FIRM_BE_BESCHED_H */