save events in a safer way. the old way assumed that event type indices remain constant (they don't always), which could result in running arbitrary events or crashing upon loading.

This commit is contained in:
nitsuja 2011-12-31 19:02:22 -08:00 committed by skidau
parent a81631b58e
commit c9059c708e
2 changed files with 50 additions and 5 deletions

View File

@ -68,6 +68,8 @@ u64 fakeDecStartTicks;
u64 fakeTBStartValue; u64 fakeTBStartValue;
u64 fakeTBStartTicks; u64 fakeTBStartTicks;
int ev_lost;
static std::recursive_mutex externalEventSection; static std::recursive_mutex externalEventSection;
void (*advanceCallback)(int cyclesExecuted) = NULL; void (*advanceCallback)(int cyclesExecuted) = NULL;
@ -107,11 +109,28 @@ void FreeTsEvent(Event* ev)
allocatedTsEvents--; allocatedTsEvents--;
} }
static void EmptyTimedCallback(u64 userdata, int cyclesLate) {}
int RegisterEvent(const char *name, TimedCallback callback) int RegisterEvent(const char *name, TimedCallback callback)
{ {
EventType type; EventType type;
type.name = name; type.name = name;
type.callback = callback; type.callback = callback;
// check for existing type with same name.
// we want event type names to remain unique so that we can use them for serialization.
for (int i = 0; i < event_types.size(); ++i)
{
if (!strcmp(name, event_types[i].name))
{
WARN_LOG(POWERPC, "Discarded old event type \"%s\" because a new type with the same name was registered.", name);
// we don't know if someone might be holding on to the type index,
// so we gut the old event type instead of actually removing it.
event_types[i].name = "_discarded_event";
event_types[i].callback = &EmptyTimedCallback;
}
}
event_types.push_back(type); event_types.push_back(type);
return (int)event_types.size() - 1; return (int)event_types.size() - 1;
} }
@ -129,6 +148,8 @@ void Init()
slicelength = maxSliceLength; slicelength = maxSliceLength;
globalTimer = 0; globalTimer = 0;
idledCycles = 0; idledCycles = 0;
ev_lost = RegisterEvent("_lost_event", &EmptyTimedCallback);
} }
void Shutdown() void Shutdown()
@ -156,8 +177,32 @@ void Shutdown()
void EventDoState(PointerWrap &p, BaseEvent* ev) void EventDoState(PointerWrap &p, BaseEvent* ev)
{ {
p.Do(ev->time); p.Do(ev->time);
p.Do(ev->type);
p.Do(ev->userdata); // this is why we can't have (nice things) pointers as userdata
p.Do(ev->userdata);
// we can't savestate ev->type directly because events might not get registered in the same order (or at all) every time.
// so, we savestate the event's type's name, and derive ev->type from that when loading.
std::string name = event_types[ev->type].name;
p.Do(name);
if (p.GetMode() == PointerWrap::MODE_READ)
{
bool foundMatch = false;
for (int i = 0; i < event_types.size(); ++i)
{
if (!strcmp(name.c_str(), event_types[i].name))
{
ev->type = i;
foundMatch = true;
break;
}
}
if (!foundMatch)
{
WARN_LOG(POWERPC, "Lost event from savestate because its type, \"%s\", has not been registered.", name.c_str());
ev->type = ev_lost;
}
}
} }
void DoState(PointerWrap &p) void DoState(PointerWrap &p)
@ -434,8 +479,8 @@ void Advance()
{ {
if (first->time <= globalTimer) if (first->time <= globalTimer)
{ {
// LOG(GEKKO, "[Scheduler] %s (%lld, %lld) ", // LOG(POWERPC, "[Scheduler] %s (%lld, %lld) ",
// first->name ? first->name : "?", (u64)globalTimer, (u64)first->time); // event_types[first->type].name ? event_types[first->type].name : "?", (u64)globalTimer, (u64)first->time);
Event* evt = first; Event* evt = first;
first = first->next; first = first->next;
event_types[evt->type].callback(evt->userdata, (int)(globalTimer - evt->time)); event_types[evt->type].callback(evt->userdata, (int)(globalTimer - evt->time));

View File

@ -50,7 +50,7 @@ u64 GetIdleTicks();
void DoState(PointerWrap &p); void DoState(PointerWrap &p);
// Returns the event_type identifier. // Returns the event_type identifier. if name is not unique, an existing event_type will be discarded.
int RegisterEvent(const char *name, TimedCallback callback); int RegisterEvent(const char *name, TimedCallback callback);
void UnregisterAllEvents(); void UnregisterAllEvents();