JobSystem.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include <cstddef>
#include <functional>
#include <string>
 
namespace eve {
namespace thread {
 
class JobSystem;
 
using JobFunc = std::function<void()>;
 
using ParallelForBody = std::function<void(int first, int last)>;
 
class Job {
public:
    virtual ~Job() = default;
 
    virtual void wait() = 0;
 
    virtual bool isDone() const = 0;
 
    virtual bool hasFailed() const = 0;
 
    virtual std::string getError() const = 0;
 
    virtual int getPendingDependencyCount() const = 0;
 
    virtual void addDependency(Job *predecessor) = 0;
 
    virtual void setCompletionCallback(JobFunc callback) = 0;
};
 
class TaskGroup {
public:
    virtual ~TaskGroup() = default;
 
    virtual Job *fork(JobFunc body) = 0;
 
    virtual Job *fork(JobFunc body, JobFunc onComplete) = 0;
 
    virtual void wait() = 0;
 
    virtual int getPendingCount() const = 0;
};
 
class JobSystem {
public:
    virtual ~JobSystem() = default;
 
    virtual int getWorkerCount() const = 0;
 
    virtual bool isRunning() const = 0;
 
    virtual int getPendingCount() const = 0;
 
    virtual int getOutstandingCount() const = 0;
 
    // ---- heap jobs (caller owns returned handles) ----
 
    virtual Job *submit(JobFunc body) = 0;
 
    virtual Job *createJob(JobFunc body) = 0;
 
    virtual void schedule(Job *job) = 0;
 
    virtual Job *parallelFor(int first, int last, ParallelForBody body, int chunk = 1) = 0;
 
    virtual TaskGroup *createTaskGroup() = 0;
 
    // ---- frame jobs (arena-allocated; valid until next beginFrame) ----
 
    virtual Job *submitFrame(JobFunc body) = 0;
 
    virtual Job *createFrameJob(JobFunc body) = 0;
 
    virtual Job *parallelForFrame(int first, int last, ParallelForBody body, int chunk = 1) = 0;
 
    virtual TaskGroup *createFrameTaskGroup() = 0;
 
    virtual void beginFrame() = 0;
 
    virtual void endFrame() = 0;
 
    // ---- lifecycle ----
 
    virtual void waitAll() = 0;
 
    virtual void stop() = 0;
};
 
EVENGINE_API_FOUNDATION JobSystem *createJobSystem(int workerCount = 0);
 
}  // namespace thread
}  // namespace eve