type.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2024 XCENA Inc.
 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
namespace pxl
{
 
enum class ExecuteStatus
{
    Idle = 0,  
    HostInit,
    DeviceInit,
    Request,
    Waiting,
    DeviceFinalize,
    HostFinalize,
    Fail,
    Cancelled,
    Completed,  
    Max
};
 
enum class ArgType
{
    Constant,
    DeviceMemory,
    NDArray,
};
 
struct ArgInfo_t
{
    ArgType type;
    const void* addr;
    size_t size;
};
 
struct KernelError_t
{
    uint32_t beginIndex;
    uint32_t endIndex;
};
 
struct Progress_t
{
    uint32_t targetCount;  // total packets the map will dispatch for this run
    uint32_t issuedCount;  // packets already sent to the device
    uint32_t doneCount;    // packets the device has reported complete
};
 
enum class Result
{
    Success = 0,
    Failure,  // generic failure; prefer a specific category below when the cause is known
    Pending,
    // --- error categories (keep Success/Failure/Pending values stable; append only) ---
    InvalidArgument,  // malformed/contradictory caller input or object state
    DeviceError,      // HW/driver-level failure reported by xif
    NotFound,         // module/symbol/resource lookup miss
    Timeout,          // operation did not complete in time (e.g. waitEvent)
    NotSupported,     // unsupported request/configuration
    NotInitialized,   // library/context/device not initialized
    Cancelled,        // operation cancelled before completion
    Internal,         // internal invariant violated / unreachable (a PXL bug); always logged
    // NOTE: memory-shortage failures are intentionally NOT represented here. They
    // surface through the standalone memory API's MemoryStatus (memory.hpp), which
    // is self-contained (no Result dependency) so the device can serve memory in
    // InfiniteMemory mode without installing the full PXL library.
    Count,  // number of values; sentinel for iteration/tests, not a real status
};
 
// Returns a stable, human-readable name for a Result code (akin to cudaGetErrorString).
// Never returns nullptr. The returned string is statically allocated.
const char* resultString(Result result) noexcept;
 
enum class DeviceAttr
{
    InfiniteMemory,
    NumClusterPerSub,
    NumMuCorePerCluster,
    TotalSubCount,
    CxlMemoryCapacity,
    // Job::remapMemory alignment. Reports NotSupported on devices that cannot
    // remap (InfiniteMemory / non-CXL), so a successful query means remap is usable.
    MappingGranularity
};
 
enum class LocalityMode : uint32_t
{
    CompactMode = 0,
    SpreadMode
};
 
static constexpr uint32_t MaxTaskCount = (1 << 20) - 1;
 
}  // namespace pxl