HOME
| OPENMP API Specification: "Version 5.2 -- GIT rev 95b2e3a44"

20.5  OMPD Tool Interface Routines

This section defines the interface provided by the OMPD library to be used by the third-party tool. Some interface routines require one or more specified threads to be stopped for the returned values to be meaningful. In this context, a stopped thread is a thread that is not modifying the observable OpenMP runtime state.

Description of Return Codes

All of the OMPD Tool Interface Routines must return function-specific return codes or any of the following return codes:

   20.5.2.4  ompd_get_device_thread_id_kinds
  20.5.3  Thread and Signal Safety
  20.5.4  Address Space Information
   20.5.4.1  ompd_get_omp_version
   20.5.4.2  ompd_get_omp_version_string
  20.5.5  Thread Handles
   20.5.5.1  ompd_get_thread_in_parallel
   20.5.5.2  ompd_get_thread_handle
   20.5.5.3  ompd_rel_thread_handle
   20.5.5.4  ompd_thread_handle_compare
   20.5.5.5  ompd_get_thread_id
   20.5.5.6  ompd_get_device_from_thread
  20.5.6  Parallel Region Handles
   20.5.6.1  ompd_get_curr_parallel_handle
   20.5.6.2  ompd_get_enclosing_parallel_handle
   20.5.6.3  ompd_get_task_parallel_handle
   20.5.6.4  ompd_rel_parallel_handle
   20.5.6.5  ompd_parallel_handle_compare
  20.5.7  Task Handles
   20.5.7.1  ompd_get_curr_task_handle
   20.5.7.2  ompd_get_generating_task_handle
   20.5.7.3  ompd_get_scheduling_task_handle
   20.5.7.4  ompd_get_task_in_parallel
   20.5.7.5  ompd_rel_task_handle
   20.5.7.6  ompd_task_handle_compare
   20.5.7.7  ompd_get_task_function
   20.5.7.8  ompd_get_task_frame
  20.5.8  Querying Thread States
   20.5.8.1  ompd_enumerate_states
   20.5.8.2  ompd_get_state
  20.5.9  Display Control Variables
   20.5.9.1  ompd_get_display_control_vars
   20.5.9.2  ompd_rel_display_control_vars
  20.5.10  Accessing Scope-Specific Information
   20.5.10.1  ompd_enumerate_icvs
   20.5.10.2  ompd_get_icv_from_scope
   20.5.10.3  ompd_get_icv_string_from_scope
   20.5.10.4  ompd_get_tool_data