Skip to content

Commit 84f73df

Browse files
committed
[NFC] add explanation to register flags doc
Pull Request: llvm#91803
1 parent d484c4d commit 84f73df

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

llvm/docs/MIRLangRef.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -545,36 +545,47 @@ corresponding internal ``llvm::RegState`` representation:
545545

546546
* - Flag
547547
- Internal Value
548+
- Meaning
548549

549550
* - ``implicit``
550551
- ``RegState::Implicit``
552+
- Not emitted register (e.g. carry, or temporary result).
551553

552554
* - ``implicit-def``
553555
- ``RegState::ImplicitDefine``
556+
- ``implicit`` and ``def``
554557

555558
* - ``def``
556559
- ``RegState::Define``
560+
- Register definition.
557561

558562
* - ``dead``
559563
- ``RegState::Dead``
564+
- Unused definition.
560565

561566
* - ``killed``
562567
- ``RegState::Kill``
568+
- The last use of a register.
563569

564570
* - ``undef``
565571
- ``RegState::Undef``
572+
- Value of the register doesn't matter.
566573

567574
* - ``internal``
568575
- ``RegState::InternalRead``
576+
- Register reads a value that is defined inside the same instruction or bundle.
569577

570578
* - ``early-clobber``
571579
- ``RegState::EarlyClobber``
580+
- Register definition happens before uses.
572581

573582
* - ``debug-use``
574583
- ``RegState::Debug``
584+
- Register 'use' is for debugging purpose.
575585

576586
* - ``renamable``
577587
- ``RegState::Renamable``
588+
- Register that may be renamed.
578589

579590
.. _subregister-indices:
580591

0 commit comments

Comments
 (0)