LCOV - code coverage report
Current view: top level - lib/IR - ProfileSummary.cpp (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 80 80 100.0 %
Date: 2017-09-14 15:23:50 Functions: 8 8 100.0 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : //=-- Profilesummary.cpp - Profile summary support --------------------------=//
       2             : //
       3             : //                     The LLVM Compiler Infrastructure
       4             : //
       5             : // This file is distributed under the University of Illinois Open Source
       6             : // License. See LICENSE.TXT for details.
       7             : //
       8             : //===----------------------------------------------------------------------===//
       9             : //
      10             : // This file contains support for converting profile summary data from/to
      11             : // metadata.
      12             : //
      13             : //===----------------------------------------------------------------------===//
      14             : 
      15             : #include "llvm/IR/ProfileSummary.h"
      16             : #include "llvm/IR/Attributes.h"
      17             : #include "llvm/IR/Constants.h"
      18             : #include "llvm/IR/Function.h"
      19             : #include "llvm/IR/Metadata.h"
      20             : #include "llvm/IR/Type.h"
      21             : #include "llvm/Support/Casting.h"
      22             : 
      23             : using namespace llvm;
      24             : 
      25             : const char *ProfileSummary::KindStr[2] = {"InstrProf", "SampleProfile"};
      26             : 
      27             : // Return an MDTuple with two elements. The first element is a string Key and
      28             : // the second is a uint64_t Value.
      29         798 : static Metadata *getKeyValMD(LLVMContext &Context, const char *Key,
      30             :                              uint64_t Val) {
      31         798 :   Type *Int64Ty = Type::getInt64Ty(Context);
      32         798 :   Metadata *Ops[2] = {MDString::get(Context, Key),
      33        1596 :                       ConstantAsMetadata::get(ConstantInt::get(Int64Ty, Val))};
      34        1596 :   return MDTuple::get(Context, Ops);
      35             : }
      36             : 
      37             : // Return an MDTuple with two elements. The first element is a string Key and
      38             : // the second is a string Value.
      39         133 : static Metadata *getKeyValMD(LLVMContext &Context, const char *Key,
      40             :                              const char *Val) {
      41         133 :   Metadata *Ops[2] = {MDString::get(Context, Key), MDString::get(Context, Val)};
      42         266 :   return MDTuple::get(Context, Ops);
      43             : }
      44             : 
      45             : // This returns an MDTuple representing the detiled summary. The tuple has two
      46             : // elements: a string "DetailedSummary" and an MDTuple representing the value
      47             : // of the detailed summary. Each element of this tuple is again an MDTuple whose
      48             : // elements are the (Cutoff, MinCount, NumCounts) triplet of the
      49             : // DetailedSummaryEntry.
      50         133 : Metadata *ProfileSummary::getDetailedSummaryMD(LLVMContext &Context) {
      51         266 :   std::vector<Metadata *> Entries;
      52         133 :   Type *Int32Ty = Type::getInt32Ty(Context);
      53         133 :   Type *Int64Ty = Type::getInt64Ty(Context);
      54        2926 :   for (auto &Entry : DetailedSummary) {
      55             :     Metadata *EntryMD[3] = {
      56        4788 :         ConstantAsMetadata::get(ConstantInt::get(Int32Ty, Entry.Cutoff)),
      57        4788 :         ConstantAsMetadata::get(ConstantInt::get(Int64Ty, Entry.MinCount)),
      58        7182 :         ConstantAsMetadata::get(ConstantInt::get(Int32Ty, Entry.NumCounts))};
      59        7182 :     Entries.push_back(MDTuple::get(Context, EntryMD));
      60             :   }
      61         133 :   Metadata *Ops[2] = {MDString::get(Context, "DetailedSummary"),
      62         399 :                       MDTuple::get(Context, Entries)};
      63         399 :   return MDTuple::get(Context, Ops);
      64             : }
      65             : 
      66             : // This returns an MDTuple representing this ProfileSummary object. The first
      67             : // entry of this tuple is another MDTuple of two elements: a string
      68             : // "ProfileFormat" and a string representing the format ("InstrProf" or
      69             : // "SampleProfile"). The rest of the elements of the outer MDTuple are specific
      70             : // to the kind of profile summary as returned by getFormatSpecificMD.
      71         133 : Metadata *ProfileSummary::getMD(LLVMContext &Context) {
      72         266 :   std::vector<Metadata *> Components;
      73         266 :   Components.push_back(getKeyValMD(Context, "ProfileFormat", KindStr[PSK]));
      74             : 
      75         266 :   Components.push_back(getKeyValMD(Context, "TotalCount", getTotalCount()));
      76         266 :   Components.push_back(getKeyValMD(Context, "MaxCount", getMaxCount()));
      77         133 :   Components.push_back(
      78         266 :       getKeyValMD(Context, "MaxInternalCount", getMaxInternalCount()));
      79         133 :   Components.push_back(
      80         266 :       getKeyValMD(Context, "MaxFunctionCount", getMaxFunctionCount()));
      81         266 :   Components.push_back(getKeyValMD(Context, "NumCounts", getNumCounts()));
      82         266 :   Components.push_back(getKeyValMD(Context, "NumFunctions", getNumFunctions()));
      83         266 :   Components.push_back(getDetailedSummaryMD(Context));
      84         399 :   return MDTuple::get(Context, Components);
      85             : }
      86             : 
      87             : // Parse an MDTuple representing (Key, Val) pair.
      88         318 : static bool getVal(MDTuple *MD, const char *Key, uint64_t &Val) {
      89         318 :   if (!MD)
      90             :     return false;
      91         318 :   if (MD->getNumOperands() != 2)
      92             :     return false;
      93         954 :   MDString *KeyMD = dyn_cast<MDString>(MD->getOperand(0));
      94         954 :   ConstantAsMetadata *ValMD = dyn_cast<ConstantAsMetadata>(MD->getOperand(1));
      95         318 :   if (!KeyMD || !ValMD)
      96             :     return false;
      97         636 :   if (!KeyMD->getString().equals(Key))
      98             :     return false;
      99         954 :   Val = cast<ConstantInt>(ValMD->getValue())->getZExtValue();
     100         318 :   return true;
     101             : }
     102             : 
     103             : // Check if an MDTuple represents a (Key, Val) pair.
     104          76 : static bool isKeyValuePair(MDTuple *MD, const char *Key, const char *Val) {
     105          76 :   if (!MD || MD->getNumOperands() != 2)
     106             :     return false;
     107         228 :   MDString *KeyMD = dyn_cast<MDString>(MD->getOperand(0));
     108         228 :   MDString *ValMD = dyn_cast<MDString>(MD->getOperand(1));
     109          76 :   if (!KeyMD || !ValMD)
     110             :     return false;
     111         357 :   if (!KeyMD->getString().equals(Key) || !ValMD->getString().equals(Val))
     112             :     return false;
     113             :   return true;
     114             : }
     115             : 
     116             : // Parse an MDTuple representing detailed summary.
     117          53 : static bool getSummaryFromMD(MDTuple *MD, SummaryEntryVector &Summary) {
     118          53 :   if (!MD || MD->getNumOperands() != 2)
     119             :     return false;
     120         159 :   MDString *KeyMD = dyn_cast<MDString>(MD->getOperand(0));
     121         106 :   if (!KeyMD || !KeyMD->getString().equals("DetailedSummary"))
     122             :     return false;
     123         159 :   MDTuple *EntriesMD = dyn_cast<MDTuple>(MD->getOperand(1));
     124             :   if (!EntriesMD)
     125             :     return false;
     126         715 :   for (auto &&MDOp : EntriesMD->operands()) {
     127         609 :     MDTuple *EntryMD = dyn_cast<MDTuple>(MDOp);
     128         609 :     if (!EntryMD || EntryMD->getNumOperands() != 3)
     129             :       return false;
     130             :     ConstantAsMetadata *Op0 =
     131        1827 :         dyn_cast<ConstantAsMetadata>(EntryMD->getOperand(0));
     132             :     ConstantAsMetadata *Op1 =
     133        1827 :         dyn_cast<ConstantAsMetadata>(EntryMD->getOperand(1));
     134             :     ConstantAsMetadata *Op2 =
     135        1827 :         dyn_cast<ConstantAsMetadata>(EntryMD->getOperand(2));
     136             : 
     137         609 :     if (!Op0 || !Op1 || !Op2)
     138             :       return false;
     139        1827 :     Summary.emplace_back(cast<ConstantInt>(Op0->getValue())->getZExtValue(),
     140        2436 :                          cast<ConstantInt>(Op1->getValue())->getZExtValue(),
     141        2436 :                          cast<ConstantInt>(Op2->getValue())->getZExtValue());
     142             :   }
     143             :   return true;
     144             : }
     145             : 
     146          53 : ProfileSummary *ProfileSummary::getFromMD(Metadata *MD) {
     147          53 :   if (!MD)
     148             :     return nullptr;
     149         106 :   if (!isa<MDTuple>(MD))
     150             :     return nullptr;
     151         106 :   MDTuple *Tuple = cast<MDTuple>(MD);
     152          53 :   if (Tuple->getNumOperands() != 8)
     153             :     return nullptr;
     154             : 
     155         106 :   auto &FormatMD = Tuple->getOperand(0);
     156             :   ProfileSummary::Kind SummaryKind;
     157          53 :   if (isKeyValuePair(dyn_cast_or_null<MDTuple>(FormatMD), "ProfileFormat",
     158             :                      "SampleProfile"))
     159             :     SummaryKind = PSK_Sample;
     160          23 :   else if (isKeyValuePair(dyn_cast_or_null<MDTuple>(FormatMD), "ProfileFormat",
     161             :                           "InstrProf"))
     162             :     SummaryKind = PSK_Instr;
     163             :   else
     164             :     return nullptr;
     165             : 
     166             :   uint64_t NumCounts, TotalCount, NumFunctions, MaxFunctionCount, MaxCount,
     167             :       MaxInternalCount;
     168         159 :   if (!getVal(dyn_cast<MDTuple>(Tuple->getOperand(1)), "TotalCount",
     169             :               TotalCount))
     170             :     return nullptr;
     171         159 :   if (!getVal(dyn_cast<MDTuple>(Tuple->getOperand(2)), "MaxCount", MaxCount))
     172             :     return nullptr;
     173         159 :   if (!getVal(dyn_cast<MDTuple>(Tuple->getOperand(3)), "MaxInternalCount",
     174             :               MaxInternalCount))
     175             :     return nullptr;
     176         159 :   if (!getVal(dyn_cast<MDTuple>(Tuple->getOperand(4)), "MaxFunctionCount",
     177             :               MaxFunctionCount))
     178             :     return nullptr;
     179         159 :   if (!getVal(dyn_cast<MDTuple>(Tuple->getOperand(5)), "NumCounts", NumCounts))
     180             :     return nullptr;
     181         159 :   if (!getVal(dyn_cast<MDTuple>(Tuple->getOperand(6)), "NumFunctions",
     182             :               NumFunctions))
     183             :     return nullptr;
     184             : 
     185          53 :   SummaryEntryVector Summary;
     186         159 :   if (!getSummaryFromMD(dyn_cast<MDTuple>(Tuple->getOperand(7)), Summary))
     187             :     return nullptr;
     188             :   return new ProfileSummary(SummaryKind, Summary, TotalCount, MaxCount,
     189             :                             MaxInternalCount, MaxFunctionCount, NumCounts,
     190         159 :                             NumFunctions);
     191             : }

Generated by: LCOV version 1.13