Skip to content
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

Fix trace and breakpoint opcodes crashing #238

Merged
merged 4 commits into from
Nov 27, 2024
Merged

Fix trace and breakpoint opcodes crashing #238

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
ba56db2
Add error checks to OPCODE_READ_PARAM_STRING_FORMATTED and OPCODE_REA…
MiranDMC Nov 25, 2024
9f46ec7
Add missing details to error message.
MiranDMC Nov 25, 2024
661361e
Add check for unfinished format specifier.
MiranDMC Nov 25, 2024
929a1a4
Use macros for reading formatted strings.
MiranDMC Nov 25, 2024
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
7 changes: 3 additions & 4 deletions cleo_plugins/DebugUtils/DebugUtils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,8 @@ class DebugUtils
}
else // breakpoint formatted name string
{
auto format = CLEO_ReadStringOpcodeParam(thread);
name = CLEO_ReadParamsFormatted(thread, format);
OPCODE_READ_PARAM_STRING_FORMATTED(nameStr);
name = nameStr;
}

pausedScripts.emplace_back(thread, name.c_str());
Expand Down Expand Up @@ -262,8 +262,7 @@ class DebugUtils
return OR_CONTINUE;
}

auto format = CLEO_ReadStringOpcodeParam(thread);
auto message = CLEO_ReadParamsFormatted(thread, format);
OPCODE_READ_PARAM_STRING_FORMATTED(message);

CLEO_Log(eLogLevel::Debug, message);
return OR_CONTINUE;
Expand Down
3 changes: 1 addition & 2 deletions cleo_plugins/FileSystemOperations/FileSystemOperations.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,8 +355,7 @@ class FileSystemOperations
static OpcodeResult WINAPI opcode_0AD9(CRunningScript* thread)
{
OPCODE_READ_PARAM_FILE_HANDLE(handle);
OPCODE_READ_PARAM_STRING(format);
static char text[4 * MAX_STR_LEN]; CLEO_ReadParamsFormatted(thread, format, text, MAX_STR_LEN);
OPCODE_READ_PARAM_STRING_FORMATTED(text);

auto ok = File::writeString(handle, text);
if (!ok)
Expand Down
6 changes: 4 additions & 2 deletions cleo_sdk/CLEO_Utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,9 +691,11 @@ namespace CLEO
#define OPCODE_READ_PARAM_STRING_LEN(_varName, _maxLen) char _buff_##_varName[_maxLen + 1]; const char* ##_varName = _readParamText(thread, _buff_##_varName, _maxLen + 1); if(##_varName != nullptr) ##_varName = _buff_##_varName; if(!_paramWasString()) { return OpcodeResult::OR_INTERRUPT; }

#define OPCODE_READ_PARAM_STRING_FORMATTED(_varName) char _buff_format_##_varName[MAX_STR_LEN + 1]; const char* _format_##_varName = _readParamText(thread, _buff_format_##_varName, MAX_STR_LEN + 1); if(!_paramWasString()) { return OpcodeResult::OR_INTERRUPT; } \
char _varName[2 * MAX_STR_LEN + 1]; char* _varName##Ok = CLEO_ReadParamsFormatted(thread, _buff_format_##_varName, _varName, sizeof(_varName));
char _varName[2 * MAX_STR_LEN + 1]; char* _varName##Ok = CLEO_ReadParamsFormatted(thread, _buff_format_##_varName, _varName, sizeof(_varName)); \
if(_varName##Ok == nullptr) { SHOW_ERROR("Invalid formatted string in script %s \nScript suspended.", CLEO::ScriptInfoStr(thread).c_str()); return thread->Suspend(); }

#define OPCODE_READ_PARAMS_FORMATTED(_format, _varName) char _varName[2 * MAX_STR_LEN + 1]; char* _varName##Ok = CLEO_ReadParamsFormatted(thread, _format, _varName, sizeof(_varName));
#define OPCODE_READ_PARAMS_FORMATTED(_format, _varName) char _varName[2 * MAX_STR_LEN + 1]; char* _varName##Ok = CLEO_ReadParamsFormatted(thread, _format, _varName, sizeof(_varName)); \
if(_varName##Ok == nullptr) { SHOW_ERROR("Invalid formatted string in script %s \nScript suspended.", CLEO::ScriptInfoStr(thread).c_str()); return thread->Suspend(); }

#define OPCODE_READ_PARAM_FILEPATH(_varName) char _buff_##_varName[512]; const char* ##_varName = _readParamText(thread, _buff_##_varName, 512); if(##_varName != nullptr) ##_varName = _buff_##_varName; if(_paramWasString()) CLEO_ResolvePath(thread, _buff_##_varName, 512); else return OpcodeResult::OR_INTERRUPT; \
if(!FilepathIsSafe(thread, ##_varName)) { SHOW_ERROR("Forbidden file path '%s' outside game directories in script %s \nScript suspended.", ##_varName, ScriptInfoStr(thread).c_str()); return thread->Suspend(); }
Expand Down
13 changes: 11 additions & 2 deletions source/CCustomOpcodeSystem.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ namespace CLEO
// invalid input arguments
if(outputStr == nullptr || len == 0)
{
LOG_WARNING(thread, "ReadFormattedString invalid input arg(s)");
LOG_WARNING(thread, "ReadFormattedString invalid input arg(s) in script %s", ((CCustomScript*)thread)->GetInfoStr().c_str());
SkipUnusedVarArgs(thread);
return -1; // error
}
Expand All @@ -498,10 +498,19 @@ namespace CLEO

if (*iter == '%')
{
// end of format string
if (iter[1] == '\0')
{
LOG_WARNING(thread, "ReadFormattedString encountered incomplete format specifier in script %s", ((CCustomScript*)thread)->GetInfoStr().c_str());
SkipUnusedVarArgs(thread);
return -1; // error
}

// escaped % character
if (iter[1] == '%')
{
if (written++ >= len) goto _ReadFormattedString_OutOfMemory;
*outIter++ = '%'; /* "%%"->'%' */
*outIter++ = '%';
iter += 2;
continue;
}
Expand Down