xref: /freebsd/contrib/llvm-project/llvm/lib/Support/PGOOptions.cpp (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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 
9 #include "llvm/Support/PGOOptions.h"
10 #include "llvm/Support/VirtualFileSystem.h"
11 
12 using namespace llvm;
13 
14 PGOOptions::PGOOptions(std::string ProfileFile, std::string CSProfileGenFile,
15                        std::string ProfileRemappingFile,
16                        std::string MemoryProfile,
17                        IntrusiveRefCntPtr<vfs::FileSystem> FS, PGOAction Action,
18                        CSPGOAction CSAction, bool DebugInfoForProfiling,
19                        bool PseudoProbeForProfiling)
20     : ProfileFile(ProfileFile), CSProfileGenFile(CSProfileGenFile),
21       ProfileRemappingFile(ProfileRemappingFile), MemoryProfile(MemoryProfile),
22       Action(Action), CSAction(CSAction),
23       DebugInfoForProfiling(DebugInfoForProfiling ||
24                             (Action == SampleUse && !PseudoProbeForProfiling)),
25       PseudoProbeForProfiling(PseudoProbeForProfiling), FS(std::move(FS)) {
26   // Note, we do allow ProfileFile.empty() for Action=IRUse LTO can
27   // callback with IRUse action without ProfileFile.
28 
29   // If there is a CSAction, PGOAction cannot be IRInstr or SampleUse.
30   assert(this->CSAction == NoCSAction ||
31          (this->Action != IRInstr && this->Action != SampleUse));
32 
33   // For CSIRInstr, CSProfileGenFile also needs to be nonempty.
34   assert(this->CSAction != CSIRInstr || !this->CSProfileGenFile.empty());
35 
36   // If CSAction is CSIRUse, PGOAction needs to be IRUse as they share
37   // a profile.
38   assert(this->CSAction != CSIRUse || this->Action == IRUse);
39 
40   // Cannot optimize with MemProf profile during IR instrumentation.
41   assert(this->MemoryProfile.empty() || this->Action != PGOOptions::IRInstr);
42 
43   // If neither Action nor CSAction nor MemoryProfile are set,
44   // DebugInfoForProfiling or PseudoProbeForProfiling needs to be true.
45   assert(this->Action != NoAction || this->CSAction != NoCSAction ||
46          !this->MemoryProfile.empty() || this->DebugInfoForProfiling ||
47          this->PseudoProbeForProfiling);
48 
49   // If we need to use the profile, the VFS cannot be nullptr.
50   assert(this->FS || !(this->Action == IRUse || this->CSAction == CSIRUse ||
51                        !this->MemoryProfile.empty()));
52 }
53 
54 PGOOptions::PGOOptions(const PGOOptions &) = default;
55 
56 PGOOptions &PGOOptions::operator=(const PGOOptions &O) = default;
57 
58 PGOOptions::~PGOOptions() = default;
59