job.cpp

/* -*- C++ -*-
    This file implements the Job class.
 
    SPDX-FileCopyrightText: 2004-2013 Mirko Boehm <mirko@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
 
    $Id: Job.cpp 20 2005-08-08 21:02:51Z mirko $
*/
 
#include "job.h"
#include "job_p.h"
 
#include "debuggingaids.h"
#include "thread.h"
#include <QAtomicInt>
#include <QAtomicPointer>
#include <QList>
#include <QMutex>
 
#include "dependencypolicy.h"
#include "exception.h"
#include "executewrapper_p.h"
#include "executor_p.h"
#include "managedjobpointer.h"
#include "queuepolicy.h"
 
namespace ThreadWeaver
{
Job::Job()
    : d_(new Private::Job_Private())
{
#if !defined(NDEBUG)
    d()->debugExecuteWrapper.wrap(setExecutor(&(d()->debugExecuteWrapper)));
#endif
    d()->status.storeRelease(Status_New);
}
 
Job::Job(Private::Job_Private *d__)
    : d_(d__)
{
#if !defined(NDEBUG)
    d()->debugExecuteWrapper.wrap(setExecutor(&(d()->debugExecuteWrapper)));
#endif
    d()->status.storeRelease(Status_New);
}
 
Job::~Job()
{
    for (int index = 0; index < d()->queuePolicies.size(); ++index) {
        d()->queuePolicies.at(index)->destructed(this);
    }
    delete d_;
}
 
void Job::execute(const JobPointer &self, Thread *th)
{
    Executor *executor = d()->executor.loadAcquire();
    Q_ASSERT(executor); // may never be unset!
    Q_ASSERT(self);
    executor->begin(self, th);
    self->setStatus(Status_Running);
    try {
        executor->execute(self, th);
        if (self->status() == Status_Running) {
            self->setStatus(Status_Success);
        }
    } catch (JobAborted &) {
        self->setStatus(Status_Aborted);
    } catch (JobFailed &) {
        self->setStatus(Status_Failed);
    } catch (AbortThread &) {
        throw;
    } catch (...) {
        TWDEBUG(0, "Uncaught exception in Job %p, aborting.", self.data());
        throw;
    }
    Q_ASSERT(self->status() > Status_Running);
    executor->end(self, th);
}
 
void Job::blockingExecute()
{
    execute(ManagedJobPointer<Job>(this), nullptr);
}
 
Executor *Job::setExecutor(Executor *executor)
{
    return d()->executor.fetchAndStoreOrdered(executor == nullptr ? &Private::defaultExecutor : executor);
}
 
Executor *Job::executor() const
{
    return d()->executor.loadAcquire();
}
 
int Job::priority() const
{
    return 0;
}
 
void Job::setStatus(JobInterface::Status status)
{
    d()->status.storeRelease(status);
}
 
JobInterface::Status Job::status() const
{
    // since status is set only through setStatus, this should be safe:
    return static_cast<Status>(d()->status.loadAcquire());
}
 
bool Job::success() const
{
    return d()->status.loadAcquire() == Status_Success;
}
 
void Job::requestAbort()
{
    d()->shouldAbort = true;
}
 
void Job::defaultBegin(const JobPointer &, Thread *)
{
}
 
void Job::defaultEnd(const JobPointer &job, Thread *)
{
    d()->handleFinish(job);
    d()->freeQueuePolicyResources(job);
}
 
void Job::aboutToBeQueued(QueueAPI *api)
{
    QMutexLocker l(mutex());
    Q_UNUSED(l);
    aboutToBeQueued_locked(api);
}
 
void Job::aboutToBeQueued_locked(QueueAPI *)
{
}
 
void Job::aboutToBeDequeued(QueueAPI *api)
{
    QMutexLocker l(mutex());
    Q_UNUSED(l);
    aboutToBeDequeued_locked(api);
}
 
void Job::aboutToBeDequeued_locked(QueueAPI *)
{
}
 
void Job::assignQueuePolicy(QueuePolicy *policy)
{
    Q_ASSERT(!mutex()->tryLock());
    if (!d()->queuePolicies.contains(policy)) {
        d()->queuePolicies.append(policy);
    }
}
 
void Job::removeQueuePolicy(QueuePolicy *policy)
{
    Q_ASSERT(!mutex()->tryLock());
    int index = d()->queuePolicies.indexOf(policy);
    if (index != -1) {
        d()->queuePolicies.removeAt(index);
    }
}
 
QList<QueuePolicy *> Job::queuePolicies() const
{
    Q_ASSERT(!mutex()->tryLock());
    return d()->queuePolicies;
}
 
Private::Job_Private *Job::d()
{
    return d_;
}
 
const Private::Job_Private *Job::d() const
{
    return d_;
}
 
bool Job::isFinished() const
{
    const Status s = status();
    return s == Status_Success || s == Status_Failed || s == Status_Aborted;
}
 
QMutex *Job::mutex() const
{
    return &(d()->mutex);
}
 
bool Job::shouldAbort() const
{
    return d()->shouldAbort;
}
 
void Job::onFinish(const std::function<void(const JobInterface &job)> &lambda)
{
    QMutexLocker l(mutex());
    d()->finishHandlers << lambda;
}
 
}
 
#include "managedjobpointer.h"