Home | History | Annotate | Line # | Download | only in ProfileData 
      1 //===- InstrProfWriter.h - Instrumented profiling writer --------*- C++ -*-===//
      2 //
      3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
      4 // See https://llvm.org/LICENSE.txt for license information.
      5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
      6 //
      7 //===----------------------------------------------------------------------===//
      8 //
      9 // This file contains support for writing profiling data for instrumentation
     10 // based PGO and coverage.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LLVM_PROFILEDATA_INSTRPROFWRITER_H
     15 #define LLVM_PROFILEDATA_INSTRPROFWRITER_H
     16 
     17 #include "llvm/ADT/DenseMap.h"
     18 #include "llvm/ADT/StringMap.h"
     19 #include "llvm/ProfileData/InstrProf.h"
     20 #include "llvm/Support/Endian.h"
     21 #include "llvm/Support/Error.h"
     22 #include "llvm/Support/MemoryBuffer.h"
     23 #include <cstdint>
     24 #include <memory>
     25 
     26 namespace llvm {
     27 
     28 /// Writer for instrumentation based profile data.
     29 class InstrProfRecordWriterTrait;
     30 class ProfOStream;
     31 class raw_fd_ostream;
     32 
     33 class InstrProfWriter {
     34 public:
     35   using ProfilingData = SmallDenseMap<uint64_t, InstrProfRecord>;
     36   // PF_IRLevelWithCS is the profile from context sensitive IR instrumentation.
     37   enum ProfKind { PF_Unknown = 0, PF_FE, PF_IRLevel, PF_IRLevelWithCS };
     38 
     39 private:
     40   bool Sparse;
     41   StringMap<ProfilingData> FunctionData;
     42   ProfKind ProfileKind = PF_Unknown;
     43   bool InstrEntryBBEnabled;
     44   // Use raw pointer here for the incomplete type object.
     45   InstrProfRecordWriterTrait *InfoObj;
     46 
     47 public:
     48   InstrProfWriter(bool Sparse = false, bool InstrEntryBBEnabled = false);
     49   ~InstrProfWriter();
     50 
     51   StringMap<ProfilingData> &getProfileData() { return FunctionData; }
     52 
     53   /// Add function counts for the given function. If there are already counts
     54   /// for this function and the hash and number of counts match, each counter is
     55   /// summed. Optionally scale counts by \p Weight.
     56   void addRecord(NamedInstrProfRecord &&I, uint64_t Weight,
     57                  function_ref<void(Error)> Warn);
     58   void addRecord(NamedInstrProfRecord &&I, function_ref<void(Error)> Warn) {
     59     addRecord(std::move(I), 1, Warn);
     60   }
     61 
     62   /// Merge existing function counts from the given writer.
     63   void mergeRecordsFromWriter(InstrProfWriter &&IPW,
     64                               function_ref<void(Error)> Warn);
     65 
     66   /// Write the profile to \c OS
     67   Error write(raw_fd_ostream &OS);
     68 
     69   /// Write the profile in text format to \c OS
     70   Error writeText(raw_fd_ostream &OS);
     71 
     72   Error validateRecord(const InstrProfRecord &Func);
     73 
     74   /// Write \c Record in text format to \c OS
     75   static void writeRecordInText(StringRef Name, uint64_t Hash,
     76                                 const InstrProfRecord &Counters,
     77                                 InstrProfSymtab &Symtab, raw_fd_ostream &OS);
     78 
     79   /// Write the profile, returning the raw data. For testing.
     80   std::unique_ptr<MemoryBuffer> writeBuffer();
     81 
     82   /// Set the ProfileKind. Report error if mixing FE and IR level profiles.
     83   /// \c WithCS indicates if this is for contenxt sensitive instrumentation.
     84   Error setIsIRLevelProfile(bool IsIRLevel, bool WithCS) {
     85     if (ProfileKind == PF_Unknown) {
     86       if (IsIRLevel)
     87         ProfileKind = WithCS ? PF_IRLevelWithCS : PF_IRLevel;
     88       else
     89         ProfileKind = PF_FE;
     90       return Error::success();
     91     }
     92 
     93     if (((ProfileKind != PF_FE) && !IsIRLevel) ||
     94         ((ProfileKind == PF_FE) && IsIRLevel))
     95       return make_error<InstrProfError>(instrprof_error::unsupported_version);
     96 
     97     // When merging a context-sensitive profile (WithCS == true) with an IRLevel
     98     // profile, set the kind to PF_IRLevelWithCS.
     99     if (ProfileKind == PF_IRLevel && WithCS)
    100       ProfileKind = PF_IRLevelWithCS;
    101 
    102     return Error::success();
    103   }
    104 
    105   void setInstrEntryBBEnabled(bool Enabled) { InstrEntryBBEnabled = Enabled; }
    106   // Internal interface for testing purpose only.
    107   void setValueProfDataEndianness(support::endianness Endianness);
    108   void setOutputSparse(bool Sparse);
    109   // Compute the overlap b/w this object and Other. Program level result is
    110   // stored in Overlap and function level result is stored in FuncLevelOverlap.
    111   void overlapRecord(NamedInstrProfRecord &&Other, OverlapStats &Overlap,
    112                      OverlapStats &FuncLevelOverlap,
    113                      const OverlapFuncFilters &FuncFilter);
    114 
    115 private:
    116   void addRecord(StringRef Name, uint64_t Hash, InstrProfRecord &&I,
    117                  uint64_t Weight, function_ref<void(Error)> Warn);
    118   bool shouldEncodeData(const ProfilingData &PD);
    119 
    120   Error writeImpl(ProfOStream &OS);
    121 };
    122 
    123 } // end namespace llvm
    124 
    125 #endif // LLVM_PROFILEDATA_INSTRPROFWRITER_H
    126