[#llvm-MCSchedClassDesc]
= xref:llvm.adoc[llvm]::MCSchedClassDesc
:relfileprefix: ../
:mrdocs:

Summarize the scheduling resources required for an instruction of a particular scheduling class.

== Synopsis

Declared in `<llvm/MC/MCSchedule.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct MCSchedClassDesc;
----

== Description

Defined as an aggregate struct for creating tables with initializer lists.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MCSchedClassDesc/isValid.adoc[`isValid`] 
| Return true if this scheduling class descriptor is valid.
| xref:llvm/MCSchedClassDesc/isVariant.adoc[`isVariant`] 
| Return true if this scheduling class is variant and must be resolved.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MCSchedClassDesc/BeginGroup.adoc[`BeginGroup`] 
| True if this instruction begins an issue group.
| xref:llvm/MCSchedClassDesc/EndGroup.adoc[`EndGroup`] 
| True if this instruction ends an issue group.
| xref:llvm/MCSchedClassDesc/NameOff.adoc[`NameOff`] 
| Offset into the sched‐class name string table.
| xref:llvm/MCSchedClassDesc/NumMicroOps.adoc[`NumMicroOps`] 
| Number of micro‐ops required by this scheduling class.
| xref:llvm/MCSchedClassDesc/NumReadAdvanceEntries.adoc[`NumReadAdvanceEntries`] 
| Number of read‐advance table entries for this class.
| xref:llvm/MCSchedClassDesc/NumWriteLatencyEntries.adoc[`NumWriteLatencyEntries`] 
| Number of write‐latency table entries for this class.
| xref:llvm/MCSchedClassDesc/NumWriteProcResEntries.adoc[`NumWriteProcResEntries`] 
| Number of write‐proc‐res table entries for this class.
| xref:llvm/MCSchedClassDesc/ReadAdvanceIdx.adoc[`ReadAdvanceIdx`] 
| First index into ReadAdvanceTable.
| xref:llvm/MCSchedClassDesc/RetireOOO.adoc[`RetireOOO`] 
| True if this instruction may retire out of order.
| xref:llvm/MCSchedClassDesc/WriteLatencyIdx.adoc[`WriteLatencyIdx`] 
| First index into WriteLatencyTable.
| xref:llvm/MCSchedClassDesc/WriteProcResIdx.adoc[`WriteProcResIdx`] 
| First index into WriteProcResTable.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/MCSchedClassDesc/InvalidNumMicroOps.adoc[`InvalidNumMicroOps`] 
| Sentinel NumMicroOps value marking an invalid scheduling class.
| xref:llvm/MCSchedClassDesc/VariantNumMicroOps.adoc[`VariantNumMicroOps`] 
| Sentinel NumMicroOps value marking a variant scheduling class.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#