launch_result.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2024 XCENA Inc.
 
#pragma once
 
#include <string>
 
#include "pxl/type.hpp"
 
namespace pxl
{
 
struct LaunchResult
{
    Result status = Result::Failure;
    double elapsedUs = 0.0;
    std::string errorMessage;
};
 
// Centralized error-message constants — keeps the public LaunchResult.errorMessage
// strings stable so tests and downstream tooling can match on them.
inline constexpr const char* kAlreadyCalledMessage =
    "run/runAsync already called on this builder";
// Common reasons this fires:
//   - The kernel was called with only scalar args (no device pointers): pass
//     an explicit device via Launcher(deviceId).
//   - A pointer argument was passed but it was NOT returned by
//     pxl::allocateMemory (e.g. it points at host malloc / static / stack
//     memory). pxl cannot infer a device from such pointers.
//   - The default device cache is unpopulated and no device is available.
inline constexpr const char* kNoDeviceResolvedMessage =
    "No device resolved — pointer arguments must come from pxl::allocateMemory(), "
    "or use Launcher(deviceId) for scalar-only kernels";
 
}  // namespace pxl