branch_aggregation.h

#ifndef AUTOFDO_BRANCH_AGGREGATION_H_
#define AUTOFDO_BRANCH_AGGREGATION_H_

#include <cstdint>

#include "binary_address_branch.h"
#include "third_party/abseil/absl/algorithm/container.h"
#include "third_party/abseil/absl/container/flat_hash_map.h"
#include "third_party/abseil/absl/container/flat_hash_set.h"

namespace devtools_crosstool_autofdo {
// An aggregation of branch/fallthrough data, which can be obtained from LBR,
// SPE, or any other profiling source. `BranchAggregation` contains aggregated
// information about single branches and fallthroughs.
//
// `BranchAggregation`'s fallthrough counters indicate control flow transfer,
// but they do not directly encode how many times each instruction is executed.
// This property differs from `LbrAggregation`, whose fallthrough counts encode
// both control flow transfer and instruction execution count.
struct BranchAggregation {
  int64_t GetNumberOfBranchCounters() const {
    return absl::c_accumulate(
        branch_counters, int64_t{0},
        [](int64_t cnt, const auto &v) { return cnt + v.second; });
  }

  // Returns the set of unique addresses. An aggregation's addresses can come
  // from the `from` and `to` addresses of the keys in `branch_counters` and
  // `fallthrough_counters`.
  absl::flat_hash_set<uint64_t> GetUniqueAddresses() const;

  // A count of the number of times each branch was taken.
  absl::flat_hash_map<BinaryAddressBranch, int64_t> branch_counters;
  // A count of the number of times each fallthrough range (a fully-closed,
  // sequentially-executed interval) was taken.
  absl::flat_hash_map<BinaryAddressFallthrough, int64_t> fallthrough_counters;
};

}  // namespace devtools_crosstool_autofdo

#endif  // AUTOFDO_BRANCH_AGGREGATION_H_