diff options
Diffstat (limited to 'docs/BranchWeightMetadata.rst')
| -rw-r--r-- | docs/BranchWeightMetadata.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/BranchWeightMetadata.rst b/docs/BranchWeightMetadata.rst index 71ecd34..aff7923 100644 --- a/docs/BranchWeightMetadata.rst +++ b/docs/BranchWeightMetadata.rst @@ -8,10 +8,11 @@ LLVM Branch Weight Metadata Introduction ============ -Branch Weight Metadata represents branch weights as its likeliness to be -taken. Metadata is assigned to the ``TerminatorInst`` as a ``MDNode`` of the -``MD_prof`` kind. The first operator is always a ``MDString`` node with the -string "branch_weights". Number of operators depends on the terminator type. +Branch Weight Metadata represents branch weights as its likeliness to be taken +(see :doc:`BlockFrequencyTerminology`). Metadata is assigned to the +``TerminatorInst`` as a ``MDNode`` of the ``MD_prof`` kind. The first operator +is always a ``MDString`` node with the string "branch_weights". Number of +operators depends on the terminator type. Branch weights might be fetch from the profiling file, or generated based on `__builtin_expect`_ instruction. |