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