WebSVN – QNX 8.QNX8 LLVM/Clang compiler suite – Blame – /llvm-build/x86_64/include/llvm/IR/ProfDataUtils.h

Rev	Author	Line No.	Line
14	pmbaty	1	//===- llvm/IR/ProfDataUtils.h - Profiling Metadata Utilities ---- 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	/// @file
		10	/// This file contains the declarations for profiling metadata utility
		11	/// functions.
		12	//
		13	//===----------------------------------------------------------------------===//
		14
		15	#ifndef LLVM_IR_PROFDATAUTILS_H
		16	#define LLVM_IR_PROFDATAUTILS_H
		17
		18	#include "llvm/ADT/SmallVector.h"
		19	#include "llvm/ADT/Twine.h"
		20	#include "llvm/IR/Metadata.h"
		21
		22	namespace llvm {
		23
		24	/// Checks if an Instruction has MD_prof Metadata
		25	bool hasProfMD(const Instruction &I);
		26
		27	/// Checks if an MDNode contains Branch Weight Metadata
		28	bool isBranchWeightMD(const MDNode *ProfileData);
		29
		30	/// Checks if an instructions has Branch Weight Metadata
		31	///
		32	/// \param I The instruction to check
		33	/// \returns True if I has an MD_prof node containing Branch Weights. False
		34	/// otherwise.
		35	bool hasBranchWeightMD(const Instruction &I);
		36
		37	/// Checks if an instructions has valid Branch Weight Metadata
		38	///
		39	/// \param I The instruction to check
		40	/// \returns True if I has an MD_prof node containing valid Branch Weights,
		41	/// i.e., one weight for each successor. False otherwise.
		42	bool hasValidBranchWeightMD(const Instruction &I);
		43
		44	/// Get the branch weights metadata node
		45	///
		46	/// \param I The Instruction to get the weights from.
		47	/// \returns A pointer to I's branch weights metadata node, if it exists.
		48	/// Nullptr otherwise.
		49	MDNode *getBranchWeightMDNode(const Instruction &I);
		50
		51	/// Get the valid branch weights metadata node
		52	///
		53	/// \param I The Instruction to get the weights from.
		54	/// \returns A pointer to I's valid branch weights metadata node, if it exists.
		55	/// Nullptr otherwise.
		56	MDNode *getValidBranchWeightMDNode(const Instruction &I);
		57
		58	/// Extract branch weights from MD_prof metadata
		59	///
		60	/// \param ProfileData A pointer to an MDNode.
		61	/// \param [out] Weights An output vector to fill with branch weights
		62	/// \returns True if weights were extracted, False otherwise. When false Weights
		63	/// will be cleared.
		64	bool extractBranchWeights(const MDNode *ProfileData,
		65	SmallVectorImpl<uint32_t> &Weights);
		66
		67	/// Extract branch weights attatched to an Instruction
		68	///
		69	/// \param I The Instruction to extract weights from.
		70	/// \param [out] Weights An output vector to fill with branch weights
		71	/// \returns True if weights were extracted, False otherwise. When false Weights
		72	/// will be cleared.
		73	bool extractBranchWeights(const Instruction &I,
		74	SmallVectorImpl<uint32_t> &Weights);
		75
		76	/// Extract branch weights from a conditional branch or select Instruction.
		77	///
		78	/// \param I The instruction to extract branch weights from.
		79	/// \param [out] TrueVal will contain the branch weight for the True branch
		80	/// \param [out] FalseVal will contain the branch weight for the False branch
		81	/// \returns True on success with profile weights filled in. False if no
		82	/// metadata or invalid metadata was found.
		83	bool extractBranchWeights(const Instruction &I, uint64_t &TrueVal,
		84	uint64_t &FalseVal);
		85
		86	/// Retrieve the total of all weights from MD_prof data.
		87	///
		88	/// \param ProfileData The profile data to extract the total weight from
		89	/// \param [out] TotalWeights input variable to fill with total weights
		90	/// \returns True on success with profile total weights filled in. False if no
		91	/// metadata was found.
		92	bool extractProfTotalWeight(const MDNode *ProfileData, uint64_t &TotalWeights);
		93
		94	/// Retrieve the total of all weights from an instruction.
		95	///
		96	/// \param I The instruction to extract the total weight from
		97	/// \param [out] TotalWeights input variable to fill with total weights
		98	/// \returns True on success with profile total weights filled in. False if no
		99	/// metadata was found.
		100	bool extractProfTotalWeight(const Instruction &I, uint64_t &TotalWeights);
		101
		102	} // namespace llvm
		103	#endif

Subversion Repositories QNX 8.QNX8 LLVM/Clang compiler suite

QNX 8.QNX8 LLVM/Clang compiler suite/llvm-build/x86_64/include/llvm/IR/ProfDataUtils.h – Rev 14