rocprofiler-sdk/ompt.h Source File

Rocprofiler SDK Developer API 0.6.0 ROCm Profiling API and tools

• rocprofiler-sdk

ompt.h

Go to the documentation of this file.

1// MIT License

2//

3// Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.

4//

5// Permission is hereby granted, free of charge, to any person obtaining a copy

6// of this software and associated documentation files (the "Software"), to deal

7// in the Software without restriction, including without limitation the rights

8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

9// copies of the Software, and to permit persons to whom the Software is

10// furnished to do so, subject to the following conditions:

11//

12// The above copyright notice and this permission notice shall be included in all

13// copies or substantial portions of the Software.

14//

15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

21// SOFTWARE.

22

23#pragma once

24

25#include <rocprofiler-sdk/defines.h>

26#include <rocprofiler-sdk/fwd.h>

27#include <rocprofiler-sdk/ompt/api_args.h>

28#include <rocprofiler-sdk/ompt/api_id.h>

29#include <rocprofiler-sdk/ompt/omp-tools.h>

30

31/**

32 * @defgroup OMPT_REGISTRATION Tool registration for OpenMP Tools

33 *

34 * Functions for enabling OMPT support in tools which provide their own ompt_start_tool symbol but

35 * want to defer to rocprofiler-sdk for OMPT.

36 *

37 * @{

38 */

39

40ROCPROFILER_EXTERN_C_INIT

41

42rocprofiler_status_t

43rocprofiler_ompt_is_initialized(int* status) ROCPROFILER_API ROCPROFILER_NONNULL(1);

44

45rocprofiler_status_t

46rocprofiler_ompt_is_finalized(int* status) ROCPROFILER_API ROCPROFILER_NONNULL(1);

47

48ompt_start_tool_result_t*

49rocprofiler_ompt_start_tool(unsigned int omp_version, const char* runtime_version) ROCPROFILER_API;

50

51ROCPROFILER_EXTERN_C_FINI

52

53/** @} */

defines.h

fwd.h

rocprofiler_status_t

rocprofiler_status_t

Status codes.

Definition fwd.h:53

rocprofiler_ompt_is_finalized

rocprofiler_status_t rocprofiler_ompt_is_finalized(int *status)

rocprofiler_ompt_start_tool

ompt_start_tool_result_t * rocprofiler_ompt_start_tool(unsigned int omp_version, const char *runtime_version)

rocprofiler_ompt_is_initialized

rocprofiler_status_t rocprofiler_ompt_is_initialized(int *status)

omp-tools.h

ompt_start_tool_result_t

Definition omp-tools.h:604

api_args.h

api_id.h

---

Generated by  1.9.8