include/llvm/Target/TargetSchedule.td

   1 //===- TargetSchedule.td - Target Independent Scheduling ---*- tablegen -*-===//
   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 defines the target-independent scheduling interfaces which should
  11 // be implemented by each target which is using TableGen based scheduling.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 //===----------------------------------------------------------------------===//
  16 // Processor functional unit - These values represent the function units
  17 // available across all chip sets for the target.  Eg., IntUnit, FPUnit, ...
  18 // These may be independent values for each chip set or may be shared across
  19 // all chip sets of the target.  Each functional unit is treated as a resource
  20 // during scheduling and has an affect instruction order based on availability
  21 // during a time interval.
  22 //
  23 class FuncUnit;
  24
  25 class ReservationKind<bits<1> val> {
  26   int Value = val;
  27 }
  28
  29 def Required : ReservationKind<0>;
  30 def Reserved : ReservationKind<1>;
  31
  32 //===----------------------------------------------------------------------===//
  33 // Instruction stage - These values represent a non-pipelined step in
  34 // the execution of an instruction.  Cycles represents the number of
  35 // discrete time slots needed to complete the stage.  Units represent
  36 // the choice of functional units that can be used to complete the
  37 // stage.  Eg. IntUnit1, IntUnit2. NextCycles indicates how many
  38 // cycles should elapse from the start of this stage to the start of
  39 // the next stage in the itinerary.  For example:
  40 //
  41 // A stage is specified in one of two ways:
  42 //
  43 //   InstrStage<1, [FU_x, FU_y]>     - TimeInc defaults to Cycles
  44 //   InstrStage<1, [FU_x, FU_y], 0>  - TimeInc explicit
  45 //
  46
  47 class InstrStage<int cycles, list<FuncUnit> units,
  48                  int timeinc = -1,
  49                  ReservationKind kind = Required> {
  50   int Cycles          = cycles;       // length of stage in machine cycles
  51   list<FuncUnit> Units = units;       // choice of functional units
  52   int TimeInc         = timeinc;      // cycles till start of next stage
  53   int Kind            = kind.Value;   // kind of FU reservation
  54 }
  55
  56 //===----------------------------------------------------------------------===//
  57 // Instruction itinerary - An itinerary represents a sequential series of steps
  58 // required to complete an instruction.  Itineraries are represented as lists of
  59 // instruction stages.
  60 //
  61
  62 //===----------------------------------------------------------------------===//
  63 // Instruction itinerary classes - These values represent 'named' instruction
  64 // itinerary.  Using named itineraries simplifies managing groups of
  65 // instructions across chip sets.  An instruction uses the same itinerary class
  66 // across all chip sets.  Thus a new chip set can be added without modifying
  67 // instruction information.
  68 //
  69 // NumMicroOps represents the number of micro-operations that each instruction
  70 // in the class are decoded to. If the number is zero, then it means the
  71 // instruction can decode into variable number of micro-ops and it must be
  72 // determined dynamically.
  73 //
  74 class InstrItinClass<int ops = 1> {
  75   int NumMicroOps = ops;
  76 }
  77 def NoItinerary : InstrItinClass;
  78
  79 //===----------------------------------------------------------------------===//
  80 // Instruction itinerary data - These values provide a runtime map of an
  81 // instruction itinerary class (name) to its itinerary data.
  82 //
  83 class InstrItinData<InstrItinClass Class, list<InstrStage> stages,
  84                     list<int> operandcycles = []> {
  85   InstrItinClass TheClass = Class;
  86   list<InstrStage> Stages = stages;
  87   list<int> OperandCycles = operandcycles;
  88 }
  89
  90 //===----------------------------------------------------------------------===//
  91 // Processor itineraries - These values represent the set of all itinerary
  92 // classes for a given chip set.
  93 //
  94 class ProcessorItineraries<list<FuncUnit> fu, list<InstrItinData> iid> {
  95   list<FuncUnit> FU = fu;
  96   list<InstrItinData> IID = iid;
  97 }
  98
  99 // NoItineraries - A marker that can be used by processors without schedule
 100 // info.
 101 def NoItineraries : ProcessorItineraries<[], []>;
 102