OSDN Git Service

2011-08-11 Sergey Grechanik <mouseentity@ispras.ru>
[pf3gnuchains/gcc-fork.git] / gcc / sched-int.h
1 /* Instruction scheduling pass.  This file contains definitions used
2    internally in the scheduler.
3    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4    2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5    Free Software Foundation, Inc.
6
7 This file is part of GCC.
8
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 3, or (at your option) any later
12 version.
13
14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
17 for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING3.  If not see
21 <http://www.gnu.org/licenses/>.  */
22
23 #ifndef GCC_SCHED_INT_H
24 #define GCC_SCHED_INT_H
25
26 #ifdef INSN_SCHEDULING
27
28 /* For state_t.  */
29 #include "insn-attr.h"
30 #include "df.h"
31 #include "basic-block.h"
32
33 /* For VEC (int, heap).  */
34 #include "vecprim.h"
35
36 /* Identificator of a scheduler pass.  */
37 enum sched_pass_id_t { SCHED_PASS_UNKNOWN, SCHED_RGN_PASS, SCHED_EBB_PASS,
38                        SCHED_SMS_PASS, SCHED_SEL_PASS };
39
40 typedef VEC (basic_block, heap) *bb_vec_t;
41 typedef VEC (rtx, heap) *insn_vec_t;
42 typedef VEC (rtx, heap) *rtx_vec_t;
43
44 extern void sched_init_bbs (void);
45
46 extern void sched_extend_luids (void);
47 extern void sched_init_insn_luid (rtx);
48 extern void sched_init_luids (bb_vec_t);
49 extern void sched_finish_luids (void);
50
51 extern void sched_extend_target (void);
52
53 extern void haifa_init_h_i_d (bb_vec_t);
54 extern void haifa_finish_h_i_d (void);
55
56 /* Hooks that are common to all the schedulers.  */
57 struct common_sched_info_def
58 {
59   /* Called after blocks were rearranged due to movement of jump instruction.
60      The first parameter - index of basic block, in which jump currently is.
61      The second parameter - index of basic block, in which jump used
62      to be.
63      The third parameter - index of basic block, that follows the second
64      parameter.  */
65   void (*fix_recovery_cfg) (int, int, int);
66
67   /* Called to notify frontend, that new basic block is being added.
68      The first parameter - new basic block.
69      The second parameter - block, after which new basic block is being added,
70      or EXIT_BLOCK_PTR, if recovery block is being added,
71      or NULL, if standalone block is being added.  */
72   void (*add_block) (basic_block, basic_block);
73
74   /* Estimate number of insns in the basic block.  */
75   int (*estimate_number_of_insns) (basic_block);
76
77   /* Given a non-insn (!INSN_P (x)) return
78      -1 - if this rtx don't need a luid.
79      0 - if it should have the same luid as the previous insn.
80      1 - if it needs a separate luid.  */
81   int (*luid_for_non_insn) (rtx);
82
83   /* Scheduler pass identifier.  It is preferably used in assertions.  */
84   enum sched_pass_id_t sched_pass_id;
85 };
86
87 extern struct common_sched_info_def *common_sched_info;
88
89 extern const struct common_sched_info_def haifa_common_sched_info;
90
91 /* Return true if selective scheduling pass is working.  */
92 static inline bool
93 sel_sched_p (void)
94 {
95   return common_sched_info->sched_pass_id == SCHED_SEL_PASS;
96 }
97
98 /* Returns maximum priority that an insn was assigned to.  */
99 extern int get_rgn_sched_max_insns_priority (void);
100
101 /* Increases effective priority for INSN by AMOUNT.  */
102 extern void sel_add_to_insn_priority (rtx, int);
103
104 /* True if during selective scheduling we need to emulate some of haifa
105    scheduler behaviour.  */
106 extern int sched_emulate_haifa_p;
107
108 /* Mapping from INSN_UID to INSN_LUID.  In the end all other per insn data
109    structures should be indexed by luid.  */
110 extern VEC (int, heap) *sched_luids;
111 #define INSN_LUID(INSN) (VEC_index (int, sched_luids, INSN_UID (INSN)))
112 #define LUID_BY_UID(UID) (VEC_index (int, sched_luids, UID))
113
114 #define SET_INSN_LUID(INSN, LUID) \
115 (VEC_replace (int, sched_luids, INSN_UID (INSN), (LUID)))
116
117 /* The highest INSN_LUID.  */
118 extern int sched_max_luid;
119
120 extern int insn_luid (rtx);
121
122 /* This list holds ripped off notes from the current block.  These notes will
123    be attached to the beginning of the block when its scheduling is
124    finished.  */
125 extern rtx note_list;
126
127 extern void remove_notes (rtx, rtx);
128 extern rtx restore_other_notes (rtx, basic_block);
129 extern void sched_insns_init (rtx);
130 extern void sched_insns_finish (void);
131
132 extern void *xrecalloc (void *, size_t, size_t, size_t);
133 extern rtx bb_note (basic_block);
134
135 extern void reemit_notes (rtx);
136
137 /* Functions in haifa-sched.c.  */
138 extern int haifa_classify_insn (const_rtx);
139
140 /* Functions in sel-sched-ir.c.  */
141 extern void sel_find_rgns (void);
142 extern void sel_mark_hard_insn (rtx);
143
144 extern size_t dfa_state_size;
145
146 extern void advance_state (state_t);
147
148 extern void setup_sched_dump (void);
149 extern void sched_init (void);
150 extern void sched_finish (void);
151
152 extern bool sel_insn_is_speculation_check (rtx);
153
154 /* Describe the ready list of the scheduler.
155    VEC holds space enough for all insns in the current region.  VECLEN
156    says how many exactly.
157    FIRST is the index of the element with the highest priority; i.e. the
158    last one in the ready list, since elements are ordered by ascending
159    priority.
160    N_READY determines how many insns are on the ready list.
161    N_DEBUG determines how many debug insns are on the ready list.  */
162 struct ready_list
163 {
164   rtx *vec;
165   int veclen;
166   int first;
167   int n_ready;
168   int n_debug;
169 };
170
171 extern char *ready_try;
172 extern struct ready_list ready;
173
174 extern int max_issue (struct ready_list *, int, state_t, bool, int *);
175
176 extern void ebb_compute_jump_reg_dependencies (rtx, regset);
177
178 extern edge find_fallthru_edge_from (basic_block);
179
180 extern void (* sched_init_only_bb) (basic_block, basic_block);
181 extern basic_block (* sched_split_block) (basic_block, rtx);
182 extern basic_block sched_split_block_1 (basic_block, rtx);
183 extern basic_block (* sched_create_empty_bb) (basic_block);
184 extern basic_block sched_create_empty_bb_1 (basic_block);
185
186 extern basic_block sched_create_recovery_block (basic_block *);
187 extern void sched_create_recovery_edges (basic_block, basic_block,
188                                          basic_block);
189
190 /* Pointer to data describing the current DFA state.  */
191 extern state_t curr_state;
192
193 /* Type to represent status of a dependence.  */
194 typedef int ds_t;
195
196 /* Type to represent weakness of speculative dependence.  */
197 typedef int dw_t;
198
199 extern enum reg_note ds_to_dk (ds_t);
200 extern ds_t dk_to_ds (enum reg_note);
201
202 /* Information about the dependency.  */
203 struct _dep
204 {
205   /* Producer.  */
206   rtx pro;
207
208   /* Consumer.  */
209   rtx con;
210
211   /* Dependency major type.  This field is superseded by STATUS below.
212      Though, it is still in place because some targets use it.  */
213   enum reg_note type;
214
215   /* Dependency status.  This field holds all dependency types and additional
216      information for speculative dependencies.  */
217   ds_t status;
218
219   /* Cached cost of the dependency.  */
220   int cost;
221 };
222
223 typedef struct _dep dep_def;
224 typedef dep_def *dep_t;
225
226 #define DEP_PRO(D) ((D)->pro)
227 #define DEP_CON(D) ((D)->con)
228 #define DEP_TYPE(D) ((D)->type)
229 #define DEP_STATUS(D) ((D)->status)
230 #define DEP_COST(D) ((D)->cost)
231
232 #define UNKNOWN_DEP_COST INT_MIN
233
234 /* Functions to work with dep.  */
235
236 extern void init_dep_1 (dep_t, rtx, rtx, enum reg_note, ds_t);
237 extern void init_dep (dep_t, rtx, rtx, enum reg_note);
238
239 extern void sd_debug_dep (dep_t);
240
241 /* Definition of this struct resides below.  */
242 struct _dep_node;
243 typedef struct _dep_node *dep_node_t;
244
245 /* A link in the dependency list.  This is essentially an equivalent of a
246    single {INSN, DEPS}_LIST rtx.  */
247 struct _dep_link
248 {
249   /* Dep node with all the data.  */
250   dep_node_t node;
251
252   /* Next link in the list. For the last one it is NULL.  */
253   struct _dep_link *next;
254
255   /* Pointer to the next field of the previous link in the list.
256      For the first link this points to the deps_list->first.
257
258      With help of this field it is easy to remove and insert links to the
259      list.  */
260   struct _dep_link **prev_nextp;
261 };
262 typedef struct _dep_link *dep_link_t;
263
264 #define DEP_LINK_NODE(N) ((N)->node)
265 #define DEP_LINK_NEXT(N) ((N)->next)
266 #define DEP_LINK_PREV_NEXTP(N) ((N)->prev_nextp)
267
268 /* Macros to work dep_link.  For most usecases only part of the dependency
269    information is need.  These macros conveniently provide that piece of
270    information.  */
271
272 #define DEP_LINK_DEP(N) (DEP_NODE_DEP (DEP_LINK_NODE (N)))
273 #define DEP_LINK_PRO(N) (DEP_PRO (DEP_LINK_DEP (N)))
274 #define DEP_LINK_CON(N) (DEP_CON (DEP_LINK_DEP (N)))
275 #define DEP_LINK_TYPE(N) (DEP_TYPE (DEP_LINK_DEP (N)))
276 #define DEP_LINK_STATUS(N) (DEP_STATUS (DEP_LINK_DEP (N)))
277
278 /* A list of dep_links.  */
279 struct _deps_list
280 {
281   /* First element.  */
282   dep_link_t first;
283
284   /* Total number of elements in the list.  */
285   int n_links;
286 };
287 typedef struct _deps_list *deps_list_t;
288
289 #define DEPS_LIST_FIRST(L) ((L)->first)
290 #define DEPS_LIST_N_LINKS(L) ((L)->n_links)
291
292 /* Suppose we have a dependence Y between insn pro1 and con1, where pro1 has
293    additional dependents con0 and con2, and con1 is dependent on additional
294    insns pro0 and pro1:
295
296    .con0      pro0
297    . ^         |
298    . |         |
299    . |         |
300    . X         A
301    . |         |
302    . |         |
303    . |         V
304    .pro1--Y-->con1
305    . |         ^
306    . |         |
307    . |         |
308    . Z         B
309    . |         |
310    . |         |
311    . V         |
312    .con2      pro2
313
314    This is represented using a "dep_node" for each dependence arc, which are
315    connected as follows (diagram is centered around Y which is fully shown;
316    other dep_nodes shown partially):
317
318    .          +------------+    +--------------+    +------------+
319    .          : dep_node X :    |  dep_node Y  |    : dep_node Z :
320    .          :            :    |              |    :            :
321    .          :            :    |              |    :            :
322    .          : forw       :    |  forw        |    : forw       :
323    .          : +--------+ :    |  +--------+  |    : +--------+ :
324    forw_deps  : |dep_link| :    |  |dep_link|  |    : |dep_link| :
325    +-----+    : | +----+ | :    |  | +----+ |  |    : | +----+ | :
326    |first|----->| |next|-+------+->| |next|-+--+----->| |next|-+--->NULL
327    +-----+    : | +----+ | :    |  | +----+ |  |    : | +----+ | :
328    . ^  ^     : |     ^  | :    |  |     ^  |  |    : |        | :
329    . |  |     : |     |  | :    |  |     |  |  |    : |        | :
330    . |  +--<----+--+  +--+---<--+--+--+  +--+--+--<---+--+     | :
331    . |        : |  |     | :    |  |  |     |  |    : |  |     | :
332    . |        : | +----+ | :    |  | +----+ |  |    : | +----+ | :
333    . |        : | |prev| | :    |  | |prev| |  |    : | |prev| | :
334    . |        : | |next| | :    |  | |next| |  |    : | |next| | :
335    . |        : | +----+ | :    |  | +----+ |  |    : | +----+ | :
336    . |        : |        | :<-+ |  |        |  |<-+ : |        | :<-+
337    . |        : | +----+ | :  | |  | +----+ |  |  | : | +----+ | :  |
338    . |        : | |node|-+----+ |  | |node|-+--+--+ : | |node|-+----+
339    . |        : | +----+ | :    |  | +----+ |  |    : | +----+ | :
340    . |        : |        | :    |  |        |  |    : |        | :
341    . |        : +--------+ :    |  +--------+  |    : +--------+ :
342    . |        :            :    |              |    :            :
343    . |        :  SAME pro1 :    |  +--------+  |    :  SAME pro1 :
344    . |        :  DIFF con0 :    |  |dep     |  |    :  DIFF con2 :
345    . |        :            :    |  |        |  |    :            :
346    . |                          |  | +----+ |  |
347    .RTX<------------------------+--+-|pro1| |  |
348    .pro1                        |  | +----+ |  |
349    .                            |  |        |  |
350    .                            |  | +----+ |  |
351    .RTX<------------------------+--+-|con1| |  |
352    .con1                        |  | +----+ |  |
353    . |                          |  |        |  |
354    . |                          |  | +----+ |  |
355    . |                          |  | |kind| |  |
356    . |                          |  | +----+ |  |
357    . |        :            :    |  | |stat| |  |    :            :
358    . |        :  DIFF pro0 :    |  | +----+ |  |    :  DIFF pro2 :
359    . |        :  SAME con1 :    |  |        |  |    :  SAME con1 :
360    . |        :            :    |  +--------+  |    :            :
361    . |        :            :    |              |    :            :
362    . |        : back       :    |  back        |    : back       :
363    . v        : +--------+ :    |  +--------+  |    : +--------+ :
364    back_deps  : |dep_link| :    |  |dep_link|  |    : |dep_link| :
365    +-----+    : | +----+ | :    |  | +----+ |  |    : | +----+ | :
366    |first|----->| |next|-+------+->| |next|-+--+----->| |next|-+--->NULL
367    +-----+    : | +----+ | :    |  | +----+ |  |    : | +----+ | :
368    .    ^     : |     ^  | :    |  |     ^  |  |    : |        | :
369    .    |     : |     |  | :    |  |     |  |  |    : |        | :
370    .    +--<----+--+  +--+---<--+--+--+  +--+--+--<---+--+     | :
371    .          : |  |     | :    |  |  |     |  |    : |  |     | :
372    .          : | +----+ | :    |  | +----+ |  |    : | +----+ | :
373    .          : | |prev| | :    |  | |prev| |  |    : | |prev| | :
374    .          : | |next| | :    |  | |next| |  |    : | |next| | :
375    .          : | +----+ | :    |  | +----+ |  |    : | +----+ | :
376    .          : |        | :<-+ |  |        |  |<-+ : |        | :<-+
377    .          : | +----+ | :  | |  | +----+ |  |  | : | +----+ | :  |
378    .          : | |node|-+----+ |  | |node|-+--+--+ : | |node|-+----+
379    .          : | +----+ | :    |  | +----+ |  |    : | +----+ | :
380    .          : |        | :    |  |        |  |    : |        | :
381    .          : +--------+ :    |  +--------+  |    : +--------+ :
382    .          :            :    |              |    :            :
383    .          : dep_node A :    |  dep_node Y  |    : dep_node B :
384    .          +------------+    +--------------+    +------------+
385 */
386
387 struct _dep_node
388 {
389   /* Backward link.  */
390   struct _dep_link back;
391
392   /* The dep.  */
393   struct _dep dep;
394
395   /* Forward link.  */
396   struct _dep_link forw;
397 };
398
399 #define DEP_NODE_BACK(N) (&(N)->back)
400 #define DEP_NODE_DEP(N) (&(N)->dep)
401 #define DEP_NODE_FORW(N) (&(N)->forw)
402
403 /* The following enumeration values tell us what dependencies we
404    should use to implement the barrier.  We use true-dependencies for
405    TRUE_BARRIER and anti-dependencies for MOVE_BARRIER.  */
406 enum reg_pending_barrier_mode
407 {
408   NOT_A_BARRIER = 0,
409   MOVE_BARRIER,
410   TRUE_BARRIER
411 };
412
413 /* Whether a register movement is associated with a call.  */
414 enum post_call_group
415 {
416   not_post_call,
417   post_call,
418   post_call_initial
419 };
420
421 /* Insns which affect pseudo-registers.  */
422 struct deps_reg
423 {
424   rtx uses;
425   rtx sets;
426   rtx implicit_sets;
427   rtx clobbers;
428   int uses_length;
429   int clobbers_length;
430 };
431
432 /* Describe state of dependencies used during sched_analyze phase.  */
433 struct deps_desc
434 {
435   /* The *_insns and *_mems are paired lists.  Each pending memory operation
436      will have a pointer to the MEM rtx on one list and a pointer to the
437      containing insn on the other list in the same place in the list.  */
438
439   /* We can't use add_dependence like the old code did, because a single insn
440      may have multiple memory accesses, and hence needs to be on the list
441      once for each memory access.  Add_dependence won't let you add an insn
442      to a list more than once.  */
443
444   /* An INSN_LIST containing all insns with pending read operations.  */
445   rtx pending_read_insns;
446
447   /* An EXPR_LIST containing all MEM rtx's which are pending reads.  */
448   rtx pending_read_mems;
449
450   /* An INSN_LIST containing all insns with pending write operations.  */
451   rtx pending_write_insns;
452
453   /* An EXPR_LIST containing all MEM rtx's which are pending writes.  */
454   rtx pending_write_mems;
455
456   /* We must prevent the above lists from ever growing too large since
457      the number of dependencies produced is at least O(N*N),
458      and execution time is at least O(4*N*N), as a function of the
459      length of these pending lists.  */
460
461   /* Indicates the length of the pending_read list.  */
462   int pending_read_list_length;
463
464   /* Indicates the length of the pending_write list.  */
465   int pending_write_list_length;
466
467   /* Length of the pending memory flush list. Large functions with no
468      calls may build up extremely large lists.  */
469   int pending_flush_length;
470
471   /* The last insn upon which all memory references must depend.
472      This is an insn which flushed the pending lists, creating a dependency
473      between it and all previously pending memory references.  This creates
474      a barrier (or a checkpoint) which no memory reference is allowed to cross.
475
476      This includes all non constant CALL_INSNs.  When we do interprocedural
477      alias analysis, this restriction can be relaxed.
478      This may also be an INSN that writes memory if the pending lists grow
479      too large.  */
480   rtx last_pending_memory_flush;
481
482   /* A list of the last function calls we have seen.  We use a list to
483      represent last function calls from multiple predecessor blocks.
484      Used to prevent register lifetimes from expanding unnecessarily.  */
485   rtx last_function_call;
486
487   /* A list of the last function calls that may not return normally
488      we have seen.  We use a list to represent last function calls from
489      multiple predecessor blocks.  Used to prevent moving trapping insns
490      across such calls.  */
491   rtx last_function_call_may_noreturn;
492
493   /* A list of insns which use a pseudo register that does not already
494      cross a call.  We create dependencies between each of those insn
495      and the next call insn, to ensure that they won't cross a call after
496      scheduling is done.  */
497   rtx sched_before_next_call;
498
499   /* Used to keep post-call pseudo/hard reg movements together with
500      the call.  */
501   enum post_call_group in_post_call_group_p;
502
503   /* The last debug insn we've seen.  */
504   rtx last_debug_insn;
505
506   /* The maximum register number for the following arrays.  Before reload
507      this is max_reg_num; after reload it is FIRST_PSEUDO_REGISTER.  */
508   int max_reg;
509
510   /* Element N is the next insn that sets (hard or pseudo) register
511      N within the current basic block; or zero, if there is no
512      such insn.  Needed for new registers which may be introduced
513      by splitting insns.  */
514   struct deps_reg *reg_last;
515
516   /* Element N is set for each register that has any nonzero element
517      in reg_last[N].{uses,sets,clobbers}.  */
518   regset_head reg_last_in_use;
519
520   /* Shows the last value of reg_pending_barrier associated with the insn.  */
521   enum reg_pending_barrier_mode last_reg_pending_barrier;
522
523   /* True when this context should be treated as a readonly by
524      the analysis.  */
525   BOOL_BITFIELD readonly : 1;
526 };
527
528 typedef struct deps_desc *deps_t;
529
530 /* This structure holds some state of the current scheduling pass, and
531    contains some function pointers that abstract out some of the non-generic
532    functionality from functions such as schedule_block or schedule_insn.
533    There is one global variable, current_sched_info, which points to the
534    sched_info structure currently in use.  */
535 struct haifa_sched_info
536 {
537   /* Add all insns that are initially ready to the ready list.  Called once
538      before scheduling a set of insns.  */
539   void (*init_ready_list) (void);
540   /* Called after taking an insn from the ready list.  Returns nonzero if
541      this insn can be scheduled, nonzero if we should silently discard it.  */
542   int (*can_schedule_ready_p) (rtx);
543   /* Return nonzero if there are more insns that should be scheduled.  */
544   int (*schedule_more_p) (void);
545   /* Called after an insn has all its hard dependencies resolved.
546      Adjusts status of instruction (which is passed through second parameter)
547      to indicate if instruction should be moved to the ready list or the
548      queue, or if it should silently discard it (until next resolved
549      dependence).  */
550   ds_t (*new_ready) (rtx, ds_t);
551   /* Compare priority of two insns.  Return a positive number if the second
552      insn is to be preferred for scheduling, and a negative one if the first
553      is to be preferred.  Zero if they are equally good.  */
554   int (*rank) (rtx, rtx);
555   /* Return a string that contains the insn uid and optionally anything else
556      necessary to identify this insn in an output.  It's valid to use a
557      static buffer for this.  The ALIGNED parameter should cause the string
558      to be formatted so that multiple output lines will line up nicely.  */
559   const char *(*print_insn) (const_rtx, int);
560   /* Return nonzero if an insn should be included in priority
561      calculations.  */
562   int (*contributes_to_priority) (rtx, rtx);
563
564   /* Return true if scheduling insn (passed as the parameter) will trigger
565      finish of scheduling current block.  */
566   bool (*insn_finishes_block_p) (rtx);
567
568   /* The boundaries of the set of insns to be scheduled.  */
569   rtx prev_head, next_tail;
570
571   /* Filled in after the schedule is finished; the first and last scheduled
572      insns.  */
573   rtx head, tail;
574
575   /* If nonzero, enables an additional sanity check in schedule_block.  */
576   unsigned int queue_must_finish_empty:1;
577
578   /* Maximum priority that has been assigned to an insn.  */
579   int sched_max_insns_priority;
580
581   /* Hooks to support speculative scheduling.  */
582
583   /* Called to notify frontend that instruction is being added (second
584      parameter == 0) or removed (second parameter == 1).  */
585   void (*add_remove_insn) (rtx, int);
586
587   /* Called to notify the frontend that instruction INSN is being
588      scheduled.  */
589   void (*begin_schedule_ready) (rtx insn);
590
591   /* Called to notify the frontend that an instruction INSN is about to be
592      moved to its correct place in the final schedule.  This is done for all
593      insns in order of the schedule.  LAST indicates the last scheduled
594      instruction.  */
595   void (*begin_move_insn) (rtx insn, rtx last);
596
597   /* If the second parameter is not NULL, return nonnull value, if the
598      basic block should be advanced.
599      If the second parameter is NULL, return the next basic block in EBB.
600      The first parameter is the current basic block in EBB.  */
601   basic_block (*advance_target_bb) (basic_block, rtx);
602
603   /* Allocate memory, store the frontend scheduler state in it, and
604      return it.  */
605   void *(*save_state) (void);
606   /* Restore frontend scheduler state from the argument, and free the
607      memory.  */
608   void (*restore_state) (void *);
609
610   /* ??? FIXME: should use straight bitfields inside sched_info instead of
611      this flag field.  */
612   unsigned int flags;
613 };
614
615 /* This structure holds description of the properties for speculative
616    scheduling.  */
617 struct spec_info_def
618 {
619   /* Holds types of allowed speculations: BEGIN_{DATA|CONTROL},
620      BE_IN_{DATA_CONTROL}.  */
621   int mask;
622
623   /* A dump file for additional information on speculative scheduling.  */
624   FILE *dump;
625
626   /* Minimal cumulative weakness of speculative instruction's
627      dependencies, so that insn will be scheduled.  */
628   dw_t data_weakness_cutoff;
629
630   /* Minimal usefulness of speculative instruction to be considered for
631      scheduling.  */
632   int control_weakness_cutoff;
633
634   /* Flags from the enum SPEC_SCHED_FLAGS.  */
635   int flags;
636 };
637 typedef struct spec_info_def *spec_info_t;
638
639 extern spec_info_t spec_info;
640
641 extern struct haifa_sched_info *current_sched_info;
642
643 /* Do register pressure sensitive insn scheduling if the flag is set
644    up.  */
645 extern bool sched_pressure_p;
646
647 /* Map regno -> its pressure class.  The map defined only when
648    SCHED_PRESSURE_P is true.  */
649 extern enum reg_class *sched_regno_pressure_class;
650
651 /* Indexed by INSN_UID, the collection of all data associated with
652    a single instruction.  */
653
654 struct _haifa_deps_insn_data
655 {
656   /* The number of incoming edges in the forward dependency graph.
657      As scheduling proceeds, counts are decreased.  An insn moves to
658      the ready queue when its counter reaches zero.  */
659   int dep_count;
660
661   /* Nonzero if instruction has internal dependence
662      (e.g. add_dependence was invoked with (insn == elem)).  */
663   unsigned int has_internal_dep;
664
665   /* NB: We can't place 'struct _deps_list' here instead of deps_list_t into
666      h_i_d because when h_i_d extends, addresses of the deps_list->first
667      change without updating deps_list->first->next->prev_nextp.  Thus
668      BACK_DEPS and RESOLVED_BACK_DEPS are allocated on the heap and FORW_DEPS
669      list is allocated on the obstack.  */
670
671   /* A list of hard backward dependencies.  The insn is a consumer of all the
672      deps mentioned here.  */
673   deps_list_t hard_back_deps;
674
675   /* A list of speculative (weak) dependencies.  The insn is a consumer of all
676      the deps mentioned here.  */
677   deps_list_t spec_back_deps;
678
679   /* A list of insns which depend on the instruction.  Unlike 'back_deps',
680      it represents forward dependencies.  */
681   deps_list_t forw_deps;
682
683   /* A list of scheduled producers of the instruction.  Links are being moved
684      from 'back_deps' to 'resolved_back_deps' while scheduling.  */
685   deps_list_t resolved_back_deps;
686
687   /* A list of scheduled consumers of the instruction.  Links are being moved
688      from 'forw_deps' to 'resolved_forw_deps' while scheduling to fasten the
689      search in 'forw_deps'.  */
690   deps_list_t resolved_forw_deps;
691
692   /* If the insn is conditional (either through COND_EXEC, or because
693      it is a conditional branch), this records the condition.  NULL
694      for insns that haven't been seen yet or don't have a condition;
695      const_true_rtx to mark an insn without a condition, or with a
696      condition that has been clobbered by a subsequent insn.  */
697   rtx cond;
698
699   /* True if the condition in 'cond' should be reversed to get the actual
700      condition.  */
701   unsigned int reverse_cond : 1;
702
703   /* Some insns (e.g. call) are not allowed to move across blocks.  */
704   unsigned int cant_move : 1;
705 };
706
707 /* Bits used for storing values of the fields in the following
708    structure.  */
709 #define INCREASE_BITS 8
710
711 /* The structure describes how the corresponding insn increases the
712    register pressure for each pressure class.  */
713 struct reg_pressure_data
714 {
715   /* Pressure increase for given class because of clobber.  */
716   unsigned int clobber_increase : INCREASE_BITS;
717   /* Increase in register pressure for given class because of register
718      sets. */
719   unsigned int set_increase : INCREASE_BITS;
720   /* Pressure increase for given class because of unused register
721      set.  */
722   unsigned int unused_set_increase : INCREASE_BITS;
723   /* Pressure change: #sets - #deaths.  */
724   int change : INCREASE_BITS;
725 };
726
727 /* The following structure describes usage of registers by insns.  */
728 struct reg_use_data
729 {
730   /* Regno used in the insn.  */
731   int regno;
732   /* Insn using the regno.  */
733   rtx insn;
734   /* Cyclic list of elements with the same regno.  */
735   struct reg_use_data *next_regno_use;
736   /* List of elements with the same insn.  */
737   struct reg_use_data *next_insn_use;
738 };
739
740 /* The following structure describes used sets of registers by insns.
741    Registers are pseudos whose pressure class is not NO_REGS or hard
742    registers available for allocations.  */
743 struct reg_set_data
744 {
745   /* Regno used in the insn.  */
746   int regno;
747   /* Insn setting the regno.  */
748   rtx insn;
749   /* List of elements with the same insn.  */
750   struct reg_set_data *next_insn_set;
751 };
752
753 struct _haifa_insn_data
754 {
755   /* We can't place 'struct _deps_list' into h_i_d instead of deps_list_t
756      because when h_i_d extends, addresses of the deps_list->first
757      change without updating deps_list->first->next->prev_nextp.  */
758
759   /* Logical uid gives the original ordering of the insns.  */
760   int luid;
761
762   /* A priority for each insn.  */
763   int priority;
764
765   /* The minimum clock tick at which the insn becomes ready.  This is
766      used to note timing constraints for the insns in the pending list.  */
767   int tick;
768
769   /* For insns that are scheduled at a fixed difference from another,
770      this records the tick in which they must be ready.  */
771   int exact_tick;
772
773   /* INTER_TICK is used to adjust INSN_TICKs of instructions from the
774      subsequent blocks in a region.  */
775   int inter_tick;
776
777   /* Used temporarily to estimate an INSN_TICK value for an insn given
778      current knowledge.  */
779   int tick_estimate;
780
781   /* See comment on QUEUE_INDEX macro in haifa-sched.c.  */
782   int queue_index;
783
784   short cost;
785
786   /* Set if there's DEF-USE dependence between some speculatively
787      moved load insn and this one.  */
788   unsigned int fed_by_spec_load : 1;
789   unsigned int is_load_insn : 1;
790   /* Nonzero if this insn has negative-cost forward dependencies against
791      an already scheduled insn.  */
792   unsigned int feeds_backtrack_insn : 1;
793
794   /* Nonzero if this insn is a shadow of another, scheduled after a fixed
795      delay.  We only emit shadows at the end of a cycle, with no other
796      real insns following them.  */
797   unsigned int shadow_p : 1;
798
799   /* '> 0' if priority is valid,
800      '== 0' if priority was not yet computed,
801      '< 0' if priority in invalid and should be recomputed.  */
802   signed char priority_status;
803
804   /* What speculations are necessary to apply to schedule the instruction.  */
805   ds_t todo_spec;
806
807   /* What speculations were already applied.  */
808   ds_t done_spec;
809
810   /* What speculations are checked by this instruction.  */
811   ds_t check_spec;
812
813   /* Recovery block for speculation checks.  */
814   basic_block recovery_block;
815
816   /* Original pattern of the instruction.  */
817   rtx orig_pat;
818
819   /* The following array contains info how the insn increases register
820      pressure.  There is an element for each cover class of pseudos
821      referenced in insns.  */
822   struct reg_pressure_data *reg_pressure;
823   /* The following array contains maximal reg pressure between last
824      scheduled insn and given insn.  There is an element for each
825      pressure class of pseudos referenced in insns.  This info updated
826      after scheduling each insn for each insn between the two
827      mentioned insns.  */
828   int *max_reg_pressure;
829   /* The following list contains info about used pseudos and hard
830      registers available for allocation.  */
831   struct reg_use_data *reg_use_list;
832   /* The following list contains info about set pseudos and hard
833      registers available for allocation.  */
834   struct reg_set_data *reg_set_list;
835   /* Info about how scheduling the insn changes cost of register
836      pressure excess (between source and target).  */
837   int reg_pressure_excess_cost_change;
838 };
839
840 typedef struct _haifa_insn_data haifa_insn_data_def;
841 typedef haifa_insn_data_def *haifa_insn_data_t;
842
843 DEF_VEC_O (haifa_insn_data_def);
844 DEF_VEC_ALLOC_O (haifa_insn_data_def, heap);
845
846 extern VEC(haifa_insn_data_def, heap) *h_i_d;
847
848 #define HID(INSN) (VEC_index (haifa_insn_data_def, h_i_d, INSN_UID (INSN)))
849
850 /* Accessor macros for h_i_d.  There are more in haifa-sched.c and
851    sched-rgn.c.  */
852 #define INSN_PRIORITY(INSN) (HID (INSN)->priority)
853 #define INSN_REG_PRESSURE(INSN) (HID (INSN)->reg_pressure)
854 #define INSN_MAX_REG_PRESSURE(INSN) (HID (INSN)->max_reg_pressure)
855 #define INSN_REG_USE_LIST(INSN) (HID (INSN)->reg_use_list)
856 #define INSN_REG_SET_LIST(INSN) (HID (INSN)->reg_set_list)
857 #define INSN_REG_PRESSURE_EXCESS_COST_CHANGE(INSN) \
858   (HID (INSN)->reg_pressure_excess_cost_change)
859 #define INSN_PRIORITY_STATUS(INSN) (HID (INSN)->priority_status)
860
861 typedef struct _haifa_deps_insn_data haifa_deps_insn_data_def;
862 typedef haifa_deps_insn_data_def *haifa_deps_insn_data_t;
863
864 DEF_VEC_O (haifa_deps_insn_data_def);
865 DEF_VEC_ALLOC_O (haifa_deps_insn_data_def, heap);
866
867 extern VEC(haifa_deps_insn_data_def, heap) *h_d_i_d;
868
869 #define HDID(INSN) (VEC_index (haifa_deps_insn_data_def, h_d_i_d,       \
870                                INSN_LUID (INSN)))
871 #define INSN_DEP_COUNT(INSN)    (HDID (INSN)->dep_count)
872 #define HAS_INTERNAL_DEP(INSN)  (HDID (INSN)->has_internal_dep)
873 #define INSN_FORW_DEPS(INSN) (HDID (INSN)->forw_deps)
874 #define INSN_RESOLVED_BACK_DEPS(INSN) (HDID (INSN)->resolved_back_deps)
875 #define INSN_RESOLVED_FORW_DEPS(INSN) (HDID (INSN)->resolved_forw_deps)
876 #define INSN_HARD_BACK_DEPS(INSN) (HDID (INSN)->hard_back_deps)
877 #define INSN_SPEC_BACK_DEPS(INSN) (HDID (INSN)->spec_back_deps)
878 #define INSN_CACHED_COND(INSN)  (HDID (INSN)->cond)
879 #define INSN_REVERSE_COND(INSN) (HDID (INSN)->reverse_cond)
880 #define CANT_MOVE(INSN) (HDID (INSN)->cant_move)
881 #define CANT_MOVE_BY_LUID(LUID) (VEC_index (haifa_deps_insn_data_def, h_d_i_d, \
882                                             LUID)->cant_move)
883
884
885 #define INSN_PRIORITY(INSN)     (HID (INSN)->priority)
886 #define INSN_PRIORITY_STATUS(INSN) (HID (INSN)->priority_status)
887 #define INSN_PRIORITY_KNOWN(INSN) (INSN_PRIORITY_STATUS (INSN) > 0)
888 #define TODO_SPEC(INSN) (HID (INSN)->todo_spec)
889 #define DONE_SPEC(INSN) (HID (INSN)->done_spec)
890 #define CHECK_SPEC(INSN) (HID (INSN)->check_spec)
891 #define RECOVERY_BLOCK(INSN) (HID (INSN)->recovery_block)
892 #define ORIG_PAT(INSN) (HID (INSN)->orig_pat)
893
894 /* INSN is either a simple or a branchy speculation check.  */
895 #define IS_SPECULATION_CHECK_P(INSN) \
896   (sel_sched_p () ? sel_insn_is_speculation_check (INSN) : RECOVERY_BLOCK (INSN) != NULL)
897
898 /* INSN is a speculation check that will simply reexecute the speculatively
899    scheduled instruction if the speculation fails.  */
900 #define IS_SPECULATION_SIMPLE_CHECK_P(INSN) \
901   (RECOVERY_BLOCK (INSN) == EXIT_BLOCK_PTR)
902
903 /* INSN is a speculation check that will branch to RECOVERY_BLOCK if the
904    speculation fails.  Insns in that block will reexecute the speculatively
905    scheduled code and then will return immediately after INSN thus preserving
906    semantics of the program.  */
907 #define IS_SPECULATION_BRANCHY_CHECK_P(INSN) \
908   (RECOVERY_BLOCK (INSN) != NULL && RECOVERY_BLOCK (INSN) != EXIT_BLOCK_PTR)
909
910 /* Dep status (aka ds_t) of the link encapsulates information, that is needed
911    for speculative scheduling.  Namely, it is 4 integers in the range
912    [0, MAX_DEP_WEAK] and 3 bits.
913    The integers correspond to the probability of the dependence to *not*
914    exist, it is the probability, that overcoming of this dependence will
915    not be followed by execution of the recovery code.  Nevertheless,
916    whatever high the probability of success is, recovery code should still
917    be generated to preserve semantics of the program.  To find a way to
918    get/set these integers, please refer to the {get, set}_dep_weak ()
919    functions in sched-deps.c .
920    The 3 bits in the DEP_STATUS correspond to 3 dependence types: true-,
921    output- and anti- dependence.  It is not enough for speculative scheduling
922    to know just the major type of all the dependence between two instructions,
923    as only true dependence can be overcome.
924    There also is the 4-th bit in the DEP_STATUS (HARD_DEP), that is reserved
925    for using to describe instruction's status.  It is set whenever instruction
926    has at least one dependence, that cannot be overcame.
927    See also: check_dep_status () in sched-deps.c .  */
928
929 /* We exclude sign bit.  */
930 #define BITS_PER_DEP_STATUS (HOST_BITS_PER_INT - 1)
931
932 /* First '4' stands for 3 dep type bits and HARD_DEP bit.
933    Second '4' stands for BEGIN_{DATA, CONTROL}, BE_IN_{DATA, CONTROL}
934    dep weakness.  */
935 #define BITS_PER_DEP_WEAK ((BITS_PER_DEP_STATUS - 4) / 4)
936
937 /* Mask of speculative weakness in dep_status.  */
938 #define DEP_WEAK_MASK ((1 << BITS_PER_DEP_WEAK) - 1)
939
940 /* This constant means that dependence is fake with 99.999...% probability.
941    This is the maximum value, that can appear in dep_status.
942    Note, that we don't want MAX_DEP_WEAK to be the same as DEP_WEAK_MASK for
943    debugging reasons.  Though, it can be set to DEP_WEAK_MASK, and, when
944    done so, we'll get fast (mul for)/(div by) NO_DEP_WEAK.  */
945 #define MAX_DEP_WEAK (DEP_WEAK_MASK - 1)
946
947 /* This constant means that dependence is 99.999...% real and it is a really
948    bad idea to overcome it (though this can be done, preserving program
949    semantics).  */
950 #define MIN_DEP_WEAK 1
951
952 /* This constant represents 100% probability.
953    E.g. it is used to represent weakness of dependence, that doesn't exist.  */
954 #define NO_DEP_WEAK (MAX_DEP_WEAK + MIN_DEP_WEAK)
955
956 /* Default weakness of speculative dependence.  Used when we can't say
957    neither bad nor good about the dependence.  */
958 #define UNCERTAIN_DEP_WEAK (MAX_DEP_WEAK - MAX_DEP_WEAK / 4)
959
960 /* Offset for speculative weaknesses in dep_status.  */
961 enum SPEC_TYPES_OFFSETS {
962   BEGIN_DATA_BITS_OFFSET = 0,
963   BE_IN_DATA_BITS_OFFSET = BEGIN_DATA_BITS_OFFSET + BITS_PER_DEP_WEAK,
964   BEGIN_CONTROL_BITS_OFFSET = BE_IN_DATA_BITS_OFFSET + BITS_PER_DEP_WEAK,
965   BE_IN_CONTROL_BITS_OFFSET = BEGIN_CONTROL_BITS_OFFSET + BITS_PER_DEP_WEAK
966 };
967
968 /* The following defines provide numerous constants used to distinguish between
969    different types of speculative dependencies.  */
970
971 /* Dependence can be overcome with generation of new data speculative
972    instruction.  */
973 #define BEGIN_DATA (((ds_t) DEP_WEAK_MASK) << BEGIN_DATA_BITS_OFFSET)
974
975 /* This dependence is to the instruction in the recovery block, that was
976    formed to recover after data-speculation failure.
977    Thus, this dependence can overcome with generating of the copy of
978    this instruction in the recovery block.  */
979 #define BE_IN_DATA (((ds_t) DEP_WEAK_MASK) << BE_IN_DATA_BITS_OFFSET)
980
981 /* Dependence can be overcome with generation of new control speculative
982    instruction.  */
983 #define BEGIN_CONTROL (((ds_t) DEP_WEAK_MASK) << BEGIN_CONTROL_BITS_OFFSET)
984
985 /* This dependence is to the instruction in the recovery block, that was
986    formed to recover after control-speculation failure.
987    Thus, this dependence can be overcome with generating of the copy of
988    this instruction in the recovery block.  */
989 #define BE_IN_CONTROL (((ds_t) DEP_WEAK_MASK) << BE_IN_CONTROL_BITS_OFFSET)
990
991 /* A few convenient combinations.  */
992 #define BEGIN_SPEC (BEGIN_DATA | BEGIN_CONTROL)
993 #define DATA_SPEC (BEGIN_DATA | BE_IN_DATA)
994 #define CONTROL_SPEC (BEGIN_CONTROL | BE_IN_CONTROL)
995 #define SPECULATIVE (DATA_SPEC | CONTROL_SPEC)
996 #define BE_IN_SPEC (BE_IN_DATA | BE_IN_CONTROL)
997
998 /* Constants, that are helpful in iterating through dep_status.  */
999 #define FIRST_SPEC_TYPE BEGIN_DATA
1000 #define LAST_SPEC_TYPE BE_IN_CONTROL
1001 #define SPEC_TYPE_SHIFT BITS_PER_DEP_WEAK
1002
1003 /* Dependence on instruction can be of multiple types
1004    (e.g. true and output). This fields enhance REG_NOTE_KIND information
1005    of the dependence.  */
1006 #define DEP_TRUE (((ds_t) 1) << (BE_IN_CONTROL_BITS_OFFSET + BITS_PER_DEP_WEAK))
1007 #define DEP_OUTPUT (DEP_TRUE << 1)
1008 #define DEP_ANTI (DEP_OUTPUT << 1)
1009
1010 #define DEP_TYPES (DEP_TRUE | DEP_OUTPUT | DEP_ANTI)
1011
1012 /* Instruction has non-speculative dependence.  This bit represents the
1013    property of an instruction - not the one of a dependence.
1014    Therefore, it can appear only in TODO_SPEC field of an instruction.  */
1015 #define HARD_DEP (DEP_ANTI << 1)
1016
1017 /* This represents the results of calling sched-deps.c functions,
1018    which modify dependencies.  */
1019 enum DEPS_ADJUST_RESULT {
1020   /* No dependence needed (e.g. producer == consumer).  */
1021   DEP_NODEP,
1022   /* Dependence is already present and wasn't modified.  */
1023   DEP_PRESENT,
1024   /* Existing dependence was modified to include additional information.  */
1025   DEP_CHANGED,
1026   /* New dependence has been created.  */
1027   DEP_CREATED
1028 };
1029
1030 /* Represents the bits that can be set in the flags field of the
1031    sched_info structure.  */
1032 enum SCHED_FLAGS {
1033   /* If set, generate links between instruction as DEPS_LIST.
1034      Otherwise, generate usual INSN_LIST links.  */
1035   USE_DEPS_LIST = 1,
1036   /* Perform data or control (or both) speculation.
1037      Results in generation of data and control speculative dependencies.
1038      Requires USE_DEPS_LIST set.  */
1039   DO_SPECULATION = USE_DEPS_LIST << 1,
1040   DO_BACKTRACKING = DO_SPECULATION << 1,
1041   SCHED_RGN = DO_BACKTRACKING << 1,
1042   SCHED_EBB = SCHED_RGN << 1,
1043   /* Scheduler can possibly create new basic blocks.  Used for assertions.  */
1044   NEW_BBS = SCHED_EBB << 1,
1045   SEL_SCHED = NEW_BBS << 1
1046 };
1047
1048 enum SPEC_SCHED_FLAGS {
1049   COUNT_SPEC_IN_CRITICAL_PATH = 1,
1050   PREFER_NON_DATA_SPEC = COUNT_SPEC_IN_CRITICAL_PATH << 1,
1051   PREFER_NON_CONTROL_SPEC = PREFER_NON_DATA_SPEC << 1,
1052   SEL_SCHED_SPEC_DONT_CHECK_CONTROL = PREFER_NON_CONTROL_SPEC << 1
1053 };
1054
1055 #define NOTE_NOT_BB_P(NOTE) (NOTE_P (NOTE) && (NOTE_KIND (NOTE) \
1056                                                != NOTE_INSN_BASIC_BLOCK))
1057
1058 extern FILE *sched_dump;
1059 extern int sched_verbose;
1060
1061 extern spec_info_t spec_info;
1062 extern bool haifa_recovery_bb_ever_added_p;
1063
1064 /* Exception Free Loads:
1065
1066    We define five classes of speculative loads: IFREE, IRISKY,
1067    PFREE, PRISKY, and MFREE.
1068
1069    IFREE loads are loads that are proved to be exception-free, just
1070    by examining the load insn.  Examples for such loads are loads
1071    from TOC and loads of global data.
1072
1073    IRISKY loads are loads that are proved to be exception-risky,
1074    just by examining the load insn.  Examples for such loads are
1075    volatile loads and loads from shared memory.
1076
1077    PFREE loads are loads for which we can prove, by examining other
1078    insns, that they are exception-free.  Currently, this class consists
1079    of loads for which we are able to find a "similar load", either in
1080    the target block, or, if only one split-block exists, in that split
1081    block.  Load2 is similar to load1 if both have same single base
1082    register.  We identify only part of the similar loads, by finding
1083    an insn upon which both load1 and load2 have a DEF-USE dependence.
1084
1085    PRISKY loads are loads for which we can prove, by examining other
1086    insns, that they are exception-risky.  Currently we have two proofs for
1087    such loads.  The first proof detects loads that are probably guarded by a
1088    test on the memory address.  This proof is based on the
1089    backward and forward data dependence information for the region.
1090    Let load-insn be the examined load.
1091    Load-insn is PRISKY iff ALL the following hold:
1092
1093    - insn1 is not in the same block as load-insn
1094    - there is a DEF-USE dependence chain (insn1, ..., load-insn)
1095    - test-insn is either a compare or a branch, not in the same block
1096      as load-insn
1097    - load-insn is reachable from test-insn
1098    - there is a DEF-USE dependence chain (insn1, ..., test-insn)
1099
1100    This proof might fail when the compare and the load are fed
1101    by an insn not in the region.  To solve this, we will add to this
1102    group all loads that have no input DEF-USE dependence.
1103
1104    The second proof detects loads that are directly or indirectly
1105    fed by a speculative load.  This proof is affected by the
1106    scheduling process.  We will use the flag  fed_by_spec_load.
1107    Initially, all insns have this flag reset.  After a speculative
1108    motion of an insn, if insn is either a load, or marked as
1109    fed_by_spec_load, we will also mark as fed_by_spec_load every
1110    insn1 for which a DEF-USE dependence (insn, insn1) exists.  A
1111    load which is fed_by_spec_load is also PRISKY.
1112
1113    MFREE (maybe-free) loads are all the remaining loads. They may be
1114    exception-free, but we cannot prove it.
1115
1116    Now, all loads in IFREE and PFREE classes are considered
1117    exception-free, while all loads in IRISKY and PRISKY classes are
1118    considered exception-risky.  As for loads in the MFREE class,
1119    these are considered either exception-free or exception-risky,
1120    depending on whether we are pessimistic or optimistic.  We have
1121    to take the pessimistic approach to assure the safety of
1122    speculative scheduling, but we can take the optimistic approach
1123    by invoking the -fsched_spec_load_dangerous option.  */
1124
1125 enum INSN_TRAP_CLASS
1126 {
1127   TRAP_FREE = 0, IFREE = 1, PFREE_CANDIDATE = 2,
1128   PRISKY_CANDIDATE = 3, IRISKY = 4, TRAP_RISKY = 5
1129 };
1130
1131 #define WORST_CLASS(class1, class2) \
1132 ((class1 > class2) ? class1 : class2)
1133
1134 #ifndef __GNUC__
1135 #define __inline
1136 #endif
1137
1138 #ifndef HAIFA_INLINE
1139 #define HAIFA_INLINE __inline
1140 #endif
1141
1142 struct sched_deps_info_def
1143 {
1144   /* Called when computing dependencies for a JUMP_INSN.  This function
1145      should store the set of registers that must be considered as set by
1146      the jump in the regset.  */
1147   void (*compute_jump_reg_dependencies) (rtx, regset);
1148
1149   /* Start analyzing insn.  */
1150   void (*start_insn) (rtx);
1151
1152   /* Finish analyzing insn.  */
1153   void (*finish_insn) (void);
1154
1155   /* Start analyzing insn LHS (Left Hand Side).  */
1156   void (*start_lhs) (rtx);
1157
1158   /* Finish analyzing insn LHS.  */
1159   void (*finish_lhs) (void);
1160
1161   /* Start analyzing insn RHS (Right Hand Side).  */
1162   void (*start_rhs) (rtx);
1163
1164   /* Finish analyzing insn RHS.  */
1165   void (*finish_rhs) (void);
1166
1167   /* Note set of the register.  */
1168   void (*note_reg_set) (int);
1169
1170   /* Note clobber of the register.  */
1171   void (*note_reg_clobber) (int);
1172
1173   /* Note use of the register.  */
1174   void (*note_reg_use) (int);
1175
1176   /* Note memory dependence of type DS between MEM1 and MEM2 (which is
1177      in the INSN2).  */
1178   void (*note_mem_dep) (rtx mem1, rtx mem2, rtx insn2, ds_t ds);
1179
1180   /* Note a dependence of type DS from the INSN.  */
1181   void (*note_dep) (rtx insn, ds_t ds);
1182
1183   /* Nonzero if we should use cselib for better alias analysis.  This
1184      must be 0 if the dependency information is used after sched_analyze
1185      has completed, e.g. if we're using it to initialize state for successor
1186      blocks in region scheduling.  */
1187   unsigned int use_cselib : 1;
1188
1189   /* If set, generate links between instruction as DEPS_LIST.
1190      Otherwise, generate usual INSN_LIST links.  */
1191   unsigned int use_deps_list : 1;
1192
1193   /* Generate data and control speculative dependencies.
1194      Requires USE_DEPS_LIST set.  */
1195   unsigned int generate_spec_deps : 1;
1196 };
1197
1198 extern struct sched_deps_info_def *sched_deps_info;
1199
1200
1201 /* Functions in sched-deps.c.  */
1202 extern bool sched_insns_conditions_mutex_p (const_rtx, const_rtx);
1203 extern bool sched_insn_is_legitimate_for_speculation_p (const_rtx, ds_t);
1204 extern void add_dependence (rtx, rtx, enum reg_note);
1205 extern void sched_analyze (struct deps_desc *, rtx, rtx);
1206 extern void init_deps (struct deps_desc *, bool);
1207 extern void init_deps_reg_last (struct deps_desc *);
1208 extern void free_deps (struct deps_desc *);
1209 extern void init_deps_global (void);
1210 extern void finish_deps_global (void);
1211 extern void deps_analyze_insn (struct deps_desc *, rtx);
1212 extern void remove_from_deps (struct deps_desc *, rtx);
1213 extern void init_insn_reg_pressure_info (rtx);
1214
1215 extern dw_t get_dep_weak_1 (ds_t, ds_t);
1216 extern dw_t get_dep_weak (ds_t, ds_t);
1217 extern ds_t set_dep_weak (ds_t, ds_t, dw_t);
1218 extern dw_t estimate_dep_weak (rtx, rtx);
1219 extern ds_t ds_merge (ds_t, ds_t);
1220 extern ds_t ds_full_merge (ds_t, ds_t, rtx, rtx);
1221 extern ds_t ds_max_merge (ds_t, ds_t);
1222 extern dw_t ds_weak (ds_t);
1223 extern ds_t ds_get_speculation_types (ds_t);
1224 extern ds_t ds_get_max_dep_weak (ds_t);
1225
1226 extern void sched_deps_init (bool);
1227 extern void sched_deps_finish (void);
1228
1229 extern void haifa_note_reg_set (int);
1230 extern void haifa_note_reg_clobber (int);
1231 extern void haifa_note_reg_use (int);
1232
1233 extern void maybe_extend_reg_info_p (void);
1234
1235 extern void deps_start_bb (struct deps_desc *, rtx);
1236 extern enum reg_note ds_to_dt (ds_t);
1237
1238 extern bool deps_pools_are_empty_p (void);
1239 extern void sched_free_deps (rtx, rtx, bool);
1240 extern void extend_dependency_caches (int, bool);
1241
1242 extern void debug_ds (ds_t);
1243
1244
1245 /* Functions in haifa-sched.c.  */
1246 extern void sched_init_region_reg_pressure_info (void);
1247 extern int haifa_classify_insn (const_rtx);
1248 extern void get_ebb_head_tail (basic_block, basic_block, rtx *, rtx *);
1249 extern int no_real_insns_p (const_rtx, const_rtx);
1250
1251 extern int insn_cost (rtx);
1252 extern int dep_cost_1 (dep_t, dw_t);
1253 extern int dep_cost (dep_t);
1254 extern int set_priorities (rtx, rtx);
1255
1256 extern void sched_setup_bb_reg_pressure_info (basic_block, rtx);
1257 extern void schedule_block (basic_block *);
1258
1259 extern int cycle_issued_insns;
1260 extern int issue_rate;
1261 extern int dfa_lookahead;
1262
1263 extern void ready_sort (struct ready_list *);
1264 extern rtx ready_element (struct ready_list *, int);
1265 extern rtx *ready_lastpos (struct ready_list *);
1266
1267 extern int try_ready (rtx);
1268 extern void sched_extend_ready_list (int);
1269 extern void sched_finish_ready_list (void);
1270 extern void sched_change_pattern (rtx, rtx);
1271 extern int sched_speculate_insn (rtx, ds_t, rtx *);
1272 extern void unlink_bb_notes (basic_block, basic_block);
1273 extern void add_block (basic_block, basic_block);
1274 extern rtx bb_note (basic_block);
1275 extern void concat_note_lists (rtx, rtx *);
1276 extern rtx sched_emit_insn (rtx);
1277 extern rtx get_ready_element (int);
1278 extern int number_in_ready (void);
1279 \f
1280
1281 /* Types and functions in sched-rgn.c.  */
1282
1283 /* A region is the main entity for interblock scheduling: insns
1284    are allowed to move between blocks in the same region, along
1285    control flow graph edges, in the 'up' direction.  */
1286 typedef struct
1287 {
1288   /* Number of extended basic blocks in region.  */
1289   int rgn_nr_blocks;
1290   /* cblocks in the region (actually index in rgn_bb_table).  */
1291   int rgn_blocks;
1292   /* Dependencies for this region are already computed.  Basically, indicates,
1293      that this is a recovery block.  */
1294   unsigned int dont_calc_deps : 1;
1295   /* This region has at least one non-trivial ebb.  */
1296   unsigned int has_real_ebb : 1;
1297 }
1298 region;
1299
1300 extern int nr_regions;
1301 extern region *rgn_table;
1302 extern int *rgn_bb_table;
1303 extern int *block_to_bb;
1304 extern int *containing_rgn;
1305
1306 /* Often used short-hand in the scheduler.  The rest of the compiler uses
1307    BLOCK_FOR_INSN(INSN) and an indirect reference to get the basic block
1308    number ("index").  For historical reasons, the scheduler does not.  */
1309 #define BLOCK_NUM(INSN)       (BLOCK_FOR_INSN (INSN)->index + 0)
1310
1311 #define RGN_NR_BLOCKS(rgn) (rgn_table[rgn].rgn_nr_blocks)
1312 #define RGN_BLOCKS(rgn) (rgn_table[rgn].rgn_blocks)
1313 #define RGN_DONT_CALC_DEPS(rgn) (rgn_table[rgn].dont_calc_deps)
1314 #define RGN_HAS_REAL_EBB(rgn) (rgn_table[rgn].has_real_ebb)
1315 #define BLOCK_TO_BB(block) (block_to_bb[block])
1316 #define CONTAINING_RGN(block) (containing_rgn[block])
1317
1318 /* The mapping from ebb to block.  */
1319 extern int *ebb_head;
1320 #define BB_TO_BLOCK(ebb) (rgn_bb_table[ebb_head[ebb]])
1321 #define EBB_FIRST_BB(ebb) BASIC_BLOCK (BB_TO_BLOCK (ebb))
1322 #define EBB_LAST_BB(ebb) BASIC_BLOCK (rgn_bb_table[ebb_head[ebb + 1] - 1])
1323 #define INSN_BB(INSN) (BLOCK_TO_BB (BLOCK_NUM (INSN)))
1324
1325 extern int current_nr_blocks;
1326 extern int current_blocks;
1327 extern int target_bb;
1328 extern bool sched_no_dce;
1329
1330 extern void record_delay_slot_pair (rtx, rtx, int);
1331 extern void free_delay_pairs (void);
1332 extern void add_delay_dependencies (rtx);
1333 extern bool sched_is_disabled_for_current_region_p (void);
1334 extern void sched_rgn_init (bool);
1335 extern void sched_rgn_finish (void);
1336 extern void rgn_setup_region (int);
1337 extern void sched_rgn_compute_dependencies (int);
1338 extern void sched_rgn_local_init (int);
1339 extern void sched_rgn_local_finish (void);
1340 extern void sched_rgn_local_free (void);
1341 extern void extend_regions (void);
1342 extern void rgn_make_new_region_out_of_new_block (basic_block);
1343
1344 extern void compute_priorities (void);
1345 extern void increase_insn_priority (rtx, int);
1346 extern void debug_rgn_dependencies (int);
1347 extern void debug_dependencies (rtx, rtx);
1348 extern void free_rgn_deps (void);
1349 extern int contributes_to_priority (rtx, rtx);
1350 extern void extend_rgns (int *, int *, sbitmap, int *);
1351 extern void deps_join (struct deps_desc *, struct deps_desc *);
1352
1353 extern void rgn_setup_common_sched_info (void);
1354 extern void rgn_setup_sched_infos (void);
1355
1356 extern void debug_regions (void);
1357 extern void debug_region (int);
1358 extern void dump_region_dot (FILE *, int);
1359 extern void dump_region_dot_file (const char *, int);
1360
1361 extern void haifa_sched_init (void);
1362 extern void haifa_sched_finish (void);
1363
1364 /* sched-deps.c interface to walk, add, search, update, resolve, delete
1365    and debug instruction dependencies.  */
1366
1367 /* Constants defining dependences lists.  */
1368
1369 /* No list.  */
1370 #define SD_LIST_NONE (0)
1371
1372 /* hard_back_deps.  */
1373 #define SD_LIST_HARD_BACK (1)
1374
1375 /* spec_back_deps.  */
1376 #define SD_LIST_SPEC_BACK (2)
1377
1378 /* forw_deps.  */
1379 #define SD_LIST_FORW (4)
1380
1381 /* resolved_back_deps.  */
1382 #define SD_LIST_RES_BACK (8)
1383
1384 /* resolved_forw_deps.  */
1385 #define SD_LIST_RES_FORW (16)
1386
1387 #define SD_LIST_BACK (SD_LIST_HARD_BACK | SD_LIST_SPEC_BACK)
1388
1389 /* A type to hold above flags.  */
1390 typedef int sd_list_types_def;
1391
1392 extern void sd_next_list (const_rtx, sd_list_types_def *, deps_list_t *, bool *);
1393
1394 /* Iterator to walk through, resolve and delete dependencies.  */
1395 struct _sd_iterator
1396 {
1397   /* What lists to walk.  Can be any combination of SD_LIST_* flags.  */
1398   sd_list_types_def types;
1399
1400   /* Instruction dependencies lists of which will be walked.  */
1401   rtx insn;
1402
1403   /* Pointer to the next field of the previous element.  This is not
1404      simply a pointer to the next element to allow easy deletion from the
1405      list.  When a dep is being removed from the list the iterator
1406      will automatically advance because the value in *linkp will start
1407      referring to the next element.  */
1408   dep_link_t *linkp;
1409
1410   /* True if the current list is a resolved one.  */
1411   bool resolved_p;
1412 };
1413
1414 typedef struct _sd_iterator sd_iterator_def;
1415
1416 /* ??? We can move some definitions that are used in below inline functions
1417    out of sched-int.h to sched-deps.c provided that the below functions will
1418    become global externals.
1419    These definitions include:
1420    * struct _deps_list: opaque pointer is needed at global scope.
1421    * struct _dep_link: opaque pointer is needed at scope of sd_iterator_def.
1422    * struct _dep_node: opaque pointer is needed at scope of
1423    struct _deps_link.  */
1424
1425 /* Return initialized iterator.  */
1426 static inline sd_iterator_def
1427 sd_iterator_start (rtx insn, sd_list_types_def types)
1428 {
1429   /* Some dep_link a pointer to which will return NULL.  */
1430   static dep_link_t null_link = NULL;
1431
1432   sd_iterator_def i;
1433
1434   i.types = types;
1435   i.insn = insn;
1436   i.linkp = &null_link;
1437
1438   /* Avoid 'uninitialized warning'.  */
1439   i.resolved_p = false;
1440
1441   return i;
1442 }
1443
1444 /* Return the current element.  */
1445 static inline bool
1446 sd_iterator_cond (sd_iterator_def *it_ptr, dep_t *dep_ptr)
1447 {
1448   dep_link_t link = *it_ptr->linkp;
1449
1450   if (link != NULL)
1451     {
1452       *dep_ptr = DEP_LINK_DEP (link);
1453       return true;
1454     }
1455   else
1456     {
1457       sd_list_types_def types = it_ptr->types;
1458
1459       if (types != SD_LIST_NONE)
1460         /* Switch to next list.  */
1461         {
1462           deps_list_t list;
1463
1464           sd_next_list (it_ptr->insn,
1465                         &it_ptr->types, &list, &it_ptr->resolved_p);
1466
1467           it_ptr->linkp = &DEPS_LIST_FIRST (list);
1468
1469           if (list)
1470             return sd_iterator_cond (it_ptr, dep_ptr);
1471         }
1472
1473       *dep_ptr = NULL;
1474       return false;
1475     }
1476 }
1477
1478 /* Advance iterator.  */
1479 static inline void
1480 sd_iterator_next (sd_iterator_def *it_ptr)
1481 {
1482   it_ptr->linkp = &DEP_LINK_NEXT (*it_ptr->linkp);
1483 }
1484
1485 /* A cycle wrapper.  */
1486 #define FOR_EACH_DEP(INSN, LIST_TYPES, ITER, DEP)               \
1487   for ((ITER) = sd_iterator_start ((INSN), (LIST_TYPES));       \
1488        sd_iterator_cond (&(ITER), &(DEP));                      \
1489        sd_iterator_next (&(ITER)))
1490
1491 #define IS_DISPATCH_ON 1
1492 #define IS_CMP 2
1493 #define DISPATCH_VIOLATION 3
1494 #define FITS_DISPATCH_WINDOW 4
1495 #define DISPATCH_INIT 5
1496 #define ADD_TO_DISPATCH_WINDOW 6
1497
1498 extern int sd_lists_size (const_rtx, sd_list_types_def);
1499 extern bool sd_lists_empty_p (const_rtx, sd_list_types_def);
1500 extern void sd_init_insn (rtx);
1501 extern void sd_finish_insn (rtx);
1502 extern dep_t sd_find_dep_between (rtx, rtx, bool);
1503 extern void sd_add_dep (dep_t, bool);
1504 extern enum DEPS_ADJUST_RESULT sd_add_or_update_dep (dep_t, bool);
1505 extern void sd_resolve_dep (sd_iterator_def);
1506 extern void sd_unresolve_dep (sd_iterator_def);
1507 extern void sd_copy_back_deps (rtx, rtx, bool);
1508 extern void sd_delete_dep (sd_iterator_def);
1509 extern void sd_debug_lists (rtx, sd_list_types_def);
1510
1511 #endif /* INSN_SCHEDULING */
1512
1513 /* Functions in sched-vis.c.  These must be outside INSN_SCHEDULING as
1514    sched-vis.c is compiled always.  */
1515 extern void print_insn (char *, const_rtx, int);
1516 extern void print_pattern (char *, const_rtx, int);
1517 extern void print_value (char *, const_rtx, int);
1518
1519 #endif /* GCC_SCHED_INT_H */