Skip to content

[Sanitizers][Darwin] Correct iterating of MachO load commands #130161

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 3 commits into from
Mar 9, 2025
+101 −64
Merged

[Sanitizers][Darwin] Correct iterating of MachO load commands #130161

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0931113
[Sanitizers][Darwin] Correct iterating of MachO load commands
Mar 6, 2025
b81df5e
[Sanitizers][Darwin][NFC] clang-format sanitizer_procmaps_mac files
Mar 6, 2025
127062d
[Sanitizers][Darwin][NFC] Apply PR feedback
Mar 7, 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
37 changes: 29 additions & 8 deletions compiler-rt/lib/sanitizer_common/sanitizer_procmaps_mac.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,9 +334,22 @@ static const load_command *NextCommand(const load_command *lc) {
return (const load_command *)((const char *)lc + lc->cmdsize);
}

static void FindUUID(const load_command *first_lc, u8 *uuid_output) {
for (const load_command *lc = first_lc; lc->cmd != 0; lc = NextCommand(lc)) {
if (lc->cmd != LC_UUID) continue;
#ifdef MH_MAGIC_64
static const size_t header_size = sizeof(mach_header_64);
#else
static const size_t header_size = sizeof(mach_header);
#endif

static void FindUUID(const load_command *first_lc, const mach_header *hdr,
u8 *uuid_output) {
unsigned short curcmd = 0;
for (const load_command *lc = first_lc; curcmd < hdr->ncmds;
curcmd++, lc = NextCommand(lc)) {

CHECK_LT((const char*)lc, (const char*)hdr + header_size + hdr->sizeofcmds);

if (lc->cmd != LC_UUID)
continue;

const uuid_command *uuid_lc = (const uuid_command *)lc;
const uint8_t *uuid = &uuid_lc->uuid[0];
Expand All @@ -345,9 +358,16 @@ static void FindUUID(const load_command *first_lc, u8 *uuid_output) {
}
}

static bool IsModuleInstrumented(const load_command *first_lc) {
for (const load_command *lc = first_lc; lc->cmd != 0; lc = NextCommand(lc)) {
if (lc->cmd != LC_LOAD_DYLIB) continue;
static bool IsModuleInstrumented(const load_command *first_lc,
const mach_header *hdr) {
unsigned short curcmd = 0;
for (const load_command *lc = first_lc; curcmd < hdr->ncmds;
curcmd++, lc = NextCommand(lc)) {

CHECK_LT((const char*)lc, (const char*)hdr + header_size + hdr->sizeofcmds);

if (lc->cmd != LC_LOAD_DYLIB)
continue;

const dylib_command *dylib_lc = (const dylib_command *)lc;
uint32_t dylib_name_offset = dylib_lc->dylib.name.offset;
Expand Down Expand Up @@ -394,9 +414,10 @@ bool MemoryMappingLayout::Next(MemoryMappedSegment *segment) {
}
}
FindUUID((const load_command *)data_.current_load_cmd_addr,
data_.current_uuid);
hdr, data_.current_uuid);
data_.current_instrumented = IsModuleInstrumented(
(const load_command *)data_.current_load_cmd_addr);
(const load_command *)data_.current_load_cmd_addr,
hdr);
}

while (data_.current_load_cmd_count > 0) {
Expand Down
25 changes: 20 additions & 5 deletions compiler-rt/lib/sanitizer_common/tests/sanitizer_procmaps_mac_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,12 @@ class MemoryMappingLayoutMock final : public MemoryMappingLayout {
.uuid = {}
};

static constexpr char dylib_name[] = "libclang_rt.\0\0\0"; // 8 bytes aligned, padded with zeros per loader.h
static constexpr char libclang_rt_dylib_name[] = "libclang_rt.\0\0\0"; // 8 bytes aligned, padded with zeros per loader.h
static constexpr char uninstrumented_dylib_name[] = "uninst___rt.\0\0\0"; // 8 bytes aligned, padded with zeros per loader.h

static constexpr dylib_command mock_dylib_command = {
.cmd = LC_LOAD_DYLIB,
.cmdsize = sizeof(dylib_command) + sizeof(dylib_name),
.cmdsize = sizeof(dylib_command) + sizeof(libclang_rt_dylib_name),
.dylib = {
.name = {
.offset = sizeof(dylib_command)
Expand All @@ -59,7 +61,7 @@ class MemoryMappingLayoutMock final : public MemoryMappingLayout {
std::vector<unsigned char> mock_header;

public:
MemoryMappingLayoutMock(): MemoryMappingLayout(false) {
MemoryMappingLayoutMock(bool instrumented): MemoryMappingLayout(false) {
EXPECT_EQ(mock_uuid_command.cmdsize % 8, 0u);
EXPECT_EQ(mock_dylib_command.cmdsize % 8, 0u);

Expand Down Expand Up @@ -89,6 +91,7 @@ class MemoryMappingLayoutMock final : public MemoryMappingLayout {
copy((unsigned char *)&mock_dylib_command,
((unsigned char *)&mock_dylib_command) + sizeof(dylib_command), // as mock_dylib_command.cmdsize contains the following string
back_inserter(mock_header));
const char (&dylib_name)[16] = instrumented ? libclang_rt_dylib_name : uninstrumented_dylib_name;
copy((unsigned char *)dylib_name,
((unsigned char *)dylib_name) + sizeof(dylib_name),
back_inserter(mock_header));
Expand Down Expand Up @@ -120,8 +123,20 @@ class MemoryMappingLayoutMock final : public MemoryMappingLayout {
}
};

TEST(MemoryMappingLayout, Next) {
__sanitizer::MemoryMappingLayoutMock memory_mapping;
TEST(MemoryMappingLayout, NextInstrumented) {
__sanitizer::MemoryMappingLayoutMock memory_mapping(true);
__sanitizer::MemoryMappedSegment segment;
size_t size = memory_mapping.SizeOfLoadCommands();
while (memory_mapping.Next(&segment)) {
size_t offset = memory_mapping.CurrentLoadCommandOffset();
EXPECT_LE(offset, size);
}
size_t final_offset = memory_mapping.CurrentLoadCommandOffset();
EXPECT_EQ(final_offset, size); // All commands processed, no more, no less
}

TEST(MemoryMappingLayout, NextUnInstrumented) {
__sanitizer::MemoryMappingLayoutMock memory_mapping(false);
__sanitizer::MemoryMappedSegment segment;
size_t size = memory_mapping.SizeOfLoadCommands();
while (memory_mapping.Next(&segment)) {
Expand Down