/*
 * Copyright 2025-2026 NVIDIA CORPORATION & AFFILIATES.  All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */

#ifndef PARAMETER_API_H
#define PARAMETER_API_H

#include <stddef.h>
#include <stdint.h>

#include "../macros.h"
#include "../types/cuest_types.h"
#include "../types/cuest_parameter_types.h"
#include "../types/workspace_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @defgroup Parameters
 */

/**
 * @brief Create a new cuEST parameters object of the specified type.
 * @ingroup Parameters
 *
 * Allocates and initializes an opaque parameter object of the type specified by \c parameterType.
 * The created object is returned via \c outParameters and must be destroyed with \c cuestParametersDestroy.
 *
 * @param[in]  parameterType      Type of parameters object to create (see \c cuestParametersType_t).
 * @param[out] outParameters      Pointer to receive allocated opaque parameters handle. Must not be NULL.
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_NULL_POINTER if any required pointer is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if \c parameterType is not a valid parameters type;
 *   - \c CUEST_STATUS_EXCEPTION or \c CUEST_STATUS_UNKNOWN_ERROR otherwise.
 */
CUEST_API
cuestStatus_t cuestParametersCreate(
    cuestParametersType_t parameterType,
    void** outParameters);

/**
 * @brief Destroy and free a cuEST parameters object of the specified type.
 * @ingroup Parameters
 *
 * Properly deallocates and cleans up resources for a parameters handle created by \c cuestParametersCreate.
 *
 * @param[in] parameterType    Type of parameters object (must match creation).
 * @param[in] parameters       Opaque parameters handle to destroy; must not be NULL.
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_NULL_POINTER if any required pointer is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type;
 *   - \c CUEST_STATUS_EXCEPTION or \c CUEST_STATUS_UNKNOWN_ERROR otherwise.
 */
CUEST_API
cuestStatus_t cuestParametersDestroy(
    cuestParametersType_t parameterType,
    void* parameters);

/**
 * @brief Query the value of a given attribute from a cuEST parameters object.
 * @ingroup Parameters
 *
 * Retrieves the value associated with an attribute for the given \c parameters object. The type and meaning
 * of \c attribute and \c attributeValue depend on \c parameterType. The result is placed in \c attributeValue, whose
 * size must match the expected value size.
 *
 * For string-valued attributes (e.g. \c CUEST_HANDLE_PARAMETERS_JIT_CACHE_DIR, queried as a
 * \c char*), cuEST allocates the returned, NUL-terminated buffer with C's \c malloc and the caller
 * owns it: it must be released with C's native \c free(). This allocation only occurs when the
 * function completes successfully (returns \c CUEST_STATUS_SUCCESS). On any error status no
 * allocation is made and \c attributeValue is left unchanged — cuEST never writes to it on a
 * failing path — so a caller that pre-initializes \c attributeValue (e.g. to \c NULL) can rely on
 * that value afterward for a deterministic cleanup pattern, and there is nothing to free.
 *
 * @param[in]  parameterType       Type of parameters object being queried.
 * @param[in]  parameters          Opaque handle of the parameters object (must not be NULL).
 * @param[in]  attribute           Integer attribute identifier (cast to appropriate attribute enum internally).
 * @param[out] attributeValue      Destination for the queried value (must not be NULL).
 * @param[in]  attributeValueSize  Size in bytes of \c attributeValue buffer (must match queried type).
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_NULL_POINTER if any required pointer is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type;
 *   - \c CUEST_STATUS_INVALID_SIZE if \c attributeValueSize does not match the attribute type size;
 *   - \c CUEST_STATUS_INVALID_PARAMETER if the \c attribute is not valid for the given \c parameterType;
 *   - \c CUEST_STATUS_EXCEPTION or \c CUEST_STATUS_UNKNOWN_ERROR otherwise.
 */
CUEST_API
cuestStatus_t cuestParametersQuery(
    cuestParametersType_t parameterType,
    const void* parameters,
    int attribute,
    void* attributeValue,
    size_t attributeValueSize);

/**
 * @brief Configure the value of a given attribute for a cuEST parameters object.
 * @ingroup Parameters
 *
 * Sets or updates the value of an attribute for the given \c parameters object. The type and semantics
 * of the \c attribute and \c attributeValue depend on \c parameterType. The input value is provided as a pointer,
 * and its size must match the expected storage for the attribute.
 *
 * @param[in]  parameterType         Type of parameters object to configure.
 * @param[in,out] parameters            Opaque handle to parameters object (must not be NULL).
 * @param[in]  attribute             Integer attribute identifier (cast to appropriate attribute enum internally).
 * @param[in]  attributeValue        Pointer to the new value (must not be NULL).
 * @param[in]  attributeValueSize    Size in bytes of \c attributeValue (must match attribute type).
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_NULL_POINTER if any required pointer is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if opaque handles are not the correct type;
 *   - \c CUEST_STATUS_INVALID_SIZE if \c attributeValueSize does not match the attribute type size;
 *   - \c CUEST_STATUS_INVALID_PARAMETER if the \c attribute is not valid for the given \c parameterType;
 *   - \c CUEST_STATUS_EXCEPTION or \c CUEST_STATUS_UNKNOWN_ERROR otherwise.
 */
CUEST_API
cuestStatus_t cuestParametersConfigure(
    cuestParametersType_t parameterType,
    void* parameters,
    int attribute,
    const void* attributeValue,
    size_t attributeValueSize);

#ifdef __cplusplus
}
#endif

#endif /* PARAMETER_API_H */
