include/llvm/Target/TargetInstrItineraries.h

   1 //===-- llvm/Target/TargetInstrItineraries.h - Scheduling -------*- 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 describes the structures used for instruction itineraries and
  11 // states.  This is used by schedulers to determine instruction states and
  12 // latencies.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_TARGET_TARGETINSTRITINERARIES_H
  17 #define LLVM_TARGET_TARGETINSTRITINERARIES_H
  18
  19 namespace llvm {
  20
  21 //===----------------------------------------------------------------------===//
  22 // Instruction stage - These values represent a step in the execution of an
  23 // instruction.  The latency represents the number of discrete time slots used
  24 // need to complete the stage.  Units represent the choice of functional units
  25 // that can be used to complete the stage.  Eg. IntUnit1, IntUnit2.
  26 //
  27 struct InstrStage {
  28   unsigned Cycles;  // Length of stage in machine cycles
  29   unsigned Units;   // Choice of functional units
  30 };
  31
  32
  33 //===----------------------------------------------------------------------===//
  34 // Instruction itinerary - An itinerary represents a sequential series of steps
  35 // required to complete an instruction.  Itineraries are represented as
  36 // sequences of instruction stages.
  37 //
  38 struct InstrItinerary {
  39   unsigned First;    // Index of first stage in itinerary
  40   unsigned Last;     // Index of last + 1 stage in itinerary
  41 };
  42
  43
  44
  45 //===----------------------------------------------------------------------===//
  46 // Instruction itinerary Data - Itinerary data supplied by a subtarget to be
  47 // used by a target.
  48 //
  49 struct InstrItineraryData {
  50   const InstrStage     *Stages;         // Array of stages selected
  51   const InstrItinerary *Itineratries;   // Array of itineraries selected
  52
  53 //
  54 // Ctors.
  55 //
  56   InstrItineraryData() : Stages(0), Itineratries(0) {}
  57   InstrItineraryData(const InstrStage *S, const InstrItinerary *I)
  58     : Stages(S), Itineratries(I) {}
  59
  60   //
  61   // isEmpty - Returns true if there are no itineraries.
  62   //
  63   inline bool isEmpty() const { return Itineratries == 0; }
  64
  65   //
  66   // begin - Return the first stage of the itinerary.
  67   //
  68   inline const InstrStage *begin(unsigned ItinClassIndx) const {
  69     unsigned StageIdx = Itineratries[ItinClassIndx].First;
  70     return Stages + StageIdx;
  71   }
  72
  73   //
  74   // end - Return the last+1 stage of the itinerary.
  75   //
  76   inline const InstrStage *end(unsigned ItinClassIndx) const {
  77     unsigned StageIdx = Itineratries[ItinClassIndx].Last;
  78     return Stages + StageIdx;
  79   }
  80 };
  81
  82
  83 } // End llvm namespace
  84
  85 #endif