context.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2024 XCENA Inc.
 
#pragma once
#include <cstdint>
#include <functional>
#include <optional>
 
#include "pxl/type.hpp"
 
namespace pxl
{
class Job;
 
class Context
{
public:
    using AsyncCallback = std::function<void(Job* job, void* arg)>;
 
    Context(const Context&) = delete;
 
    Context& operator=(const Context&) = delete;
 
    virtual Job* createJob() = 0;
 
    virtual Job* createJob(const uint32_t numSub) = 0;
 
    virtual Result createJobForceAsync(const uint32_t numSub, const AsyncCallback& callback, void* arg, uint32_t timeout = 0) = 0;
 
    virtual Result destroyJob(Job* job) = 0;
 
    virtual void* memAlloc(const size_t size) = 0;
 
    virtual void* memCalloc(const size_t num, const size_t size) = 0;
 
    virtual void memFree(const void* ptr) = 0;
 
    virtual uint32_t deviceId() const = 0;
 
    virtual uint32_t availableSubCount() const = 0;
 
    virtual uint64_t availableMemSize() const = 0;
 
    virtual Result getAttribute(DeviceAttr attr, uint64_t& value) const = 0;
 
    virtual void* memRealloc(void* ptr, const size_t size) = 0;
 
protected:
    Context() = default;
    virtual ~Context() = default;
};
 
uint32_t getNumDevice();
 
uint32_t availableSubCount(uint32_t deviceId);
 
std::optional<uint32_t> getDefaultDeviceId();
 
void clearDefaultDeviceId();
 
Context* createContext();
 
Context* createContext(uint32_t deviceId);
 
void destroyContext(Context* context);
 
}  // namespace pxl