10b57cec5SDimitry Andric //====--------------- lib/Support/BlockFrequency.cpp -----------*- C++ -*-====// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric // 90b57cec5SDimitry Andric // This file implements Block Frequency class. 100b57cec5SDimitry Andric // 110b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 120b57cec5SDimitry Andric 130b57cec5SDimitry Andric #include "llvm/Support/BlockFrequency.h" 1404eeddc0SDimitry Andric #include "llvm/Support/BranchProbability.h" 155f757f3fSDimitry Andric #include "llvm/Support/MathExtras.h" 16*0fca6ea1SDimitry Andric #include "llvm/Support/ScaledNumber.h" 17*0fca6ea1SDimitry Andric #include "llvm/Support/raw_ostream.h" 180b57cec5SDimitry Andric 190b57cec5SDimitry Andric using namespace llvm; 200b57cec5SDimitry Andric 210b57cec5SDimitry Andric BlockFrequency &BlockFrequency::operator*=(BranchProbability Prob) { 220b57cec5SDimitry Andric Frequency = Prob.scale(Frequency); 230b57cec5SDimitry Andric return *this; 240b57cec5SDimitry Andric } 250b57cec5SDimitry Andric 260b57cec5SDimitry Andric BlockFrequency BlockFrequency::operator*(BranchProbability Prob) const { 270b57cec5SDimitry Andric BlockFrequency Freq(Frequency); 280b57cec5SDimitry Andric Freq *= Prob; 290b57cec5SDimitry Andric return Freq; 300b57cec5SDimitry Andric } 310b57cec5SDimitry Andric 320b57cec5SDimitry Andric BlockFrequency &BlockFrequency::operator/=(BranchProbability Prob) { 330b57cec5SDimitry Andric Frequency = Prob.scaleByInverse(Frequency); 340b57cec5SDimitry Andric return *this; 350b57cec5SDimitry Andric } 360b57cec5SDimitry Andric 370b57cec5SDimitry Andric BlockFrequency BlockFrequency::operator/(BranchProbability Prob) const { 380b57cec5SDimitry Andric BlockFrequency Freq(Frequency); 390b57cec5SDimitry Andric Freq /= Prob; 400b57cec5SDimitry Andric return Freq; 410b57cec5SDimitry Andric } 425f757f3fSDimitry Andric 435f757f3fSDimitry Andric std::optional<BlockFrequency> BlockFrequency::mul(uint64_t Factor) const { 445f757f3fSDimitry Andric bool Overflow; 455f757f3fSDimitry Andric uint64_t ResultFrequency = SaturatingMultiply(Frequency, Factor, &Overflow); 465f757f3fSDimitry Andric if (Overflow) 475f757f3fSDimitry Andric return {}; 485f757f3fSDimitry Andric return BlockFrequency(ResultFrequency); 495f757f3fSDimitry Andric } 50*0fca6ea1SDimitry Andric 51*0fca6ea1SDimitry Andric void llvm::printRelativeBlockFreq(raw_ostream &OS, BlockFrequency EntryFreq, 52*0fca6ea1SDimitry Andric BlockFrequency Freq) { 53*0fca6ea1SDimitry Andric if (Freq == BlockFrequency(0)) { 54*0fca6ea1SDimitry Andric OS << "0"; 55*0fca6ea1SDimitry Andric return; 56*0fca6ea1SDimitry Andric } 57*0fca6ea1SDimitry Andric if (EntryFreq == BlockFrequency(0)) { 58*0fca6ea1SDimitry Andric OS << "<invalid BFI>"; 59*0fca6ea1SDimitry Andric return; 60*0fca6ea1SDimitry Andric } 61*0fca6ea1SDimitry Andric ScaledNumber<uint64_t> Block(Freq.getFrequency(), 0); 62*0fca6ea1SDimitry Andric ScaledNumber<uint64_t> Entry(EntryFreq.getFrequency(), 0); 63*0fca6ea1SDimitry Andric OS << Block / Entry; 64*0fca6ea1SDimitry Andric } 65