LLVM 19.0.0git
PGOOptions.cpp
Go to the documentation of this file.
1//===------ PGOOptions.cpp -- PGO option tunables --------------*- 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
11
12using namespace llvm;
13
14PGOOptions::PGOOptions(std::string ProfileFile, std::string CSProfileGenFile,
15 std::string ProfileRemappingFile,
16 std::string MemoryProfile,
18 CSPGOAction CSAction, ColdFuncOpt ColdType,
19 bool DebugInfoForProfiling, bool PseudoProbeForProfiling,
20 bool AtomicCounterUpdate)
21 : ProfileFile(ProfileFile), CSProfileGenFile(CSProfileGenFile),
22 ProfileRemappingFile(ProfileRemappingFile), MemoryProfile(MemoryProfile),
23 Action(Action), CSAction(CSAction), ColdOptType(ColdType),
24 DebugInfoForProfiling(DebugInfoForProfiling ||
25 (Action == SampleUse && !PseudoProbeForProfiling)),
26 PseudoProbeForProfiling(PseudoProbeForProfiling),
27 AtomicCounterUpdate(AtomicCounterUpdate), FS(std::move(FS)) {
28 // Note, we do allow ProfileFile.empty() for Action=IRUse LTO can
29 // callback with IRUse action without ProfileFile.
30
31 // If there is a CSAction, PGOAction cannot be IRInstr or SampleUse.
32 assert(this->CSAction == NoCSAction ||
33 (this->Action != IRInstr && this->Action != SampleUse));
34
35 // For CSIRInstr, CSProfileGenFile also needs to be nonempty.
36 assert(this->CSAction != CSIRInstr || !this->CSProfileGenFile.empty());
37
38 // If CSAction is CSIRUse, PGOAction needs to be IRUse as they share
39 // a profile.
40 assert(this->CSAction != CSIRUse || this->Action == IRUse);
41
42 // Cannot optimize with MemProf profile during IR instrumentation.
43 assert(this->MemoryProfile.empty() || this->Action != PGOOptions::IRInstr);
44
45 // If neither Action nor CSAction nor MemoryProfile are set,
46 // DebugInfoForProfiling or PseudoProbeForProfiling needs to be true.
47 assert(this->Action != NoAction || this->CSAction != NoCSAction ||
48 !this->MemoryProfile.empty() || this->DebugInfoForProfiling ||
49 this->PseudoProbeForProfiling);
50
51 // If we need to use the profile, the VFS cannot be nullptr.
52 assert(this->FS || !(this->Action == IRUse || this->CSAction == CSIRUse ||
53 !this->MemoryProfile.empty()));
54}
55
56PGOOptions::PGOOptions(const PGOOptions &) = default;
57
59
60PGOOptions::~PGOOptions() = default;
Define option tunables for PGO.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
Defines the virtual file system interface vfs::FileSystem.
A smart pointer to a reference-counted object that inherits from RefCountedBase or ThreadSafeRefCount...
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1858
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
A struct capturing PGO tunables.
Definition: PGOOptions.h:27
PGOOptions & operator=(const PGOOptions &)
PGOOptions(std::string ProfileFile, std::string CSProfileGenFile, std::string ProfileRemappingFile, std::string MemoryProfile, IntrusiveRefCntPtr< vfs::FileSystem > FS, PGOAction Action=NoAction, CSPGOAction CSAction=NoCSAction, ColdFuncOpt ColdType=ColdFuncOpt::Default, bool DebugInfoForProfiling=false, bool PseudoProbeForProfiling=false, bool AtomicCounterUpdate=false)
Definition: PGOOptions.cpp:14