/*
 * Copyright 2026 NVIDIA Corporation.  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.
 */

/*
 * This file defines an API for Nsight Compute's cuda-injection library.
 * It is intended for clients that load the injection dynamically themselves from the target application process,
 * rather than relying on ncu to load it into the target process.
 *
 * It is important that clients load the injection library before the target process issues the first CUDA API call.
 */

#if !defined(NV_COMPUTE_INJECTION_API_H)
#define NV_COMPUTE_INJECTION_API_H

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

#if defined(__GNUC__)
  #if defined(__NV_COMPUTE_INJECTION_API_PUSH_VISIBILITY_DEFAULT)
    #pragma GCC visibility push(default)
  #endif
#endif

#ifdef _WIN32
#define NV_INJ_API __stdcall
#else
#define NV_INJ_API
#endif

typedef enum nvInjResult {
    NV_INJ_SUCCESS = 0,
    NV_INJ_ERROR_UNKNOWN = 1,
    NV_INJ_ERROR_INVALID_PARAMS = 2,
    NV_INJ_ERROR_NOT_INITIALIZED = 3,
} nvInjResult;

typedef struct nvInjBeginProfiling_Params
{
    /// [in] assign to sizeof(nvInjBeginProfiling_Params)
    size_t structSize;
    /// [in] assign to NULL
    void* pPriv;
} nvInjBeginProfiling_Params;

/**
 * @brief Begin profiling of this process
 *
 * This function must be called to begin a new profiling session.
 * The injection will reset applicable state for a new profiling session and
 * instruct the application to suspend in the next API call or workload launch.
 * Clients must launch ncu in attach mode after this API call.
 * Clients should pass --process-id with this process's ID to ensure ncu
 * attaches to this process when multiple attachable processes may exist.
 * Clients are responsible for configuring the profiling session by passing
 * applicable arguments to the ncu frontend launch.
 * Clients should track the ncu process to be able to wait for its termination after nvInjEndProfiling().
 *
 * @param pParams Parameters for starting profiling
 * @return NV_INJ_SUCCESS if the profiling is successfully started, or an appropriate error code.
 */
nvInjResult NV_INJ_API nvInjBeginProfiling(nvInjBeginProfiling_Params* pParams);


typedef struct nvInjEndProfiling_Params
{
    /// [in] assign to sizeof(nvInjEndProfiling_Params)
    size_t structSize;
    /// [in] assign to NULL
    void* pPriv;
} nvInjEndProfiling_Params;

/**
 * @brief End profiling of this process
 *
 * This function must be called after nvInjBeginProfiling() to end an active profiling session.
 * The injection will send an exit message to the ncu frontend to direct it do detach and exit.
 * Clients should wait for the ncu process to terminate before proceeding.
 * Any created report(s) can be consumed after ncu terminated.
 *
 * @param pParams Parameters for ending profiling
 * @return NV_INJ_SUCCESS if the profiling is successfully ended, or an appropriate error code.
 */
nvInjResult NV_INJ_API nvInjEndProfiling(nvInjEndProfiling_Params* pParams);

#if defined(__GNUC__)
  #if defined(__NV_COMPUTE_INJECTION_API_PUSH_VISIBILITY_DEFAULT)
    #pragma GCC visibility pop
  #endif
#endif

#ifdef __cplusplus
}
#endif

#endif // NV_COMPUTE_INJECTION_API_H