Doxygenate comments.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@59753 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dan Gohman 2008-11-20 22:09:52 +00:00
parent 25f1d0310c
commit 33372a18c5

View File

@ -19,60 +19,56 @@
namespace llvm { namespace llvm {
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
// Instruction stage - These values represent a step in the execution of an /// Instruction stage - These values represent a step in the execution of an
// instruction. The latency represents the number of discrete time slots used /// instruction. The latency represents the number of discrete time slots used
// need to complete the stage. Units represent the choice of functional units /// need to complete the stage. Units represent the choice of functional units
// that can be used to complete the stage. Eg. IntUnit1, IntUnit2. /// that can be used to complete the stage. Eg. IntUnit1, IntUnit2.
// ///
struct InstrStage { struct InstrStage {
unsigned Cycles; // Length of stage in machine cycles unsigned Cycles; ///< Length of stage in machine cycles
unsigned Units; // Choice of functional units unsigned Units; ///< Choice of functional units
}; };
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
// Instruction itinerary - An itinerary represents a sequential series of steps /// Instruction itinerary - An itinerary represents a sequential series of steps
// required to complete an instruction. Itineraries are represented as /// required to complete an instruction. Itineraries are represented as
// sequences of instruction stages. /// sequences of instruction stages.
// ///
struct InstrItinerary { struct InstrItinerary {
unsigned First; // Index of first stage in itinerary unsigned First; ///< Index of first stage in itinerary
unsigned Last; // Index of last + 1 stage in itinerary unsigned Last; ///< Index of last + 1 stage in itinerary
}; };
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
// Instruction itinerary Data - Itinerary data supplied by a subtarget to be /// Instruction itinerary Data - Itinerary data supplied by a subtarget to be
// used by a target. /// used by a target.
// ///
struct InstrItineraryData { struct InstrItineraryData {
const InstrStage *Stages; // Array of stages selected const InstrStage *Stages; ///< Array of stages selected
const InstrItinerary *Itineratries; // Array of itineraries selected const InstrItinerary *Itineratries; ///< Array of itineraries selected
// /// Ctors.
// Ctors. ///
//
InstrItineraryData() : Stages(0), Itineratries(0) {} InstrItineraryData() : Stages(0), Itineratries(0) {}
InstrItineraryData(const InstrStage *S, const InstrItinerary *I) InstrItineraryData(const InstrStage *S, const InstrItinerary *I)
: Stages(S), Itineratries(I) {} : Stages(S), Itineratries(I) {}
// /// isEmpty - Returns true if there are no itineraries.
// isEmpty - Returns true if there are no itineraries. ///
//
inline bool isEmpty() const { return Itineratries == 0; } inline bool isEmpty() const { return Itineratries == 0; }
// /// begin - Return the first stage of the itinerary.
// begin - Return the first stage of the itinerary. ///
//
inline const InstrStage *begin(unsigned ItinClassIndx) const { inline const InstrStage *begin(unsigned ItinClassIndx) const {
unsigned StageIdx = Itineratries[ItinClassIndx].First; unsigned StageIdx = Itineratries[ItinClassIndx].First;
return Stages + StageIdx; return Stages + StageIdx;
} }
// /// end - Return the last+1 stage of the itinerary.
// end - Return the last+1 stage of the itinerary. ///
//
inline const InstrStage *end(unsigned ItinClassIndx) const { inline const InstrStage *end(unsigned ItinClassIndx) const {
unsigned StageIdx = Itineratries[ItinClassIndx].Last; unsigned StageIdx = Itineratries[ItinClassIndx].Last;
return Stages + StageIdx; return Stages + StageIdx;