2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Implements a trace scheduler as presented in Muchnik[TM].
23 * @author Michael Beck
30 #include "iredges_t.h"
33 #include "belistsched.h"
38 /* we need a special mark */
42 typedef struct trace_irn {
43 sched_timestep_t delay; /**< The delay for this node if already calculated, else 0. */
44 sched_timestep_t etime; /**< The earliest time of this node. */
45 unsigned num_user; /**< The number real users (mode datab) of this node */
46 int reg_diff; /**< The difference of num(out registers) - num(in registers) */
47 int preorder; /**< The pre-order position */
48 unsigned critical_path_len; /**< The weighted length of the longest critical path */
49 unsigned is_root : 1; /**< is a root node of a block */
52 typedef struct trace_env {
53 trace_irn_t *sched_info; /**< trace scheduling information about the nodes */
54 sched_timestep_t curr_time; /**< current time of the scheduler */
55 be_lv_t *liveness; /**< The liveness for the irg */
56 DEBUG_ONLY(firm_dbg_module_t *dbg;)
60 * Returns a random node from a nodeset
62 static ir_node *get_nodeset_node(const ir_nodeset_t *nodeset)
64 return ir_nodeset_first(nodeset);
68 * Returns non-zero if the node is a root node
70 static inline unsigned is_root_node(trace_env_t *env, ir_node *n)
72 unsigned const idx = get_irn_idx(n);
74 assert(idx < ARR_LEN(env->sched_info));
75 return env->sched_info[idx].is_root;
79 * Mark a node as root node
81 static inline void mark_root_node(trace_env_t *env, ir_node *n)
83 unsigned const idx = get_irn_idx(n);
85 assert(idx < ARR_LEN(env->sched_info));
86 env->sched_info[idx].is_root = 1;
90 * Get the current delay.
92 static inline sched_timestep_t get_irn_delay(trace_env_t *env, ir_node *n)
94 unsigned const idx = get_irn_idx(n);
96 assert(idx < ARR_LEN(env->sched_info));
97 return env->sched_info[idx].delay;
101 * Set the current delay.
103 static inline void set_irn_delay(trace_env_t *env, ir_node *n, sched_timestep_t delay)
105 unsigned const idx = get_irn_idx(n);
107 assert(idx < ARR_LEN(env->sched_info));
108 env->sched_info[idx].delay = delay;
112 * Get the current etime.
114 static inline sched_timestep_t get_irn_etime(trace_env_t *env, ir_node *n)
116 unsigned const idx = get_irn_idx(n);
118 assert(idx < ARR_LEN(env->sched_info));
119 return env->sched_info[idx].etime;
123 * Set the current etime.
125 static inline void set_irn_etime(trace_env_t *env, ir_node *n, sched_timestep_t etime)
127 unsigned const idx = get_irn_idx(n);
129 assert(idx < ARR_LEN(env->sched_info));
130 env->sched_info[idx].etime = etime;
134 * Get the number of users.
136 static inline unsigned get_irn_num_user(trace_env_t *env, ir_node *n)
138 unsigned const idx = get_irn_idx(n);
140 assert(idx < ARR_LEN(env->sched_info));
141 return env->sched_info[idx].num_user;
145 * Set the number of users.
147 static inline void set_irn_num_user(trace_env_t *env, ir_node *n, unsigned num_user)
149 unsigned const idx = get_irn_idx(n);
151 assert(idx < ARR_LEN(env->sched_info));
152 env->sched_info[idx].num_user = num_user;
156 * Get the register difference.
158 static inline int get_irn_reg_diff(trace_env_t *env, ir_node *n)
160 unsigned const idx = get_irn_idx(n);
162 assert(idx < ARR_LEN(env->sched_info));
163 return env->sched_info[idx].reg_diff;
167 * Set the register difference.
169 static inline void set_irn_reg_diff(trace_env_t *env, ir_node *n, int reg_diff)
171 unsigned const idx = get_irn_idx(n);
173 assert(idx < ARR_LEN(env->sched_info));
174 env->sched_info[idx].reg_diff = reg_diff;
178 * Get the pre-order position.
180 static inline int get_irn_preorder(trace_env_t *env, ir_node *n)
182 unsigned const idx = get_irn_idx(n);
184 assert(idx < ARR_LEN(env->sched_info));
185 return env->sched_info[idx].preorder;
189 * Set the pre-order position.
191 static inline void set_irn_preorder(trace_env_t *env, ir_node *n, int pos)
193 unsigned const idx = get_irn_idx(n);
195 assert(idx < ARR_LEN(env->sched_info));
196 env->sched_info[idx].preorder = pos;
200 * Get the pre-order position.
202 static inline unsigned get_irn_critical_path_len(trace_env_t *env, ir_node *n)
204 unsigned const idx = get_irn_idx(n);
206 assert(idx < ARR_LEN(env->sched_info));
207 return env->sched_info[idx].critical_path_len;
211 * Set the pre-order position.
213 static inline void set_irn_critical_path_len(trace_env_t *env, ir_node *n, unsigned len)
215 unsigned const idx = get_irn_idx(n);
217 assert(idx < ARR_LEN(env->sched_info));
218 env->sched_info[idx].critical_path_len = len;
222 * returns the exec-time for node n.
224 static sched_timestep_t exectime(trace_env_t *env, ir_node *n)
227 if (be_is_Keep(n) || is_Proj(n))
233 * Calculates the latency for between two ops
235 static sched_timestep_t latency(trace_env_t *env, ir_node *pred, int pred_cycle, ir_node *curr, int curr_cycle)
239 /* a Keep hides a root */
240 if (be_is_Keep(curr))
241 return exectime(env, pred);
243 /* Proj's are executed immediately */
251 * Returns the number of users of a node having mode datab.
253 static int get_num_successors(ir_node *irn)
257 if (get_irn_mode(irn) == mode_T) {
258 /* for mode_T nodes: count the users of all Projs */
259 foreach_out_edge(irn, edge) {
260 ir_node *proj = get_edge_src_irn(edge);
261 ir_mode *mode = get_irn_mode(proj);
264 sum += get_num_successors(proj);
265 else if (mode_is_datab(mode))
266 sum += get_irn_n_edges(proj);
270 /* do not count keep-alive edges */
271 foreach_out_edge(irn, edge) {
272 if (get_irn_opcode(get_edge_src_irn(edge)) != iro_End)
281 * Returns the difference of regs_output - regs_input;
283 static int get_reg_difference(trace_env_t *env, ir_node *irn)
288 ir_node *block = get_nodes_block(irn);
290 if (be_is_Call(irn)) {
291 /* we want calls preferred */
295 if (get_irn_mode(irn) == mode_T) {
296 /* mode_T nodes: num out regs == num Projs with mode datab */
297 foreach_out_edge(irn, edge) {
298 ir_node *proj = get_edge_src_irn(edge);
299 if (mode_is_datab(get_irn_mode(proj)))
306 /* num in regs: number of ins with mode datab and not ignore */
307 for (i = get_irn_arity(irn) - 1; i >= 0; i--) {
308 ir_node *in = get_irn_n(irn, i);
310 if (!mode_is_datab(get_irn_mode(in)))
313 if (arch_irn_is_ignore(in))
316 if (be_is_live_end(env->liveness, block, in))
322 return num_out - num_in;
326 * descent into a dag and create a pre-order list.
328 static void descent(ir_node *root, ir_node *block, ir_node **list, trace_env_t *env, unsigned path_len)
332 if (! is_Phi(root)) {
333 path_len += exectime(env, root);
334 if (get_irn_critical_path_len(env, root) < path_len) {
335 set_irn_critical_path_len(env, root, path_len);
337 /* calculate number of users (needed for heuristic) */
338 set_irn_num_user(env, root, get_num_successors(root));
340 /* calculate register difference (needed for heuristic) */
341 set_irn_reg_diff(env, root, get_reg_difference(env, root));
343 /* Phi nodes always leave the block */
344 for (i = get_irn_arity(root) - 1; i >= 0; --i) {
345 ir_node *pred = get_irn_n(root, i);
347 DBG((env->dbg, LEVEL_3, " node %+F\n", pred));
349 /* Blocks may happen as predecessors of End nodes */
353 /* already seen nodes are not marked */
354 if (get_irn_link(pred) != MARK)
357 /* don't leave our block */
358 if (get_nodes_block(pred) != block)
361 set_irn_link(pred, NULL);
363 descent(pred, block, list, env, path_len);
366 set_irn_link(root, *list);
371 * Returns non-zero if root is a root in the block block.
373 static int is_root(ir_node *root, ir_node *block)
375 foreach_out_edge(root, edge) {
376 ir_node *succ = get_edge_src_irn(edge);
380 /* Phi nodes are always in "another block */
383 if (get_nodes_block(succ) == block)
390 * Performs initial block calculations for trace scheduling.
392 static void trace_preprocess_block(trace_env_t *env, ir_node *block)
394 ir_node *root = NULL, *preord = NULL;
398 /* First step: Find the root set. */
399 foreach_out_edge(block, edge) {
400 ir_node *succ = get_edge_src_irn(edge);
402 if (is_Anchor(succ)) {
403 /* ignore a keep alive edge */
406 if (is_root(succ, block)) {
407 mark_root_node(env, succ);
408 set_irn_link(succ, root);
412 set_irn_link(succ, MARK);
415 /* Second step: calculate the pre-order list. */
417 for (curr = root; curr; curr = irn) {
418 irn = (ir_node*)get_irn_link(curr);
419 DBG((env->dbg, LEVEL_2, " DAG root %+F\n", curr));
420 descent(curr, block, &preord, env, 0);
424 /* Third step: calculate the Delay. Note that our
425 * list is now in pre-order, starting at root
427 for (cur_pos = 0, curr = root; curr; curr = (ir_node*)get_irn_link(curr), cur_pos++) {
431 /* assure, that branches can be executed last */
435 if (is_root_node(env, curr))
436 d = exectime(env, curr);
439 foreach_out_edge(curr, edge) {
440 ir_node *n = get_edge_src_irn(edge);
442 if (get_nodes_block(n) == block) {
445 ld = latency(env, curr, 1, n, 0) + get_irn_delay(env, n);
451 set_irn_delay(env, curr, d);
452 DB((env->dbg, LEVEL_2, "\t%+F delay %u\n", curr, d));
454 /* set the etime of all nodes to 0 */
455 set_irn_etime(env, curr, 0);
457 set_irn_preorder(env, curr, cur_pos);
462 * This functions gets called after a node finally has been made ready.
464 static void trace_node_ready(void *data, ir_node *irn, ir_node *pred)
466 trace_env_t *env = (trace_env_t*)data;
467 sched_timestep_t etime_p, etime;
469 etime = env->curr_time;
471 etime_p = get_irn_etime(env, pred);
472 etime += latency(env, pred, 1, irn, 0);
473 etime = etime_p > etime ? etime_p : etime;
476 set_irn_etime(env, irn, etime);
477 DB((env->dbg, LEVEL_2, "\tset etime of %+F to %u\n", irn, etime));
481 * Update the current time after irn has been selected.
483 static void trace_update_time(void *data, ir_node *irn)
485 trace_env_t *env = (trace_env_t*)data;
486 if (is_Phi(irn) || get_irn_opcode(irn) == beo_Start) {
487 env->curr_time += get_irn_etime(env, irn);
490 env->curr_time += exectime(env, irn);
495 * Allocates memory and initializes trace scheduling environment.
496 * @param irg The backend irg object
497 * @return The environment
499 static trace_env_t *trace_init(ir_graph *irg)
501 trace_env_t *env = XMALLOCZ(trace_env_t);
502 int nn = get_irg_last_idx(irg);
505 env->sched_info = NEW_ARR_FZ(trace_irn_t, nn);
506 env->liveness = be_get_irg_liveness(irg);
507 FIRM_DBG_REGISTER(env->dbg, "firm.be.sched.trace");
509 be_assure_live_chk(irg);
515 * Frees all memory allocated for trace scheduling environment.
516 * @param env The environment
518 static void trace_free(void *data)
520 trace_env_t *env = (trace_env_t*)data;
521 DEL_ARR_F(env->sched_info);
526 * Simple selector. Just assure that jumps are scheduled last.
528 static ir_node *basic_selection(ir_nodeset_t *ready_set)
530 /* assure that branches and constants are executed last */
531 foreach_ir_nodeset(ready_set, irn, iter) {
537 /* at last: schedule branches */
538 return get_nodeset_node(ready_set);
542 * The muchnik selector.
544 static ir_node *muchnik_select(void *block_env, ir_nodeset_t *ready_set)
546 trace_env_t *env = (trace_env_t*)block_env;
547 ir_nodeset_t mcands, ecands;
548 sched_timestep_t max_delay = 0;
550 /* calculate the max delay of all candidates */
551 foreach_ir_nodeset(ready_set, irn, iter) {
552 sched_timestep_t d = get_irn_delay(env, irn);
554 max_delay = d > max_delay ? d : max_delay;
557 ir_nodeset_init_size(&mcands, 8);
558 ir_nodeset_init_size(&ecands, 8);
560 /* build mcands and ecands */
561 foreach_ir_nodeset(ready_set, irn, iter) {
562 if (get_irn_delay(env, irn) == max_delay) {
563 ir_nodeset_insert(&mcands, irn);
564 if (get_irn_etime(env, irn) <= env->curr_time)
565 ir_nodeset_insert(&ecands, irn);
571 if (ir_nodeset_size(&mcands) == 1) {
572 irn = get_nodeset_node(&mcands);
573 DB((env->dbg, LEVEL_3, "\tirn = %+F, mcand = 1, max_delay = %u\n", irn, max_delay));
576 size_t cnt = ir_nodeset_size(&ecands);
578 irn = get_nodeset_node(&ecands);
581 /* BEWARE: don't select a JUMP if others are still possible */
584 DB((env->dbg, LEVEL_3, "\tirn = %+F, ecand = 1, max_delay = %u\n", irn, max_delay));
587 DB((env->dbg, LEVEL_3, "\tecand = %zu, max_delay = %u\n", cnt, max_delay));
588 irn = basic_selection(&ecands);
592 DB((env->dbg, LEVEL_3, "\tmcand = %zu\n", ir_nodeset_size(&mcands)));
593 irn = basic_selection(&mcands);
600 static void *muchnik_init_graph(ir_graph *irg)
602 trace_env_t *env = trace_init(irg);
606 static void *muchnik_init_block(void *graph_env, ir_node *bl)
608 trace_env_t *env = (trace_env_t*) graph_env;
609 trace_preprocess_block(env, bl);
613 static void sched_muchnik(ir_graph *irg)
615 static const list_sched_selector_t muchnik_selector = {
619 trace_node_ready, /* node_ready */
620 trace_update_time, /* node_selected */
621 NULL, /* finish_block */
622 trace_free /* finish_graph */
624 be_list_sched_graph(irg, &muchnik_selector);
628 * Execute the heuristic function.
630 static ir_node *heuristic_select(void *block_env, ir_nodeset_t *ns)
632 trace_env_t *trace_env = (trace_env_t*)block_env;
633 ir_node *cand = NULL;
634 int max_prio = INT_MIN;
635 int cur_prio = INT_MIN;
637 /* Note: register pressure calculation needs an overhaul, you need correct
638 * tracking for each register class indidually and weight by each class
639 int cur_pressure = ir_nodeset_size(lv); */
640 int cur_pressure = 1;
642 /* prefer instructions which can be scheduled early */
644 /* prefer instructions with lots of successors */
645 #define PRIO_NUMSUCCS 8
646 /* prefer instructions with long critical path */
647 #define PRIO_LEVEL 12
648 /* prefer instructions coming early in preorder */
649 #define PRIO_PREORD 8
650 /* weight of current register pressure */
651 #define PRIO_CUR_PRESS 20
652 /* weight of register pressure difference */
653 #define PRIO_CHG_PRESS 8
655 /* priority based selection, heuristic inspired by mueller diss */
656 foreach_ir_nodeset(ns, irn, iter) {
657 /* make sure that branches are scheduled last */
659 int rdiff = get_irn_reg_diff(trace_env, irn);
660 int sign = rdiff < 0;
661 int chg = (rdiff < 0 ? -rdiff : rdiff) << PRIO_CHG_PRESS;
663 reg_fact = chg * cur_pressure;
665 reg_fact = INT_MAX - 2;
666 reg_fact = sign ? -reg_fact : reg_fact;
668 cur_prio = (get_irn_critical_path_len(trace_env, irn) << PRIO_LEVEL)
669 //- (get_irn_delay(trace_env, irn) << PRIO_LEVEL)
670 + (get_irn_num_user(trace_env, irn) << PRIO_NUMSUCCS)
671 - (get_irn_etime(trace_env, irn) << PRIO_TIME)
672 //- ((get_irn_reg_diff(trace_env, irn) >> PRIO_CHG_PRESS) << ((cur_pressure >> PRIO_CUR_PRESS) - 3))
674 + (get_irn_preorder(trace_env, irn) << PRIO_PREORD); /* high preorder means early schedule */
675 if (cur_prio > max_prio) {
680 DBG((trace_env->dbg, LEVEL_4, "checked NODE %+F\n", irn));
681 DBG((trace_env->dbg, LEVEL_4, "\tpriority: %d\n", cur_prio));
682 DBG((trace_env->dbg, LEVEL_4, "\tpath len: %d (%d)\n", get_irn_critical_path_len(trace_env, irn), get_irn_critical_path_len(trace_env, irn) << PRIO_LEVEL));
683 DBG((trace_env->dbg, LEVEL_4, "\tdelay: %d (%d)\n", get_irn_delay(trace_env, irn), get_irn_delay(trace_env, irn) << PRIO_LEVEL));
684 DBG((trace_env->dbg, LEVEL_4, "\t#user: %d (%d)\n", get_irn_num_user(trace_env, irn), get_irn_num_user(trace_env, irn) << PRIO_NUMSUCCS));
685 DBG((trace_env->dbg, LEVEL_4, "\tetime: %d (%d)\n", get_irn_etime(trace_env, irn), 0 - (get_irn_etime(trace_env, irn) << PRIO_TIME)));
686 DBG((trace_env->dbg, LEVEL_4, "\tpreorder: %d (%d)\n", get_irn_preorder(trace_env, irn), get_irn_preorder(trace_env, irn) << PRIO_PREORD));
687 DBG((trace_env->dbg, LEVEL_4, "\treg diff: %d (%d)\n", get_irn_reg_diff(trace_env, irn), 0 - reg_fact));
688 DBG((trace_env->dbg, LEVEL_4, "\tpressure: %d\n", cur_pressure));
693 DBG((trace_env->dbg, LEVEL_4, "heuristic selected %+F:\n", cand));
696 cand = basic_selection(ns);
702 static void sched_heuristic(ir_graph *irg)
704 static const list_sched_selector_t heuristic_selector = {
708 trace_node_ready, /* node_ready */
709 trace_update_time, /* node_selected */
710 NULL, /* finish_block */
711 trace_free /* finish_graph */
713 be_list_sched_graph(irg, &heuristic_selector);
716 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_sched_trace)
717 void be_init_sched_trace(void)
719 be_register_scheduler("heur", sched_heuristic);
720 be_register_scheduler("muchnik", sched_muchnik);