AuroraRuntime/Source/Async/WorkItem.cpp

837 lines
20 KiB
C++
Raw Normal View History

/***
Copyright (C) 2021 J Reece Wilson (a/k/a "Reece"). All rights reserved.
File: WorkItem.cpp
Date: 2021-6-26
Author: Reece
***/
2021-09-30 14:57:41 +00:00
#include <Source/RuntimeInternal.hpp>
2021-06-30 09:28:52 +00:00
#include "Async.hpp"
2021-06-27 21:25:29 +00:00
#include "WorkItem.hpp"
2021-06-30 09:28:52 +00:00
#include "AsyncApp.hpp"
#include "AuSchedular.hpp"
#include "ThreadPool.hpp"
2021-06-27 21:25:29 +00:00
2023-08-30 00:28:05 +00:00
#if defined(AURORA_COMPILER_CLANG)
// warning: enumeration values 'kEnumCount' not handled in switch [-Wswitch
#pragma clang diagnostic ignored "-Wswitch"
// Yea, I don't give a shit.
#endif
2021-06-27 21:25:29 +00:00
namespace Aurora::Async
{
WorkItem::WorkItem(IThreadPoolInternal *owner,
2024-02-28 14:47:00 +00:00
AuOptional<WorkerPId_t> worker,
const AuSPtr<IWorkItemHandler> &task) :
worker_(worker), task_(task), owner_(owner),
finishedEvent_(false, true, true)
2021-06-27 21:25:29 +00:00
{
2024-01-23 22:35:18 +00:00
SysAssert(owner, "Unable to dispatch on an unspecified pool");
this->uShutdownCookie = owner->uAtomicShutdownCookie;
if (auto pWorker = this->GetState())
{
this->optOtherCookie = pWorker->shutdown.uShutdownFence;
}
2021-06-27 21:25:29 +00:00
}
WorkItem::~WorkItem()
{
if (auto pIOWatch = AuExchange(this->pIOWatch, {}))
{
pIOWatch->StopWatch();
}
2021-06-27 21:25:29 +00:00
}
AuSPtr<IWorkItem> WorkItem::WaitFor(const AuSPtr<IWorkItem> &workItem)
2021-06-27 21:25:29 +00:00
{
bool status {};
2021-06-27 21:25:29 +00:00
{
auto dependency = AuReinterpretCast<WorkItem>(workItem);
AU_LOCK_GUARD(this->lock);
2021-09-06 10:58:08 +00:00
AU_LOCK_GUARD(dependency->lock);
if (dependency->HasFailed())
{
2022-05-17 00:59:19 +00:00
Fail();
return AU_SHARED_FROM_THIS;
}
if (!AuTryInsert(dependency->waiters_, AuSharedFromThis()))
{
2022-05-17 00:59:19 +00:00
Fail();
return AU_SHARED_FROM_THIS;
}
2024-03-04 11:55:54 +00:00
if (!AuTryInsert(this->waitOn_, AuConstReference(workItem)))
{
AuTryRemove(dependency->waiters_, AuSharedFromThis());
2022-05-17 00:59:19 +00:00
Fail();
return AU_SHARED_FROM_THIS;
}
2021-06-27 21:25:29 +00:00
}
return AU_SHARED_FROM_THIS;
}
2021-07-12 14:37:05 +00:00
bool WorkItem::WaitForLocked(const AuList<AuSPtr<IWorkItem>> &workItems)
{
for (auto &workItem : workItems)
{
2023-05-02 10:27:06 +00:00
if (!workItem)
{
SysPushErrorArg();
return false;
}
auto dependency = AuReinterpretCast<WorkItem>(workItem);
AU_LOCK_GUARD(dependency->lock);
if (dependency->HasFailed())
{
return false;
}
if (!AuTryInsert(dependency->waiters_, AuSharedFromThis()))
{
return false;
}
2024-03-04 11:55:54 +00:00
if (!AuTryInsert(this->waitOn_, AuConstReference(workItem)))
{
AuTryRemove(dependency->waiters_, AuSharedFromThis());
return false;
}
}
return true;
}
AuSPtr<IWorkItem> WorkItem::WaitFor(const AuList<AuSPtr<IWorkItem>> &workItems)
{
bool status {};
{
AU_LOCK_GUARD(this->lock);
status = WaitForLocked(workItems);
}
if (!status)
{
Fail();
}
return AU_SHARED_FROM_THIS;
2021-06-27 21:25:29 +00:00
}
2021-07-12 14:37:05 +00:00
AuSPtr<IWorkItem> WorkItem::Then(const AuSPtr<IWorkItem> &next)
{
auto that = AU_SHARED_FROM_THIS;
2023-05-02 10:27:06 +00:00
if (!next)
{
SysPushErrorArg();
return {};
}
2021-07-12 14:37:05 +00:00
next->WaitFor(that);
next->Dispatch();
return that;
}
2021-06-30 12:00:32 +00:00
AuSPtr<IWorkItem> WorkItem::SetSchedTimeNs(AuUInt64 ns)
2021-06-30 12:00:32 +00:00
{
this->dispatchTimeNs_ = Time::SteadyClockNS() + ns;
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::SetSchedTimeAbs(AuUInt32 ms)
{
return this->SetSchedTimeNsAbs(AuMSToNS<AuUInt64>(ms));
}
AuSPtr<IWorkItem> WorkItem::SetSchedTimeNsAbs(AuUInt64 ns)
{
auto uNow = AuTime::CurrentClockNS();
if (uNow > ns)
{
return AU_SHARED_FROM_THIS;
}
this->dispatchTimeNs_ = AuTime::SteadyClockNS() + (ns - uNow);
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::SetSchedSteadyTimeNsAbs(AuUInt64 ns)
{
this->dispatchTimeNs_ = ns;
return AU_SHARED_FROM_THIS;
2021-06-30 12:00:32 +00:00
}
AuSPtr<IWorkItem> WorkItem::SetSchedByLoopSourceRepeating(const AuSPtr<IO::Loop::ILoopSource> &pLoopSource)
{
if (this->pIOWatchLS)
{
this->Fail();
return {};
}
this->bIoRepeating = true;
this->pIOWatchLS = pLoopSource;
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::SetSchedByLoopSourceOnce(const AuSPtr<IO::Loop::ILoopSource> &pLoopSource)
{
if (this->pIOWatchLS)
{
this->Fail();
return {};
}
this->bIoRepeating = false;
this->pIOWatchLS = pLoopSource;
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::SetSchedTime(AuUInt32 ms)
2021-06-27 21:25:29 +00:00
{
this->dispatchTimeNs_ = Time::SteadyClockNS() + AuMSToNS<AuUInt64>(ms);
return AU_SHARED_FROM_THIS;
2021-06-27 21:25:29 +00:00
}
AuSPtr<IWorkItem> WorkItem::AddDelayTime(AuUInt32 ms)
{
2022-06-12 18:23:18 +00:00
this->delayTimeNs_ += AuMSToNS<AuUInt64>(ms);
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::AddDelayTimeNs(AuUInt64 ns)
{
this->delayTimeNs_ += ns;
return AU_SHARED_FROM_THIS;
}
2021-06-27 21:25:29 +00:00
AuSPtr<IWorkItem> WorkItem::AddDelayTimeRepeating(AuUInt32 ms)
{
this->delayTimeNs_ += AuMSToNS<AuUInt64>(ms);
this->bRepeatingTimer = true;
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::AddDelayTimeNsRepeating(AuUInt64 ns)
{
this->bRepeatingTimer = true;
this->delayTimeNs_ += ns;
return AU_SHARED_FROM_THIS;
}
AuSPtr<IWorkItem> WorkItem::Dispatch()
2021-06-27 21:25:29 +00:00
{
DispatchEx(false);
return AU_SHARED_FROM_THIS;
2021-06-27 21:25:29 +00:00
}
void WorkItem::DispatchEx(bool check, bool bIsIOTick)
2021-06-27 21:25:29 +00:00
{
AU_LOCK_GUARD(this->lock);
2021-06-27 21:25:29 +00:00
DispatchExLocked(check);
}
void WorkItem::DispatchExLocked(bool check, bool bIsIOTick)
{
2021-06-27 21:25:29 +00:00
if (check)
{
if (this->dispatchPending_)
2021-06-27 21:25:29 +00:00
{
return;
}
}
if (HasFailed())
{
return;
}
for (auto itr = this->waitOn_.begin(); itr != this->waitOn_.end(); )
2021-06-27 21:25:29 +00:00
{
auto &waitable = *itr;
if (AuStaticCast<WorkItem>(waitable)->HasFinishedRepeatable())
{
// noop
}
else if (waitable->HasFinished())
{
itr = this->waitOn_.erase(itr);
}
else if (waitable->HasFailed())
{
itr = this->waitOn_.erase(itr);
this->Fail();
return;
}
else
2021-06-27 21:25:29 +00:00
{
return;
}
}
this->dispatchPending_ = true;
2021-09-06 10:58:08 +00:00
if (this->ioTickCount)
{
// Bypass IO tick check / I owe you
}
else if (!bIsIOTick && this->pIOWatchLS)
{
if (this->pIOWatchLS &&
!this->pIOWatch && // should sched?
!this->pIOWatchLS->IsSignaled()) // fast path to avoid scheduling
{
// Try schedule outside of an IO tick
if (!Schedule())
{
this->Fail();
}
return;
}
else if (!this->pIOWatchLS->IsSignaled()) // fast path to avoid bailing out
{
return;
}
}
if (bIsIOTick)
{
this->ioTickCount++;
}
if (Time::SteadyClockNS() < this->dispatchTimeNs_)
{
if (!Schedule())
{
this->Fail();
}
return;
}
if (auto delay = this->delayTimeNs_)
2021-06-27 21:25:29 +00:00
{
this->dispatchTimeNs_ = delay + Time::SteadyClockNS();
if (!this->bRepeatingTimer)
{
this->delayTimeNs_ = 0;
}
if (!Schedule())
{
this->Fail();
}
2021-06-27 21:25:29 +00:00
return;
}
if (this->ioTickCount)
{
this->ioTickCount--;
}
2021-06-27 21:25:29 +00:00
SendOff();
}
EWorkPriority WorkItem::GetPrio()
{
return this->prio_;
}
void WorkItem::SetPrio(EWorkPriority prio)
{
if (!EWorkPriorityIsValid(prio))
{
SysPushErrorArg();
return;
}
this->prio_ = prio;
}
2021-06-30 09:28:52 +00:00
void WorkItem::CancelAsync()
{
AU_LOCK_GUARD(this->lock2);
this->Fail();
}
AuOptional<AuPair<AuUInt32, AuUInt32>> WorkItem::QueryFences()
{
return AuPair<AuUInt32, AuUInt32>{ this->uShutdownCookie, this->optOtherCookie.ValueOr(0) };
}
bool WorkItem::CheckAlive()
{
if (this->owner_ &&
this->uShutdownCookie != this->owner_->uAtomicShutdownCookie)
{
this->Fail();
return false;
}
if (this->optOtherCookie)
{
if (auto pWorker = this->GetState())
{
if (this->optOtherCookie.value() != pWorker->shutdown.uShutdownFence)
{
this->Fail();
return false;
}
}
}
return true;
2021-06-30 09:28:52 +00:00
}
void WorkItem::DispatchTask(IWorkItemHandler::ProcessInfo &info)
{
if (!this->CheckAlive())
{
return;
}
bool bRerun = (this->pIOWatchLS && this->bIoRepeating) ||
this->waitOn_.size() ||
this->bRepeatingTimer;
if (bRerun)
{
info = ETickType::eScheduleAndNotifyRepeatingWaiters;
}
if (this->task_)
{
try
{
this->task_->DispatchFrame(info);
}
catch (...)
{
// TODO: runtime config for root level exception caught behaviour
SysPushErrorCatch();
this->Fail();
return;
}
}
}
void WorkItem::Cleanup()
{
}
AuSPtr<ThreadState> WorkItem::GetState()
{
if (this->worker_.HasValue())
{
return this->owner_->GetThreadHandle(this->worker_.value());
}
else
{
return {};
}
}
void WorkItem::RunAsyncLocked2()
{
AU_LOCK_GUARD(this->lock2);
IWorkItemHandler::ProcessInfo info(true);
info.pool = this->owner_->ToThreadPool();
DispatchTask(info);
RunAsyncLocked2(info);
}
2021-06-30 09:28:52 +00:00
void WorkItem::RunAsync()
2021-06-27 21:25:29 +00:00
{
AU_LOCK_GUARD(this->lock2);
RunAsyncLocked();
}
void WorkItem::RunAsyncLocked()
{
2021-06-27 21:25:29 +00:00
IWorkItemHandler::ProcessInfo info(true);
info.pool = this->owner_->ToThreadPool();
2021-09-06 10:58:08 +00:00
2023-09-22 05:05:39 +00:00
DispatchTask(info);
2021-06-27 21:25:29 +00:00
AU_LOCK_GUARD(this->lock);
RunAsyncLocked2(info);
}
void WorkItem::RunAsyncLocked2(const IWorkItemHandler::ProcessInfo &info)
{
if (info.type != ETickType::eScheduleAndNotifyRepeatingWaiters &&
info.type != ETickType::eRerunAndNotifyRepeatingWaiters)
{
if (auto pIOWatch = AuExchange(this->pIOWatch, {}))
{
pIOWatch->StopWatch();
}
AuResetMember(this->pIOWatchLS);
}
this->finished2 = false;
2021-06-27 21:25:29 +00:00
switch (info.type)
{
case ETickType::eFinished:
2021-06-27 21:25:29 +00:00
{
2021-06-27 21:25:29 +00:00
// do nothing
break;
}
case ETickType::eEnumInvalid:
2021-06-27 21:25:29 +00:00
{
SysPanic("Handle Invalid");
break;
}
case ETickType::eSchedule:
case ETickType::eScheduleAndNotifyRepeatingWaiters:
2021-06-27 21:25:29 +00:00
{
if (info.reschedMs)
{
SetSchedTime(info.reschedMs);
}
else if (info.reschedNs)
2021-06-30 12:00:32 +00:00
{
SetSchedTimeNs(info.reschedNs);
}
else if (info.reschedClockAbsMs)
{
SetSchedTimeAbs(info.reschedClockAbsMs);
}
else if (info.reschedClockAbsNs)
{
SetSchedTimeNsAbs(info.reschedClockAbsNs);
}
else if (info.reschedSteadyClockAbsNs)
{
SetSchedSteadyTimeNsAbs(info.reschedSteadyClockAbsNs);
}
else if (info.pLoopSource)
{
SetSchedByLoopSourceOnce(info.pLoopSource);
}
if (!WaitForLocked(info.waitFor))
{
this->Fail();
}
2021-06-27 21:25:29 +00:00
}
[[fallthrough]];
case ETickType::eRerun:
case ETickType::eRerunAndNotifyRepeatingWaiters:
2021-06-27 21:25:29 +00:00
{
DispatchEx(false);
if (info.type == ETickType::eRerun ||
info.type == ETickType::eSchedule)
{
return;
}
this->finished2 = true;
2021-06-27 21:25:29 +00:00
}
case ETickType::eFailed:
2021-06-27 21:25:29 +00:00
{
this->Fail();
2021-06-27 21:25:29 +00:00
return;
}
}
this->dispatchPending_ = false;
this->finished = !this->finished2;
this->finishedEvent_->Set();
2021-09-06 10:58:08 +00:00
for (auto &waiter : AuExchange(this->waiters_, {}))
2021-09-06 10:58:08 +00:00
{
AuReinterpretCast<WorkItem>(waiter)->DispatchEx(true);
2021-09-06 10:58:08 +00:00
}
if (this->finished2)
{
this->finished2 = false;
this->finishedEvent_->Reset();
}
else
{
this->Cleanup();
}
2021-06-27 21:25:29 +00:00
}
void WorkItem::Fail()
{
failed = true;
if (auto pIOWatch = AuExchange(this->pIOWatch, {}))
{
pIOWatch->StopWatch();
}
AuResetMember(this->pIOWatchLS);
2022-01-19 17:08:13 +00:00
if (auto task_ = AuExchange(this->task_, {}))
2021-06-27 21:25:29 +00:00
{
task_->OnFailure();
2021-06-27 21:25:29 +00:00
}
for (auto &waiter : this->waiters_)
2021-06-27 21:25:29 +00:00
{
AuReinterpretCast<WorkItem>(waiter)->Fail();
2021-06-27 21:25:29 +00:00
}
this->waiters_.clear();
this->waitOn_.clear();
this->Cleanup();
2021-06-27 21:25:29 +00:00
if (this->finishedEvent_)
2021-06-27 21:25:29 +00:00
{
this->finishedEvent_->Set();
2021-06-27 21:25:29 +00:00
}
}
bool WorkItem::BlockUntilComplete()
{
#if 0
2023-09-22 05:05:39 +00:00
if (!this->worker_)
#else
if (!this->worker_ && !AuAsync::GetCurrentWorkerPId())
#endif
2023-09-22 05:05:39 +00:00
{
this->finishedEvent_->Wait();
return true;
}
struct WaitProxy : Threading::IWaitable
{
AuThreadPrimitives::IEvent *pEvent {};
WaitProxy(AuThreadPrimitives::IEvent *pEvent) :
pEvent(pEvent)
{
}
bool HasOSHandle(AuMach &mach) override
{
return this->pEvent->HasOSHandle(mach);
}
bool HasLockImplementation() override
{
return this->pEvent->HasLockImplementation();
}
void Lock() override
{
return this->pEvent->Lock();
}
bool LockMS(AuUInt64 qwRelTimeoutInMs) override
{
return this->pEvent->LockMS(qwRelTimeoutInMs);
}
bool LockNS(AuUInt64 qwRelTimeoutInNs) override
{
return this->pEvent->LockNS(qwRelTimeoutInNs);
}
bool LockAbsMS(AuUInt64 qwAbsTimeoutInMs) override
{
return this->pEvent->LockAbsMS(qwAbsTimeoutInMs);
}
bool LockAbsNS(AuUInt64 qwAbsTimeoutInNs) override
{
return this->pEvent->LockAbsNS(qwAbsTimeoutInNs);
}
bool TryLock() override
{
return this->pEvent->TryLock();
}
void Unlock() override
{
// PATCH: ensure release notifications set the event!
this->pEvent->Set();
}
} waitProxy(this->finishedEvent_.AsPointer());
return this->owner_->WaitFor(this->worker_.ValueOr(WorkerPId_t {}),
AuUnsafeRaiiToShared(&waitProxy),
0 /*forever*/);
2021-06-27 21:25:29 +00:00
}
2021-06-27 21:25:29 +00:00
bool WorkItem::HasFinished()
{
return this->finished;
2021-06-27 21:25:29 +00:00
}
bool WorkItem::HasFinishedRepeatable()
{
return this->finished2;
}
2021-09-29 08:01:42 +00:00
void WorkItem::Cancel()
{
AU_LOCK_GUARD(this->lock2);
2021-09-29 08:01:42 +00:00
Fail();
}
2021-06-27 21:25:29 +00:00
bool WorkItem::HasFailed()
{
return this->failed;
2021-06-27 21:25:29 +00:00
}
bool WorkItem::Schedule()
2021-06-27 21:25:29 +00:00
{
if (auto pLoopSource = this->pIOWatchLS)
{
2024-02-28 14:47:00 +00:00
AuSPtr<AuIO::IIOProcessor> pIOProcessor;
if (this->pIOWatch)
{
return true;
}
auto pState = this->GetState();
if (!pState)
{
2024-02-28 14:47:00 +00:00
pIOProcessor = this->owner_->ToThreadPool()->GetIOProcessor(AuAsync::GetCurrentWorkerPId());
}
else
{
pIOProcessor = pState->singletons.GetIOProcessor(this->worker_.value());
}
if (!pIOProcessor)
{
return false;
}
AU_DEBUG_MEMCRUNCH;
AuWPtr<WorkItem> wptr = this->SharedFromThis();
this->pIOWatch = pIOProcessor->StartSimpleLSWatchEx(pLoopSource, AuMakeSharedThrow<AuIO::IIOSimpleEventListenerFunctional>([=]()
{
if (auto pThat = AuTryLockMemoryType(wptr))
{
pThat->DispatchEx(false, true);
}
}, [=]()
{
if (auto pThat = AuTryLockMemoryType(wptr))
{
pThat->DispatchEx(false, true);
}
}, [=]()
{
if (auto pThat = AuTryLockMemoryType(wptr))
{
pThat->DispatchEx(false, true);
}
}), !this->bIoRepeating);
if (!this->pIOWatch)
{
return false;
}
return true;
}
else
{
return Async::Schedule(this->dispatchTimeNs_, this->owner_, this->worker_.value(), AuSharedFromThis());
}
2021-06-27 21:25:29 +00:00
}
void WorkItem::SendOff()
{
2023-09-22 05:05:39 +00:00
if (!this->worker_)
{
// If we aren't actually calling a task interface, we may as well just dispatch objects waiting on us from here
RunAsyncLocked2();
}
else
{
2023-09-22 05:05:39 +00:00
this->owner_->Run(this->worker_.value(), AuSharedFromThis());
}
2021-06-27 21:25:29 +00:00
}
void *WorkItem::GetPrivateData()
2021-06-27 21:25:29 +00:00
{
if (!this->task_)
{
return nullptr;
}
return this->task_->GetPrivateData();
}
inline auto ToInternal(const AuSPtr<IThreadPool> &pool)
{
return AuStaticPointerCast<ThreadPool>(pool);
}
AUKN_SYM AuSPtr<IWorkItem> NewWorkItem(const WorkerId_t &worker, const AuSPtr<IWorkItemHandler> &task)
{
AU_DEBUG_MEMCRUNCH;
if (!task)
{
SysPushErrorArg("WorkItem has null task. Running out of memory?");
return {};
}
auto pWorker = GetCurrentWorkerPId().GetPool();
2023-09-15 15:53:18 +00:00
if (!pWorker)
{
pWorker = AuUnsafeRaiiToShared(static_cast<IAsyncApp *>(gAsyncApp));
2023-09-15 15:53:18 +00:00
}
2023-09-15 15:41:10 +00:00
return AuMakeShared<WorkItem>(ToInternal(pWorker).get(), WorkerPId_t { pWorker , worker }, task);
}
AUKN_SYM AuSPtr<IWorkItem> NewWorkItem(const WorkerPId_t &worker, const AuSPtr<IWorkItemHandler> &task)
{
AU_DEBUG_MEMCRUNCH;
if (!task)
{
SysPushErrorArg("WorkItem has null task. Running out of memory?");
return {};
}
2023-09-15 15:53:18 +00:00
auto pWorker = worker.GetPool();
2023-09-15 15:53:18 +00:00
if (!pWorker)
{
pWorker = GetCurrentWorkerPId().GetPool();
2023-09-15 15:53:18 +00:00
}
if (!pWorker)
{
pWorker = AuUnsafeRaiiToShared(static_cast<IAsyncApp *>(gAsyncApp));
2023-09-15 15:53:18 +00:00
}
return AuMakeSharedThrow<WorkItem>(ToInternal(pWorker).get(), worker, task);
2021-06-27 21:25:29 +00:00
}
AUKN_SYM AuSPtr<IWorkItem> NewFence()
{
auto pWorker = GetCurrentWorkerPId().GetPool();
2023-09-15 15:53:18 +00:00
if (!pWorker)
{
pWorker = AuUnsafeRaiiToShared(static_cast<IAsyncApp *>(gAsyncApp));
2023-09-15 15:53:18 +00:00
}
2024-02-28 14:47:00 +00:00
return AuMakeShared<WorkItem>((IThreadPoolInternal *)ToInternal(pWorker).get(), AuOptional<WorkerPId_t> {}, AuSPtr<IWorkItemHandler>{});
}
2021-06-27 21:25:29 +00:00
}