This is an archive of the discontinued LLVM Phabricator instance.

Differential D89564

Provide correct return type and additional description for llvm.test.set.loop.iterations.* in langref
ClosedPublic

Authored by JanekvO on Oct 16 2020, 10:17 AM.

Details

Reviewers
SjoerdMeijer
samparker
Commits
rG03f3ef221b02: [LangRef] Correct return type llvm.test.set.loop.iterations.*
Summary

The langref description for llvm.test.set.loop.iterations.* seems to be missing the i1 return type.

Diff Detail

Event Timeline

JanekvO created this revision.Oct 16 2020, 10:17 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 16 2020, 10:17 AM
Herald added subscribers: llvm-commits, jdoerfert. · View Herald Transcript
JanekvO requested review of this revision.Oct 16 2020, 10:17 AM
Harbormaster completed remote builds in B75327: Diff 298662.Oct 16 2020, 11:01 AM
samparker accepted this revision.Oct 19 2020, 3:00 AM

Thanks!

llvm/docs/LangRef.rst
15502

Probably better to specify that this is a result of icmp ne %count, 0.

This revision is now accepted and ready to land.Oct 19 2020, 3:00 AM
JanekvO updated this revision to Diff 298999.Oct 19 2020, 4:09 AM

Rebase and change description to more accurately specify the result of the intrinsic.

Harbormaster completed remote builds in B75516: Diff 298999.Oct 19 2020, 4:10 AM
JanekvO marked an inline comment as done.Oct 19 2020, 4:12 AM

Thanks for the review @samparker
Also, I don't have commit access so could anybody else land this as soon as it's good to go?

samparker added a comment.Oct 19 2020, 4:18 AM

Yeah, I'm happy to do that for you.

This revision was landed with ongoing or failed builds.Oct 19 2020, 4:57 AM
Closed by commit rG03f3ef221b02: [LangRef] Correct return type llvm.test.set.loop.iterations.* (authored by samparker). · Explain Why
This revision was automatically updated to reflect the committed changes.
samparker added a commit: rG03f3ef221b02: [LangRef] Correct return type llvm.test.set.loop.iterations.*.

Revision Contents

PathSize
llvm/
docs/
5 lines

Diff 299011

llvm/docs/LangRef.rst

  • This file is larger than 256 KB, so syntax highlighting is disabled by default.
Show First 20 Lines • Show All 15,468 Lines • ▼ Show 20 Lines
Syntax: Syntax:
""""""" """""""
This is an overloaded intrinsic. This is an overloaded intrinsic.
:: ::
declare void @llvm.test.set.loop.iterations.i32(i32) declare i1 @llvm.test.set.loop.iterations.i32(i32)
declare void @llvm.test.set.loop.iterations.i64(i64) declare i1 @llvm.test.set.loop.iterations.i64(i64)
Overview: Overview:
""""""""" """""""""
The '``llvm.test.set.loop.iterations.*``' intrinsics are used to specify the The '``llvm.test.set.loop.iterations.*``' intrinsics are used to specify the
the loop trip count, and also test that the given count is not zero, allowing the loop trip count, and also test that the given count is not zero, allowing
it to control entry to a while-loop. They are placed in the loop preheader's it to control entry to a while-loop. They are placed in the loop preheader's
predecessor basic block, and are marked as ``IntrNoDuplicate`` to avoid predecessor basic block, and are marked as ``IntrNoDuplicate`` to avoid
optimizers duplicating these instructions. optimizers duplicating these instructions.
Arguments: Arguments:
"""""""""" """"""""""
The integer operand is the loop trip count of the hardware-loop, and thus The integer operand is the loop trip count of the hardware-loop, and thus
not e.g. the loop back-edge taken count. not e.g. the loop back-edge taken count.
Semantics: Semantics:
"""""""""" """"""""""
The '``llvm.test.set.loop.iterations.*``' intrinsics do not perform any The '``llvm.test.set.loop.iterations.*``' intrinsics do not perform any
arithmetic on their operand. It's a hint to the backend that can use this to arithmetic on their operand. It's a hint to the backend that can use this to
set up the hardware-loop count with a target specific instruction, usually a set up the hardware-loop count with a target specific instruction, usually a
move of this value to a special register or a hardware-loop instruction. move of this value to a special register or a hardware-loop instruction.
The result is the conditional value of whether the given count is not zero.
samparkerUnsubmitted
Done
ReplyInline Actions

Probably better to specify that this is a result of icmp ne %count, 0.

samparker: Probably better to specify that this is a result of icmp ne %count, 0.
'``llvm.loop.decrement.reg.*``' Intrinsic '``llvm.loop.decrement.reg.*``' Intrinsic
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Syntax: Syntax:
""""""" """""""
This is an overloaded intrinsic. This is an overloaded intrinsic.
▲ Show 20 Lines • Show All 5,344 Lines • Show Last 20 Lines