ompd_rc_t ompd_get_curr_parallel_handle(
ompd_thread_handle_t *thread_handle,
ompd_parallel_handle_t **parallel_handle
);
Summary The ompd_get_curr_parallel_handle function obtains a pointer to the parallel handle for an OpenMP thread’s current parallel region.
Description The ompd_get_curr_parallel_handle function enables the tool to obtain a pointer to the parallel handle for the current parallel region that is associated with an OpenMP thread. This call is meaningful only if the associated thread is stopped. The parallel handle is owned by the tool and it must be released by calling ompd_rel_parallel_handle.
Description of Arguments The thread_handle argument is an opaque handle for a thread and selects the thread on which to operate. On return, the parallel_handle argument is set to a handle for the parallel region that the associated thread is currently executing, if any.
Description of Return Codes This routine must return any of the general return codes listed at the beginning of Section 5.5 or the following return code:
Summary The ompd_get_enclosing_parallel_handle function obtains a pointer to the parallel handle for an enclosing parallel region.
Description The ompd_get_enclosing_parallel_handle function enables a tool to obtain a pointer to the parallel handle for the parallel region that encloses the parallel region that parallel_handle specifies. This call is meaningful only if at least one thread in the parallel region is stopped. A pointer to the parallel handle for the enclosing region is returned in the location to which enclosing_parallel_handle points. After the call, the tool owns the handle; the tool must release the handle with ompd_rel_parallel_handle when it is no longer required.
Description of Arguments The parallel_handle argument is an opaque handle for a parallel region that selects the parallel region on which to operate. On return, the enclosing_parallel_handle argument is set to a handle for the parallel region that encloses the selected parallel region.
Description of Return Codes This routine must return any of the general return codes listed at the beginning of Section 5.5 or the following return code:
Summary The ompd_get_task_parallel_handle function obtains a pointer to the parallel handle for the parallel region that encloses a task region.
Description The ompd_get_task_parallel_handle function enables a tool to obtain a pointer to the parallel handle for the parallel region that encloses the task region that task_handle specifies. This call is meaningful only if at least one thread in the parallel region is stopped. A pointer to the parallel regions handle is returned in the location to which task_parallel_handle points. The tool owns that parallel handle, which it must release with ompd_rel_parallel_handle.
Description of Arguments The task_handle argument is an opaque handle that selects the task on which to operate. On return, the parallel_handle argument is set to a handle for the parallel region that encloses the selected task.
Description of Return Codes This routine must return any of the general return codes listed at the beginning of Section 5.5.
Summary The ompd_rel_parallel_handle function releases a parallel region handle.
Description Parallel region handles are opaque so tools cannot release them directly. Instead, a tool must pass a parallel region handle to the ompd_rel_parallel_handle function for disposal when finished with it.
Description of Arguments The parallel_handle argument is an opaque handle to be released.
Description of Return Codes This routine must return any of the general return codes listed at the beginning of Section 5.5.
Summary The ompd_parallel_handle_compare function compares two parallel region handles.
Description The internal structure of parallel region handles is opaque to tools. While tools can easily compare pointers to parallel region handles, they cannot determine whether handles at two different addresses refer to the same underlying parallel region and, instead must use the ompd_parallel_handle_compare function.
On success, ompd_parallel_handle_compare returns a signed integer value in the location to which cmp_value points that indicates how the underlying parallel regions compare. A value less than, equal to, or greater than 0 indicates that the region corresponding to parallel_handle_1 is, respectively, less than, equal to, or greater than that corresponding to parallel_handle_2. This function is provided since the means by which parallel region handles are ordered is implementation defined.
Description of Arguments The parallel_handle_1 and parallel_handle_2 arguments are opaque handles that correspond to parallel regions. On return the cmp_value argument points to a signed integer value that indicates how the underlying parallel regions compare.
Description of Return Codes This routine must return any of the general return codes listed at the beginning of Section 5.5.