include/llvm/CodeGen/ScheduleHazardRecognizer.h

   1 //=- llvm/CodeGen/ScheduleHazardRecognizer.h - Scheduling Support -*- C++ -*-=//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the ScheduleHazardRecognizer class, which implements
  11 // hazard-avoidance heuristics for scheduling.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CODEGEN_SCHEDULEHAZARDRECOGNIZER_H
  16 #define LLVM_CODEGEN_SCHEDULEHAZARDRECOGNIZER_H
  17
  18 namespace llvm {
  19
  20 class SUnit;
  21
  22 /// HazardRecognizer - This determines whether or not an instruction can be
  23 /// issued this cycle, and whether or not a noop needs to be inserted to handle
  24 /// the hazard.
  25 class ScheduleHazardRecognizer {
  26 protected:
  27   /// MaxLookAhead - Indicate the number of cycles in the scoreboard
  28   /// state. Important to restore the state after backtracking. Additionally,
  29   /// MaxLookAhead=0 identifies a fake recognizer, allowing the client to
  30   /// bypass virtual calls. Currently the PostRA scheduler ignores it.
  31   unsigned MaxLookAhead;
  32
  33 public:
  34   ScheduleHazardRecognizer(): MaxLookAhead(0) {}
  35   virtual ~ScheduleHazardRecognizer();
  36
  37   enum HazardType {
  38     NoHazard,      // This instruction can be emitted at this cycle.
  39     Hazard,        // This instruction can't be emitted at this cycle.
  40     NoopHazard     // This instruction can't be emitted, and needs noops.
  41   };
  42
  43   unsigned getMaxLookAhead() const { return MaxLookAhead; }
  44
  45   /// atIssueLimit - Return true if no more instructions may be issued in this
  46   /// cycle.
  47   virtual bool atIssueLimit() const { return false; }
  48
  49   /// getHazardType - Return the hazard type of emitting this node.  There are
  50   /// three possible results.  Either:
  51   ///  * NoHazard: it is legal to issue this instruction on this cycle.
  52   ///  * Hazard: issuing this instruction would stall the machine.  If some
  53   ///     other instruction is available, issue it first.
  54   ///  * NoopHazard: issuing this instruction would break the program.  If
  55   ///     some other instruction can be issued, do so, otherwise issue a noop.
  56   virtual HazardType getHazardType(SUnit *m, int Stalls) {
  57     return NoHazard;
  58   }
  59
  60   /// Reset - This callback is invoked when a new block of
  61   /// instructions is about to be schedule. The hazard state should be
  62   /// set to an initialized state.
  63   virtual void Reset() {}
  64
  65   /// EmitInstruction - This callback is invoked when an instruction is
  66   /// emitted, to advance the hazard state.
  67   virtual void EmitInstruction(SUnit *) {}
  68
  69   /// AdvanceCycle - This callback is invoked whenever the next top-down
  70   /// instruction to be scheduled cannot issue in the current cycle, either
  71   /// because of latency or resource conflicts.  This should increment the
  72   /// internal state of the hazard recognizer so that previously "Hazard"
  73   /// instructions will now not be hazards.
  74   virtual void AdvanceCycle() {}
  75
  76   /// RecedeCycle - This callback is invoked whenever the next bottom-up
  77   /// instruction to be scheduled cannot issue in the current cycle, either
  78   /// because of latency or resource conflicts.
  79   virtual void RecedeCycle() {}
  80
  81   /// EmitNoop - This callback is invoked when a noop was added to the
  82   /// instruction stream.
  83   virtual void EmitNoop() {
  84     // Default implementation: count it as a cycle.
  85     AdvanceCycle();
  86   }
  87 };
  88
  89 }
  90
  91 #endif