75 lines
2.8 KiB
C++
75 lines
2.8 KiB
C++
//===- llvm/IR/ProfDataUtils.h - Profiling Metadata Utilities ---*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
/// @file
|
|
/// This file contains the declarations for profiling metadata utility
|
|
/// functions.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_IR_PROFDATAUTILS_H
|
|
#define LLVM_IR_PROFDATAUTILS_H
|
|
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/Twine.h"
|
|
#include "llvm/IR/Metadata.h"
|
|
|
|
namespace llvm {
|
|
|
|
/// Checks if an Instruction has MD_prof Metadata
|
|
bool hasProfMD(const Instruction &I);
|
|
|
|
/// Checks if an MDNode contains Branch Weight Metadata
|
|
bool isBranchWeightMD(const MDNode *ProfileData);
|
|
|
|
/// Checks if an instructions has Branch Weight Metadata
|
|
///
|
|
/// \param I The instruction to check
|
|
/// \returns True if I has an MD_prof node containing Branch Weights. False
|
|
/// otherwise.
|
|
bool hasBranchWeightMD(const Instruction &I);
|
|
|
|
/// Extract branch weights from MD_prof metadata
|
|
///
|
|
/// \param ProfileData A pointer to an MDNode.
|
|
/// \param [out] Weights An output vector to fill with branch weights
|
|
/// \returns True if weights were extracted, False otherwise. When false Weights
|
|
/// will be cleared.
|
|
bool extractBranchWeights(const MDNode *ProfileData,
|
|
SmallVectorImpl<uint32_t> &Weights);
|
|
|
|
/// Extract branch weights attatched to an Instruction
|
|
///
|
|
/// \param I The Instruction to extract weights from.
|
|
/// \param [out] Weights An output vector to fill with branch weights
|
|
/// \returns True if weights were extracted, False otherwise. When false Weights
|
|
/// will be cleared.
|
|
bool extractBranchWeights(const Instruction &I,
|
|
SmallVectorImpl<uint32_t> &Weights);
|
|
|
|
/// Extract branch weights from a conditional branch or select Instruction.
|
|
///
|
|
/// \param I The instruction to extract branch weights from.
|
|
/// \param [out] TrueVal will contain the branch weight for the True branch
|
|
/// \param [out] FalseVal will contain the branch weight for the False branch
|
|
/// \returns True on success with profile weights filled in. False if no
|
|
/// metadata or invalid metadata was found.
|
|
bool extractBranchWeights(const Instruction &I, uint64_t &TrueVal,
|
|
uint64_t &FalseVal);
|
|
|
|
/// Retrieve the total of all weights from MD_prof data.
|
|
///
|
|
/// \param ProfileData The profile data to extract the total weight from
|
|
/// \param [out] TotalWeights input variable to fill with total weights
|
|
/// \returns True on success with profile total weights filled in. False if no
|
|
/// metadata was found.
|
|
bool extractProfTotalWeight(const MDNode *ProfileData, uint64_t &TotalWeights);
|
|
|
|
} // namespace llvm
|
|
#endif
|