Skip to content

[NFC][profdata] Apply lints and other format fixes #149433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2025
Merged

[NFC][profdata] Apply lints and other format fixes #149433

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
725a13d
[NFC][profdata] Apply lints and other format fixes
ellishg Jul 18, 2025
82108e8
add back include
ellishg Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 58 additions & 62 deletions llvm/tools/llvm-profdata/llvm-profdata.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
#include "llvm/Debuginfod/HTTPClient.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/Object/Binary.h"
#include "llvm/ProfileData/DataAccessProf.h"
#include "llvm/ProfileData/InstrProfCorrelator.h"
#include "llvm/ProfileData/InstrProfReader.h"
#include "llvm/ProfileData/InstrProfWriter.h"
Expand Down Expand Up @@ -54,23 +53,23 @@ using ProfCorrelatorKind = InstrProfCorrelator::ProfCorrelatorKind;

// https://llvm.org/docs/CommandGuide/llvm-profdata.html has documentations
// on each subcommand.
cl::SubCommand ShowSubcommand(
static cl::SubCommand ShowSubcommand(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curiously, is this static keyword suggested by lint/format tools ? Ask mainly because I don't anticipate 'clang-format' to do this, and curious if there are other ways (e.g. copilot or other coding agents) to apply lint/format changes nowadays.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My VSCode had yellow squiggles from clang-tidy and used that tool to fix these issues. I'm not sure if these lints are new or not.

"show",
"Takes a profile data file and displays the profiles. See detailed "
"documentation in "
"https://llvm.org/docs/CommandGuide/llvm-profdata.html#profdata-show");
cl::SubCommand OrderSubcommand(
static cl::SubCommand OrderSubcommand(
"order",
"Reads temporal profiling traces from a profile and outputs a function "
"order that reduces the number of page faults for those traces. See "
"detailed documentation in "
"https://llvm.org/docs/CommandGuide/llvm-profdata.html#profdata-order");
cl::SubCommand OverlapSubcommand(
static cl::SubCommand OverlapSubcommand(
"overlap",
"Computes and displays the overlap between two profiles. See detailed "
"documentation in "
"https://llvm.org/docs/CommandGuide/llvm-profdata.html#profdata-overlap");
cl::SubCommand MergeSubcommand(
static cl::SubCommand MergeSubcommand(
"merge",
"Takes several profiles and merge them together. See detailed "
"documentation in "
Expand All @@ -93,12 +92,11 @@ enum class ShowFormat { Text, Json, Yaml };
} // namespace

// Common options.
cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
cl::init("-"), cl::desc("Output file"),
cl::sub(ShowSubcommand),
cl::sub(OrderSubcommand),
cl::sub(OverlapSubcommand),
cl::sub(MergeSubcommand));
static cl::opt<std::string>
OutputFilename("output", cl::value_desc("output"), cl::init("-"),
cl::desc("Output file"), cl::sub(ShowSubcommand),
cl::sub(OrderSubcommand), cl::sub(OverlapSubcommand),
cl::sub(MergeSubcommand));
// NOTE: cl::alias must not have cl::sub(), since aliased option's cl::sub()
// will be used. llvm::cl::alias::done() method asserts this condition.
static cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
Expand Down Expand Up @@ -528,9 +526,9 @@ static void exitWithError(Twine Message, StringRef Whence = "",
static void exitWithError(Error E, StringRef Whence = "") {
if (E.isA<InstrProfError>()) {
handleAllErrors(std::move(E), [&](const InstrProfError &IPE) {
instrprof_error instrError = IPE.get();
instrprof_error InstrError = IPE.get();
StringRef Hint = "";
if (instrError == instrprof_error::unrecognized_format) {
if (InstrError == instrprof_error::unrecognized_format) {
// Hint in case user missed specifying the profile type.
Hint = "Perhaps you forgot to use the --sample or --memory option?";
}
Expand Down Expand Up @@ -637,7 +635,7 @@ class SymbolRemapper {
return New.empty() ? Name : FunctionId(New);
}
};
}
} // namespace

struct WeightedFile {
std::string Filename;
Expand Down Expand Up @@ -827,18 +825,18 @@ loadInput(const WeightedFile &Input, SymbolRemapper *Remapper,
// Only show hint the first time an error occurs.
auto [ErrCode, Msg] = InstrProfError::take(std::move(E));
std::unique_lock<std::mutex> ErrGuard{WC->ErrLock};
bool firstTime = WC->WriterErrorCodes.insert(ErrCode).second;
bool FirstTime = WC->WriterErrorCodes.insert(ErrCode).second;
handleMergeWriterError(make_error<InstrProfError>(ErrCode, Msg),
Input.Filename, FuncName, firstTime);
Input.Filename, FuncName, FirstTime);
});
}

if (KeepVTableSymbols) {
const InstrProfSymtab &symtab = Reader->getSymtab();
const auto &VTableNames = symtab.getVTableNames();
const InstrProfSymtab &Symtab = Reader->getSymtab();
const auto &VTableNames = Symtab.getVTableNames();

for (const auto &kv : VTableNames)
WC->Writer.addVTableName(kv.getKey());
for (const auto &KV : VTableNames)
WC->Writer.addVTableName(KV.getKey());
}

if (Reader->hasTemporalProfile()) {
Expand Down Expand Up @@ -879,8 +877,8 @@ static void mergeWriterContexts(WriterContext *Dst, WriterContext *Src) {
Dst->Writer.mergeRecordsFromWriter(std::move(Src->Writer), [&](Error E) {
auto [ErrorCode, Msg] = InstrProfError::take(std::move(E));
std::unique_lock<std::mutex> ErrGuard{Dst->ErrLock};
bool firstTime = Dst->WriterErrorCodes.insert(ErrorCode).second;
if (firstTime)
bool FirstTime = Dst->WriterErrorCodes.insert(ErrorCode).second;
if (FirstTime)
warn(toString(make_error<InstrProfError>(ErrorCode, Msg)));
});
}
Expand All @@ -890,34 +888,32 @@ getFuncName(const StringMap<InstrProfWriter::ProfilingData>::value_type &Val) {
return Val.first();
}

static std::string
getFuncName(const SampleProfileMap::value_type &Val) {
static std::string getFuncName(const SampleProfileMap::value_type &Val) {
return Val.second.getContext().toString();
}

template <typename T>
static void filterFunctions(T &ProfileMap) {
bool hasFilter = !FuncNameFilter.empty();
bool hasNegativeFilter = !FuncNameNegativeFilter.empty();
if (!hasFilter && !hasNegativeFilter)
template <typename T> static void filterFunctions(T &ProfileMap) {
bool HasFilter = !FuncNameFilter.empty();
bool HasNegativeFilter = !FuncNameNegativeFilter.empty();
if (!HasFilter && !HasNegativeFilter)
return;

// If filter starts with '?' it is MSVC mangled name, not a regex.
llvm::Regex ProbablyMSVCMangledName("[?@$_0-9A-Za-z]+");
if (hasFilter && FuncNameFilter[0] == '?' &&
if (HasFilter && FuncNameFilter[0] == '?' &&
ProbablyMSVCMangledName.match(FuncNameFilter))
FuncNameFilter = llvm::Regex::escape(FuncNameFilter);
if (hasNegativeFilter && FuncNameNegativeFilter[0] == '?' &&
if (HasNegativeFilter && FuncNameNegativeFilter[0] == '?' &&
ProbablyMSVCMangledName.match(FuncNameNegativeFilter))
FuncNameNegativeFilter = llvm::Regex::escape(FuncNameNegativeFilter);

size_t Count = ProfileMap.size();
llvm::Regex Pattern(FuncNameFilter);
llvm::Regex NegativePattern(FuncNameNegativeFilter);
std::string Error;
if (hasFilter && !Pattern.isValid(Error))
if (HasFilter && !Pattern.isValid(Error))
exitWithError(Error);
if (hasNegativeFilter && !NegativePattern.isValid(Error))
if (HasNegativeFilter && !NegativePattern.isValid(Error))
exitWithError(Error);

// Handle MD5 profile, so it is still able to match using the original name.
Expand All @@ -929,10 +925,10 @@ static void filterFunctions(T &ProfileMap) {
auto Tmp = I++;
const auto &FuncName = getFuncName(*Tmp);
// Negative filter has higher precedence than positive filter.
if ((hasNegativeFilter &&
if ((HasNegativeFilter &&
(NegativePattern.match(FuncName) ||
(FunctionSamples::UseMD5 && NegativeMD5Name == FuncName))) ||
(hasFilter && !(Pattern.match(FuncName) ||
(HasFilter && !(Pattern.match(FuncName) ||
(FunctionSamples::UseMD5 && MD5Name == FuncName))))
ProfileMap.erase(Tmp);
}
Expand Down Expand Up @@ -1193,7 +1189,7 @@ adjustInstrProfile(std::unique_ptr<WriterContext> &WC,
StringMap<StringRef> StaticFuncMap;
InstrProfSummaryBuilder IPBuilder(ProfileSummaryBuilder::DefaultCutoffs);

auto checkSampleProfileHasFUnique = [&Reader]() {
auto CheckSampleProfileHasFUnique = [&Reader]() {
for (const auto &PD : Reader->getProfiles()) {
auto &FContext = PD.second.getContext();
if (FContext.toString().find(FunctionSamples::UniqSuffix) !=
Expand All @@ -1204,9 +1200,9 @@ adjustInstrProfile(std::unique_ptr<WriterContext> &WC,
return false;
};

bool SampleProfileHasFUnique = checkSampleProfileHasFUnique();
bool SampleProfileHasFUnique = CheckSampleProfileHasFUnique();

auto buildStaticFuncMap = [&StaticFuncMap,
auto BuildStaticFuncMap = [&StaticFuncMap,
SampleProfileHasFUnique](const StringRef Name) {
std::string FilePrefixes[] = {".cpp", "cc", ".c", ".hpp", ".h"};
size_t PrefixPos = StringRef::npos;
Expand Down Expand Up @@ -1366,7 +1362,7 @@ adjustInstrProfile(std::unique_ptr<WriterContext> &WC,
InstrProfRecord *R = &PD.getValue().begin()->second;
StringRef FullName = PD.getKey();
InstrProfileMap[FullName] = InstrProfileEntry(R);
buildStaticFuncMap(FullName);
BuildStaticFuncMap(FullName);
}

for (auto &PD : Reader->getProfiles()) {
Expand Down Expand Up @@ -1497,8 +1493,8 @@ remapSamples(const sampleprof::FunctionSamples &Samples,
BodySample.second.getSamples());
for (const auto &Target : BodySample.second.getCallTargets()) {
Result.addCalledTargetSamples(BodySample.first.LineOffset,
MaskedDiscriminator,
Remapper(Target.first), Target.second);
MaskedDiscriminator, Remapper(Target.first),
Target.second);
}
}
for (const auto &CallsiteSamples : Samples.getCallsiteSamples()) {
Expand Down Expand Up @@ -1759,7 +1755,7 @@ static void parseInputFilenamesFile(MemoryBuffer *Buffer,
if (SanitizedEntry.starts_with("#"))
continue;
// If there's no comma, it's an unweighted profile.
else if (!SanitizedEntry.contains(','))
if (!SanitizedEntry.contains(','))
addWeightedInput(WFV, {std::string(SanitizedEntry), 1});
else
addWeightedInput(WFV, parseWeightedFile(SanitizedEntry));
Expand Down Expand Up @@ -2740,10 +2736,11 @@ std::error_code SampleOverlapAggregator::loadProfiles() {
return std::error_code();
}

void overlapSampleProfile(const std::string &BaseFilename,
const std::string &TestFilename,
const OverlapFuncFilters &FuncFilter,
uint64_t SimilarityCutoff, raw_fd_ostream &OS) {
static void overlapSampleProfile(const std::string &BaseFilename,
const std::string &TestFilename,
const OverlapFuncFilters &FuncFilter,
uint64_t SimilarityCutoff,
raw_fd_ostream &OS) {
using namespace sampleprof;

// We use 0.000005 to initialize OverlapAggr.Epsilon because the final metrics
Expand Down Expand Up @@ -2883,17 +2880,15 @@ static int showInstrProfile(ShowFormat SFormat, raw_fd_ostream &OS) {
OS << ":ir\n";

for (const auto &Func : *Reader) {
if (Reader->isIRLevelProfile()) {
if (IsIRInstr) {
bool FuncIsCS = NamedInstrProfRecord::hasCSFlagInHash(Func.Hash);
if (FuncIsCS != ShowCS)
continue;
}
bool Show = ShowAllFunctions ||
(!FuncNameFilter.empty() && Func.Name.contains(FuncNameFilter));

bool doTextFormatDump = (Show && TextFormat);

if (doTextFormatDump) {
if (Show && TextFormat) {
InstrProfSymtab &Symtab = Reader->getSymtab();
InstrProfWriter::writeRecordInText(Func.Name, Func.Hash, Func, Symtab,
OS);
Expand Down Expand Up @@ -2931,9 +2926,9 @@ static int showInstrProfile(ShowFormat SFormat, raw_fd_ostream &OS) {
continue;
}

for (size_t I = 0, E = Func.Counts.size(); I < E; ++I) {
FuncMax = std::max(FuncMax, Func.Counts[I]);
FuncSum += Func.Counts[I];
for (const auto &Count : Func.Counts) {
FuncMax = std::max(FuncMax, Count);
FuncSum += Count;
}

if (FuncMax < ShowValueCutoff) {
Expand All @@ -2943,7 +2938,8 @@ static int showInstrProfile(ShowFormat SFormat, raw_fd_ostream &OS) {
<< " Sum = " << FuncSum << ")\n";
}
continue;
} else if (OnlyListBelow)
}
if (OnlyListBelow)
continue;

if (TopNFunctions) {
Expand Down Expand Up @@ -3017,9 +3013,8 @@ static int showInstrProfile(ShowFormat SFormat, raw_fd_ostream &OS) {
if (TextFormat || ShowCovered)
return 0;
std::unique_ptr<ProfileSummary> PS(Builder.getSummary());
bool IsIR = Reader->isIRLevelProfile();
OS << "Instrumentation level: " << (IsIR ? "IR" : "Front-end");
if (IsIR) {
OS << "Instrumentation level: " << (IsIRInstr ? "IR" : "Front-end");
if (IsIRInstr) {
OS << " entry_first = " << Reader->instrEntryBBEnabled();
OS << " instrument_loop_entries = " << Reader->instrLoopEntriesEnabled();
}
Expand Down Expand Up @@ -3076,10 +3071,10 @@ static int showInstrProfile(ShowFormat SFormat, raw_fd_ostream &OS) {
auto &Traces = Reader->getTemporalProfTraces();
OS << "Temporal Profile Traces (samples=" << Traces.size()
<< " seen=" << Reader->getTemporalProfTraceStreamSize() << "):\n";
for (unsigned i = 0; i < Traces.size(); i++) {
OS << " Temporal Profile Trace " << i << " (weight=" << Traces[i].Weight
<< " count=" << Traces[i].FunctionNameRefs.size() << "):\n";
for (auto &NameRef : Traces[i].FunctionNameRefs)
for (auto [Index, Trace] : llvm::enumerate(Traces)) {
OS << " Temporal Profile Trace " << Index << " (weight=" << Trace.Weight
<< " count=" << Trace.FunctionNameRefs.size() << "):\n";
for (auto &NameRef : Trace.FunctionNameRefs)
OS << " " << Reader->getSymtab().getFuncOrVarName(NameRef) << "\n";
}
}
Expand Down Expand Up @@ -3392,7 +3387,8 @@ static int show_main(StringRef ProgName) {
exitWithErrorCode(EC, OutputFilename);

if (ShowAllFunctions && !FuncNameFilter.empty())
WithColor::warning() << "-function argument ignored: showing all functions\n";
WithColor::warning()
<< "-function argument ignored: showing all functions\n";

if (!DebugInfoFilename.empty())
return showDebugInfoCorrelation(DebugInfoFilename, SFormat, OS);
Expand Down
Loading