Skip to content

Commit 237857c

Browse files
committed
Pop string stack correctly
1 parent b25312e commit 237857c

6 files changed

Lines changed: 39 additions & 26 deletions

File tree

‎include/scratchcpp/thread.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ class LIBSCRATCHCPP_EXPORT Thread
2020
public:
2121
Thread(Target *target, IEngine *engine, Script *script);
2222
Thread(const Thread &) = delete;
23+
~Thread();
2324

2425
Target *target() const;
2526
IEngine *engine() const;

‎src/engine/internal/codegen/llvm/llvmbuildutils.cpp‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,6 @@ void LLVMBuildUtils::init(llvm::Function *function, BlockPrototype *procedurePro
8282
// Create string count variable (LLVM should optimize it into a constant later)
8383
m_stringCountVar = m_builder.CreateAlloca(m_builder.getInt64Ty(), nullptr, "stringCount");
8484

85-
// Create string array variable
86-
m_stringArrayVar = m_builder.CreateAlloca(m_stringPtrType->getPointerTo(), nullptr, "stringArray");
87-
8885
// Create string count block (string count is known after all instructions are processed)
8986
m_stringCountBlock = llvm::BasicBlock::Create(m_llvmCtx, "getStringCount", m_function);
9087
m_builder.CreateBr(m_stringCountBlock);
@@ -97,7 +94,9 @@ void LLVMBuildUtils::init(llvm::Function *function, BlockPrototype *procedurePro
9794

9895
// Push string stack (load string array)
9996
m_builder.SetInsertPoint(m_stringAllocaBlock);
100-
pushStringStack();
97+
98+
llvm::Value *stringCount = m_builder.CreateLoad(m_builder.getInt64Ty(), m_stringCountVar, "strCount");
99+
m_stringArray = m_builder.CreateCall(m_functions.resolve_llvm_push_string_stack(), { m_executionContextPtr, stringCount });
101100

102101
// Create next block
103102
m_stringAllocaNextBlock = llvm::BasicBlock::Create(m_llvmCtx, "entry.next", m_function);
@@ -178,7 +177,7 @@ void LLVMBuildUtils::end(LLVMInstruction *lastInstruction, LLVMRegister *lastCon
178177

179178
// End branch
180179
m_builder.SetInsertPoint(m_endBranch);
181-
popStringStack();
180+
m_builder.CreateCall(m_functions.resolve_llvm_pop_string_stack(), { m_executionContextPtr });
182181

183182
llvm::PointerType *pointerType = llvm::PointerType::get(llvm::Type::getInt8Ty(m_llvmCtx), 0);
184183

@@ -212,7 +211,7 @@ void LLVMBuildUtils::end(LLVMInstruction *lastInstruction, LLVMRegister *lastCon
212211

213212
// Thread end branch (stop the entire thread, including procedure callers)
214213
m_builder.SetInsertPoint(m_endThreadBranch);
215-
popStringStack();
214+
m_builder.CreateCall(m_functions.resolve_llvm_pop_string_stack(), { m_executionContextPtr });
216215

217216
switch (m_codeType) {
218217
case Compiler::CodeType::Script:
@@ -513,10 +512,14 @@ llvm::Value *LLVMBuildUtils::addAlloca(llvm::Type *type)
513512
llvm::Value *LLVMBuildUtils::addStringAlloca()
514513
{
515514
// All temporary strings are allocated when the string stack is pushed
516-
llvm::Value *stringArray = m_builder.CreateLoad(m_stringPtrType->getPointerTo(), m_stringArrayVar, "loadedStringArray");
515+
llvm::BasicBlock *block = m_builder.GetInsertBlock();
516+
m_builder.SetInsertPoint(m_stringAllocaBlock);
517+
517518
llvm::Value *index = m_builder.getInt64(m_stringCount++);
518-
llvm::Value *elementPtr = m_builder.CreateGEP(m_stringPtrType->getPointerTo(), stringArray, index);
519+
llvm::Value *elementPtr = m_builder.CreateGEP(m_stringPtrType->getPointerTo(), m_stringArray, index);
519520
llvm::Value *ret = m_builder.CreateLoad(m_stringPtrType->getPointerTo(), elementPtr, "localString");
521+
522+
m_builder.SetInsertPoint(block);
520523
return ret;
521524
}
522525

@@ -1428,14 +1431,12 @@ void LLVMBuildUtils::createSuspend()
14281431
m_builder.SetInsertPoint(suspendBranch);
14291432
}
14301433

1431-
popStringStack();
14321434
syncVariables();
14331435

14341436
m_coroutine->createSuspend();
14351437

14361438
reloadVariables();
14371439
reloadLists();
1438-
pushStringStack();
14391440

14401441
if (m_warpArg) {
14411442
m_builder.CreateBr(nextBranch);
@@ -2205,15 +2206,3 @@ llvm::Value *LLVMBuildUtils::getListDataPtr(const LLVMListPtr &listPtr)
22052206
{
22062207
return m_builder.CreateLoad(m_valueDataType->getPointerTo(), m_builder.CreateLoad(m_valueDataType->getPointerTo()->getPointerTo(), listPtr.dataPtr));
22072208
}
2208-
2209-
void LLVMBuildUtils::pushStringStack()
2210-
{
2211-
llvm::Value *stringCount = m_builder.CreateLoad(m_builder.getInt64Ty(), m_stringCountVar, "strCount");
2212-
llvm::Value *strings = m_builder.CreateCall(m_functions.resolve_llvm_push_string_stack(), { m_executionContextPtr, stringCount });
2213-
m_builder.CreateStore(strings, m_stringArrayVar);
2214-
}
2215-
2216-
void LLVMBuildUtils::popStringStack()
2217-
{
2218-
m_builder.CreateCall(m_functions.resolve_llvm_pop_string_stack(), { m_executionContextPtr });
2219-
}

‎src/engine/internal/codegen/llvm/llvmbuildutils.h‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,6 @@ class LIBSCRATCHCPP_TEST_EXPORT LLVMBuildUtils
154154
llvm::Value *getListPtr(llvm::Value *targetLists, List *list);
155155
llvm::Value *getListDataPtr(const LLVMListPtr &listPtr);
156156

157-
void pushStringStack();
158-
void popStringStack();
159-
160157
LLVMCompilerContext *m_ctx = nullptr;
161158
llvm::LLVMContext &m_llvmCtx;
162159
llvm::IRBuilder<> &m_builder;
@@ -201,7 +198,7 @@ class LIBSCRATCHCPP_TEST_EXPORT LLVMBuildUtils
201198
llvm::BasicBlock *m_stringAllocaBlock = nullptr;
202199
llvm::BasicBlock *m_stringAllocaNextBlock = nullptr;
203200
llvm::Value *m_stringCountVar = nullptr;
204-
llvm::Value *m_stringArrayVar = nullptr;
201+
llvm::Value *m_stringArray = nullptr;
205202
size_t m_stringCount = 0;
206203
};
207204

‎src/engine/thread.cpp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ Thread::Thread(Target *target, IEngine *engine, Script *script) :
2525
}
2626
}
2727

28+
/*! Destroys Thread. */
29+
Thread::~Thread()
30+
{
31+
if (impl->executionContext)
32+
impl->executionContext->clearStringStack();
33+
}
34+
2835
/*! Returns the Target of the script. */
2936
Target *Thread::target() const
3037
{
@@ -70,12 +77,14 @@ bool Thread::runPredicate()
7077
void Thread::kill()
7178
{
7279
impl->code->kill(impl->executionContext.get());
80+
impl->executionContext->clearStringStack();
7381
}
7482

7583
/*! Resets the script to run from the start. */
7684
void Thread::reset()
7785
{
7886
impl->code->reset(impl->executionContext.get());
87+
impl->executionContext->clearStringStack();
7988
}
8089

8190
/*! Returns true if the script is stopped or finished. */

‎test/engine/engine_test.cpp‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2399,3 +2399,20 @@ TEST(EngineTest, NoStringStackRaceConditionInRecursiveProcedures)
23992399
ASSERT_VAR(stage, "passed");
24002400
ASSERT_TRUE(GET_VAR(stage, "passed")->value().toBool());
24012401
}
2402+
2403+
TEST(EngineTest, NoStaleStringStackInNonWarpProceduresWithArguments)
2404+
{
2405+
// Regtest for #704
2406+
Project p("regtest_projects/704_string_stack_with_procedure_arguments.sb3");
2407+
ASSERT_TRUE(p.load());
2408+
2409+
auto engine = p.engine();
2410+
2411+
Stage *stage = engine->stage();
2412+
ASSERT_TRUE(stage);
2413+
2414+
engine->run();
2415+
2416+
ASSERT_VAR(stage, "passed");
2417+
ASSERT_TRUE(GET_VAR(stage, "passed")->value().toBool());
2418+
}
Binary file not shown.

0 commit comments

Comments
 (0)