llvm-project/clang/lib/AST/Interp/InterpStack.cpp
isuckatcs 403e0e8cd9
[clang][Interp] Fix crash during InterpStack printing (#68246)
`InterpStack` is using an `std::vector<>` to track the `ItemTypes`. As a
result, the new types are inserted
to the back of the `std::vector<>`, however `dump()` was reading the
types from the front (the bottom
of the stack) and printing the value on the top of the stack.

This lead to a crash if the type on the bottom had a different type from
the type on the top. E.g.:
```
Items: 2. Size: 40
0/8: 0
1/40: 0x5590cddc0460 {16, 16, 32}
```

The same method also miscalculated the offsets during printing the
stack, which was a source of
incorrect stack dumps and future crashes.

This patch changes the order of iteration of the types and fixes the
offset calculation.

As for testing the change, the issue is that it needs to be done as a
unittest, however from
`clang/unittests` we don't have access to `clang/lib`, where `Interp`
resides. Although the previous
implementation didn't have unittests either, so I'm not sure if we
actually care that much or not.
2023-10-12 23:26:44 +02:00

112 lines
2.6 KiB
C++

//===--- InterpStack.cpp - Stack implementation for the VM ------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "InterpStack.h"
#include "Boolean.h"
#include "Floating.h"
#include "Integral.h"
#include "Pointer.h"
#include <cassert>
#include <cstdlib>
using namespace clang;
using namespace clang::interp;
InterpStack::~InterpStack() {
clear();
}
void InterpStack::clear() {
if (Chunk && Chunk->Next)
std::free(Chunk->Next);
if (Chunk)
std::free(Chunk);
Chunk = nullptr;
StackSize = 0;
#ifndef NDEBUG
ItemTypes.clear();
#endif
}
void *InterpStack::grow(size_t Size) {
assert(Size < ChunkSize - sizeof(StackChunk) && "Object too large");
if (!Chunk || sizeof(StackChunk) + Chunk->size() + Size > ChunkSize) {
if (Chunk && Chunk->Next) {
Chunk = Chunk->Next;
} else {
StackChunk *Next = new (std::malloc(ChunkSize)) StackChunk(Chunk);
if (Chunk)
Chunk->Next = Next;
Chunk = Next;
}
}
auto *Object = reinterpret_cast<void *>(Chunk->End);
Chunk->End += Size;
StackSize += Size;
return Object;
}
void *InterpStack::peekData(size_t Size) const {
assert(Chunk && "Stack is empty!");
StackChunk *Ptr = Chunk;
while (Size > Ptr->size()) {
Size -= Ptr->size();
Ptr = Ptr->Prev;
assert(Ptr && "Offset too large");
}
return reinterpret_cast<void *>(Ptr->End - Size);
}
void InterpStack::shrink(size_t Size) {
assert(Chunk && "Chunk is empty!");
while (Size > Chunk->size()) {
Size -= Chunk->size();
if (Chunk->Next) {
std::free(Chunk->Next);
Chunk->Next = nullptr;
}
Chunk->End = Chunk->start();
Chunk = Chunk->Prev;
assert(Chunk && "Offset too large");
}
Chunk->End -= Size;
StackSize -= Size;
}
void InterpStack::dump() const {
#ifndef NDEBUG
llvm::errs() << "Items: " << ItemTypes.size() << ". Size: " << size() << '\n';
if (ItemTypes.empty())
return;
size_t Index = 0;
size_t Offset = 0;
// The type of the item on the top of the stack is inserted to the back
// of the vector, so the iteration has to happen backwards.
for (auto TyIt = ItemTypes.rbegin(); TyIt != ItemTypes.rend(); ++TyIt) {
Offset += align(primSize(*TyIt));
llvm::errs() << Index << '/' << Offset << ": ";
TYPE_SWITCH(*TyIt, {
const T &V = peek<T>(Offset);
llvm::errs() << V;
});
llvm::errs() << '\n';
++Index;
}
#endif
}