Re-apply "InstrProf: Add unit tests for the profile reader and writer"
[oota-llvm.git] / include / llvm / ProfileData / InstrProfWriter.h
1 //=-- InstrProfWriter.h - Instrumented profiling writer -----------*- C++ -*-=//
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 writing profiling data for instrumentation
11 // based PGO and coverage.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_PROFILEDATA_INSTRPROFWRITER_H
16 #define LLVM_PROFILEDATA_INSTRPROFWRITER_H
17
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/ProfileData/InstrProf.h"
22 #include "llvm/Support/DataTypes.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include <vector>
25
26 namespace llvm {
27
28 /// Writer for instrumentation based profile data.
29 class InstrProfWriter {
30 public:
31   typedef SmallDenseMap<uint64_t, std::vector<uint64_t>, 1> CounterData;
32 private:
33   StringMap<CounterData> FunctionData;
34   uint64_t MaxFunctionCount;
35 public:
36   InstrProfWriter() : MaxFunctionCount(0) {}
37
38   /// Add function counts for the given function. If there are already counts
39   /// for this function and the hash and number of counts match, each counter is
40   /// summed.
41   std::error_code addFunctionCounts(StringRef FunctionName,
42                                     uint64_t FunctionHash,
43                                     ArrayRef<uint64_t> Counters);
44   /// Write the profile to \c OS
45   void write(raw_fd_ostream &OS);
46   /// Write the profile, returning the raw data. For testing.
47   std::string writeString();
48 private:
49   std::pair<uint64_t, uint64_t> writeImpl(raw_ostream &OS);
50 };
51
52 } // end namespace llvm
53
54 #endif