add a comment explicitly calling out that allocation orders may include

reserved regs and that register allocators need to explicitly check for
them.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@113593 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Jim Grosbach 2010-09-10 17:51:34 +00:00
parent 81781ed939
commit cc38399ea9

View File

@ -227,9 +227,12 @@ public:
/// cheaper to allocate caller saved registers.
///
/// These methods take a MachineFunction argument, which can be used to tune
/// the allocatable registers based on the characteristics of the function.
/// One simple example is that the frame pointer register can be used if
/// frame-pointer-elimination is performed.
/// the allocatable registers based on the characteristics of the function,
/// subtarget, or other criteria.
///
/// Register allocators should account for the fact that an allocation
/// order iterator may return a reserved register and always check
/// if the register is allocatable (getAllocatableSet()) before using it.
///
/// By default, these methods return all registers in the class.
///