module.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2024 XCENA Inc.
 
#pragma once
#include <cstdint>
#include <string>
#include <vector>
 
#include "pxl/function.hpp"
 
namespace pxl
{
 
template <auto Func>
struct KernelTraits;
 
class Module
{
public:
    Module(const Module&) = delete;
 
    Module& operator=(const Module&) = delete;
 
    virtual Function* createFunction(const char* muFuncName) = 0;
 
    template <auto Func>
    Function* createFunction()
    {
        const char* kernelName = nullptr;
 
#if defined(__PXCC_ANALYSIS__)
        kernelName = "__pxcc_placeholder__";
#else
        static_assert(sizeof(KernelTraits<Func>) > 0,
                      "Kernel function not found in KernelTraits — was it compiled with pxcc?");
        kernelName = KernelTraits<Func>::name;
#endif
 
        return createFunction(kernelName);
    }
 
    virtual void destroyFunction(Function* function) = 0;
 
    virtual std::string getMuBinaryPath() const = 0;
 
    virtual uint32_t getNumMuFunctions() const = 0;
 
    virtual std::vector<std::string> getMuFunctionList() const = 0;
 
protected:
    Module() = default;
    virtual ~Module() = default;
};
 
Module* createModule(const char* muBinaryPath);
 
Module* createModule(const void* image);
 
Module* createModule();
 
void destroyModule(Module* module);
 
void registerKernelBinary(const void* start, const void* end);
 
}  // namespace pxl