Skip to content

[Remarks] YAMLRemarkSerializer: Fix StringRef out-of-bounds read #159759

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 4 commits into from
Sep 23, 2025
Merged

[Remarks] YAMLRemarkSerializer: Fix StringRef out-of-bounds read #159759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
415fcd0
[spr] changes to main this commit is based on
tobias-stadler Sep 19, 2025
88f9aa2
[spr] initial version
tobias-stadler Sep 19, 2025
15bb8e7
[spr] changes introduced through rebase
tobias-stadler Sep 23, 2025
5675264
Rebase
tobias-stadler Sep 23, 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
8 changes: 6 additions & 2 deletions llvm/lib/Remarks/YAMLRemarkSerializer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,15 @@ template <> struct MappingTraits<Argument> {
static void mapping(IO &io, Argument &A) {
assert(io.outputting() && "input not yet implemented");

// A.Key.data() is not necessarily null-terminated, so we must make a copy,
// otherwise we potentially read out of bounds.
// FIXME: Add support for StringRef Keys in YAML IO.
std::string Key(A.Key);
if (StringRef(A.Val).count('\n') > 1) {
StringBlockVal S(A.Val);
io.mapRequired(A.Key.data(), S);
io.mapRequired(Key.c_str(), S);
} else {
io.mapRequired(A.Key.data(), A.Val);
io.mapRequired(Key.c_str(), A.Val);
}
io.mapOptional("DebugLoc", A.Loc);
}
Expand Down
30 changes: 30 additions & 0 deletions llvm/unittests/Remarks/YAMLRemarksSerializerTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,33 @@ TEST(YAMLRemarks, SerializerRemarkParsedStrTabStandaloneNoStrTab) {
"...\n"),
std::move(PreFilledStrTab));
}

TEST(YAMLRemarks, SerializerRemarkStringRefOOBRead) {
remarks::Remark R;
R.RemarkType = remarks::Type::Missed;
R.PassName = StringRef("passAAAA", 4);
R.RemarkName = StringRef("nameAAAA", 4);
R.FunctionName = StringRef("funcAAAA", 4);
R.Loc = remarks::RemarkLocation{StringRef("pathAAAA", 4), 3, 4};
R.Hotness = 5;
R.Args.emplace_back();
R.Args.back().Key = StringRef("keyAAAA", 3);
R.Args.back().Val = StringRef("valueAAAA", 5);
R.Args.emplace_back();
R.Args.back().Key = StringRef("keydebugAAAA", 8);
R.Args.back().Val = StringRef("valuedebugAAAA", 10);
R.Args.back().Loc =
remarks::RemarkLocation{StringRef("argpathAAAA", 7), 6, 7};
checkStandalone(remarks::Format::YAML, R,
"--- !Missed\n"
"Pass: pass\n"
"Name: name\n"
"DebugLoc: { File: path, Line: 3, Column: 4 }\n"
"Function: func\n"
"Hotness: 5\n"
"Args:\n"
" - key: value\n"
" - keydebug: valuedebug\n"
" DebugLoc: { File: argpath, Line: 6, Column: 7 }\n"
"...\n");
}
Loading