roctracer.h

Go to the documentation of this file.

/* Copyright (c) 2018-2022 Advanced Micro Devices, Inc.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE. */

#ifndef ROCTRACER_H_
#define ROCTRACER_H_

/* Placeholder for calling convention and import/export macros */
#if !defined(ROCTRACER_CALL)
#define ROCTRACER_CALL
#endif /* !defined (ROCTRACER_CALL) */

#if !defined(ROCTRACER_EXPORT_DECORATOR)
#if defined(__GNUC__)
#define ROCTRACER_EXPORT_DECORATOR __attribute__((visibility("default")))
#elif defined(_MSC_VER)
#define ROCTRACER_EXPORT_DECORATOR __declspec(dllexport)
#endif /* defined (_MSC_VER) */
#endif /* !defined (ROCTRACER_EXPORT_DECORATOR) */

#if !defined(ROCTRACER_IMPORT_DECORATOR)
#if defined(__GNUC__)
#define ROCTRACER_IMPORT_DECORATOR
#elif defined(_MSC_VER)
#define ROCTRACER_IMPORT_DECORATOR __declspec(dllimport)
#endif /* defined (_MSC_VER) */
#endif /* !defined (ROCTRACER_IMPORT_DECORATOR) */

#define ROCTRACER_EXPORT ROCTRACER_EXPORT_DECORATOR ROCTRACER_CALL
#define ROCTRACER_IMPORT ROCTRACER_IMPORT_DECORATOR ROCTRACER_CALL

#if !defined(ROCTRACER)
#if defined(ROCTRACER_EXPORTS)
#define ROCTRACER_API ROCTRACER_EXPORT
#else /* !defined (ROCTRACER_EXPORTS) */
#define ROCTRACER_API ROCTRACER_IMPORT
#endif /* !defined (ROCTRACER_EXPORTS) */
#endif /* !defined (ROCTRACER) */

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

#include "ext/prof_protocol.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define ROCTRACER_VERSION_4_1

#define ROCTRACER_VERSION_MAJOR 4

#define ROCTRACER_VERSION_MINOR 1

ROCTRACER_API uint32_t roctracer_version_major() ROCTRACER_VERSION_4_1;

ROCTRACER_API uint32_t roctracer_version_minor() ROCTRACER_VERSION_4_1;

typedef enum {
  ROCTRACER_STATUS_SUCCESS = 0,
  ROCTRACER_STATUS_ERROR = -1,
  ROCTRACER_STATUS_ERROR_INVALID_DOMAIN_ID = -2,
  ROCTRACER_STATUS_ERROR_INVALID_ARGUMENT = -3,
  ROCTRACER_STATUS_ERROR_DEFAULT_POOL_UNDEFINED = -4,
  ROCTRACER_STATUS_ERROR_DEFAULT_POOL_ALREADY_DEFINED = -5,
  ROCTRACER_STATUS_ERROR_MEMORY_ALLOCATION = -6,
  ROCTRACER_STATUS_ERROR_MISMATCHED_EXTERNAL_CORRELATION_ID = -7,
  ROCTRACER_STATUS_ERROR_NOT_IMPLEMENTED = -8,
  ROCTRACER_STATUS_UNINIT = 2,
  ROCTRACER_STATUS_BREAK = 3,
  ROCTRACER_STATUS_BAD_DOMAIN = ROCTRACER_STATUS_ERROR_INVALID_DOMAIN_ID,
  ROCTRACER_STATUS_BAD_PARAMETER = ROCTRACER_STATUS_ERROR_INVALID_ARGUMENT,
  ROCTRACER_STATUS_HIP_API_ERR = 6,
  ROCTRACER_STATUS_HIP_OPS_ERR = 7,
  ROCTRACER_STATUS_HCC_OPS_ERR = ROCTRACER_STATUS_HIP_OPS_ERR,
  ROCTRACER_STATUS_HSA_ERR = 7,
  ROCTRACER_STATUS_ROCTX_ERR = 8,
} roctracer_status_t;

ROCTRACER_API const char* roctracer_error_string() ROCTRACER_VERSION_4_1;

typedef activity_domain_t roctracer_domain_t;

ROCTRACER_API const char* roctracer_op_string(
    uint32_t domain, uint32_t op, uint32_t kind) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t
roctracer_op_code(uint32_t domain, const char* str, uint32_t* op,
                  uint32_t* kind) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_set_properties(
    roctracer_domain_t domain, void* properties) ROCTRACER_VERSION_4_1;

typedef activity_rtapi_callback_t roctracer_rtapi_callback_t;

ROCTRACER_API roctracer_status_t roctracer_enable_op_callback(
    activity_domain_t domain, uint32_t op, activity_rtapi_callback_t callback,
    void* arg) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_enable_domain_callback(
    activity_domain_t domain, activity_rtapi_callback_t callback,
    void* arg) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_disable_op_callback(
    activity_domain_t domain, uint32_t op) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_disable_domain_callback(
    activity_domain_t domain) ROCTRACER_VERSION_4_1;

typedef activity_record_t roctracer_record_t;

ROCTRACER_API roctracer_status_t
roctracer_next_record(const activity_record_t* record,
                      const activity_record_t** next) ROCTRACER_VERSION_4_1;

typedef void (*roctracer_allocator_t)(char** ptr, size_t size, void* arg);

typedef void (*roctracer_buffer_callback_t)(const char* begin, const char* end,
                                            void* arg);

typedef struct {
  uint32_t mode;

  size_t buffer_size;

  roctracer_allocator_t alloc_fun;

  void* alloc_arg;

  roctracer_buffer_callback_t buffer_callback_fun;

  void* buffer_callback_arg;
} roctracer_properties_t;

typedef void roctracer_pool_t;

ROCTRACER_API roctracer_status_t
roctracer_open_pool_expl(const roctracer_properties_t* properties,
                         roctracer_pool_t** pool) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_open_pool(
    const roctracer_properties_t* properties) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t
roctracer_close_pool_expl(roctracer_pool_t* pool) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_close_pool() ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_pool_t* roctracer_default_pool_expl(
    roctracer_pool_t* pool) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_pool_t* roctracer_default_pool() ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_enable_op_activity_expl(
    activity_domain_t domain, uint32_t op,
    roctracer_pool_t* pool) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_enable_op_activity(
    activity_domain_t domain, uint32_t op) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_enable_domain_activity_expl(
    activity_domain_t domain, roctracer_pool_t* pool) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_enable_domain_activity(
    activity_domain_t domain) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_disable_op_activity(
    activity_domain_t domain, uint32_t op) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_disable_domain_activity(
    activity_domain_t domain) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t
roctracer_flush_activity_expl(roctracer_pool_t* pool) ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_flush_activity()
    ROCTRACER_VERSION_4_1;

ROCTRACER_API roctracer_status_t roctracer_get_timestamp(
    roctracer_timestamp_t* timestamp) ROCTRACER_VERSION_4_1;

#ifdef __cplusplus
} /* extern "C" block */
#endif /* __cplusplus */

#endif /* ROCTRACER_H_ */